Merge lp:~rafalcieslak256/ubuntu-accomplishments-daemon/daemon-launcher into lp:ubuntu-accomplishments-daemon

[Rafał Cieślak]

This implements an elegant launcher for the accomplishments daemon. It is launcher by executing `accomplishments-daemon` script (it works both when installed and when run from branch).

Supported options include:
 * --help - Guess what it does.
 * --start - Launches the daemon. If the launcher is run without arguments, it behaves just as if with --start.
 * --stop - Calls stop_daemon() via DBUsAPI, which stops the rector. A graceful way to exit the daemon.
 * --kill - Kills the daemon process (by PID).
 * --reload - Reloads accomplishments database. It will also send a DBus signal, but note that the viewer does not support it yet, and it will require restart to get the new accomplishments from daemon.

Note that the viewer is not yet aware of the launcher and runs the daemon 'the old way'. It may slightly confuse the launcher (it will be able to stop a daemon which was started by viewer, but won't be able to kill it, as it does not know where to find the PID file). I don't think there is a point in a separate branch for this fix in viewer, as it's gonna be a 1 line change, therefore simply avoid starting the daemon with viewer when testing this branch (run the daemon manually and then the viewer) and I will apply the fix to the viewer when this branch gets merged in.

And remember to restart the daemon before testing this branch ;-)

[Matt Fischer (mfisch)]

I think this is a great solution and will be clean even when run as different users since dbus is per session. Two minor comments and a question:

typo on line 19: "stop_daemo"

minor issue, line 86: "if the path is set wrongly" change "wrongly" to "incorrectly" as wrongly isn't a valid word ;)

Did you run the unit tests in a pbuilder environment with this change yet? If not, I can try it later today. I'm worried about package changes mainly if there needs to be any, since the daemon doesn't run anyway.

review: Needs Fixing

[lp:~rafalcieslak256/ubuntu-accomplishments-daemon/daemon-launcher]

126. By Rafał Cieślak on 2012-08-06

Minor fixes for the launcher

[Rafał Cieślak (rafalcieslak256)]

Updated with several fixes. I am not sure how to correctly run tests in pbuilder, and therefore I would be thankful if you did it for me.

[Matt Fischer (mfisch)]

Works fine in a pbuilder

review: Approve

=== modified file 'accomplishments/daemon/api.py'
--- accomplishments/daemon/api.py	2012-08-04 00:22:49 +0000
+++ accomplishments/daemon/api.py	2012-08-06 20:55:29 +0000
@@ -1138,6 +1138,9 @@
                 self.accDB[collection] = collectiondata
 
         self._update_all_locked_and_completed_statuses()
+        
+        if not self.test_mode:
+            self.service.accomplishments_collections_reloaded()
         # Uncomment following for debugging
         # print self.accDB\
 
@@ -1631,7 +1634,7 @@
         log.msg(type(value))
         if value == True:
             log.msg("setting")
-            command = "twistd -noy " + daemon_exec_dir + "/accomplishments-daemon --logfile=" + os.path.join(self.dir_cache, "logs", "daemon.log")
+            command = os.path.join(daemon_exec_dir, "accomplishments-daemon") + " --start"
             filetext = "[Desktop Entry]\n\
 Type=Application\n\
 Encoding=UTF-8\n\
@@ -1834,3 +1837,8 @@
     #Other significant system functions
     def get_API_version(self):
         return "0.2"
+    
+    def stop_daemon(self):
+        print "Stopping the daemon as stop_daemon() got called."
+        from twisted.internet import reactor
+        reactor.stop()

=== modified file 'accomplishments/daemon/dbusapi.py'
--- accomplishments/daemon/dbusapi.py	2012-07-16 16:22:10 +0000
+++ accomplishments/daemon/dbusapi.py	2012-08-06 20:55:29 +0000
@@ -18,16 +18,11 @@
 
 
 def daemon_is_registered():
-    """
-    """
     try:
         obj = dbus.SessionBus().get_object(
             "org.ubuntu.accomplishments", "/")
         return True
     except dbus.exceptions.DBusException:
-        log.msg(
-            "User does not have the accomplishments daemon "
-            "available")
         return False
 
 
@@ -883,6 +878,11 @@
 
     @dbus.service.method(dbus_interface='org.ubuntu.accomplishments',
         in_signature="", out_signature="")
+    def stop_daemon(self):
+        return self.api.stop_daemon()
+        
+    @dbus.service.method(dbus_interface='org.ubuntu.accomplishments',
+        in_signature="", out_signature="")
     def publish_trophies_online(self):
         return self.api.publish_trophies_online()
 
@@ -926,3 +926,8 @@
     @dbus.service.signal(dbus_interface='org.ubuntu.accomplishments')
     def ubuntu_one_account_ready(self):
         pass
+
+    @dbus.service.signal(dbus_interface='org.ubuntu.accomplishments')
+    def accomplishments_collections_reloaded(self):
+        pass
+        

=== modified file 'bin/accomplishments-daemon'
--- bin/accomplishments-daemon	2012-07-30 17:36:03 +0000
+++ bin/accomplishments-daemon	2012-08-06 20:55:29 +0000
@@ -1,18 +1,10 @@
-#!/usr/bin/twistd -y
-"""
-Run the Accomplishments daemon!
-"""
+#!/usr/bin/python -O
+
 import sys
 import os
 
-from twisted.internet import gireactor
-gireactor.install()
-
-import dbus
-from dbus.mainloop.glib import DBusGMainLoop
-
-
-# Importing from accomplishments.paths would fail, if the path is set wrongly.
+# Importing from accomplishments.{daemon,util} would fail, if the path 
+# is set incorrectly.
 # We need to ensure that the script will load the correct version of
 # accomplishment.* that is installed with this script.
 scriptpath = os.path.abspath(__file__)
@@ -23,25 +15,144 @@
 sys.path.insert(0, basepath + "/lib/python2.7/site-packages")
 sys.path.insert(0, basepath + "/lib/python2.7/dist-packages")
 
-
-# Ensure the sync daemon is running. The following command can be run in the
-# background (&), because it would block the daemon from running for few
-# seconds, while the syncdaemon will not be needed immediatelly after
-# accomplishments daemon startups.
-os.system("u1sdtool --start &")
-
-
-from accomplishments.daemon import app
-
-from accomplishments.util import paths
-
-dbus_loop = DBusGMainLoop(set_as_default=True)
-application = app.applicationFactory(
-    app_name="Ubuntu Accomplishments",
-    bus_name="org.ubuntu.accomplishments",
-    main_loop=dbus_loop,
-    session_bus=dbus.SessionBus(mainloop=dbus_loop),
-    object_path="/",
-    # Let's execute the timer service every 15 minutes
-    update_interval=15 * 60,
-    gpg_key=os.path.join(paths.systemdata_dir, "validation-key.pub"))
+# This is a global variable
+pidfile_path = None
+
+def main():
+    # This part of code is executed if the script is run directly.
+    import argparse
+    parser = argparse.ArgumentParser(description='Launches the accomplishments daemon.')
+    mode = parser.add_mutually_exclusive_group()
+    mode.add_argument('--start',action='store_true',help="Launch the accomplishments daemon (default option when run without arguments).")
+    mode.add_argument('--stop',action='store_true',help="Stop the daemon gracefully.")
+    mode.add_argument('--kill',action='store_true',help="Kill the daemon process.")
+    mode.add_argument('--reload',action='store_true',help="Reload accomplishments collections.")
+    args = parser.parse_args()
+    
+    import xdg.BaseDirectory
+    try:
+        rootdir = os.environ['ACCOMPLISHMENTS_ROOT_DIR']
+        cache_dir = os.path.join(
+            rootdir, "accomplishments", ".cache", "accomplishments")
+    except KeyError:
+        cache_dir = os.path.join(
+            xdg.BaseDirectory.xdg_cache_home, "accomplishments")
+            
+    global pidfile_path
+    pidfile_path = os.path.join(cache_dir,"accomplishments-daemon.pid")
+        
+    if args.start or not (args.start or args.stop or args.kill or args.reload):
+        from accomplishments.util.paths import daemon_exec_dir
+        
+        # Check if the daemon is already running.
+        if is_daemon_running():
+            print "The daemon is already running."
+            return
+        
+        # The daemon is not running.
+        print "Launching the daemon..."
+        
+        # Create the cache directories.
+        if not os.path.exists(cache_dir):
+            os.makedirs(cache_dir)
+        if not os.path.exists(os.path.join(cache_dir,"logs")):
+            os.makedirs(os.path.join(cache_dir,"logs"))
+        
+        # Remove the pid file if for some reasons it's still present.
+        # Try killing the process though, maybe it hung or DBus died.
+        if os.path.exists(pidfile_path):
+            if kill_daemon_process() is not 0:
+                # Successfully killed daemon removes the pidfile himself.
+                os.remove(pidfile_path)
+        
+        command = "twistd -y " + os.path.join(daemon_exec_dir, "accomplishments-daemon") + " --logfile=" + os.path.join(cache_dir, "logs", "daemon.log") + " --pidfile=" + pidfile_path
+        
+        os.system(command)
+    
+    elif args.stop:
+        if not is_daemon_running():
+            print "The daemon is not running."
+            return
+        print "Stopping the daemon..."
+        
+        from accomplishments.daemon import dbusapi
+        api = dbusapi.Accomplishments()
+        api.stop_daemon()
+    
+    elif args.kill:
+        # Killing the daemon
+        res = kill_daemon_process()
+        if res is 0:
+            print "Daemon killed."
+        elif res is -1:
+            if not is_daemon_running():
+                print "The daemon is not running."
+            else:
+                print "Unable to kill daemon - its PID is unknown. Try stopping it instead."
+        elif res is -2:
+            pass
+    
+    elif args.reload:
+        if not is_daemon_running():
+            print "The daemon is not running."
+            return
+        print "Reloading accomplishments collections."
+        
+        from accomplishments.daemon import dbusapi
+        api = dbusapi.Accomplishments()
+        api.reload_accom_database()
+        
+    
+def kill_daemon_process():
+    if not os.path.exists(pidfile_path):
+        return -1
+    pidfile = open(pidfile_path,'r')
+    pid = int(pidfile.read())
+    i = os.system("kill " + str(pid))
+    if i is not 0:
+        print "Failed to kill daemon, PID:" + str(pid)
+        return -2
+    return 0
+    
+def is_daemon_running():
+    from accomplishments.daemon.dbusapi import daemon_is_registered
+    return daemon_is_registered()
+    
+
+if __name__=="__main__":
+    # If run directly...
+    main()
+    
+if __name__=="__builtin__":
+    # This part of code is executed only if the script is run by twistd.
+    # It is responsible for setting up and launching the twistd daemon.
+    
+    # This piece of code cannot be wrapped inside a function, as silly
+    # twistd blindly searches fora global variable named "application",
+    # and therefore while this code must be exposed.
+    
+    # Reactor has to be installed before any import statements.
+    from twisted.internet import gireactor
+    gireactor.install()
+
+    from accomplishments.daemon import app
+    from accomplishments.util import paths
+    
+    # Ensure the sync daemon is running. The following command can be run in the
+    # background (&), because it would block the daemon from running for few
+    # seconds, while the syncdaemon will not be needed immediatelly after
+    # accomplishments daemon startups.
+    os.system("u1sdtool --start &")
+
+    import dbus
+    from dbus.mainloop.glib import DBusGMainLoop
+    dbus_loop = DBusGMainLoop(set_as_default=True)
+    application = app.applicationFactory(
+        app_name="Ubuntu Accomplishments",
+        bus_name="org.ubuntu.accomplishments",
+        main_loop=dbus_loop,
+        session_bus=dbus.SessionBus(mainloop=dbus_loop),
+        object_path="/",
+        # Let's execute the timer service every 15 minutes
+        update_interval=15 * 60,
+        gpg_key=os.path.join(paths.systemdata_dir, "validation-key.pub"))

=== removed file 'bin/accomplishments-daemon-fg'
--- bin/accomplishments-daemon-fg	2012-04-15 14:02:28 +0000
+++ bin/accomplishments-daemon-fg	1970-01-01 00:00:00 +0000
@@ -1,38 +0,0 @@
-#!/usr/bin/twistd -noy
-"""
-Run the Accomplishments daemon!
-"""
-import sys
-import os
-
-from twisted.internet import glib2reactor
-glib2reactor.install()
-
-import dbus
-from dbus.mainloop.glib import DBusGMainLoop
-
-# Importing from accomplishments.paths would fail, if the path is set wrongly.
-# We need to ensure that the script will load the correct version of
-# accomplishment.* that is installed with this script.
-scriptpath = os.path.abspath(__file__)
-# basepaths shall be equal to prefix used while installing - if the application is run from source, it does not really matter.
-basepath = os.path.split(os.path.split(scriptpath)[0])[0]
-sys.path.insert(0, basepath)
-sys.path.insert(0, basepath + "/lib/python2.7")
-sys.path.insert(0, basepath + "/lib/python2.7/site-packages")
-sys.path.insert(0, basepath + "/lib/python2.7/dist-packages")
-
-from accomplishments.daemon import app
-
-from accomplishments.util import paths
-
-dbus_loop = DBusGMainLoop(set_as_default=True)
-application = app.applicationFactory(
-    app_name="Ubuntu Accomplishments",
-    bus_name="org.ubuntu.accomplishments",
-    main_loop=dbus_loop,
-    session_bus=dbus.SessionBus(mainloop=dbus_loop),
-    object_path="/",
-    # Let's execute the timer service every 15 minutes
-    update_interval=15 * 60,
-    gpg_key=os.path.join(paths.systemdata_dir, "validation-key.pub"))