Merge lp:~mvo/software-center/oem-descriptor-in-user-agent into lp:software-center

[Michael Vogt]

Include the oem channel descriptor in the user-agent string

[James Westby (james-w)]

review: Approve

=== modified file 'softwarecenter/enums.py'
--- softwarecenter/enums.py	2012-08-01 04:26:27 +0000
+++ softwarecenter/enums.py	2012-08-21 09:13:20 +0000
@@ -300,7 +300,7 @@
 PURCHASE_TRANSACTION_ID = "FakePurchaseTransactionID"
 
 from .version import VERSION, DISTRO, RELEASE, CODENAME
-USER_AGENT = "Software Center/%s (N;) %s/%s (%s)" % (
+WEBKIT_USER_AGENT_SUFFIX = "SoftwareCenter/%s %s/%s (%s)" % (
     VERSION, DISTRO, RELEASE, CODENAME)
 
 # global backend switch, prefer aptdaemon, if that can not be found, use PK

=== modified file 'softwarecenter/paths.py'
--- softwarecenter/paths.py	2012-04-12 10:15:36 +0000
+++ softwarecenter/paths.py	2012-08-21 09:13:20 +0000
@@ -70,6 +70,8 @@
 APT_XAPIAN_INDEX_UPDATE_STAMP_PATH = (APT_XAPIAN_INDEX_BASE_PATH +
                                       "/update-timestamp")
 
+# OEM
+OEM_CHANNEL_DESCRIPTOR = "/var/lib/ubuntu-dist-channel"
 
 # ratings&review
 # relative to datadir

=== modified file 'softwarecenter/ui/gtk3/widgets/webkit.py'
--- softwarecenter/ui/gtk3/widgets/webkit.py	2012-08-14 05:46:18 +0000
+++ softwarecenter/ui/gtk3/widgets/webkit.py	2012-08-21 09:13:20 +0000
@@ -27,6 +27,8 @@
 
 from softwarecenter.i18n import get_language
 from softwarecenter.paths import SOFTWARE_CENTER_CACHE_DIR
+from softwarecenter.enums import WEBKIT_USER_AGENT_SUFFIX
+from softwarecenter.utils import get_oem_channel_descriptor
 
 from gi.repository import Soup
 from gi.repository import WebKit
@@ -70,13 +72,30 @@
 global_webkit_init()
 
 
-class LocaleAwareWebView(webkit.WebView):
+class SoftwareCenterWebView(webkit.WebView):
+    """ A customized version of the regular webview 
+
+    It will:
+    - send Accept-Language headers from the users language
+    - disable plugings
+    - send a custom user-agent string
+    """
 
     def __init__(self):
         # actual webkit init
         webkit.WebView.__init__(self)
         self.connect("resource-request-starting",
                      self._on_resource_request_starting)
+        settings = self.get_settings()
+        settings.set_property("enable-plugins", False)
+        settings.set_property("user-agent", self._get_user_agent_string())
+
+    def _get_user_agent_string(self):
+        settings = self.get_settings()
+        user_agent_string = settings.get_property("user-agent")
+        user_agent_string += " %s " % WEBKIT_USER_AGENT_SUFFIX
+        user_agent_string += get_oem_channel_descriptor()
+        return user_agent_string
 
     def _on_resource_request_starting(self, view, frame, res, req, resp):
         lang = get_language()
@@ -95,9 +114,7 @@
     def __init__(self, include_progress_ui=False):
         super(ScrolledWebkitWindow, self).__init__()
         # get webkit
-        self.webkit = LocaleAwareWebView()
-        settings = self.webkit.get_settings()
-        settings.set_property("enable-plugins", False)
+        self.webkit = SoftwareCenterWebView()
         # add progress UI if needed
         if include_progress_ui:
             self._add_progress_ui()

=== modified file 'softwarecenter/utils.py'
--- softwarecenter/utils.py	2012-08-16 14:44:29 +0000
+++ softwarecenter/utils.py	2012-08-21 09:13:20 +0000
@@ -38,7 +38,10 @@
     from urlparse import urlsplit
 
 from enums import Icons, APP_INSTALL_PATH_DELIMITER
-from paths import SOFTWARE_CENTER_CACHE_DIR
+from paths import (
+    SOFTWARE_CENTER_CACHE_DIR,
+    OEM_CHANNEL_DESCRIPTOR,
+    )
 
 from config import get_config
 
@@ -754,6 +757,15 @@
                 raise
 
 
+def get_oem_channel_descriptor(path=OEM_CHANNEL_DESCRIPTOR):
+    """Return the ubuntu  distribution channel descriptor or a empty string """
+    if not os.path.exists(path):
+        return ""
+    with open(path) as f:
+        for line in filter(lambda l: not l.startswith("#"), f):
+            return line.strip()
+
+
 class SimpleFileDownloader(GObject.GObject):
 
     LOG = logging.getLogger("softwarecenter.simplefiledownloader")

=== added file 'tests/data/ubuntu_dist_channel'
--- tests/data/ubuntu_dist_channel	1970-01-01 00:00:00 +0000
+++ tests/data/ubuntu_dist_channel	2012-08-21 09:13:20 +0000
@@ -0,0 +1,3 @@
+# This is a distribution channel descriptor
+# For more information see http://wiki.ubuntu.com/DistributionChannelDescriptor
+canonical-oem-watauga-precise-amd64-20120517-2

=== modified file 'tests/gtk3/test_purchase.py'
--- tests/gtk3/test_purchase.py	2012-08-15 12:00:33 +0000
+++ tests/gtk3/test_purchase.py	2012-08-21 09:13:20 +0000
@@ -2,8 +2,6 @@
 
 from mock import Mock, patch
 
-from gi.repository import Soup, WebKit
-
 from tests.utils import (
     do_events_with_sleep,
     get_mock_options,
@@ -21,14 +19,6 @@
 
 class TestPurchase(unittest.TestCase):
 
-    def test_have_cookie_jar(self):
-        # ensure we have a cookie jar available
-        session = WebKit.get_default_session()
-        cookie_jars = [feature 
-                for feature in  session.get_features(Soup.SessionFeature)
-                if isinstance(feature, Soup.CookieJar)]
-        self.assertEqual(len(cookie_jars), 1)
-
     def test_purchase_view_log_cleaner(self):
         win = get_test_window_purchaseview()
         self.addCleanup(win.destroy)

=== 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-08-21 09:13:20 +0000
@@ -0,0 +1,44 @@
+import unittest
+
+from gi.repository import Soup, WebKit
+
+from mock import patch
+
+from tests.utils import (
+    setup_test_env,
+)
+setup_test_env()
+
+from softwarecenter.enums import WEBKIT_USER_AGENT_SUFFIX
+from softwarecenter.ui.gtk3.widgets.webkit import SoftwareCenterWebView
+
+
+class TestWebkit(unittest.TestCase):
+
+    def test_have_cookie_jar(self):
+        # ensure we have a cookie jar available
+        session = WebKit.get_default_session()
+        cookie_jars = [feature 
+                for feature in  session.get_features(Soup.SessionFeature)
+                if isinstance(feature, Soup.CookieJar)]
+        self.assertEqual(len(cookie_jars), 1)
+    
+    def test_user_agent_string(self):
+        webview = SoftwareCenterWebView()
+        settings = webview.get_settings()
+        self.assertTrue(
+            WEBKIT_USER_AGENT_SUFFIX in settings.get_property("user-agent"))
+
+    @patch("softwarecenter.ui.gtk3.widgets.webkit.get_oem_channel_descriptor")
+    def test_user_agent_oem_channel_descriptor(self, mock_oem_channel):
+        canary = "she-loves-you-yeah-yeah-yeah"
+        mock_oem_channel.return_value = canary
+        webview = SoftwareCenterWebView()
+        settings = webview.get_settings()
+        self.assertTrue(
+            canary in settings.get_property("user-agent"))
+        
+        
+
+if __name__ == "__main__":
+    unittest.main()

=== modified file 'tests/test_utils.py'
--- tests/test_utils.py	2012-07-19 09:29:16 +0000
+++ tests/test_utils.py	2012-08-21 09:13:20 +0000
@@ -31,6 +31,7 @@
     get_http_proxy_string_from_libproxy,
     get_http_proxy_string_from_gsettings,
     get_nice_date_string,
+    get_oem_channel_descriptor,
     get_title_from_html,
     get_uuid,
     is_no_display_desktop_file,
@@ -288,6 +289,10 @@
         # ensure that the second one was not called
         self.assertEqual(len(glob.glob(os.path.join(tmpdir, "marker.*"))), 1)
 
+    def test_oem_channel_extractor(self):
+        s = get_oem_channel_descriptor("./tests/data/ubuntu_dist_channel")
+        self.assertEqual(s, "canonical-oem-watauga-precise-amd64-20120517-2")
+
 
 if __name__ == "__main__":
     unittest.main()