Merge lp:~rockstar/entertainer/client-gtkreactor into lp:entertainer/future

[Paul Hummer]

[Paul Hummer (rockstar)]

First of all, this branch is dependent on the package-structure-apocalypse
branch that is currently in review. Please see the review diff, as it's
actually based off what will merge after the dependent branch lands.

This branch does two very small but very important things. The first is that
it creates a server_registry dict that will allow for many types of servers
(like the DLNA system). The selection of which server to use is a config
setting (currently not settable in the UI, since there's only one type right
now). Also, the server's host and port are part of the config as well.

The second, and more significant change is that the Entertainer client now
uses the twisted reactor as its main event loop. It requires some twisted
magic to install some special gtk stuff. So now the client has the ability
to make a connection to the new server, and with the reactor, you'll never
know the difference. In fact, Entertainer still works the exact same as it
did before. Now THAT's magic. :)

Now the real blocker is the indexer stuff, and so that means I need to get
testresources working with Entertainer's tests to provide Configuration object
for all tests.

It's coming together, which is quite encouraging.

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

[Matt Layman (mblayman)]

This branch seems like a stepping stone branch. I guess it proves that we can replace gtk main loop with the reactor. I did verify that a connection occurred when I was running `./entertainer-server`.

Some lint problems need to be fixed. It looks like "entertainer-client" can be removed.

************* Module entertainer-client
E0611: 8: No name 'client_main' in module 'entertainerlib.network'
************* Module entertainerlib.network
W0611: 10: Unused import EntertainerLocalClientProtocol
W0611: 5: Unused import ClientCreator

client_main went away. Will that eventually happen to server_main too?

review: Needs Fixing

[lp:~rockstar/entertainer/client-gtkreactor]

367. By Paul Hummer on 2009-05-10

Fixed some lint

[Paul Hummer (rockstar)]

On Sat, 09 May 2009 19:31:00 -0000, Matt Layman <email address hidden>
wrote:
> Some lint problems need to be fixed. It looks like "entertainer-client" can
> be removed.

Removed.

>
> ************* Module entertainer-client
> E0611: 8: No name 'client_main' in module 'entertainerlib.network'
> ************* Module entertainerlib.network
> W0611: 10: Unused import EntertainerLocalClientProtocol
> W0611: 5: Unused import ClientCreator

Both of these issues have been fixed as well.

> client_main went away. Will that eventually happen to server_main too?

No, server_main is the future. The main for the backend will go away. You'll
notice that server_main, with this branch, has the ability to start any server
that's in the server registry, so it's the future.

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

[Matt Layman (mblayman)]

Thanks Paul. The branch looks good to me know. I thought it looked a little odd to have server_main in the networking __init__, but I guess it will be used and necessary for autostarting the server if a user doesn't start it separately themselves.

review: Approve

=== modified file 'entertainerlib/client/client.py'
--- entertainerlib/client/client.py	2009-05-09 03:37:11 +0000
+++ entertainerlib/client/client.py	2009-05-09 05:24:36 +0000
@@ -8,6 +8,12 @@
 import sys
 
 import gtk
+from twisted.internet import gtk2reactor
+gtk2reactor.install() # Install the gtk2 reactor before import the real reactor
+from twisted.internet import reactor
+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
@@ -16,8 +22,10 @@
 from entertainerlib.client.medialibrary.images import ImageLibrary
 from entertainerlib.client.medialibrary.videos import VideoLibrary
 from entertainerlib.configuration import Configuration
+from entertainerlib.gui.system_tray_icon import SystemTrayIcon
 from entertainerlib.logger import Logger
-from entertainerlib.gui.system_tray_icon import SystemTrayIcon
+from entertainerlib.network.local.client import EntertainerLocalClientProtocol
+
 
 class Client:
     '''
@@ -50,12 +58,20 @@
             SystemTrayIcon(
                 self.quit_client, self.toggle_interface_visibility)
 
+        startLogging(sys.stdout)
+        client = EntertainerLocalClientProtocol
+
+        ClientCreator(reactor, client).connectTCP(
+            config.network_options['host'],
+            config.network_options['port'])
+
+
     def start(self):
         '''Start the necessary main loop.'''
         self.ui.start_up()
         self.interface_visible = True
         gtk.gdk.threads_enter()
-        gtk.main()
+        reactor.run()
         gtk.gdk.threads_leave()
 
     def initialize_backend_connection(self):
@@ -69,7 +85,7 @@
         '''Clean up the connection to the backend then close the client.'''
         self.backend_connection.close_connection()
 
-        gtk.main_quit()
+        reactor.stop()
         sys.exit(0)
 
     def toggle_interface_visibility(self):

=== modified file 'entertainerlib/configuration.py'
--- entertainerlib/configuration.py	2009-05-06 05:37:53 +0000
+++ entertainerlib/configuration.py	2009-05-09 05:26:08 +0000
@@ -103,6 +103,12 @@
             self.stage_width = None
             self.stage_height = None
 
+            # Network options specify the server type and extra options
+            self.network_options = {
+                'type': 'local',
+                'host': 'localhost',
+                'port': 55545}
+
     def create_cfg_dir(self):
         '''Create a configuration directory and default config files.'''
 

=== modified file 'entertainerlib/network/__init__.py'
--- entertainerlib/network/__init__.py	2009-04-30 01:11:22 +0000
+++ entertainerlib/network/__init__.py	2009-05-09 05:24:36 +0000
@@ -5,34 +5,25 @@
 from twisted.internet.protocol import ClientCreator
 from twisted.python.log import startLogging
 
+from entertainerlib.configuration import Configuration
 from entertainerlib.network.local.server import EntertainerLocalServer
 from entertainerlib.network.local.client import EntertainerLocalClientProtocol
 
+
+# New server types must be registered here.
+server_registry = {
+    'local': EntertainerLocalServer}
+
 # Entertainer really needs a good absctractable way to handle command line
 # arguments.
 def server_main(*args, **kwargs):
     '''Entertainer Server main function.'''
-    # When multiple server types are supported, the following variable will be
-    # more dynamic.
-    startLogging(sys.stdout)
-    server_type = EntertainerLocalServer
-
-    server = server_type()
-    # TODO: This port number could probably be a config var.
-    reactor.listenTCP(5545, server)
-    reactor.run()
-
-
-def client_main():
-    '''Entertainer test client code.
-
-    This code will go away when what is now the client is made into a true
-    client.
-    '''
-    startLogging(sys.stdout)
-    client = EntertainerLocalClientProtocol
-
-    ClientCreator(reactor, client).connectTCP(
-        'localhost', 5545)
+    startLogging(sys.stdout)
+    config = Configuration()
+    server = server_registry.get(
+        config.network_options['type'])
+
+    server = server()
+    reactor.listenTCP(config.network_options['port'], server)
     reactor.run()