account.py 11 KB

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