agent-zero/plugins/_office/tools/document_artifact.py
Alessandro 10a6cd28c6 feat(office): replace Collabora with LibreOffice document runtime
Remove the Collabora/WOPI runtime and route stack, including the old status APIs, proxy helpers, bootstrap extensions, and WOPI store tests. Add the Markdown-first document store, LibreOffice status/conversion helpers, LibreOfficeKit session bridge, and reusable Xpra virtual desktop gateway used by the new document runtime.

Update image and self-update bootstrap paths so existing containers can acquire the LibreOffice, XFCE, Xpra, and desktop-control dependencies through the normal install hooks instead of an ad hoc manual install.
2026-05-02 13:07:10 +02:00

177 lines
8.2 KiB
Python

from __future__ import annotations
import json
from pathlib import Path
from typing import Any
from helpers.tool import Response, Tool
from plugins._office.helpers import artifact_editor, document_store, libreoffice
class DocumentArtifact(Tool):
async def execute(
self,
action: str = "",
kind: str = "document",
title: str = "Untitled",
format: str = "md",
content: str = "",
path: str = "",
file_id: str = "",
version_id: int | str | None = None,
operation: str = "",
find: str = "",
replace: str = "",
sheet: str = "",
cells: Any = None,
rows: Any = None,
chart: Any = None,
slides: Any = None,
max_chars: int | str = 12000,
**kwargs: Any,
) -> Response:
action = str(action or self.method or "status").strip().lower().replace("-", "_")
try:
if action == "create":
doc = document_store.create_document(
kind=kind,
title=title,
fmt=format,
content=content,
path=path,
context_id=self._context_id(),
)
if doc["extension"] == "docx":
validation = libreoffice.validate_docx(doc["path"])
if not validation.get("ok"):
return Response(
message=f"document_artifact create failed: {validation.get('error')}",
break_loop=False,
)
return self._document_response("Created document artifact.", doc, action=action)
if action == "open":
doc = self._document_from_input(file_id=file_id, path=path)
return self._document_response("Opened document artifact.", doc, action=action)
if action in {"read", "extract"}:
doc = self._document_from_input(file_id=file_id, path=path)
payload = {
"ok": True,
"action": "read",
"document": self._public_doc(doc),
"content": artifact_editor.read_artifact(doc, max_chars=int(max_chars or 12000)),
}
return self._json_response(payload, doc=doc, action="read")
if action in {"edit", "update", "patch"}:
doc = self._document_from_input(file_id=file_id, path=path)
updated_doc, payload = artifact_editor.edit_artifact(
doc,
operation=operation,
content=content,
find=find,
replace=replace,
sheet=sheet,
cells=cells,
rows=rows,
chart=chart,
slides=slides,
**kwargs,
)
payload["document"] = self._public_doc(updated_doc)
return self._json_response(payload, doc=updated_doc, action="edit")
if action == "inspect":
doc = self._document_from_input(file_id=file_id, path=path)
return self._json_response({"ok": True, "action": action, "document": self._public_doc(doc)}, doc=doc, action=action)
if action == "version_history":
doc = self._document_from_input(file_id=file_id, path=path)
versions = document_store.version_history(doc["file_id"])
return self._json_response({"ok": True, "action": action, "versions": versions}, doc=doc, action=action)
if action == "restore_version":
if version_id is None or str(version_id).strip() == "":
return Response(message="version_id is required for restore_version.", break_loop=False)
doc = self._document_from_input(file_id=file_id, path=path)
restored = document_store.restore_version(doc["file_id"], int(version_id))
return self._document_response("Restored document artifact version.", restored, action=action)
if action == "export":
doc = self._document_from_input(file_id=file_id, path=path)
target_format = str(kwargs.get("target_format") or kwargs.get("export_format") or "").lower().lstrip(".")
if target_format and target_format != doc["extension"]:
result = libreoffice.convert_document(doc["path"], target_format)
if result.get("ok"):
payload = {
"ok": True,
"action": action,
"path": document_store.display_path(result["path"]),
"document": self._public_doc(doc),
}
return self._json_response(payload, doc=doc, action=action)
return Response(
message=f"document_artifact export failed: {result.get('error')}",
break_loop=False,
additional=self._additional(doc, action=action),
)
return self._document_response("Document artifact export path is ready.", doc, action=action)
if action == "status":
return self._json_response({"ok": True, "action": action, "status": libreoffice.collect_status()}, action=action)
return Response(message=f"Unknown document_artifact action: {action}", break_loop=False)
except Exception as exc:
return Response(message=f"document_artifact {action} failed: {exc}", break_loop=False)
def get_log_object(self):
return self.agent.context.log.log(
type="tool",
heading=f"icon://description {self.agent.agent_name}: Using document artifact",
content="",
kvps={**self.args, "_tool_name": self.name},
_tool_name=self.name,
)
def _document_from_input(self, file_id: str = "", path: str = "") -> dict[str, Any]:
if file_id:
return document_store.get_document(file_id)
if path:
return document_store.register_document(path, context_id=self._context_id())
raise ValueError("file_id or path is required")
def _context_id(self) -> str:
return self.agent.context.id if self.agent and self.agent.context else ""
def _document_response(self, message: str, doc: dict[str, Any], action: str = "") -> Response:
payload = {"ok": True, "action": action, "message": message, "document": self._public_doc(doc)}
return Response(
message=json.dumps(payload, indent=2, ensure_ascii=False),
break_loop=False,
additional=self._additional(doc, action=action),
)
def _json_response(self, payload: dict[str, Any], doc: dict[str, Any] | None = None, action: str = "") -> Response:
return Response(
message=json.dumps(payload, indent=2, ensure_ascii=False, default=str),
break_loop=False,
additional=self._additional(doc, action=action) if doc else {"_tool_name": self.name, "canvas_surface": "office", "action": action},
)
def _additional(self, doc: dict[str, Any] | None, action: str = "") -> dict[str, Any]:
if not doc:
return {"_tool_name": self.name, "canvas_surface": "office", "action": action}
return {
"_tool_name": self.name,
"canvas_surface": "office",
"action": action,
"file_id": doc["file_id"],
"title": doc["basename"],
"format": doc["extension"],
"path": document_store.display_path(doc["path"]),
"version": document_store.item_version(doc),
}
def _public_doc(self, doc: dict[str, Any]) -> dict[str, Any]:
return {
"file_id": doc["file_id"],
"path": document_store.display_path(doc["path"]),
"basename": doc["basename"],
"extension": doc["extension"],
"size": doc["size"],
"version": document_store.item_version(doc),
"last_modified": doc["last_modified"],
"exists": Path(doc["path"]).exists(),
}