alfresco-community-repo/source/java/org/alfresco/web/scripts/WebClientAuthenticator.java

/*
 * 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.web.scripts;

import javax.servlet.ServletContext;

import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.service.cmr.security.AuthenticationService;
import org.alfresco.web.app.servlet.AuthenticationHelper;
import org.alfresco.web.app.servlet.AuthenticationStatus;
import org.alfresco.web.app.servlet.BaseServlet;
import org.alfresco.web.scripts.WebScriptDescription.RequiredAuthentication;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.web.context.ServletContextAware;


/**
 * Alfresco Web Client Authentication Interceptor
 * 
 * @author davidc
 */
public class WebClientAuthenticator implements MethodInterceptor, ServletContextAware
{
    // Logger
    private static final Log logger = LogFactory.getLog(WebClientAuthenticator.class);

    // dependencies
    private ServletContext context;
    private AuthenticationService authenticationService;


    /* (non-Javadoc)
     * @see org.springframework.web.context.ServletContextAware#setServletContext(javax.servlet.ServletContext)
     */
    public void setServletContext(ServletContext context)
    {
        this.context = context;
    }
    
    /**
     * @param authenticationService
     */
    public void setAuthenticationService(AuthenticationService authenticationService)
    {
        this.authenticationService = authenticationService;
    }
    
    /* (non-Javadoc)
     * @see org.aopalliance.intercept.MethodInterceptor#invoke(org.aopalliance.intercept.MethodInvocation)
     */
    public Object invoke(MethodInvocation invocation)
        throws Throwable
    {
        String currentUser = null;
        Object retVal = null;
        Object[] args = invocation.getArguments();
        WebScriptRequest request = (WebScriptRequest)args[0];
        WebScriptResponse response = (WebScriptResponse)args[1];
        WebScript service = (WebScript)invocation.getThis();
        WebScriptDescription description = service.getDescription();
        AuthenticationStatus status = null;

        try
        {
            
            //
            // Determine if user already authenticated
            //
            
            currentUser = AuthenticationUtil.getCurrentUserName();
            if (logger.isDebugEnabled())
                logger.debug("Current authentication: " + (currentUser == null ? "unauthenticated" : "authenticated as " + currentUser));
    
            //
            // validate credentials
            // 
    
            String ticket = request.getParameter("ticket");
            boolean isGuest = request.isGuest();
            
            if (logger.isDebugEnabled())
            {
                logger.debug("Web Script authentication required: " + description.getRequiredAuthentication());
                logger.debug("Guest login: " + isGuest);
                logger.debug("Ticket provided: " + (ticket != null && ticket.length() > 0));
            }
        
            if (ticket != null && ticket.length() > 0)
            {
                if (logger.isDebugEnabled())
                    logger.debug("Authenticating ticket " + ticket);

                status = AuthenticationHelper.authenticate(context, request, response, ticket);
            }
            else
            {
                if (isGuest && description.getRequiredAuthentication() == RequiredAuthentication.guest)
                {
                    if (logger.isDebugEnabled())
                        logger.debug("Authenticating as Guest");

                    status = AuthenticationHelper.authenticate(context, request, response, true);
                }
                else
                {
                    if (logger.isDebugEnabled())
                        logger.debug("Authenticating session");

                    status = AuthenticationHelper.authenticate(context, request, response, false);
                }
            }

            //
            // execute web script or request authorization
            //
            
            if (status != null && status != AuthenticationStatus.Failure)
            {
                retVal = invocation.proceed();
            }
            else
            {
                // authentication failed - now need to display the login page to the user, if asked to
                if (logger.isDebugEnabled())
                    logger.debug("Redirecting to Alfresco Login");

                BaseServlet.redirectToLoginPage(request, response, context);
            }
        }
        finally
        {
            if (status != null && status != AuthenticationStatus.Failure)
            {
                authenticationService.clearCurrentSecurityContext();
                if (currentUser != null)
                {
                    AuthenticationUtil.setCurrentUser(currentUser);
                }
                
                if (logger.isDebugEnabled())
                    logger.debug("Authentication reset: " + (currentUser == null ? "unauthenticated" : "authenticated as " + currentUser));
            }
        }
        
        return retVal;        
    }

}