1
mirror of https://github.com/carm-outsource/TimeReward.git synced 2026-06-04 15:28:16 +08:00

13 Commits

Author SHA1 Message Date
carm 77182148c5 Merge remote-tracking branch 'origin/master' 2023-02-23 00:56:32 +08:00
carm cd12f9383a feat(update): 适配最新依赖版本。 2023-02-23 00:56:13 +08:00
Yurinann 681a65230b fix(version): 适配 1.10- 版本的消息文本发送 (#6)
feat(command): 添加了指令权限判断与重载时的奖励数量反馈
2023-02-23 00:50:58 +08:00
carm d2600d308c feat(update): 适配最新依赖版本。 2023-02-22 20:32:36 +08:00
Yurinann 45346b093a refactor(update): 适配最新依赖版本 (#5)
* refactor(update): 适配最新依赖版本

* feat(update): 更新 README,添加更多自定义语言文本。
2023-02-22 19:26:25 +08:00
carm 1dc99f5f1c 添加使用统计图 2022-03-08 06:24:45 +08:00
carm fc0701013e Merge remote-tracking branch 'origin/master' 2022-03-02 22:19:12 +08:00
carm e34ac6a5b4 添加配置 2022-03-02 22:18:54 +08:00
carm 3cb48047db Update README.md 2022-03-02 21:45:42 +08:00
carm 414281f223 Update README.md 2022-03-02 21:44:14 +08:00
carm 19357a4f34 Update README.md 2022-03-02 20:51:38 +08:00
carm 103d043ae2 Update README.md 2022-03-02 20:49:34 +08:00
carm f5f180bdee Update README.md 2022-03-02 20:44:39 +08:00
34 changed files with 980 additions and 1027 deletions
+2
View File
@@ -0,0 +1,2 @@
custom: ['https://donate.carm.cc']
+32
View File
@@ -0,0 +1,32 @@
---
name: 问题提交
about: 提交并描述问题,帮助我们对其进行检查与修复。
title: ''
labels: bug
assignees: ''
---
**问题简述**
<!--用简短的话语描述一下大概问题。-->
**问题来源**
<!--
描述一下通过哪些操作才发现的问题,如:
1. 打开 '...'
2. 点击了 '....'
3. 出现了报错 '....'
-->
**预期结果**(可选)
<!--如果问题不发生,应该是什么情况-->
**问题截图/问题报错**
<!--如果有报错或输出,请提供截图。-->
**操作环境**
<!--请在后台输入 `version` 并复制相关输出。-->
**其他补充**
<!--如有其他补充,可以在这里描述。-->
+20
View File
@@ -0,0 +1,20 @@
---
name: 功能需求
about: 希望我们提供更多的功能。
title: ''
labels: enhancement
assignees: ''
---
**功能简述**
<!--简单的描述一下你想要的功能-->
**需求来源**
<!--简单的描述一下为什么需要这个功能。-->
**功能参考**(可选)
<!--如果有相关功能的参考,如文本、截图,请提供给我们。-->
**附加内容**
<!--如果有什么小细节需要重点注意,请在这里告诉我们。-->
+45 -33
View File
@@ -1,31 +1,46 @@
```text ```text
_____ _ ______ _ _______ ____ __
|_ _(_) | ___ \ | | /_ __(_)___ ___ ___ / __ \___ _ ______ __________/ /
| | _ _ __ ___ ___| |_/ /_____ ____ _ _ __ __| | / / / / __ `__ \/ _ \/ /_/ / _ \ | /| / / __ `/ ___/ __ /
| | | | '_ ` _ \ / _ \ // _ \ \ /\ / / _` | '__/ _` | / / / / / / / / / __/ _, _/ __/ |/ |/ / /_/ / / / /_/ /
| | | | | | | | | __/ |\ \ __/\ V V / (_| | | | (_| | /_/ /_/_/ /_/ /_/\___/_/ |_|\___/|__/|__/\__,_/_/ \__,_/
\_/ |_|_| |_| |_|\___\_| \_\___| \_/\_/ \__,_|_| \__,_|
``` ```
# TimeReward # TimeReward
[![workflow](https://github.com/CarmJos/TimeReward/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/TimeReward/actions/workflows/maven.yml) ![CodeSize](https://img.shields.io/github/languages/code-size/carm-outsource/TimeReward)
![Support](https://img.shields.io/badge/Minecraft-Java%201.12--Latest-yellow) [![Download](https://img.shields.io/github/downloads/carm-outsource/TimeReward/total)](https://github.com/carm-outsource/TimeReward/releases)
[![Java CI with Maven](https://github.com/CarmJos/TimeReward/actions/workflows/maven.yml/badge.svg?branch=master)](https://github.com/CarmJos/TimeReward/actions/workflows/maven.yml)
![Support](https://img.shields.io/badge/Minecraft-Java%201.8--Latest-yellow)
![](https://visitor-badge.glitch.me/badge?page_id=TimeReward.readme) ![](https://visitor-badge.glitch.me/badge?page_id=TimeReward.readme)
在线时长自动领奖插件,通过指令发放奖励,基于EasyPlugin实现。 使用数据库存储的在线时长自动领奖插件,通过指令发放奖励,基于EasyPlugin实现。
## 插件依赖 ## 功能
- **[必须]** 插件本体基于 [Spigot-API](https://hub.spigotmc.org/stash/projects/SPIGOT) 、 [BukkitAPI](http://bukkit.org/) 实现 - 基于数据库存储的用户在线时长统计
- **高效算法。** 在线时间不受服务器卡顿(如果有)影响。
- **异步存取。** 数据读取与存储均为异步操作,不影响服务器性能。
- **接口全面。** 提供插件用户数据访问接口与变量,便于其他插件进行读取判断。
- **轻量插件。** 适合小型服务器使用,配置简单方便。
- **规范开发。** 插件架构符合开发规范,适合新手开发者学习。
## [依赖](https://github.com/CarmJos/TimeReward/network/dependencies)
- **[必须]** 插件本体基于 [Spigot-API](https://hub.spigotmc.org/stash/projects/SPIGOT) 、[BukkitAPI](http://bukkit.org/) 实现。
- **[自带]** 插件功能基于 [EasyPlugin](https://github.com/CarmJos/EasyPlugin) 实现。 - **[自带]** 插件功能基于 [EasyPlugin](https://github.com/CarmJos/EasyPlugin) 实现。
- **[自带]** 数据功能基于 [EasySQL](https://github.com/CarmJos/EasySQL) 实现。 - **[自带]** 数据功能基于 [EasySQL](https://github.com/CarmJos/EasySQL) 实现。
- **[自带]** 消息格式基于 [MineDown](https://github.com/Phoenix616/MineDown) 实现。
- 所有 messages.yml 均支持 MineDown 语法。
- **[推荐]** 变量部分基于 [PlaceholderAPI](https://www.spigotmc.org/resources/6245/) 实现。
详细依赖列表可见 [Dependencies](https://github.com/CarmJos/timereward/network/dependencies) 。 详细依赖列表可见 [Dependencies](https://github.com/CarmJos/TimeReward/network/dependencies) 。
## 插件指令 ## [指令](src/main/resources/plugin.yml)
指令主指令为 `/TimeReward` 以下指令主指令为 `/TimeReward``/tr`
- 必须参数 `<参数>`
```text ```text
# reload # reload
@@ -36,7 +51,7 @@
@ 管理指令 (TimeReward.admin) @ 管理指令 (TimeReward.admin)
- 查看用户的在线时长信息与奖励领取情况。 - 查看用户的在线时长信息与奖励领取情况。
# list # list
@ 管理指令 (TimeReward.admin) @ 管理指令 (TimeReward.admin)
- 列出所有奖励与条件。 - 列出所有奖励与条件。
@@ -45,16 +60,11 @@
- 测试执行奖励配置的指令。 - 测试执行奖励配置的指令。
``` ```
## 插件权限 ## 变量 (PlaceholderAPI)
```text 安装 PlaceholderAPI 后,可以输入 /papi info TimeReward 查看相关变量。
# TimeReward.admin 变量如下:
- 建筑魔杖的管理权限。
```
## 插件变量
```text ```text
# %TimeReward_time% # %TimeReward_time%
@@ -67,26 +77,28 @@
- 得到玩家是否已经领取了某个奖励。 - 得到玩家是否已经领取了某个奖励。
- * 也可以代表玩家是否可以领取某个奖励 - * 也可以代表玩家是否可以领取某个奖励
- * 因为一旦可以领取就会自动领取,变为已领取状态 - * 因为一旦可以领取就会自动领取,变为已领取状态
``` ```
## 配置文件 ## 配置文件
### 插件配置文件 ([config.yml](src/main/resources/config.yml)) ### 插件配置文件 ([config.yml](src/main/java/cc/carm/plugin/timereward/conf/PluginConfig.java))
详见源文件。
### 消息配置文件 ([messages.yml](src/main/java/cc/carm/plugin/timereward/configuration/PluginMessages.java))
详见代码源文件,将在首次启动时生成配置。 详见代码源文件,将在首次启动时生成配置。
### 消息配置文件 ([messages.yml](src/main/java/cc/carm/plugin/timereward/conf/PluginMessages.java))
支持 [MineDown 语法](https://wiki.phoenix616.dev/library:minedown:syntax),详见代码源文件,将在首次启动时生成配置。
## 使用统计
[![bStats](https://bstats.org/signatures/bukkit/TimeReward.svg)](https://bstats.org/plugin/bukkit/TimeReward/14505)
## 支持与捐赠 ## 支持与捐赠
若您觉得本插件做的不错,您可以捐赠支持我! 若您觉得本插件做的不错,您可以捐赠支持我,感谢您成为开源项目的支持者
感谢您成为开源项目的支持者! Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.
[![](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)](https://www.jetbrains.com/?from=https://github.com/CarmJos/UserPrefix)
<img height=25% width=25% src="https://raw.githubusercontent.com/CarmJos/CarmJos/main/img/donate-code.jpg" alt=""/>
## 开源协议 ## 开源协议
本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。 本项目源码采用 [GNU General Public License v3.0](https://opensource.org/licenses/GPL-3.0) 开源协议。
+99 -70
View File
@@ -5,20 +5,23 @@
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<properties> <properties>
<java.version>8</java.version> <project.jdk.version>8</project.jdk.version>
<maven.compiler.source>${java.version}</maven.compiler.source> <maven.compiler.source>${project.jdk.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target> <maven.compiler.target>${project.jdk.version}</maven.compiler.target>
<easyplugin.version>1.3.9</easyplugin.version> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<easysql.version>0.3.8</easysql.version> <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
<deps.easyplugin.version>1.5.2</deps.easyplugin.version>
<deps.easysql.version>0.4.6</deps.easysql.version>
<deps.mineconfig.version>2.4.0</deps.mineconfig.version>
</properties> </properties>
<groupId>cc.carm.plugin</groupId> <groupId>cc.carm.plugin</groupId>
<artifactId>timereward</artifactId> <artifactId>timereward</artifactId>
<version>1.3.0</version> <version>2.0.1</version>
<packaging>jar</packaging>
<name>TimeReward</name> <name>TimeReward</name>
<description>区域保护插件,将不符合条件的玩家弹出区域,基于EasyPlugin实现。</description> <description>在线时长自动领奖插件,通过指令发放奖励,基于EasyPlugin实现。</description>
<url>https://github.com/CarmJos/TimeReward</url> <url>https://github.com/CarmJos/TimeReward</url>
<issueManagement> <issueManagement>
@@ -31,10 +34,6 @@
<url>https://github.com/CarmJos/TimeReward/actions/workflows/maven.yml</url> <url>https://github.com/CarmJos/TimeReward/actions/workflows/maven.yml</url>
</ciManagement> </ciManagement>
<distributionManagement>
<downloadUrl>https://github.com/CarmJos/TimeReward/releases</downloadUrl>
</distributionManagement>
<developers> <developers>
<developer> <developer>
<id>CarmJos</id> <id>CarmJos</id>
@@ -45,15 +44,20 @@
</developers> </developers>
<repositories> <repositories>
<repository>
<id>carm-repo</id>
<name>Carm's Repo</name>
<url>https://repo.carm.cc/repository/maven-public/</url>
</repository>
<repository> <repository>
<id>github</id> <id>github</id>
<name>GitHub Packages</name> <name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/*</url> <url>https://maven.pkg.github.com/CarmJos/${project.name}</url>
</repository> </repository>
<repository> <repository>
<id>central</id> <id>maven-central</id>
<url>https://repo1.maven.org/maven2/</url> <url>https://repo1.maven.org/maven2/</url>
</repository> </repository>
@@ -61,45 +65,71 @@
<id>nexus</id> <id>nexus</id>
<url>https://mvn.lumine.io/repository/maven-public/</url> <url>https://mvn.lumine.io/repository/maven-public/</url>
</repository> </repository>
<repository>
<id>carm-repo</id>
<name>Carm's Repo</name>
<url>https://repo.carm.cc/repository/maven-public/</url>
</repository>
</repositories> </repositories>
<distributionManagement>
<downloadUrl>https://github.com/CarmJos/TimeReward/releases</downloadUrl>
<repository>
<id>github</id>
<name>GitHub Packages</name>
<url>https://maven.pkg.github.com/CarmJos/${project.name}</url>
</repository>
</distributionManagement>
<dependencies> <dependencies>
<dependency> <dependency>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<artifactId>easysql-beecp</artifactId> <artifactId>mineconfiguration-bukkit</artifactId>
<version>${easysql.version}</version> <version>${deps.mineconfig.version}</version>
<scope>compile</scope> <scope>compile</scope>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<dependency> <dependency>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-main</artifactId> <artifactId>easyplugin-main</artifactId>
<version>${easyplugin.version}</version> <version>${deps.easyplugin.version}</version>
<scope>compile</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-command</artifactId>
<version>${deps.easyplugin.version}</version>
<scope>compile</scope> <scope>compile</scope>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<dependency> <dependency>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<artifactId>easyplugin-configuration</artifactId> <artifactId>easyplugin-placeholderapi</artifactId>
<version>${easyplugin.version}</version> <version>${deps.easyplugin.version}</version>
<scope>compile</scope> <scope>compile</scope>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<!--suppress VulnerableLibrariesLocal -->
<dependency> <dependency>
<groupId>cc.carm.lib</groupId> <groupId>cc.carm.lib</groupId>
<artifactId>githubreleases4j</artifactId> <artifactId>easyplugin-githubchecker</artifactId>
<version>1.3.1</version> <version>${deps.easyplugin.version}</version>
<scope>compile</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>cc.carm.lib</groupId>
<artifactId>easysql-beecp</artifactId>
<version>${deps.easysql.version}</version>
<scope>compile</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>de.themoep</groupId>
<artifactId>minedown</artifactId>
<version>1.7.1-SNAPSHOT</version>
<scope>compile</scope> <scope>compile</scope>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
@@ -111,8 +141,7 @@
<scope>compile</scope> <scope>compile</scope>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.spigotmc</groupId> <groupId>org.spigotmc</groupId>
<artifactId>spigot-api</artifactId> <artifactId>spigot-api</artifactId>
@@ -120,21 +149,13 @@
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
<dependency>
<groupId>org.spigotmc</groupId>
<artifactId>spigot</artifactId>
<version>1.12.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency> <dependency>
<groupId>me.clip</groupId> <groupId>me.clip</groupId>
<artifactId>placeholderapi</artifactId> <artifactId>placeholderapi</artifactId>
<version>2.10.9</version> <version>2.11.2</version>
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
<dependency> <dependency>
<groupId>junit</groupId> <groupId>junit</groupId>
<artifactId>junit</artifactId> <artifactId>junit</artifactId>
@@ -145,14 +166,15 @@
<dependency> <dependency>
<groupId>org.jetbrains</groupId> <groupId>org.jetbrains</groupId>
<artifactId>annotations</artifactId> <artifactId>annotations</artifactId>
<version>23.0.0</version> <version>24.0.0</version>
<scope>provided</scope> <scope>provided</scope>
</dependency> </dependency>
</dependencies> </dependencies>
<build> <build>
<defaultGoal>clean package</defaultGoal>
<plugins> <plugins>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
@@ -177,30 +199,25 @@
</filesets> </filesets>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.1</version>
<configuration>
<useSystemClassLoader>false</useSystemClassLoader>
</configuration>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version> <version>3.10.0</version>
<configuration> <configuration>
<source>${java.version}</source> <source>${project.jdk.version}</source>
<target>${java.version}</target> <target>${project.jdk.version}</target>
<encoding>UTF-8</encoding> <encoding>UTF-8</encoding>
<compilerArgument>-parameters</compilerArgument> <compilerArgument>-parameters</compilerArgument>
</configuration> </configuration>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>3.2.0</version> <version>3.2.0</version>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId> <artifactId>maven-source-plugin</artifactId>
@@ -214,30 +231,41 @@
</execution> </execution>
</executions> </executions>
</plugin> </plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId> <artifactId>maven-shade-plugin</artifactId>
<version>3.2.3</version> <version>3.2.4</version>
<executions> <executions>
<execution> <execution>
<phase>package</phase> <phase>package</phase>
<goals> <goals>
<goal>shade</goal> <goal>shade</goal>
</goals> </goals>
<configuration>
<createDependencyReducedPom>false</createDependencyReducedPom>
</configuration>
</execution> </execution>
</executions> </executions>
<configuration> <configuration>
<finalName>${project.name}-${project.version}</finalName> <finalName>${project.name}-${project.version}</finalName>
<outputDirectory>${project.basedir}/asset</outputDirectory> <outputDirectory>${project.basedir}/asset/</outputDirectory>
<minimizeJar>true</minimizeJar> <createDependencyReducedPom>false</createDependencyReducedPom>
<filters>
<filter>
<artifact>*:*</artifact>
<excludes>
<exclude>META-INF/MANIFEST.MF</exclude>
<exclude>META-INF/*.txt</exclude>
</excludes>
</filter>
</filters>
<relocations> <relocations>
<relocation> <relocation>
<pattern>cc.carm.lib</pattern> <pattern>cc.carm.lib</pattern>
<shadedPattern>cc.carm.plugin.timereward.lib</shadedPattern> <shadedPattern>cc.carm.plugin.timereward.lib</shadedPattern>
</relocation> </relocation>
<relocation>
<pattern>de.themoep.minedown</pattern>
<shadedPattern>cc.carm.plugin.moeteleport.lib.minedown</shadedPattern>
</relocation>
<relocation> <relocation>
<pattern>org.bstats</pattern> <pattern>org.bstats</pattern>
<shadedPattern>cc.carm.plugin.timereward.lib.bstats</shadedPattern> <shadedPattern>cc.carm.plugin.timereward.lib.bstats</shadedPattern>
@@ -247,18 +275,19 @@
<shadedPattern>cc.carm.plugin.timereward.lib.json</shadedPattern> <shadedPattern>cc.carm.plugin.timereward.lib.json</shadedPattern>
</relocation> </relocation>
</relocations> </relocations>
<filters> </configuration>
<filter> </plugin>
<artifact>*:*</artifact>
<excludes> <plugin>
<exclude>META-INF/MANIFEST.MF</exclude> <groupId>org.apache.maven.plugins</groupId>
<exclude>META-INF/*.txt</exclude> <artifactId>maven-surefire-plugin</artifactId>
</excludes> <version>2.22.1</version>
</filter> <configuration>
</filters> <useSystemClassLoader>false</useSystemClassLoader>
</configuration> </configuration>
</plugin> </plugin>
</plugins> </plugins>
<resources> <resources>
<resource> <resource>
<directory>src/main/resources</directory> <directory>src/main/resources</directory>
@@ -1,88 +1,89 @@
package cc.carm.plugin.timereward; package cc.carm.plugin.timereward;
import cc.carm.lib.configuration.core.source.ConfigurationProvider;
import cc.carm.lib.easyplugin.EasyPlugin; import cc.carm.lib.easyplugin.EasyPlugin;
import cc.carm.lib.easyplugin.i18n.EasyPluginMessageProvider; import cc.carm.lib.easyplugin.updatechecker.GHUpdateChecker;
import cc.carm.lib.easyplugin.utils.MessageUtils; import cc.carm.lib.easyplugin.utils.MessageUtils;
import cc.carm.lib.mineconfiguration.bukkit.MineConfiguration;
import cc.carm.plugin.timereward.command.TimeRewardCommand; import cc.carm.plugin.timereward.command.TimeRewardCommand;
import cc.carm.plugin.timereward.configuration.PluginConfig; import cc.carm.plugin.timereward.conf.PluginConfig;
import cc.carm.plugin.timereward.database.DataManager; import cc.carm.plugin.timereward.conf.PluginMessages;
import cc.carm.plugin.timereward.hooker.GHUpdateChecker;
import cc.carm.plugin.timereward.hooker.PAPIExpansion; import cc.carm.plugin.timereward.hooker.PAPIExpansion;
import cc.carm.plugin.timereward.listener.UserListener; import cc.carm.plugin.timereward.listener.UserListener;
import cc.carm.plugin.timereward.manager.ConfigManager;
import cc.carm.plugin.timereward.manager.RewardManager; import cc.carm.plugin.timereward.manager.RewardManager;
import cc.carm.plugin.timereward.manager.UserManager; import cc.carm.plugin.timereward.manager.UserManager;
import cc.carm.plugin.timereward.util.JarResourceUtils; import cc.carm.plugin.timereward.storage.database.MySQLStorage;
import org.bstats.bukkit.Metrics; import org.bstats.bukkit.Metrics;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
public class Main extends EasyPlugin { public class Main extends EasyPlugin {
private static Main instance; private static Main instance;
public Main() { protected ConfigurationProvider<?> configProvider;
super(new EasyPluginMessageProvider.zh_CN()); protected ConfigurationProvider<?> messageProvider;
instance = this;
}
private GHUpdateChecker checker; protected MySQLStorage storage;
protected DataManager dataManager;
protected ConfigManager configManager;
protected UserManager userManager; protected UserManager userManager;
protected RewardManager rewardManager; protected RewardManager rewardManager;
@Override public Main() {
public boolean initialize() { instance = this;
log("加载插件配置文件..."); }
this.configManager = new ConfigManager();
if (!this.configManager.initConfig()) {
error("插件配置文件初始化失败,请检查文件权限。");
return false;
}
info("初始化数据管理器..."); @Override
this.dataManager = new DataManager(); protected void load() {
if (!dataManager.initialize()) { log("加载插件配置文件...");
severe("初始化数据库失败,请检查配置文件。"); this.configProvider = MineConfiguration.from(this, "config.yml");
dataManager.shutdown(); this.configProvider.initialize(PluginConfig.class);
this.messageProvider = MineConfiguration.from(this, "messages.yml");
this.messageProvider.initialize(PluginMessages.class);
}
@Override
protected boolean initialize() {
log("初始化数据管理器...");
this.storage = new MySQLStorage();
try {
storage.initialize();
} catch (Exception e) {
severe("初始化存储失败,请检查配置文件。");
setEnabled(false);
return false; // 初始化失败,不再继续加载 return false; // 初始化失败,不再继续加载
} }
log("加载用户管理器..."); log("加载用户管理器...");
this.userManager = new UserManager(); this.userManager = new UserManager();
if (Bukkit.getOnlinePlayers().size() > 0) { if (Bukkit.getOnlinePlayers().size() > 0) {
log(" 加载当前在线用户数据..."); log("加载现有用户数据...");
this.userManager.loadAll(); this.userManager.loadAll();
} }
log("加载奖励管理器..."); log("加载奖励管理器...");
this.rewardManager = new RewardManager(); this.rewardManager = new RewardManager(this);
log(" 加载了 " + this.rewardManager.listRewards().size() + " 个奖励配置"); log("成功加载了 " + this.rewardManager.listRewards().size() + " 个奖励配置");
this.rewardManager.initialize();
log("注册监听器..."); log("注册监听器...");
regListener(new UserListener()); registerListener(new UserListener());
log("注册指令..."); log("注册指令...");
registerCommand("TimeReward", new TimeRewardCommand()); registerCommand("TimeReward", new TimeRewardCommand());
if (MessageUtils.hasPlaceholderAPI()) { if (MessageUtils.hasPlaceholderAPI()) {
log("注册变量..."); log("注册变量...");
new PAPIExpansion(this).register(); new PAPIExpansion(this, "TimeReward").register();
} else { } else {
log("检测到未安装PlaceholderAPI,跳过变量注册"); log("未安装PlaceholderAPI,跳过变量注册...");
} }
if (PluginConfig.METRICS.get()) { if (PluginConfig.METRICS.getNotNull()) {
info("启用统计数据..."); info("启用统计数据...");
Metrics metrics = new Metrics(this, 14505); new Metrics(this, 14505);
} }
if (PluginConfig.CHECK_UPDATE.get()) { if (PluginConfig.CHECK_UPDATE.getNotNull()) {
info("开始检查更新..."); info("开始检查更新...");
this.checker = new GHUpdateChecker("CarmJos", "TimeReward"); getScheduler().runAsync(GHUpdateChecker.runner(this));
getScheduler().runAsync(() -> this.checker.checkUpdate(Main.this.getDescription().getVersion()));
} else { } else {
info("已禁用检查更新,跳过。"); info("已禁用检查更新,跳过。");
} }
@@ -92,34 +93,22 @@ public class Main extends EasyPlugin {
@Override @Override
protected void shutdown() { protected void shutdown() {
info("终止奖励发放进程...");
info("终止发奖励进程...");
this.rewardManager.shutdown(); this.rewardManager.shutdown();
info("卸载监听器...");
Bukkit.getServicesManager().unregisterAll(this);
info("保存用户数据..."); info("保存用户数据...");
this.userManager.unloadAll(true); this.userManager.unloadAll(true);
info("结束数据库进程..."); info("终止数据库进程...");
getDataManager().shutdown(); getStorage().shutdown();
info("卸载监听器...");
Bukkit.getServicesManager().unregisterAll(this);
} }
@Override @Override
public boolean isDebugging() { public boolean isDebugging() {
return PluginConfig.DEBUG.get(); return PluginConfig.DEBUG.getNotNull();
}
@Override
public void outputInfo() {
String[] pluginInfo = JarResourceUtils.readResource(this.getResource("PLUGIN_INFO"));
if (pluginInfo != null) Main.info(pluginInfo);
}
public static Main getInstance() {
return instance;
} }
public static void info(String... messages) { public static void info(String... messages) {
@@ -134,8 +123,20 @@ public class Main extends EasyPlugin {
getInstance().debug(messages); getInstance().debug(messages);
} }
public static DataManager getDataManager() { public static Main getInstance() {
return getInstance().dataManager; return instance;
}
public static MySQLStorage getStorage() {
return getInstance().storage;
}
public ConfigurationProvider<?> getConfigProvider() {
return configProvider;
}
public ConfigurationProvider<?> getMessageProvider() {
return messageProvider;
} }
} }
@@ -2,7 +2,6 @@ package cc.carm.plugin.timereward;
import cc.carm.lib.easyplugin.utils.ColorParser; import cc.carm.lib.easyplugin.utils.ColorParser;
import cc.carm.lib.easyplugin.utils.MessageUtils; import cc.carm.lib.easyplugin.utils.MessageUtils;
import cc.carm.plugin.timereward.manager.ConfigManager;
import cc.carm.plugin.timereward.manager.RewardManager; import cc.carm.plugin.timereward.manager.RewardManager;
import cc.carm.plugin.timereward.manager.UserManager; import cc.carm.plugin.timereward.manager.UserManager;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
@@ -16,10 +15,6 @@ public class TimeRewardAPI {
return Main.getInstance().userManager; return Main.getInstance().userManager;
} }
public static ConfigManager getConfigManager() {
return Main.getInstance().configManager;
}
public static RewardManager getRewardManager() { public static RewardManager getRewardManager() {
return Main.getInstance().rewardManager; return Main.getInstance().rewardManager;
} }
@@ -39,5 +34,4 @@ public class TimeRewardAPI {
return MessageUtils.setPlaceholders(player, ColorParser.parse(command)); return MessageUtils.setPlaceholders(player, ColorParser.parse(command));
} }
} }
@@ -1,9 +1,10 @@
package cc.carm.plugin.timereward.command; package cc.carm.plugin.timereward.command;
import cc.carm.plugin.timereward.Main;
import cc.carm.plugin.timereward.TimeRewardAPI; import cc.carm.plugin.timereward.TimeRewardAPI;
import cc.carm.plugin.timereward.configuration.PluginMessages; import cc.carm.plugin.timereward.conf.PluginMessages;
import cc.carm.plugin.timereward.data.RewardContents; import cc.carm.plugin.timereward.storage.RewardContents;
import cc.carm.plugin.timereward.data.TimeRewardUser; import cc.carm.plugin.timereward.storage.UserData;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.command.Command; import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor; import org.bukkit.command.CommandExecutor;
@@ -27,42 +28,49 @@ public class TimeRewardCommand implements CommandExecutor, TabCompleter {
return true; return true;
} }
@Override @Override
public boolean onCommand(CommandSender sender, Command command, String alias, String[] args) { public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String alias, String[] args) {
if (sender instanceof Player && !sender.hasPermission("TimeReward.admin")) PluginMessages.NO_PERMISSION.send(sender);
if (args.length < 1) return help(sender); if (args.length < 1) return help(sender);
String aim = args[0];
String aim = args[0];
if (aim.equalsIgnoreCase("reload")) { if (aim.equalsIgnoreCase("reload")) {
sender.sendMessage("§7正在重载配置文件..."); long s1 = System.currentTimeMillis();
PluginMessages.RELOAD.START.send(sender);
try { try {
TimeRewardAPI.getConfigManager().reload(); Main.getInstance().getConfigProvider().reload();
sender.sendMessage("§a配置文件重载完成!"); Main.getInstance().getMessageProvider().reload();
PluginMessages.RELOAD.COMPLETE.send(sender, System.currentTimeMillis() - s1, TimeRewardAPI.getRewardManager().listRewards().size());
} catch (Exception e) { } catch (Exception e) {
sender.sendMessage("§c配置文件重载失败,错误信息:" + e.getMessage() + " (详见后台"); PluginMessages.RELOAD.ERROR.send(sender);
e.printStackTrace(); e.printStackTrace();
} }
return true; return true;
} else if (aim.equalsIgnoreCase("list")) { } else if (aim.equalsIgnoreCase("list")) {
Collection<RewardContents> awards = TimeRewardAPI.getRewardManager().listRewards().values(); Collection<RewardContents> awards = TimeRewardAPI.getRewardManager().listRewards().values();
PluginMessages.List.HEADER.send(sender, awards.size()); PluginMessages.LIST.HEADER.send(sender, awards.size());
for (RewardContents reward : awards) { for (RewardContents reward : awards) {
if (reward.getPermission() != null) { if (reward.getPermission() != null) {
PluginMessages.List.OBJECT_PERM.send(sender, PluginMessages.LIST.OBJECT_PERM.send(sender,
reward.getRewardID(), reward.getDisplayName(), reward.getRewardID(), reward.getDisplayName(),
reward.getTime(), reward.getPermission() reward.getTime(), reward.getPermission()
); );
} else { } else {
PluginMessages.List.OBJECT.send(sender, PluginMessages.LIST.OBJECT.send(sender,
reward.getRewardID(), reward.getDisplayName(), reward.getTime() reward.getRewardID(), reward.getDisplayName(), reward.getTime()
); );
} }
} }
return true; return true;
} else if (aim.equalsIgnoreCase("test")) { } else if (aim.equalsIgnoreCase("test")) {
if (args.length < 2) return help(sender); if (args.length < 2) return help(sender);
if (!(sender instanceof Player)) { if (!(sender instanceof Player)) {
sender.sendMessage("§c您不是玩家,无法使用此命令!"); PluginMessages.NOT_PLAYER.send(sender);
return true; return true;
} }
@@ -85,7 +93,7 @@ public class TimeRewardCommand implements CommandExecutor, TabCompleter {
return true; return true;
} }
TimeRewardUser user = TimeRewardAPI.getUserManager().get(player); UserData user = TimeRewardAPI.getUserManager().getData(player);
PluginMessages.USER_INFO.send(sender, PluginMessages.USER_INFO.send(sender,
player.getName(), user.getAllSeconds(), player.getName(), user.getAllSeconds(),
user.getClaimedRewards().size(), String.join("&8, &f", user.getClaimedRewards()) user.getClaimedRewards().size(), String.join("&8, &f", user.getClaimedRewards())
@@ -97,11 +105,8 @@ public class TimeRewardCommand implements CommandExecutor, TabCompleter {
return help(sender); return help(sender);
} }
@Nullable
@Override @Override
public List<String> onTabComplete( public @Nullable List<String> onTabComplete(@NotNull CommandSender sender, @NotNull Command command, @NotNull String alias, @NotNull String[] args) {
@NotNull CommandSender sender, @NotNull Command command,
@NotNull String alias, @NotNull String[] args) {
List<String> allCompletes = new ArrayList<>(); List<String> allCompletes = new ArrayList<>();
// 玩家指令部分 // 玩家指令部分
if (sender.hasPermission("TimeReward.admin")) { if (sender.hasPermission("TimeReward.admin")) {
@@ -123,6 +128,9 @@ public class TimeRewardCommand implements CommandExecutor, TabCompleter {
} }
break; break;
} }
default: {
break;
}
} }
} }
@@ -0,0 +1,52 @@
package cc.carm.plugin.timereward.conf;
import cc.carm.lib.configuration.core.ConfigurationRoot;
import cc.carm.lib.configuration.core.annotation.HeaderComment;
import cc.carm.lib.configuration.core.value.ConfigValue;
import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
import cc.carm.plugin.timereward.storage.RewardContents;
public class PluginConfig extends ConfigurationRoot {
public static final ConfigValue<Boolean> DEBUG = ConfiguredValue.of(Boolean.class, false);
@HeaderComment({
"统计数据设定",
"该选项用于帮助开发者统计插件版本与使用情况,且绝不会影响性能与使用体验。",
"当然,您也可以选择在这里关闭,或在plugins/bStats下的配置文件中关闭。"
})
public static final ConfigValue<Boolean> METRICS = ConfiguredValue.of(Boolean.class, true);
@HeaderComment({
"检查更新设定",
"该选项用于插件判断是否要检查更新,若您不希望插件检查更新并提示您,可以选择关闭。",
"检查更新为异步操作,绝不会影响性能与使用体验。"
})
public static final ConfigValue<Boolean> CHECK_UPDATE = ConfiguredValue.of(Boolean.class, true);
@HeaderComment("数据存储相关设定")
public static final class STORAGE extends ConfigurationRoot {
}
@HeaderComment({"奖励相关设定,包含以下设定:",
" [id] 配置键名即奖励ID,支持英文、数字与下划线。",
" | 确定后请不要更改,因为该键值用于存储玩家是否领取的数据",
" | 如果更改,原先领取过该奖励的玩家将会自动再领取一次!",
" [name] 奖励的显示名称,可以是任意字符串",
" | 可以在 commands 中使用 %(name) 来获取该奖励的名称",
" | 也可以使用变量 %TimeReward_reward_<奖励ID>% 来获取对应奖励的名称",
" [permission] 领取奖励时后台执行的指令",
" | 支持PlaceholderAPI变量,指令中可以使用 %(name) 来获取该奖励的名称。",
" [commands] 该奖励领取权限,可以不设置。",
" | 若为空则所有人都可以领取;若不为空,则需要拥有该权限的玩家才能领取。"
})
public static final ConfigValue<RewardContents.Group> REWARDS = ConfigValue.builder()
.asValue(RewardContents.Group.class).fromSection()
.parseValue((v, d) -> RewardContents.Group.parse(v))
.serializeValue(RewardContents.Group::serialize)
.defaults(RewardContents.Group.defaults())
.build();
}
@@ -0,0 +1,122 @@
package cc.carm.plugin.timereward.conf;
import cc.carm.lib.configuration.core.ConfigurationRoot;
import cc.carm.lib.configuration.core.annotation.HeaderComment;
import cc.carm.lib.easyplugin.utils.ColorParser;
import cc.carm.lib.mineconfiguration.bukkit.builder.message.CraftMessageListBuilder;
import cc.carm.lib.mineconfiguration.bukkit.value.ConfiguredMessageList;
import de.themoep.minedown.MineDown;
import me.clip.placeholderapi.PlaceholderAPI;
import net.md_5.bungee.api.chat.BaseComponent;
import net.md_5.bungee.api.chat.TextComponent;
import org.bukkit.command.CommandSender;
import org.bukkit.command.ConsoleCommandSender;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import java.util.function.BiFunction;
@HeaderComment({
"TimeReward 在线奖励插件的消息配置文件",
"如特定的消息不需要任何提示,可直接留下单行空内容消息。",
"支持 &+颜色代码(原版颜色)、&(#XXXXXX)(RGB颜色) 与 &<#XXXXXX>(前后标注RGB颜色渐变)。",
" "
})
public class PluginMessages extends ConfigurationRoot {
public static @NotNull CraftMessageListBuilder<BaseComponent[]> list() {
return ConfiguredMessageList.create(getParser())
.whenSend((sender, message) -> {
if (sender instanceof ConsoleCommandSender) {
message.forEach(m -> sender.sendMessage(TextComponent.toLegacyText(m)));
return;
}
Player player = (Player) sender;
message.forEach(m -> player.spigot().sendMessage(m));
});
}
public static @NotNull BiFunction<CommandSender, String, BaseComponent[]> getParser() {
return (sender, message) -> {
if (sender instanceof Player) message = PlaceholderAPI.setPlaceholders((Player) sender, message);
return MineDown.parse(ColorParser.parse(message));
};
}
public static final ConfiguredMessageList<BaseComponent[]> NO_PERMISSION = list().defaults(
"&c&l抱歉!&f但您没有足够的权限使用该指令。"
).build();
public static final ConfiguredMessageList<BaseComponent[]> NOT_PLAYER = list().defaults(
"&f该指令请以玩家身份执行。"
).build();
public static final ConfiguredMessageList<BaseComponent[]> NOT_ONLINE = list().defaults(
"&f玩家 &e%(player) &f并不在线。"
).params("player").build();
public static final ConfiguredMessageList<BaseComponent[]> NOT_EXISTS = list().defaults(
"&f奖励 &e%(award) &f并不存在。"
).params("award").build();
public static final ConfiguredMessageList<BaseComponent[]> USER_INFO = list().defaults(
"&f玩家 &6%(player) &f已在线&e%(time)&f秒,共领取了 &e%(amount)&f 次奖励。",
"&7已领取的奖励列表如下:&r%(rewards) &7。"
).params("player", "time", "amount", "rewards").build();
public static final ConfiguredMessageList<BaseComponent[]> COMMAND_LIST = list().defaults(
"&f正在执行奖励 %(award) 的指令列表..."
).params("award").build();
public static final ConfiguredMessageList<BaseComponent[]> COMMAND_USAGE = list().defaults(
"&6&l在线奖励 &f指令帮助",
"&8#&f reload",
"&8-&7 重载插件配置文件。",
"&8#&f user &6<玩家>",
"&8-&7 查看用户的在线时长信息与奖励领取情况。",
"&8#&f list",
"&8-&7 列出所有奖励与条件。",
"&8#&f test &6<奖励ID>",
"&8-&7 测试执行奖励配置的指令。"
).build();
public static class LIST extends ConfigurationRoot {
public static final ConfiguredMessageList<BaseComponent[]> HEADER = list().defaults(
"&6&l在线奖励 &f奖励列表 &7(共%(amount)个)"
).params("amount").build();
public static final ConfiguredMessageList<BaseComponent[]> OBJECT = list().defaults(
"&8# &f%(id)",
"&8- &7奖励名称 &f%(name)",
"&8- &7领取时间 &f&e%(time)&f秒"
).params("id", "name", "time").build();
public static final ConfiguredMessageList<BaseComponent[]> OBJECT_PERM = list().defaults(
"&8# &f%(id)",
"&8- &7奖励名称 &f%(name)",
"&8- &7领取时间 &f&e%(time)&f秒",
"&8- &7需要权限 &f%(permission)"
).params("id", "name", "time", "permission").build();
}
public static class RELOAD extends ConfigurationRoot {
public static final ConfiguredMessageList<BaseComponent[]> START = list().defaults(
"&f正在重载配置文件..."
).build();
public static final ConfiguredMessageList<BaseComponent[]> ERROR = list().defaults(
"&f配置文件&c重载失败!&f详细原因详见后台输出。"
).build();
public static final ConfiguredMessageList<BaseComponent[]> COMPLETE = list().defaults(
"&f配置文件重载完成!耗时 &d%(time)&fms,共加载了 &d(count) &f个奖励配置。"
).params("time", "count").build();
}
}
@@ -1,30 +0,0 @@
package cc.carm.plugin.timereward.configuration;
import cc.carm.lib.easyplugin.configuration.cast.ConfigSectionCast;
import cc.carm.lib.easyplugin.configuration.values.ConfigValue;
import cc.carm.plugin.timereward.TimeRewardAPI;
import cc.carm.plugin.timereward.data.RewardContents;
import java.util.HashMap;
import java.util.LinkedHashMap;
public class PluginConfig {
public static final ConfigValue<Boolean> DEBUG = new ConfigValue<>(
"debug", Boolean.class, false
);
public static final ConfigValue<Boolean> METRICS = new ConfigValue<>(
"metrics", Boolean.class, true
);
public static final ConfigValue<Boolean> CHECK_UPDATE = new ConfigValue<>(
"check-update", Boolean.class, true
);
public static final ConfigSectionCast<HashMap<String, RewardContents>> REWARDS = new ConfigSectionCast<>(
"rewards", TimeRewardAPI.getRewardManager()::readRewards, new LinkedHashMap<>()
);
}
@@ -1,64 +0,0 @@
package cc.carm.plugin.timereward.configuration;
import cc.carm.lib.easyplugin.configuration.language.EasyMessageList;
import cc.carm.lib.easyplugin.configuration.language.MessagesRoot;
public class PluginMessages extends MessagesRoot {
public static final EasyMessageList COMMAND_USAGE = new EasyMessageList(
"&6&l在线奖励 &f后台指令帮助",
"&8#&f reload",
"&8-&7 重载插件配置文件。",
"&8#&f user &6<玩家>",
"&8-&7 查看用户的在线时长信息与奖励领取情况。",
"&8#&f list",
"&8-&7 列出所有奖励与条件。",
"&8#&f test &6<奖励ID>",
"&8-&7 测试执行奖励配置的指令。"
);
public static class List {
public static final EasyMessageList HEADER = EasyMessageList.builder()
.contents("&6&l在线奖励 &f奖励列表 &7(共%(amount)个)")
.params("amount").build();
public static final EasyMessageList OBJECT = EasyMessageList.builder()
.contents(
"&8# &f%(id)",
"&8- &7奖励名称 &f%(name)",
"&8- &7领取时间 &f&e%(time)&f秒"
).params("id", "name", "time").build();
public static final EasyMessageList OBJECT_PERM = EasyMessageList.builder()
.contents(
"&8# &f%(id)",
"&8- &7奖励名称 &f%(name)",
"&8- &7领取时间 &f&e%(time)&f秒",
"&8- &7需要权限 &f%(permission)"
).params("id", "name", "time", "permission").build();
}
public static final EasyMessageList USER_INFO = EasyMessageList.builder()
.contents(
"&f玩家 &6%(player) &f已在线&e%(time)&f秒,共领取了 &e%(amount)&f 次奖励。",
"&7已领取的奖励列表如下:&r%(rewards) &7。"
).params("player", "time", "amount", "rewards").build();
public static final EasyMessageList COMMAND_LIST = EasyMessageList.builder()
.contents("&f正在执行奖励 %(award) 的指令列表...")
.params("award")
.build();
public static final EasyMessageList NOT_ONLINE = EasyMessageList.builder()
.contents("&f玩家 &e%(player) &f并不在线。")
.params("player")
.build();
public static final EasyMessageList NOT_EXISTS = EasyMessageList.builder()
.contents("&f奖励 &e%(award) &f并不存在。")
.params("award")
.build();
}
@@ -1,8 +0,0 @@
package cc.carm.plugin.timereward.data;
import cc.carm.plugin.timereward.database.DataManager;
@FunctionalInterface
public interface DataTaskRunner {
void run(TimeRewardUser user, DataManager dataManager) throws Exception;
}
@@ -1,77 +0,0 @@
package cc.carm.plugin.timereward.data;
import cc.carm.lib.easyplugin.utils.ColorParser;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
import java.util.Objects;
public class RewardContents {
public final @NotNull String id;
private final long time;
private final @Nullable String name;
private final @Nullable String permission;
private final @NotNull List<String> commands;
public RewardContents(@NotNull String id, long time,
@Nullable String name, @Nullable String permission,
@NotNull List<String> commands) {
this.id = id;
this.time = time;
this.name = name;
this.permission = permission;
this.commands = commands;
}
public String getRewardID() {
return id;
}
public long getTime() {
return time;
}
public @Nullable String getName() {
return name;
}
public @NotNull String getDisplayName() {
return ColorParser.parseColor(getName() == null ? getRewardID() : getName());
}
public @Nullable String getPermission() {
return permission;
}
public @NotNull List<String> getCommands() {
return commands;
}
public boolean checkPermission(@NotNull Player player) {
return permission == null || player.hasPermission(permission);
}
public boolean isTimeEnough(long requireSeconds) {
return requireSeconds >= getTime();
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RewardContents that = (RewardContents) o;
return id.equals(that.id);
}
@Override
public int hashCode() {
return Objects.hash(id);
}
}
@@ -1,49 +0,0 @@
package cc.carm.plugin.timereward.database;
import cc.carm.lib.easyplugin.configuration.values.ConfigValue;
public class DBConfiguration {
protected static final ConfigValue<String> DRIVER_NAME = new ConfigValue<>(
"database.driver", String.class,
"com.mysql.cj.jdbc.Driver"
);
protected static final ConfigValue<String> HOST = new ConfigValue<>(
"database.host", String.class,
"127.0.0.1"
);
protected static final ConfigValue<Integer> PORT = new ConfigValue<>(
"database.port", Integer.class,
3306
);
protected static final ConfigValue<String> DATABASE = new ConfigValue<>(
"database.database", String.class,
"minecraft"
);
protected static final ConfigValue<String> USERNAME = new ConfigValue<>(
"database.username", String.class,
"root"
);
protected static final ConfigValue<String> PASSWORD = new ConfigValue<>(
"database.password", String.class,
"password"
);
protected static final ConfigValue<String> ADDITIONAL = new ConfigValue<>(
"database.additional", String.class,
"?useSSL=false"
);
protected static String buildJDBC() {
return String.format("jdbc:mysql://%s:%s/%s%s",
HOST.get(), PORT.get(), DATABASE.get(), ADDITIONAL.get()
);
}
}
@@ -1,45 +0,0 @@
package cc.carm.plugin.timereward.database;
import cc.carm.lib.easyplugin.configuration.values.ConfigValue;
public class DBTables {
protected static class UserOnlineTime {
protected static final ConfigValue<String> TABLE_NAME = new ConfigValue<>(
"database.tables.time", String.class,
"tr_user_times"
);
protected static final String[] TABLE_COLUMNS = new String[]{
"`uuid` VARCHAR(36) NOT NULL PRIMARY KEY COMMENT '用户UUID'", // 用户的UUID
"`time` INT UNSIGNED NOT NULL DEFAULT 0 COMMENT '用户在线秒数'",// 用户在线时间(秒)
"`update` DATETIME NOT NULL " +
"DEFAULT CURRENT_TIMESTAMP " +
"ON UPDATE CURRENT_TIMESTAMP " +
" COMMENT '最后更新时间'"
};
}
protected static class UserClaimedReward {
protected static final ConfigValue<String> TABLE_NAME = new ConfigValue<>(
"database.tables.claimed", String.class,
"tr_user_claimed"
);
protected static final String[] TABLE_COLUMNS = new String[]{
"`id` INT UNSIGNED NOT NULL AUTO_INCREMENT UNIQUE KEY", // 排序键
"`uuid` VARCHAR(36) NOT NULL PRIMARY KEY COMMENT '用户UUID'", // 用户的UUID 主键
"`value` MEDIUMTEXT", // 已领取的奖励ID
"`update` DATETIME NOT NULL " +
"DEFAULT CURRENT_TIMESTAMP " +
"ON UPDATE CURRENT_TIMESTAMP " +
" COMMENT '最后更新时间'"
};
}
}
@@ -1,117 +0,0 @@
package cc.carm.plugin.timereward.database;
import cc.carm.lib.easysql.EasySQL;
import cc.carm.lib.easysql.api.SQLManager;
import cc.carm.plugin.timereward.Main;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.UUID;
public class DataManager {
protected static final Gson GSON = new Gson();
protected static final JsonParser PARSER = new JsonParser();
private SQLManager sqlManager;
public boolean initialize() {
try {
Main.info(" 尝试连接到数据库...");
this.sqlManager = EasySQL.createManager(
DBConfiguration.DRIVER_NAME.get(), DBConfiguration.buildJDBC(),
DBConfiguration.USERNAME.get(), DBConfiguration.PASSWORD.get()
);
// this.sqlManager.setDebugMode(() -> Main.getInstance().isDebugging());
} catch (Exception exception) {
Main.severe("无法连接到数据库,请检查配置文件。");
exception.printStackTrace();
return false;
}
try {
Main.info(" 创建插件所需表...");
getSQLManager().createTable(DBTables.UserOnlineTime.TABLE_NAME.get())
.setColumns(DBTables.UserOnlineTime.TABLE_COLUMNS)
.build().execute();
getSQLManager().createTable(DBTables.UserClaimedReward.TABLE_NAME.get())
.setColumns(DBTables.UserClaimedReward.TABLE_COLUMNS)
.build().execute();
} catch (SQLException exception) {
Main.severe("无法创建插件所需的表,请检查数据库权限。");
exception.printStackTrace();
return false;
}
return true;
}
public void shutdown() {
Main.info(" 关闭数据库连接...");
EasySQL.shutdownManager(getSQLManager());
this.sqlManager = null;
}
public SQLManager getSQLManager() {
return sqlManager;
}
public @Nullable Long getPlayTime(@NotNull UUID userUUID) throws SQLException {
return getSQLManager().createQuery().inTable(DBTables.UserOnlineTime.TABLE_NAME.get())
.selectColumns("uuid", "time")
.addCondition("uuid", userUUID.toString())
.setLimit(1).build().executeFunction(query -> {
ResultSet resultSet = query.getResultSet();
return resultSet.next() ? resultSet.getLong("time") : 0L;
});
}
public @NotNull Set<String> getClaimedData(@NotNull UUID userUUID) throws SQLException {
return getSQLManager().createQuery().inTable(DBTables.UserClaimedReward.TABLE_NAME.get())
.selectColumns("uuid", "value")
.addCondition("uuid", userUUID.toString())
.setLimit(1).build().executeFunction(query -> {
ResultSet resultSet = query.getResultSet();
if (!resultSet.next()) return new LinkedHashSet<>();
String json = resultSet.getString("value");
if (json == null) return new LinkedHashSet<>();
JsonElement element = PARSER.parse(json);
if (!element.isJsonArray()) return new LinkedHashSet<>();
Set<String> ids = new LinkedHashSet<>();
for (JsonElement e : element.getAsJsonArray()) {
ids.add(e.getAsString());
}
return ids;
}, new LinkedHashSet<>());
}
public void saveClaimedData(@NotNull UUID userUUID, @Nullable Set<String> claimedRewards) throws SQLException {
if (claimedRewards == null) {
getSQLManager().createDelete(DBTables.UserClaimedReward.TABLE_NAME.get())
.addCondition("uuid", userUUID.toString())
.setLimit(1).build().execute();
} else {
getSQLManager().createReplace(DBTables.UserClaimedReward.TABLE_NAME.get())
.setColumnNames("uuid", "value")
.setParams(userUUID.toString(), GSON.toJson(claimedRewards))
.execute();
}
}
public void savePlayTime(@NotNull UUID userUUID, long time) throws SQLException {
getSQLManager().createReplace(DBTables.UserOnlineTime.TABLE_NAME.get())
.setColumnNames("uuid", "time").setParams(userUUID.toString(), time)
.execute();
}
}
@@ -1,34 +0,0 @@
package cc.carm.plugin.timereward.hooker;
import cc.carm.lib.githubreleases4j.GithubReleases4J;
import cc.carm.plugin.timereward.Main;
public class GHUpdateChecker {
private final String owner;
private final String repo;
public GHUpdateChecker(String owner, String repo) {
this.owner = owner;
this.repo = repo;
}
public void checkUpdate(String currentVersion) {
Integer behindVersions = GithubReleases4J.getVersionBehind(owner, repo, currentVersion);
String downloadURL = GithubReleases4J.getReleasesURL(owner, repo);
if (behindVersions == null) {
Main.severe("检查更新失败,请您定期查看插件是否更新,避免安全问题。");
Main.severe("下载地址 " + downloadURL);
} else if (behindVersions == 0) {
Main.info("检查完成,当前已是最新版本。");
} else if (behindVersions > 0) {
Main.info("发现新版本! 目前已落后 " + behindVersions + " 个版本。");
Main.info("最新版下载地址 " + downloadURL);
} else {
Main.severe("检查更新失败! 当前版本未知,请您使用原生版本以避免安全问题。");
Main.severe("最新版下载地址 " + downloadURL);
}
}
}
@@ -1,88 +1,54 @@
package cc.carm.plugin.timereward.hooker; package cc.carm.plugin.timereward.hooker;
import cc.carm.lib.easyplugin.papi.EasyPlaceholder;
import cc.carm.lib.easyplugin.papi.handler.PlaceholderHandler;
import cc.carm.plugin.timereward.TimeRewardAPI; import cc.carm.plugin.timereward.TimeRewardAPI;
import cc.carm.plugin.timereward.data.RewardContents; import cc.carm.plugin.timereward.storage.RewardContents;
import cc.carm.plugin.timereward.data.TimeRewardUser; import cc.carm.plugin.timereward.storage.UserData;
import me.clip.placeholderapi.expansion.PlaceholderExpansion;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.plugin.java.JavaPlugin; import org.bukkit.plugin.java.JavaPlugin;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import java.util.Arrays; import java.util.Collections;
import java.util.List; import java.util.function.BiFunction;
import java.util.function.Function;
public class PAPIExpansion extends PlaceholderExpansion { public class PAPIExpansion extends EasyPlaceholder {
private static final List<String> PLACEHOLDERS = Arrays.asList( public PAPIExpansion(@NotNull JavaPlugin plugin, @NotNull String rootIdentifier) {
"%TimeReward_time%", super(plugin, rootIdentifier);
"%TimeReward_reward_<奖励ID>%",
"%TimeReward_claimed_<奖励ID>%"
);
private final JavaPlugin plugin; handle("time", userHandler(UserData::getAllSeconds));
handle("reward",
public PAPIExpansion(JavaPlugin plugin) { rewardHandler(RewardContents::getDisplayName),
this.plugin = plugin; Collections.singletonList("<奖励ID>")
);
handle("claimed", userHandler((user, args) -> {
if (args.length < 1) return "请填写奖励ID";
else return user.isClaimed(args[0]);
}), Collections.singletonList("<奖励ID>"));
handle("version", (player, args) -> getVersion());
} }
@Override protected <R> PlaceholderHandler userHandler(Function<UserData, R> userFunction) {
public @NotNull List<String> getPlaceholders() { return userHandler((user, args) -> userFunction.apply(user));
return PLACEHOLDERS;
} }
@Override protected <R> PlaceholderHandler userHandler(BiFunction<UserData, String[], R> userFunction) {
public boolean canRegister() { return (player, args) -> {
return true; if (player == null || !player.isOnline()) return "加载中...";
return userFunction.apply(TimeRewardAPI.getUserManager().getData((Player) player), args);
};
} }
@Override protected <R> PlaceholderHandler rewardHandler(Function<RewardContents, R> function) {
public @NotNull String getAuthor() { return (player, args) -> {
return plugin.getDescription().getAuthors().toString(); if (args.length < 1) return "请填写奖励ID";
} String rewardName = args[0];
RewardContents contents = TimeRewardAPI.getRewardManager().getReward(rewardName);
@Override if (contents == null) return "奖励不存在";
public @NotNull String getIdentifier() { return function.apply(contents);
return plugin.getDescription().getName(); };
}
@Override
public @NotNull String getVersion() {
return plugin.getDescription().getVersion();
}
@Override
public String onPlaceholderRequest(Player player, @NotNull String identifier) {
if (player == null) return "加载中...";
String[] args = identifier.split("_");
if (args.length < 1) {
return "Error Params";
}
TimeRewardUser user = TimeRewardAPI.getUserManager().get(player);
switch (args[0].toLowerCase()) {
case "time": {
return Long.toString(user.getAllSeconds());
}
case "reward": {
if (args.length < 2) return "请填写奖励ID";
String rewardName = args[1];
RewardContents contents = TimeRewardAPI.getRewardManager().getReward(rewardName);
if (contents == null) return "奖励不存在";
return contents.getDisplayName();
}
case "claimed": {
if (args.length < 2) return "请填写奖励ID";
return Boolean.toString(user.isClaimed(args[1]));
}
case "version": {
return getVersion();
}
default: {
return "参数错误";
}
}
} }
} }
@@ -11,12 +11,12 @@ public class UserListener implements Listener {
@EventHandler @EventHandler
public void onJoin(PlayerJoinEvent event) { public void onJoin(PlayerJoinEvent event) {
Main.getInstance().getScheduler().runAsync(() -> TimeRewardAPI.getUserManager().load(event.getPlayer().getUniqueId())); Main.getInstance().getScheduler().runAsync(() -> TimeRewardAPI.getUserManager().loadData(event.getPlayer().getUniqueId()));
} }
@EventHandler @EventHandler
public void onQuit(PlayerQuitEvent event) { public void onQuit(PlayerQuitEvent event) {
Main.getInstance().getScheduler().runAsync(() -> TimeRewardAPI.getUserManager().unload(event.getPlayer().getUniqueId())); Main.getInstance().getScheduler().runAsync(() -> TimeRewardAPI.getUserManager().unloadData(event.getPlayer().getUniqueId()));
} }
} }
@@ -1,49 +0,0 @@
package cc.carm.plugin.timereward.manager;
import cc.carm.lib.easyplugin.configuration.file.FileConfig;
import cc.carm.lib.easyplugin.configuration.language.MessagesConfig;
import cc.carm.lib.easyplugin.configuration.language.MessagesInitializer;
import cc.carm.plugin.timereward.Main;
import cc.carm.plugin.timereward.configuration.PluginMessages;
public class ConfigManager {
private FileConfig pluginConfiguration;
private MessagesConfig messageConfiguration;
public boolean initConfig() {
try {
pluginConfiguration = new FileConfig(Main.getInstance(), "config.yml");
messageConfiguration = new MessagesConfig(Main.getInstance(), "messages.yml");
FileConfig.pluginConfiguration = () -> pluginConfiguration;
FileConfig.messageConfiguration = () -> messageConfiguration;
MessagesInitializer.initialize(messageConfiguration, PluginMessages.class);
return true;
} catch (Exception ex) {
return false;
}
}
public FileConfig getPluginConfig() {
return FileConfig.pluginConfiguration.get();
}
public FileConfig getMessageConfig() {
return FileConfig.messageConfiguration.get();
}
public void reload() throws Exception {
getPluginConfig().reload();
getMessageConfig().reload();
}
public void saveConfig() throws Exception {
getPluginConfig().save();
getMessageConfig().save();
}
}
@@ -3,26 +3,27 @@ package cc.carm.plugin.timereward.manager;
import cc.carm.lib.easyplugin.utils.MessageUtils; import cc.carm.lib.easyplugin.utils.MessageUtils;
import cc.carm.plugin.timereward.Main; import cc.carm.plugin.timereward.Main;
import cc.carm.plugin.timereward.TimeRewardAPI; import cc.carm.plugin.timereward.TimeRewardAPI;
import cc.carm.plugin.timereward.configuration.PluginConfig; import cc.carm.plugin.timereward.conf.PluginConfig;
import cc.carm.plugin.timereward.data.RewardContents; import cc.carm.plugin.timereward.storage.RewardContents;
import cc.carm.plugin.timereward.data.TimeRewardUser; import cc.carm.plugin.timereward.storage.UserData;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.bukkit.scheduler.BukkitRunnable; import org.bukkit.scheduler.BukkitRunnable;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.Unmodifiable;
import java.util.HashMap; import java.util.Collections;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.stream.Collectors; import java.util.stream.Collectors;
public class RewardManager { public class RewardManager {
private BukkitRunnable rewardChecker; protected BukkitRunnable runnable;
public void initialize() { public RewardManager(Main main) {
this.rewardChecker = new BukkitRunnable() { this.runnable = new BukkitRunnable() {
@Override @Override
public void run() { public void run() {
if (Bukkit.getOnlinePlayers().isEmpty()) return; if (Bukkit.getOnlinePlayers().isEmpty()) return;
@@ -31,58 +32,36 @@ public class RewardManager {
List<RewardContents> unclaimedRewards = getUnclaimedRewards(player); List<RewardContents> unclaimedRewards = getUnclaimedRewards(player);
if (unclaimedRewards.isEmpty()) continue; if (unclaimedRewards.isEmpty()) continue;
Main.getInstance().getScheduler().run(() -> unclaimedRewards.forEach( main.getScheduler().run(() -> unclaimedRewards.forEach(
// 在同步进程中为玩家发放奖励 // 在同步进程中为玩家发放奖励
unclaimedReward -> claimReward(player, unclaimedReward, false) unclaimedReward -> claimReward(player, unclaimedReward, false)
)); ));
} }
} }
}; };
this.runnable.runTaskTimerAsynchronously(main, 100L, 20L);
this.rewardChecker.runTaskTimerAsynchronously(Main.getInstance(), 100L, 20L);
} }
public void shutdown() { public void shutdown() {
this.rewardChecker.cancel(); this.runnable.cancel();
this.rewardChecker = null; this.runnable = null;
} }
public HashMap<String, RewardContents> readRewards(@NotNull ConfigurationSection section) { protected Map<String, RewardContents> getRewards() {
HashMap<String, RewardContents> rewards = new HashMap<>(); return PluginConfig.REWARDS.getNotNull().getContents();
for (String rewardID : section.getKeys(false)) { }
ConfigurationSection rewardSection = section.getConfigurationSection(rewardID);
if (rewardSection == null) continue;
long time = rewardSection.getLong("time", -1);
if (time <= 0) {
Main.severe("奖励 " + rewardID + " 的时间配置错误,请检查配置文件。");
continue;
}
rewards.put(rewardID, new RewardContents( public @Nullable RewardContents getReward(String rewardID) {
rewardID, time, return getRewards().get(rewardID);
rewardSection.getString("name"),
rewardSection.getString("permission"),
rewardSection.getStringList("commands")
));
}
return rewards;
} }
public Map<String, RewardContents> listRewards() { public Map<String, RewardContents> listRewards() {
return new HashMap<>(getRewardsMap()); return Collections.unmodifiableMap(PluginConfig.REWARDS.getNotNull().getContents());
} }
public RewardContents getReward(String rewardID) { @Unmodifiable
return getRewardsMap().get(rewardID); public @NotNull List<RewardContents> getUnclaimedRewards(@NotNull Player player) {
} UserData user = TimeRewardAPI.getUserManager().getData(player);
protected HashMap<String, RewardContents> getRewardsMap() {
return PluginConfig.REWARDS.getOptional().orElse(new HashMap<>());
}
public List<RewardContents> getUnclaimedRewards(Player player) {
TimeRewardUser user = TimeRewardAPI.getUserManager().get(player);
return listRewards().values().stream() return listRewards().values().stream()
.filter(reward -> reward.isTimeEnough(user.getAllSeconds())) // 时间足够 .filter(reward -> reward.isTimeEnough(user.getAllSeconds())) // 时间足够
.filter(reward -> !user.isClaimed(reward.getRewardID())) // 未曾领取 .filter(reward -> !user.isClaimed(reward.getRewardID())) // 未曾领取
@@ -91,7 +70,7 @@ public class RewardManager {
} }
public boolean claimReward(Player player, RewardContents reward, boolean check) { public boolean claimReward(Player player, RewardContents reward, boolean check) {
TimeRewardUser user = TimeRewardAPI.getUserManager().get(player); UserData user = TimeRewardAPI.getUserManager().getData(player);
if (check && user.isClaimed(reward.getRewardID())) return false; if (check && user.isClaimed(reward.getRewardID())) return false;
if (check && !reward.isTimeEnough(user.getAllSeconds())) return false; if (check && !reward.isTimeEnough(user.getAllSeconds())) return false;
if (check && !reward.checkPermission(player)) return false; if (check && !reward.checkPermission(player)) return false;
@@ -113,5 +92,4 @@ public class RewardManager {
return claimReward(player, reward, true); return claimReward(player, reward, true);
} }
} }
@@ -1,9 +1,10 @@
package cc.carm.plugin.timereward.manager; package cc.carm.plugin.timereward.manager;
import cc.carm.plugin.timereward.Main; import cc.carm.plugin.timereward.Main;
import cc.carm.plugin.timereward.data.DataTaskRunner; import cc.carm.plugin.timereward.util.DataTaskRunner;
import cc.carm.plugin.timereward.data.TimeRewardUser; import cc.carm.plugin.timereward.storage.UserData;
import cc.carm.plugin.timereward.database.DataManager; import cc.carm.plugin.timereward.storage.database.MySQLStorage;
import com.google.common.collect.ImmutableMap;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@@ -12,122 +13,119 @@ import org.jetbrains.annotations.Unmodifiable;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.Set;
import java.util.UUID; import java.util.UUID;
public class UserManager { public class UserManager {
private final HashMap<UUID, TimeRewardUser> userDataMap; private final HashMap<UUID, UserData> userDataMap;
public UserManager() { public UserManager() {
this.userDataMap = new HashMap<>(); this.userDataMap = new HashMap<>();
} }
@NotNull @NotNull
public TimeRewardUser read(UUID userUUID) { public UserData readData(UUID userUUID) {
try { try {
long start = System.currentTimeMillis(); long start = System.currentTimeMillis();
DataManager storage = Main.getDataManager(); MySQLStorage storage = Main.getStorage();
Long playTime = storage.getPlayTime(userUUID); UserData data = storage.loadData(userUUID);
Set<String> claimedRewards = storage.getClaimedData(userUUID);
if (playTime == null && claimedRewards.isEmpty()) { if (data == null) {
Main.debugging("当前还不存在玩家 " + userUUID + " 的数据,视作新档。"); Main.debugging("当前还不存在玩家 " + userUUID + " 的数据,视作新档。");
return new TimeRewardUser(userUUID); return new UserData(userUUID);
} }
Main.debugging("读取 " + userUUID + " 的用户数据完成, 耗时 " + (System.currentTimeMillis() - start) + "ms。"); Main.debugging("读取 " + userUUID + " 的用户数据完成, 耗时 " + (System.currentTimeMillis() - start) + "ms。");
return new TimeRewardUser(userUUID, claimedRewards, playTime == null ? 0L : playTime);
return data;
} catch (Exception e) { } catch (Exception e) {
Main.severe("无法正常读取玩家数据,玩家操作将不会被保存,请检查数据配置!"); Main.severe("无法正常读取玩家数据,玩家操作将不会被保存,请检查数据配置!");
Main.severe("Could not load user's data, please check the data configuration!"); Main.severe("Could not loadData user's data, please check the data conf!");
e.printStackTrace(); e.printStackTrace();
return new TimeRewardUser(userUUID); return new UserData(userUUID);
} }
} }
public void save(TimeRewardUser user) { public void saveData(UserData data) {
try { try {
long start = System.currentTimeMillis(); long start = System.currentTimeMillis();
DataManager dataManager = Main.getDataManager(); MySQLStorage storage = Main.getStorage();
Main.debugging("正在保存 " + user.getUserUUID() + " 的用户数据..."); Main.debugging("正在保存 " + data.getUserUUID() + " 的用户数据...");
dataManager.saveClaimedData(user.getUserUUID(), user.getClaimedRewards()); storage.saveClaimedData(data.getUserUUID(), data.getClaimedRewards());
dataManager.savePlayTime(user.getUserUUID(), user.getAllSeconds()); storage.savePlayTime(data.getUserUUID(), data.getAllSeconds());
Main.debugging("保存 " + user.getUserUUID() + " 的用户数据完成,耗时 " + (System.currentTimeMillis() - start) + "ms。"); Main.debugging("保存 " + data.getUserUUID() + " 的用户数据完成,耗时 " + (System.currentTimeMillis() - start) + "ms。");
} catch (Exception e) { } catch (Exception e) {
Main.severe("无法正常保存玩家数据,请检查数据配置!"); Main.severe("无法正常保存玩家数据,请检查数据配置!");
Main.severe("Could not save user's data, please check the data configuration!"); Main.severe("Could not saveData user's data, please check the data conf!");
e.printStackTrace(); e.printStackTrace();
} }
} }
public void load(UUID userUUID) { public void loadData(UUID userUUID) {
getUsersMap().put(userUUID, read(userUUID)); getUserDataMap().put(userUUID, readData(userUUID));
} }
public void unload(UUID userUUID) { public void unloadData(UUID userUUID) {
unload(userUUID, true); unloadData(userUUID, true);
} }
public void unload(UUID userUUID, boolean save) { public void unloadData(UUID userUUID, boolean save) {
TimeRewardUser data = get(userUUID); UserData data = getData(userUUID);
if (data == null) return; if (data == null) return;
if (save) save(data); if (save) saveData(data);
getUsersMap().remove(userUUID); getUserDataMap().remove(userUUID);
} }
public void loadAll() { public void loadAll() {
for (Player player : Bukkit.getOnlinePlayers()) { for (Player player : Bukkit.getOnlinePlayers()) {
if (getUsersMap().containsKey(player.getUniqueId())) continue; if (getUserDataMap().containsKey(player.getUniqueId())) continue;
load(player.getUniqueId()); loadData(player.getUniqueId());
} }
} }
public void saveAll() { public void saveAll() {
getUsersMap().values().forEach(this::save); getUserDataMap().values().forEach(this::saveData);
} }
public void unloadAll(boolean save) { public void unloadAll(boolean save) {
if (save) saveAll(); if (save) saveAll();
getUsersMap().clear(); getUserDataMap().clear();
} }
@Nullable @Nullable
public TimeRewardUser get(UUID userUUID) { public UserData getData(UUID userUUID) {
return getUsersMap().get(userUUID); return getUserDataMap().get(userUUID);
} }
@NotNull @NotNull
public TimeRewardUser get(Player player) { public UserData getData(Player player) {
return getUsersMap().get(player.getUniqueId()); return getUserDataMap().get(player.getUniqueId());
} }
public void editData(@NotNull UUID uuid, @NotNull DataTaskRunner task) { public void editData(@NotNull DataTaskRunner task) {
TimeRewardUser user = get(uuid);
if (user == null) user = read(uuid); // 不在线则加载数据
try { try {
task.run(user, Main.getDataManager()); task.run(Main.getStorage());
} catch (Exception exception) { } catch (Exception exception) {
Main.severe("无法正常更改玩家数据,请检查数据配置!"); Main.severe("无法正常更改玩家数据,请检查数据配置!");
Main.severe("Could not edit user's data, please check the data configuration!"); Main.severe("Could not edit user's data, please check the data conf!");
exception.printStackTrace(); exception.printStackTrace();
} }
} }
public void editDataAsync(@NotNull UUID uuid, @NotNull DataTaskRunner task) { public void editDataAsync(@NotNull DataTaskRunner task) {
Main.getInstance().getScheduler().runAsync(() -> editData(uuid, task)); Main.getInstance().getScheduler().runAsync(() -> editData(task));
} }
@NotNull @NotNull
@Unmodifiable @Unmodifiable
public Map<UUID, TimeRewardUser> list() { public Map<UUID, UserData> listUserData() {
return new HashMap<>(getUsersMap()); return ImmutableMap.copyOf(getUserDataMap());
} }
protected @NotNull HashMap<UUID, TimeRewardUser> getUsersMap() { protected @NotNull HashMap<UUID, UserData> getUserDataMap() {
return userDataMap; return userDataMap;
} }
@@ -0,0 +1,149 @@
package cc.carm.plugin.timereward.storage;
import cc.carm.lib.configuration.core.source.ConfigurationWrapper;
import cc.carm.lib.easyplugin.utils.ColorParser;
import cc.carm.plugin.timereward.Main;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
public class RewardContents {
public final @NotNull String id;
private final long time;
private final @Nullable String name;
private final @Nullable String permission;
private final @NotNull List<String> commands;
public RewardContents(@NotNull String id, long time,
@Nullable String name, @Nullable String permission,
@NotNull List<String> commands) {
this.id = id;
this.time = time;
this.name = name;
this.permission = permission;
this.commands = commands;
}
public String getRewardID() {
return id;
}
public long getTime() {
return time;
}
public @Nullable String getName() {
return name;
}
public @NotNull String getDisplayName() {
return ColorParser.parse(getName() == null ? getRewardID() : getName());
}
public @Nullable String getPermission() {
return permission;
}
public @NotNull List<String> getCommands() {
return commands;
}
public boolean checkPermission(@NotNull Player player) {
return permission == null || player.hasPermission(permission);
}
public boolean isTimeEnough(long requireSeconds) {
return requireSeconds >= getTime();
}
public Map<String, Object> serialize() {
Map<String, Object> map = new LinkedHashMap<>();
map.put("time", getTime());
if (getName() != null) map.put("name", getName());
if (getPermission() != null) map.put("permission", getPermission());
map.put("commands", getCommands());
return map;
}
public static RewardContents parse(String id, @NotNull ConfigurationWrapper<?> section) {
long time = section.getLong("time", -1L);
if (time <= 0) {
Main.severe("奖励 " + id + " 的时间配置错误,请检查配置文件。");
return null;
}
return new RewardContents(
id, time,
section.getString("name"),
section.getString("permission"),
section.getStringList("commands")
);
}
public static RewardContents defaults(String id) {
return new RewardContents(
id, 7200,
"&f[初级奖励] &e总在线时长 2小时", "TimeReward.vip",
Collections.singletonList("say &f恭喜 &b%player_name% &f领取了奖励 &r%(name) &f")
);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RewardContents that = (RewardContents) o;
return id.equals(that.id);
}
@Override
public int hashCode() {
return Objects.hash(id);
}
public static final class Group {
final @NotNull Map<String, RewardContents> contents;
public Group(@NotNull Map<String, RewardContents> contents) {
this.contents = contents;
}
public @NotNull Map<String, RewardContents> getContents() {
return contents;
}
public Map<String, Object> serialize() {
Map<String, Object> map = new LinkedHashMap<>();
for (Map.Entry<String, RewardContents> entry : contents.entrySet()) {
map.put(entry.getKey(), entry.getValue().serialize());
}
return map;
}
public static Group parse(@NotNull ConfigurationWrapper<?> section) {
Map<String, RewardContents> rewards = new LinkedHashMap<>();
for (String rewardID : section.getKeys(false)) {
ConfigurationWrapper<?> rewardSection = section.getConfigurationSection(rewardID);
if (rewardSection == null) continue;
RewardContents c = RewardContents.parse(rewardID, rewardSection);
if (c == null) continue;
rewards.put(rewardID, c);
}
return new Group(rewards);
}
public static Group defaults() {
Map<String, RewardContents> rewards = new LinkedHashMap<>();
rewards.put("example", RewardContents.defaults("example"));
return new Group(rewards);
}
}
}
@@ -1,4 +1,4 @@
package cc.carm.plugin.timereward.data; package cc.carm.plugin.timereward.storage;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
@@ -10,33 +10,31 @@ import java.util.concurrent.TimeUnit;
/** /**
* 用户奖励数据用于存储用户的奖励的领取情况 * 用户奖励数据用于存储用户的奖励的领取情况
*/ */
public class TimeRewardUser { public class UserData {
UUID userUUID; protected final @NotNull UUID userUUID;
private final Set<@NotNull String> claimedRewards; // 记录已领取的奖励ID
private final long storedSeconds; // 记录已经游玩的时间
private final long joinMillis; // 记录本次加入的时间
Set<@NotNull String> claimedRewards; //记录已领取的奖励ID public UserData(@NotNull UUID userUUID) {
this(userUUID, 0, new LinkedHashSet<>());
long storedSeconds; //记录已经游玩的时间
long joinMillis; // 记录本次加入的时间
public TimeRewardUser(UUID userUUID) {
this(userUUID, new LinkedHashSet<>(), 0);
} }
public TimeRewardUser(UUID userUUID, Set<@NotNull String> claimedRewards, public UserData(@NotNull UUID userUUID, long storedSeconds,
long storedSeconds) { Set<@NotNull String> claimedRewards) {
this(userUUID, claimedRewards, storedSeconds, System.currentTimeMillis()); this(userUUID, storedSeconds, claimedRewards, System.currentTimeMillis());
} }
public TimeRewardUser(UUID userUUID, Set<@NotNull String> claimedRewards, public UserData(@NotNull UUID userUUID, long storedSeconds,
long storedSeconds, long joinMillis) { Set<@NotNull String> claimedRewards, long joinMillis) {
this.userUUID = userUUID; this.userUUID = userUUID;
this.claimedRewards = claimedRewards;
this.storedSeconds = storedSeconds; this.storedSeconds = storedSeconds;
this.claimedRewards = claimedRewards;
this.joinMillis = joinMillis; this.joinMillis = joinMillis;
} }
public UUID getUserUUID() { public @NotNull UUID getUserUUID() {
return userUUID; return userUUID;
} }
@@ -53,7 +51,6 @@ public class TimeRewardUser {
return joinMillis; return joinMillis;
} }
/** /**
* 获取玩家本次加入服务器的时间 即为 当前时间-加入时间 * 获取玩家本次加入服务器的时间 即为 当前时间-加入时间
* *
@@ -0,0 +1,37 @@
package cc.carm.plugin.timereward.storage.database;
import cc.carm.lib.configuration.core.ConfigurationRoot;
import cc.carm.lib.configuration.core.annotation.ConfigPath;
import cc.carm.lib.configuration.core.annotation.HeaderComment;
import cc.carm.lib.configuration.core.value.ConfigValue;
import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
@HeaderComment("数据库相关设定")
@ConfigPath("storage.database")
public class DatabaseConfig extends ConfigurationRoot {
@ConfigPath("driver")
protected static final ConfigValue<String> DRIVER_NAME = ConfiguredValue.of(
String.class, "com.mysql.jdbc.Driver"
);
protected static final ConfigValue<String> HOST = ConfiguredValue.of(String.class, "127.0.0.1");
protected static final ConfigValue<Integer> PORT = ConfiguredValue.of(Integer.class, 3306);
protected static final ConfigValue<String> DATABASE = ConfiguredValue.of(String.class, "minecraft");
protected static final ConfigValue<String> USERNAME = ConfiguredValue.of(String.class, "root");
protected static final ConfigValue<String> PASSWORD = ConfiguredValue.of(String.class, "password");
protected static final ConfigValue<String> EXTRA = ConfiguredValue.of(String.class, "?useSSL=false");
@HeaderComment("插件相关表的名称")
public static final class TABLES extends ConfigurationRoot {
public static final ConfigValue<String> USER_TIMES = ConfiguredValue.of(String.class, "tr_user_times");
public static final ConfigValue<String> USER_CLAIMED = ConfiguredValue.of(String.class, "tr_user_claimed");
}
protected static String buildJDBC() {
return String.format("jdbc:mysql://%s:%s/%s%s",
HOST.getNotNull(), PORT.getNotNull(), DATABASE.getNotNull(), EXTRA.getNotNull()
);
}
}
@@ -0,0 +1,74 @@
package cc.carm.plugin.timereward.storage.database;
import cc.carm.lib.configuration.core.value.ConfigValue;
import cc.carm.lib.easysql.api.SQLManager;
import cc.carm.lib.easysql.api.SQLTable;
import cc.carm.lib.easysql.api.builder.TableCreateBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.sql.SQLException;
import java.util.function.Consumer;
public enum DatabaseTables implements SQLTable {
/**
* 用于记录用户在线时间的表
*/
USER_TIMES(DatabaseConfig.TABLES.USER_TIMES, (table) -> {
table.addColumn("uuid", "CHAR(36) NOT NULL PRIMARY KEY"); // 用户的UUID
table.addColumn("time", "INT UNSIGNED NOT NULL DEFAULT 0"); // 用户在线时间(秒)
table.addColumn("update",
"DATETIME NOT NULL " +
"DEFAULT CURRENT_TIMESTAMP " +
"ON UPDATE CURRENT_TIMESTAMP"
);
}),
/**
* 用于记录用户奖励领取情况的表
*/
USER_CLAIMED(DatabaseConfig.TABLES.USER_CLAIMED, (table) -> {
table.addAutoIncrementColumn("id", false, true); // 排序键
table.addColumn("uuid", "CHAR(36) NOT NULL PRIMARY KEY"); // 用户的UUID 主键
table.addColumn("value", "MEDIUMTEXT"); // 已领取的奖励ID
table.addColumn("update",
"DATETIME NOT NULL " +
"DEFAULT CURRENT_TIMESTAMP " +
"ON UPDATE CURRENT_TIMESTAMP"
);
});
private final Consumer<TableCreateBuilder> builder;
private final ConfigValue<String> name;
private @Nullable SQLManager manager;
DatabaseTables(ConfigValue<String> name,
Consumer<TableCreateBuilder> builder) {
this.name = name;
this.builder = builder;
}
@Override
public @Nullable SQLManager getSQLManager() {
return this.manager;
}
@Override
public @NotNull String getTableName() {
return this.name.getNotNull();
}
@Override
public boolean create(SQLManager sqlManager) throws SQLException {
if (this.manager == null) this.manager = sqlManager;
TableCreateBuilder tableBuilder = sqlManager.createTable(getTableName());
if (builder != null) builder.accept(tableBuilder);
return tableBuilder.build().executeFunction(l -> l > 0, false);
}
}
@@ -0,0 +1,118 @@
package cc.carm.plugin.timereward.storage.database;
import cc.carm.lib.easysql.EasySQL;
import cc.carm.lib.easysql.api.SQLManager;
import cc.carm.plugin.timereward.Main;
import cc.carm.plugin.timereward.storage.UserData;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.UUID;
public class MySQLStorage {
protected static final Gson GSON = new Gson();
protected static final JsonParser PARSER = new JsonParser();
private SQLManager sqlManager;
public void initialize() throws Exception {
Main.info("加载数据库配置...");
Main.getInstance().getConfigProvider().initialize(DatabaseConfig.class);
try {
Main.info("尝试连接到数据库...");
this.sqlManager = EasySQL.createManager(
DatabaseConfig.DRIVER_NAME.getNotNull(), DatabaseConfig.buildJDBC(),
DatabaseConfig.USERNAME.getNotNull(), DatabaseConfig.PASSWORD.getNotNull()
);
this.sqlManager.setDebugMode(() -> Main.getInstance().isDebugging());
} catch (Exception exception) {
throw new Exception("无法连接到数据库,请检查配置文件。", exception);
}
try {
Main.info("创建插件所需表...");
for (DatabaseTables value : DatabaseTables.values()) {
value.create(this.sqlManager);
}
} catch (SQLException exception) {
throw new Exception("无法创建插件所需的表,请检查数据库权限。", exception);
}
}
public void shutdown() {
Main.info("关闭数据库连接...");
EasySQL.shutdownManager(getSQLManager());
this.sqlManager = null;
}
public SQLManager getSQLManager() {
return sqlManager;
}
public @Nullable UserData loadData(@NotNull UUID uuid) throws Exception {
Long playTime = loadPlayTime(uuid);
Set<String> claimedData = loadClaimedData(uuid);
return new UserData(uuid, playTime, claimedData);
}
public long loadPlayTime(@NotNull UUID uuid) throws Exception {
return DatabaseTables.USER_TIMES.createQuery()
.selectColumns("uuid", "time")
.addCondition("uuid", uuid).setLimit(1).build()
.executeFunction((query) -> {
ResultSet resultSet = query.getResultSet();
if (resultSet == null || !resultSet.next()) return 0L;
return resultSet.getLong("time");
}, 0L);
}
@NotNull
public Set<String> loadClaimedData(@NotNull UUID uuid) throws Exception {
return DatabaseTables.USER_CLAIMED.createQuery()
.selectColumns("uuid", "value")
.addCondition("uuid", uuid).setLimit(1).build()
.executeFunction((query) -> {
ResultSet resultSet = query.getResultSet();
if (!resultSet.next()) return new LinkedHashSet<>();
String json = resultSet.getString("value");
if (json == null) return new LinkedHashSet<>();
JsonElement element = PARSER.parse(json);
if (!element.isJsonArray()) return new LinkedHashSet<>();
Set<String> ids = new LinkedHashSet<>();
for (JsonElement e : element.getAsJsonArray()) {
ids.add(e.getAsString());
}
return ids;
}, new LinkedHashSet<>());
}
public void saveClaimedData(@NotNull UUID uuid, @Nullable Set<String> claimedRewards) throws Exception {
if (claimedRewards != null) {
DatabaseTables.USER_CLAIMED.createReplace()
.setColumnNames("uuid", "value")
.setParams(uuid.toString(), GSON.toJson(claimedRewards))
.execute();
} else {
DatabaseTables.USER_CLAIMED.createDelete()
.addCondition("uuid", uuid).setLimit(1)
.build()
.execute();
}
}
public void savePlayTime(@NotNull UUID uuid, long time) throws Exception {
DatabaseTables.USER_TIMES.createReplace()
.setColumnNames("uuid", "time")
.setParams(uuid.toString(), time)
.execute();
}
}
@@ -0,0 +1,8 @@
package cc.carm.plugin.timereward.util;
import cc.carm.plugin.timereward.storage.database.MySQLStorage;
@FunctionalInterface
public interface DataTaskRunner {
void run(MySQLStorage mySQLStorage) throws Exception;
}
@@ -1,106 +0,0 @@
package cc.carm.plugin.timereward.util;
import org.jetbrains.annotations.Nullable;
import java.io.*;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
@SuppressWarnings("ResultOfMethodCallIgnored")
public class JarResourceUtils {
public static final char JAR_SEPARATOR = '/';
public static @Nullable String[] readResource(@Nullable InputStream resourceStream) {
if (resourceStream == null) return null;
try (Scanner scanner = new Scanner(resourceStream, StandardCharsets.UTF_8.name())) {
List<String> contents = new ArrayList<>();
while (scanner.hasNextLine()) {
contents.add(scanner.nextLine());
}
return contents.toArray(new String[0]);
} catch (Exception e) {
return null;
}
}
public static void copyFolderFromJar(String folderName, File destFolder, CopyOption option)
throws IOException {
copyFolderFromJar(folderName, destFolder, option, null);
}
public static void copyFolderFromJar(String folderName, File destFolder,
CopyOption option, PathTrimmer trimmer) throws IOException {
if (!destFolder.exists())
destFolder.mkdirs();
byte[] buffer = new byte[1024];
File fullPath;
String path = JarResourceUtils.class.getProtectionDomain().getCodeSource().getLocation().getPath();
if (trimmer != null)
path = trimmer.trim(path);
try {
if (!path.startsWith("file"))
path = "file://" + path;
fullPath = new File(new URI(path));
} catch (URISyntaxException e) {
e.printStackTrace();
return;
}
ZipInputStream zis = new ZipInputStream(new FileInputStream(fullPath));
ZipEntry entry;
while ((entry = zis.getNextEntry()) != null) {
if (!entry.getName().startsWith(folderName + JAR_SEPARATOR))
continue;
String fileName = entry.getName();
if (fileName.charAt(fileName.length() - 1) == JAR_SEPARATOR) {
File file = new File(destFolder + File.separator + fileName);
if (file.isFile()) {
file.delete();
}
file.mkdirs();
continue;
}
File file = new File(destFolder + File.separator + fileName);
if (option == CopyOption.COPY_IF_NOT_EXIST && file.exists())
continue;
if (!file.getParentFile().exists())
file.getParentFile().mkdirs();
if (!file.exists())
file.createNewFile();
FileOutputStream fos = new FileOutputStream(file);
int len;
while ((len = zis.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
fos.close();
}
zis.closeEntry();
zis.close();
}
public enum CopyOption {
COPY_IF_NOT_EXIST, REPLACE_IF_EXIST
}
@FunctionalInterface
public interface PathTrimmer {
String trim(String original);
}
}
+5 -6
View File
@@ -1,6 +1,5 @@
&e _____ _ &6______ _ &e _______ &6 ____ __
&e|_ _(_) &6| ___ \ | | &e /_ __(_)___ ___ ___ &6 / __ \___ _ ______ __________/ /
&e | | _ _ __ ___ ___&6| |_/ /_____ ____ _ _ __ __| | &e / / / / __ `__ \/ _ \&6/ /_/ / _ \ | /| / / __ `/ ___/ __ /
&e | | | | '_ ` _ \ / _ \&6 // _ \ \ /\ / / _` | '__/ _` | &e / / / / / / / / / __&6/ _, _/ __/ |/ |/ / /_/ / / / /_/ /
&e | | | | | | | | | __/&6 |\ \ __/\ V V / (_| | | | (_| | &e/_/ /_/_/ /_/ /_/\___/&6_/ |_|\___/|__/|__/\__,_/_/ \__,_/
&e \_/ |_|_| |_| |_|\___\&6_| \_\___| \_/\_/ \__,_|_| \__,_|
-57
View File
@@ -1,57 +0,0 @@
# ${project.name} - ${project.description}
# 项目地址: ${project.url}
# 下载地址: ${project.distributionManagement.downloadUrl}
version: ${project.version}
debug: false
# 统计数据设定
# 该选项用于帮助开发者统计插件版本与使用情况,且绝不会影响性能与使用体验。
# 当然,您也可以选择在这里关闭,或在plugins/bStats下的配置文件中关闭。
metrics: true
# 检查更新设定
# 该选项用于插件判断是否要检查更新,若您不希望插件检查更新并提示您,可以选择关闭。
# 检查更新为异步操作,绝不会影响性能与使用体验。
check-update: true
database:
# 数据库驱动路径,默认为 MySQL
driver: "com.mysql.cj.jdbc.Driver"
# 数据库连接配置
host: "127.0.0.1"
port: 3306
database: "minecraft"
username: "username"
password: "password"
additional: "?useSSL=false"
# 插件相关表的名称
tables:
claimed: "tr_user_claimed" # 用于记录用户奖励领取情况的表
time: "tr_user_times" # 用于记录用户在线时间的表
# 奖励相关配置
rewards:
# 配置键名即奖励ID,支持英文、数字与下划线。
# 确定后请不要更改,因为该键值用于存储玩家是否领取的数据
# 如果更改,原先领取过该奖励的玩家将会自动再领取一次!
"example":
# 奖励的显示名称,可以是任意字符串
# 可以在commands 中使用 %(name) 来获取该奖励的名称
# 也可以使用变量 %TimeReward_reward_<奖励ID>% 来获取对应奖励的名称
name: "&f[初级奖励] &e总在线时长 2小时"
# 该奖励自动领取需要的在线时长,单位为秒
time: 7200
# 该奖励领取权限,可以不设置。
# 若为空则所有人都可以领取;若不为空,则需要拥有该权限的玩家才能领取。
permission: "servername.vip"
# 领取奖励时后台执行的指令
# 支持PlaceholderAPI变量,指令中可以使用 %(name) 来获取该奖励的名称
commands:
- "say &f恭喜 &b%player_name% &f领取了奖励 &r%(name) &f "
-5
View File
@@ -1,5 +0,0 @@
# ${project.name} - ${project.description}
# 项目地址: ${project.url}
# 下载地址: ${project.distributionManagement.downloadUrl}
version: ${project.version}
+9 -11
View File
@@ -1,26 +1,24 @@
main: cc.carm.plugin.timereward.Main main: cc.carm.plugin.timereward.Main
name: TimeReward name: TimeReward
version: ${project.version} version: ${project.version}
description: ${project.description} author: CarmJos
website: ${project.url} website: ${project.url}
description: ${project.description}
authors: api-version: 1.13
- CarmJos
softdepend: softdepend:
- PlaceholderAPI - PlaceholderAPI
api-version: 1.13 permissions:
"TimeReward.admin":
description: "在线自动领奖的管理员权限。"
default: op
commands: commands:
"TimeReward": "TimeReward":
permission: "TimeReward.admin" permission: "TimeReward.admin"
description: "在线自动领奖的基础指令。" description: "在线自动领奖的基础指令。"
usage: "/TimeReward help" usage: "/TimeReward help"
aliases:
permissions: - tr
"TimeReward.admin":
description: "在线自动领奖的管理员权限。"
default: op