Merge lp:~aacid/unity/fix_panek_title_escaping_1067357_for_6.0 into lp:unity/6.0

[Albert Astals Cid]

Fix escaping of _panel_title

It only has to be escpaed if comes from new_title
if coming from UBUS_LAUNCHER_SELECTION_CHANGED data it is already escaped
Fixes bug #1067357

Fix escaping of _panel_title

It only has to be escpaed if comes from new_title
if coming from UBUS_LAUNCHER_SELECTION_CHANGED data it is already escaped
Fixes bug #1067357

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-unity/1545/console reported an error when processing this lp:~aacid/unity/fix_panek_title_escaping_1067357_for_6.0 branch.
Not merging it.

[Albert Astals Cid (aacid)]

Reapproving after minor compile fix

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-unity/1546/console reported an error when processing this lp:~aacid/unity/fix_panek_title_escaping_1067357_for_6.0 branch.
Not merging it.

[Marco Trevisan (Treviño) (3v1n0)]

review: Approve

=== modified file 'panel/PanelMenuView.cpp'
--- panel/PanelMenuView.cpp	2012-08-27 03:00:42 +0000
+++ panel/PanelMenuView.cpp	2012-10-24 08:16:21 +0000
@@ -785,6 +785,46 @@
   gtk_style_context_restore(style_context);
 }
 
+std::string PanelMenuView::GetCurrentTitle() const
+{
+  if (!_switcher_showing && !_launcher_keynav)
+  {
+    auto win_manager = WindowManager::Default();
+    std::string new_title;
+
+    if (win_manager->IsScaleActive())
+    {
+      if (win_manager->IsScaleActiveForGroup())
+        new_title = GetActiveViewName(true);
+      else if (_we_control_active)
+        new_title = _desktop_name;
+    }
+    else if (win_manager->IsExpoActive())
+    {
+      new_title = _desktop_name;
+    }
+    else if (!_we_control_active)
+    {
+      new_title = "";
+    }
+    else
+    {
+      new_title = GetActiveViewName();
+      _window_buttons->SetControlledWindow(_active_xid);
+    }
+
+    // _panel_title needs to be only escaped when computed
+    // in this function, if it comes from OnLauncherSelectionChanged
+    // it is already escaped
+    glib::String escaped(g_markup_escape_text(new_title.c_str(), -1));
+    return escaped.Str();
+  }
+  else
+  {
+    return _panel_title;
+  }
+}
+
 void PanelMenuView::Refresh(bool force)
 {
   nux::Geometry const& geo = GetGeometry();
@@ -794,42 +834,13 @@
   if (geo.width > _monitor_geo.width)
     return;
 
-  auto win_manager = WindowManager::Default();
-  std::string new_title;
-
-  if (win_manager->IsScaleActive())
-  {
-    if (win_manager->IsScaleActiveForGroup())
-      new_title = GetActiveViewName(true);
-    else if (_we_control_active)
-      new_title = _desktop_name;
-  }
-  else if (win_manager->IsExpoActive())
-  {
-    new_title = _desktop_name;
-  }
-  else if (!_we_control_active)
-  {
-    new_title = "";
-  }
-  else if (!_switcher_showing && !_launcher_keynav)
-  {
-    new_title = GetActiveViewName();
-    _window_buttons->SetControlledWindow(_active_xid);
-  }
-
-  if (!_switcher_showing && !_launcher_keynav)
-  {
-    if (_panel_title != new_title)
-    {
-      _panel_title = new_title;
-    }
-    else if (!force && _last_geo == geo && _title_texture)
-    {
-      // No need to redraw the title, let's save some CPU time!
-      return;
-    }
-  }
+  const std::string& new_title = GetCurrentTitle();
+  if (new_title == _panel_title && !force && _last_geo == geo && _title_texture)
+  {
+    // No need to redraw the title, let's save some CPU time!
+    return;
+  }
+  _panel_title = new_title;
 
   if (_panel_title.empty())
   {
@@ -843,12 +854,7 @@
   cairo_set_operator(cr, CAIRO_OPERATOR_CLEAR);
   cairo_paint(cr);
 
-  glib::String escaped(g_markup_escape_text(_panel_title.c_str(), -1));
-
-  std::ostringstream bold_label;
-  bold_label << "<b>" << escaped.Str() << "</b>";
-
-  DrawTitle(cr, geo, bold_label.str());
+  DrawTitle(cr, geo, _panel_title);
 
   cairo_destroy(cr);
 

=== modified file 'panel/PanelMenuView.h'
--- panel/PanelMenuView.h	2012-09-07 14:29:09 +0000
+++ panel/PanelMenuView.h	2012-10-24 08:16:21 +0000
@@ -69,8 +69,11 @@
   virtual nux::Area* FindAreaUnderMouse(const nux::Point& mouse_position,
                                         nux::NuxEventType event_type);
   virtual void OnEntryAdded(indicator::Entry::Ptr const& entry);
+  virtual std::string GetActiveViewName(bool use_appname = false) const;
 
 private:
+  friend class TestPanelMenuView;
+
   void OnActiveChanged(PanelIndicatorEntryView* view, bool is_active);
   void OnViewOpened(BamfMatcher* matcher, BamfView* view);
   void OnViewClosed(BamfMatcher* matcher, BamfView* view);
@@ -101,6 +104,7 @@
   void OnMaximizedGrabEnd(int x, int y);
 
   void FullRedraw();
+  std::string GetCurrentTitle() const;
   void Refresh(bool force = false);
   void DrawTitle(cairo_t *cr_real, nux::Geometry const& geo, std::string const& label) const;
 
@@ -110,8 +114,6 @@
 
   BamfWindow* GetBamfWindowForXid(Window xid) const;
 
-  std::string GetActiveViewName(bool use_appname = false) const;
-
   void OnSwitcherShown(GVariant* data);
   void OnLauncherKeyNavStarted(GVariant* data);
   void OnLauncherKeyNavEnded(GVariant* data);

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2012-10-12 16:34:45 +0000
+++ tests/CMakeLists.txt	2012-10-24 08:16:21 +0000
@@ -223,6 +223,7 @@
                  test_launcher_icon.cpp
                  test_keyboard_util.cpp
                  test_panel_style.cpp
+                 test_panel_menu_view.cpp
                  test_places_group.cpp
                  test_previews_application.cpp
                  test_previews_generic.cpp
@@ -327,6 +328,11 @@
                  ${CMAKE_SOURCE_DIR}/launcher/VolumeImp.cpp
                  ${CMAKE_SOURCE_DIR}/launcher/VolumeLauncherIcon.cpp
                  ${CMAKE_SOURCE_DIR}/launcher/VolumeMonitorWrapper.cpp
+                 ${CMAKE_SOURCE_DIR}/panel/PanelIndicatorEntryView.cpp
+                 ${CMAKE_SOURCE_DIR}/panel/PanelIndicatorsView.cpp
+                 ${CMAKE_SOURCE_DIR}/panel/PanelMenuView.cpp
+                 ${CMAKE_SOURCE_DIR}/panel/PanelTitlebarGrabAreaView.cpp
+                 ${CMAKE_SOURCE_DIR}/panel/WindowButtons.cpp
                  ${CMAKE_SOURCE_DIR}/shortcuts/ShortcutController.cpp
                  ${CMAKE_SOURCE_DIR}/shortcuts/ShortcutModel.cpp
                  #${CMAKE_SOURCE_DIR}/shortcuts/ShortcutHintPrivate.cpp

=== added file 'tests/test_panel_menu_view.cpp'
--- tests/test_panel_menu_view.cpp	1970-01-01 00:00:00 +0000
+++ tests/test_panel_menu_view.cpp	2012-10-24 08:16:21 +0000
@@ -0,0 +1,174 @@
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 3, as published
+ * by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY 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
+ * version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ */
+
+#include <gmock/gmock.h>
+
+#include <Nux/Nux.h>
+#include "PanelMenuView.h"
+#include "PanelStyle.h"
+#include "UnitySettings.h"
+#include "UBusMessages.h"
+#include "test_utils.h"
+
+using namespace testing;
+
+namespace unity
+{
+
+class MockPanelMenuView : public PanelMenuView
+{
+  protected:
+    virtual std::string GetActiveViewName(bool use_appname) const
+    {
+      return "<>'";
+    }
+};
+
+class MockWindowManager : public WindowManager
+{
+public:
+  MockWindowManager() : _scale_active(false), _scale_active_group(false) {}
+  guint32 GetActiveWindow() const { return 0; }
+  unsigned long long GetWindowActiveNumber (guint32 xid) const { return 0; }
+  bool IsScreenGrabbed() const { return false; }
+  bool IsViewPortSwitchStarted() const { return false; }
+  void ShowDesktop() { }
+  bool InShowDesktop() const { return false; }
+  bool IsWindowMaximized(guint32 xid) const { return false; }
+  bool IsWindowDecorated(guint32 xid) { return true; }
+  bool IsWindowOnCurrentDesktop(guint32 xid) const { return true; }
+  bool IsWindowObscured(guint32 xid) const { return false; }
+  bool IsWindowMapped(guint32 xid) const { return true; }
+  bool IsWindowVisible(guint32 xid) const { return true; }
+  bool IsWindowOnTop(guint32 xid) const { return false; }
+  bool IsWindowClosable(guint32 xid) const { return true; }
+  bool IsWindowMinimizable(guint32 xid) const { return true; }
+  bool IsWindowMaximizable(guint32 xid) const { return true; }
+  void Restore(guint32 xid) { }
+  void RestoreAt(guint32 xid, int x, int y) { }
+  void Minimize(guint32 xid) { }
+  void Close(guint32 xid) { }
+  void Activate(guint32 xid) { }
+  void Raise(guint32 xid) { }
+  void Lower(guint32 xid) { }
+  void FocusWindowGroup(std::vector<Window> windows, FocusVisibility, int monitor, bool only_top_win) { }
+  bool ScaleWindowGroup(std::vector<Window> windows, int state, bool force) { return false; }
+  int GetWindowMonitor(guint32 xid) const { return -1; }
+  void SetWindowIconGeometry(Window window, nux::Geometry const& geo) { }
+  int WorkspaceCount () const { return 1; }
+  void TerminateScale() { }
+  void SetScaleActive(bool scale_active) { _scale_active = scale_active; }
+  bool IsScaleActive() const { return _scale_active; }
+  void SetScaleActiveForGroup(bool scale_active_group) { _scale_active_group = scale_active_group; }
+  bool IsScaleActiveForGroup() const { return _scale_active_group; }
+  void InitiateExpo() { }
+  void TerminateExpo() { }
+  bool IsExpoActive() const { return false; }
+  bool IsWallActive() const { return false; }
+  void MoveResizeWindow(guint32 xid, nux::Geometry geometry) { }
+  bool saveInputFocus() { return false; }
+  bool restoreInputFocus() { return false; }
+  void AddProperties(GVariantBuilder* builder) {}
+  std::string GetWindowName(guint32 xid) const { return ""; }
+
+  nux::Geometry GetWindowGeometry(guint xid) const
+  {
+    int width = (guint32)xid >> 16;
+    int height = (guint32)xid & 0x0000FFFF;
+    return nux::Geometry(0, 0, width, height);
+  }
+
+  nux::Geometry GetWindowSavedGeometry(guint xid) const
+  {
+    return nux::Geometry(0, 0, 1, 1);
+  }
+
+  nux::Geometry GetScreenGeometry() const
+  {
+    return nux::Geometry(0, 0, 1, 1);
+  }
+
+  nux::Geometry GetWorkAreaGeometry(guint32 xid) const
+  {
+    return nux::Geometry(0, 0, 1, 1);
+  }
+
+  void CheckWindowIntersections (nux::Geometry const& region, bool &active, bool &any)
+  {
+    active = false;
+    any = false;
+  }
+
+  bool _scale_active;
+  bool _scale_active_group;
+};
+
+struct TestPanelMenuView : public testing::Test
+{
+  virtual void SetUp()
+  {
+  }
+
+  void ProcessUBusMessages()
+  {
+    bool expired = false;
+    glib::Idle idle([&] { expired = true; return false; },
+                    glib::Source::Priority::LOW);
+    Utils::WaitUntil(expired);
+  }
+
+  std::string panelTitle() const
+  {
+    const PanelMenuView *panel = &panelMenuView;
+    return panel->GetCurrentTitle();
+  }
+
+protected:
+  // The order is important, i.e. PanelMenuView needs
+  // panel::Style that needs Settings
+  MockWindowManager windowManager;
+  Settings settings;
+  panel::Style panelStyle;
+  MockPanelMenuView panelMenuView;
+};
+
+TEST_F(TestPanelMenuView, Escaping)
+{
+  WindowManager::SetDefault(&windowManager);
+  static const char *escapedText = "Panel d&amp;Inici";
+  EXPECT_TRUE(panelTitle().empty());
+
+  UBusManager ubus;
+  ubus.SendMessage(UBUS_LAUNCHER_START_KEY_NAV, NULL);
+  ubus.SendMessage(UBUS_LAUNCHER_SELECTION_CHANGED,
+                   g_variant_new_string(escapedText));
+  ProcessUBusMessages();
+
+  EXPECT_EQ(panelTitle(), escapedText);
+
+  ubus.SendMessage(UBUS_LAUNCHER_END_KEY_NAV, NULL);
+  ProcessUBusMessages();
+
+  // Change the wm to trick PanelMenuView::RefreshTitle to call GetActiveViewName
+  windowManager.SetScaleActive(true);
+  windowManager.SetScaleActiveForGroup(true);
+
+  EXPECT_EQ(panelTitle(), "&lt;&gt;&apos;");
+}
+
+}