├── .gitignore ├── LICENSE ├── README.md ├── build.gradle.kts ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── settings.gradle └── src └── main ├── java └── club │ └── minnced │ └── jda │ └── reactor │ └── ReactiveEventManager.java └── kotlin └── club └── minnced └── jda └── reactor ├── attachments.kt ├── cacheview.kt ├── chunking.kt ├── observers.kt ├── restaction.kt ├── task.kt └── util.kt /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | build/ 3 | .idea/ 4 | .gradle/ 5 | out/ 6 | *.iml 7 | gradle.properties 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [ ![version](https://shields.io/github/v/tag/MinnDevelopment/jda-reactor) ](#Installation) 2 | # jda-reactor 3 | 4 | A collection of kotlin extensions for JDA that make use with reactor-core easier. 5 | 6 | ## Installation 7 | 8 | Replace the `$VERSION` with the latest release version. 9 |
Replace `$JDA_VERSION` with the latest stable JDA v5 release. 10 | 11 | ### Gradle 12 | 13 | ```gradle 14 | dependencies { 15 | implementation("net.dv8tion:JDA:$JDA_VERSION") 16 | implementation("com.github.MinnDevelopment:jda-reactor:$VERSION") 17 | } 18 | 19 | repositories { 20 | mavenCentral() 21 | maven("https://jitpack.io") 22 | } 23 | ``` 24 | 25 | ### Maven 26 | 27 | ```xml 28 | 29 | net.dv8tion 30 | JDA 31 | $JDA_VERSION 32 | 33 | 34 | com.github.MinnDevelopment 35 | jda-reactor 36 | $VERSION 37 | 38 | ``` 39 | 40 | ```xml 41 | 42 | jitpack 43 | jitpack 44 | https://jitpack.io 45 | 46 | ``` 47 | 48 | ## Examples 49 | 50 | Some small example usages of the components supported by this library. 51 | 52 | There is a complete bot written as an example available at [reactive-jda-bot](https://github.com/MinnDevelopment/reactive-jda-bot). 53 | 54 | ### ReactiveEventManager 55 | 56 | ```kotlin 57 | fun main() { 58 | // Create a ReactiveEventManager for Flux event streams 59 | val manager = ReactiveEventManager() 60 | // subscribe directly on the manager instance 61 | manager.on() // Flux 62 | .next() // Mono 63 | .subscribe { println("Ready to go!") } // Subscribe to event 64 | 65 | manager.on() // Flux 66 | .map { it.message } // Flux 67 | .filter { it.contentRaw == "!ping" } // filter by content 68 | .map { it.channel } // Flux 69 | .map { it.sendMessage("Pong!") } // Flux 70 | .flatMap { it.asMono() } // Flux (send message and provide result) 71 | .subscribe() // Subscribe to event 72 | 73 | val jda = JDABuilder(BOT_TOKEN) 74 | .setEventManager(manager) 75 | .build() 76 | 77 | // you can also subscribe to events from the JDA instance 78 | jda.on() // Flux 79 | .subscribe { println("That was fun!") } // Make a statement on shutdown, not guaranteed to run if daemon scheduler (default) 80 | } 81 | ``` 82 | 83 | ### Mono/Flux RestAction 84 | 85 | Every RestAction receives an `asMono` extensions which converts them into a `Mono` of the same result type. 86 |
Additionally some more specific types such as `PaginationAction` can be streamed into a `Flux` 87 | which will automatically paginate the endpoint as demanded by the subscription. 88 | 89 | #### PaginationAction\ 90 | 91 | ```kotlin 92 | fun getMessagesForUser(channel: MessageChannel, user: User): Flux { 93 | val action = channel.iterableHistory 94 | return action.asFlux() // Flux 95 | .filter { it.author == user } // filter by user 96 | } 97 | ``` 98 | 99 | #### RestAction\ 100 | 101 | ```kotlin 102 | fun sendAndLog(channel: MessageChannel, content: String) { 103 | val action = channel.sendMessage(content) 104 | action.asMono() // Mono 105 | .flatMap { it.addReaction(EMOTE).asMono() } // Mono = empty mono 106 | .doOnSuccess { println("${channel.name}: $content") } // add side-effect 107 | .subscribe() // subscribe to empty stream 108 | } 109 | ``` 110 | 111 | #### RestAction> 112 | 113 | ```kotlin 114 | fun getBannedUsers(guild: Guild): Flux { 115 | return guild.retrieveBanList() // RestAction> 116 | .toFlux() // Flux 117 | .map { it.user } // Flux 118 | .map { it.asTag } // Flux 119 | } 120 | ``` 121 | 122 | ### Entity Observers 123 | 124 | ```kotlin 125 | fun onNextMessage(channel: MessageChannel, callback: (Message) -> Unit) { 126 | channel.onMessage() // Flux 127 | .next() // Mono 128 | .map { it.message } // Mono 129 | .subscribe { callback(it) } 130 | } 131 | 132 | fun onReaction(message: Message, reaction: String): Flux { 133 | return message.on() // Flux 134 | .filter { it.emoji.name == reaction } // Flux with filter 135 | .map { it.user } // Flux 136 | } 137 | ``` 138 | 139 | ```kotlin 140 | fun onNameChange(user: User): Flux { 141 | return user.on() // Flux 142 | .map { it.newValue } // Flux 143 | } 144 | 145 | fun onNameChange(channel: GuildChannel): Flux { 146 | return channel.onUpdate() // Flux 147 | .map { it.newValue } // Flux 148 | } 149 | ``` 150 | 151 | ### CacheView 152 | 153 | I've added a special `toFluxLocked` which makes use of the `lockedIterator()` that was introduced in JDA version 4. This will automatically lock the cache view for read access when `subscribe()` is invoked and unlock it on the completion signal. 154 | 155 | #### Example toFluxLocked 156 | 157 | ```kotlin 158 | fun findUserByName(jda: JDA, name: String): Mono { 159 | return jda.userCache 160 | .toFluxLocked() // Flux lazy locked user cache 161 | .filterFirst { it.name == name } // Mono unlock on first match 162 | } 163 | 164 | fun sendToUser(jda: JDA, name: String, content: String) { 165 | return findUserByName(name) // Mono 166 | .flatMap { it.openPrivateChannel().asMono() } // Mono 167 | .flatMap { it.sendMessage(content).asMono() } // Mono 168 | .subscribe() // lock the user cache and look for the user by name 169 | } 170 | ``` 171 | 172 | ### Quality of Life Extensions 173 | 174 | I've added a few extensions to reactor itself that might be useful when working with JDA. 175 | 176 | - `T?.toMono()` improvement of `T.toMono()` which uses `Mono.justOrEmpty` instead 177 | - `Mono.then(() -> Mono)` lazy version of `Mono.then(Mono)` similar to `Mono.flatMap` 178 | - `Flux.then(() -> Mono)` same as above 179 | - `Flux.filterFirst((T) -> Boolean)` combination of `filter().next()` 180 | - `Flux.filterFirstWhen((T) -> Publisher)` combination of `filterWhen().next()` 181 | - `Flux.nextWhen((T) -> Mono)` combination of `next().flatMap()` 182 | - `Iterable>.asFlux(): Flux` flatten lists of completion stages 183 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 2 | 3 | plugins { 4 | `java-library` 5 | `maven-publish` 6 | kotlin("jvm") version "1.7.20" 7 | } 8 | 9 | group = "club.minnced" 10 | version = "1.6.0" 11 | 12 | repositories { 13 | mavenLocal() 14 | mavenCentral() 15 | } 16 | 17 | dependencies { 18 | compileOnly("com.google.code.findbugs:jsr305:3.0.2") 19 | compileOnly("net.dv8tion:JDA:5.0.0-beta.1") 20 | 21 | api("io.projectreactor:reactor-core:3.5.0") 22 | implementation("io.projectreactor.kotlin:reactor-kotlin-extensions:1.2.0") 23 | implementation(kotlin("stdlib")) 24 | } 25 | 26 | configure { 27 | sourceCompatibility = JavaVersion.VERSION_1_8 28 | targetCompatibility = JavaVersion.VERSION_1_8 29 | } 30 | 31 | val jar: Jar by tasks 32 | val javadoc: Javadoc by tasks 33 | tasks.withType { 34 | kotlinOptions.jvmTarget = "1.8" 35 | } 36 | 37 | 38 | javadoc.apply { 39 | isFailOnError = false 40 | options.memberLevel = JavadocMemberLevel.PUBLIC 41 | options.encoding = "UTF-8" 42 | if (options is StandardJavadocDocletOptions) { 43 | val opt = options as StandardJavadocDocletOptions 44 | opt.author() 45 | opt.links( 46 | "https://projectreactor.io/docs/core/3.5.0.RELEASE/api/", 47 | "https://docs.oracle.com/javase/8/docs/api/", 48 | "https://ci.dv8tion.net/job/JDA5/javadoc") 49 | if (JavaVersion.current().isJava9Compatible) { 50 | opt.addBooleanOption("html5", true) 51 | opt.addStringOption("-release", "8") 52 | } 53 | } 54 | } 55 | 56 | val sourcesJar = task("sourcesJar") { 57 | from(sourceSets["main"].allSource) 58 | classifier = "sources" 59 | } 60 | 61 | val javadocJar = task("javadocJar") { 62 | from(javadoc.destinationDir) 63 | classifier = "javadoc" 64 | 65 | dependsOn(javadoc) 66 | } 67 | 68 | val build: Task by tasks 69 | build.apply { 70 | dependsOn(javadocJar) 71 | dependsOn(sourcesJar) 72 | dependsOn(jar) 73 | } 74 | 75 | publishing.publications { 76 | register("Release") { 77 | from(components["java"]) 78 | groupId = project.group as String 79 | artifactId = project.name 80 | version = project.version as String 81 | 82 | artifact(javadocJar) 83 | artifact(sourcesJar) 84 | } 85 | } -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MinnDevelopment/jda-reactor/e01a6350c03948cf9423f16183b41adae0fd73d9/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'jda-reactor' 2 | 3 | -------------------------------------------------------------------------------- /src/main/java/club/minnced/jda/reactor/ReactiveEventManager.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.jda.reactor; 18 | 19 | import net.dv8tion.jda.api.events.ExceptionEvent; 20 | import net.dv8tion.jda.api.events.GenericEvent; 21 | import net.dv8tion.jda.api.events.session.ShutdownEvent; 22 | import net.dv8tion.jda.api.hooks.EventListener; 23 | import net.dv8tion.jda.api.hooks.IEventManager; 24 | import reactor.core.Disposable; 25 | import reactor.core.publisher.Flux; 26 | import reactor.core.publisher.Sinks; 27 | import reactor.util.Logger; 28 | import reactor.util.Loggers; 29 | 30 | import javax.annotation.Nonnull; 31 | import javax.annotation.Nullable; 32 | import java.util.*; 33 | import java.util.function.Function; 34 | import java.util.logging.Level; 35 | 36 | /** 37 | * Implementation if {@link IEventManager} which publishes events to a {@link Flux}. 38 | * 39 | *

This implementation provides access to event-specific flux instances with {@link #on(Class)}. 40 | */ 41 | public class ReactiveEventManager implements IEventManager, Disposable { 42 | private static final Logger log = Loggers.getLogger(ReactiveEventManager.class); 43 | private final Map listeners = new HashMap<>(); 44 | private final Sinks.Many sink; 45 | private final Disposable reference; 46 | private Flux flux; 47 | private boolean instance = true; 48 | 49 | /** 50 | * Create a new ReactiveEventManager with custom sink and flux configuration. 51 | *
This manager will automatically subscribe to the output flux. You can dispose this subscription with {@link #dispose()}. 52 | * 53 | *

This uses {@code Sinks.many().multicast().onBackpressureBuffer()} as the default sink. 54 | * 55 | * @see #setInstance(boolean) 56 | * @see #getFlux() 57 | * @see #dispose() 58 | */ 59 | public ReactiveEventManager() { 60 | this(Sinks.many().multicast().onBackpressureBuffer()); 61 | } 62 | 63 | /** 64 | * Create a new ReactiveEventManager with custom sink and flux configuration. 65 | *
This manager will automatically subscribe to the output flux. You can dispose this subscription with {@link #dispose()}. 66 | * 67 | * @param sink 68 | * The {@link Sinks.Many} instance this manager should use 69 | * 70 | * @see #setInstance(boolean) 71 | * @see #getFlux() 72 | * @see #dispose() 73 | */ 74 | public ReactiveEventManager(@Nonnull Sinks.Many sink) { 75 | this(sink, null); 76 | } 77 | 78 | /** 79 | * Create a new ReactiveEventManager with custom sink and flux configuration. 80 | *
This manager will automatically subscribe to the output flux. You can dispose this subscription with {@link #dispose()}. 81 | * 82 | *

This uses {@code Sinks.many().multicast().onBackpressureBuffer()} as the default sink. 83 | * 84 | *

Example

85 | * 
{@code
 86 |      * val manager = ReactiveEventManager({
 87 |      *     it.publishOn(Schedulers.elastic()
 88 |      *       .log(customLogger, Level.INFO, true)
 89 |      * })
 90 |      * }
91 | * 92 | * @param spec 93 | * Possible further configuration for the {@link Flux} for event streaming. 94 | * This can be useful to configure a custom scheduler or log level, by default this will use {@code log(logger, Level.FINEST, true)}. 95 | * 96 | * @see #setInstance(boolean) 97 | * @see #getFlux() 98 | * @see #dispose() 99 | */ 100 | public ReactiveEventManager(@Nullable Function, Flux> spec) { 101 | this(Sinks.many().multicast().onBackpressureBuffer(), spec); 102 | } 103 | 104 | /** 105 | * Create a new ReactiveEventManager with custom sink and flux configuration. 106 | *
This manager will automatically subscribe to the output flux. You can dispose this subscription with {@link #dispose()}. 107 | * 108 | * @param sink 109 | * The {@link Sinks.Many} instance this manager should use 110 | * @param spec 111 | * Possible further configuration for the {@link Flux} for event streaming. 112 | * This can be useful to configure a custom scheduler or log level, by default this will use {@code log(logger, Level.FINEST, true)}. 113 | * 114 | * @see #setInstance(boolean) 115 | * @see #getFlux() 116 | * @see #dispose() 117 | */ 118 | public ReactiveEventManager(@Nonnull Sinks.Many sink, @Nullable Function, Flux> spec) { 119 | this.sink = sink; 120 | Flux tmp = sink.asFlux().log(log, Level.FINEST, true); 121 | this.flux = spec == null ? tmp : spec.apply(tmp); 122 | this.reference = flux.subscribe(); 123 | } 124 | 125 | /** 126 | * The manager automatically subscribes to any flux it publishes from. 127 | *
This dispose implementation simply causes that subscription to get disposed. 128 | * 129 | * {@inheritDoc} 130 | */ 131 | @Override 132 | public void dispose() { 133 | reference.dispose(); 134 | } 135 | 136 | /** 137 | * The flux used for event publishing. 138 | *
Identical to {@code on(GenericEvent.class)} 139 | * 140 | * @return The {@link Flux} instance 141 | */ 142 | @Nonnull 143 | public Flux getFlux() { 144 | return flux; 145 | } 146 | 147 | /** 148 | * Applies custom settings to the flux instance. 149 | * 150 | * @param spec 151 | * Function used to apply settings, must return updated flux instance 152 | * 153 | * @return Same manager instance 154 | */ 155 | @Nonnull 156 | public ReactiveEventManager applySpec(@Nonnull Function, Flux> spec) { 157 | this.flux = Objects.requireNonNull(spec.apply(flux)); 158 | return this; 159 | } 160 | 161 | /** 162 | * Whether the sink of this instance should be completed by a {@link ShutdownEvent}. 163 | *
Default: true 164 | * 165 | * @param enabled 166 | * True, if shutdown should complete the sink 167 | */ 168 | public void setInstance(boolean enabled) { 169 | this.instance = enabled; 170 | } 171 | 172 | @Override 173 | public void handle(@Nonnull GenericEvent event) { 174 | try { 175 | sink.tryEmitNext(event); 176 | } catch (Throwable t) { 177 | sink.tryEmitNext(new ExceptionEvent(event.getJDA(), t, false)); 178 | } 179 | if (event instanceof ShutdownEvent) { 180 | dispose(); 181 | if (instance) 182 | sink.tryEmitComplete(); 183 | } 184 | } 185 | 186 | /** 187 | * Returns a {@link Flux} instance for the specific event type. 188 | *
Shortcut for {@code getFlux().ofType(type)}. 189 | * 190 | * @param type 191 | * Class instance for the event type 192 | * @param 193 | * The event type 194 | * 195 | * @throws NullPointerException 196 | * If null is provided 197 | * 198 | * @return {@link Flux} 199 | */ 200 | @Nonnull 201 | public Flux on(@Nonnull Class type) { 202 | return flux.ofType(type); 203 | } 204 | 205 | @Override 206 | public void register(@Nonnull Object listener) { 207 | if (listener instanceof EventListener) { 208 | EventListener eventListener = (EventListener) listener; 209 | Disposable disposable = on(GenericEvent.class).subscribe(eventListener::onEvent); 210 | listeners.put(eventListener, disposable); 211 | } 212 | else throw new UnsupportedOperationException(); 213 | } 214 | 215 | @Override 216 | public void unregister(@Nonnull Object listener) { 217 | if (listener instanceof EventListener) { 218 | Disposable disposable = listeners.remove(listener); 219 | if (disposable != null) 220 | disposable.dispose(); 221 | } 222 | else throw new UnsupportedOperationException(); 223 | } 224 | 225 | @Nonnull 226 | @Override 227 | public List getRegisteredListeners() { 228 | return new ArrayList<>(listeners.keySet()); 229 | } 230 | } 231 | -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/attachments.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.entities.Icon 20 | import net.dv8tion.jda.api.entities.Message 21 | import reactor.core.publisher.Flux 22 | import reactor.core.publisher.Mono 23 | import reactor.core.scheduler.Schedulers 24 | import java.io.* 25 | import java.nio.charset.Charset 26 | 27 | /** 28 | * Retrieves the attachment as an InputStream 29 | * 30 | * @return[Mono] 31 | */ 32 | fun Message.Attachment.toInputStream(): Mono { 33 | return toByteArray() 34 | .map { ByteArrayInputStream(it) } 35 | } 36 | 37 | /** 38 | * Retrieves the attachment as an InputStream and converts it to a byte stream 39 | * 40 | * @return[Flux] 41 | */ 42 | fun Message.Attachment.toBytes(): Flux { 43 | return toByteArray() 44 | .flatMapIterable { it.asIterable() } 45 | } 46 | 47 | /** 48 | * Retrieves the attachment as an InputStream and converts it to a stream of lines 49 | * 50 | * @return[Flux] 51 | */ 52 | fun Message.Attachment.toLines(): Flux { 53 | return toInputStream() 54 | .map { InputStreamReader(it) } 55 | .flatMapMany { 56 | Flux.fromIterable( 57 | it.buffered().lineSequence().asIterable() 58 | ) 59 | } 60 | } 61 | 62 | /** 63 | * Retrieves the attachment as an InputStream and converts it to a ByteArray 64 | * 65 | * @return[Mono] 66 | */ 67 | fun Message.Attachment.toByteArray(): Mono { 68 | return Mono.fromFuture { proxy.download() } 69 | .map { 70 | it.use { source -> 71 | val buffer = ByteArrayOutputStream() 72 | source.copyTo(buffer) 73 | buffer.toByteArray() 74 | } 75 | } 76 | .subscribeOn(Schedulers.boundedElastic()) 77 | } 78 | 79 | /** 80 | * Retrieves the attachment as an InputStream and converts it to its text content 81 | * 82 | * @param charset the [Charset] to use (default UTF-8) 83 | * 84 | * @return[Mono] 85 | */ 86 | fun Message.Attachment.toText(charset: Charset = Charsets.UTF_8): Mono { 87 | return toByteArray() 88 | .map { it.toString(charset) } 89 | } 90 | 91 | /** 92 | * Retrieves the attachment as a file. 93 | * 94 | * - No parameters = Save in current working directory with the name provided by the attachment 95 | * - path parameter - Use the provided path (prefix with "/" to use absolute path) 96 | * - file parameter - Save to specific file object (useful for temporary files) 97 | * 98 | * @param path The file path, null to use current directory and name of attachment 99 | * @param file Target file, or current directory and name of attachment 100 | * 101 | * @return[Mono] 102 | */ 103 | fun Message.Attachment.toFile(path: String? = null, file: File? = null): Mono { 104 | return Mono.fromFuture { 105 | when { 106 | path != null -> proxy.downloadToFile(File(path)) 107 | file != null -> proxy.downloadToFile(file) 108 | else -> proxy.downloadToFile(File(fileName)) 109 | } 110 | }.subscribeOn(Schedulers.boundedElastic()) 111 | } 112 | 113 | /** 114 | * Retrieves the attachment as an InputStream and converts it to an Icon 115 | * 116 | * @return[Mono] 117 | */ 118 | fun Message.Attachment.toIcon(): Mono { 119 | return toInputStream() 120 | .map { Icon.from(it) } 121 | } 122 | 123 | /** 124 | * Copies the attachment to the specified OutputStream and provides the number of copied bytes 125 | * 126 | * @param outputStream The target stream 127 | * 128 | * @return[Mono] 129 | */ 130 | fun Message.Attachment.copyTo(outputStream: OutputStream): Mono { 131 | return toInputStream() 132 | .map { it.copyTo(outputStream) } 133 | } 134 | 135 | -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/cacheview.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | @file:JvmName("CacheViews") 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.utils.cache.CacheView 20 | import reactor.core.publisher.Flux 21 | import reactor.kotlin.core.publisher.toFlux 22 | 23 | /** 24 | * Creates a Flux using [CacheView.lockedIterator] and closes it after usage. 25 | * 26 | * @return Lazy flux that will apply a read-lock on the cache 27 | */ 28 | fun CacheView.toFluxLocked(): Flux = Flux.defer { 29 | // Use defer to make this lazy, otherwise it will lock this right away before subscribe() is called! 30 | val iterator = lockedIterator() 31 | iterator.toFlux().doFinally { iterator.close() } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/chunking.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.entities.Guild 20 | import net.dv8tion.jda.api.entities.Member 21 | import reactor.core.publisher.Flux 22 | 23 | /** 24 | * Load and stream the members of this guild. 25 | * 26 | * This required [GatewayIntent.GUILD_MEMBERS][net.dv8tion.jda.api.requests.GatewayIntent#GUILD_MEMBERS] to be enabled. 27 | * 28 | * @throws[IllegalStateException] If the GUILD_MEMBERS intent is not enabled 29 | * 30 | * @return[Flux] Flux of members 31 | */ 32 | fun Guild.streamMembers(): Flux = Flux.create { sink -> 33 | val task = loadMembers { 34 | sink.next(it) 35 | } 36 | 37 | sink.onCancel(task::cancel) 38 | task.onError(sink::error) 39 | task.onSuccess { sink.complete() } 40 | } -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/observers.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | @file:JvmName("Observers") 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.JDA 20 | import net.dv8tion.jda.api.entities.Guild 21 | import net.dv8tion.jda.api.entities.Member 22 | import net.dv8tion.jda.api.entities.Message 23 | import net.dv8tion.jda.api.entities.User 24 | import net.dv8tion.jda.api.entities.channel.Channel 25 | import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel 26 | import net.dv8tion.jda.api.events.GenericEvent 27 | import net.dv8tion.jda.api.events.RawGatewayEvent 28 | import net.dv8tion.jda.api.events.channel.update.GenericChannelUpdateEvent 29 | import net.dv8tion.jda.api.events.guild.GenericGuildEvent 30 | import net.dv8tion.jda.api.events.guild.member.GenericGuildMemberEvent 31 | import net.dv8tion.jda.api.events.guild.update.GenericGuildUpdateEvent 32 | import net.dv8tion.jda.api.events.message.GenericMessageEvent 33 | import net.dv8tion.jda.api.events.message.MessageReceivedEvent 34 | import net.dv8tion.jda.api.events.user.GenericUserEvent 35 | import net.dv8tion.jda.api.hooks.EventListener 36 | import net.dv8tion.jda.api.sharding.ShardManager 37 | import reactor.core.publisher.Flux 38 | 39 | // Guild events 40 | 41 | inline fun Guild.on() = on(T::class.java) 42 | 43 | fun Guild.on(type: Class): Flux { 44 | val id = this.idLong 45 | return jda.on(type).filter { it.guild.idLong == id } 46 | } 47 | 48 | inline fun > Guild.onUpdate() = onUpdate(T::class.java) 49 | 50 | fun > Guild.onUpdate(type: Class): Flux { 51 | val id = this.idLong 52 | return jda.on(type).filter { it.guild.idLong == id } 53 | } 54 | 55 | // User events 56 | 57 | inline fun User.on() = on(T::class.java) 58 | 59 | fun User.on(type: Class): Flux { 60 | val id = this.idLong 61 | return jda.on(type).filter { it.user.idLong == id } 62 | } 63 | 64 | inline fun Member.on() = on(T::class.java) 65 | 66 | fun Member.on(type: Class): Flux { 67 | val guildId = this.guild.idLong 68 | val userId = this.idLong 69 | return guild.on(type).filter { it.guild.idLong == guildId } .filter { it.user.idLong == userId } 70 | } 71 | 72 | // Channel Updates 73 | 74 | inline fun > Channel.onUpdate() = onUpdate(T::class.java) 75 | 76 | fun > Channel.onUpdate(type: Class): Flux { 77 | val id = this.idLong 78 | return jda.on(type).filter { it.channel.idLong == id } 79 | } 80 | 81 | // Message events 82 | 83 | inline fun Message.on() = on(T::class.java) 84 | 85 | fun Message.on(type: Class): Flux { 86 | val id = this.idLong 87 | return jda.on(type).filter { it.messageIdLong == id } 88 | } 89 | 90 | fun MessageChannel.onMessage(): Flux { 91 | val id = this.idLong 92 | return jda.on(MessageReceivedEvent::class.java).filter { it.channel.idLong == id } 93 | } 94 | 95 | fun JDA.on(type: Class) : Flux { 96 | val manager = eventManager as? ReactiveEventManager ?: throw IllegalStateException("You are not using a ReactiveEventManager!") 97 | return manager.on(type) 98 | } 99 | 100 | /** 101 | * Constructs an event flow using a [Flux] of the specified type. 102 | * 103 | * # Example 104 | * 105 | * ``` 106 | * jda.on() // Flux 107 | * .map { it.message } // Flux 108 | * .filter { it.author.asTag == "Minn#6688" } // Flux 109 | * .subscribe { println("Minn#6688 said ${it.contentDisplay}") } 110 | * ``` 111 | */ 112 | inline fun JDA.on() = on(T::class.java) 113 | 114 | /** 115 | * Constructs an event flow using a [Flux] of the specified type. 116 | * 117 | * # Example 118 | * 119 | * ``` 120 | * jda.on() // Flux 121 | * .map { it.message } // Flux 122 | * .filter { it.author.asTag == "Minn#6688" } // Flux 123 | * .subscribe { println("Minn#6688 said ${it.contentDisplay}") } 124 | * ``` 125 | */ 126 | inline fun ShardManager.on(): Flux = Flux.create { sink -> 127 | addEventListener(object : EventListener { 128 | override fun onEvent(event: GenericEvent) { 129 | if (event is T) { 130 | sink.next(event) 131 | } 132 | } 133 | }) 134 | } 135 | 136 | inline fun ReactiveEventManager.on() = on(T::class.java) 137 | 138 | /** 139 | * Filters a [RawGatewayEvent] by the provided type. 140 | * 141 | * Must be enabled by [JDABuilder#setRawEventsEnabled][net.dv8tion.jda.api.JDABuilder.setRawEventsEnabled] 142 | * otherwise this flux will never publish any events. 143 | * 144 | * @param types The types to filter 145 | * 146 | * @return [Flux] of [RawGatewayEvent] for the provided type 147 | */ 148 | fun JDA.onRaw(vararg types: String): Flux = on(RawGatewayEvent::class.java).filter { it.type in types } -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/restaction.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | @file:JvmName("RestActions") 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.requests.RestAction 20 | import net.dv8tion.jda.api.requests.restaction.pagination.PaginationAction 21 | import reactor.core.publisher.Flux 22 | import reactor.core.publisher.FluxSink 23 | import reactor.core.publisher.Mono 24 | import java.util.concurrent.CompletableFuture 25 | import java.util.concurrent.CompletionStage 26 | import java.util.concurrent.atomic.AtomicLong 27 | import java.util.concurrent.locks.ReentrantLock 28 | import kotlin.concurrent.withLock 29 | 30 | /** 31 | * Converts the RestAction into a [Mono] of the same result type. 32 | * 33 | * - If the result type is a list you can use [toFlux] instead. 34 | * - If the type of RestAction is a PaginationAction you can use [asFlux] instead. 35 | * 36 | * This is a shortcut for `Mono.fromFuture(action.submit())`. 37 | * 38 | * # Example 39 | * 40 | * ``` 41 | * channel.sendMessage("This message will self-destruct in 5 seconds) // RestAction 42 | * .asMono() // Mono 43 | * .delay(Duration.ofSeconds(5)) // Mono 44 | * .flatMap { it.delete().asMono() } // Mono 45 | * .subscribe() 46 | * ``` 47 | */ 48 | fun RestAction.asMono() : Mono = Mono.fromFuture(this::submit) 49 | 50 | /** 51 | * Maps the response of this RestAction into a Flux. 52 | * 53 | * If this is a [PaginationAction] use [asFlux] instead. 54 | * 55 | * This is a shortcut for `action.asMono().flatMapIterable{it}`. 56 | * 57 | * # Example 58 | * 59 | * ``` 60 | * guild.retrieveBanList() // RestAction> 61 | * .toFlux() // Flux 62 | * .map { it.user } // Flux 63 | * .map { it.asTag } // Flux 64 | * .subscribe { 65 | * // Print the DiscordTag (Example: Minn#6688) 66 | * println(it) 67 | * } 68 | * ```` 69 | */ 70 | fun RestAction>.toFlux() : Flux = asMono().flatMapIterable { it } 71 | 72 | /** 73 | * Converts a PaginationAction into a streamed flux of data. 74 | * Unlike [toFlux] this will make multiple requests (as needed) in order to satisfy 75 | * the requested resources. [toFlux] makes a single request and streams the result into a Flux publisher 76 | * while this will paginate the underlying endpoint until it satisfied the demand or reaches an end. 77 | * 78 | * # Example 79 | * 80 | * ``` 81 | * guild.retrieveAuditLogs() // AuditLogPaginationAction : PaginationAction 82 | * .type(ActionType.BAN) // AuditLogPaginationAction : PaginationAction 83 | * .asFlux() // Flux 84 | * .take(5) // Flux 85 | * .map { "${it.user} banned user with id ${it.targetId}" } // Flux 86 | * .subscribe { println(it) } 87 | * ``` 88 | * 89 | * @param overflowStrategy 90 | * The OverflowStrategy to apply (default [LATEST][FluxSink.OverflowStrategy.LATEST]) 91 | */ 92 | fun PaginationAction.asFlux(overflowStrategy: FluxSink.OverflowStrategy = FluxSink.OverflowStrategy.LATEST) : Flux 93 | where M : PaginationAction = Flux.create({ sink -> 94 | cache(false) 95 | var task: CompletionStage<*> = CompletableFuture.completedFuture(null) 96 | val remaining = AtomicLong(0) 97 | var done = false 98 | val lock = ReentrantLock() 99 | sink.onDispose { 100 | // Tell the worker to stop iterating 101 | done = true 102 | } 103 | 104 | sink.onRequest { amount -> 105 | lock.withLock { 106 | // If amount is lower than demand we don't need to do anything 107 | if (amount <= remaining.get() || done) 108 | return@onRequest 109 | // Update our demand with new requested amount 110 | remaining.set(amount) 111 | 112 | task = task.thenCompose { 113 | when { 114 | // If completed or disposed, do nothing 115 | done || remaining.get() <= 0 -> CompletableFuture.completedFuture(null) 116 | 117 | // Collect remaining supply from pagination 118 | else -> forEachRemainingAsync { 119 | sink.next(it) 120 | //If we completed or were disposed stop iteration 121 | // otherwise continue until demand is matched 122 | !done && remaining.decrementAndGet() > 0 123 | }.thenRun { 124 | //If we still have remaining requests then we exhausted the supply of the pagination 125 | // This means we are done and call complete() 126 | //If done = true we already completed or were disposed, do nothing 127 | if (remaining.get() > 0 && !done) lock.withLock { 128 | done = true 129 | sink.complete() 130 | } 131 | } 132 | } 133 | } 134 | } 135 | } 136 | }, overflowStrategy) -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/task.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.utils.concurrent.Task 20 | import reactor.core.publisher.Flux 21 | import reactor.core.publisher.Mono 22 | import java.util.function.Function 23 | 24 | /** 25 | * Converts this task to a [Mono] 26 | * 27 | * @return[Mono] 28 | */ 29 | fun Task.asMono(): Mono = Mono.create { sink -> 30 | onSuccess(sink::success) 31 | onError(sink::error) 32 | sink.onCancel(this::cancel) 33 | } 34 | 35 | /** 36 | * Converts this task to a [Flux] 37 | * 38 | * @return[Flux] 39 | */ 40 | fun Task>.asFlux(): Flux = asMono().flatMapIterable(Function.identity()) -------------------------------------------------------------------------------- /src/main/kotlin/club/minnced/jda/reactor/util.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2019 Florian Spieß and the contributors of jda-reactor 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | @file:JvmName("Utils") 17 | package club.minnced.jda.reactor 18 | 19 | import net.dv8tion.jda.api.JDABuilder 20 | import net.dv8tion.jda.api.events.GenericEvent 21 | import net.dv8tion.jda.api.sharding.DefaultShardManagerBuilder 22 | import org.reactivestreams.Publisher 23 | import reactor.core.publisher.Flux 24 | import reactor.core.publisher.Mono 25 | import reactor.core.publisher.Sinks 26 | import java.util.concurrent.CompletionStage 27 | 28 | /** 29 | * Same as `Mono.justOrEmpty(it)` 30 | * 31 | * @return Mono for the current nullable value 32 | */ 33 | fun T?.toMono(): Mono = Mono.justOrEmpty(this) 34 | 35 | /** 36 | * Lazy version of `Mono.then(Mono)`. 37 | * 38 | * @param[R] The result type 39 | * @param[callback] The callback to pass to [Mono.defer] 40 | * 41 | * @return Mono for the termination signal 42 | */ 43 | fun Mono<*>.then(callback: () -> Mono): Mono = then(Mono.defer(callback)) 44 | 45 | /** 46 | * Lazy version of `Flux.then(Mono)`. 47 | * 48 | * @param[R] The result type 49 | * @param[callback] The callback to pass to [Mono.defer] 50 | * 51 | * @return Mono for the termination signal 52 | */ 53 | fun Flux<*>.then(callback: () -> Mono): Mono = then(Mono.defer(callback)) 54 | 55 | /** 56 | * Combination of [Flux.filter] and [Flux.next]. 57 | * Shortcut for `flux.filter(predicate).next()`. 58 | * 59 | * @param[predicate] The filter function 60 | * 61 | * @return `Mono` for the matched result 62 | */ 63 | fun Flux.filterFirst(predicate: (T) -> Boolean): Mono = filter(predicate).next() 64 | 65 | /** 66 | * Similar to [filterFirst] but accepts a publisher for the result. 67 | * Shortcut for `flux.filterWhen(predicate).next()` 68 | * 69 | * @param[predicate] The filter function 70 | * 71 | * @return `Mono` for the matched result 72 | */ 73 | fun Flux.filterFirstWhen(predicate: (T) -> Publisher): Mono = filterWhen(predicate).next() 74 | 75 | /** 76 | * Combination of [Flux.next] and [Mono.flatMap]. 77 | * Shortcut for `flux.next().flatMap(func)` 78 | * 79 | * @param[func] The transformation function 80 | * 81 | * @return `Mono` for the result 82 | */ 83 | fun Flux.nextWhen(func: (T) -> Mono): Mono = next().flatMap(func) 84 | 85 | /** 86 | * Converts the iterable of completion stages into a Flux of the result types. 87 | * 88 | * @param[T] The result type 89 | * 90 | * @return [Flux] for the result 91 | */ 92 | fun Iterable>.asFlux(): Flux { 93 | return Flux.fromIterable(this) 94 | .flatMap { Mono.fromCompletionStage(it) } 95 | } 96 | 97 | 98 | /** 99 | * Make this JDABuilder use a [ReactiveEventManager] 100 | * 101 | * @param[block] Initializer block 102 | * 103 | * @return The current JDABuilder for chaining 104 | */ 105 | inline fun JDABuilder.reactive(sink: Sinks.Many? = null, block: ReactiveEventManager.() -> Unit = {}) = setEventManager(createManager(sink, block)) 106 | 107 | /** 108 | * Make this DefaultShardManagerBuilder use a [ReactiveEventManager] 109 | * 110 | * @param[block] Initializer block 111 | * 112 | * @return The current DefaultShardManagerBuilder for chaining 113 | */ 114 | fun DefaultShardManagerBuilder.reactive(sink: Sinks.Many? = null, block: ReactiveEventManager.() -> Unit = {}) = setEventManagerProvider { createManager(sink, block) } 115 | 116 | /** 117 | * Creates a new [ReactiveEventManager] 118 | * 119 | * @return The [ReactiveEventManager]. 120 | */ 121 | inline fun createManager(sink: Sinks.Many? = null, block: ReactiveEventManager.() -> Unit = {}): ReactiveEventManager { 122 | val manager = if (sink != null) ReactiveEventManager(sink) 123 | else ReactiveEventManager() 124 | return manager.apply(block) 125 | } --------------------------------------------------------------------------------