Merge lp:~didrocks/unity/gsettings-migration into lp:unity

[Didier Roche-Tolomelli]

gsettings migration, handle lucid -> next LTS, lucid UNE -> next LTS, lucid Unity ppa -> next LTS, maverick -> natty and maverick unity -> natty

[Neil J. Patel (njpatel)]

Can'test it works but code looks good and the python is hurting my eyes enough :)

Approved, but could you just make gchar *output = NULL, so if it's not set we don't accidently free a random memory area.

Thanks!

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2010-11-24 21:44:18 +0000
+++ CMakeLists.txt	2010-11-25 15:59:43 +0000
@@ -1,7 +1,7 @@
   project (unity)
 cmake_minimum_required(VERSION 2.8)
 
-subdirs (libunity services tests)
+subdirs (libunity services tests tools)
 
 #
 # Base bits

=== modified file 'com.canonical.Unity.gschema.xml'
--- com.canonical.Unity.gschema.xml	2010-11-22 10:40:59 +0000
+++ com.canonical.Unity.gschema.xml	2010-11-25 15:59:43 +0000
@@ -1,9 +1,14 @@
 <schemalist>
 	<schema path="/desktop/unity/launcher/" id="com.canonical.Unity.Launcher" gettext-domain="unity">
     <key type="as" name="favorites">
-      <default>[ 'ubiquity-gtkui.desktop', 'nautilus.desktop', 'firefox.desktop', 'empathy.desktop', 'tomboy.desktop' ]</default>
+      <default>[ 'ubiquity-gtkui.desktop', 'nautilus.desktop', 'firefox.desktop', 'empathy.desktop', 'ubuntuone-control-panel-gtk.desktop', 'tomboy.desktop' ]</default>
       <summary>List of desktop file ids for favorites on the launcher.</summary>
       <description>These applications are shown in the Launcher by default.</description>
     </key>
+    <key type="s" name="favorite-migration">
+      <default>''</default>
+      <summary>Version of last migration done</summary>
+      <description>This is a detection key for the favorite migration script to know whether the needed migration is done or not.</description>
+    </key>
     </schema>
 </schemalist>

=== modified file 'src/FavoriteStoreGSettings.cpp'
--- src/FavoriteStoreGSettings.cpp	2010-11-24 22:57:59 +0000
+++ src/FavoriteStoreGSettings.cpp	2010-11-25 15:59:43 +0000
@@ -16,12 +16,16 @@
 * Authored by: Neil Jagdish Patel <[e-mail]>
 */
 
+#include "config.h"
+
 #include <gio/gdesktopappinfo.h>
 
 #include "FavoriteStoreGSettings.h"
 
 #define SETTINGS_NAME "com.canonical.Unity.Launcher"
 
+#define LATEST_SETTINGS_MIGRATION "3.2.0"
+
 static void on_settings_updated (GSettings *settings, const gchar *key, FavoriteStoreGSettings *self);
 
 FavoriteStoreGSettings::FavoriteStoreGSettings ()
@@ -41,9 +45,30 @@
 void
 FavoriteStoreGSettings::Init ()
 {
+  gchar *latest_migration_update;
+
   m_favorites = NULL;
   m_ignore_signals = false;
 
+  /* migrate the favorites if needed and ignore errors */
+  latest_migration_update = g_settings_get_string (m_settings, "favorite-migration");
+  if (g_strcmp0 (latest_migration_update, LATEST_SETTINGS_MIGRATION) < 0)
+    {
+      GError *error = NULL;
+      char *cmd = g_strdup_printf ("%s/lib/unity/migrate_favorites.py", PREFIXDIR);
+      char *output;
+      
+      g_spawn_command_line_sync (cmd, &output, NULL, NULL, &error);
+      if (error)
+        {
+          printf ("WARNING: Unable to run the migrate favorites tools successfully: %s.\nThe output was:%s\n", error->message,output);
+          g_error_free (error);
+        }
+      g_free (output);
+      g_free (cmd);
+    }
+  g_free (latest_migration_update);
+
   g_signal_connect (m_settings, "changed",
                     G_CALLBACK (on_settings_updated), this);
 

=== added file 'tools/CMakeLists.txt'
--- tools/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tools/CMakeLists.txt	2010-11-25 15:59:43 +0000
@@ -0,0 +1,5 @@
+#
+# Some unity tools
+#
+install(FILES migrate_favorites.py PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib/unity/)
+

=== modified file 'tools/migrate_favorites.py'
--- tools/migrate_favorites.py	2010-10-06 08:37:47 +0000
+++ tools/migrate_favorites.py	2010-11-25 15:59:43 +0000
@@ -12,6 +12,10 @@
 import gobject
 import os
 import sys
+import subprocess
+from xdg import BaseDirectory
+
+LAST_MIGRATION = '3.2.0'
 
 def get_desktop_dir():
     ''' no python binding from xdg to get the desktop directory? '''
@@ -34,68 +38,100 @@
         pass
     return os.path.expanduser('~/Desktop')
 
-def register_new_app(client, launcher_location, apps_list, priority_position):
-    key_name = 'app-%s' % launcher_location.split('/')[-1]
-    # remove forbidden key in gconf:
-    for val in [' ', '+', '\'', '"', '\\', '`', '[', ']', '(', ')', '°', '#', '~', '|', '&', '=', '?']:
-        key_name = key_name.replace(val, '_')
-    # default distribution launcher don't begin with / and don't have a desktop file in ~/.gnome2
-    if os.path.exists(launcher_location) and key_name not in apps_list:
-        apps_list.append(key_name)
-        app_gconf_key_path = '/desktop/unity/launcher/favorites/%s' % key_name
-        client.set_string('%s/desktop_file' % app_gconf_key_path, launcher_location)
-        client.set_float('%s/priority' % app_gconf_key_path, priority_position)
-        client.set_string('%s/type' % app_gconf_key_path, 'application')
-        priority_position += 1
-        #print key_name
-        #print launcher_location
-        #print priority_position
-    return (apps_list, priority_position)
-
-if os.path.exists(os.path.expanduser('~/.gconf/desktop/unity/')):
-    print "migration already done or unity used before migration support"
+def register_new_app(launcher_location, apps_list):
+    ''' append a new app with full desktop path if valid, take care of dups '''
+    
+    # default distribution launcher don't go into that function (as don't have an aboslute path)
+    entry = ""
+    if os.path.exists(launcher_location):
+        # try to strip the full path we had in unity mutter if it's part of a xdg path:
+        for xdg_dir in BaseDirectory.xdg_data_dirs:
+            xdg_app_dir = os.path.join(xdg_dir, "applications", "")
+            if launcher_location.startswith(xdg_app_dir):
+                candidate_desktop_file = launcher_location.split(xdg_app_dir)[1]
+                # if really the xdg path is the path to the launcher
+                if not '/' in candidate_desktop_file:
+                    entry = candidate_desktop_file
+                    break
+        if not entry:
+            entry = launcher_location
+        if entry not in apps_list:
+            apps_list.append(entry)
+
+    return apps_list
+
+
+migration_level = subprocess.Popen(["gsettings", "get", "com.canonical.Unity.Launcher", "favorite-migration"], stdout=subprocess.PIPE).communicate()[0].strip()[1:-1]
+if migration_level >= LAST_MIGRATION:
+    print "Migration already done"
     sys.exit(0)
 
 client = gconf.client_get_default()
 
-# import current defaults
-apps_list = client.get_list('/desktop/unity/launcher/favorites/favorites_list', gconf.VALUE_STRING)
-priority_position = len(apps_list) + 1
-
-# get GNOME panel favorites and convert them
-panel_list = client.get_list('/apps/panel/general/toplevel_id_list', gconf.VALUE_STRING)
-candidate_objects = client.get_list('/apps/panel/general/object_id_list', gconf.VALUE_STRING)
-for candidate in candidate_objects:
-    candidate_path = '/apps/panel/objects/%s' % candidate
-    if (client.get_string('%s/object_type' % candidate_path) == 'launcher-object'
-       and client.get_string('%s/toplevel_id' % candidate_path) in panel_list):
-        launcher_location = client.get_string('%s/launcher_location' % candidate_path)
-        if launcher_location:
-            if not launcher_location.startswith('/'):
-                launcher_location = os.path.expanduser('~/.gnome2/panel2.d/default/launchers/%s' % launcher_location)
-            (apps_list, priority_position) = register_new_app(client, launcher_location, apps_list, priority_position)
-
-
-# get UNE lucid panel favorites and convert them
-lucid_favorites_list = client.get_list('/apps/netbook-launcher/favorites/favorites_list', gconf.VALUE_STRING)
-for candidate in lucid_favorites_list:
-    candidate_path = '/apps/netbook-launcher/favorites/%s' % candidate
-    if (client.get_string('%s/type' % candidate_path) == 'application'):
-        launcher_location = client.get_string('%s/desktop_file' % candidate_path)
-        if launcher_location:     
-            (apps_list, priority_position) = register_new_app(client, launcher_location, apps_list, priority_position)
-            
-# get GNOME desktop launchers
-desktop_dir = get_desktop_dir()
-for launcher_location in glob.glob('%s/*.desktop' % desktop_dir):
-    # blacklist ubiquity as will have two ubiquity in the netbook live session then
-    if not "ubiquity" in launcher_location:
-        (apps_list, priority_position) = register_new_app(client, launcher_location, apps_list, priority_position)
-
-# set list of default and new favorites and write everything!
-client.set_list('/desktop/unity/launcher/favorites/favorites_list', gconf.VALUE_STRING, apps_list)
-#print apps_list
-client.clear_cache()
-# ugly workaround to force gconf client to actually dump its cache to gconfd
-loop = gobject.MainLoop(); gobject.idle_add(loop.quit); loop.run();
+# get current gsettings defaults into a list
+defaults_call = subprocess.Popen(["gsettings", "get", "com.canonical.Unity.Launcher", "favorites"], stdout=subprocess.PIPE)
+apps_list = [elem.strip()[1:-1] for elem in defaults_call.communicate()[0].strip()[1:-1].split(',')]
+
+# first migration to unity compiz
+if migration_level < '3.2.0':
+
+    unity_mutter_favorites_list = client.get_list('/desktop/unity/launcher/favorites/favorites_list', gconf.VALUE_STRING)
+    unity_mutter_launcher_ordered = {}
+    for candidate in unity_mutter_favorites_list:
+        candidate_path = '/desktop/unity/launcher/favorites/%s' % candidate
+        if (client.get_string('%s/type' % candidate_path) == 'application'):
+            launcher_location = client.get_string('%s/desktop_file' % candidate_path)
+            position = client.get_string('%s/desktop_file' % candidate_path)
+            if launcher_location:
+                # try to preserve the order, will be done in a second loop
+                unity_mutter_launcher_ordered[position] = launcher_location
+    for launcher_location in unity_mutter_launcher_ordered:    
+        apps_list = register_new_app(launcher_location, apps_list)
+
+
+    # import netbook-launcher favorites and convert them
+    lucid_favorites_list = client.get_list('/apps/netbook-launcher/favorites/favorites_list', gconf.VALUE_STRING)
+    for candidate in lucid_favorites_list:
+        candidate_path = '/apps/netbook-launcher/favorites/%s' % candidate
+        if (client.get_string('%s/type' % candidate_path) == 'application'):
+            launcher_location = client.get_string('%s/desktop_file' % candidate_path)
+            if launcher_location:     
+                apps_list = register_new_app(launcher_location, apps_list)
+
+    # get GNOME panel favorites and convert them
+    panel_list = client.get_list('/apps/panel/general/toplevel_id_list', gconf.VALUE_STRING)
+    candidate_objects = client.get_list('/apps/panel/general/object_id_list', gconf.VALUE_STRING)
+    for candidate in candidate_objects:
+        candidate_path = '/apps/panel/objects/%s' % candidate
+        if (client.get_string('%s/object_type' % candidate_path) == 'launcher-object'
+           and client.get_string('%s/toplevel_id' % candidate_path) in panel_list):
+            launcher_location = client.get_string('%s/launcher_location' % candidate_path)
+            if launcher_location:
+                if not launcher_location.startswith('/'):
+                    launcher_location = os.path.expanduser('~/.gnome2/panel2.d/default/launchers/%s' % launcher_location)
+                apps_list = register_new_app(launcher_location, apps_list)
+                
+    # get GNOME desktop launchers
+    desktop_dir = get_desktop_dir()
+    for launcher_location in glob.glob('%s/*.desktop' % desktop_dir):
+        # blacklist ubiquity as will have two ubiquity in the netbook live session then
+        if not "ubiquity" in launcher_location:
+            apps_list = register_new_app(launcher_location, apps_list)
+
+    # Now write to gsettings!
+    #print apps_list
+    return_code = subprocess.call(["gsettings", "set", "com.canonical.Unity.Launcher", "favorites", str(apps_list)])
+    
+    if return_code != 0:
+        print "Settings fail to transition to new unity compiz"
+        sys.exit(1)
+        
+    # some autumn cleanage (gconf binding for recursive_unset seems broken)
+    subprocess.call(["gconftool-2", "--recursive-unset", "/apps/netbook-launcher"])
+    subprocess.call(["gconftool-2", "--recursive-unset", "/desktop/unity"])
+    print "Settings successfully transitionned to new unity compiz"
+
+# stamp that all went well
+subprocess.call(["gsettings", "set", "com.canonical.Unity.Launcher", "favorite-migration", "\'%s\'" % LAST_MIGRATION])
+sys.exit(0)