Merge lp:~mhr3/unity/pass-extra-hints-for-perform-action into lp:unity

[Michal Hruby]

Make sure we can pass extra hints when activating preview actions

Make sure we can pass extra hints when activating preview actions. This also adds compability with latest changes in libunity.

Added tests for the issue.

The related libunity branch is @ https://code.launchpad.net/~mhr3/libunity/add-hints-to-activate/+merge/122538

[Nick Dedekind (nick-dedekind)]

LGTM

Only comment is that it would be better if you could use the Hints typedef in dash::Preview::PerformAction.

161 + void PerformAction(std::string const& id,
162 + std::map<std::string, glib::Variant> const& hints =
163 + std::map<std::string, glib::Variant>()) const;

review: Approve

[Michal Hruby (mhr3)]

> LGTM
>
> Only comment is that it would be better if you could use the Hints typedef in
> dash::Preview::PerformAction.
>

Wanted to, but it's defined in Lens.h, which includes Previews, so there'd be a circular dependency... :(

[Unity Merger (unity-merger)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Paweł Stołowski (stolowski)]

Looking good.

review: Approve

=== modified file 'UnityCore/Lens.cpp'
--- UnityCore/Lens.cpp	2012-08-31 14:36:57 +0000
+++ UnityCore/Lens.cpp	2012-09-04 15:18:19 +0000
@@ -89,7 +89,8 @@
   void ActivationReply(GVariant* parameters);
   void Preview(std::string const& uri);
   void ActivatePreviewAction(std::string const& action_id,
-                             std::string const& uri);
+                             std::string const& uri,
+                             Hints const& hints);
   void SignalPreview(std::string const& preview_uri,
                      glib::Variant const& preview_update,
                      glib::DBusProxy::ReplyCallback reply_cb);
@@ -499,6 +500,7 @@
                             &b),
               sigc::mem_fun(this, &Lens::Impl::OnGlobalSearchFinished),
               global_search_cancellable_);
+
   g_variant_builder_clear(&b);
 }
 
@@ -608,7 +610,8 @@
 }
 
 void Lens::Impl::ActivatePreviewAction(std::string const& action_id,
-                                       std::string const& uri)
+                                       std::string const& uri,
+                                       Hints const& hints)
 {
   LOG_DEBUG(logger) << "Activating action '" << action_id << "' on  '" << id_ << "'";
 
@@ -622,10 +625,35 @@
   activation_uri += ":";
   activation_uri += uri;
 
-  proxy_->Call("Activate",
-               g_variant_new("(su)", activation_uri.c_str(),
-                             UNITY_PROTOCOL_ACTION_TYPE_PREVIEW_ACTION),
-               sigc::mem_fun(this, &Lens::Impl::ActivationReply));
+  if (hints.empty())
+  {
+    // FIXME: we should really be using the (sua{sv}) method all the time,
+    // but we're past freezes and having to logout and back in is
+    // too big of a deal after beta freeze
+    proxy_->Call("Activate",
+                 g_variant_new("(su)", activation_uri.c_str(),
+                               UNITY_PROTOCOL_ACTION_TYPE_PREVIEW_ACTION),
+                 sigc::mem_fun(this, &Lens::Impl::ActivationReply));
+  }
+  else
+  {
+    GVariantBuilder b;
+    g_variant_builder_init(&b, G_VARIANT_TYPE("a{sv}"));
+
+    for (auto it = hints.begin(); it != hints.end(); ++it)
+    {
+      GVariant* variant = it->second;
+      g_variant_builder_add(&b, "{sv}", it->first.c_str(), variant);
+    }
+
+    proxy_->Call("ActivateWithHints",
+                 g_variant_new("(sua{sv})", activation_uri.c_str(),
+                               UNITY_PROTOCOL_ACTION_TYPE_PREVIEW_ACTION,
+                               &b),
+                 sigc::mem_fun(this, &Lens::Impl::ActivationReply));
+
+    g_variant_builder_clear(&b);
+  }
 }
 
 void Lens::Impl::SignalPreview(std::string const& preview_uri,
@@ -877,9 +905,10 @@
 }
 
 void Lens::ActivatePreviewAction(std::string const& action_id,
-                                 std::string const& uri)
+                                 std::string const& uri,
+                                 Hints const& hints)
 {
-  pimpl->ActivatePreviewAction(action_id, uri);
+  pimpl->ActivatePreviewAction(action_id, uri, hints);
 }
 
 void Lens::SignalPreview(std::string const& uri,

=== modified file 'UnityCore/Lens.h'
--- UnityCore/Lens.h	2012-08-30 16:14:40 +0000
+++ UnityCore/Lens.h	2012-09-04 15:18:19 +0000
@@ -86,7 +86,8 @@
   virtual void Activate(std::string const& uri);
   virtual void Preview(std::string const& uri);
   virtual void ActivatePreviewAction(std::string const& action_id,
-                                     std::string const& uri);
+                                     std::string const& uri,
+                                     Hints const& hints);
   virtual void SignalPreview(std::string const& uri,
       glib::Variant const& preview_update,
       glib::DBusProxy::ReplyCallback reply_cb = nullptr);

=== modified file 'UnityCore/Preview.cpp'
--- UnityCore/Preview.cpp	2012-08-20 10:53:00 +0000
+++ UnityCore/Preview.cpp	2012-09-04 15:18:19 +0000
@@ -262,11 +262,11 @@
   }
 }
 
-void Preview::PerformAction(std::string const& id) const
+void Preview::PerformAction(std::string const& id, Lens::Hints const& hints) const
 {
   if (pimpl->parent_lens_)
   {
-    pimpl->parent_lens_->ActivatePreviewAction(id, preview_uri);
+    pimpl->parent_lens_->ActivatePreviewAction(id, preview_uri, hints);
   }
   else
   {

=== modified file 'UnityCore/Preview.h'
--- UnityCore/Preview.h	2012-08-20 10:25:17 +0000
+++ UnityCore/Preview.h	2012-09-04 15:18:19 +0000
@@ -112,7 +112,9 @@
   ActionPtrList GetActions() const;
   InfoHintPtrList GetInfoHints() const;
 
-  void PerformAction(std::string const& id) const;
+  void PerformAction(std::string const& id,
+                     std::map<std::string, glib::Variant> const& hints =
+                     std::map<std::string, glib::Variant>()) const;
   void EmitClosed() const;
 
 protected:

=== modified file 'tests/test_lens.cpp'
--- tests/test_lens.cpp	2012-08-28 12:23:15 +0000
+++ tests/test_lens.cpp	2012-09-04 15:18:19 +0000
@@ -273,6 +273,47 @@
   Utils::WaitUntil(action_executed);
 }
 
+TEST_F(TestLens, TestPreviewActionWithHints)
+{
+  std::string uri = PopulateAndGetFirstResultURI();
+  bool previewed = false;
+  Preview::Ptr preview;
+
+  auto preview_cb = [&previewed, &uri, &preview]
+                                        (std::string const& uri_,
+                                         Preview::Ptr const& preview_)
+  {
+    EXPECT_EQ(uri, uri_);
+    EXPECT_EQ(preview_->renderer_name, "preview-movie");
+
+    preview = preview_;
+    previewed = true;
+  };
+
+  lens_->preview_ready.connect(preview_cb);
+  lens_->Preview(uri);
+
+  Utils::WaitUntil(previewed);
+
+  bool action_executed = false;
+  auto activated_cb = [&action_executed] (std::string const& uri,
+                                          HandledType handled_type,
+                                          Lens::Hints const& hints)
+  {
+    EXPECT_EQ(handled_type, HandledType::SHOW_DASH);
+    action_executed = true;
+  };
+
+  lens_->activated.connect(activated_cb);
+  EXPECT_GT(preview->GetActions().size(), (unsigned)0);
+  auto action = preview->GetActions()[0];
+  auto hints = Lens::Hints();
+  hints["passing-test-hint"] = g_variant_new_boolean(TRUE);
+  preview->PerformAction(action->id, hints);
+
+  Utils::WaitUntil(action_executed);
+}
+
 TEST_F(TestLens, TestEmitClosedSignal)
 {
   std::string uri = PopulateAndGetFirstResultURI();