org.apache.catalina.core.StandardContextValve Maven / Gradle / Ivy
Show all versions of payara-micro Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 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.
*/
// Portions Copyright [2016-2022] [Payara Foundation and/or its affiliates]
package org.apache.catalina.core;
import org.apache.catalina.*;
import org.apache.catalina.valves.ValveBase;
import org.glassfish.web.valve.GlassFishValve;
import jakarta.servlet.*;
import jakarta.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.regex.Pattern;
import org.glassfish.grizzly.utils.Charsets;
/**
* Valve that implements the default basic behavior for the
* StandardContext container implementation.
*
* USAGE CONSTRAINT: This implementation is likely to be useful only
* when processing HTTP requests.
*
* @author Craig R. McClanahan
* @version $Revision: 1.19 $ $Date: 2007/05/05 05:31:54 $
*/
final class StandardContextValve
extends ValveBase {
// ----------------------------------------------------- Instance Variables
/**
* The descriptive information related to this implementation.
*/
private static final String info =
"org.apache.catalina.core.StandardContextValve/1.0";
private StandardContext context = null;
private static final Pattern PATTERN_META_INF = Pattern.compile("[.]{2}[/]?.*[/](META-INF[/].*|META-INF$)",
Pattern.CASE_INSENSITIVE);
private static final Pattern PATTERN_WEB_INF = Pattern.compile("[.]{2}[/]?.*[/](WEB-INF[/].*|WEB-INF$)",
Pattern.CASE_INSENSITIVE);
// ------------------------------------------------------------- Properties
/**
* Return descriptive information about this Valve implementation.
*/
@Override
public String getInfo() {
return (info);
}
// --------------------------------------------------------- Public Methods
/**
* Cast to a StandardContext right away, as it will be needed later.
*
* @see Contained#setContainer(Container)
*/
@Override
public void setContainer(Container container) {
super.setContainer(container);
if (container instanceof StandardContext) {
context = (StandardContext) container;
}
}
/**
* Select the appropriate child Wrapper to process this request,
* based on the specified request URI. If no matching Wrapper can
* be found, return an appropriate HTTP error.
*
* @param request Request to be processed
* @param response Response to be produced
*
* @exception IOException if an input/output error occurred
* @exception ServletException if a servlet error occurred
*/
@Override
public int invoke(Request request, Response response)
throws IOException, ServletException {
Wrapper wrapper = preInvoke(request, response);
if (wrapper == null) {
return END_PIPELINE;
}
/* GlassFish 1343
wrapper.getPipeline().invoke(request, response);
*/
// START GlassFish 1343
if (wrapper.getPipeline().hasNonBasicValves() ||
wrapper.hasCustomPipeline()) {
wrapper.getPipeline().invoke(request, response);
} else {
GlassFishValve basic = wrapper.getPipeline().getBasic();
if (basic != null) {
basic.invoke(request, response);
basic.postInvoke(request, response);
}
}
// END GlassFish 1343
return END_PIPELINE;
}
/**
* Tomcat style invocation.
*/
@Override
public void invoke(org.apache.catalina.connector.Request request,
org.apache.catalina.connector.Response response)
throws IOException, ServletException {
Wrapper wrapper = preInvoke(request, response);
if (wrapper == null) {
return;
}
/* GlassFish 1343
wrapper.getPipeline().invoke(request, response);
*/
// START GlassFish 1343
if (wrapper.getPipeline().hasNonBasicValves() ||
wrapper.hasCustomPipeline()) {
wrapper.getPipeline().invoke(request, response);
} else {
GlassFishValve basic = wrapper.getPipeline().getBasic();
if (basic != null) {
basic.invoke(request, response);
basic.postInvoke(request, response);
}
}
// END GlassFish 1343
postInvoke(request, response);
}
@Override
public void postInvoke(Request request, Response response)
throws IOException, ServletException {
}
/**
* Report a "not found" error for the specified resource. FIXME: We
* should really be using the error reporting settings for this web
* application, but currently that code runs at the wrapper level rather
* than the context level.
*
* @param response The response we are creating
*/
private void notFound(HttpServletResponse response) {
try {
response.sendError(HttpServletResponse.SC_NOT_FOUND);
} catch (IllegalStateException | IOException e) {
// Ignore
}
}
/**
* Log a message on the Logger associated with our Container (if any)
*
* @param message Message to be logged
*
private void log(String message) {
org.apache.catalina.Logger logger = null;
String containerName = null;
if (container != null) {
logger = container.getLogger();
containerName = container.getName();
}
if (logger != null) {
logger.log("StandardContextValve[" + container.getName() + "]: " +
message);
} else {
if (log.isLoggable(Level.INFO)) {
log.info("StandardContextValve[" + containerName + "]: " +
message);
}
}
}
/**
* Log a message on the Logger associated with our Container (if any)
*
* @param message Message to be logged
* @param t Associated exception
*
private void log(String message, Throwable t) {
org.apache.catalina.Logger logger = null;
String containerName = null;
if (container != null) {
logger = container.getLogger();
containerName = container.getName();
}
if (logger != null) {
logger.log("StandardContextValve[" + container.getName() + "]: " +
message, t, org.apache.catalina.Logger.WARNING);
} else {
log.log(Level.WARNING, "StandardContextValve[" + containerName +
"]: " + message, t);
}
}
*/
/**
* resolves '.' and '..' elements in the path
* if there are too many, making a path negative, returns null
*
* @param path to be normalized
* @return normalized path or null
*/
protected String normalize(String path) {
if (path == null) {
return null;
}
String rv = path;
// starts with a double-slash
if (rv.indexOf("//") == 0) {
rv = rv.replace("//", "/");
}
// starts with dot-slash
if (rv.indexOf("./") == 0) {
rv = rv.replaceFirst("./", "/");
}
// has ../*/WEB-INF/* or ../*/META-INF/*
if (PATTERN_WEB_INF.matcher(rv).find()) {
return "/WEB-INF";
}
if (PATTERN_META_INF.matcher(rv).find()) {
return "/META-INF";
}
// Normalize the slashes and add leading slash if necessary
if (rv.indexOf('\\') >= 0) {
rv = rv.replace('\\', '/');
}
// Resolve occurrences of "/../" in the normalized path
while (true) {
int idx = rv.indexOf("/../");
if (idx < 0) {
break;
}
if (idx == 0) {
return null; // negative relative path
}
int index2 = rv.lastIndexOf('/', idx - 1);
rv = rv.substring(0, index2) + rv.substring(idx + 3);
}
// Resolve occurrences of "/./" example if the path looks like /app/./some/./something/./my.jsp
//then after processing should look like /app/some/something/my.jsp
rv = evaluateNormalizedPathWithSinglePoint(rv);
//if the path don't start with / then include it
if(!rv.startsWith("/")) {
rv = "/" + rv;
}
// Return the normalized path that we have completed
return rv;
}
/**
* this method helps to evaluate the element "/./" on the path
* @param path to be normalized
* @return normalized path
*/
private String evaluateNormalizedPathWithSinglePoint(String path) {
// Resolve occurrences of "/./" in the normalized path
while (true) {
int idx = path.indexOf("/./");
if (idx < 0) {
break;
}
path = path.substring(0, idx) + path.substring(idx + 2);
}
return path;
}
private Wrapper preInvoke(Request request, Response response) {
// Disallow any direct access to resources under WEB-INF or META-INF
HttpRequest hreq = (HttpRequest) request;
// START CR 6415120
if (request.getCheckRestrictedResources()) {
// END CR 6415120
String requestPath = normalize(hreq.getRequestPathMB().toString(Charsets.UTF8_CHARSET));
if ((requestPath == null)
|| (requestPath.toUpperCase().startsWith("/META-INF/", 0))
|| (requestPath.equalsIgnoreCase("/META-INF"))
|| (requestPath.toUpperCase().startsWith("/WEB-INF/", 0))
|| (requestPath.equalsIgnoreCase("/WEB-INF"))) {
notFound((HttpServletResponse) response.getResponse());
return null;
}
// START CR 6415120
}
// END CR 6415120
// Wait if we are reloading
boolean reloaded = false;
while (((StandardContext) container).getPaused()) {
reloaded = true;
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
// Ignore
}
}
// Reloading will have stopped the old webappclassloader and
// created a new one
if (reloaded &&
context.getLoader() != null &&
context.getLoader().getClassLoader() != null) {
Thread.currentThread().setContextClassLoader(
context.getLoader().getClassLoader());
}
// Select the Wrapper to be used for this Request
Wrapper wrapper = request.getWrapper();
if (wrapper == null) {
notFound((HttpServletResponse) response.getResponse());
return null;
} else if (wrapper.isUnavailable()) {
// May be as a result of a reload, try and find the new wrapper
wrapper = (Wrapper) container.findChild(wrapper.getName());
if (wrapper == null) {
notFound((HttpServletResponse) response.getResponse());
return null;
}
}
return wrapper;
}
}