forked from OpenFeign/feign
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUriUtils.java
More file actions
222 lines (196 loc) · 6.66 KB
/
Copy pathUriUtils.java
File metadata and controls
222 lines (196 loc) · 6.66 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/**
* Copyright 2012-2018 The Feign Authors
*
* 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 feign.template;
import feign.Util;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URL;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.nio.charset.Charset;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class UriUtils {
private static final String QUERY_RESERVED_CHARACTERS = "?/,=";
private static final String PATH_RESERVED_CHARACTERS = "/=@:!$&\'(),;~";
private static final Pattern PCT_ENCODED_PATTERN = Pattern.compile("%[0-9A-Fa-f][0-9A-Fa-f]");
/**
* Determines if the value is already pct-encoded.
*
* @param value to check.
* @return {@literal true} if the value is already pct-encoded
*/
public static boolean isEncoded(String value) {
return PCT_ENCODED_PATTERN.matcher(value).matches();
}
/**
* Uri Encode the value, using the default Charset. Already encoded values are skipped.
*
* @param value to encode.
* @return the encoded value.
*/
public static String encode(String value) {
return encodeReserved(value, "", Util.UTF_8);
}
/**
* Uri Encode the value. Already encoded values are skipped.
*
* @param value to encode.
* @param charset to use.
* @return the encoded value.
*/
public static String encode(String value, Charset charset) {
return encodeReserved(value, "", charset);
}
/**
* Uri Decode the value.
*
* @param value to decode
* @param charset to use.
* @return the decoded value.
*/
public static String decode(String value, Charset charset) {
try {
/* there is nothing special between uri and url decoding */
return URLDecoder.decode(value, charset.name());
} catch (UnsupportedEncodingException uee) {
/* since the encoding is not supported, return the original value */
return value;
}
}
/**
* Uri Encode a Path Fragment.
*
* @param path containing the path fragment.
* @param charset to use.
* @return the encoded path fragment.
*/
public static String pathEncode(String path, Charset charset) {
return encodeReserved(path, PATH_RESERVED_CHARACTERS, charset);
}
/**
* Uri Encode a Query Fragment.
*
* @param query containing the query fragment
* @param charset to use.
* @return the encoded query fragment.
*/
public static String queryEncode(String query, Charset charset) {
return encodeReserved(query, QUERY_RESERVED_CHARACTERS, charset);
}
/**
* Determines if the provided uri is an absolute uri.
*
* @param uri to evaluate.
* @return true if the uri is absolute.
*/
public static boolean isAbsolute(String uri) {
return uri != null && !uri.isEmpty() && uri.startsWith("http");
}
/**
* Uri Encode a String using the provided charset.
*
* @param value to encode.
* @param charset to use.
* @return the encoded value.
*/
private static String urlEncode(String value, Charset charset) {
try {
String encoded = URLEncoder.encode(value, charset.toString());
/*
* url encoding is not equivalent to URI encoding, there are few differences, namely dealing
* with spaces, !, ', (, ), and ~ characters. we will need to manually process those values.
*/
return encoded.replaceAll("\\+", "%20")
.replaceAll("\\%21", "!")
.replaceAll("\\%27", "'")
.replaceAll("\\%28", "(")
.replaceAll("\\%29", ")")
.replaceAll("\\%7E", "~")
.replaceAll("\\%2B", "+");
} catch (UnsupportedEncodingException uee) {
/* since the encoding is not supported, return the original value */
return value;
}
}
/**
* Encodes the value, preserving all reserved characters.. Values that are already pct-encoded are
* ignored.
*
* @param value inspect.
* @param reserved characters to preserve.
* @param charset to use.
* @return a new String with the reserved characters preserved.
*/
public static String encodeReserved(String value, String reserved, Charset charset) {
/* value is encoded, we need to split it up and skip the parts that are already encoded */
Matcher matcher = PCT_ENCODED_PATTERN.matcher(value);
if (!matcher.find()) {
return encodeChunk(value, reserved, charset);
}
int length = value.length();
StringBuilder encoded = new StringBuilder(length + 8);
int index = 0;
do {
/* split out the value before the encoded value */
String before = value.substring(index, matcher.start());
/* encode it */
encoded.append(encodeChunk(before, reserved, charset));
/* append the encoded value */
encoded.append(matcher.group());
/* update the string search index */
index = matcher.end();
} while (matcher.find());
/* append the rest of the string */
String tail = value.substring(index, length);
encoded.append(encodeChunk(tail, reserved, charset));
return encoded.toString();
}
/**
* Encode a Uri Chunk, ensuring that all reserved characters are also encoded.
*
* @param value to encode.
* @param reserved characters to evaluate.
* @param charset to use.
* @return an encoded uri chunk.
*/
private static String encodeChunk(String value, String reserved, Charset charset) {
StringBuilder encoded = null;
int length = value.length();
int index = 0;
for (int i = 0; i < length; i++) {
char character = value.charAt(i);
if (reserved.indexOf(character) != -1) {
if (encoded == null) {
encoded = new StringBuilder(length + 8);
}
if (i != index) {
/* we are in the middle of the value, so we need to encode mid string */
encoded.append(urlEncode(value.substring(index, i), charset));
}
encoded.append(character);
index = i + 1;
}
}
/* if there are no reserved characters, encode the original value */
if (encoded == null) {
return urlEncode(value, charset);
}
/* encode the rest of the string */
if (index < length) {
encoded.append(urlEncode(value.substring(index, length), charset));
}
return encoded.toString();
}
}