com.landawn.abacus.util.URLEncodedUtil Maven / Gradle / Ivy
Show all versions of abacus-common Show documentation
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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
*
* 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* Note: it's copied from Apache HttpComponents developed at The Apache Software Foundation (http://www.apache.org/), or
* under the Apache License 2.0. The methods copied from other products/frameworks may be modified in this class.
*
*
* A collection of utilities for encoding URLs.
*
* @since 4.0
*/
public final class URLEncodedUtil {
public static final char QP_SEP_A = '&';
public static final char QP_SEP_S = ';';
public static final String NAME_VALUE_SEPARATOR = "=";
/**
* urlQuery parameter separators.
*/
private static final char[] QP_SEPS = { QP_SEP_A, QP_SEP_S };
/**
* urlQuery parameter separator pattern.
*/
private static final String QP_SEP_PATTERN = "[" + new String(QP_SEPS) + "]";
/**
* Unreserved characters, i.e. alphanumeric, plus: {@code _ - ! . ~ ' ( ) *}
*
* This list is the same as the {@code unreserved} list in RFC
* 2396
*/
private static final BitSet UNRESERVED = new BitSet(256);
/**
* Punctuation characters: , ; : $ & + =
*
* These are the additional characters allowed by userinfo.
*/
private static final BitSet PUNCT = new BitSet(256);
/**
* Characters which are safe to use in userinfo, i.e. {@link #UNRESERVED} plus {@link #PUNCT}uation
*/
private static final BitSet USERINFO = new BitSet(256);
/**
* Characters which are safe to use in a path, i.e. {@link #UNRESERVED} plus {@link #PUNCT}uation plus / @
*/
private static final BitSet PATHSAFE = new BitSet(256);
/**
* Characters which are safe to use in a urlQuery or a fragment, i.e. {@link #RESERVED} plus {@link #UNRESERVED}
*/
private static final BitSet URIC = new BitSet(256);
/**
* Reserved characters, i.e. {@code ;/?:@&=+$,[]}
*
* This list is the same as the {@code reserved} list in RFC 2396
* as augmented by RFC 2732
*/
private static final BitSet RESERVED = new BitSet(256);
/**
* Safe characters for x-www-form-urlencoded data, as per java.net.URLEncoder and browser behaviour, i.e.
* alphanumeric plus {@code "-", "_", ".", "*"}
*/
private static final BitSet URLENCODER = new BitSet(256);
static {
// unreserved chars
// alpha characters
for (int i = 'a'; i <= 'z'; i++) {
UNRESERVED.set(i);
}
for (int i = 'A'; i <= 'Z'; i++) {
UNRESERVED.set(i);
}
// numeric characters
for (int i = '0'; i <= '9'; i++) {
UNRESERVED.set(i);
}
UNRESERVED.set('_'); // these are the charactes of the "mark" list
UNRESERVED.set('-');
UNRESERVED.set('.');
UNRESERVED.set('*');
URLENCODER.or(UNRESERVED); // skip remaining unreserved characters
UNRESERVED.set('!');
UNRESERVED.set('~');
UNRESERVED.set('\'');
UNRESERVED.set('(');
UNRESERVED.set(')');
// punct chars
PUNCT.set(',');
PUNCT.set(';');
PUNCT.set(':');
PUNCT.set('$');
PUNCT.set('&');
PUNCT.set('+');
PUNCT.set('=');
// Safe for userinfo
USERINFO.or(UNRESERVED);
USERINFO.or(PUNCT);
// URL path safe
PATHSAFE.or(UNRESERVED);
PATHSAFE.set('/'); // segment separator
PATHSAFE.set(';'); // param separator
PATHSAFE.set(':'); // rest as per list in 2396, i.e. : @ & = + $ ,
PATHSAFE.set('@');
PATHSAFE.set('&');
PATHSAFE.set('=');
PATHSAFE.set('+');
PATHSAFE.set('$');
PATHSAFE.set(',');
RESERVED.set(';');
RESERVED.set('/');
RESERVED.set('?');
RESERVED.set(':');
RESERVED.set('@');
RESERVED.set('&');
RESERVED.set('=');
RESERVED.set('+');
RESERVED.set('$');
RESERVED.set(',');
RESERVED.set('['); // added by RFC 2732
RESERVED.set(']'); // added by RFC 2732
URIC.or(RESERVED);
URIC.or(UNRESERVED);
}
private static final int RADIX = 16;
private URLEncodedUtil() {
// singleton.
}
/**
*
* @param urlQuery
* @return
*/
public static Map decode(final String urlQuery) {
return decode(urlQuery, Charsets.UTF_8);
}
/**
*
* @param urlQuery
* @param charset
* @return
*/
public static Map decode(final String urlQuery, final Charset charset) {
final Map result = new LinkedHashMap<>();
if (N.isNullOrEmpty(urlQuery)) {
return result;
}
try (final Scanner scanner = new Scanner(urlQuery)) {
scanner.useDelimiter(QP_SEP_PATTERN);
String name = null;
String value = null;
while (scanner.hasNext()) {
final String token = scanner.next();
final int i = token.indexOf(NAME_VALUE_SEPARATOR);
if (i != -1) {
name = decodeFormFields(token.substring(0, i).trim(), charset);
value = decodeFormFields(token.substring(i + 1).trim(), charset);
} else {
name = decodeFormFields(token.trim(), charset);
value = null;
}
result.put(name, value);
}
}
return result;
}
/**
*
* @param
* @param targetClass
* @param urlQuery
* @return
*/
public static T decode(final Class targetClass, final String urlQuery) {
return decode(targetClass, urlQuery, Charsets.UTF_8);
}
/**
*
* @param
* @param targetClass
* @param urlQuery
* @param charset
* @return
*/
public static T decode(final Class targetClass, final String urlQuery, final Charset charset) {
final EntityInfo entityInfo = ParserUtil.getEntityInfo(targetClass);
final Object result = entityInfo.createEntityResult();
if (N.isNullOrEmpty(urlQuery)) {
return (T) entityInfo.finishEntityResult(result);
}
try (final Scanner scanner = new Scanner(urlQuery)) {
scanner.useDelimiter(QP_SEP_PATTERN);
PropInfo propInfo = null;
Object propValue = null;
String name = null;
String value = null;
while (scanner.hasNext()) {
final String token = scanner.next();
final int i = token.indexOf(NAME_VALUE_SEPARATOR);
if (i != -1) {
name = decodeFormFields(token.substring(0, i).trim(), charset);
value = decodeFormFields(token.substring(i + 1).trim(), charset);
} else {
name = decodeFormFields(token.trim(), charset);
value = null;
}
propInfo = entityInfo.getPropInfo(name);
if (value == null) {
propValue = propInfo.jsonXmlType.defaultValue();
} else {
propValue = propInfo.readPropValue(value);
}
entityInfo.setPropValue(result, name, propValue);
}
}
return (T) entityInfo.finishEntityResult(result);
}
/**
* Parameters 2 entity.
*
* @param
* @param targetClass
* @param parameters
* @return
*/
public static T parameters2Entity(final Class targetClass, final Map parameters) {
final EntityInfo entityInfo = ParserUtil.getEntityInfo(targetClass);
final Object result = entityInfo.createEntityResult();
if (N.isNullOrEmpty(parameters)) {
return (T) entityInfo.finishEntityResult(result);
}
PropInfo propInfo = null;
Object propValue = null;
String[] values = null;
for (String key : parameters.keySet()) {
propInfo = entityInfo.getPropInfo(key);
values = parameters.get(key);
if (N.isNullOrEmpty(values) || (values.length == 1 && N.isNullOrEmpty(values[0]))) {
propValue = propInfo.jsonXmlType.defaultValue();
} else {
if (propInfo.jsonXmlType.clazz().equals(String[].class)) {
propValue = values;
} else {
propValue = propInfo.readPropValue(StringUtil.join(values, ", "));
}
}
propInfo.setPropValue(result, propValue);
}
return (T) entityInfo.finishEntityResult(result);
}
/**
*
* @param parameters
* @return
*/
public static String encode(final Object parameters) {
return encode(parameters, Charsets.UTF_8);
}
/**
*
* @param parameters
* @param charset
* @return
*/
public static String encode(final Object parameters, final Charset charset) {
return encode(parameters, charset, NamingPolicy.LOWER_CAMEL_CASE);
}
/**
*
* @param parameters
* @param charset
* @param namingPolicy
* @return
*/
public static String encode(final Object parameters, final Charset charset, final NamingPolicy namingPolicy) {
final StringBuilder sb = Objectory.createStringBuilder();
try {
encode(sb, parameters, charset, namingPolicy);
return sb.toString();
} finally {
Objectory.recycle(sb);
}
}
/**
*
* @param url
* @param parameters
* @return
*/
public static String encode(final String url, final Object parameters) {
return encode(url, parameters, Charsets.UTF_8);
}
/**
*
* @param url
* @param parameters
* @param charset
* @return
*/
public static String encode(final String url, final Object parameters, final Charset charset) {
return encode(url, parameters, charset, NamingPolicy.LOWER_CAMEL_CASE);
}
/**
*
* @param url
* @param parameters
* @param charset
* @param namingPolicy
* @return
*/
@SuppressWarnings("rawtypes")
public static String encode(final String url, final Object parameters, final Charset charset, final NamingPolicy namingPolicy) {
if (parameters == null || (parameters instanceof Map && ((Map) parameters).isEmpty())) {
return url;
}
final StringBuilder sb = Objectory.createStringBuilder();
try {
sb.append(url);
sb.append(WD._QUESTION_MARK);
encode(sb, parameters, charset, namingPolicy);
return sb.toString();
} finally {
Objectory.recycle(sb);
}
}
/**
*
* @param output
* @param parameters
*/
public static void encode(final StringBuilder output, final Object parameters) {
encode(output, parameters, Charsets.UTF_8);
}
/**
*
* @param output
* @param parameters
* @param charset
*/
public static void encode(final StringBuilder output, final Object parameters, final Charset charset) {
encode(output, parameters, charset, NamingPolicy.LOWER_CAMEL_CASE);
}
/**
*
* @param output
* @param parameters
* @param charset
*/
@SuppressWarnings("rawtypes")
public static void encode(final StringBuilder output, final Object parameters, final Charset charset, final NamingPolicy namingPolicy) {
if (parameters == null || (parameters instanceof Map && ((Map) parameters).isEmpty())) {
return;
}
final boolean isNoChange = namingPolicy == null || namingPolicy == NamingPolicy.NO_CHANGE;
if (parameters instanceof Map) {
final Map map = (Map) parameters;
int i = 0;
for (Map.Entry entry : map.entrySet()) {
if (i++ > 0) {
output.append(QP_SEP_A);
}
if (isNoChange) {
encodeFormFields(output, entry.getKey(), charset);
} else {
encodeFormFields(output, namingPolicy.convert(entry.getKey()), charset);
}
output.append(NAME_VALUE_SEPARATOR);
encodeFormFields(output, N.stringOf(entry.getValue()), charset);
}
} else if (ClassUtil.isEntity(parameters.getClass())) {
encode(output, Maps.entity2Map(parameters, true, null, namingPolicy), charset, NamingPolicy.NO_CHANGE);
} else if (parameters instanceof Object[] a) {
if (0 != (a.length % 2)) {
throw new IllegalArgumentException(
"The parameters must be the pairs of property name and value, or Map, or an entity class with getter/setter methods.");
}
for (int i = 0, len = a.length; i < len; i++) {
if (i > 0) {
output.append(QP_SEP_A);
}
if (isNoChange) {
encodeFormFields(output, (String) a[i], charset);
} else {
encodeFormFields(output, namingPolicy.convert((String) a[i]), charset);
}
output.append(NAME_VALUE_SEPARATOR);
encodeFormFields(output, N.stringOf(a[++i]), charset);
}
} else {
encodeFormFields(output, N.stringOf(parameters), charset);
}
}
/**
* Decode/unescape www-url-form-encoded content.
*
* @param content
* the content to decode, will decode '+' as space
* @param charset
* the charset to use
* @return encoded string
*/
private static String decodeFormFields(final String content, final Charset charset) {
if (content == null) {
return null;
}
return urlDecode(content, (charset != null) ? charset : Charsets.UTF_8, true);
}
/**
* Decode/unescape a portion of a URL, to use with the urlQuery part ensure {@code plusAsBlank} is true.
*
* @param content
* the portion to decode
* @param charset
* the charset to use
* @param plusAsBlank
* if {@code true}, then convert '+' to space (e.g. for www-url-form-encoded content), otherwise leave as
* is.
* @return encoded string
*/
private static String urlDecode(final String content, final Charset charset, final boolean plusAsBlank) {
if (content == null) {
return null;
}
final ByteBuffer bb = ByteBuffer.allocate(content.length());
final CharBuffer cb = CharBuffer.wrap(content);
while (cb.hasRemaining()) {
final char c = cb.get();
if ((c == '%') && (cb.remaining() >= 2)) {
final char uc = cb.get();
final char lc = cb.get();
final int u = Character.digit(uc, 16);
final int l = Character.digit(lc, 16);
if ((u != -1) && (l != -1)) {
bb.put((byte) ((u << 4) + l));
} else {
bb.put((byte) '%');
bb.put((byte) uc);
bb.put((byte) lc);
}
} else if (plusAsBlank && (c == '+')) {
bb.put((byte) ' ');
} else {
bb.put((byte) c);
}
}
bb.flip();
return charset.decode(bb).toString();
}
/**
* Encode/escape www-url-form-encoded content.
*
* Uses the {@link #URLENCODER} set of characters, rather than the {@link #UNRSERVED} set; this is for compatibilty
* with previous releases, URLEncoder.encode() and most browsers.
*
* @param sb
* @param content the content to encode, will convert space to '+'
* @param charset the charset to use
* @return encoded string
*/
private static void encodeFormFields(final StringBuilder sb, final String content, final Charset charset) {
urlEncode(sb, content, (charset != null) ? charset : Charsets.UTF_8, URLENCODER, true);
}
/**
*
* @param sb
* @param content
* @param charset
* @param safechars
* @param blankAsPlus
*/
private static void urlEncode(final StringBuilder sb, final String content, final Charset charset, final BitSet safechars, final boolean blankAsPlus) {
if (content == null) {
sb.append(N.NULL_STRING);
return;
}
final ByteBuffer bb = charset.encode(content);
while (bb.hasRemaining()) {
final int b = bb.get() & 0xff;
if (safechars.get(b)) {
sb.append((char) b);
} else if (blankAsPlus && (b == ' ')) {
sb.append('+');
} else {
sb.append('%');
final char hex1 = Character.toUpperCase(Character.forDigit((b >> 4) & 0xF, RADIX));
final char hex2 = Character.toUpperCase(Character.forDigit(b & 0xF, RADIX));
sb.append(hex1);
sb.append(hex2);
}
}
}
/**
* Encode a String using the {@link #USERINFO} set of characters.
*
* Used by URIBuilder to encode the userinfo segment.
*
* @param sb
* @param content the string to encode, does not convert space to '+'
* @param charset the charset to use
* @return
*/
static void encUserInfo(final StringBuilder sb, final String content, final Charset charset) {
urlEncode(sb, content, charset, USERINFO, false);
}
/**
* Encode a String using the {@link #URIC} set of characters.
*
* Used by URIBuilder to encode the urlQuery and fragment segments.
*
* @param sb
* @param content the string to encode, does not convert space to '+'
* @param charset the charset to use
* @return
*/
static void encUric(final StringBuilder sb, final String content, final Charset charset) {
urlEncode(sb, content, charset, URIC, false);
}
/**
* Encode a String using the {@link #PATHSAFE} set of characters.
*
* Used by URIBuilder to encode path segments.
*
* @param sb
* @param content the string to encode, does not convert space to '+'
* @param charset the charset to use
* @return
*/
static void encPath(final StringBuilder sb, final String content, final Charset charset) {
urlEncode(sb, content, charset, PATHSAFE, false);
}
}