Merge lp:~3v1n0/unity/hints-on-first-run into lp:unity

[Marco Trevisan (Treviño)]

UnityScreen: show the shortcut hint on first run

As designed, we show the shortcut hints the first time an user run unity.

[Brandon Schaefer (brandontschaefer)]

Nice :). LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3706
http://jenkins.qa.ubuntu.com/job/unity-ci/784/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/320
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/316
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/318

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/784/rebuild

review: Approve (continuous-integration)

=== modified file 'panel/PanelMenuView.cpp'
--- panel/PanelMenuView.cpp	2014-03-06 09:26:03 +0000
+++ panel/PanelMenuView.cpp	2014-03-12 22:56:47 +0000
@@ -693,22 +693,30 @@
   if (BAMF_IS_WINDOW(window))
   {
     BamfView *view = reinterpret_cast<BamfView*>(window);
-    std::vector<Window> const& our_xids = nux::XInputWindow::NativeHandleList();
     Window window_xid = bamf_window_get_xid(window);
 
-    if (std::find(our_xids.begin(), our_xids.end(), window_xid) != our_xids.end())
+    if (bamf_window_get_window_type(window) == BAMF_WINDOW_DOCK)
     {
-      /* If the active window is an unity window, we need to fallback to the
-       * top one, anyway we should always avoid to focus unity internal windows */
-      BamfWindow* top_win = GetBamfWindowForXid(GetTopWindow());
-
-      if (top_win && top_win != window)
-      {
-        window = top_win;
-      }
-      else
-      {
-        return "";
+      auto panel = const_cast<PanelMenuView*>(this)->GetTopLevelViewWindow();
+      if (static_cast<nux::BaseWindow*>(panel)->GetInputWindowId() == window_xid)
+        return desktop_name_;
+
+      std::vector<Window> const& our_xids = nux::XInputWindow::NativeHandleList();
+
+      if (std::find(our_xids.begin(), our_xids.end(), window_xid) != our_xids.end())
+      {
+        /* If the active window is an unity window, we need to fallback to the
+         * top one, anyway we should always avoid to focus unity internal windows */
+        BamfWindow* top_win = GetBamfWindowForXid(GetTopWindow());
+
+        if (top_win && top_win != window)
+        {
+          window = top_win;
+        }
+        else
+        {
+          return "";
+        }
       }
     }
 
@@ -718,7 +726,7 @@
     }
     else if (!IsValidWindow(window_xid))
     {
-       return "";
+      return "";
     }
 
     if (WindowManager::Default().IsWindowMaximized(window_xid) && !use_appname)

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2014-03-07 19:18:30 +0000
+++ plugins/unityshell/src/unityshell.cpp	2014-03-12 22:56:47 +0000
@@ -138,6 +138,7 @@
 const int MAX_BUFFER_AGE = 11;
 const int FRAMES_TO_REDRAW_ON_RESUME = 10;
 const std::string RELAYOUT_TIMEOUT = "relayout-timeout";
+const std::string FIRST_RUN_STAMP = "first_run.stamp";
 } // namespace local
 } // anon namespace
 
@@ -3663,6 +3664,7 @@
   auto shortcuts_modeller = std::make_shared<shortcut::CompizModeller>();
   shortcut_controller_ = std::make_shared<shortcut::Controller>(base_window_raiser, shortcuts_modeller);
   AddChild(shortcut_controller_.get());
+  ShowFirstRunHints();
 
   // Setup Session Controller
   auto manager = std::make_shared<session::GnomeManager>();
@@ -3742,6 +3744,41 @@
   return menus_->KeyGrabber()->GetActions();
 }
 
+void UnityScreen::ShowFirstRunHints()
+{
+  sources_.AddTimeoutSeconds(1, [this] {
+    auto const& cache_dir = glib::gchar_to_string(g_get_user_cache_dir())+"/unity/";
+    if (!g_file_test((cache_dir+local::FIRST_RUN_STAMP).c_str(), G_FILE_TEST_EXISTS))
+    {
+      // We focus the panel, so the shortcut hint will be hidden at first user input
+      auto const& panels = panel_controller_->panels();
+      if (!panels.empty())
+      {
+        auto panel_win = static_cast<nux::BaseWindow*>(panels.front()->GetTopLevelViewWindow());
+        SaveInputThenFocus(panel_win->GetInputWindowId());
+      }
+      shortcut_controller_->first_run = true;
+      shortcut_controller_->Show();
+
+      if (g_mkdir_with_parents(cache_dir.c_str(), 0700) >= 0)
+      {
+        glib::Error error;
+        g_file_set_contents((cache_dir+local::FIRST_RUN_STAMP).c_str(), "", 0, &error);
+
+        if (error)
+        {
+          LOG_ERROR(logger) << "Impossible to save the unity stamp file: " << error;
+        }
+      }
+      else
+      {
+        LOG_ERROR(logger) << "Impossible to create unity cache folder!";
+      }
+    }
+    return false;
+  });
+}
+
 /* Window init */
 
 namespace

=== modified file 'plugins/unityshell/src/unityshell.h'
--- plugins/unityshell/src/unityshell.h	2014-03-07 03:37:43 +0000
+++ plugins/unityshell/src/unityshell.h	2014-03-12 22:56:47 +0000
@@ -306,6 +306,8 @@
 
   void DamageBlurUpdateRegion(nux::Geometry const&);
 
+  void ShowFirstRunHints();
+
   std::unique_ptr<na::TickSource> tick_source_;
   std::unique_ptr<na::AnimationController> animation_controller_;
 

=== modified file 'shortcuts/ShortcutController.cpp'
--- shortcuts/ShortcutController.cpp	2013-11-20 21:39:40 +0000
+++ shortcuts/ShortcutController.cpp	2014-03-12 22:56:47 +0000
@@ -37,7 +37,8 @@
 
 Controller::Controller(BaseWindowRaiser::Ptr const& base_window_raiser,
                        AbstractModeller::Ptr const& modeller)
-  : modeller_(modeller)
+  : first_run(false)
+  , modeller_(modeller)
   , base_window_raiser_(base_window_raiser)
   , visible_(false)
   , enabled_(true)
@@ -155,6 +156,7 @@
   AddChild(view_.GetPointer());
   view_->SetModel(modeller_->GetCurrentModel());
   view_->background_color = WindowManager::Default().average_color();
+  view_->closable = first_run();
 
   if (!view_window_)
   {
@@ -197,6 +199,8 @@
   if (view_window_ && view_window_->GetOpacity() > 0.0f)
   {
     view_->live_background = false;
+    view_->closable = false;
+    first_run = false;
     animation::StartOrReverse(fade_animator_, animation::Direction::BACKWARD);
   }
 }

=== modified file 'shortcuts/ShortcutController.h'
--- shortcuts/ShortcutController.h	2013-11-14 00:17:19 +0000
+++ shortcuts/ShortcutController.h	2014-03-12 22:56:47 +0000
@@ -47,6 +47,8 @@
   Controller(BaseWindowRaiser::Ptr const& raiser, AbstractModeller::Ptr const& modeller);
   virtual ~Controller();
 
+  nux::Property<bool> first_run;
+
   bool Show();
   void Hide();
 

=== modified file 'tests/test_shortcut_controller.cpp'
--- tests/test_shortcut_controller.cpp	2013-09-25 00:48:03 +0000
+++ tests/test_shortcut_controller.cpp	2014-03-12 22:56:47 +0000
@@ -68,6 +68,7 @@
     MOCK_METHOD1(SetOpacity, void(double));
     using Controller::GetOffsetPerMonitor;
     using Controller::ConstructView;
+    using Controller::OnShowTimer;
     using Controller::view_;
 
     void RealSetOpacity(double value)
@@ -188,5 +189,37 @@
   color_property.changed.emit(nux::color::RandomColor());
 }
 
+TEST_F(TestShortcutController, FirstRunFalse)
+{
+  ASSERT_FALSE(controller_.first_run());
+
+  controller_.ConstructView();
+  EXPECT_FALSE(controller_.view_->closable());
+}
+
+TEST_F(TestShortcutController, FirstRunTrue)
+{
+  ASSERT_FALSE(controller_.first_run());
+
+  controller_.first_run = true;
+  controller_.ConstructView();
+  EXPECT_TRUE(controller_.view_->closable());
+}
+
+TEST_F(TestShortcutController, UnsetFirstRunOnHide)
+{
+  controller_.first_run = true;
+  controller_.ConstructView();
+
+  ASSERT_TRUE(controller_.view_->closable());
+  controller_.Show();
+  controller_.OnShowTimer();
+  tick_source_.tick(100 * 1000);
+  controller_.Hide();
+
+  EXPECT_FALSE(controller_.first_run());
+  EXPECT_FALSE(controller_.view_->closable());
+}
+
 }
 }