OCR-D Workflow integration

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

@@ -0,0 +1,115 @@
+/*
+ * (c) Kitodo. Key to digital objects e. V. <[email protected]>
+ *
+ * This file is part of the Kitodo project.
+ *
+ * It is licensed under GNU General Public License version 3 or later.
+ *
+ * For the full copyright and license information, please read the
+ * GPL3-License.txt file that was distributed with this source code.
+ */
+
+package org.kitodo.data.database.beans;
+
+import java.util.Objects;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.ForeignKey;
+import javax.persistence.JoinColumn;
+import javax.persistence.ManyToOne;
+import javax.persistence.Table;
+
+@Entity
+@Table(name = "ocrworkflow")
+public class OCRWorkflow extends BaseBean {
+
+    @Column(name = "title")
+    private String title;
+
+    @Column(name = "file")
+    private String file;
+
+    @Column(name = "active")
+    private Boolean active = true;
+
+    @ManyToOne
+    @JoinColumn(name = "client_id", foreignKey = @ForeignKey(name = "FK_ocrworkflow_client_id"))
+    private Client client;
+
+    public String getTitle() {
+        return this.title;
+    }
+
+    public void setTitle(String title) {
+        this.title = title;
+    }
+
+    public String getFile() {
+        return this.file;
+    }
+
+    public void setFile(String file) {
+        this.file = file;
+    }
+
+    /**
+     * Check if ocr workflow is active.
+     *
+     * @return true or false
+     */
+    public Boolean isActive() {
+        if (Objects.isNull(this.active)) {
+            this.active = true;
+        }
+        return this.active;
+    }
+
+    /**
+     * Set ruleset as active.
+     *
+     * @param active as boolean
+     */
+    public void setActive(boolean active) {
+        this.active = active;
+    }
+
+
+    /**
+     * Get client.
+     *
+     * @return Client object
+     */
+    public Client getClient() {
+        return this.client;
+    }
+
+    /**
+     * Set client.
+     *
+     * @param client
+     *            as Client object
+     */
+    public void setClient(Client client) {
+        this.client = client;
+    }
+
+    @Override
+    public boolean equals(Object object) {
+        if (this == object) {
+            return true;
+        }
+
+        if (object instanceof OCRWorkflow) {
+            OCRWorkflow ruleset = (OCRWorkflow) object;
+            return Objects.equals(this.getId(), ruleset.getId());
+        }
+
+        return false;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(title, file, active);
+    }
+}

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

@@ -62,6 +62,10 @@ public class Process extends BaseTemplateBean {
     @JoinColumn(name = "docket_id", foreignKey = @ForeignKey(name = "FK_process_docket_id"))
     private Docket docket;
 
+    @ManyToOne
+    @JoinColumn(name = "ocr_workflow_id", foreignKey = @ForeignKey(name = "FK_process_ocr_workflow_id"))
+    private OCRWorkflow ocrWorkflow;
+
     @ManyToOne
     @JoinColumn(name = "project_id", foreignKey = @ForeignKey(name = "FK_process_project_id"))
     private Project project;
@@ -289,6 +293,25 @@ public void setDocket(Docket docket) {
         this.docket = docket;
     }
 
+    /**
+     * Get ocr workflow.
+     *
+     * @return value of ocr workflow
+     */
+    public OCRWorkflow getOcrWorkflow() {
+        return ocrWorkflow;
+    }
+
+    /**
+     * Set ocr workflow.
+     *
+     * @param ocrWorkflow
+     *            as Workflow object
+     */
+    public void setOcrWorkflow(OCRWorkflow ocrWorkflow) {
+        this.ocrWorkflow = ocrWorkflow;
+    }
+
     /**
      * Get template.
      *

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

@@ -52,6 +52,10 @@ public class Template extends BaseTemplateBean {
     @JoinColumn(name = "workflow_id", foreignKey = @ForeignKey(name = "FK_template_workflow_id"))
     private Workflow workflow;
 
+    @ManyToOne
+    @JoinColumn(name = "ocr_workflow_id", foreignKey = @ForeignKey(name = "FK_template_ocr_workflow_id"))
+    private OCRWorkflow ocrWorkflow;
+
     @OneToMany(mappedBy = "template", cascade = CascadeType.ALL, orphanRemoval = true)
     private List<Process> processes;
 
@@ -168,6 +172,25 @@ public void setWorkflow(Workflow workflow) {
         this.workflow = workflow;
     }
 
+    /**
+     * Get ocr workflow.
+     *
+     * @return value of ocr workflow
+     */
+    public OCRWorkflow getOcrWorkflow() {
+        return ocrWorkflow;
+    }
+
+    /**
+     * Set ocr workflow.
+     *
+     * @param ocrWorkflow
+     *            as Workflow object
+     */
+    public void setOcrWorkflow(OCRWorkflow ocrWorkflow) {
+        this.ocrWorkflow = ocrWorkflow;
+    }
+
     /**
      * Get projects list.
      *

Kitodo-DataManagement/src/main/java/org/kitodo/data/database/persistence/OCRWorkflowDAO.java

@@ -0,0 +1,66 @@
+/*
+ * (c) Kitodo. Key to digital objects e. V. <[email protected]>
+ *
+ * This file is part of the Kitodo project.
+ *
+ * It is licensed under GNU General Public License version 3 or later.
+ *
+ * For the full copyright and license information, please read the
+ * GPL3-License.txt file that was distributed with this source code.
+ */
+
+package org.kitodo.data.database.persistence;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+
+import org.kitodo.data.database.beans.OCRWorkflow;
+import org.kitodo.data.database.exceptions.DAOException;
+
+public class OCRWorkflowDAO extends BaseDAO<OCRWorkflow> {
+
+    @Override
+    public OCRWorkflow getById(Integer id) throws DAOException {
+        OCRWorkflow ocrWorkflow = retrieveObject(OCRWorkflow.class, id);
+        if (Objects.isNull(ocrWorkflow)) {
+            throw new DAOException("Object cannot be found in database");
+        }
+        return ocrWorkflow;
+    }
+
+    @Override
+    public List<OCRWorkflow> getAll() throws DAOException {
+        return retrieveAllObjects(OCRWorkflow.class);
+    }
+
+    @Override
+    public List<OCRWorkflow> getAll(int offset, int size) throws DAOException {
+        return retrieveObjects("FROM OCRWorkflow ORDER BY id ASC", offset, size);
+    }
+
+    @Override
+    public List<OCRWorkflow> getAllNotIndexed(int offset, int size) throws DAOException {
+        throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public void remove(Integer ocrWorkflowId) throws DAOException {
+        removeObject(OCRWorkflow.class, ocrWorkflowId);
+    }
+
+    /**
+     * Get available ocr workflows - available means that ocr workflow has status active and is
+     * assigned to client with given id.
+     *
+     * @param clientId
+     *            id of client to which searched ocr workflows should be assigned
+     * @return list of available ocr workflow objects
+     */
+    public List<OCRWorkflow> getAvailableOCRWorkflows(int clientId) {
+        return getByQuery(
+                "SELECT w FROM OCRWorkflow AS w INNER JOIN w.client AS c WITH c.id = :clientId",
+                Collections.singletonMap("clientId", clientId));
+    }
+
+}

Kitodo-DataManagement/src/main/resources/db/migration/V2_124__Add_authorities_to_manage_ocr_workflow.sql

@@ -0,0 +1,41 @@
+--
+-- (c) Kitodo. Key to digital objects e. V. <[email protected]>
+--
+-- This file is part of the Kitodo project.
+--
+-- It is licensed under GNU General Public License version 3 or later.
+--
+-- For the full copyright and license information, please read the
+-- GPL3-License.txt file that was distributed with this source code.
+--
+
+-- Add authorities to manage ocr workflows
+INSERT IGNORE INTO authority (title) VALUES ('addOCRWorkflow_clientAssignable');
+INSERT IGNORE INTO authority (title) VALUES ('editOCRWorkflow_clientAssignable');
+INSERT IGNORE INTO authority (title) VALUES ('deleteOCRWorkflow_clientAssignable');
+INSERT IGNORE INTO authority (title) VALUES ('viewOCRWorkflow_clientAssignable');
+
+-- Add table "ocrworkflow"
+CREATE TABLE IF NOT EXISTS ocrworkflow (
+    id INT(10) NOT NULL AUTO_INCREMENT,
+    title varchar(255) NOT NULL,
+    file varchar(255) NOT NULL,
+    active tinyint(1) DEFAULT NULL,
+    client_id INT(10) NOT NULL,
+    PRIMARY KEY(id)
+) DEFAULT CHARACTER SET = utf8mb4
+  COLLATE utf8mb4_unicode_ci;
+
+-- Add column related to ocr workflow to process table
+ALTER TABLE process ADD ocr_workflow_id INT(11) DEFAULT NULL;
+
+-- Add foreign key
+ALTER TABLE process add constraint `FK_process_ocr_workflow_id`
+    foreign key (ocr_workflow_id) REFERENCES ocrworkflow(id);
+
+-- Add column related to ocr workflow to template table
+ALTER TABLE template ADD ocr_workflow_id INT(11) DEFAULT NULL;
+
+-- Add foreign key
+ALTER TABLE template add constraint `FK_template_ocr_workflow_id`
+    foreign key (ocr_workflow_id) REFERENCES ocrworkflow(id);

Kitodo-DataManagement/src/test/resources/hibernate.cfg.xml

@@ -67,6 +67,7 @@
         <mapping class="org.kitodo.data.database.beans.LdapServer"/>
         <mapping class="org.kitodo.data.database.beans.ListColumn"/>
         <mapping class="org.kitodo.data.database.beans.MappingFile"/>
+        <mapping class="org.kitodo.data.database.beans.OCRWorkflow"/>
         <mapping class="org.kitodo.data.database.beans.Process"/>
         <mapping class="org.kitodo.data.database.beans.Project"/>
         <mapping class="org.kitodo.data.database.beans.Property"/>

Kitodo/src/main/java/org/kitodo/config/enums/ParameterCore.java

@@ -46,6 +46,12 @@ public enum ParameterCore implements ParameterInterface {
      */
     DIR_RULESETS(new Parameter<UndefinedParameter>("directory.rulesets")),
 
+    /**
+     * Absolute path to the directory that the ocr workflow files will be
+     * read from. It must be terminated by a directory separator ("/").
+     */
+    DIR_OCR_WORKFLOWS(new Parameter<UndefinedParameter>("directory.ocr.workflows")),
+
     /**
      * Absolute path to the directory that XSLT files are stored in which are used
      * to transform the "XML log" (as visible from the XML button in the processes

Kitodo/src/main/java/org/kitodo/production/controller/SecurityAccessController.java

@@ -1081,4 +1081,40 @@ public boolean hasAuthorityToViewDatabaseStatistics() {
     public boolean hasAuthorityToRunKitodoScripts() {
         return securityAccessService.hasAuthorityToRunKitodoScripts();
     }
+
+    /**
+     * Check if the current user has the authority to add ocr workflow.
+     *
+     * @return true if the current user has the authority to add ocr workflow.
+     */
+    public boolean hasAuthorityToAddOCRWorkflow() {
+        return securityAccessService.hasAuthorityToAddOCRWorkflow();
+    }
+
+    /**
+     * Check if the current user has the authority to edit ocr workflow.
+     *
+     * @return true if the current user has the authority to edit ocr workflow.
+     */
+    public boolean hasAuthorityToEditOCRWorkflow() {
+        return securityAccessService.hasAuthorityToEditOCRWorkflow();
+    }
+
+    /**
+     * Check if the current user has the authority to delete ocr workflow.
+     *
+     * @return true if the current user has the authority to delete ocr workflow.
+     */
+    public boolean hasAuthorityToDeleteOCRWorkflow() {
+        return securityAccessService.hasAuthorityToDeleteOCRWorkflow();
+    }
+
+    /**
+     * Check if the current user has the authority to view ocr workflow.
+     *
+     * @return true if the current user has the authority to view ocr workflow.
+     */
+    public boolean hasAuthorityToViewOCRWorkflow() {
+        return securityAccessService.hasAuthorityToViewOCRWorkflow();
+    }
 }

Kitodo/src/main/java/org/kitodo/production/converter/OCRWorkflowConverter.java

@@ -0,0 +1,34 @@
+/*
+ * (c) Kitodo. Key to digital objects e. V. <[email protected]>
+ *
+ * This file is part of the Kitodo project.
+ *
+ * It is licensed under GNU General Public License version 3 or later.
+ *
+ * For the full copyright and license information, please read the
+ * GPL3-License.txt file that was distributed with this source code.
+ */
+
+package org.kitodo.production.converter;
+
+import javax.faces.component.UIComponent;
+import javax.faces.context.FacesContext;
+import javax.faces.convert.Converter;
+import javax.inject.Named;
+
+import org.kitodo.production.services.ServiceManager;
+
+@Named
+public class OCRWorkflowConverter extends BeanConverter implements Converter {
+
+    @Override
+    public Object getAsObject(FacesContext context, UIComponent component, String value) {
+        return getAsObject(ServiceManager.getOCRWorkflowService(), value);
+    }
+
+    @Override
+    public String getAsString(FacesContext context, UIComponent component, Object value) {
+        return getAsString(value, "ocrWorkflow");
+    }
+
+}