Merge lp:~a-j-buxton/xfpanel-switch/orphan-plugins into lp:~xfpanel-switch-dev/xfpanel-switch/trunk

[Alistair Buxton]

Fix (LP: #1765565): Don't crash on corrupted panel configs.

1. Fix the problem directly:

Catch the exception if the .desktop file is missing and return false.
This will remove launchers with missing .desktop (not just the binary).

2. Fix the problem more generally:

Ignore orphan plugin configurations. This is a plugin configuration
section which is not refered to by any panel and therefore is not used.
Some old versions of xfce4-panel seem to create these, but I can't
reproduce with the latest version.

These orphans are completely ignored by the panel. Xfpanel-switch also
ignores them, unless they are launchers with missing .desktop files.
The second part of this patch cleans them out anyway.

This is tricky to test as it requires you to have a previously unidentified corruption in your panel config. However, the reporter reported that it worked on IRC. I have not heavily tested it, but it appears to have saved my configuration okay too.

In order to test it you'll have to intentionally break the panel config: add a bunch of launchers, plugins etc, then delete them from panels/panel-N/plugin-ids using settings editor so that they become orphans. Then save the configuration and load it again. The orphans should be gone.

Next add a launcher and delete the .desktop from ~/.config/xfce4/panel/. Again save and load and thebroken launcher should be gone.

In neither case should it crash. :)

[lp:~a-j-buxton/xfpanel-switch/orphan-plugins]

143. By Alistair Buxton on 2018-04-20

Be careful about which plugins are deleted.

If the key /plugins/plugin-2 is deemed to be bad, we should not delete
/plugins/plugin-20 for example. So check that the keys to be deleted
either exactly match, or start with the pattern + '/'.

144. By Alistair Buxton on 2018-04-20

Check for orphans also when loading a config.

Because of the way the configuration copying is used, sometimes orphans
can persist in configs (because they don't go through xfconf.)

=== modified file 'xfpanel-switch/panelconfig.py'
--- xfpanel-switch/panelconfig.py	2018-04-13 21:34:06 +0000
+++ xfpanel-switch/panelconfig.py	2018-04-20 05:14:55 +0000
@@ -61,6 +61,7 @@
 
             pc.properties[pp] = pv
 
+        pc.remove_orphans()
         pc.find_desktops()
 
         pc.source = None
@@ -80,12 +81,40 @@
             except:
                 pass
 
+        pc.remove_orphans()
         pc.find_desktops()
 
         return pc
 
+    def remove_orphans(self):
+        plugin_ids = set()
+        rem_keys = []
+
+        for pp, pv in self.properties.items():
+            path = pp.split('/')
+            if len(path) == 4 and path[0] == '' and path[1] == 'panels' and \
+                    path[2].startswith('panel-') and path[3] == 'plugin-ids':
+                plugin_ids.update(pv)
+
+        for pp, pv in self.properties.items():
+            path = pp.split('/')
+            if len(path) == 3 and path[0] == '' and path[1] == 'plugins' and \
+                    path[2].startswith('plugin-'):
+                number = path[2].split('-')[1]
+                try:
+                    if int(number) not in plugin_ids:
+                        rem_keys.append('/plugins/plugin-' + number)
+                except ValueError:
+                    pass
+
+        self.remove_keys(rem_keys)
+
     def check_desktop(self, path):
-        bytes = self.get_desktop_source_file(path).read()
+        try:
+            bytes = self.get_desktop_source_file(path).read()
+        except FileNotFoundError:
+            # If the .desktop file does not exist at all return False
+            return False
 
         # Check if binary exists
         keyfile = GLib.KeyFile.new()
@@ -99,7 +128,7 @@
         return False
 
     def find_desktops(self):
-        remove_keys = []
+        rem_keys = []
 
         for pp, pv in self.properties.items():
             path = pp.split('/')
@@ -114,13 +143,16 @@
                         if self.check_desktop(desktop_path):
                             self.desktops.append(desktop_path)
                         else:
-                            remove_keys.append('/plugins/plugin-' + number)
-
+                            rem_keys.append('/plugins/plugin-' + number)
+
+        self.remove_keys(rem_keys)
+
+    def remove_keys(self, rem_keys):
         keys = list(self.properties.keys())
         for param in keys:
-            for bad_plugin in remove_keys:
-                if param.startswith(bad_plugin):
-                    self.properties.pop(param, None)
+            for bad_plugin in rem_keys:
+                if param == bad_plugin or param.startswith(bad_plugin+'/'):
+                    del self.properties[param]
 
     def get_desktop_source_file(self, desktop):
         if getattr(self, 'source', None) is None: