hazza/DSpace
1
0
Fork 0
mirror of https://github.com/DSpace/DSpace.git synced 2025-10-17 23:13:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix dspace-api module per new code style

Browse Source
This commit is contained in:
Tim Donohue
2018-02-14 10:53:46 -06:00
parent 8ffc97f7f9
commit 8a48f782ea
1051 changed files with 53347 additions and 63373 deletions
Download Patch File Download Diff File Expand all files Collapse all files

290
dspace-api/src/main/java/org/dspace/eperson/GroupServiceImpl.java
View File

@@ -7,6 +7,16 @@
*/
package org.dspace.eperson;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
@@ -33,9 +43,6 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import java.sql.SQLException;
import java.util.*;
/**
* Service implementation for the Group object.
* This class is responsible for all business logic calls for the Group object and is autowired by spring.
@@ -43,8 +50,7 @@ import java.util.*;
*
* @author kevinvandevelde at atmire.com
*/
public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements GroupService
{
public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements GroupService {
private static final Logger log = LoggerFactory.getLogger(GroupServiceImpl.class);
@Autowired(required = true)
@@ -65,25 +71,23 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Autowired(required = true)
protected AuthorizeService authorizeService;
protected GroupServiceImpl()
{
protected GroupServiceImpl() {
super();
}
@Override
public Group create(Context context) throws SQLException, AuthorizeException {
// FIXME - authorization?
if (!authorizeService.isAdmin(context))
{
if (!authorizeService.isAdmin(context)) {
throw new AuthorizeException(
"You must be an admin to create an EPerson Group");
"You must be an admin to create an EPerson Group");
}
// Create a table row
Group g = groupDAO.create(context, new Group());
log.info(LogManager.getHeader(context, "create_group", "group_id="
+ g.getID()));
+ g.getID()));
context.addEvent(new Event(Event.CREATE, Constants.GROUP, g.getID(), null, getIdentifiers(context, g)));
update(context, g);
@@ -93,56 +97,57 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Override
public void setName(Group group, String name) throws SQLException {
if (group.isPermanent())
{
if (group.isPermanent()) {
log.error("Attempt to rename permanent Group {} to {}.",
group.getName(), name);
group.getName(), name);
throw new SQLException("Attempt to rename a permanent Group");
}
else
} else {
group.setName(name);
}
}
@Override
public void addMember(Context context, Group group, EPerson e) {
if (isDirectMember(group, e))
{
if (isDirectMember(group, e)) {
return;
}
group.addMember(e);
e.getGroups().add(group);
context.addEvent(new Event(Event.ADD, Constants.GROUP, group.getID(), Constants.EPERSON, e.getID(), e.getEmail(), getIdentifiers(context, group)));
context.addEvent(
new Event(Event.ADD, Constants.GROUP, group.getID(), Constants.EPERSON, e.getID(), e.getEmail(),
getIdentifiers(context, group)));
}
@Override
public void addMember(Context context, Group groupParent, Group groupChild) throws SQLException {
// don't add if it's already a member
// don't add if it's already a member
// and don't add itself
if (groupParent.contains(groupChild) || groupParent.getID()==groupChild.getID())
{
if (groupParent.contains(groupChild) || groupParent.getID() == groupChild.getID()) {
return;
}
groupParent.addMember(groupChild);
groupChild.addParentGroup(groupParent);
context.addEvent(new Event(Event.ADD, Constants.GROUP, groupParent.getID(), Constants.GROUP, groupChild.getID(), groupChild.getName(), getIdentifiers(context, groupParent)));
context.addEvent(new Event(Event.ADD, Constants.GROUP, groupParent.getID(), Constants.GROUP, groupChild.getID(),
groupChild.getName(), getIdentifiers(context, groupParent)));
}
@Override
public void removeMember(Context context, Group group, EPerson ePerson) {
if (group.remove(ePerson))
{
context.addEvent(new Event(Event.REMOVE, Constants.GROUP, group.getID(), Constants.EPERSON, ePerson.getID(), ePerson.getEmail(), getIdentifiers(context, group)));
if (group.remove(ePerson)) {
context.addEvent(new Event(Event.REMOVE, Constants.GROUP, group.getID(), Constants.EPERSON, ePerson.getID(),
ePerson.getEmail(), getIdentifiers(context, group)));
}
}
@Override
public void removeMember(Context context, Group groupParent, Group childGroup) throws SQLException {
if (groupParent.remove(childGroup))
{
if (groupParent.remove(childGroup)) {
childGroup.removeParentGroup(groupParent);
context.addEvent(new Event(Event.REMOVE, Constants.GROUP, groupParent.getID(), Constants.GROUP, childGroup.getID(), childGroup.getName(), getIdentifiers(context, groupParent)));
context.addEvent(
new Event(Event.REMOVE, Constants.GROUP, groupParent.getID(), Constants.GROUP, childGroup.getID(),
childGroup.getName(), getIdentifiers(context, groupParent)));
}
}
@@ -169,9 +174,8 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Override
public boolean isMember(Context context, EPerson ePerson, Group group)
throws SQLException
{
if(group == null) {
throws SQLException {
if (group == null) {
return false;
// special, everyone is member of group 0 (anonymous)
@@ -181,14 +185,14 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
} else {
Boolean cachedGroupMembership = context.getCachedGroupMembership(group, ePerson);
if(cachedGroupMembership != null) {
if (cachedGroupMembership != null) {
return cachedGroupMembership.booleanValue();
} else {
boolean isMember = false;
//If we have an ePerson, check we can find membership in the database
if(ePerson != null) {
if (ePerson != null) {
//lookup eperson in normal groups and subgroups with 1 query
isMember = isEPersonInGroup(context, group, ePerson);
}
@@ -198,7 +202,9 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
//special group is a subgroup of the provided group.
//Note that special groups should only be checked if the current user == the ePerson.
//This also works for anonymous users (ePerson == null) if IP authentication used
if(!isMember && CollectionUtils.isNotEmpty(context.getSpecialGroups()) && isAuthenticatedUser(context, ePerson)) {
if (!isMember && CollectionUtils.isNotEmpty(context.getSpecialGroups()) &&
isAuthenticatedUser(context, ePerson)) {
Iterator<Group> it = context.getSpecialGroups().iterator();
while (it.hasNext() && !isMember) {
@@ -239,14 +245,13 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Override
public Set<Group> allMemberGroupsSet(Context context, EPerson ePerson) throws SQLException {
Set<Group> cachedGroupMembership = context.getCachedAllMemberGroupsSet(ePerson);
if(cachedGroupMembership != null) {
if (cachedGroupMembership != null) {
return cachedGroupMembership;
}
Set<Group> groups = new HashSet<>();
if (ePerson != null)
{
if (ePerson != null) {
// two queries - first to get groups eperson is a member of
// second query gets parent groups for groups eperson is a member of
groups.addAll(groupDAO.findByEPerson(context, ePerson));
@@ -256,11 +261,9 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
// However, we only do this is we are looking up the special groups
// of the current user, as we cannot look up the special groups
// of a user who is not logged in.
if ((context.getCurrentUser() == null) || (context.getCurrentUser().equals(ePerson)))
{
if ((context.getCurrentUser() == null) || (context.getCurrentUser().equals(ePerson))) {
List<Group> specialGroups = context.getSpecialGroups();
for(Group special : specialGroups)
{
for (Group special : specialGroups) {
groups.add(special);
}
}
@@ -281,8 +284,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
}
@Override
public List<EPerson> allMembers(Context c, Group g) throws SQLException
{
public List<EPerson> allMembers(Context c, Group g) throws SQLException {
// two queries - first to get all groups which are a member of this group
// second query gets all members of each group in the first query
@@ -312,15 +314,16 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Override
public Group findByName(Context context, String name) throws SQLException {
if (name == null)
{
if (name == null) {
return null;
}
return groupDAO.findByName(context, name);
}
/** DEPRECATED: Please use {@code findAll(Context context, List<MetadataField> metadataSortFields)} instead */
/**
* DEPRECATED: Please use {@code findAll(Context context, List<MetadataField> metadataSortFields)} instead
*/
@Override
@Deprecated
public List<Group> findAll(Context context, int sortField) throws SQLException {
@@ -330,16 +333,15 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
throw new UnsupportedOperationException("You can only find all groups sorted by name with this method");
}
}
@Override
public List<Group> findAll(Context context, List<MetadataField> metadataSortFields) throws SQLException
{
return findAll(context, metadataSortFields, -1, -1);
public List<Group> findAll(Context context, List<MetadataField> metadataSortFields) throws SQLException {
return findAll(context, metadataSortFields, -1, -1);
}
@Override
public List<Group> findAll(Context context, List<MetadataField> metadataSortFields, int pageSize, int offset) throws SQLException
{
public List<Group> findAll(Context context, List<MetadataField> metadataSortFields, int pageSize, int offset)
throws SQLException {
if (CollectionUtils.isEmpty(metadataSortFields)) {
return groupDAO.findAll(context, pageSize, offset);
} else {
@@ -353,8 +355,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
}
@Override
public List<Group> search(Context context, String groupIdentifier, int offset, int limit) throws SQLException
{
public List<Group> search(Context context, String groupIdentifier, int offset, int limit) throws SQLException {
List<Group> groups = new ArrayList<>();
UUID uuid = UUIDUtils.fromString(groupIdentifier);
if (uuid == null) {
@@ -363,8 +364,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
} else {
//Search by group id
Group group = find(context, uuid);
if (group != null)
{
if (group != null) {
groups.add(group);
}
}
@@ -382,8 +382,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
} else {
//Search by group id
Group group = find(context, uuid);
if (group != null)
{
if (group != null) {
result = 1;
}
}
@@ -393,14 +392,13 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Override
public void delete(Context context, Group group) throws SQLException {
if (group.isPermanent())
{
if (group.isPermanent()) {
log.error("Attempt to delete permanent Group $", group.getName());
throw new SQLException("Attempt to delete a permanent Group");
}
context.addEvent(new Event(Event.DELETE, Constants.GROUP, group.getID(),
group.getName(), getIdentifiers(context, group)));
group.getName(), getIdentifiers(context, group)));
//Remove the supervised group from any workspace items linked to us.
group.getSupervisedItems().clear();
@@ -426,7 +424,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
rethinkGroupCache(context, false);
log.info(LogManager.getHeader(context, "delete_group", "group_id="
+ group.getID()));
+ group.getID()));
}
@Override
@@ -438,21 +436,17 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
* Return true if group has no direct or indirect members
*/
@Override
public boolean isEmpty(Group group)
{
public boolean isEmpty(Group group) {
// the only fast check available is on epeople...
boolean hasMembers = (!group.getMembers().isEmpty());
if (hasMembers)
{
if (hasMembers) {
return false;
}
else
{
} else {
// well, groups is never null...
for (Group subGroup : group.getMemberGroups()){
for (Group subGroup : group.getMemberGroups()) {
hasMembers = !isEmpty(subGroup);
if (hasMembers){
if (hasMembers) {
return false;
}
}
@@ -465,8 +459,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
GroupService groupService = EPersonServiceFactory.getInstance().getGroupService();
// Check for Anonymous group. If not found, create it
Group anonymousGroup = groupService.findByName(context, Group.ANONYMOUS);
if (anonymousGroup==null)
{
if (anonymousGroup == null) {
anonymousGroup = groupService.create(context);
anonymousGroup.setName(Group.ANONYMOUS);
anonymousGroup.setPermanent(true);
@@ -476,8 +469,7 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
// Check for Administrator group. If not found, create it
Group adminGroup = groupService.findByName(context, Group.ADMIN);
if (adminGroup == null)
{
if (adminGroup == null) {
adminGroup = groupService.create(context);
adminGroup.setName(Group.ADMIN);
adminGroup.setPermanent(true);
@@ -488,11 +480,9 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
/**
* Get a list of groups with no members.
*
* @param context
* The relevant DSpace Context.
* @param context The relevant DSpace Context.
* @return list of groups with no members
* @throws SQLException
* An exception that provides information on a database access error or other errors.
* @throws SQLException An exception that provides information on a database access error or other errors.
*/
@Override
public List<Group> getEmptyGroups(Context context) throws SQLException {
@@ -502,46 +492,37 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
/**
* Update the group - writing out group object and EPerson list if necessary
*
* @param context
* The relevant DSpace Context.
* @param group
* Group to update
* @throws SQLException
* An exception that provides information on a database access error or other errors.
* @throws AuthorizeException
* Exception indicating the current user of the context does not have permission
* to perform a particular action.
* @param context The relevant DSpace Context.
* @param group Group to update
* @throws SQLException An exception that provides information on a database access error or other errors.
* @throws AuthorizeException Exception indicating the current user of the context does not have permission
* to perform a particular action.
*/
@Override
public void update(Context context, Group group) throws SQLException, AuthorizeException
{
public void update(Context context, Group group) throws SQLException, AuthorizeException {
super.update(context, group);
// FIXME: Check authorisation
groupDAO.save(context, group);
if (group.isMetadataModified())
{
context.addEvent(new Event(Event.MODIFY_METADATA, Constants.GROUP, group.getID(), group.getDetails(), getIdentifiers(context, group)));
if (group.isMetadataModified()) {
context.addEvent(new Event(Event.MODIFY_METADATA, Constants.GROUP, group.getID(), group.getDetails(),
getIdentifiers(context, group)));
group.clearDetails();
}
if (group.isGroupsChanged())
{
if (group.isGroupsChanged()) {
rethinkGroupCache(context, true);
group.clearGroupsChanged();
}
log.info(LogManager.getHeader(context, "update_group", "group_id="
+ group.getID()));
+ group.getID()));
}
protected boolean isEPersonInGroup(Context context, Group group, EPerson ePerson)
throws SQLException
{
throws SQLException {
return groupDAO.findByIdAndMembership(context, group.getID(), ePerson) != null;
}
@@ -550,12 +531,9 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
* Regenerate the group cache AKA the group2groupcache table in the database -
* meant to be called when a group is added or removed from another group
*
* @param context
* The relevant DSpace Context.
* @param flushQueries
* flushQueries Flush all pending queries
* @throws SQLException
* An exception that provides information on a database access error or other errors.
* @param context The relevant DSpace Context.
* @param flushQueries flushQueries Flush all pending queries
* @throws SQLException An exception that provides information on a database access error or other errors.
*/
protected void rethinkGroupCache(Context context, boolean flushQueries) throws SQLException {
@@ -604,8 +582,8 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
Group childGroup = find(context, child);
if (parentGroup != null && childGroup != null && group2GroupCacheDAO.find(context, parentGroup, childGroup) == null)
{
if (parentGroup != null && childGroup != null && group2GroupCacheDAO
.find(context, parentGroup, childGroup) == null) {
Group2GroupCache group2GroupCache = group2GroupCacheDAO.create(context, new Group2GroupCache());
group2GroupCache.setParent(parentGroup);
group2GroupCache.setChild(childGroup);
@@ -616,71 +594,53 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
}
@Override
public DSpaceObject getParentObject(Context context, Group group) throws SQLException
{
if (group == null)
{
public DSpaceObject getParentObject(Context context, Group group) throws SQLException {
if (group == null) {
return null;
}
// could a collection/community administrator manage related groups?
// check before the configuration options could give a performance gain
// if all group management are disallowed
if (AuthorizeConfiguration.canCollectionAdminManageAdminGroup()
|| AuthorizeConfiguration.canCollectionAdminManageSubmitters()
|| AuthorizeConfiguration.canCollectionAdminManageWorkflows()
|| AuthorizeConfiguration.canCommunityAdminManageAdminGroup()
|| AuthorizeConfiguration
.canCommunityAdminManageCollectionAdminGroup()
|| AuthorizeConfiguration
.canCommunityAdminManageCollectionSubmitters()
|| AuthorizeConfiguration
.canCommunityAdminManageCollectionWorkflows())
{
|| AuthorizeConfiguration.canCollectionAdminManageSubmitters()
|| AuthorizeConfiguration.canCollectionAdminManageWorkflows()
|| AuthorizeConfiguration.canCommunityAdminManageAdminGroup()
|| AuthorizeConfiguration
.canCommunityAdminManageCollectionAdminGroup()
|| AuthorizeConfiguration
.canCommunityAdminManageCollectionSubmitters()
|| AuthorizeConfiguration
.canCommunityAdminManageCollectionWorkflows()) {
// is this a collection related group?
org.dspace.content.Collection collection = collectionService.findByGroup(context, group);
if (collection != null)
{
if (collection != null) {
if ((group.equals(collection.getWorkflowStep1()) ||
group.equals(collection.getWorkflowStep2()) ||
group.equals(collection.getWorkflowStep3())))
{
if (AuthorizeConfiguration.canCollectionAdminManageWorkflows())
{
group.equals(collection.getWorkflowStep2()) ||
group.equals(collection.getWorkflowStep3()))) {
if (AuthorizeConfiguration.canCollectionAdminManageWorkflows()) {
return collection;
}
else if (AuthorizeConfiguration.canCommunityAdminManageCollectionWorkflows())
{
} else if (AuthorizeConfiguration.canCommunityAdminManageCollectionWorkflows()) {
return collectionService.getParentObject(context, collection);
}
}
if (group.equals(collection.getSubmitters()))
{
if (AuthorizeConfiguration.canCollectionAdminManageSubmitters())
{
if (group.equals(collection.getSubmitters())) {
if (AuthorizeConfiguration.canCollectionAdminManageSubmitters()) {
return collection;
}
else if (AuthorizeConfiguration.canCommunityAdminManageCollectionSubmitters())
{
} else if (AuthorizeConfiguration.canCommunityAdminManageCollectionSubmitters()) {
return collectionService.getParentObject(context, collection);
}
}
if (group.equals(collection.getAdministrators()))
{
if (AuthorizeConfiguration.canCollectionAdminManageAdminGroup())
{
if (group.equals(collection.getAdministrators())) {
if (AuthorizeConfiguration.canCollectionAdminManageAdminGroup()) {
return collection;
}
else if (AuthorizeConfiguration.canCommunityAdminManageCollectionAdminGroup())
{
} else if (AuthorizeConfiguration.canCommunityAdminManageCollectionAdminGroup()) {
return collectionService.getParentObject(context, collection);
}
}
}
// is the group related to a community and community administrator allowed
// to manage it?
else if (AuthorizeConfiguration.canCommunityAdminManageAdminGroup())
{
} else if (AuthorizeConfiguration.canCommunityAdminManageAdminGroup()) {
// is the group related to a community and community administrator allowed
// to manage it?
return communityService.findByAdminGroup(context, group);
}
}
@@ -696,24 +656,20 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
* Used recursively to generate a map of ALL of the children of the given
* parent
*
* @param parents
* Map of parent,child relationships
* @param parent
* the parent you're interested in
* @param parents Map of parent,child relationships
* @param parent the parent you're interested in
* @return Map whose keys are all of the children of a parent
*/
protected Set<UUID> getChildren(Map<UUID,Set<UUID>> parents, UUID parent)
{
protected Set<UUID> getChildren(Map<UUID, Set<UUID>> parents, UUID parent) {
Set<UUID> myChildren = new HashSet<>();
// degenerate case, this parent has no children
if (!parents.containsKey(parent))
{
if (!parents.containsKey(parent)) {
return myChildren;
}
// got this far, so we must have children
Set<UUID> children = parents.get(parent);
Set<UUID> children = parents.get(parent);
// now iterate over all of the children
@@ -730,12 +686,9 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
@Override
public Group findByIdOrLegacyId(Context context, String id) throws SQLException {
if (org.apache.commons.lang.StringUtils.isNumeric(id))
{
if (org.apache.commons.lang.StringUtils.isNumeric(id)) {
return findByLegacyId(context, Integer.parseInt(id));
}
else
{
} else {
return find(context, UUIDUtils.fromString(id));
}
}
@@ -751,7 +704,8 @@ public class GroupServiceImpl extends DSpaceObjectServiceImpl<Group> implements
}
@Override
public List<Group> findByMetadataField(final Context context, final String searchValue, final MetadataField metadataField) throws SQLException {
public List<Group> findByMetadataField(final Context context, final String searchValue,
final MetadataField metadataField) throws SQLException {
return groupDAO.findByMetadataField(context, searchValue, metadataField);
}
}