Merge lp:~3v1n0/synapse-project/gwibber-plugin into lp:synapse-project

[Marco Trevisan (Treviño)]

Added new Gwibber plugin which allows to control the gwibber service (starting, stopping or reloading its data) and to send messages to the enabled social networks.

The message can be sent both writing any valid text (<= 140 chars) in synapse or selecting a gwibber binary and then writing it as a query.

[Michal Hruby (mhr3)]

Could you please fix the pot file issue?

review: Needs Fixing

[Marco Trevisan (Treviño) (3v1n0)]

> Could you please fix the pot file issue?

I don't know why but bzr doesn't allow me to do that... If I remove the file, it asks me to re-add it to stay synced with upstream, if reset it with the original one, it gives me out this output... :/

[Michal Hruby (mhr3)]

The problem seems to be that you removed the pot file in r216, the only way to fix this will be probably to create a new branch... :/

[Marco Trevisan (Treviño) (3v1n0)]

> The problem seems to be that you removed the pot file in r216, the only way to
> fix this will be probably to create a new branch... :/

Please, check if latest revision fixes the issue... Thanks.

[Michal Hruby (mhr3)]

Nope...

[Michal Hruby (mhr3)]

Still the same issue, as I said, you'll most likely need to re-create the branch - just `bzr branch` trunk again, copy your additions there and push it all in one commit.

review: Needs Fixing

[lp:~3v1n0/synapse-project/gwibber-plugin]

225. By Marco Trevisan (Treviño) on 2010-12-05

merge with Head

226. By Marco Trevisan (Treviño) on 2010-12-05

reverted old synapse.pot

227. By Marco Trevisan (Treviño) on 2010-12-05

Updated pot file again

[Marco Trevisan (Treviño) (3v1n0)]

Ok, this version should be ok for merging now... Isn't it?!

Sorry, but I'm a git addicted, and bzr is not so friendly as git is to me :P

review: Needs Resubmitting

[Michal Hruby (mhr3)]

> Ok, this version should be ok for merging now... Isn't it?!
>
> Sorry, but I'm a git addicted, and bzr is not so friendly as git is to me :P

Coming from the other side of the barricade, I completely understand your frustration, but it's still not right, anyhow it has still the same issue, once you delete a file from the tree and then re-add it, it's marked in the history, and you won't fix it by adding more revisions.

[Marco Trevisan (Treviño) (3v1n0)]

> > Ok, this version should be ok for merging now... Isn't it?!
> >
> > Sorry, but I'm a git addicted, and bzr is not so friendly as git is to me :P
>
> Coming from the other side of the barricade, I completely understand your
> frustration, but it's still not right, anyhow it has still the same issue,
> once you delete a file from the tree and then re-add it, it's marked in the
> history, and you won't fix it by adding more revisions.

Mh, I thought that using the revert command in the proper way was enough for restoring a removed file (and so I read in the ML)... In fact the diff shown here and in my local tree, against the master branch doesn't report a conflict with the synapse.pot file any more... Why the diff shown here (http://pastebin.ubuntu.com/540314/) doesn't merge with master? :(

I'm hating bazaar :P, however if you can't merge, I'll re-push a newer tree as soon as I can (also if I don't like loosing the commit history! :/)

[Michal Hruby (mhr3)]

I was actually only looking here at the diff, and it still showed the file as being removed and re-added, but now it's ok, now I wonder if I didn't refresh the page, or Launchpad is having fun with me...

[Alberto Aldegheri (albyrock87)]

Trevino: Thank you for this plugin, but I have some things to say.

If I search for "Gwibber", Synapse shows me the "Gwibber launcher".

If I press tab I see:
Refresh
Stop
Send to Gwibber

The "Send to Gwibber" shouldn't be there: it should be there only while selecting the unknown match (ie simple text).

Also I think that "Send to Gwibber" shouldn't be the first Action for unknown matches:
The risk is to send to Gwibber unwanted text. (IMHO - mhr3, need I your idea about this)

[Marco Trevisan (Treviño) (3v1n0)]

About the "send to gwibber" thing, I agree... I've to fix that, I already gave a look to a clean way to accomplish it.

For the second point, I think that we just have to reduce its priority... Actually the default unknown action is the dictionary... However you can choose the default value you'd like to have.

I'm also writing another action class which will allow to send the written text to the specified protocol, but I'm too busy in these days for pushing it... :(

[Michal Hruby (mhr3)]

The "Send to Gwibber" action should try to be smart, and increase the Score based on the query, ie if I type "@[a-z].*" it's quite clear what I'd want this action, also the more words in the query, the more likely that it is for this action...

Also "Send to Gwibber" - what does that even mean? I'd be nice if the plugin looked at the available accounts and displayed "Tweet this" / "Update facebook status" etc.

[Marco Trevisan (Treviño) (3v1n0)]

> The "Send to Gwibber" action should try to be smart, and increase the Score
> based on the query, ie if I type "@[a-z].*" it's quite clear what I'd want
> this action, also the more words in the query, the more likely that it is for
> this action...

Ok for this... Give me some priority values to use...

> Also "Send to Gwibber" - what does that even mean? I'd be nice if the plugin
> looked at the available accounts and displayed "Tweet this" / "Update facebook
> status" etc.

The version I've in my local branch, take cares of the enabled accounts, and I've also added an action for every single enabled account (i.e. Send to Twitter, Send to Identi.ca...), not to send to every enabled account; but for using the default Gwibber sending feature, I'd use a title like this or maybe "Send via Gwibber" showing to which services in the description...

[Michal Hruby (mhr3)]

> Ok for this... Give me some priority values to use...

Use anything, I'll tune it during the merge.

[Antono Vasiljev (antono)]

Yo. Any updates here?

[Marco Trevisan (Treviño) (3v1n0)]

No, sorry. I've no more time to maintain this, so feel free to branch and hack on this.

Unmerged revisions

227. By Marco Trevisan (Treviño) on 2010-12-05

Updated pot file again

226. By Marco Trevisan (Treviño) on 2010-12-05

reverted old synapse.pot

225. By Marco Trevisan (Treviño) on 2010-12-05

merge with Head

224. By Marco Trevisan (Treviño) on 2010-12-05

fixed the pot merging issue

223. By Marco Trevisan (Treviño) on 2010-12-05

Merging with head (again..)

222. By Marco Trevisan (Treviño) on 2010-12-05

gwibber: Added to translations potfiles

221. By Marco Trevisan (Treviño) on 2010-12-05

Merge with head branch

220. By Marco Trevisan (Treviño) on 2010-12-05

gwibber: adding GwibberQueryAction wrapping class.

This class allows to perform actions for matching queries, not just based
on the action name. For example, you can match the gwibber binary (or
desktop file), and then write your message... This will be parsed and
then, eventually, sent to gwibber.

219. By Marco Trevisan (Treviño) on 2010-12-04

gwibber: added SendMessage feature

Actually it works for every written string with length <= 140 chars.

218. By Marco Trevisan (Treviño) on 2010-12-04

Merge with master branch

=== modified file 'po/POTFILES.in'
--- po/POTFILES.in	2010-12-05 14:27:47 +0000
+++ po/POTFILES.in	2010-12-05 22:26:27 +0000
@@ -14,6 +14,7 @@
 src/plugins/directory-plugin.c
 src/plugins/gnome-session-plugin.c
 src/plugins/gnome-screensaver-plugin.c
+src/plugins/gwibber-plugin.c
 src/plugins/hybrid-search-plugin.c
 src/plugins/locate-plugin.c
 src/plugins/rhythmbox-plugin.c

=== modified file 'src/plugins/Makefile.am'
--- src/plugins/Makefile.am	2010-12-05 14:15:45 +0000
+++ src/plugins/Makefile.am	2010-12-05 22:26:27 +0000
@@ -32,6 +32,7 @@
 	directory-plugin.vala \
 	gnome-session-plugin.vala \
 	gnome-screensaver-plugin.vala \
+	gwibber-plugin.vala \
 	hybrid-search-plugin.vala \
 	locate-plugin.vala \
 	rhythmbox-plugin.vala \

=== added file 'src/plugins/gwibber-plugin.vala'
--- src/plugins/gwibber-plugin.vala	1970-01-01 00:00:00 +0000
+++ src/plugins/gwibber-plugin.vala	2010-12-05 22:26:27 +0000
@@ -0,0 +1,384 @@
+/*
+ * Copyright (C) 2010 Marco Trevisan (Treviño) <[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.
+ *
+ */
+
+namespace Synapse
+{
+  const string APP_BIN     = "gwibber";
+  const string SERVICE_BIN = "gwibber-service";
+
+  [DBus (name = "com.Gwibber.Service")]
+  interface GwibberService : Object {
+      public const string UNIQUE_NAME = "com.Gwibber.Service";
+      public const string OBJECT_PATH = "/com/gwibber/Service";
+      public const string INTERFACE_NAME = "com.Gwibber.Service";
+
+      public abstract async void Start() throws DBus.Error;
+      public abstract async void Refresh() throws DBus.Error;
+      public abstract async void Quit() throws DBus.Error;
+      public abstract async void SendMessage(string msg) throws DBus.Error;
+  }
+
+  [DBus (name = "com.Gwibber.Accounts")]
+  interface GwibberAccounts : Object {
+      public const string UNIQUE_NAME = "com.Gwibber.Accounts";
+      public const string OBJECT_PATH = "/com/gwibber/Accounts";
+      public const string INTERFACE_NAME = "com.Gwibber.Accounts";
+
+      public abstract async string? SendEnabled(string id) throws DBus.Error;
+      public abstract async string? Get(string id) throws DBus.Error;
+      public abstract async string? List() throws DBus.Error;
+      public abstract async string? Query(string query) throws DBus.Error;
+  }
+
+  public class GwibberPlugin : ActionPlugin
+  {
+    private Gee.List<GwibberAction> actions;
+
+    static void register_plugin()
+    {
+      DataSink.PluginRegistry.get_default().register_plugin(
+        typeof (GwibberPlugin),
+        "Gwibber",
+        _ ("Allows you to post to micro-blogging services via Gwibber."),
+        "gwibber",
+        register_plugin,
+        Environment.find_program_in_path("gwibber-service") != null,
+        _ ("Gwibber is not installed")
+      );
+    }
+
+    construct
+    {
+      actions = new Gee.ArrayList<GwibberAction>();
+
+      actions.add(new Start());
+      actions.add(new Stop());
+      actions.add(new Refresh());
+      actions.add(new SendMessage());
+    }
+
+    public override bool handles_unknown()
+    {
+      return is_gwibber_running();
+    }
+
+    private static bool is_gwibber_running() {
+      return DBusNameCache.get_default().name_has_owner(GwibberService.UNIQUE_NAME);
+    }
+
+    static construct
+    {
+      register_plugin();
+    }
+
+    private abstract class GwibberAction : Object, Match
+    {
+      // from Match interface
+      public string title { get; construct set; }
+      public string description { get; set; }
+      public string icon_name { get; construct set; }
+      public bool has_thumbnail { get; construct set; }
+      public string thumbnail_path { get; construct set; }
+      public MatchType match_type { get; construct set; }
+      public int default_relevancy { get; set; }
+
+      public abstract bool valid_for_match(Match match);
+
+      public virtual bool valid_for_query(string query)
+      {
+        return false;
+      }
+
+      // stupid Vala...
+      protected async abstract void execute_internal(Match? match);
+      public void execute (Match? match)
+      {
+        execute_internal.begin(match);
+      }
+
+      public virtual int get_relevancy()
+      {
+        return is_gwibber_running() ? default_relevancy + 20 : default_relevancy;
+      }
+    }
+
+    private abstract class GwibberBinAction : GwibberAction
+    {
+      protected static string service_path = Environment.find_program_in_path(SERVICE_BIN);
+      protected static string app_path = Environment.find_program_in_path(APP_BIN);
+
+      // Stupid vala...
+      protected async abstract void execute_internal_bin(Match? match);
+      public override async void execute_internal(Match? match)
+      {
+        execute_internal_bin(match);
+      }
+
+      public override bool valid_for_match(Match match)
+      {
+        if (match.match_type == MatchType.APPLICATION)
+        {
+          ApplicationMatch? am = match as ApplicationMatch;
+
+          AppInfo app = am.app_info ??
+                        new DesktopAppInfo.from_filename(am.filename);
+
+          var exe = Environment.find_program_in_path(app.get_executable());
+          if (exe == service_path || exe == app_path)
+            return true;
+        }
+
+        return false;
+      }
+    }
+
+    private class GwibberQueryAction : GwibberAction
+    {
+      private string query;
+      private GwibberAction action;
+
+      public GwibberQueryAction(string query, GwibberAction action) {
+        Object (title: action.title,
+                description: action.description,
+                icon_name: action.icon_name, has_thumbnail: action.has_thumbnail,
+                match_type: action.match_type,
+                default_relevancy: action.default_relevancy);
+
+        this.query = query;
+        this.action = action;
+      }
+
+      public override bool valid_for_match(Match match)
+      {
+        return this.action.valid_for_match(match);
+      }
+
+      public override bool valid_for_query(string query)
+      {
+        return this.action.valid_for_query(query);
+      }
+
+      protected override async void execute_internal(Match? match) {
+        var nm = new DefaultMatch(this.query);
+        nm.match_type = MatchType.UNKNOWN;
+
+        this.action.execute_internal(nm);
+      }
+
+      public override int get_relevancy()
+      {
+        return this.action.get_relevancy();
+      }
+    }
+
+    private class Start : GwibberBinAction
+    {
+      public Start()
+      {
+        Object (title: _ ("Start"),
+                description: _ ("Start Gwibber Service"),
+                icon_name: "gtk-apply", has_thumbnail: false,
+                match_type: MatchType.ACTION,
+                default_relevancy: 150);
+      }
+
+      public async override void execute_internal_bin(Match? match)
+      {
+        if (is_gwibber_running())
+          return;
+
+        try {
+          var conn = DBus.Bus.get(DBus.BusType.SESSION);
+          var service = (GwibberService)conn.get_object(GwibberService.UNIQUE_NAME,
+                                                        GwibberService.OBJECT_PATH,
+                                                        GwibberService.INTERFACE_NAME);
+          yield service.Start();
+        } catch (DBus.Error e) {
+          stderr.printf ("Gwibber is not available.\n%s", e.message);
+        }
+      }
+
+      public override bool valid_for_match(Match match)
+      {
+        if (is_gwibber_running())
+          return false;
+
+        return base.valid_for_match(match);
+      }
+    }
+
+    private class Stop : GwibberBinAction
+    {
+      public Stop()
+      {
+        Object (title: _ ("Stop"),
+                description: _ ("Stop Gwibber Service"),
+                icon_name: "gtk-close", has_thumbnail: false,
+                match_type: MatchType.ACTION,
+                default_relevancy: 150);
+      }
+
+      public override async void execute_internal_bin(Match? match)
+      {
+        if (!is_gwibber_running())
+          return;
+
+        try {
+          var conn = DBus.Bus.get(DBus.BusType.SESSION);
+          var service = (GwibberService)conn.get_object(GwibberService.UNIQUE_NAME,
+                                                        GwibberService.OBJECT_PATH,
+                                                        GwibberService.INTERFACE_NAME);
+          yield service.Quit();
+        } catch (DBus.Error e) {
+          stderr.printf ("Gwibber is not available.\n%s", e.message);
+        }
+      }
+
+      public override bool valid_for_match(Match match)
+      {
+        if (!is_gwibber_running())
+          return false;
+
+        return base.valid_for_match(match);
+      }
+    }
+
+    private class Refresh : GwibberBinAction
+    {
+      public Refresh()
+      {
+        Object (title: _ ("Refresh"),
+                description: _ ("Refresh Gwibber Accounts"),
+                icon_name: "gtk-refresh", has_thumbnail: false,
+                match_type: MatchType.ACTION,
+                default_relevancy: 150);
+      }
+
+      public override async void execute_internal_bin(Match? match)
+      {
+        if (!is_gwibber_running())
+          return;
+
+        try {
+          var conn = DBus.Bus.get(DBus.BusType.SESSION);
+          var service = (GwibberService)conn.get_object(GwibberService.UNIQUE_NAME,
+                                                        GwibberService.OBJECT_PATH,
+                                                        GwibberService.INTERFACE_NAME);
+          yield service.Refresh();
+        } catch (DBus.Error e) {
+          stderr.printf ("Gwibber is not available.\n%s", e.message);
+        }
+      }
+
+      public override bool valid_for_match(Match match)
+      {
+        if (!is_gwibber_running())
+          return false;
+
+        return base.valid_for_match(match);
+      }
+    }
+
+    private class SendMessage : GwibberBinAction
+    {
+      public SendMessage()
+      {
+        Object (title: _ ("Send to Gwibber"),
+                description: _ ("Send Message to Gwibber enabled accounts"),
+                icon_name: "gwibber", has_thumbnail: false,
+                match_type: MatchType.ACTION,
+                default_relevancy: 100);
+      }
+
+      public override async void execute_internal_bin(Match? match)
+      {
+
+        if (!is_gwibber_running() || match.match_type != MatchType.UNKNOWN)
+          return;
+
+        try {
+          var conn = DBus.Bus.get(DBus.BusType.SESSION);
+          var service = (GwibberService)conn.get_object(GwibberService.UNIQUE_NAME,
+                                                        GwibberService.OBJECT_PATH,
+                                                        GwibberService.INTERFACE_NAME);
+          yield service.SendMessage(match.title);
+        } catch (DBus.Error e) {
+          stderr.printf ("Gwibber is not available.\n%s", e.message);
+        }
+      }
+
+      public override bool valid_for_match(Match match)
+      {
+        if (!is_gwibber_running() || match.title.length >  140)
+          return false;
+        
+        return (match.match_type == MatchType.UNKNOWN || base.valid_for_match(match));
+      }
+
+      public override bool valid_for_query(string query)
+      {
+        if (query.length <= 140)
+          return true;
+
+        return false;
+      }
+    }
+
+    public override ResultSet? find_for_match (Query query, Match match)
+    {
+      bool query_empty = query.query_string == "";
+      var results = new ResultSet();
+
+      if (query_empty)
+      {
+        foreach (var action in actions)
+        {
+          if (action.valid_for_match(match))
+          {
+            results.add(action, action.get_relevancy());
+          }
+        }
+      }
+      else
+      {
+        var matchers = Query.get_matchers_for_query(query.query_string, 0,
+          RegexCompileFlags.OPTIMIZE | RegexCompileFlags.CASELESS);
+        foreach (var action in actions)
+        {
+          if (!action.valid_for_match(match)) continue;
+          foreach (var matcher in matchers)
+          {
+            if (action.valid_for_query(query.query_string))
+            {
+              results.add(new GwibberQueryAction(query.query_string, action), matcher.value);
+              break;
+            }
+            else if (matcher.key.match(action.title))
+            {
+              results.add(action, matcher.value);
+              break;
+            }
+          }
+        }
+      }
+      
+      return results;
+    }
+  }
+}

=== modified file 'src/synapse-main.vala'
--- src/synapse-main.vala	2010-12-05 14:20:09 +0000
+++ src/synapse-main.vala	2010-12-05 22:26:27 +0000
@@ -116,6 +116,7 @@
         typeof (ZeitgeistPlugin),
         typeof (HybridSearchPlugin),
         //typeof (LocatePlugin),
+        typeof (GwibberPlugin),
         typeof (GnomeSessionPlugin),
         typeof (GnomeScreenSaverPlugin),
         typeof (UPowerPlugin),