Merge lp:~mhr3/unity-lens-applications/no-recent-apps-search-just-filtering into lp:unity-lens-applications

[Michal Hruby]

Don't search in recent apps, just filter them when searching.

According to design, the Recent Apps category is not supposed to do any search, it's a given set of 6 applications you used recently and searching can only filter any of these applications away.

[Michal Hruby (mhr3)]

Sorry for the bigger diff - the change actually isn't as big, there's some whitespace changes plus a bit of moving code around.

[lp:~mhr3/unity-lens-applications/no-recent-apps-search-just-filtering]

278. By Michal Hruby on 2012-03-15

Add semi-automatic test

[Neil J. Patel (njpatel)]

Looks good

review: Approve

=== modified file 'src/daemon.vala'
--- src/daemon.vala	2012-03-12 15:41:00 +0000
+++ src/daemon.vala	2012-03-15 12:14:19 +0000
@@ -384,10 +384,10 @@
       scope.queue_search_changed (SearchType.GLOBAL);
     }
 
-    private string prepare_zg_search_string (Unity.LensSearch search,
+    private string prepare_zg_search_string (string search_string,
                                              OptionsFilter? options)
     {
-      string s = search.search_string.strip ();
+      string s = search_string.strip ();
       
       if (!s.has_suffix ("*") && s != "")
         s = s + "*";
@@ -455,8 +455,6 @@
       
       Timer timer = new Timer ();
 
-      var zg_search_string = prepare_zg_search_string (search, filter);
-
       var transaction = new Dee.Transaction (model);
       transaction.clear ();
 
@@ -465,35 +463,6 @@
        * the Installed category too soon and this will cause flicker
        * in the Dash. (lp:868192) */
 
-      if (local_apps_active () && display_recent_apps) {
-        try {
-          var results = yield zg_index.search (zg_search_string,
-                                               new Zeitgeist.TimeRange.anytime(),
-                                               zg_templates,
-                                               0,
-                                               20,
-                                               Zeitgeist.ResultType.MOST_RECENT_SUBJECTS,
-                                               cancellable);
-
-          append_events_with_category (results, transaction, Category.RECENT, has_search);
-
-          timer.stop ();
-          debug ("Entry search found %u/%u Recently Used apps in %fms for query '%s'",
-                 results.size (), results.estimated_matches (),
-                 timer.elapsed()*1000, zg_search_string);
-
-        } catch (IOError.CANCELLED ioe) {
-          // no need to bother
-          return;
-        } catch (GLib.Error e) {
-          warning ("Error performing search '%s': %s",
-                   search.search_string, e.message);
-        }
-      }
-
-      transaction.commit ();
-
-      timer.start ();
       Set<string> installed_uris = new HashSet<string> ();
       Set<string> available_uris = new HashSet<string> ();
       var appresults = appsearcher.search (pkg_search_string, 0,
@@ -504,13 +473,50 @@
       if (local_apps_active ())
       {
         add_pkg_search_result (appresults, installed_uris, available_uris,
-                               model, Category.INSTALLED);
+                               transaction, Category.INSTALLED);
       }
 
       timer.stop ();
       debug ("Entry search listed %i Installed apps in %fms for query: %s",
              appresults.num_hits, timer.elapsed ()*1000, pkg_search_string);
 
+      if (local_apps_active () && display_recent_apps)
+      {
+        try
+        {
+          timer.start ();
+          /* Ignore the search string, we want to keep displaying the same apps
+           * in the recent category and just filter out those that don't match
+           * the search query */
+          var zg_search_string = prepare_zg_search_string ("", filter);
+
+          var results = yield zg_index.search (zg_search_string,
+                                               new Zeitgeist.TimeRange.anytime(),
+                                               zg_templates,
+                                               0,
+                                               20,
+                                               Zeitgeist.ResultType.MOST_RECENT_SUBJECTS,
+                                               cancellable);
+
+          append_events_with_category (results, transaction, Category.RECENT,
+                                       false, 6, installed_uris);
+
+          timer.stop ();
+          debug ("Entry search found %u/%u Recently Used apps in %fms for query '%s'",
+                 results.size (), results.estimated_matches (),
+                 timer.elapsed()*1000, zg_search_string);
+
+        } catch (IOError.CANCELLED ioe) {
+          // no need to bother
+          return;
+        } catch (GLib.Error e) {
+          warning ("Error performing search '%s': %s",
+                   search.search_string, e.message);
+        }
+      }
+
+      transaction.commit ();
+
       /* If we don't have a search we display 6 random apps */
       if (usc_apps_active () && display_available_apps && pkgsearcher != null)
       {
@@ -598,10 +604,13 @@
       
       Timer timer = new Timer ();
 
-      var zg_search_string = prepare_zg_search_string (search, null);
+      if (local_apps_active () && display_recent_apps)
+      {
+        try
+        {
+          var zg_search_string = prepare_zg_search_string (search.search_string,
+                                                           null);
 
-      if (local_apps_active () && display_recent_apps) {
-        try {
           var results = yield zg_index.search (zg_search_string,
                                                new Zeitgeist.TimeRange.anytime(),
                                                zg_templates,
@@ -611,7 +620,8 @@
                                                cancellable);
 
           model.clear ();
-          append_events_with_category (results, model, Category.RECENT_APPS, false);
+          append_events_with_category (results, model, Category.RECENT_APPS,
+                                       false);
 
           timer.stop ();
           debug ("Entry search found %u/%u Recently Used apps in %fms for query '%s'",
@@ -997,46 +1007,62 @@
     public void append_events_with_category (Zeitgeist.ResultSet events,
                                              Dee.Model results,
                                              uint category_id,
-                                             bool include_favorites)
+                                             bool include_favorites,
+                                             int max_results = int.MAX,
+                                             Set<string>? allowed_uris = null)
     {
+      int num_results = 0;
       foreach (var ev in events)
+      {
+        string? app_uri = null;
+        if (ev.num_subjects () > 0)
+          app_uri = ev.get_subject (0).get_uri ();
+        
+        if (app_uri == null)
         {
-          string app_uri;
-          if (ev.num_subjects () > 0)
-            app_uri = ev.get_subject (0).get_uri ();
-          else
-            {
-              warning ("Unexpected event without subject");
-              continue;
-            }
-        
-          /* Assert that we indeed have a known application as actor */
-          string desktop_id = Utils.get_desktop_id_for_actor (app_uri);
-          
-          /* Discard Recently Used apps that are in the launcher */
-          if ((category_id == Category.RECENT ||
-               category_id == Category.RECENT_APPS) &&
-              !include_favorites &&
-              (favorite_apps.has_app_id (desktop_id)
-              || app_watcher.has_app_id (desktop_id)))
-            continue;
-
-          var appmanager = AppInfoManager.get_default ();
-          AppInfo? app = appmanager.lookup (desktop_id);
-
-          if (app == null)
-            continue;
-          
-          if (!app.should_show ())
-            continue;
-          
-          string full_path = appmanager.get_path (desktop_id);
-          string full_uri = full_path != null ? "file://" + full_path : app_uri;
-
-          results.append (app_uri, app.get_icon().to_string(), category_id,
-                          "application/x-desktop", app.get_display_name (),
-                          app.get_description (), full_uri);
+          warning ("Unexpected event without subject");
+          continue;
         }
+
+        /* Assert that we indeed have a known application as actor */
+        string desktop_id = Utils.get_desktop_id_for_actor (app_uri);
+        
+        /* Discard Recently Used apps that are in the launcher */
+        if ((category_id == Category.RECENT ||
+             category_id == Category.RECENT_APPS) &&
+            !include_favorites &&
+            (favorite_apps.has_app_id (desktop_id)
+            || app_watcher.has_app_id (desktop_id)))
+          continue;
+
+        var appmanager = AppInfoManager.get_default ();
+        AppInfo? app = appmanager.lookup (desktop_id);
+
+        if (app == null)
+          continue;
+        
+        if (!app.should_show ())
+          continue;
+
+        /* HACK! when using the max_results together with allowed_uris,
+         * the limit serves as a truncation point - therefore results which
+         * are not displayed the first time won't be displayed later
+         * (consider results A, B, C - all of them are allowed and we use
+         *  limit 2 - so only A and B is displayed, later we change allowed to
+         *  B and C, so normally we would display both B and C, but that's not
+         *  desired because C wasn't shown in the first place, so we display
+         *  only B) */
+        if (num_results++ >= max_results) break;
+
+        if (allowed_uris != null && !(app_uri in allowed_uris)) continue;
+
+        string full_path = appmanager.get_path (desktop_id);
+        string full_uri = full_path != null ? "file://" + full_path : app_uri;
+
+        results.append (app_uri, app.get_icon().to_string(), category_id,
+                        "application/x-desktop", app.get_display_name (),
+                        app.get_description (), full_uri);
+      }
     }
     
   } /* END: class Daemon */

=== added file 'tests/test-6-recent-results.sh'
--- tests/test-6-recent-results.sh	1970-01-01 00:00:00 +0000
+++ tests/test-6-recent-results.sh	2012-03-15 12:14:19 +0000
@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# Do empty search, print the results, look at the number of items
+# for the recent category, make sure there are max 6
+test `unity-tool -n com.canonical.Unity.Lens.Applications -p /com/canonical/unity/lens/applications -s "" --no-search-reply -r | awk -F "\t" ' { print $3; } ' | grep 0 | wc -l` -le 6
+