[DURACOM-457] Port Bulk Import feature from DSpace-CRIS

Adds Excel-based bulk import functionality for creating, updating, and deleting items. Supports metadata groups, bitstreams, authority
references, security levels, and collection export. Fully integrated into CLI and REST APIs without CRIS dependencies.

Author: AdamF42

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImport.java

@@ -0,0 +1,45 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import java.sql.SQLException;
+
+import org.apache.commons.cli.ParseException;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+import org.dspace.eperson.factory.EPersonServiceFactory;
+
+/**
+ * Extension of {@link BulkImport} for CLI.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class BulkImportCli extends BulkImport {
+
+    @Override
+    protected void assignCurrentUserInContext(Context context) throws ParseException {
+        if (commandLine.hasOption('e')) {
+            String ePersonEmail = commandLine.getOptionValue('e');
+            try {
+                EPerson ePerson =
+                    EPersonServiceFactory.getInstance().getEPersonService().findByEmail(context, ePersonEmail);
+                if (ePerson == null) {
+                    super.handler.logError("EPerson not found: " + ePersonEmail);
+                    throw new IllegalArgumentException("Unable to find a user with email: " + ePersonEmail);
+                }
+                context.setCurrentUser(ePerson);
+            } catch (SQLException e) {
+                throw new IllegalArgumentException("SQLException trying to find user with email: " + ePersonEmail);
+            }
+        } else {
+            throw new ParseException("Required parameter -e missing!");
+        }
+    }
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImportCli.java

@@ -0,0 +1,29 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import org.apache.commons.cli.Options;
+
+/**
+ * Extension of {@link BulkImportScriptConfiguration} for CLI.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class BulkImportCliScriptConfiguration<T extends BulkImportCli> extends BulkImportScriptConfiguration<T> {
+
+    @Override
+    public Options getOptions() {
+        Options options = super.getOptions();
+        options.addOption("e", "email", true, "email address of user");
+        options.getOption("e").setRequired(true);
+        super.options = options;
+        return options;
+    }
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImportCliScriptConfiguration.java

@@ -0,0 +1,82 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import java.io.InputStream;
+import java.sql.SQLException;
+import java.util.List;
+
+import org.apache.commons.cli.Options;
+import org.dspace.authorize.service.AuthorizeService;
+import org.dspace.core.Context;
+import org.dspace.scripts.DSpaceCommandLineParameter;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * Script configuration for {@link BulkImport}.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ * @param  <T> the {@link BulkImport} type
+ */
+public class BulkImportScriptConfiguration<T extends BulkImport> extends ScriptConfiguration<T> {
+
+    @Autowired
+    private AuthorizeService authorizeService;
+
+    private Class<T> dspaceRunnableClass;
+
+    @Override
+    public boolean isAllowedToExecute(Context context, List<DSpaceCommandLineParameter> commandLineParameters) {
+        try {
+            return authorizeService.isCollectionAdmin(context) || authorizeService.isAdmin(context);
+        } catch (SQLException e) {
+            throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e);
+        }
+    }
+
+    @Override
+    public Options getOptions() {
+        if (options == null) {
+            Options options = new Options();
+
+            options.addOption("c", "collection", true, "the own collection of the imported items");
+            options.getOption("c").setType(String.class);
+            options.getOption("c").setRequired(true);
+
+            options.addOption("f", "file", true, "source file");
+            options.getOption("f").setType(InputStream.class);
+            options.getOption("f").setRequired(true);
+
+            options.addOption("er", "concludeOnError", false, "conclude the import at the first error");
+            options.getOption("er").setType(boolean.class);
+            options.getOption("er").setRequired(false);
+
+            super.options = options;
+        }
+        return options;
+    }
+
+    @Override
+    public Class<T> getDspaceRunnableClass() {
+        return dspaceRunnableClass;
+    }
+
+    /**
+     * Generic setter for the dspaceRunnableClass
+     *
+     * @param dspaceRunnableClass The dspaceRunnableClass to be set on this
+     *                            BulkImportScriptConfiguration
+     */
+    @Override
+    public void setDspaceRunnableClass(Class<T> dspaceRunnableClass) {
+        this.dspaceRunnableClass = dspaceRunnableClass;
+    }
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImportScriptConfiguration.java

@@ -0,0 +1,50 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+
+import org.apache.poi.ss.usermodel.Sheet;
+
+/**
+ * Enum that identifies the type of a bulk import excel sheet.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public enum BulkImportSheetType {
+
+    /**
+     * The type of the main sheet of the Bulk Import excel.
+     */
+    ENTITY_ROWS,
+
+    /**
+     * The type of the sheets with nested metadata groups.
+     */
+    METADATA_GROUPS,
+
+    /**
+     * The type of the sheet with the bitstream access condition and metadata
+     * fields.
+     */
+    BITSTREAMS;
+
+    public static BulkImportSheetType getTypeFromSheet(Sheet sheet) {
+
+        if (sheet.getWorkbook().getSheetIndex(sheet) == 0) {
+            return BulkImportSheetType.ENTITY_ROWS;
+        }
+
+        if (BulkImport.BITSTREAMS_SHEET_NAME.equalsIgnoreCase(sheet.getSheetName())) {
+            return BulkImportSheetType.BITSTREAMS;
+        }
+
+        return BulkImportSheetType.METADATA_GROUPS;
+
+    }
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImportSheetType.java

@@ -0,0 +1,43 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+import java.util.Map;
+
+import org.dspace.content.vo.MetadataValueVO;
+import org.dspace.core.Context;
+
+/**
+ * The purpose of this class is to manage MetadataValueVO transformations.
+ * 
+ * @author Mykhaylo Boychuk (mykhaylo.boychuk at 4science.it)
+ */
+public class BulkImportTransformerService {
+
+    private Map<String, BulkImportValueTransformer> field2ValueTransformer;
+
+    public BulkImportTransformerService (Map<String, BulkImportValueTransformer> field2ValueTransformer) {
+        this.field2ValueTransformer = field2ValueTransformer;
+    }
+
+    public MetadataValueVO converter(Context context, String field, MetadataValueVO metadataValue) {
+        if (field2ValueTransformer.containsKey(field)) {
+            BulkImportValueTransformer transformer = field2ValueTransformer.get(field);
+            return transformer.transform(context, metadataValue);
+        }
+        return metadataValue;
+    }
+
+    public Map<String, BulkImportValueTransformer> getField2ValueTransformer() {
+        return field2ValueTransformer;
+    }
+
+    public void setField2ValueTransformer(Map<String, BulkImportValueTransformer> field2ValueTransformer) {
+        this.field2ValueTransformer = field2ValueTransformer;
+    }
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImportTransformerService.java

@@ -0,0 +1,19 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkedit;
+import org.dspace.content.vo.MetadataValueVO;
+import org.dspace.core.Context;
+
+/**
+ * @author Mykhaylo Boychuk (mykhaylo.boychuk at 4science.it)
+ */
+public interface BulkImportValueTransformer {
+
+    MetadataValueVO transform(Context context, MetadataValueVO metadataValue);
+
+}

dspace-api/src/main/java/org/dspace/app/bulkedit/BulkImportValueTransformer.java

@@ -190,10 +190,10 @@ public void internalRun() throws Exception {
         // Create a context
         Context c = null;
         c = new Context();
-        c.turnOffAuthorisationSystem();
 
         // Find the EPerson, assign to context
         assignCurrentUserInContext(c);
+        assignSpecialGroupsInContext(c);
 
         if (authorityControlled == null) {
             setAuthorizedMetadataFields();
@@ -218,6 +218,7 @@ public void internalRun() throws Exception {
         initMetadataImport(csv);
         List<BulkEditChange> changes;
 
+        handleAuthorizationSystem(c);
         if (!commandLine.hasOption('s') || validateOnly) {
             // See what has changed
             try {
@@ -261,7 +262,7 @@ public void internalRun() throws Exception {
             }
 
             // Finish off and tidy up
-            c.restoreAuthSystemState();
+            handleAuthorizationSystem(c);
             c.complete();
         } catch (Exception e) {
             c.abort();
@@ -283,6 +284,12 @@ protected void assignCurrentUserInContext(Context context) throws ParseException
         }
     }
 
+    private void assignSpecialGroupsInContext(Context context) throws SQLException {
+        for (UUID uuid : handler.getSpecialGroups()) {
+            context.setSpecialGroup(uuid);
+        }
+    }
+
     /**
      * This method determines whether the changes should be applied or not. This is default set to true for the REST
      * script as we don't want to interact with the caller. This will be overwritten in the CLI script to ask for

dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java

@@ -0,0 +1,48 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.bulkimport.exception;
+
+/**
+ * Exception for errors that occurs during the items bulk import via excel.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class BulkImportException extends RuntimeException {
+
+    private static final long serialVersionUID = -74730626862418515L;
+
+    /**
+     * Constructor with error message and cause.
+     *
+     * @param message the error message
+     * @param cause   the error cause
+     */
+    public BulkImportException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    /**
+     * Constructor with error message.
+     *
+     * @param message the error message
+     */
+    public BulkImportException(String message) {
+        super(message);
+    }
+
+    /**
+     * Constructor with error cause.
+     *
+     * @param cause the error cause
+     */
+    public BulkImportException(Throwable cause) {
+        super(cause);
+    }
+
+}