Merge lp:~stolowski/unity-lens-applications/show-more-apps-on-no-query into lp:unity-lens-applications

[Paweł Stołowski]

List 10 'What's new' apps and the 12 'Top Rated' apps from Software Center in 'Apps Available for Download' before user performs any search if no filters are active.

List 100 top rated apps according to active filters if search string is empty.

List 10 'What's new' apps and the 12 'Top Rated' apps from Software Center in 'Apps Available for Download' before user performs any search if no filters are active.

List 100 top rated apps according to active filters if search string is empty.

WARNING! Don't approve until Software Center changes are merged.

[lp:~stolowski/unity-lens-applications/show-more-apps-on-no-query]

300. By Paweł Stołowski on 2012-09-12

Updated comment.

[Michal Hruby (mhr3)]

93 + var whats_new = sc_data_provider.get_items_for_category ("What’s New"); //make sure there is unicode char U+2019 (right quotation mark)

Very nasty that we need to pass an exact unicode string, imo the service should be fixed.

[Michal Hruby (mhr3)]

465 +typedef int (*AppFilterCallback)(UnityPackageInfo *, void *);

Shouldn't this return a gboolean instead? Or an enum perhaps? It's not obvious what the callback should be returning.

[lp:~stolowski/unity-lens-applications/show-more-apps-on-no-query]

301. By Paweł Stołowski on 2012-09-12

Make filtering callback use bool return value.

302. By Paweł Stołowski on 2012-09-17

Use 'unity-whats-new' and 'unity-top-rated' categories instead of 'What's new' (requiring utf)
and 'Top Rated'. Requires lp:~mvo/software-center/extra-unity-categories.

[Paweł Stołowski (stolowski)]

Software Center has been fixed to provide unity-whats-new and unity-top-rated categories instead. Updated the code. Ready for re-review.

[Neil J. Patel (njpatel)]

Hi, this is approved pending that we can get the Software Centre bits landed for b2.

DO NOT APPROVE THIS UNTIL THEN.

review: Approve

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2012-08-08 16:30:35 +0000
+++ src/Makefile.am	2012-09-17 15:59:25 +0000
@@ -61,6 +61,7 @@
   utils.vala \
   aptd-client.vala \
   software-center-data-provider.vala \
+  software-center-data-cache.vala \
   $(NULL)
 
 unity-package-search.o : $(srcdir)/unity-package-search.cc $(srcdir)/unity-package-search.h

=== modified file 'src/daemon.vala'
--- src/daemon.vala	2012-09-13 17:12:02 +0000
+++ src/daemon.vala	2012-09-17 15:59:25 +0000
@@ -26,6 +26,20 @@
 
 namespace Unity.ApplicationsLens {
 
+  /* Number of 'Apps available for download' to show if no search query is provided AND a filter is active. 
+     It shouldn't be too high as this may impact lens performance.
+   */
+  const uint MAX_APP_FOR_DOWNLOAD_FOR_EMPTY_QUERY = 100;
+
+  /* Number of top rated apps to show in 'Apps available for download' if no search query is provided AND NO filter is active. */
+  const uint MAX_TOP_RATED_APPS_FOR_EMPTY_QUERY = 12;
+
+  /* Number of "What's new" apps to show in 'Apps available for download' if no search query is provided AND NO filter is active. */
+  const uint MAX_WHATS_NEW_APPS_FOR_EMPTY_QUERY = 10;
+
+  /* Time between queries to SoftwareCenterDataProvider */
+  const int64 TOP_RATED_ITEMS_CACHE_LIFETIME = 24*3600; // 24 hours
+
   const string ICON_PATH = Config.DATADIR + "/icons/unity-icon-theme/places/svg/";
   const string ICON_APP_INSTALL_PATH = Config.DATADIR + "/app-install/icons";
 
@@ -462,6 +476,14 @@
       }
     }
 
+    /* Returns TRUE if application is NOT installed */
+    public bool filter_cb (Unity.Package.PackageInfo pkginfo)
+    {
+      var appmanager = AppInfoManager.get_default();
+      AppInfo? app = appmanager.lookup (pkginfo.desktop_file);
+      return app == null;
+    }
+
     private async void update_scope_search (Unity.LensSearch search,
                                             Cancellable cancellable)
     {
@@ -475,6 +497,7 @@
 
       string pkg_search_string = prepare_pkg_search_string (search, filter);
 
+      bool has_filter = (filter != null && filter.filtering);
       bool has_search = !Utils.is_search_empty (search);
 
       Timer timer = new Timer ();
@@ -556,16 +579,43 @@
           debug ("Entry search listed %i Available apps in %fms for query: %s",
                  pkgresults.num_hits, timer.elapsed ()*1000, pkg_search_string);
         }
-        else
+        else if (has_filter) /* Empty search string + active filters should get lots of results from selected categories */
         {
           timer.start ();
           string? filter_query = prepare_pkg_search_string (search, filter);
-          var random_pkgresults = pkgsearcher.get_random_apps (filter_query, 12);
-          add_pkg_search_result (random_pkgresults, installed_uris, available_uris,
-                                 model, Category.AVAILABLE, 6);
-          timer.stop ();
-          debug ("Entry search listed %i random Available apps in %fms",
-                 random_pkgresults.num_hits, timer.elapsed ()*1000);
+
+          var pkgresults = pkgsearcher.get_apps (filter_query, MAX_APP_FOR_DOWNLOAD_FOR_EMPTY_QUERY, filter_cb);
+          add_pkg_search_result (pkgresults, installed_uris, available_uris, model, Category.AVAILABLE, MAX_APP_FOR_DOWNLOAD_FOR_EMPTY_QUERY);
+          timer.stop ();
+          debug ("Entry search listed %i Available apps in %fms",
+                 pkgresults.num_hits, timer.elapsed ()*1000);
+        }
+        else
+        {
+          timer.start ();
+
+          uint hits = 0;
+          try
+          {
+            Set<string> duplicates_lookup = new HashSet<string> ();
+            
+            if (sc_data_provider == null)
+              sc_data_provider = new SoftwareCenterDataCache (TOP_RATED_ITEMS_CACHE_LIFETIME);
+
+            var whats_new = sc_data_provider.get_items_for_category ("unity-whats-new");
+            hits = add_sc_category_results (whats_new, model, Category.AVAILABLE, ref duplicates_lookup, MAX_WHATS_NEW_APPS_FOR_EMPTY_QUERY);
+
+            var top_rated = sc_data_provider.get_items_for_category ("unity-top-rated");
+            hits += add_sc_category_results (top_rated, model, Category.AVAILABLE, ref duplicates_lookup, MAX_TOP_RATED_APPS_FOR_EMPTY_QUERY);
+          }
+          catch (GLib.Error e)
+          {
+            warning ("Failed to get top rated apps: %s", e.message);
+          }
+
+          timer.stop ();
+          debug ("Entry search listed %u top rated/new available apps in %fms",
+                 hits, timer.elapsed ()*1000);
         }
       }
 
@@ -749,25 +799,25 @@
       return default_icon.to_string ();
     }
 
-    public Icon find_pkg_icon (Unity.Package.PackageInfo pkginfo)
+    public Icon find_pkg_icon (string desktop_file, string icon_name)
     {
-      string desktop_id = Path.get_basename (pkginfo.desktop_file);
+      string desktop_id = Path.get_basename (desktop_file);
       bool installed = AppInfoManager.get_default().lookup (desktop_id) != null;
 
       /* If the app is already installed we should be able to pull the
        * icon from the theme */
       if (installed)
-        return new ThemedIcon (pkginfo.icon);
+        return new ThemedIcon (icon_name);
 
       /* App is not installed - we need to find the right icon in the bowels
        * of the software center */
-      if (pkginfo.icon.has_prefix ("/"))
+      if (icon_name.has_prefix ("/"))
       {
-        return new FileIcon (File.new_for_path (pkginfo.icon));
+        return new FileIcon (File.new_for_path (icon_name));
       }
       else
       {
-        Icon icon = file_icon_cache.lookup (pkginfo.icon);
+        Icon icon = file_icon_cache.lookup (icon_name);
 
         if (icon != null)
           return icon;
@@ -775,24 +825,24 @@
         /* If the icon name contains a . it probably already have a
          * type postfix - so test icon name directly */
         string path;
-        if ("." in pkginfo.icon)
+        if ("." in icon_name)
         {
-          path = @"$(Config.DATADIR)/app-install/icons/$(pkginfo.icon)";
+          path = @"$(Config.DATADIR)/app-install/icons/$(icon_name)";
           if (FileUtils.test (path, FileTest.EXISTS))
           {
             icon = new FileIcon (File.new_for_path (path));
-            file_icon_cache.insert (pkginfo.icon, icon);
+            file_icon_cache.insert (icon_name, icon);
             return icon;
           }
           /* Try also software center cache dir */
           path = Path.build_filename (Environment.get_user_cache_dir (),
                                       "software-center",
                                       "icons",
-                                      pkginfo.icon);
+                                      icon_name);
           if (FileUtils.test (path, FileTest.EXISTS))
           {
             icon = new FileIcon (File.new_for_path (path));
-            file_icon_cache.insert (pkginfo.icon, icon);
+            file_icon_cache.insert (icon_name, icon);
             return icon;
           }
         }
@@ -800,12 +850,12 @@
         /* Now try appending all the image extensions we know */
         foreach (var ext in image_extensions)
         {
-          path = @"$(Config.DATADIR)/app-install/icons/$(pkginfo.icon).$(ext)";
+          path = @"$(Config.DATADIR)/app-install/icons/$(icon_name).$(ext)";
           if (FileUtils.test (path, FileTest.EXISTS))
           {
             /* Got it! Cache the icon path and return the icon */
             icon = new FileIcon (File.new_for_path (path));
-            file_icon_cache.insert (pkginfo.icon, icon);
+            file_icon_cache.insert (icon_name, icon);
             return icon;
           }
         }
@@ -813,7 +863,7 @@
 
       /* Cache the fact that we couldn't find this icon */
       var icon = new ThemedIcon ("applications-other");
-      file_icon_cache.insert (pkginfo.icon, icon);
+      file_icon_cache.insert (icon_name, icon);
 
       return icon;
     }
@@ -880,6 +930,41 @@
       return GLib.Path.get_basename (name);
     }
 
+    /**
+     * Add all results obtained from SoftwareCenterDataProvider
+     */
+    private uint add_sc_category_results (SoftwareCenterDataProviderService.AppInfo?[] results, 
+                                          Dee.Model model,
+                                          Category category,
+                                          ref Set<string> duplicates_lookup,
+                                          uint max_results)
+    {
+      uint i = 0;
+      foreach (SoftwareCenterDataProviderService.AppInfo app in results)
+      {
+        string uri = @"unity-install://$(app.package_name)/$(app.application_name)";
+
+        if (uri in duplicates_lookup)
+        {
+          continue;
+        }
+
+        Icon icon = find_pkg_icon (app.desktop_file, app.icon);
+
+        model.append (uri, icon.to_string (),
+                      category, 
+                      "application/x-desktop",
+                      app.application_name,
+                      "", //comment 
+                      "file://" + app.desktop_file);
+        duplicates_lookup.add (uri);
+        i++;
+        if (i == max_results)
+          break;
+      }
+      return i;
+    }
+
     private void add_pkg_search_result (Unity.Package.SearchResult results,
                                         Set<string> installed_uris,
                                         Set<string> available_uris,
@@ -953,7 +1038,7 @@
           available_uris.add (uri);            
         }
 
-        Icon icon = find_pkg_icon (pkginfo);
+        Icon icon = find_pkg_icon (pkginfo.desktop_file, pkginfo.icon);
 
         model.append (uri, icon.to_string (),
                       category,"application/x-desktop",
@@ -1159,7 +1244,7 @@
           try {
             if (sc_data_provider == null)
             {
-              sc_data_provider = new SoftwareCenterDataProviderProxy ();
+              sc_data_provider = new SoftwareCenterDataCache (TOP_RATED_ITEMS_CACHE_LIFETIME);
               sc_data_provider.connect_to ();
             }
 

=== modified file 'src/runner.vala'
--- src/runner.vala	2012-08-14 14:32:55 +0000
+++ src/runner.vala	2012-09-17 15:59:25 +0000
@@ -415,7 +415,7 @@
           continue;
         
         // pick the first one
-        icon = this.daemon.find_pkg_icon (pkginfo);
+        icon = this.daemon.find_pkg_icon (pkginfo.desktop_file, pkginfo.icon);
         return exec_string;
         
       }

=== added file 'src/software-center-data-cache.vala'
--- src/software-center-data-cache.vala	1970-01-01 00:00:00 +0000
+++ src/software-center-data-cache.vala	2012-09-17 15:59:25 +0000
@@ -0,0 +1,71 @@
+/*
+ * Copyright (C) 2012 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Pawel Stolowski <[e-mail]>
+ */
+
+namespace Unity.ApplicationsLens {
+
+public class SoftwareCenterDataCache: SoftwareCenterDataProviderProxy
+{
+  public int64 category_items_lifetime { get; set; }
+  private HashTable<string, int64?> category_items_last_update;
+  private HashTable<string, Gee.ArrayList<SoftwareCenterDataProviderService.AppInfo?>> category_items_cached;
+
+  public SoftwareCenterDataCache (int64 category_items_lifetime)
+  {
+    category_items_last_update = new HashTable<string, int64?> (str_hash, str_equal);
+    category_items_cached = new HashTable<string, Gee.ArrayList<SoftwareCenterDataProviderService.AppInfo?>> (str_hash, str_equal);
+    this.category_items_lifetime = category_items_lifetime;
+  }
+
+  internal static bool outdated (ref int64 last_update, int64 lifetime)
+  {
+    var current_time = new GLib.DateTime.now_utc ();
+    int64 current_unix_time = current_time.to_unix ();
+    if (current_unix_time > last_update + lifetime)
+    {
+      last_update = current_unix_time;
+      return true;
+    }
+    return false;
+  }
+
+  public override SoftwareCenterDataProviderService.AppInfo?[] get_items_for_category (string category_name) throws Error
+  {
+    int64 last_update = 0;
+    if (category_items_last_update.contains (category_name))
+    {
+      last_update = category_items_last_update[category_name];
+    }
+
+    if (outdated (ref last_update, category_items_lifetime))
+    {
+      category_items_last_update[category_name] = last_update;
+
+      var data = base.get_items_for_category (category_name);
+      var results = new Gee.ArrayList<SoftwareCenterDataProviderService.AppInfo?> ();
+      foreach (var item in data)
+      {
+        results.add (item);
+      }
+      category_items_cached[category_name] = results;
+      return data;
+    }
+    return category_items_cached[category_name].to_array ();
+  }
+}
+
+}
\ No newline at end of file

=== modified file 'src/software-center-data-provider.vala'
--- src/software-center-data-provider.vala	2012-09-06 08:11:17 +0000
+++ src/software-center-data-provider.vala	2012-09-17 15:59:25 +0000
@@ -24,7 +24,18 @@
   [DBus (name = "com.ubuntu.SoftwareCenterDataProvider")]
   public interface SoftwareCenterDataProviderService: GLib.Object
   {
+    public struct AppInfo
+    {
+      string application_name;
+      string package_name;
+      string icon;
+      string desktop_file;
+    }
+
     public abstract HashTable<string, Variant> get_app_details (string appname, string pkgname) throws Error;
+    public abstract string[] get_available_categories () throws Error;
+    public abstract string[] get_available_subcategories () throws Error;
+    public abstract AppInfo?[] get_items_for_category (string category_name) throws Error;
   }
   
   public class SoftwareCenterDataProviderProxy: GLib.Object
@@ -125,6 +136,15 @@
       return data;
     }
 
+    public virtual SoftwareCenterDataProviderService.AppInfo?[] get_items_for_category (string category_name) throws Error
+    {
+      if (_service == null)
+        connect_to ();
+
+      SoftwareCenterDataProviderService.AppInfo?[] data = _service.get_items_for_category (category_name);
+      return data;
+    }
+
     private SoftwareCenterDataProviderService _service;
   }
 }

=== modified file 'src/unity-package-search.cc'
--- src/unity-package-search.cc	2012-08-08 16:57:47 +0000
+++ src/unity-package-search.cc	2012-09-17 15:59:25 +0000
@@ -475,6 +475,68 @@
   return result;
 }
 
+/**
+ * Get applications matching given xapian filter query and additionally filter results out
+ * using AppFilterCallback, until n_apps matching apps are found.
+ * Results are filtered out if AppFilterCallback returns FALSE.
+ */
+UnityPackageSearchResult* unity_package_searcher_get_apps (UnityPackageSearcher *searcher,
+                                                           const gchar          *filter_query,
+                                                           guint                 n_apps,
+                                                           AppFilterCallback    cb,
+                                                           gpointer data)
+{
+  UnityPackageSearchResult *result;
+  GHashTable               *unique;
+  guint num_matches = 0;
+
+  g_return_val_if_fail (searcher != NULL, NULL);
+
+  unique = g_hash_table_new (g_str_hash, g_str_equal);
+
+  result = g_slice_new0 (UnityPackageSearchResult);
+
+  g_debug ("FILTER %s", filter_query);
+
+  Xapian::Query query;
+  try
+  {
+    query = searcher->query_parser->parse_query (filter_query, QUERY_PARSER_FILTER_FLAGS);
+    searcher->enquire->set_sort_by_relevance ();
+    searcher->enquire->set_query(query);
+
+    Xapian::MSet matches = searcher->enquire->get_mset(0, searcher->db->get_doccount ());
+    Xapian::MSetIterator iter = matches.begin();
+    while (num_matches < n_apps && iter != matches.end())
+    {
+      Xapian::Document doc = iter.get_document ();
+      UnityPackageInfo *pkginfo = _pkginfo_from_document (doc);
+
+      if (g_hash_table_lookup_extended (unique, pkginfo->package_name, NULL, NULL) || cb(pkginfo, data) == FALSE)
+      {
+        _free_package_info (pkginfo);
+      }
+      else
+      {
+        g_hash_table_insert (unique, pkginfo->package_name, NULL);
+        result->results = g_slist_prepend (result->results, pkginfo);
+        num_matches++;
+      }
+      ++iter;
+    }
+  }
+  catch (Xapian::Error e)
+  {
+    g_debug ("Error getting apps for query '%s': %s", filter_query, e.get_msg().c_str());
+    return g_slice_new0 (UnityPackageSearchResult);
+  }
+
+  g_hash_table_unref (unique);
+
+  result->num_hits = num_matches;
+  return result;
+}
+
 UnityPackageSearchResult*
 unity_package_searcher_get_random_apps (UnityPackageSearcher *searcher,
                                         const gchar          *filter_query,

=== modified file 'src/unity-package-search.h'
--- src/unity-package-search.h	2012-07-26 14:07:49 +0000
+++ src/unity-package-search.h	2012-09-17 15:59:25 +0000
@@ -49,9 +49,12 @@
         gint      relevancy;
 } UnityPackageInfo;
 
+typedef gboolean (*AppFilterCallback)(UnityPackageInfo *, void *);
+
 #ifdef __cplusplus
 extern "C" {
 #endif
+   
 
 UnityPackageSearcher*     unity_package_searcher_new    ();
 
@@ -69,6 +72,12 @@
                                                                   const gchar          *filter_query,
                                                                   guint                 n_apps);
 
+UnityPackageSearchResult* unity_package_searcher_get_apps (UnityPackageSearcher *searcher,
+                                                           const gchar          *filter_query,
+                                                           guint                 n_apps,
+                                                           AppFilterCallback    cb,
+                                                           gpointer data);
+
 void                      unity_package_search_result_free (UnityPackageSearchResult *result);
 
 void                      unity_package_package_info_free (UnityPackageInfo *pkginfo);

=== modified file 'vapi/unity-package-search.vapi'
--- vapi/unity-package-search.vapi	2012-08-08 13:52:11 +0000
+++ vapi/unity-package-search.vapi	2012-09-17 15:59:25 +0000
@@ -18,6 +18,8 @@
       BY_RELEVANCY
     }
     
+    public delegate bool AppFilterCallback (PackageInfo pkginfo);
+
     [Compact]
     [CCode (free_function = "unity_package_searcher_free", cheader_filename = "unity-package-search.h")]
     public class Searcher {
@@ -27,6 +29,7 @@
       public Searcher.for_menu(GMenu.Tree menu);
       public SearchResult search (string search_string, uint max_hits, Unity.Package.SearchType search_type, Unity.Package.Sort sort);
       public SearchResult get_random_apps (string? filter_query, uint n_apps);
+      public SearchResult get_apps (string? filter_query, uint n_apps, AppFilterCallback cb);
       public PackageInfo? get_by_desktop_file (string desktop_file);
     }