Implement Permissions API

api/src/main/java/me/lokka30/treasury/api/permission/PermissionsProvider.java

@@ -0,0 +1,28 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission;
+
+import java.util.Collection;
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+import me.lokka30.treasury.api.common.response.Response;
+import me.lokka30.treasury.api.permission.node.NodeFactory;
+import me.lokka30.treasury.api.permission.node.holder.NodeHolderGroup;
+import me.lokka30.treasury.api.permission.node.holder.NodeHolderPlayer;
+import org.jetbrains.annotations.NotNull;
+
+public interface PermissionsProvider {
+
+    @NotNull NodeFactory nodeFactory();
+
+    @NotNull CompletableFuture<Response<NodeHolderPlayer>> retrievePlayerNodeHolder(@NotNull UUID uuid);
+
+    @NotNull CompletableFuture<Response<Collection<UUID>>> allPlayerNodeHolderIds();
+
+    @NotNull CompletableFuture<Response<NodeHolderGroup>> retrieveOrCreateGroup(@NotNull String groupId);
+
+    @NotNull CompletableFuture<Response<Collection<String>>> allGroupNodeHolderIds();
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/context/Context.java

@@ -0,0 +1,39 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.context;
+
+import java.util.Objects;
+import java.util.function.BiPredicate;
+import me.lokka30.treasury.api.permission.node.holder.NodeHolder;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+public interface Context {
+
+    Context GLOBAL = Context.of("global", ($, $1) -> true);
+
+    @Contract(value = "_, _ -> new", pure = true)
+    @NotNull
+    static Context of(@NotNull String key, @NotNull BiPredicate<NodeHolder, String> condition) {
+        Objects.requireNonNull(key, "key");
+        Objects.requireNonNull(condition, "condition");
+        return new Context() {
+            @Override
+            public @NotNull String getKey() {
+                return key;
+            }
+
+            @Override
+            public @NotNull BiPredicate<NodeHolder, String> getCondition() {
+                return condition;
+            }
+        };
+    }
+
+    @NotNull String getKey();
+
+    @NotNull BiPredicate<NodeHolder, String> getCondition();
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/context/ContextSet.java

@@ -0,0 +1,75 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.context;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+
+public final class ContextSet {
+
+    private static final ContextSet EMPTY = new ContextSet(Collections.emptyMap());
+
+    @NotNull
+    public static ContextSet empty() {
+        return EMPTY;
+    }
+
+    @NotNull
+    public static ContextSet of(@NotNull Context @NotNull ... contexts) {
+        Objects.requireNonNull(contexts, "contexts");
+        if (contexts.length == 0) {
+            return empty();
+        }
+        Map<String, Context> map = new ConcurrentHashMap<>();
+        for (Context context : contexts) {
+            map.put(context.getKey(), context);
+        }
+        return new ContextSet(map);
+    }
+
+    private Map<String, Context> contexts;
+
+    @Contract(pure = true)
+    private ContextSet(Map<String, Context> contexts) {
+        this.contexts = contexts;
+    }
+
+    @NotNull
+    public Optional<Context> getContext(@NotNull String contextKey) {
+        Objects.requireNonNull(contextKey, "contextKey");
+        return Optional.ofNullable(this.contexts.get(contextKey));
+    }
+
+    public void registerContext(@NotNull Context context) {
+        Objects.requireNonNull(context, "context");
+        if (!this.contexts.containsKey(context.getKey())) {
+            this.contexts.put(context.getKey(), context);
+            return;
+        }
+        throw new IllegalArgumentException("Context already registered in this context set");
+    }
+
+    public boolean hasContext(@NotNull String contextKey) {
+        Objects.requireNonNull(contextKey, "contextKey");
+        return contexts.containsKey(contextKey);
+    }
+
+    @NotNull
+    public Set<Context> asSet() {
+        if (this.contexts.isEmpty()) {
+            return Collections.emptySet();
+        }
+        Set<Context> ret = ConcurrentHashMap.newKeySet();
+        ret.addAll(this.contexts.values());
+        return ret;
+    }
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/Node.java

@@ -0,0 +1,28 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node;
+
+import me.lokka30.treasury.api.permission.context.ContextSet;
+import me.lokka30.treasury.api.permission.node.type.NodeType;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public interface Node<Data> {
+
+    @NotNull NodeType<Data> nodeType();
+
+    @NotNull ContextSet contexts();
+
+    @Nullable Integer weight();
+
+    @NotNull String key();
+
+    @NotNull Data data();
+
+    @NotNull Node<Data> copyWithNewData(
+            @NotNull ContextSet contexts, @Nullable Integer weight, @NotNull Data data
+    );
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/NodeFactory.java

@@ -0,0 +1,50 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node;
+
+import me.lokka30.treasury.api.common.misc.TriState;
+import me.lokka30.treasury.api.permission.context.Context;
+import me.lokka30.treasury.api.permission.context.ContextSet;
+import me.lokka30.treasury.api.permission.node.type.PermissionNode;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public abstract class NodeFactory {
+
+    @NotNull
+    public PermissionNode createPermissionNode(@NotNull String permission) {
+        return this.createPermissionNode(permission, ContextSet.of(Context.GLOBAL));
+    }
+
+    @NotNull
+    public PermissionNode createPermissionNode(
+            @NotNull String permission, @NotNull ContextSet contextSet
+    ) {
+        return this.createPermissionNode(permission, contextSet, (Integer) null);
+    }
+
+    @NotNull
+    public PermissionNode createPermissionNode(
+            @NotNull String permission, @NotNull ContextSet contextSet, @Nullable Integer weight
+    ) {
+        return this.createPermissionNode(permission, contextSet, weight, TriState.UNSPECIFIED);
+    }
+
+    @NotNull
+    public PermissionNode createPermissionNode(
+            @NotNull String permission, @NotNull ContextSet contextSet, @NotNull TriState value
+    ) {
+        return this.createPermissionNode(permission, contextSet, null, value);
+    }
+
+    @NotNull
+    public abstract PermissionNode createPermissionNode(
+            @NotNull String permission,
+            @NotNull ContextSet contextSet,
+            @Nullable Integer weight,
+            @NotNull TriState value
+    );
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/holder/NodeHolder.java

@@ -0,0 +1,42 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node.holder;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
+import me.lokka30.treasury.api.common.misc.TriState;
+import me.lokka30.treasury.api.common.response.Response;
+import me.lokka30.treasury.api.permission.node.Node;
+import me.lokka30.treasury.api.permission.node.type.NodeType;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public interface NodeHolder {
+
+    @NotNull String getIdentifier();
+
+    @Nullable NodeHolder parentNodeHolder();
+
+    @NotNull CompletableFuture<Response<Collection<Node<?>>>> allNodes();
+
+    @NotNull CompletableFuture<Response<Map<String, NodeType<?>>>> allNodesKeys();
+
+    @NotNull <Data> CompletableFuture<Response<Collection<Node<Data>>>> allNodesWithType(@NotNull NodeType<Data> nodeType);
+
+    @NotNull CompletableFuture<Response<TriState>> hasNode(@NotNull String nodeKey);
+
+    @NotNull <Data> CompletableFuture<Response<Optional<Node<Data>>>> retrieveNode(
+            @NotNull String key, @NotNull NodeType<Data> nodeType
+    );
+
+    @NotNull <Data> CompletableFuture<Response<TriState>> insertOrModifyNode(
+            @NotNull Node<Data> node, @NotNull NodeType<Data> nodeType
+    );
+
+    @NotNull CompletableFuture<Response<TriState>> removeNode(@NotNull String nodeKey);
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/holder/NodeHolderGroup.java

@@ -0,0 +1,9 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node.holder;
+
+public interface NodeHolderGroup extends NodeHolder {
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/holder/NodeHolderPlayer.java

@@ -0,0 +1,57 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node.holder;
+
+import java.util.Objects;
+import java.util.Optional;
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+import me.lokka30.treasury.api.common.misc.TriState;
+import me.lokka30.treasury.api.common.response.Response;
+import me.lokka30.treasury.api.permission.context.ContextSet;
+import me.lokka30.treasury.api.permission.node.Node;
+import me.lokka30.treasury.api.permission.node.type.NodeType;
+import org.jetbrains.annotations.NotNull;
+
+public interface NodeHolderPlayer extends NodeHolder {
+
+    @NotNull UUID getUniqueId();
+
+    @Override
+    @NotNull
+    default String getIdentifier() {
+        return this.getUniqueId().toString();
+    }
+
+    /**
+     * Returns whether the specified {@link ContextSet context set} applies for this player node
+     * holder.
+     * <p>By "applies" it is meant that all the
+     * {@link me.lokka30.treasury.api.permission.context.Context contexts} defined in the
+     * specified context set's conditions are met.
+     *
+     * @param contextSet context set to probe
+     * @return applies or not.
+     */
+    boolean contextSetApplies(@NotNull ContextSet contextSet);
+
+    @NotNull
+    default CompletableFuture<Response<TriState>> hasPermission(@NotNull String nodeKey) {
+        Objects.requireNonNull(nodeKey, "nodeKey");
+        return retrieveNode(nodeKey, NodeType.PERMISSION).thenApply(resp -> {
+            if (!resp.isSuccessful()) {
+                return Response.failure(resp.getFailureReason());
+            }
+            Optional<Node<TriState>> nodeOpt = resp.getResult();
+            if (!nodeOpt.isPresent()) {
+                return Response.success(TriState.UNSPECIFIED);
+            }
+            return Response.success(TriState.fromBoolean(this.contextSetApplies(nodeOpt
+                    .get()
+                    .contexts())));
+        });
+    }
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/type/NodeType.java

@@ -0,0 +1,25 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node.type;
+
+import me.lokka30.treasury.api.common.misc.TriState;
+import org.jetbrains.annotations.NotNull;
+
+public final class NodeType<Data> {
+
+    public static final NodeType<TriState> PERMISSION = new NodeType<>(TriState.class);
+
+    private final Class<Data> dataClass;
+
+    private NodeType(@NotNull Class<Data> dataClass) {
+        this.dataClass = dataClass;
+    }
+
+    @NotNull
+    public Class<Data> dataClass() {
+        return this.dataClass;
+    }
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/type/PermissionNode.java

@@ -0,0 +1,20 @@
+/*
+ * This file is/was part of Treasury. To read more information about Treasury such as its licensing, see <https://github.com/ArcanePlugins/Treasury>.
+ */
+
+package me.lokka30.treasury.api.permission.node.type;
+
+import me.lokka30.treasury.api.common.misc.TriState;
+import me.lokka30.treasury.api.permission.node.Node;
+import me.lokka30.treasury.api.permission.node.type.NodeType;
+import org.jetbrains.annotations.NotNull;
+
+public interface PermissionNode extends Node<TriState> {
+
+    @Override
+    @NotNull
+    default NodeType<TriState> nodeType() {
+        return NodeType.PERMISSION;
+    }
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/type/PrefixNode.java

@@ -0,0 +1,6 @@
+package me.lokka30.treasury.api.permission.node.type;
+
+// todo
+public interface PrefixNode {
+
+}

api/src/main/java/me/lokka30/treasury/api/permission/node/type/SuffixNode.java

@@ -0,0 +1,6 @@
+package me.lokka30.treasury.api.permission.node.type;
+
+// todo
+public interface SuffixNode {
+
+}