policies = authorizeService
+ .getPoliciesActionFilter(context, bitstream, Constants.READ);
+
+ // Looks at all read policies.
+ for (ResourcePolicy policy : policies) {
+ boolean isValid = resourcePolicyService.isDateValid(policy);
+ Group group = policy.getGroup();
+
+ if (group != null && StringUtils.equals(group.getName(), Group.ANONYMOUS)) {
+ // Only calculate the status for the anonymous group.
+ if (!isValid) {
+ // If the policy is not valid there is an active embargo
+ Date startDate = policy.getStartDate();
+
+ if (startDate != null && !startDate.before(LocalDate.now().toDate())) {
+ // There is an active embargo: aim to take the shortest embargo (account for rare cases where
+ // more than one resource policy exists)
+ if (embargoDate == null) {
+ embargoDate = startDate;
+ } else {
+ embargoDate = startDate.before(embargoDate) ? startDate : embargoDate;
+ }
+ }
+ }
+ }
+ }
+
+ return embargoDate;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/access/status/factory/AccessStatusServiceFactory.java b/dspace-api/src/main/java/org/dspace/access/status/factory/AccessStatusServiceFactory.java
new file mode 100644
index 000000000000..77d8f6b44876
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/access/status/factory/AccessStatusServiceFactory.java
@@ -0,0 +1,25 @@
+/**
+ * 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.access.status.factory;
+
+import org.dspace.access.status.service.AccessStatusService;
+import org.dspace.services.factory.DSpaceServicesFactory;
+
+/**
+ * Abstract factory to get services for the access status package,
+ * use AccessStatusServiceFactory.getInstance() to retrieve an implementation.
+ */
+public abstract class AccessStatusServiceFactory {
+
+ public abstract AccessStatusService getAccessStatusService();
+
+ public static AccessStatusServiceFactory getInstance() {
+ return DSpaceServicesFactory.getInstance().getServiceManager()
+ .getServiceByName("accessStatusServiceFactory", AccessStatusServiceFactory.class);
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/access/status/factory/AccessStatusServiceFactoryImpl.java b/dspace-api/src/main/java/org/dspace/access/status/factory/AccessStatusServiceFactoryImpl.java
new file mode 100644
index 000000000000..fe3848cb2b21
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/access/status/factory/AccessStatusServiceFactoryImpl.java
@@ -0,0 +1,26 @@
+/**
+ * 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.access.status.factory;
+
+import org.dspace.access.status.service.AccessStatusService;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * Factory implementation to get services for the access status package,
+ * use AccessStatusServiceFactory.getInstance() to retrieve an implementation.
+ */
+public class AccessStatusServiceFactoryImpl extends AccessStatusServiceFactory {
+
+ @Autowired(required = true)
+ private AccessStatusService accessStatusService;
+
+ @Override
+ public AccessStatusService getAccessStatusService() {
+ return accessStatusService;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/access/status/package-info.java b/dspace-api/src/main/java/org/dspace/access/status/package-info.java
new file mode 100644
index 000000000000..2c0ed22cd4a9
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/access/status/package-info.java
@@ -0,0 +1,30 @@
+/**
+ * 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/
+ */
+/**
+ *
+ * Access status allows the users to view the bitstreams availability before
+ * browsing into the item itself.
+ *
+ *
+ * The access status is calculated through a pluggable class:
+ * {@link org.dspace.access.status.AccessStatusHelper}.
+ * The {@link org.dspace.access.status.AccessStatusServiceImpl}
+ * must be configured to specify this class, as well as a forever embargo date
+ * threshold year, month and day.
+ *
+ *
+ * See {@link org.dspace.access.status.DefaultAccessStatusHelper} for a simple calculation
+ * based on the primary or the first bitstream of the original bundle. You can
+ * supply your own class to implement more complex access statuses.
+ *
+ *
+ * For now, the access status is calculated when the item is shown in a list.
+ *
+ */
+
+package org.dspace.access.status;
diff --git a/dspace-api/src/main/java/org/dspace/access/status/service/AccessStatusService.java b/dspace-api/src/main/java/org/dspace/access/status/service/AccessStatusService.java
new file mode 100644
index 000000000000..2ed47bde4cd2
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/access/status/service/AccessStatusService.java
@@ -0,0 +1,57 @@
+/**
+ * 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.access.status.service;
+
+import java.sql.SQLException;
+
+import org.dspace.content.Item;
+import org.dspace.core.Context;
+
+/**
+ * Public interface to the access status subsystem.
+ *
+ * Configuration properties: (with examples)
+ * {@code
+ * # values for the forever embargo date threshold
+ * # This threshold date is used in the default access status helper to dermine if an item is
+ * # restricted or embargoed based on the start date of the primary (or first) file policies.
+ * # In this case, if the policy start date is inferior to the threshold date, the status will
+ * # be embargo, else it will be restricted.
+ * # You might want to change this threshold based on your needs. For example: some databases
+ * # doesn't accept a date superior to 31 december 9999.
+ * access.status.embargo.forever.year = 10000
+ * access.status.embargo.forever.month = 1
+ * access.status.embargo.forever.day = 1
+ * # implementation of access status helper plugin - replace with local implementation if applicable
+ * # This default access status helper provides an item status based on the policies of the primary
+ * # bitstream (or first bitstream in the original bundles if no primary file is specified).
+ * plugin.single.org.dspace.access.status.AccessStatusHelper = org.dspace.access.status.DefaultAccessStatusHelper
+ * }
+ */
+public interface AccessStatusService {
+
+ /**
+ * Calculate the access status for an Item while considering the forever embargo date threshold.
+ *
+ * @param context the DSpace context
+ * @param item the item
+ * @return an access status value
+ * @throws SQLException An exception that provides information on a database access error or other errors.
+ */
+ public String getAccessStatus(Context context, Item item) throws SQLException;
+
+ /**
+ * Retrieve embargo information for the item
+ *
+ * @param context the DSpace context
+ * @param item the item to check for embargo information
+ * @return an embargo date
+ * @throws SQLException An exception that provides information on a database access error or other errors.
+ */
+ public String getEmbargoFromItem(Context context, Item item) throws SQLException;
+}
diff --git a/dspace-api/src/main/java/org/dspace/administer/CreateAdministrator.java b/dspace-api/src/main/java/org/dspace/administer/CreateAdministrator.java
index 80d69f3b661b..81250e9c8259 100644
--- a/dspace-api/src/main/java/org/dspace/administer/CreateAdministrator.java
+++ b/dspace-api/src/main/java/org/dspace/administer/CreateAdministrator.java
@@ -14,6 +14,7 @@
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
+import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.lang3.StringUtils;
import org.dspace.core.Context;
@@ -54,14 +55,14 @@ public final class CreateAdministrator {
protected GroupService groupService;
/**
- * For invoking via the command line. If called with no command line arguments,
+ * For invoking via the command line. If called with no command line arguments,
* it will negotiate with the user for the administrator details
*
* @param argv the command line arguments given
* @throws Exception if error
*/
public static void main(String[] argv)
- throws Exception {
+ throws Exception {
CommandLineParser parser = new DefaultParser();
Options options = new Options();
@@ -69,19 +70,41 @@ public static void main(String[] argv)
options.addOption("e", "email", true, "administrator email address");
options.addOption("f", "first", true, "administrator first name");
+ options.addOption("h", "help", false, "explain create-administrator options");
options.addOption("l", "last", true, "administrator last name");
options.addOption("c", "language", true, "administrator language");
options.addOption("p", "password", true, "administrator password");
- CommandLine line = parser.parse(options, argv);
+ CommandLine line = null;
+
+ try {
+
+ line = parser.parse(options, argv);
+
+ } catch (Exception e) {
+
+ System.out.println(e.getMessage() + "\nTry \"dspace create-administrator -h\" to print help information.");
+ System.exit(1);
+
+ }
if (line.hasOption("e") && line.hasOption("f") && line.hasOption("l") &&
- line.hasOption("c") && line.hasOption("p")) {
+ line.hasOption("c") && line.hasOption("p")) {
ca.createAdministrator(line.getOptionValue("e"),
- line.getOptionValue("f"), line.getOptionValue("l"),
- line.getOptionValue("c"), line.getOptionValue("p"));
+ line.getOptionValue("f"), line.getOptionValue("l"),
+ line.getOptionValue("c"), line.getOptionValue("p"));
+ } else if (line.hasOption("h")) {
+ String header = "\nA command-line tool for creating an initial administrator for setting up a" +
+ " DSpace site. Unless all the required parameters are passed it will" +
+ " prompt for an e-mail address, last name, first name and password from" +
+ " standard input.. An administrator group is then created and the data passed" +
+ " in used to create an e-person in that group.\n\n";
+ String footer = "\n";
+ HelpFormatter formatter = new HelpFormatter();
+ formatter.printHelp("dspace create-administrator", header, options, footer, true);
+ return;
} else {
- ca.negotiateAdministratorDetails();
+ ca.negotiateAdministratorDetails(line);
}
}
@@ -91,7 +114,7 @@ public static void main(String[] argv)
* @throws Exception if error
*/
protected CreateAdministrator()
- throws Exception {
+ throws Exception {
context = new Context();
groupService = EPersonServiceFactory.getInstance().getGroupService();
ePersonService = EPersonServiceFactory.getInstance().getEPersonService();
@@ -103,20 +126,20 @@ protected CreateAdministrator()
*
* @throws Exception if error
*/
- protected void negotiateAdministratorDetails()
- throws Exception {
+ protected void negotiateAdministratorDetails(CommandLine line)
+ throws Exception {
Console console = System.console();
System.out.println("Creating an initial administrator account");
- boolean dataOK = false;
-
- String email = null;
- String firstName = null;
- String lastName = null;
- char[] password1 = null;
- char[] password2 = null;
+ String email = line.getOptionValue('e');
+ String firstName = line.getOptionValue('f');
+ String lastName = line.getOptionValue('l');
String language = I18nUtil.getDefaultLocale().getLanguage();
+ ConfigurationService cfg = DSpaceServicesFactory.getInstance().getConfigurationService();
+ boolean flag = line.hasOption('p');
+ char[] password = null;
+ boolean dataOK = line.hasOption('f') && line.hasOption('e') && line.hasOption('l');
while (!dataOK) {
System.out.print("E-mail address: ");
@@ -147,8 +170,6 @@ protected void negotiateAdministratorDetails()
if (lastName != null) {
lastName = lastName.trim();
}
-
- ConfigurationService cfg = DSpaceServicesFactory.getInstance().getConfigurationService();
if (cfg.hasProperty("webui.supported.locales")) {
System.out.println("Select one of the following languages: "
+ cfg.getProperty("webui.supported.locales"));
@@ -163,46 +184,59 @@ protected void negotiateAdministratorDetails()
}
}
- System.out.println("Password will not display on screen.");
- System.out.print("Password: ");
+ System.out.print("Is the above data correct? (y or n): ");
System.out.flush();
- password1 = console.readPassword();
+ String s = console.readLine();
- System.out.print("Again to confirm: ");
- System.out.flush();
+ if (s != null) {
+ s = s.trim();
+ if (s.toLowerCase().startsWith("y")) {
+ dataOK = true;
+ }
+ }
+
+ }
+ if (!flag) {
+ password = getPassword(console);
+ if (password == null) {
+ return;
+ }
+ } else {
+ password = line.getOptionValue("p").toCharArray();
+ }
+ // if we make it to here, we are ready to create an administrator
+ createAdministrator(email, firstName, lastName, language, String.valueOf(password));
- password2 = console.readPassword();
+ }
- //TODO real password validation
- if (password1.length > 1 && Arrays.equals(password1, password2)) {
- // password OK
- System.out.print("Is the above data correct? (y or n): ");
- System.out.flush();
+ private char[] getPassword(Console console) {
+ char[] password1 = null;
+ char[] password2 = null;
+ System.out.println("Password will not display on screen.");
+ System.out.print("Password: ");
+ System.out.flush();
- String s = console.readLine();
+ password1 = console.readPassword();
- if (s != null) {
- s = s.trim();
- if (s.toLowerCase().startsWith("y")) {
- dataOK = true;
- }
- }
- } else {
- System.out.println("Passwords don't match");
- }
- }
+ System.out.print("Again to confirm: ");
+ System.out.flush();
- // if we make it to here, we are ready to create an administrator
- createAdministrator(email, firstName, lastName, language, String.valueOf(password1));
+ password2 = console.readPassword();
- //Cleaning arrays that held password
- Arrays.fill(password1, ' ');
- Arrays.fill(password2, ' ');
+ // TODO real password validation
+ if (password1.length > 1 && Arrays.equals(password1, password2)) {
+ // password OK
+ Arrays.fill(password2, ' ');
+ return password1;
+ } else {
+ System.out.println("Passwords don't match");
+ return null;
+ }
}
/**
- * Create the administrator with the given details. If the user
+ * Create the administrator with the given details. If the user
* already exists then they are simply upped to administrator status
*
* @param email the email for the user
@@ -213,8 +247,8 @@ protected void negotiateAdministratorDetails()
* @throws Exception if error
*/
protected void createAdministrator(String email, String first, String last,
- String language, String pw)
- throws Exception {
+ String language, String pw)
+ throws Exception {
// Of course we aren't an administrator yet so we need to
// circumvent authorisation
context.turnOffAuthorisationSystem();
diff --git a/dspace-api/src/main/java/org/dspace/administer/MetadataImporter.java b/dspace-api/src/main/java/org/dspace/administer/MetadataImporter.java
index 37a89fa6943a..2677cb20501f 100644
--- a/dspace-api/src/main/java/org/dspace/administer/MetadataImporter.java
+++ b/dspace-api/src/main/java/org/dspace/administer/MetadataImporter.java
@@ -11,13 +11,16 @@
import java.sql.SQLException;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
-import org.apache.xpath.XPathAPI;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.MetadataField;
import org.dspace.content.MetadataSchema;
@@ -81,7 +84,7 @@ private MetadataImporter() { }
* @throws SQLException if database error
* @throws IOException if IO error
* @throws TransformerException if transformer error
- * @throws ParserConfigurationException if config error
+ * @throws ParserConfigurationException if configuration error
* @throws AuthorizeException if authorization error
* @throws SAXException if parser error
* @throws NonUniqueMetadataException if duplicate metadata
@@ -90,8 +93,7 @@ private MetadataImporter() { }
public static void main(String[] args)
throws ParseException, SQLException, IOException, TransformerException,
ParserConfigurationException, AuthorizeException, SAXException,
- NonUniqueMetadataException, RegistryImportException {
- boolean forceUpdate = false;
+ NonUniqueMetadataException, RegistryImportException, XPathExpressionException {
// create an options object and populate it
CommandLineParser parser = new DefaultParser();
@@ -100,16 +102,14 @@ public static void main(String[] args)
options.addOption("u", "update", false, "update an existing schema");
CommandLine line = parser.parse(options, args);
- String file = null;
if (line.hasOption('f')) {
- file = line.getOptionValue('f');
+ String file = line.getOptionValue('f');
+ boolean forceUpdate = line.hasOption('u');
+ loadRegistry(file, forceUpdate);
} else {
usage();
- System.exit(0);
+ System.exit(1);
}
-
- forceUpdate = line.hasOption('u');
- loadRegistry(file, forceUpdate);
}
/**
@@ -120,15 +120,15 @@ public static void main(String[] args)
* @throws SQLException if database error
* @throws IOException if IO error
* @throws TransformerException if transformer error
- * @throws ParserConfigurationException if config error
+ * @throws ParserConfigurationException if configuration error
* @throws AuthorizeException if authorization error
* @throws SAXException if parser error
* @throws NonUniqueMetadataException if duplicate metadata
* @throws RegistryImportException if import fails
*/
public static void loadRegistry(String file, boolean forceUpdate)
- throws SQLException, IOException, TransformerException, ParserConfigurationException,
- AuthorizeException, SAXException, NonUniqueMetadataException, RegistryImportException {
+ throws SQLException, IOException, TransformerException, ParserConfigurationException, AuthorizeException,
+ SAXException, NonUniqueMetadataException, RegistryImportException, XPathExpressionException {
Context context = null;
try {
@@ -140,7 +140,9 @@ public static void loadRegistry(String file, boolean forceUpdate)
Document document = RegistryImporter.loadXML(file);
// Get the nodes corresponding to types
- NodeList schemaNodes = XPathAPI.selectNodeList(document, "/dspace-dc-types/dc-schema");
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList schemaNodes = (NodeList) xPath.compile("/dspace-dc-types/dc-schema")
+ .evaluate(document, XPathConstants.NODESET);
// Add each one as a new format to the registry
for (int i = 0; i < schemaNodes.getLength(); i++) {
@@ -149,7 +151,8 @@ public static void loadRegistry(String file, boolean forceUpdate)
}
// Get the nodes corresponding to types
- NodeList typeNodes = XPathAPI.selectNodeList(document, "/dspace-dc-types/dc-type");
+ NodeList typeNodes = (NodeList) xPath.compile("/dspace-dc-types/dc-type")
+ .evaluate(document, XPathConstants.NODESET);
// Add each one as a new format to the registry
for (int i = 0; i < typeNodes.getLength(); i++) {
@@ -181,8 +184,8 @@ public static void loadRegistry(String file, boolean forceUpdate)
* @throws RegistryImportException if import fails
*/
private static void loadSchema(Context context, Node node, boolean updateExisting)
- throws SQLException, IOException, TransformerException,
- AuthorizeException, NonUniqueMetadataException, RegistryImportException {
+ throws SQLException, AuthorizeException, NonUniqueMetadataException, RegistryImportException,
+ XPathExpressionException {
// Get the values
String name = RegistryImporter.getElementData(node, "name");
String namespace = RegistryImporter.getElementData(node, "namespace");
@@ -227,7 +230,7 @@ private static void loadSchema(Context context, Node node, boolean updateExistin
/**
* Process a node in the metadata registry XML file. The node must
* be a "dc-type" node. If the type already exists, then it
- * will not be reimported
+ * will not be re-imported.
*
* @param context DSpace context object
* @param node the node in the DOM tree
@@ -239,8 +242,8 @@ private static void loadSchema(Context context, Node node, boolean updateExistin
* @throws RegistryImportException if import fails
*/
private static void loadType(Context context, Node node)
- throws SQLException, IOException, TransformerException,
- AuthorizeException, NonUniqueMetadataException, RegistryImportException {
+ throws SQLException, IOException, AuthorizeException, NonUniqueMetadataException, RegistryImportException,
+ XPathExpressionException {
// Get the values
String schema = RegistryImporter.getElementData(node, "schema");
String element = RegistryImporter.getElementData(node, "element");
diff --git a/dspace-api/src/main/java/org/dspace/administer/ProcessCleaner.java b/dspace-api/src/main/java/org/dspace/administer/ProcessCleaner.java
new file mode 100644
index 000000000000..ee6b8d08b059
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/administer/ProcessCleaner.java
@@ -0,0 +1,140 @@
+/**
+ * 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.administer;
+
+import java.io.IOException;
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+
+import org.apache.commons.cli.ParseException;
+import org.apache.commons.lang.time.DateUtils;
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.content.ProcessStatus;
+import org.dspace.core.Context;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.scripts.Process;
+import org.dspace.scripts.factory.ScriptServiceFactory;
+import org.dspace.scripts.service.ProcessService;
+import org.dspace.services.ConfigurationService;
+import org.dspace.services.factory.DSpaceServicesFactory;
+import org.dspace.utils.DSpace;
+
+/**
+ * Script to cleanup the old processes in the specified state.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class ProcessCleaner extends DSpaceRunnable> {
+
+ private ConfigurationService configurationService;
+
+ private ProcessService processService;
+
+
+ private boolean cleanCompleted = false;
+
+ private boolean cleanFailed = false;
+
+ private boolean cleanRunning = false;
+
+ private boolean help = false;
+
+ private Integer days;
+
+
+ @Override
+ public void setup() throws ParseException {
+
+ this.configurationService = DSpaceServicesFactory.getInstance().getConfigurationService();
+ this.processService = ScriptServiceFactory.getInstance().getProcessService();
+
+ this.help = commandLine.hasOption('h');
+ this.cleanFailed = commandLine.hasOption('f');
+ this.cleanRunning = commandLine.hasOption('r');
+ this.cleanCompleted = commandLine.hasOption('c') || (!cleanFailed && !cleanRunning);
+
+ this.days = configurationService.getIntProperty("process-cleaner.days", 14);
+
+ if (this.days <= 0) {
+ throw new IllegalStateException("The number of days must be a positive integer.");
+ }
+
+ }
+
+ @Override
+ public void internalRun() throws Exception {
+
+ if (help) {
+ printHelp();
+ return;
+ }
+
+ Context context = new Context();
+
+ try {
+ context.turnOffAuthorisationSystem();
+ performDeletion(context);
+ } finally {
+ context.restoreAuthSystemState();
+ context.complete();
+ }
+
+ }
+
+ /**
+ * Delete the processes based on the specified statuses and the configured days
+ * from their creation.
+ */
+ private void performDeletion(Context context) throws SQLException, IOException, AuthorizeException {
+
+ List statuses = getProcessToDeleteStatuses();
+ Date creationDate = calculateCreationDate();
+
+ handler.logInfo("Searching for processes with status: " + statuses);
+ List processes = processService.findByStatusAndCreationTimeOlderThan(context, statuses, creationDate);
+ handler.logInfo("Found " + processes.size() + " processes to be deleted");
+ for (Process process : processes) {
+ processService.delete(context, process);
+ }
+
+ handler.logInfo("Process cleanup completed");
+
+ }
+
+ /**
+ * Returns the list of Process statuses do be deleted.
+ */
+ private List getProcessToDeleteStatuses() {
+ List statuses = new ArrayList();
+ if (cleanCompleted) {
+ statuses.add(ProcessStatus.COMPLETED);
+ }
+ if (cleanFailed) {
+ statuses.add(ProcessStatus.FAILED);
+ }
+ if (cleanRunning) {
+ statuses.add(ProcessStatus.RUNNING);
+ }
+ return statuses;
+ }
+
+ private Date calculateCreationDate() {
+ return DateUtils.addDays(new Date(), -days);
+ }
+
+ @Override
+ @SuppressWarnings("unchecked")
+ public ProcessCleanerConfiguration getScriptConfiguration() {
+ return new DSpace().getServiceManager()
+ .getServiceByName("process-cleaner", ProcessCleanerConfiguration.class);
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerCli.java b/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerCli.java
new file mode 100644
index 000000000000..292c6c372e4f
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerCli.java
@@ -0,0 +1,18 @@
+/**
+ * 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.administer;
+
+/**
+ * The {@link ProcessCleaner} for CLI.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class ProcessCleanerCli extends ProcessCleaner {
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerCliConfiguration.java b/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerCliConfiguration.java
new file mode 100644
index 000000000000..043990156d16
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerCliConfiguration.java
@@ -0,0 +1,18 @@
+/**
+ * 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.administer;
+
+/**
+ * The {@link ProcessCleanerConfiguration} for CLI.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class ProcessCleanerCliConfiguration extends ProcessCleanerConfiguration {
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerConfiguration.java b/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerConfiguration.java
new file mode 100644
index 000000000000..91dcfb5dfec5
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/administer/ProcessCleanerConfiguration.java
@@ -0,0 +1,53 @@
+/**
+ * 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.administer;
+
+import org.apache.commons.cli.Options;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link ProcessCleaner} script.
+ */
+public class ProcessCleanerConfiguration extends ScriptConfiguration {
+
+ private Class dspaceRunnableClass;
+
+ @Override
+ public Options getOptions() {
+ if (options == null) {
+
+ Options options = new Options();
+
+ options.addOption("h", "help", false, "help");
+
+ options.addOption("r", "running", false, "delete the process with RUNNING status");
+ options.getOption("r").setType(boolean.class);
+
+ options.addOption("f", "failed", false, "delete the process with FAILED status");
+ options.getOption("f").setType(boolean.class);
+
+ options.addOption("c", "completed", false,
+ "delete the process with COMPLETED status (default if no statuses are specified)");
+ options.getOption("c").setType(boolean.class);
+
+ super.options = options;
+ }
+ return options;
+ }
+
+ @Override
+ public Class getDspaceRunnableClass() {
+ return dspaceRunnableClass;
+ }
+
+ @Override
+ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
+ this.dspaceRunnableClass = dspaceRunnableClass;
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/administer/RegistryImporter.java b/dspace-api/src/main/java/org/dspace/administer/RegistryImporter.java
index 5b5f70412ac2..27a653421312 100644
--- a/dspace-api/src/main/java/org/dspace/administer/RegistryImporter.java
+++ b/dspace-api/src/main/java/org/dspace/administer/RegistryImporter.java
@@ -13,8 +13,11 @@
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
-import org.apache.xpath.XPathAPI;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
@@ -72,9 +75,10 @@ public static Document loadXML(String filename)
* @throws TransformerException if error
*/
public static String getElementData(Node parentElement, String childName)
- throws TransformerException {
+ throws XPathExpressionException {
// Grab the child node
- Node childNode = XPathAPI.selectSingleNode(parentElement, childName);
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ Node childNode = (Node) xPath.compile(childName).evaluate(parentElement, XPathConstants.NODE);
if (childNode == null) {
// No child node, so no values
@@ -115,9 +119,10 @@ public static String getElementData(Node parentElement, String childName)
* @throws TransformerException if error
*/
public static String[] getRepeatedElementData(Node parentElement,
- String childName) throws TransformerException {
+ String childName) throws XPathExpressionException {
// Grab the child node
- NodeList childNodes = XPathAPI.selectNodeList(parentElement, childName);
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList childNodes = (NodeList) xPath.compile(childName).evaluate(parentElement, XPathConstants.NODESET);
String[] data = new String[childNodes.getLength()];
diff --git a/dspace-api/src/main/java/org/dspace/administer/RegistryLoader.java b/dspace-api/src/main/java/org/dspace/administer/RegistryLoader.java
index b2f72802529d..bbf320a0d5e5 100644
--- a/dspace-api/src/main/java/org/dspace/administer/RegistryLoader.java
+++ b/dspace-api/src/main/java/org/dspace/administer/RegistryLoader.java
@@ -16,15 +16,18 @@
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
import org.apache.logging.log4j.Logger;
-import org.apache.xpath.XPathAPI;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.BitstreamFormat;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.BitstreamFormatService;
import org.dspace.core.Context;
-import org.dspace.core.LogManager;
+import org.dspace.core.LogHelper;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
@@ -95,7 +98,7 @@ public static void main(String[] argv) throws Exception {
System.exit(1);
} catch (Exception e) {
- log.fatal(LogManager.getHeader(context, "error_loading_registries",
+ log.fatal(LogHelper.getHeader(context, "error_loading_registries",
""), e);
System.err.println("Error: \n - " + e.getMessage());
@@ -122,12 +125,13 @@ public static void main(String[] argv) throws Exception {
*/
public static void loadBitstreamFormats(Context context, String filename)
throws SQLException, IOException, ParserConfigurationException,
- SAXException, TransformerException, AuthorizeException {
+ SAXException, TransformerException, AuthorizeException, XPathExpressionException {
Document document = loadXML(filename);
// Get the nodes corresponding to formats
- NodeList typeNodes = XPathAPI.selectNodeList(document,
- "dspace-bitstream-types/bitstream-type");
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList typeNodes = (NodeList) xPath.compile("dspace-bitstream-types/bitstream-type")
+ .evaluate(document, XPathConstants.NODESET);
// Add each one as a new format to the registry
for (int i = 0; i < typeNodes.getLength(); i++) {
@@ -135,7 +139,7 @@ public static void loadBitstreamFormats(Context context, String filename)
loadFormat(context, n);
}
- log.info(LogManager.getHeader(context, "load_bitstream_formats",
+ log.info(LogHelper.getHeader(context, "load_bitstream_formats",
"number_loaded=" + typeNodes.getLength()));
}
@@ -151,8 +155,7 @@ public static void loadBitstreamFormats(Context context, String filename)
* @throws AuthorizeException if authorization error
*/
private static void loadFormat(Context context, Node node)
- throws SQLException, IOException, TransformerException,
- AuthorizeException {
+ throws SQLException, AuthorizeException, XPathExpressionException {
// Get the values
String mimeType = getElementData(node, "mimetype");
String shortDesc = getElementData(node, "short_description");
@@ -231,9 +234,10 @@ private static Document loadXML(String filename) throws IOException,
* @throws TransformerException if transformer error
*/
private static String getElementData(Node parentElement, String childName)
- throws TransformerException {
+ throws XPathExpressionException {
// Grab the child node
- Node childNode = XPathAPI.selectSingleNode(parentElement, childName);
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ Node childNode = (Node) xPath.compile(childName).evaluate(parentElement, XPathConstants.NODE);
if (childNode == null) {
// No child node, so no values
@@ -274,9 +278,10 @@ private static String getElementData(Node parentElement, String childName)
* @throws TransformerException if transformer error
*/
private static String[] getRepeatedElementData(Node parentElement,
- String childName) throws TransformerException {
+ String childName) throws XPathExpressionException {
// Grab the child node
- NodeList childNodes = XPathAPI.selectNodeList(parentElement, childName);
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList childNodes = (NodeList) xPath.compile(childName).evaluate(parentElement, XPathConstants.NODESET);
String[] data = new String[childNodes.getLength()];
diff --git a/dspace-api/src/main/java/org/dspace/administer/StructBuilder.java b/dspace-api/src/main/java/org/dspace/administer/StructBuilder.java
index 89d9ffe5a841..13a1b3b5bbf8 100644
--- a/dspace-api/src/main/java/org/dspace/administer/StructBuilder.java
+++ b/dspace-api/src/main/java/org/dspace/administer/StructBuilder.java
@@ -30,6 +30,10 @@
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
@@ -38,7 +42,7 @@
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
-import org.apache.xpath.XPathAPI;
+import org.apache.commons.lang3.StringUtils;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Collection;
import org.dspace.content.Community;
@@ -52,9 +56,11 @@
import org.dspace.core.Context;
import org.dspace.eperson.factory.EPersonServiceFactory;
import org.dspace.eperson.service.EPersonService;
-import org.jdom.Element;
-import org.jdom.output.Format;
-import org.jdom.output.XMLOutputter;
+import org.dspace.handle.factory.HandleServiceFactory;
+import org.dspace.handle.service.HandleService;
+import org.jdom2.Element;
+import org.jdom2.output.Format;
+import org.jdom2.output.XMLOutputter;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
@@ -76,6 +82,7 @@
*
*
* }
+ *
*
* It can be arbitrarily deep, and supports all the metadata elements
* that make up the community and collection metadata. See the system
@@ -104,12 +111,14 @@ public class StructBuilder {
*/
private static final Map communityMap = new HashMap<>();
- protected static CommunityService communityService
+ protected static final CommunityService communityService
= ContentServiceFactory.getInstance().getCommunityService();
- protected static CollectionService collectionService
+ protected static final CollectionService collectionService
= ContentServiceFactory.getInstance().getCollectionService();
- protected static EPersonService ePersonService
+ protected static final EPersonService ePersonService
= EPersonServiceFactory.getInstance().getEPersonService();
+ protected static final HandleService handleService
+ = HandleServiceFactory.getInstance().getHandleService();
/**
* Default constructor
@@ -135,16 +144,18 @@ private StructBuilder() { }
* @throws SQLException passed through.
* @throws FileNotFoundException if input or output could not be opened.
* @throws TransformerException if the input document is invalid.
+ * @throws XPathExpressionException passed through.
*/
public static void main(String[] argv)
- throws ParserConfigurationException, SQLException,
- FileNotFoundException, IOException, TransformerException {
+ throws ParserConfigurationException, SQLException,
+ IOException, TransformerException, XPathExpressionException {
// Define command line options.
Options options = new Options();
options.addOption("h", "help", false, "Print this help message.");
options.addOption("?", "help");
options.addOption("x", "export", false, "Export the current structure as XML.");
+ options.addOption("k", "keep-handles", false, "Apply Handles from input document.");
options.addOption(Option.builder("e").longOpt("eperson")
.desc("User who is manipulating the repository's structure.")
@@ -206,6 +217,7 @@ public static void main(String[] argv)
// Export? Import?
if (line.hasOption('x')) { // export
exportStructure(context, outputStream);
+ outputStream.close();
} else { // Must be import
String input = line.getOptionValue('f');
if (null == input) {
@@ -220,7 +232,12 @@ public static void main(String[] argv)
inputStream = new FileInputStream(input);
}
- importStructure(context, inputStream, outputStream);
+ boolean keepHandles = options.hasOption("k");
+ importStructure(context, inputStream, outputStream, keepHandles);
+
+ inputStream.close();
+ outputStream.close();
+
// save changes from import
context.complete();
}
@@ -233,14 +250,17 @@ public static void main(String[] argv)
* @param context
* @param input XML which describes the new communities and collections.
* @param output input, annotated with the new objects' identifiers.
+ * @param keepHandles true if Handles should be set from input.
* @throws IOException
* @throws ParserConfigurationException
* @throws SAXException
* @throws TransformerException
* @throws SQLException
*/
- static void importStructure(Context context, InputStream input, OutputStream output)
- throws IOException, ParserConfigurationException, SQLException, TransformerException {
+ static void importStructure(Context context, InputStream input,
+ OutputStream output, boolean keepHandles)
+ throws IOException, ParserConfigurationException, SQLException,
+ TransformerException, XPathExpressionException {
// load the XML
Document document = null;
@@ -258,15 +278,29 @@ static void importStructure(Context context, InputStream input, OutputStream out
// is properly structured.
try {
validate(document);
- } catch (TransformerException ex) {
+ } catch (XPathExpressionException ex) {
System.err.format("The input document is invalid: %s%n", ex.getMessage());
System.exit(1);
}
// Check for 'identifier' attributes -- possibly output by this class.
- NodeList identifierNodes = XPathAPI.selectNodeList(document, "//*[@identifier]");
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList identifierNodes = (NodeList) xPath.compile("//*[@identifier]")
+ .evaluate(document, XPathConstants.NODESET);
if (identifierNodes.getLength() > 0) {
- System.err.println("The input document has 'identifier' attributes, which will be ignored.");
+ if (!keepHandles) {
+ System.err.println("The input document has 'identifier' attributes, which will be ignored.");
+ } else {
+ for (int i = 0; i < identifierNodes.getLength() ; i++) {
+ String identifier = identifierNodes.item(i).getAttributes().item(0).getTextContent();
+ if (handleService.resolveToURL(context, identifier) != null) {
+ System.err.printf("The input document contains handle %s,"
+ + " which is in use already. Aborting...%n",
+ identifier);
+ System.exit(1);
+ }
+ }
+ }
}
// load the mappings into the member variable hashmaps
@@ -287,10 +321,11 @@ static void importStructure(Context context, InputStream input, OutputStream out
Element[] elements = new Element[]{};
try {
// get the top level community list
- NodeList first = XPathAPI.selectNodeList(document, "/import_structure/community");
+ NodeList first = (NodeList) xPath.compile("/import_structure/community")
+ .evaluate(document, XPathConstants.NODESET);
// run the import starting with the top level communities
- elements = handleCommunities(context, first, null);
+ elements = handleCommunities(context, first, null, keepHandles);
} catch (TransformerException ex) {
System.err.format("Input content not understood: %s%n", ex.getMessage());
System.exit(1);
@@ -307,7 +342,7 @@ static void importStructure(Context context, InputStream input, OutputStream out
}
// finally write the string into the output file.
- final org.jdom.Document xmlOutput = new org.jdom.Document(root);
+ final org.jdom2.Document xmlOutput = new org.jdom2.Document(root);
try {
new XMLOutputter().output(xmlOutput, output);
} catch (IOException e) {
@@ -411,7 +446,7 @@ static void exportStructure(Context context, OutputStream output) {
}
// Now write the structure out.
- org.jdom.Document xmlOutput = new org.jdom.Document(rootElement);
+ org.jdom2.Document xmlOutput = new org.jdom2.Document(rootElement);
try {
XMLOutputter outputter = new XMLOutputter(Format.getPrettyFormat());
outputter.output(xmlOutput, output);
@@ -456,14 +491,16 @@ private static void giveHelp(Options options) {
* @throws TransformerException if transformer error
*/
private static void validate(org.w3c.dom.Document document)
- throws TransformerException {
+ throws XPathExpressionException {
StringBuilder err = new StringBuilder();
boolean trip = false;
err.append("The following errors were encountered parsing the source XML.\n");
err.append("No changes have been made to the DSpace instance.\n\n");
- NodeList first = XPathAPI.selectNodeList(document, "/import_structure/community");
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList first = (NodeList) xPath.compile("/import_structure/community")
+ .evaluate(document, XPathConstants.NODESET);
if (first.getLength() == 0) {
err.append("-There are no top level communities in the source document.");
System.out.println(err.toString());
@@ -493,14 +530,15 @@ private static void validate(org.w3c.dom.Document document)
* no errors.
*/
private static String validateCommunities(NodeList communities, int level)
- throws TransformerException {
+ throws XPathExpressionException {
StringBuilder err = new StringBuilder();
boolean trip = false;
String errs = null;
+ XPath xPath = XPathFactory.newInstance().newXPath();
for (int i = 0; i < communities.getLength(); i++) {
Node n = communities.item(i);
- NodeList name = XPathAPI.selectNodeList(n, "name");
+ NodeList name = (NodeList) xPath.compile("name").evaluate(n, XPathConstants.NODESET);
if (name.getLength() != 1) {
String pos = Integer.toString(i + 1);
err.append("-The level ").append(level)
@@ -510,7 +548,7 @@ private static String validateCommunities(NodeList communities, int level)
}
// validate sub communities
- NodeList subCommunities = XPathAPI.selectNodeList(n, "community");
+ NodeList subCommunities = (NodeList) xPath.compile("community").evaluate(n, XPathConstants.NODESET);
String comErrs = validateCommunities(subCommunities, level + 1);
if (comErrs != null) {
err.append(comErrs);
@@ -518,7 +556,7 @@ private static String validateCommunities(NodeList communities, int level)
}
// validate collections
- NodeList collections = XPathAPI.selectNodeList(n, "collection");
+ NodeList collections = (NodeList) xPath.compile("collection").evaluate(n, XPathConstants.NODESET);
String colErrs = validateCollections(collections, level + 1);
if (colErrs != null) {
err.append(colErrs);
@@ -542,14 +580,15 @@ private static String validateCommunities(NodeList communities, int level)
* @return the errors to be generated by the calling method, or null if none
*/
private static String validateCollections(NodeList collections, int level)
- throws TransformerException {
+ throws XPathExpressionException {
StringBuilder err = new StringBuilder();
boolean trip = false;
String errs = null;
+ XPath xPath = XPathFactory.newInstance().newXPath();
for (int i = 0; i < collections.getLength(); i++) {
Node n = collections.item(i);
- NodeList name = XPathAPI.selectNodeList(n, "name");
+ NodeList name = (NodeList) xPath.compile("name").evaluate(n, XPathConstants.NODESET);
if (name.getLength() != 1) {
String pos = Integer.toString(i + 1);
err.append("-The level ").append(level)
@@ -609,22 +648,29 @@ private static String getStringValue(Node node) {
* @param context the context of the request
* @param communities a nodelist of communities to create along with their sub-structures
* @param parent the parent community of the nodelist of communities to create
+ * @param keepHandles use Handles from input.
* @return an element array containing additional information regarding the
* created communities (e.g. the handles they have been assigned)
*/
- private static Element[] handleCommunities(Context context, NodeList communities, Community parent)
- throws TransformerException, SQLException, AuthorizeException {
+ private static Element[] handleCommunities(Context context, NodeList communities,
+ Community parent, boolean keepHandles)
+ throws TransformerException, SQLException, AuthorizeException,
+ XPathExpressionException {
Element[] elements = new Element[communities.getLength()];
+ XPath xPath = XPathFactory.newInstance().newXPath();
for (int i = 0; i < communities.getLength(); i++) {
- Community community;
- Element element = new Element("community");
+ Node tn = communities.item(i);
+ Node identifier = tn.getAttributes().getNamedItem("identifier");
// create the community or sub community
- if (parent != null) {
+ Community community;
+ if (null == identifier
+ || StringUtils.isBlank(identifier.getNodeValue())
+ || !keepHandles) {
community = communityService.create(parent, context);
} else {
- community = communityService.create(null, context);
+ community = communityService.create(parent, context, identifier.getNodeValue());
}
// default the short description to be an empty string
@@ -632,9 +678,8 @@ private static Element[] handleCommunities(Context context, NodeList communities
MD_SHORT_DESCRIPTION, null, " ");
// now update the metadata
- Node tn = communities.item(i);
for (Map.Entry entry : communityMap.entrySet()) {
- NodeList nl = XPathAPI.selectNodeList(tn, entry.getKey());
+ NodeList nl = (NodeList) xPath.compile(entry.getKey()).evaluate(tn, XPathConstants.NODESET);
if (nl.getLength() == 1) {
communityService.setMetadataSingleValue(context, community,
entry.getValue(), null, getStringValue(nl.item(0)));
@@ -658,6 +703,7 @@ private static Element[] handleCommunities(Context context, NodeList communities
// but it's here to keep it separate from the create process in
// case
// we want to move it or make it switchable later
+ Element element = new Element("community");
element.setAttribute("identifier", community.getHandle());
Element nameElement = new Element("name");
@@ -700,12 +746,16 @@ private static Element[] handleCommunities(Context context, NodeList communities
}
// handle sub communities
- NodeList subCommunities = XPathAPI.selectNodeList(tn, "community");
- Element[] subCommunityElements = handleCommunities(context, subCommunities, community);
+ NodeList subCommunities = (NodeList) xPath.compile("community")
+ .evaluate(tn, XPathConstants.NODESET);
+ Element[] subCommunityElements = handleCommunities(context,
+ subCommunities, community, keepHandles);
// handle collections
- NodeList collections = XPathAPI.selectNodeList(tn, "collection");
- Element[] collectionElements = handleCollections(context, collections, community);
+ NodeList collections = (NodeList) xPath.compile("collection")
+ .evaluate(tn, XPathConstants.NODESET);
+ Element[] collectionElements = handleCollections(context,
+ collections, community, keepHandles);
int j;
for (j = 0; j < subCommunityElements.length; j++) {
@@ -730,22 +780,33 @@ private static Element[] handleCommunities(Context context, NodeList communities
* @return an Element array containing additional information about the
* created collections (e.g. the handle)
*/
- private static Element[] handleCollections(Context context, NodeList collections, Community parent)
- throws TransformerException, SQLException, AuthorizeException {
+ private static Element[] handleCollections(Context context,
+ NodeList collections, Community parent, boolean keepHandles)
+ throws SQLException, AuthorizeException, XPathExpressionException {
Element[] elements = new Element[collections.getLength()];
+ XPath xPath = XPathFactory.newInstance().newXPath();
for (int i = 0; i < collections.getLength(); i++) {
- Element element = new Element("collection");
- Collection collection = collectionService.create(context, parent);
+ Node tn = collections.item(i);
+ Node identifier = tn.getAttributes().getNamedItem("identifier");
+
+ // Create the Collection.
+ Collection collection;
+ if (null == identifier
+ || StringUtils.isBlank(identifier.getNodeValue())
+ || !keepHandles) {
+ collection = collectionService.create(context, parent);
+ } else {
+ collection = collectionService.create(context, parent, identifier.getNodeValue());
+ }
// default the short description to the empty string
collectionService.setMetadataSingleValue(context, collection,
MD_SHORT_DESCRIPTION, Item.ANY, " ");
// import the rest of the metadata
- Node tn = collections.item(i);
for (Map.Entry entry : collectionMap.entrySet()) {
- NodeList nl = XPathAPI.selectNodeList(tn, entry.getKey());
+ NodeList nl = (NodeList) xPath.compile(entry.getKey()).evaluate(tn, XPathConstants.NODESET);
if (nl.getLength() == 1) {
collectionService.setMetadataSingleValue(context, collection,
entry.getValue(), null, getStringValue(nl.item(0)));
@@ -754,6 +815,7 @@ private static Element[] handleCollections(Context context, NodeList collections
collectionService.update(context, collection);
+ Element element = new Element("collection");
element.setAttribute("identifier", collection.getHandle());
Element nameElement = new Element("name");
diff --git a/dspace-api/src/main/java/org/dspace/alerts/AllowSessionsEnum.java b/dspace-api/src/main/java/org/dspace/alerts/AllowSessionsEnum.java
new file mode 100644
index 000000000000..a200cab8781f
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/alerts/AllowSessionsEnum.java
@@ -0,0 +1,54 @@
+/**
+ * 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.alerts;
+
+/**
+ * Enum representing the options for allowing sessions:
+ * ALLOW_ALL_SESSIONS - Will allow all users to log in and continue their sessions
+ * ALLOW_CURRENT_SESSIONS_ONLY - Will prevent non admin users from logging in, however logged-in users
+ * will remain logged in
+ * ALLOW_ADMIN_SESSIONS_ONLY - Only admin users can log in, non admin sessions will be interrupted
+ *
+ * NOTE: This functionality can be stored in the database, but no support is present right now to interrupt and prevent
+ * sessions.
+ */
+public enum AllowSessionsEnum {
+ ALLOW_ALL_SESSIONS("all"),
+ ALLOW_CURRENT_SESSIONS_ONLY("current"),
+ ALLOW_ADMIN_SESSIONS_ONLY("admin");
+
+ private String allowSessionsType;
+
+ AllowSessionsEnum(String allowSessionsType) {
+ this.allowSessionsType = allowSessionsType;
+ }
+
+ public String getValue() {
+ return allowSessionsType;
+ }
+
+ public static AllowSessionsEnum fromString(String alertAllowSessionType) {
+ if (alertAllowSessionType == null) {
+ return AllowSessionsEnum.ALLOW_ALL_SESSIONS;
+ }
+
+ switch (alertAllowSessionType) {
+ case "all":
+ return AllowSessionsEnum.ALLOW_ALL_SESSIONS;
+ case "current":
+ return AllowSessionsEnum.ALLOW_CURRENT_SESSIONS_ONLY;
+ case "admin" :
+ return AllowSessionsEnum.ALLOW_ADMIN_SESSIONS_ONLY;
+ default:
+ throw new IllegalArgumentException("No corresponding enum value for provided string: "
+ + alertAllowSessionType);
+ }
+ }
+
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/alerts/SystemWideAlert.java b/dspace-api/src/main/java/org/dspace/alerts/SystemWideAlert.java
new file mode 100644
index 000000000000..f56cbdcce9e9
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/alerts/SystemWideAlert.java
@@ -0,0 +1,179 @@
+/**
+ * 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.alerts;
+
+import java.util.Date;
+import javax.persistence.Cacheable;
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.SequenceGenerator;
+import javax.persistence.Table;
+import javax.persistence.Temporal;
+import javax.persistence.TemporalType;
+
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.dspace.core.ReloadableEntity;
+import org.hibernate.annotations.CacheConcurrencyStrategy;
+
+/**
+ * Database object representing system-wide alerts
+ */
+@Entity
+@Cacheable
+@org.hibernate.annotations.Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE, include = "non-lazy")
+@Table(name = "systemwidealert")
+public class SystemWideAlert implements ReloadableEntity {
+
+ @Id
+ @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "alert_id_seq")
+ @SequenceGenerator(name = "alert_id_seq", sequenceName = "alert_id_seq", allocationSize = 1)
+ @Column(name = "alert_id", unique = true, nullable = false)
+ private Integer alertId;
+
+ @Column(name = "message", nullable = false)
+ private String message;
+
+ @Column(name = "allow_sessions")
+ private String allowSessions;
+
+ @Column(name = "countdown_to")
+ @Temporal(TemporalType.TIMESTAMP)
+ private Date countdownTo;
+
+ @Column(name = "active")
+ private boolean active;
+
+ protected SystemWideAlert() {
+ }
+
+ /**
+ * This method returns the ID that the system-wide alert holds within the database
+ *
+ * @return The ID that the system-wide alert holds within the database
+ */
+ @Override
+ public Integer getID() {
+ return alertId;
+ }
+
+ /**
+ * Set the ID for the system-wide alert
+ *
+ * @param alertID The ID to set
+ */
+ public void setID(final Integer alertID) {
+ this.alertId = alertID;
+ }
+
+ /**
+ * Retrieve the message of the system-wide alert
+ *
+ * @return the message of the system-wide alert
+ */
+ public String getMessage() {
+ return message;
+ }
+
+ /**
+ * Set the message of the system-wide alert
+ *
+ * @param message The message to set
+ */
+ public void setMessage(final String message) {
+ this.message = message;
+ }
+
+ /**
+ * Retrieve what kind of sessions are allowed while the system-wide alert is active
+ *
+ * @return what kind of sessions are allowed while the system-wide alert is active
+ */
+ public AllowSessionsEnum getAllowSessions() {
+ return AllowSessionsEnum.fromString(allowSessions);
+ }
+
+ /**
+ * Set what kind of sessions are allowed while the system-wide alert is active
+ *
+ * @param allowSessions Integer representing what kind of sessions are allowed
+ */
+ public void setAllowSessions(AllowSessionsEnum allowSessions) {
+ this.allowSessions = allowSessions.getValue();
+ }
+
+ /**
+ * Retrieve the date to which will be count down when the system-wide alert is active
+ *
+ * @return the date to which will be count down when the system-wide alert is active
+ */
+ public Date getCountdownTo() {
+ return countdownTo;
+ }
+
+ /**
+ * Set the date to which will be count down when the system-wide alert is active
+ *
+ * @param countdownTo The date to which will be count down
+ */
+ public void setCountdownTo(final Date countdownTo) {
+ this.countdownTo = countdownTo;
+ }
+
+ /**
+ * Retrieve whether the system-wide alert is active
+ *
+ * @return whether the system-wide alert is active
+ */
+ public boolean isActive() {
+ return active;
+ }
+
+ /**
+ * Set whether the system-wide alert is active
+ *
+ * @param active Whether the system-wide alert is active
+ */
+ public void setActive(final boolean active) {
+ this.active = active;
+ }
+
+ /**
+ * Return true if other is the same SystemWideAlert
+ * as this object, false otherwise
+ *
+ * @param other object to compare to
+ * @return true if object passed in represents the same
+ * system-wide alert as this object
+ */
+ @Override
+ public boolean equals(Object other) {
+ return (other instanceof SystemWideAlert &&
+ new EqualsBuilder().append(this.getID(), ((SystemWideAlert) other).getID())
+ .append(this.getMessage(), ((SystemWideAlert) other).getMessage())
+ .append(this.getAllowSessions(), ((SystemWideAlert) other).getAllowSessions())
+ .append(this.getCountdownTo(), ((SystemWideAlert) other).getCountdownTo())
+ .append(this.isActive(), ((SystemWideAlert) other).isActive())
+ .isEquals());
+ }
+
+ @Override
+ public int hashCode() {
+ return new HashCodeBuilder(17, 37)
+ .append(this.getID())
+ .append(this.getMessage())
+ .append(this.getAllowSessions())
+ .append(this.getCountdownTo())
+ .append(this.isActive())
+ .toHashCode();
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/alerts/SystemWideAlertServiceImpl.java b/dspace-api/src/main/java/org/dspace/alerts/SystemWideAlertServiceImpl.java
new file mode 100644
index 000000000000..9ddf6c97d111
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/alerts/SystemWideAlertServiceImpl.java
@@ -0,0 +1,129 @@
+/**
+ * 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.alerts;
+
+import java.io.IOException;
+import java.sql.SQLException;
+import java.util.Date;
+import java.util.List;
+
+import org.apache.logging.log4j.Logger;
+import org.dspace.alerts.dao.SystemWideAlertDAO;
+import org.dspace.alerts.service.SystemWideAlertService;
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.authorize.service.AuthorizeService;
+import org.dspace.core.Context;
+import org.dspace.core.LogHelper;
+import org.dspace.eperson.EPerson;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * The implementation for the {@link SystemWideAlertService} class
+ */
+public class SystemWideAlertServiceImpl implements SystemWideAlertService {
+
+ private static final Logger log = org.apache.logging.log4j.LogManager.getLogger(SystemWideAlertService.class);
+
+
+ @Autowired
+ private SystemWideAlertDAO systemWideAlertDAO;
+
+ @Autowired
+ private AuthorizeService authorizeService;
+
+ @Override
+ public SystemWideAlert create(final Context context, final String message,
+ final AllowSessionsEnum allowSessionsType,
+ final Date countdownTo, final boolean active) throws SQLException,
+ AuthorizeException {
+ if (!authorizeService.isAdmin(context)) {
+ throw new AuthorizeException(
+ "Only administrators can create a system-wide alert");
+ }
+ SystemWideAlert systemWideAlert = new SystemWideAlert();
+ systemWideAlert.setMessage(message);
+ systemWideAlert.setAllowSessions(allowSessionsType);
+ systemWideAlert.setCountdownTo(countdownTo);
+ systemWideAlert.setActive(active);
+
+ SystemWideAlert createdAlert = systemWideAlertDAO.create(context, systemWideAlert);
+ log.info(LogHelper.getHeader(context, "system_wide_alert_create",
+ "System Wide Alert has been created with message: '" + message + "' and ID "
+ + createdAlert.getID() + " and allowSessionsType " + allowSessionsType +
+ " and active set to " + active));
+
+
+ return createdAlert;
+ }
+
+ @Override
+ public SystemWideAlert find(final Context context, final int alertId) throws SQLException {
+ return systemWideAlertDAO.findByID(context, SystemWideAlert.class, alertId);
+ }
+
+ @Override
+ public List findAll(final Context context) throws SQLException {
+ return systemWideAlertDAO.findAll(context, SystemWideAlert.class);
+ }
+
+ @Override
+ public List findAll(final Context context, final int limit, final int offset) throws SQLException {
+ return systemWideAlertDAO.findAll(context, limit, offset);
+ }
+
+ @Override
+ public List findAllActive(final Context context, final int limit, final int offset)
+ throws SQLException {
+ return systemWideAlertDAO.findAllActive(context, limit, offset);
+ }
+
+ @Override
+ public void delete(final Context context, final SystemWideAlert systemWideAlert)
+ throws SQLException, IOException, AuthorizeException {
+ if (!authorizeService.isAdmin(context)) {
+ throw new AuthorizeException(
+ "Only administrators can create a system-wide alert");
+ }
+ systemWideAlertDAO.delete(context, systemWideAlert);
+ log.info(LogHelper.getHeader(context, "system_wide_alert_create",
+ "System Wide Alert with ID " + systemWideAlert.getID() + " has been deleted"));
+
+ }
+
+ @Override
+ public void update(final Context context, final SystemWideAlert systemWideAlert)
+ throws SQLException, AuthorizeException {
+ if (!authorizeService.isAdmin(context)) {
+ throw new AuthorizeException(
+ "Only administrators can create a system-wide alert");
+ }
+ systemWideAlertDAO.save(context, systemWideAlert);
+
+ }
+
+ @Override
+ public boolean canNonAdminUserLogin(Context context) throws SQLException {
+ List active = findAllActive(context, 1, 0);
+ if (active == null || active.isEmpty()) {
+ return true;
+ }
+ return active.get(0).getAllowSessions() == AllowSessionsEnum.ALLOW_ALL_SESSIONS;
+ }
+
+ @Override
+ public boolean canUserMaintainSession(Context context, EPerson ePerson) throws SQLException {
+ if (authorizeService.isAdmin(context, ePerson)) {
+ return true;
+ }
+ List active = findAllActive(context, 1, 0);
+ if (active == null || active.isEmpty()) {
+ return true;
+ }
+ return active.get(0).getAllowSessions() != AllowSessionsEnum.ALLOW_ADMIN_SESSIONS_ONLY;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/alerts/dao/SystemWideAlertDAO.java b/dspace-api/src/main/java/org/dspace/alerts/dao/SystemWideAlertDAO.java
new file mode 100644
index 000000000000..b26b64758355
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/alerts/dao/SystemWideAlertDAO.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.alerts.dao;
+
+import java.sql.SQLException;
+import java.util.List;
+
+import org.dspace.alerts.SystemWideAlert;
+import org.dspace.core.Context;
+import org.dspace.core.GenericDAO;
+
+/**
+ * This is the Data Access Object for the {@link SystemWideAlert} object
+ */
+public interface SystemWideAlertDAO extends GenericDAO {
+
+ /**
+ * Returns a list of all SystemWideAlert objects in the database
+ *
+ * @param context The relevant DSpace context
+ * @param limit The limit for the amount of SystemWideAlerts returned
+ * @param offset The offset for the Processes to be returned
+ * @return The list of all SystemWideAlert objects in the Database
+ * @throws SQLException If something goes wrong
+ */
+ List findAll(Context context, int limit, int offset) throws SQLException;
+
+ /**
+ * Returns a list of all active SystemWideAlert objects in the database
+ *
+ * @param context The relevant DSpace context
+ * @param limit The limit for the amount of SystemWideAlerts returned
+ * @param offset The offset for the Processes to be returned
+ * @return The list of all SystemWideAlert objects in the Database
+ * @throws SQLException If something goes wrong
+ */
+ List findAllActive(Context context, int limit, int offset) throws SQLException;
+
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/alerts/dao/impl/SystemWideAlertDAOImpl.java b/dspace-api/src/main/java/org/dspace/alerts/dao/impl/SystemWideAlertDAOImpl.java
new file mode 100644
index 000000000000..13a0e0af236a
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/alerts/dao/impl/SystemWideAlertDAOImpl.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.alerts.dao.impl;
+
+import java.sql.SQLException;
+import java.util.List;
+import javax.persistence.criteria.CriteriaBuilder;
+import javax.persistence.criteria.CriteriaQuery;
+import javax.persistence.criteria.Root;
+
+import org.dspace.alerts.SystemWideAlert;
+import org.dspace.alerts.SystemWideAlert_;
+import org.dspace.alerts.dao.SystemWideAlertDAO;
+import org.dspace.core.AbstractHibernateDAO;
+import org.dspace.core.Context;
+
+/**
+ * Implementation class for the {@link SystemWideAlertDAO}
+ */
+public class SystemWideAlertDAOImpl extends AbstractHibernateDAO implements SystemWideAlertDAO {
+
+ public List findAll(final Context context, final int limit, final int offset) throws SQLException {
+ CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
+ CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, SystemWideAlert.class);
+ Root alertRoot = criteriaQuery.from(SystemWideAlert.class);
+ criteriaQuery.select(alertRoot);
+
+ return list(context, criteriaQuery, false, SystemWideAlert.class, limit, offset);
+ }
+
+ public List findAllActive(final Context context, final int limit, final int offset)
+ throws SQLException {
+ CriteriaBuilder criteriaBuilder = getCriteriaBuilder(context);
+ CriteriaQuery criteriaQuery = getCriteriaQuery(criteriaBuilder, SystemWideAlert.class);
+ Root alertRoot = criteriaQuery.from(SystemWideAlert.class);
+ criteriaQuery.select(alertRoot);
+ criteriaQuery.where(criteriaBuilder.equal(alertRoot.get(SystemWideAlert_.active), true));
+
+ return list(context, criteriaQuery, false, SystemWideAlert.class, limit, offset);
+ }
+
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/alerts/service/SystemWideAlertService.java b/dspace-api/src/main/java/org/dspace/alerts/service/SystemWideAlertService.java
new file mode 100644
index 000000000000..cf231308849d
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/alerts/service/SystemWideAlertService.java
@@ -0,0 +1,118 @@
+/**
+ * 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.alerts.service;
+
+import java.io.IOException;
+import java.sql.SQLException;
+import java.util.Date;
+import java.util.List;
+
+import org.dspace.alerts.AllowSessionsEnum;
+import org.dspace.alerts.SystemWideAlert;
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+
+/**
+ * An interface for the SystemWideAlertService with methods regarding the SystemWideAlert workload
+ */
+public interface SystemWideAlertService {
+
+ /**
+ * This method will create a SystemWideAlert object in the database
+ *
+ * @param context The relevant DSpace context
+ * @param message The message of the system-wide alert
+ * @param allowSessionsType Which sessions need to be allowed for the system-wide alert
+ * @param countdownTo The date to which to count down to when the system-wide alert is active
+ * @param active Whether the system-wide alert os active
+ * @return The created SystemWideAlert object
+ * @throws SQLException If something goes wrong
+ */
+ SystemWideAlert create(Context context, String message, AllowSessionsEnum allowSessionsType,
+ Date countdownTo, boolean active
+ ) throws SQLException, AuthorizeException;
+
+ /**
+ * This method will retrieve a SystemWideAlert object from the Database with the given ID
+ *
+ * @param context The relevant DSpace context
+ * @param alertId The alert id on which we'll search for in the database
+ * @return The system-wide alert that holds the given alert id
+ * @throws SQLException If something goes wrong
+ */
+ SystemWideAlert find(Context context, int alertId) throws SQLException;
+
+ /**
+ * Returns a list of all SystemWideAlert objects in the database
+ *
+ * @param context The relevant DSpace context
+ * @return The list of all SystemWideAlert objects in the Database
+ * @throws SQLException If something goes wrong
+ */
+ List findAll(Context context) throws SQLException;
+
+ /**
+ * Returns a list of all SystemWideAlert objects in the database
+ *
+ * @param context The relevant DSpace context
+ * @param limit The limit for the amount of system-wide alerts returned
+ * @param offset The offset for the system-wide alerts to be returned
+ * @return The list of all SystemWideAlert objects in the Database
+ * @throws SQLException If something goes wrong
+ */
+ List findAll(Context context, int limit, int offset) throws SQLException;
+
+
+ /**
+ * Returns a list of all active SystemWideAlert objects in the database
+ *
+ * @param context The relevant DSpace context
+ * @return The list of all active SystemWideAlert objects in the database
+ * @throws SQLException If something goes wrong
+ */
+ List findAllActive(Context context, int limit, int offset) throws SQLException;
+
+ /**
+ * This method will delete the given SystemWideAlert object from the database
+ *
+ * @param context The relevant DSpace context
+ * @param systemWideAlert The SystemWideAlert object to be deleted
+ * @throws SQLException If something goes wrong
+ */
+ void delete(Context context, SystemWideAlert systemWideAlert)
+ throws SQLException, IOException, AuthorizeException;
+
+
+ /**
+ * This method will be used to update the given SystemWideAlert object in the database
+ *
+ * @param context The relevant DSpace context
+ * @param systemWideAlert The SystemWideAlert object to be updated
+ * @throws SQLException If something goes wrong
+ */
+ void update(Context context, SystemWideAlert systemWideAlert) throws SQLException, AuthorizeException;
+
+
+ /**
+ * Verifies if the user connected to the current context can retain its session
+ *
+ * @param context The relevant DSpace context
+ * @return if the user connected to the current context can retain its session
+ */
+ boolean canUserMaintainSession(Context context, EPerson ePerson) throws SQLException;
+
+
+ /**
+ * Verifies if a non admin user can log in
+ *
+ * @param context The relevant DSpace context
+ * @return if a non admin user can log in
+ */
+ boolean canNonAdminUserLogin(Context context) throws SQLException;
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControl.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControl.java
new file mode 100644
index 000000000000..7bef232f0450
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControl.java
@@ -0,0 +1,689 @@
+/**
+ * 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.bulkaccesscontrol;
+
+import static org.apache.commons.collections4.CollectionUtils.isEmpty;
+import static org.apache.commons.collections4.CollectionUtils.isNotEmpty;
+import static org.dspace.authorize.ResourcePolicy.TYPE_CUSTOM;
+import static org.dspace.authorize.ResourcePolicy.TYPE_INHERITED;
+import static org.dspace.core.Constants.CONTENT_BUNDLE_NAME;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.sql.SQLException;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.Arrays;
+import java.util.Date;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.TimeZone;
+import java.util.UUID;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.apache.commons.cli.ParseException;
+import org.apache.commons.lang3.StringUtils;
+import org.dspace.app.bulkaccesscontrol.exception.BulkAccessControlException;
+import org.dspace.app.bulkaccesscontrol.model.AccessCondition;
+import org.dspace.app.bulkaccesscontrol.model.AccessConditionBitstream;
+import org.dspace.app.bulkaccesscontrol.model.AccessConditionItem;
+import org.dspace.app.bulkaccesscontrol.model.BulkAccessConditionConfiguration;
+import org.dspace.app.bulkaccesscontrol.model.BulkAccessControlInput;
+import org.dspace.app.bulkaccesscontrol.service.BulkAccessConditionConfigurationService;
+import org.dspace.app.mediafilter.factory.MediaFilterServiceFactory;
+import org.dspace.app.mediafilter.service.MediaFilterService;
+import org.dspace.app.util.DSpaceObjectUtilsImpl;
+import org.dspace.app.util.service.DSpaceObjectUtils;
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.authorize.factory.AuthorizeServiceFactory;
+import org.dspace.authorize.service.ResourcePolicyService;
+import org.dspace.content.Bitstream;
+import org.dspace.content.Collection;
+import org.dspace.content.DSpaceObject;
+import org.dspace.content.Item;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.ItemService;
+import org.dspace.core.Constants;
+import org.dspace.core.Context;
+import org.dspace.discovery.DiscoverQuery;
+import org.dspace.discovery.SearchService;
+import org.dspace.discovery.SearchServiceException;
+import org.dspace.discovery.SearchUtils;
+import org.dspace.discovery.indexobject.IndexableItem;
+import org.dspace.eperson.EPerson;
+import org.dspace.eperson.factory.EPersonServiceFactory;
+import org.dspace.eperson.service.EPersonService;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.services.ConfigurationService;
+import org.dspace.services.factory.DSpaceServicesFactory;
+import org.dspace.submit.model.AccessConditionOption;
+import org.dspace.utils.DSpace;
+
+/**
+ * Implementation of {@link DSpaceRunnable} to perform a bulk access control via json file.
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ *
+ */
+public class BulkAccessControl extends DSpaceRunnable> {
+
+ private DSpaceObjectUtils dSpaceObjectUtils;
+
+ private SearchService searchService;
+
+ private ItemService itemService;
+
+ private String filename;
+
+ private List uuids;
+
+ private Context context;
+
+ private BulkAccessConditionConfigurationService bulkAccessConditionConfigurationService;
+
+ private ResourcePolicyService resourcePolicyService;
+
+ protected EPersonService epersonService;
+
+ private ConfigurationService configurationService;
+
+ private MediaFilterService mediaFilterService;
+
+ private Map itemAccessConditions;
+
+ private Map uploadAccessConditions;
+
+ private final String ADD_MODE = "add";
+
+ private final String REPLACE_MODE = "replace";
+
+ private boolean help = false;
+
+ protected String eperson = null;
+
+ @Override
+ @SuppressWarnings("unchecked")
+ public void setup() throws ParseException {
+
+ this.searchService = SearchUtils.getSearchService();
+ this.itemService = ContentServiceFactory.getInstance().getItemService();
+ this.resourcePolicyService = AuthorizeServiceFactory.getInstance().getResourcePolicyService();
+ this.epersonService = EPersonServiceFactory.getInstance().getEPersonService();
+ this.configurationService = DSpaceServicesFactory.getInstance().getConfigurationService();
+ mediaFilterService = MediaFilterServiceFactory.getInstance().getMediaFilterService();
+ mediaFilterService.setLogHandler(handler);
+ this.bulkAccessConditionConfigurationService = new DSpace().getServiceManager().getServiceByName(
+ "bulkAccessConditionConfigurationService", BulkAccessConditionConfigurationService.class);
+ this.dSpaceObjectUtils = new DSpace().getServiceManager().getServiceByName(
+ DSpaceObjectUtilsImpl.class.getName(), DSpaceObjectUtilsImpl.class);
+
+ BulkAccessConditionConfiguration bulkAccessConditionConfiguration =
+ bulkAccessConditionConfigurationService.getBulkAccessConditionConfiguration("default");
+
+ itemAccessConditions = bulkAccessConditionConfiguration
+ .getItemAccessConditionOptions()
+ .stream()
+ .collect(Collectors.toMap(AccessConditionOption::getName, Function.identity()));
+
+ uploadAccessConditions = bulkAccessConditionConfiguration
+ .getBitstreamAccessConditionOptions()
+ .stream()
+ .collect(Collectors.toMap(AccessConditionOption::getName, Function.identity()));
+
+ help = commandLine.hasOption('h');
+ filename = commandLine.getOptionValue('f');
+ uuids = commandLine.hasOption('u') ? Arrays.asList(commandLine.getOptionValues('u')) : null;
+ }
+
+ @Override
+ public void internalRun() throws Exception {
+
+ if (help) {
+ printHelp();
+ return;
+ }
+
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.setTimeZone(TimeZone.getTimeZone("UTC"));
+ BulkAccessControlInput accessControl;
+ context = new Context(Context.Mode.BATCH_EDIT);
+ setEPerson(context);
+
+ if (!isAuthorized(context)) {
+ handler.logError("Current user is not eligible to execute script bulk-access-control");
+ throw new AuthorizeException("Current user is not eligible to execute script bulk-access-control");
+ }
+
+ if (uuids == null || uuids.size() == 0) {
+ handler.logError("A target uuid must be provided with at least on uuid (run with -h flag for details)");
+ throw new IllegalArgumentException("At least one target uuid must be provided");
+ }
+
+ InputStream inputStream = handler.getFileStream(context, filename)
+ .orElseThrow(() -> new IllegalArgumentException("Error reading file, the file couldn't be "
+ + "found for filename: " + filename));
+
+ try {
+ accessControl = mapper.readValue(inputStream, BulkAccessControlInput.class);
+ } catch (IOException e) {
+ handler.logError("Error parsing json file " + e.getMessage());
+ throw new IllegalArgumentException("Error parsing json file", e);
+ }
+ try {
+ validate(accessControl);
+ updateItemsAndBitstreamsPolices(accessControl);
+ context.complete();
+ } catch (Exception e) {
+ handler.handleException(e);
+ context.abort();
+ }
+ }
+
+ /**
+ * check the validation of mapped json data, it must
+ * provide item or bitstream information or both of them
+ * and check the validation of item node if provided,
+ * and check the validation of bitstream node if provided.
+ *
+ * @param accessControl mapped json data
+ * @throws SQLException if something goes wrong in the database
+ * @throws BulkAccessControlException if accessControl is invalid
+ */
+ private void validate(BulkAccessControlInput accessControl) throws SQLException {
+
+ AccessConditionItem item = accessControl.getItem();
+ AccessConditionBitstream bitstream = accessControl.getBitstream();
+
+ if (Objects.isNull(item) && Objects.isNull(bitstream)) {
+ handler.logError("item or bitstream node must be provided");
+ throw new BulkAccessControlException("item or bitstream node must be provided");
+ }
+
+ if (Objects.nonNull(item)) {
+ validateItemNode(item);
+ }
+
+ if (Objects.nonNull(bitstream)) {
+ validateBitstreamNode(bitstream);
+ }
+ }
+
+ /**
+ * check the validation of item node, the item mode
+ * must be provided with value 'add' or 'replace'
+ * if mode equals to add so the information
+ * of accessCondition must be provided,
+ * also checking that accessConditions information are valid.
+ *
+ * @param item the item node
+ * @throws BulkAccessControlException if item node is invalid
+ */
+ private void validateItemNode(AccessConditionItem item) {
+ String mode = item.getMode();
+ List accessConditions = item.getAccessConditions();
+
+ if (StringUtils.isEmpty(mode)) {
+ handler.logError("item mode node must be provided");
+ throw new BulkAccessControlException("item mode node must be provided");
+ } else if (!(StringUtils.equalsAny(mode, ADD_MODE, REPLACE_MODE))) {
+ handler.logError("wrong value for item mode<" + mode + ">");
+ throw new BulkAccessControlException("wrong value for item mode<" + mode + ">");
+ } else if (ADD_MODE.equals(mode) && isEmpty(accessConditions)) {
+ handler.logError("accessConditions of item must be provided with mode<" + ADD_MODE + ">");
+ throw new BulkAccessControlException(
+ "accessConditions of item must be provided with mode<" + ADD_MODE + ">");
+ }
+
+ for (AccessCondition accessCondition : accessConditions) {
+ validateAccessCondition(accessCondition);
+ }
+ }
+
+ /**
+ * check the validation of bitstream node, the bitstream mode
+ * must be provided with value 'add' or 'replace'
+ * if mode equals to add so the information of accessConditions
+ * must be provided,
+ * also checking that constraint information is valid,
+ * also checking that accessConditions information are valid.
+ *
+ * @param bitstream the bitstream node
+ * @throws SQLException if something goes wrong in the database
+ * @throws BulkAccessControlException if bitstream node is invalid
+ */
+ private void validateBitstreamNode(AccessConditionBitstream bitstream) throws SQLException {
+ String mode = bitstream.getMode();
+ List accessConditions = bitstream.getAccessConditions();
+
+ if (StringUtils.isEmpty(mode)) {
+ handler.logError("bitstream mode node must be provided");
+ throw new BulkAccessControlException("bitstream mode node must be provided");
+ } else if (!(StringUtils.equalsAny(mode, ADD_MODE, REPLACE_MODE))) {
+ handler.logError("wrong value for bitstream mode<" + mode + ">");
+ throw new BulkAccessControlException("wrong value for bitstream mode<" + mode + ">");
+ } else if (ADD_MODE.equals(mode) && isEmpty(accessConditions)) {
+ handler.logError("accessConditions of bitstream must be provided with mode<" + ADD_MODE + ">");
+ throw new BulkAccessControlException(
+ "accessConditions of bitstream must be provided with mode<" + ADD_MODE + ">");
+ }
+
+ validateConstraint(bitstream);
+
+ for (AccessCondition accessCondition : bitstream.getAccessConditions()) {
+ validateAccessCondition(accessCondition);
+ }
+ }
+
+ /**
+ * check the validation of constraint node if provided,
+ * constraint isn't supported when multiple uuids are provided
+ * or when uuid isn't an Item
+ *
+ * @param bitstream the bitstream node
+ * @throws SQLException if something goes wrong in the database
+ * @throws BulkAccessControlException if constraint node is invalid
+ */
+ private void validateConstraint(AccessConditionBitstream bitstream) throws SQLException {
+ if (uuids.size() > 1 && containsConstraints(bitstream)) {
+ handler.logError("constraint isn't supported when multiple uuids are provided");
+ throw new BulkAccessControlException("constraint isn't supported when multiple uuids are provided");
+ } else if (uuids.size() == 1 && containsConstraints(bitstream)) {
+ DSpaceObject dso =
+ dSpaceObjectUtils.findDSpaceObject(context, UUID.fromString(uuids.get(0)));
+
+ if (Objects.nonNull(dso) && dso.getType() != Constants.ITEM) {
+ handler.logError("constraint is not supported when uuid isn't an Item");
+ throw new BulkAccessControlException("constraint is not supported when uuid isn't an Item");
+ }
+ }
+ }
+
+ /**
+ * check the validation of access condition,
+ * the access condition name must equal to one of configured access conditions,
+ * then call {@link AccessConditionOption#validateResourcePolicy(
+ * Context, String, Date, Date)} if exception happens so, it's invalid.
+ *
+ * @param accessCondition the accessCondition
+ * @throws BulkAccessControlException if the accessCondition is invalid
+ */
+ private void validateAccessCondition(AccessCondition accessCondition) {
+
+ if (!itemAccessConditions.containsKey(accessCondition.getName())) {
+ handler.logError("wrong access condition <" + accessCondition.getName() + ">");
+ throw new BulkAccessControlException("wrong access condition <" + accessCondition.getName() + ">");
+ }
+
+ try {
+ itemAccessConditions.get(accessCondition.getName()).validateResourcePolicy(
+ context, accessCondition.getName(), accessCondition.getStartDate(), accessCondition.getEndDate());
+ } catch (Exception e) {
+ handler.logError("invalid access condition, " + e.getMessage());
+ handler.handleException(e);
+ }
+ }
+
+ /**
+ * find all items of provided {@link #uuids} from solr,
+ * then update the resource policies of items
+ * or bitstreams of items (only bitstreams of ORIGINAL bundles)
+ * and derivative bitstreams, or both of them.
+ *
+ * @param accessControl the access control input
+ * @throws SQLException if something goes wrong in the database
+ * @throws SearchServiceException if a search error occurs
+ * @throws AuthorizeException if an authorization error occurs
+ */
+ private void updateItemsAndBitstreamsPolices(BulkAccessControlInput accessControl)
+ throws SQLException, SearchServiceException, AuthorizeException {
+
+ int counter = 0;
+ int start = 0;
+ int limit = 20;
+
+ String query = buildSolrQuery(uuids);
+
+ Iterator- itemIterator = findItems(query, start, limit);
+
+ while (itemIterator.hasNext()) {
+
+ Item item = context.reloadEntity(itemIterator.next());
+
+ if (Objects.nonNull(accessControl.getItem())) {
+ updateItemPolicies(item, accessControl);
+ }
+
+ if (Objects.nonNull(accessControl.getBitstream())) {
+ updateBitstreamsPolicies(item, accessControl);
+ }
+
+ context.commit();
+ context.uncacheEntity(item);
+ counter++;
+
+ if (counter == limit) {
+ counter = 0;
+ start += limit;
+ itemIterator = findItems(query, start, limit);
+ }
+ }
+ }
+
+ private String buildSolrQuery(List uuids) throws SQLException {
+ String [] query = new String[uuids.size()];
+
+ for (int i = 0 ; i < query.length ; i++) {
+ DSpaceObject dso = dSpaceObjectUtils.findDSpaceObject(context, UUID.fromString(uuids.get(i)));
+
+ if (dso.getType() == Constants.COMMUNITY) {
+ query[i] = "location.comm:" + dso.getID();
+ } else if (dso.getType() == Constants.COLLECTION) {
+ query[i] = "location.coll:" + dso.getID();
+ } else if (dso.getType() == Constants.ITEM) {
+ query[i] = "search.resourceid:" + dso.getID();
+ }
+ }
+ return StringUtils.joinWith(" OR ", query);
+ }
+
+ private Iterator
- findItems(String query, int start, int limit)
+ throws SearchServiceException {
+
+ DiscoverQuery discoverQuery = buildDiscoveryQuery(query, start, limit);
+
+ return searchService.search(context, discoverQuery)
+ .getIndexableObjects()
+ .stream()
+ .map(indexableObject ->
+ ((IndexableItem) indexableObject).getIndexedObject())
+ .collect(Collectors.toList())
+ .iterator();
+ }
+
+ private DiscoverQuery buildDiscoveryQuery(String query, int start, int limit) {
+ DiscoverQuery discoverQuery = new DiscoverQuery();
+ discoverQuery.setDSpaceObjectFilter(IndexableItem.TYPE);
+ discoverQuery.setQuery(query);
+ discoverQuery.setStart(start);
+ discoverQuery.setMaxResults(limit);
+
+ return discoverQuery;
+ }
+
+ /**
+ * update the item resource policies,
+ * when mode equals to 'replace' will remove
+ * all current resource polices of types 'TYPE_CUSTOM'
+ * and 'TYPE_INHERITED' then, set the new resource policies.
+ *
+ * @param item the item
+ * @param accessControl the access control input
+ * @throws SQLException if something goes wrong in the database
+ * @throws AuthorizeException if an authorization error occurs
+ */
+ private void updateItemPolicies(Item item, BulkAccessControlInput accessControl)
+ throws SQLException, AuthorizeException {
+
+ AccessConditionItem acItem = accessControl.getItem();
+
+ if (REPLACE_MODE.equals(acItem.getMode())) {
+ removeReadPolicies(item, TYPE_CUSTOM);
+ removeReadPolicies(item, TYPE_INHERITED);
+ }
+
+ setItemPolicies(item, accessControl);
+ logInfo(acItem.getAccessConditions(), acItem.getMode(), item);
+ }
+
+ /**
+ * create the new resource policies of item.
+ * then, call {@link ItemService#adjustItemPolicies(
+ * Context, Item, Collection)} to adjust item's default policies.
+ *
+ * @param item the item
+ * @param accessControl the access control input
+ * @throws SQLException if something goes wrong in the database
+ * @throws AuthorizeException if an authorization error occurs
+ */
+ private void setItemPolicies(Item item, BulkAccessControlInput accessControl)
+ throws SQLException, AuthorizeException {
+
+ accessControl
+ .getItem()
+ .getAccessConditions()
+ .forEach(accessCondition -> createResourcePolicy(item, accessCondition,
+ itemAccessConditions.get(accessCondition.getName())));
+
+ itemService.adjustItemPolicies(context, item, item.getOwningCollection(), false);
+ }
+
+ /**
+ * update the resource policies of all item's bitstreams
+ * or bitstreams specified into constraint node,
+ * and derivative bitstreams.
+ *
+ * NOTE: only bitstreams of ORIGINAL bundles
+ *
+ * @param item the item contains bitstreams
+ * @param accessControl the access control input
+ */
+ private void updateBitstreamsPolicies(Item item, BulkAccessControlInput accessControl) {
+ AccessConditionBitstream.Constraint constraints = accessControl.getBitstream().getConstraints();
+
+ // look over all the bundles and force initialization of bitstreams collection
+ // to avoid lazy initialization exception
+ long count = item.getBundles()
+ .stream()
+ .flatMap(bundle ->
+ bundle.getBitstreams().stream())
+ .count();
+
+ item.getBundles(CONTENT_BUNDLE_NAME).stream()
+ .flatMap(bundle -> bundle.getBitstreams().stream())
+ .filter(bitstream -> constraints == null ||
+ constraints.getUuid() == null ||
+ constraints.getUuid().size() == 0 ||
+ constraints.getUuid().contains(bitstream.getID().toString()))
+ .forEach(bitstream -> updateBitstreamPolicies(bitstream, item, accessControl));
+ }
+
+ /**
+ * check that the bitstream node is existed,
+ * and contains constraint node,
+ * and constraint contains uuids.
+ *
+ * @param bitstream the bitstream node
+ * @return true when uuids of constraint of bitstream is not empty,
+ * otherwise false
+ */
+ private boolean containsConstraints(AccessConditionBitstream bitstream) {
+ return Objects.nonNull(bitstream) &&
+ Objects.nonNull(bitstream.getConstraints()) &&
+ isNotEmpty(bitstream.getConstraints().getUuid());
+ }
+
+ /**
+ * update the bitstream resource policies,
+ * when mode equals to replace will remove
+ * all current resource polices of types 'TYPE_CUSTOM'
+ * and 'TYPE_INHERITED' then, set the new resource policies.
+ *
+ * @param bitstream the bitstream
+ * @param item the item of bitstream
+ * @param accessControl the access control input
+ * @throws RuntimeException if something goes wrong in the database
+ * or an authorization error occurs
+ */
+ private void updateBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessControlInput accessControl) {
+
+ AccessConditionBitstream acBitstream = accessControl.getBitstream();
+
+ if (REPLACE_MODE.equals(acBitstream.getMode())) {
+ removeReadPolicies(bitstream, TYPE_CUSTOM);
+ removeReadPolicies(bitstream, TYPE_INHERITED);
+ }
+
+ try {
+ setBitstreamPolicies(bitstream, item, accessControl);
+ logInfo(acBitstream.getAccessConditions(), acBitstream.getMode(), bitstream);
+ } catch (SQLException | AuthorizeException e) {
+ throw new RuntimeException(e);
+ }
+
+ }
+
+ /**
+ * remove dspace object's read policies.
+ *
+ * @param dso the dspace object
+ * @param type resource policy type
+ * @throws BulkAccessControlException if something goes wrong
+ * in the database or an authorization error occurs
+ */
+ private void removeReadPolicies(DSpaceObject dso, String type) {
+ try {
+ resourcePolicyService.removePolicies(context, dso, type, Constants.READ);
+ } catch (SQLException | AuthorizeException e) {
+ throw new BulkAccessControlException(e);
+ }
+ }
+
+ /**
+ * create the new resource policies of bitstream.
+ * then, call {@link ItemService#adjustItemPolicies(
+ * Context, Item, Collection)} to adjust bitstream's default policies.
+ * and also update the resource policies of its derivative bitstreams.
+ *
+ * @param bitstream the bitstream
+ * @param item the item of bitstream
+ * @param accessControl the access control input
+ * @throws SQLException if something goes wrong in the database
+ * @throws AuthorizeException if an authorization error occurs
+ */
+ private void setBitstreamPolicies(Bitstream bitstream, Item item, BulkAccessControlInput accessControl)
+ throws SQLException, AuthorizeException {
+
+ accessControl.getBitstream()
+ .getAccessConditions()
+ .forEach(accessCondition -> createResourcePolicy(bitstream, accessCondition,
+ uploadAccessConditions.get(accessCondition.getName())));
+
+ itemService.adjustBitstreamPolicies(context, item, item.getOwningCollection(), bitstream);
+ mediaFilterService.updatePoliciesOfDerivativeBitstreams(context, item, bitstream);
+ }
+
+ /**
+ * create the resource policy from the information
+ * comes from the access condition.
+ *
+ * @param obj the dspace object
+ * @param accessCondition the access condition
+ * @param accessConditionOption the access condition option
+ * @throws BulkAccessControlException if an exception occurs
+ */
+ private void createResourcePolicy(DSpaceObject obj, AccessCondition accessCondition,
+ AccessConditionOption accessConditionOption) {
+
+ String name = accessCondition.getName();
+ String description = accessCondition.getDescription();
+ Date startDate = accessCondition.getStartDate();
+ Date endDate = accessCondition.getEndDate();
+
+ try {
+ accessConditionOption.createResourcePolicy(context, obj, name, description, startDate, endDate);
+ } catch (Exception e) {
+ throw new BulkAccessControlException(e);
+ }
+ }
+
+ /**
+ * Set the eperson in the context
+ *
+ * @param context the context
+ * @throws SQLException if database error
+ */
+ protected void setEPerson(Context context) throws SQLException {
+ EPerson myEPerson = epersonService.find(context, this.getEpersonIdentifier());
+
+ if (myEPerson == null) {
+ handler.logError("EPerson cannot be found: " + this.getEpersonIdentifier());
+ throw new UnsupportedOperationException("EPerson cannot be found: " + this.getEpersonIdentifier());
+ }
+
+ context.setCurrentUser(myEPerson);
+ }
+
+ private void logInfo(List accessConditions, String mode, DSpaceObject dso) {
+ String type = dso.getClass().getSimpleName();
+
+ if (REPLACE_MODE.equals(mode) && isEmpty(accessConditions)) {
+ handler.logInfo("Cleaning " + type + " {" + dso.getID() + "} policies");
+ handler.logInfo("Inheriting policies from owning Collection in " + type + " {" + dso.getID() + "}");
+ return;
+ }
+
+ StringBuilder message = new StringBuilder();
+ message.append(mode.equals(ADD_MODE) ? "Adding " : "Replacing ")
+ .append(type)
+ .append(" {")
+ .append(dso.getID())
+ .append("} policy")
+ .append(mode.equals(ADD_MODE) ? " with " : " to ")
+ .append("access conditions:");
+
+ AppendAccessConditionsInfo(message, accessConditions);
+
+ handler.logInfo(message.toString());
+
+ if (REPLACE_MODE.equals(mode) && isAppendModeEnabled()) {
+ handler.logInfo("Inheriting policies from owning Collection in " + type + " {" + dso.getID() + "}");
+ }
+ }
+
+ private void AppendAccessConditionsInfo(StringBuilder message, List accessConditions) {
+ DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
+ message.append("{");
+
+ for (int i = 0; i < accessConditions.size(); i++) {
+ message.append(accessConditions.get(i).getName());
+
+ Optional.ofNullable(accessConditions.get(i).getStartDate())
+ .ifPresent(date -> message.append(", start_date=" + dateFormat.format(date)));
+
+ Optional.ofNullable(accessConditions.get(i).getEndDate())
+ .ifPresent(date -> message.append(", end_date=" + dateFormat.format(date)));
+
+ if (i != accessConditions.size() - 1) {
+ message.append(", ");
+ }
+ }
+
+ message.append("}");
+ }
+
+ private boolean isAppendModeEnabled() {
+ return configurationService.getBooleanProperty("core.authorization.installitem.inheritance-read.append-mode");
+ }
+
+ protected boolean isAuthorized(Context context) {
+ return true;
+ }
+
+ @Override
+ @SuppressWarnings("unchecked")
+ public BulkAccessControlScriptConfiguration getScriptConfiguration() {
+ return new DSpace().getServiceManager()
+ .getServiceByName("bulk-access-control", BulkAccessControlScriptConfiguration.class);
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlCli.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlCli.java
new file mode 100644
index 000000000000..4e8cfe480eeb
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlCli.java
@@ -0,0 +1,66 @@
+/**
+ * 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.bulkaccesscontrol;
+
+import java.sql.SQLException;
+import java.util.Arrays;
+import java.util.UUID;
+import java.util.stream.Collectors;
+
+import org.apache.commons.lang3.StringUtils;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+import org.dspace.scripts.DSpaceCommandLineParameter;
+
+/**
+ * Extension of {@link BulkAccessControl} for CLI.
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ *
+ */
+public class BulkAccessControlCli extends BulkAccessControl {
+
+ @Override
+ protected void setEPerson(Context context) throws SQLException {
+ EPerson myEPerson;
+ eperson = commandLine.getOptionValue('e');
+
+ if (eperson == null) {
+ handler.logError("An eperson to do the the Bulk Access Control must be specified " +
+ "(run with -h flag for details)");
+ throw new UnsupportedOperationException("An eperson to do the Bulk Access Control must be specified");
+ }
+
+ if (StringUtils.contains(eperson, '@')) {
+ myEPerson = epersonService.findByEmail(context, eperson);
+ } else {
+ myEPerson = epersonService.find(context, UUID.fromString(eperson));
+ }
+
+ if (myEPerson == null) {
+ handler.logError("EPerson cannot be found: " + eperson + " (run with -h flag for details)");
+ throw new UnsupportedOperationException("EPerson cannot be found: " + eperson);
+ }
+
+ context.setCurrentUser(myEPerson);
+ }
+
+ @Override
+ protected boolean isAuthorized(Context context) {
+
+ if (context.getCurrentUser() == null) {
+ return false;
+ }
+
+ return getScriptConfiguration().isAllowedToExecute(context,
+ Arrays.stream(commandLine.getOptions())
+ .map(option ->
+ new DSpaceCommandLineParameter("-" + option.getOpt(), option.getValue()))
+ .collect(Collectors.toList()));
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlCliScriptConfiguration.java
new file mode 100644
index 000000000000..951c93db3030
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlCliScriptConfiguration.java
@@ -0,0 +1,42 @@
+/**
+ * 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.bulkaccesscontrol;
+
+import java.io.InputStream;
+
+import org.apache.commons.cli.Options;
+
+/**
+ * Extension of {@link BulkAccessControlScriptConfiguration} for CLI.
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ *
+ */
+public class BulkAccessControlCliScriptConfiguration
+ extends BulkAccessControlScriptConfiguration {
+
+ @Override
+ public Options getOptions() {
+ Options options = new Options();
+
+ options.addOption("u", "uuid", true, "target uuids of communities/collections/items");
+ options.getOption("u").setType(String.class);
+ options.getOption("u").setRequired(true);
+
+ options.addOption("f", "file", true, "source json file");
+ options.getOption("f").setType(InputStream.class);
+ options.getOption("f").setRequired(true);
+
+ options.addOption("e", "eperson", true, "email of EPerson used to perform actions");
+ options.getOption("e").setRequired(true);
+
+ options.addOption("h", "help", false, "help");
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlScriptConfiguration.java
new file mode 100644
index 000000000000..5196247f94cb
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/BulkAccessControlScriptConfiguration.java
@@ -0,0 +1,110 @@
+/**
+ * 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.bulkaccesscontrol;
+
+import java.io.InputStream;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.Objects;
+import java.util.UUID;
+import java.util.stream.Collectors;
+
+import org.apache.commons.cli.Options;
+import org.dspace.app.util.DSpaceObjectUtilsImpl;
+import org.dspace.app.util.service.DSpaceObjectUtils;
+import org.dspace.content.DSpaceObject;
+import org.dspace.core.Context;
+import org.dspace.scripts.DSpaceCommandLineParameter;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+import org.dspace.utils.DSpace;
+
+/**
+ * Script configuration for {@link BulkAccessControl}.
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ *
+ * @param the {@link BulkAccessControl} type
+ */
+public class BulkAccessControlScriptConfiguration extends ScriptConfiguration {
+
+ private Class dspaceRunnableClass;
+
+ @Override
+ public boolean isAllowedToExecute(Context context, List commandLineParameters) {
+
+ try {
+ if (Objects.isNull(commandLineParameters)) {
+ return authorizeService.isAdmin(context) || authorizeService.isComColAdmin(context)
+ || authorizeService.isItemAdmin(context);
+ } else {
+ List dspaceObjectIDs =
+ commandLineParameters.stream()
+ .filter(parameter -> "-u".equals(parameter.getName()))
+ .map(DSpaceCommandLineParameter::getValue)
+ .collect(Collectors.toList());
+
+ DSpaceObjectUtils dSpaceObjectUtils = new DSpace().getServiceManager().getServiceByName(
+ DSpaceObjectUtilsImpl.class.getName(), DSpaceObjectUtilsImpl.class);
+
+ for (String dspaceObjectID : dspaceObjectIDs) {
+
+ DSpaceObject dso = dSpaceObjectUtils.findDSpaceObject(context, UUID.fromString(dspaceObjectID));
+
+ if (Objects.isNull(dso)) {
+ throw new IllegalArgumentException();
+ }
+
+ if (!authorizeService.isAdmin(context, dso)) {
+ return false;
+ }
+ }
+ }
+ } catch (SQLException e) {
+ throw new RuntimeException(e);
+ }
+
+ return true;
+ }
+
+ @Override
+ public Options getOptions() {
+ if (options == null) {
+ Options options = new Options();
+
+ options.addOption("u", "uuid", true, "target uuids of communities/collections/items");
+ options.getOption("u").setType(String.class);
+ options.getOption("u").setRequired(true);
+
+ options.addOption("f", "file", true, "source json file");
+ options.getOption("f").setType(InputStream.class);
+ options.getOption("f").setRequired(true);
+
+ options.addOption("h", "help", false, "help");
+
+ super.options = options;
+ }
+ return options;
+ }
+
+ @Override
+ public Class getDspaceRunnableClass() {
+ return dspaceRunnableClass;
+ }
+
+ /**
+ * Generic setter for the dspaceRunnableClass
+ *
+ * @param dspaceRunnableClass The dspaceRunnableClass to be set on this
+ * BulkImportScriptConfiguration
+ */
+ @Override
+ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
+ this.dspaceRunnableClass = dspaceRunnableClass;
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/exception/BulkAccessControlException.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/exception/BulkAccessControlException.java
new file mode 100644
index 000000000000..092611eb0654
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/exception/BulkAccessControlException.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.bulkaccesscontrol.exception;
+
+/**
+ * Exception for errors that occurs during the bulk access control
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ *
+ */
+public class BulkAccessControlException 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 BulkAccessControlException(String message, Throwable cause) {
+ super(message, cause);
+ }
+
+ /**
+ * Constructor with error message.
+ *
+ * @param message the error message
+ */
+ public BulkAccessControlException(String message) {
+ super(message);
+ }
+
+ /**
+ * Constructor with error cause.
+ *
+ * @param cause the error cause
+ */
+ public BulkAccessControlException(Throwable cause) {
+ super(cause);
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessCondition.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessCondition.java
new file mode 100644
index 000000000000..6cf95e0e2179
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessCondition.java
@@ -0,0 +1,59 @@
+/**
+ * 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.bulkaccesscontrol.model;
+
+import java.util.Date;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import org.dspace.app.bulkaccesscontrol.BulkAccessControl;
+import org.dspace.util.MultiFormatDateDeserializer;
+
+/**
+ * Class that model the values of an Access Condition as expressed in the {@link BulkAccessControl} input file
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ */
+public class AccessCondition {
+
+ private String name;
+
+ private String description;
+
+ @JsonDeserialize(using = MultiFormatDateDeserializer.class)
+ private Date startDate;
+
+ @JsonDeserialize(using = MultiFormatDateDeserializer.class)
+ private Date endDate;
+
+ public AccessCondition() {
+ }
+
+ public AccessCondition(String name, String description, Date startDate, Date endDate) {
+ this.name = name;
+ this.description = description;
+ this.startDate = startDate;
+ this.endDate = endDate;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public Date getStartDate() {
+ return startDate;
+ }
+
+ public Date getEndDate() {
+ return endDate;
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessConditionBitstream.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessConditionBitstream.java
new file mode 100644
index 000000000000..2176e24d7f9d
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessConditionBitstream.java
@@ -0,0 +1,69 @@
+/**
+ * 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.bulkaccesscontrol.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.dspace.app.bulkaccesscontrol.BulkAccessControl;
+
+/**
+ * Class that model the value of bitstream node
+ * from json file of the {@link BulkAccessControl}
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ */
+public class AccessConditionBitstream {
+
+ private String mode;
+
+ private Constraint constraints;
+
+ private List accessConditions;
+
+ public String getMode() {
+ return mode;
+ }
+
+ public void setMode(String mode) {
+ this.mode = mode;
+ }
+
+ public Constraint getConstraints() {
+ return constraints;
+ }
+
+ public void setConstraints(Constraint constraints) {
+ this.constraints = constraints;
+ }
+
+ public List getAccessConditions() {
+ if (accessConditions == null) {
+ return new ArrayList<>();
+ }
+ return accessConditions;
+ }
+
+ public void setAccessConditions(List accessConditions) {
+ this.accessConditions = accessConditions;
+ }
+
+ public class Constraint {
+
+ private List uuid;
+
+ public List getUuid() {
+ return uuid;
+ }
+
+ public void setUuid(List uuid) {
+ this.uuid = uuid;
+ }
+ }
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessConditionItem.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessConditionItem.java
new file mode 100644
index 000000000000..c482dfc34d65
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/AccessConditionItem.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.bulkaccesscontrol.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.dspace.app.bulkaccesscontrol.BulkAccessControl;
+
+/**
+ * Class that model the value of item node
+ * from json file of the {@link BulkAccessControl}
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ */
+public class AccessConditionItem {
+
+ String mode;
+
+ List accessConditions;
+
+ public String getMode() {
+ return mode;
+ }
+
+ public void setMode(String mode) {
+ this.mode = mode;
+ }
+
+ public List getAccessConditions() {
+ if (accessConditions == null) {
+ return new ArrayList<>();
+ }
+ return accessConditions;
+ }
+
+ public void setAccessConditions(List accessConditions) {
+ this.accessConditions = accessConditions;
+ }
+}
\ No newline at end of file
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/BulkAccessConditionConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/BulkAccessConditionConfiguration.java
new file mode 100644
index 000000000000..a2ebbe5a12d4
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/BulkAccessConditionConfiguration.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.bulkaccesscontrol.model;
+
+import java.util.List;
+
+import org.dspace.submit.model.AccessConditionOption;
+
+/**
+ * A collection of conditions to be met when bulk access condition.
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ */
+public class BulkAccessConditionConfiguration {
+
+ private String name;
+ private List itemAccessConditionOptions;
+ private List bitstreamAccessConditionOptions;
+
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+
+ public List getItemAccessConditionOptions() {
+ return itemAccessConditionOptions;
+ }
+
+ public void setItemAccessConditionOptions(
+ List itemAccessConditionOptions) {
+ this.itemAccessConditionOptions = itemAccessConditionOptions;
+ }
+
+ public List getBitstreamAccessConditionOptions() {
+ return bitstreamAccessConditionOptions;
+ }
+
+ public void setBitstreamAccessConditionOptions(
+ List bitstreamAccessConditionOptions) {
+ this.bitstreamAccessConditionOptions = bitstreamAccessConditionOptions;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/BulkAccessControlInput.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/BulkAccessControlInput.java
new file mode 100644
index 000000000000..0f8852a71f7d
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/model/BulkAccessControlInput.java
@@ -0,0 +1,72 @@
+/**
+ * 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.bulkaccesscontrol.model;
+
+import org.dspace.app.bulkaccesscontrol.BulkAccessControl;
+
+/**
+ * Class that model the content of the JSON file used as input for the {@link BulkAccessControl}
+ *
+ *
+ * {
+ * item: {
+ * mode: "replace",
+ * accessConditions: [
+ * {
+ * "name": "openaccess"
+ * }
+ * ]
+ * },
+ * bitstream: {
+ * constraints: {
+ * uuid: [bit-uuid1, bit-uuid2, ..., bit-uuidN],
+ * },
+ * mode: "add",
+ * accessConditions: [
+ * {
+ * "name": "embargo",
+ * "startDate": "2024-06-24T23:59:59.999+0000"
+ * }
+ * ]
+ * }
+ * }
+ *
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ */
+public class BulkAccessControlInput {
+
+ AccessConditionItem item;
+
+ AccessConditionBitstream bitstream;
+
+ public BulkAccessControlInput() {
+ }
+
+ public BulkAccessControlInput(AccessConditionItem item,
+ AccessConditionBitstream bitstream) {
+ this.item = item;
+ this.bitstream = bitstream;
+ }
+
+ public AccessConditionItem getItem() {
+ return item;
+ }
+
+ public void setItem(AccessConditionItem item) {
+ this.item = item;
+ }
+
+ public AccessConditionBitstream getBitstream() {
+ return bitstream;
+ }
+
+ public void setBitstream(AccessConditionBitstream bitstream) {
+ this.bitstream = bitstream;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/service/BulkAccessConditionConfigurationService.java b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/service/BulkAccessConditionConfigurationService.java
new file mode 100644
index 000000000000..321b6d928e92
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkaccesscontrol/service/BulkAccessConditionConfigurationService.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.bulkaccesscontrol.service;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.commons.collections4.CollectionUtils;
+import org.dspace.app.bulkaccesscontrol.model.BulkAccessConditionConfiguration;
+import org.springframework.beans.factory.annotation.Autowired;
+
+/**
+ * Simple bean to manage different Bulk Access Condition configurations
+ *
+ * @author Mohamed Eskander (mohamed.eskander at 4science.it)
+ */
+public class BulkAccessConditionConfigurationService {
+
+ @Autowired
+ private List bulkAccessConditionConfigurations;
+
+ public List getBulkAccessConditionConfigurations() {
+ if (CollectionUtils.isEmpty(bulkAccessConditionConfigurations)) {
+ return new ArrayList<>();
+ }
+ return bulkAccessConditionConfigurations;
+ }
+
+ public BulkAccessConditionConfiguration getBulkAccessConditionConfiguration(String name) {
+ return getBulkAccessConditionConfigurations().stream()
+ .filter(x -> name.equals(x.getName()))
+ .findFirst()
+ .orElse(null);
+ }
+
+ public void setBulkAccessConditionConfigurations(
+ List bulkAccessConditionConfigurations) {
+ this.bulkAccessConditionConfigurations = bulkAccessConditionConfigurations;
+ }
+}
\ No newline at end of file
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java
index 053fed18d38f..cbc052b5573f 100644
--- a/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/DSpaceCSV.java
@@ -138,7 +138,7 @@ public DSpaceCSV(boolean exportAll) {
/**
* Create a new instance, reading the lines in from file
*
- * @param inputStream the inputstream to read from
+ * @param inputStream the input stream to read from
* @param c The DSpace Context
* @throws Exception thrown if there is an error reading or processing the file
*/
@@ -159,7 +159,7 @@ public DSpaceCSV(InputStream inputStream, Context c) throws Exception {
columnCounter++;
// Remove surrounding quotes if there are any
- if ((element.startsWith("\"")) && (element.endsWith("\""))) {
+ if (element.startsWith("\"") && element.endsWith("\"")) {
element = element.substring(1, element.length() - 1);
}
@@ -337,15 +337,15 @@ public boolean hasActions() {
/**
* Set the value separator for multiple values stored in one csv value.
*
- * Is set in bulkedit.cfg as valueseparator
+ * Is set in {@code bulkedit.cfg} as {@code valueseparator}.
*
- * If not set, defaults to double pipe '||'
+ * If not set, defaults to double pipe '||'.
*/
private void setValueSeparator() {
// Get the value separator
valueSeparator = DSpaceServicesFactory.getInstance().getConfigurationService()
.getProperty("bulkedit.valueseparator");
- if ((valueSeparator != null) && (!"".equals(valueSeparator.trim()))) {
+ if ((valueSeparator != null) && !valueSeparator.trim().isEmpty()) {
valueSeparator = valueSeparator.trim();
} else {
valueSeparator = "||";
@@ -360,7 +360,7 @@ private void setValueSeparator() {
/**
* Set the field separator use to separate fields in the csv.
*
- * Is set in bulkedit.cfg as fieldseparator
+ * Is set in {@code bulkedit.cfg} as {@code fieldseparator}.
*
* If not set, defaults to comma ','.
*
@@ -371,7 +371,7 @@ private void setFieldSeparator() {
// Get the value separator
fieldSeparator = DSpaceServicesFactory.getInstance().getConfigurationService()
.getProperty("bulkedit.fieldseparator");
- if ((fieldSeparator != null) && (!"".equals(fieldSeparator.trim()))) {
+ if ((fieldSeparator != null) && !fieldSeparator.trim().isEmpty()) {
fieldSeparator = fieldSeparator.trim();
if ("tab".equals(fieldSeparator)) {
fieldSeparator = "\t";
@@ -395,15 +395,15 @@ private void setFieldSeparator() {
/**
* Set the authority separator for value with authority data.
*
- * Is set in dspace.cfg as bulkedit.authorityseparator
+ * Is set in {@code dspace.cfg} as {@code bulkedit.authorityseparator}.
*
- * If not set, defaults to double colon '::'
+ * If not set, defaults to double colon '::'.
*/
private void setAuthoritySeparator() {
// Get the value separator
authoritySeparator = DSpaceServicesFactory.getInstance().getConfigurationService()
.getProperty("bulkedit.authorityseparator");
- if ((authoritySeparator != null) && (!"".equals(authoritySeparator.trim()))) {
+ if ((authoritySeparator != null) && !authoritySeparator.trim().isEmpty()) {
authoritySeparator = authoritySeparator.trim();
} else {
authoritySeparator = "::";
@@ -508,7 +508,7 @@ public final void addItem(String line) throws Exception {
int i = 0;
for (String part : bits) {
int bitcounter = part.length() - part.replaceAll("\"", "").length();
- if ((part.startsWith("\"")) && ((!part.endsWith("\"")) || ((bitcounter & 1) == 1))) {
+ if (part.startsWith("\"") && (!part.endsWith("\"") || ((bitcounter & 1) == 1))) {
found = true;
String add = bits.get(i) + fieldSeparator + bits.get(i + 1);
bits.remove(i);
@@ -524,7 +524,7 @@ public final void addItem(String line) throws Exception {
// Deal with quotes around the elements
int i = 0;
for (String part : bits) {
- if ((part.startsWith("\"")) && (part.endsWith("\""))) {
+ if (part.startsWith("\"") && part.endsWith("\"")) {
part = part.substring(1, part.length() - 1);
bits.set(i, part);
}
@@ -564,7 +564,7 @@ public final void addItem(String line) throws Exception {
for (String part : bits) {
if (i > 0) {
// Is this a last empty item?
- if ((last) && (i == headings.size())) {
+ if (last && (i == headings.size())) {
part = "";
}
@@ -577,7 +577,7 @@ public final void addItem(String line) throws Exception {
csvLine.add(headings.get(i - 1), null);
String[] elements = part.split(escapedValueSeparator);
for (String element : elements) {
- if ((element != null) && (!"".equals(element))) {
+ if ((element != null) && !element.isEmpty()) {
csvLine.add(headings.get(i - 1), element);
}
}
@@ -629,18 +629,18 @@ public final String[] getCSVLinesAsStringArray() {
public InputStream getInputStream() {
StringBuilder stringBuilder = new StringBuilder();
for (String csvLine : getCSVLinesAsStringArray()) {
- stringBuilder.append(csvLine + "\n");
+ stringBuilder.append(csvLine).append("\n");
}
return IOUtils.toInputStream(stringBuilder.toString(), StandardCharsets.UTF_8);
}
/**
- * Is it Ok to export this value? When exportAll is set to false, we don't export
+ * Is it okay to export this value? When exportAll is set to false, we don't export
* some of the metadata elements.
*
- * The list can be configured via the key ignore-on-export in bulkedit.cfg
+ * The list can be configured via the key ignore-on-export in {@code bulkedit.cfg}.
*
- * @param md The Metadatum to examine
+ * @param md The MetadataField to examine
* @return Whether or not it is OK to export this element
*/
protected boolean okToExport(MetadataField md) {
@@ -649,12 +649,8 @@ protected boolean okToExport(MetadataField md) {
if (md.getQualifier() != null) {
key += "." + md.getQualifier();
}
- if (ignore.get(key) != null) {
- return false;
- }
-
// Must be OK, so don't ignore
- return true;
+ return ignore.get(key) == null;
}
/**
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionScriptConfiguration.java
index b8d41318db48..fb228e7041b8 100644
--- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionScriptConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataDeletionScriptConfiguration.java
@@ -7,33 +7,16 @@
*/
package org.dspace.app.bulkedit;
-import java.sql.SQLException;
-
import org.apache.commons.cli.Options;
-import org.dspace.authorize.service.AuthorizeService;
-import org.dspace.core.Context;
import org.dspace.scripts.configuration.ScriptConfiguration;
-import org.springframework.beans.factory.annotation.Autowired;
/**
* The {@link ScriptConfiguration} for the {@link MetadataDeletion} script.
*/
public class MetadataDeletionScriptConfiguration extends ScriptConfiguration {
- @Autowired
- private AuthorizeService authorizeService;
-
private Class dspaceRunnableClass;
- @Override
- public boolean isAllowedToExecute(Context context) {
- try {
- return 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) {
@@ -41,10 +24,8 @@ public Options getOptions() {
Options options = new Options();
options.addOption("m", "metadata", true, "metadata field name");
- options.getOption("m").setType(String.class);
options.addOption("l", "list", false, "lists the metadata fields that can be deleted");
- options.getOption("l").setType(boolean.class);
super.options = options;
}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java
index 0c513c466722..aa76c09c0a5b 100644
--- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportScriptConfiguration.java
@@ -7,22 +7,14 @@
*/
package org.dspace.app.bulkedit;
-import java.sql.SQLException;
-
import org.apache.commons.cli.Options;
-import org.dspace.authorize.service.AuthorizeService;
-import org.dspace.core.Context;
import org.dspace.scripts.configuration.ScriptConfiguration;
-import org.springframework.beans.factory.annotation.Autowired;
/**
* The {@link ScriptConfiguration} for the {@link MetadataExport} script
*/
public class MetadataExportScriptConfiguration extends ScriptConfiguration {
- @Autowired
- private AuthorizeService authorizeService;
-
private Class dspaceRunnableClass;
@Override
@@ -39,27 +31,15 @@ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
this.dspaceRunnableClass = dspaceRunnableClass;
}
- @Override
- public boolean isAllowedToExecute(Context context) {
- try {
- return 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("i", "id", true, "ID or handle of thing to export (item, collection, or community)");
- options.getOption("i").setType(String.class);
options.addOption("a", "all", false,
"include all metadata fields that are not normally changed (e.g. provenance)");
- options.getOption("a").setType(boolean.class);
options.addOption("h", "help", false, "help");
- options.getOption("h").setType(boolean.class);
super.options = options;
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearch.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearch.java
new file mode 100644
index 000000000000..027ad116a7e2
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearch.java
@@ -0,0 +1,170 @@
+/**
+ * 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 java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.UUID;
+
+import org.apache.commons.cli.ParseException;
+import org.dspace.content.Item;
+import org.dspace.content.MetadataDSpaceCsvExportServiceImpl;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.CollectionService;
+import org.dspace.content.service.CommunityService;
+import org.dspace.content.service.MetadataDSpaceCsvExportService;
+import org.dspace.core.Context;
+import org.dspace.discovery.DiscoverQuery;
+import org.dspace.discovery.IndexableObject;
+import org.dspace.discovery.SearchService;
+import org.dspace.discovery.SearchUtils;
+import org.dspace.discovery.configuration.DiscoveryConfiguration;
+import org.dspace.discovery.configuration.DiscoveryConfigurationService;
+import org.dspace.discovery.indexobject.IndexableCollection;
+import org.dspace.discovery.indexobject.IndexableCommunity;
+import org.dspace.discovery.utils.DiscoverQueryBuilder;
+import org.dspace.discovery.utils.parameter.QueryBuilderSearchFilter;
+import org.dspace.eperson.factory.EPersonServiceFactory;
+import org.dspace.eperson.service.EPersonService;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.sort.SortOption;
+import org.dspace.utils.DSpace;
+
+/**
+ * Metadata exporter to allow the batch export of metadata from a discovery search into a file
+ *
+ */
+public class MetadataExportSearch extends DSpaceRunnable {
+ private static final String EXPORT_CSV = "exportCSV";
+ private boolean help = false;
+ private String identifier;
+ private String discoveryConfigName;
+ private String[] filterQueryStrings;
+ private boolean hasScope = false;
+ private String query;
+
+ private SearchService searchService;
+ private MetadataDSpaceCsvExportService metadataDSpaceCsvExportService;
+ private EPersonService ePersonService;
+ private DiscoveryConfigurationService discoveryConfigurationService;
+ private CommunityService communityService;
+ private CollectionService collectionService;
+ private DiscoverQueryBuilder queryBuilder;
+
+ @Override
+ public MetadataExportSearchScriptConfiguration getScriptConfiguration() {
+ return new DSpace().getServiceManager()
+ .getServiceByName("metadata-export-search", MetadataExportSearchScriptConfiguration.class);
+ }
+
+ @Override
+ public void setup() throws ParseException {
+ searchService = SearchUtils.getSearchService();
+ metadataDSpaceCsvExportService = new DSpace().getServiceManager()
+ .getServiceByName(
+ MetadataDSpaceCsvExportServiceImpl.class.getCanonicalName(),
+ MetadataDSpaceCsvExportService.class
+ );
+ ePersonService = EPersonServiceFactory.getInstance().getEPersonService();
+ discoveryConfigurationService = SearchUtils.getConfigurationService();
+ communityService = ContentServiceFactory.getInstance().getCommunityService();
+ collectionService = ContentServiceFactory.getInstance().getCollectionService();
+ queryBuilder = SearchUtils.getQueryBuilder();
+
+ if (commandLine.hasOption('h')) {
+ help = true;
+ return;
+ }
+
+ if (commandLine.hasOption('q')) {
+ query = commandLine.getOptionValue('q');
+ }
+
+ if (commandLine.hasOption('s')) {
+ hasScope = true;
+ identifier = commandLine.getOptionValue('s');
+ }
+
+ if (commandLine.hasOption('c')) {
+ discoveryConfigName = commandLine.getOptionValue('c');
+ }
+
+ if (commandLine.hasOption('f')) {
+ filterQueryStrings = commandLine.getOptionValues('f');
+ }
+ }
+
+ @Override
+ public void internalRun() throws Exception {
+ if (help) {
+ loghelpinfo();
+ printHelp();
+ return;
+ }
+ handler.logDebug("starting search export");
+
+ IndexableObject dso = null;
+ Context context = new Context();
+ context.setCurrentUser(ePersonService.find(context, this.getEpersonIdentifier()));
+
+ if (hasScope) {
+ dso = resolveScope(context, identifier);
+ }
+
+ DiscoveryConfiguration discoveryConfiguration =
+ discoveryConfigurationService.getDiscoveryConfiguration(discoveryConfigName);
+
+ List queryBuilderSearchFilters = new ArrayList<>();
+
+ handler.logDebug("processing filter queries");
+ if (filterQueryStrings != null) {
+ for (String filterQueryString: filterQueryStrings) {
+ String field = filterQueryString.split(",", 2)[0];
+ String operator = filterQueryString.split("(,|=)", 3)[1];
+ String value = filterQueryString.split("=", 2)[1];
+ QueryBuilderSearchFilter queryBuilderSearchFilter =
+ new QueryBuilderSearchFilter(field, operator, value);
+ queryBuilderSearchFilters.add(queryBuilderSearchFilter);
+ }
+ }
+ handler.logDebug("building query");
+ DiscoverQuery discoverQuery =
+ queryBuilder.buildQuery(context, dso, discoveryConfiguration, query, queryBuilderSearchFilters,
+ "Item", 10, Long.getLong("0"), null, SortOption.DESCENDING);
+ handler.logDebug("creating iterator");
+
+ Iterator- itemIterator = searchService.iteratorSearch(context, dso, discoverQuery);
+ handler.logDebug("creating dspacecsv");
+ DSpaceCSV dSpaceCSV = metadataDSpaceCsvExportService.export(context, itemIterator, true);
+ handler.logDebug("writing to file " + getFileNameOrExportFile());
+ handler.writeFilestream(context, getFileNameOrExportFile(), dSpaceCSV.getInputStream(), EXPORT_CSV);
+ context.restoreAuthSystemState();
+ context.complete();
+
+ }
+
+ protected void loghelpinfo() {
+ handler.logInfo("metadata-export");
+ }
+
+ protected String getFileNameOrExportFile() {
+ return "metadataExportSearch.csv";
+ }
+
+ public IndexableObject resolveScope(Context context, String id) throws SQLException {
+ UUID uuid = UUID.fromString(id);
+ IndexableObject scopeObj = new IndexableCommunity(communityService.find(context, uuid));
+ if (scopeObj.getIndexedObject() == null) {
+ scopeObj = new IndexableCollection(collectionService.find(context, uuid));
+ }
+ return scopeObj;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchCli.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchCli.java
new file mode 100644
index 000000000000..51ca77cbfb3a
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchCli.java
@@ -0,0 +1,20 @@
+/**
+ * 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;
+
+/**
+ * The cli version of the {@link MetadataExportSearch} script
+ */
+public class MetadataExportSearchCli extends MetadataExportSearch {
+
+ @Override
+ protected String getFileNameOrExportFile() {
+ return commandLine.getOptionValue('n');
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchCliScriptConfiguration.java
new file mode 100644
index 000000000000..c0343f545a98
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchCliScriptConfiguration.java
@@ -0,0 +1,26 @@
+/**
+ * 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;
+
+/**
+ * This is the CLI version of the {@link MetadataExportSearchScriptConfiguration} class that handles the
+ * configuration for the {@link MetadataExportSearchCli} script
+ */
+public class MetadataExportSearchCliScriptConfiguration
+ extends MetadataExportSearchScriptConfiguration {
+
+ @Override
+ public Options getOptions() {
+ Options options = super.getOptions();
+ options.addOption("n", "filename", true, "the filename to export to");
+ return super.getOptions();
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchScriptConfiguration.java
new file mode 100644
index 000000000000..4f2a225d3ac6
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataExportSearchScriptConfiguration.java
@@ -0,0 +1,56 @@
+/**
+ * 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;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link MetadataExportSearch} script
+ */
+public class MetadataExportSearchScriptConfiguration extends ScriptConfiguration {
+
+ private Class dspaceRunnableclass;
+
+ @Override
+ public Class getDspaceRunnableClass() {
+ return dspaceRunnableclass;
+ }
+
+ @Override
+ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
+ this.dspaceRunnableclass = dspaceRunnableClass;
+ }
+
+ @Override
+ public Options getOptions() {
+ if (options == null) {
+ Options options = new Options();
+ options.addOption("q", "query", true,
+ "The discovery search string to will be used to match records. Not URL encoded");
+ options.getOption("q").setType(String.class);
+ options.addOption("s", "scope", true,
+ "UUID of a specific DSpace container (site, community or collection) to which the search has to be " +
+ "limited");
+ options.getOption("s").setType(String.class);
+ options.addOption("c", "configuration", true,
+ "The name of a Discovery configuration that should be used by this search");
+ options.getOption("c").setType(String.class);
+ options.addOption("f", "filter", true,
+ "Advanced search filter that has to be used to filter the result set, with syntax `<:filter-name>," +
+ "<:filter-operator>=<:filter-value>`. Not URL encoded. For example `author," +
+ "authority=5df05073-3be7-410d-8166-e254369e4166` or `title,contains=sample text`");
+ options.getOption("f").setType(String.class);
+ options.addOption("h", "help", false, "help");
+
+ super.options = options;
+ }
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java
index 0db0cc45be19..af6976acb14a 100644
--- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImport.java
@@ -25,6 +25,7 @@
import org.apache.commons.cli.ParseException;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.Logger;
+import org.dspace.app.util.RelationshipUtils;
import org.dspace.authority.AuthorityValue;
import org.dspace.authority.factory.AuthorityServiceFactory;
import org.dspace.authority.service.AuthorityValueService;
@@ -53,7 +54,7 @@
import org.dspace.content.service.WorkspaceItemService;
import org.dspace.core.Constants;
import org.dspace.core.Context;
-import org.dspace.core.LogManager;
+import org.dspace.core.LogHelper;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.factory.EPersonServiceFactory;
import org.dspace.handle.factory.HandleServiceFactory;
@@ -577,6 +578,10 @@ public List runImport(Context c, boolean change,
wfItem = workflowService.startWithoutNotify(c, wsItem);
}
} else {
+ // Add provenance info
+ String provenance = installItemService.getSubmittedByProvenanceMessage(c, wsItem.getItem());
+ itemService.addMetadata(c, item, MetadataSchemaEnum.DC.getName(),
+ "description", "provenance", "en", provenance);
// Install the item
installItemService.installItem(c, wsItem);
}
@@ -597,18 +602,19 @@ public List runImport(Context c, boolean change,
changes.add(whatHasChanged);
}
- if (change) {
- //only clear cache if changes have been made.
- c.uncacheEntity(wsItem);
- c.uncacheEntity(wfItem);
- c.uncacheEntity(item);
+ if (change && (rowCount % configurationService.getIntProperty("bulkedit.change.commit.count", 100) == 0)) {
+ c.commit();
+ handler.logInfo(LogHelper.getHeader(c, "metadata_import_commit", "lineNumber=" + rowCount));
}
populateRefAndRowMap(line, item == null ? null : item.getID());
// keep track of current rows processed
rowCount++;
}
+ if (change) {
+ c.commit();
+ }
- c.setMode(originalMode);
+ c.setMode(Context.Mode.READ_ONLY);
// Return the changes
@@ -640,7 +646,7 @@ protected void compareAndUpdate(Context c, Item item, String[] fromCSV, boolean
all += part + ",";
}
all = all.substring(0, all.length());
- log.debug(LogManager.getHeader(c, "metadata_import",
+ log.debug(LogHelper.getHeader(c, "metadata_import",
"item_id=" + item.getID() + ",fromCSV=" + all));
// Don't compare collections or actions or rowNames
@@ -677,7 +683,7 @@ protected void compareAndUpdate(Context c, Item item, String[] fromCSV, boolean
qualifier = qualifier.substring(0, qualifier.indexOf('['));
}
}
- log.debug(LogManager.getHeader(c, "metadata_import",
+ log.debug(LogHelper.getHeader(c, "metadata_import",
"item_id=" + item.getID() + ",fromCSV=" + all +
",looking_for_schema=" + schema +
",looking_for_element=" + element +
@@ -697,7 +703,7 @@ protected void compareAndUpdate(Context c, Item item, String[] fromCSV, boolean
.getConfidence() : Choices.CF_ACCEPTED);
}
i++;
- log.debug(LogManager.getHeader(c, "metadata_import",
+ log.debug(LogHelper.getHeader(c, "metadata_import",
"item_id=" + item.getID() + ",fromCSV=" + all +
",found=" + dcv.getValue()));
}
@@ -748,7 +754,7 @@ protected void compareAndUpdate(Context c, Item item, String[] fromCSV, boolean
// column "dc.contributor.author" so don't remove it
if ((value != null) && (!"".equals(value)) && (!contains(value, fromCSV)) && fromAuthority == null) {
// Remove it
- log.debug(LogManager.getHeader(c, "metadata_import",
+ log.debug(LogHelper.getHeader(c, "metadata_import",
"item_id=" + item.getID() + ",fromCSV=" + all +
",removing_schema=" + schema +
",removing_element=" + element +
@@ -924,11 +930,10 @@ private void addRelationship(Context c, Item item, String typeName, String value
rightItem = item;
}
- // Create the relationship
- int leftPlace = relationshipService.findNextLeftPlaceByLeftItem(c, leftItem);
- int rightPlace = relationshipService.findNextRightPlaceByRightItem(c, rightItem);
- Relationship persistedRelationship = relationshipService.create(c, leftItem, rightItem,
- foundRelationshipType, leftPlace, rightPlace);
+ // Create the relationship, appending to the end
+ Relationship persistedRelationship = relationshipService.create(
+ c, leftItem, rightItem, foundRelationshipType, -1, -1
+ );
relationshipService.update(c, persistedRelationship);
}
@@ -1362,7 +1367,7 @@ private int displayChanges(List changes, boolean changed) {
* is the field is defined as authority controlled
*/
private static boolean isAuthorityControlledField(String md) {
- String mdf = StringUtils.substringAfter(md, ":");
+ String mdf = md.contains(":") ? StringUtils.substringAfter(md, ":") : md;
mdf = StringUtils.substringBefore(mdf, "[");
return authorityControlled.contains(mdf);
}
@@ -1793,36 +1798,7 @@ private void validateTypesByTypeByTypeName(Context c,
*/
private RelationshipType matchRelationshipType(List relTypes,
String targetType, String originType, String originTypeName) {
- RelationshipType foundRelationshipType = null;
- if (originTypeName.split("\\.").length > 1) {
- originTypeName = originTypeName.split("\\.")[1];
- }
- for (RelationshipType relationshipType : relTypes) {
- // Is origin type leftward or righward
- boolean isLeft = false;
- if (relationshipType.getLeftType().getLabel().equalsIgnoreCase(originType)) {
- isLeft = true;
- }
- if (isLeft) {
- // Validate typeName reference
- if (!relationshipType.getLeftwardType().equalsIgnoreCase(originTypeName)) {
- continue;
- }
- if (relationshipType.getLeftType().getLabel().equalsIgnoreCase(originType) &&
- relationshipType.getRightType().getLabel().equalsIgnoreCase(targetType)) {
- foundRelationshipType = relationshipType;
- }
- } else {
- if (!relationshipType.getRightwardType().equalsIgnoreCase(originTypeName)) {
- continue;
- }
- if (relationshipType.getLeftType().getLabel().equalsIgnoreCase(targetType) &&
- relationshipType.getRightType().getLabel().equalsIgnoreCase(originType)) {
- foundRelationshipType = relationshipType;
- }
- }
- }
- return foundRelationshipType;
+ return RelationshipUtils.matchRelationshipType(relTypes, targetType, originType, originTypeName);
}
}
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java
index 038df616cae5..7e1537fe9d91 100644
--- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportCliScriptConfiguration.java
@@ -19,7 +19,6 @@ public class MetadataImportCliScriptConfiguration extends MetadataImportScriptCo
public Options getOptions() {
Options options = super.getOptions();
options.addOption("e", "email", true, "email address or user id of user (required if adding new items)");
- options.getOption("e").setType(String.class);
options.getOption("e").setRequired(true);
super.options = options;
return options;
diff --git a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java
index 07e6a9aec96e..ce2f7fb68af1 100644
--- a/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/app/bulkedit/MetadataImportScriptConfiguration.java
@@ -8,22 +8,15 @@
package org.dspace.app.bulkedit;
import java.io.InputStream;
-import java.sql.SQLException;
import org.apache.commons.cli.Options;
-import org.dspace.authorize.service.AuthorizeService;
-import org.dspace.core.Context;
import org.dspace.scripts.configuration.ScriptConfiguration;
-import org.springframework.beans.factory.annotation.Autowired;
/**
* The {@link ScriptConfiguration} for the {@link MetadataImport} script
*/
public class MetadataImportScriptConfiguration extends ScriptConfiguration {
- @Autowired
- private AuthorizeService authorizeService;
-
private Class dspaceRunnableClass;
@Override
@@ -40,15 +33,6 @@ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
this.dspaceRunnableClass = dspaceRunnableClass;
}
- @Override
- public boolean isAllowedToExecute(Context context) {
- try {
- return 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) {
@@ -59,20 +43,14 @@ public Options getOptions() {
options.getOption("f").setRequired(true);
options.addOption("s", "silent", false,
"silent operation - doesn't request confirmation of changes USE WITH CAUTION");
- options.getOption("s").setType(boolean.class);
options.addOption("w", "workflow", false, "workflow - when adding new items, use collection workflow");
- options.getOption("w").setType(boolean.class);
options.addOption("n", "notify", false,
"notify - when adding new items using a workflow, send notification emails");
- options.getOption("n").setType(boolean.class);
options.addOption("v", "validate-only", false,
"validate - just validate the csv, don't run the import");
- options.getOption("v").setType(boolean.class);
options.addOption("t", "template", false,
"template - when adding new items, use the collection template (if it exists)");
- options.getOption("t").setType(boolean.class);
options.addOption("h", "help", false, "help");
- options.getOption("h").setType(boolean.class);
super.options = options;
}
diff --git a/dspace-api/src/main/java/org/dspace/app/exception/ResourceAlreadyExistsException.java b/dspace-api/src/main/java/org/dspace/app/exception/ResourceAlreadyExistsException.java
new file mode 100644
index 000000000000..8291af87fc2e
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/exception/ResourceAlreadyExistsException.java
@@ -0,0 +1,32 @@
+/**
+ * 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.exception;
+
+/**
+ * This class provides an exception to be used when trying to save a resource
+ * that already exists.
+ *
+ * @author Luca Giamminonni (luca.giamminonni at 4science.it)
+ *
+ */
+public class ResourceAlreadyExistsException extends RuntimeException {
+
+ private static final long serialVersionUID = 1L;
+
+ /**
+ * Create a ResourceAlreadyExistsException with a message and the already
+ * existing resource.
+ *
+ * @param message the error message
+ */
+ public ResourceAlreadyExistsException(String message) {
+ super(message);
+ }
+
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/harvest/Harvest.java b/dspace-api/src/main/java/org/dspace/app/harvest/Harvest.java
index 1eaa78338004..f2630572e362 100644
--- a/dspace-api/src/main/java/org/dspace/app/harvest/Harvest.java
+++ b/dspace-api/src/main/java/org/dspace/app/harvest/Harvest.java
@@ -13,11 +13,8 @@
import java.util.List;
import java.util.UUID;
-import org.apache.commons.cli.CommandLine;
-import org.apache.commons.cli.CommandLineParser;
-import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.HelpFormatter;
-import org.apache.commons.cli.Options;
+import org.apache.commons.cli.ParseException;
+import org.apache.commons.lang3.StringUtils;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Collection;
import org.dspace.content.DSpaceObject;
@@ -36,224 +33,223 @@
import org.dspace.harvest.OAIHarvester;
import org.dspace.harvest.factory.HarvestServiceFactory;
import org.dspace.harvest.service.HarvestedCollectionService;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.utils.DSpace;
/**
* Test class for harvested collections.
*
* @author Alexey Maslov
*/
-public class Harvest {
- private static Context context;
-
- private static final HarvestedCollectionService harvestedCollectionService =
- HarvestServiceFactory.getInstance().getHarvestedCollectionService();
- private static final EPersonService ePersonService = EPersonServiceFactory.getInstance().getEPersonService();
- private static final CollectionService collectionService =
- ContentServiceFactory.getInstance().getCollectionService();
-
- public static void main(String[] argv) throws Exception {
- // create an options object and populate it
- CommandLineParser parser = new DefaultParser();
-
- Options options = new Options();
-
- options.addOption("p", "purge", false, "delete all items in the collection");
- options.addOption("r", "run", false, "run the standard harvest procedure");
- options.addOption("g", "ping", false, "test the OAI server and set");
- options.addOption("o", "once", false, "run the harvest procedure with specified parameters");
- options.addOption("s", "setup", false, "Set the collection up for harvesting");
- options.addOption("S", "start", false, "start the harvest loop");
- options.addOption("R", "reset", false, "reset harvest status on all collections");
- options.addOption("P", "purge", false, "purge all harvestable collections");
-
-
- options.addOption("e", "eperson", true,
- "eperson");
- options.addOption("c", "collection", true,
- "harvesting collection (handle or id)");
- options.addOption("t", "type", true,
- "type of harvesting (0 for none)");
- options.addOption("a", "address", true,
- "address of the OAI-PMH server");
- options.addOption("i", "oai_set_id", true,
- "id of the PMH set representing the harvested collection");
- options.addOption("m", "metadata_format", true,
- "the name of the desired metadata format for harvesting, resolved to namespace and " +
- "crosswalk in dspace.cfg");
-
- options.addOption("h", "help", false, "help");
-
- CommandLine line = parser.parse(options, argv);
-
- String command = null;
- String eperson = null;
- String collection = null;
- String oaiSource = null;
- String oaiSetID = null;
- String metadataKey = null;
- int harvestType = 0;
-
- if (line.hasOption('h')) {
- HelpFormatter myhelp = new HelpFormatter();
- myhelp.printHelp("Harvest\n", options);
- System.out.println("\nPING OAI server: Harvest -g -a oai_source -i oai_set_id");
- System.out.println(
- "RUNONCE harvest with arbitrary options: Harvest -o -e eperson -c collection -t harvest_type -a " +
- "oai_source -i oai_set_id -m metadata_format");
- System.out.println(
- "SETUP a collection for harvesting: Harvest -s -c collection -t harvest_type -a oai_source -i " +
- "oai_set_id -m metadata_format");
- System.out.println("RUN harvest once: Harvest -r -e eperson -c collection");
- System.out.println("START harvest scheduler: Harvest -S");
- System.out.println("RESET all harvest status: Harvest -R");
- System.out.println("PURGE a collection of items and settings: Harvest -p -e eperson -c collection");
- System.out.println("PURGE all harvestable collections: Harvest -P -e eperson");
-
-
- System.exit(0);
- }
+public class Harvest extends DSpaceRunnable {
+
+ private HarvestedCollectionService harvestedCollectionService;
+ protected EPersonService ePersonService;
+ private CollectionService collectionService;
+
+ private boolean help;
+ private String command = null;
+ private String collection = null;
+ private String oaiSource = null;
+ private String oaiSetID = null;
+ private String metadataKey = null;
+ private int harvestType = 0;
+
+ protected Context context;
+
+
+ public HarvestScriptConfiguration getScriptConfiguration() {
+ return new DSpace().getServiceManager()
+ .getServiceByName("harvest", HarvestScriptConfiguration.class);
+ }
+
+ public void setup() throws ParseException {
+ harvestedCollectionService =
+ HarvestServiceFactory.getInstance().getHarvestedCollectionService();
+ ePersonService = EPersonServiceFactory.getInstance().getEPersonService();
+ collectionService =
+ ContentServiceFactory.getInstance().getCollectionService();
+
+ assignCurrentUserInContext();
- if (line.hasOption('s')) {
+ help = commandLine.hasOption('h');
+
+
+ if (commandLine.hasOption('s')) {
command = "config";
}
- if (line.hasOption('p')) {
+ if (commandLine.hasOption('p')) {
command = "purge";
}
- if (line.hasOption('r')) {
+ if (commandLine.hasOption('r')) {
command = "run";
}
- if (line.hasOption('g')) {
+ if (commandLine.hasOption('g')) {
command = "ping";
}
- if (line.hasOption('o')) {
- command = "runOnce";
- }
- if (line.hasOption('S')) {
+ if (commandLine.hasOption('S')) {
command = "start";
}
- if (line.hasOption('R')) {
+ if (commandLine.hasOption('R')) {
command = "reset";
}
- if (line.hasOption('P')) {
+ if (commandLine.hasOption('P')) {
command = "purgeAll";
}
-
-
- if (line.hasOption('e')) {
- eperson = line.getOptionValue('e');
+ if (commandLine.hasOption('o')) {
+ command = "reimport";
}
- if (line.hasOption('c')) {
- collection = line.getOptionValue('c');
+ if (commandLine.hasOption('c')) {
+ collection = commandLine.getOptionValue('c');
}
- if (line.hasOption('t')) {
- harvestType = Integer.parseInt(line.getOptionValue('t'));
+ if (commandLine.hasOption('t')) {
+ harvestType = Integer.parseInt(commandLine.getOptionValue('t'));
} else {
harvestType = 0;
}
- if (line.hasOption('a')) {
- oaiSource = line.getOptionValue('a');
+ if (commandLine.hasOption('a')) {
+ oaiSource = commandLine.getOptionValue('a');
}
- if (line.hasOption('i')) {
- oaiSetID = line.getOptionValue('i');
+ if (commandLine.hasOption('i')) {
+ oaiSetID = commandLine.getOptionValue('i');
}
- if (line.hasOption('m')) {
- metadataKey = line.getOptionValue('m');
+ if (commandLine.hasOption('m')) {
+ metadataKey = commandLine.getOptionValue('m');
}
+ }
+ /**
+ * This method will assign the currentUser to the {@link Context} variable which is also created in this method.
+ * The instance of the method in this class will fetch the EPersonIdentifier from this class, this identifier
+ * was given to this class upon instantiation, it'll then be used to find the {@link EPerson} associated with it
+ * and this {@link EPerson} will be set as the currentUser of the created {@link Context}
+ * @throws ParseException If something went wrong with the retrieval of the EPerson Identifier
+ */
+ protected void assignCurrentUserInContext() throws ParseException {
+ UUID currentUserUuid = this.getEpersonIdentifier();
+ try {
+ this.context = new Context(Context.Mode.BATCH_EDIT);
+ EPerson eperson = ePersonService.find(context, currentUserUuid);
+ if (eperson == null) {
+ super.handler.logError("EPerson not found: " + currentUserUuid);
+ throw new IllegalArgumentException("Unable to find a user with uuid: " + currentUserUuid);
+ }
+ this.context.setCurrentUser(eperson);
+ } catch (SQLException e) {
+ handler.handleException("Something went wrong trying to fetch eperson for uuid: " + currentUserUuid, e);
+ }
+ }
- // Instantiate our class
- Harvest harvester = new Harvest();
- harvester.context = new Context(Context.Mode.BATCH_EDIT);
-
+ public void internalRun() throws Exception {
+ if (help) {
+ printHelp();
+ handler.logInfo("PING OAI server: Harvest -g -a oai_source -i oai_set_id");
+ handler.logInfo(
+ "SETUP a collection for harvesting: Harvest -s -c collection -t harvest_type -a oai_source -i " +
+ "oai_set_id -m metadata_format");
+ handler.logInfo("RUN harvest once: Harvest -r -e eperson -c collection");
+ handler.logInfo("START harvest scheduler: Harvest -S");
+ handler.logInfo("RESET all harvest status: Harvest -R");
+ handler.logInfo("PURGE a collection of items and settings: Harvest -p -e eperson -c collection");
+ handler.logInfo("PURGE all harvestable collections: Harvest -P -e eperson");
+
+ return;
+ }
- // Check our options
- if (command == null) {
- System.out
- .println("Error - no parameters specified (run with -h flag for details)");
- System.exit(1);
+ if (StringUtils.isBlank(command)) {
+ handler.logError("No parameters specified (run with -h flag for details)");
+ throw new UnsupportedOperationException("No command specified");
} else if ("run".equals(command)) {
// Run a single harvest cycle on a collection using saved settings.
- if (collection == null || eperson == null) {
- System.out
- .println("Error - a target collection and eperson must be provided");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ if (collection == null || context.getCurrentUser() == null) {
+ handler.logError("A target collection and eperson must be provided (run with -h flag for details)");
+ throw new UnsupportedOperationException("A target collection and eperson must be provided");
}
-
- harvester.runHarvest(collection, eperson);
+ runHarvest(context, collection);
} else if ("start".equals(command)) {
// start the harvest loop
startHarvester();
} else if ("reset".equals(command)) {
// reset harvesting status
- resetHarvesting();
+ resetHarvesting(context);
} else if ("purgeAll".equals(command)) {
// purge all collections that are set up for harvesting (obviously for testing purposes only)
- if (eperson == null) {
- System.out
- .println("Error - an eperson must be provided");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ if (context.getCurrentUser() == null) {
+ handler.logError("An eperson must be provided (run with -h flag for details)");
+ throw new UnsupportedOperationException("An eperson must be provided");
}
List harvestedCollections = harvestedCollectionService.findAll(context);
for (HarvestedCollection harvestedCollection : harvestedCollections) {
- System.out.println(
- "Purging the following collections (deleting items and resetting harvest status): " +
- harvestedCollection
- .getCollection().getID().toString());
- harvester.purgeCollection(harvestedCollection.getCollection().getID().toString(), eperson);
+ handler.logInfo(
+ "Purging the following collections (deleting items and resetting harvest status): " +
+ harvestedCollection
+ .getCollection().getID().toString());
+ purgeCollection(context, harvestedCollection.getCollection().getID().toString());
}
context.complete();
} else if ("purge".equals(command)) {
// Delete all items in a collection. Useful for testing fresh harvests.
- if (collection == null || eperson == null) {
- System.out
- .println("Error - a target collection and eperson must be provided");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ if (collection == null || context.getCurrentUser() == null) {
+ handler.logError("A target collection and eperson must be provided (run with -h flag for details)");
+ throw new UnsupportedOperationException("A target collection and eperson must be provided");
}
- harvester.purgeCollection(collection, eperson);
+ purgeCollection(context, collection);
+ context.complete();
+
+ } else if ("reimport".equals(command)) {
+ // Delete all items in a collection. Useful for testing fresh harvests.
+ if (collection == null || context.getCurrentUser() == null) {
+ handler.logError("A target collection and eperson must be provided (run with -h flag for details)");
+ throw new UnsupportedOperationException("A target collection and eperson must be provided");
+ }
+ purgeCollection(context, collection);
+ runHarvest(context, collection);
context.complete();
- //TODO: implement this... remove all items and remember to unset "last-harvested" settings
} else if ("config".equals(command)) {
// Configure a collection with the three main settings
if (collection == null) {
- System.out.println("Error - a target collection must be provided");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ handler.logError("A target collection must be provided (run with -h flag for details)");
+ throw new UnsupportedOperationException("A target collection must be provided");
}
if (oaiSource == null || oaiSetID == null) {
- System.out.println("Error - both the OAI server address and OAI set id must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ handler.logError(
+ "Both the OAI server address and OAI set id must be specified (run with -h flag for details)");
+ throw new UnsupportedOperationException("Both the OAI server address and OAI set id must be specified");
}
if (metadataKey == null) {
- System.out
- .println("Error - a metadata key (commonly the prefix) must be specified for this collection");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ handler.logError(
+ "A metadata key (commonly the prefix) must be specified for this collection (run with -h flag" +
+ " for details)");
+ throw new UnsupportedOperationException(
+ "A metadata key (commonly the prefix) must be specified for this collection");
}
- harvester.configureCollection(collection, harvestType, oaiSource, oaiSetID, metadataKey);
+ configureCollection(context, collection, harvestType, oaiSource, oaiSetID, metadataKey);
} else if ("ping".equals(command)) {
if (oaiSource == null || oaiSetID == null) {
- System.out.println("Error - both the OAI server address and OAI set id must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
+ handler.logError(
+ "Both the OAI server address and OAI set id must be specified (run with -h flag for details)");
+ throw new UnsupportedOperationException("Both the OAI server address and OAI set id must be specified");
}
pingResponder(oaiSource, oaiSetID, metadataKey);
+ } else {
+ handler.logError(
+ "Your command '" + command + "' was not recognized properly (run with -h flag for details)");
+ throw new UnsupportedOperationException("Your command '" + command + "' was not recognized properly");
}
+
+
}
/*
* Resolve the ID into a collection and check to see if its harvesting options are set. If so, return
* the collection, if not, bail out.
*/
- private Collection resolveCollection(String collectionID) {
+ private Collection resolveCollection(Context context, String collectionID) {
DSpaceObject dso;
Collection targetCollection = null;
@@ -273,14 +269,14 @@ private Collection resolveCollection(String collectionID) {
}
} else {
// not a handle, try and treat it as an collection database UUID
- System.out.println("Looking up by UUID: " + collectionID + ", " + "in context: " + context);
+ handler.logInfo("Looking up by UUID: " + collectionID + ", " + "in context: " + context);
targetCollection = collectionService.find(context, UUID.fromString(collectionID));
}
}
// was the collection valid?
if (targetCollection == null) {
- System.out.println("Cannot resolve " + collectionID + " to collection");
- System.exit(1);
+ handler.logError("Cannot resolve " + collectionID + " to collection");
+ throw new UnsupportedOperationException("Cannot resolve " + collectionID + " to collection");
}
} catch (SQLException se) {
se.printStackTrace();
@@ -290,12 +286,12 @@ private Collection resolveCollection(String collectionID) {
}
- private void configureCollection(String collectionID, int type, String oaiSource, String oaiSetId,
+ private void configureCollection(Context context, String collectionID, int type, String oaiSource, String oaiSetId,
String mdConfigId) {
- System.out.println("Running: configure collection");
+ handler.logInfo("Running: configure collection");
- Collection collection = resolveCollection(collectionID);
- System.out.println(collection.getID());
+ Collection collection = resolveCollection(context, collectionID);
+ handler.logInfo(String.valueOf(collection.getID()));
try {
HarvestedCollection hc = harvestedCollectionService.find(context, collection);
@@ -310,9 +306,8 @@ private void configureCollection(String collectionID, int type, String oaiSource
context.restoreAuthSystemState();
context.complete();
} catch (Exception e) {
- System.out.println("Changes could not be committed");
- e.printStackTrace();
- System.exit(1);
+ handler.logError("Changes could not be committed");
+ handler.handleException(e);
} finally {
if (context != null) {
context.restoreAuthSystemState();
@@ -323,18 +318,15 @@ private void configureCollection(String collectionID, int type, String oaiSource
/**
* Purges a collection of all harvest-related data and settings. All items in the collection will be deleted.
+ * @param collectionID
*
- * @param collectionID
- * @param email
*/
- private void purgeCollection(String collectionID, String email) {
- System.out.println(
- "Purging collection of all items and resetting last_harvested and harvest_message: " + collectionID);
- Collection collection = resolveCollection(collectionID);
+ private void purgeCollection(Context context, String collectionID) {
+ handler.logInfo(
+ "Purging collection of all items and resetting last_harvested and harvest_message: " + collectionID);
+ Collection collection = resolveCollection(context, collectionID);
try {
- EPerson eperson = ePersonService.findByEmail(context, email);
- context.setCurrentUser(eperson);
context.turnOffAuthorisationSystem();
ItemService itemService = ContentServiceFactory.getInstance().getItemService();
@@ -343,7 +335,7 @@ private void purgeCollection(String collectionID, String email) {
while (it.hasNext()) {
i++;
Item item = it.next();
- System.out.println("Deleting: " + item.getHandle());
+ handler.logInfo("Deleting: " + item.getHandle());
collectionService.removeItem(context, collection, item);
context.uncacheEntity(item);// Dispatch events every 50 items
if (i % 50 == 0) {
@@ -363,9 +355,8 @@ private void purgeCollection(String collectionID, String email) {
context.restoreAuthSystemState();
context.dispatchEvents();
} catch (Exception e) {
- System.out.println("Changes could not be committed");
- e.printStackTrace();
- System.exit(1);
+ handler.logError("Changes could not be committed");
+ handler.handleException(e);
} finally {
context.restoreAuthSystemState();
}
@@ -375,46 +366,42 @@ private void purgeCollection(String collectionID, String email) {
/**
* Run a single harvest cycle on the specified collection under the authorization of the supplied EPerson
*/
- private void runHarvest(String collectionID, String email) {
- System.out.println("Running: a harvest cycle on " + collectionID);
+ private void runHarvest(Context context, String collectionID) {
+ handler.logInfo("Running: a harvest cycle on " + collectionID);
- System.out.print("Initializing the harvester... ");
+ handler.logInfo("Initializing the harvester... ");
OAIHarvester harvester = null;
try {
- Collection collection = resolveCollection(collectionID);
+ Collection collection = resolveCollection(context, collectionID);
HarvestedCollection hc = harvestedCollectionService.find(context, collection);
harvester = new OAIHarvester(context, collection, hc);
- System.out.println("success. ");
+ handler.logInfo("Initialized the harvester successfully");
} catch (HarvestingException hex) {
- System.out.print("failed. ");
- System.out.println(hex.getMessage());
+ handler.logError("Initializing the harvester failed.");
throw new IllegalStateException("Unable to harvest", hex);
} catch (SQLException se) {
- System.out.print("failed. ");
- System.out.println(se.getMessage());
+ handler.logError("Initializing the harvester failed.");
throw new IllegalStateException("Unable to access database", se);
}
try {
// Harvest will not work for an anonymous user
- EPerson eperson = ePersonService.findByEmail(context, email);
- System.out.println("Harvest started... ");
- context.setCurrentUser(eperson);
+ handler.logInfo("Harvest started... ");
harvester.runHarvest();
context.complete();
} catch (SQLException | AuthorizeException | IOException e) {
throw new IllegalStateException("Failed to run harvester", e);
}
- System.out.println("Harvest complete. ");
+ handler.logInfo("Harvest complete. ");
}
/**
* Resets harvest_status and harvest_start_time flags for all collections that have a row in the
* harvested_collections table
*/
- private static void resetHarvesting() {
- System.out.print("Resetting harvest status flag on all collections... ");
+ private void resetHarvesting(Context context) {
+ handler.logInfo("Resetting harvest status flag on all collections... ");
try {
List harvestedCollections = harvestedCollectionService.findAll(context);
@@ -424,21 +411,21 @@ private static void resetHarvesting() {
harvestedCollection.setHarvestStatus(HarvestedCollection.STATUS_READY);
harvestedCollectionService.update(context, harvestedCollection);
}
- System.out.println("success. ");
+ handler.logInfo("Reset harvest status flag successfully");
} catch (Exception ex) {
- System.out.println("failed. ");
- ex.printStackTrace();
+ handler.logError("Resetting harvest status flag failed");
+ handler.handleException(ex);
}
}
/**
* Starts up the harvest scheduler. Terminating this process will stop the scheduler.
*/
- private static void startHarvester() {
+ private void startHarvester() {
try {
- System.out.print("Starting harvest loop... ");
+ handler.logInfo("Starting harvest loop... ");
HarvestServiceFactory.getInstance().getHarvestSchedulingService().startNewScheduler();
- System.out.println("running. ");
+ handler.logInfo("running. ");
} catch (Exception ex) {
ex.printStackTrace();
}
@@ -451,29 +438,31 @@ private static void startHarvester() {
* @param set name of an item set.
* @param metadataFormat local prefix name, or null for "dc".
*/
- private static void pingResponder(String server, String set, String metadataFormat) {
+ private void pingResponder(String server, String set, String metadataFormat) {
List errors;
- System.out.print("Testing basic PMH access: ");
+ handler.logInfo("Testing basic PMH access: ");
errors = harvestedCollectionService.verifyOAIharvester(server, set,
- (null != metadataFormat) ? metadataFormat : "dc", false);
+ (null != metadataFormat) ? metadataFormat : "dc", false);
if (errors.isEmpty()) {
- System.out.println("OK");
+ handler.logInfo("OK");
} else {
for (String error : errors) {
- System.err.println(error);
+ handler.logError(error);
}
}
- System.out.print("Testing ORE support: ");
+ handler.logInfo("Testing ORE support: ");
errors = harvestedCollectionService.verifyOAIharvester(server, set,
- (null != metadataFormat) ? metadataFormat : "dc", true);
+ (null != metadataFormat) ? metadataFormat : "dc", true);
if (errors.isEmpty()) {
- System.out.println("OK");
+ handler.logInfo("OK");
} else {
for (String error : errors) {
- System.err.println(error);
+ handler.logError(error);
}
}
}
+
+
}
diff --git a/dspace-api/src/main/java/org/dspace/app/harvest/HarvestCli.java b/dspace-api/src/main/java/org/dspace/app/harvest/HarvestCli.java
new file mode 100644
index 000000000000..8c9766e93421
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/harvest/HarvestCli.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.harvest;
+
+import java.sql.SQLException;
+
+import org.apache.commons.cli.ParseException;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+
+public class HarvestCli extends Harvest {
+
+ /**
+ * This is the overridden instance of the {@link Harvest#assignCurrentUserInContext()} method in the parent class
+ * {@link Harvest}.
+ * This is done so that the CLI version of the Script is able to retrieve its currentUser from the -e flag given
+ * with the parameters of the Script.
+ *
+ * @throws ParseException If the e flag was not given to the parameters when calling the script
+ */
+ @Override
+ protected void assignCurrentUserInContext() throws ParseException {
+ if (this.commandLine.hasOption('e')) {
+ String ePersonEmail = this.commandLine.getOptionValue('e');
+ this.context = new Context(Context.Mode.BATCH_EDIT);
+ try {
+ EPerson ePerson = ePersonService.findByEmail(this.context, ePersonEmail);
+ if (ePerson == null) {
+ super.handler.logError("EPerson not found: " + ePersonEmail);
+ throw new IllegalArgumentException("Unable to find a user with email: " + ePersonEmail);
+ }
+ this.context.setCurrentUser(ePerson);
+ } catch (SQLException e) {
+ throw new IllegalArgumentException("SQLException trying to find user with email: " + ePersonEmail);
+ }
+ }
+ }
+
+
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/harvest/HarvestCliScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/harvest/HarvestCliScriptConfiguration.java
new file mode 100644
index 000000000000..9e58b64a6243
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/harvest/HarvestCliScriptConfiguration.java
@@ -0,0 +1,22 @@
+/**
+ * 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.harvest;
+
+import org.apache.commons.cli.Options;
+
+
+public class HarvestCliScriptConfiguration extends HarvestScriptConfiguration {
+
+ public Options getOptions() {
+ Options options = super.getOptions();
+ options.addOption("e", "eperson", true,
+ "eperson");
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/harvest/HarvestScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/harvest/HarvestScriptConfiguration.java
new file mode 100644
index 000000000000..ff83c3ecb225
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/harvest/HarvestScriptConfiguration.java
@@ -0,0 +1,56 @@
+/**
+ * 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.harvest;
+
+import org.apache.commons.cli.Options;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+
+public class HarvestScriptConfiguration extends ScriptConfiguration {
+
+ private Class dspaceRunnableClass;
+
+ @Override
+ public Class getDspaceRunnableClass() {
+ return dspaceRunnableClass;
+ }
+
+ @Override
+ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
+ this.dspaceRunnableClass = dspaceRunnableClass;
+ }
+
+
+ public Options getOptions() {
+ Options options = new Options();
+ options.addOption("p", "purge", false, "delete all items in the collection");
+ options.addOption("r", "run", false, "run the standard harvest procedure");
+ options.addOption("g", "ping", false, "test the OAI server and set");
+ options.addOption("s", "setup", false, "Set the collection up for harvesting");
+ options.addOption("S", "start", false, "start the harvest loop");
+ options.addOption("R", "reset", false, "reset harvest status on all collections");
+ options.addOption("P", "purgeCollections", false, "purge all harvestable collections");
+ options.addOption("o", "reimport", false, "reimport all items in the collection, " +
+ "this is equivalent to -p -r, purging all items in a collection and reimporting them");
+ options.addOption("c", "collection", true,
+ "harvesting collection (handle or id)");
+ options.addOption("t", "type", true,
+ "type of harvesting (0 for none)");
+ options.addOption("a", "address", true,
+ "address of the OAI-PMH server");
+ options.addOption("i", "oai_set_id", true,
+ "id of the PMH set representing the harvested collection");
+ options.addOption("m", "metadata_format", true,
+ "the name of the desired metadata format for harvesting, resolved to namespace and " +
+ "crosswalk in dspace.cfg");
+
+ options.addOption("h", "help", false, "help");
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java
new file mode 100644
index 000000000000..71fc088694d9
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExport.java
@@ -0,0 +1,264 @@
+/**
+ * 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.itemexport;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.nio.file.Path;
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.UUID;
+
+import org.apache.commons.cli.ParseException;
+import org.apache.commons.io.file.PathUtils;
+import org.dspace.app.itemexport.factory.ItemExportServiceFactory;
+import org.dspace.app.itemexport.service.ItemExportService;
+import org.dspace.content.Collection;
+import org.dspace.content.Item;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.CollectionService;
+import org.dspace.content.service.ItemService;
+import org.dspace.core.Constants;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+import org.dspace.eperson.factory.EPersonServiceFactory;
+import org.dspace.eperson.service.EPersonService;
+import org.dspace.handle.factory.HandleServiceFactory;
+import org.dspace.handle.service.HandleService;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.utils.DSpace;
+
+/**
+ * Item exporter to create simple AIPs for DSpace content. Currently exports
+ * individual items, or entire collections. For instructions on use, see
+ * printUsage() method.
+ *
+ * ItemExport creates the simple AIP package that the importer also uses. It
+ * consists of:
+ *
+ * /exportdir/42/ (one directory per item) / dublin_core.xml - qualified dublin
+ * core in RDF schema / contents - text file, listing one file per line / file1
+ * - files contained in the item / file2 / ...
+ *
+ * issues -doesn't handle special characters in metadata (needs to turn {@code &'s} into
+ * {@code &}, etc.)
+ *
+ * Modified by David Little, UCSD Libraries 12/21/04 to allow the registration
+ * of files (bitstreams) into DSpace.
+ *
+ * @author David Little
+ * @author Jay Paz
+ */
+public class ItemExport extends DSpaceRunnable {
+
+ public static final String TEMP_DIR = "exportSAF";
+ public static final String ZIP_NAME = "exportSAFZip";
+ public static final String ZIP_FILENAME = "saf-export";
+ public static final String ZIP_EXT = "zip";
+
+ protected String typeString = null;
+ protected String destDirName = null;
+ protected String idString = null;
+ protected int seqStart = -1;
+ protected int type = -1;
+ protected Item item = null;
+ protected Collection collection = null;
+ protected boolean migrate = false;
+ protected boolean zip = false;
+ protected String zipFileName = "";
+ protected boolean excludeBitstreams = false;
+ protected boolean help = false;
+
+ protected static HandleService handleService = HandleServiceFactory.getInstance().getHandleService();
+ protected static ItemService itemService = ContentServiceFactory.getInstance().getItemService();
+ protected static CollectionService collectionService = ContentServiceFactory.getInstance().getCollectionService();
+ protected static final EPersonService epersonService =
+ EPersonServiceFactory.getInstance().getEPersonService();
+
+ @Override
+ public ItemExportScriptConfiguration getScriptConfiguration() {
+ return new DSpace().getServiceManager()
+ .getServiceByName("export", ItemExportScriptConfiguration.class);
+ }
+
+ @Override
+ public void setup() throws ParseException {
+ help = commandLine.hasOption('h');
+
+ if (commandLine.hasOption('t')) { // type
+ typeString = commandLine.getOptionValue('t');
+
+ if ("ITEM".equals(typeString)) {
+ type = Constants.ITEM;
+ } else if ("COLLECTION".equals(typeString)) {
+ type = Constants.COLLECTION;
+ }
+ }
+
+ if (commandLine.hasOption('i')) { // id
+ idString = commandLine.getOptionValue('i');
+ }
+
+ setNumber();
+
+ if (commandLine.hasOption('m')) { // number
+ migrate = true;
+ }
+
+ if (commandLine.hasOption('x')) {
+ excludeBitstreams = true;
+ }
+ }
+
+ @Override
+ public void internalRun() throws Exception {
+ if (help) {
+ printHelp();
+ return;
+ }
+
+ validate();
+
+ Context context = new Context();
+ context.turnOffAuthorisationSystem();
+
+ if (type == Constants.ITEM) {
+ // first, is myIDString a handle?
+ if (idString.indexOf('/') != -1) {
+ item = (Item) handleService.resolveToObject(context, idString);
+
+ if ((item == null) || (item.getType() != Constants.ITEM)) {
+ item = null;
+ }
+ } else {
+ item = itemService.find(context, UUID.fromString(idString));
+ }
+
+ if (item == null) {
+ handler.logError("The item cannot be found: " + idString + " (run with -h flag for details)");
+ throw new UnsupportedOperationException("The item cannot be found: " + idString);
+ }
+ } else {
+ if (idString.indexOf('/') != -1) {
+ // has a / must be a handle
+ collection = (Collection) handleService.resolveToObject(context,
+ idString);
+
+ // ensure it's a collection
+ if ((collection == null)
+ || (collection.getType() != Constants.COLLECTION)) {
+ collection = null;
+ }
+ } else {
+ collection = collectionService.find(context, UUID.fromString(idString));
+ }
+
+ if (collection == null) {
+ handler.logError("The collection cannot be found: " + idString + " (run with -h flag for details)");
+ throw new UnsupportedOperationException("The collection cannot be found: " + idString);
+ }
+ }
+
+ ItemExportService itemExportService = ItemExportServiceFactory.getInstance()
+ .getItemExportService();
+ try {
+ itemExportService.setHandler(handler);
+ process(context, itemExportService);
+ context.complete();
+ } catch (Exception e) {
+ context.abort();
+ throw new Exception(e);
+ }
+ }
+
+ /**
+ * Validate the options
+ */
+ protected void validate() {
+ if (type == -1) {
+ handler.logError("The type must be either COLLECTION or ITEM (run with -h flag for details)");
+ throw new UnsupportedOperationException("The type must be either COLLECTION or ITEM");
+ }
+
+ if (idString == null) {
+ handler.logError("The ID must be set to either a database ID or a handle (run with -h flag for details)");
+ throw new UnsupportedOperationException("The ID must be set to either a database ID or a handle");
+ }
+ }
+
+ /**
+ * Process the export
+ * @param context
+ * @throws Exception
+ */
+ protected void process(Context context, ItemExportService itemExportService) throws Exception {
+ setEPerson(context);
+ setDestDirName(context, itemExportService);
+ setZip(context);
+
+ Iterator- items;
+ if (item != null) {
+ List
- myItems = new ArrayList<>();
+ myItems.add(item);
+ items = myItems.iterator();
+ } else {
+ handler.logInfo("Exporting from collection: " + idString);
+ items = itemService.findByCollection(context, collection);
+ }
+ itemExportService.exportAsZip(context, items, destDirName, zipFileName,
+ seqStart, migrate, excludeBitstreams);
+
+ File zip = new File(destDirName + System.getProperty("file.separator") + zipFileName);
+ try (InputStream is = new FileInputStream(zip)) {
+ // write input stream on handler
+ handler.writeFilestream(context, ZIP_FILENAME + "." + ZIP_EXT, is, ZIP_NAME);
+ } finally {
+ PathUtils.deleteDirectory(Path.of(destDirName));
+ }
+ }
+
+ /**
+ * Set the destination directory option
+ */
+ protected void setDestDirName(Context context, ItemExportService itemExportService) throws Exception {
+ destDirName = itemExportService.getExportWorkDirectory() + File.separator + TEMP_DIR;
+ }
+
+ /**
+ * Set the zip option
+ */
+ protected void setZip(Context context) {
+ zip = true;
+ zipFileName = ZIP_FILENAME + "-" + context.getCurrentUser().getID() + "." + ZIP_EXT;
+ }
+
+ /**
+ * Set the number option
+ */
+ protected void setNumber() {
+ seqStart = 1;
+ if (commandLine.hasOption('n')) { // number
+ seqStart = Integer.parseInt(commandLine.getOptionValue('n'));
+ }
+ }
+
+ private void setEPerson(Context context) throws SQLException {
+ EPerson myEPerson = epersonService.find(context, this.getEpersonIdentifier());
+
+ // check eperson
+ if (myEPerson == null) {
+ handler.logError("EPerson cannot be found: " + this.getEpersonIdentifier());
+ throw new UnsupportedOperationException("EPerson cannot be found: " + this.getEpersonIdentifier());
+ }
+
+ context.setCurrentUser(myEPerson);
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLI.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLI.java
new file mode 100644
index 000000000000..8e9af1e01094
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLI.java
@@ -0,0 +1,96 @@
+/**
+ * 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.itemexport;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Iterator;
+import java.util.List;
+
+import org.dspace.app.itemexport.service.ItemExportService;
+import org.dspace.content.Item;
+import org.dspace.core.Context;
+
+/**
+ * CLI variant for the {@link ItemExport} class.
+ * This was done to specify the specific behaviors for the CLI.
+ *
+ * @author Francesco Pio Scognamiglio (francescopio.scognamiglio at 4science.com)
+ */
+public class ItemExportCLI extends ItemExport {
+
+ @Override
+ protected void validate() {
+ super.validate();
+
+ setDestDirName();
+
+ if (destDirName == null) {
+ handler.logError("The destination directory must be set (run with -h flag for details)");
+ throw new UnsupportedOperationException("The destination directory must be set");
+ }
+
+ if (seqStart == -1) {
+ handler.logError("The sequence start number must be set (run with -h flag for details)");
+ throw new UnsupportedOperationException("The sequence start number must be set");
+ }
+ }
+
+ @Override
+ protected void process(Context context, ItemExportService itemExportService) throws Exception {
+ setZip(context);
+
+ if (zip) {
+ Iterator
- items;
+ if (item != null) {
+ List
- myItems = new ArrayList<>();
+ myItems.add(item);
+ items = myItems.iterator();
+ } else {
+ handler.logInfo("Exporting from collection: " + idString);
+ items = itemService.findByCollection(context, collection);
+ }
+ itemExportService.exportAsZip(context, items, destDirName, zipFileName,
+ seqStart, migrate, excludeBitstreams);
+ } else {
+ if (item != null) {
+ // it's only a single item
+ itemExportService
+ .exportItem(context, Collections.singletonList(item).iterator(), destDirName,
+ seqStart, migrate, excludeBitstreams);
+ } else {
+ handler.logInfo("Exporting from collection: " + idString);
+
+ // it's a collection, so do a bunch of items
+ Iterator
- i = itemService.findByCollection(context, collection);
+ itemExportService.exportItem(context, i, destDirName, seqStart, migrate, excludeBitstreams);
+ }
+ }
+ }
+
+ protected void setDestDirName() {
+ if (commandLine.hasOption('d')) { // dest
+ destDirName = commandLine.getOptionValue('d');
+ }
+ }
+
+ @Override
+ protected void setZip(Context context) {
+ if (commandLine.hasOption('z')) {
+ zip = true;
+ zipFileName = commandLine.getOptionValue('z');
+ }
+ }
+
+ @Override
+ protected void setNumber() {
+ if (commandLine.hasOption('n')) { // number
+ seqStart = Integer.parseInt(commandLine.getOptionValue('n'));
+ }
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLIScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLIScriptConfiguration.java
new file mode 100644
index 000000000000..ff79c7cfa703
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLIScriptConfiguration.java
@@ -0,0 +1,56 @@
+/**
+ * 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.itemexport;
+
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link ItemExportCLI} script
+ *
+ * @author Francesco Pio Scognamiglio (francescopio.scognamiglio at 4science.com)
+ */
+public class ItemExportCLIScriptConfiguration extends ItemExportScriptConfiguration {
+
+ @Override
+ public Options getOptions() {
+ Options options = new Options();
+
+ options.addOption(Option.builder("t").longOpt("type")
+ .desc("type: COLLECTION or ITEM")
+ .hasArg().required().build());
+ options.addOption(Option.builder("i").longOpt("id")
+ .desc("ID or handle of thing to export")
+ .hasArg().required().build());
+ options.addOption(Option.builder("d").longOpt("dest")
+ .desc("destination where you want items to go")
+ .hasArg().required().build());
+ options.addOption(Option.builder("n").longOpt("number")
+ .desc("sequence number to begin exporting items with")
+ .hasArg().required().build());
+ options.addOption(Option.builder("z").longOpt("zip")
+ .desc("export as zip file (specify filename e.g. export.zip)")
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("m").longOpt("migrate")
+ .desc("export for migration (remove handle and metadata that will be re-created in new system)")
+ .hasArg(false).required(false).build());
+
+ // as pointed out by Peter Dietz this provides similar functionality to export metadata
+ // but it is needed since it directly exports to Simple Archive Format (SAF)
+ options.addOption(Option.builder("x").longOpt("exclude-bitstreams")
+ .desc("do not export bitstreams")
+ .hasArg(false).required(false).build());
+
+ options.addOption(Option.builder("h").longOpt("help")
+ .desc("help")
+ .hasArg(false).required(false).build());
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLITool.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLITool.java
deleted file mode 100644
index d6a69b582394..000000000000
--- a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportCLITool.java
+++ /dev/null
@@ -1,246 +0,0 @@
-/**
- * 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.itemexport;
-
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.Iterator;
-import java.util.List;
-import java.util.UUID;
-
-import org.apache.commons.cli.CommandLine;
-import org.apache.commons.cli.CommandLineParser;
-import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.HelpFormatter;
-import org.apache.commons.cli.Options;
-import org.dspace.app.itemexport.factory.ItemExportServiceFactory;
-import org.dspace.app.itemexport.service.ItemExportService;
-import org.dspace.content.Collection;
-import org.dspace.content.Item;
-import org.dspace.content.factory.ContentServiceFactory;
-import org.dspace.content.service.CollectionService;
-import org.dspace.content.service.ItemService;
-import org.dspace.core.Constants;
-import org.dspace.core.Context;
-import org.dspace.handle.factory.HandleServiceFactory;
-import org.dspace.handle.service.HandleService;
-
-/**
- * Item exporter to create simple AIPs for DSpace content. Currently exports
- * individual items, or entire collections. For instructions on use, see
- * printUsage() method.
- *
- * ItemExport creates the simple AIP package that the importer also uses. It
- * consists of:
- *
- * /exportdir/42/ (one directory per item) / dublin_core.xml - qualified dublin
- * core in RDF schema / contents - text file, listing one file per line / file1
- * - files contained in the item / file2 / ...
- *
- * issues -doesn't handle special characters in metadata (needs to turn {@code &'s} into
- * {@code &}, etc.)
- *
- * Modified by David Little, UCSD Libraries 12/21/04 to allow the registration
- * of files (bitstreams) into DSpace.
- *
- * @author David Little
- * @author Jay Paz
- */
-public class ItemExportCLITool {
-
- protected static ItemExportService itemExportService = ItemExportServiceFactory.getInstance()
- .getItemExportService();
- protected static HandleService handleService = HandleServiceFactory.getInstance().getHandleService();
- protected static ItemService itemService = ContentServiceFactory.getInstance().getItemService();
- protected static CollectionService collectionService = ContentServiceFactory.getInstance().getCollectionService();
-
- /**
- * Default constructor
- */
- private ItemExportCLITool() { }
-
- /*
- *
- */
- public static void main(String[] argv) throws Exception {
- // create an options object and populate it
- CommandLineParser parser = new DefaultParser();
-
- Options options = new Options();
-
- options.addOption("t", "type", true, "type: COLLECTION or ITEM");
- options.addOption("i", "id", true, "ID or handle of thing to export");
- options.addOption("d", "dest", true,
- "destination where you want items to go");
- options.addOption("m", "migrate", false,
- "export for migration (remove handle and metadata that will be re-created in new system)");
- options.addOption("n", "number", true,
- "sequence number to begin exporting items with");
- options.addOption("z", "zip", true, "export as zip file (specify filename e.g. export.zip)");
- options.addOption("h", "help", false, "help");
-
- // as pointed out by Peter Dietz this provides similar functionality to export metadata
- // but it is needed since it directly exports to Simple Archive Format (SAF)
- options.addOption("x", "exclude-bitstreams", false, "do not export bitstreams");
-
- CommandLine line = parser.parse(options, argv);
-
- String typeString = null;
- String destDirName = null;
- String myIDString = null;
- int seqStart = -1;
- int myType = -1;
-
- Item myItem = null;
- Collection mycollection = null;
-
- if (line.hasOption('h')) {
- HelpFormatter myhelp = new HelpFormatter();
- myhelp.printHelp("ItemExport\n", options);
- System.out
- .println("\nfull collection: ItemExport -t COLLECTION -i ID -d dest -n number");
- System.out
- .println("singleitem: ItemExport -t ITEM -i ID -d dest -n number");
-
- System.exit(0);
- }
-
- if (line.hasOption('t')) { // type
- typeString = line.getOptionValue('t');
-
- if ("ITEM".equals(typeString)) {
- myType = Constants.ITEM;
- } else if ("COLLECTION".equals(typeString)) {
- myType = Constants.COLLECTION;
- }
- }
-
- if (line.hasOption('i')) { // id
- myIDString = line.getOptionValue('i');
- }
-
- if (line.hasOption('d')) { // dest
- destDirName = line.getOptionValue('d');
- }
-
- if (line.hasOption('n')) { // number
- seqStart = Integer.parseInt(line.getOptionValue('n'));
- }
-
- boolean migrate = false;
- if (line.hasOption('m')) { // number
- migrate = true;
- }
-
- boolean zip = false;
- String zipFileName = "";
- if (line.hasOption('z')) {
- zip = true;
- zipFileName = line.getOptionValue('z');
- }
-
- boolean excludeBitstreams = false;
- if (line.hasOption('x')) {
- excludeBitstreams = true;
- }
-
- // now validate the args
- if (myType == -1) {
- System.out
- .println("type must be either COLLECTION or ITEM (-h for help)");
- System.exit(1);
- }
-
- if (destDirName == null) {
- System.out
- .println("destination directory must be set (-h for help)");
- System.exit(1);
- }
-
- if (seqStart == -1) {
- System.out
- .println("sequence start number must be set (-h for help)");
- System.exit(1);
- }
-
- if (myIDString == null) {
- System.out
- .println("ID must be set to either a database ID or a handle (-h for help)");
- System.exit(1);
- }
-
- Context c = new Context(Context.Mode.READ_ONLY);
- c.turnOffAuthorisationSystem();
-
- if (myType == Constants.ITEM) {
- // first, is myIDString a handle?
- if (myIDString.indexOf('/') != -1) {
- myItem = (Item) handleService.resolveToObject(c, myIDString);
-
- if ((myItem == null) || (myItem.getType() != Constants.ITEM)) {
- myItem = null;
- }
- } else {
- myItem = itemService.find(c, UUID.fromString(myIDString));
- }
-
- if (myItem == null) {
- System.out
- .println("Error, item cannot be found: " + myIDString);
- }
- } else {
- if (myIDString.indexOf('/') != -1) {
- // has a / must be a handle
- mycollection = (Collection) handleService.resolveToObject(c,
- myIDString);
-
- // ensure it's a collection
- if ((mycollection == null)
- || (mycollection.getType() != Constants.COLLECTION)) {
- mycollection = null;
- }
- } else if (myIDString != null) {
- mycollection = collectionService.find(c, UUID.fromString(myIDString));
- }
-
- if (mycollection == null) {
- System.out.println("Error, collection cannot be found: "
- + myIDString);
- System.exit(1);
- }
- }
-
- if (zip) {
- Iterator- items;
- if (myItem != null) {
- List
- myItems = new ArrayList<>();
- myItems.add(myItem);
- items = myItems.iterator();
- } else {
- System.out.println("Exporting from collection: " + myIDString);
- items = itemService.findByCollection(c, mycollection);
- }
- itemExportService.exportAsZip(c, items, destDirName, zipFileName, seqStart, migrate, excludeBitstreams);
- } else {
- if (myItem != null) {
- // it's only a single item
- itemExportService
- .exportItem(c, Collections.singletonList(myItem).iterator(), destDirName, seqStart, migrate,
- excludeBitstreams);
- } else {
- System.out.println("Exporting from collection: " + myIDString);
-
- // it's a collection, so do a bunch of items
- Iterator
- i = itemService.findByCollection(c, mycollection);
- itemExportService.exportItem(c, i, destDirName, seqStart, migrate, excludeBitstreams);
- }
- }
-
- c.complete();
- }
-}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportScriptConfiguration.java
new file mode 100644
index 000000000000..b37df5f5ea59
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportScriptConfiguration.java
@@ -0,0 +1,62 @@
+/**
+ * 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.itemexport;
+
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link ItemExport} script
+ *
+ * @author Francesco Pio Scognamiglio (francescopio.scognamiglio at 4science.com)
+ */
+public class ItemExportScriptConfiguration extends ScriptConfiguration {
+
+ private Class dspaceRunnableClass;
+
+ @Override
+ public Class getDspaceRunnableClass() {
+ return dspaceRunnableClass;
+ }
+
+ @Override
+ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
+ this.dspaceRunnableClass = dspaceRunnableClass;
+ }
+
+ @Override
+ public Options getOptions() {
+ Options options = new Options();
+
+ options.addOption(Option.builder("t").longOpt("type")
+ .desc("type: COLLECTION or ITEM")
+ .hasArg().required().build());
+ options.addOption(Option.builder("i").longOpt("id")
+ .desc("ID or handle of thing to export")
+ .hasArg().required().build());
+ options.addOption(Option.builder("n").longOpt("number")
+ .desc("sequence number to begin exporting items with")
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("m").longOpt("migrate")
+ .desc("export for migration (remove handle and metadata that will be re-created in new system)")
+ .hasArg(false).required(false).build());
+
+ // as pointed out by Peter Dietz this provides similar functionality to export metadata
+ // but it is needed since it directly exports to Simple Archive Format (SAF)
+ options.addOption(Option.builder("x").longOpt("exclude-bitstreams")
+ .desc("do not export bitstreams")
+ .hasArg(false).required(false).build());
+
+ options.addOption(Option.builder("h").longOpt("help")
+ .desc("help")
+ .hasArg(false).required(false).build());
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportServiceImpl.java b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportServiceImpl.java
index 7d5e63c1274d..a884f9b07564 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportServiceImpl.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemexport/ItemExportServiceImpl.java
@@ -16,6 +16,7 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
+import java.nio.charset.StandardCharsets;
import java.sql.SQLException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
@@ -51,11 +52,12 @@
import org.dspace.core.Context;
import org.dspace.core.Email;
import org.dspace.core.I18nUtil;
-import org.dspace.core.LogManager;
+import org.dspace.core.LogHelper;
import org.dspace.core.Utils;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.service.EPersonService;
import org.dspace.handle.service.HandleService;
+import org.dspace.scripts.handler.DSpaceRunnableHandler;
import org.dspace.services.ConfigurationService;
import org.springframework.beans.factory.annotation.Autowired;
@@ -63,17 +65,21 @@
* Item exporter to create simple AIPs for DSpace content. Currently exports
* individual items, or entire collections. For instructions on use, see
* printUsage() method.
- *
+ *
* ItemExport creates the simple AIP package that the importer also uses. It
* consists of:
- *
- * /exportdir/42/ (one directory per item) / dublin_core.xml - qualified dublin
- * core in RDF schema / contents - text file, listing one file per line / file1
- * - files contained in the item / file2 / ...
- *
+ *
{@code
+ * /exportdir/42/ (one directory per item)
+ * / dublin_core.xml - qualified dublin core in RDF schema
+ * / contents - text file, listing one file per line
+ * / file1 - files contained in the item
+ * / file2
+ * / ...
+ * }
+ *
* issues -doesn't handle special characters in metadata (needs to turn {@code &'s} into
* {@code &}, etc.)
- *
+ *
* Modified by David Little, UCSD Libraries 12/21/04 to allow the registration
* of files (bitstreams) into DSpace.
*
@@ -96,11 +102,12 @@ public class ItemExportServiceImpl implements ItemExportService {
@Autowired(required = true)
protected ConfigurationService configurationService;
-
/**
* log4j logger
*/
- private final Logger log = org.apache.logging.log4j.LogManager.getLogger(ItemExportServiceImpl.class);
+ private final Logger log = org.apache.logging.log4j.LogManager.getLogger();
+
+ private DSpaceRunnableHandler handler;
protected ItemExportServiceImpl() {
@@ -125,11 +132,11 @@ public void exportItem(Context c, Iterator- i,
}
}
- System.out.println("Beginning export");
+ logInfo("Beginning export");
while (i.hasNext()) {
if (SUBDIR_LIMIT > 0 && ++counter == SUBDIR_LIMIT) {
- subdir = Integer.valueOf(subDirSuffix++).toString();
+ subdir = Integer.toString(subDirSuffix++);
fullPath = destDirName + File.separatorChar + subdir;
counter = 0;
@@ -138,7 +145,7 @@ public void exportItem(Context c, Iterator
- i,
}
}
- System.out.println("Exporting item to " + mySequenceNumber);
+ logInfo("Exporting item to " + mySequenceNumber);
Item item = i.next();
exportItem(c, item, fullPath, mySequenceNumber, migrate, excludeBitstreams);
c.uncacheEntity(item);
@@ -154,7 +161,7 @@ protected void exportItem(Context c, Item myItem, String destDirName,
// now create a subdirectory
File itemDir = new File(destDir + "/" + seqStart);
- System.out.println("Exporting Item " + myItem.getID() +
+ logInfo("Exporting Item " + myItem.getID() +
(myItem.getHandle() != null ? ", handle " + myItem.getHandle() : "") +
" to " + itemDir);
@@ -167,6 +174,7 @@ protected void exportItem(Context c, Item myItem, String destDirName,
// make it this far, now start exporting
writeMetadata(c, myItem, itemDir, migrate);
writeBitstreams(c, myItem, itemDir, excludeBitstreams);
+ writeCollections(myItem, itemDir);
if (!migrate) {
writeHandle(c, myItem, itemDir);
}
@@ -191,7 +199,7 @@ protected void exportItem(Context c, Item myItem, String destDirName,
*/
protected void writeMetadata(Context c, Item i, File destDir, boolean migrate)
throws Exception {
- Set schemas = new HashSet();
+ Set schemas = new HashSet<>();
List dcValues = itemService.getMetadata(i, Item.ANY, Item.ANY, Item.ANY, Item.ANY);
for (MetadataValue metadataValue : dcValues) {
schemas.add(metadataValue.getMetadataField().getMetadataSchema().getName());
@@ -224,7 +232,7 @@ protected void writeMetadata(Context c, String schema, Item i,
File outFile = new File(destDir, filename);
- System.out.println("Attempting to create file " + outFile);
+ logInfo("Attempting to create file " + outFile);
if (outFile.createNewFile()) {
BufferedOutputStream out = new BufferedOutputStream(
@@ -267,7 +275,7 @@ protected void writeMetadata(Context c, String schema, Item i,
+ Utils.addEntities(dcv.getValue()) + "\n")
.getBytes("UTF-8");
- if ((!migrate) ||
+ if (!migrate ||
(migrate && !(
("date".equals(metadataField.getElement()) && "issued".equals(qualifier)) ||
("date".equals(metadataField.getElement()) && "accessioned".equals(qualifier)) ||
@@ -292,10 +300,10 @@ protected void writeMetadata(Context c, String schema, Item i,
}
// When migrating, only keep date.issued if it is different to date.accessioned
- if ((migrate) &&
+ if (migrate &&
(dateIssued != null) &&
(dateAccessioned != null) &&
- (!dateIssued.equals(dateAccessioned))) {
+ !dateIssued.equals(dateAccessioned)) {
utf8 = (" "
+ Utils.addEntities(dateIssued) + "\n")
@@ -330,7 +338,7 @@ protected void writeHandle(Context c, Item i, File destDir)
File outFile = new File(destDir, filename);
if (outFile.createNewFile()) {
- PrintWriter out = new PrintWriter(new FileWriter(outFile));
+ PrintWriter out = new PrintWriter(new FileWriter(outFile, StandardCharsets.UTF_8));
out.println(i.getHandle());
@@ -342,6 +350,33 @@ protected void writeHandle(Context c, Item i, File destDir)
}
}
+ /**
+ * Create the 'collections' file. List handles of all Collections which
+ * contain this Item. The "owning" Collection is listed first.
+ *
+ * @param item list collections holding this Item.
+ * @param destDir write the file here.
+ * @throws IOException if the file cannot be created or written.
+ */
+ protected void writeCollections(Item item, File destDir)
+ throws IOException {
+ File outFile = new File(destDir, "collections");
+ if (outFile.createNewFile()) {
+ try (PrintWriter out = new PrintWriter(new FileWriter(outFile))) {
+ String ownerHandle = item.getOwningCollection().getHandle();
+ out.println(ownerHandle);
+ for (Collection collection : item.getCollections()) {
+ String collectionHandle = collection.getHandle();
+ if (!collectionHandle.equals(ownerHandle)) {
+ out.println(collectionHandle);
+ }
+ }
+ }
+ } else {
+ throw new IOException("Cannot create 'collections' in " + destDir);
+ }
+ }
+
/**
* Create both the bitstreams and the contents file. Any bitstreams that
* were originally registered will be marked in the contents file as such.
@@ -360,7 +395,7 @@ protected void writeBitstreams(Context c, Item i, File destDir,
File outFile = new File(destDir, "contents");
if (outFile.createNewFile()) {
- PrintWriter out = new PrintWriter(new FileWriter(outFile));
+ PrintWriter out = new PrintWriter(new FileWriter(outFile, StandardCharsets.UTF_8));
List bundles = i.getBundles();
@@ -398,7 +433,7 @@ protected void writeBitstreams(Context c, Item i, File destDir,
File fdirs = new File(destDir + File.separator
+ dirs);
if (!fdirs.exists() && !fdirs.mkdirs()) {
- log.error("Unable to create destination directory");
+ logError("Unable to create destination directory");
}
}
@@ -455,12 +490,12 @@ public void exportAsZip(Context context, Iterator
- items,
File wkDir = new File(workDir);
if (!wkDir.exists() && !wkDir.mkdirs()) {
- log.error("Unable to create working direcory");
+ logError("Unable to create working direcory");
}
File dnDir = new File(destDirName);
if (!dnDir.exists() && !dnDir.mkdirs()) {
- log.error("Unable to create destination directory");
+ logError("Unable to create destination directory");
}
// export the items using normal export method
@@ -474,7 +509,7 @@ public void exportAsZip(Context context, Iterator
- items,
public void createDownloadableExport(DSpaceObject dso,
Context context, boolean migrate) throws Exception {
EPerson eperson = context.getCurrentUser();
- ArrayList list = new ArrayList(1);
+ ArrayList list = new ArrayList<>(1);
list.add(dso);
processDownloadableExport(list, context, eperson == null ? null
: eperson.getEmail(), migrate);
@@ -491,7 +526,7 @@ public void createDownloadableExport(List dsObjects,
@Override
public void createDownloadableExport(DSpaceObject dso,
Context context, String additionalEmail, boolean migrate) throws Exception {
- ArrayList list = new ArrayList(1);
+ ArrayList list = new ArrayList<>(1);
list.add(dso);
processDownloadableExport(list, context, additionalEmail, migrate);
}
@@ -629,11 +664,9 @@ protected void processDownloadableExport(List dsObjects,
Thread go = new Thread() {
@Override
public void run() {
- Context context = null;
+ Context context = new Context();
Iterator
- iitems = null;
try {
- // create a new dspace context
- context = new Context();
// ignore auths
context.turnOffAuthorisationSystem();
@@ -645,14 +678,14 @@ public void run() {
String downloadDir = getExportDownloadDirectory(eperson);
File dnDir = new File(downloadDir);
if (!dnDir.exists() && !dnDir.mkdirs()) {
- log.error("Unable to create download directory");
+ logError("Unable to create download directory");
}
Iterator iter = itemsMap.keySet().iterator();
while (iter.hasNext()) {
String keyName = iter.next();
List uuids = itemsMap.get(keyName);
- List
- items = new ArrayList
- ();
+ List
- items = new ArrayList<>();
for (UUID uuid : uuids) {
items.add(itemService.find(context, uuid));
}
@@ -664,7 +697,7 @@ public void run() {
File wkDir = new File(workDir);
if (!wkDir.exists() && !wkDir.mkdirs()) {
- log.error("Unable to create working directory");
+ logError("Unable to create working directory");
}
@@ -755,7 +788,8 @@ public String getExportWorkDirectory() throws Exception {
throw new Exception(
"A dspace.cfg entry for 'org.dspace.app.itemexport.work.dir' does not exist.");
}
- return exportDir;
+ // clean work dir path from duplicate separators
+ return StringUtils.replace(exportDir, File.separator + File.separator, File.separator);
}
@Override
@@ -876,14 +910,14 @@ public void deleteOldExportArchives(EPerson eperson) throws Exception {
.getIntProperty("org.dspace.app.itemexport.life.span.hours");
Calendar now = Calendar.getInstance();
now.setTime(new Date());
- now.add(Calendar.HOUR, (-hours));
+ now.add(Calendar.HOUR, -hours);
File downloadDir = new File(getExportDownloadDirectory(eperson));
if (downloadDir.exists()) {
File[] files = downloadDir.listFiles();
for (File file : files) {
if (file.lastModified() < now.getTimeInMillis()) {
if (!file.delete()) {
- log.error("Unable to delete export file");
+ logError("Unable to delete export file");
}
}
}
@@ -896,7 +930,7 @@ public void deleteOldExportArchives() throws Exception {
int hours = configurationService.getIntProperty("org.dspace.app.itemexport.life.span.hours");
Calendar now = Calendar.getInstance();
now.setTime(new Date());
- now.add(Calendar.HOUR, (-hours));
+ now.add(Calendar.HOUR, -hours);
File downloadDir = new File(configurationService.getProperty("org.dspace.app.itemexport.download.dir"));
if (downloadDir.exists()) {
// Get a list of all the sub-directories, potentially one for each ePerson.
@@ -907,7 +941,7 @@ public void deleteOldExportArchives() throws Exception {
for (File file : files) {
if (file.lastModified() < now.getTimeInMillis()) {
if (!file.delete()) {
- log.error("Unable to delete old files");
+ logError("Unable to delete old files");
}
}
}
@@ -915,7 +949,7 @@ public void deleteOldExportArchives() throws Exception {
// If the directory is now empty then we delete it too.
if (dir.listFiles().length == 0) {
if (!dir.delete()) {
- log.error("Unable to delete directory");
+ logError("Unable to delete directory");
}
}
}
@@ -936,14 +970,14 @@ public void emailSuccessMessage(Context context, EPerson eperson,
email.send();
} catch (Exception e) {
- log.warn(LogManager.getHeader(context, "emailSuccessMessage", "cannot notify user of export"), e);
+ logWarn(LogHelper.getHeader(context, "emailSuccessMessage", "cannot notify user of export"), e);
}
}
@Override
public void emailErrorMessage(EPerson eperson, String error)
throws MessagingException {
- log.warn("An error occurred during item export, the user will be notified. " + error);
+ logWarn("An error occurred during item export, the user will be notified. " + error);
try {
Locale supportedLocale = I18nUtil.getEPersonLocale(eperson);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "export_error"));
@@ -953,7 +987,7 @@ public void emailErrorMessage(EPerson eperson, String error)
email.send();
} catch (Exception e) {
- log.warn("error during item export error notification", e);
+ logWarn("error during item export error notification", e);
}
}
@@ -968,7 +1002,7 @@ public void zip(String strSource, String target) throws Exception {
}
File targetFile = new File(tempFileName);
if (!targetFile.createNewFile()) {
- log.warn("Target file already exists: " + targetFile.getName());
+ logWarn("Target file already exists: " + targetFile.getName());
}
FileOutputStream fos = new FileOutputStream(tempFileName);
@@ -984,7 +1018,7 @@ public void zip(String strSource, String target) throws Exception {
deleteDirectory(cpFile);
if (!targetFile.renameTo(new File(target))) {
- log.error("Unable to rename file");
+ logError("Unable to rename file");
}
} finally {
if (cpZipOutputStream != null) {
@@ -1017,8 +1051,11 @@ protected void zipFiles(File cpFile, String strSource,
return;
}
String strAbsPath = cpFile.getPath();
- String strZipEntryName = strAbsPath.substring(strSource
- .length() + 1, strAbsPath.length());
+ int startIndex = strSource.length();
+ if (!StringUtils.endsWith(strSource, File.separator)) {
+ startIndex++;
+ }
+ String strZipEntryName = strAbsPath.substring(startIndex, strAbsPath.length());
// byte[] b = new byte[ (int)(cpFile.length()) ];
@@ -1057,7 +1094,7 @@ protected boolean deleteDirectory(File path) {
deleteDirectory(file);
} else {
if (!file.delete()) {
- log.error("Unable to delete file: " + file.getName());
+ logError("Unable to delete file: " + file.getName());
}
}
}
@@ -1066,4 +1103,64 @@ protected boolean deleteDirectory(File path) {
return (path.delete());
}
+ @Override
+ public void setHandler(DSpaceRunnableHandler handler) {
+ this.handler = handler;
+ }
+
+ private void logInfo(String message) {
+ logInfo(message, null);
+ }
+
+ private void logInfo(String message, Exception e) {
+ if (handler != null) {
+ handler.logInfo(message);
+ return;
+ }
+
+ if (e != null) {
+ log.info(message, e);
+ } else {
+ log.info(message);
+ }
+ }
+
+ private void logWarn(String message) {
+ logWarn(message, null);
+ }
+
+ private void logWarn(String message, Exception e) {
+ if (handler != null) {
+ handler.logWarning(message);
+ return;
+ }
+
+ if (e != null) {
+ log.warn(message, e);
+ } else {
+ log.warn(message);
+ }
+ }
+
+ private void logError(String message) {
+ logError(message, null);
+ }
+
+ private void logError(String message, Exception e) {
+ if (handler != null) {
+ if (e != null) {
+ handler.logError(message, e);
+ } else {
+ handler.logError(message);
+ }
+ return;
+ }
+
+ if (e != null) {
+ log.error(message, e);
+ } else {
+ log.error(message);
+ }
+ }
+
}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemexport/service/ItemExportService.java b/dspace-api/src/main/java/org/dspace/app/itemexport/service/ItemExportService.java
index 7dedc9950b4f..6ec1027709bb 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemexport/service/ItemExportService.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemexport/service/ItemExportService.java
@@ -17,6 +17,7 @@
import org.dspace.content.Item;
import org.dspace.core.Context;
import org.dspace.eperson.EPerson;
+import org.dspace.scripts.handler.DSpaceRunnableHandler;
/**
* Item exporter to create simple AIPs for DSpace content. Currently exports
@@ -267,4 +268,10 @@ public void emailErrorMessage(EPerson eperson, String error)
*/
public void zip(String strSource, String target) throws Exception;
+ /**
+ * Set the DSpace Runnable Handler
+ * @param handler
+ */
+ public void setHandler(DSpaceRunnableHandler handler);
+
}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImport.java b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImport.java
new file mode 100644
index 000000000000..b32de11f7a7f
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImport.java
@@ -0,0 +1,440 @@
+/**
+ * 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.itemimport;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URL;
+import java.nio.file.Files;
+import java.sql.SQLException;
+import java.util.ArrayList;
+import java.util.Date;
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+
+import org.apache.commons.cli.ParseException;
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.tika.Tika;
+import org.dspace.app.itemimport.factory.ItemImportServiceFactory;
+import org.dspace.app.itemimport.service.ItemImportService;
+import org.dspace.authorize.AuthorizeException;
+import org.dspace.content.Collection;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.CollectionService;
+import org.dspace.core.Constants;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+import org.dspace.eperson.factory.EPersonServiceFactory;
+import org.dspace.eperson.service.EPersonService;
+import org.dspace.handle.factory.HandleServiceFactory;
+import org.dspace.handle.service.HandleService;
+import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.utils.DSpace;
+
+/**
+ * Import items into DSpace. The conventional use is upload files by copying
+ * them. DSpace writes the item's bitstreams into its assetstore. Metadata is
+ * also loaded to the DSpace database.
+ *
+ * A second use assumes the bitstream files already exist in a storage
+ * resource accessible to DSpace. In this case the bitstreams are 'registered'.
+ * That is, the metadata is loaded to the DSpace database and DSpace is given
+ * the location of the file which is subsumed into DSpace.
+ *
+ * The distinction is controlled by the format of lines in the 'contents' file.
+ * See comments in processContentsFile() below.
+ *
+ * Modified by David Little, UCSD Libraries 12/21/04 to
+ * allow the registration of files (bitstreams) into DSpace.
+ */
+public class ItemImport extends DSpaceRunnable {
+
+ public static String TEMP_DIR = "importSAF";
+ public static String MAPFILE_FILENAME = "mapfile";
+ public static String MAPFILE_BITSTREAM_TYPE = "importSAFMapfile";
+
+ protected boolean template = false;
+ protected String command = null;
+ protected String sourcedir = null;
+ protected String mapfile = null;
+ protected String eperson = null;
+ protected String[] collections = null;
+ protected boolean isTest = false;
+ protected boolean isExcludeContent = false;
+ protected boolean isResume = false;
+ protected boolean useWorkflow = false;
+ protected boolean useWorkflowSendEmail = false;
+ protected boolean isQuiet = false;
+ protected boolean commandLineCollections = false;
+ protected boolean zip = false;
+ protected boolean remoteUrl = false;
+ protected String zipfilename = null;
+ protected boolean zipvalid = false;
+ protected boolean help = false;
+ protected File workDir = null;
+ protected File workFile = null;
+
+ protected static final CollectionService collectionService =
+ ContentServiceFactory.getInstance().getCollectionService();
+ protected static final EPersonService epersonService =
+ EPersonServiceFactory.getInstance().getEPersonService();
+ protected static final HandleService handleService =
+ HandleServiceFactory.getInstance().getHandleService();
+
+ @Override
+ public ItemImportScriptConfiguration getScriptConfiguration() {
+ return new DSpace().getServiceManager()
+ .getServiceByName("import", ItemImportScriptConfiguration.class);
+ }
+
+ @Override
+ public void setup() throws ParseException {
+ help = commandLine.hasOption('h');
+
+ if (commandLine.hasOption('a')) {
+ command = "add";
+ }
+
+ if (commandLine.hasOption('r')) {
+ command = "replace";
+ }
+
+ if (commandLine.hasOption('d')) {
+ command = "delete";
+ }
+
+ if (commandLine.hasOption('w')) {
+ useWorkflow = true;
+ if (commandLine.hasOption('n')) {
+ useWorkflowSendEmail = true;
+ }
+ }
+
+ if (commandLine.hasOption('v')) {
+ isTest = true;
+ handler.logInfo("**Test Run** - not actually importing items.");
+ }
+
+ isExcludeContent = commandLine.hasOption('x');
+
+ if (commandLine.hasOption('p')) {
+ template = true;
+ }
+
+ if (commandLine.hasOption('c')) { // collections
+ collections = commandLine.getOptionValues('c');
+ commandLineCollections = true;
+ } else {
+ handler.logInfo("No collections given. Assuming 'collections' file inside item directory");
+ }
+
+ if (commandLine.hasOption('R')) {
+ isResume = true;
+ handler.logInfo("**Resume import** - attempting to import items not already imported");
+ }
+
+ if (commandLine.hasOption('q')) {
+ isQuiet = true;
+ }
+
+ setZip();
+ }
+
+ @Override
+ public void internalRun() throws Exception {
+ if (help) {
+ printHelp();
+ return;
+ }
+
+ Date startTime = new Date();
+ Context context = new Context(Context.Mode.BATCH_EDIT);
+
+ setMapFile();
+
+ validate(context);
+
+ setEPerson(context);
+
+ // check collection
+ List mycollections = null;
+ // don't need to validate collections set if command is "delete"
+ // also if no collections are given in the command line
+ if (!"delete".equals(command) && commandLineCollections) {
+ handler.logInfo("Destination collections:");
+
+ mycollections = new ArrayList<>();
+
+ // validate each collection arg to see if it's a real collection
+ for (int i = 0; i < collections.length; i++) {
+ Collection collection = null;
+ if (collections[i] != null) {
+ // is the ID a handle?
+ if (collections[i].indexOf('/') != -1) {
+ // string has a / so it must be a handle - try and resolve
+ // it
+ collection = ((Collection) handleService
+ .resolveToObject(context, collections[i]));
+ } else {
+ // not a handle, try and treat it as an integer collection database ID
+ collection = collectionService.find(context, UUID.fromString(collections[i]));
+ }
+ }
+
+ // was the collection valid?
+ if (collection == null
+ || collection.getType() != Constants.COLLECTION) {
+ throw new IllegalArgumentException("Cannot resolve "
+ + collections[i] + " to collection");
+ }
+
+ // add resolved collection to list
+ mycollections.add(collection);
+
+ // print progress info
+ handler.logInfo((i == 0 ? "Owning " : "") + "Collection: " + collection.getName());
+ }
+ }
+ // end validation
+
+ // start
+ ItemImportService itemImportService = ItemImportServiceFactory.getInstance()
+ .getItemImportService();
+ try {
+ itemImportService.setTest(isTest);
+ itemImportService.setExcludeContent(isExcludeContent);
+ itemImportService.setResume(isResume);
+ itemImportService.setUseWorkflow(useWorkflow);
+ itemImportService.setUseWorkflowSendEmail(useWorkflowSendEmail);
+ itemImportService.setQuiet(isQuiet);
+ itemImportService.setHandler(handler);
+
+ try {
+ context.turnOffAuthorisationSystem();
+
+ readZip(context, itemImportService);
+
+ process(context, itemImportService, mycollections);
+
+ // complete all transactions
+ context.complete();
+ } catch (Exception e) {
+ context.abort();
+ throw new Exception(
+ "Error committing changes to database: " + e.getMessage() + ", aborting most recent changes", e);
+ }
+
+ if (isTest) {
+ handler.logInfo("***End of Test Run***");
+ }
+ } finally {
+ if (zip) {
+ // if zip file was valid then clean sourcedir
+ if (zipvalid && sourcedir != null && new File(sourcedir).exists()) {
+ FileUtils.deleteDirectory(new File(sourcedir));
+ }
+
+ // clean workdir
+ if (workDir != null && workDir.exists()) {
+ FileUtils.deleteDirectory(workDir);
+ }
+
+ // conditionally clean workFile if import was done in the UI or via a URL and it still exists
+ if (workFile != null && workFile.exists()) {
+ workFile.delete();
+ }
+ }
+
+ Date endTime = new Date();
+ handler.logInfo("Started: " + startTime.getTime());
+ handler.logInfo("Ended: " + endTime.getTime());
+ handler.logInfo(
+ "Elapsed time: " + ((endTime.getTime() - startTime.getTime()) / 1000) + " secs (" + (endTime
+ .getTime() - startTime.getTime()) + " msecs)");
+ }
+ }
+
+ /**
+ * Validate the options
+ * @param context
+ */
+ protected void validate(Context context) {
+ // check zip type: uploaded file or remote url
+ if (commandLine.hasOption('z')) {
+ zipfilename = commandLine.getOptionValue('z');
+ } else if (commandLine.hasOption('u')) {
+ remoteUrl = true;
+ zipfilename = commandLine.getOptionValue('u');
+ }
+ if (StringUtils.isBlank(zipfilename)) {
+ throw new UnsupportedOperationException("Must run with either name of zip file or url of zip file");
+ }
+
+ if (command == null) {
+ handler.logError("Must run with either add, replace, or remove (run with -h flag for details)");
+ throw new UnsupportedOperationException("Must run with either add, replace, or remove");
+ }
+
+ // can only resume for adds
+ if (isResume && !"add".equals(command)) {
+ handler.logError("Resume option only works with the --add command (run with -h flag for details)");
+ throw new UnsupportedOperationException("Resume option only works with the --add command");
+ }
+
+ if (isResume && StringUtils.isBlank(mapfile)) {
+ handler.logError("The mapfile does not exist. ");
+ throw new UnsupportedOperationException("The mapfile does not exist");
+ }
+ }
+
+ /**
+ * Process the import
+ * @param context
+ * @param itemImportService
+ * @param collections
+ * @throws Exception
+ */
+ protected void process(Context context, ItemImportService itemImportService,
+ List collections) throws Exception {
+ readMapfile(context);
+
+ if ("add".equals(command)) {
+ itemImportService.addItems(context, collections, sourcedir, mapfile, template);
+ } else if ("replace".equals(command)) {
+ itemImportService.replaceItems(context, collections, sourcedir, mapfile, template);
+ } else if ("delete".equals(command)) {
+ itemImportService.deleteItems(context, mapfile);
+ }
+
+ // write input stream on handler
+ File mapFile = new File(mapfile);
+ try (InputStream mapfileInputStream = new FileInputStream(mapFile)) {
+ handler.writeFilestream(context, MAPFILE_FILENAME, mapfileInputStream, MAPFILE_BITSTREAM_TYPE);
+ } finally {
+ mapFile.delete();
+ }
+ }
+
+ /**
+ * Read the ZIP archive in SAF format
+ * @param context
+ * @param itemImportService
+ * @throws Exception
+ */
+ protected void readZip(Context context, ItemImportService itemImportService) throws Exception {
+ Optional optionalFileStream = Optional.empty();
+ Optional validationFileStream = Optional.empty();
+ if (!remoteUrl) {
+ // manage zip via upload
+ optionalFileStream = handler.getFileStream(context, zipfilename);
+ validationFileStream = handler.getFileStream(context, zipfilename);
+ } else {
+ // manage zip via remote url
+ optionalFileStream = Optional.ofNullable(new URL(zipfilename).openStream());
+ validationFileStream = Optional.ofNullable(new URL(zipfilename).openStream());
+ }
+
+ if (validationFileStream.isPresent()) {
+ // validate zip file
+ if (validationFileStream.isPresent()) {
+ validateZip(validationFileStream.get());
+ }
+
+ workFile = new File(itemImportService.getTempWorkDir() + File.separator
+ + zipfilename + "-" + context.getCurrentUser().getID());
+ FileUtils.copyInputStreamToFile(optionalFileStream.get(), workFile);
+ } else {
+ throw new IllegalArgumentException(
+ "Error reading file, the file couldn't be found for filename: " + zipfilename);
+ }
+
+ workDir = new File(itemImportService.getTempWorkDir() + File.separator + TEMP_DIR
+ + File.separator + context.getCurrentUser().getID());
+ sourcedir = itemImportService.unzip(workFile, workDir.getAbsolutePath());
+ }
+
+ /**
+ * Confirm that the zip file has the correct MIME type
+ * @param inputStream
+ */
+ protected void validateZip(InputStream inputStream) {
+ Tika tika = new Tika();
+ try {
+ String mimeType = tika.detect(inputStream);
+ if (mimeType.equals("application/zip")) {
+ zipvalid = true;
+ } else {
+ handler.logError("A valid zip file must be supplied. The provided file has mimetype: " + mimeType);
+ throw new UnsupportedOperationException("A valid zip file must be supplied");
+ }
+ } catch (IOException e) {
+ throw new IllegalArgumentException(
+ "There was an error while reading the zip file: " + zipfilename);
+ }
+ }
+
+ /**
+ * Read the mapfile
+ * @param context
+ */
+ protected void readMapfile(Context context) {
+ if (isResume) {
+ try {
+ Optional optionalFileStream = handler.getFileStream(context, mapfile);
+ if (optionalFileStream.isPresent()) {
+ File tempFile = File.createTempFile(mapfile, "temp");
+ tempFile.deleteOnExit();
+ FileUtils.copyInputStreamToFile(optionalFileStream.get(), tempFile);
+ mapfile = tempFile.getAbsolutePath();
+ }
+ } catch (IOException | AuthorizeException e) {
+ throw new UnsupportedOperationException("The mapfile does not exist");
+ }
+ }
+ }
+
+ /**
+ * Set the mapfile option
+ * @throws IOException
+ */
+ protected void setMapFile() throws IOException {
+ if (isResume && commandLine.hasOption('m')) {
+ mapfile = commandLine.getOptionValue('m');
+ } else {
+ mapfile = Files.createTempFile(MAPFILE_FILENAME, "temp").toString();
+ }
+ }
+
+ /**
+ * Set the zip option
+ */
+ protected void setZip() {
+ zip = true;
+ }
+
+ /**
+ * Set the eperson in the context
+ * @param context
+ * @throws SQLException
+ */
+ protected void setEPerson(Context context) throws SQLException {
+ EPerson myEPerson = epersonService.find(context, this.getEpersonIdentifier());
+
+ // check eperson
+ if (myEPerson == null) {
+ handler.logError("EPerson cannot be found: " + this.getEpersonIdentifier());
+ throw new UnsupportedOperationException("EPerson cannot be found: " + this.getEpersonIdentifier());
+ }
+
+ context.setCurrentUser(myEPerson);
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLI.java b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLI.java
new file mode 100644
index 000000000000..98d2469b7155
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLI.java
@@ -0,0 +1,187 @@
+/**
+ * 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.itemimport;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.net.URL;
+import java.sql.SQLException;
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+
+import org.apache.commons.io.FileUtils;
+import org.apache.commons.lang3.StringUtils;
+import org.dspace.app.itemimport.service.ItemImportService;
+import org.dspace.content.Collection;
+import org.dspace.core.Context;
+import org.dspace.eperson.EPerson;
+
+/**
+ * CLI variant for the {@link ItemImport} class.
+ * This was done to specify the specific behaviors for the CLI.
+ *
+ * @author Francesco Pio Scognamiglio (francescopio.scognamiglio at 4science.com)
+ */
+public class ItemImportCLI extends ItemImport {
+
+ @Override
+ protected void validate(Context context) {
+ // can only resume for adds
+ if (isResume && !"add".equals(command)) {
+ handler.logError("Resume option only works with the --add command (run with -h flag for details)");
+ throw new UnsupportedOperationException("Resume option only works with the --add command");
+ }
+
+ if (commandLine.hasOption('e')) {
+ eperson = commandLine.getOptionValue('e');
+ }
+
+ // check eperson identifier (email or id)
+ if (eperson == null) {
+ handler.logError("An eperson to do the importing must be specified (run with -h flag for details)");
+ throw new UnsupportedOperationException("An eperson to do the importing must be specified");
+ }
+
+ File myFile = null;
+ try {
+ myFile = new File(mapfile);
+ } catch (Exception e) {
+ throw new UnsupportedOperationException("The mapfile " + mapfile + " does not exist");
+ }
+
+ if (!isResume && "add".equals(command) && myFile.exists()) {
+ handler.logError("The mapfile " + mapfile + " already exists. "
+ + "Either delete it or use --resume if attempting to resume an aborted import. "
+ + "(run with -h flag for details)");
+ throw new UnsupportedOperationException("The mapfile " + mapfile + " already exists");
+ }
+
+ if (command == null) {
+ handler.logError("Must run with either add, replace, or remove (run with -h flag for details)");
+ throw new UnsupportedOperationException("Must run with either add, replace, or remove");
+ } else if ("add".equals(command) || "replace".equals(command)) {
+ if (!remoteUrl && sourcedir == null) {
+ handler.logError("A source directory containing items must be set (run with -h flag for details)");
+ throw new UnsupportedOperationException("A source directory containing items must be set");
+ }
+
+ if (mapfile == null) {
+ handler.logError(
+ "A map file to hold importing results must be specified (run with -h flag for details)");
+ throw new UnsupportedOperationException("A map file to hold importing results must be specified");
+ }
+ } else if ("delete".equals(command)) {
+ if (mapfile == null) {
+ handler.logError("A map file must be specified (run with -h flag for details)");
+ throw new UnsupportedOperationException("A map file must be specified");
+ }
+ }
+ }
+
+ @Override
+ protected void process(Context context, ItemImportService itemImportService,
+ List collections) throws Exception {
+ if ("add".equals(command)) {
+ itemImportService.addItems(context, collections, sourcedir, mapfile, template);
+ } else if ("replace".equals(command)) {
+ itemImportService.replaceItems(context, collections, sourcedir, mapfile, template);
+ } else if ("delete".equals(command)) {
+ itemImportService.deleteItems(context, mapfile);
+ }
+ }
+
+ @Override
+ protected void readZip(Context context, ItemImportService itemImportService) throws Exception {
+ // If this is a zip archive, unzip it first
+ if (zip) {
+ if (!remoteUrl) {
+ // confirm zip file exists
+ File myZipFile = new File(sourcedir + File.separator + zipfilename);
+ if ((!myZipFile.exists()) || (!myZipFile.isFile())) {
+ throw new IllegalArgumentException(
+ "Error reading file, the file couldn't be found for filename: " + zipfilename);
+ }
+
+ // validate zip file
+ InputStream validationFileStream = new FileInputStream(myZipFile);
+ validateZip(validationFileStream);
+
+ workDir = new File(itemImportService.getTempWorkDir() + File.separator + TEMP_DIR
+ + File.separator + context.getCurrentUser().getID());
+ sourcedir = itemImportService.unzip(
+ new File(sourcedir + File.separator + zipfilename), workDir.getAbsolutePath());
+ } else {
+ // manage zip via remote url
+ Optional optionalFileStream = Optional.ofNullable(new URL(zipfilename).openStream());
+ if (optionalFileStream.isPresent()) {
+ // validate zip file via url
+ Optional validationFileStream = Optional.ofNullable(new URL(zipfilename).openStream());
+ if (validationFileStream.isPresent()) {
+ validateZip(validationFileStream.get());
+ }
+
+ workFile = new File(itemImportService.getTempWorkDir() + File.separator
+ + zipfilename + "-" + context.getCurrentUser().getID());
+ FileUtils.copyInputStreamToFile(optionalFileStream.get(), workFile);
+ workDir = new File(itemImportService.getTempWorkDir() + File.separator + TEMP_DIR
+ + File.separator + context.getCurrentUser().getID());
+ sourcedir = itemImportService.unzip(workFile, workDir.getAbsolutePath());
+ } else {
+ throw new IllegalArgumentException(
+ "Error reading file, the file couldn't be found for filename: " + zipfilename);
+ }
+ }
+ }
+ }
+
+ @Override
+ protected void setMapFile() {
+ if (commandLine.hasOption('m')) {
+ mapfile = commandLine.getOptionValue('m');
+ }
+ }
+
+ @Override
+ protected void setZip() {
+ if (commandLine.hasOption('s')) { // source
+ sourcedir = commandLine.getOptionValue('s');
+ }
+
+ if (commandLine.hasOption('z')) {
+ zip = true;
+ zipfilename = commandLine.getOptionValue('z');
+ }
+
+ if (commandLine.hasOption('u')) { // remote url
+ zip = true;
+ remoteUrl = true;
+ zipfilename = commandLine.getOptionValue('u');
+ }
+ }
+
+ @Override
+ protected void setEPerson(Context context) throws SQLException {
+ EPerson myEPerson = null;
+ if (StringUtils.contains(eperson, '@')) {
+ // @ sign, must be an email
+ myEPerson = epersonService.findByEmail(context, eperson);
+ } else {
+ myEPerson = epersonService.find(context, UUID.fromString(eperson));
+ }
+
+ // check eperson
+ if (myEPerson == null) {
+ handler.logError("EPerson cannot be found: " + eperson + " (run with -h flag for details)");
+ throw new UnsupportedOperationException("EPerson cannot be found: " + eperson);
+ }
+
+ context.setCurrentUser(myEPerson);
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLIScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLIScriptConfiguration.java
new file mode 100644
index 000000000000..89abd7155b39
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLIScriptConfiguration.java
@@ -0,0 +1,80 @@
+/**
+ * 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.itemimport;
+
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link ItemImportCLI} script
+ *
+ * @author Francesco Pio Scognamiglio (francescopio.scognamiglio at 4science.com)
+ */
+public class ItemImportCLIScriptConfiguration extends ItemImportScriptConfiguration {
+
+ @Override
+ public Options getOptions() {
+ Options options = new Options();
+
+ options.addOption(Option.builder("a").longOpt("add")
+ .desc("add items to DSpace")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("r").longOpt("replace")
+ .desc("replace items in mapfile")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("d").longOpt("delete")
+ .desc("delete items listed in mapfile")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("s").longOpt("source")
+ .desc("source of items (directory)")
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("z").longOpt("zip")
+ .desc("name of zip file")
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("u").longOpt("url")
+ .desc("url of zip file")
+ .hasArg().build());
+ options.addOption(Option.builder("c").longOpt("collection")
+ .desc("destination collection(s) Handle or database ID")
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("m").longOpt("mapfile")
+ .desc("mapfile items in mapfile")
+ .hasArg().required().build());
+ options.addOption(Option.builder("e").longOpt("eperson")
+ .desc("email of eperson doing importing")
+ .hasArg().required().build());
+ options.addOption(Option.builder("w").longOpt("workflow")
+ .desc("send submission through collection's workflow")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("n").longOpt("notify")
+ .desc("if sending submissions through the workflow, send notification emails")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("v").longOpt("validate")
+ .desc("test run - do not actually import items")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("x").longOpt("exclude-bitstreams")
+ .desc("do not load or expect content bitstreams")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("p").longOpt("template")
+ .desc("apply template")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("R").longOpt("resume")
+ .desc("resume a failed import (add only)")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("q").longOpt("quiet")
+ .desc("don't display metadata")
+ .hasArg(false).required(false).build());
+
+ options.addOption(Option.builder("h").longOpt("help")
+ .desc("help")
+ .hasArg(false).required(false).build());
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLITool.java b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLITool.java
deleted file mode 100644
index 7cad97df3171..000000000000
--- a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportCLITool.java
+++ /dev/null
@@ -1,429 +0,0 @@
-/**
- * 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.itemimport;
-
-import java.io.File;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Date;
-import java.util.List;
-import java.util.UUID;
-
-import org.apache.commons.cli.CommandLine;
-import org.apache.commons.cli.CommandLineParser;
-import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.HelpFormatter;
-import org.apache.commons.cli.Options;
-import org.dspace.app.itemimport.factory.ItemImportServiceFactory;
-import org.dspace.app.itemimport.service.ItemImportService;
-import org.dspace.content.Collection;
-import org.dspace.content.factory.ContentServiceFactory;
-import org.dspace.content.service.CollectionService;
-import org.dspace.core.Constants;
-import org.dspace.core.Context;
-import org.dspace.eperson.EPerson;
-import org.dspace.eperson.factory.EPersonServiceFactory;
-import org.dspace.eperson.service.EPersonService;
-import org.dspace.handle.factory.HandleServiceFactory;
-import org.dspace.handle.service.HandleService;
-
-/**
- * Import items into DSpace. The conventional use is upload files by copying
- * them. DSpace writes the item's bitstreams into its assetstore. Metadata is
- * also loaded to the DSpace database.
- *
- * A second use assumes the bitstream files already exist in a storage
- * resource accessible to DSpace. In this case the bitstreams are 'registered'.
- * That is, the metadata is loaded to the DSpace database and DSpace is given
- * the location of the file which is subsumed into DSpace.
- *
- * The distinction is controlled by the format of lines in the 'contents' file.
- * See comments in processContentsFile() below.
- *
- * Modified by David Little, UCSD Libraries 12/21/04 to
- * allow the registration of files (bitstreams) into DSpace.
- */
-public class ItemImportCLITool {
-
- private static boolean template = false;
-
- private static final CollectionService collectionService = ContentServiceFactory.getInstance()
- .getCollectionService();
- private static final EPersonService epersonService = EPersonServiceFactory.getInstance().getEPersonService();
- private static final HandleService handleService = HandleServiceFactory.getInstance().getHandleService();
-
- /**
- * Default constructor
- */
- private ItemImportCLITool() { }
-
- public static void main(String[] argv) throws Exception {
- Date startTime = new Date();
- int status = 0;
-
- try {
- // create an options object and populate it
- CommandLineParser parser = new DefaultParser();
-
- Options options = new Options();
-
- options.addOption("a", "add", false, "add items to DSpace");
- options.addOption("r", "replace", false, "replace items in mapfile");
- options.addOption("d", "delete", false,
- "delete items listed in mapfile");
- options.addOption("i", "inputtype", true, "input type in case of BTE import");
- options.addOption("s", "source", true, "source of items (directory)");
- options.addOption("z", "zip", true, "name of zip file");
- options.addOption("c", "collection", true,
- "destination collection(s) Handle or database ID");
- options.addOption("m", "mapfile", true, "mapfile items in mapfile");
- options.addOption("e", "eperson", true,
- "email of eperson doing importing");
- options.addOption("w", "workflow", false,
- "send submission through collection's workflow");
- options.addOption("n", "notify", false,
- "if sending submissions through the workflow, send notification emails");
- options.addOption("t", "test", false,
- "test run - do not actually import items");
- options.addOption("p", "template", false, "apply template");
- options.addOption("R", "resume", false,
- "resume a failed import (add only)");
- options.addOption("q", "quiet", false, "don't display metadata");
-
- options.addOption("h", "help", false, "help");
-
- CommandLine line = parser.parse(options, argv);
-
- String command = null; // add replace remove, etc
- String bteInputType = null; //ris, endnote, tsv, csv, bibtex
- String sourcedir = null;
- String mapfile = null;
- String eperson = null; // db ID or email
- String[] collections = null; // db ID or handles
- boolean isTest = false;
- boolean isResume = false;
- boolean useWorkflow = false;
- boolean useWorkflowSendEmail = false;
- boolean isQuiet = false;
-
- if (line.hasOption('h')) {
- HelpFormatter myhelp = new HelpFormatter();
- myhelp.printHelp("ItemImport\n", options);
- System.out
- .println("\nadding items: ItemImport -a -e eperson -c collection -s sourcedir -m mapfile");
- System.out
- .println(
- "\nadding items from zip file: ItemImport -a -e eperson -c collection -s sourcedir -z " +
- "filename.zip -m mapfile");
- System.out
- .println("replacing items: ItemImport -r -e eperson -c collection -s sourcedir -m mapfile");
- System.out
- .println("deleting items: ItemImport -d -e eperson -m mapfile");
- System.out
- .println(
- "If multiple collections are specified, the first collection will be the one that owns the " +
- "item.");
-
- System.exit(0);
- }
-
- if (line.hasOption('a')) {
- command = "add";
- }
-
- if (line.hasOption('r')) {
- command = "replace";
- }
-
- if (line.hasOption('d')) {
- command = "delete";
- }
-
- if (line.hasOption('b')) {
- command = "add-bte";
- }
-
- if (line.hasOption('i')) {
- bteInputType = line.getOptionValue('i');
- }
-
- if (line.hasOption('w')) {
- useWorkflow = true;
- if (line.hasOption('n')) {
- useWorkflowSendEmail = true;
- }
- }
-
- if (line.hasOption('t')) {
- isTest = true;
- System.out.println("**Test Run** - not actually importing items.");
- }
-
- if (line.hasOption('p')) {
- template = true;
- }
-
- if (line.hasOption('s')) { // source
- sourcedir = line.getOptionValue('s');
- }
-
- if (line.hasOption('m')) { // mapfile
- mapfile = line.getOptionValue('m');
- }
-
- if (line.hasOption('e')) { // eperson
- eperson = line.getOptionValue('e');
- }
-
- if (line.hasOption('c')) { // collections
- collections = line.getOptionValues('c');
- }
-
- if (line.hasOption('R')) {
- isResume = true;
- System.out
- .println("**Resume import** - attempting to import items not already imported");
- }
-
- if (line.hasOption('q')) {
- isQuiet = true;
- }
-
- boolean zip = false;
- String zipfilename = "";
- if (line.hasOption('z')) {
- zip = true;
- zipfilename = line.getOptionValue('z');
- }
-
- //By default assume collections will be given on the command line
- boolean commandLineCollections = true;
- // now validate
- // must have a command set
- if (command == null) {
- System.out
- .println("Error - must run with either add, replace, or remove (run with -h flag for details)");
- System.exit(1);
- } else if ("add".equals(command) || "replace".equals(command)) {
- if (sourcedir == null) {
- System.out
- .println("Error - a source directory containing items must be set");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
- }
-
- if (mapfile == null) {
- System.out
- .println("Error - a map file to hold importing results must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
- }
-
- if (eperson == null) {
- System.out
- .println("Error - an eperson to do the importing must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
- }
-
- if (collections == null) {
- System.out.println("No collections given. Assuming 'collections' file inside item directory");
- commandLineCollections = false;
- }
- } else if ("add-bte".equals(command)) {
- //Source dir can be null, the user can specify the parameters for his loader in the Spring XML
- // configuration file
-
- if (mapfile == null) {
- System.out
- .println("Error - a map file to hold importing results must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
- }
-
- if (eperson == null) {
- System.out
- .println("Error - an eperson to do the importing must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
- }
-
- if (collections == null) {
- System.out.println("No collections given. Assuming 'collections' file inside item directory");
- commandLineCollections = false;
- }
-
- if (bteInputType == null) {
- System.out
- .println(
- "Error - an input type (tsv, csv, ris, endnote, bibtex or any other type you have " +
- "specified in BTE Spring XML configuration file) must be specified");
- System.out.println(" (run with -h flag for details)");
- System.exit(1);
- }
- } else if ("delete".equals(command)) {
- if (eperson == null) {
- System.out
- .println("Error - an eperson to do the importing must be specified");
- System.exit(1);
- }
-
- if (mapfile == null) {
- System.out.println("Error - a map file must be specified");
- System.exit(1);
- }
- }
-
- // can only resume for adds
- if (isResume && !"add".equals(command) && !"add-bte".equals(command)) {
- System.out
- .println("Error - resume option only works with the --add or the --add-bte commands");
- System.exit(1);
- }
-
- // do checks around mapfile - if mapfile exists and 'add' is selected,
- // resume must be chosen
- File myFile = new File(mapfile);
-
- if (!isResume && "add".equals(command) && myFile.exists()) {
- System.out.println("Error - the mapfile " + mapfile
- + " already exists.");
- System.out
- .println("Either delete it or use --resume if attempting to resume an aborted import.");
- System.exit(1);
- }
-
- ItemImportService myloader = ItemImportServiceFactory.getInstance().getItemImportService();
- myloader.setTest(isTest);
- myloader.setResume(isResume);
- myloader.setUseWorkflow(useWorkflow);
- myloader.setUseWorkflowSendEmail(useWorkflowSendEmail);
- myloader.setQuiet(isQuiet);
-
- // create a context
- Context c = new Context(Context.Mode.BATCH_EDIT);
-
- // find the EPerson, assign to context
- EPerson myEPerson = null;
-
- if (eperson.indexOf('@') != -1) {
- // @ sign, must be an email
- myEPerson = epersonService.findByEmail(c, eperson);
- } else {
- myEPerson = epersonService.find(c, UUID.fromString(eperson));
- }
-
- if (myEPerson == null) {
- System.out.println("Error, eperson cannot be found: " + eperson);
- System.exit(1);
- }
-
- c.setCurrentUser(myEPerson);
-
- // find collections
- List mycollections = null;
-
- // don't need to validate collections set if command is "delete"
- // also if no collections are given in the command line
- if (!"delete".equals(command) && commandLineCollections) {
- System.out.println("Destination collections:");
-
- mycollections = new ArrayList<>();
-
- // validate each collection arg to see if it's a real collection
- for (int i = 0; i < collections.length; i++) {
- // is the ID a handle?
- if (collections[i].indexOf('/') != -1) {
- // string has a / so it must be a handle - try and resolve
- // it
- mycollections.add((Collection) handleService
- .resolveToObject(c, collections[i]));
-
- // resolved, now make sure it's a collection
- if ((mycollections.get(i) == null)
- || (mycollections.get(i).getType() != Constants.COLLECTION)) {
- mycollections.set(i, null);
- }
- } else if (collections[i] != null) {
- // not a handle, try and treat it as an integer collection database ID
- mycollections.set(i, collectionService.find(c, UUID.fromString(collections[i])));
- }
-
- // was the collection valid?
- if (mycollections.get(i) == null) {
- throw new IllegalArgumentException("Cannot resolve "
- + collections[i] + " to collection");
- }
-
- // print progress info
- String owningPrefix = "";
-
- if (i == 0) {
- owningPrefix = "Owning ";
- }
-
- System.out.println(owningPrefix + " Collection: "
- + mycollections.get(i).getName());
- }
- } // end of validating collections
-
- try {
- // If this is a zip archive, unzip it first
- if (zip) {
- sourcedir = myloader.unzip(sourcedir, zipfilename);
- }
-
-
- c.turnOffAuthorisationSystem();
-
- if ("add".equals(command)) {
- myloader.addItems(c, mycollections, sourcedir, mapfile, template);
- } else if ("replace".equals(command)) {
- myloader.replaceItems(c, mycollections, sourcedir, mapfile, template);
- } else if ("delete".equals(command)) {
- myloader.deleteItems(c, mapfile);
- }
-
- // complete all transactions
- c.complete();
- } catch (Exception e) {
- c.abort();
- e.printStackTrace();
- System.out.println(e);
- status = 1;
- }
-
- // Delete the unzipped file
- try {
- if (zip) {
- System.gc();
- System.out.println(
- "Deleting temporary zip directory: " + myloader.getTempWorkDirFile().getAbsolutePath());
- myloader.cleanupZipTemp();
- }
- } catch (IOException ex) {
- System.out.println("Unable to delete temporary zip archive location: " + myloader.getTempWorkDirFile()
- .getAbsolutePath());
- }
-
-
- if (isTest) {
- System.out.println("***End of Test Run***");
- }
- } finally {
- Date endTime = new Date();
- System.out.println("Started: " + startTime.getTime());
- System.out.println("Ended: " + endTime.getTime());
- System.out.println(
- "Elapsed time: " + ((endTime.getTime() - startTime.getTime()) / 1000) + " secs (" + (endTime
- .getTime() - startTime.getTime()) + " msecs)");
- }
-
- System.exit(status);
- }
-}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportScriptConfiguration.java
new file mode 100644
index 000000000000..3f2675ea58f1
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportScriptConfiguration.java
@@ -0,0 +1,90 @@
+/**
+ * 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.itemimport;
+
+import java.io.InputStream;
+
+import org.apache.commons.cli.Option;
+import org.apache.commons.cli.Options;
+import org.dspace.scripts.configuration.ScriptConfiguration;
+
+/**
+ * The {@link ScriptConfiguration} for the {@link ItemImport} script
+ *
+ * @author Francesco Pio Scognamiglio (francescopio.scognamiglio at 4science.com)
+ */
+public class ItemImportScriptConfiguration extends ScriptConfiguration {
+
+ private Class dspaceRunnableClass;
+
+ @Override
+ public Class getDspaceRunnableClass() {
+ return dspaceRunnableClass;
+ }
+
+ @Override
+ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
+ this.dspaceRunnableClass = dspaceRunnableClass;
+ }
+
+ @Override
+ public Options getOptions() {
+ Options options = new Options();
+
+ options.addOption(Option.builder("a").longOpt("add")
+ .desc("add items to DSpace")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("r").longOpt("replace")
+ .desc("replace items in mapfile")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("d").longOpt("delete")
+ .desc("delete items listed in mapfile")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("z").longOpt("zip")
+ .desc("name of zip file")
+ .type(InputStream.class)
+ .hasArg().build());
+ options.addOption(Option.builder("u").longOpt("url")
+ .desc("url of zip file")
+ .hasArg().build());
+ options.addOption(Option.builder("c").longOpt("collection")
+ .desc("destination collection(s) Handle or database ID")
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("m").longOpt("mapfile")
+ .desc("mapfile items in mapfile")
+ .type(InputStream.class)
+ .hasArg().required(false).build());
+ options.addOption(Option.builder("w").longOpt("workflow")
+ .desc("send submission through collection's workflow")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("n").longOpt("notify")
+ .desc("if sending submissions through the workflow, send notification emails")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("v").longOpt("validate")
+ .desc("test run - do not actually import items")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("x").longOpt("exclude-bitstreams")
+ .desc("do not load or expect content bitstreams")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("p").longOpt("template")
+ .desc("apply template")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("R").longOpt("resume")
+ .desc("resume a failed import (add only)")
+ .hasArg(false).required(false).build());
+ options.addOption(Option.builder("q").longOpt("quiet")
+ .desc("don't display metadata")
+ .hasArg(false).required(false).build());
+
+ options.addOption(Option.builder("h").longOpt("help")
+ .desc("help")
+ .hasArg(false).required(false).build());
+
+ return options;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportServiceImpl.java b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportServiceImpl.java
index c89b2d07238e..255f4bdcbb15 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportServiceImpl.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemimport/ItemImportServiceImpl.java
@@ -7,6 +7,13 @@
*/
package org.dspace.app.itemimport;
+import static org.dspace.iiif.util.IIIFSharedUtils.METADATA_IIIF_HEIGHT_QUALIFIER;
+import static org.dspace.iiif.util.IIIFSharedUtils.METADATA_IIIF_IMAGE_ELEMENT;
+import static org.dspace.iiif.util.IIIFSharedUtils.METADATA_IIIF_LABEL_ELEMENT;
+import static org.dspace.iiif.util.IIIFSharedUtils.METADATA_IIIF_SCHEMA;
+import static org.dspace.iiif.util.IIIFSharedUtils.METADATA_IIIF_TOC_ELEMENT;
+import static org.dspace.iiif.util.IIIFSharedUtils.METADATA_IIIF_WIDTH_QUALIFIER;
+
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.BufferedReader;
@@ -44,6 +51,10 @@
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.transform.TransformerException;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
import org.apache.commons.collections4.ComparatorUtils;
import org.apache.commons.io.FileDeleteStrategy;
@@ -51,10 +62,11 @@
import org.apache.commons.lang3.RandomStringUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.exception.ExceptionUtils;
+import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
-import org.apache.xpath.XPathAPI;
import org.dspace.app.itemimport.service.ItemImportService;
import org.dspace.app.util.LocalSchemaFilenameFilter;
+import org.dspace.app.util.RelationshipUtils;
import org.dspace.authorize.AuthorizeException;
import org.dspace.authorize.ResourcePolicy;
import org.dspace.authorize.service.AuthorizeService;
@@ -68,6 +80,9 @@
import org.dspace.content.MetadataField;
import org.dspace.content.MetadataSchema;
import org.dspace.content.MetadataSchemaEnum;
+import org.dspace.content.MetadataValue;
+import org.dspace.content.Relationship;
+import org.dspace.content.RelationshipType;
import org.dspace.content.WorkspaceItem;
import org.dspace.content.service.BitstreamFormatService;
import org.dspace.content.service.BitstreamService;
@@ -77,17 +92,21 @@
import org.dspace.content.service.ItemService;
import org.dspace.content.service.MetadataFieldService;
import org.dspace.content.service.MetadataSchemaService;
+import org.dspace.content.service.MetadataValueService;
+import org.dspace.content.service.RelationshipService;
+import org.dspace.content.service.RelationshipTypeService;
import org.dspace.content.service.WorkspaceItemService;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.core.Email;
import org.dspace.core.I18nUtil;
-import org.dspace.core.LogManager;
+import org.dspace.core.LogHelper;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.Group;
import org.dspace.eperson.service.EPersonService;
import org.dspace.eperson.service.GroupService;
import org.dspace.handle.service.HandleService;
+import org.dspace.scripts.handler.DSpaceRunnableHandler;
import org.dspace.services.ConfigurationService;
import org.dspace.workflow.WorkflowItem;
import org.dspace.workflow.WorkflowService;
@@ -117,7 +136,9 @@
* allow the registration of files (bitstreams) into DSpace.
*/
public class ItemImportServiceImpl implements ItemImportService, InitializingBean {
- private final Logger log = org.apache.logging.log4j.LogManager.getLogger(ItemImportServiceImpl.class);
+ private final Logger log = LogManager.getLogger();
+
+ private DSpaceRunnableHandler handler;
@Autowired(required = true)
protected AuthorizeService authorizeService;
@@ -151,15 +172,25 @@ public class ItemImportServiceImpl implements ItemImportService, InitializingBea
protected WorkflowService workflowService;
@Autowired(required = true)
protected ConfigurationService configurationService;
+ @Autowired(required = true)
+ protected RelationshipService relationshipService;
+ @Autowired(required = true)
+ protected RelationshipTypeService relationshipTypeService;
+ @Autowired(required = true)
+ protected MetadataValueService metadataValueService;
protected String tempWorkDir;
protected boolean isTest = false;
+ protected boolean isExcludeContent = false;
protected boolean isResume = false;
protected boolean useWorkflow = false;
protected boolean useWorkflowSendEmail = false;
protected boolean isQuiet = false;
+ //remember which folder item was imported from
+ Map itemFolderMap = null;
+
@Override
public void afterPropertiesSet() throws Exception {
tempWorkDir = configurationService.getProperty("org.dspace.app.batchitemimport.work.dir");
@@ -168,11 +199,13 @@ public void afterPropertiesSet() throws Exception {
if (!tempWorkDirFile.exists()) {
boolean success = tempWorkDirFile.mkdir();
if (success) {
- log.info("Created org.dspace.app.batchitemimport.work.dir of: " + tempWorkDir);
+ logInfo("Created org.dspace.app.batchitemimport.work.dir of: " + tempWorkDir);
} else {
- log.error("Cannot create batch import directory! " + tempWorkDir);
+ logError("Cannot create batch import directory! " + tempWorkDir);
}
}
+ // clean work dir path from duplicate separators
+ tempWorkDir = StringUtils.replace(tempWorkDir, File.separator + File.separator, File.separator);
}
// File listing filter to look for metadata files
@@ -198,9 +231,9 @@ public void addItemsAtomic(Context c, List mycollections, String sou
try {
addItems(c, mycollections, sourceDir, mapFile, template);
} catch (Exception addException) {
- log.error("AddItems encountered an error, will try to revert. Error: " + addException.getMessage());
+ logError("AddItems encountered an error, will try to revert. Error: " + addException.getMessage());
deleteItems(c, mapFile);
- log.info("Attempted to delete partial (errored) import");
+ logInfo("Attempted to delete partial (errored) import");
throw addException;
}
}
@@ -211,14 +244,15 @@ public void addItems(Context c, List mycollections,
// create the mapfile
File outFile = null;
PrintWriter mapOut = null;
+
try {
Map skipItems = new HashMap<>(); // set of items to skip if in 'resume'
// mode
- System.out.println("Adding items from directory: " + sourceDir);
- log.debug("Adding items from directory: " + sourceDir);
- System.out.println("Generating mapfile: " + mapFile);
- log.debug("Generating mapfile: " + mapFile);
+ itemFolderMap = new HashMap<>();
+
+ logDebug("Adding items from directory: " + sourceDir);
+ logDebug("Generating mapfile: " + mapFile);
boolean directoryFileCollections = false;
if (mycollections == null) {
@@ -235,16 +269,12 @@ public void addItems(Context c, List mycollections,
// sneaky isResume == true means open file in append mode
outFile = new File(mapFile);
mapOut = new PrintWriter(new FileWriter(outFile, isResume));
-
- if (mapOut == null) {
- throw new Exception("can't open mapfile: " + mapFile);
- }
}
// open and process the source directory
File d = new java.io.File(sourceDir);
- if (d == null || !d.isDirectory()) {
+ if (!d.isDirectory()) {
throw new Exception("Error, cannot open source directory " + sourceDir);
}
@@ -254,7 +284,13 @@ public void addItems(Context c, List mycollections,
for (int i = 0; i < dircontents.length; i++) {
if (skipItems.containsKey(dircontents[i])) {
- System.out.println("Skipping import of " + dircontents[i]);
+ logInfo("Skipping import of " + dircontents[i]);
+
+ //we still need the item in the map for relationship linking
+ String skippedHandle = skipItems.get(dircontents[i]);
+ Item skippedItem = (Item) handleService.resolveToObject(c, skippedHandle);
+ itemFolderMap.put(dircontents[i], skippedItem);
+
} else {
List clist;
if (directoryFileCollections) {
@@ -262,24 +298,30 @@ public void addItems(Context c, List mycollections,
try {
List cols = processCollectionFile(c, path, "collections");
if (cols == null) {
- System.out
- .println("No collections specified for item " + dircontents[i] + ". Skipping.");
+ logError("No collections specified for item " + dircontents[i] + ". Skipping.");
continue;
}
clist = cols;
} catch (IllegalArgumentException e) {
- System.out.println(e.getMessage() + " Skipping.");
+ logError(e.getMessage() + " Skipping.");
continue;
}
} else {
clist = mycollections;
}
+
Item item = addItem(c, clist, sourceDir, dircontents[i], mapOut, template);
+
+ itemFolderMap.put(dircontents[i], item);
+
c.uncacheEntity(item);
- System.out.println(i + " " + dircontents[i]);
+ logInfo(i + " " + dircontents[i]);
}
}
+ //now that all items are imported, iterate again to link relationships
+ addRelationships(c, sourceDir);
+
} finally {
if (mapOut != null) {
mapOut.flush();
@@ -288,13 +330,315 @@ public void addItems(Context c, List mycollections,
}
}
+ /**
+ * Add relationships from a 'relationships' manifest file.
+ *
+ * @param c Context
+ * @param sourceDir The parent import source directory
+ * @throws Exception
+ */
+ protected void addRelationships(Context c, String sourceDir) throws Exception {
+
+ for (Map.Entry itemEntry : itemFolderMap.entrySet()) {
+
+ String folderName = itemEntry.getKey();
+ String path = sourceDir + File.separatorChar + folderName;
+ Item item = itemEntry.getValue();
+
+ //look for a 'relationship' manifest
+ Map> relationships = processRelationshipFile(path, "relationships");
+ if (!relationships.isEmpty()) {
+
+ for (Map.Entry> relEntry : relationships.entrySet()) {
+
+ String relationshipType = relEntry.getKey();
+ List identifierList = relEntry.getValue();
+
+ for (String itemIdentifier : identifierList) {
+
+ if (isTest) {
+ logInfo("\tAdding relationship (type: " + relationshipType +
+ ") from " + folderName + " to " + itemIdentifier);
+ continue;
+ }
+
+ //find referenced item
+ Item relationItem = resolveRelatedItem(c, itemIdentifier);
+ if (null == relationItem) {
+ throw new Exception("Could not find item for " + itemIdentifier);
+ }
+
+ addRelationship(c, item, relationItem, relationshipType);
+ }
+
+ }
+
+ }
+
+ }
+
+ }
+
+ /**
+ * Add relationship.
+ * @param c the context
+ * @param item the item
+ * @param relationItem the related item
+ * @param relationshipType the relation type name
+ * @throws SQLException
+ * @throws AuthorizeException
+ */
+ protected void addRelationship(Context c, Item item, Item relationItem, String relationshipType)
+ throws SQLException, AuthorizeException {
+ // get entity type of entity and item
+ String itemEntityType = getEntityType(item);
+ String relatedEntityType = getEntityType(relationItem);
+
+ // find matching relationship type
+ List relTypes = relationshipTypeService.findByLeftwardOrRightwardTypeName(
+ c, relationshipType);
+ RelationshipType foundRelationshipType = RelationshipUtils.matchRelationshipType(
+ relTypes, relatedEntityType, itemEntityType, relationshipType);
+
+ if (foundRelationshipType == null) {
+ throw new IllegalArgumentException("No Relationship type found for:\n" +
+ "Target type: " + relatedEntityType + "\n" +
+ "Origin referer type: " + itemEntityType + "\n" +
+ "with typeName: " + relationshipType
+ );
+ }
+
+ boolean left = false;
+ if (foundRelationshipType.getLeftwardType().equalsIgnoreCase(relationshipType)) {
+ left = true;
+ }
+
+ // placeholder items for relation placing
+ Item leftItem = null;
+ Item rightItem = null;
+ if (left) {
+ leftItem = item;
+ rightItem = relationItem;
+ } else {
+ leftItem = relationItem;
+ rightItem = item;
+ }
+
+ // Create the relationship, appending to the end
+ Relationship persistedRelationship = relationshipService.create(
+ c, leftItem, rightItem, foundRelationshipType, -1, -1
+ );
+ relationshipService.update(c, persistedRelationship);
+
+ logInfo("\tAdded relationship (type: " + relationshipType + ") from " +
+ leftItem.getHandle() + " to " + rightItem.getHandle());
+ }
+
+ /**
+ * Get the item's entity type from meta.
+ *
+ * @param item
+ * @return
+ */
+ protected String getEntityType(Item item) {
+ return itemService.getMetadata(item, "dspace", "entity", "type", Item.ANY).get(0).getValue();
+ }
+
+ /**
+ * Read the relationship manifest file.
+ *
+ * Each line in the file contains a relationship type id and an item
+ * identifier in the following format:
+ *
+ *
+ * {@code relation. }
+ *
+ *
+ * The {@code input_item_folder} should refer the folder name of another
+ * item in this import batch.
+ *
+ * @param path The main import folder path.
+ * @param filename The name of the manifest file to check ('relationships')
+ * @return Map of found relationships
+ * @throws Exception
+ */
+ protected Map> processRelationshipFile(String path, String filename) throws Exception {
+
+ File file = new File(path + File.separatorChar + filename);
+ Map> result = new HashMap<>();
+
+ if (file.exists()) {
+
+ logInfo("\tProcessing relationships file: " + filename);
+
+ BufferedReader br = null;
+ try {
+ br = new BufferedReader(new FileReader(file));
+ String line = null;
+ while ((line = br.readLine()) != null) {
+ line = line.trim();
+ if ("".equals(line)) {
+ continue;
+ }
+
+ String relationshipType = null;
+ String itemIdentifier = null;
+
+ StringTokenizer st = new StringTokenizer(line);
+
+ if (st.hasMoreTokens()) {
+ relationshipType = st.nextToken();
+ if (relationshipType.split("\\.").length > 1) {
+ relationshipType = relationshipType.split("\\.")[1];
+ }
+ } else {
+ throw new Exception("Bad mapfile line:\n" + line);
+ }
+
+ if (st.hasMoreTokens()) {
+ itemIdentifier = st.nextToken("").trim();
+ } else {
+ throw new Exception("Bad mapfile line:\n" + line);
+ }
+
+ if (!result.containsKey(relationshipType)) {
+ result.put(relationshipType, new ArrayList<>());
+ }
+
+ result.get(relationshipType).add(itemIdentifier);
+
+ }
+
+ } catch (FileNotFoundException e) {
+ logWarn("\tNo relationships file found.");
+ } finally {
+ if (br != null) {
+ try {
+ br.close();
+ } catch (IOException e) {
+ logError("Non-critical problem releasing resources.");
+ }
+ }
+ }
+
+ }
+
+ return result;
+ }
+
+ /**
+ * Resolve an item identifier referred to in the relationships manifest file.
+ *
+ * The import item map will be checked first to see if the identifier refers to an item folder
+ * that was just imported. Next it will try to find the item by handle or UUID, or by a unique
+ * meta value.
+ *
+ * @param c Context
+ * @param itemIdentifier The identifier string found in the import manifest (handle, uuid, or import subfolder)
+ * @return Item if found, or null.
+ * @throws Exception
+ */
+ protected Item resolveRelatedItem(Context c, String itemIdentifier) throws Exception {
+
+ if (itemIdentifier.contains(":")) {
+
+ if (itemIdentifier.startsWith("folderName:") || itemIdentifier.startsWith("rowName:")) {
+ //identifier refers to a folder name in this import
+ int i = itemIdentifier.indexOf(":");
+ String folderName = itemIdentifier.substring(i + 1);
+ if (itemFolderMap.containsKey(folderName)) {
+ return itemFolderMap.get(folderName);
+ }
+
+ } else {
+
+ //lookup by meta value
+ int i = itemIdentifier.indexOf(":");
+ String metaKey = itemIdentifier.substring(0, i);
+ String metaValue = itemIdentifier.substring(i + 1);
+ return findItemByMetaValue(c, metaKey, metaValue);
+
+ }
+
+ }
+
+ // resolve item by handle or UUID
+ return resolveItem(c, itemIdentifier);
+
+ }
+
+ /**
+ * Resolve an item identifier.
+ *
+ * @param c Context
+ * @param itemIdentifier The identifier string found in the import file (handle or UUID)
+ * @return Item if found, or null.
+ * @throws SQLException
+ * @throws IllegalStateException
+ * @throws Exception
+ */
+ protected Item resolveItem(Context c, String itemIdentifier)
+ throws IllegalStateException, SQLException {
+ if (itemIdentifier.indexOf('/') != -1) {
+ // resolve by handle
+ return (Item) handleService.resolveToObject(c, itemIdentifier);
+ }
+
+ // resolve by UUID
+ return itemService.findByIdOrLegacyId(c, itemIdentifier);
+ }
+
+ /**
+ * Lookup an item by a (unique) meta value.
+ *
+ * @param c current DSpace session.
+ * @param metaKey name of the metadata field to match.
+ * @param metaValue value to be matched.
+ * @return the matching Item.
+ * @throws Exception if single item not found.
+ */
+ protected Item findItemByMetaValue(Context c, String metaKey, String metaValue) throws Exception {
+
+ Item item = null;
+
+ String mf[] = metaKey.split("\\.");
+ if (mf.length < 2) {
+ throw new Exception("Bad metadata field in reference: '" + metaKey +
+ "' (expected syntax is schema.element[.qualifier])");
+ }
+ String schema = mf[0];
+ String element = mf[1];
+ String qualifier = mf.length == 2 ? null : mf[2];
+ try {
+ MetadataField mfo = metadataFieldService.findByElement(c, schema, element, qualifier);
+ Iterator mdv = metadataValueService.findByFieldAndValue(c, mfo, metaValue);
+ if (mdv.hasNext()) {
+ MetadataValue mdvVal = mdv.next();
+ UUID uuid = mdvVal.getDSpaceObject().getID();
+ if (mdv.hasNext()) {
+ throw new Exception("Ambiguous reference; multiple matches in db: " + metaKey);
+ }
+ item = itemService.find(c, uuid);
+ }
+ } catch (SQLException e) {
+ throw new Exception("Error looking up item by metadata reference: " + metaKey, e);
+ }
+
+ if (item == null) {
+ throw new Exception("Item not found by metadata reference: " + metaKey);
+ }
+
+ return item;
+
+ }
+
@Override
public void replaceItems(Context c, List mycollections,
String sourceDir, String mapFile, boolean template) throws Exception {
// verify the source directory
File d = new java.io.File(sourceDir);
- if (d == null || !d.isDirectory()) {
+ if (!d.isDirectory()) {
throw new Exception("Error, cannot open source directory "
+ sourceDir);
}
@@ -312,7 +656,7 @@ public void replaceItems(Context c, List mycollections,
Item oldItem = null;
if (oldHandle.indexOf('/') != -1) {
- System.out.println("\tReplacing: " + oldHandle);
+ logInfo("\tReplacing: " + oldHandle);
// add new item, locate old one
oldItem = (Item) handleService.resolveToObject(c, oldHandle);
@@ -333,10 +677,6 @@ public void replaceItems(Context c, List mycollections,
File handleFile = new File(sourceDir + File.separatorChar + newItemName + File.separatorChar + "handle");
PrintWriter handleOut = new PrintWriter(new FileWriter(handleFile, true));
- if (handleOut == null) {
- throw new Exception("can't open handle file: " + handleFile.getCanonicalPath());
- }
-
handleOut.println(oldHandle);
handleOut.close();
@@ -349,7 +689,7 @@ public void replaceItems(Context c, List mycollections,
@Override
public void deleteItems(Context c, String mapFile) throws Exception {
- System.out.println("Deleting items listed in mapfile: " + mapFile);
+ logInfo("Deleting items listed in mapfile: " + mapFile);
// read in the mapfile
Map myhash = readMapFile(mapFile);
@@ -362,12 +702,12 @@ public void deleteItems(Context c, String mapFile) throws Exception {
if (itemID.indexOf('/') != -1) {
String myhandle = itemID;
- System.out.println("Deleting item " + myhandle);
+ logInfo("Deleting item " + myhandle);
deleteItem(c, myhandle);
} else {
// it's an ID
Item myitem = itemService.findByIdOrLegacyId(c, itemID);
- System.out.println("Deleting item " + itemID);
+ logInfo("Deleting item " + itemID);
deleteItem(c, myitem);
c.uncacheEntity(myitem);
}
@@ -390,8 +730,7 @@ protected Item addItem(Context c, List mycollections, String path,
String itemname, PrintWriter mapOut, boolean template) throws Exception {
String mapOutputString = null;
- System.out.println("Adding item from directory " + itemname);
- log.debug("adding item from directory " + itemname);
+ logDebug("adding item from directory " + itemname);
// create workspace item
Item myitem = null;
@@ -435,10 +774,14 @@ protected Item addItem(Context c, List mycollections, String path,
// put item in system
if (!isTest) {
try {
+ // Add provenance info
+ String provenance = installItemService.getSubmittedByProvenanceMessage(c, wi.getItem());
+ itemService.addMetadata(c, wi.getItem(), MetadataSchemaEnum.DC.getName(),
+ "description", "provenance", "en", provenance);
installItemService.installItem(c, wi, myhandle);
} catch (Exception e) {
workspaceItemService.deleteAll(c, wi);
- log.error("Exception after install item, try to revert...", e);
+ logError("Exception after install item, try to revert...", e);
throw e;
}
@@ -450,7 +793,7 @@ protected Item addItem(Context c, List mycollections, String path,
// set permissions if specified in contents file
if (options.size() > 0) {
- System.out.println("Processing options");
+ logInfo("Processing options");
processOptions(c, myitem, options);
}
}
@@ -501,7 +844,7 @@ protected void deleteItem(Context c, String myhandle) throws Exception {
Item myitem = (Item) handleService.resolveToObject(c, myhandle);
if (myitem == null) {
- System.out.println("Error - cannot locate item - already deleted?");
+ logError("Error - cannot locate item - already deleted?");
} else {
deleteItem(c, myitem);
c.uncacheEntity(myitem);
@@ -554,7 +897,7 @@ protected Map readMapFile(String filename) throws Exception {
// Load all metadata schemas into the item.
protected void loadMetadata(Context c, Item myitem, String path)
throws SQLException, IOException, ParserConfigurationException,
- SAXException, TransformerException, AuthorizeException {
+ SAXException, TransformerException, AuthorizeException, XPathExpressionException {
// Load the dublin core metadata
loadDublinCore(c, myitem, path + "dublin_core.xml");
@@ -568,14 +911,15 @@ protected void loadMetadata(Context c, Item myitem, String path)
protected void loadDublinCore(Context c, Item myitem, String filename)
throws SQLException, IOException, ParserConfigurationException,
- SAXException, TransformerException, AuthorizeException {
+ SAXException, TransformerException, AuthorizeException, XPathExpressionException {
Document document = loadXML(filename);
// Get the schema, for backward compatibility we will default to the
// dublin core schema if the schema name is not available in the import
// file
String schema;
- NodeList metadata = XPathAPI.selectNodeList(document, "/dublin_core");
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList metadata = (NodeList) xPath.compile("/dublin_core").evaluate(document, XPathConstants.NODESET);
Node schemaAttr = metadata.item(0).getAttributes().getNamedItem(
"schema");
if (schemaAttr == null) {
@@ -585,11 +929,10 @@ protected void loadDublinCore(Context c, Item myitem, String filename)
}
// Get the nodes corresponding to formats
- NodeList dcNodes = XPathAPI.selectNodeList(document,
- "/dublin_core/dcvalue");
+ NodeList dcNodes = (NodeList) xPath.compile("/dublin_core/dcvalue").evaluate(document, XPathConstants.NODESET);
if (!isQuiet) {
- System.out.println("\tLoading dublin core from " + filename);
+ logInfo("\tLoading dublin core from " + filename);
}
// Add each one as a new format to the registry
@@ -613,13 +956,14 @@ protected void addDCValue(Context c, Item i, String schema, Node n)
String qualifier = getAttributeValue(n, "qualifier"); //NodeValue();
// //getElementData(n,
// "qualifier");
- String language = getAttributeValue(n, "language");
- if (language != null) {
- language = language.trim();
+
+ String language = null;
+ if (StringUtils.isNotBlank(getAttributeValue(n, "language"))) {
+ language = getAttributeValue(n, "language").trim();
}
if (!isQuiet) {
- System.out.println("\tSchema: " + schema + " Element: " + element + " Qualifier: " + qualifier
+ logInfo("\tSchema: " + schema + " Element: " + element + " Qualifier: " + qualifier
+ " Value: " + value);
}
@@ -628,20 +972,28 @@ protected void addDCValue(Context c, Item i, String schema, Node n)
}
// only add metadata if it is no test and there is an actual value
if (!isTest && !value.equals("")) {
- itemService.addMetadata(c, i, schema, element, qualifier, language, value);
+ if (StringUtils.equals(schema, MetadataSchemaEnum.RELATION.getName())) {
+ Item relationItem = resolveItem(c, value);
+ if (relationItem == null) {
+ throw new IllegalArgumentException("No item found with id=" + value);
+ }
+ addRelationship(c, i, relationItem, element);
+ } else {
+ itemService.addMetadata(c, i, schema, element, qualifier, language, value);
+ }
} else {
// If we're just test the import, let's check that the actual metadata field exists.
MetadataSchema foundSchema = metadataSchemaService.find(c, schema);
if (foundSchema == null) {
- System.out.println("ERROR: schema '" + schema + "' was not found in the registry.");
+ logError("ERROR: schema '" + schema + "' was not found in the registry.");
return;
}
MetadataField foundField = metadataFieldService.findByElement(c, foundSchema, element, qualifier);
if (foundField == null) {
- System.out.println(
+ logError(
"ERROR: Metadata field: '" + schema + "." + element + "." + qualifier + "' was not found in the " +
"registry.");
return;
@@ -668,7 +1020,7 @@ protected List processCollectionFile(Context c, String path, String
File file = new File(path + File.separatorChar + filename);
ArrayList collections = new ArrayList<>();
List result = null;
- System.out.println("Processing collections file: " + filename);
+ logInfo("Processing collections file: " + filename);
if (file.exists()) {
BufferedReader br = null;
@@ -695,13 +1047,13 @@ protected List processCollectionFile(Context c, String path, String
result = collections;
} catch (FileNotFoundException e) {
- System.out.println("No collections file found.");
+ logWarn("No collections file found.");
} finally {
if (br != null) {
try {
br.close();
} catch (IOException e) {
- System.out.println("Non-critical problem releasing resources.");
+ logError("Non-critical problem releasing resources.");
}
}
}
@@ -723,7 +1075,7 @@ protected String processHandleFile(Context c, Item i, String path, String filena
File file = new File(path + File.separatorChar + filename);
String result = null;
- System.out.println("Processing handle file: " + filename);
+ logInfo("Processing handle file: " + filename);
if (file.exists()) {
BufferedReader is = null;
try {
@@ -732,14 +1084,14 @@ protected String processHandleFile(Context c, Item i, String path, String filena
// result gets contents of file, or null
result = is.readLine();
- System.out.println("read handle: '" + result + "'");
+ logInfo("read handle: '" + result + "'");
} catch (FileNotFoundException e) {
// probably no handle file, just return null
- System.out.println("It appears there is no handle file -- generating one");
+ logWarn("It appears there is no handle file -- generating one");
} catch (IOException e) {
// probably no handle file, just return null
- System.out.println("It appears there is no handle file -- generating one");
+ logWarn("It appears there is no handle file -- generating one");
} finally {
if (is != null) {
try {
@@ -751,7 +1103,7 @@ protected String processHandleFile(Context c, Item i, String path, String filena
}
} else {
// probably no handle file, just return null
- System.out.println("It appears there is no handle file -- generating one");
+ logWarn("It appears there is no handle file -- generating one");
}
return result;
@@ -778,7 +1130,7 @@ protected List processContentsFile(Context c, Item i, String path,
String line = "";
List options = new ArrayList<>();
- System.out.println("\tProcessing contents file: " + contentsFile);
+ logInfo("\tProcessing contents file: " + contentsFile);
if (contentsFile.exists()) {
BufferedReader is = null;
@@ -825,9 +1177,9 @@ protected List processContentsFile(Context c, Item i, String path,
}
} // while
if (iAssetstore == -1 || sFilePath == null) {
- System.out.println("\tERROR: invalid contents file line");
- System.out.println("\t\tSkipping line: "
- + sRegistrationLine);
+ logError("\tERROR: invalid contents file line");
+ logInfo("\t\tSkipping line: "
+ + sRegistrationLine);
continue;
}
@@ -850,10 +1202,10 @@ protected List processContentsFile(Context c, Item i, String path,
}
registerBitstream(c, i, iAssetstore, sFilePath, sBundle, sDescription);
- System.out.println("\tRegistering Bitstream: " + sFilePath
- + "\tAssetstore: " + iAssetstore
- + "\tBundle: " + sBundle
- + "\tDescription: " + sDescription);
+ logInfo("\tRegistering Bitstream: " + sFilePath
+ + "\tAssetstore: " + iAssetstore
+ + "\tBundle: " + sBundle
+ + "\tDescription: " + sDescription);
continue; // process next line in contents file
}
@@ -862,7 +1214,7 @@ protected List processContentsFile(Context c, Item i, String path,
if (bitstreamEndIndex == -1) {
// no extra info
processContentFileEntry(c, i, path, line, null, false);
- System.out.println("\tBitstream: " + line);
+ logInfo("\tBitstream: " + line);
} else {
String bitstreamName = line.substring(0, bitstreamEndIndex);
@@ -870,6 +1222,59 @@ protected List processContentsFile(Context c, Item i, String path,
boolean bundleExists = false;
boolean permissionsExist = false;
boolean descriptionExists = false;
+ boolean labelExists = false;
+ boolean heightExists = false;
+ boolean widthExists = false;
+ boolean tocExists = false;
+
+ // look for label
+ String labelMarker = "\tiiif-label";
+ int lMarkerIndex = line.indexOf(labelMarker);
+ int lEndIndex = 0;
+ if (lMarkerIndex > 0) {
+ lEndIndex = line.indexOf("\t", lMarkerIndex + 1);
+ if (lEndIndex == -1) {
+ lEndIndex = line.length();
+ }
+ labelExists = true;
+ }
+
+ // look for height
+ String heightMarker = "\tiiif-height";
+ int hMarkerIndex = line.indexOf(heightMarker);
+ int hEndIndex = 0;
+ if (hMarkerIndex > 0) {
+ hEndIndex = line.indexOf("\t", hMarkerIndex + 1);
+ if (hEndIndex == -1) {
+ hEndIndex = line.length();
+ }
+ heightExists = true;
+ }
+
+ // look for width
+ String widthMarker = "\tiiif-width";
+ int wMarkerIndex = line.indexOf(widthMarker);
+ int wEndIndex = 0;
+ if (wMarkerIndex > 0) {
+ wEndIndex = line.indexOf("\t", wMarkerIndex + 1);
+ if (wEndIndex == -1) {
+ wEndIndex = line.length();
+ }
+ widthExists = true;
+ }
+
+ // look for toc
+ String tocMarker = "\tiiif-toc";
+ int tMarkerIndex = line.indexOf(tocMarker);
+ int tEndIndex = 0;
+ if (tMarkerIndex > 0) {
+ tEndIndex = line.indexOf("\t", tMarkerIndex + 1);
+ if (tEndIndex == -1) {
+ tEndIndex = line.length();
+ }
+ tocExists = true;
+ }
+
// look for a bundle name
String bundleMarker = "\tbundle:";
@@ -918,18 +1323,20 @@ protected List processContentsFile(Context c, Item i, String path,
if (bundleExists) {
String bundleName = line.substring(bMarkerIndex
- + bundleMarker.length(), bEndIndex).trim();
+ + bundleMarker.length(), bEndIndex).trim();
processContentFileEntry(c, i, path, bitstreamName, bundleName, primary);
- System.out.println("\tBitstream: " + bitstreamName +
- "\tBundle: " + bundleName +
- primaryStr);
+ logInfo("\tBitstream: " + bitstreamName +
+ "\tBundle: " + bundleName +
+ primaryStr);
} else {
processContentFileEntry(c, i, path, bitstreamName, null, primary);
- System.out.println("\tBitstream: " + bitstreamName + primaryStr);
+ logInfo("\tBitstream: " + bitstreamName + primaryStr);
}
- if (permissionsExist || descriptionExists) {
+ if (permissionsExist || descriptionExists || labelExists || heightExists
+ || widthExists || tocExists) {
+ logInfo("Gathering options.");
String extraInfo = bitstreamName;
if (permissionsExist) {
@@ -942,6 +1349,26 @@ protected List processContentsFile(Context c, Item i, String path,
+ line.substring(dMarkerIndex, dEndIndex);
}
+ if (labelExists) {
+ extraInfo = extraInfo
+ + line.substring(lMarkerIndex, lEndIndex);
+ }
+
+ if (heightExists) {
+ extraInfo = extraInfo
+ + line.substring(hMarkerIndex, hEndIndex);
+ }
+
+ if (widthExists) {
+ extraInfo = extraInfo
+ + line.substring(wMarkerIndex, wEndIndex);
+ }
+
+ if (tocExists) {
+ extraInfo = extraInfo
+ + line.substring(tMarkerIndex, tEndIndex);
+ }
+
options.add(extraInfo);
}
}
@@ -956,12 +1383,12 @@ protected List processContentsFile(Context c, Item i, String path,
String[] dirListing = dir.list();
for (String fileName : dirListing) {
if (!"dublin_core.xml".equals(fileName) && !fileName.equals("handle") && !metadataFileFilter
- .accept(dir, fileName)) {
+ .accept(dir, fileName) && !"collections".equals(fileName) && !"relationships".equals(fileName)) {
throw new FileNotFoundException("No contents file found");
}
}
- System.out.println("No contents file found - but only metadata files found. Assuming metadata only.");
+ logInfo("No contents file found - but only metadata files found. Assuming metadata only.");
}
return options;
@@ -983,6 +1410,10 @@ protected List processContentsFile(Context c, Item i, String path,
protected void processContentFileEntry(Context c, Item i, String path,
String fileName, String bundleName, boolean primary) throws SQLException,
IOException, AuthorizeException {
+ if (isExcludeContent) {
+ return;
+ }
+
String fullpath = path + File.separatorChar + fileName;
// get an input stream
@@ -1123,11 +1554,16 @@ protected void registerBitstream(Context c, Item i, int assetstore,
*/
protected void processOptions(Context c, Item myItem, List options)
throws SQLException, AuthorizeException {
+ logInfo("Processing options.");
for (String line : options) {
- System.out.println("\tprocessing " + line);
+ logInfo("\tprocessing " + line);
boolean permissionsExist = false;
boolean descriptionExists = false;
+ boolean labelExists = false;
+ boolean heightExists = false;
+ boolean widthExists = false;
+ boolean tocExists = false;
String permissionsMarker = "\tpermissions:";
int pMarkerIndex = line.indexOf(permissionsMarker);
@@ -1151,6 +1587,56 @@ protected void processOptions(Context c, Item myItem, List options)
descriptionExists = true;
}
+
+ // look for label
+ String labelMarker = "\tiiif-label:";
+ int lMarkerIndex = line.indexOf(labelMarker);
+ int lEndIndex = 0;
+ if (lMarkerIndex > 0) {
+ lEndIndex = line.indexOf("\t", lMarkerIndex + 1);
+ if (lEndIndex == -1) {
+ lEndIndex = line.length();
+ }
+ labelExists = true;
+ }
+
+ // look for height
+ String heightMarker = "\tiiif-height:";
+ int hMarkerIndex = line.indexOf(heightMarker);
+ int hEndIndex = 0;
+ if (hMarkerIndex > 0) {
+ hEndIndex = line.indexOf("\t", hMarkerIndex + 1);
+ if (hEndIndex == -1) {
+ hEndIndex = line.length();
+ }
+ heightExists = true;
+ }
+
+ // look for width
+ String widthMarker = "\tiiif-width:";
+ int wMarkerIndex = line.indexOf(widthMarker);
+ int wEndIndex = 0;
+ if (wMarkerIndex > 0) {
+ wEndIndex = line.indexOf("\t", wMarkerIndex + 1);
+ if (wEndIndex == -1) {
+ wEndIndex = line.length();
+ }
+ widthExists = true;
+ }
+
+ // look for toc
+ String tocMarker = "\tiiif-toc:";
+ int tMarkerIndex = line.indexOf(tocMarker);
+ int tEndIndex = 0;
+ if (tMarkerIndex > 0) {
+ tEndIndex = line.indexOf("\t", tMarkerIndex + 1);
+ if (tEndIndex == -1) {
+ tEndIndex = line.length();
+ }
+ tocExists = true;
+ }
+
+
int bsEndIndex = line.indexOf("\t");
String bitstreamName = line.substring(0, bsEndIndex);
@@ -1159,7 +1645,7 @@ protected void processOptions(Context c, Item myItem, List options)
Group myGroup = null;
if (permissionsExist) {
String thisPermission = line.substring(pMarkerIndex
- + permissionsMarker.length(), pEndIndex);
+ + permissionsMarker.length(), pEndIndex);
// get permission type ("read" or "write")
int pTypeIndex = thisPermission.indexOf('-');
@@ -1176,7 +1662,7 @@ protected void processOptions(Context c, Item myItem, List options)
}
groupName = thisPermission.substring(groupIndex + 1,
- groupEndIndex);
+ groupEndIndex);
if (thisPermission.toLowerCase().charAt(pTypeIndex + 1) == 'r') {
actionID = Constants.READ;
@@ -1187,8 +1673,8 @@ protected void processOptions(Context c, Item myItem, List options)
try {
myGroup = groupService.findByName(c, groupName);
} catch (SQLException sqle) {
- System.out.println("SQL Exception finding group name: "
- + groupName);
+ logError("SQL Exception finding group name: "
+ + groupName);
// do nothing, will check for null group later
}
}
@@ -1196,46 +1682,114 @@ protected void processOptions(Context c, Item myItem, List options)
String thisDescription = "";
if (descriptionExists) {
thisDescription = line.substring(
- dMarkerIndex + descriptionMarker.length(), dEndIndex)
+ dMarkerIndex + descriptionMarker.length(), dEndIndex)
.trim();
}
+ String thisLabel = "";
+ if (labelExists) {
+ thisLabel = line.substring(
+ lMarkerIndex + labelMarker.length(), lEndIndex)
+ .trim();
+ }
+
+ String thisHeight = "";
+ if (heightExists) {
+ thisHeight = line.substring(
+ hMarkerIndex + heightMarker.length(), hEndIndex)
+ .trim();
+ }
+
+ String thisWidth = "";
+ if (widthExists) {
+ thisWidth = line.substring(
+ wMarkerIndex + widthMarker.length(), wEndIndex)
+ .trim();
+ }
+
+ String thisToc = "";
+ if (tocExists) {
+ thisToc = line.substring(
+ tMarkerIndex + tocMarker.length(), tEndIndex)
+ .trim();
+ }
+
+ if (isTest) {
+ continue;
+ }
+
Bitstream bs = null;
- boolean notfound = true;
- if (!isTest) {
- // find bitstream
- List bitstreams = itemService.getNonInternalBitstreams(c, myItem);
- for (int j = 0; j < bitstreams.size() && notfound; j++) {
- if (bitstreams.get(j).getName().equals(bitstreamName)) {
- bs = bitstreams.get(j);
- notfound = false;
- }
+ boolean updateRequired = false;
+
+ // find bitstream
+ List bitstreams = itemService.getNonInternalBitstreams(c, myItem);
+ for (Bitstream bitstream : bitstreams) {
+ if (bitstream.getName().equals(bitstreamName)) {
+ bs = bitstream;
+ break;
}
}
- if (notfound && !isTest) {
+ if (null == bs) {
// this should never happen
- System.out.println("\tdefault permissions set for "
- + bitstreamName);
- } else if (!isTest) {
+ logInfo("\tdefault permissions set for " + bitstreamName);
+ } else {
if (permissionsExist) {
if (myGroup == null) {
- System.out.println("\t" + groupName
- + " not found, permissions set to default");
+ logInfo("\t" + groupName
+ + " not found, permissions set to default");
} else if (actionID == -1) {
- System.out
- .println("\tinvalid permissions flag, permissions set to default");
+ logInfo("\tinvalid permissions flag, permissions set to default");
} else {
- System.out.println("\tSetting special permissions for "
- + bitstreamName);
+ logInfo("\tSetting special permissions for "
+ + bitstreamName);
setPermission(c, myGroup, actionID, bs);
}
}
if (descriptionExists) {
- System.out.println("\tSetting description for "
- + bitstreamName);
+ logInfo("\tSetting description for "
+ + bitstreamName);
bs.setDescription(c, thisDescription);
+ updateRequired = true;
+ }
+
+ if (labelExists) {
+ MetadataField metadataField = metadataFieldService
+ .findByElement(c, METADATA_IIIF_SCHEMA, METADATA_IIIF_LABEL_ELEMENT, null);
+ logInfo("\tSetting label to " + thisLabel + " in element "
+ + metadataField.getElement() + " on " + bitstreamName);
+ bitstreamService.addMetadata(c, bs, metadataField, null, thisLabel);
+ updateRequired = true;
+ }
+
+ if (heightExists) {
+ MetadataField metadataField = metadataFieldService
+ .findByElement(c, METADATA_IIIF_SCHEMA, METADATA_IIIF_IMAGE_ELEMENT,
+ METADATA_IIIF_HEIGHT_QUALIFIER);
+ logInfo("\tSetting height to " + thisHeight + " in element "
+ + metadataField.getElement() + " on " + bitstreamName);
+ bitstreamService.addMetadata(c, bs, metadataField, null, thisHeight);
+ updateRequired = true;
+ }
+ if (widthExists) {
+ MetadataField metadataField = metadataFieldService
+ .findByElement(c, METADATA_IIIF_SCHEMA, METADATA_IIIF_IMAGE_ELEMENT,
+ METADATA_IIIF_WIDTH_QUALIFIER);
+ logInfo("\tSetting width to " + thisWidth + " in element "
+ + metadataField.getElement() + " on " + bitstreamName);
+ bitstreamService.addMetadata(c, bs, metadataField, null, thisWidth);
+ updateRequired = true;
+ }
+ if (tocExists) {
+ MetadataField metadataField = metadataFieldService
+ .findByElement(c, METADATA_IIIF_SCHEMA, METADATA_IIIF_TOC_ELEMENT, null);
+ logInfo("\tSetting toc to " + thisToc + " in element "
+ + metadataField.getElement() + " on " + bitstreamName);
+ bitstreamService.addMetadata(c, bs, metadataField, null, thisToc);
+ updateRequired = true;
+ }
+ if (updateRequired) {
bitstreamService.update(c, bs);
}
}
@@ -1269,9 +1823,9 @@ protected void setPermission(Context c, Group g, int actionID, Bitstream bs)
resourcePolicyService.update(c, rp);
} else {
if (actionID == Constants.READ) {
- System.out.println("\t\tpermissions: READ for " + g.getName());
+ logInfo("\t\tpermissions: READ for " + g.getName());
} else if (actionID == Constants.WRITE) {
- System.out.println("\t\tpermissions: WRITE for " + g.getName());
+ logInfo("\t\tpermissions: WRITE for " + g.getName());
}
}
@@ -1352,7 +1906,7 @@ protected boolean deleteDirectory(File path) {
deleteDirectory(files[i]);
} else {
if (!files[i].delete()) {
- log.error("Unable to delete file: " + files[i].getName());
+ logError("Unable to delete file: " + files[i].getName());
}
}
}
@@ -1372,7 +1926,7 @@ public String unzip(File zipfile, String destDir) throws IOException {
// 2
// does the zip file exist and can we write to the temp directory
if (!zipfile.canRead()) {
- log.error("Zip file '" + zipfile.getAbsolutePath() + "' does not exist, or is not readable.");
+ logError("Zip file '" + zipfile.getAbsolutePath() + "' does not exist, or is not readable.");
}
String destinationDir = destDir;
@@ -1382,13 +1936,13 @@ public String unzip(File zipfile, String destDir) throws IOException {
File tempdir = new File(destinationDir);
if (!tempdir.isDirectory()) {
- log.error("'" + configurationService.getProperty("org.dspace.app.itemexport.work.dir") +
- "' as defined by the key 'org.dspace.app.itemexport.work.dir' in dspace.cfg " +
+ logError("'" + configurationService.getProperty("org.dspace.app.batchitemimport.work.dir") +
+ "' as defined by the key 'org.dspace.app.batchitemimport.work.dir' in dspace.cfg " +
"is not a valid directory");
}
if (!tempdir.exists() && !tempdir.mkdirs()) {
- log.error("Unable to create temporary directory: " + tempdir.getAbsolutePath());
+ logError("Unable to create temporary directory: " + tempdir.getAbsolutePath());
}
String sourcedir = destinationDir + System.getProperty("file.separator") + zipfile.getName();
String zipDir = destinationDir + System.getProperty("file.separator") + zipfile.getName() + System
@@ -1400,71 +1954,71 @@ public String unzip(File zipfile, String destDir) throws IOException {
ZipFile zf = new ZipFile(zipfile);
ZipEntry entry;
Enumeration entries = zf.entries();
- while (entries.hasMoreElements()) {
- entry = entries.nextElement();
- if (entry.isDirectory()) {
- if (!new File(zipDir + entry.getName()).mkdirs()) {
- log.error("Unable to create contents directory: " + zipDir + entry.getName());
- }
- } else {
- String entryName = entry.getName();
- File outFile = new File(zipDir + entryName);
- // Verify that this file will be extracted into our zipDir (and not somewhere else!)
- if (!outFile.toPath().normalize().startsWith(zipDir)) {
- throw new IOException("Bad zip entry: '" + entryName
- + "' in file '" + zipfile.getAbsolutePath() + "'!"
- + " Cannot process this file.");
+ try {
+ while (entries.hasMoreElements()) {
+ entry = entries.nextElement();
+ if (entry.isDirectory()) {
+ if (!new File(zipDir + entry.getName()).mkdirs()) {
+ logError("Unable to create contents directory: " + zipDir + entry.getName());
+ }
} else {
- System.out.println("Extracting file: " + entryName);
- log.info("Extracting file: " + entryName);
+ String entryName = entry.getName();
+ File outFile = new File(zipDir + entryName);
+ // Verify that this file will be extracted into our zipDir (and not somewhere else!)
+ if (!outFile.toPath().normalize().startsWith(zipDir)) {
+ throw new IOException("Bad zip entry: '" + entryName
+ + "' in file '" + zipfile.getAbsolutePath() + "'!"
+ + " Cannot process this file.");
+ } else {
+ logInfo("Extracting file: " + entryName);
- int index = entryName.lastIndexOf('/');
- if (index == -1) {
- // Was it created on Windows instead?
- index = entryName.lastIndexOf('\\');
- }
- if (index > 0) {
- File dir = new File(zipDir + entryName.substring(0, index));
- if (!dir.exists() && !dir.mkdirs()) {
- log.error("Unable to create directory: " + dir.getAbsolutePath());
+ int index = entryName.lastIndexOf('/');
+ if (index == -1) {
+ // Was it created on Windows instead?
+ index = entryName.lastIndexOf('\\');
}
+ if (index > 0) {
+ File dir = new File(zipDir + entryName.substring(0, index));
+ if (!dir.exists() && !dir.mkdirs()) {
+ logError("Unable to create directory: " + dir.getAbsolutePath());
+ }
- //Entries could have too many directories, and we need to adjust the sourcedir
- // file1.zip (SimpleArchiveFormat / item1 / contents|dublin_core|...
- // SimpleArchiveFormat / item2 / contents|dublin_core|...
- // or
- // file2.zip (item1 / contents|dublin_core|...
- // item2 / contents|dublin_core|...
-
- //regex supports either windows or *nix file paths
- String[] entryChunks = entryName.split("/|\\\\");
- if (entryChunks.length > 2) {
- if (StringUtils.equals(sourceDirForZip, sourcedir)) {
- sourceDirForZip = sourcedir + "/" + entryChunks[0];
+ //Entries could have too many directories, and we need to adjust the sourcedir
+ // file1.zip (SimpleArchiveFormat / item1 / contents|dublin_core|...
+ // SimpleArchiveFormat / item2 / contents|dublin_core|...
+ // or
+ // file2.zip (item1 / contents|dublin_core|...
+ // item2 / contents|dublin_core|...
+
+ //regex supports either windows or *nix file paths
+ String[] entryChunks = entryName.split("/|\\\\");
+ if (entryChunks.length > 2) {
+ if (StringUtils.equals(sourceDirForZip, sourcedir)) {
+ sourceDirForZip = sourcedir + "/" + entryChunks[0];
+ }
}
}
+ byte[] buffer = new byte[1024];
+ int len;
+ InputStream in = zf.getInputStream(entry);
+ BufferedOutputStream out = new BufferedOutputStream(
+ new FileOutputStream(outFile));
+ while ((len = in.read(buffer)) >= 0) {
+ out.write(buffer, 0, len);
+ }
+ in.close();
+ out.close();
}
- byte[] buffer = new byte[1024];
- int len;
- InputStream in = zf.getInputStream(entry);
- BufferedOutputStream out = new BufferedOutputStream(
- new FileOutputStream(outFile));
- while ((len = in.read(buffer)) >= 0) {
- out.write(buffer, 0, len);
- }
- in.close();
- out.close();
}
}
+ } finally {
+ //Close zip file
+ zf.close();
}
- //Close zip file
- zf.close();
-
if (!StringUtils.equals(sourceDirForZip, sourcedir)) {
sourcedir = sourceDirForZip;
- System.out.println("Set sourceDir using path inside of Zip: " + sourcedir);
- log.info("Set sourceDir using path inside of Zip: " + sourcedir);
+ logInfo("Set sourceDir using path inside of Zip: " + sourcedir);
}
return sourcedir;
@@ -1514,20 +2068,15 @@ public void processUIImport(String filepath, Collection owningCollection, String
final String theFilePath = filepath;
final String theInputType = inputType;
final String theResumeDir = resumeDir;
- final boolean useTemplateItem = template;
Thread go = new Thread() {
@Override
public void run() {
- Context context = null;
-
+ Context context = new Context();
String importDir = null;
EPerson eperson = null;
try {
-
- // create a new dspace context
- context = new Context();
eperson = ePersonService.find(context, oldEPerson.getID());
context.setCurrentUser(eperson);
context.turnOffAuthorisationSystem();
@@ -1538,7 +2087,8 @@ public void run() {
if (theOtherCollections != null) {
for (String colID : theOtherCollections) {
UUID colId = UUID.fromString(colID);
- if (!theOwningCollection.getID().equals(colId)) {
+ if (theOwningCollection != null
+ && !theOwningCollection.getID().equals(colId)) {
Collection col = collectionService.find(context, colId);
if (col != null) {
collectionList.add(col);
@@ -1557,7 +2107,7 @@ public void run() {
if (!importDirFile.exists()) {
boolean success = importDirFile.mkdirs();
if (!success) {
- log.info("Cannot create batch import directory!");
+ logInfo("Cannot create batch import directory!");
throw new Exception("Cannot create batch import directory!");
}
}
@@ -1689,14 +2239,14 @@ public void emailSuccessMessage(Context context, EPerson eperson,
email.send();
} catch (Exception e) {
- log.warn(LogManager.getHeader(context, "emailSuccessMessage", "cannot notify user of import"), e);
+ logError(LogHelper.getHeader(context, "emailSuccessMessage", "cannot notify user of import"), e);
}
}
@Override
public void emailErrorMessage(EPerson eperson, String error)
throws MessagingException {
- log.warn("An error occurred during item import, the user will be notified. " + error);
+ logError("An error occurred during item import, the user will be notified. " + error);
try {
Locale supportedLocale = I18nUtil.getEPersonLocale(eperson);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "bte_batch_import_error"));
@@ -1706,7 +2256,7 @@ public void emailErrorMessage(EPerson eperson, String error)
email.send();
} catch (Exception e) {
- log.warn("error during item import error notification", e);
+ logError("error during item import error notification", e);
}
}
@@ -1784,18 +2334,17 @@ public File getTempWorkDirFile()
+ tempDirFile.getAbsolutePath()
+ " could not be created.");
} else {
- log.debug("Created directory " + tempDirFile.getAbsolutePath());
+ logDebug("Created directory " + tempDirFile.getAbsolutePath());
}
} else {
- log.debug("Work directory exists: " + tempDirFile.getAbsolutePath());
+ logDebug("Work directory exists: " + tempDirFile.getAbsolutePath());
}
return tempDirFile;
}
@Override
public void cleanupZipTemp() {
- System.out.println("Deleting temporary zip directory: " + tempWorkDir);
- log.debug("Deleting temporary zip directory: " + tempWorkDir);
+ logDebug("Deleting temporary zip directory: " + tempWorkDir);
deleteDirectory(new File(tempWorkDir));
}
@@ -1804,6 +2353,11 @@ public void setTest(boolean isTest) {
this.isTest = isTest;
}
+ @Override
+ public void setExcludeContent(boolean isExcludeContent) {
+ this.isExcludeContent = isExcludeContent;
+ }
+
@Override
public void setResume(boolean isResume) {
this.isResume = isResume;
@@ -1823,4 +2377,82 @@ public void setUseWorkflowSendEmail(boolean useWorkflowSendEmail) {
public void setQuiet(boolean isQuiet) {
this.isQuiet = isQuiet;
}
+
+ @Override
+ public void setHandler(DSpaceRunnableHandler handler) {
+ this.handler = handler;
+ }
+
+ private void logInfo(String message) {
+ logInfo(message, null);
+ }
+
+ private void logInfo(String message, Exception e) {
+ if (handler != null) {
+ handler.logInfo(message);
+ return;
+ }
+
+ if (e != null) {
+ log.info(message, e);
+ } else {
+ log.info(message);
+ }
+ }
+
+ private void logDebug(String message) {
+ logDebug(message, null);
+ }
+
+ private void logDebug(String message, Exception e) {
+ if (handler != null) {
+ handler.logDebug(message);
+ return;
+ }
+
+ if (e != null) {
+ log.debug(message, e);
+ } else {
+ log.debug(message);
+ }
+ }
+
+ private void logWarn(String message) {
+ logWarn(message, null);
+ }
+
+ private void logWarn(String message, Exception e) {
+ if (handler != null) {
+ handler.logWarning(message);
+ return;
+ }
+
+ if (e != null) {
+ log.warn(message, e);
+ } else {
+ log.warn(message);
+ }
+ }
+
+ private void logError(String message) {
+ logError(message, null);
+ }
+
+ private void logError(String message, Exception e) {
+ if (handler != null) {
+ if (e != null) {
+ handler.logError(message, e);
+ } else {
+ handler.logError(message);
+ }
+ return;
+ }
+
+ if (e != null) {
+ log.error(message, e);
+ } else {
+ log.error(message);
+ }
+ }
+
}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemimport/service/ItemImportService.java b/dspace-api/src/main/java/org/dspace/app/itemimport/service/ItemImportService.java
index af333764b562..e99ece31b9bb 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemimport/service/ItemImportService.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemimport/service/ItemImportService.java
@@ -16,6 +16,7 @@
import org.dspace.content.Collection;
import org.dspace.core.Context;
import org.dspace.eperson.EPerson;
+import org.dspace.scripts.handler.DSpaceRunnableHandler;
/**
* Import items into DSpace. The conventional use is upload files by copying
@@ -105,7 +106,7 @@ public void processUIImport(String url, Collection owningCollection, String[] co
String inputType, Context context, boolean template) throws Exception;
/**
- * Since the BTE batch import is done in a new thread we are unable to communicate
+ * If a batch import is done in a new thread we are unable to communicate
* with calling method about success or failure. We accomplish this
* communication with email instead. Send a success email once the batch
* import is complete
@@ -119,7 +120,7 @@ public void emailSuccessMessage(Context context, EPerson eperson,
String fileName) throws MessagingException;
/**
- * Since the BTE batch import is done in a new thread we are unable to communicate
+ * If a batch import is done in a new thread we are unable to communicate
* with calling method about success or failure. We accomplis this
* communication with email instead. Send an error email if the batch
* import fails
@@ -210,6 +211,13 @@ public void replaceItems(Context c, List mycollections, String sourc
*/
public void setTest(boolean isTest);
+ /**
+ * Set exclude-content flag.
+ *
+ * @param isExcludeContent true or false
+ */
+ public void setExcludeContent(boolean isExcludeContent);
+
/**
* Set resume flag
*
@@ -235,4 +243,10 @@ public void replaceItems(Context c, List mycollections, String sourc
* @param isQuiet true or false
*/
public void setQuiet(boolean isQuiet);
+
+ /**
+ * Set the DSpace Runnable Handler
+ * @param handler
+ */
+ public void setHandler(DSpaceRunnableHandler handler);
}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemmarking/ItemMarkingAvailabilityBitstreamStrategy.java b/dspace-api/src/main/java/org/dspace/app/itemmarking/ItemMarkingAvailabilityBitstreamStrategy.java
index cd08ad032c49..31166add72ec 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemmarking/ItemMarkingAvailabilityBitstreamStrategy.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemmarking/ItemMarkingAvailabilityBitstreamStrategy.java
@@ -11,6 +11,8 @@
import java.sql.SQLException;
import java.util.List;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
import org.dspace.app.util.Util;
import org.dspace.content.Bitstream;
import org.dspace.content.Bundle;
@@ -34,8 +36,9 @@ public class ItemMarkingAvailabilityBitstreamStrategy implements ItemMarkingExtr
@Autowired(required = true)
protected ItemService itemService;
- public ItemMarkingAvailabilityBitstreamStrategy() {
+ private static final Logger LOG = LogManager.getLogger();
+ public ItemMarkingAvailabilityBitstreamStrategy() {
}
@Override
@@ -43,14 +46,14 @@ public ItemMarkingInfo getItemMarkingInfo(Context context, Item item)
throws SQLException {
List bundles = itemService.getBundles(item, "ORIGINAL");
- if (bundles.size() == 0) {
+ if (bundles.isEmpty()) {
ItemMarkingInfo markInfo = new ItemMarkingInfo();
markInfo.setImageName(nonAvailableImageName);
return markInfo;
} else {
Bundle originalBundle = bundles.iterator().next();
- if (originalBundle.getBitstreams().size() == 0) {
+ if (originalBundle.getBitstreams().isEmpty()) {
ItemMarkingInfo markInfo = new ItemMarkingInfo();
markInfo.setImageName(nonAvailableImageName);
@@ -72,8 +75,7 @@ public ItemMarkingInfo getItemMarkingInfo(Context context, Item item)
try {
bsLink = bsLink + Util.encodeBitstreamName(bitstream.getName(), Constants.DEFAULT_ENCODING);
} catch (UnsupportedEncodingException e) {
-
- e.printStackTrace();
+ LOG.warn("DSpace uses an unsupported encoding", e);
}
signInfo.setLink(bsLink);
diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/AddBitstreamsAction.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/AddBitstreamsAction.java
index e9693fb3d1ab..644745304a23 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/AddBitstreamsAction.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/AddBitstreamsAction.java
@@ -77,7 +77,7 @@ public void execute(Context context, ItemArchive itarch, boolean isTest,
ItemUpdate.pr("Contents bitstream count: " + contents.size());
String[] files = dir.list(ItemUpdate.fileFilter);
- List fileList = new ArrayList();
+ List fileList = new ArrayList<>();
for (String filename : files) {
fileList.add(filename);
ItemUpdate.pr("file: " + filename);
@@ -134,9 +134,6 @@ protected String addBitstream(Context context, ItemArchive itarch, Item item, Fi
ItemUpdate.pr("contents entry for bitstream: " + ce.toString());
File f = new File(dir, ce.filename);
- // get an input stream
- BufferedInputStream bis = new BufferedInputStream(new FileInputStream(f));
-
Bitstream bs = null;
String newBundleName = ce.bundlename;
@@ -173,7 +170,9 @@ protected String addBitstream(Context context, ItemArchive itarch, Item item, Fi
targetBundle = bundles.iterator().next();
}
- bs = bitstreamService.create(context, targetBundle, bis);
+ try (BufferedInputStream bis = new BufferedInputStream(new FileInputStream(f));) {
+ bs = bitstreamService.create(context, targetBundle, bis);
+ }
bs.setName(context, ce.filename);
// Identify the format
diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/ContentsEntry.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/ContentsEntry.java
index e192b92b89ea..7bbe4a19e9ea 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/ContentsEntry.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/ContentsEntry.java
@@ -105,6 +105,7 @@ public static ContentsEntry parse(String line)
return new ContentsEntry(arp[0], arp[1], actionId, groupName, arp[3]);
}
+ @Override
public String toString() {
StringBuilder sb = new StringBuilder(filename);
if (bundlename != null) {
diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/DtoMetadata.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/DtoMetadata.java
index 6e4a4a88d6b4..e67b2221e47e 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/DtoMetadata.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/DtoMetadata.java
@@ -120,6 +120,7 @@ public boolean matches(String compoundForm, boolean wildcard) {
return true;
}
+ @Override
public String toString() {
String s = "\tSchema: " + schema + " Element: " + element;
if (qualifier != null) {
diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemArchive.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemArchive.java
index 2270d736a8e3..26de45caf77e 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemArchive.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemArchive.java
@@ -17,6 +17,7 @@
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintWriter;
+import java.nio.charset.StandardCharsets;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Iterator;
@@ -55,7 +56,7 @@ public class ItemArchive {
protected Transformer transformer = null;
protected List dtomList = null;
- protected List undoDtomList = new ArrayList();
+ protected List undoDtomList = new ArrayList<>();
protected List undoAddContents = new ArrayList<>(); // for undo of add
@@ -325,7 +326,7 @@ public void writeUndo(File undoDir)
PrintWriter pw = null;
try {
File f = new File(dir, ItemUpdate.DELETE_CONTENTS_FILE);
- pw = new PrintWriter(new BufferedWriter(new FileWriter(f)));
+ pw = new PrintWriter(new BufferedWriter(new FileWriter(f, StandardCharsets.UTF_8)));
for (UUID i : undoAddContents) {
pw.println(i);
}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemUpdate.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemUpdate.java
index b6aa875f29b0..a3fe0b2321f7 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemUpdate.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/ItemUpdate.java
@@ -39,29 +39,34 @@
import org.dspace.handle.service.HandleService;
/**
- * Provides some batch editing capabilities for items in DSpace:
- * Metadata fields - Add, Delete
- * Bitstreams - Add, Delete
+ * Provides some batch editing capabilities for items in DSpace.
+ *
+ * - Metadata fields - Add, Delete
+ * - Bitstreams - Add, Delete
+ *
*
- * The design has been for compatibility with ItemImporter
+ *
+ * The design has been for compatibility with
+ * {@link org.dspace.app.itemimport.service.ItemImportService}
* in the use of the DSpace archive format which is used to
* specify changes on a per item basis. The directory names
* to correspond to each item are arbitrary and will only be
* used for logging purposes. The reference to the item is
- * from a required dc.identifier with the item handle to be
- * included in the dublin_core.xml (or similar metadata) file.
+ * from a required {@code dc.identifier} with the item handle to be
+ * included in the {@code dublin_core.xml} (or similar metadata) file.
*
- * Any combination of these actions is permitted in a single run of this class
+ *
+ * Any combination of these actions is permitted in a single run of this class.
* The order of actions is important when used in combination.
- * It is the responsibility of the calling class (here, ItemUpdate)
- * to register UpdateAction classes in the order to which they are
+ * It is the responsibility of the calling class (here, {@code ItemUpdate})
+ * to register {@link UpdateAction} classes in the order which they are
* to be performed.
*
- *
- * It is unfortunate that so much code needs to be borrowed
- * from ItemImport as it is not reusable in private methods, etc.
- * Some of this has been placed into the MetadataUtilities class
- * for possible reuse elsewhere.
+ *
+ * It is unfortunate that so much code needs to be borrowed from
+ * {@link org.dspace.app.itemimport.service.ItemImportService} as it is not
+ * reusable in private methods, etc. Some of this has been placed into the
+ * {@link MetadataUtilities} class for possible reuse elsewhere.
*
* @author W. Hays based on a conceptual design by R. Rodgers
*/
@@ -73,7 +78,7 @@ public class ItemUpdate {
public static final String DELETE_CONTENTS_FILE = "delete_contents";
public static String HANDLE_PREFIX = null;
- public static final Map filterAliases = new HashMap();
+ public static final Map filterAliases = new HashMap<>();
public static boolean verbose = false;
@@ -375,7 +380,7 @@ protected void processArchive(Context context, String sourceDirPath, String item
// open and process the source directory
File sourceDir = new File(sourceDirPath);
- if ((sourceDir == null) || !sourceDir.exists() || !sourceDir.isDirectory()) {
+ if (!sourceDir.exists() || !sourceDir.isDirectory()) {
pr("Error, cannot open archive source directory " + sourceDirPath);
throw new Exception("error with archive source directory " + sourceDirPath);
}
diff --git a/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java b/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
index 5c2138a590d2..910eb434d1d0 100644
--- a/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
+++ b/dspace-api/src/main/java/org/dspace/app/itemupdate/MetadataUtilities.java
@@ -27,10 +27,12 @@
import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamResult;
+import javax.xml.xpath.XPath;
+import javax.xml.xpath.XPathConstants;
+import javax.xml.xpath.XPathExpressionException;
+import javax.xml.xpath.XPathFactory;
import org.apache.commons.lang3.StringUtils;
-import org.apache.xpath.XPathAPI;
-import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Item;
import org.dspace.content.MetadataField;
import org.dspace.content.MetadataSchema;
@@ -170,24 +172,21 @@ public static void appendMetadata(Context context, Item item, DtoMetadata dtom,
* @param docBuilder DocumentBuilder
* @param is - InputStream of dublin_core.xml
* @return list of DtoMetadata representing the metadata fields relating to an Item
- * @throws SQLException if database error
* @throws IOException if IO error
* @throws ParserConfigurationException if parser config error
* @throws SAXException if XML error
- * @throws TransformerException if transformer error
- * @throws AuthorizeException if authorization error
*/
public static List loadDublinCore(DocumentBuilder docBuilder, InputStream is)
- throws SQLException, IOException, ParserConfigurationException,
- SAXException, TransformerException, AuthorizeException {
+ throws IOException, XPathExpressionException, SAXException {
Document document = docBuilder.parse(is);
List dtomList = new ArrayList();
// Get the schema, for backward compatibility we will default to the
// dublin core schema if the schema name is not available in the import file
- String schema = null;
- NodeList metadata = XPathAPI.selectNodeList(document, "/dublin_core");
+ String schema;
+ XPath xPath = XPathFactory.newInstance().newXPath();
+ NodeList metadata = (NodeList) xPath.compile("/dublin_core").evaluate(document, XPathConstants.NODESET);
Node schemaAttr = metadata.item(0).getAttributes().getNamedItem("schema");
if (schemaAttr == null) {
schema = MetadataSchemaEnum.DC.getName();
@@ -196,7 +195,7 @@ public static List loadDublinCore(DocumentBuilder docBuilder, Input
}
// Get the nodes corresponding to formats
- NodeList dcNodes = XPathAPI.selectNodeList(document, "/dublin_core/dcvalue");
+ NodeList dcNodes = (NodeList) xPath.compile("/dublin_core/dcvalue").evaluate(document, XPathConstants.NODESET);
for (int i = 0; i < dcNodes.getLength(); i++) {
Node n = dcNodes.item(i);
diff --git a/dspace-api/src/main/java/org/dspace/app/launcher/CommandRunner.java b/dspace-api/src/main/java/org/dspace/app/launcher/CommandRunner.java
index ce33b6655bc6..06c2ddb48340 100644
--- a/dspace-api/src/main/java/org/dspace/app/launcher/CommandRunner.java
+++ b/dspace-api/src/main/java/org/dspace/app/launcher/CommandRunner.java
@@ -16,7 +16,7 @@
import java.util.ArrayList;
import java.util.List;
-import org.jdom.Document;
+import org.jdom2.Document;
/**
* @author mwood
diff --git a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java
index d445f9bbf3f5..89a416bfa883 100644
--- a/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java
+++ b/dspace-api/src/main/java/org/dspace/app/launcher/ScriptLauncher.java
@@ -21,6 +21,7 @@
import org.apache.logging.log4j.Logger;
import org.dspace.core.Context;
import org.dspace.scripts.DSpaceRunnable;
+import org.dspace.scripts.DSpaceRunnable.StepResult;
import org.dspace.scripts.configuration.ScriptConfiguration;
import org.dspace.scripts.factory.ScriptServiceFactory;
import org.dspace.scripts.handler.DSpaceRunnableHandler;
@@ -29,9 +30,9 @@
import org.dspace.servicemanager.DSpaceKernelImpl;
import org.dspace.servicemanager.DSpaceKernelInit;
import org.dspace.services.RequestService;
-import org.jdom.Document;
-import org.jdom.Element;
-import org.jdom.input.SAXBuilder;
+import org.jdom2.Document;
+import org.jdom2.Element;
+import org.jdom2.input.SAXBuilder;
/**
* A DSpace script launcher.
@@ -145,8 +146,13 @@ public static int handleScript(String[] args, Document commandConfigs,
private static int executeScript(String[] args, DSpaceRunnableHandler dSpaceRunnableHandler,
DSpaceRunnable script) {
try {
- script.initialize(args, dSpaceRunnableHandler, null);
- script.run();
+ StepResult result = script.initialize(args, dSpaceRunnableHandler, null);
+ // check the StepResult, only run the script if the result is Continue;
+ // otherwise - for example the script is started with the help as argument, nothing is to do
+ if (StepResult.Continue.equals(result)) {
+ // runs the script, the normal initialization is successful
+ script.run();
+ }
return 0;
} catch (ParseException e) {
script.printHelp();
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/Brand.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/Brand.java
index 2d963dd3da79..9e28edad45b5 100644
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/Brand.java
+++ b/dspace-api/src/main/java/org/dspace/app/mediafilter/Brand.java
@@ -21,10 +21,10 @@
*/
public class Brand {
- private int brandWidth;
- private int brandHeight;
- private Font font;
- private int xOffset;
+ private final int brandWidth;
+ private final int brandHeight;
+ private final Font font;
+ private final int xOffset;
/**
* Constructor to set up footer image attributes.
@@ -92,7 +92,7 @@ public BufferedImage create(String brandLeftText,
* do the text placements and preparatory work for the brand image generation
*
* @param brandImage a BufferedImage object where the image is created
- * @param identifier and Identifier object describing what text is to be placed in what
+ * @param brandText an Identifier object describing what text is to be placed in what
* position within the brand
*/
private void drawImage(BufferedImage brandImage,
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/BrandText.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/BrandText.java
index ae77f6048b48..91107406434e 100644
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/BrandText.java
+++ b/dspace-api/src/main/java/org/dspace/app/mediafilter/BrandText.java
@@ -39,7 +39,7 @@ class BrandText {
* its location within a rectangular area.
*
* @param location one of the class location constants e.g. Identifier.BL
- * @param the text associated with the location
+ * @param text text associated with the location
*/
public BrandText(String location, String text) {
this.location = location;
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/ExcelFilter.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/ExcelFilter.java
deleted file mode 100644
index c17d168c0435..000000000000
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/ExcelFilter.java
+++ /dev/null
@@ -1,99 +0,0 @@
-/**
- * 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.mediafilter;
-
-import java.io.InputStream;
-import java.nio.charset.StandardCharsets;
-
-import org.apache.commons.io.IOUtils;
-import org.apache.logging.log4j.Logger;
-import org.apache.poi.POITextExtractor;
-import org.apache.poi.extractor.ExtractorFactory;
-import org.apache.poi.hssf.extractor.ExcelExtractor;
-import org.apache.poi.xssf.extractor.XSSFExcelExtractor;
-import org.dspace.content.Item;
-
-/*
- * ExcelFilter
- *
- * Entries you must add to dspace.cfg:
- *
- * filter.plugins = blah, \
- * Excel Text Extractor
- *
- * plugin.named.org.dspace.app.mediafilter.FormatFilter = \
- * blah = blah, \
- * org.dspace.app.mediafilter.ExcelFilter = Excel Text Extractor
- *
- * #Configure each filter's input Formats
- * filter.org.dspace.app.mediafilter.ExcelFilter.inputFormats = Microsoft Excel, Microsoft Excel XML
- *
- */
-public class ExcelFilter extends MediaFilter {
-
- private static Logger log = org.apache.logging.log4j.LogManager.getLogger(ExcelFilter.class);
-
- public String getFilteredName(String oldFilename) {
- return oldFilename + ".txt";
- }
-
- /**
- * @return String bundle name
- */
- public String getBundleName() {
- return "TEXT";
- }
-
- /**
- * @return String bitstream format
- */
- public String getFormatString() {
- return "Text";
- }
-
- /**
- * @return String description
- */
- public String getDescription() {
- return "Extracted text";
- }
-
- /**
- * @param item item
- * @param source source input stream
- * @param verbose verbose mode
- * @return InputStream the resulting input stream
- * @throws Exception if error
- */
- @Override
- public InputStream getDestinationStream(Item item, InputStream source, boolean verbose)
- throws Exception {
- String extractedText = null;
-
- try {
- POITextExtractor theExtractor = ExtractorFactory.createExtractor(source);
- if (theExtractor instanceof ExcelExtractor) {
- // for xls file
- extractedText = (theExtractor).getText();
- } else if (theExtractor instanceof XSSFExcelExtractor) {
- // for xlsx file
- extractedText = (theExtractor).getText();
- }
- } catch (Exception e) {
- log.error("Error filtering bitstream: " + e.getMessage(), e);
- throw e;
- }
-
- if (extractedText != null) {
- // generate an input stream with the extracted text
- return IOUtils.toInputStream(extractedText, StandardCharsets.UTF_8);
- }
-
- return null;
- }
-}
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/HTMLFilter.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/HTMLFilter.java
deleted file mode 100644
index 1b982cb27737..000000000000
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/HTMLFilter.java
+++ /dev/null
@@ -1,81 +0,0 @@
-/**
- * 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.mediafilter;
-
-import java.io.ByteArrayInputStream;
-import java.io.InputStream;
-import javax.swing.text.Document;
-import javax.swing.text.html.HTMLEditorKit;
-
-import org.dspace.content.Item;
-
-/*
- *
- * to do: helpful error messages - can't find mediafilter.cfg - can't
- * instantiate filter - bitstream format doesn't exist
- *
- */
-public class HTMLFilter extends MediaFilter {
-
- @Override
- public String getFilteredName(String oldFilename) {
- return oldFilename + ".txt";
- }
-
- /**
- * @return String bundle name
- */
- @Override
- public String getBundleName() {
- return "TEXT";
- }
-
- /**
- * @return String bitstreamformat
- */
- @Override
- public String getFormatString() {
- return "Text";
- }
-
- /**
- * @return String description
- */
- @Override
- public String getDescription() {
- return "Extracted text";
- }
-
- /**
- * @param currentItem item
- * @param source source input stream
- * @param verbose verbose mode
- * @return InputStream the resulting input stream
- * @throws Exception if error
- */
- @Override
- public InputStream getDestinationStream(Item currentItem, InputStream source, boolean verbose)
- throws Exception {
- // try and read the document - set to ignore character set directive,
- // assuming that the input stream is already set properly (I hope)
- HTMLEditorKit kit = new HTMLEditorKit();
- Document doc = kit.createDefaultDocument();
-
- doc.putProperty("IgnoreCharsetDirective", Boolean.TRUE);
-
- kit.read(source, doc, 0);
-
- String extractedText = doc.getText(0, doc.getLength());
-
- // generate an input stream with the extracted text
- byte[] textBytes = extractedText.getBytes();
- ByteArrayInputStream bais = new ByteArrayInputStream(textBytes);
-
- return bais; // will this work? or will the byte array be out of scope?
- }
-}
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickPdfThumbnailFilter.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickPdfThumbnailFilter.java
index 467303c3cafd..afe1bb3d75df 100644
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickPdfThumbnailFilter.java
+++ b/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickPdfThumbnailFilter.java
@@ -22,7 +22,9 @@ public InputStream getDestinationStream(Item currentItem, InputStream source, bo
File f2 = null;
File f3 = null;
try {
- f2 = getImageFile(f, 0, verbose);
+ // Step 1: get an image from our PDF file, with PDF-specific processing options
+ f2 = getImageFile(f, verbose);
+ // Step 2: use the image above to create the final resized and rotated thumbnail
f3 = getThumbnailFile(f2, verbose);
byte[] bytes = Files.readAllBytes(f3.toPath());
return new ByteArrayInputStream(bytes);
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickThumbnailFilter.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickThumbnailFilter.java
index a79fd42d5937..408982d157e5 100644
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickThumbnailFilter.java
+++ b/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickThumbnailFilter.java
@@ -14,6 +14,9 @@
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.common.PDRectangle;
import org.dspace.content.Bitstream;
import org.dspace.content.Bundle;
import org.dspace.content.Item;
@@ -113,13 +116,54 @@ public File getThumbnailFile(File f, boolean verbose)
return f2;
}
- public File getImageFile(File f, int page, boolean verbose)
+ /**
+ * Return an image from a bitstream with specific processing options for
+ * PDFs. This is only used by ImageMagickPdfThumbnailFilter in order to
+ * generate an intermediate image file for use with getThumbnailFile.
+ */
+ public File getImageFile(File f, boolean verbose)
throws IOException, InterruptedException, IM4JavaException {
- File f2 = new File(f.getParentFile(), f.getName() + ".jpg");
+ // Writing an intermediate file to disk is inefficient, but since we're
+ // doing it anyway, we should use a lossless format. IM's internal MIFF
+ // is lossless like PNG and TIFF, but much faster.
+ File f2 = new File(f.getParentFile(), f.getName() + ".miff");
f2.deleteOnExit();
ConvertCmd cmd = new ConvertCmd();
IMOperation op = new IMOperation();
- String s = "[" + page + "]";
+
+ // Optionally override ImageMagick's default density of 72 DPI to use a
+ // "supersample" when creating the PDF thumbnail. Note that I prefer to
+ // use the getProperty() method here instead of getIntPropert() because
+ // the latter always returns an integer (0 in the case it's not set). I
+ // would prefer to keep ImageMagick's default to itself rather than for
+ // us to set one. Also note that the density option *must* come before
+ // we open the input file.
+ String density = configurationService.getProperty(PRE + ".density");
+ if (density != null) {
+ op.density(Integer.valueOf(density));
+ }
+
+ // Check the PDF's MediaBox and CropBox to see if they are the same.
+ // If not, then tell ImageMagick to use the CropBox when generating
+ // the thumbnail because the CropBox is generally used to define the
+ // area displayed when a user opens the PDF on a screen, whereas the
+ // MediaBox is used for print. Not all PDFs set these correctly, so
+ // we can use ImageMagick's default behavior unless we see an explit
+ // CropBox. Note: we don't need to do anything special to detect if
+ // the CropBox is missing or empty because pdfbox will set it to the
+ // same size as the MediaBox if it doesn't exist. Also note that we
+ // only need to check the first page, since that's what we use for
+ // generating the thumbnail (PDDocument uses a zero-based index).
+ PDPage pdfPage = PDDocument.load(f).getPage(0);
+ PDRectangle pdfPageMediaBox = pdfPage.getMediaBox();
+ PDRectangle pdfPageCropBox = pdfPage.getCropBox();
+
+ // This option must come *before* we open the input file.
+ if (pdfPageCropBox != pdfPageMediaBox) {
+ op.define("pdf:use-cropbox=true");
+ }
+
+ String s = "[0]";
op.addImage(f.getAbsolutePath() + s);
if (configurationService.getBooleanProperty(PRE + ".flatten", true)) {
op.flatten();
@@ -172,20 +216,20 @@ public boolean preProcessBitstream(Context c, Item item, Bitstream source, boole
if (description != null) {
if (replaceRegex.matcher(description).matches()) {
if (verbose) {
- System.out.format("%s %s matches pattern and is replacable.%n",
- description, nsrc);
+ System.out.format("%s %s matches pattern and is replaceable.%n",
+ description, n);
}
continue;
}
if (description.equals(getDescription())) {
if (verbose) {
System.out.format("%s %s is replaceable.%n",
- getDescription(), nsrc);
+ getDescription(), n);
}
continue;
}
}
- System.out.format("Custom Thumbnail exists for %s for item %s. Thumbnail will not be generated.%n",
+ System.out.format("Custom thumbnail exists for %s for item %s. Thumbnail will not be generated.%n",
nsrc, item.getHandle());
return false;
}
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickVideoThumbnailFilter.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickVideoThumbnailFilter.java
new file mode 100644
index 000000000000..4221a514d7d5
--- /dev/null
+++ b/dspace-api/src/main/java/org/dspace/app/mediafilter/ImageMagickVideoThumbnailFilter.java
@@ -0,0 +1,76 @@
+/**
+ * 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.mediafilter;
+
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+
+import org.dspace.content.Item;
+import org.im4java.core.ConvertCmd;
+import org.im4java.core.IM4JavaException;
+import org.im4java.core.IMOperation;
+
+
+/**
+ * Filter video bitstreams, scaling the image to be within the bounds of
+ * thumbnail.maxwidth, thumbnail.maxheight, the size we want our thumbnail to be
+ * no bigger than. Creates only JPEGs.
+ */
+public class ImageMagickVideoThumbnailFilter extends ImageMagickThumbnailFilter {
+ private static final int DEFAULT_WIDTH = 180;
+ private static final int DEFAULT_HEIGHT = 120;
+ private static final int FRAME_NUMBER = 100;
+
+ /**
+ * @param currentItem item
+ * @param source source input stream
+ * @param verbose verbose mode
+ * @return InputStream the resulting input stream
+ * @throws Exception if error
+ */
+ @Override
+ public InputStream getDestinationStream(Item currentItem, InputStream source, boolean verbose)
+ throws Exception {
+ File f = inputStreamToTempFile(source, "imthumb", ".tmp");
+ File f2 = null;
+ try {
+ f2 = getThumbnailFile(f, verbose);
+ byte[] bytes = Files.readAllBytes(f2.toPath());
+ return new ByteArrayInputStream(bytes);
+ } finally {
+ //noinspection ResultOfMethodCallIgnored
+ f.delete();
+ if (f2 != null) {
+ //noinspection ResultOfMethodCallIgnored
+ f2.delete();
+ }
+ }
+ }
+
+ @Override
+ public File getThumbnailFile(File f, boolean verbose)
+ throws IOException, InterruptedException, IM4JavaException {
+ File f2 = new File(f.getParentFile(), f.getName() + ".jpg");
+ f2.deleteOnExit();
+ ConvertCmd cmd = new ConvertCmd();
+ IMOperation op = new IMOperation();
+ op.autoOrient();
+ op.addImage("VIDEO:" + f.getAbsolutePath() + "[" + FRAME_NUMBER + "]");
+ op.thumbnail(configurationService.getIntProperty("thumbnail.maxwidth", DEFAULT_WIDTH),
+ configurationService.getIntProperty("thumbnail.maxheight", DEFAULT_HEIGHT));
+ op.addImage(f2.getAbsolutePath());
+ if (verbose) {
+ System.out.println("IM Thumbnail Param: " + op);
+ }
+ cmd.run(op);
+ return f2;
+ }
+}
diff --git a/dspace-api/src/main/java/org/dspace/app/mediafilter/MediaFilterCLITool.java b/dspace-api/src/main/java/org/dspace/app/mediafilter/MediaFilterCLITool.java
deleted file mode 100644
index 067419df2245..000000000000
--- a/dspace-api/src/main/java/org/dspace/app/mediafilter/MediaFilterCLITool.java
+++ /dev/null
@@ -1,328 +0,0 @@
-/**
- * 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.mediafilter;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-
-import org.apache.commons.cli.CommandLine;
-import org.apache.commons.cli.CommandLineParser;
-import org.apache.commons.cli.DefaultParser;
-import org.apache.commons.cli.HelpFormatter;
-import org.apache.commons.cli.MissingArgumentException;
-import org.apache.commons.cli.Option;
-import org.apache.commons.cli.Options;
-import org.apache.commons.lang3.ArrayUtils;
-import org.dspace.app.mediafilter.factory.MediaFilterServiceFactory;
-import org.dspace.app.mediafilter.service.MediaFilterService;
-import org.dspace.content.Collection;
-import org.dspace.content.Community;
-import org.dspace.content.DSpaceObject;
-import org.dspace.content.Item;
-import org.dspace.core.Constants;
-import org.dspace.core.Context;
-import org.dspace.core.SelfNamedPlugin;
-import org.dspace.core.factory.CoreServiceFactory;
-import org.dspace.handle.factory.HandleServiceFactory;
-import org.dspace.services.factory.DSpaceServicesFactory;
-
-/**
- * MediaFilterManager is the class that invokes the media/format filters over the
- * repository's content. A few command line flags affect the operation of the
- * MFM: -v verbose outputs all extracted text to STDOUT; -f force forces all
- * bitstreams to be processed, even if they have been before; -n noindex does not
- * recreate index after processing bitstreams; -i [identifier] limits processing
- * scope to a community, collection or item; and -m [max] limits processing to a
- * maximum number of items.
- */
-public class MediaFilterCLITool {
-
- //key (in dspace.cfg) which lists all enabled filters by name
- private static final String MEDIA_FILTER_PLUGINS_KEY = "filter.plugins";
-
- //prefix (in dspace.cfg) for all filter properties
- private static final String FILTER_PREFIX = "filter";
-
- //suffix (in dspace.cfg) for input formats supported by each filter
- private static final String INPUT_FORMATS_SUFFIX = "inputFormats";
-
- /**
- * Default constructor
- */
- private MediaFilterCLITool() { }
-
- public static void main(String[] argv) throws Exception {
- // set headless for non-gui workstations
- System.setProperty("java.awt.headless", "true");
-
- // create an options object and populate it
- CommandLineParser parser = new DefaultParser();
-
- int status = 0;
-
- Options options = new Options();
-
- options.addOption("v", "verbose", false,
- "print all extracted text and other details to STDOUT");
- options.addOption("q", "quiet", false,
- "do not print anything except in the event of errors.");
- options.addOption("f", "force", false,
- "force all bitstreams to be processed");
- options.addOption("i", "identifier", true,
- "ONLY process bitstreams belonging to identifier");
- options.addOption("m", "maximum", true,
- "process no more than maximum items");
- options.addOption("h", "help", false, "help");
-
- //create a "plugin" option (to specify specific MediaFilter plugins to run)
- Option pluginOption = Option.builder("p")
- .longOpt("plugins")
- .hasArg()
- .hasArgs()
- .valueSeparator(',')
- .desc(
- "ONLY run the specified Media Filter plugin(s)\n" +
- "listed from '" + MEDIA_FILTER_PLUGINS_KEY + "' in dspace.cfg.\n" +
- "Separate multiple with a comma (,)\n" +
- "(e.g. MediaFilterManager -p \n\"Word Text Extractor\",\"PDF Text Extractor\")")
- .build();
- options.addOption(pluginOption);
-
- //create a "skip" option (to specify communities/collections/items to skip)
- Option skipOption = Option.builder("s")
- .longOpt("skip")
- .hasArg()
- .hasArgs()
- .valueSeparator(',')
- .desc(
- "SKIP the bitstreams belonging to identifier\n" +
- "Separate multiple identifiers with a comma (,)\n" +
- "(e.g. MediaFilterManager -s \n 123456789/34,123456789/323)")
- .build();
- options.addOption(skipOption);
-
- boolean isVerbose = false;
- boolean isQuiet = false;
- boolean isForce = false; // default to not forced
- String identifier = null; // object scope limiter
- int max2Process = Integer.MAX_VALUE;
- Map> filterFormats = new HashMap<>();
-
- CommandLine line = null;
- try {
- line = parser.parse(options, argv);
- } catch (MissingArgumentException e) {
- System.out.println("ERROR: " + e.getMessage());
- HelpFormatter myhelp = new HelpFormatter();
- myhelp.printHelp("MediaFilterManager\n", options);
- System.exit(1);
- }
-
- if (line.hasOption('h')) {
- HelpFormatter myhelp = new HelpFormatter();
- myhelp.printHelp("MediaFilterManager\n", options);
-
- System.exit(0);
- }
-
- if (line.hasOption('v')) {
- isVerbose = true;
- }
-
- isQuiet = line.hasOption('q');
-
- if (line.hasOption('f')) {
- isForce = true;
- }
-
- if (line.hasOption('i')) {
- identifier = line.getOptionValue('i');
- }
-
- if (line.hasOption('m')) {
- max2Process = Integer.parseInt(line.getOptionValue('m'));
- if (max2Process <= 1) {
- System.out.println("Invalid maximum value '" +
- line.getOptionValue('m') + "' - ignoring");
- max2Process = Integer.MAX_VALUE;
- }
- }
-
- String filterNames[] = null;
- if (line.hasOption('p')) {
- //specified which media filter plugins we are using
- filterNames = line.getOptionValues('p');
-
- if (filterNames == null || filterNames.length == 0) { //display error, since no plugins specified
- System.err.println("\nERROR: -p (-plugin) option requires at least one plugin to be specified.\n" +
- "(e.g. MediaFilterManager -p \"Word Text Extractor\",\"PDF Text Extractor\")\n");
- HelpFormatter myhelp = new HelpFormatter();
- myhelp.printHelp("MediaFilterManager\n", options);
- System.exit(1);
- }
- } else {
- //retrieve list of all enabled media filter plugins!
- filterNames = DSpaceServicesFactory.getInstance().getConfigurationService()
- .getArrayProperty(MEDIA_FILTER_PLUGINS_KEY);
- }
-
- MediaFilterService mediaFilterService = MediaFilterServiceFactory.getInstance().getMediaFilterService();
- mediaFilterService.setForce(isForce);
- mediaFilterService.setQuiet(isQuiet);
- mediaFilterService.setVerbose(isVerbose);
- mediaFilterService.setMax2Process(max2Process);
-
- //initialize an array of our enabled filters
- List filterList = new ArrayList<>();
-
- //set up each filter
- for (int i = 0; i < filterNames.length; i++) {
- //get filter of this name & add to list of filters
- FormatFilter filter = (FormatFilter) CoreServiceFactory.getInstance().getPluginService()
- .getNamedPlugin(FormatFilter.class, filterNames[i]);
- if (filter == null) {
- System.err.println(
- "\nERROR: Unknown MediaFilter specified (either from command-line or in dspace.cfg): '" +
- filterNames[i] + "'");
- System.exit(1);
- } else {
- filterList.add(filter);
-
- String filterClassName = filter.getClass().getName();
-
- String pluginName = null;
-
- //If this filter is a SelfNamedPlugin,
- //then the input formats it accepts may differ for
- //each "named" plugin that it defines.
- //So, we have to look for every key that fits the
- //following format: filter...inputFormats
- if (SelfNamedPlugin.class.isAssignableFrom(filter.getClass())) {
- //Get the plugin instance name for this class
- pluginName = ((SelfNamedPlugin) filter).getPluginInstanceName();
- }
-
-
- //Retrieve our list of supported formats from dspace.cfg
- //For SelfNamedPlugins, format of key is:
- // filter.