/* * Copyright 2002-2017 the original author or 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 org.springframework.web.util; import java.io.ByteArrayOutputStream; import java.io.Serializable; import java.net.URI; import java.net.URISyntaxException; import java.nio.charset.Charset; import java.util.ArrayList; import java.util.Arrays; import java.util.Collections; import java.util.Iterator; import java.util.List; import java.util.Map; import org.springframework.util.Assert; import org.springframework.util.CollectionUtils; import org.springframework.util.LinkedMultiValueMap; import org.springframework.util.MultiValueMap; import org.springframework.util.ObjectUtils; import org.springframework.util.StringUtils; /** * Extension of {@link UriComponents} for hierarchical URIs. * * @author Arjen Poutsma * @author Juergen Hoeller * @author Rossen Stoyanchev * @author Phillip Webb * @since 3.1.3 * @see <a href="http://tools.ietf.org/html/rfc3986#section-1.2.3">Hierarchical URIs</a> */ @SuppressWarnings("serial") final class HierarchicalUriComponents extends UriComponents { private static final char PATH_DELIMITER = '/'; private static final String PATH_DELIMITER_STRING = "/"; private final String userInfo; private final String host; private final String port; private final PathComponent path; private final MultiValueMap<String, String> queryParams; private final boolean encoded; /** * Package-private constructor. All arguments are optional, and can be {@code null}. * @param scheme the scheme * @param userInfo the user info * @param host the host * @param port the port * @param path the path * @param queryParams the query parameters * @param fragment the fragment * @param encoded whether the components are already encoded * @param verify whether the components need to be checked for illegal characters */ HierarchicalUriComponents(String scheme, String userInfo, String host, String port, PathComponent path, MultiValueMap<String, String> queryParams, String fragment, boolean encoded, boolean verify) { super(scheme, fragment); this.userInfo = userInfo; this.host = host; this.port = port; this.path = path != null ? path : NULL_PATH_COMPONENT; this.queryParams = CollectionUtils.unmodifiableMultiValueMap( queryParams != null ? queryParams : new LinkedMultiValueMap<>(0)); this.encoded = encoded; if (verify) { verify(); } } // Component getters @Override public String getSchemeSpecificPart() { return null; } @Override public String getUserInfo() { return this.userInfo; } @Override public String getHost() { return this.host; } @Override public int getPort() { if (this.port == null) { return -1; } else if (this.port.contains("{")) { throw new IllegalStateException( "The port contains a URI variable but has not been expanded yet: " + this.port); } return Integer.parseInt(this.port); } @Override public String getPath() { return this.path.getPath(); } @Override public List<String> getPathSegments() { return this.path.getPathSegments(); } @Override public String getQuery() { if (!this.queryParams.isEmpty()) { StringBuilder queryBuilder = new StringBuilder(); for (Map.Entry<String, List<String>> entry : this.queryParams.entrySet()) { String name = entry.getKey(); List<String> values = entry.getValue(); if (CollectionUtils.isEmpty(values)) { if (queryBuilder.length() != 0) { queryBuilder.append('&'); } queryBuilder.append(name); } else { for (Object value : values) { if (queryBuilder.length() != 0) { queryBuilder.append('&'); } queryBuilder.append(name); if (value != null) { queryBuilder.append('='); queryBuilder.append(value.toString()); } } } } return queryBuilder.toString(); } else { return null; } } /** * Return the map of query parameters. Empty if no query has been set. */ @Override public MultiValueMap<String, String> getQueryParams() { return this.queryParams; } // Encoding /** * Encode all URI components using their specific encoding rules and return * the result as a new {@code UriComponents} instance. * @param charset the encoding of the values * @return the encoded URI components */ @Override public HierarchicalUriComponents encode(Charset charset) { if (this.encoded) { return this; } String schemeTo = encodeUriComponent(getScheme(), charset, Type.SCHEME); String userInfoTo = encodeUriComponent(this.userInfo, charset, Type.USER_INFO); String hostTo = encodeUriComponent(this.host, charset, getHostType()); PathComponent pathTo = this.path.encode(charset); MultiValueMap<String, String> paramsTo = encodeQueryParams(charset); String fragmentTo = encodeUriComponent(getFragment(), charset, Type.FRAGMENT); return new HierarchicalUriComponents(schemeTo, userInfoTo, hostTo, this.port, pathTo, paramsTo, fragmentTo, true, false); } private MultiValueMap<String, String> encodeQueryParams(Charset charset) { int size = this.queryParams.size(); MultiValueMap<String, String> result = new LinkedMultiValueMap<>(size); for (Map.Entry<String, List<String>> entry : this.queryParams.entrySet()) { String name = encodeUriComponent(entry.getKey(), charset, Type.QUERY_PARAM); List<String> values = new ArrayList<>(entry.getValue().size()); for (String value : entry.getValue()) { values.add(encodeUriComponent(value, charset, Type.QUERY_PARAM)); } result.put(name, values); } return result; } /** * Encode the given source into an encoded String using the rules specified * by the given component and with the given options. * @param source the source String * @param encoding the encoding of the source String * @param type the URI component for the source * @return the encoded URI * @throws IllegalArgumentException when the given value is not a valid URI component */ static String encodeUriComponent(String source, String encoding, Type type) { return encodeUriComponent(source, Charset.forName(encoding), type); } /** * Encode the given source into an encoded String using the rules specified * by the given component and with the given options. * @param source the source String * @param charset the encoding of the source String * @param type the URI component for the source * @return the encoded URI * @throws IllegalArgumentException when the given value is not a valid URI component */ static String encodeUriComponent(String source, Charset charset, Type type) { if (!StringUtils.hasLength(source)) { return source; } Assert.notNull(charset, "Charset must not be null"); Assert.notNull(type, "Type must not be null"); byte[] bytes = source.getBytes(charset); ByteArrayOutputStream bos = new ByteArrayOutputStream(bytes.length); boolean changed = false; for (byte b : bytes) { if (b < 0) { b += 256; } if (type.isAllowed(b)) { bos.write(b); } else { bos.write('%'); char hex1 = Character.toUpperCase(Character.forDigit((b >> 4) & 0xF, 16)); char hex2 = Character.toUpperCase(Character.forDigit(b & 0xF, 16)); bos.write(hex1); bos.write(hex2); changed = true; } } return (changed ? new String(bos.toByteArray(), charset) : source); } private Type getHostType() { return (this.host != null && this.host.startsWith("[") ? Type.HOST_IPV6 : Type.HOST_IPV4); } // Verifying /** * Verifies all URI components to determine whether they contain any illegal * characters, throwing an {@code IllegalArgumentException} if so. * @throws IllegalArgumentException if any component has illegal characters */ private void verify() { if (!this.encoded) { return; } verifyUriComponent(getScheme(), Type.SCHEME); verifyUriComponent(this.userInfo, Type.USER_INFO); verifyUriComponent(this.host, getHostType()); this.path.verify(); for (Map.Entry<String, List<String>> entry : queryParams.entrySet()) { verifyUriComponent(entry.getKey(), Type.QUERY_PARAM); for (String value : entry.getValue()) { verifyUriComponent(value, Type.QUERY_PARAM); } } verifyUriComponent(getFragment(), Type.FRAGMENT); } private static void verifyUriComponent(String source, Type type) { if (source == null) { return; } int length = source.length(); for (int i = 0; i < length; i++) { char ch = source.charAt(i); if (ch == '%') { if ((i + 2) < length) { char hex1 = source.charAt(i + 1); char hex2 = source.charAt(i + 2); int u = Character.digit(hex1, 16); int l = Character.digit(hex2, 16); if (u == -1 || l == -1) { throw new IllegalArgumentException("Invalid encoded sequence \"" + source.substring(i) + "\""); } i += 2; } else { throw new IllegalArgumentException("Invalid encoded sequence \"" + source.substring(i) + "\""); } } else if (!type.isAllowed(ch)) { throw new IllegalArgumentException("Invalid character '" + ch + "' for " + type.name() + " in \"" + source + "\""); } } } // Expanding @Override protected HierarchicalUriComponents expandInternal(UriTemplateVariables uriVariables) { Assert.state(!this.encoded, "Cannot expand an already encoded UriComponents object"); String schemeTo = expandUriComponent(getScheme(), uriVariables); String userInfoTo = expandUriComponent(this.userInfo, uriVariables); String hostTo = expandUriComponent(this.host, uriVariables); String portTo = expandUriComponent(this.port, uriVariables); PathComponent pathTo = this.path.expand(uriVariables); MultiValueMap<String, String> paramsTo = expandQueryParams(uriVariables); String fragmentTo = expandUriComponent(getFragment(), uriVariables); return new HierarchicalUriComponents(schemeTo, userInfoTo, hostTo, portTo, pathTo, paramsTo, fragmentTo, false, false); } private MultiValueMap<String, String> expandQueryParams(UriTemplateVariables variables) { int size = this.queryParams.size(); MultiValueMap<String, String> result = new LinkedMultiValueMap<>(size); variables = new QueryUriTemplateVariables(variables); for (Map.Entry<String, List<String>> entry : this.queryParams.entrySet()) { String name = expandUriComponent(entry.getKey(), variables); List<String> values = new ArrayList<>(entry.getValue().size()); for (String value : entry.getValue()) { values.add(expandUriComponent(value, variables)); } result.put(name, values); } return result; } /** * Normalize the path removing sequences like "path/..". * @see StringUtils#cleanPath(String) */ @Override public UriComponents normalize() { String normalizedPath = StringUtils.cleanPath(getPath()); return new HierarchicalUriComponents(getScheme(), this.userInfo, this.host, this.port, new FullPathComponent(normalizedPath), this.queryParams, getFragment(), this.encoded, false); } // Other functionality /** * Returns a URI String from this {@code UriComponents} instance. */ @Override public String toUriString() { StringBuilder uriBuilder = new StringBuilder(); if (getScheme() != null) { uriBuilder.append(getScheme()); uriBuilder.append(':'); } if (this.userInfo != null || this.host != null) { uriBuilder.append("//"); if (this.userInfo != null) { uriBuilder.append(this.userInfo); uriBuilder.append('@'); } if (this.host != null) { uriBuilder.append(host); } if (getPort() != -1) { uriBuilder.append(':'); uriBuilder.append(port); } } String path = getPath(); if (StringUtils.hasLength(path)) { if (uriBuilder.length() != 0 && path.charAt(0) != PATH_DELIMITER) { uriBuilder.append(PATH_DELIMITER); } uriBuilder.append(path); } String query = getQuery(); if (query != null) { uriBuilder.append('?'); uriBuilder.append(query); } if (getFragment() != null) { uriBuilder.append('#'); uriBuilder.append(getFragment()); } return uriBuilder.toString(); } /** * Returns a {@code URI} from this {@code UriComponents} instance. */ @Override public URI toUri() { try { if (this.encoded) { return new URI(toString()); } else { String path = getPath(); if (StringUtils.hasLength(path) && path.charAt(0) != PATH_DELIMITER) { // Only prefix the path delimiter if something exists before it if (getScheme() != null || getUserInfo() != null || getHost() != null || getPort() != -1) { path = PATH_DELIMITER + path; } } return new URI(getScheme(), getUserInfo(), getHost(), getPort(), path, getQuery(), getFragment()); } } catch (URISyntaxException ex) { throw new IllegalStateException("Could not create URI object: " + ex.getMessage(), ex); } } @Override protected void copyToUriComponentsBuilder(UriComponentsBuilder builder) { if (getScheme() != null) { builder.scheme(getScheme()); } if (getUserInfo() != null) { builder.userInfo(getUserInfo()); } if (getHost() != null) { builder.host(getHost()); } // Avoid parsing the port, may have URI variable.. if (this.port != null) { builder.port(this.port); } if (getPath() != null) { this.path.copyToUriComponentsBuilder(builder); } if (!getQueryParams().isEmpty()) { builder.queryParams(getQueryParams()); } if (getFragment() != null) { builder.fragment(getFragment()); } } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (!(obj instanceof HierarchicalUriComponents)) { return false; } HierarchicalUriComponents other = (HierarchicalUriComponents) obj; return ObjectUtils.nullSafeEquals(getScheme(), other.getScheme()) && ObjectUtils.nullSafeEquals(getUserInfo(), other.getUserInfo()) && ObjectUtils.nullSafeEquals(getHost(), other.getHost()) && getPort() == other.getPort() && this.path.equals(other.path) && this.queryParams.equals(other.queryParams) && ObjectUtils.nullSafeEquals(getFragment(), other.getFragment()); } @Override public int hashCode() { int result = ObjectUtils.nullSafeHashCode(getScheme()); result = 31 * result + ObjectUtils.nullSafeHashCode(this.userInfo); result = 31 * result + ObjectUtils.nullSafeHashCode(this.host); result = 31 * result + ObjectUtils.nullSafeHashCode(this.port); result = 31 * result + this.path.hashCode(); result = 31 * result + this.queryParams.hashCode(); result = 31 * result + ObjectUtils.nullSafeHashCode(getFragment()); return result; } // Nested types /** * Enumeration used to identify the allowed characters per URI component. * <p>Contains methods to indicate whether a given character is valid in a specific URI component. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a> */ enum Type { SCHEME { @Override public boolean isAllowed(int c) { return isAlpha(c) || isDigit(c) || '+' == c || '-' == c || '.' == c; } }, AUTHORITY { @Override public boolean isAllowed(int c) { return isUnreserved(c) || isSubDelimiter(c) || ':' == c || '@' == c; } }, USER_INFO { @Override public boolean isAllowed(int c) { return isUnreserved(c) || isSubDelimiter(c) || ':' == c; } }, HOST_IPV4 { @Override public boolean isAllowed(int c) { return isUnreserved(c) || isSubDelimiter(c); } }, HOST_IPV6 { @Override public boolean isAllowed(int c) { return isUnreserved(c) || isSubDelimiter(c) || '[' == c || ']' == c || ':' == c; } }, PORT { @Override public boolean isAllowed(int c) { return isDigit(c); } }, PATH { @Override public boolean isAllowed(int c) { return isPchar(c) || '/' == c; } }, PATH_SEGMENT { @Override public boolean isAllowed(int c) { return isPchar(c); } }, QUERY { @Override public boolean isAllowed(int c) { return isPchar(c) || '/' == c || '?' == c; } }, QUERY_PARAM { @Override public boolean isAllowed(int c) { if ('=' == c || '&' == c) { return false; } else { return isPchar(c) || '/' == c || '?' == c; } } }, FRAGMENT { @Override public boolean isAllowed(int c) { return isPchar(c) || '/' == c || '?' == c; } }, URI { @Override public boolean isAllowed(int c) { return isUnreserved(c); } }; /** * Indicates whether the given character is allowed in this URI component. * @return {@code true} if the character is allowed; {@code false} otherwise */ public abstract boolean isAllowed(int c); /** * Indicates whether the given character is in the {@code ALPHA} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isAlpha(int c) { return (c >= 'a' && c <= 'z' || c >= 'A' && c <= 'Z'); } /** * Indicates whether the given character is in the {@code DIGIT} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isDigit(int c) { return (c >= '0' && c <= '9'); } /** * Indicates whether the given character is in the {@code gen-delims} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isGenericDelimiter(int c) { return (':' == c || '/' == c || '?' == c || '#' == c || '[' == c || ']' == c || '@' == c); } /** * Indicates whether the given character is in the {@code sub-delims} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isSubDelimiter(int c) { return ('!' == c || '$' == c || '&' == c || '\'' == c || '(' == c || ')' == c || '*' == c || '+' == c || ',' == c || ';' == c || '=' == c); } /** * Indicates whether the given character is in the {@code reserved} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isReserved(int c) { return (isGenericDelimiter(c) || isSubDelimiter(c)); } /** * Indicates whether the given character is in the {@code unreserved} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isUnreserved(int c) { return (isAlpha(c) || isDigit(c) || '-' == c || '.' == c || '_' == c || '~' == c); } /** * Indicates whether the given character is in the {@code pchar} set. * @see <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986, appendix A</a> */ protected boolean isPchar(int c) { return (isUnreserved(c) || isSubDelimiter(c) || ':' == c || '@' == c); } } /** * Defines the contract for path (segments). */ interface PathComponent extends Serializable { String getPath(); List<String> getPathSegments(); PathComponent encode(Charset charset); void verify(); PathComponent expand(UriTemplateVariables uriVariables); void copyToUriComponentsBuilder(UriComponentsBuilder builder); } /** * Represents a path backed by a String. */ static final class FullPathComponent implements PathComponent { private final String path; public FullPathComponent(String path) { this.path = path; } @Override public String getPath() { return this.path; } @Override public List<String> getPathSegments() { String[] segments = StringUtils.tokenizeToStringArray(this.path, PATH_DELIMITER_STRING); return Collections.unmodifiableList(Arrays.asList(segments)); } @Override public PathComponent encode(Charset charset) { String encodedPath = encodeUriComponent(getPath(), charset, Type.PATH); return new FullPathComponent(encodedPath); } @Override public void verify() { verifyUriComponent(this.path, Type.PATH); } @Override public PathComponent expand(UriTemplateVariables uriVariables) { String expandedPath = expandUriComponent(getPath(), uriVariables); return new FullPathComponent(expandedPath); } @Override public void copyToUriComponentsBuilder(UriComponentsBuilder builder) { builder.path(getPath()); } @Override public boolean equals(Object obj) { return (this == obj || (obj instanceof FullPathComponent && getPath().equals(((FullPathComponent) obj).getPath()))); } @Override public int hashCode() { return getPath().hashCode(); } } /** * Represents a path backed by a String list (i.e. path segments). */ static final class PathSegmentComponent implements PathComponent { private final List<String> pathSegments; public PathSegmentComponent(List<String> pathSegments) { Assert.notNull(pathSegments, "List must not be null"); this.pathSegments = Collections.unmodifiableList(new ArrayList<>(pathSegments)); } @Override public String getPath() { StringBuilder pathBuilder = new StringBuilder(); pathBuilder.append(PATH_DELIMITER); for (Iterator<String> iterator = this.pathSegments.iterator(); iterator.hasNext(); ) { String pathSegment = iterator.next(); pathBuilder.append(pathSegment); if (iterator.hasNext()) { pathBuilder.append(PATH_DELIMITER); } } return pathBuilder.toString(); } @Override public List<String> getPathSegments() { return this.pathSegments; } @Override public PathComponent encode(Charset charset) { List<String> pathSegments = getPathSegments(); List<String> encodedPathSegments = new ArrayList<>(pathSegments.size()); for (String pathSegment : pathSegments) { String encodedPathSegment = encodeUriComponent(pathSegment, charset, Type.PATH_SEGMENT); encodedPathSegments.add(encodedPathSegment); } return new PathSegmentComponent(encodedPathSegments); } @Override public void verify() { for (String pathSegment : getPathSegments()) { verifyUriComponent(pathSegment, Type.PATH_SEGMENT); } } @Override public PathComponent expand(UriTemplateVariables uriVariables) { List<String> pathSegments = getPathSegments(); List<String> expandedPathSegments = new ArrayList<>(pathSegments.size()); for (String pathSegment : pathSegments) { String expandedPathSegment = expandUriComponent(pathSegment, uriVariables); expandedPathSegments.add(expandedPathSegment); } return new PathSegmentComponent(expandedPathSegments); } @Override public void copyToUriComponentsBuilder(UriComponentsBuilder builder) { builder.pathSegment(getPathSegments().toArray(new String[getPathSegments().size()])); } @Override public boolean equals(Object obj) { return (this == obj || (obj instanceof PathSegmentComponent && getPathSegments().equals(((PathSegmentComponent) obj).getPathSegments()))); } @Override public int hashCode() { return getPathSegments().hashCode(); } } /** * Represents a collection of PathComponents. */ static final class PathComponentComposite implements PathComponent { private final List<PathComponent> pathComponents; public PathComponentComposite(List<PathComponent> pathComponents) { Assert.notNull(pathComponents, "PathComponent List must not be null"); this.pathComponents = pathComponents; } @Override public String getPath() { StringBuilder pathBuilder = new StringBuilder(); for (PathComponent pathComponent : this.pathComponents) { pathBuilder.append(pathComponent.getPath()); } return pathBuilder.toString(); } @Override public List<String> getPathSegments() { List<String> result = new ArrayList<>(); for (PathComponent pathComponent : this.pathComponents) { result.addAll(pathComponent.getPathSegments()); } return result; } @Override public PathComponent encode(Charset charset) { List<PathComponent> encodedComponents = new ArrayList<>(this.pathComponents.size()); for (PathComponent pathComponent : this.pathComponents) { encodedComponents.add(pathComponent.encode(charset)); } return new PathComponentComposite(encodedComponents); } @Override public void verify() { for (PathComponent pathComponent : this.pathComponents) { pathComponent.verify(); } } @Override public PathComponent expand(UriTemplateVariables uriVariables) { List<PathComponent> expandedComponents = new ArrayList<>(this.pathComponents.size()); for (PathComponent pathComponent : this.pathComponents) { expandedComponents.add(pathComponent.expand(uriVariables)); } return new PathComponentComposite(expandedComponents); } @Override public void copyToUriComponentsBuilder(UriComponentsBuilder builder) { for (PathComponent pathComponent : this.pathComponents) { pathComponent.copyToUriComponentsBuilder(builder); } } } /** * Represents an empty path. */ static final PathComponent NULL_PATH_COMPONENT = new PathComponent() { @Override public String getPath() { return null; } @Override public List<String> getPathSegments() { return Collections.emptyList(); } @Override public PathComponent encode(Charset charset) { return this; } @Override public void verify() { } @Override public PathComponent expand(UriTemplateVariables uriVariables) { return this; } @Override public void copyToUriComponentsBuilder(UriComponentsBuilder builder) { } @Override public boolean equals(Object obj) { return (this == obj); } @Override public int hashCode() { return getClass().hashCode(); } }; private static class QueryUriTemplateVariables implements UriTemplateVariables { private final UriTemplateVariables delegate; public QueryUriTemplateVariables(UriTemplateVariables delegate) { this.delegate = delegate; } @Override public Object getValue(String name) { Object value = this.delegate.getValue(name); if (ObjectUtils.isArray(value)) { value = StringUtils.arrayToCommaDelimitedString(ObjectUtils.toObjectArray(value)); } return value; } } }