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

c2cgeoportal_admin/views/dimension_layers.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2017-2020, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -30,7 +28,9 @@
 
 from functools import partial
 from itertools import groupby
+from typing import Generic, TypeVar, cast
 
+import sqlalchemy.orm.query
 from c2cgeoform.views.abstract_views import ListField
 from sqlalchemy.orm import subqueryload
 
@@ -39,20 +39,25 @@ from c2cgeoportal_commons.models.main import DimensionLayer
 
 _list_field = partial(ListField, DimensionLayer)
 
+_T = TypeVar("_T", bound=DimensionLayer)
+
 
-class DimensionLayerViews(LayerViews):
+class DimensionLayerViews(LayerViews[_T], Generic[_T]):
+    """The layer with dimensions administration view."""
 
     _extra_list_fields = [
         _list_field(
             "dimensions",
             renderer=lambda layer_wms: "; ".join(
                 [
-                    "{}: {}".format(group[0], ", ".join([d.value or "NULL" for d in group[1]]))
-                    for group in groupby(layer_wms.dimensions, lambda d: d.name)
+                    f"{group[0]}: {', '.join([d.value or 'NULL' for d in group[1]])}"
+                    for group in groupby(layer_wms.dimensions, lambda d: cast(str, d.name))
                 ]
             ),
         )
-    ] + LayerViews._extra_list_fields
+    ] + LayerViews._extra_list_fields  # pylint: disable=protected-access
 
-    def _base_query(self, query):
-        return super()._base_query(query.options(subqueryload("dimensions")))
+    def _sub_query(
+        self, query: sqlalchemy.orm.query.Query[DimensionLayer]
+    ) -> sqlalchemy.orm.query.Query[DimensionLayer]:
+        return super()._sub_query(query.options(subqueryload(DimensionLayer.dimensions)))

c2cgeoportal_admin/views/functionalities.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2017-2020, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,47 +27,83 @@
 
 
 from functools import partial
+from typing import Any
 
+import colander
+import pyramid.request
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews, ListField
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
+from deform.widget import FormWidget
 from pyramid.view import view_config, view_defaults
 
+from c2cgeoportal_admin import _
+from c2cgeoportal_admin.views.logged_views import LoggedViews
 from c2cgeoportal_commons.models.main import Functionality
 
 _list_field = partial(ListField, Functionality)
 
-base_schema = GeoFormSchemaNode(Functionality)
+
+def _translate_available_functionality(
+    available_functionality: dict[str, Any], request: pyramid.request.Request
+) -> dict[str, Any]:
+    result = {}
+    result.update(available_functionality)
+    result["description"] = request.localizer.translate(
+        _(available_functionality.get("description", "").strip())
+    )
+    return result
+
+
+base_schema = GeoFormSchemaNode(
+    Functionality,
+    widget=FormWidget(fields_template="functionality_fields"),
+    functionalities=colander.deferred(
+        lambda node, kw: {
+            f["name"]: _translate_available_functionality(f, kw["request"])
+            for f in kw["request"].registry.settings["admin_interface"]["available_functionalities"]
+        },
+    ),
+)
 
 
 @view_defaults(match_param="table=functionalities")
-class FunctionalityViews(AbstractViews):
+class FunctionalityViews(LoggedViews[Functionality]):
+    """The functionality administration view."""
+
     _list_fields = [_list_field("id"), _list_field("name"), _list_field("description"), _list_field("value")]
     _id_field = "id"
     _model = Functionality
     _base_schema = base_schema
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
-    def index(self):
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
         return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
-    def grid(self):
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
         return super().grid()
 
-    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         return super().edit()
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         return super().save()
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")
-    def delete(self):
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         return super().delete()
 
     @view_config(
-        route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
+        route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"  # type: ignore[misc]
     )
-    def duplicate(self):
+    def duplicate(self) -> ObjectResponse:
         return super().duplicate()

c2cgeoportal_admin/views/home.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2017-2020, Camptocamp SA
+# Copyright (c) 2017-2021, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -28,10 +26,12 @@
 # either expressed or implied, of the FreeBSD Project.
 
 
+import pyramid.request
 from pyramid.httpexceptions import HTTPFound
 from pyramid.view import view_config
 
 
-@view_config(route_name="admin")
-def home_view(request):
+@view_config(route_name="admin")  # type: ignore  # type: ignore
+def home_view(request: pyramid.request.Request) -> HTTPFound:
+    """Get the main administration view, redirect to the layertree."""
     return HTTPFound(request.route_url("layertree", application="admin"))

c2cgeoportal_admin/views/interfaces.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2017-2020, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -31,9 +29,17 @@
 from functools import partial
 
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews, ListField
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
 from pyramid.view import view_config, view_defaults
 
+from c2cgeoportal_admin.views.logged_views import LoggedViews
 from c2cgeoportal_commons.models.main import Interface
 
 _list_field = partial(ListField, Interface)
@@ -42,7 +48,9 @@ base_schema = GeoFormSchemaNode(Interface)
 
 
 @view_defaults(match_param="table=interfaces")
-class InterfacesViews(AbstractViews):
+class InterfacesViews(LoggedViews[Interface]):
+    """The interface administration view."""
+
     _list_fields = [
         _list_field("id"),
         _list_field("name"),
@@ -52,37 +60,35 @@ class InterfacesViews(AbstractViews):
         ),
         _list_field(
             "theme",
-            renderer=lambda interface: ", ".join(
-                ["{}-{}".format(t.name, t.name) or "" for t in interface.theme]
-            ),
+            renderer=lambda interface: ", ".join([f"{t.name}-{t.name}" or "" for t in interface.theme]),
         ),
     ]
     _id_field = "id"
     _model = Interface
     _base_schema = base_schema
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
-    def index(self):
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
         return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
-    def grid(self):
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
         return super().grid()
 
-    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         return super().edit()
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         return super().save()
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")
-    def delete(self):
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         return super().delete()
 
-    @view_config(
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def duplicate(self):
+    def duplicate(self) -> ObjectResponse:
         return super().duplicate()

c2cgeoportal_admin/views/layer_groups.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2017-2020, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -30,12 +28,21 @@
 
 from functools import partial
 
+import sqlalchemy
+import sqlalchemy.orm.query
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import ListField
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
 from deform.widget import FormWidget
 from pyramid.view import view_config, view_defaults
 
-from c2cgeoportal_admin.schemas.metadata import metadatas_schema_node
+from c2cgeoportal_admin.schemas.metadata import metadata_schema_node
 from c2cgeoportal_admin.schemas.treegroup import children_schema_node
 from c2cgeoportal_admin.schemas.treeitem import parent_id_node
 from c2cgeoportal_admin.views.treeitems import TreeItemViews
@@ -43,50 +50,54 @@ from c2cgeoportal_commons.models.main import LayerGroup, TreeGroup
 
 _list_field = partial(ListField, LayerGroup)
 
-
 base_schema = GeoFormSchemaNode(LayerGroup, widget=FormWidget(fields_template="layer_group_fields"))
 base_schema.add(children_schema_node())
-base_schema.add(metadatas_schema_node.clone())
+base_schema.add(metadata_schema_node(LayerGroup.metadatas, LayerGroup))
 base_schema.add_unique_validator(LayerGroup.name, LayerGroup.id)
 base_schema.add(parent_id_node(TreeGroup))
 
 
 @view_defaults(match_param="table=layer_groups")
-class LayerGroupsViews(TreeItemViews):
+class LayerGroupsViews(TreeItemViews[LayerGroup]):
+    """The layer group administration view."""
 
-    _list_fields = (
-        TreeItemViews._list_fields + [_list_field("is_expanded")] + TreeItemViews._extra_list_fields
-    )
+    _list_fields = TreeItemViews._list_fields + TreeItemViews._extra_list_fields  # type: ignore[misc] # pylint: disable=protected-access
 
     _id_field = "id"
     _model = LayerGroup
     _base_schema = base_schema
 
-    def _base_query(self, query=None):
-        return super()._base_query(self._request.dbsession.query(LayerGroup).distinct())
+    def _base_query(self) -> sqlalchemy.orm.query.Query[LayerGroup]:
+        return super()._sub_query(self._request.dbsession.query(LayerGroup).distinct())
+
+    def _sub_query(
+        self, query: sqlalchemy.orm.query.Query[LayerGroup]
+    ) -> sqlalchemy.orm.query.Query[LayerGroup]:
+        del query
+        return self._base_query()
 
-    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
-    def index(self):
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
         return super().index()
 
-    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
-    def grid(self):
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
         return super().grid()
 
-    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")
-    def view(self):
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
         return super().edit()
 
-    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")
-    def save(self):
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
         return super().save()
 
-    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")
-    def delete(self):
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
         return super().delete()
 
-    @view_config(
+    @view_config(  # type: ignore[misc]
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
     )
-    def duplicate(self):
+    def duplicate(self) -> ObjectResponse:
         return super().duplicate()

c2cgeoportal_admin/views/layers.py

@@ -1,6 +1,4 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2017-2020, Camptocamp SA
+# Copyright (c) 2017-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,7 +27,10 @@
 
 
 from functools import partial
+from typing import Generic, TypeVar, cast
 
+import sqlalchemy
+import sqlalchemy.orm.query
 from c2cgeoform.views.abstract_views import ListField
 from sqlalchemy.orm import subqueryload
 
@@ -38,10 +39,13 @@ from c2cgeoportal_commons.models.main import Interface, Layer
 
 _list_field = partial(ListField, Layer)
 
+_T = TypeVar("_T", bound=Layer)
+
 
-class LayerViews(TreeItemViews):
+class LayerViews(TreeItemViews[_T], Generic[_T]):
+    """The layer administration view."""
 
-    _list_fields = TreeItemViews._list_fields + [
+    _list_fields = TreeItemViews._list_fields + [  # type: ignore[misc] # pylint: disable=protected-access
         _list_field("public"),
         _list_field("geo_table"),
         _list_field("exclude_properties"),
@@ -51,7 +55,7 @@ class LayerViews(TreeItemViews):
         _list_field(
             "interfaces",
             renderer=lambda layer_wms: ", ".join(
-                [i.name or "" for i in sorted(layer_wms.interfaces, key=lambda i: i.name)]
+                [i.name or "" for i in sorted(layer_wms.interfaces, key=lambda i: cast(str, i.name))]
             ),
             sort_column=Interface.name,
             filter_column=Interface.name,
@@ -59,14 +63,14 @@ class LayerViews(TreeItemViews):
         _list_field(
             "restrictionareas",
             renderer=lambda layer_wms: ", ".join(
-                [r.name or "" for r in sorted(layer_wms.restrictionareas, key=lambda r: r.name)]
+                [r.name or "" for r in sorted(layer_wms.restrictionareas, key=lambda r: cast(str, r.name))]
             ),
         ),
-    ] + TreeItemViews._extra_list_fields
+    ] + TreeItemViews._extra_list_fields  # pylint: disable=protected-access
 
-    def _base_query(self, query):
-        return super()._base_query(
-            query.outerjoin("interfaces")
-            .options(subqueryload("interfaces"))
-            .options(subqueryload("restrictionareas"))
+    def _sub_query(self, query: sqlalchemy.orm.query.Query[Layer]) -> sqlalchemy.orm.query.Query[Layer]:
+        return super()._sub_query(
+            query.outerjoin(Layer.interfaces)
+            .options(subqueryload(Layer.interfaces))
+            .options(subqueryload(Layer.restrictionareas))
         )

c2cgeoportal_admin/views/layers_cog.py

@@ -0,0 +1,135 @@
+# Copyright (c) 2017-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.
+
+
+from functools import partial
+from typing import cast
+
+import sqlalchemy
+import sqlalchemy.orm.query
+from c2cgeoform.schema import GeoFormSchemaNode
+from c2cgeoform.views.abstract_views import (
+    DeleteResponse,
+    GridResponse,
+    IndexResponse,
+    ListField,
+    ObjectResponse,
+    SaveResponse,
+)
+from deform.widget import FormWidget
+from pyramid.httpexceptions import HTTPNotFound
+from pyramid.view import view_config, view_defaults
+
+from c2cgeoportal_admin import _
+from c2cgeoportal_admin.schemas.interfaces import interfaces_schema_node
+from c2cgeoportal_admin.schemas.metadata import metadata_schema_node
+from c2cgeoportal_admin.schemas.restriction_areas import restrictionareas_schema_node
+from c2cgeoportal_admin.schemas.treeitem import parent_id_node
+from c2cgeoportal_admin.views.layers import LayerViews
+from c2cgeoportal_commons.lib.literal import Literal
+from c2cgeoportal_commons.models.main import LayerCOG, LayerGroup
+
+_list_field = partial(ListField, LayerCOG)
+
+
+base_schema = GeoFormSchemaNode(LayerCOG, widget=FormWidget(fields_template="layer_fields"))
+base_schema.add(metadata_schema_node(LayerCOG.metadatas, LayerCOG))
+base_schema.add(interfaces_schema_node(LayerCOG.interfaces))
+base_schema.add(restrictionareas_schema_node(LayerCOG.restrictionareas))
+base_schema.add_unique_validator(LayerCOG.name, LayerCOG.id)
+base_schema.add(parent_id_node(LayerGroup))
+
+
+@view_defaults(match_param="table=layers_cog")
+class LayerCOGViews(LayerViews[LayerCOG]):
+    """The vector tiles administration view."""
+
+    _list_fields = (
+        LayerViews._list_fields  # typer: ignore[misc] # pylint: disable=protected-access
+        + [_list_field("url")]
+        + LayerViews._extra_list_fields  # pylint: disable=protected-access
+    )
+
+    _id_field = "id"
+    _model = LayerCOG
+    _base_schema = base_schema
+
+    def _base_query(self) -> sqlalchemy.orm.query.Query[LayerCOG]:
+        return super()._sub_query(self._request.dbsession.query(LayerCOG).distinct())
+
+    def _sub_query(
+        self, query: sqlalchemy.orm.query.Query[LayerCOG] | None
+    ) -> sqlalchemy.orm.query.Query[LayerCOG]:
+        del query
+        return self._base_query()
+
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")  # type: ignore[misc]
+    def index(self) -> IndexResponse:
+        return super().index()
+
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")  # type: ignore[misc]
+    def grid(self) -> GridResponse:
+        return super().grid()
+
+    def schema(self) -> GeoFormSchemaNode:
+        try:
+            obj = self._get_object()
+        except HTTPNotFound:
+            obj = None
+
+        schema = cast(GeoFormSchemaNode, self._base_schema.clone())
+        if obj is not None:
+            schema["url"].description = Literal(
+                _("{}<br>Current runtime value is: {}").format(
+                    schema["url"].description,
+                    obj.url_description(self._request),
+                )
+            )
+        return schema
+
+    @view_config(route_name="c2cgeoform_item", request_method="GET", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def view(self) -> ObjectResponse:
+        if self._is_new():
+            dbsession = self._request.dbsession
+            default_cog = LayerCOG.get_default(dbsession)
+            if default_cog:
+                return self.copy(default_cog, excludes=["name", "url"])
+        return super().edit()
+
+    @view_config(route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2")  # type: ignore[misc]
+    def save(self) -> SaveResponse:
+        return super().save()
+
+    @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore[misc]
+    def delete(self) -> DeleteResponse:
+        return super().delete()
+
+    @view_config(  # type: ignore[misc]
+        route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
+    )
+    def duplicate(self) -> ObjectResponse:
+        return super().duplicate()