1
mirror of https://github.com/CarmJos/EasyPlugin.git synced 2026-06-05 00:58:17 +08:00

Compare commits

...

4 Commits

32 changed files with 1032 additions and 72 deletions
+24
View File
@@ -108,3 +108,27 @@ jobs:
git add -A
git commit -m "API Document generated."
git push origin HEAD:gh-pages --force
central-deploy:
name: "Deploy Project (Central)"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: "Set up JDK"
uses: actions/setup-java@v2
with:
java-version: '11'
distribution: 'adopt'
cache: maven
server-id: ossrh
server-username: MAVEN_USERNAME
server-password: MAVEN_PASSWORD
gpg-private-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} # Value of the GPG private key to import
gpg-passphrase: MAVEN_GPG_PASSPHRASE # env variable for GPG private key passphrase
- name: "Central Deploy"
run: mvn -B -Possrh deploy --file pom.xml -DskipTests
env:
MAVEN_USERNAME: ${{ secrets.OSSRH_USER }}
MAVEN_PASSWORD: ${{ secrets.OSSRH_PASS }}
MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+13 -6
View File
@@ -53,28 +53,34 @@
- Storage [`easyplugin-storage`](base/storage)
- 抽象存储管理器,便于实现不同的存储类型。
- 随本项目提供了 `FileBasedStorage``FolderBasedStorage` 等常用存储抽象方法。
- Messages [`easyplugin-message`](base/messages)
- 随本项目提供了基于 MineConfiguration 实现的 `EasyMessages` 类。
- 支持多种消息配置,包括文本消息、ActionBar消息、Title消息、声音、粒子效果播放等。
- 支持消息间的延迟发送。
> 以下项目均已独立出单独项目,仅仅是按照包名规则打包到EasyPlugin的子项目中。
>
> 如需使用,**强烈建议自行引用对应的项目**,以支持完整的Javadoc并获取源码内容!
- _Listener_ [`easyplugin-listener`](base/listener) (打包自 [**EasyListener**](https://github.com/CarmJos/EasyListener))
- _Configuration_ [`easyplugin-conf`](base/conf) (打包自 [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration))
- _Configuration_ [`easyplugin-conf`](base/conf) (打包自 [**MineConfiguration
**](https://github.com/CarmJos/MineConfiguration))
- _Database_ [`easyplugin-database`](base/database) (打包自 [**EasySQL**](https://github.com/CarmJos/EasySQL))
- _Messages*_ [`easyplugin-message`](base/message) (打包自 [**EasyMessages**](https://github.com/CarmJos/EasyMessages))
### 附属部分 (`/extension`)
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/)* [`easyplugin-placeholderapi`](extension/papi)
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) [`easyplugin-placeholderapi`](extension/papi)
- [Vault](https://github.com/MilkBowl/VaultAPI)* [`easyplugin-vault`](extension/vault)
## 开发
详细开发介绍请 [点击这里](.documentation/README.md) , JavaDoc(最新Release) 请 [点击这里](https://carmjos.github.io/EasyPlugin) 。
详细开发介绍请 [点击这里](.documentation/README.md) , JavaDoc(最新Release)
请 [点击这里](https://carmjos.github.io/EasyPlugin) 。
### 示例代码
您可以 [点击这里](https://github.com/CarmJos/UltraDepository) 查看实例项目演示,更多演示详见 [开发介绍](.documentation/README.md) 。
您可以 [点击这里](https://github.com/CarmJos/UltraDepository)
查看实例项目演示,更多演示详见 [开发介绍](.documentation/README.md) 。
### 依赖方式
@@ -181,7 +187,8 @@ dependencies {
> MIT 协议可能是几大开源协议中最宽松的一个,核心条款是:
>
> 该软件及其相关文档对所有人免费,可以任意处置,包括使用,复制,修改,合并,发表,分发,再授权,或者销售。唯一的限制是,软件中必须包含上述版 权和许可提示。
> 该软件及其相关文档对所有人免费,可以任意处置,包括使用,复制,修改,合并,发表,分发,再授权,或者销售。唯一的限制是,软件中必须包含上述版
> 权和许可提示。
>
> 这意味着:
> - 你可以自由使用,复制,修改,可以用于自己的项目。
+50
View File
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-parent</artifactId>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
<maven.compiler.source>${project.jdk.version}</maven.compiler.source>
<maven.compiler.target>${project.jdk.version}</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
</properties>
<artifactId>easyplugin-color</artifactId>
<name>EasyPlugin-Color</name>
<description>轻松插件颜色模块,支持简单便捷的颜色解析器,包括基本颜色、RGB颜色与RGB渐变颜色。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
<developers>
<developer>
<id>CarmJos</id>
<name>Carm Jos</name>
<email>carm@carm.cc</email>
<url>https://www.carm.cc</url>
</developer>
</developers>
<licenses>
<license>
<name>The MIT License</name>
<url>https://opensource.org/licenses/MIT</url>
</license>
</licenses>
<issueManagement>
<system>GitHub Issues</system>
<url>https://github.com/CarmJos/EasyPlugin/issues</url>
</issueManagement>
<ciManagement>
<system>GitHub Actions</system>
<url>https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml</url>
</ciManagement>
</project>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -46,7 +46,8 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
public abstract Void noPermission(CommandSender sender);
public Void onException(CommandSender sender, SubCommand<?> cmd, Exception ex) {
sender.sendMessage("Error occurred when executing " + cmd.getName() + ": " + ex.getLocalizedMessage());
sender.sendMessage("Error occurred when executing " + cmd.getIdentifier() + ": " + ex.getLocalizedMessage());
ex.printStackTrace();
return null;
}
@@ -56,27 +57,34 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
}
@Override
public String getName() {
public @NotNull String getIdentifier() {
return this.cmd;
}
public void registerSubCommand(SubCommand<?> command) {
String name = command.getName().toLowerCase();
String name = command.getIdentifier().toLowerCase();
this.registeredCommands.put(name, command);
command.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
}
public void registerHandler(CommandHandler handler) {
String name = handler.getName().toLowerCase();
String name = handler.getIdentifier().toLowerCase();
this.registeredHandlers.put(name, handler);
handler.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
}
@Override
public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, String[] args) {
if (!this.hasPermission(sender)) {
noPermission(sender);
return true;
}
if (args.length == 0) {
this.noArgs(sender);
} else {
return true;
}
String input = args[0].toLowerCase();
CommandHandler handler = getHandler(input);
@@ -86,6 +94,7 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
} else {
handler.onCommand(sender, command, label, this.shortenArgs(args));
}
return true;
}
SubCommand<?> sub = getSubCommand(input);
@@ -96,14 +105,11 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
} else {
try {
sub.execute(this.plugin, sender, this.shortenArgs(args));
} catch (ArrayIndexOutOfBoundsException ex) {
this.unknownCommand(sender, args);
} catch (Exception ex) {
this.onException(sender, sub, ex);
}
}
}
return true;
}
@@ -115,7 +121,7 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
if (args.length == 1) {
return getExecutors().stream()
.filter(e -> e.hasPermission(sender))
.map(NamedExecutor::getName)
.map(NamedExecutor::getIdentifier)
.filter(s -> StringUtil.startsWithIgnoreCase(s, input))
.collect(Collectors.toList());
} else {
@@ -139,7 +145,7 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
executors.addAll(this.registeredHandlers.values());
executors.addAll(this.registeredCommands.values());
List<NamedExecutor> sortedExecutors = new ArrayList<>(executors);
sortedExecutors.sort(Comparator.comparing(NamedExecutor::getName));
sortedExecutors.sort(Comparator.comparing(NamedExecutor::getIdentifier));
return sortedExecutors;
}
@@ -11,16 +11,16 @@ import java.util.function.Function;
public interface NamedExecutor {
String getName();
@NotNull String getIdentifier();
List<String> getAliases();
@NotNull List<String> getAliases();
default boolean hasPermission(CommandSender sender) {
default boolean hasPermission(@NotNull CommandSender sender) {
return true;
}
default Void sendMessage(@NotNull CommandSender sender, @NotNull String... messages) {
return sendMessage(sender, (Function<String, String>) null, messages);
return sendMessage(sender, Function.identity(), messages);
}
default Void sendMessage(@NotNull CommandSender sender,
@@ -14,12 +14,12 @@ public abstract class SubCommand<C extends CommandHandler> implements NamedExecu
private final @NotNull C parent;
private final String name;
private final String identifier;
private final List<String> aliases;
public SubCommand(@NotNull C parent, String name, String... aliases) {
public SubCommand(@NotNull C parent, String identifier, String... aliases) {
this.parent = parent;
this.name = name;
this.identifier = identifier;
this.aliases = Arrays.asList(aliases);
}
@@ -28,13 +28,13 @@ public abstract class SubCommand<C extends CommandHandler> implements NamedExecu
}
@Override
public String getName() {
return this.name;
public @NotNull String getIdentifier() {
return this.identifier;
}
@Override
@Unmodifiable
public List<String> getAliases() {
public @NotNull List<String> getAliases() {
return this.aliases;
}
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -0,0 +1,208 @@
package cc.carm.lib.easyplugin.utils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.awt.*;
import java.util.List;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
/**
* 颜色解析器。
* <br> 普通颜色 格式 {@code &+颜色代码 },如 {@literal &c} 、{@literal &a}
* <br> RGB颜色(版本需要≥1.14) 格式 {@code &(#XXXXXX) },如 {@literal &(#aaaaaa)}
* <br> 渐变RBG颜色(版本需要≥1.14) 格式 {@code &<#XXXXXX>FOOBAR&<#XXXXXX> }
* <p> 注意:当使用渐变RGB颜色时,普通颜色代码与RGB颜色代码将失效。
*/
public class ColorParser {
public static final Pattern HEX_PATTERN = Pattern.compile("&\\(&?#([\\da-fA-F]{6})\\)");
public static final Pattern GRADIENT_PATTERN = Pattern.compile("&<&?#([\\da-fA-F]{6})>");
public static final Pattern COLOR_PATTERN = Pattern.compile("([&§][0-9a-fA-FrRxX])+"); // 会影响颜色的代码
public static final Pattern FORMAT_PATTERN = Pattern.compile("([&§][0-9a-fA-Fk-oK-OrRxX])+"); // MC可用的格式化代码
/**
* 清除一条消息中的全部颜色代码 (包括RGB颜色代码与渐变颜色代码)
*
* @param text 源消息内容
* @return 清理颜色后的消息
*/
public static @NotNull String clear(@NotNull String text) {
text = HEX_PATTERN.matcher(text).replaceAll("");
text = GRADIENT_PATTERN.matcher(text).replaceAll("");
text = COLOR_PATTERN.matcher(text).replaceAll("");
return text;
}
/**
* 对一条消息进行颜色解析,包括普通颜色代码、RGB颜色代码与RBG渐变代码。
*
* @param text 源消息内容
* @return 解析后的消息
*/
public static @NotNull String parse(@NotNull String text) {
return parseBaseColor(parseGradientColor(parseHexColor(text)));
}
/**
* 对多条消息进行颜色解析,包括普通颜色代码、RGB颜色代码与RBG渐变代码。
*
* @param texts 源消息内容
* @return 解析后的消息
*/
public static @NotNull String[] parse(@NotNull String... texts) {
return parse(Arrays.asList(texts)).toArray(new String[0]);
}
/**
* 对多条消息进行颜色解析,包括普通颜色代码、RGB颜色代码与RBG渐变代码。
*
* @param texts 源消息内容
* @return 解析后的消息
*/
public static @NotNull List<String> parse(@NotNull Collection<String> texts) {
return texts.stream().map(ColorParser::parse).collect(Collectors.toList());
}
/**
* 解析消息中的基本颜色代码格式 {@code &+颜色代码 },如 {@literal &c} 、{@literal &a}
*
* @param text 消息内容
* @return RGB处理后的消息
* @see net.md_5.bungee.api.ChatColor
*/
public static String parseBaseColor(final String text) {
return text.replaceAll("&", "§").replace("§§", "&");
}
/**
* 解析消息中的RGB颜色代码(版本需要≥1.14) 格式 {@code &(#XXXXXX) },如 {@literal &(#aaaaaa)}
*
* @param text 消息内容
* @return RGB处理后的消息
*/
public static String parseHexColor(String text) {
Matcher matcher = HEX_PATTERN.matcher(text);
while (matcher.find()) {
text = matcher.replaceFirst(buildHexColor(matcher.group(1)).toLowerCase());
matcher.reset(text);
}
return text;
}
/**
* 对一条消息进行RGB渐变处理(版本需要≥1.14),格式 {@code &<#XXXXXX>FOOBAR&<#XXXXXX> }。
*
* @param text 消息内容
* @return RGB渐变处理后的消息
*/
public static @NotNull String parseGradientColor(@NotNull String text) {
List<String> colors = new ArrayList<>();
Matcher matcher = ColorParser.GRADIENT_PATTERN.matcher(text);
while (matcher.find()) colors.add(matcher.group(1));
if (colors.isEmpty()) return text; // 无渐变颜色,直接跳出
String[] parts = ColorParser.GRADIENT_PATTERN.split(text);
StringBuilder builder = new StringBuilder();
for (int i = 0; i < parts.length; i++) {
String startHex = i - 1 >= 0 && colors.size() > i - 1 ? colors.get(i - 1) : null; // 本条消息的起始颜色
String endHex = colors.size() > i ? colors.get(i) : null; // 本条消息的结束颜色
builder.append(gradientText(parts[i], startHex, endHex));
}
return builder.toString();
}
public static @NotNull String gradientText(@NotNull String text,
@Nullable Color startColor, @Nullable Color endColor) {
Objects.requireNonNull(text, "Text to be gradient should not be null!");
if (startColor == null || endColor == null || text.isEmpty()) {
// 起始颜色有任一为空,则不进行渐变上色。
// 若有起始颜色,则代表其跟在某个渐变之后,应当添加"&r"阻断前面的渐变。
return (startColor != null ? "&r" : "") + text;
}
// 用于记录消息中特殊格式的位置
// 在渐变中,允许使用格式字符与颜色字符来改变其中某个字的颜色/格式,以支持更多形式内容。
LinkedHashMap<Integer, String> extraFormats = new LinkedHashMap<>();
Matcher matcher = ColorParser.FORMAT_PATTERN.matcher(text);
while (matcher.find()) {
extraFormats.put(matcher.start(), matcher.group());
text = matcher.replaceFirst("");
matcher.reset(text);
}
if (text.length() == 1) {
// 当只有一个实际字符时,无需进行渐变计算,直接返回 中间颜色+起始格式(如果有)+消息 即可。
return colorText(text, extraFormats.get(0), buildHexColor(mediumHex(startColor, endColor)));
}
String[] characters = text.split("");
int step = characters.length; // 变换次数
// 决定每种颜色变换的方向
int rDirection = startColor.getRed() < endColor.getRed() ? 1 : -1;
int gDirection = startColor.getGreen() < endColor.getGreen() ? 1 : -1;
int bDirection = startColor.getBlue() < endColor.getBlue() ? 1 : -1;
// 决定每种颜色每次变换的度
int rStep = Math.abs(startColor.getRed() - endColor.getRed()) / (step - 1);
int gStep = Math.abs(startColor.getGreen() - endColor.getGreen()) / (step - 1);
int bStep = Math.abs(startColor.getBlue() - endColor.getBlue()) / (step - 1);
String[] hexes = IntStream.range(0, step).mapToObj(i -> colorToHex(
startColor.getRed() + rStep * i * rDirection,
startColor.getGreen() + gStep * i * gDirection,
startColor.getBlue() + bStep * i * bDirection
)).toArray(String[]::new);
return IntStream.range(0, characters.length)
.mapToObj(i -> colorText(characters[i], extraFormats.get(i), buildHexColor(hexes[i])))
.collect(Collectors.joining());
}
protected static String gradientText(@NotNull String text, @Nullable String startHex, @Nullable String endHex) {
return gradientText(text,
startHex == null ? null : Color.decode("0x" + startHex),
endHex == null ? null : Color.decode("0x" + endHex)
);
}
private static String mediumHex(@NotNull Color start, @NotNull Color end) {
return colorToHex(
Math.abs(start.getRed() - end.getRed()) / 2,
Math.abs(start.getGreen() - end.getGreen()) / 2,
Math.abs(start.getBlue() - end.getBlue()) / 2
);
}
private static String colorText(String message, @Nullable String format, @Nullable String color) {
if (format != null && COLOR_PATTERN.matcher(format).find()) {
// format中存在影响颜色的内容,则当前消息的颜色会被覆盖。
// 为了减少最终消息的长度,故直接返回键入的FORMAT和对应消息的内容。
return format + message;
}
return (color == null ? "" : color) + (format == null ? "" : parseBaseColor(format)) + message;
}
protected static String colorToHex(Color color) {
return colorToHex(color.getRed(), color.getGreen(), color.getBlue());
}
protected static String colorToHex(int r, int g, int b) {
// 将R、G、B转换为16进制(若非2位则补0)输出
return String.format("%02X%02X%02X", r, g, b);
}
protected static String buildHexColor(String hexCode) {
return Arrays.stream(hexCode.split("")).map(s -> '§' + s)
.collect(Collectors.joining("", '§' + "x", ""));
}
}
+21
View File
@@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-parent</artifactId>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<artifactId>easyplugin-messages</artifactId>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
</project>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+10 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -22,6 +22,15 @@
<description>轻松插件工具类模块,该模块中的内容支持在Bungee、Bukkit使用。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>easyplugin-color</artifactId>
<version>${project.version}</version>
<scope>compile</scope>
</dependency>
</dependencies>
<developers>
<developer>
<id>CarmJos</id>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -0,0 +1,231 @@
package cc.carm.lib.easyplugin.papi;
import cc.carm.lib.easyplugin.papi.expansion.SectionExpansion;
import cc.carm.lib.easyplugin.papi.expansion.SubExpansion;
import cc.carm.lib.easyplugin.papi.handler.PlaceholderHandler;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.OfflinePlayer;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Supplier;
public class EasyPlaceholder extends PlaceholderExpansion {
protected final @NotNull String plugin;
protected final @NotNull SectionExpansion rootExpansion;
protected final @NotNull String name;
protected final @NotNull String author;
protected final @NotNull String version;
protected final boolean persistent;
public EasyPlaceholder(@NotNull JavaPlugin plugin, @NotNull String rootIdentifier) {
this(
plugin.getName(), true, rootIdentifier,
plugin.getName(), plugin.getDescription().getVersion(),
String.join(", ", plugin.getDescription().getAuthors())
);
}
public EasyPlaceholder(@NotNull JavaPlugin plugin, @NotNull SectionExpansion rootExpansion) {
this(
plugin.getName(), true, rootExpansion,
plugin.getName(), plugin.getDescription().getVersion(),
String.join(", ", plugin.getDescription().getAuthors())
);
}
public EasyPlaceholder(@NotNull String plugin, boolean persistent, @NotNull String rootIdentifier,
@NotNull String name, @NotNull String version, @NotNull String author) {
super();
this.plugin = plugin;
this.name = name;
this.author = author;
this.version = version;
this.persistent = persistent;
this.rootExpansion = new SectionExpansion(this, rootIdentifier);
}
public EasyPlaceholder(@NotNull String plugin, boolean persistent,
@NotNull SectionExpansion rootExpansion,
@NotNull String name, @NotNull String version, @NotNull String author) {
super();
this.plugin = plugin;
this.name = name;
this.author = author;
this.version = version;
this.persistent = persistent;
this.rootExpansion = rootExpansion;
}
/**
* 得到根变量解析器
*
* @return 根变量解析器
*/
public @NotNull SectionExpansion getRootExpansion() {
return rootExpansion;
}
/**
* 当未找到对应变量处理器时调用
*
* @param player 变量解析时的目标玩家,可能为空或不在线。
* @return 返回给玩家的内容
*/
public String onErrorParams(@Nullable OfflinePlayer player) {
return "Wrong params";
}
/**
* 当变量处理器返回 NULL 值时调用
*
* @param player 变量解析时的目标玩家,可能为空或不在线。
* @return 返回给玩家的内容
*/
public String onNullResponse(@Nullable OfflinePlayer player) {
return "";
}
/**
* 当变量处理器抛出异常时调用
*
* @param player 变量解析时的目标玩家,可能为空或不在线。
* @param expansion 抛出异常的变量处理器
* @param exception 异常内容
* @return 返回给玩家的内容
*/
public String onException(@Nullable OfflinePlayer player, @NotNull SubExpansion<?> expansion, @NotNull Exception exception) {
exception.printStackTrace();
return "Error \"" + expansion.getIdentifier() + "\"";
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, aliases);
return this;
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param paramsConsumer 用于提供该变量的可用参数
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull Consumer<ArrayList<String>> paramsConsumer, @NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, paramsConsumer, aliases);
return this;
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull List<String> availableParams, @NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, availableParams, aliases);
return this;
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handle(String identifier, @NotNull PlaceholderHandler handler,
@NotNull Supplier<List<String>> availableParams, @NotNull String... aliases) {
this.rootExpansion.handle(identifier, handler, availableParams, aliases);
return this;
}
/**
* 处理一组变量。
*
* @param section 该组变量的标识符
* @param consumer 该组变量的处理器操作方法
* <br> 在其中可调用 {@link SectionExpansion#handle(String, PlaceholderHandler, String...)} 方法处理子变量,
* <br> 或者调用 {@link SectionExpansion#handleSection(String, Consumer, String...)} 方法处理下一层组变量
* @param aliases 该变量的别称
* @return {@link EasyPlaceholder}
*/
public final EasyPlaceholder handleSection(@NotNull String section,
@NotNull Consumer<SectionExpansion> consumer,
@NotNull String... aliases) {
this.rootExpansion.handleSection(section, consumer, aliases);
return this;
}
@Override
public String onRequest(@Nullable OfflinePlayer player, @NotNull String params) {
String[] args = params.split("_");
if (args.length == 0) return onErrorParams(player);
Object response = rootExpansion.handleRequest(player, args);
if (response == null) return onNullResponse(player);
else return response.toString();
}
@Override
public @Nullable String getRequiredPlugin() {
return this.plugin;
}
@Override
public @NotNull String getIdentifier() {
return this.rootExpansion.getIdentifier();
}
@Override
public @NotNull String getAuthor() {
return this.author;
}
@Override
public @NotNull String getVersion() {
return this.version;
}
@Override
public @NotNull String getName() {
return this.name;
}
@Override
public @NotNull List<String> getPlaceholders() {
return this.rootExpansion.listPlaceholders();
}
@Override
public boolean persist() {
return this.persistent;
}
}
@@ -0,0 +1,13 @@
package cc.carm.lib.easyplugin.papi.expansion;
import org.jetbrains.annotations.NotNull;
import java.util.List;
public interface EasyExpansion {
@NotNull String getIdentifier();
@NotNull List<String> getAliases();
}
@@ -0,0 +1,219 @@
package cc.carm.lib.easyplugin.papi.expansion;
import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
import cc.carm.lib.easyplugin.papi.handler.PlaceholderHandler;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.function.Consumer;
import java.util.function.Supplier;
public class SectionExpansion implements EasyExpansion {
protected final EasyPlaceholder root;
protected final @NotNull String identifier;
protected final @NotNull List<String> aliases;
protected final @NotNull Map<String, SectionExpansion> registeredSections = new HashMap<>();
protected final @NotNull Map<String, SubExpansion<?>> registeredExpansions = new HashMap<>();
protected final @NotNull Map<String, String> aliasesMap = new HashMap<>();
public SectionExpansion(@NotNull EasyPlaceholder root,
@NotNull String identifier, @NotNull String... aliases) {
this(root, identifier, Arrays.asList(aliases));
}
public SectionExpansion(@NotNull EasyPlaceholder root,
@NotNull String identifier, @NotNull List<String> aliases) {
this.root = root;
this.identifier = identifier;
this.aliases = aliases;
}
public EasyPlaceholder getRoot() {
return root;
}
@NotNull
@Override
public String getIdentifier() {
return identifier;
}
@Override
public @NotNull List<String> getAliases() {
return this.aliases;
}
public void register(@NotNull SubExpansion<?> placeholder) {
String name = placeholder.getIdentifier().toLowerCase();
this.registeredExpansions.put(name, placeholder);
placeholder.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
}
public final void register(@NotNull SectionExpansion placeholder) {
String name = placeholder.getIdentifier().toLowerCase();
this.registeredSections.put(name, placeholder);
placeholder.getAliases().forEach(alias -> this.aliasesMap.put(alias.toLowerCase(), name));
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull String... aliases) {
handle(identifier, handler, Collections.emptyList(), aliases);
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param paramsConsumer 用于提供该变量的可用参数
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull Consumer<ArrayList<String>> paramsConsumer, @NotNull String... aliases) {
handle(identifier, handler, () -> {
ArrayList<String> params = new ArrayList<>();
paramsConsumer.accept(params);
return params;
}, aliases);
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull List<String> availableParams, @NotNull String... aliases) {
handle(identifier, handler, () -> availableParams, aliases);
}
/**
* 处理变量并返回对应内容。
*
* @param identifier 该变量的标识符
* @param handler 该变量的处理器,返回值将会被转换为字符串。
* @param availableParams 该变量的可用参数
* @param aliases 该变量的别称
*/
public final void handle(@NotNull String identifier, @NotNull PlaceholderHandler handler,
@NotNull Supplier<List<String>> availableParams, @NotNull String... aliases) {
register(new SubExpansion<SectionExpansion>(this, identifier, aliases) {
@Override
public Object handle(@Nullable OfflinePlayer player, @NotNull String[] args) throws Exception {
return handler.handle(player, args);
}
@Override
public List<String> listAvailableParams() {
return availableParams.get();
}
});
}
/**
* 处理一组变量。
*
* @param section 该组变量的标识符
* @param consumer 该组变量的处理器操作方法
* <br> 在其中可调用 {@link SectionExpansion#handle(String, PlaceholderHandler, String...)} 方法处理子变量,
* <br> 或者调用 {@link SectionExpansion#handleSection(String, Consumer, String...)} 方法处理下一层组变量
* @param aliases 该变量的别称
*/
public final void handleSection(@NotNull String section, @NotNull Consumer<SectionExpansion> consumer,
@NotNull String... aliases) {
SectionExpansion sectionExpansion = new SectionExpansion(getRoot(), section, aliases);
consumer.accept(sectionExpansion);
register(sectionExpansion);
}
public final @Nullable Object handleRequest(@Nullable OfflinePlayer player, @NotNull String[] args) {
if (args.length == 0) return getRoot().onErrorParams(player);
String input = args[0].toLowerCase();
SectionExpansion group = getHandler(input);
if (group != null) return group.handleRequest(player, this.shortenArgs(args));
SubExpansion<?> sub = getSubPlaceholder(input);
if (sub == null) return getRoot().onErrorParams(player);
try {
return sub.handle(player, this.shortenArgs(args));
} catch (Exception ex) {
return getRoot().onException(player, sub, ex);
}
}
public List<String> listPlaceholders() {
List<String> placeholders = new ArrayList<>();
String currentID = getIdentifier();
for (SectionExpansion section : this.registeredSections.values()) {
for (String groupID : section.listPlaceholders()) {
placeholders.add(currentID + "_" + groupID);
}
}
for (SubExpansion<?> placeholder : this.registeredExpansions.values()) {
String identifier = placeholder.getIdentifier();
List<String> params = placeholder.listAvailableParams();
if (params.isEmpty()) {
placeholders.add(currentID + "_" + identifier);
continue;
}
for (String param : params) {
placeholders.add(currentID + "_" + identifier + "_" + param);
}
}
return placeholders;
}
protected @Nullable SectionExpansion getHandler(@NotNull String name) {
SectionExpansion fromName = this.registeredSections.get(name);
if (fromName != null) return fromName;
String nameFromAlias = this.aliasesMap.get(name);
if (nameFromAlias == null) return null;
else return this.registeredSections.get(nameFromAlias);
}
protected @Nullable SubExpansion<?> getSubPlaceholder(@NotNull String name) {
SubExpansion<?> fromName = this.registeredExpansions.get(name);
if (fromName != null) return fromName;
String nameFromAlias = this.aliasesMap.get(name);
if (nameFromAlias == null) return null;
else return this.registeredExpansions.get(nameFromAlias);
}
protected String[] shortenArgs(String[] args) {
if (args.length == 0) {
return args;
} else {
List<String> argList = new ArrayList<>(Arrays.asList(args).subList(1, args.length));
return argList.toArray(new String[0]);
}
}
}
@@ -0,0 +1,44 @@
package cc.carm.lib.easyplugin.papi.expansion;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
public abstract class SubExpansion<PARENT extends SectionExpansion> implements EasyExpansion {
protected final @NotNull PARENT parent;
protected final @NotNull String identifier;
protected final @NotNull List<String> aliases;
public SubExpansion(@NotNull PARENT parent,
@NotNull String identifier, @NotNull String... aliases) {
this.parent = parent;
this.identifier = identifier;
this.aliases = Arrays.asList(aliases);
}
public abstract Object handle(@Nullable OfflinePlayer player, @NotNull String[] args) throws Exception;
/**
* 用于提示此子变量的全部可用参数
*
* @return 该子变量的全部可用参数
*/
public List<String> listAvailableParams() {
return Collections.emptyList();
}
@Override
public @NotNull String getIdentifier() {
return this.identifier;
}
@Override
public @NotNull List<String> getAliases() {
return this.aliases;
}
}
@@ -0,0 +1,12 @@
package cc.carm.lib.easyplugin.papi.handler;
import org.bukkit.OfflinePlayer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@FunctionalInterface
public interface PlaceholderHandler {
@Nullable Object handle(@Nullable OfflinePlayer player, @NotNull String[] args) throws Exception;
}
@@ -0,0 +1,77 @@
package cc.carm.tests.easyplugin.papi;
import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
import cc.carm.lib.easyplugin.papi.expansion.SubExpansion;
import org.bukkit.OfflinePlayer;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.PlayerInventory;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
import java.util.Objects;
public class DemoPlaceholder extends EasyPlaceholder {
public DemoPlaceholder() {
super(
"TestPlugin", true, "TestPlaceholder",
"TestPlugin", "1.0.0", "Carm"
);
handle("version", (player, args) -> "1.0.0", "ver", "v");
handleSection("game", (section) -> {
// 即处理 %TestPlaceholder_game_items%
section.handle("items", ((player, args) -> {
if (player == null || !player.isOnline() || !(player instanceof Player)) return -1;
PlayerInventory inv = ((Player) player).getInventory();
return Arrays.stream(inv.getContents())
.filter(Objects::nonNull)
.mapToInt(ItemStack::getAmount)
.count();
}));
// 即处理 %TestPlaceholder_game_location% 或 %TestPlaceholder_game_loc%
section.handle("location", (player, args) -> {
if (player == null || !player.isOnline() || !(player instanceof Player)) return "Unknown";
return ((Player) player).getLocation();
}, "loc" /* 声明此变量的别称*/);
// 即处理 %TestPlaceholder_game_time%
section.handle("time", (player, args) -> System.currentTimeMillis());
section.handle("random",
(player, args) -> {
if (args.length == 0) return Math.random();
else if (args.length == 1) return Math.random() * Double.parseDouble(args[0]);
else if (args.length == 2) {
return Math.random() * (Double.parseDouble(args[1]) - Double.parseDouble(args[0])) + Double.parseDouble(args[0]);
} else return onErrorParams(player);
},
(params) -> {
params.add("<最小值>_<最大值>");
params.add("<基础值(乘随机数)>");
});
}, "g");
}
@Override
public String onErrorParams(@Nullable OfflinePlayer player) {
return super.onErrorParams(player);
}
@Override
public String onNullResponse(@Nullable OfflinePlayer player) {
return super.onNullResponse(player);
}
@Override
public String onException(@Nullable OfflinePlayer player, @NotNull SubExpansion<?> expansion, @NotNull Exception exception) {
return super.onException(player, expansion, exception);
}
}
@@ -0,0 +1,37 @@
package cc.carm.tests.easyplugin.papi;
import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
import org.junit.Test;
public class PlaceholderTest {
@Test
public void onTest() {
DemoPlaceholder placeholder = new DemoPlaceholder();
System.out.println("# Placeholders");
placeholder.getPlaceholders().forEach(s -> System.out.println(" -> " + s));
System.out.println();
System.out.println("# Request tests");
test(placeholder, "game_items");
test(placeholder, "g_time");
test(placeholder, "game_loc");
test(placeholder, "ver");
test(placeholder, "game_random");
test(placeholder, "game_random_0_5");
test(placeholder, "game_random_100");
System.out.println("# Error tests");
test(placeholder, "game_random_try");
}
private void test(EasyPlaceholder placeholder, String input) {
System.out.println(" " + input + " -> " + placeholder.onRequest(null, input));
}
}
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.18</version>
<version>1.5.0</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+3 -1
View File
@@ -15,12 +15,14 @@
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-parent</artifactId>
<packaging>pom</packaging>
<version>1.4.18</version>
<version>1.5.0</version>
<modules>
<module>base/color</module>
<module>base/utils</module>
<module>base/main</module>
<module>base/conf</module>
<module>base/messages</module>
<module>base/gui</module>
<module>base/command</module>
<module>base/storage</module>