/
Permission.java
293 lines (262 loc) · 10.8 KB
/
Permission.java
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* 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
*
* http://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 net.dv8tion.jda.api;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.Nonnull;
import java.util.Arrays;
import java.util.Collection;
import java.util.EnumSet;
import java.util.stream.Collectors;
/**
* Represents the bit offsets used by Discord for Permissions.
*/
public enum Permission
{
CREATE_INSTANT_INVITE(0, true, true, "Create Instant Invite"),
KICK_MEMBERS( 1, true, false, "Kick Members"),
BAN_MEMBERS( 2, true, false, "Ban Members"),
ADMINISTRATOR( 3, true, false, "Administrator"),
MANAGE_CHANNEL( 4, true, true, "Manage Channels"),
MANAGE_SERVER( 5, true, false, "Manage Server"),
MESSAGE_ADD_REACTION( 6, true, true, "Add Reactions"),
VIEW_AUDIT_LOGS( 7, true, false, "View Audit Logs"),
PRIORITY_SPEAKER( 8, true, true, "Priority Speaker"),
VIEW_GUILD_INSIGHTS(19, true, false, "View Server Insights"),
// Applicable to all channel types
VIEW_CHANNEL( 10, true, true, "Read Text Channels & See Voice Channels"),
// Text Permissions
MESSAGE_READ( 10, true, true, "Read Messages"),
MESSAGE_WRITE( 11, true, true, "Send Messages"),
MESSAGE_TTS( 12, true, true, "Send TTS Messages"),
MESSAGE_MANAGE( 13, true, true, "Manage Messages"),
MESSAGE_EMBED_LINKS( 14, true, true, "Embed Links"),
MESSAGE_ATTACH_FILES( 15, true, true, "Attach Files"),
MESSAGE_HISTORY( 16, true, true, "Read History"),
MESSAGE_MENTION_EVERYONE(17, true, true, "Mention Everyone"),
MESSAGE_EXT_EMOJI( 18, true, true, "Use External Emojis"),
USE_SLASH_COMMANDS( 31, true, true, "Use Slash Commands"),
// Voice Permissions
VOICE_STREAM( 9, true, true, "Video"),
VOICE_CONNECT( 20, true, true, "Connect"),
VOICE_SPEAK( 21, true, true, "Speak"),
VOICE_MUTE_OTHERS(22, true, true, "Mute Members"),
VOICE_DEAF_OTHERS(23, true, true, "Deafen Members"),
VOICE_MOVE_OTHERS(24, true, true, "Move Members"),
VOICE_USE_VAD( 25, true, true, "Use Voice Activity"),
NICKNAME_CHANGE(26, true, false, "Change Nickname"),
NICKNAME_MANAGE(27, true, false, "Manage Nicknames"),
MANAGE_ROLES( 28, true, false, "Manage Roles"),
MANAGE_PERMISSIONS(28, false, true, "Manage Permissions"),
MANAGE_WEBHOOKS( 29, true, true, "Manage Webhooks"),
MANAGE_EMOTES( 30, true, false, "Manage Emojis"),
REQUEST_TO_SPEAK( 32, true, true, "Request to Speak"),
UNKNOWN(-1, false, false, "Unknown");
/**
* Empty array of Permission enum, useful for optimized use in {@link java.util.Collection#toArray(Object[])}.
*/
// This is an optimization suggested by Effective Java 3rd Edition - Item 54
public static final Permission[] EMPTY_PERMISSIONS = new Permission[0];
/**
* Represents a raw set of all permissions
*/
public static final long ALL_PERMISSIONS = Permission.getRaw(Permission.values());
/**
* All permissions that apply to a channel
*/
public static final long ALL_CHANNEL_PERMISSIONS = Permission.getRaw(Arrays.stream(values())
.filter(Permission::isChannel).collect(Collectors.toSet()));
/**
* All Guild specific permissions which are only available to roles
*/
public static final long ALL_GUILD_PERMISSIONS = Permission.getRaw(Arrays.stream(values())
.filter(Permission::isGuild).collect(Collectors.toSet()));
/**
* All text channel specific permissions which are only available in text channel permission overrides
*/
public static final long ALL_TEXT_PERMISSIONS
= Permission.getRaw(MESSAGE_ADD_REACTION, MESSAGE_WRITE, MESSAGE_TTS,
MESSAGE_MANAGE, MESSAGE_EMBED_LINKS, MESSAGE_ATTACH_FILES,
MESSAGE_HISTORY, MESSAGE_MENTION_EVERYONE, USE_SLASH_COMMANDS);
/**
* All voice channel specific permissions which are only available in voice channel permission overrides
*/
public static final long ALL_VOICE_PERMISSIONS
= Permission.getRaw(VOICE_STREAM, VOICE_CONNECT, VOICE_SPEAK, VOICE_MUTE_OTHERS,
VOICE_DEAF_OTHERS, VOICE_MOVE_OTHERS, VOICE_USE_VAD, PRIORITY_SPEAKER, REQUEST_TO_SPEAK);
private final int offset;
private final long raw;
private final boolean isGuild, isChannel;
private final String name;
Permission(int offset, boolean isGuild, boolean isChannel, @Nonnull String name)
{
this.offset = offset;
this.raw = 1L << offset;
this.isGuild = isGuild;
this.isChannel = isChannel;
this.name = name;
}
/**
* The readable name as used in the Discord client.
*
* @return The readable name of this {@link net.dv8tion.jda.api.Permission Permission}.
*/
@Nonnull
public String getName()
{
return this.name;
}
/**
* The binary offset of the permission.
* <br>For more information about Discord's offset system refer to
* <a href="https://discord.com/developers/docs/topics/permissions">Discord Permissions</a>.
*
* @return The offset that represents this {@link net.dv8tion.jda.api.Permission Permission}.
*/
public int getOffset()
{
return offset;
}
/**
* The value of this permission when viewed as a raw value.
* <br>This is equivalent to: <code>1 {@literal <<} {@link #getOffset()}</code>
*
* @return The raw value of this specific permission.
*/
public long getRawValue()
{
return raw;
}
/**
* Returns whether or not this Permission is present at the Guild level
* (configurable via {@link net.dv8tion.jda.api.entities.Role Roles})
*
* @return True if this permission is present at the Guild level.
*/
public boolean isGuild()
{
return isGuild;
}
/**
* Returns whether or not this Permission is present Channel level
* (configurable via {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionsOverrides})
*
* @return True if this permission is present at the Channel level.
*/
public boolean isChannel()
{
return isChannel;
}
/**
* Whether this permission is specifically for {@link net.dv8tion.jda.api.entities.TextChannel TextChannels}
*
* @return True, if and only if this permission can only be applied to text channels
*/
public boolean isText()
{
return (raw & ALL_TEXT_PERMISSIONS) == raw;
}
/**
* Whether this permission is specifically for {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannels}
*
* @return True, if and only if this permission can only be applied to voice channels
*/
public boolean isVoice()
{
return (raw & ALL_VOICE_PERMISSIONS) == raw;
}
/**
* Gets the first {@link net.dv8tion.jda.api.Permission Permission} relating to the provided offset.
* <br>If there is no {@link net.dv8tion.jda.api.Permission Permssions} that matches the provided
* offset, {@link net.dv8tion.jda.api.Permission#UNKNOWN Permission.UNKNOWN} is returned.
*
* @param offset
* The offset to match a {@link net.dv8tion.jda.api.Permission Permission} to.
*
* @return {@link net.dv8tion.jda.api.Permission Permission} relating to the provided offset.
*/
@Nonnull
public static Permission getFromOffset(int offset)
{
for (Permission perm : values())
{
if (perm.offset == offset)
return perm;
}
return UNKNOWN;
}
/**
* A set of all {@link net.dv8tion.jda.api.Permission Permissions} that are specified by this raw long representation of
* permissions. The is best used with the getRaw methods in {@link net.dv8tion.jda.api.entities.Role Role} or
* {@link net.dv8tion.jda.api.entities.PermissionOverride PermissionOverride}.
*
* <p>Example: {@link net.dv8tion.jda.api.entities.Role#getPermissionsRaw() Role.getPermissionsRaw()}
*
* @param permissions
* The raw {@code long} representation of permissions.
*
* @return Possibly-empty EnumSet of {@link net.dv8tion.jda.api.Permission Permissions}.
*
*/
@Nonnull
public static EnumSet<Permission> getPermissions(long permissions)
{
if (permissions == 0)
return EnumSet.noneOf(Permission.class);
EnumSet<Permission> perms = EnumSet.noneOf(Permission.class);
for (Permission perm : Permission.values())
{
if (perm != UNKNOWN && (permissions & perm.raw) == perm.raw)
perms.add(perm);
}
return perms;
}
/**
* This is effectively the opposite of {@link #getPermissions(long)}, this takes 1 or more {@link net.dv8tion.jda.api.Permission Permissions}
* and returns the raw offset {@code long} representation of the permissions.
*
* @param permissions
* The array of permissions of which to form into the raw long representation.
*
* @return Unsigned long representing the provided permissions.
*/
public static long getRaw(@Nonnull Permission... permissions)
{
long raw = 0;
for (Permission perm : permissions)
{
if (perm != null && perm != UNKNOWN)
raw |= perm.raw;
}
return raw;
}
/**
* This is effectively the opposite of {@link #getPermissions(long)}, this takes a Collection of {@link net.dv8tion.jda.api.Permission Permissions}
* and returns the raw offset {@code long} representation of the permissions.
* <br>Example: {@code getRaw(EnumSet.of(Permission.MESSAGE_READ, Permission.MESSAGE_WRITE))}
*
* @param permissions
* The Collection of permissions of which to form into the raw long representation.
*
* @return Unsigned long representing the provided permissions.
*
* @see java.util.EnumSet EnumSet
*/
public static long getRaw(@Nonnull Collection<Permission> permissions)
{
Checks.notNull(permissions, "Permission Collection");
return getRaw(permissions.toArray(EMPTY_PERMISSIONS));
}
}