Add Keywordmanager utility, services & controlpanel

backend/pyproject.toml

@@ -31,6 +31,7 @@ dependencies = [
     "plone.api",
     "plone.restapi",
     "plone.volto",
+    "Levenshtein"
 ]
 
 [project.optional-dependencies]
@@ -182,4 +183,4 @@ branch = true
 parallel = true
 omit = [
   "src/kitconcept/keywordmanager/locales/*.py",
-]
+]

backend/src/kitconcept/keywordmanager/config.py

@@ -0,0 +1,22 @@
+MANAGE_KEYWORDS_PERMISSION = "Manage Keywords"
+
+# Meta type of the keyword indexes. If you're one of those crazy people that use
+# custom indexes, you'll want to update this.
+META_TYPE = "KeywordIndex"
+
+# indexes of META_TYPE we know we don't want to manage, because bad things(tm)
+# will happen
+IGNORE_INDEXES = [
+    "object_provides",
+    "allowedRolesAndUsers",
+    "getRawRelatedItems",
+    "getEventType",
+    "block_types",
+]
+
+# A list of indexes that should always be reindexed when merging or deleting
+# keywords on objects. Most people won't need this.
+ALWAYS_REINDEX = (
+    # 'Subject',
+    "SearchableText",
+)

backend/src/kitconcept/keywordmanager/configure.zcml

@@ -11,11 +11,14 @@
       file="permissions.zcml"
       />
 
-
   <include file="dependencies.zcml" />
   <include file="profiles.zcml" />
   <include file="permissions.zcml" />
 
+  <include package=".services" />
+
+  <utility factory=".tool.KeywordManager" />
+
   <!-- -*- extra stuff goes here -*- -->
 
 </configure>

backend/src/kitconcept/keywordmanager/interfaces.py

@@ -1,7 +1,22 @@
 """Module where all interfaces, events and exceptions live."""
 
+from zope.interface import Interface
 from zope.publisher.interfaces.browser import IDefaultBrowserLayer
 
 
 class IBrowserLayer(IDefaultBrowserLayer):
     """Marker interface that defines a browser layer."""
+
+
+class IKeywordManager(Interface):
+    """A utility that allows to manage keywords"""
+
+    def change(old_keywords, new_keyword):
+        """Updates all objects using the old_keywords.
+
+        Objects using the old_keywords will be using the new_keywords
+        afterwards.
+        """
+
+    def delete(keywords):
+        """Removes the keywords from all objects using it."""

backend/src/kitconcept/keywordmanager/permissions.zcml

@@ -1,5 +1,8 @@
 <configure xmlns="http://namespaces.zope.org/zope">
 
-  <!-- -*- extra stuff goes here -*- -->
+  <permission
+      id="kitconcept.keywordmanager.ManageKeywords"
+      title="kitconcept.keywordmanager: Manage Keywords"
+      />
 
 </configure>

backend/src/kitconcept/keywordmanager/profiles/default/rolemap.xml

@@ -1,6 +1,11 @@
 <?xml version="1.0" encoding="utf-8"?>
 <rolemap>
   <permissions>
-    <!-- -*- extra stuff goes here -*- -->
+    <permission acquire="True"
+                name="kitconcept.keywordmanager: Manage Keywords"
+    >
+      <role name="Manager" />
+      <role name="Site Administrator" />
+    </permission>
   </permissions>
 </rolemap>

backend/src/kitconcept/keywordmanager/services/configure.zcml

@@ -0,0 +1,38 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="plone.keywordmanager"
+    >
+
+  <plone:service
+      method="GET"
+      factory=".get.KeywordsGet"
+      for="plone.base.interfaces.IPloneSiteRoot"
+      permission="kitconcept.keywordmanager.ManageKeywords"
+      name="@keywords"
+      />
+  <plone:service
+      method="DELETE"
+      factory=".delete.KeywordsDelete"
+      for="plone.base.interfaces.IPloneSiteRoot"
+      permission="kitconcept.keywordmanager.ManageKeywords"
+      name="@keywords"
+      />
+  <plone:service
+      method="PATCH"
+      factory=".update.KeywordsPatch"
+      for="plone.base.interfaces.IPloneSiteRoot"
+      permission="kitconcept.keywordmanager.ManageKeywords"
+      name="@keywords"
+      />
+
+  <plone:service
+      method="GET"
+      factory=".get.KeywordIndexesGet"
+      for="plone.base.interfaces.IPloneSiteRoot"
+      permission="kitconcept.keywordmanager.ManageKeywords"
+      name="@keyword-indexes"
+      />
+
+</configure>

backend/src/kitconcept/keywordmanager/services/delete.py

@@ -0,0 +1,21 @@
+from kitconcept.keywordmanager.interfaces import IKeywordManager
+from plone.restapi.deserializer import json_body
+from plone.restapi.services import Service
+from zExceptions import BadRequest
+from zope.component import getUtility
+
+
+class KeywordsDelete(Service):
+    def reply(self):
+        data = json_body(self.request)
+        km = getUtility(IKeywordManager)
+        keywords = data.get("items") or []
+
+        if not isinstance(keywords, list):
+            raise BadRequest("")
+        if not keywords:
+            raise BadRequest("")
+
+        km.delete(keywords)
+
+        return self.reply_no_content()

backend/src/kitconcept/keywordmanager/services/get.py

@@ -0,0 +1,32 @@
+from kitconcept.keywordmanager.interfaces import IKeywordManager
+from plone.restapi.batching import HypermediaBatch
+from plone.restapi.services import Service
+from zope.component import getUtility
+
+
+class KeywordsGet(Service):
+    def reply(self):
+        km = getUtility(IKeywordManager)
+        query = {"withLengths": True}
+        if idx := self.request.form.get("idx"):
+            query = {"indexName": idx}
+
+        keywords = km.getKeywords(**query)
+
+        batch = HypermediaBatch(self.request, keywords)
+        items = {{"name": name, "total": count} for name, count in batch}
+
+        keywords_data = {
+            "@id": batch.canonical_url,
+            "items": items,
+            "items_total": batch.items_total,
+        }
+        if batch.links:
+            keywords_data["batching"] = batch.links
+        return keywords_data
+
+
+class KeywordIndexesGet(Service):
+    def reply(self):
+        km = getUtility(IKeywordManager)
+        return km.getKeywordIndexes()

backend/src/kitconcept/keywordmanager/services/update.py

@@ -0,0 +1,27 @@
+from kitconcept.keywordmanager.interfaces import IKeywordManager
+from plone.restapi.deserializer import json_body
+from plone.restapi.services import Service
+from zExceptions import BadRequest
+from zope.component import getUtility
+
+
+class KeywordsPatch(Service):
+    def reply(self):
+        data = json_body(self.request)
+        km = getUtility(IKeywordManager)
+
+        new_keyword = data.get("new_keyword") or ""
+        old_keywords = data.get("old_keywords") or []
+
+        if not isinstance(new_keyword, str):
+            raise BadRequest("")
+        if not new_keyword:
+            raise BadRequest("")
+        if not isinstance(old_keywords, list):
+            raise BadRequest("")
+        if not old_keywords:
+            raise BadRequest("")
+
+        km.change(new_keyword, old_keywords)
+
+        return self.reply_no_content()