/** * The contents of this file are subject to the license and copyright * detailed in the LICENSE and NOTICE files at the root of the source * tree and available online at * * http://www.dspace.org/license/ */ package org.dspace.sword2; import org.apache.log4j.Logger; import org.dspace.authorize.AuthorizeException; import org.dspace.content.Bitstream; import org.dspace.content.Bundle; import org.dspace.content.Item; import org.dspace.core.Context; import org.dspace.core.LogManager; import org.swordapp.server.AuthCredentials; import org.swordapp.server.Deposit; import org.swordapp.server.DepositReceipt; import org.swordapp.server.MediaResource; import org.swordapp.server.MediaResourceManager; import org.swordapp.server.SwordAuthException; import org.swordapp.server.SwordConfiguration; import org.swordapp.server.SwordError; import org.swordapp.server.SwordServerException; import org.swordapp.server.UriRegistry; import java.io.IOException; import java.io.InputStream; import java.sql.SQLException; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.TreeMap; public class MediaResourceManagerDSpace extends DSpaceSwordAPI implements MediaResourceManager { private static Logger log = Logger.getLogger(MediaResourceManagerDSpace.class); private VerboseDescription verboseDescription = new VerboseDescription(); public MediaResource getMediaResourceRepresentation(String uri, Map<String, String> accept, AuthCredentials authCredentials, SwordConfiguration swordConfig) throws SwordError, SwordServerException, SwordAuthException { try { SwordContext sc = null; SwordConfigurationDSpace config = (SwordConfigurationDSpace) swordConfig; SwordAuthenticator auth = new SwordAuthenticator(); sc = auth.authenticate(authCredentials); Context context = sc.getContext(); if (log.isDebugEnabled()) { log.debug(LogManager.getHeader(context, "sword_get_media_resource", "")); } // log the request String un = authCredentials.getUsername() != null ? authCredentials.getUsername() : "NONE"; String obo = authCredentials.getOnBehalfOf() != null ? authCredentials.getOnBehalfOf() : "NONE"; log.info(LogManager.getHeader(context, "sword_get_media_resource", "username=" + un + ",on_behalf_of=" + obo)); // first thing is to figure out what we're being asked to work on; it may be an Item or a Bitstream SwordUrlManager urlManager = config.getUrlManager(context, config); if (urlManager.isActionableBitstreamUrl(context, uri)) { // we're being asked for the bitstream itself Bitstream bitstream = urlManager.getBitstream(context, uri); // find out, now we know what we're being asked for, whether this is allowed WorkflowManagerFactory.getInstance().retrieveBitstream(context, bitstream); InputStream stream = bitstream.retrieve(); MediaResource mr = new MediaResource(stream, bitstream.getFormat().getMIMEType(), null, true); mr.setContentMD5(bitstream.getChecksum()); mr.setLastModified(this.getLastModified(context, bitstream)); return mr; } else { // we're dealing with a request for a representation of the item as a media resource Item item = urlManager.getItem(context, uri); boolean feedRequest = urlManager.isFeedRequest(context, uri); // find out, now we know what we're being asked for, whether this is allowed WorkflowManagerFactory.getInstance().retrieveContent(context, item); SwordContentDisseminator disseminator = null; // first off, consider the accept headers. The accept argument is a map // from accept header to value. // we only care about Accept and Accept-Packaging if (!feedRequest) { String acceptContentType = this.getHeader(accept, "Accept", null); String acceptPackaging = this.getHeader(accept, "Accept-Packaging", UriRegistry.PACKAGE_SIMPLE_ZIP); // we know that only one Accept-Packaging value is allowed, so we don't need // to do any further work on it. // we extract from the Accept header the ordered list of content types TreeMap<Float, List<String>> analysed = this.analyseAccept(acceptContentType); // the meat of this is done by the package disseminator disseminator = SwordDisseminatorFactory.getContentInstance(analysed, acceptPackaging); } else { // we just want to ask for the atom version, so we bypass the main content // negotiation place Map<Float, List<String>> analysed = new HashMap<Float, List<String>>(); List<String> list = new ArrayList<String>(); list.add("application/atom+xml"); analysed.put((float) 1.0, list); disseminator = SwordDisseminatorFactory.getContentInstance(analysed, null); } // Note that at this stage, if we don't have a desiredContentType, it will // be null, and the disseminator is free to choose the format InputStream stream = disseminator.disseminate(context, item); MediaResource mr = new MediaResource(stream, disseminator.getContentType(), disseminator.getPackaging()); return mr; } } catch (DSpaceSwordException e) { throw new SwordServerException(e); } catch (SQLException e) { throw new SwordServerException(e); } catch (IOException e) { throw new SwordServerException(e); } catch (AuthorizeException e) { throw new SwordServerException(e); } } private Date getLastModified(Context context, Bitstream bitstream) throws SQLException { Date lm = null; for (Bundle bundle : bitstream.getBundles()) { for (Item item : bundle.getItems()) { Date possible = item.getLastModified(); if (lm == null) { lm = possible; } else if (possible.getTime() > lm.getTime()) { lm = possible; } } } if (lm == null) { return new Date(); } return lm; } public DepositReceipt replaceMediaResource(String emUri, Deposit deposit, AuthCredentials authCredentials, SwordConfiguration swordConfig) throws SwordError, SwordServerException, SwordAuthException { // start the timer Date start = new Date(); // store up the verbose description, which we can then give back at the end if necessary this.verboseDescription.append("Initialising verbose replace of media resource"); SwordContext sc = null; SwordConfigurationDSpace config = (SwordConfigurationDSpace) swordConfig; try { sc = this.doAuth(authCredentials); Context context = sc.getContext(); if (log.isDebugEnabled()) { log.debug(LogManager.getHeader(context, "sword_replace", "")); } DepositReceipt receipt = null; SwordUrlManager urlManager = config.getUrlManager(context, config); if (urlManager.isActionableBitstreamUrl(context, emUri)) { Bitstream bitstream = urlManager.getBitstream(context, emUri); // now we have the deposit target, we can determine whether this operation is allowed // at all WorkflowManager wfm = WorkflowManagerFactory.getInstance(); wfm.replaceBitstream(context, bitstream); // check that we can submit to ALL the items this bitstream is in List<Item> items = new ArrayList<Item>(); for (Bundle bundle : bitstream.getBundles()) { for (Item item : bundle.getItems()) { this.checkAuth(sc, item); items.add(item); } } // make a note of the authentication in the verbose string this.verboseDescription.append("Authenticated user: " + sc.getAuthenticated().getEmail()); if (sc.getOnBehalfOf() != null) { this.verboseDescription.append("Depositing on behalf of: " + sc.getOnBehalfOf().getEmail()); } DepositResult result = null; try { result = this.replaceBitstream(sc, items, bitstream, deposit, authCredentials, config); } catch(DSpaceSwordException e) { if (config.isKeepPackageOnFailedIngest()) { try { this.storePackageAsFile(deposit, authCredentials, config); } catch(IOException e2) { log.warn("Unable to store SWORD package as file: " + e); } } throw e; } catch(SwordError e) { if (config.isKeepPackageOnFailedIngest()) { try { this.storePackageAsFile(deposit, authCredentials, config); } catch(IOException e2) { log.warn("Unable to store SWORD package as file: " + e); } } throw e; } // now we've produced a deposit, we need to decide on its workflow state wfm.resolveState(context, deposit, null, this.verboseDescription, false); ReceiptGenerator genny = new ReceiptGenerator(); receipt = genny.createFileReceipt(context, result, config); } else { // get the deposit target Item item = this.getDSpaceTarget(context, emUri, config); // now we have the deposit target, we can determine whether this operation is allowed // at all WorkflowManager wfm = WorkflowManagerFactory.getInstance(); wfm.replaceResourceContent(context, item); // find out if the supplied SWORDContext can submit to the given // dspace object SwordAuthenticator auth = new SwordAuthenticator(); if (!auth.canSubmit(sc, item, this.verboseDescription)) { // throw an exception if the deposit can't be made String oboEmail = "none"; if (sc.getOnBehalfOf() != null) { oboEmail = sc.getOnBehalfOf().getEmail(); } log.info(LogManager.getHeader(context, "replace_failed_authorisation", "user=" + sc.getAuthenticated().getEmail() + ",on_behalf_of=" + oboEmail)); throw new SwordAuthException("Cannot replace the given item with this context"); } // make a note of the authentication in the verbose string this.verboseDescription.append("Authenticated user: " + sc.getAuthenticated().getEmail()); if (sc.getOnBehalfOf() != null) { this.verboseDescription.append("Depositing on behalf of: " + sc.getOnBehalfOf().getEmail()); } try { this.replaceContent(sc, item, deposit, authCredentials, config); } catch(DSpaceSwordException e) { if (config.isKeepPackageOnFailedIngest()) { try { this.storePackageAsFile(deposit, authCredentials, config); } catch(IOException e2) { log.warn("Unable to store SWORD package as file: " + e); } } throw e; } catch(SwordError e) { if (config.isKeepPackageOnFailedIngest()) { try { this.storePackageAsFile(deposit, authCredentials, config); } catch(IOException e2) { log.warn("Unable to store SWORD package as file: " + e); } } throw e; } // now we've produced a deposit, we need to decide on its workflow state wfm.resolveState(context, deposit, null, this.verboseDescription, false); // ReceiptGenerator genny = new ReceiptGenerator(); // DepositReceipt receipt = genny.createReceipt(context, result, config); } Date finish = new Date(); long delta = finish.getTime() - start.getTime(); this.verboseDescription.append("Total time for deposit processing: " + delta + " ms"); // receipt.setVerboseDescription(this.verboseDescription.toString()); // if something hasn't killed it already (allowed), then complete the transaction sc.commit(); // return the receipt for the purposes of the location return receipt; } catch (DSpaceSwordException e) { log.error("caught exception:", e); throw new SwordServerException("There was a problem depositing the item", e); } catch (SQLException e) { throw new SwordServerException(e); } finally { // this is a read operation only, so there's never any need to commit the context if (sc != null) { sc.abort(); } } } public void deleteMediaResource(String emUri, AuthCredentials authCredentials, SwordConfiguration swordConfig) throws SwordError, SwordServerException, SwordAuthException { // start the timer Date start = new Date(); // store up the verbose description, which we can then give back at the end if necessary this.verboseDescription.append("Initialising verbose delete of media resource"); SwordContext sc = null; SwordConfigurationDSpace config = (SwordConfigurationDSpace) swordConfig; try { sc = this.doAuth(authCredentials); Context context = sc.getContext(); if (log.isDebugEnabled()) { log.debug(LogManager.getHeader(context, "sword_delete", "")); } SwordUrlManager urlManager = config.getUrlManager(context, config); WorkflowManager wfm = WorkflowManagerFactory.getInstance(); // get the deposit target if (urlManager.isActionableBitstreamUrl(context, emUri)) { Bitstream bitstream = urlManager.getBitstream(context, emUri); // now we have the deposit target, we can determine whether this operation is allowed // at all wfm.deleteBitstream(context, bitstream); // check that we can submit to ALL the items this bitstream is in List<Item> items = new ArrayList<Item>(); for (Bundle bundle : bitstream.getBundles()) { for (Item item : bundle.getItems()) { this.checkAuth(sc, item); items.add(item); } } // make a note of the authentication in the verbose string this.verboseDescription.append("Authenticated user: " + sc.getAuthenticated().getEmail()); if (sc.getOnBehalfOf() != null) { this.verboseDescription.append("Depositing on behalf of: " + sc.getOnBehalfOf().getEmail()); } this.removeBitstream(sc, bitstream, items, authCredentials, config); } else { Item item = this.getDSpaceTarget(context, emUri, config); // now we have the deposit target, we can determine whether this operation is allowed // at all wfm.deleteMediaResource(context, item); // find out if the supplied SWORDContext can submit to the given // dspace object SwordAuthenticator auth = new SwordAuthenticator(); if (!auth.canSubmit(sc, item, this.verboseDescription)) { // throw an exception if the deposit can't be made String oboEmail = "none"; if (sc.getOnBehalfOf() != null) { oboEmail = sc.getOnBehalfOf().getEmail(); } log.info(LogManager.getHeader(context, "replace_failed_authorisation", "user=" + sc.getAuthenticated().getEmail() + ",on_behalf_of=" + oboEmail)); throw new SwordAuthException("Cannot replace the given item with this context"); } // make a note of the authentication in the verbose string this.verboseDescription.append("Authenticated user: " + sc.getAuthenticated().getEmail()); if (sc.getOnBehalfOf() != null) { this.verboseDescription.append("Depositing on behalf of: " + sc.getOnBehalfOf().getEmail()); } // do the business of removal this.removeContent(sc, item, authCredentials, config); } // now we've produced a deposit, we need to decide on its workflow state wfm.resolveState(context, null, null, this.verboseDescription, false); //ReceiptGenerator genny = new ReceiptGenerator(); //DepositReceipt receipt = genny.createReceipt(context, result, config); Date finish = new Date(); long delta = finish.getTime() - start.getTime(); this.verboseDescription.append("Total time for deposit processing: " + delta + " ms"); // receipt.setVerboseDescription(this.verboseDescription.toString()); // if something hasn't killed it already (allowed), then complete the transaction sc.commit(); // So, we don't actually return a receipt, but it was useful constructing it. Perhaps this will // change in the spec? } catch (DSpaceSwordException e) { log.error("caught exception:", e); throw new SwordServerException("There was a problem depositing the item", e); } catch (SQLException e) { throw new SwordServerException(e); } finally { // this is a read operation only, so there's never any need to commit the context if (sc != null) { sc.abort(); } } } public DepositReceipt addResource(String emUri, Deposit deposit, AuthCredentials authCredentials, SwordConfiguration swordConfig) throws SwordError, SwordServerException, SwordAuthException { // start the timer Date start = new Date(); // store up the verbose description, which we can then give back at the end if necessary this.verboseDescription.append("Initialising verbose add to media resource"); SwordContext sc = null; SwordConfigurationDSpace config = (SwordConfigurationDSpace) swordConfig; try { sc = this.doAuth(authCredentials); Context context = sc.getContext(); if (log.isDebugEnabled()) { log.debug(LogManager.getHeader(context, "sword_add", "")); } // get the deposit target Item item = this.getDSpaceTarget(context, emUri, config); // now we have the deposit target, we can determine whether this operation is allowed // at all WorkflowManager wfm = WorkflowManagerFactory.getInstance(); wfm.addResourceContent(context, item); // find out if the supplied SWORDContext can submit to the given // dspace object SwordAuthenticator auth = new SwordAuthenticator(); if (!auth.canSubmit(sc, item, this.verboseDescription)) { // throw an exception if the deposit can't be made String oboEmail = "none"; if (sc.getOnBehalfOf() != null) { oboEmail = sc.getOnBehalfOf().getEmail(); } log.info(LogManager.getHeader(context, "replace_failed_authorisation", "user=" + sc.getAuthenticated().getEmail() + ",on_behalf_of=" + oboEmail)); throw new SwordAuthException("Cannot replace the given item with this context"); } // make a note of the authentication in the verbose string this.verboseDescription.append("Authenticated user: " + sc.getAuthenticated().getEmail()); if (sc.getOnBehalfOf() != null) { this.verboseDescription.append("Depositing on behalf of: " + sc.getOnBehalfOf().getEmail()); } DepositResult result = null; try { result = this.addContent(sc, item, deposit, authCredentials, config); if (deposit.isMultipart()) { ContainerManagerDSpace cm = new ContainerManagerDSpace(); result = cm.doAddMetadata(sc, item, deposit, authCredentials, config, result); } } catch(DSpaceSwordException e) { if (config.isKeepPackageOnFailedIngest()) { try { this.storePackageAsFile(deposit, authCredentials, config); if (deposit.isMultipart()) { this.storeEntryAsFile(deposit, authCredentials, config); } } catch(IOException e2) { log.warn("Unable to store SWORD package as file: " + e); } } throw e; } catch(SwordError e) { if (config.isKeepPackageOnFailedIngest()) { try { this.storePackageAsFile(deposit, authCredentials, config); if (deposit.isMultipart()) { this.storeEntryAsFile(deposit, authCredentials, config); } } catch(IOException e2) { log.warn("Unable to store SWORD package as file: " + e); } } throw e; } // now we've produced a deposit, we need to decide on its workflow state wfm.resolveState(context, deposit, null, this.verboseDescription, false); ReceiptGenerator genny = new ReceiptGenerator(); // Now, this bit is tricky: DepositReceipt receipt; // If this was a single file deposit, then we don't return a receipt, we just // want to specify the location header if (deposit.getPackaging().equals(UriRegistry.PACKAGE_BINARY)) { receipt = genny.createFileReceipt(context, result, config); } // if, on the other-hand, this was a package, then we want to generate a // deposit receipt proper, but with the location being for the media resource else { receipt = genny.createReceipt(context, result, config, true); } Date finish = new Date(); long delta = finish.getTime() - start.getTime(); this.verboseDescription.append("Total time for add processing: " + delta + " ms"); receipt.setVerboseDescription(this.verboseDescription.toString()); // if something hasn't killed it already (allowed), then complete the transaction sc.commit(); return receipt; } catch (DSpaceSwordException e) { log.error("caught exception:", e); throw new SwordServerException("There was a problem depositing the item", e); } finally { // this is a read operation only, so there's never any need to commit the context if (sc != null) { sc.abort(); } } } private void removeContent(SwordContext swordContext, Item item, AuthCredentials authCredentials, SwordConfigurationDSpace swordConfig) throws DSpaceSwordException, SwordAuthException { try { // remove content only really means everything from the ORIGINAL bundle VersionManager vm = new VersionManager(); Bundle[] originals = item.getBundles("ORIGINAL"); for (Bundle original : originals) { vm.emptyBundle(item, original); } } catch (SQLException e) { throw new DSpaceSwordException(e); } catch (AuthorizeException e) { throw new SwordAuthException(e); } catch (IOException e) { throw new DSpaceSwordException(e); } } private void removeBitstream(SwordContext swordContext, Bitstream bitstream, List<Item> items, AuthCredentials authCredentials, SwordConfigurationDSpace swordConfig) throws DSpaceSwordException, SwordAuthException { try { // remove content only really means everything from the ORIGINAL bundle VersionManager vm = new VersionManager(); for (Item item : items) { vm.removeBitstream(item, bitstream); } } catch (SQLException e) { throw new DSpaceSwordException(e); } catch (AuthorizeException e) { throw new SwordAuthException(e); } catch (IOException e) { throw new DSpaceSwordException(e); } } private void replaceContent(SwordContext swordContext, Item item, Deposit deposit, AuthCredentials authCredentials, SwordConfigurationDSpace swordConfig) throws DSpaceSwordException, SwordError, SwordAuthException, SwordServerException { // get the things out of the service that we need Context context = swordContext.getContext(); SwordUrlManager urlManager = swordConfig.getUrlManager(swordContext.getContext(), swordConfig); // is the content acceptable? If not, this will throw an error this.isAcceptable(swordConfig, context, deposit, item); // Obtain the relevant ingester from the factory SwordContentIngester si = SwordIngesterFactory.getContentInstance(context, deposit, null); this.verboseDescription.append("Loaded ingester: " + si.getClass().getName()); try { // delegate the to the version manager to get rid of any existing content and to version // if if necessary VersionManager vm = new VersionManager(); vm.emptyBundle(item, "ORIGINAL"); } catch (SQLException e) { throw new DSpaceSwordException(e); } catch (AuthorizeException e) { throw new SwordAuthException(e); } catch (IOException e) { throw new DSpaceSwordException(e); } // do the deposit DepositResult result = si.ingest(context, deposit, item, this.verboseDescription); this.verboseDescription.append("Replace completed successfully"); // store the originals (this code deals with the possibility that that's not required) this.storeOriginals(swordConfig, context, this.verboseDescription, deposit, result); } private DepositResult replaceBitstream(SwordContext swordContext, List<Item> items, Bitstream bitstream, Deposit deposit, AuthCredentials authCredentials, SwordConfigurationDSpace swordConfig) throws DSpaceSwordException, SwordError, SwordAuthException, SwordServerException { // FIXME: this is basically not possible with the existing DSpace API. // we are going to hack around the problem, by deleting the old bitstream and // adding the new one and returning it // get the things out of the service that we need Context context = swordContext.getContext(); SwordUrlManager urlManager = swordConfig.getUrlManager(swordContext.getContext(), swordConfig); // is the content acceptable to the items? If not, this will throw an error for (Item item : items) { this.isAcceptable(swordConfig, context, deposit, item); } // Obtain the relevant ingester from the factory SwordContentIngester si = SwordIngesterFactory.getContentInstance(context, deposit, null); this.verboseDescription.append("Loaded ingester: " + si.getClass().getName()); try { // first we delete the original bitstream this.removeBitstream(swordContext, bitstream, items, authCredentials, swordConfig); DepositResult result = null; boolean first = true; for (Item item : items) { if (first) { // just do this to the first item result = this.addContent(swordContext, item, deposit, authCredentials, swordConfig); } else { // now duplicate the bitstream to all the others Bundle[] bundles = item.getBundles("ORIGINAL"); if (bundles.length > 0) { bundles[0].addBitstream(result.getOriginalDeposit()); } else { Bundle bundle = item.createBundle("ORIGINAL"); bundle.addBitstream(result.getOriginalDeposit()); } } } // DepositResult result = si.ingest(context, deposit, items, this.verboseDescription); this.verboseDescription.append("Replace completed successfully"); return result; } catch (SQLException e) { throw new DSpaceSwordException(e); } catch (AuthorizeException e) { throw new SwordAuthException(e); } } private DepositResult addContent(SwordContext swordContext, Item item, Deposit deposit, AuthCredentials authCredentials, SwordConfigurationDSpace swordConfig) throws DSpaceSwordException, SwordError, SwordAuthException, SwordServerException { // get the things out of the service that we need Context context = swordContext.getContext(); SwordUrlManager urlManager = swordConfig.getUrlManager(swordContext.getContext(), swordConfig); // is the content acceptable? If not, this will throw an error this.isAcceptable(swordConfig, context, deposit, item); // Obtain the relevant ingester from the factory SwordContentIngester si = SwordIngesterFactory.getContentInstance(context, deposit, null); this.verboseDescription.append("Loaded ingester: " + si.getClass().getName()); // do the deposit DepositResult result = si.ingest(context, deposit, item, this.verboseDescription); this.verboseDescription.append("Add completed successfully"); // store the originals (this code deals with the possibility that that's not required) this.storeOriginals(swordConfig, context, this.verboseDescription, deposit, result); return result; } private Item getDSpaceTarget(Context context, String editMediaUrl, SwordConfigurationDSpace config) throws DSpaceSwordException, SwordError { SwordUrlManager urlManager = config.getUrlManager(context, config); // get the target collection Item item = urlManager.getItem(context, editMediaUrl); this.verboseDescription.append("Performing replace using edit-media URL: " + editMediaUrl); this.verboseDescription.append("Location resolves to item with handle: " + item.getHandle()); return item; } private void checkAuth(SwordContext sc, Item item) throws DSpaceSwordException, SwordError, SwordAuthException { Context context = sc.getContext(); SwordAuthenticator auth = new SwordAuthenticator(); if (!auth.canSubmit(sc, item, this.verboseDescription)) { // throw an exception if the deposit can't be made String oboEmail = "none"; if (sc.getOnBehalfOf() != null) { oboEmail = sc.getOnBehalfOf().getEmail(); } log.info(LogManager.getHeader(context, "replace_failed_authorisation", "user=" + sc.getAuthenticated().getEmail() + ",on_behalf_of=" + oboEmail)); throw new SwordAuthException("Cannot replace the given item with this context"); } } }