-
-
Notifications
You must be signed in to change notification settings - Fork 724
/
WebhookManagerUpdatable.java
287 lines (264 loc) · 11.6 KB
/
WebhookManagerUpdatable.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
/*
* 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.*;
import net.dv8tion.jda.core.exceptions.PermissionException;
import net.dv8tion.jda.core.managers.fields.WebhookField;
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 org.apache.http.util.Args;
import org.json.JSONObject;
/**
* An {@link #update() updatable} manager that allows
* to modify webhook settings like the {@link #getNameField() default name} or the {@link #getAvatarField() default avatar}.
*
* <p>This manager allows to modify multiple fields at once
* by getting the {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField} for specific
* properties and setting or resetting their values; followed by a call of {@link #update()}!
*
* <p>The {@link net.dv8tion.jda.core.managers.WebhookManager WebhookManager} 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_WEBHOOKS MANAGE_WEBHOOKS} in the parent TextChannel
*/
public class WebhookManagerUpdatable
{
protected final Webhook webhook;
protected WebhookField<String> name;
protected WebhookField<Icon> avatar;
protected WebhookField<TextChannel> channel;
/**
* Creates a new WebhookManagerUpdatable instance
*
* @param webhook
* The target {@link net.dv8tion.jda.core.entities.Webhook Webhook} to modify
*/
public WebhookManagerUpdatable(Webhook webhook)
{
this.webhook = webhook;
setupFields();
}
/**
* The {@link net.dv8tion.jda.core.JDA JDA} instance of this Manager
*
* @return the corresponding JDA instance
*/
public JDA getJDA()
{
return webhook.getJDA();
}
/**
* The {@link net.dv8tion.jda.core.entities.Guild Guild} this Manager's
* {@link net.dv8tion.jda.core.entities.Webhook Webhook} is in.
* <br>This is logically the same as calling {@code getWebhook().getGuild()}
*
* @return The parent {@link net.dv8tion.jda.core.entities.Guild Guild}
*/
public Guild getGuild()
{
return webhook.getGuild();
}
/**
* The {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} this Manager's
* {@link net.dv8tion.jda.core.entities.Webhook Webhook} is in.
* <br>This is logically the same as calling {@code getWebhook().getChannel()}
*
* @return The parent {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
*/
public TextChannel getChannel()
{
return webhook.getChannel();
}
/**
* The target {@link net.dv8tion.jda.core.entities.Webhook Webhook}
* that will be modified by this manager
*
* @return The target {@link net.dv8tion.jda.core.entities.Webhook Webhook}
*/
public Webhook getWebhook()
{
return webhook;
}
/**
* A {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField}
* for the <b><u>name</u></b> of the selected {@link net.dv8tion.jda.core.entities.Webhook Webhook}'s {@link Webhook#getDefaultUser() default User}.
* <br>Default value: Not given
*
* <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.WebhookField WebhookField} instance.
*
* <p>A Webhook name <b>must bot</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.WebhookField WebhookField} - Type: {@code String}
*/
public WebhookField<String> getNameField()
{
return name;
}
/**
* A {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField}
* for the <b><u>avatar</u></b> of the selected {@link net.dv8tion.jda.core.entities.Webhook Webhook}'s {@link Webhook#getDefaultUser() default User}.
* <br>Default value: {@code null}
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) setValue(Icon)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField} instance.
*
* @return {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField} - Type: {@link net.dv8tion.jda.core.entities.Icon}
*/
public WebhookField<Icon> getAvatarField()
{
return avatar;
}
/**
* A {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField}
* for the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* of the selected {@link net.dv8tion.jda.core.entities.Webhook Webhook}'s {@link Webhook#getDefaultUser() default User}.
* <br>Default value: Not given
*
* <p>To set the value use {@link net.dv8tion.jda.core.managers.fields.Field#setValue(Object) setValue(TextChannel)}
* on the returned {@link net.dv8tion.jda.core.managers.fields.WebhookField WebhookField} instance.
*
* <p>A Webhook channel <b>must bot</b> be {@code null} and <b>must</b> be from the same {@link net.dv8tion.jda.core.entities.Guild Guild}!
* <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.WebhookField WebhookField} - Type: {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
*/
public WebhookField<TextChannel> getChannelField()
{
return channel;
}
/**
* 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();
avatar.reset();
channel.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_CHANNEL UNKNOWN_CHANNEL}
* <br>If the TextChannel 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_WEBHOOKS MANAGE_WEBHOOKS Permission}</li>
* </ul>
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If the currently logged in account does not have the Permission {@link net.dv8tion.jda.core.Permission#MANAGE_WEBHOOKS MANAGE_WEBHOOKS}
* in either the current or selected new TextChannel.
*
* @return {@link net.dv8tion.jda.core.requests.restaction.AuditableRestAction AuditableRestAction}
* <br>Applies all changes that have been made in a single api-call.
*/
public AuditableRestAction<Void> update()
{
Member self = getGuild().getSelfMember();
if (!self.hasPermission(webhook.getChannel(), Permission.MANAGE_WEBHOOKS))
throw new PermissionException(Permission.MANAGE_WEBHOOKS);
if (channel.isSet() && !self.hasPermission(channel.getValue(), Permission.MANAGE_WEBHOOKS))
throw new PermissionException(Permission.MANAGE_WEBHOOKS, "Permission not available in selected new channel");
if (!shouldUpdate())
return new AuditableRestAction.EmptyRestAction<>(getJDA(), null);
JSONObject data = new JSONObject();
data.put("name", name.getOriginalValue());
if (channel.shouldUpdate())
data.put("channel_id", channel.getValue().getId());
if (name.shouldUpdate())
data.put("name", name.getValue());
if (avatar.shouldUpdate())
{
Icon value = avatar.getValue();
data.put("avatar", value != null ? value.getEncoding() : JSONObject.NULL);
}
Route.CompiledRoute route = Route.Webhooks.MODIFY_WEBHOOK.compile(webhook.getId());
return new AuditableRestAction<Void>(getJDA(), route, data)
{
@Override
protected void handleResponse(Response response, Request<Void> request)
{
if (response.isOk())
request.onSuccess(null);
else
request.onFailure(response);
}
};
}
protected boolean shouldUpdate()
{
return name.shouldUpdate()
|| avatar.shouldUpdate()
|| channel.shouldUpdate();
}
protected void setupFields()
{
name = new WebhookField<String>(this, webhook::getName)
{
@Override
public void checkValue(String value)
{
Args.notNull(value, "default name");
}
};
avatar = new WebhookField<Icon>(this, null)
{
@Override
public void checkValue(Icon value) { }
@Override
public Icon getOriginalValue()
{
throw new UnsupportedOperationException("Cannot easily provide the original Avatar. Use User#getIconUrl() and download it yourself.");
}
@Override
public boolean shouldUpdate()
{
return isSet();
}
};
channel = new WebhookField<TextChannel>(this, webhook::getChannel)
{
@Override
public void checkValue(TextChannel value)
{
Args.notNull(value, "channel");
Args.check(value.equals(getChannel()), "Channel is not from the same Guild!");
}
};
}
}