/**
* Commit the contained item to the main archive. The item is associated with the relevant
* collection, added to the search index, and any other tasks such as assigning dates are
* performed.
*
* @return the fully archived item.
*/
@Override
public Item archive(Context context, BasicWorkflowItem workflowItem)
throws SQLException, IOException, AuthorizeException {
// FIXME: Check auth
Item item = workflowItem.getItem();
Collection collection = workflowItem.getCollection();
log.info(
LogManager.getHeader(
context,
"archive_item",
"workflow_item_id="
+ workflowItem.getID()
+ "item_id="
+ item.getID()
+ "collection_id="
+ collection.getID()));
installItemService.installItem(context, workflowItem);
// Log the event
log.info(
LogManager.getHeader(
context,
"install_item",
"workflow_id=" + workflowItem.getID() + ", item_id=" + item.getID() + "handle=FIXME"));
return item;
}
protected void notifyOfReject(
Context context, BasicWorkflowItem workflowItem, EPerson e, String reason) {
try {
// Get the item title
String title = getItemTitle(workflowItem);
// Get the collection
Collection coll = workflowItem.getCollection();
// Get rejector's name
String rejector = getEPersonName(e);
Locale supportedLocale = I18nUtil.getEPersonLocale(e);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "submit_reject"));
email.addRecipient(workflowItem.getSubmitter().getEmail());
email.addArgument(title);
email.addArgument(coll.getName());
email.addArgument(rejector);
email.addArgument(reason);
email.addArgument(getMyDSpaceLink());
email.send();
} catch (RuntimeException re) {
// log this email error
log.warn(
LogManager.getHeader(
context,
"notify_of_reject",
"cannot email user eperson_id="
+ e.getID()
+ " eperson_email="
+ e.getEmail()
+ " workflow_item_id="
+ workflowItem.getID()
+ ": "
+ re.getMessage()));
throw re;
} catch (Exception ex) {
// log this email error
log.warn(
LogManager.getHeader(
context,
"notify_of_reject",
"cannot email user eperson_id="
+ e.getID()
+ " eperson_email="
+ e.getEmail()
+ " workflow_item_id="
+ workflowItem.getID()
+ ": "
+ ex.getMessage()));
}
}
@Override
public WorkspaceItem abort(Context c, XmlWorkflowItem wi, EPerson e)
throws AuthorizeException, SQLException, IOException {
if (!authorizeService.isAdmin(c)) {
throw new AuthorizeException("You must be an admin to abort a workflow");
}
c.turnOffAuthorisationSystem();
// Restore permissions for the submitter
// convert into personal workspace
WorkspaceItem wsi = returnToWorkspace(c, wi);
log.info(
LogManager.getHeader(
c,
"abort_workflow",
"workflow_item_id="
+ wi.getID()
+ "item_id="
+ wsi.getItem().getID()
+ "collection_id="
+ wi.getCollection().getID()
+ "eperson_id="
+ e.getID()));
c.restoreAuthSystemState();
return wsi;
}
@Override
public WorkspaceItem abort(Context context, BasicWorkflowItem workflowItem, EPerson e)
throws SQLException, AuthorizeException, IOException {
// authorize a DSpaceActions.ABORT
if (!authorizeService.isAdmin(context)) {
throw new AuthorizeException("You must be an admin to abort a workflow");
}
// stop workflow regardless of its state
taskListItemService.deleteByWorkflowItem(context, workflowItem);
log.info(
LogManager.getHeader(
context,
"abort_workflow",
"workflow_item_id="
+ workflowItem.getID()
+ "item_id="
+ workflowItem.getItem().getID()
+ "collection_id="
+ workflowItem.getCollection().getID()
+ "eperson_id="
+ e.getID()));
// convert into personal workspace
return returnToWorkspace(context, workflowItem);
}
/**
* Return the workflow item to the workspace of the submitter. The workflow item is removed, and a
* workspace item created.
*
* @param c Context
* @param wfi WorkflowItem to be 'dismantled'
* @return the workspace item
*/
protected WorkspaceItem returnToWorkspace(Context c, BasicWorkflowItem wfi)
throws SQLException, IOException, AuthorizeException {
// FIXME: How should this interact with the workflow system?
// FIXME: Remove license
// FIXME: Provenance statement?
// Create the new workspace item row
WorkspaceItem workspaceItem = workspaceItemService.create(c, wfi);
workspaceItem.setMultipleFiles(wfi.hasMultipleFiles());
workspaceItem.setMultipleTitles(wfi.hasMultipleTitles());
workspaceItem.setPublishedBefore(wfi.isPublishedBefore());
workspaceItemService.update(c, workspaceItem);
// myitem.update();
log.info(
LogManager.getHeader(
c,
"return_to_workspace",
"workflow_item_id=" + wfi.getID() + "workspace_item_id=" + workspaceItem.getID()));
// Now remove the workflow object manually from the database
workflowItemService.deleteWrapper(c, wfi);
return workspaceItem;
}
/**
* Commit the contained item to the main archive. The item is associated with the relevant
* collection, added to the search index, and any other tasks such as assigning dates are
* performed.
*
* @param context The relevant DSpace Context.
* @param wfi workflow item
* @return the fully archived item.
* @throws IOException A general class of exceptions produced by failed or interrupted I/O
* operations.
* @throws SQLException An exception that provides information on a database access error or other
* errors.
* @throws AuthorizeException Exception indicating the current user of the context does not have
* permission to perform a particular action.
*/
@Override
public Item archive(Context context, XmlWorkflowItem wfi)
throws SQLException, IOException, AuthorizeException {
// FIXME: Check auth
Item item = wfi.getItem();
Collection collection = wfi.getCollection();
// Remove (if any) the workflowItemroles for this item
workflowItemRoleService.deleteForWorkflowItem(context, wfi);
log.info(
LogManager.getHeader(
context,
"archive_item",
"workflow_item_id="
+ wfi.getID()
+ "item_id="
+ item.getID()
+ "collection_id="
+ collection.getID()));
installItemService.installItem(context, wfi);
// Notify
notifyOfArchive(context, item, collection);
// Clear any remaining workflow metadata
itemService.clearMetadata(
context, item, WorkflowRequirementsService.WORKFLOW_SCHEMA, Item.ANY, Item.ANY, Item.ANY);
itemService.update(context, item);
// Log the event
log.info(
LogManager.getHeader(
context,
"install_item",
"workflow_item_id=" + wfi.getID() + ", item_id=" + item.getID() + "handle=FIXME"));
return item;
}
@Override
public void claim(Context context, BasicWorkflowItem workflowItem, EPerson e)
throws SQLException, IOException, AuthorizeException {
int taskstate = workflowItem.getState();
switch (taskstate) {
case WFSTATE_STEP1POOL:
// authorize DSpaceActions.SUBMIT_REVIEW
doState(context, workflowItem, WFSTATE_STEP1, e);
break;
case WFSTATE_STEP2POOL:
// authorize DSpaceActions.SUBMIT_STEP2
doState(context, workflowItem, WFSTATE_STEP2, e);
break;
case WFSTATE_STEP3POOL:
// authorize DSpaceActions.SUBMIT_STEP3
doState(context, workflowItem, WFSTATE_STEP3, e);
break;
// if we got here, we weren't pooled... error?
// FIXME - log the error?
}
log.info(
LogManager.getHeader(
context,
"claim_task",
"workflow_item_id="
+ workflowItem.getID()
+ "item_id="
+ workflowItem.getItem().getID()
+ "collection_id="
+ workflowItem.getCollection().getID()
+ "newowner_id="
+ workflowItem.getOwner().getID()
+ "old_state="
+ taskstate
+ "new_state="
+ workflowItem.getState()));
}
@Override
public void unclaim(Context context, BasicWorkflowItem workflowItem, EPerson e)
throws SQLException, IOException, AuthorizeException {
int taskstate = workflowItem.getState();
switch (taskstate) {
case WFSTATE_STEP1:
// authorize DSpaceActions.STEP1
doState(context, workflowItem, WFSTATE_STEP1POOL, e);
break;
case WFSTATE_STEP2:
// authorize DSpaceActions.APPROVE
doState(context, workflowItem, WFSTATE_STEP2POOL, e);
break;
case WFSTATE_STEP3:
// authorize DSpaceActions.STEP3
doState(context, workflowItem, WFSTATE_STEP3POOL, e);
break;
// error handling? shouldn't get here
// FIXME - what to do with error - log it?
}
log.info(
LogManager.getHeader(
context,
"unclaim_workflow",
"workflow_item_id="
+ workflowItem.getID()
+ ",item_id="
+ workflowItem.getItem().getID()
+ ",collection_id="
+ workflowItem.getCollection().getID()
+ ",old_state="
+ taskstate
+ ",new_state="
+ workflowItem.getState()));
}
// send notices of curation activity
@Override
public void notifyOfCuration(
Context c,
BasicWorkflowItem wi,
List<EPerson> ePeople,
String taskName,
String action,
String message)
throws SQLException, IOException {
try {
// Get the item title
String title = getItemTitle(wi);
// Get the submitter's name
String submitter = getSubmitterName(wi);
// Get the collection
Collection coll = wi.getCollection();
for (EPerson epa : ePeople) {
Locale supportedLocale = I18nUtil.getEPersonLocale(epa);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "flowtask_notify"));
email.addArgument(title);
email.addArgument(coll.getName());
email.addArgument(submitter);
email.addArgument(taskName);
email.addArgument(message);
email.addArgument(action);
email.addRecipient(epa.getEmail());
email.send();
}
} catch (MessagingException e) {
log.warn(
LogManager.getHeader(
c,
"notifyOfCuration",
"cannot email users of workflow_item_id " + wi.getID() + ": " + e.getMessage()));
}
}
protected void activateFirstStep(
Context context, Workflow wf, Step firstStep, XmlWorkflowItem wfi)
throws AuthorizeException, IOException, SQLException, WorkflowException,
WorkflowConfigurationException {
WorkflowActionConfig firstActionConfig = firstStep.getUserSelectionMethod();
firstActionConfig.getProcessingAction().activate(context, wfi);
log.info(
LogManager.getHeader(
context,
"start_workflow",
firstActionConfig.getProcessingAction()
+ " workflow_item_id="
+ wfi.getID()
+ "item_id="
+ wfi.getItem().getID()
+ "collection_id="
+ wfi.getCollection().getID()));
// record the start of the workflow w/provenance message
recordStart(context, wfi.getItem(), firstActionConfig.getProcessingAction());
// Fire an event !
logWorkflowEvent(
context,
firstStep.getWorkflow().getID(),
null,
null,
wfi,
null,
firstStep,
firstActionConfig);
// If we don't have a UI activate it
if (!firstActionConfig.requiresUI()) {
ActionResult outcome =
firstActionConfig.getProcessingAction().execute(context, wfi, firstStep, null);
processOutcome(context, null, wf, firstStep, firstActionConfig, outcome, wfi, true);
}
}
/**
* Return the workflow item to the workspace of the submitter. The workflow item is removed, and a
* workspace item created.
*
* @param c Context
* @param wfi WorkflowItem to be 'dismantled'
* @return the workspace item
* @throws java.io.IOException ...
* @throws java.sql.SQLException ...
* @throws org.dspace.authorize.AuthorizeException ...
*/
protected WorkspaceItem returnToWorkspace(Context c, XmlWorkflowItem wfi)
throws SQLException, IOException, AuthorizeException {
// authorize a DSpaceActions.REJECT
// stop workflow
deleteAllTasks(c, wfi);
c.turnOffAuthorisationSystem();
// Also clear all info for this step
workflowRequirementsService.clearInProgressUsers(c, wfi);
// Remove (if any) the workflowItemroles for this item
workflowItemRoleService.deleteForWorkflowItem(c, wfi);
Item myitem = wfi.getItem();
// Restore permissions for the submitter
grantUserAllItemPolicies(c, myitem, myitem.getSubmitter());
// FIXME: How should this interact with the workflow system?
// FIXME: Remove license
// FIXME: Provenance statement?
// Create the new workspace item row
WorkspaceItem workspaceItem = workspaceItemService.create(c, wfi);
workspaceItem.setMultipleFiles(wfi.hasMultipleFiles());
workspaceItem.setMultipleTitles(wfi.hasMultipleTitles());
workspaceItem.setPublishedBefore(wfi.isPublishedBefore());
workspaceItemService.update(c, workspaceItem);
// myitem.update();
log.info(
LogManager.getHeader(
c,
"return_to_workspace",
"workflow_item_id=" + wfi.getID() + "workspace_item_id=" + workspaceItem.getID()));
// Now remove the workflow object manually from the database
xmlWorkflowItemService.deleteWrapper(c, wfi);
return workspaceItem;
}
@Override
public BasicWorkflowItem start(Context context, WorkspaceItem wsi)
throws SQLException, AuthorizeException, IOException {
// FIXME Check auth
Item myitem = wsi.getItem();
Collection collection = wsi.getCollection();
log.info(
LogManager.getHeader(
context,
"start_workflow",
"workspace_item_id="
+ wsi.getID()
+ "item_id="
+ myitem.getID()
+ "collection_id="
+ collection.getID()));
// record the start of the workflow w/provenance message
recordStart(context, myitem);
// create the WorkflowItem
BasicWorkflowItem wfi = workflowItemService.create(context, myitem, collection);
wfi.setMultipleFiles(wsi.hasMultipleFiles());
wfi.setMultipleTitles(wsi.hasMultipleTitles());
wfi.setPublishedBefore(wsi.isPublishedBefore());
// remove the WorkspaceItem
workspaceItemService.deleteWrapper(context, wsi);
// now get the workflow started
wfi.setState(WFSTATE_SUBMIT);
advance(context, wfi, null);
// Return the workflow item
return wfi;
}
/**
* notify the submitter that the item is archived
*
* @param context The relevant DSpace Context.
* @param item which item was archived
* @param coll collection name to display in template
* @throws SQLException An exception that provides information on a database access error or other
* errors.
* @throws IOException A general class of exceptions produced by failed or interrupted I/O
* operations.
*/
protected void notifyOfArchive(Context context, Item item, Collection coll)
throws SQLException, IOException {
try {
// Get submitter
EPerson ep = item.getSubmitter();
// Get the Locale
Locale supportedLocale = I18nUtil.getEPersonLocale(ep);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "submit_archive"));
// Get the item handle to email to user
String handle = handleService.findHandle(context, item);
// Get title
List<MetadataValue> titles =
itemService.getMetadata(item, MetadataSchema.DC_SCHEMA, "title", null, Item.ANY);
String title = "";
try {
title = I18nUtil.getMessage("org.dspace.workflow.WorkflowManager.untitled");
} catch (MissingResourceException e) {
title = "Untitled";
}
if (titles.size() > 0) {
title = titles.iterator().next().getValue();
}
email.addRecipient(ep.getEmail());
email.addArgument(title);
email.addArgument(coll.getName());
email.addArgument(handleService.getCanonicalForm(handle));
email.send();
} catch (MessagingException e) {
log.warn(
LogManager.getHeader(
context, "notifyOfArchive", "cannot email user" + " item_id=" + item.getID()));
}
}
/** notify the submitter that the item is archived */
protected void notifyOfArchive(Context context, Item item, Collection coll)
throws SQLException, IOException {
try {
// Get submitter
EPerson ep = item.getSubmitter();
// Get the Locale
Locale supportedLocale = I18nUtil.getEPersonLocale(ep);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "submit_archive"));
// Get the item handle to email to user
String handle = handleService.findHandle(context, item);
// Get title
String title = item.getName();
if (StringUtils.isBlank(title)) {
try {
title = I18nUtil.getMessage("org.dspace.workflow.WorkflowManager.untitled");
} catch (MissingResourceException e) {
title = "Untitled";
}
}
email.addRecipient(ep.getEmail());
email.addArgument(title);
email.addArgument(coll.getName());
email.addArgument(handleService.getCanonicalForm(handle));
email.send();
} catch (MessagingException e) {
log.warn(
LogManager.getHeader(
context,
"notifyOfArchive",
"cannot email user; item_id=" + item.getID() + ": " + e.getMessage()));
}
}
/*
* Executes an action and returns the next.
*/
@Override
public WorkflowActionConfig doState(
Context c,
EPerson user,
HttpServletRequest request,
int workflowItemId,
Workflow workflow,
WorkflowActionConfig currentActionConfig)
throws SQLException, AuthorizeException, IOException, MessagingException, WorkflowException {
try {
XmlWorkflowItem wi = xmlWorkflowItemService.find(c, workflowItemId);
Step currentStep = currentActionConfig.getStep();
if (currentActionConfig.getProcessingAction().isAuthorized(c, request, wi)) {
ActionResult outcome =
currentActionConfig.getProcessingAction().execute(c, wi, currentStep, request);
return processOutcome(
c, user, workflow, currentStep, currentActionConfig, outcome, wi, false);
} else {
throw new AuthorizeException("You are not allowed to to perform this task.");
}
} catch (WorkflowConfigurationException e) {
log.error(
LogManager.getHeader(
c,
"error while executing state",
"workflow: "
+ workflow.getID()
+ " action: "
+ currentActionConfig.getId()
+ " workflowItemId: "
+ workflowItemId),
e);
WorkflowUtils.sendAlert(request, e);
throw new WorkflowException(e);
}
}
protected void notifyOfReject(Context c, XmlWorkflowItem wi, EPerson e, String reason) {
try {
// Get the item title
String title = wi.getItem().getName();
// Get the collection
Collection coll = wi.getCollection();
// Get rejector's name
String rejector = getEPersonName(e);
Locale supportedLocale = I18nUtil.getEPersonLocale(e);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "submit_reject"));
email.addRecipient(wi.getSubmitter().getEmail());
email.addArgument(title);
email.addArgument(coll.getName());
email.addArgument(rejector);
email.addArgument(reason);
email.addArgument(ConfigurationManager.getProperty("dspace.url") + "/mydspace");
email.send();
} catch (Exception ex) {
// log this email error
log.warn(
LogManager.getHeader(
c,
"notify_of_reject",
"cannot email user"
+ " eperson_id"
+ e.getID()
+ " eperson_email"
+ e.getEmail()
+ " workflow_item_id"
+ wi.getID()));
}
}
protected void notifyGroupOfTask(
Context c, BasicWorkflowItem wi, Group mygroup, List<EPerson> epa)
throws SQLException, IOException {
// check to see if notification is turned off
// and only do it once - delete key after notification has
// been suppressed for the first time
UUID myID = wi.getItem().getID();
if (noEMail.containsKey(myID)) {
// suppress email, and delete key
noEMail.remove(myID);
} else {
try {
// Get the item title
String title = getItemTitle(wi);
// Get the submitter's name
String submitter = getSubmitterName(wi);
// Get the collection
Collection coll = wi.getCollection();
String message = "";
for (EPerson anEpa : epa) {
Locale supportedLocale = I18nUtil.getEPersonLocale(anEpa);
Email email = Email.getEmail(I18nUtil.getEmailFilename(supportedLocale, "submit_task"));
email.addArgument(title);
email.addArgument(coll.getName());
email.addArgument(submitter);
ResourceBundle messages = ResourceBundle.getBundle("Messages", supportedLocale);
switch (wi.getState()) {
case WFSTATE_STEP1POOL:
message = messages.getString("org.dspace.workflow.WorkflowManager.step1");
break;
case WFSTATE_STEP2POOL:
message = messages.getString("org.dspace.workflow.WorkflowManager.step2");
break;
case WFSTATE_STEP3POOL:
message = messages.getString("org.dspace.workflow.WorkflowManager.step3");
break;
}
email.addArgument(message);
email.addArgument(getMyDSpaceLink());
email.addRecipient(anEpa.getEmail());
email.send();
}
} catch (MessagingException e) {
String gid = (mygroup != null) ? String.valueOf(mygroup.getID()) : "none";
log.warn(
LogManager.getHeader(
c,
"notifyGroupofTask",
"cannot email user group_id="
+ gid
+ " workflow_item_id="
+ wi.getID()
+ ": "
+ e.getMessage()));
}
}
}
@Override
public WorkspaceItem sendWorkflowItemBackSubmission(
Context context,
BasicWorkflowItem workflowItem,
EPerson ePerson,
String provenancePrefix,
String rejection_message)
throws SQLException, AuthorizeException, IOException {
int oldState = workflowItem.getState();
// authorize a DSpaceActions.REJECT
// stop workflow
taskListItemService.deleteByWorkflowItem(context, workflowItem);
// rejection provenance
Item myitem = workflowItem.getItem();
// Get current date
String now = DCDate.getCurrent().toString();
// Get user's name + email address
String usersName = getEPersonName(ePerson);
// Here's what happened
String provDescription =
"Rejected by " + usersName + ", reason: " + rejection_message + " on " + now + " (GMT) ";
// Add to item as a DC field
itemService.addMetadata(
context,
myitem,
MetadataSchema.DC_SCHEMA,
"description",
"provenance",
"en",
provDescription);
itemService.update(context, myitem);
// convert into personal workspace
WorkspaceItem wsi = returnToWorkspace(context, workflowItem);
// notify that it's been rejected
notifyOfReject(context, workflowItem, ePerson, rejection_message);
log.info(
LogManager.getHeader(
context,
"reject_workflow",
"workflow_item_id="
+ workflowItem.getID()
+ "item_id="
+ workflowItem.getItem().getID()
+ "collection_id="
+ workflowItem.getCollection().getID()
+ "eperson_id="
+ ePerson.getID()));
logWorkflowEvent(
context,
wsi.getItem(),
workflowItem,
ePerson,
WFSTATE_SUBMIT,
null,
wsi.getCollection(),
oldState,
null);
return wsi;
}
@Override
public WorkflowActionConfig processOutcome(
Context c,
EPerson user,
Workflow workflow,
Step currentStep,
WorkflowActionConfig currentActionConfig,
ActionResult currentOutcome,
XmlWorkflowItem wfi,
boolean enteredNewStep)
throws IOException, AuthorizeException, SQLException, WorkflowException {
if (currentOutcome.getType() == ActionResult.TYPE.TYPE_PAGE
|| currentOutcome.getType() == ActionResult.TYPE.TYPE_ERROR) {
// Our outcome is a page or an error, so return our current action
c.restoreAuthSystemState();
return currentActionConfig;
} else if (currentOutcome.getType() == ActionResult.TYPE.TYPE_CANCEL
|| currentOutcome.getType() == ActionResult.TYPE.TYPE_SUBMISSION_PAGE) {
// We either pressed the cancel button or got an order to return to the submission page, so
// don't return an action
// By not returning an action we ensure ourselfs that we go back to the submission page
c.restoreAuthSystemState();
return null;
} else if (currentOutcome.getType() == ActionResult.TYPE.TYPE_OUTCOME) {
Step nextStep = null;
WorkflowActionConfig nextActionConfig = null;
try {
// We have completed our action search & retrieve the next action
if (currentOutcome.getResult() == ActionResult.OUTCOME_COMPLETE) {
nextActionConfig = currentStep.getNextAction(currentActionConfig);
}
if (nextActionConfig != null) {
// We remain in the current step since an action is found
nextStep = currentStep;
nextActionConfig.getProcessingAction().activate(c, wfi);
if (nextActionConfig.requiresUI() && !enteredNewStep) {
createOwnedTask(c, wfi, currentStep, nextActionConfig, user);
return nextActionConfig;
} else if (nextActionConfig.requiresUI() && enteredNewStep) {
// We have entered a new step and have encountered a UI, return null since the current
// user doesn't have anything to do with this
c.restoreAuthSystemState();
return null;
} else {
ActionResult newOutcome =
nextActionConfig.getProcessingAction().execute(c, wfi, currentStep, null);
return processOutcome(
c, user, workflow, currentStep, nextActionConfig, newOutcome, wfi, enteredNewStep);
}
} else if (enteredNewStep) {
// If the user finished his/her step, we keep processing until there is a UI step action
// or no step at all
nextStep = workflow.getNextStep(c, wfi, currentStep, currentOutcome.getResult());
c.turnOffAuthorisationSystem();
nextActionConfig = processNextStep(c, user, workflow, currentOutcome, wfi, nextStep);
// If we require a user interface return null so that the user is redirected to the
// "submissions page"
if (nextActionConfig == null || nextActionConfig.requiresUI()) {
return null;
} else {
return nextActionConfig;
}
} else {
ClaimedTask task = claimedTaskService.findByWorkflowIdAndEPerson(c, wfi, user);
// Check if we have a task for this action (might not be the case with automatic steps)
// First add it to our list of finished users, since no more actions remain
workflowRequirementsService.addFinishedUser(c, wfi, user);
c.turnOffAuthorisationSystem();
// Check if our requirements have been met
if ((currentStep.isFinished(c, wfi)
&& currentOutcome.getResult() == ActionResult.OUTCOME_COMPLETE)
|| currentOutcome.getResult() != ActionResult.OUTCOME_COMPLETE) {
// Delete all the table rows containing the users who performed this task
workflowRequirementsService.clearInProgressUsers(c, wfi);
// Remove all the tasks
deleteAllTasks(c, wfi);
nextStep = workflow.getNextStep(c, wfi, currentStep, currentOutcome.getResult());
nextActionConfig = processNextStep(c, user, workflow, currentOutcome, wfi, nextStep);
// If we require a user interface return null so that the user is redirected to the
// "submissions page"
if (nextActionConfig == null || nextActionConfig.requiresUI()) {
return null;
} else {
return nextActionConfig;
}
} else {
// We are done with our actions so go to the submissions page but remove action
// ClaimedAction first
deleteClaimedTask(c, wfi, task);
c.restoreAuthSystemState();
nextStep = currentStep;
nextActionConfig = currentActionConfig;
return null;
}
}
} catch (Exception e) {
log.error("error while processing workflow outcome", e);
e.printStackTrace();
} finally {
if ((nextStep != null && currentStep != null && nextActionConfig != null)
|| (wfi.getItem().isArchived() && currentStep != null)) {
logWorkflowEvent(
c,
currentStep.getWorkflow().getID(),
currentStep.getId(),
currentActionConfig.getId(),
wfi,
user,
nextStep,
nextActionConfig);
}
}
}
log.error(LogManager.getHeader(c, "Invalid step outcome", "Workflow item id: " + wfi.getID()));
throw new WorkflowException("Invalid step outcome");
}
@Override
public boolean advance(
Context context, BasicWorkflowItem workflowItem, EPerson e, boolean curate, boolean record)
throws SQLException, IOException, AuthorizeException {
int taskstate = workflowItem.getState();
boolean archived = false;
// perform curation tasks if needed
if (curate && workflowCuratorService.needsCuration(workflowItem)) {
if (!workflowCuratorService.doCuration(context, workflowItem)) {
// don't proceed - either curation tasks queued, or item rejected
log.info(
LogManager.getHeader(
context,
"advance_workflow",
"workflow_item_id="
+ workflowItem.getID()
+ ",item_id="
+ workflowItem.getItem().getID()
+ ",collection_id="
+ workflowItem.getCollection().getID()
+ ",old_state="
+ taskstate
+ ",doCuration=false"));
return false;
}
}
switch (taskstate) {
case WFSTATE_SUBMIT:
archived = doState(context, workflowItem, WFSTATE_STEP1POOL, e);
break;
case WFSTATE_STEP1:
// authorize DSpaceActions.SUBMIT_REVIEW
// Record provenance
if (record) {
recordApproval(context, workflowItem, e);
}
archived = doState(context, workflowItem, WFSTATE_STEP2POOL, e);
break;
case WFSTATE_STEP2:
// authorize DSpaceActions.SUBMIT_STEP2
// Record provenance
if (record) {
recordApproval(context, workflowItem, e);
}
archived = doState(context, workflowItem, WFSTATE_STEP3POOL, e);
break;
case WFSTATE_STEP3:
// authorize DSpaceActions.SUBMIT_STEP3
// We don't record approval for editors, since they can't reject,
// and thus didn't actually make a decision
archived = doState(context, workflowItem, WFSTATE_ARCHIVE, e);
break;
// error handling? shouldn't get here
}
log.info(
LogManager.getHeader(
context,
"advance_workflow",
"workflow_item_id="
+ workflowItem.getID()
+ ",item_id="
+ workflowItem.getItem().getID()
+ ",collection_id="
+ workflowItem.getCollection().getID()
+ ",old_state="
+ taskstate
+ ",new_state="
+ workflowItem.getState()));
return archived;
}
protected void logWorkflowEvent(
Context c,
String workflowId,
String previousStepId,
String previousActionConfigId,
XmlWorkflowItem wfi,
EPerson actor,
Step newStep,
WorkflowActionConfig newActionConfig)
throws SQLException {
try {
// Fire an event so we can log our action !
Item item = wfi.getItem();
Collection myCollection = wfi.getCollection();
String workflowStepString = null;
List<EPerson> currentEpersonOwners = new ArrayList<EPerson>();
List<Group> currentGroupOwners = new ArrayList<Group>();
// These are only null if our item is sent back to the submission
if (newStep != null && newActionConfig != null) {
workflowStepString = workflowId + "." + newStep.getId() + "." + newActionConfig.getId();
// Retrieve the current owners of the task
List<ClaimedTask> claimedTasks = claimedTaskService.find(c, wfi, newStep.getId());
List<PoolTask> pooledTasks = poolTaskService.find(c, wfi);
for (PoolTask poolTask : pooledTasks) {
if (poolTask.getEperson() != null) {
currentEpersonOwners.add(poolTask.getEperson());
} else {
currentGroupOwners.add(poolTask.getGroup());
}
}
for (ClaimedTask claimedTask : claimedTasks) {
currentEpersonOwners.add(claimedTask.getOwner());
}
}
String previousWorkflowStepString = null;
if (previousStepId != null && previousActionConfigId != null) {
previousWorkflowStepString =
workflowId + "." + previousStepId + "." + previousActionConfigId;
}
// Fire our usage event !
UsageWorkflowEvent usageWorkflowEvent =
new UsageWorkflowEvent(
c, item, wfi, workflowStepString, previousWorkflowStepString, myCollection, actor);
usageWorkflowEvent.setEpersonOwners(
currentEpersonOwners.toArray(new EPerson[currentEpersonOwners.size()]));
usageWorkflowEvent.setGroupOwners(
currentGroupOwners.toArray(new Group[currentGroupOwners.size()]));
DSpaceServicesFactory.getInstance().getEventService().fireEvent(usageWorkflowEvent);
} catch (Exception e) {
// Catch all errors we do not want our workflow to crash because the logging threw an
// exception
log.error(
LogManager.getHeader(
c, "Error while logging workflow event", "Workflow Item: " + wfi.getID()),
e);
}
}
@Override
public WorkspaceItem sendWorkflowItemBackSubmission(
Context context, XmlWorkflowItem wi, EPerson e, String provenance, String rejection_message)
throws SQLException, AuthorizeException, IOException {
String workflowID = null;
String currentStepId = null;
String currentActionConfigId = null;
ClaimedTask claimedTask = claimedTaskService.findByWorkflowIdAndEPerson(context, wi, e);
if (claimedTask != null) {
// Log it
workflowID = claimedTask.getWorkflowID();
currentStepId = claimedTask.getStepID();
currentActionConfigId = claimedTask.getActionID();
}
context.turnOffAuthorisationSystem();
// rejection provenance
Item myitem = wi.getItem();
// Get current date
String now = DCDate.getCurrent().toString();
// Get user's name + email address
String usersName = getEPersonName(e);
// Here's what happened
String provDescription =
provenance
+ " Rejected by "
+ usersName
+ ", reason: "
+ rejection_message
+ " on "
+ now
+ " (GMT) ";
// Add to item as a DC field
itemService.addMetadata(
context,
myitem,
MetadataSchema.DC_SCHEMA,
"description",
"provenance",
"en",
provDescription);
// Clear any workflow schema related metadata
itemService.clearMetadata(
context, myitem, WorkflowRequirementsService.WORKFLOW_SCHEMA, Item.ANY, Item.ANY, Item.ANY);
itemService.update(context, myitem);
// convert into personal workspace
WorkspaceItem wsi = returnToWorkspace(context, wi);
// notify that it's been rejected
notifyOfReject(context, wi, e, rejection_message);
log.info(
LogManager.getHeader(
context,
"reject_workflow",
"workflow_item_id="
+ wi.getID()
+ "item_id="
+ wi.getItem().getID()
+ "collection_id="
+ wi.getCollection().getID()
+ "eperson_id="
+ e.getID()));
logWorkflowEvent(context, workflowID, currentStepId, currentActionConfigId, wi, e, null, null);
context.restoreAuthSystemState();
return wsi;
}