@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;
}
/**
* 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;
}
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);
}
}
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()));
}
}
@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;
}
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);
}
}
