account.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. import enum
  2. import json
  3. from flask_login import UserMixin # type: ignore
  4. from sqlalchemy import func
  5. from sqlalchemy.orm import Mapped, mapped_column
  6. from models.base import Base
  7. from .engine import db
  8. from .types import StringUUID
  9. class AccountStatus(enum.StrEnum):
  10. PENDING = "pending"
  11. UNINITIALIZED = "uninitialized"
  12. ACTIVE = "active"
  13. BANNED = "banned"
  14. CLOSED = "closed"
  15. class Account(UserMixin, Base):
  16. __tablename__ = "accounts"
  17. __table_args__ = (db.PrimaryKeyConstraint("id", name="account_pkey"), db.Index("account_email_idx", "email"))
  18. id: Mapped[str] = mapped_column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  19. name = db.Column(db.String(255), nullable=False)
  20. email = db.Column(db.String(255), nullable=False)
  21. password = db.Column(db.String(255), nullable=True)
  22. password_salt = db.Column(db.String(255), nullable=True)
  23. avatar = db.Column(db.String(255))
  24. interface_language = db.Column(db.String(255))
  25. interface_theme = db.Column(db.String(255))
  26. timezone = db.Column(db.String(255))
  27. last_login_at = db.Column(db.DateTime)
  28. last_login_ip = db.Column(db.String(255))
  29. last_active_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  30. status = db.Column(db.String(16), nullable=False, server_default=db.text("'active'::character varying"))
  31. initialized_at = db.Column(db.DateTime)
  32. created_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  33. updated_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  34. dept_id = db.Column(StringUUID, nullable=True)
  35. @property
  36. def is_password_set(self):
  37. return self.password is not None
  38. @property
  39. def current_tenant(self):
  40. # FIXME: fix the type error later, because the type is important maybe cause some bugs
  41. return self._current_tenant # type: ignore
  42. @current_tenant.setter
  43. def current_tenant(self, value: "Tenant"):
  44. tenant = value
  45. ta = TenantAccountJoin.query.filter_by(tenant_id=tenant.id, account_id=self.id).first()
  46. if ta:
  47. tenant.current_role = ta.role
  48. else:
  49. tenant = None # type: ignore
  50. self._current_tenant = tenant
  51. @property
  52. def current_tenant_id(self) -> str | None:
  53. return self._current_tenant.id if self._current_tenant else None
  54. @current_tenant_id.setter
  55. def current_tenant_id(self, value: str):
  56. try:
  57. tenant_account_join = (
  58. db.session.query(Tenant, TenantAccountJoin)
  59. .filter(Tenant.id == value)
  60. .filter(TenantAccountJoin.tenant_id == Tenant.id)
  61. .filter(TenantAccountJoin.account_id == self.id)
  62. .one_or_none()
  63. )
  64. if tenant_account_join:
  65. tenant, ta = tenant_account_join
  66. tenant.current_role = ta.role
  67. else:
  68. tenant = None
  69. except Exception:
  70. tenant = None
  71. self._current_tenant = tenant
  72. @property
  73. def current_role(self):
  74. return self._current_tenant.current_role
  75. def get_status(self) -> AccountStatus:
  76. status_str = self.status
  77. return AccountStatus(status_str)
  78. @classmethod
  79. def get_by_openid(cls, provider: str, open_id: str):
  80. account_integrate = (
  81. db.session.query(AccountIntegrate)
  82. .filter(AccountIntegrate.provider == provider, AccountIntegrate.open_id == open_id)
  83. .one_or_none()
  84. )
  85. if account_integrate:
  86. return db.session.query(Account).filter(Account.id == account_integrate.account_id).one_or_none()
  87. return None
  88. # check current_user.current_tenant.current_role in ['admin', 'owner']
  89. @property
  90. def is_admin_or_owner(self):
  91. return TenantAccountRole.is_privileged_role(self._current_tenant.current_role)
  92. @property
  93. def is_admin(self):
  94. return TenantAccountRole.is_admin_role(self._current_tenant.current_role)
  95. @property
  96. def is_editor(self):
  97. return TenantAccountRole.is_editing_role(self._current_tenant.current_role)
  98. @property
  99. def is_dataset_editor(self):
  100. return TenantAccountRole.is_dataset_edit_role(self._current_tenant.current_role)
  101. @property
  102. def is_dataset_operator(self):
  103. return self._current_tenant.current_role == TenantAccountRole.DATASET_OPERATOR
  104. class TenantStatus(enum.StrEnum):
  105. NORMAL = "normal"
  106. ARCHIVE = "archive"
  107. class TenantAccountRole(enum.StrEnum):
  108. OWNER = "owner"
  109. ADMIN = "admin"
  110. EDITOR = "editor"
  111. NORMAL = "normal"
  112. DATASET_OPERATOR = "dataset_operator"
  113. @staticmethod
  114. def is_valid_role(role: str) -> bool:
  115. if not role:
  116. return False
  117. return role in {
  118. TenantAccountRole.OWNER,
  119. TenantAccountRole.ADMIN,
  120. TenantAccountRole.EDITOR,
  121. TenantAccountRole.NORMAL,
  122. TenantAccountRole.DATASET_OPERATOR,
  123. }
  124. @staticmethod
  125. def is_privileged_role(role: str) -> bool:
  126. if not role:
  127. return False
  128. return role in {TenantAccountRole.OWNER, TenantAccountRole.ADMIN}
  129. @staticmethod
  130. def is_admin_role(role: str) -> bool:
  131. if not role:
  132. return False
  133. return role == TenantAccountRole.ADMIN
  134. @staticmethod
  135. def is_non_owner_role(role: str) -> bool:
  136. if not role:
  137. return False
  138. return role in {
  139. TenantAccountRole.ADMIN,
  140. TenantAccountRole.EDITOR,
  141. TenantAccountRole.NORMAL,
  142. TenantAccountRole.DATASET_OPERATOR,
  143. }
  144. @staticmethod
  145. def is_editing_role(role: str) -> bool:
  146. if not role:
  147. return False
  148. return role in {TenantAccountRole.OWNER, TenantAccountRole.ADMIN, TenantAccountRole.EDITOR}
  149. @staticmethod
  150. def is_dataset_edit_role(role: str) -> bool:
  151. if not role:
  152. return False
  153. return role in {
  154. TenantAccountRole.OWNER,
  155. TenantAccountRole.ADMIN,
  156. TenantAccountRole.EDITOR,
  157. TenantAccountRole.DATASET_OPERATOR,
  158. }
  159. class Tenant(db.Model): # type: ignore[name-defined]
  160. __tablename__ = "tenants"
  161. __table_args__ = (db.PrimaryKeyConstraint("id", name="tenant_pkey"),)
  162. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  163. name = db.Column(db.String(255), nullable=False)
  164. encrypt_public_key = db.Column(db.Text)
  165. plan = db.Column(db.String(255), nullable=False, server_default=db.text("'basic'::character varying"))
  166. status = db.Column(db.String(255), nullable=False, server_default=db.text("'normal'::character varying"))
  167. custom_config = db.Column(db.Text)
  168. created_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  169. updated_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  170. def get_accounts(self) -> list[Account]:
  171. return (
  172. db.session.query(Account)
  173. .filter(Account.id == TenantAccountJoin.account_id, TenantAccountJoin.tenant_id == self.id)
  174. .all()
  175. )
  176. @property
  177. def custom_config_dict(self) -> dict:
  178. return json.loads(self.custom_config) if self.custom_config else {}
  179. @custom_config_dict.setter
  180. def custom_config_dict(self, value: dict):
  181. self.custom_config = json.dumps(value)
  182. class TenantAccountJoin(db.Model): # type: ignore[name-defined]
  183. __tablename__ = "tenant_account_joins"
  184. __table_args__ = (
  185. db.PrimaryKeyConstraint("id", name="tenant_account_join_pkey"),
  186. db.Index("tenant_account_join_account_id_idx", "account_id"),
  187. db.Index("tenant_account_join_tenant_id_idx", "tenant_id"),
  188. db.UniqueConstraint("tenant_id", "account_id", name="unique_tenant_account_join"),
  189. )
  190. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  191. tenant_id = db.Column(StringUUID, nullable=False)
  192. account_id = db.Column(StringUUID, nullable=False)
  193. current = db.Column(db.Boolean, nullable=False, server_default=db.text("false"))
  194. role = db.Column(db.String(16), nullable=False, server_default="normal")
  195. invited_by = db.Column(StringUUID, nullable=True)
  196. created_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  197. updated_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  198. class AccountIntegrate(db.Model): # type: ignore[name-defined]
  199. __tablename__ = "account_integrates"
  200. __table_args__ = (
  201. db.PrimaryKeyConstraint("id", name="account_integrate_pkey"),
  202. db.UniqueConstraint("account_id", "provider", name="unique_account_provider"),
  203. db.UniqueConstraint("provider", "open_id", name="unique_provider_open_id"),
  204. )
  205. id = db.Column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  206. account_id = db.Column(StringUUID, nullable=False)
  207. provider = db.Column(db.String(16), nullable=False)
  208. open_id = db.Column(db.String(255), nullable=False)
  209. encrypted_token = db.Column(db.String(255), nullable=False)
  210. created_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  211. updated_at = db.Column(db.DateTime, nullable=False, server_default=func.current_timestamp())
  212. class InvitationCode(db.Model): # type: ignore[name-defined]
  213. __tablename__ = "invitation_codes"
  214. __table_args__ = (
  215. db.PrimaryKeyConstraint("id", name="invitation_code_pkey"),
  216. db.Index("invitation_codes_batch_idx", "batch"),
  217. db.Index("invitation_codes_code_idx", "code", "status"),
  218. )
  219. id = db.Column(db.Integer, nullable=False)
  220. batch = db.Column(db.String(255), nullable=False)
  221. code = db.Column(db.String(32), nullable=False)
  222. status = db.Column(db.String(16), nullable=False, server_default=db.text("'unused'::character varying"))
  223. used_at = db.Column(db.DateTime)
  224. used_by_tenant_id = db.Column(StringUUID)
  225. used_by_account_id = db.Column(StringUUID)
  226. deprecated_at = db.Column(db.DateTime)
  227. created_at = db.Column(db.DateTime, nullable=False, server_default=db.text("CURRENT_TIMESTAMP(0)"))
  228. class TenantPluginPermission(Base):
  229. class InstallPermission(enum.StrEnum):
  230. EVERYONE = "everyone"
  231. ADMINS = "admins"
  232. NOBODY = "noone"
  233. class DebugPermission(enum.StrEnum):
  234. EVERYONE = "everyone"
  235. ADMINS = "admins"
  236. NOBODY = "noone"
  237. __tablename__ = "account_plugin_permissions"
  238. __table_args__ = (
  239. db.PrimaryKeyConstraint("id", name="account_plugin_permission_pkey"),
  240. db.UniqueConstraint("tenant_id", name="unique_tenant_plugin"),
  241. )
  242. id: Mapped[str] = mapped_column(StringUUID, server_default=db.text("uuid_generate_v4()"))
  243. tenant_id: Mapped[str] = mapped_column(StringUUID, nullable=False)
  244. install_permission: Mapped[InstallPermission] = mapped_column(
  245. db.String(16), nullable=False, server_default="everyone"
  246. )
  247. debug_permission: Mapped[DebugPermission] = mapped_column(db.String(16), nullable=False, server_default="noone")