Compare commits
29 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| a3caabc0d5 | |||
| b59f202891 | |||
| e6d94fbd59 | |||
| 045f40c4de | |||
| 2ff4056d89 | |||
| 2fe03269e4 | |||
| ac2a3981fc | |||
| 2684e5c8ab | |||
| 4386838b69 | |||
| bfbad9cbc6 | |||
| 2e545ff718 | |||
| 5e5dc2d54a | |||
| 7804893054 | |||
| bf3ac4af1a | |||
| e4a37176e1 | |||
| 67665974dc | |||
| 51b7ed69bd | |||
| 6fca2c9aba | |||
| 4c5a6547ec | |||
| 587568e574 | |||
| cc84bbda88 | |||
| 75a4da7af3 | |||
| f95387c5b8 | |||
| 1dc86121f6 | |||
| cd54e5f2c5 | |||
| 1b24d1b032 | |||
| 7ac14416b5 | |||
| b22a2f5593 | |||
| f45d8c9b34 |
+146
@@ -5,6 +5,152 @@ 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.28.0] - 2026-05-22
|
||||
### Added
|
||||
- **AI explanations now include recent game logs.** When you press "Explain with AI" on a
|
||||
diagnostic, RigDoctor also gathers recent **Proton** (`~/steam-<appid>.log`) and **Steam**
|
||||
console logs (`core/gamelogs.py`, tail-read + size-bounded) and passes them to the model, so
|
||||
it can correlate log errors with the sensor findings and pinpoint *when* something went wrong.
|
||||
### Fixed
|
||||
- The AI explanation popup now **renders Markdown** (headings, bold, lists) instead of showing
|
||||
raw `###`/`**` — `QTextEdit.setMarkdown`, and the model is told to answer in Markdown.
|
||||
|
||||
## [0.27.1] - 2026-05-22
|
||||
### Changed
|
||||
- AI assistant: selecting **Ollama** now pre-fills the model field with **`qwen2.5:7b`** (a
|
||||
strong 7B that fits an 8 GB GPU; our grounding makes a 7B sufficient). It won't overwrite a
|
||||
model you've already entered, and you can change it freely.
|
||||
|
||||
## [0.27.0] - 2026-05-22
|
||||
### Added
|
||||
- **AI assistant (M14, D24)** — optional, **strictly opt-in, never automatic**. Explains your
|
||||
diagnostics in plain language only when you press **"Explain with AI"** on the diagnostic
|
||||
dialog (or run `rigdoctor ai explain`). You choose a provider explicitly (no default):
|
||||
**Ollama** (local, private, no key) or **Claude** (Anthropic; key stored in the keyring, with
|
||||
a consent prompt before any data is sent). Configure in **Settings → AI assistant**.
|
||||
- Answers are **grounded**: RigDoctor passes the actual findings plus matched reference facts
|
||||
from a curated knowledge base (`core/ai_knowledge.py` — exact keyword/code match, no
|
||||
embeddings, stdlib only), so even a small local model gets the domain facts it needs. Stdlib
|
||||
`urllib` only — no new core dependency. Output is advisory (D9).
|
||||
- CLI: `rigdoctor ai status|test|explain`.
|
||||
|
||||
## [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
|
||||
|
||||
+26
-1
@@ -239,9 +239,34 @@ consent." That milestone lands here, **scoped tightly to stay safe**:
|
||||
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.
|
||||
|
||||
### D24 — AI assistant module (M14) — *DECIDED 2026-05-22; adds to D14*
|
||||
A new optional module that **explains the collected diagnostics in plain language** (likely
|
||||
root cause + suggested next steps). Adds M14 to the D14 set.
|
||||
- **Strictly opt-in, never automatic.** The model is contacted **only** on an explicit user
|
||||
action (an "Explain with AI" button / `rigdoctor ai explain`) — never on launch, after a
|
||||
diagnostic, in the sample/record loop, or in the background. **Configuring** a provider does
|
||||
not trigger any call.
|
||||
- **Local-first.** Defaults to a local **Ollama** server (data never leaves the machine, no
|
||||
key, stdlib `urllib`). An **OpenAI-compatible** endpoint (cloud or local) can be used with a
|
||||
key (stored in the keyring like the update token). Cloud use shows a "this sends your data to
|
||||
X" consent before the first call.
|
||||
- **Grounded & advisory.** The prompt carries only the findings we collected; output is framed
|
||||
as suggestions (consistent with D9 — it explains/recommends, applying fixes stays
|
||||
consent-gated). No new runtime dependency (HTTP via stdlib).
|
||||
|
||||
## Open
|
||||
|
||||
None currently — all tracked decisions (D1–D22) are resolved. New questions will be added
|
||||
None currently — all tracked decisions (D1–D24) 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`).
|
||||
|
||||
+44
-22
@@ -11,15 +11,16 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
| 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 | ⬜ |
|
||||
| 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 | ⬜ |
|
||||
| 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 | 🟨 |
|
||||
| M12 | Session sharing (shared terminal) | Sharing | none (relay) | all | P3 | ✅ |
|
||||
| M13 | Auto-update | (core) | none (stdlib; user-local file swap) | all | P3 | ✅ |
|
||||
| M14 | AI assistant (explain diagnostics) | (optional) | none (stdlib urllib; Ollama or Claude) | all | P3 | ✅ |
|
||||
| ~~M7~~ | ~~Stress / repro~~ | — | — | — | — | ❌ dropped (D7) |
|
||||
|
||||
## Notes per module
|
||||
@@ -41,7 +42,10 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
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** — depends on M1; the terminal "HWMonitor for Linux" face. Stdlib-only.
|
||||
- **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). *M6 implemented (Steam detection first —
|
||||
the D12 "pick a game" foundation):* discovers Steam installs + all library folders
|
||||
@@ -64,19 +68,26 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
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`). *Pending:* non-Steam
|
||||
launchers (Lutris/Heroic), GPU power-profile (PowerMizer) checks, and the zero-config watcher.
|
||||
(`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. *Implemented (first cut):* distro/
|
||||
package-manager/GPU detection (`core/sysenv`), an optional-component catalog (`core/catalog`),
|
||||
@@ -86,12 +97,13 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
**`.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) — 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.
|
||||
- **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`
|
||||
@@ -106,6 +118,15 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
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
|
||||
update via apt instead.)
|
||||
- **M14 AI assistant** (D24) — optional, **strictly opt-in, never automatic**: explains the
|
||||
collected diagnostics in plain language only when the user presses **"Explain with AI"**
|
||||
(`core/ai.py`, GUI button on the diagnostic dialog, `rigdoctor ai explain`). The user picks a
|
||||
provider explicitly (no default): **Ollama** (local, private, no key) or **Claude** (Anthropic
|
||||
Messages API, key in the keyring; consent prompt before sending). Answers are **grounded** —
|
||||
we pass the actual findings plus matched reference facts from a curated knowledge base
|
||||
(`core/ai_knowledge.py`, "RAG-lite": exact keyword/code match, no embeddings, stdlib only),
|
||||
which lifts a small local model and sharpens Claude. Stdlib `urllib` (no pip deps); output is
|
||||
advisory (D9). Configure in **Settings → AI assistant**.
|
||||
|
||||
## Bundles (final — D14)
|
||||
- **Essential:** M1 + M3 + M4 *(the MVP, NVIDIA-only — D5)*
|
||||
@@ -113,6 +134,7 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
- **Diagnostics:** M5 + M6
|
||||
- **Desktop UI:** M10 + M11 *(adds PySide6)*
|
||||
- **Sharing:** M12 *(session sharing / remote assist — D16)*
|
||||
- **AI:** M14 *(optional AI explanations — D24)*
|
||||
|
||||
## MVP candidate — *confirmed (D5)*
|
||||
**M1 + M3 + M4 (Essential), NVIDIA-only, CLI-first.** Gives a working tool that captures the
|
||||
|
||||
+32
-16
@@ -22,7 +22,8 @@ Ubuntu + NVIDIA first; `.deb` distribution (see `DECISIONS.md`).
|
||||
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
|
||||
@@ -33,13 +34,17 @@ Ubuntu + NVIDIA first; `.deb` distribution (see `DECISIONS.md`).
|
||||
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.
|
||||
*Pending:* non-Steam launchers (Lutris/Heroic) + GPU power-profile (PowerMizer) checks.
|
||||
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)
|
||||
- [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
|
||||
@@ -56,9 +61,14 @@ Ubuntu + NVIDIA first; `.deb` distribution (see `DECISIONS.md`).
|
||||
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 Setup tab); **user-local `install.sh` + self-extracting `.run`**
|
||||
(no-root venv install, handles python3-venv prereq, CI-built). *Pending:* module-selection
|
||||
config + `systemd --user` service enable + trigger-mode pick.
|
||||
(`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)
|
||||
@@ -72,14 +82,20 @@ Ubuntu + NVIDIA first; `.deb` distribution (see `DECISIONS.md`).
|
||||
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.
|
||||
- [x] Tier 2: live read-only view — `rigdoctor share serve` (stdlib HTTP, token-gated:
|
||||
sensors + health + inventory). Remote = user-chosen tunnel; GUI controls still to add.
|
||||
- [x] Tier 3: host-consented interactive terminal — a real PTY shell shared over the relay
|
||||
(own `pty`, pyte-rendered guest), off by default; host reads along + can type (sudo).
|
||||
## 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.
|
||||
|
||||
## Phase 7 — AI assistant (M14, D24)
|
||||
- [x] **Explain diagnostics with AI** — opt-in, never automatic (`core/ai.py`, "Explain with AI"
|
||||
button + `rigdoctor ai explain`). Provider chosen explicitly: **Ollama** (local) or
|
||||
**Claude** (Anthropic). Grounded with a curated reference KB (`core/ai_knowledge.py`,
|
||||
RAG-lite, exact match — no embeddings); stdlib `urllib`. Settings → AI assistant.
|
||||
- [ ] *Possible follow-ups:* interactive chat grounded in the data; more reference-KB entries;
|
||||
an "Explain" button on the System Health page.
|
||||
|
||||
> **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
-9
@@ -144,15 +144,23 @@ 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.)*
|
||||
|
||||
### M14 — AI assistant (D24)
|
||||
Optional module that explains the collected diagnostics in plain language. **Strictly opt-in and
|
||||
never automatic** — the model is contacted only when the user presses "Explain with AI" (GUI) or
|
||||
runs `rigdoctor ai explain`; configuring it contacts nothing. The user explicitly chooses a
|
||||
provider (no default): **Ollama** (local, private, no key) or **Claude** (Anthropic Messages
|
||||
API, key in the keyring, with a consent prompt before sending data). Answers are **grounded** in
|
||||
the actual findings plus matched reference facts from a curated, exact-match knowledge base
|
||||
("RAG-lite" — no embeddings/vector store, stdlib only); no fine-tuning. HTTP via stdlib `urllib`
|
||||
(no new core dependency); output is advisory (consistent with D9).
|
||||
|
||||
## 5. Non-functional requirements
|
||||
- **Zero hard deps for the core/CLI/daemon** — Python stdlib + tools already present. **Qt
|
||||
|
||||
@@ -115,3 +115,11 @@ 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
|
||||
|
||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "rigdoctor"
|
||||
version = "0.16.0"
|
||||
version = "0.28.0"
|
||||
description = "Modular hardware monitoring & crash diagnostics for Linux gamers."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.11"
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""RigDoctor — modular hardware monitoring & crash diagnostics for Linux gamers."""
|
||||
|
||||
__version__ = "0.16.0"
|
||||
__version__ = "0.28.0"
|
||||
|
||||
+114
-45
@@ -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:
|
||||
@@ -296,12 +289,6 @@ def cmd_uninstall(args) -> int:
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_share_serve(args) -> int:
|
||||
from .core import share
|
||||
|
||||
return share.serve(host=args.host, port=args.port)
|
||||
|
||||
|
||||
def cmd_collect_priv(args) -> int:
|
||||
"""Internal: emit root-only data (SMART + dmidecode) as JSON, run via pkexec at launch."""
|
||||
from dataclasses import asdict
|
||||
@@ -423,6 +410,68 @@ def cmd_wrap(args) -> int:
|
||||
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_ai(args) -> int:
|
||||
"""AI assistant (M14) — opt-in; only contacts a provider on `test`/`explain`."""
|
||||
from .core import ai
|
||||
|
||||
sub = args.ai_cmd or "status"
|
||||
if sub == "status":
|
||||
print(f"Provider: {ai.provider() or 'not configured'}")
|
||||
if ai.provider():
|
||||
print(f" {ai.provider_label()}")
|
||||
print(f" ready: {'yes' if ai.is_configured() else 'no'}")
|
||||
else:
|
||||
print(" Configure it in the GUI: Settings → AI assistant.")
|
||||
return 0
|
||||
|
||||
if not ai.is_configured():
|
||||
print("AI is not configured. Set it up in the GUI (Settings → AI assistant).")
|
||||
return 1
|
||||
|
||||
if sub == "test":
|
||||
ok, msg = ai.explain("Connectivity test — reply exactly: RigDoctor AI is working.")
|
||||
print(msg)
|
||||
return 0 if ok else 1
|
||||
|
||||
# explain: gather the current health findings and ask the provider to explain them.
|
||||
from .core import health
|
||||
|
||||
findings = health.run_health_checks()
|
||||
text = ai.format_findings(findings)
|
||||
print(f"Asking {ai.provider_label()} to explain the current health findings…\n")
|
||||
ok, msg = ai.explain(text)
|
||||
print(msg)
|
||||
return 0 if ok else 1
|
||||
|
||||
|
||||
def cmd_gameenv(args) -> int:
|
||||
from dataclasses import asdict
|
||||
|
||||
@@ -438,34 +487,41 @@ def cmd_gameenv(args) -> int:
|
||||
|
||||
|
||||
def cmd_games(args) -> int:
|
||||
from .core import steam
|
||||
from dataclasses import asdict
|
||||
|
||||
from .core import launchers, steam
|
||||
|
||||
selected = steam.selected_library_paths()
|
||||
if not selected:
|
||||
print("No Steam libraries selected to scan.")
|
||||
print(" See them with: rigdoctor games libraries")
|
||||
print(" Then enable one: rigdoctor games libraries --enable <path> (or --all)")
|
||||
return 1
|
||||
result = steam.rescan()
|
||||
if args.json:
|
||||
from dataclasses import asdict
|
||||
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,
|
||||
"new_appids": result.new_appids,
|
||||
"games": [asdict(g) for g in result.games],
|
||||
"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 result.games:
|
||||
print("No games found in the selected Steam libraries.")
|
||||
|
||||
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)
|
||||
print(f"{len(result.games)} game(s) across {len(selected)} librar(y/ies):\n")
|
||||
for g in result.games:
|
||||
flag = " NEW" if g.appid in new else ""
|
||||
print(f" {g.name:<48} {steam.human_size(g.size_bytes):>9}{flag}")
|
||||
if new:
|
||||
print(f"\n{len(new)} newly-installed since the last scan.")
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -516,8 +572,9 @@ 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)
|
||||
@@ -571,13 +628,6 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
cp = sub.add_parser("collect-priv", help=argparse.SUPPRESS) # internal: run via pkexec
|
||||
cp.set_defaults(func=cmd_collect_priv)
|
||||
|
||||
share_p = sub.add_parser("share", help="session sharing (M12)")
|
||||
share_sub = share_p.add_subparsers(dest="share_cmd", required=True)
|
||||
serve_p = share_sub.add_parser("serve", help="serve a read-only live view (token-gated)")
|
||||
serve_p.add_argument("--host", default="127.0.0.1", help="bind address (use 0.0.0.0 + a tunnel for remote)")
|
||||
serve_p.add_argument("--port", type=int, default=8765, help="port")
|
||||
serve_p.set_defaults(func=cmd_share_serve)
|
||||
|
||||
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)")
|
||||
@@ -617,6 +667,25 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
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)
|
||||
|
||||
ai_p = sub.add_parser("ai", help="AI assistant (M14): explain diagnostics — opt-in, never automatic")
|
||||
ai_sub = ai_p.add_subparsers(dest="ai_cmd")
|
||||
ai_sub.add_parser("status", help="show the configured provider (contacts nothing)").set_defaults(func=cmd_ai)
|
||||
ai_sub.add_parser("test", help="send a tiny probe to verify connectivity").set_defaults(func=cmd_ai)
|
||||
ai_sub.add_parser("explain", help="explain the current health findings with AI").set_defaults(func=cmd_ai)
|
||||
ai_p.set_defaults(func=cmd_ai, ai_cmd=None)
|
||||
return p
|
||||
|
||||
|
||||
|
||||
+73
-37
@@ -43,6 +43,11 @@ GAMES_FILE = STATE_DIR / "games.json"
|
||||
TOKEN_FILE = CONFIG_DIR / "token"
|
||||
_SECRET_ATTRS = ["application", "rigdoctor", "type", "update-token"]
|
||||
|
||||
# AI assistant (M14, D24) — API key for the Claude provider, stored in the keyring like the
|
||||
# update token (Ollama is local and needs none). Separate keyring entry + file fallback.
|
||||
AI_KEY_FILE = CONFIG_DIR / "ai-key"
|
||||
_AI_SECRET_ATTRS = ["application", "rigdoctor", "type", "ai-key"]
|
||||
|
||||
|
||||
def _secret_tool() -> str | None:
|
||||
return shutil.which("secret-tool")
|
||||
@@ -53,27 +58,27 @@ def keyring_available() -> bool:
|
||||
return _secret_tool() is not None
|
||||
|
||||
|
||||
def _keyring_store(token: str) -> bool:
|
||||
def _keyring_store(value: str, attrs: list[str], label: 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,
|
||||
[tool, "store", "--label", label, *attrs],
|
||||
input=value, text=True, capture_output=True, timeout=20,
|
||||
)
|
||||
return proc.returncode == 0
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
return False
|
||||
|
||||
|
||||
def _keyring_lookup() -> str | None:
|
||||
def _keyring_lookup(attrs: list[str]) -> 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
|
||||
[tool, "lookup", *attrs], text=True, capture_output=True, timeout=20
|
||||
)
|
||||
if proc.returncode == 0 and proc.stdout.strip():
|
||||
return proc.stdout.strip()
|
||||
@@ -82,54 +87,67 @@ def _keyring_lookup() -> str | None:
|
||||
return None
|
||||
|
||||
|
||||
def _keyring_clear() -> None:
|
||||
def _keyring_clear(attrs: list[str]) -> None:
|
||||
tool = _secret_tool()
|
||||
if not tool:
|
||||
return
|
||||
try:
|
||||
subprocess.run([tool, "clear", *_SECRET_ATTRS], capture_output=True, timeout=20)
|
||||
subprocess.run([tool, "clear", *attrs], capture_output=True, timeout=20)
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
pass
|
||||
|
||||
|
||||
def _load_secret(env_var: str | None, attrs: list[str], file: Path) -> str | None:
|
||||
if env_var:
|
||||
env = os.environ.get(env_var)
|
||||
if env and env.strip():
|
||||
return env.strip()
|
||||
from_keyring = _keyring_lookup(attrs)
|
||||
if from_keyring:
|
||||
return from_keyring
|
||||
try:
|
||||
value = file.read_text().strip()
|
||||
return value or None
|
||||
except OSError:
|
||||
return None
|
||||
|
||||
|
||||
def _save_secret(value: str, attrs: list[str], label: str, file: Path) -> None:
|
||||
value = value.strip()
|
||||
if _keyring_store(value, attrs, label):
|
||||
try: # don't leave a plaintext copy once it's in the keyring
|
||||
file.unlink()
|
||||
except OSError:
|
||||
pass
|
||||
return
|
||||
CONFIG_DIR.mkdir(parents=True, exist_ok=True)
|
||||
file.write_text(value + "\n")
|
||||
try:
|
||||
file.chmod(0o600)
|
||||
except OSError:
|
||||
pass
|
||||
|
||||
|
||||
def _clear_secret(attrs: list[str], file: Path) -> None:
|
||||
_keyring_clear(attrs)
|
||||
try:
|
||||
file.unlink()
|
||||
except 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
|
||||
return _load_secret("RIGDOCTOR_TOKEN", _SECRET_ATTRS, TOKEN_FILE)
|
||||
|
||||
|
||||
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
|
||||
_save_secret(token, _SECRET_ATTRS, "RigDoctor update token", TOKEN_FILE)
|
||||
|
||||
|
||||
def clear_token() -> None:
|
||||
_keyring_clear()
|
||||
try:
|
||||
TOKEN_FILE.unlink()
|
||||
except OSError:
|
||||
pass
|
||||
_clear_secret(_SECRET_ATTRS, TOKEN_FILE)
|
||||
|
||||
|
||||
def token_backend() -> str:
|
||||
@@ -137,12 +155,25 @@ def token_backend() -> str:
|
||||
env = os.environ.get("RIGDOCTOR_TOKEN")
|
||||
if env and env.strip():
|
||||
return "env"
|
||||
if _keyring_lookup() is not None:
|
||||
if _keyring_lookup(_SECRET_ATTRS) is not None:
|
||||
return "keyring"
|
||||
if TOKEN_FILE.exists():
|
||||
return "file"
|
||||
return "none"
|
||||
|
||||
|
||||
def load_ai_key() -> str | None:
|
||||
"""Claude API key from $RIGDOCTOR_AI_KEY, then the OS keyring, then a 0600 file (M14)."""
|
||||
return _load_secret("RIGDOCTOR_AI_KEY", _AI_SECRET_ATTRS, AI_KEY_FILE)
|
||||
|
||||
|
||||
def save_ai_key(key: str) -> None:
|
||||
_save_secret(key, _AI_SECRET_ATTRS, "RigDoctor AI key", AI_KEY_FILE)
|
||||
|
||||
|
||||
def clear_ai_key() -> None:
|
||||
_clear_secret(_AI_SECRET_ATTRS, AI_KEY_FILE)
|
||||
|
||||
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
|
||||
@@ -154,6 +185,11 @@ DEFAULTS: dict = {
|
||||
"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)
|
||||
"ai_provider": "", # AI assistant (M14, D24): "" (unset) | "ollama" | "claude"
|
||||
"ai_model": "", # model name (e.g. "llama3.1" for Ollama; blank = Claude default)
|
||||
"ai_endpoint": "http://localhost:11434", # Ollama server base URL (Claude uses a fixed endpoint)
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,178 @@
|
||||
"""AI assistant (M14, D24): explain the collected diagnostics in plain language.
|
||||
|
||||
**Strictly opt-in and never automatic** — the model is contacted ONLY from a direct user
|
||||
action ("Explain with AI" / ``rigdoctor ai explain``), never on launch, after a diagnostic, or
|
||||
in any loop. Choosing/configuring a provider does not contact anything. The user must pick a
|
||||
provider explicitly (there is no default).
|
||||
|
||||
Two providers, both over stdlib ``urllib`` (no pip deps in core):
|
||||
* **ollama** — a local server (data stays on the machine, no key).
|
||||
* **claude** — the Anthropic Messages API (key in the keyring).
|
||||
|
||||
Answers are *grounded*: we pass the actual findings plus matched reference facts
|
||||
(:mod:`ai_knowledge`) and ask the model to reason over them. Output is advisory (D9).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
|
||||
from .. import config
|
||||
from . import ai_knowledge
|
||||
|
||||
PROVIDERS = ("ollama", "claude")
|
||||
OLLAMA_DEFAULT_ENDPOINT = "http://localhost:11434"
|
||||
# Suggested Ollama model — strong instruction-following that fits an 8 GB GPU at Q4. Because we
|
||||
# ground the prompt with reference facts, a 7B model is sufficient here.
|
||||
OLLAMA_SUGGESTED_MODEL = "qwen2.5:7b"
|
||||
CLAUDE_ENDPOINT = "https://api.anthropic.com/v1/messages"
|
||||
CLAUDE_DEFAULT_MODEL = "claude-opus-4-7"
|
||||
CLAUDE_MAX_TOKENS = 2000
|
||||
ANTHROPIC_VERSION = "2023-06-01"
|
||||
|
||||
SYSTEM_PROMPT = (
|
||||
"You are RigDoctor's hardware-diagnostics assistant for Linux gamers. You are given the "
|
||||
"structured findings RigDoctor collected from this machine — which may include recent game, "
|
||||
"Proton, and system log excerpts — plus a set of reference facts. Explain in plain language "
|
||||
"what they mean, correlate any log errors with the findings to pinpoint WHEN and WHY things "
|
||||
"went wrong, identify the most likely root cause, and give concrete, ordered next steps "
|
||||
"(exact commands where useful). Base your reasoning ONLY on the data and reference facts "
|
||||
"provided — do not invent readings, hardware, or log lines. Be concise and practical. "
|
||||
"Present fixes as suggestions, and clearly warn before any step that could cause data loss "
|
||||
"or instability. Format your answer in Markdown."
|
||||
)
|
||||
|
||||
|
||||
def provider() -> str:
|
||||
return config.load_config().get("ai_provider", "")
|
||||
|
||||
|
||||
def model() -> str:
|
||||
m = config.load_config().get("ai_model", "").strip()
|
||||
if m:
|
||||
return m
|
||||
return CLAUDE_DEFAULT_MODEL if provider() == "claude" else ""
|
||||
|
||||
|
||||
def endpoint() -> str:
|
||||
ep = config.load_config().get("ai_endpoint", OLLAMA_DEFAULT_ENDPOINT).strip()
|
||||
return ep or OLLAMA_DEFAULT_ENDPOINT
|
||||
|
||||
|
||||
def is_local() -> bool:
|
||||
return provider() == "ollama"
|
||||
|
||||
|
||||
def is_configured() -> bool:
|
||||
"""Whether the chosen provider is ready (does NOT contact anything)."""
|
||||
p = provider()
|
||||
if p == "claude":
|
||||
return bool(config.load_ai_key())
|
||||
if p == "ollama":
|
||||
return bool(model()) # a model name is required; endpoint has a default
|
||||
return False # no provider chosen
|
||||
|
||||
|
||||
def provider_label() -> str:
|
||||
p = provider()
|
||||
if p == "claude":
|
||||
return f"Claude ({model()})"
|
||||
if p == "ollama":
|
||||
return f"Ollama ({model() or '?'} @ {endpoint()})"
|
||||
return "not configured"
|
||||
|
||||
|
||||
def build_prompt(findings_text: str) -> str:
|
||||
"""The user-message content: matched reference facts + the collected findings."""
|
||||
facts = ai_knowledge.relevant(findings_text)
|
||||
parts = []
|
||||
if facts:
|
||||
parts.append("Reference facts (use these to interpret the findings):")
|
||||
parts += [f"- {f}" for f in facts]
|
||||
parts.append("")
|
||||
parts.append("Collected findings:")
|
||||
parts.append(findings_text.strip() or "(no findings provided)")
|
||||
return "\n".join(parts)
|
||||
|
||||
|
||||
def explain(findings_text: str, timeout: float = 120.0) -> tuple[bool, str]:
|
||||
"""Contact the configured provider to explain the findings. Returns (ok, text | error).
|
||||
|
||||
The caller MUST be a direct user action (D24) — this never runs automatically.
|
||||
"""
|
||||
content = build_prompt(findings_text)
|
||||
try:
|
||||
if provider() == "claude":
|
||||
return _claude(content, timeout)
|
||||
if provider() == "ollama":
|
||||
return _ollama(content, timeout)
|
||||
return False, "No AI provider is configured (Settings → AI assistant)."
|
||||
except urllib.error.HTTPError as exc:
|
||||
return False, _http_error(exc)
|
||||
except (urllib.error.URLError, OSError, TimeoutError) as exc:
|
||||
return False, f"Couldn't reach the AI provider: {exc}"
|
||||
except (ValueError, KeyError, IndexError) as exc:
|
||||
return False, f"Unexpected response from the AI provider: {exc}"
|
||||
|
||||
|
||||
def _post(url: str, payload: dict, headers: dict, timeout: float) -> dict:
|
||||
req = urllib.request.Request(
|
||||
url, data=json.dumps(payload).encode("utf-8"),
|
||||
headers={"Content-Type": "application/json", **headers},
|
||||
)
|
||||
with urllib.request.urlopen(req, timeout=timeout) as resp:
|
||||
return json.load(resp)
|
||||
|
||||
|
||||
def _ollama(content: str, timeout: float) -> tuple[bool, str]:
|
||||
if not model():
|
||||
return False, "No Ollama model is set (Settings → AI assistant)."
|
||||
payload = {"model": model(), "system": SYSTEM_PROMPT, "prompt": content, "stream": False}
|
||||
out = _post(endpoint().rstrip("/") + "/api/generate", payload, {}, timeout)
|
||||
return True, (out.get("response") or "").strip() or "(the model returned an empty response)"
|
||||
|
||||
|
||||
def _claude(content: str, timeout: float) -> tuple[bool, str]:
|
||||
key = config.load_ai_key()
|
||||
if not key:
|
||||
return False, "No Claude API key is set (Settings → AI assistant)."
|
||||
# One-shot call: no prompt caching (single request, short system prompt) and no thinking
|
||||
# (keeps a button-press snappy). Sampling params are omitted (removed on current Opus).
|
||||
payload = {
|
||||
"model": model(),
|
||||
"max_tokens": CLAUDE_MAX_TOKENS,
|
||||
"system": SYSTEM_PROMPT,
|
||||
"messages": [{"role": "user", "content": content}],
|
||||
}
|
||||
headers = {"x-api-key": key, "anthropic-version": ANTHROPIC_VERSION}
|
||||
out = _post(CLAUDE_ENDPOINT, payload, headers, timeout)
|
||||
text = "\n".join(b.get("text", "") for b in out.get("content", []) if b.get("type") == "text")
|
||||
return True, text.strip() or "(the model returned no text)"
|
||||
|
||||
|
||||
def _http_error(exc: urllib.error.HTTPError) -> str:
|
||||
detail = ""
|
||||
try:
|
||||
body = exc.read().decode("utf-8", "replace")
|
||||
detail = json.loads(body).get("error", {}).get("message", "") or ""
|
||||
except (ValueError, OSError):
|
||||
pass
|
||||
hint = " — check your API key in Settings → AI assistant." if exc.code in (401, 403) else ""
|
||||
return f"AI request failed (HTTP {exc.code}){hint}{(': ' + detail) if detail else ''}"
|
||||
|
||||
|
||||
def format_findings(findings, header: str = "") -> str:
|
||||
"""Render M4 Finding objects (or similar) into the plain-text block we send the model."""
|
||||
lines = [header] if header else []
|
||||
for f in findings:
|
||||
severity = str(getattr(f, "severity", "")).upper()
|
||||
category = getattr(f, "category", "")
|
||||
title = getattr(f, "title", "")
|
||||
detail = getattr(f, "detail", "")
|
||||
line = f"- [{severity}] {category}: {title}".rstrip()
|
||||
if detail:
|
||||
line += f" — {detail}"
|
||||
lines.append(line)
|
||||
return "\n".join(lines) if lines else "No findings."
|
||||
@@ -0,0 +1,79 @@
|
||||
"""Curated reference knowledge for the AI assistant (M14, D24) — "RAG-lite".
|
||||
|
||||
A small, hand-written set of domain facts (Xid codes, SMART attributes, common Linux-gaming
|
||||
error signatures, tunable meanings). At explain-time we select the entries whose triggers
|
||||
appear in the collected findings and inject them into the prompt, so even a small local model
|
||||
gets the relevant facts instead of having to recall them. Provider-agnostic — it sharpens
|
||||
Claude too.
|
||||
|
||||
Retrieval is exact keyword/substring matching, not embeddings: the keys here (``Xid 79``,
|
||||
``SMART 197``, ``fallen off the bus``) are precise, so a vector store would be overkill and
|
||||
would break the stdlib-only rule. Each entry is ``(triggers, fact)``; a trigger matches
|
||||
case-insensitively against the findings text.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
# (triggers, fact). Keep facts short, factual, and cause-oriented — they go into the prompt.
|
||||
ENTRIES: list[tuple[tuple[str, ...], str]] = [
|
||||
(("xid 79", "fallen off the bus", "gpu has fallen"),
|
||||
"NVIDIA Xid 79 / 'GPU has fallen off the bus' = the driver lost PCIe contact with the GPU "
|
||||
"mid-operation. Usual causes, in order: insufficient/unstable PSU power or a bad power "
|
||||
"cable, an unstable overclock/undervolt, PCIe link or riser issues, or overheating. Often "
|
||||
"fatal to the session (hard freeze)."),
|
||||
(("xid 13", "graphics engine exception"),
|
||||
"NVIDIA Xid 13 = graphics engine exception, frequently an unstable GPU overclock or a "
|
||||
"faulty application shader; revert any OC/UV and test."),
|
||||
(("xid 31", "fifo: mmu fault", "mmu fault"),
|
||||
"NVIDIA Xid 31 = MMU fault (illegal memory access by the app/driver) — often a game/driver "
|
||||
"bug or unstable VRAM overclock."),
|
||||
(("xid 8", "xid 62", "xid 63", "xid 64"),
|
||||
"These Xid codes commonly indicate VRAM/ECC or memory-training problems — suspect failing "
|
||||
"VRAM or an unstable memory overclock."),
|
||||
(("smart 197", "current_pending_sector", "pending sector"),
|
||||
"SMART 197 (Current Pending Sector) > 0 = sectors the drive can't read and is waiting to "
|
||||
"reallocate — early sign of a failing disk. Back up now and run an extended self-test."),
|
||||
(("smart 198", "offline_uncorrectable", "uncorrectable"),
|
||||
"SMART 198 (Offline Uncorrectable) > 0 = sectors that failed to read/write — the drive is "
|
||||
"degrading; back up immediately."),
|
||||
(("smart 5", "reallocated_sector", "reallocated sector"),
|
||||
"SMART 5 (Reallocated Sectors) climbing over time = the drive is using spares for bad "
|
||||
"sectors; a rising count predicts failure."),
|
||||
(("media and data integrity errors", "percentage used", "available spare"),
|
||||
"NVMe health: 'Media and Data Integrity Errors' > 0 is concerning; 'Percentage Used' near "
|
||||
"or over 100% and 'Available Spare' below the threshold mean the SSD is near end-of-life."),
|
||||
(("thermal throttling", "throttle", "tjmax", "package id 0"),
|
||||
"Sustained CPU/GPU temperatures at the thermal limit cause throttling (clocks drop to shed "
|
||||
"heat) — check cooling, fan curves, paste, and case airflow."),
|
||||
(("oom", "out of memory", "oom-killer", "killed process"),
|
||||
"The kernel OOM-killer terminates processes when RAM (and swap) are exhausted — a freeze "
|
||||
"or a game crashing to desktop under memory pressure points here; check swap and "
|
||||
"vm.swappiness, and watch for a memory leak."),
|
||||
(("segfault", "general protection fault", "segmentation fault"),
|
||||
"A segfault/GP-fault is a process accessing invalid memory — for games under Proton it's "
|
||||
"often a Proton/Wine or anticheat incompatibility, or unstable RAM (run memtest)."),
|
||||
(("proton", "wine", "d3d", "vkd3d", "dxvk"),
|
||||
"Proton/Wine issues: mismatched Proton version, missing vkd3d/DXVK, or shader-cache "
|
||||
"corruption are common. Try a known-good Proton version and clear the shader cache."),
|
||||
(("pcie_aspm", "aspm"),
|
||||
"PCIe ASPM (Active State Power Management) can cause GPU/NVMe instability on some boards; "
|
||||
"setting pcie_aspm=off is a common stability fix at a small idle-power cost."),
|
||||
(("cpu_governor", "powersave", "schedutil", "performance governor"),
|
||||
"The CPU frequency governor sets the clock policy; 'performance' avoids latency spikes from "
|
||||
"ramp-up at a higher power draw, while 'powersave'/'schedutil' favor efficiency."),
|
||||
(("nvidia persistence", "persistence mode"),
|
||||
"NVIDIA persistence mode keeps the driver loaded when no app is using the GPU, avoiding "
|
||||
"re-init stalls — harmless to enable."),
|
||||
]
|
||||
|
||||
|
||||
def relevant(findings_text: str, limit: int = 8) -> list[str]:
|
||||
"""Reference facts whose triggers appear in the findings text (case-insensitive)."""
|
||||
haystack = findings_text.lower()
|
||||
hits: list[str] = []
|
||||
for triggers, fact in ENTRIES:
|
||||
if any(t in haystack for t in triggers):
|
||||
hits.append(fact)
|
||||
if len(hits) >= limit:
|
||||
break
|
||||
return hits
|
||||
@@ -65,3 +65,11 @@ COMPONENTS: tuple[Component, ...] = (
|
||||
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
|
||||
|
||||
@@ -71,6 +71,32 @@ def check_pcie_aspm() -> list[Finding]:
|
||||
|
||||
# --- 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 []
|
||||
@@ -235,6 +261,34 @@ def check_mitigations() -> list[Finding]:
|
||||
|
||||
# --- 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
|
||||
|
||||
@@ -259,6 +313,7 @@ def run_gameenv_checks() -> list[Finding]:
|
||||
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()
|
||||
@@ -267,5 +322,7 @@ def run_gameenv_checks() -> list[Finding]:
|
||||
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,67 @@
|
||||
"""Collect recent game / Proton / Steam logs to enrich an AI diagnostic (M14).
|
||||
|
||||
Reads logs that already exist on disk — no change to how the game is launched. Two reliable
|
||||
sources: Proton's per-app log (``~/steam-<appid>.log``, written when ``PROTON_LOG=1``) and
|
||||
Steam's own console log. Each is tail-read and size-bounded so the AI prompt stays small. The
|
||||
text is fed to the AI alongside the findings so it can see *when* something went wrong (a
|
||||
vkd3d/DXVK error, a crash line, the exit code) rather than only the sensor summary.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
# Steam keeps logs under its install root; ~/.steam/steam usually symlinks to the real one.
|
||||
_STEAM_LOG_DIRS = ("~/.steam/steam/logs", "~/.local/share/Steam/logs", "~/.steam/root/logs")
|
||||
_STEAM_LOG_FILES = ("console-linux.txt", "console_log.txt", "stderr.txt")
|
||||
|
||||
|
||||
def _tail(path: Path, max_bytes: int) -> str:
|
||||
"""Last ``max_bytes`` of a file, decoded leniently (empty string on error)."""
|
||||
try:
|
||||
size = path.stat().st_size
|
||||
with path.open("rb") as fh:
|
||||
if size > max_bytes:
|
||||
fh.seek(size - max_bytes)
|
||||
return fh.read().decode("utf-8", "replace")
|
||||
except OSError:
|
||||
return ""
|
||||
|
||||
|
||||
def _proton_logs() -> list[Path]:
|
||||
try:
|
||||
logs = list(Path.home().glob("steam-*.log"))
|
||||
except OSError:
|
||||
return []
|
||||
return sorted(logs, key=lambda p: p.stat().st_mtime, reverse=True)
|
||||
|
||||
|
||||
def _steam_console() -> Path | None:
|
||||
for directory in _STEAM_LOG_DIRS:
|
||||
base = Path(os.path.expanduser(directory))
|
||||
for name in _STEAM_LOG_FILES:
|
||||
candidate = base / name
|
||||
if candidate.exists():
|
||||
return candidate
|
||||
return None
|
||||
|
||||
|
||||
def available() -> bool:
|
||||
return bool(_proton_logs() or _steam_console())
|
||||
|
||||
|
||||
def collect(max_bytes: int = 6000) -> str:
|
||||
"""Recent Proton + Steam log tails as one labelled text block ('' if none)."""
|
||||
sections: list[str] = []
|
||||
protons = _proton_logs()
|
||||
if protons:
|
||||
tail = _tail(protons[0], max_bytes).strip()
|
||||
if tail:
|
||||
sections.append(f"--- Proton log ({protons[0].name}) ---\n{tail}")
|
||||
console = _steam_console()
|
||||
if console:
|
||||
tail = _tail(console, max_bytes).strip()
|
||||
if tail:
|
||||
sections.append(f"--- Steam log ({console.name}) ---\n{tail}")
|
||||
return "\n\n".join(sections)
|
||||
@@ -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,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
|
||||
@@ -1,194 +0,0 @@
|
||||
"""Session sharing (M12, Tier 2): a read-only live view over a local HTTP server.
|
||||
|
||||
Serves the live sensor snapshot + health report + inventory, **read-only**, 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.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import secrets
|
||||
from dataclasses import asdict
|
||||
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
|
||||
from urllib.parse import parse_qs, urlparse
|
||||
|
||||
from .sampler import Sampler
|
||||
from .sources import available_sources
|
||||
|
||||
_PAGE = """<!doctype html>
|
||||
<html><head><meta charset="utf-8"><title>RigDoctor — shared</title>
|
||||
<style>
|
||||
body{background:#101216;color:#e6e8eb;font-family:system-ui,sans-serif;margin:0;padding:24px}
|
||||
h1{font-size:20px;margin:0 0 4px} h2{font-size:14px;color:#8b929c;margin:18px 0 6px}
|
||||
.card{background:#1b1f26;border:1px solid #2a2f39;border-radius:12px;padding:16px;margin:14px 0}
|
||||
table{width:100%;border-collapse:collapse} td{padding:3px 0;font-size:14px}
|
||||
td.v{text-align:right;font-weight:600} .muted{color:#8b929c}
|
||||
.critical{color:#f87171} .warning{color:#fb923c} .ok{color:#4ade80} .info{color:#8b929c}
|
||||
.badge{display:inline-block;background:#38bdf8;color:#06222e;border-radius:6px;padding:1px 8px;font-size:12px;font-weight:700}
|
||||
</style></head><body>
|
||||
<h1>RigDoctor <span class="badge">read-only share</span></h1>
|
||||
<p class="muted">A live view shared by the machine's owner. You can look, not change anything.</p>
|
||||
<div class="card"><div id="live">loading…</div></div>
|
||||
<div class="card"><h2 style="margin-top:0">Health</h2><div id="health">loading…</div></div>
|
||||
<div class="card"><h2 style="margin-top:0">Inventory</h2><div id="inv">loading…</div></div>
|
||||
<script>
|
||||
const T=new URLSearchParams(location.search).get('t');
|
||||
const j=async p=>(await fetch(p+'?t='+encodeURIComponent(T))).json();
|
||||
const fmt=(v,u)=>v==null?'N/A':(u==='\\u00b0C'?(+v).toFixed(1)+' °C':(u?v+' '+u:v));
|
||||
async function live(){try{const d=await j('/api/snapshot');let h='';
|
||||
for(const[g,items]of Object.entries(d.groups)){h+='<h2>'+g.toUpperCase()+'</h2><table>';
|
||||
for(const it of items)h+='<tr><td class="muted">'+it.name+'</td><td class="v">'+fmt(it.value,it.unit)+'</td></tr>';
|
||||
h+='</table>';}document.getElementById('live').innerHTML=h;}catch(e){}}
|
||||
async function once(){try{const r=await j('/api/report');
|
||||
document.getElementById('health').innerHTML=r.map(f=>'<div><span class="'+f.severity+'">['+f.severity.toUpperCase()+']</span> '+f.category+': '+f.title+'</div>').join('')||'no findings';}catch(e){}
|
||||
try{const inv=await j('/api/inventory');let h='';
|
||||
for(const[s,kv]of Object.entries(inv)){h+='<h2>'+s+'</h2><table>';
|
||||
for(const[k,v]of Object.entries(kv))h+='<tr><td class="muted">'+k+'</td><td class="v">'+v+'</td></tr>';
|
||||
h+='</table>';}document.getElementById('inv').innerHTML=h;}catch(e){}}
|
||||
live();once();setInterval(live,2000);
|
||||
</script></body></html>"""
|
||||
|
||||
|
||||
def _snapshot(sampler: Sampler) -> dict:
|
||||
sample = sampler.sample()
|
||||
groups: dict[str, list] = {}
|
||||
for r in sample.readings:
|
||||
if r.metric == "name":
|
||||
item = {"name": "device", "value": r.label, "unit": ""}
|
||||
else:
|
||||
item = {"name": (r.label + " " + r.metric).strip() if r.label else r.metric,
|
||||
"value": r.value, "unit": r.unit}
|
||||
groups.setdefault(r.source, []).append(item)
|
||||
return {"ts": sample.ts, "groups": groups}
|
||||
|
||||
|
||||
def _report() -> list:
|
||||
from .health import run_health_checks
|
||||
return [asdict(f) for f in run_health_checks()]
|
||||
|
||||
|
||||
def _inventory() -> dict:
|
||||
from .inventory import collect, to_dict
|
||||
return to_dict(collect())
|
||||
|
||||
|
||||
# --- Relay (M12) frames: a host streams these; a guest renders them. -----------------
|
||||
|
||||
def host_full_frame(sampler: Sampler) -> str:
|
||||
"""Initial frame: live snapshot + health report + inventory."""
|
||||
return json.dumps({"type": "full", "snapshot": _snapshot(sampler),
|
||||
"report": _report(), "inventory": _inventory()})
|
||||
|
||||
|
||||
def host_snapshot_frame(sampler: Sampler) -> str:
|
||||
"""Recurring frame: just the live snapshot."""
|
||||
return json.dumps({"type": "snapshot", "snapshot": _snapshot(sampler)})
|
||||
|
||||
|
||||
def _fmt(value, unit: str) -> str:
|
||||
if value is None:
|
||||
return "N/A"
|
||||
if unit == "°C":
|
||||
try:
|
||||
return f"{float(value):.1f} °C"
|
||||
except (TypeError, ValueError):
|
||||
return str(value)
|
||||
return f"{value} {unit}".strip()
|
||||
|
||||
|
||||
def guest_html(snapshot: dict | None, report: list | None, inventory: dict | None) -> str:
|
||||
"""Render a received frame as read-only dark HTML for the guest's view."""
|
||||
import html as _html
|
||||
|
||||
def esc(x) -> str:
|
||||
return _html.escape(str(x))
|
||||
|
||||
out = ['<div style="font-family:sans-serif;color:#e6e8eb">']
|
||||
if snapshot:
|
||||
for group, items in snapshot.get("groups", {}).items():
|
||||
out.append(f'<h3 style="color:#8b929c">{esc(group).upper()}</h3><table width="100%">')
|
||||
for it in items:
|
||||
out.append(f'<tr><td style="color:#8b929c">{esc(it.get("name"))}</td>'
|
||||
f'<td align="right"><b>{esc(_fmt(it.get("value"), it.get("unit", "")))}</b></td></tr>')
|
||||
out.append("</table>")
|
||||
if report:
|
||||
out.append('<h3 style="color:#8b929c">HEALTH</h3>')
|
||||
colors = {"critical": "#f87171", "warning": "#fb923c", "ok": "#4ade80"}
|
||||
for f in report:
|
||||
sev = f.get("severity", "info")
|
||||
out.append(f'<div><span style="color:{colors.get(sev, "#8b929c")}">[{esc(sev).upper()}]</span> '
|
||||
f'{esc(f.get("category"))}: {esc(f.get("title"))}</div>')
|
||||
if inventory:
|
||||
out.append('<h3 style="color:#8b929c">INVENTORY</h3>')
|
||||
for section, kv in inventory.items():
|
||||
out.append(f'<h4 style="margin:6px 0;color:#8b929c">{esc(section)}</h4><table width="100%">')
|
||||
for k, v in kv.items():
|
||||
out.append(f'<tr><td style="color:#8b929c">{esc(k)}</td><td align="right"><b>{esc(v)}</b></td></tr>')
|
||||
out.append("</table>")
|
||||
out.append("</div>")
|
||||
return "".join(out)
|
||||
|
||||
|
||||
class _Handler(BaseHTTPRequestHandler):
|
||||
def log_message(self, *args): # quiet
|
||||
pass
|
||||
|
||||
def _authed(self, query: dict) -> bool:
|
||||
return secrets.compare_digest(query.get("t", [""])[0], self.server.token)
|
||||
|
||||
def _send(self, code: int, ctype: str, body: bytes) -> None:
|
||||
self.send_response(code)
|
||||
self.send_header("Content-Type", ctype)
|
||||
self.send_header("Content-Length", str(len(body)))
|
||||
self.end_headers()
|
||||
self.wfile.write(body)
|
||||
|
||||
def do_GET(self) -> None: # noqa: N802
|
||||
parsed = urlparse(self.path)
|
||||
if not self._authed(parse_qs(parsed.query)):
|
||||
self._send(403, "text/plain", b"Forbidden: missing or invalid share token")
|
||||
return
|
||||
if parsed.path == "/":
|
||||
self._send(200, "text/html; charset=utf-8", _PAGE.encode())
|
||||
elif parsed.path == "/api/snapshot":
|
||||
self._send(200, "application/json", json.dumps(_snapshot(self.server.sampler)).encode())
|
||||
elif parsed.path == "/api/report":
|
||||
self._send(200, "application/json", json.dumps(_report()).encode())
|
||||
elif parsed.path == "/api/inventory":
|
||||
self._send(200, "application/json", json.dumps(_inventory()).encode())
|
||||
else:
|
||||
self._send(404, "text/plain", b"Not found")
|
||||
|
||||
|
||||
class _Server(ThreadingHTTPServer):
|
||||
daemon_threads = True
|
||||
|
||||
def __init__(self, addr, token: str):
|
||||
super().__init__(addr, _Handler)
|
||||
self.token = token
|
||||
self.sampler = Sampler(available_sources())
|
||||
|
||||
|
||||
def make_server(host: str = "127.0.0.1", port: int = 0, token: str | None = None) -> tuple[_Server, str]:
|
||||
token = token or secrets.token_urlsafe(16)
|
||||
return _Server((host, port), token), token
|
||||
|
||||
|
||||
def serve(host: str = "127.0.0.1", port: int = 8765) -> int:
|
||||
srv, token = make_server(host, port)
|
||||
url = f"http://{host}:{srv.server_address[1]}/?t={token}"
|
||||
print(
|
||||
f"Sharing a read-only live view at:\n {url}\n\n"
|
||||
"Anyone with this URL (and network access to this host) can VIEW your sensors,\n"
|
||||
"health report, and inventory — read-only. For remote help, expose it via a tunnel\n"
|
||||
"(Tailscale / cloudflared / `ssh -R`). Press Ctrl-C to stop sharing.",
|
||||
flush=True,
|
||||
)
|
||||
try:
|
||||
srv.serve_forever()
|
||||
except KeyboardInterrupt:
|
||||
print("\nStopped sharing.")
|
||||
finally:
|
||||
srv.shutdown()
|
||||
return 0
|
||||
@@ -58,10 +58,11 @@ class SteamLibrary:
|
||||
class Game:
|
||||
appid: str
|
||||
name: str
|
||||
library: str # library path the game lives in
|
||||
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 --------------------------------------------------
|
||||
@@ -313,7 +314,8 @@ def cached_games() -> list[Game]:
|
||||
cache = load_cache()
|
||||
if not cache:
|
||||
return []
|
||||
return [Game(**{k: g.get(k) for k in Game.__dataclass_fields__}) for g in cache.get("games", [])]
|
||||
# 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:
|
||||
@@ -353,6 +355,21 @@ def acknowledge_new() -> None:
|
||||
|
||||
# --- 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:
|
||||
|
||||
@@ -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
|
||||
@@ -28,9 +28,21 @@ def main(argv: list[str] | None = None) -> int:
|
||||
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)
|
||||
window.show()
|
||||
# `--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()
|
||||
|
||||
|
||||
|
||||
@@ -2,15 +2,19 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from PySide6.QtCore import Qt
|
||||
import threading
|
||||
|
||||
from PySide6.QtCore import Qt, Signal
|
||||
from PySide6.QtGui import QFont
|
||||
from PySide6.QtWidgets import (
|
||||
QDialog,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
@@ -20,8 +24,12 @@ from .widgets import finding_card
|
||||
|
||||
|
||||
class DiagnosticDialog(QDialog):
|
||||
_explained = Signal(object) # (ok, text) from a user-triggered AI explanation
|
||||
|
||||
def __init__(self, result, parent=None) -> None:
|
||||
super().__init__(parent)
|
||||
self._result = result
|
||||
self._explained.connect(self._on_explained)
|
||||
self.setWindowTitle(f"Diagnostic — {result.game}" if result.game else "Diagnostic")
|
||||
self.resize(660, 680)
|
||||
|
||||
@@ -73,9 +81,69 @@ class DiagnosticDialog(QDialog):
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
buttons = QHBoxLayout()
|
||||
self._explain_btn = QPushButton("Explain with AI")
|
||||
self._explain_btn.clicked.connect(self._explain_with_ai)
|
||||
from ..core import ai
|
||||
self._explain_btn.setVisible(ai.is_configured()) # opt-in only; hidden if not set up
|
||||
buttons.addWidget(self._explain_btn)
|
||||
buttons.addStretch(1)
|
||||
close = QPushButton("Close")
|
||||
close.setObjectName("PrimaryButton")
|
||||
close.clicked.connect(self.accept)
|
||||
buttons.addWidget(close)
|
||||
root.addLayout(buttons)
|
||||
|
||||
# --- AI explanation (M14, D24) — runs only on this button press ----------------
|
||||
def _explain_with_ai(self) -> None:
|
||||
from ..core import ai
|
||||
|
||||
if not ai.is_local(): # cloud provider → explicit consent before sending data
|
||||
confirm = QMessageBox.question(
|
||||
self, "Send to AI provider",
|
||||
f"This sends your diagnostic findings to {ai.provider_label()}.\n\nContinue?",
|
||||
QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
|
||||
QMessageBox.StandardButton.No,
|
||||
)
|
||||
if confirm != QMessageBox.StandardButton.Yes:
|
||||
return
|
||||
self._explain_btn.setEnabled(False)
|
||||
self._explain_btn.setText("Asking the AI…")
|
||||
threading.Thread(target=self._work_explain, daemon=True).start()
|
||||
|
||||
def _work_explain(self) -> None:
|
||||
from ..core import ai, gamelogs
|
||||
|
||||
text = ai.format_findings(self._result.findings, header="Diagnostic findings:")
|
||||
text += "\n\nCapture summary:\n" + render_summary(self._result.summary)
|
||||
logs = gamelogs.collect()
|
||||
if logs:
|
||||
text += "\n\nRecent game/Proton/Steam logs (newest at the end):\n" + logs
|
||||
self._explained.emit(ai.explain(text))
|
||||
|
||||
def _on_explained(self, result) -> None:
|
||||
ok, text = result
|
||||
self._explain_btn.setEnabled(True)
|
||||
self._explain_btn.setText("Explain with AI")
|
||||
self._show_explanation(text if ok else f"AI explanation failed:\n\n{text}")
|
||||
|
||||
def _show_explanation(self, text: str) -> None:
|
||||
from ..core import ai
|
||||
|
||||
dlg = QDialog(self)
|
||||
dlg.setWindowTitle(f"AI explanation — {ai.provider_label()}")
|
||||
dlg.resize(620, 520)
|
||||
lay = QVBoxLayout(dlg)
|
||||
view = QTextEdit()
|
||||
view.setObjectName("Report")
|
||||
view.setReadOnly(True)
|
||||
view.setMarkdown(text) # the model replies in Markdown — render it
|
||||
lay.addWidget(view)
|
||||
note = QLabel("AI-generated suggestions — verify before acting, especially anything that changes settings or data.")
|
||||
note.setObjectName("Muted")
|
||||
note.setWordWrap(True)
|
||||
lay.addWidget(note)
|
||||
close = QPushButton("Close")
|
||||
close.setObjectName("PrimaryButton")
|
||||
close.clicked.connect(dlg.accept)
|
||||
lay.addWidget(close, alignment=Qt.AlignmentFlag.AlignRight)
|
||||
dlg.exec()
|
||||
|
||||
@@ -46,7 +46,7 @@ class EnvironmentPage(QWidget):
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("Environment")
|
||||
title = QLabel("Tuning")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.addStretch(1)
|
||||
|
||||
@@ -88,6 +88,7 @@ class GamesPage(QWidget):
|
||||
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)
|
||||
@@ -213,7 +214,7 @@ class GamesPage(QWidget):
|
||||
threading.Thread(target=self._work, daemon=True).start()
|
||||
|
||||
def _work(self) -> None:
|
||||
from ..core import steam
|
||||
from ..core import launchers, steam
|
||||
|
||||
try:
|
||||
selected = {os.path.realpath(p) for p in steam.selected_library_paths()}
|
||||
@@ -223,6 +224,10 @@ class GamesPage(QWidget):
|
||||
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)
|
||||
@@ -265,11 +270,13 @@ class GamesPage(QWidget):
|
||||
self._status.setText("scan failed")
|
||||
return
|
||||
self._new_appids = set(result.new_appids)
|
||||
self._populate_games(result.games, self._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(result.games)} games · {time.strftime('%H:%M:%S')}{suffix}"
|
||||
f"{len(games)} games · {time.strftime('%H:%M:%S')}{suffix}{non_steam}"
|
||||
)
|
||||
self.new_count_changed.emit(new)
|
||||
|
||||
@@ -293,12 +300,17 @@ class GamesPage(QWidget):
|
||||
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,
|
||||
os.path.basename(g.library.rstrip("/")) or g.library,
|
||||
sublabel,
|
||||
steam.human_size(g.size_bytes),
|
||||
g.appid in new_appids,
|
||||
appid=g.appid,
|
||||
appid=appid,
|
||||
on_diagnose=self._start_diagnostic,
|
||||
))
|
||||
self._list.addStretch(1)
|
||||
|
||||
@@ -32,7 +32,7 @@ class HealthPage(QWidget):
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("Health")
|
||||
title = QLabel("System Health")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.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,12 +2,14 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import html
|
||||
import os
|
||||
import sys
|
||||
import threading
|
||||
from pathlib import Path
|
||||
|
||||
from PySide6.QtCore import Qt, QProcess, QTimer, Signal
|
||||
from PySide6.QtGui import QTextDocument
|
||||
from PySide6.QtGui import QIcon, QTextDocument
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QButtonGroup,
|
||||
@@ -19,6 +21,7 @@ from PySide6.QtWidgets import (
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QStackedWidget,
|
||||
QSystemTrayIcon,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
@@ -31,14 +34,24 @@ from .dashboard import Dashboard
|
||||
from .environment_page import EnvironmentPage
|
||||
from .games_page import GamesPage
|
||||
from .health_page import HealthPage
|
||||
from .notifications_page import NotificationsPage
|
||||
from .inventory_page import InventoryPage
|
||||
from .recorder_page import RecorderPage
|
||||
from .setup_page import SetupPage
|
||||
from .share_page import SharePage
|
||||
from .theme import ACCENT, GOOD, MUTED
|
||||
from .theme import ACCENT, CRIT, GOOD, MUTED, TEXT
|
||||
from .tray import TrayIcon
|
||||
from .worker import SamplerWorker
|
||||
|
||||
_NAV_ITEMS = ["Dashboard", "Logs", "Health", "Games", "Environment", "Setup", "Notifications", "Share"]
|
||||
# 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):
|
||||
@@ -71,18 +84,23 @@ class MainWindow(QMainWindow):
|
||||
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.notifications_page = NotificationsPage()
|
||||
self.notifications_page.changed.connect(self._apply_alert_settings)
|
||||
self.setup_page.changed.connect(self._apply_alert_settings)
|
||||
self.share_page = SharePage()
|
||||
self._stack.addWidget(self.dashboard) # 0 Dashboard
|
||||
self._stack.addWidget(self.recorder_page) # 1 Logs
|
||||
self._stack.addWidget(self.health_page) # 2 Health
|
||||
self._stack.addWidget(self.games_page) # 3 Games
|
||||
self._stack.addWidget(self.environment_page) # 4 Environment
|
||||
self._stack.addWidget(self.setup_page) # 5 Setup
|
||||
self._stack.addWidget(self.notifications_page) # 6 Notifications
|
||||
self._stack.addWidget(self.share_page) # 7 Share
|
||||
# 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())
|
||||
@@ -124,6 +142,30 @@ class MainWindow(QMainWindow):
|
||||
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")
|
||||
@@ -138,21 +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)
|
||||
self._nav_buttons: dict[str, QPushButton] = {}
|
||||
for i, name in enumerate(_NAV_ITEMS):
|
||||
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)
|
||||
v.addWidget(btn)
|
||||
self._nav_buttons[name] = btn
|
||||
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(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>')
|
||||
@@ -234,9 +293,64 @@ class MainWindow(QMainWindow):
|
||||
self._elevated.emit()
|
||||
|
||||
def _on_elevated(self) -> None:
|
||||
# Re-run Health now that root-only SMART data is available. (dmidecode is still
|
||||
# collected and used by the relay guest view + the CLI `rigdoctor inventory`.)
|
||||
# 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")
|
||||
@@ -319,6 +433,19 @@ class MainWindow(QMainWindow):
|
||||
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,108 +0,0 @@
|
||||
"""Notifications page (M8 config): user-configurable alert settings."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from PySide6.QtCore import Qt, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QCheckBox,
|
||||
QDoubleSpinBox,
|
||||
QFrame,
|
||||
QGridLayout,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..config import load_config, update_config
|
||||
from ..core import alerts
|
||||
|
||||
|
||||
class NotificationsPage(QWidget):
|
||||
changed = Signal() # settings saved — main window re-applies them live
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
title = QLabel("Notifications")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
v = QVBoxLayout(card)
|
||||
v.setContentsMargins(16, 14, 16, 14)
|
||||
v.setSpacing(10)
|
||||
head = QLabel("Alerts")
|
||||
head.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
v.addWidget(head)
|
||||
|
||||
self._enabled = QCheckBox("Enable desktop notifications")
|
||||
v.addWidget(self._enabled)
|
||||
|
||||
grid = QGridLayout()
|
||||
grid.setHorizontalSpacing(12)
|
||||
grid.setColumnStretch(2, 1)
|
||||
self._gpu = self._spin()
|
||||
self._cpu = self._spin()
|
||||
grid.addWidget(QLabel("GPU temperature alert"), 0, 0)
|
||||
grid.addWidget(self._gpu, 0, 1)
|
||||
grid.addWidget(QLabel("CPU temperature alert"), 1, 0)
|
||||
grid.addWidget(self._cpu, 1, 1)
|
||||
v.addLayout(grid)
|
||||
|
||||
note = QLabel("GPU-lost and new-version alerts are included whenever notifications are enabled.")
|
||||
note.setObjectName("Muted")
|
||||
note.setWordWrap(True)
|
||||
v.addWidget(note)
|
||||
|
||||
buttons = QHBoxLayout()
|
||||
save = QPushButton("Save")
|
||||
save.setObjectName("PrimaryButton")
|
||||
save.clicked.connect(self._save)
|
||||
test = QPushButton("Send test")
|
||||
test.clicked.connect(self._test)
|
||||
buttons.addWidget(save)
|
||||
buttons.addWidget(test)
|
||||
buttons.addStretch(1)
|
||||
v.addLayout(buttons)
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
v.addWidget(self._status)
|
||||
|
||||
root.addWidget(card)
|
||||
root.addStretch(1)
|
||||
self._load()
|
||||
|
||||
@staticmethod
|
||||
def _spin() -> QDoubleSpinBox:
|
||||
spin = QDoubleSpinBox()
|
||||
spin.setRange(40, 110)
|
||||
spin.setDecimals(0)
|
||||
spin.setSingleStep(1)
|
||||
spin.setSuffix(" °C")
|
||||
return spin
|
||||
|
||||
def _load(self) -> None:
|
||||
cfg = load_config()
|
||||
self._enabled.setChecked(bool(cfg.get("alerts_enabled", True)))
|
||||
self._gpu.setValue(float(cfg.get("gpu_temp_alert", 90.0)))
|
||||
self._cpu.setValue(float(cfg.get("cpu_temp_alert", 95.0)))
|
||||
|
||||
def _save(self) -> None:
|
||||
update_config(
|
||||
alerts_enabled=self._enabled.isChecked(),
|
||||
gpu_temp_alert=self._gpu.value(),
|
||||
cpu_temp_alert=self._cpu.value(),
|
||||
)
|
||||
self.changed.emit()
|
||||
self._status.setText("Saved.")
|
||||
|
||||
def _test(self) -> None:
|
||||
ok = alerts.notify("RigDoctor", "Test notification — alerts are working.")
|
||||
self._status.setText("Test notification sent." if ok else "notify-send not found — install libnotify-bin (Setup).")
|
||||
@@ -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))
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
"""Setup page (M9 in the GUI): show environment + optional components, install missing."""
|
||||
"""Settings page: components/deps, alerts (M8), account access (token), and uninstall."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
@@ -8,12 +8,18 @@ from PySide6.QtCore import Qt, QUrl, Signal
|
||||
from PySide6.QtGui import QDesktopServices
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QButtonGroup,
|
||||
QCheckBox,
|
||||
QComboBox,
|
||||
QDoubleSpinBox,
|
||||
QFrame,
|
||||
QGridLayout,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QRadioButton,
|
||||
QSizePolicy,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
@@ -21,7 +27,7 @@ from PySide6.QtWidgets import (
|
||||
)
|
||||
|
||||
from .. import config
|
||||
from ..core import installer, sysenv, uninstall, updates
|
||||
from ..core import ai, alerts, installer, service, sysenv, uninstall, updates
|
||||
from .theme import GOOD, MUTED, WARN
|
||||
|
||||
|
||||
@@ -49,18 +55,23 @@ _BACKEND_DESC = {
|
||||
class SetupPage(QWidget):
|
||||
_installed = Signal(int, str)
|
||||
_upd_state = Signal(object)
|
||||
_mode_applied = Signal(object) # (mode, ok, message) from a trigger-mode change
|
||||
_ai_tested = Signal(object) # (ok, message) from an AI connectivity test
|
||||
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)
|
||||
self._ai_tested.connect(self._on_ai_tested)
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
title = QLabel("Setup")
|
||||
title = QLabel("Settings")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
|
||||
@@ -70,7 +81,7 @@ class SetupPage(QWidget):
|
||||
env_layout.addWidget(self._env)
|
||||
root.addWidget(env_card)
|
||||
|
||||
comp_card, comp_layout = _panel("Optional components")
|
||||
comp_card, comp_layout = _panel("Components & dependencies")
|
||||
self._components = QVBoxLayout()
|
||||
self._components.setSpacing(6)
|
||||
comp_layout.addLayout(self._components)
|
||||
@@ -80,12 +91,130 @@ class SetupPage(QWidget):
|
||||
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)
|
||||
|
||||
# AI assistant (M14, D24): explain diagnostics. Strictly opt-in — the model is only
|
||||
# contacted when the user presses "Explain with AI"; this panel just configures it.
|
||||
ai_card, ai_layout = _panel("AI assistant")
|
||||
ai_desc = QLabel(
|
||||
"Optionally let an AI explain your diagnostics in plain language. It runs <b>only</b> "
|
||||
"when you press “Explain with AI” — never automatically. Choose a provider:\n"
|
||||
"• Ollama — a local model on your machine (private, no key; needs Ollama running).\n"
|
||||
"• Claude — Anthropic's API (higher quality; sends findings to Anthropic; needs a key)."
|
||||
)
|
||||
ai_desc.setObjectName("Muted")
|
||||
ai_desc.setWordWrap(True)
|
||||
ai_layout.addWidget(ai_desc)
|
||||
|
||||
prov_row = QHBoxLayout()
|
||||
self._ai_group = QButtonGroup(self)
|
||||
self._ai_ollama = QRadioButton("Ollama (local)")
|
||||
self._ai_claude = QRadioButton("Claude (Anthropic)")
|
||||
self._ai_group.addButton(self._ai_ollama)
|
||||
self._ai_group.addButton(self._ai_claude)
|
||||
self._ai_ollama.toggled.connect(self._on_ai_provider_changed)
|
||||
prov_row.addWidget(self._ai_ollama)
|
||||
prov_row.addWidget(self._ai_claude)
|
||||
prov_row.addStretch(1)
|
||||
ai_layout.addLayout(prov_row)
|
||||
|
||||
self._ai_model = QLineEdit()
|
||||
self._ai_model.setPlaceholderText(
|
||||
f"Model (e.g. {ai.OLLAMA_SUGGESTED_MODEL} for Ollama; blank = Claude default)")
|
||||
ai_layout.addWidget(self._ai_model)
|
||||
self._ai_endpoint = QLineEdit()
|
||||
self._ai_endpoint.setPlaceholderText("Ollama server URL (default http://localhost:11434)")
|
||||
ai_layout.addWidget(self._ai_endpoint)
|
||||
self._ai_key = QLineEdit()
|
||||
self._ai_key.setEchoMode(QLineEdit.EchoMode.Password)
|
||||
self._ai_key.setPlaceholderText("Claude API key (stored in your keyring)")
|
||||
ai_layout.addWidget(self._ai_key)
|
||||
|
||||
ai_btn_row = QHBoxLayout()
|
||||
ai_save = QPushButton("Save")
|
||||
ai_save.setObjectName("PrimaryButton")
|
||||
ai_save.clicked.connect(self._save_ai)
|
||||
self._ai_test_btn = QPushButton("Test")
|
||||
self._ai_test_btn.clicked.connect(self._test_ai)
|
||||
ai_btn_row.addWidget(ai_save)
|
||||
ai_btn_row.addWidget(self._ai_test_btn)
|
||||
ai_btn_row.addStretch(1)
|
||||
ai_layout.addLayout(ai_btn_row)
|
||||
self._ai_status = QLabel("")
|
||||
self._ai_status.setObjectName("Muted")
|
||||
self._ai_status.setWordWrap(True)
|
||||
ai_layout.addWidget(self._ai_status)
|
||||
root.addWidget(ai_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. "
|
||||
@@ -115,7 +244,7 @@ class SetupPage(QWidget):
|
||||
self._output = QTextEdit()
|
||||
self._output.setObjectName("Report")
|
||||
self._output.setReadOnly(True)
|
||||
self._output.setMinimumHeight(180)
|
||||
self._output.setMinimumHeight(160)
|
||||
self._output.setVisible(False)
|
||||
root.addWidget(self._output)
|
||||
root.addStretch(1)
|
||||
@@ -129,8 +258,122 @@ class SetupPage(QWidget):
|
||||
root.addLayout(danger)
|
||||
|
||||
self._refresh()
|
||||
self._load_alerts()
|
||||
self._trigger.setCurrentText(config.load_config().get("trigger_mode", "manual"))
|
||||
self._load_ai()
|
||||
self._refresh_update_status()
|
||||
|
||||
# --- AI assistant (M14) ---------------------------------------------------
|
||||
def _load_ai(self) -> None:
|
||||
cfg = config.load_config()
|
||||
prov = cfg.get("ai_provider", "")
|
||||
self._ai_claude.setChecked(prov == "claude")
|
||||
self._ai_ollama.setChecked(prov == "ollama")
|
||||
self._ai_model.setText(cfg.get("ai_model", ""))
|
||||
self._ai_endpoint.setText(cfg.get("ai_endpoint", "http://localhost:11434"))
|
||||
if config.load_ai_key():
|
||||
self._ai_key.setPlaceholderText("Claude API key saved — type to replace")
|
||||
self._on_ai_provider_changed()
|
||||
|
||||
def _ai_provider(self) -> str:
|
||||
if self._ai_claude.isChecked():
|
||||
return "claude"
|
||||
if self._ai_ollama.isChecked():
|
||||
return "ollama"
|
||||
return ""
|
||||
|
||||
def _on_ai_provider_changed(self) -> None:
|
||||
prov = self._ai_provider()
|
||||
self._ai_endpoint.setVisible(prov == "ollama")
|
||||
self._ai_key.setVisible(prov == "claude")
|
||||
self._ai_test_btn.setEnabled(prov != "")
|
||||
if prov == "ollama" and not self._ai_model.text().strip():
|
||||
self._ai_model.setText(ai.OLLAMA_SUGGESTED_MODEL) # suggested default; user can change
|
||||
|
||||
def _save_ai(self) -> None:
|
||||
prov = self._ai_provider()
|
||||
config.update_config(
|
||||
ai_provider=prov,
|
||||
ai_model=self._ai_model.text().strip(),
|
||||
ai_endpoint=self._ai_endpoint.text().strip() or "http://localhost:11434",
|
||||
)
|
||||
if prov == "claude" and self._ai_key.text().strip():
|
||||
config.save_ai_key(self._ai_key.text().strip())
|
||||
self._ai_key.clear()
|
||||
self._ai_key.setPlaceholderText("Claude API key saved — type to replace")
|
||||
self._ai_status.setText("Saved." if prov else "Saved — no provider selected (AI stays off).")
|
||||
|
||||
def _test_ai(self) -> None:
|
||||
self._save_ai()
|
||||
self._ai_status.setText("Testing… contacting the provider.")
|
||||
self._ai_test_btn.setEnabled(False)
|
||||
threading.Thread(target=self._work_test_ai, daemon=True).start()
|
||||
|
||||
def _work_test_ai(self) -> None:
|
||||
from ..core import ai
|
||||
|
||||
ok, msg = ai.explain("Connectivity test — reply exactly: RigDoctor AI is working.")
|
||||
self._ai_tested.emit((ok, msg))
|
||||
|
||||
def _on_ai_tested(self, result) -> None:
|
||||
ok, msg = result
|
||||
self._ai_test_btn.setEnabled(True)
|
||||
self._ai_status.setText(("✓ " if ok else "✗ ") + (msg[:200] if msg else ""))
|
||||
|
||||
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)
|
||||
|
||||
@@ -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()
|
||||
+100
-100
@@ -1,9 +1,10 @@
|
||||
"""Share page (M12): host or join a shared session over the relay.
|
||||
"""Share page (M12): a shared **terminal** session over the relay.
|
||||
|
||||
Guest sees the host's live sensors + health + inventory (read-only). If the host enables it,
|
||||
a full **PTY terminal** is shared: the guest types and the commands run on the host (as the
|
||||
host's user), the host reads along, and the host can type too — e.g. a sudo password, which
|
||||
stays local and is never sent to the guest.
|
||||
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
|
||||
@@ -11,7 +12,8 @@ from __future__ import annotations
|
||||
import base64
|
||||
import json
|
||||
|
||||
from PySide6.QtCore import Qt, QSocketNotifier, QTimer, QUrl
|
||||
from PySide6.QtCore import Qt, QSocketNotifier, QUrl
|
||||
from PySide6.QtGui import QKeySequence, QShortcut
|
||||
from PySide6.QtWebSockets import QWebSocket
|
||||
from PySide6.QtWidgets import (
|
||||
QCheckBox,
|
||||
@@ -20,16 +22,12 @@ from PySide6.QtWidgets import (
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QPushButton,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..config import load_config, load_token
|
||||
from ..core import share
|
||||
from ..core.pty_session import PtySession
|
||||
from ..core.sampler import Sampler
|
||||
from ..core.sources import available_sources
|
||||
from .terminal_widget import TerminalView
|
||||
|
||||
|
||||
@@ -57,16 +55,13 @@ class SharePage(QWidget):
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._sampler = Sampler(available_sources())
|
||||
self._host_ws: QWebSocket | None = None
|
||||
self._guest_ws: QWebSocket | None = None
|
||||
self._pty: PtySession | None = None
|
||||
self._pty_notifier: QSocketNotifier | None = None
|
||||
self._last_report = None
|
||||
self._last_inv = None
|
||||
self._timer = QTimer(self)
|
||||
self._timer.setInterval(2000)
|
||||
self._timer.timeout.connect(self._stream)
|
||||
self._guest_can_type = False
|
||||
self._fs: QWidget | None = None
|
||||
self._fs_state = None
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
@@ -74,19 +69,19 @@ class SharePage(QWidget):
|
||||
title = QLabel("Share")
|
||||
title.setObjectName("PageTitle")
|
||||
root.addWidget(title)
|
||||
root.addWidget(self._build_host())
|
||||
root.addWidget(self._build_host(), 1)
|
||||
root.addWidget(self._build_guest(), 1)
|
||||
|
||||
# ------------------------------------------------------------------ host
|
||||
def _build_host(self) -> QFrame:
|
||||
card, v = _card("Start a shared session")
|
||||
self._host_status = QLabel("Let someone with an account view your machine, read-only.")
|
||||
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 shared session")
|
||||
self._start_btn = QPushButton("Start session")
|
||||
self._start_btn.setObjectName("PrimaryButton")
|
||||
self._start_btn.clicked.connect(self._start_host)
|
||||
self._stop_btn = QPushButton("Stop")
|
||||
@@ -95,28 +90,33 @@ class SharePage(QWidget):
|
||||
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_term = QCheckBox("Allow remote terminal — the guest runs commands as your user (you read along; you can type too, e.g. a sudo password)")
|
||||
self._allow_term.setStyleSheet("color:#fb923c; background:transparent;")
|
||||
self._allow_term.toggled.connect(self._toggle_terminal)
|
||||
v.addWidget(self._allow_term)
|
||||
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)
|
||||
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 Setup → Account access first.")
|
||||
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)
|
||||
@@ -135,37 +135,25 @@ class SharePage(QWidget):
|
||||
if data.get("error"):
|
||||
self._host_status.setText(f"Rejected: {data['error']}")
|
||||
return
|
||||
if "code" in data: # relay handshake
|
||||
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 view your machine.")
|
||||
self._host_status.setText(
|
||||
f"Sharing as {data.get('user', '?')} — give this code to whoever should connect.")
|
||||
self._stop_btn.setEnabled(True)
|
||||
self._host_ws.sendTextMessage(share.host_full_frame(self._sampler))
|
||||
self._send_terminal_state()
|
||||
if self._allow_term.isChecked():
|
||||
self._start_pty()
|
||||
self._timer.start()
|
||||
return
|
||||
kind = data.get("type") # frames forwarded from a guest
|
||||
if kind == "req_full":
|
||||
# A guest just joined — send a full frame AND the current terminal state, so a
|
||||
# guest that joins *after* the host enabled the terminal still gets access.
|
||||
self._host_ws.sendTextMessage(share.host_full_frame(self._sampler))
|
||||
self._send_terminal_state()
|
||||
elif kind == "pty_in" and self._pty:
|
||||
self._pty.write(base64.b64decode(data["data"]))
|
||||
elif kind == "pty_resize" and self._pty:
|
||||
self._pty.set_size(int(data["rows"]), int(data["cols"]))
|
||||
|
||||
def _toggle_terminal(self, on: bool) -> None:
|
||||
if on and self._host_ws and self._code_label.text():
|
||||
self._start_pty()
|
||||
elif not on:
|
||||
self._stop_pty()
|
||||
self._send_terminal_state()
|
||||
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_term.isChecked()}))
|
||||
self._host_ws.sendTextMessage(json.dumps({"type": "terminal", "enabled": self._allow_input.isChecked()}))
|
||||
|
||||
def _start_pty(self) -> None:
|
||||
if self._pty:
|
||||
@@ -176,15 +164,15 @@ class SharePage(QWidget):
|
||||
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 / EOF
|
||||
self._stop_pty()
|
||||
self._send_terminal_state()
|
||||
self._allow_term.setChecked(False)
|
||||
if not data: # shell exited
|
||||
self._stop_host()
|
||||
return
|
||||
self._host_term.feed(data)
|
||||
if self._host_ws:
|
||||
@@ -198,13 +186,9 @@ class SharePage(QWidget):
|
||||
self._pty.close()
|
||||
self._pty = None
|
||||
self._host_term.setVisible(False)
|
||||
|
||||
def _stream(self) -> None:
|
||||
if self._host_ws:
|
||||
self._host_ws.sendTextMessage(share.host_snapshot_frame(self._sampler))
|
||||
self._host_fs_btn.setEnabled(False)
|
||||
|
||||
def _stop_host(self) -> None:
|
||||
self._timer.stop()
|
||||
self._stop_pty()
|
||||
if self._host_ws:
|
||||
self._host_ws.close()
|
||||
@@ -215,7 +199,6 @@ class SharePage(QWidget):
|
||||
self._host_status.setText("Stopped sharing.")
|
||||
|
||||
def _host_closed(self) -> None:
|
||||
self._timer.stop()
|
||||
self._stop_pty()
|
||||
self._start_btn.setEnabled(True)
|
||||
self._stop_btn.setEnabled(False)
|
||||
@@ -225,7 +208,7 @@ class SharePage(QWidget):
|
||||
|
||||
# ----------------------------------------------------------------- guest
|
||||
def _build_guest(self) -> QFrame:
|
||||
card, v = _card("Join a shared session")
|
||||
card, v = _card("Join a terminal session")
|
||||
row = QHBoxLayout()
|
||||
self._code_input = QLineEdit()
|
||||
self._code_input.setPlaceholderText("Enter share code")
|
||||
@@ -237,37 +220,31 @@ class SharePage(QWidget):
|
||||
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._view = QTextEdit()
|
||||
self._view.setObjectName("Report")
|
||||
self._view.setReadOnly(True)
|
||||
self._view.setVisible(False)
|
||||
self._view.setMinimumHeight(200)
|
||||
v.addWidget(self._view)
|
||||
|
||||
self._term_label = QLabel("")
|
||||
self._term_label.setObjectName("Muted")
|
||||
self._term_label.setVisible(False)
|
||||
v.addWidget(self._term_label)
|
||||
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)
|
||||
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 Setup → Account access first.")
|
||||
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.")
|
||||
@@ -290,46 +267,40 @@ class SharePage(QWidget):
|
||||
self._guest_status.setText(data["error"])
|
||||
return
|
||||
if "joined" in data:
|
||||
self._guest_status.setText(f"Viewing {data.get('host', '?')}'s machine — read-only.")
|
||||
self._guest_status.setText(f"Connected to {data.get('host', '?')}'s terminal — watching.")
|
||||
self._leave_btn.setEnabled(True)
|
||||
self._view.setVisible(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 in ("full", "snapshot"):
|
||||
if kind == "full":
|
||||
self._last_report = data.get("report")
|
||||
self._last_inv = data.get("inventory")
|
||||
self._view.setHtml(share.guest_html(data.get("snapshot"), self._last_report, self._last_inv))
|
||||
elif kind == "terminal":
|
||||
self._set_terminal_visible(bool(data.get("enabled")))
|
||||
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 _set_terminal_visible(self, enabled: bool) -> None:
|
||||
self._term_label.setVisible(True)
|
||||
self._term_label.setText("Terminal enabled by host — your keystrokes run on their machine. Click here and type."
|
||||
if enabled else "Terminal not enabled by the host.")
|
||||
self._guest_term.setVisible(enabled)
|
||||
if enabled:
|
||||
self._guest_term.reset()
|
||||
self._guest_resize(*self._guest_term.grid())
|
||||
self._guest_term.setFocus()
|
||||
|
||||
def _guest_key(self, data: bytes) -> None:
|
||||
if self._guest_ws:
|
||||
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:
|
||||
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
|
||||
for w in (self._view, self._term_label, self._guest_term):
|
||||
w.setVisible(False)
|
||||
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.")
|
||||
@@ -337,11 +308,40 @@ class SharePage(QWidget):
|
||||
def _guest_closed(self) -> None:
|
||||
self._join_btn.setEnabled(True)
|
||||
self._leave_btn.setEnabled(False)
|
||||
if self._view.isVisible():
|
||||
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._timer.stop()
|
||||
self._stop_pty()
|
||||
for ws in (self._host_ws, self._guest_ws):
|
||||
if ws:
|
||||
|
||||
@@ -1,30 +1,66 @@
|
||||
"""A minimal terminal view: renders PTY output via pyte and emits keystrokes (M12, Tier 3).
|
||||
"""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). Monochrome for
|
||||
now; cursor addressing / layout (vim, top) work via pyte.
|
||||
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, QTextCursor
|
||||
from PySide6.QtWidgets import QPlainTextEdit
|
||||
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)
|
||||
|
||||
|
||||
class TerminalView(QPlainTextEdit):
|
||||
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(QPlainTextEdit.LineWrapMode.NoWrap)
|
||||
self.setLineWrapMode(QTextEdit.LineWrapMode.NoWrap)
|
||||
self.setFont(QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont))
|
||||
self.setUndoRedoEnabled(False)
|
||||
self.setMinimumHeight(260)
|
||||
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=1000, ratio=0.5)
|
||||
self._screen = pyte.HistoryScreen(cols, rows, history=2000, ratio=0.5)
|
||||
self._stream = pyte.ByteStream(self._screen)
|
||||
|
||||
def grid(self) -> tuple[int, int]:
|
||||
@@ -38,24 +74,51 @@ class TerminalView(QPlainTextEdit):
|
||||
self._screen.reset()
|
||||
self._render()
|
||||
|
||||
def _row_text(self, row) -> str:
|
||||
return "".join(row[x].data for x in range(self._cols)).rstrip()
|
||||
# --- 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 = [self._row_text(r) for r in self._screen.history.top] # scrollback
|
||||
self.setPlainText("\n".join(history + list(self._screen.display)))
|
||||
if at_bottom: # follow output; place caret at the real (row, col)
|
||||
cursor = self.textCursor()
|
||||
cursor.movePosition(QTextCursor.MoveOperation.Start)
|
||||
cursor.movePosition(QTextCursor.MoveOperation.Down, QTextCursor.MoveMode.MoveAnchor, len(history) + self._screen.cursor.y)
|
||||
cursor.movePosition(QTextCursor.MoveOperation.Right, QTextCursor.MoveMode.MoveAnchor, self._screen.cursor.x)
|
||||
self.setTextCursor(cursor)
|
||||
self.ensureCursorVisible()
|
||||
else: # user scrolled up to read — keep their place
|
||||
bar.setValue(prev)
|
||||
|
||||
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)
|
||||
|
||||
@@ -77,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 {{
|
||||
@@ -143,6 +144,24 @@ 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}; }}
|
||||
|
||||
@@ -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)
|
||||
@@ -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,101 @@
|
||||
"""Tests for the M14 AI assistant: provider selection, grounding, parsing (no network)."""
|
||||
|
||||
import unittest
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import ai, ai_knowledge
|
||||
|
||||
|
||||
class KnowledgeTests(unittest.TestCase):
|
||||
def test_matches_xid_and_smart(self):
|
||||
facts = ai_knowledge.relevant("Kernel: NVRM: Xid 79: GPU has fallen off the bus")
|
||||
self.assertTrue(any("fallen off the bus" in f for f in facts))
|
||||
|
||||
def test_matches_smart_pending(self):
|
||||
facts = ai_knowledge.relevant("SMART 197 Current_Pending_Sector = 8")
|
||||
self.assertTrue(any("Pending Sector" in f for f in facts))
|
||||
|
||||
def test_no_match_returns_empty(self):
|
||||
self.assertEqual(ai_knowledge.relevant("everything is fine"), [])
|
||||
|
||||
|
||||
class ConfigStateTests(unittest.TestCase):
|
||||
def _cfg(self, **over):
|
||||
base = {"ai_provider": "", "ai_model": "", "ai_endpoint": "http://localhost:11434"}
|
||||
base.update(over)
|
||||
return base
|
||||
|
||||
def test_unconfigured_by_default(self):
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg()):
|
||||
self.assertFalse(ai.is_configured())
|
||||
|
||||
def test_ollama_needs_model(self):
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg(ai_provider="ollama")):
|
||||
self.assertFalse(ai.is_configured())
|
||||
with mock.patch.object(ai.config, "load_config",
|
||||
return_value=self._cfg(ai_provider="ollama", ai_model="llama3.1")):
|
||||
self.assertTrue(ai.is_configured())
|
||||
|
||||
def test_claude_needs_key(self):
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg(ai_provider="claude")), \
|
||||
mock.patch.object(ai.config, "load_ai_key", return_value=None):
|
||||
self.assertFalse(ai.is_configured())
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg(ai_provider="claude")), \
|
||||
mock.patch.object(ai.config, "load_ai_key", return_value="sk-ant-x"):
|
||||
self.assertTrue(ai.is_configured())
|
||||
|
||||
def test_claude_default_model(self):
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg(ai_provider="claude")):
|
||||
self.assertEqual(ai.model(), ai.CLAUDE_DEFAULT_MODEL)
|
||||
|
||||
|
||||
class PromptTests(unittest.TestCase):
|
||||
def test_build_prompt_includes_facts_and_findings(self):
|
||||
prompt = ai.build_prompt("Xid 79: GPU has fallen off the bus")
|
||||
self.assertIn("Reference facts", prompt)
|
||||
self.assertIn("Collected findings", prompt)
|
||||
self.assertIn("fallen off the bus", prompt)
|
||||
|
||||
def test_format_findings(self):
|
||||
class F:
|
||||
severity, category, title, detail = "warn", "GPU", "Hot", "92C"
|
||||
text = ai.format_findings([F()])
|
||||
self.assertIn("[WARN] GPU: Hot — 92C", text)
|
||||
|
||||
|
||||
class ExplainTests(unittest.TestCase):
|
||||
def _cfg(self, **over):
|
||||
base = {"ai_provider": "", "ai_model": "", "ai_endpoint": "http://localhost:11434"}
|
||||
base.update(over)
|
||||
return base
|
||||
|
||||
def test_no_provider(self):
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg()):
|
||||
ok, msg = ai.explain("x")
|
||||
self.assertFalse(ok)
|
||||
self.assertIn("No AI provider", msg)
|
||||
|
||||
def test_ollama_parses_response(self):
|
||||
with mock.patch.object(ai.config, "load_config",
|
||||
return_value=self._cfg(ai_provider="ollama", ai_model="llama3.1")), \
|
||||
mock.patch.object(ai, "_post", return_value={"response": "It's the PSU."}) as post:
|
||||
ok, msg = ai.explain("Xid 79")
|
||||
self.assertTrue(ok)
|
||||
self.assertEqual(msg, "It's the PSU.")
|
||||
self.assertIn("/api/generate", post.call_args[0][0])
|
||||
|
||||
def test_claude_parses_content_blocks(self):
|
||||
with mock.patch.object(ai.config, "load_config", return_value=self._cfg(ai_provider="claude")), \
|
||||
mock.patch.object(ai.config, "load_ai_key", return_value="sk-ant-x"), \
|
||||
mock.patch.object(ai, "_post", return_value={"content": [
|
||||
{"type": "text", "text": "Likely a failing disk."}]}) as post:
|
||||
ok, msg = ai.explain("SMART 197")
|
||||
self.assertTrue(ok)
|
||||
self.assertEqual(msg, "Likely a failing disk.")
|
||||
headers = post.call_args[0][2]
|
||||
self.assertEqual(headers["anthropic-version"], ai.ANTHROPIC_VERSION)
|
||||
self.assertEqual(headers["x-api-key"], "sk-ant-x")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
@@ -0,0 +1,49 @@
|
||||
"""Tests for M14 game/Proton/Steam log collection."""
|
||||
|
||||
import tempfile
|
||||
import unittest
|
||||
from pathlib import Path
|
||||
from unittest import mock
|
||||
|
||||
from rigdoctor.core import gamelogs
|
||||
|
||||
|
||||
class TailTests(unittest.TestCase):
|
||||
def test_tail_returns_last_bytes(self):
|
||||
path = Path(tempfile.mkdtemp()) / "x.log"
|
||||
path.write_text("A" * 100 + "TAIL")
|
||||
out = gamelogs._tail(path, 4)
|
||||
self.assertEqual(out, "TAIL")
|
||||
|
||||
def test_tail_short_file(self):
|
||||
path = Path(tempfile.mkdtemp()) / "x.log"
|
||||
path.write_text("short")
|
||||
self.assertEqual(gamelogs._tail(path, 9999), "short")
|
||||
|
||||
def test_tail_missing(self):
|
||||
self.assertEqual(gamelogs._tail(Path("/nope/x.log"), 10), "")
|
||||
|
||||
|
||||
class CollectTests(unittest.TestCase):
|
||||
def test_collect_includes_proton_and_steam(self):
|
||||
tmp = Path(tempfile.mkdtemp())
|
||||
proton = tmp / "steam-570.log"
|
||||
proton.write_text("err: vkd3d device lost")
|
||||
console = tmp / "console-linux.txt"
|
||||
console.write_text("Game removed AppID 570 ... exit")
|
||||
with mock.patch.object(gamelogs, "_proton_logs", return_value=[proton]), \
|
||||
mock.patch.object(gamelogs, "_steam_console", return_value=console):
|
||||
out = gamelogs.collect()
|
||||
self.assertIn("Proton log", out)
|
||||
self.assertIn("vkd3d", out)
|
||||
self.assertIn("Steam log", out)
|
||||
self.assertIn("exit", out)
|
||||
|
||||
def test_collect_empty_when_none(self):
|
||||
with mock.patch.object(gamelogs, "_proton_logs", return_value=[]), \
|
||||
mock.patch.object(gamelogs, "_steam_console", return_value=None):
|
||||
self.assertEqual(gamelogs.collect(), "")
|
||||
|
||||
|
||||
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()
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core import installer
|
||||
from rigdoctor.core import catalog, installer
|
||||
from rigdoctor.core.catalog import Component
|
||||
from rigdoctor.core.updates import is_newer
|
||||
|
||||
@@ -31,6 +31,13 @@ class InstallerTests(unittest.TestCase):
|
||||
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):
|
||||
|
||||
@@ -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()
|
||||
@@ -1,38 +0,0 @@
|
||||
"""Tests for M12 relay frames + guest HTML rendering (host/guest data shapes)."""
|
||||
|
||||
import json
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core import share
|
||||
from rigdoctor.core.sampler import Sampler
|
||||
from rigdoctor.core.sources import available_sources
|
||||
|
||||
|
||||
class RelayFrameTests(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.sampler = Sampler(available_sources())
|
||||
|
||||
def test_full_frame_shape(self):
|
||||
frame = json.loads(share.host_full_frame(self.sampler))
|
||||
self.assertEqual(frame["type"], "full")
|
||||
self.assertIn("groups", frame["snapshot"])
|
||||
self.assertIsInstance(frame["report"], list)
|
||||
self.assertIsInstance(frame["inventory"], dict)
|
||||
|
||||
def test_snapshot_frame_shape(self):
|
||||
frame = json.loads(share.host_snapshot_frame(self.sampler))
|
||||
self.assertEqual(frame["type"], "snapshot")
|
||||
self.assertIn("groups", frame["snapshot"])
|
||||
|
||||
def test_guest_html_renders(self):
|
||||
snap = {"groups": {"gpu": [{"name": "temp", "value": 51.0, "unit": "°C"}]}}
|
||||
report = [{"severity": "ok", "category": "Logs", "title": "No errors"}]
|
||||
inv = {"System": {"Kernel": "7.0.0"}}
|
||||
html = share.guest_html(snap, report, inv)
|
||||
self.assertIn("51.0 °C", html)
|
||||
self.assertIn("No errors", html)
|
||||
self.assertIn("Kernel", html)
|
||||
|
||||
|
||||
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()
|
||||
@@ -1,46 +0,0 @@
|
||||
"""Tests for M12 Tier 2 share server: token gating + endpoints."""
|
||||
|
||||
import json
|
||||
import threading
|
||||
import unittest
|
||||
import urllib.error
|
||||
import urllib.request
|
||||
|
||||
from rigdoctor.core import share
|
||||
|
||||
|
||||
class ShareServerTests(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.srv, self.token = share.make_server("127.0.0.1", 0)
|
||||
self.port = self.srv.server_address[1]
|
||||
self.thread = threading.Thread(target=self.srv.serve_forever, daemon=True)
|
||||
self.thread.start()
|
||||
|
||||
def tearDown(self):
|
||||
self.srv.shutdown()
|
||||
|
||||
def _url(self, path, token=None):
|
||||
q = f"?t={token}" if token else ""
|
||||
return f"http://127.0.0.1:{self.port}{path}{q}"
|
||||
|
||||
def test_requires_token(self):
|
||||
with self.assertRaises(urllib.error.HTTPError) as cm:
|
||||
urllib.request.urlopen(self._url("/api/snapshot"), timeout=10)
|
||||
self.assertEqual(cm.exception.code, 403)
|
||||
|
||||
def test_bad_token_rejected(self):
|
||||
with self.assertRaises(urllib.error.HTTPError) as cm:
|
||||
urllib.request.urlopen(self._url("/api/snapshot", "wrong"), timeout=10)
|
||||
self.assertEqual(cm.exception.code, 403)
|
||||
|
||||
def test_snapshot_with_token(self):
|
||||
data = json.load(urllib.request.urlopen(self._url("/api/snapshot", self.token), timeout=10))
|
||||
self.assertIn("groups", data)
|
||||
|
||||
def test_page_served(self):
|
||||
body = urllib.request.urlopen(self._url("/", self.token), timeout=10).read()
|
||||
self.assertIn(b"read-only share", body)
|
||||
|
||||
|
||||
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()
|
||||
Reference in New Issue
Block a user