c2cgeoportal-commons 2.5.0.100__py3-none-any.whl → 2.9rc44__py3-none-any.whl

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
@@ -28,30 +26,29 @@
 # either expressed or implied, of the FreeBSD Project.
 
 
+import logging
+import smtplib
 from email.mime.multipart import MIMEMultipart
 from email.mime.text import MIMEText
 from email.utils import formatdate
-import logging
-import smtplib
 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

c2cgeoportal_commons/lib/url.py

@@ -0,0 +1,221 @@
+# Copyright (c) 2013-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.
+
+import logging
+import re
+import urllib.parse
+
+from pyramid.request import Request
+
+_LOG = logging.getLogger(__name__)
+
+
+class Url:
+    """Object representation of an URI."""
+
+    scheme = ""
+    _netloc = ""
+    _hostname: str | None = None
+    _port: int | None = None
+    path = ""
+    query: dict[str, str] = {}
+    fragment = ""
+
+    def __init__(self, url: str | None = None):
+        if url:
+            url_split = urllib.parse.urlsplit(url)
+            self.scheme = url_split.scheme
+            self._netloc = url_split.netloc
+            self._hostname = url_split.hostname
+            try:
+                self._port = url_split.port
+            except ValueError as error:
+                _LOG.debug(error)
+            self.path = url_split.path
+            self.query = dict(urllib.parse.parse_qsl(url_split.query))
+            self.fragment = url_split.fragment
+
+    def clone(self) -> "Url":
+        result = Url()
+        result.scheme = self.scheme
+        result._netloc = self._netloc  # pylint: disable=protected-access
+        result._hostname = self._hostname  # pylint: disable=protected-access
+        result._port = self._port  # pylint: disable=protected-access
+        result.path = self.path
+        result.query = dict(self.query)
+        result.fragment = self.fragment
+        return result
+
+    @staticmethod
+    def _is_valid_hostname(hostname: str) -> bool:
+        if len(hostname) > 255:
+            return False
+        if hostname[-1] == ".":
+            hostname = hostname[:-1]  # strip exactly one dot from the right, if present
+        allowed = re.compile(r"(?!-)[a-z\d-]{1,63}(?<!-)$", re.IGNORECASE)
+        return all(allowed.match(x) for x in hostname.split("."))
+
+    @property
+    def netloc(self) -> str:
+        return self._netloc
+
+    @netloc.setter
+    def netloc(self, netloc: str) -> None:
+        netloc_split = netloc.split(":")
+        if len(netloc_split) > 2:
+            raise RuntimeError(f"The netloc '{netloc}' in invalid")
+        if not self._is_valid_hostname(netloc_split[0]):
+            raise RuntimeError(f"The netloc '{netloc}' in invalid")
+        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)
+                self._port = None
+            else:
+                self._port = int(netloc_split[1])
+        else:
+            self._port = None
+        self._netloc = netloc
+        self._hostname = netloc_split[0]
+
+    @property
+    def hostname(self) -> str | None:
+        return self._hostname
+
+    @hostname.setter
+    def hostname(self, hostname: str) -> None:
+        if not self._is_valid_hostname(hostname):
+            raise RuntimeError(f"The hostname '{hostname}' in invalid")
+        self._hostname = hostname
+        self.netloc = hostname if self._port is None else f"{hostname}:{self._port}"
+
+    @property
+    def port(self) -> int | None:
+        return self._port
+
+    @port.setter
+    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":
+        if query:
+            for key, value in query.items():
+                if force or key not in self.query:
+                    self.query[key] = value
+        return self
+
+    @property
+    def query_lower(self) -> dict[str, str]:
+        return {k.lower(): v for k, v in self.query.items()}
+
+    def url(self) -> str:
+        return urllib.parse.urlunsplit(
+            (
+                self.scheme,
+                self._netloc,
+                self.path,
+                urllib.parse.urlencode(self.query),
+                self.fragment,
+            )
+        )
+
+    def __str__(self) -> str:
+        return self.url()
+
+    def __repr__(self) -> str:
+        return self.url()
+
+
+def get_url2(
+    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.
+
+    Manage the schema: static and config.
+    """
+    if servers is None:
+        servers = request.registry.settings.get("servers", {})
+
+    url_obj = Url(url)
+    url_split = urllib.parse.urlsplit(url)
+    if url_obj.scheme == "":
+        if url_obj.netloc == "" and url_obj.path not in ("", "/"):
+            # Relative URL like: /dummy/static/url or dummy/static/url
+            return url_obj
+        errors.add(f"{name}='{url}' is not an URL.")
+        return None
+    if url_obj.scheme in ("http", "https"):
+        if url_obj.netloc == "":
+            errors.add(f"{name}='{url}' is not a valid URL.")
+            return None
+        return url_obj
+    if url_obj.scheme == "static":
+        if request is None:
+            errors.add(f"{name}='{url}' The request is required for static URL.")
+        if url_obj.path in ("", "/"):
+            errors.add(f"{name}='{url}' cannot have an empty path.")
+            return None
+        proj = url_obj.netloc
+        package = request.registry.settings["package"]
+        if proj in ("", "static"):
+            proj = "/etc/geomapfish/static"
+        elif ":" not in proj:
+            if proj == "static-ngeo":
+                errors.add(
+                    f"{name}='{url}' static-ngeo shouldn't be used out of webpack because it don't has "
+                    "cache bustering."
+                )
+            proj = f"{package}_geoportal:{proj}"
+        return Url(request.static_url(f"{proj}{url_split.path}"))
+    if url_obj.scheme == "config":
+        if url_obj.netloc == "":
+            errors.add(f"{name}='{url}' cannot have an empty netloc.")
+            return None
+        server = servers.get(url_obj.netloc)
+        if server is None:
+            errors.add(
+                f"{name}: The server '{url_obj.netloc}' ({url}) is not found in the config: "
+                f"[{', '.join(servers.keys())}]"
+            )
+            return None
+
+        if isinstance(server, dict):
+            url_obj_server = Url(server["url"])
+            url_obj_server.add_query(server.get("params", {}))
+        else:
+            url_obj_server = Url(server)
+
+        if url_obj.path != "":
+            if url_obj_server.path == "" or url_obj_server.path[-1] != "/":
+                url_obj_server.path += "/"
+            url_obj_server.path = urllib.parse.urljoin(url_obj_server.path, url_obj.path[1:])
+        url_obj_server.add_query(url_obj.query, force=True)
+        url_obj_server.fragment = url_obj.fragment
+        return url_obj_server
+    return None

c2cgeoportal_commons/lib/validators.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2019-2020, Camptocamp SA
+# Copyright (c) 2019-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -33,5 +31,5 @@ import re
 import colander
 
 # Custom url validator that allow c2cgeoportal static urls.
-URL_REGEX = r"(?:{}|^(:?static|config)://\S+$)".format(colander.URL_REGEX)
+URL_REGEX = rf"(?:{colander.URL_REGEX}|^(:?static|config)://\S+$)"
 url = colander.Regex(URL_REGEX, msg=colander._("Must be a URL"), flags=re.IGNORECASE)

c2cgeoportal_commons/models/__init__.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2011-2020, Camptocamp SA
+# Copyright (c) 2011-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,11 +27,11 @@
 
 
 import logging
-from typing import Any, Dict, List, Optional, Union  # noqa
+from typing import Any
 
 import sqlalchemy.ext.declarative
-import sqlalchemy.ext.declarative.api
-import sqlalchemy.orm  # noqa
+import sqlalchemy.orm
+import sqlalchemy.orm.scoping
 import zope.event
 
 try:
@@ -44,20 +42,27 @@ except ModuleNotFoundError:
     pass
 
 
-# Should be filed on application initialisation
-DBSession: sqlalchemy.orm.Session = None
-Base: sqlalchemy.ext.declarative.api.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
+
+
+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__)
+_LOG = logging.getLogger(__name__)
 
 
 class InvalidateCacheEvent:
-    pass
+    """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()
 
 
@@ -68,6 +73,5 @@ try:
     def _cache_invalidate_cb() -> None:
         zope.event.notify(InvalidateCacheEvent())
 
-
 except ModuleNotFoundError:
-    LOG.error("c2cwsgiutils broadcast not found")
+    _LOG.error("c2cwsgiutils broadcast not found")