Merge lp:~mhr3/libunity/add-hints-to-activate into lp:libunity

[Michal Hruby]

Add hints parameter to dbus Activate() method

Added hints to the dbus Activate() method, this allows us to pass arbitrary hints when activating a preview action.

[Paweł Stołowski (stolowski)]

Looks good!

review: Approve

[lp:~mhr3/libunity/add-hints-to-activate]

175. By Michal Hruby on 2012-09-04

We're past freezes, make the wire protocol backwards-compatible

=== modified file 'configure.ac'
--- configure.ac	2012-08-30 15:55:52 +0000
+++ configure.ac	2012-09-04 11:43:20 +0000
@@ -1,5 +1,5 @@
 # When releasing also remember to update the soname as instructed below
-AC_INIT(libunity, 5.97.3)
+AC_INIT(libunity, 5.97.4)
 
 AM_INIT_AUTOMAKE(AC_PACKAGE_NAME, AC_PACKAGE_VERSION)
 AM_CONFIG_HEADER(config.h)

=== modified file 'protocol/protocol-lens-interface.vala'
--- protocol/protocol-lens-interface.vala	2012-08-28 13:41:29 +0000
+++ protocol/protocol-lens-interface.vala	2012-09-04 11:43:20 +0000
@@ -72,8 +72,12 @@
 {
   public async abstract void info_request () throws IOError;
 
-  public async abstract ActivationReplyRaw activate (string uri,
-                                               uint action_type) throws IOError;
+  // FIXME: should have the hints param and activate_with_hints should go away
+  public async abstract ActivationReplyRaw activate (
+      string uri, uint action_type) throws IOError;
+
+  public async abstract ActivationReplyRaw activate_with_hints (
+      string uri, uint action_type, HashTable<string, Variant> hints) throws IOError;
 
   public async abstract HashTable<string, Variant> update_preview_property (string uri, HashTable<string, Variant> values) throws IOError;
 

=== modified file 'protocol/protocol-scope-interface.vala'
--- protocol/protocol-scope-interface.vala	2012-08-28 13:41:29 +0000
+++ protocol/protocol-scope-interface.vala	2012-09-04 11:43:20 +0000
@@ -62,7 +62,7 @@
   public abstract async void info_request () throws IOError;
 
   public abstract async ActivationReplyRaw activate (
-      string uri, uint action_type) throws IOError;
+      string uri, uint action_type, HashTable<string, Variant> hints) throws IOError;
 
   public abstract async HashTable<string, Variant> update_preview_property (
       string uri, HashTable<string, Variant> values) throws IOError;

=== modified file 'src/unity-lens-private.vala'
--- src/unity-lens-private.vala	2012-08-30 15:55:52 +0000
+++ src/unity-lens-private.vala	2012-09-04 11:43:20 +0000
@@ -496,6 +496,15 @@
   public async ActivationReplyRaw activate (string uri,
                                             uint action_type) throws IOError
   {
+    var hints = new HashTable<string, Variant> (null, null);
+    var reply = yield activate_with_hints (uri, action_type, hints);
+    return reply;
+  }
+
+  public async ActivationReplyRaw activate_with_hints (
+      string uri, uint action_type,
+      HashTable<string, Variant> hints) throws IOError
+  {
     string[] tokens;
     ScopeProxy? scope = null;
     string? scope_uri = null;
@@ -520,7 +529,7 @@
 
     if (scope is ScopeProxy)
     {
-      raw = yield scope.activate (scope_uri, (ActionType) action_type);
+      raw = yield scope.activate (scope_uri, (ActionType) action_type, hints);
       raw.uri = "%s:%s".printf (uid_for_scope (scope), raw.uri);
     }
     else

=== modified file 'src/unity-previews.vala'
--- src/unity-previews.vala	2012-08-20 14:57:40 +0000
+++ src/unity-previews.vala	2012-09-04 11:43:20 +0000
@@ -82,7 +82,7 @@
 
     _raw.add_action_with_hints (action.id, action.display_name,
                                 action.icon_hint, action.layout_hint,
-                                action.get_hints ());
+                                action.get_hints_internal ());
   }
 
   public void add_info (InfoHint info_hint)
@@ -139,6 +139,10 @@
   public string extra_text { get; set; }
   public Icon? icon_hint { get; construct; }
   public LayoutHint layout_hint { get; construct; }
+  public HashTable<string, Variant>? hints { get { return hints_; } }
+
+  private HashTable<string, Variant> hints_ =
+    new HashTable<string, Variant> (str_hash, str_equal);
 
   public PreviewAction (string id, string display_name, Icon? icon_hint)
   {
@@ -163,14 +167,13 @@
     tuple[1] = display_name;
     tuple[2] = new Variant.string (icon_hint != null ? icon_hint.to_string () : "");
     tuple[3] = (uint) layout_hint;
-    tuple[4] = get_hints ();
+    tuple[4] = get_hints_internal ();
 
     return new Variant.tuple (tuple);
   }
 
-  internal HashTable<string, Variant> get_hints ()
+  internal unowned HashTable<string, Variant> get_hints_internal ()
   {
-    var hints = new HashTable<string, Variant> (str_hash, str_equal);
     if (extra_text != null && extra_text[0] != '\0')
       hints["extra-text"] = extra_text;
 

=== modified file 'src/unity-scope-private.vala'
--- src/unity-scope-private.vala	2012-08-30 15:55:52 +0000
+++ src/unity-scope-private.vala	2012-09-04 11:43:20 +0000
@@ -283,7 +283,8 @@
   }
 
   public async ActivationReplyRaw activate (string uri,
-                                            uint action_type) throws IOError
+                                            uint action_type,
+                                            HashTable<string, Variant> hints) throws IOError
   {
     var reply = ActivationReplyRaw ();
     ActivationResponse? response = null;
@@ -302,7 +303,7 @@
       case ActionType.PREVIEW_ACTION:
         string[] tokens = uri.split (":", 2);
         stripped_uri = tokens[1];
-        response = activate_action (tokens[0], stripped_uri);
+        response = activate_action (tokens[0], stripped_uri, hints);
         break;
       case ActionType.PREVIEW_BUILTIN_ACTION:
         // TODO: implement
@@ -321,7 +322,7 @@
         var new_uri = response.goto_uri;
         if (new_uri == null || new_uri[0] == '\0')
           new_uri = stripped_uri ?? uri;
-        reply = yield activate (new_uri, ActionType.PREVIEW_RESULT);
+        reply = yield activate (new_uri, ActionType.PREVIEW_RESULT, hints);
         return reply;
       }
     }
@@ -584,12 +585,27 @@
     return response;
   }
 
-  public ActivationResponse? activate_action (string action_id, string uri)
+  public ActivationResponse? activate_action (string action_id, string uri,
+                                              HashTable<string, Variant> hints)
   {
     ActivationResponse? response = null;
     var action = _action_map[action_id];
     if (action != null)
+    {
+      var action_hints = action.hints;
+      action_hints.remove_all ();
+      if (hints.size () > 0)
+      {
+        HashTableIter<string, Variant> iter = HashTableIter<string, Variant> (hints);
+        unowned string key;
+        unowned Variant value;
+        while (iter.next (out key, out value))
+        {
+          action_hints[key] = value;
+        }
+      }
       response = action.activated (uri);
+    }
     else
       warning ("Cannot find PreviewAction with id: %s", action_id);
 

=== modified file 'src/unity-scope-proxy-local.vala'
--- src/unity-scope-proxy-local.vala	2012-08-30 15:55:52 +0000
+++ src/unity-scope-proxy-local.vala	2012-09-04 11:43:20 +0000
@@ -86,9 +86,10 @@
   /*
    * Implementation of the ScopeService interface
    */
-  public async ActivationReplyRaw activate (string uri, ActionType action_type)
+  public async ActivationReplyRaw activate (string uri, ActionType action_type,
+                                            HashTable<string, Variant> hints)
   {
-    var reply = yield scope.activate (uri, action_type);
+    var reply = yield scope.activate (uri, action_type, hints);
     return reply;
   }
 

=== modified file 'src/unity-scope-proxy-remote.vala'
--- src/unity-scope-proxy-remote.vala	2012-08-30 15:55:52 +0000
+++ src/unity-scope-proxy-remote.vala	2012-09-04 11:43:20 +0000
@@ -188,12 +188,13 @@
   /*
    * Implementation of the ScopeService interface
    */
-  public async ActivationReplyRaw activate (string uri, ActionType action_type)
+  public async ActivationReplyRaw activate (string uri, ActionType action_type,
+                                            HashTable<string, Variant> hints)
   {
     if (synchronized)
     {
       try {
-        var raw = yield _service.activate (uri, (uint) action_type);
+        var raw = yield _service.activate (uri, (uint) action_type, hints);
         return raw;
       } catch (Error e) {
         warning (@"Unable to search scope ($dbus_path): $(e.message)");

=== modified file 'src/unity-scope-proxy.vala'
--- src/unity-scope-proxy.vala	2012-08-30 15:55:52 +0000
+++ src/unity-scope-proxy.vala	2012-09-04 11:43:20 +0000
@@ -38,7 +38,8 @@
   public abstract Dee.SerializableModel filters_model { get; set; }
 
   public abstract async ActivationReplyRaw activate (string uri,
-                                                     ActionType action_type);
+                                                     ActionType action_type,
+                                                     HashTable<string, Variant> hints);
   public abstract async HashTable<string, Variant> update_preview_property (
       string uri, HashTable<string, Variant> values) throws IOError;
   public abstract async HashTable<string, Variant> search (

=== modified file 'src/unity-scope.vala'
--- src/unity-scope.vala	2012-08-30 15:55:52 +0000
+++ src/unity-scope.vala	2012-09-04 11:43:20 +0000
@@ -192,10 +192,11 @@
   }
 
   internal async Protocol.ActivationReplyRaw activate (string uri,
-      Protocol.ActionType action_type)
+      Protocol.ActionType action_type,
+      HashTable<string, Variant> hints)
   {
     try {
-      var reply = yield _pimpl.activate (uri, action_type);
+      var reply = yield _pimpl.activate (uri, action_type, hints);
       return reply;
     } catch (Error e) {
       warning (@"Unable to activate scope: $(e.message)");

=== modified file 'test/vala/test-lens.vala'
--- test/vala/test-lens.vala	2012-08-30 15:55:52 +0000
+++ test/vala/test-lens.vala	2012-09-04 11:43:20 +0000
@@ -58,6 +58,7 @@
     Test.add_data_func ("/Unit/Lens/Preview/Async", test_lens_preview_async);
     Test.add_data_func ("/Unit/Lens/Preview/Signal", test_lens_preview_signal);
     Test.add_data_func ("/Unit/Lens/Preview/ClosedSignal", test_lens_preview_closed_signal);
+    Test.add_data_func ("/Unit/Lens/Preview/ActionWithHints", test_lens_preview_action_with_hint);
     Test.add_data_func ("/Unit/Lens/PrivateContentFlag", test_lens_private_content_flag);
     Test.add_data_func ("/Unit/Lens/HomeLensDefaultName", test_lens_home_lens_default_name);
 
@@ -209,9 +210,30 @@
   private static void call_lens_activate (string uri, uint action_type,
                                           Func<Variant?>? cb = null)
   {
-    var parameters = new Variant ("(su)", uri, action_type);
-
-    call_lens_method ("Activate", parameters, cb);
+    call_lens_activate_with_hints (uri, action_type,
+                                   new HashTable<string, Variant> (null, null),
+                                   cb);
+  }
+
+  private static void call_lens_activate_with_hints (
+      string uri, uint action_type, HashTable<string, Variant> hints,
+      Func<Variant?>? cb = null)
+  {
+    Variant parameters;
+    // let's make sure we test both variants, since we have to support them
+    if (hints.size () > 0)
+    {
+      Variant ht = hints;
+      parameters = new Variant ("(su@a{sv})", uri, action_type, ht);
+
+      call_lens_method ("ActivateWithHints", parameters, cb);
+    }
+    else
+    {
+      parameters = new Variant ("(su)", uri, action_type);
+
+      call_lens_method ("Activate", parameters, cb);
+    }
   }
 
   private static void call_lens_update_preview_property (string uri, HashTable<string, Variant> props,
@@ -1068,6 +1090,72 @@
     assert (got_closed_signal == 1);
   }
 
+  public static void test_lens_preview_action_with_hint ()
+  {
+    SignalWrapper[] signals = null;
+    assert (local_scope != null);
+
+    var ml = new MainLoop ();
+
+    bool got_preview_uri_signal = false;
+    bool got_activated_signal = false;
+
+    var preview = new Unity.GenericPreview ("title", "description", null);
+    var action = new Unity.PreviewAction ("button1", "Do stuff!", null);
+    preview.add_action (action);
+
+    signals += new SignalWrapper (action,
+      action.activated.connect ((uri) =>
+    {
+      got_activated_signal = true;
+      assert (action.hints["passing-extra-info"].get_boolean () == true);
+      return null;
+    }));
+
+    // this signal handler gets called when activate is called with PREVIEW_RESULT
+    signals += new SignalWrapper (local_scope,
+      local_scope.preview_uri.connect ((uri) =>
+    {
+      assert (uri == "scheme://local/");
+      got_preview_uri_signal = true;
+      return preview;
+    }));
+
+    ml = new MainLoop ();
+
+    var lens_results_model =
+      exported_lens.get_model_internal (0) as Dee.SharedModel;
+    var iter = lens_results_model.get_first_iter ();
+    var mangled_uri = lens_results_model.get_string (iter, 0);
+
+    Unity.Protocol.Preview? reconstructed = null;
+    call_lens_activate (mangled_uri, Unity.Protocol.ActionType.PREVIEW_RESULT, (reply) =>
+    {
+      var v = reply.get_child_value (0);
+      Unity.Protocol.ActivationReplyRaw reply_struct =
+        (Unity.Protocol.ActivationReplyRaw) v;
+      reconstructed = Unity.Protocol.Preview.parse (reply_struct.hints["preview"]);
+      ml.quit ();
+    });
+    run_with_timeout (ml, 5000);
+
+    assert (reconstructed != null);
+
+    ml = new MainLoop ();
+
+    // activate the action, check that hints are passed to it
+    var hints = new HashTable<string, Variant> (str_hash, str_equal);
+    hints["passing-extra-info"] = new Variant.boolean (true);
+    call_lens_activate_with_hints ("%s:%s".printf (action.id, mangled_uri), Unity.Protocol.ActionType.PREVIEW_ACTION, hints, (reply) =>
+    {
+      ml.quit ();
+    });
+
+    run_with_timeout (ml, 5000);
+
+    assert (got_activated_signal);
+  }
+
   public static void test_lens_private_content_flag ()
   {
     assert (local_scope != null);