Merge pull request ib-ai#79 from ib-ai/button-roles

Button roles

Author: Arraying

Dockerfile

@@ -1,5 +1,5 @@
 # Using maven base image for building with maven.
-FROM maven:latest AS builder
+FROM maven:3.8.1-openjdk-11 AS builder
 
 LABEL "repository"="https://github.com/ib-ai/IB.ai/"
 LABEL "homepage"="https://discord.gg/IBO/"
@@ -14,7 +14,8 @@ RUN mvn dependency:go-offline
 
 # Build from source into ./target/*.jar
 COPY src ./src
-RUN mvn -e -B package
+# We don't want checkstyle in development...
+RUN mvn -e -B package -Dcheckstyle.skip
 
 # Using Java JDK 10 base image
 FROM openjdk:10

lang/en/command_aliases.json

@@ -7,6 +7,7 @@
 
   "avatar": ["avatar", "av"],
   "blacklist": ["blacklist", "hackban"],
+  "buttonroles": ["buttonrole", "br"],
   "cassowary": ["cassowary", "casso"],
   "catpic": ["catpic", "cat"],
   "channelorder": ["channelorder", "co"],

lang/en/error.json

@@ -8,6 +8,7 @@
   "blacklist_fail": "Blacklist failed. Is the ID correct and valid?",
   "blacklist_id": "You need to specify a valid number ID.",
   "blacklist_present": "You cannot blacklist someone who is already on the server. If you would like to get rid of them please ban them manually.",
+  "buttonrole_integrity": "One of the integrity constraints were violated. Need a non-empty array, each element consisting of colour (primary|secondary|success|danger), ?emoji, ?row, label (80) and a non-empty array of roles. More than 4 roles per element is not allowed.",
   "cassowary_id": "One or more of the role IDs you entered was invalid.",
   "category_invalid":  "The category provided is invalid or does not exist.",
   "embed_field_format": "Please provide the field in the following form: `\"Title\" \"Value\"`",

pom.xml

@@ -185,7 +185,7 @@
         <dependency>
             <groupId>net.dv8tion</groupId>
             <artifactId>JDA</artifactId>
-            <version>4.2.1_256</version>
+            <version>4.2.1_266</version>
         </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>

src/main/java/com/ibdiscord/IBai.java

@@ -25,6 +25,7 @@
 import com.ibdiscord.exceptions.JavaVersionException;
 import com.ibdiscord.i18n.LocaleException;
 import com.ibdiscord.i18n.LocaliserHandler;
+import com.ibdiscord.listeners.ButtonListener;
 import com.ibdiscord.listeners.FilterListener;
 import com.ibdiscord.listeners.GuildListener;
 import com.ibdiscord.listeners.MessageListener;
@@ -101,7 +102,9 @@ private void init() {
                             config.getBotVersion(),
                             config.getStaticPrefix()))
                     )
-                    .addEventListeners(new FilterListener(),
+                    .setRawEventsEnabled(true)
+                    .addEventListeners(new ButtonListener(),
+                            new FilterListener(),
                             new GuildListener(),
                             new MessageListener(),
                             new MonitorListener(),

src/main/java/com/ibdiscord/button/ButtonCallbackAction.java

@@ -0,0 +1,74 @@
+/* Copyright 2017-2021 Arraying
+ *
+ * This file is part of IB.ai.
+ *
+ * IB.ai is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * IB.ai is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with IB.ai. If not, see http://www.gnu.org/licenses/.
+ */
+
+package com.ibdiscord.button;
+
+import net.dv8tion.jda.api.JDA;
+import net.dv8tion.jda.api.utils.data.DataObject;
+import net.dv8tion.jda.internal.requests.Requester;
+import net.dv8tion.jda.internal.requests.RestActionImpl;
+import net.dv8tion.jda.internal.requests.Route;
+import okhttp3.RequestBody;
+
+/**
+ * Wrapper for an interaction callback.
+ */
+public final class ButtonCallbackAction extends RestActionImpl<Void> {
+
+    private final int added;
+    private final int removed;
+
+    /**
+     * Creates the callback.
+     * @param api The API.
+     * @param id The ID.
+     * @param token The token.
+     * @param added The number of roles added.
+     * @param removed The number of roles removed.
+     */
+    public ButtonCallbackAction(JDA api, String id, String token, int added, int removed) {
+        super(api, Route.post(String.format("/interactions/%s/%s/callback", id, token)).compile());
+        this.added = added;
+        this.removed = removed;
+    }
+
+    /**
+     * Sends the correct payload.
+     * @return The payload.
+     */
+    @Override
+    protected RequestBody finalizeData() {
+        DataObject dataObject = DataObject.empty();
+        dataObject.put("type", 4);
+        DataObject message = DataObject.empty();
+        String content;
+        if (added > 0 && removed == 0) {
+            content = "Added " + added + " role(s).";
+        } else if (removed > 0 && added == 0) {
+            content = "Removed " + removed + " role(s).";
+        } else if(added > 0 && removed > 0) {
+            content = "Added " + added + " role(s) and removed " + removed + " role(s).";
+        } else {
+            content = "Did not update roles";
+        }
+        message.put("content", content);
+        message.put("flags", 64); // Only send to the user.
+        dataObject.put("data", message);
+        return RequestBody.create(Requester.MEDIA_TYPE_JSON, dataObject.toJson());
+    }
+}

src/main/java/com/ibdiscord/button/ButtonColour.java

@@ -0,0 +1,47 @@
+/* Copyright 2017-2021 Arraying
+ *
+ * This file is part of IB.ai.
+ *
+ * IB.ai is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * IB.ai is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with IB.ai. If not, see http://www.gnu.org/licenses/.
+ */
+
+package com.ibdiscord.button;
+
+/**
+ * Different types a button can be.
+ * Omitted: link.
+ */
+public enum ButtonColour {
+
+    /**
+     * Discord Blue.
+     */
+    PRIMARY,
+
+    /**
+     * Grey.
+     */
+    SECONDARY,
+
+    /**
+     * Green.
+     */
+    SUCCESS,
+
+    /**
+     * Red.
+     */
+    DANGER
+
+}

src/main/java/com/ibdiscord/button/ButtonEmoji.java

@@ -0,0 +1,89 @@
+/* Copyright 2017-2021 Arraying
+ *
+ * This file is part of IB.ai.
+ *
+ * IB.ai is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * IB.ai is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with IB.ai. If not, see http://www.gnu.org/licenses/.
+ */
+
+package com.ibdiscord.button;
+
+import lombok.RequiredArgsConstructor;
+import net.dv8tion.jda.api.utils.data.DataObject;
+
+import java.util.regex.Pattern;
+
+/**
+ * Represents a button emoji.
+ */
+@RequiredArgsConstructor
+public final class ButtonEmoji {
+
+    private static Pattern EMOTE_PATTERN = Pattern.compile("^<(?:a)?:(\\S{2,32}):(\\d{17,20})>$");
+    private final boolean emoji;
+    private final String id;
+    private final String name;
+    private final boolean animated;
+
+    /**
+     * Gets the emoji from a string.
+     * @param input The string.
+     * @return A possibly null emoji.
+     */
+    public static ButtonEmoji parse(String input) {
+        if (input == null) {
+            return null;
+        }
+        input = input.trim();
+        if (EMOTE_PATTERN.matcher(input).matches()) {
+            String[] pieces = input.split(":");
+            String animated = pieces[1];
+            String name = pieces[1];
+            String id = pieces[2].replaceAll("\\D", "");
+            return new ButtonEmoji(false, id, name, animated.contains("a"));
+        } else {
+            return new ButtonEmoji(true, null, input, false);
+        }
+    }
+
+    /**
+     * Wraps the emoji as JSON.
+     * @return A JSON object.
+     */
+    public DataObject get() {
+        DataObject dataObject = DataObject.empty();
+        if (emoji) {
+            dataObject.putNull("id");
+            dataObject.put("name", name);
+        } else {
+            dataObject.put("id", id);
+            dataObject.put("name", name);
+            dataObject.put("animated", animated);
+        }
+        return dataObject;
+    }
+
+    /**
+     * Debugging friendly representation.
+     * @return The string.
+     */
+    @Override
+    public String toString() {
+        return "ButtonEmoji{"
+            + "emoji=" + emoji
+            + ", id='" + id + '\''
+            + ", name='" + name + '\''
+            + ", animated=" + animated
+            + '}';
+    }
+}

src/main/java/com/ibdiscord/button/ButtonMessageAction.java

@@ -0,0 +1,96 @@
+/* Copyright 2017-2021 Arraying
+ *
+ * This file is part of IB.ai.
+ *
+ * IB.ai is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * IB.ai is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with IB.ai. If not, see http://www.gnu.org/licenses/.
+ */
+
+package com.ibdiscord.button;
+
+import net.dv8tion.jda.api.JDA;
+import net.dv8tion.jda.api.entities.MessageChannel;
+import net.dv8tion.jda.api.entities.TextChannel;
+import net.dv8tion.jda.api.utils.data.DataArray;
+import net.dv8tion.jda.api.utils.data.DataObject;
+import net.dv8tion.jda.internal.requests.Route;
+import net.dv8tion.jda.internal.requests.restaction.MessageActionImpl;
+
+import java.util.List;
+
+public final class ButtonMessageAction extends MessageActionImpl {
+
+    private final List<ButtonRole> buttons;
+
+    /**
+     * Creates the new action.
+     * @param api The API.
+     * @param route The route.
+     * @param channel The channel.
+     * @param message The message to send.
+     * @param buttons The buttons.
+     */
+    private ButtonMessageAction(JDA api, Route.CompiledRoute route, MessageChannel channel, String message, List<ButtonRole> buttons) {
+        super(api, route, channel, new StringBuilder().append(message));
+        this.buttons = buttons;
+    }
+
+    /**
+     * Creates a message which has button reactions.
+     * This will use one action row.
+     * @param channel The channel.
+     * @param message The message to send.
+     * @param roles A list of button reaction roles.
+     * @return An action, which can be queued.
+     */
+    public static ButtonMessageAction create(TextChannel channel, String message, List<ButtonRole> roles) {
+        Route.CompiledRoute route = Route.Messages.SEND_MESSAGE.compile(channel.getId());
+        return new ButtonMessageAction(channel.getJDA(), route, channel, message, roles);
+    }
+
+    /**
+     * Gets the message as JSON.
+     * Here, we inject the custom button stuff.
+     * @return A data object of messages.
+     */
+    @Override
+    protected DataObject getJSON() {
+        final DataObject dataObject = super.getJSON();
+        final DataArray componentsOuter = DataArray.empty();
+        for (int i = 0; i < 5; i++) {
+            final DataObject actionRow = DataObject.empty();
+            final DataArray componentsInner = DataArray.empty();
+            for (ButtonRole button : buttons) {
+                if (button.getRow() != i) {
+                    continue;
+                }
+                DataObject clickable = DataObject.empty();
+                clickable.put("type", 2);
+                clickable.put("label", button.getName());
+                clickable.put("style", button.getColour().ordinal() + 1);
+                clickable.put("custom_id", button.getRoles());
+                if (button.getEmoji() != null) {
+                    clickable.put("emoji", button.getEmoji().get());
+                }
+                componentsInner.add(clickable);
+            }
+            if (componentsInner.length() > 0) {
+                actionRow.put("type", 1);
+                actionRow.put("components", componentsInner);
+                componentsOuter.add(actionRow);
+            }
+        }
+        dataObject.put("components", componentsOuter);
+        return dataObject;
+    }
+}