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;
|
|
|
|
import java.nio.charset.UnsupportedCharsetException;
|
2008-11-19 08:22:15 +01:00
|
|
|
import java.util.ArrayList;
|
|
|
|
import java.util.HashMap;
|
|
|
|
import java.util.List;
|
|
|
|
import java.util.Map;
|
2009-03-14 14:48:01 +01:00
|
|
|
import java.util.regex.Matcher;
|
|
|
|
import java.util.regex.Pattern;
|
2008-11-19 08:22:15 +01:00
|
|
|
|
|
|
|
/**
|
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>
|
|
|
|
* QueryStringDecoder decoder = new QueryStringDecoder("/hello?recipient=world");
|
|
|
|
* assert decoder.getPath().equals("/hello");
|
|
|
|
* assert decoder.getParameters().get("recipient").equals("world");
|
|
|
|
* </pre>
|
2009-06-19 16:49:26 +02:00
|
|
|
*
|
2008-11-19 08:22:15 +01:00
|
|
|
* @author The Netty Project (netty-dev@lists.jboss.org)
|
|
|
|
* @author Andy Taylor (andy.taylor@jboss.org)
|
2009-10-14 07:46:40 +02:00
|
|
|
* @author Trustin Lee (trustin@gmail.com)
|
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-03-14 14:48:01 +01:00
|
|
|
private static final Pattern PARAM_PATTERN = Pattern.compile("([^=]*)=([^&]*)&*");
|
2009-02-26 07:34:07 +01:00
|
|
|
|
|
|
|
private final String charset;
|
2008-11-19 08:22:15 +01:00
|
|
|
private final String uri;
|
|
|
|
private String path;
|
|
|
|
private final Map<String, List<String>> params = new HashMap<String, List<String>>();
|
|
|
|
|
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-02-26 07:34:07 +01:00
|
|
|
public QueryStringDecoder(String uri, String charset) {
|
|
|
|
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-02-26 07:34:07 +01:00
|
|
|
public QueryStringDecoder(URI uri, String charset){
|
|
|
|
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() {
|
|
|
|
//decode lazily
|
|
|
|
if(path == null) {
|
|
|
|
if(uri.contains("?")) {
|
|
|
|
decode();
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
path = uri;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
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() {
|
|
|
|
if(path == null){
|
|
|
|
if(uri.contains("?")) {
|
|
|
|
decode();
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
path = uri;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return params;
|
|
|
|
}
|
|
|
|
|
|
|
|
private void decode() {
|
2009-03-14 14:48:01 +01:00
|
|
|
int pathEndPos = uri.indexOf('?');
|
|
|
|
if (pathEndPos < 0) {
|
|
|
|
path = uri;
|
|
|
|
} else {
|
|
|
|
path = uri.substring(0, pathEndPos);
|
|
|
|
decodeParams(uri.substring(pathEndPos + 1));
|
|
|
|
}
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
2008-11-26 09:44:39 +01:00
|
|
|
|
2008-11-19 08:22:15 +01:00
|
|
|
private void decodeParams(String s) {
|
2009-03-14 14:48:01 +01:00
|
|
|
Matcher m = PARAM_PATTERN.matcher(s);
|
|
|
|
int pos = 0;
|
|
|
|
while (m.find(pos)) {
|
|
|
|
pos = m.end();
|
|
|
|
String key = decodeComponent(m.group(1), charset);
|
|
|
|
String value = decodeComponent(m.group(2), charset);
|
|
|
|
|
|
|
|
List<String> values = params.get(key);
|
2008-11-19 08:22:15 +01:00
|
|
|
if(values == null) {
|
|
|
|
values = new ArrayList<String>();
|
2009-03-14 14:48:01 +01:00
|
|
|
params.put(key,values);
|
2009-02-12 05:39:17 +01:00
|
|
|
}
|
2009-03-14 14:48:01 +01:00
|
|
|
values.add(value);
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2009-03-14 14:35:10 +01:00
|
|
|
private static String decodeComponent(String s, String charset) {
|
2009-03-14 14:48:01 +01:00
|
|
|
if (s == null) {
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
2009-02-26 07:34:07 +01:00
|
|
|
try {
|
|
|
|
return URLDecoder.decode(s, charset);
|
|
|
|
} catch (UnsupportedEncodingException e) {
|
|
|
|
throw new UnsupportedCharsetException(charset);
|
|
|
|
}
|
2008-11-19 08:22:15 +01:00
|
|
|
}
|
|
|
|
}
|