1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*
* This file is part of fabric-permissions-api, licensed under the MIT License.
*
* Copyright (c) lucko (Luck) <[email protected]>
* 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.fabric.api.permissions.v0;
import net.fabricmc.fabric.api.util.TriState;
import net.minecraft.command.CommandSource;
import net.minecraft.entity.Entity;
import net.minecraft.server.command.ServerCommandSource;
import org.jetbrains.annotations.NotNull;
import java.util.Objects;
import java.util.function.Predicate;
/**
* A simple permissions API.
*/
public interface Permissions {
/**
* Gets the {@link TriState state} of a {@code permission} for the given source.
*
* @param source the source
* @param permission the permission
* @return the state of the permission
*/
static @NotNull TriState getPermissionValue(@NotNull CommandSource source, @NotNull String permission) {
Objects.requireNonNull(source, "source");
Objects.requireNonNull(permission, "permission");
return PermissionCheckEvent.EVENT.invoker().onPermissionCheck(source, permission);
}
/**
* Performs a permission check, falling back to the {@code defaultValue} if the resultant
* state is {@link TriState#DEFAULT}.
*
* @param source the source to perform the check for
* @param permission the permission to check
* @param defaultValue the default value to use if nothing has been set
* @return the result of the permission check
*/
static boolean check(@NotNull CommandSource source, @NotNull String permission, boolean defaultValue) {
return getPermissionValue(source, permission).orElse(defaultValue);
}
/**
* Performs a permission check, falling back to requiring the {@code defaultRequiredLevel}
* if the resultant state is {@link TriState#DEFAULT}.
*
* @param source the source to perform the check for
* @param permission the permission to check
* @param defaultRequiredLevel the required permission level to check for as a fallback
* @return the result of the permission check
*/
static boolean check(@NotNull CommandSource source, @NotNull String permission, int defaultRequiredLevel) {
return getPermissionValue(source, permission).orElseGet(() -> source.hasPermissionLevel(defaultRequiredLevel));
}
/**
* Performs a permission check, falling back to {@code false} if the resultant state
* is {@link TriState#DEFAULT}.
*
* @param source the source to perform the check for
* @param permission the permission to check
* @return the result of the permission check
*/
static boolean check(@NotNull CommandSource source, @NotNull String permission) {
return getPermissionValue(source, permission).orElse(false);
}
/**
* Creates a predicate which returns the result of performing a permission check,
* falling back to the {@code defaultValue} if the resultant state is {@link TriState#DEFAULT}.
*
* @param permission the permission to check
* @param defaultValue the default value to use if nothing has been set
* @return a predicate that will perform the permission check
*/
static @NotNull Predicate<ServerCommandSource> require(@NotNull String permission, boolean defaultValue) {
Objects.requireNonNull(permission, "permission");
return player -> check(player, permission, defaultValue);
}
/**
* Creates a predicate which returns the result of performing a permission check,
* falling back to requiring the {@code defaultRequiredLevel} if the resultant state is
* {@link TriState#DEFAULT}.
*
* @param permission the permission to check
* @param defaultRequiredLevel the required permission level to check for as a fallback
* @return a predicate that will perform the permission check
*/
static @NotNull Predicate<ServerCommandSource> require(@NotNull String permission, int defaultRequiredLevel) {
Objects.requireNonNull(permission, "permission");
return player -> check(player, permission, defaultRequiredLevel);
}
/**
* Creates a predicate which returns the result of performing a permission check,
* falling back to {@code false} if the resultant state is {@link TriState#DEFAULT}.
*
* @param permission the permission to check
* @return a predicate that will perform the permission check
*/
static @NotNull Predicate<ServerCommandSource> require(@NotNull String permission) {
Objects.requireNonNull(permission, "permission");
return player -> check(player, permission);
}
/**
* Gets the {@link TriState state} of a {@code permission} for the given entity.
*
* @param entity the entity
* @param permission the permission
* @return the state of the permission
*/
static @NotNull TriState getPermissionValue(@NotNull Entity entity, @NotNull String permission) {
Objects.requireNonNull(entity, "entity");
return getPermissionValue(entity.getCommandSource(), permission);
}
/**
* Performs a permission check, falling back to the {@code defaultValue} if the resultant
* state is {@link TriState#DEFAULT}.
*
* @param entity the entity to perform the check for
* @param permission the permission to check
* @param defaultValue the default value to use if nothing has been set
* @return the result of the permission check
*/
static boolean check(@NotNull Entity entity, @NotNull String permission, boolean defaultValue) {
Objects.requireNonNull(entity, "entity");
return check(entity.getCommandSource(), permission, defaultValue);
}
/**
* Performs a permission check, falling back to requiring the {@code defaultRequiredLevel}
* if the resultant state is {@link TriState#DEFAULT}.
*
* @param entity the entity to perform the check for
* @param permission the permission to check
* @param defaultRequiredLevel the required permission level to check for as a fallback
* @return the result of the permission check
*/
static boolean check(@NotNull Entity entity, @NotNull String permission, int defaultRequiredLevel) {
Objects.requireNonNull(entity, "entity");
return check(entity.getCommandSource(), permission, defaultRequiredLevel);
}
/**
* Performs a permission check, falling back to {@code false} if the resultant state
* is {@link TriState#DEFAULT}.
*
* @param entity the entity to perform the check for
* @param permission the permission to check
* @return the result of the permission check
*/
static boolean check(@NotNull Entity entity, @NotNull String permission) {
Objects.requireNonNull(entity, "entity");
return check(entity.getCommandSource(), permission);
}
}
|
