c2cgeoportal-commons 2.6.0__py3-none-any.whl → 2.8.1.180__py3-none-any.whl

c2cgeoportal_commons/lib/url.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2013-2021, Camptocamp SA
+# Copyright (c) 2013-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -27,89 +25,198 @@
 # 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 typing import Dict, Optional, Set
 
 from pyramid.request import Request
 
+LOG = logging.getLogger(__name__)
+
+
+class Url:
+    """Object representation of an URI."""
+
+    scheme = ""
+    _netloc = ""
+    _hostname: Optional[str] = None
+    _port: Optional[int] = None
+    path = ""
+    query: Dict[str, str] = {}
+    fragment = ""
+
+    def __init__(self, url: Optional[str] = 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) -> Optional[str]:
+        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) -> Optional[int]:
+        return self._port
+
+    @port.setter
+    def port(self, port: Optional[int]) -> 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 add_url_params(url: str, params: Optional[Dict[str, str]]) -> str:
-    if not params:
-        return url
-    return add_spliturl_params(urllib.parse.urlsplit(url), params)
+    def __str__(self) -> str:
+        return self.url()
 
+    def __repr__(self) -> str:
+        return self.url()
 
-def add_spliturl_params(spliturl: urllib.parse.SplitResult, params: Dict[str, str]) -> str:
-    query = {k: v[-1] for k, v in list(urllib.parse.parse_qs(spliturl.query).items())}
-    for key, value in list(params.items()):
-        if key not in query:
-            query[key] = value
 
-    return urllib.parse.urlunsplit(
-        (spliturl.scheme, spliturl.netloc, spliturl.path, urllib.parse.urlencode(query), spliturl.fragment)
-    )
+def get_url2(
+    name: str, url: str, request: Request, errors: Set[str], servers: Optional[Dict[str, str]] = None
+) -> Optional[Url]:
+    """
+    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", {})
 
-def get_url2(name: str, url: str, request: Request, errors: Set[str]) -> Optional[str]:
+    url_obj = Url(url)
     url_split = urllib.parse.urlsplit(url)
-    if url_split.scheme == "":
-        if url_split.netloc == "" and url_split.path not in ("", "/"):
+    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 urllib.parse.urlunsplit(url_split)
-        errors.add("{}='{}' is not an URL.".format(name, url))
+            return url_obj
+        errors.add(f"{name}='{url}' is not an URL.")
         return None
-    if url_split.scheme in ("http", "https"):
-        if url_split.netloc == "":
-            errors.add("{}='{}' is not a valid URL.".format(name, url))
+    if url_obj.scheme in ("http", "https"):
+        if url_obj.netloc == "":
+            errors.add(f"{name}='{url}' is not a valid URL.")
             return None
-        return urllib.parse.urlunsplit(url_split)
-    if url_split.scheme == "static":
-        if url_split.path in ("", "/"):
-            errors.add("{}='{}' cannot have an empty path.".format(name, url))
+        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_split.netloc
+        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(
-                    "{}='{}' static-ngeo shouldn't be used out of webpack because it don't has "
-                    "cache bustering.".format(name, url)
+                    f"{name}='{url}' static-ngeo shouldn't be used out of webpack because it don't has "
+                    "cache bustering."
                 )
-            proj = "{}_geoportal:{}".format(package, proj)
-        return request.static_url("{}{}".format(proj, url_split.path))
-    if url_split.scheme == "config":
-        if url_split.netloc == "":
-            errors.add("{}='{}' cannot have an empty netloc.".format(name, url))
+            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 = request.registry.settings.get("servers", {}).get(url_split.netloc)
+        server = servers.get(url_obj.netloc)
         if server is None:
             errors.add(
-                "{}: The server '{}' ({}) is not found in the config: [{}]".format(
-                    name,
-                    url_split.netloc,
-                    url,
-                    ", ".join(request.registry.settings.get("servers", {}).keys()),
-                )
+                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 = server["url"]
-            params: Dict[str, str] = server.get("params", {})
+            url_obj_server = Url(server["url"])
+            url_obj_server.add_query(server.get("params", {}))
         else:
-            url_split_server = urllib.parse.urlsplit(server)
-            params = dict(urllib.parse.parse_qsl(url_split_server.query))
-            url = urllib.parse.urlunsplit(url_split_server._replace(query=""))
-        params.update(dict(urllib.parse.parse_qsl(url_split.query)))
-
-        if url_split.path != "":
-            if url[-1] != "/":
-                url += "/"
-            url = urllib.parse.urljoin(url, url_split.path[1:])
-
-        return url if not params else "{}?{}".format(url, urllib.parse.urlencode(params))
-
+            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-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,11 +27,10 @@
 
 
 import logging
-from typing import Any, Dict, List, Optional, Union  # noqa
+from typing import Any, Dict, List
 
 import sqlalchemy.ext.declarative
-import sqlalchemy.ext.declarative.api
-import sqlalchemy.orm  # noqa
+import sqlalchemy.orm
 import zope.event
 
 try:
@@ -44,9 +41,9 @@ except ModuleNotFoundError:
     pass
 
 
-# Should be filed on application initialisation
+# Should be filed on application initialization
 DBSession: sqlalchemy.orm.Session = None
-Base: sqlalchemy.ext.declarative.api.ConcreteBase = sqlalchemy.ext.declarative.declarative_base()
+Base: sqlalchemy.ext.declarative.ConcreteBase = sqlalchemy.ext.declarative.declarative_base()
 DBSessions: Dict[str, sqlalchemy.orm.Session] = {}
 
 
@@ -54,10 +51,11 @@ LOG = logging.getLogger(__name__)
 
 
 class InvalidateCacheEvent:
-    pass
+    """Event to be broadcast."""
 
 
 def cache_invalidate_cb(*args: List[Any]) -> None:
+    """Invalidate the cache on a broadcast event."""
     _cache_invalidate_cb()
 
 
@@ -68,6 +66,5 @@ try:
     def _cache_invalidate_cb() -> None:
         zope.event.notify(InvalidateCacheEvent())
 
-
 except ModuleNotFoundError:
     LOG.error("c2cwsgiutils broadcast not found")