app.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402
  1. import uuid
  2. from typing import cast
  3. from flask import jsonify, request
  4. from flask_login import current_user # type: ignore
  5. from flask_restful import Resource, inputs, marshal, marshal_with, reqparse # type: ignore
  6. from sqlalchemy import select
  7. from sqlalchemy.orm import Session
  8. from werkzeug.exceptions import BadRequest, Forbidden, NotFound, abort
  9. from controllers.console import api
  10. from controllers.console.app.wraps import get_app_model
  11. from controllers.console.wraps import (
  12. account_initialization_required,
  13. cloud_edition_billing_resource_check,
  14. enterprise_license_required,
  15. setup_required,
  16. )
  17. from core.ops.ops_trace_manager import OpsTraceManager
  18. from extensions.ext_database import db
  19. from fields.app_fields import (
  20. app_detail_fields,
  21. app_detail_fields_with_site,
  22. app_pagination_fields,
  23. )
  24. from libs.login import login_required
  25. from models import Account, App
  26. from services.app_dsl_service import AppDslService, ImportMode
  27. from services.app_service import AppService
  28. ALLOW_CREATE_APP_MODES = ["chat", "agent-chat", "advanced-chat", "workflow", "completion"]
  29. class AppListApi(Resource):
  30. @setup_required
  31. @login_required
  32. @account_initialization_required
  33. @enterprise_license_required
  34. def get(self):
  35. """Get app list"""
  36. def uuid_list(value):
  37. try:
  38. return [str(uuid.UUID(v)) for v in value.split(",")]
  39. except ValueError:
  40. abort(400, message="Invalid UUID format in tag_ids.")
  41. parser = reqparse.RequestParser()
  42. parser.add_argument("page", type=inputs.int_range(1, 99999), required=False, default=1, location="args")
  43. parser.add_argument("limit", type=inputs.int_range(1, 100), required=False, default=20, location="args")
  44. parser.add_argument(
  45. "mode",
  46. type=str,
  47. choices=[
  48. "completion",
  49. "chat",
  50. "advanced-chat",
  51. "workflow",
  52. "agent-chat",
  53. "channel",
  54. "all",
  55. ],
  56. default="all",
  57. location="args",
  58. required=False,
  59. )
  60. parser.add_argument("name", type=str, location="args", required=False)
  61. parser.add_argument("auth_type", type=str, location="args", required=False)
  62. parser.add_argument("creator_dept", type=str, location="args", required=False)
  63. parser.add_argument("creator", type=str, location="args", required=False)
  64. parser.add_argument("tag_ids", type=uuid_list, location="args", required=False)
  65. parser.add_argument("is_created_by_me", type=inputs.boolean, location="args", required=False)
  66. args = parser.parse_args()
  67. # get app list
  68. app_service = AppService()
  69. app_pagination = app_service.get_paginate_apps(current_user.id, current_user.current_tenant_id, args)
  70. if not app_pagination:
  71. return {"data": [], "total": 0, "page": 1, "limit": 20, "has_more": False}
  72. return marshal(app_pagination, app_pagination_fields)
  73. @setup_required
  74. @login_required
  75. @account_initialization_required
  76. @marshal_with(app_detail_fields)
  77. @cloud_edition_billing_resource_check("apps")
  78. def post(self):
  79. """Create app"""
  80. parser = reqparse.RequestParser()
  81. parser.add_argument("name", type=str, required=True, location="json")
  82. parser.add_argument("description", type=str, location="json")
  83. parser.add_argument("mode", type=str, choices=ALLOW_CREATE_APP_MODES, location="json")
  84. parser.add_argument("icon_type", type=str, location="json")
  85. parser.add_argument("icon", type=str, location="json")
  86. parser.add_argument("icon_background", type=str, location="json")
  87. args = parser.parse_args()
  88. # The role of the current user in the ta table must be admin, owner, or editor
  89. if not current_user.is_editor:
  90. raise Forbidden()
  91. if "mode" not in args or args["mode"] is None:
  92. raise BadRequest("mode is required")
  93. app_service = AppService()
  94. app = app_service.create_app(current_user.current_tenant_id, args, current_user)
  95. return app, 201
  96. class AppApi(Resource):
  97. @setup_required
  98. @login_required
  99. @account_initialization_required
  100. @enterprise_license_required
  101. @get_app_model
  102. @marshal_with(app_detail_fields_with_site)
  103. def get(self, app_model):
  104. """Get app detail"""
  105. app_service = AppService()
  106. app_model = app_service.get_app(app_model)
  107. return app_model
  108. @setup_required
  109. @login_required
  110. @account_initialization_required
  111. @get_app_model
  112. @marshal_with(app_detail_fields_with_site)
  113. def put(self, app_model):
  114. """Update app"""
  115. # The role of the current user in the ta table must be admin, owner, or editor
  116. if not current_user.is_editor:
  117. raise Forbidden()
  118. parser = reqparse.RequestParser()
  119. parser.add_argument("name", type=str, required=True, nullable=False, location="json")
  120. parser.add_argument("description", type=str, location="json")
  121. parser.add_argument("icon_type", type=str, location="json")
  122. parser.add_argument("icon", type=str, location="json")
  123. parser.add_argument("icon_background", type=str, location="json")
  124. parser.add_argument("use_icon_as_answer_icon", type=bool, location="json")
  125. args = parser.parse_args()
  126. app_service = AppService()
  127. app_model = app_service.update_app(app_model, args)
  128. return app_model
  129. @setup_required
  130. @login_required
  131. @account_initialization_required
  132. @get_app_model
  133. def delete(self, app_model):
  134. """Delete app"""
  135. # The role of the current user in the ta table must be admin, owner, or editor
  136. if not current_user.is_editor:
  137. raise Forbidden()
  138. app_service = AppService()
  139. app_service.delete_app(app_model)
  140. return {"result": "success"}, 204
  141. class AppCopyApi(Resource):
  142. @setup_required
  143. @login_required
  144. @account_initialization_required
  145. @get_app_model
  146. @marshal_with(app_detail_fields_with_site)
  147. def post(self, app_model):
  148. """Copy app"""
  149. # The role of the current user in the ta table must be admin, owner, or editor
  150. if not current_user.is_editor:
  151. raise Forbidden()
  152. parser = reqparse.RequestParser()
  153. parser.add_argument("name", type=str, location="json")
  154. parser.add_argument("description", type=str, location="json")
  155. parser.add_argument("icon_type", type=str, location="json")
  156. parser.add_argument("icon", type=str, location="json")
  157. parser.add_argument("icon_background", type=str, location="json")
  158. args = parser.parse_args()
  159. with Session(db.engine) as session:
  160. import_service = AppDslService(session)
  161. yaml_content = import_service.export_dsl(app_model=app_model, include_secret=True)
  162. account = cast(Account, current_user)
  163. result = import_service.import_app(
  164. account=account,
  165. import_mode=ImportMode.YAML_CONTENT.value,
  166. yaml_content=yaml_content,
  167. name=args.get("name"),
  168. description=args.get("description"),
  169. icon_type=args.get("icon_type"),
  170. icon=args.get("icon"),
  171. icon_background=args.get("icon_background"),
  172. )
  173. session.commit()
  174. stmt = select(App).where(App.id == result.app_id)
  175. app = session.scalar(stmt)
  176. return app, 201
  177. class AppExportApi(Resource):
  178. @setup_required
  179. @login_required
  180. @account_initialization_required
  181. @get_app_model
  182. def get(self, app_model):
  183. """Export app"""
  184. # The role of the current user in the ta table must be admin, owner, or editor
  185. if not current_user.is_editor:
  186. raise Forbidden()
  187. # Add include_secret params
  188. parser = reqparse.RequestParser()
  189. parser.add_argument("include_secret", type=inputs.boolean, default=False, location="args")
  190. args = parser.parse_args()
  191. return {"data": AppDslService.export_dsl(app_model=app_model, include_secret=args["include_secret"])}
  192. class AppNameApi(Resource):
  193. @setup_required
  194. @login_required
  195. @account_initialization_required
  196. @get_app_model
  197. @marshal_with(app_detail_fields)
  198. def post(self, app_model):
  199. # The role of the current user in the ta table must be admin, owner, or editor
  200. if not current_user.is_editor:
  201. raise Forbidden()
  202. parser = reqparse.RequestParser()
  203. parser.add_argument("name", type=str, required=True, location="json")
  204. args = parser.parse_args()
  205. app_service = AppService()
  206. app_model = app_service.update_app_name(app_model, args.get("name"))
  207. return app_model
  208. class AppIconApi(Resource):
  209. @setup_required
  210. @login_required
  211. @account_initialization_required
  212. @get_app_model
  213. @marshal_with(app_detail_fields)
  214. def post(self, app_model):
  215. # The role of the current user in the ta table must be admin, owner, or editor
  216. if not current_user.is_editor:
  217. raise Forbidden()
  218. parser = reqparse.RequestParser()
  219. parser.add_argument("icon", type=str, location="json")
  220. parser.add_argument("icon_background", type=str, location="json")
  221. args = parser.parse_args()
  222. app_service = AppService()
  223. app_model = app_service.update_app_icon(app_model, args.get("icon"), args.get("icon_background"))
  224. return app_model
  225. class AppSiteStatus(Resource):
  226. @setup_required
  227. @login_required
  228. @account_initialization_required
  229. @get_app_model
  230. @marshal_with(app_detail_fields)
  231. def post(self, app_model):
  232. # The role of the current user in the ta table must be admin, owner, or editor
  233. if not current_user.is_editor:
  234. raise Forbidden()
  235. parser = reqparse.RequestParser()
  236. parser.add_argument("enable_site", type=bool, required=True, location="json")
  237. args = parser.parse_args()
  238. app_service = AppService()
  239. app_model = app_service.update_app_site_status(app_model, args.get("enable_site"))
  240. return app_model
  241. class AppApiStatus(Resource):
  242. @setup_required
  243. @login_required
  244. @account_initialization_required
  245. @get_app_model
  246. @marshal_with(app_detail_fields)
  247. def post(self, app_model):
  248. # The role of the current user in the ta table must be admin or owner
  249. if not current_user.is_admin_or_owner:
  250. raise Forbidden()
  251. parser = reqparse.RequestParser()
  252. parser.add_argument("enable_api", type=bool, required=True, location="json")
  253. args = parser.parse_args()
  254. app_service = AppService()
  255. app_model = app_service.update_app_api_status(app_model, args.get("enable_api"))
  256. return app_model
  257. class AppTraceApi(Resource):
  258. @setup_required
  259. @login_required
  260. @account_initialization_required
  261. def get(self, app_id):
  262. """Get app trace"""
  263. app_trace_config = OpsTraceManager.get_app_tracing_config(app_id=app_id)
  264. return app_trace_config
  265. @setup_required
  266. @login_required
  267. @account_initialization_required
  268. def post(self, app_id):
  269. # add app trace
  270. if not current_user.is_editor:
  271. raise Forbidden()
  272. parser = reqparse.RequestParser()
  273. parser.add_argument("enabled", type=bool, required=True, location="json")
  274. parser.add_argument("tracing_provider", type=str, required=True, location="json")
  275. args = parser.parse_args()
  276. OpsTraceManager.update_app_tracing_config(
  277. app_id=app_id,
  278. enabled=args["enabled"],
  279. tracing_provider=args["tracing_provider"],
  280. )
  281. return {"result": "success"}
  282. class AppPermissionApi(Resource):
  283. @setup_required
  284. @login_required
  285. @get_app_model
  286. @account_initialization_required
  287. def get(self, app_model):
  288. app_service = AppService()
  289. app_model = app_service.get_app_by_id(app_model)
  290. if not app_model:
  291. raise NotFound("App not found.")
  292. read_permission_list = AppService.get_app_read_permission(app_model.id)
  293. response = {
  294. "edit_auth": app_model.edit_auth,
  295. "read_permission": read_permission_list,
  296. }
  297. return response
  298. @setup_required
  299. @login_required
  300. @get_app_model
  301. @account_initialization_required
  302. def post(self, app_model):
  303. # add app permission
  304. app_service = AppService()
  305. app_model = app_service.get_app_by_id(app_model)
  306. # 解析表单数据
  307. data = request.get_json()
  308. if not data:
  309. raise NotFound("Invalid JSON")
  310. edit_auth = data.get("edit_auth")
  311. if edit_auth is None:
  312. return jsonify({"error": "Missing 'edit_auth' field"}), 400
  313. read_permission_list = data.get("read_permission")
  314. if read_permission_list is None:
  315. return jsonify({"error": "Missing 'read_permission' field"}), 400
  316. if not isinstance(read_permission_list, list):
  317. return jsonify({"error": "'read_permission' should be a list"}), 400
  318. # 更新知识库的编辑权限
  319. AppService.update_app_edit_auth(current_user.id, app_model, edit_auth)
  320. # 更新知识库的编辑、可见授权
  321. AppService.update_app_read_permission(current_user.id, app_model, read_permission_list)
  322. return {"result": "success"}, 204
  323. api.add_resource(AppListApi, "/apps")
  324. api.add_resource(AppApi, "/apps/<uuid:app_id>")
  325. api.add_resource(AppCopyApi, "/apps/<uuid:app_id>/copy")
  326. api.add_resource(AppExportApi, "/apps/<uuid:app_id>/export")
  327. api.add_resource(AppNameApi, "/apps/<uuid:app_id>/name")
  328. api.add_resource(AppIconApi, "/apps/<uuid:app_id>/icon")
  329. api.add_resource(AppSiteStatus, "/apps/<uuid:app_id>/site-enable")
  330. api.add_resource(AppApiStatus, "/apps/<uuid:app_id>/api-enable")
  331. api.add_resource(AppTraceApi, "/apps/<uuid:app_id>/trace")
  332. api.add_resource(AppPermissionApi, "/apps/<uuid:app_id>/permission")