[pull] master from kitodo:master

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;
     }
 
     /**

Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Process.java

@@ -85,7 +85,7 @@ public class Process extends BaseTemplateBean {
     @OrderBy("ordering")
     private List<Task> tasks;
 
-    @OneToMany(mappedBy = "process", cascade = CascadeType.ALL)
+    @OneToMany(mappedBy = "process", cascade = CascadeType.PERSIST, orphanRemoval = true)
     private List<Comment> comments;
 
     @ManyToMany(cascade = CascadeType.ALL)

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);
 

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();

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>
 

Kitodo/src/main/java/org/kitodo/production/enums/ObjectType.java

@@ -37,6 +37,7 @@ public enum ObjectType {
     FILTER("filter", "filters", true),
     IMPORT_CONFIGURATION("importConfig.configuration", "importConfig.configurations", false),
     MAPPING_FILE("mappingFile.file", "mappingFile.files", false),
+    COMMENT("comment", "comments", false),
     NONE("", "", false);
 
     private final String messageKeySingular;

Kitodo/src/main/java/org/kitodo/production/forms/CommentForm.java

@@ -44,6 +44,7 @@
 public class CommentForm extends BaseForm {
     private static final Logger logger = LogManager.getLogger(CommentForm.class);
     private boolean correctionComment = false;
+    private Comment editedComment = null;
     private String commentMessage;
     private String correctionTaskId;
     private Task currentTask;
@@ -60,6 +61,21 @@ public Process getProcess() {
         return process;
     }
 
+    /**
+     * Remove a given comment.
+     * 
+     * @param comment to be removed.
+     */
+    public void removeComment(Comment comment) {
+        try {
+            ServiceManager.getCommentService().removeComment(comment);
+            saveProcessAndTasksToIndex();
+        } catch (CustomResponseException | DAOException | DataException | IOException e) {
+            Helper.setErrorMessage(ERROR_DELETING, new Object[]{ObjectType.COMMENT.getTranslationSingular()},
+                    logger, e);
+        }
+    }
+
     /**
      * Set process by ID.
      *
@@ -103,6 +119,32 @@ public void setCommentMessage(String commentMessage) {
         this.commentMessage = commentMessage;
     }
 
+    /**
+     * Set's edited comment.
+     * 
+     * @param comment to be set as editedComment.
+     */
+    public void setEditedComment(Comment comment) {
+        this.editedComment = comment;
+    }
+
+    /**
+     * Returns edited comment.
+     * 
+     * @return edited comment.
+     */
+    public Comment getEditedComment() {
+        return this.editedComment;
+    }
+
+    private void saveProcessAndTasksToIndex() throws CustomResponseException, DataException, IOException {
+        ServiceManager.getProcessService().saveToIndex(this.process, true);
+        for (Task task : this.process.getTasks()) {
+            // update tasks in elastic search index, which includes correction comment status 
+            ServiceManager.getTaskService().saveToIndex(task, true);
+        }
+    }
+
     /**
      * Add a new comment to the process.
      */
@@ -128,12 +170,8 @@ public String addComment() {
         }
         try {
             ServiceManager.getCommentService().saveToDatabase(comment);
-            ServiceManager.getProcessService().saveToIndex(this.process, true);
-            for (Task task : this.process.getTasks()) {
-                // update tasks in elastic search index, which includes correction comment status 
-                ServiceManager.getTaskService().saveToIndex(task, true);
-            }
-        } catch (DAOException | CustomResponseException | DataException | IOException e) {
+            saveProcessAndTasksToIndex();
+        } catch (CustomResponseException | DAOException | DataException | IOException e) {
             Helper.setErrorMessage(ERROR_SAVING, logger, e);
         }
         newComment(false);
@@ -144,6 +182,21 @@ public String addComment() {
         return null;
     }
 
+    /**
+     * Saves the edited comment to database.
+     */
+    public void saveEditedComment() {
+        if (Objects.nonNull(this.editedComment) && this.editedComment.getType().equals(CommentType.INFO)) {
+            try {
+                ServiceManager.getCommentService().saveToDatabase(this.editedComment);
+                saveProcessAndTasksToIndex();
+            } catch (CustomResponseException | DAOException | DataException | IOException e) {
+                Helper.setErrorMessage(ERROR_SAVING, logger, e);
+            }
+        }
+        this.editedComment = null;
+    }
+
     /**
      * Add a new comment to all batch processes.
      */

Kitodo/src/main/java/org/kitodo/production/services/data/CommentService.java

@@ -20,6 +20,7 @@
 import org.kitodo.data.database.beans.Task;
 import org.kitodo.data.database.exceptions.DAOException;
 import org.kitodo.data.database.persistence.CommentDAO;
+import org.kitodo.production.services.ServiceManager;
 import org.kitodo.production.services.data.base.SearchDatabaseService;
 import org.primefaces.model.SortOrder;
 
@@ -91,4 +92,14 @@ public List<Comment> getAllCommentsByTask(Task task) {
     public void saveList(List<Comment> list) throws DAOException {
         dao.saveList(list);
     }
+
+    /**
+     * Remove comment from database and resolve associations.
+     * 
+     * @param comment to be removed.
+     */
+    public void removeComment(Comment comment) throws DAOException {
+        comment.getProcess().getComments().remove(comment);
+        ServiceManager.getCommentService().removeFromDatabase(comment);
+    }
 }

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);
     }

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>
 

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>
 

Kitodo/src/main/resources/messages/messages_de.properties

@@ -189,6 +189,8 @@ columnConfigurationSaved=Spaltenkonfiguration gespeichert
 columnCount=Spaltenz\u00E4hlung
 comment=Kommentieren
 comments=Kommentare
+commentDelete=Kommentar l\u00F6schen
+commentEdit=Kommentar bearbeiten
 commentWrite=Kommentar schreiben
 configureColumns=Spalten konfigurieren
 configurationChanged=Einstellungen ge\u00E4ndert
@@ -222,7 +224,6 @@ copyRolesToClient=Rollen zum Mandanten hinzuf\u00FCgen
 copyTemplates=Projekt inkl. Templates kopieren
 correction=Korrektur
 correctionFor=Korrektur f\u00FCr Schritt
-correctionK=K
 correctionMessage=Korrekturmeldung
 correctionMessageSend=Korrekturmeldung senden
 correctionMessageSendAllTasks=Korrekturmeldung f\u00FCr alle Schritte senden

Kitodo/src/main/resources/messages/messages_en.properties

@@ -189,6 +189,8 @@ columnConfigurationSaved=Column configuration saved
 columnCount=Column counting
 comment=Add comment
 comments=Comments
+commentDelete=Delete comment
+commentEdit=Edit comment
 commentWrite=Write comment
 configureColumns=Configure columns
 configurationChanged=Configuration changed
@@ -222,7 +224,6 @@ copyRolesToClient=Copy roles to client
 copyTemplates=Copy Project including Templates
 correction=Correction
 correctionFor=Correction for step
-correctionK=C
 correctionMessage=Correction message
 correctionMessageSend=Send correction message
 correctionMessageSendAllTasks=send correction message to all tasks

Kitodo/src/main/resources/messages/messages_es.properties

@@ -222,7 +222,6 @@ copyRolesToClient=Añadir funciones al cliente
 copyTemplates=Copiar el proyecto incluyendo las plantillas
 correction=Corrección
 correctionFor=Corrección del paso
-correctionK=C
 correctionMessage=Mensaje de corrección
 correctionMessageSend=Enviar mensaje de corrección
 correctionMessageSendAllTasks=Enviar mensaje de corrección para todos los pasos