plugin_view.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323
  1. # coding=utf-8
  2. """
  3. 插件视图
  4. 提供插件的 CRUD API
  5. """
  6. from django.utils.translation import gettext as _
  7. from rest_framework.request import Request
  8. from rest_framework.views import APIView
  9. from common.auth import TokenAuth
  10. from common.exception.app_exception import AppApiException
  11. from common.result import result
  12. from plugin.services.plugin_registry import PluginRegistryService
  13. class PluginView(APIView):
  14. """插件管理"""
  15. authentication_classes = [TokenAuth]
  16. class List(APIView):
  17. """获取插件列表"""
  18. authentication_classes = [TokenAuth]
  19. def get(self, request: Request, workspace_id: str):
  20. plugin_type = request.query_params.get('plugin_type')
  21. status = request.query_params.get('status')
  22. is_installed = request.query_params.get('is_installed')
  23. if is_installed is not None:
  24. is_installed = is_installed == 'true'
  25. plugins = PluginRegistryService.get_plugins(
  26. workspace_id=workspace_id,
  27. plugin_type=plugin_type,
  28. status=status,
  29. is_installed=is_installed
  30. )
  31. data = [{
  32. 'id': str(p.id),
  33. 'name': p.name,
  34. 'code': p.code,
  35. 'desc': p.desc,
  36. 'plugin_type': p.plugin_type,
  37. 'status': p.status,
  38. 'version': p.version,
  39. 'author': p.author,
  40. 'icon': p.icon,
  41. 'is_installed': p.is_installed,
  42. 'install_time': p.install_time.isoformat() if p.install_time else None,
  43. 'create_time': p.create_time.isoformat() if p.create_time else None,
  44. } for p in plugins]
  45. return result.success(data)
  46. class Create(APIView):
  47. """创建插件"""
  48. authentication_classes = [TokenAuth]
  49. def post(self, request: Request, workspace_id: str):
  50. name = request.data.get('name', '')
  51. code = request.data.get('code', '')
  52. plugin_type = request.data.get('plugin_type', 'CUSTOM')
  53. desc = request.data.get('desc', '')
  54. version = request.data.get('version', '1.0.0')
  55. author = request.data.get('author', '')
  56. icon = request.data.get('icon', '')
  57. schema = request.data.get('schema', {})
  58. config = request.data.get('config', {})
  59. entry_point = request.data.get('entry_point', '')
  60. if not name or not code:
  61. raise AppApiException(400, _('插件名称和编码不能为空'))
  62. try:
  63. plugin = PluginRegistryService.register_plugin(
  64. workspace_id=workspace_id,
  65. name=name,
  66. code=code,
  67. plugin_type=plugin_type,
  68. desc=desc,
  69. version=version,
  70. author=author,
  71. icon=icon,
  72. schema=schema,
  73. config=config,
  74. entry_point=entry_point,
  75. user_id=str(request.user.id) if hasattr(request.user, 'id') else None
  76. )
  77. except ValueError as e:
  78. raise AppApiException(400, str(e))
  79. return result.success({
  80. 'id': str(plugin.id),
  81. 'name': plugin.name,
  82. 'code': plugin.code,
  83. 'desc': plugin.desc,
  84. 'plugin_type': plugin.plugin_type,
  85. 'status': plugin.status,
  86. 'version': plugin.version,
  87. 'author': plugin.author,
  88. 'icon': plugin.icon,
  89. 'is_installed': plugin.is_installed,
  90. 'create_time': plugin.create_time.isoformat() if plugin.create_time else None,
  91. })
  92. class Operate(APIView):
  93. """插件操作(更新/删除)"""
  94. authentication_classes = [TokenAuth]
  95. def get(self, request: Request, workspace_id: str, plugin_id: str):
  96. plugin = PluginRegistryService.get_plugin(plugin_id)
  97. if not plugin:
  98. raise AppApiException(404, _('插件不存在'))
  99. # 获取版本列表
  100. versions = PluginRegistryService.get_plugin_versions(plugin_id)
  101. version_list = [{
  102. 'id': str(v.id),
  103. 'version': v.version,
  104. 'status': v.status,
  105. 'changelog': v.changelog,
  106. 'is_rollback': v.is_rollback,
  107. 'create_time': v.create_time.isoformat() if v.create_time else None,
  108. } for v in versions]
  109. return result.success({
  110. 'id': str(plugin.id),
  111. 'name': plugin.name,
  112. 'code': plugin.code,
  113. 'desc': plugin.desc,
  114. 'plugin_type': plugin.plugin_type,
  115. 'status': plugin.status,
  116. 'version': plugin.version,
  117. 'author': plugin.author,
  118. 'icon': plugin.icon,
  119. 'schema': plugin.schema,
  120. 'config': plugin.config,
  121. 'entry_point': plugin.entry_point,
  122. 'is_installed': plugin.is_installed,
  123. 'install_time': plugin.install_time.isoformat() if plugin.install_time else None,
  124. 'create_time': plugin.create_time.isoformat() if plugin.create_time else None,
  125. 'versions': version_list,
  126. })
  127. def put(self, request: Request, workspace_id: str, plugin_id: str):
  128. name = request.data.get('name')
  129. desc = request.data.get('desc')
  130. plugin_type = request.data.get('plugin_type')
  131. author = request.data.get('author')
  132. icon = request.data.get('icon')
  133. schema = request.data.get('schema')
  134. config = request.data.get('config')
  135. entry_point = request.data.get('entry_point')
  136. plugin = PluginRegistryService.update_plugin(
  137. plugin_id=plugin_id,
  138. name=name,
  139. desc=desc,
  140. plugin_type=plugin_type,
  141. author=author,
  142. icon=icon,
  143. schema=schema,
  144. config=config,
  145. entry_point=entry_point
  146. )
  147. if not plugin:
  148. raise AppApiException(404, _('插件不存在'))
  149. return result.success({
  150. 'id': str(plugin.id),
  151. 'name': plugin.name,
  152. 'code': plugin.code,
  153. 'desc': plugin.desc,
  154. 'plugin_type': plugin.plugin_type,
  155. 'status': plugin.status,
  156. 'version': plugin.version,
  157. 'author': plugin.author,
  158. 'icon': plugin.icon,
  159. 'update_time': plugin.update_time.isoformat() if plugin.update_time else None,
  160. })
  161. def delete(self, request: Request, workspace_id: str, plugin_id: str):
  162. success = PluginRegistryService.delete_plugin(plugin_id)
  163. if not success:
  164. raise AppApiException(404, _('插件不存在'))
  165. return result.success(True)
  166. class Install(APIView):
  167. """安装/卸载插件"""
  168. authentication_classes = [TokenAuth]
  169. def post(self, request: Request, workspace_id: str, plugin_id: str):
  170. action = request.data.get('action', 'install')
  171. if action == 'install':
  172. plugin = PluginRegistryService.install_plugin(plugin_id)
  173. elif action == 'uninstall':
  174. plugin = PluginRegistryService.uninstall_plugin(plugin_id)
  175. else:
  176. raise AppApiException(400, _('无效的操作'))
  177. if not plugin:
  178. raise AppApiException(404, _('插件不存在'))
  179. return result.success({
  180. 'id': str(plugin.id),
  181. 'status': plugin.status,
  182. 'is_installed': plugin.is_installed,
  183. })
  184. class EnableDisable(APIView):
  185. """启用/禁用插件"""
  186. authentication_classes = [TokenAuth]
  187. def post(self, request: Request, workspace_id: str, plugin_id: str):
  188. action = request.data.get('action', 'enable')
  189. if action == 'enable':
  190. plugin = PluginRegistryService.enable_plugin(plugin_id)
  191. elif action == 'disable':
  192. plugin = PluginRegistryService.disable_plugin(plugin_id)
  193. else:
  194. raise AppApiException(400, _('无效的操作'))
  195. if not plugin:
  196. raise AppApiException(404, _('插件不存在'))
  197. return result.success({
  198. 'id': str(plugin.id),
  199. 'status': plugin.status,
  200. })
  201. class Version(APIView):
  202. """版本管理"""
  203. authentication_classes = [TokenAuth]
  204. def get(self, request: Request, workspace_id: str, plugin_id: str):
  205. versions = PluginRegistryService.get_plugin_versions(plugin_id)
  206. data = [{
  207. 'id': str(v.id),
  208. 'version': v.version,
  209. 'status': v.status,
  210. 'changelog': v.changelog,
  211. 'is_rollback': v.is_rollback,
  212. 'create_time': v.create_time.isoformat() if v.create_time else None,
  213. } for v in versions]
  214. return result.success(data)
  215. def post(self, request: Request, workspace_id: str, plugin_id: str):
  216. version = request.data.get('version', '')
  217. changelog = request.data.get('changelog', '')
  218. schema = request.data.get('schema')
  219. config = request.data.get('config')
  220. file_path = request.data.get('file_path', '')
  221. file_hash = request.data.get('file_hash', '')
  222. if not version:
  223. raise AppApiException(400, _('版本号不能为空'))
  224. plugin_version = PluginRegistryService.create_plugin_version(
  225. plugin_id=plugin_id,
  226. version=version,
  227. changelog=changelog,
  228. schema=schema,
  229. config=config,
  230. file_path=file_path,
  231. file_hash=file_hash
  232. )
  233. if not plugin_version:
  234. raise AppApiException(404, _('插件不存在'))
  235. return result.success({
  236. 'id': str(plugin_version.id),
  237. 'version': plugin_version.version,
  238. 'status': plugin_version.status,
  239. 'changelog': plugin_version.changelog,
  240. 'create_time': plugin_version.create_time.isoformat() if plugin_version.create_time else None,
  241. })
  242. class Rollback(APIView):
  243. """版本回滚"""
  244. authentication_classes = [TokenAuth]
  245. def post(self, request: Request, workspace_id: str, plugin_id: str, version_id: str):
  246. plugin = PluginRegistryService.rollback_plugin_version(plugin_id, version_id)
  247. if not plugin:
  248. raise AppApiException(404, _('插件或版本不存在'))
  249. return result.success({
  250. 'id': str(plugin.id),
  251. 'version': plugin.version,
  252. 'schema': plugin.schema,
  253. 'config': plugin.config,
  254. })
  255. class Search(APIView):
  256. """搜索插件"""
  257. authentication_classes = [TokenAuth]
  258. def get(self, request: Request, workspace_id: str):
  259. query = request.query_params.get('query', '')
  260. if not query:
  261. raise AppApiException(400, _('搜索关键词不能为空'))
  262. plugins = PluginRegistryService.search_plugins(workspace_id, query)
  263. data = [{
  264. 'id': str(p.id),
  265. 'name': p.name,
  266. 'code': p.code,
  267. 'desc': p.desc,
  268. 'plugin_type': p.plugin_type,
  269. 'status': p.status,
  270. 'version': p.version,
  271. 'author': p.author,
  272. 'icon': p.icon,
  273. 'is_installed': p.is_installed,
  274. } for p in plugins]
  275. return result.success(data)