Skip to content

Commit

Permalink
Resolve absolute resource links in ResourceTransformers
Browse files Browse the repository at this point in the history 
This commit adapts the fix for SPR-14597 commited to spring-webmvc to
the spring-web-reactive module.

Issue: SPR-14597
  • Loading branch information
@bclozel
bclozel committed Oct 11, 2016
1 parent 679b661 commit 7ae7294
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 27 deletions.
3 changes: 2 additions & 1 deletion .../src/main/java/org/springframework/web/reactive/resource/AppCacheManifestTransformer.java
View file
Expand Up @@ -144,7 +144,8 @@ private Mono<LineOutput> processLine(LineInfo info, ServerWebExchange exchange,
return Mono.just(new LineOutput(info.getLine(), null));
}

Mono<String> pathMono = resolveUrlPath(info.getLine(), exchange, resource, chain)
String link = toAbsolutePath(info.getLine(), exchange.getRequest());
Mono<String> pathMono = resolveUrlPath(link, exchange, resource, chain)
.doOnNext(path -> {
if (logger.isTraceEnabled()) {
logger.trace("Link modified: " + path + " (original: " + info.getLine() + ")");
Expand Down
3 changes: 2 additions & 1 deletion ...e/src/main/java/org/springframework/web/reactive/resource/CssLinkResourceTransformer.java
View file
Expand Up @@ -102,7 +102,8 @@ public Mono<Resource> transform(ServerWebExchange exchange, Resource resource,
.concatMap(segment -> {
String segmentContent = segment.getContent(fullContent);
if (segment.isLink() && !hasScheme(segmentContent)) {
return resolveUrlPath(segmentContent, exchange, newResource, transformerChain)
String link = toAbsolutePath(segmentContent, exchange.getRequest());
return resolveUrlPath(link, exchange, newResource, transformerChain)
.defaultIfEmpty(segmentContent);
}
else {
Expand Down
19 changes: 18 additions & 1 deletion ...e/src/main/java/org/springframework/web/reactive/resource/ResourceTransformerSupport.java
View file
Expand Up @@ -21,6 +21,8 @@
import reactor.core.publisher.Mono;

import org.springframework.core.io.Resource;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;

/**
Expand Down Expand Up @@ -72,7 +74,7 @@ protected Mono<String> resolveUrlPath(String resourcePath, ServerWebExchange exc
if (resourcePath.startsWith("/")) {
// full resource path
ResourceUrlProvider urlProvider = getResourceUrlProvider();
return (urlProvider != null ? urlProvider.getForRequestUrl(exchange, resourcePath) : null);
return (urlProvider != null ? urlProvider.getForRequestUrl(exchange, resourcePath) : Mono.empty());
}
else {
// try resolving as relative path
Expand All @@ -81,4 +83,19 @@ protected Mono<String> resolveUrlPath(String resourcePath, ServerWebExchange exc
}
}

/**
* Transform the given relative request path to an absolute path,
* taking the path of the given request as a point of reference.
* The resulting path is also cleaned from sequences like "path/..".
*
* @param path the relative path to transform
* @param request the referer request
* @return the absolute request path for the given resource path
*/
protected String toAbsolutePath(String path, ServerHttpRequest request) {
String requestPath = request.getURI().getPath();
String absolutePath = StringUtils.applyRelativePath(requestPath, path);
return StringUtils.cleanPath(absolutePath);
}

}
43 changes: 34 additions & 9 deletions ...test/java/org/springframework/web/reactive/resource/AppCacheManifestTransformerTests.java
View file
Expand Up @@ -61,18 +61,35 @@ public class AppCacheManifestTransformerTests {

@Before
public void setup() {
ClassPathResource allowedLocation = new ClassPathResource("test/", getClass());
ResourceWebHandler resourceHandler = new ResourceWebHandler();
ResourceUrlProvider resourceUrlProvider = new ResourceUrlProvider();
resourceUrlProvider.setHandlerMap(Collections.singletonMap("/static/**", resourceHandler));

VersionResourceResolver versionResolver = new VersionResourceResolver();
versionResolver.setStrategyMap(Collections.singletonMap("/**", new ContentVersionStrategy()));
PathResourceResolver pathResolver = new PathResourceResolver();
pathResolver.setAllowedLocations(allowedLocation);
List<ResourceResolver> resolvers = Arrays.asList(versionResolver, pathResolver);
ResourceResolverChain resolverChain = new DefaultResourceResolverChain(resolvers);

CssLinkResourceTransformer cssLinkResourceTransformer = new CssLinkResourceTransformer();
cssLinkResourceTransformer.setResourceUrlProvider(resourceUrlProvider);
List<ResourceTransformer> transformers = Arrays.asList(cssLinkResourceTransformer);
this.chain = new DefaultResourceTransformerChain(resolverChain, transformers);
this.transformer = new AppCacheManifestTransformer();
this.chain = mock(ResourceTransformerChain.class);
this.transformer.setResourceUrlProvider(resourceUrlProvider);

MockServerHttpRequest request = new MockServerHttpRequest(HttpMethod.GET, "");
ServerHttpResponse response = new MockServerHttpResponse();
WebSessionManager manager = new DefaultWebSessionManager();
this.exchange = new DefaultServerWebExchange(request, response, manager);
resourceHandler.setResourceResolvers(resolvers);
resourceHandler.setResourceTransformers(transformers);
resourceHandler.setLocations(Collections.singletonList(allowedLocation));
}


@Test
public void noTransformIfExtensionNoMatch() throws Exception {
initExchange(HttpMethod.GET, "/static/foobar.file");
this.chain = mock(ResourceTransformerChain.class);
Resource resource = mock(Resource.class);
given(resource.getFilename()).willReturn("foobar.file");
given(this.chain.transform(this.exchange, resource)).willReturn(Mono.just(resource));
Expand All @@ -83,6 +100,8 @@ public void noTransformIfExtensionNoMatch() throws Exception {

@Test
public void syntaxErrorInManifest() throws Exception {
initExchange(HttpMethod.GET, "/static/error.appcache");
this.chain = mock(ResourceTransformerChain.class);
Resource resource = new ClassPathResource("test/error.appcache", getClass());
given(this.chain.transform(this.exchange, resource)).willReturn(Mono.just(resource));

Expand All @@ -92,7 +111,7 @@ public void syntaxErrorInManifest() throws Exception {

@Test
public void transformManifest() throws Exception {

initExchange(HttpMethod.GET, "/static/test.appcache");
VersionResourceResolver versionResolver = new VersionResourceResolver();
versionResolver.setStrategyMap(Collections.singletonMap("/**", new ContentVersionStrategy()));

Expand All @@ -112,11 +131,11 @@ public void transformManifest() throws Exception {
String content = new String(bytes, "UTF-8");

assertThat("should rewrite resource links", content,
Matchers.containsString("foo-e36d2e05253c6c7085a91522ce43a0b4.css"));
Matchers.containsString("/static/foo-e36d2e05253c6c7085a91522ce43a0b4.css"));
assertThat("should rewrite resource links", content,
Matchers.containsString("bar-11e16cf79faee7ac698c805cf28248d2.css"));
Matchers.containsString("/static/bar-11e16cf79faee7ac698c805cf28248d2.css"));
assertThat("should rewrite resource links", content,
Matchers.containsString("js/bar-bd508c62235b832d960298ca6c0b7645.js"));
Matchers.containsString("/static/js/bar-bd508c62235b832d960298ca6c0b7645.js"));

assertThat("should not rewrite external resources", content,
Matchers.containsString("//example.org/style.css"));
Expand All @@ -127,4 +146,10 @@ public void transformManifest() throws Exception {
Matchers.containsString("# Hash: 4bf0338bcbeb0a5b3a4ec9ed8864107d"));
}

private void initExchange(HttpMethod method, String url) {
MockServerHttpRequest request = new MockServerHttpRequest(method, url);
ServerHttpResponse response = new MockServerHttpResponse();
WebSessionManager manager = new DefaultWebSessionManager();
this.exchange = new DefaultServerWebExchange(request, response, manager);
}
}
46 changes: 31 additions & 15 deletions .../test/java/org/springframework/web/reactive/resource/CssLinkResourceTransformerTests.java
View file
Expand Up @@ -52,39 +52,45 @@ public class CssLinkResourceTransformerTests {

@Before
public void setUp() {
ClassPathResource allowedLocation = new ClassPathResource("test/", getClass());
ResourceWebHandler resourceHandler = new ResourceWebHandler();

ResourceUrlProvider resourceUrlProvider = new ResourceUrlProvider();
resourceUrlProvider.setHandlerMap(Collections.singletonMap("/static/**", resourceHandler));

VersionResourceResolver versionResolver = new VersionResourceResolver();
versionResolver.setStrategyMap(Collections.singletonMap("/**", new ContentVersionStrategy()));

PathResourceResolver pathResolver = new PathResourceResolver();
pathResolver.setAllowedLocations(new ClassPathResource("test/", getClass()));

pathResolver.setAllowedLocations(allowedLocation);
List<ResourceResolver> resolvers = Arrays.asList(versionResolver, pathResolver);
List<ResourceTransformer> transformers = Collections.singletonList(new CssLinkResourceTransformer());

CssLinkResourceTransformer cssLinkResourceTransformer = new CssLinkResourceTransformer();
cssLinkResourceTransformer.setResourceUrlProvider(resourceUrlProvider);
List<ResourceTransformer> transformers = Collections.singletonList(cssLinkResourceTransformer);

resourceHandler.setResourceResolvers(resolvers);
resourceHandler.setResourceTransformers(transformers);
resourceHandler.setLocations(Collections.singletonList(allowedLocation));
ResourceResolverChain resolverChain = new DefaultResourceResolverChain(resolvers);
this.transformerChain = new DefaultResourceTransformerChain(resolverChain, transformers);

MockServerHttpRequest request = new MockServerHttpRequest(HttpMethod.GET, "");
ServerHttpResponse response = new MockServerHttpResponse();
WebSessionManager manager = new DefaultWebSessionManager();
this.exchange = new DefaultServerWebExchange(request, response, manager);
}


@Test
public void transform() throws Exception {
initExchange(HttpMethod.GET, "/static/main.css");
Resource css = new ClassPathResource("test/main.css", getClass());
TransformedResource actual =
(TransformedResource) this.transformerChain.transform(this.exchange, css)
.blockMillis(5000);

String expected = "\n" +
"@import url(\"bar-11e16cf79faee7ac698c805cf28248d2.css\");\n" +
"@import url('bar-11e16cf79faee7ac698c805cf28248d2.css');\n" +
"@import url(bar-11e16cf79faee7ac698c805cf28248d2.css);\n\n" +
"@import \"foo-e36d2e05253c6c7085a91522ce43a0b4.css\";\n" +
"@import 'foo-e36d2e05253c6c7085a91522ce43a0b4.css';\n\n" +
"body { background: url(\"images/image-f448cd1d5dba82b774f3202c878230b3.png\") }\n";
"@import url(\"/static/bar-11e16cf79faee7ac698c805cf28248d2.css\");\n" +
"@import url('/static/bar-11e16cf79faee7ac698c805cf28248d2.css');\n" +
"@import url(/static/bar-11e16cf79faee7ac698c805cf28248d2.css);\n\n" +
"@import \"/static/foo-e36d2e05253c6c7085a91522ce43a0b4.css\";\n" +
"@import '/static/foo-e36d2e05253c6c7085a91522ce43a0b4.css';\n\n" +
"body { background: url(\"/static/images/image-f448cd1d5dba82b774f3202c878230b3.png\") }\n";

String result = new String(actual.getByteArray(), "UTF-8");
result = StringUtils.deleteAny(result, "\r");
Expand All @@ -93,13 +99,15 @@ public void transform() throws Exception {

@Test
public void transformNoLinks() throws Exception {
initExchange(HttpMethod.GET, "/static/foo.css");
Resource expected = new ClassPathResource("test/foo.css", getClass());
Resource actual = this.transformerChain.transform(this.exchange, expected).blockMillis(5000);
assertSame(expected, actual);
}

@Test
public void transformExtLinksNotAllowed() throws Exception {
initExchange(HttpMethod.GET, "/static/external.css");
ResourceResolverChain resolverChain = Mockito.mock(DefaultResourceResolverChain.class);
ResourceTransformerChain transformerChain = new DefaultResourceTransformerChain(resolverChain,
Collections.singletonList(new CssLinkResourceTransformer()));
Expand All @@ -125,9 +133,17 @@ public void transformExtLinksNotAllowed() throws Exception {

@Test
public void transformWithNonCssResource() throws Exception {
initExchange(HttpMethod.GET, "/static/images/image.png");
Resource expected = new ClassPathResource("test/images/image.png", getClass());
Resource actual = this.transformerChain.transform(this.exchange, expected).blockMillis(5000);
assertSame(expected, actual);
}

private void initExchange(HttpMethod method, String url) {
MockServerHttpRequest request = new MockServerHttpRequest(method, url);
ServerHttpResponse response = new MockServerHttpResponse();
WebSessionManager manager = new DefaultWebSessionManager();
this.exchange = new DefaultServerWebExchange(request, response, manager);
}

}

0 comments on commit 7ae7294

Please sign in to comment.