c2cgeoportal-admin 2.6.0__py3-none-any.whl → 2.9rc45__py3-none-any.whl

c2cgeoportal_admin/schemas/treegroup.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2018-2020, Camptocamp SA
+# Copyright (c) 2018-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -30,17 +28,21 @@
 
 import logging
 from functools import partial
+from typing import Any
 
 import colander
+import pyramid.request
+import sqlalchemy
 from c2cgeoform.schema import GeoFormSchemaNode
 from sqlalchemy.orm import aliased
 from sqlalchemy.sql.expression import case, func
 
 from c2cgeoportal_admin import _
 from c2cgeoportal_admin.widgets import ChildrenWidget, ChildWidget
-from c2cgeoportal_commons.models.main import LayergroupTreeitem, TreeItem
+from c2cgeoportal_commons.lib.literal import Literal
+from c2cgeoportal_commons.models.main import LayergroupTreeitem, TreeGroup, TreeItem
 
-LOG = logging.getLogger(__name__)
+_LOG = logging.getLogger(__name__)
 
 # Correspondence between TreeItem.item_type and route table segment
 ITEM_TYPE_ROUTE_MAP = {
@@ -48,11 +50,13 @@ ITEM_TYPE_ROUTE_MAP = {
     "group": "layer_groups",
     "layer": None,
     "l_wms": "layers_wms",
-    "l_wmts": "layers_wms",
+    "l_wmts": "layers_wmts",
 }
 
 
 class ChildSchemaNode(GeoFormSchemaNode):  # pylint: disable=abstract-method
+    """Schema of the child nodes."""
+
     def objectify(self, dict_, context=None):
         if dict_.get("id", None):
             context = self.dbsession.query(LayergroupTreeitem).get(dict_["id"])
@@ -61,17 +65,24 @@ class ChildSchemaNode(GeoFormSchemaNode):  # pylint: disable=abstract-method
         return context
 
 
-def treeitems(node, kw, only_groups=False):  # pylint: disable=unused-argument
+def treeitems(
+    node: TreeGroup, kw: dict[str, pyramid.request.Request], only_groups: bool = False
+) -> list[dict[str, Any]]:
+    """Get a serializable representation of the tree items."""
+    del node
     dbsession = kw["request"].dbsession
+    assert isinstance(dbsession, sqlalchemy.orm.Session)
 
-    group = case([(func.count(LayergroupTreeitem.id) == 0, "Unlinked")], else_="Others")
+    group = case(
+        (func.count(LayergroupTreeitem.id) == 0, "Unlinked"), else_="Others"  # pylint: disable=not-callable
+    )
 
     query = (
         dbsession.query(TreeItem, group)
         .distinct()
-        .outerjoin("parents_relation")
+        .outerjoin(TreeItem.parents_relation)
         .filter(TreeItem.item_type != "theme")
-        .group_by(TreeItem.id)
+        .group_by(TreeItem)
         .order_by(group.desc(), TreeItem.name)
     )
 
@@ -86,7 +97,7 @@ def treeitems(node, kw, only_groups=False):  # pylint: disable=unused-argument
         search_alias = aliased(search_ancestors, name="search_ancestors")
         relation_alias = aliased(LayergroupTreeitem, name="relation")
         search_ancestors = search_ancestors.union_all(
-            dbsession.query(relation_alias.treegroup_id).filter(
+            dbsession.query(relation_alias.treegroup_id).filter(  # type: ignore[arg-type]
                 relation_alias.treeitem_id == search_alias.c.treegroup_id
             )
         )
@@ -101,7 +112,7 @@ def treeitems(node, kw, only_groups=False):  # pylint: disable=unused-argument
         {
             "id": item.id,
             "label": item.name,
-            "icon_class": "icon-{}".format(item.item_type),
+            "icon_class": f"icon-{item.item_type}",
             "edit_url": treeitem_edit_url(kw["request"], item),
             "group": group,
         }
@@ -110,6 +121,7 @@ def treeitems(node, kw, only_groups=False):  # pylint: disable=unused-argument
 
 
 def children_validator(node, cstruct):
+    """Get the validator on the children nodes."""
     for dict_ in cstruct:
         if not dict_["treeitem_id"] in [item["id"] for item in node.candidates]:
             raise colander.Invalid(
@@ -120,31 +132,34 @@ def children_validator(node, cstruct):
             )
 
 
-def base_deferred_parent_id_validator(node, kw, model):  # pylint: disable=unused-argument
+def base_deferred_parent_id_validator(node, kw, model):
+    """Get the validator on the parent node ID."""
+    del node
+
     def validator(node, cstruct):
         if kw["dbsession"].query(model).filter(model.id == cstruct).count() == 0:
-            raise colander.Invalid(
-                node, "Value {} does not exist in table {}".format(cstruct, model.__tablename__)
-            )
+            raise colander.Invalid(node, f"Value {cstruct} does not exist in table {model.__tablename__}")
 
     return validator
 
 
-def treeitem_edit_url(request, treeitem):
+def treeitem_edit_url(request: pyramid.request.Request, treeitem: TreeGroup) -> str | None:
+    """Get the tree item editing URL."""
     if treeitem.item_type is None:
         return None
     table = ITEM_TYPE_ROUTE_MAP.get(treeitem.item_type, None)
     if table is None:
-        LOG.warning("%s not found in ITEM_TYPE_ROUTE_MAP", treeitem.item_type)
+        _LOG.warning("%s not found in ITEM_TYPE_ROUTE_MAP", treeitem.item_type)
         return None
-    return request.route_url(
+    return request.route_url(  # type: ignore
         "c2cgeoform_item",
         table=ITEM_TYPE_ROUTE_MAP[treeitem.item_type],
         id=treeitem.id,
     )
 
 
-def children_schema_node(only_groups=False):
+def children_schema_node(only_groups: bool = False) -> colander.SequenceSchema:
+    """Geth the sequence to the children nodes."""
     return colander.SequenceSchema(
         ChildSchemaNode(
             LayergroupTreeitem,
@@ -153,12 +168,22 @@ def children_schema_node(only_groups=False):
                 input_name="treeitem_id",
                 model=TreeItem,
                 label_field="name",
-                icon_class=lambda treeitem: "icon-{}".format(treeitem.item_type),
+                icon_class=lambda treeitem: f"icon-{treeitem.item_type}",
                 edit_url=treeitem_edit_url,
             ),
         ),
         name="children_relation",
         title=_("Children"),
+        description=Literal(
+            _(
+                """
+                <div class="help-block">
+                    <p>The ordered children elements.</p>
+                    <hr>
+                </div>
+                """
+            ),
+        ),
         candidates=colander.deferred(partial(treeitems, only_groups=only_groups)),
         validator=children_validator,
         widget=ChildrenWidget(child_input_name="treeitem_id", add_subitem=True, orderable=True),

c2cgeoportal_admin/schemas/treeitem.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2018-2020, Camptocamp SA
+# Copyright (c) 2018-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -37,7 +35,8 @@ from c2cgeoportal_admin.schemas.treegroup import base_deferred_parent_id_validat
 
 
 # Used for the creation of a new layer/layergroup from the layertree
-def parent_id_node(model):
+def parent_id_node(model: type) -> colander.SchemaNode:
+    """Get the scheme to the parent node ID."""
     return colander.SchemaNode(
         colander.Integer(),
         name="parent_id",

c2cgeoportal_admin/static/layertree.css

@@ -64,7 +64,6 @@
   padding-left: 0px;
 }
 
-
 .jstree-grid-wrapper .jstree-node,
 .jstree-grid-wrapper .jstree-grid-cell-regular {
   border-top: 1px solid #ddd;
@@ -115,11 +114,11 @@
 }
 
 .jstree-open .jstree-icon.jstree-ocl:before {
-  content: "\e252";
+  content: '\e252';
 }
 .jstree-closed .jstree-icon.jstree-ocl:before {
-  content: "\e250";
+  content: '\e250';
 }
 .jstree-leaf .jstree-icon.jstree-ocl:before {
-  content: "";
+  content: '';
 }

c2cgeoportal_admin/static/navbar.css

@@ -32,7 +32,7 @@
 }
 
 @media (min-width: 992px) and (max-width: 1125px) {
-  .navbar-default .navbar-nav>li>a {
+  .navbar-default .navbar-nav > li > a {
     max-width: 8.5vw;
     overflow: hidden;
     text-overflow: ellipsis;
@@ -42,39 +42,40 @@
 
 /*csslint important: false*/
 @media (max-width: 991px) {
-    .navbar-header {
-        float: none;
-    }
-    .navbar-left,.navbar-right {
-        float: none !important;
-    }
-    .navbar-toggle {
-        display: block;
-    }
-    .navbar-collapse {
-        border-top: 1px solid transparent;
-        box-shadow: inset 0 1px 0 rgba(255,255,255,0.1);
-    }
-    .navbar-fixed-top {
-        top: 0;
-        border-width: 0 0 1px;
-    }
-    .navbar-collapse.collapse {
-        display: none!important;
-    }
-    .navbar-nav {
-        float: none!important;
-        margin-top: 7.5px;
-    }
-    .navbar-nav>li {
-        float: none;
-    }
-    .navbar-nav>li>a {
-        padding-top: 10px;
-        padding-bottom: 10px;
-    }
-    .collapse.in{
-        display:block !important;
-    }
+  .navbar-header {
+    float: none;
+  }
+  .navbar-left,
+  .navbar-right {
+    float: none !important;
+  }
+  .navbar-toggle {
+    display: block;
+  }
+  .navbar-collapse {
+    border-top: 1px solid transparent;
+    box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1);
+  }
+  .navbar-fixed-top {
+    top: 0;
+    border-width: 0 0 1px;
+  }
+  .navbar-collapse.collapse {
+    display: none !important;
+  }
+  .navbar-nav {
+    float: none !important;
+    margin-top: 7.5px;
+  }
+  .navbar-nav > li {
+    float: none;
+  }
+  .navbar-nav > li > a {
+    padding-top: 10px;
+    padding-bottom: 10px;
+  }
+  .collapse.in {
+    display: block !important;
+  }
 }
 /*csslint important: true*/

c2cgeoportal_admin/static/theme.css

@@ -21,33 +21,38 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-@import "navbar.css";
+@import 'navbar.css';
 
-.nav>li>a {
+.nav > li > a {
   padding-left: 8px;
   padding-right: 8px;
 }
 
 .bootstrap-table th.actions,
-.bootstrap-table td.actions
-{
+.bootstrap-table td.actions {
   width: 30px;
 }
 
 .icon-theme:before {
-  content: "\e139";
+  content: '\e139';
 }
 .icon-group:before {
-  content: "\e118";
+  content: '\e118';
 }
 .icon-l_wms:before {
-  content: "\e060";
+  content: '\e060';
 }
 .icon-l_wmts:before {
-  content: "\e011";
+  content: '\e011';
+}
+.icon-l_cog:before {
+  content: '\e011';
+}
+.icon-mvt:before {
+  content: '\e011';
 }
 .icon-user:before {
-  content: "\e008";
+  content: '\e008';
 }
 
 .ms-res-ctn .ms-res-item {
@@ -74,3 +79,8 @@
 #layertree .alert-info {
   margin-top: 30px;
 }
+
+.item-functionalities .checkbox label {
+  overflow: hidden;
+  overflow-wrap: break-word;
+}

c2cgeoportal_admin/subscribers.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2018-2020, Camptocamp SA
+# Copyright (c) 2018-2021, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -34,6 +32,7 @@ from pyramid.i18n import TranslationStringFactory, get_localizer
 
 
 def add_renderer_globals(event):
+    """Add the localizer to the global event."""
     request = event["request"]
     event["_"] = request.translate
     event["localizer"] = request.localizer
@@ -44,6 +43,7 @@ tsf2 = TranslationStringFactory("c2cgeoform")
 
 
 def add_localizer(event):
+    """Add the localizer to the request."""
     request = event.request
     localizer = get_localizer(request)
 

c2cgeoportal_admin/templates/404.jinja2

@@ -24,8 +24,24 @@
 {% extends "layout.jinja2" %}
 
 {% block content %}
-<div class="content">
-  <h1><span class="font-semi-bold">Pyramid</span> <span class="smaller">Alchemy scaffold</span></h1>
+<div class="container-fluid">
+{% if "table" in request.matchdict %}
+{% for table in request.c2cgeoform_application.tables() %}
+{% if table["key"] == request.matchdict["table"] %}
+<h2>
+{{ table["title"] }}
+</h2>
+{% endif %}
+{% endfor %}
+{% endif %}
+{% if context.detail %}
+<p>{{ context.detail }}</p>
+{% else  %}
+{% if "id" in request.matchdict and "table" in request.matchdict %}
+<p>{{ _("Element id '{}' not found, probably deleted.").format(request.matchdict["id"]) }}</p>
+{% else %}
   <p class="lead"><span class="font-semi-bold">404</span> Page Not Found</p>
+{% endif %}
+{% endif %}
 </div>
 {% endblock content %}

c2cgeoportal_admin/templates/layertree.jinja2

@@ -37,15 +37,26 @@
 {% block content %}
 <div id="layertree" class="container-fluid">
     <div id="toolbar">
-      <div class="btn-group">
-        {% if limit_exceeded %}
-        <button id="layertree-expand" type="button" class="btn btn-default"><span class="glyphicon glyphicon-chevron-down"></span> {{_("Expand all")}}</button>
-        {% endif %}
-        <button id="layertree-collapse" type="button" class="btn btn-default"><span class="glyphicon glyphicon-chevron-up"></span> {{_("Collapse all")}}</button>
-      </div>
-      <div class="btn-group">
-        <a id="layertree-ordering" class="btn btn-default" href="{{request.route_url('layertree_ordering')}}"><span class="glyphicon glyphicon-sort"></span> {{_("Edit themes order")}}</a>
-      </div>
+      <form class="form-inline">
+        <div class="form-group">
+          <label for="interface">{{ _("Interface") }}</label>
+          <select class="form-control" id="interface">
+            <option value="all">{{ _("All") }}</option>
+            {% for interface in interfaces %}
+            <option>{{ interface.name }}</option>
+            {% endfor %}
+          </select>
+        </div>
+        <div class="btn-group">
+          {% if limit_exceeded %}
+          <button id="layertree-expand" type="button" class="btn btn-default"><span class="glyphicon glyphicon-chevron-down"></span> {{_("Expand all")}}</button>
+          {% endif %}
+          <button id="layertree-collapse" type="button" class="btn btn-default"><span class="glyphicon glyphicon-chevron-up"></span> {{_("Collapse all")}}</button>
+        </div>
+        <div class="btn-group">
+          <a id="layertree-ordering" class="btn btn-default" href="{{request.route_url('layertree_ordering')}}"><span class="glyphicon glyphicon-sort"></span> {{_("Edit themes order")}}</a>
+        </div>
+      </form>
     </div>
 
     <div id="tree"></div>
@@ -56,8 +67,14 @@
         core: {
           data: function(node, callback) {
             var url = "{{ request.route_url('layertree_children') }}";
+            let separator = '?';
             if (node.id != '#') {
               url += "?group_id=" + node.data.id + "&path=" + node.id;
+              separator = '&';
+            }
+            const interface = $('#interface')[0].value;
+            if (interface != 'all') {
+              url += separator + "interface=" + interface;
             }
             $.ajax({ url: url })
             .done(function(data) {
@@ -226,6 +243,11 @@
         $('.jstree-grid-wrapper').height($(window).height() - $('nav').height() - $('#toolbar').height() - 50);
         $('.jstree-grid-wrapper').width('100%');
       });
+
+      const interfaceField = $('#interface');
+      interfaceField.on('change', function(e) {
+        $jstree.jstree(true).refresh();
+      });
     });
     </script>
 

c2cgeoportal_admin/templates/navigation_navbar.jinja2

@@ -46,6 +46,39 @@
         {% endfor %}
       </ul>
 
+      <button id="help-button" type="button" class="btn btn-default navbar-btn navbar-right">{{_("Show help")}}</button>
+      <script>
+      $(function() {
+        const key = 'adminShowHelp';
+
+        const getCurrentValue = function() {
+          // Get current value from localStorage
+          // True by default
+          return localStorage.getItem(key) !== 'false'
+        }
+
+        const apply = function(value) {
+          // Apply some value on UI
+          if (value) {
+            $("#help-button").addClass("active")
+            $(".help-block").removeClass("hidden")
+          } else {
+            $("#help-button").removeClass("active")
+            $(".help-block").addClass("hidden")
+          }
+        }
+
+        $("#help-button").click(function() {
+          // Toggle value in localStorage and apply on UI
+          localStorage.setItem(key, getCurrentValue() ? 'false' : 'true');
+          apply(getCurrentValue())
+        })
+
+        // Apply current value from localStorage on UI
+        apply(getCurrentValue())
+      });
+      </script>
+
       <ul class="nav navbar-nav navbar-right">
         <li id="language-dropdown" class="dropdown">
           <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">{{request.locale_name}} <span class="caret"></span></a>

c2cgeoportal_admin/templates/ogcserver_synchronize.jinja2

@@ -59,6 +59,18 @@
         <li>else it will create a <code>Group</code> object.</li>
       </ul>
       <form method="POST" class="deform" id="form-synchronize">
+        <div class="form-group">
+            <input type="checkbox" name="force-parents" id="force-parents-field">
+            <label for="force-parents-field" class="control-label">{{_("Force parents re-initialization.")}}</label>
+        </div>
+        <div class="form-group">
+            <input type="checkbox" name="force-ordering" id="force-ordering-field">
+            <label for="force-ordering-field" class="control-label">{{_("Force children sorting, current server at top and other servers at bottom.")}}</label>
+        </div>
+        <div class="form-group">
+            <input type="checkbox" name="clean" id="clean">
+            <label for="clean" class="control-label">{{_("Remove unexisting layers and empty groups.")}}</label>
+        </div>
         <button type="submit" name="synchronize" class="btn btn-primary">{{_("Synchronize")}}</button>
       </form>
     </div>

c2cgeoportal_admin/templates/widgets/functionality_fields.pt

@@ -0,0 +1,51 @@
+<tal:comment replace="nothing">
+The MIT License (MIT)
+
+Copyright (c) Camptocamp SA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+</tal:comment>
+
+<?python import json ?>
+
+<tal metal:use-macro='load:mapping_fields.pt'></tal>
+
+<script type="text/javascript">
+  deform.addCallback(
+     '${field['name'].oid}',
+     function(oid) {
+       const $name = $('#' + oid);
+
+       const functionalities = ${structure: json.dumps(field.schema.functionalities, indent=4, separators=(',', ': '))};
+
+       const $form = $name.closest('form');
+       const $valueItem = $form.find('.item-value');
+       const $helpBlock = $valueItem.find('p.help-block');
+
+       const updateDescription = function() {
+         const functionality = functionalities[$name.val()] || {};
+         const description = functionality.description || '';
+         $helpBlock.text(description);
+       }
+       $name.change(function() {
+         updateDescription();
+       });
+       updateDescription();
+     }
+   );
+</script>

c2cgeoportal_admin/templates/widgets/metadata.pt

@@ -75,13 +75,19 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
          $metadataItem.find('.col-value .form-group').hide();
          $metadataItem.find('.col-value .form-group .form-control').attr('disabled', true);
 
-         var type = (c2cgeoportalAdmin.metadata_definitions[$name.val()] || {}).type || 'string';
+         var metadataDef = c2cgeoportalAdmin.metadata_definitions[$name.val()] || {};
+         var type = metadataDef.type || 'string';
+         var description = metadataDef.description || '';
+
          $typedFormgroup = $metadataItem.find('.item-' + type);
          if ($typedFormgroup.length == 0) {
            $typedFormgroup = $metadataItem.find('.item-string');
          }
          $typedFormgroup.show();
          $typedFormgroup.find('.form-control').attr('disabled', false);
+
+         $helpBlock = $typedFormgroup.find('p.help-block');
+         $helpBlock.html(description);
        };
        $name.change(function() {
          updateType();

c2cgeoportal_admin/views/__init__.py

@@ -0,0 +1,29 @@
+import pyramid.httpexceptions
+import pyramid.request
+from pyramid.view import view_config
+
+
+class IsAdminPredicate:
+    """
+    A custom predicate that checks if the request is for the admin interface.
+    """
+
+    def __init__(self, val, info):
+        del info
+
+        self.val = val
+
+    def text(self):
+        return f"is_admin = {self.val}"
+
+    phash = text
+
+    def __call__(self, context, request):
+        return request.path.startswith("/admin/") or request.path == "/admin"
+
+
+@view_config(context=pyramid.httpexceptions.HTTPNotFound, is_admin=True, renderer="../templates/404.jinja2")
+def _not_found_view(request=pyramid.request.Request):
+    del request
+
+    return {}