account.py 9.7 KB

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