1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16 package org.jboss.netty.handler.codec.http;
17
18 import org.jboss.netty.util.CharsetUtil;
19
20 import java.io.UnsupportedEncodingException;
21 import java.net.URI;
22 import java.net.URLDecoder;
23 import java.nio.charset.Charset;
24 import java.util.ArrayList;
25 import java.util.Collections;
26 import java.util.LinkedHashMap;
27 import java.util.List;
28 import java.util.Map;
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60 public class QueryStringDecoder {
61
62 private static final int DEFAULT_MAX_PARAMS = 1024;
63
64 private final Charset charset;
65 private final String uri;
66 private final boolean hasPath;
67 private final int maxParams;
68 private String path;
69 private Map<String, List<String>> params;
70 private int nParams;
71
72
73
74
75
76 public QueryStringDecoder(String uri) {
77 this(uri, HttpConstants.DEFAULT_CHARSET);
78 }
79
80
81
82
83
84 public QueryStringDecoder(String uri, boolean hasPath) {
85 this(uri, HttpConstants.DEFAULT_CHARSET, hasPath);
86 }
87
88
89
90
91
92 public QueryStringDecoder(String uri, Charset charset) {
93 this(uri, charset, true);
94 }
95
96
97
98
99
100 public QueryStringDecoder(String uri, Charset charset, boolean hasPath) {
101 this(uri, charset, hasPath, DEFAULT_MAX_PARAMS);
102 }
103
104
105
106
107
108 public QueryStringDecoder(String uri, Charset charset, boolean hasPath, int maxParams) {
109 if (uri == null) {
110 throw new NullPointerException("uri");
111 }
112 if (charset == null) {
113 throw new NullPointerException("charset");
114 }
115 if (maxParams <= 0) {
116 throw new IllegalArgumentException(
117 "maxParams: " + maxParams + " (expected: a positive integer)");
118 }
119
120 this.uri = uri;
121 this.charset = charset;
122 this.maxParams = maxParams;
123 this.hasPath = hasPath;
124 }
125
126
127
128
129 @Deprecated
130 public QueryStringDecoder(String uri, String charset) {
131 this(uri, Charset.forName(charset));
132 }
133
134
135
136
137
138 public QueryStringDecoder(URI uri) {
139 this(uri, HttpConstants.DEFAULT_CHARSET);
140 }
141
142
143
144
145
146 public QueryStringDecoder(URI uri, Charset charset) {
147 this(uri, charset, DEFAULT_MAX_PARAMS);
148 }
149
150
151
152
153
154 public QueryStringDecoder(URI uri, Charset charset, int maxParams) {
155 if (uri == null) {
156 throw new NullPointerException("uri");
157 }
158 if (charset == null) {
159 throw new NullPointerException("charset");
160 }
161 if (maxParams <= 0) {
162 throw new IllegalArgumentException(
163 "maxParams: " + maxParams + " (expected: a positive integer)");
164 }
165
166 String rawPath = uri.getRawPath();
167 if (rawPath != null) {
168 hasPath = true;
169 } else {
170 rawPath = "";
171 hasPath = false;
172 }
173
174 this.uri = rawPath + '?' + uri.getRawQuery();
175 this.charset = charset;
176 this.maxParams = maxParams;
177 }
178
179
180
181
182 @Deprecated
183 public QueryStringDecoder(URI uri, String charset) {
184 this(uri, Charset.forName(charset));
185 }
186
187
188
189
190 public String getPath() {
191 if (path == null) {
192 if (!hasPath) {
193 return path = "";
194 }
195
196 int pathEndPos = uri.indexOf('?');
197 if (pathEndPos < 0) {
198 path = uri;
199 } else {
200 return path = uri.substring(0, pathEndPos);
201 }
202 }
203 return path;
204 }
205
206
207
208
209 public Map<String, List<String>> getParameters() {
210 if (params == null) {
211 if (hasPath) {
212 int pathLength = getPath().length();
213 if (uri.length() == pathLength) {
214 return Collections.emptyMap();
215 }
216 decodeParams(uri.substring(pathLength + 1));
217 } else {
218 if (uri.length() == 0) {
219 return Collections.emptyMap();
220 }
221 decodeParams(uri);
222 }
223 }
224 return params;
225 }
226
227 private void decodeParams(String s) {
228 Map<String, List<String>> params = this.params = new LinkedHashMap<String, List<String>>();
229 nParams = 0;
230 String name = null;
231 int pos = 0;
232 int i;
233 char c;
234 for (i = 0; i < s.length(); i++) {
235 c = s.charAt(i);
236 if (c == '=' && name == null) {
237 if (pos != i) {
238 name = decodeComponent(s.substring(pos, i), charset);
239 }
240 pos = i + 1;
241
242 } else if (c == '&' || c == ';') {
243 if (name == null && pos != i) {
244
245
246
247 if (!addParam(params, decodeComponent(s.substring(pos, i), charset), "")) {
248 return;
249 }
250 } else if (name != null) {
251 if (!addParam(params, name, decodeComponent(s.substring(pos, i), charset))) {
252 return;
253 }
254 name = null;
255 }
256 pos = i + 1;
257 }
258 }
259
260 if (pos != i) {
261 if (name == null) {
262 addParam(params, decodeComponent(s.substring(pos, i), charset), "");
263 } else {
264 addParam(params, name, decodeComponent(s.substring(pos, i), charset));
265 }
266 } else if (name != null) {
267 addParam(params, name, "");
268 }
269 }
270
271 private boolean addParam(Map<String, List<String>> params, String name, String value) {
272 if (nParams >= maxParams) {
273 return false;
274 }
275
276 List<String> values = params.get(name);
277 if (values == null) {
278 values = new ArrayList<String>(1);
279 params.put(name, values);
280 }
281 values.add(value);
282 nParams ++;
283 return true;
284 }
285
286
287
288
289
290
291
292
293
294
295
296
297 public static String decodeComponent(final String s) {
298 return decodeComponent(s, HttpConstants.DEFAULT_CHARSET);
299 }
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323 @SuppressWarnings("fallthrough")
324 public static String decodeComponent(final String s,
325 final Charset charset) {
326 if (s == null) {
327 return "";
328 }
329 final int size = s.length();
330 boolean modified = false;
331 for (int i = 0; i < size; i++) {
332 final char c = s.charAt(i);
333 switch (c) {
334 case '%':
335 i++;
336
337 case '+':
338 modified = true;
339 break;
340 }
341 }
342 if (!modified) {
343 return s;
344 }
345 final byte[] buf = new byte[size];
346 int pos = 0;
347 for (int i = 0; i < size; i++) {
348 char c = s.charAt(i);
349 switch (c) {
350 case '+':
351 buf[pos++] = ' ';
352 break;
353 case '%':
354 if (i == size - 1) {
355 throw new IllegalArgumentException("unterminated escape"
356 + " sequence at end of string: " + s);
357 }
358 c = s.charAt(++i);
359 if (c == '%') {
360 buf[pos++] = '%';
361 break;
362 }
363
364 if (i == size - 1) {
365 throw new IllegalArgumentException("partial escape"
366 + " sequence at end of string: " + s);
367 }
368 c = decodeHexNibble(c);
369 final char c2 = decodeHexNibble(s.charAt(++i));
370 if (c == Character.MAX_VALUE || c2 == Character.MAX_VALUE) {
371 throw new IllegalArgumentException(
372 "invalid escape sequence `%" + s.charAt(i - 1)
373 + s.charAt(i) + "' at index " + (i - 2)
374 + " of: " + s);
375 }
376 c = (char) (c * 16 + c2);
377
378 default:
379 buf[pos++] = (byte) c;
380 break;
381 }
382 }
383 try {
384 return new String(buf, 0, pos, charset.name());
385 } catch (UnsupportedEncodingException e) {
386 throw new IllegalArgumentException("unsupported encoding: " + charset.name(), e);
387 }
388 }
389
390
391
392
393
394
395
396
397 private static char decodeHexNibble(final char c) {
398 if ('0' <= c && c <= '9') {
399 return (char) (c - '0');
400 } else if ('a' <= c && c <= 'f') {
401 return (char) (c - 'a' + 10);
402 } else if ('A' <= c && c <= 'F') {
403 return (char) (c - 'A' + 10);
404 } else {
405 return Character.MAX_VALUE;
406 }
407 }
408 }