steam-backlog-enforcer/install.sh
Krzysztof kuhy Rudnicki 433a1d6c28
Some checks are pending
dependency freshness / dependencies on newest stable (push) Waiting to run
md-naming / markdown naming convention (push) Waiting to run
pre-commit / pre-commit (push) Waiting to run
Tests / test (push) Waiting to run
Stop the web UI serving numbers the enforcer is not applying
A server started as `python -c "from ..._web_server import serve; serve(
port=8000)"` ran for five hours after the code beneath it changed, reporting
an 8h gaming budget while the daemon enforced 6h and had already cut gaming
off. Two separate holes let that happen.

The staleness check only ran from cmd_serve, so a server started any other
way never met it. And is_our_server matched argv containing
"steam_backlog_enforcer.main", which a `python -c` process does not have --
so that server could not even be identified as ours: `run.sh serve` would
have refused the port and named it as a stranger rather than replacing it.

_serve_stale puts the check inside the server, where no launch path can skip
it. Every route, static included, returns 503 once any package .py is newer
than this process, because a fresh page fetching stale numbers is the same
lie with extra steps. The answer is memoised for five seconds so it does not
stat the package per request; that bounds the staleness window instead of
leaving it open forever.

Refusing is only half a fix -- a process that 503s forever is honest and
useless -- so a refused request also stands the server down. The new
steam-backlog-enforcer-web.service supplies the other half with
Restart=always: it dies on stale code and returns on current code with
nobody having to remember anything. A user unit, not a system one; it serves
read-only views and needs no privilege. install.sh installs and enables it
rather than printing instructions.

is_our_server now substring-matches the joined argv, so run.sh serve,
python -m ...main serve and a bare python -c are all recognised.

newest_py_since moves into _serve_stale and _serve_guard delegates to it.
Both needed the same scan, and two copies would have been free to disagree
about whether a server is current -- which is the entire failure being fixed.

Verified end to end: healthy 200, touch _budget_view.py, next request 503,
systemd replaces the process, back to 200 reporting 6.0h and blocked=True.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Fcwu78wk17FWMHbbfbyicc
2026-08-29 23:39:40 +02:00

124 lines
5.1 KiB
Bash
Executable File

#!/usr/bin/env bash
# Install script for Steam Backlog Enforcer.
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
echo "=== Steam Backlog Enforcer Installer ==="
echo
# Install Python deps.
echo "Installing Python dependencies..."
pip3 install --break-system-packages requests howlongtobeatpy 2>/dev/null \
|| pip3 install requests howlongtobeatpy
# 'block-gaming' depends on guard-lib (guardctl) for tamper-resistant
# locking. Not fatal if missing - the rest of this tool works without it.
echo
echo "Checking for guard-lib (required by 'block-gaming')..."
if command -v guardctl >/dev/null 2>&1; then
echo "guardctl found on PATH."
elif [[ -x "$HOME/utils/guard-lib/install.sh" ]]; then
echo "guardctl not found - installing guard-lib from $HOME/utils/guard-lib..."
if [[ $EUID -eq 0 ]]; then
bash "$HOME/utils/guard-lib/install.sh"
else
echo "guard-lib install needs root: sudo bash \"$HOME/utils/guard-lib/install.sh\""
echo "('block-gaming' will not work until that is done; the rest of this tool is unaffected.)"
fi
else
echo "Warning: guardctl not found and ~/utils/guard-lib is not present."
echo "'block-gaming' requires guard-lib - set up ~/utils/guard-lib and run its install.sh, then re-run this installer."
echo "(The rest of this tool is unaffected.)"
fi
# Install the web-UI user unit. No root needed: it serves read-only views and
# needs no privilege. Automated rather than documented, because the whole
# reason this unit exists is that a hand-started server outlived its own code.
install_web_user_unit() {
local target_user home_dir dst src
target_user="${SUDO_USER:-$USER}"
home_dir="$(getent passwd "$target_user" | cut -d: -f6)"
if [[ -z $home_dir ]]; then
echo "Warning: cannot resolve home for $target_user; skipping web unit."
return 0
fi
src="$SCRIPT_DIR/steam-backlog-enforcer-web.service"
dst="$home_dir/.config/systemd/user/steam-backlog-enforcer-web.service"
mkdir -p "$(dirname "$dst")"
sed "s|__REPO_DIR__|$SCRIPT_DIR|g" "$src" > "$dst"
if [[ $EUID -eq 0 ]]; then
chown "$target_user" "$dst"
sudo -u "$target_user" \
XDG_RUNTIME_DIR="/run/user/$(id -u "$target_user")" \
systemctl --user daemon-reload
sudo -u "$target_user" \
XDG_RUNTIME_DIR="/run/user/$(id -u "$target_user")" \
systemctl --user enable --now steam-backlog-enforcer-web || true
else
systemctl --user daemon-reload
systemctl --user enable --now steam-backlog-enforcer-web || true
fi
echo "Installed and enabled: $dst"
}
install_web_user_unit
# Install systemd service (system-level, runs as root).
#
# Non-interactive callers (install_core_system.sh, CI, `vm run`) have no stdin,
# where a bare `read` fails and -- under `set -e` -- aborts this whole installer
# with exit 1 after the Python deps are already in place. That made the module
# permanently un-installable from the documented install path. Default to "no"
# when there is no terminal, and let STEAM_ENFORCER_INSTALL_SERVICE=y opt in.
ans="${STEAM_ENFORCER_INSTALL_SERVICE:-}"
if [[ -z $ans ]]; then
if [[ -t 0 ]]; then
read -rp "Install systemd enforce service? [y/N] " ans
else
ans="n"
echo "No terminal: skipping the systemd enforce service."
echo "(Install it later with: sudo STEAM_ENFORCER_INSTALL_SERVICE=y bash install.sh)"
fi
fi
if [[ "${ans,,}" == "y" ]]; then
if [[ $EUID -ne 0 ]]; then
echo "Error: systemd service install needs root. Re-run with sudo."
exit 1
fi
SERVICE_SRC="$SCRIPT_DIR/steam-backlog-enforcer.service"
SERVICE_DST="/etc/systemd/system/steam-backlog-enforcer.service"
# Set the correct working directory, PYTHONPATH, and desktop user (the
# user whose Steam/X11 session the service should drive) in the service
# file. install.sh requires root, so it's invoked via `sudo` and
# SUDO_USER holds the real desktop user.
DESKTOP_USER="${SUDO_USER:-$USER}"
sed "s|WorkingDirectory=.*|WorkingDirectory=$SCRIPT_DIR|; \
s|PYTHONPATH=.*|PYTHONPATH=$SCRIPT_DIR|; \
s|__DESKTOP_USER__|$DESKTOP_USER|" \
"$SERVICE_SRC" > "$SERVICE_DST"
# Daily-gaming-budget pacman hook. While the budget is exhausted a refusal
# stub is bind-mounted over /usr/bin/steam and friends; a bind mount makes
# package extraction fail EBUSY, so the mounts must be dropped before any
# transaction touching those packages.
HOOK_SRC="$SCRIPT_DIR/pacman-hooks/50-steam-backlog-playtime-unblock.hook"
HOOK_DST="/etc/pacman.d/hooks/50-steam-backlog-playtime-unblock.hook"
mkdir -p /etc/pacman.d/hooks
install -m 644 "$HOOK_SRC" "$HOOK_DST"
echo "Installed pacman hook: $HOOK_DST"
systemctl daemon-reload
systemctl enable steam-backlog-enforcer
echo "Service installed and enabled."
echo " Start now: sudo systemctl start steam-backlog-enforcer"
echo " Check: sudo systemctl status steam-backlog-enforcer"
echo " Logs: sudo journalctl -u steam-backlog-enforcer -f"
fi
echo
echo "Done! Run manually with:"
echo " python3 -m steam_backlog_enforcer.main enforce"