c2cgeoportal-geoportal 2.7.1.156__py2.py3-none-any.whl → 2.8.1.180__py2.py3-none-any.whl

c2cgeoportal_geoportal/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -257,8 +257,8 @@ def _match_url_start(reference: str, value: List[str]) -> bool:
 
 def is_valid_referrer(request: pyramid.request.Request, settings: Optional[Dict[str, Any]] = None) -> bool:
     """Check if the referrer is valid."""
-    if request.referer is not None:
-        referrer = urlsplit(request.referer)._replace(query="", fragment="").geturl().rstrip("/").split("/")
+    if request.referrer is not None:
+        referrer = urlsplit(request.referrer)._replace(query="", fragment="").geturl().rstrip("/").split("/")
         if settings is None:
             settings = request.registry.settings
         list_ = settings.get("authorized_referers", [])
@@ -280,7 +280,8 @@ def create_get_user_from_request(
         Return ``None`` if:
         * user is anonymous
         * it does not exist in the database
-        * the referer is invalid
+        * it has been deactivated
+        * the referrer is invalid
         """
         from c2cgeoportal_commons.models import DBSession  # pylint: disable=import-outside-toplevel
         from c2cgeoportal_commons.models.static import User  # pylint: disable=import-outside-toplevel
@@ -288,7 +289,7 @@ def create_get_user_from_request(
         if not hasattr(request, "is_valid_referer"):
             request.is_valid_referer = is_valid_referrer(request, settings)
         if not request.is_valid_referer:
-            LOG.debug("Invalid referer for %s: %s", request.path_qs, repr(request.referer))
+            LOG.debug("Invalid referrer for %s: %s", request.path_qs, repr(request.referrer))
             return None
 
         if not hasattr(request, "user_"):
@@ -299,7 +300,10 @@ def create_get_user_from_request(
                 # We know we will need the role object of the
                 # user so we use joined loading
                 request.user_ = (
-                    DBSession.query(User).filter_by(username=username).options(joinedload("roles")).first()
+                    DBSession.query(User)
+                    .filter_by(username=username, deactivated=False)
+                    .options(joinedload("roles"))
+                    .first()
                 )
 
         return cast(User, request.user_)
@@ -453,7 +457,7 @@ def includeme(config: pyramid.config.Configurator) -> None:
     if metrics_config["total_python_object_memory"]:
         add_provider(TotalPythonObjectMemoryProvider())
 
-    # Initialise DBSessions
+    # Initialize DBSessions
     init_db_sessions(settings, config, health_check)
 
     checker.init(config, health_check)
@@ -468,13 +472,15 @@ def includeme(config: pyramid.config.Configurator) -> None:
         for name, cache_config in settings["cache"].items():
             caching.init_region(cache_config, name)
 
-            @zope.event.classhandler.handler(InvalidateCacheEvent)  # type: ignore
-            def handle(event: InvalidateCacheEvent) -> None:
-                del event
-                caching.invalidate_region()
-                if caching.MEMORY_CACHE_DICT:
-                    caching.get_region("std").delete_multi(list(caching.MEMORY_CACHE_DICT.keys()))
-                caching.MEMORY_CACHE_DICT.clear()
+        @zope.event.classhandler.handler(InvalidateCacheEvent)  # type: ignore
+        def handle(event: InvalidateCacheEvent) -> None:
+            del event
+            caching.invalidate_region("ogc-server")
+            caching.invalidate_region("std")
+            caching.invalidate_region("obj")
+            if caching.MEMORY_CACHE_DICT:
+                caching.get_region("std").delete_multi(list(caching.MEMORY_CACHE_DICT.keys()))
+            caching.MEMORY_CACHE_DICT.clear()
 
     # Register a tween to get back the cache buster path.
     if "cache_path" not in config.get_settings():
@@ -496,8 +502,10 @@ def includeme(config: pyramid.config.Configurator) -> None:
     config.add_directive("set_user_validator", set_user_validator)
     config.set_user_validator(default_user_validator)
 
+    config.add_route("oauth2introspect", "/oauth/introspect", request_method="POST")
     config.add_route("oauth2token", "/oauth/token", request_method="POST")
     config.add_route("oauth2loginform", "/oauth/login", request_method="GET")
+    config.add_route("oauth2revoke_token", "/oauth/revoke_token", request_method="GET")
     config.add_route("notlogin", "/notlogin", request_method="GET")
 
     config.add_route("dynamic", "/dynamic.json", request_method="GET")
@@ -666,6 +674,8 @@ def includeme(config: pyramid.config.Configurator) -> None:
     # Used memory in caches
     config.add_route("memory", "/memory", request_method="GET")
 
+    config.add_route("ogc_server_clear_cache", "clear-ogc-server-cache/{id}", request_method="GET")
+
     # Scan view decorator for adding routes
     config.scan(
         ignore=[

c2cgeoportal_geoportal/lib/authentication.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2014-2021, Camptocamp SA
+# Copyright (c) 2014-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -70,14 +70,14 @@ class UrlAuthenticationPolicy(CallbackAuthenticationPolicy):  # type: ignore
             return None
         try:
             if self.aeskey is None:  # pragma: nocover
-                raise Exception("urllogin is not configured")
+                raise Exception("urllogin is not configured")  # pylint: disable=broad-exception-raised
             now = int(time.time())
             data = binascii.unhexlify(auth_enc.encode("ascii"))
             nonce = data[0:16]
             tag = data[16:32]
             ciphertext = data[32:]
             cipher = AES.new(self.aeskey.encode("ascii"), AES.MODE_EAX, nonce)
-            auth = json.loads(cipher.decrypt_and_verify(ciphertext, tag).decode("utf-8"))  # type: ignore
+            auth = json.loads(cipher.decrypt_and_verify(ciphertext, tag).decode("utf-8"))
 
             if "t" in auth and "u" in auth and "p" in auth:
                 timestamp = int(auth["t"])
@@ -92,14 +92,12 @@ class UrlAuthenticationPolicy(CallbackAuthenticationPolicy):  # type: ignore
 
         return None
 
-    def remember(  # pylint: disable=no-self-use
-        self, request: pyramid.request.Request, userid: str, **kw: Any
-    ) -> List[Dict[str, str]]:
+    def remember(self, request: pyramid.request.Request, userid: str, **kw: Any) -> List[Dict[str, str]]:
         """Do no-op."""
         del request, userid, kw
         return []
 
-    def forget(self, request: pyramid.request.Request) -> List[Dict[str, str]]:  # pylint: disable=no-self-use
+    def forget(self, request: pyramid.request.Request) -> List[Dict[str, str]]:
         """Do no-op."""
         del request
         return []
@@ -134,17 +132,15 @@ class OAuth2AuthenticationPolicy(CallbackAuthenticationPolicy):  # type: ignore
         if valid:
             request.user_ = oauth2_request.user
 
-            return cast(str, request.user_.username)
+            return cast(str, request.user.username)
         return None
 
-    def remember(  # pylint: disable=no-self-use
-        self, request: pyramid.request.Request, userid: str, **kw: Any
-    ) -> List[Dict[str, str]]:
+    def remember(self, request: pyramid.request.Request, userid: str, **kw: Any) -> List[Dict[str, str]]:
         """Do no-op."""
         del request, userid, kw
         return []
 
-    def forget(self, request: pyramid.request.Request) -> List[Dict[str, str]]:  # pylint: disable=no-self-use
+    def forget(self, request: pyramid.request.Request) -> List[Dict[str, str]]:
         """Do no-op."""
         del request
         return []
@@ -177,7 +173,7 @@ def create_authentication(settings: Dict[str, Any]) -> MultiAuthenticationPolicy
     secret = settings["authtkt_secret"]
     basicauth = settings.get("basicauth", "False").lower() in ("true", "yes", "1")
     if len(secret) < 64:
-        raise Exception(
+        raise Exception(  # pylint: disable=broad-exception-raised
             '"authtkt_secret should be at least 64 characters.'
             "See https://docs.pylonsproject.org/projects/pyramid/en/latest/api/session.html"
         )
@@ -211,7 +207,7 @@ def create_authentication(settings: Dict[str, Any]) -> MultiAuthenticationPolicy
     if basicauth:
         if settings["authentication"].get("two_factor", False):
             LOG.warning(
-                "Basic auth and tow factor auth should not be enable toogether, "
+                "Basic auth and two factor auth should not be enable together, "
                 "you should use OAuth2 instead of Basic auth"
             )
 

c2cgeoportal_geoportal/lib/caching.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2012-2021, Camptocamp SA
+# Copyright (c) 2012-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -30,13 +30,14 @@ import inspect
 import logging
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional
 
+import pyramid.interfaces
 import sqlalchemy.ext.declarative
+import zope.interface
 from dogpile.cache.api import NO_VALUE, CacheBackend
 from dogpile.cache.backends.memory import MemoryBackend
 from dogpile.cache.backends.redis import RedisBackend, RedisSentinelBackend
 from dogpile.cache.region import CacheRegion, make_region
 from dogpile.cache.util import sha1_mangle_key
-from pyramid.request import Request
 from sqlalchemy.orm.util import identity_key
 
 from c2cgeoportal_commons.models import Base
@@ -82,7 +83,9 @@ def keygen_function(namespace: Any, function: Callable[..., Any]) -> Callable[..
         parts.extend(namespace)
         if ignore_first_argument:
             args = args[1:]
-        new_args: List[str] = [arg for arg in args if not isinstance(arg, Request)]
+        new_args: List[str] = [
+            arg for arg in args if pyramid.interfaces.IRequest not in zope.interface.implementedBy(type(arg))
+        ]
         parts.extend(map(str, map(map_dbobject, new_args)))
         return "|".join(parts)
 
@@ -100,8 +103,7 @@ def _configure_region(conf: Dict[str, Any], cache_region: CacheRegion) -> None:
     kwargs: Dict[str, Any] = {"replace_existing_backend": True}
     backend = conf["backend"]
     kwargs.update({k: conf[k] for k in conf if k != "backend"})
-    kwargs.setdefault("arguments", {})
-    kwargs["arguments"]["cache_dict"] = MEMORY_CACHE_DICT
+    kwargs.setdefault("arguments", {}).setdefault("cache_dict", MEMORY_CACHE_DICT)
     cache_region.configure(backend, **kwargs)
 
 
@@ -124,7 +126,7 @@ def invalidate_region(region: Optional[str] = None) -> None:
 class HybridRedisBackend(CacheBackend):  # type: ignore
     """A Dogpile cache backend with a memory cache backend in front of a Redis backend for performance."""
 
-    def __init__(self, arguments: Dict[str, Any]):  # pylint: disable=super-init-not-called
+    def __init__(self, arguments: Dict[str, Any]):
         self._use_memory_cache = not arguments.pop("disable_memory_cache", False)
         self._memory = MemoryBackend({"cache_dict": arguments.pop("cache_dict", {})})
         self._redis = RedisBackend(arguments)

c2cgeoportal_geoportal/lib/checker.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -122,7 +122,9 @@ def _pdf3(settings: Dict[str, Any], health_check: c2cwsgiutils.health_check.Heal
 
             status = resp.json()
             if "error" in status:
-                raise Exception(f"Failed to do the printing: {status['error']}")
+                raise Exception(  # pylint: disable=broad-exception-raised
+                    f"Failed to do the printing: {status['error']}",
+                )
             done = status["done"]
 
         path = request.route_path("printproxy_report_get", ref=job["ref"])
@@ -204,7 +206,9 @@ def _lang_files(
             if type_ == "ngeo":
                 url = f"/etc/geomapfish/static/{lang}.json"
             else:
-                raise Exception(f"Your language type value '{type_}' is not valid, available values [ngeo]")
+                raise Exception(  # pylint: disable=broad-exception-raised
+                    f"Your language type value '{type_}' is not valid, available values [ngeo]",
+                )
 
             name = f"checker_lang_{type_}_{lang}"
 
@@ -248,7 +252,7 @@ def _phantomjs(settings: Dict[str, Any], health_check: c2cwsgiutils.health_check
                 path = request.route_path(self.route["name"], _query=self.route.get("params", {}))
                 url: str = cast(str, build_url("Check", path, request)["url"])
 
-                cmd: List[str] = ["node", "/usr/bin/check-example.js", url]
+                cmd: List[str] = ["check-example", url]
                 env = dict(os.environ)
                 for name, value in self.route.get("environment", {}).items():
                     if isinstance(value, (list, dict)):
@@ -260,12 +264,12 @@ def _phantomjs(settings: Dict[str, Any], health_check: c2cwsgiutils.health_check
                 try:
                     subprocess.check_output(cmd, env=env, timeout=70)
                 except subprocess.CalledProcessError as exception:
-                    raise Exception(
+                    raise Exception(  # pylint: disable=broad-exception-raised
                         f"{' '.join(exception.cmd)} exit with code: {exception.returncode}\n"
                         f"{exception.output.decode('utf-8')[:10000]}"
                     ) from exception
                 except subprocess.TimeoutExpired as exception:
-                    raise Exception(
+                    raise Exception(  # pylint: disable=broad-exception-raised
                         f"""Timeout:
 command: {' '.join(exception.cmd)}
 output:

c2cgeoportal_geoportal/lib/common_headers.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2012-2021, Camptocamp SA
+# Copyright (c) 2012-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -33,8 +33,6 @@ from typing import Any, Dict, List, Optional, cast
 import pyramid.request
 import pyramid.response
 
-from c2cgeoportal_geoportal.lib import is_intranet
-
 _LOG = logging.getLogger(__name__)
 
 
@@ -119,6 +117,8 @@ def _set_common_headers(
 ) -> pyramid.response.Response:
     """Set the common headers."""
 
+    del request  # Unused
+
     response.headers.update(service_headers_settings.get("headers", {}))
 
     if cache in (Cache.PRIVATE, Cache.PRIVATE_NO):
@@ -136,12 +136,9 @@ def _set_common_headers(
     elif cache in (Cache.PUBLIC, Cache.PUBLIC_NO):
         response.cache_control.public = True
     elif cache in (Cache.PRIVATE, Cache.PRIVATE_NO):
-        if hasattr(request, "user") and request.user is not None or is_intranet(request):
-            response.cache_control.private = True
-        else:
-            response.cache_control.public = True
+        response.cache_control.private = True
     else:
-        raise Exception("Invalid cache type")
+        raise Exception("Invalid cache type")  # pylint: disable=broad-exception-raised
 
     if content_type is not None:
         response.content_type = content_type

c2cgeoportal_geoportal/lib/dbreflection.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2011-2021, Camptocamp SA
+# Copyright (c) 2011-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -176,16 +176,16 @@ def _create_class(
     from c2cgeoportal_commons.models import Base  # pylint: disable=import-outside-toplevel
 
     exclude_properties = exclude_properties or ()
-    attributes = dict(
-        __table__=table,
-        __mapper_args__={"exclude_properties": exclude_properties},
-        __attributes_order__=attributes_order,
-        __enumerations_config__=enumerations_config,
-    )
+    attributes = {
+        "__table__": table,
+        "__mapper_args__": {"exclude_properties": exclude_properties},
+        "__attributes_order__": attributes_order,
+        "__enumerations_config__": enumerations_config,
+    }
     if pk_name is not None:
         attributes[pk_name] = Column(Integer, primary_key=True)
     # The randint is to fix the SAWarning: This declarative base already contains a class with the same
-    # class name and module nam
+    # class name and module name
     cls = type(
         f"{table.name.capitalize()}_{random.randint(0, 9999999)}", (GeoInterface, Base), attributes  # nosec
     )

c2cgeoportal_geoportal/lib/filter_capabilities.py

@@ -34,6 +34,7 @@ from typing import Any, Callable, Dict, List, Optional, Set, Union
 from xml.sax.saxutils import XMLFilterBase, XMLGenerator  # nosec
 
 import defusedxml.expatreader
+import pyramid.httpexceptions
 import pyramid.request
 import requests
 from owslib.map.wms111 import ContentMetadata as ContentMetadata111
@@ -153,6 +154,9 @@ def filter_wfst_capabilities(content: str, wfs_url: Url, request: pyramid.reques
 
     writable_layers: Set[str] = set()
     ogc_server_ids = get_ogc_server_wfs_url_ids(request, request.host).get(wfs_url.url())
+    if ogc_server_ids is None:
+        LOG.error("No OGC server found for WFS URL %s", wfs_url)
+        raise pyramid.httpexceptions.HTTPInternalServerError("No OGC server found for WFS URL")
 
     for gmf_layer in list(get_writable_layers(request, ogc_server_ids).values()):
         writable_layers |= set(gmf_layer.layer.split(","))
@@ -260,7 +264,7 @@ class _CapabilitiesFilter(XMLFilterBase):
     def endPrefixMapping(self, prefix: str) -> None:  # noqa: ignore=N802
         self._downstream.endPrefixMapping(prefix)  # type: ignore
 
-    def startElement(self, name: str, attrs: xml.sax.xmlreader.AttributesImpl) -> None:  # noqa: ignore=N802
+    def startElement(self, name: str, attrs: Dict[str, str]) -> None:  # noqa: ignore=N802
         if name == self.tag_name:
             self.level += 1
             if self.layers_path:

c2cgeoportal_geoportal/lib/lingua_extractor.py

@@ -62,6 +62,10 @@ if TYPE_CHECKING:
     from c2cgeoportal_commons.models import main  # pylint: disable=ungrouped-imports,useless-suppression
 
 
+class LinguaExtractorException(Exception):
+    """Exception raised when an error occurs during the extraction."""
+
+
 def _get_config(key: str, default: Optional[str] = None) -> Optional[str]:
     """
     Return the config value for passed key.
@@ -170,8 +174,7 @@ class GeomapfishAngularExtractor(Extractor):  # type: ignore
                 empty_template = Template("")  # nosec
 
                 class Lookup(TemplateLookup):  # type: ignore
-                    @staticmethod
-                    def get_template(uri: str) -> Template:
+                    def get_template(self, uri: str) -> Template:
                         del uri  # unused
                         return empty_template
 
@@ -220,10 +223,7 @@ class GeomapfishAngularExtractor(Extractor):  # type: ignore
                 print(traceback.format_exc())
 
         # Path in geomapfish-tools
-        script_path = "geoportal/tools/extract-messages.js"
-        if not os.path.isfile(script_path):
-            # Path in geomapfish runner
-            script_path = "/app/tools/extract-messages.js"
+        script_path = "/opt/c2cgeoportal/geoportal/extract-messages.js"
         message_str = subprocess.check_output(["node", script_path, int_filename]).decode("utf-8")
         if int_filename != filename:
             os.unlink(int_filename)
@@ -246,8 +246,8 @@ def init_db(settings: Dict[str, Any]) -> None:
     """
     Initialize the SQLAlchemy Session.
 
-    First test the connection, on wen environment it should be OK, with the command line we should get
-    an exception ind initialise the connection.
+    First test the connection, on when environment it should be OK, with the command line we should get
+    an exception ind initialize the connection.
     """
 
     try:
@@ -257,7 +257,6 @@ def init_db(settings: Dict[str, Any]) -> None:
         session = DBSession()
         session.query(Theme).count()
     except:  # pylint: disable=bare-except
-
         # Init db sessions
 
         class R:
@@ -305,7 +304,7 @@ class GeomapfishConfigExtractor(Extractor):  # type: ignore
             # For the print config
             if "templates" in gmf_config:
                 return self._collect_print_config(gmf_config, filename)
-            raise Exception("Not a known config file")
+            raise Exception("Not a known config file")  # pylint: disable=broad-exception-raised
 
     def _collect_app_config(self, filename: str) -> List[Message]:
         config.init(filename)
@@ -797,7 +796,7 @@ class GeomapfishThemeExtractor(Extractor):  # type: ignore
                     )
                     print(f"Response: {response.status_code} {response.reason}\n{response.text}")
                     if _get_config_str("IGNORE_I18N_ERRORS", "FALSE") != "TRUE":
-                        raise Exception(response.reason)
+                        raise LinguaExtractorException(response.reason)
             except Exception as e:
                 print(colorize(str(e), Color.RED))
                 rendered_headers = " ".join(
@@ -859,7 +858,7 @@ class GeomapfishThemeExtractor(Extractor):  # type: ignore
                 )
                 if _get_config_str("IGNORE_I18N_ERRORS", "FALSE") == "TRUE":
                     return [], []
-                raise Exception("Aborted")
+                raise Exception("Aborted")  # pylint: disable=broad-exception-raised
 
             try:
                 describe = parseString(response.text)

c2cgeoportal_geoportal/lib/loader.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2021, Camptocamp SA
+# Copyright (c) 2019-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without