plugins_cmd_toggle.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. """The interactive ``hermes plugins`` composite UI: general-plugin checkboxes (saved through the one
  2. admission authority) and the memory-provider / context-engine category pickers.
  3. Sibling of :mod:`hermes_cli.plugins_cmd` (the facade re-exports the names other modules use and is
  4. imported late here, never at module level).
  5. """
  6. from __future__ import annotations
  7. import functools
  8. import logging
  9. import sys
  10. logger = logging.getLogger(__name__)
  11. def _pc():
  12. """The facade, read at call time: tests patch ``plugins_cmd.<name>`` and sibling calls must see it."""
  13. from hermes_cli import plugins_cmd
  14. return plugins_cmd
  15. def _discover_memory_providers() -> list[tuple[str, str]]:
  16. """``[(name, description), ...]`` for available memory providers."""
  17. try:
  18. from plugins.memory import discover_memory_providers
  19. return [(name, desc) for name, desc, _avail in discover_memory_providers()]
  20. except Exception:
  21. return []
  22. def _discover_context_engines() -> list[tuple[str, str]]:
  23. """``[(name, description), ...]`` for repo-shipped context engines plus the plugin-registered
  24. one (``ctx.register_context_engine``); repo-shipped descriptions win on a name collision."""
  25. engines: dict[str, str] = {}
  26. try:
  27. from plugins.context_engine import discover_context_engines
  28. for name, desc, _avail in discover_context_engines():
  29. engines.setdefault(name, desc)
  30. except Exception:
  31. pass
  32. try:
  33. from hermes_cli.plugins import discover_plugins, get_plugin_context_engine
  34. discover_plugins()
  35. plugin_engine = get_plugin_context_engine()
  36. if plugin_engine and getattr(plugin_engine, "name", None):
  37. engines.setdefault(plugin_engine.name, "installed plugin")
  38. except Exception:
  39. pass
  40. return list(engines.items())
  41. # (title, default label, default name, current-value reader, discovery fn, saver) per provider
  42. # category. Readers/savers are looked up at call time so module-level patching still applies.
  43. _PROVIDER_CATEGORY_SPECS = (
  44. ("Memory Provider", "built-in", "", lambda: _pc()._get_current_memory_provider(),
  45. lambda: _discover_memory_providers(), lambda v: _pc()._save_memory_provider(v)),
  46. ("Context Engine", "compressor", "compressor", lambda: _pc()._get_current_context_engine(),
  47. lambda: _pc()._discover_context_engines(), lambda v: _pc()._save_context_engine(v)),
  48. )
  49. def _configure_category_spec(spec) -> bool:
  50. """Radio picker for one ``_PROVIDER_CATEGORY_SPECS`` row: the built-in default first, then the
  51. discovered choices; a current value not among them is appended as ``(not found)``. Saves and
  52. returns True when the choice changed."""
  53. from hermes_cli.curses_ui import curses_radiolist
  54. title, default_label, default_name, current, discover, save = spec
  55. current = current()
  56. choices = discover()
  57. names = [default_name] + [name for name, _desc in choices]
  58. items = [f"{default_label} (default)"] + [f"{name} \u2014 {desc}" if desc else name for name, desc in choices]
  59. if current not in names:
  60. names.append(current)
  61. items.append(f"{current} (not found)")
  62. selected = max(i for i, name in enumerate(names) if name == current)
  63. new_value = names[curses_radiolist(title=f"{title} (select one)", items=items, selected=selected)]
  64. if new_value == current:
  65. return False
  66. save(new_value)
  67. return True
  68. def _provider_categories() -> list:
  69. """``[(title, current_label, configure_fn), ...]`` rows for the composite UI."""
  70. return [(s[0], s[3]() or s[1], functools.partial(_configure_category_spec, s)) for s in _PROVIDER_CATEGORY_SPECS]
  71. def cmd_toggle() -> None:
  72. """Interactive composite UI — general plugins + provider plugin categories."""
  73. console = _pc()._console()
  74. entries = _pc()._discover_all_plugins()
  75. expected_config = _pc()._plugin_selection_version()
  76. enabled_set = _pc()._get_enabled_set()
  77. disabled_set = _pc()._get_disabled_set()
  78. # Track by CANONICAL KEY, not manifest name: the loader and enable/disable all gate on the
  79. # key (``web/firecrawl``) while the name may differ (``web-firecrawl``); persisting the bare
  80. # name let plugins.disabled drift so "explicit disable wins" kept a plugin off forever.
  81. plugin_keys = [entry[5] for entry in entries]
  82. # Keys keep every surface aligned. See #40190.
  83. plugin_labels = [
  84. (f"{name} \u2014 {description}" if description else name) + (" [bundled]" if source == "bundled" else "")
  85. for name, _version, description, source, _d, _key in entries
  86. ]
  87. plugin_selected = _effective_plugin_selection(entries, enabled_set, disabled_set)
  88. categories = _pc()._provider_categories()
  89. if not sys.stdin.isatty():
  90. console.print("[dim]Interactive mode requires a terminal.[/dim]")
  91. return
  92. try:
  93. import curses
  94. _run_composite_ui(curses, plugin_keys, plugin_labels, plugin_selected, disabled_set, categories, console, expected_config=expected_config)
  95. except ImportError:
  96. _run_composite_fallback(plugin_keys, plugin_labels, plugin_selected, disabled_set, categories, console, expected_config=expected_config)
  97. def _effective_plugin_selection(entries, enabled: set, disabled: set) -> set:
  98. """Row indices ticked on open: the load-time rule, not list membership — bundled platforms,
  99. backends and model providers are active without a ``plugins.enabled`` entry."""
  100. from hermes_cli.plugins_cmd_listing import _entry_status
  101. active = _pc()._category_active_names()
  102. return {i for i, entry in enumerate(entries) if _entry_status(entry, enabled, disabled, active) == "enabled"}
  103. def _persist_plugin_selection(plugin_keys, chosen, disabled, initial, *, expected_config=None) -> tuple[list, list]:
  104. """Write only the rows flipped this session; returns the ``(turned_on, turned_off)`` keys.
  105. Untouched rows are never persisted, so a never-ticked row is not mistaken for an explicit untick
  106. and list entries for plugins the picker didn't show survive. Canonical key only, with every alias
  107. purged from the opposing list like ``hermes plugins enable/disable`` (#40190).
  108. """
  109. turned_on = [plugin_keys[i] for i in sorted(chosen - initial)]
  110. turned_off = [plugin_keys[i] for i in sorted(initial - chosen)]
  111. if not (turned_on or turned_off):
  112. return [], []
  113. if expected_config is None:
  114. expected_config = _pc()._plugin_selection_version()
  115. new_enabled, new_disabled = set(_pc()._get_enabled_set()), set(disabled)
  116. entries = _pc()._discover_all_plugins()
  117. for keys, enable in ((turned_on, True), (turned_off, False)):
  118. for key in keys:
  119. _pc()._apply_activation(new_enabled, new_disabled, key, _pc()._plugin_aliases(key, entries), enable=enable)
  120. # C13: the composite UI's candidate goes through the ONE admission authority — refusal raises
  121. # AdmissionRefused BEFORE any config write; the caller surfaces it and the selection stays unsaved.
  122. _pc()._admit_and_save_plugin_sets(new_enabled, new_disabled, action="Save plugin selection", expected_config=expected_config)
  123. logger.info("plugins picker: enabled %s; disabled %s", turned_on or "none", turned_off or "none")
  124. return turned_on, turned_off
  125. def _run_composite_ui(curses, plugin_keys, plugin_labels, plugin_selected, disabled, categories, console, *, expected_config=None):
  126. """Custom curses screen with checkboxes + category action rows."""
  127. from hermes_cli.curses_ui import _addnstr, flush_stdin
  128. chosen = set(plugin_selected)
  129. n_plugins, n_categories = len(plugin_keys), len(categories)
  130. total_items = n_plugins + n_categories # navigable rows (headers/separator are skipped)
  131. providers_changed = False
  132. nav = { # key -> new cursor, given (cursor, page_size)
  133. key: move
  134. for keys, move in (
  135. ((curses.KEY_UP, ord("k")), lambda c, p: (c - 1) % total_items),
  136. ((curses.KEY_DOWN, ord("j")), lambda c, p: (c + 1) % total_items),
  137. ((curses.KEY_NPAGE, ord("f")), lambda c, p: min(total_items - 1, c + p)),
  138. ((curses.KEY_PPAGE, ord("b")), lambda c, p: max(0, c - p)),
  139. ((curses.KEY_HOME,), lambda c, p: 0),
  140. ((curses.KEY_END,), lambda c, p: total_items - 1),
  141. )
  142. for key in keys
  143. }
  144. def _init_colors():
  145. if curses.has_colors():
  146. curses.start_color()
  147. curses.use_default_colors()
  148. gray = 8 if curses.COLORS > 8 else curses.COLOR_WHITE
  149. for pair, fg in ((1, curses.COLOR_GREEN), (2, curses.COLOR_YELLOW), (3, curses.COLOR_CYAN), (4, gray)):
  150. curses.init_pair(pair, fg, -1)
  151. def _attr(base, pair):
  152. return base | curses.color_pair(pair) if curses.has_colors() else base
  153. def _row(text, idx, cursor, pair):
  154. """One navigable body row: arrow marker + bold color when *idx* is the cursor."""
  155. arrow = "\u2192" if idx == cursor else " "
  156. return (f" {arrow} {text}", _attr(curses.A_BOLD, pair) if idx == cursor else curses.A_NORMAL)
  157. def _configure_category(ci):
  158. """Leave curses, run the category's picker, refresh its row, re-enter curses."""
  159. nonlocal providers_changed
  160. curses.endwin()
  161. cat_name, _cat_cur, cat_fn = categories[ci]
  162. if cat_fn():
  163. providers_changed = True
  164. categories[ci] = (cat_name, _pc()._provider_categories()[ci][1], cat_fn)
  165. stdscr = curses.initscr()
  166. curses.noecho()
  167. curses.cbreak()
  168. stdscr.keypad(True)
  169. _init_colors()
  170. curses.curs_set(0)
  171. return stdscr
  172. def _body_lines(cursor, scroll_offset, visible_rows):
  173. """Body rows as (text, attr); "" is a blank separator."""
  174. lines = []
  175. if n_plugins > 0:
  176. lines.append((" General Plugins", _attr(curses.A_BOLD, 2)))
  177. for i in range(scroll_offset, min(n_plugins, scroll_offset + max(visible_rows, 0))):
  178. check = "\u2713" if i in chosen else " "
  179. lines.append(_row(f"[{check}] {plugin_labels[i]}", i, cursor, 1))
  180. lines.append(("", curses.A_NORMAL))
  181. if n_categories > 0:
  182. lines.append((" Provider Plugins", _attr(curses.A_BOLD, 2)))
  183. lines += [
  184. _row(f" {cat_name:<24} \u25b8 {cat_current}", n_plugins + ci, cursor, 3)
  185. for ci, (cat_name, cat_current, _cat_fn) in enumerate(categories)
  186. ]
  187. return lines
  188. def _draw(stdscr):
  189. curses.curs_set(0)
  190. _init_colors()
  191. cursor = scroll_offset = 0
  192. while True:
  193. stdscr.clear()
  194. max_y, max_x = stdscr.getmaxyx()
  195. _addnstr(stdscr, 0, 0, "Plugins", max_x - 1, _attr(curses.A_BOLD, 2))
  196. _addnstr(
  197. stdscr, 1, 0, " ↑↓/j/k navigate PgUp/PgDn page SPACE toggle ENTER configure/confirm ESC done",
  198. max_x - 1, curses.A_DIM)
  199. visible_rows = max_y - 4
  200. if cursor < scroll_offset:
  201. scroll_offset = cursor
  202. elif cursor >= scroll_offset + visible_rows:
  203. scroll_offset = cursor - visible_rows + 1
  204. lines = _body_lines(cursor, scroll_offset, visible_rows)
  205. for y, (text, attr) in enumerate(lines[: max(0, max_y - 4)], start=3):
  206. if text:
  207. _addnstr(stdscr, y, 0, text, max_x - 1, attr)
  208. stdscr.refresh()
  209. key = stdscr.getch()
  210. if key in nav:
  211. if total_items > 0: # (with no rows, every motion leaves cursor at 0)
  212. cursor = nav[key](cursor, max(1, max_y - 5))
  213. elif key == ord(" ") or key in {curses.KEY_ENTER, 10, 13}:
  214. if cursor >= n_plugins:
  215. # Provider category — launch sub-screen (SPACE and ENTER alike)
  216. if cursor - n_plugins < n_categories:
  217. stdscr = _configure_category(cursor - n_plugins)
  218. elif key == ord(" "):
  219. chosen.symmetric_difference_update({cursor})
  220. else:
  221. return # ENTER on a plugin checkbox — confirm and exit
  222. elif key in {27, ord("q")}:
  223. return # plugin changes are saved on exit
  224. curses.wrapper(_draw)
  225. flush_stdin()
  226. from hermes_cli.plugins_admission import AdmissionRefused
  227. try:
  228. turned_on, turned_off = _persist_plugin_selection(plugin_keys, chosen, disabled, plugin_selected,
  229. expected_config=expected_config)
  230. except AdmissionRefused as exc:
  231. console.print(f"[red]✗[/red] Plugin selection refused, not saved: {exc}")
  232. console.print(
  233. "[dim]config.yaml and the active environment are unchanged. "
  234. "Run `hermes pm install` to resolve, then retry.[/dim]"
  235. )
  236. return
  237. if turned_on or turned_off:
  238. console.print(
  239. f"\n[green]\u2713[/green] General plugins: {len(turned_on)} turned on, {len(turned_off)} turned off.")
  240. elif n_plugins > 0:
  241. console.print("\n[dim]General plugins unchanged.[/dim]")
  242. if providers_changed:
  243. console.print(
  244. f"[green]\u2713[/green] Memory provider: [bold]{_pc()._get_current_memory_provider() or 'built-in'}[/bold] "
  245. f"Context engine: [bold]{_pc()._get_current_context_engine()}[/bold]")
  246. if n_plugins > 0 or providers_changed:
  247. console.print("[dim]Changes take effect on next session.[/dim]")
  248. console.print()
  249. def _run_composite_fallback(plugin_keys, plugin_labels, plugin_selected, disabled, categories, console, *, expected_config=None):
  250. """Text-based fallback for the composite plugins UI."""
  251. from hermes_cli.colors import Colors, color
  252. print(color("\n Plugins", Colors.YELLOW))
  253. if plugin_keys:
  254. chosen = set(plugin_selected)
  255. print(color("\n General Plugins", Colors.YELLOW))
  256. print(color(" Toggle by number, Enter to confirm.\n", Colors.DIM))
  257. while True:
  258. for i, label in enumerate(plugin_labels):
  259. marker = color("[\u2713]", Colors.GREEN) if i in chosen else "[ ]"
  260. print(f" {marker} {i + 1:>2}. {label}")
  261. print()
  262. try:
  263. val = input(color(" Toggle # (or Enter to confirm): ", Colors.DIM)).strip()
  264. if not val:
  265. break
  266. idx = int(val) - 1
  267. if 0 <= idx < len(plugin_keys):
  268. chosen.symmetric_difference_update({idx})
  269. except (ValueError, KeyboardInterrupt, EOFError):
  270. return
  271. print()
  272. _save_plugin_selection_fallback(plugin_keys, chosen, disabled, plugin_selected, expected_config=expected_config)
  273. if categories:
  274. print(color("\n Provider Plugins", Colors.YELLOW))
  275. for ci, (cat_name, cat_current, _cat_fn) in enumerate(categories):
  276. print(f" {ci + 1}. {cat_name} [{cat_current}]")
  277. print()
  278. try:
  279. val = input(color(" Configure # (or Enter to skip): ", Colors.DIM)).strip()
  280. if val:
  281. ci = int(val) - 1
  282. if 0 <= ci < len(categories):
  283. categories[ci][2]()
  284. except (ValueError, KeyboardInterrupt, EOFError):
  285. pass
  286. print()
  287. def _save_plugin_selection_fallback(plugin_keys, chosen, disabled, initial, *, expected_config=None) -> None:
  288. """The text fallback's save: same admission authority, refusal printed."""
  289. from hermes_cli.plugins_admission import AdmissionRefused
  290. try:
  291. _persist_plugin_selection(plugin_keys, chosen, disabled, initial, expected_config=expected_config)
  292. except AdmissionRefused as exc:
  293. print(f" Plugin selection refused, not saved: {exc}")
  294. print(" config.yaml and the active environment are unchanged.")