app.py 14 KB

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