Merge lp:~mblayman/entertainer/clean-messages into lp:entertainer/future

[Matt Layman]

Removes some crufty backend connection messages that did nothing.

[Matt Layman (mblayman)]

OOPS, sorry, I certainly meant to target this branch to future.

Dependent on working-sdist (which I guess is just future now).

This is just some work to clean out a bunch of junk in the backend and try to separate the client from the backend in a more clear manner.

I did a bunch of analysis of what we are/aren't using in terms of messages. This led to some nice cleanup and removal of some methods that simply weren't needed.

I know this may not seem like important work, but it means that there will be less pain when it comes time to completely remove elements of the backend that exist in the client code. Less contact points means less work in the future.

[Paul Hummer (rockstar)]

review: Approve

=== modified file 'entertainer-backend'
--- entertainer-backend	2009-05-06 02:58:08 +0000
+++ entertainer-backend	2009-09-08 02:02:58 +0000
@@ -51,11 +51,7 @@
         sys.exit(0)
 
     if len(sys.argv) > 1 and sys.argv[1] == "--foreground":
-        try:
-            backend = BackendServer()
-        except KeyboardInterrupt:
-            backend.quitBackend()
-            sys.exit()
+        backend = BackendServer()
     else:
         print "Entertainer backend starting..."
         libc = ctypes.CDLL('libc.so.6')

=== modified file 'entertainerlib/backend/backend_server.py'
--- entertainerlib/backend/backend_server.py	2009-08-23 01:16:18 +0000
+++ entertainerlib/backend/backend_server.py	2009-09-08 02:02:58 +0000
@@ -98,7 +98,3 @@
         self.message_bus.registerMessageHandler(self.media_manager, media_dict)
         self.logger.debug("Media Manager intialized successfully")
 
-    def quitBackend(self):
-        '''Close the backend server'''
-        self.message_bus.unregisterAllMessageHandlers()
-

=== modified file 'entertainerlib/backend/core/message_bus.py'
--- entertainerlib/backend/core/message_bus.py	2009-05-10 17:36:49 +0000
+++ entertainerlib/backend/core/message_bus.py	2009-09-08 02:02:58 +0000
@@ -23,12 +23,7 @@
     When MessageHandler is registered to the MessageBus there is also another
     parameter besides handler itself. Second parameter is a dictionary that
     defines MessageTypes that registered handler wants to be notified of and
-    also priorities for those message types.
-
-    Example of second parameter:
-            dict = {MessageType.FRONTEND_OPENED : MessagePriority.LOW ,
-                    MessageType.FRONTEND_CLOSED : MessagePriority.NORMAL }
-    """
+    also priorities for those message types."""
 
     # This determines number of message types avaialble. In other words, this
     # variable tells how many variables is defined in MessageType class.
@@ -89,12 +84,6 @@
         self.logger.debug("MessageHandler '" + str(message_handler) +
                           "' unregistered from the message bus.")
 
-    def unregisterAllMessageHandlers(self):
-        """
-        Unregisters all MessageHandler from this MessageBus.
-        """
-        self.message_handlers[:] = []
-
     def notifyMessage(self, message):
         """
         Emit a new Message to this MessageBus.

=== modified file 'entertainerlib/backend/core/message_type_priority.py'
--- entertainerlib/backend/core/message_type_priority.py	2009-08-23 01:16:18 +0000
+++ entertainerlib/backend/core/message_type_priority.py	2009-09-08 00:53:03 +0000
@@ -15,56 +15,27 @@
     VERY_LOW = 40
 
 class MessageType:
-    """
-    Determines all allowed Message types. MessageHandler should use these
-    to determine type. This simply makes code more readable.
-
-    Example:
-        if message.get_type() == MessageType.FRONTEND_OPENED:
-            do_something_useful()
-    """
-
-    # Indicates that Preferences UI has been used to update preferences.
-    NOT_USED_7 = 0
+    """Determines all allowed Message types. MessageHandler should use these to
+    determine type. This simply makes code more readable."""
 
     # Indicates that Content Management UI has been used to update contents.
-    CONTENT_CONF_UPDATED = 1
-
-    # Indicates that client has been opened.
-    FRONTEND_OPENED = 2
-
-    # Indicates that client has been closed.
-    FRONTEND_CLOSED = 3
+    CONTENT_CONF_UPDATED = 0
 
     # Indicates that Feed cache has been updated.
-    FEED_DB_UPDATED = 4
-
-    NOT_USED_5 = 5
-
-    NOT_USED_1 = 6
+    FEED_DB_UPDATED = 1
 
     # Indicates that Feed cache should be updated.
-    UPDATE_FEEDS = 7
-
-    NOT_USED_6 = 8
-
-    #This should be left in otherwise message_bus.py breaks
-    #If another message type is needed please use this
-    DO_NOT_DELETE_USE_NEXT = 9
-
-    NOT_USED_2 = 10
-    NOT_USED_3 = 11
-    NOT_USED_4 = 12
+    UPDATE_FEEDS = 2
 
     # Require to rebuild image cache
-    REBUILD_IMAGE_CACHE = 13
+    REBUILD_IMAGE_CACHE = 3
 
     # Require to rebuild music cache
-    REBUILD_MUSIC_CACHE = 14
+    REBUILD_MUSIC_CACHE = 4
 
     # Require to rebuild video cache
-    REBUILD_VIDEO_CACHE = 15
+    REBUILD_VIDEO_CACHE = 5
 
     # Require to rebuild feed cache
-    REBUILD_FEED_CACHE = 16
+    REBUILD_FEED_CACHE = 6
 

=== modified file 'entertainerlib/client/backend_connection.py'
--- entertainerlib/client/backend_connection.py	2009-08-23 01:16:18 +0000
+++ entertainerlib/client/backend_connection.py	2009-09-08 02:40:16 +0000
@@ -7,46 +7,21 @@
 from entertainerlib.backend.core.message_handler import MessageHandler
 
 class BackendConnection(MessageHandler):
-    """
-    BackendConnection - Connection to the Entertainer backend. Instance from
-    this class is a gate to backend messagebus.
-    """
+    """Connection to the Entertainer backend messagebus."""
 
     def __init__(self):
-        """Initialize connection. Connects to backend."""
-        #messages = {
-        #    MessageType.CONTENT_CONF_UPDATED : MessagePriority.NORMAL,
-        #    MessageType.FEED_DB_UPDATED : MessagePriority.HIGH }
-        # XXX: rockstar - The messages above are the "real" messages, and I'm
-        # not sure why they are commented out.  Anyone?
         MessageHandler.__init__(self)
         messages = {}
         name = "Entertainer Frontend"
         self.message_bus_proxy = MessageBusProxy(messages, self, name)
         self.message_bus_proxy.connectToMessageBus()
         self.message_bus_proxy.start()
-        self.message_bus_proxy.sendMessage(
-            Message(MessageType.FRONTEND_OPENED))
 
     def close_connection(self):
         """Close connection to backend"""
-        self.message_bus_proxy.sendMessage(
-            Message(MessageType.FRONTEND_CLOSED))
         self.message_bus_proxy.disconnectFromMessageBus()
 
     def request_feed_update(self):
         """Request backend to fetch all feeds from the Internet."""
         self.message_bus_proxy.sendMessage(Message(MessageType.UPDATE_FEEDS))
 
-    def request_weather_update(self):
-        """Request backend to update weather information from the Internet."""
-        self.message_bus_proxy.sendMessage(Message(MessageType.UPDATE_WEATHER))
-
-    # Implements MessageHandler interface
-    def handleMessage(self, message):
-        """Handle received messages. (Implements MessageHandler interface)"""
-        if message.get_type() == MessageType.CONTENT_CONF_UPDATED:
-            pass
-        elif message.get_type() == MessageType.FEED_DB_UPDATED:
-            pass
-

=== modified file 'entertainerlib/client/client.py'
--- entertainerlib/client/client.py	2009-08-16 21:53:22 +0000
+++ entertainerlib/client/client.py	2009-09-08 02:40:16 +0000
@@ -10,49 +10,35 @@
 from twisted.internet.protocol import ClientCreator
 from twisted.python.log import startLogging
 
-
 from entertainerlib.client.backend_connection import BackendConnection
-from entertainerlib.gui.user_interface import UserInterface
 from entertainerlib.client.medialibrary.feeds import FeedLibrary
 from entertainerlib.client.medialibrary.music import MusicLibrary
 from entertainerlib.client.medialibrary.images import ImageLibrary
 from entertainerlib.client.medialibrary.videos import VideoLibrary
 from entertainerlib.configuration import Configuration
+from entertainerlib.gui.user_interface import UserInterface
 from entertainerlib.gui.system_tray_icon import SystemTrayIcon
-from entertainerlib.logger import Logger
 from entertainerlib.network.local.client import EntertainerLocalClientProtocol
 
 
 class Client:
-    '''
-    Entertainer client
-
-    This is a client application of the Entertainer.  Entertainer's client
+    '''This is a client application of the Entertainer. Entertainer's client
     hooks into the server, and then provides a user interface for the data the
-    server creates.
-    '''
+    server creates.'''
 
     def __init__(self):
-        '''
-        Create a new client.
-
-        This initializes all client stuff like media librarys, remote
-        control receiver and GUI. After this we just wait user actions.
-        '''
         config = Configuration()
-        self.logger = Logger().getLogger('client.Client')
-        self.backend_connection = self.initialize_backend_connection()
+        self.backend_connection = BackendConnection()
         feed_library = FeedLibrary(self.backend_connection)
-        music_library = MusicLibrary(self.backend_connection)
-        image_library = ImageLibrary(self.backend_connection)
-        video_library = VideoLibrary(self.backend_connection)
+        music_library = MusicLibrary()
+        image_library = ImageLibrary()
+        video_library = VideoLibrary()
         self.ui = UserInterface(
             feed_library, image_library, music_library, video_library,
             self.quit_client)
 
         if config.tray_icon_enabled:
-            SystemTrayIcon(
-                self.quit_client, self.toggle_interface_visibility)
+            SystemTrayIcon(self.quit_client, self.toggle_interface_visibility)
 
         startLogging(sys.stdout)
         client = EntertainerLocalClientProtocol
@@ -61,7 +47,6 @@
             config.network_options['host'],
             config.network_options['port'])
 
-
     def start(self):
         '''Start the necessary main loop.'''
         self.ui.start_up()
@@ -70,13 +55,6 @@
         reactor.run()
         gtk.gdk.threads_leave()
 
-    def initialize_backend_connection(self):
-        '''Connect to the backend server.'''
-        backend_connection = BackendConnection()
-        self.logger.debug('Connected to the Entertainer backend server.')
-
-        return backend_connection
-
     def quit_client(self):
         '''Clean up the connection to the backend then close the client.'''
         self.backend_connection.close_connection()

=== modified file 'entertainerlib/client/medialibrary/images.py'
--- entertainerlib/client/medialibrary/images.py	2009-05-10 17:36:49 +0000
+++ entertainerlib/client/medialibrary/images.py	2009-09-08 02:40:16 +0000
@@ -7,22 +7,13 @@
 from entertainerlib.configuration import Configuration
 
 class ImageLibrary:
-    """
-    Image library.
-
-    Entertainer's image cache.
-    """
-
-    def __init__(self, backend_connection):
-        """
-        Initialize image library
-        @param backend_connection: BackendConnection object
-        """
+    """Entertainer's image cache."""
+
+    def __init__(self):
         self.config = Configuration()
 
         if not os.path.exists(self.config.IMAGE_DB):
             raise Exception("Image database doesn't exist!")
-        self.backend_connection = backend_connection
 
     def get_all_images(self):
         """

=== modified file 'entertainerlib/client/medialibrary/music.py'
--- entertainerlib/client/medialibrary/music.py	2009-07-29 03:09:34 +0000
+++ entertainerlib/client/medialibrary/music.py	2009-09-08 02:40:16 +0000
@@ -28,22 +28,13 @@
     pass
 
 class MusicLibrary:
-    """
-    Music library.
-
-    Interface for Entertainer's music cache.
-    """
-
-    def __init__(self, backend_connection):
-        """
-        Initialize library.
-        @param backend_connection: BackendConnection object
-        """
+    """Interface for Entertainer's music cache."""
+
+    def __init__(self):
         self.config = Configuration()
 
         if not os.path.exists(self.config.MUSIC_DB):
             raise Exception("Music database doesn't exist!")
-        self.backend_connection = backend_connection
         self.db_connection = sqlite.connect(self.config.MUSIC_DB)
         self.cursor = self.db_connection.cursor()
 

=== modified file 'entertainerlib/client/medialibrary/videos.py'
--- entertainerlib/client/medialibrary/videos.py	2009-08-16 21:48:15 +0000
+++ entertainerlib/client/medialibrary/videos.py	2009-09-08 02:40:16 +0000
@@ -10,22 +10,13 @@
 from entertainerlib.client.medialibrary.playable import Playable
 
 class VideoLibrary:
-    """
-    Video library.
-
-    Interface for Entertainer's video cache.
-    """
-
-    def __init__(self, backend_connection):
-        """
-        Initialize video library
-        @param backend_connection: BackendConnection object
-        """
+    """Interface for Entertainer's video cache."""
+
+    def __init__(self):
         self.config = Configuration()
 
         if not os.path.exists(self.config.VIDEO_DB):
             raise Exception("Video database doesn't exist!")
-        self.backend_connection = backend_connection
 
     def get_movies(self):
         """

=== modified file 'entertainerlib/tests/mock.py'
--- entertainerlib/tests/mock.py	2009-07-29 03:09:34 +0000
+++ entertainerlib/tests/mock.py	2009-09-08 02:40:16 +0000
@@ -6,11 +6,9 @@
 
 import gobject
 
-from entertainerlib.client.backend_connection import BackendConnection
 from entertainerlib.client.medialibrary.feeds import Entry, Feed, FeedLibrary
 from entertainerlib.client.medialibrary.images import Image, ImageLibrary
-from entertainerlib.client.medialibrary.music import (Album, MusicLibrary,
-    Track)
+from entertainerlib.client.medialibrary.music import Album, MusicLibrary, Track
 from entertainerlib.client.medialibrary.videos import (Movie, TVEpisode,
     TVSeries, VideoLibrary)
 
@@ -42,17 +40,6 @@
         return False
 
 
-class MockBackendConnection(BackendConnection):
-    '''Mock entertainerlib.client.backend_connection.BackendConnection'''
-
-    def __init__(self):
-        '''Override init to prevent BackenConnection from attempting to connect
-        to a message bus.'''
-
-    def close_connection(self):
-        '''See `BackendConnection.close_connection`.'''
-
-
 class MockClutterKeyboardEvent(object):
     '''Mock clutter keyboard events'''
 
@@ -128,7 +115,7 @@
 class MockImageLibrary(ImageLibrary):
     '''Mock entertainerlib.client.medialibrary.images.ImageLibrary'''
 
-    def __init__(self, backend_connection=None):
+    def __init__(self):
         '''Override the intial behavior.'''
 
     def get_number_of_albums(self):
@@ -213,7 +200,7 @@
 class MockMusicLibrary(MusicLibrary):
     '''Mock entertainerlib.client.medialibrary.music.MusicLibrary'''
 
-    def __init__(self, backend_connection=None):
+    def __init__(self):
         '''Override the intial behavior.'''
 
     def get_albums_by_artist(self, artist=None):
@@ -305,7 +292,7 @@
 class MockVideoLibrary(VideoLibrary):
     '''Mock entertainerlib.client.medialibrary.videos.VideoLibrary'''
 
-    def __init__(self, backend_connection=None):
+    def __init__(self):
         '''Override the intial behavior.'''
 
     def get_number_of_movies(self):

=== modified file 'entertainerlib/tests/test_frontendfeedlibrary.py'
--- entertainerlib/tests/test_frontendfeedlibrary.py	2009-06-30 01:06:01 +0000
+++ entertainerlib/tests/test_frontendfeedlibrary.py	2009-09-08 02:40:16 +0000
@@ -5,7 +5,6 @@
 
 from entertainerlib.client.medialibrary.feeds import FeedLibrary
 from entertainerlib.tests import EntertainerTest
-from entertainerlib.tests.mock import MockBackendConnection
 
 class FrontendFeedLibraryTest(EntertainerTest):
     """
@@ -48,8 +47,7 @@
             db_conn.commit()
         db_conn.close()
 
-        self.backend_connection = MockBackendConnection()
-        self.library = FeedLibrary(self.backend_connection)
+        self.library = FeedLibrary(None)
 
     def tearDown(self):
         EntertainerTest.tearDown(self)

=== modified file 'entertainerlib/tests/test_music.py'
--- entertainerlib/tests/test_music.py	2009-05-10 17:36:49 +0000
+++ entertainerlib/tests/test_music.py	2009-09-08 02:40:16 +0000
@@ -8,7 +8,6 @@
 from entertainerlib.client.medialibrary.music import (
     Album, AlbumHasNoTracks, MusicLibrary, Track, CompactDisc,
     TrackRatingOutOfRange, TrackTypeError)
-from entertainerlib.tests.mock import MockBackendConnection
 from entertainerlib.client.medialibrary.playable import Playable
 from entertainerlib.tests import EntertainerTest
 
@@ -248,12 +247,7 @@
 
     def setUp(self):
         TestMusic.setUp(self)
-        self.backend_connection = MockBackendConnection()
-        self.musiclibrary = MusicLibrary(self.backend_connection)
-
-    def tearDown(self):
-        self.backend_connection.close_connection()
-        TestMusic.tearDown(self)
+        self.musiclibrary = MusicLibrary()
 
     def testMusicLibraryConstructor(self):
         """testMusicLibraryContructor - Ensures instantiation of MusicLibrary