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

Compare commits

..

42 Commits

Author SHA1 Message Date
carm ce1538003b feat(command): 提供指令别名映射模块,支持将插件内复杂的子指令简化为一个单独的指令,方便玩家使用。 2023-03-17 22:24:16 +08:00
carm fa4a97d60d feat(user): 提供便捷的用户数据库管理类 2023-03-12 00:26:52 +08:00
carm 85b7179867 fix(gui): 修复翻页GUI可能出现幽灵页的问题。 2023-03-05 12:09:52 +08:00
carm 391f9b6389 fix(gui): 修复翻页GUI可能出现幽灵页的问题。 2023-03-05 00:10:31 +08:00
carm 0e74d6864c feat(updater): 添加直接执行BukkitTask的方法 2023-03-04 01:17:08 +08:00
carm f5d2022d8b docs(color): 添加颜色代码帮助 2023-02-19 04:27:11 +08:00
carm d7303719dd ci(deploy): 修复本地部署出现的问题 2023-02-19 04:09:04 +08:00
carm 76b15f0cda ci(deploy): 修复中央库部署出现的问题 2023-02-19 04:01:21 +08:00
carm f97fd97a3c ci(deploy): 修复中央库部署出现的问题 2023-02-19 03:57:54 +08:00
carm 0c0249cab6 ci(deploy): 尝试中央库部署 2023-02-19 03:49:35 +08:00
carm 25eae114ad chore(deploy): 放弃中央库部署 2023-02-19 03:42:36 +08:00
carm edab1a822d chore(code): 修改方法名避免歧义 2023-02-19 03:36:25 +08:00
carm a9d26e179c feat(papi): 提供便捷的PlaceholderAPI变量实现类。 2023-02-19 03:32:19 +08:00
carm 3019216801 feat(papi): 提供便捷的PlaceholderAPI变量实现类。 2023-02-19 02:59:05 +08:00
carm 01250a65d1 refactor(color): 独立颜色模块 2023-02-18 19:06:48 +08:00
carm 088cc62855 fix(cmd): 修复CommandHandler处理异常的问题 2023-02-11 21:11:34 +08:00
carm 437d0ffb32 feat(utils): 独立基本类到单独项目中,便于使用。 2022-12-13 00:29:20 +08:00
carm d9b0689e63 feat(color): 添加清理颜色代码的方法 2022-11-28 16:12:01 +08:00
carm 62e7370622 feat(color): 继续完善渐变色解析。 2022-11-28 15:52:04 +08:00
carm 3d52d5db15 chore: 修改格式以便阅读 2022-11-27 23:32:39 +08:00
carm 9ad80b4916 feat(color): 为ColorParser支持RGB渐变颜色代码。 2022-11-27 22:58:00 +08:00
carm 9cff646226 docs(color): 添加ColorParser的Javadoc 2022-11-27 22:56:46 +08:00
carm 479f4592d1 feat(color): 为ColorParser支持RGB渐变颜色代码。 2022-11-27 22:53:33 +08:00
carm d2b3224b61 Merge pull request #7 from RedCarl/master
feat(color): ColorParser RGB gradient color support.
2022-11-27 21:10:58 +08:00
carm 7c72d910d9 feat(main): 在主类添加 supplySync、supplyAsync 操作方法。 2022-11-27 21:09:40 +08:00
RedCarl c822678043 ColorParser Update. 2022-11-10 23:27:24 +08:00
carm 98d9854d6f build(deps): 改用 spigot-api 2022-09-14 23:57:12 +08:00
carm 47b811dc33 feat(cooldown): 添加便捷的冷却时间工具类 2022-09-14 23:10:02 +08:00
carm 0b6e1ad3e4 feat(cooldown): 添加便捷的冷却时间工具类 2022-09-14 23:08:06 +08:00
carm 6863c02611 feat(gui): GUI原生物品配置读取 2022-09-11 23:25:17 +08:00
carm 7fc0663e89 feat(command): 允许子指令不处理报错,统一交由父CommandHandler处理。 2022-08-25 02:35:24 +08:00
carm b0c8091cb7 feat(command): 允许子指令不处理报错,统一交由父CommandHandler处理。 2022-08-25 02:34:24 +08:00
carm 8f03c2a1b3 feat(command): 为子命令提供父命令处理器的泛型,便于统一调用方法 2022-08-25 01:52:04 +08:00
carm 429eb9c6ec chore(event): 为同步/异步事件唤起方法添加Javadoc 2022-07-27 14:41:20 +08:00
carm 05e2c8fad0 chore(deps): 补充新项目到bom中。 2022-07-27 14:37:23 +08:00
carm a58fe4abd6 docs(proj): 修改措辞 2022-07-27 14:34:58 +08:00
carm 79a18f2669 docs(proj): 提供更多关于子项目内容的介绍。 2022-07-27 14:30:39 +08:00
carm e5fc8acddc feat(proj): 提供更多子项目打包,便于快速导入对应依赖。 2022-07-27 14:29:13 +08:00
carm fb125ee9bd chore(gui): 为GUIItem的onClick方法提供viewer参数。
close #6
2022-07-27 13:53:30 +08:00
carm 376cde3529 chore(cmd): 令 hasPermission() 判断的参数为 CommandSender 。 2022-07-10 10:13:06 +08:00
carm 6e555a700f chore(cmd): 移除单String参数的SubCommand构造函数 2022-07-10 05:36:30 +08:00
carm b7e9295685 chore(gui): 为 GUIConfiguration 添加 serialize() 方法。 2022-07-10 04:58:59 +08:00
48 changed files with 2416 additions and 152 deletions
+26 -3
View File
@@ -26,7 +26,7 @@ jobs:
server-password: MAVEN_TOKEN
- name: "Maven Deploy"
run: mvn -B -Pgithub deploy --file pom.xml -DskipTests
run: mvn -B -Pgithub deploy --file pom.xml -DskipTests -Dgpg.skip
env:
MAVEN_USERNAME: ${{ github.repository_owner }}
MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}}
@@ -42,9 +42,8 @@ jobs:
java-version: '8'
distribution: 'adopt'
cache: maven
- name: "Maven Deploy"
run: mvn -B -Plocal deploy --file pom.xml -DskipTests
run: mvn -B -Plocal deploy --file pom.xml -DskipTests -Dgpg.skip
- name: "Copy artifacts"
run: |
@@ -108,3 +107,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 }}
+1 -1
View File
@@ -25,7 +25,7 @@ jobs:
server-username: MAVEN_USERNAME
server-password: MAVEN_TOKEN
- name: "Package"
run: mvn -B package --file pom.xml -Dmaven.javadoc.skip=true
run: mvn -B package --file pom.xml -Dmaven.javadoc.skip=true -Dgpg.skip
env:
MAVEN_USERNAME: ${{ github.repository_owner }}
MAVEN_TOKEN: ${{secrets.GITHUB_TOKEN}}
+38 -8
View File
@@ -27,7 +27,7 @@
## 内容
项目初创不久,加 * 的仍在开发更新中...
项目初创不久,加 * 的仍在开发更新中...欢迎各路大佬帮助提供本项目的开发文档~
### 集合部分 (`/collection`)
@@ -36,25 +36,54 @@
### 主要部分 (`/base`)
- Color [`easyplugin-color`](base/color)
- 颜色工具类模块,提供功能全面的MC颜色解析转换工具。
- 支持 `&+颜色代码`(原版颜色)、`§(#XXXXXX)`(RGB颜色) 与 `&<#XXXXXX>`(前后标注RGB颜色渐变)。
- Utils [`easyplugin-utils`](base/utils)
- 通用工具类模块,该模块中的内容支持在Bungee、Bukkit使用。
- 本模块提供
- `ColorParser` 支持RGB颜色与RGB渐变色的颜色解析器。
- `EasyCooldown` 快速创造一个冷却时间的管理器。
- `JarResourceUtils` 快速读取Jar包内容的工具类。
- Main [`easyplugin-main`](base/main)
- 主要接口模块,提供了方便的插件入口类与相关工具类。
- Command [`easyplugin-command`](base/command)
- ~~Messages*~~ (已独立项目到 [**EasyMessages**](https://github.com/CarmJos/EasyMessages))
- ~~Configuration~~ (已独立项目到 [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration))
- ~~Database~~ (已独立项目到 [**EasySQL**](https://github.com/CarmJos/EasySQL))
- 指令接口模块,便于快速进行子指令的实现,并提供单独的TabComplete方法。
- 随本项目提供了 `SimpleCompleter` 类,用于快速创建补全的内容列表。
- GUI [`easyplugin-gui`](base/main)
- 简单便捷的箱子GUI接口,可以快速实现GUI中不同图标的点击功能。
- 随本项目提供了 `AutoPagedGUI` 等翻页GUI抽象类。
- Storage [`easyplugin-storage`](base/storage)
- 抽象存储管理器,便于实现不同的存储类型。
- 随本项目提供了 `FileBasedStorage``FolderBasedStorage` 等常用存储抽象方法。
- Messages [`easyplugin-message`](base/messages)
- 随本项目提供了基于 MineConfiguration 实现的 `EasyMessages` 类。
- 支持多种消息配置,包括文本消息、ActionBar消息、Title消息、声音、粒子效果播放等。
- 支持消息间的延迟发送。
### 独立项目部分
> 以下项目均已独立出单独项目,如需使用,**强烈建议自行引用对应的项目**,以支持完整的Javadoc并获取源码内容!
- _Listener_ -> [**EasyListener**](https://github.com/CarmJos/EasyListener)
- _Configuration_ -> [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration)
- _Database_ -> [**EasySQL**](https://github.com/CarmJos/EasySQL)
### 附属部分 (`/extension`)
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/)* [`easyplugin-placeholderapi`](extension/papi)
- [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) [`easyplugin-placeholderapi`](extension/papi)
- PlaceholderAPI 扩展模块,提供了方便的 PlaceholderAPI 变量注册方法。
- [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) 。
### 依赖方式
@@ -161,7 +190,8 @@ dependencies {
> MIT 协议可能是几大开源协议中最宽松的一个,核心条款是:
>
> 该软件及其相关文档对所有人免费,可以任意处置,包括使用,复制,修改,合并,发表,分发,再授权,或者销售。唯一的限制是,软件中必须包含上述版 权和许可提示。
> 该软件及其相关文档对所有人免费,可以任意处置,包括使用,复制,修改,合并,发表,分发,再授权,或者销售。唯一的限制是,软件中必须包含上述版
> 权和许可提示。
>
> 这意味着:
> - 你可以自由使用,复制,修改,可以用于自己的项目。
+59
View File
@@ -0,0 +1,59 @@
<?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.5</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>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -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", ""));
}
}
@@ -0,0 +1,50 @@
import cc.carm.lib.easyplugin.utils.ColorParser;
import org.junit.Test;
import java.util.LinkedHashMap;
import java.util.regex.Matcher;
import static cc.carm.lib.easyplugin.utils.ColorParser.*;
public class ColorParseTest {
@Test
public void test() {
System.out.println(" ");
System.out.println(parseGradientColor("&<#AAAAAA>我真的&<#BBBBBB>爱死&<#111111>你&<#FFFFFF>"));
// 测试穿插
System.out.println(parse("&<#AAAAAA>&l我&r真&b的&<#BBBBBB>&o爱死&<#111111>你&<#FFFFFF>了&r"));
System.out.println(parse("&<#AAAAAA>&l我&r真&(#666666)的&<#BBBBBB>&o爱死&<#111111>你&<#FFFFFF>了&r"));
System.out.println(parse("&r正常的颜色理应&c&l不受影响&r。"));
System.out.println(clear("&f测试&<#AAAAAA>清理颜色代码&<#111111> &&这样应该&(#666666)不被影响 &f。"));
}
@Test
public void formatReadTest() {
LinkedHashMap<Integer, String> formats = new LinkedHashMap<>();
String text = "&k&l &m&1我&k爱你爱你爱你&o吗?";
Matcher matcher = ColorParser.FORMAT_PATTERN.matcher(text);
while (matcher.find()) {
String code = matcher.group();
formats.put(matcher.start(), code);
text = matcher.replaceFirst("");
matcher.reset(text);
}
formats.forEach((index, code) -> System.out.println(index + " -> " + code));
String[] parts = text.split("");
StringBuilder builder = new StringBuilder();
for (int i = 0; i < parts.length; i++) {
String format = formats.get(i);
if (format != null) builder.append(ColorParser.parseBaseColor(format));
builder.append(parts[i]);
}
System.out.println(builder);
}
}
+61
View File
@@ -0,0 +1,61 @@
<?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.5</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-command-alias</artifactId>
<packaging>jar</packaging>
<name>EasyPlugin-Command-Alias</name>
<description>轻松插件指令别名映射模块,支持将插件内复杂的子指令简化为一个单独的指令,方便玩家使用。</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>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,51 @@
package cc.carm.lib.easyplugin.command.alias;
import org.bukkit.Location;
import org.bukkit.command.Command;
import org.bukkit.command.CommandSender;
import org.bukkit.command.SimpleCommandMap;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
public class AliasCommand extends Command {
protected final AliasCommandManager aliasCommandManager;
protected final String targetCommand;
public AliasCommand(String name, AliasCommandManager aliasCommandManager, String targetCommand) {
super(name);
this.aliasCommandManager = aliasCommandManager;
this.targetCommand = targetCommand;
}
protected SimpleCommandMap getCommandMap() {
return this.aliasCommandManager.getCommandMap();
}
protected String buildCommand(String[] args) {
return this.targetCommand + " " + String.join(" ", args);
}
@Override
public boolean execute(@NotNull CommandSender sender, @NotNull String commandLabel, @NotNull String[] args) {
return getCommandMap().dispatch(sender, buildCommand(args));
}
@NotNull
@Override
public List<String> tabComplete(@NotNull CommandSender sender, @NotNull String alias,
@NotNull String[] args, @Nullable Location location) throws IllegalArgumentException {
return Optional.ofNullable(getCommandMap().tabComplete(sender, buildCommand(args))).orElse(Collections.emptyList());
}
@NotNull
@Override
public List<String> tabComplete(@NotNull CommandSender sender, @NotNull String alias, @NotNull String[] args) throws IllegalArgumentException {
return tabComplete(sender, alias, args, null);
}
}
@@ -0,0 +1,88 @@
package cc.carm.lib.easyplugin.command.alias;
import org.bukkit.Bukkit;
import org.bukkit.command.Command;
import org.bukkit.command.SimpleCommandMap;
import org.bukkit.plugin.SimplePluginManager;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
/**
* 指令简化别名(简化映射)管理器
* <br>支持将插件内复杂的子指令简化为一个单独的指令,方便玩家使用。
*/
public class AliasCommandManager {
protected final @NotNull JavaPlugin plugin;
protected final @NotNull String prefix;
protected final @NotNull SimpleCommandMap commandMap;
protected final @NotNull Field knownCommandsFiled;
protected final @NotNull Map<String, AliasCommand> registeredCommands = new HashMap<>();
public AliasCommandManager(@NotNull JavaPlugin plugin) throws Exception {
this(plugin, plugin.getName());
}
public AliasCommandManager(@NotNull JavaPlugin plugin, @NotNull String prefix) throws Exception {
this.plugin = plugin;
this.prefix = prefix.trim();
SimplePluginManager manager = (SimplePluginManager) Bukkit.getPluginManager();
Field commandMapField = SimplePluginManager.class.getDeclaredField("commandMap");
commandMapField.setAccessible(true);
this.commandMap = (SimpleCommandMap) commandMapField.get(manager);
this.knownCommandsFiled = SimpleCommandMap.class.getDeclaredField("knownCommands");
this.knownCommandsFiled.setAccessible(true);
}
@SuppressWarnings("unchecked")
protected Map<String, Command> getKnownCommands() {
try {
return (Map<String, Command>) knownCommandsFiled.get(commandMap);
} catch (IllegalAccessException e) {
e.printStackTrace();
}
return new HashMap<>();
}
protected @NotNull SimpleCommandMap getCommandMap() {
return commandMap;
}
public String getCommandPrefix() {
return this.prefix;
}
public void register(@NotNull String alias, @NotNull String subCommand) {
AliasCommand current = this.registeredCommands.get(alias);
if (current != null) current.unregister(getCommandMap());
AliasCommand cmd = new AliasCommand(alias, this, getCommandPrefix() + " " + subCommand);
this.registeredCommands.put(alias, cmd);
getCommandMap().register(plugin.getName(), cmd);
}
public void unregister(@NotNull String alias) {
AliasCommand current = this.registeredCommands.remove(alias);
if (current != null) {
getKnownCommands().remove(alias);
current.unregister(getCommandMap());
}
}
public void unregisterAll() {
registeredCommands.forEach((k, v) -> {
getKnownCommands().remove(k);
v.unregister(getCommandMap());
});
registeredCommands.clear();
}
}
+11 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -48,4 +48,14 @@
<url>https://github.com/CarmJos/EasyPlugin/actions/workflows/maven.yml</url>
</ciManagement>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -11,13 +11,14 @@ import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.stream.Collectors;
@SuppressWarnings("UnusedReturnValue")
public abstract class CommandHandler implements TabExecutor, NamedExecutor {
protected final @NotNull JavaPlugin plugin;
protected final @NotNull String cmd;
protected final @NotNull List<String> aliases;
protected final @NotNull Map<String, SubCommand> registeredCommands = new HashMap<>();
protected final @NotNull Map<String, SubCommand<?>> registeredCommands = new HashMap<>();
protected final @NotNull Map<String, CommandHandler> registeredHandlers = new HashMap<>();
protected final @NotNull Map<String, String> aliasesMap = new HashMap<>();
@@ -36,13 +37,19 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
this.aliases = Arrays.asList(aliases);
}
public abstract void noArgs(CommandSender sender);
public abstract Void noArgs(CommandSender sender);
public void unknownCommand(CommandSender sender, String[] args) {
noArgs(sender);
public Void unknownCommand(CommandSender sender, String[] args) {
return noArgs(sender);
}
public abstract void noPermission(CommandSender sender);
public abstract Void noPermission(CommandSender sender);
public Void onException(CommandSender sender, SubCommand<?> cmd, Exception ex) {
sender.sendMessage("Error occurred when executing " + cmd.getIdentifier() + ": " + ex.getLocalizedMessage());
ex.printStackTrace();
return null;
}
@Override
public @NotNull List<String> getAliases() {
@@ -50,52 +57,59 @@ 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();
public void registerSubCommand(SubCommand<?> command) {
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 {
String input = args[0].toLowerCase();
return true;
}
CommandHandler handler = getHandler(input);
if (handler != null) {
if (!handler.hasPermission(sender)) {
this.noPermission(sender);
} else {
handler.onCommand(sender, command, label, this.shortenArgs(args));
}
}
String input = args[0].toLowerCase();
SubCommand subCommand = getSubCommand(input);
if (subCommand == null) {
this.unknownCommand(sender, args);
} else if (!subCommand.hasPermission(sender)) {
CommandHandler handler = getHandler(input);
if (handler != null) {
if (!handler.hasPermission(sender)) {
this.noPermission(sender);
} else {
try {
subCommand.execute(this.plugin, sender, this.shortenArgs(args));
} catch (ArrayIndexOutOfBoundsException var9) {
this.unknownCommand(sender, args);
}
handler.onCommand(sender, command, label, this.shortenArgs(args));
}
return true;
}
SubCommand<?> sub = getSubCommand(input);
if (sub == null) {
this.unknownCommand(sender, args);
} else if (!sub.hasPermission(sender)) {
this.noPermission(sender);
} else {
try {
sub.execute(this.plugin, sender, this.shortenArgs(args));
} catch (Exception ex) {
this.onException(sender, sub, ex);
}
}
return true;
}
@@ -107,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 {
@@ -117,9 +131,9 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
return handler.onTabComplete(sender, command, alias, this.shortenArgs(args));
}
SubCommand subCommand = getSubCommand(input);
if (subCommand != null && subCommand.hasPermission(sender)) {
return subCommand.tabComplete(this.plugin, sender, this.shortenArgs(args));
SubCommand<?> sub = getSubCommand(input);
if (sub != null && sub.hasPermission(sender)) {
return sub.tabComplete(this.plugin, sender, this.shortenArgs(args));
}
return Collections.emptyList();
@@ -131,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;
}
@@ -144,8 +158,8 @@ public abstract class CommandHandler implements TabExecutor, NamedExecutor {
else return this.registeredHandlers.get(nameFromAlias);
}
protected @Nullable SubCommand getSubCommand(@NotNull String name) {
SubCommand fromName = this.registeredCommands.get(name);
protected @Nullable SubCommand<?> getSubCommand(@NotNull String name) {
SubCommand<?> fromName = this.registeredCommands.get(name);
if (fromName != null) return fromName;
String nameFromAlias = this.aliasesMap.get(name);
@@ -1,7 +1,6 @@
package cc.carm.lib.easyplugin.command;
import org.bukkit.command.CommandSender;
import org.bukkit.permissions.Permissible;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -12,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(Permissible permissible) {
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,
@@ -2,42 +2,46 @@ package cc.carm.lib.easyplugin.command;
import org.bukkit.command.CommandSender;
import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Unmodifiable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
@SuppressWarnings("UnusedReturnValue")
public abstract class SubCommand implements NamedExecutor {
public abstract class SubCommand<C extends CommandHandler> implements NamedExecutor {
private final String name;
private final @NotNull C parent;
private final String identifier;
private final List<String> aliases;
public SubCommand(String name) {
this(name, new String[0]);
}
public SubCommand(String name, String... aliases) {
this.name = name;
public SubCommand(@NotNull C parent, String identifier, String... aliases) {
this.parent = parent;
this.identifier = identifier;
this.aliases = Arrays.asList(aliases);
}
@Override
public String getName() {
return this.name;
public @NotNull C getParent() {
return parent;
}
@Override
public List<String> getAliases() {
public @NotNull String getIdentifier() {
return this.identifier;
}
@Override
@Unmodifiable
public @NotNull List<String> getAliases() {
return this.aliases;
}
public abstract Void execute(JavaPlugin plugin, CommandSender sender, String[] args);
public abstract Void execute(JavaPlugin plugin, CommandSender sender, String[] args) throws Exception;
public List<String> tabComplete(JavaPlugin plugin, CommandSender sender, String[] args) {
return Collections.emptyList();
}
}
+10 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -59,4 +59,13 @@
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -13,10 +13,7 @@ import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.*;
import java.util.stream.IntStream;
public class GUI {
@@ -56,9 +53,9 @@ public class GUI {
*/
boolean cancelOnOuter = true;
Map<String, Object> flags;
protected final Map<String, Object> flags = new LinkedHashMap<>();
GUIListener listener;
protected GUIListener listener;
public GUI(GUIType type, String name) {
this.type = type;
@@ -131,24 +128,15 @@ public class GUI {
this.cancelOnOuter = b;
}
public void addFlag(String flag, Object obj) {
if (this.flags == null) this.flags = new HashMap<>();
this.flags.put(flag, obj);
}
public Object getFlag(String flag) {
if (this.flags == null) return null;
else
return this.flags.get(flag);
return this.flags.get(flag);
}
public void setFlag(String flag, Object obj) {
if (this.flags == null) this.flags = new HashMap<>();
this.flags.replace(flag, obj);
this.flags.put(flag, obj);
}
public void removeFlag(String flag) {
if (this.flags == null) this.flags = new HashMap<>();
this.flags.remove(flag);
}
@@ -193,6 +181,13 @@ public class GUI {
public void onClose() {
}
public GUIType getGUIType() {
return type;
}
public String getGUIName() {
return name;
}
public static void setOpenedGUI(Player player, GUI gui) {
getOpenedGUIs().put(player.getUniqueId(), gui);
@@ -37,12 +37,24 @@ public class GUIItem {
}
/**
* 玩家点击GUI后执行的代码
* 玩家点击该物品后执行的代码
* 可以使用 {@link #onClick(Player, ClickType)} 操作点击者
*
* @param type 点击的类型
*/
@Deprecated
@SuppressWarnings("DeprecatedIsStillUsed")
public void onClick(ClickType type) {
}
/**
* 玩家点击GUI后执行的代码
*
* @param clicker 点击的玩家
* @param type 点击的类型
*/
public void onClick(Player clicker, ClickType type) {
this.onClick(type); // Deprecated method support
}
public void addClickAction(GUIClickAction action) {
@@ -58,7 +70,7 @@ public class GUIItem {
}
/**
* 玩家点击GUI后执行的代码
* 自定义点击事件代码 (须自行触发)
*
* @param player 点击GUI的玩家
*/
@@ -45,7 +45,7 @@ public class GUIListener implements Listener {
GUIItem clickedItem = getCurrentGUI().getItem(event.getSlot());
if (clickedItem != null) {
if (clickedItem.isActionActive()) {
clickedItem.onClick(event.getClick());
clickedItem.onClick(player, event.getClick());
clickedItem.rawClickAction(event);
clickedItem.actions.forEach(action -> action.run(event.getClick(), player));
}
@@ -14,8 +14,8 @@ public enum GUIType {
SIX_BY_NINE(6, 54),
CANCEL(0, 0);
int lines;
int size;
private final int lines;
private final int size;
GUIType(int lines, int size) {
this.lines = lines;
@@ -6,19 +6,26 @@ import cc.carm.lib.easyplugin.utils.ColorParser;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.entity.Player;
import org.bukkit.event.inventory.ClickType;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.stream.Collectors;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Optional;
public class GUIConfiguration {
String title;
int lines;
protected String title;
protected int lines;
List<GUIItemConfiguration> guiItems;
protected Map<String, GUIItemConfiguration> guiItems;
public GUIConfiguration(String title, int lines, List<GUIItemConfiguration> guiItems) {
public GUIConfiguration(String title, int lines) {
this(title, lines, new LinkedHashMap<>(1));
}
public GUIConfiguration(String title, int lines, Map<String, GUIItemConfiguration> guiItems) {
this.title = title;
this.lines = lines;
this.guiItems = guiItems;
@@ -38,31 +45,50 @@ public class GUIConfiguration {
.get();
}
public List<GUIItemConfiguration> getGuiItems() {
public Map<String, GUIItemConfiguration> getGUIItems() {
return guiItems;
}
public void setupItems(Player player, GUI gui) {
getGuiItems().forEach(itemConfiguration -> itemConfiguration.setupItems(player, gui));
getGUIItems().values().forEach(itemConfiguration -> itemConfiguration.setupItems(player, gui));
}
public @NotNull Map<String, Object> serialize() {
LinkedHashMap<String, Object> map = new LinkedHashMap<>();
map.put("title", this.title);
map.put("lines", this.lines);
if (!this.guiItems.isEmpty()) {
LinkedHashMap<String, Object> items = new LinkedHashMap<>();
this.guiItems.forEach((key, value) -> items.put(key, value.serialize()));
map.put("items", items);
}
return map;
}
public static GUIConfiguration readConfiguration(@Nullable ConfigurationSection section) {
if (section == null) return new GUIConfiguration("name", 6, new ArrayList<>());
String title = section.getString("title", "");
int lines = section.getInt("lines", 6);
ConfigurationSection itemsSection = section.getConfigurationSection("items");
if (itemsSection == null) return new GUIConfiguration(title, lines, new ArrayList<>());
if (section == null) return new GUIConfiguration("name", 6);
return new GUIConfiguration(
title, lines, itemsSection.getKeys(false).stream()
.map(key -> GUIItemConfiguration.readFrom(itemsSection.getConfigurationSection(key)))
.filter(Objects::nonNull)
.collect(Collectors.toList())
section.getString("title", ""),
section.getInt("lines", 6),
readItems(section.getConfigurationSection("items"))
);
}
public static Map<String, GUIItemConfiguration> readItems(ConfigurationSection itemsSection) {
Map<String, GUIItemConfiguration> items = new LinkedHashMap<>();
if (itemsSection == null) return items;
for (String key : itemsSection.getKeys(false)) {
GUIItemConfiguration item = GUIItemConfiguration.readFrom(itemsSection.getConfigurationSection(key));
if (item != null) items.put(key, item);
}
return items;
}
public static ClickType readClickType(String type) {
return Arrays.stream(ClickType.values())
.filter(click -> click.name().equalsIgnoreCase(type))
@@ -2,11 +2,14 @@ package cc.carm.lib.easyplugin.gui.configuration;
import cc.carm.lib.easyplugin.gui.GUI;
import cc.carm.lib.easyplugin.gui.GUIItem;
import cc.carm.lib.easyplugin.utils.ColorParser;
import cc.carm.lib.easyplugin.utils.ItemStackFactory;
import cc.carm.lib.easyplugin.utils.MessageUtils;
import org.bukkit.Material;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.entity.Player;
import org.bukkit.inventory.ItemStack;
import org.bukkit.inventory.meta.ItemMeta;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -15,6 +18,8 @@ import java.util.stream.Collectors;
public class GUIItemConfiguration {
@Nullable ItemStack original;
@NotNull Material type;
int amount;
int data;
@@ -28,6 +33,15 @@ public class GUIItemConfiguration {
@Nullable String name, @NotNull List<String> lore,
@NotNull List<GUIActionConfiguration> actions,
@NotNull List<Integer> slots) {
this(null, type, amount, data, name, lore, actions, slots);
}
public GUIItemConfiguration(@Nullable ItemStack original,
@NotNull Material type, int amount, int data,
@Nullable String name, @NotNull List<String> lore,
@NotNull List<GUIActionConfiguration> actions,
@NotNull List<Integer> slots) {
this.original = original;
this.type = type;
this.amount = amount;
this.data = data;
@@ -38,22 +52,58 @@ public class GUIItemConfiguration {
}
public void setupItems(Player player, GUI gui) {
ItemStackFactory icon = new ItemStackFactory(this.type, this.amount, this.data);
if (this.name != null) icon.setDisplayName(this.name);
icon.setLore(MessageUtils.setPlaceholders(player, this.lore));
ItemStack itemStack;
if (original != null) {
ItemStack tmp = original.clone();
ItemMeta originalMeta = original.getItemMeta();
if (originalMeta != null) {
if (originalMeta.hasDisplayName()) {
originalMeta.setDisplayName(parseText(player, originalMeta.getDisplayName()));
}
if (originalMeta.getLore() != null) {
originalMeta.setLore(parseTexts(player, originalMeta.getLore()));
}
GUIItem item = new GUIItem(icon.toItemStack());
}
tmp.setItemMeta(originalMeta);
itemStack = tmp;
} else {
ItemStackFactory icon = new ItemStackFactory(this.type, this.amount, this.data);
if (this.name != null) {
icon.setDisplayName(parseText(player, this.name));
}
if (!this.lore.isEmpty()) {
icon.setLore(parseTexts(player, this.lore));
}
itemStack = icon.toItemStack();
}
GUIItem item = new GUIItem(itemStack);
this.actions.stream().map(GUIActionConfiguration::toClickAction).forEach(item::addClickAction);
this.slots.forEach(slot -> gui.setItem(slot, item));
}
private List<String> parseTexts(Player player, List<String> lore) {
return ColorParser.parse(MessageUtils.setPlaceholders(player, lore));
}
@NotNull
private String parseText(Player player, @NotNull String name) {
return ColorParser.parse(MessageUtils.setPlaceholders(player, name));
}
public @NotNull Map<String, Object> serialize() {
LinkedHashMap<String, Object> map = new LinkedHashMap<>();
if (original != null) map.put("original", original);
else {
map.put("type", this.type.name());
if (this.data != 0) map.put("data", this.data);
}
map.put("type", this.type.name());
if (this.name != null) map.put("name", this.name);
if (this.amount != 1) map.put("amount", this.amount);
if (this.data != 0) map.put("data", this.data);
if (!this.lore.isEmpty()) map.put("lore", this.lore);
if (this.slots.size() > 1) {
map.put("slots", this.slots);
@@ -69,6 +119,10 @@ public class GUIItemConfiguration {
@Nullable
public static GUIItemConfiguration readFrom(@Nullable ConfigurationSection itemSection) {
if (itemSection == null) return null;
ItemStack original = null;
if (itemSection.contains("original")) original = itemSection.getItemStack("original");
String material = Optional.ofNullable(itemSection.getString("type")).orElse("STONE");
Material type = Optional.ofNullable(Material.matchMaterial(material)).orElse(Material.STONE);
int data = itemSection.getInt("data", 0);
@@ -88,7 +142,7 @@ public class GUIItemConfiguration {
}
return new GUIItemConfiguration(
type, amount, data, name, lore, actions,
original, type, amount, data, name, lore, actions,
slots.size() > 0 ? slots : Collections.singletonList(slot)
);
}
@@ -49,7 +49,7 @@ public class AutoPagedGUI extends CommonPagedGUI {
setItem(previousPageSlot, new GUIItem(
previousPageUI == null ? getDefaultPreviousPage(user) : previousPageUI) {
@Override
public void onClick(ClickType type) {
public void onClick(Player clicker, ClickType type) {
if (type == ClickType.RIGHT) {
goFirstPage();
} else {
@@ -68,7 +68,7 @@ public class AutoPagedGUI extends CommonPagedGUI {
setItem(nextPageSlot, new GUIItem(
nextPageUI == null ? getDefaultNextPage(user) : nextPageUI) {
@Override
public void onClick(ClickType type) {
public void onClick(Player clicker, ClickType type) {
if (type == ClickType.RIGHT) {
goLastPage();
} else {
@@ -117,7 +117,7 @@ public class CommonPagedGUI extends PagedGUI {
* @return 最后一页的页码
*/
public int getLastPageNumber() {
return (this.container.size() / range.length) + 1;
return (this.container.size() / range.length) + ((this.container.size() % range.length) == 0 ? 0 : 1);
}
/**
+18 -2
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -22,7 +22,7 @@
<packaging>jar</packaging>
<name>EasyPlugin-Main</name>
<description>轻松插件主要接口模块,包含便的插件入口类与相关工具类。</description>
<description>轻松插件主要接口模块,包含便的插件入口类与相关工具类。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
<developers>
@@ -53,6 +53,13 @@
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>easyplugin-utils</artifactId>
<version>${project.version}</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>me.clip</groupId>
<artifactId>placeholderapi</artifactId>
@@ -61,4 +68,13 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -22,6 +22,7 @@ import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
import java.util.function.Supplier;
public abstract class EasyPlugin extends JavaPlugin {
@@ -145,22 +146,64 @@ public abstract class EasyPlugin extends JavaPlugin {
if (isDebugging()) print("&8[DEBUG] &r", messages);
}
public @NotNull <T extends Event> CompletableFuture<T> callSync(T event) {
/**
* 在主线程执行操作,并支持获取其结果。
*
* @param <T> 结果类型
* @param action 需要执行的内容
* @return CompletableFuture
*/
public @NotNull <T> CompletableFuture<T> supplySync(@NotNull Supplier<T> action) {
CompletableFuture<T> future = new CompletableFuture<>();
getScheduler().run(() -> {
Bukkit.getPluginManager().callEvent(event);
future.complete(event);
});
getScheduler().run(() -> future.complete(action.get()));
return future;
}
public @NotNull <T extends Event> CompletableFuture<T> callAsync(T event) {
return CompletableFuture.supplyAsync(() -> {
/**
* 在异步线程中执行一个操作,并获取操作的结果。
*
* @param <T> 事件类型
* @param action 需要执行的内容
* @return CompletableFuture
*/
public @NotNull <T> CompletableFuture<T> supplyAsync(@NotNull Supplier<T> action) {
CompletableFuture<T> future = new CompletableFuture<>();
getScheduler().runAsync(() -> future.complete(action.get()));
return future;
}
/**
* 在主线程唤起一个事件,并支持获取事件的结果。
*
* @param event 同步事件 (isAsync=false)
* @param <T> 事件类型
* @return CompletableFuture
*/
public @NotNull <T extends Event> CompletableFuture<T> callSync(T event) {
return supplySync(() -> {
Bukkit.getPluginManager().callEvent(event);
return event;
});
}
/**
* 在异步线程中唤起一个事件,并支持获取事件的结果。
*
* @param event 异步事件 (isAsync=true)
* @param <T> 事件类型
* @return CompletableFuture
*/
public @NotNull <T extends Event> CompletableFuture<T> callAsync(T event) {
return supplyAsync(() -> {
Bukkit.getPluginManager().callEvent(event);
return event;
});
}
protected void setMessageProvider(@NotNull EasyPluginMessageProvider provider) {
this.messageProvider = provider;
}
@SuppressWarnings("BooleanMethodIsAlwaysInverted")
private boolean hasOverride(String methodName) {
Map<Method, Method> methodMap = new HashMap<>();
@@ -1,31 +1,90 @@
package cc.carm.lib.easyplugin.utils;
import java.util.Arrays;
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可用的格式化代码
public static String parse(String text) {
return parseBaseColor(parseHexColor(text));
/**
* 清除一条消息中的全部颜色代码 (包括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;
}
public static String[] parse(String... texts) {
/**
* 对一条消息进行颜色解析,包括普通颜色代码、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]);
}
public static List<String> parse(List<String> texts) {
/**
* 对多条消息进行颜色解析,包括普通颜色代码、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()) {
@@ -35,9 +94,114 @@ public class ColorParser {
return text;
}
private static String buildHexColor(String hexCode) {
return Arrays.stream(hexCode.split(""))
.map(s -> '§' + s)
/**
* 对一条消息进行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", ""));
}
+71
View File
@@ -0,0 +1,71 @@
<?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.5</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>
<maven.deploy.skip>true</maven.deploy.skip>
</properties>
<artifactId>easyplugin-messages</artifactId>
<name>EasyPlugin-Messages</name>
<description>
轻松插件消息配置模块,支持多种消息配置,包括文本消息、ActionBar消息、Title消息、声音、粒子效果播放等。
</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>
<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>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
+9 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -23,5 +23,13 @@
<description>轻松插件存储接口模块,包含存储相关的统一接口。</description>
<url>https://github.com/CarmJos/EasyPlugin</url>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
+64
View File
@@ -0,0 +1,64 @@
<?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.5</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-user</artifactId>
<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>
<dependencies>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyplugin-main</artifactId>
<version>${project.parent.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,32 @@
package cc.carm.lib.easyplugin.user;
import org.jetbrains.annotations.NotNull;
import java.util.Objects;
public abstract class UserData<K> {
protected final @NotNull K key;
protected UserData(@NotNull K key) {
this.key = key;
}
public @NotNull K getKey() {
return key;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
UserData<?> userData = (UserData<?>) o;
return key.equals(userData.key);
}
@Override
public int hashCode() {
return Objects.hash(key);
}
}
@@ -0,0 +1,245 @@
package cc.carm.lib.easyplugin.user;
import cc.carm.lib.easyplugin.EasyPlugin;
import com.google.common.collect.ImmutableSet;
import org.bukkit.Bukkit;
import org.bukkit.OfflinePlayer;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.Unmodifiable;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.logging.Logger;
import java.util.stream.Collectors;
public abstract class UserDataManager<K, U extends UserData<K>> {
protected final @NotNull EasyPlugin plugin;
protected final @NotNull ExecutorService executor;
protected final @NotNull Map<K, U> dataCache;
public UserDataManager(@NotNull EasyPlugin plugin) {
this(plugin, Executors.newCachedThreadPool((r) -> {
Thread t = new Thread(r);
t.setDaemon(true);
t.setName(plugin.getName() + "-UserManager");
return t;
}), new ConcurrentHashMap<>());
}
public UserDataManager(@NotNull EasyPlugin plugin, @NotNull ExecutorService executor) {
this(plugin, executor, new ConcurrentHashMap<>());
}
public UserDataManager(@NotNull EasyPlugin plugin, @NotNull ExecutorService executor, @NotNull Map<K, U> cacheMap) {
this.plugin = plugin;
this.executor = executor;
this.dataCache = cacheMap;
}
public void shutdown() {
this.executor.shutdown();
}
protected @NotNull EasyPlugin getPlugin() {
return plugin;
}
protected @NotNull Logger getLogger() {
return getPlugin().getLogger();
}
public String serializeKey(@NotNull K key) {
return key.toString();
}
public abstract @NotNull U empty(@NotNull K key);
protected abstract @Nullable U loadData(@NotNull K key) throws Exception;
protected abstract void saveData(@NotNull U data) throws Exception;
public @NotNull CompletableFuture<U> load(@NotNull K key) {
return load(key, false);
}
public @NotNull CompletableFuture<U> load(@NotNull K key, boolean cache) {
return load(key, () -> cache);
}
public @NotNull Map<K, U> getDataCache() {
return dataCache;
}
@Unmodifiable
public @NotNull Set<U> list() {
return ImmutableSet.copyOf(getDataCache().values());
}
public @NotNull U get(@NotNull K key) {
return Optional.ofNullable(getNullable(key)).orElseThrow(() -> new NullPointerException("User " + key + " not found."));
}
public @Nullable U getNullable(@NotNull K key) {
return getDataCache().get(key);
}
public @NotNull Optional<@Nullable U> getOptional(@NotNull K key) {
return Optional.ofNullable(getNullable(key));
}
public @NotNull CompletableFuture<U> load(@NotNull K key, @NotNull Supplier<Boolean> cacheCondition) {
return CompletableFuture.supplyAsync(() -> {
String identifier = serializeKey(key);
try {
long s1 = System.currentTimeMillis();
getPlugin().debug("开始加载用户 " + identifier + " 的数据...");
U data = loadData(key);
if (data == null) {
getPlugin().debug("数据库内不存在用户 " + identifier + " 的数据,视作新档案。");
return empty(key);
} else {
getPlugin().debug("加载用户 " + identifier + " 的数据完成,耗时 " + (System.currentTimeMillis() - s1) + " ms.");
return data;
}
} catch (Exception ex) {
getPlugin().error("加载用户 " + serializeKey(key) + " 数据失败,请检查相关配置!");
ex.printStackTrace();
return empty(key);
}
}, executor).thenApply((data) -> {
if (cacheCondition.get()) dataCache.put(key, data);
return data;
});
}
public @NotNull CompletableFuture<Boolean> save(@NotNull U user) {
return CompletableFuture.supplyAsync(() -> {
String identifier = serializeKey(user.getKey());
try {
long s1 = System.currentTimeMillis();
getPlugin().debug("开始保存用户 " + identifier + " 的数据...");
saveData(user);
getPlugin().debug("保存用户 " + identifier + " 的数据完成,耗时 " + (System.currentTimeMillis() - s1) + " ms.");
return true;
} catch (Exception ex) {
getPlugin().error("保存用户 " + identifier + " 数据失败,请检查相关配置!");
ex.printStackTrace();
return false;
}
}, executor);
}
public @NotNull CompletableFuture<Boolean> unload(@NotNull K key) {
return unload(key, true);
}
public @NotNull CompletableFuture<Boolean> unload(@NotNull K key, boolean save) {
U data = getNullable(key);
if (data == null) return CompletableFuture.completedFuture(false);
if (save) {
return save(data).thenApply(result -> {
this.dataCache.remove(key);
return result;
});
} else {
this.dataCache.remove(key);
return CompletableFuture.completedFuture(true);
}
}
public @NotNull CompletableFuture<Boolean> modify(@NotNull K key, @NotNull Consumer<U> consumer) {
U cached = getNullable(key);
if (cached != null) {
return CompletableFuture.supplyAsync(() -> {
consumer.accept(cached);
return true;
}, executor);
} else {
return load(key, false).thenApply((data) -> {
consumer.accept(data);
return data;
}).thenCompose(this::save);
}
}
public <V> @NotNull CompletableFuture<V> peek(@NotNull K key, @NotNull Function<U, V> function) {
U cached = getNullable(key);
if (cached != null) {
return CompletableFuture.supplyAsync(() -> function.apply(cached), executor);
} else {
return load(key, false).thenApply(function);
}
}
public @NotNull CompletableFuture<Map<K, U>> loadOnline(@NotNull Function<Player, ? extends K> function) {
return loadGroup(Bukkit.getOnlinePlayers(), function, OfflinePlayer::isOnline);
}
public <T> @NotNull CompletableFuture<Map<K, U>> loadGroup(@NotNull Collection<? extends T> users,
@NotNull Function<? super T, ? extends K> function,
@NotNull Predicate<T> cacheCondition) {
CompletableFuture<Map<K, U>> task = CompletableFuture.completedFuture(new ConcurrentHashMap<>());
if (users.isEmpty()) return task;
Map<K, T> usersMap = users.stream().collect(Collectors.toMap(function, Function.identity()));
for (Map.Entry<K, T> entry : usersMap.entrySet()) {
K key = entry.getKey();
T user = entry.getValue();
task = task.thenCombine(
load(key, () -> cacheCondition.test(user)),
(map, result) -> {
map.put(key, result);
return map;
}
);
}
return task.thenApply(Collections::unmodifiableMap);
}
public @NotNull CompletableFuture<Map<K, U>> loadGroup(@NotNull Collection<K> allKeys,
@NotNull Predicate<K> cacheCondition) {
return loadGroup(allKeys, Function.identity(), cacheCondition);
}
public @NotNull CompletableFuture<Map<K, U>> loadGroup(@NotNull Collection<K> allKeys) {
return loadGroup(allKeys, (v) -> false);
}
public @NotNull CompletableFuture<Integer> saveAll() {
CompletableFuture<Integer> future = CompletableFuture.completedFuture(0);
if (getDataCache().isEmpty()) return future;
for (U value : getDataCache().values()) {
future = future.thenCombine(save(value), (before, result) -> before + (result ? 1 : 0));
}
return future;
}
public @NotNull CompletableFuture<Integer> unloadAll() {
return saveAll().thenApply(result -> {
getDataCache().clear();
return result;
});
}
}
+70
View File
@@ -0,0 +1,70 @@
<?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">
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<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-utils</artifactId>
<name>EasyPlugin-Utils</name>
<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>
<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>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -0,0 +1,93 @@
package cc.carm.lib.easyplugin.utils;
import org.jetbrains.annotations.NotNull;
import java.text.NumberFormat;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
/**
* <a href="https://gist.github.com/CarmJos/402cb5aad0ec14ab25c2fa0d21571703">Easy cooldown time utils.</a>
*
* @param <P> Cooldown key provider
* @param <K> Cooldown key
* @author CarmJos
*/
public class EasyCooldown<P, K> {
protected final NumberFormat numberFormatter;
protected final @NotNull Map<K, Long> cooldown = new HashMap<>();
protected final @NotNull Function<P, K> providerToKey;
protected long defaultDuration;
public EasyCooldown(@NotNull Function<P, K> providerToKey) {
this(defaultFormatter(), providerToKey, 1000L);
}
public EasyCooldown(@NotNull NumberFormat numberFormatter,
@NotNull Function<P, K> providerToKey) {
this(numberFormatter, providerToKey, 1000L);
}
public EasyCooldown(@NotNull NumberFormat numberFormatter,
@NotNull Function<P, K> providerToKey,
long defaultDuration) {
this.numberFormatter = numberFormatter;
this.providerToKey = providerToKey;
this.defaultDuration = defaultDuration;
}
public long getCooldown(@NotNull P provider) {
Long time = this.cooldown.get(this.providerToKey.apply(provider));
if (time == null || time < 0) return 0;
long duration = getDuration(provider);
if (duration <= 0) return 0;
long past = System.currentTimeMillis() - time;
return duration - past;
}
public @NotNull String getCooldownSeconds(@NotNull P provider) {
return formatSeconds(getCooldown(provider));
}
public void updateTime(@NotNull P provider) {
this.cooldown.put(this.providerToKey.apply(provider), System.currentTimeMillis());
}
public void clear(@NotNull P provider) {
clearCooldown(this.providerToKey.apply(provider));
}
public void clearCooldown(@NotNull K key) {
this.cooldown.remove(key);
}
public boolean isCoolingDown(@NotNull P provider) {
return getCooldown(provider) > 0;
}
public long getDuration(@NotNull P provider) {
return this.defaultDuration;
}
public @NotNull String formatSeconds(long cooldownMillis) {
return numberFormatter.format((double) cooldownMillis / 1000D);
}
public static NumberFormat createFormatter(@NotNull Consumer<NumberFormat> consumer) {
NumberFormat format = NumberFormat.getInstance();
consumer.accept(format);
return format;
}
public static NumberFormat defaultFormatter() {
return createFormatter((f) -> f.setMaximumFractionDigits(2));
}
}
+11 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -62,4 +62,14 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
+25 -2
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -52,6 +52,7 @@
<dependencyManagement>
<dependencies>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyplugin-main</artifactId>
@@ -69,7 +70,12 @@
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyplugin-papi</artifactId>
<artifactId>easyplugin-storage</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyplugin-placeholderapi</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
@@ -77,6 +83,13 @@
<artifactId>easyplugin-vault</artifactId>
<version>${project.parent.version}</version>
</dependency>
<dependency>
<groupId>${project.parent.groupId}</groupId>
<artifactId>easyplugin-githubchecker</artifactId>
<version>${project.parent.version}</version>
</dependency>
</dependencies>
</dependencyManagement>
@@ -108,4 +121,14 @@
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
+14 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -68,10 +68,23 @@
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-vault</artifactId>
</exclusion>
<exclusion>
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-storage</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
+10 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -22,6 +22,7 @@
<dependencies>
<!--suppress VulnerableLibrariesLocal -->
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>githubreleases4j</artifactId>
@@ -30,5 +31,13 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -1,7 +1,9 @@
package cc.carm.lib.easyplugin.updatechecker;
import cc.carm.lib.githubreleases4j.GithubReleases4J;
import org.bukkit.Bukkit;
import org.bukkit.plugin.Plugin;
import org.bukkit.scheduler.BukkitTask;
import org.jetbrains.annotations.NotNull;
import java.util.List;
@@ -24,11 +26,15 @@ public class GHUpdateChecker {
public static @NotNull Runnable runner(@NotNull Logger logger,
@NotNull String owner, @NotNull String repo,
@NotNull String currentVersion) {
return of(logger, owner, repo).runner(currentVersion);
return of(logger, owner, repo).createRunner(currentVersion);
}
public static @NotNull Runnable runner(@NotNull Plugin plugin) {
return of(plugin).runner(plugin.getDescription().getVersion());
return of(plugin).createRunner(plugin.getDescription().getVersion());
}
public static @NotNull BukkitTask run(@NotNull Plugin plugin) {
return Bukkit.getScheduler().runTaskAsynchronously(plugin, runner(plugin));
}
protected final @NotNull Logger logger;
@@ -59,7 +65,7 @@ public class GHUpdateChecker {
}
}
public Runnable runner(@NotNull String currentVersion) {
public Runnable createRunner(@NotNull String currentVersion) {
return () -> checkUpdate(currentVersion);
}
+11 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -21,6 +21,7 @@
<packaging>jar</packaging>
<name>EasyPlugin-PlaceholderAPI</name>
<description>EasyPlugin的 PlaceholderAPI 扩展模块,提供了方便的 PlaceholderAPI 变量注册方法。</description>
<dependencies>
@@ -32,4 +33,13 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
@@ -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));
}
}
+11 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>easyplugin-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>1.4.10</version>
<version>1.5.5</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
@@ -33,4 +33,14 @@
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
+55 -4
View File
@@ -15,12 +15,18 @@
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-parent</artifactId>
<packaging>pom</packaging>
<version>1.4.10</version>
<version>1.5.5</version>
<modules>
<module>base/color</module>
<module>base/utils</module>
<module>base/main</module>
<module>base/command</module>
<module>base/messages</module>
<module>base/gui</module>
<module>base/command</module>
<module>base/command-alias</module>
<module>base/storage</module>
<module>base/user</module>
<module>extension/papi</module>
<module>extension/vault</module>
@@ -29,7 +35,6 @@
<module>collection/all</module>
<module>collection/bom</module>
<module>collection/common</module>
<module>base/storage</module>
</modules>
@@ -103,7 +108,7 @@
<dependency>
<groupId>org.spigotmc</groupId>
<artifactId>spigot</artifactId>
<artifactId>spigot-api</artifactId>
<version>1.13.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
@@ -141,6 +146,21 @@
<artifactId>githubreleases4j</artifactId>
<version>1.3.1</version>
</dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easylistener</artifactId>
<version>2.0.1</version>
</dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>mineconfiguration-bukkit</artifactId>
<version>2.0.2</version>
</dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easysql-beecp</artifactId>
<version>0.4.3</version>
</dependency>
</dependencies>
</dependencyManagement>
@@ -187,6 +207,37 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>3.0.1</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
<configuration>
<gpgArguments>
<arg>--pinentry-mode</arg>
<arg>loopback</arg>
</gpgArguments>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.3</version>
<configuration>
<autoVersionSubmodules>true</autoVersionSubmodules>
<useReleaseProfile>false</useReleaseProfile>
<releaseProfiles>release</releaseProfiles>
<goals>deploy</goals>
</configuration>
</plugin>
</plugins>
<pluginManagement>
<plugins>