alfresco-community-repo/source/java/org/alfresco/repo/tenant/MultiTNodeServiceInterceptor.java

/*
 * Copyright (C) 2005-2008 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.tenant;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import org.alfresco.model.ContentModel;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.Path;
import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.EqualsHelper;
import org.aopalliance.intercept.MethodInvocation;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.aop.support.DelegatingIntroductionInterceptor;

/**
 * Interceptor to translate Node 
 * 
 * @since 3.0 
 * @author Derek Hulley
 * @author janv
 */
public class MultiTNodeServiceInterceptor extends DelegatingIntroductionInterceptor//implements NodeService
{
    private static final long serialVersionUID = -5462852271914961462L;

    private static Log logger = LogFactory.getLog(MultiTNodeServiceInterceptor.class);
    
    private static ThreadLocal<Boolean> ignoreMT = new ThreadLocal<Boolean>();
    
    private TenantService tenantService;
    
    /**
     * Change the filtering behaviour of this interceptor on the current thread.
     * Use this to switch off the filtering and pass references in and out as they
     * are found.
     * 
     * @param ignoreMT      <tt>true</tt> if the current thread is able to handle
     *                      MultiTenant-enabled references. 
     * @return              <tt>true</tt> if the current transaction is MT aware
     */
    public static boolean setIgnoreMT(boolean ignoreMT)
    {
        boolean wasIgnoreMT = isIgnoreMT();
        MultiTNodeServiceInterceptor.ignoreMT.set(Boolean.valueOf(ignoreMT));
        return wasIgnoreMT;
    }
    
    /**
     * @return      Returns <tt>true</tt> if the current thread has marked itself
     *              as being able to handle MultiTenant references.
     */
    static public boolean isIgnoreMT()
    {
        if (ignoreMT.get() == null)
        {
            return false;
        }
        else
        {
            return ignoreMT.get();
        }
    }
    
    public void setTenantService(TenantService tenantService)
    {
        this.tenantService = tenantService;
    }
    
    @SuppressWarnings("unchecked")
    public Object invoke(MethodInvocation invocation) throws Throwable
    {
        // See if we can shortcut (for super 'System' only)
        if (AuthenticationUtil.getSystemUserName().equals(AuthenticationUtil.getRunAsUser()) || !AuthenticationUtil.isMtEnabled())
        {
            return invocation.proceed();
        }

        String methodName = invocation.getMethod().getName();
        
        if (logger.isDebugEnabled())
        {
            logger.debug("Intercepting method " + methodName);
        }
        
        Object[] args = invocation.getArguments();
        // Convert each of the arguments to the underlying (full) reference.
        for (int i = 0; i < args.length; i++)
        {
            Object arg = args[i];
            Object newArg = arg;
            if (arg == null)
            {
                // No conversion possible
            }
            if (arg instanceof StoreRef)
            {
                StoreRef ref = (StoreRef) arg;
                newArg = tenantService.getName(ref);
            }
            else if (arg instanceof NodeRef)
            {
                NodeRef ref = (NodeRef) arg;
                newArg = tenantService.getName(ref);
            }
            else if (arg instanceof ChildAssociationRef)
            {
                ChildAssociationRef ref = (ChildAssociationRef) arg;
                newArg = tenantService.getName(ref);
            }
            else if (arg instanceof AssociationRef)
            {
                AssociationRef ref = (AssociationRef) arg;
                newArg = tenantService.getName(ref);
            }
            
            if (logger.isDebugEnabled())
            {
                if (!EqualsHelper.nullSafeEquals(newArg, arg))
                {
                    logger.debug(
                            "Argument converted: \n" +
                            "   Before: " + arg + "\n" +
                            "   After:  " + newArg);
                }
            }
            
            // Substitute the new value
            args[i] = newArg;
        }
        
        // Make the call
        Object ret = invocation.proceed();
        
        if (methodName.equals("getProperty"))
        {
            if (ret != null)
            {
                // Convert the outbound value
                QName qname = (QName)args[1];
                if (qname.equals(ContentModel.PROP_STORE_IDENTIFIER))
                {
                    String rawStoreId = (String)ret;
                    ret = tenantService.getBaseName(rawStoreId);
                }
                else
                {
                    ret = convertOutboundValue(ret);
                }
            }
            
            return ret;
        }
        else if (methodName.equals("getProperties"))
        {
            if (ret != null)
            {
                // Convert the outbound values
                Map<QName, Serializable> rawValues = (Map<QName, Serializable>)ret;
                for (Map.Entry<QName, Serializable> rawValue : rawValues.entrySet())
                {
                    QName qname = rawValue.getKey();
                    Serializable value = rawValue.getValue();

                    if (qname.equals(ContentModel.PROP_STORE_IDENTIFIER) && (value != null))
                    {
                        rawValues.put(ContentModel.PROP_STORE_IDENTIFIER, tenantService.getBaseName((String)value));
                    }
                    else
                    {
                        rawValues.put(qname, (Serializable)convertOutboundValue(value));
                    }
                }
                
                ret = rawValues;
            }
            
            return ret;
        }
        else if (methodName.equals("getStores"))
        {
            if ((ret == null) || (! (ret instanceof List)))
            {
                return null;
            }
            
            List<StoreRef> rawValues = (List<StoreRef>)ret;
            final List<StoreRef> convertedValues = new ArrayList<StoreRef>(rawValues.size());
            
            for (StoreRef ref : rawValues)
            {
                StoreRef storeRef = ref;
                try
                {
                    if (tenantService.isEnabled())
                    {
                        // MT: return tenant stores only (although for super System return all stores - as used by
                        // ConfigurationChecker, IndexRecovery, IndexBackup etc)
                        if (!AuthenticationUtil.isRunAsUserTheSystemUser())
                        {
                            tenantService.checkDomain(storeRef.getIdentifier());
                            storeRef = tenantService.getBaseName(storeRef);
                        }
                    }
                    
                    convertedValues.add(storeRef);
                }
                catch (RuntimeException re)
                {
                    // deliberately ignore - stores in different domain will not be listed
                }
            }
            
            return convertedValues;
        }
        else
        {
            // Convert the outbound value
            ret = convertOutboundValue(ret);
        }
        
        // done
        return ret;
    }

    /**
     * Convert outbound collection to spoofed (no tenant prefix) values.
     */
    private Collection<Object> convertOutboundValues(Collection<Object> rawValues)
    {
        /*
         * Return types can be Lists or Sets, so cater for both.
         */
        final Collection<Object> convertedValues;
        if (rawValues instanceof List)
        {
            convertedValues = new ArrayList<Object>(rawValues.size());
        }
        else if (rawValues instanceof Set)
        {
            convertedValues = new HashSet<Object>(rawValues.size(), 1.0F);
        }
        else
        {
            throw new IllegalArgumentException("Interceptor can only handle List and Set return types.");
        }
        
        for (Object rawValue : rawValues)
        {
            Object convertedValue = convertOutboundValue(rawValue);
            convertedValues.add(convertedValue);
        }
        // Done
        return convertedValues;
    }
    
    /**
     * Convert outbound single value to spoofed (no tenant prefix) value. 
     */
    @SuppressWarnings("unchecked")
    private Object convertOutboundValue(Object rawValue)
    {
        if (rawValue == null)
        {
            return null;
        }
        
        // Deal with collections
        Object value = rawValue;
        if (rawValue instanceof Collection)
        {
            value = convertOutboundValues((Collection<Object>)rawValue);
        }
        else if (rawValue instanceof StoreRef)
        {
            StoreRef ref = (StoreRef) rawValue;
            value = tenantService.getBaseName(ref);
        }
        else if (rawValue instanceof NodeRef)
        {
            NodeRef ref = (NodeRef) rawValue;
            value = tenantService.getBaseName(ref);
        }
        else if (rawValue instanceof ChildAssociationRef)
        {
            ChildAssociationRef ref = (ChildAssociationRef) rawValue;
            value = tenantService.getBaseName(ref);
        }
        else if (rawValue instanceof AssociationRef)
        {
            AssociationRef ref = (AssociationRef) rawValue;
            value = tenantService.getBaseName(ref);
        }
        else if (rawValue instanceof Path)
        {
            Path ref = (Path)rawValue;
            Path outboundPath = new Path();
            Iterator<Path.Element> itr = ref.iterator();
            while (itr.hasNext())
            {
                Path.Element pathElement = itr.next();
                if (pathElement instanceof Path.ChildAssocElement)
                {
                    pathElement = new Path.ChildAssocElement(tenantService.getBaseName(((Path.ChildAssocElement)pathElement).getRef()));
                }
                outboundPath.append(pathElement);
            }
            value = outboundPath;
        }
        // Done
        return value;
    }
}