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

[Michal Hruby]

Monitor Zeitgeist's blacklist to make sure locate search respects privacy settings.

Watch Zeitgeist blacklists to make sure the non-zeitgeist searches respect privacy settings

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

220. By Michal Hruby on 2012-03-15

Add manual test

[Siegfried Gevatter (rainct)]

There might be races with get_blacklisted_uris() being called before blacklist_proxy gets initialized, but like you said on IRC it's unlikely and the result will be an empty set being returned so I guess it's safe enough to ignore...

Some other comments for the sake of completeness:

 * You're assuming that if there's a URI it will be in the first subject template. This is true for Activity Log Manager, but generally it could be in any position (although indeed there should be only one them; two URIs in the same event template don't make sense).

 * You're ignoring single files being blacklisted. Is this because ALM only supports folders?

 * And, obviously, blacklists consist of much more than URIs, but yeah, probably not much point in hiding downloads by mimetype.

review: Approve

[Neil J. Patel (njpatel)]

Looks good

review: Approve

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2012-03-12 23:23:48 +0000
+++ src/Makefile.am	2012-03-15 11:52:20 +0000
@@ -36,6 +36,7 @@
   $(NULL)
 
 unity_files_daemon_VALASOURCES = \
+  blacklist-tracker.vala \
   config.vala \
   daemon.vala \
   folder.vala \

=== added file 'src/blacklist-tracker.vala'
--- src/blacklist-tracker.vala	1970-01-01 00:00:00 +0000
+++ src/blacklist-tracker.vala	2012-03-15 11:52:20 +0000
@@ -0,0 +1,129 @@
+/*
+ * 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 Michal Hruby <[e-mail]>
+ *
+ */
+using Zeitgeist;
+using Config;
+using Gee;
+
+namespace Unity.FilesLens
+{
+  /* Libzeitgeist currently doesn't expose any blacklist API, so we need to
+   * use direct dbus calls */
+  [DBus (name = "org.gnome.zeitgeist.Blacklist")]
+  public interface Blacklist : Object
+  {
+    [DBus (signature = "a{s(asaasay)}")]
+    public abstract async Variant get_templates () throws Error;
+    public signal void template_added (string template_id,
+        [DBus (signature = "(asassay)")] Variant template);
+    public signal void template_removed (string template_id,
+        [DBus (signature = "(asassay)")] Variant template);
+  }
+
+  public class BlacklistTracker : Object
+  {
+    private HashTable<string, Event> event_templates;
+    private Blacklist blacklist_proxy;
+
+    private Set<string> blacklisted_uris;
+    private bool cached_uris_dirty;
+
+    construct
+    {
+      event_templates = new HashTable<string, Event> (str_hash, str_equal);
+      blacklisted_uris = new HashSet<string> ();
+
+      Bus.get_proxy<Blacklist> (BusType.SESSION, "org.gnome.zeitgeist.Engine",
+                     "/org/gnome/zeitgeist/blacklist", 0, null, (src, res) =>
+      {
+        try
+        {
+          blacklist_proxy = (src as DBusConnection).get_proxy<Blacklist>.end (res);
+          fetch_blacklists ();
+        }
+        catch (GLib.Error err)
+        {
+          warning ("%s", err.message);
+        }
+      });
+    }
+
+    private async void fetch_blacklists ()
+    {
+      blacklist_proxy.template_added.connect (this.template_added);
+      blacklist_proxy.template_removed.connect (this.template_removed);
+      Variant all_templates = yield blacklist_proxy.get_templates ();
+
+      VariantIter iter = new VariantIter (all_templates);
+      string template_id;
+      Variant event_variant;
+      while (iter.next ("{s@(asaasay)}", out template_id, out event_variant))
+      {
+        Event e = new Event.from_variant (event_variant);
+        event_templates[template_id] = e;
+      }
+      cached_uris_dirty = true;
+    }
+
+    private void template_added (string id, Variant template)
+    {
+      Event e = new Event.from_variant (template);
+      event_templates[id] = e;
+      cached_uris_dirty = true;
+    }
+
+    private void template_removed (string id, Variant template)
+    {
+      event_templates.remove (id);
+      cached_uris_dirty = true;
+    }
+
+    private void update_uris ()
+    {
+      var iter = HashTableIter<string, Event> (event_templates);
+      unowned Event e;
+      while (iter.next (null, out e))
+      {
+        if (e.num_subjects () > 0)
+        {
+          unowned Subject s = e.get_subject (0);
+          unowned string uri = s.get_uri ();
+          if (uri == null || uri == "") continue;
+
+          if (uri.has_suffix ("*"))
+          {
+            blacklisted_uris.add (uri.substring (0, uri.length - 1));
+          }
+        }
+      }
+    }
+
+    public unowned Set<string> get_blacklisted_uris ()
+    {
+      if (cached_uris_dirty)
+      {
+        blacklisted_uris.clear ();
+        update_uris ();
+        cached_uris_dirty = false;
+      }
+      return blacklisted_uris;
+    }
+  }
+
+} /* namespace */
+

=== modified file 'src/locate.vala'
--- src/locate.vala	2012-03-02 16:04:21 +0000
+++ src/locate.vala	2012-03-15 11:52:20 +0000
@@ -36,9 +36,12 @@
       FILE_ATTRIBUTE_ACCESS_CAN_WRITE + "," +
       FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPE;
 
+  private BlacklistTracker blacklist_tracker;
+
   public async GLib.SList<FileInfo> locate (string input_query,
                                             Cancellable cancellable) throws Error
   {
+    if (blacklist_tracker == null) blacklist_tracker = new BlacklistTracker ();
     var result = new GLib.SList<FileInfo> ();
     var query = Regex.escape_string (input_query.strip ());
 
@@ -65,6 +68,19 @@
       if ("/." in line) continue; // we don't want no hidden files
 
       var file = File.new_for_path (line);
+      var uri = file.get_uri ();
+
+      bool skip = false;
+      foreach (var blacklisted_uri in blacklist_tracker.get_blacklisted_uris ())
+      {
+        if (uri.has_prefix (blacklisted_uri))
+        {
+          skip = true;
+          break;
+        }
+      }
+      if (skip) continue;
+
       var fi = yield file.query_info_async (ATTRIBS, 0, Priority.DEFAULT_IDLE,
                                             cancellable);
       if (fi.get_is_hidden () || fi.get_is_backup () ||

=== modified file 'tests/manual/locate.txt'
--- tests/manual/locate.txt	2012-03-08 16:26:02 +0000
+++ tests/manual/locate.txt	2012-03-15 11:52:20 +0000
@@ -1,6 +1,9 @@
 Locate scope
 ============
-Tests that the locate scope works.
+Tests that the built-in locate scope works.
+
+Search
+------
 
 #. Create a file named "report.txt" in your home directory (`touch report.txt`).
 #. Run updatedb (`sudo updatedb`).
@@ -9,3 +12,13 @@
 Outcome
   The "report.txt" should show up as a result in the Recent category of files lens.
 
+Privacy
+-------
+
+#. Open the "Privacy" application and add your home directory to the list of folders that shouldn't be monitored.
+#. Create a file named "report.txt" in your home directory (`touch report.txt`).
+#. Run updatedb (`sudo updatedb`).
+#. Search for this file with files lens.
+
+Outcome
+  The "report.txt" should NOT show up as a result in any of the categories of files lens.