// Create workflow start provenance message
private static void recordStart(Context c, Item myitem)
throws SQLException, IOException, AuthorizeException {
// Get non-internal format bitstreams
Bitstream[] bitstreams = myitem.getNonInternalBitstreams();
// get date
DCDate now = DCDate.getCurrent();
// Create provenance description
String provmessage = "";
if (myitem.getSubmitter() != null) {
provmessage =
"Submitted by "
+ myitem.getSubmitter().getFullName()
+ " ("
+ myitem.getSubmitter().getEmail()
+ ") on "
+ now.toString()
+ "\n";
} else
// null submitter
{
provmessage = "Submitted by unknown (probably automated) on" + now.toString() + "\n";
}
// add sizes and checksums of bitstreams
provmessage += InstallItem.getBitstreamProvenanceMessage(myitem);
// Add message to the DC
myitem.addDC("description", "provenance", "en", provmessage);
myitem.update();
}
// Create workflow start provenance message
protected void recordStart(Context context, Item myitem)
throws SQLException, IOException, AuthorizeException {
// get date
DCDate now = DCDate.getCurrent();
// Create provenance description
String provmessage;
if (myitem.getSubmitter() != null) {
provmessage =
"Submitted by "
+ myitem.getSubmitter().getFullName()
+ " ("
+ myitem.getSubmitter().getEmail()
+ ") on "
+ now.toString()
+ "\n";
} else
// null submitter
{
provmessage = "Submitted by unknown (probably automated) on" + now.toString() + "\n";
}
// add sizes and checksums of bitstreams
provmessage += installItemService.getBitstreamProvenanceMessage(context, myitem);
// Add message to the DC
itemService.addMetadata(
context, myitem, MetadataSchema.DC_SCHEMA, "description", "provenance", "en", provmessage);
itemService.update(context, myitem);
}
public void addListPolicies(List parent, DSpaceObject dso, Collection owningCollection)
throws WingException, SQLException {
if (!isAdvancedFormEnabled) {
return;
}
parent.addLabel(T_head_policies_table);
java.util.List<ResourcePolicy> resourcePolicies =
authorizeService.findPoliciesByDSOAndType(context, dso, ResourcePolicy.TYPE_CUSTOM);
if (resourcePolicies.isEmpty()) {
parent.addItem(T_no_policies);
return;
}
for (ResourcePolicy rp : resourcePolicies) {
int id = rp.getID();
String name = "";
if (rp.getRpName() != null) name = rp.getRpName();
String action = resourcePolicyService.getActionText(rp);
// if it is the default policy for the Submitter don't show it.
if (dso instanceof org.dspace.content.Item) {
org.dspace.content.Item item = (org.dspace.content.Item) dso;
if (rp.getEPerson() != null) {
if (item.getSubmitter().equals(rp.getEPerson())) continue;
}
}
String group = "";
if (rp.getGroup() != null) group = rp.getGroup().getName();
// start
String startDate = "";
if (rp.getStartDate() != null) {
startDate = DateFormatUtils.format(rp.getStartDate(), "yyyy-MM-dd");
}
// endDate
String endDate = "";
if (rp.getEndDate() != null) {
endDate = DateFormatUtils.format(rp.getEndDate(), "yyyy-MM-dd");
}
parent.addItem(T_policy.parameterize(name, action, group, startDate, endDate));
}
}
protected void grantSubmitterReadPolicies(Context context, Item item)
throws SQLException, AuthorizeException {
// A list of policies the user has for this item
List<Integer> userHasPolicies = new ArrayList<Integer>();
List<ResourcePolicy> itempols = authorizeService.getPolicies(context, item);
EPerson submitter = item.getSubmitter();
for (ResourcePolicy resourcePolicy : itempols) {
if (submitter.equals(resourcePolicy.getEPerson())) {
// The user has already got this policy so add it to the list
userHasPolicies.add(resourcePolicy.getAction());
}
}
// Make sure we don't add duplicate policies
if (!userHasPolicies.contains(Constants.READ))
addPolicyToItem(context, item, Constants.READ, submitter);
}
private void populateTableRowFromItem(Item item, TableRow row) {
EPerson submitter = item.getSubmitter();
Collection owningCollection = item.getOwningCollection();
row.setColumn("item_id", item.getID());
row.setColumn("in_archive", item.isArchived());
row.setColumn("withdrawn", item.isWithdrawn());
row.setColumn("last_modified", item.getLastModified());
if (submitter != null) {
row.setColumn("submitter_id", submitter.getID());
}
if (owningCollection != null) {
row.setColumn("owning_collection", owningCollection.getID());
}
}
protected void removeUserItemPolicies(Context context, Item item, EPerson e)
throws SQLException, AuthorizeException {
if (e != null) {
// Also remove any lingering authorizations from this user
authorizeService.removeEPersonPolicies(context, item, e);
// Remove the bundle rights
List<Bundle> bundles = item.getBundles();
for (Bundle bundle : bundles) {
authorizeService.removeEPersonPolicies(context, bundle, e);
List<Bitstream> bitstreams = bundle.getBitstreams();
for (Bitstream bitstream : bitstreams) {
authorizeService.removeEPersonPolicies(context, bitstream, e);
}
}
// Ensure that the submitter always retains his resource policies
if (e.getID().equals(item.getSubmitter().getID())) {
grantSubmitterReadPolicies(context, item);
}
}
}
/** notify the submitter that the item is archived */
private static void notifyOfArchive(Context c, Item i, Collection coll)
throws SQLException, IOException {
try {
// Get submitter
EPerson ep = i.getSubmitter();
// Get the Locale
Locale supportedLocale = I18nUtil.getEPersonLocale(ep);
Email email =
ConfigurationManager.getEmail(
I18nUtil.getEmailFilename(supportedLocale, "submit_archive"));
// Get the item handle to email to user
String handle = HandleManager.findHandle(c, i);
// Get title
DCValue[] titles = i.getDC("title", null, Item.ANY);
String title = "";
try {
title = I18nUtil.getMessage("org.dspace.workflow.WorkflowManager.untitled");
} catch (MissingResourceException e) {
title = "Untitled";
}
if (titles.length > 0) {
title = titles[0].value;
}
email.addRecipient(ep.getEmail());
email.addArgument(title);
email.addArgument(coll.getMetadata("name"));
email.addArgument(HandleManager.getCanonicalForm(handle));
email.send();
} catch (MessagingException e) {
log.warn(
LogManager.getHeader(
c, "notifyOfArchive", "cannot email user" + " item_id=" + i.getID()));
}
}
/**
* 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;
}
/**
* 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()));
}
}
@Override
public XmlWorkflowItem start(Context context, WorkspaceItem wsi)
throws SQLException, AuthorizeException, IOException, WorkflowException {
try {
Item myitem = wsi.getItem();
Collection collection = wsi.getCollection();
Workflow wf = xmlWorkflowFactory.getWorkflow(collection);
XmlWorkflowItem wfi = xmlWorkflowItemService.create(context, myitem, collection);
wfi.setMultipleFiles(wsi.hasMultipleFiles());
wfi.setMultipleTitles(wsi.hasMultipleTitles());
wfi.setPublishedBefore(wsi.isPublishedBefore());
xmlWorkflowItemService.update(context, wfi);
removeUserItemPolicies(context, myitem, myitem.getSubmitter());
grantSubmitterReadPolicies(context, myitem);
context.turnOffAuthorisationSystem();
Step firstStep = wf.getFirstStep();
if (firstStep.isValidStep(context, wfi)) {
activateFirstStep(context, wf, firstStep, wfi);
} else {
// Get our next step, if none is found, archive our item
firstStep = wf.getNextStep(context, wfi, firstStep, ActionResult.OUTCOME_COMPLETE);
if (firstStep == null) {
archive(context, wfi);
} else {
activateFirstStep(context, wf, firstStep, wfi);
}
}
// remove the WorkspaceItem
workspaceItemService.deleteWrapper(context, wsi);
context.restoreAuthSystemState();
return wfi;
} catch (WorkflowConfigurationException e) {
throw new WorkflowException(e);
}
}
/** 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()));
}
}
public void addTablePolicies(Division parent, DSpaceObject dso, Collection owningCollection)
throws WingException, SQLException {
if (!isAdvancedFormEnabled) {
return;
}
Division div = parent.addDivision("access-existing-policies");
div.setHead(T_head_policies_table);
div.addPara(T_policies_help.parameterize(owningCollection));
java.util.List<ResourcePolicy> resourcePolicies =
authorizeService.findPoliciesByDSOAndType(context, dso, ResourcePolicy.TYPE_CUSTOM);
if (resourcePolicies.isEmpty()) {
div.addPara(T_no_policies);
return;
}
int cols = resourcePolicies.size();
if (cols == 0) cols = 1;
Table policies = div.addTable("policies", 6, cols);
Row header = policies.addRow(Row.ROLE_HEADER);
header.addCellContent(T_column0); // name
header.addCellContent(T_column1); // action
header.addCellContent(T_column2); // group
header.addCellContent(T_column3); // start_date
header.addCellContent(T_column4); // end_date
for (ResourcePolicy rp : resourcePolicies) {
int id = rp.getID();
String name = "";
if (rp.getRpName() != null) name = rp.getRpName();
String action = resourcePolicyService.getActionText(rp);
// if it is the default policy for the Submitter don't show it.
if (dso instanceof org.dspace.content.Item) {
org.dspace.content.Item item = (org.dspace.content.Item) dso;
if (rp.getEPerson() != null) {
if (item.getSubmitter().equals(rp.getEPerson())) continue;
}
}
String group = "";
if (rp.getGroup() != null) group = rp.getGroup().getName();
Row row = policies.addRow();
row.addCellContent(name);
row.addCellContent(action);
row.addCellContent(group);
// start
String startDate = "";
if (rp.getStartDate() != null) {
startDate = DateFormatUtils.format(rp.getStartDate(), "yyyy-MM-dd");
}
row.addCellContent(startDate);
// endDate
String endDate = "";
if (rp.getEndDate() != null) {
endDate = DateFormatUtils.format(rp.getEndDate(), "yyyy-MM-dd");
}
row.addCellContent(endDate);
Button edit = row.addCell().addButton("submit_edit_edit_policies_" + id);
edit.setValue(T_table_submit_edit);
Button delete = row.addCell().addButton("submit_delete_edit_policies_" + id);
delete.setValue(T_table_submit_delete);
}
}
public EPerson getSubmitter() throws SQLException {
return item.getSubmitter();
}
