task: backup existing ALTO results instead of deleting them

Author: Dominick Leppich

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

@@ -13,8 +13,6 @@ public class TranscriptionImage {
     private Image image;
     private String ocrText;
     private Path ocrPath;
-    private boolean hasAlto;
-    private Path altoPath;
 
     public void setOcrText(String text) {
         this.ocrText = text;

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

@@ -34,6 +34,7 @@
 import org.apache.commons.configuration.SubnodeConfiguration;
 import org.apache.commons.io.FilenameUtils;
 import org.goobi.beans.Step;
+import org.goobi.io.BackupFileManager;
 import org.goobi.managedbeans.StepBean;
 import org.goobi.production.enums.PluginGuiType;
 import org.goobi.production.enums.PluginReturnValue;
@@ -95,9 +96,6 @@ public class TranscriptionStepPlugin implements IStepPluginVersion2 {
     private List<String> deletionCommand = null;
     @Getter
     private boolean altoFolderFound;
-    @Getter
-    @Setter
-    private boolean ignoreAltoFolder;
 
     @Override
     public void initialize(Step step, String returnPath) {
@@ -145,18 +143,15 @@ public void initImageList(String configuredImageFolder) throws SwapException, DA
         images.clear();
         Path path = Paths.get(imageFolder);
         String ocrTxtDir = step.getProzess().getOcrTxtDirectory();
-        String ocrAltoDir = step.getProzess().getOcrAltoDirectory();
         if (StorageProvider.getInstance().isFileExists(path)) {
             List<Path> imageNameList = storageProvider.listFiles(imageFolder, NIOFileUtils.imageOrObjectNameFilter);
             int order = 1;
             for (Path imagePath : imageNameList) {
                 Image image = new Image(step.getProzess(), configuredImageFolder, imagePath.getFileName().toString(), order, 800);
                 String basename = FilenameUtils.removeExtension(imagePath.getFileName().toString());
                 Path ocrFile = Paths.get(ocrTxtDir, basename + ".txt");
-                Path altoPath = Paths.get(ocrAltoDir, basename + ".xml");
-                boolean hasAlto = Files.exists(altoPath);
                 String currentOcr = readOcrFile(ocrFile);
-                images.add(new TranscriptionImage(imagePath.getFileName().toString(), image, currentOcr, ocrFile, hasAlto, altoPath));
+                images.add(new TranscriptionImage(imagePath.getFileName().toString(), image, currentOcr, ocrFile));
                 order++;
             }
         }
@@ -166,18 +161,30 @@ public void initImageList(String configuredImageFolder) throws SwapException, DA
         this.setImageToIndex();
     }
 
-    public void deleteSingleAltoResult() throws IOException {
-        Files.deleteIfExists(image.getAltoPath());
-        image.setHasAlto(false);
-    }
-
-    public void deleteAltoFolder() throws SwapException, DAOException, IOException, InterruptedException {
-        String altoDir = step.getProzess().getOcrAltoDirectory();
-        StorageProvider.getInstance().deleteDir(Paths.get(altoDir));
-        for (TranscriptionImage image : this.images) {
-            image.setHasAlto(false);
+    public void backupAlto() {
+        if (!this.isAltoFolderFound()) {
+            return;
+        }
+        try {
+            StorageProviderInterface sp = StorageProvider.getInstance();
+            Path ocrFolder = Path.of(step.getProzess().getOcrDirectory());
+            if (sp.isFileExists(ocrFolder)) {
+                Path backupPath = Paths.get(ocrFolder.getParent().toString(), BackupFileManager.generateBackupName(ocrFolder.getFileName().toString()));
+                sp.copyDirectory(ocrFolder, backupPath);
+                String directoryToKeep = step.getProzess().getOcrTxtDirectory();
+                if (directoryToKeep.endsWith("/")) {
+                    directoryToKeep = directoryToKeep.substring(0, directoryToKeep.length() - 1);
+                }
+                for (Path dir : sp.listFiles(ocrFolder.toString())) {
+                    if (!dir.toString().equals(directoryToKeep)) {
+                        sp.deleteDir(dir);
+                    }
+                }
+            }
+            this.altoFolderFound = false;
+        } catch (IOException | SwapException e) {
+            log.error("Error backing up Alto results", e);
         }
-        this.altoFolderFound = false;
     }
 
     public String saveOcrAndExit() throws IOException {

module-gui/src/main/webapp/resources/uii/plugin_step_transcription.xhtml

@@ -139,23 +139,19 @@
                 </div>
 
                 <div class="box-content">
-                    <ui:fragment rendered="#{AktuelleSchritteForm.myPlugin.altoFolderFound and not AktuelleSchritteForm.myPlugin.ignoreAltoFolder}">
+                    <ui:fragment rendered="#{AktuelleSchritteForm.myPlugin.altoFolderFound}">
                         <div class="row">
                             <div class="col-md-6 col-md-offset-3">
                                 <div class="alert alert-warning">
                                   <h:outputText escape="false" value="#{msgs.plugin_transcription_warning_alto}" />
                                 </div>
                                 <p>#{msgs.plugin_transcription_warning_alto_text1}</p>
                                 <p>#{msgs.plugin_transcription_warning_alto_text2}</p>
-                                <h:commandLink styleClass="btn">
-                                    #{msgs.ignore}
-                                    <f:setPropertyActionListener value="true" target="#{AktuelleSchritteForm.myPlugin.ignoreAltoFolder}"></f:setPropertyActionListener>
-                                </h:commandLink>
-                                <h:commandLink styleClass="btn btn-danger pull-right" action="#{AktuelleSchritteForm.myPlugin.deleteAltoFolder}">#{msgs.plugin_transcription_deleteAltoFolder}</h:commandLink>
+                                <h:commandLink styleClass="btn btn-success pull-right" action="#{AktuelleSchritteForm.myPlugin.backupAlto}">#{msgs.plugin_transcription_overwriteExistingOCR}</h:commandLink>
                             </div>
                         </div>
                     </ui:fragment>
-                    <ui:fragment rendered="#{AktuelleSchritteForm.myPlugin.ignoreAltoFolder or not AktuelleSchritteForm.myPlugin.altoFolderFound}">
+                    <ui:fragment rendered="#{not AktuelleSchritteForm.myPlugin.altoFolderFound}">
                         <div class="row transcription-row">
 
                             <f:subview id="first_image">
@@ -172,16 +168,6 @@
                                 </div>
                             </div>
                             <div class="col-md-6 transcription-editor-col">
-                                <h:panelGroup styleClass="blocker" rendered="#{AktuelleSchritteForm.myPlugin.image.hasAlto}">
-                                    <div class="alert alert-warning">
-                                      <h:outputText escape="false" value="#{msgs.plugin_transcription_warning_single_alto}" />
-                                    </div>
-                                        <div>
-                                      <h:commandLink styleClass="btn btn-danger pull-right" action="#{AktuelleSchritteForm.myPlugin.deleteSingleAltoResult}">
-                                        #{msgs.plugin_transcription_deleteSingleAltoResult}
-                                        </h:commandLink>
-                                      </div>
-                                </h:panelGroup>
                                 <textarea class="ocr-text" id="textarea_0">
                                     #{AktuelleSchritteForm.myPlugin.image.ocrText}
                                 </textarea>