c2cgeoportal-geoportal 2.3.5.79__py3-none-any.whl → 2.9rc1__py3-none-any.whl

c2cgeoportal_geoportal/lib/xsd.py

@@ -0,0 +1,166 @@
+# Copyright (c) 2018-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 xml.etree.ElementTree  # nosec
+from collections.abc import Callable
+from io import BytesIO
+from typing import Any, cast
+
+import sqlalchemy.orm.mapper
+import sqlalchemy.sql.elements
+import sqlalchemy.sql.schema
+from papyrus.xsd import XSDGenerator as PapyrusXSDGenerator
+from papyrus.xsd import tag
+from sqlalchemy.orm.properties import ColumnProperty
+from sqlalchemy.orm.util import class_mapper
+
+
+def _element_callback(tb: str, column: sqlalchemy.sql.elements.NamedColumn[Any]) -> None:
+    if column.info.get("readonly"):
+        with tag(tb, "xsd:annotation"):
+            with tag(tb, "xsd:appinfo"):
+                with tag(tb, "readonly", {"value": "true"}):
+                    pass
+
+
+class XSDGenerator(PapyrusXSDGenerator):  # type: ignore
+    """Extends the PapyrusXSDGenerator."""
+
+    def __init__(
+        self,
+        include_primary_keys: bool = False,
+        include_foreign_keys: bool = False,
+        sequence_callback: Callable[[xml.etree.ElementTree.TreeBuilder, type[str]], None] | None = None,
+        element_callback: (
+            Callable[[xml.etree.ElementTree.TreeBuilder, sqlalchemy.sql.expression.ColumnElement[Any]], None]
+            | None
+        ) = None,
+    ) -> None:
+        super().__init__(
+            include_primary_keys=include_primary_keys,
+            include_foreign_keys=include_foreign_keys,
+            sequence_callback=sequence_callback,
+            element_callback=element_callback or _element_callback,
+        )
+
+    def add_class_properties_xsd(self, tb: str, cls: type) -> None:
+        """
+        Add the XSD for the class properties to the ``TreeBuilder``.
+
+        And call the user ``sequence_callback``.
+        """
+        mapper: sqlalchemy.orm.Mapper[Any] = class_mapper(cls)
+        properties = []
+        if cls.__attributes_order__:  # type: ignore[attr-defined]
+            for attribute_name in cls.__attributes_order__:  # type: ignore[attr-defined]
+                attr = mapper.attrs.get(attribute_name)
+                if attr:
+                    properties.append(attr)
+
+            # Add other attributes
+            for p in mapper.iterate_properties:
+                if p not in properties:
+                    properties.append(p)
+        else:
+            properties = mapper.iterate_properties
+
+        for p in properties:
+            if isinstance(p, ColumnProperty):
+                self.add_column_property_xsd(tb, p)
+
+        if self.sequence_callback:
+            self.sequence_callback(tb, cls)
+
+    def add_column_property_xsd(self, tb: str, column_property: ColumnProperty[Any]) -> None:
+        column = column_property.columns[0]
+        if column.foreign_keys:
+            self.add_association_proxy_xsd(tb, column_property)
+            return
+
+        super().add_column_property_xsd(tb, column_property)
+
+    def add_association_proxy_xsd(self, tb: str, column_property: ColumnProperty[Any]) -> None:
+        from c2cgeoportal_commons.models import DBSession  # pylint: disable=import-outside-toplevel
+
+        assert DBSession is not None
+
+        column = column_property.columns[0]
+        proxy = column.info["association_proxy"]
+        attribute = column_property.class_attribute
+        cls = attribute.parent.entity
+        association_proxy = getattr(cls, proxy)
+        relationship_property = class_mapper(cls).get_property(association_proxy.target)
+        target_cls = relationship_property.argument
+        query = DBSession.query(getattr(target_cls, association_proxy.value_attr))
+        if association_proxy.order_by is not None:
+            query = query.order_by(getattr(target_cls, association_proxy.order_by))
+        attrs = {}
+        if association_proxy.nullable:
+            attrs["minOccurs"] = "0"
+            attrs["nillable"] = "true"
+        attrs["name"] = proxy
+        with tag(tb, "xsd:element", attrs) as tb2:
+            with tag(tb2, "xsd:simpleType") as tb3:
+                with tag(tb3, "xsd:restriction", {"base": "xsd:string"}) as tb4:
+                    for (value,) in query:
+                        with tag(tb4, "xsd:enumeration", {"value": value}):
+                            pass
+            self.element_callback(tb4, column)
+
+
+class XSD:
+    """The XSD file generator on a pyramid view."""
+
+    def __init__(
+        self,
+        include_primary_keys: bool = False,
+        include_foreign_keys: bool = False,
+        sequence_callback: Callable[[xml.etree.ElementTree.TreeBuilder, type[str]], None] | None = None,
+        element_callback: (
+            Callable[[xml.etree.ElementTree.TreeBuilder, sqlalchemy.sql.expression.ColumnElement[Any]], None]
+            | None
+        ) = None,
+    ) -> None:
+        self.generator = XSDGenerator(
+            include_primary_keys=include_primary_keys,
+            include_foreign_keys=include_foreign_keys,
+            sequence_callback=sequence_callback,
+            element_callback=element_callback,
+        )
+
+    def __call__(self, table: str) -> Callable[[type[str] | type[bytes], dict[str, Any]], bytes | None]:
+        def _render(cls: type[str] | type[bytes], system: dict[str, Any]) -> bytes | None:
+            request = system.get("request")
+            if request is not None:
+                response = request.response
+                response.content_type = "application/xml"
+                io = self.generator.get_class_xsd(BytesIO(), cls)
+                return cast(bytes, io.getvalue())
+            return None
+
+        return _render

c2cgeoportal_geoportal/resources.py

@@ -0,0 +1,49 @@
+# Copyright (c) 2011-2023, 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 pyramid.request
+
+
+class Root:
+    """The pyramid root object."""
+
+    def __init__(self, request: pyramid.request.Request):
+        self.request = request
+
+
+def defaultgroupsfinder(username: str, request: pyramid.request.Request) -> list[str]:
+    """
+    Get the c2cgeoportal default group finder.
+
+    To be used as the callback of the ``AuthTktAuthenticationPolicy`` or any callback-based authentication
+    policy.
+    """
+    del username  # unused
+    if not hasattr(request, "user") or request.user is None:
+        return []
+    return [role.name for role in request.user.roles]

c2cgeoportal_geoportal/scaffolds/advance_create/ci/config.yaml

@@ -0,0 +1,26 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/camptocamp/c2cciutils/master/c2cciutils/schema.json
+
+checks:
+  black: False
+  isort: False
+  prettier: False
+  codespell: False
+  eof: False
+  required_workflows: False
+  dependabot_config: False
+  prospector_config: False
+  setup: False
+
+version:
+  branch_to_version_re:
+    - from: (prod-[0-9]+-[0-9]+)
+      to: \1
+    - from: (int-[0-9]+-[0-9]+)
+      to: \1
+
+publish:
+  pypi: false
+  docker:
+    images:
+      - name: camptocamp/{{cookiecutter.package}}-config
+      - name: camptocamp/{{cookiecutter.package}}-geoportal

c2cgeoportal_geoportal/scaffolds/advance_create/cookiecutter.json

@@ -0,0 +1,18 @@
+{
+  "project": "test_project",
+  "package": "test_project",
+  "srid": "2056",
+  "extent": "",
+  "extent_mapserver": "",
+  "authtkt_secret": "",
+  "unsafe_long_version": false,
+  "geomapfish_version": "",
+  "geomapfish_main_version": "",
+  "geomapfish_main_version_dash": "",
+  "geomapfish_main_minor_version": "",
+  "geomapfish_version_tag": "",
+  "geomapfish_version_tag_env": "",
+  "geomapfish_major_version_tag": "",
+  "geomapfish_major_version_tag_env": "",
+  "_copy_without_render": ["*.po", "*/contextualdata.html"]
+}

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/.dockerignore

@@ -0,0 +1,6 @@
+Dockerfile
+vars*.yaml
+CONST_vars.yaml
+CONST_config-schema.yaml
+{{cookiecutter.package}}_geoportal/locale
+{{cookiecutter.package}}_geoportal/static

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/.eslintrc.yaml

@@ -0,0 +1,19 @@
+extends:
+  - eslint:recommended
+
+globals:
+  '{{cookiecutter.package}}': false
+
+env:
+  es6: true
+  node: true
+  browser: true
+  jquery: true
+
+parserOptions:
+  sourceType: module
+  ecmaVersion: 2020
+
+rules:
+  no-console: 0
+  no-unused-vars: 0

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/.prospector.yaml

@@ -0,0 +1,30 @@
+inherits:
+  - duplicated
+  - utils:no-design-checks
+
+max-line-length: 110
+
+pycodestyle:
+  options:
+    max-line-length: 110
+  disable:
+    - E203
+
+pylint:
+  options:
+    max-line-length: 110
+  disable:
+    - too-many-locals
+    - too-many-statements
+    - too-many-branches
+    - c-extension-no-member
+
+pyflakes:
+  disable:
+    - F401
+
+mccabe:
+  run: false
+
+bandit:
+  run: true

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/Dockerfile

@@ -0,0 +1,75 @@
+ARG {{cookiecutter.geomapfish_version_tag}}
+ARG {{cookiecutter.geomapfish_major_version_tag}}
+
+FROM camptocamp/geomapfish-tools:{{cookiecutter.geomapfish_version_tag_env}} AS builder
+LABEL maintainer Camptocamp "info@camptocamp.com"
+
+COPY requirements.txt /tmp/requirements.txt
+RUN --mount=type=cache,target=/root/.cache \
+    python3 -m pip install --disable-pip-version-check --requirement=/tmp/requirements.txt
+
+WORKDIR /app
+COPY webpack.*.js Makefile CONST_Makefile /app/
+COPY {{cookiecutter.package}}_geoportal/static-ngeo /app/{{cookiecutter.package}}_geoportal/static-ngeo
+RUN make apps
+
+COPY . /app
+
+RUN make build
+RUN mv webpack.apps.js webpack.apps.js.tmpl
+
+ENTRYPOINT [ "/usr/bin/eval-templates" ]
+CMD [ "webpack", "serve", "--open", "--mode=development", "--watch", "--no-inline" ]
+
+###############################################################################
+
+FROM camptocamp/geomapfish:{{cookiecutter.geomapfish_major_version_tag_env}} AS runner
+
+COPY requirements.txt /tmp/requirements.txt
+RUN --mount=type=cache,target=/root/.cache \
+    python3 -m pip install --disable-pip-version-check --requirement=/tmp/requirements.txt
+
+WORKDIR /app
+COPY . /app
+# Workaround, see:https://github.com/moby/moby/issues/37965
+RUN true
+COPY --from=builder /opt/c2cgeoportal/geoportal/node_modules/ngeo/dist/* /etc/static-ngeo/
+RUN rm /etc/static-ngeo/*.html
+COPY --from=builder /etc/static-ngeo/* /etc/static-ngeo/
+COPY --from=builder /app/alembic.ini /app/alembic.yaml ./
+RUN chmod go+w /etc/static-ngeo/
+
+RUN --mount=type=cache,target=/root/.cache \
+    python3 -m pip install --disable-pip-version-check --editable=/app/ \
+    && python3 -m compileall -q /venv/lib/python3.* \
+        -x '/(ptvsd|.*pydev.*|networkx|scaffolds|yaml_include)/' \
+    && python3 -m compileall -q /app/{{cookiecutter.package}}_geoportal -x /app/{{cookiecutter.package}}_geoportal/static.* \
+    && pip freeze > /requirements.txt
+
+ARG GIT_HASH
+RUN c2cwsgiutils-genversion ${GIT_HASH}
+
+ARG PGSCHEMA
+ENV PGSCHEMA=${PGSCHEMA}
+
+ENTRYPOINT [ "/usr/bin/eval-templates" ]
+CMD ["gunicorn", "--paste=/app/production.ini"]
+
+ENV VISIBLE_ENTRY_POINT=/ \
+    AUTHTKT_TIMEOUT=86400 \
+    AUTHTKT_REISSUE_TIME=9000 \
+    AUTHTKT_MAXAGE=86400 \
+    AUTHTKT_COOKIENAME=auth_tkt \
+    AUTHTKT_HTTP_ONLY=True \
+    AUTHTKT_SECURE=True \
+    AUTHTKT_SAMESITE=Lax \
+    BASICAUTH=False \
+    LOG_LEVEL=INFO \
+    C2CGEOPORTAL_LOG_LEVEL=INFO \
+    C2CWSGIUTILS_LOG_LEVEL=INFO \
+    GUNICORN_LOG_LEVEL=INFO \
+    SQL_LOG_LEVEL=WARNING \
+    DOGPILECACHE_LOG_LEVEL=INFO \
+    OTHER_LOG_LEVEL=WARNING \
+    DEVELOPMENT=0 \
+    LOG_TYPE=console

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/Makefile

@@ -0,0 +1,6 @@
+# Language provided by the application
+LANGUAGES ?= en fr de
+NGEO_INTERFACES ?= desktop mobile iframe_api
+NGEO_API ?= TRUE
+
+include CONST_Makefile

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/alembic.ini

@@ -0,0 +1,58 @@
+[DEFAULT]
+app.cfg = %(here)s/alembic.yaml
+script_location = /opt/alembic
+version_table = alembic_version
+
+[main]
+type = main
+version_locations = /opt/alembic/main/
+
+[static]
+type = static
+version_locations = /opt/alembic/static/
+
+[getitfixed]
+script_location = getitfixed:alembic
+version_locations = getitfixed:alembic/versions/
+schema = getitfixed
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console, json
+handlers = %(LOG_TYPE)s
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[handler_json]
+class = c2cwsgiutils.pyramid_logging.JsonLogHandler
+args = (sys.stdout,)
+level = NOTSET
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/alembic.yaml

@@ -0,0 +1,19 @@
+---
+vars:
+  schema: '{PGSCHEMA}'
+  schema_static: '{PGSCHEMA_STATIC}'
+  sqlalchemy.url: postgresql://{PGUSER}:{PGPASSWORD}@{PGHOST}:{PGPORT}/{PGDATABASE}?sslmode={PGSSLMODE}
+  srid: {{cookiecutter.srid}}
+environment:
+  - name: PGHOST
+  - name: PGPORT
+    default: '5432'
+  - name: PGUSER
+  - name: PGPASSWORD
+  - name: PGDATABASE
+  - name: PGSSLMODE
+    default: prefer
+  - name: PGSCHEMA
+    default: main
+  - name: PGSCHEMA_STATIC
+    default: main_static

c2cgeoportal_geoportal/scaffolds/advance_create/{{cookiecutter.project}}/geoportal/development.ini

@@ -0,0 +1,121 @@
+###
+# app configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/1.6-branch/narr/environment.html
+# this file consider that you use paste.
+###
+
+[app:app]
+use = egg:{{cookiecutter.package}}_geoportal
+filter-with = proxy-prefix
+
+pyramid.reload_templates = %(DEVELOPMENT)s
+pyramid.debug_authorization = %(DEVELOPMENT)s
+pyramid.debug_notfound = %(DEVELOPMENT)s
+pyramid.debug_routematch = %(DEVELOPMENT)s
+pyramid.debug_templates = %(DEVELOPMENT)s
+
+pyramid.includes = pyramid_debugtoolbar
+# Be careful when manipulate this,
+# if a hacker has access to the debug toolbar,
+# it's a severe security issue
+# With the provided values, the debug toolbar is only available from the Docker network
+debugtoolbar.hosts = 172.17.0.0/16
+    172.18.0.0/16
+    172.19.0.0/16
+mako.directories = {{cookiecutter.package}}_geoportal:templates
+    c2cgeoportal_geoportal:templates
+
+authtkt_secret = %(AUTHTKT_SECRET)s
+authtkt_cookie_name = %(AUTHTKT_COOKIENAME)s
+authtkt_timeout = %(AUTHTKT_TIMEOUT)s
+authtkt_max_age = %(AUTHTKT_MAXAGE)s
+authtkt_reissue_time = %(AUTHTKT_REISSUE_TIME)s
+authtkt_http_only = %(AUTHTKT_HTTP_ONLY)s
+authtkt_secure = %(AUTHTKT_SECURE)s
+authtkt_samesite = %(AUTHTKT_SAMESITE)s
+basicauth = %(BASICAUTH)s
+
+app.cfg = /etc/geomapfish/config.yaml
+
+tm.annotate_user = false
+
+[server:main]
+use = egg:waitress#main
+listen = *:8080
+
+[filter:proxy-prefix]
+use = egg:PasteDeploy#prefix
+prefix = %(VISIBLE_ENTRY_POINT)s
+
+[pipeline:main]
+pipeline = egg:c2cwsgiutils#client_info egg:c2cwsgiutils#sentry app
+
+###
+# logging configuration
+# https://docs.pylonsproject.org/projects/pyramid/en/1.5-branch/narr/logging.html
+###
+
+[loggers]
+keys = root, sqlalchemy, gunicorn, c2cgeoportal_commons, c2cgeoportal_geoportal, c2cgeoportal_admin, {{cookiecutter.package}}_geoportal, c2cwsgiutils, dogpilecache
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = %(OTHER_LOG_LEVEL)s
+handlers = console
+
+[logger_c2cgeoportal_commons]
+level = %(C2CGEOPORTAL_LOG_LEVEL)s
+handlers =
+qualname = c2cgeoportal_commons
+
+[logger_c2cgeoportal_geoportal]
+level = %(C2CGEOPORTAL_LOG_LEVEL)s
+handlers =
+qualname = c2cgeoportal_geoportal
+
+[logger_c2cgeoportal_admin]
+level = %(C2CGEOPORTAL_LOG_LEVEL)s
+handlers =
+qualname = c2cgeoportal_admin
+
+[logger_{{cookiecutter.package}}_geoportal]
+level = %(LOG_LEVEL)s
+handlers =
+qualname = {{cookiecutter.package}}_geoportal
+
+[logger_c2cwsgiutils]
+level = %(C2CWSGIUTILS_LOG_LEVEL)s
+handlers =
+qualname = c2cwsgiutils
+
+[logger_gunicorn]
+level = %(GUNICORN_LOG_LEVEL)s
+handlers =
+qualname = gunicorn
+
+[logger_sqlalchemy]
+level = %(SQL_LOG_LEVEL)s
+handlers =
+qualname = sqlalchemy.engine
+# "level = INFO" logs SQL queries.
+# "level = DEBUG" logs SQL queries and results.
+# "level = WARN" logs neither.  (Recommended for production systems.)
+
+[logger_dogpilecache]
+level = %(DOGPILECACHE_LOG_LEVEL)s
+handlers =
+qualname = dogpile.cache
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s