Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
265966ffe9
|
||
|
|
a36e700df6
|
||
|
|
13c1afd7b6
|
||
|
|
0234456af8
|
||
|
|
51e18766a4
|
||
|
|
fa882bb0d7
|
||
|
|
af82b10d3c
|
||
|
|
1b0f2a2a66
|
@@ -1 +1,4 @@
|
|||||||
CLAUDE.md
|
CLAUDE.md
|
||||||
|
__pycache__/
|
||||||
|
.mypy_cache/
|
||||||
|
.ruff_cache/
|
||||||
|
|||||||
@@ -3,11 +3,11 @@
|
|||||||
# Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
|
# Maintainer: Daniele Fucini <dfucini [at] gmail [dot] com>
|
||||||
|
|
||||||
pkgname=xautolock-inhibit
|
pkgname=xautolock-inhibit
|
||||||
pkgver=0.1
|
pkgver=0.2
|
||||||
pkgrel=1
|
pkgrel=1
|
||||||
pkgdesc='Honor org.freedesktop.ScreenSaver inhibit requests by disabling xautolock'
|
pkgdesc='Honor org.freedesktop.ScreenSaver inhibit requests by disabling xautolock'
|
||||||
arch=('any')
|
arch=('any')
|
||||||
url="https://git.shouldnt.work/fuxino/${pkgname}"
|
url="https://git.shouldnt.work/fuxino/$pkgname"
|
||||||
license=('GPL-3.0-or-later')
|
license=('GPL-3.0-or-later')
|
||||||
depends=('libx11'
|
depends=('libx11'
|
||||||
'libxss'
|
'libxss'
|
||||||
@@ -15,13 +15,14 @@ depends=('libx11'
|
|||||||
'python-gobject'
|
'python-gobject'
|
||||||
'xautolock')
|
'xautolock')
|
||||||
makedepends=('git')
|
makedepends=('git')
|
||||||
source=(git+${url}?signed#tag=${pkgver})
|
source=("git+$url?signed#tag=$pkgver")
|
||||||
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
|
validpgpkeys=('7E12BC1FF3B6EDB2CD8053EB981A2B2A3BBF5514')
|
||||||
sha256sums=('SKIP')
|
sha256sums=('7de7d76f502583172f269311c54b4dfe56facf0ffd6aa21fd7883e296e67d798')
|
||||||
|
|
||||||
package()
|
package()
|
||||||
{
|
{
|
||||||
cd "${srcdir}/${pkgname}"
|
cd "$srcdir"/"$pkgname"
|
||||||
install -Dm755 "${pkgname}" "${pkgdir}/usr/bin/${pkgname}"
|
install -Dm755 "$pkgname" "$pkgdir"/usr/bin/"$pkgname"
|
||||||
install -Dm644 "${pkgname}.service" "${pkgdir}/usr/lib/systemd/user/${pkgname}.service"
|
install -Dm644 "$pkgname".service "$pkgdir"/usr/lib/systemd/user/"$pkgname".service
|
||||||
|
install -Dm644 README.md "$pkgdir"/usr/share/doc/"$pkgname"/README.md
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,95 @@
|
|||||||
|
# xautolock-inhibit
|
||||||
|
|
||||||
|
Makes screen locking with `xautolock` respect the "don't lock the screen" requests that apps send, on X11 sessions without a desktop environment (for example a plain window manager like xmonad).
|
||||||
|
|
||||||
|
Browsers, Steam, gamemode and other apps ask the desktop not to lock or blank the screen while a video or game is running, through the D-Bus service `org.freedesktop.ScreenSaver`. Without a desktop environment nothing provides that service, so the requests are dropped and the screen locks in the middle of a video. xautolock-inhibit provides it:
|
||||||
|
|
||||||
|
- While at least one request is active, it runs `xautolock -disable` and pauses X screen blanking and DPMS.
|
||||||
|
- When the last request is released, it waits a few seconds, then runs `xautolock -enable` and resumes blanking.
|
||||||
|
|
||||||
|
xautolock stays your locker; xautolock-inhibit only switches it off and on.
|
||||||
|
|
||||||
|
## How it works
|
||||||
|
|
||||||
|
- Owns `org.freedesktop.ScreenSaver` on the session bus at both `/org/freedesktop/ScreenSaver` and `/ScreenSaver` (apps differ on the path), and implements `Inhibit` and `UnInhibit`.
|
||||||
|
- Tracks requests per D-Bus client. If a client disconnects without releasing them (for example a browser crash), its requests are released.
|
||||||
|
- Runs `xautolock` only when the number of active requests goes from 0 to 1 or back to 0. Re-enabling waits a few seconds (`--release-delay`), because browsers send short bursts of requests when a video starts.
|
||||||
|
- Pauses X blanking with `XScreenSaverSuspend`, the same mechanism mpv uses, instead of changing `xset` settings. The X server ends the pause by itself if the daemon exits or crashes.
|
||||||
|
- Requests whose reason is on an ignore list (default: `Playing audio`) are accepted and logged, but don't block locking. Firefox-based browsers send one for audio playback, which would otherwise keep the screen unlocked while music plays with nobody at the computer.
|
||||||
|
- Keeps the requests it holds in `$XDG_RUNTIME_DIR/xautolock-inhibit.json`, so a restarted or crashed daemon takes them over. They are taken over only if the previous daemon stopped at most 30 seconds ago (`--restore-window`) on the same session bus, and only for clients still connected. A request released while no daemon was running can't be seen, so an old file isn't trusted.
|
||||||
|
- On exit (including SIGTERM), it re-enables xautolock. The systemd unit also runs `xautolock -enable` when it stops, as a fallback.
|
||||||
|
- If another program (a desktop environment) already owns `org.freedesktop.ScreenSaver`, it exits with status 2 instead of taking over.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
- `xautolock`, already running in the session
|
||||||
|
- `python`, `python-gobject`
|
||||||
|
- `libx11`, `libxss`
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Build and install the package with the included PKGBUILD:
|
||||||
|
|
||||||
|
```
|
||||||
|
makepkg -si
|
||||||
|
```
|
||||||
|
|
||||||
|
Then start it from your window manager's startup, after `xautolock`. For xmonad:
|
||||||
|
|
||||||
|
```haskell
|
||||||
|
spawnOnce "xautolock -time 10 -locker slock -detectsleep"
|
||||||
|
spawnOnce "systemctl --user start xautolock-inhibit"
|
||||||
|
```
|
||||||
|
|
||||||
|
The unit has no `[Install]` section on purpose. Enabling it at login would also start it in a desktop environment, or before X is up; starting it from the window manager limits it to that session. The user service manager needs `DISPLAY` (and `XAUTHORITY`) in its environment, which `/etc/X11/xinit/xinitrc.d/50-systemd-user.sh` sets up for `startx` sessions.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```
|
||||||
|
xautolock-inhibit [-i REASON] [--count-all] [-d SECONDS] [--restore-window SECONDS]
|
||||||
|
```
|
||||||
|
|
||||||
|
- `-i`, `--ignore-reason REASON`: request reason that doesn't block locking. Can be repeated; replaces the default (`Playing audio`).
|
||||||
|
- `--count-all`: every request blocks locking; no reasons are ignored.
|
||||||
|
- `-d`, `--release-delay SECONDS`: wait this long after the last release before re-enabling xautolock (default 5).
|
||||||
|
- `--restore-window SECONDS`: take over requests from a previous daemon that stopped at most this long ago (default 30; 0 disables).
|
||||||
|
|
||||||
|
To change the options used by the service:
|
||||||
|
|
||||||
|
```
|
||||||
|
systemctl --user edit xautolock-inhibit.service
|
||||||
|
```
|
||||||
|
|
||||||
|
```ini
|
||||||
|
[Service]
|
||||||
|
ExecStart=
|
||||||
|
ExecStart=/usr/bin/xautolock-inhibit --count-all
|
||||||
|
```
|
||||||
|
|
||||||
|
Every request, release and xautolock call is logged to the journal:
|
||||||
|
|
||||||
|
```
|
||||||
|
journalctl --user -u xautolock-inhibit
|
||||||
|
```
|
||||||
|
|
||||||
|
## App notes
|
||||||
|
|
||||||
|
- **Sandboxed apps** may be blocked from reaching the service. For a firejail profile that filters D-Bus (`dbus-user filter`, as the Firefox-based profiles do), allow it in the app's `.local` file, e.g. `zen-browser.local`:
|
||||||
|
|
||||||
|
```
|
||||||
|
dbus-user.talk org.freedesktop.ScreenSaver
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Games**: Steam's overlay and gamemode (`inhibit_screensaver=1`) send requests on their own.
|
||||||
|
- **scrcpy** only sends a request when started with `--disable-screensaver`.
|
||||||
|
- **mpv** talks to the X server directly and doesn't need this daemon.
|
||||||
|
|
||||||
|
## Limitations
|
||||||
|
|
||||||
|
- A release sent while the daemon is down is lost: if the daemon is back within `--restore-window`, that request stays active until its app exits. After a longer stop, all held requests are dropped and apps don't send them again.
|
||||||
|
- `SimulateUserActivity` is accepted but does nothing. Calls are logged once when a client starts sending them and once, with a count, after 5 minutes without any.
|
||||||
|
- `GetActive` always returns `false`.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
GPL-3.0-or-later. See [LICENSE](LICENSE).
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
[tool.ruff]
|
||||||
|
line-length = 120
|
||||||
|
extend-include = ["xautolock-inhibit"]
|
||||||
|
|
||||||
|
[tool.ruff.lint]
|
||||||
|
select = ["E", "F", "W", "I", "B", "UP"]
|
||||||
|
|
||||||
|
[tool.mypy]
|
||||||
|
files = ["xautolock-inhibit"]
|
||||||
|
strict = true
|
||||||
+220
-40
@@ -6,15 +6,20 @@ While an inhibit is active, X screen blanking is also paused (like mpv does).
|
|||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import ctypes
|
import ctypes
|
||||||
import itertools
|
import json
|
||||||
|
import os
|
||||||
import signal
|
import signal
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from datetime import timedelta
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
from gi.repository import Gio, GLib
|
from gi.repository import Gio, GLib
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from gi.repository import GLibUnix # GLib >= 2.80
|
from gi.repository import GLibUnix # type: ignore[attr-defined] # GLib >= 2.80, not in pygobject-stubs
|
||||||
signal_add = GLibUnix.signal_add
|
signal_add = GLibUnix.signal_add
|
||||||
except ImportError:
|
except ImportError:
|
||||||
signal_add = GLib.unix_signal_add
|
signal_add = GLib.unix_signal_add
|
||||||
@@ -22,6 +27,11 @@ except ImportError:
|
|||||||
BUS_NAME = "org.freedesktop.ScreenSaver"
|
BUS_NAME = "org.freedesktop.ScreenSaver"
|
||||||
OBJECT_PATHS = ("/org/freedesktop/ScreenSaver", "/ScreenSaver") # Vivaldi uses the first, Zen the second
|
OBJECT_PATHS = ("/org/freedesktop/ScreenSaver", "/ScreenSaver") # Vivaldi uses the first, Zen the second
|
||||||
EXIT_NAME_TAKEN = 2
|
EXIT_NAME_TAKEN = 2
|
||||||
|
ACTIVITY_QUIET = 300 # seconds without SimulateUserActivity that end a logged burst
|
||||||
|
STATE_FILE = "xautolock-inhibit.json" # in $XDG_RUNTIME_DIR
|
||||||
|
STATE_HEARTBEAT = 10 # seconds between state file touches while inhibits are held
|
||||||
|
|
||||||
|
Cookie = tuple[str, str, str, bool] # sender, application_name, reason, counts
|
||||||
|
|
||||||
INTROSPECTION = """
|
INTROSPECTION = """
|
||||||
<node>
|
<node>
|
||||||
@@ -54,11 +64,11 @@ INTROSPECTION = """
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
|
|
||||||
def log(msg):
|
def log(msg: str) -> None:
|
||||||
print(msg, flush=True)
|
print(msg, flush=True)
|
||||||
|
|
||||||
|
|
||||||
def xautolock(arg):
|
def xautolock(arg: str) -> None:
|
||||||
try:
|
try:
|
||||||
subprocess.run(["xautolock", arg], check=True, timeout=10)
|
subprocess.run(["xautolock", arg], check=True, timeout=10)
|
||||||
log(f"xautolock {arg}")
|
log(f"xautolock {arg}")
|
||||||
@@ -73,8 +83,8 @@ class XBlanking:
|
|||||||
pause by itself when this client releases it or its connection closes (exit, crash).
|
pause by itself when this client releases it or its connection closes (exit, crash).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self) -> None:
|
||||||
self.dpy = None
|
self.dpy: int | None = None
|
||||||
try:
|
try:
|
||||||
self.x11 = ctypes.CDLL("libX11.so.6")
|
self.x11 = ctypes.CDLL("libX11.so.6")
|
||||||
self.xss = ctypes.CDLL("libXss.so.1")
|
self.xss = ctypes.CDLL("libXss.so.1")
|
||||||
@@ -98,31 +108,47 @@ class XBlanking:
|
|||||||
return
|
return
|
||||||
self.dpy = dpy
|
self.dpy = dpy
|
||||||
|
|
||||||
def suspend(self, on):
|
def suspend(self, on: bool) -> None:
|
||||||
if self.dpy:
|
if self.dpy:
|
||||||
self.xss.XScreenSaverSuspend(self.dpy, int(on))
|
self.xss.XScreenSaverSuspend(self.dpy, int(on))
|
||||||
self.x11.XFlush(self.dpy)
|
self.x11.XFlush(self.dpy)
|
||||||
log(f"X blanking {'paused' if on else 'resumed'}")
|
log(f"X blanking {'paused' if on else 'resumed'}")
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class ActivityBurst:
|
||||||
|
first: float
|
||||||
|
last: float
|
||||||
|
calls: int = 0
|
||||||
|
timer: int = 0
|
||||||
|
|
||||||
|
|
||||||
class Inhibitor:
|
class Inhibitor:
|
||||||
def __init__(self, ignored_reasons, release_delay, blanking):
|
def __init__(
|
||||||
|
self, ignored_reasons: set[str], release_delay: int, blanking: XBlanking,
|
||||||
|
state_path: str | None, restore_window: int,
|
||||||
|
) -> None:
|
||||||
self.ignored_reasons = ignored_reasons
|
self.ignored_reasons = ignored_reasons
|
||||||
self.blanking = blanking
|
self.blanking = blanking
|
||||||
self.release_delay = release_delay
|
self.release_delay = release_delay
|
||||||
self.cookies = {} # cookie -> (sender, application_name, reason, counts)
|
self.state_path = state_path
|
||||||
self.next_cookie = itertools.count(1)
|
self.restore_window = restore_window
|
||||||
self.proc_names = {} # sender -> "comm[pid]", for logging only
|
self.state_ready = False # set once this instance owns the name and may write the state file
|
||||||
|
self.heartbeat_timer = 0
|
||||||
|
self.cookies: dict[int, Cookie] = {}
|
||||||
|
self.last_cookie = 0
|
||||||
|
self.proc_names: dict[str, str] = {} # sender -> "comm[pid]", for logging only
|
||||||
|
self.activity: dict[str, ActivityBurst] = {} # sender -> SimulateUserActivity burst
|
||||||
self.disabled = False
|
self.disabled = False
|
||||||
self.release_timer = 0
|
self.release_timer = 0
|
||||||
self.conn = None
|
self.conn: Gio.DBusConnection | None = None
|
||||||
|
|
||||||
# --- lock state -------------------------------------------------------
|
# --- lock state -------------------------------------------------------
|
||||||
|
|
||||||
def active_count(self):
|
def active_count(self) -> int:
|
||||||
return sum(1 for *_, counts in self.cookies.values() if counts)
|
return sum(1 for *_, counts in self.cookies.values() if counts)
|
||||||
|
|
||||||
def update(self):
|
def update(self) -> None:
|
||||||
"""Run xautolock only on 0->1 and 1->0 transitions; delay re-enabling."""
|
"""Run xautolock only on 0->1 and 1->0 transitions; delay re-enabling."""
|
||||||
active = self.active_count()
|
active = self.active_count()
|
||||||
if active and self.release_timer:
|
if active and self.release_timer:
|
||||||
@@ -134,55 +160,161 @@ class Inhibitor:
|
|||||||
# Browsers send quick Inhibit/UnInhibit bursts when a video starts.
|
# Browsers send quick Inhibit/UnInhibit bursts when a video starts.
|
||||||
self.release_timer = GLib.timeout_add_seconds(self.release_delay, self.on_release_timeout)
|
self.release_timer = GLib.timeout_add_seconds(self.release_delay, self.on_release_timeout)
|
||||||
|
|
||||||
def on_release_timeout(self):
|
def on_release_timeout(self) -> bool:
|
||||||
self.release_timer = 0
|
self.release_timer = 0
|
||||||
if not self.active_count() and self.disabled:
|
if not self.active_count() and self.disabled:
|
||||||
self.unblock()
|
self.unblock()
|
||||||
return GLib.SOURCE_REMOVE
|
return GLib.SOURCE_REMOVE
|
||||||
|
|
||||||
def block(self):
|
def block(self) -> None:
|
||||||
xautolock("-disable")
|
xautolock("-disable")
|
||||||
self.blanking.suspend(True)
|
self.blanking.suspend(True)
|
||||||
self.disabled = True
|
self.disabled = True
|
||||||
|
|
||||||
def unblock(self):
|
def unblock(self) -> None:
|
||||||
xautolock("-enable")
|
xautolock("-enable")
|
||||||
self.blanking.suspend(False)
|
self.blanking.suspend(False)
|
||||||
self.disabled = False
|
self.disabled = False
|
||||||
|
|
||||||
def shutdown(self):
|
def shutdown(self) -> None:
|
||||||
|
for sender in list(self.activity):
|
||||||
|
self.end_activity(sender)
|
||||||
if self.release_timer:
|
if self.release_timer:
|
||||||
GLib.source_remove(self.release_timer)
|
GLib.source_remove(self.release_timer)
|
||||||
self.release_timer = 0
|
self.release_timer = 0
|
||||||
|
self.save(stopped=True)
|
||||||
if self.disabled:
|
if self.disabled:
|
||||||
self.unblock()
|
self.unblock()
|
||||||
|
|
||||||
|
# --- state file -------------------------------------------------------
|
||||||
|
|
||||||
|
def start(self) -> None:
|
||||||
|
"""Take over inhibits saved by a previous instance, then set xautolock to match."""
|
||||||
|
self.restore()
|
||||||
|
self.state_ready = True
|
||||||
|
self.save()
|
||||||
|
if self.active_count():
|
||||||
|
self.block()
|
||||||
|
else:
|
||||||
|
# Start from a known state, in case a previous instance died while disabled.
|
||||||
|
xautolock("-enable")
|
||||||
|
|
||||||
|
def restore(self) -> None:
|
||||||
|
if not self.state_path:
|
||||||
|
log("XDG_RUNTIME_DIR is not set; inhibits will not survive a restart")
|
||||||
|
return
|
||||||
|
assert self.conn is not None
|
||||||
|
try:
|
||||||
|
with open(self.state_path) as f:
|
||||||
|
state = json.load(f)
|
||||||
|
age = time.time() - (state["stopped_at"] or os.stat(self.state_path).st_mtime)
|
||||||
|
bus_id = state["bus_id"]
|
||||||
|
last_cookie = int(state["last_cookie"])
|
||||||
|
saved = [(int(c), s, a, r) for c, s, a, r in state["cookies"]]
|
||||||
|
except FileNotFoundError:
|
||||||
|
return
|
||||||
|
except (OSError, ValueError, KeyError, TypeError) as e:
|
||||||
|
log(f"Ignoring unreadable state file {self.state_path}: {e}")
|
||||||
|
return
|
||||||
|
if bus_id != self.conn.get_guid():
|
||||||
|
# Unique names like :1.42 are reused by a new bus, so they would mean other clients.
|
||||||
|
if saved:
|
||||||
|
log(f"Not restoring {len(saved)} inhibit(s): saved on another session bus")
|
||||||
|
return
|
||||||
|
# Keep numbering after old cookies, so a late UnInhibit can't hit a new one.
|
||||||
|
self.last_cookie = last_cookie
|
||||||
|
if not saved:
|
||||||
|
return
|
||||||
|
if age > self.restore_window:
|
||||||
|
# An UnInhibit sent while no instance ran is lost; don't trust an old file.
|
||||||
|
log(f"Not restoring {len(saved)} inhibit(s): saved {age:.0f}s ago, "
|
||||||
|
f"over the {self.restore_window}s window")
|
||||||
|
return
|
||||||
|
for cookie, sender, app, reason in saved:
|
||||||
|
if not self.has_owner(sender):
|
||||||
|
log(f"Not restoring {cookie}: '{app}' '{reason}' ({sender} left the bus)")
|
||||||
|
continue
|
||||||
|
counts = reason not in self.ignored_reasons
|
||||||
|
self.cookies[cookie] = (sender, app, reason, counts)
|
||||||
|
note = "" if counts else " (reason ignored, does not block locking)"
|
||||||
|
log(f"Restored {cookie}: '{app}' '{reason}' from {self.proc_name(sender)}{note}")
|
||||||
|
|
||||||
|
def save(self, stopped: bool = False) -> None:
|
||||||
|
"""Write the held inhibits atomically; while any are held, touch the file regularly.
|
||||||
|
|
||||||
|
The touches keep the mtime recent, so after a crash the next instance can tell how
|
||||||
|
long ago it happened. A clean stop records the time in `stopped_at` instead.
|
||||||
|
"""
|
||||||
|
if not self.state_ready or not self.state_path:
|
||||||
|
return
|
||||||
|
assert self.conn is not None
|
||||||
|
state = {
|
||||||
|
"bus_id": self.conn.get_guid(),
|
||||||
|
"last_cookie": self.last_cookie,
|
||||||
|
"stopped_at": time.time() if stopped else None,
|
||||||
|
"cookies": [[c, s, a, r] for c, (s, a, r, _) in self.cookies.items()],
|
||||||
|
}
|
||||||
|
tmp = f"{self.state_path}.tmp"
|
||||||
|
try:
|
||||||
|
with open(tmp, "w") as f:
|
||||||
|
json.dump(state, f)
|
||||||
|
os.replace(tmp, self.state_path)
|
||||||
|
except OSError as e:
|
||||||
|
log(f"Cannot write state file {self.state_path}: {e}")
|
||||||
|
if self.cookies and not stopped:
|
||||||
|
if not self.heartbeat_timer:
|
||||||
|
self.heartbeat_timer = GLib.timeout_add_seconds(STATE_HEARTBEAT, self.on_heartbeat)
|
||||||
|
elif self.heartbeat_timer:
|
||||||
|
GLib.source_remove(self.heartbeat_timer)
|
||||||
|
self.heartbeat_timer = 0
|
||||||
|
|
||||||
|
def on_heartbeat(self) -> bool:
|
||||||
|
assert self.state_path is not None
|
||||||
|
try:
|
||||||
|
os.utime(self.state_path)
|
||||||
|
except OSError as e:
|
||||||
|
log(f"Cannot touch state file {self.state_path}: {e}")
|
||||||
|
return GLib.SOURCE_CONTINUE
|
||||||
|
|
||||||
# --- D-Bus ------------------------------------------------------------
|
# --- D-Bus ------------------------------------------------------------
|
||||||
|
|
||||||
def proc_name(self, sender):
|
def bus_call(self, method: str, name: str, reply_type: str) -> Any:
|
||||||
|
"""Call an org.freedesktop.DBus method that takes a bus name; return its single result."""
|
||||||
|
assert self.conn is not None # set in on_bus_acquired, before any method call
|
||||||
|
return self.conn.call_sync(
|
||||||
|
"org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus",
|
||||||
|
method, GLib.Variant("(s)", (name,)),
|
||||||
|
GLib.VariantType(reply_type), Gio.DBusCallFlags.NONE, 1000, None,
|
||||||
|
).unpack()[0]
|
||||||
|
|
||||||
|
def has_owner(self, name: str) -> bool:
|
||||||
|
try:
|
||||||
|
return bool(self.bus_call("NameHasOwner", name, "(b)"))
|
||||||
|
except GLib.Error:
|
||||||
|
return False
|
||||||
|
|
||||||
|
def proc_name(self, sender: str) -> str:
|
||||||
if sender not in self.proc_names:
|
if sender not in self.proc_names:
|
||||||
try:
|
try:
|
||||||
pid = self.conn.call_sync(
|
pid = self.bus_call("GetConnectionUnixProcessID", sender, "(u)")
|
||||||
"org.freedesktop.DBus", "/org/freedesktop/DBus", "org.freedesktop.DBus",
|
|
||||||
"GetConnectionUnixProcessID", GLib.Variant("(s)", (sender,)),
|
|
||||||
GLib.VariantType("(u)"), Gio.DBusCallFlags.NONE, 1000, None,
|
|
||||||
).unpack()[0]
|
|
||||||
with open(f"/proc/{pid}/comm") as f:
|
with open(f"/proc/{pid}/comm") as f:
|
||||||
self.proc_names[sender] = f"{f.read().strip()}[{pid}]"
|
self.proc_names[sender] = f"{f.read().strip()}[{pid}]"
|
||||||
except (GLib.Error, OSError):
|
except (GLib.Error, OSError):
|
||||||
self.proc_names[sender] = "?"
|
self.proc_names[sender] = "?"
|
||||||
return f"{sender} {self.proc_names[sender]}"
|
return f"{sender} {self.proc_names[sender]}"
|
||||||
|
|
||||||
def inhibit(self, sender, app, reason):
|
def inhibit(self, sender: str, app: str, reason: str) -> int:
|
||||||
cookie = next(self.next_cookie)
|
self.last_cookie += 1
|
||||||
|
cookie = self.last_cookie
|
||||||
counts = reason not in self.ignored_reasons
|
counts = reason not in self.ignored_reasons
|
||||||
self.cookies[cookie] = (sender, app, reason, counts)
|
self.cookies[cookie] = (sender, app, reason, counts)
|
||||||
note = "" if counts else " (reason ignored, does not block locking)"
|
note = "" if counts else " (reason ignored, does not block locking)"
|
||||||
log(f"Inhibit {cookie}: '{app}' '{reason}' from {self.proc_name(sender)}{note}")
|
log(f"Inhibit {cookie}: '{app}' '{reason}' from {self.proc_name(sender)}{note}")
|
||||||
|
self.save()
|
||||||
self.update()
|
self.update()
|
||||||
return cookie
|
return cookie
|
||||||
|
|
||||||
def uninhibit(self, sender, cookie):
|
def uninhibit(self, sender: str, cookie: int) -> None:
|
||||||
entry = self.cookies.get(cookie)
|
entry = self.cookies.get(cookie)
|
||||||
if entry is None or entry[0] != sender:
|
if entry is None or entry[0] != sender:
|
||||||
log(f"UnInhibit {cookie} from {self.proc_name(sender)}: unknown cookie, ignored")
|
log(f"UnInhibit {cookie} from {self.proc_name(sender)}: unknown cookie, ignored")
|
||||||
@@ -190,18 +322,53 @@ class Inhibitor:
|
|||||||
del self.cookies[cookie]
|
del self.cookies[cookie]
|
||||||
_, app, reason, _ = entry
|
_, app, reason, _ = entry
|
||||||
log(f"UnInhibit {cookie}: '{app}' '{reason}'")
|
log(f"UnInhibit {cookie}: '{app}' '{reason}'")
|
||||||
|
self.save()
|
||||||
self.update()
|
self.update()
|
||||||
|
|
||||||
def release_sender(self, sender):
|
def simulate_activity(self, sender: str) -> None:
|
||||||
|
"""Log a sender's calls once per burst: Steam sends thousands per hour."""
|
||||||
|
now = time.monotonic()
|
||||||
|
burst = self.activity.get(sender)
|
||||||
|
if burst is None:
|
||||||
|
log(f"SimulateUserActivity from {self.proc_name(sender)} (not implemented)")
|
||||||
|
burst = self.activity[sender] = ActivityBurst(first=now, last=now)
|
||||||
|
else:
|
||||||
|
GLib.source_remove(burst.timer)
|
||||||
|
burst.calls += 1
|
||||||
|
burst.last = now
|
||||||
|
burst.timer = GLib.timeout_add_seconds(ACTIVITY_QUIET, self.on_activity_quiet, sender)
|
||||||
|
|
||||||
|
def on_activity_quiet(self, sender: str) -> bool:
|
||||||
|
self.activity[sender].timer = 0
|
||||||
|
self.end_activity(sender)
|
||||||
|
return GLib.SOURCE_REMOVE
|
||||||
|
|
||||||
|
def end_activity(self, sender: str) -> None:
|
||||||
|
burst = self.activity.pop(sender, None)
|
||||||
|
if burst is None:
|
||||||
|
return
|
||||||
|
if burst.timer:
|
||||||
|
GLib.source_remove(burst.timer)
|
||||||
|
if burst.calls == 1:
|
||||||
|
return
|
||||||
|
span = timedelta(seconds=round(burst.last - burst.first))
|
||||||
|
log(f"SimulateUserActivity from {self.proc_name(sender)}: {burst.calls} calls over {span}")
|
||||||
|
|
||||||
|
def release_sender(self, sender: str) -> None:
|
||||||
gone = [c for c, (s, *_) in self.cookies.items() if s == sender]
|
gone = [c for c, (s, *_) in self.cookies.items() if s == sender]
|
||||||
for c in gone:
|
for c in gone:
|
||||||
_, app, reason, _ = self.cookies.pop(c)
|
_, app, reason, _ = self.cookies.pop(c)
|
||||||
log(f"Released {c}: '{app}' '{reason}' ({sender} left the bus)")
|
log(f"Released {c}: '{app}' '{reason}' ({sender} left the bus)")
|
||||||
|
self.end_activity(sender)
|
||||||
self.proc_names.pop(sender, None)
|
self.proc_names.pop(sender, None)
|
||||||
if gone:
|
if gone:
|
||||||
|
self.save()
|
||||||
self.update()
|
self.update()
|
||||||
|
|
||||||
def on_method_call(self, conn, sender, path, iface, method, params, invocation):
|
def on_method_call(
|
||||||
|
self, conn: Gio.DBusConnection, sender: str, path: str, iface: str, method: str,
|
||||||
|
params: GLib.Variant, invocation: Gio.DBusMethodInvocation,
|
||||||
|
) -> None:
|
||||||
if method == "Inhibit":
|
if method == "Inhibit":
|
||||||
app, reason = params.unpack()
|
app, reason = params.unpack()
|
||||||
invocation.return_value(GLib.Variant("(u)", (self.inhibit(sender, app, reason),)))
|
invocation.return_value(GLib.Variant("(u)", (self.inhibit(sender, app, reason),)))
|
||||||
@@ -209,7 +376,7 @@ class Inhibitor:
|
|||||||
self.uninhibit(sender, params.unpack()[0])
|
self.uninhibit(sender, params.unpack()[0])
|
||||||
invocation.return_value(None)
|
invocation.return_value(None)
|
||||||
elif method == "SimulateUserActivity":
|
elif method == "SimulateUserActivity":
|
||||||
log(f"SimulateUserActivity from {self.proc_name(sender)} (not implemented)")
|
self.simulate_activity(sender)
|
||||||
invocation.return_value(None)
|
invocation.return_value(None)
|
||||||
elif method == "Lock":
|
elif method == "Lock":
|
||||||
log(f"Lock from {self.proc_name(sender)}")
|
log(f"Lock from {self.proc_name(sender)}")
|
||||||
@@ -220,12 +387,15 @@ class Inhibitor:
|
|||||||
elif method in ("GetActiveTime", "GetSessionIdleTime"):
|
elif method in ("GetActiveTime", "GetSessionIdleTime"):
|
||||||
invocation.return_value(GLib.Variant("(u)", (0,)))
|
invocation.return_value(GLib.Variant("(u)", (0,)))
|
||||||
|
|
||||||
def on_name_owner_changed(self, conn, sender, path, iface, signal_name, params):
|
def on_name_owner_changed(
|
||||||
|
self, conn: Gio.DBusConnection, sender: str, path: str, iface: str, signal_name: str,
|
||||||
|
params: GLib.Variant,
|
||||||
|
) -> None:
|
||||||
name, _old, new = params.unpack()
|
name, _old, new = params.unpack()
|
||||||
if not new and name.startswith(":"):
|
if not new and name.startswith(":"):
|
||||||
self.release_sender(name)
|
self.release_sender(name)
|
||||||
|
|
||||||
def on_bus_acquired(self, conn, name):
|
def on_bus_acquired(self, conn: Gio.DBusConnection, name: str) -> None:
|
||||||
self.conn = conn
|
self.conn = conn
|
||||||
iface = Gio.DBusNodeInfo.new_for_xml(INTROSPECTION).interfaces[0]
|
iface = Gio.DBusNodeInfo.new_for_xml(INTROSPECTION).interfaces[0]
|
||||||
for path in OBJECT_PATHS:
|
for path in OBJECT_PATHS:
|
||||||
@@ -236,7 +406,7 @@ class Inhibitor:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main() -> None:
|
||||||
parser = argparse.ArgumentParser(description=__doc__)
|
parser = argparse.ArgumentParser(description=__doc__)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"-i", "--ignore-reason", action="append", metavar="REASON",
|
"-i", "--ignore-reason", action="append", metavar="REASON",
|
||||||
@@ -250,26 +420,36 @@ def main():
|
|||||||
"-d", "--release-delay", type=int, default=5, metavar="SECONDS",
|
"-d", "--release-delay", type=int, default=5, metavar="SECONDS",
|
||||||
help="wait this long after the last release before re-enabling xautolock (default: 5)",
|
help="wait this long after the last release before re-enabling xautolock (default: 5)",
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--restore-window", type=int, default=30, metavar="SECONDS",
|
||||||
|
help="take over inhibits from a previous instance that stopped at most this long ago "
|
||||||
|
"(default: 30; 0 disables)",
|
||||||
|
)
|
||||||
args = parser.parse_args()
|
args = parser.parse_args()
|
||||||
|
|
||||||
|
ignored: set[str]
|
||||||
if args.count_all:
|
if args.count_all:
|
||||||
ignored = set()
|
ignored = set()
|
||||||
else:
|
else:
|
||||||
ignored = set(args.ignore_reason or ["Playing audio"])
|
ignored = set(args.ignore_reason or ["Playing audio"])
|
||||||
inhibitor = Inhibitor(ignored, max(args.release_delay, 0), XBlanking())
|
runtime_dir = os.environ.get("XDG_RUNTIME_DIR")
|
||||||
|
state_path = os.path.join(runtime_dir, STATE_FILE) if runtime_dir else None
|
||||||
|
inhibitor = Inhibitor(
|
||||||
|
ignored, max(args.release_delay, 0), XBlanking(), state_path, max(args.restore_window, 0),
|
||||||
|
)
|
||||||
loop = GLib.MainLoop()
|
loop = GLib.MainLoop()
|
||||||
exit_code = 0
|
exit_code = 0
|
||||||
acquired = False
|
acquired = False
|
||||||
|
|
||||||
def on_name_acquired(conn, name):
|
def on_name_acquired(conn: Gio.DBusConnection, name: str) -> None:
|
||||||
nonlocal acquired
|
nonlocal acquired
|
||||||
acquired = True
|
acquired = True
|
||||||
log(f"Owning {name}; ignored reasons: {sorted(ignored) or 'none'}")
|
log(f"Owning {name}; ignored reasons: {sorted(ignored) or 'none'}")
|
||||||
# Start from a known state, in case a previous instance died while disabled.
|
# Only after owning the name, so a second instance can't undo an active inhibit
|
||||||
# Only after owning the name, so a second instance can't undo an active inhibit.
|
# or overwrite the state file.
|
||||||
xautolock("-enable")
|
inhibitor.start()
|
||||||
|
|
||||||
def on_name_lost(conn, name):
|
def on_name_lost(conn: Gio.DBusConnection | None, name: str) -> None:
|
||||||
nonlocal exit_code
|
nonlocal exit_code
|
||||||
if conn is None:
|
if conn is None:
|
||||||
log("Could not connect to the session bus")
|
log("Could not connect to the session bus")
|
||||||
@@ -282,7 +462,7 @@ def main():
|
|||||||
exit_code = EXIT_NAME_TAKEN
|
exit_code = EXIT_NAME_TAKEN
|
||||||
loop.quit()
|
loop.quit()
|
||||||
|
|
||||||
def on_signal():
|
def on_signal() -> bool:
|
||||||
log("Signal received, exiting")
|
log("Signal received, exiting")
|
||||||
loop.quit()
|
loop.quit()
|
||||||
return GLib.SOURCE_REMOVE
|
return GLib.SOURCE_REMOVE
|
||||||
|
|||||||
Reference in New Issue
Block a user