Skip to content

Commit 16d66b5

Browse files
Tais993Tais993
authored
Utility for in-app URL's (#391)
This adds the DiscordClientAction class, this class allows the user to generate URL's that link to items in the Discord app (a channel, settings screen, and more). Examples can be found in the class's Javadoc
1 parent 7ba661d commit 16d66b5

File tree

2 files changed

+296
-4
lines changed

2 files changed

+296
-4
lines changed

‎application/src/main/java/org/togetherjava/tjbot/commands/Features.java‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22

33
import net.dv8tion.jda.api.JDA;
44
import org.jetbrains.annotations.NotNull;
5-
import org.togetherjava.tjbot.commands.basic.PingCommand;
6-
import org.togetherjava.tjbot.commands.basic.RoleSelectCommand;
7-
import org.togetherjava.tjbot.commands.basic.SuggestionsUpDownVoter;
8-
import org.togetherjava.tjbot.commands.basic.VcActivityCommand;
5+
import org.togetherjava.tjbot.commands.basic.*;
96
import org.togetherjava.tjbot.commands.free.FreeCommand;
107
import org.togetherjava.tjbot.commands.mathcommands.TeXCommand;
118
import org.togetherjava.tjbot.commands.moderation.*;

‎application/src/main/java/org/togetherjava/tjbot/commands/utils/DiscordClientAction.java‎

Lines changed: 295 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,295 @@
1+
package org.togetherjava.tjbot.commands.utils;
2+
3+
import net.dv8tion.jda.api.interactions.components.Button;
4+
import net.dv8tion.jda.api.interactions.components.ButtonStyle;
5+
import org.jetbrains.annotations.Contract;
6+
import org.jetbrains.annotations.NotNull;
7+
8+
import java.util.regex.Pattern;
9+
10+
/**
11+
* Class which contains all actions a Discord client accepts.
12+
* <p>
13+
* This allows you to open DM's {@link Channels#DM_CHANNEL}, specific settings
14+
* {@link Settings.App#VOICE} and much more.
15+
*
16+
* <p>
17+
* A few notes;
18+
* <ul>
19+
* <li>iOS and Android are NOT supported</li>
20+
* <li>It opens the LAST installed Discord version (Discord, Canary, PTB)</li>
21+
* </ul>
22+
*
23+
* <p>
24+
* Example:
25+
*
26+
* <pre>
27+
* <code>
28+
* event.reply("Open Discord's secret home page!")
29+
* .addActionRow(DiscordClientAction.Guild.GUILD_HOME_CHANNEL.asLinkButton("Open home page!", event.getGuild().getId())
30+
* </code>
31+
* </pre>
32+
*
33+
* To improve readability, one might want to use a static import like:
34+
*
35+
* <pre>
36+
* <code>
37+
* event.reply(whoIsCommandOutput)
38+
* .addActionRow(USER.asLinkButton("Open home page!", target.getId())
39+
* </code>
40+
* </pre>
41+
*/
42+
public final class DiscordClientAction {
43+
44+
/**
45+
* Contains some of the more general actions
46+
*/
47+
public enum General {
48+
;
49+
50+
public static final DiscordClientAction HOME = new DiscordClientAction("discord://-/");
51+
public static final DiscordClientAction FRIENDS = new DiscordClientAction("discord://-/");
52+
53+
public static final DiscordClientAction USER =
54+
new DiscordClientAction("discord://-/users/{USER-ID}");
55+
public static final DiscordClientAction JOIN_INVITE =
56+
new DiscordClientAction("discord://-/invite/{INVITE-CODE}");
57+
public static final DiscordClientAction HUB_MEMBERSHIP_SCREENING =
58+
new DiscordClientAction("discord://-/member-verification-for-hub/{HUB-ID}");
59+
public static final DiscordClientAction STORE =
60+
new DiscordClientAction("discord://-/store");
61+
62+
public static final DiscordClientAction HYPESQUAD =
63+
new DiscordClientAction("discord://-/settings/hypesquad_online");
64+
public static final DiscordClientAction CHANGELOGS =
65+
new DiscordClientAction("discord://-/settings/changelogs");
66+
}
67+
68+
/**
69+
* Contains guild specific actions
70+
*/
71+
public enum Guild {
72+
;
73+
74+
@SuppressWarnings("squid:S1700")
75+
public static final DiscordClientAction GUILD =
76+
new DiscordClientAction("discord://-/channels/{GUILD-ID}");
77+
public static final DiscordClientAction GUILD_CHANNEL =
78+
new DiscordClientAction("discord://-/channels/{GUILD-ID}/{CHANNEL-ID}");
79+
80+
public static final DiscordClientAction GUILD_DISCOVERY =
81+
new DiscordClientAction("discord://-/guild-discovery");
82+
public static final DiscordClientAction GUILDS_CREATE =
83+
new DiscordClientAction("discord://-/guilds/create");
84+
85+
86+
public static final DiscordClientAction GUILD_EVENT =
87+
new DiscordClientAction("discord://-/events/{GUILD-ID}/{EVENT-ID}");
88+
public static final DiscordClientAction GUILD_MEMBERSHIP_SCREENING =
89+
new DiscordClientAction("discord://-/member-verification/{GUILD-ID}");
90+
91+
/**
92+
* Beta Discord feature
93+
*/
94+
public static final DiscordClientAction GUILD_HOME_CHANNEL =
95+
new DiscordClientAction("discord://-/channels/{GUILD-ID}/@home");
96+
}
97+
98+
/**
99+
* Contains actions related to channels
100+
*/
101+
public enum Channels {
102+
;
103+
104+
public static final DiscordClientAction DM_CHANNEL =
105+
new DiscordClientAction("discord://-/channels/@me/{CHANNEL-ID}");
106+
public static final DiscordClientAction DM_CHANNEL_MESSAGE =
107+
new DiscordClientAction("discord://-/channels/@me/{CHANNEL-ID}/{MESSAGE-ID}");
108+
public static final DiscordClientAction GUILD_CHANNEL =
109+
new DiscordClientAction("discord://-/channels/{GUILD-ID}/{CHANNEL-ID}");
110+
public static final DiscordClientAction GUILD_CHANNEL_MESSAGE = new DiscordClientAction(
111+
"discord://-/channels/{GUILD-ID}/{CHANNEL-ID}/{MESSAGE-ID}");
112+
}
113+
114+
/**
115+
* Contains actions related to the settings menu
116+
*/
117+
/*
118+
* The warning is about this inner class being too long, and that it should be external This
119+
* won't become an external class since it makes no sense for the design, and it requires the
120+
* developer to remember all classes.
121+
*/
122+
@SuppressWarnings("squid:S2972")
123+
public enum Settings {
124+
;
125+
126+
/**
127+
* Contains all user settings
128+
*/
129+
public enum User {
130+
;
131+
132+
public static final DiscordClientAction ACCOUNT =
133+
new DiscordClientAction("discord://-/settings/account");
134+
public static final DiscordClientAction PROFILE_CUSTOMIZATION =
135+
new DiscordClientAction("discord://-/settings/profile-customization");
136+
public static final DiscordClientAction PRIVACY_AND_SAFETY =
137+
new DiscordClientAction("discord://-/settings/privacy-and-safety");
138+
public static final DiscordClientAction AUTHORIZED_APPS =
139+
new DiscordClientAction("discord://-/settings/authorized-apps");
140+
public static final DiscordClientAction CONNECTIONS =
141+
new DiscordClientAction("discord://-/settings/connections");
142+
}
143+
144+
/**
145+
* Contains all payment settings
146+
*/
147+
public enum Payment {
148+
;
149+
150+
public static final DiscordClientAction PREMIUM =
151+
new DiscordClientAction("discord://-/settings/premium");
152+
public static final DiscordClientAction SUBSCRIPTIONS =
153+
new DiscordClientAction("discord://-/settings/subscriptions");
154+
public static final DiscordClientAction INVENTORY =
155+
new DiscordClientAction("discord://-/settings/inventory");
156+
public static final DiscordClientAction BILLING =
157+
new DiscordClientAction("discord://-/settings/billing");
158+
}
159+
160+
/**
161+
* Contains all app settings
162+
*/
163+
public enum App {
164+
;
165+
166+
public static final DiscordClientAction APPEARANCE =
167+
new DiscordClientAction("discord://-/settings/appearance");
168+
public static final DiscordClientAction ACCESSIBILITY =
169+
new DiscordClientAction("discord://-/settings/accessibility");
170+
public static final DiscordClientAction VOICE =
171+
new DiscordClientAction("discord://-/settings/voice");
172+
public static final DiscordClientAction TEXT =
173+
new DiscordClientAction("discord://-/settings/text");
174+
public static final DiscordClientAction NOTIFICATIONS =
175+
new DiscordClientAction("discord://-/settings/notifications");
176+
public static final DiscordClientAction KEYBINDS =
177+
new DiscordClientAction("discord://-/settings/keybinds");
178+
public static final DiscordClientAction LOCALE =
179+
new DiscordClientAction("discord://-/settings/locale");
180+
181+
/**
182+
* @see #LINUX
183+
*/
184+
public static final DiscordClientAction WINDOWS =
185+
new DiscordClientAction("discord://-/settings/windows");
186+
187+
/**
188+
* @see #WINDOWS
189+
*/
190+
public static final DiscordClientAction LINUX =
191+
new DiscordClientAction("discord://-/settings/linux");
192+
193+
public static final DiscordClientAction STREAMER_MODE =
194+
new DiscordClientAction("discord://-/settings/streamer-mode");
195+
public static final DiscordClientAction ADVANCED =
196+
new DiscordClientAction("discord://-/settings/advanced");
197+
}
198+
199+
/**
200+
* Contains some of the more general settings
201+
*/
202+
public enum General {
203+
;
204+
205+
public static final DiscordClientAction ACTIVITY_STATUS =
206+
new DiscordClientAction("discord://-/settings/activity-status");
207+
public static final DiscordClientAction ACTIVITY_OVERLAY =
208+
new DiscordClientAction("discord://-/settings/overlay");
209+
public static final DiscordClientAction HYPESQUAD =
210+
new DiscordClientAction("discord://-/settings/hypesquad_online");
211+
public static final DiscordClientAction CHANGELOGS =
212+
new DiscordClientAction("discord://-/settings/changelogs");
213+
}
214+
}
215+
216+
public enum Library {
217+
;
218+
219+
public static final DiscordClientAction LIBRARY_GAMES =
220+
new DiscordClientAction("discord://-/library");
221+
public static final DiscordClientAction LIBRARY_SETTINGS =
222+
new DiscordClientAction("discord://-/library/settings");
223+
public static final DiscordClientAction LIBRARY_ITEM_ACTION =
224+
new DiscordClientAction("discord://-/library/{SKU-ID}/LAUNCH");
225+
public static final DiscordClientAction SKU_STORE_PAGE =
226+
new DiscordClientAction("discord://-/store/skus/{SKU-ID}");
227+
public static final DiscordClientAction APPLICATION_STORE_PAGE =
228+
new DiscordClientAction("discord://-/store/applications/{APPLICATION-ID}");
229+
}
230+
231+
/**
232+
* Pattern for the arguments, finds everything within brackets
233+
*/
234+
public static final Pattern argumentPattern = Pattern.compile("\\{[^}]*}");
235+
236+
private final String url;
237+
238+
@Contract(pure = true)
239+
private DiscordClientAction(final String url) {
240+
this.url = url;
241+
}
242+
243+
/**
244+
* The raw URL without any arguments.
245+
*
246+
* <p>
247+
* Most likely you should use {@link #formatUrl(String...)} instead, that one throws when an
248+
* argument is lacking.
249+
*
250+
* @return A {@link String} of the URL
251+
* @see #formatUrl(String...)
252+
*/
253+
public String getRawUrl() {
254+
return url;
255+
}
256+
257+
/**
258+
* Format's the URL with the given arguments.
259+
*
260+
* @param arguments An array of the arguments this action requires
261+
* @return The formatted URL as an {@link String}
262+
* @throws IllegalArgumentException When missing arguments
263+
*/
264+
public String formatUrl(final String @NotNull... arguments) {
265+
String localUrl = url;
266+
267+
for (final String argument : arguments) {
268+
localUrl = argumentPattern.matcher(localUrl).replaceFirst(argument);
269+
}
270+
271+
if (argumentPattern.matcher(localUrl).find()) {
272+
throw new IllegalArgumentException("Missing arguments for URL " + localUrl + "!");
273+
}
274+
275+
return localUrl;
276+
}
277+
278+
/**
279+
* Format's the action as a link button.
280+
*
281+
* @param label The label of the button, see {@link Button#link(String, String)} for the
282+
* requirements
283+
* @param arguments An array of the arguments this action requires
284+
* @return A {@link Button} of {@link ButtonStyle#LINK} with the given label
285+
* @throws IllegalArgumentException When missing arguments
286+
*/
287+
public Button asLinkButton(@NotNull final String label, final String... arguments) {
288+
return Button.link(formatUrl(arguments), label);
289+
}
290+
291+
@Override
292+
public String toString() {
293+
return "DiscordClientAction{" + "url='" + url + '\'' + '}';
294+
}
295+
}

0 commit comments

Comments
 (0)