Merge lp:~didrocks/unity/migrate-docks into lp:unity

[Didier Roche-Tolomelli]

This branch enables:
- advanced matching on Exec key of the desktop file with system desktop file to
  avoid using copy (this complete the basic name matching already and is
  completed with more advanced heuristic for cairo-dock and such)
- migrate popular dock launchers to fix bug #692967. Now are handled:
  awn
  docky (multiple docks configuration are handled)
  cairo-dock

[Gord Allott (gordallott)]

Tested with cairo-dock and seems to work fine

review: Approve

=== modified file 'src/FavoriteStoreGSettings.cpp'
--- src/FavoriteStoreGSettings.cpp	2010-12-10 03:15:24 +0000
+++ src/FavoriteStoreGSettings.cpp	2011-01-04 21:29:33 +0000
@@ -24,7 +24,7 @@
 
 #define SETTINGS_NAME "com.canonical.Unity.Launcher"
 
-#define LATEST_SETTINGS_MIGRATION "3.2.0"
+#define LATEST_SETTINGS_MIGRATION "3.2.10"
 
 static void on_settings_updated (GSettings *settings, const gchar *key, FavoriteStoreGSettings *self);
 

=== modified file 'tools/migrate_favorites.py'
--- tools/migrate_favorites.py	2010-12-09 12:09:39 +0000
+++ tools/migrate_favorites.py	2011-01-04 21:29:33 +0000
@@ -16,7 +16,7 @@
 import subprocess
 from xdg import BaseDirectory
 
-LAST_MIGRATION = '3.2.0'
+LAST_MIGRATION = '3.2.10'
 
 def get_log_file():
     ''' open the log file and return it '''
@@ -32,7 +32,7 @@
 def migrating_chapter_log(name, apps_list, migration_list, log_file):
     '''Log migration of new launchers'''
     
-    log(" Migration for %s.\n Current app list is: %s\n Candidates are: %s" % (name, apps_list, migration_list), log_file)
+    log(" + Migration for %s.\n   Current app list is: %s\n   Candidates are: %s" % (name, apps_list, migration_list), log_file)
 
 
 def log(message, log_file):
@@ -67,10 +67,15 @@
     # default distribution launcher don't go into that function (as don't have an aboslute path)
     entry = ""
     if os.path.exists(launcher_location):
-        log("  == %s: exists" % launcher_location, log_file)
+        log("    == %s: exists" % launcher_location, log_file)
         # try to strip the full path we had in unity mutter if it's part of a xdg path:
         # or try to get that for other desktop file based on name.
         candidate_desktop_filename = launcher_location.split("/")[-1]
+        # some desktop file with modified exec key (like in cairo-dock contains 01desktopfilename.desktop, strip that)
+        try:
+            candidate_cairodock_desktop_filename = candidate_desktop_filename.split("01")[1]
+        except IndexError:
+            candidate_cairodock_desktop_filename = ""
         for xdg_dir in BaseDirectory.xdg_data_dirs:
             xdg_app_dir = os.path.join(xdg_dir, "applications", "")
             if launcher_location.startswith(xdg_app_dir):
@@ -78,25 +83,66 @@
                 # if really the xdg path is the path to the launcher
                 if not '/' in candidate_desktop_file:
                     entry = candidate_desktop_file
+                    log("    Direct match found for system desktop file", log_file)
                     break
             # second chance: try to see if the desktop filename is in xdg path and so, assume it's a match
-            if os.path.exists("%s/%s" % (xdg_app_dir, candidate_desktop_filename)):
+            if not entry and os.path.exists("%s/%s" % (xdg_app_dir, candidate_desktop_filename)):
                 entry = candidate_desktop_filename
-                break
+                log("    Similar desktop file name with system desktop file", log_file)
+                break
+            # third chance: try to see if a tweaked cairo-dock like deskto file name is in xdg path
+            if not entry and os.path.exists("%s/%s" % (xdg_app_dir, candidate_cairodock_desktop_filename)):
+                entry = candidate_cairodock_desktop_filename
+                log("    Similar Cairo-Dock -like desktop file name with system desktop file", log_file)
+                break
+        # fourth and last chance: try to find a corresponding Exec key.
+        # Wait! scanning /usr/share/applications is heavy !!!
+        # Don't panic, we have the bamf.index for that :)
+        if not entry:
+            exec_arg = ""
+            try:
+                for line in open(launcher_location):
+                    if "Exec=" in line:
+                        exec_arg = line.split("Exec=")[1]
+                        break
+            except IOError:
+                log("    Can't open %s for reading Exec" % launcher_location, log_file)     
+            if exec_arg:
+                try:
+                    for line in open("/usr/share/applications/bamf.index"):
+                        if exec_arg in line:
+                            entry = line.split()[0]
+                            log("    Coherent exec key found with system desktop file", log_file)
+                            break
+                except IOError:
+                    log("    No bamf.index file found on the system!", log_file)
             
         if not entry:
             entry = launcher_location
-        log("  %s: real entry is %s" % (launcher_location, entry), log_file)
+        log("    %s: real entry is %s" % (launcher_location, entry), log_file)
         if entry not in apps_list:
-            log("  --- adding %s as not in app_list" % entry, log_file)
+            log("    --- adding %s as not in app_list" % entry, log_file)
             apps_list.append(entry)
         else:
-            log("  --- NOT adding %s as already in app_list" % entry, log_file)
+            log("    --- NOT adding %s as already in app_list" % entry, log_file)
     else:
-        log("  == %s: doesn't exist" % launcher_location, log_file)
+        log("    == %s: doesn't exist" % launcher_location, log_file)
 
     return apps_list
 
+def save_gsettings_favorites(apps_list, log_file):
+    ''' save the app list favorites 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 favorites"
+        log("Settings fail to transition to new unity compiz favorites\n\n", log_file)
+        if log_file:
+            log_file.close()
+        sys.exit(1)
+
 try:
     migration_level = subprocess.Popen(["gsettings", "get", "com.canonical.Unity.Launcher", "favorite-migration"], stdout=subprocess.PIPE).communicate()[0].strip()[1:-1]
 except OSError, e:
@@ -162,29 +208,56 @@
     # get GNOME desktop launchers
     desktop_dir = get_desktop_dir()
     desktop_items = glob.glob('%s/*.desktop' % desktop_dir)
-    migrating_chapter_log("deskop items in %s" % desktop_dir, apps_list, desktop_items, log_file)
+    migrating_chapter_log("desktop items in %s" % desktop_dir, apps_list, desktop_items, log_file)
     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, log_file)
 
     # 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"
-        log("Settings fail to transition to new unity compiz\n\n", log_file)
-        if log_file:
-            log_file.close()
-        sys.exit(1)
+    save_gsettings_favorites(apps_list, log_file)
         
     # 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"
-
-log("Migration script ended sucessfully\n\n", log_file)
+
+# second migration: transition popular docks entry as well
+if migration_level < '3.2.10':
+    log("======= Migration to 3.2.10 =======\n", log_file)
+    
+    # import awn favorites
+    awn_favorites_list = client.get_list('/apps/awn-applet-taskmanager/launcher_paths', gconf.VALUE_STRING)
+    migrating_chapter_log("awn favorites", apps_list, awn_favorites_list, log_file)
+    for launcher_location in awn_favorites_list:
+        apps_list = register_new_app(launcher_location, apps_list, log_file)
+    
+    # import Docky favorites
+    dock_list = client.get_list('/apps/docky-2/Docky/DockController/ActiveDocks', gconf.VALUE_STRING)
+    for dock in dock_list:
+        docky_favorites_list = client.get_list('/apps/docky-2/Docky/Interface/DockPreferences/%s/Launchers' % dock, gconf.VALUE_STRING)
+        migrating_chapter_log("Docky favorites for %s" % dock, apps_list, docky_favorites_list, log_file)
+        for launcher_location in docky_favorites_list:
+            try:
+                launcher_location = launcher_location.split("file://")[1]
+            except IndexError:
+                pass
+            apps_list = register_new_app(launcher_location, apps_list, log_file)
+
+    # import Cairo-Dock favorites
+    try:
+        cairodock_path = "%s/cairo-dock/current_theme/launchers" % BaseDirectory.xdg_config_home
+        cairodock_favorites_list = os.listdir(cairodock_path)
+        migrating_chapter_log("Cairo-Dock favorites (in %s)" % cairodock_path, apps_list, cairodock_favorites_list, log_file)
+        for launcher in cairodock_favorites_list:
+            launcher_location = "%s/%s" % (cairodock_path, launcher)
+            apps_list = register_new_app(launcher_location, apps_list, log_file)
+    except OSError:
+        log(" + Can't migrate Cairo-Dock as %s doesn't exist" % cairodock_path, log_file)
+        
+    # Now write to gsettings!
+    save_gsettings_favorites(apps_list, log_file)
+
+log("Migration script ended successfully\n\n", log_file)
 if log_file:
     log_file.close()