Prevent deleting ImportConfigurations that are assigned as project de…

…fault configurations
kitodo · Jul 5, 2022 · 3b84d2f · 3b84d2f
1 parent 7b7e21d
commit 3b84d2f
Show file tree

Hide file tree

Showing 5 changed files with 62 additions and 0 deletions.
diff --git a/Kitodo/src/main/java/org/kitodo/exceptions/ImportConfigurationInUseException.java b/Kitodo/src/main/java/org/kitodo/exceptions/ImportConfigurationInUseException.java
@@ -0,0 +1,33 @@
+/*
+ * (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.exceptions;
+
+import org.kitodo.production.helper.Helper;
+
+/**
+ * This exception is thrown when the user tries to delete an ImportConfiguration that is currently in use.
+ */
+public class ImportConfigurationInUseException extends RuntimeException {
+
+    private static final String CONFIG_IN_USE = "importConfig.assignedAsDefaultConfig";
+
+    /**
+     * Constructor with message.
+     *
+     * @param configurationTitle title of the ImportConfiguration
+     * @param projectTitle title of the Project to which the ImportConfiguration is assigned as default configuration
+     */
+    public ImportConfigurationInUseException(String configurationTitle, String projectTitle) {
+        super(Helper.getTranslation(CONFIG_IN_USE, configurationTitle, projectTitle));
+    }
+
+}
diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/ImportConfigurationListView.java b/Kitodo/src/main/java/org/kitodo/production/forms/ImportConfigurationListView.java
@@ -22,6 +22,7 @@
 import org.apache.logging.log4j.Logger;
 import org.kitodo.data.database.beans.ImportConfiguration;
 import org.kitodo.data.database.exceptions.DAOException;
+import org.kitodo.exceptions.ImportConfigurationInUseException;
 import org.kitodo.production.enums.ObjectType;
 import org.kitodo.production.helper.Helper;
 import org.kitodo.production.services.ServiceManager;
@@ -67,6 +68,10 @@ public void deleteById(int id) {
             ServiceManager.getImportConfigurationService().removeFromDatabase(id);
         } catch (DAOException e) {
             Helper.setErrorMessage(ERROR_DELETING, new Object[] {ObjectType.IMPORT_CONFIGURATION.getTranslationSingular() }, logger, e);
+        } catch (ImportConfigurationInUseException e) {
+            Helper.setErrorMessage(
+                    Helper.getTranslation(ERROR_DELETING, ObjectType.IMPORT_CONFIGURATION.getTranslationSingular()),
+                    e.getMessage());
         }
     }
 }
diff --git a/Kitodo/src/main/java/org/kitodo/production/services/data/ImportConfigurationService.java b/Kitodo/src/main/java/org/kitodo/production/services/data/ImportConfigurationService.java
@@ -16,9 +16,12 @@
 import java.util.Objects;
 
 import org.kitodo.data.database.beans.ImportConfiguration;
+import org.kitodo.data.database.beans.Project;
 import org.kitodo.data.database.exceptions.DAOException;
 import org.kitodo.data.database.persistence.ImportConfigurationDAO;
 import org.kitodo.data.exceptions.DataException;
+import org.kitodo.exceptions.ImportConfigurationInUseException;
+import org.kitodo.production.services.ServiceManager;
 import org.kitodo.production.services.data.base.SearchDatabaseService;
 import org.primefaces.model.SortOrder;
 
@@ -89,4 +92,23 @@ public Long countDatabaseRows() throws DAOException {
     public Long countResults(Map filters) throws DAOException, DataException {
         return countDatabaseRows();
     }
+
+    /**
+     * Delete import configuration identified by ID. If the corresponding configuration is currently used as default
+     * configuration for a project, an exception is thrown.
+     * @param id of import configuration to delete
+     * @throws DAOException if import configuration could not be deleted from database
+     * @throws ImportConfigurationInUseException if import configuration is assigned as default configuration to at
+     *         least one project
+     */
+    @Override
+    public void removeFromDatabase(Integer id) throws DAOException, ImportConfigurationInUseException {
+        for (Project project : ServiceManager.getProjectService().getAll()) {
+            ImportConfiguration defaultConfiguration = project.getDefaultImportConfiguration();
+            if (Objects.nonNull(defaultConfiguration) && Objects.equals(defaultConfiguration.getId(), id)) {
+                throw new ImportConfigurationInUseException(defaultConfiguration.getTitle(), project.getTitle());
+            }
+        }
+        dao.remove(id);
+    }
 }
diff --git a/Kitodo/src/main/resources/messages/messages_de.properties b/Kitodo/src/main/resources/messages/messages_de.properties
@@ -529,6 +529,7 @@ images=Bilder
 imagesRead=Images lesen
 imagesWrite=Images schreiben
 importConfig.addSearchField=Suchfeld hinzuf\u00fcgen
+importConfig.assignedAsDefaultConfig=Importkonfiguration ''{0}'' wird derzeit als Standardkonfiguration von Projekt ''{1}'' verwendet!
 importConfig.configuration=Importkonfiguration
 importConfig.configurations=Importkonfigurationen
 importConfig.defaultConfiguration=Default-Konfiguration

diff --git a/Kitodo/src/main/resources/messages/messages_en.properties b/Kitodo/src/main/resources/messages/messages_en.properties
@@ -542,6 +542,7 @@ imagesRead=Read images
 imagesWrite=Write images
 importChildren=Import child processes
 importConfig.addSearchField=Add search field
+importConfig.assignedAsDefaultConfig=Import configuration ''{0}'' is configured as default configuration of project ''{1}''!
 importConfig.configuration=Import configuration
 importConfig.configurations=Import configurations
 importConfig.defaultConfiguration=Default configuration