Merge pull request #78 from nlpsuge/feature-close-windows-whitelist

Feature: close windows whitelist

Author: nlpsuge

README.md

@@ -99,13 +99,16 @@ sudo dnf install ydotool
 
 #Check the permission of `/dev/uinput`, if it's `crw-rw----+`, you can skip step 2
 # 2. Get permission to access to `/dev/uinput` as the normal user
-sudo touch /etc/udev/rules.d/60-awsm-ydotool-uinput.rules
-sudo echo '# See:
-     # https://github.com/ValveSoftware/steam-devices/blob/master/60-steam-input.rules 
-     # https://github.com/ReimuNotMoe/ydotool/issues/25
-
-     # ydotool udev write access
-     KERNEL=="uinput", SUBSYSTEM=="misc", TAG+="uaccess", OPTIONS+="static_node=uinput"' > /etc/udev/rules.d/60-awsm-ydotool-uinput.rules
+sudo touch /etc/udev/rules.d/60-awsm-ydotool-uinput.
+# Here we use `tee`, not redirect(>), to avoid `warning: An error occurred while redirecting file '/etc/udev/rules.d/60-awsm-ydotool-uinput.rules' open: Permission denied`
+# See: https://www.shellhacks.com/sudo-echo-to-file-permission-denied/
+echo '# See:
+# https://github.com/ValveSoftware/steam-devices/blob/master/60-steam-input.rules 
+# https://github.com/ReimuNotMoe/ydotool/issues/25
+
+# ydotool udev write access
+KERNEL=="uinput", SUBSYSTEM=="misc", TAG+="uaccess", OPTIONS+="static_node=uinput"' | sudo tee --append /etc/udev/rules.d/60-awsm-ydotool-uinput.rules
+cat /etc/udev/rules.d/60-awsm-ydotool-uinput.rules
 #Remove executable permission (a.k.a. x)
 sudo chmod 644 /etc/udev/rules.d/60-awsm-ydotool-uinput.rules
 
@@ -201,6 +204,14 @@ To install it:
 * Arch and derivatives:
 `pacman -S libgtop`
 
+# Developing guidance
+
+To compile the `data/org.gnome.shell.extensions.another-window-session-manager.gresource.xml`, use the bellow command:
+```shell
+cd root_of_this_project
+glib-compile-resources --sourcedir="data" --generate data/org.gnome.shell.extensions.another-window-session-manager.gresource.xml
+```
+
 # Known issues
 
 1. On both X11 and Wayland, if click restore button (<img src=icons/restore-symbolic.svg width="14" height="14">) continually during the process of restoring, the window size and position may can't be restored, and it may restore many instances of an application. **As a workaround, click the restore button (<img src=icons/restore-symbolic.svg width="14" height="14">) only once until all apps are restored.**

closeSession.js

@@ -18,9 +18,15 @@ const Constants = Me.imports.constants;
 
 const UiHelper = Me.imports.ui.uiHelper;
 
+var flags = {
+    closeWindows: 1 << 0,
+    logoff:       1 << 1,
+};
+
+var allFlags = flags.closeWindows | flags.logoff;
 
 var CloseSession = class {
-    constructor() {
+    constructor(flags) {
         this._log = new Log.Log();
         this._prefsUtils = new PrefsUtils.PrefsUtils();
         this._settings = this._prefsUtils.getSettings();
@@ -32,9 +38,7 @@ var CloseSession = class {
             flags: (Gio.SubprocessFlags.STDOUT_PIPE |
                     Gio.SubprocessFlags.STDERR_PIPE)});
 
-        // TODO Put into Settings
-        // All apps in the whitelist should be closed safely, no worrying about lost data
-        this.whitelist = ['org.gnome.Terminal.desktop', 'org.gnome.Nautilus.desktop', 'smplayer.desktop'];
+        this.flags = flags ? flags : allFlags;
     }
 
     async closeWindows(workspacePersistent) {
@@ -129,18 +133,24 @@ var CloseSession = class {
         let reason;
         try {
             if (app.get_n_windows() > 1) {
-                const appInWhitelist = this.whitelist.includes(app.get_id());
+                const whitelistString = this._settings.get_string('close-windows-whitelist');
+                const whitelist = JSON.parse(whitelistString);
+
                 let windows = this._sortWindows(app);
                 for (let i = windows.length - 1; i >= 0; i--) {
                     let window = windows[i];
-                    if (!window.can_close()) {
+                    const isInWhitelist = this._isInWhitelist(whitelist, window);
+                    if (isInWhitelist) {
+                        Log.Log.getDefault().info(`${app.get_name()} is in the whitelist`);
+                    }
+                    if (!window.can_close() && !isInWhitelist) {
                         closed = false;
                         reason = 'it has unclosable window(s)';
                         continue;
                     }
 
                     if (UiHelper.isDialog(window) 
-                        || appInWhitelist 
+                        || isInWhitelist
                         || !this._skip_app_with_multiple_windows)
                     {
                         closed = await this._deleteWindow(app, window);
@@ -172,6 +182,27 @@ var CloseSession = class {
         return [closed, reason];
     }
 
+    _isInWhitelist(whitelist, window) {
+        for (const id in whitelist) {
+            const row = whitelist[id];
+            const {
+                id_, enabled, name, compareWith, method, 
+                enableWhenCloseWindows, enableWhenLogout
+            } = row;
+            if (!enabled || !name) continue;
+
+            let compareWithValue = Function.callFunc(window, Meta.Window.prototype[`get_${compareWith}`]);
+            const matched = this._ruleMatched(compareWithValue, method, name);
+            if (matched) {
+                let _flags = 0;
+                if (enableWhenCloseWindows)     _flags = _flags | flags.closeWindows;
+                if (enableWhenLogout)           _flags = _flags | flags.logoff;
+                return true && (this.flags & _flags);
+            }
+        }
+        return false;
+    }
+
     _deleteWindow(app, metaWindow) {
         return new Promise((resolve, reject) => {
             // We use 'windows-changed' here because a confirm window could be popped up
@@ -360,7 +391,9 @@ var CloseSession = class {
                         Log.Log.getDefault().debug(`Finished to start ydotool.service. Started: ${started}`);
                         resolve(started);
                     } catch (error) {
-                        Log.Log.getDefault().error(error, 'Failed to start ydotool.service');
+                        const msg = 'Failed to start ydotool.service';
+                        Log.Log.getDefault().error(error, msg);
+                        global.notify_error(`${msg}`, `${error ? error.message : ''}`);
                         reject(false);
                     }
                 });
@@ -531,18 +564,6 @@ var CloseSession = class {
         }
     }
 
-    _skip_multiple_windows(shellApp) {
-        if (shellApp.get_n_windows() > 1 && this._skip_app_with_multiple_windows) {
-            const app_id = shellApp.get_id();
-            if (this.whitelist.includes(app_id)) {
-                this._log.debug(`${shellApp.get_name()} (${app_id}) in the whitelist. Closing it anyway.`);
-                return false;
-            }
-            return true;
-        }
-        return false;
-    }
-
     destroy() {
         if (this._defaultAppSystem) {
             this._defaultAppSystem = null;

data/ui/prefs-gtk4-columnview-simple.ui

@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <requires lib="gtk" version="4.0"/>
+  <template class="AwsmColumnViewSimple" parent="GtkBox">
+    <property name="orientation">vertical</property>
+    <child>
+      <object class="GtkBox">
+        <property name="orientation">vertical</property>
+        <style>
+          <class name="view"/>
+        </style>
+        <child>
+          <object class="GtkColumnView" id="list">
+            <property name="show-column-separators">true</property>
+            <style>
+              <class name="data-table"/>
+              <class name="list"/>
+            </style>
+            <child>
+              <object class="GtkColumnViewColumn" id="enabled">
+                <property name="title" translatable="yes">Enabled</property>
+                <property name="factory">
+                  <object class="GtkSignalListItemFactory">
+                    <signal name="setup" handler="setup_enabled_cb"/>
+                    <signal name="bind" handler="bind_enabled_cb"/>
+                  </object>
+                </property>
+              </object>
+            </child>
+            <child>
+              <object class="GtkColumnViewColumn" id="operation">
+                <property name="title" translatable="yes">Operation</property>
+                <property name="expand">0</property>
+                <property name="factory">
+                  <object class="GtkSignalListItemFactory">
+                    <signal name="setup" handler="setup_operation_cb"/>
+                    <signal name="bind" handler="bind_operation_cb"/>
+                  </object>
+                </property>
+              </object>
+            </child>
+          </object>
+        </child>
+      </object>
+    </child>
+  </template>
+</interface>

model/closeWindowsRule.js

@@ -2,6 +2,22 @@
 
 const { GObject } = imports.gi;
 
+
+var CloseWindowsWhitelist = GObject.registerClass({
+}, class CloseWindowsWhitelist extends GObject.Object {
+    id; // int. just like the id in MySQL. Used to update or delete rows.
+    name; // string. Can be any string
+    compareWith; // string. title, wm_class, wm_class_instance, app_name...
+    method; // string. equals
+    enabled; // boolean
+    enableWhenCloseWindows; // boolean
+    enableWhenLogout; // boolean
+
+    static new(param) {
+        return Object.assign(new CloseWindowsWhitelist(), param);
+    }
+});
+
 var CloseWindowsRuleBase = class {
     category; // string. Applications, Keywords
     type; // string, rule type, such as 'shortcut'

prefs.js

@@ -266,7 +266,7 @@ const Prefs = GObject.registerClass(
             } else {
                 this._log.error(new Error(`Failed to create folder: ${autostart_restore_desktop_file_path_parent}`));
             }
-        }        
+        }
     }
 );