Switching to a rotatable about menu
[watersofshiloah] / src / windows / _base.py
1 from __future__ import with_statement
2
3 import ConfigParser
4 import logging
5 import webbrowser
6
7 import gobject
8 import gtk
9
10 import constants
11 import hildonize
12 import util.misc as misc_utils
13 import util.go_utils as go_utils
14
15 import stream_index
16 import banners
17 import presenter
18
19
20 _moduleLogger = logging.getLogger(__name__)
21
22
23 class BasicWindow(gobject.GObject, go_utils.AutoSignal):
24
25         __gsignals__ = {
26                 'quit' : (
27                         gobject.SIGNAL_RUN_LAST,
28                         gobject.TYPE_NONE,
29                         (),
30                 ),
31                 'home' : (
32                         gobject.SIGNAL_RUN_LAST,
33                         gobject.TYPE_NONE,
34                         (),
35                 ),
36                 'jump-to' : (
37                         gobject.SIGNAL_RUN_LAST,
38                         gobject.TYPE_NONE,
39                         (gobject.TYPE_PYOBJECT, ),
40                 ),
41                 'rotate' : (
42                         gobject.SIGNAL_RUN_LAST,
43                         gobject.TYPE_NONE,
44                         (gobject.TYPE_BOOLEAN, ),
45                 ),
46                 'fullscreen' : (
47                         gobject.SIGNAL_RUN_LAST,
48                         gobject.TYPE_NONE,
49                         (gobject.TYPE_BOOLEAN, ),
50                 ),
51         }
52
53         def __init__(self, app, player, store):
54                 gobject.GObject.__init__(self)
55                 self._isDestroyed = False
56
57                 self._app = app
58                 self._player = player
59                 self._store = store
60
61                 self._clipboard = gtk.clipboard_get()
62                 self._windowInFullscreen = False
63
64                 self._errorBanner = banners.StackingBanner()
65
66                 self._layout = gtk.VBox()
67
68                 self._window = gtk.Window()
69                 self._window.add(self._layout)
70                 self._window = hildonize.hildonize_window(self._app, self._window)
71                 go_utils.AutoSignal.__init__(self, self.window)
72
73                 self._window.set_icon(self._store.get_pixbuf_from_store(self._store.STORE_LOOKUP["icon"]))
74                 self._window.connect("key-press-event", self._on_key_press)
75                 self._window.connect("window-state-event", self._on_window_state_change)
76                 self._window.connect("destroy", self._on_destroy)
77
78                 if hildonize.GTK_MENU_USED:
79                         aboutMenuItem = gtk.MenuItem("About")
80                         aboutMenuItem.connect("activate", self._on_about)
81
82                         helpMenu = gtk.Menu()
83                         helpMenu.append(aboutMenuItem)
84
85                         helpMenuItem = gtk.MenuItem("Help")
86                         helpMenuItem.set_submenu(helpMenu)
87
88                         menuBar = gtk.MenuBar()
89                         menuBar.append(helpMenuItem)
90
91                         self._layout.pack_start(menuBar, False, False)
92                 else:
93                         aboutMenuItem = gtk.Button("About")
94                         aboutMenuItem.connect("clicked", self._on_about)
95
96                         appMenu = hildonize.hildon.AppMenu()
97                         appMenu.append(aboutMenuItem)
98                         appMenu.show_all()
99                         self._window.set_app_menu(appMenu)
100
101                 self._layout.pack_start(self._errorBanner.toplevel, False, True)
102
103         @property
104         def window(self):
105                 return self._window
106
107         def show(self):
108                 hildonize.window_to_portrait(self._window)
109                 self._window.show_all()
110
111         def save_settings(self, config, sectionName):
112                 config.add_section(sectionName)
113                 config.set(sectionName, "fullscreen", str(self._windowInFullscreen))
114
115         def load_settings(self, config, sectionName):
116                 try:
117                         windowInFullscreen = config.getboolean(sectionName, "fullscreen")
118                 except ConfigParser.NoSectionError, e:
119                         _moduleLogger.info(
120                                 "Settings file %s is missing section %s" % (
121                                         constants._user_settings_,
122                                         e.section,
123                                 )
124                         )
125                         windowInFullscreen = self._windowInFullscreen
126
127                 if windowInFullscreen:
128                         self._window.fullscreen()
129                 else:
130                         self._window.unfullscreen()
131
132         def jump_to(self, node):
133                 raise NotImplementedError("On %s" % self)
134
135         @misc_utils.log_exception(_moduleLogger)
136         def _on_about(self, *args):
137                 sourceWindow = AboutWindow(self._app, self._player, self._store)
138                 if not hildonize.IS_FREMANTLE_SUPPORTED:
139                         sourceWindow.window.set_modal(True)
140                         sourceWindow.window.set_transient_for(self._window)
141                 sourceWindow.window.set_default_size(*self._window.get_size())
142                 if self._windowInFullscreen:
143                         sourceWindow.window.fullscreen()
144                 else:
145                         sourceWindow.window.unfullscreen()
146                 sourceWindow.connect("quit", self._on_quit)
147                 sourceWindow.connect("jump-to", self._on_jump)
148                 sourceWindow.connect("fullscreen", self._on_child_fullscreen)
149                 sourceWindow.show()
150
151         @misc_utils.log_exception(_moduleLogger)
152         def _on_destroy(self, *args):
153                 self._isDestroyed = True
154
155         @misc_utils.log_exception(_moduleLogger)
156         def _on_window_state_change(self, widget, event, *args):
157                 oldIsFull = self._windowInFullscreen
158                 if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
159                         self._windowInFullscreen = True
160                 else:
161                         self._windowInFullscreen = False
162                 if oldIsFull != self._windowInFullscreen:
163                         _moduleLogger.info("%r Emit fullscreen %s" % (self, self._windowInFullscreen))
164                         self.emit("fullscreen", self._windowInFullscreen)
165
166         @misc_utils.log_exception(_moduleLogger)
167         def _on_key_press(self, widget, event, *args):
168                 RETURN_TYPES = (gtk.keysyms.Return, gtk.keysyms.ISO_Enter, gtk.keysyms.KP_Enter)
169                 isCtrl = bool(event.get_state() & gtk.gdk.CONTROL_MASK)
170                 if (
171                         event.keyval == gtk.keysyms.F6 or
172                         event.keyval in RETURN_TYPES and isCtrl
173                 ):
174                         # The "Full screen" hardware key has been pressed
175                         if self._windowInFullscreen:
176                                 self._window.unfullscreen ()
177                         else:
178                                 self._window.fullscreen ()
179                         return True
180                 elif (
181                         event.keyval in (gtk.keysyms.w, ) and
182                         event.get_state() & gtk.gdk.CONTROL_MASK
183                 ):
184                         self._window.destroy()
185                 elif (
186                         event.keyval in (gtk.keysyms.q, ) and
187                         event.get_state() & gtk.gdk.CONTROL_MASK
188                 ):
189                         self.emit("quit")
190                         self._window.destroy()
191                 elif event.keyval == gtk.keysyms.l and event.get_state() & gtk.gdk.CONTROL_MASK:
192                         with open(constants._user_logpath_, "r") as f:
193                                 logLines = f.xreadlines()
194                                 log = "".join(logLines)
195                                 self._clipboard.set_text(str(log))
196                         return True
197
198         @misc_utils.log_exception(_moduleLogger)
199         def _on_home(self, *args):
200                 self.emit("home")
201                 self._window.destroy()
202
203         @misc_utils.log_exception(_moduleLogger)
204         def _on_child_fullscreen(self, source, isFull):
205                 if isFull:
206                         _moduleLogger.info("Full screen %r to mirror child %r" % (self, source))
207                         self._window.fullscreen()
208                 else:
209                         _moduleLogger.info("Unfull screen %r to mirror child %r" % (self, source))
210                         self._window.unfullscreen()
211
212         @misc_utils.log_exception(_moduleLogger)
213         def _on_jump(self, source, node):
214                 raise NotImplementedError("On %s" % self)
215
216         @misc_utils.log_exception(_moduleLogger)
217         def _on_quit(self, *args):
218                 self.emit("quit")
219                 self._window.destroy()
220
221
222 class ListWindow(BasicWindow):
223
224         def __init__(self, app, player, store, node):
225                 BasicWindow.__init__(self, app, player, store)
226                 self._node = node
227
228                 self.connect_auto(self._player, "title-change", self._on_player_title_change)
229
230                 self._loadingBanner = banners.GenericBanner()
231
232                 modelTypes, columns = zip(*self._get_columns())
233
234                 self._model = gtk.ListStore(*modelTypes)
235
236                 self._treeView = gtk.TreeView()
237                 self._treeView.connect("row-activated", self._on_row_activated)
238                 self._treeView.set_property("fixed-height-mode", True)
239                 self._treeView.set_headers_visible(False)
240                 self._treeView.set_model(self._model)
241                 for column in columns:
242                         if column is not None:
243                                 self._treeView.append_column(column)
244
245                 self._viewport = gtk.Viewport()
246                 self._viewport.add(self._treeView)
247
248                 self._treeScroller = gtk.ScrolledWindow()
249                 self._treeScroller.add(self._viewport)
250                 self._treeScroller.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)
251                 self._treeScroller = hildonize.hildonize_scrollwindow(self._treeScroller)
252
253                 self._separator = gtk.HSeparator()
254                 self._presenter = presenter.NavControl(self._player, self._store)
255                 self.connect_auto(self._presenter, "home", self._on_home)
256                 self.connect_auto(self._presenter, "jump-to", self._on_jump)
257
258                 self._contentLayout = gtk.VBox(False)
259                 self._contentLayout.pack_start(self._treeScroller, True, True)
260                 self._contentLayout.pack_start(self._separator, False, True)
261                 self._contentLayout.pack_start(self._presenter.toplevel, False, True)
262
263                 self._layout.pack_start(self._loadingBanner.toplevel, False, False)
264                 self._layout.pack_start(self._contentLayout, True, True)
265
266         def show(self):
267                 BasicWindow.show(self)
268
269                 self._errorBanner.toplevel.hide()
270                 self._loadingBanner.toplevel.hide()
271
272                 self._refresh()
273                 self._presenter.refresh()
274
275         @classmethod
276         def _get_columns(cls):
277                 raise NotImplementedError("")
278
279         def _get_current_row(self):
280                 if self._player.node is None:
281                         return -1
282                 ancestors, current, descendants = stream_index.common_paths(self._player.node, self._node)
283                 if not descendants:
284                         return -1
285                 activeChild = descendants[0]
286                 for i, row in enumerate(self._model):
287                         if activeChild is row[0]:
288                                 return i
289                 else:
290                         return -1
291
292         def jump_to(self, node):
293                 ancestors, current, descendants = stream_index.common_paths(node, self._node)
294                 if current is None:
295                         raise RuntimeError("Cannot jump to node %s" % node)
296                 if not descendants:
297                         _moduleLogger.info("Current node is the target")
298                         return
299                 child = descendants[0]
300                 window = self._window_from_node(child)
301                 window.jump_to(node)
302
303         def _window_from_node(self, node):
304                 raise NotImplementedError("")
305
306         @misc_utils.log_exception(_moduleLogger)
307         def _on_row_activated(self, view, path, column):
308                 itr = self._model.get_iter(path)
309                 node = self._model.get_value(itr, 0)
310                 self._window_from_node(node)
311
312         @misc_utils.log_exception(_moduleLogger)
313         def _on_player_title_change(self, player, node):
314                 assert not self._isDestroyed
315                 self._select_row()
316
317         @misc_utils.log_exception(_moduleLogger)
318         def _on_jump(self, source, node):
319                 ancestors, current, descendants = stream_index.common_paths(node, self._node)
320                 if current is None:
321                         _moduleLogger.info("%s is not the target, moving up" % self._node)
322                         self.emit("jump-to", node)
323                         self._window.destroy()
324                         return
325                 if not descendants:
326                         _moduleLogger.info("Current node is the target")
327                         return
328                 child = descendants[0]
329                 window = self._window_from_node(child)
330                 window.jump_to(node)
331
332         @misc_utils.log_exception(_moduleLogger)
333         def _on_delay_scroll(self, *args):
334                 self._scroll_to_row()
335
336         def _show_loading(self):
337                 animationPath = self._store.STORE_LOOKUP["loading"]
338                 animation = self._store.get_pixbuf_animation_from_store(animationPath)
339                 self._loadingBanner.show(animation, "Loading...")
340
341         def _hide_loading(self):
342                 self._loadingBanner.hide()
343
344         def _refresh(self):
345                 self._show_loading()
346                 self._model.clear()
347
348         def _select_row(self):
349                 rowIndex = self._get_current_row()
350                 if rowIndex < 0:
351                         return
352                 path = (rowIndex, )
353                 self._treeView.get_selection().select_path(path)
354
355         def _scroll_to_row(self):
356                 rowIndex = self._get_current_row()
357                 if rowIndex < 0:
358                         return
359
360                 path = (rowIndex, )
361                 self._treeView.scroll_to_cell(path)
362
363                 treeViewHeight = self._treeView.get_allocation().height
364                 viewportHeight = self._viewport.get_allocation().height
365
366                 viewsPerPort = treeViewHeight / float(viewportHeight)
367                 maxRows = len(self._model)
368                 percentThrough = rowIndex / float(maxRows)
369                 dxByIndex = int(viewsPerPort * percentThrough * viewportHeight)
370
371                 dxMax = max(treeViewHeight - viewportHeight, 0)
372
373                 dx = min(dxByIndex, dxMax)
374                 adjustment = self._treeScroller.get_vadjustment()
375                 adjustment.value = dx
376
377
378 class PresenterWindow(BasicWindow):
379
380         def __init__(self, app, player, store, node):
381                 BasicWindow.__init__(self, app, player, store)
382                 self._node = node
383                 self._playerNode = self._player.node
384                 self._nextSearch = None
385                 self._updateSeek = None
386
387                 self.connect_auto(self._player, "state-change", self._on_player_state_change)
388                 self.connect_auto(self._player, "title-change", self._on_player_title_change)
389                 self.connect_auto(self._player, "error", self._on_player_error)
390
391                 self._loadingBanner = banners.GenericBanner()
392
393                 self._presenter = presenter.StreamPresenter(self._store)
394                 self._presenter.set_context(
395                         self._get_background(),
396                         self._node.title,
397                         self._node.subtitle,
398                 )
399                 self._presenterNavigation = presenter.NavigationBox()
400                 self._presenterNavigation.toplevel.add(self._presenter.toplevel)
401                 self.connect_auto(self._presenterNavigation, "action", self._on_nav_action)
402                 self.connect_auto(self._presenterNavigation, "navigating", self._on_navigating)
403
404                 self._seekbar = hildonize.create_seekbar()
405                 self._seekbar.connect("change-value", self._on_user_seek)
406
407                 self._layout.pack_start(self._loadingBanner.toplevel, False, False)
408                 self._layout.pack_start(self._presenterNavigation.toplevel, True, True)
409                 self._layout.pack_start(self._seekbar, False, False)
410
411                 self._window.set_title(self._node.get_parent().title)
412
413         def _get_background(self):
414                 raise NotImplementedError()
415
416         def show(self):
417                 BasicWindow.show(self)
418                 self._window.show_all()
419                 self._errorBanner.toplevel.hide()
420                 self._loadingBanner.toplevel.hide()
421                 self._set_context(self._player.state)
422                 self._seekbar.hide()
423
424         def jump_to(self, node):
425                 assert self._node is node
426
427         @property
428         def _active(self):
429                 return self._playerNode is self._node
430
431         def _show_loading(self):
432                 animationPath = self._store.STORE_LOOKUP["loading"]
433                 animation = self._store.get_pixbuf_animation_from_store(animationPath)
434                 self._loadingBanner.show(animation, "Loading...")
435
436         def _hide_loading(self):
437                 self._loadingBanner.hide()
438
439         def _set_context(self, state):
440                 if state == self._player.STATE_PLAY:
441                         if self._active:
442                                 self._presenter.set_state(self._store.STORE_LOOKUP["pause"])
443                         else:
444                                 self._presenter.set_state(self._store.STORE_LOOKUP["play"])
445                 elif state == self._player.STATE_PAUSE:
446                         self._presenter.set_state(self._store.STORE_LOOKUP["play"])
447                 elif state == self._player.STATE_STOP:
448                         self._presenter.set_state(self._store.STORE_LOOKUP["play"])
449                 else:
450                         _moduleLogger.info("Unhandled player state %s" % state)
451
452         @misc_utils.log_exception(_moduleLogger)
453         def _on_user_seek(self, widget, scroll, value):
454                 self._player.seek(value / 100.0)
455
456         @misc_utils.log_exception(_moduleLogger)
457         def _on_player_update_seek(self):
458                 if self._isDestroyed:
459                         return False
460                 self._seekbar.set_value(self._player.percent_elapsed * 100)
461                 return True
462
463         @misc_utils.log_exception(_moduleLogger)
464         def _on_player_state_change(self, player, newState):
465                 assert not self._isDestroyed
466                 if self._active and self._player.state == self._player.STATE_PLAY:
467                         self._seekbar.show()
468                         assert self._updateSeek is None
469                         self._updateSeek = go_utils.Timeout(self._on_player_update_seek, once=False)
470                         self._updateSeek.start(seconds=1)
471                 else:
472                         self._seekbar.hide()
473                         if self._updateSeek is not None:
474                                 self._updateSeek.cancel()
475                                 self._updateSeek = None
476
477                 if not self._presenterNavigation.is_active():
478                         self._set_context(newState)
479
480         @misc_utils.log_exception(_moduleLogger)
481         def _on_player_title_change(self, player, node):
482                 assert not self._isDestroyed
483                 if not self._active or node in [None, self._node]:
484                         self._playerNode = node
485                         return
486                 self._playerNode = node
487                 self.emit("jump-to", node)
488                 self._window.destroy()
489
490         @misc_utils.log_exception(_moduleLogger)
491         def _on_player_error(self, player, err, debug):
492                 assert not self._isDestroyed
493                 _moduleLogger.error("%r - %r" % (err, debug))
494
495         @misc_utils.log_exception(_moduleLogger)
496         def _on_navigating(self, widget, navState):
497                 if navState == "clicking":
498                         if self._player.state == self._player.STATE_PLAY:
499                                 if self._active:
500                                         imageName = "pause_pressed"
501                                 else:
502                                         imageName = "play_pressed"
503                         elif self._player.state == self._player.STATE_PAUSE:
504                                 imageName = "play_pressed"
505                         elif self._player.state == self._player.STATE_STOP:
506                                 imageName = "play_pressed"
507                         else:
508                                 _moduleLogger.info("Unhandled player state %s" % self._player.state)
509                 elif navState == "down":
510                         imageName = "home"
511                 elif navState == "up":
512                         if self._player.state == self._player.STATE_PLAY:
513                                 if self._active:
514                                         imageName = "pause"
515                                 else:
516                                         imageName = "play"
517                         elif self._player.state == self._player.STATE_PAUSE:
518                                 imageName = "play"
519                         elif self._player.state == self._player.STATE_STOP:
520                                 imageName = "play"
521                         else:
522                                 _moduleLogger.info("Unhandled player state %s" % self._player.state)
523                 elif navState == "left":
524                         imageName = "next"
525                 elif navState == "right":
526                         imageName = "prev"
527
528                 self._presenter.set_state(self._store.STORE_LOOKUP[imageName])
529
530         @misc_utils.log_exception(_moduleLogger)
531         def _on_nav_action(self, widget, navState):
532                 self._set_context(self._player.state)
533
534                 if navState == "clicking":
535                         if self._player.state == self._player.STATE_PLAY:
536                                 if self._active:
537                                         self._player.pause()
538                                 else:
539                                         self._player.set_piece_by_node(self._node)
540                                         self._player.play()
541                         elif self._player.state == self._player.STATE_PAUSE:
542                                 self._player.play()
543                         elif self._player.state == self._player.STATE_STOP:
544                                 self._player.set_piece_by_node(self._node)
545                                 self._player.play()
546                         else:
547                                 _moduleLogger.info("Unhandled player state %s" % self._player.state)
548                 elif navState == "down":
549                         self.emit("home")
550                         self._window.destroy()
551                 elif navState == "up":
552                         pass
553                 elif navState == "left":
554                         if self._active:
555                                 self._player.next()
556                         else:
557                                 assert self._nextSearch is None
558                                 self._nextSearch = stream_index.AsyncWalker(stream_index.get_next)
559                                 self._nextSearch.start(self._node, self._on_next_node, self._on_node_search_error)
560                 elif navState == "right":
561                         if self._active:
562                                 self._player.back()
563                         else:
564                                 assert self._nextSearch is None
565                                 self._nextSearch = stream_index.AsyncWalker(stream_index.get_previous)
566                                 self._nextSearch.start(self._node, self._on_next_node, self._on_node_search_error)
567
568         @misc_utils.log_exception(_moduleLogger)
569         def _on_next_node(self, node):
570                 self._nextSearch = None
571                 self.emit("jump-to", node)
572                 self._window.destroy()
573
574         @misc_utils.log_exception(_moduleLogger)
575         def _on_node_search_error(self, e):
576                 self._nextSearch = None
577                 self._errorBanner.push_message(str(e))
578
579
580 class AboutWindow(BasicWindow):
581
582         def __init__(self, app, player, store):
583                 BasicWindow.__init__(self, app, player, store)
584                 self._window.set_title(constants.__pretty_app_name__)
585
586                 self._titleLabel = gtk.Label()
587                 self._titleLabel.set_markup("""
588 <big>Mormon Channel</big>
589 <i>Maemo Edition</i>
590 Version %s
591 """ % (constants.__version__, ))
592                 self._titleLabel.set_property("justify", gtk.JUSTIFY_CENTER)
593
594                 self._copyLabel = gtk.Label()
595                 self._copyLabel.set_markup("""
596 <small>(c) 2010 Intellectual Reserve, Inc.
597 All rights reserved.</small>
598 """)
599                 self._copyLabel.set_property("justify", gtk.JUSTIFY_CENTER)
600
601                 self._linkButton = gtk.LinkButton("LDS.org")
602                 self._linkButton.set_uri("http://www.lds.org")
603                 self._linkButton.connect("clicked", self._on_website)
604
605                 self._spacedLayout = gtk.VBox(True)
606                 self._spacedLayout.pack_start(self._titleLabel, False, False)
607                 self._spacedLayout.pack_start(self._copyLabel, False, False)
608                 self._spacedLayout.pack_start(self._linkButton, False, False)
609
610                 self._separator = gtk.HSeparator()
611                 self._presenter = presenter.NavControl(self._player, self._store)
612                 self.connect_auto(self._presenter, "home", self._on_home)
613                 self.connect_auto(self._presenter, "jump-to", self._on_jump)
614
615                 self._layout.pack_start(self._spacedLayout, True, True)
616                 self._layout.pack_start(self._presenter.toplevel, False, True)
617
618         def show(self):
619                 BasicWindow.show(self)
620                 self._window.show_all()
621                 self._errorBanner.toplevel.hide()
622                 self._presenter.refresh()
623
624         @misc_utils.log_exception(_moduleLogger)
625         def _on_about(self, *args):
626                 pass
627
628         @misc_utils.log_exception(_moduleLogger)
629         def _on_website(self, widget):
630                 uri = widget.get_uri()
631                 webbrowser.open(uri)
632
633         @misc_utils.log_exception(_moduleLogger)
634         def _on_jump(self, source, node):
635                 self.emit("jump-to", node)
636                 self._window.destroy()