Merge pull request #191 from plone/backport-sort-on-fix

Don't validate sort_on prematurely [backport for Plone 6.1]

Author: davisagli

news/173.bugfix

@@ -0,0 +1 @@
+Don't ignore sort_on values which are not ZCatalog indexes. @davisagli

setup.py

@@ -52,7 +52,6 @@
         "plone.registry",
         "plone.uuid",
         "Products.GenericSetup",
-        "Products.ZCatalog",
         "python-dateutil",
         "Zope",
         "zope.dottedname",

src/plone/app/querystring/queryparser.py

@@ -78,12 +78,9 @@ def parseFormquery(context, formquery, sort_on=None, sort_order=None):
 
     # Add sorting (sort_on and sort_order) to the query
     if sort_on:
-        catalog = getToolByName(context, "portal_catalog")
-        # I get crazy sort_ons like '194' or 'null'.
-        if sort_on in catalog.indexes():
-            query["sort_on"] = sort_on
-            if sort_order:
-                query["sort_order"] = sort_order
+        query["sort_on"] = sort_on
+        if sort_order:
+            query["sort_order"] = sort_order
     return query
 
 

src/plone/app/querystring/registryreader.py

@@ -2,11 +2,8 @@
 from plone.app.querystring.interfaces import IQuerystringRegistryReader
 from plone.base.utils import safe_text
 from plone.i18n.normalizer.interfaces import IIDNormalizer
-from Products.CMFCore.utils import getToolByName
-from Products.ZCTextIndex.interfaces import IZCTextIndex
 from zope.component import getUtility
 from zope.component import queryUtility
-from zope.component.hooks import getSite
 from zope.globalrequest import getRequest
 from zope.i18n import translate
 from zope.i18nmessageid import Message
@@ -117,14 +114,9 @@ def mapOperations(self, values):
 
     def mapSortableIndexes(self, values):
         """Map sortable indexes"""
-        catalog = getToolByName(getSite(), "portal_catalog")._catalog
         sortables = {}
         for key, field in values.get("%s.field" % self.prefix).items():
-            if (
-                field["sortable"]
-                and key in catalog.indexes
-                and not IZCTextIndex.providedBy(catalog.getIndex(key))
-            ):
+            if field["sortable"]:
                 sortables[key] = values.get(f"{self.prefix}.field.{key}")
         values["sortable"] = sortables
         return values

src/plone/app/querystring/tests/testQueryBuilder.py

@@ -411,6 +411,10 @@ def test_munge_search_term(self):
         for _in, _out in search_term_tests:
             self.assertEqual(munge_search_term(_in), _out)
 
+    def test_query_builder_unknown_sort(self):
+        results = self.querybuilder(query=self.query, sort_on="unknown")
+        self.assertEqual(len(results), 1)
+
 
 class TestQuerybuilderResultTypes(unittest.TestCase):
     layer = TEST_PROFILE_PLONEAPPQUERYSTRING_INTEGRATION_TESTING

src/plone/app/querystring/tests/testQueryParser.py

@@ -191,7 +191,14 @@ def test_sort_on_unknown(self):
             sort_on="unknown",
             sort_order="reverse",
         )
-        self.assertEqual(parsed, {"Title": {"query": "Welcome to Plone"}})
+        self.assertEqual(
+            parsed,
+            {
+                "Title": {"query": "Welcome to Plone"},
+                "sort_on": "unknown",
+                "sort_order": "reverse",
+            },
+        )
 
     def test_path_explicit(self):
         data = {