-
-
Notifications
You must be signed in to change notification settings - Fork 724
/
RoleManagerUpdatable.java
347 lines (317 loc) · 13.9 KB
/
RoleManagerUpdatable.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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
/*
* Copyright 2015-2017 Austin Keener & Michael Ritter & Florian Spieß
*
* 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.core.managers;
import net.dv8tion.jda.core.JDA;
import net.dv8tion.jda.core.Permission;
import net.dv8tion.jda.core.entities.Guild;
import net.dv8tion.jda.core.entities.Role;
import net.dv8tion.jda.core.exceptions.HierarchyException;
import net.dv8tion.jda.core.exceptions.InsufficientPermissionException;
import net.dv8tion.jda.core.managers.fields.PermissionField;
import net.dv8tion.jda.core.managers.fields.RoleField;
import net.dv8tion.jda.core.requests.Request;
import net.dv8tion.jda.core.requests.Response;
import net.dv8tion.jda.core.requests.Route;
import net.dv8tion.jda.core.requests.restaction.AuditableRestAction;
import net.dv8tion.jda.core.utils.Checks;
import org.json.JSONObject;
import javax.annotation.CheckReturnValue;
import java.awt.Color;
/**
* An {@link #update() updatable} manager that allows
* to modify role settings like the {@link #getNameField() name} or the {@link #getColorField() color}.
*
* <p>This manager allows to modify multiple fields at once
* by getting the {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} for specific
* properties and setting or resetting their values; followed by a call of {@link #update()}!
* <br>Default values depend on the inherited properties of the <u>Public Role</u> in the parent Guild.
*
* <p>The {@link net.dv8tion.jda.core.managers.RoleManager RoleManager} implementation
* simplifies this process by giving simple setters that return the {@link #update() update} {@link net.dv8tion.jda.core.requests.RestAction RestAction}
*
* <p><b>Note</b>: To {@link #update() update} this manager
* the currently logged in account requires the Permission {@link net.dv8tion.jda.core.Permission#MANAGE_ROLES MANAGE_ROLES} and
* must be more powerful according to Discord hierarchy rules (positional strength). [ee {@link Role#canInteract(net.dv8tion.jda.core.entities.Role) Role.canInteract(Role)}]
*/
public class RoleManagerUpdatable
{
protected final Role role;
protected RoleField<String> name;
protected RoleField<Color> color;
protected RoleField<Boolean> hoisted;
protected RoleField<Boolean> mentionable;
protected PermissionField permissions;
/**
* Creates a new RoleManagerUpdatable instance
*
* @param role
* The {@link net.dv8tion.jda.core.entities.Role Role} to manage
*/
public RoleManagerUpdatable(Role role)
{
this.role = role;
setupFields();
}
/**
* The {@link net.dv8tion.jda.core.JDA JDA} instance of this Manager
*
* @return the corresponding JDA instance
*/
public JDA getJDA()
{
return role.getJDA();
}
/**
* The {@link net.dv8tion.jda.core.entities.Guild Guild} this Manager's
* {@link net.dv8tion.jda.core.entities.Role Role} is in.
* <br>This is logically the same as calling {@code getRole().getGuild()}
*
* @return The parent {@link net.dv8tion.jda.core.entities.Guild Guild}
*/
public Guild getGuild()
{
return role.getGuild();
}
/**
* The target {@link net.dv8tion.jda.core.entities.Role Role} for this
* manager
*
* @return The target Role
*/
public Role getRole()
{
return role;
}
/**
* An {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField}
* for the <b><u>name</u></b> of the selected {@link net.dv8tion.jda.core.entities.Role Role}.
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) setValue(String)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} instance.
*
* <p>A role name <b>must</b> be between 1-32 characters long!
* <br>Otherwise {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) Field.setValue(...)} will
* throw an {@link IllegalArgumentException IllegalArgumentException}.
*
* @return {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} - Type: {@code String}
*/
public RoleField<String> getNameField()
{
return name;
}
/**
* An {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField}
* for the <b><u>color</u></b> of the selected {@link net.dv8tion.jda.core.entities.Role Role}.
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) setValue(Color)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} instance.
* <br>Provide {@code null} or {@link Color#BLACK black} to use the default color.
*
* @return {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} - Type: {@link java.awt.Color Color}
*/
public RoleField<Color> getColorField()
{
return color;
}
/**
* An {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField}
* for the <b><u>hoist state</u></b> of the selected {@link net.dv8tion.jda.core.entities.Role Role}.
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) setValue(Boolean)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} instance.
*
* <p>A role hoist state <b>must not</b> be {@code null}!
* <br>Otherwise {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) Field.setValue(...)} will
* throw an {@link IllegalArgumentException IllegalArgumentException}.
*
* @return {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} - Type: {@code Boolean}
*/
public RoleField<Boolean> getHoistedField()
{
return hoisted;
}
/**
* An {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField}
* for the <b><u>mentionable state</u></b> of the selected {@link net.dv8tion.jda.core.entities.Role Role}.
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) setValue(Boolean)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} instance.
*
* <p>A role mentionable state <b>must not</b> be {@code null}!
* <br>Otherwise {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) Field.setValue(...)} will
* throw an {@link IllegalArgumentException IllegalArgumentException}.
*
* @return {@link net.dv8tion.jda.core.managers.fields.RoleField RoleField} - Type: {@code Boolean}
*/
public RoleField<Boolean> getMentionableField()
{
return mentionable;
}
/**
* An {@link net.dv8tion.jda.core.managers.fields.PermissionField PermissionField}
* for the {@link net.dv8tion.jda.core.Permission Permissions} of the selected {@link net.dv8tion.jda.core.entities.Role Role}.
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.PermissionField#setPermissions(Permission...) setPermissions(Permission...)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.PermissionField PermissionField} instance.
*
* <p>A role permissions <b>must not</b> be {@code null}!
* <br>Otherwise the {@link net.dv8tion.jda.core.managers.fields.PermissionField PermissionField} will
* throw an {@link IllegalArgumentException IllegalArgumentException}.
*
* @return {@link net.dv8tion.jda.core.managers.fields.PermissionField PermissionField}
*/
public PermissionField getPermissionField()
{
return permissions;
}
/**
* Resets all {@link net.dv8tion.jda.core.managers.fields.Field Fields}
* for this manager instance by calling {@link net.dv8tion.jda.core.managers.fields.Field#reset() Field.reset()} sequentially
* <br>This is automatically called by {@link #update()}
*/
public void reset() {
name.reset();
color.reset();
hoisted.reset();
mentionable.reset();
permissions.reset();
}
/**
* Creates a new {@link net.dv8tion.jda.core.requests.RestAction RestAction} instance
* that will apply <b>all</b> changes that have been made to this manager instance.
* <br>If no changes have been made this will simply return {@link net.dv8tion.jda.core.requests.RestAction.EmptyRestAction EmptyRestAction}.
*
* <p>Before applying new changes it is recommended to call {@link #reset()} to reset previous changes.
* <br>This is automatically called if this method returns successfully.
*
* <p>Possible {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} for this
* update include the following:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_ROLE UNKNOWN_ROLE}
* <br>If the Role was deleted before finishing the task</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>If the currently logged in account was removed from the Guild before finishing the task</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>If the currently logged in account loses the {@link net.dv8tion.jda.core.Permission#MANAGE_ROLES MANAGE_ROLES Permission} or lost
* positional power before finishing the task</li>
* </ul>
*
* @throws net.dv8tion.jda.core.exceptions.InsufficientPermissionException
* If the currently logged in account does not have the Permission {@link net.dv8tion.jda.core.Permission#MANAGE_ROLES MANAGE_ROLES}
* @throws net.dv8tion.jda.core.exceptions.HierarchyException
* If the currently logged in account does not meet the required hierarchy position
* to {@link Role#canInteract(net.dv8tion.jda.core.entities.Role) interact} with this Role
*
* @return {@link net.dv8tion.jda.core.requests.restaction.AuditableRestAction AuditableRestAction}
* <br>Applies all changes that have been made in a single api-call.
*/
@CheckReturnValue
public AuditableRestAction<Void> update()
{
checkPermission(Permission.MANAGE_ROLES);
checkPosition();
if (!needsUpdate())
return new AuditableRestAction.EmptyRestAction<>(getJDA(), null);
//TODO: check if all of this is *actually* needed.
JSONObject body = new JSONObject().put("name", role.getName());
if(name.shouldUpdate())
body.put("name", name.getValue());
if(color.shouldUpdate())
body.put("color", color.getValue() == null ? 0 : color.getValue().getRGB() & 0xFFFFFF);
if(hoisted.shouldUpdate())
body.put("hoist", hoisted.getValue().booleanValue());
if(mentionable.shouldUpdate())
body.put("mentionable", mentionable.getValue().booleanValue());
if (permissions.shouldUpdate())
body.put("permissions", permissions.getValue());
reset();
Route.CompiledRoute route = Route.Roles.MODIFY_ROLE.compile(getGuild().getId(), role.getId());
return new AuditableRestAction<Void>(getJDA(), route, body)
{
@Override
protected void handleResponse(Response response, Request<Void> request)
{
if (response.isOk())
request.onSuccess(null);
else
request.onFailure(response);
}
};
}
protected boolean needsUpdate()
{
return name.shouldUpdate()
|| color.shouldUpdate()
|| hoisted.shouldUpdate()
|| mentionable.shouldUpdate()
|| permissions.shouldUpdate();
}
protected void checkPermission(Permission perm)
{
if (!getGuild().getSelfMember().hasPermission(perm))
throw new InsufficientPermissionException(perm);
}
protected void checkPosition()
{
if(!getGuild().getSelfMember().canInteract(role))
throw new HierarchyException("Can't modify role >= highest self-role");
}
protected void setupFields()
{
this.name = new RoleField<String>(this, role::getName)
{
@Override
public void checkValue(String value)
{
Checks.notNull(value, "name");
if (value.isEmpty() || value.length() > 32)
throw new IllegalArgumentException("Provided role name must be 1 to 32 characters in length");
}
};
this.color = new RoleField<Color>(this, role::getColor)
{
@Override
public RoleManagerUpdatable setValue(Color color)
{
if (color != null && color.getRGB() == 0)
color = null;
super.setValue(color);
return manager;
}
@Override
public void checkValue(Color value) {}
};
this.hoisted = new RoleField<Boolean>(this, role::isHoisted)
{
@Override
public void checkValue(Boolean value)
{
Checks.notNull(value, "hoisted Boolean");
}
};
this.mentionable = new RoleField<Boolean>(this, role::isMentionable)
{
@Override
public void checkValue(Boolean value)
{
Checks.notNull(value, "mentionable Boolean");
}
};
this.permissions = new PermissionField(this, role::getPermissionsRaw);
}
}