Files
figcraft/crates/engine/src/plugins.rs
T
bflatastic def6f84b22 M11: plugin directory on figcraft-server
A self-hosted plugin directory, with no third-party service: `figcraft-server` keeps plugin bundles,
the app browses, installs and updates from it, and `figcraft-cli` publishes to it.

- **Bundles** (`figcraft_plugin::bundle`): a plugin's manifest, module and up to 32 plain-named
  assets in one uncompressed, length-prefixed binary form (nothing can expand beyond the bytes
  sent). Its SHA-256 names it. `Bundle::decode` never allocates beyond its input and refuses
  trailing bytes; `Bundle::check` parses the manifest (refusing a plugin API this build doesn't
  run), requires a version of 1-4 numbers, compiles the module without running it (only the
  sandbox's imports allowed) and checks asset names (no paths, no dot files, no Windows device
  names, unique ignoring case). Manifests gain an optional `author`.
- **Protocol**: a new connection kind next to managing and team-library connections:
  `OpenPlugins {key}` then `Plugins {list | fetch | publish | unpublish}`. Browsing needs no
  credential; publishing and unpublishing need the server key (a wrong key is refused). Older
  servers refuse the connection and the app says the server has no plugin directory. The protocol
  version is unchanged; old clients are unaffected.
- **Server** (`apps/figcraft-server/src/directory.rs`): `<data>/plugins/index.json` plus
  `<data>/plugins/<sha256>.bin`, so no publisher-chosen name reaches the file system. Every publish
  is checked in full and must be a newer version; caps `max_plugins` (versions, 0 turns it off),
  `max_plugin_mb` (<= 32), `max_plugins_mb`. Fetches re-hash the file before sending (a damaged
  bundle is never sent) and share a download budget (~32 MiB/s) so a flood is refused, not queued.
  Damaged index entries are skipped and reported, never deleted; an unreadable index lists nothing
  and refuses writes until the operator fixes it. Operator moderation:
  `figcraft-server plugins [list]` and `plugins remove ID [--version V]` (offline or through the
  running server). Logs name ids and versions, never keys.
- **App**: Plugins > Manage plugins gets Installed / Browse tabs. Browse lists a server's plugins
  (version, author as typed, size, access) with a search; nothing is fetched until Browse is
  pressed. Install / Update open a confirmation listing the permissions asked for, the source and
  the SHA-256; only its button downloads. The download must match the listed SHA-256 (and the one
  shown), then is checked like an imported plugin before anything is written. Installed plugins
  live per user under `<settings>/FigCraft/Plugins/<hash of id>/` and run in the same sandbox;
  Remove deletes the folder.
- **Commands**: `plugin.directory.list {server?, query?}`, `plugin.directory.install {id, version?,
  confirm, server?, sha256?}` (refused without `confirm: true`; never opens a dialog),
  `plugin.directory.publish {path | plugin, server}`, `plugin.directory.unpublish {id, version?,
  server}`. `ui.set {pluginsTab, pluginConfirm}` on the control channel.
- **CLI**: `figcraft-cli plugin publish FOLDER --server ws://host:port/` with the key from
  `FIGCRAFT_SERVER_KEY` (or `?key=`), never printed.
- Docs: plugins.md (directories, publishing, commands, manifest), server.md (operating the
  directory: access, checks, caps, moderation, backups, security), collab-protocol.md, mcp.md,
  cli.md, control-protocol.md, target-app-parity area 18 and Ecosystem, ROADMAP, roadmap.md M11,
  gaps.md gap 6. Plugins & widgets 55%/32% -> 60%/35%, 10-30 h -> 8-26 h.
2026-10-12 05:28:53 +07:00

560 lines
24 KiB
Rust
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
//! Plugins: WebAssembly modules that act on the document through the same commands as the menus,
//! CLI and MCP server, inside the sandbox of `figcraft-plugin`. This module is the policy: which
//! commands a plugin may call (its manifest's permissions, and never files, other documents, the
//! undo history, dialogs or plugins), one undo step per run or panel callback, the panels plugins
//! keep open, their settings and the installed-plugin list kept in the preferences. Widgets (plugin
//! layers on the canvas) are in [`crate::widgets`], installing from a server's plugin directory in
//! [`crate::plugin_directory`]. See `docs/plugins.md`.
use std::collections::HashMap;
use std::sync::Arc;
use figcraft_plugin::{Instance, Limits, PluginError, RunOutput, UiChange};
use serde::{Deserialize, Serialize, Serializer};
use serde_json::{Map, Value, json};
use crate::cmd::{CommandSpec, find_command};
use crate::params::{get, num, string};
use crate::{EngineError, Result, Session, bad, spec};
pub use figcraft_plugin::{Access, MANIFEST_FILE, Manifest, Panel, Param, ParamKind};
/// What one plugin may keep in its settings (keys and JSON values, in bytes), and its longest key.
const MAX_SETTINGS_BYTES: usize = 64 * 1024;
const MAX_SETTING_KEY: usize = 128;
/// An installed plugin (in the preferences).
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct InstalledPlugin {
pub manifest: Manifest,
/// Its manifest file; `None` when it was imported without one (its module then lives in this
/// session only and isn't saved with the preferences).
#[serde(default, skip_serializing_if = "Option::is_none")]
pub path: Option<String>,
/// The plugin directory it was installed from (`ws://host:port/`), if any.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub source: Option<String>,
}
/// Saves only the plugins imported from a manifest file (the others can't be loaded again).
pub(crate) fn persisted<S: Serializer>(list: &[InstalledPlugin], s: S) -> std::result::Result<S::Ok, S::Error> {
s.collect_seq(list.iter().filter(|p| p.path.is_some()))
}
/// Per-session plugin state.
#[derive(Debug, Default)]
pub struct Runtime {
/// Modules of plugins imported without a manifest file, by plugin id.
modules: HashMap<String, Arc<Vec<u8>>>,
/// The last run (plugin id, command id, params): "Run last plugin".
pub last: Option<(String, String, Value)>,
/// The open plugin panels, one per plugin, in the order they opened.
pub panels: Vec<OpenPanel>,
/// Where plugins installed from a directory are kept (the app sets a folder of the user's;
/// without one, such plugins last for the session only).
pub install_dir: Option<std::path::PathBuf>,
/// The plugin directory listed last (Plugins ▸ Manage plugins ▸ Browse shows it).
pub directory: Option<crate::plugin_directory::Listing>,
}
impl Runtime {
/// Plugin `id`'s open panel.
pub fn panel(&self, id: &str) -> Option<&OpenPanel> {
self.panels.iter().find(|o| o.manifest.id == id)
}
}
/// A plugin's open panel: the running module (its memory lasts from one callback to the next),
/// the panel it showed and the values entered.
#[derive(Debug)]
pub struct OpenPanel {
pub manifest: Manifest,
/// The command that opened it, its parameters and its undo step's name.
pub command: String,
params: Value,
label: String,
pub panel: Panel,
pub values: Map<String, Value>,
instance: Instance,
}
impl OpenPanel {
/// The panel's title: its own, else the plugin's name.
pub fn title(&self) -> &str {
if self.panel.title.is_empty() { &self.manifest.name } else { &self.panel.title }
}
fn describe(&self) -> Value {
json!({"plugin": self.manifest.id, "command": self.command, "title": self.title(), "controls": self.panel.controls, "values": self.values})
}
}
/// Command prefixes no plugin may call, whatever its permissions: files and the app (plugins get
/// no file system), other documents, version history, the undo history, plugins themselves and
/// nested batches (a run already is one undo step), widgets (only a click calls one back).
const DENIED: &[&str] = &[
"widget.",
"file.",
"doc.",
"version.",
"app.",
"pref.",
"help.",
"plugin.",
"plugins.",
"libraries.",
"library.add",
"edit.undo",
"edit.redo",
"edit.repeat",
"command.batch",
"view.theme",
];
/// Read-only exceptions to [`DENIED`].
const ALLOWED: &[&str] = &["doc.list", "version.list"];
/// Why a plugin may not call `command` with `params` (before running it), if it may not.
fn refusal(m: &Manifest, command: &str, params: &Value) -> Option<String> {
if DENIED.iter().any(|p| command.starts_with(p)) && !ALLOWED.contains(&command) {
return Some(format!("`{command}` isn't available to plugins"));
}
// A widget's own data is FigCraft's to write, so no plugin can forge or retarget a widget.
if writes_widget_data(params, 0) {
return Some(format!("plugins can't write `{}…` layer data", crate::widgets::DATA_PREFIX));
}
if command == "image.place" && get(params, "path").is_some() {
return Some("plugins can't read files: pass the image as `data`".into());
}
if !m.permissions.allows(command) {
return Some(format!("`{command}` isn't in the commands {} asked permission for", m.name));
}
if m.permissions.access == Access::Read && find_command(command).is_some_and(|c| c.history) {
return Some(format!("`{command}` edits the document, and {} may only read it", m.name));
}
None
}
/// Whether `params` set layer data (`pluginData`, anywhere in them) under a widget's own keys.
fn writes_widget_data(params: &Value, depth: usize) -> bool {
let own = |data: &Value| data.as_object().is_some_and(|m| m.keys().any(|k| k.starts_with(crate::widgets::DATA_PREFIX)));
depth < 64
&& match params {
Value::Object(m) => m.iter().any(|(k, v)| (k == "pluginData" && own(v)) || writes_widget_data(v, depth + 1)),
Value::Array(a) => a.iter().any(|v| writes_widget_data(v, depth + 1)),
_ => false,
}
}
/// The sandbox's view of the session: commands go through [`refusal`] and run as nested groups,
/// so a refused one leaves nothing behind.
struct EngineHost<'s> {
s: &'s mut Session,
manifest: &'s Manifest,
}
impl figcraft_plugin::Host for EngineHost<'_> {
fn call(&mut self, command: &str, params: &str) -> std::result::Result<String, String> {
let params: Value = serde_json::from_str(params).map_err(|e| format!("params for `{command}` aren't JSON: {e}"))?;
if let Some(why) = refusal(self.manifest, command, &params) {
return Err(why);
}
let read_only = self.manifest.permissions.access == Access::Read;
let ui_before = self.s.ui_requests.len();
let r = self.s.grouped(command, |s| {
let doc = s.ds()?.doc.clone();
let v = s.execute(command, &params)?;
let opened_ui = s.ui_requests.len() > ui_before;
s.ui_requests.truncate(ui_before);
if opened_ui {
return Err(EngineError::Disabled(command.into(), "it opens a dialog or panel, which plugins can't".into()));
}
if read_only && !Arc::ptr_eq(&doc, &s.ds()?.doc) {
return Err(EngineError::Disabled(command.into(), "it changed the document, and this plugin may only read it".into()));
}
Ok(v)
});
r.map(|v| v.to_string()).map_err(|e| e.to_string())
}
fn selection(&mut self) -> String {
json!(self.s.selection()).to_string()
}
fn notify(&mut self, message: &str) {
self.s.message = Some(message.to_string());
}
fn log(&mut self, line: &str) {
log::info!("plugin {}: {line}", self.manifest.id);
}
fn setting(&mut self, key: &str) -> Option<String> {
Some(self.s.prefs.plugin_settings.get(&self.manifest.id)?.get(key)?.to_string())
}
fn set_setting(&mut self, key: &str, value: Option<&str>) -> std::result::Result<(), String> {
let (all, id) = (&mut self.s.prefs.plugin_settings, &self.manifest.id);
let Some(text) = value else {
if let Some(mine) = all.get_mut(id) {
mine.remove(key);
if mine.is_empty() {
all.remove(id);
}
}
return Ok(());
};
if key.is_empty() || key.chars().count() > MAX_SETTING_KEY || key.chars().any(char::is_control) {
return Err(format!("a setting's key must be 1–{MAX_SETTING_KEY} characters without control characters"));
}
let too_big = || format!("a plugin's settings are limited to {} KB", MAX_SETTINGS_BYTES / 1024);
if key.len() + text.len() > MAX_SETTINGS_BYTES {
return Err(too_big());
}
let v: Value = serde_json::from_str(text).map_err(|e| format!("a setting must be JSON: {e}"))?;
let others: usize =
all.get(id).map_or(0, |mine| mine.iter().filter(|(k, _)| k.as_str() != key).map(|(k, v)| k.len() + v.to_string().len()).sum());
if others + key.len() + v.to_string().len() > MAX_SETTINGS_BYTES {
return Err(too_big());
}
all.entry(id.clone()).or_default().insert(key.to_string(), v);
Ok(())
}
}
/// The installed plugin `id`.
pub(crate) fn installed<'a>(s: &'a Session, cmd: &str, id: &str) -> Result<&'a InstalledPlugin> {
s.prefs.plugins.iter().find(|p| p.manifest.id == id).ok_or_else(|| bad(cmd, format!("no plugin `{id}` is installed")))
}
/// Read a file of at most `max` bytes.
#[cfg(not(target_arch = "wasm32"))]
pub(crate) fn read_file(path: &std::path::Path, max: usize) -> Result<Vec<u8>> {
let shown = path.display();
let meta = std::fs::metadata(path).map_err(|e| EngineError::Other(format!("{shown}: {e}")))?;
if !meta.is_file() || meta.len() > max as u64 {
return Err(EngineError::Other(format!("{shown}: not a file of at most {} KB", max / 1024)));
}
std::fs::read(path).map_err(|e| EngineError::Other(format!("{shown}: {e}")))
}
/// The manifest at `path` (the file, or the folder holding `figcraft-plugin.json`), its absolute
/// path and its module.
#[cfg(not(target_arch = "wasm32"))]
fn load_from_disk(cmd: &str, path: &str) -> Result<(Manifest, String, Vec<u8>)> {
let mut file = std::path::PathBuf::from(crate::library::absolute_path(path.trim()));
if file.is_dir() {
file.push(MANIFEST_FILE);
}
let text = read_file(&file, figcraft_plugin::manifest::MAX_MANIFEST_BYTES)?;
let text = String::from_utf8(text).map_err(|_| bad(cmd, "the manifest isn't UTF-8 text"))?;
let manifest = Manifest::parse(&text).map_err(|e| bad(cmd, e))?;
let wasm = module_file(&file, &manifest)?;
Ok((manifest, file.to_string_lossy().into_owned(), wasm))
}
#[cfg(target_arch = "wasm32")]
fn load_from_disk(cmd: &str, _path: &str) -> Result<(Manifest, String, Vec<u8>)> {
Err(bad(cmd, "there are no files in the browser: pass `manifest` and `wasm` (base64)"))
}
/// The module a manifest at `manifest_file` names.
#[cfg(not(target_arch = "wasm32"))]
pub(crate) fn module_file(manifest_file: &std::path::Path, m: &Manifest) -> Result<Vec<u8>> {
let dir = manifest_file.parent().unwrap_or(std::path::Path::new("."));
read_file(&dir.join(&m.main), Limits::default().module_bytes)
}
/// The module of an installed plugin: from the session, else read again from disk (so a rebuilt
/// development plugin runs its new code).
pub(crate) fn module_of(s: &Session, p: &InstalledPlugin) -> Result<Arc<Vec<u8>>> {
if let Some(m) = s.plugins.modules.get(&p.manifest.id) {
return Ok(m.clone());
}
let Some(path) = &p.path else {
return Err(EngineError::Other(format!("{} was imported without a manifest file: import it again", p.manifest.name)));
};
#[cfg(not(target_arch = "wasm32"))]
return module_file(std::path::Path::new(path), &p.manifest).map(Arc::new);
#[cfg(target_arch = "wasm32")]
return Err(EngineError::Other(format!("{path}: there are no files in the browser")));
}
/// The sandbox limits for a run, with `fuel` lowering the instruction budget.
pub(crate) fn limits(fuel: Option<f64>) -> Limits {
let mut limits = Limits::default();
if let Some(f) = fuel.filter(|f| f.is_finite()) {
limits.fuel = (f.max(1000.0) as u64).min(limits.fuel);
}
limits
}
pub(crate) fn plugin_error(name: &str, e: PluginError) -> EngineError {
EngineError::Other(format!("{name}: {e}"))
}
/// A plugin as `plugin.list` reports it.
fn describe(s: &Session, p: &InstalledPlugin) -> Value {
let mut v = serde_json::to_value(&p.manifest).unwrap_or_else(|_| json!({"id": p.manifest.id}));
v["path"] = json!(p.path);
v["source"] = json!(p.source);
v["loaded"] = json!(p.path.is_some() || s.plugins.modules.contains_key(&p.manifest.id));
v
}
fn list(s: &mut Session, _p: &Value) -> Result<Value> {
let plugins: Vec<Value> = s.prefs.plugins.iter().map(|p| describe(s, p)).collect();
let last = s.plugins.last.as_ref().map(|(id, command, _)| json!({"id": id, "command": command}));
Ok(json!({"plugins": plugins, "last": last}))
}
fn import(s: &mut Session, p: &Value) -> Result<Value> {
let cmd = "plugin.import";
let (manifest, path, wasm) = match (string(p, "path"), get(p, "manifest")) {
(Some(path), _) => {
let (m, path, wasm) = load_from_disk(cmd, &path)?;
(m, Some(path), wasm)
}
(None, Some(m)) => {
let m = match m {
Value::String(text) => Manifest::parse(text),
other => Manifest::from_value(other),
}
.map_err(|e| bad(cmd, e))?;
use base64::Engine as _;
let b64 = string(p, "wasm").ok_or_else(|| bad(cmd, "pass the module as `wasm` (base64) with `manifest`"))?;
if b64.len() > Limits::default().module_bytes / 3 * 4 + 4 {
return Err(bad(cmd, "the module is too large"));
}
let wasm = base64::engine::general_purpose::STANDARD.decode(b64.trim()).map_err(|e| bad(cmd, format!("`wasm`: {e}")))?;
(m, None, wasm)
}
(None, None) => return Err(bad(cmd, "pass `path` (a figcraft-plugin.json or its folder), or `manifest` and `wasm`")),
};
figcraft_plugin::check_module(&wasm, &Limits::default()).map_err(|e| plugin_error(&manifest.name, e))?;
let mut out = describe(s, &InstalledPlugin { manifest: manifest.clone(), path: path.clone(), source: None });
out["replaced"] = json!(register(s, InstalledPlugin { manifest, path, source: None }, wasm));
out["loaded"] = json!(true);
Ok(out)
}
/// Install `entry` (its module `wasm` is kept in the session when it has no manifest file),
/// replacing a plugin with the same id (whose panel closes); whether one was replaced.
pub(crate) fn register(s: &mut Session, entry: InstalledPlugin, wasm: Vec<u8>) -> bool {
let id = entry.manifest.id.clone();
if entry.path.is_none() {
s.plugins.modules.insert(id.clone(), Arc::new(wasm));
} else {
s.plugins.modules.remove(&id);
}
close_panel(s, &id);
let list = &mut s.prefs.plugins;
match list.iter_mut().find(|x| x.manifest.id == id) {
Some(slot) => {
*slot = entry;
true
}
None => {
list.push(entry);
false
}
}
}
fn remove(s: &mut Session, p: &Value) -> Result<Value> {
let cmd = "plugin.remove";
let id = string(p, "id").ok_or_else(|| bad(cmd, "`id` required"))?;
let p = installed(s, cmd, &id)?.clone();
crate::plugin_directory::delete_installed(s, &p);
s.prefs.plugins.retain(|x| x.manifest.id != id);
s.prefs.plugin_settings.remove(&id);
s.plugins.modules.remove(&id);
close_panel(s, &id);
if s.plugins.last.as_ref().is_some_and(|(last, ..)| *last == id) {
s.plugins.last = None;
}
Ok(json!({"removed": id}))
}
/// Run plugin `id`'s `command` with `params` as one undo step.
pub fn run(s: &mut Session, id: &str, command: Option<&str>, params: &Value, fuel: Option<f64>) -> Result<Value> {
let cmd = "plugin.run";
let mut p = installed(s, cmd, id)?.clone();
// Checked again: the preferences file may have been edited by hand.
p.manifest = Manifest::from_value(&json!(p.manifest)).map_err(|e| bad(cmd, e))?;
let m = &p.manifest;
let c = m.command(command).ok_or_else(|| bad(cmd, format!("{} has no command `{}`", m.name, command.unwrap_or_default())))?;
let params = c.resolve_params(params).map_err(|e| bad(cmd, e))?;
let wasm = module_of(s, &p)?;
let limits = limits(fuel);
// The API the plugin was written for: a v1 plugin gets the input it always got.
let input = json!({"api": m.api, "command": c.id, "params": params, "selection": s.selection()}).to_string();
s.plugins.last = Some((m.id.clone(), c.id.clone(), params.clone()));
let label = if m.commands.len() > 1 { format!("{}: {}", m.name, c.label.trim_end_matches(['…', '.'])) } else { m.name.clone() };
let mut instance = Instance::new(&wasm, &limits).map_err(|e| plugin_error(&m.name, e))?;
let mut out = call_plugin(s, m, &label, &mut instance, &input).map_err(|(e, _)| e)?;
match out.ui.take() {
Some(UiChange::Show(panel)) => {
let values = panel.values(&Map::new());
close_panel(s, &m.id);
s.plugins.panels.push(OpenPanel { manifest: m.clone(), command: c.id.clone(), params, label, panel, values, instance });
}
Some(UiChange::Close) => close_panel(s, &m.id),
None => {}
}
Ok(report(s, &m.id, &c.id, out))
}
/// Call the plugin with `input` as one undo step (none when it changed nothing), rolled back when
/// it fails. On failure, also whether the module is still fit for more calls: it returned an
/// error itself rather than trapping or running out of fuel or memory.
pub(crate) fn call_plugin(
s: &mut Session,
m: &Manifest,
label: &str,
instance: &mut Instance,
input: &str,
) -> std::result::Result<RunOutput, (EngineError, bool)> {
let mut usable = false;
s.grouped(label, |s| {
let mut host = EngineHost { s, manifest: m };
instance.call(input, &mut host).map_err(|e| {
usable = matches!(e, PluginError::Failed(_));
plugin_error(&m.name, e)
})
})
.map_err(|e| (e, usable))
}
/// What `plugin.run` and `plugin.event` return.
fn report(s: &Session, id: &str, command: &str, out: RunOutput) -> Value {
let output = serde_json::from_str::<Value>(&out.output).unwrap_or(Value::String(out.output));
let panel = s.plugins.panel(id).map(OpenPanel::describe);
json!({"plugin": id, "command": command, "output": output, "logs": out.logs, "calls": out.calls, "fuel": out.fuel, "panel": panel})
}
/// Close plugin `id`'s panel, if it has one open.
fn close_panel(s: &mut Session, id: &str) {
s.plugins.panels.retain(|o| o.manifest.id != id);
}
fn ui(s: &mut Session, p: &Value) -> Result<Value> {
let open = match string(p, "id") {
Some(id) => s.plugins.panel(&id),
None => s.plugins.panels.last(),
};
Ok(open.map_or(Value::Null, OpenPanel::describe))
}
/// A button press or a changed value in a plugin's panel: the plugin is called back with the
/// event and every value, as one undo step.
fn event(s: &mut Session, p: &Value) -> Result<Value> {
let cmd = "plugin.event";
let id = string(p, "id").ok_or_else(|| bad(cmd, "`id` required (the plugin whose panel is open)"))?;
let control = string(p, "control").ok_or_else(|| bad(cmd, "`control` required (a control's name)"))?;
let at = s.plugins.panels.iter().position(|o| o.manifest.id == id).ok_or_else(|| bad(cmd, format!("`{id}` has no panel open")))?;
let open = s.plugins.panels.get(at).ok_or_else(|| bad(cmd, "no panel is open"))?;
let c = open
.panel
.control(&control)
.filter(|c| c.kind != ParamKind::Note)
.ok_or_else(|| bad(cmd, format!("the panel has no control `{control}`")))?;
let field = c.is_field();
let value = if field { c.coerce(get(p, "value").unwrap_or(&Value::Null)).map_err(|e| bad(cmd, e))? } else { Value::Null };
let mut open = s.plugins.panels.remove(at);
if field {
open.values.insert(control.clone(), value.clone());
}
let command = open.command.clone();
let event = json!({"control": control, "value": value});
let input = json!({"api": open.manifest.api, "command": open.command, "params": open.params, "selection": s.selection(), "event": event, "values": open.values});
let mut out = match call_plugin(s, &open.manifest, &open.label, &mut open.instance, &input.to_string()) {
Ok(out) => out,
Err((e, usable)) => {
// A plugin that returned an error keeps its panel; one that crashed loses it.
if usable {
keep(s, at, open);
}
return Err(e);
}
};
match out.ui.take() {
Some(UiChange::Show(panel)) => {
open.values = panel.values(&open.values);
open.panel = panel;
keep(s, at, open);
}
Some(UiChange::Close) => {}
None => keep(s, at, open),
}
Ok(report(s, &id, &command, out))
}
/// Put a panel taken out for a callback back in its place among the open ones.
fn keep(s: &mut Session, at: usize, open: OpenPanel) {
let at = at.min(s.plugins.panels.len());
s.plugins.panels.insert(at, open);
}
fn close(s: &mut Session, p: &Value) -> Result<Value> {
let id = string(p, "id").ok_or_else(|| bad("plugin.close", "`id` required"))?;
let closed = s.plugins.panel(&id).is_some();
close_panel(s, &id);
Ok(json!({"closed": closed}))
}
fn run_cmd(s: &mut Session, p: &Value) -> Result<Value> {
let id = string(p, "id").ok_or_else(|| bad("plugin.run", "`id` required (see plugin.list)"))?;
let command = string(p, "command");
run(s, &id, command.as_deref(), get(p, "params").unwrap_or(&Value::Null), num(p, "fuel"))
}
fn run_last(s: &mut Session, _p: &Value) -> Result<Value> {
let Some((id, command, params)) = s.plugins.last.clone() else {
return Err(EngineError::Disabled("plugins.runLast".into(), "no plugin has run yet".into()));
};
run(s, &id, Some(&command), &params, None)
}
fn manage(s: &mut Session, p: &Value) -> Result<Value> {
s.request_ui("dialog.plugins", json!({}));
list(s, p)
}
pub fn specs() -> Vec<CommandSpec> {
vec![
spec!("plugin.list", "List plugins", "{} → {plugins: [{id, name, version, main, permissions, commands, path, loaded}], last}", false, list),
spec!(
"plugin.import",
"Import plugin from manifest…",
"{path (figcraft-plugin.json or its folder) | manifest (object or JSON text), wasm (base64)} replaces a plugin with the same id",
false,
import
),
spec!("plugin.remove", "Remove plugin", "{id}", false, remove),
spec!(
"plugin.run",
"Run plugin",
"{id, command? (default: the first), params? (the command's parameters), fuel? (lower instruction budget)} one undo step → {output, logs, calls, fuel, panel}",
false,
run_cmd
),
spec!(
"plugin.ui",
"Plugin panel",
"{id?} → plugin id's open panel (without id: the one opened last) {plugin, command, title, controls, values}, or null",
false,
ui
),
spec!(
"plugin.event",
"Use plugin panel control",
"{id, control, value? (a field's new value)} presses a button or sets a field in the plugin's open panel; the plugin is called back as one undo step → like plugin.run",
false,
event
),
spec!("plugin.close", "Close plugin panel", "{id} → {closed}", false, close),
spec!("plugins.runLast", "Run last plugin", "{}", false, run_last),
spec!("plugins.manage", "Manage plugins…", "{} opens the plugins window; returns the list like `plugin.list`", false, manage),
]
}