/**
* 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.content.packager;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.sql.SQLException;
import java.util.List;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.ParserConfigurationException;
import org.dspace.authorize.AuthorizeException;
import org.dspace.content.Collection;
import org.dspace.content.Community;
import org.dspace.content.DSpaceObject;
import org.dspace.content.crosswalk.CrosswalkException;
import org.dspace.core.Constants;
import org.dspace.core.Context;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.Group;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xml.sax.SAXException;
/**
* Create EPersons and Groups from a file of external representations.
*
* @author mwood
*/
public class RoleIngester implements PackageIngester
{
private static final Logger log = LoggerFactory
.getLogger(RoleIngester.class);
/**
* Common code to ingest roles from a Document.
*
* @param context
* DSpace Context
* @param parent
* the Parent DSpaceObject
* @param document
* the XML Document
* @throws SQLException
* @throws AuthorizeException
* @throws PackageException
*/
static void ingestDocument(Context context, DSpaceObject parent,
PackageParameters params, Document document)
throws SQLException, AuthorizeException, PackageException
{
String myEmail = context.getCurrentUser().getEmail();
String myNetid = context.getCurrentUser().getNetid();
// Ingest users (EPersons) first so Groups can use them
NodeList users = document
.getElementsByTagName(RoleDisseminator.EPERSON);
for (int i = 0; i < users.getLength(); i++)
{
Element user = (Element) users.item(i);
// int userID = Integer.valueOf(user.getAttribute("ID")); // FIXME
// no way to set ID!
NodeList emails = user.getElementsByTagName(RoleDisseminator.EMAIL);
NodeList netids = user.getElementsByTagName(RoleDisseminator.NETID);
EPerson eperson;
EPerson collider;
String email = null;
String netid = null;
String identity;
if (emails.getLength() > 0)
{
email = emails.item(0).getTextContent();
if (email.equals(myEmail))
{
continue; // Cannot operate on my own EPerson!
}
identity = email;
collider = EPerson.findByEmail(context, identity);
// collider = EPerson.find(context, userID);
}
else if (netids.getLength() > 0)
{
netid = netids.item(0).getTextContent();
if (netid.equals(myNetid))
{
continue; // Cannot operate on my own EPerson!
}
identity = netid;
collider = EPerson.findByNetid(context, identity);
}
else
{
throw new PackageException("EPerson has neither email nor netid.");
}
if (null != collider)
if (params.replaceModeEnabled()) // -r -f
{
eperson = collider;
}
else if (params.keepExistingModeEnabled()) // -r -k
{
log.warn("Existing EPerson {} was not restored from the package.", identity);
continue;
}
else
{
throw new PackageException("EPerson " + identity + " already exists.");
}
else
{
eperson = EPerson.create(context);
log.info("Created EPerson {}.", identity);
}
eperson.setEmail(email);
eperson.setNetid(netid);
NodeList data;
data = user.getElementsByTagName(RoleDisseminator.FIRST_NAME);
if (data.getLength() > 0)
{
eperson.setFirstName(data.item(0).getTextContent());
}
else
{
eperson.setFirstName(null);
}
data = user.getElementsByTagName(RoleDisseminator.LAST_NAME);
if (data.getLength() > 0)
{
eperson.setLastName(data.item(0).getTextContent());
}
else
{
eperson.setLastName(null);
}
data = user.getElementsByTagName(RoleDisseminator.LANGUAGE);
if (data.getLength() > 0)
{
eperson.setLanguage(data.item(0).getTextContent());
}
else
{
eperson.setLanguage(null);
}
data = user.getElementsByTagName(RoleDisseminator.CAN_LOGIN);
eperson.setCanLogIn(data.getLength() > 0);
data = user.getElementsByTagName(RoleDisseminator.REQUIRE_CERTIFICATE);
eperson.setRequireCertificate(data.getLength() > 0);
data = user.getElementsByTagName(RoleDisseminator.SELF_REGISTERED);
eperson.setSelfRegistered(data.getLength() > 0);
data = user.getElementsByTagName(RoleDisseminator.PASSWORD_HASH);
if (data.getLength() > 0)
{
eperson.setPasswordHash(data.item(0).getTextContent());
}
else
{
eperson.setPasswordHash(null);
}
// Actually write Eperson info to DB
// NOTE: this update() doesn't call a commit(). So, Eperson info
// may still be rolled back if a subsequent error occurs
eperson.update();
}
// Now ingest the Groups
NodeList groups = document.getElementsByTagName(RoleDisseminator.GROUP);
// Create the groups and add their EPerson members
for (int groupx = 0; groupx < groups.getLength(); groupx++)
{
Element group = (Element) groups.item(groupx);
String name = group.getAttribute(RoleDisseminator.NAME);
try
{
//Translate Group name back to internal ID format (e.g. COLLECTION_<ID>_ADMIN)
// TODO: is this necessary? can we leave it in format with Handle in place of <ID>?
// For now, this is necessary, because we don't want to accidentally
// create a new group COLLECTION_hdl:123/34_ADMIN, which is equivalent
// to an existing COLLECTION_45_ADMIN group
name = PackageUtils.translateGroupNameForImport(context, name);
}
catch(PackageException pe)
{
// If an error is thrown, then this Group corresponds to a
// Community or Collection that doesn't currently exist in the
// system. So, log a warning & skip it for now.
log.warn("Skipping group named '" + name + "' as it seems to correspond to a Community or Collection that does not exist in the system. " +
"If you are performing an AIP restore, you can ignore this warning as the Community/Collection AIP will likely create this group once it is processed.");
continue;
}
Group groupObj = null; // The group to restore
Group collider = Group.findByName(context, name); // Existing group?
if (null != collider)
{ // Group already exists, so empty it
if (params.replaceModeEnabled()) // -r -f
{
for (Group member : collider.getMemberGroups())
{
collider.removeMember(member);
}
for (EPerson member : collider.getMembers())
{
// Remove all group members *EXCEPT* we don't ever want
// to remove the current user from the list of Administrators
// (otherwise remainder of ingest will fail)
if(!(collider.equals(Group.find(context, 1)) &&
member.equals(context.getCurrentUser())))
{
collider.removeMember(member);
}
}
log.info("Existing Group {} was cleared. Its members will be replaced.", name);
groupObj = collider;
}
else if (params.keepExistingModeEnabled()) // -r -k
{
log.warn("Existing Group {} was not replaced from the package.",
name);
continue;
}
else
{
throw new PackageException("Group " + name + " already exists");
}
}
else
{ // No such group exists -- so, we'll need to create it!
// First Check if this is a "typed" group (i.e. Community or Collection associated Group)
// If so, we'll create it via the Community or Collection
String type = group.getAttribute(RoleDisseminator.TYPE);
if(type!=null && !type.isEmpty() && parent!=null)
{
//What type of dspace object is this group associated with
if(parent.getType()==Constants.COLLECTION)
{
Collection collection = (Collection) parent;
// Create this Collection-associated group, based on its group type
if(type.equals(RoleDisseminator.GROUP_TYPE_ADMIN))
{
groupObj = collection.createAdministrators();
}
else if(type.equals(RoleDisseminator.GROUP_TYPE_SUBMIT))
{
groupObj = collection.createSubmitters();
}
else if(type.equals(RoleDisseminator.GROUP_TYPE_WORKFLOW_STEP_1))
{
groupObj = collection.createWorkflowGroup(1);
}
else if(type.equals(RoleDisseminator.GROUP_TYPE_WORKFLOW_STEP_2))
{
groupObj = collection.createWorkflowGroup(2);
}
else if(type.equals(RoleDisseminator.GROUP_TYPE_WORKFLOW_STEP_3))
{
groupObj = collection.createWorkflowGroup(3);
}
}
else if(parent.getType()==Constants.COMMUNITY)
{
Community community = (Community) parent;
// Create this Community-associated group, based on its group type
if(type.equals(RoleDisseminator.GROUP_TYPE_ADMIN))
{
groupObj = community.createAdministrators();
}
}
//Ignore all other dspace object types
}
//If group not yet created, create it with the given name
if(groupObj==null)
{
groupObj = Group.create(context);
}
// Always set the name: parent.createBlop() is guessing
groupObj.setName(name);
log.info("Created Group {}.", groupObj.getName());
}
// Add EPeople to newly created Group
NodeList members = group.getElementsByTagName(RoleDisseminator.MEMBER);
for (int memberx = 0; memberx < members.getLength(); memberx++)
{
Element member = (Element) members.item(memberx);
String memberName = member.getAttribute(RoleDisseminator.NAME);
EPerson memberEPerson = EPerson.findByEmail(context, memberName);
if (null != memberEPerson)
groupObj.addMember(memberEPerson);
else
throw new PackageValidationException("EPerson " + memberName
+ " not found, not added to " + name);
}
// Actually write Group info to DB
// NOTE: this update() doesn't call a commit(). So, Group info
// may still be rolled back if a subsequent error occurs
groupObj.update();
}
// Go back and add Group members, now that all groups exist
for (int groupx = 0; groupx < groups.getLength(); groupx++)
{
Element group = (Element) groups.item(groupx);
String name = group.getAttribute(RoleDisseminator.NAME);
try
{
// Translate Group name back to internal ID format (e.g. COLLECTION_<ID>_ADMIN)
name = PackageUtils.translateGroupNameForImport(context, name);
}
catch(PackageException pe)
{
// If an error is thrown, then this Group corresponds to a
// Community or Collection that doesn't currently exist in the
// system. So,skip it for now.
// (NOTE: We already logged a warning about this group earlier as
// this is the second time we are looping through all groups)
continue;
}
// Find previously created group
Group groupObj = Group.findByName(context, name);
NodeList members = group
.getElementsByTagName(RoleDisseminator.MEMBER_GROUP);
for (int memberx = 0; memberx < members.getLength(); memberx++)
{
Element member = (Element) members.item(memberx);
String memberName = member.getAttribute(RoleDisseminator.NAME);
//Translate Group name back to internal ID format (e.g. COLLECTION_<ID>_ADMIN)
memberName = PackageUtils.translateGroupNameForImport(context, memberName);
// Find previously created group
Group memberGroup = Group.findByName(context, memberName);
groupObj.addMember(memberGroup);
}
// Actually update Group info in DB
// NOTE: Group info may still be rolled back if a subsequent error occurs
groupObj.update();
}
}
/**
* Ingest roles from an InputStream.
*
* @param context
* DSpace Context
* @param parent
* the Parent DSpaceObject
* @param stream
* the XML Document InputStream
* @throws PackageException
* @throws SQLException
* @throws AuthorizeException
*/
public static void ingestStream(Context context, DSpaceObject parent,
PackageParameters params, InputStream stream)
throws PackageException, SQLException, AuthorizeException
{
Document document;
try
{
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setIgnoringComments(true);
dbf.setCoalescing(true);
DocumentBuilder db = dbf.newDocumentBuilder();
document = db.parse(stream);
}
catch (ParserConfigurationException e)
{
throw new PackageException(e);
}
catch (SAXException e)
{
throw new PackageException(e);
}
catch (IOException e)
{
throw new PackageException(e);
}
/*
* TODO ? finally { close(stream); }
*/
ingestDocument(context, parent, params, document);
}
/*
* (non-Javadoc)
*
* @see
* org.dspace.content.packager.PackageIngester#ingest(org.dspace.core.Context
* , org.dspace.content.DSpaceObject, java.io.File,
* org.dspace.content.packager.PackageParameters, java.lang.String)
*/
@Override
public DSpaceObject ingest(Context context, DSpaceObject parent,
File pkgFile, PackageParameters params, String license)
throws PackageException, CrosswalkException, AuthorizeException,
SQLException, IOException
{
Document document;
try
{
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setIgnoringComments(true);
dbf.setCoalescing(true);
DocumentBuilder db = dbf.newDocumentBuilder();
document = db.parse(pkgFile);
}
catch (ParserConfigurationException e)
{
throw new PackageException(e);
}
catch (SAXException e)
{
throw new PackageException(e);
}
ingestDocument(context, parent, params, document);
/* Does not create a DSpaceObject */
return null;
}
/*
* (non-Javadoc)
*
* @see
* org.dspace.content.packager.PackageIngester#ingestAll(org.dspace.core
* .Context, org.dspace.content.DSpaceObject, java.io.File,
* org.dspace.content.packager.PackageParameters, java.lang.String)
*/
@Override
public List<DSpaceObject> ingestAll(Context context, DSpaceObject parent,
File pkgFile, PackageParameters params, String license)
throws PackageException, UnsupportedOperationException,
CrosswalkException, AuthorizeException, SQLException, IOException
{
throw new PackageException(
"ingestAll() is not implemented, as ingest() method already handles ingestion of all roles from an external file.");
}
/*
* (non-Javadoc)
*
* @see
* org.dspace.content.packager.PackageIngester#replace(org.dspace.core.Context
* , org.dspace.content.DSpaceObject, java.io.File,
* org.dspace.content.packager.PackageParameters)
*/
@Override
public DSpaceObject replace(Context context, DSpaceObject dso,
File pkgFile, PackageParameters params) throws PackageException,
UnsupportedOperationException, CrosswalkException,
AuthorizeException, SQLException, IOException
{
//Just call ingest() -- this will perform a replacement as necessary
return ingest(context, dso, pkgFile, params, null);
}
/*
* (non-Javadoc)
*
* @see
* org.dspace.content.packager.PackageIngester#replaceAll(org.dspace.core
* .Context, org.dspace.content.DSpaceObject, java.io.File,
* org.dspace.content.packager.PackageParameters)
*/
@Override
public List<DSpaceObject> replaceAll(Context context, DSpaceObject dso,
File pkgFile, PackageParameters params) throws PackageException,
UnsupportedOperationException, CrosswalkException,
AuthorizeException, SQLException, IOException
{
throw new PackageException(
"replaceAll() is not implemented, as replace() method already handles replacement of all roles from an external file.");
}
/**
* Returns a user help string which should describe the
* additional valid command-line options that this packager
* implementation will accept when using the <code>-o</code> or
* <code>--option</code> flags with the Packager script.
*
* @return a string describing additional command-line options available
* with this packager
*/
@Override
public String getParameterHelp()
{
return "No additional options available.";
}
}