account.py 9.8 KB

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