Merge lp:~jan-hrdina/synapse-project/chromium-plugin into lp:synapse-project

[Jan Hrdina]

I've written Chromium Plugin for Chromium bookmarks support. Could you please look at it when you have time?

Thx!

[lp:~jan-hrdina/synapse-project/chromium-plugin]

509. By Jan Hrdina on 2013-05-24

Add Chromium plugin into POTFILES.in

[Michal Hruby (mhr3)]

Hi, sorry this took so long to review, synapse has been lately on backburner, and could use more active maintainers :)

Nonetheless the branch looks good, just one thing - could you make the parse_bookmarks method async? Synapse wants to be super fast to startup and doing blocking io is not helping that goal.

review: Needs Fixing

[lp:~jan-hrdina/synapse-project/chromium-plugin]

510. By Jan Hrdina on 2013-10-15

Chromium Plugin parsing method made async

511. By Jan Hrdina on 2013-10-15

Merge upstream

[Jan Hrdina (jan-hrdina)]

Hi, I have made the parse_bookmarks method async so I believe the plugin is now ready for merging.

[Michal Hruby (mhr3)]

A method isn't async just by adding the "async" keyword, you actually have to yield inside it.

Anyway fixed and merged, thanks, and once again sorry this took so long.

review: Approve

=== modified file 'po/POTFILES.in'
--- po/POTFILES.in	2012-03-18 18:55:40 +0000
+++ po/POTFILES.in	2013-10-15 14:18:49 +0000
@@ -20,6 +20,7 @@
 src/plugins/banshee-plugin.vala
 src/plugins/calculator-plugin.vala
 src/plugins/chat-actions-plugin.vala
+src/plugins/chromium-plugin.vala
 src/plugins/command-plugin.vala
 src/plugins/desktop-file-plugin.vala
 src/plugins/devhelp-search.vala

=== modified file 'src/plugins/Makefile.am'
--- src/plugins/Makefile.am	2013-07-02 23:06:40 +0000
+++ src/plugins/Makefile.am	2013-10-15 14:18:49 +0000
@@ -32,6 +32,7 @@
 	banshee-plugin.vala \
 	calculator-plugin.vala \
 	chat-actions-plugin.vala \
+	chromium-plugin.vala \
 	command-plugin.vala \
 	file-op-plugin.vala \
 	desktop-file-plugin.vala \

=== added file 'src/plugins/chromium-plugin.vala'
--- src/plugins/chromium-plugin.vala	1970-01-01 00:00:00 +0000
+++ src/plugins/chromium-plugin.vala	2013-10-15 14:18:49 +0000
@@ -0,0 +1,219 @@
+/*
+ * Copyright (C) 2013 Jan Hrdina <[e-mail]>
+ * 
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the
+ * Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * 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/>.
+ */
+ 
+namespace Synapse
+{
+
+  public class ChromiumPlugin : Object, Activatable, ItemProvider
+  {
+    public bool enabled { get; set; default = true; }
+
+    public void activate ()
+    {
+      
+    }
+
+    public void deactivate ()
+    {
+      
+    }
+    
+    private class BookmarkMatch : Object, Match, UriMatch
+    {
+      // from Match interface
+      public string title { get; construct set; }
+      public string description { get; set; default = ""; }
+      public string icon_name { get; construct set; }
+      public bool has_thumbnail { get; construct set; default = false; }
+      public string thumbnail_path { get; construct set; }
+      public MatchType match_type { get; construct set; }
+      
+      // from UriMatch interface
+      public string uri { get; set; }
+      public QueryFlags file_type { get; set; }
+      public string mime_type { get; set; }
+      
+      private string? title_folded = null;
+      private string? uri_folded = null;
+      
+      public unowned string get_title_folded ()
+      {
+        if (title_folded == null) title_folded = title.casefold ();
+        return title_folded;
+      }
+      
+      public unowned string get_uri_folded ()
+      {
+          if (uri_folded == null) uri_folded = uri.casefold ();
+        return uri_folded;
+      }
+      
+      public BookmarkMatch.with_content (string name, string url)
+      {
+        Object (title: name,
+                description: url,
+                uri: url,
+                match_type: MatchType.GENERIC_URI,
+                has_thumbnail: false, icon_name: "text-html");
+      }
+    }
+    
+    static void register_plugin ()
+    {
+      DataSink.PluginRegistry.get_default ().register_plugin (
+        typeof (ChromiumPlugin),
+        _ ("Chromium Plugin"),
+        _ ("Browse and open Chromium bookmarks."),
+        "chromium",
+        register_plugin,
+        Environment.find_program_in_path ("chromium") != null,
+        _ ("Chromium is not installed")
+      );
+    }
+ 
+    static construct
+    {
+      register_plugin ();
+    }
+    
+    private Gee.List<BookmarkMatch> bookmarks;
+    
+    construct
+    {
+      bookmarks = new Gee.ArrayList<BookmarkMatch> ();
+      parse_bookmarks.begin ();
+    }
+    
+    private void full_search (Query q, ResultSet results,
+                              MatcherFlags flags = 0)
+    {
+      // try to match against global matchers and if those fail, try also exec
+      var matchers = Query.get_matchers_for_query (q.query_string_folded, flags);
+      
+      foreach (var bmk in bookmarks)
+      {
+        unowned string name = bmk.get_title_folded ();
+        unowned string url = bmk.get_uri_folded ();
+        
+        foreach (var matcher in matchers)
+        {
+          if (matcher.key.match (name))
+          {
+            results.add (bmk, matcher.value);
+            break;
+          }
+          if (url != null && matcher.key.match (url))
+          {
+            results.add (bmk, matcher.value);
+            break;
+          }
+        }
+      }
+    }
+ 
+    public bool handles_query (Query query)
+    {
+      return (QueryFlags.INTERNET in query.query_type);
+    }
+ 
+    public async ResultSet? search (Query q) throws SearchError
+    {
+      var result = new ResultSet ();
+      
+      if (q.query_string.length == 1)
+      {
+        var flags = MatcherFlags.NO_SUBSTRING | MatcherFlags.NO_PARTIAL |
+                    MatcherFlags.NO_FUZZY;
+        full_search (q, result, flags);
+      }
+      else
+      {
+        full_search (q, result);
+      }
+      
+      q.check_cancellable ();
+      
+      return result;
+    }
+    
+    
+    /* Bookmarks parsing methods */
+    
+    private static bool is_container (Json.Object o, string container_string) 
+    {
+      return o.get_string_member ("type") == container_string;
+    }
+    
+    private static bool is_bookmark (Json.Object o)
+    {
+      return o.has_member ("url");
+    }
+    
+    private static bool is_good (Json.Object o, Gee.HashSet<string> unwanted_scheme)
+    {
+      return !unwanted_scheme.contains (o.get_string_member ("url")
+                                        .split (":", 1)[0]);
+    }
+    
+    private async void parse_bookmarks ()
+    {
+      var parser = new Json.Parser ();
+      string fpath = GLib.Path.build_filename (Environment.get_user_config_dir (),
+                                        "chromium", "Default", "Bookmarks");
+      
+      string CONTAINER = "folder";
+      Gee.HashSet<string> UNWANTED_SCHEME = new Gee.HashSet<string> ();
+      UNWANTED_SCHEME.add ("data");
+      UNWANTED_SCHEME.add ("place");
+      UNWANTED_SCHEME.add ("javascript");
+      
+      List<unowned Json.Node> folders = new List<Json.Node> ();
+      
+      try
+      {
+        parser.load_from_file (fpath);
+        var root_object = parser.get_root ().get_object ();
+        folders.concat (root_object.get_member ("roots").get_object ()
+                                   .get_member ("bookmark_bar").get_object ()
+                                   .get_array_member ("children").get_elements ());
+        folders.concat (root_object.get_member ("roots").get_object ()
+                                   .get_member ("other").get_object ()
+                                   .get_array_member ("children").get_elements ());
+        
+        Json.Object o;
+        foreach (var item in folders)
+        {
+          o = item.get_object ();
+          if (is_bookmark (o) && is_good (o, UNWANTED_SCHEME))
+          {
+            bookmarks.add (new BookmarkMatch.with_content (
+                                               o.get_string_member ("name"),
+                                               o.get_string_member ("url")));
+          }
+          if (is_container (o, CONTAINER))
+          {
+            folders.concat(o.get_array_member ("children").get_elements ());
+          }
+        }
+      }
+      catch (Error err)
+      {
+        warning ("%s", err.message);
+      }
+    }
+  }
+}

=== modified file 'src/ui/synapse-main.vala'
--- src/ui/synapse-main.vala	2013-07-20 18:34:34 +0000
+++ src/ui/synapse-main.vala	2013-10-15 14:18:49 +0000
@@ -177,6 +177,7 @@
         typeof (SelectionPlugin),
         typeof (SshPlugin),
         typeof (XnoiseActions),
+        typeof (ChromiumPlugin),
         // typeof (FileOpPlugin),
         // typeof (PidginPlugin),
         // typeof (ChatActions),