🔀 Merge pull request #158 from Schneegans/feature/disable-on-battery

docs/changelog.md

@@ -1,5 +1,13 @@
 # Changelog of the Burn-My-Windows Extension
 
+## [Burn My Windows 17](https://github.com/schneegans/Burn-My-Windows/releases/tag/v17)
+
+**Release Date:** TBD
+
+#### New Features
+
+* An option has been added which allows to automatically disable all effects if running on battery power.
+
 ## [Burn My Windows 16](https://github.com/schneegans/Burn-My-Windows/releases/tag/v16)
 
 **Release Date:** 2022-05-21

extension.js

@@ -73,6 +73,12 @@ class Extension {
     // We will use extensionThis to refer to the extension inside the patched methods.
     const extensionThis = this;
 
+    // This is used to get the battery state.
+    const UPowerProxy = Gio.DBusProxy.makeProxyWrapper(
+      utils.getStringResource('/interfaces/org.freedesktop.UPower.xml'));
+    this._upowerProxy = new UPowerProxy(Gio.DBus.system, 'org.freedesktop.UPower',
+                                        '/org/freedesktop/UPower');
+
     // We will monkey-patch these methods. Let's store the original ones.
     this._origAddWindowClone        = Workspace.prototype._addWindowClone;
     this._origWindowRemoved         = Workspace.prototype._windowRemoved;
@@ -365,6 +371,13 @@ class Extension {
       return;
     }
 
+    // We may have to do nothing if running on battery power.
+    if (this._settings.get_boolean('disable-on-battery') && this._upowerProxy.OnBattery &&
+        previewNick == '') {
+      this._fixAnimationTimes(isDialogWindow, forOpening, null);
+      return;
+    }
+
     // There is the weird case where an animation is already ongoing. This happens when a
     // window is closed which has been created before the session was started (e.g. when
     // GNOME Shell has been restarted in the meantime).

po/burn-my-windows.pot

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: burn-my-windows\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-04-05 09:22+0200\n"
+"POT-Creation-Date: 2022-05-25 12:59+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,105 +17,105 @@ msgstr ""
 "Content-Type: text/plain; charset=CHARSET\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: prefs.js:112
+#: prefs.js:113
 msgid "Effect Options"
 msgstr ""
 
-#: prefs.js:140
+#: prefs.js:141
 msgid "Go Back"
 msgstr ""
 
-#: prefs.js:182
+#: prefs.js:183
 msgid "General Options"
 msgstr ""
 
-#: prefs.js:276
+#: prefs.js:277
 msgid "Gold Sponsors"
 msgstr ""
 
-#: prefs.js:279
+#: prefs.js:280
 msgid "Silver Sponsors"
 msgstr ""
 
-#: prefs.js:282
+#: prefs.js:283
 msgid "Bronze Sponsors"
 msgstr ""
 
-#: prefs.js:285
+#: prefs.js:286
 msgid "Past Sponsors"
 msgstr ""
 
 #. Translators: %s will be replaced by the effect's name.
-#: prefs.js:510
+#: prefs.js:509
 #, javascript-format
 msgid "Preview for %s"
 msgstr ""
 
-#: prefs.js:532
+#: prefs.js:531
 msgid "Close this Window to Preview the Effect!"
 msgstr ""
 
-#: src/BrokenGlass.js:57
+#: src/BrokenGlass.js:138
 msgid "Broken Glass"
 msgstr ""
 
-#: src/TVEffect.js:56
+#: src/TVEffect.js:77
 msgid "TV Effect"
 msgstr ""
 
-#: src/TRexAttack.js:56
+#: src/TRexAttack.js:115
 msgid "T-Rex Attack"
 msgstr ""
 
-#: src/SnapOfDisintegration.js:60
+#: src/SnapOfDisintegration.js:117
 msgid "Snap of Disintegration"
 msgstr ""
 
-#: src/Wisps.js:55
+#: src/Wisps.js:85
 msgid "Wisps"
 msgstr ""
 
-#: src/Fire.js:58
+#: src/Fire.js:99
 msgid "Fire"
 msgstr ""
 
-#: src/Fire.js:130
+#: src/Fire.js:154
 msgid "Default Fire"
 msgstr ""
 
-#: src/Fire.js:140
+#: src/Fire.js:164
 msgid "Hell Fire"
 msgstr ""
 
-#: src/Fire.js:150
+#: src/Fire.js:174
 msgid "Dark and Smutty"
 msgstr ""
 
-#: src/Fire.js:160
+#: src/Fire.js:184
 msgid "Cold Breeze"
 msgstr ""
 
-#: src/Fire.js:170
+#: src/Fire.js:194
 msgid "Santa is Coming"
 msgstr ""
 
-#: src/Hexagon.js:53
+#: src/Hexagon.js:97
 msgid "Hexagon"
 msgstr ""
 
-#: src/EnergizeA.js:54
+#: src/EnergizeA.js:79
 msgid "Energize A"
 msgstr ""
 
-#: src/Apparition.js:57
+#: src/Apparition.js:80
 msgid "Apparition"
 msgstr ""
 
-#: src/EnergizeB.js:54
+#: src/EnergizeB.js:80
 msgid "Energize B"
 msgstr ""
 
-#: src/Matrix.js:58
+#: src/Matrix.js:113
 msgid "Matrix"
 msgstr ""
 
@@ -179,21 +179,22 @@ msgstr ""
 #: resources/ui/gtk4/Hexagon.ui:178 resources/ui/gtk4/Hexagon.ui:212
 #: resources/ui/gtk4/Hexagon.ui:265 resources/ui/gtk4/EnergizeB.ui:52
 #: resources/ui/gtk4/EnergizeB.ui:98 resources/ui/gtk4/EnergizeB.ui:132
-#: resources/ui/gtk4/prefs.ui:166 resources/ui/gtk4/Apparition.ui:52
-#: resources/ui/gtk4/Apparition.ui:98 resources/ui/gtk4/Apparition.ui:144
-#: resources/ui/gtk4/Apparition.ui:190 resources/ui/gtk4/Apparition.ui:236
-#: resources/ui/gtk3/Wisps.ui:68 resources/ui/gtk3/Wisps.ui:117
-#: resources/ui/gtk3/Wisps.ui:160 resources/ui/gtk3/Fire.ui:119
-#: resources/ui/gtk3/Fire.ui:167 resources/ui/gtk3/Fire.ui:215
-#: resources/ui/gtk3/Fire.ui:277 resources/ui/gtk3/Fire.ui:345
-#: resources/ui/gtk3/TVEffect.ui:61 resources/ui/gtk3/TVEffect.ui:104
-#: resources/ui/gtk3/EnergizeA.ui:68 resources/ui/gtk3/EnergizeA.ui:117
-#: resources/ui/gtk3/EnergizeA.ui:160 resources/ui/gtk3/Hexagon.ui:75
-#: resources/ui/gtk3/Hexagon.ui:124 resources/ui/gtk3/Hexagon.ui:173
-#: resources/ui/gtk3/Hexagon.ui:216 resources/ui/gtk3/Hexagon.ui:259
-#: resources/ui/gtk3/Hexagon.ui:321 resources/ui/gtk3/EnergizeB.ui:68
-#: resources/ui/gtk3/EnergizeB.ui:117 resources/ui/gtk3/EnergizeB.ui:160
-#: resources/ui/gtk3/prefs.ui:219 resources/ui/gtk3/Apparition.ui:89
+#: resources/ui/gtk4/prefs.ui:166 resources/ui/gtk4/prefs.ui:200
+#: resources/ui/gtk4/Apparition.ui:52 resources/ui/gtk4/Apparition.ui:98
+#: resources/ui/gtk4/Apparition.ui:144 resources/ui/gtk4/Apparition.ui:190
+#: resources/ui/gtk4/Apparition.ui:236 resources/ui/gtk3/Wisps.ui:68
+#: resources/ui/gtk3/Wisps.ui:117 resources/ui/gtk3/Wisps.ui:160
+#: resources/ui/gtk3/Fire.ui:119 resources/ui/gtk3/Fire.ui:167
+#: resources/ui/gtk3/Fire.ui:215 resources/ui/gtk3/Fire.ui:277
+#: resources/ui/gtk3/Fire.ui:345 resources/ui/gtk3/TVEffect.ui:61
+#: resources/ui/gtk3/TVEffect.ui:104 resources/ui/gtk3/EnergizeA.ui:68
+#: resources/ui/gtk3/EnergizeA.ui:117 resources/ui/gtk3/EnergizeA.ui:160
+#: resources/ui/gtk3/Hexagon.ui:75 resources/ui/gtk3/Hexagon.ui:124
+#: resources/ui/gtk3/Hexagon.ui:173 resources/ui/gtk3/Hexagon.ui:216
+#: resources/ui/gtk3/Hexagon.ui:259 resources/ui/gtk3/Hexagon.ui:321
+#: resources/ui/gtk3/EnergizeB.ui:68 resources/ui/gtk3/EnergizeB.ui:117
+#: resources/ui/gtk3/EnergizeB.ui:160 resources/ui/gtk3/prefs.ui:219
+#: resources/ui/gtk3/prefs.ui:263 resources/ui/gtk3/Apparition.ui:89
 #: resources/ui/gtk3/Apparition.ui:138 resources/ui/gtk3/Apparition.ui:187
 #: resources/ui/gtk3/Apparition.ui:236 resources/ui/gtk3/Apparition.ui:285
 msgid "Reset to Default Value"
@@ -342,6 +343,10 @@ msgstr ""
 msgid "Also Add Effects to Dialogs"
 msgstr ""
 
+#: resources/ui/gtk4/prefs.ui:184 resources/ui/gtk3/prefs.ui:242
+msgid "Disable on Battery Power"
+msgstr ""
+
 #: resources/ui/gtk4/Apparition.ui:116 resources/ui/gtk3/Apparition.ui:161
 msgid "Twirl Intensity"
 msgstr ""

prefs.js

@@ -14,7 +14,6 @@
 'use strict';
 
 const {Gio, Gtk, Gdk, GLib, GObject} = imports.gi;
-const ByteArray                      = imports.byteArray;
 
 // libadwaita is available starting with GNOME Shell 42.
 let Adw = null;
@@ -95,7 +94,7 @@ var PreferencesDialog = class PreferencesDialog {
 
     // Bind general options properties.
     this.bindSwitch('destroy-dialogs');
-
+    this.bindSwitch('disable-on-battery');
 
     // Starting with GNOME Shell 42, the settings dialog uses libadwaita (at least most of
     // the time - it seems that pop!_OS does not support libadwaita even on GNOME 42). We
@@ -460,9 +459,7 @@ var PreferencesDialog = class PreferencesDialog {
   // Reads the contents of a JSON file contained in the global resources archive. The data
   // is parsed and returned as a JavaScript object / array.
   _getJSONResource(path) {
-    const data   = Gio.resources_lookup_data(path, 0);
-    const string = ByteArray.toString(ByteArray.fromGBytes(data));
-    return JSON.parse(string);
+    return JSON.parse(utils.getStringResource(path));
   }
 
   // This traverses the widget tree below the given parent recursively and returns the

resources/interfaces/org.freedesktop.UPower.xml

@@ -0,0 +1,6 @@
+<node>
+    <interface name="org.freedesktop.UPower">
+        <property name="OnBattery" type="b" access="read" />
+    </interface>
+</node>
+  

resources/ui/gtk3/prefs.ui

@@ -227,6 +227,50 @@
               </object>
             </child>
 
+            <child>
+              <object class="GtkListBoxRow">
+                <property name="margin-start">10</property>
+                <property name="margin-end">10</property>
+                <property name="margin-top">10</property>
+                <property name="margin-bottom">10</property>
+                <property name="activatable">0</property>
+                <child>
+                  <object class="GtkBox">
+                    <property name="spacing">8</property>
+                    <child>
+                      <object class="GtkLabel">
+                        <property name="label" translatable="yes">Disable on Battery Power</property>
+                        <property name="xalign">0</property>
+                        <property name="halign">start</property>
+                        <property name="valign">center</property>
+                        <property name="hexpand">1</property>
+                      </object>
+                    </child>
+                    <child>
+                      <object class="GtkSwitch" id="disable-on-battery">
+                        <property name="halign">end</property>
+                        <property name="valign">center</property>
+                      </object>
+                    </child>
+                    <child>
+                      <object class="GtkButton" id="reset-disable-on-battery">
+                        <child>
+                          <object class="GtkImage">
+                            <property name="icon-name">edit-clear-symbolic</property>
+                            <property name="icon-size">1</property>
+                          </object>
+                        </child>
+                        <property name="tooltip-text" translatable="yes">Reset to Default Value</property>
+                        <style>
+                          <class name="flat" />
+                        </style>
+                      </object>
+                    </child>
+                  </object>
+                </child>
+              </object>
+            </child>
+
           </object>
         </child>
       </object>

resources/ui/gtk4/prefs.ui

@@ -174,6 +174,40 @@
               </object>
             </child>
 
+            <child>
+              <object class="GtkListBoxRow">
+                <property name="activatable">0</property>
+                <child>
+                  <object class="GtkBox">
+                    <child>
+                      <object class="GtkLabel">
+                        <property name="label" translatable="yes">Disable on Battery Power</property>
+                        <property name="xalign">0</property>
+                        <property name="halign">start</property>
+                        <property name="valign">center</property>
+                        <property name="hexpand">1</property>
+                      </object>
+                    </child>
+                    <child>
+                      <object class="GtkSwitch" id="disable-on-battery">
+                        <property name="halign">end</property>
+                        <property name="valign">center</property>
+                      </object>
+                    </child>
+                    <child>
+                      <object class="GtkButton" id="reset-disable-on-battery">
+                        <property name="icon-name">edit-clear-symbolic</property>
+                        <property name="tooltip-text" translatable="yes">Reset to Default Value</property>
+                        <style>
+                          <class name="flat" />
+                        </style>
+                      </object>
+                    </child>
+                  </object>
+                </child>
+              </object>
+            </child>
+
           </object>
         </child>
       </object>

schemas/org.gnome.shell.extensions.burn-my-windows.gschema.xml

@@ -13,6 +13,12 @@
       <description>Set to true to burn dialogs as well.</description>
     </key>
 
+    <key name="disable-on-battery" type="b">
+      <default>false</default>
+      <summary>Disable on Battery</summary>
+      <description>Enable effects only if plugged in.</description>
+    </key>
+
     <key name="close-preview-effect" type="s">
       <default>""</default>
       <summary>Close Preview Effect</summary>

src/utils.js

@@ -13,7 +13,8 @@
 
 'use strict';
 
-const {Gtk} = imports.gi;
+const {Gtk, Gio} = imports.gi;
+const ByteArray  = imports.byteArray;
 
 // Returns the given argument, except for "alpha", "beta", and "rc". In these cases -3,
 // -2, and -1 are returned respectively.
@@ -83,4 +84,11 @@ function shellVersionIsAtLeast(major, minor) {
   }
 
   return false;
+}
+
+// Reads the contents of a file contained in the global resources archive. The data
+// is returned as a string.
+function getStringResource(path) {
+  const data = Gio.resources_lookup_data(path, 0);
+  return ByteArray.toString(ByteArray.fromGBytes(data));
 }