Skip to content

extension: Add SettingsOverrider to preserve user settings #244

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

Merged
Leleat merged 2 commits into from
Apr 2, 2023
Merged

extension: Add SettingsOverrider to preserve user settings #244

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
89a97a5
common: Add more getters and setters for settings
3v1n0 Mar 15, 2023
a0ecbd5
extension: Add SettingsOverrider to preserve user settings
3v1n0 Mar 15, 2023
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
186 changes: 131 additions & 55 deletions tiling-assistant@leleat-on-github/extension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,123 @@ const { Rect, Util } = Me.imports.src.extension.utility;
* => resizeHandler.js (when resizing a window)
*/

class SettingsOverrider {
constructor(settings) {
this._settings = settings;
this._overrides = new Map();
this._originalSettings = new Map();
this._maybeNullValue = GLib.Variant.new_maybe(
new GLib.VariantType('b'), null);

const savedSettings = this._settings.getUserValue('overridden-settings');
this._wasOverridden = savedSettings !== null;
Copy link
Copy Markdown
Collaborator

@Leleat Leleat Mar 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

IMO this._wasOverridden doesn't really commumicate what it actually stands for. From what I can tell, this is only used if the extension (or GNOME Shell) was shutdown unexpectedly so that the extension's disable function wasn't called and the setting wasn't cleaned up properly. So how about something like _previousShutdownWasDirty, previousCleanupWasSkipped, savedSettingsWereCorrupted or something similiar

}

_maybeUpdateOverriden(schemaId, key, value) {
if (this._wasOverridden)
return undefined;
Copy link
Copy Markdown
Collaborator

@Leleat Leleat Mar 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Doesn't look like you actually need the return value from this method (and the name _maybeUpdateOverriden doesn't really suggest that there is a return value). So maybe remove it? (Same for L68)


const savedSettings = this._settings.getValue(
'overridden-settings').deepUnpack();
const prefKey = `${schemaId}.${key}`;
const oldValue = savedSettings[prefKey];

if (value !== undefined)
savedSettings[prefKey] = value ?? this._maybeNullValue;
else
delete savedSettings[prefKey];

this._settings.setValue('overridden-settings',
new GLib.Variant('a{sv}', savedSettings));

return oldValue;
}

add(settings, key, value) {
this._originalSettings.set(settings.schemaId, settings);
const userValue = settings.get_user_value(key);

const values = this._overrides.get(settings.schemaId) ?? new Map();
if (!values.size)
this._overrides.set(settings.schemaId, values);
values.set(key, userValue);

settings.set_value(key, value);

this._maybeUpdateOverriden(settings.schemaId, key,
userValue ?? this._maybeNullValue);
}

remove(schema, key) {
const settings = this._originalSettings.get(schema);
if (!settings)
return;

const values = this._overrides.get(settings.schemaId);
const value = values?.get(key);

if (value === undefined)
return;

if (value)
settings.set_value(key, value);
else
settings.reset(key);

values.delete(key);
this._maybeUpdateOverriden(settings.schemaId, key, undefined);
}
Comment on lines +86 to +104
Copy link
Copy Markdown
Collaborator

@Leleat Leleat Mar 23, 2023

Choose a reason for hiding this comment

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

This seems unused. Do you think it is needed in the future? I don't mind leaving it in either way, up to you.


_clear() {
if (this._wasOverridden) {
const savedSettings = this._settings.getValue(
'overridden-settings').unpack();

Object.entries(savedSettings).forEach(([path, value]) => {
const splits = path.split('.');
const key = splits.at(-1);
const schemaId = splits.slice(0, -1).join('.');

const settings = this._originalSettings.get(schemaId) ??
ExtensionUtils.getSettings(schemaId);

value = value.get_variant();
if (value.equal(this._maybeNullValue))
settings.reset(key);
else
settings.set_value(key, value);
});
} else {
this._originalSettings.forEach(settings => {
this._overrides.get(settings.schemaId).forEach((value, key) => {
if (value)
settings.set_value(key, value);
else
settings.reset(key);
});
});
}

this._settings.reset('overridden-settings');
}

destroy() {
this._clear();
this._maybeNullValue = null;
this._originalSettings = null;
this._overrides = null;
this._settings = null;
}
}

function init() {
ExtensionUtils.initTranslations(Me.metadata.uuid);
}

function enable() {
this._settings = Me.imports.src.common.Settings;
this._settings.initialize();
this._settingsOverrider = new SettingsOverrider(this._settings);

this._twm = Me.imports.src.extension.tilingWindowManager.TilingWindowManager;
this._twm.initialize();
Expand All @@ -62,45 +172,36 @@ function enable() {
this._altTabOverride = new AltTabOverride();

// Disable native tiling.
this._gnomeMutterSettings = ExtensionUtils.getSettings('org.gnome.mutter');
this._gnomeMutterEdgeTilingUserValue = this._gnomeMutterSettings.get_user_value('edge-tiling');
this._gnomeMutterSettings.set_boolean('edge-tiling', false);

if (Gio.SettingsSchemaSource.get_default().lookup('org.gnome.shell.overrides', true)) {
this._gnomeShellSettings = ExtensionUtils.getSettings('org.gnome.shell.overrides');
this._gnomeShellEdgeTilingUserValue = this._gnomeShellSettings.get_user_value('edge-tiling');
this._gnomeShellSettings.set_boolean('edge-tiling', false);
}
this._settingsOverrider.add(ExtensionUtils.getSettings('org.gnome.mutter'),
'edge-tiling', new GLib.Variant('b', false));

// Disable native keybindings for Super+Up/Down/Left/Right
this._gnomeMutterKeybindings = ExtensionUtils.getSettings('org.gnome.mutter.keybindings');
this._gnomeDesktopKeybindings = ExtensionUtils.getSettings('org.gnome.desktop.wm.keybindings');
this._nativeKeybindings = [];
const gnomeMutterKeybindings = ExtensionUtils.getSettings(
'org.gnome.mutter.keybindings');
const gnomeDesktopKeybindings = ExtensionUtils.getSettings(
'org.gnome.desktop.wm.keybindings');
const sc = Me.imports.src.common.Shortcuts;
const emptyStrvVariant = new GLib.Variant('as', []);

if (this._gnomeDesktopKeybindings.get_strv('maximize').includes('<Super>Up') &&
if (gnomeDesktopKeybindings.get_strv('maximize').includes('<Super>Up') &&
this._settings.getStrv(sc.MAXIMIZE).includes('<Super>Up')) {
const userValue = this._gnomeDesktopKeybindings.get_value('maximize');
this._gnomeDesktopKeybindings.set_strv('maximize', []);
this._nativeKeybindings.push([this._gnomeDesktopKeybindings, 'maximize', userValue]);
this._settingsOverrider.add(gnomeDesktopKeybindings,
'maximize', emptyStrvVariant);
}
if (this._gnomeDesktopKeybindings.get_strv('unmaximize').includes('<Super>Down') &&
if (gnomeDesktopKeybindings.get_strv('unmaximize').includes('<Super>Down') &&
this._settings.getStrv(sc.RESTORE_WINDOW).includes('<Super>Down')) {
const userValue = this._gnomeDesktopKeybindings.get_value('unmaximize');
this._gnomeDesktopKeybindings.set_strv('unmaximize', []);
this._nativeKeybindings.push([this._gnomeDesktopKeybindings, 'unmaximize', userValue]);
this._settingsOverrider.add(gnomeDesktopKeybindings,
'unmaximize', emptyStrvVariant);
}
if (this._gnomeMutterKeybindings.get_strv('toggle-tiled-left').includes('<Super>Left') &&
if (gnomeMutterKeybindings.get_strv('toggle-tiled-left').includes('<Super>Left') &&
this._settings.getStrv(sc.LEFT).includes('<Super>Left')) {
const userValue = this._gnomeMutterKeybindings.get_value('toggle-tiled-left');
this._gnomeMutterKeybindings.set_strv('toggle-tiled-left', []);
this._nativeKeybindings.push([this._gnomeMutterKeybindings, 'toggle-tiled-left', userValue]);
this._settingsOverrider.add(gnomeMutterKeybindings,
'toggle-tiled-left', emptyStrvVariant);
}
if (this._gnomeMutterKeybindings.get_strv('toggle-tiled-right').includes('<Super>Right') &&
if (gnomeMutterKeybindings.get_strv('toggle-tiled-right').includes('<Super>Right') &&
this._settings.getStrv(sc.RIGHT).includes('<Super>Right')) {
const userValue = this._gnomeMutterKeybindings.get_value('toggle-tiled-right');
this._gnomeMutterKeybindings.set_strv('toggle-tiled-right', []);
this._nativeKeybindings.push([this._gnomeMutterKeybindings, 'toggle-tiled-right', userValue]);
this._settingsOverrider.add(gnomeMutterKeybindings,
'toggle-tiled-right', emptyStrvVariant);
}

// Include tiled windows when dragging from the top panel.
Expand Down Expand Up @@ -134,6 +235,8 @@ function disable() {
// them after the session is unlocked again.
_saveBeforeSessionLock();

this._settingsOverrider.destroy();
this._settingsOverrider = null;
this._moveHandler.destroy();
this._moveHandler = null;
this._resizeHandler.destroy();
Expand All @@ -154,33 +257,6 @@ function disable() {
this._settings.destroy();
this._settings = null;

const restoreSetting = (gsettings, key, oldValue) => {
if (gsettings) {
if (oldValue)
gsettings.set_value(key, oldValue);
else
gsettings.reset(key);
}
};

// Re-enable native tiling.
restoreSetting(this._gnomeMutterSettings,
'edge-tiling', this._gnomeMutterEdgeTilingUserValue);
this._gnomeMutterEdgeTilingUserValue = null;
this._gnomeMutterSettings = null;

restoreSetting(this._gnomeShellSettings,
'edge-tiling', this._gnomeShellEdgeTilingUserValue);
this._gnomeShellEdgeTilingUserValue = null;
this._gnomeShellSettings = null;

// Restore native keybindings for Super+Up/Down/Left/Right
this._nativeKeybindings.forEach(([kbSetting, kbName, kbOldValue]) =>
restoreSetting(kbSetting, kbName, kbOldValue));
this._nativeKeybindings = [];
this._gnomeMutterKeybindings = null;
this._gnomeDesktopKeybindings = null;

// Restore old functions.
Main.panel._getDraggableWindowForPosition = this._getDraggableWindowForPosition;
this._getDraggableWindowForPosition = null;
Expand Down
4 changes: 4 additions & 0 deletions ...ssistant@leleat-on-github/schemas/org.gnome.shell.extensions.tiling-assistant.gschema.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,5 +279,9 @@
<key name="last-version-installed" type="i">
<default>-1</default>
</key>
<key name="overridden-settings" type="a{sv}">
<!-- Private key for remembering the overridden values -->
<default>[]</default>
</key>
</schema>
</schemalist>
16 changes: 16 additions & 0 deletions tiling-assistant@leleat-on-github/src/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,14 @@ var Settings = class Settings {
return this._settings.get_boolean(key);
}

static getValue(key) {
return this._settings.get_value(key);
}

static getUserValue(key) {
return this._settings.get_user_value(key);
}

/**
* Setters
*/
Expand All @@ -167,6 +175,14 @@ var Settings = class Settings {
static setBoolean(key, value) {
this._settings.set_boolean(key, value);
}

static setValue(key, value) {
return this._settings.set_value(key, value);
}

static reset(key) {
this._settings.reset(key);
}
};

/**
Expand Down