mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-09 03:11:58 +00:00
Hermes gateway now installs as a real Windows service via
`hermes gateway install`, auto-starts on user logon, and stays running
across reboots. Mirrors the launchd (macOS) / systemd (Linux) contract
so the rest of the CLI dispatcher just plugs into the same `install /
uninstall / start / stop / restart / status` entrypoints.
Primary implementation is the new `hermes_cli/gateway_windows.py`:
- `schtasks /Create /SC ONLOGON /RL LIMITED /RU <user> /NP /IT` creates
a per-user Scheduled Task running as the current user at next logon,
with no UAC prompt and no stored password. Same pattern OpenClaw uses.
- When `schtasks /Create` returns "Access is denied" or times out
(locked-down corporate boxes, 15s/30s hard + no-output cutoffs),
fall back to writing a `.cmd` file into
`%APPDATA%\Microsoft\Windows\Start Menu\Programs\Startup\`, which
Windows Explorer fires at every logon. Either path produces the same
end-user experience.
- `_spawn_detached()` launches `pythonw.exe -m hermes_cli.main gateway
run --replace` directly with `DETACHED_PROCESS |
CREATE_NEW_PROCESS_GROUP | CREATE_NO_WINDOW |
CREATE_BREAKAWAY_FROM_JOB` + DEVNULL stdio + sidecar
`logs/gateway-stdio.log`. Going through pythonw.exe (no console)
instead of a cmd.exe shim is what lets the gateway survive the
spawning shell's exit on Windows — documented in
`references/windows-subprocess-sigint-storm.md`.
- Two separate quoting helpers for cmd.exe vs schtasks (`/TR` argument)
— they're different parsers and mixing breaks both. Same split
OpenClaw documents in src/daemon/schtasks.ts.
- `_wait_for_gateway_ready()` + `_report_gateway_start()` poll for a
live gateway process after spawn and report the PID, so install
doesn't lie about success.
Dispatcher wiring in `hermes_cli/gateway.py`:
- `_gateway_command_inner()` gets Windows branches for install /
uninstall / start / stop / restart / status + `_is_service_installed`
+ `_is_service_running`. `gateway status` output + suggested
commands now mention `hermes gateway install` instead of
`sudo hermes gateway install --system` on Windows.
Two separable Windows fixes that only matter for a working
detached gateway, bundled here because shipping them independently
leaves install broken:
(1) Spurious CTRL_C_EVENT on detached pythonw runs. When the gateway
is launched detached on Windows, something on the boot path (HTTPX /
python-telegram-bot / asyncio ProactorEventLoop subprocess plumbing)
synthesizes a Ctrl+C within ~60-90 seconds. Python 3.11 translates it
into KeyboardInterrupt inside `asyncio.run(start_gateway(...))`, the
outer `except KeyboardInterrupt: return` exits cleanly, and the
process dies with no shutdown log — "bot started typing, then
stopped" is the fingerprint because the interrupt fires mid-send.
Fix in `run_gateway()`: when `is_windows()` and stdin is not a TTY,
install `signal.signal(SIGINT, SIG_IGN)` + same for SIGBREAK. Real
console runs have a TTY and skip the absorber, so user Ctrl+C still
works interactively. Same family as commit 449ad952b's browser-tool
SIGINT absorber; cross-referenced in the ref doc.
(2) `wmic process get` is the process-list path used by
`_scan_gateway_pids()` / `find_gateway_pids()`, which power status,
stop, and restart on Windows. `C:\Windows\System32\wbem\WMIC.exe` has
been deprecated since Windows 10 21H1 and is not installed on modern
Win 10/11 boxes, so `find_gateway_pids()` silently returns [] — status
sees no gateway even when one is running. Fix: `shutil.which("wmic")`
first, fall back to PowerShell's `Get-CimInstance Win32_Process`
emitting the same LIST-style `CommandLine=...` / `ProcessId=...` pairs
the downstream parser already handles. Zero behavior change on boxes
where wmic still works.
Verified end-to-end on Windows 10 (Delta-1):
- `hermes gateway install` → falls back to Startup folder (access
denied on schtasks for this user) + detached pythonw spawn, PID
reported correctly.
- Gateway connects to Telegram, answers messages, stays alive past
2min (previously died at ~85s with no shutdown log).
- `hermes gateway stop` + `uninstall` both clean up both tracks.
Refs: openclaw/openclaw src/daemon/schtasks.ts for the ONLOGON +
startup-folder-fallback pattern. skill hermes-agent
references/windows-subprocess-sigint-storm.md for the deeper
CTRL_C_EVENT / ProactorEventLoop background.
689 lines
26 KiB
Python
689 lines
26 KiB
Python
"""Windows gateway service backend (Scheduled Task + Startup-folder fallback).
|
|
|
|
This mirrors the contract exposed by ``launchd_install`` / ``launchd_start`` /
|
|
``launchd_status`` etc. on macOS and ``systemd_install`` / ``systemd_start`` on
|
|
Linux. It uses ``schtasks`` under the hood with ``/SC ONLOGON`` and restart-on-
|
|
failure XML settings, and falls back to a ``%APPDATA%\\...\\Startup\\<name>.cmd``
|
|
dropper when Scheduled Task creation is denied (locked-down corporate boxes).
|
|
|
|
Design notes
|
|
------------
|
|
* ``schtasks /Create /SC ONLOGON /RL LIMITED`` means the task runs at the
|
|
CURRENT USER's next logon without any elevation prompt. We also
|
|
``schtasks /Run`` immediately after install so the gateway starts right
|
|
away without waiting for the next logon.
|
|
* We write two files: a shared ``gateway.cmd`` wrapper script (cwd + env + the
|
|
actual ``python -m hermes_cli.main gateway run --replace`` invocation) and
|
|
EITHER a schtasks entry pointing at it OR a Startup-folder ``.cmd`` that
|
|
spawns it detached.
|
|
* Status = merge of "is the schtasks entry registered?" + "is the startup
|
|
.cmd present?" + "is there a gateway process running?" so the status
|
|
command keeps working regardless of which install path was taken.
|
|
* Quoting is tricky: schtasks parses ``/TR`` itself and cmd.exe parses the
|
|
generated ``gateway.cmd``. Those are DIFFERENT parsers. We keep two
|
|
separate quote helpers (same pattern OpenClaw uses) and never cross them.
|
|
* All of this is Windows-only. ``import`` paths are still safe on POSIX but
|
|
the functions raise if called on non-Windows.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import re
|
|
import shlex
|
|
import shutil
|
|
import subprocess
|
|
import sys
|
|
import time
|
|
from pathlib import Path
|
|
|
|
# Short timeouts: schtasks occasionally wedges and we don't want to hang forever.
|
|
_SCHTASKS_TIMEOUT_S = 15
|
|
_SCHTASKS_NO_OUTPUT_TIMEOUT_S = 30
|
|
# Patterns in schtasks stderr that mean "fall back to the Startup folder".
|
|
_FALLBACK_PATTERNS = re.compile(
|
|
r"(access is denied|acceso denegado|schtasks timed out|schtasks produced no output)",
|
|
re.IGNORECASE,
|
|
)
|
|
|
|
_TASK_NAME_DEFAULT = "Hermes_Gateway"
|
|
_TASK_DESCRIPTION = "Hermes Agent Gateway - Messaging Platform Integration"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Platform guard
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _assert_windows() -> None:
|
|
if sys.platform != "win32":
|
|
raise RuntimeError("gateway_windows is Windows-only")
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Quoting helpers (two DIFFERENT parsers — do not mix)
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _quote_cmd_script_arg(value: str) -> str:
|
|
"""Quote a single argument for use INSIDE a .cmd file, for cmd.exe parsing.
|
|
|
|
cmd.exe splits on spaces/tabs outside of double quotes. Embedded quotes
|
|
are doubled. We also refuse line breaks because they'd terminate the
|
|
logical command line mid-script.
|
|
"""
|
|
if "\r" in value or "\n" in value:
|
|
raise ValueError(f"refusing to quote value containing newline: {value!r}")
|
|
if not value:
|
|
return '""'
|
|
if not re.search(r'[ \t"]', value):
|
|
return value
|
|
return '"' + value.replace('"', '""') + '"'
|
|
|
|
|
|
def _quote_schtasks_arg(value: str) -> str:
|
|
"""Quote a single argument for schtasks.exe's /TR parser.
|
|
|
|
Schtasks uses a different quoting convention than cmd.exe: embedded
|
|
quotes are backslash-escaped, and the whole thing is wrapped in double
|
|
quotes if it contains whitespace or quotes.
|
|
"""
|
|
if not re.search(r'[ \t"]', value):
|
|
return value
|
|
return '"' + value.replace('"', '\\"') + '"'
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# schtasks.exe wrapper
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _exec_schtasks(args: list[str]) -> tuple[int, str, str]:
|
|
"""Run ``schtasks.exe`` with a hard timeout. Return (code, stdout, stderr).
|
|
|
|
If schtasks wedges, returns code=124 with a synthetic stderr string —
|
|
same convention OpenClaw uses, so the fallback detection regex matches.
|
|
"""
|
|
_assert_windows()
|
|
schtasks = shutil.which("schtasks")
|
|
if schtasks is None:
|
|
return (1, "", "schtasks.exe not found on PATH")
|
|
try:
|
|
proc = subprocess.run(
|
|
[schtasks, *args],
|
|
capture_output=True,
|
|
text=True,
|
|
timeout=_SCHTASKS_TIMEOUT_S,
|
|
# CREATE_NO_WINDOW avoids a flashing console window when the CLI
|
|
# is itself hosted in a TUI. See tools/browser_tool.py for the
|
|
# same pattern and the windows-subprocess-sigint-storm.md ref.
|
|
creationflags=0x08000000, # CREATE_NO_WINDOW
|
|
)
|
|
return (proc.returncode, proc.stdout or "", proc.stderr or "")
|
|
except subprocess.TimeoutExpired:
|
|
return (124, "", f"schtasks timed out after {_SCHTASKS_TIMEOUT_S}s")
|
|
except OSError as e:
|
|
return (1, "", f"schtasks invocation failed: {e}")
|
|
|
|
|
|
def _should_fall_back(code: int, detail: str) -> bool:
|
|
return code == 124 or bool(_FALLBACK_PATTERNS.search(detail or ""))
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Paths: where we stash our task script and where Startup lives
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def get_task_name() -> str:
|
|
"""Scheduled Task name, scoped per profile.
|
|
|
|
Default profile: ``Hermes_Gateway``
|
|
Named profile X: ``Hermes_Gateway_<X>``
|
|
"""
|
|
_assert_windows()
|
|
# Local import to avoid circular module initialization during hermes_cli boot.
|
|
from hermes_cli.gateway import _profile_suffix
|
|
|
|
suffix = _profile_suffix()
|
|
if not suffix:
|
|
return _TASK_NAME_DEFAULT
|
|
return f"{_TASK_NAME_DEFAULT}_{suffix}"
|
|
|
|
|
|
def _sanitize_filename(value: str) -> str:
|
|
"""Remove characters illegal in Windows filenames."""
|
|
return re.sub(r'[<>:"/\\|?*\x00-\x1f]', "_", value)
|
|
|
|
|
|
def get_task_script_path() -> Path:
|
|
"""The generated ``gateway.cmd`` wrapper that the schtasks entry invokes.
|
|
|
|
Lives under ``%LOCALAPPDATA%\\hermes\\gateway-service\\<task_name>.cmd``
|
|
(or ``<HERMES_HOME>/gateway-service/<task_name>.cmd`` so per-profile
|
|
Hermes installs stay self-contained).
|
|
"""
|
|
_assert_windows()
|
|
from hermes_cli.config import get_hermes_home
|
|
|
|
script_dir = Path(get_hermes_home()) / "gateway-service"
|
|
script_dir.mkdir(parents=True, exist_ok=True)
|
|
return script_dir / f"{_sanitize_filename(get_task_name())}.cmd"
|
|
|
|
|
|
def _startup_dir() -> Path:
|
|
appdata = os.environ.get("APPDATA", "").strip()
|
|
if appdata:
|
|
return Path(appdata) / "Microsoft" / "Windows" / "Start Menu" / "Programs" / "Startup"
|
|
userprofile = os.environ.get("USERPROFILE", "").strip() or os.environ.get("HOME", "").strip()
|
|
if not userprofile:
|
|
raise RuntimeError("neither APPDATA nor USERPROFILE is set — cannot resolve Startup folder")
|
|
return (
|
|
Path(userprofile)
|
|
/ "AppData"
|
|
/ "Roaming"
|
|
/ "Microsoft"
|
|
/ "Windows"
|
|
/ "Start Menu"
|
|
/ "Programs"
|
|
/ "Startup"
|
|
)
|
|
|
|
|
|
def get_startup_entry_path() -> Path:
|
|
_assert_windows()
|
|
return _startup_dir() / f"{_sanitize_filename(get_task_name())}.cmd"
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Script rendering
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _build_gateway_cmd_script(
|
|
python_path: str,
|
|
working_dir: str,
|
|
hermes_home: str,
|
|
profile_arg: str,
|
|
) -> str:
|
|
"""Build the ``gateway.cmd`` wrapper content (CRLF-terminated).
|
|
|
|
The script:
|
|
- cd's into the project directory
|
|
- exports HERMES_HOME, PYTHONIOENCODING, VIRTUAL_ENV
|
|
- invokes ``python -m hermes_cli.main [--profile X] gateway run --replace``
|
|
|
|
We intentionally do NOT inline PATH overrides here — cmd.exe inherits
|
|
the per-user PATH the Scheduled Task was created with, and forcibly
|
|
rewriting PATH tends to break Homebrew/nvm-style installations.
|
|
"""
|
|
lines = ["@echo off", f"rem {_TASK_DESCRIPTION}"]
|
|
lines.append(f"cd /d {_quote_cmd_script_arg(working_dir)}")
|
|
lines.append(f'set "HERMES_HOME={hermes_home}"')
|
|
lines.append('set "PYTHONIOENCODING=utf-8"')
|
|
# VIRTUAL_ENV lets the gateway's own python detection find the venv
|
|
# if someone imports hermes_constants-based logic during startup.
|
|
venv_dir = str(Path(python_path).resolve().parent.parent)
|
|
lines.append(f'set "VIRTUAL_ENV={venv_dir}"')
|
|
|
|
prog_args = [python_path, "-m", "hermes_cli.main"]
|
|
if profile_arg:
|
|
prog_args.extend(profile_arg.split())
|
|
prog_args.extend(["gateway", "run", "--replace"])
|
|
lines.append(" ".join(_quote_cmd_script_arg(a) for a in prog_args))
|
|
return "\r\n".join(lines) + "\r\n"
|
|
|
|
|
|
def _build_startup_launcher(script_path: Path) -> str:
|
|
"""The tiny .cmd that goes in the Startup folder. Just minimizes and chains."""
|
|
lines = [
|
|
"@echo off",
|
|
f"rem {_TASK_DESCRIPTION}",
|
|
# ``start "" /min`` detaches with a minimized console window.
|
|
# ``/d /c`` on cmd.exe skips AUTORUN and runs the target script once.
|
|
f'start "" /min cmd.exe /d /c {_quote_cmd_script_arg(str(script_path))}',
|
|
]
|
|
return "\r\n".join(lines) + "\r\n"
|
|
|
|
|
|
def _write_task_script() -> Path:
|
|
"""Generate and write the gateway.cmd wrapper. Return its absolute path."""
|
|
_assert_windows()
|
|
# Local imports to avoid circular-init at module load time.
|
|
from hermes_cli.config import get_hermes_home
|
|
from hermes_cli.gateway import (
|
|
PROJECT_ROOT,
|
|
_profile_arg,
|
|
get_python_path,
|
|
)
|
|
|
|
python_path = get_python_path()
|
|
working_dir = str(PROJECT_ROOT)
|
|
hermes_home = str(Path(get_hermes_home()).resolve())
|
|
profile_arg = _profile_arg(hermes_home)
|
|
|
|
content = _build_gateway_cmd_script(python_path, working_dir, hermes_home, profile_arg)
|
|
script_path = get_task_script_path()
|
|
script_path.write_text(content, encoding="utf-8", newline="")
|
|
return script_path
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Install / uninstall
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def _resolve_task_user() -> str | None:
|
|
"""Return ``DOMAIN\\USER`` if available, else bare USERNAME, else None."""
|
|
username = os.environ.get("USERNAME") or os.environ.get("USER") or os.environ.get("LOGNAME")
|
|
if not username:
|
|
return None
|
|
if "\\" in username:
|
|
return username
|
|
domain = os.environ.get("USERDOMAIN")
|
|
return f"{domain}\\{username}" if domain else username
|
|
|
|
|
|
def _install_scheduled_task(task_name: str, script_path: Path) -> tuple[bool, str]:
|
|
"""Create or update the Scheduled Task. Returns (success, detail)."""
|
|
quoted_script = _quote_schtasks_arg(str(script_path))
|
|
# First try /Change in case the task already exists — keeps the existing
|
|
# trigger + settings intact and just repoints /TR.
|
|
change_code, _out, change_err = _exec_schtasks(
|
|
["/Change", "/TN", task_name, "/TR", quoted_script]
|
|
)
|
|
if change_code == 0:
|
|
return (True, f"Updated existing Scheduled Task {task_name!r}")
|
|
|
|
# Create fresh. Start with the "current user, interactive, no stored
|
|
# password" variant; if that fails, retry without /RU /NP /IT.
|
|
base = [
|
|
"/Create",
|
|
"/F",
|
|
"/SC",
|
|
"ONLOGON",
|
|
"/RL",
|
|
"LIMITED",
|
|
"/TN",
|
|
task_name,
|
|
"/TR",
|
|
quoted_script,
|
|
]
|
|
user = _resolve_task_user()
|
|
variants = []
|
|
if user:
|
|
variants.append([*base, "/RU", user, "/NP", "/IT"])
|
|
variants.append(base)
|
|
|
|
last_code = 1
|
|
last_err = ""
|
|
for argv in variants:
|
|
code, out, err = _exec_schtasks(argv)
|
|
if code == 0:
|
|
return (True, f"Created Scheduled Task {task_name!r}")
|
|
last_code, last_err = code, (err or out or "")
|
|
return (False, f"schtasks /Create failed (code {last_code}): {last_err.strip()}")
|
|
|
|
|
|
def _install_startup_entry(script_path: Path) -> Path:
|
|
"""Write the Startup-folder fallback launcher. Returns its path."""
|
|
entry = get_startup_entry_path()
|
|
entry.parent.mkdir(parents=True, exist_ok=True)
|
|
entry.write_text(_build_startup_launcher(script_path), encoding="utf-8", newline="")
|
|
return entry
|
|
|
|
|
|
def _derive_venv_pythonw(python_exe: str) -> str:
|
|
"""Given a ``python.exe`` path, return the sibling ``pythonw.exe`` if present.
|
|
|
|
``pythonw.exe`` is the console-less variant. Using it for detached
|
|
daemons means there's no console handle to inherit from the spawning
|
|
shell, which is what lets the gateway survive a parent-shell exit on
|
|
Windows. Falls back to the original ``python.exe`` if the ``w`` variant
|
|
isn't there — caller must still set CREATE_NO_WINDOW in that case.
|
|
"""
|
|
p = Path(python_exe)
|
|
candidate = p.with_name(p.stem + "w" + p.suffix)
|
|
if candidate.exists():
|
|
return str(candidate)
|
|
return python_exe
|
|
|
|
|
|
def _build_gateway_argv() -> tuple[list[str], str, dict[str, str]]:
|
|
"""Build (argv, working_dir, env_overlay) for the gateway subprocess.
|
|
|
|
Same logical command as what gateway.cmd runs, but assembled as a
|
|
native argv for direct ``subprocess.Popen`` invocation — no cmd.exe
|
|
layer in between.
|
|
"""
|
|
_assert_windows()
|
|
from hermes_cli.config import get_hermes_home
|
|
from hermes_cli.gateway import (
|
|
PROJECT_ROOT,
|
|
_profile_arg,
|
|
get_python_path,
|
|
)
|
|
|
|
python_exe = _derive_venv_pythonw(get_python_path())
|
|
working_dir = str(PROJECT_ROOT)
|
|
hermes_home = str(Path(get_hermes_home()).resolve())
|
|
profile_arg = _profile_arg(hermes_home)
|
|
|
|
argv = [python_exe, "-m", "hermes_cli.main"]
|
|
if profile_arg:
|
|
argv.extend(profile_arg.split())
|
|
argv.extend(["gateway", "run", "--replace"])
|
|
|
|
env_overlay = {
|
|
"HERMES_HOME": hermes_home,
|
|
"PYTHONIOENCODING": "utf-8",
|
|
"VIRTUAL_ENV": str(Path(python_exe).resolve().parent.parent),
|
|
}
|
|
return argv, working_dir, env_overlay
|
|
|
|
|
|
def _spawn_detached(script_path: Path | None = None) -> int:
|
|
"""Launch the gateway as a fully detached background process.
|
|
|
|
We spawn ``pythonw.exe -m hermes_cli.main gateway run --replace``
|
|
directly — NOT through a cmd.exe shim — because on Windows a cmd.exe
|
|
child inherits the parent session's console handle and tends to get
|
|
reaped when the spawning shell exits. pythonw.exe has no console, and
|
|
combined with DETACHED_PROCESS | CREATE_NEW_PROCESS_GROUP |
|
|
CREATE_NO_WINDOW + DEVNULL stdio + a fresh env, the resulting process
|
|
is independent of whichever shell started it.
|
|
|
|
Arg ``script_path`` is accepted for API symmetry with older callers
|
|
but ignored — we don't need it now that we go direct.
|
|
|
|
Returns the spawned PID so callers can verify the process actually
|
|
came up.
|
|
"""
|
|
_assert_windows()
|
|
argv, working_dir, env_overlay = _build_gateway_argv()
|
|
|
|
# Inherit PATH etc. from the current env, overlay our required vars.
|
|
env = {**os.environ, **env_overlay}
|
|
|
|
# DETACHED_PROCESS 0x00000008 — no console attached to child
|
|
# CREATE_NEW_PROCESS_GROUP 0x00000200 — child gets its own group, won't
|
|
# receive Ctrl+C from our group
|
|
# CREATE_NO_WINDOW 0x08000000 — belt-and-braces no-console flag
|
|
# CREATE_BREAKAWAY_FROM_JOB 0x01000000 — escape any job object the
|
|
# parent is in (prevents parent-
|
|
# job teardown from reaping us;
|
|
# some Windows Terminal versions
|
|
# wrap their children in a job).
|
|
flags = 0x00000008 | 0x00000200 | 0x08000000 | 0x01000000
|
|
|
|
# Redirect any stray stdout/stderr output to a sidecar log. Python's
|
|
# logging module writes to gateway.log through a FileHandler, so the
|
|
# real gateway logs still land there — this just captures anything
|
|
# that goes to print() or native stderr.
|
|
from hermes_cli.config import get_hermes_home
|
|
|
|
log_dir = Path(get_hermes_home()) / "logs"
|
|
log_dir.mkdir(parents=True, exist_ok=True)
|
|
stray_log = log_dir / "gateway-stdio.log"
|
|
|
|
try:
|
|
with open(stray_log, "ab", buffering=0) as log_fh:
|
|
proc = subprocess.Popen(
|
|
argv,
|
|
cwd=working_dir,
|
|
env=env,
|
|
creationflags=flags,
|
|
close_fds=True,
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=log_fh,
|
|
stderr=log_fh,
|
|
)
|
|
except OSError:
|
|
# CREATE_BREAKAWAY_FROM_JOB can fail with "access denied" when the
|
|
# parent's job object doesn't permit breakaway (some Windows
|
|
# Terminal configs). Retry without the breakaway flag — in most
|
|
# setups pythonw.exe + DETACHED_PROCESS is enough on its own.
|
|
flags_no_breakaway = flags & ~0x01000000
|
|
with open(stray_log, "ab", buffering=0) as log_fh:
|
|
proc = subprocess.Popen(
|
|
argv,
|
|
cwd=working_dir,
|
|
env=env,
|
|
creationflags=flags_no_breakaway,
|
|
close_fds=True,
|
|
stdin=subprocess.DEVNULL,
|
|
stdout=log_fh,
|
|
stderr=log_fh,
|
|
)
|
|
return proc.pid
|
|
|
|
|
|
def install(force: bool = False) -> None:
|
|
"""Install the gateway as a Windows Scheduled Task (with Startup fallback).
|
|
|
|
Idempotent: re-running updates the task to point at the current python/
|
|
project paths. ``force`` is accepted for API parity with ``launchd_install``
|
|
/ ``systemd_install`` but isn't needed — we always reconcile.
|
|
"""
|
|
_assert_windows()
|
|
task_name = get_task_name()
|
|
script_path = _write_task_script()
|
|
|
|
ok, detail = _install_scheduled_task(task_name, script_path)
|
|
if ok:
|
|
print(f"✓ {detail}")
|
|
print(f" Task script: {script_path}")
|
|
# Start it now so the user doesn't have to log off/on.
|
|
run_code, _out, run_err = _exec_schtasks(["/Run", "/TN", task_name])
|
|
if run_code == 0:
|
|
_report_gateway_start("Scheduled Task")
|
|
else:
|
|
# Scheduled Task was created but /Run failed (e.g. the task's
|
|
# action is malformed). Spawn directly as a backstop.
|
|
pid = _spawn_detached(script_path)
|
|
_report_gateway_start(
|
|
f"direct spawn (PID {pid}; schtasks /Run said: {run_err.strip()})"
|
|
)
|
|
_print_next_steps()
|
|
return
|
|
|
|
# schtasks create didn't work. See if it's a "fall back to startup" case.
|
|
if _should_fall_back(1, detail):
|
|
print(f"↻ Scheduled Task install blocked ({detail.splitlines()[0]}) — using Startup folder fallback")
|
|
entry = _install_startup_entry(script_path)
|
|
pid = _spawn_detached(script_path)
|
|
print(f"✓ Installed Windows login item: {entry}")
|
|
print(f" Task script: {script_path}")
|
|
_report_gateway_start(f"direct spawn (PID {pid})")
|
|
_print_next_steps()
|
|
return
|
|
|
|
# Unknown schtasks error — surface it and bail.
|
|
raise RuntimeError(f"Windows gateway install failed: {detail}")
|
|
|
|
|
|
def _wait_for_gateway_ready(timeout_s: float = 6.0, interval_s: float = 0.4) -> list[int]:
|
|
"""Poll for a live gateway process for up to ``timeout_s`` seconds.
|
|
|
|
Returns the list of PIDs found. Empty list means nothing came up in
|
|
time — the caller should surface that to the user as a failed start.
|
|
"""
|
|
from hermes_cli.gateway import find_gateway_pids
|
|
|
|
deadline = time.time() + timeout_s
|
|
while time.time() < deadline:
|
|
pids = list(find_gateway_pids())
|
|
if pids:
|
|
return pids
|
|
time.sleep(interval_s)
|
|
return []
|
|
|
|
|
|
def _report_gateway_start(via: str) -> None:
|
|
pids = _wait_for_gateway_ready()
|
|
if pids:
|
|
print(f"✓ Gateway started via {via} (PID: {', '.join(map(str, pids))})")
|
|
else:
|
|
print(f"⚠ Launched gateway via {via}, but no process detected after 6s.")
|
|
print(" Check the log for startup errors:")
|
|
from hermes_cli.config import get_hermes_home
|
|
print(f" type {Path(get_hermes_home()).resolve()}\\logs\\gateway.log")
|
|
print(f" type {Path(get_hermes_home()).resolve()}\\logs\\gateway-stdio.log")
|
|
|
|
|
|
def _print_next_steps() -> None:
|
|
from hermes_cli.config import get_hermes_home
|
|
|
|
hermes_home = Path(get_hermes_home()).resolve()
|
|
print()
|
|
print("Next steps:")
|
|
print(" hermes gateway status # Check status")
|
|
print(f" type {hermes_home}\\logs\\gateway.log # View logs")
|
|
|
|
|
|
def uninstall() -> None:
|
|
"""Remove both the Scheduled Task and the Startup-folder fallback, if present."""
|
|
_assert_windows()
|
|
task_name = get_task_name()
|
|
script_path = get_task_script_path()
|
|
startup_entry = get_startup_entry_path()
|
|
|
|
if is_task_registered():
|
|
code, _out, err = _exec_schtasks(["/Delete", "/F", "/TN", task_name])
|
|
if code == 0:
|
|
print(f"✓ Removed Scheduled Task {task_name!r}")
|
|
else:
|
|
print(f"⚠ schtasks /Delete returned code {code}: {err.strip()}")
|
|
|
|
for path, label in [(startup_entry, "Windows login item"), (script_path, "Task script")]:
|
|
try:
|
|
path.unlink()
|
|
print(f"✓ Removed {label}: {path}")
|
|
except FileNotFoundError:
|
|
pass
|
|
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Status / start / stop / restart
|
|
# ---------------------------------------------------------------------------
|
|
|
|
def is_task_registered() -> bool:
|
|
code, _out, _err = _exec_schtasks(["/Query", "/TN", get_task_name()])
|
|
return code == 0
|
|
|
|
|
|
def is_startup_entry_installed() -> bool:
|
|
return get_startup_entry_path().exists()
|
|
|
|
|
|
def is_installed() -> bool:
|
|
"""True when either the schtasks entry or the Startup fallback is present."""
|
|
return is_task_registered() or is_startup_entry_installed()
|
|
|
|
|
|
def query_task_status() -> dict[str, str]:
|
|
"""Parse ``schtasks /Query /V /FO LIST`` and pull the interesting keys."""
|
|
code, out, err = _exec_schtasks(["/Query", "/TN", get_task_name(), "/V", "/FO", "LIST"])
|
|
if code != 0:
|
|
return {}
|
|
info: dict[str, str] = {}
|
|
for raw in out.splitlines():
|
|
line = raw.strip()
|
|
if not line or ":" not in line:
|
|
continue
|
|
key, _, value = line.partition(":")
|
|
key = key.strip().lower()
|
|
value = value.strip()
|
|
# Some Windows locales emit "Last Result" instead of "Last Run Result".
|
|
if key in {"status", "last run time", "last run result", "last result"}:
|
|
if key == "last result":
|
|
info.setdefault("last run result", value)
|
|
else:
|
|
info[key] = value
|
|
return info
|
|
|
|
|
|
def _gateway_pids() -> list[int]:
|
|
"""Reuse the cross-platform PID scanner in gateway.py."""
|
|
from hermes_cli.gateway import find_gateway_pids
|
|
|
|
return list(find_gateway_pids())
|
|
|
|
|
|
def status(deep: bool = False) -> None:
|
|
"""Print a status report for the Windows gateway service."""
|
|
_assert_windows()
|
|
task_name = get_task_name()
|
|
task_installed = is_task_registered()
|
|
startup_installed = is_startup_entry_installed()
|
|
pids = _gateway_pids()
|
|
|
|
if task_installed:
|
|
print(f"✓ Scheduled Task registered: {task_name}")
|
|
info = query_task_status()
|
|
if info:
|
|
for key in ("status", "last run time", "last run result"):
|
|
if key in info:
|
|
print(f" {key.title()}: {info[key]}")
|
|
elif startup_installed:
|
|
print(f"✓ Windows login item installed: {get_startup_entry_path()}")
|
|
else:
|
|
print("✗ Gateway service not installed")
|
|
|
|
if pids:
|
|
print(f"✓ Gateway process running (PID: {', '.join(map(str, pids))})")
|
|
else:
|
|
print("✗ No gateway process detected")
|
|
|
|
if deep:
|
|
print()
|
|
print(f" Task name: {task_name}")
|
|
print(f" Task script: {get_task_script_path()}")
|
|
print(f" Startup entry: {get_startup_entry_path()}")
|
|
|
|
if not task_installed and not startup_installed and not pids:
|
|
print()
|
|
print("To install:")
|
|
print(" hermes gateway install")
|
|
|
|
|
|
def start() -> None:
|
|
"""Start the gateway. Prefers /Run on the scheduled task if present."""
|
|
_assert_windows()
|
|
if is_task_registered():
|
|
code, _out, err = _exec_schtasks(["/Run", "/TN", get_task_name()])
|
|
if code == 0:
|
|
_report_gateway_start(f"Scheduled Task {get_task_name()!r}")
|
|
return
|
|
print(f"⚠ schtasks /Run failed (code {code}): {err.strip()} — falling back to direct spawn")
|
|
|
|
# Direct spawn — no script_path needed with the new argv-based spawner.
|
|
pid = _spawn_detached()
|
|
_report_gateway_start(f"direct spawn (PID {pid})")
|
|
|
|
|
|
def stop() -> None:
|
|
"""Stop the gateway. Tries /End on the scheduled task, then kills any stragglers."""
|
|
_assert_windows()
|
|
from hermes_cli.gateway import kill_gateway_processes
|
|
|
|
stopped_any = False
|
|
if is_task_registered():
|
|
code, _out, err = _exec_schtasks(["/End", "/TN", get_task_name()])
|
|
# schtasks returns nonzero when the task isn't currently running — don't treat that as an error.
|
|
if code == 0:
|
|
stopped_any = True
|
|
elif "not running" not in (err or "").lower():
|
|
print(f"⚠ schtasks /End returned code {code}: {err.strip()}")
|
|
|
|
killed = kill_gateway_processes(all_profiles=False)
|
|
if killed:
|
|
stopped_any = True
|
|
print(f"✓ Killed {killed} gateway process(es)")
|
|
if stopped_any:
|
|
print("✓ Gateway stopped")
|
|
else:
|
|
print("✗ No gateway was running")
|
|
|
|
|
|
def restart() -> None:
|
|
"""Stop the gateway then start it again."""
|
|
_assert_windows()
|
|
stop()
|
|
# Give Windows a moment to release the listening port.
|
|
time.sleep(1.0)
|
|
start()
|