Use XDG_CONFIG_HOME to primarily store spices configs in (#11182)

Code prioritizes new path but it will still fall back to old path
if config file only exists there

Author: Gr3q

files/usr/share/cinnamon/cinnamon-settings/bin/Spices.py

@@ -24,7 +24,8 @@
 
 home = os.path.expanduser("~")
 locale_inst = '%s/.local/share/locale' % home
-settings_dir = '%s/.cinnamon/configs/' % home
+settings_dir = os.path.join(GLib.get_user_config_dir(), 'cinnamon', 'spices')
+old_settings_dir = '%s/.cinnamon/configs/' % home
 
 URL_SPICES_HOME = "https://cinnamon-spices.linuxmint.com"
 URL_MAP = {
@@ -701,6 +702,8 @@ def _uninstall(self, job):
                 # Uninstall settings file, if any
                 if (os.path.exists(os.path.join(settings_dir, uuid))):
                     shutil.rmtree(os.path.join(settings_dir, uuid))
+                if (os.path.exists(os.path.join(old_settings_dir, uuid))):
+                    shutil.rmtree(os.path.join(old_settings_dir, uuid))
             shutil.rmtree(os.path.join(self.install_folder, uuid))
         except Exception as detail:
             self.errorMessage(_("A problem occurred while removing %s.") % job['uuid'], str(detail))

files/usr/share/cinnamon/cinnamon-settings/xlet-settings.py

@@ -17,15 +17,18 @@
 import json
 import importlib.util
 import traceback
+from pathlib import Path
 
 from JsonSettingsWidgets import *
 from ExtensionCore import find_extension_subdir
-from gi.repository import Gtk, Gio, XApp
+from gi.repository import Gtk, Gio, XApp, GLib
 
 # i18n
 gettext.install("cinnamon", "/usr/share/locale")
 
 home = os.path.expanduser("~")
+settings_dir = os.path.join(GLib.get_user_config_dir(), 'cinnamon', 'spices')
+old_settings_dir = '%s/.cinnamon/configs/' % home
 
 translations = {}
 
@@ -283,9 +286,12 @@ def check_sizing(widget, data=None):
 
     def load_instances(self):
         self.instance_info = []
-        path = "%s/.cinnamon/configs/%s" % (home, self.uuid)
+        path = Path(os.path.join(settings_dir, self.uuid))
+        old_path = Path("%s/.cinnamon/configs/%s" % (home, self.uuid))
         instances = 0
-        dir_items = sorted(os.listdir(path))
+        new_items = os.listdir(path) if path.exists() else []
+        old_items = os.listdir(old_path) if old_path.exists() else []
+        dir_items = sorted(new_items + old_items)
         try:
             multi_instance = int(self.xlet_meta["max-instances"]) != 1
         except (KeyError, ValueError):
@@ -317,7 +323,7 @@ def load_instances(self):
                 if not instance_exists:
                     continue
 
-            settings = JSONSettingsHandler(os.path.join(path, item), self.notify_dbus)
+            settings = JSONSettingsHandler(os.path.join(path if item in new_items else old_path, item), self.notify_dbus)
             settings.instance_id = instance_id
             instance_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL)
             self.instance_stack.add_named(instance_box, instance_id)

js/ui/appletManager.js

@@ -346,17 +346,20 @@ function removeAppletFromPanels(appletDefinition, deleteConfig, changed = false)
 }
 
 function _removeAppletConfigFile(uuid, instanceId) {
-    let config_path = (GLib.get_home_dir() + "/" +
-                               ".cinnamon" + "/" +
-                                 "configs" + "/" +
-                                      uuid + "/" +
-                                instanceId + ".json");
-    let file = Gio.File.new_for_path(config_path);
-    if (file.query_exists(null)) {
-        try {
-            file.delete(null);
-        } catch (e) {
-            global.logError("Problem removing applet config file during cleanup.  UUID is " + uuid + " and filename is " + config_path);
+    let config_paths = [
+        [GLib.get_home_dir(), ".cinnamon", "configs", uuid, instanceId + ".json"].join("/"),
+        [GLib.get_user_config_dir(), "cinnamon", "spices", uuid, instanceId + ".json"].join("/")
+    ];
+
+    for (let i = 0; i < config_paths.length; i++) {
+        const config_path = array[i];
+        let file = Gio.File.new_for_path(config_path);
+        if (file.query_exists(null)) {
+            try {
+                file.delete(null);
+            } catch (e) {
+                global.logError("Problem removing applet config file during cleanup.  UUID is " + uuid + " and filename is " + config_path);
+            }
         }
     }
 }

js/ui/deskletManager.js

@@ -276,17 +276,20 @@ function _unloadDesklet(deskletDefinition, deleteConfig) {
 }
 
 function _removeDeskletConfigFile(uuid, instanceId) {
-    let config_path = (GLib.get_home_dir() + "/" +
-                               ".cinnamon" + "/" +
-                                 "configs" + "/" +
-                                      uuid + "/" +
-                                instanceId + ".json");
-    let file = Gio.File.new_for_path(config_path);
-    if (file.query_exists(null)) {
-        try {
-            file.delete(null);
-        } catch (e) {
-            global.logError("Problem removing desklet config file during cleanup.  UUID is " + uuid + " and filename is " + config_path);
+    let config_paths = [
+        [GLib.get_home_dir(), ".cinnamon", "configs", uuid, instanceId + ".json"].join("/"),
+        [GLib.get_user_config_dir(), "cinnamon", "spices", uuid, instanceId + ".json"].join("/")
+    ];
+
+    for (let i = 0; i < config_paths.length; i++) {
+        const config_path = array[i];
+        let file = Gio.File.new_for_path(config_path);
+        if (file.query_exists(null)) {
+            try {
+                file.delete(null);
+            } catch (e) {
+                global.logError("Problem removing desklet config file during cleanup.  UUID is " + uuid + " and filename is " + config_path);
+            }
         }
     }
 }

js/ui/settings.js

@@ -689,10 +689,21 @@ XletSettingsBase.prototype = {
     },
 
     _ensureSettingsFiles: function() {
-        let configPath = [GLib.get_home_dir(), ".cinnamon", "configs", this.uuid].join("/");
+        let configPath = [GLib.get_user_config_dir(), "cinnamon", "spices", this.uuid].join("/");
         let configDir = Gio.file_new_for_path(configPath);
         if (!configDir.query_exists(null)) configDir.make_directory_with_parents(null);
-        this.file = configDir.get_child(this.instanceId + ".json");
+
+        let configFile = configDir.get_child(this.instanceId + ".json")
+
+        let oldConfigDir = Gio.file_new_for_path([GLib.get_home_dir(), ".cinnamon", "configs", this.uuid].join("/"));
+        let oldConfigFile = oldConfigDir.get_child(this.instanceId + ".json");
+
+        // We only use the config under the old path if it's the only one for backwards compatibility
+        if (oldConfigFile.query_exists(null) && !configFile.query_exists(null))
+            this.file = oldConfigFile;
+        else 
+            this.file = configFile;
+
         this.monitor = this.file.monitor_file(Gio.FileMonitorFlags.NONE, null);
 
         // If the settings have already been installed previously we need to check if the schema

python3/cinnamon/harvester.py

@@ -71,7 +71,7 @@ def debug(msg):
 
 home = os.path.expanduser("~")
 locale_inst = '%s/.local/share/locale' % home
-settings_dir = '%s/.cinnamon/configs/' % home
+settings_dir = os.path.join(GLib.get_user_config_dir(), 'cinnamon', 'spices')
 
 activity_logger = logger.ActivityLogger()