eea.volto.policy 5.0__zip → 5.2__zip

{eea.volto.policy-5.0/eea.volto.policy.egg-info → eea.volto.policy-5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eea.volto.policy
-Version: 5.0
+Version: 5.2
 Summary: An add-on for Plone
 Home-page: https://github.com/eea/eea.volto.policy
 Author: European Environment Agency: IDM2 A-Team
@@ -128,6 +128,20 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+5.2 - (2024-08-19)
+---------------------------
+* Feature: Check for permissions when serializing restricted blocks
+  [razvanMiu - refs #273963]
+* Feature: Customized context navigation endpoint to filter portal_type
+  [ichim-david - refs #270999]
+* Fix: Depth of context navigation endpoint by passing depth parameter
+  [ichim-david - refs #270999]
+
+5.1 - (2024-07-22)
+---------------------------
+* Change: Release
+  [avoinea]
+
 5.0 - (2024-06-11)
 ---------------------------
 * Breaking: Requires `plone.volto >= 4.1.0`

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/docs/HISTORY.txt

@@ -1,6 +1,20 @@
 Changelog
 =========
 
+5.2 - (2024-08-19)
+---------------------------
+* Feature: Check for permissions when serializing restricted blocks
+  [razvanMiu - refs #273963]
+* Feature: Customized context navigation endpoint to filter portal_type
+  [ichim-david - refs #270999]
+* Fix: Depth of context navigation endpoint by passing depth parameter
+  [ichim-david - refs #270999]
+
+5.1 - (2024-07-22)
+---------------------------
+* Change: Release
+  [avoinea]
+
 5.0 - (2024-06-11)
 ---------------------------
 * Breaking: Requires `plone.volto >= 4.1.0`

eea.volto.policy-5.2/eea/volto/policy/behaviors/configure.zcml

@@ -0,0 +1,15 @@
+<configure
+  xmlns="http://namespaces.zope.org/zope"
+  xmlns:plone="http://namespaces.plone.org/plone"
+  i18n_domain="eea">
+
+
+  <plone:behavior
+      name="eea.side_nav_title"
+      title="EEA Side Navigation title"
+      description="Used by the side navigation block"
+      provides=".sidenavigation.IEEASideNavTitle"
+      />
+
+
+</configure>

eea.volto.policy-5.2/eea/volto/policy/behaviors/sidenavigation.py

@@ -0,0 +1,13 @@
+"""Side navigation behaviors"""
+from plone.app.dexterity import _
+from plone.autoform.interfaces import IFormFieldProvider
+from plone.supermodel import model
+from zope.interface import provider
+from zope.schema import TextLine
+
+
+@provider(IFormFieldProvider)
+class IEEASideNavTitle(model.Schema):
+    """Behavior interface to set a title for the side navigation."""
+
+    side_nav_title = TextLine(title=_("Side Navigation title"), required=False)

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/eea/volto/policy/configure.zcml

@@ -9,6 +9,7 @@
 
   <include package="plone.volto" />
   <include file="profiles.zcml" />
+  <include file="permissions.zcml" />
 
   <include package=".browser" />
   <include package=".behaviors" />

eea.volto.policy-5.2/eea/volto/policy/permissions.zcml

@@ -0,0 +1,12 @@
+<configure
+  xmlns="http://namespaces.zope.org/zope"
+  xmlns:zcml="http://namespaces.zope.org/zcml"
+>
+  <configure zcml:condition="installed AccessControl.security">
+    <permission
+      id="eea.blocks.manageRestrictedBlocks"
+      title="EEA: Manage restricted blocks"
+    />
+  </configure>
+
+</configure>

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/eea/volto/policy/profiles/default/catalog.xml

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <object meta_type="Plone Catalog Tool" name="portal_catalog">
   <column value="image_scales" />
+  <column value="side_nav_title" />
 </object>

eea.volto.policy-5.2/eea/volto/policy/profiles/default/registry/side_nav_types.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<registry>
+  <record name="plone.side_nav_types"
+    interface="Products.CMFPlone.interfaces.controlpanel.INavigationSchema"
+    field="side_nav_types">
+    <value>
+      <element>Document</element>
+    </value>
+  </record>
+
+</registry>

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/eea/volto/policy/profiles/default/registry.xml

@@ -20,4 +20,7 @@
       <element>huge 1920:65536</element>
     </value>
   </record>
+  <records interface="plone.restapi.bbb.INavigationSchema"
+           prefix="plone"
+  />
 </registry>

eea.volto.policy-5.2/eea/volto/policy/restapi/blocks.py

@@ -0,0 +1,32 @@
+""" block-related utils """
+
+from plone import api
+from plone.restapi.behaviors import IBlocks
+from plone.restapi.interfaces import IBlockFieldSerializationTransformer
+from zope.component import adapter
+from zope.interface import implementer
+from zope.publisher.interfaces.browser import IBrowserRequest
+
+
+@implementer(IBlockFieldSerializationTransformer)
+@adapter(IBlocks, IBrowserRequest)
+class RestrictedBlockSerializationTransformer:
+    """Restricted Block serialization"""
+
+    order = 9999
+    block_type = None
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, value):
+        restrictedBlock = value.get("restrictedBlock", False)
+        if not restrictedBlock:
+            return value
+        if restrictedBlock and api.user.has_permission(
+                'EEA: Manage restricted blocks', obj=self.context):
+            return value
+        return {
+            "@type": "empty"
+        }

eea.volto.policy-5.2/eea/volto/policy/restapi/configure.zcml

@@ -0,0 +1,13 @@
+<configure xmlns="http://namespaces.zope.org/zope" xmlns:plone="http://namespaces.plone.org/plone">
+  <include package="plone.restapi" />
+  <include package=".deserializer" />
+  <include package=".navigation" />
+  <include package=".serializer" />
+  <include package=".services" />
+  
+  <!--  Serializations -->
+  <subscriber
+    provides="plone.restapi.interfaces.IBlockFieldSerializationTransformer"
+    factory=".blocks.RestrictedBlockSerializationTransformer" />
+
+</configure>

eea.volto.policy-5.2/eea/volto/policy/restapi/serializer/__init__.py

@@ -0,0 +1 @@
+"""RestAPI serializer"""

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/eea/volto/policy/restapi/serializer/configure.zcml

@@ -4,6 +4,8 @@
     >
 
   <adapter factory=".dxfields.DateTimeFieldSerializer" />
+  <adapter factory=".dxfields.EEAPrimaryFileFieldTarget" />
+  
     <utility
       factory=".summary.EEAJSONSummarySerializerMetadata"
       name="plone.restapi.eea_summary_serializer_metadata"

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/eea/volto/policy/restapi/serializer/dxfields.py

@@ -4,10 +4,13 @@ from plone.app.dexterity.behaviors.metadata import IPublication
 from plone.dexterity.interfaces import IDexterityContent
 from plone.restapi.interfaces import IFieldSerializer
 from plone.restapi.serializer.dxfields import DefaultFieldSerializer
+from plone.restapi.serializer.dxfields import DefaultPrimaryFieldTarget
+from plone.namedfile.interfaces import INamedFileField
 from zope.component import adapter
 from zope.interface import implementer
 from zope.schema.interfaces import IDatetime
 
+
 from eea.volto.policy.interfaces import IEeaVoltoPolicyLayer
 try:
     from eea.coremetadata.metadata import ICoreMetadata
@@ -34,3 +37,12 @@ class DateTimeFieldSerializer(DefaultFieldSerializer):
             # timezone
             return getattr(self.context, self.field.__name__)()
         return value
+
+
+@adapter(INamedFileField, IDexterityContent, IEeaVoltoPolicyLayer)
+class EEAPrimaryFileFieldTarget(DefaultPrimaryFieldTarget):
+    """ EEAPrimaryFileFieldTarget adapter of PrimaryFileFieldTarget
+    """
+    def __call__(self):
+        if self.field.__name__ == 'file':
+            return

eea.volto.policy-5.2/eea/volto/policy/restapi/services/__init__.py

@@ -0,0 +1 @@
+"""RestAPI services"""

eea.volto.policy-5.2/eea/volto/policy/restapi/services/configure.zcml

@@ -0,0 +1,6 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:zcml="http://namespaces.zope.org/zcml"
+    >
+  <include package=".contextnavigation" />
+</configure>

eea.volto.policy-5.2/eea/volto/policy/restapi/services/contextnavigation/__init__.py

@@ -0,0 +1 @@
+""" RestAPI context navigation services """

eea.volto.policy-5.2/eea/volto/policy/restapi/services/contextnavigation/configure.zcml

@@ -0,0 +1,20 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    >
+
+  <adapter
+      factory=".get.EEAContextNavigation"
+      name="contextnavigation"
+      />
+
+  <plone:service
+      method="GET"
+      factory=".get.EEAContextNavigationGet"
+      for="zope.interface.Interface"
+      permission="zope2.View"
+      name="@contextnavigation"
+      layer="plone.restapi.interfaces.IPloneRestapiLayer"
+      />
+
+</configure>

eea.volto.policy-5.2/eea/volto/policy/restapi/services/contextnavigation/get.py

@@ -0,0 +1,298 @@
+"""EEA Context Navigation"""
+
+from zope.component import getUtility
+from zope.component import adapter
+from zope.schema.interfaces import IFromUnicode
+from zope.interface import implementer
+from zope.interface import Interface
+from Products.CMFPlone.utils import normalizeString
+from plone.app.layout.navigation.root import getNavigationRoot
+from plone.app.dexterity import _
+from plone.restapi.services.contextnavigation import get as original_get
+from plone.restapi.interfaces import IExpandableElement, IPloneRestapiLayer
+from plone.registry.interfaces import IRegistry
+from plone.restapi import bbb as restapi_bbb
+from plone.restapi.bbb import safe_hasattr
+from plone import schema
+from plone import api
+
+
+class IEEANavigationPortlet(original_get.INavigationPortlet):
+    """Custom schema for navigation portlet"""
+
+    portal_type = schema.Tuple(
+        title=_("Displayed content types"),
+        description=_("The content types that should be shown in the navigati"
+                      "on"),
+        required=False,
+        default=(),
+        missing_value=(),
+        value_type=schema.Choice(
+            source="plone.app.vocabularies.ReallyUserFriendlyTypes"
+        ),
+    )
+
+
+class IEEAContextNavigationSchema(restapi_bbb.INavigationSchema):
+    """Custom schema for context navigation"""
+
+    side_nav_types = schema.Tuple(
+        title=_("Displayed content types within the side navigation"),
+        description=_("The content types that should be shown in the "
+                      "side navigation"),
+        required=False,
+        default=("Document",),
+        missing_value=(),
+        value_type=schema.Choice(
+            source="plone.app.vocabularies.ReallyUserFriendlyTypes"
+        ),
+    )
+
+
+restapi_bbb.INavigationSchema = IEEAContextNavigationSchema
+
+
+def eea_extract_data(_obj_schema, raw_data, prefix):
+    """Custom extract data function for navigation portlet"""
+    obj_schema = IEEANavigationPortlet
+    obj_schema_names = list(obj_schema)
+    data = original_get.Data({})
+    for name in obj_schema_names:
+        field = obj_schema[name]
+        raw_value = raw_data.get(prefix + name, field.default)
+
+        if isinstance(field, schema.Tuple):
+            value = raw_value.split(',') if ',' in raw_value else raw_value
+        else:
+            value = IFromUnicode(field).fromUnicode(raw_value)
+
+        data[name] = value
+
+    return data
+
+
+class EEAContextNavigationQueryBuilder(original_get.QueryBuilder):
+    """Custom QueryBuilder for context navigation"""
+
+    def getSideNavTypes(self, context):
+        """Get the side navigation types"""
+        registry = getUtility(IRegistry)
+        return registry.get("plone.side_nav_types", ())
+
+    def __init__(self, context, data):
+        super().__init__(context, data)
+
+        depth = data.bottomLevel
+
+        if depth == 0:
+            depth = 999
+
+        root = original_get.get_root(context, data.root_path)
+        if root is not None:
+            rootPath = "/".join(root.getPhysicalPath())
+        else:
+            rootPath = getNavigationRoot(context)
+
+        # EEA modification to always use the rootPath for query
+        self.query["path"] = {"query": rootPath, "depth": depth,
+                              "navtree": 1}
+
+        self.query["portal_type"] = data.portal_type or self.getSideNavTypes(
+            context)
+
+        topLevel = data.topLevel
+        if topLevel and topLevel > 0:
+            # EEA modification to use bottomLevel for depth of navtree_start
+            self.query["path"]["navtree_start"] = depth
+
+
+original_get.QueryBuilder = EEAContextNavigationQueryBuilder
+
+
+class EEANavigationPortletRenderer(original_get.NavigationPortletRenderer):
+    """Custom NavigationPortletRenderer for context navigation"""
+
+    def render(self):
+        """Render the navigation portlet"""
+        res = {
+            "title": self.title(),
+            "url": self.heading_link_target(),
+            "has_custom_name": bool(self.hasName()),
+            "items": [],
+            "available": self.available,
+        }
+        if not res["available"]:
+            return res
+
+        if self.include_top():
+            root = self.navigation_root()
+            root_is_portal = self.root_is_portal()
+
+            if root is None:
+                root = self.urltool.getPortalObject()
+                root_is_portal = True
+
+            if safe_hasattr(self.context, "getRemoteUrl"):
+                root_url = root.getRemoteUrl()
+            else:
+                root_url = original_get.get_url(root)
+
+            root_title = "Home" if root_is_portal else \
+                root.pretty_title_or_id()
+            root_type = (
+                "plone-site"
+                if root_is_portal
+                else normalizeString(root.portal_type, context=root)
+            )
+            normalized_id = normalizeString(root.Title(), context=root)
+
+            if root_is_portal:
+                state = ""
+            else:
+                state = api.content.get_state(root)
+
+            res["items"].append(
+                {
+                    "@id": root.absolute_url(),
+                    "description": root.Description() or "",
+                    "href": root_url,
+                    "icon": "",
+                    "is_current": bool(self.root_item_class()),
+                    "is_folderish": True,
+                    "is_in_path": True,
+                    "items": [],
+                    "normalized_id": normalized_id,
+                    "thumb": "",
+                    # set title to side_nav_title if available
+                    "title": getattr(root, "side_nav_title", root_title),
+                    "type": root_type,
+                    "review_state": state,
+                }
+            )
+
+        res["items"].extend(self.createNavTree())
+
+        return res
+
+    def recurse(self, children, level, bottomLevel):
+        """Recurse through the navigation tree"""
+        res = []
+
+        show_thumbs = not self.data.no_thumbs
+        show_icons = not self.data.no_icons
+
+        thumb_scale = self.thumb_scale()
+
+        for node in children:
+            brain = node["item"]
+
+            icon = ""
+
+            if show_icons:
+                if node["portal_type"] == "File":
+                    icon = self.getMimeTypeIcon(node)
+
+            has_thumb = brain.getIcon
+            thumb = ""
+
+            if show_thumbs and has_thumb and thumb_scale:
+                thumb = "{}/@@images/image/{}".format(
+                    node["item"].getURL(), thumb_scale
+                )
+
+            show_children = node["show_children"]
+            item_remote_url = node["getRemoteUrl"]
+            use_remote_url = node["useRemoteUrl"]
+            item_url = node["getURL"]
+            item = {
+                "@id": item_url,
+                "description": node["Description"],
+                "href": item_remote_url if use_remote_url else item_url,
+                "icon": icon,
+                "is_current": node["currentItem"],
+                "is_folderish": node["show_children"],
+                "is_in_path": node["currentParent"],
+                "items": [],
+                "normalized_id": node["normalized_id"],
+                "review_state": node["review_state"] or "",
+                "thumb": thumb,
+                "title": node.get("side_nav_title", node["Title"]),
+                "type": node["normalized_portal_type"],
+            }
+
+            if node.get("nav_title", False):
+                item.update({"title": node["nav_title"]})
+
+            if node.get("side_nav_title", False):
+                item.update({"side_nav_title": node["side_nav_title"]})
+
+            nodechildren = node["children"]
+
+            if (nodechildren and show_children and
+                    ((level <= bottomLevel) or (bottomLevel == 0))):
+                item["items"] = self.recurse(
+                    nodechildren, level=level + 1, bottomLevel=bottomLevel
+                )
+
+            res.append(item)
+
+        return res
+
+
+@implementer(IExpandableElement)
+@adapter(Interface, IPloneRestapiLayer)
+class EEAContextNavigation:
+    """Custom context navigation"""
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, expand=False, prefix="expand.contextnavigation."):
+        result = {
+            "contextnavigation": {
+                "@id": f"{self.context.absolute_url()}/@contextnavigation"
+            }
+        }
+        if not expand:
+            return result
+        print("REQUEST FORM", self.request.form)
+        data = eea_extract_data(
+            IEEANavigationPortlet,
+            self.request.form,
+            prefix)
+        renderer = EEANavigationPortletRenderer(
+            self.context, self.request, data)
+        res = renderer.render()
+        result["contextnavigation"].update(res)
+        return result
+
+    def getNavTree(self):
+        """ getNavTree"""
+        # compatibility method with NavigationPortletRenderer, only for tests
+        return self.__call__(expand=True)["contextnavigation"]
+
+
+class EEAContextNavigationGet(original_get.ContextNavigationGet):
+    """Custom ContextNavigationGet for context navigation"""
+
+    def reply(self):
+        """Reply with context navigation"""
+        navigation = EEAContextNavigation(self.context, self.request)
+        return navigation(expand=True, prefix="expand.contextnavigation.")[
+            "contextnavigation"
+        ]
+
+
+class EEANavtreeStrategy(original_get.NavtreeStrategy):
+    """Custom NavtreeStrategy for context navigation"""
+
+    def decoratorFactory(self, node):
+        """Decorate the navigation tree"""
+        new_node = super().decoratorFactory(node)
+        if getattr(new_node["item"], "side_nav_title", False):
+            new_node["side_nav_title"] = new_node["item"].side_nav_title
+        return new_node
+
+
+# Monkey patch the original NavtreeStrategy
+original_get.NavtreeStrategy = EEANavtreeStrategy

eea.volto.policy-5.2/eea/volto/policy/version.txt

@@ -0,0 +1 @@
+5.2

{eea.volto.policy-5.0 → eea.volto.policy-5.2/eea.volto.policy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: eea.volto.policy
-Version: 5.0
+Version: 5.2
 Summary: An add-on for Plone
 Home-page: https://github.com/eea/eea.volto.policy
 Author: European Environment Agency: IDM2 A-Team
@@ -128,6 +128,20 @@ EEA_ - European Environment Agency (EU)
 Changelog
 =========
 
+5.2 - (2024-08-19)
+---------------------------
+* Feature: Check for permissions when serializing restricted blocks
+  [razvanMiu - refs #273963]
+* Feature: Customized context navigation endpoint to filter portal_type
+  [ichim-david - refs #270999]
+* Fix: Depth of context navigation endpoint by passing depth parameter
+  [ichim-david - refs #270999]
+
+5.1 - (2024-07-22)
+---------------------------
+* Change: Release
+  [avoinea]
+
 5.0 - (2024-06-11)
 ---------------------------
 * Breaking: Requires `plone.volto >= 4.1.0`

{eea.volto.policy-5.0 → eea.volto.policy-5.2}/eea.volto.policy.egg-info/SOURCES.txt

@@ -20,11 +20,13 @@ eea/volto/policy/__init__.py
 eea/volto/policy/configure.zcml
 eea/volto/policy/interfaces.py
 eea/volto/policy/overrides.zcml
+eea/volto/policy/permissions.zcml
 eea/volto/policy/profiles.zcml
 eea/volto/policy/setuphandlers.py
 eea/volto/policy/version.txt
 eea/volto/policy/behaviors/__init__.py
 eea/volto/policy/behaviors/configure.zcml
+eea/volto/policy/behaviors/sidenavigation.py
 eea/volto/policy/browser/__init__.py
 eea/volto/policy/browser/configure.zcml
 eea/volto/policy/browser/teaser.py
@@ -169,8 +171,10 @@ eea/volto/policy/profiles/default/catalog.xml
 eea/volto/policy/profiles/default/contentrules.xml
 eea/volto/policy/profiles/default/metadata.xml
 eea/volto/policy/profiles/default/registry.xml
+eea/volto/policy/profiles/default/registry/side_nav_types.xml
 eea/volto/policy/profiles/uninstall/browserlayer.xml
 eea/volto/policy/restapi/__init__.py
+eea/volto/policy/restapi/blocks.py
 eea/volto/policy/restapi/configure.zcml
 eea/volto/policy/restapi/deserializer/__init__.py
 eea/volto/policy/restapi/deserializer/configure.zcml
@@ -181,6 +185,11 @@ eea/volto/policy/restapi/serializer/__init__.py
 eea/volto/policy/restapi/serializer/configure.zcml
 eea/volto/policy/restapi/serializer/dxfields.py
 eea/volto/policy/restapi/serializer/summary.py
+eea/volto/policy/restapi/services/__init__.py
+eea/volto/policy/restapi/services/configure.zcml
+eea/volto/policy/restapi/services/contextnavigation/__init__.py
+eea/volto/policy/restapi/services/contextnavigation/configure.zcml
+eea/volto/policy/restapi/services/contextnavigation/get.py
 eea/volto/policy/tests/__init__.py
 eea/volto/policy/tests/base.py
 eea/volto/policy/tests/test_doctests.py

eea.volto.policy-5.0/eea/volto/policy/behaviors/configure.zcml

@@ -1,7 +0,0 @@
-<configure
-  xmlns="http://namespaces.zope.org/zope"
-  xmlns:plone="http://namespaces.plone.org/plone"
-  i18n_domain="eea">
-
-
-</configure>

eea.volto.policy-5.0/eea/volto/policy/restapi/configure.zcml

@@ -1,6 +0,0 @@
-<configure xmlns="http://namespaces.zope.org/zope">
-  <include package="plone.restapi" />
-  <include package=".deserializer" />
-  <include package=".serializer" />
-  <include package=".navigation" />
-</configure>

eea.volto.policy-5.0/eea/volto/policy/restapi/serializer/__init__.py

@@ -1,2 +0,0 @@
-""" RestAPI serializer
-"""

eea.volto.policy-5.0/eea/volto/policy/version.txt

@@ -1 +0,0 @@
-5.0