Merge into trunk : frontend-cleanup : Code : Entertainer Media Center

Reviewer	Review Type	Date Requested	Status
Paul Hummer		2009-02-07	Approve on 2009-02-07
Review via email: mp+3464@code.launchpad.net

Revision history for this message

Matt Layman (mblayman) wrote on 2009-02-07:

#

This branch streamlines how the frontend and system tray icon are started. The system tray icon used to have some logic that would start the frontend, but since the icon is nothing more than a different interface to access some features of Entertainer, I've moved it into the FrontentClient. Also, the SystemTrayMessageHandler was doing nothing. There was no interaction with the message bus and message proxy which is what message handlers are supposed to do, so the class was adding no value. Therefore, I've removed it entirely. Additionally, nothing was being displayed by notifications except for debug messages, so notifications are gone now too. If we actually develop a feature that uses them in the future, we can easily bring them back.

I've also taken the simple action of moving the main loop into a different method. This should allow us to *potentially* test the FrontendClient class (although I think that there is still work to done on how to mock the backend connection that is uses).

Hopefully, this branch will greatly clarify the design of the frontend package because I'm sure it was pretty unclear to a casual observer. Refactoring is fun! :)

Revision history for this message

Matt Layman (mblayman) wrote on 2009-02-07:

#

Download full text (35.3 KiB)

=== modified file 'cfg/preferences.conf'
--- cfg/preferences.conf 2008-12-17 19:19:33 +0000
+++ cfg/preferences.conf 2009-02-07 00:48:26 +0000
@@ -9,7 +9,6 @@
theme = Default
backend_port = 45054
history_size = 8
-display_notifications = True
transition_effect = Slide
start_server_auto = True
display_icon = False

=== modified file 'docs/DEPENDENCIES'
--- docs/DEPENDENCIES 2009-01-06 23:52:09 +0000
+++ docs/DEPENDENCIES 2009-02-07 00:48:26 +0000
@@ -2,5 +2,5 @@

sudo apt-get install python-gobject python-gtk2 python-gst0.10 python-clutter \
python-pysqlite2 python-cddb python-glade2 python-cairo python-feedparser \
-python-eyed3 python-pyvorbis python-imaging python-imdbpy python-notify
+python-eyed3 python-pyvorbis python-imaging python-imdbpy

=== modified file 'entertainerlib/backend/backend_server.py'
--- entertainerlib/backend/backend_server.py 2009-01-31 15:46:36 +0000
+++ entertainerlib/backend/backend_server.py 2009-02-07 00:48:26 +0000
@@ -47,8 +47,6 @@
self.logger = Logger().getLogger('backend.BackendServer')
self.message_bus = MessageBus()

- # Notify object - used to display desktop notifications
- self.notifier = None
# Connection server - Thread that listens incoming socket connections
self.connection_server = None

=== modified file 'entertainerlib/frontend/__init__.py'
--- entertainerlib/frontend/__init__.py 2008-10-13 16:23:50 +0000
+++ entertainerlib/frontend/__init__.py 2009-02-07 00:48:26 +0000
@@ -5,22 +5,27 @@

     # Import statements are inside thu function so that they aren't imported
     # every time something from the frontend is imported
+ import clutter
+ import gobject
+ import gtk
+
     from entertainerlib.frontend.translation_setup import TranslationSetup
     TranslationSetup()

     from entertainerlib.backend.backend_server import BackendServer
     from entertainerlib.utils.configuration import Configuration
     from entertainerlib.frontend.frontend_client import FrontendClient
- from entertainerlib.utils.system_tray_icon import init_systray
+
+ gobject.threads_init()
+ gtk.gdk.threads_init()
+ clutter.threads_init()

     config = Configuration()
     if config.start_auto_server():
         print "Entertainer backend starting..."
         backend = BackendServer()

- if config.tray_icon_enabled():
- init_systray()
- else:
- FrontendClient()
+ frontend_client = FrontendClient()
+ frontend_client.start()

=== modified file 'entertainerlib/frontend/frontend_client.py'
--- entertainerlib/frontend/frontend_client.py 2009-01-31 15:46:36 +0000
+++ entertainerlib/frontend/frontend_client.py 2009-02-07 00:48:26 +0000
@@ -1,139 +1,97 @@
'''Entertainer Frontend - This is a client side of Entertainer.'''

-__licence__ = "GPLv2"
-__copyright__ = "2007, Lauri Taimila"
-__author__ = "Lauri Taimila <email address hidden>"
-__version__ = "0.1"
+__licence__ = 'GPLv2'
+__copyright__ = ('2007, Lauri Taimila', '2009, Matt Layman')
+__author__ = ('Lauri Taimila <email address hidden>',
+ 'Matt Layman <email address hidden>')

import sys

-from entertainerlib.utils.configuration import Confi...

=== modified file 'cfg/preferences.conf'
--- cfg/preferences.conf	2008-12-17 19:19:33 +0000
+++ cfg/preferences.conf	2009-02-07 00:48:26 +0000
@@ -9,7 +9,6 @@
 theme = Default
 backend_port = 45054
 history_size = 8
-display_notifications = True
 transition_effect = Slide
 start_server_auto = True
 display_icon = False

=== modified file 'docs/DEPENDENCIES'
--- docs/DEPENDENCIES	2009-01-06 23:52:09 +0000
+++ docs/DEPENDENCIES	2009-02-07 00:48:26 +0000
@@ -2,5 +2,5 @@
 
 sudo apt-get install python-gobject python-gtk2 python-gst0.10 python-clutter \
 python-pysqlite2 python-cddb python-glade2 python-cairo python-feedparser \
-python-eyed3 python-pyvorbis python-imaging python-imdbpy python-notify
+python-eyed3 python-pyvorbis python-imaging python-imdbpy

=== modified file 'entertainerlib/backend/backend_server.py'
--- entertainerlib/backend/backend_server.py	2009-01-31 15:46:36 +0000
+++ entertainerlib/backend/backend_server.py	2009-02-07 00:48:26 +0000
@@ -47,8 +47,6 @@
         self.logger = Logger().getLogger('backend.BackendServer')
         self.message_bus = MessageBus()
 
-        # Notify object - used to display desktop notifications
-        self.notifier = None
         # Connection server - Thread that listens incoming socket connections
         self.connection_server = None

=== modified file 'entertainerlib/frontend/__init__.py'
--- entertainerlib/frontend/__init__.py	2008-10-13 16:23:50 +0000
+++ entertainerlib/frontend/__init__.py	2009-02-07 00:48:26 +0000
@@ -5,22 +5,27 @@
 
     # Import statements are inside thu function so that they aren't imported
     # every time something from the frontend is imported
+    import clutter
+    import gobject
+    import gtk
+
     from entertainerlib.frontend.translation_setup import TranslationSetup
     TranslationSetup()
 
     from entertainerlib.backend.backend_server import BackendServer
     from entertainerlib.utils.configuration import Configuration
     from entertainerlib.frontend.frontend_client import FrontendClient
-    from entertainerlib.utils.system_tray_icon import init_systray
+
+    gobject.threads_init()
+    gtk.gdk.threads_init()
+    clutter.threads_init()
 
     config = Configuration()
     if config.start_auto_server():
         print "Entertainer backend starting..."
         backend = BackendServer()
 
-    if config.tray_icon_enabled():
-        init_systray()
-    else:
-        FrontendClient()
+    frontend_client = FrontendClient()
+    frontend_client.start()

=== modified file 'entertainerlib/frontend/frontend_client.py'
--- entertainerlib/frontend/frontend_client.py	2009-01-31 15:46:36 +0000
+++ entertainerlib/frontend/frontend_client.py	2009-02-07 00:48:26 +0000
@@ -1,139 +1,97 @@
 '''Entertainer Frontend - This is a client side of Entertainer.'''
 
-__licence__ = "GPLv2"
-__copyright__ = "2007, Lauri Taimila"
-__author__ = "Lauri Taimila <lauri@taimila.com>"
-__version__ = "0.1"
+__licence__ = 'GPLv2'
+__copyright__ = ('2007, Lauri Taimila', '2009, Matt Layman')
+__author__ = ('Lauri Taimila <lauri@taimila.com>',
+              'Matt Layman <laymansterms.dev@gmail.com>')
 
 import sys
 
-from entertainerlib.utils.configuration import Configuration
-from entertainerlib.utils.logger import Logger
+import gtk
+
 from entertainerlib.frontend.backend_connection import BackendConnection
-
-# Media libraries
+from entertainerlib.frontend.gui.user_interface import UserInterface
 from entertainerlib.frontend.medialibrary.feeds import FeedLibrary
 from entertainerlib.frontend.medialibrary.music import MusicLibrary
 from entertainerlib.frontend.medialibrary.images import ImageLibrary
 from entertainerlib.frontend.medialibrary.videos import VideoLibrary
-
-# GUI
-# import gtk    Currently not used
-import clutter
-import gobject
-from entertainerlib.frontend.gui.user_interface import UserInterface
+from entertainerlib.utils.configuration import Configuration
+from entertainerlib.utils.logger import Logger
+from entertainerlib.utils.system_tray_icon import SystemTrayIcon
 
 class FrontendClient:
-    """
+    '''
     Entertainer frontend
 
     This is a frontend application of the Entertainer. Frontend is a GUI part
     that user sees on the screen. This class is a core of the frontend. Frontend
     connects to the backend's messagebus at startup.
-    """
+    '''
 
-    def __init__(self, from_tray_icon=False):
-        """
+    def __init__(self):
+        '''
         Create a new frontend.
 
         This initializes all frontend stuff like media librarys, remote
         control receiver and GUI. After this we just wait user actions.
-        """
-
-        self.config = Configuration()
+        '''
+        config = Configuration()
         self.logger = Logger().getLogger('frontend.FrontendClient')
-        self.backend_connection = None    # Connection to the backend server
-        self.feed_library = None          # Feed library
-        self.music_library = None         # Music library
-        self.image_library = None         # Image library
-        self.video_library = None         # Video library
-        self.ui = None                    # User interface of the frontend
-        self.from_tray_icon = from_tray_icon
-
-        # Initialize clutter threading system.
-        #gtk.gdk.threads_init()
-        gobject.threads_init()
-        clutter.threads_init()
-        #clutter.init()
-
-        self.initialize_backend_connection()
-        self.initialize_media_library()
-        self.initialize_gui()
-        self.ui.start_up(self.config.start_in_fullscreen())
-        if(not self.from_tray_icon):
-            clutter.main()
-        #gtk.main()
-
-    def initialize_media_library(self):
-        """Initialize media library"""
-        self.feed_library = FeedLibrary(self.backend_connection)
-        self.music_library = MusicLibrary(self.backend_connection)
-        self.image_library = ImageLibrary(self.backend_connection)
-        self.video_library = VideoLibrary(self.backend_connection)
+        self.backend_connection = self.initialize_backend_connection()
+        feed_library = FeedLibrary(self.backend_connection)
+        music_library = MusicLibrary(self.backend_connection)
+        image_library = ImageLibrary(self.backend_connection)
+        video_library = VideoLibrary(self.backend_connection)
+        self.ui = UserInterface(
+            feed_library, image_library, music_library, video_library,
+            self.quit_frontend)
+
+        if config.tray_icon_enabled():
+            system_tray_icon = SystemTrayIcon(
+                self.quit_frontend, self.toggle_interface_visibility)
+
+    def start(self):
+        '''Start the necessary main loop.'''
+        self.ui.start_up()
+        self.interface_visible = True
+        gtk.gdk.threads_enter()
+        gtk.main()
+        gtk.gdk.threads_leave()
 
     def initialize_backend_connection(self):
-        """Connect to the backend server."""
+        '''Connect to the backend server.'''
         try:
-            self.backend_connection = BackendConnection()
-            self.logger.debug("Connected to the Entertainer backend server.")
+            backend_connection = BackendConnection()
+            self.logger.debug('Connected to the Entertainer backend server.')
         except:
-            print "Couldn't connect to the backend server. Execution aborted!"
-            print "Make sure that Entertainer backend server is up and running."
+            print 'Couldn\'t connect to the backend server. Execution aborted!'
+            print 'Make sure that Entertainer backend server is up and running.'
             sys.exit(1)
 
-    def initialize_gui(self):
-        """
-        Initialize frontend GUI.
-
-        Create a gui and dislpay it on the screen.
-        """
-        self.ui = UserInterface(self)
+        return backend_connection
 
     def quit_frontend(self):
-        """
+        '''
         Quit Frontend
 
         This is called when user closes frontend. Before closing application
-        the backend connection etc. are closed in a clean way."""
+        the backend connection etc. are closed in a clean way.'''
         try:
             self.backend_connection.close_connection()
         except Exception, e:
-            print "Error closing Backend Connection:", e.message
-            print "Closing anyway"
+            print 'Error closing Backend Connection:', e.message
+            print 'Closing anyway'
             sys.exit(0)
 
-        #gtk.main_quit()
-        if(not self.from_tray_icon):
-            clutter.main_quit()
+        gtk.main_quit()
         sys.exit(0)
 
-    def get_backend_connection(self):
-        """
-        Get Backend connection
-        @return BackendConnection - active connection to the Entertainer backend
-        """
-        return self.backend_connection
-
-    def get_user_interface(self):
-        """
-        Get interface object.
-        @return UserInterface object
-        """
-        return self.ui
-
-    def get_feed_library(self):
-        """Get feed library"""
-        return self.feed_library
-
-    def get_image_library(self):
-        """Get image library"""
-        return self.image_library
-
-    def get_music_library(self):
-        """Get music library"""
-        return self.music_library
-
-    def get_video_library(self):
-        """Get video library"""
-        return self.video_library
+    def toggle_interface_visibility(self):
+        '''Toggle between showing and hiding the interface's visibility.'''
+        if self.interface_visible:
+            self.ui.hide()
+            self.interface_visible = False
+        else:
+            self.ui.show()
+            self.interface_visible = True

=== modified file 'entertainerlib/frontend/gui/user_interface.py'
--- entertainerlib/frontend/gui/user_interface.py	2009-02-04 00:01:22 +0000
+++ entertainerlib/frontend/gui/user_interface.py	2009-02-07 00:48:26 +0000
@@ -20,23 +20,20 @@
 
 class UserInterface:
     """
-    Entertainer frontend user interface.
+    Entertainer user interface.
 
     Object from this class represents the main window of the Entertainer
     client. This window is actually a wrapper for Pigment viewport.
     """
 
-    def __init__(self, frontend):
-        """
-        Initialize user interface.
-        @param frontend: FrontendClient object
-        """
+    def __init__(self, feed_library, image_library, music_library,
+        video_library, quit_frontend_callback):
+        self.quit_frontend_callback = quit_frontend_callback
         self.config = Configuration()
 
         self.STAGE_WIDTH = self.config.get_stage_width()
         self.STAGE_HEIGHT = self.config.get_stage_height()
 
-        self.frontend = frontend
         self.theme = self.config.theme
         self.logger = Logger().getLogger('frontend.gui.UserInterface')
 
@@ -85,10 +82,7 @@
 
         # Screen factory to create new screens
         self.screen_factory = ScreenFactory(
-            self.frontend.get_feed_library(),
-            self.frontend.get_image_library(),
-            self.frontend.get_music_library(),
-            self.frontend.get_video_library(),
+            feed_library, image_library, music_library, video_library,
             self.player, self.history,
             self.move_to_new_screen, self.changeScreen)
 
@@ -132,10 +126,9 @@
         }
         self.move_to_new_screen("question", kwargs)
 
-    def start_up(self, fullscreen):
+    def start_up(self):
         """
         This is called once when Entertainer is starting up.
-        @param fullscreen: Should we start in fullscreen mode
         """
         self.show()
         self.current = self.create_screen("main")
@@ -146,23 +139,7 @@
         """
         This is called once when Entertainer is shutting down.
         """
-        self.frontend.quit_frontend()
-
-    def x(self, percent):
-        """
-        Transform relative position to absolute position of the screen.
-        @param percent: float value between 0-1
-        @return absolute X coordinate (can be used as width as well)
-        """
-        return int(float(self.STAGE_WIDTH) * percent)
-
-    def y(self, percent):
-        """
-        Transform relative position to absolute position of the screen.
-        @param percent: float value between 0-1
-        @return absolute Y coordinate  (can be used as height as well)
-        """
-        return int(float(self.STAGE_HEIGHT) * percent)
+        self.quit_frontend_callback()
 
     def get_stage(self):
         """
@@ -222,9 +199,13 @@
         self.changeScreen(screen, transition)
 
     def show(self):
-        '''Show user interface'''
+        '''Show the user interface.'''
         self.stage.show()
 
+    def hide(self):
+        '''Hide the user interface.'''
+        self.stage.hide()
+
     def _remove_from_stage(self, group):
         '''Remove the listed group from the stage'''
         self.stage.remove(group)

=== modified file 'entertainerlib/tests/test_configuration.py'
--- entertainerlib/tests/test_configuration.py	2009-01-31 21:36:56 +0000
+++ entertainerlib/tests/test_configuration.py	2009-02-07 00:48:26 +0000
@@ -78,10 +78,6 @@
         """Test getting the cfg dir"""
         self.assertEqual(self.configuration.get_cfg_dir(), self.config.TEST_DIR)
 
-    def testIsNotificationsEnabled(self):
-        """Test getting the display_notifications boolean"""
-        self.assertTrue(self.configuration.is_notifications_enabled())
-
     def testTrayIconEnabled(self):
         """Test getting the display_icon boolean"""
         self.assertFalse(self.configuration.tray_icon_enabled())

=== removed file 'entertainerlib/tests/test_systemtraymessagehandler.py'
--- entertainerlib/tests/test_systemtraymessagehandler.py	2009-01-31 21:36:56 +0000
+++ entertainerlib/tests/test_systemtraymessagehandler.py	1970-01-01 00:00:00 +0000
@@ -1,168 +0,0 @@
-'''Tests the SystemTrayMessageHandler'''
-
-__licence__ = "GPLv2"
-__copyright__ = "2008, Joshua Scotton"
-__author__ = "Joshua Scotton <josh@joshuascotton.com>"
-
-import unittest
-
-from entertainerlib.utils.system_tray_icon import SystemTrayMessageHandler
-
-DEFAULT_MESSAGE = ""
-DEFAULT_TITLE = "Entertainer Media Center"
-DEFAULT_LENGTH = 5
-DEFAULT_ICON = "dialog-information"
-DEFAULT_URGENCY = "LOW"
-
-NORMAL_ICON = 0
-
-class MockMessageBusProxy:
-    """This is a dummy MessageBusProxy class for the test"""
-
-    def __init__(self):
-        pass
-
-class MockSystemTrayIcon:
-    """This is a dummy SystemTrayIcon class for the test"""
-
-    NORMAL_ICON = 0
-
-    def __init__(self):
-        self.current_message = DEFAULT_MESSAGE
-        self.current_title = DEFAULT_TITLE
-        self.current_length = DEFAULT_LENGTH
-        self.current_icon = DEFAULT_ICON
-        self.current_urgency = DEFAULT_URGENCY
-        self.main_icon = NORMAL_ICON
-
-    def check_current_values(self, message, title, length, icon, urgency):
-        '''See SystemTrayIcon'''
-        return (message == self.current_message) \
-                and (title == self.current_title) \
-                and (length == self.current_length) \
-                and (icon == self.current_icon) \
-                and (urgency == self.current_urgency)
-
-    def show_message(self, message,
-                    title=DEFAULT_TITLE,
-                    length=DEFAULT_LENGTH, icon=DEFAULT_ICON,
-                    urgency=DEFAULT_URGENCY):
-        '''See SystemTrayIcon'''
-        self.current_message = message
-        self.current_title = title
-        self.current_length = length
-        self.current_icon = icon
-        self.current_urgency = urgency
-
-        # This print can be uncommented if debugging is needed
-        #print (self.current_message, self.current_title, self.current_length,
-        #    self.current_icon, self.current_urgency)
-
-    def change_icon(self, icon_state):
-        '''See SystemTrayIcon'''
-        self.main_icon = NORMAL_ICON
-
-class SystemTrayMessageHandlerTest(unittest.TestCase):
-    '''Tests SystemTrayMessageHandler'''
-
-    def setUp(self):
-        """Sets up everything for the test"""
-        self.tray_icon = MockSystemTrayIcon()
-        self.message_handler = SystemTrayMessageHandler(self.tray_icon)
-
-    def testSystemTrayMessageHandler001(self):
-        """Check if main_icon is set up right for tests"""
-        self.assertEquals(self.message_handler.get_tray_icon().main_icon,
-                          NORMAL_ICON)
-
-    def testSystemTrayMessageHandler002(self):
-        """Check if current values are set up right for tests"""
-        self.assertTrue(
-            self.message_handler.get_tray_icon().check_current_values(
-                DEFAULT_MESSAGE, DEFAULT_TITLE, DEFAULT_LENGTH,
-                DEFAULT_ICON, DEFAULT_URGENCY)
-            )
-
-    def testSystemTrayMessageHandler003(self):
-        """Test init 001"""
-        self.assertFalse(self.message_handler.get_debug())
-
-    def testSystemTrayMessageHandler004(self):
-        """Test init 002"""
-        self.assertEqual(self.message_handler.get_tray_icon(), self.tray_icon)
-
-    def testSystemTrayMessageHandler005(self):
-        """Test init 003"""
-        self.assertEqual(self.message_handler.get_message_bus_proxy(), None)
-
-    def testSystemTrayMessageHandler006(self):
-        """Test init 004"""
-        self.message_handler = SystemTrayMessageHandler(self.tray_icon, True)
-        self.assertTrue(self.message_handler.get_debug())
-
-    def testSystemTrayMessageHandler007(self):
-        """Test init 005"""
-        self.message_handler = SystemTrayMessageHandler(self.tray_icon, True)
-        self.assertEqual(self.message_handler.get_tray_icon(), self.tray_icon)
-
-    def testSystemTrayMessageHandler008(self):
-        """Test set_tray_icon()"""
-        new_tray_icon = MockSystemTrayIcon()
-        self.message_handler.set_tray_icon(new_tray_icon)
-        self.assertEqual(new_tray_icon, self.message_handler.tray_icon)
-
-    def testSystemTrayMessageHandler009(self):
-        """Test init 009"""
-        self.assertEqual(self.message_handler.get_tray_icon(), self.tray_icon)
-
-    def testSystemTrayMessageHandler010(self):
-        """Test get_debug"""
-        self.assertFalse(self.message_handler.get_debug())
-
-    def testSystemTrayMessageHandler011(self):
-        """Test set_debug() when setting True"""
-        self.message_handler.set_debug(True)
-        self.assertTrue(self.message_handler.get_debug())
-
-    def testSystemTrayMessageHandler012(self):
-        """Test set_debug() when setting False"""
-        self.message_handler.set_debug(True)
-        self.message_handler.set_debug(False)
-        self.assertFalse(self.message_handler.get_debug())
-
-    # NOT USED def testSystemTrayMessageHandler013(self):
-
-    # NOT USED def testSystemTrayMessageHandler014(self):
-
-    # NOT USED def testSystemTrayMessageHandler015(self):
-
-    # NOT USED def testSystemTrayMessageHandler016(self):
-
-    # NOT USED def testSystemTrayMessageHandler017(self):
-
-    # NOT USED def testSystemTrayMessageHandler018(self):
-
-    # NOT USED def testSystemTrayMessageHandler019(self):
-
-    # NOT USED def testSystemTrayMessageHandler020(self):
-
-    # NOT USED def testSystemTrayMessageHandler021(self):
-
-    # NOT USED def testSystemTrayMessageHandler022(self):
-
-    # NOT USED def testSystemTrayMessageHandler023(self):
-
-    # NOT USED def testSystemTrayMessageHandler024(self):
-
-    # NOT USED def testSystemTrayMessageHandler025(self):
-
-    def testSystemTrayMessageHandler026(self):
-        """testSystemTrayMessageHandler026: Test set_message_bus_proxy()"""
-        testProxy = MockMessageBusProxy()
-        self.message_handler.set_message_bus_proxy(testProxy)
-        self.assertEquals(testProxy, self.message_handler.message_bus_proxy)
-
-    def testSystemTrayMessageHandler027(self):
-        """testSystemTrayMessageHandler027: Test get_message_bus_proxy()"""
-        self.assertEquals(self.message_handler.get_message_bus_proxy(), None)
-

=== modified file 'entertainerlib/utils/configuration.py'
--- entertainerlib/utils/configuration.py	2009-01-26 18:28:26 +0000
+++ entertainerlib/utils/configuration.py	2009-02-07 00:48:26 +0000
@@ -247,18 +247,6 @@
         else:
             return os.path.join(theme_path, "Default")
 
-    def is_notifications_enabled(self):
-        """
-        Display on-screen notification bubbles on events.
-        @return: boolean
-        """
-        try:
-            result = self.preferences.getboolean("General",
-                "display_notifications")
-        except (NoSectionError, NoOptionError):
-            return False
-        return result
-
     def tray_icon_enabled(self):
         """
         Display tray icon.

=== modified file 'entertainerlib/utils/glade/entertainer-preferences.glade'
--- entertainerlib/utils/glade/entertainer-preferences.glade	2009-01-26 22:25:47 +0000
+++ entertainerlib/utils/glade/entertainer-preferences.glade	2009-02-07 00:48:26 +0000
@@ -68,20 +68,6 @@
                               </packing>
                             </child>
                             <child>
-                              <widget class="GtkCheckButton" id="checkbutton_notifications">
-                                <property name="visible">True</property>
-                                <property name="can_focus">True</property>
-                                <property name="events">GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK | GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK</property>
-                                <property name="label" translatable="yes">Display notifications on desktop</property>
-                                <property name="response_id">0</property>
-                                <property name="draw_indicator">True</property>
-                                <signal name="toggled" handler="on_checkbutton_notifications_toggled"/>
-                              </widget>
-                              <packing>
-                                <property name="position">2</property>
-                              </packing>
-                            </child>
-                            <child>
                               <placeholder/>
                             </child>
                           </widget>

=== modified file 'entertainerlib/utils/preferences_dialog.py'
--- entertainerlib/utils/preferences_dialog.py	2009-01-27 01:51:57 +0000
+++ entertainerlib/utils/preferences_dialog.py	2009-02-07 00:48:26 +0000
@@ -47,8 +47,6 @@
                     self.on_theme_list_cursor_changed,
                 "on_checkbutton_autostart_toggled" :
                     self.on_checkbutton_autostart_toggled,
-                "on_checkbutton_notifications_toggled" :
-                    self.on_checkbutton_notifications_toggled,
                 "on_checkbutton_systray_icon_toggled" :
                     self.on_checkbutton_systray_icon_toggled,
                 "on_effect_checkbox_toggled" : self.on_effect_checkbox_toggled,
@@ -174,11 +172,6 @@
         self.config.write_preference_value("General", "display_icon",
             widget.get_active())
 
-    def on_checkbutton_notifications_toggled(self, widget):
-        """Display notifications checkbox toggled"""
-        self.config.write_preference_value("General", "display_notifications",
-            widget.get_active())
-
     def on_checkbutton_autostart_toggled(self, widget):
         """Server Autostart checkbox toggled"""
         self.config.write_preference_value("General", "start_server_auto",
@@ -275,8 +268,6 @@
         effect_combobox = self.widgets.get_widget("effect_combobox")
         checkbutton_systray_icon = self.widgets.get_widget(
             "checkbutton_systray_icon")
-        checkbutton_notifications = self.widgets.get_widget(
-            "checkbutton_notifications")
         checkbutton_autostart = self.widgets.get_widget(
             "checkbutton_autostart")
         spinbutton_slideshow_step = self.widgets.get_widget(
@@ -285,7 +276,6 @@
         show_effects = self.config.show_effects()
         effect = self.config.transition_effect()
         start_icon = self.config.tray_icon_enabled()
-        notify = self.config.is_notifications_enabled()
         start_server_auto  = self.config.start_auto_server()
         slideshow_step = self.config.get_slideshow_step()
 
@@ -294,11 +284,6 @@
         else:
             checkbutton_systray_icon.set_active(False)
 
-        if notify:
-            checkbutton_notifications.set_active(True)
-        else:
-            checkbutton_notifications.set_active(False)
-
         if start_server_auto:
             checkbutton_autostart.set_active(True)
         else:

=== modified file 'entertainerlib/utils/system_tray_icon.py'
--- entertainerlib/utils/system_tray_icon.py	2008-12-16 21:53:44 +0000
+++ entertainerlib/utils/system_tray_icon.py	2009-02-07 00:48:26 +0000
@@ -5,21 +5,15 @@
 __author__ = "Lauri Taimila <lauri@taimila.com>"
 
 import os
-import sys
 
-import gobject
 import gtk
 import gtk.glade
-import pynotify
 
-from entertainerlib.backend.core.message_bus_proxy import MessageBusProxy
-from entertainerlib.backend.core.message_handler import MessageHandler
 from entertainerlib.utils.log_viewer import LogViewer
 from entertainerlib.utils.preferences_dialog import PreferencesDialog
 from entertainerlib.utils.content_management_dialog import (
     ContentManagementDialog)
 from entertainerlib.utils.configuration import Configuration
-from entertainerlib.frontend.frontend_client import FrontendClient
 
 class SystemTrayIcon:
     """Implements system tray icon for entertainer."""
@@ -27,30 +21,15 @@
     FILE_DIR = os.path.dirname(__file__)
     GLADE_DIR = os.path.join(FILE_DIR, "glade")
 
-    # Icon states
-    NORMAL_ICON = 0
-    RECORD_ICON = 1
-
-    def __init__(self, debug=False, start_frontend=False, frontend=None,
-        notify=True):
+    def __init__(self, quit_callback, toggle_interface_visibility_callback):
         """
         Create system tray icon and pop-up menu for it.
         @author ["Joshua Scotton", "Lauri Taimila"]
-        @param debug If True than debugging inotify messages will be shown
-        @param start_frontend should the frontend be started
-        @param frontend FrontendClient to be associated with this class
-        @param notify Should messages be shown? defaults to True
         """
-        self.debug = debug
+        self.quit_callback = quit_callback
+        self.toggle_interface_visibility_callback = \
+            toggle_interface_visibility_callback
         self.config = Configuration()
-        self.popup = None
-        if not (frontend == None):
-            self.frontend = frontend
-            self.frontend_visible = True
-        else:
-            self.frontend = None
-            self.frontend_visible = False
-        self.notify = notify
 
         # Path to the tray icon when using a branch
         self.tray_icon_url = os.path.join(self.FILE_DIR, "..", "..", "icons",
@@ -59,15 +38,6 @@
         self.icon_widget = gtk.StatusIcon()
         self.icon_widget.set_tooltip(_("Entertainer Server"))
 
-        # Check if running from a branch to set the tray icon
-        if (os.path.exists(self.tray_icon_url)):
-            self.icon_widget.set_from_file(self.tray_icon_url)
-        else:
-            # Must be running from a package, therefore available by icon name
-            self.icon_widget.set_from_icon_name("entertainer")
-
-        self.message_handler = SystemTrayMessageHandler(self, debug)
-
         # Load glade files
         self.menu_widgets = gtk.glade.XML(
             os.path.join(self.GLADE_DIR, "system_tray_icon_menu.glade"))
@@ -86,48 +56,20 @@
                         }
         self.menu_widgets.signal_autoconnect(callback_dic)
         self.popup = self.menu_widgets.get_widget("SystemTrayIconMenu")
+
+        # Check if running from a branch to set the tray icon
+        if (os.path.exists(self.tray_icon_url)):
+            self.icon_widget.set_from_file(self.tray_icon_url)
+        else:
+            # Must be running from a package, therefore available by icon name
+            self.icon_widget.set_from_icon_name("entertainer")
+
         self.icon_widget.connect('activate', self.systray_icon_activated)
         self.icon_widget.connect('popup-menu', self.open_popup_menu)
-        if(start_frontend):
-            self.set_frontend_visible(True)
-
-    def show_message(self, message,
-                    title=_("Entertainer Media Center"),
-                    length=5, icon="dialog-information",
-                    urgency="LOW"):
-        """
-        Show libnotify message
-        Thanks to http://roscidus.com/desktop/node/336 for info on this
-        @author Joshua Scotton
-        """
-        if self.notify:
-            if pynotify.init("Entertainer Media Center"):
-                notifier = pynotify.Notification(title, message, icon)
-                if urgency == "CRITICAL":
-                    notifier.set_urgency(pynotify.URGENCY_CRITICAL)
-                elif urgency == "NORMAL":
-                    notifier.set_urgency(pynotify.URGENCY_NORMAL)
-                else:
-                    notifier.set_urgency(pynotify.URGENCY_LOW)
-                notifier.set_timeout(length*1000)
-                notifier.attach_to_status_icon(self.icon_widget)
-                notifier.show()
-            else:
-                raise Exception("Problem with pynotify")
-        else:
-            print message
-
-    def show_icon(self):
-        """Show icon in system tray"""
-        self.icon_widget.set_visible(True)
-
-    def hide_icon(self):
-        """Hide icon from system tray"""
-        self.icon_widget.set_visible(False)
 
     def systray_icon_activated(self, widget, data= None):
         """Switch visibility of frontend when system tray icon is clicked"""
-        self.switch_frontend_visibility()
+        self.toggle_interface_visibility_callback()
 
     def open_popup_menu(self, widget, button, time, data = None):
         """Display pop-up menu when system tray icon is clicked"""
@@ -140,184 +82,17 @@
 
     def on_menuitem_preferences_activate(self, widget):
         """Executes preferences-tool."""
-        if self.debug:
-            self.show_message("Starting preferences...")
         PreferencesDialog(False)
 
     def on_menuitem_content_management_activate(self, widget):
         """Executes content-management-tool"""
-        if self.debug:
-            self.show_message("Starting content management...")
         ContentManagementDialog(False)
 
     def on_menuitem_log_viewer_activate(self, widget):
         """Display log viewer dialog"""
-        if self.debug:
-            self.show_message("Starting log viewer...")
         LogViewer(False)
 
     def on_menuitem_quit_activate(self, widget):
-        """Show confirmation dialog and quit backend"""
-        #FIXME Doesn't work yet hangs on threads_enter so commented out
-        self.get_message_bus_proxy().disconnectFromMessageBus()
-        if self.debug:
-            self.show_message("Quitting...")
-
-        if(not self.frontend == None):
-            self.frontend.quit_frontend()
-        #gtk.gdk.threads_enter()
-        gtk.main_quit()
-        #gtk.gdk.threads_leave()
-        sys.exit()
-
-    def set_message_bus_proxy(self, proxy):
-        """
-        This sets the MessageBusProxy object for the SystemTrayMessageHandler
-        @author Joshua Scotton
-        """
-        self.get_message_handler().set_message_bus_proxy(proxy)
-
-    def get_message_bus_proxy(self):
-        """
-        This gets the MessageBusProxy object from the SystemTrayMessageHandler
-        @author Joshua Scotton
-        """
-        return self.get_message_handler().get_message_bus_proxy()
-
-    def set_message_handler(self, message_handler):
-        """
-        This sets the associated SystemTrayMessageHandler
-        @author Joshua Scotton
-        """
-        self.message_handler = message_handler
-
-    def get_message_handler(self):
-        """
-        This gets the associated SystemTrayMessageHandler
-        @author Joshua Scotton
-        """
-        return self.message_handler
-
-    def set_frontend_visible(self, show=True):
-        """
-        Set the frontend to visible
-        @author Joshua Scotton
-        """
-        if(show):
-            if(self.frontend == None):
-                if self.debug:
-                    self.show_message("Starting Frontend...")
-                self.frontend = FrontendClient(True)
-            else:
-                if self.debug:
-                    self.show_message("Showing Frontend...")
-                self.frontend.ui.get_stage().show()
-            self.frontend_visible = True
-        elif(not show and not self.frontend == None):
-            if self.debug:
-                self.show_message("Hiding Frontend...")
-            self.frontend.ui.get_stage().hide()
-            self.frontend_visible = False
-
-    def get_frontend_visible(self):
-        """
-        Return the visibility of the frontend
-        @author Joshua Scotton
-        """
-        return self.frontend_visible
-
-    def switch_frontend_visibility(self):
-        """
-        Switches the visibility of the frontend
-        @author Joshua Scotton
-        """
-        if(self.get_frontend_visible()==False):
-            self.set_frontend_visible(True)
-        else:
-            self.set_frontend_visible(False)
-
-class SystemTrayMessageHandler(MessageHandler):
-    """
-    This handles the messages which are intended for the system tray icon
-    @author Joshua Scotton
-    """
-
-    def __init__(self, tray_icon, debug=False):
-        """
-        This sets up the SystemTrayMessageHandler object
-        """
-        MessageHandler.__init__(self)
-        self.debug = debug
-        self.tray_icon = tray_icon
-        self.message_bus_proxy = None
-
-    def set_tray_icon(self, tray_icon):
-        """
-        This sets the SystemTrayIcon object associated with this SystemTrayMessageHandler
-        """
-        self.tray_icon = tray_icon
-    def get_tray_icon(self):
-        """
-        Gets the SystemTrayIcon for this object
-        """
-        return self.tray_icon
-    def set_message_bus_proxy(self, proxy):
-        """
-        This sets the MessageBusProxy for this object
-        """
-        self.message_bus_proxy = proxy
-    def get_message_bus_proxy(self):
-        """
-        This gets the MessageBusProxy for this object
-        """
-        return self.message_bus_proxy
-    def set_debug(self, debug):
-        """
-        This sets debugging messages to True or False
-        """
-        self.debug = debug
-    def get_debug(self):
-        """
-        Returns whether debugging messages should be shown
-        """
-        return self.debug
-
-    # Implement MessageHandler interface
-
-    def handleMessage(self, message):
-        """Handles messages for the SystemTrayIcon"""
-        pass
-
-def init_systray():
-    '''Start the systray tasks.'''
-
-    config = Configuration()
-    message_dict = {}
-
-    gobject.threads_init()
-    gtk.gdk.threads_init()
-
-    # Create tray icon
-    gtk.gdk.threads_enter()
-
-    #Start SystemTrayIcon with show on start True
-    notify = config.is_notifications_enabled()
-    tray_icon = SystemTrayIcon(start_frontend=True, notify=notify)
-    gtk.gdk.threads_leave()
-
-    try:
-        # Open connection to backend
-        proxy = MessageBusProxy(message_dict, tray_icon.get_message_handler(),
-            "system-tray-icon")
-        proxy.connectToMessageBus()
-        proxy.start()
-        tray_icon.get_message_handler().set_message_bus_proxy(proxy)
-
-    except:
-        print "Backend is not running. Start backend and try again."
-        sys.exit(1)
-
-    gtk.gdk.threads_enter()
-    gtk.main()
-    gtk.gdk.threads_leave()
+        '''Close the application by calling the quit callback.'''
+        self.quit_callback()

Revision history for this message

Matt Layman (mblayman) wrote on 2009-02-07:

#

By the way, for those who are interested, here are some stats on the diff (a la diffstat):

cfg/preferences.conf | 1
docs/DEPENDENCIES | 2
entertainerlib/backend/backend_server.py | 2
entertainerlib/frontend/__init__.py | 15
entertainerlib/frontend/frontend_client.py | 152 +++-----
entertainerlib/frontend/gui/user_interface.py | 43 --
entertainerlib/tests/test_configuration.py | 4
entertainerlib/tests/test_systemtraymessagehandler.py | 168 ---------
entertainerlib/utils/configuration.py | 12
entertainerlib/utils/glade/entertainer-preferences.glade | 14
entertainerlib/utils/preferences_dialog.py | 15
entertainerlib/utils/system_tray_icon.py | 255 ---------------
12 files changed, 93 insertions(+), 590 deletions(-)

Revision history for this message

Paul Hummer (rockstar) wrote on 2009-02-07:

#

Matt-

Good branch. It was big, but most of it was just removing code (which I
didn't see initially). I just have two nitpicks with docstrings. That's it.

vote approve
status approved

> === modified file 'entertainerlib/frontend/frontend_client.py'
> --- entertainerlib/frontend/frontend_client.py 2009-01-31 15:46:36
> +0000 +++ entertainerlib/frontend/frontend_client.py 2009-02-07
> 00:48:26 +0000 @@ -1,139 +1,97 @@
> def quit_frontend(self):
> - """
> + '''
> Quit Frontend
>
> This is called when user closes frontend. Before closing application
> - the backend connection etc. are closed in a clean way."""
> + the backend connection etc. are closed in a clean way.'''

This docstring is a bit verbose for what it does. It could easily be a one
liner.

> === modified file 'entertainerlib/frontend/gui/user_interface.py'
> --- entertainerlib/frontend/gui/user_interface.py 2009-02-04 00:01:22
> +0000 +++ entertainerlib/frontend/gui/user_interface.py 2009-02-07
> @@ -132,10 +126,9 @@
> }
> self.move_to_new_screen("question", kwargs)
>
> - def start_up(self, fullscreen):
> + def start_up(self):
> """
> This is called once when Entertainer is starting up.
> - @param fullscreen: Should we start in fullscreen mode
> """
> self.show()
> self.current = self.create_screen("main")

Could you put this docstring on one line?

--
Paul Hummer
http://theironlion.net
1024/862FF08F C921 E962 58F8 5547 6723 0E8C 1C4D 8AC5 862F F08F

review: Approve

Revision history for this message

Matt Layman (mblayman) wrote on 2009-02-07:

#

"Matt-

Good branch. It was big, but most of it was just removing code (which I
didn't see initially). I just have two nitpicks with docstrings. That's it.

vote approve
status approved

> === modified file 'entertainerlib/frontend/frontend_client.py'
> --- entertainerlib/frontend/frontend_client.py 2009-01-31 15:46:36
> +0000 +++ entertainerlib/frontend/frontend_client.py 2009-02-07
> 00:48:26 +0000 @@ -1,139 +1,97 @@
> def quit_frontend(self):
> - """
> + '''
> Quit Frontend
>
> This is called when user closes frontend. Before closing application
> - the backend connection etc. are closed in a clean way."""
> + the backend connection etc. are closed in a clean way.'''

This docstring is a bit verbose for what it does. It could easily be a one
liner.

> === modified file 'entertainerlib/frontend/gui/user_interface.py'
> --- entertainerlib/frontend/gui/user_interface.py 2009-02-04 00:01:22
> +0000 +++ entertainerlib/frontend/gui/user_interface.py 2009-02-07
> @@ -132,10 +126,9 @@
> }
> self.move_to_new_screen("question", kwargs)
>
> - def start_up(self, fullscreen):
> + def start_up(self):
> """
> This is called once when Entertainer is starting up.
> - @param fullscreen: Should we start in fullscreen mode
> """
> self.show()
> self.current = self.create_screen("main")

Could you put this docstring on one line?

--
Paul Hummer
http://theironlion.net
1024/862FF08F C921 E962 58F8 5547 6723 0E8C 1C4D 8AC5 862F F08F
"

Ha, of course it's for doc strings that I didn't write :). I'll fix these up and push up a fix. I'll post the partial diff when I'm done.

lp:~mblayman/entertainer/frontend-cleanup updated on 2009-02-07

346. By Matt Layman on 2009-02-07: Updated doc strings

Revision history for this message

Matt Layman (mblayman) wrote on 2009-02-07:

#

Partial diff:

=== modified file 'entertainerlib/frontend/frontend_client.py'
--- entertainerlib/frontend/frontend_client.py 2009-02-07 00:28:11 +0000
+++ entertainerlib/frontend/frontend_client.py 2009-02-07 19:36:01 +0000
@@ -71,11 +71,7 @@
return backend_connection

     def quit_frontend(self):
- '''
- Quit Frontend
-
- This is called when user closes frontend. Before closing application
- the backend connection etc. are closed in a clean way.'''
+ '''Clean up the connection to the backend then close the frontend.'''
         try:
             self.backend_connection.close_connection()
         except Exception, e:

=== modified file 'entertainerlib/frontend/gui/user_interface.py'
--- entertainerlib/frontend/gui/user_interface.py 2009-02-07 00:28:11 +0000
+++ entertainerlib/frontend/gui/user_interface.py 2009-02-07 19:42:25 +0000
@@ -127,9 +127,7 @@
self.move_to_new_screen("question", kwargs)

     def start_up(self):
- """
- This is called once when Entertainer is starting up.
- """
+ '''Start the user interface and make it visible.'''
         self.show()
         self.current = self.create_screen("main")
         self.transition.forward_effect(None, self.current)

Entertainer Media Center

Merge lp:~mblayman/entertainer/frontend-cleanup into lp:entertainer

Commit message

Description of the change

Subscribers