Merge lp:~tintou/switchboard/preference-specification into lp:~elementary-pantheon/switchboard/switchboard

[Corentin Noël]

Now implements the settings:// scheme so that apps can use the scheme instead of relying on switchboard directly

[Corentin Noël (tintou)]

FYI the specification is here https://docs.google.com/document/d/1N0uqNtVXEFn3cLgNMeN75mP_dpMpCco-7uw5PKow-_Q/edit#

[lp:~tintou/switchboard/preference-specification]

687. By Corentin Noël on 2016-10-30

Now implements the settings:// scheme so that apps can use the scheme instead of relying on switchboard directly

[Danielle Foré (danrabbit)]

I'm not sure if I agree that maintaining a gsettings key is the best way to do this. I think we want to extend the plug API so that plugs can add uris here. Otherwise it kind of hurts the modularity of switchboard doesn't it? If a user decides to replace a default pane, the uri scheme would break

[Corentin Noël (tintou)]

A casual user won't change the GSettings key so it will remain unassign and will be able to be updated. I think it's more something that is up to the distribution than to the user so GSettings are easy to override…

[lp:~tintou/switchboard/preference-specification]

688. By Corentin Noël on 2016-11-02

Extend the Plug API so that each plug can provide an interface of the preference specification

[Danielle Foré (danrabbit)]

I can confirm that this branch works as intended with panes being able to extend the URL API.

I can also confirm that it does not break the old API.

The only question I have is regarding adding the scheme handler line to mimeapps.list (x-scheme-handler/settings=switchboard.desktop). I think we probably want a comment from Cody about if that should be set by switchboard or if we're setting it in our OS defaults packages.

review: Approve

=== modified file 'data/switchboard.desktop.in'
--- data/switchboard.desktop.in	2016-08-02 18:13:33 +0000
+++ data/switchboard.desktop.in	2016-11-02 00:25:52 +0000
@@ -2,13 +2,13 @@
 Type=Application
 _Name=System Settings
 _Comment=Change system and user settings
-Exec=switchboard
+Exec=switchboard %u
 Icon=preferences-desktop
 Terminal=false
+StartupNotify=true
 Categories=GNOME;GTK;System;
-X-GNOME-Keywords=Center;Control;Panel;Preferences;System;
-X-AppInstall-Keywords=Center;Control;Panel;Preferences;System;
-X-GNOME-Gettext-Domain=switchboard
+_Keywords=Center;Control;Panel;Preferences;System;
+MimeType=x-scheme-handler/settings;
 Actions=AboutDialog;
 
 [Desktop Action AboutDialog]

=== modified file 'lib/Plug.vala'
--- lib/Plug.vala	2014-11-04 23:12:02 +0000
+++ lib/Plug.vala	2016-11-02 00:25:52 +0000
@@ -19,7 +19,6 @@
  */
 
 public abstract class Switchboard.Plug : GLib.Object {
-    
     public enum Category {
         PERSONAL = 0,
         HARDWARE = 1,
@@ -64,9 +63,16 @@
     public string icon { get; construct; }
     
     /**
+     * A map of settings:// endpoints and location to pass to the
+     * {@link search_callback} method if the value is not %NULL.
+     * For example {"input/keyboard", "keyboard"}.
+     */
+    public Gee.TreeMap<string, string?> supported_settings { get; construct; default = new Gee.TreeMap<string, string?> (null, null); }
+    
+    /**
      * Inform if the plug should be shown or not
      */
-    public bool can_show { get; set; default=true;}
+    public bool can_show { get; set; default=true; }
     
     /**
      * Inform the application that the plug can now be listed in the available plugs
@@ -108,4 +114,4 @@
      * @param location a {@link string} that represents the setting to show.
      */
     public abstract void search_callback (string location);
-}
\ No newline at end of file
+}

=== modified file 'po/extra/extra.pot'
--- po/extra/extra.pot	2016-08-02 18:14:32 +0000
+++ po/extra/extra.pot	2016-11-02 00:25:52 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2016-08-02 11:13-0700\n"
+"POT-Creation-Date: 2016-10-30 15:50+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -23,6 +23,9 @@
 msgid "Change system and user settings"
 msgstr ""
 
+msgid "Center;Control;Panel;Preferences;System;"
+msgstr ""
+
 msgid "About System Settings"
 msgstr ""
 

=== modified file 'po/switchboard.pot'
--- po/switchboard.pot	2016-08-02 18:14:32 +0000
+++ po/switchboard.pot	2016-11-02 00:25:52 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2016-08-02 11:13-0700\n"
+"POT-Creation-Date: 2016-10-30 15:50+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -45,38 +45,30 @@
 msgid "All Settings"
 msgstr ""
 
-#: ../src/Switchboard.vala:67
+#: ../src/Switchboard.vala:68
 msgid "Open a plug"
 msgstr ""
 
-#: ../src/Switchboard.vala:73
+#: ../src/Switchboard.vala:74
 msgid "System Settings"
 msgstr ""
 
-#: ../src/Switchboard.vala:86
+#: ../src/Switchboard.vala:87
 msgid "translator-credits"
 msgstr ""
 
-#: ../src/Switchboard.vala:322
+#: ../src/Switchboard.vala:117
+msgid "Specified link '%s' does not exist, going back to the main panel"
+msgstr ""
+
+#: ../src/Switchboard.vala:327
 msgid "No Settings Found"
 msgstr ""
 
-#: ../src/Switchboard.vala:322
+#: ../src/Switchboard.vala:327
 msgid "Install some and re-launch Switchboard."
 msgstr ""
 
-#: ../src/Switchboard.vala:445
+#: ../src/Switchboard.vala:450
 msgid "Search Settings"
 msgstr ""
-
-#: ../src/Switchboard.vala:582
-msgid "Change system and user settings"
-msgstr ""
-
-#: ../src/Switchboard.vala:583
-msgid "Center;Control;Panel;Preferences;System;"
-msgstr ""
-
-#: ../src/Switchboard.vala:584
-msgid "About System Settings"
-msgstr ""

=== modified file 'sample/SamplePlug.vala'
--- sample/SamplePlug.vala	2014-11-04 23:12:02 +0000
+++ sample/SamplePlug.vala	2016-11-02 00:25:52 +0000
@@ -19,23 +19,26 @@
  */
 
 public class Sample.Plug : Switchboard.Plug {
-
     private Gtk.Grid main_grid;
+    private Gtk.Label hello_label;
 
     public Plug () {
         Object (category: Category.SYSTEM,
                 code_name: "sample-plug",
                 display_name: _("Sample Plug"),
                 description:_("Does nothing, but it is cool !"),
-                icon: "system-run");
+                icon: "system-run",
+                supported_settings: new Gee.TreeMap<string, string?> (null, null));
+        supported_settings.set ("wallpaper", null);
     }
-    
+
     public override Gtk.Widget get_widget () {
         if (main_grid == null) {
             main_grid = new Gtk.Grid ();
-            var hello_label = new Gtk.Label ("Hello World!");
+            hello_label = new Gtk.Label ("Hello World!");
             main_grid.attach (hello_label, 0, 0, 1, 1);
         }
+
         main_grid.show_all ();
         return main_grid;
     }
@@ -49,7 +52,7 @@
     }
     
     public override void search_callback (string location) {
-    
+        hello_label.label = "Callback : %s".printf (location);
     }
     
     // 'search' returns results like ("Keyboard → Behavior → Duration", "keyboard<sep>behavior")
@@ -62,4 +65,4 @@
     debug ("Activating Sample plug");
     var plug = new Sample.Plug ();
     return plug;
-}
\ No newline at end of file
+}

=== modified file 'schemas/org.pantheon.switchboard.gschema.xml'
--- schemas/org.pantheon.switchboard.gschema.xml	2016-05-12 18:04:05 +0000
+++ schemas/org.pantheon.switchboard.gschema.xml	2016-11-02 00:25:52 +0000
@@ -4,7 +4,7 @@
 		<value nick="Normal" value="0" />
 		<value nick="Maximized" value="1" />
 	</enum>
-	<schema path="/org/pantheon/switchboard/saved-state/" id="org.pantheon.switchboard.saved-state" gettext-domain="switchboard">
+	<schema path="/org/pantheon/switchboard/saved-state/" id="org.pantheon.switchboard.saved-state">
 		<key name="window-state" enum="switchboard-window-states">
 			<default>"Normal"</default>
 			<summary>The saved state of the window.</summary>
@@ -26,4 +26,11 @@
 			<description>The position of the window.</description>
 		</key>
 	</schema>
+	<schema path="/org/pantheon/switchboard/preferences/" id="org.pantheon.switchboard.preferences">
+		<key name="mapping-override" type="a{s(ss)}">
+			<default>{}</default>
+			<summary>Override (and extends) the default mapping with plugs</summary>
+			<description>Contains a dictionary of path and two strings: the plug name and an argument. For example {'wallpaper': ('foo-desktop','wallpaper'), 'display': ('bar-display','')}</description>
+		</key>
+	</schema>
 </schemalist>

=== modified file 'src/Switchboard.vala'
--- src/Switchboard.vala	2016-09-26 03:03:59 +0000
+++ src/Switchboard.vala	2016-11-02 00:25:52 +0000
@@ -54,6 +54,7 @@
 
         private static string? plug_to_open = null;
         private static string? open_window  = null;
+        private static string? link  = null;
         private static bool opened_directly = false;
         private static bool should_animate_next_transition = true;
         private const uint[] NAVIGATION_KEYS = {
@@ -64,18 +65,13 @@
             Gdk.Key.Return
         };
 
-        const OptionEntry[] entries = {
-            { "open-plug", 'o', 0, OptionArg.STRING, ref plug_to_open, N_("Open a plug"), "PLUG_NAME" },
-            { null }
-        };
-
         construct {
             application_id = "org.elementary.switchboard";
             program_name = _("System Settings");
             app_years = "2011-2016";
             exec_name = "switchboard";
             app_launcher = exec_name+".desktop";
-            flags |= ApplicationFlags.HANDLES_COMMAND_LINE;
+            flags |= ApplicationFlags.HANDLES_OPEN;
 
             build_version = "2.0";
             app_icon = "preferences-desktop";
@@ -85,13 +81,21 @@
             translate_url = "https://translations.launchpad.net/switchboard";
             about_authors = {"Avi Romanoff <[e-mail]>", "Corentin Noël <[e-mail]>", null};
             about_translators = _("translator-credits");
-    
             about_license_type = Gtk.License.GPL_3_0;
+
+            if (GLib.AppInfo.get_default_for_uri_scheme ("settings") == null) {
+                var appinfo = new GLib.DesktopAppInfo (app_launcher);
+                try {
+                    appinfo.set_as_default_for_type ("x-scheme-handler/settings");
+                } catch (Error e) {
+                    critical ("Unable to set default for the settings scheme: %s", e.message);
+                }
+            }
         }
 
         public static SwitchboardApp _instance = null;
 
-        public static SwitchboardApp instance {
+        public static unowned SwitchboardApp instance {
             get {
                 if (_instance == null)
                     _instance = new SwitchboardApp ();
@@ -99,74 +103,85 @@
             }
         }
 
-        public override int command_line (ApplicationCommandLine command_line) {
-            hold ();
-            int res = _command_line (command_line);
-            release ();
-            return res;
+        public override void open (File[] files, string hint) {
+            var file = files[0];
+            if (file == null) {
+                return;
+            }
+
+            if (file.get_uri_scheme () == "settings") {
+                link = file.get_uri ().replace ("settings://", "");
+                if (link.has_suffix ("/")) {
+                    link = link.substring (0, link.last_index_of_char ('/'));
+                }
+
+            } else {
+                warning ("Calling Switchboard directly is deprecated, please use the settings:// scheme instead");
+                var name = file.get_basename ();
+                if (":" in name) {
+                    var parts = name.split (":");
+                    plug_to_open = gcc_to_switchboard_code_name (parts[0]);
+                    open_window  = parts[1];
+                } else {
+                    plug_to_open = gcc_to_switchboard_code_name (name);
+                }
+            }
+
+            activate ();
         }
 
-        private int _command_line (ApplicationCommandLine command_line) {
-            var context = new OptionContext ("");
-            context.add_main_entries (entries, "switchboard ");
-            context.add_group (Gtk.get_option_group (true));
-
-            string[] args = command_line.get_arguments ();
-
-            try {
-                unowned string[] tmp = args;
-                context.parse (ref tmp);
-
-                // we have an unparsed argument. Assume that it's a gcc plug name
-                if (tmp.length > 1) {
-                    if (":" in tmp[1]) {
-                        var parts = tmp[1].split (":");
-                        plug_to_open = gcc_to_switchboard_code_name (parts[0]);
-                        open_window  = parts[1];
-                    } else {
-                        plug_to_open = gcc_to_switchboard_code_name (tmp[1]);
+        public override void activate () {
+            var plugsmanager = Switchboard.PlugsManager.get_default ();
+            var setting = new Settings ("org.pantheon.switchboard.preferences");
+            var mapping_dic = setting.get_value ("mapping-override");
+            if (link != null && !mapping_dic.lookup (link, "(ss)", ref plug_to_open, ref open_window)) {
+                bool plug_found = false;
+                foreach (var plug in plugsmanager.get_plugs ()) {
+                    if (plug.supported_settings == null)
+                        continue;
+
+                    if (plug.supported_settings.has_key (link)) {
+                        load_plug (plug);
+                        open_window = plug.supported_settings.get (link);
+                        link = null;
+
+                        // If plug_to_open was set from the command line
+                        should_animate_next_transition = false;
+                        opened_directly = true;
+                        plug_found = true;
+                        break;
                     }
                 }
-            } catch (Error e) {
-                warning (e.message);
-                return 0;
-            }
-
-            if (DEBUG)
-                Granite.Services.Logger.DisplayLevel = Granite.Services.LogLevel.DEBUG;
-            else
-                Granite.Services.Logger.DisplayLevel = Granite.Services.LogLevel.INFO;
-
-            if (plug_to_open != null) {
-                var plugsmanager = Switchboard.PlugsManager.get_default ();
+
+                if (!plug_found) {
+                    warning (_("Specified link '%s' does not exist, going back to the main panel").printf (link));
+                }
+            } else if (plug_to_open != null) {
                 foreach (var plug in plugsmanager.get_plugs ()) {
                     if (plug_to_open.has_suffix (plug.code_name)) {
                         load_plug (plug);
                         plug_to_open = null;
+
+                        // If plug_to_open was set from the command line
+                        should_animate_next_transition = false;
+                        opened_directly = true;
                         break;
                     }
                 }
-
-                // If plug_to_open was set from the command line
-                should_animate_next_transition = false;
-                opened_directly = true;
             }
 
             // If app is already running, present the current window.
-            if (get_windows () != null) {
+            if (get_windows ().length () > 0) {
                 get_windows ().data.present ();
-                return 1;
+                return;
             }
 
             loaded_plugs = new Gee.LinkedList <string> ();
             previous_plugs = new Gee.ArrayList <Switchboard.Plug> ();
-            Switchboard.PlugsManager.get_default ();
             settings = new GLib.Settings ("org.pantheon.switchboard.saved-state");
             build ();
             category_view.load_default_plugs.begin ();
             Gtk.main ();
-
-            return 0;
         }
 
         public void hide_alert () {
@@ -591,9 +606,3 @@
     }
 }
 
-#if TRANSLATION
-_("Change system and user settings");
-_("Center;Control;Panel;Preferences;System;");
-_("About System Settings");
-#endif
-