cc: migrate some settings to cache

port 1.5

(cherry picked from commit e9bc0169f6)

quickshell/Common/CacheData.qml

@@ -11,7 +11,7 @@ Singleton {
     id: root
     readonly property var log: Log.scoped("CacheData")
 
-    readonly property int cacheConfigVersion: 1
+    readonly property int cacheConfigVersion: 2
 
     readonly property bool isGreeterMode: Quickshell.env("DMS_RUN_GREETER") === "1" || Quickshell.env("DMS_RUN_GREETER") === "true"
 
@@ -19,10 +19,21 @@ Singleton {
     readonly property string _stateDir: Paths.strip(_stateUrl)
 
     property bool _loading: false
+    property bool _hasLoaded: false
+    property int _loadedCacheVersion: 0
+
+    readonly property var _pinKeys: ["brightnessDevicePins", "wifiNetworkPins", "bluetoothDevicePins", "audioInputDevicePins", "audioOutputDevicePins"]
+    readonly property var _dataKeys: ["wallpaperLastPath", "profileLastPath", "fileBrowserSettings"].concat(_pinKeys)
 
     property string wallpaperLastPath: ""
     property string profileLastPath: ""
 
+    property var brightnessDevicePins: ({})
+    property var wifiNetworkPins: ({})
+    property var bluetoothDevicePins: ({})
+    property var audioInputDevicePins: ({})
+    property var audioOutputDevicePins: ({})
+
     property var fileBrowserSettings: ({
             "wallpaper": {
                 "lastPath": "",
@@ -82,8 +93,46 @@ Singleton {
 
     function loadCache() {
         _loading = true;
-        parseCache(cacheFile.text());
+        try {
-        _loading = false;
+            parseCache(cacheFile.text());
+        } finally {
+            _loading = false;
+            _hasLoaded = true;
+        }
+    }
+
+    function set(key, value) {
+        if (_dataKeys.indexOf(key) < 0) {
+            log.warn("Unknown cache key:", key);
+            return;
+        }
+        root[key] = value;
+        saveCache();
+    }
+
+    function migratePins(pins) {
+        if (!pins)
+            return;
+        if (!_hasLoaded)
+            loadCache();
+        if (_loadedCacheVersion >= cacheConfigVersion)
+            return;
+
+        let migrated = false;
+        for (const key of _pinKeys) {
+            const legacy = pins[key];
+            if (!legacy || Object.keys(legacy).length === 0)
+                continue;
+            if (Object.keys(root[key] || {}).length > 0)
+                continue;
+            root[key] = legacy;
+            migrated = true;
+        }
+
+        if (!migrated)
+            return;
+        log.info("Migrated device pins from settings.json");
+        saveCache();
     }
 
     function parseCache(content) {
@@ -91,6 +140,7 @@ Singleton {
         try {
             if (content && content.trim()) {
                 const cache = JSON.parse(content);
+                _loadedCacheVersion = cache.configVersion || 0;
 
                 wallpaperLastPath = cache.wallpaperLastPath !== undefined ? cache.wallpaperLastPath : "";
                 profileLastPath = cache.profileLastPath !== undefined ? cache.profileLastPath : "";
@@ -126,6 +176,10 @@ Singleton {
                     };
                 }
 
+                for (const key of _pinKeys) {
+                    root[key] = cache[key] !== undefined ? cache[key] : {};
+                }
+
                 if (cache.configVersion === undefined) {
                     migrateFromUndefinedToV1(cache);
                     cleanupUnusedKeys();
@@ -142,12 +196,16 @@ Singleton {
     function saveCache() {
         if (_loading)
             return;
-        cacheFile.setText(JSON.stringify({
+        const data = {
             "wallpaperLastPath": wallpaperLastPath,
             "profileLastPath": profileLastPath,
             "fileBrowserSettings": fileBrowserSettings,
             "configVersion": cacheConfigVersion
-        }, null, 2));
+        };
+        for (const key of _pinKeys) {
+            data[key] = root[key];
+        }
+        cacheFile.setText(JSON.stringify(data, null, 2));
     }
 
     function migrateFromUndefinedToV1(cache) {
@@ -155,7 +213,7 @@ Singleton {
     }
 
     function cleanupUnusedKeys() {
-        const validKeys = ["wallpaperLastPath", "profileLastPath", "fileBrowserSettings", "configVersion"];
+        const validKeys = _dataKeys.concat(["configVersion"]);
 
         try {
             const content = cacheFile.text();

quickshell/Common/SettingsData.qml

@@ -15,7 +15,7 @@ Singleton {
     id: root
     readonly property var log: Log.scoped("SettingsData")
 
-    readonly property int settingsConfigVersion: 12
+    readonly property int settingsConfigVersion: 13
 
     readonly property bool isGreeterMode: Quickshell.env("DMS_RUN_GREETER") === "1" || Quickshell.env("DMS_RUN_GREETER") === "true"
 
@@ -773,11 +773,6 @@ Singleton {
     property bool fadeToDpmsEnabled: true
     property int fadeToDpmsGracePeriod: 5
     property string launchPrefix: ""
-    property var brightnessDevicePins: ({})
-    property var wifiNetworkPins: ({})
-    property var bluetoothDevicePins: ({})
-    property var audioInputDevicePins: ({})
-    property var audioOutputDevicePins: ({})
 
     property bool gtkThemingEnabled: false
     property bool qtThemingEnabled: false
@@ -1741,6 +1736,7 @@ Singleton {
             let obj = (txt && txt.trim()) ? JSON.parse(txt) : null;
 
             const oldVersion = obj?.configVersion ?? 0;
+            const legacyPins = oldVersion < 13 ? Store.extractPins(obj) : null;
             if (oldVersion < settingsConfigVersion) {
                 const migrated = Store.migrateToVersion(obj, settingsConfigVersion);
                 if (migrated) {
@@ -1748,6 +1744,8 @@ Singleton {
                     obj = migrated;
                 }
             }
+            if (legacyPins)
+                Qt.callLater(() => CacheData.migratePins(legacyPins));
 
             if (obj?.lockScreenActiveMonitor !== undefined) {
                 var oldVal = obj.lockScreenActiveMonitor;

quickshell/Common/settings/SettingsSpec.js

@@ -354,11 +354,6 @@ var SPEC = {
     fadeToDpmsEnabled: { def: true },
     fadeToDpmsGracePeriod: { def: 5 },
     launchPrefix: { def: "" },
-    brightnessDevicePins: { def: {} },
-    wifiNetworkPins: { def: {} },
-    bluetoothDevicePins: { def: {} },
-    audioInputDevicePins: { def: {} },
-    audioOutputDevicePins: { def: {} },
 
     gtkThemingEnabled: { def: false, onChange: "regenSystemThemes" },
     qtThemingEnabled: { def: false, onChange: "regenSystemThemes" },

quickshell/Common/settings/SettingsStore.js

@@ -2,6 +2,21 @@
 
     .import "./SettingsSpec.js" as SpecModule
 
+var PIN_KEYS = ["brightnessDevicePins", "wifiNetworkPins", "bluetoothDevicePins", "audioInputDevicePins", "audioOutputDevicePins"];
+
+function extractPins(obj) {
+    if (!obj) return null;
+
+    var pins = null;
+    for (var i = 0; i < PIN_KEYS.length; i++) {
+        var value = obj[PIN_KEYS[i]];
+        if (!value || Object.keys(value).length === 0) continue;
+        if (!pins) pins = {};
+        pins[PIN_KEYS[i]] = value;
+    }
+    return pins;
+}
+
 function parse(root, jsonObj) {
     var SPEC = SpecModule.SPEC;
 
@@ -263,6 +278,17 @@ function migrateToVersion(obj, targetVersion) {
         settings.configVersion = 12;
     }
 
+    if (currentVersion < 13) {
+        console.info("Migrating settings from version", currentVersion, "to version 13");
+        console.info("Moving device and network pins to cache.json");
+
+        for (var p = 0; p < PIN_KEYS.length; p++) {
+            delete settings[PIN_KEYS[p]];
+        }
+
+        settings.configVersion = 13;
+    }
+
     return settings;
 }
 

quickshell/Modules/ControlCenter/Details/AudioInputDetail.qml

@@ -159,7 +159,7 @@ Rectangle {
         }
 
         function getPinnedInputs() {
-            const pins = SettingsData.audioInputDevicePins || {};
+            const pins = CacheData.audioInputDevicePins || {};
             return normalizePinList(pins["preferredInput"]);
         }
 
@@ -315,7 +315,7 @@ Rectangle {
                             cursorShape: Qt.PointingHandCursor
                             onPressed: mouse => pinRipple.trigger(mouse.x, mouse.y)
                             onClicked: {
-                                const pins = JSON.parse(JSON.stringify(SettingsData.audioInputDevicePins || {}));
+                                const pins = JSON.parse(JSON.stringify(CacheData.audioInputDevicePins || {}));
                                 let pinnedList = audioContent.normalizePinList(pins["preferredInput"]);
                                 const pinIndex = pinnedList.indexOf(modelData.name);
 
@@ -332,7 +332,7 @@ Rectangle {
                                 else
                                     delete pins["preferredInput"];
 
-                                SettingsData.set("audioInputDevicePins", pins);
+                                CacheData.set("audioInputDevicePins", pins);
                             }
                         }
                     }

quickshell/Modules/ControlCenter/Details/AudioOutputDetail.qml

@@ -169,7 +169,7 @@ Rectangle {
         }
 
         function getPinnedOutputs() {
-            const pins = SettingsData.audioOutputDevicePins || {};
+            const pins = CacheData.audioOutputDevicePins || {};
             return normalizePinList(pins["preferredOutput"]);
         }
 
@@ -324,7 +324,7 @@ Rectangle {
                             cursorShape: Qt.PointingHandCursor
                             onPressed: mouse => pinRipple.trigger(mouse.x, mouse.y)
                             onClicked: {
-                                const pins = JSON.parse(JSON.stringify(SettingsData.audioOutputDevicePins || {}));
+                                const pins = JSON.parse(JSON.stringify(CacheData.audioOutputDevicePins || {}));
                                 let pinnedList = audioContent.normalizePinList(pins["preferredOutput"]);
                                 const pinIndex = pinnedList.indexOf(modelData.name);
 
@@ -341,7 +341,7 @@ Rectangle {
                                 else
                                     delete pins["preferredOutput"];
 
-                                SettingsData.set("audioOutputDevicePins", pins);
+                                CacheData.set("audioOutputDevicePins", pins);
                             }
                         }
                     }

quickshell/Modules/ControlCenter/Details/BluetoothDetail.qml

@@ -112,7 +112,7 @@ Rectangle {
     }
 
     function getPinnedDevices() {
-        const pins = SettingsData.bluetoothDevicePins || {};
+        const pins = CacheData.bluetoothDevicePins || {};
         return normalizePinList(pins["preferredDevice"]);
     }
 
@@ -400,7 +400,7 @@ Rectangle {
                             anchors.fill: parent
                             cursorShape: Qt.PointingHandCursor
                             onClicked: {
-                                const pins = JSON.parse(JSON.stringify(SettingsData.bluetoothDevicePins || {}));
+                                const pins = JSON.parse(JSON.stringify(CacheData.bluetoothDevicePins || {}));
                                 let pinnedList = root.normalizePinList(pins["preferredDevice"]);
                                 const pinIndex = pinnedList.indexOf(pairedDelegate.modelData.address);
 
@@ -418,7 +418,7 @@ Rectangle {
                                     delete pins["preferredDevice"];
                                 }
 
-                                SettingsData.set("bluetoothDevicePins", pins);
+                                CacheData.set("bluetoothDevicePins", pins);
                             }
                         }
                     }

quickshell/Modules/ControlCenter/Details/BrightnessDetail.qml

@@ -37,7 +37,7 @@ Rectangle {
 
         const pinKey = getScreenPinKey();
         if (pinKey.length > 0) {
-            const pins = SettingsData.brightnessDevicePins || {};
+            const pins = CacheData.brightnessDevicePins || {};
             const pinnedDevice = pins[pinKey];
             if (pinnedDevice && pinnedDevice.length > 0) {
                 const found = devices.find(d => d.name === pinnedDevice);
@@ -85,12 +85,12 @@ Rectangle {
         }
         const pinKey = getScreenPinKey();
         if (pinKey.length > 0) {
-            const pins = SettingsData.brightnessDevicePins || {};
+            const pins = CacheData.brightnessDevicePins || {};
             const existing = pins[pinKey];
             if (existing && existing !== deviceName) {
                 const next = JSON.parse(JSON.stringify(pins));
                 delete next[pinKey];
-                SettingsData.set("brightnessDevicePins", next);
+                CacheData.set("brightnessDevicePins", next);
             }
         }
         root.currentDeviceName = deviceName;
@@ -106,7 +106,7 @@ Rectangle {
         const pinKey = getScreenPinKey();
         if (!pinKey || !deviceName)
             return false;
-        const pins = SettingsData.brightnessDevicePins || {};
+        const pins = CacheData.brightnessDevicePins || {};
         return pins[pinKey] === deviceName;
     }
 
@@ -114,13 +114,13 @@ Rectangle {
         const pinKey = getScreenPinKey();
         if (!pinKey || !deviceName)
             return;
-        const pins = JSON.parse(JSON.stringify(SettingsData.brightnessDevicePins || {}));
+        const pins = JSON.parse(JSON.stringify(CacheData.brightnessDevicePins || {}));
         if (pins[pinKey] === deviceName) {
             delete pins[pinKey];
         } else {
             pins[pinKey] = deviceName;
         }
-        SettingsData.set("brightnessDevicePins", pins);
+        CacheData.set("brightnessDevicePins", pins);
     }
 
     implicitHeight: {
@@ -269,7 +269,7 @@ Rectangle {
 
                     readonly property bool selected: !!(modelData && modelData.name === root.currentDeviceName)
                     readonly property bool devicePinnedHere: {
-                        SettingsData.brightnessDevicePins;
+                        CacheData.brightnessDevicePins;
                         return root.isDevicePinnedToScreen(modelData ? modelData.name : "");
                     }
 

quickshell/Modules/ControlCenter/Details/NetworkDetail.qml

@@ -49,7 +49,7 @@ Rectangle {
     }
 
     function getPinnedNetworks() {
-        const pins = SettingsData.wifiNetworkPins || {};
+        const pins = CacheData.wifiNetworkPins || {};
         return normalizePinList(pins["preferredWifi"]);
     }
 
@@ -710,7 +710,7 @@ Rectangle {
                     cursorShape: Qt.PointingHandCursor
                     onPressed: mouse => pinRipple.trigger(mouse.x, mouse.y)
                     onClicked: {
-                        const pins = JSON.parse(JSON.stringify(SettingsData.wifiNetworkPins || {}));
+                        const pins = JSON.parse(JSON.stringify(CacheData.wifiNetworkPins || {}));
                         let pinnedList = root.normalizePinList(pins["preferredWifi"]);
                         const pinIndex = pinnedList.indexOf(modelData.ssid);
 
@@ -727,7 +727,7 @@ Rectangle {
                         else
                             delete pins["preferredWifi"];
 
-                        SettingsData.set("wifiNetworkPins", pins);
+                        CacheData.set("wifiNetworkPins", pins);
                     }
                 }
             }

quickshell/Modules/ControlCenter/Widgets/BrightnessSliderRow.qml

@@ -34,7 +34,7 @@ Row {
         if (screenName && screenName.length > 0) {
             const screen = Quickshell.screens.find(s => s.name === screenName);
             const pinKey = screen ? SettingsData.getScreenDisplayName(screen) : screenName;
-            const pins = SettingsData.brightnessDevicePins || {};
+            const pins = CacheData.brightnessDevicePins || {};
             const pinnedDevice = pins[pinKey];
             if (pinnedDevice && pinnedDevice.length > 0) {
                 const found = DisplayService.devices.find(dev => dev.name === pinnedDevice);

quickshell/Modules/DankBar/Widgets/ControlCenterButton.qml

@@ -203,7 +203,7 @@ BasePill {
         const pinKey = getScreenPinKey();
         if (!pinKey)
             return "";
-        const pins = SettingsData.brightnessDevicePins || {};
+        const pins = CacheData.brightnessDevicePins || {};
         return pins[pinKey] || "";
     }
 

quickshell/Modules/Settings/NetworkWifiTab.qml

@@ -55,12 +55,12 @@ Item {
                 }
 
                 function getPinnedWifiNetworks() {
-                    const pins = SettingsData.wifiNetworkPins || {};
+                    const pins = CacheData.wifiNetworkPins || {};
                     return normalizePinList(pins["preferredWifi"]);
                 }
 
                 function toggleWifiPin(ssid) {
-                    const pins = JSON.parse(JSON.stringify(SettingsData.wifiNetworkPins || {}));
+                    const pins = JSON.parse(JSON.stringify(CacheData.wifiNetworkPins || {}));
                     let pinnedList = normalizePinList(pins["preferredWifi"]);
                     const pinIndex = pinnedList.indexOf(ssid);
 
@@ -77,7 +77,7 @@ Item {
                     else
                         delete pins["preferredWifi"];
 
-                    SettingsData.set("wifiNetworkPins", pins);
+                    CacheData.set("wifiNetworkPins", pins);
                 }
 
                 property var forgetNetworkConfirm: ConfirmModal {}

quickshell/Services/DisplayService.qml

@@ -386,7 +386,7 @@ Singleton {
         if (!focusedScreen)
             return "";
 
-        const pins = SettingsData.brightnessDevicePins || {};
+        const pins = CacheData.brightnessDevicePins || {};
         const screenKey = SettingsData.getScreenDisplayName(focusedScreen);
         if (!screenKey)
             return "";