Merge pull request 'Release v24.06' (#21) from release_24.06 into master

docs/index_de.md

@@ -0,0 +1,68 @@
+---
+title: Massenupload
+identifier: intranda_workflow_massupload
+github: https://github.com/intranda/goobi-plugin-workflow-massupload
+description: Dieses Workflow Plugin erlaubt einen Massenupload von Dateien mit automatischer Zuordnung zu den korrekten Goobi-Vorgängen entweder auf Basis der Dateinamen oder anhand der analysierten Barcodes.
+published: true
+---
+
+## Einführung
+Dieses Workflow-Plugin erlaubt einen Massenupload von Dateien, die von Goobi workflow automatisch zu den richtigen Vorgängen zugeordnet werden sollen. Hierfür stellt das Plugin eine eigene Oberfläche zur Verfügung, die entweder einen Upload direkt über die Weboberfläche erlaubt oder alternativ ebenso Bilder aus dem Nutzerverzeichnis auslesen kann. Diese Bilder werden durch das Plugin auf ihren Namen geprüft, um daraus den zugehörigen Goobi-Vorgang zu ermitteln. Ist eine Ermittlung des Vorgangs eindeutig und befindet sich der ermittelte Goobi-Vorgang auch im konfigurierten Arbeitsschritt des Workflows, so werden die Bilder diesem zugeordnet und der Workflow weiter verarbeitet.
+
+Neben der Zuordnung der Dateien auf Basis des Dateinamens ist ebenso konfigurierbar, dass stattdessen eine Bildanalyse erfolgen soll, die Barcodes liest. Damit ist es möglich, dass Bilder mehrere Vorgänge beispielsweise fortlaufend benannt sind und lediglich ein Trennblatt zwischen den Aufnahmen mit aufgenommen werden muss. Alle Bilder nach einem solchen Trennblatt mit identifizierbarem Barcode werden dem jeweiligen Vorgang zugewiesen, bis der nächste Barcode im Dateistapel ermittelt wird.
+
+## Installation
+Zur Installation des Plugins müssen folgende beiden Dateien installiert werden:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin_intranda_workflow_massupload.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_workflow_massupload-GUI.jar
+```
+
+Um zu konfigurieren, wie sich das Plugin verhalten soll, können verschiedene Werte in der Konfigurationsdatei angepasst werden. Die Konfigurationsdatei befindet sich üblicherweise hier:
+
+```bash
+/opt/digiverso/goobi/config/plugin_intranda_workflow_massupload.xml
+```
+
+Für eine Nutzung dieses Plugins muss der Nutzer über die korrekte Rollenberechtigung verfügen.
+
+![Ohne korrekte Berechtigung ist das Plugin nicht nutzbar](screen1_de.png)
+
+Bitte weisen Sie daher der Gruppe die Rolle `Plugin_Goobi_Massupload` zu.
+
+![Korrekt zugewiesene Rolle für die Nutzer](screen2_de.png)
+
+
+## Überblick und Funktionsweise
+Wenn das Plugin korrekt installiert und konfiguriert wurde, ist es innerhalb des Menüpunkts `Workflow` zu finden.
+
+![Geöffnetes Plugin für den Upload](screen3_de.png)
+
+An dieser Stellen können nun entweder Dateien hochgeladen oder aus dem Nutzerverzeichnis ausgelesen werden. Nach der Analyse der Dateinamen bzw. Bilder zeigt Goobi workflow an, welchen Vorgängen die eingespielten Bilder zugewiesen werden können.
+
+![Analysierte Dateien mit Anzeige der zugehörigen Vorgänge](screen4_de.png)
+
+Mit einem Klick auf den Button `Dateien in Vorgänge einspielen` werden die Bilder nun in die Verzeichnisse der ermittelten Vorgänge verschoben und der Workflow fortgeführt.
+
+Bitte beachten Sie: Soll eine Erkennung von Barcodes erfolgen, um daraus die Vorgänge zu ermitteln, so ist wichtig, dass auch die Barcodes in ausreichender Größe und Qualität vorliegen, damit die Erkennung erfolgreich ist.
+
+![Digitalisierte Trennblätter mit Barcodes für die automatische Erkennung](screen5_de.png)
+
+
+
+## Konfiguration
+Die Konfiguration des Plugins erfolgt in der Datei `plugin_intranda_workflow_massupload.xml` wie hier aufgezeigt:
+
+{{CONFIG_CONTENT}}
+
+| Wert                               | Beschreibung                  |
+| ---------------------------------- | ----------------------------- |
+| `allowed-file-extensions`          | Mit diesem Parameter wird festgelegt, welche Datein hochgeladen werden dürfen. Hierbei handelt es sich um einen regulären Ausdruck. |
+| `user-folder-name`                 | Wenn die Dateien aus dem Nutzerverzeichnis ausgelesen werden sollen, kann hier festgelegt werden, wie der Ornder innerhalb des Nutzerverzeichnisses heisst, aus dem die Dateien gelesen werden sollen. |
+| `detection-type`                     | Mit diesem Parameter wird festgelegt, ob die Zuordnung zu den Vorgängen auf Basis von Barcodes erfolgen soll oder ob diese anhand der Dateibenennungen erfolgen soll. Als Werte stehen hier für `filename` für die Nutzung der Dateinamen und `barcode` für die Barcodeerkennung zur Verfügung. Wird als Wert `user` angegeben, erhält der Nutzer einer Auswahlmöglichkeit in der Bedienoberfläche. |
+| `copy-images-using-goobiscript`    | Sofern der Datentransfer im Hintergrund über die Warteschlangenfunktionalität von GoobiScript erfolgen soll, kann dies hier festgelegt werden. |
+| `allowed-step`                     | Legen Sie in diesem wiederholbaren Parameter fest, welcher Arbeitsschritt im ermittelten Vorgang sich gerade im Status `offen` befinden muss. |
+| `filename-part`                    | Mit diesem Parameter kann festgelegt werden, wie die Zuordnung der Dateinamen zu den Vorgängen erfolgen soll. |
+| `filename-separator`               | Geben Sie hier dasjenige Trennzeichen an, anhand dessen ein Prefix oder Suffix abgeschnitten werden soll. Somit kann festgelegt werden, dass z.B. aus einer Datei `kleiuniv_987654321_00002.tif` bei einer Zuordnung mittels`prefix`und dem Trennzeichen `_` ein Vorgang ermittelt werden soll, der `kleinuniv_987654321` heisst. |
+| `match-type`                       | Legen Sie hier fest, ob der das Matching der Vorgänge mittels `exact` über einen exakten Namen erfolgen soll oder mittels `contains` ob der Vorgangsname den Wert lediglich enthalten soll. |

docs/index_en.md

@@ -0,0 +1,68 @@
+---
+title: Mass upload
+identifier: intranda_workflow_massupload
+github: https://github.com/intranda/goobi-plugin-workflow-massupload
+description: This workflow plugin allows a mass upload of files with automatically assigned to the correct Goobi processes either on the basis of the file file names or on the basis of the analysed barcodes.
+published: true
+---
+
+## Introduction
+This workflow plugin allows the mass upload of files that are to be automatically assigned to the correct processes by Goobi workflow. The plugin provides its own interface for this purpose, which either allows uploading directly via the web interface or, alternatively, can also read images from the user directory. These images are checked by the plugin for their name in order to determine the corresponding Goobi process. If the process can be identified unambiguously and the Goobi process identified is also in the configured workflow step, the images are assigned to this step and the workflow is processed further.
+
+In addition to assigning the files based on the file name, it is also possible to configure an image analysis that reads barcodes instead. This makes it possible for images of several processes to be named consecutively, for example, and only a separator sheet needs to be included between the images. All images after such a separator sheet with an identifiable barcode are assigned to the respective process until the next barcode in the file stack is determined.
+
+## Installation
+To install the plugin, the following two files must be installed:
+
+```bash
+/opt/digiverso/goobi/plugins/workflow/plugin_intranda_workflow_massupload.jar
+/opt/digiverso/goobi/plugins/GUI/plugin_intranda_workflow_massupload-GUI.jar
+```
+
+To configure how the plugin should behave, various values can be adjusted in the configuration file. The configuration file is usually located here:
+
+```bash
+/opt/digiverso/goobi/config/plugin_intranda_workflow_massupload.xml
+```
+
+To use this plugin, the user must have the correct role authorisation.
+
+![The plugin cannot be used without correct authorisation](screen1_en.png)
+
+Therefore, please assign the role `Plugin_Goobi_Massupload` to the group.
+
+![Correctly assigned role for users](screen2_en.png)
+
+
+## Overview and functionality
+If the plugin has been installed and configured correctly, it can be found under the 'Workflow' menu item.
+
+![Open plugin for the upload](screen3_en.png)
+
+At this point, files can either be uploaded or read from the user directory. After analysing the file names or images, Goobi workflow shows which processes the uploaded images can be assigned to.
+
+![Analysed files with display of the associated processes](screen4_en.png)
+
+Click on the `Import files into processes` button to move the images to the directories of the recognised processes and continue the workflow.
+
+Please note: If barcodes are to be recognised in order to determine the processes, it is important that the barcodes are also available in sufficient size and quality for the recognition to be successful.
+
+![Digitised separator sheets with barcodes for automatic recognition](screen5_en.png)
+
+
+
+## Configuration
+The plugin is configured in the file `plugin_intranda_workflow_massupload.xml` as shown here:
+
+{{CONFIG_CONTENT}}
+
+| Value                               | Description of the                  |
+| ---------------------------------- | ----------------------------- |
+| `allowed-file-extensions`          | This parameter is used to specify which files may be uploaded. This is a regular expression. |
+| `user-folder-name`                 | If the files are to be read from the user directory, the name of the folder within the user directory from which the files are to be read can be specified here. |
+| `detection-type`                     | This parameter is used to specify whether the assignment to the processes should be based on barcodes or whether it should be based on the file names. The values available here are `filename` for the use of file names and `barcode` for barcode recognition. If the value " `user` is specified, the user is given a selection option in the user interface. |
+| `copy-images-using-goobiscript`    | If data transfer is to take place in the background using the GoobiScript queue functionality, this can be specified here. |
+| `allowed-step`                     | Use this repeatable parameter to specify which work step in the determined process must currently be in the `open` status. |
+| `filename-part`                    | This parameter can be used to specify how the file names are to be assigned to the processes. |
+| `filename-separator`               | Specify the separator that is to be used to truncate a prefix or suffix. This allows you to specify that, for example, an operation called `kleiuniv_987654321` is to be determined from a file named `kleiuniv_987654321_00002.tif` when an assignment is made using `prefix` and the separator `_`. |
+| `match-type`                       | Specify here whether the matching of the processes should be carried out using `exact` via an exact name or using `contains` whether the process name should only contain the value. |

install/plugin_intranda_workflow_massupload.xml

@@ -6,8 +6,11 @@
 	<!-- name of the folder inside of a users home directory to use as alternative for web upload -->
 	<user-folder-name>mass_upload</user-folder-name>
 
-	<!-- define if instead of the file naming a barcode shall be analyzed to match the following images to the corresponding process until the next barcode  gets recognized -->
-	<use-barcodes>false</use-barcodes>
+	<!-- define the method how to detect the processes from the uploaded images the following methods are available:
+		- "filename" to use the filenames for matching the right Goobi processes
+		- "barcode" to detect barcodes inside of the images to assign to the right Goobi processes up to the next barcode page
+		- "user" to let the user decide between filename or barcode detection -->
+	<detection-type>filename</detection-type>
 
 	<!-- copy images using goobi script in the background (true or false) -->
 	<copy-images-using-goobiscript>false</copy-images-using-goobiscript>

module-base/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-workflow-mass-upload</artifactId>
-    <version>24.05</version>
+    <version>24.06</version>
   </parent>
   <artifactId>plugin-workflow-mass-upload-base</artifactId>
   <packaging>jar</packaging>

module-base/src/main/java/de/intranda/goobi/plugins/MassUploadPlugin.java

@@ -97,8 +97,9 @@ public class MassUploadPlugin implements IWorkflowPlugin, IPlugin {
     private volatile boolean analyzingBarcodes = false;
     private boolean currentlyInserting;
     private boolean hideInsertButtonAfterClick = false;
+    private String detectionType;
 
-    private boolean useBarcodesDefault = false;
+    //        private boolean useBarcodesDefault = false;
     private String[] insertModes = { "plugin_massupload_insertmode_imageName", "plugin_massupload_insertmode_barcode" };
     private String insertMode = "plugin_massupload_insertmode_imageName";
 
@@ -117,8 +118,10 @@ public MassUploadPlugin() {
         filenameSeparator = config.getString("filename-separator", "_").toLowerCase();
         stepTitles = Arrays.asList(config.getStringArray("allowed-step"));
         copyImagesViaGoobiScript = config.getBoolean("copy-images-using-goobiscript", false);
-        boolean useBarcodes = config.getBoolean("use-barcodes", false);
-        if (useBarcodes) {
+        detectionType = config.getString("detection-type", "filename").toLowerCase();
+
+        //        boolean useBarcodes = config.getBoolean("use-barcodes", false);
+        if ("barcode".equals(detectionType)) {
             insertMode = "plugin_massupload_insertmode_barcode";
         }
         barcodePool = Executors.newFixedThreadPool(2);
@@ -269,7 +272,15 @@ public void readFilesFromUserHomeFolder() {
                         if (!Files.isDirectory(file) && !".DS_Store".equals(file.getFileName().toString())) {
                             MassUploadedFile muf = new MassUploadedFile(file.toFile(), file.getFileName().toString());
                             if ("plugin_massupload_insertmode_barcode".equals(insertMode)) {
-                                assignProcessByFilename(muf, searchCache);
+                                Callable<String> readBarcodeTask = () -> readBarcode(muf.getFile(), BarcodeFormat.CODE_128);
+                                Future<String> futureBarcode = this.barcodePool.submit(readBarcodeTask);
+                                String barcodeInfo = null;
+                                barcodeInfo = futureBarcode.get();
+                                muf.setCheckedForBarcode(true);
+
+                                muf.setBarcodeValue(Optional.ofNullable(barcodeInfo));
+                            } else {
+                                assignProcessByFilename(muf, null);
                             }
                             uploadedFiles.add(muf);
                         }

module-gui/pom.xml

@@ -3,7 +3,7 @@
   <parent>
     <groupId>io.goobi.workflow.plugin</groupId>
     <artifactId>plugin-workflow-mass-upload</artifactId>
-    <version>24.05</version>
+    <version>24.06</version>
   </parent>
   <artifactId>plugin-workflow-mass-upload-gui</artifactId>
   <packaging>jar</packaging>