/**
* 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.dspace.authenticate.factory.AuthenticateServiceFactory;
import org.dspace.authenticate.service.AuthenticationService;
import org.dspace.authorize.factory.AuthorizeServiceFactory;
import org.dspace.authorize.service.AuthorizeService;
import org.dspace.content.factory.ContentServiceFactory;
import org.dspace.content.service.CollectionService;
import org.dspace.content.service.CommunityService;
import org.dspace.content.service.ItemService;
import org.dspace.core.Context;
import org.dspace.core.LogManager;
import org.dspace.core.Constants;
import org.dspace.authenticate.AuthenticationMethod;
import org.dspace.eperson.EPerson;
import org.dspace.eperson.Group;
import org.dspace.content.*;
import org.apache.log4j.Logger;
import org.dspace.eperson.factory.EPersonServiceFactory;
import org.dspace.eperson.service.EPersonService;
import org.dspace.services.ConfigurationService;
import org.dspace.services.factory.DSpaceServicesFactory;
import org.swordapp.server.AuthCredentials;
import org.swordapp.server.SwordAuthException;
import org.swordapp.server.SwordError;
import org.swordapp.server.UriRegistry;
import java.sql.SQLException;
import java.util.Iterator;
import java.util.List;
import java.util.ArrayList;
import org.apache.commons.lang.StringUtils;
/**
* This class offers a thin wrapper for the default DSpace
* authentication module for the SWORD implementation
*
* @author Richard Jones
*
*/
public class SwordAuthenticator
{
/** logger */
private static Logger log = Logger.getLogger(SwordAuthenticator.class);
protected AuthenticationService authenticationService =
AuthenticateServiceFactory.getInstance().getAuthenticationService();
protected AuthorizeService authorizeService =
AuthorizeServiceFactory.getInstance().getAuthorizeService();
protected EPersonService ePersonService =
EPersonServiceFactory.getInstance().getEPersonService();
protected CommunityService communityService =
ContentServiceFactory.getInstance().getCommunityService();
protected CollectionService collectionService =
ContentServiceFactory.getInstance().getCollectionService();
protected ItemService itemService =
ContentServiceFactory.getInstance().getItemService();
protected ConfigurationService configurationService =
DSpaceServicesFactory.getInstance().getConfigurationService();
/**
* Does the given username and password authenticate for the
* given DSpace Context?
*
* @param context
* The relevant DSpace Context.
* @param un
* username
* @param pw
* password
* @return true if authenticates successfully, false if not
*/
public boolean authenticates(Context context, String un, String pw)
{
int auth = authenticationService.authenticate(
context, un, pw, null, null);
return auth == AuthenticationMethod.SUCCESS;
}
/**
* Construct the context object member variable of this class
* using the passed IP address as part of the loggable
* information
*
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
private Context constructContext()
throws DSpaceSwordException
{
Context context = new Context();
// Set the session ID and IP address
context.setExtraLogInfo("session_id=0");
return context;
}
/**
* Authenticate the given service document request. This extracts the appropriate
* information from the request and forwards to the appropriate authentication
* method
*
* @param auth
* authentication credentials
* @return SWORD context
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
* @throws SwordError
* SWORD error per SWORD spec
* @throws SwordAuthException
* thrown if unable to authenticate
*/
public SwordContext authenticate(AuthCredentials auth)
throws DSpaceSwordException, SwordError, SwordAuthException
{
Context context = this.constructContext();
SwordContext sc;
try
{
sc = this.authenticate(context, auth);
}
catch (DSpaceSwordException | SwordError | RuntimeException | SwordAuthException e)
{
if (context != null && context.isValid())
{
context.abort();
}
throw e;
}
return sc;
}
/**
* Authenticate the given username/password pair, in conjunction with
* the onBehalfOf user. The rules are that the username/password pair
* must successfully authenticate the user, and the onBehalfOf user
* must exist in the user database.
*
* @param context
* The relevant DSpace Context.
* @param auth
* authentication credentials
* @return a SWORD context holding the various user information
* @throws SwordAuthException
* thrown if unable to authenticate
* @throws SwordError
* SWORD error per SWORD spec
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
private SwordContext authenticate(Context context, AuthCredentials auth)
throws SwordAuthException, SwordError, DSpaceSwordException
{
String obo = auth.getOnBehalfOf();
String un = auth.getUsername();
String pw = auth.getPassword();
// smooth out the OnBehalfOf request, so that empty strings are
// treated as null
if (StringUtils.isBlank(obo))
{
obo = null;
}
// first find out if we support on-behalf-of deposit
boolean mediated = configurationService
.getBooleanProperty("swordv2-server.on-behalf-of.enable", false);
if (!mediated && obo != null)
{
// user is trying to do a mediated deposit on a repository which does not support it
log.error(
"Attempted mediated deposit on service not configured to do so");
throw new SwordError(UriRegistry.ERROR_MEDIATION_NOT_ALLOWED,
"Mediated deposit to this service is not permitted");
}
log.info(LogManager.getHeader(context, "sword_authenticate",
"username=" + un + ",on_behalf_of=" + obo));
try
{
// attempt to authenticate the primary user
SwordContext sc = new SwordContext();
EPerson ep = null;
boolean authenticated = false;
if (this.authenticates(context, un, pw))
{
// if authenticated, obtain the eperson object
ep = context.getCurrentUser();
if (ep != null)
{
authenticated = true;
sc.setAuthenticated(ep);
// Set any special groups - invoke the authentication mgr.
List<Group> specialGroups = authenticationService
.getSpecialGroups(context, null);
for (Group specialGroup : specialGroups)
{
context.setSpecialGroup(specialGroup.getID());
log.debug("Adding Special Group id=" +
specialGroup.getID());
}
sc.setAuthenticatorContext(context);
sc.setContext(context);
}
// if there is an onBehalfOfuser, then find their eperson
// record, and if it exists set it. If not, then the
// authentication process fails
EPerson epObo = null;
if (obo != null)
{
epObo = ePersonService.findByEmail(context, obo);
if (epObo == null)
{
epObo = ePersonService.findByNetid(context, obo);
}
if (epObo != null)
{
sc.setOnBehalfOf(epObo);
Context oboContext = this.constructContext();
oboContext.setCurrentUser(epObo);
// Set any special groups - invoke the authentication mgr.
List<Group> specialGroups = authenticationService
.getSpecialGroups(oboContext, null);
for (Group specialGroup : specialGroups)
{
oboContext.setSpecialGroup(specialGroup.getID());
log.debug("Adding Special Group id=" +
specialGroup.getID());
}
sc.setContext(oboContext);
}
else
{
authenticated = false;
throw new SwordError(
UriRegistry.ERROR_TARGET_OWNER_UNKNOWN,
"unable to identify on-behalf-of user: " + obo);
}
}
}
if (!authenticated)
{
// decide what kind of error to throw
if (ep != null)
{
log.info(LogManager.getHeader(context,
"sword_unable_to_set_user", "username=" + un));
throw new SwordAuthException(
"Unable to authenticate with the supplied credentials");
}
else
{
// FIXME: this shouldn't ever happen now, but may as well leave it in just in case
// there's a bug elsewhere
log.info(LogManager.getHeader(context,
"sword_unable_to_set_on_behalf_of",
"username=" + un + ",on_behalf_of=" + obo));
throw new SwordAuthException(
"Unable to authenticate the onBehalfOf account");
}
}
return sc;
}
catch (SQLException e)
{
log.error("caught exception: ", e);
throw new DSpaceSwordException(
"There was a problem accessing the repository user database",
e);
}
}
/**
* Can the users contained in this object's member SwordContext
* make a successful submission to the selected collection.
*
* See javadocs for individual canSubmitTo methods to see the conditions
* which are applied in each situation
*
* @param swordContext
* The relevant SWORD Context.
* @param dso DSpace object
* @param msg message to append result to
* @return true if can submit, false if not
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
* @throws SwordError
* never.
*/
public boolean canSubmit(SwordContext swordContext, DSpaceObject dso,
VerboseDescription msg)
throws DSpaceSwordException, SwordError
{
// determine if we can submit
boolean submit = this.canSubmitTo(swordContext, dso);
if (submit)
{
msg.append("User is authorised to submit to collection");
}
else
{
msg.append("User is not authorised to submit to collection");
}
return submit;
}
/**
* Is the authenticated user a DSpace administrator? This translates
* as asking the question of whether the given eperson is a member
* of the special DSpace group Administrator, with id 1
*
* @param swordContext
* The relevant SWORD Context.
* @return true if administrator, false if not
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public boolean isUserAdmin(SwordContext swordContext)
throws DSpaceSwordException
{
try
{
EPerson authenticated = swordContext.getAuthenticated();
if (authenticated != null)
{
return authorizeService.isAdmin(
swordContext.getAuthenticatorContext());
}
return false;
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
/**
* Is the given onBehalfOf user DSpace administrator? This translates
* as asking the question of whether the given eperson is a member
* of the special DSpace group Administrator, with id 1
*
* @param swordContext
* The relevant SWORD Context.
* @return true if administrator, false if not
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public boolean isOnBehalfOfAdmin(SwordContext swordContext)
throws DSpaceSwordException
{
EPerson onBehalfOf = swordContext.getOnBehalfOf();
try
{
if (onBehalfOf != null)
{
return authorizeService.isAdmin(
swordContext.getOnBehalfOfContext());
}
return false;
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
/**
* Is the authenticated user a member of the given group
* or one of its sub groups?
*
* @param swordContext
* The relevant SWORD Context.
* @param group group to search recursively
* @return true if the authenticated user is a member of the given group
* or one of its sub groups
*/
public boolean isUserInGroup(SwordContext swordContext, Group group)
{
EPerson authenticated = swordContext.getAuthenticated();
if (authenticated != null)
{
return isInGroup(group, authenticated);
}
return false;
}
/**
* Is the onBehalfOf user a member of the given group or
* one of its sub groups?
*
* @param swordContext
* The relevant SWORD Context.
* @param group group to search recursively
* @return true if onBehalfOf user is a member of the given group or
* one of its sub groups
*/
public boolean isOnBehalfOfInGroup(SwordContext swordContext, Group group)
{
EPerson onBehalfOf = swordContext.getOnBehalfOf();
if (onBehalfOf != null)
{
return isInGroup(group, onBehalfOf);
}
return false;
}
/**
* Is the given eperson in the given group, or any of the groups
* that are also members of that group. This method recurses
* until it has exhausted the tree of groups or finds the given
* eperson
*
* @param group group to search recursively
* @param eperson EPerson to find
* @return true if in group, false if not
*/
public boolean isInGroup(Group group, EPerson eperson)
{
List<EPerson> eps = group.getMembers();
List<Group> groups = group.getMemberGroups();
// is the user in the current group
for (EPerson ep : eps)
{
if (eperson.getID().equals(ep.getID()))
{
return true;
}
}
// is the eperson in the sub-groups (recurse)
if (groups != null && !groups.isEmpty())
{
for (Group group1 : groups)
{
if (isInGroup(group1, eperson))
{
return true;
}
}
}
// ok, we didn't find you
return false;
}
/**
* Get an array of all the communities that the current SWORD
* context will allow deposit onto in the given DSpace context
*
* The user may submit to a community if the following conditions
* are met:
*
* IF: the authenticated user is an administrator
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to READ
* OR the on-behalf-of user is null)
* OR IF: the authenticated user is authorised to READ
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to READ
* OR the on-behalf-of user is null)
*
* @param swordContext
* The relevant SWORD Context.
* @return the array of allowed collections
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public List<Community> getAllowedCommunities(SwordContext swordContext)
throws DSpaceSwordException
{
// a community is allowed if the following conditions are met
//
// - the authenticated user is an administrator
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to READ
// -- the on-behalf-of user is null
// - the authenticated user is authorised to READ
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to READ
// -- the on-behalf-of user is null
try
{
// locate all the top level communities
Context context = swordContext.getContext();
List<Community> allowed = new ArrayList<Community>();
List<Community> comms = communityService.findAllTop(context);
for (Community comm : comms)
{
boolean authAllowed = false;
boolean oboAllowed = false;
// check for obo null
if (swordContext.getOnBehalfOf() == null)
{
oboAllowed = true;
}
// look up the READ policy on the community. This will include determining if the user is an administrator
// so we do not need to check that separately
if (!authAllowed)
{
authAllowed = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(), comm,
Constants.READ);
}
// if we have not already determined that the obo user is ok to submit, look up the READ policy on the
// community. THis will include determining if the user is an administrator.
if (!oboAllowed)
{
oboAllowed = authorizeService.authorizeActionBoolean(
swordContext.getOnBehalfOfContext(), comm,
Constants.READ);
}
// final check to see if we are allowed to READ
if (authAllowed && oboAllowed)
{
allowed.add(comm);
}
}
return allowed;
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
/**
* Get an array of all the collections that the current SWORD
* context will allow deposit onto in the given DSpace context
*
* The user may submit to a community if the following conditions
* are met:
*
* IF: the authenticated user is an administrator
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to READ
* OR the on-behalf-of user is null)
* OR IF: the authenticated user is authorised to READ
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to READ
* OR the on-behalf-of user is null)
*
* @param swordContext
* The relevant SWORD Context.
* @param community
* parent community to check recursively
* @return the array of allowed collections
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public List<Community> getCommunities(SwordContext swordContext,
Community community)
throws DSpaceSwordException
{
// a community is allowed if the following conditions are met
//
// - the authenticated user is an administrator
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to READ
// -- the on-behalf-of user is null
// - the authenticated user is authorised to READ
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to READ
// -- the on-behalf-of user is null
try
{
List<Community> comms = community.getSubcommunities();
List<Community> allowed = new ArrayList<>();
for (Community comm : comms)
{
boolean authAllowed = false;
boolean oboAllowed = false;
// check for obo null
if (swordContext.getOnBehalfOf() == null)
{
oboAllowed = true;
}
// look up the READ policy on the community. This will include determining if the user is an administrator
// so we do not need to check that separately
if (!authAllowed)
{
authAllowed = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(), comm,
Constants.READ);
}
// if we have not already determined that the obo user is ok to submit, look up the READ policy on the
// community. THis will include determining if the user is an administrator.
if (!oboAllowed)
{
oboAllowed = authorizeService.authorizeActionBoolean(
swordContext.getOnBehalfOfContext(), comm,
Constants.READ);
}
// final check to see if we are allowed to READ
if (authAllowed && oboAllowed)
{
allowed.add(comm);
}
}
return allowed;
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
/**
* Get an array of all the collections that the current SWORD
* context will allow deposit onto in the given DSpace context
*
* Forwards to:
*
* getAllowedCollections(swordContext, null)
*
* See that method for details of the conditions applied
*
* @param swordContext
* The relevant SWORD Context.
* @return the array of allowed collections
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public List<org.dspace.content.Collection> getAllowedCollections(
SwordContext swordContext)
throws DSpaceSwordException
{
return this.getAllowedCollections(swordContext, null);
}
/**
* Get an array of all the collections that the current SWORD
* context will allow deposit onto in the given DSpace context
*
* IF: the authenticated user is an administrator
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to ADD
* OR the on-behalf-of user is null)
* OR IF: the authenticated user is authorised to ADD
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to ADD
* OR the on-behalf-of user is null)
*
* @param swordContext
* The relevant SWORD Context.
* @param community
* community to check
* @return the array of allowed collections
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public List<org.dspace.content.Collection> getAllowedCollections(
SwordContext swordContext, Community community)
throws DSpaceSwordException
{
// a collection is allowed if the following conditions are met
//
// - the authenticated user is an administrator
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to ADD
// -- the on-behalf-of user is null
// - the authenticated user is authorised to ADD
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to ADD
// -- the on-behalf-of user is null
try
{
// get the context of the authenticated user
Context authContext = swordContext.getAuthenticatorContext();
// short cut by obtaining the collections to which the authenticated user can submit
List<Collection> cols = collectionService.findAuthorized(
authContext, community, Constants.ADD);
List<org.dspace.content.Collection> allowed = new ArrayList<>();
// now find out if the obo user is allowed to submit to any of these collections
for (Collection col : cols)
{
boolean oboAllowed = false;
// check for obo null
if (swordContext.getOnBehalfOf() == null)
{
oboAllowed = true;
}
// if we have not already determined that the obo user is ok to submit, look up the READ policy on the
// community. THis will include determining if the user is an administrator.
if (!oboAllowed)
{
oboAllowed = authorizeService.authorizeActionBoolean(
swordContext.getOnBehalfOfContext(), col,
Constants.ADD);
}
// final check to see if we are allowed to READ
if (oboAllowed)
{
allowed.add(col);
}
}
return allowed;
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
/**
* Get a list of all the items that the current SWORD
* context will allow deposit onto in the given DSpace context
*
* IF: the authenticated user is an administrator
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle
* OR the on-behalf-of user is null)
* OR IF: the authenticated user is authorised to WRITE on the item and ADD on the ORIGINAL bundle
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle
* OR the on-behalf-of user is null)
*
* @param swordContext
* The relevant SWORD Context.
* @param collection
* collection to check
* @return the array of allowed collections
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public List<Item> getAllowedItems(SwordContext swordContext,
org.dspace.content.Collection collection)
throws DSpaceSwordException
{
// an item is allowed if the following conditions are met
//
// - the authenticated user is an administrator
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle
// -- the on-behalf-of user is null
// - the authenticated user is authorised to WRITE on the item and ADD on the ORIGINAL bundle
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to WRITE on the item and ADD on the ORIGINAL bundle
// -- the on-behalf-of user is null
try
{
List<Item> allowed = new ArrayList<>();
Iterator<Item> ii = itemService
.findByCollection(swordContext.getContext(), collection);
while (ii.hasNext())
{
Item item = ii.next();
boolean authAllowed = false;
boolean oboAllowed = false;
// check for obo null
if (swordContext.getOnBehalfOf() == null)
{
oboAllowed = true;
}
// get the "ORIGINAL" bundle(s)
List<Bundle> bundles = item.getBundles();
// look up the READ policy on the community. This will include determining if the user is an administrator
// so we do not need to check that separately
if (!authAllowed)
{
boolean write = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(), item,
Constants.WRITE);
boolean add = false;
if (bundles.isEmpty())
{
add = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(), item,
Constants.ADD);
}
else
{
for (Bundle bundle : bundles)
{
if (Constants.CONTENT_BUNDLE_NAME
.equals(bundle.getName()))
{
add = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(),
bundle, Constants.ADD);
if (!add)
{
break;
}
}
}
}
authAllowed = write && add;
}
// if we have not already determined that the obo user is ok to submit, look up the READ policy on the
// community. THis will include determining if the user is an administrator.
if (!oboAllowed)
{
boolean write = authorizeService.authorizeActionBoolean(
swordContext.getOnBehalfOfContext(), item,
Constants.WRITE);
boolean add = false;
if (bundles.isEmpty())
{
add = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(), item,
Constants.ADD);
}
else
{
for (Bundle bundle : bundles)
{
if (Constants.CONTENT_BUNDLE_NAME
.equals(bundle.getName()))
{
add = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(),
bundle, Constants.ADD);
if (!add)
{
break;
}
}
}
}
oboAllowed = write && add;
}
// final check to see if we are allowed to READ
if (authAllowed && oboAllowed)
{
allowed.add(item);
}
}
return allowed;
}
catch (SQLException e)
{
throw new DSpaceSwordException(e);
}
}
/**
* Can the current SWORD Context permit deposit into the given
* collection in the given DSpace Context?
*
* IF: the authenticated user is an administrator
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to ADD
* OR the on-behalf-of user is null)
* OR IF: the authenticated user is authorised to ADD
* AND:
* (the on-behalf-of user is an administrator
* OR the on-behalf-of user is authorised to ADD
* OR the on-behalf-of user is null)
*
* @param swordContext
* The relevant SWORD Context.
* @param collection
* collection to check
* @return true if context can deposit into collection
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public boolean canSubmitTo(SwordContext swordContext,
org.dspace.content.Collection collection)
throws DSpaceSwordException
{
// a user can submit to a collection in the following conditions:
//
// - the authenticated user is an administrator
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to ADD/in the submission group
// -- the on-behalf-of user is null
// - the authenticated user is authorised to ADD/in the submission group
// -- the on-behalf-of user is an administrator
// -- the on-behalf-of user is authorised to ADD/in the submission group
// -- the on-behalf-of user is null
try
{
boolean authAllowed = false;
boolean oboAllowed = false;
// check for obo null
if (swordContext.getOnBehalfOf() == null)
{
oboAllowed = true;
}
// look up the READ policy on the collection. This will include determining if the user is an administrator
// so we do not need to check that separately
if (!authAllowed)
{
authAllowed = authorizeService.authorizeActionBoolean(
swordContext.getAuthenticatorContext(), collection,
Constants.ADD);
}
// if we have not already determined that the obo user is ok to submit, look up the READ policy on the
// community. THis will include determining if the user is an administrator.
if (!oboAllowed)
{
oboAllowed = authorizeService.authorizeActionBoolean(
swordContext.getOnBehalfOfContext(), collection,
Constants.ADD);
}
// final check to see if we are allowed to READ
return (authAllowed && oboAllowed);
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
public boolean canSubmitTo(SwordContext swordContext, Item item)
throws DSpaceSwordException
{
// a context can submit to an item if the following are satisfied
//
// 1/ the primary authenticating user is authenticated (which is implicit
// in there being a context in the first place)
// 2/ If an On-Behalf-Of request, the On-Behalf-Of user is authorised to
// carry out the action and the authenticating user is in the list
// of allowed mediaters
// 3/ If not an On-Behalf-Of request, the authenticating user is authorised
// to carry out the action
try
{
boolean isObo = swordContext.getOnBehalfOf() != null;
Context allowContext = null;
if (isObo)
{
// we need to find out if the authenticated user is permitted to mediate
if (!this.allowedToMediate(
swordContext.getAuthenticatorContext()))
{
return false;
}
allowContext = swordContext.getOnBehalfOfContext();
}
else
{
allowContext = swordContext.getAuthenticatorContext();
}
// we now need to check whether the selected context that we are authorising
// has the appropriate permissions
boolean write = authorizeService
.authorizeActionBoolean(allowContext, item, Constants.WRITE);
List<Bundle> bundles = item.getBundles();
boolean add = false;
if (bundles.isEmpty())
{
add = authorizeService.authorizeActionBoolean(
allowContext, item, Constants.ADD);
}
else
{
for (Bundle bundle : bundles)
{
if (Constants.CONTENT_BUNDLE_NAME.equals(bundle.getName()))
{
add = authorizeService.authorizeActionBoolean(
allowContext, bundle, Constants.ADD);
if (!add)
{
break;
}
}
}
}
boolean allowed = write && add;
return allowed;
}
catch (SQLException e)
{
log.error("Caught exception: ", e);
throw new DSpaceSwordException(e);
}
}
private boolean allowedToMediate(Context context)
{
// get the configuration
String[] mediators = configurationService
.getArrayProperty("swordv2-server.on-behalf-of.update.mediators");
if (mediators == null || mediators.length==0)
{
// if there's no explicit list of mediators, then anyone can mediate
return true;
}
// get the email and netid of the mediator
EPerson eperson = context.getCurrentUser();
if (eperson == null)
{
return false;
}
String email = eperson.getEmail();
String netid = eperson.getNetid();
for (String mediator : mediators)
{
String m = mediator.trim();
if (email != null && m.equals(email.trim()))
{
return true;
}
if (netid != null && m.equals(netid.trim()))
{
return true;
}
}
return false;
}
/**
* Can the given context submit to the specified DSpace object?
*
* This forwards to the individual methods for different object types;
* see their documentation for details of the conditions.
*
* @param context
* The relevant DSpace Context.
* @param dso
* DSpace object
* @return true if context can submit to dso
* @throws DSpaceSwordException
* can be thrown by the internals of the DSpace SWORD implementation
*/
public boolean canSubmitTo(SwordContext context, DSpaceObject dso)
throws DSpaceSwordException
{
if (dso instanceof Collection)
{
return this.canSubmitTo(context, (Collection) dso);
}
else
return dso instanceof Item && this.canSubmitTo(context, (Item) dso);
}
}