feat: 初版提交

.gitignore

@@ -0,0 +1,43 @@
+.gradle
+.idea
+build/
+!gradle/wrapper/gradle-wrapper.jar
+!**/src/main/**/build/
+!**/src/test/**/build/
+
+### IntelliJ IDEA ###
+.idea/modules.xml
+.idea/jarRepositories.xml
+.idea/compiler.xml
+.idea/libraries/
+*.iws
+*.iml
+*.ipr
+out/
+!**/src/main/**/out/
+!**/src/test/**/out/
+
+### Eclipse ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+bin/
+!**/src/main/**/bin/
+!**/src/test/**/bin/
+
+### NetBeans ###
+/nbproject/private/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+
+### VS Code ###
+.vscode/
+
+### Mac OS ###
+.DS_Store

README.md

@@ -0,0 +1,14 @@
+# hamster-script
+
+为 Minecraft 服务器引入 JavaScript 脚本执行功能
+
+# 指令
+
+| 指令                 | 权限                   | 描述                   |
+|:-------------------|:---------------------|:---------------------|
+| script eval {脚本内容} | hamster.script.admin | 直接执行 JavaScript 脚本   |
+| script run {脚本文件}  | hamster.script.admin | 执行文件中的 JavaScript 代码 |
+| script reset       | hamster.script.admin | 重设 JavaScript 引擎环境   |
+| script reload      | hamster.script.admin | 重载插件                 |
+
+> 执行命令的对象（玩家或控制台）会作为 sender 变量传入脚本执行

build.gradle.kts

@@ -0,0 +1,59 @@
+@file:Suppress("VulnerableLibrariesLocal")
+
+plugins {
+    id("java")
+}
+
+group = "cn.hamster3.mc.plugin"
+version = "1.0.0"
+
+val shade = configurations.create("shade")
+
+repositories {
+    maven {
+        url = uri("https://maven.airgame.net/maven-public/")
+    }
+}
+
+dependencies {
+    // https://mvnrepository.com/artifact/org.jetbrains/annotations
+    compileOnly("org.jetbrains:annotations:24.1.0")
+    // https://mvnrepository.com/artifact/org.projectlombok/lombok
+    compileOnly("org.projectlombok:lombok:1.18.30")
+    annotationProcessor("org.projectlombok:lombok:1.18.30")
+
+    compileOnly("org.spigotmc:spigot-api:1.18.2-R0.1-SNAPSHOT")
+
+    // https://mvnrepository.com/artifact/org.openjdk.nashorn/nashorn-core
+    implementation("org.openjdk.nashorn:nashorn-core:15.4")
+    shade("org.openjdk.nashorn:nashorn-core:15.4")
+}
+
+
+tasks {
+    withType<JavaCompile>().configureEach {
+        options.encoding = "UTF-8"
+    }
+    withType<Jar>().configureEach {
+        from(rootProject.file("LICENSE"))
+        duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+    }
+    java {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+        withSourcesJar()
+    }
+    jar {
+        archiveBaseName = "HamsterScript"
+        destinationDirectory = rootProject.layout.buildDirectory
+
+        // from shade
+        from(shade.map { if (it.isDirectory) it else zipTree(it) })
+    }
+    processResources {
+        filesMatching("plugin.yml") {
+            expand(project.properties)
+        }
+        duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Mon Mar 04 18:08:15 CST 2024
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.4-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

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" "$@"

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

settings.gradle.kts

@@ -0,0 +1,2 @@
+rootProject.name = "hamster-script"
+

src/main/java/cn/hamster3/mc/plugin/script/HamsterScriptPlugin.java

@@ -0,0 +1,197 @@
+package cn.hamster3.mc.plugin.script;
+
+import lombok.Getter;
+import org.bukkit.command.Command;
+import org.bukkit.command.CommandSender;
+import org.bukkit.configuration.ConfigurationSection;
+import org.bukkit.configuration.file.FileConfiguration;
+import org.bukkit.plugin.java.JavaPlugin;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import javax.script.*;
+import java.io.File;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.StandardCopyOption;
+import java.util.*;
+import java.util.stream.Collectors;
+
+@SuppressWarnings("CallToPrintStackTrace")
+public class HamsterScriptPlugin extends JavaPlugin {
+    @Getter
+    private static ScriptEngine engine;
+    @Getter
+    private static Invocable invocable;
+    private static File codeFolder;
+    private boolean enableEvalCommand;
+
+    @Override
+    public void onEnable() {
+        reload();
+        codeFolder = new File(getDataFolder(), "code");
+        if (codeFolder.mkdirs()) {
+            getLogger().info("创建代码文件夹: " + codeFolder.getAbsolutePath());
+            try {
+                Files.copy(
+                        Objects.requireNonNull(getResource("code/example.js")),
+                        new File(codeFolder, "example.js").toPath(),
+                        StandardCopyOption.REPLACE_EXISTING
+                );
+            } catch (IOException ignored) {
+            }
+        }
+    }
+
+    private void reload() {
+        saveDefaultConfig();
+        reloadConfig();
+        FileConfiguration config = getConfig();
+        enableEvalCommand = config.getBoolean("enable-eval-command", false);
+        engine = new ScriptEngineManager(getClassLoader()).getEngineByName("JavaScript");
+        invocable = (Invocable) engine;
+        ConfigurationSection importConfig = config.getConfigurationSection("import");
+        if (importConfig != null) {
+            for (String key : importConfig.getKeys(false)) {
+                String string = importConfig.getString(key);
+                try {
+                    Class<?> clazz = Class.forName(string);
+                    engine.put(key, clazz);
+                    engine.eval(String.format("%s = %s.static;", key, key));
+                    getLogger().info("将 " + string + " 导入为 " + key);
+                } catch (ClassNotFoundException e) {
+                    getLogger().warning("将 " + string + " 导入为 " + key + " 失败：未找到这个类");
+                } catch (ScriptException e) {
+                    getLogger().warning("将 " + string + " 导入为 " + key + " 失败");
+                    e.printStackTrace();
+                }
+            }
+        }
+
+    }
+
+    @Override
+    public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) {
+        if (!sender.hasPermission("hamster.script.admin")) {
+            sender.sendMessage("§c你没有这个权限");
+            return true;
+        }
+        if (args.length < 1) {
+            sender.sendMessage("§c请输入命令");
+            return true;
+        }
+        switch (args[0]) {
+            case "eval": {
+                if (!enableEvalCommand) {
+                    sender.sendMessage("§c当前不允许直接执行 JavaScript");
+                    return true;
+                }
+                if (args.length < 2) {
+                    sender.sendMessage("§c请输入 JavaScript 代码内容");
+                    return true;
+                }
+                StringBuilder builder = new StringBuilder();
+                for (int i = 1; i < args.length; i++) {
+                    builder.append(args[i]).append(" ");
+                }
+                String code = builder.toString();
+                long start = System.currentTimeMillis();
+                try {
+                    Bindings bindings = engine.createBindings();
+                    bindings.put("sender", sender);
+                    Object eval = engine.eval(code, bindings);
+                    long time = System.currentTimeMillis() - start;
+                    sender.sendMessage("§aJavaScript 代码执行完成, 耗时: " + time + " 毫秒");
+                    sender.sendMessage("§a返回值: §f" + eval);
+                } catch (ScriptException e) {
+                    long time = System.currentTimeMillis() - start;
+                    sender.sendMessage("§cJavaScript 代码执行出错, 耗时: " + time + " 毫秒");
+                    sender.sendMessage("§c异常原因: " + e.getMessage());
+                    e.printStackTrace();
+                }
+                break;
+            }
+            case "run": {
+                if (args.length < 2) {
+                    sender.sendMessage("§c请输入 JavaScript 文件名称");
+                    return true;
+                }
+                File file = new File(codeFolder, args[1]);
+                if (!file.exists() && !args[1].endsWith(".js")) {
+                    file = new File(codeFolder, args[1] + ".js");
+                }
+                if (!file.exists()) {
+                    sender.sendMessage("§c未找到 JavaScript 文件: " + file.getAbsolutePath());
+                    return true;
+                }
+                String code;
+                try {
+                    List<String> lines = Files.readAllLines(file.toPath(), StandardCharsets.UTF_8);
+                    code = String.join("\n", lines);
+                } catch (IOException e) {
+                    sender.sendMessage("§c读取 JavaScript 文件内容 " + file.getAbsolutePath() + " 时出错！");
+                    e.printStackTrace();
+                    return true;
+                }
+                long start = System.currentTimeMillis();
+                try {
+                    Bindings bindings = engine.createBindings();
+                    bindings.put("sender", sender);
+                    Object eval = engine.eval(code, bindings);
+                    long time = System.currentTimeMillis() - start;
+                    sender.sendMessage("§aJavaScript 代码执行完成, 耗时: " + time + " 毫秒");
+                    sender.sendMessage("§a返回值: §f" + eval);
+                } catch (ScriptException e) {
+                    long time = System.currentTimeMillis() - start;
+                    sender.sendMessage("§cJavaScript 代码执行出错, 耗时: " + time + " 毫秒");
+                    sender.sendMessage("§c异常原因: " + e.getMessage());
+                    e.printStackTrace();
+                }
+                break;
+            }
+            case "reset": {
+                engine = new ScriptEngineManager().getEngineByName("JavaScript");
+                invocable = (Invocable) engine;
+                sender.sendMessage("§a已重设 JavaScript 引擎环境");
+                break;
+            }
+            case "reload": {
+                reload();
+                sender.sendMessage("§a插件重载完成");
+                break;
+            }
+            default: {
+                sender.sendMessage("§c未找到该命令");
+                break;
+            }
+        }
+        return true;
+    }
+
+    @Nullable
+    @Override
+    public List<String> onTabComplete(@NotNull CommandSender sender, @NotNull Command command, @NotNull String alias, @NotNull String[] args) {
+        if (args.length == 1) {
+            List<String> list = new ArrayList<>();
+            list.add("eval");
+            list.add("run");
+            list.add("reset");
+            list.add("reload");
+            String startWith = args[0].toLowerCase();
+            list.removeIf(o -> !o.startsWith(startWith));
+            return list;
+        }
+        if (args[0].equalsIgnoreCase("run")) {
+            File[] files = codeFolder.listFiles();
+            if (files != null) {
+                String startWith = args[1].toLowerCase();
+                return Arrays.stream(files)
+                        .map(File::getName)
+                        .filter(o -> o.toLowerCase().startsWith(startWith))
+                        .collect(Collectors.toList());
+            }
+        }
+        return Collections.emptyList();
+    }
+}

src/main/resources/code/example.js

@@ -0,0 +1,6 @@
+function sayHi(param) {
+    param.sendMessage("Hi!");
+}
+
+// 执行命令的对象会自动设置为变量 sender
+sayHi(sender);

src/main/resources/config.yml

@@ -0,0 +1,6 @@
+# 是否允许通过指令执行 JavaScript 代码
+enable-eval-command: false
+
+# 导入的 Java 代码
+import:
+  Bukkit: org.bukkit.Bukkit

src/main/resources/plugin.yml

@@ -0,0 +1,13 @@
+name: HamsterScript
+main: cn.hamster3.mc.plugin.script.HamsterScriptPlugin
+version: ${version}
+api-version: 1.13
+
+commands:
+  scripts:
+    aliases: script
+
+permissions:
+  hamster.script.admin:
+    description: Admin permission
+    default: op