Merge lp:~gary-lasker/software-center/launcher-integration-lp761851 into lp:software-center

[Gary Lasker]

This branch completes the software-center side implementation of the new Unity launcher functionality as specified at https://wiki.ubuntu.com/SoftwareCenter#Learning_how_to_launch_an_application. Note that there remains some additional functionality to be completed on the Unity side (see details in the Unity MP https://code.launchpad.net/~bilalakhtar/unity/software-center-integration-for-o/+merge/89364), but as of this branch the software-center side of the feature should be complete.

I've updated the corresponding unit test for the changes.

NOTE: This branch should land and be released as soon as possible after the corresponding Unity release (scheduled for tonight? but no sign of it yet).

Many thanks!

[lp:~gary-lasker/software-center/launcher-integration-lp761851]

2601. By Gary Lasker on 2012-01-30

sync up with latest trunk

=== modified file 'debian/changelog'
--- debian/changelog	2012-01-30 03:59:38 +0000
+++ debian/changelog	2012-01-30 04:08:26 +0000
@@ -15,7 +15,12 @@
     - add a test function in test_utils.py which covers all of
       get_nice_date_string
 
- -- Gary Lasker <[e-mail]>  Sun, 29 Jan 2012 22:57:47 -0500
+  [ Gary Lasker ]
+  * lp:~gary-lasker/software-center/launcher-integration-lp761851:
+    - update to the Unity launcher integration implementation to
+      support the revamped functionality on the Unity side (LP: #761851) 
+
+ -- Gary Lasker <[e-mail]>  Sun, 29 Jan 2012 23:04:52 -0500
 
 software-center (5.1.7) precise; urgency=low
 
 
=== modified file 'softwarecenter/backend/unitylauncher.py'
--- softwarecenter/backend/unitylauncher.py	2011-11-29 21:50:55 +0000
+++ softwarecenter/backend/unitylauncher.py	2012-01-30 04:08:26 +0000
@@ -33,7 +33,6 @@
                  icon_y,
                  icon_size,
                  app_install_desktop_file_path,
-                 installed_desktop_file_path,
                  trans_id):
         self.name = name
         self.icon_name = icon_name
@@ -42,43 +41,25 @@
         self.icon_y = icon_y
         self.icon_size = icon_size
         self.app_install_desktop_file_path = app_install_desktop_file_path
-        self.installed_desktop_file_path = installed_desktop_file_path
         self.trans_id = trans_id
         
 class UnityLauncher(object):
     """ Implements the integration between Software Center and the Unity
         launcher
     """
-    def __init__(self):
-        # keep track of applications that are candidates for adding
-        # to the Unity launcher
-        self.launcher_queue = {}
-        
-    def add_to_launcher_queue(self, pkgname, launcher_info):
-        """ add an application and its associated info to the set of candidates
-            for adding to the Unity launcher
-        """
-        self.launcher_queue[pkgname] = launcher_info
-        
-    def remove_from_launcher_queue(self, pkgname):
-        """ remove an application and its associated info from the set of
-            candidates for adding to the Unity launcher
-        """
-        if pkgname in self.launcher_queue:
-            return self.launcher_queue.pop(pkgname)
-        
+     
     def send_application_to_launcher(self, pkgname, launcher_info):
+        """ send a dbus message to the Unity launcher service to initiate
+            the add to launcher functionality for the specified application
+        """ 
         LOG.debug("sending dbus signal to Unity launcher for application: ", 
                   launcher_info.name)
         LOG.debug("  launcher_info.icon_file_path: ", 
                      launcher_info.icon_file_path)
-        LOG.debug("  launcher_info.installed_desktop_file_path: ",
-                     launcher_info.installed_desktop_file_path)
+        LOG.debug("  launcher_info.app_install_desktop_file_path: ",
+                     launcher_info.app_install_desktop_file_path)
         LOG.debug("  launcher_info.trans_id: ", launcher_info.trans_id)
-        # the application is being added to the launcher, so clear it from the
-        # list of candidates in the launcher queue
-        self.remove_from_launcher_queue(pkgname)
-        # add the application by sending a dbus signal to the Unity launcher
+
         try:
             bus = dbus.SessionBus()
             launcher_obj = bus.get_object('com.canonical.Unity.Launcher',
@@ -91,7 +72,7 @@
                     launcher_info.icon_x,
                     launcher_info.icon_y,
                     launcher_info.icon_size,
-                    launcher_info.installed_desktop_file_path,
+                    launcher_info.app_install_desktop_file_path,
                     launcher_info.trans_id)
         except Exception as e:
             LOG.warn("could not send dbus signal to the Unity launcher: (%s)",
 
=== modified file 'softwarecenter/ui/gtk3/panes/availablepane.py'
--- softwarecenter/ui/gtk3/panes/availablepane.py	2012-01-12 20:18:16 +0000
+++ softwarecenter/ui/gtk3/panes/availablepane.py	2012-01-30 04:08:26 +0000
@@ -37,7 +37,6 @@
 from softwarecenter.paths import APP_INSTALL_PATH
 from softwarecenter.utils import (wait_for_apt_cache_ready,
                                   get_exec_line_from_desktop,
-                                  convert_desktop_file_to_installed_location,
                                   get_file_path_from_iconname)
 from softwarecenter.db.appfilter import AppFilter
 from softwarecenter.db.database import Application
@@ -199,8 +198,6 @@
         # install backend
         self.backend.connect("transactions-changed", self._on_transactions_changed)
         self.backend.connect("transaction-started", self.on_transaction_started)
-        self.backend.connect("transaction-finished", self.on_transaction_finished)
-        self.backend.connect("transaction-stopped", self.on_transaction_stopped)
         
         # now we are initialized
         self.searchentry.set_sensitive(True)
@@ -352,22 +349,22 @@
             
     def on_transaction_started(self, backend, pkgname, appname, trans_id, 
                                trans_type):
-        self._register_unity_launcher_transaction_started(
-            backend, pkgname, appname, trans_id, trans_type)
+        self._add_application_to_unity_launcher(
+                backend, pkgname, appname, trans_id, trans_type)
 
-    def _register_unity_launcher_transaction_started(self, backend, pkgname, 
-                                                     appname, trans_id, 
-                                                     trans_type):
+    def _add_application_to_unity_launcher(self, backend, pkgname, 
+                                           appname, trans_id, 
+                                           trans_type):
         if not self.add_to_launcher_enabled:
             return
         # mvo: use use softwarecenter.utils explictly so that we can monkey
         #      patch it in the test
         if not softwarecenter.utils.is_unity_running():
             return
-        # we only care about getting the launcher information on an install
+        # we only care about installs
         if not trans_type == TransactionTypes.INSTALL:
             return
-        # gather details for this transaction and create the launcher_info object
+            
         app = Application(pkgname=pkgname, appname=appname)
         appdetails = app.get_details(self.db)
         # we only add items to the launcher that have a desktop file
@@ -380,17 +377,26 @@
             not get_exec_line_from_desktop(appdetails.desktop_file)):
             return
 
-        (icon_size, icon_x, icon_y) = self._get_onscreen_icon_details_for_launcher_service(app)
+        # now gather up the unity launcher info items and send the app to the
+        # launcher service
+        launcher_info = self._get_unity_launcher_info(app, appdetails, trans_id)
+        self.unity_launcher.send_application_to_launcher(pkgname, launcher_info)
+        
+    def _get_unity_launcher_info(self, app, appdetails, trans_id):
+        (icon_size, icon_x, icon_y) = (
+                self._get_onscreen_icon_details_for_launcher_service(app))
+        icon_path = get_file_path_from_iconname(
+                                self.icons,
+                                iconname=appdetails.icon_file_name)
         launcher_info = UnityLauncherInfo(app.name,
                                           appdetails.icon,
-                                          "",        # we set the icon_file_path value *after* install
+                                          icon_path,
                                           icon_x,
                                           icon_y,
                                           icon_size,
                                           appdetails.desktop_file,
-                                          "",        # we set the installed_desktop_file_path *after* install
                                           trans_id)
-        self.unity_launcher.add_to_launcher_queue(app.pkgname, launcher_info)
+        return launcher_info
 
     def _get_onscreen_icon_details_for_launcher_service(self, app):
         if self.is_app_details_view_showing():
@@ -399,28 +405,6 @@
             # TODO: implement the app list view case once it has been specified
             return (0, 0, 0)
 
-    def on_transaction_finished(self, backend, result):
-        self._check_unity_launcher_transaction_finished(result)
-        
-    def _check_unity_launcher_transaction_finished(self, result):
-        # add the completed transaction details to the corresponding
-        # launcher_item
-        if result.pkgname in self.unity_launcher.launcher_queue:
-            launcher_info = self.unity_launcher.launcher_queue[result.pkgname]
-            launcher_info.icon_file_path = get_file_path_from_iconname(
-                self.icons, launcher_info.icon_name)
-            installed_path = convert_desktop_file_to_installed_location(
-                launcher_info.app_install_desktop_file_path, result.pkgname)
-            launcher_info.installed_desktop_file_path = installed_path
-            if result.success:
-                self.unity_launcher.send_application_to_launcher(
-                                            result.pkgname, launcher_info)
-            else:
-                self.unity_launcher.remove_from_launcher_queue(result.pkgname)
-
-    def on_transaction_stopped(self, backend, result):
-        self.unity_launcher.remove_from_launcher_queue(result.pkgname)
-
     def on_app_list_changed(self, pane, length):
         """internal helper that keeps the status text and the action
            bar up-to-date by keeping track of the app-list-changed
 
=== modified file 'test/gtk3/test_unity_launcher_integration.py'
--- test/gtk3/test_unity_launcher_integration.py	2012-01-16 14:42:49 +0000
+++ test/gtk3/test_unity_launcher_integration.py	2012-01-30 04:08:26 +0000
@@ -4,8 +4,6 @@
 import time
 import unittest
 
-from mock import Mock
-
 from testutils import setup_test_env
 setup_test_env()
 
@@ -16,6 +14,7 @@
 from softwarecenter.utils import convert_desktop_file_to_installed_location
 from softwarecenter.db.application import Application
 from softwarecenter.ui.gtk3.panes.availablepane import get_test_window
+from softwarecenter.backend.unitylauncher import UnityLauncherInfo
 
 # we can only have one instance of availablepane, so create it here
 win = get_test_window()
@@ -51,47 +50,58 @@
                                     TransactionTypes.INSTALL)
         # wait a wee bit
         self._zzz()
-
-    def test_unity_launcher_integration(self):
-        # test the automatic add to launcher enabled functionality
-        available_pane.add_to_launcher_enabled = True
-        test_pkgname = "lincity-ng"
-        mock_result = Mock()
-        mock_result.pkgname = test_pkgname
-        mock_result.success = True
-        # now pretend
-        self._navigate_to_appdetails_and_install(test_pkgname)
         
-        # check that a correct UnityLauncherInfo object has been created and
-        # added to the queue
-        self.assertTrue(test_pkgname in available_pane.unity_launcher.launcher_queue)
-        launcher_info = available_pane.unity_launcher.remove_from_launcher_queue(test_pkgname)
-        # check the UnityLauncherInfo values themselves
-        self.assertEqual(launcher_info.name, "lincity-ng")
-        self.assertEqual(launcher_info.icon_name, "lincity-ng")
+    def _fake_send_application_to_launcher_and_check(self,
+                                                     pkgname, launcher_info):
+        self.assertEqual(pkgname, self.expected_pkgname)
+        self.assertEqual(launcher_info.name, self.expected_launcher_info.name)
+        self.assertEqual(launcher_info.icon_name,
+                         self.expected_launcher_info.icon_name)
         self.assertTrue(launcher_info.icon_x > 5)
         self.assertTrue(launcher_info.icon_y > 5)
         self.assertEqual(launcher_info.icon_size, 96)
         self.assertEqual(launcher_info.app_install_desktop_file_path,
-            "/usr/share/app-install/desktop/lincity-ng:lincity-ng.desktop")
-        self.assertEqual(launcher_info.trans_id, "testid101")
-        # finally, make sure the the app has been removed from the launcher
-        # queue        
-        self.assertFalse(test_pkgname in available_pane.unity_launcher.launcher_queue)
+                self.expected_launcher_info.app_install_desktop_file_path)
+        self.assertEqual(launcher_info.trans_id,
+                self.expected_launcher_info.trans_id)
+
+    def test_unity_launcher_integration(self):
+        # test the automatic add to launcher enabled functionality
+        available_pane.add_to_launcher_enabled = True
+        test_pkgname = "lincity-ng"
+        # now pretend
+        # for testing, we substitute a fake version of UnityLauncher's
+        # send_application_to_launcher method that lets us check for the
+        # correct values and also avoids firing the actual dbus signal
+        # to the unity launcher service
+        self.expected_pkgname = test_pkgname
+        self.expected_launcher_info = UnityLauncherInfo("lincity-ng",
+                 "lincity-ng",
+                 0, 0, 0, 0, # these values are set in availablepane
+                 "/usr/share/app-install/desktop/lincity-ng:lincity-ng.desktop",
+                 "testid101")
+        available_pane.unity_launcher.send_application_to_launcher = (
+                self._fake_send_application_to_launcher_and_check)
+        self._navigate_to_appdetails_and_install(test_pkgname)
         
     def test_unity_launcher_integration_disabled(self):
         # test the case where automatic add to launcher is disabled
         available_pane.add_to_launcher_enabled = False
         test_pkgname = "lincity-ng"
-        mock_result = Mock()
-        mock_result.pkgname = test_pkgname
-        mock_result.success = True
         # now pretend
+        # for testing, we substitute a fake version of UnityLauncher's
+        # send_application_to_launcher method that lets us check for the
+        # correct values and also avoids firing the actual dbus signal
+        # to the unity launcher service
+        # in the disabled add to launcher case, we just want to insure
+        # that we never call send_application_to_launcher, so we can just
+        # plug in bogus values and we will catch a call if it occurs
+        self.expected_pkgname = ""
+        self.expected_launcher_info = UnityLauncherInfo("", "",
+                 0, 0, 0, 0, "", "")
+        available_pane.unity_launcher.send_application_to_launcher = (
+                self._fake_send_application_to_launcher_and_check)
         self._navigate_to_appdetails_and_install(test_pkgname)
-        
-        # check that no corresponding unity_launcher info object has been added
-        # to the queue
-        self.assertFalse(test_pkgname in available_pane.unity_launcher.launcher_queue)
 
     def test_desktop_file_path_conversion(self):
         # test 'normal' case