c2cgeoportal-geoportal 2.3.5.80__py3-none-any.whl → 2.9rc45__py3-none-any.whl

c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter.project}}/scripts/db-restore

@@ -0,0 +1,132 @@
+#!/usr/bin/env python3
+
+# 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.
+
+import argparse
+import shlex
+import subprocess
+import sys
+
+
+def main() -> None:
+    """Restore the database backup."""
+    parser = argparse.ArgumentParser(description="Restore the database backup.")
+    parser.add_argument("--verbose", action="store_true", help="Print the command that is executed.")
+    parser.add_argument(
+        "--dry-run", action="store_true", help="Only print the command that would be executed."
+    )
+    parser.add_argument(
+        "--env",
+        help="The env file to use to get the connection settings, by default we log in the composition to "
+        "do the restore.",
+    )
+    parser.add_argument(
+        "--docker-compose-file",
+        action="append",
+        default=[],
+        help="The docker compose file to used.",
+    )
+    parser.add_argument(
+        "--arg",
+        action="append",
+        default=[],
+        help="Additional pg_restore argument, example: '--arg=--schema=main', may be used multiple times.",
+    )
+    parser.add_argument("file", help="The file path to restore")
+    args = parser.parse_args()
+
+    with open(args.file, "rb") as file_in:
+        if args.env:
+            env = {}
+            with open(args.env, encoding="utf-8") as file_env:
+                for line in file_env:
+                    if line and line[0] != "#":
+                        try:
+                            index = line.index("=")
+                            env[line[:index].strip()] = line[index + 1 :].strip()
+                        except ValueError:
+                            # Ignore lines that don't have a '='
+                            pass
+            command1 = [
+                "docker",
+                "run",
+                "--rm",
+                "--interactive",
+                "--env=PGHOST={}".format(env["PGHOST"]),
+                "--env=PGPORT={}".format(env["PGPORT"]),
+                "--env=PGUSER={}".format(env["PGUSER"]),
+            ]
+            command2 = [
+                "--env=PGPASSWORD={}".format(env["PGPASSWORD"]),
+            ]
+            command2_annon = ["--env=PGPASSWORD=***"]
+            command3 = [
+                *(["--env=PGSSLMODE={}".format(env["PGSSLMODE"])] if "PGSSLMODE" in env else []),
+                *(["--env=PGOPTIONS={}".format(env["PGOPTIONS"])] if "PGOPTIONS" in env else []),
+                "camptocamp/postgres:{}".format(env["POSTGRES_TAG"]),
+                "pg_restore",
+                "--dbname={}".format(env["PGDATABASE"]),
+                *args.arg,
+            ]
+            if args.verbose or args.dry_run:
+                subprocess.run(
+                    [
+                        "docker",
+                        "run",
+                        "--rm",
+                        "camptocamp/postgres:{}".format(env["POSTGRES_TAG"]),
+                        "pg_restore",
+                        "--version",
+                    ]
+                )
+                print(shlex.join([*command1, *command2_annon, *command3]))
+            if args.dry_run:
+                sys.exit(0)
+            sys.exit(subprocess.run([*command1, *command2, *command3], stdin=file_in).returncode)
+        else:
+            command = [
+                "docker",
+                "compose",
+                *[f"--file={f}" for f in args.docker_compose_file],
+                "exec",
+                "-T",
+                "tools",
+                "bash",
+                "-c",
+                'pg_restore --dbname="$PGDATABASE" ' + " ".join(args.arg),
+            ]
+            if args.verbose or args.dry_run:
+                subprocess.run(["docker", "compose", "exec", "tools", "pg_restore", "--version"])
+                print(shlex.join(command))
+            if args.dry_run:
+                sys.exit(0)
+            sys.exit(subprocess.run(command, stdin=file_in).returncode)
+
+
+if __name__ == "__main__":
+    main()

c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter.project}}/setup.cfg

@@ -0,0 +1,7 @@
+[isort]
+known_first_party=c2cgeoportal_commons,c2cgeoportal_geoportal,c2cgeoportal_admin,{{cookiecutter.package}}_geoportal
+multi_line_output=3
+include_trailing_comma=1
+force_grid_wrap=0
+use_parentheses=1
+line_length=110

c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter.project}}/spell-ignore-words.txt

@@ -0,0 +1,5 @@
+oder
+sie
+sur
+copyable
+referer

c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter.project}}/tests/test_app.py

@@ -0,0 +1,78 @@
+import time
+
+import pytest
+import requests
+
+
+@pytest.mark.parametrize(
+    "url,params,timeout",
+    [
+        ("https://front/", {}, 10),
+        ("https://front/themes", {}, 120),
+        ("https://front/static-geomapfish/0/locales/fr.json", {}, 2),
+        ("https://front/dynamic.json", {"interface": "desktop"}, 10),
+        ("https://front/dynamic.json", {"interface": "desktop", "query": "", "path": "/"}, 10),
+        ("https://front/c2c/health_check", {}, 2),
+        ("https://front/c2c/health_check", {"max_level": "1"}, 2),
+        ("https://front/c2c/health_check", {"checker": "check_collector"}, 2),
+        ("https://front/admin/layertree", {}, 10),
+        ("https://front/admin/layertree/children", {}, 10),
+        (
+            "http://mapserver:8080/mapserv_proxy/MapServer",
+            {"SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+            60,
+        ),
+        (
+            "https://front/mapserv_proxy",
+            {"ogcserver": "MapServer", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+            60,
+        ),
+        # (
+        #     "http://qgisserver:8080/mapserv_proxy/",
+        #     {"SERVICE": "WMS", "REQUEST": "GetCapabilities", "MAP": "/etc/qgisserver/project.qgs"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy",
+        #     {"ogcserver": "qgisserver", "SERVICE": "WMS", "REQUEST": "GetCapabilities"},
+        #     60,
+        # ),
+        # OGC API - Features
+        # (
+        #     "http://mapserver:8080/mapserv_proxy/MapServer/ogcapi/collections/osm_protected/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/MapServer/ogcapi/collections/osm_open/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "http://qgisserver:8080/mapserv_proxy/qgisserver/wfs3/collections/points/items",
+        #     {"map": "/etc/qgisserver/project.qgs", "bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+        # (
+        #     "https://front/mapserv_proxy/qgisserver/wfs3/collections/points/items",
+        #     {"bbox": "6.0,46.0,7.0,47.0", "limit": "100"},
+        #     60,
+        # ),
+    ],
+)
+def test_url(url: str, params: dict[str, str], timeout: int) -> None:
+    """Tests that some URL didn't return an error."""
+    for _ in range(6):
+        response = requests.get(url, params=params, verify=False, timeout=timeout)  # nosec
+        if response.status_code == 503:
+            time.sleep(1)
+            continue
+        break
+    assert response.status_code == 200, response.text
+
+
+def test_admin() -> None:
+    """Tests that the admin page will provide the login page."""
+    response = requests.get("https://front/admin/", verify=False, timeout=30)  # nosec
+    assert response.status_code == 200, response.text
+    assert "Login" in response.text

c2cgeoportal_geoportal/scaffolds/create/{{cookiecutter.project}}/tilegeneration/config.yaml.tmpl

@@ -0,0 +1,195 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/camptocamp/tilecloud-chain/master/tilecloud_chain/schema.json
+
+grids:
+  # grid name, I just recommends to add the min resolution because it's common to not generate all the layers at the same resolution.
+  swissgrid_05:
+    # resolutions [required]
+    # Resolutions from eCH-0056 - WMTS-07
+    # https://www.ech.ch/dokument/473ea824-bbcd-43fa-ad0a-c7c84edfa1b8
+    resolutions: [4000, 2000, 1000, 500, 250, 100, 50, 20, 10, 5, 2.5, 1, 0.5, 0.25, 0.1, 0.05]
+    # bbox [required]
+    bbox: [2420000, 1030000, 2900000, 1350000]
+    # srs [required]
+    srs: EPSG:{{cookiecutter.srid}}
+
+caches:
+${DISABLE_LOCAL}  local:
+${DISABLE_LOCAL}    type: filesystem
+${DISABLE_LOCAL}    folder: /var/sig/tiles
+${DISABLE_LOCAL}    # for GetCapabilities
+${DISABLE_LOCAL}    http_url: ${VISIBLE_WEB_PROTOCOL}://${VISIBLE_WEB_HOST}${VISIBLE_ENTRY_POINT}
+${DISABLE_LOCAL}  s3:
+${DISABLE_LOCAL}    type: s3
+${DISABLE_LOCAL}    bucket: ${TILEGENERATION_S3_BUCKET}
+${DISABLE_LOCAL}    folder: ''
+${DISABLE_LOCAL}    # for GetCapabilities
+${DISABLE_LOCAL}    http_url: ${VISIBLE_WEB_PROTOCOL}://${VISIBLE_WEB_HOST}${VISIBLE_ENTRY_POINT}
+${DISABLE_LOCAL}    cache_control: 'public, max-age=14400'
+${DISABLE_LOCAL}    host: ${AWS_S3_ENDPOINT}
+  azure:
+    type: azure
+    container: ${TILEGENERATION_AZURE_CONTAINER}
+    folder: ''
+    # for GetCapabilities
+    http_url: ${VISIBLE_WEB_PROTOCOL}://${VISIBLE_WEB_HOST}${VISIBLE_ENTRY_POINT}
+    cache_control: 'public, max-age=14400'
+
+# this defines some defaults values for all the layers
+defaults:
+  layer: &layer
+    type: wms
+    grid: swissgrid_05
+    # The minimum resolution to seed, useful to use with mapcache, optional.
+    # min_resolution_seed: 1
+    # the URL of the WMS server to used
+    url: ${MAPSERVER_URL}
+    # Set the headers to get the right virtual host, and don't get any cached result
+    headers:
+${DISABLE_LOCAL}      Host: '${VISIBLE_WEB_HOST}'
+      Cache-Control: no-cache, no-store
+      Pragma: no-cache
+    # file name extension
+    extension: png
+    # legend file name extension
+    legend_extension: png
+    # the bbox there we want to generate tiles
+    #bbox: [493000, 114000, 586000, 204000]
+
+    # mime type used for the WMS request and the WMTS capabilities generation
+    mime_type: image/png
+    # mime type used for the WMS request and the WMTS legend image generation
+    legend_mime: image/png
+    wmts_style: default
+    # the WMTS dimensions definition [default is []]
+    #dimensions:
+    #    -   name: DATE
+    #        # the default value for the WMTS capabilities
+    #        default: '2012'
+    #        # the generated values
+    #        generate: ['2012']
+    #        # all the available values in the WMTS capabilities
+    #        values: ['2012']
+    # the meta tiles definition [default is false]
+    meta: true
+    # the meta tiles size [default is 8]
+    meta_size: 5
+    # the meta tiles buffer [default is 128]
+    meta_buffer: 128
+    # connection an sql to get geometries (in column named geom) where we want to generate tiles
+    # Warn: too complex result can slow down the application
+    #    connection: host=localhost port=5432 user=www-data password=www-data dbname=<db>
+    #    geoms:
+    #        -   sql: <column> AS geom FROM <table>
+    # size and hash used to detect empty tiles and metatiles [optional, default is None]
+    empty_metatile_detection:
+      size: 740
+      hash: 3237839c217b51b8a9644d596982f342f8041546
+    empty_tile_detection:
+      size: 921
+      hash: 1e3da153be87a493c4c71198366485f290cad43c
+
+layers:
+  plan:
+    <<: *layer
+    layers: plan
+  ortho:
+    <<: *layer
+    layers: ortho
+    extension: jpeg
+    mime_type: image/jpeg
+    # no buffer needed on rater sources
+    meta_buffer: 0
+    empty_metatile_detection:
+      size: 66163
+      hash: a9d16a1794586ef92129a2fb41a739451ed09914
+    empty_tile_detection:
+      size: 1651
+      hash: 2892fea0a474228f5d66a534b0b5231d923696da
+
+generation:
+  default_cache: s3
+
+${DISABLE_LOCAL}redis:
+${DISABLE_LOCAL}  socket_timeout: ${REDIS_TIMEOUT}
+${DISABLE_LOCAL}  # For standalone version
+${DISABLE_LOCAL}  url: 'redis://${REDIS_HOST}:${REDIS_PORT}/${REDIS_DB}'
+${DISABLE_LOCAL}  # For Kubernetes version
+${DISABLE_LOCAL}  # sentinels:
+${DISABLE_LOCAL}  #   - - ${REDIS_HOST}
+${DISABLE_LOCAL}  #     - ${REDIS_PORT}
+${DISABLE_LOCAL}  # service_name: ${REDIS_SERVICENAME}
+${DISABLE_LOCAL}  # db: ${REDIS_DB}
+
+server:
+${DISABLE_LOCAL}  wmts_path: tiles
+${DISABLE_LOCAL}  static_path: tiles/static
+${DISABLE_LOCAL}  admin_path: tiles/admin
+  expires: 8 # 8 hours
+  predefined_commands:
+    - name: Generation all layers
+      command: generate-tiles
+    - name: Generation layer plan
+      command: generate-tiles --layer=plan
+    - name: Generation layer ortho
+      command: generate-tiles --layer=ortho
+    - name: Generate the legend images
+      command: generate_controller --generate-legend-images
+
+process:
+  optipng_test:
+    - cmd: optipng -o7 -simulate %(in)s
+  optipng:
+    - cmd: optipng %(args)s -zc9 -zm8 -zs3 -f5 %(in)s
+      arg:
+        default: '-q'
+        quiet: '-q'
+  jpegoptim:
+    - cmd: jpegoptim %(args)s --strip-all --all-normal -m 90 %(in)s
+      arg:
+        default: '-q'
+        quiet: '-q'
+
+openlayers:
+  srs: EPSG:{{cookiecutter.srid}}
+  center_x: 2600000
+  center_y: 1200000
+  # The proj4js definition, get it from https://epsg.io/
+  # For EPSG:2056
+  proj4js_def: |
+    +proj=somerc
+    +lat_0=46.95240555555556
+    +lon_0=7.439583333333333
+    +k_0=1
+    +x_0=2600000
+    +y_0=1200000
+    +ellps=bessel
+    +towgs84=674.374,15.056,405.346,0,0,0,0
+    +units=m +no_defs
+
+metadata:
+  title: Some title
+  abstract: Some abstract
+  servicetype: OGC WMTS
+  keywords:
+    - some
+    - keywords
+  fees: None
+  access_constraints: None
+
+provider:
+  name: The provider name
+  url: The provider URL
+  contact:
+    name: The contact name
+    position: The position name
+    info:
+      phone:
+        voice: +41 11 222 33 44
+        fax: +41 11 222 33 44
+      address:
+        delivery: Address delivery
+        city: Berne
+        area: BE
+        postal_code: 3000
+        country: Switzerland
+        email: info@example.com

c2cgeoportal_geoportal/scaffolds/update/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", "*.html.mako"]
+}

c2cgeoportal_geoportal/scaffolds/update/{{cookiecutter.project}}/.upgrade.yaml

@@ -0,0 +1,67 @@
+---
+# The list (by include, exclude) of default files that will not be overwritten by the upgrade.
+# That that can be extended with managed_files or reduced with unmanaged_files from the
+# project.yaml file in the project root directory.
+default_project_file:
+  include:
+    - geoportal/setup\.py
+    - geoportal/vars\.yaml
+    - geoportal/Makefile
+    - geoportal/{{cookiecutter.package}}_geoportal/__init__\.py
+    - geoportal/{{cookiecutter.package}}_geoportal/templates/.*
+    - geoportal/{{cookiecutter.package}}_geoportal/locale/.*
+    - geoportal/{{cookiecutter.package}}_geoportal/static/.*
+    - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/.*
+    - print/print-apps/.*
+    - mapserver/.*
+    - tilegeneration/config\.yaml\.tmpl
+    - project\.yaml
+    - docker-compose\.yaml
+    - env\.project
+    - README\.rst
+    - \.github/workflows/main\.yaml
+    - \.github/workflows/rebuild\.yaml
+  exclude:
+    - mapserver/demo\.map\.tmpl
+    - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/image/favicon\.ico
+
+# Files ignored when creating the diff files => will just be left untouched.
+no_diff:
+  - .*\.po
+  - CONST_.+
+  - .*/CONST_.+
+
+# Files that will be present in the CONST_create_template but will not be considered in the upgrade.
+# Used to provide the alt applications => does not disturb the user during upgrade.
+extra:
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/mobile_alt\.html\.ejs
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/oeedit\.html\.ejs
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/Controllermobile_alt\.js
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/Controlleroeedit\.js
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/sass/mobile_alt\.scss
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/sass/vars_mobile_alt\.scss
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/sass/oeedit\.scss
+  - geoportal/{{cookiecutter.package}}_geoportal/static-ngeo/js/apps/sass/vars_oeedit\.scss
+  - geoportal/interfaces/desktop_alt\.html\.mako
+  - geoportal/{{cookiecutter.package}}_geoportal/static/images/background-layer-button\.png
+  - tests/test_testapp.py
+
+# Automated file system operations:
+# Remove some files or directories:
+#  - action: remove
+#    paths:
+#      - <one file or directory>
+# Move a file:
+#  - action: move
+#    from: <src file>
+#    to: <dst file>
+upgrade_files:
+  - action: remove
+    paths:
+      - geoportal/tools/extract-messages.js
+  - action: move
+    from: geoportal/lingua-server.cfg
+    to: geoportal/lingva-server.cfg
+  - action: move
+    from: geoportal/lingua-client.cfg
+    to: geoportal/lingva-client.cfg