Merge lp:~mvo/software-center/system-wide-license-key-fixes into lp:software-center

[Michael Vogt]

This branch adds support for installing system-wide license keys via aptdaemon.

[Gary Lasker (gary-lasker)]

Hi mvo, this looks fine to me, very nice! I did notice that version.py is bumped, but that may be on purpose for the new RELEASE value?

I tested using the unit test only, and expect that we will get thorough testing with the server-side by QA very soon after we get this merged.

Thanks!

review: Approve

=== modified file 'debian/control'
--- debian/control	2011-11-07 10:04:33 +0000
+++ debian/control	2011-11-24 16:27:53 +0000
@@ -23,6 +23,7 @@
          ${misc:Depends},
          app-install-data (>= 0.4.0),
          aptdaemon (>= 0.40),
+	 software-center-aptdaemon-plugins,
          humanity-icon-theme|gnome-icon-theme,
          gir1.2-glib-2.0 (>= 1.31),
          gir1.2-gtk-3.0,

=== modified file 'softwarecenter/backend/installbackend_impl/aptd.py'
--- softwarecenter/backend/installbackend_impl/aptd.py	2011-09-29 18:26:52 +0000
+++ softwarecenter/backend/installbackend_impl/aptd.py	2011-11-24 16:27:53 +0000
@@ -450,10 +450,8 @@
         yield policykit1.check_authorization_by_name(name, action, flags=flags)
 
     @inline_callbacks
-    def add_license_key(self, license_key, license_key_path, pkgname):
-        """ add a license key for a purchase. Note that currently only
-            system wide license keys are supported.
-        """
+    def add_license_key(self, license_key, license_key_path, license_key_oauth, pkgname):
+        """ add a license key for a purchase. """
         self._logger.debug(
             "adding license_key for pkg '%s' of len: %i" % (
                 pkgname, len(license_key)))
@@ -475,11 +473,13 @@
         else:
             # system-wide keys
             try:
+                self._logger.info("adding license key for '%s'" % pkgname)
+                server = "ubuntu-production"
                 trans = yield self.aptd_client.add_license_key(
-                    license_key, pkgname)
+                    pkgname, license_key_oauth, server)
                 yield self._run_transaction(trans, None, None, None)
             except Exception as e:
-                self._logger.error("add_repository: '%s'" % e)
+                self._logger.error("add_license_key: '%s'" % e)
 
     @inline_callbacks
     def add_repo_add_key_and_install_app(self,
@@ -489,6 +489,7 @@
                                          iconname,
                                          license_key,
                                          license_key_path,
+                                         json_oauth_token=None,
                                          purchase=True):
         """ 
         a convenience method that combines all of the steps needed
@@ -531,6 +532,7 @@
                           'sc_add_repo_and_install_try' : "1",
                           'sc_add_repo_and_install_license_key' : license_key or "",
                           'sc_add_repo_and_install_license_key_path' : license_key_path or "",
+                          'sc_add_repo_and_install_license_key_token' : json_oauth_token or "",
                          }
 
         self._logger.info("add_sources_list_entry()")
@@ -593,6 +595,7 @@
         deb_line = trans.meta_data["sc_add_repo_and_install_deb_line"]
         license_key = trans.meta_data["sc_add_repo_and_install_license_key"]
         license_key_path = trans.meta_data["sc_add_repo_and_install_license_key_path"]
+        license_key_oauth = trans.meta_data["sc_add_repo_and_install_license_key_token"]  
         release_filename = release_filename_in_lists_from_deb_line(deb_line)
         lists_dir = apt_pkg.config.find_dir("Dir::State::lists")
         release_signature = os.path.join(lists_dir, release_filename)+".gpg"
@@ -626,10 +629,16 @@
                 self._logger.info("run_transaction()")
                 yield self._run_transaction(trans, app.pkgname, app.appname,
                                             "", metadata)
-                if license_key:
-                    yield self.add_license_key(license_key, license_key_path, app.pkgname)
             except Exception as error:
                 self._on_trans_error(error, app.pkgname)
+            # add license_key
+            # FIXME: aptd fails if there is a license_key_path already
+            #        but I wonder if we should ease that restriction
+            if license_key and not os.path.exists(license_key_path):
+                res = yield self.add_license_key(
+                    license_key, license_key_path, license_key_oauth, 
+                    app.pkgname)
+
         else:
             # download failure
             # ok, here is the fun! we can not reload() immediately, because

=== modified file 'softwarecenter/db/application.py'
--- softwarecenter/db/application.py	2011-11-13 09:21:58 +0000
+++ softwarecenter/db/application.py	2011-11-24 16:27:53 +0000
@@ -669,6 +669,8 @@
         details.append("   installation_date: %s" % self.installation_date)
         details.append("       purchase_date: %s" % self.purchase_date)
         details.append("             license: %s" % self.license)
+        details.append("         license_key: %s" % self.license_key[0:3] + len(license_key)*"*")
+        details.append("    license_key_path: %s" % self.license_key_path)
         details.append("  maintenance_status: %s" % self.maintenance_status)
         details.append("           pkg_state: %s" % self.pkg_state)
         details.append("               price: %s" % self.price)

=== modified file 'softwarecenter/ui/gtk3/app.py'
--- softwarecenter/ui/gtk3/app.py	2011-11-09 10:35:09 +0000
+++ softwarecenter/ui/gtk3/app.py	2011-11-24 16:27:53 +0000
@@ -552,6 +552,9 @@
 
     def _on_sso_login(self, sso, oauth_result):
         self._sso_login_successful = True
+        # appmanager needs to know about the oauth token for the reinstall
+        # previous purchases add_license_key call
+        self.app_manager.oauth_token = oauth_result
         # consumer key is the openid identifier
         self.scagent.query_available_for_me(oauth_result["token"],
                                             oauth_result["consumer_key"])

=== modified file 'softwarecenter/ui/gtk3/session/appmanager.py'
--- softwarecenter/ui/gtk3/session/appmanager.py	2011-11-09 10:35:09 +0000
+++ softwarecenter/ui/gtk3/session/appmanager.py	2011-11-24 16:27:53 +0000
@@ -16,6 +16,8 @@
 # this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
+import json
+
 try:
     from urllib.parse import urlencode
     urlencode  # pyflakes
@@ -55,6 +57,7 @@
         self.distro = get_distro()
         self.datadir = softwarecenter.paths.datadir
         self.icons = icons
+        self.oauth_token = ""
 
     def _globalise_instance(self):
         global _appmanager
@@ -162,12 +165,14 @@
         license_key = appdetails.license_key
         license_key_path = appdetails.license_key_path
         signing_key_id = appdetails.signing_key_id
+        oauth_token = json.dumps(self.oauth_token)
         self.backend.add_repo_add_key_and_install_app(deb_line,
                                                       signing_key_id,
                                                       app,
                                                       iconname,
                                                       license_key,
-                                                      license_key_path)
+                                                      license_key_path,
+                                                      oauth_token)
 
     def enable_software_source(self, app):
         """ enable the software source for the given app """

=== modified file 'softwarecenter/ui/gtk3/views/purchaseview.py'
--- softwarecenter/ui/gtk3/views/purchaseview.py	2011-11-22 08:28:29 +0000
+++ softwarecenter/ui/gtk3/views/purchaseview.py	2011-11-24 16:27:53 +0000
@@ -125,6 +125,7 @@
         GObject.GObject.__init__(self)
         self.wk = None
         self._wk_handlers_blocked = False
+        self._oauth_token = None
 
     def init_view(self):
         if self.wk is None:
@@ -188,6 +189,13 @@
         return wk.webkit
 
     def _on_console_message(self, view, message, line, source_id):
+        try:
+            # load the token from the console message
+            self._oauth_token = json.loads(message)
+            # compat with the regular oauth naming
+            self._oauth_token["token"] = self._oauth_token["token_key"]
+        except ValueError:
+            pass
         for k in ["token_key", "token_secret", "consumer_secret"]:
             if k in message:
                 LOG.debug("skipping console message that contains sensitive data")
@@ -256,7 +264,7 @@
             backend = get_install_backend()
             backend.add_repo_add_key_and_install_app(
                 deb_line, signing_key_id, self.app, self.iconname, 
-                license_key, license_key_path)
+                license_key, license_key_path, json.dumps(self._oauth_token))
                                                                    
     def _block_wk_handlers(self):
         # we need to block webkit signal handlers when we hide the

=== modified file 'softwarecenter/version.py'
--- softwarecenter/version.py	2011-11-07 09:41:23 +0000
+++ softwarecenter/version.py	2011-11-24 16:27:53 +0000
@@ -1,5 +1,5 @@
 
-VERSION='5.1.1'
+VERSION='5.1.2'
 CODENAME='UNRELEASED'
 DISTRO='Ubuntu'
-RELEASE='11.10'
+RELEASE='12.04'

=== modified file 'test/test_aptd.py'
--- test/test_aptd.py	2011-09-29 18:16:38 +0000
+++ test/test_aptd.py	2011-11-24 16:27:53 +0000
@@ -2,12 +2,16 @@
 
 import os
 import sys
+import time
 import unittest
 
 
 sys.path.insert(0,"../")
 from softwarecenter.backend.installbackend_impl.aptd import AptdaemonBackend
 from defer import inline_callbacks
+from mock import Mock
+
+import aptdaemon.loop 
 
 class TestAptdaemon(unittest.TestCase):
     """ tests the AptdaemonBackend """
@@ -27,23 +31,39 @@
         # test HOME
         target = "~/.fasfasdfsdafdfsdafdsfa"
         pkgname = "2vcard"
-        yield self.aptd.add_license_key(data, target, pkgname)
+        json_auth = ""
+        yield self.aptd.add_license_key(data, target, json_auth, pkgname)
         self.assertEqual(open(os.path.expanduser(target)).read(), data)
         # ensure its not written twice
         data2 = "other-data"
-        yield self.aptd.add_license_key(data2, target, pkgname)
+        yield self.aptd.add_license_key(data2, target, json_auth, pkgname)
         self.assertEqual(open(os.path.expanduser(target)).read(), data)
         # cleanup
         os.remove(os.path.expanduser(target))
 
-    # disabled until aptdaemon support is merged
-    def disabled_test_add_license_key_opt(self):
+    def test_add_license_key_opt(self):
+        if os.getuid() != 0:
+            logging.info("skipping add_license_key_opt test")
+            return
         # test /opt
         data = "some-data"
-        pkgname = "2vcard"
-        path = "/opt"
-        defer = self.aptd.add_license_key(data, path, pkgname)
-        self.assertTrue(defer.called)
+        pkgname = "hellox"
+        path = "/opt/hellox/conf/license-key.txt"
+        json_auth = os.environ.get("SC_TEST_JSON") or "no-json-auth"
+        def _error(*args):
+            print "errror", args
+        self.aptd.ui = Mock()
+        self.aptd.ui.error = _error
+        @inline_callbacks
+        def run():
+            res = yield self.aptd.add_license_key(data, path, json_auth, pkgname)
+            aptdaemon.loop.mainloop.quit()
+        # run the callback
+        run()
+        aptdaemon.loop.mainloop.run()
+        # give the daemon time to write the file
+        time.sleep(0.5)
+        self.assertTrue(os.path.exists(path))
         #self.assertEqual(open(os.path.expanduser(target)).read(), data)
         #os.remove(os.path.expanduser(target))
 
@@ -60,8 +80,10 @@
         self.assertEqual(self._pkgs_to_install, ["7zip", "2vcard"])
         self._pkgs_to_install = []
 
-    def _monkey_patched_add_vendor_key_from_keyserver(self, keyid, *args):
+    def _monkey_patched_add_vendor_key_from_keyserver(self, keyid, 
+                                                      *args, **kwargs):
         self.assertTrue(keyid.startswith("0x"))
+        return Mock()
 
     def test_download_key_from_keyserver(self):
         keyid = "0EB12F05"