Skip to content

[WIP] Add early exit to xlet-settings if no instances exist, handle adding/removing xlets while xlet-settings is open. #13055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
samw-26 wants to merge 2 commits into
base: master
Choose a base branch
from
+348 −181
Open

[WIP] Add early exit to xlet-settings if no instances exist, handle adding/removing xlets while xlet-settings is open. #13055

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75c05a7
xlet-settings: Handle adding and removing applets while open
samw-26 Nov 22, 2025
cb6308c
Keybinding handling updates
samw-26 Dec 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions files/usr/share/cinnamon/cinnamon-settings/bin/JsonSettingsWidgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@ def check_settings(self, *args):
self.timeout_id = 0
old_settings = self.settings
self.settings = self.get_settings()

if self.settings is None:
return
for key in self.bindings:
new_value = self.settings[key]["value"]
if new_value != old_settings[key]["value"]:
Expand All @@ -170,9 +171,12 @@ def check_settings(self, *args):
return GLib.SOURCE_REMOVE

def get_settings(self):
file = open(self.filepath)
raw_data = file.read()
file.close()
try:
file = open(self.filepath)
raw_data = file.read()
file.close()
except FileNotFoundError:
return
try:
settings = json.loads(raw_data, object_pairs_hook=collections.OrderedDict)
except:
Expand Down
275 changes: 166 additions & 109 deletions files/usr/share/cinnamon/cinnamon-settings/bin/KeybindingTable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,11 +355,17 @@ def load_gsettings(self, *args):

def load_json_settings(self, *args):
del self.entries[:]
self.entries = self.getConfigSettings()
settings = self.getConfigSettings()
if settings is None:
return
self.entries = settings
self.json_timeout_id = 0
self.emit_changed()

def getConfigSettings(self):
if not Path(self.schema).exists():
self.settings_monitor.cancel()
return
with open(self.schema, encoding="utf-8") as config_file:
config = json.load(config_file)
keybinds = config[self.key]["value"].split("::")
Expand Down Expand Up @@ -496,6 +502,11 @@ def __init__(self):
self._collision_check_done = False
self._collision_table = {}

self._config_monitors = {
OLD_SETTINGS_DIR: {},
SETTINGS_DIR: {}
}

self._load_static_store()
self._load_custom_store()
self._load_spice_store()
Expand Down Expand Up @@ -597,7 +608,6 @@ def _load_category(cat):

def _on_enabled_spices_changed(self, settings, key, data=None):
self._load_spice_store()
self.emit("spices-changed")

def _load_spice_store(self):
try:
Expand All @@ -611,131 +621,178 @@ def _load_spice_store(self):
settings.connect("changed::enabled-extensions", self._on_enabled_spices_changed)

enabled_extensions = set()
enabled_spices = set()
enabled_spices = {
"applets": {},
"desklets": {},
"extensions": {}
}

for applets in settings.get_strv("enabled-applets"):
p, pos, order, applet_uuid, *extra = applets.split(":")
if len(extra) > 0:
instance_id = extra[0]
else:
instance_id = None
enabled_spices.add((applet_uuid, 'applets', instance_id))

enabled_spices["applets"].setdefault(applet_uuid, set()).add(instance_id)
for desklets in settings.get_strv("enabled-desklets"):
desklet_uuid, instance_id, x, y = desklets.split(":")
enabled_spices.add((desklet_uuid, 'desklets', instance_id))
enabled_spices["desklets"].setdefault(desklet_uuid, set()).add(instance_id)

for extension in settings.get_strv("enabled-extensions"):
enabled_extensions.add(extension)
enabled_spices.add((extension, 'extensions', None))

keyboard_spices = sorted(enabled_spices)
enabled_spices["extensions"].setdefault(extension, set()).add(None)
spice_keybinds = {}
spice_properties = {}

for uuid, _type, instance_id in keyboard_spices:
for settings_dir in (OLD_SETTINGS_DIR, SETTINGS_DIR):
config_path = Path.joinpath(settings_dir, uuid)
if Path.exists(config_path):
configs = [x for x in os.listdir(config_path) if x.endswith(".json")]
# If we encounted numbered and non-numbered, config files, filter out the uuid-named one
if not all(x.split(".json")[0].isdigit() for x in configs) and any(x.split(".json")[0].isdigit() for x in configs):
for index, value in enumerate(configs):
if not value.split(".json")[0].isdigit():
configs.pop(index)
for config in configs:
config_json = Path.joinpath(config_path, config)
_id = config.split(".json")[0]
key_name = f"{uuid}_{_id}" if _id.isdigit() else uuid
with open(config_json, encoding="utf-8") as config_file:
_config = json.load(config_file)

for key, val in _config.items():
if isinstance(val, dict) and val.get("type") == "keybinding":
spice_properties.setdefault(key_name, {})
spice_properties[key_name]["highlight"] = uuid not in enabled_extensions
spice_properties[key_name]["path"] = str(config_json)
spice_properties[key_name]["type"] = _type
spice_properties[key_name]["uuid"] = uuid
spice_properties[key_name]["instance_id"] = instance_id
spice_properties[key_name]["config_id"] = _id
spice_keybinds.setdefault(key_name, {})
spice_keybinds[key_name].setdefault(key, {})
spice_keybinds[key_name][key] = {val.get("description"): val.get("value").split("::")}

self._spice_categories = {}
self._spice_store = []

new_categories = []
new_keybindings = []

for spice, bindings in spice_keybinds.items():
uuid, *_id = spice.split("_")

spice_props = spice_properties[spice]
_type = spice_props["type"]
local_metadata_path = Path.home() / '.local/share/cinnamon' / _type / uuid / 'metadata.json'
if local_metadata_path.exists():
gettext.bindtextdomain(uuid, str(Path.home() / '.local/share/locale'))
gettext.textdomain(uuid)
with open(local_metadata_path, encoding="utf-8") as metadata:
json_data = json.load(metadata)
category_label = _(json_data["name"])
else:
system_metadata_path = Path("/usr/share/cinnamon") / _type / uuid / "metadata.json"
if system_metadata_path.exists():
with open(system_metadata_path, encoding="utf-8") as metadata:
def set_properties(_type, uuid, config_path, configs):
for config in configs:
config_json = Path.joinpath(config_path, config)
_id = config.split(".json")[0]
key_name = f"{uuid}_{_id}" if _id.isdigit() else uuid
with open(config_json, encoding="utf-8") as config_file:
_config = json.load(config_file)

for key, val in _config.items():
if isinstance(val, dict) and val.get("type") == "keybinding":
spice_properties.setdefault(key_name, {})
spice_properties[key_name]["highlight"] = uuid not in enabled_extensions
spice_properties[key_name]["path"] = str(config_json)
spice_properties[key_name]["type"] = _type
spice_properties[key_name]["uuid"] = uuid
spice_properties[key_name]["instance_id"] = _id
Copy link
Contributor Author

@samw-26 samw-26 Dec 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the instance_id property to be the same as config id. I was not sure why there was a distinction before, let me know if this is okay?

spice_properties[key_name]["config_id"] = _id
spice_keybinds.setdefault(key_name, {})
spice_keybinds[key_name].setdefault(key, {})
spice_keybinds[key_name][key] = {val.get("description"): val.get("value").split("::")}


def on_dir_changed(monitor, file, other_file, event_type, _type, uuid, config_path, get_configs):
if event_type != Gio.FileMonitorEvent.CHANGES_DONE_HINT:
return
monitor.cancel()
del self._config_monitors[config_path.parent][uuid]
set_properties(_type, uuid, config_path, get_configs(config_path))
resume()


def has_monitors():
for value in self._config_monitors.values():
if len(value):
return True
return False


def resume():
if has_monitors():
return
finish_load()


for _type, value in enabled_spices.items():
for uuid, instance_ids in value.items():
for settings_dir in (OLD_SETTINGS_DIR, SETTINGS_DIR):
config_path = Path.joinpath(settings_dir, uuid)
if not Path.exists(config_path):
continue

def get_configs(config_path):
configs = [x for x in os.listdir(config_path) if x.endswith(".json")]
# If we encounted numbered and non-numbered, config files, filter out the uuid-named one
if not all(x.split(".json")[0].isdigit() for x in configs) and any(x.split(".json")[0].isdigit() for x in configs):
for index, value in enumerate(configs):
if not value.split(".json")[0].isdigit():
configs.pop(index)
return configs

configs = get_configs(config_path)
# Must wait until config file is created/deleted
if len(configs) != len(instance_ids):
g_config_dir = Gio.File.new_for_path(str(config_path))
monitor = g_config_dir.monitor_directory(Gio.FileMonitorFlags.NONE, None)
monitor.connect("changed", on_dir_changed, _type, uuid, config_path, get_configs)
self._config_monitors[settings_dir][uuid] = monitor
continue

set_properties(_type, uuid, config_path, configs)

def finish_load():
self._spice_categories = {}
self._spice_store = []

new_categories = []
new_keybindings = []

for spice, bindings in spice_keybinds.items():
uuid, *_id = spice.split("_")

spice_props = spice_properties[spice]
_type = spice_props["type"]
local_metadata_path = Path.home() / '.local/share/cinnamon' / _type / uuid / 'metadata.json'
if local_metadata_path.exists():
gettext.bindtextdomain(uuid, str(Path.home() / '.local/share/locale'))
gettext.textdomain(uuid)
with open(local_metadata_path, encoding="utf-8") as metadata:
json_data = json.load(metadata)
category_label = _(json_data["name"])
if not _id:
cat_label = category_label if category_label else uuid
new_categories.append([cat_label, uuid, "spices", None, spice_props])
instance_num = 1
elif len(new_categories) == 0 or uuid != new_categories[-1][2]:
cat_label = category_label if category_label else uuid
new_categories.append([cat_label, uuid, "spices", None, {}])
instance_num = 1
label = _("Instance") + f" {instance_num}"
new_categories.append([label, f"{uuid}_{instance_num}", uuid, None, spice_props])
instance_num = 2
elif len(new_categories) > 0 and uuid == new_categories[-1][2]:
label = _("Instance") + f" {instance_num}"
new_categories.append([label, f"{uuid}_{instance_num}", uuid, None, spice_props])
instance_num += 1

dbus_info = {}
dbus_info["highlight"] = spice_props["highlight"]
dbus_info["uuid"] = spice_props["uuid"]
dbus_info["instance_id"] = spice_props["instance_id"]
dbus_info["config_id"] = spice_props["config_id"]
for binding_key, binding_values in bindings.items():
if "@cinnamon.org" in uuid:
binding_label = _(list(binding_values.keys())[0])
else:
home = os.path.expanduser("~")
gettext.bindtextdomain(uuid, f"{home}/.local/share/locale")
gettext.textdomain(uuid)
binding_label = gettext.gettext(list(binding_values.keys())[0])
binding_schema = spice_properties[spice]["path"]
binding_category = f"{uuid}_{instance_num - 1}" if _id else uuid
new_keybindings.append([binding_label, binding_schema, binding_key, binding_category, dbus_info])
self._spice_categories[binding_category] = category_label

cat_lookup = {}

for cat in new_categories:
cat_lookup[cat[1]] = cat[0]
self._spice_store.append(KeyBindingCategory(cat[0], cat[1], cat[2], cat[3], cat[4]))

for binding in new_keybindings:
self._spice_categories.setdefault(binding[3], cat_lookup[binding[3]])
for category in self._spice_store:
if category.int_name == binding[3]:
kb = KeyBinding(binding[0], binding[1], binding[2], binding[3], self.settings_by_schema_id, binding[4])
kb.connect("changed", self._on_kb_changed)

self._add_to_collision_table(kb)
category.add(kb)
system_metadata_path = Path("/usr/share/cinnamon") / _type / uuid / "metadata.json"
if system_metadata_path.exists():
with open(system_metadata_path, encoding="utf-8") as metadata:
json_data = json.load(metadata)
category_label = _(json_data["name"])
if not _id:
cat_label = category_label if category_label else uuid
new_categories.append([cat_label, uuid, "spices", None, spice_props])
instance_num = 1
elif len(new_categories) == 0 or uuid != new_categories[-1][2]:
cat_label = category_label if category_label else uuid
new_categories.append([cat_label, uuid, "spices", None, {}])
instance_num = 1
label = _("Instance") + f" {instance_num}"
new_categories.append([label, f"{uuid}_{instance_num}", uuid, None, spice_props])
instance_num = 2
elif len(new_categories) > 0 and uuid == new_categories[-1][2]:
label = _("Instance") + f" {instance_num}"
new_categories.append([label, f"{uuid}_{instance_num}", uuid, None, spice_props])
instance_num += 1

dbus_info = {}
dbus_info["highlight"] = spice_props["highlight"]
dbus_info["uuid"] = spice_props["uuid"]
dbus_info["instance_id"] = spice_props["instance_id"]
dbus_info["config_id"] = spice_props["config_id"]
for binding_key, binding_values in bindings.items():
if "@cinnamon.org" in uuid:
binding_label = _(list(binding_values.keys())[0])
else:
home = os.path.expanduser("~")
gettext.bindtextdomain(uuid, f"{home}/.local/share/locale")
gettext.textdomain(uuid)
binding_label = gettext.gettext(list(binding_values.keys())[0])
binding_schema = spice_properties[spice]["path"]
binding_category = f"{uuid}_{instance_num - 1}" if _id else uuid
new_keybindings.append([binding_label, binding_schema, binding_key, binding_category, dbus_info])
self._spice_categories[binding_category] = category_label

cat_lookup = {}

for cat in new_categories:
cat_lookup[cat[1]] = cat[0]
self._spice_store.append(KeyBindingCategory(cat[0], cat[1], cat[2], cat[3], cat[4]))

for binding in new_keybindings:
self._spice_categories.setdefault(binding[3], cat_lookup[binding[3]])
for category in self._spice_store:
if category.int_name == binding[3]:
kb = KeyBinding(binding[0], binding[1], binding[2], binding[3], self.settings_by_schema_id, binding[4])
kb.connect("changed", self._on_kb_changed)

self._add_to_collision_table(kb)
category.add(kb)
self.emit("spices-changed")

resume()


def _load_custom_store(self):
settings = self._get_settings_for_schema(CUSTOM_KEYS_PARENT_SCHEMA)
Expand Down
2 changes: 1 addition & 1 deletion files/usr/share/cinnamon/cinnamon-settings/bin/SettingsWidgets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from KeybindingWidgets import ButtonKeybinding
import util

import KeybindingTable
from bin import KeybindingTable

settings_objects = {}

Expand Down
Loading
Loading