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

[Rafał Cieślak]

This branch is meant to fix #982246 in daemon, by introducing proper PATH setting.

It allows to install the daemon with a given prefix. (python setup.py install --prefix /where/to/install
Although this is possible at the moment, the daemon will start only if the prefix is /usr, or it is being run without installation, in any other case it will crash on startup. This branch fixes this issue.

This feature is quite cool, I am delighted to be able to successfully install the application to /opt/accomplishments (or any other directory), it makes it much easier to browse it's installed files, makes me sure I won't accidentally hurt any significant system file, and simplifies uninstallation (just remove whole directory)

=========
First part of the fix is in the bin/accomplishments-daemon file. It failed to import anything from accomplishments.* modules, because python was looking for them in /usr/lib/python2.7/... while our modules were installed to the prefixed directory (e.g. /opt/accomplishments/lib/python2.7/...). This is fixed by determining the prefix (stored in basepath variable), and adding required directories to the PATH. The basepath itself is added to the PATH too, which is exactly the same as adding ./ when the daemon is run from branch.

The same code is added to bin/accomplishments-daemon-fg file.

Next piece of fix is a complete rewrite of accomplishments/utils/paths.py. The problem was that it has supported only two cases (run from branch and installed to /usr), as it had hadr-coded paths. Proposed code determines the prefix (to basepath) and sets the required variables as needed.

Lastly, the new PATH variable is not passed to subprocesses - I've solved that by setting module_dir variables in paths.py, storing the path to accomplishment.* modules. This way they can be used to prepare os.environ in the api.py file.

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

16. By Rafał Cieślak on 2012-04-15

unneeded import

17. By Rafał Cieślak on 2012-04-15

this unsafe function is not used anymore

[Rafał Cieślak (rafalcieslak256)]

Notes concerning integration with viewer when installing both are available in related viewer's branch's merge request: https://code.launchpad.net/~rafalcieslak256/ubuntu-accomplishments-viewer/982246/+merge/102031

=== modified file 'accomplishments/daemon/api.py'
--- accomplishments/daemon/api.py	2012-04-14 17:07:55 +0000
+++ accomplishments/daemon/api.py	2012-04-15 16:19:19 +0000
@@ -38,13 +38,18 @@
 from ubuntuone.platform.tools import SyncDaemonTool
 from ubuntuone.couch import auth
 
-os.environ["PYTHONPATH"] = "$PYTHONPATH:."
-
 import accomplishments
 from accomplishments import exceptions
 from accomplishments.daemon import dbusapi
 from accomplishments.util import get_data_file, SubprocessReturnCodeProtocol
-from accomplishments.util.paths import media_dir
+from accomplishments.util.paths import media_dir, module_dir1, module_dir2, installed
+
+os.environ["PYTHONPATH"] = "$PYTHONPATH:."
+# The directories with accomplishment.* modules, that are being used by scripts,
+# may happen to be in a completelly different directory, if the daemon was
+# installed using a non-default prefix.
+if installed:
+    os.environ["PYTHONPATH"] = module_dir1 + ":" + module_dir2 + ":" + os.environ["PYTHONPATH"]
 
 MATRIX_USERNAME = "openiduser155707"
 LOCAL_USERNAME = getpass.getuser()

=== modified file 'accomplishments/util/__init__.py'
--- accomplishments/util/__init__.py	2012-04-12 03:02:29 +0000
+++ accomplishments/util/__init__.py	2012-04-15 16:19:19 +0000
@@ -52,6 +52,9 @@
 
 
 def get_data_path():
+    # XXX: NOTE: This function will most likely work incorrectly when daemon is installed in non-default path.
+    # Luckily, this function is no longer used anywhere.
+    # If you feel you need to get this path, please refer to utils/paths.py instead.
     """Retrieve accomplishments-daemon data path
 
     This path is by default <accomplishments_daemon_lib_path>/../data/ in trunk

=== modified file 'accomplishments/util/paths.py'
--- accomplishments/util/paths.py	2012-04-12 03:02:29 +0000
+++ accomplishments/util/paths.py	2012-04-15 16:19:19 +0000
@@ -1,16 +1,45 @@
 import os
-from accomplishments.util import get_data_path
-
-def uses_system_lib():
-    return os.path.dirname(__file__).startswith("/usr")
-
-runs_in_branch = not uses_system_lib()
-#systemdata_dir = "data/daemon/"
-#media_dir      = "data/media/"
-if not runs_in_branch:
-    systemdata_dir = "/usr/share/accomplishments-daemon/"
-    media_dir      = "/usr/share/accomplishments-daemon/media/"
-else:
-    localdatapath = get_data_path()
-    systemdata_dir = os.path.join(localdatapath, "daemon")
-    media_dir      = os.path.join(localdatapath, "media")
+
+if __file__[0] is '/':
+    #the script run with absolute path
+    scriptpath = __file__
+else:
+    scriptpath = os.path.join(os.getcwd(),__file__)
+    
+# okay, so as we have the full path, we're ready to analise it...    
+
+# start by looking 2 levels higher. This is either the branch directory,
+# or the python2.7/...-packages directory, if the application is run installed.
+branchpath = os.path.split(os.path.split(os.path.split(scriptpath)[0])[0])[0]
+branchdir_name = os.path.split(branchpath)[1]
+if ((branchdir_name == "site-packages") or (branchdir_name == 'dist-packages')):
+    installed = True
+else:
+    installed = False
+
+# Great, at that level we know whether the application is run from branch, or
+# has been installed. This allows us to interpret the directories further...
+
+
+if installed:
+    basepath = os.path.split(os.path.split(os.path.split(branchpath)[0])[0])[0]
+    # basepath should equal to prefix given on installation.
+    print "Daemon seems to be installed to: " + basepath
+    
+    # finally, setting these significant data directories...
+    systemdata_dir = os.path.join(basepath, 'share/accomplishments-daemon')
+    media_dir      = os.path.join(basepath, 'share/accomplishments-daemon/media')
+    # these two may need to be set for the accomplismhents scripts, so that they
+    # can use OUR accomplishments module, using this installation.
+    module_dir1    = os.path.join(basepath, 'lib/python2.7/site-packages') 
+    module_dir2    = os.path.join(basepath, 'lib/python2.7/dist-packages')
+else:
+    # using branch root directory as the base path
+    basepath = branchpath
+    print "Daemon seems to be run not installed, branch base path used: " + basepath
+    
+    # finally, setting these significant data directories...
+    systemdata_dir = os.path.join(basepath, 'data/daemon')
+    media_dir      = os.path.join(basepath, 'data/media')
+    module_dir1    = None # always using default
+    module_dir2    = None # always using default

=== modified file 'bin/accomplishments-daemon'
--- bin/accomplishments-daemon	2012-04-12 00:20:10 +0000
+++ bin/accomplishments-daemon	2012-04-15 16:19:19 +0000
@@ -11,14 +11,21 @@
 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
 
-if paths.runs_in_branch:
-    # PYTHONPATH mangling
-    sys.path.insert(0, ".")
-
 dbus_loop = DBusGMainLoop(set_as_default=True)
 application = app.applicationFactory(
     app_name="Ubuntu Accomplishments",

=== modified file 'bin/accomplishments-daemon-fg'
--- bin/accomplishments-daemon-fg	2012-04-12 00:20:10 +0000
+++ bin/accomplishments-daemon-fg	2012-04-15 16:19:19 +0000
@@ -11,14 +11,21 @@
 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
 
-if paths.runs_in_branch:
-    # PYTHONPATH mangling
-    sys.path.insert(0, ".")
-
 dbus_loop = DBusGMainLoop(set_as_default=True)
 application = app.applicationFactory(
     app_name="Ubuntu Accomplishments",