Merge lp:~osomon/unity/4.0-dash-custom-home-screen into lp:unity/4.0

[Olivier Tilloy]

Allow customizing the dash’s home screen.

The contents of the custom home screen are described in a JSON file called HomeShortcutsCustomized.json.

The file is looked for in the following locations in decreasing order of priority:
    - $XDG_CONFIG_HOME/unity/ (defaults to $HOME/.config/unity/)
    - $DIR/unity/ for $DIR in $XDG_CONFIG_DIRS

The syntax of the file is as follows:
==========================================================================
{
  "shortcut1": {
    "source": $source,
    "name": $name,
    "name[fr]": $name_in_french,
    […]
    "icon": $icon
  },
  "shortcut2": {
    […]
  },
  […]
}
==========================================================================

The source attribute may either be a desktop file (full path or just its basename if it is located in a standard directory), or a lens file (basename only). This attribute is mandatory.
The 'name' attribute is optional. If present, it will override the default display name as advertised by the desktop file or by the lens. The name can be localized in several languages using the square brackets suffix notation, in which case the locale matching the system’s will be used, defaulting to the untranslated 'name' attribute if necessary.
The 'icon' attribute is optional. If present, it will override the default icon as advertised by the desktop file or by the lens. It should be a full path name.
If the source is a lens, the optional 'filter' attribute allows specifying a filter in the form "$name:$value", e.g. "type:videos" for the files lens.
If the source is a lens, the optional 'section' attribute allows specifying a section number (an integer starting at index 0).

=== added directory 'manual-tests'
=== added directory 'manual-tests/custom-dash-home'
=== added file 'manual-tests/custom-dash-home/HomeShortcutsCustomized-4-entries.json'
--- manual-tests/custom-dash-home/HomeShortcutsCustomized-4-entries.json	1970-01-01 00:00:00 +0000
+++ manual-tests/custom-dash-home/HomeShortcutsCustomized-4-entries.json	2011-12-15 12:51:34 +0000
@@ -0,0 +1,22 @@
+{
+	"shortcut1": {
+		"source": "/usr/share/applications/ubuntu-software-center.desktop",
+		"name": "Software Center",
+		"name[fr]": "Logithèque",
+		"icon": "/usr/share/icons/Humanity/places/64/start-here.svg"
+	},
+	"shortcut2": {
+		"source": "music.lens",
+		"filter": "genre:rock",
+		"name": "Rock Music"
+	},
+	"shortcut3": {
+		"source": "files.lens",
+		"filter": "type:videos",
+		"name": "Vidéos",
+		"icon": "/usr/share/icons/Humanity/actions/64/help-about.svg"
+	},
+	"shortcut4": {
+		"source": "transmission-gtk.desktop"
+	}
+}

=== added file 'manual-tests/custom-dash-home/HomeShortcutsCustomized-8-entries.json'
--- manual-tests/custom-dash-home/HomeShortcutsCustomized-8-entries.json	1970-01-01 00:00:00 +0000
+++ manual-tests/custom-dash-home/HomeShortcutsCustomized-8-entries.json	2011-12-15 12:51:34 +0000
@@ -0,0 +1,44 @@
+{
+	"shortcut1": {
+		"source": "/usr/share/applications/ubuntu-software-center.desktop",
+		"name": "Software Center",
+		"name[fr]": "Logithèque",
+		"icon": "/usr/share/icons/Humanity/places/64/start-here.svg"
+	},
+	"shortcut2": {
+		"source": "music.lens",
+		"filter": "genre:rock",
+		"name": "Rock Music"
+	},
+	"shortcut3": {
+		"source": "files.lens",
+		"filter": "type:videos",
+		"name": "Vidéos",
+		"icon": "/usr/share/icons/Humanity/actions/64/help-about.svg"
+	},
+	"shortcut4": {
+		"source": "transmission-gtk.desktop"
+	},
+	"shortcut5": {
+		"source": "/usr/share/applications/eog.desktop",
+		"name": "Eye Of Gnome",
+		"name[de]": "Auge des Zwergs",
+		"icon": "/usr/share/icons/hicolor/scalable/apps/eog.svg"
+	},
+	"shortcut6": {
+		"source": "/usr/share/applications/jockey-gtk.desktop",
+		"name": "Jockey",
+		"name[de]": "Jockey",
+		"icon": "/usr/share/icons/hicolor/scalable/apps/jockey.svg"
+	},
+	"shortcut7": {
+		"source": "/usr/share/applications/gwibber.desktop",
+		"name": "gwibber",
+		"icon": "/usr/share/icons/hicolor/scalable/apps/gwibber.svg"
+	},
+	"shortcut8": {
+		"source": "/usr/share/applications/giggle.desktop",
+		"name": "Giggle",
+		"icon": "/usr/share/icons/hicolor/scalable/apps/giggle.svg"
+	}
+}

=== added file 'manual-tests/custom-dash-home/HomeShortcutsCustomized-broken.json'
--- manual-tests/custom-dash-home/HomeShortcutsCustomized-broken.json	1970-01-01 00:00:00 +0000
+++ manual-tests/custom-dash-home/HomeShortcutsCustomized-broken.json	2011-12-15 12:51:34 +0000
@@ -0,0 +1,23 @@
+this is some intentional garbage with lots of errors
+{
+	"shortcut1": {
+		"source": "/usr/share/applications/ubuntu-software-center.desktop",
+		"name": "Software Center",
+		"name[fr]": "Logithèque",
+		"icn": "/usr/share/icons/Humanity/places/64/start-here.svg"
+	},
+	"shortcut2": {
+		"sorce": "music.lens",
+		"filter": "genre:rock",
+		"name": "Rock Music"
+	},
+	"shortcut3": {
+		"source": "files.lens",
+		"filter": "type:videos",
+		"name": "Vidéos",
+		"icon": "/usr/share/icons/Humanity/actions/64/hep-about.svg"
+	},
+	"shortcut12": {
+		"source": "transmission-gtk.destop"
+	}
+}

=== added file 'manual-tests/custom-dash-home/custom-dash-home.txt'
--- manual-tests/custom-dash-home/custom-dash-home.txt	1970-01-01 00:00:00 +0000
+++ manual-tests/custom-dash-home/custom-dash-home.txt	2011-12-15 12:51:34 +0000
@@ -0,0 +1,46 @@
+Manual tests for the 'dash custom home screen' functionality
+============================================================
+
+How to test
+-----------
+
+To test the functionality, create the folder $HOME/.config/unity/, and copy the
+three files HomeShortcutsCustomized*.json there.
+
+Then for each of them repeat the following steps:
+
+    cd $HOME/.config/unity/
+    rm HomeShortcutsCustomized.json
+    ln -s $FILE HomeShortcutsCustomized.json # replace $FILE with the json file being considered
+    # restart unity
+    # open the dash
+    # check the visual appearance against the expected results detailed below
+
+
+Expected results
+----------------
+
+With 'HomeShortcutsCustomized-4-entries.json', the home screen of the dash
+contains 4 icons that fill the first row. The second row is empty.
+Those icons are:
+ - "Software Center": launches the Ubuntu Software Center, the icon is the
+   Ubuntu Circle Of Friends, and if you are running with a French locale the
+   name is localized to "Logithèque".
+ - "Rock Music": opens the music lens with the genre filter set to "Rock".
+ - "Vidéos": opens the files lens with the type filter set to "videos", the icon
+   is a yellow star.
+ - "Transmission BitTorrent Client": launches transmission-gtk.
+
+With 'HomeShortcutsCustomized-8-entries.json', the home screen of the dash
+contains 8 icons that fill the two rows. The first row contains the exact same
+icons as 'HomeShortcutsCustomized-4-entries.json' (see details above). The icons
+on the second row are:
+ - "Eye Of Gnome": launches eog, if you are running with a German locale the
+   name is localized to "Auge des Zwergs".
+ - "Jockey": launches jockey-gtk.
+ - "gwibber": launches gwibber.
+ - "Giggle": this icon appears only if giggle is installed, it launches giggle.
+
+With 'HomeShortcutsCustomized-broken.json', the home screen of the dash contains
+the default icons because the file fails to be parsed.
+

=== modified file 'plugins/unityshell/src/JSONParser.cpp'
--- plugins/unityshell/src/JSONParser.cpp	2011-09-15 04:28:49 +0000
+++ plugins/unityshell/src/JSONParser.cpp	2011-12-15 12:51:34 +0000
@@ -145,6 +145,19 @@
     values[i] = json_array_get_double_element(array, i);
 }
 
+void Parser::ReadString(std::string const& node_name,
+                        std::string const& member_name,
+                        std::string& value) const
+{
+  JsonObject* object = GetNodeObject(node_name);
+
+  if (!object)
+    return;
+
+  if (json_object_has_member(object, member_name.c_str()))
+    value = json_object_get_string_member(object, member_name.c_str());
+}
+
 void Parser::ReadColor(std::string const& node_name,
                        std::string const& member_name,
                        std::string const& opacity_name,

=== modified file 'plugins/unityshell/src/JSONParser.h'
--- plugins/unityshell/src/JSONParser.h	2011-09-15 04:28:49 +0000
+++ plugins/unityshell/src/JSONParser.h	2011-12-15 12:51:34 +0000
@@ -58,6 +58,10 @@
                    std::string const& member_name,
                    std::vector<double>& values) const;
 
+  void ReadString(std::string const& node_name,
+                  std::string const& member_name,
+                  std::string& value) const;
+
   void ReadColor(std::string const& node_name,
                  std::string const& member_name,
                  std::string const& opacity_name,

=== modified file 'plugins/unityshell/src/PlacesHomeView.cpp'
--- plugins/unityshell/src/PlacesHomeView.cpp	2011-09-02 03:40:15 +0000
+++ plugins/unityshell/src/PlacesHomeView.cpp	2011-12-15 12:51:34 +0000
@@ -39,16 +39,25 @@
 
 #include "PlacesHomeView.h"
 
+#include "JSONParser.h"
 #include "PlacesSimpleTile.h"
 #include "PlacesStyle.h"
 #include <UnityCore/GLibWrapper.h>
 #include <UnityCore/Variant.h>
 
+#include <sstream>
 #include <string>
 #include <vector>
 
+#include <boost/algorithm/string.hpp>
+
 #define DELTA_DOUBLE_REQUEST 500000000
 
+namespace
+{
+  const std::string custom_shortcuts_file = "/unity/HomeShortcutsCustomized.json";
+}
+
 namespace unity
 {
 
@@ -136,7 +145,9 @@
 
   expanded.connect(sigc::mem_fun(this, &PlacesHomeView::Refresh));
 
-  Refresh();
+  // Wait for the asynchronous loading of the lenses to complete
+  // before refreshing the view for the first time.
+  _lenses.lenses_loaded.connect(sigc::bind(sigc::mem_fun(this, &PlacesHomeView::Refresh), (PlacesGroup*) NULL));
 }
 
 PlacesHomeView::~PlacesHomeView()
@@ -163,64 +174,227 @@
 
   _layout->Clear();
 
-  // Media Apps
-  markup = g_strdup_printf(temp, _("Media Apps"));
-  shortcut = new Shortcut(PKGDATADIR"/find_media_apps.png",
-                          markup,
-                          icon_size);
-  shortcut->_id = TYPE_PLACE;
-  shortcut->_place_id = g_strdup("applications.lens?filter_type=media");
-  shortcut->_place_section = 9;
-  _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
-  shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
-  g_free(markup);
-
-  // Internet Apps
-  markup = g_strdup_printf(temp, _("Internet Apps"));
-  shortcut = new Shortcut(PKGDATADIR"/find_internet_apps.png",
-                          markup,
-                          icon_size);
-  shortcut->_id = TYPE_PLACE;
-  shortcut->_place_id = g_strdup("applications.lens?filter_type=internet");
-  shortcut->_place_section = 8;
-  _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
-  shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
-  g_free(markup);
-
-  // More Apps
-  markup = g_strdup_printf(temp, _("More Apps"));
-  shortcut = new Shortcut(PKGDATADIR"/find_more_apps.png",
-                          markup,
-                          icon_size);
-  shortcut->_id = TYPE_PLACE;
-  shortcut->_place_id = g_strdup("applications.lens");
-  shortcut->_place_section = 0;
-  _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
-  shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
-  g_free(markup);
-
-  // Find Files
-  markup = g_strdup_printf(temp, _("Find Files"));
-  shortcut = new Shortcut(PKGDATADIR"/find_files.png",
-                          markup,
-                          icon_size);
-  shortcut->_id = TYPE_PLACE;
-  shortcut->_place_id = g_strdup("files.lens");
-  shortcut->_place_section = 0;
-  _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
-  shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
-  g_free(markup);
-
-  // Browser
-  CreateShortcutFromMime("x-scheme-handler/http", _("Browse the Web"), _browser_alternatives);
-
-  // Photos
-  // FIXME: Need to figure out the default
-  CreateShortcutFromExec("shotwell", _("View Photos"), _photo_alternatives);
-
-  CreateShortcutFromMime("x-scheme-handler/mailto", _("Check Email"), _email_alternatives);
-
-  CreateShortcutFromMime("audio/x-vorbis+ogg", _("Listen to Music"), _music_alternatives);
+  // The following code path allows one to replace the default dash home screen
+  // with a custom home screen, the contents of which are described in a JSON
+  // file. The file is looked for in the following locations in decreasing order
+  // of priority:
+  //   - $XDG_CONFIG_HOME/unity/ (defaults to $HOME/.config/unity/)
+  //   - $DIR/unity/ for $DIR in $XDG_CONFIG_DIRS
+  // The syntax of the file is as follows:
+  // ==========================================================================
+  // {
+  //   "shortcut1": {
+  //     "source": $source,
+  //     "name": $name,
+  //     "name[fr]": $name_in_french,
+  //     […]
+  //     "icon": $icon
+  //   },
+  //   "shortcut2": {
+  //     […]
+  //   },
+  //   […]
+  // }
+  // ==========================================================================
+  // The source attribute may either be a desktop file (full path or just its
+  // basename if it is located in a standard directory), or a lens file
+  // (basename only). This attribute is mandatory.
+  // The 'name' attribute is optional. If present, it will override the default
+  // display name as advertised by the desktop file or by the lens. The name can
+  // be localized in several languages using the square brackets suffix
+  // notation, in which case the locale matching the system’s will be used,
+  // defaulting to the untranslated 'name' attribute if necessary.
+  // The 'icon' attribute is optional. If present, it will override the default
+  // icon as advertised by the desktop file or by the lens. It should be a full
+  // path name.
+  // If the source is a lens, the optional 'filter' attribute allows specifying
+  // a filter in the form "$name:$value", e.g. "type:videos" for the files lens.
+  // If the source is a lens, the optional 'section' attribute allows specifying
+  // a section number (an integer starting at index 0).
+
+  std::string customShortcuts;
+  std::ostringstream file;
+  // Look for a custom shortcuts file in the user’s home directory first.
+  file << g_get_user_config_dir() << custom_shortcuts_file;
+  if (g_file_test(file.str().c_str(), G_FILE_TEST_EXISTS))
+  {
+    customShortcuts = file.str();
+  }
+  else
+  {
+    // Fall back on the standard XDG directories.
+    gchar** config = (gchar**) g_get_system_config_dirs();
+    for (gint i = 0; config[i]; ++i)
+    {
+      std::ostringstream file;
+      file << config[i] << custom_shortcuts_file;
+      if (g_file_test(file.str().c_str(), G_FILE_TEST_EXISTS))
+      {
+        customShortcuts = file.str();
+        break;
+      }
+    }
+  }
+  json::Parser parser;
+  if ((customShortcuts == "") || !parser.Open(customShortcuts))
+  {
+    // Media Apps
+    markup = g_strdup_printf(temp, _("Media Apps"));
+    shortcut = new Shortcut(PKGDATADIR"/find_media_apps.png",
+                            markup,
+                            icon_size);
+    shortcut->_id = TYPE_PLACE;
+    shortcut->_place_id = g_strdup("applications.lens?filter_type=media");
+    shortcut->_place_section = 9;
+    _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
+    shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
+    g_free(markup);
+
+    // Internet Apps
+    markup = g_strdup_printf(temp, _("Internet Apps"));
+    shortcut = new Shortcut(PKGDATADIR"/find_internet_apps.png",
+                            markup,
+                            icon_size);
+    shortcut->_id = TYPE_PLACE;
+    shortcut->_place_id = g_strdup("applications.lens?filter_type=internet");
+    shortcut->_place_section = 8;
+    _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
+    shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
+    g_free(markup);
+
+    // More Apps
+    markup = g_strdup_printf(temp, _("More Apps"));
+    shortcut = new Shortcut(PKGDATADIR"/find_more_apps.png",
+                            markup,
+                            icon_size);
+    shortcut->_id = TYPE_PLACE;
+    shortcut->_place_id = g_strdup("applications.lens");
+    shortcut->_place_section = 0;
+    _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
+    shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
+    g_free(markup);
+
+    // Find Files
+    markup = g_strdup_printf(temp, _("Find Files"));
+    shortcut = new Shortcut(PKGDATADIR"/find_files.png",
+                            markup,
+                            icon_size);
+    shortcut->_id = TYPE_PLACE;
+    shortcut->_place_id = g_strdup("files.lens");
+    shortcut->_place_section = 0;
+    _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
+    shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
+    g_free(markup);
+
+    // Browser
+    CreateShortcutFromMime("x-scheme-handler/http", _("Browse the Web"), _browser_alternatives);
+
+    // Photos
+    // FIXME: Need to figure out the default
+    CreateShortcutFromExec("shotwell", _("View Photos"), _photo_alternatives);
+
+    CreateShortcutFromMime("x-scheme-handler/mailto", _("Check Email"), _email_alternatives);
+
+    CreateShortcutFromMime("audio/x-vorbis+ogg", _("Listen to Music"), _music_alternatives);
+  }
+  else
+  {
+    // The custom shortcuts file can contain up to 8 shortcuts.
+    for (int i = 0; i < 8; ++i)
+    {
+      std::ostringstream oss;
+      oss << "shortcut" << (i + 1);
+      std::string slot = oss.str();
+      std::string source;
+      parser.ReadString(slot, "source", source);
+      if (source != "")
+      {
+        std::string icon;
+        parser.ReadString(slot, "icon", icon);
+
+        std::string name;
+        gchar** languages = (gchar**) g_get_language_names();
+        for (gint i = 0; languages[i]; ++i)
+        {
+          std::ostringstream key;
+          key << "name[" << languages[i] << "]";
+          parser.ReadString(slot, key.str(), name);
+          if (name != "")
+            break;
+        }
+        if (name == "")
+        {
+          parser.ReadString(slot, "name", name);
+        }
+
+        if (boost::iends_with(source, ".desktop"))
+        {
+          GDesktopAppInfo* info = NULL;
+          if (boost::istarts_with(source, "/"))
+            info = g_desktop_app_info_new_from_filename(source.c_str());
+          else
+            info = g_desktop_app_info_new(source.c_str());
+          if (G_IS_DESKTOP_APP_INFO(info))
+          {
+            if (name == "")
+              name = g_app_info_get_display_name(G_APP_INFO(info));
+            if (icon == "")
+            {
+              gchar* cicon = g_icon_to_string(g_app_info_get_icon(G_APP_INFO(info)));
+              icon = cicon;
+              g_free(cicon);
+            }
+            gchar* exec = g_strdup(g_app_info_get_executable(G_APP_INFO(info)));
+            markup = g_strdup_printf(temp, name.c_str());
+            shortcut = new Shortcut(icon.c_str(), markup, style->GetHomeTileIconSize());
+            shortcut->_id = TYPE_EXEC;
+            shortcut->_exec = exec;
+            _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
+            shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
+            g_free(markup);
+            g_object_unref(info);
+          }
+        }
+        else if (boost::iends_with(source, ".lens"))
+        {
+          unity::dash::Lens::Ptr lens = _lenses.GetLens(source);
+          if (lens)
+          {
+            if (name == "")
+              name = lens->name;
+            if (icon == "")
+              icon = lens->icon_hint;
+          }
+          std::string filter;
+          parser.ReadString(slot, "filter", filter);
+          int section = -1;
+          parser.ReadInt(slot, "section", section);
+          markup = g_strdup_printf(temp, name.c_str());
+          shortcut = new Shortcut(icon.c_str(), markup, style->GetHomeTileIconSize());
+          shortcut->_id = TYPE_PLACE;
+          if (filter != "")
+          {
+            std::vector<std::string> filter_key_value;
+            boost::split(filter_key_value, filter, boost::is_any_of(":"));
+            if (filter_key_value.size() == 2)
+              shortcut->_place_id = g_strdup_printf("%s?filter_%s=%s",
+                                                    source.c_str(),
+                                                    filter_key_value[0].c_str(),
+                                                    filter_key_value[1].c_str());
+            else
+              shortcut->_place_id = g_strdup(source.c_str());
+          }
+          else
+            shortcut->_place_id = g_strdup(source.c_str());
+          if (section != -1)
+            shortcut->_place_section = section;
+          _layout->AddView(shortcut, 1, nux::eLeft, nux::eFull);
+          shortcut->sigClick.connect(sigc::mem_fun(this, &PlacesHomeView::OnShortcutClicked));
+          g_free(markup);
+        }
+      }
+    }
+  }
 
   SetExpanded(true);
   SetCounts(8, 8);

=== modified file 'plugins/unityshell/src/PlacesHomeView.h'
--- plugins/unityshell/src/PlacesHomeView.h	2011-09-02 03:40:15 +0000
+++ plugins/unityshell/src/PlacesHomeView.h	2011-12-15 12:51:34 +0000
@@ -29,6 +29,8 @@
 
 #include <Nux/GridHLayout.h>
 
+#include <UnityCore/FilesystemLenses.h>
+
 #include "PlacesTile.h"
 #include "PlacesGroup.h"
 
@@ -67,6 +69,8 @@
   std::vector<std::string> _music_alternatives;
 
   guint _ubus_handle;
+
+  unity::dash::FilesystemLenses _lenses;
 };
 
 }