Merge lp:~mhr3/unity-lens-files/fix-947856 into lp:unity-lens-files

[Michal Hruby]

Use Zeitgeist's data to list files from Downloads directory.

This makes sure that search is consistent and privacy settings are honored.

Use Zeitgeist for downloads directory listing and searching, so we make sure the privacy settings are honored.

[Siegfried Gevatter (rainct)]

Nice :).

review: Approve

[Neil J. Patel (njpatel)]

Looks good

review: Approve

[lp:~mhr3/unity-lens-files/fix-947856]

219. By Michal Hruby on 2012-03-15

Monitor Zeitgeist's blacklist to make sure locate search respects privacy settings.. Fixes: https://bugs.launchpad.net/bugs/955229. Approved by Neil J. Patel, Siegfried Gevatter.

220. By Michal Hruby on 2012-03-15

Use Zeitgeist's data to list files from Downloads directory.

This makes sure that search is consistent and privacy settings are honored.. Fixes: https://bugs.launchpad.net/bugs/947856. Approved by Neil J. Patel, Siegfried Gevatter.

=== modified file 'src/daemon.vala'
--- src/daemon.vala	2012-03-12 23:23:48 +0000
+++ src/daemon.vala	2012-03-15 12:01:17 +0000
@@ -42,6 +42,7 @@
     /* For each section we have a set of Zeitgeist.Event templates that
      * we use to query Zeitgeist */
     private HashTable<string, Event> type_templates;
+    private HashTable<string, Event> download_dir_type_templates;
 
     private const string SCHEMA_NAME = "com.canonical.Unity.FilesLens";
     private const string USE_LOCATE_KEY = "use-locate";
@@ -213,65 +214,65 @@
       lens.categories = categories;
     }
 
-    private void prepare_type_templates ()
+    private void init_templates (HashTable<string, Event> templates,
+                                 string manifestation, string uri_prefix)
     {
-      type_templates = new HashTable<string, Event> (str_hash, str_equal);
       Event event;
 
       /* Section.ALL_FILES */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                "", "", "", "", "", ""));
-      type_templates["all"] = event;
+      templates["all"] = event;
       
       /* Section.DOCUMENTS */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                NFO_DOCUMENT,
                                                "", "", "", "", ""),
-                             new Subject.full ("file:*",
+                             new Subject.full ("",
                                                "!"+NFO_PRESENTATION,
                                                "", "", "", "", ""));
-      type_templates["documents"] = event;
+      templates["documents"] = event;
 
       /* Section.FOLDERS
        * - we're using special ORIGIN queries here */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                "", "", "", "", "", ""));
-      type_templates["folders"] = event;
+      templates["folders"] = event;
 
       /* Section.IMAGES */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                NFO_IMAGE, "", "", "", "", ""));
-      type_templates["images"] = event;
+      templates["images"] = event;
       
       /* Section.AUDIO */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                NFO_AUDIO, "", "", "", "", ""));
-      type_templates["audio"] = event;
+      templates["audio"] = event;
 
       /* Section.VIDEOS */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                NFO_VIDEO, "", "", "", "", ""));
-      type_templates["videos"] = event;
+      templates["videos"] = event;
 
       /* Section.PRESENTATIONS
        * FIXME: Zeitgeist logger needs to user finer granularity
        *        on classification as I am not sure it uses
        *        NFO_PRESENTATION yet */
-      event = new Event.full("", ZG_USER_ACTIVITY, "",
-                             new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "",
+                             new Subject.full (uri_prefix,
                                                NFO_PRESENTATION, "", "", "", "", ""));
-      type_templates["presentations"] = event;
+      templates["presentations"] = event;
 
       /* Section.OTHER 
        * Note that subject templates are joined with logical AND */
-      event = new Event.full("", ZG_USER_ACTIVITY, "");
-      event.add_subject (new Subject.full ("file:*",
+      event = new Event.full("", manifestation, "");
+      event.add_subject (new Subject.full (uri_prefix,
                                            "!"+NFO_DOCUMENT, "", "", "", "", ""));
       event.add_subject (new Subject.full ("",
                                            "!"+NFO_IMAGE,
@@ -289,7 +290,23 @@
                                            "!"+NFO_PRESENTATION,
                                            "",
                                            "", "", "", ""));
-      type_templates["other"] = event;
+      templates["other"] = event;
+    }
+
+    private void prepare_type_templates ()
+    {
+      type_templates = new HashTable<string, Event> (str_hash, str_equal);
+      init_templates (type_templates, ZG_USER_ACTIVITY, "file:*");
+
+      unowned string download_path;
+      download_path = Environment.get_user_special_dir (UserDirectory.DOWNLOAD);
+      if (download_path != null)
+      {
+        download_dir_type_templates = new HashTable<string, Event> (str_hash,
+                                                                    str_equal);
+        string download_uri = File.new_for_path (download_path).get_uri ();
+        init_templates (download_dir_type_templates, "", download_uri + "/*");
+      }
     }
 
     private const string[] ALL_TYPES =
@@ -303,14 +320,19 @@
       "other"
     };
 
-    private GenericArray<Event> create_template (OptionsFilter? filter)
+    private GenericArray<Event>? create_template (OptionsFilter? filter,
+                                                  bool downloads_templates)
     {
       var templates = new GenericArray<Event> ();
 
+      HashTable<string, Event>? prepared_templates = downloads_templates ?
+        download_dir_type_templates : type_templates;
+      if (prepared_templates == null) return null;
+
       if (filter == null || !filter.filtering)
       {
         /* Section.ALL_FILES */
-        templates.add (type_templates["all"]);
+        templates.add (prepared_templates["all"]);
         return templates;
       }
 
@@ -327,7 +349,7 @@
       if (types.length == ALL_TYPES.length)
       {
         /* Section.ALL_FILES */
-        templates.add (type_templates["all"]);
+        templates.add (prepared_templates["all"]);
         return templates;
       }
 
@@ -336,7 +358,7 @@
         // we need to handle folders separately
         if (type_id == "folders") continue;
 
-        templates.add (type_templates[type_id]);
+        templates.add (prepared_templates[type_id]);
       }
 
       return templates;
@@ -413,8 +435,17 @@
         /* Add downloads catagory if we don't have a search */
         if (has_search == false)
         {
-          yield update_downloads_async (results_model, cancellable,
-                                        search.search_string);
+          results = yield run_zg_query (search,
+                                        new Zeitgeist.TimeRange.anytime (),
+                                        ResultType.MOST_RECENT_SUBJECTS,
+                                        null,
+                                        20,
+                                        cancellable,
+                                        true);
+
+          Unity.FilesLens.append_events_sorted (results, results_model,
+                                                0, int64.MAX, ResultFlags.NONE,
+                                                null, Categories.DOWNLOADS);
         }
 
         if (has_search && use_locate)
@@ -487,8 +518,18 @@
         }
 
         /* get recently downloaded files */
-        yield update_downloads_async (txn, cancellable,
-                                      search.search_string);
+        results = yield run_zg_query (search,
+                                      get_current_timerange (),
+                                      ResultType.MOST_RECENT_SUBJECTS,
+                                      filter,
+                                      50,
+                                      cancellable,
+                                      true);
+
+        Unity.FilesLens.append_events_sorted (results, txn,
+                                              min_size, max_size,
+                                              ResultFlags.NONE,
+                                              null, Categories.DOWNLOADS);
 
         /* commit if the origin query is taking too long, if we committed right
          * away, we'd cause flicker */
@@ -670,16 +711,19 @@
       }
     }
 
-    private async ResultSet run_zg_query (LensSearch search,
-                                          TimeRange time_range,
-                                          ResultType result_type,
-                                          OptionsFilter? filters,
-                                          uint num_results,
-                                          Cancellable cancellable) throws Error
+    private async ResultSet? run_zg_query (LensSearch search,
+                                           TimeRange time_range,
+                                           ResultType result_type,
+                                           OptionsFilter? filters,
+                                           uint num_results,
+                                           Cancellable cancellable,
+                                           bool downloads_only = false)
+        throws Error
     {
       ResultSet results;
       var timer = new Timer ();
-      var templates = create_template (filters);
+      var templates = create_template (filters, downloads_only);
+      if (templates == null) return null;
 
       /* Copy the templates to a PtrArray which libzg expects */
       var ptr_arr = new PtrArray ();
@@ -730,74 +774,6 @@
       }
     }
 
-    private async void update_downloads_async (Dee.Model results_model,
-                                               Cancellable cancellable,
-                                               string? name_filter = null,
-                                               int category_override = -1) throws IOError
-    {
-      // FIXME: Store the Downloads folder and update on changes
-      unowned string download_path =
-                 Environment.get_user_special_dir (UserDirectory.DOWNLOAD);
-      if (download_path == null) {
-        warning ("Download directory unknown, skipping.");
-        return;
-      }
-      var download_dir = File.new_for_path (download_path);
-      SList<FileInfo> downloads;
-
-      try {
-        if (name_filter != null && name_filter != "")
-          downloads = yield Utils.list_dir_filtered (download_dir, name_filter);
-        else
-          downloads = yield Utils.list_dir (download_dir);
-      } catch (GLib.Error e) {
-        warning ("Failed to list downloads from directory '%s': %s",
-                 download_path, e.message);
-        return;
-      }
-
-      cancellable.set_error_if_cancelled (); // throws IOError
-
-      /* Sort files by mtime, we do an ugly nested ternary
-       * to avoid potential long/int overflow */
-      downloads.sort ((CompareFunc) Utils.cmp_file_info_by_mtime);
-      
-      var timerange = get_current_timerange ();
-      int64 min_size, max_size;
-      get_current_size_limits (out min_size, out max_size);
-      var types = get_current_types ();
-      
-      foreach (var info in downloads)
-      {
-        var uri = download_dir.get_child (info.get_name ()).get_uri ();
-        var mimetype = info.get_content_type ();
-        var icon_hint = Utils.check_icon_string (uri, mimetype, info);
-
-        // check if we match the timerange
-        uint64 atime = info.get_attribute_uint64 (FILE_ATTRIBUTE_TIME_ACCESS) * 1000;
-        
-        if (atime < timerange.get_start() || atime > timerange.get_end ())
-          continue;
-
-        // check if type matches
-        if (types != null && !Utils.file_info_matches_any (info, types))
-          continue;
-        
-        // check if size is within bounds
-        int64 size = info.get_size ();
-        if (size < min_size || size > max_size)
-          continue;
-        
-        uint category_id = Categories.DOWNLOADS;
-        
-        if (category_override >= 0)
-          category_id = category_override;
-        
-        results_model.append (uri, icon_hint, category_id,
-                              mimetype, info.get_display_name (), uri);
-      }
-    }
-
     private async void perform_locate (uint timeout,
                                        string query,
                                        Dee.Model results_model,
@@ -908,13 +884,14 @@
 
   /* Appends a set of Zeitgeist.Events to our Dee.Model assuming that
    * these events are already sorted with descending timestamps */
-  public void append_events_sorted (Zeitgeist.ResultSet events,
+  public void append_events_sorted (Zeitgeist.ResultSet? events,
                                     Dee.Model results,
                                     int64 min_size, int64 max_size,
                                     ResultFlags flags,
                                     Gee.Set<string>? excluded_uris = null,
                                     int category_override = -1)
   {
+    if (events == null) return;
     foreach (var ev in events)
     {
       if (ev.num_subjects() > 0)

=== modified file 'src/url-checker.vala'
--- src/url-checker.vala	2012-03-13 08:53:24 +0000
+++ src/url-checker.vala	2012-03-15 12:01:17 +0000
@@ -68,6 +68,7 @@
      */
     public string? check_url (string sample, out UrlType url_type)
     {
+      url_type = UrlType.UNKNOWN;
       if (sample.strip () == "") return null;
       
       if (mountable_regex.match (sample))
@@ -80,7 +81,6 @@
         url_type = UrlType.WEB;
         return sample.has_prefix ("http") ? sample : ("http://" + sample);
       }
-      url_type = UrlType.UNKNOWN;
       return null;
     }
     

=== added file 'tests/manual/downloads.txt'
--- tests/manual/downloads.txt	1970-01-01 00:00:00 +0000
+++ tests/manual/downloads.txt	2012-03-15 12:01:17 +0000
@@ -0,0 +1,10 @@
+Downloads
+=========
+Tests that the downloads category shows files from your ~/Downloads directory.
+
+#. Create a file in the ~/Downloads category (or equivalent for your locale).
+#. Search for this file with files lens.
+
+Outcome
+  The file you created in the first step should show up as a result in the Downloads category of files lens.
+