add type for users ( guest and user)

Author: bea777515

QA/py/pg_files/upgrade_prod.sql

@@ -2921,6 +2921,46 @@ ALTER TABLE projects ADD COLUMN formulae VARCHAR;
 UPDATE alembic_version SET version_num='78b24e7ba52b' WHERE alembic_version.version_num = '032dfb7159d5';
 
 COMMIT;
+BEGIN;
+-- Running upgrade 78b24e7ba52b -> e6dda08ff48b
+
+CREATE TABLE organizations (
+    id SERIAL NOT NULL,
+    name VARCHAR(255) NOT NULL,
+    directories VARCHAR(100)[],
+    PRIMARY KEY (id)
+);
+
+ALTER TABLE users ADD COLUMN type SMALLINT;
+
+ALTER TABLE users ADD CONSTRAINT checktype CHECK (type= 1 OR (type=0 AND status=0));
+
+ALTER TABLE users ADD CONSTRAINT checkstatus CHECK (status ANY(array[-1, 0, 1, 2]::int[]));
+
+UPDATE users SET type=1;
+
+UPDATE alembic_version SET version_num='e6dda08ff48b' WHERE alembic_version.version_num = '78b24e7ba52b';
+
+COMMIT;
+BEGIN;
+-- Running upgrade e6dda08ff48b -> 5b706c64bae0
+
+ALTER TABLE organizations ADD CONSTRAINT orgname UNIQUE (name);
+
+ALTER TABLE organizations DROP COLUMN id;
+
+INSERT INTO organizations (name) SELECT DISTINCT organisation FROM users;
+
+ALTER TABLE users ADD CONSTRAINT org FOREIGN KEY(organisation) REFERENCES organizations (name);
+
+ALTER TABLE users ADD CONSTRAINT orgname FOREIGN KEY(organisation) REFERENCES organizations (name);
+
+UPDATE alembic_version SET version_num='5b706c64bae0' WHERE alembic_version.version_num = 'e6dda08ff48b';
+
+COMMIT;
+
+
+
 
 ------- Leave on tail
 

py/API_models/constants.py

@@ -8,7 +8,7 @@
 
 from BO.DataLicense import DataLicense, AccessLevelEnum
 from DB.Collection import PeopleOrganizationDirectory
-from DB.User import UserStatus
+from DB.User import UserStatus, UserType
 from BO.User import (
     USER_PWD_REGEXP,
     USER_PWD_REGEXP_DESCRIPTION,
@@ -66,6 +66,12 @@ class Constants(BaseModel):
         default={st.name: st.value for st in UserStatus},
         example={"blocked": -1, "inactive": 0, "active": 1, "pending": 2},
     )
+    user_type: Dict[str, int] = Field(
+        title="User status",
+        description="Application User type values",
+        default={st.name: st.value for st in UserType},
+        example={"guest": 0},
+    )
     password_regexp: str = Field(
         title="Password regexp",
         description=USER_PWD_REGEXP_DESCRIPTION,

py/DB/User.py

@@ -7,12 +7,19 @@
 from enum import Enum
 from typing import List, Iterable, TYPE_CHECKING
 
-from sqlalchemy import event, SmallInteger
-
+from sqlalchemy import event, SmallInteger, CheckConstraint
+from sqlalchemy.dialects.postgresql import ARRAY
 from BO.helpers.TSVHelpers import none_to_empty
 from data.Countries import countries_by_name
 from .helpers import Session, Result
-from .helpers.DDL import Column, ForeignKey, Sequence, Integer, String, Boolean
+from .helpers.DDL import (
+    Column,
+    ForeignKey,
+    Sequence,
+    Integer,
+    String,
+    Boolean,
+)
 from .helpers.Direct import text, func
 from .helpers.ORM import Model, relationship, Insert
 from .helpers.Postgres import TIMESTAMP
@@ -28,12 +35,15 @@ class UserStatus(int, Enum):
     pending: Final = 2
 
 
+class UserType(int, Enum):
+    guest: Final = 0
+    user: Final = 1
+
+
 class Organization(Model):
     __tablename__ = "organizations"
-    id: int = Column(Integer, primary_key=True)
-    name: str = Column(String(255), nullable=False)
-    directory: str = Column(String(20), nullable=True)
-    reference: str = Column(String(40), nullable=True)
+    name: str = Column(String(255), unique=True, primary_key=True)
+    directories: list = Column(ARRAY(String), nullable=True)
 
     @staticmethod
     def find_organizations(
@@ -46,21 +56,24 @@ def find_organizations(
         :param found_organizations: A dict in
         """
         sql = text(
-            "SELECT id, name, directory , reference"
+            "SELECT name, directories"
             "  FROM organizations "
             " WHERE LOWER(name) = ANY(:nms)  "
         )
         res: Result = session.execute(sql, {"nms": names})
         for rec in res:
             for u in found_organzations:
-                if (
-                    u == rec[1]
-                    or none_to_empty(found_users[u].get("email")).lower() == rec[2]
-                ):
-                    found_users[u]["id"] = rec[0]
+                if u == rec[0]:
+                    found_organizations[u]["name"] = rec[0]
 
     def __str__(self):
-        return "{0} ({1} {2})".format(self.name, self.directory, self.reference)
+        return "{0} ({1})".format(self.name, self.directories)
+
+
+CHK_STATUS = "status = ANY(ARRAY{0}::int[])".format([st.value for st in UserStatus])
+CHK_TYPE = "type= {0} OR (type={1} AND status={2})".format(
+    UserType.user.value, UserType.guest.value, UserStatus.inactive.value
+)
 
 
 class User(Model):
@@ -69,16 +82,22 @@ class User(Model):
     email: str = Column(String(255), unique=True, nullable=False)
     password: str = Column(String(255))
     name: str = Column(String(255), nullable=False)
-    organisation: str = Column(String(255))
+    organisation: str = Column(
+        String(255), ForeignKey("organizations.name"), nullable=True
+    )
     status: int = Column(SmallInteger(), default=1)
     status_date = Column(TIMESTAMP)
     status_admin_comment: str = Column(String(255))
     preferences: str = Column(String(40000))
     country: str = Column(String(50))
     orcid: str = Column(String(20), nullable=True)
+    type: int = Column(SmallInteger(), default=1)
     usercreationdate = Column(TIMESTAMP, default=func.now())
     usercreationreason = Column(String(1000))
 
+    checktype = CheckConstraint(CHK_TYPE)
+    # table level CHECK constraint. type guest must have inactive status .
+    checkstatus = CheckConstraint(CHK_STATUS)
     # Mail status: True for verified, default NULL
     mail_status: bool = Column(Boolean(), nullable=True)
     # Date the mail status was set
@@ -125,6 +144,16 @@ def __str__(self):
         return "{0} ({1})".format(self.name, self.email)
 
 
+def insert_new_organization(sess, **kwargs):
+    """
+    Add new organization if missing on user inser or update
+    """
+    print(" oninsert ", **kwargs)
+    # if organisation :
+    #    ins = Insert(Organization.name).values((organisation))
+    #    sess.execute(ins)
+
+
 class Role(Model):
     """
     The roles granted to users.

py/cmds/db_upg/versions/5b706c64bae0_organizations_users_relation.py

@@ -0,0 +1,39 @@
+"""organizations users relation
+
+Revision ID: 5b706c64bae0
+Revises: e6dda08ff48b
+Create Date: 2025-01-17 14:48:54.137602
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "5b706c64bae0"
+down_revision = "e6dda08ff48b"
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_unique_constraint("orgname", "organizations", ["name"])
+    op.drop_column("organizations", "id")
+    op.execute(
+        "INSERT INTO organizations (name) SELECT DISTINCT organisation FROM users WHERE organisation IS NOT NULL"
+    )
+    op.create_foreign_key(None, "users", "organizations", ["organisation"], ["name"])
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(None, "users", type_="foreignkey")
+    op.drop_constraint("orgname", "organizations", type_="unique")
+    op.add_column(
+        "organizations",
+        sa.Column("id", sa.INTEGER(), autoincrement=True, nullable=False),
+    )
+
+    # ### end Alembic commands ###

py/cmds/db_upg/versions/e6dda08ff48b_organizations_table_and_users_type.py

@@ -0,0 +1,44 @@
+"""organizations table and users type
+
+Revision ID: e6dda08ff48b
+Revises: 78b24e7ba52b
+Create Date: 2025-01-17 11:45:22.873082
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = "e6dda08ff48b"
+down_revision = "78b24e7ba52b"
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+from DB.User import UserType, UserStatus, CHK_STATUS, CHK_TYPE
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "organizations",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("name", sa.String(length=255), nullable=False),
+        sa.Column(
+            "directories", postgresql.ARRAY(sa.String(length=100)), nullable=True
+        ),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.add_column("users", sa.Column("type", sa.SmallInteger(), nullable=True))
+    op.create_check_constraint("checktype", "users", CHK_TYPE)
+    op.create_check_constraint("checkstatus", "users", CHK_STATUS)
+    op.execute("UPDATE users SET type={0}".format(UserType.user.value))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint("checktype", "users", type_="check")
+    op.drop_constraint("checkstatus", "users", type_="check")
+    op.drop_column("users", "type")
+    op.drop_table("organizations")
+
+    # ### end Alembic commands ###

py/helpers/login.py

@@ -15,7 +15,7 @@
 
 from API_operations.helpers.Service import Service
 from BO.Rights import NOT_AUTHORIZED
-from DB.User import User, UserStatus
+from DB.User import User, UserStatus, UserType
 from helpers.fastApiUtils import build_serializer
 
 NOT_AUTHORIZED_MAIL = "__id____" + NOT_AUTHORIZED
@@ -58,7 +58,7 @@ def validate_login(self, username: str, password: str) -> Union[str, bytes]:
                 func.lower(User.email) == func.lower(username),
                 User.status == UserStatus.active.value,
             )
-        db_users = user_qry.all()
+        db_users = user_qry.filter(User.type == UserType.user.value).all()
         assert len(db_users) == 1, NOT_AUTHORIZED
         the_user: User = db_users[0]
         # verif even user is not active , in order to let modify email only if mail_status is False