/*
* Copyright (C) 2005-2007 Alfresco Software Limited.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* As a special exception to the terms and conditions of version 2.0 of
* the GPL, you may redistribute this Program in connection with Free/Libre
* and Open Source Software ("FLOSS") applications as described in Alfresco's
* FLOSS exception. You should have recieved a copy of the text describing
* the FLOSS exception, and it is also available here:
* http://www.alfresco.com/legal/licensing"
*/
package org.alfresco.repo.audit;
import java.io.Serializable;
import java.util.Date;
import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.policy.Behaviour;
import org.alfresco.repo.policy.JavaBehaviour;
import org.alfresco.repo.policy.PolicyComponent;
import org.alfresco.repo.policy.PolicyScope;
import org.alfresco.repo.policy.Behaviour.NotificationFrequency;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.repo.tenant.TenantService;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.InvalidNodeRefException;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.cmr.security.AuthenticationService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.PropertyMap;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* This aspect maintains the audit properties of the Auditable aspect.
*
* @author David Caruana
*/
public class AuditableAspect
{
// Logger
private static final Log logger = LogFactory.getLog(AuditableAspect.class);
// Unknown user, for when authentication has not occured
private static final String USERNAME_UNKNOWN = "unknown";
// Dependencies
private NodeService nodeService;
private AuthenticationService authenticationService;
private PolicyComponent policyComponent;
private TenantService tenantService;
// Behaviours
private Behaviour onCreateAudit;
private Behaviour onAddAudit;
private Behaviour onUpdateAudit;
/**
* @param nodeService the node service to use for audit property maintenance
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* @param policyComponent the policy component
*/
public void setPolicyComponent(PolicyComponent policyComponent)
{
this.policyComponent = policyComponent;
}
/**
* @param authenticationService the authentication service
*/
public void setAuthenticationService(AuthenticationService authenticationService)
{
this.authenticationService = authenticationService;
}
/**
* @param tenantService the tenant service
*/
public void setTenantService(TenantService tenantService)
{
this.tenantService = tenantService;
}
/**
* Initialise the Auditable Aspect
*/
public void init()
{
// Create behaviours
onCreateAudit = new JavaBehaviour(this, "onCreateAudit", NotificationFrequency.FIRST_EVENT);
onAddAudit = new JavaBehaviour(this, "onAddAudit", NotificationFrequency.FIRST_EVENT);
onUpdateAudit = new JavaBehaviour(this, "onUpdateAudit", NotificationFrequency.TRANSACTION_COMMIT);
// Bind behaviours to node policies
policyComponent.bindClassBehaviour(QName.createQName(NamespaceService.ALFRESCO_URI, "onCreateNode"), ContentModel.ASPECT_AUDITABLE, onCreateAudit);
policyComponent.bindClassBehaviour(QName.createQName(NamespaceService.ALFRESCO_URI, "onAddAspect"), ContentModel.ASPECT_AUDITABLE, onAddAudit);
policyComponent.bindClassBehaviour(QName.createQName(NamespaceService.ALFRESCO_URI, "onUpdateNode"), ContentModel.ASPECT_AUDITABLE, onUpdateAudit);
// Register onCopy class behaviour
policyComponent.bindClassBehaviour(QName.createQName(NamespaceService.ALFRESCO_URI, "onCopyNode"), ContentModel.ASPECT_AUDITABLE, new JavaBehaviour(this, "onCopy"));
}
/**
* Maintain audit properties on creation of Node
*
* @param childAssocRef the association to the child created
*/
public void onCreateAudit(ChildAssociationRef childAssocRef)
{
NodeRef nodeRef = childAssocRef.getChildRef();
onAddAudit(nodeRef, null);
}
/**
* Maintain audit properties on addition of audit aspect to a node
*
* @param nodeRef the node to which auditing has been added
* @param aspect the aspect added
*/
public void onAddAudit(NodeRef nodeRef, QName aspect)
{
// Get the current properties
PropertyMap properties = new PropertyMap();
// Set created / updated date
Date now = new Date(System.currentTimeMillis());
properties.put(ContentModel.PROP_CREATED, now);
properties.put(ContentModel.PROP_MODIFIED, now);
// Set creator (but do not override, if explicitly set)
String creator = (String)properties.get(ContentModel.PROP_CREATOR);
if (creator == null || creator.length() == 0)
{
creator = getUsername();
properties.put(ContentModel.PROP_CREATOR, creator);
}
properties.put(ContentModel.PROP_MODIFIER, creator);
try
{
// Set the updated property values (but do not cascade to update audit behaviour)
onUpdateAudit.disable();
// note: in MT case, this will run in System context of user's domain ... checkForLock requires System
AuthenticationUtil.runAs(new SetAuditProperties(nodeService, nodeRef, properties), AuthenticationUtil.getSystemUserName());
}
finally
{
onUpdateAudit.enable();
}
if (logger.isDebugEnabled())
logger.debug("Auditable node " + nodeRef + " created [created,modified=" + now + ";creator,modifier=" + creator + "]");
}
/**
* Maintain audit properties on update of node
*
* @param nodeRef the updated node
*/
public void onUpdateAudit(NodeRef nodeRef)
{
// Get the current properties
try
{
PropertyMap properties = new PropertyMap();
// Set updated date
Date now = new Date(System.currentTimeMillis());
properties.put(ContentModel.PROP_MODIFIED, now);
// Set modifier
String modifier = getUsername();
properties.put(ContentModel.PROP_MODIFIER, modifier);
// Set the updated property values
// note: in MT case, this will run in System context of user's domain ... checkForLock requires System
AuthenticationUtil.runAs(new SetAuditProperties(nodeService, nodeRef, properties), AuthenticationUtil.getSystemUserName());
if (logger.isDebugEnabled())
logger.debug("Auditable node " + nodeRef + " updated [modified=" + now + ";modifier=" + modifier + "]");
}
catch(InvalidNodeRefException e)
{
if (logger.isDebugEnabled())
logger.debug("Warning: Auditable node " + nodeRef + " no longer exists - cannot update");
}
}
/**
* @return the current username (or unknown, if unknown)
*/
private String getUsername()
{
String currentUserName = authenticationService.getCurrentUserName();
if (currentUserName != null)
{
if (tenantService.isEnabled() && authenticationService.isCurrentUserTheSystemUser())
{
return tenantService.getBaseNameUser(currentUserName);
}
return currentUserName;
}
return USERNAME_UNKNOWN;
}
/**
* OnCopy behaviour implementation for the lock aspect.
* <p>
* Ensures that the propety values of the lock aspect are not copied onto
* the destination node.
*
* @see org.alfresco.repo.copy.CopyServicePolicies.OnCopyNodePolicy#onCopyNode(QName, NodeRef, StoreRef, boolean, PolicyScope)
*/
public void onCopy(
QName sourceClassRef,
NodeRef sourceNodeRef,
StoreRef destinationStoreRef,
boolean copyToNewNode,
PolicyScope copyDetails)
{
// The auditable aspect should not be copied
}
/**
* Helper to set Audit Properties as System User
*/
private static class SetAuditProperties implements AuthenticationUtil.RunAsWork<Boolean>
{
private NodeService nodeService;
private NodeRef nodeRef;
private Map<QName, Serializable> properties;
/**
* Construct
*
* @param nodeRef
* @param properties
*/
private SetAuditProperties(NodeService nodeService, NodeRef nodeRef, Map<QName, Serializable> properties)
{
this.nodeService = nodeService;
this.nodeRef = nodeRef;
this.properties = properties;
}
/* (non-Javadoc)
* @see org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork#doWork()
*/
public Boolean doWork() throws Exception
{
// Callback here must be done on a per-property basis to avoid the cm:name updates to the child association
for (Map.Entry<QName, Serializable> entry : properties.entrySet())
{
QName propertyQName = entry.getKey();
Serializable propertyValue = entry.getValue();
nodeService.setProperty(nodeRef, propertyQName, propertyValue);
}
return Boolean.TRUE;
}
}
}