/**
* 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.
*/
package org.apache.cxf.jaxrs.utils;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URLEncoder;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;
import javax.ws.rs.ext.RuntimeDelegate;
import javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate;
import org.apache.cxf.common.i18n.BundleUtils;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.common.util.UrlUtils;
import org.apache.cxf.helpers.CastUtils;
import org.apache.cxf.jaxrs.impl.HttpHeadersImpl;
import org.apache.cxf.jaxrs.impl.MetadataMap;
import org.apache.cxf.jaxrs.impl.PathSegmentImpl;
import org.apache.cxf.jaxrs.impl.RuntimeDelegateImpl;
import org.apache.cxf.jaxrs.model.ParameterType;
import org.apache.cxf.message.Message;
import org.apache.cxf.service.model.EndpointInfo;
import org.apache.cxf.transport.Destination;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
import org.apache.cxf.transport.http.Headers;
import org.apache.cxf.transport.servlet.BaseUrlHelper;
public final class HttpUtils {
private static final ResourceBundle BUNDLE = BundleUtils.getBundle(HttpUtils.class);
private static final Logger LOG = LogUtils.getL7dLogger(HttpUtils.class);
private static final String REQUEST_PATH_TO_MATCH = "path_to_match";
private static final String REQUEST_PATH_TO_MATCH_SLASH = "path_to_match_slash";
private static final String HTTP_SCHEME = "http";
private static final String LOCAL_HOST_IP_ADDRESS = "127.0.0.1";
private static final String ANY_IP_ADDRESS = "0.0.0.0";
private static final int DEFAULT_HTTP_PORT = 80;
private static final Pattern ENCODE_PATTERN = Pattern.compile("%[0-9a-fA-F][0-9a-fA-F]");
private static final String CHARSET_PARAMETER = "charset";
// there are more of such characters, ex, '*' but '*' is not affected by UrlEncode
private static final String PATH_RESERVED_CHARACTERS = "=@/:!$&\'(),;~";
private static final String QUERY_RESERVED_CHARACTERS = "?/,";
private HttpUtils() {
}
public static String urlDecode(String value, String enc) {
return UrlUtils.urlDecode(value, enc);
}
public static String urlDecode(String value) {
return UrlUtils.urlDecode(value);
}
public static String pathDecode(String value) {
return UrlUtils.pathDecode(value);
}
private static String componentEncode(String reservedChars, String value) {
StringBuilder buffer = new StringBuilder();
StringBuilder bufferToEncode = new StringBuilder();
for (int i = 0; i < value.length(); i++) {
char currentChar = value.charAt(i);
if (reservedChars.indexOf(currentChar) != -1) {
if (bufferToEncode.length() > 0) {
buffer.append(urlEncode(bufferToEncode.toString()));
bufferToEncode.setLength(0);
}
buffer.append(currentChar);
} else {
bufferToEncode.append(currentChar);
}
}
if (bufferToEncode.length() > 0) {
buffer.append(urlEncode(bufferToEncode.toString()));
}
return buffer.toString();
}
public static String queryEncode(String value) {
return componentEncode(QUERY_RESERVED_CHARACTERS, value);
}
public static String urlEncode(String value) {
return urlEncode(value, "UTF-8");
}
public static String urlEncode(String value, String enc) {
try {
value = URLEncoder.encode(value, enc);
} catch (UnsupportedEncodingException ex) {
throw new RuntimeException(ex);
}
return value;
}
public static String pathEncode(String value) {
String result = componentEncode(PATH_RESERVED_CHARACTERS, value);
// URLEncoder will encode '+' to %2B but will turn ' ' into '+'
// We need to retain '+' and encode ' ' as %20
if (result.indexOf('+') != -1) {
result = result.replace("+", "%20");
}
if (result.indexOf("%2B") != -1) {
result = result.replace("%2B", "+");
}
return result;
}
public static boolean isPartiallyEncoded(String value) {
return ENCODE_PATTERN.matcher(value).find();
}
/**
* Encodes partially encoded string. Encode all values but those matching pattern
* "percent char followed by two hexadecimal digits".
*
* @param encoded fully or partially encoded string.
* @return fully encoded string
*/
public static String encodePartiallyEncoded(String encoded, boolean query) {
if (encoded.length() == 0) {
return encoded;
}
Matcher m = ENCODE_PATTERN.matcher(encoded);
StringBuilder sb = new StringBuilder();
int i = 0;
while (m.find()) {
String before = encoded.substring(i, m.start());
sb.append(query ? HttpUtils.queryEncode(before) : HttpUtils.pathEncode(before));
sb.append(m.group());
i = m.end();
}
String tail = encoded.substring(i, encoded.length());
sb.append(query ? HttpUtils.queryEncode(tail) : HttpUtils.pathEncode(tail));
return sb.toString();
}
public static SimpleDateFormat getHttpDateFormat() {
return Headers.getHttpDateFormat();
}
public static String toHttpDate(Date date) {
return Headers.toHttpDate(date);
}
public static RuntimeDelegate getOtherRuntimeDelegate() {
try {
RuntimeDelegate rd = RuntimeDelegate.getInstance();
return rd instanceof RuntimeDelegateImpl ? null : rd;
} catch (Throwable t) {
return null;
}
}
public static HeaderDelegate<Object> getHeaderDelegate(Object o) {
return getHeaderDelegate(getOtherRuntimeDelegate(), o);
}
@SuppressWarnings("unchecked")
public static HeaderDelegate<Object> getHeaderDelegate(RuntimeDelegate rd, Object o) {
return rd == null ? null : (HeaderDelegate<Object>)rd.createHeaderDelegate(o.getClass());
}
@SuppressWarnings("unchecked")
public static <T> MultivaluedMap<String, T> getModifiableStringHeaders(Message m) {
MultivaluedMap<String, Object> headers = getModifiableHeaders(m);
convertHeaderValuesToString(headers, false);
return (MultivaluedMap<String, T>)headers;
}
public static MultivaluedMap<String, Object> getModifiableHeaders(Message m) {
Map<String, List<Object>> headers = CastUtils.cast((Map<?, ?>)m.get(Message.PROTOCOL_HEADERS));
return new MetadataMap<String, Object>(headers, false, false, true);
}
public static void convertHeaderValuesToString(Map<String, List<Object>> headers, boolean delegateOnly) {
RuntimeDelegate rd = getOtherRuntimeDelegate();
if (rd == null && delegateOnly) {
return;
}
for (Map.Entry<String, List<Object>> entry : headers.entrySet()) {
List<Object> values = entry.getValue();
for (int i = 0; i < values.size(); i++) {
Object value = values.get(i);
if (value != null && !(value instanceof String)) {
HeaderDelegate<Object> hd = getHeaderDelegate(rd, value);
if (hd != null) {
value = hd.toString(value);
} else if (!delegateOnly) {
value = value.toString();
}
try {
values.set(i, value);
} catch (UnsupportedOperationException ex) {
// this may happen if an unmodifiable List was set via Map put
List<Object> newList = new ArrayList<Object>(values);
newList.set(i, value);
// Won't help if the map is unmodifiable in which case it is a bug anyway
headers.put(entry.getKey(), newList);
}
}
}
}
}
public static Date getHttpDate(String value) {
if (value == null) {
return null;
}
try {
return Headers.getHttpDateFormat().parse(value);
} catch (ParseException ex) {
return null;
}
}
public static Locale getLocale(String value) {
if (value == null) {
return null;
}
String[] values = StringUtils.split(value, "-");
if (values.length == 0 || values.length > 2) {
throw new IllegalArgumentException("Illegal locale value : " + value);
}
if (values.length == 1) {
return new Locale(values[0]);
} else {
return new Locale(values[0], values[1]);
}
}
public static int getContentLength(String value) {
if (value == null) {
return -1;
}
try {
int len = Integer.valueOf(value);
return len >= 0 ? len : -1;
} catch (Exception ex) {
return -1;
}
}
public static String getHeaderString(List<String> values) {
if (values == null) {
return null;
} else {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < values.size(); i++) {
String value = values.get(i);
if (StringUtils.isEmpty(value)) {
continue;
}
sb.append(value);
if (i + 1 < values.size()) {
sb.append(",");
}
}
return sb.toString();
}
}
public static boolean isDateRelatedHeader(String headerName) {
return HttpHeaders.DATE.equalsIgnoreCase(headerName)
|| HttpHeaders.IF_MODIFIED_SINCE.equalsIgnoreCase(headerName)
|| HttpHeaders.IF_UNMODIFIED_SINCE.equalsIgnoreCase(headerName)
|| HttpHeaders.EXPIRES.equalsIgnoreCase(headerName)
|| HttpHeaders.LAST_MODIFIED.equalsIgnoreCase(headerName);
}
public static boolean isHttpRequest(Message message) {
return message.get(AbstractHTTPDestination.HTTP_REQUEST) != null;
}
public static URI toAbsoluteUri(String relativePath, Message message) {
String base = BaseUrlHelper.getBaseURL(
(HttpServletRequest)message.get(AbstractHTTPDestination.HTTP_REQUEST));
return URI.create(base + relativePath);
}
public static URI toAbsoluteUri(URI u, Message message) {
HttpServletRequest request =
(HttpServletRequest)message.get(AbstractHTTPDestination.HTTP_REQUEST);
boolean absolute = u.isAbsolute();
if (request != null && (!absolute || isLocalHostOrAnyIpAddress(u))) {
String serverAndPort = request.getServerName();
boolean localAddressUsed = false;
if (absolute) {
if (ANY_IP_ADDRESS.equals(serverAndPort)) {
serverAndPort = request.getLocalAddr();
localAddressUsed = true;
}
if (LOCAL_HOST_IP_ADDRESS.equals(serverAndPort)) {
serverAndPort = "localhost";
localAddressUsed = true;
}
}
int port = localAddressUsed ? request.getLocalPort() : request.getServerPort();
if (port != DEFAULT_HTTP_PORT) {
serverAndPort += ":" + port;
}
String base = request.getScheme() + "://" + serverAndPort;
if (!absolute) {
u = URI.create(base + u.toString());
} else {
int originalPort = u.getPort();
String hostValue = u.getHost().equals(ANY_IP_ADDRESS)
? ANY_IP_ADDRESS : LOCAL_HOST_IP_ADDRESS;
String replaceValue = originalPort == -1 ? hostValue : hostValue + ":" + originalPort;
u = URI.create(u.toString().replace(replaceValue, serverAndPort));
}
}
return u;
}
private static boolean isLocalHostOrAnyIpAddress(URI u) {
String host = u.getHost();
return host != null && (LOCAL_HOST_IP_ADDRESS.equals(host)) || ANY_IP_ADDRESS.equals(host);
}
public static void resetRequestURI(Message m, String requestURI) {
m.remove(REQUEST_PATH_TO_MATCH_SLASH);
m.remove(REQUEST_PATH_TO_MATCH);
m.put(Message.REQUEST_URI, requestURI);
}
public static String getPathToMatch(Message m, boolean addSlash) {
String var = addSlash ? REQUEST_PATH_TO_MATCH_SLASH : REQUEST_PATH_TO_MATCH;
String pathToMatch = (String)m.get(var);
if (pathToMatch != null) {
return pathToMatch;
}
String requestAddress = getProtocolHeader(m, Message.REQUEST_URI, "/");
if (m.get(Message.QUERY_STRING) == null) {
int index = requestAddress.lastIndexOf('?');
if (index > 0 && index < requestAddress.length()) {
m.put(Message.QUERY_STRING, requestAddress.substring(index + 1));
requestAddress = requestAddress.substring(0, index);
}
}
String baseAddress = getBaseAddress(m);
pathToMatch = getPathToMatch(requestAddress, baseAddress, addSlash);
m.put(var, pathToMatch);
return pathToMatch;
}
public static String getProtocolHeader(Message m, String name, String defaultValue) {
return getProtocolHeader(m, name, defaultValue, false);
}
public static String getProtocolHeader(Message m, String name, String defaultValue, boolean setOnMessage) {
String value = (String)m.get(name);
if (value == null) {
value = new HttpHeadersImpl(m).getRequestHeaders().getFirst(name);
if (value != null && setOnMessage) {
m.put(name, value);
}
}
return value == null ? defaultValue : value;
}
public static String getBaseAddress(Message m) {
String endpointAddress = getEndpointAddress(m);
try {
URI uri = new URI(endpointAddress);
String path = uri.getRawPath();
String scheme = uri.getScheme();
if (scheme != null && !scheme.startsWith(HttpUtils.HTTP_SCHEME)
&& HttpUtils.isHttpRequest(m)) {
path = HttpUtils.toAbsoluteUri(path, m).getRawPath();
}
return (path == null || path.length() == 0) ? "/" : path;
} catch (URISyntaxException ex) {
return endpointAddress == null ? "/" : endpointAddress;
}
}
public static String getEndpointAddress(Message m) {
String address = null;
Destination d = m.getExchange().getDestination();
if (d != null) {
if (d instanceof AbstractHTTPDestination) {
EndpointInfo ei = ((AbstractHTTPDestination)d).getEndpointInfo();
HttpServletRequest request = (HttpServletRequest)m.get(AbstractHTTPDestination.HTTP_REQUEST);
Object property = request != null
? request.getAttribute("org.apache.cxf.transport.endpoint.address") : null;
address = property != null ? property.toString() : ei.getAddress();
} else {
address = m.containsKey(Message.BASE_PATH)
? (String)m.get(Message.BASE_PATH) : d.getAddress().getAddress().getValue();
}
} else {
address = (String)m.get(Message.ENDPOINT_ADDRESS);
}
if (address.startsWith("http") && address.endsWith("//")) {
address = address.substring(0, address.length() - 1);
}
return address;
}
public static void updatePath(Message m, String path) {
String baseAddress = getBaseAddress(m);
boolean pathSlash = path.startsWith("/");
boolean baseSlash = baseAddress.endsWith("/");
if (pathSlash && baseSlash) {
path = path.substring(1);
} else if (!pathSlash && !baseSlash) {
path = "/" + path;
}
m.put(Message.REQUEST_URI, baseAddress + path);
m.remove(REQUEST_PATH_TO_MATCH);
m.remove(REQUEST_PATH_TO_MATCH_SLASH);
}
public static String getPathToMatch(String path, String address, boolean addSlash) {
int ind = path.indexOf(address);
if (ind == -1 && address.equals(path + "/")) {
path += "/";
ind = 0;
}
if (ind == 0) {
path = path.substring(ind + address.length());
}
if (addSlash && !path.startsWith("/")) {
path = "/" + path;
}
return path;
}
public static String getOriginalAddress(Message m) {
Destination d = m.getDestination();
return d == null ? "/" : d.getAddress().getAddress().getValue();
}
public static String fromPathSegment(PathSegment ps) {
if (PathSegmentImpl.class.isAssignableFrom(ps.getClass())) {
return ((PathSegmentImpl)ps).getOriginalPath();
}
StringBuilder sb = new StringBuilder();
sb.append(ps.getPath());
for (Map.Entry<String, List<String>> entry : ps.getMatrixParameters().entrySet()) {
for (String value : entry.getValue()) {
sb.append(';').append(entry.getKey());
if (value != null) {
sb.append('=').append(value);
}
}
}
return sb.toString();
}
public static Response.Status getParameterFailureStatus(ParameterType pType) {
if (pType == ParameterType.MATRIX || pType == ParameterType.PATH
|| pType == ParameterType.QUERY) {
return Response.Status.NOT_FOUND;
}
return Response.Status.BAD_REQUEST;
}
public static String getSetEncoding(MediaType mt, MultivaluedMap<String, Object> headers,
String defaultEncoding) {
String enc = mt.getParameters().get(CHARSET_PARAMETER);
if (enc == null) {
return defaultEncoding;
}
try {
"0".getBytes(enc);
return enc;
} catch (UnsupportedEncodingException ex) {
String message = new org.apache.cxf.common.i18n.Message("UNSUPPORTED_ENCODING",
BUNDLE, enc, defaultEncoding).toString();
LOG.warning(message);
headers.putSingle(HttpHeaders.CONTENT_TYPE,
JAXRSUtils.mediaTypeToString(mt, CHARSET_PARAMETER)
+ ';' + CHARSET_PARAMETER + "="
+ (defaultEncoding == null ? "UTF-8" : defaultEncoding));
}
return defaultEncoding;
}
public static String getEncoding(MediaType mt, String defaultEncoding) {
String charset = mt == null ? defaultEncoding : mt.getParameters().get("charset");
return charset == null ? defaultEncoding : charset;
}
public static URI resolve(UriBuilder baseBuilder, URI uri) {
if (!uri.isAbsolute()) {
return baseBuilder.build().resolve(uri);
}
return uri;
}
public static URI relativize(URI base, URI uri) {
// quick bail-out
if (!(base.isAbsolute()) || !(uri.isAbsolute())) {
return uri;
}
if (base.isOpaque() || uri.isOpaque()) {
// Unlikely case of an URN which can't deal with
// relative path, such as urn:isbn:0451450523
return uri;
}
// Check for common root
URI root = base.resolve("/");
if (!(root.equals(uri.resolve("/")))) {
// Different protocol/auth/host/port, return as is
return uri;
}
// Ignore hostname bits for the following , but add "/" in the beginning
// so that in worst case we'll still return "/fred" rather than
// "http://example.com/fred".
URI baseRel = URI.create("/").resolve(root.relativize(base));
URI uriRel = URI.create("/").resolve(root.relativize(uri));
// Is it same path?
if (baseRel.getPath().equals(uriRel.getPath())) {
return baseRel.relativize(uriRel);
}
// Direct siblings? (ie. in same folder)
URI commonBase = baseRel.resolve("./");
if (commonBase.equals(uriRel.resolve("./"))) {
return commonBase.relativize(uriRel);
}
// No, then just keep climbing up until we find a common base.
URI relative = URI.create("");
while (!(uriRel.getPath().startsWith(commonBase.getPath())) && !(commonBase.getPath().equals("/"))) {
commonBase = commonBase.resolve("../");
relative = relative.resolve("../");
}
// Now we can use URI.relativize
URI relToCommon = commonBase.relativize(uriRel);
// and prepend the needed ../
return relative.resolve(relToCommon);
}
public static String toHttpLanguage(Locale locale) {
return Headers.toHttpLanguage(locale);
}
}