Merge lp:~jamesh/unity-lens-applications/scope-previews into lp:~unity-team/unity-lens-applications/libunity7-compatible

[James Henstridge]

Add screenshots to local scope previews with information obtained from the software center, escape markup characters in descriptions and don't allow the user to disable the applications scope.

When creating previews for local scopes, look up the package name in the software center index (requires scopes to be included in the app-install data) and then query the data provider for screenshots to include in the preview. This

As the preview() method was getting quite long, I also took the opportunity to split it into the app preview and scope preview cases into their own methods.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:343
http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-ci/11/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-raring-amd64-ci/11

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-lens-applications-libunity7-compatible-ci/11/rebuild

review: Approve (continuous-integration)

[lp:~jamesh/unity-lens-applications/scope-previews]

344. By James Henstridge on 2013-05-01

Escape special characters in the scope description when producing
previews.

345. By James Henstridge on 2013-05-01

Don't include scope description in comment field of search results.

346. By James Henstridge on 2013-05-01

Don't show the enable/disable buttons in the preview of the applications
scope.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:346
http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-ci/13/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-raring-amd64-ci/13/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-lens-applications-libunity7-compatible-ci/13/rebuild

review: Needs Fixing (continuous-integration)

[lp:~jamesh/unity-lens-applications/scope-previews]

347. By James Henstridge on 2013-05-01

Merge from libunity7-compatible, fixing conflict

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:347
http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-ci/14/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-raring-amd64-ci/14

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-lens-applications-libunity7-compatible-ci/14/rebuild

review: Approve (continuous-integration)

[lp:~jamesh/unity-lens-applications/scope-previews]

348. By James Henstridge on 2013-05-01

Also remove the disable action for the home scope.

[Michal Hruby (mhr3)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:348
http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-ci/15/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-lens-applications-libunity7-compatible-raring-amd64-ci/15

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-lens-applications-libunity7-compatible-ci/15/rebuild

review: Approve (continuous-integration)

=== modified file 'src/daemon.vala'
--- src/daemon.vala	2013-04-30 18:46:48 +0000
+++ src/daemon.vala	2013-05-01 19:21:29 +0000
@@ -1080,7 +1080,6 @@
         var uri = @"scope://$(info.desktop_file)";
         var name = info.application_name;
         var icon_hint = info.icon;
-        var comment = info.description;
         var category = info.desktop_file in disabled_scope_ids ?
           Category.AVAILABLE : Category.INSTALLED;
 
@@ -1103,7 +1102,7 @@
                       ResultType.DEFAULT,
                       "application/x-unity-scope",
                       name != "" ? name : uri,
-                      comment,
+                      "",
                       "", // dnd_uri ?!
                       empty_asv);
       }
@@ -1310,282 +1309,340 @@
 
     public Unity.Preview preview (string uri)
     {
-      Unity.ApplicationPreview? preview = null;
-
-      string pkgname = "";
-      string appname = "";
+      Unity.Preview? preview = null;
       bool installed = uri.has_prefix ("application://");
       bool is_scope = uri.has_prefix ("scope://");
 
       if (installed || uri.has_prefix ("unity-install://"))
       {
-        string desktopfile = null;
-        if (installed)
-        {
-          desktopfile = uri.substring (14); //remove "application://" prefix
-
-          // de-mangle desktop file names back to what S-C expects
-          if (sc_mangler.contains (desktopfile))
-          {
-            desktopfile = sc_mangler.get (desktopfile);
-          }
-
-          Unity.Package.PackageInfo pkginfo = pkgsearcher.get_by_desktop_file (desktopfile);
-          if (pkginfo != null)
-          {
-            appname = pkginfo.application_name;
-            pkgname = pkginfo.package_name;
-          }
-        }
-        else // unity-install
-        {
-          string app = uri.substring (16); //remove "unity-install://" prefix
-          string[] parts = app.split ("/");
-          if (parts.length > 1)
-          {
-            pkgname = parts[0];
-            appname = parts[1];
-          }
-        }
-
-        if (pkgname != "")
-        {
+        preview = make_app_preview (uri, installed);
+      }
+      else if (is_scope)
+      {
+        preview = make_scope_preview (uri);
+      }
+      return preview;
+    }
+
+    private SoftwareCenterData.AppDetailsData get_app_details (string appname, string pkgname) throws Error
+    {
+      if (sc_data_provider == null)
+      {
+        sc_data_provider = new SoftwareCenterDataCache (TOP_RATED_ITEMS_CACHE_LIFETIME);
+        sc_data_provider.connect_to ();
+      }
+
+      debug ("Requesting pkg info: %s, %s\n", pkgname, appname);
+      return sc_data_provider.get_app_details (appname, pkgname);
+    }
+
+    private Unity.Preview make_app_preview (string uri, bool installed)
+    {
+      Unity.ApplicationPreview? preview = null;
+      string desktopfile = null;
+      string pkgname = "";
+      string appname = "";
+
+      if (installed)
+      {
+        desktopfile = uri.substring (14); //remove "application://" prefix
+
+        // de-mangle desktop file names back to what S-C expects
+        if (sc_mangler.contains (desktopfile))
+        {
+          desktopfile = sc_mangler.get (desktopfile);
+        }
+
+        Unity.Package.PackageInfo pkginfo = pkgsearcher.get_by_desktop_file (desktopfile);
+        if (pkginfo != null)
+        {
+          appname = pkginfo.application_name;
+          pkgname = pkginfo.package_name;
+        }
+      }
+      else // unity-install
+      {
+        string app = uri.substring (16); //remove "unity-install://" prefix
+        string[] parts = app.split ("/");
+        if (parts.length > 1)
+        {
+          pkgname = parts[0];
+          appname = parts[1];
+        }
+      }
+
+      if (pkgname != "")
+      {
+        try {
+          var details = get_app_details (appname, pkgname);
+
+          Icon? icon = null;
+          if (installed)
+            icon = new GLib.ThemedIcon (details.icon);
+          else
+          {
+            icon = find_pkg_icon (null, details.icon);
+            if (icon.to_string () == GENERIC_APP_ICON && details.icon_url != null && details.icon_url != "")
+            {
+              icon = new GLib.FileIcon (File.new_for_uri (details.icon_url));
+            }
+          }
+
+          Icon? screenshot = null;
+
+          if (details.screenshot != null)
+          {
+            File scr_file = File.new_for_uri (details.screenshot);
+            screenshot = new FileIcon (scr_file);
+          }
+
+          string subtitle = "";
+          if (details.version != "")
+            subtitle = _("Version %s").printf (details.version);
+          if (details.size > 0)
+          {
+            if (subtitle != "")
+              subtitle += ", ";
+            subtitle += ("Size %s").printf (GLib.format_size (details.size));
+          }
+          preview = new Unity.ApplicationPreview (details.name, subtitle, details.description, icon, screenshot);
+          preview.license = details.license;
+
+          init_ratings_db ();
+          if (ratings != null)
+          {
+            Unity.Ratings.Result result;
+            ratings.query (pkgname, out result);
+            preview.set_rating (result.average_rating / 5.0f, result.total_rating);
+          }
+
+          if (details.hardware_requirements != "")
+            preview.add_info (new InfoHint ("hardware-requirements", _("Hardware requirements"), null, details.hardware_requirements));
+
+          if (uri.has_prefix ("unity-install://")) // application needs to be purchased/installed
+          {
+            // uninstalled and not purchased before
+            if (details.pkg_state == SoftwareCenterData.PackageState.NEEDS_PURCHASE)
+            {
+              var buy_action = new Unity.PreviewAction ("buy", _("Buy"), null);
+              if (details.price != null && details.price != "")
+              {
+                buy_action.extra_text = details.price;
+              }
+
+              buy_action.activated.connect (start_software_center);
+              preview.add_action (buy_action);
+            }
+            else // uninstalled, purchased before
+            {
+
+              Unity.PreviewAction install_action = null;
+              if (details.raw_price == null || details.raw_price == "")
+              {
+                install_action = new Unity.PreviewAction ("install", _("Free Download"), null);
+                install_action.activated.connect (app_preview_install);
+              }
+              else
+              {
+                install_action = new Unity.PreviewAction ("install", _("Install"), null);
+                install_action.activated.connect (start_software_center);
+              }
+              preview.add_action (install_action);
+            }
+
+            if (details.website != null && details.website != "")
+            {
+              preview_developer_website = details.website;
+              var website_action = new Unity.PreviewAction ("website", _("Developer Site"), null);
+              website_action.activated.connect (app_preview_website);
+              preview.add_action (website_action);
+            }
+          }
+          else // application is already installed
+          {
+            preview.add_info (new InfoHint ("date-installed", _("Installed on"), null, details.installation_date));
+            var launch_action = new Unity.PreviewAction ("launch", _("Launch"), null);
+            preview.add_action (launch_action);
+            if (!details.is_desktop_dependency)
+            {
+              var uninstall_action = new Unity.PreviewAction ("uninstall", _("Uninstall"), null);
+              uninstall_action.activated.connect (app_preview_uninstall);
+              preview.add_action (uninstall_action);
+            }
+          }
+
+          preview_installable_desktop_file = details.desktop_file;
+          preview_installable_icon_file = details.icon;
+        }
+        catch (Error e)
+        {
+          warning ("Failed to get package details for '%s': %s", uri, e.message);
+          preview = null;
+        }
+      }
+
+      // xapian db doesn't know this .desktop file or S-C dbus data provider fails,
+      // fallback to DesktopAppInfo (based on installed .desktop file) if available
+      if (preview == null && desktopfile != null)
+      {
+        var app_info = new DesktopAppInfo (desktopfile);
+        if (app_info != null)
+        {
+          preview = new Unity.ApplicationPreview (app_info.get_display_name (), "", app_info.get_description () ?? "", app_info.get_icon (), null);
+          var launch_action = new Unity.PreviewAction ("launch", _("Launch"), null);
+          preview.add_action (launch_action);
+        }
+      }
+
+      if (preview == null)
+      {
+        warning ("No pksearcher nor desktop app info for '%s'", uri);
+      }
+      return preview;
+    }
+
+    private Unity.Preview make_scope_preview(string uri)
+    {
+      Unity.ApplicationPreview? preview = null;
+      var scope_id = uri.substring (8);
+      bool scope_disabled = scope_id in disabled_scope_ids;
+
+      // figure out if the scope is remote
+      bool is_remote_scope = false;
+      var info = scopesearcher.get_by_desktop_file (scope_id);
+
+      Dee.ModelIter found_iter = null;
+      if (info == null)
+      {
+        var iter = remote_scopes_model.get_first_iter ();
+        var end_iter = remote_scopes_model.get_last_iter ();
+        while (iter != end_iter)
+        {
+          if (remote_scopes_model.get_string (iter, 0) == scope_id)
+          {
+            is_remote_scope = true;
+            found_iter = iter;
+            break;
+          }
+          iter = remote_scopes_model.next (iter);
+        }
+      }
+
+      if (is_remote_scope)
+      {
+        var name = remote_scopes_model.get_string (found_iter, 1);
+        if (name == null || name == "")
+          name = remote_scopes_model.get_string (found_iter, 0);
+        var description = remote_scopes_model.get_string (found_iter, 2);
+        if (description != null)
+          description = Markup.escape_text(description);
+        Icon? icon = null;
+        Icon? screenshot = null;
+        var icon_hint = remote_scopes_model.get_string (found_iter, 3);
+        var screenshot_url = remote_scopes_model.get_string (found_iter, 4);
+        try
+        {
+          if (icon_hint != "") icon = Icon.new_for_string (icon_hint);
+          if (screenshot_url != "") screenshot = Icon.new_for_string (screenshot_url);
+        }
+        catch (Error err)
+        {
+          warning ("%s", err.message);
+        }
+
+        if (icon == null) icon = get_default_scope_icon ();
+
+        preview = new Unity.ApplicationPreview (name,
+                                                "",
+                                                description,
+                                                icon,
+                                                screenshot);
+      }
+      else if (info != null)
+      {
+        var name = info.application_name;
+        if (name == null || name == "")
+          name = info.desktop_file;
+        var subtitle = "";
+        var description = info.description;
+        if (description != null)
+          description = Markup.escape_text(description);
+        Icon? icon = null;
+        Icon? screenshot = null;
+        try
+        {
+          if (info.icon != null && info.icon != "")
+            icon = Icon.new_for_string (info.icon);
+        }
+        catch (Error err)
+        {
+          warning ("%s", err.message);
+        }
+        if (icon == null)
+          icon = get_default_scope_icon ();
+
+        // de-mangle desktop file names back to what S-C expects
+        string mangled_id;
+        if (sc_mangler.contains (scope_id))
+        {
+          mangled_id = sc_mangler.get (scope_id);
+        }
+        else
+        {
+          mangled_id = scope_id;
+        }
+
+        Unity.Package.PackageInfo pkginfo = pkgsearcher.get_by_desktop_file (mangled_id);
+        if (pkginfo != null)
+        {
+          SoftwareCenterData.AppDetailsData? details;
           try {
-            if (sc_data_provider == null)
-            {
-              sc_data_provider = new SoftwareCenterDataCache (TOP_RATED_ITEMS_CACHE_LIFETIME);
-              sc_data_provider.connect_to ();
-            }
-
-            debug ("Requesting pkg info: %s, %s\n", pkgname, appname);
-            var details = sc_data_provider.get_app_details (appname, pkgname);
-
-            Icon? icon = null;
-            if (installed)
-              icon = new GLib.ThemedIcon (details.icon);
-            else
-            {
-              icon = find_pkg_icon (null, details.icon);
-              if (icon.to_string () == GENERIC_APP_ICON && details.icon_url != null && details.icon_url != "")
-              {
-                icon = new GLib.FileIcon (File.new_for_uri (details.icon_url));
-              }
-            }
-
-            Icon? screenshot = null;
-
+            details = get_app_details(pkginfo.application_name,
+                                      pkginfo.package_name);
+          } catch (Error e) {
+            details = null;
+          }
+          if (details != null) {
+            if (details.version != "")
+              subtitle = _("Version %s").printf (details.version);
             if (details.screenshot != null)
             {
               File scr_file = File.new_for_uri (details.screenshot);
               screenshot = new FileIcon (scr_file);
             }
-
-            string subtitle = "";
-            if (details.version != "")
-              subtitle = _("Version %s").printf (details.version);
-            if (details.size > 0)
-            {
-              if (subtitle != "")
-                subtitle += ", ";
-              subtitle += ("Size %s").printf (GLib.format_size (details.size));
-            }
-            preview = new Unity.ApplicationPreview (details.name, subtitle, details.description, icon, screenshot);
-            preview.license = details.license;
-
-            init_ratings_db ();
-            if (ratings != null)
-            {
-              Unity.Ratings.Result result;
-              ratings.query (pkgname, out result);
-              preview.set_rating (result.average_rating / 5.0f, result.total_rating);
-            }
-
-            if (details.hardware_requirements != "")
-              preview.add_info (new InfoHint ("hardware-requirements", _("Hardware requirements"), null, details.hardware_requirements));
-
-            if (uri.has_prefix ("unity-install://")) // application needs to be purchased/installed
-            {
-              // uninstalled and not purchased before
-              if (details.pkg_state == SoftwareCenterData.PackageState.NEEDS_PURCHASE)
-              {
-                var buy_action = new Unity.PreviewAction ("buy", _("Buy"), null);
-                if (details.price != null && details.price != "")
-                {
-                  buy_action.extra_text = details.price;
-                }
-
-                buy_action.activated.connect (start_software_center);
-                preview.add_action (buy_action);
-              }
-              else // uninstalled, purchased before
-              {
-
-                Unity.PreviewAction install_action = null;
-                if (details.raw_price == null || details.raw_price == "")
-                {
-                  install_action = new Unity.PreviewAction ("install", _("Free Download"), null);
-                  install_action.activated.connect (app_preview_install);
-                }
-                else
-                {
-                  install_action = new Unity.PreviewAction ("install", _("Install"), null);
-                  install_action.activated.connect (start_software_center);
-                }
-                preview.add_action (install_action);
-              }
-
-              if (details.website != null && details.website != "")
-              {
-                preview_developer_website = details.website;
-                var website_action = new Unity.PreviewAction ("website", _("Developer Site"), null);
-                website_action.activated.connect (app_preview_website);
-                preview.add_action (website_action);
-              }
-            }
-            else // application is already installed
-            {
-              preview.add_info (new InfoHint ("date-installed", _("Installed on"), null, details.installation_date));
-              var launch_action = new Unity.PreviewAction ("launch", _("Launch"), null);
-              preview.add_action (launch_action);
-              if (!details.is_desktop_dependency)
-              {
-                var uninstall_action = new Unity.PreviewAction ("uninstall", _("Uninstall"), null);
-                uninstall_action.activated.connect (app_preview_uninstall);
-                preview.add_action (uninstall_action);
-              }
-            }
-
-            preview_installable_desktop_file = details.desktop_file;
-            preview_installable_icon_file = details.icon;
-          }
-          catch (Error e)
-          {
-            warning ("Failed to get package details for '%s': %s", uri, e.message);
-            preview = null;
-          }
-        }
-
-        // xapian db doesn't know this .desktop file or S-C dbus data provider fails,
-        // fallback to DesktopAppInfo (based on installed .desktop file) if available
-        if (preview == null && desktopfile != null)
-        {
-          var app_info = new DesktopAppInfo (desktopfile);
-          if (app_info != null)
-          {
-            preview = new Unity.ApplicationPreview (app_info.get_display_name (), "", app_info.get_description () ?? "", app_info.get_icon (), null);
-            var launch_action = new Unity.PreviewAction ("launch", _("Launch"), null);
-            preview.add_action (launch_action);
-          }
-        }
-
-        if (preview == null)
-        {
-          warning ("No pksearcher nor desktop app info for '%s'", uri);
-        }
+          }
+        }
+
+        preview = new Unity.ApplicationPreview (name,
+                                                subtitle,
+                                                description,
+                                                icon,
+                                                screenshot);
       }
-      else if (is_scope)
+      if (preview != null && scope_id != "home.scope" &&
+          scope_id != "applications.scope")
       {
-        var scope_id = uri.substring (8);
-        bool scope_disabled = scope_id in disabled_scope_ids;
-
-        // figure out if the scope is remote
-        bool is_remote_scope = false;
-        var info = scopesearcher.get_by_desktop_file (scope_id);
-
-        Dee.ModelIter found_iter = null;
-        if (info == null)
-        {
-          var iter = remote_scopes_model.get_first_iter ();
-          var end_iter = remote_scopes_model.get_last_iter ();
-          while (iter != end_iter)
-          {
-            if (remote_scopes_model.get_string (iter, 0) == scope_id)
-            {
-              is_remote_scope = true;
-              found_iter = iter;
-              break;
-            }
-            iter = remote_scopes_model.next (iter);
-          }
-        }
-
-        if (is_remote_scope)
-        {
-          var name = remote_scopes_model.get_string (found_iter, 1);
-          if (name == null || name == "")
-            name = remote_scopes_model.get_string (found_iter, 0);
-          var description = remote_scopes_model.get_string (found_iter, 2);
-          Icon? icon = null;
-          Icon? screenshot = null;
-          var icon_hint = remote_scopes_model.get_string (found_iter, 3);
-          var screenshot_url = remote_scopes_model.get_string (found_iter, 4);
-          try
-          {
-            if (icon_hint != "") icon = Icon.new_for_string (icon_hint);
-            if (screenshot_url != "") screenshot = Icon.new_for_string (screenshot_url);
-          }
-          catch (Error err)
-          {
-            warning ("%s", err.message);
-          }
-
-          if (icon == null) icon = get_default_scope_icon ();
-
-          preview = new Unity.ApplicationPreview (name,
-                                                  "",
-                                                  description,
-                                                  icon,
-                                                  screenshot);
-        }
-        else if (info != null)
-        {
-          var name = info.application_name;
-          if (name == null || name == "")
-            name = info.desktop_file;
-          // XXX: add this to package info.
-          var description = info.description;
-          Icon? icon = null;
-          try
-          {
-            if (info.icon != null && info.icon != "")
-              icon = Icon.new_for_string (info.icon);
-          }
-          catch (Error err)
-          {
-            warning ("%s", err.message);
-          }
-          if (icon == null)
-            icon = get_default_scope_icon ();
-
-          preview = new Unity.ApplicationPreview (name,
-                                                  "",
-                                                  description,
-                                                  icon,
-                                                  null);
-        }
-        if (preview != null) {
-          PreviewAction action;
-          preview.set_rating(-1.0f, 0);
-          if (scope_disabled)
-          {
-            action = new Unity.PreviewAction ("enable-scope", _("Enable"), null);
-            action.activated.connect (() =>
+        PreviewAction action;
+        preview.set_rating(-1.0f, 0);
+        if (scope_disabled)
+        {
+          action = new Unity.PreviewAction ("enable-scope", _("Enable"), null);
+          action.activated.connect (() =>
             {
               enable_scope (scope_id);
               return new ActivationResponse.with_preview (this.preview (uri));
             });
-          }
-          else
-          {
-            action = new Unity.PreviewAction ("disable-scope", _("Disable"), null);
-            action.activated.connect (() =>
+        }
+        else
+        {
+          action = new Unity.PreviewAction ("disable-scope", _("Disable"), null);
+          action.activated.connect (() =>
             {
               disable_scope (scope_id);
               return new ActivationResponse.with_preview (this.preview (uri));
             });
-          }
-          preview.add_action (action);
         }
+        preview.add_action (action);
       }
       return preview;
     }