jasper/jasper2/src/share/org/apache/jasper/servlet/JspServlet.java - tomcat55 - Git at Google

 /*
  * Copyright 1999,2004 The Apache Software Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * 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.apache.jasper.servlet;

 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Enumeration;

 import javax.servlet.ServletConfig;
 import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;

 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;

 import org.apache.jasper.Constants;
 import org.apache.jasper.EmbeddedServletOptions;
 import org.apache.jasper.Options;
 import org.apache.jasper.compiler.JspRuntimeContext;
 import org.apache.jasper.compiler.Localizer;

 /**
  * The JSP engine (a.k.a Jasper).
  *
  * The servlet container is responsible for providing a
  * URLClassLoader for the web application context Jasper
  * is being used in. Jasper will try get the Tomcat
  * ServletContext attribute for its ServletContext class
  * loader, if that fails, it uses the parent class loader.
  * In either case, it must be a URLClassLoader.
  *
  * @author Anil K. Vijendran
  * @author Harish Prabandham
  * @author Remy Maucherat
  * @author Kin-man Chung
  * @author Glenn Nielsen
  */
 public class JspServlet extends HttpServlet {

     // Logger
     private static Log log = LogFactory.getLog(JspServlet.class);

     private ServletContext context;
     private ServletConfig config;
     private Options options;
     private JspRuntimeContext rctxt;


     /*
      * Initializes this JspServlet.
      */
     public void init(ServletConfig config) throws ServletException {

 	super.init(config);
 	this.config = config;
 	this.context = config.getServletContext();

         // Initialize the JSP Runtime Context
         options = new EmbeddedServletOptions(config, context);
         rctxt = new JspRuntimeContext(context,options);

 	if (log.isDebugEnabled()) {
 	    log.debug(Localizer.getMessage("jsp.message.scratch.dir.is",
 					   options.getScratchDir().toString()));
 	    log.debug(Localizer.getMessage("jsp.message.dont.modify.servlets"));
 	}
     }


     /**
      * Returns the number of JSPs for which JspServletWrappers exist, i.e.,
      * the number of JSPs that have been loaded into the webapp with which
      * this JspServlet is associated.
      *
      * <p>This info may be used for monitoring purposes.
      *
      * @return The number of JSPs that have been loaded into the webapp with
      * which this JspServlet is associated
      */
     public int getJspCount() {
         return this.rctxt.getJspCount();
     }


     /**
      * Resets the JSP reload counter.
      *
      * @param count Value to which to reset the JSP reload counter
      */
     public void setJspReloadCount(int count) {
         this.rctxt.setJspReloadCount(count);
     }


     /**
      * Gets the number of JSPs that have been reloaded.
      *
      * <p>This info may be used for monitoring purposes.
      *
      * @return The number of JSPs (in the webapp with which this JspServlet is
      * associated) that have been reloaded
      */
     public int getJspReloadCount() {
         return this.rctxt.getJspReloadCount();
     }


     /**
      * <p>Look for a <em>precompilation request</em> as described in
      * Section 8.4.2 of the JSP 1.2 Specification.  <strong>WARNING</strong> -
      * we cannot use <code>request.getParameter()</code> for this, because
      * that will trigger parsing all of the request parameters, and not give
      * a servlet the opportunity to call
      * <code>request.setCharacterEncoding()</code> first.</p>
      *
      * @param request The servlet requset we are processing
      *
      * @exception ServletException if an invalid parameter value for the
      *  <code>jsp_precompile</code> parameter name is specified
      */
     boolean preCompile(HttpServletRequest request) throws ServletException {

         String queryString = request.getQueryString();
         if (queryString == null) {
             return (false);
         }
         int start = queryString.indexOf(Constants.PRECOMPILE);
         if (start < 0) {
             return (false);
         }
         queryString =
             queryString.substring(start + Constants.PRECOMPILE.length());
         if (queryString.length() == 0) {
             return (true);             // ?jsp_precompile
         }
         if (queryString.startsWith("&")) {
             return (true);             // ?jsp_precompile&foo=bar...
         }
         if (!queryString.startsWith("=")) {
             return (false);            // part of some other name or value
         }
         int limit = queryString.length();
         int ampersand = queryString.indexOf("&");
         if (ampersand > 0) {
             limit = ampersand;
         }
         String value = queryString.substring(1, limit);
         if (value.equals("true")) {
             return (true);             // ?jsp_precompile=true
         } else if (value.equals("false")) {
 	    // Spec says if jsp_precompile=false, the request should not
 	    // be delivered to the JSP page; the easiest way to implement
 	    // this is to set the flag to true, and precompile the page anyway.
 	    // This still conforms to the spec, since it says the
 	    // precompilation request can be ignored.
             return (true);             // ?jsp_precompile=false
         } else {
             throw new ServletException("Cannot have request parameter " +
                                        Constants.PRECOMPILE + " set to " +
                                        value);
         }

     }


     public void service (HttpServletRequest request,
     			 HttpServletResponse response)
 	throws ServletException, IOException {

         try {
             String includeUri
                 = (String) request.getAttribute(Constants.INC_SERVLET_PATH);
             String requestUri
                 = (String) request.getAttribute(Constants.INC_REQUEST_URI);

             String jspUri;

             // When jsp-property-group/url-matching is used, and when the
             // jsp is not defined with <servlet-name>, the url
             // as to be passed as it is to the JSP container (since
             // Catalina doesn't know anything about the requested JSP

             // The first scenario occurs when the jsp is not directly under /
             // example: /utf16/foo.jsp
             if (requestUri != null){
                 String currentIncludedUri
                     = requestUri.substring(requestUri.indexOf(includeUri));

                 if ( !includeUri.equals(currentIncludedUri) ) {
                     includeUri = currentIncludedUri;
                 }
             }

             // The second scenario is when the includeUri is null but it
             // is still possible to recreate the request.
             if (includeUri == null) {
                 jspUri = request.getServletPath();
                 if (request.getPathInfo() != null) {
                     jspUri = request.getServletPath() + request.getPathInfo();
                 }
             } else {
                 jspUri = includeUri;
             }

             String jspFile = (String) request.getAttribute(Constants.JSP_FILE);
             if (jspFile != null) {
                 jspUri = jspFile;
             }

             boolean precompile = preCompile(request);

             if (log.isDebugEnabled()) {
                 log.debug("JspEngine --> " + jspUri);
                 log.debug("\t     ServletPath: " + request.getServletPath());
                 log.debug("\t        PathInfo: " + request.getPathInfo());
                 log.debug("\t        RealPath: " + context.getRealPath(jspUri));
                 log.debug("\t      RequestURI: " + request.getRequestURI());
                 log.debug("\t     QueryString: " + request.getQueryString());
                 log.debug("\t  Request Params: ");
                 Enumeration e = request.getParameterNames();

                 while (e.hasMoreElements()) {
                     String name = (String) e.nextElement();
                     log.debug("\t\t " + name + " = "
                               + request.getParameter(name));
                 }
             }

             serviceJspFile(request, response, jspUri, null, precompile);
         } catch (RuntimeException e) {
             throw e;
         } catch (ServletException e) {
             throw e;
         } catch (IOException e) {
             throw e;
         } catch (Throwable e) {
             throw new ServletException(e);
         }

     }

     public void destroy() {
         if (log.isDebugEnabled()) {
             log.debug("JspServlet.destroy()");
         }

         rctxt.destroy();
     }


     // -------------------------------------------------------- Private Methods

     private void serviceJspFile(HttpServletRequest request,
                                 HttpServletResponse response, String jspUri,
                                 Throwable exception, boolean precompile)
         throws ServletException, IOException {

         JspServletWrapper wrapper =
             (JspServletWrapper) rctxt.getWrapper(jspUri);
         if (wrapper == null) {
             synchronized(this) {
                 wrapper = (JspServletWrapper) rctxt.getWrapper(jspUri);
                 if (wrapper == null) {
                     // Check if the requested JSP page exists, to avoid
                     // creating unnecessary directories and files.
                     InputStream resourceStream =
                         context.getResourceAsStream(jspUri);
                     if (resourceStream == null) {
                         response.sendError(HttpServletResponse.SC_NOT_FOUND,
                                            jspUri);
                         return;
                     } else {
                         try {
                             resourceStream.close();
                         } catch(IOException e) { /* ignore */ }
                     }
                     boolean isErrorPage = exception != null;
                     wrapper = new JspServletWrapper(config, options, jspUri,
                                                     isErrorPage, rctxt);
                     rctxt.addWrapper(jspUri,wrapper);
                 }
             }
         }

         wrapper.service(request, response, precompile);

     }

 }
	/*
	* Copyright 1999,2004 The Apache Software Foundation.
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* 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.apache.jasper.servlet;

	import java.io.IOException;
	import java.io.InputStream;
	import java.util.Enumeration;

	import javax.servlet.ServletConfig;
	import javax.servlet.ServletContext;
	import javax.servlet.ServletException;
	import javax.servlet.http.HttpServlet;
	import javax.servlet.http.HttpServletRequest;
	import javax.servlet.http.HttpServletResponse;

	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;

	import org.apache.jasper.Constants;
	import org.apache.jasper.EmbeddedServletOptions;
	import org.apache.jasper.Options;
	import org.apache.jasper.compiler.JspRuntimeContext;
	import org.apache.jasper.compiler.Localizer;

	/**
	* The JSP engine (a.k.a Jasper).
	*
	* The servlet container is responsible for providing a
	* URLClassLoader for the web application context Jasper
	* is being used in. Jasper will try get the Tomcat
	* ServletContext attribute for its ServletContext class
	* loader, if that fails, it uses the parent class loader.
	* In either case, it must be a URLClassLoader.
	*
	* @author Anil K. Vijendran
	* @author Harish Prabandham
	* @author Remy Maucherat
	* @author Kin-man Chung
	* @author Glenn Nielsen
	*/
	public class JspServlet extends HttpServlet {

	// Logger
	private static Log log = LogFactory.getLog(JspServlet.class);

	private ServletContext context;
	private ServletConfig config;
	private Options options;
	private JspRuntimeContext rctxt;


	/*
	* Initializes this JspServlet.
	*/
	public void init(ServletConfig config) throws ServletException {

	super.init(config);
	this.config = config;
	this.context = config.getServletContext();

	// Initialize the JSP Runtime Context
	options = new EmbeddedServletOptions(config, context);
	rctxt = new JspRuntimeContext(context,options);

	if (log.isDebugEnabled()) {
	log.debug(Localizer.getMessage("jsp.message.scratch.dir.is",
	options.getScratchDir().toString()));
	log.debug(Localizer.getMessage("jsp.message.dont.modify.servlets"));
	}
	}


	/**
	* Returns the number of JSPs for which JspServletWrappers exist, i.e.,
	* the number of JSPs that have been loaded into the webapp with which
	* this JspServlet is associated.
	*
	* <p>This info may be used for monitoring purposes.
	*
	* @return The number of JSPs that have been loaded into the webapp with
	* which this JspServlet is associated
	*/
	public int getJspCount() {
	return this.rctxt.getJspCount();
	}


	/**
	* Resets the JSP reload counter.
	*
	* @param count Value to which to reset the JSP reload counter
	*/
	public void setJspReloadCount(int count) {
	this.rctxt.setJspReloadCount(count);
	}


	/**
	* Gets the number of JSPs that have been reloaded.
	*
	* <p>This info may be used for monitoring purposes.
	*
	* @return The number of JSPs (in the webapp with which this JspServlet is
	* associated) that have been reloaded
	*/
	public int getJspReloadCount() {
	return this.rctxt.getJspReloadCount();
	}


	/**
	* <p>Look for a <em>precompilation request</em> as described in
	* Section 8.4.2 of the JSP 1.2 Specification. <strong>WARNING</strong> -
	* we cannot use <code>request.getParameter()</code> for this, because
	* that will trigger parsing all of the request parameters, and not give
	* a servlet the opportunity to call
	* <code>request.setCharacterEncoding()</code> first.</p>
	*
	* @param request The servlet requset we are processing
	*
	* @exception ServletException if an invalid parameter value for the
	* <code>jsp_precompile</code> parameter name is specified
	*/
	boolean preCompile(HttpServletRequest request) throws ServletException {

	String queryString = request.getQueryString();
	if (queryString == null) {
	return (false);
	}
	int start = queryString.indexOf(Constants.PRECOMPILE);
	if (start < 0) {
	return (false);
	}
	queryString =
	queryString.substring(start + Constants.PRECOMPILE.length());
	if (queryString.length() == 0) {
	return (true); // ?jsp_precompile
	}
	if (queryString.startsWith("&")) {
	return (true); // ?jsp_precompile&foo=bar...
	}
	if (!queryString.startsWith("=")) {
	return (false); // part of some other name or value
	}
	int limit = queryString.length();
	int ampersand = queryString.indexOf("&");
	if (ampersand > 0) {
	limit = ampersand;
	}
	String value = queryString.substring(1, limit);
	if (value.equals("true")) {
	return (true); // ?jsp_precompile=true
	} else if (value.equals("false")) {
	// Spec says if jsp_precompile=false, the request should not
	// be delivered to the JSP page; the easiest way to implement
	// this is to set the flag to true, and precompile the page anyway.
	// This still conforms to the spec, since it says the
	// precompilation request can be ignored.
	return (true); // ?jsp_precompile=false
	} else {
	throw new ServletException("Cannot have request parameter " +
	Constants.PRECOMPILE + " set to " +
	value);
	}

	}


	public void service (HttpServletRequest request,
	HttpServletResponse response)
	throws ServletException, IOException {

	try {
	String includeUri
	= (String) request.getAttribute(Constants.INC_SERVLET_PATH);
	String requestUri
	= (String) request.getAttribute(Constants.INC_REQUEST_URI);

	String jspUri;

	// When jsp-property-group/url-matching is used, and when the
	// jsp is not defined with <servlet-name>, the url
	// as to be passed as it is to the JSP container (since
	// Catalina doesn't know anything about the requested JSP

	// The first scenario occurs when the jsp is not directly under /
	// example: /utf16/foo.jsp
	if (requestUri != null){
	String currentIncludedUri
	= requestUri.substring(requestUri.indexOf(includeUri));

	if ( !includeUri.equals(currentIncludedUri) ) {
	includeUri = currentIncludedUri;
	}
	}

	// The second scenario is when the includeUri is null but it
	// is still possible to recreate the request.
	if (includeUri == null) {
	jspUri = request.getServletPath();
	if (request.getPathInfo() != null) {
	jspUri = request.getServletPath() + request.getPathInfo();
	}
	} else {
	jspUri = includeUri;
	}

	String jspFile = (String) request.getAttribute(Constants.JSP_FILE);
	if (jspFile != null) {
	jspUri = jspFile;
	}

	boolean precompile = preCompile(request);

	if (log.isDebugEnabled()) {
	log.debug("JspEngine --> " + jspUri);
	log.debug("\t ServletPath: " + request.getServletPath());
	log.debug("\t PathInfo: " + request.getPathInfo());
	log.debug("\t RealPath: " + context.getRealPath(jspUri));
	log.debug("\t RequestURI: " + request.getRequestURI());
	log.debug("\t QueryString: " + request.getQueryString());
	log.debug("\t Request Params: ");
	Enumeration e = request.getParameterNames();

	while (e.hasMoreElements()) {
	String name = (String) e.nextElement();
	log.debug("\t\t " + name + " = "
	+ request.getParameter(name));
	}
	}

	serviceJspFile(request, response, jspUri, null, precompile);
	} catch (RuntimeException e) {
	throw e;
	} catch (ServletException e) {
	throw e;
	} catch (IOException e) {
	throw e;
	} catch (Throwable e) {
	throw new ServletException(e);
	}

	}

	public void destroy() {
	if (log.isDebugEnabled()) {
	log.debug("JspServlet.destroy()");
	}

	rctxt.destroy();
	}


	// -------------------------------------------------------- Private Methods

	private void serviceJspFile(HttpServletRequest request,
	HttpServletResponse response, String jspUri,
	Throwable exception, boolean precompile)
	throws ServletException, IOException {

	JspServletWrapper wrapper =
	(JspServletWrapper) rctxt.getWrapper(jspUri);
	if (wrapper == null) {
	synchronized(this) {
	wrapper = (JspServletWrapper) rctxt.getWrapper(jspUri);
	if (wrapper == null) {
	// Check if the requested JSP page exists, to avoid
	// creating unnecessary directories and files.
	InputStream resourceStream =
	context.getResourceAsStream(jspUri);
	if (resourceStream == null) {
	response.sendError(HttpServletResponse.SC_NOT_FOUND,
	jspUri);
	return;
	} else {
	try {
	resourceStream.close();
	} catch(IOException e) { /* ignore */ }
	}
	boolean isErrorPage = exception != null;
	wrapper = new JspServletWrapper(config, options, jspUri,
	isErrorPage, rctxt);
	rctxt.addWrapper(jspUri,wrapper);
	}
	}
	}

	wrapper.service(request, response, precompile);

	}

	}