mcsmapi 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

mcsmapi/models/instance.py

@@ -1,148 +1,166 @@
-from typing import List, Dict, Optional
+from enum import IntEnum
 from pydantic import BaseModel
 from mcsmapi.models.file import FileList
 from mcsmapi.models.image import DockerConfig
 
 
+class CRLFType(IntEnum):
+    """换行符"""
+
+    LF = 0
+    CR = 1
+    CRLF = 2
+
+
+class Status(IntEnum):
+    """实例状态"""
+
+    BUSY = -1
+    STOP = 0
+    STOPPING = 1
+    STARTING = 2
+    RUNNING = 3
+
+
 class TerminalOption(BaseModel):
     """终端选项"""
 
-    """是否启用颜色输出"""
     haveColor: bool = False
-    """是否使用伪终端 (PTY)"""
+    """是否启用颜色输出"""
     pty: bool = True
+    """是否使用伪终端 (PTY)"""
 
 
 class EventTask(BaseModel):
     """事件任务"""
 
-    """是否自动启动"""
     autoStart: bool = False
-    """是否自动重启"""
+    """是否自动启动"""
     autoRestart: bool = True
-    """是否忽略该任务"""
+    """是否自动重启"""
     ignore: bool = False
+    """是否忽略该任务"""
 
 
 class PingConfig(BaseModel):
-    """服务器 Ping 配置"""
+    """服务器 Ping 配置(新版已弃用)"""
 
-    """服务器 IP 地址"""
     ip: str = ""
-    """服务器端口"""
+    """服务器 IP 地址"""
     port: int = 25565
-    """Ping 类型 (1: 默认类型)"""
+    """服务器端口"""
     type: int = 1
+    """Ping 类型 (1: 默认类型)"""
 
 
 class InstanceConfig(BaseModel):
     """实例配置信息"""
 
-    """实例名称"""
     nickname: str = "New Name"
-    """启动命令"""
+    """实例名称"""
     startCommand: str = "cmd.exe"
-    """停止命令"""
+    """启动命令"""
     stopCommand: str = "^C"
-    """工作目录"""
+    """停止命令"""
     cwd: str = ""
+    """工作目录"""
+    ie: str = "utf8"
     """输入编码"""
-    ie: str = "gbk"
+    oe: str = "utf8"
     """输出编码"""
-    oe: str = "gbk"
-    """创建时间 (Unix 时间戳)"""
     createDatetime: int = 0
-    """最后修改时间 (Unix 时间戳)"""
+    """创建时间 (Unix 时间戳)"""
     lastDatetime: int = 0
-    """实例类型 (universal, minecraft 等)"""
+    """最后修改时间 (Unix 时间戳)"""
     type: str = "universal"
+    """实例类型 (universal, minecraft 等)"""
+    tag: list[str] = []
     """实例标签"""
-    tag: List[str] = []
-    """实例结束时间 (可选)"""
-    endTime: Optional[int] = None
+    endTime: int | None = None
+    """实例到期时间"""
+    fileCode: str = "utf8"
     """文件编码"""
-    fileCode: str = "gbk"
-    """进程类型 (如 docker, local)"""
     processType: str = "docker"
-    """更新命令"""
+    """进程类型 (如 docker, local)"""
     updateCommand: str = "shutdown -s"
+    """更新命令"""
+    actionCommandList: list[str] = []
     """实例可执行的操作命令列表"""
-    actionCommandList: List[str] = []
-    """换行符 (0: LF, 1: CR, 2: CRLF)"""
-    crlf: int = 2
-    """Docker 相关配置"""
+    crlf: CRLFType = CRLFType.CRLF
+    """换行符"""
     docker: "DockerConfig" = DockerConfig()
-    """是否启用 RCON 远程控制"""
+    """Docker 相关配置"""
     enableRcon: bool = True
-    """RCON 连接密码"""
+    """是否启用 RCON 远程控制"""
     rconPassword: str = ""
-    """RCON 端口"""
+    """RCON 连接密码"""
     rconPort: int = 2557
-    """RCON IP 地址"""
+    """RCON 端口"""
     rconIp: str = ""
-    """终端选项配置"""
+    """RCON IP 地址"""
     terminalOption: TerminalOption = TerminalOption()
-    """事件任务配置"""
+    """终端选项配置"""
     eventTask: EventTask = EventTask()
-    """服务器 Ping 监测配置"""
+    """事件任务配置"""
     pingConfig: PingConfig = PingConfig()
+    """服务器 Ping 监测配置"""
+    runAs: str = ""
+    """运行该实例的系统用户，为空则使用启动面板的系统用户"""
 
 
 class ProcessInfo(BaseModel):
     """进程信息"""
 
+    cpu: int
     """CPU 使用率 (单位: %)"""
-    cpu: int = 0
+    memory: int
     """进程占用内存 (单位: KB)"""
-    memory: int = 0
+    ppid: int
     """父进程 ID"""
-    ppid: int = 0
+    pid: int
     """进程 ID"""
-    pid: int = 0
+    ctime: int
     """进程创建时间 (Unix 时间戳)"""
-    ctime: int = 0
+    elapsed: int
     """进程运行时长 (单位: 秒)"""
-    elapsed: int = 0
+    timestamp: int
     """时间戳"""
-    timestamp: int = 0
 
 
 class InstanceInfo(BaseModel):
-    """实例运行状态信息( 这些选项在新版中已不再支持设置，但仍在API中返回)"""
+    """实例运行状态信息(这些选项在新版中已不再支持设置，但仍在API中返回)"""
 
-    """当前玩家数量 (-1 表示未知)"""
-    currentPlayers: int = -1
-    """文件锁状态 (0: 无锁)"""
+    currentPlayers: int
+    """当前玩家数量"""
     fileLock: int = 0
-    """最大允许玩家数 (-1 表示未知)"""
+    """文件锁状态 (0: 无锁)"""
     maxPlayers: int = -1
-    """是否启用 FRP 远程服务"""
+    """最大允许玩家数 (-1 表示未知)"""
     openFrpStatus: bool = False
+    """是否启用 FRP 远程服务"""
+    playersChart: list[dict] = []
     """玩家数量变化图表数据"""
-    playersChart: List[Dict] = []
-    """服务器版本"""
     version: str = ""
+    """服务器版本"""
 
 
 class InstanceDetail(BaseModel):
     """实例详细信息"""
 
+    config: InstanceConfig
     """实例的配置信息"""
-    config: InstanceConfig = InstanceConfig()
+    info: InstanceInfo
     """实例的运行状态信息"""
-    info: InstanceInfo = InstanceInfo()
+    daemonId: str
     """所属的守护进程 (Daemon) ID"""
-    daemonId: str = ""
+    instanceUuid: str
     """实例唯一标识符 (UUID)"""
-    instanceUuid: str = ""
+    processInfo: ProcessInfo
     """实例的进程信息"""
-    processInfo: ProcessInfo = ProcessInfo()
-    """实例的存储空间大小(始终为`0`)"""
-    space: int = 0  # 在 MCSM 代码中，此项始终为 0，意义不明
+    started: int
     """实例的启动次数"""
-    started: int = 0
-    """实例状态 (-1: 忙碌, 0: 停止, 1: 停止中, 2: 启动中, 3: 运行中)"""
-    status: int = 0
+    status: Status
+    """实例状态"""
 
     def start(self) -> str | bool:
         """
@@ -153,7 +171,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().start(self.daemonId, self.instanceUuid)
+        return Instance.start(self.daemonId, self.instanceUuid)
 
     def stop(self) -> str | bool:
         """
@@ -164,7 +182,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().stop(self.daemonId, self.instanceUuid)
+        return Instance.stop(self.daemonId, self.instanceUuid)
 
     def restart(self) -> str | bool:
         """
@@ -175,7 +193,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().restart(self.daemonId, self.instanceUuid)
+        return Instance.restart(self.daemonId, self.instanceUuid)
 
     def kill(self) -> str | bool:
         """
@@ -186,7 +204,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().kill(self.daemonId, self.instanceUuid)
+        return Instance.kill(self.daemonId, self.instanceUuid)
 
     def delete(self, deleteFile=False) -> str:
         """
@@ -197,7 +215,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().delete(self.daemonId, [self.instanceUuid], deleteFile)[0]
+        return Instance.delete(self.daemonId, [self.instanceUuid], deleteFile)[0]
 
     def update(self) -> bool:
         """
@@ -208,7 +226,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().update(self.daemonId, self.instanceUuid)
+        return Instance.update(self.daemonId, self.instanceUuid)
 
     def updateConfig(self, config: dict) -> str | bool:
         """
@@ -222,14 +240,12 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        updated_config = self.config.dict()
+        updated_config = self.config.model_dump()
         updated_config.update(config)
 
-        instance_config = InstanceConfig(**updated_config).dict()
+        instance_config = InstanceConfig(**updated_config).model_dump()
 
-        return Instance().updateConfig(
-            self.daemonId, self.instanceUuid, instance_config
-        )
+        return Instance.updateConfig(self.daemonId, self.instanceUuid, instance_config)
 
     def reinstall(self, targetUrl: str, title: str = "", description: str = "") -> bool:
         """
@@ -245,7 +261,7 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().reinstall(
+        return Instance.reinstall(
             self.daemonId, self.instanceUuid, targetUrl, title, description
         )
 
@@ -263,29 +279,29 @@ class InstanceDetail(BaseModel):
         """
         from mcsmapi.apis.file import File
 
-        return File().show(self.daemonId, self.instanceUuid, target, page, page_size)
+        return File.show(self.daemonId, self.instanceUuid, target, page, page_size)
 
 
 class InstanceCreateResult(BaseModel):
     """实例创建结果"""
 
-    """实例唯一标识符 (UUID)"""
     instanceUuid: str = ""
-    """实例的配置信息"""
+    """实例唯一标识符 (UUID)"""
     config: InstanceConfig = InstanceConfig()
+    """实例的配置信息"""
 
 
 class InstanceSearchList(BaseModel):
     """实例搜索列表"""
 
-    """每页的实例数量"""
     pageSize: int = 0
-    """最大页数"""
+    """每页的实例数量"""
     maxPage: int = 0
+    """最大页数"""
+    data: list[InstanceDetail] = []
     """实例详细信息列表"""
-    data: List[InstanceDetail] = []
-    """所属的守护进程 (Daemon) ID"""
     daemonId: str = ""
+    """所属的守护进程 (Daemon) ID"""
 
     def __init__(self, **data: str):
         """实例化对象，并在每个实例中填充 daemonId"""
@@ -297,7 +313,7 @@ class InstanceSearchList(BaseModel):
 class UserInstancesList(BaseModel):
     """用户实例列表"""
 
-    """实例唯一标识符 (UUID)"""
     instanceUuid: str = ""
-    """所属的守护进程 (Daemon) ID"""
+    """实例唯一标识符 (UUID)"""
     daemonId: str = ""
+    """所属的守护进程 (Daemon) ID"""

mcsmapi/models/overview.py

@@ -1,112 +1,170 @@
-from typing import Dict, List, Optional
+from enum import Enum
+from typing import Literal
 from pydantic import BaseModel
+from mcsmapi.models.common import CpuMemChart, InstanceInfo, ProcessInfo
 from mcsmapi.models.daemon import DaemonModel
 
 
 class SystemUser(BaseModel):
     """系统用户信息"""
 
-    """用户 ID (UID)"""
     uid: int = 0
-    """用户组 ID (GID)"""
+    """用户 ID (UID)"""
     gid: int = 0
-    """用户名"""
+    """用户组 ID (GID)"""
     username: str = ""
-    """用户主目录"""
+    """用户名"""
     homedir: str = ""
-    """默认 Shell 解释器 (可选)"""
-    shell: Optional[str] = None
+    """用户主目录"""
+    shell: str | None = None
+    """默认 Shell 解释器"""
 
 
 class SystemInfo(BaseModel):
     """系统信息"""
 
-    """当前登录用户信息"""
     user: SystemUser = SystemUser()
-    """系统当前时间 (Unix 时间戳)"""
+    """当前登录用户信息"""
     time: int = 0
-    """系统总内存大小 (单位: 字节)"""
+    """系统当前时间 (Unix 时间戳)"""
     totalmem: int = 0
-    """系统空闲内存大小 (单位: 字节)"""
+    """系统总内存大小 (单位: 字节)"""
     freemem: int = 0
-    """操作系统类型"""
+    """系统空闲内存大小 (单位: 字节)"""
     type: str = ""
-    """操作系统版本"""
+    """操作系统类型"""
     version: str = ""
-    """系统节点名称"""
+    """操作系统版本"""
     node: str = ""
-    """主机名"""
+    """系统节点名称"""
     hostname: str = ""
+    """主机名"""
+    loadavg: list[float] = []
     """系统负载平均值 (过去 1、5、15 分钟)"""
-    loadavg: List[float] = []
-    """操作系统平台"""
     platform: str = ""
-    """系统发行版本信息"""
+    """操作系统平台"""
     release: str = ""
-    """系统运行时间 (单位: 秒)"""
+    """系统发行版本信息"""
     uptime: float = 0
-    """CPU 当前使用率 (单位: %)"""
+    """系统运行时间 (单位: 秒)"""
     cpu: float = 0
+    """CPU 当前使用率 (单位: %)"""
 
 
 class RecordInfo(BaseModel):
     """安全记录信息"""
 
-    """成功登录次数"""
     logined: int = 0
-    """非法访问次数"""
+    """成功登录次数"""
     illegalAccess: int = 0
-    """被封禁的 IP 数量"""
+    """非法访问次数"""
     banips: int = 0
-    """登录失败次数"""
+    """被封禁的 IP 数量"""
     loginFailed: int = 0
+    """登录失败次数"""
 
 
 class ChartInfo(BaseModel):
     """图表数据信息"""
 
-    """系统性能数据 (CPU/内存等)"""
-    system: List[Dict[str, float]] = []
-    """请求统计信息 (HTTP 请求数等)"""
-    request: List[Dict[str, int]] = []
-
-
-class ProcessInfo(BaseModel):
-    """进程信息"""
-
-    """CPU 使用率 (单位: %)"""
-    cpu: int = 0
-    """进程占用内存 (单位: KB)"""
-    memory: int = 0
-    """进程当前工作目录"""
-    cwd: str = ""
+    system: list[CpuMemChart]
+    """系统统计信息"""
+    request: list[InstanceInfo]
+    """实例统计信息"""
 
 
 class RemoteCountInfo(BaseModel):
     """远程守护进程统计信息"""
 
+    total: int
     """远程守护进程总数"""
-    total: int = 0
+    available: int
     """可用的远程守护进程数量"""
-    available: int = 0
 
 
 class OverviewModel(BaseModel):
     """系统概览信息"""
 
+    version: str
     """系统当前版本"""
-    version: str = ""
+    specifiedDaemonVersion: str
     """指定的守护进程 (Daemon) 版本"""
-    specifiedDaemonVersion: str = ""
+    system: SystemInfo
     """系统信息"""
-    system: SystemInfo = SystemInfo()
+    record: RecordInfo
     """安全访问记录"""
-    record: RecordInfo = RecordInfo()
+    process: ProcessInfo
     """进程状态信息"""
-    process: ProcessInfo = ProcessInfo()
+    chart: ChartInfo
     """系统与请求统计图表数据"""
-    chart: ChartInfo = ChartInfo()
+    remoteCount: RemoteCountInfo
     """远程守护进程统计信息"""
-    remoteCount: RemoteCountInfo = RemoteCountInfo()
+    remote: list[DaemonModel]
     """远程守护进程详细信息"""
-    remote: List["DaemonModel"] = []
+
+
+class LogType(Enum):
+    """操作类型"""
+
+    # 系统相关
+    SYSTEM_CONFIG_CHANGE = "system_config_change"
+
+    # 用户相关
+    USER_LOGIN = "user_login"
+    USER_CONFIG_CHANGE = "user_config_change"
+    USER_DELETE = "user_delete"
+    USER_CREATE = "user_create"
+
+    # 守护进程相关
+    DAEMON_CONFIG_CHANGE = "daemon_config_change"
+    DAEMON_REMOVE = "daemon_remove"
+    DAEMON_CREATE = "daemon_create"
+
+    # 实例任务相关
+    INSTANCE_TASK_DELETE = "instance_task_delete"
+    INSTANCE_TASK_CREATE = "instance_task_create"
+
+    # 实例文件相关
+    INSTANCE_FILE_DELETE = "instance_file_delete"
+    INSTANCE_FILE_DOWNLOAD = "instance_file_download"
+    INSTANCE_FILE_UPDATE = "instance_file_update"
+    INSTANCE_FILE_UPLOAD = "instance_file_upload"
+
+    # 实例操作相关
+    INSTANCE_DELETE = "instance_delete"
+    INSTANCE_CREATE = "instance_create"
+    INSTANCE_CONFIG_CHANGE = "instance_config_change"
+    INSTANCE_KILL = "instance_kill"
+    INSTANCE_UPDATE = "instance_update"
+    INSTANCE_RESTART = "instance_restart"
+    INSTANCE_STOP = "instance_stop"
+    INSTANCE_START = "instance_start"
+
+
+class LogDetail(BaseModel):
+    """操作日志详情"""
+
+    operation_id: str
+    """操作者uuid"""
+    operator_name: str | None = None
+    """操作者用户名"""
+    operation_time: str
+    """操作时间戳"""
+    operator_ip: str
+    """操作者ip"""
+    operation_level: Literal["info", "warning", "error", "unknown"]
+    """日志等级"""
+    type: LogType
+    """操作类型"""
+    instance_name: str | None = None
+    """实例名称(仅实例事件存在)"""
+    instance_id: str | None = None
+    """实例ID(仅实例事件存在)"""
+    daemon_id: str | None = None
+    """守护进程ID(仅实例事件和守护进程事件存在)"""
+    login_result: bool | None = None
+    """登录结果(仅登录事件存在)"""
+    file: str | None = None
+    """文件名(仅文件操作事件存在)"""
+    task_name: str | None = None
+    """任务名称(仅任务操作事件存在)"""