io.micronaut.web.router.resource.StaticResourceResolver Maven / Gradle / Ivy
/*
* Copyright 2017-2020 original 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
*
* https://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 io.micronaut.web.router.resource;
import io.micronaut.core.io.ResourceLoader;
import io.micronaut.core.util.AntPathMatcher;
import io.micronaut.core.util.CollectionUtils;
import io.micronaut.core.util.PathMatcher;
import io.micronaut.core.util.StringUtils;
import java.net.URL;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
/**
* Resolves resources from a set of resource loaders.
*
* @author James Kleeh
* @since 1.0
*/
public class StaticResourceResolver {
/**
* An empty resolver to use as a constant.
*/
public static final StaticResourceResolver EMPTY = new StaticResourceResolver(Collections.emptyList()) {
@Override
public Optional resolve(String resourcePath) {
return Optional.empty();
}
};
private static final String INDEX_PAGE = "index.html";
private final AntPathMatcher pathMatcher;
private final Map> resourceMappings;
/**
* Default constructor.
*
* @param configurations The static resource configurations
*/
StaticResourceResolver(List configurations) {
if (CollectionUtils.isEmpty(configurations)) {
this.pathMatcher = null;
this.resourceMappings = Collections.emptyMap();
} else {
this.resourceMappings = new LinkedHashMap<>();
this.pathMatcher = PathMatcher.ANT;
if (CollectionUtils.isNotEmpty(configurations)) {
for (StaticResourceConfiguration config: configurations) {
if (config.isEnabled()) {
this.resourceMappings.put(config.getMapping(), config.getResourceLoaders());
}
}
}
}
}
/**
* Resolves a path to a URL.
*
* @param resourcePath The path to the resource
* @return The optional URL
*/
public Optional resolve(String resourcePath) {
for (Map.Entry> entry : resourceMappings.entrySet()) {
List loaders = entry.getValue();
String mapping = entry.getKey();
if (!loaders.isEmpty() && pathMatcher.matches(mapping, resourcePath)) {
String path = pathMatcher.extractPathWithinPattern(mapping, resourcePath);
//A request to the root of the mapping
if (StringUtils.isEmpty(path)) {
path = INDEX_PAGE;
}
if (path.startsWith("/")) {
path = path.substring(1);
}
for (ResourceLoader loader : loaders) {
Optional resource = loader.getResource(path);
if (resource.isPresent()) {
return resource;
} else {
if (path.indexOf('.') == -1) {
if (!path.endsWith("/")) {
path = path + "/";
}
path += INDEX_PAGE;
resource = loader.getResource(path);
if (resource.isPresent()) {
return resource;
}
}
}
}
}
}
return Optional.empty();
}
}