0

57 Commits
v1.6 ... dev/ci

Author SHA1 Message Date
2b055062a3 GitLab CI: publish by job 2021-10-21 22:24:23 +03:00
f923f47765 GitLab CI: manual publish 2021-10-21 18:33:16 +03:00
86a1c3ab9c GitLab CI 2021-10-10 14:26:44 +03:00
4ba35bd89d update version 2021-02-04 11:55:41 +03:00
368eab1227 Merge branch 'develop' 2021-02-04 11:54:44 +03:00
e8f8476c5a Merge branch 'feature/messages' into develop 2021-02-04 11:54:23 +03:00
b38b619459 форматирование обычных сообщений через Messages 2021-02-04 11:53:52 +03:00
c48b75e6ed update version 2021-02-04 11:37:10 +03:00
8e51f25c82 Merge branch 'develop' 2021-02-04 11:35:33 +03:00
5482311f48 Merge branch 'feature/messages' into develop 2021-02-04 11:34:44 +03:00
8478ba7281 Messages на замену I18n 2021-02-04 11:34:14 +03:00
b02fbb02f1 I18n признан deprecated 2021-02-04 11:33:39 +03:00
74136f3217 code style 2021-01-08 21:05:39 +03:00
b9f22a427e code style: зачистка от излишних SuppressWarnings 2021-01-08 21:05:15 +03:00
36fc374356 code style: tabs -> spaces 2021-01-08 21:00:00 +03:00
0b74f104f2 update version 2021-01-08 17:07:15 +03:00
6e54a16067 Merge branch 'develop' 2021-01-08 17:05:46 +03:00
16ae1743c7 update README.MD 2021-01-08 17:05:34 +03:00
8afba72b77 Merge branch 'feature/textured-skull' into develop 2021-01-08 16:54:32 +03:00
002dae285c добавлен метод установки текстурированной головы игрока (skull) 2021-01-08 16:54:07 +03:00
c0f02d20d5 добавлен метод копирования Location 2021-01-08 16:06:48 +03:00
d34e418dcc update version 2021-01-05 19:04:28 +03:00
bcca590741 Merge branch 'develop' 2021-01-05 19:03:32 +03:00
c47bb2093e удалена ненужная зависимость 2021-01-05 19:03:21 +03:00
64c4f20d97 Merge branch 'dev/docs' into develop 2021-01-05 18:59:24 +03:00
89bca95d9f update README.MD 2021-01-05 18:22:31 +03:00
897045b8d2 fix README.MD 2021-01-05 18:20:09 +03:00
0a648b7a5d fix README.MD 2021-01-05 18:18:29 +03:00
b1615e258e update README.MD 2021-01-05 18:17:27 +03:00
1e529d9d55 update README.MD 2021-01-05 17:40:43 +03:00
9929b0af18 fix README.MD 2021-01-05 17:29:36 +03:00
d63b9a085c update README.MD 2021-01-05 17:28:51 +03:00
8e20d31227 update README.MD 2021-01-05 17:13:15 +03:00
1c1075e2dc add README.MD 2021-01-04 02:17:44 +03:00
9d65461f1d Merge branch 'feature/jdbctemplate' into develop 2021-01-03 16:15:44 +03:00
3037aed8ef убран лишний код 2021-01-03 16:09:24 +03:00
f821691308 JdbcTemplate: add queryOne method 2021-01-03 16:07:40 +03:00
c963c4bd60 JdbcTemplate: refactoring 2021-01-03 16:00:34 +03:00
2fc1bf36c1 update version 2021-01-03 00:24:06 +03:00
eb5396b891 Merge branch 'develop' 2021-01-03 00:23:40 +03:00
5315a4ad94 Merge branch 'feature/scheduler' into develop 2021-01-03 00:23:17 +03:00
bd91b19114 ScheduleManager: отложенное выполнение задач 2021-01-03 00:22:55 +03:00
e36d0fd75d Merge branch 'dev/refactory' into develop 2021-01-03 00:02:15 +03:00
f9f6fbc541 Merge branch 'feature/jdbctemplate' into develop 2021-01-03 00:01:39 +03:00
395b0a015f add tests for JdbcTemplate 2021-01-03 00:00:29 +03:00
c0c1ede462 add JdbcTemplate
like Spring Data
2021-01-02 20:27:11 +03:00
e12d005a25 update version 2021-01-02 14:39:35 +03:00
6e50fc278e Merge branch 'develop' 2021-01-02 14:39:18 +03:00
5f2e208453 Merge branch 'feature/scheduler' into develop 2021-01-02 14:39:05 +03:00
b3aec1716a add ScheduleTask 2021-01-02 14:38:41 +03:00
c20df9af24 ScheduleManager: move to another package 2021-01-02 14:26:54 +03:00
0165a7d424 move AssetsManager to another package 2021-01-02 03:01:28 +03:00
c8866af418 update version 2021-01-02 02:52:42 +03:00
359dbba09a Merge branch 'develop' 2021-01-02 02:52:19 +03:00
c513d6990a Merge branch 'feature/effects' into develop 2021-01-02 02:51:45 +03:00
6155bb0d42 EffectsHelper: add spawn particle 2021-01-02 02:51:07 +03:00
5514753f31 add EffectsHelper 2021-01-02 02:46:38 +03:00
32 changed files with 2330 additions and 580 deletions

11
.gitlab-ci.yml Normal file
View File

@@ -0,0 +1,11 @@
image: gradle:6.7.0-jdk8
variables:
GRADLE_OPTS: "-Dorg.gradle.daemon=false"
before_script:
- export GRADLE_USER_HOME=`pwd`/.gradle
build:
stage: build
only:
- dev/ci
script: gradle --console=plain publish

698
README.MD Normal file
View File

@@ -0,0 +1,698 @@
# GHAST TOOLS
![version: 1.12.1](https://img.shields.io/badge/version-1.12.1-0a0.svg?style=flat)
![bukkit-api: 1.12](https://img.shields.io/badge/bukkit--api-1.12-d50.svg?style=flat)
Набор вспомогательных инструментов для Bukkit API.
_Основан на версии Bukkit API 1.12._
## Содержание
1. [Перед использованием](#перед-использованием)
2. [GhastTools](#ghasttools)
3. [AssetsManager](#assetsmanager)
4. [BuildHelper](#buildhelper)
5. [CommandManager](#commandmanager)
6. [EffectsHelper](#effectshelper)
7. [EventContext](#eventcontext)
8. [JdbcTemplate](#jdbctemplate)
9. [ScheduleManager](#schedulemanager)
10. [ScheduleTask](#scheduletask)
11. [Messages](#messages)
12. [XLog](#xlog)
13. [Подключение](#подключение)
1. [Gradle](#gradle)
2. [Maven](#maven)
---
## Перед использованием
Перед началом использования, необходимо в вашем Bukkit-плагине прописать подобный код:
```java
void onLoad() {
GhastTools.setPlugin(this);
}
```
Это необходимо сделать, т.к. весь инструментарий основан на статических (static) методах.
Все методы данного набора инструментов объеденены в классы, выполняющие роль группировщиков.
## GhastTools
Методы общего назначения или без определённой группировки.
### loadConfig
Загрузка файла настроек плагина - `config.yml`.
```java
YamlConfiguration config = GhastTools.loadConfig();
```
По-умолчанию "гаст" пытается файл найти в папке плагина - `getDataFolder()`.
Если файла там нет, то выгружает встроенный (имеющийся в `.jar` файле плагина) в эту папку и загружает его.
```java
YamlConfiguration config = GhastTools.loadConfig(false);
```
Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина,
будет загруден исключительно встроенный файл настроек.
### copyLocation
Копирования объекта `Location`
```java
Location location = ...;
Location copyLoc = GhastTools.copyLocation(location);
```
## AssetsManager
Методы по работе с файлами плагина (_"ассетами"_).
У каждой группы методов один и тот же набор входных параметров:
- `resourceName` - наименование и путь к файлу в папке плагина
- `defaultResourceName` - наименование и путь к файлу в плагине.
_Опционально. По-умолчанию равнен `resourceName`_
- `saveDefault` - необходимость скопировать содержимое файла из `defaultResourceName` в файл `resourceName`.
_Опционально. По-умолчанию равен `true`_
Правила поиска файлов так же одинаков для каждой группы:
- В начале файл ищется в папке плагина
- Если файл отсутствует в папке плагина, то...
- если `defaultResourceName` не равен `null`...
- если `saveDefault` равен `true`, то файл из плагина будет выгружен в папку плагина и от туда загружен в память.
- если `saveDefault` равен `false`, то данные будут взяты из файлв в плагине.
- если `defaultResourceName` равен `null`, то будет брошено исключение `AssetsException` с описанием ошибки вида "Файл X не найден".
### getAsInputStream
```java
InputStream inputStream = AssetsManager.getAsInputStream("translate.ru.yml", "translate.yml", false);
```
### getAsReader
```java
Reader reader = AssetsManager.getAsReader("translate.ru.yml", "translate.yml", false);
```
### getAsString
```java
String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCharsets.UTF_8, false);
```
У этой группы есть дополнительный _опциональный_ параметр - `charset` - в котором указывается кодиривка получаемой строки.
о-умолчанию равен `StandardCharsets.UTF_8`_
## BuildHelper
Набор методов облегчающих размецение объектов на карте.
### placeSkull
Установка черепа.
```java
Location location = ...;
Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH);
skull.update(true); // иначе изменения на карте не применятся и череп будет висеть в воздухе
```
### placePlayerHead
Установка головы игрока.
```java
Location location = ...;
Skull playerHead = BuildHelper.placePlayerHead(location, BlockFace.NORTH);
playerHead.update(true); // иначе изменения на карте не применятся и голова будет висеть в воздухе
```
Если третьим параметром передать URL текстуры, то голова будет текстурирована.
```java
Location location = ...;
BuildHelper.placePlayerHead(location, BlockFace.NORTH, "http://...");
```
### setPlayerHeadSkin
Установка текстуры для головы игрока.
```java
Location location = ...;
Skull playerHead = BuildHelper.placePlayerHead(location, BlockFace.NORTH);
playerHead.update(true); // иначе изменения на карте не применятся и голова будет висеть в воздухе
setPlayerHeadSkin(playerHead);
```
Порядок выполнения методов в приведённом выше примере **важен**. Если `playerHead.update(true)` вызвать после
установки текстуры, она собъётся на стандартную.
### placeSignWall
```java
Location location = ...;
Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH)
```
## CommandManager
Регистрация команд.
Имеется два варианта использования: упрощённый
```java
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
```
и подробный:
```java
CommandManager.create("start")
.useOnlyPlayer()
.executer((sender, args) -> sender.sendMessage("hello!"))
.register();
```
### register
Упрощенная регистрация команды. Указывается лишь название команды и исполнитель.
```java
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
```
### create
Конструктор для подробного варианта регистрации команды.
```java
CommandManager.Builder builder = CommandManager.create("start");
```
### executer
Указание исполнителя для команды
```java
CommandManager.Builder builder = CommandManager.create("start")
.executer((sender, args) -> sender.sendMessage("hello!"));
```
### onError
Обработчик исключений
```java
CommandManager.Builder builder = CommandManager.create("start")
.onError((sender, commandName, args, exception) -> {
sender.sendMessage(ChatColor.RED + "Произошла ошибка при выполнении команды '" + commandName + "'.");
exception.printStackTrace();
});
```
### useOnlyPlayer
Указание, что данную команду могут использовать только Игроки.
Опционально можно указать сообщение, которое будет выводиться в консоль.
_Отменяет действие указателя `useOnlyConsole`_
```java
CommandManager.Builder builder = CommandManager.create("start")
.useOnlyPlayer("Команду могут использовать только игроки");
```
### useOnlyConsole
Указание, что данную команду можно использовать только в консоле.
Опционально можно указать сообщение, которое будет выводиться Игроку.
_Отменяет действие указателя `useOnlyPlayer`_
```java
CommandManager.Builder builder = CommandManager.create("start")
.useOnlyConsole(ChatColor.RED + "Команду можно использовать только в консоли");
```
### register
Регистрация описанной в Конструкторе команды.
```java
CommandManager.create("start")
.useOnlyPlayer()
.executer((sender, args) -> sender.sendMessage("hello!"))
.register();
```
## EffectsHelper
Набор методов для работы с эффектами.
### playSound
Воспроизвести звук.
```java
Location location = ...;
EffectsHelper.playSound(location, Sound.AMBIENT_CAVE, 1.0f);
```
### particle
Создание частиц.
```java
Location location = ...;
EffectsHelper.particle(location, Particle.REDSTONE, 1.0d, 1.0d, 1.0d, 1.0d, 5);
```
## EventContext
Регистрация группы обработчиков событий, объединённых общим условием выполнения.
```java
EventContext.create()
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
.onEvent(PlayerJoinEvent.class, event -> { event.getPlayer().kickPlayer("Max players"); });
```
### create
Создание контекста событий.
```java
EventContext eventContext = EventContext.create();
```
### filter
Условие, при котором будут срабатывать обработчики событий в данном контексте.
```java
EventContext.create()
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
```
### onEvent
Указание события и его обработчика.
_Обработчик события регистрируется сразу же._
```java
EventContext.create()
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
.onEvent(PlayerJoinEvent.class, event -> event.getPlayer().kickPlayer("Max players"));
```
### cancelEvent
Отменить событие.
_Обработчик события регистрируется сразу же._
```java
EventContext.create()
.cancelEvent(BlockPlaceEvent.class);
```
эквивалентен коду:
```java
EventContext.create()
.onEvent(BlockPlaceEvent.class, event -> event.setCancelled(true))
```
## JdbcTemplate
Инструмент для упрощения работы с SQL базами данных, работающими через JDBC.
Для начала потребуется создать объект `DataSource`
```java
// На примере MySQL
MysqlDataSource dataSource = new MysqlDataSource();
dataSource.setServerName("localhost");
dataSource.setPort(3306);
dataSource.setCharacterEncoding(StandardCharsets.UTF_8.name());
dataSource.setDatabaseName("MyDataBase");
dataSource.setUser("root");
dataSource.setPassword("secret");
```
После чего создать `JdbcTemplate`
```java
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
```
### execute
Выполнение SQL запроса без последующей обработки результатов выполнения.
```java
jdbcTemplate.execute("CREATE TABLE my_table (id int, name varchar(16));");
```
### query
Выполнение SQL запроса и обработка его результатов.
Может возвращать любой тип объектов.
```java
String name = jdbcTemplate.query("SELECT name FROM my_table LIMIT 0,1", resultSet -> {
if (resultSet.next()) {
return resultSet.getString("name");
} else {
return null;
}
});
```
```java
List<String> names = jdbcTemplate.query("SELECT name FROM my_table", resultSet -> {
if (resultSet.next()) {
List<String> list = new ArrayList<>();
do {
list.add(resultSet.getString("name"));
} while (resultSet.next());
return list;
} else {
return Collections.emptyList();
}
});
```
### queryOne
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
Возвращает `Optional`.
```java
Optional<String> optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name"));
```
### queryList
Выполнение SQL запроса и обработка результата как списка данных.
Возвращает `List`.
```java
List<String> names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name"));
```
### queryForMap
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
Возвращает `Map<String, Object>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
```java
Map<String, Object> map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;");
```
### queryForMapList
Выполнение SQL запроса и обработка результата как списка данных.
Возвращает `List<Map<String, Object>>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
```java
List<Map<String, Object>> mapList = jdbcTemplate.queryForMapList("SELECT * FROM my_table");
```
### update
Выполнение SQL запроса где будет происходить обновление данных в таблице.
Под "обновлением" подразумеваются любые изменения в таблице: `UPDATE`, `DELETE`, `INSERT`.
Возвращает число строк, которые были _по факту обновлены_ в таблице.
```java
int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx';");
```
## ScheduleManager
Набор методов для создания параллельных задач, выполняющихся один раз или по рассписанию.
### createTask
Создание конструктора задачи.
```java
ScheduleManager.Builder builder = ScheduleManager.createTask();
```
### useBukkitScheduler
Если задача будет взаимодействоватьс **Bukkit API** или необходима привязка задачи к _тикам_,
то необходимо использовать данный указатель.
В ином случае, указатель не нужен.
```java
ScheduleManager.Builder builder = ScheduleManager.createTask()
.useBukkitScheduler();
```
### after
Указание, что задачу нужно выполнить не сразу, а с некоторой задержкой перед запуском.
```java
ScheduleManager.Builder builder = ScheduleManager.createTask()
.after(5, TimeUnit.MINUTES);
```
### every
Указание, что задачу нужно повторять через указанное время.
```java
ScheduleManager.Builder builder = ScheduleManager.createTask()
.every(5, TimeUnit.MINUTES);
```
### create
Создание описанной задачи.
```java
ScheduleTask scheduleTask = ScheduleManager.createTask()
.every(1, TimeUnit.SECONDS)
.create(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
```
_Задача будет только создана. Для её выполнения нужно вызвать `scheduleTask.start()`._
### execute
Создание и выполнение описанной задачи.
```java
ScheduleTask scheduleTask = ScheduleManager.createTask()
.every(1, TimeUnit.SECONDS)
.execute(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
```
## ScheduleTask
Вспомогательный объект, созданный через `ScheduleManager`. Позволяет управлять созданной задачей.
### start
Запускает задачу, если она еще не запущена.
```java
ScheduleTask scheduleTask = ...;
scheduleTask.start();
```
### isCanceled
Возвращает состояние задачи. Если `true`, значит задача была или _отменена/остоновлена_ или была завершена.
```java
ScheduleTask scheduleTask = ...;
boolean status = scheduleTask.isCanceled();
```
### cancel
Отменяет/Остонавливает выполнение задачи.
```java
ScheduleTask scheduleTask = ...;
scheduleTask.cancel();
```
## Messages
Инструмент для работы с параметизированными сообщениями или просто сообщениями, которые храняться в отдельном файле.
Параметизированные сообщения имеют следующий вид: `Привет, {player}!`.
### load
Загрузка сообщений в инструмент.
Есть три варианта: через `Properties`
```java
Properties properties = ...;
Messages.load(properties);
```
через `Map<String, String>`
```java
Map<String, String> map = ...;
Messages.load(map);
```
через `Reader`
```java
Reader reader = ...;
Messages.load(reader);
```
Следует учесть, про при работе через `Reader`, **Messages** ожидает там обнаружить список строк в формате `key=value`.
### get
Получение обычноего или параметизированного сообщения.
Для примера, пусть у нас будут такие сообщения:
```properties
simple=Простое сообщение
welcome=Приветствуем, {player}!
```
Для получения простого сообщения, просто указываем его ключ:
```java
String message = Messages.get("simple");
// Простое сообщение
```
Для получения параметизированного сообщения, нужно помимо ключа передать параметры.
Есть два способа: через `Map<String, Object>`
```java
Map<String, Object> = map = new HashMap<>(1);
map.put("player", "David");
String message = Messages.get("welcome", map);
// Приветствуем, David!
```
через попарное перечисление параметров
```java
String message = Messages.get("welcome", "player", "David");
// Приветствуем, David!
```
Если по указанному ключу сообщение отсутствует, то **Messages** вернёт значение самого ключа
```java
String message = Messages.get("not_exists_key");
// not_exists_key
message = Messages.get("not_exists_key", "player", "David");
// not_exists_key
```
Если параметр, который указан в шаблоне не был указан/определён, то параметр останется как есть
```java
String message = Messages.get("welcome");
// Приветствуем, {player}!
message = Messages.get("welcome", "unknown_param_key", 123);
// Приветствуем, {player}!
```
### format
**Messages** можно использовать и просто для форматирования параметизированных шаблонов:
```java
Map<String, Object> = map = new HashMap<>(1);
map.put("player", "David");
String message = Messages.format("Приветствуем, {player}!", map);
// Приветствуем, David!
```
```java
String message = Messages.foramt("Приветствуем, {player}!", "player", "David");
// Приветствуем, David!
```
## XLog
Замена стандартному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования.
Имеет 4 уровня логирования: `debug`, `info`, `warning`, `error`.
Сообщения могут быть шаблонизированными. Синтаксис шаблонов — `java.text.MessageFormat`.
Примеры:
```java
XLog.info("Hello");
XLog.info("Player {0} join game", event.getPlayer().getName());
XLog.error("ERROR!", exception);
XLog.error("ERROR: {0}", exception.getMessage());
// Для экранирования "{" нужно перед ней поставить "'".
// А для использования "'" нужно их дублировать.
XLog.error("ERROR ''{0}'' in Event '{{1}'}: {2}", exception.getClass(), event.getClass(), exception.getMessage());
XLog.error("ERROR: {0}", exception.getMessage(), exception);
```
---
## Подключение
### Gradle
```groovy
repositories {
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
}
```
```groovy
implementation group: 'ghast', name: 'ghast-tools', version: '1.12.1'
```
### Maven
```xml
<repositories>
<repository>
<id>dmx-mc-project</id>
<url>https://dmx-mc-project.gitlab.io/maven-repository/</url>
</repository>
</repositories>
```
```xml
<dependencies>
<dependency>
<groupId>ghast</groupId>
<artifactId>ghast-tools</artifactId>
<version>1.12.1</version>
</dependency>
</dependencies>
```

View File

@@ -1,10 +1,7 @@
//file:noinspection GroovyAssignabilityCheck
plugins { plugins {
id 'java' id 'java'
} id 'maven-publish'
def publishScript = file(rootProject.getProjectDir().getPath() + '/publish.gradle')
if (publishScript.exists()) {
apply from: publishScript.path
} }
project.group = projectGroup project.group = projectGroup
@@ -15,9 +12,12 @@ repositories {
mavenCentral() mavenCentral()
maven { url 'https://hub.spigotmc.org/nexus/content/groups/public' } maven { url 'https://hub.spigotmc.org/nexus/content/groups/public' }
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' } maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
maven { url "https://gitlab.com/api/v4/projects/${project.property('gitlab.projectid')}/packages/maven" }
} }
ext { ext {
junitVersion = '5.5.2'
libs = [ libs = [
bukkit: [lib: 'org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT', exclude: [ bukkit: [lib: 'org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT', exclude: [
'com.google.code.gson:gson', 'com.google.code.gson:gson',
@@ -27,7 +27,16 @@ ext {
]], ]],
commons_text: 'org.apache.commons:commons-text:1.9', commons_text: 'org.apache.commons:commons-text:1.9',
lombok: 'org.projectlombok:lombok:1.18.12', lombok: 'org.projectlombok:lombok:1.18.12',
reflection_object: 'ru.dmitriymx:reflection-object:1.0-BETA' reflection_object: 'ru.dmitriymx:reflection-object:1.2',
test: [
junit5: [
"org.junit.jupiter:junit-jupiter-api:$junitVersion",
"org.junit.jupiter:junit-jupiter-engine:$junitVersion"
],
mock: ['org.mockito:mockito-core:1.10.19'],
h2db: 'com.h2database:h2:1.4.200'
]
] ]
} }
@@ -40,6 +49,15 @@ def compileOnly2(library) {
} }
} }
def testImplementation2(library) {
dependencies.testImplementation library.lib, {
library.exclude.each { String excludeLibStr ->
String[] excludeLib = excludeLibStr.split(':')
exclude group: excludeLib[0], module: excludeLib[1]
}
}
}
dependencies { dependencies {
compileOnly libs.lombok compileOnly libs.lombok
annotationProcessor libs.lombok annotationProcessor libs.lombok
@@ -47,4 +65,38 @@ dependencies {
compileOnly2 libs.bukkit compileOnly2 libs.bukkit
implementation libs.commons_text implementation libs.commons_text
implementation libs.reflection_object implementation libs.reflection_object
}
testImplementation libs.test.junit5
testImplementation libs.test.mock
testImplementation2 libs.bukkit
testImplementation libs.test.h2db
}
test {
useJUnitPlatform()
}
publishing {
publications {
mavenBinary(MavenPublication) {
groupId = project.property('projectGroup')
artifactId = project.property('projectName')
version = project.property('projectVersion')
from components.java
}
}
repositories {
maven {
url "https://gitlab.com/api/v4/projects/${project.property('gitlab.projectid')}/packages/maven"
credentials(HttpHeaderCredentials) {
name = 'Job-Token'
value = System.getenv('CI_JOB_TOKEN')
}
authentication {
header(HttpHeaderAuthentication)
}
}
}
}

View File

@@ -1,3 +1,5 @@
projectGroup=ghast projectGroup=ghast
projectName=ghast-tools projectName=ghast-tools
projectVersion=1.6 projectVersion=1.12.1
gitlab.projectid=23328133

View File

@@ -1,2 +1 @@
rootProject.name = projectName rootProject.name=projectName

View File

@@ -1,13 +0,0 @@
package ghast;
public class AssetsException extends RuntimeException {
public AssetsException(String message) {
super(message);
}
public AssetsException(String message, Throwable cause) {
super(message, cause);
}
}

View File

@@ -1,162 +0,0 @@
package ghast;
import lombok.experimental.UtilityClass;
import org.bukkit.plugin.Plugin;
import java.io.*;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Scanner;
import static java.text.MessageFormat.format;
@UtilityClass
@SuppressWarnings("unused")
public class AssetsManager {
private static final String ERROR_NOT_FOUND = "Asset \"{0}\" not found";
private static final String ERROR_OPEN = "Error open asset \"{0}\": {1}";
//region getAsInputStream methods
public InputStream getAsInputStream(String resourceName, String defaultResourceName, boolean saveDefault) {
Plugin plugin = GhastTools.getPlugin();
InputStream inputStream;
Path pathToResource = plugin.getDataFolder().toPath().resolve(resourceName);
if (Files.exists(pathToResource)) {
inputStream = openResource(pathToResource);
} else if (defaultResourceName != null) {
URL resourceUrl = getResourceUrl(defaultResourceName);
if (saveDefault) {
doSaveTo(resourceUrl, pathToResource);
inputStream = openResource(pathToResource);
} else {
inputStream = openResource(resourceUrl);
}
} else {
throw new AssetsException(format(ERROR_NOT_FOUND, resourceName));
}
return inputStream;
}
public InputStream getAsInputStream(String resourceName, String defaultResourceName) {
return getAsInputStream(resourceName, defaultResourceName, true);
}
public InputStream getAsInputStream(String resourceName, boolean saveDefault) {
return getAsInputStream(resourceName, resourceName, saveDefault);
}
public InputStream getAsInputStream(String resourceName) {
return getAsInputStream(resourceName, resourceName, true);
}
//endregion
//region getAsReader methods
public Reader getAsReader(String resourceName, String defaultResourceName, boolean saveDefault) {
return new InputStreamReader(getAsInputStream(resourceName, defaultResourceName, saveDefault));
}
public Reader getAsReader(String resourceName, String defaultResourceName) {
return new InputStreamReader(getAsInputStream(resourceName, defaultResourceName, true));
}
public Reader getAsReader(String resourceName, boolean saveDefault) {
return new InputStreamReader(getAsInputStream(resourceName, resourceName, saveDefault));
}
public Reader getAsReader(String resourceName) {
return new InputStreamReader(getAsInputStream(resourceName, resourceName, true));
}
//endregion
//region getAsString methods
public String getAsString(String resourceName, String defaultResourceName, Charset charset, boolean saveDefault) {
try (InputStream inputStream = getAsInputStream(resourceName, defaultResourceName, saveDefault);
Scanner scanner = new Scanner(inputStream, charset.name()).useDelimiter("\\A")) {
return scanner.next();
} catch (IOException e) {
throw new AssetsException(format(ERROR_OPEN, resourceName, e.getMessage()), e);
}
}
public String getAsString(String resourceName, String defaultResourceName, Charset charset) {
return getAsString(resourceName, defaultResourceName, charset, true);
}
public String getAsString(String resourceName, String defaultResourceName, boolean saveDefault) {
return getAsString(resourceName, defaultResourceName, StandardCharsets.UTF_8, saveDefault);
}
public String getAsString(String resourceName, String defaultResourceName) {
return getAsString(resourceName, defaultResourceName, StandardCharsets.UTF_8, true);
}
public String getAsString(String resourceName, Charset charset, boolean saveDefault) {
return getAsString(resourceName, resourceName, charset, saveDefault);
}
public String getAsString(String resourceName, Charset charset) {
return getAsString(resourceName, resourceName, charset, true);
}
public String getAsString(String resourceName, boolean saveDefault) {
return getAsString(resourceName, resourceName, StandardCharsets.UTF_8, saveDefault);
}
public String getAsString(String resourceName) {
return getAsString(resourceName, resourceName, StandardCharsets.UTF_8, true);
}
//endregion
private URL getResourceUrl(String resourceName) {
URL resourceUrl = AssetsManager.class.getClassLoader().getResource(resourceName);
if (resourceUrl == null) {
throw new AssetsException(format(ERROR_NOT_FOUND, resourceName));
}
return resourceUrl;
}
private void doSaveTo(URL resourceUrl, Path saveToPath) {
try {
Files.createDirectories(saveToPath.getParent());
try (InputStream inputStream = resourceUrl.openStream();
OutputStream outputStream = Files.newOutputStream(saveToPath)) {
byte[] buffer = new byte[8192];
int count;
while ((count = inputStream.read(buffer)) != -1) {
outputStream.write(buffer, 0, count);
}
outputStream.flush();
}
} catch (IOException e) {
throw new AssetsException(format("Error save asset \"{0}\" to \"{1}\": {2}",
resourceUrl, saveToPath, e.getMessage()), e);
}
}
private InputStream openResource(Path pathToResource) {
try {
return Files.newInputStream(pathToResource);
} catch (IOException e) {
throw new AssetsException(format(ERROR_OPEN, pathToResource, e.getMessage()), e);
}
}
private InputStream openResource(URL resourceUrl) {
try {
return resourceUrl.openStream();
} catch (IOException e) {
throw new AssetsException(format(ERROR_OPEN, resourceUrl, e.getMessage()), e);
}
}
}

View File

@@ -3,34 +3,145 @@ package ghast;
import lombok.experimental.UtilityClass; import lombok.experimental.UtilityClass;
import org.bukkit.Location; import org.bukkit.Location;
import org.bukkit.Material; import org.bukkit.Material;
import org.bukkit.SkullType;
import org.bukkit.block.Block; import org.bukkit.block.Block;
import org.bukkit.block.BlockFace; import org.bukkit.block.BlockFace;
import org.bukkit.block.Sign; import org.bukkit.block.Sign;
import org.bukkit.block.Skull; import org.bukkit.block.Skull;
import ru.dmitriymx.reflection.ReflectionClass;
import ru.dmitriymx.reflection.ReflectionObject;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.UUID;
@UtilityClass @UtilityClass
@SuppressWarnings("unused") @SuppressWarnings("unused")
public class BuildHelper { public class BuildHelper {
public Skull placeSkull(Location location, BlockFace face) { private final Class<?> CLASS_BLOCKPOSITION = getClassForName("net.minecraft.server.v1_12_R1.BlockPosition");
Block block = location.getWorld().getBlockAt(location); private final Class<?> CLASS_GAMEPROFILE = getClassForName("com.mojang.authlib.GameProfile");
block.setType(Material.SKULL);
Skull skull = (Skull) block.getState();
skull.setRotation(face);
org.bukkit.material.Skull skullMaterial = (org.bukkit.material.Skull) skull.getData();
skullMaterial.setFacingDirection(BlockFace.SELF);
return skull; /**
} * Установка черепа.
* <p>
* После установки, необходимо выполнить <code>skull.update(true);</code>
*
* @param location место установки.
* @param face куда будет повёрнут череп.
* @return Блок типа {@link Skull}
*/
public Skull placeSkull(Location location, BlockFace face) {
Location fixedLocation = GhastTools.copyLocation(location);
fixedLocation.setZ(fixedLocation.getZ() - 1);
public Sign placeSignWall(Location location, BlockFace face) { Block block = location.getWorld().getBlockAt(location);
Block block = location.getWorld().getBlockAt(location); block.setType(Material.SKULL);
block.setType(Material.WALL_SIGN);
Sign sign = (Sign) block.getState(); Skull skull = (Skull) block.getState();
org.bukkit.material.Sign signMaterial = (org.bukkit.material.Sign) sign.getData(); skull.setRotation(face);
signMaterial.setFacingDirection(face);
return sign; org.bukkit.material.Skull skullMaterial = (org.bukkit.material.Skull) skull.getData();
} skullMaterial.setFacingDirection(BlockFace.SELF);
return skull;
}
/**
* Установка головы игрока.
* <p>
* После установки, необходимо выполнить <code>skull.update(true);</code>
*
* @param location место установки.
* @param face куда будет повёрнута голова.
* @return Блок типа {@link Skull}
*/
public static Skull placePlayerHead(Location location, BlockFace face) {
Location fixedLocation = GhastTools.copyLocation(location);
fixedLocation.setZ(fixedLocation.getZ() - 1);
Block block = fixedLocation.getWorld().getBlockAt(fixedLocation);
block.setType(Material.SKULL);
Skull skull = (Skull) block.getState();
skull.setSkullType(SkullType.PLAYER);
skull.setRotation(face);
org.bukkit.material.Skull skullMaterial = (org.bukkit.material.Skull) skull.getData();
skullMaterial.setFacingDirection(BlockFace.SELF);
return skull;
}
/**
* Установка текстурированной головы игрока.
*
* @param location место установки.
* @param face куда будет повёрнута голова.
* @param skinUrl URL на текстуру
* @return Блок типа {@link Skull}
*/
public static Skull placePlayerHead(Location location, BlockFace face, String skinUrl) {
Skull playerHead = placePlayerHead(location, face);
playerHead.update(true);
setPlayerHeadSkin(playerHead, skinUrl);
return playerHead;
}
/**
* Установка текстуры для головы игрока.
*
* @param skull блок головы игрока
* @param skinUrl URL на текстуру
*/
public static void setPlayerHeadSkin(Skull skull, String skinUrl) {
//TODO заменить рефлексию на "фантомные" классы
ReflectionObject refobjBlockPosition = new ReflectionClass(CLASS_BLOCKPOSITION)
.constructor(double.class, double.class, double.class)
.newInstance(skull.getX(), skull.getY(), skull.getZ());
new ReflectionObject(skull.getWorld())
.method("getHandle").invoke()
.method("getTileEntity", CLASS_BLOCKPOSITION)
.invoke(refobjBlockPosition.getOriginalObject())
.method("setGameProfile", CLASS_GAMEPROFILE)
.invoke(getRefObjPlayerProfile(skinUrl).getOriginalObject());
}
public Sign placeSignWall(Location location, BlockFace face) {
Block block = location.getWorld().getBlockAt(location);
block.setType(Material.WALL_SIGN);
Sign sign = (Sign) block.getState();
org.bukkit.material.Sign signMaterial = (org.bukkit.material.Sign) sign.getData();
signMaterial.setFacingDirection(face);
return sign;
}
private ReflectionObject getRefObjPlayerProfile(String url){
ReflectionObject refobjProperty = new ReflectionClass(
getClassForName("com.mojang.authlib.properties.Property"))
.constructor(String.class, String.class)
.newInstance("textures", Base64.getEncoder()
.encodeToString(("{textures:{SKIN:{url:\"" + url + "\"}}}").getBytes(StandardCharsets.UTF_8)));
ReflectionObject refobjGameProfile = new ReflectionClass(CLASS_GAMEPROFILE)
.constructor(UUID.class, String.class)
.newInstance(UUID.randomUUID(), null);
refobjGameProfile
.method("getProperties").invoke()
.method("put", Object.class, Object.class)
.invoke("textures", refobjProperty.getOriginalObject());
return refobjGameProfile;
}
private Class<?> getClassForName(String className) {
try {
return Class.forName(className);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
} }

View File

@@ -0,0 +1,27 @@
package ghast;
import lombok.experimental.UtilityClass;
import org.bukkit.Location;
import org.bukkit.Particle;
import org.bukkit.Sound;
import org.bukkit.SoundCategory;
import org.bukkit.util.Vector;
@UtilityClass
@SuppressWarnings("unused")
public class EffectsHelper {
public void playSound(Location location, Sound sound, float pitch) {
location.getWorld().playSound(location, sound, SoundCategory.MASTER, 1.0f, pitch);
}
public void particle(Location location, Particle particle, double dx, double dy, double dz, double speed, int amount) {
location.getWorld().spawnParticle(particle, location, amount, dx, dy, dz, speed);
}
//TODO нужно проверить
public void particle(Location location, Particle particle, Vector vector, double speed, int amount) {
particle(location, particle, vector.getX(), vector.getY(), vector.getZ(), speed, amount);
}
}

View File

@@ -17,55 +17,55 @@ import java.util.function.Consumer;
@SuppressWarnings("unused") @SuppressWarnings("unused")
public class EventContext implements Listener { public class EventContext implements Listener {
private static final BooleanSupplier EMPTY_FILTER = () -> true; private static final BooleanSupplier EMPTY_FILTER = () -> true;
private static final Consumer<Cancellable> CANCEL_EVENT = event -> event.setCancelled(true); private static final Consumer<Cancellable> CANCEL_EVENT = event -> event.setCancelled(true);
private final Map<Class<? extends Event>, Consumer<?>> eventMap = new HashMap<>(); private final Map<Class<? extends Event>, Consumer<?>> eventMap = new HashMap<>();
private BooleanSupplier filter = EMPTY_FILTER; private BooleanSupplier filter = EMPTY_FILTER;
public EventContext filter(BooleanSupplier filter) { public EventContext filter(BooleanSupplier filter) {
this.filter = (filter != null ? filter : EMPTY_FILTER); this.filter = (filter != null ? filter : EMPTY_FILTER);
return this; return this;
} }
public <T extends Event> EventContext onEvent(Class<T> eventType, EventPriority eventPriority, Consumer<T> consumer) { public <T extends Event> EventContext onEvent(Class<T> eventType, EventPriority eventPriority, Consumer<T> consumer) {
if (consumer == null) { if (consumer == null) {
eventMap.remove(eventType); eventMap.remove(eventType);
} else { } else {
eventMap.put(eventType, consumer); eventMap.put(eventType, consumer);
bukkitRegisterEvent(eventType, eventPriority); bukkitRegisterEvent(eventType, eventPriority);
} }
return this; return this;
} }
public <T extends Event> EventContext onEvent(Class<T> eventType, Consumer<T> consumer) { public <T extends Event> EventContext onEvent(Class<T> eventType, Consumer<T> consumer) {
return onEvent(eventType, EventPriority.NORMAL, consumer); return onEvent(eventType, EventPriority.NORMAL, consumer);
} }
public <T extends Event & Cancellable> EventContext cancelEvent(Class<T> eventType, EventPriority eventPriority) { public <T extends Event & Cancellable> EventContext cancelEvent(Class<T> eventType, EventPriority eventPriority) {
eventMap.put(eventType, CANCEL_EVENT); eventMap.put(eventType, CANCEL_EVENT);
bukkitRegisterEvent(eventType, eventPriority); bukkitRegisterEvent(eventType, eventPriority);
return this; return this;
} }
public <T extends Event & Cancellable> EventContext cancelEvent(Class<T> eventType) { public <T extends Event & Cancellable> EventContext cancelEvent(Class<T> eventType) {
return cancelEvent(eventType, EventPriority.NORMAL); return cancelEvent(eventType, EventPriority.NORMAL);
} }
private void bukkitRegisterEvent(Class<? extends Event> eventType, EventPriority eventPriority) { private void bukkitRegisterEvent(Class<? extends Event> eventType, EventPriority eventPriority) {
Bukkit.getPluginManager().registerEvent(eventType, this, eventPriority, Bukkit.getPluginManager().registerEvent(eventType, this, eventPriority,
this::eventExecute, GhastTools.getPlugin()); this::eventExecute, GhastTools.getPlugin());
} }
@SuppressWarnings({ "unchecked", "rawtypes" }) @SuppressWarnings({ "unchecked", "rawtypes" })
private void eventExecute(Listener listener, Event event) { private void eventExecute(Listener listener, Event event) {
Consumer consumer = eventMap.get(event.getClass()); Consumer consumer = eventMap.get(event.getClass());
if (consumer != null && filter.getAsBoolean()) { if (consumer != null && filter.getAsBoolean()) {
consumer.accept(event); consumer.accept(event);
} }
} }
public static EventContext create() { public static EventContext create() {
return new EventContext(); return new EventContext();
} }
} }

View File

@@ -1,6 +1,8 @@
package ghast; package ghast;
import ghast.assets.AssetsManager;
import lombok.experimental.UtilityClass; import lombok.experimental.UtilityClass;
import org.bukkit.Location;
import org.bukkit.configuration.file.YamlConfiguration; import org.bukkit.configuration.file.YamlConfiguration;
import org.bukkit.plugin.Plugin; import org.bukkit.plugin.Plugin;
@@ -12,45 +14,42 @@ import java.lang.ref.WeakReference;
@SuppressWarnings("unused") @SuppressWarnings("unused")
public class GhastTools { public class GhastTools {
private static WeakReference<Plugin> refPlugin; private static WeakReference<Plugin> refPlugin;
@SuppressWarnings("java:S2696") public void setPlugin(Plugin plugin) {
public void setPlugin(Plugin plugin) { refPlugin = plugin == null ? null : new WeakReference<>(plugin);
if (plugin == null) { }
refPlugin = null;
} else {
refPlugin = new WeakReference<>(plugin);
}
}
@SuppressWarnings("java:S112") public Plugin getPlugin() {
public Plugin getPlugin() { if (refPlugin == null) {
if (refPlugin == null) { throw new RuntimeException("Plugin not set.");
throw new RuntimeException("Plugin not set."); }
}
Plugin plugin = refPlugin.get(); Plugin plugin = refPlugin.get();
if (plugin == null) { if (plugin == null) {
throw new RuntimeException("Plugin not set."); throw new RuntimeException("Plugin not set.");
} }
return plugin; return plugin;
} }
@SuppressWarnings("java:S112") public YamlConfiguration loadConfig(boolean saveDefault) {
public YamlConfiguration loadConfig(boolean saveDefault) { if (saveDefault) {
if (saveDefault) { getPlugin().saveDefaultConfig();
getPlugin().saveDefaultConfig(); }
}
try (Reader reader = AssetsManager.getAsReader("config.yml", saveDefault)) { try (Reader reader = AssetsManager.getAsReader("config.yml", saveDefault)) {
return YamlConfiguration.loadConfiguration(reader); return YamlConfiguration.loadConfiguration(reader);
} catch (IOException e) { } catch (IOException e) {
throw new RuntimeException("Error load config: " + e.getMessage(), e); throw new RuntimeException("Error load config: " + e.getMessage(), e);
} }
} }
public YamlConfiguration loadConfig() { public YamlConfiguration loadConfig() {
return loadConfig(true); return loadConfig(true);
} }
public Location copyLocation(Location location) {
return new Location(location.getWorld(), location.getX(), location.getY(), location.getZ());
}
} }

View File

@@ -14,78 +14,81 @@ import java.io.Reader;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
/**
* @deprecated use {@link Messages}
*/
@UtilityClass @UtilityClass
@SuppressWarnings("unused") @SuppressWarnings("unused")
@Deprecated
public class I18n { public class I18n {
private final String DEFAULT_LANG = "en"; private final String DEFAULT_LANG = "en";
private final Table<String/*Lang*/, String/*Key*/, String/*Template|Message*/> messagesMap = HashBasedTable.create(); private final Table<String/*Lang*/, String/*Key*/, String/*Template|Message*/> messagesMap = HashBasedTable.create();
//region Load messages //region Load messages
@SuppressWarnings("java:S112") public void loadMessages(String lang, Reader reader) {
public void loadMessages(String lang, Reader reader) { Map<String, String> map = messagesMap.row(lang.toLowerCase());
Map<String, String> map = messagesMap.row(lang.toLowerCase());
try { try {
BufferedReader bufferedReader = new BufferedReader(reader); BufferedReader bufferedReader = new BufferedReader(reader);
String line; String line;
while ((line = bufferedReader.readLine()) != null) { while ((line = bufferedReader.readLine()) != null) {
String[] split = line.split("=", 2); String[] split = line.split("=", 2);
map.put(split[0].trim().toLowerCase(), split[1].trim()); map.put(split[0].trim().toLowerCase(), split[1].trim());
} }
} catch (IOException e) { } catch (IOException e) {
throw new RuntimeException("Error load messages: " + e.getMessage(), e); throw new RuntimeException("Error load messages: " + e.getMessage(), e);
} }
} }
public void loadMessages(String lang, Map<String, String> messages) { public void loadMessages(String lang, Map<String, String> messages) {
Map<String, String> map = messagesMap.row(lang.toLowerCase()); Map<String, String> map = messagesMap.row(lang.toLowerCase());
messages.forEach((k, v) -> map.put(k.toLowerCase(), v)); messages.forEach((k, v) -> map.put(k.toLowerCase(), v));
} }
public void loadMessages(Reader reader) { public void loadMessages(Reader reader) {
loadMessages(DEFAULT_LANG, reader); loadMessages(DEFAULT_LANG, reader);
} }
public void loadMessages(Map<String, String> messages) { public void loadMessages(Map<String, String> messages) {
loadMessages(DEFAULT_LANG, messages); loadMessages(DEFAULT_LANG, messages);
} }
//endregion //endregion
//region Get message //region Get message
public String get(String lang, String key) { public String get(String lang, String key) {
return messagesMap.row(lang.toLowerCase()).getOrDefault(key.toLowerCase(), StringUtils.EMPTY); return messagesMap.row(lang.toLowerCase()).getOrDefault(key.toLowerCase(), StringUtils.EMPTY);
} }
public String get(String lang, String key, Map<String, Object> params) { public String get(String lang, String key, Map<String, Object> params) {
return StringSubstitutor.replace(get(lang, key.toLowerCase()), params, "{", "}"); return StringSubstitutor.replace(get(lang, key.toLowerCase()), params, "{", "}");
} }
public String get(String key) { public String get(String key) {
return get(DEFAULT_LANG, key); return get(DEFAULT_LANG, key);
} }
public String get(String key, Map<String, Object> params) { public String get(String key, Map<String, Object> params) {
return get(DEFAULT_LANG, key, params); return get(DEFAULT_LANG, key, params);
} }
//endregion //endregion
public ParamBuilder paramBuilder() { public ParamBuilder paramBuilder() {
return new ParamBuilder(); return new ParamBuilder();
} }
@NoArgsConstructor(access = AccessLevel.PRIVATE) @NoArgsConstructor(access = AccessLevel.PRIVATE)
public static class ParamBuilder { public static class ParamBuilder {
private final Map<String, Object> params = new HashMap<>(); private final Map<String, Object> params = new HashMap<>();
public ParamBuilder add(String key, Object value) { public ParamBuilder add(String key, Object value) {
params.put(key, value); params.put(key, value);
return this; return this;
} }
public Map<String, Object> build() { public Map<String, Object> build() {
return params; return params;
} }
} }
} }

View File

@@ -0,0 +1,150 @@
package ghast;
import lombok.experimental.UtilityClass;
import org.apache.commons.text.StringSubstitutor;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.Reader;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
@UtilityClass
public class Messages {
private final Map<String/*Key*/, String/*Template|Message*/> MESSAGES_MAP = new HashMap<>();
//region Load messages
/**
* Загрузка сообщений из {@link Properties}
*
* @param properties список сообщений и шаблонов
*/
public void load(Properties properties) {
MESSAGES_MAP.clear();
properties.forEach((key, value) -> MESSAGES_MAP.put(key.toString().trim().toLowerCase(), value.toString().trim()));
}
/**
* Загрузка сообщений из {@link Reader}.
* <p>
* Формат строк: {@code key=value}
* </p>
*
* @param reader {@link Reader} со списоком сообщений и шаблонов
*/
public void load(Reader reader) {
MESSAGES_MAP.clear();
try {
BufferedReader bufferedReader = new BufferedReader(reader);
String line;
while ((line = bufferedReader.readLine()) != null) {
String[] split = line.split("=", 2);
MESSAGES_MAP.put(split[0].trim().toLowerCase(), split[1].trim());
}
} catch (IOException e) {
//TODO заменить на специализированный Exception
throw new RuntimeException("Error load messages: " + e.getMessage(), e);
}
}
/**
* Загрузка сообщений из {@link Map}<{@link String}, {@link String}>.
*
* @param messages список сообщений и шаблонов
*/
public void load(Map<String, String> messages) {
MESSAGES_MAP.clear();
MESSAGES_MAP.putAll(messages);
}
//endregion
//region Get messages
/**
* Получить обычное сообщение по ключу/коду.
*
* @param key ключ/код
* @return сообщение, если таковое задано. Иначе - ключ
*/
public String get(String key) {
String keyLc = key.toLowerCase();
return MESSAGES_MAP.getOrDefault(keyLc, keyLc);
}
/**
* Получить параметизированное сообщение по ключу/коду.
*
* @param key ключ/код
* @param params список параметров
* @return сообщение, если таковое задано. Иначе - ключ
*/
public String get(String key, Map<String, Object> params) {
String keyLc = key.toLowerCase();
if (MESSAGES_MAP.containsKey(keyLc)) {
return format(MESSAGES_MAP.get(keyLc), params);
} else {
return keyLc;
}
}
/**
* Получить параметизированное сообщение по ключу/коду.
*
* @param key ключ/код
* @param params чередующийся по парный список параметров: {@link String (str)param_name}, {@link Object (obj)param_value} и т.д.
* @return сообщение, если таковое задано. Иначе - ключ
*/
public String get(String key, Object... params) {
String keyLc = key.toLowerCase();
if (MESSAGES_MAP.containsKey(keyLc)) {
return format(MESSAGES_MAP.get(keyLc), params);
} else {
return keyLc;
}
}
//endregion
//region Format message
/**
* Получить сообщение по формату.
*
* @param format параметизированное сообщение
* @param params параметры
* @return сообщение
*/
public String format(String format, Map<String, Object> params) {
return StringSubstitutor.replace(format, params, "{", "}");
}
/**
* Получить сообщение по формату.
*
* @param format параметизированное сообщение
* @param params параметры
* @return сообщение
*/
public String format(String format, Object... params) {
return format(format, arrayParamsToMap(params));
}
//endregion
private Map<String, Object> arrayParamsToMap(Object... params) {
int len;
if ((params.length % 2) == 1) {
len = params.length - 1;
} else {
len = params.length;
}
Map<String, Object> map = new HashMap<>(len / 2);
for (int i = 0; i < len; i = i + 2) {
map.put((String) params[i], params[i + 1]);
}
return map;
}
}

View File

@@ -1,92 +0,0 @@
package ghast;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.experimental.UtilityClass;
import org.bukkit.Bukkit;
import org.bukkit.scheduler.BukkitScheduler;
import java.util.concurrent.*;
@UtilityClass
@SuppressWarnings("unused")
public class ScheduleManager {
private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder()
.setNameFormat("ScheduleManager-Thread-%d")
.setDaemon(true)
.build();
public Builder createTask() {
return new Builder();
}
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public static class Builder {
private static final long MS_PER_ONE_TICK = 1000L/*one second by ms*/ / 20L/*tick per second*/;
private boolean useBukkitScheduler = false;
private Long afterMs;
private Long everyMs;
public Builder useBukkitScheduler() {
this.useBukkitScheduler = true;
return this;
}
public Builder after(long value, TimeUnit unit) {
this.afterMs = unit.toMillis(value);
return this;
}
public Builder every(long value, TimeUnit unit) {
this.everyMs = unit.toMillis(value);
return this;
}
public void execute(Runnable runnable) {
if (useBukkitScheduler) {
createBukkitSchedule(runnable);
} else {
createSchedule(runnable);
}
}
private void createBukkitSchedule(Runnable runnable) {
BukkitScheduler bukkitScheduler = Bukkit.getScheduler();
if (this.afterMs == null && this.everyMs == null) {
bukkitScheduler.runTask(GhastTools.getPlugin(), runnable);
} else if (this.everyMs != null) {
long everyTicks = this.everyMs / MS_PER_ONE_TICK;
long afterTicks = this.afterMs != null ? this.afterMs / MS_PER_ONE_TICK : 0;
bukkitScheduler.runTaskTimer(GhastTools.getPlugin(), runnable, afterTicks, everyTicks);
} else {
long ticks = this.afterMs / MS_PER_ONE_TICK;
bukkitScheduler.runTaskLater(GhastTools.getPlugin(), runnable, ticks);
}
}
private void createSchedule(Runnable runnable) {
ExecutorService executorService;
if (this.afterMs == null && this.everyMs == null) {
executorService = Executors.newSingleThreadExecutor(THREAD_FACTORY);
executorService.execute(runnable);
} else if (this.everyMs != null) {
ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1, THREAD_FACTORY);
scheduledExecutorService.scheduleAtFixedRate(runnable,
this.afterMs != null ? this.afterMs : 0,
everyMs, TimeUnit.MILLISECONDS);
executorService = scheduledExecutorService;
} else {
ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1, THREAD_FACTORY);
scheduledExecutorService.schedule(runnable, afterMs, TimeUnit.MILLISECONDS);
executorService = scheduledExecutorService;
}
executorService.shutdown();
}
}
}

View File

@@ -10,68 +10,68 @@ import static java.text.MessageFormat.format;
@SuppressWarnings("unused") @SuppressWarnings("unused")
public class XLog { public class XLog {
//region Debug //region Debug
public void debug(String pattern, Object... objects) { public void debug(String pattern, Object... objects) {
if (objects.length > 1 && objects[objects.length - 1] instanceof Throwable) { if (objects.length > 1 && objects[objects.length - 1] instanceof Throwable) {
Throwable throwable = (Throwable) objects[objects.length - 1]; Throwable throwable = (Throwable) objects[objects.length - 1];
Object[] values = new Object[objects.length - 1]; Object[] values = new Object[objects.length - 1];
System.arraycopy(objects, 0, values, 0, values.length); System.arraycopy(objects, 0, values, 0, values.length);
debug(format(pattern, values), throwable); debug(format(pattern, values), throwable);
} else { } else {
debug(format(pattern, objects)); debug(format(pattern, objects));
} }
} }
public void debug(String message, Throwable throwable) { public void debug(String message, Throwable throwable) {
GhastTools.getPlugin().getLogger().log(Level.FINE, message, throwable); GhastTools.getPlugin().getLogger().log(Level.FINE, message, throwable);
} }
public void debug(String message) { public void debug(String message) {
GhastTools.getPlugin().getLogger().fine(message); GhastTools.getPlugin().getLogger().fine(message);
} }
//endregion //endregion
//region Info //region Info
public void info(String pattern, Object... objects) { public void info(String pattern, Object... objects) {
info(format(pattern, objects)); info(format(pattern, objects));
} }
public void info(String message) { public void info(String message) {
GhastTools.getPlugin().getLogger().info(message); GhastTools.getPlugin().getLogger().info(message);
} }
//endregion //endregion
//region Warning //region Warning
public void warn(String pattern, Object... objects) { public void warn(String pattern, Object... objects) {
warn(format(pattern, objects)); warn(format(pattern, objects));
} }
public void warn(String message) { public void warn(String message) {
GhastTools.getPlugin().getLogger().warning(message); GhastTools.getPlugin().getLogger().warning(message);
} }
//endregion //endregion
//region Error //region Error
public void error(String pattern, Object... objects) { public void error(String pattern, Object... objects) {
if (objects.length > 1 && objects[objects.length - 1] instanceof Throwable) { if (objects.length > 1 && objects[objects.length - 1] instanceof Throwable) {
Throwable throwable = (Throwable) objects[objects.length - 1]; Throwable throwable = (Throwable) objects[objects.length - 1];
Object[] values = new Object[objects.length - 1]; Object[] values = new Object[objects.length - 1];
System.arraycopy(objects, 0, values, 0, values.length); System.arraycopy(objects, 0, values, 0, values.length);
error(format(pattern, values), throwable); error(format(pattern, values), throwable);
} else { } else {
error(format(pattern, objects)); error(format(pattern, objects));
} }
} }
public void error(String message) { public void error(String message) {
GhastTools.getPlugin().getLogger().severe(message); GhastTools.getPlugin().getLogger().severe(message);
} }
public void error(String message, Throwable throwable) { public void error(String message, Throwable throwable) {
GhastTools.getPlugin().getLogger().log(Level.SEVERE, message, throwable); GhastTools.getPlugin().getLogger().log(Level.SEVERE, message, throwable);
} }
//endregion //endregion
} }

View File

@@ -0,0 +1,13 @@
package ghast.assets;
public class AssetsException extends RuntimeException {
public AssetsException(String message) {
super(message);
}
public AssetsException(String message, Throwable cause) {
super(message, cause);
}
}

View File

@@ -0,0 +1,163 @@
package ghast.assets;
import ghast.GhastTools;
import lombok.experimental.UtilityClass;
import org.bukkit.plugin.Plugin;
import java.io.*;
import java.net.URL;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Scanner;
import static java.text.MessageFormat.format;
@UtilityClass
@SuppressWarnings("unused")
public class AssetsManager {
private static final String ERROR_NOT_FOUND = "Asset \"{0}\" not found";
private static final String ERROR_OPEN = "Error open asset \"{0}\": {1}";
//region getAsInputStream methods
public InputStream getAsInputStream(String resourceName, String defaultResourceName, boolean saveDefault) {
Plugin plugin = GhastTools.getPlugin();
InputStream inputStream;
Path pathToResource = plugin.getDataFolder().toPath().resolve(resourceName);
if (Files.exists(pathToResource)) {
inputStream = openResource(pathToResource);
} else if (defaultResourceName != null) {
URL resourceUrl = getResourceUrl(defaultResourceName);
if (saveDefault) {
doSaveTo(resourceUrl, pathToResource);
inputStream = openResource(pathToResource);
} else {
inputStream = openResource(resourceUrl);
}
} else {
throw new AssetsException(format(ERROR_NOT_FOUND, resourceName));
}
return inputStream;
}
public InputStream getAsInputStream(String resourceName, String defaultResourceName) {
return getAsInputStream(resourceName, defaultResourceName, true);
}
public InputStream getAsInputStream(String resourceName, boolean saveDefault) {
return getAsInputStream(resourceName, resourceName, saveDefault);
}
public InputStream getAsInputStream(String resourceName) {
return getAsInputStream(resourceName, resourceName, true);
}
//endregion
//region getAsReader methods
public Reader getAsReader(String resourceName, String defaultResourceName, boolean saveDefault) {
return new InputStreamReader(getAsInputStream(resourceName, defaultResourceName, saveDefault));
}
public Reader getAsReader(String resourceName, String defaultResourceName) {
return new InputStreamReader(getAsInputStream(resourceName, defaultResourceName, true));
}
public Reader getAsReader(String resourceName, boolean saveDefault) {
return new InputStreamReader(getAsInputStream(resourceName, resourceName, saveDefault));
}
public Reader getAsReader(String resourceName) {
return new InputStreamReader(getAsInputStream(resourceName, resourceName, true));
}
//endregion
//region getAsString methods
public String getAsString(String resourceName, String defaultResourceName, Charset charset, boolean saveDefault) {
try (InputStream inputStream = getAsInputStream(resourceName, defaultResourceName, saveDefault);
Scanner scanner = new Scanner(inputStream, charset.name()).useDelimiter("\\A")) {
return scanner.next();
} catch (IOException e) {
throw new AssetsException(format(ERROR_OPEN, resourceName, e.getMessage()), e);
}
}
public String getAsString(String resourceName, String defaultResourceName, Charset charset) {
return getAsString(resourceName, defaultResourceName, charset, true);
}
public String getAsString(String resourceName, String defaultResourceName, boolean saveDefault) {
return getAsString(resourceName, defaultResourceName, StandardCharsets.UTF_8, saveDefault);
}
public String getAsString(String resourceName, String defaultResourceName) {
return getAsString(resourceName, defaultResourceName, StandardCharsets.UTF_8, true);
}
public String getAsString(String resourceName, Charset charset, boolean saveDefault) {
return getAsString(resourceName, resourceName, charset, saveDefault);
}
public String getAsString(String resourceName, Charset charset) {
return getAsString(resourceName, resourceName, charset, true);
}
public String getAsString(String resourceName, boolean saveDefault) {
return getAsString(resourceName, resourceName, StandardCharsets.UTF_8, saveDefault);
}
public String getAsString(String resourceName) {
return getAsString(resourceName, resourceName, StandardCharsets.UTF_8, true);
}
//endregion
private URL getResourceUrl(String resourceName) {
URL resourceUrl = AssetsManager.class.getClassLoader().getResource(resourceName);
if (resourceUrl == null) {
throw new AssetsException(format(ERROR_NOT_FOUND, resourceName));
}
return resourceUrl;
}
private void doSaveTo(URL resourceUrl, Path saveToPath) {
try {
Files.createDirectories(saveToPath.getParent());
try (InputStream inputStream = resourceUrl.openStream();
OutputStream outputStream = Files.newOutputStream(saveToPath)) {
byte[] buffer = new byte[8192];
int count;
while ((count = inputStream.read(buffer)) != -1) {
outputStream.write(buffer, 0, count);
}
outputStream.flush();
}
} catch (IOException e) {
throw new AssetsException(format("Error save asset \"{0}\" to \"{1}\": {2}",
resourceUrl, saveToPath, e.getMessage()), e);
}
}
private InputStream openResource(Path pathToResource) {
try {
return Files.newInputStream(pathToResource);
} catch (IOException e) {
throw new AssetsException(format(ERROR_OPEN, pathToResource, e.getMessage()), e);
}
}
private InputStream openResource(URL resourceUrl) {
try {
return resourceUrl.openStream();
} catch (IOException e) {
throw new AssetsException(format(ERROR_OPEN, resourceUrl, e.getMessage()), e);
}
}
}

View File

@@ -4,5 +4,5 @@ import org.bukkit.command.CommandSender;
public interface CommandExecuter { public interface CommandExecuter {
void execute(CommandSender sender, String[] args); void execute(CommandSender sender, String[] args);
} }

View File

@@ -11,61 +11,61 @@ import ru.dmitriymx.reflection.ReflectionObject;
@SuppressWarnings("unused") @SuppressWarnings("unused")
public class CommandManager { public class CommandManager {
public Builder create(String name) { public Builder create(String name) {
return new Builder(name); return new Builder(name);
} }
public void register(String name, CommandExecuter executer) { public void register(String name, CommandExecuter executer) {
create(name).executer(executer).register(); create(name).executer(executer).register();
} }
@RequiredArgsConstructor(access = AccessLevel.PRIVATE) @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
public static class Builder { public static class Builder {
private final String name; private final String name;
private CommandExecuter executer; private CommandExecuter executer;
private ErrorConsumer errorConsumer; private ErrorConsumer errorConsumer;
private Boolean onlyPlayer; private Boolean onlyPlayer;
private String deniedMessage; private String deniedMessage;
public Builder executer(CommandExecuter executer) { public Builder executer(CommandExecuter executer) {
this.executer = executer; this.executer = executer;
return this; return this;
} }
public Builder onError(ErrorConsumer errorConsumer) { public Builder onError(ErrorConsumer errorConsumer) {
this.errorConsumer = errorConsumer; this.errorConsumer = errorConsumer;
return this; return this;
} }
public Builder useOnlyPlayer(String deniedMessage) { public Builder useOnlyPlayer(String deniedMessage) {
this.onlyPlayer = true; this.onlyPlayer = true;
this.deniedMessage = deniedMessage; this.deniedMessage = deniedMessage;
return this; return this;
} }
public Builder useOnlyPlayer() { public Builder useOnlyPlayer() {
return useOnlyPlayer(null); return useOnlyPlayer(null);
} }
public Builder useOnlyConsole(String deniedMessage) { public Builder useOnlyConsole(String deniedMessage) {
this.onlyPlayer = false; this.onlyPlayer = false;
this.deniedMessage = deniedMessage; this.deniedMessage = deniedMessage;
return this; return this;
} }
public Builder useOnlyConsole() { public Builder useOnlyConsole() {
return useOnlyConsole(null); return useOnlyConsole(null);
} }
public void register() { public void register() {
//TODO для Paper такие "извращения" не требуются. Нужно продумать. //TODO для Paper такие "извращения" не требуются. Нужно продумать.
new ReflectionObject(Bukkit.getServer()) new ReflectionObject(Bukkit.getServer())
.method("getCommandMap").invoke() .method("getCommandMap").invoke()
.method("register", String.class, Command.class).invoke( .method("register", String.class, Command.class).invoke(
name, new CommandWrapper(name, this.onlyPlayer, this.deniedMessage, name, new CommandWrapper(name, this.onlyPlayer, this.deniedMessage,
this.executer, this.errorConsumer) this.executer, this.errorConsumer)
); );
} }
} }
} }

View File

@@ -8,64 +8,63 @@ import org.bukkit.entity.Player;
class CommandWrapper extends BukkitCommand { class CommandWrapper extends BukkitCommand {
private static final String DEFAULT_DENIED_MESSAGE_PLAYERS = ChatColor.RED + "This command use only players"; private static final String DEFAULT_DENIED_MESSAGE_PLAYERS = ChatColor.RED + "This command use only players";
private static final String DEFAULT_DENIED_MESSAGE_CONSOLE = ChatColor.RED + "This command use only in console"; private static final String DEFAULT_DENIED_MESSAGE_CONSOLE = ChatColor.RED + "This command use only in console";
private static final ErrorConsumer DEFAULT_ERROR_CONSUMER = private static final ErrorConsumer DEFAULT_ERROR_CONSUMER =
(sender, commandName, args, exception) -> { (sender, commandName, args, exception) -> {
sender.sendMessage(String.format("%sError execute command '%s'!", ChatColor.RED, commandName)); sender.sendMessage(String.format("%sError execute command '%s'!", ChatColor.RED, commandName));
XLog.error("Error execute command ''{0}'' with args ''{1}''", XLog.error("Error execute command ''{0}'' with args ''{1}''",
commandName, String.join(" ", args), exception); commandName, String.join(" ", args), exception);
}; };
private final CommandExecuter executer; private final CommandExecuter executer;
private final ErrorConsumer errorConsumer; private final ErrorConsumer errorConsumer;
private final Boolean onlyPlayer; private final Boolean onlyPlayer;
private String deniedMessage; private String deniedMessage;
protected CommandWrapper(String name, Boolean onlyPlayer, String deniedMessage, protected CommandWrapper(String name, Boolean onlyPlayer, String deniedMessage,
CommandExecuter executer, ErrorConsumer errorConsumer) { CommandExecuter executer, ErrorConsumer errorConsumer) {
super(name); super(name);
this.onlyPlayer = onlyPlayer; this.onlyPlayer = onlyPlayer;
this.executer = executer; this.executer = executer;
if (onlyPlayer != null) { if (onlyPlayer != null) {
if (deniedMessage == null) { if (deniedMessage == null) {
this.deniedMessage = Boolean.TRUE.equals(onlyPlayer) ? DEFAULT_DENIED_MESSAGE_PLAYERS this.deniedMessage = Boolean.TRUE.equals(onlyPlayer) ? DEFAULT_DENIED_MESSAGE_PLAYERS
: DEFAULT_DENIED_MESSAGE_CONSOLE; : DEFAULT_DENIED_MESSAGE_CONSOLE;
} else { } else {
this.deniedMessage = deniedMessage; this.deniedMessage = deniedMessage;
} }
} }
if(errorConsumer == null) { if(errorConsumer == null) {
this.errorConsumer = DEFAULT_ERROR_CONSUMER; this.errorConsumer = DEFAULT_ERROR_CONSUMER;
} else { } else {
this.errorConsumer = errorConsumer; this.errorConsumer = errorConsumer;
} }
} }
@Override @Override
@SuppressWarnings("java:S1066") public boolean execute(CommandSender commandSender, String commandName, String[] args) {
public boolean execute(CommandSender commandSender, String commandName, String[] args) { if (Boolean.TRUE.equals(onlyPlayer)) {
if (Boolean.TRUE.equals(onlyPlayer)) { if (!(commandSender instanceof Player)) {
if (!(commandSender instanceof Player)) { commandSender.sendMessage(deniedMessage);
commandSender.sendMessage(deniedMessage); return true;
return true; }
} } else if (Boolean.FALSE.equals(onlyPlayer)) { // use console only
} else if (Boolean.FALSE.equals(onlyPlayer)) { // use console only if (commandSender instanceof Player) {
if (commandSender instanceof Player) { commandSender.sendMessage(deniedMessage);
commandSender.sendMessage(deniedMessage); return true;
return true; }
} }
}
try { try {
executer.execute(commandSender, args); executer.execute(commandSender, args);
return true; return true;
} catch (Exception e) { } catch (Exception e) {
errorConsumer.accept(commandSender, commandName, args, e); errorConsumer.accept(commandSender, commandName, args, e);
return false; return false;
} }
} }
} }

View File

@@ -4,5 +4,5 @@ import org.bukkit.command.CommandSender;
public interface ErrorConsumer { public interface ErrorConsumer {
void accept(CommandSender sender, String commandName, String[] args, Exception exception); void accept(CommandSender sender, String commandName, String[] args, Exception exception);
} }

View File

@@ -0,0 +1,10 @@
package ghast.database;
import java.sql.SQLException;
public class CannotGetJdbcConnectionException extends DataAccessException {
public CannotGetJdbcConnectionException(String msg, SQLException ex) {
super(msg, ex);
}
}

View File

@@ -0,0 +1,18 @@
package ghast.database;
import lombok.Getter;
@Getter
public class DataAccessException extends RuntimeException {
private String sql;
public DataAccessException(String msg, Throwable cause) {
super(msg, cause);
}
public DataAccessException(String msg, String sql, Throwable cause) {
this(msg, cause);
this.sql = sql;
}
}

View File

@@ -0,0 +1,22 @@
package ghast.database;
import java.util.List;
import java.util.Map;
import java.util.Optional;
public interface JdbcOperations {
void execute(String sql) throws DataAccessException;
<T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException;
<T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException;
<T> List<T> queryList(String sql, RowMapper<T> rowMapper) throws DataAccessException;
Map<String, Object> queryForMap(String sql) throws DataAccessException;
List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException;
int update(String sql) throws DataAccessException;
}

View File

@@ -0,0 +1,244 @@
package ghast.database;
import ghast.XLog;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import javax.sql.DataSource;
import java.sql.Date;
import java.sql.*;
import java.util.*;
@NoArgsConstructor
@Getter
@Setter
public class JdbcTemplate implements JdbcOperations {
private static final String DBG_SQL_INFO = "Execute SQL: {0}";
private DataSource dataSource;
public JdbcTemplate(DataSource dataSource) {
setDataSource(dataSource);
}
@Override
public void execute(String sql) throws DataAccessException {
XLog.debug(DBG_SQL_INFO, sql);
Connection connection = openConnection();
Statement statement = null;
try {
statement = connection.createStatement();
statement.execute(sql);
} catch (SQLException e) {
throw new DataAccessException("Error execute SQL", sql, e);
} finally {
closeStatement(statement);
closeConnection(connection);
}
}
@Override
public <T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
XLog.debug(DBG_SQL_INFO, sql);
Connection connection = openConnection();
Statement statement = null;
ResultSet resultSet = null;
try {
statement = connection.createStatement();
resultSet = statement.executeQuery(sql);
return rse.extractData(resultSet);
} catch (SQLException e) {
throw new DataAccessException("Error execute SQL", sql, e);
} finally {
closeResultSet(resultSet);
closeStatement(statement);
closeConnection(connection);
}
}
@Override
public <T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
return query(sql, rs -> {
if (rs.next()) {
return Optional.ofNullable(rse.extractData(rs));
} else {
return Optional.empty();
}
});
}
@Override
public <T> List<T> queryList(String sql, final RowMapper<T> rowMapper) throws DataAccessException {
return query(sql, rs -> {
List<T> resultList;
int rowNum = 0;
if (rs.next()) {
resultList = new ArrayList<>();
do {
resultList.add(rowMapper.mapRow(rs, rowNum++));
} while (rs.next());
} else {
resultList = Collections.emptyList();
}
return resultList;
});
}
@Override
public Map<String, Object> queryForMap(String sql) throws DataAccessException {
return query(sql, rs -> {
if (rs.next()) {
ResultSetMetaData metaData = rs.getMetaData();
int columnCount = metaData.getColumnCount();
return rowToMap(columnCount, metaData, rs);
} else {
return Collections.emptyMap();
}
});
}
@Override
public List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException {
return query(sql, rs -> {
List<Map<String, Object>> resultList;
if (rs.next()) {
resultList = new ArrayList<>();
ResultSetMetaData metaData = rs.getMetaData();
int columnCount = metaData.getColumnCount();
do {
resultList.add(rowToMap(columnCount, metaData, rs));
} while (rs.next());
} else {
resultList = Collections.emptyList();
}
return resultList;
});
}
@Override
public int update(String sql) throws DataAccessException {
XLog.debug(DBG_SQL_INFO, sql);
Connection connection = openConnection();
Statement statement = null;
try {
statement = connection.createStatement();
int rows = statement.executeUpdate(sql);
XLog.debug("Affected {0} rows", rows);
return rows;
} catch (SQLException e) {
XLog.error("Error execute SQL: {0}", e.getMessage(), e);
return 0;
} finally {
closeStatement(statement);
closeConnection(connection);
}
}
private Connection openConnection() {
try {
return getDataSource().getConnection();
} catch (SQLException ex) {
throw new CannotGetJdbcConnectionException("Could not get JDBC Connection", ex);
}
}
private String lookupColumnName(ResultSetMetaData resultSetMetaData, int columnIndex) throws SQLException {
String name = resultSetMetaData.getColumnLabel(columnIndex);
if (name == null || name.isEmpty()) {
name = resultSetMetaData.getColumnName(columnIndex);
}
return name;
}
private Map<String, Object> rowToMap(int columnCount, ResultSetMetaData metaData, ResultSet rs) throws SQLException {
Map<String, Object> rowMap = new LinkedHashMap<>(columnCount);
for (int i = 1; i <= columnCount; i++) {
String key = lookupColumnName(metaData, i);
Object value = getResultSetRawValue(rs, i);
rowMap.put(key, value);
}
return rowMap;
}
private Object getResultSetRawValue(ResultSet resultSet, int index) throws SQLException {
Object obj = resultSet.getObject(index);
if (obj == null) {
return null;
}
String className = obj.getClass().getName();
if (obj instanceof Blob) {
Blob blob = (Blob) obj;
obj = blob.getBytes(1, (int) blob.length());
} else if (obj instanceof Clob) {
Clob clob = (Clob) obj;
obj = clob.getSubString(1, (int) clob.length());
} else if ("oracle.sql.TIMESTAMP".equals(className) || "oracle.sql.TIMESTAMPTZ".equals(className)) {
obj = resultSet.getTimestamp(index);
} else if (className.startsWith("oracle.sql.DATE")) {
String metaDataClassName = resultSet.getMetaData().getColumnClassName(index);
if ("java.sql.Timestamp".equals(metaDataClassName) || "oracle.sql.TIMESTAMP".equals(metaDataClassName)) {
obj = resultSet.getTimestamp(index);
} else {
obj = resultSet.getDate(index);
}
} else if (obj instanceof Date
&& "java.sql.Timestamp".equals(resultSet.getMetaData().getColumnClassName(index))) {
obj = resultSet.getTimestamp(index);
}
return obj;
}
private void closeResultSet(ResultSet resultSet) {
if (resultSet != null) {
try {
resultSet.close();
} catch (SQLException e) {
XLog.debug("Could not close JDBC ResultSet", e);
} catch (Exception e) {
XLog.debug("Unexpected exception on closing JDBC ResultSet", e);
}
}
}
private void closeStatement(Statement statement) {
if (statement != null) {
try {
statement.close();
} catch (SQLException e) {
XLog.debug("Could not close JDBC Statement", e);
} catch (Exception e) {
XLog.debug("Unexpected exception on closing JDBC Statement", e);
}
}
}
private void closeConnection(Connection con) {
if (con == null) {
return;
}
try {
con.close();
} catch (SQLException e) {
XLog.debug("Could not close JDBC Connection", e);
} catch (Exception e) {
XLog.debug("Unexpected exception on closing JDBC Connection", e);
}
}
}

View File

@@ -0,0 +1,9 @@
package ghast.database;
import java.sql.ResultSet;
import java.sql.SQLException;
public interface ResultSetExtractor<T> {
T extractData(ResultSet rs) throws SQLException, DataAccessException;
}

View File

@@ -0,0 +1,9 @@
package ghast.database;
import java.sql.ResultSet;
import java.sql.SQLException;
public interface RowMapper<T> {
T mapRow(ResultSet rs, int rowNum) throws SQLException;
}

View File

@@ -0,0 +1,33 @@
package ghast.scheduler;
import lombok.RequiredArgsConstructor;
import org.bukkit.scheduler.BukkitTask;
import java.util.function.Supplier;
@RequiredArgsConstructor
public class BukkitScheduleTask implements ScheduleTask {
private final Supplier<BukkitTask> generator;
private BukkitTask bukkitTask;
@Override
public void start() {
if (isCanceled()) {
bukkitTask = generator.get();
}
}
@Override
public boolean isCanceled() {
return bukkitTask == null || bukkitTask.isCancelled();
}
@Override
public void cancel() {
if (bukkitTask != null) {
bukkitTask.cancel();
bukkitTask = null;
}
}
}

View File

@@ -0,0 +1,33 @@
package ghast.scheduler;
import lombok.RequiredArgsConstructor;
import java.util.concurrent.Future;
import java.util.function.Supplier;
@RequiredArgsConstructor
public class JavaScheduleTask implements ScheduleTask {
private final Supplier<Future<?>> generator;
private Future<?> future;
@Override
public void start() {
if (future == null || future.isDone()) {
future = generator.get();
}
}
@Override
public boolean isCanceled() {
return future == null || future.isCancelled();
}
@Override
public void cancel() {
if (future != null) {
future.cancel(true);
future = null;
}
}
}

View File

@@ -0,0 +1,113 @@
package ghast.scheduler;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import ghast.GhastTools;
import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import lombok.experimental.UtilityClass;
import org.bukkit.Bukkit;
import org.bukkit.scheduler.BukkitScheduler;
import java.util.concurrent.*;
@UtilityClass
@SuppressWarnings("unused")
public class ScheduleManager {
private static final ThreadFactory THREAD_FACTORY = new ThreadFactoryBuilder()
.setNameFormat("ScheduleManager-Thread-%d")
.setDaemon(true)
.build();
public Builder createTask() {
return new Builder();
}
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public static class Builder {
private static final long MS_PER_ONE_TICK = 1000L/*one second by ms*/ / 20L/*tick per second*/;
private boolean useBukkitScheduler = false;
private Long afterMs;
private Long everyMs;
public Builder useBukkitScheduler() {
this.useBukkitScheduler = true;
return this;
}
public Builder after(long value, TimeUnit unit) {
this.afterMs = unit.toMillis(value);
return this;
}
public Builder every(long value, TimeUnit unit) {
this.everyMs = unit.toMillis(value);
return this;
}
public ScheduleTask create(Runnable runnable) {
if (useBukkitScheduler) {
return createBukkitSchedule(runnable);
} else {
return createSchedule(runnable);
}
}
public ScheduleTask execute(Runnable runnable) {
ScheduleTask scheduleTask = create(runnable);
scheduleTask.start();
return scheduleTask;
}
private ScheduleTask createBukkitSchedule(Runnable runnable) {
BukkitScheduler bukkitScheduler = Bukkit.getScheduler();
BukkitScheduleTask resultTask;
if (this.afterMs == null && this.everyMs == null) {
resultTask = new BukkitScheduleTask(() -> bukkitScheduler.runTask(GhastTools.getPlugin(), runnable));
} else if (this.everyMs != null) {
long everyTicks = this.everyMs / MS_PER_ONE_TICK;
long afterTicks = this.afterMs != null ? this.afterMs / MS_PER_ONE_TICK : 0;
resultTask = new BukkitScheduleTask(() ->
bukkitScheduler.runTaskTimer(GhastTools.getPlugin(), runnable, afterTicks, everyTicks));
} else {
long ticks = this.afterMs / MS_PER_ONE_TICK;
resultTask = new BukkitScheduleTask(() ->
bukkitScheduler.runTaskLater(GhastTools.getPlugin(), runnable, ticks));
}
return resultTask;
}
private ScheduleTask createSchedule(Runnable runnable) {
ExecutorService executorService;
JavaScheduleTask resultTask;
if (this.afterMs == null && this.everyMs == null) {
executorService = Executors.newSingleThreadExecutor(THREAD_FACTORY);
resultTask = new JavaScheduleTask(() -> executorService.submit(runnable));
} else if (this.everyMs != null) {
ScheduledExecutorService scheduledExecutorService
= Executors.newScheduledThreadPool(1, THREAD_FACTORY);
resultTask = new JavaScheduleTask(() ->
scheduledExecutorService.scheduleAtFixedRate(runnable,
this.afterMs != null ? this.afterMs : 0,
everyMs, TimeUnit.MILLISECONDS));
executorService = scheduledExecutorService;
} else {
ScheduledExecutorService scheduledExecutorService
= Executors.newScheduledThreadPool(1, THREAD_FACTORY);
resultTask = new JavaScheduleTask(() ->
scheduledExecutorService.schedule(runnable, afterMs, TimeUnit.MILLISECONDS));
executorService = scheduledExecutorService;
}
executorService.shutdown();
return resultTask;
}
}
}

View File

@@ -0,0 +1,10 @@
package ghast.scheduler;
public interface ScheduleTask {
void start();
boolean isCanceled();
void cancel();
}

View File

@@ -0,0 +1,289 @@
package ghast.database;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import ghast.GhastTools;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.bukkit.plugin.Plugin;
import org.h2.jdbcx.JdbcDataSource;
import org.junit.jupiter.api.*;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.text.MessageFormat;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.StringJoiner;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
class JdbcTemplateTest {
static final String JDBC_USER = "sa";
static final String JDBC_PASSWORD = "";
static final String JDBC_DB_NAME = "in_mem_db";
static final String JDBC_URL = "jdbc:h2:mem:" + JDBC_DB_NAME + ";DB_CLOSE_DELAY=-1";
static final String TABLE_NAME = "TEST_TABLE";
static final String COLUMN_ID = "ID";
static final String COLUMN_NAME = "C_NAME";
static final String COLUMN_VALUE = "C_VALUE";
static final Object[][] DATA = new Object[][]{
{ "Player 1", 100 }, { "Player 2", 250 },
{ "Player 3", 0 }, { "Player 4", 780 }
};
static DataSource dataSource;
JdbcTemplate jdbcTemplate;
@BeforeAll
static void beforeAll() {
Logger logger = Logger.getLogger(JdbcTemplateTest.class.getName());
Plugin mockPlugin = mock(Plugin.class);
when(mockPlugin.getLogger()).thenReturn(logger);
GhastTools.setPlugin(mockPlugin);
JdbcDataSource jdbcDataSource = new JdbcDataSource();
jdbcDataSource.setUser(JDBC_USER);
jdbcDataSource.setPassword(JDBC_PASSWORD);
jdbcDataSource.setURL(JDBC_URL);
dataSource = jdbcDataSource;
}
@BeforeEach
void before() {
jdbcTemplate = new JdbcTemplate(dataSource);
createTable();
String sql_head = MessageFormat.format("INSERT INTO {0} ({1}, {2}) VALUES ",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
StringJoiner sql_sj = new StringJoiner(", ");
for (Object[] datum : DATA) {
sql_sj.add(MessageFormat.format("( ''{0}'', {1} )", datum[0], datum[1]));
}
jdbcTemplate.execute(sql_head + sql_sj.toString());
}
@AfterEach
void after() {
dropTable();
}
@Test
void testQuery_Simple_Single() {
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
Integer value = jdbcTemplate.query(sql, rs -> {
if (rs.next()) {
return rs.getInt(1);
} else {
return null;
}
});
assertEquals(DATA[0][1], value);
}
@Test
void testQuery_Simple_Optional() {
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
Optional<Integer> optValue = jdbcTemplate.queryOne(sql, rs -> rs.getInt(1));
assertTrue(optValue.isPresent());
assertEquals(DATA[0][1], optValue.get());
}
@Test
void testQuery_Simple_List() {
String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}'' OR {1} LIKE ''{4}''",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0], DATA[1][0]);
List<Integer> listValues = jdbcTemplate.queryList(sql, (rs, rowNum) -> rs.getInt(1));
assertIterableEquals(Lists.newArrayList(DATA[0][1], DATA[1][1]), listValues);
}
@Test
void testQuery_Object_Single() {
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0} WHERE {1} LIKE ''{3}''",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
Player actualPlayer = jdbcTemplate.query(sql, rs -> {
if (rs.next()) {
Player player0 = new Player();
player0.name = rs.getString(COLUMN_NAME);
player0.value = rs.getInt(COLUMN_VALUE);
return player0;
} else {
return null;
}
});
Player expectedPlayer = new Player();
expectedPlayer.name = (String) DATA[0][0];
expectedPlayer.value = (int) DATA[0][1];
assertEquals(expectedPlayer, actualPlayer);
}
@Test
void testQuery_Object_List() {
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0}",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
List<Player> actualPlayers = jdbcTemplate.queryList(sql, (rs, num) -> {
Player player0 = new Player();
player0.name = rs.getString(COLUMN_NAME);
player0.value = rs.getInt(COLUMN_VALUE);
return player0;
});
List<Player> expectedPlayers = Stream.of(DATA)
.map(datum -> {
Player player1 = new Player();
player1.name = (String) datum[0];
player1.value = (int) datum[1];
return player1;
})
.collect(Collectors.toList());
assertIterableEquals(expectedPlayers, actualPlayers);
}
@Test
void testQueryForMap() {
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0} WHERE {1} LIKE ''{3}''",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
Map<String, Object> actualMap = jdbcTemplate.queryForMap(sql);
Map<String, Object> expectedMap = ImmutableMap.of(
COLUMN_NAME, DATA[0][0],
COLUMN_VALUE, DATA[0][1]);
assertIterableEquals(expectedMap.entrySet(), actualMap.entrySet());
}
@Test
void testQueryForMapList() {
String sql = MessageFormat.format("SELECT {1}, {2} FROM {0}",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
List<Map<String, Object>> actualMapList = jdbcTemplate.queryForMapList(sql);
List<Map<String, Object>> expectedMapList = Stream.of(DATA)
.map(datum -> ImmutableMap.of(COLUMN_NAME, datum[0], COLUMN_VALUE, datum[1]))
.collect(Collectors.toList());
assertIterableEquals(expectedMapList, actualMapList);
}
@Test
void testUpdate() {
String newName = "Player X";
String sql = MessageFormat.format("UPDATE {0} SET {1} = ''{3}'' WHERE {1} LIKE ''{2}''",
TABLE_NAME, COLUMN_NAME, DATA[0][0], newName);
int rows = jdbcTemplate.update(sql);
assertEquals(1, rows);
sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, newName);
Integer value = jdbcTemplate.query(sql, rs -> {
if (rs.next()) {
return rs.getInt(1);
} else {
return null;
}
});
assertEquals(DATA[0][1], value);
}
private void createTable() {
jdbcTemplate.execute("CREATE TABLE " + TABLE_NAME + " (" +
COLUMN_ID + " bigint auto_increment," +
COLUMN_NAME + " varchar(16)," +
COLUMN_VALUE + " integer)");
}
private void dropTable() {
jdbcTemplate.execute("DROP TABLE IF EXISTS " + TABLE_NAME);
}
class Player {
String name;
int value;
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof Player)) return false;
Player player = (Player) o;
return new EqualsBuilder().append(value, player.value).append(name, player.name).isEquals();
}
@Override
public int hashCode() {
return new HashCodeBuilder(17, 37).append(name).append(value).toHashCode();
}
}
@Nested
class JdbcTemplateTest_ExecuteTestCase {
@BeforeEach
void before() {
jdbcTemplate = new JdbcTemplate(dataSource);
dropTable();
}
@AfterEach
void after() {
dropTable();
}
@Test
void test() throws ClassNotFoundException, IllegalAccessException, InstantiationException, SQLException {
createTable();
//region Check result
Class.forName("org.h2.Driver").newInstance();
Connection connection = DriverManager.getConnection(JDBC_URL, JDBC_USER, JDBC_PASSWORD);
ResultSet resultSet = connection.getMetaData().getTables(JDBC_DB_NAME.toUpperCase(), "PUBLIC",
TABLE_NAME.toUpperCase(), new String[]{"TABLE"});
assertTrue(resultSet.next());
resultSet.close();
connection.close();
//endregion
}
}
}