workspace.py 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228
  1. import logging
  2. from flask import request
  3. from flask_login import current_user # type: ignore
  4. from flask_restful import Resource, fields, inputs, marshal, marshal_with, reqparse # type: ignore
  5. from werkzeug.exceptions import Unauthorized
  6. import services
  7. from controllers.common.errors import FilenameNotExistsError
  8. from controllers.console import api
  9. from controllers.console.admin import admin_required
  10. from controllers.console.datasets.error import (
  11. FileTooLargeError,
  12. NoFileUploadedError,
  13. TooManyFilesError,
  14. UnsupportedFileTypeError,
  15. )
  16. from controllers.console.error import AccountNotLinkTenantError
  17. from controllers.console.wraps import (
  18. account_initialization_required,
  19. cloud_edition_billing_resource_check,
  20. setup_required,
  21. )
  22. from extensions.ext_database import db
  23. from libs.helper import TimestampField
  24. from libs.login import login_required
  25. from models.account import Tenant, TenantStatus
  26. from services.account_service import TenantService
  27. from services.file_service import FileService
  28. from services.workspace_service import WorkspaceService
  29. provider_fields = {
  30. "provider_name": fields.String,
  31. "provider_type": fields.String,
  32. "is_valid": fields.Boolean,
  33. "token_is_set": fields.Boolean,
  34. }
  35. tenant_fields = {
  36. "id": fields.String,
  37. "name": fields.String,
  38. "plan": fields.String,
  39. "status": fields.String,
  40. "created_at": TimestampField,
  41. "role": fields.String,
  42. "in_trial": fields.Boolean,
  43. "trial_end_reason": fields.String,
  44. "custom_config": fields.Raw(attribute="custom_config"),
  45. }
  46. tenants_fields = {
  47. "id": fields.String,
  48. "name": fields.String,
  49. "plan": fields.String,
  50. "status": fields.String,
  51. "created_at": TimestampField,
  52. "current": fields.Boolean,
  53. }
  54. workspace_fields = {"id": fields.String, "name": fields.String, "status": fields.String, "created_at": TimestampField}
  55. class TenantListApi(Resource):
  56. @setup_required
  57. @login_required
  58. @account_initialization_required
  59. def get(self):
  60. tenants = TenantService.get_join_tenants(current_user)
  61. for tenant in tenants:
  62. if tenant.id == current_user.current_tenant_id:
  63. tenant.current = True # Set current=True for current tenant
  64. return {"workspaces": marshal(tenants, tenants_fields)}, 200
  65. class WorkspaceListApi(Resource):
  66. @setup_required
  67. @admin_required
  68. def get(self):
  69. parser = reqparse.RequestParser()
  70. parser.add_argument("page", type=inputs.int_range(1, 99999), required=False, default=1, location="args")
  71. parser.add_argument("limit", type=inputs.int_range(1, 100), required=False, default=20, location="args")
  72. args = parser.parse_args()
  73. tenants = Tenant.query.order_by(Tenant.created_at.desc()).paginate(page=args["page"], per_page=args["limit"])
  74. has_more = False
  75. if len(tenants.items) == args["limit"]:
  76. current_page_first_tenant = tenants[-1]
  77. rest_count = (
  78. db.session.query(Tenant)
  79. .filter(
  80. Tenant.created_at < current_page_first_tenant.created_at, Tenant.id != current_page_first_tenant.id
  81. )
  82. .count()
  83. )
  84. if rest_count > 0:
  85. has_more = True
  86. total = db.session.query(Tenant).count()
  87. return {
  88. "data": marshal(tenants.items, workspace_fields),
  89. "has_more": has_more,
  90. "limit": args["limit"],
  91. "page": args["page"],
  92. "total": total,
  93. }, 200
  94. class TenantApi(Resource):
  95. @setup_required
  96. @login_required
  97. @account_initialization_required
  98. @marshal_with(tenant_fields)
  99. def get(self):
  100. if request.path == "/info":
  101. logging.warning("Deprecated URL /info was used.")
  102. tenant = current_user.current_tenant
  103. if tenant.status == TenantStatus.ARCHIVE:
  104. tenants = TenantService.get_join_tenants(current_user)
  105. # if there is any tenant, switch to the first one
  106. if len(tenants) > 0:
  107. TenantService.switch_tenant(current_user, tenants[0].id)
  108. tenant = tenants[0]
  109. # else, raise Unauthorized
  110. else:
  111. raise Unauthorized("workspace is archived")
  112. return WorkspaceService.get_tenant_info(tenant), 200
  113. class SwitchWorkspaceApi(Resource):
  114. @setup_required
  115. @login_required
  116. @account_initialization_required
  117. def post(self):
  118. parser = reqparse.RequestParser()
  119. parser.add_argument("tenant_id", type=str, required=True, location="json")
  120. args = parser.parse_args()
  121. # check if tenant_id is valid, 403 if not
  122. try:
  123. TenantService.switch_tenant(current_user, args["tenant_id"])
  124. except Exception:
  125. raise AccountNotLinkTenantError("Account not link tenant")
  126. new_tenant = db.session.query(Tenant).get(args["tenant_id"]) # Get new tenant
  127. if new_tenant is None:
  128. raise ValueError("Tenant not found")
  129. return {"result": "success", "new_tenant": marshal(WorkspaceService.get_tenant_info(new_tenant), tenant_fields)}
  130. class CustomConfigWorkspaceApi(Resource):
  131. @setup_required
  132. @login_required
  133. @account_initialization_required
  134. @cloud_edition_billing_resource_check("workspace_custom")
  135. def post(self):
  136. parser = reqparse.RequestParser()
  137. parser.add_argument("remove_webapp_brand", type=bool, location="json")
  138. parser.add_argument("replace_webapp_logo", type=str, location="json")
  139. args = parser.parse_args()
  140. tenant = Tenant.query.filter(Tenant.id == current_user.current_tenant_id).one_or_404()
  141. custom_config_dict = {
  142. "remove_webapp_brand": args["remove_webapp_brand"],
  143. "replace_webapp_logo": args["replace_webapp_logo"]
  144. if args["replace_webapp_logo"] is not None
  145. else tenant.custom_config_dict.get("replace_webapp_logo"),
  146. }
  147. tenant.custom_config_dict = custom_config_dict
  148. db.session.commit()
  149. return {"result": "success", "tenant": marshal(WorkspaceService.get_tenant_info(tenant), tenant_fields)}
  150. class WebappLogoWorkspaceApi(Resource):
  151. @setup_required
  152. @login_required
  153. @account_initialization_required
  154. @cloud_edition_billing_resource_check("workspace_custom")
  155. def post(self):
  156. # get file from request
  157. file = request.files["file"]
  158. # check file
  159. if "file" not in request.files:
  160. raise NoFileUploadedError()
  161. if len(request.files) > 1:
  162. raise TooManyFilesError()
  163. if not file.filename:
  164. raise FilenameNotExistsError
  165. extension = file.filename.split(".")[-1]
  166. if extension.lower() not in {"svg", "png"}:
  167. raise UnsupportedFileTypeError()
  168. try:
  169. upload_file = FileService.upload_file(
  170. filename=file.filename,
  171. content=file.read(),
  172. mimetype=file.mimetype,
  173. user=current_user,
  174. )
  175. except services.errors.file.FileTooLargeError as file_too_large_error:
  176. raise FileTooLargeError(file_too_large_error.description)
  177. except services.errors.file.UnsupportedFileTypeError:
  178. raise UnsupportedFileTypeError()
  179. return {"id": upload_file.id}, 201
  180. api.add_resource(TenantListApi, "/workspaces") # GET for getting all tenants
  181. api.add_resource(WorkspaceListApi, "/all-workspaces") # GET for getting all tenants
  182. api.add_resource(TenantApi, "/workspaces/current", endpoint="workspaces_current") # GET for getting current tenant info
  183. api.add_resource(TenantApi, "/info", endpoint="info") # Deprecated
  184. api.add_resource(SwitchWorkspaceApi, "/workspaces/switch") # POST for switching tenant
  185. api.add_resource(CustomConfigWorkspaceApi, "/workspaces/custom-config")
  186. api.add_resource(WebappLogoWorkspaceApi, "/workspaces/custom-config/webapp-logo/upload")