2008-11-19 08:22:15 +01:00
|
|
|
/*
|
2009-08-28 09:15:49 +02:00
|
|
|
* Copyright 2009 Red Hat, Inc.
|
2009-06-19 19:48:17 +02:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* Red Hat licenses this file to you 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:
|
2008-11-19 08:22:15 +01:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
2008-11-19 08:22:15 +01:00
|
|
|
*
|
2009-08-28 09:15:49 +02:00
|
|
|
* 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.
|
2008-11-19 08:22:15 +01:00
|
|
|
*/
|
|
|
|
package org.jboss.netty.handler.codec.http;
|
|
|
|
|
2009-02-26 07:34:07 +01:00
|
|
|
import java.io.UnsupportedEncodingException;
|
2008-11-19 08:22:15 +01:00
|
|
|
import java.net.URI;
|
2009-02-26 07:34:07 +01:00
|
|
|
import java.net.URLDecoder;
|
2009-12-29 06:52:00 +01:00
|
|
|
import java.nio.charset.Charset;
|
2009-02-26 07:34:07 +01:00
|
|
|
import java.nio.charset.UnsupportedCharsetException;
|
2008-11-19 08:22:15 +01:00
|
|
|
import java.util.ArrayList;
|
2010-06-14 12:57:48 +02:00
|
|
|
import java.util.Collections;
|
|
|
|
import java.util.LinkedHashMap;
|
2008-11-19 08:22:15 +01:00
|
|
|
import java.util.List;
|
|
|
|
import java.util.Map;
|
|
|
|
|
|
|
|
/**
|
2009-06-19 16:49:26 +02:00
|
|
|
* Splits an HTTP query string into a path string and key-value parameter pairs.
|
2009-06-19 17:05:47 +02:00
|
|
|
* This decoder is for one time use only. Create a new instance for each URI:
|
|
|
|
* <pre>
|
2010-02-02 03:00:04 +01:00
|
|
|
* {@link QueryStringDecoder} decoder = new {@link QueryStringDecoder}("/hello?recipient=world");
|
2009-06-19 17:05:47 +02:00
|
|
|
* assert decoder.getPath().equals("/hello");
|
|
|
|
* assert decoder.getParameters().get("recipient").equals("world");
|
|
|
|
* </pre>
|
2009-06-19 16:49:26 +02:00
|
|
|
*
|
2010-01-26 10:04:19 +01:00
|
|
|
* @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
|
2008-11-19 08:22:15 +01:00
|
|
|
* @author Andy Taylor (andy.taylor@jboss.org)
|
2010-01-26 10:04:19 +01:00
|
|
|
* @author <a href="http://gleamynode.net/">Trustin Lee</a>
|
2010-06-14 13:07:44 +02:00
|
|
|
* @author <a href="http://tsunanet.net/">Benoit Sigoure</a>
|
2008-12-03 10:00:29 +01:00
|
|
|
* @version $Rev$, $Date$
|
2008-12-03 10:05:54 +01:00
|
|
|
*
|
2009-06-19 17:05:47 +02:00
|
|
|
* @see QueryStringEncoder
|
2009-07-20 05:37:35 +02:00
|
|
|
*
|
|
|
|
* @apiviz.stereotype utility
|
|
|
|
* @apiviz.has org.jboss.netty.handler.codec.http.HttpRequest oneway - - decodes
|
2008-11-19 08:22:15 +01:00
|
|
|
*/
|
|
|
|
public class QueryStringDecoder {
|
|
|
|
|
2009-12-29 06:52:00 +01:00
|
|
|
private final Charset charset;
|
2008-11-19 08:22:15 +01:00
|
|
|
private final String uri;
|
|
|
|
private String path;
|
2010-06-14 12:57:48 +02:00
|
|
|
private Map<String, List<String>> params;
|
2008-11-19 08:22:15 +01:00
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Creates a new decoder that decodes the specified URI. The decoder will
|
|
|
|
* assume that the query string is encoded in UTF-8.
|
|
|
|
*/
|
2008-11-19 08:22:15 +01:00
|
|
|
public QueryStringDecoder(String uri) {
|
2009-03-14 14:48:01 +01:00
|
|
|
this(uri, HttpCodecUtil.DEFAULT_CHARSET);
|
2009-02-26 07:34:07 +01:00
|
|
|
}
|
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Creates a new decoder that decodes the specified URI encoded in the
|
|
|
|
* specified charset.
|
|
|
|
*/
|
2009-12-29 06:52:00 +01:00
|
|
|
public QueryStringDecoder(String uri, Charset charset) {
|
2009-02-26 07:34:07 +01:00
|
|
|
if (uri == null) {
|
|
|
|
throw new NullPointerException("uri");
|
|
|
|
}
|
|
|
|
if (charset == null) {
|
|
|
|
throw new NullPointerException("charset");
|
|
|
|
}
|
|
|
|
|
2008-11-19 08:22:15 +01:00
|
|
|
this.uri = uri;
|
2009-02-26 07:34:07 +01:00
|
|
|
this.charset = charset;
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Creates a new decoder that decodes the specified URI. The decoder will
|
|
|
|
* assume that the query string is encoded in UTF-8.
|
|
|
|
*/
|
2009-02-26 07:34:07 +01:00
|
|
|
public QueryStringDecoder(URI uri) {
|
2009-03-14 14:48:01 +01:00
|
|
|
this(uri, HttpCodecUtil.DEFAULT_CHARSET);
|
2009-02-26 07:34:07 +01:00
|
|
|
}
|
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Creates a new decoder that decodes the specified URI encoded in the
|
|
|
|
* specified charset.
|
|
|
|
*/
|
2009-12-29 06:52:00 +01:00
|
|
|
public QueryStringDecoder(URI uri, Charset charset){
|
2009-02-26 07:34:07 +01:00
|
|
|
if (uri == null) {
|
|
|
|
throw new NullPointerException("uri");
|
|
|
|
}
|
|
|
|
if (charset == null) {
|
|
|
|
throw new NullPointerException("charset");
|
|
|
|
}
|
|
|
|
|
2008-11-19 08:22:15 +01:00
|
|
|
this.uri = uri.toASCIIString();
|
2009-02-26 07:34:07 +01:00
|
|
|
this.charset = charset;
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Returns the decoded path string of the URI.
|
|
|
|
*/
|
2008-11-19 08:22:15 +01:00
|
|
|
public String getPath() {
|
2010-06-14 12:57:48 +02:00
|
|
|
if (path == null) {
|
|
|
|
int pathEndPos = uri.indexOf('?');
|
|
|
|
if (pathEndPos < 0) {
|
|
|
|
path = uri;
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
else {
|
2010-06-14 12:57:48 +02:00
|
|
|
return path = uri.substring(0, pathEndPos);
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
return path;
|
|
|
|
}
|
|
|
|
|
2009-06-19 16:49:26 +02:00
|
|
|
/**
|
|
|
|
* Returns the decoded key-value parameter pairs of the URI.
|
|
|
|
*/
|
2008-11-19 08:22:15 +01:00
|
|
|
public Map<String, List<String>> getParameters() {
|
2010-06-14 12:57:48 +02:00
|
|
|
if (params == null) {
|
|
|
|
int pathLength = getPath().length();
|
|
|
|
if (uri.length() == pathLength) {
|
|
|
|
return Collections.emptyMap();
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
2010-06-14 12:57:48 +02:00
|
|
|
params = decodeParams(uri.substring(pathLength + 1));
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
return params;
|
|
|
|
}
|
|
|
|
|
2010-06-14 12:57:48 +02:00
|
|
|
private Map<String, List<String>> decodeParams(String s) {
|
|
|
|
Map<String, List<String>> params = new LinkedHashMap<String, List<String>>();
|
|
|
|
String name = null;
|
|
|
|
int pos = 0; // Beginning of the unprocessed region
|
|
|
|
int i; // End of the unprocessed region
|
|
|
|
char c = 0; // Current character
|
|
|
|
for (i = 0; i < s.length(); i++) {
|
|
|
|
c = s.charAt(i);
|
|
|
|
if (c == '=' && name == null) {
|
|
|
|
if (pos != i) {
|
|
|
|
name = decodeComponent(s.substring(pos, i), charset);
|
|
|
|
}
|
|
|
|
pos = i + 1;
|
|
|
|
} else if (c == '&') {
|
|
|
|
if (name == null && pos != i) {
|
|
|
|
// We haven't seen an `=' so far but moved forward.
|
|
|
|
// Must be a param of the form '&a&' so add it with
|
|
|
|
// an empty value.
|
|
|
|
addParam(params, decodeComponent(s.substring(pos, i), charset), "");
|
|
|
|
} else if (name != null) {
|
|
|
|
addParam(params, name, decodeComponent(s.substring(pos, i), charset));
|
|
|
|
name = null;
|
|
|
|
}
|
|
|
|
pos = i + 1;
|
|
|
|
}
|
2009-03-14 14:48:01 +01:00
|
|
|
}
|
2008-11-26 09:44:39 +01:00
|
|
|
|
2010-06-14 12:57:48 +02:00
|
|
|
if (pos != i) { // Are there characters we haven't dealt with?
|
|
|
|
if (name == null) { // Yes and we haven't seen any `='.
|
|
|
|
addParam(params, decodeComponent(s.substring(pos, i), charset), "");
|
|
|
|
} else { // Yes and this must be the last value.
|
|
|
|
addParam(params, name, decodeComponent(s.substring(pos, i), charset));
|
2009-02-12 05:39:17 +01:00
|
|
|
}
|
2010-06-14 12:57:48 +02:00
|
|
|
} else if (name != null) { // Have we seen a name without value?
|
|
|
|
addParam(params, name, "");
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
2010-06-14 12:57:48 +02:00
|
|
|
|
|
|
|
return params;
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
|
2009-12-29 06:52:00 +01:00
|
|
|
private static String decodeComponent(String s, Charset charset) {
|
2009-03-14 14:48:01 +01:00
|
|
|
if (s == null) {
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
2009-02-26 07:34:07 +01:00
|
|
|
try {
|
2009-12-29 06:52:00 +01:00
|
|
|
return URLDecoder.decode(s, charset.name());
|
2009-02-26 07:34:07 +01:00
|
|
|
} catch (UnsupportedEncodingException e) {
|
2009-12-29 06:52:00 +01:00
|
|
|
throw new UnsupportedCharsetException(charset.name());
|
2009-02-26 07:34:07 +01:00
|
|
|
}
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
2010-06-14 12:57:48 +02:00
|
|
|
|
|
|
|
private static void addParam(Map<String, List<String>> params, String name, String value) {
|
|
|
|
List<String> values = params.get(name);
|
|
|
|
if (values == null) {
|
|
|
|
values = new ArrayList<String>(1); // Often there's only 1 value.
|
|
|
|
params.put(name, values);
|
|
|
|
}
|
|
|
|
values.add(value);
|
|
|
|
}
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|