plugin_tools.py 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. # app/services/agent/tools/builtin/plugin_tools.py
  2. from typing import Optional, Dict, Any, List
  3. from sqlalchemy.ext.asyncio import AsyncSession
  4. from sqlalchemy import select
  5. from app.models.user import VasUser
  6. from app.models.plugin import Plugin
  7. from app.schemas.plugin import PluginUpdate
  8. from app.services.plugin_service import PluginService
  9. from app.services.agent.tools.registry import agent_tool
  10. ADMIN_CHECK_MSG = "Permission denied: This operation is restricted to system administrators (admin)"
  11. @agent_tool(
  12. name="list_plugins",
  13. description="查询当前系统注册的爬虫插件列表,包含插件名、最新版本号与启用状态(管理员专有)",
  14. )
  15. async def list_plugins(
  16. status: Optional[int] = None,
  17. page: int = 1,
  18. page_size: int = 20,
  19. *,
  20. db: AsyncSession,
  21. current_user: VasUser,
  22. ) -> Dict[str, Any]:
  23. """查询插件列表"""
  24. if current_user.role != "admin":
  25. return {"error": ADMIN_CHECK_MSG}
  26. try:
  27. res = await PluginService.get_plugin_list(
  28. db=db,
  29. page=page,
  30. page_size=min(page_size, 50),
  31. status=status,
  32. )
  33. items = []
  34. for p in res.get("list", []):
  35. items.append({
  36. "id": p.id,
  37. "name": p.name,
  38. "display_name": p.display_name,
  39. "filename": p.filename,
  40. "latest_version": p.latest_version,
  41. "description": p.description,
  42. "status": p.status,
  43. "status_cn": "已启用" if p.status == 1 else "已停用",
  44. })
  45. return {
  46. "total": res.get("total", len(items)),
  47. "plugins": items,
  48. }
  49. except Exception as e:
  50. return {"error": f"Failed to query plugin list: {str(e)}"}
  51. @agent_tool(
  52. name="get_plugin_detail",
  53. description="获取指定插件的完整信息及所有发布历史版本与更新日志(管理员专有)",
  54. )
  55. async def get_plugin_detail(
  56. plugin_id: Optional[int] = None,
  57. plugin_name: Optional[str] = None,
  58. *,
  59. db: AsyncSession,
  60. current_user: VasUser,
  61. ) -> Dict[str, Any]:
  62. """获取单个插件详情"""
  63. if current_user.role != "admin":
  64. return {"error": ADMIN_CHECK_MSG}
  65. try:
  66. target_id = plugin_id
  67. if target_id is None and plugin_name:
  68. stmt = select(Plugin.id).where(Plugin.name == plugin_name.strip())
  69. target_id = (await db.execute(stmt)).scalar_one_or_none()
  70. if not target_id:
  71. return {"error": f"Plugin not found: id={plugin_id}, name={plugin_name}"}
  72. detail = await PluginService.get_plugin_detail(db, target_id)
  73. versions_info = []
  74. for v in detail.get("versions", []):
  75. versions_info.append({
  76. "version": v.version,
  77. "download_url": v.download_url,
  78. "sha256": v.sha256[:16] + "..." if v.sha256 else "",
  79. "changelog": v.changelog,
  80. "created_at": v.created_at.strftime("%Y-%m-%d %H:%M:%S") if v.created_at else None,
  81. })
  82. return {
  83. "id": detail["id"],
  84. "name": detail["name"],
  85. "display_name": detail["display_name"],
  86. "latest_version": detail["latest_version"],
  87. "status": detail["status"],
  88. "description": detail["description"],
  89. "versions_count": len(versions_info),
  90. "versions": versions_info,
  91. }
  92. except Exception as e:
  93. return {"error": f"Failed to get plugin details: {str(e)}"}
  94. @agent_tool(
  95. name="toggle_plugin_status",
  96. description="一键启用(status=1)或停用(status=0)指定插件(管理员专有)",
  97. is_dangerous=True,
  98. )
  99. async def toggle_plugin_status(
  100. plugin_id: Optional[int] = None,
  101. plugin_name: Optional[str] = None,
  102. status: int = 1,
  103. *,
  104. db: AsyncSession,
  105. current_user: VasUser,
  106. ) -> Dict[str, Any]:
  107. """启停插件"""
  108. if current_user.role != "admin":
  109. return {"error": ADMIN_CHECK_MSG}
  110. try:
  111. target_id = plugin_id
  112. if target_id is None and plugin_name:
  113. stmt = select(Plugin.id).where(Plugin.name == plugin_name.strip())
  114. target_id = (await db.execute(stmt)).scalar_one_or_none()
  115. if not target_id:
  116. return {"error": f"Plugin not found: id={plugin_id}, name={plugin_name}"}
  117. clean_status = 1 if status == 1 else 0
  118. updated = await PluginService.update_plugin(
  119. db=db,
  120. plugin_id=target_id,
  121. plugin_in=PluginUpdate(status=clean_status),
  122. )
  123. return {
  124. "success": True,
  125. "plugin_id": updated.id,
  126. "name": updated.name,
  127. "status": updated.status,
  128. "message": f"Plugin {updated.name} has been successfully {'enabled' if clean_status == 1 else 'disabled'}",
  129. }
  130. except Exception as e:
  131. return {"error": f"Failed to toggle plugin status: {str(e)}"}
  132. @agent_tool(
  133. name="switch_plugin_version",
  134. description="一键切换/回滚插件的当前生效版本号(管理员专有)",
  135. is_dangerous=True,
  136. )
  137. async def switch_plugin_version(
  138. version: str,
  139. plugin_id: Optional[int] = None,
  140. plugin_name: Optional[str] = None,
  141. *,
  142. db: AsyncSession,
  143. current_user: VasUser,
  144. ) -> Dict[str, Any]:
  145. """切换插件生效版本"""
  146. if current_user.role != "admin":
  147. return {"error": ADMIN_CHECK_MSG}
  148. try:
  149. target_id = plugin_id
  150. if target_id is None and plugin_name:
  151. stmt = select(Plugin.id).where(Plugin.name == plugin_name.strip())
  152. target_id = (await db.execute(stmt)).scalar_one_or_none()
  153. if not target_id:
  154. return {"error": f"Plugin not found: id={plugin_id}, name={plugin_name}"}
  155. plugin = await PluginService.switch_version(db, target_id, version.strip())
  156. return {
  157. "success": True,
  158. "plugin_id": plugin.id,
  159. "name": plugin.name,
  160. "current_version": plugin.latest_version,
  161. "message": f"Plugin {plugin.name} active version switched to {version}",
  162. }
  163. except Exception as e:
  164. return {"error": f"Failed to switch plugin version: {str(e)}"}