org.apache.catalina.ssi.SSIEcho Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 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.
*/
package org.apache.catalina.ssi;
import org.glassfish.web.util.HtmlEntityEncoder;
import java.io.PrintWriter;
/**
* Return the result associated with the supplied Server Variable.
*
* @author Bip Thelin
* @author Paul Speed
* @author Dan Sandberg
* @author David Becker
* @version $Revision: 1.4 $, $Date: 2007/05/05 05:32:19 $
*/
public class SSIEcho implements SSICommand {
protected final static String DEFAULT_ENCODING = "entity";
protected final static String MISSING_VARIABLE_VALUE = "(none)";
/**
* @see SSICommand
*/
public long process(SSIMediator ssiMediator, String commandName,
String[] paramNames, String[] paramValues, PrintWriter writer) {
String encoding = DEFAULT_ENCODING;
String originalValue = null;
String errorMessage = null; // delay the call of HtmlEntityEncoder.encode
for (int i = 0; i < paramNames.length; i++) {
String paramName = paramNames[i];
String paramValue = paramValues[i];
if (paramName.equalsIgnoreCase("var")) {
originalValue = paramValue;
} else if (paramName.equalsIgnoreCase("encoding")) {
if (isValidEncoding(paramValue)) {
encoding = paramValue;
} else {
ssiMediator.log("#echo--Invalid encoding: " + paramValue);
if (errorMessage == null) {
errorMessage = getEncodedConfigErrorMessage(ssiMediator);
}
writer.write(errorMessage);
}
} else {
ssiMediator.log("#echo--Invalid attribute: " + paramName);
if (errorMessage == null) {
errorMessage = getEncodedConfigErrorMessage(ssiMediator);
}
writer.write(errorMessage);
}
}
String variableValue = ssiMediator.getVariableValue(
originalValue, encoding);
if (variableValue == null) {
variableValue = MISSING_VARIABLE_VALUE;
}
writer.write(variableValue);
return System.currentTimeMillis();
}
protected boolean isValidEncoding(String encoding) {
return encoding.equalsIgnoreCase("url")
|| encoding.equalsIgnoreCase("entity")
|| encoding.equalsIgnoreCase("none");
}
private String getEncodedConfigErrorMessage(SSIMediator ssiMediator) {
String errorMessage = ssiMediator.getConfigErrMsg();
return HtmlEntityEncoder.encodeXSS(errorMessage);
}
}