File size: 16,790 Bytes
f5ce49f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 | """
Plugin discovery, validation, collision detection, and dispatch.
Discovery runs once (JarvisLive.__init__ calls discover_plugins()); the resulting
PluginRegistry is cached for the process lifetime. Enable/disable state is re-read
from config on every call to get_tool_declarations() / run() / list_for_ui(), so
toggling a plugin does not require restarting the app or re-importing anything.
"""
from __future__ import annotations
import importlib.util
import inspect
import re
import sys
import traceback
from dataclasses import dataclass, field
from pathlib import Path
from typing import Callable, Optional
from memory.config_manager import get_plugin_enabled, get_plugin_config
_NAME_RE = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_]{0,63}$")
_DEFAULT_PARAMS = {"type": "OBJECT", "properties": {}}
# Optional, and the same contract actions use: a plugin that takes a moment can
# say so, and the model carries on talking instead of waiting on it. See
# core/action_loader.py for what each value means.
_BEHAVIORS = ("BLOCKING", "NON_BLOCKING")
_SCHEDULING = ("WHEN_IDLE", "SILENT", "INTERRUPT")
def _opt_upper(value, allowed: tuple[str, ...]) -> Optional[str]:
v = str(value or "").strip().upper()
return v if v in allowed else None
def _opt_tier(value) -> Optional[str]:
""""core" or "extra" from a declaration, or None when it did not say.
Anything else is treated as "did not say" rather than as an error: a typo
should fall back to the default ranking, not stop a working tool loading.
"""
text = str(value or "").strip().lower()
return text if text in ("core", "extra") else None
def _opt_text(value) -> Optional[str]:
text = str(value or "").strip()
return text or None
@dataclass
class PluginRecord:
name: str
description: str = ""
parameters: dict = field(default_factory=lambda: dict(_DEFAULT_PARAMS))
run: Optional[Callable] = None
file: str = ""
valid: bool = False
error: str = ""
settings: Optional[dict] = None # optional PLUGIN_SETTINGS schema (config fields)
behavior: Optional[str] = None # None = the API's default (blocking)
scheduling: Optional[str] = None # None = the API's default (WHEN_IDLE)
# Read by providers/schema.py when a small model gets a tool budget; never
# sent to any API β main.py strips both before the Gemini config is built.
# tier "core" | "extra" β this file's own opinion of whether it should
# survive a tight budget, instead of that being decided by the
# order files happen to be discovered in.
# brief a short description used in place of the long one when a budget
# is in force. Nothing is deleted: Gemini still gets the full text.
tier: Optional[str] = None
brief: Optional[str] = None
class PluginRegistry:
def __init__(self, plugins: dict[str, PluginRecord], logger: Callable[[str], None],
notify: Callable[[str], None] | None = None):
self._plugins = plugins # name -> PluginRecord, VALID entries only
self._all_records: list[PluginRecord] = [] # valid + invalid, for UI listing
self._logger = logger
# Where user-facing notices go. `logger` is the console transcript and
# carries everything; `notify` reaches the activity log, so only things
# the user has to know about are sent to it. Defaults to dropping them,
# which keeps every existing single-sink caller working unchanged.
self._notify = notify or (lambda _msg: None)
# -- called by main.py at LiveConnectConfig build time --
def get_tool_declarations(self) -> list[dict]:
decls = []
for name, rec in self._plugins.items():
if get_plugin_enabled(name):
decl = {
"name": rec.name,
"description": rec.description,
"parameters": rec.parameters,
}
if rec.behavior:
decl["behavior"] = rec.behavior
# Budget metadata. NOT part of any API's schema β main.py calls
# providers.schema.strip_meta() before the Gemini config is
# built, and budget() consumes them on the local-engine path.
if rec.tier:
decl["tier"] = rec.tier
if rec.brief:
decl["brief"] = rec.brief
decls.append(decl)
return decls
def has(self, name: str) -> bool:
return name in self._plugins
def scheduling(self, name: str) -> Optional[str]:
"""How this plugin's result should re-enter the conversation, if it said."""
rec = self._plugins.get(name)
return rec.scheduling if rec else None
# -- called by main.py from _execute_tool's else branch --
def run(self, name: str, parameters: dict, player=None, session_memory=None) -> str:
rec = self._plugins.get(name)
if rec is None or not rec.valid:
return f"Plugin '{name}' is not available."
if not get_plugin_enabled(name):
return f"The '{name}' plugin is currently disabled."
try:
return _call_run(rec.run, parameters, player, session_memory) or "Done."
except Exception as e:
self._logger(f"Plugin '{name}' crashed during run(): {e}")
self._notify(f"Plugin '{name}' failed β see the console for details.")
traceback.print_exc()
return f"Sir, the '{name}' plugin failed: {e}"
# -- called by ui.py's settings tab to render per-plugin config forms --
def settings_schemas(self) -> list[dict]:
"""One entry per settings SECTION, for enabled plugins that declare a
PLUGIN_SETTINGS schema. Sections are deduped by namespace so a suite of
plugins sharing one namespace (e.g. the printer trio) shows a single
form. Current stored values are merged in so the UI can pre-fill fields.
"""
seen: set[str] = set()
out: list[dict] = []
for name, rec in self._plugins.items():
if not rec.settings or not get_plugin_enabled(name):
continue
ns = rec.settings.get("namespace") or rec.name
if ns in seen:
continue
seen.add(ns)
out.append({
"plugin": rec.name,
"namespace": ns,
"title": rec.settings.get("title") or rec.name,
"fields": rec.settings.get("fields", []),
"values": get_plugin_config(ns),
"action": rec.settings.get("action"), # optional test/connect button
})
return out
# -- called by ui.py's Plugin Manager overlay --
def list_for_ui(self) -> list[dict]:
out = []
for rec in self._all_records:
out.append({
"name": rec.name,
"description": rec.description,
"file": rec.file,
"valid": rec.valid,
"error": rec.error,
"enabled": get_plugin_enabled(rec.name) if rec.valid else False,
})
return out
def _call_run(run_fn, parameters, player, session_memory):
"""Invoke run() passing only the kwargs it actually declares (or all of them
if it has **kwargs), so a minimal `def run(parameters):` plugin still works."""
sig = inspect.signature(run_fn)
has_var_kw = any(p.kind == inspect.Parameter.VAR_KEYWORD for p in sig.parameters.values())
kwargs = {}
if has_var_kw or "player" in sig.parameters:
kwargs["player"] = player
if has_var_kw or "session_memory" in sig.parameters:
kwargs["session_memory"] = session_memory
return run_fn(parameters, **kwargs)
def _validate(module, filename: str) -> PluginRecord:
"""Returns a PluginRecord; .valid=False + .error set on any problem. Never raises."""
plugin_meta = getattr(module, "PLUGIN", None)
if not isinstance(plugin_meta, dict):
return PluginRecord(name=Path(filename).stem, file=filename,
error="Missing PLUGIN dict constant.")
name = plugin_meta.get("name")
if not isinstance(name, str) or not _NAME_RE.match(name):
return PluginRecord(name=str(name or Path(filename).stem), file=filename,
error="PLUGIN['name'] missing or not a valid identifier "
"(letters/digits/underscore, must start with letter/underscore).")
description = plugin_meta.get("description")
if not isinstance(description, str) or not description.strip():
return PluginRecord(name=name, file=filename,
error="PLUGIN['description'] missing or empty.")
parameters = plugin_meta.get("parameters", _DEFAULT_PARAMS)
if not isinstance(parameters, dict) or parameters.get("type") != "OBJECT":
return PluginRecord(name=name, file=filename,
error="PLUGIN['parameters'] must be a dict with \"type\": \"OBJECT\".")
run_fn = getattr(module, "run", None)
if not callable(run_fn):
return PluginRecord(name=name, file=filename,
error="Missing callable run(parameters, ...) function.")
# Optional, self-describing settings schema (rendered by the settings UI).
# A malformed schema is ignored, never fatal β the plugin still loads.
settings = getattr(module, "PLUGIN_SETTINGS", None)
if not (isinstance(settings, dict) and isinstance(settings.get("fields"), list)):
settings = None
return PluginRecord(name=name, description=description.strip(), parameters=parameters,
run=run_fn, file=filename, valid=True, error="", settings=settings,
behavior=_opt_upper(plugin_meta.get("behavior"), _BEHAVIORS),
scheduling=_opt_upper(plugin_meta.get("scheduling"), _SCHEDULING),
tier=_opt_tier(plugin_meta.get("tier")),
brief=_opt_text(plugin_meta.get("brief")))
# The app's own top-level packages. Named explicitly rather than only probed on
# disk, because the case that matters most is the folder being ABSENT: a plugin
# importing core.undo on a build with no core/ at all must still be told to
# update, not to install something called "core".
_FIRST_PARTY = {"core", "memory", "actions", "plugins", "dashboard", "config"}
def _is_first_party(top: str, plugins_dir: Path) -> bool:
"""True when `top` names part of this app rather than a third-party package.
The disk probe is the second half so a package added to the project later is
recognised without anyone remembering to edit the set above.
"""
if top in _FIRST_PARTY:
return True
root = plugins_dir.parent
try:
return (root / top).is_dir() or (root / f"{top}.py").is_file()
except OSError:
return False
def _load_error(path: Path, plugins_dir: Path, exc: Exception) -> str:
"""Turn an import failure into something the person who downloaded the file
can act on.
Plugins are shared one file at a time, but some of them sit on a helper β
anything named with a leading underscore, which this loader deliberately
skips so it is never treated as a plugin of its own. Download the plugin
without its helper and Python reports `No module named 'plugins._x'`, which
is accurate and tells a non-programmer nothing. Naming the missing file, and
saying it belongs next to this one, turns a support question into a
thirty-second fix. Nothing here is specific to any plugin: the helper's name
comes from the exception itself.
"""
if isinstance(exc, ModuleNotFoundError):
missing = (getattr(exc, "name", "") or "").split(".")
if len(missing) == 2 and missing[0] == "plugins" and missing[1].startswith("_"):
helper = missing[1] + ".py"
return (f"Needs the shared file '{helper}', which is not in "
f"{plugins_dir.name}/. It comes with this plugin β download "
f"'{helper}' into the same folder as {path.name} and restart.")
if missing and missing[0] not in ("plugins",):
if _is_first_party(missing[0], plugins_dir):
# 'pip install core' is not merely unhelpful β it is dangerous
# advice. These names belong to this project, and telling
# somebody to install a same-named stranger from an index is a
# supply-chain hazard dressed up as a fix. A plugin written
# against a newer Mark reaches this line, and the honest answer
# is that the app is behind the plugin, not that a package is
# absent.
needed = "/".join(missing) + ".py"
return (f"Needs '{needed}', which is part of this app rather than "
f"something to install β your copy doesn't have it, so it "
f"comes with a newer version. Update the app; there is "
f"nothing to pip install.")
return (f"Needs a package that is not installed: "
f"pip install {missing[0]}")
return f"Failed to load: {exc}"
def discover_plugins(plugins_dir: Path, core_tool_names: set[str],
logger: Callable[[str], None] = print,
notify: Callable[[str], None] | None = None) -> PluginRegistry:
"""
Scans plugins_dir for *.py files (skips files starting with '_', e.g. __init__.py,
_template.py, and any shared-helper modules an author prefixes with '_').
Import errors, validation errors, and name collisions are logged and the offending
file is skipped β they NEVER raise out of this function and never abort the scan
of remaining files.
"""
plugins_dir.mkdir(parents=True, exist_ok=True)
valid: dict[str, PluginRecord] = {}
all_records: list[PluginRecord] = []
files = sorted(plugins_dir.glob("*.py"), key=lambda p: p.name) # deterministic order
for path in files:
if path.name.startswith("_"):
continue
try:
module_name = f"plugins.{path.stem}"
spec = importlib.util.spec_from_file_location(module_name, path)
if spec is None or spec.loader is None:
raise ImportError("could not build import spec")
module = importlib.util.module_from_spec(spec)
sys.modules[module_name] = module
try:
spec.loader.exec_module(module)
except Exception:
sys.modules.pop(module_name, None)
raise
rec = _validate(module, path.name)
if rec.valid and rec.name in core_tool_names:
rec = PluginRecord(name=rec.name, file=path.name,
error=f"Name '{rec.name}' collides with a core tool β rejected.")
elif rec.valid and rec.name in valid:
other = valid[rec.name].file
rec = PluginRecord(name=rec.name, file=path.name,
error=f"Name '{rec.name}' already used by plugin '{other}' β rejected.")
except Exception as e:
rec = PluginRecord(name=path.stem, file=path.name,
error=_load_error(path, plugins_dir, e))
traceback.print_exc()
all_records.append(rec)
if rec.valid:
valid[rec.name] = rec
logger(f"Plugin loaded: {rec.name} ({path.name})")
else:
logger(f"Plugin rejected: {path.name} β {rec.error}")
notify = notify or (lambda _msg: None)
registry = PluginRegistry(valid, logger, notify)
registry._all_records = all_records
rejected = len(all_records) - len(valid)
logger(f"Plugin discovery complete: {len(valid)} active, "
f"{rejected} rejected, {len(all_records)} total.")
# The activity log is the user's conversation, not a boot transcript: a
# plugin that loaded correctly is not news, so only a failure surfaces there
# β and then as one line, because the per-plugin detail is on the console.
if rejected:
notify(f"{rejected} plugin(s) could not be loaded β see the console.")
return registry
|