diff options
-rw-r--r-- | README.md | 30 | ||||
-rw-r--r-- | build.gradle.kts | 25 | ||||
-rw-r--r-- | gradle/wrapper/gradle-wrapper.jar | bin | 0 -> 58695 bytes | |||
-rw-r--r-- | gradle/wrapper/gradle-wrapper.properties | 5 | ||||
-rw-r--r-- | gradlew | 183 | ||||
-rw-r--r-- | gradlew.bat | 100 | ||||
-rw-r--r-- | settings.gradle.kts | 33 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/BaseInformation.kt | 8 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/Command.kt | 8 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/ICommand.kt | 14 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/SyncRestAction.kt | 28 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/commands/EchoCommand.kt | 20 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/commands/HelpCommand.kt | 23 | ||||
-rw-r--r-- | src/main/kotlin/com/romangraef/jdacommander/start.kt | 45 | ||||
-rw-r--r-- | versions.properties | 18 |
15 files changed, 540 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..79aaadf --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +## JDA Commander + +This is a proof of concept project to demonstrate using [jcommander] with [JDA] + +### Building +This project uses [Gradle] for building and dependency management. + + - You can either directly run the project using `./gradlew run`. + - You can create a zip/tar using `./gradlew distZip` or `./gradlew distTar` respectively. + - Those can be found in `build/distributions` + - Those have Windows / Linux scripts to launch the project in the bin folder + +#### Versioning / Dependencies + +This project uses [Refresh Versions] to manage dependencies. + + +Run `./gradlew refreshVersions` to check for updates. Then open `versions.properties` and bump versions where appropriate. After that reload your project and run `./gradlew refreshVersions` again to make sure there won't be any git conflicts. + +When introducing new dependencies make sure you use the `"_"` version identifier, so it will be managed by the plugin. + +### Token +Set the environment variable `DISCORD_TOKEN` to a bot token obtained from Discord's [Developer Panel][discord]. + + +[discord]: https://discord.com/developers/applications/me +[refresh versions]: https://google.com +[gradle]: https://gradle.org +[jda]: https://github.com/DV8FromTheWorld/JDA +[jcommander]: https://jcommander.org/ diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..fbe5623 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,25 @@ +plugins { + kotlin("jvm") + application +} + +group = "com.romangraef" +version = "1.0-SNAPSHOT" + +repositories { + jcenter() + mavenCentral() +} + +dependencies { + implementation(kotlin("stdlib-jdk8")) + implementation("com.beust", "jcommander", "_") + implementation("net.dv8tion", "JDA", "_") + implementation("org.reflections", "reflections", "_") + + runtimeOnly("org.slf4j", "slf4j-simple", "_") +} + +application { + mainClassName = "com.romangraef.jdacommander.StartKt" +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar Binary files differnew file mode 100644 index 0000000..f3d88b1 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.jar diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..1b16c34 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists @@ -0,0 +1,183 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# 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 +# +# https://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. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9618d8d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,100 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..5e4b233 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,33 @@ +import de.fayard.dependencies.bootstrapRefreshVersionsAndDependencies + +pluginManagement { + repositories { + mavenLocal() + gradlePluginPortal() + maven(url = "https://dl.bintray.com/kotlin/kotlin-eap") + } +} + +buildscript { + repositories { + mavenLocal() + gradlePluginPortal() + maven(url = "https://dl.bintray.com/kotlin/kotlin-eap") + } + dependencies.classpath("de.fayard:dependencies:0.5.8") +} + +bootstrapRefreshVersionsAndDependencies() + +plugins { + id("com.gradle.enterprise").version("3.1.1") +} + +gradleEnterprise { + buildScan { + termsOfServiceUrl = "https://gradle.com/terms-of-service" + termsOfServiceAgree = "yes" + } +} +rootProject.name = "jdacommander" + diff --git a/src/main/kotlin/com/romangraef/jdacommander/BaseInformation.kt b/src/main/kotlin/com/romangraef/jdacommander/BaseInformation.kt new file mode 100644 index 0000000..fdf4a67 --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/BaseInformation.kt @@ -0,0 +1,8 @@ +package com.romangraef.jdacommander + +import com.beust.jcommander.Parameter + +class BaseInformation { + @Parameter(names = ["-p", "--private", "--direct", "--dm"]) + var sendToDM: Boolean = false +} diff --git a/src/main/kotlin/com/romangraef/jdacommander/Command.kt b/src/main/kotlin/com/romangraef/jdacommander/Command.kt new file mode 100644 index 0000000..a5178e6 --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/Command.kt @@ -0,0 +1,8 @@ +package com.romangraef.jdacommander + +@Retention(AnnotationRetention.RUNTIME) +@Target(AnnotationTarget.CLASS) +annotation class Command + ( + val value: String +)
\ No newline at end of file diff --git a/src/main/kotlin/com/romangraef/jdacommander/ICommand.kt b/src/main/kotlin/com/romangraef/jdacommander/ICommand.kt new file mode 100644 index 0000000..99fee95 --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/ICommand.kt @@ -0,0 +1,14 @@ +package com.romangraef.jdacommander + +import net.dv8tion.jda.api.entities.Message +import net.dv8tion.jda.api.entities.MessageChannel +import net.dv8tion.jda.api.requests.RestAction + +abstract class ICommand { + lateinit var base: BaseInformation + lateinit var message: Message + abstract fun run() + val channel get() = message.channel + val jda get() = message.jda + val responseChannel: RestAction<out MessageChannel> get() = if (base.sendToDM) message.author.openPrivateChannel() else SyncRestAction(jda, channel) +} diff --git a/src/main/kotlin/com/romangraef/jdacommander/SyncRestAction.kt b/src/main/kotlin/com/romangraef/jdacommander/SyncRestAction.kt new file mode 100644 index 0000000..27b0b10 --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/SyncRestAction.kt @@ -0,0 +1,28 @@ +package com.romangraef.jdacommander + +import java.util.concurrent.CompletableFuture +import java.util.function.BooleanSupplier +import java.util.function.Consumer +import net.dv8tion.jda.api.JDA +import net.dv8tion.jda.api.requests.RestAction + +class SyncRestAction<I>(private val jda: JDA, private val value: I) : RestAction<I> { + override fun getJDA(): JDA = jda + + override fun setCheck(checks: BooleanSupplier?): RestAction<I> { + // No need for last Second checks. + // We don't execute HTTP requests anyways. + return this + } + + override fun queue(success: Consumer<in I>?, failure: Consumer<in Throwable>?) { + success?.accept(value) + } + + override fun complete(shouldQueue: Boolean): I = value + + override fun submit(shouldQueue: Boolean): CompletableFuture<I> = + CompletableFuture.supplyAsync { value } + + +}
\ No newline at end of file diff --git a/src/main/kotlin/com/romangraef/jdacommander/commands/EchoCommand.kt b/src/main/kotlin/com/romangraef/jdacommander/commands/EchoCommand.kt new file mode 100644 index 0000000..edf50ba --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/commands/EchoCommand.kt @@ -0,0 +1,20 @@ +package com.romangraef.jdacommander.commands + +import com.beust.jcommander.Parameter +import com.romangraef.jdacommander.Command +import com.romangraef.jdacommander.ICommand + +@Command("echo") +class EchoCommand : ICommand() { + @Parameter(names = ["-c", "--caps", "--capitalize"], description = "Convert the text to upper case") + var caps: Boolean = false + + @Parameter(description = "Text to echo back") + lateinit var texts: List<String> + val text get() = texts.joinToString(" ") + + override fun run() = responseChannel.queue { + it.sendMessage(if (caps) text.toUpperCase() else text).queue() + } + +} diff --git a/src/main/kotlin/com/romangraef/jdacommander/commands/HelpCommand.kt b/src/main/kotlin/com/romangraef/jdacommander/commands/HelpCommand.kt new file mode 100644 index 0000000..63a69fc --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/commands/HelpCommand.kt @@ -0,0 +1,23 @@ +package com.romangraef.jdacommander.commands + +import com.beust.jcommander.Parameter +import com.romangraef.jdacommander.Command +import com.romangraef.jdacommander.ICommand + +@Command("help") +class HelpCommand : ICommand() { + + @Parameter(description = "Help Topic") + var helpTopic: String? = null + + override fun run() = responseChannel.queue { + it.sendMessage( + if (helpTopic == null) { + "Helping...." + } else { + "Helping on topic $helpTopic" + } + ).queue() + } + +} diff --git a/src/main/kotlin/com/romangraef/jdacommander/start.kt b/src/main/kotlin/com/romangraef/jdacommander/start.kt new file mode 100644 index 0000000..465d79c --- /dev/null +++ b/src/main/kotlin/com/romangraef/jdacommander/start.kt @@ -0,0 +1,45 @@ +package com.romangraef.jdacommander + +import com.beust.jcommander.JCommander +import net.dv8tion.jda.api.JDABuilder +import net.dv8tion.jda.api.events.message.MessageReceivedEvent +import net.dv8tion.jda.api.hooks.ListenerAdapter +import org.reflections.Reflections + +fun loadCommands(packageName: String): Map<String, Class<out ICommand>> { + val reflections = Reflections(packageName) + return reflections.getTypesAnnotatedWith(Command::class.java) + .map { + println(it) + it + } + .filter { ICommand::class.java.isAssignableFrom(it) } + .map { + it.getAnnotation(Command::class.java).value to (it as Class<out ICommand>) + }.toMap() +} + +fun main() { + val allCommands = loadCommands("com.romangraef.jdacommander.commands") + JDABuilder.createDefault(System.getenv("DISCORD_TOKEN")) + .addEventListeners(object : ListenerAdapter() { + override fun onMessageReceived(event: MessageReceivedEvent) { + val text = event.message.contentRaw + if (!text.startsWith("!")) return + val jCommander = JCommander() + val bi = BaseInformation() + allCommands.forEach { (name, `class`) -> + jCommander.addCommand(name, `class`.newInstance()) + } + jCommander.addObject(bi) + jCommander.parse(*text.substring(1).split("\\s+".toRegex()).toTypedArray()) + val parsedCommand = jCommander.parsedCommand + jCommander.findCommandByAlias(parsedCommand).objects.filterIsInstance<ICommand>().forEach { + it.base = bi + it.message = event.message + it.run() + } + } + }) + .build() +}
\ No newline at end of file diff --git a/versions.properties b/versions.properties new file mode 100644 index 0000000..ff2a180 --- /dev/null +++ b/versions.properties @@ -0,0 +1,18 @@ +## suppress inspection "SpellCheckingInspection" for whole file +## +## Dependencies and Plugin versions with their available updates +## Generated by $ ./gradlew refreshVersions +## Please, don't put extra comments in that file yet, keeping them is not supported yet. + +version.com.beust..jcommander=1.80 +## # available=2.0.0-RC1 + +version.kotlin=1.4.0 + +version.net.dv8tion..JDA=4.2.0_194 + +version.org.reflections..reflections=0.9.12 + +version.org.slf4j..slf4j-simple=1.7.30 +## # available=1.8.0-beta4 +## # available=2.0.0-alpha1 |