/*
* DSpaceMETSIngester
*
* Version: $Revision: 4575 $
*
* Date: $Date: 2009-11-30 21:37:44 +0000 (Mon, 30 Nov 2009) $
*
* Copyright (c) 2002-2009, The DSpace Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* - Neither the name of the DSpace Foundation nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
* USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*/
package org.dspace.content.packager;
import java.io.IOException;
import java.sql.SQLException;
import java.util.Set;
import org.apache.log4j.Logger;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Bitstream;
import org.dspace.content.Bundle;
import org.dspace.content.Collection;
import org.dspace.content.Item;
import org.dspace.content.crosswalk.CrosswalkException;
import org.dspace.content.crosswalk.MetadataValidationException;
import org.dspace.core.Context;
import org.dspace.license.CreativeCommons;
import org.jdom.Element;
/**
* Packager plugin to ingest a
* METS (Metadata Encoding & Transmission Standard) package
* that conforms to the DSpace METS SIP (Submission Information Package) Profile.
* See <a href="http://www.loc.gov/standards/mets/">http://www.loc.gov/standards/mets/</a>
* for more information on METS, and
* <a href="http://www.dspace.org/standards/METS/SIP/profilev0p9p1/metssipv0p9p1.pdf">
* http://www.dspace.org/standards/METS/SIP/profilev0p9p1/metssipv0p9p1.pdf</a>
* (or a similar file in the /standards/METS/SIP resource hierarchy)
* for more information about the DSpace METS SIP profile.
*
* @author Larry Stone
* @version $Revision: 4575 $
* @see org.dspace.content.packager.METSManifest
*/
public class DSpaceMETSIngester
extends AbstractMETSIngester
{
/** log4j category */
private static Logger log = Logger.getLogger(DSpaceMETSIngester.class);
// first part of required mets@PROFILE value
private final static String PROFILE_START = "DSpace METS SIP Profile";
// just check the profile name.
void checkManifest(METSManifest manifest)
throws MetadataValidationException
{
String profile = manifest.getProfile();
if (profile == null)
throw new MetadataValidationException("Cannot accept METS with no PROFILE attribute!");
else if (!profile.startsWith(PROFILE_START))
throw new MetadataValidationException("METS has unacceptable PROFILE value, profile="+profile);
}
// nothing needed.
public void checkPackageFiles(Set packageFiles, Set missingFiles,
METSManifest manifest)
throws PackageValidationException, CrosswalkException
{
// This is where a subclass would arrange to use or ignore
// any "extra" files added to its type of package.
}
/**
* Choose DMD section(s) to crosswalk.
* <p>
* The algorithm is:<br>
* 1. Use whatever the <code>dmd</code> parameter specifies as the primary DMD.<br>
* 2. If (1) is unspecified, find MODS (preferably) or DC as primary DMD.<br>
* 3. If (1) or (2) succeeds, crosswalk it and ignore all other DMDs with
* same GROUPID<br>
* 4. Crosswalk remaining DMDs not eliminated already.
*/
public void chooseItemDmd(Context context, Item item,
METSManifest manifest,
AbstractMETSIngester.MdrefManager callback,
Element dmds[], PackageParameters params)
throws CrosswalkException,
AuthorizeException, SQLException, IOException
{
int found = -1;
// Check to see what dmdSec the user specified in the 'dmd' parameter
String userDmd = null;
if (params != null)
userDmd = params.getProperty("dmd");
if (userDmd != null && userDmd.length() > 0)
{
for (int i = 0; i < dmds.length; ++i)
if (userDmd.equalsIgnoreCase(manifest.getMdType(dmds[i])))
found = i;
}
// MODS is preferred, if nothing specified by user
if (found == -1)
{
for (int i = 0; i < dmds.length; ++i)
//NOTE: METS standard actually says this should be MODS (all uppercase). But,
// just in case, we're going to be a bit more forgiving.
if ("MODS".equalsIgnoreCase(manifest.getMdType(dmds[i])))
found = i;
}
// DC acceptable if no MODS
if (found == -1)
{
for (int i = 0; i < dmds.length; ++i)
//NOTE: METS standard actually says this should be DC (all uppercase). But,
// just in case, we're going to be a bit more forgiving.
if ("DC".equalsIgnoreCase(manifest.getMdType(dmds[i])))
found = i;
}
String groupID = null;
if (found >= 0)
{
manifest.crosswalkItem(context, item, dmds[found], callback);
groupID = dmds[found].getAttributeValue("GROUPID");
if (groupID != null)
{
for (int i = 0; i < dmds.length; ++i)
{
String g = dmds[i].getAttributeValue("GROUPID");
if (g != null && !g.equals(groupID))
manifest.crosswalkItem(context, item, dmds[i], callback);
}
}
}
// otherwise take the first. Don't xwalk more than one because
// each xwalk _adds_ metadata, and could add duplicate fields.
else
{
if (dmds.length > 0)
manifest.crosswalkItem(context, item, dmds[0], callback);
}
}
/**
* Policy: For DSpace deposit license, take deposit license
* supplied by explicit argument first, else use collection's
* default deposit license.
* For Creative Commons, look for a rightsMd containing a CC license.
*/
public void addLicense(Context context, Collection collection,
Item item, METSManifest manifest,
AbstractMETSIngester.MdrefManager callback,
String license)
throws PackageValidationException, CrosswalkException,
AuthorizeException, SQLException, IOException
{
PackageUtils.addDepositLicense(context, license, item, collection);
// If package includes a Creative Commons license, add that:
Element rmds[] = manifest.getItemRightsMD();
for (int i = 0; i < rmds.length; ++i)
{
String type = manifest.getMdType(rmds[i]);
if (type != null && type.equals("Creative Commons"))
{
log.debug("Got Creative Commons license in rightsMD");
CreativeCommons.setLicense(context, item,
manifest.getMdContentAsStream(rmds[i], callback),
manifest.getMdContentMimeType(rmds[i]));
// if there was a bitstream, get rid of it, since
// it's just an artifact now that the CC license is installed.
Element mdRef = rmds[i].getChild("mdRef", METSManifest.metsNS);
if (mdRef != null)
{
Bitstream bs = callback.getBitstreamForMdRef(mdRef);
if (bs != null)
{
Bundle parent[] = bs.getBundles();
if (parent.length > 0)
{
parent[0].removeBitstream(bs);
parent[0].update();
}
}
}
}
}
}
// last change to fix up Item.
public void finishItem(Context context, Item item)
throws PackageValidationException, CrosswalkException,
AuthorizeException, SQLException, IOException
{
// nothing to do.
}
}