Files
plyngent/src/plyngent/tools/danger.py
T

236 lines
6.8 KiB
Python

from __future__ import annotations
import json
from typing import TYPE_CHECKING, cast
from plyngent.tools.workspace import WorkspaceError, resolve_path
if TYPE_CHECKING:
from collections.abc import Mapping, Sequence
_DISPLAY_ARGV_MAX = 400
_CODE_PREVIEW_MAX = 240
_SHELL_BASENAMES: frozenset[str] = frozenset(
{
"bash",
"sh",
"zsh",
"fish",
"dash",
"ksh",
"csh",
"tcsh",
"powershell",
"pwsh",
"cmd",
"cmd.exe",
"python",
"python3",
"python2",
"ipython",
"ipython3",
"node",
"nodejs",
"deno",
"bun",
"ruby",
"perl",
"php",
"lua",
"r",
"julia",
"irb",
"pry",
"ghci",
"scala",
"jshell",
"sqlite3",
"psql",
"mysql",
"mongo",
"redis-cli",
}
)
def _basename(argv0: str) -> str:
name = argv0.replace("\\", "/").rsplit("/", 1)[-1]
name = name.removesuffix(".exe")
return name.lower()
def _as_argv(args: Mapping[str, object]) -> list[str] | None:
command = args.get("command")
if not isinstance(command, list) or not command:
return None
out: list[str] = []
for part_obj in cast("list[object]", command):
if not isinstance(part_obj, str):
return None
out.append(part_obj)
return out
def _find_dash_c_code(argv: Sequence[str]) -> str | None:
"""Return the argument after ``-c`` / ``-c…`` if present (python/bash/node style)."""
for index, part in enumerate(argv[1:], start=1):
if part == "-c":
return argv[index + 1] if index + 1 < len(argv) else ""
# Combined short forms are uncommon; only exact -c is supported.
return None
def _shell_or_dash_c_reason(argv: Sequence[str], *, via: str) -> str | None:
"""Confirm interactive shells/REPLs and ``-c`` one-liners so the user can inspect argv.
Multi-line reason (shown inside the CLI confirm box). ``via`` is a short
label (tool name), not repeated on every line.
"""
if not argv:
return None
base = _basename(argv[0])
display = " ".join(argv)
if len(display) > _DISPLAY_ARGV_MAX:
display = display[:_DISPLAY_ARGV_MAX] + ""
code = _find_dash_c_code(argv)
if code is not None:
preview = code if len(code) <= _CODE_PREVIEW_MAX else code[:_CODE_PREVIEW_MAX] + ""
return f"{via}: {base} -c (review code before allow)\nargv:\n {display}\n-c code:\n {preview}"
if base in _SHELL_BASENAMES and len(argv) == 1:
return f"{via}: interactive {base!r} (review before allow)\nargv:\n {display}"
# e.g. python -i, bash --login without -c still needs a glance.
if base in _SHELL_BASENAMES:
return f"{via}: shell/runtime {base!r} (review before allow)\nargv:\n {display}"
return None
def _write_file_reason(args: Mapping[str, object]) -> str | None:
path = args.get("path")
if not isinstance(path, str) or not path:
return None
try:
target = resolve_path(path)
except WorkspaceError:
return f"write file {path!r}"
return f"write file {path!r} ({target})"
def _edit_replace_reason(args: Mapping[str, object]) -> str | None:
path = args.get("path")
if not isinstance(path, str) or not path:
return None
return f"edit (replace) in {path!r}"
def _edit_lineno_reason(args: Mapping[str, object]) -> str | None:
path = args.get("path")
if not isinstance(path, str) or not path:
return None
start = args.get("start_line")
end = args.get("end_line")
return f"edit lines {start}-{end} in {path!r}"
def _copy_path_reason(args: Mapping[str, object]) -> str | None:
src = args.get("src")
dst = args.get("dst")
return f"copy {src!r}{dst!r}"
def _move_path_reason(args: Mapping[str, object]) -> str | None:
src = args.get("src")
dst = args.get("dst")
return f"move {src!r}{dst!r}"
def _delete_path_reason(args: Mapping[str, object]) -> str | None:
path = args.get("path")
recursive = bool(args.get("recursive", False))
extra = " recursively" if recursive else ""
return f"delete path {path!r}{extra}"
def _run_command_reason(args: Mapping[str, object]) -> str | None:
argv = _as_argv(args)
if argv is None:
return None
return _shell_or_dash_c_reason(argv, via="run_command")
def _batch_step_argv(item: object) -> list[str] | None:
if not isinstance(item, dict):
return None
step = cast("dict[str, object]", item)
command = step.get("command")
if not isinstance(command, list) or not command:
return None
argv: list[str] = []
for part in command:
if not isinstance(part, str):
return None
argv.append(part)
return argv or None
def _run_command_batch_reason(args: Mapping[str, object]) -> str | None:
"""One confirm for the whole batch if any step is shell/REPL/-c."""
raw = args.get("commands")
if isinstance(raw, str):
try:
loaded: object = json.loads(raw)
except json.JSONDecodeError:
return None
raw = loaded
if not isinstance(raw, list):
return None
risky = [
reason
for index, item in enumerate(cast("list[object]", raw))
if (argv := _batch_step_argv(item)) is not None
and (reason := _shell_or_dash_c_reason(argv, via=f"run_command_batch[{index}]")) is not None
]
if not risky:
return None
header = f"run_command_batch: {len(risky)} risky step(s) (review before allow)"
return header + "\n" + "\n".join(risky)
def _open_pty_reason(args: Mapping[str, object]) -> str | None:
argv = _as_argv(args)
if argv is None:
return None
return _shell_or_dash_c_reason(argv, via="open_pty")
def classify_danger(name: str, args: Mapping[str, object]) -> str | None: # noqa: PLR0911
"""Return a short reason if ``name``/``args`` need user confirm, else ``None``.
Hard denylists (paths/commands) still raise independently. This only covers
soft confirms for mutating tools and risky shell/REPL launches
(interactive shells and ``python -c`` / ``bash -c`` one-liners).
"""
if name == "delete_path":
return _delete_path_reason(args)
if name == "move_path":
return _move_path_reason(args)
if name == "copy_path":
return _copy_path_reason(args)
if name == "write_file":
return _write_file_reason(args)
if name == "edit_replace":
return _edit_replace_reason(args)
if name == "edit_lineno":
return _edit_lineno_reason(args)
if name == "run_command":
return _run_command_reason(args)
if name == "run_command_batch":
return _run_command_batch_reason(args)
if name == "open_pty":
return _open_pty_reason(args)
return None