From 8bcbb8ce2179915eee391e97141d662fade7b4d3 Mon Sep 17 00:00:00 2001
From: jonaspiterek <piterek@kitconcept.com>
Date: Thu, 9 Nov 2023 12:20:08 +0100
Subject: [PATCH] Add author content type

---
 .../src/collective_blog/content/author.py     |  26 ++
 .../src/collective_blog/content/blog_post.py  |  21 +-
 .../src/collective_blog/permissions.zcml      |  12 +-
 .../profiles/default/catalog.xml              |  11 +-
 .../profiles/default/types.xml                |   5 +-
 .../profiles/default/types/Author.xml         |  98 ++++++
 .../profiles/default/types/Blog_post.xml      |   4 +-
 .../profiles/default/workflows.xml            |   7 +-
 .../workflows/author_workflow/definition.xml  | 284 ++++++++++++++++++
 .../blog_post_workflow/definition.xml         |   2 +-
 10 files changed, 447 insertions(+), 23 deletions(-)
 create mode 100644 backend/src/collective_blog/src/collective_blog/content/author.py
 create mode 100644 backend/src/collective_blog/src/collective_blog/profiles/default/types/Author.xml
 create mode 100644 backend/src/collective_blog/src/collective_blog/profiles/default/workflows/author_workflow/definition.xml

diff --git a/backend/src/collective_blog/src/collective_blog/content/author.py b/backend/src/collective_blog/src/collective_blog/content/author.py
new file mode 100644
index 0000000..ed192e8
--- /dev/null
+++ b/backend/src/collective_blog/src/collective_blog/content/author.py
@@ -0,0 +1,26 @@
+from collective_blog import _
+from plone.dexterity.content import Container
+from plone.supermodel.model import Schema
+from zope import schema
+from zope.interface import implementer
+
+
+class IAuthor(Schema):
+    """An author."""
+
+    title = schema.TextLine(
+        title=_("Name"),
+        description=_("Name of the author"),
+        required=True,
+    )
+
+    description = schema.TextLine(
+        title=_("Description"),
+        description=_("About the author"),
+        required=False,
+    )
+
+
+@implementer(IAuthor)
+class Author(Container):
+    """An author."""
diff --git a/backend/src/collective_blog/src/collective_blog/content/blog_post.py b/backend/src/collective_blog/src/collective_blog/content/blog_post.py
index ccc61e1..a9c0e58 100644
--- a/backend/src/collective_blog/src/collective_blog/content/blog_post.py
+++ b/backend/src/collective_blog/src/collective_blog/content/blog_post.py
@@ -1,32 +1,31 @@
 from collective_blog import _
+from plone.autoform import directives
 from plone.dexterity.content import Container
 from plone.supermodel.model import Schema
-from zope import schema
-from zope.interface import implementer
-
 from z3c.relationfield.schema import RelationChoice
 from z3c.relationfield.schema import RelationList
-from plone.autoform import directives
+from zope import schema
+from zope.interface import implementer
 
 
 class IBlogPost(Schema):
     """A Blog post."""
 
     title = schema.TextLine(
-        title=_('Title'),
-        description=_('Blog post title'),
+        title=_("Title"),
+        description=_("Blog post title"),
         required=True,
     )
 
     description = schema.TextLine(
-        title=_('Description'),
-        description=_('Blog post description'),
+        title=_("Description"),
+        description=_("Blog post description"),
         required=False,
     )
 
     authors = RelationList(
-        title=_('Authors'),
-        description=_('Blog post authors'),
+        title=_("Authors"),
+        description=_("Blog post authors"),
         required=False,
         value_type=RelationChoice(
             vocabulary="plone.app.vocabularies.Catalog",
@@ -45,4 +44,4 @@ class IBlogPost(Schema):
 
 @implementer(IBlogPost)
 class BlogPost(Container):
-    """A Blog post."""
\ No newline at end of file
+    """A Blog post."""
diff --git a/backend/src/collective_blog/src/collective_blog/permissions.zcml b/backend/src/collective_blog/src/collective_blog/permissions.zcml
index d3ff788..bf43af8 100644
--- a/backend/src/collective_blog/src/collective_blog/permissions.zcml
+++ b/backend/src/collective_blog/src/collective_blog/permissions.zcml
@@ -7,10 +7,14 @@
   <configure zcml:condition="installed AccessControl.security">
     <!-- -*- extra stuff goes here -*- -->
 
-    <permission 
-      id="kitconcept_blog.blog_post.add" 
-      title="kitconcept_blog: Add Blog post"
-    />
+    <permission
+        id="kitconcept_blog.blog_post.add"
+        title="kitconcept_blog: Add Blog post"
+        />
+    <permission
+        id="kitconcept_blog.author.add"
+        title="kitconcept_blog: Add Author"
+        />
 
   </configure>
 
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/catalog.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/catalog.xml
index 7dc04fd..061e9cc 100644
--- a/backend/src/collective_blog/src/collective_blog/profiles/default/catalog.xml
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/catalog.xml
@@ -10,7 +10,14 @@
   <!-- Metadata
   <column value="industry" />
 -->
-  <index meta_type="FieldIndex" name="Blog post">
-    <indexed_attr value="Blog post"/>
+  <index meta_type="FieldIndex"
+         name="Blog post"
+  >
+    <indexed_attr value="Blog post" />
+  </index>
+  <index meta_type="FieldIndex"
+         name="Author"
+  >
+    <indexed_attr value="Author" />
   </index>
 </object>
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/types.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/types.xml
index d7605a7..0f728e8 100644
--- a/backend/src/collective_blog/src/collective_blog/profiles/default/types.xml
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/types.xml
@@ -7,7 +7,10 @@
           name="MyType"
   />
 -->
-  <object meta_type="Dexterity FTI" 
+  <object meta_type="Dexterity FTI"
           name="Blog post"
   />
+  <object meta_type="Dexterity FTI"
+          name="Author"
+  />
 </object>
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/types/Author.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/types/Author.xml
new file mode 100644
index 0000000..9f675e6
--- /dev/null
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/types/Author.xml
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="utf-8"?>
+<object xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+        meta_type="Dexterity FTI"
+        name="Author"
+        i18n:domain="collective_blog"
+>
+
+  <!-- Basic properties -->
+  <property name="title"
+            i18n:translate=""
+  >Author</property>
+  <property name="description"
+            i18n:translate=""
+  />
+
+  <property name="allow_discussion">False</property>
+  <property name="factory">Author</property>
+  <property name="icon_expr" />
+  <property name="link_target" />
+
+  <!-- Hierarchy control -->
+  <property name="allowed_content_types" />
+  <property name="filter_content_types">True</property>
+  <property name="global_allow">True</property>
+
+  <!-- Schema, class and security -->
+  <property name="add_permission">cmf.AddPortalContent</property>
+  <property name="klass">collective_blog.content.author.Author</property>
+  <property name="model_file" />
+  <property name="model_source" />
+  <property name="schema">collective_blog.content.author.IAuthor</property>
+
+  <!-- Enabled behaviors -->
+  <property name="behaviors"
+            purge="true"
+  >
+    <element value="volto.blocks" />
+    <element value="volto.preview_image" />
+    <element value="plone.namefromtitle" />
+    <element value="plone.allowdiscussion" />
+    <element value="plone.excludefromnavigation" />
+    <element value="plone.shortname" />
+    <element value="plone.dublincore" />
+    <element value="plone.richtext" />
+    <element value="plone.relateditems" />
+    <element value="plone.versioning" />
+    <element value="plone.tableofcontents" />
+    <element value="plone.locking" />
+  </property>
+
+  <!-- View information -->
+  <property name="add_view_expr">string:${folder_url}/++add++author</property>
+  <property name="immediate_view">view</property>
+  <property name="default_view">view</property>
+  <property name="default_view_fallback">False</property>
+  <property name="view_methods">
+    <element value="view" />
+  </property>
+
+  <!-- Method aliases -->
+  <alias from="(Default)"
+         to="(dynamic view)"
+  />
+  <alias from="edit"
+         to="@@edit"
+  />
+  <alias from="sharing"
+         to="@@sharing"
+  />
+  <alias from="view"
+         to="(selected layout)"
+  />
+
+  <!-- Actions -->
+  <action action_id="view"
+          category="object"
+          condition_expr=""
+          description=""
+          title="View"
+          url_expr="string:${object_url}"
+          visible="True"
+          i18n:attributes="title"
+  >
+    <permission value="View" />
+  </action>
+  <action action_id="edit"
+          category="object"
+          condition_expr=""
+          description=""
+          title="Edit"
+          url_expr="string:${object_url}/edit"
+          visible="True"
+          i18n:attributes="title"
+  >
+    <permission value="Modify portal content" />
+  </action>
+
+</object>
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/types/Blog_post.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/types/Blog_post.xml
index 32a07a8..9078f84 100644
--- a/backend/src/collective_blog/src/collective_blog/profiles/default/types/Blog_post.xml
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/types/Blog_post.xml
@@ -35,7 +35,7 @@
             purge="true"
   >
     <element value="volto.blocks" />
-    <element value="volto.preview_image"/>
+    <element value="volto.preview_image" />
     <element value="plone.namefromtitle" />
     <element value="plone.allowdiscussion" />
     <element value="plone.excludefromnavigation" />
@@ -95,4 +95,4 @@
     <permission value="Modify portal content" />
   </action>
 
-</object>
\ No newline at end of file
+</object>
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/workflows.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/workflows.xml
index 7019430..d484652 100644
--- a/backend/src/collective_blog/src/collective_blog/profiles/default/workflows.xml
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/workflows.xml
@@ -11,7 +11,10 @@
       <bound-workflow workflow_id="workflow_id" />
     </default> -->
     <type type_id="Blog post">
-      <bound-workflow workflow_id="blog_post_workflow"/>
+      <bound-workflow workflow_id="blog_post_workflow" />
+    </type>
+    <type type_id="Author">
+      <bound-workflow workflow_id="author_workflow" />
     </type>
   </bindings>
-</object>
\ No newline at end of file
+</object>
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/author_workflow/definition.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/author_workflow/definition.xml
new file mode 100644
index 0000000..ee849b7
--- /dev/null
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/author_workflow/definition.xml
@@ -0,0 +1,284 @@
+<?xml version="1.0" encoding="utf-8"?>
+<dc-workflow xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+             description=" - Simple workflow that is useful for basic web sites. - Things start out as private, and can either be submitted for review, or published directly. - The creator of a content item can edit the item even after it is published."
+             initial_state="private"
+             state_variable="review_state"
+             title="Blog Post Workflow"
+             workflow_id="author_workflow"
+             i18n:attributes="title; description"
+             i18n:domain="plone"
+>
+
+  <permission>Access contents information</permission>
+  <permission>Modify portal content</permission>
+  <permission>View</permission>
+
+  <state state_id="pending"
+         title="Pending review"
+         i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    Waiting to be reviewed, not editable by the owner.
+  </description>
+    <exit-transition transition_id="publish" />
+    <exit-transition transition_id="reject" />
+    <exit-transition transition_id="retract" />
+    <permission-map acquired="False"
+                    name="Access contents information"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Owner</permission-role>
+      <permission-role>Editor</permission-role>
+      <permission-role>Reader</permission-role>
+      <permission-role>Contributor</permission-role>
+      <permission-role>Reviewer</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+    <permission-map acquired="False"
+                    name="Modify portal content"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Reviewer</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+    <permission-map acquired="False"
+                    name="View"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Owner</permission-role>
+      <permission-role>Editor</permission-role>
+      <permission-role>Reader</permission-role>
+      <permission-role>Contributor</permission-role>
+      <permission-role>Reviewer</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+
+  </state>
+  <state state_id="private"
+         title="Private"
+         i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    Can only be seen and edited by the owner.
+  </description>
+    <exit-transition transition_id="publish" />
+    <exit-transition transition_id="submit" />
+    <permission-map acquired="False"
+                    name="Access contents information"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Owner</permission-role>
+      <permission-role>Editor</permission-role>
+      <permission-role>Reader</permission-role>
+      <permission-role>Contributor</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+    <permission-map acquired="False"
+                    name="Modify portal content"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Owner</permission-role>
+      <permission-role>Editor</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+    <permission-map acquired="False"
+                    name="View"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Owner</permission-role>
+      <permission-role>Editor</permission-role>
+      <permission-role>Reader</permission-role>
+      <permission-role>Contributor</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+  </state>
+  <state state_id="published"
+         title="Published"
+         i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    Visible to everyone, editable by the owner.
+  </description>
+    <exit-transition transition_id="retract" />
+    <exit-transition transition_id="reject" />
+    <permission-map acquired="False"
+                    name="Access contents information"
+    >
+      <permission-role>Anonymous</permission-role>
+    </permission-map>
+    <permission-map acquired="False"
+                    name="Modify portal content"
+    >
+      <permission-role>Manager</permission-role>
+      <permission-role>Owner</permission-role>
+      <permission-role>Editor</permission-role>
+      <permission-role>Site Administrator</permission-role>
+    </permission-map>
+    <permission-map acquired="False"
+                    name="View"
+    >
+      <permission-role>Anonymous</permission-role>
+    </permission-map>
+  </state>
+
+  <transition after_script=""
+              before_script=""
+              new_state="approved"
+              title="Reviewer approved your holiday"
+              transition_id="publish"
+              trigger="USER"
+              i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    Publishing the item makes it visible to other users.
+  </description>
+    <action category="workflow"
+            url="%(content_url)s/content_status_modify?workflow_action=publish"
+            i18n:translate=""
+    >Approved</action>
+    <guard>
+      <guard-permission>Review portal content</guard-permission>
+    </guard>
+  </transition>
+  <transition after_script=""
+              before_script=""
+              new_state="private"
+              title="Reviewer sends content back for re-drafting"
+              transition_id="reject"
+              trigger="USER"
+              i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    Sending the item back will return the item to the original author instead of publishing it. You should preferably include a reason for why it was not published.
+  </description>
+    <action category="workflow"
+            url="%(content_url)s/content_status_modify?workflow_action=reject"
+            i18n:translate=""
+    >Send back</action>
+    <guard>
+      <guard-permission>Review portal content</guard-permission>
+    </guard>
+  </transition>
+  <transition after_script=""
+              before_script=""
+              new_state="private"
+              title="Member retracts submission"
+              transition_id="retract"
+              trigger="USER"
+              i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    If you submitted the item by mistake or want to perform additional edits, this will take it back.
+  </description>
+    <action category="workflow"
+            url="%(content_url)s/content_status_modify?workflow_action=retract"
+            i18n:translate=""
+    >Retract</action>
+    <guard>
+      <guard-permission>Request review</guard-permission>
+    </guard>
+  </transition>
+  <transition after_script=""
+              before_script=""
+              new_state="pending"
+              title="Member submits content for approval"
+              transition_id="submit"
+              trigger="USER"
+              i18n:attributes="title"
+  >
+    <description i18n:translate="">
+    Puts your holiday in a review queue, so it can be approved by the reviewer.
+  </description>
+    <action category="workflow"
+            url="%(content_url)s/content_status_modify?workflow_action=submit"
+            i18n:translate=""
+    >Submit for review</action>
+    <guard>
+      <guard-permission>Request review</guard-permission>
+    </guard>
+  </transition>
+
+  <worklist title=""
+            worklist_id="reviewer_queue"
+  >
+    <description>Reviewer tasks</description>
+    <action category="global"
+            url="%(portal_url)s/search?review_state=pending"
+    >Pending (%(count)d)</action>
+    <guard>
+      <guard-permission>Review portal content</guard-permission>
+    </guard>
+    <match name="review_state"
+           values="pending"
+    />
+  </worklist>
+
+  <variable for_catalog="False"
+            for_status="True"
+            update_always="True"
+            variable_id="action"
+  >
+    <description>Previous transition</description>
+    <default>
+
+      <expression>transition/getId|nothing</expression>
+    </default>
+    <guard>
+</guard>
+  </variable>
+  <variable for_catalog="False"
+            for_status="True"
+            update_always="True"
+            variable_id="actor"
+  >
+    <description>The ID of the user who performed the previous transition</description>
+    <default>
+
+      <expression>user/getId</expression>
+    </default>
+    <guard>
+</guard>
+  </variable>
+  <variable for_catalog="False"
+            for_status="True"
+            update_always="True"
+            variable_id="comments"
+  >
+    <description>Comment about the last transition</description>
+    <default>
+
+      <expression>python:state_change.kwargs.get('comment', '')</expression>
+    </default>
+    <guard>
+</guard>
+  </variable>
+  <variable for_catalog="False"
+            for_status="False"
+            update_always="False"
+            variable_id="review_history"
+  >
+    <description>Provides access to workflow history</description>
+    <default>
+
+      <expression>state_change/getHistory</expression>
+    </default>
+    <guard>
+      <guard-permission>Request review</guard-permission>
+      <guard-permission>Review portal content</guard-permission>
+    </guard>
+  </variable>
+  <variable for_catalog="False"
+            for_status="True"
+            update_always="True"
+            variable_id="time"
+  >
+    <description>When the previous transition was performed</description>
+    <default>
+
+      <expression>state_change/getDateTime</expression>
+    </default>
+    <guard>
+</guard>
+  </variable>
+
+</dc-workflow>
diff --git a/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/blog_post_workflow/definition.xml b/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/blog_post_workflow/definition.xml
index 3ae5d5d..249538a 100644
--- a/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/blog_post_workflow/definition.xml
+++ b/backend/src/collective_blog/src/collective_blog/profiles/default/workflows/blog_post_workflow/definition.xml
@@ -281,4 +281,4 @@
 </guard>
   </variable>
 
-</dc-workflow>
\ No newline at end of file
+</dc-workflow>