kitconcept.plate 1.0.0a23__py3-none-any.whl

kitconcept/plate/__init__.py

@@ -0,0 +1,14 @@
+"""Init and utils."""
+
+from zope.i18nmessageid import MessageFactory
+
+import logging
+
+
+__version__ = "1.0.0a23"
+
+PACKAGE_NAME = "kitconcept.plate"
+
+_ = MessageFactory(PACKAGE_NAME)
+
+logger = logging.getLogger(PACKAGE_NAME)

kitconcept/plate/behaviors/configure.zcml

@@ -0,0 +1,13 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    >
+
+  <plone:behavior
+      name="kitconcept.plate.workspace"
+      title="Workspace"
+      description="Marks a content item as a Workspace container."
+      provides=".workspace.IWorkspaceMarker"
+      />
+
+</configure>

kitconcept/plate/behaviors/workspace.py

@@ -0,0 +1,5 @@
+from zope.interface import Interface
+
+
+class IWorkspaceMarker(Interface):
+    """Marker interface applied to Workspace content objects."""

kitconcept/plate/configure.zcml

@@ -0,0 +1,32 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:i18n="http://namespaces.zope.org/i18n"
+    i18n_domain="kitconcept.plate"
+    >
+
+  <i18n:registerTranslations directory="locales" />
+
+  <include
+      package="Products.CMFCore"
+      file="permissions.zcml"
+      />
+
+
+  <include file="dependencies.zcml" />
+  <include file="profiles.zcml" />
+  <include file="permissions.zcml" />
+
+  <include package=".behaviors" />
+  <include package=".controlpanels" />
+  <include package=".deserializers" />
+  <include package=".indexers" />
+  <include package=".mentions" />
+  <include package=".serializers" />
+  <include package=".services" />
+  <include package=".subscribers" />
+  <include package=".vocabularies" />
+  <include package=".upgrades" />
+
+  <!-- -*- extra stuff goes here -*- -->
+
+</configure>

kitconcept/plate/content/wiki_page.py

@@ -0,0 +1,5 @@
+from plone.supermodel import model
+
+
+class IWikiPage(model.Schema):
+    """Schema for wiki pages."""

kitconcept/plate/content/workspace.py

@@ -0,0 +1,5 @@
+from plone.supermodel import model
+
+
+class IWorkspace(model.Schema):
+    """Schema for workspace containers."""

kitconcept/plate/controlpanels/configure.zcml

@@ -0,0 +1,10 @@
+<configure
+    xmlns="http://namespaces.zope.org/zope"
+    xmlns:browser="http://namespaces.zope.org/browser"
+    xmlns:plone="http://namespaces.plone.org/plone"
+    i18n_domain="kitconcept.plate"
+    >
+
+  <!-- -*- extra stuff goes here -*- -->
+
+</configure>

kitconcept/plate/dependencies.zcml

@@ -0,0 +1,7 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <!-- List all packages you depend here -->
+  <include package="plone.restapi" />
+  <include package="plone.volto" />
+
+</configure>

kitconcept/plate/deserializers/__init__.py

@@ -0,0 +1 @@
+"""Block field deserializers for Plate editor."""

kitconcept/plate/deserializers/comments.py

@@ -0,0 +1,137 @@
+from kitconcept.plate.mentions import mentions_utility
+from plone import api
+from plone.restapi.interfaces import IBlockFieldDeserializationTransformer
+from zExceptions import BadRequest
+from zExceptions import Unauthorized
+from zope.component import adapter
+from zope.interface import implementer
+from zope.interface import Interface
+from zope.publisher.interfaces.browser import IBrowserRequest
+
+
+@adapter(Interface, IBrowserRequest)
+@implementer(IBlockFieldDeserializationTransformer)
+class CommentsDeserializer:
+    """Handle comments in __somersault__ blocks."""
+
+    order = 100
+    block_type = "__somersault__"
+    disabled = False
+
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, block):
+        """Process comments during block deserialization.
+
+        Validates permissions, prevents unauthorized modification of comments,
+        and stores discussions data separately from user details.
+        """
+        current_user = api.user.get_current()
+
+        # Check if user has permission to discuss content
+        has_permission = api.user.has_permission(
+            "kitconcept.plate: Discuss content", obj=self.context
+        )
+
+        # Get discussions from the request
+        incoming_discussions = block.get("discussions", {})
+        # Discard user details from the request (they are not stored here)
+        incoming_users = block.pop("users", {})
+
+        # Get existing discussions from the block data if it already exists
+        existing_discussions = self._get_existing_discussions()
+
+        if not has_permission:
+            # User does not have permission to edit comments
+            if incoming_discussions or incoming_users:
+                # They're trying to modify comments but don't have permission
+                raise Unauthorized("You do not have permission to modify comments")
+            else:
+                # No new comments in request, preserve existing comments
+                if existing_discussions:
+                    block["discussions"] = existing_discussions
+                return block
+
+        # User has permission - validate and store the discussions
+        if incoming_discussions:
+            # Validate that comments from other users are unchanged
+            self._validate_unchanged_comments(
+                incoming_discussions, existing_discussions, current_user
+            )
+            block["discussions"] = incoming_discussions
+        elif existing_discussions:
+            # Keep existing discussions if none in request
+            block["discussions"] = existing_discussions
+
+        # Mentions may live in the document value or in a comment's
+        # ``contentRich`` value. Notify only nodes introduced by this save;
+        # stable mention ids prevent later, unrelated edits from resending mail.
+        if current_user:
+            utility = mentions_utility()
+            utility.queue_notifications(
+                self.context,
+                utility.new_mentions(block, self._get_existing_block()),
+                current_user,
+            )
+
+        return block
+
+    def _get_existing_block(self):
+        """Return the stored somersault block, if there is one."""
+        if hasattr(self.context, "blocks"):
+            blocks = self.context.blocks or {}
+            block = blocks.get("__somersault__")
+            if isinstance(block, dict):
+                return block
+        return {}
+
+    def _get_existing_discussions(self):
+        """Get existing discussions from the context if available."""
+        # Try to get from blocks if context has blocks
+        return self._get_existing_block().get("discussions", {})
+
+    def _validate_unchanged_comments(
+        self, incoming_discussions, existing_discussions, current_user
+    ):
+        """Validate that comments from other users are unchanged.
+
+        Raises BadRequest if a comment from another user has been modified.
+        """
+        if not existing_discussions:
+            return  # No existing comments to validate against
+
+        # Check each existing discussion
+        for discussion_id, existing_discussion in existing_discussions.items():
+            incoming_discussion = incoming_discussions.get(discussion_id)
+
+            if not incoming_discussion:
+                # Discussion was removed - not allowed
+                raise BadRequest("Cannot delete existing discussion")
+
+            # Check each existing comment
+            existing_comments = existing_discussion.get("comments", [])
+            incoming_comments = {
+                c["id"]: c for c in incoming_discussion.get("comments", [])
+            }
+
+            for existing_comment in existing_comments:
+                comment_id = existing_comment.get("id")
+                user_id = existing_comment.get("userId")
+
+                # If comment is from another user, it must not be modified
+                if user_id and user_id != current_user.getId():
+                    incoming_comment = incoming_comments.get(comment_id)
+                    if not incoming_comment:
+                        # Comment was removed - not allowed
+                        raise BadRequest(
+                            "Cannot delete comment "
+                            f"{comment_id} created by another user"
+                        )
+                    # Comment still exists - verify it's unchanged
+                    if incoming_comment != existing_comment:
+                        raise BadRequest(
+                            "Cannot modify comment "
+                            f"{comment_id} created by another user"
+                        )

kitconcept/plate/deserializers/configure.zcml

@@ -0,0 +1,10 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <!-- Block deserializers -->
+
+  <subscriber
+      factory=".comments.CommentsDeserializer"
+      provides="plone.restapi.interfaces.IBlockFieldDeserializationTransformer"
+      />
+
+</configure>

kitconcept/plate/indexers/configure.zcml

@@ -0,0 +1,7 @@
+<configure xmlns="http://namespaces.zope.org/zope">
+
+  <!-- Indexers/Metadata -->
+
+  <!-- -*- extra stuff goes here -*- -->
+
+</configure>

kitconcept/plate/interfaces.py

@@ -0,0 +1,27 @@
+"""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 IMentions(Interface):
+    """Named utility that extracts and notifies Plate user mentions."""
+
+    def iter_mentions(value):
+        """Yield mention nodes from a Plate value or discussion structure."""
+
+    def new_mentions(incoming_block, existing_block):
+        """Return mention nodes newly introduced by this save."""
+
+    def queue_notifications(context, mentions, author):
+        """Keep newly introduced mentions until the lifecycle event fires."""
+
+    def send_notifications(context, mentions, author):
+        """Send one notification per newly mentioned user."""
+
+    def send_pending_notifications(context):
+        """Deliver mentions queued for this context by an earlier save."""

kitconcept/plate/locales/__main__.py

@@ -0,0 +1,69 @@
+"""Update locales."""
+
+from pathlib import Path
+
+import logging
+import re
+import subprocess
+
+
+logger = logging.getLogger("i18n")
+logger.setLevel(logging.DEBUG)
+
+
+PATTERN = r"^[a-z]{2}.*"
+
+locale_path = Path(__file__).parent.resolve()
+target_path = locale_path.parent.resolve()
+domains = [path.name[:-4] for path in locale_path.glob("*.pot")]
+
+i18ndude = "uvx i18ndude"
+
+# ignore node_modules files resulting in errors
+excludes = '"*.html *json-schema*.xml"'
+
+
+def locale_folder_setup(domain: str):
+    languages = [path for path in locale_path.glob("*") if path.is_dir()]
+    for lang_folder in languages:
+        lc_messages_path = lang_folder / "LC_MESSAGES"
+        lang = lang_folder.name
+        if lc_messages_path.exists():
+            continue
+        elif re.match(PATTERN, lang):
+            lc_messages_path.mkdir()
+            cmd = (
+                f"msginit --locale={lang} "
+                f"--input={locale_path}/{domain}.pot "
+                f"--output={locale_path}/{lang}/LC_MESSAGES/{domain}.po"
+            )
+            subprocess.call(cmd, shell=True)  # noQA: S602
+
+
+def _rebuild(domain: str):
+    cmd = (
+        f"{i18ndude} rebuild-pot --pot {locale_path}/{domain}.pot "
+        f"--exclude {excludes} "
+        f"--create {domain} {target_path}"
+    )
+    subprocess.call(cmd, shell=True)  # noQA: S602
+
+
+def _sync(domain: str):
+    cmd = (
+        f"{i18ndude} sync --pot {locale_path}/{domain}.pot "
+        f"{locale_path}/*/LC_MESSAGES/{domain}.po"
+    )
+    subprocess.call(cmd, shell=True)  # noQA: S602
+
+
+def main():
+    for domain in domains:
+        logger.info(f"Updating translations for {domain}")
+        locale_folder_setup(domain)
+        _rebuild(domain)
+        _sync(domain)
+
+
+if __name__ == "__main__":
+    main()

kitconcept/plate/locales/de/LC_MESSAGES/kitconcept.plate.po

@@ -0,0 +1,65 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2026-06-25 12:03+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"Language-Code: de\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8 latin1\n"
+"Domain: DOMAIN\n"
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "A Plate-powered wiki page."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "A folderish workspace container."
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "A new add-on for Plone that includes both backend and Volto frontend"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "Create example content to showcase this addon."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Edit"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "Uninstall kitconcept.plate setup."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "View"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "Wiki Page"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Workspace"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "kitconcept.plate: Example content"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "kitconcept.plate: Install"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "kitconcept.plate: Uninstall"
+msgstr ""

kitconcept/plate/locales/en/LC_MESSAGES/kitconcept.plate.po

@@ -0,0 +1,65 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2026-06-25 12:03+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"Language-Code: en\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8 latin1\n"
+"Domain: DOMAIN\n"
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "A Plate-powered wiki page."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "A folderish workspace container."
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "A new add-on for Plone that includes both backend and Volto frontend"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "Create example content to showcase this addon."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Edit"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "Uninstall kitconcept.plate setup."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "View"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "Wiki Page"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Workspace"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "kitconcept.plate: Example content"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "kitconcept.plate: Install"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "kitconcept.plate: Uninstall"
+msgstr ""

kitconcept/plate/locales/es/LC_MESSAGES/kitconcept.plate.po

@@ -0,0 +1,65 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2026-06-25 12:03+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"Language-Code: es\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8 latin1\n"
+"Domain: DOMAIN\n"
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "A Plate-powered wiki page."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "A folderish workspace container."
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "A new add-on for Plone that includes both backend and Volto frontend"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "Create example content to showcase this addon."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Edit"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "Uninstall kitconcept.plate setup."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "View"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "Wiki Page"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Workspace"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "kitconcept.plate: Example content"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "kitconcept.plate: Install"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "kitconcept.plate: Uninstall"
+msgstr ""

kitconcept/plate/locales/it/LC_MESSAGES/kitconcept.plate.po

@@ -0,0 +1,65 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"POT-Creation-Date: 2026-06-25 12:03+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0\n"
+"Language-Code: it\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8 latin1\n"
+"Domain: DOMAIN\n"
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "A Plate-powered wiki page."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "A folderish workspace container."
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "A new add-on for Plone that includes both backend and Volto frontend"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "Create example content to showcase this addon."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Edit"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "Uninstall kitconcept.plate setup."
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "View"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/WikiPage.xml
+msgid "Wiki Page"
+msgstr ""
+
+#: kitconcept/plate/profiles/default/types/Workspace.xml
+msgid "Workspace"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:22
+msgid "kitconcept.plate: Example content"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:13
+msgid "kitconcept.plate: Install"
+msgstr ""
+
+#: kitconcept/plate/profiles.zcml:30
+msgid "kitconcept.plate: Uninstall"
+msgstr ""