Query string token search

news/106.feature

@@ -0,0 +1 @@
+include vocabulary term token in termlist used to configure the querystring search [jackahl] (#106)

news/108.feature

@@ -0,0 +1 @@
+add lookup to process vocabulary tokens being used as query parameters. Using values is also still supported. [jackahl]

plone/app/querystring/configure.zcml

@@ -63,4 +63,8 @@
     component=".querymodifiers.modify_query_to_enforce_navigation_root"
     name="1000"
     />
+  <utility
+    component=".querymodifiers.vocabulary_value_look_up"
+    name="1001"
+  />
 </configure>

plone/app/querystring/querymodifiers.py

@@ -1,6 +1,9 @@
 # -*- coding: utf-8 -*-
 from plone.app.querystring.interfaces import IQueryModifier
 from zope.interface import provider
+from zope.component import getUtility
+from plone.registry.interfaces import IRegistry
+from zope.schema.interfaces import IVocabularyFactory
 
 
 @provider(IQueryModifier)
@@ -24,4 +27,49 @@ def modify_query_to_enforce_navigation_root(query):
             'o': 'plone.app.querystring.operation.string.path',
             'v': '/',
         })
+
+    return query
+
+@provider(IQueryModifier)
+def vocabulary_value_look_up(query):
+    registry = getUtility(IRegistry)
+
+    for query_param in query:
+        query_field_name = query_param.get('i')
+        query_vocabulary_name = registry.get(f"plone.app.querystring.field.{query_field_name}.vocabulary")
+
+        if query_vocabulary_name:
+
+            query_terms = query_param.get('v')
+            factory = getUtility(IVocabularyFactory, query_vocabulary_name)
+            vocabulary = factory(None)
+            if type(query_terms) is list:
+                new_terms = []
+                for query_term in query_terms:
+                    try:
+                        vocabulary_term = vocabulary.getTerm(query_term)
+                        new_terms.append(query_term)
+
+                    except:
+                        for term in vocabulary:
+                            if term.token == query_term:
+                                new_terms.append(term.value)
+                                break
+                query_param['v']= new_terms
+            elif type(query_terms) is str:
+                try:
+                    vocabulary_term = vocabulary.getTerm(query_terms)
+                except:
+                    for term in vocabulary:
+                        if term.token == query_terms:
+                            query_terms=term.value
+                            break
+            query_param['v']= query_terms
+
+        query_vocabulary_name = None
+
     return query
+
+
+
+

plone/app/querystring/registryreader.py

@@ -93,13 +93,13 @@ def getVocabularyValues(self, values):
                     title = translate(item.title, context=self.request)
                 else:
                     title = item.title
-                translated.append((title, item.value))
+                translated.append((title, item.value, item.token))
             translated = sorted(
                 translated,
                 key=lambda x: normalizeString(safe_unicode(x[0]))
             )
-            for (title, value) in translated:
-                field['values'][value] = {'title': title}
+            for (title, value, token) in translated:
+                field['values'][value] = {'title': title, 'token': token}
 
         return values
 

plone/app/querystring/tests/testRegistryReader.py

@@ -77,7 +77,7 @@ def test_get_vocabularies(self):
         result = reader.getVocabularyValues(result)
         vocabulary_result = result.get(
             'plone.app.querystring.field.reviewState.values')
-        self.assertEqual(vocabulary_result, {'foo': {'title': u'bar'}})
+        self.assertEqual(vocabulary_result, {'foo': {'title': u'bar', 'token': 'foo'}})
 
     def test_map_operations_clean(self):
         """tests if mapOperations is getting all operators correctly"""