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

c2cgeoportal_geoportal/scripts/theme2fts.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2014-2020, Camptocamp SA
+# Copyright (c) 2014-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -31,19 +29,25 @@
 import gettext
 import os
 import sys
-from argparse import ArgumentParser
-from typing import Any, Dict, List, Set
+from argparse import ArgumentParser, Namespace
+from typing import TYPE_CHECKING, Any, Dict, Iterator, List, Optional, Set
 
+import pyramid.config
 import transaction
 from sqlalchemy import func
+from sqlalchemy.orm.session import Session
 
-from c2cgeoportal_geoportal.lib.bashcolor import RED, colorize
+from c2cgeoportal_geoportal.lib.bashcolor import Color, colorize
 from c2cgeoportal_geoportal.lib.fulltextsearch import Normalize
 from c2cgeoportal_geoportal.lib.i18n import LOCALE_PATH
 from c2cgeoportal_geoportal.scripts import fill_arguments, get_appsettings, get_session
 
+if TYPE_CHECKING:
+    import c2cgeoportal_commons.models.main
+
 
-def main():
+def get_argparser() -> ArgumentParser:
+    """Get the argument parser for this script."""
     parser = ArgumentParser(
         prog=sys.argv[0],
         add_help=True,
@@ -53,7 +57,7 @@ def main():
     parser.add_argument(
         "--locale-folder",
         default=LOCALE_PATH,
-        help="The folder where the locale files are stored (default to {})".format(LOCALE_PATH),
+        help=f"The folder where the locale files are stored (default is {LOCALE_PATH})",
     )
     parser.add_argument("--interfaces", action="append", help="the interfaces to export")
     parser.add_argument(
@@ -85,7 +89,13 @@ def main():
     )
     parser.add_argument("--package", help="the application package")
     fill_arguments(parser)
-    options = parser.parse_args()
+    return parser
+
+
+def main() -> None:
+    """Run the command."""
+
+    options = get_argparser().parse_args()
     settings = get_appsettings(options)
 
     with transaction.manager:
@@ -95,7 +105,13 @@ def main():
 
 
 class Import:
-    def __init__(self, session, settings, options):
+    """
+    To import all the themes, layer groups and layers names into the full-text search table.
+
+    Done by interface and by language.
+    """
+
+    def __init__(self, session: Session, settings: pyramid.config.Configurator, options: Namespace):
         self.options = options
         self.imported: Set[Any] = set()
         package = settings["package"]
@@ -106,9 +122,9 @@ class Import:
 
         fts_missing_langs = [lang for lang in self.languages if lang not in self.fts_languages]
         if fts_missing_langs:
-            msg = "Keys {} are missing in fulltextsearch languages configuration.".format(fts_missing_langs)
+            msg = f"Keys {fts_missing_langs} are missing in fulltextsearch languages configuration."
             if os.environ.get("IGNORE_I18N_ERRORS", "FALSE") == "TRUE":
-                print(colorize(msg, RED))
+                print(colorize(msg, Color.RED))
                 self.languages = [lang for lang in self.languages if lang in self.fts_languages]
             else:
                 raise KeyError(KeyError(msg))
@@ -122,19 +138,19 @@ class Import:
         )
 
         self.session = session
-        self.session.execute(FullTextSearch.__table__.delete().where(FullTextSearch.from_theme))  # noqa
+        self.session.execute(FullTextSearch.__table__.delete().where(FullTextSearch.from_theme))
 
         self._: Dict[str, gettext.NullTranslations] = {}
         for lang in self.languages:
             try:
                 self._[lang] = gettext.translation(
-                    "{}_geoportal-client".format(package),
+                    f"{package}_geoportal-client",
                     options.locale_folder.format(package=package),
                     [lang],
                 )
             except OSError as e:
                 self._[lang] = gettext.NullTranslations()
-                print("Warning: {} (language: {})".format(e, lang))
+                print(f"Warning: {e} (language: {lang})")
 
         query = self.session.query(Interface)
         if options.interfaces is not None:
@@ -156,7 +172,13 @@ class Import:
             for theme in self.session.query(Theme).all():
                 self._add_theme(theme, role)
 
-    def _add_fts(self, item, interface, action, role):
+    def _add_fts(
+        self,
+        item: "c2cgeoportal_commons.models.main.TreeItem",
+        interface: "c2cgeoportal_commons.models.main.Interface",
+        action: str,
+        role: Optional["c2cgeoportal_commons.models.main.Role"],
+    ) -> None:
         from c2cgeoportal_commons.models.main import FullTextSearch  # pylint: disable=import-outside-toplevel
 
         key = (
@@ -168,7 +190,7 @@ class Import:
             self.imported.add(key)
             for lang in self.languages:
                 fts = FullTextSearch()
-                fts.label = self._[lang].gettext(item.name)
+                fts.label = self._render_label(item, lang)
                 fts.role = role
                 fts.interface = interface
                 fts.lang = lang
@@ -177,14 +199,18 @@ class Import:
                     self.fts_languages[lang],
                     " ".join(
                         [self.fts_normalizer(self._[lang].gettext(item.name))]
-                        + [v.strip() for m in item.get_metadatas("searchAlias") for v in m.value.split(",")]
+                        + [v.strip() for m in item.get_metadata("searchAlias") for v in m.value.split(",")]
                     ),
                 )
                 fts.actions = [{"action": action, "data": item.name}]
                 fts.from_theme = True
                 self.session.add(fts)
 
-    def _add_theme(self, theme, role=None):
+    def _add_theme(
+        self,
+        theme: "c2cgeoportal_commons.models.main.Theme",
+        role: Optional["c2cgeoportal_commons.models.main.Role"] = None,
+    ) -> None:
         fill = False
         for interface in self.interfaces:
             if interface in theme.interfaces:
@@ -198,13 +224,29 @@ class Import:
                     if role is None or theme.id not in self.public_theme[interface.id]:
                         self._add_fts(theme, interface, "add_theme", role)
 
-    def _add_block(self, group, interface, role):
+    def _add_block(
+        self,
+        group: "c2cgeoportal_commons.models.main.LayerGroup",
+        interface: "c2cgeoportal_commons.models.main.Interface",
+        role: Optional["c2cgeoportal_commons.models.main.Role"],
+    ) -> bool:
         return self._add_group(group, interface, self.options.blocks, role)
 
-    def _add_folder(self, group, interface, role):
+    def _add_folder(
+        self,
+        group: "c2cgeoportal_commons.models.main.LayerGroup",
+        interface: "c2cgeoportal_commons.models.main.Interface",
+        role: Optional["c2cgeoportal_commons.models.main.Role"],
+    ) -> bool:
         return self._add_group(group, interface, self.options.folders, role)
 
-    def _add_group(self, group, interface, export, role):
+    def _add_group(
+        self,
+        group: "c2cgeoportal_commons.models.main.LayerGroup",
+        interface: "c2cgeoportal_commons.models.main.Interface",
+        export: bool,
+        role: Optional["c2cgeoportal_commons.models.main.Role"],
+    ) -> bool:
         from c2cgeoportal_commons.models.main import LayerGroup  # pylint: disable=import-outside-toplevel
 
         fill = False
@@ -224,13 +266,20 @@ class Import:
         return fill
 
     @staticmethod
-    def _layer_visible(layer, role):
+    def _layer_visible(
+        layer: "c2cgeoportal_commons.models.main.Layer", role: "c2cgeoportal_commons.models.main.Role"
+    ) -> bool:
         for restrictionarea in layer.restrictionareas:
             if role in restrictionarea.roles:
                 return True
         return False
 
-    def _add_layer(self, layer, interface, role):
+    def _add_layer(
+        self,
+        layer: "c2cgeoportal_commons.models.main.Layer",
+        interface: "c2cgeoportal_commons.models.main.Interface",
+        role: Optional["c2cgeoportal_commons.models.main.Role"],
+    ) -> bool:
         if role is None:
             fill = layer.public and interface in layer.interfaces
         else:
@@ -240,3 +289,58 @@ class Import:
             self._add_fts(layer, interface, "add_layer", role)
 
         return fill
+
+    def _render_label(
+        self,
+        item: "c2cgeoportal_commons.models.main.TreeItem",
+        lang: str,
+    ) -> str:
+        patterns = item.get_metadata("searchLabelPattern")
+        if not patterns:
+            return self._[lang].gettext(item.name)
+        pattern = patterns[0]
+        assert isinstance(pattern.value, str)
+        tree_paths = list(self._get_paths(item))
+        # Remove paths where the last element isn't a theme
+        tree_paths = [p for p in tree_paths if p[-1].item_type == "theme"]
+        result = None
+        current_result = None
+        if tree_paths:
+            for path in tree_paths:
+                if len(path) == 2:
+                    current_result = pattern.value.format(
+                        name=self._[lang].gettext(item.name),
+                        theme=self._[lang].gettext(path[-1].name),
+                        parent=self._[lang].gettext(path[1].name),
+                    )
+                elif len(path) > 2:
+                    current_result = pattern.value.format(
+                        name=self._[lang].gettext(item.name),
+                        theme=self._[lang].gettext(path[-1].name),
+                        parent=self._[lang].gettext(path[1].name),
+                        block=self._[lang].gettext(path[-2].name),
+                    )
+                if result and current_result != result:
+                    sys.stderr.write(
+                        f"WARNING: the item {item.name} (id: {item.id}) has a label pattern and inconsistent "
+                        f"multiple parents\n"
+                    )
+                    return self._[lang].gettext(item.name)
+                result = current_result
+        return result or pattern.value.format(
+            name=self._[lang].gettext(item.name),
+            theme=self._[lang].gettext(item.name),
+        )
+
+    def _get_paths(
+        self,
+        item: "c2cgeoportal_commons.models.main.TreeItem",
+    ) -> Iterator[List["c2cgeoportal_commons.models.main.TreeItem"]]:
+        if item is None:
+            return
+        if any(item.parents):
+            for parent in item.parents:
+                for path in self._get_paths(parent):
+                    yield [item, *path]
+        else:
+            yield [item]

c2cgeoportal_geoportal/scripts/urllogin.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# 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
@@ -32,41 +30,51 @@ import binascii
 import json
 import sys
 import time
+from typing import cast
 
 from Crypto.Cipher import AES  # nosec
+from Crypto.Cipher.ChaCha20_Poly1305 import ChaCha20Poly1305Cipher  # nosec
 
 from c2cgeoportal_geoportal.scripts import fill_arguments, get_appsettings
 
 
-def create_token(aeskey, user, password, valid):
+def create_token(aeskey: str, user: str, password: str, valid: bool) -> str:
+    """Create the authenticated URL token."""
     auth = {"u": user, "p": password, "t": int(time.time()) + valid * 3600 * 24}
 
     if aeskey is None:
         print("urllogin is not configured")
         sys.exit(1)
-    cipher = AES.new(aeskey.encode("ascii"), AES.MODE_EAX)
+    cipher = cast(ChaCha20Poly1305Cipher, AES.new(aeskey.encode("ascii"), AES.MODE_EAX))
     data = json.dumps(auth)
     mod_len = len(data) % 16
     if mod_len != 0:
         data += "".join([" " for i in range(16 - mod_len)])
-    ciphertext, tag = cipher.encrypt_and_digest(data.encode("utf-8"))  # type: ignore
-    return binascii.hexlify(cipher.nonce + tag + ciphertext).decode("ascii")  # type: ignore
+    ciphertext, tag = cipher.encrypt_and_digest(data.encode("utf-8"))
+    return binascii.hexlify(cipher.nonce + tag + ciphertext).decode("ascii")
+
 
+def get_argparser() -> argparse.ArgumentParser:
+    """Get the argument parser for this script."""
 
-def main():
     parser = argparse.ArgumentParser(description="Generate an auth token")
-    fill_arguments(parser)
+    fill_arguments(parser, use_attribute=True)
     parser.add_argument("user", help="The username")
     parser.add_argument("password", help="The password")
     parser.add_argument("valid", type=int, default=1, nargs="?", help="Is valid for, in days")
+    return parser
+
+
+def main() -> None:
+    """Run the command."""
 
-    args = parser.parse_args()
+    args = get_argparser().parse_args()
     settings = get_appsettings(args)
     urllogin = settings.get("urllogin", {})
     aeskey = urllogin.get("aes_key")
     auth_enc = create_token(aeskey, args.user, args.password, args.valid)
 
-    print(("Use: auth={}".format(auth_enc)))
+    print(f"Use: auth={auth_enc}")
 
 
 if __name__ == "__main__":

c2cgeoportal_geoportal/templates/login.html

@@ -1,86 +1,90 @@
-<!DOCTYPE HTML>
+<!DOCTYPE html>
 <html lang="${lang}">
-    <head>
-        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-        <meta name="Content-Language" content="${lang}" />
-        <title>${_('Login to Geoportal Application')}</title>
-        <style>
-            body {
-                background: #444444;
-                font-family: Helvetica, Arial, sans-serif;
-            }
-            * {
-                padding: 0;
-                margin: 0;
-            }
-            div#content {
-                background: #F5F5EF;
-                padding: 20px 30px;
-                width: 330px;
-                margin: 100px auto auto auto;
-                -webkit-border-radius: 10px;
-                border-radius: 10px;
-            }
-            td.field {
-                padding-top: 20px;
-            }
-            td.field p {
-                font-weight: bold;
-                color: #444444;
-                font-size: 80%;
-                margin-bottom: 3px;
-            }
-            td.field input {
-                -webkit-border-radius: 2px;
-                border-radius: 2px;
-                border: solid 1px #444444;
-                padding: 3px 6px;
-                font-size: 110%;
-                width: 250px;
-            }
-            td.buttons {
-                padding-top: 25px;
-                padding-bottom: 20px;
-                text-align: right;
-            }
-            td.buttons input {
-                padding: 1px 6px;
-                font-weight: bold;
-                color: #444444;
-            }
-        </style>
-    </head>
-    <body>
-        <div id="content">
-            <form method="POST" id="loginForm" action="${request.route_url('login', _query=login_params)}">
-                <table style="margin-left: auto; margin-right: auto;">
-                    <tbody>
-                        <tr>
-                            <td class="field"><p>
-                                <label for="email">${_('Username')}</label></p>
-                                <input id="login" name="login" type="text">
-                            </td>
-                        </tr>
-                        <tr>
-                            <td class="field"><p>
-                                <label for="password">${_('Password')}</label></p>
-                                <input id="password" name="password" type="password">
-                            </td>
-                        </tr>
-% if two_fa:
-                        <tr>
-                            <td class="field">
-                                <p><label for="otp">${_('Authentication code')}</label></p>
-                                <input id="otp" name="otp" type="text" autocomplete="off">
-                            </td>
-                        </tr>
-% endif
-                        <tr>
-                            <td class="buttons"><input tabindex="4" value="${_('Login')}" type="submit"></td>
-                        </tr>
-                    </tbody>
-                </table>
-            </form>
-        </div>
-    </body>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <meta name="Content-Language" content="${lang}" />
+    <title>${_('Login to Geoportal Application')}</title>
+    <style>
+      body {
+        background: #444444;
+        font-family: Helvetica, Arial, sans-serif;
+      }
+      * {
+        padding: 0;
+        margin: 0;
+      }
+      div#content {
+        background: #f5f5ef;
+        padding: 20px 30px;
+        width: 330px;
+        margin: 100px auto auto auto;
+        -webkit-border-radius: 10px;
+        border-radius: 10px;
+      }
+      td.field {
+        padding-top: 20px;
+      }
+      td.field p {
+        font-weight: bold;
+        color: #444444;
+        font-size: 80%;
+        margin-bottom: 3px;
+      }
+      td.field input {
+        -webkit-border-radius: 2px;
+        border-radius: 2px;
+        border: solid 1px #444444;
+        padding: 3px 6px;
+        font-size: 110%;
+        width: 250px;
+      }
+      td.buttons {
+        padding-top: 25px;
+        padding-bottom: 20px;
+        text-align: right;
+      }
+      td.buttons input {
+        padding: 1px 6px;
+        font-weight: bold;
+        color: #444444;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="content">
+      <form method="POST" id="loginForm" action="${request.route_url('login', _query=login_params)}">
+        <table style="margin-left: auto; margin-right: auto">
+          <tbody>
+            <tr>
+              <td class="field">
+                <p>
+                  <label for="email">${_('Username')}</label>
+                </p>
+                <input id="login" name="login" type="text" />
+              </td>
+            </tr>
+            <tr>
+              <td class="field">
+                <p>
+                  <label for="password">${_('Password')}</label>
+                </p>
+                <input id="password" name="password" type="password" />
+              </td>
+            </tr>
+            % if two_fa:
+            <tr>
+              <td class="field">
+                <p><label for="otp">${_('Authentication code')}</label></p>
+                <input id="otp" name="otp" type="text" autocomplete="off" />
+              </td>
+            </tr>
+            % endif
+            <tr>
+              <td class="buttons"><input tabindex="4" value="${_('Login')}" type="submit" /></td>
+            </tr>
+          </tbody>
+        </table>
+      </form>
+    </div>
+  </body>
 </html>

c2cgeoportal_geoportal/templates/notlogin.html

@@ -1,62 +1,62 @@
 <!DOCTYPE html>
 <html lang="${lang}">
-    <head>
-        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-        <meta name="Content-Language" content="${lang}" />
-        <title>${_('Login to Geoportal Application')}</title>
-        <style>
-            body {
-                background: #444444;
-                font-family: Helvetica, Arial, sans-serif;
-            }
-            * {
-                padding: 0;
-                margin: 0;
-            }
-            div#content {
-                background: #f5f5ef;
-                padding: 20px 30px;
-                width: 330px;
-                margin: 100px auto auto auto;
-                -webkit-border-radius: 10px;
-                border-radius: 10px;
-            }
-            td.field {
-                padding-top: 20px;
-            }
-            td.field p {
-                font-weight: bold;
-                color: #444444;
-                font-size: 80%;
-                margin-bottom: 3px;
-            }
-            td.field input {
-                -webkit-border-radius: 2px;
-                border-radius: 2px;
-                border: solid 1px #444444;
-                padding: 3px 6px;
-                font-size: 110%;
-                width: 250px;
-            }
-            td.buttons {
-                padding-top: 25px;
-                padding-bottom: 20px;
-                text-align: right;
-            }
-            td.buttons input {
-                padding: 1px 6px;
-                font-weight: bold;
-                color: #444444;
-            }
-        </style>
-    </head>
-    <body>
-        <div id="content">
-            <p>
-                ${_('The user is not correctly initialized you should login in the main application and try '
-                'again.')}
-            </p>
-            <p><a href="${request.route_url('base')}">${_('Main application')}</a></p>
-        </div>
-    </body>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <meta name="Content-Language" content="${lang}" />
+    <title>${_('Login to Geoportal Application')}</title>
+    <style>
+      body {
+        background: #444444;
+        font-family: Helvetica, Arial, sans-serif;
+      }
+      * {
+        padding: 0;
+        margin: 0;
+      }
+      div#content {
+        background: #f5f5ef;
+        padding: 20px 30px;
+        width: 330px;
+        margin: 100px auto auto auto;
+        -webkit-border-radius: 10px;
+        border-radius: 10px;
+      }
+      td.field {
+        padding-top: 20px;
+      }
+      td.field p {
+        font-weight: bold;
+        color: #444444;
+        font-size: 80%;
+        margin-bottom: 3px;
+      }
+      td.field input {
+        -webkit-border-radius: 2px;
+        border-radius: 2px;
+        border: solid 1px #444444;
+        padding: 3px 6px;
+        font-size: 110%;
+        width: 250px;
+      }
+      td.buttons {
+        padding-top: 25px;
+        padding-bottom: 20px;
+        text-align: right;
+      }
+      td.buttons input {
+        padding: 1px 6px;
+        font-weight: bold;
+        color: #444444;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="content">
+      <p>
+        ${_('The user is not correctly initialized you should login in the main application and try '
+        'again.')}
+      </p>
+      <p><a href="${request.route_url('base')}">${_('Main application')}</a></p>
+    </div>
+  </body>
 </html>

c2cgeoportal_geoportal/templates/testi18n.html

@@ -1,14 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html
-  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-    <meta charset="UTF-8">
+  <head>
+    <meta charset="UTF-8" />
     <title>${title}</title>
-</head>
-<body>
+  </head>
+  <body>
     <h1>${title}</h1>
     <p>${_('my translation test')}</p>
-</body>
+  </body>
 </html>