+ * This method will not attempt to ensure validity of the resultant text representation. + * + * @param target target host + * @param request the {@link HttpRequest} + * + * @return String the request URI + */ + @Internal + public static String getRequestUri(final HttpHost target, final HttpRequest request) { + Args.notNull(target, "Target"); + Args.notNull(request, "HTTP request"); + final StringBuilder buf = new StringBuilder(); + final URIAuthority authority = request.getAuthority(); + if (authority != null) { + final String scheme = request.getScheme(); + buf.append(scheme != null ? scheme : URIScheme.HTTP.id).append("://"); + buf.append(authority.getHostName()); + if (authority.getPort() >= 0) { + buf.append(":").append(authority.getPort()); + } + } else { + buf.append(target.getSchemeName()).append("://"); + buf.append(target.getHostName()); + if (target.getPort() >= 0) { + buf.append(":").append(target.getPort()); + } + } + final String path = request.getPath(); + if (path == null) { + buf.append("/"); + } else { + if (buf.length() > 0 && !path.startsWith("/")) { + buf.append("/"); + } + buf.append(path); + } + return buf.toString(); + } + + /** + * Returns normalized representation of the request URI optimized for use as a cache key. + * This method ensures the resultant URI has an explicit port in the authority component, + * and explicit path component and no fragment. + */ + @Internal + public static URI normalize(final URI requestUri) throws URISyntaxException { + Args.notNull(requestUri, "URI"); + final URIBuilder builder = new URIBuilder(requestUri); + if (builder.getHost() != null) { + if (builder.getScheme() == null) { + builder.setScheme(URIScheme.HTTP.id); + } + if (builder.getPort() <= -1) { + if (URIScheme.HTTP.same(builder.getScheme())) { + builder.setPort(80); + } else if (URIScheme.HTTPS.same(builder.getScheme())) { + builder.setPort(443); + } + } + } + builder.setFragment(null); + return builder.normalizeSyntax().build(); + } + + /** + * Lenient URI parser that normalizes valid {@link URI}s and returns {@code null} for malformed URIs. + */ + @Internal + public static URI normalize(final String requestUri) { + if (requestUri == null) { + return null; + } + try { + return CacheKeyGenerator.normalize(new URI(requestUri)); + } catch (final URISyntaxException ex) { + return null; + } + } + /** * Computes a key for the given request {@link URI} that can be used as * a unique identifier for cached resources. The URI is expected to @@ -71,7 +160,7 @@ public String resolve(final URI uri) { */ public String generateKey(final URI requestUri) { try { - final URI normalizeRequestUri = CacheSupport.normalize(requestUri); + final URI normalizeRequestUri = normalize(requestUri); return normalizeRequestUri.toASCIIString(); } catch (final URISyntaxException ex) { return requestUri.toASCIIString(); @@ -87,7 +176,7 @@ public String generateKey(final URI requestUri) { * @return cache key */ public String generateKey(final HttpHost host, final HttpRequest request) { - final String s = CacheSupport.getRequestUri(request, host); + final String s = getRequestUri(host, request); try { return generateKey(new URI(s)); } catch (final URISyntaxException ex) { diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheSupport.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheSupport.java index f4ec0604d0..380dbae965 100644 --- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheSupport.java +++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/CacheSupport.java @@ -27,7 +27,6 @@ package org.apache.hc.client5.http.impl.cache; import java.net.URI; -import java.net.URISyntaxException; import java.util.BitSet; import java.util.Objects; import java.util.function.Consumer; @@ -36,13 +35,8 @@ import org.apache.hc.core5.annotation.Internal; import org.apache.hc.core5.http.FormattedHeader; import org.apache.hc.core5.http.Header; -import org.apache.hc.core5.http.HttpHost; -import org.apache.hc.core5.http.HttpRequest; import org.apache.hc.core5.http.MessageHeaders; -import org.apache.hc.core5.http.URIScheme; import org.apache.hc.core5.http.message.ParserCursor; -import org.apache.hc.core5.net.URIAuthority; -import org.apache.hc.core5.net.URIBuilder; import org.apache.hc.core5.util.Args; import org.apache.hc.core5.util.CharArrayBuffer; import org.apache.hc.core5.util.TextUtils; @@ -57,90 +51,6 @@ @Internal public final class CacheSupport { - private static final URI BASE_URI = URI.create("http://example.com/"); - - /** - * Returns text representation of the request URI of the given {@link HttpRequest}. - * This method will use {@link HttpRequest#getPath()}, {@link HttpRequest#getScheme()} and - * {@link HttpRequest#getAuthority()} values when available or attributes of target - * {@link HttpHost } in order to construct an absolute URI. - *
- * This method will not attempt to ensure validity of the resultant text representation. - * - * @param request the {@link HttpRequest} - * @param target target host - * - * @return String the request URI - */ - public static String getRequestUri(final HttpRequest request, final HttpHost target) { - Args.notNull(request, "HTTP request"); - Args.notNull(target, "Target"); - final StringBuilder buf = new StringBuilder(); - final URIAuthority authority = request.getAuthority(); - if (authority != null) { - final String scheme = request.getScheme(); - buf.append(scheme != null ? scheme : URIScheme.HTTP.id).append("://"); - buf.append(authority.getHostName()); - if (authority.getPort() >= 0) { - buf.append(":").append(authority.getPort()); - } - } else { - buf.append(target.getSchemeName()).append("://"); - buf.append(target.getHostName()); - if (target.getPort() >= 0) { - buf.append(":").append(target.getPort()); - } - } - final String path = request.getPath(); - if (path == null) { - buf.append("/"); - } else { - if (buf.length() > 0 && !path.startsWith("/")) { - buf.append("/"); - } - buf.append(path); - } - return buf.toString(); - } - - /** - * Returns normalized representation of the request URI optimized for use as a cache key. - * This method ensures the resultant URI has an explicit port in the authority component, - * and explicit path component and no fragment. - */ - public static URI normalize(final URI requestUri) throws URISyntaxException { - Args.notNull(requestUri, "URI"); - final URIBuilder builder = new URIBuilder(requestUri.isAbsolute() ? URIUtils.resolve(BASE_URI, requestUri) : requestUri) ; - if (builder.getHost() != null) { - if (builder.getScheme() == null) { - builder.setScheme(URIScheme.HTTP.id); - } - if (builder.getPort() <= -1) { - if (URIScheme.HTTP.same(builder.getScheme())) { - builder.setPort(80); - } else if (URIScheme.HTTPS.same(builder.getScheme())) { - builder.setPort(443); - } - } - } - builder.setFragment(null); - return builder.normalizeSyntax().build(); - } - - /** - * Lenient URI parser that normalizes valid {@link URI}s and returns {@code null} for malformed URIs. - */ - public static URI normalize(final String requestUri) { - if (requestUri == null) { - return null; - } - try { - return normalize(new URI(requestUri)); - } catch (final URISyntaxException ex) { - return null; - } - } - private static final BitSet COMMA = Tokenizer.INIT_BITSET(','); // This method should be provided by MessageSupport from core @@ -179,7 +89,7 @@ public static URI getLocationURI(final URI requestUri, final MessageHeaders resp if (h == null) { return null; } - final URI locationUri = CacheSupport.normalize(h.getValue()); + final URI locationUri = CacheKeyGenerator.normalize(h.getValue()); if (locationUri == null) { return requestUri; } diff --git a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpCacheSupport.java b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpCacheSupport.java index 69285cb1be..8cc04c9854 100644 --- a/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpCacheSupport.java +++ b/httpclient5-cache/src/main/java/org/apache/hc/client5/http/impl/cache/HttpCacheSupport.java @@ -42,14 +42,12 @@ @Deprecated public final class HttpCacheSupport { - private static final URI BASE_URI = URI.create("http://example.com/"); - public static String getRequestUri(final HttpRequest request, final HttpHost target) { - return CacheSupport.getRequestUri(request, target); + return CacheKeyGenerator.getRequestUri(target, request); } public static URI normalize(final URI requestUri) throws URISyntaxException { - return CacheSupport.normalize(requestUri); + return CacheKeyGenerator.normalize(requestUri); } /** @@ -73,7 +71,7 @@ public static URI normalizeQuetly(final String requestUri) { * @since 5.2 */ public static URI normalizeQuietly(final String requestUri) { - return CacheSupport.normalize(requestUri); + return CacheKeyGenerator.normalize(requestUri); } } diff --git a/httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheKeyGenerator.java b/httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheKeyGenerator.java index b5858961b3..8a41bbb1bc 100644 --- a/httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheKeyGenerator.java +++ b/httpclient5-cache/src/test/java/org/apache/hc/client5/http/impl/cache/TestCacheKeyGenerator.java @@ -26,6 +26,8 @@ */ package org.apache.hc.client5.http.impl.cache; +import java.net.URI; +import java.net.URISyntaxException; import java.util.Arrays; import java.util.Collections; @@ -51,6 +53,54 @@ public void setUp() throws Exception { extractor = CacheKeyGenerator.INSTANCE; } + @Test + public void testGetRequestUri() { + Assertions.assertEquals("http://foo.example.com/stuff?huh", + CacheKeyGenerator.getRequestUri( + new HttpHost("bar.example.com"), + new HttpGet("http://foo.example.com/stuff?huh"))); + + Assertions.assertEquals("http://bar.example.com/stuff?huh", + CacheKeyGenerator.getRequestUri( + new HttpHost("bar.example.com"), + new HttpGet("/stuff?huh"))); + + Assertions.assertEquals("http://foo.example.com:8888/stuff?huh", + CacheKeyGenerator.getRequestUri( + new HttpHost("bar.example.com", 8080), + new HttpGet("http://foo.example.com:8888/stuff?huh"))); + + Assertions.assertEquals("https://bar.example.com:8443/stuff?huh", + CacheKeyGenerator.getRequestUri( + new HttpHost("https", "bar.example.com", 8443), + new HttpGet("/stuff?huh"))); + + Assertions.assertEquals("http://foo.example.com/", + CacheKeyGenerator.getRequestUri( + new HttpHost("bar.example.com"), + new HttpGet("http://foo.example.com"))); + + Assertions.assertEquals("http://bar.example.com/stuff?huh", + CacheKeyGenerator.getRequestUri( + new HttpHost("bar.example.com"), + new HttpGet("stuff?huh"))); + } + + @Test + public void testNormalizeRequestUri() throws URISyntaxException { + Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), + CacheKeyGenerator.normalize(URI.create("//bar.example.com/stuff?huh"))); + + Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), + CacheKeyGenerator.normalize(URI.create("http://bar.example.com/stuff?huh"))); + + Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), + CacheKeyGenerator.normalize(URI.create("http://bar.example.com/stuff?huh#there"))); + + Assertions.assertEquals(URI.create("http://bar.example.com:80/stuff?huh"), + CacheKeyGenerator.normalize(URI.create("HTTP://BAR.example.com/p1/p2/../../stuff?huh"))); + } + @Test public void testExtractsUriFromAbsoluteUriInRequest() { final HttpHost host = new HttpHost("bar.example.com");