cinnamon-desktop-editor: Use a path when setting a panel-launcher

icon.

If an icon name is used in the panel launcher applet, and the user
switches to an icon theme that doesn't have that icon name, the
launcher will disappear.

Now, the selected icon's path is checked - if it's coming from the
hicolor theme, it's left as-is (since hicolor is inherited by the
active theme). Otherwise, the icon's path is stored instead of its
name, so it will remain valid regardless of future themes.

Add an optional 'icon-size' argument to cinnamon-desktop-editor,
so the path to an appropriately-sized icon is used for the launcher.

Author: mtwebster

files/usr/share/cinnamon/applets/[email protected]/applet.js

@@ -682,9 +682,11 @@ class CinnamonPanelLaunchersApplet extends Applet.Applet {
 
     showAddLauncherDialog(timestamp, launcher){
         if (launcher) {
-            Util.spawnCommandLine("cinnamon-desktop-editor -mcinnamon-launcher -f" + launcher.getId() + " " + this.settings.file.get_path());
+            Util.spawnCommandLine("cinnamon-desktop-editor -mcinnamon-launcher --icon-size %d -f %s %s"
+                .format(this.icon_size, launcher.getId(), this.settings.file.get_path()));
         } else {
-            Util.spawnCommandLine("cinnamon-desktop-editor -mcinnamon-launcher " + this.settings.file.get_path());
+            Util.spawnCommandLine("cinnamon-desktop-editor -mcinnamon-launcher --icon-size %d %s"
+                .format(this.icon_size, this.settings.file.get_path()))
         }
     }
 

files/usr/share/cinnamon/cinnamon-desktop-editor/cinnamon-desktop-editor.py

@@ -8,6 +8,7 @@
 import shutil
 import subprocess
 from setproctitle import setproctitle
+from pathlib import Path
 
 import gi
 gi.require_version("Gtk", "3.0")
@@ -56,7 +57,7 @@ def ask(msg):
 class ItemEditor(object):
     ui_file = None
 
-    def __init__(self, item_path=None, callback=None, destdir=None):
+    def __init__(self, item_path=None, callback=None, destdir=None, icon_size=24):
         self.builder = Gtk.Builder()
         self.builder.set_translation_domain('cinnamon') # let it translate!
         self.builder.add_from_file(self.ui_file)
@@ -66,16 +67,32 @@ def __init__(self, item_path=None, callback=None, destdir=None):
 
         self.dialog.connect('response', self.on_response)
 
+        self.starting_icon = None
         self.icon_chooser = self.builder.get_object('icon-chooser')
         self.icon_chooser.get_dialog().set_property("allow-paths", True)
 
+        self.icon_size = icon_size
+        self.icon_chooser.set_icon_size(self.get_gtk_size_for_pixels(icon_size))
+
         self.build_ui()
 
         self.item_path = item_path
         self.load()
         self.check_custom_path()
         self.resync_validity()
 
+    def get_gtk_size_for_pixels(self, icon_size):
+        i = 0
+        while True:
+            try:
+                valid, width, height = Gtk.IconSize.lookup(Gtk.IconSize(i))
+                if height > icon_size:
+                    return Gtk.IconSize(i)
+            except ValueError:
+                return Gtk.IconSize.DIALOG
+
+            i += 1
+
     def build_ui(self):
         raise NotImplementedError()
 
@@ -139,6 +156,7 @@ def set_icon(self, name):
         else:
             print(val)
             self.icon_chooser.set_icon(val)
+            self.starting_icon = val
             print('icon:', self.icon_chooser.get_icon())
 
     def load(self):
@@ -178,8 +196,6 @@ def on_response(self, dialog, response):
             self.callback(True, self.item_path)
         else:
             self.callback(False, self.item_path)
-        self.dialog.destroy()
-
 
 class LauncherEditor(ItemEditor):
     ui_file = '/usr/share/cinnamon/cinnamon-desktop-editor/launcher-editor.ui'
@@ -295,13 +311,37 @@ def load(self):
         self.set_icon("Icon")
 
     def get_keyfile_edits(self):
+        icon_theme = Gtk.IconTheme.get_default()
+        icon = self.icon_chooser.get_icon()
+
+        if icon != self.starting_icon:
+            info = icon_theme.lookup_icon(icon, self.icon_size, 0)
+            if info:
+                filename = info.get_filename()
+                if not self.in_hicolor(filename):
+                    icon = filename
+
         return dict(Name=self.builder.get_object('name-entry').get_text(),
                     Exec=self.builder.get_object('exec-entry').get_text(),
                     Comment=self.builder.get_object('comment-entry').get_text(),
                     Terminal=self.builder.get_object('terminal-check').get_active(),
-                    Icon=self.icon_chooser.get_icon(),
+                    Icon=icon,
                     Type="Application")
 
+    def in_hicolor(self, path):
+        datadirs = GLib.get_system_data_dirs()
+
+        for datadir in datadirs:
+            hicolor_folder = Path(os.path.join(datadir, "icons", "hicolor"))
+            icon_path = Path(path)
+            try:
+                if icon_path.relative_to(hicolor_folder) is not None:
+                    return True
+            except ValueError:
+                pass
+
+        return False
+
     def pick_exec(self, button):
         chooser = Gtk.FileChooserDialog(title=_("Choose a command"),
                                         parent=self.dialog,
@@ -320,6 +360,7 @@ def __init__(self):
         parser.add_option("-d", "--directory", dest="destination_directory", help="Destination directory of the new launcher", metavar="DEST_DIR")
         parser.add_option("-f", "--file", dest="desktop_file", help="Name of desktop file (i.e. gnome-terminal.desktop)", metavar="DESKTOP_NAME")
         parser.add_option("-m", "--mode", dest="mode", default=None, help="Mode to run in: launcher, directory, panel-launcher or nemo-launcher")
+        parser.add_option("-i", "--icon-size", dest="icon_size", type=int, default=24, help="Size to set the icon picker for (panel-launcher only)")
         (options, args) = parser.parse_args()
 
         if not options.mode:
@@ -343,6 +384,7 @@ def __init__(self):
 
         if options.mode == "cinnamon-launcher":
             self.json_path = args[0]
+            self.icon_size = options.icon_size
 
         if self.desktop_file is not None:
             self.get_desktop_path()
@@ -354,7 +396,7 @@ def __init__(self):
             editor = LauncherEditor(self.orig_file, self.launcher_cb)
             editor.dialog.show_all()
         elif self.mode == "cinnamon-launcher":
-            editor = CinnamonLauncherEditor(self.orig_file, self.panel_launcher_cb)
+            editor = CinnamonLauncherEditor(self.orig_file, self.panel_launcher_cb, icon_size=self.icon_size)
             editor.dialog.show_all()
         elif self.mode == "nemo-launcher":
             editor = LauncherEditor(self.orig_file, self.nemo_launcher_cb, self.dest_dir)