account.py 10 KB

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