Enable global Control Panel search via plone.restapi searchable text - 1981

news/1981.bugfix.rst

@@ -0,0 +1 @@
+Added a single Control Panel API endpoint exposing searchable text for global settings search. Fixes #1981.

src/plone/restapi/controlpanels/__init__.py

@@ -1,8 +1,15 @@
+from plone.dexterity.interfaces import IDexterityFTI
+from plone.restapi.controlpanels.interfaces import IContentRulesControlpanel
 from plone.restapi.controlpanels.interfaces import IControlpanel
+from plone.restapi.controlpanels.interfaces import IDexterityTypesControlpanel
 from Products.CMFCore.utils import getToolByName
+from zope.component import getAllUtilitiesRegisteredFor
+from zope.component import queryMultiAdapter
 from zope.interface import implementer
 from zope.publisher.interfaces import NotFound
 
+import zope
+
 
 @implementer(IControlpanel)
 class RegistryConfigletPanel:
@@ -38,6 +45,42 @@ def __init__(self, context, request):
             self.title = self.configlet["title"]
             self.group = self._get_group_title()
 
+    def get_searchable_text(self):
+
+        text_parts = []
+
+        if self.title:
+            text_parts.append(self.title)
+
+        if self.schema is not None:
+            for name, field in zope.schema.getFields(self.schema).items():
+                if field.title:
+                    text_parts.append(field.title)
+        else:
+            types_list = []
+
+            if IDexterityTypesControlpanel.providedBy(self):
+                ftis = getAllUtilitiesRegisteredFor(IDexterityFTI)
+                for fti in ftis:
+                    if fti.Title():
+                        text_parts.append(fti.Title())
+
+            elif IContentRulesControlpanel.providedBy(self):
+                cpanel = queryMultiAdapter(
+                    (self.context, self.request), name="rules-controlpanel"
+                )
+                if cpanel:
+                    registered_rules = cpanel.registeredRules()
+                    for rule in registered_rules:
+                        if isinstance(rule, dict):
+                            if rule.get("title"):
+                                text_parts.append(rule["title"])
+
+            if types_list:
+                text_parts.extend(types_list)
+
+        return [text for text in text_parts if text]
+
     def add(self, names):
         raise NotFound(self.context, names, self.request)
 

src/plone/restapi/controlpanels/interfaces.py

@@ -25,6 +25,13 @@ def update(names):
     def delete(names):
         """Remove controlpanel children by names"""
 
+    def get_searchable_text():
+        """Return searchable text for this controlpannel.
+
+        Schema-based control panels return text from field titles and descriptions.
+        Other control panels can return custom text.
+        """
+
 
 class IDexterityTypesControlpanel(IControlpanel):
     """Dexterity Types Control panel"""

src/plone/restapi/serializer/controlpanels/__init__.py

@@ -34,6 +34,7 @@ def __call__(self):
             ),
             "title": self.controlpanel.title,
             "group": self.controlpanel.group,
+            "searchable_text": self.controlpanel.get_searchable_text(),
         }