mirror of
https://github.com/plan-player-analytics/Plan.git
synced 2025-01-02 14:37:45 +01:00
Implemented a CompositeResolver
Allows building tree-like structure for resolution
This commit is contained in:
parent
e7da714f55
commit
7f0341087e
@ -0,0 +1,101 @@
|
|||||||
|
/*
|
||||||
|
* This file is part of Player Analytics (Plan).
|
||||||
|
*
|
||||||
|
* Plan is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Lesser General Public License v3 as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* (at your option) any later version.
|
||||||
|
*
|
||||||
|
* Plan is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Lesser General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU Lesser General Public License
|
||||||
|
* along with Plan. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
package com.djrapitops.plan.delivery.web.resolver;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility Resolver for organizing resolution in a tree-like structure.
|
||||||
|
* <p>
|
||||||
|
* CompositeResolver removes first part of the target with {@link URLTarget#omitFirst()}
|
||||||
|
* before calling the child Resolvers.
|
||||||
|
*
|
||||||
|
* @author Rsl1122
|
||||||
|
*/
|
||||||
|
public final class CompositeResolver implements Resolver {
|
||||||
|
|
||||||
|
private final List<String> prefixes;
|
||||||
|
private final List<Resolver> resolvers;
|
||||||
|
|
||||||
|
CompositeResolver() {
|
||||||
|
this.prefixes = new ArrayList<>();
|
||||||
|
this.resolvers = new ArrayList<>();
|
||||||
|
}
|
||||||
|
|
||||||
|
public static CompositeResolver.Builder builder() {
|
||||||
|
return new Builder();
|
||||||
|
}
|
||||||
|
|
||||||
|
private Optional<Resolver> getResolver(URLTarget target) {
|
||||||
|
return target.getPart(0).flatMap(this::find);
|
||||||
|
}
|
||||||
|
|
||||||
|
private Optional<Resolver> find(String prefix) {
|
||||||
|
for (int i = 0; i < prefixes.size(); i++) {
|
||||||
|
if (prefixes.get(i).equals(prefix)) {
|
||||||
|
return Optional.of(resolvers.get(i));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Optional.empty();
|
||||||
|
}
|
||||||
|
|
||||||
|
void add(String prefix, Resolver resolver) {
|
||||||
|
if (prefix == null) throw new IllegalArgumentException("Prefix can not be null");
|
||||||
|
if (resolver == null) throw new IllegalArgumentException("Resolver can not be null");
|
||||||
|
prefixes.add(prefix);
|
||||||
|
resolvers.add(resolver);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public boolean canAccess(WebUser permissions, URLTarget target, Parameters parameters) {
|
||||||
|
return getResolver(target)
|
||||||
|
.map(resolver -> resolver.canAccess(permissions, target.omitFirst(), parameters))
|
||||||
|
.orElse(true);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<Response> resolve(URLTarget target, Parameters parameters) {
|
||||||
|
return getResolver(target)
|
||||||
|
.flatMap(resolver -> resolver.resolve(target.omitFirst(), parameters));
|
||||||
|
}
|
||||||
|
|
||||||
|
public static class Builder {
|
||||||
|
private final CompositeResolver composite;
|
||||||
|
|
||||||
|
private Builder() {
|
||||||
|
this.composite = new CompositeResolver();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a new resolver to the CompositeResolver.
|
||||||
|
*
|
||||||
|
* @param prefix Start of the target (first part of the target string, eg "example" in "/example/target/", or "" in "/")
|
||||||
|
* @param resolver Resolver to call for this target, {@link URLTarget#omitFirst()} will be called for Resolver method calls.
|
||||||
|
* @return this builder.
|
||||||
|
*/
|
||||||
|
public Builder add(String prefix, Resolver resolver) {
|
||||||
|
composite.add(prefix, resolver);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public CompositeResolver build() {
|
||||||
|
return composite;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -28,7 +28,7 @@ public interface Resolver {
|
|||||||
* @param permissions WebUser that is accessing this page.
|
* @param permissions WebUser that is accessing this page.
|
||||||
* @param target Target that is being accessed, /example/target
|
* @param target Target that is being accessed, /example/target
|
||||||
* @param parameters Parameters in the URL, ?param=value etc.
|
* @param parameters Parameters in the URL, ?param=value etc.
|
||||||
* @return true if allowed, false if response should be 403 (forbidden)
|
* @return true if allowed or invalid target, false if response should be 403 (forbidden)
|
||||||
*/
|
*/
|
||||||
boolean canAccess(WebUser permissions, URLTarget target, Parameters parameters);
|
boolean canAccess(WebUser permissions, URLTarget target, Parameters parameters);
|
||||||
|
|
||||||
|
@ -84,7 +84,7 @@ public class ResponseBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public ResponseBuilder setContent(String content, Charset charset) {
|
public ResponseBuilder setContent(String content, Charset charset) {
|
||||||
String mimeType = response.headers.get("Content-Type");
|
String mimeType = getMimeType();
|
||||||
response.charset = charset;
|
response.charset = charset;
|
||||||
|
|
||||||
if (mimeType != null) {
|
if (mimeType != null) {
|
||||||
@ -118,13 +118,17 @@ public class ResponseBuilder {
|
|||||||
public Response build() {
|
public Response build() {
|
||||||
byte[] content = response.bytes;
|
byte[] content = response.bytes;
|
||||||
exceptionIf(content == null, "Content not defined for Response");
|
exceptionIf(content == null, "Content not defined for Response");
|
||||||
String mimeType = response.getHeaders().get("Content-Type");
|
String mimeType = getMimeType();
|
||||||
exceptionIf(content.length > 0 && mimeType == null, "MIME Type not defined for Response");
|
exceptionIf(content.length > 0 && mimeType == null, "MIME Type not defined for Response");
|
||||||
exceptionIf(content.length > 0 && mimeType.isEmpty(), "MIME Type empty for Response");
|
exceptionIf(content.length > 0 && mimeType.isEmpty(), "MIME Type empty for Response");
|
||||||
exceptionIf(response.code < 100 || response.code >= 600, "HTTP Status code out of bounds (" + response.code + ")");
|
exceptionIf(response.code < 100 || response.code >= 600, "HTTP Status code out of bounds (" + response.code + ")");
|
||||||
return response;
|
return response;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private String getMimeType() {
|
||||||
|
return response.headers.get("Content-Type");
|
||||||
|
}
|
||||||
|
|
||||||
private void exceptionIf(boolean value, String errorMsg) {
|
private void exceptionIf(boolean value, String errorMsg) {
|
||||||
if (value) throw new InvalidResponseException(errorMsg);
|
if (value) throw new InvalidResponseException(errorMsg);
|
||||||
}
|
}
|
||||||
|
@ -17,6 +17,7 @@
|
|||||||
package com.djrapitops.plan.delivery.web.resolver;
|
package com.djrapitops.plan.delivery.web.resolver;
|
||||||
|
|
||||||
import java.util.Arrays;
|
import java.util.Arrays;
|
||||||
|
import java.util.Collections;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Optional;
|
import java.util.Optional;
|
||||||
|
|
||||||
@ -34,6 +35,7 @@ public final class URLTarget {
|
|||||||
private List<String> parse(String target) {
|
private List<String> parse(String target) {
|
||||||
String[] partArray = target.split("/");
|
String[] partArray = target.split("/");
|
||||||
// Ignores index 0, assuming target starts with /
|
// Ignores index 0, assuming target starts with /
|
||||||
|
if (partArray.length == 1) return Collections.emptyList();
|
||||||
return Arrays.asList(partArray)
|
return Arrays.asList(partArray)
|
||||||
.subList(1, partArray.length);
|
.subList(1, partArray.length);
|
||||||
}
|
}
|
||||||
@ -63,4 +65,17 @@ public final class URLTarget {
|
|||||||
public boolean endsWith(String suffix) {
|
public boolean endsWith(String suffix) {
|
||||||
return full.endsWith(suffix);
|
return full.endsWith(suffix);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Immutable modification, removes first part of the target string.
|
||||||
|
* <p>
|
||||||
|
* Example: URLTarget "/example/target" return value of omitFirst URLTarget is "/target"
|
||||||
|
* Example: URLTarget "/example" return value of omitFirst URLTarget is "/"
|
||||||
|
* Example: URLTarget "/" return value of omitFirst URLTarget is ""
|
||||||
|
*
|
||||||
|
* @return new URLTarget with first part removed.
|
||||||
|
*/
|
||||||
|
public URLTarget omitFirst() {
|
||||||
|
return new URLTarget(full.replaceFirst("/" + getPart(0).orElse(""), ""));
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user