void uncacheEntity(E entity) throws SQLException;
+
+ /**
+ * Do a manual flush. This synchronizes the in-memory state of the Session
+ * with the database (write changes to the database)
+ *
+ * @throws SQLException passed through.
+ */
+ public void flushSession() throws SQLException;
}
diff --git a/dspace-api/src/main/java/org/dspace/core/Email.java b/dspace-api/src/main/java/org/dspace/core/Email.java
index 998d934c9558..2c8d7cdec4e5 100644
--- a/dspace-api/src/main/java/org/dspace/core/Email.java
+++ b/dspace-api/src/main/java/org/dspace/core/Email.java
@@ -21,7 +21,6 @@
import java.util.Collections;
import java.util.Date;
import java.util.Enumeration;
-import java.util.Iterator;
import java.util.List;
import java.util.Properties;
import javax.activation.DataHandler;
@@ -41,7 +40,6 @@
import javax.mail.internet.MimeMultipart;
import javax.mail.internet.ParseException;
-import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.velocity.Template;
@@ -57,26 +55,40 @@
import org.dspace.services.factory.DSpaceServicesFactory;
/**
- * Class representing an e-mail message, also used to send e-mails.
+ * Class representing an e-mail message. The {@link send} method causes the
+ * assembled message to be formatted and sent.
*
* Typical use:
- *
+ *
+ * Email email = Email.getEmail(path);
+ * email.addRecipient("foo@bar.com");
+ * email.addArgument("John");
+ * email.addArgument("On the Testing of DSpace");
+ * email.send();
+ *
+ * {@code path} is the filesystem path of an email template, typically in
+ * {@code ${dspace.dir}/config/emails/} and can include the subject -- see
+ * below. Templates are processed by
+ * Apache Velocity. They may contain VTL directives and property
+ * placeholders.
+ *
+ * {@link addArgument(string)} adds a property to the {@code params} array
+ * in the Velocity context, which can be used to replace placeholder tokens
+ * in the message. These arguments are indexed by number in the order they were
+ * added to the message.
+ *
+ * The DSpace configuration properties are also available to templates as the
+ * array {@code config}, indexed by name. Example: {@code ${config.get('dspace.name')}}
+ *
+ * Recipients and attachments may be added as needed. See {@link addRecipient},
+ * {@link addAttachment(File, String)}, and
+ * {@link addAttachment(InputStream, String, String)}.
*
- * Email email = new Email();
- * email.addRecipient("foo@bar.com");
- * email.addArgument("John");
- * email.addArgument("On the Testing of DSpace");
- * email.send();
- *
+ * Headers such as Subject may be supplied by the template, by defining them
+ * using the VTL directive {@code #set()}. Only headers named in the DSpace
+ * configuration array property {@code mail.message.headers} will be added.
*
- * name is the name of an email template in
- * dspace-dir/config/emails/ (which also includes the subject.)
- * arg0 and arg1 are arguments to fill out the
- * message with.
- *
- * Emails are formatted using Apache Velocity. Headers such as Subject may be
- * supplied by the template, by defining them using #set(). Example:
- *
+ * Example:
*
*
*
@@ -91,12 +103,14 @@
*
* Thank you for sending us your submission "${params[1]}".
*
+ * --
+ * The ${config.get('dspace.name')} Team
+ *
*
*
*
* If the example code above was used to send this mail, the resulting mail
* would have the subject Example e-mail and the body would be:
- *
*
*
*
@@ -105,7 +119,16 @@
*
* Thank you for sending us your submission "On the Testing of DSpace".
*
+ * --
+ * The DSpace Team
+ *
*
+ *
+ * There are two ways to load a message body. One can create an instance of
+ * {@link Email} and call {@link setContent} on it, passing the body as a String. Or
+ * one can use the static factory method {@link getEmail} to load a file by its
+ * complete filesystem path. In either case the text will be loaded into a
+ * Velocity template.
*
* @author Robert Tansley
* @author Jim Downing - added attachment handling code
@@ -115,7 +138,6 @@ public class Email {
/**
* The content of the message
*/
- private String content;
private String contentName;
/**
@@ -176,13 +198,12 @@ public Email() {
moreAttachments = new ArrayList<>(10);
subject = "";
template = null;
- content = "";
replyTo = null;
charset = null;
}
/**
- * Add a recipient
+ * Add a recipient.
*
* @param email the recipient's email address
*/
@@ -196,16 +217,24 @@ public void addRecipient(String email) {
* "Subject:" line must be stripped.
*
* @param name a name for this message body
- * @param cnt the content of the message
+ * @param content the content of the message
*/
- public void setContent(String name, String cnt) {
- content = cnt;
+ public void setContent(String name, String content) {
contentName = name;
arguments.clear();
+
+ VelocityEngine templateEngine = new VelocityEngine();
+ templateEngine.init(VELOCITY_PROPERTIES);
+
+ StringResourceRepository repo = (StringResourceRepository)
+ templateEngine.getApplicationAttribute(RESOURCE_REPOSITORY_NAME);
+ repo.putStringResource(contentName, content);
+ // Turn content into a template.
+ template = templateEngine.getTemplate(contentName);
}
/**
- * Set the subject of the message
+ * Set the subject of the message.
*
* @param s the subject of the message
*/
@@ -214,7 +243,7 @@ public void setSubject(String s) {
}
/**
- * Set the reply-to email address
+ * Set the reply-to email address.
*
* @param email the reply-to email address
*/
@@ -223,7 +252,7 @@ public void setReplyTo(String email) {
}
/**
- * Fill out the next argument in the template
+ * Fill out the next argument in the template.
*
* @param arg the value for the next argument
*/
@@ -231,6 +260,13 @@ public void addArgument(Object arg) {
arguments.add(arg);
}
+ /**
+ * Add an attachment bodypart to the message from an external file.
+ *
+ * @param f reference to a file to be attached.
+ * @param name a name for the resulting bodypart in the message's MIME
+ * structure.
+ */
public void addAttachment(File f, String name) {
attachments.add(new FileAttachment(f, name));
}
@@ -238,6 +274,17 @@ public void addAttachment(File f, String name) {
/** When given a bad MIME type for an attachment, use this instead. */
private static final String DEFAULT_ATTACHMENT_TYPE = "application/octet-stream";
+ /**
+ * Add an attachment bodypart to the message from a byte stream.
+ *
+ * @param is the content of this stream will become the content of the
+ * bodypart.
+ * @param name a name for the resulting bodypart in the message's MIME
+ * structure.
+ * @param mimetype the MIME type of the resulting bodypart, such as
+ * "text/pdf". If {@code null} it will default to
+ * "application/octet-stream", which is MIME for "unknown format".
+ */
public void addAttachment(InputStream is, String name, String mimetype) {
if (null == mimetype) {
LOG.error("Null MIME type replaced with '" + DEFAULT_ATTACHMENT_TYPE
@@ -257,6 +304,11 @@ public void addAttachment(InputStream is, String name, String mimetype) {
moreAttachments.add(new InputStreamAttachment(is, name, mimetype));
}
+ /**
+ * Set the character set of the message.
+ *
+ * @param cs the name of a character set, such as "UTF-8" or "EUC-JP".
+ */
public void setCharset(String cs) {
charset = cs;
}
@@ -280,15 +332,20 @@ public void reset() {
* {@code mail.message.headers} then that name and its value will be added
* to the message's headers.
*
- *
"subject" is treated specially: if {@link setSubject()} has not been called,
- * the value of any "subject" property will be used as if setSubject had
- * been called with that value. Thus a template may define its subject, but
- * the caller may override it.
+ *
"subject" is treated specially: if {@link setSubject()} has not been
+ * called, the value of any "subject" property will be used as if setSubject
+ * had been called with that value. Thus a template may define its subject,
+ * but the caller may override it.
*
* @throws MessagingException if there was a problem sending the mail.
* @throws IOException if IO error
*/
public void send() throws MessagingException, IOException {
+ if (null == template) {
+ // No template -- no content -- PANIC!!!
+ throw new MessagingException("Email has no body");
+ }
+
ConfigurationService config
= DSpaceServicesFactory.getInstance().getConfigurationService();
@@ -308,23 +365,19 @@ public void send() throws MessagingException, IOException {
MimeMessage message = new MimeMessage(session);
// Set the recipients of the message
- Iterator i = recipients.iterator();
-
- while (i.hasNext()) {
- message.addRecipient(Message.RecipientType.TO, new InternetAddress(
- i.next()));
+ for (String recipient : recipients) {
+ message.addRecipient(Message.RecipientType.TO,
+ new InternetAddress(recipient));
}
// Get headers defined by the template.
String[] templateHeaders = config.getArrayProperty("mail.message.headers");
// Format the mail message body
- VelocityEngine templateEngine = new VelocityEngine();
- templateEngine.init(VELOCITY_PROPERTIES);
-
VelocityContext vctx = new VelocityContext();
vctx.put("config", new UnmodifiableConfigurationService(config));
vctx.put("params", Collections.unmodifiableList(arguments));
+<<<<<<< HEAD
if (null == template) {
if (StringUtils.isBlank(content)) {
// No template and no content -- PANIC!!!
@@ -339,6 +392,8 @@ public void send() throws MessagingException, IOException {
templateHeaders = new String[] {};
}
+=======
+>>>>>>> dspace-7.6.1
StringWriter writer = new StringWriter();
try {
template.merge(vctx, writer);
@@ -405,7 +460,8 @@ public void send() throws MessagingException, IOException {
// add the stream
messageBodyPart = new MimeBodyPart();
messageBodyPart.setDataHandler(new DataHandler(
- new InputStreamDataSource(attachment.name,attachment.mimetype,attachment.is)));
+ new InputStreamDataSource(attachment.name,
+ attachment.mimetype, attachment.is)));
messageBodyPart.setFileName(attachment.name);
multipart.addBodyPart(messageBodyPart);
}
@@ -447,6 +503,9 @@ public void send() throws MessagingException, IOException {
/**
* Get the VTL template for an email message. The message is suitable
* for inserting values using Apache Velocity.
+ *
+ * Note that everything is stored here, so that only send() throws a
+ * MessagingException.
*
* @param emailFile
* full name for the email template, for example "/dspace/config/emails/register".
@@ -484,15 +543,6 @@ public static Email getEmail(String emailFile)
}
return email;
}
- /*
- * Implementation note: It might be necessary to add a quick utility method
- * like "send(to, subject, message)". We'll see how far we get without it -
- * having all emails as templates in the config allows customisation and
- * internationalisation.
- *
- * Note that everything is stored and the run in send() so that only send()
- * throws a MessagingException.
- */
/**
* Test method to send an email to check email server settings
@@ -547,7 +597,7 @@ public static void main(String[] args) {
}
/**
- * Utility struct class for handling file attachments.
+ * Utility record class for handling file attachments.
*
* @author ojd20
*/
@@ -563,7 +613,7 @@ public FileAttachment(File f, String n) {
}
/**
- * Utility struct class for handling file attachments.
+ * Utility record class for handling file attachments.
*
* @author Adán Román Ruiz at arvo.es
*/
@@ -580,6 +630,8 @@ public InputStreamAttachment(InputStream is, String name, String mimetype) {
}
/**
+ * Wrap an {@link InputStream} in a {@link DataSource}.
+ *
* @author arnaldo
*/
public static class InputStreamDataSource implements DataSource {
@@ -587,6 +639,14 @@ public static class InputStreamDataSource implements DataSource {
private final String contentType;
private final ByteArrayOutputStream baos;
+ /**
+ * Consume the content of an InputStream and store it in a local buffer.
+ *
+ * @param name give the DataSource a name.
+ * @param contentType the DataSource contains this type of data.
+ * @param inputStream content to be buffered in the DataSource.
+ * @throws IOException if the stream cannot be read.
+ */
InputStreamDataSource(String name, String contentType, InputStream inputStream) throws IOException {
this.name = name;
this.contentType = contentType;
diff --git a/dspace-api/src/main/java/org/dspace/core/HibernateDBConnection.java b/dspace-api/src/main/java/org/dspace/core/HibernateDBConnection.java
index 3321e4d837e5..b371af80eede 100644
--- a/dspace-api/src/main/java/org/dspace/core/HibernateDBConnection.java
+++ b/dspace-api/src/main/java/org/dspace/core/HibernateDBConnection.java
@@ -337,4 +337,17 @@ public void uncacheEntity(E entity) throws SQLExcep
}
}
}
+
+ /**
+ * Do a manual flush. This synchronizes the in-memory state of the Session
+ * with the database (write changes to the database)
+ *
+ * @throws SQLException passed through.
+ */
+ @Override
+ public void flushSession() throws SQLException {
+ if (getSession().isDirty()) {
+ getSession().flush();
+ }
+ }
}
diff --git a/dspace-api/src/main/java/org/dspace/core/LicenseServiceImpl.java b/dspace-api/src/main/java/org/dspace/core/LicenseServiceImpl.java
index 8324105a3085..d895f9a76481 100644
--- a/dspace-api/src/main/java/org/dspace/core/LicenseServiceImpl.java
+++ b/dspace-api/src/main/java/org/dspace/core/LicenseServiceImpl.java
@@ -17,9 +17,12 @@
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
+import javax.servlet.http.HttpServletRequest;
import org.dspace.core.service.LicenseService;
import org.dspace.services.factory.DSpaceServicesFactory;
+import org.dspace.services.model.Request;
+import org.dspace.web.ContextUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -101,13 +104,14 @@ public String getLicenseText(String licenseFile) {
/**
* Get the site-wide default license that submitters need to grant
*
+ * Localized license requires: default_{{locale}}.license file.
+ * Locale also must be listed in webui.supported.locales setting.
+ *
* @return the default license
*/
@Override
public String getDefaultSubmissionLicense() {
- if (null == license) {
- init();
- }
+ init();
return license;
}
@@ -115,9 +119,8 @@ public String getDefaultSubmissionLicense() {
* Load in the default license.
*/
protected void init() {
- File licenseFile = new File(
- DSpaceServicesFactory.getInstance().getConfigurationService().getProperty("dspace.dir")
- + File.separator + "config" + File.separator + "default.license");
+ Context context = obtainContext();
+ File licenseFile = new File(I18nUtil.getDefaultLicense(context));
FileInputStream fir = null;
InputStreamReader ir = null;
@@ -169,4 +172,24 @@ protected void init() {
}
}
}
+
+ /**
+ * Obtaining current request context.
+ * Return new context if getting one from current request failed.
+ *
+ * @return DSpace context object
+ */
+ private Context obtainContext() {
+ try {
+ Request currentRequest = DSpaceServicesFactory.getInstance().getRequestService().getCurrentRequest();
+ if (currentRequest != null) {
+ HttpServletRequest request = currentRequest.getHttpServletRequest();
+ return ContextUtil.obtainContext(request);
+ }
+ } catch (Exception e) {
+ log.error("Can't load current request context.");
+ }
+
+ return new Context();
+ }
}
diff --git a/dspace-api/src/main/java/org/dspace/core/Utils.java b/dspace-api/src/main/java/org/dspace/core/Utils.java
index b9fff20c7674..ea9ed57eca04 100644
--- a/dspace-api/src/main/java/org/dspace/core/Utils.java
+++ b/dspace-api/src/main/java/org/dspace/core/Utils.java
@@ -16,8 +16,6 @@
import java.net.Inet4Address;
import java.net.InetAddress;
import java.net.MalformedURLException;
-import java.net.URI;
-import java.net.URISyntaxException;
import java.net.URL;
import java.net.UnknownHostException;
import java.nio.charset.StandardCharsets;
@@ -415,7 +413,9 @@ public static String[] tokenize(String metadata) {
* @return metadata field key
*/
public static String standardize(String schema, String element, String qualifier, String separator) {
- if (StringUtils.isBlank(qualifier)) {
+ if (StringUtils.isBlank(element)) {
+ return null;
+ } else if (StringUtils.isBlank(qualifier)) {
return schema + separator + element;
} else {
return schema + separator + element + separator + qualifier;
@@ -447,14 +447,14 @@ public static String getBaseUrl(String urlString) {
*/
public static String getHostName(String uriString) {
try {
- URI uri = new URI(uriString);
- String hostname = uri.getHost();
+ URL url = new URL(uriString);
+ String hostname = url.getHost();
// remove the "www." from hostname, if it exists
if (hostname != null) {
return hostname.startsWith("www.") ? hostname.substring(4) : hostname;
}
return null;
- } catch (URISyntaxException e) {
+ } catch (MalformedURLException e) {
return null;
}
}
diff --git a/dspace-api/src/main/java/org/dspace/ctask/general/MetadataWebService.java b/dspace-api/src/main/java/org/dspace/ctask/general/MetadataWebService.java
index f7ab18c01e54..5891fa017cb0 100644
--- a/dspace-api/src/main/java/org/dspace/ctask/general/MetadataWebService.java
+++ b/dspace-api/src/main/java/org/dspace/ctask/general/MetadataWebService.java
@@ -207,9 +207,10 @@ public void init(Curator curator, String taskId) throws IOException {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
factory.setNamespaceAware(true);
try {
- // disallow DTD parsing to ensure no XXE attacks can occur.
+ // disallow DTD parsing to ensure no XXE attacks can occur
// See https://cheatsheetseries.owasp.org/cheatsheets/XML_External_Entity_Prevention_Cheat_Sheet.html
factory.setFeature("http://apache.org/xml/features/disallow-doctype-decl", true);
+ factory.setXIncludeAware(false);
docBuilder = factory.newDocumentBuilder();
} catch (ParserConfigurationException pcE) {
log.error("caught exception: " + pcE);
diff --git a/dspace-api/src/main/java/org/dspace/curate/Curation.java b/dspace-api/src/main/java/org/dspace/curate/Curation.java
index b3af072a32cd..4d70286e79e0 100644
--- a/dspace-api/src/main/java/org/dspace/curate/Curation.java
+++ b/dspace-api/src/main/java/org/dspace/curate/Curation.java
@@ -152,17 +152,10 @@ private long runQueue(TaskQueue queue, Curator curator) throws SQLException, Aut
super.handler.logInfo("Curating id: " + entry.getObjectId());
}
curator.clear();
- // does entry relate to a DSO or workflow object?
- if (entry.getObjectId().indexOf('/') > 0) {
- for (String taskName : entry.getTaskNames()) {
- curator.addTask(taskName);
- }
- curator.curate(context, entry.getObjectId());
- } else {
- // TODO: Remove this exception once curation tasks are supported by configurable workflow
- // e.g. see https://github.com/DSpace/DSpace/pull/3157
- throw new IllegalArgumentException("curation for workflow items is no longer supported");
+ for (String taskName : entry.getTaskNames()) {
+ curator.addTask(taskName);
}
+ curator.curate(context, entry.getObjectId());
}
queue.release(this.queue, ticket, true);
return ticket;
diff --git a/dspace-api/src/main/java/org/dspace/curate/CurationScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/curate/CurationScriptConfiguration.java
index fefb4eb768ea..2587e6b0251e 100644
--- a/dspace-api/src/main/java/org/dspace/curate/CurationScriptConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/curate/CurationScriptConfiguration.java
@@ -8,12 +8,15 @@
package org.dspace.curate;
import java.sql.SQLException;
+import java.util.List;
import org.apache.commons.cli.Options;
-import org.dspace.authorize.service.AuthorizeService;
+import org.dspace.content.DSpaceObject;
import org.dspace.core.Context;
+import org.dspace.handle.factory.HandleServiceFactory;
+import org.dspace.handle.service.HandleService;
+import org.dspace.scripts.DSpaceCommandLineParameter;
import org.dspace.scripts.configuration.ScriptConfiguration;
-import org.springframework.beans.factory.annotation.Autowired;
/**
* The {@link ScriptConfiguration} for the {@link Curation} script
@@ -22,9 +25,6 @@
*/
public class CurationScriptConfiguration extends ScriptConfiguration {
- @Autowired
- private AuthorizeService authorizeService;
-
private Class dspaceRunnableClass;
@Override
@@ -38,16 +38,37 @@ public void setDspaceRunnableClass(Class dspaceRunnableClass) {
}
/**
- * Only admin can run Curation script via the scripts and processes endpoints.
- * @param context The relevant DSpace context
- * @return True if currentUser is admin, otherwise false
+ * Only repository admins or admins of the target object can run Curation script via the scripts
+ * and processes endpoints.
+ *
+ * @param context The relevant DSpace context
+ * @param commandLineParameters the parameters that will be used to start the process if known,
+ * null otherwise
+ * @return true if the currentUser is allowed to run the script with the specified parameters or
+ * at least in some case if the parameters are not yet known
*/
@Override
- public boolean isAllowedToExecute(Context context) {
+ public boolean isAllowedToExecute(Context context, List commandLineParameters) {
try {
- return authorizeService.isAdmin(context);
+ if (commandLineParameters == null) {
+ return authorizeService.isAdmin(context) || authorizeService.isComColAdmin(context)
+ || authorizeService.isItemAdmin(context);
+ } else if (commandLineParameters.stream()
+ .map(DSpaceCommandLineParameter::getName)
+ .noneMatch("-i"::equals)) {
+ return authorizeService.isAdmin(context);
+ } else {
+ String dspaceObjectID = commandLineParameters.stream()
+ .filter(parameter -> "-i".equals(parameter.getName()))
+ .map(DSpaceCommandLineParameter::getValue)
+ .findFirst()
+ .get();
+ HandleService handleService = HandleServiceFactory.getInstance().getHandleService();
+ DSpaceObject dso = handleService.resolveToObject(context, dspaceObjectID);
+ return authorizeService.isAdmin(context, dso);
+ }
} catch (SQLException e) {
- throw new RuntimeException("SQLException occurred when checking if the current user is an admin", e);
+ throw new RuntimeException(e);
}
}
diff --git a/dspace-api/src/main/java/org/dspace/curate/XmlWorkflowCuratorServiceImpl.java b/dspace-api/src/main/java/org/dspace/curate/XmlWorkflowCuratorServiceImpl.java
index 05c7a8d99930..27a162d543c2 100644
--- a/dspace-api/src/main/java/org/dspace/curate/XmlWorkflowCuratorServiceImpl.java
+++ b/dspace-api/src/main/java/org/dspace/curate/XmlWorkflowCuratorServiceImpl.java
@@ -13,6 +13,8 @@
import java.util.ArrayList;
import java.util.List;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Collection;
@@ -30,6 +32,7 @@
import org.dspace.workflow.FlowStep;
import org.dspace.workflow.Task;
import org.dspace.workflow.TaskSet;
+import org.dspace.xmlworkflow.Role;
import org.dspace.xmlworkflow.RoleMembers;
import org.dspace.xmlworkflow.WorkflowConfigurationException;
import org.dspace.xmlworkflow.factory.XmlWorkflowFactory;
@@ -47,14 +50,17 @@
* Manage interactions between curation and workflow. A curation task can be
* attached to a workflow step, to be executed during the step.
*
+ *
+ * NOTE: when run in workflow, curation tasks run with
+ * authorization disabled.
+ *
* @see CurationTaskConfig
* @author mwood
*/
@Service
public class XmlWorkflowCuratorServiceImpl
implements XmlWorkflowCuratorService {
- private static final Logger LOG
- = org.apache.logging.log4j.LogManager.getLogger();
+ private static final Logger LOG = LogManager.getLogger();
@Autowired(required = true)
protected XmlWorkflowFactory workflowFactory;
@@ -97,7 +103,18 @@ public boolean doCuration(Context c, XmlWorkflowItem wfi)
throws AuthorizeException, IOException, SQLException {
Curator curator = new Curator();
curator.setReporter(reporter);
- return curate(curator, c, wfi);
+ c.turnOffAuthorisationSystem();
+ boolean wasAnonymous = false;
+ if (null == c.getCurrentUser()) { // We need someone to email
+ wasAnonymous = true;
+ c.setCurrentUser(ePersonService.getSystemEPerson(c));
+ }
+ boolean failedP = curate(curator, c, wfi);
+ if (wasAnonymous) {
+ c.setCurrentUser(null);
+ }
+ c.restoreAuthSystemState();
+ return failedP;
}
@Override
@@ -123,40 +140,48 @@ public boolean curate(Curator curator, Context c, XmlWorkflowItem wfi)
item.setOwningCollection(wfi.getCollection());
for (Task task : step.tasks) {
curator.addTask(task.name);
- curator.curate(item);
- int status = curator.getStatus(task.name);
- String result = curator.getResult(task.name);
- String action = "none";
- switch (status) {
- case Curator.CURATE_FAIL:
- // task failed - notify any contacts the task has assigned
- if (task.powers.contains("reject")) {
- action = "reject";
- }
- notifyContacts(c, wfi, task, "fail", action, result);
- // if task so empowered, reject submission and terminate
- if ("reject".equals(action)) {
- workflowService.sendWorkflowItemBackSubmission(c, wfi,
- c.getCurrentUser(), null,
- task.name + ": " + result);
- return false;
- }
- break;
- case Curator.CURATE_SUCCESS:
- if (task.powers.contains("approve")) {
- action = "approve";
- }
- notifyContacts(c, wfi, task, "success", action, result);
- if ("approve".equals(action)) {
- // cease further task processing and advance submission
- return true;
- }
- break;
- case Curator.CURATE_ERROR:
- notifyContacts(c, wfi, task, "error", action, result);
- break;
- default:
- break;
+
+ // Check whether the task is configured to be queued rather than automatically run
+ if (StringUtils.isNotEmpty(step.queue)) {
+ // queue attribute has been set in the FlowStep configuration: add task to configured queue
+ curator.queue(c, item.getID().toString(), step.queue);
+ } else {
+ // Task is configured to be run automatically
+ curator.curate(c, item);
+ int status = curator.getStatus(task.name);
+ String result = curator.getResult(task.name);
+ String action = "none";
+ switch (status) {
+ case Curator.CURATE_FAIL:
+ // task failed - notify any contacts the task has assigned
+ if (task.powers.contains("reject")) {
+ action = "reject";
+ }
+ notifyContacts(c, wfi, task, "fail", action, result);
+ // if task so empowered, reject submission and terminate
+ if ("reject".equals(action)) {
+ workflowService.sendWorkflowItemBackSubmission(c, wfi,
+ c.getCurrentUser(), null,
+ task.name + ": " + result);
+ return false;
+ }
+ break;
+ case Curator.CURATE_SUCCESS:
+ if (task.powers.contains("approve")) {
+ action = "approve";
+ }
+ notifyContacts(c, wfi, task, "success", action, result);
+ if ("approve".equals(action)) {
+ // cease further task processing and advance submission
+ return true;
+ }
+ break;
+ case Curator.CURATE_ERROR:
+ notifyContacts(c, wfi, task, "error", action, result);
+ break;
+ default:
+ break;
+ }
}
curator.clear();
}
@@ -223,8 +248,12 @@ protected void notifyContacts(Context c, XmlWorkflowItem wfi,
String status, String action, String message)
throws AuthorizeException, IOException, SQLException {
List epa = resolveContacts(c, task.getContacts(status), wfi);
- if (epa.size() > 0) {
+ if (!epa.isEmpty()) {
workflowService.notifyOfCuration(c, wfi, epa, task.name, action, message);
+ } else {
+ LOG.warn("No contacts were found for workflow item {}: "
+ + "task {} returned action {} with message {}",
+ wfi.getID(), task.name, action, message);
}
}
@@ -247,8 +276,7 @@ protected List resolveContacts(Context c, List contacts,
// decode contacts
if ("$flowgroup".equals(contact)) {
// special literal for current flowgoup
- ClaimedTask claimedTask = claimedTaskService.findByWorkflowIdAndEPerson(c, wfi, c.getCurrentUser());
- String stepID = claimedTask.getStepID();
+ String stepID = getFlowStep(c, wfi).step;
Step step;
try {
Workflow workflow = workflowFactory.getWorkflow(wfi.getCollection());
@@ -258,19 +286,26 @@ protected List resolveContacts(Context c, List contacts,
String.valueOf(wfi.getID()), e);
return epList;
}
- RoleMembers roleMembers = step.getRole().getMembers(c, wfi);
- for (EPerson ep : roleMembers.getEPersons()) {
- epList.add(ep);
- }
- for (Group group : roleMembers.getGroups()) {
- epList.addAll(group.getMembers());
+ Role role = step.getRole();
+ if (null != role) {
+ RoleMembers roleMembers = role.getMembers(c, wfi);
+ for (EPerson ep : roleMembers.getEPersons()) {
+ epList.add(ep);
+ }
+ for (Group group : roleMembers.getGroups()) {
+ epList.addAll(group.getMembers());
+ }
+ } else {
+ epList.add(ePersonService.getSystemEPerson(c));
}
} else if ("$colladmin".equals(contact)) {
+ // special literal for collection administrators
Group adGroup = wfi.getCollection().getAdministrators();
if (adGroup != null) {
epList.addAll(groupService.allMembers(c, adGroup));
}
} else if ("$siteadmin".equals(contact)) {
+ // special literal for site administrator
EPerson siteEp = ePersonService.findByEmail(c,
configurationService.getProperty("mail.admin"));
if (siteEp != null) {
diff --git a/dspace-api/src/main/java/org/dspace/curate/service/XmlWorkflowCuratorService.java b/dspace-api/src/main/java/org/dspace/curate/service/XmlWorkflowCuratorService.java
index 2ad1eac12904..778b779cfe03 100644
--- a/dspace-api/src/main/java/org/dspace/curate/service/XmlWorkflowCuratorService.java
+++ b/dspace-api/src/main/java/org/dspace/curate/service/XmlWorkflowCuratorService.java
@@ -42,9 +42,9 @@ public boolean needsCuration(Context c, XmlWorkflowItem wfi)
*
* @param c the context
* @param wfi the workflow item
- * @return true if curation was completed or not required,
+ * @return true if curation was completed or not required;
* false if tasks were queued for later completion,
- * or item was rejected
+ * or item was rejected.
* @throws AuthorizeException if authorization error
* @throws IOException if IO error
* @throws SQLException if database error
@@ -58,7 +58,9 @@ public boolean doCuration(Context c, XmlWorkflowItem wfi)
* @param curator the curation context
* @param c the user context
* @param wfId the workflow item's ID
- * @return true if curation failed.
+ * @return true if curation curation was completed or not required;
+ * false if tasks were queued for later completion,
+ * or item was rejected.
* @throws AuthorizeException if authorization error
* @throws IOException if IO error
* @throws SQLException if database error
@@ -72,7 +74,9 @@ public boolean curate(Curator curator, Context c, String wfId)
* @param curator the curation context
* @param c the user context
* @param wfi the workflow item
- * @return true if curation failed.
+ * @return true if workflow curation was completed or not required;
+ * false if tasks were queued for later completion,
+ * or item was rejected.
* @throws AuthorizeException if authorization error
* @throws IOException if IO error
* @throws SQLException if database error
diff --git a/dspace-api/src/main/java/org/dspace/discovery/FullTextContentStreams.java b/dspace-api/src/main/java/org/dspace/discovery/FullTextContentStreams.java
index ee220e5a4fdf..21468def6866 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/FullTextContentStreams.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/FullTextContentStreams.java
@@ -76,14 +76,19 @@ private void buildFullTextList(Item parentItem) {
if (StringUtils.equals(FULLTEXT_BUNDLE, myBundle.getName())) {
// a-ha! grab the text out of the bitstreams
List bitstreams = myBundle.getBitstreams();
+ log.debug("Processing full-text bitstreams. Item handle: " + sourceInfo);
for (Bitstream fulltextBitstream : emptyIfNull(bitstreams)) {
fullTextStreams.add(new FullTextBitstream(sourceInfo, fulltextBitstream));
- log.debug("Added BitStream: "
- + fulltextBitstream.getStoreNumber() + " "
- + fulltextBitstream.getSequenceID() + " "
- + fulltextBitstream.getName());
+ if (fulltextBitstream != null) {
+ log.debug("Added BitStream: "
+ + fulltextBitstream.getStoreNumber() + " "
+ + fulltextBitstream.getSequenceID() + " "
+ + fulltextBitstream.getName());
+ } else {
+ log.error("Found a NULL bitstream when processing full-text files: item handle:" + sourceInfo);
+ }
}
}
}
@@ -158,16 +163,16 @@ public FullTextBitstream(final String parentHandle, final Bitstream file) {
}
public String getContentType(final Context context) throws SQLException {
- BitstreamFormat format = bitstream.getFormat(context);
+ BitstreamFormat format = bitstream != null ? bitstream.getFormat(context) : null;
return format == null ? null : StringUtils.trimToEmpty(format.getMIMEType());
}
public String getFileName() {
- return StringUtils.trimToEmpty(bitstream.getName());
+ return bitstream != null ? StringUtils.trimToEmpty(bitstream.getName()) : null;
}
public long getSize() {
- return bitstream.getSizeBytes();
+ return bitstream != null ? bitstream.getSizeBytes() : -1;
}
public InputStream getInputStream() throws SQLException, IOException, AuthorizeException {
diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java
index fcb3e79d1d4b..661c48d91cfc 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/IndexClient.java
@@ -56,37 +56,18 @@ public void internalRun() throws Exception {
* new DSpace.getServiceManager().getServiceByName("org.dspace.discovery.SolrIndexer");
*/
- if (indexClientOptions == IndexClientOptions.REMOVE) {
- handler.logInfo("Removing " + commandLine.getOptionValue("r") + " from Index");
- indexer.unIndexContent(context, commandLine.getOptionValue("r"));
- } else if (indexClientOptions == IndexClientOptions.CLEAN) {
- handler.logInfo("Cleaning Index");
- indexer.cleanIndex();
- } else if (indexClientOptions == IndexClientOptions.DELETE) {
- handler.logInfo("Deleting Index");
- indexer.deleteIndex();
- } else if (indexClientOptions == IndexClientOptions.BUILD ||
- indexClientOptions == IndexClientOptions.BUILDANDSPELLCHECK) {
- handler.logInfo("(Re)building index from scratch.");
- indexer.deleteIndex();
- indexer.createIndex(context);
- if (indexClientOptions == IndexClientOptions.BUILDANDSPELLCHECK) {
- checkRebuildSpellCheck(commandLine, indexer);
- }
- } else if (indexClientOptions == IndexClientOptions.OPTIMIZE) {
- handler.logInfo("Optimizing search core.");
- indexer.optimize();
- } else if (indexClientOptions == IndexClientOptions.SPELLCHECK) {
- checkRebuildSpellCheck(commandLine, indexer);
- } else if (indexClientOptions == IndexClientOptions.INDEX) {
- final String param = commandLine.getOptionValue('i');
+ Optional indexableObject = Optional.empty();
+
+ if (indexClientOptions == IndexClientOptions.REMOVE || indexClientOptions == IndexClientOptions.INDEX) {
+ final String param = indexClientOptions == IndexClientOptions.REMOVE ? commandLine.getOptionValue('r') :
+ commandLine.getOptionValue('i');
UUID uuid = null;
try {
uuid = UUID.fromString(param);
} catch (Exception e) {
- // nothing to do, it should be an handle
+ // nothing to do, it should be a handle
}
- Optional indexableObject = Optional.empty();
+
if (uuid != null) {
final Item item = ContentServiceFactory.getInstance().getItemService().find(context, uuid);
if (item != null) {
@@ -118,7 +99,32 @@ public void internalRun() throws Exception {
if (!indexableObject.isPresent()) {
throw new IllegalArgumentException("Cannot resolve " + param + " to a DSpace object");
}
- handler.logInfo("Indexing " + param + " force " + commandLine.hasOption("f"));
+ }
+
+ if (indexClientOptions == IndexClientOptions.REMOVE) {
+ handler.logInfo("Removing " + commandLine.getOptionValue("r") + " from Index");
+ indexer.unIndexContent(context, indexableObject.get().getUniqueIndexID());
+ } else if (indexClientOptions == IndexClientOptions.CLEAN) {
+ handler.logInfo("Cleaning Index");
+ indexer.cleanIndex();
+ } else if (indexClientOptions == IndexClientOptions.DELETE) {
+ handler.logInfo("Deleting Index");
+ indexer.deleteIndex();
+ } else if (indexClientOptions == IndexClientOptions.BUILD ||
+ indexClientOptions == IndexClientOptions.BUILDANDSPELLCHECK) {
+ handler.logInfo("(Re)building index from scratch.");
+ indexer.deleteIndex();
+ indexer.createIndex(context);
+ if (indexClientOptions == IndexClientOptions.BUILDANDSPELLCHECK) {
+ checkRebuildSpellCheck(commandLine, indexer);
+ }
+ } else if (indexClientOptions == IndexClientOptions.OPTIMIZE) {
+ handler.logInfo("Optimizing search core.");
+ indexer.optimize();
+ } else if (indexClientOptions == IndexClientOptions.SPELLCHECK) {
+ checkRebuildSpellCheck(commandLine, indexer);
+ } else if (indexClientOptions == IndexClientOptions.INDEX) {
+ handler.logInfo("Indexing " + commandLine.getOptionValue('i') + " force " + commandLine.hasOption("f"));
final long startTimeMillis = System.currentTimeMillis();
final long count = indexAll(indexer, ContentServiceFactory.getInstance().
getItemService(), context, indexableObject.get());
@@ -179,7 +185,7 @@ private static long indexAll(final IndexingService indexingService,
indexingService.indexContent(context, dso, true, true);
count++;
if (dso.getIndexedObject() instanceof Community) {
- final Community community = (Community) dso;
+ final Community community = (Community) dso.getIndexedObject();
final String communityHandle = community.getHandle();
for (final Community subcommunity : community.getSubcommunities()) {
count += indexAll(indexingService, itemService, context, new IndexableCommunity(subcommunity));
diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java
index 8bf3cf2aba62..8707b733a637 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/IndexDiscoveryScriptConfiguration.java
@@ -7,22 +7,14 @@
*/
package org.dspace.discovery;
-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 IndexClient} script
*/
public class IndexDiscoveryScriptConfiguration extends ScriptConfiguration {
- @Autowired
- private AuthorizeService authorizeService;
-
private Class dspaceRunnableClass;
@Override
@@ -30,15 +22,6 @@ public Class getDspaceRunnableClass() {
return 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) {
diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java b/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java
index 4ff1f3134484..4f56a2c92850 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/IndexEventConsumer.java
@@ -154,7 +154,11 @@ public void consume(Context ctx, Event event) throws Exception {
case Event.REMOVE:
case Event.ADD:
- if (object == null) {
+ // At this time, ADD and REMOVE actions are ignored on SITE object. They are only triggered for
+ // top-level communities. No action is necessary as Community itself is indexed (or deleted) separately.
+ if (event.getSubjectType() == Constants.SITE) {
+ log.debug(event.getEventTypeAsString() + " event triggered for Site object. Skipping it.");
+ } else if (object == null) {
log.warn(event.getEventTypeAsString() + " event, could not get object for "
+ event.getObjectTypeAsString() + " id="
+ event.getObjectID()
@@ -201,6 +205,10 @@ public void consume(Context ctx, Event event) throws Exception {
@Override
public void end(Context ctx) throws Exception {
+ // Change the mode to readonly to improve performance
+ Context.Mode originalMode = ctx.getCurrentMode();
+ ctx.setMode(Context.Mode.READ_ONLY);
+
try {
for (String uid : uniqueIdsToDelete) {
try {
@@ -230,6 +238,11 @@ public void end(Context ctx) throws Exception {
uniqueIdsToDelete.clear();
createdItemsToUpdate.clear();
}
+<<<<<<< HEAD
+=======
+
+ ctx.setMode(originalMode);
+>>>>>>> dspace-7.6.1
}
}
diff --git a/dspace-api/src/main/java/org/dspace/discovery/IndexingUtils.java b/dspace-api/src/main/java/org/dspace/discovery/IndexingUtils.java
index 8dd02f5d44e0..9eed61c3f473 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/IndexingUtils.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/IndexingUtils.java
@@ -107,6 +107,13 @@ static List findDirectlyAuthorizedGroupAndEPersonPrefixedIds(
ArrayList prefixedIds = new ArrayList<>();
for (int auth : authorizations) {
for (ResourcePolicy policy : authService.getPoliciesActionFilter(context, obj, auth)) {
+<<<<<<< HEAD
+=======
+ // Avoid NPE in cases where the policy does not have group or eperson
+ if (policy.getGroup() == null && policy.getEPerson() == null) {
+ continue;
+ }
+>>>>>>> dspace-7.6.1
String prefixedId = policy.getGroup() == null
? "e" + policy.getEPerson().getID()
: "g" + policy.getGroup().getID();
diff --git a/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java b/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java
index f14ca124f4fe..4d2980b77727 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/SearchUtils.java
@@ -18,6 +18,9 @@
import org.dspace.content.DSpaceObject;
import org.dspace.content.Item;
import org.dspace.content.WorkspaceItem;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.DSpaceObjectService;
+import org.dspace.core.Context;
import org.dspace.discovery.configuration.DiscoveryConfiguration;
import org.dspace.discovery.configuration.DiscoveryConfigurationService;
import org.dspace.discovery.utils.DiscoverQueryBuilder;
@@ -73,35 +76,83 @@ public static void clearCachedSearchService() {
searchService = null;
}
+<<<<<<< HEAD
+=======
+ /**
+ * Retrieves the Discovery Configuration for a null context, prefix and DSpace object.
+ * This will result in returning the default configuration
+ * @return the default configuration
+ */
+>>>>>>> dspace-7.6.1
public static DiscoveryConfiguration getDiscoveryConfiguration() {
- return getDiscoveryConfiguration(null, null);
+ return getDiscoveryConfiguration(null, null, null);
}
- public static DiscoveryConfiguration getDiscoveryConfiguration(DSpaceObject dso) {
- return getDiscoveryConfiguration(null, dso);
+ /**
+ * Retrieves the Discovery Configuration with a null prefix for a DSpace object.
+ * @param context
+ * the dabase context
+ * @param dso
+ * the DSpace object
+ * @return the Discovery Configuration for the specified DSpace object
+ */
+ public static DiscoveryConfiguration getDiscoveryConfiguration(Context context, DSpaceObject dso) {
+ return getDiscoveryConfiguration(context, null, dso);
}
/**
* Return the discovery configuration to use in a specific scope for the king of search identified by the prefix. A
* null prefix mean the normal query, other predefined values are workspace or workflow
- *
+ *
+ *
+ * @param context
+ * the database context
* @param prefix
* the namespace of the configuration to lookup if any
* @param dso
* the DSpaceObject
* @return the discovery configuration for the specified scope
*/
- public static DiscoveryConfiguration getDiscoveryConfiguration(String prefix, DSpaceObject dso) {
+ public static DiscoveryConfiguration getDiscoveryConfiguration(Context context, String prefix,
+ DSpaceObject dso) {
if (prefix != null) {
return getDiscoveryConfigurationByName(dso != null ? prefix + "." + dso.getHandle() : prefix);
} else {
- return getDiscoveryConfigurationByName(dso != null ? dso.getHandle() : null);
+ return getDiscoveryConfigurationByDSO(context, dso);
}
}
+ /**
+ * Retrieve the configuration for the current dspace object and all its parents and add it to the provided set
+ * @param context - The database context
+ * @param configurations - The set of configurations to add the retrieved configurations to
+ * @param prefix - The namespace of the configuration to lookup if any
+ * @param dso - The DSpace Object
+ * @return the set of configurations with additional retrieved ones for the dspace object and parents
+ * @throws SQLException
+ */
+ public static Set addDiscoveryConfigurationForParents(
+ Context context, Set configurations, String prefix, DSpaceObject dso)
+ throws SQLException {
+ if (dso == null) {
+ configurations.add(getDiscoveryConfigurationByName(null));
+ return configurations;
+ }
+ if (prefix != null) {
+ configurations.add(getDiscoveryConfigurationByName(prefix + "." + dso.getHandle()));
+ } else {
+ configurations.add(getDiscoveryConfigurationByName(dso.getHandle()));
+ }
+
+ DSpaceObjectService dSpaceObjectService = ContentServiceFactory.getInstance()
+ .getDSpaceObjectService(dso);
+ DSpaceObject parentObject = dSpaceObjectService.getParentObject(context, dso);
+ return addDiscoveryConfigurationForParents(context, configurations, prefix, parentObject);
+ }
+
/**
* Return the discovery configuration identified by the specified name
- *
+ *
* @param configurationName the configuration name assigned to the bean in the
* discovery.xml
* @return the discovery configuration
@@ -113,6 +164,18 @@ public static DiscoveryConfiguration getDiscoveryConfigurationByName(
return configurationService.getDiscoveryConfiguration(configurationName);
}
+ /**
+ * Return the discovery configuration for the provided DSO
+ * @param context - The database context
+ * @param dso - The DSpace object to retrieve the configuration for
+ * @return the discovery configuration for the provided DSO
+ */
+ public static DiscoveryConfiguration getDiscoveryConfigurationByDSO(
+ Context context, DSpaceObject dso) {
+ DiscoveryConfigurationService configurationService = getConfigurationService();
+ return configurationService.getDiscoveryDSOConfiguration(context, dso);
+ }
+
public static DiscoveryConfigurationService getConfigurationService() {
ServiceManager manager = DSpaceServicesFactory.getInstance().getServiceManager();
return manager
@@ -127,47 +190,55 @@ public static List getIgnoredMetadataFields(int type) {
* Method that retrieves a list of all the configuration objects from the given item
* A configuration object can be returned for each parent community/collection
*
+ * @param context the database context
* @param item the DSpace item
* @return a list of configuration objects
* @throws SQLException An exception that provides information on a database access error or other errors.
*/
- public static List getAllDiscoveryConfigurations(Item item) throws SQLException {
+ public static List getAllDiscoveryConfigurations(Context context, Item item)
+ throws SQLException {
List collections = item.getCollections();
- return getAllDiscoveryConfigurations(null, collections, item);
+ return getAllDiscoveryConfigurations(context, null, collections, item);
}
/**
* Return all the discovery configuration applicable to the provided workspace item
+ *
+ * @param context
* @param witem a workspace item
* @return a list of discovery configuration
* @throws SQLException
*/
- public static List getAllDiscoveryConfigurations(WorkspaceItem witem) throws SQLException {
+ public static List getAllDiscoveryConfigurations(final Context context,
+ WorkspaceItem witem) throws SQLException {
List collections = new ArrayList();
collections.add(witem.getCollection());
- return getAllDiscoveryConfigurations("workspace", collections, witem.getItem());
+ return getAllDiscoveryConfigurations(context, "workspace", collections, witem.getItem());
}
/**
* Return all the discovery configuration applicable to the provided workflow item
+ *
+ * @param context
* @param witem a workflow item
* @return a list of discovery configuration
* @throws SQLException
*/
- public static List getAllDiscoveryConfigurations(WorkflowItem witem) throws SQLException {
+ public static List getAllDiscoveryConfigurations(final Context context,
+ WorkflowItem witem) throws SQLException {
List collections = new ArrayList();
collections.add(witem.getCollection());
- return getAllDiscoveryConfigurations("workflow", collections, witem.getItem());
+ return getAllDiscoveryConfigurations(context, "workflow", collections, witem.getItem());
}
- private static List getAllDiscoveryConfigurations(String prefix,
+ private static List getAllDiscoveryConfigurations(final Context context,
+ String prefix,
List collections, Item item)
throws SQLException {
Set result = new HashSet<>();
for (Collection collection : collections) {
- DiscoveryConfiguration configuration = getDiscoveryConfiguration(prefix, collection);
- result.add(configuration);
+ addDiscoveryConfigurationForParents(context, result, prefix, collection);
}
//Add alwaysIndex configurations
diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java
index 52e0043ff403..7aece5acf313 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceFileInfoPlugin.java
@@ -53,10 +53,20 @@ public void additionalIndex(Context context, IndexableObject indexableObject, So
if (bitstreams != null) {
for (Bitstream bitstream : bitstreams) {
document.addField(SOLR_FIELD_NAME_FOR_FILENAMES, bitstream.getName());
+ // Add _keyword and _filter fields which are necessary to support filtering and faceting
+ // for the file names
+ document.addField(SOLR_FIELD_NAME_FOR_FILENAMES + "_keyword", bitstream.getName());
+ document.addField(SOLR_FIELD_NAME_FOR_FILENAMES + "_filter", bitstream.getName());
String description = bitstream.getDescription();
if ((description != null) && !description.isEmpty()) {
document.addField(SOLR_FIELD_NAME_FOR_DESCRIPTIONS, description);
+ // Add _keyword and _filter fields which are necessary to support filtering and
+ // faceting for the descriptions
+ document.addField(SOLR_FIELD_NAME_FOR_DESCRIPTIONS + "_keyword",
+ description);
+ document.addField(SOLR_FIELD_NAME_FOR_DESCRIPTIONS + "_filter",
+ description);
}
}
}
@@ -65,4 +75,4 @@ public void additionalIndex(Context context, IndexableObject indexableObject, So
}
}
}
-}
\ No newline at end of file
+}
diff --git a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java
index 3f59ba4f4810..813787bff105 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/SolrServiceImpl.java
@@ -256,7 +256,12 @@ public void unIndexContent(Context context, String searchUniqueID, boolean commi
try {
if (solrSearchCore.getSolr() != null) {
- indexObjectServiceFactory.getIndexableObjectFactory(searchUniqueID).delete(searchUniqueID);
+ IndexFactory index = indexObjectServiceFactory.getIndexableObjectFactory(searchUniqueID);
+ if (index != null) {
+ index.delete(searchUniqueID);
+ } else {
+ log.warn("Object not found in Solr index: " + searchUniqueID);
+ }
if (commit) {
solrSearchCore.getSolr().commit();
}
@@ -1026,9 +1031,8 @@ protected DiscoverResult retrieveResult(Context context, DiscoverQuery query)
// Add information about our search fields
for (String field : searchFields) {
List valuesAsString = new ArrayList<>();
- for (Object o : doc.getFieldValues(field)) {
- valuesAsString.add(String.valueOf(o));
- }
+ Optional.ofNullable(doc.getFieldValues(field))
+ .ifPresent(l -> l.forEach(o -> valuesAsString.add(String.valueOf(o))));
resultDoc.addSearchField(field, valuesAsString.toArray(new String[valuesAsString.size()]));
}
result.addSearchDocument(indexableObject, resultDoc);
diff --git a/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java b/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java
index c02c83ece62b..6cb93e2993f3 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoveryConfigurationService.java
@@ -7,12 +7,23 @@
*/
package org.dspace.discovery.configuration;
+import java.sql.SQLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.UUID;
+import java.util.concurrent.ConcurrentHashMap;
import org.apache.commons.lang3.StringUtils;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.dspace.content.Collection;
+import org.dspace.content.Community;
+import org.dspace.content.DSpaceObject;
+import org.dspace.content.factory.ContentServiceFactory;
+import org.dspace.content.service.DSpaceObjectService;
+import org.dspace.core.Context;
import org.dspace.discovery.IndexableObject;
import org.dspace.discovery.indexobject.IndexableDSpaceObject;
import org.dspace.services.factory.DSpaceServicesFactory;
@@ -22,9 +33,18 @@
*/
public class DiscoveryConfigurationService {
+ private static final Logger log = LogManager.getLogger();
+
private Map map;
private Map> toIgnoreMetadataFields = new HashMap<>();
+ /**
+ * Discovery configurations, cached by Community/Collection UUID. When a Community or Collection does not have its
+ * own configuration, we take the one of the first parent that does.
+ * This cache ensures we do not have to go up the hierarchy every time.
+ */
+ private final Map comColToDiscoveryConfigurationMap = new ConcurrentHashMap<>();
+
public Map getMap() {
return map;
}
@@ -41,25 +61,98 @@ public void setToIgnoreMetadataFields(Map> toIgnoreMetadat
this.toIgnoreMetadataFields = toIgnoreMetadataFields;
}
- public DiscoveryConfiguration getDiscoveryConfiguration(IndexableObject dso) {
+ /**
+ * Retrieve the discovery configuration for the provided IndexableObject. When a DSpace Object can be retrieved from
+ * the IndexableObject, the discovery configuration will be returned for the DSpace Object. Otherwise, a check will
+ * be done to look for the unique index ID of the IndexableObject. When the IndexableObject is null, the default
+ * configuration will be retrieved
+ *
+ * When no direct match is found, the parent object will
+ * be checked until there is no parent left, in which case the "default" configuration will be returned.
+ * @param context - The database context
+ * @param indexableObject - The IndexableObject to retrieve the configuration for
+ * @return the discovery configuration for the provided IndexableObject.
+ */
+ public DiscoveryConfiguration getDiscoveryConfiguration(Context context, IndexableObject indexableObject) {
String name;
- if (dso == null) {
- name = "default";
- } else if (dso instanceof IndexableDSpaceObject) {
- name = ((IndexableDSpaceObject) dso).getIndexedObject().getHandle();
+ if (indexableObject == null) {
+ return getDiscoveryConfiguration(null);
+ } else if (indexableObject instanceof IndexableDSpaceObject) {
+ return getDiscoveryDSOConfiguration(context, ((IndexableDSpaceObject) indexableObject).getIndexedObject());
} else {
- name = dso.getUniqueIndexID();
+ name = indexableObject.getUniqueIndexID();
}
-
return getDiscoveryConfiguration(name);
}
- public DiscoveryConfiguration getDiscoveryConfiguration(final String name) {
+ /**
+ * Retrieve the discovery configuration for the provided DSO. When no direct match is found, the parent object will
+ * be checked until there is no parent left, in which case the "default" configuration will be returned.
+ * @param context - The database context
+ * @param dso - The DSpace object to retrieve the configuration for
+ * @return the discovery configuration for the provided DSO.
+ */
+ public DiscoveryConfiguration getDiscoveryDSOConfiguration(final Context context, DSpaceObject dso) {
+ // Fall back to default configuration
+ if (dso == null) {
+ return getDiscoveryConfiguration(null, true);
+ }
+
+ // Attempt to retrieve cached configuration by UUID
+ if (comColToDiscoveryConfigurationMap.containsKey(dso.getID())) {
+ return comColToDiscoveryConfigurationMap.get(dso.getID());
+ }
+
+ DiscoveryConfiguration configuration;
+
+ // Attempt to retrieve configuration by DSO handle
+ configuration = getDiscoveryConfiguration(dso.getHandle(), false);
+
+ if (configuration == null) {
+ // Recurse up the Comm/Coll hierarchy until a configuration is found
+ DSpaceObjectService dSpaceObjectService =
+ ContentServiceFactory.getInstance().getDSpaceObjectService(dso);
+ DSpaceObject parentObject = null;
+ try {
+ parentObject = dSpaceObjectService.getParentObject(context, dso);
+ } catch (SQLException e) {
+ log.error(e);
+ }
+ configuration = getDiscoveryDSOConfiguration(context, parentObject);
+ }
+
+ // Cache the resulting configuration when the DSO is a Community or Collection
+ if (dso instanceof Community || dso instanceof Collection) {
+ comColToDiscoveryConfigurationMap.put(dso.getID(), configuration);
+ }
+
+ return configuration;
+ }
+
+ /**
+ * Retrieve the Discovery Configuration for the provided name. When no configuration can be found for the name, the
+ * default configuration will be returned.
+ * @param name - The name of the configuration to be retrieved
+ * @return the Discovery Configuration for the provided name, or default when none was found.
+ */
+ public DiscoveryConfiguration getDiscoveryConfiguration(String name) {
+ return getDiscoveryConfiguration(name, true);
+ }
+
+ /**
+ * Retrieve the configuration for the provided name. When useDefault is set to true, the "default" configuration
+ * will be returned when no match is found. When useDefault is set to false, null will be returned when no match is
+ * found.
+ * @param name - The name of the configuration to retrieve
+ * @param useDefault - Whether the default configuration should be used when no match is found
+ * @return the configuration for the provided name
+ */
+ public DiscoveryConfiguration getDiscoveryConfiguration(final String name, boolean useDefault) {
DiscoveryConfiguration result;
result = StringUtils.isBlank(name) ? null : getMap().get(name);
- if (result == null) {
+ if (result == null && useDefault) {
//No specific configuration, get the default one
result = getMap().get("default");
}
@@ -67,12 +160,23 @@ public DiscoveryConfiguration getDiscoveryConfiguration(final String name) {
return result;
}
- public DiscoveryConfiguration getDiscoveryConfigurationByNameOrDso(final String configurationName,
- final IndexableObject dso) {
+ /**
+ * Retrieve the Discovery configuration for the provided name or IndexableObject. The configuration will first be
+ * checked for the provided name. When no match is found for the name, the configuration will be retrieved for the
+ * IndexableObject
+ *
+ * @param context - The database context
+ * @param configurationName - The name of the configuration to be retrieved
+ * @param indexableObject - The indexable object to retrieve the configuration for
+ * @return the Discovery configuration for the provided name, or when not found for the provided IndexableObject
+ */
+ public DiscoveryConfiguration getDiscoveryConfigurationByNameOrIndexableObject(Context context,
+ String configurationName,
+ IndexableObject indexableObject) {
if (StringUtils.isNotBlank(configurationName) && getMap().containsKey(configurationName)) {
return getMap().get(configurationName);
} else {
- return getDiscoveryConfiguration(dso);
+ return getDiscoveryConfiguration(context, indexableObject);
}
}
@@ -92,13 +196,25 @@ public List getIndexAlwaysConfigurations() {
return configs;
}
+ /**
+ * @return All configurations for {@link org.dspace.discovery.configuration.DiscoverySearchFilterFacet}
+ */
+ public List getAllFacetsConfig() {
+ List configs = new ArrayList<>();
+ for (String key : map.keySet()) {
+ DiscoveryConfiguration config = map.get(key);
+ configs.addAll(config.getSidebarFacets());
+ }
+ return configs;
+ }
+
public static void main(String[] args) {
System.out.println(DSpaceServicesFactory.getInstance().getServiceManager().getServicesNames().size());
DiscoveryConfigurationService mainService = DSpaceServicesFactory.getInstance().getServiceManager()
.getServiceByName(
- DiscoveryConfigurationService.class
- .getName(),
- DiscoveryConfigurationService.class);
+ DiscoveryConfigurationService.class
+ .getName(),
+ DiscoveryConfigurationService.class);
for (String key : mainService.getMap().keySet()) {
System.out.println(key);
@@ -126,7 +242,7 @@ public static void main(String[] args) {
System.out.println("Recent submissions configuration:");
DiscoveryRecentSubmissionsConfiguration recentSubmissionConfiguration = discoveryConfiguration
- .getRecentSubmissionConfiguration();
+ .getRecentSubmissionConfiguration();
System.out.println("\tMetadata sort field: " + recentSubmissionConfiguration.getMetadataSortField());
System.out.println("\tMax recent submissions: " + recentSubmissionConfiguration.getMax());
diff --git a/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoverySortConfiguration.java b/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoverySortConfiguration.java
index e251d1bc5118..cd1a4eecb8d4 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoverySortConfiguration.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/configuration/DiscoverySortConfiguration.java
@@ -9,6 +9,7 @@
import java.util.ArrayList;
import java.util.List;
+import javax.annotation.Nullable;
import org.apache.commons.collections4.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
@@ -22,6 +23,11 @@ public class DiscoverySortConfiguration {
private List sortFields = new ArrayList();
+ /**
+ * Default sort configuration to use when needed
+ */
+ @Nullable private DiscoverySortFieldConfiguration defaultSortField;
+
public List getSortFields() {
return sortFields;
}
@@ -30,6 +36,14 @@ public void setSortFields(List sortFields) {
this.sortFields = sortFields;
}
+ public DiscoverySortFieldConfiguration getDefaultSortField() {
+ return defaultSortField;
+ }
+
+ public void setDefaultSortField(DiscoverySortFieldConfiguration configuration) {
+ this.defaultSortField = configuration;
+ }
+
public DiscoverySortFieldConfiguration getSortFieldConfiguration(String sortField) {
if (StringUtils.isBlank(sortField)) {
return null;
diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java
index c2bacfe5024e..817be7848df7 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CollectionIndexFactoryImpl.java
@@ -86,7 +86,7 @@ public SolrInputDocument buildDocument(Context context, IndexableCollection inde
final Collection collection = indexableCollection.getIndexedObject();
// Retrieve configuration
- DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(collection);
+ DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(context, collection);
DiscoveryHitHighlightingConfiguration highlightingConfiguration = discoveryConfiguration
.getHitHighlightingConfiguration();
List highlightedMetadataFields = new ArrayList<>();
@@ -173,4 +173,4 @@ public List getCollectionLocations(Context context, Collection collectio
return locations;
}
-}
\ No newline at end of file
+}
diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java
index 8521b7dda0de..e92819601839 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/CommunityIndexFactoryImpl.java
@@ -69,7 +69,7 @@ public SolrInputDocument buildDocument(Context context, IndexableCommunity index
final Community community = indexableObject.getIndexedObject();
// Retrieve configuration
- DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(community);
+ DiscoveryConfiguration discoveryConfiguration = SearchUtils.getDiscoveryConfiguration(context, community);
DiscoveryHitHighlightingConfiguration highlightingConfiguration = discoveryConfiguration
.getHitHighlightingConfiguration();
List highlightedMetadataFields = new ArrayList<>();
@@ -135,4 +135,4 @@ public List getLocations(Context context, IndexableCommunity indexableDS
return locations;
}
-}
\ No newline at end of file
+}
diff --git a/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java b/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java
index 8a24b997ffae..f24e9875f006 100644
--- a/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java
+++ b/dspace-api/src/main/java/org/dspace/discovery/indexobject/InprogressSubmissionIndexFactoryImpl.java
@@ -80,11 +80,13 @@ public void storeInprogressItemFields(Context context, SolrInputDocument doc,
// Add item metadata
List