mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-02 17:35:18 +00:00
7f79a2a498
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3129 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
585 lines
20 KiB
Java
585 lines
20 KiB
Java
/*
|
|
* Copyright (C) 2005 Alfresco, Inc.
|
|
*
|
|
* Licensed under the Mozilla Public License version 1.1
|
|
* with a permitted attribution clause. You may obtain a
|
|
* copy of the License at
|
|
*
|
|
* http://www.alfresco.org/legal/license.txt
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
* either express or implied. See the License for the specific
|
|
* language governing permissions and limitations under the
|
|
* License.
|
|
*/
|
|
package org.alfresco.repo.domain.hibernate;
|
|
|
|
import java.util.Collection;
|
|
import java.util.Collections;
|
|
import java.util.HashSet;
|
|
import java.util.Set;
|
|
|
|
import org.alfresco.repo.domain.DbAccessControlEntry;
|
|
import org.alfresco.repo.domain.DbAccessControlList;
|
|
import org.alfresco.repo.domain.DbAuthority;
|
|
import org.alfresco.repo.domain.DbPermission;
|
|
import org.alfresco.repo.domain.DbPermissionKey;
|
|
import org.alfresco.repo.domain.Node;
|
|
import org.alfresco.repo.node.db.NodeDaoService;
|
|
import org.alfresco.repo.security.permissions.NodePermissionEntry;
|
|
import org.alfresco.repo.security.permissions.PermissionEntry;
|
|
import org.alfresco.repo.security.permissions.PermissionReference;
|
|
import org.alfresco.repo.security.permissions.impl.PermissionsDaoComponent;
|
|
import org.alfresco.repo.security.permissions.impl.SimpleNodePermissionEntry;
|
|
import org.alfresco.repo.security.permissions.impl.SimplePermissionEntry;
|
|
import org.alfresco.repo.security.permissions.impl.SimplePermissionReference;
|
|
import org.alfresco.repo.transaction.TransactionalDao;
|
|
import org.alfresco.service.cmr.repository.InvalidNodeRefException;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.security.AccessStatus;
|
|
import org.alfresco.service.namespace.QName;
|
|
import org.alfresco.util.GUID;
|
|
import org.hibernate.Query;
|
|
import org.hibernate.Session;
|
|
import org.springframework.orm.hibernate3.HibernateCallback;
|
|
import org.springframework.orm.hibernate3.support.HibernateDaoSupport;
|
|
|
|
/**
|
|
* Support for accessing persisted permission information.
|
|
*
|
|
* This class maps between persisted objects and the external API defined in the
|
|
* PermissionsDAO interface.
|
|
*
|
|
* @author andyh
|
|
*/
|
|
public class PermissionsDaoComponentImpl extends HibernateDaoSupport implements PermissionsDaoComponent, TransactionalDao
|
|
{
|
|
private static final boolean INHERIT_PERMISSIONS_DEFAULT = true;
|
|
public static final String QUERY_GET_PERMISSION = "permission.GetPermission";
|
|
public static final String QUERY_GET_AC_ENTRIES_FOR_AUTHORITY = "permission.GetAccessControlEntriesForAuthority";
|
|
public static final String QUERY_GET_AC_ENTRIES_FOR_PERMISSION = "permission.GetAccessControlEntriesForPermission";
|
|
|
|
private NodeDaoService nodeDaoService;
|
|
|
|
/** a uuid identifying this unique instance */
|
|
private String uuid;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
public PermissionsDaoComponentImpl()
|
|
{
|
|
this.uuid = GUID.generate();
|
|
}
|
|
|
|
/**
|
|
* Checks equality by type and uuid
|
|
*/
|
|
public boolean equals(Object obj)
|
|
{
|
|
if (obj == null)
|
|
{
|
|
return false;
|
|
}
|
|
else if (!(obj instanceof PermissionsDaoComponentImpl))
|
|
{
|
|
return false;
|
|
}
|
|
PermissionsDaoComponentImpl that = (PermissionsDaoComponentImpl) obj;
|
|
return this.uuid.equals(that.uuid);
|
|
}
|
|
|
|
/**
|
|
* @see #uuid
|
|
*/
|
|
public int hashCode()
|
|
{
|
|
return uuid.hashCode();
|
|
}
|
|
|
|
/**
|
|
* Does this <tt>Session</tt> contain any changes which must be
|
|
* synchronized with the store?
|
|
*
|
|
* @return true => changes are pending
|
|
*/
|
|
public boolean isDirty()
|
|
{
|
|
// create a callback for the task
|
|
HibernateCallback callback = new HibernateCallback()
|
|
{
|
|
public Object doInHibernate(Session session)
|
|
{
|
|
return session.isDirty();
|
|
}
|
|
};
|
|
// execute the callback
|
|
return ((Boolean)getHibernateTemplate().execute(callback)).booleanValue();
|
|
}
|
|
|
|
/**
|
|
* Just flushes the session
|
|
*/
|
|
public void flush()
|
|
{
|
|
getSession().flush();
|
|
}
|
|
|
|
public void setNodeDaoService(NodeDaoService nodeDaoService)
|
|
{
|
|
this.nodeDaoService = nodeDaoService;
|
|
}
|
|
|
|
public NodePermissionEntry getPermissions(NodeRef nodeRef)
|
|
{
|
|
// Create the object if it is not found.
|
|
// Null objects are not cached in hibernate
|
|
// If the object does not exist it will repeatedly query to check its
|
|
// non existence.
|
|
|
|
NodePermissionEntry npe = null;
|
|
DbAccessControlList acl = null;
|
|
Node node = getNode(nodeRef, false);
|
|
if (node != null)
|
|
{
|
|
// get the persisted version
|
|
acl = getAccessControlList(node, false);
|
|
}
|
|
if (acl == null)
|
|
{
|
|
// there isn't an access control list for the node - spoof a null one
|
|
SimpleNodePermissionEntry snpe = new SimpleNodePermissionEntry(
|
|
nodeRef,
|
|
true,
|
|
Collections.<SimplePermissionEntry> emptySet());
|
|
npe = snpe;
|
|
}
|
|
else
|
|
{
|
|
npe = createSimpleNodePermissionEntry(node);
|
|
}
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug(
|
|
"Created access control list for node: \n" +
|
|
" node: " + nodeRef + "\n" +
|
|
" acl: " + npe);
|
|
}
|
|
return npe;
|
|
}
|
|
|
|
/**
|
|
* Get the persisted access control list or create it if required.
|
|
*
|
|
* @param nodeRef - the node for which to create the list
|
|
* @param create - create the object if it is missing
|
|
* @return Returns the current access control list or null if not found
|
|
*/
|
|
private DbAccessControlList getAccessControlList(Node node, boolean create)
|
|
{
|
|
DbAccessControlList acl = node.getAccessControlList();
|
|
if (acl == null && create)
|
|
{
|
|
acl = createAccessControlList(node);
|
|
}
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Retrieved access control list: \n" +
|
|
" node: " + node.getNodeRef() + "\n" +
|
|
" list: " + acl);
|
|
}
|
|
return acl;
|
|
}
|
|
|
|
/**
|
|
* Creates an access control list for the node and removes the entry from
|
|
* the nullPermsionCache.
|
|
*/
|
|
private DbAccessControlList createAccessControlList(Node node)
|
|
{
|
|
DbAccessControlList acl = new DbAccessControlListImpl();
|
|
acl.setInherits(INHERIT_PERMISSIONS_DEFAULT);
|
|
getHibernateTemplate().save(acl);
|
|
|
|
// maintain inverse
|
|
node.setAccessControlList(acl);
|
|
|
|
NodeRef nodeRef = node.getNodeRef();
|
|
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Created Access Control List: \n" +
|
|
" node: " + nodeRef + "\n" +
|
|
" list: " + acl);
|
|
}
|
|
return acl;
|
|
}
|
|
|
|
/**
|
|
* @param nodeRef the node reference
|
|
* @param mustExist true if an exception must be thrown if the node does not exist
|
|
* @return Returns the node for the given reference, or null if <code>mustExist == false</code>
|
|
* @throws InvalidNodeRefException if the node must exist but doesn't
|
|
*/
|
|
private Node getNode(NodeRef nodeRef, boolean mustExist)
|
|
{
|
|
Node node = nodeDaoService.getNode(nodeRef);
|
|
if (node == null && mustExist)
|
|
{
|
|
throw new InvalidNodeRefException(nodeRef);
|
|
}
|
|
return node;
|
|
}
|
|
|
|
public void deletePermissions(NodeRef nodeRef)
|
|
{
|
|
Node node = getNode(nodeRef, false);
|
|
if (node == null)
|
|
{
|
|
return;
|
|
}
|
|
DbAccessControlList acl = getAccessControlList(node, false);
|
|
if (acl != null)
|
|
{
|
|
// maintain referencial integrity
|
|
node.setAccessControlList(null);
|
|
// delete the access control list - it will cascade to the entries
|
|
getHibernateTemplate().delete(acl);
|
|
}
|
|
}
|
|
|
|
@SuppressWarnings("unchecked")
|
|
public void deletePermissions(final String authority)
|
|
{
|
|
// get the authority
|
|
HibernateCallback callback = new HibernateCallback()
|
|
{
|
|
public Object doInHibernate(Session session)
|
|
{
|
|
Query query = session
|
|
.getNamedQuery(QUERY_GET_AC_ENTRIES_FOR_AUTHORITY)
|
|
.setString("authorityRecipient", authority);
|
|
return (Integer) HibernateHelper.deleteDbAccessControlEntries(session, query);
|
|
}
|
|
};
|
|
Integer deletedCount = (Integer) getHibernateTemplate().execute(callback);
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Deleted " + deletedCount + " entries for authority " + authority);
|
|
}
|
|
}
|
|
|
|
public void deletePermissions(final NodeRef nodeRef, final String authority)
|
|
{
|
|
Node node = getNode(nodeRef, false);
|
|
if (node == null)
|
|
{
|
|
return;
|
|
}
|
|
DbAccessControlList acl = node.getAccessControlList();
|
|
int deletedCount = 0;
|
|
if (acl != null)
|
|
{
|
|
deletedCount = acl.deleteEntriesForAuthority(authority);
|
|
}
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Deleted " + deletedCount + "entries for criteria: \n" +
|
|
" node: " + nodeRef + "\n" +
|
|
" authority: " + authority);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Deletes all permission entries (access control list entries) that match
|
|
* the given criteria. Note that the access control list for the node is
|
|
* not deleted.
|
|
*/
|
|
public void deletePermission(NodeRef nodeRef, String authority, PermissionReference permission)
|
|
{
|
|
Node node = getNode(nodeRef, false);
|
|
if (node == null)
|
|
{
|
|
return;
|
|
}
|
|
DbAccessControlList acl = node.getAccessControlList();
|
|
int deletedCount = 0;
|
|
if (acl != null)
|
|
{
|
|
DbPermissionKey permissionKey = new DbPermissionKey(permission.getQName(), permission.getName());
|
|
deletedCount = acl.deleteEntry(authority, permissionKey);
|
|
}
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Deleted " + deletedCount + "entries for criteria: \n" +
|
|
" node: " + nodeRef + "\n" +
|
|
" permission: " + permission + "\n" +
|
|
" authority: " + authority);
|
|
}
|
|
}
|
|
|
|
public void setPermission(NodeRef nodeRef, String authority, PermissionReference permission, boolean allow)
|
|
{
|
|
Node node = getNode(nodeRef, true);
|
|
// get the entry
|
|
DbAccessControlEntry entry = getAccessControlEntry(node, authority, permission);
|
|
if (entry == null)
|
|
{
|
|
// need to create it
|
|
DbAccessControlList dbAccessControlList = getAccessControlList(node, true);
|
|
DbPermission dbPermission = getPermission(permission, true);
|
|
DbAuthority dbAuthority = getAuthority(authority, true);
|
|
// set persistent objects
|
|
entry = dbAccessControlList.newEntry(dbPermission, dbAuthority, allow);
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Created new access control entry: " + entry);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
entry.setAllowed(allow);
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Updated access control entry: " + entry);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param nodeRef the node against which to join
|
|
* @param authority the authority against which to join
|
|
* @param perm the permission against which to join
|
|
* @return Returns all access control entries that match the criteria
|
|
*/
|
|
private DbAccessControlEntry getAccessControlEntry(
|
|
Node node,
|
|
String authority,
|
|
PermissionReference permission)
|
|
{
|
|
DbAccessControlList acl = getAccessControlList(node, false);
|
|
DbAccessControlEntry entry = null;
|
|
if (acl != null)
|
|
{
|
|
DbPermissionKey permissionKey = new DbPermissionKey(permission.getQName(), permission.getName());
|
|
entry = acl.getEntry(authority, permissionKey);
|
|
}
|
|
// done
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("" + (entry == null ? "Did not find" : "Found") + " entry for criteria: \n" +
|
|
" node: " + node.getId() + "\n" +
|
|
" authority: " + authority + "\n" +
|
|
" permission: " + permission);
|
|
}
|
|
return entry;
|
|
}
|
|
|
|
/**
|
|
* Utility method to find or create a persisted authority
|
|
*/
|
|
private DbAuthority getAuthority(String authority, boolean create)
|
|
{
|
|
DbAuthority entity = (DbAuthority) getHibernateTemplate().get(DbAuthorityImpl.class, authority);
|
|
if ((entity == null) && create)
|
|
{
|
|
entity = new DbAuthorityImpl();
|
|
entity.setRecipient(authority);
|
|
getHibernateTemplate().save(entity);
|
|
return entity;
|
|
}
|
|
else
|
|
{
|
|
return entity;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Utility method to find and optionally create a persisted permission.
|
|
*/
|
|
private DbPermission getPermission(PermissionReference permissionRef, final boolean create)
|
|
{
|
|
final QName qname = permissionRef.getQName();
|
|
final String name = permissionRef.getName();
|
|
Session session = getSession();
|
|
|
|
DbPermission dbPermission = DbPermissionImpl.find(session, qname, name);
|
|
|
|
// create if necessary
|
|
if ((dbPermission == null) && create)
|
|
{
|
|
dbPermission = new DbPermissionImpl();
|
|
dbPermission.setTypeQname(qname);
|
|
dbPermission.setName(name);
|
|
getHibernateTemplate().save(dbPermission);
|
|
}
|
|
return dbPermission;
|
|
}
|
|
|
|
public void setPermission(PermissionEntry permissionEntry)
|
|
{
|
|
setPermission(
|
|
permissionEntry.getNodeRef(),
|
|
permissionEntry.getAuthority(),
|
|
permissionEntry.getPermissionReference(),
|
|
permissionEntry.isAllowed());
|
|
}
|
|
|
|
public void setPermission(NodePermissionEntry nodePermissionEntry)
|
|
{
|
|
NodeRef nodeRef = nodePermissionEntry.getNodeRef();
|
|
Node node = getNode(nodeRef, true);
|
|
|
|
// Get the access control list
|
|
// Note the logic here requires to know whether it was created or not
|
|
DbAccessControlList acl = getAccessControlList(node, false);
|
|
if (acl != null)
|
|
{
|
|
// maintain referencial integrity
|
|
node.setAccessControlList(null);
|
|
// drop the list
|
|
getHibernateTemplate().delete(acl);
|
|
}
|
|
// create the access control list
|
|
acl = createAccessControlList(node);
|
|
|
|
// set attributes
|
|
acl.setInherits(nodePermissionEntry.inheritPermissions());
|
|
|
|
// add all entries
|
|
for (PermissionEntry pe : nodePermissionEntry.getPermissionEntries())
|
|
{
|
|
PermissionReference permission = pe.getPermissionReference();
|
|
String authority = pe.getAuthority();
|
|
boolean isAllowed = pe.isAllowed();
|
|
|
|
DbPermission permissionEntity = getPermission(permission, true);
|
|
DbAuthority authorityEntity = getAuthority(authority, true);
|
|
|
|
@SuppressWarnings("unused")
|
|
DbAccessControlEntryImpl entry = acl.newEntry(permissionEntity, authorityEntity, isAllowed);
|
|
}
|
|
}
|
|
|
|
public void setInheritParentPermissions(NodeRef nodeRef, boolean inheritParentPermissions)
|
|
{
|
|
Node node = getNode(nodeRef, true);
|
|
|
|
DbAccessControlList acl = null;
|
|
if (!inheritParentPermissions)
|
|
{
|
|
// Inheritance == true is the default, so only force a create of the ACL if the value false
|
|
acl = getAccessControlList(node, true);
|
|
acl.setInherits(false);
|
|
}
|
|
else
|
|
{
|
|
acl = getAccessControlList(node, false);
|
|
if (acl != null)
|
|
{
|
|
acl.setInherits(true);
|
|
}
|
|
}
|
|
}
|
|
|
|
public boolean getInheritParentPermissions(NodeRef nodeRef)
|
|
{
|
|
Node node = getNode(nodeRef, false);
|
|
if (node == null)
|
|
{
|
|
return INHERIT_PERMISSIONS_DEFAULT;
|
|
}
|
|
|
|
DbAccessControlList acl = getAccessControlList(node, false);
|
|
if (acl == null)
|
|
{
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
return acl.getInherits();
|
|
}
|
|
}
|
|
|
|
// Utility methods to create simple detached objects for the outside world
|
|
// We do not pass out the hibernate objects
|
|
|
|
private SimpleNodePermissionEntry createSimpleNodePermissionEntry(Node node)
|
|
{
|
|
DbAccessControlList acl = node.getAccessControlList();
|
|
if (acl == null)
|
|
{
|
|
// there isn't an access control list for the node - spoof a null one
|
|
SimpleNodePermissionEntry snpe = new SimpleNodePermissionEntry(
|
|
node.getNodeRef(),
|
|
true,
|
|
Collections.<SimplePermissionEntry> emptySet());
|
|
return snpe;
|
|
}
|
|
else
|
|
{
|
|
Set<DbAccessControlEntry> entries = acl.getEntries();
|
|
SimpleNodePermissionEntry snpe = new SimpleNodePermissionEntry(
|
|
node.getNodeRef(),
|
|
acl.getInherits(),
|
|
createSimplePermissionEntries(node, entries));
|
|
return snpe;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param entries access control entries
|
|
* @return Returns a unique set of entries that can be given back to the outside world
|
|
*/
|
|
private Set<SimplePermissionEntry> createSimplePermissionEntries(Node node, Collection<DbAccessControlEntry> entries)
|
|
{
|
|
if (entries == null)
|
|
{
|
|
return null;
|
|
}
|
|
HashSet<SimplePermissionEntry> spes = new HashSet<SimplePermissionEntry>(entries.size(), 1.0f);
|
|
if (entries.size() != 0)
|
|
{
|
|
for (DbAccessControlEntry entry : entries)
|
|
{
|
|
spes.add(createSimplePermissionEntry(node, entry));
|
|
}
|
|
}
|
|
return spes;
|
|
}
|
|
|
|
private static SimplePermissionEntry createSimplePermissionEntry(Node node, DbAccessControlEntry ace)
|
|
{
|
|
if (ace == null)
|
|
{
|
|
return null;
|
|
}
|
|
return new SimplePermissionEntry(
|
|
node.getNodeRef(),
|
|
createSimplePermissionReference(ace.getPermission()),
|
|
ace.getAuthority().getRecipient(),
|
|
ace.isAllowed() ? AccessStatus.ALLOWED : AccessStatus.DENIED);
|
|
}
|
|
|
|
private static SimplePermissionReference createSimplePermissionReference(DbPermission perm)
|
|
{
|
|
if (perm == null)
|
|
{
|
|
return null;
|
|
}
|
|
return new SimplePermissionReference(
|
|
perm.getTypeQname(),
|
|
perm.getName());
|
|
}
|
|
}
|