Merge pull request kitodo#5747 from effective-webwork/comments-docket

Print comments onto docket
subhh · Oct 18, 2023 · 99e97da · 99e97da
2 parents ea50685 + 561424d
commit 99e97da
Show file tree

Hide file tree

Showing 7 changed files with 63 additions and 37 deletions.
diff --git a/Kitodo-API/src/main/java/org/kitodo/api/docket/DocketData.java b/Kitodo-API/src/main/java/org/kitodo/api/docket/DocketData.java
@@ -39,8 +39,8 @@ public class DocketData {
     /** The creation Date of the process. */
     private String creationDate;
 
-    /** A comment. */
-    private String comment;
+    /** The comments. */
+    private List<String> comments = new ArrayList<>();
 
     /** The template properties. */
     private List<Property> templateProperties;
@@ -185,22 +185,22 @@ public void setCreationDate(String creationDate) {
     }
 
     /**
-     * Gets the comment.
+     * Gets the comments.
      * 
-     * @return The comment.
+     * @return The comments.
      */
-    public String getComment() {
-        return comment;
+    public List<String> getComments() {
+        return comments;
     }
 
     /**
-     * Sets the comment.
+     * Sets the comments.
      * 
-     * @param comment
-     *            The comment.
+     * @param comments
+     *            The comments.
      */
-    public void setComment(String comment) {
-        this.comment = comment;
+    public void setComments(List<String> comments) {
+        this.comments = comments;
     }
 
     /**

diff --git a/Kitodo-Docket/src/main/java/org/kitodo/docket/ExportXmlLog.java b/Kitodo-Docket/src/main/java/org/kitodo/docket/ExportXmlLog.java
@@ -300,9 +300,15 @@ private ArrayList<Element> processProcessInformation(DocketData docketData, Name
         ruleset.setText(docketData.getRulesetName());
         processElements.add(ruleset);
 
-        Element comment = new Element("comment", xmlns);
-        comment.setText(docketData.getComment());
-        processElements.add(comment);
+        Element comments = new Element("comments", xmlns);
+        List<Element> commentList = new ArrayList<>();
+        for (String commentString : docketData.getComments()) {
+            Element comment = new Element("comment", xmlns);
+            comment.setText(commentString);
+            commentList.add(comment);
+        }
+        comments.addContent(commentList);
+        processElements.add(comments);
 
         List<Element> processProperties = prepareProperties(docketData.getProcessProperties(), xmlns);
 

diff --git a/Kitodo-Docket/src/test/java/org/kitodo/docket/DocketDataGenerator.java b/Kitodo-Docket/src/test/java/org/kitodo/docket/DocketDataGenerator.java
@@ -14,6 +14,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 import org.kitodo.api.docket.DocketData;
@@ -32,7 +33,7 @@ public DocketData createDocketData(String processID, String signatur, String doc
         docketdata.setProcessName("ProcessTitle");
         docketdata.setProjectName("projectTitle");
         docketdata.setRulesetName("RulesetTitle");
-        docketdata.setComment("A comment");
+        docketdata.setComments(Collections.singletonList("A comment"));
 
         List<Property> templateProperties = new ArrayList<>();
         Property propertyForDocket = new Property();

diff --git a/Kitodo-Docket/src/test/resources/docket_multipage.xsl b/Kitodo-Docket/src/test/resources/docket_multipage.xsl
@@ -334,13 +334,15 @@
                     <fo:table line-height="14pt">
                         <fo:table-column column-width="12.8cm"/>
                         <fo:table-body>
-                            <fo:table-row height="2cm" border-width="1pt" border-style="solid">
-                                <fo:table-cell>
-                                    <fo:block>
-                                        <xsl:value-of select="kitodo:comment"/>
-                                    </fo:block>
-                                </fo:table-cell>
-                            </fo:table-row>
+                            <xsl:for-each select="kitodo:comments/kitodo:comment">
+                                <fo:table-row border-width="1pt" border-style="solid">
+                                    <fo:table-cell>
+                                        <fo:block>
+                                            <xsl:value-of select="text()"/>
+                                        </fo:block>
+                                    </fo:table-cell>
+                                </fo:table-row>
+                            </xsl:for-each>
                         </fo:table-body>
                     </fo:table>
 

diff --git a/Kitodo/src/main/java/org/kitodo/production/services/data/ProcessService.java b/Kitodo/src/main/java/org/kitodo/production/services/data/ProcessService.java
@@ -37,6 +37,8 @@
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Paths;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
 import java.time.Duration;
 import java.time.LocalDateTime;
 import java.time.format.DateTimeFormatter;
@@ -2036,7 +2038,7 @@ private static DocketData getDocketData(Process process) throws IOException {
         docketdata.setProcessName(process.getTitle());
         docketdata.setProjectName(process.getProject().getTitle());
         docketdata.setRulesetName(process.getRuleset().getTitle());
-        docketdata.setComment(process.getWikiField());
+        docketdata.setComments(getDocketDataForComments(process.getComments()));
 
         if (!process.getTemplates().isEmpty()) {
             docketdata.setTemplateProperties(getDocketDataForProperties(process.getTemplates()));
@@ -2064,6 +2066,17 @@ private static ArrayList<org.kitodo.api.docket.Property> getDocketDataForPropert
         return propertiesForDocket;
     }
 
+    private static List<String> getDocketDataForComments(List<Comment> comments) {
+        List<String> commentsForDocket = new ArrayList<>();
+        DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
+        for (Comment comment : comments) {
+            String commentString = dateFormat.format(comment.getCreationDate()) + " "
+                    + comment.getAuthor().getFullName() + ": " + comment.getMessage();
+            commentsForDocket.add(commentString);
+        }
+        return commentsForDocket;
+    }
+
     private List<Map<String, Object>> getMetadataForIndex(Process process) {
         return getMetadataForIndex(process, false);
     }

diff --git a/Kitodo/src/main/resources/docket.xsl b/Kitodo/src/main/resources/docket.xsl
@@ -333,13 +333,15 @@
                         <fo:table line-height="14pt">
                             <fo:table-column column-width="12.8cm"/>
                             <fo:table-body>
-                                <fo:table-row height="2cm" border-width="1pt" border-style="solid">
-                                    <fo:table-cell>
-                                        <fo:block>
-                                            <xsl:value-of select="kitodo:comment"/>
-                                        </fo:block>
-                                    </fo:table-cell>
-                                </fo:table-row>
+                                <xsl:for-each select="kitodo:comments/kitodo:comment">
+                                    <fo:table-row border-width="1pt" border-style="solid">
+                                        <fo:table-cell>
+                                            <fo:block>
+                                                <xsl:value-of select="text()"/>
+                                            </fo:block>
+                                        </fo:table-cell>
+                                    </fo:table-row>
+                                </xsl:for-each>
                             </fo:table-body>
                         </fo:table>
 

diff --git a/Kitodo/src/main/resources/docket_multipage.xsl b/Kitodo/src/main/resources/docket_multipage.xsl
@@ -334,13 +334,15 @@
                     <fo:table line-height="14pt">
                         <fo:table-column column-width="12.8cm"/>
                         <fo:table-body>
-                            <fo:table-row height="2cm" border-width="1pt" border-style="solid">
-                                <fo:table-cell>
-                                    <fo:block>
-                                        <xsl:value-of select="kitodo:comment"/>
-                                    </fo:block>
-                                </fo:table-cell>
-                            </fo:table-row>
+                            <xsl:for-each select="kitodo:comments/kitodo:comment">
+                                <fo:table-row border-width="1pt" border-style="solid">
+                                    <fo:table-cell>
+                                        <fo:block>
+                                            <xsl:value-of select="text()"/>
+                                        </fo:block>
+                                    </fo:table-cell>
+                                </fo:table-row>
+                            </xsl:for-each>
                         </fo:table-body>
                     </fo:table>