Allow different period while ON/INHIBIT checking

bulletmark · bulletmark · commit 5ee88489e42e · 2022-08-15T20:01:29.000+10:00
diff --git a/README.md b/README.md
@@ -31,12 +31,12 @@ inhibit sleep or not until at least the next check period.
 The latest version of this document and code is available at
 https://github.com/bulletmark/sleep-inhibitor.
 
-:warning: **Warning**: Unfortunately this program is currently
+:warning: **Warning**: Unfortunately this program is currently slightly
 handicapped due to [this systemd
 issue](https://github.com/systemd/systemd/issues/14812). Until this
-issue is addressed, your system may not automatically [re-]suspend after
-it has been inhibited, even though _sleep-inhibitor_ has removed the
-inhibit.
+issue is addressed, your system may not automatically [re-]suspend if
+still idle after it has been inhibited, even though _sleep-inhibitor_
+has removed the inhibit.
 
 ### Motivation
 
diff --git a/sleep-inhibitor.conf b/sleep-inhibitor.conf
@@ -5,18 +5,27 @@
 # determined (e.g. at either /usr/share/sleep-inhibitor/plugins or
 # /usr/local/share/sleep-inhibitor/plugins) but you can define it
 # explicitly here if you want, e.g. for custom config file for testing.
+#
 # plugin_dir:
 #
-# Default global check period in minutes. Can be specified
-# for each plugin, or if not specified will the global default you
-# define here (or is 5 mins if not specified at all).
+# Default global check period in minutes. Can be specified for each
+# plugin, or if not specified will be the global default you define
+# here, or is 5 mins if not specified at all.
+#
 # period: 5
 #
+# Default global check period, while ON/INHIBITING, in minutes. Can be
+# specified for each plugin, or if not specified will be the global
+# default you define here, or is "period" above if not specified at all.
+#
+# period_on:
+#
 # Default global "what" value. Can be specified for each plugin, or if
 # not specified will the global default you define here. Takes a
 # colon-separated list of one or more operations to inhibit. See the
 # description of the --what option in the man page for systemd-inhibit.
 # Defaults to the default value of that systemd-inhibit option.
+#
 # what:
 #
 # Plugins are defined following. You can define as many plugins as you
@@ -29,11 +38,13 @@
 #         plugins, or relative to the program distribution plugins/
 #         directory for standard plugins.
 # args:   Optional. Provides arguments to the above script if required.
-# period: Optional. Specifies period in minutes. Defaults to global
-#         value, see above.
+# period: Optional. Specifies period to check in minutes. Defaults to
+#         global value, see above.
+# period_on: Optional. Specifies period to check (while ON/INHIBITING)
+#         in minutes. Defaults to above "period" value, then global value.
 # name:   Optional. Descriptive name for logging. Defaults to basename of
 #         path.
-# what:   Optional. Takes a colon-seperated list of one or more
+# what:   Optional. Takes a colon-separated list of one or more
 #         operations to inhibit. Defaults to global value, see above.
 
 # Comment/delete out or edit the following examples, or add your own.
diff --git a/sleep_inhibitor.py b/sleep_inhibitor.py
@@ -27,15 +27,15 @@ class Plugin:
     loglock = threading.Lock()
     threads = []
 
-    def __init__(self, index, prog, progname, def_period, def_what,
-            conf, plugin_dir, inhibitor_prog):
+    def __init__(self, index, prog, progname, def_period, def_period_on,
+            def_what, conf, plugin_dir, inhibitor_prog):
         'Constructor'
         pathstr = conf.get('path')
         if not pathstr:
             sys.exit(f'Plugin #{index}: path must be defined')
 
         path = Path(pathstr)
-        name = conf.get('name', path.name)
+        name = conf.get('name', path.stem)
         self.name = f'Plugin {name}'
 
         if not path.is_absolute():
@@ -49,7 +49,15 @@ def __init__(self, index, prog, progname, def_period, def_what,
         if not path.exists():
             sys.exit(f'{self.name}: "{path}" does not exist')
 
-        period = float(conf.get('period', def_period))
+        per = conf.get('period')
+        if per is None:
+            period = def_period
+            period_on_def = def_period_on
+        else:
+            period = float(per)
+            period_on_def = period
+
+        period_on = float(conf.get('period_on', period_on_def))
         self.period = period * 60
         self.is_inhibiting = None
 
@@ -68,9 +76,9 @@ def __init__(self, index, prog, progname, def_period, def_what,
         # run the plugin in a loop which keeps the inhibit on while the
         # inhibit state is returned.
         self.icmd = shlex.split(f'{inhibitor_prog}{what} --who="{progname}" '
-                f'--why="{self.name}" {prog} -s {self.period} -i "{cmd}"')
+                f'--why="{self.name}" {prog} -s {period_on * 60} -i "{cmd}"')
 
-        print(f'{self.name} [{path}] configured @ {period} minutes')
+        print(f'{self.name} [{path}] configured @ {period}/{period_on} minutes')
 
         # Each plugin periodic check runs in it's own thread
         thread = threading.Thread(target=self.run)
@@ -186,12 +194,13 @@ def init():
 
     # Get some global defaults
     period = float(conf.get('period', 5))
+    period_on = float(conf.get('period_on', period))
     what = conf.get('what')
 
     # Iterate to create each configured plugins
     for index, plugin in enumerate(plugins, 1):
-        Plugin(index, prog, progname, period, what, plugin, plugin_dir,
-                inhibitor_prog)
+        Plugin(index, prog, progname, period, period_on, what, plugin,
+                plugin_dir, inhibitor_prog)
 
 def main():
     'Main entry'
