feat: move JDA parsers into commons (#18)

cloud-discord-common/src/main/java/org/incendo/cloud/discord/legacy/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Support for legacy parsing.
+ */
+package org.incendo.cloud.discord.legacy;

cloud-discord-common/src/main/java/org/incendo/cloud/discord/legacy/parser/DiscordChannelParser.java

@@ -0,0 +1,173 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.discord.legacy.parser;
+
+import cloud.commandframework.arguments.parser.ArgumentParseResult;
+import cloud.commandframework.context.CommandContext;
+import cloud.commandframework.context.CommandInput;
+import java.util.Collection;
+import java.util.Objects;
+import java.util.Set;
+import org.apiguardian.api.API;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.incendo.cloud.discord.legacy.repository.DiscordRepository;
+
+/**
+ * Parser for Discord channels.
+ *
+ * @param <C> command sender type
+ * @param <G> guild type
+ * @param <T> channel type
+ * @since 1.0.0
+ */
+@API(status = API.Status.INTERNAL, since = "1.0.0")
+public abstract class DiscordChannelParser<C, G, T> extends MentionableDiscordParser<C, G, T> {
+
+    protected DiscordChannelParser(final @NonNull Set<DiscordParserMode> modes) {
+        super(modes);
+    }
+
+    @Override
+    public final @NonNull ArgumentParseResult<T> parse(
+            @NonNull final CommandContext<@NonNull C> commandContext,
+            @NonNull final CommandInput commandInput
+    ) {
+        final ArgumentParseResult<T> preProcessed = this.preProcess(commandContext);
+        if (preProcessed != null) {
+            return preProcessed;
+        }
+
+        final String input = commandInput.readString();
+        final DiscordRepository<G, T> repository = this.repository(commandContext);
+
+        Exception exception = null;
+
+        if (this.modes().contains(DiscordParserMode.MENTION)) {
+            if (input.startsWith("<#") && input.endsWith(">")) {
+                final String id = input.substring(2, input.length() - 1);
+
+                try {
+                    final T result = repository.getById(id);
+                    if (result != null) {
+                        return ArgumentParseResult.success(result);
+                    }
+                } catch (final ChannelNotFoundParseException | NumberFormatException e) {
+                    exception = e;
+                }
+            } else {
+                exception = new IllegalArgumentException(String.format("Input '%s' is not a channel mention.", input));
+            }
+        }
+
+        if (this.modes().contains(DiscordParserMode.ID)) {
+            try {
+                final T result = repository.getById(input);
+                if (result != null) {
+                    return ArgumentParseResult.success(result);
+                }
+            } catch (final ChannelNotFoundParseException | NumberFormatException e) {
+                exception = e;
+            }
+        }
+
+        if (this.modes().contains(DiscordParserMode.NAME)) {
+            final Collection<? extends T> channels = repository.getByName(input);
+
+            if (channels.isEmpty()) {
+                exception = new ChannelNotFoundParseException(input);
+            } else if (channels.size() > 1) {
+                exception = new TooManyChannelsFoundParseException(input);
+            } else {
+                return ArgumentParseResult.success(channels.stream().findFirst().get());
+            }
+        }
+
+        return ArgumentParseResult.failure(Objects.requireNonNull(exception, "exception"));
+    }
+
+
+    public static class ChannelParseException extends IllegalArgumentException {
+
+        private static final long serialVersionUID = 2724288304060572202L;
+        private final String input;
+
+        /**
+         * Construct a new channel parse exception
+         *
+         * @param input String input
+         */
+        public ChannelParseException(final @NonNull String input) {
+            this.input = input;
+        }
+
+        /**
+         * Get the users input
+         *
+         * @return users input
+         */
+        public final @NonNull String input() {
+            return this.input;
+        }
+    }
+
+
+    public static final class TooManyChannelsFoundParseException extends ChannelParseException {
+
+        private static final long serialVersionUID = -507783063742841507L;
+
+        /**
+         * Construct a new channel parse exception
+         *
+         * @param input String input
+         */
+        public TooManyChannelsFoundParseException(final @NonNull String input) {
+            super(input);
+        }
+
+        @Override
+        public @NonNull String getMessage() {
+            return String.format("Too many channels found for '%s'.", input());
+        }
+    }
+
+
+    public static final class ChannelNotFoundParseException extends ChannelParseException {
+
+        private static final long serialVersionUID = -8299458048947528494L;
+
+        /**
+         * Construct a new channel parse exception
+         *
+         * @param input String input
+         */
+        public ChannelNotFoundParseException(final @NonNull String input) {
+            super(input);
+        }
+
+        @Override
+        public @NonNull String getMessage() {
+            return String.format("Channel not found for '%s'.", input());
+        }
+    }
+}

cloud-discord-common/src/main/java/org/incendo/cloud/discord/legacy/parser/DiscordMemberParser.java

@@ -0,0 +1,184 @@
+//
+// MIT License
+//
+// Copyright (c) 2024 Incendo
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all
+// copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+//
+package org.incendo.cloud.discord.legacy.parser;
+
+import cloud.commandframework.arguments.parser.ArgumentParseResult;
+import cloud.commandframework.context.CommandContext;
+import cloud.commandframework.context.CommandInput;
+import java.util.Collection;
+import java.util.Objects;
+import java.util.Set;
+import org.apiguardian.api.API;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.incendo.cloud.discord.legacy.repository.DiscordRepository;
+
+/**
+ * Parser for Discord members.
+ *
+ * @param <C> command sender type
+ * @param <G> guild type
+ * @param <T> member type
+ * @since 1.0.0
+ */
+@API(status = API.Status.INTERNAL, since = "1.0.0")
+public abstract class DiscordMemberParser<C, G, T> extends MentionableDiscordParser<C, G, T> {
+
+    protected DiscordMemberParser(final @NonNull Set<@NonNull DiscordParserMode> modes) {
+        super(modes);
+    }
+
+    @Override
+    public final @NonNull ArgumentParseResult<@NonNull T> parse(
+            @NonNull final CommandContext<@NonNull C> commandContext,
+            @NonNull final CommandInput commandInput
+    ) {
+        final ArgumentParseResult<T> preProcessed = this.preProcess(commandContext);
+        if (preProcessed != null) {
+            return preProcessed;
+        }
+
+        final String input = commandInput.readString();
+        final DiscordRepository<G, T> repository = this.repository(commandContext);
+
+        Exception exception = null;
+
+        if (this.modes().contains(DiscordParserMode.MENTION)) {
+            if (input.startsWith("<@") && input.endsWith(">")) {
+                final String id;
+                if (input.startsWith("<@!")) {
+                    id = input.substring(3, input.length() - 1);
+                } else {
+                    id = input.substring(2, input.length() - 1);
+                }
+
+                try {
+                    final T result = repository.getById(id);
+                    if (result != null) {
+                        return ArgumentParseResult.success(result);
+                    }
+                } catch (final MemberNotFoundParseException | NumberFormatException e) {
+                    exception = e;
+                }
+            } else {
+                exception = new IllegalArgumentException(String.format("Input '%s' is not a member mention.", input));
+            }
+        }
+
+        if (this.modes().contains(DiscordParserMode.ID)) {
+            try {
+                final T result = repository.getById(input);
+                if (result != null) {
+                    return ArgumentParseResult.success(result);
+                }
+            } catch (final MemberNotFoundParseException | NumberFormatException e) {
+                exception = e;
+            }
+        }
+
+        if (this.modes().contains(DiscordParserMode.NAME)) {
+            final Collection<? extends T> members = repository.getByName(input);
+
+            if (members.isEmpty()) {
+                exception = new MemberNotFoundParseException(input);
+            } else if (members.size() > 1) {
+                exception = new TooManyMembersFoundParseException(input);
+            } else {
+                return ArgumentParseResult.success(members.stream().findFirst().get());
+            }
+        }
+
+        return ArgumentParseResult.failure(Objects.requireNonNull(exception, "exception"));
+    }
+
+
+    public static class MemberParseException extends IllegalArgumentException {
+
+        private final String input;
+
+        /**
+         * Constructs a new member parse exception.
+         *
+         * @param input string input
+         */
+        public MemberParseException(final @NonNull String input) {
+            this.input = input;
+        }
+
+        /**
+         * Returns the user's input.
+         *
+         * @return user's input
+         */
+        public final @NonNull String input() {
+            return this.input;
+        }
+    }
+
+
+    public static final class TooManyMembersFoundParseException extends MemberParseException {
+
+        /**
+         * Constructs a new member parse exception.
+         *
+         * @param input string input
+         */
+        public TooManyMembersFoundParseException(final @NonNull String input) {
+            super(input);
+        }
+
+        @Override
+        public String getMessage() {
+            return String.format("Too many users found for '%s'.", this.input());
+        }
+    }
+
+
+    public static final class MemberNotFoundParseException extends MemberParseException {
+
+        /**
+         * Constructs a new member parse exception.
+         *
+         * @param input string input
+         */
+        public MemberNotFoundParseException(final @NonNull String input) {
+            super(input);
+        }
+
+        @Override
+        public String getMessage() {
+            return String.format("User not found for '%s'.", this.input());
+        }
+    }
+
+
+    public static final class CommandNotFromGuildException extends IllegalArgumentException {
+
+        /**
+         * Constructs a new command not from guild exception.
+         */
+        public CommandNotFromGuildException() {
+            super("Command must be executed in a guild.");
+        }
+    }
+}