AstrBot 4.11.3__py3-none-any.whl → 4.12.0__py3-none-any.whl

astrbot/core/sandbox/booters/boxlite.py

@@ -0,0 +1,186 @@
+import asyncio
+import random
+from typing import Any
+
+import aiohttp
+import boxlite
+from shipyard.filesystem import FileSystemComponent as ShipyardFileSystemComponent
+from shipyard.python import PythonComponent as ShipyardPythonComponent
+from shipyard.shell import ShellComponent as ShipyardShellComponent
+
+from astrbot.api import logger
+
+from ..olayer import FileSystemComponent, PythonComponent, ShellComponent
+from .base import SandboxBooter
+
+
+class MockShipyardSandboxClient:
+    def __init__(self, sb_url: str) -> None:
+        self.sb_url = sb_url.rstrip("/")
+
+    async def _exec_operation(
+        self,
+        ship_id: str,
+        operation_type: str,
+        payload: dict[str, Any],
+        session_id: str,
+    ) -> dict[str, Any]:
+        async with aiohttp.ClientSession() as session:
+            headers = {"X-SESSION-ID": session_id}
+            async with session.post(
+                f"{self.sb_url}/{operation_type}",
+                json=payload,
+                headers=headers,
+            ) as response:
+                if response.status == 200:
+                    return await response.json()
+                else:
+                    error_text = await response.text()
+                    raise Exception(
+                        f"Failed to exec operation: {response.status} {error_text}"
+                    )
+
+    async def upload_file(self, path: str, remote_path: str) -> dict:
+        """Upload a file to the sandbox"""
+        url = f"http://{self.sb_url}/upload"
+
+        try:
+            # Read file content
+            with open(path, "rb") as f:
+                file_content = f.read()
+
+            # Create multipart form data
+            data = aiohttp.FormData()
+            data.add_field(
+                "file",
+                file_content,
+                filename=remote_path.split("/")[-1],
+                content_type="application/octet-stream",
+            )
+            data.add_field("file_path", remote_path)
+
+            timeout = aiohttp.ClientTimeout(total=120)  # 2 minutes for file upload
+
+            async with aiohttp.ClientSession(timeout=timeout) as session:
+                async with session.post(url, data=data) as response:
+                    if response.status == 200:
+                        return {
+                            "success": True,
+                            "message": "File uploaded successfully",
+                            "file_path": remote_path,
+                        }
+                    else:
+                        error_text = await response.text()
+                        return {
+                            "success": False,
+                            "error": f"Server returned {response.status}: {error_text}",
+                            "message": "File upload failed",
+                        }
+
+        except aiohttp.ClientError as e:
+            logger.error(f"Failed to upload file: {e}")
+            return {
+                "success": False,
+                "error": f"Connection error: {str(e)}",
+                "message": "File upload failed",
+            }
+        except asyncio.TimeoutError:
+            return {
+                "success": False,
+                "error": "File upload timeout",
+                "message": "File upload failed",
+            }
+        except FileNotFoundError:
+            logger.error(f"File not found: {path}")
+            return {
+                "success": False,
+                "error": f"File not found: {path}",
+                "message": "File upload failed",
+            }
+        except Exception as e:
+            logger.error(f"Unexpected error uploading file: {e}")
+            return {
+                "success": False,
+                "error": f"Internal error: {str(e)}",
+                "message": "File upload failed",
+            }
+
+    async def wait_healthy(self, ship_id: str, session_id: str) -> None:
+        """Mock wait healthy"""
+        loop = 60
+        while loop > 0:
+            try:
+                logger.info(
+                    f"Checking health for sandbox {ship_id} on {self.sb_url}..."
+                )
+                url = f"{self.sb_url}/health"
+                async with aiohttp.ClientSession() as session:
+                    async with session.get(url) as response:
+                        if response.status == 200:
+                            logger.info(f"Sandbox {ship_id} is healthy")
+                return
+            except Exception:
+                await asyncio.sleep(1)
+                loop -= 1
+
+
+class BoxliteBooter(SandboxBooter):
+    async def boot(self, session_id: str) -> None:
+        logger.info(
+            f"Booting(Boxlite) for session: {session_id}, this may take a while..."
+        )
+        random_port = random.randint(20000, 30000)
+        self.box = boxlite.SimpleBox(
+            image="soulter/shipyard-ship",
+            memory_mib=512,
+            cpus=1,
+            ports=[
+                {
+                    "host_port": random_port,
+                    "guest_port": 8123,
+                }
+            ],
+        )
+        await self.box.start()
+        logger.info(f"Boxlite booter started for session: {session_id}")
+        self.mocked = MockShipyardSandboxClient(
+            sb_url=f"http://127.0.0.1:{random_port}"
+        )
+        self._fs = ShipyardFileSystemComponent(
+            client=self.mocked,  # type: ignore
+            ship_id=self.box.id,
+            session_id=session_id,
+        )
+        self._python = ShipyardPythonComponent(
+            client=self.mocked,  # type: ignore
+            ship_id=self.box.id,
+            session_id=session_id,
+        )
+        self._shell = ShipyardShellComponent(
+            client=self.mocked,  # type: ignore
+            ship_id=self.box.id,
+            session_id=session_id,
+        )
+
+        await self.mocked.wait_healthy(self.box.id, session_id)
+
+    async def shutdown(self) -> None:
+        logger.info(f"Shutting down Boxlite booter for ship: {self.box.id}")
+        self.box.shutdown()
+        logger.info(f"Boxlite booter for ship: {self.box.id} stopped")
+
+    @property
+    def fs(self) -> FileSystemComponent:
+        return self._fs
+
+    @property
+    def python(self) -> PythonComponent:
+        return self._python
+
+    @property
+    def shell(self) -> ShellComponent:
+        return self._shell
+
+    async def upload_file(self, path: str, file_name: str) -> dict:
+        """Upload file to sandbox"""
+        return await self.mocked.upload_file(path, file_name)

astrbot/core/sandbox/booters/shipyard.py

@@ -0,0 +1,67 @@
+from shipyard import ShipyardClient, Spec
+
+from astrbot.api import logger
+
+from ..olayer import FileSystemComponent, PythonComponent, ShellComponent
+from .base import SandboxBooter
+
+
+class ShipyardBooter(SandboxBooter):
+    def __init__(
+        self,
+        endpoint_url: str,
+        access_token: str,
+        ttl: int = 3600,
+        session_num: int = 10,
+    ) -> None:
+        self._sandbox_client = ShipyardClient(
+            endpoint_url=endpoint_url, access_token=access_token
+        )
+        self._ttl = ttl
+        self._session_num = session_num
+
+    async def boot(self, session_id: str) -> None:
+        ship = await self._sandbox_client.create_ship(
+            ttl=self._ttl,
+            spec=Spec(cpus=1.0, memory="512m"),
+            max_session_num=self._session_num,
+            session_id=session_id,
+        )
+        logger.info(f"Got sandbox ship: {ship.id} for session: {session_id}")
+        self._ship = ship
+
+    async def shutdown(self) -> None:
+        pass
+
+    @property
+    def fs(self) -> FileSystemComponent:
+        return self._ship.fs
+
+    @property
+    def python(self) -> PythonComponent:
+        return self._ship.python
+
+    @property
+    def shell(self) -> ShellComponent:
+        return self._ship.shell
+
+    async def upload_file(self, path: str, file_name: str) -> dict:
+        """Upload file to sandbox"""
+        return await self._ship.upload_file(path, file_name)
+
+    async def download_file(self, remote_path: str, local_path: str):
+        """Download file from sandbox."""
+        return await self._ship.download_file(remote_path, local_path)
+
+    async def available(self) -> bool:
+        """Check if the sandbox is available."""
+        try:
+            ship_id = self._ship.id
+            data = await self._sandbox_client.get_ship(ship_id)
+            if not data:
+                return False
+            health = bool(data.get("status", 0) == 1)
+            return health
+        except Exception as e:
+            logger.error(f"Error checking Shipyard sandbox availability: {e}")
+            return False

astrbot/core/sandbox/olayer/__init__.py

@@ -0,0 +1,5 @@
+from .filesystem import FileSystemComponent
+from .python import PythonComponent
+from .shell import ShellComponent
+
+__all__ = ["PythonComponent", "ShellComponent", "FileSystemComponent"]

astrbot/core/sandbox/olayer/filesystem.py

@@ -0,0 +1,33 @@
+"""
+File system component
+"""
+
+from typing import Any, Protocol
+
+
+class FileSystemComponent(Protocol):
+    async def create_file(
+        self, path: str, content: str = "", mode: int = 0o644
+    ) -> dict[str, Any]:
+        """Create a file with the specified content"""
+        ...
+
+    async def read_file(self, path: str, encoding: str = "utf-8") -> dict[str, Any]:
+        """Read file content"""
+        ...
+
+    async def write_file(
+        self, path: str, content: str, mode: str = "w", encoding: str = "utf-8"
+    ) -> dict[str, Any]:
+        """Write content to file"""
+        ...
+
+    async def delete_file(self, path: str) -> dict[str, Any]:
+        """Delete file or directory"""
+        ...
+
+    async def list_dir(
+        self, path: str = ".", show_hidden: bool = False
+    ) -> dict[str, Any]:
+        """List directory contents"""
+        ...

astrbot/core/sandbox/olayer/python.py

@@ -0,0 +1,19 @@
+"""
+Python/IPython component
+"""
+
+from typing import Any, Protocol
+
+
+class PythonComponent(Protocol):
+    """Python/IPython operations component"""
+
+    async def exec(
+        self,
+        code: str,
+        kernel_id: str | None = None,
+        timeout: int = 30,
+        silent: bool = False,
+    ) -> dict[str, Any]:
+        """Execute Python code"""
+        ...

astrbot/core/sandbox/olayer/shell.py

@@ -0,0 +1,21 @@
+"""
+Shell component
+"""
+
+from typing import Any, Protocol
+
+
+class ShellComponent(Protocol):
+    """Shell operations component"""
+
+    async def exec(
+        self,
+        command: str,
+        cwd: str | None = None,
+        env: dict[str, str] | None = None,
+        timeout: int | None = 30,
+        shell: bool = True,
+        background: bool = False,
+    ) -> dict[str, Any]:
+        """Execute shell command"""
+        ...

astrbot/core/sandbox/sandbox_client.py

@@ -0,0 +1,52 @@
+import uuid
+
+from astrbot.api import logger
+from astrbot.core.star.context import Context
+
+from .booters.base import SandboxBooter
+
+session_booter: dict[str, SandboxBooter] = {}
+
+
+async def get_booter(
+    context: Context,
+    session_id: str,
+) -> SandboxBooter:
+    config = context.get_config(umo=session_id)
+
+    sandbox_cfg = config.get("provider_settings", {}).get("sandbox", {})
+    booter_type = sandbox_cfg.get("booter", "shipyard")
+
+    if session_id in session_booter:
+        booter = session_booter[session_id]
+        if not await booter.available():
+            # rebuild
+            session_booter.pop(session_id, None)
+    if session_id not in session_booter:
+        uuid_str = uuid.uuid5(uuid.NAMESPACE_DNS, session_id).hex
+        if booter_type == "shipyard":
+            from .booters.shipyard import ShipyardBooter
+
+            ep = sandbox_cfg.get("shipyard_endpoint", "")
+            token = sandbox_cfg.get("shipyard_access_token", "")
+            ttl = sandbox_cfg.get("shipyard_ttl", 3600)
+            max_sessions = sandbox_cfg.get("shipyard_max_sessions", 10)
+
+            client = ShipyardBooter(
+                endpoint_url=ep, access_token=token, ttl=ttl, session_num=max_sessions
+            )
+        elif booter_type == "boxlite":
+            from .booters.boxlite import BoxliteBooter
+
+            client = BoxliteBooter()
+        else:
+            raise ValueError(f"Unknown booter type: {booter_type}")
+
+        try:
+            await client.boot(uuid_str)
+        except Exception as e:
+            logger.error(f"Error booting sandbox for session {session_id}: {e}")
+            raise e
+
+        session_booter[session_id] = client
+    return session_booter[session_id]

astrbot/core/sandbox/tools/__init__.py

@@ -0,0 +1,10 @@
+from .fs import FileDownloadTool, FileUploadTool
+from .python import PythonTool
+from .shell import ExecuteShellTool
+
+__all__ = [
+    "FileUploadTool",
+    "PythonTool",
+    "ExecuteShellTool",
+    "FileDownloadTool",
+]

astrbot/core/sandbox/tools/fs.py

@@ -0,0 +1,188 @@
+import os
+from dataclasses import dataclass, field
+
+from astrbot.api import FunctionTool, logger
+from astrbot.api.event import MessageChain
+from astrbot.core.agent.run_context import ContextWrapper
+from astrbot.core.agent.tool import ToolExecResult
+from astrbot.core.astr_agent_context import AstrAgentContext
+from astrbot.core.message.components import File
+from astrbot.core.utils.astrbot_path import get_astrbot_temp_path
+
+from ..sandbox_client import get_booter
+
+# @dataclass
+# class CreateFileTool(FunctionTool):
+#     name: str = "astrbot_create_file"
+#     description: str = "Create a new file in the sandbox."
+#     parameters: dict = field(
+#         default_factory=lambda: {
+#             "type": "object",
+#             "properties": {
+#                 "path": {
+#                     "path": "string",
+#                     "description": "The path where the file should be created, relative to the sandbox root. Must not use absolute paths or traverse outside the sandbox.",
+#                 },
+#                 "content": {
+#                     "type": "string",
+#                     "description": "The content to write into the file.",
+#                 },
+#             },
+#             "required": ["path", "content"],
+#         }
+#     )
+
+#     async def call(
+#         self, context: ContextWrapper[AstrAgentContext], path: str, content: str
+#     ) -> ToolExecResult:
+#         sb = await get_booter(
+#             context.context.context,
+#             context.context.event.unified_msg_origin,
+#         )
+#         try:
+#             result = await sb.fs.create_file(path, content)
+#             return json.dumps(result)
+#         except Exception as e:
+#             return f"Error creating file: {str(e)}"
+
+
+# @dataclass
+# class ReadFileTool(FunctionTool):
+#     name: str = "astrbot_read_file"
+#     description: str = "Read the content of a file in the sandbox."
+#     parameters: dict = field(
+#         default_factory=lambda: {
+#             "type": "object",
+#             "properties": {
+#                 "path": {
+#                     "type": "string",
+#                     "description": "The path of the file to read, relative to the sandbox root. Must not use absolute paths or traverse outside the sandbox.",
+#                 },
+#             },
+#             "required": ["path"],
+#         }
+#     )
+
+#     async def call(self, context: ContextWrapper[AstrAgentContext], path: str):
+#         sb = await get_booter(
+#             context.context.context,
+#             context.context.event.unified_msg_origin,
+#         )
+#         try:
+#             result = await sb.fs.read_file(path)
+#             return result
+#         except Exception as e:
+#             return f"Error reading file: {str(e)}"
+
+
+@dataclass
+class FileUploadTool(FunctionTool):
+    name: str = "astrbot_upload_file"
+    description: str = "Upload a local file to the sandbox. The file must exist on the local filesystem."
+    parameters: dict = field(
+        default_factory=lambda: {
+            "type": "object",
+            "properties": {
+                "local_path": {
+                    "type": "string",
+                    "description": "The local file path to upload. This must be an absolute path to an existing file on the local filesystem.",
+                },
+                # "remote_path": {
+                #     "type": "string",
+                #     "description": "The filename to use in the sandbox. If not provided, file will be saved to the working directory with the same name as the local file.",
+                # },
+            },
+            "required": ["local_path"],
+        }
+    )
+
+    async def call(
+        self,
+        context: ContextWrapper[AstrAgentContext],
+        local_path: str,
+    ):
+        sb = await get_booter(
+            context.context.context,
+            context.context.event.unified_msg_origin,
+        )
+        try:
+            # Check if file exists
+            if not os.path.exists(local_path):
+                return f"Error: File does not exist: {local_path}"
+
+            if not os.path.isfile(local_path):
+                return f"Error: Path is not a file: {local_path}"
+
+            # Use basename if sandbox_filename is not provided
+            remote_path = os.path.basename(local_path)
+
+            # Upload file to sandbox
+            result = await sb.upload_file(local_path, remote_path)
+            logger.debug(f"Upload result: {result}")
+            success = result.get("success", False)
+
+            if not success:
+                return f"Error uploading file: {result.get('message', 'Unknown error')}"
+
+            file_path = result.get("file_path", "")
+            logger.info(f"File {local_path} uploaded to sandbox at {file_path}")
+
+            return f"File uploaded successfully to {file_path}"
+        except Exception as e:
+            logger.error(f"Error uploading file {local_path}: {e}")
+            return f"Error uploading file: {str(e)}"
+
+
+@dataclass
+class FileDownloadTool(FunctionTool):
+    name: str = "astrbot_download_file"
+    description: str = "Download a file from the sandbox. Only call this when user explicitly need you to download a file."
+    parameters: dict = field(
+        default_factory=lambda: {
+            "type": "object",
+            "properties": {
+                "remote_path": {
+                    "type": "string",
+                    "description": "The path of the file in the sandbox to download.",
+                }
+            },
+            "required": ["remote_path"],
+        }
+    )
+
+    async def call(
+        self,
+        context: ContextWrapper[AstrAgentContext],
+        remote_path: str,
+    ) -> ToolExecResult:
+        sb = await get_booter(
+            context.context.context,
+            context.context.event.unified_msg_origin,
+        )
+        try:
+            name = os.path.basename(remote_path)
+
+            local_path = os.path.join(get_astrbot_temp_path(), name)
+
+            # Download file from sandbox
+            await sb.download_file(remote_path, local_path)
+            logger.info(f"File {remote_path} downloaded from sandbox to {local_path}")
+
+            try:
+                name = os.path.basename(local_path)
+                await context.context.event.send(
+                    MessageChain(chain=[File(name=name, file=local_path)])
+                )
+            except Exception as e:
+                logger.error(f"Error sending file message: {e}")
+
+            # remove
+            try:
+                os.remove(local_path)
+            except Exception as e:
+                logger.error(f"Error removing temp file {local_path}: {e}")
+
+            return f"File downloaded successfully to {local_path}"
+        except Exception as e:
+            logger.error(f"Error downloading file {remote_path}: {e}")
+            return f"Error downloading file: {str(e)}"

astrbot/core/sandbox/tools/python.py

@@ -0,0 +1,74 @@
+from dataclasses import dataclass, field
+
+import mcp
+
+from astrbot.api import FunctionTool
+from astrbot.core.agent.run_context import ContextWrapper
+from astrbot.core.agent.tool import ToolExecResult
+from astrbot.core.astr_agent_context import AstrAgentContext
+from astrbot.core.sandbox.sandbox_client import get_booter
+
+
+@dataclass
+class PythonTool(FunctionTool):
+    name: str = "astrbot_execute_ipython"
+    description: str = "Execute a command in an IPython shell."
+    parameters: dict = field(
+        default_factory=lambda: {
+            "type": "object",
+            "properties": {
+                "code": {
+                    "type": "string",
+                    "description": "The Python code to execute.",
+                },
+                "silent": {
+                    "type": "boolean",
+                    "description": "Whether to suppress the output of the code execution.",
+                    "default": False,
+                },
+            },
+            "required": ["code"],
+        }
+    )
+
+    async def call(
+        self, context: ContextWrapper[AstrAgentContext], code: str, silent: bool = False
+    ) -> ToolExecResult:
+        sb = await get_booter(
+            context.context.context,
+            context.context.event.unified_msg_origin,
+        )
+        try:
+            result = await sb.python.exec(code, silent=silent)
+            data = result.get("data", {})
+            output = data.get("output", {})
+            error = data.get("error", "")
+            images: list[dict] = output.get("images", [])
+            text: str = output.get("text", "")
+
+            resp = mcp.types.CallToolResult(content=[])
+
+            if error:
+                resp.content.append(
+                    mcp.types.TextContent(type="text", text=f"error: {error}")
+                )
+
+            if images:
+                for img in images:
+                    resp.content.append(
+                        mcp.types.ImageContent(
+                            type="image", data=img["image/png"], mimeType="image/png"
+                        )
+                    )
+            if text:
+                resp.content.append(mcp.types.TextContent(type="text", text=text))
+
+            if not resp.content:
+                resp.content.append(
+                    mcp.types.TextContent(type="text", text="No output.")
+                )
+
+            return resp
+
+        except Exception as e:
+            return f"Error executing code: {str(e)}"