c2cgeoportal-commons 2.6.0__py3-none-any.whl → 2.9rc45__py3-none-any.whl

c2cgeoportal_commons/alembic/static/7ef947f30f20_add_oauth2_tables.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2020, Camptocamp SA
+# Copyright (c) 2020-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,7 +25,10 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 
-"""Add OAuth2 tables
+# pylint: disable=invalid-name
+
+"""
+Add OAuth2 tables.
 
 Revision ID: 7ef947f30f20
 Revises: 107b81f5b9fe
@@ -47,7 +48,8 @@ branch_labels = None
 depends_on = None
 
 
-def upgrade():
+def upgrade() -> None:
+    """Upgrade."""
     staticschema = config["schema_static"]
 
     # Instructions
@@ -103,7 +105,8 @@ def upgrade():
     )
 
 
-def downgrade():
+def downgrade() -> None:
+    """Downgrade."""
     staticschema = config["schema_static"]
 
     # Instructions

c2cgeoportal_commons/alembic/static/910b4ca53b68_sync_model_database.py

@@ -0,0 +1,186 @@
+# Copyright (c) 2024, Camptocamp SA
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies,
+# either expressed or implied, of the FreeBSD Project.
+
+# pylint: disable=invalid-name
+
+"""
+Sync the model and the database.
+
+Revision ID: 910b4ca53b68
+Revises: 76d72fb3fcb9
+Create Date: 2024-04-22 07:17:27.468564
+"""
+
+import sqlalchemy as sa
+from alembic import op
+from c2c.template.config import config
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "910b4ca53b68"
+down_revision = "76d72fb3fcb9"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade."""
+    staticschema = config["schema_static"]
+
+    # Add required fields in oauth2
+    op.alter_column(
+        "oauth2_authorizationcode",
+        "redirect_uri",
+        existing_type=sa.VARCHAR(),
+        nullable=False,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_authorizationcode",
+        "expire_at",
+        existing_type=postgresql.TIMESTAMP(timezone=True),
+        nullable=False,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_bearertoken",
+        "access_token",
+        existing_type=sa.VARCHAR(length=100),
+        nullable=False,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_bearertoken",
+        "refresh_token",
+        existing_type=sa.VARCHAR(length=100),
+        nullable=False,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_bearertoken",
+        "expire_at",
+        existing_type=postgresql.TIMESTAMP(timezone=True),
+        nullable=False,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_client", "client_id", existing_type=sa.VARCHAR(), nullable=False, schema=staticschema
+    )
+    op.alter_column(
+        "oauth2_client", "secret", existing_type=sa.VARCHAR(), nullable=False, schema=staticschema
+    )
+    op.alter_column(
+        "oauth2_client", "redirect_uri", existing_type=sa.VARCHAR(), nullable=False, schema=staticschema
+    )
+    op.execute(f"UPDATE {staticschema}.oauth2_client SET state_required = true WHERE state_required IS NULL")
+    op.alter_column(
+        "oauth2_client", "state_required", existing_type=sa.BOOLEAN(), nullable=False, schema=staticschema
+    )
+    op.execute(f"UPDATE {staticschema}.oauth2_client SET pkce_required = true WHERE pkce_required IS NULL")
+    op.alter_column(
+        "oauth2_client", "pkce_required", existing_type=sa.BOOLEAN(), nullable=False, schema=staticschema
+    )
+    # URL and creation are required
+    op.alter_column("shorturl", "url", existing_type=sa.VARCHAR(), nullable=False, schema=staticschema)
+    op.alter_column(
+        "shorturl", "creation", existing_type=postgresql.TIMESTAMP(), nullable=False, schema=staticschema
+    )
+    # Add default value to nb_hits
+    op.execute(f"UPDATE {staticschema}.shorturl SET nb_hits = 0 WHERE nb_hits IS NULL")
+    op.alter_column("shorturl", "nb_hits", existing_type=sa.INTEGER(), nullable=False, schema=staticschema)
+    # Add default value to is_password_changed and deactivated
+    op.execute(
+        f'UPDATE {staticschema}."user" SET is_password_changed = false WHERE is_password_changed IS NULL'
+    )
+    op.alter_column(
+        "user", "is_password_changed", existing_type=sa.BOOLEAN(), nullable=False, schema=staticschema
+    )
+    op.execute(f'UPDATE {staticschema}."user" SET deactivated = false WHERE deactivated IS NULL')
+    op.alter_column("user", "deactivated", existing_type=sa.BOOLEAN(), nullable=False, schema=staticschema)
+
+
+def downgrade() -> None:
+    """Downgrade."""
+    staticschema = config["schema_static"]
+
+    op.alter_column("user", "deactivated", existing_type=sa.BOOLEAN(), nullable=True, schema=staticschema)
+    op.alter_column(
+        "user", "is_password_changed", existing_type=sa.BOOLEAN(), nullable=True, schema=staticschema
+    )
+    op.alter_column("shorturl", "nb_hits", existing_type=sa.INTEGER(), nullable=True, schema=staticschema)
+    op.alter_column(
+        "shorturl", "creation", existing_type=postgresql.TIMESTAMP(), nullable=True, schema=staticschema
+    )
+    op.alter_column("shorturl", "url", existing_type=sa.VARCHAR(), nullable=True, schema=staticschema)
+    op.alter_column(
+        "oauth2_client", "pkce_required", existing_type=sa.BOOLEAN(), nullable=True, schema=staticschema
+    )
+    op.alter_column(
+        "oauth2_client", "state_required", existing_type=sa.BOOLEAN(), nullable=True, schema=staticschema
+    )
+    op.alter_column(
+        "oauth2_client", "redirect_uri", existing_type=sa.VARCHAR(), nullable=True, schema=staticschema
+    )
+    op.alter_column("oauth2_client", "secret", existing_type=sa.VARCHAR(), nullable=True, schema=staticschema)
+    op.alter_column(
+        "oauth2_client", "client_id", existing_type=sa.VARCHAR(), nullable=True, schema=staticschema
+    )
+    op.alter_column(
+        "oauth2_bearertoken",
+        "expire_at",
+        existing_type=postgresql.TIMESTAMP(timezone=True),
+        nullable=True,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_bearertoken",
+        "refresh_token",
+        existing_type=sa.VARCHAR(length=100),
+        nullable=True,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_bearertoken",
+        "access_token",
+        existing_type=sa.VARCHAR(length=100),
+        nullable=True,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_authorizationcode",
+        "expire_at",
+        existing_type=postgresql.TIMESTAMP(timezone=True),
+        nullable=True,
+        schema=staticschema,
+    )
+    op.alter_column(
+        "oauth2_authorizationcode",
+        "redirect_uri",
+        existing_type=sa.VARCHAR(),
+        nullable=True,
+        schema=staticschema,
+    )

c2cgeoportal_commons/alembic/static/aa41e9613256_wip_add_openid_connect_support.py

@@ -0,0 +1,64 @@
+# Copyright (c) 2024, Camptocamp SA
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies,
+# either expressed or implied, of the FreeBSD Project.
+
+# pylint: disable=invalid-name
+
+"""
+Add OpenID connect support.
+
+Revision ID: aa41e9613256
+Revises: 910b4ca53b68
+Create Date: 2024-08-30 15:56:31.163378
+"""
+
+
+from alembic import op
+from c2c.template.config import config
+
+# revision identifiers, used by Alembic.
+revision = "aa41e9613256"
+down_revision = "910b4ca53b68"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    """Upgrade."""
+    staticschema = config["schema_static"]
+
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_index(op.f("ix_main_static_user_email"), "user", ["email"], unique=False, schema=staticschema)
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    """Downgrade."""
+    staticschema = config["schema_static"]
+
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f("ix_main_static_user_email"), table_name="user", schema=staticschema)
+    # ### end Alembic commands ###

c2cgeoportal_commons/alembic/static/ae5e88f35669_add_table_user_role.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2018-2019, Camptocamp SA
+# Copyright (c) 2018-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,7 +25,10 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 
-"""Add table user_role and rename user.role_name to settings_role_id
+# pylint: disable=no-member,invalid-name
+
+"""
+Add table user_role and rename user.role_name to settings_role_id.
 
 Revision ID: ae5e88f35669
 Revises: 53d671b17b20
@@ -46,7 +47,8 @@ branch_labels = None
 depends_on = None
 
 
-def upgrade():
+def upgrade() -> None:
+    """Upgrade."""
     schema = config["schema"]
     staticschema = config["schema_static"]
 
@@ -57,43 +59,38 @@ def upgrade():
         schema=staticschema,
     )
     op.execute(
-        """
+        f"""
 INSERT INTO "{staticschema}"."user_role" ("user_id", "role_id")
 SELECT "user"."id", "role"."id"
 FROM "{staticschema}"."user"
-JOIN "{schema}"."role" ON "role"."name" = "user"."role_name";""".format(
-            schema=schema, staticschema=staticschema
-        )
+JOIN "{schema}"."role" ON "role"."name" = "user"."role_name";"""
     )
 
     op.add_column("user", Column("settings_role_id", Integer), schema=staticschema)
     op.execute(
-        """
+        f"""
 UPDATE "{staticschema}"."user"
 SET "settings_role_id" = "role"."id"
 FROM "{schema}"."role"
-WHERE "role"."name" = "user"."role_name";""".format(
-            schema=schema, staticschema=staticschema
-        )
+WHERE "role"."name" = "user"."role_name";"""
     )
 
     op.drop_column("user", "role_name", schema=staticschema)
 
 
-def downgrade():
+def downgrade() -> None:
+    """Downgrade."""
     schema = config["schema"]
     staticschema = config["schema_static"]
 
     op.add_column("user", Column("role_name", Unicode), schema=staticschema)
 
     op.execute(
-        """
+        f"""
 UPDATE "{staticschema}"."user"
 SET "role_name" = "role"."name"
 FROM "{schema}"."role"
-WHERE "role"."id" = "user"."settings_role_id";""".format(
-            schema=schema, staticschema=staticschema
-        )
+WHERE "role"."id" = "user"."settings_role_id";"""
     )
 
     op.drop_column("user", "settings_role_id", schema=staticschema)

c2cgeoportal_commons/alembic/static/bd029dbfc11a_fill_tech_data_column.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2019, Camptocamp SA
+# Copyright (c) 2019-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,7 +25,10 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 
-"""Fill tech_data column
+# pylint: disable=no-member,invalid-name
+
+"""
+Fill tech_data column.
 
 Revision ID: bd029dbfc11a
 Revises: 0c640a58a09a
@@ -44,11 +45,12 @@ branch_labels = None
 depends_on = None
 
 
-def upgrade():
+def upgrade() -> None:
+    """Upgrade."""
     staticschema = config["schema_static"]
 
-    op.execute("UPDATE {staticschema}.\"user\" SET tech_data = '';".format(staticschema=staticschema))
+    op.execute(f"UPDATE {staticschema}.\"user\" SET tech_data = '';")
 
 
-def downgrade():
-    pass
+def downgrade() -> None:
+    """Downgrade."""

c2cgeoportal_commons/lib/email_.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2013-2020, Camptocamp SA
+# Copyright (c) 2013-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -34,24 +32,23 @@ from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from email.utils import formatdate
 from socket import gaierror
-from typing import Any, Dict, List, cast
+from typing import Any, cast
 
 try:
     from pyramid.httpexceptions import HTTPInternalServerError
 except ModuleNotFoundError:
 
     class HTTPInternalServerError(BaseException):  # type: ignore
-        pass
+        """Fallback class."""
 
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
-def send_email_config(
-    settings: Dict[str, Any], email_config_name: str, email: str, **kwargs: Dict[str, Any]
-) -> None:  # pragma: no cover
+def send_email_config(settings: dict[str, Any], email_config_name: str, email: str, **kwargs: Any) -> None:
+    """Send an email from the config information."""
     smtp_config = settings["smtp"]
-    email_config = cast(Dict[str, str], settings[email_config_name])
+    email_config = cast(dict[str, str], settings[email_config_name])
 
     try:
         send_email(
@@ -62,16 +59,17 @@ def send_email_config(
             smtp_config,
         )
     except gaierror:
-        LOG.error("Unable to send the email.", exc_info=True)
-        raise HTTPInternalServerError("See server logs for details")
+        _LOG.exception("Unable to send the email.")
+        raise HTTPInternalServerError("See server logs for details")  # pylint: disable=raise-missing-from
 
 
 def send_email(
-    from_addr: str, to_addrs: List[str], body: str, subject: str, smtp_config: Dict[str, str]
-) -> None:  # pragma: no cover
+    from_addr: str, to_address: list[str], body: str, subject: str, smtp_config: dict[str, str]
+) -> None:
+    """Send an email."""
     msg = MIMEMultipart()
     msg["From"] = from_addr
-    msg["To"] = ", ".join(to_addrs)
+    msg["To"] = ", ".join(to_address)
     msg["Date"] = formatdate(localtime=True)
     msg["Subject"] = subject
     msg.attach(MIMEText(body, "plain", "utf-8"))
@@ -86,5 +84,5 @@ def send_email(
     if smtp_config.get("user", False):
         smtp.login(smtp_config["user"], smtp_config["password"])
 
-    smtp.sendmail(from_addr, to_addrs, msg.as_string())
+    smtp.sendmail(from_addr, to_address, msg.as_string())
     smtp.close()

c2cgeoportal_commons/lib/literal.py

@@ -0,0 +1,44 @@
+# Copyright (c) 2021-2024, Camptocamp SA
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# The views and conclusions contained in the software and documentation are those
+# of the authors and should not be interpreted as representing official policies,
+# either expressed or implied, of the FreeBSD Project.
+
+from typing import cast
+
+from pyramid.i18n import TranslationString
+from pyramid.threadlocal import get_current_request
+
+
+class Literal:
+    """For use in templates to mark a string as safe and avoid HTML escaping."""
+
+    def __init__(self, s: str | TranslationString) -> None:
+        self.s = s
+
+    def __html__(self) -> str:
+        return cast(str, get_current_request().translate(self.s))
+
+    def __bool__(self) -> bool:
+        return len(self.s) > 0