Compare commits
64 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2fe03269e4 | |||
| ac2a3981fc | |||
| 2684e5c8ab | |||
| 4386838b69 | |||
| bfbad9cbc6 | |||
| 2e545ff718 | |||
| 5e5dc2d54a | |||
| 7804893054 | |||
| bf3ac4af1a | |||
| e4a37176e1 | |||
| 67665974dc | |||
| 51b7ed69bd | |||
| 6fca2c9aba | |||
| 4c5a6547ec | |||
| 587568e574 | |||
| cc84bbda88 | |||
| 75a4da7af3 | |||
| f95387c5b8 | |||
| 1dc86121f6 | |||
| cd54e5f2c5 | |||
| 1b24d1b032 | |||
| 7ac14416b5 | |||
| b22a2f5593 | |||
| f45d8c9b34 | |||
| 8d6ce47e87 | |||
| 03b2dd8363 | |||
| ab89dda0b4 | |||
| 305c88ba09 | |||
| 82f3ea49de | |||
| 8d695227bc | |||
| 82bef0a08c | |||
| 73f347449e | |||
| 5cd51beadf | |||
| 934b489fec | |||
| 7a283dc338 | |||
| 5682878f22 | |||
| 5a584c08d5 | |||
| 8b1083a29b | |||
| 25b7a58e3c | |||
| 1ec8675fa0 | |||
| 9c30c9824e | |||
| 596b3ec8c4 | |||
| 392ea76347 | |||
| 29f4a45df8 | |||
| d7f07dd7c0 | |||
| 0642eb4712 | |||
| f25ac939cc | |||
| b47006bc22 | |||
| 00394c287c | |||
| 2f6cab72c4 | |||
| 67d4c1cb99 | |||
| e33cc0ef3a | |||
| e3b20089f0 | |||
| 54c0971ac3 | |||
| 9ae2e22b44 | |||
| 89ebb6c61e | |||
| c8f7d66349 | |||
| 6215181d23 | |||
| 09cbc57b8c | |||
| f3021c4ddb | |||
| ca4bc4c64f | |||
| 46ba53631a | |||
| 4e3f6aa94e | |||
| 2e6a981120 |
@@ -27,12 +27,39 @@ jobs:
|
||||
python -m pip install --upgrade build
|
||||
python -m build
|
||||
|
||||
- name: Build self-extracting installer (.run)
|
||||
run: python packaging/make_run.py
|
||||
|
||||
- name: Read version
|
||||
id: ver
|
||||
run: |
|
||||
V=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
|
||||
echo "version=$V" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Build release notes
|
||||
run: |
|
||||
python - <<'PY'
|
||||
import json
|
||||
version = "${{ steps.ver.outputs.version }}"
|
||||
tag = f"v{version}"
|
||||
out, capturing = [], False
|
||||
try:
|
||||
for line in open("CHANGELOG.md", encoding="utf-8").read().splitlines():
|
||||
if line.startswith("## "):
|
||||
if capturing:
|
||||
break
|
||||
capturing = line.startswith(f"## [{version}]")
|
||||
continue
|
||||
if capturing:
|
||||
out.append(line)
|
||||
except OSError:
|
||||
pass
|
||||
body = "\n".join(out).strip() or f"Release {tag}."
|
||||
payload = {"tag_name": tag, "target_commitish": "${{ github.sha }}", "name": tag, "body": body}
|
||||
open("/tmp/release.json", "w", encoding="utf-8").write(json.dumps(payload))
|
||||
print(f"release notes: {len(body)} chars")
|
||||
PY
|
||||
|
||||
- name: Publish Gitea release
|
||||
env:
|
||||
TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -52,7 +79,7 @@ jobs:
|
||||
rid=$(curl -sS -X POST \
|
||||
-H "Authorization: token ${TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\":\"${TAG}\",\"target_commitish\":\"${{ github.sha }}\",\"name\":\"${TAG}\",\"body\":\"Automated release for ${TAG}. See CHANGELOG.md.\"}" \
|
||||
-d @/tmp/release.json \
|
||||
"${API}/releases" | python -c "import sys, json; print(json.load(sys.stdin)['id'])")
|
||||
|
||||
for f in dist/*; do
|
||||
|
||||
+424
@@ -5,6 +5,430 @@ All notable changes to RigDoctor are recorded here. Format follows
|
||||
(`MAJOR.MINOR.PATCH`, pre-1.0). `__version__` and `pyproject.toml` must match the git
|
||||
release tag (so the auto-updater, D18, can compare versions).
|
||||
|
||||
## [0.26.1] - 2026-05-22
|
||||
### Fixed
|
||||
- **Setup wizard contrast.** The **radio buttons** (Recording trigger) were unstyled, so the
|
||||
selected option was invisible on the dark theme — now styled with a clear accent ring + dot.
|
||||
Bundle **checkboxes** got explicit checked/disabled states, and stay selectable even when a
|
||||
bundle is already installed (the page no longer looks dead when everything's present).
|
||||
|
||||
## [0.26.0] - 2026-05-22
|
||||
### Added
|
||||
- **Graphical setup wizard (M9).** A first-run GUI wizard (`gui/setup_wizard.py`) walks through:
|
||||
environment summary → pick **dependency bundles** (Diagnostics / Monitoring / Gaming / Updates,
|
||||
from the component catalog) → install the missing apt packages → choose the **recording
|
||||
trigger** → a readiness summary. It shows automatically on first launch (until done), is
|
||||
re-runnable from **Settings → Run setup wizard** or `rigdoctor-gui --setup`, and `install.sh`
|
||||
launches it after a fresh install when a desktop session is present.
|
||||
|
||||
## [0.25.0] - 2026-05-22
|
||||
### Changed
|
||||
- **Share is now terminal-only (D23, amends D16).** The Share page is a single shared-terminal
|
||||
experience: the host shares their shell, the guest watches and may type **only if the host
|
||||
ticks "Allow the guest to type"** (otherwise read-only). The terminal is larger and either
|
||||
side can pop it **full-screen** (Esc to exit).
|
||||
### Removed
|
||||
- The read-only **stats view** (live sensors/health/inventory over the relay) and the
|
||||
`rigdoctor share serve` HTTP server — the shared terminal replaces them. (`core/share.py`
|
||||
removed; the `share` CLI command is gone.)
|
||||
|
||||
## [0.24.0] - 2026-05-22
|
||||
### Added
|
||||
- **Shared terminal is now in color.** The terminal view renders pyte's per-cell foreground/
|
||||
background, bold, and reverse, so the host's real shell keeps its theming — fish, `ls`,
|
||||
`git`, prompts, etc. look the same as locally (the session already runs the host's `$SHELL`
|
||||
with its config and `TERM=xterm-256color`; only the rendering was monochrome).
|
||||
|
||||
## [0.23.0] - 2026-05-22
|
||||
### Added
|
||||
- **Crash-logger trigger modes (M9 / D6)** via `systemd --user`, no root: **manual**,
|
||||
**always-on** (a background service records continuously), and **game-launch** (auto-records
|
||||
while a Steam game runs). Set it from **Settings → Recording trigger** or
|
||||
`rigdoctor service mode <manual|always-on|game-launch>`; `rigdoctor service status` shows it.
|
||||
`core/service.py` writes/enables the user units.
|
||||
- **Zero-config game-launch watcher** (`core/watcher.py`, `rigdoctor watch`) — polls Steam's
|
||||
RunningAppID and brackets a focused capture around the running game (the D12 fallback for users
|
||||
who don't add the `wrap` launch option; the wrapper stays the precise primary path).
|
||||
|
||||
## [0.22.0] - 2026-05-22
|
||||
### Added
|
||||
- **M6 breadth.** Environment checks now also report **GPU PowerMizer** mode (NVIDIA, X — flags
|
||||
Adaptive/Auto and suggests Prefer-Max-Performance), the **Wine** version, and the **Steam
|
||||
client** version.
|
||||
- **Non-Steam launchers.** Lutris (its SQLite library) and Heroic (Epic + GOG JSON stores) are
|
||||
detected (`core/launchers.py`) and listed on the Games page and `rigdoctor games`, tagged by
|
||||
launcher. You can Run Diagnostic on them too (records while you play; auto-launch stays
|
||||
Steam-only).
|
||||
### Notes
|
||||
- The zero-config game watcher (D12 fallback) is deferred to the M9 trigger-mode work, where the
|
||||
service integration lives.
|
||||
|
||||
## [0.21.0] - 2026-05-22
|
||||
### Added
|
||||
- **Live monitor TUI (M2).** `rigdoctor monitor` is now a proper **curses** dashboard:
|
||||
current / session-min / session-max per sensor, grouped by subsystem, with temperature and
|
||||
utilization **color bands** (and GPU-lost flagged red). `q` quits, `r` resets the session
|
||||
min/max. Falls back to a plain full-screen redraw on a non-TTY (`--plain` forces it). The
|
||||
terminal face of the same live data the GUI dashboard graphs. Completes the Monitoring bundle.
|
||||
|
||||
## [0.20.0] - 2026-05-22
|
||||
### Changed
|
||||
- **Reorganized navigation** into grouped sidebar sections — **Monitor** (Dashboard) ·
|
||||
**Diagnose** (Games, Recordings, System Health, Tuning) · **System** (Inventory) · **App**
|
||||
(Settings, Share) — so it's clear where to go.
|
||||
- **Renames for clarity:** *Health → System Health* (it's the overall 7-day system scan, not
|
||||
per-game), *Environment → Tuning* (gaming tunables + fixes), *Logs → Recordings*,
|
||||
*Setup → Settings*.
|
||||
- **Settings** absorbed **Notifications** (alerts) — app configuration (components/deps, alerts,
|
||||
account access, uninstall) now lives in one page; Notifications is no longer a separate item.
|
||||
- **Recordings** is now a hub: pick which captured log to view (always-on capture, last
|
||||
diagnostic, or a preserved crash), **Analyze crash** in place, alongside the recorder controls.
|
||||
|
||||
## [0.19.0] - 2026-05-22
|
||||
### Added
|
||||
- **System-tray applet (M11, D13).** A tray icon whose menu shows live **CPU / GPU temp** and
|
||||
**memory used/total**, a **status line** (Normal / Hot / GPU not responding), and is led by a
|
||||
**Run Diagnostic** submenu (pick a detected game → the guided session), plus **Open dashboard**,
|
||||
**Start/Stop recording**, **Snapshot (copy)**, and **Quit**. It reuses the dashboard's sample
|
||||
stream (no extra sampling). With a tray present, **closing the window hides to the tray** (Quit
|
||||
exits); `rigdoctor-gui --tray` starts hidden for autostart. Needs a tray host — on GNOME the
|
||||
AppIndicator extension; degrades to a no-op if none is available. Completes the Desktop UI bundle.
|
||||
- **GUI smoke tests**: construct `MainWindow` headless and exercise the tray, so a startup crash
|
||||
fails the build (closes the gap that let the 0.18.0 import regression ship).
|
||||
|
||||
## [0.18.2] - 2026-05-22
|
||||
### Fixed
|
||||
- **GUI wouldn't start** (0.18.0 regression): the recording indicator used a wrong relative
|
||||
import (`from .core` → `rigdoctor.gui.core`, which doesn't exist), crashing `MainWindow` on
|
||||
launch. Corrected to `from ..core`.
|
||||
|
||||
## [0.18.1] - 2026-05-22
|
||||
### Changed
|
||||
- Recording badge: dropped the sample count (not useful at a glance) — it now shows just
|
||||
**● Recording** + the game, plus a **⚠ GPU-lost** line if one is detected.
|
||||
|
||||
## [0.18.0] - 2026-05-22
|
||||
### Added
|
||||
- **Global recording indicator.** While a capture is running, the sidebar shows a red
|
||||
**● Recording** badge on every page — with the **game** being captured and the live sample
|
||||
count (and a GPU-lost flag if seen). It polls the recorder, so it reflects captures started
|
||||
any way: manual `record`, a guided diagnostic, or the Steam launch wrapper.
|
||||
|
||||
## [0.17.0] - 2026-05-22
|
||||
### Added
|
||||
- **Inventory page is back in the GUI** (it was removed in 0.7.2 in favor of the CLI). Sidebar
|
||||
**Inventory** → System / CPU / Firmware / Memory / GPU / Storage / Display as cards, with
|
||||
**Copy Markdown** and **Save…** for pasting into forum/bug reports, and **Refresh**. Root-only
|
||||
details (motherboard/BIOS/RAM modules via dmidecode) fill in after the launch password prompt.
|
||||
Backed by the existing M5 `core/inventory.py` — the CLI `rigdoctor inventory` is unchanged.
|
||||
|
||||
## [0.16.0] - 2026-05-22
|
||||
### Added
|
||||
- **Automatic crash-capture via a Steam launch wrapper (M6/D12).** Set `rigdoctor wrap
|
||||
%command%` as a game's Steam launch option (or in Lutris/Heroic's wrapper field) and RigDoctor
|
||||
starts a focused, game-tagged capture when the game launches and stops it cleanly on exit — no
|
||||
manual Run Diagnostic / Finish. A hard freeze leaves the capture unterminated, so it's flagged
|
||||
as a crash next launch. The wrapper resolves the game name from Steam's `SteamAppId`, doesn't
|
||||
disturb an existing capture, and returns the game's exit code. (`core/wrap.py`, `rigdoctor wrap`.)
|
||||
- GUI **Auto-capture…** helper on the Games page: shows the exact launch-option line (absolute
|
||||
path, copy button) and how to set it in Steam.
|
||||
- Auto-capture preserves an unanalyzed crash (`diagnostic-crash.jsonl`) before starting a new
|
||||
capture, so relaunching the game can't wipe a crash report you haven't seen yet.
|
||||
### Fixed
|
||||
- `docs/MODULES.md` status column was stale — M1, M3, M4, M5, M8, M10, and M13 are done and now
|
||||
marked ✅ (only M2 and M11 remain not-started; M6/M9/M12 in progress).
|
||||
|
||||
## [0.15.0] - 2026-05-22
|
||||
### Added
|
||||
- **Hard-crash detection & recovery for the guided diagnostic.** If a focused capture ends
|
||||
without a clean stop (the recorder never wrote `session-stop` and isn't running), RigDoctor
|
||||
treats it as a likely hard freeze. On launch the **Games** page shows a warning banner —
|
||||
*"Your last diagnostic for <game> ended unexpectedly…"* — with **Analyze crash** / **Dismiss**.
|
||||
- **Deeper crash analysis.** *Analyze crash* combines the captured window (final readings before
|
||||
the freeze + any GPU-lost event) with a focused scan of the **previous (crashed) boot's kernel
|
||||
log** (`journalctl -k -b -1`: Xid/panic/OOM/MCE/AER/thermal) plus SMART/driver/persistence/
|
||||
live-temp checks — the full "what happened" picture. `core/diagnostic.py` gains
|
||||
`pending_crash()` / `analyze_crash()`; `health.check_previous_boot()` +
|
||||
`run_health_checks(include_journal=False)` back it.
|
||||
|
||||
## [0.14.0] - 2026-05-22
|
||||
### Changed
|
||||
- **Dashboard headline tiles are now history trend graphs** instead of single-value gauges —
|
||||
GPU temp, GPU load, CPU temp, and memory each plot their recent history (with the current
|
||||
value, window min/max, and a dashed warning-threshold line), so you can see changes over time
|
||||
rather than only the instantaneous reading. New `HistoryGraph` widget (QPainter, no new deps).
|
||||
|
||||
## [0.13.0] - 2026-05-22
|
||||
### Added
|
||||
- **Run Diagnostic now explains itself and can launch the game.** Clicking Run Diagnostic shows
|
||||
what to do — *play the game, reproduce the crash, then Finish & analyze* (and that data
|
||||
survives a hard freeze + reboot) — and offers **Launch game & start** (asks Steam to run it by
|
||||
appid) or **Start without launching**. The recording banner now spells out the next step
|
||||
instead of just showing a sample count.
|
||||
### Fixed
|
||||
- Button labels containing "&" (e.g. "Finish & analyze") rendered as "Finish _analyze" because
|
||||
Qt treated the "&" as a keyboard mnemonic — now escaped so the ampersand shows literally.
|
||||
|
||||
## [0.12.0] - 2026-05-22
|
||||
### Added
|
||||
- **Guided diagnostic in the GUI.** Each game on the **Games** page now has a **Run Diagnostic**
|
||||
button → a focused, game-tagged capture starts and a recording banner appears (live sample
|
||||
count, GPU-lost indicator) with **Finish & analyze** / **Discard**. Finishing opens a results
|
||||
dialog: the window-scoped capture summary (peak temps/power, events, last samples) plus the
|
||||
health findings as cards. The banner persists/restores if you navigate away and back while a
|
||||
capture is running. Shares `core/diagnostic.py` with the CLI (one flow, three front-ends).
|
||||
|
||||
## [0.11.0] - 2026-05-22
|
||||
### Added
|
||||
- **Guided diagnostic session (CLI) — the seed use case, end to end.** `rigdoctor diagnose
|
||||
start --game "<name>"` runs a **focused crash-capture tagged with that game** (its own
|
||||
diagnostic log, so the report is scoped to just that session), `diagnose status` shows
|
||||
progress, and `diagnose finish` stops it and prints a combined report: the **capture
|
||||
summary** (peak temps/power, GPU-lost events, last samples — M3) plus the **health findings**
|
||||
(Xid/SMART/driver/etc. — M4). The game can be given by `--game` or `--appid` (resolved from
|
||||
the Steam scan), and is recorded as a log event so it survives a crash + reboot.
|
||||
- Shared orchestration lives in `core/diagnostic.py` (one callable for CLI/GUI/tray, per
|
||||
ARCHITECTURE §7.1); the recorder/`record run` gained an optional `--game` tag.
|
||||
|
||||
## [0.10.2] - 2026-05-22
|
||||
### Changed
|
||||
- When an Environment **Apply**/**Install** fails, the status now shows the **real reason**
|
||||
(cancelled at the password prompt vs. the system rejecting the change, e.g. a BIOS/kernel-
|
||||
locked PCIe ASPM policy) instead of a vague "cancelled, or needs privileges".
|
||||
|
||||
## [0.10.1] - 2026-05-22
|
||||
### Fixed
|
||||
- **Environment-page contrast.** The combo-box **drop-down list** was rendering light-on-light
|
||||
(the popup view is a separate widget the theme didn't cover) — now dark with readable text.
|
||||
- The **Install / Apply** buttons on findings were hard to read (the accent fill didn't paint
|
||||
reliably inside the finding cards, leaving dim dark-on-dark text). They're now an outlined
|
||||
style — bright accent text on the dark card, filling accent on hover — readable regardless,
|
||||
and given a minimum height so the row can't crush them.
|
||||
|
||||
## [0.10.0] - 2026-05-22
|
||||
### Added
|
||||
- **Actionable Environment page (M6) — install & apply, not just advice.** Findings that
|
||||
recommend a tool or a setting are now one-click:
|
||||
- **Install buttons** for GameMode, MangoHud, and cpupower (added to the M9 component catalog,
|
||||
so they also appear on the **Setup** page with the existing installer).
|
||||
- **Apply controls** for runtime-reversible tunables — a dropdown of the live options + Apply,
|
||||
via a single pkexec prompt, no reboot: **CPU governor**, **NVIDIA persistence mode**,
|
||||
**PCIe ASPM policy**, **vm.swappiness**, **Transparent HugePages** (`core/fixes.py`). The
|
||||
chosen value is validated against the live options before anything runs.
|
||||
- This is the consent-gated apply milestone D9 anticipated, scoped to safe settings (**D22**).
|
||||
GRUB-based fixes and CPU mitigations stay suggestion-only; `rigdoctor gameenv` still prints
|
||||
the exact commands for headless use.
|
||||
### Changed
|
||||
- The `Finding` model gained optional `action` (installable component) and `fix` (applyable
|
||||
tunable) fields; the shared `finding_card` widget renders the matching control.
|
||||
|
||||
## [0.9.0] - 2026-05-22
|
||||
### Added
|
||||
- **Gaming environment checks (M6) — the evaluate-and-suggest engine.** A new read-only report
|
||||
(D9) that flags system settings which hurt gaming stability/performance and gives the exact fix
|
||||
command. Checks: **PCIe ASPM**, **NVIDIA persistence mode**, **CPU governor** (the three that
|
||||
map to the seed-case GPU bus-drop / Xid 79), GameMode, MangoHud, `vm.swappiness`, shader disk
|
||||
cache, Transparent HugePages, CPU mitigations, and installed Proton versions.
|
||||
- **CLI:** `rigdoctor gameenv` (text or `--json`).
|
||||
- **GUI:** a new **Environment** page (findings cards, auto-runs on open), reusing the M4
|
||||
health-report card style via a shared `finding_card` widget.
|
||||
### Fixed
|
||||
- **Notification icon** now uses the RigDoctor icon (matching the app/dock) instead of a generic
|
||||
stock icon — resolved from the installed icon theme, the bundled asset, then a stock fallback.
|
||||
|
||||
## [0.8.0] - 2026-05-22
|
||||
### Added
|
||||
- **Gaming environment checks (M6) — Steam game detection.** RigDoctor now finds your Steam
|
||||
libraries (across multiple drives, via `libraryfolders.vdf`) and the games installed in each
|
||||
(parsing `appmanifest_*.acf` — stdlib only, no Steam tooling needed). Runtimes, Proton builds,
|
||||
and redistributables are filtered out.
|
||||
- **Opt-in libraries:** detected libraries are listed with a per-library game count; you check
|
||||
the ones to scan. Nothing is scanned until you pick a library.
|
||||
- **Background scan on every launch:** the GUI rescans the selected libraries in the background
|
||||
when it opens and flags games installed since the last scan with a **NEW** badge plus a count
|
||||
on the **Games** sidebar item (cleared when you view the page). Results are cached
|
||||
(`~/.local/state/rigdoctor/games.json`) so the list shows instantly.
|
||||
- **CLI:** `rigdoctor games` lists detected games; `rigdoctor games libraries
|
||||
[--enable PATH | --disable PATH | --all]` lists/selects libraries (headless-complete, D17).
|
||||
- Config now supports list values (TOML arrays); `steam_libraries` records the selected libraries.
|
||||
|
||||
## [0.7.3] - 2026-05-21
|
||||
### Fixed
|
||||
- Shared terminal now has **scrollback** — large output (e.g. `ls -la`) can be scrolled up to
|
||||
read; it keeps a history buffer and only auto-scrolls to the bottom when you're already there.
|
||||
|
||||
## [0.7.2] - 2026-05-21
|
||||
### Changed
|
||||
- Removed the GUI **Inventory** tab — use the CLI `rigdoctor inventory` instead. (Inventory is
|
||||
still collected for the relay guest view, so a remote helper still sees the host's hardware.)
|
||||
### Fixed
|
||||
- Shared terminal caret now sits at the real cursor position (row **and** column) instead of
|
||||
the start of the line.
|
||||
|
||||
## [0.7.1] - 2026-05-21
|
||||
### Fixed
|
||||
- Shared terminal: a guest who joined **after** the host enabled the terminal stayed read-only.
|
||||
The host now re-sends the terminal state when a guest joins, so the terminal is available.
|
||||
- Inventory page no longer jumps back to the top when it refreshes (e.g. when elevated data
|
||||
arrives) — scroll position is preserved and unchanged data isn't re-rendered.
|
||||
- Shared terminal now follows the cursor to the bottom as output arrives (e.g. `ls -la`),
|
||||
instead of staying scrolled up.
|
||||
|
||||
## [0.7.0] - 2026-05-21
|
||||
### Added
|
||||
- **Shared terminal (M12, Tier 3)**: when the host enables it, the session shares a real **PTY**
|
||||
shell — the guest gets an interactive terminal (vim, top, tab-completion, Ctrl-C) running on
|
||||
the host as the host's user. The host **reads along** live and can type too, e.g. a `sudo`
|
||||
password — which stays local and is never sent to the guest. Off by default, host-consented.
|
||||
The guest also pulls the host's inventory on join.
|
||||
### Fixed
|
||||
- **Input contrast**: all form controls (text fields, spin boxes, combo boxes, terminals) now
|
||||
use the dark theme with readable text (Fusion defaulted them to light-on-light).
|
||||
|
||||
## [0.6.0] - 2026-05-21
|
||||
### Added
|
||||
- **Session sharing over the relay (M12)**: a **Share** tab — *Start shared session* (host)
|
||||
hands you a short code and streams a read-only live view; *Enter share code* (guest) joins
|
||||
someone else's session and views their sensors/health/inventory. Both connect outbound over
|
||||
WebSocket to the relay (`relay_url`, default `wss://rigdoctor.jesseyvanofferen.com`), gated
|
||||
by your Gitea access token — no port forwarding. Read-only.
|
||||
|
||||
## [0.5.0] - 2026-05-21
|
||||
### Added
|
||||
- **Session sharing (M12, Tier 2)**: `rigdoctor share serve` starts a **read-only** live view
|
||||
(sensors auto-refresh + health report + inventory) over a local HTTP server, gated by a
|
||||
random share token. Bind to localhost for local testing, or to all interfaces behind a
|
||||
user-chosen tunnel (Tailscale/cloudflared/SSH) for remote help. No actions, no terminal.
|
||||
(Tier 1 export and Tier 3 gated terminal still to come — D16.)
|
||||
|
||||
## [0.4.1] - 2026-05-21
|
||||
### Fixed
|
||||
- Checkbox contrast: a checked checkbox is now a clear accent-filled box with a checkmark
|
||||
(was hard to tell checked from unchecked on the dark theme).
|
||||
|
||||
## [0.4.0] - 2026-05-21
|
||||
### Added
|
||||
- **Alerts (M8)**: desktop notifications (via `notify-send`) for **overheat** (GPU/CPU past a
|
||||
threshold), **GPU-lost** (nvidia-smi timeout), and a **new version available** (fired once
|
||||
per version). Edge-triggered with a cooldown so it doesn't spam. Degrades gracefully if
|
||||
`notify-send` isn't installed.
|
||||
- **Notifications page**: configure alerts (enable/disable, GPU/CPU temperature thresholds)
|
||||
with a "Send test" button; changes apply live and persist to `config.toml`.
|
||||
- **App icon**: ships a RigDoctor icon and shows it in the dock/launcher. The GUI
|
||||
**self-registers** the icon + `.desktop` on launch (and sets the Wayland app-id), so a
|
||||
self-update + relaunch picks it up — no need to re-run the installer.
|
||||
|
||||
## [0.3.2] - 2026-05-21
|
||||
### Changed
|
||||
- Replaced the per-page "Run with admin" buttons with a **single password prompt at launch**
|
||||
(`pkexec`): the GUI collects root-only data (SMART + dmidecode board/BIOS/RAM) once and
|
||||
caches it for the session, so Health and Inventory always show the full picture. Falls back
|
||||
to non-root if cancelled/unavailable; disable via `elevate_on_launch = false`.
|
||||
|
||||
## [0.3.1] - 2026-05-21
|
||||
### Fixed
|
||||
- Changelog/release notes now **render Markdown** instead of showing raw `#`/`**` markup —
|
||||
the in-app changelog uses `QTextEdit.setMarkdown()` and the update prompt renders notes as
|
||||
rich text (closes #1).
|
||||
|
||||
## [0.3.0] - 2026-05-21
|
||||
### Added
|
||||
- **System inventory (M5)**: CPU, GPU (model/driver/VBIOS/VRAM/PCIe), motherboard/BIOS, RAM
|
||||
(total + modules), storage, kernel, and display server. CLI `rigdoctor inventory`
|
||||
(`--json` / `--markdown` / `--output`) and a GUI **Inventory** tab with Copy-as-Markdown,
|
||||
Save, and "Run with admin" (for `dmidecode` board/BIOS/RAM details). Fills the last GUI tab.
|
||||
|
||||
## [0.2.0] - 2026-05-21
|
||||
### Added
|
||||
- **"Check for updates" button** in the sidebar — force an immediate version check instead of
|
||||
waiting for the 30-minute poll.
|
||||
|
||||
## [0.1.1] - 2026-05-21
|
||||
### Fixed
|
||||
- Dialogs (the update prompt and changelog) were light-on-light and unreadable — they now use
|
||||
the dark theme with readable text.
|
||||
|
||||
## [0.1.0] - 2026-05-21
|
||||
_First milestone release — a complete, installable, self-updating RigDoctor: live monitoring,
|
||||
crash capture + health report, desktop GUI, user-local install/uninstall, and updates._
|
||||
### Added
|
||||
- **In-app uninstaller**: "Uninstall RigDoctor" button on the Setup page (and
|
||||
`rigdoctor uninstall [--purge]`) — removes the venv, launchers, and desktop entry, with an
|
||||
option to also wipe settings/token/logs. Runs detached so it can delete its own venv.
|
||||
- **In-app changelog**: a "Changelog" link in the sidebar opens the release history (tags +
|
||||
notes) fetched from the update server.
|
||||
|
||||
## [0.0.10] - 2026-05-21
|
||||
### Added
|
||||
- **"Restart now" button** after a successful in-app update — relaunches RigDoctor for you
|
||||
instead of asking you to restart manually.
|
||||
- **Real release notes**: CI now sets each Gitea release's body from the matching CHANGELOG
|
||||
section (instead of "Automated release for…"), and the updater shows **"What's new"** — a
|
||||
notes dialog before applying (GUI) and in `rigdoctor update` (CLI).
|
||||
### Changed
|
||||
- Setup page / `rigdoctor install`: dropped internal module references (M4, M5, …) from the
|
||||
component descriptions — end users don't need them.
|
||||
- Adopting **Conventional Commits** + **git-cliff** (`cliff.toml`, `packaging/changelog.sh`)
|
||||
to generate CHANGELOG entries from commit history going forward (D20).
|
||||
### Fixed
|
||||
- The self-extracting **`.run` installer** is now built **without makeself** (a pure-Python
|
||||
self-extractor, `packaging/make_run.py`), so it reliably attaches to every release — it was
|
||||
silently skipped before because the CI runner couldn't install makeself.
|
||||
|
||||
## [0.0.8] - 2026-05-21
|
||||
### Added
|
||||
- **Periodic update checks**: the GUI now re-checks for new releases while running (every
|
||||
`update_check_minutes`, default 30; 0 disables), so a newly published version is detected
|
||||
without restarting. After applying an update, re-checks stop until restart.
|
||||
- **"Run with admin" on the Health page**: runs all checks (including root-only SMART) via
|
||||
`pkexec rigdoctor report --json`, so the full report — not just "SMART needs root" — is
|
||||
available from the UI.
|
||||
|
||||
## [0.0.7] - 2026-05-21
|
||||
### Added
|
||||
- **User-local installer** `install.sh` (no root): creates a private venv, links
|
||||
`rigdoctor`/`rigdoctor-gui` into `~/.local/bin`, and adds a desktop entry. Re-run to
|
||||
upgrade; `--uninstall` to remove.
|
||||
- **Self-extracting `.run` installer** via `packaging/make-run.sh` (makeself) — one
|
||||
download-and-run executable bundling the wheel + `install.sh`; built and attached to each
|
||||
release by CI.
|
||||
- **Self-update apply (M13)**: `rigdoctor update` now installs the newer version via
|
||||
authenticated pip (`rigdoctor[gui] @ git+https://oauth2:<token>@…@<tag>`); the GUI sidebar
|
||||
"Update to v…" button applies it and prompts to restart. Token is scrubbed from output.
|
||||
|
||||
## [0.0.6] - 2026-05-21
|
||||
### Added
|
||||
- **Token-gated updates (M13)**: store a Gitea Personal Access Token, **encrypted in the OS
|
||||
keyring** (Secret Service / GNOME Keyring via `secret-tool`) with a 0600-file fallback.
|
||||
`rigdoctor login` / `logout` / `update [--check]`; GUI **Setup → Update access** panel
|
||||
(token field, "Get a token", backend status) and sidebar states (connect / up-to-date /
|
||||
"Update to v…" / access denied). Updates are gated to accounts on the Gitea server (D18).
|
||||
- `libsecret-tools` added to the installer catalog (enables encrypted token storage).
|
||||
### Changed
|
||||
- D18 update mechanism revised from anonymous public HTTP to **authenticated HTTP (token)** —
|
||||
the Gitea instance requires sign-in for all anonymous access.
|
||||
|
||||
## [0.0.5] - 2026-05-21
|
||||
### Added
|
||||
- **M9 installer (first cut)**: detects distro / package manager / GPU; a catalog of optional
|
||||
components (smartmontools, lm-sensors, dmidecode, pciutils, libnotify) with what each
|
||||
enables; `rigdoctor install [--check] [-y]` installs missing apt packages via pkexec/sudo
|
||||
with consent; GUI **Setup** tab with one-click install. Fixes the "smartmontools missing"
|
||||
gap in the health report.
|
||||
- **Update check (M13, check half)**: on GUI launch the sidebar checks the Gitea releases API
|
||||
and shows "up-to-date", an "Update to v…" button if a newer release exists, or "update check
|
||||
unavailable" if the API can't be reached anonymously.
|
||||
|
||||
## [0.0.4] - 2026-05-21
|
||||
### Added
|
||||
- **M4 health report**: scans kernel logs (NVIDIA Xid incl. 79 "fell off the bus", kernel
|
||||
panic, OOM, MCE, PCIe AER, thermal, amdgpu reset), SMART health, NVIDIA driver/library
|
||||
mismatch, journald persistence, and live temps → prioritized plain-language findings with
|
||||
suggested fixes (read-only, D9).
|
||||
- CLI `rigdoctor report` (text + `--json`).
|
||||
- GUI **Health** tab: runs checks in the background; findings shown as severity-colored cards.
|
||||
- Tests for the journal scanner.
|
||||
|
||||
## [0.0.3] - 2026-05-21
|
||||
### Added
|
||||
- Show the app version (`v<version>`) in the GUI sidebar.
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
|
||||
A **modular diagnostics, monitoring, and health-check toolkit for Linux gamers.**
|
||||
|
||||
> **Status:** 🟢 Phase 1 (MVP) in progress. The **sensor core (M1)** and **crash-capture
|
||||
> logger (M3)** work — `snapshot`/`monitor` read NVIDIA GPU, CPU, memory, and NVMe live, and
|
||||
> `record` captures a crash-safe log with a post-crash report. A desktop GUI (M10) is also
|
||||
> up. Health report (M4) is next. See `docs/ROADMAP.md`.
|
||||
> **Status:** 🟢 Phase 1 (MVP) complete. The **sensor core (M1)**, **crash-capture logger
|
||||
> (M3)**, and **health report (M4)** all work — live `snapshot`/`monitor`, crash-safe `record`
|
||||
> with a post-crash report, and `report` to scan logs/SMART/driver for likely causes. A
|
||||
> desktop GUI (M10) ties them together (dashboard, recording, health). See `docs/ROADMAP.md`.
|
||||
|
||||
## Why this exists
|
||||
|
||||
@@ -63,6 +63,21 @@ Full rationale and the still-open questions are in `docs/DECISIONS.md`.
|
||||
| `installer/` | Installer / `.deb` packaging (empty until Phase 4) |
|
||||
| `tests/` | Tests (stdlib `unittest`) |
|
||||
|
||||
## Install (user-local, no root)
|
||||
|
||||
RigDoctor installs into a private venv under `~/.local` — no root, self-updating:
|
||||
|
||||
```bash
|
||||
./install.sh # from a source checkout or the self-extracting .run
|
||||
./install.sh --ref v0.0.6 # install a specific released tag (needs a token)
|
||||
./install.sh --uninstall # remove it
|
||||
```
|
||||
|
||||
This adds `rigdoctor` / `rigdoctor-gui` to `~/.local/bin` and a desktop entry. Each release
|
||||
also ships a one-file **`.run`** installer (download, `chmod +x`, run). Updates are gated to
|
||||
accounts on the Git server (a Personal Access Token); save one via the GUI **Setup → Update
|
||||
access** panel or `rigdoctor login`, then `rigdoctor update` (or the sidebar button).
|
||||
|
||||
## Run it (dev)
|
||||
|
||||
Stdlib-only, no install needed (target is Python ≥ 3.11; tested on 3.14):
|
||||
@@ -104,8 +119,8 @@ rigdoctor gui # or: rigdoctor-gui
|
||||
It opens a dark-themed window with sidebar navigation and a **live dashboard** over the
|
||||
same sensor core — circular gauges for the headline metrics plus collapsible per-subsystem
|
||||
cards (GPU/CPU/memory/storage) with temperature-colored values (icey-blue → green → red).
|
||||
The **Logs** section is a full recording page (start/stop, live status, and the post-crash
|
||||
report); Health / Inventory are placeholders until M4 / M5 land.
|
||||
The **Logs** and **Health** sections are full pages (recording controls + post-crash report;
|
||||
and the kernel-log / SMART / driver scan). **Inventory** is a placeholder until M5 lands.
|
||||
|
||||
Without the GUI extra, `pip install -e .` gives just the stdlib-only CLI.
|
||||
|
||||
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
# git-cliff configuration — generate CHANGELOG.md from Conventional Commits (D20).
|
||||
# Run via packaging/changelog.sh.
|
||||
|
||||
[changelog]
|
||||
header = """
|
||||
# Changelog
|
||||
|
||||
All notable changes to RigDoctor are recorded here. Format follows
|
||||
[Keep a Changelog](https://keepachangelog.com/); versioning is SemVer-style
|
||||
(`MAJOR.MINOR.PATCH`, pre-1.0). `__version__` and `pyproject.toml` must match the git
|
||||
release tag (so the auto-updater, D18, can compare versions).
|
||||
"""
|
||||
body = """
|
||||
{% for group, commits in commits | group_by(attribute="group") %}
|
||||
## {{ group | upper_first }}
|
||||
{% for commit in commits %}\
|
||||
- {{ commit.message | upper_first }}\
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
"""
|
||||
trim = true
|
||||
|
||||
[git]
|
||||
conventional_commits = true
|
||||
filter_unconventional = false
|
||||
commit_parsers = [
|
||||
{ message = "^feat", group = "Added" },
|
||||
{ message = "^fix", group = "Fixed" },
|
||||
{ message = "^docs", group = "Documentation" },
|
||||
{ message = "^perf", group = "Performance" },
|
||||
{ message = "^refactor", group = "Changed" },
|
||||
{ message = "^chore\\(release\\)", skip = true },
|
||||
{ message = "^chore|^build|^ci|^style|^test", group = "Internal" },
|
||||
{ message = ".*", group = "Other" },
|
||||
]
|
||||
tag_pattern = "v[0-9]*"
|
||||
sort_commits = "oldest"
|
||||
|
||||
[bump]
|
||||
# Pre-1.0 rules (D21): feat -> minor, fix -> patch, breaking -> minor (not major).
|
||||
features_always_bump_minor = true
|
||||
breaking_always_bump_major = false
|
||||
+72
-4
@@ -152,9 +152,22 @@ reachable from it. This **supersedes the earlier "CLI-first / terminal-first" fr
|
||||
- *No change to layering (D2):* the core, CLI, and daemon stay **stdlib-only** and must run
|
||||
without Qt. "GUI-first" is about emphasis and front-end parity, not dropping headless support.
|
||||
|
||||
### D18 — Auto-update (M13) — *PLANNED 2026-05-21*
|
||||
### D18 — Auto-update (M13) — *PLANNED 2026-05-21; mechanism revised 2026-05-21*
|
||||
RigDoctor should **check for a newer version on launch and self-update** (new module **M13**).
|
||||
**Mechanism (chosen): user-local, no-root self-update from the public repo.**
|
||||
**Mechanism (revised): user-local, no-root self-update over authenticated HTTP (token).**
|
||||
*Why revised:* the Gitea instance requires sign-in for **all** anonymous access (repo page,
|
||||
releases feed, raw, API all 303/403 anonymously), so the original "public HTTP" plan can't
|
||||
work. Updates are therefore **gated to people with an account on the Gitea server**, which is
|
||||
desirable — access control is delegated to Gitea.
|
||||
- *Auth:* each user creates a **Personal Access Token** (scope `read:repository`); RigDoctor
|
||||
stores it at `~/.config/rigdoctor/token` (mode 0600) or reads `RIGDOCTOR_TOKEN`. Requests
|
||||
send `Authorization: token <PAT>`. Finer access = repo visibility/collaborators on Gitea.
|
||||
- *Check:* `GET /api/v1/repos/jessey/rigdoctor/releases/latest` with the token; compare tags.
|
||||
- *Apply:* `pip install --upgrade "git+https://oauth2:<token>@…/rigdoctor.git@<tag>"` into the
|
||||
user-local venv, then restart (incl. the daemon). No root.
|
||||
- *States surfaced:* no-token → "connect to update server"; auth error → "access denied";
|
||||
newer → "Update to v…"; else "up-to-date".
|
||||
- *Original (now-superseded) plan was anonymous public HTTP:*
|
||||
- *Install model (D8 revised):* primary install is **user-local** (`~/.local`), so the running
|
||||
app can replace its own files and update with **no apt, no root, no password prompt**.
|
||||
- *Check:* on launch, query the **public Gitea releases API**
|
||||
@@ -178,12 +191,67 @@ RigDoctor should **check for a newer version on launch and self-update** (new mo
|
||||
PATCH for ordinary changes, MINOR for larger milestones). `__version__`
|
||||
(`rigdoctor/__init__.py`) and `pyproject.toml` are the single source of truth and **must match
|
||||
the git release tag** so the auto-updater (D18) can compare versions. Every change updates
|
||||
`CHANGELOG.md` (Keep a Changelog style). *Note:* an early placeholder `0.1.0` was corrected to
|
||||
`CHANGELOG.md` — now generated from **Conventional Commits** via git-cliff (see D20).
|
||||
*Milestone policy (pre-1.0):* **0.0.x** = early development; **0.1.0** = first complete,
|
||||
installable, self-updating release (reached 2026-05-21); **0.x.0** = each later milestone
|
||||
(AMD/Intel, unattended logger auto-start, session sharing…); **1.0.0** = broadly stable
|
||||
(multi-vendor/distro, no major caveats). PATCH (`0.x.PATCH`) for fixes/small changes. *Note:* an early placeholder `0.1.0` was corrected to
|
||||
follow the released **0.0.x** line — first release was **V0.0.1**; current is **0.0.2**.
|
||||
|
||||
### D20 — Automated changelog & release notes — *DECIDED 2026-05-21*
|
||||
**Release notes are generated from our changes, surfaced in the auto-updater.**
|
||||
- *Release body:* CI sets each Gitea release's `body` from the matching `CHANGELOG.md`
|
||||
section (was a hardcoded "Automated release for…"). The updater fetches the release `body`
|
||||
and shows **"What's new"** — a dialog before applying (GUI) and in `rigdoctor update` (CLI).
|
||||
- *Generation:* adopt **Conventional Commits** (`feat:`/`fix:`/`docs:`/`chore:` …) and
|
||||
**git-cliff** (`cliff.toml`, `packaging/changelog.sh`) to generate `CHANGELOG.md` from
|
||||
commit history. Refines D19's "hand-write CHANGELOG" to "generate it from conventional
|
||||
commits"; `__version__`/`pyproject.toml`/tag still the source of truth for the version.
|
||||
- *CI does not auto-commit the changelog* (avoids push loops) — it's regenerated by the dev
|
||||
via the script when cutting a version; CI only reads the section for the release body.
|
||||
|
||||
### D21 — Versioning rules & automation — *DECIDED 2026-05-21*
|
||||
The next version is **determined by the Conventional Commit types** since the last release
|
||||
(D20), so it can be auto-computed instead of guessed:
|
||||
- `fix:` / `perf:` → bump **PATCH**.
|
||||
- `feat:` → bump **MINOR** (pre-1.0: `0.MINOR.0`).
|
||||
- breaking (`feat!:` / `BREAKING CHANGE:`) → pre-1.0: bump **MINOR** (not major); post-1.0: MAJOR.
|
||||
- `docs:` / `chore:` / `refactor:` / `ci:` / `test:` / `style:` alone → **PATCH** (no feature release).
|
||||
- Milestone overrides by hand are allowed (e.g., jumping to `1.0.0`); see the milestone policy in D19.
|
||||
|
||||
*Automation:* `git-cliff --bumped-version` computes the next version from history;
|
||||
`packaging/bump.sh` writes it into `__init__.py` + `pyproject.toml`. Rules live in
|
||||
`cliff.toml [bump]` (pre-1.0: `breaking_always_bump_major = false`).
|
||||
|
||||
### D22 — Limited live apply of fixes (M6) — *DECIDED 2026-05-22; realizes the D9 milestone*
|
||||
D9 deferred auto-applying fixes to "a deliberate later milestone, gated behind explicit user
|
||||
consent." That milestone lands here, **scoped tightly to stay safe**:
|
||||
- **Only runtime-reversible settings** are applyable from the gaming-environment report (M6):
|
||||
**CPU governor, NVIDIA persistence mode, PCIe ASPM policy, vm.swappiness, Transparent
|
||||
HugePages.** Each takes effect immediately, needs **no reboot**, and reverts on reboot.
|
||||
- **How:** a dropdown of the live options + an Apply button per finding (`core/fixes.py`).
|
||||
Applying runs a **single pkexec-elevated command** (one auth prompt); the chosen value is
|
||||
validated against the live options first; writes target **sysfs/procfs or `nvidia-smi`** —
|
||||
never the GRUB cmdline or a persistent config file.
|
||||
- **Still suggestion-only** (the read-only stance holds for these): GRUB-based `pcie_aspm=off`,
|
||||
CPU **mitigations** changes (security-sensitive, need a reboot), and the shader-cache env var.
|
||||
- Everything remains **CLI-discoverable** (`rigdoctor gameenv` still prints the exact commands);
|
||||
the apply UI is an additive convenience in the GUI, not the only path. Installing optional
|
||||
tools (GameMode/MangoHud/cpupower) reuses the M9 installer and is likewise one-click.
|
||||
|
||||
### D23 — Session sharing scoped to a shared terminal only — *DECIDED 2026-05-22; amends D16*
|
||||
D16's escalating ladder (export → read-only stats view → terminal) is **cut down to just the
|
||||
shared terminal.** Rationale: the terminal is the only mode the owner wants; the stats view
|
||||
duplicated what the GUI already shows and added surface area. Concretely:
|
||||
- **Removed:** the read-only stats view + its HTTP server (`core/share.py`, `rigdoctor share
|
||||
serve`) and the (never-built) bundle export. The `share` CLI command is gone.
|
||||
- **Kept & finished:** the relay **shared terminal** (host PTY of `$SHELL`) — now color-rendered
|
||||
(preserves fish/ls/git theming), full-screen-able, with the guest read-only unless the host
|
||||
ticks "Allow the guest to type" (the D9 consent exception). Account-gated by the Gitea token.
|
||||
|
||||
## Open
|
||||
|
||||
None currently — all tracked decisions (D1–D19) are resolved. New questions will be added
|
||||
None currently — all tracked decisions (D1–D23) are resolved. New questions will be added
|
||||
here as they arise. Remaining detail to flesh out during build: the tray's supporting-action
|
||||
set (D13), per-module apt package names, M12's tunnel/token specifics, and M13's
|
||||
update mechanism (APT repo vs. self-installed `.deb`).
|
||||
|
||||
+88
-35
@@ -8,18 +8,18 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
|
||||
| ID | Module | Bundle | Key deps | GPU scope | Priority | Status |
|
||||
|----|--------|--------|----------|-----------|----------|--------|
|
||||
| M1 | Sensor core | Essential | none (nvidia-smi, sysfs) | all (NVIDIA first) | P0 | ⬜ |
|
||||
| M3 | Crash-capture logger | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | 🟨 |
|
||||
| M4 | Health report (log scan) | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | ⬜ |
|
||||
| M2 | Live monitor (TUI) | Monitoring | none (stdlib curses) | all | P1 | ⬜ |
|
||||
| M8 | Alerting | Monitoring | libnotify (opt) | all | P2 | ⬜ |
|
||||
| M5 | System inventory | Diagnostics | none (opt: lm-sensors, dmidecode) | all | P1 | ⬜ |
|
||||
| M6 | Gaming env checks | Diagnostics | none | all | P2 | ⬜ |
|
||||
| M10 | Desktop GUI | Desktop UI | **python3-pyside6** | all | P2 | 🟨 |
|
||||
| M11 | Tray / menu-bar applet | Desktop UI | **python3-pyside6** (+ AppIndicator on GNOME) | all | P2 | ⬜ |
|
||||
| M9 | Installer | (meta) | none | all | P1 | ⬜ |
|
||||
| M12 | Session sharing / remote assist | Sharing | none (Tier 3: tmate/sshx) | all | P3 | ⬜ |
|
||||
| M13 | Auto-update | (core) | none (stdlib; user-local file swap) | all | P3 | ⬜ |
|
||||
| M1 | Sensor core | Essential | none (nvidia-smi, sysfs) | all (NVIDIA first) | P0 | ✅ |
|
||||
| M3 | Crash-capture logger | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | ✅ |
|
||||
| M4 | Health report (log scan) | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | ✅ |
|
||||
| M2 | Live monitor (TUI) | Monitoring | none (stdlib curses) | all | P1 | ✅ |
|
||||
| M8 | Alerting | Monitoring | libnotify (opt) | all | P2 | ✅ |
|
||||
| M5 | System inventory | Diagnostics | none (opt: lm-sensors, dmidecode) | all | P1 | ✅ |
|
||||
| M6 | Gaming env checks | Diagnostics | none | all | P2 | 🟨 |
|
||||
| M10 | Desktop GUI | Desktop UI | **python3-pyside6** | all | P2 | ✅ |
|
||||
| M11 | Tray / menu-bar applet | Desktop UI | **python3-pyside6** (+ AppIndicator on GNOME) | all | P2 | ✅ |
|
||||
| M9 | Installer | (meta) | none | all | P1 | 🟨 |
|
||||
| M12 | Session sharing (shared terminal) | Sharing | none (relay) | all | P3 | ✅ |
|
||||
| M13 | Auto-update | (core) | none (stdlib; user-local file swap) | all | P3 | ✅ |
|
||||
| ~~M7~~ | ~~Stress / repro~~ | — | — | — | — | ❌ dropped (D7) |
|
||||
|
||||
## Notes per module
|
||||
@@ -31,35 +31,88 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
*Implemented (manual trigger):* JSONL log with fsync-per-sample, size-based rotation
|
||||
(`log_max_bytes`/`log_backups`), GPU-lost/recovered event markers, atomic status file, and
|
||||
`rigdoctor record run|start|stop|status|report`. The foreground `run` is the systemd-ready
|
||||
entrypoint; the service unit + always-on/game-launch triggers (D6/D12) land in Phase 4.
|
||||
Also fully driven from the GUI's Recording/Logs page (M10) via shared `core.reccontrol`.
|
||||
entrypoint. The **game-launch trigger** is implemented via the D12 wrapper (`rigdoctor wrap
|
||||
%command%`, see M6/below); the `systemd --user` service unit + always-on trigger (D6) and the
|
||||
zero-config watcher (D12) are still pending. Also fully driven from the GUI's Recording/Logs
|
||||
page (M10) via shared `core.reccontrol`.
|
||||
- **M4 Health report** — turns scattered logs into a prioritized, plain-language findings
|
||||
list with **suggested** fixes (read-only, D9). Reuses M1 for a live snapshot. Also powers
|
||||
the **guided diagnostic session** (with M3): pick a game → focused capture → scan →
|
||||
findings (see SPEC §4).
|
||||
- **M2 Live monitor** — depends on M1; the terminal "HWMonitor for Linux" face. Stdlib-only.
|
||||
findings (see SPEC §4). *Implemented:* journalctl scan (Xid/panic/OOM/MCE/AER/thermal/amdgpu),
|
||||
SMART, NVIDIA driver-mismatch, journald-persistence + live-temp checks; `rigdoctor report`
|
||||
(text/JSON) + GUI Health tab. GPU-firmware verification deferred.
|
||||
- **M2 Live monitor** — the terminal "HWMonitor for Linux" face. *Implemented (`tui.py`):*
|
||||
`rigdoctor monitor` is a stdlib **curses** dashboard — current / session-min / session-max
|
||||
per sensor, grouped by subsystem, with temperature & utilization color bands; `q` quits,
|
||||
`r` resets the min/max. Falls back to a plain redraw on a non-TTY (`--plain` forces it).
|
||||
- **M5 / M6 Diagnostics** — inventory export + gaming-env checks; M6 flags risky settings and
|
||||
suggests the fix command but does not apply it (D9).
|
||||
suggests the fix command but does not apply it (D9). *M6 implemented (Steam detection first —
|
||||
the D12 "pick a game" foundation):* discovers Steam installs + all library folders
|
||||
(`libraryfolders.vdf`, multi-drive) and the games in each (`appmanifest_*.acf`), filtering
|
||||
runtimes/Proton/redistributables — stdlib only. **Libraries are opt-in** (`steam_libraries`
|
||||
config); the GUI **Games** page lists them with per-library counts and rescans in the
|
||||
background on every launch, badging games installed since the last scan (cached in
|
||||
`state/games.json`). CLI: `rigdoctor games` / `games libraries [--enable|--disable|--all]`.
|
||||
*Env-check engine implemented* (`core/gameenv.py`): a read-only findings report (reusing the
|
||||
M4 `Finding` model) over PCIe ASPM, NVIDIA persistence mode, CPU governor (the three seed-case
|
||||
contributors to GPU bus-drop / Xid 79), GameMode, MangoHud, swappiness, shader cache, THP, CPU
|
||||
mitigations, and installed Proton versions — each with the suggested fix command. CLI
|
||||
`rigdoctor gameenv`; GUI **Environment** page. Per **D22**, the GUI adds **one-click apply**
|
||||
for the runtime-reversible tunables (governor / NVIDIA persistence / PCIe ASPM / swappiness /
|
||||
THP — dropdown + Apply via a single pkexec prompt, `core/fixes.py`) and **one-click install**
|
||||
of optional tools (GameMode / MangoHud / cpupower, now in the M9 catalog). GRUB/mitigations
|
||||
stay suggestion-only. *Guided diagnostic (D12 "pick a game", `core/diagnostic.py`):* a focused
|
||||
capture tagged with a game → window-scoped report (capture summary + M4 findings), in the CLI
|
||||
(`rigdoctor diagnose start/status/finish`) and GUI (per-game **Run Diagnostic** → recording
|
||||
banner → results dialog). **Auto-capture** via the D12 wrapper (`rigdoctor wrap %command%`,
|
||||
`core/wrap.py`; GUI "Auto-capture…" helper). **Hard crashes are detected** (capture left
|
||||
without a clean stop) and flagged on next launch with a crash-boot kernel-log analysis
|
||||
(`pending_crash`/`analyze_crash` + `health.check_previous_boot`). **Non-Steam launchers**
|
||||
(Lutris SQLite + Heroic JSON, `core/launchers.py`) are detected and listed alongside Steam
|
||||
games; env checks also cover **GPU PowerMizer** (X), **Wine** and **Steam-client** versions.
|
||||
*Pending:* the zero-config watcher (D12 fallback) — landing with M9's trigger-mode work.
|
||||
- **M8 Alerting** — threshold/event notifications; integrates with the tray applet (M11).
|
||||
- **M10 Desktop GUI** — PySide6 graphical front-end over the core engine (dashboard, log
|
||||
browser, report viewer, logger controls). Optional; adds the Qt dependency. *Bootstrapped
|
||||
early (ahead of its Phase 4 slot) at the user's request:* dark-themed window with sidebar
|
||||
nav, a live dashboard (circular gauges + collapsible per-subsystem cards, temperature-
|
||||
colored values), and a **Recording/Logs page** with full M3 controls (start/stop/status +
|
||||
post-crash report). Health/Inventory remain placeholders until M4/M5. GUI-first per D17.
|
||||
- **M11 Tray applet** — `QSystemTrayIcon` menu-bar applet. Dropdown shows live M1 readouts
|
||||
(CPU temp, GPU temp, memory used/total, status dot) and is led by a **Run Diagnostic**
|
||||
action (the guided diagnostic session), plus Open dashboard / Start-Stop recording /
|
||||
Snapshot / Quit (D13). Optional; shares the Qt dependency with M10.
|
||||
- **M10 Desktop GUI** — PySide6 graphical front-end over the core engine. Optional; adds the
|
||||
Qt dependency. Dark-themed window with a **grouped sidebar** (Monitor / Diagnose / System /
|
||||
App) over: **Dashboard** (live history graphs + per-subsystem cards), **Games** (M6 detection
|
||||
+ Run Diagnostic), **Recordings** (recorder controls + view/report any captured log + analyze
|
||||
a crash), **System Health** (M4 scan), **Tuning** (M6 gaming tunables + fixes), **Inventory**
|
||||
(M5), **Settings** (components/deps + alerts + account + uninstall), and **Share** (M12). A
|
||||
global recording badge shows on every page. GUI-first per D17.
|
||||
- **M11 Tray applet** — `QSystemTrayIcon` menu-bar applet. *Implemented (`gui/tray.py`, D13):*
|
||||
the menu shows live M1 readouts (CPU temp, GPU temp, memory used/total) + a status line
|
||||
(Normal / Hot / GPU not responding), led by a **Run Diagnostic** submenu (per detected game →
|
||||
the guided session), plus Open dashboard / Start-Stop recording / Snapshot-copy / Quit. It
|
||||
shares the dashboard's sample stream (no extra sampling) and drives the existing MainWindow
|
||||
flows. With a tray present, closing the window **hides to the tray** (Quit exits); `rigdoctor-gui
|
||||
--tray` starts hidden for autostart. Optional; shares the Qt dependency with M10. *Needs a tray
|
||||
host* — on GNOME that means the AppIndicator extension; degrades to no-op if none is available.
|
||||
- **M9 Installer** — interactive wizard layered on the `.deb` (D8); apt-first dependency
|
||||
resolution; enables the logger service and trigger mode.
|
||||
- **M12 Session sharing / remote assist** (D16) — let a helper inspect a user's machine, in
|
||||
an escalating ladder: (1) **diagnostic bundle export** (inventory + recent log + report,
|
||||
one-way), (2) **live read-only view** over a user-chosen tunnel (Tailscale/cloudflared/SSH,
|
||||
no hosted relay), (3) **gated interactive terminal** wrapping tmate/sshx (read-only by
|
||||
default; read-write only on explicit consent — a deliberate exception to D9). Per-session
|
||||
consent, ephemeral revocable tokens, audit log.
|
||||
- **M13 Auto-update** (D18) — *planned.* On launch, check the public Gitea releases API and
|
||||
resolution; enables the logger service and trigger mode. *Implemented (first cut):* distro/
|
||||
package-manager/GPU detection (`core/sysenv`), an optional-component catalog (`core/catalog`),
|
||||
and dependency install via pkexec/sudo — `rigdoctor install [--check] [-y]` + GUI Setup tab.
|
||||
The **user-local app install** is `install.sh` (private venv + `~/.local/bin` launchers +
|
||||
desktop entry, no root; handles the `python3-venv` prerequisite) plus a self-extracting
|
||||
**`.run`** (pure-Python self-extractor, `packaging/make_run.py`, built by CI). *Pending:*
|
||||
config/module selection + `systemd --user`
|
||||
service enable.
|
||||
- **M12 Session sharing / remote assist** (D16, scoped to terminal-only by **D23**) — a single
|
||||
mode: a **host-consented shared terminal** over the relay. The host shares a real PTY running
|
||||
their `$SHELL` (colors/theming preserved — fish etc.); the guest watches live and can type
|
||||
**only if the host allows it** (otherwise read-only) — a deliberate, consent-gated exception
|
||||
to D9. The host reads along and can type too (e.g. a sudo password, which stays local). Either
|
||||
side can pop the terminal **full-screen**. Account-gated by the Gitea token. *The earlier
|
||||
read-only stats view and `share serve` (Tier 1/2) were removed.*
|
||||
- **M13 Auto-update** (D18) — *check + auth implemented:* updates are **gated to Gitea account
|
||||
holders** via a Personal Access Token, stored **encrypted in the OS keyring** (`secret-tool`)
|
||||
with a 0600-file fallback (`config.load_token`/`save_token`/`token_backend`). `core/updates`
|
||||
queries the releases API with the token; CLI `login`/`logout`/`update`; GUI Setup "Update
|
||||
access" panel + sidebar states. The no-root **self-update apply** is implemented:
|
||||
`rigdoctor update` runs an authenticated `pip install --upgrade "rigdoctor[gui] @
|
||||
git+https://oauth2:<token>@…@<tag>"` into the user-local venv (GUI "Update to v…" button +
|
||||
restart prompt; token scrubbed). Installed via the user-local **`install.sh`** /
|
||||
self-extracting **`.run`** (M9).
|
||||
*Original plan:* On launch, check the public Gitea releases API and
|
||||
**self-update a user-local install with no root** (download → verify checksum/signature →
|
||||
atomic symlink swap → restart, incl. the daemon). HTTPS-only, version-check-only (no
|
||||
telemetry), opt-out-able. Surfaced in the GUI; `rigdoctor update` in the CLI. (`.deb` users
|
||||
|
||||
+55
-26
@@ -15,50 +15,79 @@ Ubuntu + NVIDIA first; `.deb` distribution (see `DECISIONS.md`).
|
||||
- [x] M3 crash-capture logger (JSONL, fsync per sample, GPU-lost detection, size rotation)
|
||||
- [x] Manual trigger mode (`rigdoctor record run/start/stop/status`); `systemd --user`
|
||||
service + other trigger modes in Phase 4 (`run` is already the service entrypoint)
|
||||
- [ ] M4 health report (Xid/panic/OOM/MCE/AER/thermal scan + driver-mismatch + snapshot,
|
||||
suggested fixes only — D9)
|
||||
- [x] M4 health report (Xid/panic/OOM/MCE/AER/thermal scan + SMART + driver-mismatch +
|
||||
journald-persistence + live temps, suggested fixes only — D9; GPU-firmware verify deferred)
|
||||
- [x] `record report` post-crash summary (peak temps/power per subsystem, events, last N samples)
|
||||
- **Exit criteria:** user can run it during gaming and, after a freeze/black-screen, see the
|
||||
last readings + a plausible cause.
|
||||
|
||||
## Phase 2 — Live monitor (terminal)
|
||||
- [ ] M2 TUI dashboard (current/min/max, grouped, throttle highlighting)
|
||||
- [x] M2 TUI dashboard (`rigdoctor monitor`, `tui.py`): curses, current/min/max grouped by
|
||||
subsystem with temp/usage color bands; q quit / r reset; plain-redraw fallback on non-TTY
|
||||
- [ ] M8 basic alerting (overheat/throttle/GPU-lost notifications)
|
||||
|
||||
## Phase 3 — Diagnostics breadth
|
||||
- [ ] M5 system inventory + exportable report
|
||||
- [ ] M6 gaming environment checks (suggest-only)
|
||||
- [~] M6 gaming environment checks (suggest-only) — *Steam game/library detection done*
|
||||
(multi-library `libraryfolders.vdf` discovery + `appmanifest` scan, opt-in libraries,
|
||||
launch-time background rescan with new-game badge; CLI `rigdoctor games`, GUI Games page).
|
||||
This is also the D12 "pick a game" foundation. *Env-check engine done* (`rigdoctor gameenv`
|
||||
+ GUI Environment page): PCIe ASPM, NVIDIA persistence, CPU governor, GameMode, MangoHud,
|
||||
swappiness, shader cache, THP, mitigations, Proton versions — read-only with fix commands.
|
||||
Also: GPU PowerMizer (X), Wine + Steam-client versions, and non-Steam launchers
|
||||
(Lutris/Heroic, `core/launchers.py`). *Pending:* the zero-config watcher (D12 fallback,
|
||||
lands with M9's trigger-mode work).
|
||||
- [ ] SMART integration (smartmontools if present)
|
||||
|
||||
## Phase 4 — Desktop UI & installer
|
||||
- [ ] M10 desktop GUI (PySide6: dashboard, log browser, report viewer, logger controls)
|
||||
- [ ] M11 tray / menu-bar applet (QSystemTrayIcon: live M1 readouts + Run Diagnostic +
|
||||
supporting actions — D13)
|
||||
- [ ] Guided diagnostic session (pick game → focused M3 capture → M4 scan → findings),
|
||||
shared by tray/GUI/CLI
|
||||
- [ ] Logger trigger modes: always-on + game-launch (D12 — wrapper first:
|
||||
`rigdoctor wrap %command%` + global Steam compat-tool; zero-config watcher
|
||||
(Steam RunningAppID + /proc) and GameMode hook follow)
|
||||
- [ ] M9 interactive installer (GPU detection, module menu, apt dependency resolution,
|
||||
service enable + trigger-mode pick)
|
||||
- [x] M10 desktop GUI (PySide6: dashboard w/ history graphs, logs, health, games, environment,
|
||||
inventory, setup, notifications, share)
|
||||
- [x] M11 tray / menu-bar applet (`gui/tray.py`: live CPU/GPU temp + memory readouts, status
|
||||
line, Run Diagnostic submenu per game, Open dashboard / Start-Stop recording / Snapshot /
|
||||
Quit — D13; close-to-tray, `--tray` autostart). Needs a tray host (AppIndicator on GNOME).
|
||||
- [~] Guided diagnostic session (pick game → focused M3 capture → M4 scan → findings),
|
||||
shared by tray/GUI/CLI — *core + CLI + GUI done* (`core/diagnostic.py`, `rigdoctor
|
||||
diagnose start/status/finish`, and a **Run Diagnostic** button per game on the GUI Games
|
||||
page → recording banner → results dialog with the capture summary + findings). Tags a
|
||||
focused capture with the chosen game (own diagnostic log, window-scoped report) and
|
||||
combines the capture summary with the M4 findings. **Auto start/stop** via the D12
|
||||
wrapper is wired in, and a **hard-crash is detected** (capture left without a clean stop)
|
||||
→ flagged on next launch with a deeper crash-boot log analysis. *Pending:* the tray (M11)
|
||||
entry point and the zero-config watcher.
|
||||
- [~] Logger trigger modes: always-on + game-launch (D12) — *game-launch **wrapper** done:*
|
||||
`rigdoctor wrap %command%` (per-game Steam launch option / Lutris/Heroic wrapper field)
|
||||
auto-brackets a focused capture around the game; GUI "Auto-capture…" helper shows the
|
||||
launch-option string. *Pending:* global Steam compat-tool registration, the zero-config
|
||||
watcher (Steam RunningAppID + /proc), GameMode hook, and the always-on `systemd --user`
|
||||
service.
|
||||
- [~] M9 interactive installer — *done:* distro/GPU detection + optional-dependency install
|
||||
(`rigdoctor install`, GUI Settings); **user-local `install.sh` + self-extracting `.run`**
|
||||
(no-root venv install, handles python3-venv prereq, CI-built); **`systemd --user` trigger
|
||||
modes** (`core/service.py`, `rigdoctor service mode manual|always-on|game-launch` + GUI
|
||||
Settings "Recording trigger") incl. the zero-config **game-launch watcher**
|
||||
(`core/watcher.py`, `rigdoctor watch`); and a **graphical first-run setup wizard**
|
||||
(`gui/setup_wizard.py`): environment → dependency-bundle selection → install → recording
|
||||
trigger → readiness, auto-launched by install.sh and re-runnable from Settings.
|
||||
*Pending:* `.deb` packaging (next bullet).
|
||||
- [ ] `.deb` packaging (D8) declaring per-bundle deps incl. python3-pyside6 for Desktop UI
|
||||
|
||||
## Phase 5 — Breadth (later)
|
||||
- [ ] AMD GPU support in M1 (Steam Deck / Radeon)
|
||||
- [ ] Intel GPU best-effort
|
||||
- [ ] M13 auto-update (D18) — launch-time version check + no-root self-update of the
|
||||
user-local install from the public Gitea releases; GUI prompt + `rigdoctor update`
|
||||
- [ ] (Later, separate milestone) Optional auto-apply of suggested fixes behind explicit
|
||||
consent — currently out of scope (D9)
|
||||
- [x] M13 auto-update (D18) — launch-time version check (GUI sidebar) + no-root self-update
|
||||
apply (`rigdoctor update` / sidebar button → authenticated pip upgrade), token-gated.
|
||||
Restart-after-update is manual for now.
|
||||
- [~] Optional auto-apply of suggested fixes behind explicit consent (D9 milestone) — *first
|
||||
cut shipped for M6 (D22):* one-click apply of runtime-reversible tunables (CPU governor,
|
||||
NVIDIA persistence, PCIe ASPM, swappiness, THP) via a single pkexec prompt, no reboot.
|
||||
GRUB-based fixes + CPU mitigations remain suggestion-only.
|
||||
|
||||
## Phase 6 — Session sharing / remote assist (M12, D16)
|
||||
Escalating ladder, built in order:
|
||||
- [ ] Tier 1: `share export` — diagnostic bundle (inventory + recent log + report); B opens
|
||||
it in RigDoctor. One-way, safest.
|
||||
- [ ] Tier 2: live read-only view (local server + user-chosen tunnel: Tailscale/cloudflared/
|
||||
SSH; no hosted relay), token-gated, A approves, revocable.
|
||||
- [ ] Tier 3: gated interactive terminal (wrap tmate/sshx; read-only default, read-write on
|
||||
explicit consent), with session audit log.
|
||||
## Phase 6 — Session sharing / remote assist (M12, D16 → scoped to terminal-only by D23)
|
||||
- [x] **Shared terminal** — a real PTY (host's `$SHELL`) shared over the relay, color-rendered
|
||||
(pyte), full-screen-able; the guest watches and may type only on host consent (D9
|
||||
exception); host reads along + can type (sudo). The single share mode.
|
||||
- [removed] The read-only stats view (`share serve`) and bundle export — dropped per D23; the
|
||||
shared terminal is the only sharing mode.
|
||||
|
||||
> **Out of scope:** stress/repro module (D7); multi-distro support and packaging beyond
|
||||
> Ubuntu/apt + `.deb` (D15) — a thin seam is kept but not built out.
|
||||
|
||||
+17
-14
@@ -43,9 +43,12 @@ RigDoctor's crash-safe logger is designed to fix exactly that.
|
||||
- **Not a stress-test / load-generator** — explicitly out of scope (D7). Users can run
|
||||
existing tools (gpu-burn, vkmark, stress-ng) alongside the logger if they want.
|
||||
- Not an overclocking utility.
|
||||
- **Not (yet) an auto-fixer.** RigDoctor is **read-only**: it diagnoses and *suggests*
|
||||
actions (with the exact command where possible) but does not apply changes itself in this
|
||||
stage. Auto-apply is a deliberate later milestone behind explicit consent. (D9)
|
||||
- **Read-only by default, with a narrow consent-gated exception.** RigDoctor diagnoses and
|
||||
*suggests* actions (with the exact command where possible). It does **not** apply changes
|
||||
itself — **except** a small set of **runtime-reversible** gaming tunables (M6: CPU governor,
|
||||
NVIDIA persistence, PCIe ASPM policy, swappiness, THP) that can be applied from the GUI via a
|
||||
single pkexec prompt, no reboot, revert on reboot (D22, realizing the D9 milestone). Risky/
|
||||
persistent fixes (GRUB cmdline, CPU mitigations) remain suggestion-only.
|
||||
|
||||
## 3. Target users & platforms
|
||||
|
||||
@@ -96,8 +99,10 @@ PCIe topology. Exportable (Markdown/JSON) to paste into forum/bug reports.
|
||||
### M6 — Gaming environment checks
|
||||
Detects & evaluates: GPU power profile / persistence mode, CPU governor, Proton/Wine/Steam
|
||||
versions, GameMode, MangoHud, shader cache, swappiness, hugepages, CPU mitigations,
|
||||
PCIe ASPM. Flags settings that hurt stability/performance and **suggests** the fix command
|
||||
(read-only per D9).
|
||||
PCIe ASPM. Flags settings that hurt stability/performance and **suggests** the fix command.
|
||||
Also includes Steam library/game detection (the D12 "pick a game" foundation) and, per D22,
|
||||
a **one-click apply** for the runtime-reversible tunables (governor, persistence, ASPM,
|
||||
swappiness, THP) plus one-click install of optional tools (GameMode/MangoHud/cpupower).
|
||||
|
||||
### M8 — Alerting
|
||||
Threshold + event alerts (desktop notification / sound / log) on overheat, throttle,
|
||||
@@ -139,15 +144,13 @@ bundles with descriptions and the exact packages each needs → resolve & instal
|
||||
mode. Delivered with the user-local install (and the optional `.deb`) (D8). Module
|
||||
list/bundling is final per D14.
|
||||
|
||||
### M12 — Session sharing / remote assist (D16)
|
||||
Lets a user (A) grant a helper (B) inspection access, as an escalating, consent-driven
|
||||
ladder: (1) **diagnostic bundle export** (inventory + recent capture log + report, one-way);
|
||||
(2) **live read-only view** of the dashboard + logs over a user-chosen tunnel
|
||||
(Tailscale/cloudflared/SSH — no RigDoctor-hosted relay); (3) **gated interactive terminal**
|
||||
wrapping an existing tool (tmate/sshx), read-only by default, read-write only on explicit
|
||||
consent. Per-session consent, ephemeral revocable tokens, permission escalation (view ≠
|
||||
shell), and a session audit log. Tier 3 is a deliberate, consent-gated exception to the
|
||||
read-only stance (D9). Built in Phase 6.
|
||||
### M12 — Session sharing / remote assist (D16, scoped to terminal-only by D23)
|
||||
Lets a user (A) grant a helper (B) a **shared terminal** over the relay: A shares a real PTY
|
||||
running their shell; B watches live and may type **only if A allows it** (otherwise read-only)
|
||||
— a deliberate, consent-gated exception to the read-only stance (D9). A reads along and can
|
||||
type too (e.g. a sudo password, which stays local and is never sent to B). Account-gated by the
|
||||
Gitea token; per-session share code. The shared terminal preserves colors/theming and can be
|
||||
viewed full-screen. *(The earlier read-only stats view / bundle export were dropped — D23.)*
|
||||
|
||||
## 5. Non-functional requirements
|
||||
- **Zero hard deps for the core/CLI/daemon** — Python stdlib + tools already present. **Qt
|
||||
|
||||
Executable
+125
@@ -0,0 +1,125 @@
|
||||
#!/usr/bin/env sh
|
||||
# RigDoctor user-local installer (no root). Creates a private venv, links the
|
||||
# `rigdoctor` / `rigdoctor-gui` commands into ~/.local/bin, and adds a desktop
|
||||
# entry. Installs from a bundled wheel (the .run installer) or from a source
|
||||
# checkout. Re-run to upgrade; `./install.sh --uninstall` to remove.
|
||||
set -eu
|
||||
|
||||
APP_NAME=rigdoctor
|
||||
DATA_HOME="${XDG_DATA_HOME:-$HOME/.local/share}"
|
||||
VENV="$DATA_HOME/$APP_NAME/venv"
|
||||
BIN_DIR="$HOME/.local/bin"
|
||||
DESKTOP_DIR="$DATA_HOME/applications"
|
||||
DESKTOP_FILE="$DESKTOP_DIR/rigdoctor.desktop"
|
||||
SCRIPT_DIR=$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)
|
||||
|
||||
uninstall() {
|
||||
echo "Removing RigDoctor user-local install…"
|
||||
rm -rf "$VENV"
|
||||
rm -f "$BIN_DIR/rigdoctor" "$BIN_DIR/rigdoctor-gui" "$DESKTOP_FILE" \
|
||||
"$DATA_HOME/icons/hicolor/scalable/apps/rigdoctor.svg"
|
||||
echo "Done. (Config and logs under ~/.config/rigdoctor and ~/.local/share/rigdoctor were kept.)"
|
||||
}
|
||||
|
||||
REF=""
|
||||
while [ $# -gt 0 ]; do
|
||||
case "$1" in
|
||||
--uninstall) uninstall; exit 0 ;;
|
||||
--ref) REF="${2:-}"; [ -n "$REF" ] || { echo "--ref needs a tag"; exit 1; }; shift 2 ;;
|
||||
-h|--help) echo "Usage: install.sh [--ref <tag>] [--uninstall]"; exit 0 ;;
|
||||
*) echo "Unknown option: $1"; exit 1 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
PY=python3
|
||||
command -v "$PY" >/dev/null 2>&1 || { echo "python3 not found — install Python 3.11+."; exit 1; }
|
||||
"$PY" - <<'EOF' || { echo "Python 3.11+ is required."; exit 1; }
|
||||
import sys
|
||||
sys.exit(0 if sys.version_info >= (3, 11) else 1)
|
||||
EOF
|
||||
|
||||
# venv support (ensurepip) is required; install python3-venv if it's missing.
|
||||
if ! "$PY" -c "import ensurepip" >/dev/null 2>&1; then
|
||||
PYVER=$("$PY" -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')")
|
||||
PKGS="python3-venv python${PYVER}-venv"
|
||||
echo "Python venv support is missing — needs: $PKGS"
|
||||
if command -v pkexec >/dev/null 2>&1; then ESC=pkexec
|
||||
elif command -v sudo >/dev/null 2>&1; then ESC=sudo
|
||||
else ESC=""; fi
|
||||
if [ -n "$ESC" ] && command -v apt-get >/dev/null 2>&1; then
|
||||
echo "Installing $PKGS (you may be prompted for your password)…"
|
||||
"$ESC" sh -c "apt-get update && apt-get install -y $PKGS" \
|
||||
|| { echo "Failed. Install manually: sudo apt install $PKGS"; exit 1; }
|
||||
else
|
||||
echo "Install it manually, then re-run: sudo apt install $PKGS"
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Where to install from: a specific released tag (--ref), a bundled wheel, or source.
|
||||
WHEEL=$(ls "$SCRIPT_DIR"/rigdoctor-*.whl 2>/dev/null | head -n1 || true)
|
||||
if [ -n "$REF" ]; then
|
||||
CONF="${XDG_CONFIG_HOME:-$HOME/.config}/rigdoctor/token"
|
||||
TOKEN="${RIGDOCTOR_TOKEN:-$(cat "$CONF" 2>/dev/null || true)}"
|
||||
[ -n "$TOKEN" ] || { echo "--ref needs a token (run 'rigdoctor login' or set RIGDOCTOR_TOKEN)."; exit 1; }
|
||||
SRC="rigdoctor[gui] @ git+https://oauth2:$TOKEN@git.jesseyvanofferen.com/jessey/rigdoctor.git@$REF"
|
||||
elif [ -n "$WHEEL" ]; then
|
||||
SRC="$WHEEL[gui]"
|
||||
elif [ -f "$SCRIPT_DIR/pyproject.toml" ]; then
|
||||
SRC="$SCRIPT_DIR[gui]"
|
||||
else
|
||||
echo "No bundled wheel or source found next to the installer."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Creating venv at $VENV…"
|
||||
"$PY" -m venv "$VENV"
|
||||
"$VENV/bin/pip" install --upgrade pip >/dev/null
|
||||
echo "Installing RigDoctor (pulls in PySide6 — this can take a minute)…"
|
||||
"$VENV/bin/pip" install "$SRC"
|
||||
|
||||
mkdir -p "$BIN_DIR"
|
||||
ln -sf "$VENV/bin/rigdoctor" "$BIN_DIR/rigdoctor"
|
||||
ln -sf "$VENV/bin/rigdoctor-gui" "$BIN_DIR/rigdoctor-gui"
|
||||
|
||||
# Install the app icon (for the dock/launcher); fall back to a stock icon.
|
||||
ICON_NAME=utilities-system-monitor
|
||||
ICON_SRC=$("$VENV/bin/python" -c "import os, rigdoctor.gui as g; print(os.path.join(os.path.dirname(g.__file__), 'assets', 'rigdoctor.svg'))" 2>/dev/null || true)
|
||||
if [ -n "$ICON_SRC" ] && [ -f "$ICON_SRC" ]; then
|
||||
ICON_DST="$DATA_HOME/icons/hicolor/scalable/apps/rigdoctor.svg"
|
||||
mkdir -p "$(dirname "$ICON_DST")"
|
||||
cp "$ICON_SRC" "$ICON_DST"
|
||||
ICON_NAME=rigdoctor
|
||||
command -v gtk-update-icon-cache >/dev/null 2>&1 && gtk-update-icon-cache -qtf "$DATA_HOME/icons/hicolor" 2>/dev/null || true
|
||||
fi
|
||||
|
||||
mkdir -p "$DESKTOP_DIR"
|
||||
cat > "$DESKTOP_FILE" <<EOF
|
||||
[Desktop Entry]
|
||||
Type=Application
|
||||
Name=RigDoctor
|
||||
Comment=Hardware monitoring & crash diagnostics for Linux gamers
|
||||
Exec=$VENV/bin/rigdoctor-gui
|
||||
Icon=$ICON_NAME
|
||||
Terminal=false
|
||||
Categories=System;Monitor;Utility;
|
||||
StartupWMClass=rigdoctor
|
||||
EOF
|
||||
command -v update-desktop-database >/dev/null 2>&1 && update-desktop-database "$DESKTOP_DIR" 2>/dev/null || true
|
||||
|
||||
echo
|
||||
echo "RigDoctor $("$VENV/bin/rigdoctor" --version 2>/dev/null | awk '{print $2}') installed."
|
||||
echo " GUI: rigdoctor-gui (or find 'RigDoctor' in your app menu)"
|
||||
echo " CLI: rigdoctor --help"
|
||||
case ":$PATH:" in
|
||||
*":$BIN_DIR:"*) ;;
|
||||
*) echo " Note: add $BIN_DIR to your PATH (a fresh login usually does this).";;
|
||||
esac
|
||||
|
||||
# Launch the graphical setup wizard if a desktop session is available (first run shows it).
|
||||
if [ -n "${DISPLAY:-}${WAYLAND_DISPLAY:-}" ] && [ -x "$VENV/bin/rigdoctor-gui" ]; then
|
||||
echo " Opening the setup wizard…"
|
||||
("$VENV/bin/rigdoctor-gui" --setup >/dev/null 2>&1 &)
|
||||
else
|
||||
echo " Run 'rigdoctor-gui' to finish setup."
|
||||
fi
|
||||
Executable
+25
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env sh
|
||||
# Auto-set the next version from Conventional Commits (git-cliff), per D21.
|
||||
# Run after committing your feat:/fix: changes; it updates __init__.py + pyproject.toml.
|
||||
# Then update CHANGELOG.md, commit as `chore(release): vX.Y.Z`, and push (CI tags + releases).
|
||||
set -eu
|
||||
|
||||
ROOT=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
cd "$ROOT"
|
||||
|
||||
command -v git-cliff >/dev/null 2>&1 || { echo "git-cliff not found. Install: pip install git-cliff"; exit 1; }
|
||||
|
||||
NEXT=$(git-cliff --bumped-version | sed 's/^v//')
|
||||
[ -n "$NEXT" ] || { echo "Could not compute the next version."; exit 1; }
|
||||
|
||||
python3 - "$NEXT" <<'PY'
|
||||
import pathlib, re, sys
|
||||
version = sys.argv[1]
|
||||
init = pathlib.Path("src/rigdoctor/__init__.py")
|
||||
init.write_text(re.sub(r'__version__ = "[^"]+"', f'__version__ = "{version}"', init.read_text()))
|
||||
proj = pathlib.Path("pyproject.toml")
|
||||
proj.write_text(re.sub(r'(?m)^version = "[^"]+"', f'version = "{version}"', proj.read_text(), count=1))
|
||||
PY
|
||||
|
||||
echo "Set version to $NEXT."
|
||||
echo "Next: add a '## [$NEXT]' CHANGELOG section, then commit as 'chore(release): v$NEXT'."
|
||||
Executable
+20
@@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env sh
|
||||
# Regenerate CHANGELOG.md from Conventional Commits using git-cliff (D20).
|
||||
# Install once: pip install git-cliff (ships prebuilt binaries)
|
||||
# Usage: packaging/changelog.sh [--tag vX.Y.Z]
|
||||
set -eu
|
||||
|
||||
ROOT=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
cd "$ROOT"
|
||||
|
||||
command -v git-cliff >/dev/null 2>&1 || {
|
||||
echo "git-cliff not found. Install it: pip install git-cliff"
|
||||
exit 1
|
||||
}
|
||||
|
||||
if [ "${1:-}" = "--tag" ] && [ -n "${2:-}" ]; then
|
||||
git-cliff --tag "$2" -o CHANGELOG.md
|
||||
else
|
||||
git-cliff -o CHANGELOG.md
|
||||
fi
|
||||
echo "Wrote CHANGELOG.md"
|
||||
Executable
+3
@@ -0,0 +1,3 @@
|
||||
#!/usr/bin/env sh
|
||||
# Build the self-extracting .run installer (delegates to make_run.py — no makeself).
|
||||
exec python3 "$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)/make_run.py" "$@"
|
||||
@@ -0,0 +1,62 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Build a dependency-free self-extracting .run installer (no makeself).
|
||||
|
||||
Produces dist/rigdoctor-<version>-installer.run: a POSIX shell stub with an appended
|
||||
tar.gz of the wheel + install.sh. Running it extracts to a temp dir and runs install.sh.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import io
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import tarfile
|
||||
import tomllib
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
MARKER = "__RIGDOCTOR_ARCHIVE__"
|
||||
|
||||
STUB = f"""#!/bin/sh
|
||||
# RigDoctor self-extracting installer. Extracts the embedded archive and runs install.sh.
|
||||
set -eu
|
||||
SKIP=$(awk '/^{MARKER}$/ {{ print NR + 1; exit 0 }}' "$0")
|
||||
TMP=$(mktemp -d)
|
||||
tail -n +"$SKIP" "$0" | tar -xz -C "$TMP"
|
||||
sh "$TMP/install.sh" "$@"
|
||||
RET=$?
|
||||
rm -rf "$TMP"
|
||||
exit $RET
|
||||
{MARKER}
|
||||
"""
|
||||
|
||||
|
||||
def main() -> int:
|
||||
version = tomllib.loads((ROOT / "pyproject.toml").read_text())["project"]["version"]
|
||||
dist = ROOT / "dist"
|
||||
dist.mkdir(exist_ok=True)
|
||||
|
||||
wheel = dist / f"rigdoctor-{version}-py3-none-any.whl"
|
||||
if not wheel.exists():
|
||||
subprocess.run([sys.executable, "-m", "build", "--wheel"], cwd=ROOT, check=True)
|
||||
if not wheel.exists():
|
||||
print(f"wheel not found: {wheel}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
buf = io.BytesIO()
|
||||
with tarfile.open(fileobj=buf, mode="w:gz") as tar:
|
||||
tar.add(wheel, arcname=wheel.name)
|
||||
tar.add(ROOT / "install.sh", arcname="install.sh")
|
||||
|
||||
out = dist / f"rigdoctor-{version}-installer.run"
|
||||
with open(out, "wb") as f:
|
||||
f.write(STUB.encode())
|
||||
f.write(buf.getvalue())
|
||||
os.chmod(out, 0o755)
|
||||
print(f"Built {out}")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
+5
-2
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "rigdoctor"
|
||||
version = "0.0.3"
|
||||
version = "0.26.1"
|
||||
description = "Modular hardware monitoring & crash diagnostics for Linux gamers."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.11"
|
||||
@@ -13,7 +13,7 @@ requires-python = ">=3.11"
|
||||
dependencies = []
|
||||
|
||||
[project.optional-dependencies]
|
||||
gui = ["PySide6"]
|
||||
gui = ["PySide6", "pyte"]
|
||||
|
||||
[project.scripts]
|
||||
rigdoctor = "rigdoctor.cli:main"
|
||||
@@ -21,3 +21,6 @@ rigdoctor-gui = "rigdoctor.gui.app:main"
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
rigdoctor = ["gui/assets/*.svg"]
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""RigDoctor — modular hardware monitoring & crash diagnostics for Linux gamers."""
|
||||
|
||||
__version__ = "0.0.3"
|
||||
__version__ = "0.26.1"
|
||||
|
||||
+449
-14
@@ -44,17 +44,10 @@ def cmd_snapshot(args) -> int:
|
||||
|
||||
|
||||
def cmd_monitor(args) -> int:
|
||||
from .tui import run
|
||||
|
||||
interval = args.interval or load_config()["interval"]
|
||||
try:
|
||||
for sample in _sampler().stream(interval=interval):
|
||||
# Basic full-screen redraw; the rich TUI (M2) comes later.
|
||||
print("\033[2J\033[H", end="")
|
||||
print(f"RigDoctor — live (every {interval:g}s, Ctrl-C to quit)\n")
|
||||
print(render_snapshot(sample))
|
||||
sys.stdout.flush()
|
||||
except KeyboardInterrupt:
|
||||
print()
|
||||
return 0
|
||||
return run(interval, plain=getattr(args, "plain", False))
|
||||
|
||||
|
||||
def cmd_gui(args) -> int:
|
||||
@@ -86,6 +79,7 @@ def cmd_record_run(args) -> int:
|
||||
max_bytes=cfg["log_max_bytes"],
|
||||
backups=cfg["log_backups"],
|
||||
status_path=config.STATUS_FILE,
|
||||
game=getattr(args, "game", None),
|
||||
)
|
||||
|
||||
def _handle(_sig, _frame):
|
||||
@@ -164,9 +158,372 @@ def cmd_record_report(args) -> int:
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_install(args) -> int:
|
||||
from .core import installer, sysenv
|
||||
|
||||
print(f"Distro: {sysenv.distro_name()}")
|
||||
pm = sysenv.package_manager()
|
||||
print(f"Package manager: {pm or 'none (only apt is supported)'}")
|
||||
print(f"GPU: {', '.join(sysenv.gpu_vendors()) or 'unknown'}\n")
|
||||
|
||||
status = installer.component_status()
|
||||
print("Optional components:")
|
||||
for component, present in status:
|
||||
mark = "✓" if present else "✗"
|
||||
print(f" [{mark}] {component.name:<22} — {component.enables}")
|
||||
if not present:
|
||||
print(f" apt: {' '.join(component.apt)}")
|
||||
|
||||
missing = [c for c, present in status if not present]
|
||||
if not missing:
|
||||
print("\nAll optional components are installed. ✔")
|
||||
return 0
|
||||
|
||||
packages = installer.missing_packages(missing)
|
||||
print(f"\nMissing packages: {' '.join(packages)}")
|
||||
if args.check:
|
||||
return 0
|
||||
if pm != "apt":
|
||||
print(f"Automatic install needs apt. Install manually:\n sudo apt install {' '.join(packages)}")
|
||||
return 1
|
||||
if not args.yes:
|
||||
try:
|
||||
reply = input(f"\nInstall {len(packages)} package(s) now? [y/N] ").strip().lower()
|
||||
except EOFError:
|
||||
reply = "n"
|
||||
if reply not in ("y", "yes"):
|
||||
print("Aborted.")
|
||||
return 1
|
||||
|
||||
print("Installing (you may be prompted for your password)…")
|
||||
rc, out = installer.install_packages(packages)
|
||||
print(out[-2000:])
|
||||
if rc == 0:
|
||||
still = [c.name for c, present in installer.component_status() if not present]
|
||||
print("\nStill missing: " + (", ".join(still) if still else "none ✔"))
|
||||
else:
|
||||
print(f"\nInstall failed (exit {rc}).")
|
||||
return rc
|
||||
|
||||
|
||||
def cmd_login(args) -> int:
|
||||
from getpass import getpass
|
||||
|
||||
from .core import updates
|
||||
|
||||
token = args.token
|
||||
if not token:
|
||||
print(f"Create a token (scope read:repository) at: {updates.TOKEN_PAGE}")
|
||||
try:
|
||||
token = getpass("Paste token: ").strip()
|
||||
except (EOFError, KeyboardInterrupt):
|
||||
token = ""
|
||||
if not token:
|
||||
print("No token provided.")
|
||||
return 1
|
||||
config.save_token(token)
|
||||
state, tag, _notes = updates.update_state()
|
||||
if state == updates.AUTH:
|
||||
print("Token saved, but the server rejected it (check scope/permissions).")
|
||||
return 1
|
||||
if state in (updates.UP_TO_DATE, updates.AVAILABLE):
|
||||
print(f"Token saved and verified. Latest release: {tag}.")
|
||||
return 0
|
||||
print("Token saved (couldn't reach the server to verify right now).")
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_logout(args) -> int:
|
||||
config.clear_token()
|
||||
print("Update token removed.")
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_update(args) -> int:
|
||||
from .core import updates
|
||||
|
||||
state, tag, notes = updates.update_state()
|
||||
if state == updates.NO_TOKEN:
|
||||
print("No update token. Run `rigdoctor login` after creating one at:")
|
||||
print(f" {updates.TOKEN_PAGE}")
|
||||
return 1
|
||||
if state == updates.AUTH:
|
||||
print("The update server rejected your token (check scope/permissions).")
|
||||
return 1
|
||||
if state == updates.NETWORK:
|
||||
print("Couldn't reach the update server.")
|
||||
return 1
|
||||
if state == updates.UP_TO_DATE:
|
||||
print(f"Up to date (v{__version__}).")
|
||||
return 0
|
||||
# AVAILABLE
|
||||
print(f"Update available: {tag} (current v{__version__}).")
|
||||
if notes:
|
||||
print("\nWhat's new:\n" + "\n".join(" " + ln for ln in notes.splitlines()) + "\n")
|
||||
if args.check:
|
||||
return 0
|
||||
print(f"Installing {tag}…")
|
||||
rc, out = updates.apply_update(tag)
|
||||
print(out[-2000:])
|
||||
if rc == 0:
|
||||
print(f"\nUpdated to {tag}. Restart RigDoctor to use the new version.")
|
||||
return 0
|
||||
print(f"\nUpdate failed (exit {rc}).")
|
||||
return rc
|
||||
|
||||
|
||||
def cmd_uninstall(args) -> int:
|
||||
from .core import uninstall as uninstaller
|
||||
|
||||
scope = "everything (app + settings, token, and logs)" if args.purge else "the app (settings/logs kept)"
|
||||
if not args.yes:
|
||||
try:
|
||||
reply = input(f"Uninstall RigDoctor — remove {scope}? [y/N] ").strip().lower()
|
||||
except EOFError:
|
||||
reply = "n"
|
||||
if reply not in ("y", "yes"):
|
||||
print("Aborted.")
|
||||
return 1
|
||||
uninstaller.uninstall(purge=args.purge)
|
||||
print("Uninstalling… RigDoctor will be removed momentarily.")
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_collect_priv(args) -> int:
|
||||
"""Internal: emit root-only data (SMART + dmidecode) as JSON, run via pkexec at launch."""
|
||||
from dataclasses import asdict
|
||||
|
||||
from .core.health import check_smart
|
||||
from .core.inventory import _dmidecode
|
||||
|
||||
data = {"smart": [asdict(f) for f in check_smart()], "dmidecode": _dmidecode()}
|
||||
print(json.dumps(data))
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_inventory(args) -> int:
|
||||
from .core import inventory
|
||||
|
||||
sections = inventory.collect()
|
||||
if args.json:
|
||||
text = inventory.render_json(sections)
|
||||
elif args.markdown:
|
||||
text = inventory.render_markdown(sections)
|
||||
else:
|
||||
text = inventory.render_text(sections)
|
||||
if args.output:
|
||||
Path(args.output).write_text(text)
|
||||
print(f"Wrote {args.output}")
|
||||
else:
|
||||
print(text)
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_report(args) -> int:
|
||||
print("`report` (M4 health report) is not implemented yet — next on the roadmap.")
|
||||
return 2
|
||||
from dataclasses import asdict
|
||||
|
||||
from .core.health import run_health_checks
|
||||
from .render import render_health
|
||||
|
||||
findings = run_health_checks()
|
||||
if args.json:
|
||||
print(json.dumps([asdict(f) for f in findings], indent=2, ensure_ascii=False))
|
||||
else:
|
||||
print(render_health(findings))
|
||||
return 0
|
||||
|
||||
|
||||
def _resolve_game(args) -> str | None:
|
||||
"""Game name from --game, or looked up from --appid via the Steam scan."""
|
||||
if getattr(args, "game", None):
|
||||
return args.game
|
||||
if getattr(args, "appid", None):
|
||||
from .core import steam
|
||||
|
||||
for g in steam.scan_games(steam.selected_library_paths()):
|
||||
if g.appid == str(args.appid):
|
||||
return g.name
|
||||
return None
|
||||
return None
|
||||
|
||||
|
||||
def cmd_diagnose(args) -> int:
|
||||
from .core import diagnostic, reccontrol, steam
|
||||
|
||||
sub = args.diagnose_cmd or "status"
|
||||
|
||||
if sub == "start":
|
||||
if reccontrol.running_pid():
|
||||
print("A capture is already running — finish it with: rigdoctor diagnose finish")
|
||||
return 1
|
||||
game = _resolve_game(args)
|
||||
if game is None and (args.game or args.appid):
|
||||
print("Couldn't match that game in your selected Steam libraries.")
|
||||
return 1
|
||||
if game is None:
|
||||
games = steam.cached_games() or steam.scan_games(steam.selected_library_paths())
|
||||
if games:
|
||||
print("Pick a game to focus on, then re-run with --game:")
|
||||
for g in games:
|
||||
print(f" --game {g.name!r}")
|
||||
else:
|
||||
print("No games detected. Select a library: rigdoctor games libraries --all")
|
||||
return 1
|
||||
pid = diagnostic.start(game=game, interval=args.interval)
|
||||
time.sleep(1.0)
|
||||
if pid and reccontrol.pid_alive(pid):
|
||||
print(f"Diagnostic capture started for {game!r} (pid {pid}).")
|
||||
print(" Play your game. When you're done (or after a crash + reboot):")
|
||||
print(" rigdoctor diagnose finish")
|
||||
return 0
|
||||
print(f"Capture failed to start; see {config.SPAWN_LOG}")
|
||||
return 1
|
||||
|
||||
if sub == "status":
|
||||
status = diagnostic.active()
|
||||
if not status:
|
||||
print("No diagnostic capture is running.")
|
||||
return 0
|
||||
game = status.get("game") or "—"
|
||||
print(f"Capturing for {game!r}: {status.get('samples', 0)} samples"
|
||||
+ (" · GPU-lost seen" if status.get("gpu_lost") else ""))
|
||||
return 0
|
||||
|
||||
# finish
|
||||
if not reccontrol.running_pid() and not config.DIAG_LOG.exists():
|
||||
print("No diagnostic to analyze. Start one with: rigdoctor diagnose start --game <name>")
|
||||
return 1
|
||||
print("Stopping capture and analyzing…\n")
|
||||
result = diagnostic.finish(last_n=args.last)
|
||||
from .render import render_health, render_summary
|
||||
|
||||
if result.game:
|
||||
print(f"Diagnostic — {result.game}\n")
|
||||
print(render_summary(result.summary, log_path=config.DIAG_LOG))
|
||||
print("\n" + render_health(result.findings, title="Findings"))
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_wrap(args) -> int:
|
||||
from .core import wrap
|
||||
|
||||
return wrap.run(args.command)
|
||||
|
||||
|
||||
def cmd_watch(args) -> int:
|
||||
from .core import watcher
|
||||
|
||||
interval = args.interval or load_config().get("interval", 1.0)
|
||||
print("Watching for a running Steam game (Ctrl-C to stop)…")
|
||||
return watcher.watch(interval=max(2.0, interval))
|
||||
|
||||
|
||||
def cmd_service(args) -> int:
|
||||
from .core import service
|
||||
|
||||
sub = args.service_cmd or "status"
|
||||
if sub == "mode":
|
||||
ok, msg = service.apply_mode(args.mode)
|
||||
print(f"Trigger mode set to '{args.mode}'.")
|
||||
if not ok and msg:
|
||||
print(f" note: {msg}")
|
||||
return 0 if ok or not service.available() else 1
|
||||
|
||||
info = service.status()
|
||||
print(f"Trigger mode: {info['mode']}")
|
||||
print(f"systemd --user: {'available' if info['available'] else 'not available'}")
|
||||
if info["available"]:
|
||||
print(f" recorder service: {'active' if info.get('recorder_active') else 'inactive'}")
|
||||
print(f" watcher service: {'active' if info.get('watch_active') else 'inactive'}")
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_gameenv(args) -> int:
|
||||
from dataclasses import asdict
|
||||
|
||||
from .core.gameenv import run_gameenv_checks
|
||||
from .render import render_health
|
||||
|
||||
findings = run_gameenv_checks()
|
||||
if args.json:
|
||||
print(json.dumps([asdict(f) for f in findings], indent=2, ensure_ascii=False))
|
||||
else:
|
||||
print(render_health(findings, title="Gaming environment"))
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_games(args) -> int:
|
||||
from dataclasses import asdict
|
||||
|
||||
from .core import launchers, steam
|
||||
|
||||
selected = steam.selected_library_paths()
|
||||
result = steam.rescan() if selected else None
|
||||
steam_games = result.games if result else []
|
||||
extra = launchers.scan() # non-Steam (Lutris/Heroic)
|
||||
all_games = list(steam_games) + list(extra)
|
||||
|
||||
if args.json:
|
||||
print(json.dumps({
|
||||
"scanned_at": result.scanned_at if result else None,
|
||||
"new_appids": result.new_appids if result else [],
|
||||
"games": [asdict(g) for g in all_games],
|
||||
}, indent=2, ensure_ascii=False))
|
||||
return 0
|
||||
|
||||
if not all_games:
|
||||
if not selected:
|
||||
print("No Steam libraries selected and no non-Steam games found.")
|
||||
print(" Pick a Steam library: rigdoctor games libraries --enable <path> (or --all)")
|
||||
return 1
|
||||
print("No games found.")
|
||||
return 0
|
||||
|
||||
new = set(result.new_appids) if result else set()
|
||||
print(f"{len(all_games)} game(s):\n")
|
||||
for g in all_games:
|
||||
tag = " NEW" if g.appid in new else ""
|
||||
src = "" if g.launcher == "steam" else f" [{g.launcher}]"
|
||||
size = steam.human_size(g.size_bytes) if g.size_bytes else ""
|
||||
print(f" {g.name:<46}{src:<10} {size:>9}{tag}")
|
||||
if not selected:
|
||||
print("\n(no Steam libraries selected — `rigdoctor games libraries --all` to add them)")
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_games_libraries(args) -> int:
|
||||
from .core import steam
|
||||
|
||||
discovered = steam.discover_libraries()
|
||||
selected = {os.path.realpath(p) for p in steam.selected_library_paths()}
|
||||
|
||||
# --all / --enable / --disable adjust the selection, then we list the result.
|
||||
if args.all or args.enable or args.disable:
|
||||
if args.all:
|
||||
selected = {lib.path for lib in discovered}
|
||||
for raw in args.enable or []:
|
||||
selected.add(os.path.realpath(os.path.expanduser(raw)))
|
||||
for raw in args.disable or []:
|
||||
selected.discard(os.path.realpath(os.path.expanduser(raw)))
|
||||
config.update_config(steam_libraries=sorted(selected))
|
||||
|
||||
if not discovered:
|
||||
print("No Steam libraries detected (is Steam installed?).")
|
||||
return 1
|
||||
if args.json:
|
||||
print(json.dumps([
|
||||
{"path": lib.path, "label": lib.label, "selected": lib.path in selected,
|
||||
"games": len(steam.scan_library(lib.path))}
|
||||
for lib in discovered
|
||||
], indent=2, ensure_ascii=False))
|
||||
return 0
|
||||
print("Steam libraries (checked = scanned for games):\n")
|
||||
for lib in discovered:
|
||||
mark = "x" if lib.path in selected else " "
|
||||
count = len(steam.scan_library(lib.path))
|
||||
label = f" [{lib.label}]" if lib.label else ""
|
||||
print(f" [{mark}] {lib.path}{label} ({count} games)")
|
||||
return 0
|
||||
|
||||
|
||||
def build_parser() -> argparse.ArgumentParser:
|
||||
@@ -181,19 +538,40 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
sp.add_argument("--json", action="store_true", help="output JSON instead of text")
|
||||
sp.set_defaults(func=cmd_snapshot)
|
||||
|
||||
mp = sub.add_parser("monitor", help="live-refreshing sensor view")
|
||||
mp = sub.add_parser("monitor", help="live monitor TUI (current/min/max, M2)")
|
||||
mp.add_argument("-n", "--interval", type=float, default=None, help="refresh interval (s)")
|
||||
mp.add_argument("--plain", action="store_true", help="plain redraw instead of the curses UI")
|
||||
mp.set_defaults(func=cmd_monitor)
|
||||
|
||||
sub.add_parser("gui", help="launch the desktop GUI (needs PySide6)").set_defaults(func=cmd_gui)
|
||||
sub.add_parser("sources", help="list detected sensor sources").set_defaults(func=cmd_sources)
|
||||
|
||||
inst = sub.add_parser("install", help="set up optional system dependencies (M9)")
|
||||
inst.add_argument("--check", action="store_true", help="report status only; install nothing")
|
||||
inst.add_argument("-y", "--yes", action="store_true", help="install without confirmation")
|
||||
inst.set_defaults(func=cmd_install)
|
||||
|
||||
login = sub.add_parser("login", help="save a Gitea token for updates (M13)")
|
||||
login.add_argument("--token", default=None, help="token (prompted if omitted)")
|
||||
login.set_defaults(func=cmd_login)
|
||||
sub.add_parser("logout", help="remove the saved update token").set_defaults(func=cmd_logout)
|
||||
|
||||
upd = sub.add_parser("update", help="check for / apply a newer version (M13)")
|
||||
upd.add_argument("--check", action="store_true", help="only report, don't apply")
|
||||
upd.set_defaults(func=cmd_update)
|
||||
|
||||
unin = sub.add_parser("uninstall", help="remove the user-local install")
|
||||
unin.add_argument("--purge", action="store_true", help="also remove settings, token, and logs")
|
||||
unin.add_argument("-y", "--yes", action="store_true", help="don't ask for confirmation")
|
||||
unin.set_defaults(func=cmd_uninstall)
|
||||
|
||||
rec = sub.add_parser("record", help="crash-capture logger (M3)")
|
||||
rec_sub = rec.add_subparsers(dest="record_cmd", required=True)
|
||||
|
||||
run_p = rec_sub.add_parser("run", help="run the capture loop in the foreground (systemd-friendly)")
|
||||
run_p.add_argument("-n", "--interval", type=float, default=None, help="sampling interval (s)")
|
||||
run_p.add_argument("-o", "--out", default=None, help="log file path")
|
||||
run_p.add_argument("--game", default=None, help="tag the capture with a game name (M6/diagnose)")
|
||||
run_p.set_defaults(func=cmd_record_run)
|
||||
|
||||
start_p = rec_sub.add_parser("start", help="start recording in the background")
|
||||
@@ -209,7 +587,64 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
report_p.add_argument("--log", default=None, help="path to a capture log")
|
||||
report_p.set_defaults(func=cmd_record_report)
|
||||
|
||||
sub.add_parser("report", help="health report (coming soon)").set_defaults(func=cmd_report)
|
||||
rep = sub.add_parser("report", help="health report (M4): scan logs/SMART/driver for issues")
|
||||
rep.add_argument("--json", action="store_true", help="output JSON instead of text")
|
||||
rep.set_defaults(func=cmd_report)
|
||||
|
||||
cp = sub.add_parser("collect-priv", help=argparse.SUPPRESS) # internal: run via pkexec
|
||||
cp.set_defaults(func=cmd_collect_priv)
|
||||
|
||||
inv = sub.add_parser("inventory", help="system inventory (M5): export hardware/OS details")
|
||||
inv.add_argument("--json", action="store_true", help="output JSON")
|
||||
inv.add_argument("--markdown", action="store_true", help="output Markdown (for forum/bug reports)")
|
||||
inv.add_argument("-o", "--output", default=None, help="write to a file instead of stdout")
|
||||
inv.set_defaults(func=cmd_inventory)
|
||||
|
||||
games_p = sub.add_parser("games", help="Steam game & library detection (M6)")
|
||||
games_p.add_argument("--json", action="store_true", help="output JSON")
|
||||
games_p.set_defaults(func=cmd_games)
|
||||
games_sub = games_p.add_subparsers(dest="games_cmd")
|
||||
lib_p = games_sub.add_parser("libraries", help="list/select Steam libraries to scan")
|
||||
lib_p.add_argument("--enable", action="append", metavar="PATH", help="scan this library (repeatable)")
|
||||
lib_p.add_argument("--disable", action="append", metavar="PATH", help="stop scanning this library (repeatable)")
|
||||
lib_p.add_argument("--all", action="store_true", help="scan all detected libraries")
|
||||
lib_p.add_argument("--json", action="store_true", help="output JSON")
|
||||
lib_p.set_defaults(func=cmd_games_libraries)
|
||||
|
||||
env_p = sub.add_parser("gameenv", help="gaming environment checks (M6): flag stability/perf settings")
|
||||
env_p.add_argument("--json", action="store_true", help="output JSON instead of text")
|
||||
env_p.set_defaults(func=cmd_gameenv)
|
||||
|
||||
diag_p = sub.add_parser("diagnose", help="guided diagnostic: capture while gaming, then analyze")
|
||||
diag_sub = diag_p.add_subparsers(dest="diagnose_cmd")
|
||||
diag_start = diag_sub.add_parser("start", help="start a focused capture for a game")
|
||||
diag_start.add_argument("--game", default=None, help="game name to focus on")
|
||||
diag_start.add_argument("--appid", default=None, help="Steam appid to focus on (resolved to a name)")
|
||||
diag_start.add_argument("-n", "--interval", type=float, default=None, help="sampling interval (s)")
|
||||
diag_start.set_defaults(func=cmd_diagnose)
|
||||
diag_sub.add_parser("status", help="show the in-progress diagnostic").set_defaults(func=cmd_diagnose)
|
||||
diag_finish = diag_sub.add_parser("finish", help="stop the capture and analyze it")
|
||||
diag_finish.add_argument("--last", type=int, default=10, help="recent samples to show")
|
||||
diag_finish.set_defaults(func=cmd_diagnose)
|
||||
diag_p.set_defaults(func=cmd_diagnose, diagnose_cmd=None, last=10)
|
||||
|
||||
wrap_p = sub.add_parser(
|
||||
"wrap", help="run a game with automatic crash-capture (Steam launch option, D12)")
|
||||
wrap_p.add_argument("command", nargs=argparse.REMAINDER,
|
||||
help="the game command — use `rigdoctor wrap %%command%%` in Steam")
|
||||
wrap_p.set_defaults(func=cmd_wrap)
|
||||
|
||||
watch_p = sub.add_parser("watch", help="auto-capture while a Steam game runs (game-launch trigger)")
|
||||
watch_p.add_argument("-n", "--interval", type=float, default=None, help="poll interval (s)")
|
||||
watch_p.set_defaults(func=cmd_watch)
|
||||
|
||||
svc_p = sub.add_parser("service", help="crash-logger trigger mode + systemd --user service (M9/D6)")
|
||||
svc_sub = svc_p.add_subparsers(dest="service_cmd")
|
||||
svc_sub.add_parser("status", help="show the trigger mode and service state").set_defaults(func=cmd_service)
|
||||
mode_p = svc_sub.add_parser("mode", help="set the trigger mode")
|
||||
mode_p.add_argument("mode", choices=("manual", "always-on", "game-launch"))
|
||||
mode_p.set_defaults(func=cmd_service)
|
||||
svc_p.set_defaults(func=cmd_service, service_cmd=None)
|
||||
return p
|
||||
|
||||
|
||||
|
||||
@@ -3,6 +3,8 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
|
||||
APP = "rigdoctor"
|
||||
@@ -21,14 +23,139 @@ CONFIG_FILE = CONFIG_DIR / "config.toml"
|
||||
|
||||
# Crash-capture logger (M3)
|
||||
LOG_FILE = LOG_DIR / "capture.jsonl"
|
||||
# Guided diagnostic (M6/D12): a focused capture writes here, separate from the always-on
|
||||
# crash log, so its report covers only that session's window.
|
||||
DIAG_LOG = LOG_DIR / "diagnostic.jsonl"
|
||||
# A crashed (unterminated, unacknowledged) diagnostic is preserved here when a new capture
|
||||
# starts, so auto-capture (the Steam wrapper) relaunching the game doesn't wipe it first.
|
||||
DIAG_CRASH = LOG_DIR / "diagnostic-crash.jsonl"
|
||||
STATUS_FILE = STATE_DIR / "recorder.json"
|
||||
PID_FILE = STATE_DIR / "recorder.pid"
|
||||
SPAWN_LOG = STATE_DIR / "recorder.out"
|
||||
|
||||
# Gaming environment / game detection (M6) — cached Steam game scan (mutable state,
|
||||
# not config: refreshed by the background scan on every launch).
|
||||
GAMES_FILE = STATE_DIR / "games.json"
|
||||
|
||||
# Update access token (M13) — gates updates to Gitea account holders (D18).
|
||||
# Stored in the OS keyring (Secret Service / GNOME Keyring) via `secret-tool` when
|
||||
# available — encrypted at rest, unlocked with the login session — else a 0600 file.
|
||||
TOKEN_FILE = CONFIG_DIR / "token"
|
||||
_SECRET_ATTRS = ["application", "rigdoctor", "type", "update-token"]
|
||||
|
||||
|
||||
def _secret_tool() -> str | None:
|
||||
return shutil.which("secret-tool")
|
||||
|
||||
|
||||
def keyring_available() -> bool:
|
||||
"""True if an encrypted OS keyring (secret-tool) is usable."""
|
||||
return _secret_tool() is not None
|
||||
|
||||
|
||||
def _keyring_store(token: str) -> bool:
|
||||
tool = _secret_tool()
|
||||
if not tool:
|
||||
return False
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
[tool, "store", "--label", "RigDoctor update token", *_SECRET_ATTRS],
|
||||
input=token, text=True, capture_output=True, timeout=20,
|
||||
)
|
||||
return proc.returncode == 0
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return False
|
||||
|
||||
|
||||
def _keyring_lookup() -> str | None:
|
||||
tool = _secret_tool()
|
||||
if not tool:
|
||||
return None
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
[tool, "lookup", *_SECRET_ATTRS], text=True, capture_output=True, timeout=20
|
||||
)
|
||||
if proc.returncode == 0 and proc.stdout.strip():
|
||||
return proc.stdout.strip()
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
pass
|
||||
return None
|
||||
|
||||
|
||||
def _keyring_clear() -> None:
|
||||
tool = _secret_tool()
|
||||
if not tool:
|
||||
return
|
||||
try:
|
||||
subprocess.run([tool, "clear", *_SECRET_ATTRS], capture_output=True, timeout=20)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
pass
|
||||
|
||||
|
||||
def load_token() -> str | None:
|
||||
"""Token from $RIGDOCTOR_TOKEN, then the OS keyring, then a 0600 file."""
|
||||
env = os.environ.get("RIGDOCTOR_TOKEN")
|
||||
if env and env.strip():
|
||||
return env.strip()
|
||||
from_keyring = _keyring_lookup()
|
||||
if from_keyring:
|
||||
return from_keyring
|
||||
try:
|
||||
token = TOKEN_FILE.read_text().strip()
|
||||
return token or None
|
||||
except OSError:
|
||||
return None
|
||||
|
||||
|
||||
def save_token(token: str) -> None:
|
||||
"""Save to the OS keyring if possible (encrypted); else a 0600 file."""
|
||||
token = token.strip()
|
||||
if _keyring_store(token):
|
||||
try: # don't leave a plaintext copy once it's in the keyring
|
||||
TOKEN_FILE.unlink()
|
||||
except OSError:
|
||||
pass
|
||||
return
|
||||
CONFIG_DIR.mkdir(parents=True, exist_ok=True)
|
||||
TOKEN_FILE.write_text(token + "\n")
|
||||
try:
|
||||
TOKEN_FILE.chmod(0o600)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def clear_token() -> None:
|
||||
_keyring_clear()
|
||||
try:
|
||||
TOKEN_FILE.unlink()
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def token_backend() -> str:
|
||||
"""Where the active token lives: 'env' | 'keyring' | 'file' | 'none'."""
|
||||
env = os.environ.get("RIGDOCTOR_TOKEN")
|
||||
if env and env.strip():
|
||||
return "env"
|
||||
if _keyring_lookup() is not None:
|
||||
return "keyring"
|
||||
if TOKEN_FILE.exists():
|
||||
return "file"
|
||||
return "none"
|
||||
|
||||
DEFAULTS: dict = {
|
||||
"interval": 1.0, # sampling interval in seconds (default ≤1 Hz — NFR)
|
||||
"log_max_bytes": 20_000_000, # rotate a log segment past this size
|
||||
"log_backups": 10, # keep this many rotated segments (bounds disk use)
|
||||
"update_check_minutes": 30, # re-check for updates this often while running (0 = off)
|
||||
"elevate_on_launch": True, # GUI asks for the password once at launch (SMART/dmidecode)
|
||||
"alerts_enabled": True, # desktop notifications on overheat / GPU-lost / new version
|
||||
"gpu_temp_alert": 90.0, # °C — alert when GPU reaches this
|
||||
"cpu_temp_alert": 95.0, # °C — alert when CPU reaches this
|
||||
"relay_url": "wss://rigdoctor.jesseyvanofferen.com", # session-sharing relay (M12)
|
||||
"steam_libraries": [], # Steam library paths to scan for games (M6); empty = none picked yet
|
||||
"trigger_mode": "manual", # crash-logger trigger (D6): manual | always-on | game-launch
|
||||
"setup_done": False, # first-run GUI setup wizard completed (M9)
|
||||
}
|
||||
|
||||
|
||||
@@ -44,3 +171,29 @@ def load_config() -> dict:
|
||||
except Exception:
|
||||
pass
|
||||
return cfg
|
||||
|
||||
|
||||
def _toml_value(value) -> str:
|
||||
if isinstance(value, bool):
|
||||
return "true" if value else "false"
|
||||
if isinstance(value, (int, float)):
|
||||
return repr(value)
|
||||
if isinstance(value, (list, tuple)):
|
||||
return "[" + ", ".join(_toml_value(v) for v in value) + "]"
|
||||
return '"' + str(value).replace("\\", "\\\\").replace('"', '\\"') + '"'
|
||||
|
||||
|
||||
def save_config(values: dict) -> None:
|
||||
"""Write a flat config.toml (stdlib has no TOML writer)."""
|
||||
CONFIG_DIR.mkdir(parents=True, exist_ok=True)
|
||||
lines = ["# RigDoctor config — edit in the app (Notifications) or here."]
|
||||
lines += [f"{key} = {_toml_value(value)}" for key, value in values.items()]
|
||||
CONFIG_FILE.write_text("\n".join(lines) + "\n")
|
||||
|
||||
|
||||
def update_config(**changes) -> dict:
|
||||
"""Merge changes into the current effective config and persist them."""
|
||||
cfg = load_config()
|
||||
cfg.update(changes)
|
||||
save_config(cfg)
|
||||
return cfg
|
||||
|
||||
@@ -0,0 +1,109 @@
|
||||
"""Desktop alerts (M8): notify on overheat / GPU-lost / new version via notify-send.
|
||||
|
||||
Edge-triggered: an alert fires when a condition becomes true (not every sample), and
|
||||
can fire again only after it has cleared and a cooldown has passed — so a hot GPU or a
|
||||
1-Hz sample loop doesn't spam notifications. Degrades to a no-op if notify-send is absent.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
import subprocess
|
||||
import time
|
||||
from pathlib import Path
|
||||
|
||||
from ..config import DATA_DIR
|
||||
from .sample import Sample
|
||||
|
||||
APP_NAME = "RigDoctor"
|
||||
_STOCK_ICON = "utilities-system-monitor"
|
||||
# The RigDoctor icon, so notifications match the app/dock icon. Prefer the copy that
|
||||
# desktop integration installs into the icon theme (~/.local/share/icons/...); fall back to
|
||||
# the bundled asset for source/dev runs, then to a stock icon if neither is present.
|
||||
_INSTALLED_ICON = DATA_DIR.parent / "icons" / "hicolor" / "scalable" / "apps" / "rigdoctor.svg"
|
||||
_BUNDLED_ICON = Path(__file__).parents[1] / "gui" / "assets" / "rigdoctor.svg"
|
||||
|
||||
|
||||
def available() -> bool:
|
||||
return shutil.which("notify-send") is not None
|
||||
|
||||
|
||||
def _icon() -> str:
|
||||
"""Resolve the notification icon at call time (the themed copy may be installed late)."""
|
||||
for path in (_INSTALLED_ICON, _BUNDLED_ICON):
|
||||
try:
|
||||
if path.exists():
|
||||
return str(path)
|
||||
except OSError:
|
||||
pass
|
||||
return _STOCK_ICON
|
||||
|
||||
|
||||
def notify(title: str, message: str, urgency: str = "normal") -> bool:
|
||||
"""Send a desktop notification (best-effort). urgency: low|normal|critical."""
|
||||
if not available():
|
||||
return False
|
||||
try:
|
||||
subprocess.run(
|
||||
["notify-send", "-a", APP_NAME, "-u", urgency, "-i", _icon(), title, message],
|
||||
timeout=10,
|
||||
check=False,
|
||||
)
|
||||
return True
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return False
|
||||
|
||||
|
||||
class AlertMonitor:
|
||||
"""Evaluate samples and raise edge-triggered desktop alerts."""
|
||||
|
||||
def __init__(self, gpu_temp: float = 90.0, cpu_temp: float = 95.0, cooldown: float = 300.0):
|
||||
self.gpu_temp = gpu_temp
|
||||
self.cpu_temp = cpu_temp
|
||||
self.cooldown = cooldown
|
||||
self.enabled = True
|
||||
self._active: dict[str, bool] = {}
|
||||
self._last: dict[str, float] = {}
|
||||
|
||||
def _fire(self, key: str, title: str, message: str, urgency: str = "critical") -> None:
|
||||
if self._active.get(key):
|
||||
return # already alerting; wait until it clears
|
||||
now = time.time()
|
||||
if now - self._last.get(key, 0.0) < self.cooldown:
|
||||
return
|
||||
self._active[key] = True
|
||||
self._last[key] = now
|
||||
notify(title, message, urgency)
|
||||
|
||||
def _clear(self, key: str) -> None:
|
||||
self._active[key] = False
|
||||
|
||||
def check(self, sample: Sample) -> None:
|
||||
if not self.enabled:
|
||||
return
|
||||
gpu_t = next(
|
||||
(r.value for r in sample.readings
|
||||
if r.source == "gpu" and r.metric == "temp" and r.label == "" and r.value is not None),
|
||||
None,
|
||||
)
|
||||
if gpu_t is not None:
|
||||
if gpu_t >= self.gpu_temp:
|
||||
self._fire("gpu_temp", "GPU overheating", f"GPU at {gpu_t:.0f} °C")
|
||||
else:
|
||||
self._clear("gpu_temp")
|
||||
|
||||
cpu_temps = [r.value for r in sample.readings
|
||||
if r.source == "cpu" and r.metric == "temp" and r.value is not None]
|
||||
if cpu_temps:
|
||||
cpu_t = max(cpu_temps)
|
||||
if cpu_t >= self.cpu_temp:
|
||||
self._fire("cpu_temp", "CPU overheating", f"CPU at {cpu_t:.0f} °C")
|
||||
else:
|
||||
self._clear("cpu_temp")
|
||||
|
||||
lost = any(r.source == "gpu" and r.metric == "status" and r.label == "query-timeout"
|
||||
for r in sample.readings)
|
||||
if lost:
|
||||
self._fire("gpu_lost", "GPU not responding", "nvidia-smi query timed out — the GPU may have dropped")
|
||||
else:
|
||||
self._clear("gpu_lost")
|
||||
@@ -0,0 +1,75 @@
|
||||
"""Installable component catalog (M9): optional system tools and what they enable.
|
||||
|
||||
apt-only (D15). Core monitoring (M1/M3/M4) needs no packages — these are optional
|
||||
enrichments the installer can add. Each component is detected by a representative
|
||||
command (present == usable).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
|
||||
|
||||
@dataclass(frozen=True)
|
||||
class Component:
|
||||
id: str
|
||||
name: str
|
||||
bundle: str
|
||||
enables: str # capability unlocked when present
|
||||
apt: tuple[str, ...] # apt package name(s)
|
||||
command: str # command used to detect presence
|
||||
|
||||
|
||||
COMPONENTS: tuple[Component, ...] = (
|
||||
Component(
|
||||
"smartmontools", "SMART disk health", "Diagnostics",
|
||||
"Disk health (SMART) in the health report", ("smartmontools",), "smartctl",
|
||||
),
|
||||
Component(
|
||||
"lm-sensors", "lm-sensors", "Diagnostics",
|
||||
"Extra motherboard / voltage sensors", ("lm-sensors",), "sensors",
|
||||
),
|
||||
Component(
|
||||
"dmidecode", "dmidecode", "Diagnostics",
|
||||
"Motherboard / BIOS / RAM details for system inventory", ("dmidecode",), "dmidecode",
|
||||
),
|
||||
Component(
|
||||
"pciutils", "pciutils", "Diagnostics",
|
||||
"PCIe topology + GPU detection (lspci)", ("pciutils",), "lspci",
|
||||
),
|
||||
Component(
|
||||
"libnotify", "Desktop notifications", "Monitoring",
|
||||
"Desktop alert notifications", ("libnotify-bin",), "notify-send",
|
||||
),
|
||||
Component(
|
||||
"libsecret", "Encrypted token storage", "Updates",
|
||||
"Store the update token in the OS keyring, encrypted", ("libsecret-tools",), "secret-tool",
|
||||
),
|
||||
Component(
|
||||
"gamemode", "Feral GameMode", "Gaming",
|
||||
"Auto-applies performance tweaks (CPU governor, scheduling) while a game runs",
|
||||
("gamemode",), "gamemoderun",
|
||||
),
|
||||
Component(
|
||||
"mangohud", "MangoHud", "Gaming",
|
||||
"In-game overlay for FPS, frame times, and temperatures", ("mangohud",), "mangohud",
|
||||
),
|
||||
Component(
|
||||
"cpupower", "cpupower", "Gaming",
|
||||
"Read/set the CPU frequency governor (e.g. performance for gaming)",
|
||||
("linux-tools-common", "linux-tools-generic"), "cpupower",
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def by_id(component_id: str) -> Component | None:
|
||||
"""Look up a catalog component by its id (None if unknown)."""
|
||||
return next((c for c in COMPONENTS if c.id == component_id), None)
|
||||
|
||||
|
||||
def by_bundle() -> dict[str, list[Component]]:
|
||||
"""Components grouped by bundle, preserving catalog order (for the setup wizard)."""
|
||||
groups: dict[str, list[Component]] = {}
|
||||
for c in COMPONENTS:
|
||||
groups.setdefault(c.bundle, []).append(c)
|
||||
return groups
|
||||
@@ -0,0 +1,187 @@
|
||||
"""Guided diagnostic session (SPEC §4 / ARCHITECTURE §7.1): orchestrate M3 + M4.
|
||||
|
||||
The seed use case, one flow: **pick a game** → **focused crash-capture** scoped to that
|
||||
session (M3, tagged with the game) → on **finish**, **scan & analyze** (M4 health report)
|
||||
over the captured window + system logs → return a prioritized result. This is not a new
|
||||
module — it's a single shared callable so the CLI, GUI, and tray run the identical flow.
|
||||
|
||||
The capture is **manually bracketed** (start/finish) for now; auto start/stop on game launch
|
||||
(the D12 wrapper/watcher) plugs in here later without changing the result shape.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import time
|
||||
from dataclasses import dataclass
|
||||
|
||||
from .. import config
|
||||
from . import reccontrol
|
||||
from .crashlog import Summary, summarize
|
||||
from .health import CRITICAL, OK, WARNING, Finding
|
||||
|
||||
_SEV_ORDER = {CRITICAL: 0, WARNING: 1, "info": 2, OK: 3}
|
||||
|
||||
|
||||
@dataclass
|
||||
class DiagnosticResult:
|
||||
game: str | None
|
||||
summary: Summary # capture window: peak temps/power, events, last samples (M3)
|
||||
findings: list[Finding] # health findings: Xid/SMART/driver/etc. (M4)
|
||||
|
||||
|
||||
@dataclass
|
||||
class CrashInfo:
|
||||
game: str | None
|
||||
samples: int
|
||||
when: float | None # ts of the last captured sample (≈ when the freeze hit)
|
||||
gpu_lost: bool
|
||||
|
||||
|
||||
def _clear_diag_log() -> None:
|
||||
"""Each diagnostic is a fresh focused capture — drop any previous session + segments."""
|
||||
base = config.DIAG_LOG
|
||||
for p in [base, *base.parent.glob(base.name + ".*")]:
|
||||
try:
|
||||
p.unlink()
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def start(game: str | None = None, interval: float | None = None) -> int | None:
|
||||
"""Begin a focused capture, tagged with the game, into the dedicated diagnostic log.
|
||||
Returns the pid, or None if a capture is already running."""
|
||||
if reccontrol.running_pid():
|
||||
return None
|
||||
if _crash_from_log(config.DIAG_LOG): # preserve an unanalyzed crash before overwriting it
|
||||
try:
|
||||
config.DIAG_LOG.replace(config.DIAG_CRASH)
|
||||
except OSError:
|
||||
pass
|
||||
_clear_diag_log()
|
||||
return reccontrol.start_background(interval=interval, out=str(config.DIAG_LOG), game=game)
|
||||
|
||||
|
||||
def is_running() -> bool:
|
||||
return reccontrol.running_pid() is not None
|
||||
|
||||
|
||||
def active() -> dict | None:
|
||||
"""Status of the in-progress session (running flag, game, samples), or None if idle."""
|
||||
if not is_running():
|
||||
return None
|
||||
return reccontrol.read_status()
|
||||
|
||||
|
||||
def _await_stopped(timeout: float = 6.0) -> None:
|
||||
deadline = time.monotonic() + timeout
|
||||
while reccontrol.running_pid() and time.monotonic() < deadline:
|
||||
time.sleep(0.1)
|
||||
|
||||
|
||||
def _game_from_summary(summary: Summary) -> str | None:
|
||||
"""Recover the focused game from the log's 'game' event (survives a crash + reboot)."""
|
||||
for _ts, kind, detail in reversed(summary.events):
|
||||
if kind == "game" and detail:
|
||||
return detail
|
||||
return None
|
||||
|
||||
|
||||
def finish(last_n: int = 10, log_path=None) -> DiagnosticResult:
|
||||
"""Stop the capture (if running), summarize the window, and run the health report."""
|
||||
from .health import run_health_checks
|
||||
|
||||
reccontrol.stop_background()
|
||||
_await_stopped()
|
||||
path = log_path or config.DIAG_LOG
|
||||
summary = summarize(path, last_n=last_n)
|
||||
game = _game_from_summary(summary) or (reccontrol.read_status() or {}).get("game")
|
||||
findings = run_health_checks()
|
||||
return DiagnosticResult(game=game, summary=summary, findings=findings)
|
||||
|
||||
|
||||
# --- hard-crash detection & post-crash analysis -----------------------------------
|
||||
|
||||
def _crash_from_log(path) -> CrashInfo | None:
|
||||
"""CrashInfo if `path` holds an abnormally-ended session (start, no stop, not acked)."""
|
||||
if not path.exists():
|
||||
return None
|
||||
summary = summarize(path)
|
||||
kinds = {kind for _ts, kind, _detail in summary.events}
|
||||
if "session-start" not in kinds:
|
||||
return None
|
||||
if "session-stop" in kinds or "diagnostic-acknowledged" in kinds:
|
||||
return None
|
||||
return CrashInfo(
|
||||
game=_game_from_summary(summary),
|
||||
samples=summary.samples,
|
||||
when=summary.end,
|
||||
gpu_lost="gpu-lost" in kinds,
|
||||
)
|
||||
|
||||
|
||||
def _crash_path():
|
||||
"""Where the pending crash lives: the preserved archive if present, else the live log."""
|
||||
return config.DIAG_CRASH if config.DIAG_CRASH.exists() else config.DIAG_LOG
|
||||
|
||||
|
||||
def pending_crash() -> CrashInfo | None:
|
||||
"""Detect a diagnostic that ended abnormally (no clean stop, no live recorder).
|
||||
|
||||
A focused capture writes `session-start` (+ `game`) and, on a clean stop, `session-stop`.
|
||||
After a hard freeze that block never runs, so the log has a start with no stop and no
|
||||
live recorder — that's our hard-crash signal. A crash preserved across an auto-relaunch
|
||||
(`DIAG_CRASH`) is checked first. Returns None if a capture is running, none is recorded,
|
||||
it stopped cleanly, or the user already acknowledged it.
|
||||
"""
|
||||
info = _crash_from_log(config.DIAG_CRASH) # preserved across a relaunch (wrapper)
|
||||
if info is not None:
|
||||
return info
|
||||
if is_running():
|
||||
return None
|
||||
return _crash_from_log(config.DIAG_LOG)
|
||||
|
||||
|
||||
def acknowledge_crash() -> None:
|
||||
"""Mark the recorded crash as seen so it stops prompting."""
|
||||
try:
|
||||
config.DIAG_CRASH.unlink() # drop the preserved archive, if any
|
||||
except OSError:
|
||||
pass
|
||||
try:
|
||||
config.DIAG_LOG.parent.mkdir(parents=True, exist_ok=True)
|
||||
with open(config.DIAG_LOG, "a", encoding="utf-8") as fh:
|
||||
fh.write(json.dumps({"ts": time.time(), "event": "diagnostic-acknowledged", "detail": ""}) + "\n")
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def _crash_headline(summary: Summary) -> Finding:
|
||||
gpu_lost = any(kind == "gpu-lost" for _ts, kind, _detail in summary.events)
|
||||
when = time.strftime("%H:%M:%S", time.localtime(summary.end)) if summary.end else "?"
|
||||
detail = (
|
||||
f"The capture stopped abruptly at {when} after {summary.samples} samples, with no clean "
|
||||
"shutdown recorded — consistent with a hard freeze or power loss."
|
||||
)
|
||||
if gpu_lost:
|
||||
detail += " A GPU-lost event was captured during the session."
|
||||
return Finding(
|
||||
CRITICAL if gpu_lost else WARNING,
|
||||
"Diagnostic",
|
||||
"Session ended without a clean stop (likely a hard crash)",
|
||||
detail,
|
||||
"Review the last readings (Capture, above) and the crash-boot findings below.",
|
||||
)
|
||||
|
||||
|
||||
def analyze_crash(last_n: int = 15) -> DiagnosticResult:
|
||||
"""Analyze a recorded hard crash: the captured window + the previous boot's kernel log
|
||||
+ the rest of the health report (SMART/driver/persistence/temps)."""
|
||||
from .health import check_previous_boot, run_health_checks
|
||||
|
||||
summary = summarize(_crash_path(), last_n=last_n)
|
||||
findings: list[Finding] = [_crash_headline(summary)]
|
||||
findings += check_previous_boot() # the crashed boot's kernel log
|
||||
findings += run_health_checks(include_journal=False) # SMART/driver/persistence/temps
|
||||
findings.sort(key=lambda f: _SEV_ORDER.get(f.severity, 9))
|
||||
return DiagnosticResult(game=_game_from_summary(summary), summary=summary, findings=findings)
|
||||
@@ -0,0 +1,51 @@
|
||||
"""Session privilege elevation.
|
||||
|
||||
At GUI launch the app asks for the password once (pkexec) and collects the data that
|
||||
needs root — SMART health + dmidecode (board/BIOS/RAM) — caching it for the session so
|
||||
Health and Inventory can always show the full picture without per-action prompts.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
_privileged: dict | None = None
|
||||
|
||||
|
||||
def privileged() -> dict | None:
|
||||
"""Cached root-collected data ({"smart": [...], "dmidecode": {...}}), or None."""
|
||||
return _privileged
|
||||
|
||||
|
||||
def set_privileged(data: dict | None) -> None:
|
||||
global _privileged
|
||||
_privileged = data
|
||||
|
||||
|
||||
def available() -> bool:
|
||||
return shutil.which("pkexec") is not None and os.geteuid() != 0
|
||||
|
||||
|
||||
def _cli() -> list[str]:
|
||||
candidate = os.path.join(os.path.dirname(sys.executable), "rigdoctor")
|
||||
return [candidate] if os.path.exists(candidate) else [sys.executable, "-m", "rigdoctor"]
|
||||
|
||||
|
||||
def collect_via_pkexec(timeout: float = 120.0) -> dict | None:
|
||||
"""Run one elevated collection (single password prompt). None if unavailable/cancelled."""
|
||||
if not available():
|
||||
return None
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
["pkexec", *_cli(), "collect-priv"],
|
||||
capture_output=True, text=True, timeout=timeout,
|
||||
)
|
||||
if proc.returncode == 0 and proc.stdout.strip():
|
||||
return json.loads(proc.stdout)
|
||||
except (subprocess.SubprocessError, OSError, ValueError):
|
||||
pass
|
||||
return None
|
||||
@@ -0,0 +1,177 @@
|
||||
"""Apply runtime-reversible system tunables (M6) — a limited, consent-gated exception to
|
||||
the read-only stance (D9, amended by D22).
|
||||
|
||||
Only safe settings that take effect immediately, need no reboot, and revert on reboot are
|
||||
applyable here: CPU governor, NVIDIA persistence mode, PCIe ASPM policy, vm.swappiness, and
|
||||
Transparent HugePages. Each is set by a single privileged command (one pkexec prompt). The
|
||||
chosen value is validated against the live options before building the command, and writes go
|
||||
to sysfs / procfs (or `nvidia-smi`) — never the GRUB cmdline or a persistent config file.
|
||||
Riskier fixes (GRUB-based PCIe ASPM-off, CPU mitigations) stay suggestion-only.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shlex
|
||||
import shutil
|
||||
import subprocess
|
||||
from collections.abc import Callable
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
@dataclass
|
||||
class Tunable:
|
||||
id: str
|
||||
label: str # e.g. "CPU governor"
|
||||
options: list[str] # selectable values (live, from the system)
|
||||
current: str | None # the value in effect now (preselect this in the dropdown)
|
||||
note: str = "" # caveat shown by the control, e.g. "resets on reboot"
|
||||
|
||||
|
||||
def _read(path: str) -> str | None:
|
||||
try:
|
||||
return Path(path).read_text()
|
||||
except OSError:
|
||||
return None
|
||||
|
||||
|
||||
def _bracketed(text: str) -> tuple[list[str], str | None]:
|
||||
"""Parse a sysfs 'a [b] c' enum into (options, active)."""
|
||||
options = [tok.strip("[]") for tok in text.split()]
|
||||
active = next((tok.strip("[]") for tok in text.split() if tok.startswith("[")), None)
|
||||
return options, active
|
||||
|
||||
|
||||
# --- individual tunables: a state reader + a command builder per id -------------------
|
||||
|
||||
_GOV = "/sys/devices/system/cpu"
|
||||
|
||||
|
||||
def _cpu_governor() -> Tunable | None:
|
||||
cur = _read(f"{_GOV}/cpu0/cpufreq/scaling_governor")
|
||||
if cur is None:
|
||||
return None
|
||||
avail = _read(f"{_GOV}/cpu0/cpufreq/scaling_available_governors")
|
||||
options = avail.split() if avail and avail.strip() else ["performance", "powersave", "schedutil"]
|
||||
return Tunable("cpu_governor", "CPU governor", options, cur.strip(), "applies now; resets on reboot")
|
||||
|
||||
|
||||
def _cpu_governor_cmd(value: str) -> list[str]:
|
||||
return ["/bin/sh", "-c",
|
||||
f'for f in {_GOV}/cpu*/cpufreq/scaling_governor; do echo {shlex.quote(value)} > "$f"; done']
|
||||
|
||||
|
||||
def _nvidia_persistence() -> Tunable | None:
|
||||
if shutil.which("nvidia-smi") is None:
|
||||
return None
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
["nvidia-smi", "--query-gpu=persistence_mode", "--format=csv,noheader"],
|
||||
capture_output=True, text=True, timeout=10,
|
||||
)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return None
|
||||
state = proc.stdout.strip().splitlines()[0].strip().lower() if proc.stdout.strip() else ""
|
||||
current = "Enabled" if state.startswith("enabled") else ("Disabled" if state.startswith("disabled") else None)
|
||||
return Tunable("nvidia_persistence", "NVIDIA persistence mode", ["Enabled", "Disabled"], current,
|
||||
"resets on reboot (enable nvidia-persistenced to persist)")
|
||||
|
||||
|
||||
def _nvidia_persistence_cmd(value: str) -> list[str]:
|
||||
return ["nvidia-smi", "-pm", "1" if value == "Enabled" else "0"]
|
||||
|
||||
|
||||
def _pcie_aspm() -> Tunable | None:
|
||||
text = _read("/sys/module/pcie_aspm/parameters/policy")
|
||||
if not text:
|
||||
return None
|
||||
options, active = _bracketed(text)
|
||||
return Tunable("pcie_aspm", "PCIe ASPM policy", options, active, "applies now; resets on reboot")
|
||||
|
||||
|
||||
def _pcie_aspm_cmd(value: str) -> list[str]:
|
||||
return ["/bin/sh", "-c", f'echo {shlex.quote(value)} > /sys/module/pcie_aspm/parameters/policy']
|
||||
|
||||
|
||||
def _swappiness() -> Tunable | None:
|
||||
text = _read("/proc/sys/vm/swappiness")
|
||||
if text is None or not text.strip().isdigit():
|
||||
return None
|
||||
cur = text.strip()
|
||||
options = ["0", "10", "30", "60", "100"]
|
||||
if cur not in options:
|
||||
options = sorted(set(options) | {cur}, key=int)
|
||||
return Tunable("swappiness", "vm.swappiness", options, cur, "applies now; resets on reboot")
|
||||
|
||||
|
||||
def _swappiness_cmd(value: str) -> list[str]:
|
||||
return ["/bin/sh", "-c", f'echo {shlex.quote(value)} > /proc/sys/vm/swappiness']
|
||||
|
||||
|
||||
def _thp() -> Tunable | None:
|
||||
text = _read("/sys/kernel/mm/transparent_hugepage/enabled")
|
||||
if not text:
|
||||
return None
|
||||
options, active = _bracketed(text)
|
||||
return Tunable("thp", "Transparent HugePages", options, active, "applies now; resets on reboot")
|
||||
|
||||
|
||||
def _thp_cmd(value: str) -> list[str]:
|
||||
return ["/bin/sh", "-c", f'echo {shlex.quote(value)} > /sys/kernel/mm/transparent_hugepage/enabled']
|
||||
|
||||
|
||||
_TUNABLES: dict[str, tuple[Callable[[], Tunable | None], Callable[[str], list[str]]]] = {
|
||||
"cpu_governor": (_cpu_governor, _cpu_governor_cmd),
|
||||
"nvidia_persistence": (_nvidia_persistence, _nvidia_persistence_cmd),
|
||||
"pcie_aspm": (_pcie_aspm, _pcie_aspm_cmd),
|
||||
"swappiness": (_swappiness, _swappiness_cmd),
|
||||
"thp": (_thp, _thp_cmd),
|
||||
}
|
||||
|
||||
|
||||
# --- public API -----------------------------------------------------------------------
|
||||
|
||||
def get_tunable(fix_id: str) -> Tunable | None:
|
||||
"""Live state (options + current value) for a fix id, or None if not applicable here."""
|
||||
fns = _TUNABLES.get(fix_id)
|
||||
return fns[0]() if fns else None
|
||||
|
||||
|
||||
def apply_command(fix_id: str, value: str) -> list[str] | None:
|
||||
"""The privileged command to set fix_id=value, or None if unknown/invalid.
|
||||
|
||||
The value is validated against the *live* options, so only a real, currently-available
|
||||
setting can ever be turned into a command.
|
||||
"""
|
||||
fns = _TUNABLES.get(fix_id)
|
||||
if not fns:
|
||||
return None
|
||||
state = fns[0]()
|
||||
if state is None or value not in state.options:
|
||||
return None
|
||||
return fns[1](value)
|
||||
|
||||
|
||||
def _elevate(cmd: list[str]) -> list[str]:
|
||||
prog = shutil.which(cmd[0]) or cmd[0] # pkexec needs an absolute program path
|
||||
cmd = [prog, *cmd[1:]]
|
||||
if os.geteuid() == 0:
|
||||
return cmd
|
||||
if shutil.which("pkexec"):
|
||||
return ["pkexec", *cmd]
|
||||
if shutil.which("sudo"):
|
||||
return ["sudo", *cmd]
|
||||
return cmd # no escalation available — will likely fail, surfaced to the caller
|
||||
|
||||
|
||||
def apply(fix_id: str, value: str) -> tuple[int, str]:
|
||||
"""Apply fix_id=value via a single elevated command. Returns (exit_code, output)."""
|
||||
cmd = apply_command(fix_id, value)
|
||||
if cmd is None:
|
||||
return (1, f"Unknown or unavailable setting: {fix_id}={value}")
|
||||
try:
|
||||
proc = subprocess.run(_elevate(cmd), capture_output=True, text=True, timeout=120)
|
||||
return (proc.returncode, proc.stdout + proc.stderr)
|
||||
except (subprocess.SubprocessError, OSError) as exc:
|
||||
return (1, str(exc))
|
||||
@@ -0,0 +1,328 @@
|
||||
"""Gaming environment checks (M6): evaluate system settings that affect gaming
|
||||
stability/performance and suggest the fix command — read-only (D9).
|
||||
|
||||
Stdlib-only. Each check degrades gracefully (a missing file/tool yields no finding or an
|
||||
info finding, never an exception). The pure ``evaluate_*`` helpers are split from the IO
|
||||
that reads sysfs / runs tools, so they're unit-testable.
|
||||
|
||||
Several checks target the seed case directly: an RTX 3070 falling off the PCIe bus under
|
||||
load (Xid 79). PCIe ASPM power-saving, NVIDIA persistence mode, and a power-saving CPU
|
||||
governor are the usual contributors to that class of drop-off / stutter.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
|
||||
from .health import INFO, OK, WARNING, Finding
|
||||
|
||||
_ORDER = {"critical": 0, WARNING: 1, INFO: 2, OK: 3}
|
||||
|
||||
|
||||
def _read(path: str) -> str | None:
|
||||
try:
|
||||
return Path(path).read_text()
|
||||
except OSError:
|
||||
return None
|
||||
|
||||
|
||||
# --- PCIe ASPM (seed-case relevant) ---------------------------------------------------
|
||||
|
||||
def _active_aspm(policy_text: str) -> str | None:
|
||||
"""The active ASPM policy is the bracketed token, e.g. '[default] performance ...'."""
|
||||
m = re.search(r"\[(\w+)\]", policy_text)
|
||||
return m.group(1) if m else None
|
||||
|
||||
|
||||
def evaluate_aspm(policy_text: str | None) -> Finding | None:
|
||||
if not policy_text:
|
||||
return None
|
||||
active = _active_aspm(policy_text)
|
||||
if active is None:
|
||||
return None
|
||||
if active in ("powersave", "powersupersave"):
|
||||
return Finding(
|
||||
WARNING, "PCIe", f"PCIe ASPM is in power-saving mode ({active})",
|
||||
"Aggressive PCIe Active-State Power Management can cause the GPU to drop off the "
|
||||
"bus under load (Xid 79) or stutter — the seed-case failure mode.",
|
||||
"Set the policy to performance below (live), or for a permanent change add "
|
||||
"`pcie_aspm=off` in GRUB, then `sudo update-grub` and reboot.",
|
||||
fix="pcie_aspm",
|
||||
)
|
||||
if active == "performance":
|
||||
return Finding(OK, "PCIe", "PCIe ASPM set to performance", "ASPM power-saving is disabled.",
|
||||
fix="pcie_aspm")
|
||||
return Finding(
|
||||
INFO, "PCIe", f"PCIe ASPM policy: {active}",
|
||||
"ASPM is left to the kernel/BIOS default.",
|
||||
"If you see GPU bus-drop events (Xid 79), set the policy to performance below.",
|
||||
fix="pcie_aspm",
|
||||
)
|
||||
|
||||
|
||||
def check_pcie_aspm() -> list[Finding]:
|
||||
f = evaluate_aspm(_read("/sys/module/pcie_aspm/parameters/policy"))
|
||||
return [f] if f else []
|
||||
|
||||
|
||||
# --- NVIDIA persistence mode (seed-case relevant) -------------------------------------
|
||||
|
||||
def check_gpu_powermizer() -> list[Finding]:
|
||||
"""NVIDIA PowerMizer preferred-performance mode (X only, via nvidia-settings)."""
|
||||
if shutil.which("nvidia-settings") is None or not os.environ.get("DISPLAY"):
|
||||
return []
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
["nvidia-settings", "-q", "[gpu:0]/GPUPowerMizerMode", "-t"],
|
||||
capture_output=True, text=True, timeout=10,
|
||||
)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return []
|
||||
raw = proc.stdout.strip().splitlines()[0].strip() if proc.stdout.strip() else ""
|
||||
if not raw.isdigit(): # no X target / Wayland / query failed — skip quietly
|
||||
return []
|
||||
names = {0: "Adaptive", 1: "Prefer Maximum Performance", 2: "Auto"}
|
||||
name = names.get(int(raw), f"mode {raw}")
|
||||
if int(raw) == 1:
|
||||
return [Finding(OK, "GPU", f"GPU PowerMizer: {name}", "The GPU prefers maximum performance.")]
|
||||
return [Finding(
|
||||
INFO, "GPU", f"GPU PowerMizer: {name}",
|
||||
"Adaptive/Auto can downclock the GPU between load spikes, hurting frame consistency.",
|
||||
"Prefer max performance (X only, resets on reboot): "
|
||||
"`nvidia-settings -a '[gpu:0]/GPUPowerMizerMode=1'`.",
|
||||
)]
|
||||
|
||||
|
||||
def check_gpu_persistence() -> list[Finding]:
|
||||
if shutil.which("nvidia-smi") is None:
|
||||
return []
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
["nvidia-smi", "--query-gpu=persistence_mode", "--format=csv,noheader"],
|
||||
capture_output=True, text=True, timeout=10,
|
||||
)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return []
|
||||
state = proc.stdout.strip().splitlines()[0].strip() if proc.stdout.strip() else ""
|
||||
if state.lower().startswith("disabled"):
|
||||
return [Finding(
|
||||
INFO, "GPU", "NVIDIA persistence mode is off",
|
||||
"The driver unloads when no client is attached, adding latency on first GPU "
|
||||
"access and churning state between game launches.",
|
||||
"Enable it below (per-boot), or enable the `nvidia-persistenced` service to "
|
||||
"make it permanent.",
|
||||
fix="nvidia_persistence",
|
||||
)]
|
||||
if state.lower().startswith("enabled"):
|
||||
return [Finding(OK, "GPU", "NVIDIA persistence mode on", "The driver stays resident.",
|
||||
fix="nvidia_persistence")]
|
||||
return []
|
||||
|
||||
|
||||
# --- CPU governor ---------------------------------------------------------------------
|
||||
|
||||
def evaluate_governor(governors: set[str]) -> Finding | None:
|
||||
if not governors:
|
||||
return None
|
||||
shown = ", ".join(sorted(governors))
|
||||
if governors == {"performance"}:
|
||||
return Finding(OK, "CPU", "CPU governor: performance", "CPUs run at full clocks under load.",
|
||||
fix="cpu_governor")
|
||||
if "powersave" in governors:
|
||||
return Finding(
|
||||
WARNING, "CPU", f"CPU governor set to power-saving ({shown})",
|
||||
"A powersave governor caps CPU frequency and can bottleneck frame times.",
|
||||
"Set it to performance below (or install GameMode to switch it per-game).",
|
||||
fix="cpu_governor",
|
||||
)
|
||||
return Finding(
|
||||
INFO, "CPU", f"CPU governor: {shown}",
|
||||
"A dynamic governor scales with load; usually fine.",
|
||||
"For the most consistent frame pacing, set performance below (or use GameMode).",
|
||||
fix="cpu_governor",
|
||||
)
|
||||
|
||||
|
||||
def check_cpu_governor() -> list[Finding]:
|
||||
govs: set[str] = set()
|
||||
for p in Path("/sys/devices/system/cpu").glob("cpu*/cpufreq/scaling_governor"):
|
||||
text = _read(str(p))
|
||||
if text and text.strip():
|
||||
govs.add(text.strip())
|
||||
f = evaluate_governor(govs)
|
||||
return [f] if f else []
|
||||
|
||||
|
||||
# --- GameMode / MangoHud --------------------------------------------------------------
|
||||
|
||||
def check_gamemode() -> list[Finding]:
|
||||
if shutil.which("gamemoderun") or shutil.which("gamemoded"):
|
||||
return [Finding(
|
||||
OK, "Tools", "Feral GameMode installed",
|
||||
"GameMode can apply the performance governor and other tweaks while a game runs.",
|
||||
)]
|
||||
return [Finding(
|
||||
INFO, "Tools", "GameMode not installed",
|
||||
"GameMode auto-applies performance tweaks (governor, scheduling) for the duration of a game.",
|
||||
"Install it: `sudo apt install gamemode`, then launch games with `gamemoderun %command%` "
|
||||
"(or use a global Steam launch option).",
|
||||
action="gamemode",
|
||||
)]
|
||||
|
||||
|
||||
def check_mangohud() -> list[Finding]:
|
||||
if shutil.which("mangohud"):
|
||||
return [Finding(OK, "Tools", "MangoHud available", "In-game FPS/temps/frametime overlay is installed.")]
|
||||
return [Finding(
|
||||
INFO, "Tools", "MangoHud not installed",
|
||||
"MangoHud overlays live FPS, frame times, and temps in-game — handy for spotting stutter.",
|
||||
"Install it: `sudo apt install mangohud`, then launch with `mangohud %command%`.",
|
||||
action="mangohud",
|
||||
)]
|
||||
|
||||
|
||||
# --- vm.swappiness --------------------------------------------------------------------
|
||||
|
||||
def evaluate_swappiness(value: int) -> Finding:
|
||||
if value > 10:
|
||||
return Finding(
|
||||
INFO, "Memory", f"vm.swappiness is high ({value})",
|
||||
"A high swappiness lets the kernel swap out memory eagerly, which can cause "
|
||||
"hitching during gaming on systems with ample RAM.",
|
||||
"Lower it below (e.g. 10); applies immediately.",
|
||||
fix="swappiness",
|
||||
)
|
||||
return Finding(OK, "Memory", f"vm.swappiness is {value}", "Swapping is conservative.",
|
||||
fix="swappiness")
|
||||
|
||||
|
||||
def check_swappiness() -> list[Finding]:
|
||||
text = _read("/proc/sys/vm/swappiness")
|
||||
if text is None or not text.strip().isdigit():
|
||||
return []
|
||||
return [evaluate_swappiness(int(text.strip()))]
|
||||
|
||||
|
||||
# --- shader cache ---------------------------------------------------------------------
|
||||
|
||||
def evaluate_shader_cache(env: dict) -> Finding:
|
||||
disabled = (
|
||||
env.get("__GL_SHADER_DISK_CACHE") == "0"
|
||||
or env.get("MESA_SHADER_CACHE_DISABLE", "").lower() in ("1", "true")
|
||||
or env.get("MESA_GLSL_CACHE_DISABLE", "").lower() in ("1", "true")
|
||||
)
|
||||
if disabled:
|
||||
return Finding(
|
||||
WARNING, "GPU", "Shader disk cache is disabled",
|
||||
"With the shader cache off, shaders recompile every run — a common cause of "
|
||||
"in-game stutter, especially on first encounters.",
|
||||
"Unset the disabling variable (e.g. remove `__GL_SHADER_DISK_CACHE=0` / "
|
||||
"`MESA_SHADER_CACHE_DISABLE`) from your environment / launch options.",
|
||||
)
|
||||
return Finding(OK, "GPU", "Shader disk cache enabled", "Compiled shaders are cached between runs (default).")
|
||||
|
||||
|
||||
def check_shader_cache() -> list[Finding]:
|
||||
return [evaluate_shader_cache(os.environ)]
|
||||
|
||||
|
||||
# --- transparent hugepages / CPU mitigations (only when notable) ----------------------
|
||||
|
||||
def check_thp() -> list[Finding]:
|
||||
text = _read("/sys/kernel/mm/transparent_hugepage/enabled")
|
||||
if not text:
|
||||
return []
|
||||
active = _active_aspm(text) # same '[token]' format
|
||||
if active == "never":
|
||||
return [Finding(
|
||||
INFO, "Memory", "Transparent HugePages disabled (never)",
|
||||
"Some workloads benefit from THP; 'madvise' lets apps opt in without the downsides of 'always'.",
|
||||
"Optional: set 'madvise' below; applies immediately.",
|
||||
fix="thp",
|
||||
)]
|
||||
return []
|
||||
|
||||
|
||||
def check_mitigations() -> list[Finding]:
|
||||
cmdline = _read("/proc/cmdline") or ""
|
||||
if "mitigations=off" in cmdline:
|
||||
return [Finding(
|
||||
INFO, "CPU", "CPU security mitigations are disabled",
|
||||
"`mitigations=off` recovers some CPU performance at the cost of CPU-vulnerability "
|
||||
"protections — a deliberate trade-off, noted here for awareness.",
|
||||
"Remove `mitigations=off` from the kernel cmdline to restore protections.",
|
||||
)]
|
||||
return []
|
||||
|
||||
|
||||
# --- Proton versions (informational) --------------------------------------------------
|
||||
|
||||
def check_wine() -> list[Finding]:
|
||||
"""System Wine version (used by Lutris / non-Proton games)."""
|
||||
if shutil.which("wine") is None:
|
||||
return []
|
||||
try:
|
||||
proc = subprocess.run(["wine", "--version"], capture_output=True, text=True, timeout=10)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return []
|
||||
ver = proc.stdout.strip().split()[0] if proc.stdout.strip() else ""
|
||||
if not ver:
|
||||
return []
|
||||
return [Finding(
|
||||
INFO, "Tools", f"Wine: {ver}",
|
||||
"System Wine — used by Lutris and non-Proton titles.",
|
||||
"Steam games generally run best on Proton; keep Wine current for native/Lutris use.",
|
||||
)]
|
||||
|
||||
|
||||
def check_steam_client() -> list[Finding]:
|
||||
"""Installed Steam client package version."""
|
||||
from . import steam
|
||||
|
||||
ver = steam.client_version()
|
||||
if not ver:
|
||||
return []
|
||||
return [Finding(INFO, "Tools", f"Steam client: {ver}", "The installed Steam package version.")]
|
||||
|
||||
|
||||
def check_proton() -> list[Finding]:
|
||||
from . import steam
|
||||
|
||||
try:
|
||||
versions = steam.proton_versions()
|
||||
except Exception:
|
||||
versions = []
|
||||
if not versions:
|
||||
return []
|
||||
return [Finding(
|
||||
INFO, "Tools", f"Proton: {len(versions)} version(s) installed",
|
||||
", ".join(versions),
|
||||
"Steam picks the Proton version per game (Properties → Compatibility); "
|
||||
"Proton Experimental often has the latest fixes.",
|
||||
)]
|
||||
|
||||
|
||||
# --- aggregate ------------------------------------------------------------------------
|
||||
|
||||
def run_gameenv_checks() -> list[Finding]:
|
||||
"""Run all environment checks, sorted by severity (worst first)."""
|
||||
findings: list[Finding] = []
|
||||
findings += check_pcie_aspm()
|
||||
findings += check_gpu_persistence()
|
||||
findings += check_gpu_powermizer()
|
||||
findings += check_cpu_governor()
|
||||
findings += check_gamemode()
|
||||
findings += check_mangohud()
|
||||
findings += check_swappiness()
|
||||
findings += check_shader_cache()
|
||||
findings += check_thp()
|
||||
findings += check_mitigations()
|
||||
findings += check_proton()
|
||||
findings += check_wine()
|
||||
findings += check_steam_client()
|
||||
findings.sort(key=lambda f: _ORDER.get(f.severity, 9))
|
||||
return findings
|
||||
@@ -0,0 +1,277 @@
|
||||
"""Health report (M4): scan kernel logs + SMART + driver/library state into a
|
||||
prioritized, plain-language findings list with suggested fixes (read-only, D9).
|
||||
|
||||
Stdlib-only. Every check degrades gracefully — a missing tool/permission yields an
|
||||
info finding, never an exception.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import re
|
||||
import shutil
|
||||
import subprocess
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
CRITICAL = "critical"
|
||||
WARNING = "warning"
|
||||
INFO = "info"
|
||||
OK = "ok"
|
||||
_ORDER = {CRITICAL: 0, WARNING: 1, INFO: 2, OK: 3}
|
||||
|
||||
|
||||
@dataclass
|
||||
class Finding:
|
||||
severity: str # critical | warning | info | ok
|
||||
category: str # GPU, Kernel, Memory, Storage, Thermal, Driver, PCIe, Logs
|
||||
title: str
|
||||
detail: str = ""
|
||||
suggestion: str = ""
|
||||
action: str = "" # optional: id of an installable catalog component (for an Install button)
|
||||
fix: str = "" # optional: id of an applyable runtime tunable (for an Apply dropdown, M6)
|
||||
|
||||
|
||||
# --- NVIDIA Xid knowledge (the seed crash is Xid 79) --------------------------
|
||||
_XID_INFO: dict[int, tuple[str, str]] = {
|
||||
13: (WARNING, "Graphics engine exception (often an app/driver bug or unstable overclock)"),
|
||||
31: (WARNING, "GPU memory page fault (usually a driver or application bug)"),
|
||||
43: (WARNING, "GPU stopped processing a task (application error)"),
|
||||
45: (INFO, "Preemptive channel removal (often a side-effect of another error or a reboot)"),
|
||||
48: (CRITICAL, "Double-bit ECC error — VRAM hardware fault"),
|
||||
62: (CRITICAL, "Internal microcontroller halt (often follows instability)"),
|
||||
79: (CRITICAL, "GPU has fallen off the bus — hardware: power delivery, PCIe link, or thermals"),
|
||||
94: (CRITICAL, "Contained ECC error"),
|
||||
95: (CRITICAL, "Uncontained ECC error"),
|
||||
119: (CRITICAL, "GSP RPC timeout — GPU System Processor hang"),
|
||||
120: (CRITICAL, "GSP error — GPU System Processor fault"),
|
||||
}
|
||||
_XID_SUGGEST: dict[int, str] = {
|
||||
79: "Check PSU/power cables and reseat the GPU/riser; test a lower power limit "
|
||||
"(`sudo nvidia-smi -pl <watts>`) and capture a session with `rigdoctor record`.",
|
||||
48: "Persistent VRAM ECC errors mean failing memory — RMA the card if it recurs.",
|
||||
119: "GSP hangs are often driver-version specific — try a different driver branch.",
|
||||
120: "GSP errors are often driver-version specific — try a different driver branch.",
|
||||
}
|
||||
_XID_RE = re.compile(r"Xid(?:\s*\([^)]*\))?:?\s*(\d+)")
|
||||
|
||||
|
||||
def scan_journal_text(text: str) -> list[Finding]:
|
||||
"""Parse kernel-log text into findings (separated from IO so it's testable)."""
|
||||
lines = text.splitlines()
|
||||
findings: list[Finding] = []
|
||||
|
||||
xids: dict[int, int] = {}
|
||||
for line in lines:
|
||||
if "Xid" in line:
|
||||
m = _XID_RE.search(line)
|
||||
if m:
|
||||
code = int(m.group(1))
|
||||
xids[code] = xids.get(code, 0) + 1
|
||||
for code in sorted(xids):
|
||||
severity, desc = _XID_INFO.get(code, (WARNING, f"NVIDIA GPU error (Xid {code})"))
|
||||
suggest = _XID_SUGGEST.get(code, "Look up this Xid code in NVIDIA's Xid error documentation.")
|
||||
findings.append(Finding(severity, "GPU", f"NVIDIA Xid {code} ×{xids[code]}", desc, suggest))
|
||||
|
||||
oom = sum(1 for ln in lines if "Out of memory" in ln or "oom-kill" in ln or "oom_reaper" in ln)
|
||||
if oom:
|
||||
findings.append(Finding(
|
||||
WARNING, "Memory", f"Out-of-memory kills ×{oom}",
|
||||
"The kernel killed processes to reclaim RAM.",
|
||||
"Close memory-heavy apps, add zram/swap, or investigate a leak.",
|
||||
))
|
||||
|
||||
if any("Kernel panic" in ln for ln in lines):
|
||||
findings.append(Finding(
|
||||
CRITICAL, "Kernel", "Kernel panic recorded",
|
||||
"The kernel hit an unrecoverable error.",
|
||||
"Note the panic message; review recent driver/kernel updates and hardware.",
|
||||
))
|
||||
|
||||
if any("mce:" in ln or "Machine check" in ln or "Hardware Error" in ln for ln in lines):
|
||||
findings.append(Finding(
|
||||
CRITICAL, "Hardware", "Machine Check Exception (MCE)",
|
||||
"The CPU reported a hardware error.",
|
||||
"Run memtest86 for RAM, check CPU temps/voltages, and review the MCE detail.",
|
||||
))
|
||||
|
||||
if any("AER:" in ln or "PCIe Bus Error" in ln or ("pcieport" in ln and "error" in ln.lower()) for ln in lines):
|
||||
findings.append(Finding(
|
||||
WARNING, "PCIe", "PCIe bus errors (AER)",
|
||||
"Correctable/uncorrectable PCIe errors were logged.",
|
||||
"Reseat the device and check risers/cabling; AER storms can precede a GPU drop.",
|
||||
))
|
||||
|
||||
low = [ln.lower() for ln in lines]
|
||||
if any(("thermal" in ln and ("critical" in ln or "throttl" in ln)) or "temperature above threshold" in ln for ln in low):
|
||||
findings.append(Finding(
|
||||
WARNING, "Thermal", "Thermal events logged",
|
||||
"The system logged thermal throttling / critical-temperature events.",
|
||||
"Improve airflow/cooling and check fan curves; watch live temps on the dashboard.",
|
||||
))
|
||||
|
||||
if any("amdgpu" in ln and "reset" in ln for ln in low):
|
||||
findings.append(Finding(
|
||||
CRITICAL, "GPU", "AMD GPU reset (amdgpu)",
|
||||
"The AMD GPU was reset after a hang.",
|
||||
"Check power/thermals/driver; capture a session with `rigdoctor record`.",
|
||||
))
|
||||
|
||||
return findings
|
||||
|
||||
|
||||
def _journalctl(args: list[str]) -> str | None:
|
||||
if shutil.which("journalctl") is None:
|
||||
return None
|
||||
try:
|
||||
proc = subprocess.run(["journalctl", *args], capture_output=True, text=True, timeout=25)
|
||||
return proc.stdout
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return None
|
||||
|
||||
|
||||
def check_journal() -> list[Finding]:
|
||||
out = _journalctl(["-k", "--no-pager", "-o", "cat", "--since", "-7 days"])
|
||||
if out is None:
|
||||
return [Finding(
|
||||
INFO, "Logs", "Couldn't read the kernel journal",
|
||||
"journalctl is unavailable or not readable.",
|
||||
"Ensure systemd/journald is present and your user is in the 'systemd-journal' or 'adm' group.",
|
||||
)]
|
||||
findings = scan_journal_text(out)
|
||||
if not findings:
|
||||
findings.append(Finding(
|
||||
OK, "Logs", "No notable kernel errors (last 7 days)",
|
||||
"No Xid, panic, OOM, MCE, PCIe AER, or thermal events found.",
|
||||
))
|
||||
return findings
|
||||
|
||||
|
||||
def check_previous_boot() -> list[Finding]:
|
||||
"""Scan the previous boot's kernel log — the boot that crashed — for fault signatures.
|
||||
|
||||
Needs persistent journald (else the crashed boot's logs were lost on reboot, which the
|
||||
persistence check flags separately). Findings are framed as coming from that boot.
|
||||
"""
|
||||
out = _journalctl(["-k", "-b", "-1", "--no-pager", "-o", "cat"])
|
||||
if not out or not out.strip():
|
||||
return []
|
||||
tagged = []
|
||||
for f in scan_journal_text(out):
|
||||
detail = ("Logged during the previous (crashed) boot. " + (f.detail or "")).strip()
|
||||
tagged.append(Finding(f.severity, f.category, f.title, detail, f.suggestion))
|
||||
return tagged
|
||||
|
||||
|
||||
def check_journal_persistence() -> list[Finding]:
|
||||
if Path("/var/log/journal").is_dir():
|
||||
return []
|
||||
return [Finding(
|
||||
WARNING, "Logs", "journald isn't persistent across reboots",
|
||||
"Crash-boot kernel logs are discarded on reboot, so a hard freeze's evidence can vanish.",
|
||||
"Enable persistent logging: `sudo mkdir -p /var/log/journal && sudo systemctl restart systemd-journald`",
|
||||
)]
|
||||
|
||||
|
||||
def check_nvidia_driver() -> list[Finding]:
|
||||
if shutil.which("nvidia-smi") is None:
|
||||
return []
|
||||
try:
|
||||
proc = subprocess.run(["nvidia-smi"], capture_output=True, text=True, timeout=10)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return []
|
||||
if "Driver/library version mismatch" in (proc.stdout + proc.stderr):
|
||||
return [Finding(
|
||||
CRITICAL, "Driver", "NVIDIA driver/library version mismatch",
|
||||
"The loaded kernel module and the userspace NVIDIA libraries differ — GPU monitoring will fail until resolved.",
|
||||
"Reboot to load the matching module (or finish the interrupted driver update).",
|
||||
)]
|
||||
return []
|
||||
|
||||
|
||||
def _smart_devices() -> list[str]:
|
||||
try:
|
||||
proc = subprocess.run(["smartctl", "--scan"], capture_output=True, text=True, timeout=10)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return []
|
||||
devices = []
|
||||
for line in proc.stdout.splitlines():
|
||||
line = line.strip()
|
||||
if line.startswith("/dev/"):
|
||||
devices.append(line.split()[0])
|
||||
return devices
|
||||
|
||||
|
||||
def check_smart() -> list[Finding]:
|
||||
if shutil.which("smartctl") is None:
|
||||
return [Finding(
|
||||
INFO, "Storage", "SMART not checked (smartmontools missing)",
|
||||
"Disk self-health couldn't be read.",
|
||||
"Install it for disk health checks: `sudo apt install smartmontools`",
|
||||
)]
|
||||
devices = _smart_devices()
|
||||
if not devices:
|
||||
return [Finding(
|
||||
INFO, "Storage", "SMART: couldn't enumerate drives",
|
||||
"Reading SMART usually needs root.",
|
||||
"Run: `sudo rigdoctor report`",
|
||||
)]
|
||||
findings: list[Finding] = []
|
||||
for dev in devices:
|
||||
try:
|
||||
proc = subprocess.run(["smartctl", "-H", dev], capture_output=True, text=True, timeout=15)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
continue
|
||||
combined = proc.stdout + proc.stderr
|
||||
if "Permission denied" in combined or "requires root" in combined.lower():
|
||||
findings.append(Finding(INFO, "Storage", f"SMART for {dev} needs root", "", "Run: `sudo rigdoctor report`"))
|
||||
elif "PASSED" in combined:
|
||||
findings.append(Finding(OK, "Storage", f"SMART OK: {dev}", "Overall-health self-assessment passed."))
|
||||
elif "FAILED" in combined or "FAILING_NOW" in combined:
|
||||
findings.append(Finding(CRITICAL, "Storage", f"SMART FAILED: {dev}", "The drive reports failing health.", "Back up now and replace the drive."))
|
||||
return findings
|
||||
|
||||
|
||||
def check_live_temps() -> list[Finding]:
|
||||
from .sampler import Sampler
|
||||
from .sources import available_sources
|
||||
|
||||
sample = Sampler(available_sources()).sample()
|
||||
hot = [
|
||||
(r.source, r.label or r.metric, r.value)
|
||||
for r in sample.readings
|
||||
if r.unit == "°C" and r.value is not None and r.value >= 90
|
||||
]
|
||||
if not hot:
|
||||
return []
|
||||
worst = max(hot, key=lambda x: x[2])
|
||||
detail = "; ".join(f"{s} {label} {v:.0f}°C" for s, label, v in hot)
|
||||
return [Finding(
|
||||
WARNING, "Thermal", f"High temperature right now ({worst[2]:.0f}°C)",
|
||||
detail, "Check cooling/airflow and reduce load.",
|
||||
)]
|
||||
|
||||
|
||||
def run_health_checks(include_journal: bool = True) -> list[Finding]:
|
||||
"""Run all checks and return findings sorted by severity (worst first).
|
||||
|
||||
SMART needs root; if the session collected it via launch elevation, use that
|
||||
instead of re-running smartctl (which would just report "needs root").
|
||||
|
||||
`include_journal=False` skips the 7-day kernel-journal scan — used by the crash
|
||||
analysis, which scans the previous (crashed) boot specifically instead.
|
||||
"""
|
||||
from . import elevation
|
||||
|
||||
findings: list[Finding] = []
|
||||
findings += check_nvidia_driver()
|
||||
if include_journal:
|
||||
findings += check_journal()
|
||||
findings += check_journal_persistence()
|
||||
priv = elevation.privileged()
|
||||
if priv is not None and priv.get("smart") is not None:
|
||||
findings += [Finding(**d) for d in priv["smart"]]
|
||||
else:
|
||||
findings += check_smart()
|
||||
findings += check_live_temps()
|
||||
findings.sort(key=lambda f: _ORDER.get(f.severity, 9))
|
||||
return findings
|
||||
@@ -0,0 +1,58 @@
|
||||
"""Optional-dependency installer (M9): figure out what's missing and install it.
|
||||
|
||||
apt-only (D15). Installs run via pkexec/sudo so a normal user gets a single auth
|
||||
prompt; nothing is installed without an explicit confirmation by the caller.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shlex
|
||||
import shutil
|
||||
import subprocess
|
||||
from collections.abc import Callable
|
||||
|
||||
from . import sysenv
|
||||
from .catalog import COMPONENTS, Component
|
||||
|
||||
|
||||
def component_status(present: Callable[[str], bool] | None = None) -> list[tuple[Component, bool]]:
|
||||
"""Pair each catalog component with whether it's installed (command present)."""
|
||||
present = present or sysenv.has_command
|
||||
return [(c, present(c.command)) for c in COMPONENTS]
|
||||
|
||||
|
||||
def missing_packages(components: list[Component]) -> list[str]:
|
||||
"""De-duplicated apt package list for the given components, order preserved."""
|
||||
packages: list[str] = []
|
||||
for component in components:
|
||||
for pkg in component.apt:
|
||||
if pkg not in packages:
|
||||
packages.append(pkg)
|
||||
return packages
|
||||
|
||||
|
||||
def apt_install_command(packages: list[str]) -> list[str]:
|
||||
"""Build an `apt-get update && install` command, elevated if we're not root."""
|
||||
inner = "apt-get update && apt-get install -y " + " ".join(shlex.quote(p) for p in packages)
|
||||
cmd = ["/bin/sh", "-c", inner]
|
||||
if os.geteuid() == 0:
|
||||
return cmd
|
||||
if shutil.which("pkexec"):
|
||||
return ["pkexec", *cmd]
|
||||
if shutil.which("sudo"):
|
||||
return ["sudo", *cmd]
|
||||
return cmd # no privilege escalation available — will likely fail, surfaced to the caller
|
||||
|
||||
|
||||
def install_packages(packages: list[str]) -> tuple[int, str]:
|
||||
"""Install the given packages. Returns (exit_code, combined_output)."""
|
||||
if not packages:
|
||||
return (0, "Nothing to install.")
|
||||
try:
|
||||
proc = subprocess.run(
|
||||
apt_install_command(packages), capture_output=True, text=True, timeout=900
|
||||
)
|
||||
return (proc.returncode, proc.stdout + proc.stderr)
|
||||
except (subprocess.SubprocessError, OSError) as exc:
|
||||
return (1, str(exc))
|
||||
@@ -0,0 +1,206 @@
|
||||
"""System inventory (M5): collect hardware/OS details, exportable to Markdown/JSON.
|
||||
|
||||
Stdlib + tools already used elsewhere (nvidia-smi, lspci, lsblk, dmidecode). Every
|
||||
probe degrades gracefully; board/BIOS/RAM-module details need dmidecode as root.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import platform
|
||||
import shutil
|
||||
import subprocess
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
from .. import __version__
|
||||
from . import sysenv
|
||||
|
||||
|
||||
@dataclass
|
||||
class Section:
|
||||
title: str
|
||||
items: list[tuple[str, str]]
|
||||
|
||||
|
||||
def _run(cmd: list[str], timeout: float = 12.0) -> str:
|
||||
try:
|
||||
proc = subprocess.run(cmd, capture_output=True, text=True, timeout=timeout)
|
||||
if proc.returncode == 0:
|
||||
return proc.stdout
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
pass
|
||||
return ""
|
||||
|
||||
|
||||
def _system() -> Section:
|
||||
u = os.uname()
|
||||
return Section("System", [
|
||||
("Distro", sysenv.distro_name()),
|
||||
("Kernel", u.release),
|
||||
("Architecture", u.machine),
|
||||
("Hostname", u.nodename),
|
||||
("Python", platform.python_version()),
|
||||
("RigDoctor", __version__),
|
||||
])
|
||||
|
||||
|
||||
def _cpu() -> Section:
|
||||
model = "?"
|
||||
threads = 0
|
||||
core_ids: set[tuple[str, str]] = set()
|
||||
phys = "0"
|
||||
try:
|
||||
for line in Path("/proc/cpuinfo").read_text().splitlines():
|
||||
if line.startswith("model name") and model == "?":
|
||||
model = line.split(":", 1)[1].strip()
|
||||
elif line.startswith("processor"):
|
||||
threads += 1
|
||||
elif line.startswith("physical id"):
|
||||
phys = line.split(":", 1)[1].strip()
|
||||
elif line.startswith("core id"):
|
||||
core_ids.add((phys, line.split(":", 1)[1].strip()))
|
||||
except OSError:
|
||||
pass
|
||||
items = [("Model", model)]
|
||||
if core_ids:
|
||||
items.append(("Cores", str(len(core_ids))))
|
||||
items.append(("Threads", str(threads or os.cpu_count() or "?")))
|
||||
return Section("CPU", items)
|
||||
|
||||
|
||||
def _firmware(dmi: dict) -> Section:
|
||||
board = dmi.get("baseboard", {})
|
||||
bios = dmi.get("bios", {})
|
||||
items: list[tuple[str, str]] = []
|
||||
if board:
|
||||
items.append(("Motherboard", f"{board.get('Manufacturer', '')} {board.get('Product Name', '')}".strip()))
|
||||
if bios:
|
||||
items.append(("BIOS", f"{bios.get('Vendor', '')} {bios.get('Version', '')}".strip()))
|
||||
if bios.get("Release Date"):
|
||||
items.append(("BIOS date", bios["Release Date"]))
|
||||
if not items:
|
||||
items = [("Motherboard / BIOS", "run with admin (dmidecode needs root)")]
|
||||
return Section("Firmware", items)
|
||||
|
||||
|
||||
def _memory(dmi: dict) -> Section:
|
||||
items: list[tuple[str, str]] = []
|
||||
try:
|
||||
for line in Path("/proc/meminfo").read_text().splitlines():
|
||||
if line.startswith("MemTotal"):
|
||||
items.append(("Total", f"{int(line.split()[1]) / 1024 / 1024:.1f} GB"))
|
||||
break
|
||||
except (OSError, ValueError, IndexError):
|
||||
pass
|
||||
modules = dmi.get("memory", [])
|
||||
if modules:
|
||||
items.append(("Modules", str(len(modules))))
|
||||
for i, m in enumerate(modules):
|
||||
desc = " · ".join(p for p in (m.get("Size"), m.get("Type"), m.get("Speed"), m.get("Part Number")) if p)
|
||||
items.append((f"Slot {i}", desc))
|
||||
elif shutil.which("dmidecode"):
|
||||
items.append(("Modules", "run with admin for module details"))
|
||||
return Section("Memory", items)
|
||||
|
||||
|
||||
def _gpu() -> Section:
|
||||
if shutil.which("nvidia-smi"):
|
||||
out = _run([
|
||||
"nvidia-smi",
|
||||
"--query-gpu=name,driver_version,vbios_version,memory.total,pcie.link.gen.max,pcie.link.width.max",
|
||||
"--format=csv,noheader",
|
||||
])
|
||||
line = out.strip().splitlines()[0] if out.strip() else ""
|
||||
if line:
|
||||
cols = [c.strip() for c in line.split(",")]
|
||||
keys = ["Name", "Driver", "VBIOS", "VRAM", "PCIe gen (max)", "PCIe width (max)"]
|
||||
return Section("GPU", list(zip(keys, cols)))
|
||||
out = _run(["lspci"])
|
||||
gpus = [ln.split(":", 2)[-1].strip() for ln in out.splitlines()
|
||||
if "VGA compatible controller" in ln or "3D controller" in ln]
|
||||
return Section("GPU", [("Device", g) for g in gpus] or [("Device", "unknown")])
|
||||
|
||||
|
||||
def _storage() -> Section:
|
||||
items: list[tuple[str, str]] = []
|
||||
# TYPE first so MODEL (which can contain spaces) is the trailing field.
|
||||
out = _run(["lsblk", "-dn", "-o", "TYPE,NAME,SIZE,MODEL"])
|
||||
for line in out.strip().splitlines():
|
||||
parts = line.split(None, 3)
|
||||
if len(parts) < 3 or parts[0] != "disk": # skip loop/zram/rom devices
|
||||
continue
|
||||
name, size = parts[1], parts[2]
|
||||
model = parts[3] if len(parts) > 3 else ""
|
||||
items.append((name, f"{model} ({size})".strip()))
|
||||
return Section("Storage", items or [("Disks", "unknown")])
|
||||
|
||||
|
||||
def _display() -> Section:
|
||||
return Section("Display", [
|
||||
("Session", os.environ.get("XDG_SESSION_TYPE", "unknown")),
|
||||
("Desktop", os.environ.get("XDG_CURRENT_DESKTOP") or os.environ.get("DESKTOP_SESSION", "unknown")),
|
||||
])
|
||||
|
||||
|
||||
def _dmidecode() -> dict:
|
||||
if not shutil.which("dmidecode"):
|
||||
return {}
|
||||
out = _run(["dmidecode", "-t", "baseboard", "-t", "bios", "-t", "memory"], timeout=15)
|
||||
if not out.strip():
|
||||
return {}
|
||||
result: dict = {"baseboard": {}, "bios": {}, "memory": []}
|
||||
for block in out.split("Handle "):
|
||||
lines = block.splitlines()
|
||||
if len(lines) < 2:
|
||||
continue
|
||||
title = lines[1].strip()
|
||||
kv: dict[str, str] = {}
|
||||
for ln in lines[2:]:
|
||||
if ln.startswith("\t") and ":" in ln:
|
||||
key, _, value = ln.strip().partition(":")
|
||||
kv[key.strip()] = value.strip()
|
||||
if title == "Base Board Information":
|
||||
result["baseboard"] = kv
|
||||
elif title == "BIOS Information":
|
||||
result["bios"] = kv
|
||||
elif title == "Memory Device" and kv.get("Size") and kv["Size"] != "No Module Installed":
|
||||
result["memory"].append(kv)
|
||||
return result
|
||||
|
||||
|
||||
def collect() -> list[Section]:
|
||||
from . import elevation
|
||||
|
||||
priv = elevation.privileged()
|
||||
dmi = priv["dmidecode"] if (priv and priv.get("dmidecode") is not None) else _dmidecode()
|
||||
return [_system(), _cpu(), _firmware(dmi), _memory(dmi), _gpu(), _storage(), _display()]
|
||||
|
||||
|
||||
def to_dict(sections: list[Section]) -> dict:
|
||||
return {s.title: dict(s.items) for s in sections}
|
||||
|
||||
|
||||
def from_dict(data: dict) -> list[Section]:
|
||||
return [Section(title, list(items.items())) for title, items in data.items()]
|
||||
|
||||
|
||||
def render_markdown(sections: list[Section]) -> str:
|
||||
out = ["# RigDoctor system inventory", ""]
|
||||
for s in sections:
|
||||
out.append(f"## {s.title}")
|
||||
out += [f"- **{k}:** {v}" for k, v in s.items]
|
||||
out.append("")
|
||||
return "\n".join(out).strip() + "\n"
|
||||
|
||||
|
||||
def render_text(sections: list[Section]) -> str:
|
||||
blocks = []
|
||||
for s in sections:
|
||||
blocks.append("\n".join([s.title] + [f" {k:<18} {v}" for k, v in s.items]))
|
||||
return "\n\n".join(blocks)
|
||||
|
||||
|
||||
def render_json(sections: list[Section]) -> str:
|
||||
return json.dumps(to_dict(sections), indent=2, ensure_ascii=False)
|
||||
@@ -0,0 +1,89 @@
|
||||
"""Non-Steam game detection (M6): Lutris + Heroic installed games.
|
||||
|
||||
Reads each launcher's own install records (Lutris' SQLite library, Heroic's JSON stores),
|
||||
returning the same `steam.Game` shape tagged with the launcher. Stdlib only; every reader
|
||||
degrades to [] if the launcher isn't installed or its files can't be parsed.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import sqlite3
|
||||
from pathlib import Path
|
||||
|
||||
from .steam import Game
|
||||
|
||||
LUTRIS_DB = Path(os.path.expanduser("~/.local/share/lutris/pga.db"))
|
||||
HEROIC_DIR = Path(os.path.expanduser("~/.config/heroic"))
|
||||
|
||||
|
||||
def _lutris_games() -> list[Game]:
|
||||
db = LUTRIS_DB
|
||||
if not db.exists():
|
||||
return []
|
||||
games: list[Game] = []
|
||||
try:
|
||||
con = sqlite3.connect(f"file:{db}?mode=ro", uri=True) # read-only
|
||||
try:
|
||||
rows = con.execute(
|
||||
"SELECT name, slug FROM games WHERE installed = 1 AND name IS NOT NULL"
|
||||
).fetchall()
|
||||
finally:
|
||||
con.close()
|
||||
except (sqlite3.Error, OSError):
|
||||
return []
|
||||
for name, slug in rows:
|
||||
if name:
|
||||
games.append(Game(appid=slug or "", name=str(name), library="", installdir="",
|
||||
launcher="lutris"))
|
||||
return games
|
||||
|
||||
|
||||
def _read_json(path: Path):
|
||||
try:
|
||||
return json.loads(path.read_text())
|
||||
except (OSError, ValueError):
|
||||
return None
|
||||
|
||||
|
||||
def _heroic_games() -> list[Game]:
|
||||
base = HEROIC_DIR
|
||||
if not base.is_dir():
|
||||
return []
|
||||
games: list[Game] = []
|
||||
|
||||
# Epic / Legendary: {app_name: {"title": ..., ...}}
|
||||
epic = _read_json(base / "legendaryConfig" / "legendary" / "installed.json")
|
||||
if isinstance(epic, dict):
|
||||
for app_name, info in epic.items():
|
||||
if isinstance(info, dict):
|
||||
games.append(Game(appid=str(app_name), name=info.get("title") or str(app_name),
|
||||
library="", installdir="", launcher="heroic"))
|
||||
|
||||
# GOG: {"installed": [{"appName", "install_path", "title"?}]}
|
||||
gog = _read_json(base / "gog_store" / "installed.json")
|
||||
entries = gog.get("installed") if isinstance(gog, dict) else None
|
||||
if isinstance(entries, list):
|
||||
for e in entries:
|
||||
if not isinstance(e, dict):
|
||||
continue
|
||||
install_path = e.get("install_path") or ""
|
||||
title = e.get("title") or os.path.basename(install_path.rstrip("/")) or str(e.get("appName", ""))
|
||||
if title:
|
||||
games.append(Game(appid=str(e.get("appName", "")), name=title, library="",
|
||||
installdir="", launcher="heroic"))
|
||||
return games
|
||||
|
||||
|
||||
def scan() -> list[Game]:
|
||||
"""Installed non-Steam games (Lutris + Heroic), de-duplicated, sorted by name."""
|
||||
seen: set[tuple[str, str]] = set()
|
||||
out: list[Game] = []
|
||||
for game in _lutris_games() + _heroic_games():
|
||||
key = (game.launcher, game.name)
|
||||
if key in seen:
|
||||
continue
|
||||
seen.add(key)
|
||||
out.append(game)
|
||||
return sorted(out, key=lambda g: g.name.lower())
|
||||
@@ -0,0 +1,59 @@
|
||||
"""A pseudo-terminal running the host's shell (M12, Tier 3 — host side).
|
||||
|
||||
Spawns the user's login shell in a real PTY so interactive programs work over a shared
|
||||
session: vim, top, tab-completion, colours, Ctrl-C, and `sudo` (which prompts inside the
|
||||
PTY — the host types that password locally, so it's never sent to the guest). Runs as the
|
||||
host's own user — never elevated. Linux-only (uses `pty`/`termios`).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import fcntl
|
||||
import os
|
||||
import pty
|
||||
import signal
|
||||
import struct
|
||||
import termios
|
||||
|
||||
|
||||
class PtySession:
|
||||
def __init__(self, rows: int = 24, cols: int = 80):
|
||||
self.pid, self.master_fd = pty.fork()
|
||||
if self.pid == 0: # child: become the shell
|
||||
os.environ["TERM"] = "xterm-256color"
|
||||
shell = os.environ.get("SHELL", "/bin/bash")
|
||||
try:
|
||||
os.execvp(shell, [shell])
|
||||
finally:
|
||||
os._exit(1)
|
||||
os.set_blocking(self.master_fd, False)
|
||||
self.set_size(rows, cols)
|
||||
|
||||
def set_size(self, rows: int, cols: int) -> None:
|
||||
try:
|
||||
fcntl.ioctl(self.master_fd, termios.TIOCSWINSZ, struct.pack("HHHH", rows, cols, 0, 0))
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
def write(self, data: bytes) -> None:
|
||||
try:
|
||||
os.write(self.master_fd, data)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
def read(self, size: int = 65536) -> bytes:
|
||||
try:
|
||||
return os.read(self.master_fd, size)
|
||||
except (BlockingIOError, OSError):
|
||||
return b""
|
||||
|
||||
def close(self) -> None:
|
||||
try:
|
||||
os.close(self.master_fd)
|
||||
except OSError:
|
||||
pass
|
||||
try:
|
||||
os.kill(self.pid, signal.SIGHUP)
|
||||
os.waitpid(self.pid, os.WNOHANG)
|
||||
except (OSError, ChildProcessError, ProcessLookupError):
|
||||
pass
|
||||
@@ -38,7 +38,9 @@ def read_status() -> dict | None:
|
||||
return None
|
||||
|
||||
|
||||
def start_background(interval: float | None = None, out: str | None = None) -> int | None:
|
||||
def start_background(
|
||||
interval: float | None = None, out: str | None = None, game: str | None = None
|
||||
) -> int | None:
|
||||
"""Spawn a detached `record run`. Returns the child pid, or None if already running."""
|
||||
if running_pid():
|
||||
return None
|
||||
@@ -48,6 +50,8 @@ def start_background(interval: float | None = None, out: str | None = None) -> i
|
||||
cmd += ["--interval", str(interval)]
|
||||
if out:
|
||||
cmd += ["--out", out]
|
||||
if game:
|
||||
cmd += ["--game", game]
|
||||
out_fh = open(config.SPAWN_LOG, "a")
|
||||
proc = subprocess.Popen(
|
||||
cmd,
|
||||
|
||||
@@ -27,12 +27,14 @@ class Recorder:
|
||||
backups: int = 10,
|
||||
status_path=None,
|
||||
sampler: Sampler | None = None,
|
||||
game: str | None = None,
|
||||
) -> None:
|
||||
self.interval = interval
|
||||
self.sampler = sampler or Sampler(available_sources())
|
||||
self.writer = CrashLogWriter(log_path, max_bytes, backups)
|
||||
self.log_path = Path(log_path)
|
||||
self.status_path = Path(status_path) if status_path else None
|
||||
self.game = game or None
|
||||
self.samples = 0
|
||||
self._stop = threading.Event()
|
||||
self._gpu_lost = False
|
||||
@@ -43,6 +45,8 @@ class Recorder:
|
||||
|
||||
def run(self) -> None:
|
||||
self.writer.write_event("session-start", f"interval={self.interval:g}s")
|
||||
if self.game:
|
||||
self.writer.write_event("game", self.game) # tag the focused-diagnostic target
|
||||
self._write_status(running=True)
|
||||
try:
|
||||
while not self._stop.is_set():
|
||||
@@ -81,6 +85,7 @@ class Recorder:
|
||||
"samples": self.samples,
|
||||
"updated": time.time(),
|
||||
"gpu_lost": self._gpu_lost,
|
||||
"game": self.game,
|
||||
}
|
||||
if sample is not None:
|
||||
data["latest"] = headline(sample)
|
||||
|
||||
@@ -0,0 +1,118 @@
|
||||
"""`systemd --user` services for the crash logger + game watcher (M9 / D6 trigger modes).
|
||||
|
||||
Three trigger modes (D6): **manual** (no service — start/stop by hand), **always-on** (a user
|
||||
service samples continuously, bounded by log rotation), and **game-launch** (a watcher service
|
||||
auto-brackets a capture around each game). No root: everything is a `systemd --user` unit in
|
||||
``~/.config/systemd/user``. Degrades gracefully when systemd isn't available.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from .. import config
|
||||
|
||||
UNIT_DIR = Path(os.path.expanduser("~/.config/systemd/user"))
|
||||
RECORDER_UNIT = "rigdoctor-recorder.service"
|
||||
WATCH_UNIT = "rigdoctor-watch.service"
|
||||
MODES = ("manual", "always-on", "game-launch")
|
||||
|
||||
_UNITS = {
|
||||
RECORDER_UNIT: ("RigDoctor crash-capture recorder (always-on)", ["record", "run"]),
|
||||
WATCH_UNIT: ("RigDoctor game-launch watcher", ["watch"]),
|
||||
}
|
||||
|
||||
|
||||
def available() -> bool:
|
||||
return shutil.which("systemctl") is not None
|
||||
|
||||
|
||||
def _rigdoctor_bin() -> str:
|
||||
exe = Path(sys.executable).with_name("rigdoctor") # next to the venv python
|
||||
if exe.exists():
|
||||
return str(exe)
|
||||
return shutil.which("rigdoctor") or "rigdoctor"
|
||||
|
||||
|
||||
def _systemctl(*args: str) -> tuple[int, str]:
|
||||
try:
|
||||
proc = subprocess.run(["systemctl", "--user", *args],
|
||||
capture_output=True, text=True, timeout=20)
|
||||
return proc.returncode, (proc.stdout + proc.stderr).strip()
|
||||
except (OSError, subprocess.SubprocessError) as exc:
|
||||
return 1, str(exc)
|
||||
|
||||
|
||||
def unit_text(description: str, args: list[str]) -> str:
|
||||
exec_cmd = " ".join([_rigdoctor_bin(), *args])
|
||||
return (
|
||||
"[Unit]\n"
|
||||
f"Description={description}\n\n"
|
||||
"[Service]\n"
|
||||
"Type=simple\n"
|
||||
f"ExecStart={exec_cmd}\n"
|
||||
"Restart=on-failure\n"
|
||||
"RestartSec=5\n\n"
|
||||
"[Install]\n"
|
||||
"WantedBy=default.target\n"
|
||||
)
|
||||
|
||||
|
||||
def install_units() -> None:
|
||||
"""Write/refresh both unit files and reload systemd (idempotent)."""
|
||||
UNIT_DIR.mkdir(parents=True, exist_ok=True)
|
||||
for name, (desc, args) in _UNITS.items():
|
||||
(UNIT_DIR / name).write_text(unit_text(desc, args))
|
||||
_systemctl("daemon-reload")
|
||||
|
||||
|
||||
def is_active(name: str) -> bool:
|
||||
return _systemctl("is-active", name)[0] == 0
|
||||
|
||||
|
||||
def is_enabled(name: str) -> bool:
|
||||
return _systemctl("is-enabled", name)[0] == 0
|
||||
|
||||
|
||||
def _enable(name: str) -> tuple[int, str]:
|
||||
return _systemctl("enable", "--now", name)
|
||||
|
||||
|
||||
def _disable(name: str) -> tuple[int, str]:
|
||||
return _systemctl("disable", "--now", name)
|
||||
|
||||
|
||||
def apply_mode(mode: str) -> tuple[bool, str]:
|
||||
"""Reconcile the user services to `mode` and persist it. Returns (ok, message)."""
|
||||
if mode not in MODES:
|
||||
return False, f"Unknown trigger mode: {mode}"
|
||||
if not available():
|
||||
config.update_config(trigger_mode=mode)
|
||||
return False, "systemd --user isn't available — mode saved, but no service was changed."
|
||||
install_units()
|
||||
if mode == "always-on":
|
||||
_disable(WATCH_UNIT)
|
||||
rc, out = _enable(RECORDER_UNIT)
|
||||
elif mode == "game-launch":
|
||||
_disable(RECORDER_UNIT)
|
||||
rc, out = _enable(WATCH_UNIT)
|
||||
else: # manual
|
||||
_disable(RECORDER_UNIT)
|
||||
_disable(WATCH_UNIT)
|
||||
rc, out = 0, ""
|
||||
config.update_config(trigger_mode=mode)
|
||||
return rc == 0, out
|
||||
|
||||
|
||||
def status() -> dict:
|
||||
"""Current trigger mode (config) + live service states (best-effort)."""
|
||||
cfg = config.load_config()
|
||||
info = {"available": available(), "mode": cfg.get("trigger_mode", "manual")}
|
||||
if info["available"]:
|
||||
info["recorder_active"] = is_active(RECORDER_UNIT)
|
||||
info["watch_active"] = is_active(WATCH_UNIT)
|
||||
return info
|
||||
@@ -0,0 +1,399 @@
|
||||
"""Steam library & game detection (M6, the Steam piece of D12 game detection).
|
||||
|
||||
Discovers a user's Steam installs, the library folders they've configured (Steam tracks
|
||||
them all in ``libraryfolders.vdf``, so multiple libraries on multiple drives are covered),
|
||||
and the games installed in each (one ``appmanifest_<appid>.acf`` per app). Stdlib only —
|
||||
no Steam tooling required, every probe degrades gracefully.
|
||||
|
||||
The set of libraries actually scanned is user-chosen (config ``steam_libraries``); nothing
|
||||
is scanned until the user opts a library in. Scan results are cached in ``games.json`` so the
|
||||
GUI can show the list instantly and the launch-time background scan can diff against it to
|
||||
flag newly-installed games.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import time
|
||||
from dataclasses import asdict, dataclass
|
||||
from pathlib import Path
|
||||
|
||||
from ..config import GAMES_FILE, load_config
|
||||
|
||||
# Steam "apps" that aren't games: runtimes, Proton builds, redistributables. Filtered out of
|
||||
# scans by appid (known IDs) or by name prefix (covers future Proton/runtime versions).
|
||||
_TOOL_APPIDS = {
|
||||
"228980", # Steamworks Common Redistributables
|
||||
"1070560", # Steam Linux Runtime 1.0 (scout)
|
||||
"1391110", # Steam Linux Runtime 2.0 (soldier)
|
||||
"1628350", # Steam Linux Runtime 3.0 (sniper)
|
||||
"1493710", # Proton Experimental
|
||||
"2180100", # Proton Hotfix
|
||||
"1826330", # Proton EasyAntiCheat Runtime
|
||||
"1161040", # Proton BattlEye Runtime
|
||||
}
|
||||
_TOOL_NAME_PREFIXES = ("Proton", "Steam Linux Runtime", "Steamworks Common")
|
||||
|
||||
# Where Steam may be installed (native + Flatpak + Snap). Symlinks (~/.steam/steam) are
|
||||
# resolved and de-duplicated by real path.
|
||||
_ROOT_CANDIDATES = (
|
||||
"~/.steam/steam",
|
||||
"~/.steam/root",
|
||||
"~/.local/share/Steam",
|
||||
"~/.var/app/com.valvesoftware.Steam/data/Steam", # Flatpak
|
||||
"~/snap/steam/common/.local/share/Steam", # Snap
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class SteamLibrary:
|
||||
path: str # the library root (contains a steamapps/ dir)
|
||||
label: str = "" # Steam's label for the folder, if any
|
||||
|
||||
|
||||
@dataclass
|
||||
class Game:
|
||||
appid: str
|
||||
name: str
|
||||
library: str # library path the game lives in (Steam)
|
||||
installdir: str # folder name under <library>/steamapps/common
|
||||
size_bytes: int = 0
|
||||
last_updated: int = 0 # epoch seconds (acf LastUpdated), 0 if unknown
|
||||
launcher: str = "steam" # "steam" | "lutris" | "heroic"
|
||||
|
||||
|
||||
# --- VDF (Valve Data Format) parsing --------------------------------------------------
|
||||
# Minimal text-VDF reader: quoted "key" "value" pairs and "key" { ... } nesting. Enough
|
||||
# for libraryfolders.vdf and appmanifest_*.acf; ignores #base/#include and unquoted tokens.
|
||||
|
||||
def _parse_vdf(text: str) -> dict:
|
||||
pos = 0
|
||||
n = len(text)
|
||||
|
||||
def skip_ws() -> None:
|
||||
nonlocal pos
|
||||
while pos < n:
|
||||
c = text[pos]
|
||||
if c in " \t\r\n":
|
||||
pos += 1
|
||||
elif c == "/" and pos + 1 < n and text[pos + 1] == "/": # // line comment
|
||||
while pos < n and text[pos] != "\n":
|
||||
pos += 1
|
||||
else:
|
||||
break
|
||||
|
||||
def read_string() -> str:
|
||||
nonlocal pos
|
||||
pos += 1 # opening quote
|
||||
out = []
|
||||
while pos < n:
|
||||
c = text[pos]
|
||||
if c == "\\" and pos + 1 < n:
|
||||
nxt = text[pos + 1]
|
||||
out.append({"n": "\n", "t": "\t", "\\": "\\", '"': '"'}.get(nxt, nxt))
|
||||
pos += 2
|
||||
continue
|
||||
if c == '"':
|
||||
pos += 1
|
||||
break
|
||||
out.append(c)
|
||||
pos += 1
|
||||
return "".join(out)
|
||||
|
||||
def parse_obj() -> dict:
|
||||
nonlocal pos
|
||||
obj: dict = {}
|
||||
while True:
|
||||
skip_ws()
|
||||
if pos >= n or text[pos] == "}":
|
||||
pos += 1 # consume closing brace (or run off the end)
|
||||
return obj
|
||||
if text[pos] != '"': # skip unquoted/unsupported tokens defensively
|
||||
pos += 1
|
||||
continue
|
||||
key = read_string()
|
||||
skip_ws()
|
||||
if pos < n and text[pos] == "{":
|
||||
pos += 1
|
||||
obj[key] = parse_obj()
|
||||
elif pos < n and text[pos] == '"':
|
||||
obj[key] = read_string()
|
||||
else: # malformed; bail on this key
|
||||
obj[key] = ""
|
||||
return obj
|
||||
|
||||
skip_ws()
|
||||
if pos < n and text[pos] == '"':
|
||||
root_key = read_string()
|
||||
skip_ws()
|
||||
if pos < n and text[pos] == "{":
|
||||
pos += 1
|
||||
return {root_key: parse_obj()}
|
||||
return {}
|
||||
|
||||
|
||||
def _read_vdf(path: Path) -> dict:
|
||||
try:
|
||||
return _parse_vdf(path.read_text(encoding="utf-8", errors="replace"))
|
||||
except OSError:
|
||||
return {}
|
||||
|
||||
|
||||
# --- discovery ------------------------------------------------------------------------
|
||||
|
||||
def steam_roots() -> list[Path]:
|
||||
"""Existing Steam install roots, de-duplicated by resolved path."""
|
||||
seen: set[Path] = set()
|
||||
roots: list[Path] = []
|
||||
for cand in _ROOT_CANDIDATES:
|
||||
p = Path(os.path.expanduser(cand))
|
||||
if not p.exists():
|
||||
continue
|
||||
real = p.resolve()
|
||||
if real in seen:
|
||||
continue
|
||||
seen.add(real)
|
||||
roots.append(real)
|
||||
return roots
|
||||
|
||||
|
||||
def _libraryfolders_vdf(root: Path) -> Path | None:
|
||||
for rel in ("steamapps/libraryfolders.vdf", "config/libraryfolders.vdf"):
|
||||
p = root / rel
|
||||
if p.exists():
|
||||
return p
|
||||
return None
|
||||
|
||||
|
||||
def discover_libraries() -> list[SteamLibrary]:
|
||||
"""Every Steam library folder configured on this machine, de-duplicated by real path.
|
||||
|
||||
Reads each install's ``libraryfolders.vdf`` (which lists all drives/folders), and
|
||||
always includes the install root itself as a fallback.
|
||||
"""
|
||||
seen: set[Path] = set()
|
||||
libs: list[SteamLibrary] = []
|
||||
|
||||
def add(path: Path, label: str = "") -> None:
|
||||
if not (path / "steamapps").is_dir():
|
||||
return
|
||||
real = path.resolve()
|
||||
if real in seen:
|
||||
return
|
||||
seen.add(real)
|
||||
libs.append(SteamLibrary(path=str(real), label=label))
|
||||
|
||||
for root in steam_roots():
|
||||
vdf = _libraryfolders_vdf(root)
|
||||
folders = _read_vdf(vdf).get("libraryfolders", {}) if vdf else {}
|
||||
if isinstance(folders, dict):
|
||||
for entry in folders.values():
|
||||
if isinstance(entry, dict) and entry.get("path"):
|
||||
add(Path(entry["path"]), entry.get("label", ""))
|
||||
add(root) # the install root is itself a library
|
||||
return libs
|
||||
|
||||
|
||||
# --- game scanning --------------------------------------------------------------------
|
||||
|
||||
def is_tool(appid: str, name: str) -> bool:
|
||||
"""True for non-game Steam apps (runtimes, Proton, redistributables)."""
|
||||
if appid in _TOOL_APPIDS:
|
||||
return True
|
||||
return name.startswith(_TOOL_NAME_PREFIXES)
|
||||
|
||||
|
||||
def scan_library(library: str) -> list[Game]:
|
||||
"""Games installed in one library, parsed from its appmanifest_*.acf files."""
|
||||
steamapps = Path(library) / "steamapps"
|
||||
games: list[Game] = []
|
||||
try:
|
||||
manifests = sorted(steamapps.glob("appmanifest_*.acf"))
|
||||
except OSError:
|
||||
return games
|
||||
for manifest in manifests:
|
||||
state = _read_vdf(manifest).get("AppState", {})
|
||||
if not isinstance(state, dict):
|
||||
continue
|
||||
# Steam treats VDF keys case-insensitively (e.g. "SizeOnDisk" but "lastupdated").
|
||||
state = {k.lower(): v for k, v in state.items()}
|
||||
appid = state.get("appid", "")
|
||||
name = state.get("name", "").strip()
|
||||
if not appid or not name or is_tool(appid, name):
|
||||
continue
|
||||
games.append(Game(
|
||||
appid=appid,
|
||||
name=name,
|
||||
library=str(library),
|
||||
installdir=state.get("installdir", ""),
|
||||
size_bytes=_int(state.get("sizeondisk")),
|
||||
last_updated=_int(state.get("lastupdated")),
|
||||
))
|
||||
return games
|
||||
|
||||
|
||||
def scan_games(libraries: list[str]) -> list[Game]:
|
||||
"""All games across the given libraries, de-duplicated by appid, sorted by name."""
|
||||
by_appid: dict[str, Game] = {}
|
||||
for lib in libraries:
|
||||
for game in scan_library(lib):
|
||||
by_appid.setdefault(game.appid, game) # first library wins on duplicates
|
||||
return sorted(by_appid.values(), key=lambda g: g.name.lower())
|
||||
|
||||
|
||||
def _int(value) -> int:
|
||||
try:
|
||||
return int(value)
|
||||
except (TypeError, ValueError):
|
||||
return 0
|
||||
|
||||
|
||||
def proton_versions() -> list[str]:
|
||||
"""Installed Proton compatibility-tool versions across all discovered libraries.
|
||||
|
||||
Proton builds are the appmanifests we filter out of game scans; here we surface them
|
||||
for the M6 environment report. Returns unique names, newest-looking last.
|
||||
"""
|
||||
names: set[str] = set()
|
||||
for lib in discover_libraries():
|
||||
try:
|
||||
manifests = sorted((Path(lib.path) / "steamapps").glob("appmanifest_*.acf"))
|
||||
except OSError:
|
||||
continue
|
||||
for manifest in manifests:
|
||||
state = _read_vdf(manifest).get("AppState", {})
|
||||
if isinstance(state, dict):
|
||||
state = {k.lower(): v for k, v in state.items()}
|
||||
name = state.get("name", "").strip()
|
||||
if name.startswith("Proton"):
|
||||
names.add(name)
|
||||
return sorted(names)
|
||||
|
||||
|
||||
# --- config-driven selection ----------------------------------------------------------
|
||||
|
||||
def selected_library_paths(cfg: dict | None = None) -> list[str]:
|
||||
"""Library paths the user has opted in to scanning (config ``steam_libraries``)."""
|
||||
cfg = cfg or load_config()
|
||||
paths = cfg.get("steam_libraries") or []
|
||||
return [str(p) for p in paths]
|
||||
|
||||
|
||||
# --- scan cache + new-game detection --------------------------------------------------
|
||||
|
||||
@dataclass
|
||||
class ScanResult:
|
||||
games: list[Game]
|
||||
new_appids: list[str] # newly-installed since the last scan (badge fuel)
|
||||
scanned_at: float
|
||||
|
||||
|
||||
def load_cache() -> dict | None:
|
||||
try:
|
||||
return json.loads(GAMES_FILE.read_text())
|
||||
except (OSError, ValueError):
|
||||
return None
|
||||
|
||||
|
||||
def _save_cache(games: list[Game], known: set[str], new: list[str], when: float) -> None:
|
||||
GAMES_FILE.parent.mkdir(parents=True, exist_ok=True)
|
||||
data = {
|
||||
"scanned_at": when,
|
||||
"known_appids": sorted(known),
|
||||
"new_appids": new,
|
||||
"games": [asdict(g) for g in games],
|
||||
}
|
||||
GAMES_FILE.write_text(json.dumps(data, indent=2, ensure_ascii=False))
|
||||
|
||||
|
||||
def cached_games() -> list[Game]:
|
||||
"""Games from the last scan (for instant display before a rescan finishes)."""
|
||||
cache = load_cache()
|
||||
if not cache:
|
||||
return []
|
||||
# Only pass keys present in the record so dataclass defaults fill any new fields.
|
||||
return [Game(**{k: g[k] for k in Game.__dataclass_fields__ if k in g}) for g in cache.get("games", [])]
|
||||
|
||||
|
||||
def rescan(cfg: dict | None = None) -> ScanResult:
|
||||
"""Scan the selected libraries, diff against the cache, and persist the result.
|
||||
|
||||
Newly-installed games (appids never seen before) are reported in ``new_appids``. The
|
||||
very first scan reports nothing as new (so the whole library isn't flagged at once);
|
||||
unacknowledged new games carry forward until they're acknowledged or uninstalled.
|
||||
"""
|
||||
games = scan_games(selected_library_paths(cfg))
|
||||
current = {g.appid for g in games}
|
||||
prev = load_cache()
|
||||
if prev is None:
|
||||
known: set[str] = set(current) # first run: everything is "known", nothing new
|
||||
new = []
|
||||
else:
|
||||
known = set(prev.get("known_appids", []))
|
||||
carried = set(prev.get("new_appids", [])) & current # still-unacknowledged & installed
|
||||
new = sorted((current - known) | carried)
|
||||
known |= current
|
||||
when = time.time()
|
||||
_save_cache(games, known, new, when)
|
||||
return ScanResult(games=games, new_appids=new, scanned_at=when)
|
||||
|
||||
|
||||
def acknowledge_new() -> None:
|
||||
"""Clear the new-game badge (called when the user views the games list)."""
|
||||
cache = load_cache()
|
||||
if not cache or not cache.get("new_appids"):
|
||||
return
|
||||
cache["new_appids"] = []
|
||||
try:
|
||||
GAMES_FILE.write_text(json.dumps(cache, indent=2, ensure_ascii=False))
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
# --- formatting -----------------------------------------------------------------------
|
||||
|
||||
def client_version() -> str | None:
|
||||
"""The installed Steam package version (apt), or None — best-effort, offline."""
|
||||
if shutil.which("dpkg-query") is None:
|
||||
return None
|
||||
for pkg in ("steam-installer", "steam-launcher", "steam"):
|
||||
try:
|
||||
proc = subprocess.run(["dpkg-query", "-W", "-f=${Version}", pkg],
|
||||
capture_output=True, text=True, timeout=10)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
continue
|
||||
if proc.returncode == 0 and proc.stdout.strip():
|
||||
return proc.stdout.strip()
|
||||
return None
|
||||
|
||||
|
||||
def launch_game(appid: str) -> bool:
|
||||
"""Best-effort: ask Steam to launch a game by appid (steam:// URL). Non-blocking."""
|
||||
if not appid:
|
||||
return False
|
||||
url = f"steam://rungameid/{appid}"
|
||||
for cmd in (["steam", url], ["xdg-open", url]):
|
||||
if shutil.which(cmd[0]):
|
||||
try:
|
||||
subprocess.Popen(
|
||||
cmd, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL,
|
||||
stdin=subprocess.DEVNULL, start_new_session=True,
|
||||
)
|
||||
return True
|
||||
except (OSError, subprocess.SubprocessError):
|
||||
continue
|
||||
return False
|
||||
|
||||
|
||||
def human_size(num_bytes: int) -> str:
|
||||
if num_bytes <= 0:
|
||||
return "—"
|
||||
size = float(num_bytes)
|
||||
for unit in ("B", "KB", "MB", "GB", "TB"):
|
||||
if size < 1024 or unit == "TB":
|
||||
return f"{size:.0f} {unit}" if unit in ("B", "KB") else f"{size:.1f} {unit}"
|
||||
size /= 1024
|
||||
return f"{size:.1f} TB"
|
||||
@@ -0,0 +1,49 @@
|
||||
"""Environment detection for the installer (M9)."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
import subprocess
|
||||
|
||||
|
||||
def package_manager() -> str | None:
|
||||
"""Only apt is supported (D15); return 'apt' if present, else None."""
|
||||
if shutil.which("apt-get") or shutil.which("apt"):
|
||||
return "apt"
|
||||
return None
|
||||
|
||||
|
||||
def has_command(cmd: str) -> bool:
|
||||
return shutil.which(cmd) is not None
|
||||
|
||||
|
||||
def distro_name() -> str:
|
||||
try:
|
||||
data: dict[str, str] = {}
|
||||
with open("/etc/os-release") as f:
|
||||
for line in f:
|
||||
key, _, value = line.partition("=")
|
||||
data[key.strip()] = value.strip().strip('"')
|
||||
return data.get("PRETTY_NAME") or data.get("NAME") or "Linux"
|
||||
except OSError:
|
||||
return "Linux"
|
||||
|
||||
|
||||
def gpu_vendors() -> list[str]:
|
||||
vendors: list[str] = []
|
||||
if shutil.which("nvidia-smi"):
|
||||
vendors.append("NVIDIA")
|
||||
out = ""
|
||||
if shutil.which("lspci"):
|
||||
try:
|
||||
out = subprocess.run(["lspci"], capture_output=True, text=True, timeout=10).stdout
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
out = ""
|
||||
low = out.lower()
|
||||
if "nvidia" in low and "NVIDIA" not in vendors:
|
||||
vendors.append("NVIDIA")
|
||||
if ("amd/ati" in low or "advanced micro devices" in low or "radeon" in low) and "AMD" not in vendors:
|
||||
vendors.append("AMD")
|
||||
if "intel" in low and any(k in low for k in ("vga", "display", "graphics")) and "Intel" not in vendors:
|
||||
vendors.append("Intel")
|
||||
return vendors
|
||||
@@ -0,0 +1,42 @@
|
||||
"""Uninstall the user-local RigDoctor install (app files; optionally all data).
|
||||
|
||||
Mirrors `install.sh --uninstall`. The removal runs in a detached shell so it can
|
||||
delete the venv the current process is running from once we exit.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shlex
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
|
||||
from .. import config
|
||||
from . import reccontrol
|
||||
|
||||
|
||||
def targets(purge: bool = False) -> list[Path]:
|
||||
"""Paths removed by an uninstall. With purge, also config/state/logs."""
|
||||
home = Path.home()
|
||||
share = config.DATA_DIR.parent # ~/.local/share
|
||||
items = [
|
||||
config.DATA_DIR / "venv",
|
||||
home / ".local" / "bin" / "rigdoctor",
|
||||
home / ".local" / "bin" / "rigdoctor-gui",
|
||||
share / "applications" / "rigdoctor.desktop",
|
||||
share / "icons" / "hicolor" / "scalable" / "apps" / "rigdoctor.svg",
|
||||
]
|
||||
if purge:
|
||||
items += [config.CONFIG_DIR, config.STATE_DIR, config.DATA_DIR]
|
||||
return items
|
||||
|
||||
|
||||
def uninstall(purge: bool = False) -> None:
|
||||
"""Stop the recorder, clear the token if purging, and remove the install."""
|
||||
reccontrol.stop_background()
|
||||
if purge:
|
||||
config.clear_token() # removes keyring entry + any file fallback
|
||||
paths = " ".join(shlex.quote(str(p)) for p in targets(purge))
|
||||
subprocess.Popen(
|
||||
["/bin/sh", "-c", f"sleep 1; rm -rf {paths}"],
|
||||
start_new_session=True,
|
||||
)
|
||||
@@ -0,0 +1,119 @@
|
||||
"""Update check (M13): ask the Gitea releases API for the latest version + notes.
|
||||
|
||||
Stdlib-only (urllib). The Gitea instance requires sign-in, so updates are gated to
|
||||
account holders via a Personal Access Token (D18): set $RIGDOCTOR_TOKEN or save one
|
||||
with `rigdoctor login`. Returns the latest tag, its release notes (body), and a clear
|
||||
state for the UI; `apply_update` performs the no-root self-update.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import subprocess
|
||||
import sys
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
|
||||
from .. import __version__
|
||||
from ..config import load_token
|
||||
|
||||
GITEA_BASE = "https://git.jesseyvanofferen.com"
|
||||
REPO = "jessey/rigdoctor"
|
||||
LATEST_API = f"{GITEA_BASE}/api/v1/repos/{REPO}/releases/latest"
|
||||
RELEASES_PAGE = f"{GITEA_BASE}/{REPO}/releases"
|
||||
TOKEN_PAGE = f"{GITEA_BASE}/user/settings/applications"
|
||||
|
||||
# Update states
|
||||
NO_TOKEN = "no-token"
|
||||
AUTH = "auth"
|
||||
NETWORK = "network"
|
||||
UP_TO_DATE = "up-to-date"
|
||||
AVAILABLE = "available"
|
||||
|
||||
|
||||
def _parse(version: str) -> tuple[int, ...]:
|
||||
return tuple(int(p) for p in version.lstrip("vV").split(".") if p.isdigit())
|
||||
|
||||
|
||||
def is_newer(latest: str, current: str = __version__) -> bool:
|
||||
try:
|
||||
return _parse(latest) > _parse(current)
|
||||
except (ValueError, AttributeError):
|
||||
return False
|
||||
|
||||
|
||||
def fetch_latest(timeout: float = 5.0) -> tuple[str | None, str, str | None]:
|
||||
"""Return (tag, notes, error). error is NO_TOKEN/AUTH/NETWORK, or None on success."""
|
||||
token = load_token()
|
||||
if not token:
|
||||
return (None, "", NO_TOKEN)
|
||||
req = urllib.request.Request(
|
||||
LATEST_API,
|
||||
headers={"Accept": "application/json", "Authorization": f"token {token}"},
|
||||
)
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=timeout) as resp: # noqa: S310 (https)
|
||||
data = json.load(resp)
|
||||
return (data.get("tag_name") or None, (data.get("body") or "").strip(), None)
|
||||
except urllib.error.HTTPError as exc:
|
||||
return (None, "", AUTH if exc.code in (401, 403) else NETWORK)
|
||||
except Exception:
|
||||
return (None, "", NETWORK)
|
||||
|
||||
|
||||
def check_latest(timeout: float = 5.0) -> str | None:
|
||||
"""Convenience: latest tag or None (ignores notes/error)."""
|
||||
tag, _notes, _error = fetch_latest(timeout)
|
||||
return tag
|
||||
|
||||
|
||||
def update_state(timeout: float = 5.0) -> tuple[str, str | None, str]:
|
||||
"""Return (state, tag, notes). state in NO_TOKEN/AUTH/NETWORK/UP_TO_DATE/AVAILABLE."""
|
||||
tag, notes, error = fetch_latest(timeout)
|
||||
if error:
|
||||
return (error, None, "")
|
||||
if tag and is_newer(tag):
|
||||
return (AVAILABLE, tag, notes)
|
||||
return (UP_TO_DATE, tag, notes)
|
||||
|
||||
|
||||
def list_releases(limit: int = 15, timeout: float = 6.0) -> tuple[list[tuple[str, str, str]], str | None]:
|
||||
"""Return ([(tag, date, notes), …], error) for the in-app changelog."""
|
||||
token = load_token()
|
||||
if not token:
|
||||
return ([], NO_TOKEN)
|
||||
req = urllib.request.Request(
|
||||
f"{GITEA_BASE}/api/v1/repos/{REPO}/releases?limit={limit}",
|
||||
headers={"Accept": "application/json", "Authorization": f"token {token}"},
|
||||
)
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=timeout) as resp: # noqa: S310 (https)
|
||||
data = json.load(resp)
|
||||
return ([
|
||||
(r.get("tag_name") or "?", (r.get("published_at") or "")[:10], (r.get("body") or "").strip())
|
||||
for r in data
|
||||
], None)
|
||||
except urllib.error.HTTPError as exc:
|
||||
return ([], AUTH if exc.code in (401, 403) else NETWORK)
|
||||
except Exception:
|
||||
return ([], NETWORK)
|
||||
|
||||
|
||||
def apply_update(tag: str) -> tuple[int, str]:
|
||||
"""Self-update the current (user-local) install to `tag` via authenticated pip.
|
||||
|
||||
Installs `rigdoctor[gui] @ git+https://oauth2:<token>@…/rigdoctor.git@<tag>` into
|
||||
the running environment. Returns (exit_code, output) with the token scrubbed.
|
||||
"""
|
||||
token = load_token()
|
||||
if not token:
|
||||
return (1, "No update token configured. Run `rigdoctor login`.")
|
||||
host = GITEA_BASE.split("://", 1)[1]
|
||||
ref = f"rigdoctor[gui] @ git+https://oauth2:{token}@{host}/{REPO}.git@{tag}"
|
||||
cmd = [sys.executable, "-m", "pip", "install", "--upgrade", ref]
|
||||
try:
|
||||
proc = subprocess.run(cmd, capture_output=True, text=True, timeout=1800)
|
||||
out = (proc.stdout + proc.stderr).replace(token, "***")
|
||||
return (proc.returncode, out)
|
||||
except (subprocess.SubprocessError, OSError) as exc:
|
||||
return (1, str(exc).replace(token, "***"))
|
||||
@@ -0,0 +1,107 @@
|
||||
"""Zero-config game-launch watcher (D12 fallback): poll Steam's RunningAppID and
|
||||
auto-bracket a focused capture around the running game.
|
||||
|
||||
For users who won't add the `rigdoctor wrap %command%` launch option. Less precise than the
|
||||
wrapper (it depends on Steam writing RunningAppID to registry.vdf, and only covers Steam), so
|
||||
the wrapper stays the primary mechanism. Stdlib only; safe to run as a `systemd --user` service
|
||||
(the game-launch trigger mode).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import signal
|
||||
import time
|
||||
from pathlib import Path
|
||||
|
||||
from . import reccontrol, steam
|
||||
from .steam import _parse_vdf
|
||||
|
||||
_REGISTRY_CANDIDATES = ("~/.steam/registry.vdf", "~/.steam/steam/registry.vdf")
|
||||
|
||||
|
||||
def _registry_path() -> Path | None:
|
||||
for cand in _REGISTRY_CANDIDATES:
|
||||
p = Path(os.path.expanduser(cand))
|
||||
if p.exists():
|
||||
return p
|
||||
return None
|
||||
|
||||
|
||||
def _find_key(data: dict, key: str):
|
||||
"""Recursively find a (case-insensitive) scalar key in nested VDF dicts."""
|
||||
target = key.lower()
|
||||
for k, v in data.items():
|
||||
if isinstance(v, dict):
|
||||
found = _find_key(v, key)
|
||||
if found is not None:
|
||||
return found
|
||||
elif k.lower() == target:
|
||||
return v
|
||||
return None
|
||||
|
||||
|
||||
def running_appid() -> int:
|
||||
"""The Steam appid currently running (0 if none / unknown)."""
|
||||
path = _registry_path()
|
||||
if path is None:
|
||||
return 0
|
||||
try:
|
||||
data = _parse_vdf(path.read_text(encoding="utf-8", errors="replace"))
|
||||
except OSError:
|
||||
return 0
|
||||
raw = _find_key(data, "RunningAppID")
|
||||
try:
|
||||
return int(raw)
|
||||
except (TypeError, ValueError):
|
||||
return 0
|
||||
|
||||
|
||||
def transition(prev: int, current: int) -> str | None:
|
||||
"""'start' when a game begins, 'stop' when it ends, else None."""
|
||||
if current and not prev:
|
||||
return "start"
|
||||
if prev and not current:
|
||||
return "stop"
|
||||
return None
|
||||
|
||||
|
||||
def _name_for(appid: int) -> str:
|
||||
target = str(appid)
|
||||
for g in steam.cached_games() or steam.scan_games(steam.selected_library_paths()):
|
||||
if g.appid == target:
|
||||
return g.name
|
||||
return f"Steam app {appid}"
|
||||
|
||||
|
||||
def watch(interval: float = 5.0) -> int:
|
||||
"""Poll for a running Steam game and bracket a capture around it. Blocks until signalled."""
|
||||
from . import diagnostic
|
||||
|
||||
stop = {"flag": False}
|
||||
|
||||
def _on_signal(_sig, _frame):
|
||||
stop["flag"] = True
|
||||
|
||||
signal.signal(signal.SIGTERM, _on_signal)
|
||||
signal.signal(signal.SIGINT, _on_signal)
|
||||
|
||||
prev = 0
|
||||
started = False
|
||||
while not stop["flag"]:
|
||||
current = running_appid()
|
||||
action = transition(prev, current)
|
||||
if action == "start" and not reccontrol.running_pid():
|
||||
started = diagnostic.start(game=_name_for(current)) is not None
|
||||
elif action == "stop" and started:
|
||||
reccontrol.stop_background()
|
||||
started = False
|
||||
prev = current
|
||||
# Sleep in small slices so a stop signal is handled promptly.
|
||||
slept = 0.0
|
||||
while slept < interval and not stop["flag"]:
|
||||
time.sleep(min(0.25, interval - slept))
|
||||
slept += 0.25
|
||||
if started:
|
||||
reccontrol.stop_background()
|
||||
return 0
|
||||
@@ -0,0 +1,78 @@
|
||||
"""Steam-launch wrapper (D12): auto-bracket a focused diagnostic around a game.
|
||||
|
||||
Set as a per-game Steam launch option — `rigdoctor wrap %command%` — or in Lutris/Heroic's
|
||||
wrapper field. Steam expands `%command%` to the real game command; we start a focused capture
|
||||
(tagged with the game), run the game, and stop the capture cleanly when it exits. A hard
|
||||
freeze means the game (and this wrapper) never returns, so the capture is left without a clean
|
||||
stop — which RigDoctor then flags as a crash on next launch.
|
||||
|
||||
Deterministic and daemonless (D12 "build first"): no polling, and it knows the title.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import signal
|
||||
import subprocess
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def game_name_from_env() -> str | None:
|
||||
"""The launching game's name, resolved from Steam's SteamAppId env var via the scan."""
|
||||
appid = os.environ.get("SteamAppId") or os.environ.get("SteamGameId")
|
||||
if not appid:
|
||||
return None
|
||||
from . import steam
|
||||
|
||||
games = steam.cached_games() or steam.scan_games(steam.selected_library_paths())
|
||||
for game in games:
|
||||
if game.appid == str(appid):
|
||||
return game.name
|
||||
return f"Steam app {appid}"
|
||||
|
||||
|
||||
def launch_option() -> str:
|
||||
"""The exact string to paste into Steam's Launch Options (absolute path → PATH-proof)."""
|
||||
exe = Path(sys.executable).with_name("rigdoctor")
|
||||
prog = str(exe) if exe.exists() else "rigdoctor"
|
||||
quoted = f'"{prog}"' if " " in prog else prog
|
||||
return f"{quoted} wrap %command%"
|
||||
|
||||
|
||||
def run(command: list[str]) -> int:
|
||||
"""Start a focused capture (unless one's already running), run the game, then stop it.
|
||||
Returns the game's exit code so Steam sees the right status."""
|
||||
from . import diagnostic, reccontrol
|
||||
|
||||
if not command:
|
||||
print("usage: rigdoctor wrap %command% (set as a Steam launch option)", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
game = game_name_from_env() or os.path.basename(command[0])
|
||||
started = False
|
||||
if not reccontrol.running_pid(): # don't disturb an existing capture
|
||||
started = diagnostic.start(game=game) is not None
|
||||
|
||||
proc: subprocess.Popen | None = None
|
||||
|
||||
def _forward(signum, _frame): # pass Steam's stop signal to the game
|
||||
if proc is not None and proc.poll() is None:
|
||||
try:
|
||||
proc.send_signal(signum)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
previous = {sig: signal.signal(sig, _forward) for sig in (signal.SIGTERM, signal.SIGINT)}
|
||||
try:
|
||||
proc = subprocess.Popen(command)
|
||||
rc = proc.wait()
|
||||
except (OSError, ValueError, subprocess.SubprocessError) as exc:
|
||||
print(f"rigdoctor wrap: couldn't launch the game: {exc}", file=sys.stderr)
|
||||
rc = 1
|
||||
finally:
|
||||
for sig, handler in previous.items():
|
||||
signal.signal(sig, handler)
|
||||
if started:
|
||||
reccontrol.stop_background() # clean stop → no false crash flag
|
||||
return rc
|
||||
@@ -3,24 +3,46 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from PySide6.QtGui import QIcon
|
||||
from PySide6.QtWidgets import QApplication
|
||||
|
||||
from ..config import load_config
|
||||
from . import desktop
|
||||
from .main_window import MainWindow
|
||||
from .theme import STYLESHEET
|
||||
|
||||
ICON = Path(__file__).parent / "assets" / "rigdoctor.svg"
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
desktop.ensure() # self-register icon + .desktop so updates show it without re-installing
|
||||
app = QApplication(argv if argv is not None else sys.argv)
|
||||
app.setApplicationName("RigDoctor")
|
||||
app.setApplicationDisplayName("RigDoctor")
|
||||
# Match the installed rigdoctor.desktop so the dock/launcher shows our icon (Wayland app-id).
|
||||
app.setDesktopFileName("rigdoctor")
|
||||
if ICON.exists():
|
||||
app.setWindowIcon(QIcon(str(ICON)))
|
||||
app.setStyle("Fusion")
|
||||
app.setStyleSheet(STYLESHEET)
|
||||
|
||||
interval = float(load_config().get("interval", 1.0))
|
||||
cfg = load_config()
|
||||
interval = float(cfg.get("interval", 1.0))
|
||||
window = MainWindow(interval=interval)
|
||||
# `--tray` starts hidden to the system tray (for autostart); if no tray is available,
|
||||
# fall back to showing the window so the app is never invisible-and-unreachable.
|
||||
args = argv if argv is not None else sys.argv
|
||||
if "--tray" in args and window.tray_available():
|
||||
window.start_minimized_note()
|
||||
else:
|
||||
window.show()
|
||||
# First run (or `--setup`): the graphical setup wizard (M9).
|
||||
if "--setup" in args or not cfg.get("setup_done", False):
|
||||
from .setup_wizard import SetupWizard
|
||||
|
||||
SetupWizard(window).exec()
|
||||
return app.exec()
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 16 16">
|
||||
<path d="M3.5 8.5 L6.5 11.5 L12.5 4.5" fill="none" stroke="#06222e"
|
||||
stroke-width="2.4" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 237 B |
@@ -0,0 +1,8 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="256" height="256" viewBox="0 0 256 256">
|
||||
<rect x="8" y="8" width="240" height="240" rx="52" fill="#15181e"/>
|
||||
<circle cx="128" cy="128" r="84" fill="none" stroke="#2a2f39" stroke-width="14"/>
|
||||
<path d="M128 44 a84 84 0 1 1 -59.4 24.6" fill="none" stroke="#38bdf8"
|
||||
stroke-width="14" stroke-linecap="round"/>
|
||||
<path d="M60 132 H100 L116 96 L140 168 L156 132 H196" fill="none" stroke="#e6e8eb"
|
||||
stroke-width="14" stroke-linecap="round" stroke-linejoin="round"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 533 B |
@@ -17,19 +17,19 @@ from PySide6.QtWidgets import (
|
||||
|
||||
from ..core.sample import Sample
|
||||
from ..render import metric_label
|
||||
from .widgets import Card, MetricBar, MetricRow, StatGauge
|
||||
from .widgets import Card, HistoryGraph, MetricBar, MetricRow
|
||||
|
||||
_GROUP_ORDER = ["gpu", "cpu", "memory", "storage"]
|
||||
_GROUP_TITLES = {"gpu": "GPU", "cpu": "CPU", "memory": "Memory", "storage": "Storage"}
|
||||
_BAR_METRICS = {"util", "mem_util", "fan", "used_pct"}
|
||||
|
||||
|
||||
def _gauge_card(gauge: StatGauge) -> QFrame:
|
||||
def _tile_card(widget: QWidget) -> QFrame:
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
layout = QVBoxLayout(card)
|
||||
layout.setContentsMargins(6, 14, 6, 8)
|
||||
layout.addWidget(gauge)
|
||||
layout.setContentsMargins(6, 10, 6, 8)
|
||||
layout.addWidget(widget)
|
||||
return card
|
||||
|
||||
|
||||
@@ -54,16 +54,16 @@ class Dashboard(QWidget):
|
||||
header.addWidget(self._updated)
|
||||
root.addLayout(header)
|
||||
|
||||
# Headline gauges
|
||||
self._g_gpu_temp = StatGauge("GPU Temp", "°C", 100, "temp")
|
||||
self._g_gpu_load = StatGauge("GPU Load", "%", 100, "accent")
|
||||
self._g_cpu_temp = StatGauge("CPU Temp", "°C", 100, "temp")
|
||||
self._g_mem = StatGauge("Memory", "%", 100, "usage")
|
||||
gauges = QHBoxLayout()
|
||||
gauges.setSpacing(14)
|
||||
# Headline trend graphs (history over the session, not just the live value)
|
||||
self._g_gpu_temp = HistoryGraph("GPU Temp", "°C", 30, 100, "temp")
|
||||
self._g_gpu_load = HistoryGraph("GPU Load", "%", 0, 100, "accent")
|
||||
self._g_cpu_temp = HistoryGraph("CPU Temp", "°C", 30, 100, "temp")
|
||||
self._g_mem = HistoryGraph("Memory", "%", 0, 100, "usage")
|
||||
graphs = QHBoxLayout()
|
||||
graphs.setSpacing(14)
|
||||
for g in (self._g_gpu_temp, self._g_gpu_load, self._g_cpu_temp, self._g_mem):
|
||||
gauges.addWidget(_gauge_card(g))
|
||||
root.addLayout(gauges)
|
||||
graphs.addWidget(_tile_card(g))
|
||||
root.addLayout(graphs)
|
||||
|
||||
# Per-subsystem cards (scrollable, 2-column grid)
|
||||
scroll = QScrollArea()
|
||||
@@ -81,10 +81,10 @@ class Dashboard(QWidget):
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
def update_sample(self, sample: Sample) -> None:
|
||||
self._g_gpu_temp.set_value(self._val(sample, "gpu", "temp", ""))
|
||||
self._g_gpu_load.set_value(self._val(sample, "gpu", "util"))
|
||||
self._g_cpu_temp.set_value(self._cpu_temp(sample))
|
||||
self._g_mem.set_value(self._val(sample, "memory", "used_pct"))
|
||||
self._g_gpu_temp.add_value(self._val(sample, "gpu", "temp", ""))
|
||||
self._g_gpu_load.add_value(self._val(sample, "gpu", "util"))
|
||||
self._g_cpu_temp.add_value(self._cpu_temp(sample))
|
||||
self._g_mem.add_value(self._val(sample, "memory", "used_pct"))
|
||||
|
||||
keys = [r.key for r in sample.readings]
|
||||
if keys != self._built_keys: # sources appeared/disappeared
|
||||
|
||||
@@ -0,0 +1,51 @@
|
||||
"""Best-effort desktop integration: install our icon + .desktop so the dock shows it.
|
||||
|
||||
Runs at GUI launch (idempotent), so a self-update + relaunch refreshes the icon without
|
||||
re-running install.sh. No-op for non-installed (dev) runs where the launcher is absent.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shutil
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
from .. import config
|
||||
|
||||
_ICON_SRC = Path(__file__).parent / "assets" / "rigdoctor.svg"
|
||||
|
||||
_DESKTOP = """[Desktop Entry]
|
||||
Type=Application
|
||||
Name=RigDoctor
|
||||
Comment=Hardware monitoring & crash diagnostics for Linux gamers
|
||||
Exec={exec}
|
||||
Icon=rigdoctor
|
||||
Terminal=false
|
||||
Categories=System;Monitor;Utility;
|
||||
StartupWMClass=rigdoctor
|
||||
"""
|
||||
|
||||
|
||||
def ensure() -> None:
|
||||
share = config.DATA_DIR.parent # ~/.local/share
|
||||
|
||||
try:
|
||||
if _ICON_SRC.exists():
|
||||
icon_dst = share / "icons" / "hicolor" / "scalable" / "apps" / "rigdoctor.svg"
|
||||
icon_dst.parent.mkdir(parents=True, exist_ok=True)
|
||||
if not icon_dst.exists() or icon_dst.read_bytes() != _ICON_SRC.read_bytes():
|
||||
shutil.copyfile(_ICON_SRC, icon_dst)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
gui_exec = Path(sys.executable).with_name("rigdoctor-gui")
|
||||
if not gui_exec.exists(): # dev / not a normal install — don't fabricate a .desktop
|
||||
return
|
||||
try:
|
||||
desktop = share / "applications" / "rigdoctor.desktop"
|
||||
content = _DESKTOP.format(exec=gui_exec)
|
||||
desktop.parent.mkdir(parents=True, exist_ok=True)
|
||||
if not desktop.exists() or desktop.read_text() != content:
|
||||
desktop.write_text(content)
|
||||
except OSError:
|
||||
pass
|
||||
@@ -0,0 +1,81 @@
|
||||
"""Results view for a guided diagnostic session (M6/D12): capture summary + findings."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from PySide6.QtCore import Qt
|
||||
from PySide6.QtGui import QFont
|
||||
from PySide6.QtWidgets import (
|
||||
QDialog,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..render import render_summary
|
||||
from .widgets import finding_card
|
||||
|
||||
|
||||
class DiagnosticDialog(QDialog):
|
||||
def __init__(self, result, parent=None) -> None:
|
||||
super().__init__(parent)
|
||||
self.setWindowTitle(f"Diagnostic — {result.game}" if result.game else "Diagnostic")
|
||||
self.resize(660, 680)
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 16)
|
||||
root.setSpacing(14)
|
||||
|
||||
title = QLabel(f"Diagnostic — {result.game}" if result.game else "Diagnostic")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
|
||||
scroll = QScrollArea()
|
||||
scroll.setWidgetResizable(True)
|
||||
scroll.setFrameShape(QFrame.Shape.NoFrame)
|
||||
scroll.setStyleSheet("background: transparent;")
|
||||
body = QWidget()
|
||||
col = QVBoxLayout(body)
|
||||
col.setContentsMargins(0, 0, 0, 0)
|
||||
col.setSpacing(10)
|
||||
col.setAlignment(Qt.AlignmentFlag.AlignTop)
|
||||
|
||||
# Capture window summary (peaks / events / last samples) — monospace for the columns.
|
||||
cap_head = QLabel("Capture")
|
||||
cap_head.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
col.addWidget(cap_head)
|
||||
summary = QLabel(render_summary(result.summary))
|
||||
summary.setObjectName("Report")
|
||||
summary.setFont(QFont("monospace"))
|
||||
summary.setTextInteractionFlags(Qt.TextInteractionFlag.TextSelectableByMouse)
|
||||
summary.setWordWrap(False)
|
||||
summary.setStyleSheet(
|
||||
"background: #0d0f13; color: #cfd3da; border: 1px solid #2a2f39; "
|
||||
"border-radius: 8px; padding: 10px;"
|
||||
)
|
||||
col.addWidget(summary)
|
||||
|
||||
find_head = QLabel(f"Findings ({len(result.findings)})")
|
||||
find_head.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
col.addWidget(find_head)
|
||||
if result.findings:
|
||||
for finding in result.findings:
|
||||
col.addWidget(finding_card(finding))
|
||||
else:
|
||||
none = QLabel("No findings.")
|
||||
none.setObjectName("Muted")
|
||||
col.addWidget(none)
|
||||
|
||||
scroll.setWidget(body)
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
buttons = QHBoxLayout()
|
||||
buttons.addStretch(1)
|
||||
close = QPushButton("Close")
|
||||
close.setObjectName("PrimaryButton")
|
||||
close.clicked.connect(self.accept)
|
||||
buttons.addWidget(close)
|
||||
root.addLayout(buttons)
|
||||
@@ -0,0 +1,156 @@
|
||||
"""Environment page (M6 in the GUI): runs the gaming-environment checks as findings cards."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import threading
|
||||
import time
|
||||
|
||||
from PySide6.QtCore import Qt, QTimer, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from .widgets import finding_card
|
||||
|
||||
|
||||
def _fail_reason(out: str) -> str:
|
||||
"""Turn the failed command's output into a short, human reason."""
|
||||
low = (out or "").lower()
|
||||
if "not authorized" in low or "dismissed" in low or "authentication" in low:
|
||||
return "cancelled at the password prompt"
|
||||
if "operation not permitted" in low or "invalid argument" in low or "permission denied" in low:
|
||||
return "the system rejected the change (it may be locked by BIOS/kernel)"
|
||||
last = next((ln.strip() for ln in reversed((out or "").splitlines()) if ln.strip()), "")
|
||||
return (last[:80] or "no privileges, or cancelled")
|
||||
|
||||
|
||||
class EnvironmentPage(QWidget):
|
||||
_result = Signal(object) # list[Finding]
|
||||
_action_done = Signal(object) # (label, rc, output) — install or apply finished
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._result.connect(self._render_findings)
|
||||
self._action_done.connect(self._on_action_done)
|
||||
self._busy = False
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("Tuning")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.addStretch(1)
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
header.addWidget(self._status)
|
||||
self._run_btn = QPushButton("Run checks")
|
||||
self._run_btn.setObjectName("PrimaryButton")
|
||||
self._run_btn.clicked.connect(self._run)
|
||||
header.addWidget(self._run_btn)
|
||||
root.addLayout(header)
|
||||
|
||||
intro = QLabel(
|
||||
"System settings that affect gaming stability and performance, with the suggested "
|
||||
"fix command. RigDoctor only reports — it never changes anything."
|
||||
)
|
||||
intro.setObjectName("Muted")
|
||||
intro.setWordWrap(True)
|
||||
root.addWidget(intro)
|
||||
|
||||
scroll = QScrollArea()
|
||||
scroll.setWidgetResizable(True)
|
||||
scroll.setFrameShape(QFrame.Shape.NoFrame)
|
||||
scroll.setStyleSheet("background: transparent;")
|
||||
self._container = QWidget()
|
||||
self._list = QVBoxLayout(self._container)
|
||||
self._list.setContentsMargins(0, 0, 0, 0)
|
||||
self._list.setSpacing(10)
|
||||
self._list.setAlignment(Qt.AlignmentFlag.AlignTop)
|
||||
scroll.setWidget(self._container)
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
QTimer.singleShot(350, self._run) # auto-run shortly after the window opens
|
||||
|
||||
def _run(self) -> None:
|
||||
self._run_btn.setEnabled(False)
|
||||
self._status.setText("Checking environment…")
|
||||
threading.Thread(target=self._work, daemon=True).start()
|
||||
|
||||
def _work(self) -> None:
|
||||
from ..core.gameenv import run_gameenv_checks
|
||||
|
||||
try:
|
||||
findings = run_gameenv_checks()
|
||||
except Exception:
|
||||
findings = None
|
||||
self._result.emit(findings)
|
||||
|
||||
def _render_findings(self, findings) -> None:
|
||||
self._run_btn.setEnabled(True)
|
||||
if findings is None: # check failed — keep current results
|
||||
self._status.setText("check failed")
|
||||
return
|
||||
|
||||
while self._list.count():
|
||||
item = self._list.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
|
||||
crit = sum(1 for f in findings if f.severity == "critical")
|
||||
warn = sum(1 for f in findings if f.severity == "warning")
|
||||
self._status.setText(
|
||||
f"{crit} critical · {warn} warning · {len(findings)} checks · "
|
||||
f"{time.strftime('%H:%M:%S')}"
|
||||
)
|
||||
for finding in findings:
|
||||
self._list.addWidget(finding_card(finding, on_install=self._install, on_apply=self._apply))
|
||||
self._list.addStretch(1)
|
||||
|
||||
def _install(self, component) -> None:
|
||||
if self._busy:
|
||||
return
|
||||
self._busy = True
|
||||
self._run_btn.setEnabled(False)
|
||||
self._status.setText(f"Installing {component.name}… (may prompt for your password)")
|
||||
threading.Thread(target=self._work_install, args=(component,), daemon=True).start()
|
||||
|
||||
def _work_install(self, component) -> None:
|
||||
from ..core import installer
|
||||
|
||||
rc, out = installer.install_packages(list(component.apt))
|
||||
self._action_done.emit((component.name, rc, out))
|
||||
|
||||
def _apply(self, fix_id: str, value: str) -> None:
|
||||
if self._busy:
|
||||
return
|
||||
self._busy = True
|
||||
self._run_btn.setEnabled(False)
|
||||
self._status.setText(f"Applying {value}… (may prompt for your password)")
|
||||
threading.Thread(target=self._work_apply, args=(fix_id, value), daemon=True).start()
|
||||
|
||||
def _work_apply(self, fix_id: str, value: str) -> None:
|
||||
from ..core import fixes
|
||||
|
||||
rc, out = fixes.apply(fix_id, value)
|
||||
self._action_done.emit((value, rc, out))
|
||||
|
||||
def _on_action_done(self, result) -> None:
|
||||
label, rc, out = result
|
||||
self._busy = False
|
||||
if rc == 0:
|
||||
self._status.setText(f"{label} applied — re-checking…")
|
||||
self._run() # re-run so the finding reflects the new state
|
||||
else:
|
||||
self._run_btn.setEnabled(True)
|
||||
self._status.setText(f"'{label}' failed — {_fail_reason(out)}")
|
||||
@@ -0,0 +1,517 @@
|
||||
"""Games page (M6 in the GUI): pick Steam libraries and browse detected games.
|
||||
|
||||
Libraries are opt-in — the user checks which ones to scan. The list is loaded from the
|
||||
cache instantly, then a background rescan refreshes it and flags games installed since the
|
||||
last scan (a "NEW" badge here + a count on the sidebar nav).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import threading
|
||||
import time
|
||||
|
||||
from PySide6.QtCore import Qt, QTimer, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QCheckBox,
|
||||
QDialog,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..config import load_config, update_config
|
||||
from .diagnostic_dialog import DiagnosticDialog
|
||||
from .theme import ACCENT, GOOD, MUTED, WARN
|
||||
|
||||
|
||||
def _game_row(name: str, sublabel: str, size: str, is_new: bool, appid: str = "", on_diagnose=None) -> QFrame:
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
h = QHBoxLayout(card)
|
||||
h.setContentsMargins(16, 10, 16, 10)
|
||||
h.setSpacing(10)
|
||||
|
||||
left = QVBoxLayout()
|
||||
left.setSpacing(2)
|
||||
title = QLabel(name)
|
||||
title.setStyleSheet("font-weight: 600; background: transparent;")
|
||||
title.setWordWrap(True)
|
||||
left.addWidget(title)
|
||||
if sublabel:
|
||||
sub = QLabel(sublabel)
|
||||
sub.setObjectName("Muted")
|
||||
left.addWidget(sub)
|
||||
h.addLayout(left, 1)
|
||||
|
||||
if is_new:
|
||||
badge = QLabel("NEW")
|
||||
badge.setStyleSheet(
|
||||
f"color: {GOOD}; border: 1px solid {GOOD}; border-radius: 6px; "
|
||||
f"padding: 1px 6px; font-weight: 700; background: transparent;"
|
||||
)
|
||||
h.addWidget(badge, 0, Qt.AlignmentFlag.AlignVCenter)
|
||||
|
||||
size_label = QLabel(size)
|
||||
size_label.setObjectName("Muted")
|
||||
size_label.setMinimumWidth(80)
|
||||
size_label.setAlignment(Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignVCenter)
|
||||
h.addWidget(size_label, 0)
|
||||
|
||||
if on_diagnose is not None:
|
||||
diag_btn = QPushButton("Run Diagnostic")
|
||||
diag_btn.setObjectName("ActionButton")
|
||||
diag_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
diag_btn.clicked.connect(lambda: on_diagnose(name, appid))
|
||||
h.addWidget(diag_btn, 0)
|
||||
return card
|
||||
|
||||
|
||||
class GamesPage(QWidget):
|
||||
_libraries_ready = Signal(object) # list[dict(path, label, count, selected)]
|
||||
_scanned = Signal(object) # steam.ScanResult
|
||||
new_count_changed = Signal(int) # newly-installed game count (for the nav badge)
|
||||
_diag_done = Signal(object) # DiagnosticResult — focused capture analyzed
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._libraries_ready.connect(self._render_libraries)
|
||||
self._scanned.connect(self._render_games)
|
||||
self._diag_done.connect(self._on_diag_done)
|
||||
self._busy = False
|
||||
self._new_appids: set[str] = set()
|
||||
self._extra_games: list = [] # non-Steam (Lutris/Heroic), appended after a scan
|
||||
self._diag_game: str | None = None
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("Games")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.addStretch(1)
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
header.addWidget(self._status)
|
||||
self._autocap_btn = QPushButton("Auto-capture…")
|
||||
self._autocap_btn.clicked.connect(self._show_autocapture)
|
||||
header.addWidget(self._autocap_btn)
|
||||
self._rescan_btn = QPushButton("Rescan")
|
||||
self._rescan_btn.setObjectName("PrimaryButton")
|
||||
self._rescan_btn.clicked.connect(self.refresh)
|
||||
header.addWidget(self._rescan_btn)
|
||||
root.addLayout(header)
|
||||
|
||||
# In-progress diagnostic banner (hidden until a focused capture is running).
|
||||
self._banner = QFrame()
|
||||
self._banner.setObjectName("Card")
|
||||
self._banner.setStyleSheet(f"#Card {{ border: 1px solid {ACCENT}; }}")
|
||||
banner_h = QHBoxLayout(self._banner)
|
||||
banner_h.setContentsMargins(16, 10, 16, 10)
|
||||
banner_h.setSpacing(10)
|
||||
self._banner_label = QLabel("")
|
||||
self._banner_label.setWordWrap(True)
|
||||
self._banner_label.setStyleSheet(f"color: {ACCENT}; font-weight: 700; background: transparent;")
|
||||
banner_h.addWidget(self._banner_label, 1)
|
||||
self._finish_btn = QPushButton("Finish && analyze") # && → literal & (not a mnemonic)
|
||||
self._finish_btn.setObjectName("ActionButton")
|
||||
self._finish_btn.clicked.connect(self._finish_diagnostic)
|
||||
banner_h.addWidget(self._finish_btn)
|
||||
self._discard_btn = QPushButton("Discard")
|
||||
self._discard_btn.clicked.connect(self._discard_diagnostic)
|
||||
banner_h.addWidget(self._discard_btn)
|
||||
self._banner.hide()
|
||||
root.addWidget(self._banner)
|
||||
|
||||
# Hard-crash banner: a previous diagnostic ended without a clean stop.
|
||||
self._crash_banner = QFrame()
|
||||
self._crash_banner.setObjectName("Card")
|
||||
self._crash_banner.setStyleSheet(f"#Card {{ border: 1px solid {WARN}; }}")
|
||||
crash_h = QHBoxLayout(self._crash_banner)
|
||||
crash_h.setContentsMargins(16, 10, 16, 10)
|
||||
crash_h.setSpacing(10)
|
||||
self._crash_label = QLabel("")
|
||||
self._crash_label.setWordWrap(True)
|
||||
self._crash_label.setStyleSheet(f"color: {WARN}; font-weight: 700; background: transparent;")
|
||||
crash_h.addWidget(self._crash_label, 1)
|
||||
self._analyze_btn = QPushButton("Analyze crash")
|
||||
self._analyze_btn.setObjectName("ActionButton")
|
||||
self._analyze_btn.clicked.connect(self._analyze_crash)
|
||||
crash_h.addWidget(self._analyze_btn)
|
||||
self._dismiss_btn = QPushButton("Dismiss")
|
||||
self._dismiss_btn.clicked.connect(self._dismiss_crash)
|
||||
crash_h.addWidget(self._dismiss_btn)
|
||||
self._crash_banner.hide()
|
||||
root.addWidget(self._crash_banner)
|
||||
|
||||
self._diag_timer = QTimer(self)
|
||||
self._diag_timer.setInterval(1000)
|
||||
self._diag_timer.timeout.connect(self._poll_diag)
|
||||
|
||||
# Libraries (opt-in checkboxes)
|
||||
lib_card = QFrame()
|
||||
lib_card.setObjectName("Card")
|
||||
lib_v = QVBoxLayout(lib_card)
|
||||
lib_v.setContentsMargins(16, 12, 16, 12)
|
||||
lib_v.setSpacing(6)
|
||||
lib_head = QLabel("Steam libraries")
|
||||
lib_head.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
lib_v.addWidget(lib_head)
|
||||
self._lib_box = QVBoxLayout()
|
||||
self._lib_box.setSpacing(6)
|
||||
lib_v.addLayout(self._lib_box)
|
||||
self._lib_hint = QLabel("Looking for Steam libraries…")
|
||||
self._lib_hint.setObjectName("Muted")
|
||||
self._lib_hint.setWordWrap(True)
|
||||
lib_v.addWidget(self._lib_hint)
|
||||
root.addWidget(lib_card)
|
||||
|
||||
# Games list
|
||||
scroll = QScrollArea()
|
||||
scroll.setWidgetResizable(True)
|
||||
scroll.setFrameShape(QFrame.Shape.NoFrame)
|
||||
scroll.setStyleSheet("background: transparent;")
|
||||
self._container = QWidget()
|
||||
self._list = QVBoxLayout(self._container)
|
||||
self._list.setContentsMargins(0, 0, 0, 0)
|
||||
self._list.setSpacing(8)
|
||||
self._list.setAlignment(Qt.AlignmentFlag.AlignTop)
|
||||
scroll.setWidget(self._container)
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
self._load_cached() # instant display from the last scan
|
||||
QTimer.singleShot(400, self.refresh) # then rescan in the background on launch
|
||||
self._check_crash() # surface an interrupted (crashed) diagnostic
|
||||
|
||||
# --- loading ----------------------------------------------------------------------
|
||||
|
||||
def _load_cached(self) -> None:
|
||||
from ..core import steam
|
||||
|
||||
cache = steam.load_cache() or {}
|
||||
self._new_appids = set(cache.get("new_appids", []))
|
||||
games = steam.cached_games()
|
||||
if games:
|
||||
self._populate_games(games, self._new_appids)
|
||||
self.new_count_changed.emit(len(self._new_appids))
|
||||
|
||||
def refresh(self) -> None:
|
||||
if self._busy:
|
||||
return
|
||||
self._busy = True
|
||||
self._rescan_btn.setEnabled(False)
|
||||
self._status.setText("Scanning Steam libraries…")
|
||||
threading.Thread(target=self._work, daemon=True).start()
|
||||
|
||||
def _work(self) -> None:
|
||||
from ..core import launchers, steam
|
||||
|
||||
try:
|
||||
selected = {os.path.realpath(p) for p in steam.selected_library_paths()}
|
||||
libs = [
|
||||
{"path": lib.path, "label": lib.label, "selected": lib.path in selected,
|
||||
"count": len(steam.scan_library(lib.path))}
|
||||
for lib in steam.discover_libraries()
|
||||
]
|
||||
self._libraries_ready.emit(libs)
|
||||
try:
|
||||
self._extra_games = launchers.scan() # Lutris / Heroic (non-Steam)
|
||||
except Exception:
|
||||
self._extra_games = []
|
||||
self._scanned.emit(steam.rescan())
|
||||
except Exception:
|
||||
self._scanned.emit(None)
|
||||
|
||||
# --- rendering --------------------------------------------------------------------
|
||||
|
||||
def _render_libraries(self, libs) -> None:
|
||||
while self._lib_box.count():
|
||||
item = self._lib_box.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
if not libs:
|
||||
self._lib_hint.setText("No Steam libraries detected. Is Steam installed?")
|
||||
self._lib_hint.show()
|
||||
return
|
||||
self._lib_hint.hide()
|
||||
for lib in libs:
|
||||
label = lib["path"]
|
||||
if lib["label"]:
|
||||
label += f" [{lib['label']}]"
|
||||
cb = QCheckBox(f"{label} · {lib['count']} games")
|
||||
cb.setChecked(lib["selected"])
|
||||
cb.toggled.connect(lambda checked, p=lib["path"]: self._toggle_library(p, checked))
|
||||
self._lib_box.addWidget(cb)
|
||||
|
||||
def _toggle_library(self, path: str, checked: bool) -> None:
|
||||
selected = {os.path.realpath(p) for p in (load_config().get("steam_libraries") or [])}
|
||||
if checked:
|
||||
selected.add(os.path.realpath(path))
|
||||
else:
|
||||
selected.discard(os.path.realpath(path))
|
||||
update_config(steam_libraries=sorted(selected))
|
||||
self.refresh()
|
||||
|
||||
def _render_games(self, result) -> None:
|
||||
self._busy = False
|
||||
self._rescan_btn.setEnabled(True)
|
||||
if result is None:
|
||||
self._status.setText("scan failed")
|
||||
return
|
||||
self._new_appids = set(result.new_appids)
|
||||
games = list(result.games) + list(self._extra_games)
|
||||
self._populate_games(games, self._new_appids)
|
||||
new = len(self._new_appids)
|
||||
suffix = f" · {new} new" if new else ""
|
||||
non_steam = f" · {len(self._extra_games)} non-Steam" if self._extra_games else ""
|
||||
self._status.setText(
|
||||
f"{len(games)} games · {time.strftime('%H:%M:%S')}{suffix}{non_steam}"
|
||||
)
|
||||
self.new_count_changed.emit(new)
|
||||
|
||||
def _populate_games(self, games, new_appids: set[str]) -> None:
|
||||
from ..core import steam
|
||||
|
||||
while self._list.count():
|
||||
item = self._list.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
|
||||
if not games:
|
||||
empty = QLabel(
|
||||
"No games to show yet — check a Steam library above to scan it for games."
|
||||
)
|
||||
empty.setObjectName("Muted")
|
||||
empty.setWordWrap(True)
|
||||
self._list.addWidget(empty)
|
||||
self._list.addStretch(1)
|
||||
return
|
||||
|
||||
for g in games:
|
||||
launcher = getattr(g, "launcher", "steam")
|
||||
if launcher != "steam":
|
||||
sublabel, appid = launcher.title(), "" # non-Steam: can't steam:// launch it
|
||||
else:
|
||||
sublabel, appid = (os.path.basename(g.library.rstrip("/")) or g.library), g.appid
|
||||
self._list.addWidget(_game_row(
|
||||
g.name,
|
||||
sublabel,
|
||||
steam.human_size(g.size_bytes),
|
||||
g.appid in new_appids,
|
||||
appid=appid,
|
||||
on_diagnose=self._start_diagnostic,
|
||||
))
|
||||
self._list.addStretch(1)
|
||||
|
||||
# --- guided diagnostic (M6/D12) ---------------------------------------------------
|
||||
|
||||
def _start_diagnostic(self, name: str, appid: str = "") -> None:
|
||||
from ..core import diagnostic, steam
|
||||
|
||||
if diagnostic.is_running():
|
||||
QMessageBox.information(
|
||||
self, "RigDoctor",
|
||||
"A capture is already running — finish or discard it first.")
|
||||
return
|
||||
|
||||
# Tell the user what the flow actually is, and offer to launch the game for them.
|
||||
box = QMessageBox(self)
|
||||
box.setIcon(QMessageBox.Icon.Information)
|
||||
box.setWindowTitle(f"Run Diagnostic — {name}")
|
||||
box.setText(f"Record a focused diagnostic while you play {name}?")
|
||||
box.setInformativeText(
|
||||
"RigDoctor will capture sensors in the background. Then:\n\n"
|
||||
"1. Play the game and try to reproduce the freeze / black screen / crash.\n"
|
||||
"2. When you're done — or after a hard freeze and reboot — come back here and "
|
||||
"click “Finish & analyze”.\n\n"
|
||||
"Your readings are saved continuously, so even a hard lock won't lose them."
|
||||
)
|
||||
launch_btn = box.addButton("Launch game && start", QMessageBox.ButtonRole.AcceptRole)
|
||||
start_btn = box.addButton("Start without launching", QMessageBox.ButtonRole.ActionRole)
|
||||
box.addButton("Cancel", QMessageBox.ButtonRole.RejectRole)
|
||||
if not appid:
|
||||
launch_btn.setEnabled(False) # no appid → can't ask Steam to launch it
|
||||
box.exec()
|
||||
clicked = box.clickedButton()
|
||||
if clicked not in (launch_btn, start_btn):
|
||||
return
|
||||
|
||||
if diagnostic.start(game=name) is None:
|
||||
QMessageBox.warning(self, "RigDoctor", "Couldn't start the capture.")
|
||||
return
|
||||
launched = steam.launch_game(appid) if clicked is launch_btn else False
|
||||
self._diag_game = name
|
||||
self._finish_btn.setEnabled(True)
|
||||
self._discard_btn.setEnabled(True)
|
||||
self._banner.show()
|
||||
self._diag_timer.start()
|
||||
self._poll_diag()
|
||||
if clicked is launch_btn and not launched:
|
||||
QMessageBox.information(
|
||||
self, "RigDoctor",
|
||||
"Recording started, but couldn't launch the game automatically — "
|
||||
"launch it yourself, then click “Finish & analyze” when you're done.")
|
||||
|
||||
def _poll_diag(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
status = diagnostic.active()
|
||||
if not status:
|
||||
self._diag_timer.stop() # recorder exited on its own
|
||||
return
|
||||
samples = status.get("samples", 0)
|
||||
lost = " · ⚠ GPU-lost detected" if status.get("gpu_lost") else ""
|
||||
game = status.get("game") or self._diag_game or "your game"
|
||||
self._banner_label.setText(
|
||||
f"● Recording {game} — play it and reproduce the problem, then click "
|
||||
f"“Finish & analyze”. ({samples} samples{lost})"
|
||||
)
|
||||
|
||||
def _finish_diagnostic(self) -> None:
|
||||
self._diag_timer.stop()
|
||||
self._finish_btn.setEnabled(False)
|
||||
self._discard_btn.setEnabled(False)
|
||||
self._banner_label.setText("Analyzing… (running the health report)")
|
||||
threading.Thread(target=self._work_finish, daemon=True).start()
|
||||
|
||||
def _work_finish(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
try:
|
||||
result = diagnostic.finish()
|
||||
except Exception:
|
||||
result = None
|
||||
self._diag_done.emit(result)
|
||||
|
||||
def _on_diag_done(self, result) -> None:
|
||||
self._banner.hide()
|
||||
self._crash_banner.hide()
|
||||
self._finish_btn.setEnabled(True)
|
||||
self._discard_btn.setEnabled(True)
|
||||
self._analyze_btn.setEnabled(True)
|
||||
if result is None:
|
||||
QMessageBox.warning(self, "RigDoctor", "The diagnostic couldn't be analyzed.")
|
||||
return
|
||||
DiagnosticDialog(result, self).exec()
|
||||
|
||||
def _discard_diagnostic(self) -> None:
|
||||
from ..core import reccontrol
|
||||
|
||||
self._diag_timer.stop()
|
||||
reccontrol.stop_background()
|
||||
self._banner.hide()
|
||||
|
||||
def _show_autocapture(self) -> None:
|
||||
from ..core import wrap
|
||||
|
||||
option = wrap.launch_option()
|
||||
dlg = QDialog(self)
|
||||
dlg.setWindowTitle("Auto-capture in Steam")
|
||||
dlg.resize(580, 250)
|
||||
v = QVBoxLayout(dlg)
|
||||
v.setContentsMargins(20, 18, 20, 16)
|
||||
v.setSpacing(12)
|
||||
info = QLabel(
|
||||
"Capture automatically every time you launch a game — no need to click "
|
||||
"Run Diagnostic.\n\n"
|
||||
"1. In Steam, right-click the game → Properties → Launch Options.\n"
|
||||
"2. Paste the line below.\n\n"
|
||||
"RigDoctor starts a focused capture when the game launches and stops it on exit. "
|
||||
"If the game hard-freezes, you'll get a crash report next time you open RigDoctor."
|
||||
)
|
||||
info.setWordWrap(True)
|
||||
v.addWidget(info)
|
||||
row = QHBoxLayout()
|
||||
field = QLineEdit(option)
|
||||
field.setReadOnly(True)
|
||||
row.addWidget(field, 1)
|
||||
copy = QPushButton("Copy")
|
||||
copy.setObjectName("PrimaryButton")
|
||||
copy.clicked.connect(lambda: QApplication.clipboard().setText(option))
|
||||
row.addWidget(copy)
|
||||
v.addLayout(row)
|
||||
buttons = QHBoxLayout()
|
||||
buttons.addStretch(1)
|
||||
close = QPushButton("Close")
|
||||
close.clicked.connect(dlg.accept)
|
||||
buttons.addWidget(close)
|
||||
v.addLayout(buttons)
|
||||
dlg.exec()
|
||||
|
||||
# --- hard-crash recovery ----------------------------------------------------------
|
||||
|
||||
def _check_crash(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
info = diagnostic.pending_crash()
|
||||
if info is None:
|
||||
self._crash_banner.hide()
|
||||
return
|
||||
game = info.game or "your last game"
|
||||
extra = " · ⚠ GPU-lost was captured" if info.gpu_lost else ""
|
||||
self._crash_label.setText(
|
||||
f"⚠ Your last diagnostic for {game} ended unexpectedly — likely a hard crash "
|
||||
f"({info.samples} samples{extra}). Analyze it to see the final readings and the "
|
||||
f"likely cause from the system logs."
|
||||
)
|
||||
self._analyze_btn.setEnabled(True)
|
||||
self._crash_banner.show()
|
||||
|
||||
def _analyze_crash(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
diagnostic.acknowledge_crash() # don't prompt again for this one
|
||||
self._analyze_btn.setEnabled(False)
|
||||
self._crash_label.setText("Analyzing the crash (final readings + system logs)…")
|
||||
threading.Thread(target=self._work_analyze_crash, daemon=True).start()
|
||||
|
||||
def _work_analyze_crash(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
try:
|
||||
result = diagnostic.analyze_crash()
|
||||
except Exception:
|
||||
result = None
|
||||
self._diag_done.emit(result)
|
||||
|
||||
def _dismiss_crash(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
diagnostic.acknowledge_crash()
|
||||
self._crash_banner.hide()
|
||||
|
||||
# --- nav badge integration --------------------------------------------------------
|
||||
|
||||
def showEvent(self, event) -> None: # noqa: N802 (Qt override)
|
||||
# Viewing the list acknowledges the new games: clear the sidebar badge. The NEW
|
||||
# tags stay on the rows for this session so the user can still spot them.
|
||||
super().showEvent(event)
|
||||
if self._new_appids:
|
||||
from ..core import steam
|
||||
|
||||
threading.Thread(target=steam.acknowledge_new, daemon=True).start()
|
||||
self.new_count_changed.emit(0)
|
||||
|
||||
# Reflect a capture that's still running (e.g. started earlier, navigated back).
|
||||
from ..core import diagnostic
|
||||
|
||||
if diagnostic.is_running():
|
||||
status = diagnostic.active() or {}
|
||||
self._diag_game = status.get("game") or self._diag_game
|
||||
self._banner.show()
|
||||
if not self._diag_timer.isActive():
|
||||
self._diag_timer.start()
|
||||
else:
|
||||
self._check_crash() # re-surface an interrupted diagnostic if one is pending
|
||||
@@ -0,0 +1,96 @@
|
||||
"""Health page (M4 in the GUI): runs the health checks and shows findings as cards."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import threading
|
||||
import time
|
||||
|
||||
from PySide6.QtCore import Qt, QTimer, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from .widgets import finding_card
|
||||
|
||||
|
||||
class HealthPage(QWidget):
|
||||
_result = Signal(object) # list[Finding]
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._result.connect(self._render_findings)
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("System Health")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.addStretch(1)
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
header.addWidget(self._status)
|
||||
self._run_btn = QPushButton("Run health report")
|
||||
self._run_btn.setObjectName("PrimaryButton")
|
||||
self._run_btn.clicked.connect(self._run)
|
||||
header.addWidget(self._run_btn)
|
||||
root.addLayout(header)
|
||||
|
||||
scroll = QScrollArea()
|
||||
scroll.setWidgetResizable(True)
|
||||
scroll.setFrameShape(QFrame.Shape.NoFrame)
|
||||
scroll.setStyleSheet("background: transparent;")
|
||||
self._container = QWidget()
|
||||
self._list = QVBoxLayout(self._container)
|
||||
self._list.setContentsMargins(0, 0, 0, 0)
|
||||
self._list.setSpacing(10)
|
||||
self._list.setAlignment(Qt.AlignmentFlag.AlignTop)
|
||||
scroll.setWidget(self._container)
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
QTimer.singleShot(300, self._run) # auto-run shortly after the window opens
|
||||
|
||||
def _run(self) -> None:
|
||||
self._run_btn.setEnabled(False)
|
||||
self._status.setText("Scanning logs, SMART, and driver…")
|
||||
threading.Thread(target=self._work, daemon=True).start()
|
||||
|
||||
def _work(self) -> None:
|
||||
from ..core.health import run_health_checks
|
||||
|
||||
try:
|
||||
findings = run_health_checks()
|
||||
except Exception:
|
||||
findings = []
|
||||
self._result.emit(findings)
|
||||
|
||||
def _render_findings(self, findings) -> None:
|
||||
self._run_btn.setEnabled(True)
|
||||
if findings is None: # collection failed — keep current results
|
||||
self._status.setText("check failed")
|
||||
return
|
||||
|
||||
while self._list.count():
|
||||
item = self._list.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
|
||||
crit = sum(1 for f in findings if f.severity == "critical")
|
||||
warn = sum(1 for f in findings if f.severity == "warning")
|
||||
self._status.setText(
|
||||
f"{crit} critical · {warn} warning · {len(findings)} checks · "
|
||||
f"{time.strftime('%H:%M:%S')}"
|
||||
)
|
||||
for finding in findings:
|
||||
self._list.addWidget(finding_card(finding))
|
||||
self._list.addStretch(1)
|
||||
@@ -0,0 +1,150 @@
|
||||
"""Inventory page (M5 in the GUI): system inventory with copy/save + admin re-collect."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import threading
|
||||
|
||||
from PySide6.QtCore import Qt, QTimer, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QFileDialog,
|
||||
QFrame,
|
||||
QGridLayout,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..core import inventory
|
||||
|
||||
|
||||
def _section_card(section) -> QFrame:
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
layout = QVBoxLayout(card)
|
||||
layout.setContentsMargins(16, 12, 16, 12)
|
||||
layout.setSpacing(6)
|
||||
title = QLabel(section.title)
|
||||
title.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
layout.addWidget(title)
|
||||
grid = QGridLayout()
|
||||
grid.setColumnStretch(1, 1)
|
||||
grid.setHorizontalSpacing(14)
|
||||
grid.setVerticalSpacing(4)
|
||||
for row, (key, value) in enumerate(section.items):
|
||||
k = QLabel(key)
|
||||
k.setObjectName("Muted")
|
||||
v = QLabel(value)
|
||||
v.setWordWrap(True)
|
||||
v.setStyleSheet("background: transparent;")
|
||||
grid.addWidget(k, row, 0)
|
||||
grid.addWidget(v, row, 1)
|
||||
layout.addLayout(grid)
|
||||
return card
|
||||
|
||||
|
||||
class InventoryPage(QWidget):
|
||||
_result = Signal(object) # list[Section]
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._sections: list = []
|
||||
self._result.connect(self._render)
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("Inventory")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.addStretch(1)
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
header.addWidget(self._status)
|
||||
self._copy_btn = QPushButton("Copy Markdown")
|
||||
self._copy_btn.clicked.connect(self._copy)
|
||||
header.addWidget(self._copy_btn)
|
||||
self._save_btn = QPushButton("Save…")
|
||||
self._save_btn.clicked.connect(self._save)
|
||||
header.addWidget(self._save_btn)
|
||||
self._refresh_btn = QPushButton("Refresh")
|
||||
self._refresh_btn.setObjectName("PrimaryButton")
|
||||
self._refresh_btn.clicked.connect(self._run)
|
||||
header.addWidget(self._refresh_btn)
|
||||
root.addLayout(header)
|
||||
|
||||
self._scroll = scroll = QScrollArea()
|
||||
scroll.setWidgetResizable(True)
|
||||
scroll.setFrameShape(QFrame.Shape.NoFrame)
|
||||
scroll.setStyleSheet("background: transparent;")
|
||||
self._container = QWidget()
|
||||
self._list = QVBoxLayout(self._container)
|
||||
self._list.setContentsMargins(0, 0, 0, 0)
|
||||
self._list.setSpacing(12)
|
||||
self._list.setAlignment(Qt.AlignmentFlag.AlignTop)
|
||||
scroll.setWidget(self._container)
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
QTimer.singleShot(300, self._run)
|
||||
|
||||
def _run(self) -> None:
|
||||
self._busy("Collecting…")
|
||||
threading.Thread(target=self._work, daemon=True).start()
|
||||
|
||||
def _work(self) -> None:
|
||||
try:
|
||||
sections = inventory.collect()
|
||||
except Exception:
|
||||
sections = []
|
||||
self._result.emit(sections)
|
||||
|
||||
def _busy(self, text: str) -> None:
|
||||
self._status.setText(text)
|
||||
for b in (self._refresh_btn, self._copy_btn, self._save_btn):
|
||||
b.setEnabled(False)
|
||||
|
||||
def _render(self, sections) -> None:
|
||||
self._refresh_btn.setEnabled(True)
|
||||
self._copy_btn.setEnabled(True)
|
||||
self._save_btn.setEnabled(True)
|
||||
if sections is None: # collection failed — keep current
|
||||
self._status.setText("collection failed")
|
||||
return
|
||||
if sections == self._sections: # unchanged — don't rebuild (would jump scroll)
|
||||
self._status.setText("")
|
||||
return
|
||||
|
||||
scroll_pos = self._scroll.verticalScrollBar().value()
|
||||
self._sections = sections
|
||||
while self._list.count():
|
||||
item = self._list.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
for section in sections:
|
||||
self._list.addWidget(_section_card(section))
|
||||
self._list.addStretch(1)
|
||||
self._status.setText("")
|
||||
# restore scroll after the layout settles so re-renders don't yank to the top
|
||||
QTimer.singleShot(0, lambda: self._scroll.verticalScrollBar().setValue(scroll_pos))
|
||||
|
||||
def _copy(self) -> None:
|
||||
if self._sections:
|
||||
QApplication.clipboard().setText(inventory.render_markdown(self._sections))
|
||||
self._status.setText("copied as Markdown")
|
||||
|
||||
def _save(self) -> None:
|
||||
if not self._sections:
|
||||
return
|
||||
path, _ = QFileDialog.getSaveFileName(self, "Save inventory", "rigdoctor-inventory.md", "Markdown (*.md)")
|
||||
if path:
|
||||
with open(path, "w", encoding="utf-8") as f:
|
||||
f.write(inventory.render_markdown(self._sections))
|
||||
self._status.setText(f"saved {os.path.basename(path)}")
|
||||
@@ -2,37 +2,69 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from PySide6.QtCore import Qt
|
||||
import html
|
||||
import os
|
||||
import sys
|
||||
import threading
|
||||
from pathlib import Path
|
||||
|
||||
from PySide6.QtCore import Qt, QProcess, QTimer, Signal
|
||||
from PySide6.QtGui import QIcon, QTextDocument
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QButtonGroup,
|
||||
QDialog,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QMainWindow,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QStackedWidget,
|
||||
QSystemTrayIcon,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from .. import __version__
|
||||
from ..config import load_config
|
||||
from ..core import alerts, elevation, updates
|
||||
from .dashboard import Dashboard
|
||||
from .environment_page import EnvironmentPage
|
||||
from .games_page import GamesPage
|
||||
from .health_page import HealthPage
|
||||
from .inventory_page import InventoryPage
|
||||
from .recorder_page import RecorderPage
|
||||
from .theme import ACCENT, MUTED
|
||||
from .setup_page import SetupPage
|
||||
from .share_page import SharePage
|
||||
from .theme import ACCENT, CRIT, GOOD, MUTED, TEXT
|
||||
from .tray import TrayIcon
|
||||
from .worker import SamplerWorker
|
||||
|
||||
_NAV_ITEMS = ["Dashboard", "Logs", "Health", "Inventory"]
|
||||
_PLACEHOLDERS = {
|
||||
"Health": "The health report (M4) — log scan + plain-language findings — lands here.",
|
||||
"Inventory": "System inventory (M5) — CPU/GPU/board/RAM/drivers — lands here.",
|
||||
}
|
||||
# Sidebar grouped by intent. Each page name maps to a widget built in __init__; the stack is
|
||||
# filled in this order, so _PAGES.index(name) is the stack index.
|
||||
_NAV = [
|
||||
("Monitor", ["Dashboard"]),
|
||||
("Diagnose", ["Games", "Recordings", "System Health", "Tuning"]),
|
||||
("System", ["Inventory"]),
|
||||
("App", ["Settings", "Share"]),
|
||||
]
|
||||
_PAGES = [name for _section, names in _NAV for name in names]
|
||||
_ICON = Path(__file__).parent / "assets" / "rigdoctor.svg"
|
||||
|
||||
|
||||
class MainWindow(QMainWindow):
|
||||
_update_checked = Signal(object) # (state, tag, notes)
|
||||
_update_applied = Signal(int) # pip exit code
|
||||
_changelog_ready = Signal(object) # ([(tag, date, notes)], error)
|
||||
_elevated = Signal() # privileged data collected at launch
|
||||
|
||||
def __init__(self, interval: float = 1.0) -> None:
|
||||
super().__init__()
|
||||
self.setWindowTitle("RigDoctor")
|
||||
self.resize(1000, 680)
|
||||
cfg = load_config()
|
||||
|
||||
central = QWidget()
|
||||
self.setCentralWidget(central)
|
||||
@@ -48,10 +80,27 @@ class MainWindow(QMainWindow):
|
||||
self._stack = QStackedWidget()
|
||||
self.dashboard = Dashboard()
|
||||
self.recorder_page = RecorderPage()
|
||||
self._stack.addWidget(self.dashboard) # 0 Dashboard
|
||||
self._stack.addWidget(self.recorder_page) # 1 Logs
|
||||
self._stack.addWidget(self._placeholder_page("Health", _PLACEHOLDERS["Health"])) # 2
|
||||
self._stack.addWidget(self._placeholder_page("Inventory", _PLACEHOLDERS["Inventory"])) # 3
|
||||
self.health_page = HealthPage()
|
||||
self.games_page = GamesPage()
|
||||
self.games_page.new_count_changed.connect(self._set_games_badge)
|
||||
self.environment_page = EnvironmentPage()
|
||||
self.inventory_page = InventoryPage()
|
||||
self.setup_page = SetupPage()
|
||||
self.setup_page.changed.connect(self._apply_alert_settings)
|
||||
self.share_page = SharePage()
|
||||
# Page name → widget; the stack is filled in _PAGES order so indices line up.
|
||||
self._pages = {
|
||||
"Dashboard": self.dashboard,
|
||||
"Games": self.games_page,
|
||||
"Recordings": self.recorder_page,
|
||||
"System Health": self.health_page,
|
||||
"Tuning": self.environment_page,
|
||||
"Inventory": self.inventory_page,
|
||||
"Settings": self.setup_page,
|
||||
"Share": self.share_page,
|
||||
}
|
||||
for name in _PAGES:
|
||||
self._stack.addWidget(self._pages[name])
|
||||
content_layout.addWidget(self._stack)
|
||||
|
||||
layout.addWidget(self._build_sidebar())
|
||||
@@ -59,8 +108,64 @@ class MainWindow(QMainWindow):
|
||||
|
||||
self._worker = SamplerWorker(interval=interval)
|
||||
self._worker.sampled.connect(self.dashboard.update_sample)
|
||||
# Desktop alerts (M8): overheat / GPU-lost from the sample stream, new-version below.
|
||||
# Configurable on the Notifications page; gated by AlertMonitor.enabled.
|
||||
self._notified_update_tag = None
|
||||
self._alert_monitor = alerts.AlertMonitor(
|
||||
gpu_temp=float(cfg.get("gpu_temp_alert", 90.0)),
|
||||
cpu_temp=float(cfg.get("cpu_temp_alert", 95.0)),
|
||||
)
|
||||
self._alert_monitor.enabled = bool(cfg.get("alerts_enabled", True))
|
||||
self._worker.sampled.connect(self._alert_monitor.check)
|
||||
self._worker.start()
|
||||
|
||||
# Ask for the password once at launch and collect root-only data (SMART +
|
||||
# dmidecode); Health/Inventory then always show the full picture (config:
|
||||
# elevate_on_launch). Falls back silently to non-root if cancelled/unavailable.
|
||||
if cfg.get("elevate_on_launch", True) and elevation.available():
|
||||
self._elevated.connect(self._on_elevated)
|
||||
threading.Thread(target=self._collect_privileged, daemon=True).start()
|
||||
|
||||
# Update check (M13): once at launch, then periodically so a newly published
|
||||
# release is detected without restarting (interval from config; 0 disables).
|
||||
self._latest_tag = None
|
||||
self._latest_notes = ""
|
||||
self._applied = False
|
||||
self._update_checked.connect(self._show_update_state)
|
||||
self._update_applied.connect(self._on_update_applied)
|
||||
self._changelog_ready.connect(self._on_changelog)
|
||||
self._start_update_check()
|
||||
minutes = float(cfg.get("update_check_minutes", 30) or 0)
|
||||
if minutes > 0:
|
||||
self._update_timer = QTimer(self)
|
||||
self._update_timer.setInterval(int(minutes * 60_000))
|
||||
self._update_timer.timeout.connect(self._start_update_check)
|
||||
self._update_timer.start()
|
||||
|
||||
# Reflect any capture (manual, diagnostic, or the Steam wrapper) in the sidebar on
|
||||
# every page, so it's always clear when RigDoctor is recording and for which game.
|
||||
self._rec_timer = QTimer(self)
|
||||
self._rec_timer.setInterval(1500)
|
||||
self._rec_timer.timeout.connect(self._update_recording)
|
||||
self._rec_timer.start()
|
||||
self._update_recording()
|
||||
|
||||
# System-tray applet (M11) — optional; only when the desktop offers a tray. When
|
||||
# present, closing the window hides to the tray instead of quitting.
|
||||
self._tray = None
|
||||
self._quitting = False
|
||||
self._tray_hint_shown = False
|
||||
if QSystemTrayIcon.isSystemTrayAvailable():
|
||||
icon = self.windowIcon() if not self.windowIcon().isNull() else QIcon(str(_ICON))
|
||||
self._tray = TrayIcon(
|
||||
self, icon,
|
||||
gpu_alert=float(cfg.get("gpu_temp_alert", 90.0)),
|
||||
cpu_alert=float(cfg.get("cpu_temp_alert", 95.0)),
|
||||
)
|
||||
self._worker.sampled.connect(self._tray.update_sample)
|
||||
self._tray.show()
|
||||
QApplication.instance().setQuitOnLastWindowClosed(False)
|
||||
|
||||
def _build_sidebar(self) -> QFrame:
|
||||
bar = QFrame()
|
||||
bar.setObjectName("Sidebar")
|
||||
@@ -75,19 +180,38 @@ class MainWindow(QMainWindow):
|
||||
subtitle.setObjectName("AppSubtitle")
|
||||
v.addWidget(title)
|
||||
v.addWidget(subtitle)
|
||||
|
||||
# Global recording indicator — visible on every page while a capture runs.
|
||||
self._rec_indicator = QLabel()
|
||||
self._rec_indicator.setWordWrap(True)
|
||||
self._rec_indicator.setTextFormat(Qt.TextFormat.RichText)
|
||||
self._rec_indicator.setStyleSheet(
|
||||
f"background: #241316; border: 1px solid {CRIT}; border-radius: 8px; padding: 8px 10px;"
|
||||
)
|
||||
self._rec_indicator.hide()
|
||||
v.addSpacing(12)
|
||||
v.addWidget(self._rec_indicator)
|
||||
v.addSpacing(18)
|
||||
|
||||
group = QButtonGroup(self)
|
||||
group.setExclusive(True)
|
||||
for i, name in enumerate(_NAV_ITEMS):
|
||||
self._nav_buttons: dict[str, QPushButton] = {}
|
||||
for section, names in _NAV:
|
||||
header = QLabel(section.upper())
|
||||
header.setObjectName("NavSection")
|
||||
v.addSpacing(8)
|
||||
v.addWidget(header)
|
||||
for name in names:
|
||||
idx = _PAGES.index(name)
|
||||
btn = QPushButton(name)
|
||||
btn.setObjectName("NavButton")
|
||||
btn.setCheckable(True)
|
||||
btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
btn.setChecked(i == 0)
|
||||
btn.clicked.connect(lambda _checked, idx=i: self._stack.setCurrentIndex(idx))
|
||||
group.addButton(btn, i)
|
||||
btn.setChecked(idx == 0)
|
||||
btn.clicked.connect(lambda _checked, i=idx: self._stack.setCurrentIndex(i))
|
||||
group.addButton(btn, idx)
|
||||
v.addWidget(btn)
|
||||
self._nav_buttons[name] = btn
|
||||
|
||||
v.addStretch(1)
|
||||
live = QLabel(f'<span style="color:{ACCENT};">●</span> <span style="color:{MUTED};">Live</span>')
|
||||
@@ -95,31 +219,233 @@ class MainWindow(QMainWindow):
|
||||
version = QLabel(f"v{__version__}")
|
||||
version.setObjectName("Muted")
|
||||
v.addWidget(version)
|
||||
changelog_btn = QPushButton("Changelog")
|
||||
changelog_btn.setObjectName("LinkButton")
|
||||
changelog_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
changelog_btn.clicked.connect(self._show_changelog)
|
||||
v.addWidget(changelog_btn)
|
||||
check_btn = QPushButton("Check for updates")
|
||||
check_btn.setObjectName("LinkButton")
|
||||
check_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
check_btn.clicked.connect(self._manual_check)
|
||||
v.addWidget(check_btn)
|
||||
|
||||
# Update state (filled in by the background check).
|
||||
self._update_label = QLabel("checking for updates…")
|
||||
self._update_label.setObjectName("Muted")
|
||||
v.addWidget(self._update_label)
|
||||
self._update_btn = QPushButton()
|
||||
self._update_btn.setObjectName("PrimaryButton")
|
||||
self._update_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
self._update_btn.clicked.connect(self._apply_update)
|
||||
self._update_btn.setVisible(False)
|
||||
v.addWidget(self._update_btn)
|
||||
self._restart_btn = QPushButton("Restart now")
|
||||
self._restart_btn.setObjectName("PrimaryButton")
|
||||
self._restart_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
self._restart_btn.clicked.connect(self._restart)
|
||||
self._restart_btn.setVisible(False)
|
||||
v.addWidget(self._restart_btn)
|
||||
return bar
|
||||
|
||||
def _placeholder_page(self, title: str, description: str) -> QWidget:
|
||||
page = QWidget()
|
||||
page.setObjectName("Page")
|
||||
v = QVBoxLayout(page)
|
||||
v.setContentsMargins(20, 18, 20, 18)
|
||||
v.setSpacing(16)
|
||||
head = QLabel(title)
|
||||
head.setObjectName("PageTitle")
|
||||
v.addWidget(head)
|
||||
def _restart(self) -> None:
|
||||
gui = os.path.join(os.path.dirname(sys.executable), "rigdoctor-gui")
|
||||
if os.path.exists(gui):
|
||||
QProcess.startDetached(gui)
|
||||
else: # dev / not installed next to python
|
||||
QProcess.startDetached(sys.executable, sys.argv)
|
||||
QApplication.instance().quit()
|
||||
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
cv = QVBoxLayout(card)
|
||||
cv.setContentsMargins(24, 48, 24, 48)
|
||||
msg = QLabel(description)
|
||||
msg.setObjectName("Muted")
|
||||
msg.setWordWrap(True)
|
||||
msg.setAlignment(Qt.AlignmentFlag.AlignCenter)
|
||||
cv.addWidget(msg)
|
||||
v.addWidget(card)
|
||||
v.addStretch(1)
|
||||
return page
|
||||
def _apply_update(self) -> None:
|
||||
if not self._latest_tag:
|
||||
return
|
||||
box = QMessageBox(self)
|
||||
box.setWindowTitle(f"Update to {self._latest_tag}")
|
||||
box.setText(f"Update RigDoctor to {self._latest_tag}?")
|
||||
notes_doc = QTextDocument()
|
||||
notes_doc.setMarkdown(self._latest_notes or "_(no release notes)_")
|
||||
box.setInformativeText(notes_doc.toHtml()) # render Markdown as rich text (#1)
|
||||
box.setStandardButtons(QMessageBox.StandardButton.Ok | QMessageBox.StandardButton.Cancel)
|
||||
box.button(QMessageBox.StandardButton.Ok).setText("Update")
|
||||
if box.exec() != QMessageBox.StandardButton.Ok:
|
||||
return
|
||||
self._update_btn.setEnabled(False)
|
||||
self._update_label.setText("updating…")
|
||||
tag = self._latest_tag
|
||||
threading.Thread(target=lambda: self._update_applied.emit(updates.apply_update(tag)[0]), daemon=True).start()
|
||||
|
||||
def _on_update_applied(self, rc: int) -> None:
|
||||
if rc == 0:
|
||||
self._applied = True
|
||||
self._update_label.setText("update installed")
|
||||
self._update_btn.setVisible(False)
|
||||
self._restart_btn.setVisible(True)
|
||||
if hasattr(self, "_update_timer"):
|
||||
self._update_timer.stop()
|
||||
else:
|
||||
self._update_label.setText("update failed")
|
||||
self._update_btn.setEnabled(True)
|
||||
|
||||
def _collect_privileged(self) -> None:
|
||||
data = elevation.collect_via_pkexec()
|
||||
if data is not None:
|
||||
elevation.set_privileged(data)
|
||||
self._elevated.emit()
|
||||
|
||||
def _on_elevated(self) -> None:
|
||||
# Re-run Health + Inventory now that root-only data is available (SMART for Health,
|
||||
# dmidecode motherboard/BIOS/RAM for Inventory).
|
||||
self.health_page._run()
|
||||
self.inventory_page._run()
|
||||
|
||||
# --- tray-driven actions (M11) ----------------------------------------------------
|
||||
|
||||
def show_page(self, name: str) -> None:
|
||||
"""Bring the window forward on a given page (used by the tray)."""
|
||||
if name in self._nav_buttons:
|
||||
self._stack.setCurrentIndex(_PAGES.index(name))
|
||||
self._nav_buttons[name].setChecked(True)
|
||||
self.showNormal()
|
||||
self.raise_()
|
||||
self.activateWindow()
|
||||
|
||||
def show_dashboard(self) -> None:
|
||||
self.show_page("Dashboard")
|
||||
|
||||
def tray_available(self) -> bool:
|
||||
return self._tray is not None
|
||||
|
||||
def start_minimized_note(self) -> None:
|
||||
"""Started hidden to the tray (autostart) — let the user know it's there."""
|
||||
if self._tray is not None:
|
||||
self._tray_hint_shown = True
|
||||
self._tray.showMessage(
|
||||
"RigDoctor", "Running in the tray — right-click the icon for actions.",
|
||||
QSystemTrayIcon.MessageIcon.Information, 4000,
|
||||
)
|
||||
|
||||
def run_diagnostic(self, name: str, appid: str) -> None:
|
||||
self.show_page("Games")
|
||||
self.games_page._start_diagnostic(name, appid)
|
||||
|
||||
def quit_app(self) -> None:
|
||||
self._quitting = True
|
||||
self._worker.stop()
|
||||
self.share_page.shutdown()
|
||||
if self._tray is not None:
|
||||
self._tray.hide()
|
||||
QApplication.instance().quit()
|
||||
|
||||
def _update_recording(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
status = diagnostic.active()
|
||||
if not status:
|
||||
self._rec_indicator.hide()
|
||||
return
|
||||
game = status.get("game")
|
||||
lines = [f"<span style='color:{CRIT};'>●</span> <b style='color:{TEXT};'>Recording</b>"]
|
||||
if game:
|
||||
lines.append(f"<span style='color:{TEXT};'>{html.escape(str(game))}</span>")
|
||||
if status.get("gpu_lost"):
|
||||
lines.append(f"<span style='color:{CRIT};'>⚠ GPU-lost</span>")
|
||||
self._rec_indicator.setText("<br>".join(lines))
|
||||
self._rec_indicator.show()
|
||||
|
||||
def _set_games_badge(self, count: int) -> None:
|
||||
btn = self._nav_buttons.get("Games")
|
||||
if btn is not None:
|
||||
btn.setText(f"Games ● {count}" if count > 0 else "Games")
|
||||
|
||||
def _apply_alert_settings(self) -> None:
|
||||
cfg = load_config()
|
||||
self._alert_monitor.enabled = bool(cfg.get("alerts_enabled", True))
|
||||
self._alert_monitor.gpu_temp = float(cfg.get("gpu_temp_alert", 90.0))
|
||||
self._alert_monitor.cpu_temp = float(cfg.get("cpu_temp_alert", 95.0))
|
||||
|
||||
def _manual_check(self) -> None:
|
||||
if self._applied:
|
||||
return
|
||||
self._update_label.setText("checking for updates…")
|
||||
self._start_update_check()
|
||||
|
||||
def _start_update_check(self) -> None:
|
||||
threading.Thread(target=self._check_updates, daemon=True).start()
|
||||
|
||||
def _show_changelog(self) -> None:
|
||||
dialog = QDialog(self)
|
||||
dialog.setWindowTitle("RigDoctor — Changelog")
|
||||
dialog.resize(560, 540)
|
||||
layout = QVBoxLayout(dialog)
|
||||
view = QTextEdit()
|
||||
view.setObjectName("Report")
|
||||
view.setReadOnly(True)
|
||||
view.setPlainText("Loading…")
|
||||
layout.addWidget(view)
|
||||
self._changelog_view = view
|
||||
dialog.show()
|
||||
threading.Thread(target=self._fetch_changelog, daemon=True).start()
|
||||
|
||||
def _fetch_changelog(self) -> None:
|
||||
self._changelog_ready.emit(updates.list_releases())
|
||||
|
||||
def _on_changelog(self, result) -> None:
|
||||
view = getattr(self, "_changelog_view", None)
|
||||
if view is None:
|
||||
return
|
||||
releases, error = result
|
||||
if error == updates.NO_TOKEN:
|
||||
view.setPlainText("Add an update token (Setup → Update access) to load the changelog.")
|
||||
return
|
||||
if error or not releases:
|
||||
view.setPlainText("Couldn't load the changelog from the update server.")
|
||||
return
|
||||
blocks = []
|
||||
for tag, date, notes in releases:
|
||||
title = f"## {tag}" + (f" — {date}" if date else "")
|
||||
blocks.append(f"{title}\n\n{notes or '_(no notes)_'}")
|
||||
view.setMarkdown("\n\n".join(blocks)) # render Markdown instead of raw text (#1)
|
||||
|
||||
def _check_updates(self) -> None:
|
||||
self._update_checked.emit(updates.update_state())
|
||||
|
||||
def _show_update_state(self, result) -> None:
|
||||
if self._applied: # an update was applied this session; awaiting restart
|
||||
return
|
||||
state, tag, notes = result
|
||||
self._latest_tag = tag
|
||||
self._latest_notes = notes
|
||||
self._update_btn.setVisible(False)
|
||||
if state == updates.NO_TOKEN:
|
||||
self._update_label.setText("connect to update server")
|
||||
elif state == updates.AUTH:
|
||||
self._update_label.setText("update access denied")
|
||||
elif state == updates.NETWORK:
|
||||
self._update_label.setText("update check unavailable")
|
||||
elif state == updates.AVAILABLE:
|
||||
self._update_label.setText(f'<span style="color:{GOOD};">{tag} available</span>')
|
||||
self._update_btn.setText(f"Update to {tag}")
|
||||
self._update_btn.setVisible(True)
|
||||
if self._alert_monitor.enabled and tag != self._notified_update_tag:
|
||||
self._notified_update_tag = tag # once per version, not every poll
|
||||
alerts.notify("Update available", f"RigDoctor {tag} is available — open RigDoctor to update.")
|
||||
else: # UP_TO_DATE
|
||||
self._update_label.setText("up-to-date")
|
||||
|
||||
def closeEvent(self, event) -> None: # noqa: N802 (Qt override)
|
||||
# With a tray, closing the window hides it (the app keeps running for the tray
|
||||
# readouts + any capture); Quit from the tray menu exits for real.
|
||||
if self._tray is not None and not self._quitting:
|
||||
event.ignore()
|
||||
self.hide()
|
||||
if not self._tray_hint_shown:
|
||||
self._tray_hint_shown = True
|
||||
self._tray.showMessage(
|
||||
"RigDoctor",
|
||||
"Still running in the tray — right-click the icon for actions or Quit.",
|
||||
QSystemTrayIcon.MessageIcon.Information, 5000,
|
||||
)
|
||||
return
|
||||
self._worker.stop()
|
||||
self.share_page.shutdown()
|
||||
super().closeEvent(event)
|
||||
|
||||
@@ -1,16 +1,19 @@
|
||||
"""Recording & Logs page (M3 in the GUI): start/stop/status + post-crash report.
|
||||
"""Recordings page (M3 in the GUI): recorder controls + view/report any captured log.
|
||||
|
||||
Drives the same background recorder as the CLI via core.reccontrol, so the GUI and
|
||||
`rigdoctor record …` are interchangeable.
|
||||
Drives the same background recorder as the CLI via core.reccontrol, and surfaces the
|
||||
captured data — the always-on log, the last guided diagnostic, and a preserved hard-crash
|
||||
(which can be analyzed in place). One place to see what was captured and what it means.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import threading
|
||||
import time
|
||||
|
||||
from PySide6.QtCore import Qt, QTimer, QUrl
|
||||
from PySide6.QtCore import Qt, QTimer, QUrl, Signal
|
||||
from PySide6.QtGui import QDesktopServices, QFont
|
||||
from PySide6.QtWidgets import (
|
||||
QComboBox,
|
||||
QDoubleSpinBox,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
@@ -25,6 +28,7 @@ from .. import config
|
||||
from ..core import reccontrol
|
||||
from ..core.crashlog import summarize
|
||||
from ..render import format_headline, render_summary
|
||||
from .diagnostic_dialog import DiagnosticDialog
|
||||
from .theme import GOOD, MUTED, WARN
|
||||
|
||||
|
||||
@@ -45,31 +49,30 @@ def _fmt_time(value, fmt="%Y-%m-%d %H:%M:%S") -> str:
|
||||
|
||||
|
||||
class RecorderPage(QWidget):
|
||||
_analyzed = Signal(object) # DiagnosticResult from a crash analysis
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._analyzed.connect(self._show_analysis)
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
title = QLabel("Recording")
|
||||
title = QLabel("Recordings")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
|
||||
# --- Status + controls -------------------------------------------------
|
||||
status_card, status_layout = _panel("Status")
|
||||
|
||||
self._state = QLabel("○ Not recording")
|
||||
self._state.setStyleSheet(f"color: {MUTED}; font-weight: 700; background: transparent;")
|
||||
status_layout.addWidget(self._state)
|
||||
|
||||
self._info = QLabel("")
|
||||
self._info.setObjectName("Muted")
|
||||
status_layout.addWidget(self._info)
|
||||
|
||||
self._latest = QLabel("")
|
||||
status_layout.addWidget(self._latest)
|
||||
|
||||
self._warn = QLabel("")
|
||||
self._warn.setStyleSheet(f"color: {WARN}; font-weight: 600; background: transparent;")
|
||||
self._warn.setVisible(False)
|
||||
@@ -97,19 +100,20 @@ class RecorderPage(QWidget):
|
||||
status_layout.addLayout(controls)
|
||||
root.addWidget(status_card)
|
||||
|
||||
# --- Report ------------------------------------------------------------
|
||||
report_card = QFrame()
|
||||
report_card.setObjectName("Card")
|
||||
report_layout = QVBoxLayout(report_card)
|
||||
report_layout.setContentsMargins(16, 14, 16, 14)
|
||||
report_layout.setSpacing(10)
|
||||
# --- Captured logs -----------------------------------------------------
|
||||
report_card, report_layout = _panel("Captured logs")
|
||||
header = QHBoxLayout()
|
||||
report_title = QLabel("Post-crash report")
|
||||
report_title.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
header.addWidget(report_title)
|
||||
header.addStretch(1)
|
||||
header.addWidget(QLabel("Show:"))
|
||||
self._source = QComboBox()
|
||||
self._source.currentIndexChanged.connect(self._load_report)
|
||||
header.addWidget(self._source, 1)
|
||||
self._analyze_btn = QPushButton("Analyze crash")
|
||||
self._analyze_btn.setObjectName("ActionButton")
|
||||
self._analyze_btn.clicked.connect(self._analyze_crash)
|
||||
self._analyze_btn.setVisible(False)
|
||||
header.addWidget(self._analyze_btn)
|
||||
refresh_btn = QPushButton("Refresh")
|
||||
refresh_btn.clicked.connect(self._load_report)
|
||||
refresh_btn.clicked.connect(self._refresh_sources)
|
||||
header.addWidget(refresh_btn)
|
||||
report_layout.addLayout(header)
|
||||
|
||||
@@ -121,13 +125,12 @@ class RecorderPage(QWidget):
|
||||
report_layout.addWidget(self._report)
|
||||
root.addWidget(report_card, 1)
|
||||
|
||||
# Poll recorder status once a second (reflects CLI-driven sessions too).
|
||||
self._timer = QTimer(self)
|
||||
self._timer.setInterval(1000)
|
||||
self._timer.timeout.connect(self._refresh_status)
|
||||
self._timer.start()
|
||||
self._refresh_status()
|
||||
self._load_report()
|
||||
self._refresh_sources()
|
||||
|
||||
# --- actions ---------------------------------------------------------------
|
||||
def _on_start(self) -> None:
|
||||
@@ -139,12 +142,56 @@ class RecorderPage(QWidget):
|
||||
self._stop_btn.setEnabled(False)
|
||||
reccontrol.stop_background()
|
||||
QTimer.singleShot(600, self._refresh_status)
|
||||
QTimer.singleShot(900, self._load_report)
|
||||
QTimer.singleShot(900, self._refresh_sources)
|
||||
|
||||
def _open_folder(self) -> None:
|
||||
config.LOG_DIR.mkdir(parents=True, exist_ok=True)
|
||||
QDesktopServices.openUrl(QUrl.fromLocalFile(str(config.LOG_DIR)))
|
||||
|
||||
# --- captured logs ---------------------------------------------------------
|
||||
def _refresh_sources(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
current = self._source.currentData()
|
||||
self._source.blockSignals(True)
|
||||
self._source.clear()
|
||||
self._source.addItem("Always-on capture", str(config.LOG_FILE))
|
||||
if config.DIAG_LOG.exists():
|
||||
self._source.addItem("Last diagnostic", str(config.DIAG_LOG))
|
||||
if config.DIAG_CRASH.exists():
|
||||
self._source.addItem("Crash (unanalyzed)", str(config.DIAG_CRASH))
|
||||
# keep the previous selection if it's still present
|
||||
idx = self._source.findData(current) if current else -1
|
||||
self._source.setCurrentIndex(idx if idx >= 0 else 0)
|
||||
self._source.blockSignals(False)
|
||||
self._analyze_btn.setVisible(diagnostic.pending_crash() is not None)
|
||||
self._load_report()
|
||||
|
||||
def _load_report(self) -> None:
|
||||
path = self._source.currentData() or str(config.LOG_FILE)
|
||||
summary = summarize(path, last_n=10)
|
||||
self._report.setPlainText(render_summary(summary, log_path=path))
|
||||
|
||||
def _analyze_crash(self) -> None:
|
||||
self._analyze_btn.setEnabled(False)
|
||||
self._report.setPlainText("Analyzing the crash (final readings + system logs)…")
|
||||
threading.Thread(target=self._work_analyze, daemon=True).start()
|
||||
|
||||
def _work_analyze(self) -> None:
|
||||
from ..core import diagnostic
|
||||
|
||||
try:
|
||||
result = diagnostic.analyze_crash()
|
||||
except Exception:
|
||||
result = None
|
||||
self._analyzed.emit(result)
|
||||
|
||||
def _show_analysis(self, result) -> None:
|
||||
self._analyze_btn.setEnabled(True)
|
||||
if result is not None:
|
||||
DiagnosticDialog(result, self).exec()
|
||||
self._refresh_sources()
|
||||
|
||||
# --- refresh ---------------------------------------------------------------
|
||||
def _refresh_status(self) -> None:
|
||||
pid = reccontrol.running_pid()
|
||||
@@ -162,8 +209,10 @@ class RecorderPage(QWidget):
|
||||
self._interval.setEnabled(not running)
|
||||
|
||||
if status:
|
||||
game = status.get("game")
|
||||
game_line = f"Game: {game} " if game else ""
|
||||
self._info.setText(
|
||||
f"Samples: {status.get('samples', 0)} "
|
||||
f"{game_line}Samples: {status.get('samples', 0)} "
|
||||
f"Started: {_fmt_time(status.get('started'))} "
|
||||
f"Updated: {_fmt_time(status.get('updated'), '%H:%M:%S')}\n"
|
||||
f"Log: {status.get('log', config.LOG_FILE)}"
|
||||
@@ -179,7 +228,3 @@ class RecorderPage(QWidget):
|
||||
self._info.setText("No recording yet. Press “Start recording”.")
|
||||
self._latest.setText("")
|
||||
self._warn.setVisible(False)
|
||||
|
||||
def _load_report(self) -> None:
|
||||
summary = summarize(config.LOG_FILE, last_n=10)
|
||||
self._report.setPlainText(render_summary(summary, log_path=config.LOG_FILE))
|
||||
|
||||
@@ -0,0 +1,367 @@
|
||||
"""Settings page: components/deps, alerts (M8), account access (token), and uninstall."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import threading
|
||||
|
||||
from PySide6.QtCore import Qt, QUrl, Signal
|
||||
from PySide6.QtGui import QDesktopServices
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QCheckBox,
|
||||
QComboBox,
|
||||
QDoubleSpinBox,
|
||||
QFrame,
|
||||
QGridLayout,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QSizePolicy,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from .. import config
|
||||
from ..core import alerts, installer, service, sysenv, uninstall, updates
|
||||
from .theme import GOOD, MUTED, WARN
|
||||
|
||||
|
||||
def _panel(title: str) -> tuple[QFrame, QVBoxLayout]:
|
||||
frame = QFrame()
|
||||
frame.setObjectName("Card")
|
||||
frame.setSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Maximum)
|
||||
layout = QVBoxLayout(frame)
|
||||
layout.setContentsMargins(16, 14, 16, 14)
|
||||
layout.setSpacing(8)
|
||||
label = QLabel(title)
|
||||
label.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
layout.addWidget(label)
|
||||
return frame, layout
|
||||
|
||||
|
||||
_BACKEND_DESC = {
|
||||
"env": "token from $RIGDOCTOR_TOKEN",
|
||||
"keyring": "token stored in the OS keyring (encrypted)",
|
||||
"file": "token stored in a 0600 file — install libsecret-tools to encrypt it",
|
||||
"none": "no token saved",
|
||||
}
|
||||
|
||||
|
||||
class SetupPage(QWidget):
|
||||
_installed = Signal(int, str)
|
||||
_upd_state = Signal(object)
|
||||
_mode_applied = Signal(object) # (mode, ok, message) from a trigger-mode change
|
||||
changed = Signal() # alert settings saved — main window re-applies them live
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._installed.connect(self._on_installed)
|
||||
self._upd_state.connect(self._on_upd_state)
|
||||
self._mode_applied.connect(self._on_mode_applied)
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
title = QLabel("Settings")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
|
||||
env_card, env_layout = _panel("Environment")
|
||||
self._env = QLabel("")
|
||||
self._env.setObjectName("Muted")
|
||||
env_layout.addWidget(self._env)
|
||||
root.addWidget(env_card)
|
||||
|
||||
comp_card, comp_layout = _panel("Components & dependencies")
|
||||
self._components = QVBoxLayout()
|
||||
self._components.setSpacing(6)
|
||||
comp_layout.addLayout(self._components)
|
||||
controls = QHBoxLayout()
|
||||
self._install_btn = QPushButton("Install missing")
|
||||
self._install_btn.setObjectName("PrimaryButton")
|
||||
self._install_btn.clicked.connect(self._install)
|
||||
self._refresh_btn = QPushButton("Re-check")
|
||||
self._refresh_btn.clicked.connect(self._refresh)
|
||||
wizard_btn = QPushButton("Run setup wizard")
|
||||
wizard_btn.clicked.connect(self._run_wizard)
|
||||
controls.addWidget(self._install_btn)
|
||||
controls.addWidget(self._refresh_btn)
|
||||
controls.addWidget(wizard_btn)
|
||||
controls.addStretch(1)
|
||||
comp_layout.addLayout(controls)
|
||||
root.addWidget(comp_card)
|
||||
|
||||
# Alerts (M8) — folded in from the old Notifications page.
|
||||
alerts_card, alerts_layout = _panel("Notifications")
|
||||
self._alerts_enabled = QCheckBox("Enable desktop notifications")
|
||||
alerts_layout.addWidget(self._alerts_enabled)
|
||||
grid = QGridLayout()
|
||||
grid.setHorizontalSpacing(12)
|
||||
grid.setColumnStretch(2, 1)
|
||||
self._gpu_alert = self._spin()
|
||||
self._cpu_alert = self._spin()
|
||||
grid.addWidget(QLabel("GPU temperature alert"), 0, 0)
|
||||
grid.addWidget(self._gpu_alert, 0, 1)
|
||||
grid.addWidget(QLabel("CPU temperature alert"), 1, 0)
|
||||
grid.addWidget(self._cpu_alert, 1, 1)
|
||||
alerts_layout.addLayout(grid)
|
||||
alerts_note = QLabel("GPU-lost and new-version alerts are included whenever notifications are enabled.")
|
||||
alerts_note.setObjectName("Muted")
|
||||
alerts_note.setWordWrap(True)
|
||||
alerts_layout.addWidget(alerts_note)
|
||||
alerts_buttons = QHBoxLayout()
|
||||
save_alerts = QPushButton("Save")
|
||||
save_alerts.setObjectName("PrimaryButton")
|
||||
save_alerts.clicked.connect(self._save_alerts)
|
||||
test_alerts = QPushButton("Send test")
|
||||
test_alerts.clicked.connect(self._test_alerts)
|
||||
alerts_buttons.addWidget(save_alerts)
|
||||
alerts_buttons.addWidget(test_alerts)
|
||||
alerts_buttons.addStretch(1)
|
||||
self._alerts_status = QLabel("")
|
||||
self._alerts_status.setObjectName("Muted")
|
||||
alerts_buttons.addWidget(self._alerts_status)
|
||||
alerts_layout.addLayout(alerts_buttons)
|
||||
root.addWidget(alerts_card)
|
||||
|
||||
# Recording trigger (M9 / D6): when the crash logger runs.
|
||||
trig_card, trig_layout = _panel("Recording trigger")
|
||||
trig_desc = QLabel(
|
||||
"When the crash logger runs (uses a systemd --user service):\n"
|
||||
"• Manual — you start/stop it yourself.\n"
|
||||
"• Always-on — a background service records continuously.\n"
|
||||
"• Game-launch — auto-records while a Steam game is running."
|
||||
)
|
||||
trig_desc.setObjectName("Muted")
|
||||
trig_desc.setWordWrap(True)
|
||||
trig_layout.addWidget(trig_desc)
|
||||
trig_row = QHBoxLayout()
|
||||
self._trigger = QComboBox()
|
||||
self._trigger.addItems(list(service.MODES))
|
||||
apply_trigger = QPushButton("Apply")
|
||||
apply_trigger.setObjectName("PrimaryButton")
|
||||
apply_trigger.clicked.connect(self._apply_trigger)
|
||||
trig_row.addWidget(self._trigger, 1)
|
||||
trig_row.addWidget(apply_trigger)
|
||||
trig_layout.addLayout(trig_row)
|
||||
self._trigger_status = QLabel("")
|
||||
self._trigger_status.setObjectName("Muted")
|
||||
self._trigger_status.setWordWrap(True)
|
||||
trig_layout.addWidget(self._trigger_status)
|
||||
if not service.available():
|
||||
apply_trigger.setEnabled(False)
|
||||
self._trigger_status.setText("systemd --user isn't available on this system.")
|
||||
root.addWidget(trig_card)
|
||||
|
||||
# Account access (M13/M12): one Gitea token gates updates and session sharing.
|
||||
upd_card, upd_layout = _panel("Account access")
|
||||
hint = QLabel("A Gitea access token unlocks updates and session sharing. "
|
||||
"Create it with scopes <b>read:user</b> and <b>read:repository</b>.")
|
||||
hint.setObjectName("Muted")
|
||||
hint.setWordWrap(True)
|
||||
upd_layout.addWidget(hint)
|
||||
self._upd_status = QLabel("")
|
||||
self._upd_status.setObjectName("Muted")
|
||||
self._upd_status.setWordWrap(True)
|
||||
upd_layout.addWidget(self._upd_status)
|
||||
token_row = QHBoxLayout()
|
||||
self._token_input = QLineEdit()
|
||||
self._token_input.setEchoMode(QLineEdit.EchoMode.Password)
|
||||
self._token_input.setPlaceholderText("Paste a Gitea token (read:user + read:repository)")
|
||||
save_btn = QPushButton("Save token")
|
||||
save_btn.setObjectName("PrimaryButton")
|
||||
save_btn.clicked.connect(self._save_token)
|
||||
get_btn = QPushButton("Get a token")
|
||||
get_btn.clicked.connect(lambda: QDesktopServices.openUrl(QUrl(updates.TOKEN_PAGE)))
|
||||
token_row.addWidget(self._token_input, 1)
|
||||
token_row.addWidget(save_btn)
|
||||
token_row.addWidget(get_btn)
|
||||
upd_layout.addLayout(token_row)
|
||||
root.addWidget(upd_card)
|
||||
|
||||
self._output = QTextEdit()
|
||||
self._output.setObjectName("Report")
|
||||
self._output.setReadOnly(True)
|
||||
self._output.setMinimumHeight(160)
|
||||
self._output.setVisible(False)
|
||||
root.addWidget(self._output)
|
||||
root.addStretch(1)
|
||||
|
||||
danger = QHBoxLayout()
|
||||
danger.addStretch(1)
|
||||
uninstall_btn = QPushButton("Uninstall RigDoctor")
|
||||
uninstall_btn.setObjectName("DangerButton")
|
||||
uninstall_btn.clicked.connect(self._uninstall)
|
||||
danger.addWidget(uninstall_btn)
|
||||
root.addLayout(danger)
|
||||
|
||||
self._refresh()
|
||||
self._load_alerts()
|
||||
self._trigger.setCurrentText(config.load_config().get("trigger_mode", "manual"))
|
||||
self._refresh_update_status()
|
||||
|
||||
def _run_wizard(self) -> None:
|
||||
from .setup_wizard import SetupWizard
|
||||
|
||||
SetupWizard(self).exec()
|
||||
self._refresh()
|
||||
self._trigger.setCurrentText(config.load_config().get("trigger_mode", "manual"))
|
||||
|
||||
# --- recording trigger (M9) -----------------------------------------------
|
||||
def _apply_trigger(self) -> None:
|
||||
mode = self._trigger.currentText()
|
||||
self._trigger_status.setText(f"Applying “{mode}”… (may take a moment)")
|
||||
threading.Thread(target=self._work_trigger, args=(mode,), daemon=True).start()
|
||||
|
||||
def _work_trigger(self, mode: str) -> None:
|
||||
ok, msg = service.apply_mode(mode)
|
||||
self._mode_applied.emit((mode, ok, msg))
|
||||
|
||||
def _on_mode_applied(self, result) -> None:
|
||||
mode, ok, msg = result
|
||||
if ok:
|
||||
self._trigger_status.setText(f"Recording trigger set to “{mode}”.")
|
||||
else:
|
||||
self._trigger_status.setText(f"“{mode}” saved. {msg}")
|
||||
|
||||
# --- alerts (M8) ----------------------------------------------------------
|
||||
@staticmethod
|
||||
def _spin() -> QDoubleSpinBox:
|
||||
spin = QDoubleSpinBox()
|
||||
spin.setRange(40, 110)
|
||||
spin.setDecimals(0)
|
||||
spin.setSingleStep(1)
|
||||
spin.setSuffix(" °C")
|
||||
return spin
|
||||
|
||||
def _load_alerts(self) -> None:
|
||||
cfg = config.load_config()
|
||||
self._alerts_enabled.setChecked(bool(cfg.get("alerts_enabled", True)))
|
||||
self._gpu_alert.setValue(float(cfg.get("gpu_temp_alert", 90.0)))
|
||||
self._cpu_alert.setValue(float(cfg.get("cpu_temp_alert", 95.0)))
|
||||
|
||||
def _save_alerts(self) -> None:
|
||||
config.update_config(
|
||||
alerts_enabled=self._alerts_enabled.isChecked(),
|
||||
gpu_temp_alert=self._gpu_alert.value(),
|
||||
cpu_temp_alert=self._cpu_alert.value(),
|
||||
)
|
||||
self.changed.emit()
|
||||
self._alerts_status.setText("Saved.")
|
||||
|
||||
def _test_alerts(self) -> None:
|
||||
ok = alerts.notify("RigDoctor", "Test notification — alerts are working.")
|
||||
self._alerts_status.setText(
|
||||
"Test sent." if ok else "notify-send not found — install libnotify-bin above.")
|
||||
|
||||
def _uninstall(self) -> None:
|
||||
box = QMessageBox(self)
|
||||
box.setIcon(QMessageBox.Icon.Warning)
|
||||
box.setWindowTitle("Uninstall RigDoctor")
|
||||
box.setText("Uninstall RigDoctor?")
|
||||
box.setInformativeText(
|
||||
"This removes the app. Choose “Remove all” to also delete your settings, "
|
||||
"update token, and captured logs."
|
||||
)
|
||||
remove_all = box.addButton("Remove all", QMessageBox.ButtonRole.DestructiveRole)
|
||||
app_only = box.addButton("Uninstall", QMessageBox.ButtonRole.AcceptRole)
|
||||
box.addButton("Cancel", QMessageBox.ButtonRole.RejectRole)
|
||||
box.exec()
|
||||
clicked = box.clickedButton()
|
||||
if clicked is remove_all:
|
||||
purge = True
|
||||
elif clicked is app_only:
|
||||
purge = False
|
||||
else:
|
||||
return
|
||||
uninstall.uninstall(purge=purge)
|
||||
QMessageBox.information(self, "RigDoctor", "Uninstalling… RigDoctor will close now.")
|
||||
QApplication.instance().quit()
|
||||
|
||||
def _refresh(self) -> None:
|
||||
self._env.setText(
|
||||
f"Distro: {sysenv.distro_name()} "
|
||||
f"Package manager: {sysenv.package_manager() or 'none (apt required)'} "
|
||||
f"GPU: {', '.join(sysenv.gpu_vendors()) or 'unknown'}"
|
||||
)
|
||||
while self._components.count():
|
||||
item = self._components.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
|
||||
status = installer.component_status()
|
||||
for component, present in status:
|
||||
mark = "✓" if present else "✗"
|
||||
color = GOOD if present else MUTED
|
||||
row = QLabel(f"<span style='color:{color}'>[{mark}]</span> "
|
||||
f"<b>{component.name}</b> — {component.enables}")
|
||||
row.setTextFormat(Qt.TextFormat.RichText)
|
||||
row.setWordWrap(True)
|
||||
self._components.addWidget(row)
|
||||
|
||||
self._missing = [c for c, present in status if not present]
|
||||
self._install_btn.setEnabled(bool(self._missing) and sysenv.package_manager() == "apt")
|
||||
if not self._missing:
|
||||
self._install_btn.setText("All installed ✔")
|
||||
|
||||
def _install(self) -> None:
|
||||
packages = installer.missing_packages(self._missing)
|
||||
if not packages:
|
||||
return
|
||||
self._install_btn.setEnabled(False)
|
||||
self._install_btn.setText("Installing… (may prompt for password)")
|
||||
self._output.setVisible(True)
|
||||
self._output.setPlainText(f"Installing: {' '.join(packages)}\n")
|
||||
threading.Thread(target=self._work, args=(packages,), daemon=True).start()
|
||||
|
||||
def _work(self, packages: list[str]) -> None:
|
||||
rc, out = installer.install_packages(packages)
|
||||
self._installed.emit(rc, out)
|
||||
|
||||
def _on_installed(self, rc: int, out: str) -> None:
|
||||
self._output.setPlainText(out[-4000:])
|
||||
self._install_btn.setText("Install missing")
|
||||
self._refresh()
|
||||
# If libsecret-tools was just installed, move a file token into the keyring.
|
||||
if config.token_backend() == "file" and config.keyring_available():
|
||||
token = config.load_token()
|
||||
if token:
|
||||
config.save_token(token)
|
||||
self._refresh_update_status()
|
||||
|
||||
# --- update access (token) ------------------------------------------------
|
||||
def _save_token(self) -> None:
|
||||
token = self._token_input.text().strip()
|
||||
if not token:
|
||||
return
|
||||
config.save_token(token)
|
||||
self._token_input.clear()
|
||||
self._refresh_update_status()
|
||||
|
||||
def _refresh_update_status(self) -> None:
|
||||
self._upd_status.setText(f"{_BACKEND_DESC[config.token_backend()]} · checking…")
|
||||
threading.Thread(target=self._check_update, daemon=True).start()
|
||||
|
||||
def _check_update(self) -> None:
|
||||
self._upd_state.emit((config.token_backend(), updates.update_state()))
|
||||
|
||||
def _on_upd_state(self, result) -> None:
|
||||
backend, (state, tag, _notes) = result
|
||||
msg = {
|
||||
updates.NO_TOKEN: "paste a token below to enable updates",
|
||||
updates.AUTH: "token rejected — check its scope/permissions",
|
||||
updates.NETWORK: "couldn't reach the update server",
|
||||
updates.UP_TO_DATE: f"up to date ({tag})" if tag else "up to date",
|
||||
updates.AVAILABLE: f"update available: {tag}",
|
||||
}[state]
|
||||
color = GOOD if state == updates.AVAILABLE else (WARN if state == updates.AUTH else MUTED)
|
||||
self._upd_status.setText(
|
||||
f"<span style='color:{MUTED}'>{_BACKEND_DESC[backend]}</span> · "
|
||||
f"<span style='color:{color}'>{msg}</span>"
|
||||
)
|
||||
@@ -0,0 +1,259 @@
|
||||
"""First-run GUI setup wizard (M9): the full graphical installer/setup.
|
||||
|
||||
Bootstrap (Python venv + PySide6) is done by install.sh/.run; this wizard handles the rest
|
||||
graphically — environment summary → pick dependency bundles → install the missing apt packages
|
||||
→ choose the recording trigger → readiness summary. Shown automatically on first launch (until
|
||||
`setup_done`), re-runnable from Settings, and launched by install.sh after a fresh install.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import threading
|
||||
|
||||
from PySide6.QtCore import Qt, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QButtonGroup,
|
||||
QCheckBox,
|
||||
QDialog,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QRadioButton,
|
||||
QStackedWidget,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from .. import config
|
||||
from ..core import catalog, installer, service, sysenv
|
||||
|
||||
|
||||
class SetupWizard(QDialog):
|
||||
_installed = Signal(int, str)
|
||||
|
||||
def __init__(self, parent=None) -> None:
|
||||
super().__init__(parent)
|
||||
self.setWindowTitle("RigDoctor Setup")
|
||||
self.resize(620, 560)
|
||||
self.setObjectName("Page")
|
||||
self._installed.connect(self._on_installed)
|
||||
self._bundle_checks: dict[str, QCheckBox] = {}
|
||||
self._installing = False
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(22, 20, 22, 16)
|
||||
root.setSpacing(14)
|
||||
|
||||
self._stack = QStackedWidget()
|
||||
self._stack.addWidget(self._page_welcome()) # 0
|
||||
self._stack.addWidget(self._page_bundles()) # 1
|
||||
self._stack.addWidget(self._page_install()) # 2
|
||||
self._stack.addWidget(self._page_trigger()) # 3
|
||||
self._stack.addWidget(self._page_finish()) # 4
|
||||
root.addWidget(self._stack, 1)
|
||||
|
||||
nav = QHBoxLayout()
|
||||
self._skip_btn = QPushButton("Skip")
|
||||
self._skip_btn.clicked.connect(self._skip)
|
||||
self._back_btn = QPushButton("Back")
|
||||
self._back_btn.clicked.connect(lambda: self._go(-1))
|
||||
self._next_btn = QPushButton("Next")
|
||||
self._next_btn.setObjectName("PrimaryButton")
|
||||
self._next_btn.clicked.connect(lambda: self._go(1))
|
||||
nav.addWidget(self._skip_btn)
|
||||
nav.addStretch(1)
|
||||
nav.addWidget(self._back_btn)
|
||||
nav.addWidget(self._next_btn)
|
||||
root.addLayout(nav)
|
||||
|
||||
self._index = 0
|
||||
self._update_nav()
|
||||
|
||||
# --- pages -----------------------------------------------------------------
|
||||
def _page(self, title: str, subtitle: str = "") -> tuple[QWidget, QVBoxLayout]:
|
||||
page = QWidget()
|
||||
v = QVBoxLayout(page)
|
||||
v.setContentsMargins(0, 0, 0, 0)
|
||||
v.setSpacing(10)
|
||||
head = QLabel(title)
|
||||
head.setObjectName("PageTitle")
|
||||
v.addWidget(head)
|
||||
if subtitle:
|
||||
sub = QLabel(subtitle)
|
||||
sub.setObjectName("Muted")
|
||||
sub.setWordWrap(True)
|
||||
v.addWidget(sub)
|
||||
return page, v
|
||||
|
||||
def _page_welcome(self) -> QWidget:
|
||||
page, v = self._page(
|
||||
"Welcome to RigDoctor",
|
||||
"Let's set up monitoring and diagnostics for your machine. This takes a minute and "
|
||||
"needs no root for the app itself — only installing optional tools may ask for your "
|
||||
"password.",
|
||||
)
|
||||
env = QLabel(
|
||||
f"Detected:\n"
|
||||
f" • Distro: {sysenv.distro_name()}\n"
|
||||
f" • Package manager: {sysenv.package_manager() or 'none (apt required for extras)'}\n"
|
||||
f" • GPU: {', '.join(sysenv.gpu_vendors()) or 'unknown'}"
|
||||
)
|
||||
env.setObjectName("Muted")
|
||||
v.addWidget(env)
|
||||
v.addStretch(1)
|
||||
return page
|
||||
|
||||
def _page_bundles(self) -> QWidget:
|
||||
page, v = self._page(
|
||||
"Choose what to set up",
|
||||
"Pick the optional tool bundles to install. Core monitoring, crash capture, and the "
|
||||
"health report work without any of these — they just add capability.",
|
||||
)
|
||||
present = {c.id: ok for c, ok in installer.component_status()}
|
||||
for bundle, comps in catalog.by_bundle().items():
|
||||
missing = [c for c in comps if not present.get(c.id)]
|
||||
names = ", ".join(c.name for c in comps)
|
||||
tag = " — all installed ✓" if not missing else f" — {len(missing)} to install"
|
||||
cb = QCheckBox(f"{bundle}: {names}{tag}")
|
||||
cb.setChecked(bool(missing)) # default-check bundles with something to add
|
||||
cb.setEnabled(sysenv.package_manager() == "apt") # selectable even if already installed
|
||||
self._bundle_checks[bundle] = cb
|
||||
v.addWidget(cb)
|
||||
if sysenv.package_manager() != "apt":
|
||||
note = QLabel("Only apt is supported for installing tools, so these are read-only here.")
|
||||
note.setObjectName("Muted")
|
||||
note.setWordWrap(True)
|
||||
v.addWidget(note)
|
||||
v.addStretch(1)
|
||||
return page
|
||||
|
||||
def _page_install(self) -> QWidget:
|
||||
page, v = self._page("Install tools", "Installing the selected packages…")
|
||||
self._install_status = QLabel("")
|
||||
self._install_status.setObjectName("Muted")
|
||||
self._install_status.setWordWrap(True)
|
||||
v.addWidget(self._install_status)
|
||||
self._install_output = QTextEdit()
|
||||
self._install_output.setObjectName("Report")
|
||||
self._install_output.setReadOnly(True)
|
||||
v.addWidget(self._install_output, 1)
|
||||
return page
|
||||
|
||||
def _page_trigger(self) -> QWidget:
|
||||
page, v = self._page(
|
||||
"Recording trigger",
|
||||
"When the crash logger runs. You can change this any time in Settings.",
|
||||
)
|
||||
self._trigger_group = QButtonGroup(self)
|
||||
labels = {
|
||||
"manual": "Manual — start/stop recording yourself.",
|
||||
"always-on": "Always-on — a background service records continuously.",
|
||||
"game-launch": "Game-launch — auto-record while a Steam game runs.",
|
||||
}
|
||||
for i, (mode, text) in enumerate(labels.items()):
|
||||
rb = QRadioButton(text)
|
||||
rb.setProperty("mode", mode)
|
||||
rb.setChecked(mode == config.load_config().get("trigger_mode", "manual"))
|
||||
self._trigger_group.addButton(rb, i)
|
||||
v.addWidget(rb)
|
||||
if not service.available():
|
||||
note = QLabel("systemd --user isn't available, so always-on / game-launch can't be enabled here.")
|
||||
note.setObjectName("Muted")
|
||||
note.setWordWrap(True)
|
||||
v.addWidget(note)
|
||||
v.addStretch(1)
|
||||
return page
|
||||
|
||||
def _page_finish(self) -> QWidget:
|
||||
page, v = self._page("You're all set", "")
|
||||
self._finish_summary = QLabel("")
|
||||
self._finish_summary.setObjectName("Muted")
|
||||
self._finish_summary.setWordWrap(True)
|
||||
v.addWidget(self._finish_summary)
|
||||
v.addStretch(1)
|
||||
return page
|
||||
|
||||
# --- navigation ------------------------------------------------------------
|
||||
def _go(self, delta: int) -> None:
|
||||
if self._installing:
|
||||
return
|
||||
new = self._index + delta
|
||||
if new < 0:
|
||||
return
|
||||
if new >= self._stack.count(): # past the last page → finish
|
||||
self._finish()
|
||||
return
|
||||
self._index = new
|
||||
self._stack.setCurrentIndex(new)
|
||||
self._update_nav()
|
||||
if new == 2: # entering the install page
|
||||
self._run_install()
|
||||
elif new == 4: # entering the finish page
|
||||
self._fill_summary()
|
||||
|
||||
def _update_nav(self) -> None:
|
||||
self._back_btn.setEnabled(self._index > 0 and not self._installing)
|
||||
last = self._index == self._stack.count() - 1
|
||||
self._next_btn.setText("Finish" if last else "Next")
|
||||
self._skip_btn.setVisible(not last)
|
||||
|
||||
def _selected_components(self):
|
||||
present = {c.id: ok for c, ok in installer.component_status()}
|
||||
chosen = []
|
||||
for bundle, comps in catalog.by_bundle().items():
|
||||
if self._bundle_checks.get(bundle) and self._bundle_checks[bundle].isChecked():
|
||||
chosen += [c for c in comps if not present.get(c.id)]
|
||||
return chosen
|
||||
|
||||
def _run_install(self) -> None:
|
||||
packages = installer.missing_packages(self._selected_components())
|
||||
if not packages:
|
||||
self._install_status.setText("Nothing to install — your selected tools are already present.")
|
||||
self._install_output.setVisible(False)
|
||||
return
|
||||
self._installing = True
|
||||
self._update_nav()
|
||||
self._next_btn.setEnabled(False)
|
||||
self._install_status.setText("Installing… you may be asked for your password.")
|
||||
self._install_output.setVisible(True)
|
||||
self._install_output.setPlainText(f"Installing: {' '.join(packages)}\n")
|
||||
threading.Thread(target=lambda: self._installed.emit(*installer.install_packages(packages)), daemon=True).start()
|
||||
|
||||
def _on_installed(self, rc: int, out: str) -> None:
|
||||
self._installing = False
|
||||
self._install_output.setPlainText(out[-4000:])
|
||||
self._install_status.setText("Done." if rc == 0 else "Some packages may not have installed — see the log.")
|
||||
self._next_btn.setEnabled(True)
|
||||
self._update_nav()
|
||||
|
||||
def _fill_summary(self) -> None:
|
||||
from ..core.sources import available_sources
|
||||
|
||||
status = installer.component_status()
|
||||
present = sum(1 for _c, ok in status if ok)
|
||||
sources = len(available_sources())
|
||||
mode = self._chosen_mode()
|
||||
self._finish_summary.setText(
|
||||
f"• Optional tools present: {present}/{len(status)}\n"
|
||||
f"• Sensor sources detected: {sources}\n"
|
||||
f"• Recording trigger: {mode}\n\n"
|
||||
"You can re-run this wizard or change anything from Settings."
|
||||
)
|
||||
|
||||
def _chosen_mode(self) -> str:
|
||||
btn = self._trigger_group.checkedButton()
|
||||
return btn.property("mode") if btn else "manual"
|
||||
|
||||
def _finish(self) -> None:
|
||||
mode = self._chosen_mode()
|
||||
if service.available():
|
||||
service.apply_mode(mode)
|
||||
else:
|
||||
config.update_config(trigger_mode=mode)
|
||||
config.update_config(setup_done=True)
|
||||
self.accept()
|
||||
|
||||
def _skip(self) -> None:
|
||||
config.update_config(setup_done=True)
|
||||
self.reject()
|
||||
@@ -0,0 +1,348 @@
|
||||
"""Share page (M12): a shared **terminal** session over the relay.
|
||||
|
||||
The host shares a real PTY running their shell; the guest watches it live and — only if the
|
||||
host ticks "Allow the guest to type" — can run commands (as the host's user). The host reads
|
||||
along and can type too, e.g. a sudo password, which stays local and is never sent to the guest.
|
||||
This is the only share mode (the old read-only stats view was removed). Either terminal can be
|
||||
popped full-screen.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import base64
|
||||
import json
|
||||
|
||||
from PySide6.QtCore import Qt, QSocketNotifier, QUrl
|
||||
from PySide6.QtGui import QKeySequence, QShortcut
|
||||
from PySide6.QtWebSockets import QWebSocket
|
||||
from PySide6.QtWidgets import (
|
||||
QCheckBox,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QPushButton,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..config import load_config, load_token
|
||||
from ..core.pty_session import PtySession
|
||||
from .terminal_widget import TerminalView
|
||||
|
||||
|
||||
def _relay_url() -> str:
|
||||
return load_config().get("relay_url", "wss://rigdoctor.jesseyvanofferen.com").rstrip("/")
|
||||
|
||||
|
||||
def _b64(data: bytes) -> str:
|
||||
return base64.b64encode(data).decode("ascii")
|
||||
|
||||
|
||||
def _card(title: str) -> tuple[QFrame, QVBoxLayout]:
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
v = QVBoxLayout(card)
|
||||
v.setContentsMargins(16, 14, 16, 14)
|
||||
v.setSpacing(10)
|
||||
head = QLabel(title)
|
||||
head.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
v.addWidget(head)
|
||||
return card, v
|
||||
|
||||
|
||||
class SharePage(QWidget):
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._host_ws: QWebSocket | None = None
|
||||
self._guest_ws: QWebSocket | None = None
|
||||
self._pty: PtySession | None = None
|
||||
self._pty_notifier: QSocketNotifier | None = None
|
||||
self._guest_can_type = False
|
||||
self._fs: QWidget | None = None
|
||||
self._fs_state = None
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(14)
|
||||
title = QLabel("Share")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
root.addWidget(self._build_host(), 1)
|
||||
root.addWidget(self._build_guest(), 1)
|
||||
|
||||
# ------------------------------------------------------------------ host
|
||||
def _build_host(self) -> QFrame:
|
||||
card, v = _card("Host a terminal session")
|
||||
self._host_status = QLabel("Share a live terminal with someone who has an account.")
|
||||
self._host_status.setObjectName("Muted")
|
||||
self._host_status.setWordWrap(True)
|
||||
v.addWidget(self._host_status)
|
||||
|
||||
row = QHBoxLayout()
|
||||
self._start_btn = QPushButton("Start session")
|
||||
self._start_btn.setObjectName("PrimaryButton")
|
||||
self._start_btn.clicked.connect(self._start_host)
|
||||
self._stop_btn = QPushButton("Stop")
|
||||
self._stop_btn.setEnabled(False)
|
||||
self._stop_btn.clicked.connect(self._stop_host)
|
||||
self._code_label = QLabel("")
|
||||
self._code_label.setStyleSheet("font-weight:700; font-size:18px; color:#38bdf8; background:transparent;")
|
||||
self._code_label.setTextInteractionFlags(Qt.TextInteractionFlag.TextSelectableByMouse)
|
||||
self._host_fs_btn = QPushButton("Full screen")
|
||||
self._host_fs_btn.setEnabled(False)
|
||||
self._host_fs_btn.clicked.connect(lambda: self._enter_fullscreen(self._host_term))
|
||||
row.addWidget(self._start_btn)
|
||||
row.addWidget(self._stop_btn)
|
||||
row.addSpacing(12)
|
||||
row.addWidget(self._code_label)
|
||||
row.addStretch(1)
|
||||
row.addWidget(self._host_fs_btn)
|
||||
v.addLayout(row)
|
||||
|
||||
self._allow_input = QCheckBox(
|
||||
"Allow the guest to type — they run commands as your user (off = they only watch)")
|
||||
self._allow_input.setStyleSheet("color:#fb923c; background:transparent;")
|
||||
self._allow_input.toggled.connect(self._send_terminal_state)
|
||||
v.addWidget(self._allow_input)
|
||||
|
||||
self._host_term = TerminalView()
|
||||
self._host_term.keys.connect(lambda b: self._pty.write(b) if self._pty else None)
|
||||
self._host_term.resized.connect(lambda r, c: self._pty.set_size(r, c) if self._pty else None)
|
||||
self._host_term.setVisible(False)
|
||||
v.addWidget(self._host_term, 1)
|
||||
return card
|
||||
|
||||
def _start_host(self) -> None:
|
||||
if not load_token():
|
||||
self._host_status.setText("Set a Gitea access token in Settings → Account access first.")
|
||||
return
|
||||
self._host_status.setText("Connecting to the relay…")
|
||||
self._start_btn.setEnabled(False)
|
||||
self._host_ws = QWebSocket()
|
||||
self._host_ws.connected.connect(lambda: self._host_ws.sendTextMessage(json.dumps({"token": load_token()})))
|
||||
self._host_ws.textMessageReceived.connect(self._host_msg)
|
||||
self._host_ws.disconnected.connect(self._host_closed)
|
||||
self._host_ws.errorOccurred.connect(lambda *_: self._host_status.setText(f"Relay error: {self._host_ws.errorString()}"))
|
||||
self._host_ws.open(QUrl(_relay_url() + "/ws/host"))
|
||||
|
||||
def _host_msg(self, text: str) -> None:
|
||||
try:
|
||||
data = json.loads(text)
|
||||
except ValueError:
|
||||
return
|
||||
if data.get("error"):
|
||||
self._host_status.setText(f"Rejected: {data['error']}")
|
||||
return
|
||||
if "code" in data: # relay handshake → start the terminal immediately
|
||||
self._code_label.setText(data["code"])
|
||||
self._host_status.setText(
|
||||
f"Sharing as {data.get('user', '?')} — give this code to whoever should connect.")
|
||||
self._stop_btn.setEnabled(True)
|
||||
self._start_pty()
|
||||
self._send_terminal_state()
|
||||
return
|
||||
kind = data.get("type")
|
||||
if kind == "req_full": # a guest joined — tell them their typing permission
|
||||
self._send_terminal_state()
|
||||
elif kind == "pty_in" and self._pty and self._allow_input.isChecked():
|
||||
self._pty.write(base64.b64decode(data["data"]))
|
||||
elif kind == "pty_resize" and self._pty and self._allow_input.isChecked():
|
||||
self._pty.set_size(int(data["rows"]), int(data["cols"]))
|
||||
|
||||
def _send_terminal_state(self) -> None:
|
||||
if self._host_ws and self._code_label.text():
|
||||
self._host_ws.sendTextMessage(json.dumps({"type": "terminal", "enabled": self._allow_input.isChecked()}))
|
||||
|
||||
def _start_pty(self) -> None:
|
||||
if self._pty:
|
||||
return
|
||||
rows, cols = self._host_term.grid()
|
||||
self._pty = PtySession(rows=rows, cols=cols)
|
||||
self._pty_notifier = QSocketNotifier(self._pty.master_fd, QSocketNotifier.Type.Read, self)
|
||||
self._pty_notifier.activated.connect(self._on_pty_output)
|
||||
self._host_term.reset()
|
||||
self._host_term.setVisible(True)
|
||||
self._host_fs_btn.setEnabled(True)
|
||||
self._host_term.setFocus()
|
||||
|
||||
def _on_pty_output(self) -> None:
|
||||
if not self._pty:
|
||||
return
|
||||
data = self._pty.read()
|
||||
if not data: # shell exited
|
||||
self._stop_host()
|
||||
return
|
||||
self._host_term.feed(data)
|
||||
if self._host_ws:
|
||||
self._host_ws.sendTextMessage(json.dumps({"type": "pty", "data": _b64(data)}))
|
||||
|
||||
def _stop_pty(self) -> None:
|
||||
if self._pty_notifier:
|
||||
self._pty_notifier.setEnabled(False)
|
||||
self._pty_notifier = None
|
||||
if self._pty:
|
||||
self._pty.close()
|
||||
self._pty = None
|
||||
self._host_term.setVisible(False)
|
||||
self._host_fs_btn.setEnabled(False)
|
||||
|
||||
def _stop_host(self) -> None:
|
||||
self._stop_pty()
|
||||
if self._host_ws:
|
||||
self._host_ws.close()
|
||||
self._host_ws = None
|
||||
self._code_label.setText("")
|
||||
self._stop_btn.setEnabled(False)
|
||||
self._start_btn.setEnabled(True)
|
||||
self._host_status.setText("Stopped sharing.")
|
||||
|
||||
def _host_closed(self) -> None:
|
||||
self._stop_pty()
|
||||
self._start_btn.setEnabled(True)
|
||||
self._stop_btn.setEnabled(False)
|
||||
if self._code_label.text():
|
||||
self._code_label.setText("")
|
||||
self._host_status.setText("Disconnected from the relay.")
|
||||
|
||||
# ----------------------------------------------------------------- guest
|
||||
def _build_guest(self) -> QFrame:
|
||||
card, v = _card("Join a terminal session")
|
||||
row = QHBoxLayout()
|
||||
self._code_input = QLineEdit()
|
||||
self._code_input.setPlaceholderText("Enter share code")
|
||||
self._code_input.setMaxLength(6)
|
||||
self._code_input.setFixedWidth(160)
|
||||
self._join_btn = QPushButton("Join")
|
||||
self._join_btn.setObjectName("PrimaryButton")
|
||||
self._join_btn.clicked.connect(self._join)
|
||||
self._leave_btn = QPushButton("Leave")
|
||||
self._leave_btn.setEnabled(False)
|
||||
self._leave_btn.clicked.connect(self._leave)
|
||||
self._guest_fs_btn = QPushButton("Full screen")
|
||||
self._guest_fs_btn.setEnabled(False)
|
||||
self._guest_fs_btn.clicked.connect(lambda: self._enter_fullscreen(self._guest_term))
|
||||
row.addWidget(self._code_input)
|
||||
row.addWidget(self._join_btn)
|
||||
row.addWidget(self._leave_btn)
|
||||
row.addStretch(1)
|
||||
row.addWidget(self._guest_fs_btn)
|
||||
v.addLayout(row)
|
||||
self._guest_status = QLabel("")
|
||||
self._guest_status.setObjectName("Muted")
|
||||
self._guest_status.setWordWrap(True)
|
||||
v.addWidget(self._guest_status)
|
||||
|
||||
self._guest_term = TerminalView()
|
||||
self._guest_term.keys.connect(self._guest_key)
|
||||
self._guest_term.resized.connect(self._guest_resize)
|
||||
self._guest_term.setVisible(False)
|
||||
v.addWidget(self._guest_term, 1)
|
||||
return card
|
||||
|
||||
def _join(self) -> None:
|
||||
code = self._code_input.text().strip().upper()
|
||||
if not load_token():
|
||||
self._guest_status.setText("Set a Gitea access token in Settings → Account access first.")
|
||||
return
|
||||
if not code:
|
||||
self._guest_status.setText("Enter a share code.")
|
||||
return
|
||||
self._guest_status.setText("Connecting…")
|
||||
self._join_btn.setEnabled(False)
|
||||
self._guest_ws = QWebSocket()
|
||||
self._guest_ws.connected.connect(lambda: self._guest_ws.sendTextMessage(json.dumps({"token": load_token()})))
|
||||
self._guest_ws.textMessageReceived.connect(self._guest_msg)
|
||||
self._guest_ws.disconnected.connect(self._guest_closed)
|
||||
self._guest_ws.errorOccurred.connect(lambda *_: self._guest_status.setText(f"Relay error: {self._guest_ws.errorString()}"))
|
||||
self._guest_ws.open(QUrl(_relay_url() + "/ws/guest/" + code))
|
||||
|
||||
def _guest_msg(self, text: str) -> None:
|
||||
try:
|
||||
data = json.loads(text)
|
||||
except ValueError:
|
||||
return
|
||||
if data.get("error"):
|
||||
self._guest_status.setText(data["error"])
|
||||
return
|
||||
if "joined" in data:
|
||||
self._guest_status.setText(f"Connected to {data.get('host', '?')}'s terminal — watching.")
|
||||
self._leave_btn.setEnabled(True)
|
||||
self._guest_fs_btn.setEnabled(True)
|
||||
self._guest_term.reset()
|
||||
self._guest_term.setVisible(True)
|
||||
self._guest_ws.sendTextMessage(json.dumps({"type": "req_full"}))
|
||||
return
|
||||
kind = data.get("type")
|
||||
if kind == "terminal":
|
||||
self._guest_can_type = bool(data.get("enabled"))
|
||||
self._guest_status.setText(
|
||||
"You can type — your keystrokes run on the host's machine."
|
||||
if self._guest_can_type else "Read-only — watching the host's terminal.")
|
||||
if self._guest_can_type:
|
||||
self._guest_term.setFocus()
|
||||
self._guest_resize(*self._guest_term.grid())
|
||||
elif kind == "pty":
|
||||
self._guest_term.feed(base64.b64decode(data["data"]))
|
||||
|
||||
def _guest_key(self, data: bytes) -> None:
|
||||
if self._guest_ws and self._guest_can_type:
|
||||
self._guest_ws.sendTextMessage(json.dumps({"type": "pty_in", "data": _b64(data)}))
|
||||
|
||||
def _guest_resize(self, rows: int, cols: int) -> None:
|
||||
if self._guest_ws and self._guest_can_type:
|
||||
self._guest_ws.sendTextMessage(json.dumps({"type": "pty_resize", "rows": rows, "cols": cols}))
|
||||
|
||||
def _leave(self) -> None:
|
||||
if self._guest_ws:
|
||||
self._guest_ws.close()
|
||||
self._guest_ws = None
|
||||
self._guest_term.setVisible(False)
|
||||
self._guest_fs_btn.setEnabled(False)
|
||||
self._guest_can_type = False
|
||||
self._leave_btn.setEnabled(False)
|
||||
self._join_btn.setEnabled(True)
|
||||
self._guest_status.setText("Left the session.")
|
||||
|
||||
def _guest_closed(self) -> None:
|
||||
self._join_btn.setEnabled(True)
|
||||
self._leave_btn.setEnabled(False)
|
||||
if self._guest_term.isVisible():
|
||||
self._guest_status.setText("Session ended (host disconnected).")
|
||||
|
||||
# --------------------------------------------------------------- full screen
|
||||
def _enter_fullscreen(self, term: TerminalView) -> None:
|
||||
if self._fs is not None:
|
||||
return
|
||||
parent_layout = term.parentWidget().layout()
|
||||
self._fs_state = (parent_layout, parent_layout.indexOf(term), term)
|
||||
self._fs = QWidget()
|
||||
self._fs.setStyleSheet("background:#0d0f13;")
|
||||
lay = QVBoxLayout(self._fs)
|
||||
lay.setContentsMargins(0, 0, 0, 0)
|
||||
lay.setSpacing(0)
|
||||
hint = QLabel("Esc to exit full screen")
|
||||
hint.setObjectName("Muted")
|
||||
hint.setStyleSheet("padding:4px 10px; background:#15181e;")
|
||||
lay.addWidget(hint)
|
||||
lay.addWidget(term, 1)
|
||||
QShortcut(QKeySequence(Qt.Key.Key_Escape), self._fs, activated=self._leave_fullscreen)
|
||||
self._fs.showFullScreen()
|
||||
term.setFocus()
|
||||
|
||||
def _leave_fullscreen(self) -> None:
|
||||
if self._fs is None:
|
||||
return
|
||||
parent_layout, index, term = self._fs_state
|
||||
parent_layout.insertWidget(index, term)
|
||||
self._fs.close()
|
||||
self._fs = None
|
||||
self._fs_state = None
|
||||
term.setFocus()
|
||||
|
||||
def shutdown(self) -> None:
|
||||
self._stop_pty()
|
||||
for ws in (self._host_ws, self._guest_ws):
|
||||
if ws:
|
||||
ws.close()
|
||||
@@ -0,0 +1,161 @@
|
||||
"""A terminal view: renders PTY output via pyte (with colors) and emits keystrokes (M12).
|
||||
|
||||
Used by both sides of a shared session — the host (mirrors its local PTY, can also type, e.g.
|
||||
a sudo password) and the guest (renders the streamed PTY, sends keystrokes). Renders pyte's
|
||||
per-cell foreground/background/bold/reverse so the host's real shell (e.g. fish) keeps its
|
||||
colors and theming; cursor addressing (vim, top) works via pyte. Scrollback is preserved.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import html as _html
|
||||
|
||||
import pyte
|
||||
from PySide6.QtCore import Qt, Signal
|
||||
from PySide6.QtGui import QFontDatabase, QFontMetrics
|
||||
from PySide6.QtWidgets import QTextEdit
|
||||
|
||||
# ANSI named colors → RGB (a dark, modern palette). pyte also yields 6-hex strings for
|
||||
# 256-color / truecolor, which we pass through, and "default" which maps to the theme.
|
||||
_FG_DEFAULT = "#d6dae0"
|
||||
_BG_DEFAULT = "#0d0f13"
|
||||
_NAMED = {
|
||||
"black": "#2a2f39", "red": "#f87171", "green": "#4ade80", "brown": "#e5c07b",
|
||||
"yellow": "#e5c07b", "blue": "#60a5fa", "magenta": "#c084fc", "cyan": "#38bdf8",
|
||||
"white": "#d6dae0",
|
||||
}
|
||||
_BRIGHT = { # bold brightens the standard 8
|
||||
"black": "#5b626c", "red": "#fca5a5", "green": "#86efac", "brown": "#fde68a",
|
||||
"yellow": "#fde68a", "blue": "#93c5fd", "magenta": "#d8b4fe", "cyan": "#7dd3fc",
|
||||
"white": "#ffffff",
|
||||
}
|
||||
_HISTORY_RENDER = 400 # cap scrollback rows rendered per frame (perf)
|
||||
|
||||
|
||||
def _color(name: str, default: str, bright: bool) -> str:
|
||||
if name == "default":
|
||||
return default
|
||||
table = _BRIGHT if bright else _NAMED
|
||||
if name in table:
|
||||
return table[name]
|
||||
if len(name) == 6: # pyte 256/truecolor as a hex string
|
||||
try:
|
||||
int(name, 16)
|
||||
return "#" + name
|
||||
except ValueError:
|
||||
pass
|
||||
return default
|
||||
|
||||
|
||||
class TerminalView(QTextEdit):
|
||||
keys = Signal(bytes) # user keystrokes -> bytes for the PTY
|
||||
resized = Signal(int, int) # rows, cols
|
||||
|
||||
def __init__(self, rows: int = 24, cols: int = 80):
|
||||
super().__init__()
|
||||
self.setLineWrapMode(QTextEdit.LineWrapMode.NoWrap)
|
||||
self.setFont(QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont))
|
||||
self.setUndoRedoEnabled(False)
|
||||
self.setReadOnly(False) # we capture keys ourselves; no local editing
|
||||
self.setStyleSheet(f"QTextEdit {{ background: {_BG_DEFAULT}; border: none; }}")
|
||||
self.setMinimumHeight(320)
|
||||
self._rows, self._cols = rows, cols
|
||||
self._screen = pyte.HistoryScreen(cols, rows, history=2000, ratio=0.5)
|
||||
self._stream = pyte.ByteStream(self._screen)
|
||||
|
||||
def grid(self) -> tuple[int, int]:
|
||||
return self._rows, self._cols
|
||||
|
||||
def feed(self, data: bytes) -> None:
|
||||
self._stream.feed(data)
|
||||
self._render()
|
||||
|
||||
def reset(self) -> None:
|
||||
self._screen.reset()
|
||||
self._render()
|
||||
|
||||
# --- rendering ---------------------------------------------------------------------
|
||||
def _span(self, style, text: str) -> str:
|
||||
fg_name, bg_name, bold, reverse = style
|
||||
fg = _color(fg_name, _FG_DEFAULT, bold)
|
||||
bg = _color(bg_name, _BG_DEFAULT, False)
|
||||
if reverse:
|
||||
fg, bg = bg, fg
|
||||
esc = _html.escape(text, quote=False).replace(" ", " ")
|
||||
weight = "font-weight:bold;" if bold else ""
|
||||
return f'<span style="color:{fg};background:{bg};{weight}">{esc}</span>'
|
||||
|
||||
def _row_html(self, row, cursor_x) -> str:
|
||||
out: list[str] = []
|
||||
buf: list[str] = []
|
||||
cur_style = None
|
||||
for x in range(self._cols):
|
||||
ch = row[x]
|
||||
reverse = ch.reverse
|
||||
if cursor_x is not None and x == cursor_x and self.hasFocus():
|
||||
reverse = not reverse # block cursor = inverted cell
|
||||
style = (ch.fg, ch.bg, ch.bold, reverse)
|
||||
if style != cur_style:
|
||||
if buf:
|
||||
out.append(self._span(cur_style, "".join(buf)))
|
||||
buf = []
|
||||
cur_style = style
|
||||
buf.append(ch.data or " ")
|
||||
if buf:
|
||||
out.append(self._span(cur_style, "".join(buf)))
|
||||
return "".join(out)
|
||||
|
||||
def _render(self) -> None:
|
||||
bar = self.verticalScrollBar()
|
||||
at_bottom = bar.value() >= bar.maximum() - 2
|
||||
prev = bar.value()
|
||||
|
||||
history = list(self._screen.history.top)[-_HISTORY_RENDER:]
|
||||
lines = [self._row_html(r, None) for r in history]
|
||||
cur_y = self._screen.cursor.y
|
||||
for y in range(self._rows):
|
||||
cursor_x = self._screen.cursor.x if y == cur_y else None
|
||||
lines.append(self._row_html(self._screen.buffer[y], cursor_x))
|
||||
self.setHtml('<div style="white-space:pre;line-height:100%;">' + "<br>".join(lines) + "</div>")
|
||||
|
||||
bar.setValue(bar.maximum() if at_bottom else prev)
|
||||
|
||||
def resizeEvent(self, event): # noqa: N802 (Qt override)
|
||||
super().resizeEvent(event)
|
||||
fm = QFontMetrics(self.font())
|
||||
cw = max(1, fm.horizontalAdvance("M"))
|
||||
ch = max(1, fm.height())
|
||||
cols = max(20, self.viewport().width() // cw)
|
||||
rows = max(6, self.viewport().height() // ch)
|
||||
if (rows, cols) != (self._rows, self._cols):
|
||||
self._rows, self._cols = rows, cols
|
||||
self._screen.resize(rows, cols)
|
||||
self._render()
|
||||
self.resized.emit(rows, cols)
|
||||
|
||||
def keyPressEvent(self, event): # noqa: N802 (Qt override)
|
||||
data = self._translate(event)
|
||||
if data:
|
||||
self.keys.emit(data)
|
||||
event.accept() # display comes from PTY output, not local editing
|
||||
|
||||
@staticmethod
|
||||
def _translate(event) -> bytes:
|
||||
key = event.key()
|
||||
mod = event.modifiers()
|
||||
k = Qt.Key
|
||||
if mod & Qt.KeyboardModifier.ControlModifier and k.Key_A.value <= key <= k.Key_Z.value:
|
||||
return bytes([key - k.Key_A.value + 1]) # Ctrl-A..Ctrl-Z
|
||||
special = {
|
||||
k.Key_Return.value: b"\r", k.Key_Enter.value: b"\r",
|
||||
k.Key_Backspace.value: b"\x7f", k.Key_Tab.value: b"\t",
|
||||
k.Key_Escape.value: b"\x1b",
|
||||
k.Key_Up.value: b"\x1b[A", k.Key_Down.value: b"\x1b[B",
|
||||
k.Key_Right.value: b"\x1b[C", k.Key_Left.value: b"\x1b[D",
|
||||
k.Key_Home.value: b"\x1b[H", k.Key_End.value: b"\x1b[F",
|
||||
k.Key_Delete.value: b"\x1b[3~", k.Key_PageUp.value: b"\x1b[5~", k.Key_PageDown.value: b"\x1b[6~",
|
||||
}
|
||||
if key in special:
|
||||
return special[key]
|
||||
text = event.text()
|
||||
return text.encode("utf-8") if text else b""
|
||||
@@ -2,6 +2,10 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
_CHECK = (Path(__file__).parent / "assets" / "check.svg").as_posix()
|
||||
|
||||
# Palette (dark)
|
||||
BG = "#101216"
|
||||
SIDEBAR = "#15181e"
|
||||
@@ -10,6 +14,7 @@ CARD_BORDER = "#2a2f39"
|
||||
TRACK = "#2a2f39"
|
||||
TEXT = "#e6e8eb"
|
||||
MUTED = "#8b929c"
|
||||
INPUT_BG = "#0d0f13" # form-control background (must stay dark — see contrast rule)
|
||||
|
||||
ACCENT = "#38bdf8"
|
||||
COLD = "#7dd3fc" # icey-blue
|
||||
@@ -72,6 +77,7 @@ QPushButton#NavButton {{
|
||||
}}
|
||||
QPushButton#NavButton:hover {{ background: {CARD}; color: {TEXT}; }}
|
||||
QPushButton#NavButton:checked {{ background: {CARD}; color: #ffffff; font-weight: 600; }}
|
||||
QLabel#NavSection {{ color: {MUTED}; font-size: 10px; font-weight: 800; letter-spacing: 1px; padding: 2px 12px 0; }}
|
||||
|
||||
#Card {{ background: {CARD}; border: 1px solid {CARD_BORDER}; border-radius: 12px; }}
|
||||
QPushButton#CardHeader {{
|
||||
@@ -99,6 +105,15 @@ QPushButton#PrimaryButton {{ background: {ACCENT}; color: #06222e; border: none;
|
||||
QPushButton#PrimaryButton:hover {{ background: #5cc8fb; }}
|
||||
QPushButton#PrimaryButton:disabled {{ background: #27424f; color: #5f7c8a; }}
|
||||
|
||||
/* Inline per-finding action buttons (Install / Apply). Outlined: bright accent text on the
|
||||
dark card so it stays readable regardless of fill painting; fills accent on hover. */
|
||||
QPushButton#ActionButton {{
|
||||
background: transparent; color: {ACCENT}; border: 1px solid {ACCENT};
|
||||
border-radius: 8px; padding: 6px 16px; font-weight: 700; min-height: 18px;
|
||||
}}
|
||||
QPushButton#ActionButton:hover {{ background: {ACCENT}; color: #06222e; }}
|
||||
QPushButton#ActionButton:disabled {{ color: {MUTED}; border-color: {CARD_BORDER}; }}
|
||||
|
||||
QDoubleSpinBox, QSpinBox {{
|
||||
background: #262b34; color: {TEXT}; border: 1px solid {CARD_BORDER};
|
||||
border-radius: 6px; padding: 4px 6px;
|
||||
@@ -107,4 +122,69 @@ QDoubleSpinBox, QSpinBox {{
|
||||
QTextEdit#Report {{
|
||||
background: #0d0f13; color: #cfd3da; border: 1px solid {CARD_BORDER}; border-radius: 8px;
|
||||
}}
|
||||
|
||||
QPushButton#DangerButton {{
|
||||
background: transparent; color: {CRIT}; border: 1px solid {CRIT};
|
||||
border-radius: 8px; padding: 7px 14px;
|
||||
}}
|
||||
QPushButton#DangerButton:hover {{ background: {CRIT}; color: #1a0d0d; }}
|
||||
|
||||
QPushButton#LinkButton {{
|
||||
background: transparent; border: none; color: {MUTED};
|
||||
text-align: left; padding: 0; text-decoration: underline;
|
||||
}}
|
||||
QPushButton#LinkButton:hover {{ color: {TEXT}; }}
|
||||
|
||||
QCheckBox {{ spacing: 8px; background: transparent; }}
|
||||
QCheckBox::indicator {{
|
||||
width: 17px; height: 17px; border-radius: 4px;
|
||||
border: 1px solid {MUTED}; background: #262b34;
|
||||
}}
|
||||
QCheckBox::indicator:hover {{ border-color: {ACCENT}; }}
|
||||
QCheckBox::indicator:checked {{
|
||||
background: {ACCENT}; border-color: {ACCENT}; image: url("{_CHECK}");
|
||||
}}
|
||||
QCheckBox::indicator:disabled {{ border-color: #3a414d; background: #1c2026; }}
|
||||
QCheckBox::indicator:checked:disabled {{ background: #2a6175; border-color: #2a6175; }}
|
||||
QCheckBox:disabled {{ color: {MUTED}; }}
|
||||
|
||||
/* Radio buttons — same dark treatment as checkboxes; the selected one gets a clear
|
||||
accent dot (Fusion leaves these unstyled = the selection is invisible on dark). */
|
||||
QRadioButton {{ spacing: 8px; background: transparent; }}
|
||||
QRadioButton::indicator {{
|
||||
width: 17px; height: 17px; border-radius: 9px;
|
||||
border: 1px solid {MUTED}; background: #262b34;
|
||||
}}
|
||||
QRadioButton::indicator:hover {{ border-color: {ACCENT}; }}
|
||||
QRadioButton::indicator:checked {{
|
||||
border: 1px solid {ACCENT};
|
||||
background: qradialgradient(cx:0.5, cy:0.5, radius:0.5, fx:0.5, fy:0.5,
|
||||
stop:0 {ACCENT}, stop:0.5 {ACCENT}, stop:0.55 #262b34, stop:1 #262b34);
|
||||
}}
|
||||
QRadioButton:disabled {{ color: {MUTED}; }}
|
||||
|
||||
/* Dialogs (update prompt, changelog) — match the dark theme so text is readable. */
|
||||
QDialog {{ background: {BG}; }}
|
||||
QMessageBox {{ background: {CARD}; }}
|
||||
QDialog QLabel, QMessageBox QLabel {{ color: {TEXT}; background: transparent; }}
|
||||
|
||||
/* Form controls: keep dark bg + light text (Fusion defaults to light-on-light here). */
|
||||
QLineEdit, QPlainTextEdit, QAbstractSpinBox, QComboBox {{
|
||||
background: {INPUT_BG}; color: {TEXT};
|
||||
border: 1px solid {CARD_BORDER}; border-radius: 6px; padding: 5px 8px;
|
||||
selection-background-color: {ACCENT}; selection-color: #06222e;
|
||||
}}
|
||||
QLineEdit:focus, QPlainTextEdit:focus, QAbstractSpinBox:focus, QComboBox:focus {{
|
||||
border: 1px solid {ACCENT};
|
||||
}}
|
||||
QLineEdit:disabled, QPlainTextEdit:disabled, QAbstractSpinBox:disabled {{ color: {MUTED}; }}
|
||||
|
||||
/* The combo-box drop-down list is a separate popup view — unstyled it renders
|
||||
light-on-light (same Fusion trap as the closed control above). */
|
||||
QComboBox QAbstractItemView {{
|
||||
background: {CARD}; color: {TEXT};
|
||||
border: 1px solid {CARD_BORDER}; outline: 0;
|
||||
selection-background-color: {ACCENT}; selection-color: #06222e;
|
||||
}}
|
||||
QComboBox QAbstractItemView::item {{ padding: 5px 8px; min-height: 22px; }}
|
||||
"""
|
||||
|
||||
@@ -0,0 +1,144 @@
|
||||
"""System-tray applet (M11, D13): live readouts + quick actions over the shared engine.
|
||||
|
||||
A QSystemTrayIcon whose menu shows at-a-glance CPU/GPU temp + memory and a status dot, led
|
||||
by **Run Diagnostic** (the guided session), plus Open dashboard / Start-Stop recording /
|
||||
Snapshot / Quit. It consumes the same sample stream as the dashboard (no extra sampling) and
|
||||
drives the existing MainWindow flows — one engine, another front-end.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from PySide6.QtWidgets import QApplication, QMenu, QSystemTrayIcon
|
||||
|
||||
from ..core import reccontrol
|
||||
|
||||
|
||||
def _gpu_temp(sample):
|
||||
for r in sample.readings:
|
||||
if r.source == "gpu" and r.metric == "temp" and r.label == "" and r.value is not None:
|
||||
return r.value
|
||||
return None
|
||||
|
||||
|
||||
def _cpu_temp(sample):
|
||||
temps = [r for r in sample.readings if r.source == "cpu" and r.metric == "temp" and r.value is not None]
|
||||
for r in temps:
|
||||
low = r.label.lower()
|
||||
if low.startswith("package") or "tctl" in low or "tdie" in low:
|
||||
return r.value
|
||||
return max((r.value for r in temps), default=None)
|
||||
|
||||
|
||||
def _memory(sample):
|
||||
used = total = pct = None
|
||||
for r in sample.readings:
|
||||
if r.source == "memory":
|
||||
if r.metric == "used":
|
||||
used = r.value
|
||||
elif r.metric == "total":
|
||||
total = r.value
|
||||
elif r.metric == "used_pct":
|
||||
pct = r.value
|
||||
return used, total, pct
|
||||
|
||||
|
||||
def _gpu_lost(sample) -> bool:
|
||||
return any(r.source == "gpu" and r.metric == "status" and r.label == "query-timeout"
|
||||
for r in sample.readings)
|
||||
|
||||
|
||||
class TrayIcon(QSystemTrayIcon):
|
||||
def __init__(self, window, icon, gpu_alert: float = 90.0, cpu_alert: float = 95.0) -> None:
|
||||
super().__init__(icon, window)
|
||||
self._window = window
|
||||
self._gpu_alert = gpu_alert
|
||||
self._cpu_alert = cpu_alert
|
||||
self._last = None
|
||||
self.setToolTip("RigDoctor")
|
||||
|
||||
menu = QMenu()
|
||||
self._status_act = self._readout(menu, "● starting…")
|
||||
self._cpu_act = self._readout(menu, "CPU temp: —")
|
||||
self._gpu_act = self._readout(menu, "GPU temp: —")
|
||||
self._mem_act = self._readout(menu, "Memory: —")
|
||||
menu.addSeparator()
|
||||
self._diag_menu = menu.addMenu("Run Diagnostic")
|
||||
self._diag_menu.aboutToShow.connect(self._rebuild_diag_menu)
|
||||
menu.addAction("Open dashboard", self._window.show_dashboard)
|
||||
self._rec_act = menu.addAction("Start recording", self._toggle_record)
|
||||
menu.addAction("Snapshot (copy)", self._snapshot)
|
||||
menu.addSeparator()
|
||||
menu.addAction("Quit", self._window.quit_app)
|
||||
menu.aboutToShow.connect(self._refresh_actions)
|
||||
self.setContextMenu(menu)
|
||||
self.activated.connect(self._on_activated)
|
||||
|
||||
@staticmethod
|
||||
def _readout(menu: QMenu, text: str):
|
||||
act = menu.addAction(text)
|
||||
act.setEnabled(False) # display-only line
|
||||
return act
|
||||
|
||||
def _on_activated(self, reason) -> None:
|
||||
if reason in (QSystemTrayIcon.ActivationReason.Trigger,
|
||||
QSystemTrayIcon.ActivationReason.DoubleClick):
|
||||
self._window.show_dashboard()
|
||||
|
||||
def update_sample(self, sample) -> None:
|
||||
self._last = sample
|
||||
cpu, gpu = _cpu_temp(sample), _gpu_temp(sample)
|
||||
used, total, pct = _memory(sample)
|
||||
self._cpu_act.setText(f"CPU temp: {cpu:.0f} °C" if cpu is not None else "CPU temp: —")
|
||||
self._gpu_act.setText(f"GPU temp: {gpu:.0f} °C" if gpu is not None else "GPU temp: —")
|
||||
if used is not None and total is not None:
|
||||
extra = f" ({pct:.0f}%)" if pct is not None else ""
|
||||
self._mem_act.setText(f"Memory: {used:.1f} / {total:.1f} GB{extra}")
|
||||
else:
|
||||
self._mem_act.setText("Memory: —")
|
||||
|
||||
if _gpu_lost(sample):
|
||||
self._status_act.setText("● GPU not responding")
|
||||
elif (gpu is not None and gpu >= self._gpu_alert) or (cpu is not None and cpu >= self._cpu_alert):
|
||||
self._status_act.setText("● Hot — over alert threshold")
|
||||
else:
|
||||
self._status_act.setText("● Normal")
|
||||
|
||||
bits = []
|
||||
if cpu is not None:
|
||||
bits.append(f"CPU {cpu:.0f}°C")
|
||||
if gpu is not None:
|
||||
bits.append(f"GPU {gpu:.0f}°C")
|
||||
self.setToolTip("RigDoctor" + (" — " + " ".join(bits) if bits else ""))
|
||||
|
||||
def _refresh_actions(self) -> None:
|
||||
self._rec_act.setText("Stop recording" if reccontrol.running_pid() else "Start recording")
|
||||
|
||||
def _toggle_record(self) -> None:
|
||||
if reccontrol.running_pid():
|
||||
reccontrol.stop_background()
|
||||
else:
|
||||
reccontrol.start_background()
|
||||
|
||||
def _rebuild_diag_menu(self) -> None:
|
||||
from ..core import steam
|
||||
|
||||
self._diag_menu.clear()
|
||||
games = steam.cached_games()
|
||||
if not games:
|
||||
self._diag_menu.addAction("Open Games to pick a game…",
|
||||
lambda: self._window.show_page("Games"))
|
||||
return
|
||||
for g in games[:20]:
|
||||
self._diag_menu.addAction(
|
||||
g.name,
|
||||
lambda _checked=False, name=g.name, appid=g.appid: self._window.run_diagnostic(name, appid),
|
||||
)
|
||||
|
||||
def _snapshot(self) -> None:
|
||||
if self._last is None:
|
||||
return
|
||||
from ..render import render_snapshot
|
||||
|
||||
QApplication.clipboard().setText(render_snapshot(self._last))
|
||||
self.showMessage("RigDoctor", "Snapshot copied to clipboard.",
|
||||
QSystemTrayIcon.MessageIcon.Information, 4000)
|
||||
@@ -2,9 +2,12 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from PySide6.QtCore import QRectF, Qt
|
||||
from PySide6.QtGui import QColor, QFont, QPainter, QPen
|
||||
from collections import deque
|
||||
|
||||
from PySide6.QtCore import QPointF, QRectF, Qt
|
||||
from PySide6.QtGui import QColor, QFont, QPainter, QPainterPath, QPen
|
||||
from PySide6.QtWidgets import (
|
||||
QComboBox,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
@@ -16,7 +19,118 @@ from PySide6.QtWidgets import (
|
||||
|
||||
from ..core.sample import Reading
|
||||
from ..render import format_value
|
||||
from .theme import MUTED, TEXT, TRACK, gauge_color, temp_color
|
||||
from .theme import (
|
||||
ACCENT,
|
||||
CRIT,
|
||||
GOOD,
|
||||
MUTED,
|
||||
TEMP_WARN,
|
||||
TEXT,
|
||||
TRACK,
|
||||
USAGE_WARN,
|
||||
WARN,
|
||||
gauge_color,
|
||||
temp_color,
|
||||
)
|
||||
|
||||
_SEV = {
|
||||
"critical": ("CRITICAL", CRIT),
|
||||
"warning": ("WARNING", WARN),
|
||||
"info": ("INFO", MUTED),
|
||||
"ok": ("OK", GOOD),
|
||||
}
|
||||
|
||||
|
||||
def finding_card(finding, on_install=None, on_apply=None) -> QFrame:
|
||||
"""A card for one M4/M6 Finding (severity-colored title, detail, suggested fix).
|
||||
|
||||
If the finding names an installable catalog component (``finding.action``) and an
|
||||
``on_install(component)`` callback is given, an "Install" button is shown — so a
|
||||
"tool not installed" finding becomes one click instead of a copy-pasted apt command.
|
||||
|
||||
If the finding names a runtime tunable (``finding.fix``) and an ``on_apply(fix_id,
|
||||
value)`` callback is given, a dropdown of the live options + an Apply button is shown
|
||||
(M6 live fixes — D22).
|
||||
"""
|
||||
label, color = _SEV.get(finding.severity, ("?", MUTED))
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
v = QVBoxLayout(card)
|
||||
v.setContentsMargins(16, 12, 16, 12)
|
||||
v.setSpacing(4)
|
||||
|
||||
head = QLabel(f"{label} · {finding.category}: {finding.title}")
|
||||
head.setStyleSheet(f"color: {color}; font-weight: 700; background: transparent;")
|
||||
head.setWordWrap(True)
|
||||
v.addWidget(head)
|
||||
|
||||
if finding.detail:
|
||||
detail = QLabel(finding.detail)
|
||||
detail.setObjectName("Muted")
|
||||
detail.setWordWrap(True)
|
||||
v.addWidget(detail)
|
||||
if finding.suggestion:
|
||||
suggestion = QLabel(f"→ {finding.suggestion}")
|
||||
suggestion.setStyleSheet(f"color: {ACCENT}; background: transparent;")
|
||||
suggestion.setWordWrap(True)
|
||||
v.addWidget(suggestion)
|
||||
|
||||
component = _installable_component(finding) if on_install else None
|
||||
if component is not None:
|
||||
row = QHBoxLayout()
|
||||
row.addStretch(1)
|
||||
btn = QPushButton(f"Install {component.name}")
|
||||
btn.setObjectName("ActionButton")
|
||||
btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
btn.clicked.connect(lambda: on_install(component))
|
||||
row.addWidget(btn)
|
||||
v.addLayout(row)
|
||||
|
||||
tunable = _tunable(finding) if on_apply else None
|
||||
if tunable is not None and tunable.options:
|
||||
row = QHBoxLayout()
|
||||
name = QLabel(f"{tunable.label}:")
|
||||
name.setObjectName("Muted")
|
||||
combo = QComboBox()
|
||||
combo.addItems(tunable.options)
|
||||
if tunable.current in tunable.options:
|
||||
combo.setCurrentText(tunable.current)
|
||||
combo.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
apply_btn = QPushButton("Apply")
|
||||
apply_btn.setObjectName("ActionButton")
|
||||
apply_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
apply_btn.clicked.connect(lambda: on_apply(tunable.id, combo.currentText()))
|
||||
row.addWidget(name)
|
||||
row.addWidget(combo, 1)
|
||||
row.addWidget(apply_btn)
|
||||
v.addLayout(row)
|
||||
if tunable.note:
|
||||
note = QLabel(tunable.note)
|
||||
note.setObjectName("Muted")
|
||||
v.addWidget(note)
|
||||
return card
|
||||
|
||||
|
||||
def _tunable(finding):
|
||||
"""The runtime tunable a finding can apply, if any."""
|
||||
fix = getattr(finding, "fix", "")
|
||||
if not fix:
|
||||
return None
|
||||
from ..core import fixes
|
||||
|
||||
return fixes.get_tunable(fix)
|
||||
|
||||
|
||||
def _installable_component(finding):
|
||||
"""The catalog component a finding offers to install, if any and if apt is usable."""
|
||||
action = getattr(finding, "action", "")
|
||||
if not action:
|
||||
return None
|
||||
from ..core import catalog, sysenv
|
||||
|
||||
if sysenv.package_manager() != "apt":
|
||||
return None # apt-only (D15) — no one-click install elsewhere
|
||||
return catalog.by_id(action)
|
||||
|
||||
|
||||
class Card(QFrame):
|
||||
@@ -148,6 +262,117 @@ class StatGauge(QWidget):
|
||||
p.end()
|
||||
|
||||
|
||||
class HistoryGraph(QWidget):
|
||||
"""A headline metric as a trend: current value + window min/max + a history line.
|
||||
|
||||
Replaces the at-a-glance gauge with changes-over-time. `kind` drives the color
|
||||
(temp band / usage / accent), matching StatGauge so the dashboard stays consistent.
|
||||
"""
|
||||
|
||||
def __init__(self, title: str, unit: str = "", vmin: float = 0.0, vmax: float = 100.0,
|
||||
kind: str = "accent", history: int = 180) -> None:
|
||||
super().__init__()
|
||||
self._title = title
|
||||
self._unit = unit
|
||||
self._min = vmin
|
||||
self._max = vmax
|
||||
self._kind = kind # "temp" | "usage" | "accent"
|
||||
self._values: deque[float | None] = deque(maxlen=history)
|
||||
self.setMinimumSize(160, 132)
|
||||
|
||||
def add_value(self, value: float | None) -> None:
|
||||
self._values.append(value)
|
||||
self.update()
|
||||
|
||||
def _fmt(self, value: float | None) -> str:
|
||||
if value is None:
|
||||
return "—"
|
||||
if self._unit == "°C":
|
||||
return f"{value:.0f}°"
|
||||
if self._unit == "%":
|
||||
return f"{value:.0f}%"
|
||||
return f"{value:.0f}{self._unit}"
|
||||
|
||||
def paintEvent(self, event) -> None: # noqa: N802 (Qt override)
|
||||
p = QPainter(self)
|
||||
p.setRenderHint(QPainter.RenderHint.Antialiasing)
|
||||
w, h = self.width(), self.height()
|
||||
pad = 10.0
|
||||
present = [v for v in self._values if v is not None]
|
||||
current = next((v for v in reversed(self._values) if v is not None), None)
|
||||
color = QColor(gauge_color(self._kind, current))
|
||||
|
||||
ftitle = QFont()
|
||||
ftitle.setPointSizeF(10.0)
|
||||
ftitle.setBold(True)
|
||||
p.setFont(ftitle)
|
||||
p.setPen(QColor(MUTED))
|
||||
p.drawText(QRectF(pad, 6, w - 2 * pad, 18),
|
||||
Qt.AlignmentFlag.AlignLeft | Qt.AlignmentFlag.AlignVCenter, self._title)
|
||||
|
||||
fval = QFont()
|
||||
fval.setPointSizeF(21.0)
|
||||
fval.setBold(True)
|
||||
p.setFont(fval)
|
||||
p.setPen(color if current is not None else QColor(MUTED))
|
||||
p.drawText(QRectF(pad, 2, w - 2 * pad, 28),
|
||||
Qt.AlignmentFlag.AlignRight | Qt.AlignmentFlag.AlignTop, self._fmt(current))
|
||||
|
||||
if present:
|
||||
fsm = QFont()
|
||||
fsm.setPointSizeF(8.5)
|
||||
p.setFont(fsm)
|
||||
p.setPen(QColor(MUTED))
|
||||
p.drawText(QRectF(pad, 27, w - 2 * pad, 14), Qt.AlignmentFlag.AlignLeft,
|
||||
f"min {self._fmt(min(present))} max {self._fmt(max(present))}")
|
||||
|
||||
g_top, g_bot = 48.0, h - pad
|
||||
g_left, g_right = pad, w - pad
|
||||
span = self._max - self._min
|
||||
if g_bot - g_top < 12 or g_right - g_left < 12 or span <= 0:
|
||||
p.end()
|
||||
return
|
||||
|
||||
def y_of(v: float) -> float:
|
||||
frac = (max(self._min, min(self._max, v)) - self._min) / span
|
||||
return g_bot - frac * (g_bot - g_top)
|
||||
|
||||
warn = TEMP_WARN if self._kind == "temp" else (USAGE_WARN if self._kind == "usage" else None)
|
||||
if warn is not None and self._min <= warn <= self._max:
|
||||
pen = QPen(QColor(TRACK))
|
||||
pen.setWidthF(1.0)
|
||||
pen.setStyle(Qt.PenStyle.DashLine)
|
||||
p.setPen(pen)
|
||||
yw = y_of(warn)
|
||||
p.drawLine(QPointF(g_left, yw), QPointF(g_right, yw))
|
||||
|
||||
maxlen = self._values.maxlen or 1
|
||||
step = (g_right - g_left) / max(1, maxlen - 1)
|
||||
n = len(self._values)
|
||||
# Build the line newest-at-right; break it where readings are missing.
|
||||
path = QPainterPath()
|
||||
drawing = False
|
||||
for i, v in enumerate(self._values):
|
||||
if v is None:
|
||||
drawing = False
|
||||
continue
|
||||
x = g_right - (n - 1 - i) * step
|
||||
y = y_of(v)
|
||||
if drawing:
|
||||
path.lineTo(x, y)
|
||||
else:
|
||||
path.moveTo(x, y)
|
||||
drawing = True
|
||||
if not path.isEmpty():
|
||||
pen = QPen(color)
|
||||
pen.setWidthF(2.0)
|
||||
pen.setCapStyle(Qt.PenCapStyle.RoundCap)
|
||||
pen.setJoinStyle(Qt.PenJoinStyle.RoundJoin)
|
||||
p.setPen(pen)
|
||||
p.drawPath(path)
|
||||
p.end()
|
||||
|
||||
|
||||
class MetricBar(QWidget):
|
||||
"""A label + value with a thin progress bar (for 0–100% metrics)."""
|
||||
|
||||
|
||||
@@ -99,6 +99,25 @@ def _aggregate_peaks(maxima: dict) -> list[tuple[str, str, float, str, float, st
|
||||
return rows
|
||||
|
||||
|
||||
_SEV_LABEL = {"critical": "CRITICAL", "warning": "WARNING", "info": "INFO", "ok": "OK"}
|
||||
|
||||
|
||||
def render_health(findings: list, title: str = "Health report") -> str:
|
||||
if not findings:
|
||||
return f"{title}: no findings."
|
||||
crit = sum(1 for f in findings if f.severity == "critical")
|
||||
warn = sum(1 for f in findings if f.severity == "warning")
|
||||
lines = [title, "", f" {crit} critical · {warn} warning · {len(findings)} checks", ""]
|
||||
for f in findings:
|
||||
lines.append(f"[{_SEV_LABEL.get(f.severity, '?')}] {f.category}: {f.title}")
|
||||
if f.detail:
|
||||
lines.append(f" {f.detail}")
|
||||
if f.suggestion:
|
||||
lines.append(f" → {f.suggestion}")
|
||||
lines.append("")
|
||||
return "\n".join(lines).rstrip()
|
||||
|
||||
|
||||
def render_summary(summary: Summary, log_path=None) -> str:
|
||||
if summary.samples == 0 and not summary.events:
|
||||
where = f" ({log_path})" if log_path else ""
|
||||
|
||||
@@ -0,0 +1,170 @@
|
||||
"""Live monitor TUI (M2): a curses HWMonitor-style terminal dashboard.
|
||||
|
||||
Shows current / session-min / session-max per sensor, grouped by subsystem, with
|
||||
temperature and utilization color bands. stdlib `curses` only; falls back to a plain
|
||||
full-screen redraw when stdout isn't a TTY (piped/SSH-without-tty). Keys: q quit, r reset
|
||||
the session min/max. The terminal face of the same live data the GUI dashboard graphs.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import curses
|
||||
import sys
|
||||
import time
|
||||
|
||||
from .core.sample import Reading, Sample
|
||||
from .core.sampler import Sampler
|
||||
from .core.sources import available_sources
|
||||
from .render import _GROUP_ORDER, _GROUP_TITLES, format_raw, metric_label, render_snapshot
|
||||
|
||||
# Color-band thresholds (mirror the GUI dashboard so both faces agree).
|
||||
TEMP_COLD, TEMP_WARN, TEMP_CRIT = 50.0, 78.0, 88.0
|
||||
USAGE_WARN, USAGE_CRIT = 85.0, 95.0
|
||||
_USAGE_METRICS = {"util", "used_pct", "mem_util", "load"}
|
||||
|
||||
|
||||
def band(r: Reading) -> str:
|
||||
"""Color band for a reading: cold | good | warn | crit | normal | na."""
|
||||
if r.source == "gpu" and r.metric == "status": # GPU-lost / query timeout
|
||||
return "crit"
|
||||
if r.value is None:
|
||||
return "na"
|
||||
if r.unit == "°C":
|
||||
if r.value >= TEMP_CRIT:
|
||||
return "crit"
|
||||
if r.value >= TEMP_WARN:
|
||||
return "warn"
|
||||
if r.value >= TEMP_COLD:
|
||||
return "good"
|
||||
return "cold"
|
||||
if r.unit == "%" and r.metric in _USAGE_METRICS:
|
||||
if r.value >= USAGE_CRIT:
|
||||
return "crit"
|
||||
if r.value >= USAGE_WARN:
|
||||
return "warn"
|
||||
return "good"
|
||||
return "normal"
|
||||
|
||||
|
||||
def track(stats: dict[str, tuple[float, float]], sample: Sample) -> None:
|
||||
"""Fold a sample's readings into {key: (min, max)} session extremes."""
|
||||
for r in sample.readings:
|
||||
if r.value is None:
|
||||
continue
|
||||
lo, hi = stats.get(r.key, (r.value, r.value))
|
||||
stats[r.key] = (min(lo, r.value), max(hi, r.value))
|
||||
|
||||
|
||||
# --- curses front-end -----------------------------------------------------------------
|
||||
|
||||
_BAND_PAIR = {"cold": 1, "good": 2, "warn": 3, "crit": 4}
|
||||
|
||||
|
||||
def _init_colors() -> None:
|
||||
try:
|
||||
curses.start_color()
|
||||
curses.use_default_colors()
|
||||
curses.init_pair(1, curses.COLOR_CYAN, -1)
|
||||
curses.init_pair(2, curses.COLOR_GREEN, -1)
|
||||
curses.init_pair(3, curses.COLOR_YELLOW, -1)
|
||||
curses.init_pair(4, curses.COLOR_RED, -1)
|
||||
except curses.error:
|
||||
pass
|
||||
|
||||
|
||||
def _attr(band_name: str) -> int:
|
||||
pair = _BAND_PAIR.get(band_name)
|
||||
if not pair:
|
||||
return curses.A_NORMAL
|
||||
attr = curses.color_pair(pair)
|
||||
return attr | curses.A_BOLD if band_name == "crit" else attr
|
||||
|
||||
|
||||
def _draw(stdscr, sample: Sample, stats: dict, interval: float) -> None:
|
||||
stdscr.erase()
|
||||
height, width = stdscr.getmaxyx()
|
||||
|
||||
def put(y: int, x: int, text: str, attr: int = curses.A_NORMAL) -> None:
|
||||
if 0 <= y < height and 0 <= x < width:
|
||||
try:
|
||||
stdscr.addnstr(y, x, text, max(0, width - x - 1), attr)
|
||||
except curses.error:
|
||||
pass
|
||||
|
||||
put(0, 0, f"RigDoctor — live monitor every {interval:g}s", curses.A_BOLD)
|
||||
put(1, 0, "q quit r reset min/max", curses.A_DIM)
|
||||
|
||||
groups = sample.by_source()
|
||||
order = [k for k in _GROUP_ORDER if k in groups] + [k for k in groups if k not in _GROUP_ORDER]
|
||||
name_w, col_w = 24, 11
|
||||
y = 3
|
||||
for key in order:
|
||||
if y >= height:
|
||||
break
|
||||
put(y, 0, _GROUP_TITLES.get(key, key.title()), curses.A_BOLD)
|
||||
y += 1
|
||||
put(y, 2, f"{'sensor':<{name_w}}{'current':>{col_w}}{'min':>{col_w}}{'max':>{col_w}}", curses.A_DIM)
|
||||
y += 1
|
||||
for r in groups[key]:
|
||||
if y >= height:
|
||||
break
|
||||
if r.metric == "name": # device identity line
|
||||
put(y, 2, str(r.label), curses.A_DIM)
|
||||
y += 1
|
||||
continue
|
||||
lo, hi = stats.get(r.key, (r.value, r.value))
|
||||
put(y, 2, f"{metric_label(r):<{name_w}}")
|
||||
put(y, 2 + name_w, f"{format_raw(r.value, r.unit):>{col_w}}", _attr(band(r)))
|
||||
put(y, 2 + name_w + col_w, f"{format_raw(lo, r.unit):>{col_w}}", curses.A_DIM)
|
||||
put(y, 2 + name_w + 2 * col_w, f"{format_raw(hi, r.unit):>{col_w}}", curses.A_DIM)
|
||||
y += 1
|
||||
y += 1
|
||||
stdscr.refresh()
|
||||
|
||||
|
||||
def _loop(stdscr, sampler: Sampler, interval: float) -> None:
|
||||
curses.curs_set(0)
|
||||
stdscr.nodelay(True)
|
||||
_init_colors()
|
||||
stats: dict[str, tuple[float, float]] = {}
|
||||
latest = sampler.sample()
|
||||
track(stats, latest)
|
||||
next_sample = time.monotonic() + interval
|
||||
while True:
|
||||
ch = stdscr.getch()
|
||||
if ch in (ord("q"), ord("Q")):
|
||||
return
|
||||
if ch in (ord("r"), ord("R")):
|
||||
stats.clear()
|
||||
track(stats, latest)
|
||||
now = time.monotonic()
|
||||
if now >= next_sample:
|
||||
latest = sampler.sample()
|
||||
track(stats, latest)
|
||||
next_sample = now + interval
|
||||
_draw(stdscr, latest, stats, interval)
|
||||
time.sleep(0.05) # keep key handling responsive without busy-spinning
|
||||
|
||||
|
||||
def _run_plain(sampler: Sampler, interval: float) -> int:
|
||||
"""Fallback for non-TTY output: clear + reprint each tick (no curses)."""
|
||||
try:
|
||||
for sample in sampler.stream(interval=interval):
|
||||
print("\033[2J\033[H", end="")
|
||||
print(f"RigDoctor — live (every {interval:g}s, Ctrl-C to quit)\n")
|
||||
print(render_snapshot(sample))
|
||||
sys.stdout.flush()
|
||||
except KeyboardInterrupt:
|
||||
print()
|
||||
return 0
|
||||
|
||||
|
||||
def run(interval: float, plain: bool = False) -> int:
|
||||
sampler = Sampler(available_sources())
|
||||
if plain or not sys.stdout.isatty():
|
||||
return _run_plain(sampler, interval)
|
||||
try:
|
||||
curses.wrapper(_loop, sampler, interval)
|
||||
except curses.error: # terminal can't do curses — degrade gracefully
|
||||
return _run_plain(sampler, interval)
|
||||
return 0
|
||||
@@ -0,0 +1,38 @@
|
||||
"""Tests for the M8 alert monitor (edge-triggered; notify mocked)."""
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import alerts
|
||||
from rigdoctor.core.sample import Reading, Sample
|
||||
|
||||
|
||||
def _gpu(temp):
|
||||
return Sample(readings=[Reading("gpu", "temp", temp, "°C")])
|
||||
|
||||
|
||||
class AlertTests(unittest.TestCase):
|
||||
@mock.patch.object(alerts, "notify")
|
||||
def test_edge_triggered_no_repeat(self, m):
|
||||
mon = alerts.AlertMonitor(gpu_temp=90.0, cooldown=0.0)
|
||||
mon.check(_gpu(95)) # fires
|
||||
mon.check(_gpu(96)) # still hot — no repeat while active
|
||||
self.assertEqual(m.call_count, 1)
|
||||
mon.check(_gpu(50)) # clears
|
||||
mon.check(_gpu(95)) # hot again — fires
|
||||
self.assertEqual(m.call_count, 2)
|
||||
|
||||
@mock.patch.object(alerts, "notify")
|
||||
def test_no_alert_below_threshold(self, m):
|
||||
alerts.AlertMonitor(gpu_temp=90.0).check(_gpu(70))
|
||||
m.assert_not_called()
|
||||
|
||||
@mock.patch.object(alerts, "notify")
|
||||
def test_gpu_lost(self, m):
|
||||
mon = alerts.AlertMonitor()
|
||||
mon.check(Sample(readings=[Reading("gpu", "status", None, "", "query-timeout")]))
|
||||
m.assert_called_once()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,42 @@
|
||||
"""Tests for config save/load (flat TOML writer)."""
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor import config
|
||||
|
||||
|
||||
class ConfigTests(unittest.TestCase):
|
||||
def test_save_load_round_trip(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
cf = Path(d) / "config.toml"
|
||||
with mock.patch.object(config, "CONFIG_FILE", cf), mock.patch.object(config, "CONFIG_DIR", Path(d)):
|
||||
config.save_config({"alerts_enabled": False, "gpu_temp_alert": 88.0, "update_check_minutes": 5})
|
||||
loaded = config.load_config()
|
||||
self.assertIs(loaded["alerts_enabled"], False)
|
||||
self.assertEqual(loaded["gpu_temp_alert"], 88.0)
|
||||
self.assertEqual(loaded["update_check_minutes"], 5)
|
||||
|
||||
def test_list_value_round_trip(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
cf = Path(d) / "config.toml"
|
||||
with mock.patch.object(config, "CONFIG_FILE", cf), mock.patch.object(config, "CONFIG_DIR", Path(d)):
|
||||
paths = ["/home/u/.local/share/Steam", "/mnt/games/SteamLibrary"]
|
||||
config.update_config(steam_libraries=paths)
|
||||
self.assertEqual(config.load_config()["steam_libraries"], paths)
|
||||
config.update_config(steam_libraries=[])
|
||||
self.assertEqual(config.load_config()["steam_libraries"], [])
|
||||
|
||||
def test_update_config_merges_and_keeps_defaults(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
cf = Path(d) / "config.toml"
|
||||
with mock.patch.object(config, "CONFIG_FILE", cf), mock.patch.object(config, "CONFIG_DIR", Path(d)):
|
||||
config.update_config(cpu_temp_alert=70.0)
|
||||
self.assertEqual(config.load_config()["cpu_temp_alert"], 70.0)
|
||||
self.assertEqual(config.load_config()["gpu_temp_alert"], 90.0) # default preserved
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,111 @@
|
||||
"""Tests for the guided diagnostic orchestration (M3+M4 glue)."""
|
||||
|
||||
import tempfile
|
||||
import time
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import diagnostic
|
||||
from rigdoctor.core.crashlog import CrashLogWriter, summarize
|
||||
from rigdoctor.core.health import Finding
|
||||
from rigdoctor.core.sample import Reading, Sample
|
||||
|
||||
|
||||
def _write_log(path: str, game: str) -> None:
|
||||
w = CrashLogWriter(path)
|
||||
w.write_event("session-start", "interval=1s")
|
||||
w.write_event("game", game)
|
||||
for temp in (60.0, 72.0, 81.0):
|
||||
w.write_sample(Sample(ts=time.time(), readings=[Reading("gpu", "temp", temp, "°C", "")]))
|
||||
w.write_event("gpu-lost", "nvidia-smi query timed out")
|
||||
w.close()
|
||||
|
||||
|
||||
class GameRecoveryTests(unittest.TestCase):
|
||||
def test_game_recovered_from_log_event(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = str(Path(d) / "capture.jsonl")
|
||||
_write_log(log, "Path of Exile 2")
|
||||
summary = summarize(log)
|
||||
self.assertEqual(diagnostic._game_from_summary(summary), "Path of Exile 2")
|
||||
|
||||
def test_no_game_event_returns_none(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = str(Path(d) / "capture.jsonl")
|
||||
w = CrashLogWriter(log)
|
||||
w.write_event("session-start")
|
||||
w.close()
|
||||
self.assertIsNone(diagnostic._game_from_summary(summarize(log)))
|
||||
|
||||
|
||||
class FinishTests(unittest.TestCase):
|
||||
def test_finish_combines_summary_and_findings(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = Path(d) / "capture.jsonl"
|
||||
_write_log(str(log), "Satisfactory")
|
||||
fake = [Finding("warning", "GPU", "NVIDIA Xid 79 ×1", "fell off the bus")]
|
||||
with mock.patch("rigdoctor.core.health.run_health_checks", return_value=fake), \
|
||||
mock.patch.object(diagnostic.reccontrol, "stop_background", return_value=False), \
|
||||
mock.patch.object(diagnostic.reccontrol, "running_pid", return_value=None):
|
||||
result = diagnostic.finish(log_path=log)
|
||||
self.assertEqual(result.game, "Satisfactory")
|
||||
self.assertEqual(result.summary.samples, 3)
|
||||
self.assertEqual(result.findings, fake)
|
||||
# peak GPU temp captured in the window, GPU-lost event recorded
|
||||
self.assertEqual(result.summary.maxima["gpu.temp"][0], 81.0)
|
||||
self.assertTrue(any(kind == "gpu-lost" for _ts, kind, _d in result.summary.events))
|
||||
|
||||
|
||||
class CrashDetectionTests(unittest.TestCase):
|
||||
def _diag_log(self, d) -> Path:
|
||||
return Path(d) / "diagnostic.jsonl"
|
||||
|
||||
def test_unterminated_session_is_a_pending_crash(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = self._diag_log(d)
|
||||
_write_log(str(log), "Tarkov") # has session-start + game, no session-stop
|
||||
with mock.patch.object(diagnostic.config, "DIAG_LOG", log), \
|
||||
mock.patch.object(diagnostic.config, "DIAG_CRASH", log.with_suffix(".crash")), \
|
||||
mock.patch.object(diagnostic.reccontrol, "running_pid", return_value=None):
|
||||
info = diagnostic.pending_crash()
|
||||
self.assertIsNotNone(info)
|
||||
self.assertEqual(info.game, "Tarkov")
|
||||
self.assertTrue(info.gpu_lost) # _write_log writes a gpu-lost event
|
||||
|
||||
def test_clean_stop_is_not_a_crash(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = self._diag_log(d)
|
||||
w = CrashLogWriter(str(log))
|
||||
w.write_event("session-start"); w.write_event("game", "X")
|
||||
w.write_sample(Sample(time.time(), [Reading("gpu", "temp", 60.0, "°C", "")]))
|
||||
w.write_event("session-stop", "samples=1")
|
||||
w.close()
|
||||
with mock.patch.object(diagnostic.config, "DIAG_LOG", log), \
|
||||
mock.patch.object(diagnostic.config, "DIAG_CRASH", log.with_suffix(".crash")), \
|
||||
mock.patch.object(diagnostic.reccontrol, "running_pid", return_value=None):
|
||||
self.assertIsNone(diagnostic.pending_crash())
|
||||
|
||||
def test_acknowledge_clears_pending_crash(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = self._diag_log(d)
|
||||
_write_log(str(log), "Tarkov")
|
||||
with mock.patch.object(diagnostic.config, "DIAG_LOG", log), \
|
||||
mock.patch.object(diagnostic.config, "DIAG_CRASH", log.with_suffix(".crash")), \
|
||||
mock.patch.object(diagnostic.reccontrol, "running_pid", return_value=None):
|
||||
self.assertIsNotNone(diagnostic.pending_crash())
|
||||
diagnostic.acknowledge_crash()
|
||||
self.assertIsNone(diagnostic.pending_crash())
|
||||
|
||||
def test_running_capture_is_not_a_crash(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
log = self._diag_log(d)
|
||||
_write_log(str(log), "Tarkov")
|
||||
with mock.patch.object(diagnostic.config, "DIAG_LOG", log), \
|
||||
mock.patch.object(diagnostic.config, "DIAG_CRASH", log.with_suffix(".crash")), \
|
||||
mock.patch.object(diagnostic.reccontrol, "running_pid", return_value=4321):
|
||||
self.assertIsNone(diagnostic.pending_crash()) # it's in-progress, not crashed
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,63 @@
|
||||
"""Tests for M6 runtime tunables (parse, command builders, value validation)."""
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import fixes
|
||||
from rigdoctor.core.fixes import Tunable
|
||||
|
||||
|
||||
class ParseTests(unittest.TestCase):
|
||||
def test_bracketed(self):
|
||||
self.assertEqual(fixes._bracketed("always [madvise] never"), (["always", "madvise", "never"], "madvise"))
|
||||
|
||||
def test_bracketed_none_active(self):
|
||||
self.assertEqual(fixes._bracketed("a b c"), (["a", "b", "c"], None))
|
||||
|
||||
|
||||
class CommandBuilderTests(unittest.TestCase):
|
||||
def test_governor_cmd_writes_value_to_sysfs(self):
|
||||
cmd = fixes._cpu_governor_cmd("performance")
|
||||
self.assertEqual(cmd[:2], ["/bin/sh", "-c"])
|
||||
self.assertIn("performance", cmd[2])
|
||||
self.assertIn("scaling_governor", cmd[2])
|
||||
|
||||
def test_persistence_cmd(self):
|
||||
self.assertEqual(fixes._nvidia_persistence_cmd("Enabled"), ["nvidia-smi", "-pm", "1"])
|
||||
self.assertEqual(fixes._nvidia_persistence_cmd("Disabled"), ["nvidia-smi", "-pm", "0"])
|
||||
|
||||
def test_swappiness_cmd_targets_procfs(self):
|
||||
self.assertIn("/proc/sys/vm/swappiness", fixes._swappiness_cmd("10")[2])
|
||||
|
||||
def test_quoting_is_safe(self):
|
||||
# A value that would be dangerous unquoted stays a single quoted token.
|
||||
cmd = fixes._pcie_aspm_cmd("performance; rm -rf /")
|
||||
self.assertIn("'performance; rm -rf /'", cmd[2])
|
||||
|
||||
|
||||
class ApplyValidationTests(unittest.TestCase):
|
||||
def test_unknown_fix_returns_none(self):
|
||||
self.assertIsNone(fixes.apply_command("does_not_exist", "x"))
|
||||
|
||||
def test_value_validated_against_live_options(self):
|
||||
fake = Tunable("x", "X", ["a", "b"], "a")
|
||||
with mock.patch.dict(fixes._TUNABLES, {"x": (lambda: fake, lambda v: ["echo", v])}, clear=False):
|
||||
self.assertEqual(fixes.apply_command("x", "a"), ["echo", "a"])
|
||||
self.assertIsNone(fixes.apply_command("x", "not-an-option"))
|
||||
|
||||
def test_apply_unknown_is_error(self):
|
||||
rc, _ = fixes.apply("nope", "x")
|
||||
self.assertEqual(rc, 1)
|
||||
|
||||
|
||||
class GameenvWiringTests(unittest.TestCase):
|
||||
def test_findings_reference_known_fix_ids(self):
|
||||
from rigdoctor.core import gameenv
|
||||
|
||||
fix_ids = {f.fix for f in gameenv.run_gameenv_checks() if f.fix}
|
||||
# Whatever fixes the live system surfaces, each must be a real tunable id.
|
||||
self.assertTrue(fix_ids.issubset(set(fixes._TUNABLES)))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,73 @@
|
||||
"""Tests for M6 gaming-environment checks (pure evaluators + aggregate smoke test)."""
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core import gameenv
|
||||
from rigdoctor.core.health import Finding
|
||||
|
||||
|
||||
class AspmTests(unittest.TestCase):
|
||||
def test_powersave_is_warning(self):
|
||||
f = gameenv.evaluate_aspm("[powersave] performance powersupersave\n")
|
||||
self.assertEqual(f.severity, "warning")
|
||||
self.assertEqual(f.category, "PCIe")
|
||||
|
||||
def test_performance_is_ok(self):
|
||||
self.assertEqual(gameenv.evaluate_aspm("[performance] powersave powersupersave").severity, "ok")
|
||||
|
||||
def test_default_is_info(self):
|
||||
self.assertEqual(gameenv.evaluate_aspm("[default] performance powersave").severity, "info")
|
||||
|
||||
def test_missing_is_none(self):
|
||||
self.assertIsNone(gameenv.evaluate_aspm(None))
|
||||
self.assertIsNone(gameenv.evaluate_aspm("no brackets here"))
|
||||
|
||||
|
||||
class GovernorTests(unittest.TestCase):
|
||||
def test_performance_only_is_ok(self):
|
||||
self.assertEqual(gameenv.evaluate_governor({"performance"}).severity, "ok")
|
||||
|
||||
def test_powersave_is_warning(self):
|
||||
f = gameenv.evaluate_governor({"powersave"})
|
||||
self.assertEqual(f.severity, "warning")
|
||||
self.assertEqual(f.fix, "cpu_governor") # offers the live Apply dropdown
|
||||
|
||||
def test_dynamic_is_info(self):
|
||||
self.assertEqual(gameenv.evaluate_governor({"schedutil"}).severity, "info")
|
||||
|
||||
def test_empty_is_none(self):
|
||||
self.assertIsNone(gameenv.evaluate_governor(set()))
|
||||
|
||||
|
||||
class SwappinessTests(unittest.TestCase):
|
||||
def test_high_is_info_with_suggestion(self):
|
||||
f = gameenv.evaluate_swappiness(60)
|
||||
self.assertEqual(f.severity, "info")
|
||||
self.assertEqual(f.fix, "swappiness") # offers the live Apply dropdown
|
||||
|
||||
def test_low_is_ok(self):
|
||||
self.assertEqual(gameenv.evaluate_swappiness(10).severity, "ok")
|
||||
|
||||
|
||||
class ShaderCacheTests(unittest.TestCase):
|
||||
def test_disabled_nvidia_is_warning(self):
|
||||
self.assertEqual(gameenv.evaluate_shader_cache({"__GL_SHADER_DISK_CACHE": "0"}).severity, "warning")
|
||||
|
||||
def test_disabled_mesa_is_warning(self):
|
||||
self.assertEqual(gameenv.evaluate_shader_cache({"MESA_SHADER_CACHE_DISABLE": "true"}).severity, "warning")
|
||||
|
||||
def test_default_is_ok(self):
|
||||
self.assertEqual(gameenv.evaluate_shader_cache({}).severity, "ok")
|
||||
|
||||
|
||||
class AggregateTests(unittest.TestCase):
|
||||
def test_run_returns_sorted_findings(self):
|
||||
findings = gameenv.run_gameenv_checks()
|
||||
self.assertTrue(all(isinstance(f, Finding) for f in findings))
|
||||
order = {"critical": 0, "warning": 1, "info": 2, "ok": 3}
|
||||
sevs = [order.get(f.severity, 9) for f in findings]
|
||||
self.assertEqual(sevs, sorted(sevs)) # worst-first
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,76 @@
|
||||
"""GUI smoke tests: construct the real widgets so a startup crash fails the build.
|
||||
|
||||
These run headless (offscreen) and skip cleanly if PySide6 isn't installed (the core/CLI
|
||||
test suite stays Qt-free). Constructing MainWindow is the check that would have caught the
|
||||
0.18.0 bad-import regression that broke launch.
|
||||
"""
|
||||
|
||||
import os
|
||||
import time
|
||||
import unittest
|
||||
|
||||
os.environ.setdefault("QT_QPA_PLATFORM", "offscreen")
|
||||
|
||||
try:
|
||||
from PySide6.QtGui import QIcon
|
||||
from PySide6.QtWidgets import QApplication, QWidget
|
||||
HAVE_QT = True
|
||||
except ImportError:
|
||||
HAVE_QT = False
|
||||
|
||||
|
||||
@unittest.skipUnless(HAVE_QT, "PySide6 not installed")
|
||||
class GuiSmokeTests(unittest.TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
cls.app = QApplication.instance() or QApplication([])
|
||||
|
||||
def test_main_window_constructs(self):
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import updates
|
||||
from rigdoctor.gui import main_window as mw
|
||||
|
||||
# Avoid construction side effects: no pkexec elevation, no network update check.
|
||||
with mock.patch("rigdoctor.core.elevation.available", return_value=False), \
|
||||
mock.patch.object(updates, "update_state", return_value=(updates.UP_TO_DATE, None, "")):
|
||||
window = mw.MainWindow()
|
||||
try:
|
||||
self.assertEqual(len(window._nav_buttons), len(mw._PAGES))
|
||||
self.assertEqual(set(window._nav_buttons), set(mw._PAGES))
|
||||
finally:
|
||||
window._worker.stop()
|
||||
|
||||
def test_tray_readouts_update(self):
|
||||
from rigdoctor.core.sample import Reading, Sample
|
||||
from rigdoctor.gui.tray import TrayIcon
|
||||
|
||||
class StubWindow(QWidget):
|
||||
def show_dashboard(self): ...
|
||||
def show_page(self, name): ...
|
||||
def run_diagnostic(self, name, appid): ...
|
||||
def quit_app(self): ...
|
||||
|
||||
tray = TrayIcon(StubWindow(), QIcon())
|
||||
tray.update_sample(Sample(time.time(), [
|
||||
Reading("gpu", "temp", 72.0, "°C", ""),
|
||||
Reading("cpu", "temp", 65.0, "°C", "Package id 0"),
|
||||
Reading("memory", "used", 14.2, "GB"),
|
||||
Reading("memory", "total", 31.0, "GB"),
|
||||
Reading("memory", "used_pct", 46.0, "%"),
|
||||
]))
|
||||
self.assertIn("72", tray._gpu_act.text())
|
||||
self.assertIn("65", tray._cpu_act.text())
|
||||
self.assertIn("14.2 / 31.0 GB", tray._mem_act.text())
|
||||
self.assertEqual(tray._status_act.text(), "● Normal")
|
||||
|
||||
def test_setup_wizard_constructs(self):
|
||||
from rigdoctor.gui.setup_wizard import SetupWizard
|
||||
|
||||
wizard = SetupWizard()
|
||||
self.assertEqual(wizard._stack.count(), 5) # welcome/bundles/install/trigger/finish
|
||||
self.assertTrue(wizard._bundle_checks)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,46 @@
|
||||
"""Tests for the M4 health report's log scanner (synthetic input)."""
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core.health import CRITICAL, WARNING, run_health_checks, scan_journal_text
|
||||
|
||||
|
||||
class HealthScanTests(unittest.TestCase):
|
||||
def test_xid_79_is_critical(self):
|
||||
text = "NVRM: Xid (PCI:0000:01:00): 79, pid=1234, GPU has fallen off the bus."
|
||||
findings = scan_journal_text(text)
|
||||
gpu = [f for f in findings if f.category == "GPU"]
|
||||
self.assertEqual(len(gpu), 1)
|
||||
self.assertIn("79", gpu[0].title)
|
||||
self.assertEqual(gpu[0].severity, CRITICAL)
|
||||
|
||||
def test_xid_count_aggregates(self):
|
||||
text = "\n".join(["NVRM: Xid (PCI:0000:01:00): 79, foo"] * 3)
|
||||
gpu = [f for f in scan_journal_text(text) if f.category == "GPU"][0]
|
||||
self.assertIn("×3", gpu.title)
|
||||
|
||||
def test_oom_and_panic_detected(self):
|
||||
text = "Out of memory: Killed process 999 (game)\nKernel panic - not syncing: x"
|
||||
cats = {f.category for f in scan_journal_text(text)}
|
||||
self.assertIn("Memory", cats)
|
||||
self.assertIn("Kernel", cats)
|
||||
|
||||
def test_mce_critical(self):
|
||||
findings = scan_journal_text("mce: [Hardware Error]: Machine check events logged")
|
||||
self.assertTrue(any(f.severity == CRITICAL and f.category == "Hardware" for f in findings))
|
||||
|
||||
def test_clean_text_yields_no_findings(self):
|
||||
self.assertEqual(scan_journal_text("usb 1-1: new high-speed USB device\nbluetooth: ok"), [])
|
||||
|
||||
def test_run_health_checks_returns_findings(self):
|
||||
# Runs against the real system; just assert it returns a sorted list of Findings.
|
||||
findings = run_health_checks()
|
||||
self.assertIsInstance(findings, list)
|
||||
severities = [f.severity for f in findings]
|
||||
order = {"critical": 0, "warning": 1, "info": 2, "ok": 3}
|
||||
ranks = [order.get(s, 9) for s in severities]
|
||||
self.assertEqual(ranks, sorted(ranks))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,53 @@
|
||||
"""Tests for the M9 installer logic and the M13 version comparison."""
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core import catalog, installer
|
||||
from rigdoctor.core.catalog import Component
|
||||
from rigdoctor.core.updates import is_newer
|
||||
|
||||
|
||||
class InstallerTests(unittest.TestCase):
|
||||
def test_component_status_uses_presence(self):
|
||||
status = installer.component_status(present=lambda cmd: cmd == "smartctl")
|
||||
by_id = {c.id: ok for c, ok in status}
|
||||
self.assertTrue(by_id["smartmontools"])
|
||||
self.assertFalse(by_id["dmidecode"])
|
||||
|
||||
def test_missing_packages_dedup_preserves_order(self):
|
||||
comps = [
|
||||
Component("a", "A", "B", "x", ("p1", "p2"), "c1"),
|
||||
Component("b", "B", "B", "y", ("p2", "p3"), "c2"),
|
||||
]
|
||||
self.assertEqual(installer.missing_packages(comps), ["p1", "p2", "p3"])
|
||||
|
||||
def test_apt_command_includes_packages(self):
|
||||
joined = " ".join(installer.apt_install_command(["smartmontools", "dmidecode"]))
|
||||
self.assertIn("smartmontools", joined)
|
||||
self.assertIn("dmidecode", joined)
|
||||
self.assertIn("apt-get install", joined)
|
||||
|
||||
def test_install_nothing_is_noop(self):
|
||||
rc, _ = installer.install_packages([])
|
||||
self.assertEqual(rc, 0)
|
||||
|
||||
def test_by_bundle_groups_all_components(self):
|
||||
groups = catalog.by_bundle()
|
||||
flat = [c for comps in groups.values() for c in comps]
|
||||
self.assertEqual(len(flat), len(catalog.COMPONENTS))
|
||||
self.assertIn("Gaming", groups)
|
||||
self.assertIn("Diagnostics", groups)
|
||||
|
||||
|
||||
class UpdateTests(unittest.TestCase):
|
||||
def test_is_newer(self):
|
||||
self.assertTrue(is_newer("v0.0.5", "0.0.4"))
|
||||
self.assertFalse(is_newer("v0.0.4", "0.0.4"))
|
||||
self.assertFalse(is_newer("v0.0.3", "0.0.4"))
|
||||
|
||||
def test_is_newer_handles_garbage(self):
|
||||
self.assertFalse(is_newer("not-a-version", "0.0.4"))
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,30 @@
|
||||
"""Tests for the M5 system inventory (render + dict round-trip; collect on real system)."""
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core import inventory
|
||||
from rigdoctor.core.inventory import Section
|
||||
|
||||
|
||||
class InventoryTests(unittest.TestCase):
|
||||
def test_collect_returns_sections(self):
|
||||
sections = inventory.collect()
|
||||
self.assertTrue(sections)
|
||||
titles = {s.title for s in sections}
|
||||
self.assertIn("System", titles)
|
||||
self.assertIn("CPU", titles)
|
||||
|
||||
def test_dict_round_trip(self):
|
||||
sections = [Section("System", [("Kernel", "7.0.0"), ("Distro", "Ubuntu")])]
|
||||
restored = inventory.from_dict(inventory.to_dict(sections))
|
||||
self.assertEqual(restored[0].title, "System")
|
||||
self.assertEqual(restored[0].items, [("Kernel", "7.0.0"), ("Distro", "Ubuntu")])
|
||||
|
||||
def test_render_markdown(self):
|
||||
md = inventory.render_markdown([Section("CPU", [("Model", "Test CPU")])])
|
||||
self.assertIn("## CPU", md)
|
||||
self.assertIn("- **Model:** Test CPU", md)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,67 @@
|
||||
"""Tests for M6 non-Steam game detection (Lutris SQLite + Heroic JSON)."""
|
||||
|
||||
import json
|
||||
import sqlite3
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import launchers
|
||||
|
||||
|
||||
class LutrisTests(unittest.TestCase):
|
||||
def test_reads_installed_games_only(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
db = Path(d) / "pga.db"
|
||||
con = sqlite3.connect(db)
|
||||
con.execute("CREATE TABLE games (id INTEGER, name TEXT, slug TEXT, installed INTEGER)")
|
||||
con.executemany(
|
||||
"INSERT INTO games VALUES (?, ?, ?, ?)",
|
||||
[(1, "Hades", "hades", 1), (2, "Hollow Knight", "hollow-knight", 1), (3, "Old Game", "old", 0)],
|
||||
)
|
||||
con.commit()
|
||||
con.close()
|
||||
with mock.patch.object(launchers, "LUTRIS_DB", db), \
|
||||
mock.patch.object(launchers, "HEROIC_DIR", Path(d) / "nope"):
|
||||
games = launchers.scan()
|
||||
names = {g.name for g in games}
|
||||
self.assertEqual(names, {"Hades", "Hollow Knight"})
|
||||
self.assertTrue(all(g.launcher == "lutris" for g in games))
|
||||
|
||||
def test_missing_db_is_empty(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
with mock.patch.object(launchers, "LUTRIS_DB", Path(d) / "absent.db"), \
|
||||
mock.patch.object(launchers, "HEROIC_DIR", Path(d) / "nope"):
|
||||
self.assertEqual(launchers.scan(), [])
|
||||
|
||||
|
||||
class HeroicTests(unittest.TestCase):
|
||||
def test_epic_and_gog(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
base = Path(d) / "heroic"
|
||||
(base / "legendaryConfig" / "legendary").mkdir(parents=True)
|
||||
(base / "gog_store").mkdir(parents=True)
|
||||
(base / "legendaryConfig" / "legendary" / "installed.json").write_text(
|
||||
json.dumps({"abc123": {"title": "Control"}}))
|
||||
(base / "gog_store" / "installed.json").write_text(
|
||||
json.dumps({"installed": [{"appName": "777", "title": "The Witcher 3"}]}))
|
||||
with mock.patch.object(launchers, "LUTRIS_DB", Path(d) / "nope.db"), \
|
||||
mock.patch.object(launchers, "HEROIC_DIR", base):
|
||||
names = {g.name for g in launchers.scan()}
|
||||
self.assertEqual(names, {"Control", "The Witcher 3"})
|
||||
|
||||
def test_gog_title_falls_back_to_install_path(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
base = Path(d) / "heroic"
|
||||
(base / "gog_store").mkdir(parents=True)
|
||||
(base / "gog_store" / "installed.json").write_text(
|
||||
json.dumps({"installed": [{"appName": "9", "install_path": "/games/Stardew Valley"}]}))
|
||||
with mock.patch.object(launchers, "LUTRIS_DB", Path(d) / "nope.db"), \
|
||||
mock.patch.object(launchers, "HEROIC_DIR", base):
|
||||
names = {g.name for g in launchers.scan()}
|
||||
self.assertEqual(names, {"Stardew Valley"})
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,27 @@
|
||||
"""Tests for the host PTY session (M12 Tier 3)."""
|
||||
|
||||
import time
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core.pty_session import PtySession
|
||||
|
||||
|
||||
class PtySessionTests(unittest.TestCase):
|
||||
def test_runs_command_and_reads_output(self):
|
||||
pty = PtySession(rows=24, cols=80)
|
||||
try:
|
||||
time.sleep(0.4)
|
||||
pty.read() # drain the shell prompt
|
||||
pty.write(b"echo PTY_MARKER_42\n")
|
||||
deadline = time.time() + 3
|
||||
buf = ""
|
||||
while time.time() < deadline and "PTY_MARKER_42" not in buf:
|
||||
time.sleep(0.1)
|
||||
buf += pty.read().decode(errors="replace")
|
||||
self.assertIn("PTY_MARKER_42", buf)
|
||||
finally:
|
||||
pty.close()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,58 @@
|
||||
"""Tests for the M9 systemd --user trigger-mode service manager."""
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import service
|
||||
|
||||
|
||||
class UnitTextTests(unittest.TestCase):
|
||||
def test_unit_text_has_required_sections(self):
|
||||
txt = service.unit_text("RigDoctor recorder", ["record", "run"])
|
||||
self.assertIn("[Unit]", txt)
|
||||
self.assertIn("[Service]", txt)
|
||||
self.assertIn("ExecStart=", txt)
|
||||
self.assertIn("record run", txt)
|
||||
self.assertIn("WantedBy=default.target", txt)
|
||||
|
||||
|
||||
class ApplyModeTests(unittest.TestCase):
|
||||
def test_unknown_mode_rejected(self):
|
||||
ok, msg = service.apply_mode("turbo")
|
||||
self.assertFalse(ok)
|
||||
self.assertIn("Unknown", msg)
|
||||
|
||||
def test_no_systemd_saves_mode_but_reports(self):
|
||||
with mock.patch.object(service, "available", return_value=False), \
|
||||
mock.patch.object(service.config, "update_config") as update:
|
||||
ok, msg = service.apply_mode("always-on")
|
||||
self.assertFalse(ok)
|
||||
self.assertIn("available", msg.lower())
|
||||
update.assert_called_once_with(trigger_mode="always-on")
|
||||
|
||||
def test_always_on_enables_recorder_disables_watch(self):
|
||||
calls = []
|
||||
with mock.patch.object(service, "available", return_value=True), \
|
||||
mock.patch.object(service, "install_units"), \
|
||||
mock.patch.object(service, "_enable", side_effect=lambda n: calls.append(("enable", n)) or (0, "")), \
|
||||
mock.patch.object(service, "_disable", side_effect=lambda n: calls.append(("disable", n)) or (0, "")), \
|
||||
mock.patch.object(service.config, "update_config"):
|
||||
ok, _ = service.apply_mode("always-on")
|
||||
self.assertTrue(ok)
|
||||
self.assertIn(("enable", service.RECORDER_UNIT), calls)
|
||||
self.assertIn(("disable", service.WATCH_UNIT), calls)
|
||||
|
||||
def test_manual_disables_both(self):
|
||||
disabled = []
|
||||
with mock.patch.object(service, "available", return_value=True), \
|
||||
mock.patch.object(service, "install_units"), \
|
||||
mock.patch.object(service, "_enable", return_value=(0, "")), \
|
||||
mock.patch.object(service, "_disable", side_effect=lambda n: disabled.append(n) or (0, "")), \
|
||||
mock.patch.object(service.config, "update_config"):
|
||||
ok, _ = service.apply_mode("manual")
|
||||
self.assertTrue(ok)
|
||||
self.assertEqual(set(disabled), {service.RECORDER_UNIT, service.WATCH_UNIT})
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,147 @@
|
||||
"""Tests for M6 Steam library & game detection (VDF parse, scan, tool filter, cache diff)."""
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import steam
|
||||
|
||||
_GAME_ACF = """"AppState"
|
||||
{{
|
||||
\t"appid"\t\t"{appid}"
|
||||
\t"name"\t\t"{name}"
|
||||
\t"installdir"\t\t"{installdir}"
|
||||
\t"SizeOnDisk"\t\t"{size}"
|
||||
\t"LastUpdated"\t\t"{updated}"
|
||||
}}
|
||||
"""
|
||||
|
||||
_LIBRARYFOLDERS = """"libraryfolders"
|
||||
{{
|
||||
\t"0"
|
||||
\t{{
|
||||
\t\t"path"\t\t"{path}"
|
||||
\t\t"label"\t\t"Main"
|
||||
\t\t"apps"
|
||||
\t\t{{
|
||||
\t\t\t"570"\t\t"123"
|
||||
\t\t}}
|
||||
\t}}
|
||||
}}
|
||||
"""
|
||||
|
||||
|
||||
def _make_library(root: Path, games) -> Path:
|
||||
"""games: list of (appid, name, installdir, size, updated). Returns the library path."""
|
||||
steamapps = root / "steamapps"
|
||||
steamapps.mkdir(parents=True, exist_ok=True)
|
||||
for appid, name, installdir, size, updated in games:
|
||||
(steamapps / f"appmanifest_{appid}.acf").write_text(
|
||||
_GAME_ACF.format(appid=appid, name=name, installdir=installdir, size=size, updated=updated)
|
||||
)
|
||||
return root
|
||||
|
||||
|
||||
class VdfTests(unittest.TestCase):
|
||||
def test_parse_nested_and_pairs(self):
|
||||
data = steam._parse_vdf(_GAME_ACF.format(
|
||||
appid="570", name="Dota 2", installdir="dota 2 beta", size="15", updated="1700"))
|
||||
state = data["AppState"]
|
||||
self.assertEqual(state["appid"], "570")
|
||||
self.assertEqual(state["name"], "Dota 2")
|
||||
self.assertEqual(state["installdir"], "dota 2 beta")
|
||||
|
||||
def test_parse_handles_quotes_in_names(self):
|
||||
acf = _GAME_ACF.format(appid="1", name="Baldur\\'s Gate 3", installdir="bg3", size="1", updated="1")
|
||||
data = steam._parse_vdf(acf)
|
||||
self.assertIn("Baldur", data["AppState"]["name"])
|
||||
|
||||
def test_parse_garbage_returns_empty(self):
|
||||
self.assertEqual(steam._parse_vdf("not vdf at all"), {})
|
||||
|
||||
|
||||
class ToolFilterTests(unittest.TestCase):
|
||||
def test_known_tool_appid(self):
|
||||
self.assertTrue(steam.is_tool("228980", "Steamworks Common Redistributables"))
|
||||
|
||||
def test_proton_name_prefix(self):
|
||||
self.assertTrue(steam.is_tool("9999999", "Proton 8.0"))
|
||||
self.assertTrue(steam.is_tool("9999998", "Steam Linux Runtime 3.0 (sniper)"))
|
||||
|
||||
def test_real_game_is_not_a_tool(self):
|
||||
self.assertFalse(steam.is_tool("570", "Dota 2"))
|
||||
|
||||
|
||||
class ScanTests(unittest.TestCase):
|
||||
def test_scan_library_filters_tools(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
lib = _make_library(Path(d), [
|
||||
("570", "Dota 2", "dota 2 beta", "15000000000", "1700000000"),
|
||||
("228980", "Steamworks Common Redistributables", "Steamworks Shared", "0", "0"),
|
||||
("1493710", "Proton Experimental", "Proton - Experimental", "0", "0"),
|
||||
])
|
||||
games = steam.scan_library(str(lib))
|
||||
names = {g.name for g in games}
|
||||
self.assertEqual(names, {"Dota 2"})
|
||||
self.assertEqual(games[0].size_bytes, 15000000000)
|
||||
|
||||
def test_scan_games_dedupes_and_sorts(self):
|
||||
with tempfile.TemporaryDirectory() as d1, tempfile.TemporaryDirectory() as d2:
|
||||
a = _make_library(Path(d1), [("10", "Zeta", "zeta", "1", "1"), ("20", "Alpha", "alpha", "1", "1")])
|
||||
b = _make_library(Path(d2), [("20", "Alpha", "alpha", "1", "1")]) # dup appid 20
|
||||
games = steam.scan_games([str(a), str(b)])
|
||||
self.assertEqual([g.name for g in games], ["Alpha", "Zeta"]) # sorted, deduped
|
||||
|
||||
|
||||
class DiscoverTests(unittest.TestCase):
|
||||
def test_discover_reads_libraryfolders(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
root = Path(d) / "Steam"
|
||||
(root / "steamapps").mkdir(parents=True)
|
||||
extra = Path(d) / "Extra"
|
||||
(extra / "steamapps").mkdir(parents=True)
|
||||
(root / "steamapps" / "libraryfolders.vdf").write_text(
|
||||
_LIBRARYFOLDERS.format(path=str(extra)))
|
||||
with mock.patch.object(steam, "steam_roots", return_value=[root]):
|
||||
libs = steam.discover_libraries()
|
||||
paths = {lib.path for lib in libs}
|
||||
self.assertIn(str(root.resolve()), paths) # root itself
|
||||
self.assertIn(str(extra.resolve()), paths) # the configured extra library
|
||||
|
||||
|
||||
class CacheDiffTests(unittest.TestCase):
|
||||
def _rescan(self, lib, games_file, cfg):
|
||||
with mock.patch.object(steam, "GAMES_FILE", games_file):
|
||||
return steam.rescan(cfg=cfg)
|
||||
|
||||
def test_first_scan_has_no_new_then_added_game_is_new(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
lib = _make_library(Path(d) / "lib", [("10", "Alpha", "alpha", "1", "1")])
|
||||
games_file = Path(d) / "games.json"
|
||||
cfg = {"steam_libraries": [str(lib)]}
|
||||
|
||||
first = self._rescan(lib, games_file, cfg)
|
||||
self.assertEqual(first.new_appids, []) # first run flags nothing as new
|
||||
|
||||
# Install a second game; it should be flagged new on the next scan.
|
||||
_make_library(lib, [("10", "Alpha", "alpha", "1", "1"), ("20", "Beta", "beta", "1", "1")])
|
||||
second = self._rescan(lib, games_file, cfg)
|
||||
self.assertEqual(second.new_appids, ["20"])
|
||||
self.assertEqual({g.name for g in second.games}, {"Alpha", "Beta"})
|
||||
|
||||
def test_acknowledge_clears_new(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
lib = _make_library(Path(d) / "lib", [("10", "Alpha", "alpha", "1", "1")])
|
||||
games_file = Path(d) / "games.json"
|
||||
cfg = {"steam_libraries": [str(lib)]}
|
||||
self._rescan(lib, games_file, cfg)
|
||||
_make_library(lib, [("10", "Alpha", "alpha", "1", "1"), ("20", "Beta", "beta", "1", "1")])
|
||||
self._rescan(lib, games_file, cfg)
|
||||
with mock.patch.object(steam, "GAMES_FILE", games_file):
|
||||
steam.acknowledge_new()
|
||||
self.assertEqual(steam.load_cache()["new_appids"], [])
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,36 @@
|
||||
"""Tests for update-token storage (file fallback + env override), keyring mocked out."""
|
||||
|
||||
import os
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor import config
|
||||
|
||||
|
||||
class TokenStorageTests(unittest.TestCase):
|
||||
def test_file_fallback_roundtrip(self):
|
||||
with tempfile.TemporaryDirectory() as d:
|
||||
token_file = Path(d) / "token"
|
||||
with mock.patch.object(config, "_secret_tool", return_value=None), \
|
||||
mock.patch.object(config, "TOKEN_FILE", token_file), \
|
||||
mock.patch.dict(os.environ, {}, clear=True):
|
||||
self.assertIsNone(config.load_token())
|
||||
config.save_token("abc123")
|
||||
self.assertEqual(config.load_token(), "abc123")
|
||||
self.assertEqual(config.token_backend(), "file")
|
||||
self.assertEqual(token_file.stat().st_mode & 0o777, 0o600)
|
||||
config.clear_token()
|
||||
self.assertIsNone(config.load_token())
|
||||
self.assertEqual(config.token_backend(), "none")
|
||||
|
||||
def test_env_override_wins(self):
|
||||
with mock.patch.object(config, "_secret_tool", return_value=None), \
|
||||
mock.patch.dict(os.environ, {"RIGDOCTOR_TOKEN": "envtok"}, clear=True):
|
||||
self.assertEqual(config.load_token(), "envtok")
|
||||
self.assertEqual(config.token_backend(), "env")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,58 @@
|
||||
"""Tests for the M2 live-monitor TUI logic (min/max tracking + color bands)."""
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor import tui
|
||||
from rigdoctor.core.sample import Reading, Sample
|
||||
|
||||
|
||||
def _temp(v):
|
||||
return Reading("gpu", "temp", v, "°C", "")
|
||||
|
||||
|
||||
class TrackTests(unittest.TestCase):
|
||||
def test_tracks_min_and_max(self):
|
||||
stats: dict = {}
|
||||
for v in (60.0, 80.0, 70.0, 55.0):
|
||||
tui.track(stats, Sample(0.0, [_temp(v)]))
|
||||
self.assertEqual(stats["gpu.temp"], (55.0, 80.0))
|
||||
|
||||
def test_ignores_none_values(self):
|
||||
stats: dict = {}
|
||||
tui.track(stats, Sample(0.0, [_temp(None)]))
|
||||
self.assertEqual(stats, {})
|
||||
|
||||
def test_keys_separate_by_label(self):
|
||||
stats: dict = {}
|
||||
tui.track(stats, Sample(0.0, [
|
||||
Reading("cpu", "temp", 50.0, "°C", "Core 0"),
|
||||
Reading("cpu", "temp", 70.0, "°C", "Core 1"),
|
||||
]))
|
||||
self.assertEqual(stats["cpu.temp.Core 0"], (50.0, 50.0))
|
||||
self.assertEqual(stats["cpu.temp.Core 1"], (70.0, 70.0))
|
||||
|
||||
|
||||
class BandTests(unittest.TestCase):
|
||||
def test_temperature_bands(self):
|
||||
self.assertEqual(tui.band(_temp(40.0)), "cold")
|
||||
self.assertEqual(tui.band(_temp(60.0)), "good")
|
||||
self.assertEqual(tui.band(_temp(80.0)), "warn")
|
||||
self.assertEqual(tui.band(_temp(90.0)), "crit")
|
||||
|
||||
def test_usage_bands(self):
|
||||
self.assertEqual(tui.band(Reading("gpu", "util", 50.0, "%")), "good")
|
||||
self.assertEqual(tui.band(Reading("gpu", "util", 88.0, "%")), "warn")
|
||||
self.assertEqual(tui.band(Reading("memory", "used_pct", 96.0, "%")), "crit")
|
||||
|
||||
def test_non_metric_percentage_is_normal(self):
|
||||
self.assertEqual(tui.band(Reading("gpu", "fan", 100.0, "%")), "normal")
|
||||
|
||||
def test_gpu_lost_is_crit(self):
|
||||
self.assertEqual(tui.band(Reading("gpu", "status", None, "", "query-timeout")), "crit")
|
||||
|
||||
def test_missing_value_is_na(self):
|
||||
self.assertEqual(tui.band(Reading("gpu", "power", None, "W")), "na")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,69 @@
|
||||
"""Tests for the M9/D12 game-launch watcher (RunningAppID parse + transitions)."""
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import watcher
|
||||
|
||||
_REGISTRY = """"Registry"
|
||||
{
|
||||
\t"HKCU"
|
||||
\t{
|
||||
\t\t"Software"
|
||||
\t\t{
|
||||
\t\t\t"Valve"
|
||||
\t\t\t{
|
||||
\t\t\t\t"Steam"
|
||||
\t\t\t\t{
|
||||
\t\t\t\t\t"RunningAppID"\t\t"%s"
|
||||
\t\t\t\t}
|
||||
\t\t\t}
|
||||
\t\t}
|
||||
\t}
|
||||
}
|
||||
"""
|
||||
|
||||
|
||||
class TransitionTests(unittest.TestCase):
|
||||
def test_transitions(self):
|
||||
self.assertEqual(watcher.transition(0, 570), "start")
|
||||
self.assertEqual(watcher.transition(570, 0), "stop")
|
||||
self.assertIsNone(watcher.transition(570, 570))
|
||||
self.assertIsNone(watcher.transition(0, 0))
|
||||
|
||||
|
||||
class FindKeyTests(unittest.TestCase):
|
||||
def test_case_insensitive_nested(self):
|
||||
data = {"Registry": {"HKCU": {"steam": {"runningappid": "42"}}}}
|
||||
self.assertEqual(watcher._find_key(data, "RunningAppID"), "42")
|
||||
|
||||
def test_missing(self):
|
||||
self.assertIsNone(watcher._find_key({"a": {"b": "c"}}, "RunningAppID"))
|
||||
|
||||
|
||||
class RunningAppIdTests(unittest.TestCase):
|
||||
def _with_registry(self, content):
|
||||
d = tempfile.mkdtemp()
|
||||
path = Path(d) / "registry.vdf"
|
||||
path.write_text(content)
|
||||
return path
|
||||
|
||||
def test_reads_running_appid(self):
|
||||
path = self._with_registry(_REGISTRY % "570")
|
||||
with mock.patch.object(watcher, "_registry_path", return_value=path):
|
||||
self.assertEqual(watcher.running_appid(), 570)
|
||||
|
||||
def test_zero_when_idle(self):
|
||||
path = self._with_registry(_REGISTRY % "0")
|
||||
with mock.patch.object(watcher, "_registry_path", return_value=path):
|
||||
self.assertEqual(watcher.running_appid(), 0)
|
||||
|
||||
def test_zero_when_no_registry(self):
|
||||
with mock.patch.object(watcher, "_registry_path", return_value=None):
|
||||
self.assertEqual(watcher.running_appid(), 0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,68 @@
|
||||
"""Tests for the D12 Steam-launch wrapper (rigdoctor wrap %command%)."""
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import wrap
|
||||
from rigdoctor.core.steam import Game
|
||||
|
||||
|
||||
class LaunchOptionTests(unittest.TestCase):
|
||||
def test_format(self):
|
||||
opt = wrap.launch_option()
|
||||
self.assertTrue(opt.endswith("wrap %command%"))
|
||||
self.assertIn("rigdoctor", opt)
|
||||
|
||||
|
||||
class GameNameTests(unittest.TestCase):
|
||||
def test_resolves_from_steam_appid(self):
|
||||
g = Game(appid="570", name="Dota 2", library="/x", installdir="dota")
|
||||
with mock.patch.dict("os.environ", {"SteamAppId": "570"}), \
|
||||
mock.patch("rigdoctor.core.steam.cached_games", return_value=[g]):
|
||||
self.assertEqual(wrap.game_name_from_env(), "Dota 2")
|
||||
|
||||
def test_unknown_appid_falls_back(self):
|
||||
with mock.patch.dict("os.environ", {"SteamAppId": "999"}), \
|
||||
mock.patch("rigdoctor.core.steam.cached_games", return_value=[]), \
|
||||
mock.patch("rigdoctor.core.steam.scan_games", return_value=[]):
|
||||
self.assertEqual(wrap.game_name_from_env(), "Steam app 999")
|
||||
|
||||
def test_none_without_steam_env(self):
|
||||
with mock.patch.dict("os.environ", {}, clear=True):
|
||||
self.assertIsNone(wrap.game_name_from_env())
|
||||
|
||||
|
||||
class RunTests(unittest.TestCase):
|
||||
def test_brackets_capture_and_returns_exit_code(self):
|
||||
with mock.patch("rigdoctor.core.reccontrol.running_pid", return_value=None), \
|
||||
mock.patch("rigdoctor.core.diagnostic.start", return_value=123) as start, \
|
||||
mock.patch("rigdoctor.core.reccontrol.stop_background") as stop, \
|
||||
mock.patch.dict("os.environ", {}, clear=True):
|
||||
rc = wrap.run(["true"])
|
||||
self.assertEqual(rc, 0)
|
||||
start.assert_called_once()
|
||||
stop.assert_called_once()
|
||||
|
||||
def test_propagates_game_failure(self):
|
||||
with mock.patch("rigdoctor.core.reccontrol.running_pid", return_value=None), \
|
||||
mock.patch("rigdoctor.core.diagnostic.start", return_value=123), \
|
||||
mock.patch("rigdoctor.core.reccontrol.stop_background"), \
|
||||
mock.patch.dict("os.environ", {}, clear=True):
|
||||
self.assertEqual(wrap.run(["false"]), 1)
|
||||
|
||||
def test_does_not_touch_an_existing_capture(self):
|
||||
with mock.patch("rigdoctor.core.reccontrol.running_pid", return_value=999), \
|
||||
mock.patch("rigdoctor.core.diagnostic.start") as start, \
|
||||
mock.patch("rigdoctor.core.reccontrol.stop_background") as stop, \
|
||||
mock.patch.dict("os.environ", {}, clear=True):
|
||||
rc = wrap.run(["true"])
|
||||
self.assertEqual(rc, 0)
|
||||
start.assert_not_called()
|
||||
stop.assert_not_called()
|
||||
|
||||
def test_empty_command_is_usage_error(self):
|
||||
self.assertEqual(wrap.run([]), 2)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user