com.sun.grizzly.util.http.Parameters Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2010 Sun Microsystems, Inc. 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.html
* or glassfish/bootstrap/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 glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [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 com.sun.grizzly.util.http;
import com.sun.grizzly.util.LoggerUtils;
import com.sun.grizzly.util.buf.ByteChunk;
import com.sun.grizzly.util.buf.CharChunk;
import com.sun.grizzly.util.buf.MessageBytes;
import com.sun.grizzly.util.buf.UDecoder;
import com.sun.grizzly.util.collections.MultiMap;
import java.io.IOException;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* @author Costin Manolache
*/
public final class Parameters extends MultiMap {
/**
* Default Logger.
*/
private final static Logger logger = LoggerUtils.getLogger();
// Transition: we'll use the same Hashtable( String->String[] )
// for the beginning. When we are sure all accesses happen through
// this class - we can switch to MultiMap
/* START PWC 6057385
private Hashtable paramHashStringArray=new Hashtable();
*/
// START PWC 6057385
private LinkedHashMap paramHashStringArray =
new LinkedHashMap();
// END PWC 6057385
private boolean didQueryParameters = false;
private boolean didMerge = false;
MessageBytes queryMB;
MimeHeaders headers;
UDecoder urlDec;
MessageBytes decodedQuery = MessageBytes.newInstance();
public static final int INITIAL_SIZE = 4;
// Garbage-less parameter merging.
// In a sub-request with parameters, the new parameters
// will be stored in child. When a getParameter happens,
// the 2 are merged togheter. The child will be altered
// to contain the merged values - the parent is allways the
// original request.
private Parameters child = null;
private Parameters parent = null;
private Parameters currentChild = null;
String encoding = null;
String queryStringEncoding = null;
/**
*
*/
public Parameters() {
super(INITIAL_SIZE);
}
public void setQuery(MessageBytes queryMB) {
this.queryMB = queryMB;
}
public void setHeaders(MimeHeaders headers) {
this.headers = headers;
}
public void setEncoding(String s) {
encoding = s;
if (debug > 0) {
log("Set encoding to " + s);
}
}
public void setQueryStringEncoding(String s) {
queryStringEncoding = s;
if (debug > 0) {
log("Set query string encoding to " + s);
}
}
public void recycle() {
super.recycle();
paramHashStringArray.clear();
didQueryParameters = false;
currentChild = null;
didMerge = false;
encoding = null;
decodedQuery.recycle();
}
// -------------------- Sub-request support --------------------
public Parameters getCurrentSet() {
if (currentChild == null) {
return this;
}
return currentChild;
}
/**
* Create ( or reuse ) a child that will be used during a sub-request.
* All future changes ( setting query string, adding parameters )
* will affect the child ( the parent request is never changed ).
* Both setters and getters will return the data from the deepest
* child, merged with data from parents.
*/
public void push() {
// We maintain a linked list, that will grow to the size of the
// longest include chain.
// The list has 2 points of interest:
// - request.parameters() is the original request and head,
// - request.parameters().currentChild() is the current set.
// The ->child and parent<- links are preserved ( currentChild is not
// the last in the list )
// create a new element in the linked list
// note that we reuse the child, if any - pop will not
// set child to null !
if (currentChild == null) {
currentChild = new Parameters();
currentChild.setURLDecoder(urlDec);
currentChild.parent = this;
return;
}
if (currentChild.child == null) {
currentChild.child = new Parameters();
currentChild.setURLDecoder(urlDec);
currentChild.child.parent = currentChild;
} // it is not null if this object already had a child
// i.e. a deeper include() ( we keep it )
// the head will be the new element.
currentChild = currentChild.child;
currentChild.setEncoding(encoding);
}
/**
* Discard the last child. This happens when we return from a
* sub-request and the parameters are locally modified.
*/
public void pop() {
if (currentChild == null) {
throw new RuntimeException("Attempt to pop without a push");
}
currentChild.recycle();
currentChild = currentChild.parent;
// don't remove the top.
}
// -------------------- Data access --------------------
// Access to the current name/values, no side effect ( processing ).
// You must explicitely call handleQueryParameters and the post methods.
// This is the original data representation ( hash of String->String[])
public void addParameterValues(String key, String[] newValues) {
if (key == null) {
return;
}
String values[];
if (paramHashStringArray.containsKey(key)) {
String oldValues[] = paramHashStringArray.get(key);
values = new String[oldValues.length + newValues.length];
System.arraycopy(oldValues, 0, values, 0, oldValues.length);
System.arraycopy(newValues, 0, values, oldValues.length, newValues.length);
} else {
values = newValues;
}
paramHashStringArray.put(key, values);
}
public String[] getParameterValues(String name) {
handleQueryParameters();
// sub-request
if (currentChild != null) {
currentChild.merge();
return currentChild.paramHashStringArray.get(name);
}
// no "facade"
String values[] = paramHashStringArray.get(name);
return values;
}
public Enumeration getParameterNames() {
handleQueryParameters();
// Slow - the original code
if (currentChild != null) {
currentChild.merge();
/* START PWC 6057385
return currentChild.paramHashStringArray.keys();
*/
// START PWC 6057385
return Collections.enumeration(
currentChild.paramHashStringArray.keySet());
// END PWC 6057385
}
// merge in child
/* START PWC 6057385
return paramHashStringArray.keys();
*/
// START PWC 6057385
return Collections.enumeration(paramHashStringArray.keySet());
// END PWC 6057385
}
/**
* Combine the parameters from parent with our local ones
*/
private void merge() {
// recursive
if (debug > 0) {
log("Before merging " + this + " " + parent + " " + didMerge);
log(paramsAsString());
}
// Local parameters first - they take precedence as in spec.
handleQueryParameters();
// we already merged with the parent
if (didMerge) {
return;
}
// we are the top level
if (parent == null) {
return;
}
// Add the parent props to the child ( lower precedence )
parent.merge();
/* START PWC 6057385
Hashtable parentProps=parent.paramHashStringArray;
*/
// START PWC 6057385
LinkedHashMap parentProps = parent.paramHashStringArray;
// END PWC 6057385
merge2(paramHashStringArray, parentProps);
didMerge = true;
if (debug > 0) {
log("After " + paramsAsString());
}
}
// Shortcut.
public String getParameter(String name) {
String[] values = getParameterValues(name);
if (values != null) {
if (values.length == 0) {
return "";
}
return values[0];
} else {
return null;
}
}
// -------------------- Processing --------------------
/**
* Process the query string into parameters
*/
public void handleQueryParameters() {
if (didQueryParameters) {
return;
}
didQueryParameters = true;
if (queryMB == null || queryMB.isNull()) {
return;
}
if (debug > 0) {
log("Decoding query " + decodedQuery + " " + queryStringEncoding);
}
try {
decodedQuery.duplicate(queryMB);
} catch (IOException e) {
// Can't happen, as decodedQuery can't overflow
e.printStackTrace();
}
processParameters(decodedQuery, queryStringEncoding);
}
// --------------------
/**
* Combine 2 hashtables into a new one.
* ( two will be added to one ).
* Used to combine child parameters ( RequestDispatcher's query )
* with parent parameters ( original query or parent dispatcher )
*/
/* START PWC 6057385
private static void merge2(Hashtable one, Hashtable two ) {
Enumeration e = two.keys();
while (e.hasMoreElements()) {
String name = (String) e.nextElement();
*/
// START PWC 6057385
private static void merge2(LinkedHashMap one,
LinkedHashMap two) {
Iterator e = two.keySet().iterator();
while (e.hasNext()) {
String name = e.next();
// END PWC 6057385
String[] oneValue = one.get(name);
String[] twoValue = two.get(name);
String[] combinedValue;
if (twoValue == null) {
continue;
} else {
if (oneValue == null) {
combinedValue = new String[twoValue.length];
System.arraycopy(twoValue, 0, combinedValue,
0, twoValue.length);
} else {
combinedValue = new String[oneValue.length +
twoValue.length];
System.arraycopy(oneValue, 0, combinedValue, 0,
oneValue.length);
System.arraycopy(twoValue, 0, combinedValue,
oneValue.length, twoValue.length);
}
one.put(name, combinedValue);
}
}
}
// incredibly inefficient data representation for parameters,
// until we test the new one
private void addParam(String key, String value) {
if (key == null) {
return;
}
String values[];
if (paramHashStringArray.containsKey(key)) {
String oldValues[] = paramHashStringArray.get(key);
values = new String[oldValues.length + 1];
System.arraycopy(oldValues, 0, values, 0, oldValues.length);
values[oldValues.length] = value;
} else {
values = new String[1];
values[0] = value;
}
paramHashStringArray.put(key, values);
}
public void setURLDecoder(UDecoder u) {
urlDec = u;
}
// -------------------- Parameter parsing --------------------
// This code is not used right now - it's the optimized version
// of the above.
// we are called from a single thread - we can do it the hard way
// if needed
ByteChunk tmpName = new ByteChunk();
ByteChunk tmpValue = new ByteChunk();
CharChunk tmpNameC = new CharChunk(1024);
CharChunk tmpValueC = new CharChunk(1024);
public void processParameters(byte bytes[], int start, int len) {
processParameters(bytes, start, len, encoding);
}
public void processParameters(byte bytes[], int start, int len,
String enc) {
int end = start + len;
int pos = start;
if (debug > 0) {
log("Bytes: " + new String(bytes, start, len));
}
do {
boolean noEq = false;
int valStart = -1;
int valEnd = -1;
int nameStart = pos;
int nameEnd = ByteChunk.indexOf(bytes, nameStart, end, '=');
// Workaround for a&b&c encoding
int nameEnd2 = ByteChunk.indexOf(bytes, nameStart, end, '&');
if ((nameEnd2 != -1) &&
(nameEnd == -1 || nameEnd > nameEnd2)) {
nameEnd = nameEnd2;
noEq = true;
valStart = nameEnd;
valEnd = nameEnd;
if (debug > 0) {
log("no equal " + nameStart + " " + nameEnd + " " + new String(bytes, nameStart,
nameEnd - nameStart));
}
}
if (nameEnd == -1) {
nameEnd = end;
}
if (!noEq) {
valStart = (nameEnd < end) ? nameEnd + 1 : end;
valEnd = ByteChunk.indexOf(bytes, valStart, end, '&');
if (valEnd == -1) {
valEnd = (valStart < end) ? end : valStart;
}
}
pos = valEnd + 1;
if (nameEnd <= nameStart) {
continue;
// invalid chunk - it's better to ignore
// XXX log it ?
}
tmpName.setBytes(bytes, nameStart, nameEnd - nameStart);
tmpValue.setBytes(bytes, valStart, valEnd - valStart);
try {
addParam(urlDecode(tmpName, enc), urlDecode(tmpValue, enc));
} catch (IOException e) {
// Exception during character decoding: skip parameter
}
tmpName.recycle();
tmpValue.recycle();
} while (pos < end);
}
private String urlDecode(ByteChunk bc, String enc)
throws IOException {
if (urlDec == null) {
urlDec = new UDecoder();
}
urlDec.convert(bc);
String result = null;
if (enc != null) {
bc.setEncoding(enc);
result = bc.toString();
} else {
CharChunk cc = tmpNameC;
int length = bc.getLength();
cc.allocate(length, -1);
// Default encoding: fast conversion
byte[] bbuf = bc.getBuffer();
char[] cbuf = cc.getBuffer();
int start = bc.getStart();
for (int i = 0; i < length; i++) {
cbuf[i] = (char) (bbuf[i + start] & 0xff);
}
cc.setChars(cbuf, 0, length);
result = cc.toString();
cc.recycle();
}
return result;
}
public void processParameters(char chars[], int start, int len) {
int end = start + len;
int pos = start;
if (debug > 0) {
log("Chars: " + new String(chars, start, len));
}
do {
boolean noEq = false;
int nameStart = pos;
int valStart = -1;
int valEnd = -1;
int nameEnd = CharChunk.indexOf(chars, nameStart, end, '=');
int nameEnd2 = CharChunk.indexOf(chars, nameStart, end, '&');
if ((nameEnd2 != -1) &&
(nameEnd == -1 || nameEnd > nameEnd2)) {
nameEnd = nameEnd2;
noEq = true;
valStart = nameEnd;
valEnd = nameEnd;
if (debug > 0) {
log("no equal " + nameStart + " " + nameEnd + " " + new String(chars, nameStart,
nameEnd - nameStart));
}
}
if (nameEnd == -1) {
nameEnd = end;
}
if (!noEq) {
valStart = (nameEnd < end) ? nameEnd + 1 : end;
valEnd = CharChunk.indexOf(chars, valStart, end, '&');
if (valEnd == -1) {
valEnd = (valStart < end) ? end : valStart;
}
}
pos = valEnd + 1;
if (nameEnd <= nameStart) {
continue;
// invalid chunk - no name, it's better to ignore
// XXX log it ?
}
try {
tmpNameC.append(chars, nameStart, nameEnd - nameStart);
tmpValueC.append(chars, valStart, valEnd - valStart);
if (debug > 0) {
log(tmpNameC + "= " + tmpValueC);
}
if (urlDec == null) {
urlDec = new UDecoder();
}
urlDec.convert(tmpNameC);
urlDec.convert(tmpValueC);
if (debug > 0) {
log(tmpNameC + "= " + tmpValueC);
}
addParam(tmpNameC.toString(), tmpValueC.toString());
} catch (IOException ex) {
ex.printStackTrace();
}
tmpNameC.recycle();
tmpValueC.recycle();
} while (pos < end);
}
public void processParameters(MessageBytes data) {
processParameters(data, encoding);
}
public void processParameters(MessageBytes data, String encoding) {
if (data == null || data.isNull() || data.getLength() <= 0) {
return;
}
if (data.getType() == MessageBytes.T_BYTES) {
ByteChunk bc = data.getByteChunk();
processParameters(bc.getBytes(), bc.getOffset(),
bc.getLength(), encoding);
} else {
if (data.getType() != MessageBytes.T_CHARS) {
data.toChars();
}
CharChunk cc = data.getCharChunk();
processParameters(cc.getChars(), cc.getOffset(),
cc.getLength());
}
}
/**
* Debug purpose
*/
public String paramsAsString() {
StringBuilder sb = new StringBuilder();
/* START PWC 6057385
Enumeration en= paramHashStringArray.keys();
while( en.hasMoreElements() ) {
String k=(String)en.nextElement();
*/
// START PWC 6057385
Iterator en = paramHashStringArray.keySet().iterator();
while (en.hasNext()) {
String k = en.next();
// END PWC 6057385
sb.append(k).append("=");
String v[] = paramHashStringArray.get(k);
for (int i = 0; i < v.length; i++) {
sb.append(v[i]).append(",");
}
sb.append("\n");
}
return sb.toString();
}
private static int debug = 0;
private void log(String s) {
if (logger.isLoggable(Level.FINEST)) {
logger.log(Level.FINEST, "Parameters: " + s);
}
}
// -------------------- Old code, needs rewrite --------------------
/**
* Used by RequestDispatcher
*/
public void processSingleParameters(String str) {
int end = str.length();
int pos = 0;
if (debug > 0) {
log("String: " + str);
}
do {
boolean noEq = false;
int valStart = -1;
int valEnd = -1;
int nameStart = pos;
int nameEnd = str.indexOf('=', nameStart);
int nameEnd2 = str.indexOf('&', nameStart);
if (nameEnd2 == -1) {
nameEnd2 = end;
}
if ((nameEnd2 != -1) &&
(nameEnd == -1 || nameEnd > nameEnd2)) {
nameEnd = nameEnd2;
noEq = true;
valStart = nameEnd;
valEnd = nameEnd;
if (debug > 0) {
log("no equal " + nameStart + " " + nameEnd + " " + str.substring(nameStart, nameEnd));
}
}
if (nameEnd == -1) {
nameEnd = end;
}
if (!noEq) {
valStart = nameEnd + 1;
valEnd = str.indexOf('&', valStart);
if (valEnd == -1) {
valEnd = (valStart < end) ? end : valStart;
}
}
pos = valEnd + 1;
if (nameEnd <= nameStart) {
continue;
}
if (debug > 0) {
log("XXX " + nameStart + " " + nameEnd + " "
+ valStart + " " + valEnd);
}
try {
tmpNameC.append(str, nameStart, nameEnd - nameStart);
tmpValueC.append(str, valStart, valEnd - valStart);
if (debug > 0) {
log(tmpNameC + "= " + tmpValueC);
}
if (urlDec == null) {
urlDec = new UDecoder();
}
urlDec.convert(tmpNameC);
urlDec.convert(tmpValueC);
if (debug > 0) {
log(tmpNameC + "= " + tmpValueC);
}
if (str.compareTo(tmpNameC.toString()) == 0) {
addParam(tmpNameC.toString(), tmpValueC.toString());
}
} catch (IOException ex) {
ex.printStackTrace();
}
tmpNameC.recycle();
tmpValueC.recycle();
} while (pos < end);
}
public void processParameters(String str) {
int end = str.length();
int pos = 0;
if (debug > 0) {
log("String: " + str);
}
do {
boolean noEq = false;
int valStart = -1;
int valEnd = -1;
int nameStart = pos;
int nameEnd = str.indexOf('=', nameStart);
int nameEnd2 = str.indexOf('&', nameStart);
if (nameEnd2 == -1) {
nameEnd2 = end;
}
if ((nameEnd2 != -1) &&
(nameEnd == -1 || nameEnd > nameEnd2)) {
nameEnd = nameEnd2;
noEq = true;
valStart = nameEnd;
valEnd = nameEnd;
if (debug > 0) {
log("no equal " + nameStart + " " + nameEnd + " " + str.substring(nameStart, nameEnd));
}
}
if (nameEnd == -1) {
nameEnd = end;
}
if (!noEq) {
valStart = nameEnd + 1;
valEnd = str.indexOf('&', valStart);
if (valEnd == -1) {
valEnd = (valStart < end) ? end : valStart;
}
}
pos = valEnd + 1;
if (nameEnd <= nameStart) {
continue;
}
if (debug > 0) {
log("XXX " + nameStart + " " + nameEnd + " "
+ valStart + " " + valEnd);
}
try {
tmpNameC.append(str, nameStart, nameEnd - nameStart);
tmpValueC.append(str, valStart, valEnd - valStart);
if (debug > 0) {
log(tmpNameC + "= " + tmpValueC);
}
if (urlDec == null) {
urlDec = new UDecoder();
}
urlDec.convert(tmpNameC);
urlDec.convert(tmpValueC);
if (debug > 0) {
log(tmpNameC + "= " + tmpValueC);
}
addParam(tmpNameC.toString(), tmpValueC.toString());
} catch (IOException ex) {
ex.printStackTrace();
}
tmpNameC.recycle();
tmpValueC.recycle();
} while (pos < end);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy