plugin.py 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. from typing import Optional, List
  2. from datetime import datetime
  3. from pydantic import BaseModel, Field
  4. class PluginPublishRequest(BaseModel):
  5. name: str = Field(..., description="插件唯一英文标识,如: tls_plugin")
  6. version: str = Field(..., description="版本号,如: 1.0.1")
  7. display_name: Optional[str] = Field("", description="插件中文展示名")
  8. filename: Optional[str] = Field("", description="插件二进制脚本文件名,如 tls_plugin.py")
  9. class_name: Optional[str] = Field("", description="插件入口类名,如 TLSPlugin")
  10. protocol: Optional[str] = Field("IPlugin", description="插件协议标识,如 IPlugin")
  11. description: Optional[str] = Field("", description="插件功能描述")
  12. download_url: Optional[str] = Field(None, description="已有文件下载地址")
  13. sha256: Optional[str] = Field("", description="文件 SHA256 校验和")
  14. changelog: Optional[str] = Field(None, description="本次版本更新日志")
  15. set_as_latest: bool = Field(True, description="是否立即将该版本设为插件最新版本")
  16. developer_id: Optional[str] = Field(None, description="插件开发管理者ID")
  17. class PluginPublishOut(BaseModel):
  18. plugin_id: int
  19. name: str
  20. version: str
  21. download_url: str
  22. sha256: str
  23. class_name: Optional[str] = ""
  24. protocol: Optional[str] = "IPlugin"
  25. class PluginOut(BaseModel):
  26. id: int
  27. name: str
  28. display_name: str
  29. filename: str
  30. class_name: str = ""
  31. protocol: str = "IPlugin"
  32. latest_version: str
  33. description: str
  34. status: int
  35. developer_id: Optional[str] = None
  36. created_at: Optional[datetime] = None
  37. updated_at: Optional[datetime] = None
  38. class Config:
  39. from_attributes = True
  40. class PluginListResponse(BaseModel):
  41. list: List[PluginOut]
  42. total: int
  43. class PluginVersionOut(BaseModel):
  44. id: int
  45. version: str
  46. download_url: str
  47. sha256: str
  48. changelog: Optional[str] = None
  49. created_at: Optional[datetime] = None
  50. class Config:
  51. from_attributes = True
  52. class PluginDetailOut(BaseModel):
  53. id: int
  54. name: str
  55. display_name: str
  56. filename: str
  57. class_name: str = ""
  58. protocol: str = "IPlugin"
  59. latest_version: str
  60. description: str
  61. status: int
  62. developer_id: Optional[str] = None
  63. versions: List[PluginVersionOut] = []
  64. class Config:
  65. from_attributes = True
  66. class PluginUpdate(BaseModel):
  67. display_name: Optional[str] = Field(None, description="插件展示名")
  68. filename: Optional[str] = Field(None, description="插件脚本文件名")
  69. class_name: Optional[str] = Field(None, description="插件入口类名")
  70. protocol: Optional[str] = Field(None, description="插件协议标识")
  71. description: Optional[str] = Field(None, description="功能描述")
  72. status: Optional[int] = Field(None, description="状态: 1-启用, 0-停用")
  73. developer_id: Optional[str] = Field(None, description="插件开发管理者ID")
  74. class PluginSwitchVersion(BaseModel):
  75. plugin_id: int = Field(..., description="插件ID")
  76. version: str = Field(..., description="切换的目标版本号")
  77. class PluginUpgradeDispatch(BaseModel):
  78. target_node: str = Field("all", description="'all' 表示全量广播,或指定特定节点 node_id 如 'node01'")
  79. plugins: List[str] = Field(default_factory=list, description="指定升级的插件英文名列表;传空数组 [] 表示对所有启用的插件下发最新版")
  80. class PluginLatestItemOut(BaseModel):
  81. name: str
  82. display_name: str
  83. filename: str
  84. class_name: str = ""
  85. protocol: str = "IPlugin"
  86. version: str
  87. description: str
  88. download_url: str
  89. sha256: str
  90. changelog: Optional[str] = None