Merge lp:~jderose/userwebkit/links into lp:userwebkit

[Jason Gerard DeRose]

Adds CouchView._on_nav_policy_decision() and its test.

Also adds new CouchView 'open' signal, used to open external links in the user's default browser.

=== modified file 'debian/control'
--- debian/control	2011-10-01 01:05:20 +0000
+++ debian/control	2011-12-22 05:11:23 +0000
@@ -3,7 +3,7 @@
 Priority: optional
 Maintainer: Jason Gerard DeRose <[e-mail]>
 Build-Depends: debhelper (>= 8.9), python3 (>= 3.2),
-    python3-microfiber (>= 11.10),
+    python3-microfiber (>= 11.12),
     python3-gobject,
     gir1.2-gtk-3.0,
     gir1.2-webkit-3.0,
@@ -15,8 +15,8 @@
 Package: python3-userwebkit
 Architecture: all
 Depends: ${misc:Depends}, python3 (>= 3.2),
-    python3-microfiber (>= 11.10),
-    dc3 (>= 11.10),
+    python3-microfiber (>= 11.12),
+    dc3 (>= 11.12),
     python3-gobject,
     gir1.2-gtk-3.0,
     gir1.2-webkit-3.0,

=== modified file 'test_userwebkit.py'
--- test_userwebkit.py	2011-09-26 10:25:21 +0000
+++ test_userwebkit.py	2011-12-22 05:11:23 +0000
@@ -63,6 +63,31 @@
     }
 
 
+class DummyCallback:
+    def __init__(self):
+        self._calls = []
+
+    def __call__(self, *args):
+        self._calls.append(args)
+
+
+class DummyRequest:
+    def __init__(self, uri):
+        self.__uri = uri
+
+    def get_uri(self):
+        return self.__uri
+
+
+class DummyPolicy:
+    def __init__(self):
+        self._called = False
+
+    def ignore(self):
+        assert self._called is False
+        self._called = True
+
+
 class TestCouchView(TestCase):
     def test_init(self):
         view = userwebkit.CouchView()
@@ -115,3 +140,69 @@
         self.assertIsNone(view._env)
         self.assertIsNone(view._on_request(None, None, None, None, None))
 
+    def test_on_nav_policy_decision(self):
+        callback = DummyCallback()
+        view = userwebkit.CouchView()
+        view.connect('open', callback)
+
+        # Make sure on_request() immediately returns when env is None:
+        self.assertIsNone(
+            view._on_nav_policy_decision(None, None, None, None, None)
+        )
+        self.assertEqual(callback._calls, [])
+
+        # When URI netloc and scheme matches env, should return False
+        env = random_env()
+        view.set_env(env)
+        request = DummyRequest(env['url'] + 'foo')
+        self.assertIs(
+            view._on_nav_policy_decision(None, None, request, None, None),
+            False
+        )
+        self.assertEqual(callback._calls, [])
+
+        # For external http, https URI, should fire 'open' signal, call
+        # policy.ignore(), and return True
+        request = DummyRequest('http://www.ubuntu.com/')
+        policy = DummyPolicy()
+        self.assertIs(
+            view._on_nav_policy_decision(None, None, request, None, policy),
+            True
+        )
+        self.assertIs(policy._called, True)
+        self.assertEqual(callback._calls,
+            [
+                (view, 'http://www.ubuntu.com/'),   
+            ]
+        )
+ 
+        request = DummyRequest('https://launchpad.net/novacut')
+        policy = DummyPolicy()
+        self.assertIs(
+            view._on_nav_policy_decision(None, None, request, None, policy),
+            True
+        )
+        self.assertIs(policy._called, True)
+        self.assertEqual(callback._calls,
+            [
+                (view, 'http://www.ubuntu.com/'),
+                (view, 'https://launchpad.net/novacut'),  
+            ]
+        )
+
+        # For other non-internal URI, should just call policy.ignore() and
+        # return True... should not fire 'open'
+        request = DummyRequest('ftp://example.com/')
+        policy = DummyPolicy()
+        self.assertIs(
+            view._on_nav_policy_decision(None, None, request, None, policy),
+            True
+        )
+        self.assertIs(policy._called, True)
+        self.assertEqual(callback._calls,
+            [
+                (view, 'http://www.ubuntu.com/'),
+                (view, 'https://launchpad.net/novacut'),  
+            ]
+        )
+

=== modified file 'ui/index.html'
--- ui/index.html	2011-11-24 20:42:28 +0000
+++ ui/index.html	2011-12-22 05:11:23 +0000
@@ -54,5 +54,8 @@
 <p id="hello"></p>
 <p>Right click and <strong>Inspect Element</strong></p>
 <button id="button">Start</button>
+<p>
+<a href="http://novacut.com/">A test link</a>
+</p>
 </body>
 </html>

=== modified file 'userwebkit.py'
--- userwebkit.py	2011-12-18 14:41:37 +0000
+++ userwebkit.py	2011-12-22 05:11:23 +0000
@@ -74,12 +74,18 @@
         'title_data': (GObject.SIGNAL_RUN_LAST, GObject.TYPE_NONE,
             [TYPE_PYOBJECT]
         ),
+        'open': (GObject.SIGNAL_RUN_LAST, GObject.TYPE_NONE,
+            [TYPE_PYOBJECT]
+        ),
     }
 
     def __init__(self, env=None):
         super().__init__()
         self.connect('resource-request-starting', self._on_request)
         self.connect('notify::title', self._on_notify_title)
+        self.connect('navigation-policy-decision-requested',
+            self._on_nav_policy_decision
+        )
         self.set_env(env)
 
     def set_env(self, env):
@@ -116,6 +122,35 @@
         for (key, value) in h.items():
             request.props.message.props.request_headers.append(key, value)
 
+    def _on_nav_policy_decision(self, view, frame, request, nav, policy):
+        """
+        Handle user trying to Navigate away from current page.
+
+        Note that this will be called before `CouchView._on_resource_request()`.
+
+        The *policy* arg is a ``WebPolicyDecision`` instance.  To handle the
+        decision, call one of:
+
+            * ``WebPolicyDecision.ignore()``
+            * ``WebPolicyDecision.use()``
+            * ``WebPolicyDecision.download()``
+
+        And then return ``True``.
+
+        Otherwise, return ``False`` or ``None`` to have the WebKit default
+        behavior apply.
+        """
+        if self._env is None:
+            return
+        uri = request.get_uri()
+        u = urlparse(uri)
+        if u.netloc == self._u.netloc and u.scheme in ('http', 'https'):
+            return False
+        if u.scheme in ('http', 'https'):
+            self.emit('open', uri)
+        policy.ignore()
+        return True
+
     def _on_notify_title(self, view, notify):
         title = view.get_property('title')
         if title is None:
@@ -233,6 +268,7 @@
             Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC
         )
         self.view = CouchView()
+        self.view.connect('open', self.on_open)
         self.scroll.add(self.view)
         self.view.get_settings().set_property('enable-developer-extras', True)
         inspector = self.view.get_inspector()
@@ -293,8 +329,12 @@
 
     def on_reload(self, button):
         self.view.reload_bypass_cache()
-        
+
     def on_futon(self, button):
         self.view.load_uri(self.server._full_url('/_utils/'))
-        
+
+    def on_open(self, view, uri):
+        import subprocess
+        subprocess.check_call(['/usr/bin/xdg-open', uri])
+