/
MessagePaginationAction.java
150 lines (133 loc) · 4.8 KB
/
MessagePaginationAction.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
/*
* Copyright 2015-2018 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.requests.restaction.pagination;
import net.dv8tion.jda.core.Permission;
import net.dv8tion.jda.core.entities.*;
import net.dv8tion.jda.core.exceptions.InsufficientPermissionException;
import net.dv8tion.jda.core.requests.Request;
import net.dv8tion.jda.core.requests.Response;
import net.dv8tion.jda.core.requests.Route;
import org.json.JSONArray;
import org.json.JSONException;
import java.util.ArrayList;
import java.util.List;
/**
* {@link net.dv8tion.jda.core.requests.restaction.pagination.PaginationAction PaginationAction}
* that paginates the endpoints {@link net.dv8tion.jda.core.requests.Route.Messages#GET_MESSAGE_HISTORY Route.Messages.GET_MESSAGE_HISTORY}.
*
* <p><b>Must provide not-null {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel} to compile a valid
* pagination route.</b>
*
* <h2>Limits:</h2>
* Minimum - 1
* <br>Maximum - 100
*
* <h1>Example</h1>
* <pre><code>
* /**
* * Iterates messages in an async stream and stops once the limit has been reached.
* */
* public static void onEachMessageAsync(MessageChannel channel, {@literal Consumer<Message>} consumer, int limit)
* {
* if (limit{@literal <} 1)
* return;
* <u>MessagePaginationAction</u> action = channel.<u>getIterableHistory</u>();
* AtomicInteger counter = new AtomicInteger(limit);
* action.forEachAsync( (message){@literal ->}
* {
* consumer.accept(message);
* // if false the iteration is terminated; else it continues
* return counter.decrementAndGet() == 0;
* });
* }
* </code></pre>
*
* @since 3.1
* @author Florian Spieß
*/
public class MessagePaginationAction extends PaginationAction<Message, MessagePaginationAction>
{
private final MessageChannel channel;
public MessagePaginationAction(MessageChannel channel)
{
super(channel.getJDA(), Route.Messages.GET_MESSAGE_HISTORY.compile(channel.getId()), 1, 100, 100);
if (channel.getType() == ChannelType.TEXT)
{
TextChannel textChannel = (TextChannel) channel;
if (!textChannel.getGuild().getSelfMember().hasPermission(textChannel, Permission.MESSAGE_HISTORY))
throw new InsufficientPermissionException(Permission.MESSAGE_HISTORY);
}
this.channel = channel;
}
/**
* The {@link net.dv8tion.jda.core.entities.ChannelType ChannelType} of
* the targeted {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
*
* @return {@link net.dv8tion.jda.core.entities.ChannelType ChannelType}
*/
public ChannelType getType()
{
return getChannel().getType();
}
/**
* The targeted {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}
*
* @return The MessageChannel instance
*/
public MessageChannel getChannel()
{
return channel;
}
@Override
protected Route.CompiledRoute finalizeRoute()
{
Route.CompiledRoute route = super.finalizeRoute();
final String limit = String.valueOf(this.getLimit());
final Message last = this.last;
route = route.withQueryParams("limit", limit);
if (last != null)
route = route.withQueryParams("before", last.getId());
return route;
}
@Override
protected void handleResponse(Response response, Request<List<Message>> request)
{
if (!response.isOk())
{
request.onFailure(response);
return;
}
JSONArray array = response.getArray();
List<Message> messages = new ArrayList<>(array.length());
EntityBuilder builder = api.getEntityBuilder();
for (int i = 0; i < array.length(); i++)
{
try
{
Message msg = builder.createMessage(array.getJSONObject(i), channel, false);
messages.add(msg);
if (useCache)
cached.add(msg);
last = msg;
}
catch (JSONException | NullPointerException e)
{
LOG.warn("Encountered an exception in MessagePagination", e);
}
}
request.onSuccess(messages);
}
}