Merge lp:~jeremy-munsch/synapse-project/steam-plugin into lp:synapse-project

[Jeremy Munsch]

add steam plugin for games search and action providers
no dependencies

[lp:~jeremy-munsch/synapse-project/steam-plugin]

634. By Rico Tzschichholz on 2015-11-30

ui/controller: Some optimization accessing model.query[] in search*()

635. By Rico Tzschichholz on 2015-11-30

core/query: Cache and reuse Regex.escape_string (query)

636. By Rico Tzschichholz on 2015-11-30

debian: Bump build-deps accordingly

637. By Rico Tzschichholz on 2016-02-26

plugins: Add suport for MATE Screensaver

638. By Rico Tzschichholz on 2016-02-26

po: Update translations

639. By Rico Tzschichholz on 2016-02-27

desktop-file-plugin: correct ApplicationsMatch to DesktopFileMatch

640. By Rico Tzschichholz on 2016-02-27

src: Drop "using Gee;"

641. By Rico Tzschichholz on 2016-02-27

src: Drop "using Json;"

642. By Rico Tzschichholz on 2016-02-27

src: Drop "using Zeitgeist;"

643. By Rico Tzschichholz on 2016-02-27

src: Drop "using Gtk;"

644. By Rico Tzschichholz on 2016-02-27

src: Drop "using Cairo;"

645. By Rico Tzschichholz on 2016-02-27

src: Drop last usages of "using *;"

646. By Rico Tzschichholz on 2016-02-27

ui: Show release-name in about-dialog only

647. By Rico Tzschichholz on 2016-02-27

ui: Bump to 2016

648. By Rico Tzschichholz on 2016-02-28

Release 0.2.99.2

649. By Rico Tzschichholz on 2016-03-02

ui: Set and update client-window of Gtk.IMMulticontext

650. By Rico Tzschichholz on 2016-03-08

main: Properly construct OptionEntry

Stop using an empty string where is getting treated as translateable.

651. By Michael Aquilina on 2016-04-01

Add pass plugin

652. By Rico Tzschichholz on 2016-09-29

Fix non-matching generic types

653. By Rico Tzschichholz on 2016-10-06

Fix non-matching generic types of interface implementations

654. By Jeremy Munsch on 2016-12-16

add steam plugin

Unmerged revisions

654. By Jeremy Munsch on 2016-12-16

add steam plugin

=== modified file 'src/plugins/Makefile.am'
--- src/plugins/Makefile.am	2016-04-01 05:58:51 +0000
+++ src/plugins/Makefile.am	2016-12-16 20:48:59 +0000
@@ -53,6 +53,7 @@
 	test-slow-plugin.vala \
 	xnoise-media-player-plugin.vala \
 	system-management.vala \
+	steam-plugin.vala \
 	zeal-plugin.vala \
 	$(NULL)
 

=== added file 'src/plugins/steam-plugin.vala'
--- src/plugins/steam-plugin.vala	1970-01-01 00:00:00 +0000
+++ src/plugins/steam-plugin.vala	2016-12-16 20:48:59 +0000
@@ -0,0 +1,237 @@
+/*
+ * Copyright (C) 2015 Jérémy Munsch <[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
+{
+  public class SteamPlugin : Object, Activatable, ItemProvider, ActionProvider
+  {
+    public bool enabled { get; set; default = true; }
+
+    public static string steam_games_dir { get; private set; default = ".steam/SteamApps"; }
+
+    private Gee.List<SteamGameMatch> games;
+    private Gee.List<SteamAction> actions;
+
+    public void activate ()
+    {
+      parse_steam_games.begin ();
+    }
+
+    public void deactivate ()
+    {
+    }
+
+    static void register_plugin ()
+    {
+      PluginRegistry.get_default ().register_plugin (
+        typeof (SteamPlugin),
+        _("Steam"),
+        _("Browse and launch your steam games"),
+        "steam",
+        register_plugin,
+        Environment.find_program_in_path ("steam") != null,
+        _("Unable to find \"steam\" program")
+      );
+    }
+
+    static construct
+    {
+      register_plugin ();
+      steam_games_dir = Path.build_filename (Environment.get_home_dir (), steam_games_dir);
+    }
+
+    construct
+    {
+      games = new Gee.ArrayList<SteamGameMatch> ();
+      actions = new Gee.ArrayList<SteamAction> ();
+      actions.add (new SteamAction (_("Start game"), _("Launch the game through Steam"), "steam steam://rungameid/%s", MatchScore.HIGHEST));
+      actions.add (new SteamAction (_("Open store"), _("Go to the game store"), "steam steam://store/%s"));
+      actions.add (new SteamAction (_("Open newspage"), _("Go to the game newspage"), "steam steam://appnews/%s"));
+      actions.add (new SteamAction (_("Check system requirement"), _("Check if the system meets the game requirement"), "steam steam://checksysreqs/%s"));
+      actions.add (new SteamAction (_("Backup"), _("Launch the backup wizard"), "steam steam://backup/%s"));
+    }
+
+    public bool handles_query (Query query)
+    {
+      return (QueryFlags.APPLICATIONS in query.query_type);
+    }
+
+    public async ResultSet? search (Query q) throws SearchError
+    {
+      var results = new ResultSet ();
+
+      var matchers = Query.get_matchers_for_query (q.query_string, MatcherFlags.NO_FUZZY,  RegexCompileFlags.OPTIMIZE | RegexCompileFlags.CASELESS);
+      foreach (var matcher in matchers)
+      {
+        foreach (var game in games)
+        {
+          q.check_cancellable ();
+          if (matcher.key.match (game.title))
+            results.add (game, matcher.value);
+        }
+      }
+      return results;
+    }
+
+    public ResultSet? find_for_match (ref Query q, Match match)
+    {
+      if (!actions[0].valid_for_match (match))
+        return null;
+
+      var matchers = Query.get_matchers_for_query (q.query_string, 0,  RegexCompileFlags.OPTIMIZE | RegexCompileFlags.CASELESS);
+
+      var results = new ResultSet ();
+      foreach (var matcher in matchers)
+      {
+        foreach (var action in actions)
+        {
+          if (matcher.key.match (action.title))
+            results.add (action, matcher.value + action.default_relevancy);
+        }
+      }
+      return results;
+    }
+
+
+    /**
+     * Actions
+     */
+
+    private class SteamAction : Action
+    {
+      public string command { get; set; }
+
+      public SteamAction (string title, string description, string command, int default_relevancy = MatchScore.AVERAGE)
+      {
+        Object (title: title,
+                description: description,
+                icon_name: "steam",
+                has_thumbnail: false);
+        this.command = command;
+        this.default_relevancy = default_relevancy;
+      }
+
+      public override bool valid_for_match (Match match)
+      {
+        return (match is SteamGameMatch);
+      }
+
+      public override void do_execute (Match match, Match? target = null)
+      {
+        string cmd = command.printf (((SteamGameMatch)match).app_id);
+        try
+        {
+          AppInfo ai = AppInfo.create_from_commandline (cmd, "steam", 0);
+          if (!ai.launch (null, null))
+            warning ("Could not launch Steam %s".printf (cmd));
+        }
+        catch (Error err)
+        {
+          warning ("Could not launch %s %s", cmd, err.message);
+        }
+      }
+    }
+
+
+    /**
+     * Match
+     */
+
+    private class SteamGameMatch : Match
+    {
+      public string app_id { get; set; }
+      public string name { get; set; }
+
+      public SteamGameMatch (string app_id, string name)
+      {
+        Gtk.IconTheme icon_theme = Gtk.IconTheme.get_default ();
+        Gtk.IconInfo? icon_info = icon_theme.lookup_icon ("steam_icon_%s".printf (app_id), 48, 0);
+
+        Object (title: "Steam %s".printf (name),
+                description : "",
+                icon_name: icon_info != null ? "steam_icon_%s".printf (app_id) : "steam",
+                has_thumbnail: false);
+        this.app_id = app_id;
+        this.name = name;
+      }
+    }
+
+
+    /**
+     * private methods
+     */
+
+    private async void parse_steam_games ()
+    {
+      try
+      {
+        File steam_apps = File.new_for_path (steam_games_dir);
+
+        FileEnumerator enumerator = steam_apps.enumerate_children (
+        "standard::*",
+        FileQueryInfoFlags.NOFOLLOW_SYMLINKS);
+
+        FileInfo info = null;
+        while ((info = enumerator.next_file ()) != null)
+        {
+          Idle.add_full (Priority.DEFAULT_IDLE, parse_steam_games.callback);
+          yield;
+          if (info.get_file_type () == FileType.REGULAR && Regex.match_simple ("appmanifest_[0-9]*.acf", info.get_name ()))
+          {
+            try
+            {
+              string app_id = null, app_name = null;
+
+              File file = File.new_for_path (Path.build_filename (steam_games_dir, info.get_name ()));
+
+              FileInputStream @is = file.read ();
+              DataInputStream dis = new DataInputStream (@is);
+              string line;
+
+              while ((line = dis.read_line ()) != null) {
+                if (null == app_id && -1 != line.index_of ("\"appid\""))
+                  app_id = (new Regex ("(?:\t* *\"[a-zA-Z]+\"\t)|\"|\t")).replace (line, line.length, 0, "").strip ();
+                if (null == app_name && -1 != line.index_of ("\"name\""))
+                  app_name = (new Regex ("(?:\t* *\"[a-zA-Z]+\"\t)|\"|\t")).replace (line, line.length, 0, "").strip ();
+                if (null != app_id && null != app_name)
+                  break;
+              }
+
+              if (null == app_id && null == app_name)
+              {
+                message ("Was not able to parse Steam app manifest %s".printf (Path.build_filename (steam_games_dir, info.get_name ())));
+                break;
+              }
+
+              games.add (new SteamGameMatch (app_id, app_name));
+            }
+            catch (Error e)
+            {
+              warning ("%s", e.message);
+            }
+          }
+        }
+      }
+      catch (Error e)
+      {
+        warning ("%s".printf (e.message));
+      }
+    }
+  }
+}

=== modified file 'src/ui/synapse-main.vala'
--- src/ui/synapse-main.vala	2016-04-01 05:58:51 +0000
+++ src/ui/synapse-main.vala	2016-12-16 20:48:59 +0000
@@ -176,6 +176,7 @@
         typeof (PidginPlugin),
         typeof (PassPlugin),
         typeof (ChatActions),
+        typeof (SteamPlugin),
         typeof (ZealPlugin),
 #if HAVE_ZEITGEIST
         typeof (ZeitgeistPlugin),