c2cgeoportal-admin 2.7.1.156__py3-none-any.whl → 2.8.1.180__py3-none-any.whl

c2cgeoportal_admin/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -42,6 +42,7 @@ from transaction import TransactionManager
 from translationstring import TranslationStringFactory
 
 from c2cgeoportal_admin.subscribers import add_localizer, add_renderer_globals
+from c2cgeoportal_admin.views import IsAdminPredicate
 
 search_paths = (resource_filename(__name__, "templates/widgets"),) + c2cgeoform.default_search_paths
 c2cgeoform.default_search_paths = search_paths
@@ -83,6 +84,19 @@ def main(_, **settings):
         reify=True,
     )
 
+    # Add fake user as we do not have authentication from geoportal
+    from c2cgeoportal_commons.models.static import User  # pylint: disable=import-outside-toplevel
+
+    config.add_request_method(
+        lambda request: User(
+            username="test_user",
+        ),
+        name="user",
+        property=True,
+    )
+
+    config.add_route("ogc_server_clear_cache", "/ogc_server_clear_cache/{id}")
+
     config.add_subscriber(add_renderer_globals, BeforeRender)
     config.add_subscriber(add_localizer, NewRequest)
 
@@ -118,6 +132,7 @@ def includeme(config: Configurator) -> None:
     # Use pyramid_tm to hook the transaction lifecycle to the request
     config.include("pyramid_tm")
     config.add_translation_dirs("c2cgeoportal_admin:locale")
+    config.add_view_predicate("is_admin", IsAdminPredicate)
 
     configure_mappers()
 

c2cgeoportal_admin/lib/ogcserver_synchronizer.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2020-2021, Camptocamp SA
+# Copyright (c) 2020-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -357,7 +357,7 @@ class OGCServerSynchronizer:
 
         return layer
 
-    @functools.lru_cache()
+    @functools.lru_cache(maxsize=10)
     def wms_capabilities(self) -> bytes:
         errors: Set[str] = set()
         url = get_url2(
@@ -367,7 +367,7 @@ class OGCServerSynchronizer:
             errors,
         )
         if url is None:
-            raise Exception("\n".join(errors))
+            raise Exception("\n".join(errors))  # pylint: disable=broad-exception-raised
 
         # Add functionality params
         # sparams = get_mapserver_substitution_params(self.request)
@@ -401,7 +401,7 @@ class OGCServerSynchronizer:
             "application/vnd.ogc.wms_xml",
             "text/xml",
         ]:
-            raise Exception(
+            raise Exception(  # pylint: disable=broad-exception-raised
                 f"GetCapabilities from URL '{url}' returns a wrong Content-Type: "
                 f"{response.headers.get('Content-Type', '')}\n{response.text}"
             )

c2cgeoportal_admin/routes.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -61,6 +61,7 @@ def includeme(config):
         LayerVectorTiles,
         LayerWMS,
         LayerWMTS,
+        Log,
         OGCServer,
         RestrictionArea,
         Role,
@@ -84,6 +85,7 @@ def includeme(config):
         ("functionalities", Functionality),
         ("interfaces", Interface),
         ("oauth2_clients", OAuth2Client),
+        ("logs", Log),
     ]
 
     admin_interface_config = config.registry.settings["admin_interface"]

c2cgeoportal_admin/schemas/metadata.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2021, Camptocamp SA
+# Copyright (c) 2018-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_admin/schemas/treegroup.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2022, Camptocamp SA
+# Copyright (c) 2018-2024, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -78,7 +78,7 @@ def treeitems(
         .distinct()
         .outerjoin("parents_relation")
         .filter(TreeItem.item_type != "theme")
-        .group_by(TreeItem.id)
+        .group_by(TreeItem)
         .order_by(group.desc(), TreeItem.name)
     )
 

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/widgets/metadata.pt

@@ -87,7 +87,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
          $typedFormgroup.find('.form-control').attr('disabled', false);
 
          $helpBlock = $typedFormgroup.find('p.help-block');
-         $helpBlock.text(description);
+         $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 {}

c2cgeoportal_admin/views/functionalities.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -32,11 +32,12 @@ from typing import Any, Dict
 import colander
 import pyramid.request
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews, ListField
+from c2cgeoform.views.abstract_views import ListField
 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)
@@ -66,7 +67,7 @@ base_schema = GeoFormSchemaNode(
 
 
 @view_defaults(match_param="table=functionalities")
-class FunctionalityViews(AbstractViews):  # type: ignore
+class FunctionalityViews(LoggedViews):
     """The functionality administration view."""
 
     _list_fields = [_list_field("id"), _list_field("name"), _list_field("description"), _list_field("value")]

c2cgeoportal_admin/views/interfaces.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -29,9 +29,10 @@
 from functools import partial
 
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews, ListField
+from c2cgeoform.views.abstract_views import ListField
 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)
@@ -40,7 +41,7 @@ base_schema = GeoFormSchemaNode(Interface)
 
 
 @view_defaults(match_param="table=interfaces")
-class InterfacesViews(AbstractViews):  # type: ignore
+class InterfacesViews(LoggedViews):
     """The interface administration view."""
 
     _list_fields = [

c2cgeoportal_admin/views/layer_groups.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without

c2cgeoportal_admin/views/layers_wms.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -44,7 +44,7 @@ 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.dimension_layers import DimensionLayerViews
-from c2cgeoportal_commons.models.main import LayerGroup, LayerWMS, LayerWMTS, OGCServer, TreeItem
+from c2cgeoportal_commons.models.main import LayerGroup, LayerWMS, LayerWMTS, LogAction, OGCServer, TreeItem
 
 _list_field = partial(ListField, LayerWMS)
 
@@ -130,7 +130,7 @@ class LayerWmsViews(DimensionLayerViews):
 
     @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore
     def delete(self) -> Dict[str, Any]:
-        return super().delete()  # type: ignore
+        return super().delete()
 
     @view_config(  # type: ignore
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
@@ -172,6 +172,8 @@ class LayerWmsViews(DimensionLayerViews):
         dbsession.flush()
         mark_changed(dbsession)
 
+        self._create_log(LogAction.CONVERT_TO_WMTS, src, element_url_table="layers_wmts")
+
         return {
             "success": True,
             "redirect": self._request.route_url(

c2cgeoportal_admin/views/layers_wmts.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -44,7 +44,7 @@ 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.dimension_layers import DimensionLayerViews
-from c2cgeoportal_commons.models.main import LayerGroup, LayerWMS, LayerWMTS, OGCServer, TreeItem
+from c2cgeoportal_commons.models.main import LayerGroup, LayerWMS, LayerWMTS, LogAction, OGCServer, TreeItem
 
 _list_field = partial(ListField, LayerWMTS)
 
@@ -122,7 +122,7 @@ class LayerWmtsViews(DimensionLayerViews):
 
     @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore
     def delete(self) -> Dict[str, Any]:
-        return super().delete()  # type: ignore
+        return super().delete()
 
     @view_config(  # type: ignore
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"
@@ -165,6 +165,8 @@ class LayerWmtsViews(DimensionLayerViews):
         dbsession.flush()
         mark_changed(dbsession)
 
+        self._create_log(LogAction.CONVERT_TO_WMS, src, element_url_table="layers_wms")
+
         return {
             "success": True,
             "redirect": self._request.route_url(

c2cgeoportal_admin/views/layertree.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2017-2021, Camptocamp SA
+# Copyright (c) 2017-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -45,7 +45,7 @@ itemtypes_tables = {
 }
 
 
-@view_defaults(match_param=("application=admin"))
+@view_defaults(match_param="application=admin")
 class LayerTreeViews:
     """The layer tree administration view."""
 

c2cgeoportal_admin/views/logged_views.py

@@ -0,0 +1,80 @@
+# Copyright (c) 2023-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 datetime
+from typing import Any, Dict, Optional, Union
+
+import pytz
+from c2cgeoform.views.abstract_views import AbstractViews
+from pyramid.httpexceptions import HTTPFound
+
+from c2cgeoportal_commons.models import Base
+from c2cgeoportal_commons.models.main import Log, LogAction
+
+
+class LoggedViews(AbstractViews):  # type: ignore
+    """Extension of AbstractViews which log actions in a table."""
+
+    _log_model = Log  # main.Log or static.Log
+    _name_field = "name"
+
+    def save(self) -> Union[HTTPFound, Dict[str, Any]]:
+        response = super().save()
+
+        if isinstance(response, HTTPFound):
+            self._create_log(
+                action=LogAction.INSERT if self._is_new() else LogAction.UPDATE,
+                obj=self._obj,
+            )
+
+        return response
+
+    def delete(self) -> Dict[str, Any]:
+        obj = self._get_object()
+
+        response = super().delete()
+
+        self._create_log(LogAction.DELETE, obj)
+
+        return response  # type: ignore
+
+    def _create_log(
+        self,
+        action: LogAction,
+        obj: Base,
+        element_url_table: Optional[str] = None,
+    ) -> None:
+        log = self._log_model(
+            date=datetime.datetime.now(pytz.utc),
+            action=action,
+            element_type=self._model.__tablename__,
+            element_id=getattr(obj, self._id_field),
+            element_name=getattr(obj, self._name_field),
+            element_url_table=element_url_table or self._request.matchdict.get("table", None),
+            username=self._request.user.username,
+        )
+        self._request.dbsession.add(log)

c2cgeoportal_admin/views/logs.py

@@ -0,0 +1,90 @@
+# Copyright (c) 2023-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.
+
+from functools import partial
+
+from c2cgeoform.views.abstract_views import AbstractViews, ItemAction, ListField
+from pyramid.view import view_config, view_defaults
+
+from c2cgeoportal_commons.models import _
+from c2cgeoportal_commons.models.main import AbstractLog
+
+_list_field = partial(ListField, AbstractLog)
+
+
+@view_defaults(match_param="table=logs")
+class LogViews(AbstractViews):  # type: ignore
+    """The theme administration view."""
+
+    # We pass labels explicitly because actually we are not able to get info
+    # from InstrumentedAttribute created from AbstractConcreteBase.
+    _list_fields = [
+        _list_field("id"),
+        _list_field("date", label=_("Date")),
+        _list_field("username", label=_("Username")),
+        _list_field("action", label=_("Action"), renderer=lambda log: log.action.name),
+        _list_field("element_type", label=_("Element type")),
+        _list_field("element_id", label=_("Element identifier")),
+        _list_field("element_name", label=_("Element name")),
+    ]
+    _list_ordered_fields = [AbstractLog.date.desc()]
+
+    _id_field = "id"
+    _model = AbstractLog
+
+    @view_config(route_name="c2cgeoform_index", renderer="../templates/index.jinja2")
+    def index(self):
+        return super().index()
+
+    @view_config(route_name="c2cgeoform_grid", renderer="fast_json")
+    def grid(self):
+        return super().grid()
+
+    def _grid_actions(self):
+        return []
+
+    def _grid_item_actions(self, item):
+        element_url = self._request.route_url(
+            "c2cgeoform_item",
+            table=item.element_url_table,
+            id=item.element_id,
+        )
+
+        return {
+            "dblclick": element_url,
+            "dropdown": [
+                ItemAction(
+                    name="edit_element",
+                    label=_("Edit element"),
+                    icon="glyphicon glyphicon-pencil",
+                    url=element_url,
+                ).to_dict(self._request)
+            ],
+        }
+
+    def _item_actions(self, item, readonly=False):
+        return []

c2cgeoportal_admin/views/oauth2_clients.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2021, Camptocamp SA
+# Copyright (c) 2021-2023, Camptocamp SA
 # All rights reserved.
 
 # Redistribution and use in source and binary forms, with or without
@@ -30,10 +30,11 @@ from functools import partial
 from typing import Any, Dict
 
 from c2cgeoform.schema import GeoFormSchemaNode
-from c2cgeoform.views.abstract_views import AbstractViews, ListField
+from c2cgeoform.views.abstract_views import ListField
 from pyramid.view import view_config, view_defaults
 
-from c2cgeoportal_commons.models.static import OAuth2Client
+from c2cgeoportal_admin.views.logged_views import LoggedViews
+from c2cgeoportal_commons.models.static import Log, OAuth2Client
 
 _list_field = partial(ListField, OAuth2Client)
 
@@ -42,7 +43,7 @@ base_schema.add_unique_validator(OAuth2Client.client_id, OAuth2Client.id)
 
 
 @view_defaults(match_param="table=oauth2_clients")
-class OAuth2ClientViews(AbstractViews):  # type: ignore
+class OAuth2ClientViews(LoggedViews):
     """The oAuth2 client administration view."""
 
     _list_fields = [
@@ -54,6 +55,8 @@ class OAuth2ClientViews(AbstractViews):  # type: ignore
     _id_field = "id"
     _model = OAuth2Client
     _base_schema = base_schema
+    _log_model = Log
+    _name_field = "client_id"
 
     def _base_query(self):
         return self._request.dbsession.query(OAuth2Client)
@@ -76,11 +79,11 @@ class OAuth2ClientViews(AbstractViews):  # type: ignore
         route_name="c2cgeoform_item", request_method="POST", renderer="../templates/edit.jinja2"
     )
     def save(self) -> Dict[str, Any]:
-        return super().save()  # type: ignore
+        return super().save()
 
     @view_config(route_name="c2cgeoform_item", request_method="DELETE", renderer="fast_json")  # type: ignore
     def delete(self) -> Dict[str, Any]:
-        return super().delete()  # type: ignore
+        return super().delete()
 
     @view_config(  # type: ignore
         route_name="c2cgeoform_item_duplicate", request_method="GET", renderer="../templates/edit.jinja2"