imio.smartweb.common 1.2.12__tar.gz → 1.2.13__tar.gz

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/CHANGES.rst

@@ -2,6 +2,25 @@ Changelog
 =========
 
 
+1.2.13 (2024-05-24)
+-------------------
+
+- WEB-4088 : Cover use case for sending data in odwb for a staging environment
+  [boulch]
+
+- Ensure translation of vocabularies when used with `AjaxSelectFieldWidget`
+  [laulaz]
+
+- Remove useless `container_uid` from `search-filters` results
+  [laulaz]
+
+- WEB-3864 : Ensure that a taxonomy term that is deleted is not used anywhere
+  [boulch]
+
+- WEB-3862 : Unpatch (restore original) eea.facetednavigation jquery
+  [laulaz]
+
+
 1.2.12 (2024-05-06)
 -------------------
 

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: imio.smartweb.common
-Version: 1.2.12
+Version: 1.2.13
 Summary: Common utilities, vocabularies, taxonomies for imio.smartweb & co products
 Home-page: https://github.com/imio/imio.smartweb.common
 Author: iMio
@@ -135,6 +135,25 @@ Changelog
 =========
 
 
+1.2.13 (2024-05-24)
+-------------------
+
+- WEB-4088 : Cover use case for sending data in odwb for a staging environment
+  [boulch]
+
+- Ensure translation of vocabularies when used with `AjaxSelectFieldWidget`
+  [laulaz]
+
+- Remove useless `container_uid` from `search-filters` results
+  [laulaz]
+
+- WEB-3864 : Ensure that a taxonomy term that is deleted is not used anywhere
+  [boulch]
+
+- WEB-3862 : Unpatch (restore original) eea.facetednavigation jquery
+  [laulaz]
+
+
 1.2.12 (2024-05-06)
 -------------------
 

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/setup.py

@@ -16,7 +16,7 @@ long_description = "\n\n".join(
 
 setup(
     name="imio.smartweb.common",
-    version="1.2.12",
+    version="1.2.13",
     description="Common utilities, vocabularies, taxonomies for imio.smartweb & co products",
     long_description=long_description,
     # Get more from https://pypi.org/classifiers/
@@ -66,6 +66,7 @@ setup(
         "eea.facetednavigation",
         "imio.gdpr",
         "collective.privacy",
+        "collective.taxonomy",
         "iaweb.privacy",
         "imio.smartweb.locales",
         "more-itertools",

imio.smartweb.common-1.2.13/src/imio/smartweb/common/browser/collective_taxonomy_controlpanel.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+from collective.taxonomy.interfaces import ITaxonomy
+from collective.taxonomy.jsonimpl import ImportJson as baseImportJson
+from imio.smartweb.locales import SmartwebMessageFactory as _
+from plone import api
+from zope.component import queryUtility
+from zope.i18n import translate
+
+import json
+
+
+class ImportJson(baseImportJson):
+    """Update taxonomy using json data."""
+
+    def __call__(self):
+        request = self.request
+        if request.method == "POST":
+            data = json.loads(request.get("BODY", ""))
+            taxonomy = queryUtility(ITaxonomy, name=data["taxonomy"])
+            languages = data["languages"]
+            items_to_check = []
+            nodes = data["tree"]["subnodes"]
+            for language in languages:
+                for node in nodes:
+                    if node["translations"].get(language):
+                        items_to_check.append(
+                            {node["key"]: node["translations"][language]}
+                        )
+                ids_remaining = [key for data in items_to_check for key in data.keys()]
+                if not taxonomy.inverted_data.get(language):
+                    continue
+                initial_taxonomy_ids = [k for k in taxonomy.inverted_data[language]]
+                for id in initial_taxonomy_ids:
+                    if id in ids_remaining:
+                        continue
+                    # This is a removed term
+                    catalog = api.portal.get_tool("portal_catalog")
+                    brains = catalog.searchResults(
+                        object_provides=taxonomy.getGeneratedName()
+                    )
+                    for brain in brains:
+                        index_key = f"taxonomy_{taxonomy.getShortName()}"
+                        if hasattr(brain, index_key) and id in getattr(
+                            brain, index_key
+                        ):
+                            obj = brain.getObject()
+                            here = obj.absolute_url()
+                            term_title = taxonomy.translate(
+                                id, context=obj, target_language=language
+                            )
+                            return json.dumps(
+                                {
+                                    "status": "error",
+                                    "message": translate(
+                                        _(
+                                            f'Term "{term_title}" can\'t be removed because it is used (at least) here : {here}'
+                                        ),
+                                        context=request,
+                                    ),
+                                }
+                            )
+        return super(ImportJson, self).__call__()

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/browser/configure.zcml

@@ -73,6 +73,14 @@
       layer="imio.smartweb.common.interfaces.IImioSmartwebCommonLayer"
       />
 
+  <browser:page
+      name="getVocabulary"
+      for="*"
+      class=".vocabulary.TranslatedVocabularyView"
+      permission="zope2.View"
+      layer="imio.smartweb.common.interfaces.IImioSmartwebCommonLayer"
+      />
+
   <browser:page
       for="plone.app.layout.navigation.interfaces.INavigationRoot"
       name="image_scale"
@@ -82,4 +90,12 @@
       allowed_attributes="scale tag"
       />
 
+  <browser:page
+      name="taxonomy-import"
+      for="Products.CMFCore.interfaces.ISiteRoot"
+      class=".collective_taxonomy_controlpanel.ImportJson"
+      permission="collective.taxonomy.ManageTaxonomies"
+      layer="imio.smartweb.common.interfaces.IImioSmartwebCommonLayer"
+      />
+
 </configure>

imio.smartweb.common-1.2.13/src/imio/smartweb/common/browser/static/smartweb-common-view-compiled.css

@@ -0,0 +1 @@
+.show-on-focus{border-radius:5px;box-shadow:0 0 2.9px rgba(0,0,0,.028),0 0 8.1px rgba(0,0,0,.04),0 0 19.6px rgba(0,0,0,.052),0 0 65px rgba(0,0,0,.08);color:#000!important;display:inline-block;font-weight:500;left:10px;position:absolute!important;text-decoration:none;top:10px}.show-on-focus:not(:focus){clip:rect(0,0,0,0);border-width:0;height:1px!important;margin:-1px;overflow:hidden;padding:0!important;white-space:nowrap;width:1px!important}.show-on-focus:focus{background-color:#fff!important;padding:1rem;z-index:999}.show-on-focus:hover{text-decoration:underline}#smartweb-footer{position:relative}#smartweb-footer .show-on-focus{color:#000!important}form .form-text{margin-bottom:.3em;margin-top:-.4em}#cookies-form #form-widgets-all_basic_cookies,#cookies-form .form-text p,#cookies-form label span.required{display:none}#gdpr-consent-banner{background:orange;display:none;left:0;padding:5px;position:fixed;top:0;width:100%;z-index:999999}.faceted-select-widget.faceted-zero-count-hidden .faceted-select-item-disabled{display:none}

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/browser/static/src/view.less

@@ -8,7 +8,7 @@
     border-radius: 5px;
     box-shadow: 0px 0px 2.9px rgba(0, 0, 0, 0.028), 0px 0px 8.1px rgba(0, 0, 0, 0.04), 0px 0px 19.6px rgba(0, 0, 0, 0.052), 0px 0px 65px rgba(0, 0, 0, 0.08);
     font-weight: 500;
-
+    color: #000 !important;
     &:not(:focus) {
         width: 1px !important;
         height: 1px !important;
@@ -21,7 +21,7 @@
     }
 
     &:focus {
-        background-color: #FFFFFF;
+        background-color: #FFFFFF!important;
         padding: 1rem;
         z-index: 999;
     }
@@ -31,6 +31,13 @@
     }
 }
 
+#smartweb-footer {
+    position: relative;
+    .show-on-focus {
+        color: #000!important;
+    }
+}
+
 // Fields description position between title and input.
 form .form-text {
     margin-top: -0.4em;

imio.smartweb.common-1.2.13/src/imio/smartweb/common/browser/vocabulary.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+from imio.smartweb.locales import SmartwebMessageFactory as _
+from plone import api
+from plone.app.content.browser.vocabulary import VocabularyView
+from plone.app.content.utils import json_dumps
+from plone.app.content.utils import json_loads
+from zope.i18n import translate
+
+
+class TranslatedVocabularyView(VocabularyView):
+
+    def __call__(self):
+        """
+        Translate texts in JSON response
+        `@getVocabulary` does not do it and returns English values
+        """
+        result = super(TranslatedVocabularyView, self).__call__()
+        json = json_loads(result)
+        if int(json.get("total", 0)) == 0:
+            return result
+        lang = api.portal.get_current_language()[:2]
+        for item in json["results"]:
+            if "text" in item:
+                item["text"] = translate(_(item["text"]), target_language=lang)
+        return json_dumps(json)

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/interfaces.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 from collective.privacy.interfaces import ICollectivePrivacyLayer
+from collective.taxonomy.interfaces import IBrowserLayer
 from imio.smartweb.locales import SmartwebMessageFactory as _
 from plone import schema
 from plone.app.z3cform.interfaces import IPloneFormLayer
@@ -10,7 +11,7 @@ from zope.interface import Interface
 
 
 class IImioSmartwebCommonLayer(
-    IDefaultPloneLayer, IPloneFormLayer, ICollectivePrivacyLayer
+    IBrowserLayer, IDefaultPloneLayer, IPloneFormLayer, ICollectivePrivacyLayer
 ):
     """Marker interface that defines a browser layer."""
 

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/profiles/default/metadata.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <metadata>
-  <version>1026</version>
+  <version>1029</version>
   <dependencies>
     <dependency>profile-plone.restapi:default</dependency>
     <dependency>profile-eea.facetednavigation:default</dependency>

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/profiles/default/registry.xml

@@ -54,10 +54,6 @@
     <value key="load_defer">False</value>
   </records>
 
-  <records prefix="plone.bundles/faceted.jquery"
-           interface='Products.CMFPlone.interfaces.IBundleRegistry'>
-    <value key="jscompilation">++plone++imio.smartweb.common/patched.web3862.eea.faceted-jquery.min.js</value>
-  </records>
 
   <!-- TinyMCE custom configuration -->
 
@@ -1080,4 +1076,14 @@
     <value>False</value>
   </record>
 
+  <record name="imio.smartweb.common.activate_sending_data_to_odwb_for_staging">
+    <field type="plone.registry.field.Bool">
+      <title>Activate sending data to odwb for staging</title>
+      <description>Be careful, it must be existing an odwb table prefixing with staging and naming like prod table. Also, smartweb registry keys (odwb pushkey) must be respect.</description>
+      <required>False</required>
+    </field>
+    <value>False</value>
+  </record>
+
+
 </registry>

imio.smartweb.common-1.2.13/src/imio/smartweb/common/profiles/testing/catalog.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<object name="portal_catalog">
+
+  <column value="local_category"/>
+  <column value="local_category_nl"/>
+  <column value="local_category_de"/>
+  <column value="local_category_en"/>
+
+</object>

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/profiles/testing/metadata.xml

@@ -2,5 +2,6 @@
 <metadata>
   <dependencies>
     <dependency>profile-imio.smartweb.common:default</dependency>
+    <dependency>profile-collective.taxonomy:examples</dependency>
   </dependencies>
 </metadata>

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/profiles/testing/types/Document.xml

@@ -5,6 +5,7 @@
     i18n:domain="plone">
 
     <property name="behaviors" purge="false">
+      <element value="collective.taxonomy.generated.test"/>
       <element value="imio.smartweb.iam"/>
       <element value="imio.smartweb.topics"/>
       <element value="plone.leadimage"/>

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/rest/search_filters.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 from imio.smartweb.common.config import VOCABULARIES_MAPPING
+from imio.smartweb.common.rest.utils import get_restapi_query_lang
 from imio.smartweb.common.utils import get_term_from_vocabulary
 from operator import itemgetter
 from plone.restapi.search.handler import SearchHandler
@@ -13,6 +14,7 @@ from zope.component import getMultiAdapter
 
 # we don't need some brains metadata to construct search filters
 EXCLUDED_METADATA = [
+    "container_uid",
     "effective",
     "end",
     "has_leadimage",
@@ -65,6 +67,9 @@ class SearchFiltersHandler(SearchHandler):
         if not isinstance(metadatas, list):
             metadatas = [metadatas]
 
+        lang = get_restapi_query_lang(query)
+        local_categories_trans = {}
+
         metadatas = list(set(metadatas) - set(EXCLUDED_METADATA))
         filters = {metadata: set() for metadata in metadatas}
         for brain in brains:
@@ -72,11 +77,14 @@ class SearchFiltersHandler(SearchHandler):
                 value = getattr(brain, metadata, None)
                 if not value:
                     continue
-                if isinstance(value, list) or isinstance(value, tuple):
-                    for v in value:
-                        filters[metadata].add(v)
-                else:
-                    filters[metadata].add(value)
+                if not isinstance(value, (list, tuple)):
+                    value = [value]
+                for v in value:
+                    filters[metadata].add(v)
+                    if metadata == "local_category":
+                        local_categories_trans[v] = getattr(
+                            brain, f"{metadata}_{lang}", v
+                        )
 
         results = {}
         for metadata, values in filters.items():
@@ -91,8 +99,12 @@ class SearchFiltersHandler(SearchHandler):
                     term = serializer()
                     term["title"] = json_compatible(title)  # needed for translations
                     results[metadata].append(term)
-                    results[metadata].sort(key=itemgetter("title"))
+            elif metadata == "local_category":
+                results[metadata] = [
+                    {"token": v, "title": local_categories_trans[v]} for v in values
+                ]
             else:
-                results[metadata] = [{"token": v, "title": v} for v in sorted(values)]
+                results[metadata] = [{"token": v, "title": v} for v in values]
+            results[metadata].sort(key=itemgetter("title"))
 
         return results

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/testing.py

@@ -26,7 +26,7 @@ class ImioSmartwebCommonLayer(PloneSandboxLayer):
         import plone.restapi
 
         self.loadZCML(package=plone.restapi)
-        self.loadZCML(package=imio.smartweb.common)
+        self.loadZCML(package=imio.smartweb.common, name="testing.zcml")
 
     def setUpPloneSite(self, portal):
         api.user.create(email="test@imio.be", username="test")

imio.smartweb.common-1.2.13/src/imio/smartweb/common/testing.zcml

@@ -0,0 +1,8 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope">
+
+  <include package="collective.taxonomy" file="testing.zcml" />
+
+  <include file="configure.zcml" />
+
+</configure>

{imio.smartweb.common-1.2.12 → imio.smartweb.common-1.2.13}/src/imio/smartweb/common/tests/test_rest.py

@@ -31,6 +31,10 @@ class TestREST(unittest.TestCase):
             title="Doc 1",
         )
         self.doc1.topics = ["agriculture"]
+        self.doc1.local_category = "Titre FR"
+        self.doc1.local_category_nl = "NL title"
+        self.doc1.local_category_de = "DE title"
+        self.doc1.local_category_en = "EN title"
         api.content.transition(self.doc1, "publish")
 
         self.doc2 = api.content.create(
@@ -100,11 +104,31 @@ class TestREST(unittest.TestCase):
             ],
         )
 
+        query = {
+            "portal_type": "Document",
+            "metadata_fields": "local_category",
+        }
+        response = self.api_session.get("/@search-filters", params=query)
+        json = response.json()
+        self.assertEqual(
+            json["local_category"],
+            [{"title": "Titre FR", "token": "Titre FR"}],
+        )
+        query["translated_in_nl"] = 1
+        response = self.api_session.get("/@search-filters", params=query)
+        json = response.json()
+        self.assertEqual(
+            json["local_category"],
+            [{"title": "NL title", "token": "Titre FR"}],
+        )
+        del query["translated_in_nl"]
+
         query = {
             "portal_type": "Event",
             "metadata_fields": [
                 "iam",
                 "topics",
+                "container_uid",
                 "effective",
                 "end",
                 "has_leadimage",
@@ -114,6 +138,7 @@ class TestREST(unittest.TestCase):
         }
         response = self.api_session.get("/@search-filters", params=query)
         json = response.json()
+        self.assertNotIn("container_uid", json)
         self.assertNotIn("effective", json)
         self.assertNotIn("end", json)
         self.assertNotIn("has_leadimage", json)

imio.smartweb.common-1.2.13/src/imio/smartweb/common/tests/test_taxonomy.py

@@ -0,0 +1,140 @@
+# -*- coding: utf-8 -*-
+
+from imio.smartweb.common.testing import IMIO_SMARTWEB_COMMON_FUNCTIONAL_TESTING
+from plone import api
+from plone.app.testing import setRoles
+from plone.app.testing import TEST_USER_ID
+from plone.app.testing.interfaces import SITE_OWNER_NAME
+from plone.app.testing.interfaces import SITE_OWNER_PASSWORD
+from plone.testing.z2 import Browser
+from transaction import commit
+
+import json
+import unittest
+
+
+class TestTaxonomy(unittest.TestCase):
+    layer = IMIO_SMARTWEB_COMMON_FUNCTIONAL_TESTING
+
+    def setUp(self):
+        """Custom shared utility setup for tests"""
+        self.request = self.layer["request"]
+        self.portal = self.layer["portal"]
+        setRoles(self.portal, TEST_USER_ID, ["Manager"])
+        self.browser = Browser(self.layer["app"])
+        self.browser.handleErrors = False
+        self.browser.addHeader(
+            "Authorization",
+            "Basic {0}:{1}".format(SITE_OWNER_NAME, SITE_OWNER_PASSWORD),
+        )
+        commit()
+        self.page = api.content.create(
+            container=self.portal,
+            type="Document",
+            title="Test page",
+        )
+
+    def test_removing_unused_taxonomy_term(self):
+        body_data = {
+            "languages": ["fr", "en", "nl", "ru", "da", "de"],
+            "tree": {
+                "key": "0",
+                "title": "Test vocabulary",
+                "subnodes": [
+                    {
+                        "key": "1",
+                        "translations": {
+                            "da": "Informationsvidenskab",
+                            "de": "Informatik",
+                            "en": "Information Science",
+                            "ru": "Информатику",
+                        },
+                        "subnodes": [
+                            {
+                                "key": "3",
+                                "translations": {"da": "Kronologi", "en": "Chronology"},
+                                "subnodes": [],
+                            }
+                        ],
+                    }
+                ],
+                "default_language": "da",
+            },
+            "taxonomy": "collective.taxonomy.test",
+        }
+        json_str = json.dumps(body_data)
+        bytes_data = json_str.encode("utf-8")
+        self.request.set("BODY", bytes_data)
+        self.request.method = "POST"
+        result = self.portal.restrictedTraverse("@@taxonomy-import")()
+        self.assertEqual(
+            result,
+            '{"status": "info", "message": "Your taxonomy has been saved with success."}',
+        )
+
+    def test_removing_used_taxonomy_term(self):
+        self.page.taxonomy_test = ["1", "2"]
+        body_data = {
+            "languages": ["fr", "en", "nl", "ru", "da", "de"],
+            "tree": {
+                "key": "0",
+                "title": "Test vocabulary",
+                "subnodes": [
+                    {
+                        "key": "1",
+                        "translations": {
+                            "da": "Informationsvidenskab",
+                            "de": "Informatik",
+                            "en": "Information Science",
+                            "ru": "Информатику",
+                        },
+                        "subnodes": [
+                            {
+                                "key": "3",
+                                "translations": {"da": "Kronologi", "en": "Chronology"},
+                                "subnodes": [],
+                            }
+                        ],
+                    }
+                ],
+                "default_language": "da",
+            },
+            "taxonomy": "collective.taxonomy.test",
+        }
+        json_str = json.dumps(body_data)
+        bytes_data = json_str.encode("utf-8")
+        self.request.set("BODY", bytes_data)
+        self.request.method = "POST"
+        result = self.portal.restrictedTraverse("@@taxonomy-import")()
+        self.assertEqual(
+            result,
+            '{"status": "error", "message": "Term \\"Information Science \\u00bb Book Collecting\\" can\'t be removed because it is used (at least) here : http://nohost/plone/test-page"}',
+        )
+
+    def test_removing_used_parent_taxonomy_term(self):
+        self.page.taxonomy_test = ["2"]
+        self.page.reindexObject()
+        catalog = api.portal.get_tool("portal_catalog")
+        brain = api.content.find(UID=self.page.UID())[0]
+        indexes = catalog.getIndexDataForRID(brain.getRID())
+        index = indexes.get("taxonomy_test")
+        self.assertListEqual(sorted(index), ["1", "2"])
+        body_data = {
+            "languages": ["fr", "en", "nl", "ru", "da", "de"],
+            "tree": {
+                "key": "0",
+                "title": "Test vocabulary",
+                "subnodes": [],
+                "default_language": "da",
+            },
+            "taxonomy": "collective.taxonomy.test",
+        }
+        json_str = json.dumps(body_data)
+        bytes_data = json_str.encode("utf-8")
+        self.request.set("BODY", bytes_data)
+        self.request.method = "POST"
+        result = self.portal.restrictedTraverse("@@taxonomy-import")()
+        self.assertEqual(
+            result,
+            '{"status": "error", "message": "Term \\"Information Science\\" can\'t be removed because it is used (at least) here : http://nohost/plone/test-page"}',
+        )

imio.smartweb.common-1.2.13/src/imio/smartweb/common/tests/test_vocabulary.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+
+from imio.smartweb.common.testing import IMIO_SMARTWEB_COMMON_INTEGRATION_TESTING
+from plone import api
+from plone.app.testing import setRoles
+from plone.app.testing import TEST_USER_ID
+from unittest.mock import patch
+from zope.component import queryMultiAdapter
+
+import json
+import unittest
+
+
+class TestVocabulary(unittest.TestCase):
+    layer = IMIO_SMARTWEB_COMMON_INTEGRATION_TESTING
+
+    def setUp(self):
+        """Custom shared utility setup for tests"""
+        self.request = self.layer["request"]
+        self.portal = self.layer["portal"]
+        setRoles(self.portal, TEST_USER_ID, ["Manager"])
+        self.document = api.content.create(
+            container=self.portal,
+            type="Document",
+            title="My Doc",
+        )
+
+    def test_getvocabulary(self):
+        self.request.form = {
+            "name": "imio.smartweb.vocabulary.Topics",
+            "field": "topics",
+        }
+        view = queryMultiAdapter((self.document, self.request), name="getVocabulary")
+        result = json.loads(view())
+        self.assertEqual(result["results"][0]["id"], "entertainment")
+        self.assertEqual(result["results"][0]["text"], "Entertainment")
+        with patch("plone.api.portal.get_current_language", return_value="fr"):
+            view = queryMultiAdapter(
+                (self.document, self.request), name="getVocabulary"
+            )
+            result = json.loads(view())
+            self.assertEqual(result["results"][0]["id"], "entertainment")
+            self.assertEqual(
+                result["results"][0]["text"], "Activités et divertissement"
+            )