Merge lp:~mvo/software-center/oauth-from-webkit into lp:software-center

[Michael Vogt]

This adds support for having oauth signed requests from the webkit view to avoid having to login again into the web login if there is a oauth token in the keyring already.

[Michael Vogt (mvo)]

Setting to work in progress until Anthony gets a chance to look at it.

[Michael Vogt (mvo)]

To test you can run:
$ PYTHONPATH=. python softwarecenter/ui/gtk3/views/purchaseview.py https://software-center.ubuntu.com/api/2.0/subscriptions

This probably needs a bit of cleanup but the basic principal should be there.

Unmerged revisions

3053. By Michael Vogt on 2012-07-03

add support for oauth signing into our webkit to allow avoiding the first (web) login if there is a auth token already

=== modified file 'softwarecenter/backend/login_sso.py'
--- softwarecenter/backend/login_sso.py	2012-04-16 20:51:09 +0000
+++ softwarecenter/backend/login_sso.py	2012-07-03 08:41:20 +0000
@@ -25,6 +25,8 @@
 import string
 import os
 
+from gi.repository import GObject
+
 from dbus.mainloop.glib import DBusGMainLoop
 DBusGMainLoop(set_as_default=True)
 
@@ -36,6 +38,11 @@
 
 LOG = logging.getLogger(__name__)
 
+from ubuntu_sso import (
+        DBUS_BUS_NAME,
+        DBUS_CREDENTIALS_IFACE,
+        DBUS_CREDENTIALS_PATH,
+        )
 
 class LoginBackendDbusSSO(LoginBackend):
 
@@ -44,8 +51,11 @@
         self.appname = appname
         self.help_text = help_text
         self.bus = dbus.SessionBus()
-        self.proxy = self.bus.get_object(
-            'com.ubuntu.sso', '/com/ubuntu/sso/credentials')
+        obj = self.bus.get_object(bus_name=DBUS_BUS_NAME,
+                                  object_path=DBUS_CREDENTIALS_PATH,
+                                  follow_name_owner_changes=True)
+        self.proxy =  dbus.Interface(object=obj,
+                                     dbus_interface=DBUS_CREDENTIALS_IFACE)
         self.proxy.connect_to_signal("CredentialsFound",
                                      self._on_credentials_found)
         self.proxy.connect_to_signal("CredentialsError",
@@ -73,6 +83,25 @@
         self._credentials = None
         self.proxy.register(self.appname, self._get_params())
 
+    def find_credentials_sync(self):
+        LOG.debug("find_credentials_sync()")
+        self._credentials = None
+
+        # setup tmp handlers that stop the loop
+        loop = GObject.MainLoop(GObject.main_context_default())
+        sigs = []
+        sigs.append(self.connect("login-successful", lambda s,c: loop.quit()))
+        sigs.append(self.connect("login-failed", lambda s: loop.quit()))
+
+        # run and wait for the handlers to exit the loop
+        self.proxy.find_credentials(self.appname, self._get_params())
+        loop.run()
+
+        for sig in sigs:
+            self.disconnect(sig)
+
+        return self._credentials
+
     def _on_credentials_found(self, app_name, credentials):
         LOG.debug("_on_credentials_found for '%s'" % app_name)
         if app_name != self.appname:

=== modified file 'softwarecenter/ui/gtk3/views/purchaseview.py'
--- softwarecenter/ui/gtk3/views/purchaseview.py	2012-05-30 18:39:55 +0000
+++ softwarecenter/ui/gtk3/views/purchaseview.py	2012-07-03 08:41:20 +0000
@@ -36,6 +36,12 @@
 from softwarecenter.ui.gtk3.utils import get_parent
 from softwarecenter.ui.gtk3.views.webkit import ScrolledWebkitWindow
 
+from softwarecenter.backend.login_sso import get_sso_backend
+from softwarecenter.enums import (SOFTWARE_CENTER_NAME_KEYRING,
+                                  SOFTWARE_CENTER_SSO_DESCRIPTION,
+                                  )
+
+
 LOG = logging.getLogger(__name__)
 
 
@@ -104,7 +110,10 @@
         GObject.GObject.__init__(self)
         self.wk = None
         self._wk_handlers_blocked = False
-        self._oauth_token = None
+        # for the oauth
+        sso = get_sso_backend(None, SOFTWARE_CENTER_NAME_KEYRING, "")
+        self._oauth_token = sso.find_credentials_sync()
+
         self.config = get_config()
 
     def _log_debug_output(self, *args):
@@ -112,7 +121,7 @@
 
     def init_view(self):
         if self.wk is None:
-            self.wk = ScrolledWebkitWindow()
+            self.wk = ScrolledWebkitWindow(self._oauth_token)
             #self.wk.webkit.connect("new-window-policy-decision-requested",
             #    self._on_new_window)
             self.wk.webkit.connect("create-web-view", self._on_create_web_view)

=== modified file 'softwarecenter/ui/gtk3/views/webkit.py'
--- softwarecenter/ui/gtk3/views/webkit.py	2012-06-28 07:20:49 +0000
+++ softwarecenter/ui/gtk3/views/webkit.py	2012-07-03 08:41:20 +0000
@@ -17,8 +17,16 @@
 # this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
+<<<<<<< TREE
 import os
 
+=======
+import urlparse
+
+from oauth.oauth import (
+    OAuthRequest, OAuthToken, OAuthConsumer, OAuthSignatureMethod_PLAINTEXT)
+
+>>>>>>> MERGE-SOURCE
 from gi.repository import WebKit as webkit
 from gi.repository import Gtk
 from gi.repository import Pango
@@ -44,14 +52,17 @@
     session.add_feature(cookie_jar)
 global_webkit_init()
 
-
 class LocaleAwareWebView(webkit.WebView):
 
-    def __init__(self):
+    SIGN_WITH_OAUTH_URL = "https://software-center.ubuntu.com"
+    OAUTH_REALM = "software-center.ubuntu.com"
+
+    def __init__(self, oauth_token=None):
         # actual webkit init
         webkit.WebView.__init__(self)
         self.connect("resource-request-starting",
                      self._on_resource_request_starting)
+        self._oauth = oauth_token
 
     def _on_resource_request_starting(self, view, frame, res, req, resp):
         lang = get_language()
@@ -64,13 +75,44 @@
         #    print name, value
         #headers.foreach(_show_header, None)
 
+        # SEE FULL HTTP DEBUG WITH: 
+        #   $ SOFTWARE_CENTER_DEBUG_WEBKIT=1 ./software-center
+        # once lp:~mvo/software-center/webkit-http-debug is merged
+
+        # sign with oauth if we have the right url
+        url = req.get_property("uri")
+        if url.startswith(self.SIGN_WITH_OAUTH_URL):
+            self._sign_with_oauth(req)
+
+    def _sign_with_oauth(self, req):
+        """ OAuth sign a SoupRequest """
+        message = req.get_message()
+        if message and self._oauth:
+            consumer = OAuthConsumer(
+                self._oauth["consumer_key"], self._oauth["consumer_secret"])
+            token = OAuthToken(
+                self._oauth["token"], self._oauth["token_secret"])
+            url = req.get_property("uri")
+            parts = urlparse.urlparse(url)
+            parameters = urlparse.parse_qs(parts.query)
+            oauth_request = OAuthRequest.from_consumer_and_token(
+                consumer, token, http_url=url, parameters=parameters)
+            oauth_request.sign_request(
+                OAuthSignatureMethod_PLAINTEXT(), consumer, token)
+            # FIXME: what do we need here?
+            oauth_realm = self.OAUTH_REALM
+            # update the headers
+            headers = message.get_property("request-headers")
+            for k,v in oauth_request.to_header(realm=oauth_realm).iteritems():
+                headers.append(k, v)
+
 
 class ScrolledWebkitWindow(Gtk.VBox):
 
-    def __init__(self, include_progress_ui=False):
+    def __init__(self, oauth_token=None, include_progress_ui=False):
         super(ScrolledWebkitWindow, self).__init__()
         # get webkit
-        self.webkit = LocaleAwareWebView()
+        self.webkit = LocaleAwareWebView(oauth_token)
         settings = self.webkit.get_settings()
         settings.set_property("enable-plugins", False)
         # add progress UI if needed

=== added file 'tests/gtk3/test_webkit.py'
--- tests/gtk3/test_webkit.py	1970-01-01 00:00:00 +0000
+++ tests/gtk3/test_webkit.py	2012-07-03 08:41:20 +0000
@@ -0,0 +1,54 @@
+import os
+import unittest
+
+from gi.repository import GObject
+from gi.repository import WebKit
+from gi.repository import Soup
+
+from testutils import setup_test_env
+setup_test_env()
+
+from softwarecenter.ui.gtk3.views.webkit import LocaleAwareWebView
+
+class WebkitTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.loop = GObject.MainLoop(GObject.main_context_default())
+        # add log
+        session = WebKit.get_default_session()
+        logger = Soup.Logger.new(Soup.LoggerLogLevel.HEADERS, -1)
+        logger.set_printer(self._soup_log_collector, None)
+        logger.attach(session)
+        self.addCleanup(lambda: logger.detach(session))
+        self._soup_headers = []
+ 
+    def test_webkit_oauth(self):
+        oauth = { "token" : "aToken",
+                  "consumer_key" : "aConsumerKey",
+                  "consumer_secret" : "aConsumerSecret",
+                  "token_secret" : "aTokenSecret",
+                 }
+        wk = LocaleAwareWebView(oauth_token=oauth)
+        wk.connect("notify::load-status", self._on_load_status_changed)
+        wk.open("https://software-center.ubuntu.com/subscriptions/en/ubuntu/precise/+new/?archive_id=commercial-ppa-uploaders%2Fworld-of-goo&arch=amd64")
+        self.loop.run()
+        # poor mans check
+        for header in self._soup_headers:
+            if "oauth_signature" in header:
+                break
+        else:
+            raise Exception("Failed to find oauth_signature in headers")
+
+    def _soup_log_collector(self, logger, level, direction, data, user_data):
+        #print logger, level, direction, data
+        self._soup_headers.append(data)
+
+    def _on_load_status_changed(self, view, pspec):
+        prop = pspec.name
+        status = view.get_property(prop)
+        if (status == WebKit.LoadStatus.FINISHED or
+            status == WebKit.LoadStatus.FAILED):
+            self.loop.quit()
+
+if __name__ == "__main__":
+    unittest.main()