commit 115e8fcb20bff18ed0e8fbf6c596d7519364eafa Author: Paldiu Date: Thu Jul 7 23:09:25 2022 -0500 SimplexSS (Scheduling Service) A reactive non-blocking api for scheduling runnable tasks (now called Services) using Reactor (https://reactorproject.io) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..dfe0770 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..068b4c3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* +replay_pid* + +# IDE +.idea/ +.gradle/ +gradle/ +.m2 +*.iml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bfeb0c3 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Paldiu + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0c300bc --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# SimplexSS + A reactive non blocking api for scheduling runnable tasks (called services) diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..216f392 --- /dev/null +++ b/build.gradle @@ -0,0 +1,53 @@ +plugins { + id 'java' + id 'com.github.johnrengelman.shadow' version '7.1.2' +} + +group = 'io.github.simplex' +version = '1.0.0' + +repositories { + mavenCentral() + maven { + name = 'papermc-repo' + url = 'https://repo.papermc.io/repository/maven-public/' + } + maven { + name = 'sonatype' + url = 'https://oss.sonatype.org/content/groups/public/' + } +} + +dependencies { + compileOnly 'io.papermc.paper:paper-api:1.19-R0.1-SNAPSHOT' + shadow 'io.projectreactor:reactor-core:3.4.19' +} + +shadowJar { + relocate ('reactor', "io.github.simplex.reactor") +} + +def targetJavaVersion = 17 +java { + def javaVersion = JavaVersion.toVersion(targetJavaVersion) + sourceCompatibility = javaVersion + targetCompatibility = javaVersion + if (JavaVersion.current() < javaVersion) { + toolchain.languageVersion = JavaLanguageVersion.of(targetJavaVersion) + } +} + +tasks.withType(JavaCompile).configureEach { + if (targetJavaVersion >= 10 || JavaVersion.current().isJava10Compatible()) { + options.release = targetJavaVersion + } +} + +processResources { + def props = [version: version] + inputs.properties props + filteringCharset 'UTF-8' + filesMatching('plugin.yml') { + expand props + } +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..e69de29 diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..c53aefa --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original 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 POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${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 "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# 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 ;; #( + MSYS* | 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" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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 Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@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 execute + +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 execute + +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 + +: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 %* + +: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 b/settings.gradle new file mode 100644 index 0000000..9c05ebc --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'SimplexSS' diff --git a/src/main/java/io/github/simplex/api/ExecutableService.java b/src/main/java/io/github/simplex/api/ExecutableService.java new file mode 100644 index 0000000..8b6bbad --- /dev/null +++ b/src/main/java/io/github/simplex/api/ExecutableService.java @@ -0,0 +1,23 @@ +package io.github.simplex.api; + +import org.bukkit.plugin.Plugin; + +public abstract class ExecutableService implements Service { + private final int serviceID; + private final Plugin plugin; + + public ExecutableService(Plugin plugin, int serviceID) { + this.serviceID = serviceID; + this.plugin = plugin; + } + + @Override + public int getServiceID() { + return serviceID; + } + + @Override + public Plugin getProvidingPlugin() { + return plugin; + } +} diff --git a/src/main/java/io/github/simplex/api/Scheduler.java b/src/main/java/io/github/simplex/api/Scheduler.java new file mode 100644 index 0000000..72fc06a --- /dev/null +++ b/src/main/java/io/github/simplex/api/Scheduler.java @@ -0,0 +1,16 @@ +package io.github.simplex.api; + +import io.github.simplex.simplexss.ServiceManager; +import reactor.core.publisher.Mono; + +public interface Scheduler { + Mono getServiceManager(); + + Mono queue(Service service); + + Mono runOnce(Service service); + + Mono forceStop(Service service); + + Mono forceStart(Service service); +} diff --git a/src/main/java/io/github/simplex/api/Service.java b/src/main/java/io/github/simplex/api/Service.java new file mode 100644 index 0000000..a8a88b6 --- /dev/null +++ b/src/main/java/io/github/simplex/api/Service.java @@ -0,0 +1,22 @@ +package io.github.simplex.api; + +import io.github.simplex.simplexss.ServiceManager; +import io.github.simplex.simplexss.ServicePool; +import org.bukkit.plugin.Plugin; +import reactor.core.publisher.Mono; + +public interface Service { + int getServiceID(); + + boolean isDelayed(); + + boolean isRepeating(); + + Mono start(); + + Mono stop(); + + Plugin getProvidingPlugin(); + + ServicePool getServicePool(); +} diff --git a/src/main/java/io/github/simplex/simplexss/SchedulingSystem.java b/src/main/java/io/github/simplex/simplexss/SchedulingSystem.java new file mode 100644 index 0000000..5e7b114 --- /dev/null +++ b/src/main/java/io/github/simplex/simplexss/SchedulingSystem.java @@ -0,0 +1,78 @@ +package io.github.simplex.simplexss; + +import io.github.simplex.api.Scheduler; +import io.github.simplex.api.Service; +import org.bukkit.plugin.Plugin; +import reactor.core.publisher.Mono; + +import java.util.HashSet; +import java.util.Set; + +public final class SchedulingSystem implements Scheduler { + private final ServiceManager serviceManager; + private final Plugin plugin; + private final Set repeatingPools; + private final Set delayedPools; + + public SchedulingSystem(ServiceManager serviceManager, Plugin plugin) { + this.serviceManager = serviceManager; + this.plugin = plugin; + this.repeatingPools = new HashSet<>(); + this.delayedPools = new HashSet<>(); + } + + public Set getRepeatingPools() { + return repeatingPools; + } + + public Set getDelayedPools() { + return delayedPools; + } + + @Override + public Mono getServiceManager() { + return Mono.just(serviceManager); + } + + @Override + public Mono queue(Service service) { + getServiceManager().doOnNext(m -> { + Mono pool = Mono.justOrEmpty(m.getAssociatedServicePool(service)); + pool.defaultIfEmpty(m.createServicePool(service)) + .map(p -> p.getService(service.getServiceID())) + .doOnNext(s -> { + if (s.getServicePool().isPoolDelayed()) { + getDelayedPools().add(s.getServicePool()); + } + if (s.getServicePool().isPoolRepeating()) { + getRepeatingPools().add(s.getServicePool()); + } + else { + runOnce(s).block(); + } + }); + }); + return Mono.empty(); + } + + @Override + public Mono runOnce(Service service) { + service.start().block(); + service.stop().block(); + return Mono.empty(); + } + + @Override + public Mono forceStop(Service service) { + return service.stop(); + } + + @Override + public Mono forceStart(Service service) { + return service.start(); + } + + public Plugin getProvidingPlugin() { + return plugin; + } +} diff --git a/src/main/java/io/github/simplex/simplexss/ServiceManager.java b/src/main/java/io/github/simplex/simplexss/ServiceManager.java new file mode 100644 index 0000000..0000965 --- /dev/null +++ b/src/main/java/io/github/simplex/simplexss/ServiceManager.java @@ -0,0 +1,62 @@ +package io.github.simplex.simplexss; + +import io.github.simplex.api.Service; +import org.bukkit.plugin.Plugin; +import org.jetbrains.annotations.Contract; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.HashSet; +import java.util.Set; +import java.util.stream.Stream; + +public final class ServiceManager { + private final Set servicePools; + private final Plugin plugin; + + public ServiceManager(Plugin plugin) { + this.plugin = plugin; + servicePools = new HashSet<>(); + } + + @Contract(pure = true, value = "_ -> new") + public @NotNull ServicePool createServicePool(Service... services) { + ServicePool pool = new ServicePool(); + Stream.of(services).forEach(pool::addService); + return pool; + } + + @Contract("_, _ -> param1") + public ServicePool addToExistingPool(@NotNull ServicePool pool, Service... services) { + Stream.of(services).forEach(pool::addService); + return pool; + } + + @Contract("_, _ -> param1") + public ServicePool takeFromExistingPool(@NotNull ServicePool pool, Service... services) { + Stream.of(services).forEach(pool::removeService); + return pool; + } + + public Set getServicePools() { + return servicePools; + } + + public boolean locateServiceWithinPools(Service service) { + return servicePools.stream().map(p -> p.isValidService(service)).findFirst().orElseGet(() -> false); + } + + public @Nullable ServicePool getAssociatedServicePool(Service service) { + if (!locateServiceWithinPools(service)) return null; + + return servicePools + .stream() + .filter(p -> p.getAssociatedServices().contains(service)) + .findFirst() + .orElseGet(() -> null); + } + + public Plugin getProvidingPlugin() { + return plugin; + } +} diff --git a/src/main/java/io/github/simplex/simplexss/ServicePool.java b/src/main/java/io/github/simplex/simplexss/ServicePool.java new file mode 100644 index 0000000..b9989b8 --- /dev/null +++ b/src/main/java/io/github/simplex/simplexss/ServicePool.java @@ -0,0 +1,56 @@ +package io.github.simplex.simplexss; + +import io.github.simplex.api.Service; + +import java.util.HashSet; +import java.util.Set; + +public final class ServicePool { + private final Set associatedServices; + private boolean delayed = false; + private boolean repeating = false; + + public ServicePool() { + this.associatedServices = new HashSet<>(); + } + + public void setDelayed(boolean delayed) { + this.delayed = delayed; + } + + public void setRepeating(boolean repeating) { + this.repeating = repeating; + } + + public boolean isPoolDelayed() { + return delayed; + } + + public boolean isPoolRepeating() { + return repeating; + } + + public void addService(Service service) { + getAssociatedServices().add(service); + } + + public boolean isValidService(Service service) { + return getAssociatedServices().contains(service); + } + + public Set getAssociatedServices() { + return associatedServices; + } + + public Service getService(int serviceID) { + return getAssociatedServices() + .stream() + .filter(s -> s.getServiceID() == serviceID) + .findFirst() + .orElse(null); + } + + public void removeService(Service service) { + getAssociatedServices().remove(service); + } +} diff --git a/src/main/java/io/github/simplex/simplexss/SimplexSS.java b/src/main/java/io/github/simplex/simplexss/SimplexSS.java new file mode 100644 index 0000000..ee106e0 --- /dev/null +++ b/src/main/java/io/github/simplex/simplexss/SimplexSS.java @@ -0,0 +1,17 @@ +package io.github.simplex.simplexss; + +import org.bukkit.plugin.java.JavaPlugin; + +public final class SimplexSS extends JavaPlugin { + + @Override + public void onEnable() { + // Plugin startup logic + + } + + @Override + public void onDisable() { + // Plugin shutdown logic + } +} diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml new file mode 100644 index 0000000..c137177 --- /dev/null +++ b/src/main/resources/plugin.yml @@ -0,0 +1,7 @@ +name: SimplexSS +version: '${version}' +main: io.github.simplex.simplexss.SimplexSS +api-version: 1.19 +authors: [ SimplexDevelopment ] +description: A Scheduler Service API written with Reactor designed to create fully reactive non-blocking tasks. +website: https://github.com/SimplexDevelopment