Merge lp:~gary-lasker/software-center/recommendations-opt-out into lp:software-center

[Gary Lasker]

This branch implements the recommendations opt-out feature as specified in the most recent Software Center spec from mpt (https://wiki.ubuntu.com/SoftwareCenter/Recommendations#Opting_in_and_out). It adds a new menu item to the "View" menu that reads "Turn Off Recommendations" for the case where the user has previously opted in.

In the case where the user has not yet opted in, this menu item reads "Turn On Recommendations...", and if activated it displays a dialog to show the disclaimer for uploading of data (that same text that is shown in the panel below).

Unfortunately, this branch is light on tests for the small amout of new stuff, but in actuality there is not much new code for which tests will be terribly important. The "heavy" code is already tested -- this is really just some small UI additions. Nevertheless, I apologize for that, and a follow-on branch is forthcoming that will improve this coverage. In the interest of getting this last remaining important piece of recommender functionality merged in time for it to be covered under our current outstanding string freeze/UI freeze exception bug 956779, I'm submitting the MP now.

Thanks!

[lp:~gary-lasker/software-center/recommendations-opt-out]

2858. By Gary Lasker on 2012-03-18

trunkify

2859. By Gary Lasker on 2012-03-19

make a new class RecommendationsOptInDialog in the recommendations module and use it

2860. By Gary Lasker on 2012-03-19

add new tests so that all of the recommendations widget panels are tested

[Gary Lasker (gary-lasker)]

Just a note that I factored the opt-in dialog code to its own class and added some new unit tests so that all of the recommendations panel widget types are tested now.

[Michael Vogt (mvo)]

Thanks for your branch. This is fine but I did some fixes in lp:~mvo/software-center/recommendations-opt-out/
 please double check them and merge back.

=== modified file 'data/ui/gtk3/SoftwareCenter.ui'
--- data/ui/gtk3/SoftwareCenter.ui	2011-11-29 18:52:13 +0000
+++ data/ui/gtk3/SoftwareCenter.ui	2012-03-19 01:17:20 +0000
@@ -158,12 +158,6 @@
                       </object>
                     </child>
                     <child>
-                      <object class="GtkSeparatorMenuItem" id="separator_login">
-                        <property name="visible">True</property>
-                        <property name="can_focus">False</property>
-                      </object>
-                    </child>
-                    <child>
                       <object class="GtkMenuItem" id="menuitem_reinstall_purchases">
                         <property name="visible">True</property>
                         <property name="can_focus">False</property>
@@ -454,6 +448,22 @@
                         <signal name="toggled" handler="on_menuitem_add_to_launcher_toggled" swapped="no"/>
                       </object>
                     </child>
+                    <child>
+                      <object class="GtkSeparatorMenuItem" id="separator_recommendations_opt_in">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                      </object>
+                    </child>
+                    <child>
+                      <object class="GtkMenuItem" id="menuitem_recommendations">
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="use_action_appearance">False</property>
+                        <property name="label" translatable="yes">Turn On Recommendations...</property>
+                        <property name="use_underline">True</property>
+                        <signal name="activate" handler="on_menuitem_recommendations_activate" swapped="no"/>
+                      </object>
+                    </child>
                   </object>
                 </child>
               </object>
 
=== modified file 'softwarecenter/ui/gtk3/app.py'
--- softwarecenter/ui/gtk3/app.py	2012-03-16 17:49:04 +0000
+++ softwarecenter/ui/gtk3/app.py	2012-03-19 01:17:20 +0000
@@ -89,6 +89,8 @@
                                                        get_appmanager)
 from softwarecenter.ui.gtk3.session.viewmanager import (
     ViewManager, get_viewmanager)
+from softwarecenter.ui.gtk3.widgets.recommendations import (
+    RecommendationsOptInDialog)
 
 from softwarecenter.config import get_config
 from softwarecenter.backend import get_install_backend
@@ -370,14 +372,14 @@
 
         # Adapt menu entries
         supported_menuitem = self.builder.get_object(
-            "menuitem_view_supported_only")
+                "menuitem_view_supported_only")
         supported_menuitem.set_label(self.distro.get_supported_filter_name())
         file_menu = self.builder.get_object("menu1")
 
         if not self.distro.DEVELOPER_URL:
             help_menu = self.builder.get_object("menu_help")
             developer_separator = self.builder.get_object(
-                "separator_developer")
+                    "separator_developer")
             help_menu.remove(developer_separator)
             developer_menuitem = self.builder.get_object("menuitem_developer")
             help_menu.remove(developer_menuitem)
@@ -495,6 +497,9 @@
 
     def on_available_pane_created(self, widget):
         self.available_pane.searchentry.grab_focus()
+        rec_panel = self.available_pane.cat_view.recommended_for_you_panel
+        self._update_recommendations_menuitem(
+                        opted_in=rec_panel.recommender_agent.is_opted_in())
         # connect a signal to monitor the recommendations opt-in state and
         # persist the recommendations uuid on an opt-in
         self.available_pane.cat_view.recommended_for_you_panel.connect(
@@ -507,13 +512,25 @@
     #~ def on_installed_pane_created(self, widget):
         #~ pass
 
-    def _on_recommendations_opt_in(self, agent, recommender_uuid):
+    def _on_recommendations_opt_in(self, rec_panel, recommender_uuid):
         self.recommender_uuid = recommender_uuid
+        self._update_recommendations_menuitem(opted_in=True)
 
-    def _on_recommendations_opt_out(self):
+    def _on_recommendations_opt_out(self, rec_panel):
         # if the user opts back out of the recommender service, we
-        # reset the UUID to indicate it
+        # reset the recommender UUID to indicate it
         self.recommender_uuid = ""
+        self._update_recommendations_menuitem(opted_in=False)
+
+    def _update_recommendations_menuitem(self, opted_in):
+        recommendations_menuitem = self.builder.get_object(
+                                            "menuitem_recommendations")
+        if opted_in:
+            recommendations_menuitem.set_label(
+                                            _(u"Turn Off Recommendations"))
+        else:
+            recommendations_menuitem.set_label(
+                                            _(u"Turn On Recommendations..."))
 
     def _on_update_software_center_agent_finished(self, pid, condition):
         LOG.info("software-center-agent finished with status %i" %
@@ -764,7 +781,19 @@
             from softwarecenter.backend.scagent import SoftwareCenterAgent
             self.scagent = SoftwareCenterAgent()
             self.scagent.connect("available-for-me",
-                self._available_for_me_result)
+                                 self._available_for_me_result)
+
+    def on_menuitem_recommendations_activate(self, menu_item):
+        rec_panel = self.available_pane.cat_view.recommended_for_you_panel
+        if rec_panel.recommender_agent.is_opted_in():
+            rec_panel.opt_out_of_recommendations_service()
+        else:
+            # build and show the opt-in dialog
+            opt_in_dialog = RecommendationsOptInDialog(self.icons)
+            res = opt_in_dialog.run()
+            opt_in_dialog.destroy()
+            if res == Gtk.ResponseType.YES:
+                rec_panel.opt_in_to_recommendations_service()
 
     def on_menuitem_reinstall_purchases_activate(self, menuitem):
         self.view_manager.set_active_view(ViewPages.AVAILABLE)
@@ -773,7 +802,7 @@
         if self.available_for_me_query:
             # we already have the list of available items, so just show it
             self.available_pane.on_previous_purchases_activated(
-                self.available_for_me_query)
+                    self.available_for_me_query)
         else:
             # fetch the list of available items and show it
             self._create_scagent_if_needed()
 
=== modified file 'softwarecenter/ui/gtk3/views/catview_gtk.py'
--- softwarecenter/ui/gtk3/views/catview_gtk.py	2012-03-15 21:19:02 +0000
+++ softwarecenter/ui/gtk3/views/catview_gtk.py	2012-03-19 01:17:20 +0000
@@ -579,7 +579,7 @@
             self.vbox.remove(self.recommended_for_you_in_cat)
         self.recommended_for_you_in_cat = RecommendationsPanelCategory(
                                                                     self,
-                                                                   category)
+                                                                    category)
         # only show the panel in the categories view when the user
         # is opted in to the recommender service
         # FIXME: this is needed vs. a simple hide() on the widget because
 
=== modified file 'softwarecenter/ui/gtk3/widgets/containers.py'
--- softwarecenter/ui/gtk3/widgets/containers.py	2012-03-12 12:43:52 +0000
+++ softwarecenter/ui/gtk3/widgets/containers.py	2012-03-19 01:17:20 +0000
@@ -564,6 +564,10 @@
             self.more = MoreLink()
             self.header.pack_end(self.more, False, False, 0)
 
+    def remove_more_button(self):
+        if hasattr(self, "more"):
+            self.header.remove(self.more)
+
     def render_header(self, cr, a, border_radius, assets):
 
         if hasattr(self, "more"):
 
=== modified file 'softwarecenter/ui/gtk3/widgets/recommendations.py'
--- softwarecenter/ui/gtk3/widgets/recommendations.py	2012-03-15 22:23:21 +0000
+++ softwarecenter/ui/gtk3/widgets/recommendations.py	2012-03-19 01:17:20 +0000
@@ -91,7 +91,7 @@
         # add the new stuff
         self.recommended_for_you_content = FlowableGrid()
         self.add(self.recommended_for_you_content)
-        self.spinner_notebook.show_spinner(_("Receiving recommendations…"))
+        self.spinner_notebook.show_spinner(_(u"Receiving recommendations…"))
         # get the recommendations from the recommender agent
         self.recommended_for_you_cat = RecommendedForYouCategory(
                                             subcategory=self.subcategory)
@@ -136,6 +136,12 @@
                                    ),
         }
 
+    TURN_ON_RECOMMENDATIONS_TEXT = _(u"Turn On Recommendations")
+    RECOMMENDATIONS_OPT_IN_TEXT = _(u"To make recommendations, "
+                 "Ubuntu Software Center "
+                 "will occasionally send to Canonical an anonymous list "
+                 "of software currently installed.")
+
     def __init__(self, catview):
         RecommendationsPanel.__init__(self, catview)
         self.subcategory = None
@@ -156,7 +162,7 @@
         self.add(self.recommended_for_you_content)
 
         # opt in button
-        button = Gtk.Button(_("Turn On Recommendations"))
+        button = Gtk.Button(self.TURN_ON_RECOMMENDATIONS_TEXT)
         button.connect("clicked", self._on_opt_in_button_clicked)
         hbox = Gtk.Box(Gtk.Orientation.HORIZONTAL)
         hbox.pack_start(button, False, False, 0)
@@ -164,15 +170,16 @@
         self.opt_in_button = button  # for tests
 
         # opt in text
-        text = _("To make recommendations, Ubuntu Software Center "
-                 "will occasionally send to Canonical an anonymous list "
-                 "of software currently installed.")
+        text = self.RECOMMENDATIONS_OPT_IN_TEXT
         label = Gtk.Label(text)
         label.set_alignment(0, 0.5)
         label.set_line_wrap(True)
         vbox.pack_start(label, False, False, 0)
 
     def _on_opt_in_button_clicked(self, button):
+        self.opt_in_to_recommendations_service()
+
+    def opt_in_to_recommendations_service(self):
         # we upload the user profile here, and only after this is finished
         # do we fire the request for recommendations and finally display
         # them here -- a spinner is shown for this process (the spec
@@ -180,6 +187,14 @@
         # progress info)
         self._upload_user_profile_and_get_recommendations()
 
+    def opt_out_of_recommendations_service(self):
+        if self.recommended_for_you_content:
+            self.recommended_for_you_content.destroy()
+        self._show_opt_in_view()
+        self.remove_more_button()
+        self.show_all()
+        self.emit("recommendations-opt-out")
+
     def _upload_user_profile_and_get_recommendations(self):
         # initiate upload of the user profile here
         self._upload_user_profile()
@@ -256,18 +271,42 @@
         self.hide()
 
 
+class RecommendationsOptInDialog(Gtk.MessageDialog):
+    """
+    Dialog to display the recommendations opt-in message when opt-in is
+    initiated from the menu.
+    """
+    def __init__(self, icons):
+        Gtk.MessageDialog.__init__(self, flags=Gtk.DialogFlags.MODAL,
+                                   type=Gtk.MessageType.INFO)
+        self.set_title("")
+        icon_name = "softwarecenter"
+        if icons.has_icon(icon_name):
+            icon = Gtk.Image.new_from_icon_name(icon_name,
+                                                Gtk.IconSize.DIALOG)
+            self.set_image(icon)
+            icon.show()
+        self.format_secondary_text(
+                        RecommendationsPanelLobby.RECOMMENDATIONS_OPT_IN_TEXT)
+        self.add_button(Gtk.STOCK_CANCEL, Gtk.ResponseType.CANCEL)
+        self.add_button(RecommendationsPanelLobby.TURN_ON_RECOMMENDATIONS_TEXT,
+                                 Gtk.ResponseType.YES)
+        self.set_default_response(Gtk.ResponseType.YES)
+
+
 # test helpers
-def get_test_window():
+def get_test_window(panel_type="lobby"):
     import softwarecenter.log
     softwarecenter.log.root.setLevel(level=logging.DEBUG)
     fmt = logging.Formatter("%(name)s - %(message)s", None)
     softwarecenter.log.handler.setFormatter(fmt)
 
-    # this is *way* to complicated we should *not* need a CatView
+    # this is *way* too complicated we should *not* need a CatView
     # here! see FIXME in RecommendationsPanel.__init__()
     from softwarecenter.ui.gtk3.views.catview_gtk import CategoriesViewGtk
     from softwarecenter.testutils import (
-        get_test_db, get_test_pkg_info, get_test_gtk3_icon_cache)
+        get_test_db, get_test_pkg_info, get_test_gtk3_icon_cache,
+        get_test_categories)
     cache = get_test_pkg_info()
     db = get_test_db()
     icons = get_test_gtk3_icon_cache()
@@ -277,7 +316,13 @@
                                 db,
                                 icons)
 
-    view = RecommendationsPanelLobby(catview)
+    if panel_type is "lobby":
+        view = RecommendationsPanelLobby(catview)
+    elif panel_type is "category":
+        cats = get_test_categories(db)
+        view = RecommendationsPanelCategory(catview, cats[0])
+    else: # panel_type is "details":
+        view = RecommendationsPanelDetails(catview)
 
     win = Gtk.Window()
     win.connect("destroy", lambda x: Gtk.main_quit())
 
=== modified file 'test/gtk3/test_recommendations_widgets.py'
--- test/gtk3/test_recommendations_widgets.py	2012-03-01 11:29:55 +0000
+++ test/gtk3/test_recommendations_widgets.py	2012-03-19 01:17:20 +0000
@@ -16,8 +16,20 @@
 
 class TestRecommendationsWidgets(unittest.TestCase):
 
-    def test_recommendations_widgets(self):
-        win = get_test_window()
+    def test_recommendations_lobby(self):
+        win = get_test_window(panel_type="lobby")
+        win.show_all()
+        GObject.timeout_add(TIMEOUT, lambda: win.destroy())
+        Gtk.main()
+        
+    def test_recommendations_category(self):
+        win = get_test_window(panel_type="category")
+        win.show_all()
+        GObject.timeout_add(TIMEOUT, lambda: win.destroy())
+        Gtk.main()
+        
+    def test_recommendations_details(self):
+        win = get_test_window(panel_type="details")
         win.show_all()
         GObject.timeout_add(TIMEOUT, lambda: win.destroy())
         Gtk.main()