Add endpoint to access block_types indexer

src/plone/volto/configure.zcml

@@ -10,11 +10,18 @@
 
   <i18n:registerTranslations directory="locales" />
 
+  <include
+      package="Products.CMFCore"
+      file="permissions.zcml"
+      />
+
   <include file="dependencies.zcml" />
+  <include file="permissions.zcml" />
 
   <include package=".behaviors" />
   <include package=".browser" />
   <include package=".indexers" />
+  <include package=".services" />
 
   <include file="profiles.zcml" />
   <include file="patches.zcml" />

src/plone/volto/indexers/indexers.py

@@ -4,6 +4,8 @@
 from plone.restapi.blocks import visit_blocks
 from plone.volto.behaviors.preview import IPreview
 
+import collections
+
 
 @indexer(IPreview)
 def hasPreviewImage(obj):
@@ -40,9 +42,9 @@ def image_field_indexer(obj):
 def block_types_indexer(obj):
     """Indexer for all block types included in a page."""
     obj = aq_base(obj)
-    block_types = set()
+    block_types = collections.Counter()
     for block in visit_blocks(obj, obj.blocks):
         block_type = block.get("@type")
         if block_type:
-            block_types.add(block_type)
+            block_types[block_type] += 1
     return block_types

src/plone/volto/permissions.zcml

@@ -0,0 +1,8 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <permission
+      id="plone.volto.service.BlockTypes"
+      title="Plone Site Setup: Block Types"
+      />
+
+</configure>

src/plone/volto/profiles/default/catalog.xml

@@ -4,6 +4,7 @@
   <column value="head_title" />
   <column value="hasPreviewImage" />
   <column value="image_field" />
+  <column value="block_types" />
   <index meta_type="KeywordIndex"
          name="block_types"
   >

src/plone/volto/profiles/default/metadata.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <metadata>
-  <version>1019</version>
+  <version>1020</version>
   <dependencies>
     <dependency>profile-plone.restapi:blocks</dependency>
   </dependencies>

src/plone/volto/profiles/default/rolemap.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rolemap>
+  <permissions>
+    <permission acquire="True"
+                name="Plone Site Setup: Block Types"
+    >
+      <role name="Manager" />
+      <role name="Site Administrator" />
+    </permission>
+  </permissions>
+</rolemap>

src/plone/volto/services/blocktypes/configure.zcml

@@ -0,0 +1,15 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    xmlns:zcml="http://namespaces.zope.org/zcml"
+    >
+
+  <plone:service
+      method="GET"
+      factory=".get.BlockTypesGet"
+      for="zope.interface.Interface"
+      permission="plone.volto.service.BlockTypes"
+      name="@blocktypes"
+      />
+
+</configure>

src/plone/volto/services/blocktypes/get.py

@@ -0,0 +1,56 @@
+from plone import api
+from plone.restapi.behaviors import IBlocks
+from plone.restapi.services import Service
+from zope.interface import implementer
+from zope.publisher.interfaces import IPublishTraverse
+
+import collections
+
+
+@implementer(IPublishTraverse)
+class BlockTypesGet(Service):
+    def __init__(self, context, request):
+        super().__init__(context, request)
+        self.block_type = None
+
+    def publishTraverse(self, request, name):
+        self.block_type = name
+        return self
+
+    def reply(self):
+        catalog = api.portal.get_tool(name="portal_catalog")
+        request_body = self.request.form
+        type = self.block_type
+
+        query = {
+            "object_provides": IBlocks.__identifier__,
+        }
+
+        if request_body.get("path"):
+            query["path"] = request_body["path"]
+
+        if type:
+            result = []
+            query["block_types"] = self.block_type
+            brains = catalog.unrestrictedSearchResults(**query)
+
+            for brain in brains:
+                result.append(
+                    {
+                        "@id": brain.getURL(),
+                        "title": brain.Title,
+                        "count": brain.block_types[self.block_type],
+                    }
+                )
+        else:
+            result = {}
+            brains = catalog.unrestrictedSearchResults(**query)
+            block_types_total = collections.Counter()
+
+            for brain in brains:
+                block_types_total.update(brain.block_types)
+
+            for block_type, count in block_types_total.items():
+                result[block_type] = count
+
+        return result

src/plone/volto/services/configure.zcml

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

src/plone/volto/upgrades.py

@@ -190,3 +190,16 @@ def update_robots_txt(context):
         logger.info(
             "Ignoring plone.robots_txt registry as it was modified in this portal."
         )
+
+
+def reindex_block_types(context):
+    catalog = getToolByName(context, "portal_catalog")
+    brains = catalog(object_provides="plone.restapi.behaviors.IBlocks")
+    total = len(brains)
+    for index, brain in enumerate(brains):
+        obj = brain.getObject()
+        obj.reindexObject(idxs=["block_types"], update_metadata=0)
+        logger.info("Reindexing object %s.", brain.getPath())
+        if index % 250 == 0:
+            logger.info(f"Reindexed {index}/{total} objects")
+            transaction.commit()

src/plone/volto/upgrades.zcml

@@ -96,4 +96,14 @@
         handler=".upgrades.update_robots_txt"
         />
   </genericsetup:upgradeSteps>
+  <genericsetup:upgradeSteps
+      profile="plone.volto:default"
+      source="1019"
+      destination="1020"
+      >
+    <genericsetup:upgradeStep
+        title="Update robots_txt setting for Volto"
+        handler=".upgrades.reindex_block_types"
+        />
+  </genericsetup:upgradeSteps>
 </configure>