me.lucko.luckperms.api.Contexts Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of luckperms-api Show documentation
An advanced permissions plugin for Bukkit/Spigot, BungeeCord, Sponge, Nukkit and Velocity.
The newest version!
/*
 * This file is part of LuckPerms, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) 
 *  Copyright (c) contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package me.lucko.luckperms.api;

import me.lucko.luckperms.api.context.ContextSet;
import me.lucko.luckperms.api.context.ImmutableContextSet;

import org.checkerframework.checker.nullness.qual.NonNull;

import java.util.Objects;
import java.util.Set;

/**
 * Encapsulates the {@link ContextSet contexts} and {@link LookupSetting settings} for
 * a permission or meta lookup.
 *
 * This class is immutable.
 *
 * @since 2.11
 */
public class Contexts {

    /**
     * The context key used to denote the subjects server
     */
    public static final String SERVER_KEY = "server";

    /**
     * The context key used to denote the subjects world
     */
    public static final String WORLD_KEY = "world";

    /**
     * The default {@link LookupSetting}s as a flag.
     */
    private static final byte DEFAULT_SETTINGS_FLAG = LookupSetting.createFlag(
            LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER,
            LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD,
            LookupSetting.RESOLVE_INHERITANCE,
            LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER,
            LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD
    );

    /**
     * A 'global' or default contexts instance.
     *
     * Formed of an empty {@link ContextSet} and all inclusion and
     * inheritance {@link LookupSetting}s applied.
     */
    private static final Contexts GLOBAL = new Contexts(ImmutableContextSet.empty(), DEFAULT_SETTINGS_FLAG);

    /**
     * Gets the {@link FullySatisfiedContexts} instance.
     *
     * @return a context that will satisfy all contextual requirements.
     */
    public static @NonNull Contexts allowAll() {
        return FullySatisfiedContexts.getInstance();
    }

    /**
     * Returns a 'global' or default contexts instance.
     *
     * Formed of an empty {@link ContextSet} and all inclusion and
     * inheritance {@link LookupSetting}s applied.
     *
     * @return the global contexts
     * @since 3.3
     */
    public static @NonNull Contexts global() {
        return GLOBAL;
    }

    /**
     * Creates a new {@link Contexts} instance.
     *
     * @param contextSet the context set
     * @param includeNodesSetWithoutServer the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}
     * @param includeNodesSetWithoutWorld the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}
     * @param resolveInheritance the value of {@link LookupSetting#RESOLVE_INHERITANCE}
     * @param applyParentsWithoutServer the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}
     * @param applyParentsWithoutWorld the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}
     * @param isOp the value of {@link LookupSetting#IS_OP}
     * @return a new instance
     */
    public static @NonNull Contexts of(@NonNull ContextSet contextSet, boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) {
        Objects.requireNonNull(contextSet, "contextSet");
        byte settingsFlag = LookupSetting.createFlag(
                includeNodesSetWithoutServer,
                includeNodesSetWithoutWorld,
                resolveInheritance,
                applyParentsWithoutServer,
                applyParentsWithoutWorld,
                isOp
        );
        if (contextSet.isEmpty() && DEFAULT_SETTINGS_FLAG == settingsFlag) {
            return GLOBAL;
        }
        return new Contexts(contextSet.makeImmutable(), settingsFlag);
    }

    /**
     * Creates a new {@link Contexts} instance.
     *
     * @param contextSet the context set
     * @param settings the settings
     * @return a new instance
     */
    public static Contexts of(@NonNull ContextSet contextSet, @NonNull Set settings) {
        Objects.requireNonNull(contextSet, "contextSet");
        Objects.requireNonNull(settings, "settings");

        byte settingsFlag = LookupSetting.createFlag(settings);
        if (contextSet.isEmpty() && DEFAULT_SETTINGS_FLAG == settingsFlag) {
            return GLOBAL;
        }

        return new Contexts(contextSet.makeImmutable(), settingsFlag);
    }

    /**
     * The contexts that apply for this lookup
     */
    private final ImmutableContextSet contextSet;

    /**
     * The settings for this lookup
     */
    private final byte settingsFlag;

    // cache hashcode - this class is immutable, and is used as an index in the permission cache.
    private final int hashCode;

    /**
     * Creates a new {@link Contexts} instance.
     *
     * @param contextSet the context set
     * @param includeNodesSetWithoutServer the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}
     * @param includeNodesSetWithoutWorld the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}
     * @param resolveInheritance the value of {@link LookupSetting#RESOLVE_INHERITANCE}
     * @param applyParentsWithoutServer the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}
     * @param applyParentsWithoutWorld the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}
     * @param isOp the value of {@link LookupSetting#IS_OP}
     * @deprecated in favour of {@link #of(ContextSet, boolean, boolean, boolean, boolean, boolean, boolean)}
     */
    @Deprecated
    public Contexts(@NonNull ContextSet contextSet, boolean includeNodesSetWithoutServer, boolean includeNodesSetWithoutWorld, boolean resolveInheritance, boolean applyParentsWithoutServer, boolean applyParentsWithoutWorld, boolean isOp) {
        this.contextSet = Objects.requireNonNull(contextSet, "contextSet").makeImmutable();
        this.settingsFlag = LookupSetting.createFlag(
                includeNodesSetWithoutServer,
                includeNodesSetWithoutWorld,
                resolveInheritance,
                applyParentsWithoutServer,
                applyParentsWithoutWorld,
                isOp
        );
        this.hashCode = calculateHashCode();
    }

    protected Contexts(@NonNull ImmutableContextSet contextSet, byte settingsFlag) {
        this.contextSet = contextSet;
        this.settingsFlag = settingsFlag;
        this.hashCode = calculateHashCode();
    }

    /**
     * Gets the {@link ContextSet set of context pairs} for this {@link Contexts} instance.
     *
     * @return an immutable context from this instance
     * @since 2.13
     */
    public @NonNull ContextSet getContexts() {
        return this.contextSet;
    }

    /**
     * Gets the set of {@link LookupSetting}s for this {@link Contexts} instance.
     *
     * @return the settings
     * @since 4.2
     */
    public @NonNull Set getSettings() {
        return LookupSetting.createSetFromFlag(this.settingsFlag);
    }

    /**
     * Creates a copy of this {@link Contexts} instance, but with the
     * {@link ContextSet set of context pairs} replaced by the given set.
     *
     * @param contextSet the context set
     * @return a new contexts instance representing the new settings
     * @since 4.4
     */
    public @NonNull Contexts setContexts(@NonNull ContextSet contextSet) {
        ImmutableContextSet cs = Objects.requireNonNull(contextSet, "contextSet").makeImmutable();
        if (this.contextSet.equals(cs)) {
            return this;
        }
        return new Contexts(cs, this.settingsFlag);
    }

    /**
     * Creates a copy of this {@link Contexts} instance, but with the
     * {@link LookupSetting}s replaced by the given settings.
     *
     * @param settings the lookup settings
     * @return a new contexts instance representing the new settings
     * @since 4.4
     */
    public @NonNull Contexts setSettings(@NonNull Set settings) {
        Objects.requireNonNull(settings, "settings");

        byte settingsFlag = LookupSetting.createFlag(settings);
        if (this.settingsFlag == settingsFlag) {
            return this;
        }
        if (DEFAULT_SETTINGS_FLAG == settingsFlag && this.contextSet.isEmpty()) {
            return GLOBAL;
        }

        return new Contexts(this.contextSet, settingsFlag);
    }

    /**
     * Gets if the given {@link LookupSetting} is set.
     *
     * @param setting the setting
     * @return the value
     * @since 4.2
     */
    public boolean hasSetting(@NonNull LookupSetting setting) {
        return LookupSetting.isSet(this.settingsFlag, setting);
    }

    /**
     * Gets the value of {@link LookupSetting#IS_OP}.
     *
     * @return the value
     * @see LookupSetting#IS_OP
     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
     */
    @Deprecated
    public boolean isOp() {
        return hasSetting(LookupSetting.IS_OP);
    }

    /**
     * Gets the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER}.
     *
     * @return the value
     * @see LookupSetting#INCLUDE_NODES_SET_WITHOUT_SERVER
     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
     */
    @Deprecated
    public boolean isIncludeGlobal() {
        return hasSetting(LookupSetting.INCLUDE_NODES_SET_WITHOUT_SERVER);
    }

    /**
     * Gets the value of {@link LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD}.
     *
     * @return the value
     * @see LookupSetting#INCLUDE_NODES_SET_WITHOUT_WORLD
     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
     */
    @Deprecated
    public boolean isIncludeGlobalWorld() {
        return hasSetting(LookupSetting.INCLUDE_NODES_SET_WITHOUT_WORLD);
    }

    /**
     * Gets the value of {@link LookupSetting#RESOLVE_INHERITANCE}.
     *
     * @return the value
     * @see LookupSetting#RESOLVE_INHERITANCE
     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
     */
    @Deprecated
    public boolean isApplyGroups() {
        return hasSetting(LookupSetting.RESOLVE_INHERITANCE);
    }

    /**
     * Gets the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER}.
     *
     * @return the value
     * @see LookupSetting#APPLY_PARENTS_SET_WITHOUT_SERVER
     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
     */
    @Deprecated
    public boolean isApplyGlobalGroups() {
        return hasSetting(LookupSetting.APPLY_PARENTS_SET_WITHOUT_SERVER);
    }

    /**
     * Gets the value of {@link LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD}.
     *
     * @return the value
     * @see LookupSetting#APPLY_PARENTS_SET_WITHOUT_WORLD
     * @deprecated in favour of {@link #hasSetting(LookupSetting)}
     */
    @Deprecated
    public boolean isApplyGlobalWorldGroups() {
        return hasSetting(LookupSetting.APPLY_PARENTS_SET_WITHOUT_WORLD);
    }

    @Override
    public @NonNull String toString() {
        return "Contexts(contextSet=" + this.contextSet + ", settings=" + LookupSetting.createSetFromFlag(this.settingsFlag) + ")";
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) return true;
        if (o == allowAll()) return false;
        if (!(o instanceof Contexts)) return false;
        final Contexts that = (Contexts) o;
        return this.contextSet.equals(that.contextSet) && this.settingsFlag == that.settingsFlag;
    }

    private int calculateHashCode() {
        final int PRIME = 59;
        int result = 1;
        result = result * PRIME + this.contextSet.hashCode();
        result = result * PRIME + this.settingsFlag;
        return result;
    }

    @Override
    public int hashCode() {
        return this.hashCode;
    }

}