c2cgeoportal-commons 2.7.1.145__py3-none-any.whl → 2.9.0.350__py3-none-any.whl

c2cgeoportal_commons/alembic/static/910b4ca53b68_sync_model_database.py

@@ -0,0 +1,186 @@
+# Copyright (c) 2024-2025, 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 = false 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 = false 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-2025, 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,4 +1,4 @@
-# Copyright (c) 2018-2019, Camptocamp SA
+# Copyright (c) 2018-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -25,7 +25,7 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 
-# pylint: disable=no-member
+# pylint: disable=no-member,invalid-name
 
 """
 Add table user_role and rename user.role_name to settings_role_id.
@@ -59,24 +59,20 @@ def upgrade() -> None:
         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)
@@ -90,13 +86,11 @@ def downgrade() -> None:
     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,4 +1,4 @@
-# Copyright (c) 2019-2021, Camptocamp SA
+# Copyright (c) 2019-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -25,7 +25,7 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 
-# pylint: disable=no-member
+# pylint: disable=no-member,invalid-name
 
 """
 Fill tech_data column.

c2cgeoportal_commons/lib/email_.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2021, Camptocamp SA
+# Copyright (c) 2013-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -32,7 +32,7 @@ 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
@@ -42,13 +42,13 @@ except ModuleNotFoundError:
         """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: Any) -> None:
+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(
@@ -59,12 +59,12 @@ def send_email_config(settings: Dict[str, Any], email_config_name: str, email: s
             smtp_config,
         )
     except gaierror:
-        LOG.exception("Unable to send the email.")
+        _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_address: List[str], body: str, subject: str, smtp_config: Dict[str, str]
+    from_addr: str, to_address: list[str], body: str, subject: str, smtp_config: dict[str, str]
 ) -> None:
     """Send an email."""
     msg = MIMEMultipart()
@@ -74,15 +74,11 @@ def send_email(
     msg["Subject"] = subject
     msg.attach(MIMEText(body, "plain", "utf-8"))
 
-    # Connect to server
-    if smtp_config.get("ssl", False):
-        smtp: smtplib.SMTP = smtplib.SMTP_SSL(smtp_config["host"])
-    else:
-        smtp = smtplib.SMTP(smtp_config["host"])
-    if smtp_config.get("starttls", False):
-        smtp.starttls()
-    if smtp_config.get("user", False):
-        smtp.login(smtp_config["user"], smtp_config["password"])
-
-    smtp.sendmail(from_addr, to_address, msg.as_string())
-    smtp.close()
+    SMTPClass = smtplib.SMTP_SSL if smtp_config.get("ssl", False) else smtplib.SMTP
+    with SMTPClass(smtp_config["host"]) as smtp:
+        if smtp_config.get("starttls", False):
+            smtp.starttls()
+        if smtp_config.get("user", False):
+            smtp.login(smtp_config["user"], smtp_config["password"])
+
+        smtp.sendmail(from_addr, to_address, msg.as_string())

c2cgeoportal_commons/lib/literal.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2021-2021, Camptocamp SA
+# Copyright (c) 2021-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -25,7 +25,7 @@
 # of the authors and should not be interpreted as representing official policies,
 # either expressed or implied, of the FreeBSD Project.
 
-from typing import Union, cast
+from typing import cast
 
 from pyramid.i18n import TranslationString
 from pyramid.threadlocal import get_current_request
@@ -34,7 +34,7 @@ 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: Union[str, TranslationString]) -> None:
+    def __init__(self, s: str | TranslationString) -> None:
         self.s = s
 
     def __html__(self) -> str:

c2cgeoportal_commons/lib/url.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2021, Camptocamp SA
+# Copyright (c) 2013-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -28,11 +28,10 @@
 import logging
 import re
 import urllib.parse
-from typing import Dict, Optional, Set
 
 from pyramid.request import Request
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 
 class Url:
@@ -40,13 +39,13 @@ class Url:
 
     scheme = ""
     _netloc = ""
-    _hostname: Optional[str] = None
-    _port: Optional[int] = None
+    _hostname: str | None = None
+    _port: int | None = None
     path = ""
-    query: Dict[str, str] = {}
+    query: dict[str, str] = {}
     fragment = ""
 
-    def __init__(self, url: Optional[str] = None):
+    def __init__(self, url: str | None = None):
         if url:
             url_split = urllib.parse.urlsplit(url)
             self.scheme = url_split.scheme
@@ -55,7 +54,7 @@ class Url:
             try:
                 self._port = url_split.port
             except ValueError as error:
-                LOG.debug(error)
+                _LOG.debug(error)
             self.path = url_split.path
             self.query = dict(urllib.parse.parse_qsl(url_split.query))
             self.fragment = url_split.fragment
@@ -94,7 +93,7 @@ class Url:
         if len(netloc_split) == 2:
             allowed = re.compile(r"^[0-9]+$")
             if not allowed.match(netloc_split[1]):
-                LOG.debug("The netloc '%s' contains invalid port", netloc)
+                _LOG.debug("The netloc '%s' contains invalid port", netloc)
                 self._port = None
             else:
                 self._port = int(netloc_split[1])
@@ -104,7 +103,7 @@ class Url:
         self._hostname = netloc_split[0]
 
     @property
-    def hostname(self) -> Optional[str]:
+    def hostname(self) -> str | None:
         return self._hostname
 
     @hostname.setter
@@ -115,15 +114,15 @@ class Url:
         self.netloc = hostname if self._port is None else f"{hostname}:{self._port}"
 
     @property
-    def port(self) -> Optional[int]:
+    def port(self) -> int | None:
         return self._port
 
     @port.setter
-    def port(self, port: Optional[int]) -> None:
+    def port(self, port: int | None) -> None:
         self._port = port
         self.netloc = (self._hostname or "") if port is None else f"{self._hostname}:{port}"
 
-    def add_query(self, query: Dict[str, str], force: bool = False) -> "Url":
+    def add_query(self, query: dict[str, str], force: bool = False) -> "Url":
         if query:
             for key, value in query.items():
                 if force or key not in self.query:
@@ -131,7 +130,7 @@ class Url:
         return self
 
     @property
-    def query_lower(self) -> Dict[str, str]:
+    def query_lower(self) -> dict[str, str]:
         return {k.lower(): v for k, v in self.query.items()}
 
     def url(self) -> str:
@@ -153,8 +152,8 @@ class Url:
 
 
 def get_url2(
-    name: str, url: str, request: Request, errors: Set[str], servers: Optional[Dict[str, str]] = None
-) -> Optional[Url]:
+    name: str, url: str, request: Request, errors: set[str], servers: dict[str, str] | None = None
+) -> Url | None:
     """
     Get the real URL from the URI of the administration interface.
 

c2cgeoportal_commons/lib/validators.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2019-2020, Camptocamp SA
+# Copyright (c) 2019-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_commons/models/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2025, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,10 +27,11 @@
 
 
 import logging
-from typing import Any, Dict, List
+from typing import Any
 
 import sqlalchemy.ext.declarative
 import sqlalchemy.orm
+import sqlalchemy.orm.scoping
 import zope.event
 
 try:
@@ -41,20 +42,26 @@ except ModuleNotFoundError:
     pass
 
 
-# Should be filed on application initialisation
-DBSession: sqlalchemy.orm.Session = None
-Base: sqlalchemy.ext.declarative.ConcreteBase = sqlalchemy.ext.declarative.declarative_base()
-DBSessions: Dict[str, sqlalchemy.orm.Session] = {}
+# Should be filed on application initialization
+DBSession: sqlalchemy.orm.scoping.scoped_session[sqlalchemy.orm.Session] | None = None
 
 
-LOG = logging.getLogger(__name__)
+class BaseType(sqlalchemy.ext.declarative.DeclarativeMeta, type):
+    pass
+
+
+Base: BaseType = sqlalchemy.orm.declarative_base()
+DBSessions: dict[str, sqlalchemy.orm.scoping.scoped_session[sqlalchemy.orm.Session]] = {}
+
+
+_LOG = logging.getLogger(__name__)
 
 
 class InvalidateCacheEvent:
     """Event to be broadcast."""
 
 
-def cache_invalidate_cb(*args: List[Any]) -> None:
+def cache_invalidate_cb(*args: list[Any]) -> None:
     """Invalidate the cache on a broadcast event."""
     _cache_invalidate_cb()
 
@@ -67,4 +74,4 @@ try:
         zope.event.notify(InvalidateCacheEvent())
 
 except ModuleNotFoundError:
-    LOG.error("c2cwsgiutils broadcast not found")
+    _LOG.error("c2cwsgiutils broadcast not found")