/*
 * ====================================================================
 *
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * [Additional notices, if required by prior licensing conditions]
 *
 */

/*
 * This Interceptor written by Shai Fultheim, shai@brm.com.
 *
 * Being used to rewrite the sessionID to include JVM ID(jvmRoute).
 * This will allow (Response.)encodeUrl to work in  multi tomcats
 * configuration.
 *
 * The class is part of session package in order to use the
 * (StandartSession.)encodeUrl.
 * 
 * All changes to: Shai Fultheim, shai@brm.com
 */

package org.apache.tomcat.session;

import org.apache.tomcat.core.*;

public class URLSessionInterceptor extends  BaseInterceptor
{
    // Separates the session id from the jvm route
    static final char SESSIONID_ROUTE_SEP = '.';
    ContextManager cm;
    int manager_note;

    public URLSessionInterceptor() {
    }

	// Called on init. Takes the context manager (used for logging) and
	// the standardManager address.
    public void engineInit( ContextManager cm ) throws TomcatException {
		this.cm = cm;

		// set-up a per/container note for StandardManager
		manager_note = cm.getNoteId(ContextManager.CONTAINER_NOTE, "tomcat.standardManager");

		if ( debug > 0 ) cm.log("URLSessionInterceptor: Started");
    }

	// Called every time the servlet ask for NEW session.
	public int newSessionRequest(Request request, Response response) {
		String jvmRoute = request.getJvmRoute();

		// Check whether SessionInterceptor hasn't been removed from
		// server.xml
		if( request.getSession( false ) != null ) {
			cm.log("Request has Seesion object. exiting");
			return 0;
		}

		// Get context's Manager interface and create new session by that interface.
		// NOTE: Session exists only in our context.
		StandardSession session =
			(StandardSession)
				((StandardManager)request.getContext().getContainer().getNote(manager_note))
					.getNewSession();

		// Add jvmRoute (if we have it)
		if(jvmRoute != null) {
			session.setId(session.getId() + "." + jvmRoute);
			if (debug > 0) cm.log("Creating.   jvmRoute=" + jvmRoute);
		}

		// Attach session to request.
		request.setSession(session);

		if (debug > 0) cm.log("Creating.   SessionID=" + request.getSession(false).getId());

		return 0;
    }

    // Extract the session id from the request. URLSessionInterceptor
    // will have to be called _before_ mapper, to avoid coding session
    // stuff inside the mapper.
    public int contextMap(Request request ) {
		// Check whether SessionInterceptor hasn't been removed from
		// server.xml
        if( request.getRequestedSessionId() != null ) {
            cm.log("Another interceptor tried to set SessionID. exiting");
    	    return 0;
    	}

    	int foundAt = -1;
    	String sig  = ";jsessionid=";
    	String uri  = request.getRequestURI();
    	String sessionId;

        // Take SessionID out of the URL
    	if ((foundAt = uri.indexOf(sig)) != -1){
    	    sessionId=uri.substring(foundAt+sig.length());
    	    request.setRequestURI(uri.substring(0, foundAt));
    	    request.setSessionIdSource(Request.SESSIONID_FROM_URL);
    	    request.setRequestedSessionId(sessionId);
            if (debug > 0) cm.log("Retrieving. SessionID=" + sessionId);
    	} else
            if (debug > 0) cm.log("No '" + sig + "' in url. New request?");

    	return 0;
    }
}