Merge lp:~gordallott/unity/dash-legal-link into lp:unity

[Gord Allott]

adds a legal link to the dash, also a new resource

adds a legal link to the dash

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

Looks good and works well...

29 + glib::String cachedir(g_strdup(g_get_user_cache_dir()));

No need to strdup it, just assign that to std::string... It should be never NULL, in case just check for that.

30 + legal_seen_file_path_ = cachedir.Str() + "/unitydashlegalseen";

Since we have an unity .cache dir, I'd just add there... i.e. cachedir/unity/dashlegalseen

68 + QueueRelayout();
69 + QueueDraw();

The first is enough, as does also redraw.

64 + info_icon_->SetVisible(info_previously_shown_);
65 + legal_->SetVisible(!info_previously_shown_);
67 + DoOpenLegalise();

Wouldn't be better to open the legalise (and close the dash) and then switch the icon visibility?

95 + std::string legal_file_path = "file://";
96 + legal_file_path.append(PKGDATADIR);
97 + legal_file_path.append("/searchingthedashlegalnotice.html");

Why not just doing:
std::string legal_file_path = "file://" PKGDATADIR "/searchingthedashlegalnotice.html";

221 + nux::LayeredLayout* layered_layout_;
222 + nux::HLayout *legal_layout_;

It seems you don't need to keep these in class.

Finally, both the icon and the text are always built, only their visibility is switched, couldn't avoid this (and then only allocate only the needed resources)?

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

143 + auto geo = GetAbsoluteGeometry();

Ah, use auto const& instead ;)

[Gord Allott (gordallott)]

> Looks good and works well...
>
> 29 + glib::String cachedir(g_strdup(g_get_user_cache_dir()));
>
> No need to strdup it, just assign that to std::string... It should be never
> NULL, in case just check for that.
>
> 30 + legal_seen_file_path_ = cachedir.Str() + "/unitydashlegalseen";
>
> Since we have an unity .cache dir, I'd just add there... i.e.
> cachedir/unity/dashlegalseen

we don't have a unity cache directory, not anymore.

>
> 68 + QueueRelayout();
> 69 + QueueDraw();
>
> The first is enough, as does also redraw.
>
> 64 + info_icon_->SetVisible(info_previously_shown_);
> 65 + legal_->SetVisible(!info_previously_shown_);
> 67 + DoOpenLegalise();
>
> Wouldn't be better to open the legalise (and close the dash) and then switch
> the icon visibility?
>
> 95 + std::string legal_file_path = "file://";
> 96 + legal_file_path.append(PKGDATADIR);
> 97 + legal_file_path.append("/searchingthedashlegalnotice.html");
>
> Why not just doing:
> std::string legal_file_path = "file://" PKGDATADIR
> "/searchingthedashlegalnotice.html";

personal preference

>
> 221 + nux::LayeredLayout* layered_layout_;
> 222 + nux::HLayout *legal_layout_;
>
> It seems you don't need to keep these in class.
>
> Finally, both the icon and the text are always built, only their visibility is
> switched, couldn't avoid this (and then only allocate only the needed
> resources)?

they could, but there is little reason to, its less than 2kb of memory.

[Timo Jyrinki (timo-jyrinki)]

This has been in 6.0 series already for some time (in this final form), would be good to have in lp:unity as well?

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/114/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/./build=pbuilder,distribution=quantal,flavor=amd64/114/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-mbs-autolanding/./build=pbuilder,distribution=quantal,flavor=i386/114/console

review: Needs Fixing (continuous-integration)

[Martin Mrazik (mrazik)]

Gord, can you please merge with lp:unity and then re-upload your branch? The above is a jenkins error but it is a bit of corner case and left-over from the migration to inline packaging. Instead of creating some weird hack it would be easier to manually get the packaging into your branch (by merging with trunk). Many thanks!

=== modified file 'dash/LensBar.cpp'
--- dash/LensBar.cpp	2012-09-18 13:59:06 +0000
+++ dash/LensBar.cpp	2012-10-15 16:31:20 +0000
@@ -16,11 +16,17 @@
  * Authored by: Neil Jagdish Patel <[e-mail]>
  */
 
+#include <glib/gstdio.h>
+#include "LensBar.h"
 #include <NuxCore/Logger.h>
 #include "config.h"
+#include <Nux/HLayout.h>
+#include <Nux/LayeredLayout.h>
 
+#include "unity-shared/DashStyle.h"
+#include "unity-shared/StaticCairoText.h"
 #include "unity-shared/CairoTexture.h"
-#include "LensBar.h"
+#include "unity-shared/UBusMessages.h"
 
 namespace unity
 {
@@ -41,7 +47,12 @@
 
 LensBar::LensBar()
   : nux::View(NUX_TRACKER_LOCATION)
+  , info_previously_shown_(false)
 {
+  glib::String cachedir(g_strdup(g_get_user_cache_dir())); 
+  legal_seen_file_path_ = cachedir.Str() + "/unitydashlegalseen";
+  info_previously_shown_ = (g_file_test(legal_seen_file_path_.c_str(), G_FILE_TEST_EXISTS)) ? true : false;
+
   SetupBackground();
   SetupLayout();
   SetupHomeLens();
@@ -58,10 +69,50 @@
 
 void LensBar::SetupLayout()
 {
+  legal_layout_ = new nux::HLayout(NUX_TRACKER_LOCATION);
+  std::string legal_text("<span underline='single'>");
+  legal_text.append(g_dgettext("credentials-control-center", "Legal notice"));
+  legal_text.append("</span>");
+  legal_ = new nux::StaticCairoText(legal_text);
+  legal_->SetFont("Ubuntu 14px");
+  legal_layout_->AddSpace(1, 1);
+  legal_layout_->SetLeftAndRightPadding(0, 10);
+  info_icon_ = new IconTexture(Style::Instance().GetInformationTexture(), 22, 22); 
+  legal_layout_->AddView(info_icon_, 0, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_MATCHCONTENT);
+  legal_layout_->AddView(legal_,  0, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_MATCHCONTENT);
+  
+  info_icon_->SetVisible(info_previously_shown_);
+  legal_->SetVisible(!info_previously_shown_);
+  
+  info_icon_->mouse_click.connect([&] (int a, int b, unsigned long c, unsigned long d) 
+  {
+    DoOpenLegalise();
+  });
+
+  legal_->mouse_click.connect([&] (int a, int b, unsigned long c, unsigned long d) 
+  {
+    info_previously_shown_ = true;
+
+    info_icon_->SetVisible(info_previously_shown_);
+    legal_->SetVisible(!info_previously_shown_);
+
+    DoOpenLegalise();
+    QueueRelayout();
+    QueueDraw();
+  });
+
+
   layout_ = new nux::HLayout(NUX_TRACKER_LOCATION);
   layout_->SetContentDistribution(nux::MAJOR_POSITION_CENTER);
-  SetLayout(layout_);
+  
+  layered_layout_ = new nux::LayeredLayout();
+  layered_layout_->AddLayer(layout_);
+  layered_layout_->AddLayout(legal_layout_);
+  layered_layout_->SetPaintAll(true);
+  layered_layout_->SetInputMode(nux::LayeredLayout::InputMode::INPUT_MODE_COMPOSITE);
 
+  SetLayout(layered_layout_);
+  
   SetMinimumHeight(LENSBAR_HEIGHT);
   SetMaximumHeight(LENSBAR_HEIGHT);
 }
@@ -79,6 +130,23 @@
   icon->key_nav_focus_activate.connect([&, icon](nux::Area*){ SetActive(icon); });
 }
 
+void LensBar::DoOpenLegalise()
+{
+  glib::Error error;
+  std::string legal_file_path = "file://";
+  legal_file_path.append(PKGDATADIR);
+  legal_file_path.append("/searchingthedashlegalnotice.html");
+  g_app_info_launch_default_for_uri(legal_file_path.c_str(), NULL, &error);
+  if (error)
+  {
+    LOG_ERROR(logger) << "Could not open legal uri: " << error.Message();
+  }
+
+  g_creat(legal_seen_file_path_.c_str(), S_IRWXU);
+
+  ubus_.SendMessage(UBUS_PLACE_VIEW_CLOSE_REQUEST);
+}
+
 void LensBar::AddLens(Lens::Ptr& lens)
 {
   LensBarIcon* icon = new LensBarIcon(lens->id, lens->icon_hint);
@@ -112,7 +180,7 @@
 
   bg_layer_->SetGeometry(base);
   nux::GetPainter().RenderSinglePaintLayer(graphics_engine, base, bg_layer_.get());
-
+ 
   graphics_engine.PopClippingRectangle();
 }
 
@@ -139,11 +207,11 @@
   }
   else if (!IsFullRedraw())
   {
-    ++pushed_paint_layers;
+    pushed_paint_layers += 2;
     nux::GetPainter().PushLayer(graphics_engine, bg_layer_->GetGeometry(), bg_layer_.get());
   }
 
-  layout_->ProcessDraw(graphics_engine, true);
+  GetLayout()->ProcessDraw(graphics_engine, true);
 
   if (pushed_paint_layers)
     nux::GetPainter().PopBackground(pushed_paint_layers);
@@ -172,6 +240,27 @@
   graphics_engine.PopClippingRectangle();
 }
 
+nux::Area* LensBar::FindAreaUnderMouse(const nux::Point& mouse_position, nux::NuxEventType event_type)
+{
+  //LayeredLayout is acting a little screwy, events are not passing past the first layout like instructed,
+  //so we manually override if the cursor is on the right hand side of the lensbar 
+  auto geo = GetAbsoluteGeometry();
+  int info_width = (info_previously_shown_) ? info_icon_->GetGeometry().width : legal_->GetGeometry().width;
+  
+  if (mouse_position.x - geo.x < geo.width - info_width - 10)
+  {
+    return nux::View::FindAreaUnderMouse(mouse_position, event_type);
+  }
+  else
+  {
+    if (info_previously_shown_)
+      return dynamic_cast<nux::Area*>(info_icon_);
+    else
+      return dynamic_cast<nux::Area*>(legal_);
+  }
+  
+}
+
 void LensBar::SetActive(LensBarIcon* activated)
 {
   bool state_changed = false;

=== modified file 'dash/LensBar.h'
--- dash/LensBar.h	2012-05-06 23:48:38 +0000
+++ dash/LensBar.h	2012-10-15 16:31:20 +0000
@@ -25,21 +25,27 @@
 
 #include <NuxGraphics/GraphicsEngine.h>
 #include <Nux/Nux.h>
-#include <Nux/HLayout.h>
+#include <Nux/PaintLayer.h>
 #include <Nux/View.h>
 #include <UnityCore/Lens.h>
 
 #include "unity-shared/IconTexture.h"
 #include "unity-shared/Introspectable.h"
+#include "unity-shared/UBusWrapper.h"
 #include "LensBarIcon.h"
 
 namespace nux
 {
 class AbstractPaintLayer;
+class HLayout;
+class LayeredLayout;
+class StaticCairoText;
 }
 
 namespace unity
 {
+class IconTexture;
+
 namespace dash
 {
 
@@ -62,24 +68,35 @@
   void SetupBackground();
   void SetupLayout();
   void SetupHomeLens();
+  void DoOpenLegalise();
 
   void Draw(nux::GraphicsEngine& gfx_context, bool force_draw);
   void DrawContent(nux::GraphicsEngine& gfx_context, bool force_draw);
 
+  nux::Area* FindAreaUnderMouse(const nux::Point& mouse_position, nux::NuxEventType event_type);
+
   void SetActive(LensBarIcon* icon);
 
   bool AcceptKeyNavFocus();
   std::string GetName() const;
   void AddProperties(GVariantBuilder* builder);
 
-private:
   std::string GetActiveLensId() const;
   typedef std::unique_ptr<nux::AbstractPaintLayer> LayerPtr;
 
   LensIcons icons_;
 
+  UBusManager ubus_;
+
+  nux::LayeredLayout* layered_layout_;
+  nux::HLayout *legal_layout_;
+  nux::StaticCairoText *legal_;
   nux::HLayout* layout_;
   LayerPtr bg_layer_;
+  IconTexture* info_icon_;
+
+  bool info_previously_shown_;
+  std::string legal_seen_file_path_;
 };
 
 } // namespace dash

=== added file 'plugins/unityshell/resources/information_icon.svg'
--- plugins/unityshell/resources/information_icon.svg	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/resources/information_icon.svg	2012-10-15 16:31:20 +0000
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 width="22px" height="22px" viewBox="0 0 22 22" enable-background="new 0 0 22 22" xml:space="preserve">
+<g>
+	<g>
+		<path fill="#FFFFFF" d="M11,2c-4.971,0-9,4.03-9,9s4.029,9,9,9s9-4.03,9-9S15.971,2,11,2z M12.007,17.01h-2.004V9.001h2.004V17.01
+			z M11.877,6.903c-0.245,0.224-0.534,0.336-0.868,0.336c-0.346,0-0.64-0.112-0.885-0.336C9.88,6.68,9.757,6.378,9.757,5.998
+			c0-0.392,0.123-0.699,0.367-0.924c0.245-0.223,0.539-0.335,0.885-0.335c0.334,0,0.623,0.112,0.868,0.335
+			c0.244,0.225,0.366,0.532,0.366,0.924C12.243,6.378,12.121,6.68,11.877,6.903z"/>
+	</g>
+</g>
+</svg>

=== added file 'plugins/unityshell/resources/searchingthedashlegalnotice.html'
--- plugins/unityshell/resources/searchingthedashlegalnotice.html	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/resources/searchingthedashlegalnotice.html	2012-10-15 16:31:20 +0000
@@ -0,0 +1,1 @@
+<html><head><title>searching the dash legal notice</title><style type="text/css">ol{margin:0;padding:0}.c0{color:#000080;font-family:"Ubuntu";text-decoration:underline}.c8{list-style-type:disc;margin:0;padding:0}.c4{color:#1155cc;font-family:"Ubuntu";text-decoration:underline}.c10{max-width:499.5pt;background-color:#ffffff;padding:72pt 58.5pt 72pt 54pt}.c1{color:inherit;text-decoration:inherit}.c7{padding-left:0pt;margin-left:36pt}.c6{font-weight:bold}.c9{text-align:center}.c2{direction:ltr}.c5{font-family:"Ubuntu"}.c3{height:11pt}.title{padding-top:24pt;line-height:1.15;text-align:left;color:#000000;font-size:36pt;font-family:"Arial";font-weight:bold;padding-bottom:6pt}.subtitle{padding-top:18pt;line-height:1.15;text-align:left;color:#666666;font-style:italic;font-size:24pt;font-family:"Georgia";padding-bottom:4pt}li{color:#000000;font-size:11pt;font-family:"Arial"}p{color:#000000;font-size:11pt;margin:0;font-family:"Arial"}h1{padding-top:24pt;line-height:1.15;text-align:left;color:#000000;font-size:18pt;font-family:"Arial";font-weight:bold;padding-bottom:6pt}h2{padding-top:18pt;line-height:1.15;text-align:left;color:#000000;font-size:14pt;font-family:"Arial";font-weight:bold;padding-bottom:4pt}h3{padding-top:14pt;line-height:1.15;text-align:left;color:#666666;font-size:12pt;font-family:"Arial";font-weight:bold;padding-bottom:4pt}h4{padding-top:12pt;line-height:1.15;text-align:left;color:#666666;font-style:italic;font-size:11pt;font-family:"Arial";padding-bottom:2pt}h5{padding-top:11pt;line-height:1.15;text-align:left;color:#666666;font-size:10pt;font-family:"Arial";font-weight:bold;padding-bottom:2pt}h6{padding-top:10pt;line-height:1.15;text-align:left;color:#666666;font-style:italic;font-size:10pt;font-family:"Arial";padding-bottom:2pt}</style></head><body class="c10"><p class="c2 c9"><span class="c5">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span class="c6 c5">Searching in the dash - Legal notice</span></p><p class="c2 c3"><span class="c6 c5"></span></p><p class="c2"><span class="c5">This search function is provided to you by Canonical Group Limited (Canonical). This legal notice applies to searching in the dash and incorporates the terms of Canonical&#39;s</span><span class="c0">&nbsp;</span><span class="c4"><a class="c1" href="http://www.canonical.com/legal">legal notice</a></span><span class="c0">&nbsp;</span><span class="c5">(and privacy policy). </span></p><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c6 c5">Collection and use of data</span></p><p class="c2"><span class="c5">When you enter a search term into the dash Ubuntu will search your Ubuntu computer and will record the search terms locally. </span></p><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c5">Unless you have opted out (see the &ldquo;Online Search&rdquo; section below), we will also send your keystrokes as a search term to productsearch.ubuntu.com and selected third parties so that we may complement your search results with online search results from such third parties including: Facebook, Twitter, BBC and Amazon. Canonical and these selected third parties will collect your search terms and use them to provide you with search results while using Ubuntu. </span></p><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c5">By searching in the dash you consent to:</span></p><p class="c2 c3"><span class="c5"></span></p><ol class="c8" start="1"><li class="c7 c2"><span class="c5">the collection and use of your search terms and IP address in this way; and</span></li><li class="c2 c7"><span class="c5">the storage of your search terms and IP address by Canonical and such selected third parties (if applicable).</span></li></ol><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c5">Canonical will only use your search terms and IP address in accordance with this legal notice and </span><span class="c4"><a class="c1" href="http://www.ubuntu.com/aboutus/privacypolicy">our privacy</a></span><span class="c4"><a class="c1" href="http://www.ubuntu.com/aboutus/privacypolicy">&nbsp;policy</a></span><span class="c5">.</span><span class="c5">&nbsp;Please see </span><span class="c4"><a class="c1" href="http://www.ubuntu.com/aboutus/privacypolicy">our privacy</a></span><span class="c4"><a class="c1" href="http://www.ubuntu.com/aboutus/privacypolicy">&nbsp;policy</a></span><span class="c5">&nbsp;</span><span class="c5">for further information about how Canonical protects your personal information. For information on how our selected third parties may use your information, please see their privacy policies.</span></p><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c6 c5">Online Search</span></p><p class="c2"><span class="c5">You may restrict your dash so that we don&rsquo;t send searches to third parties and you don&#39;t receive online search results. To do this go to the Privacy panel and toggle the &lsquo;Include online search results&rsquo; option to off. The Privacy panel can be found in your System Settings or via a dash search. For a current list of our selected third parties, please see </span><span class="c4"><a class="c1" href="http://www.ubuntu.com/privacypolicy/thirdparties">www.ubuntu.com/privacypolicy/thirdparties</a></span><span class="c5">.</span></p><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c5 c6">Changes</span></p><p class="c2"><span class="c5">Although most changes are likely to be minor, Canonical may change this legal notice from time to time, and at Canonical&#39;s sole discretion. Please check this page from time to time for any changes to this legal notice as we will not be able to notify you directly.</span></p><p class="c2 c3"><span class="c5"></span></p><p class="c2"><span class="c6 c5">How to contact us</span></p><p class="c2"><span class="c5">Please submit any questions or comments about searching in the dash or this legal notice by contacting us at the following address: Canonical Group Ltd, 5th Floor, Blue Fin Building, 110 Southwark Street, London, England, SE1 0SU.</span></p></body></html>

=== modified file 'unity-shared/DashStyle.cpp'
--- unity-shared/DashStyle.cpp	2012-10-10 14:25:59 +0000
+++ unity-shared/DashStyle.cpp	2012-10-15 16:31:20 +0000
@@ -221,6 +221,7 @@
   LazyLoadTexture search_close_texture_;
   LazyLoadTexture search_spin_texture_;
 
+  LazyLoadTexture information_texture_;
 
   LazyLoadTexture refine_gradient_corner_;
   LazyLoadTexture refine_gradient_dash_;
@@ -268,6 +269,7 @@
   , search_circle_texture_("/search_circle.svg", 32)
   , search_close_texture_("/search_close.svg", 32)
   , search_spin_texture_("/search_spin.svg", 32)
+  , information_texture_("/information_icon.svg")
   , refine_gradient_corner_("/refine_gradient_corner.png")
   , refine_gradient_dash_("/refine_gradient_dash.png")
   , refine_gradient_no_refine_dash_("/refine_gradient_dash_no_refine.png")
@@ -2211,6 +2213,11 @@
   return pimpl->search_spin_texture_.texture();
 }
 
+nux::BaseTexture* Style::GetInformationTexture()
+{
+  return pimpl->information_texture_.texture(); 
+}
+
 nux::BaseTexture* Style::GetRefineTextureCorner()
 {
   return pimpl->refine_gradient_corner_.texture();

=== modified file 'unity-shared/DashStyle.h'
--- unity-shared/DashStyle.h	2012-10-10 14:25:59 +0000
+++ unity-shared/DashStyle.h	2012-10-15 16:31:20 +0000
@@ -203,7 +203,9 @@
   nux::BaseTexture* GetStarDeselectedIcon();
   nux::BaseTexture* GetStarSelectedIcon();
   nux::BaseTexture* GetStarHighlightIcon();
-  
+ 
+  nux::BaseTexture* GetInformationTexture();
+
   nux::BaseTexture* GetRefineTextureCorner();
   nux::BaseTexture* GetRefineTextureDash();
   nux::BaseTexture* GetRefineNoRefineTextureDash();