Merge lp:~mvo/software-center/purchaseviewspinner2 into lp:software-center

[Michael Vogt]

This adds a spinner to the purchaseview both when new windows are opened and in the global toolbar.

[Gary Lasker (gary-lasker)]

This is awesome! Thanks mvo!

review: Approve

=== modified file 'softwarecenter/ui/gtk3/panes/availablepane.py'
--- softwarecenter/ui/gtk3/panes/availablepane.py	2011-11-29 21:50:55 +0000
+++ softwarecenter/ui/gtk3/panes/availablepane.py	2011-12-14 13:06:26 +0000
@@ -138,6 +138,7 @@
         self.purchase_view.connect("purchase-succeeded", self.on_purchase_succeeded)
         self.purchase_view.connect("purchase-failed", self.on_purchase_failed)
         self.purchase_view.connect("purchase-cancelled-by-user", self.on_purchase_cancelled_by_user)
+        self.purchase_view.connect("purchase-needs-spinner", self.on_purchase_needs_spinner)
         # categories, appview and details into the notebook in the bottom
         self.scroll_categories = Gtk.ScrolledWindow()
         self.scroll_categories.set_policy(Gtk.PolicyType.AUTOMATIC, 
@@ -226,6 +227,10 @@
             self.display_purchase)
         return
 
+    def on_purchase_needs_spinner(self, appmanager, active):
+        vm = get_viewmanager()
+        vm.set_spinner_active(active)
+
     def on_purchase_succeeded(self, widget):
         # switch to the details page to display the transaction is in progress
         self._return_to_appdetails_view()
 
=== modified file 'softwarecenter/ui/gtk3/panes/globalpane.py'
--- softwarecenter/ui/gtk3/panes/globalpane.py	2011-09-15 09:36:39 +0000
+++ softwarecenter/ui/gtk3/panes/globalpane.py	2011-12-14 13:06:26 +0000
@@ -47,6 +47,12 @@
         #~ self.init_atk_name(self.searchentry, "searchentry")
         self.searchentry = vm.get_global_searchentry()
         self._insert_as_tool_item(self.searchentry, -1)
+
+        # spinner
+        self.spinner = vm.get_global_spinner()
+        self.spinner.set_size_request(StockEms.XLARGE, StockEms.XLARGE)
+        self._insert_as_tool_item(self.spinner, -1)
+
         if self.get_direction() != Gtk.TextDirection.RTL:
             _widget_set_margins(self.searchentry, right=StockEms.MEDIUM)
         else:
@@ -77,6 +83,7 @@
     p = GlobalPane(vm, datadir, db, cache, icons)
 
     win = Gtk.Window()
+    win.set_data("pane", p)
     win.connect("destroy", Gtk.main_quit)
     win.add(p)
     win.show_all()
 
=== modified file 'softwarecenter/ui/gtk3/session/viewmanager.py'
--- softwarecenter/ui/gtk3/session/viewmanager.py	2011-11-09 09:49:39 +0000
+++ softwarecenter/ui/gtk3/session/viewmanager.py	2011-12-14 13:06:26 +0000
@@ -49,6 +49,7 @@
             "right-clicked", self.on_nav_forward_clicked)
 
         self.navhistory = NavigationHistory(self.back_forward, options)
+        self.spinner = Gtk.Spinner()
 
         self.all_views = {}
         self.view_to_pane = {}
@@ -95,9 +96,22 @@
             if page_id == v:
                 return k
 
+    def set_spinner_active(self, active):
+        if active:
+            self.spinner.show()
+            self.spinner.start()
+        else:
+            self.spinner.stop()
+            self.spinner.hide()
+
     def set_active_view(self, view_id):
+        # no views yet
         if not self.all_views: 
             return
+        # if the view switches, ensure that the global spinner is hidden
+        self.spinner.hide()
+
+        # emit signal
         self.emit('view-changed', view_id)
         page_id = self.all_views[view_id]
         view_widget = self.get_view_widget(view_id)
@@ -178,6 +192,7 @@
             self.search_entry.hide()
         else:
             self.search_entry.show()
+            self.spinner.hide()
         return
 
     def nav_back(self):
@@ -194,3 +209,6 @@
 
     def get_global_backforward(self):
         return self.back_forward
+
+    def get_global_spinner(self):
+        return self.spinner
 
=== modified file 'softwarecenter/ui/gtk3/views/purchaseview.py'
--- softwarecenter/ui/gtk3/views/purchaseview.py	2011-12-12 09:15:52 +0000
+++ softwarecenter/ui/gtk3/views/purchaseview.py	2011-12-14 13:06:26 +0000
@@ -20,11 +20,13 @@
 from gi.repository import GObject
 from gi.repository import Gtk
 from gi.repository import Gdk
+from gi.repository import Pango
 import logging
 import os
 import json
 import sys
 import urllib
+import urlparse
 from gi.repository import WebKit as webkit
 session = webkit.get_default_session()
 session.set_property("ssl-ca-file", "/etc/ssl/certs/ca-certificates.crt")
@@ -55,17 +57,70 @@
         #headers.foreach(_show_header, None)
 
 
-class ScrolledWebkitWindow(Gtk.ScrolledWindow):
+class ScrolledWebkitWindow(Gtk.VBox):
 
-    def __init__(self):
+    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.show()
+        # add progress UI if needed
+        if include_progress_ui:
+            self._add_progress_ui()
+        # create main webkitview
+        self.scroll = Gtk.ScrolledWindow()
+        self.scroll.set_policy(Gtk.PolicyType.AUTOMATIC, 
+                               Gtk.PolicyType.AUTOMATIC)
+        self.pack_start(self.scroll, True, True, 0)
         # embed the webkit view in a scrolled window
-        self.add(self.webkit)
-        self.set_policy(Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)
+        self.scroll.add(self.webkit)
+        self.show_all()
+    def _add_progress_ui(self):
+        # create toolbar box
+        self.header = Gtk.HBox()
+        # add spinner
+        self.spinner = Gtk.Spinner()
+        self.header.pack_start(self.spinner, False, False, 6)
+        # add a url to the toolbar
+        self.url = Gtk.Label()
+        self.url.set_ellipsize(Pango.EllipsizeMode.END)
+        self.url.set_alignment(0.0, 0.5)
+        self.url.set_text("")
+        self.header.pack_start(self.url, True, True, 0)
+        # frame around the box
+        self.frame = Gtk.Frame()
+        self.frame.set_border_width(3)
+        self.frame.add(self.header)
+        self.pack_start(self.frame, False, False, 6)
+        # connect the webkit stuff
+        self.webkit.connect("notify::uri", self._on_uri_changed)
+        self.webkit.connect("notify::load-status", self._on_load_status_changed)
+    def _on_uri_changed(self, view, pspec):
+        prop = pspec.name
+        uri = view.get_property(prop)
+        # the full uri is irellevant for the purchase view, but it is
+        # interessting to know what protocol/netloc is in use so that the
+        # user can verify its https on sites he is expecting
+        scheme, netloc, path, params, query, frag = urlparse.urlparse(uri)
+        if scheme == "file" and netloc == "":
+            self.url.set_text("")
+        else:
+            self.url.set_text("%s://%s" % (scheme, netloc))
+        # start spinner when the uri changes
+        #self.spinner.start()
+    def _on_load_status_changed(self, view, pspec):
+        prop = pspec.name
+        status = view.get_property(prop)
+        #print status
+        if status == webkit.LoadStatus.PROVISIONAL:
+            self.spinner.start()
+            self.spinner.show()
+        if (status == webkit.LoadStatus.FINISHED or
+            status == webkit.LoadStatus.FAILED):
+            self.spinner.stop()
+            self.spinner.hide()
+        
 
 
 class PurchaseView(Gtk.VBox):
@@ -119,6 +174,10 @@
          'purchase-cancelled-by-user' : (GObject.SignalFlags.RUN_LAST,
                                          None,
                                          ()),
+         'purchase-needs-spinner' : (GObject.SignalFlags.RUN_LAST,
+                                      None,
+                                     (bool, )),
+                                     
     }
 
     def __init__(self):
@@ -179,6 +238,7 @@
         
     def _on_create_web_view(self, view, frame):
         win = Gtk.Window()
+<<<<<<< TREE
         win.set_size_request(500, 400)
         # set transient parent
         parent = self
@@ -187,11 +247,20 @@
         win.set_transient_for(parent)
         # and add the webkit view
         wk = ScrolledWebkitWindow()
+=======
+        win.set_size_request(400, 400)
+        wk = ScrolledWebkitWindow(include_progress_ui=True)
+>>>>>>> MERGE-SOURCE
         wk.webkit.connect("close-web-view", self._on_close_web_view)
         win.add(wk)
         win.show_all()
         # make sure close will work later
         wk.webkit.set_data("win", win)
+        # find and set parent
+        w = self.wk.get_parent()
+        while w.get_parent():
+            w = w.get_parent()
+        win.set_transient_for(w)
         return wk.webkit
 
     def _on_console_message(self, view, message, line, source_id):
@@ -224,10 +293,13 @@
         prop = view.get_property(property_spec.name)
         window = self.get_window()
         if prop == webkit.LoadStatus.PROVISIONAL:
+            self.emit("purchase-needs-spinner", True)
             if window:
                 window.set_cursor(Gdk.Cursor.new(Gdk.CursorType.WATCH))
         elif (prop == webkit.LoadStatus.FIRST_VISUALLY_NON_EMPTY_LAYOUT or
+              prop == webkit.LoadStatus.FAILED or
               prop == webkit.LoadStatus.FINISHED):
+            self.emit("purchase-needs-spinner", False)
             if window:
                 window.set_cursor(None)
 
 
=== added file 'test/gtk3/test_globalpane.py'
--- test/gtk3/test_globalpane.py	1970-01-01 00:00:00 +0000
+++ test/gtk3/test_globalpane.py	2011-12-14 13:06:26 +0000
@@ -0,0 +1,30 @@
+#!/usr/bin/python
+
+from gi.repository import Gtk, GObject
+import sys
+import unittest
+
+sys.path.insert(0,"../..")
+sys.path.insert(0,"..")
+
+#from mock import Mock
+
+TIMEOUT=300
+
+import softwarecenter.paths
+softwarecenter.paths.datadir = "../data"
+
+from softwarecenter.testutils import do_events
+
+class TestGlobalPane(unittest.TestCase):
+
+    def test_spinner_available(self):
+        from softwarecenter.ui.gtk3.panes.globalpane import get_test_window
+        win = get_test_window()
+        pane = win.get_data("pane")
+        self.assertNotEqual(pane.spinner, None)
+        do_events()
+
+
+if __name__ == "__main__":
+    unittest.main()
 
=== modified file 'test/gtk3/test_purchase.py'
--- test/gtk3/test_purchase.py	2011-09-20 09:50:30 +0000
+++ test/gtk3/test_purchase.py	2011-12-14 13:06:26 +0000
@@ -20,6 +20,7 @@
     SoftwareCenterAppGtk3)
 from softwarecenter.ui.gtk3.panes.availablepane import (
     AvailablePane)
+from softwarecenter.testutils import do_events
 
 class TestPurchase(unittest.TestCase):
 
@@ -47,6 +48,22 @@
         # run another one
         win.destroy()
 
+    def test_spinner_emits_signals(self):
+        import softwarecenter.ui.gtk3.views.purchaseview
+        from softwarecenter.ui.gtk3.views.purchaseview import get_test_window_purchaseview
+        win = get_test_window_purchaseview()
+        self._p()
+        # get the view
+        view = win.get_data("view")
+        # ensure "purchase-needs-spinner" signals are send
+        signal_mock = Mock()
+        view.connect("purchase-needs-spinner", signal_mock)
+        view.wk.webkit.load_uri("http://www.ubuntu.com/")
+        self._p()
+        self.assertTrue(signal_mock.called)
+        # run another one
+        win.destroy()
+
 
     def test_reinstall_previous_purchase_display(self):
         os.environ["PYTHONPATH"]=".."
@@ -74,8 +91,7 @@
         context = GObject.main_context_default()
         for i in range(5):
             time.sleep(0.1)
-            while context.pending():
-                context.iteration()
+            do_events()
 
 if __name__ == "__main__":
     import logging