Merge lp:~michaelaquilina/synapse-project/tomboy-notes-plugin into lp:synapse-project

[Michael Aquilina]

This simple plugin adds support for searching and opening existing tomboy notes.

[Michael Aquilina (michaelaquilina)]

This new plugin is a lot more simple than the pass plugin if you want to give it a quick look

[Rico Tzschichholz (ricotz)]

The clean up diff of "pass" should provide some hints which can be applied here too.

Also keep the files in Makefile.am in alphabetical order.
Cache values which are reused like "info.get_name ()"

[lp:~michaelaquilina/synapse-project/tomboy-notes-plugin]

637. By Michael Aquilina on 2016-03-03

Add tomboy notes plugin

[Michael Aquilina (michaelaquilina)]

Updated

[Michael Aquilina (michaelaquilina)]

any feedback on this?

[Michael Aquilina (michaelaquilina)]

@ricotz are we good to merge this in?

Unmerged revisions

637. By Michael Aquilina on 2016-03-03

Add tomboy notes plugin

=== modified file 'po/POTFILES.in'
--- po/POTFILES.in	2016-02-26 16:57:32 +0000
+++ po/POTFILES.in	2016-03-03 12:14:31 +0000
@@ -40,6 +40,7 @@
 src/plugins/selection-plugin.vala
 src/plugins/ssh-plugin.vala
 src/plugins/system-management.vala
+src/plugins/tomboy-notes-plugin.vala
 src/plugins/xnoise-media-player-plugin.vala
 src/plugins/zeitgeist-plugin.vala
 src/plugins/zeitgeist-related.vala

=== modified file 'po/POTFILES.skip'
--- po/POTFILES.skip	2016-02-26 16:57:32 +0000
+++ po/POTFILES.skip	2016-03-03 12:14:31 +0000
@@ -41,6 +41,7 @@
 src/plugins/selection-plugin.c
 src/plugins/ssh-plugin.c
 src/plugins/system-management.c
+src/plugins/tomboy-notes-plugin.c
 src/plugins/xnoise-media-player-plugin.c
 src/plugins/zeitgeist-plugin.c
 src/plugins/zeitgeist-related.c

=== modified file 'src/plugins/Makefile.am'
--- src/plugins/Makefile.am	2016-02-26 16:57:32 +0000
+++ src/plugins/Makefile.am	2016-03-03 12:14:31 +0000
@@ -50,6 +50,7 @@
 	rhythmbox-plugin.vala \
 	selection-plugin.vala \
 	test-slow-plugin.vala \
+	tomboy-notes-plugin.vala \
 	xnoise-media-player-plugin.vala \
 	system-management.vala \
 	zeal-plugin.vala \

=== added file 'src/plugins/tomboy-notes-plugin.vala'
--- src/plugins/tomboy-notes-plugin.vala	1970-01-01 00:00:00 +0000
+++ src/plugins/tomboy-notes-plugin.vala	2016-03-03 12:14:31 +0000
@@ -0,0 +1,190 @@
+/*
+ * Copyright (C) 2011 Michael Aquilina <[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 2 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, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA.
+ *
+ * Authored by Michael Aquilina <[e-mail]>
+ *
+ */
+
+namespace Synapse
+{
+  public class TomboyNotesPlugin : Object, Activatable, ItemProvider
+  {
+    public bool enabled { get; set; default = true; }
+
+    private List<TomboyNoteMatch> notes;
+    private FileMonitor tomboy_monitor;
+
+    public void activate ()
+    {
+      File note_storage = File.new_for_path (
+        "%s/.local/share/tomboy".printf (Environment.get_home_dir ())
+      );
+      try {
+        notes = list_tomboy_notes (note_storage);
+      } catch (Error err) {
+        warning ("%s", err.message);
+      }
+
+      tomboy_monitor = note_storage.monitor (FileMonitorFlags.SEND_MOVED, null);
+      tomboy_monitor.set_rate_limit (500);
+      tomboy_monitor.changed.connect ( (src, dest, event) => {
+        string src_path = src.get_path ();
+        if (src_path.has_suffix (".note")) {
+          message ("Reloading notes due to change in %s (%s)", src_path, event.to_string ());
+          try {
+            notes = list_tomboy_notes (note_storage);
+          } catch (Error err) {
+            warning ("Unable to list tomboy notes: %s", err.message);
+          }
+        }
+      });
+    }
+
+    public void deactivate ()
+    {
+      tomboy_monitor.cancel();
+    }
+
+    static void register_plugin ()
+    {
+      PluginRegistry.get_default ().register_plugin (
+        typeof (TomboyNotesPlugin),
+        _("Tomboy Notes"),
+        _("Search for tomboy notes."),
+        "tomboy",
+        register_plugin,
+        Environment.find_program_in_path ("tomboy") != null,
+        _("Tomboy Notes is not installed")
+      );
+    }
+
+    static construct
+    {
+      register_plugin ();
+    }
+
+    public string? get_note_title (File note_file) throws Error {
+      FileIOStream ios = note_file.open_readwrite ();
+      FileInputStream @is = ios.input_stream as FileInputStream;
+      DataInputStream dis = new DataInputStream (@is);
+
+      string line;
+      while ((line = dis.read_line ()) != null) {
+        if (Regex.match_simple ("<title>.*</title>", line)) {
+          line = line.replace ("<title>", "");
+          line = line.replace ("</title>", "");
+          return line.strip ();
+        }
+      }
+      dis.close();
+      is.close();
+      ios.close();
+
+      return null;
+    }
+
+    private List<TomboyNoteMatch> list_tomboy_notes (File directory) throws Error {
+      List<TomboyNoteMatch> result = new List<TomboyNoteMatch> ();
+
+      FileEnumerator enumerator = directory.enumerate_children (
+        FileAttribute.STANDARD_NAME + "," +
+        FileAttribute.STANDARD_TYPE,
+        FileQueryInfoFlags.NOFOLLOW_SYMLINKS,
+        null
+      );
+
+      FileInfo? info = null;
+      while ((info = enumerator.next_file (null)) != null) {
+        string file_name = info.get_name ();
+        File note_file = directory.get_child (file_name);
+
+        if (info.get_file_type () == FileType.REGULAR && file_name.has_suffix (".note")) {
+          try {
+            var match = new TomboyNoteMatch(
+              get_note_title (note_file),
+              note_file.get_path ()
+            );
+            result.append (match);
+          } catch (Error err) {
+            warning ("%s", err.message);
+          }
+        }
+      }
+      return result;
+    }
+
+    public bool handles_query (Query query)
+    {
+      return (QueryFlags.ACTIONS in query.query_type);
+    }
+
+    public async ResultSet? search (Query query) throws SearchError
+    {
+      var matchers = Query.get_matchers_for_query (
+        query.query_string, 0,
+        RegexCompileFlags.OPTIMIZE | RegexCompileFlags.CASELESS
+      );
+
+      var results = new ResultSet ();
+      foreach (unowned TomboyNoteMatch note in notes)
+      {
+        foreach (var matcher in matchers)
+        {
+          if (matcher.key.match (note.title)) {
+            results.add (note, MatchScore.GOOD);
+            break;
+          }
+        }
+      }
+
+      // make sure this method is called before returning any results
+      query.check_cancellable ();
+      if (results.size > 0) {
+        return results;
+      } else {
+        return null;
+      }
+    }
+
+    private class TomboyNoteMatch : ActionMatch
+    {
+      private string url;
+
+      public TomboyNoteMatch (string note_title, string url)
+      {
+        Object (title: note_title,
+                description: _("Open Tomboy Note"),
+                has_thumbnail: false,
+                icon_name: "tomboy");
+        this.url = url;
+      }
+
+      public override void do_action ()
+      {
+        try
+        {
+          AppInfo ai = AppInfo.create_from_commandline (
+            "tomboy --open-note %s".printf (url), "tomboy", 0
+          );
+          ai.launch (null, null);
+        } catch (Error err) {
+          warning ("%s", err.message);
+        }
+      }
+    }
+  }
+}

=== modified file 'src/ui/synapse-main.vala'
--- src/ui/synapse-main.vala	2016-02-27 15:19:21 +0000
+++ src/ui/synapse-main.vala	2016-03-03 12:14:31 +0000
@@ -175,6 +175,7 @@
         typeof (FileOpPlugin),
         typeof (PidginPlugin),
         typeof (ChatActions),
+        typeof (TomboyNotesPlugin),
         typeof (ZealPlugin),
 #if HAVE_ZEITGEIST
         typeof (ZeitgeistPlugin),