Merge branch 'feature/messages' into develop

README.MD

@@ -18,7 +18,7 @@ _Основан на версии Bukkit API 1.12._
 8. [JdbcTemplate](#jdbctemplate)
 9. [ScheduleManager](#schedulemanager)
 10. [ScheduleTask](#scheduletask)
-11. [I18n](#i18n)
+11. [Messages](#messages)
 12. [XLog](#xlog)
 13. [Подключение](#подключение)
     1. [Gradle](#gradle)
@@ -62,6 +62,15 @@ YamlConfiguration config = GhastTools.loadConfig(false);
 Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина,
 будет загруден исключительно встроенный файл настроек.
 
+### copyLocation
+
+Копирования объекта `Location`
+
+```java
+Location location = ...;
+Location copyLoc = GhastTools.copyLocation(location); 
+```
+
 ## AssetsManager
 
 Методы по работе с файлами плагина (_"ассетами"_).
@@ -110,11 +119,45 @@ _По-умолчанию равен `StandardCharsets.UTF_8`_
 
 ### placeSkull
 
+Установка черепа.
+
 ```java
 Location location = ...;
-Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH)
+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
@@ -489,91 +532,110 @@ ScheduleTask scheduleTask = ...;
 scheduleTask.cancel();
 ```
 
-## I18n
+## Messages
 
-Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле.
+Инструмент для работы с параметизированными сообщениями или просто сообщениями, которые храняться в отдельном файле.
 
-Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`.
+Параметизированные сообщения имеют следующий вид: `Привет, {player}!`.
 
-### loadMessages
+### load
 
 Загрузка сообщений в инструмент.
 
-Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`).
+Есть три варианта: через `Properties`
 
 ```java
-Map<String, String> messagesMap = ...;
+Properties properties = ...;
-I18n.loadMessages(messagesMap);
+Messages.load(properties);
 ```
 
+через `Map<String, String>`
+
 ```java
-Reader reader = AssetsManager.getAsReader("messages.properties");
+Map<String, String> map = ...;
-I18n.loadMessages(reader);
+Messages.load(map);
 ```
 
-В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en".
+через `Reader`
 
 ```java
-Map<String, String> enMessagesMap = ...;
+Reader reader = ...;
-Map<String, String> ruMessagesMap = ...;
+Messages.load(reader);
-
-I18n.loadMessages("en", enMessagesMap);
-I18n.loadMessages("ru", ruMessagesMap);
 ```
 
-```java
+Следует учесть, про при работе через `Reader`, **Messages** ожидает там обнаружить список строк в формате `key=value`.
-Reader readerEn = AssetsManager.getAsReader("messages.properties");
-Reader readerRu = AssetsManager.getAsReader("messages.ru.properties");
-
-I18n.loadMessages("en", readerEn);
-I18n.loadMessages("ru", readerRu);
-```
 
 ### get
 
-Получение сообщения по его ключу.  
+Получение обычноего или параметизированного сообщения.
 
-```java
+Для примера, пусть у нас будут такие сообщения:
-String msg = I18n.get("player.join.msg");
+
+```properties
+simple=Простое сообщение
+welcome=Приветствуем, {player}!
 ```
 
-Если следующим сообщением указать `Map<String, Object>`, то можно будет воспользоваться шаблонизатором.
+Для получения простого сообщения, просто указываем его ключ:
 
 ```java
-Map<String, String> messagesMap = new HashMap<>();
+String message = Messages.get("simple");
-messagesMap.put("player.join.msg", "Привет, {player}!");
+// Простое сообщение
-
-I18n.loadMessages(messagesMap);
-
-Map<String, String> params = new HashMap<>();
-params.put("player", event.getPlayer().getName());
-
-String msg = I18n.get("player.join.msg", params);
 ```
 
-Однако можно создавать `Map<String, String> params` явно, а воспользоваться [paramBuilder()](#parambuilder)
+Для получения параметизированного сообщения, нужно помимо ключа передать параметры.
+Есть два способа: через `Map<String, Object>`
 
 ```java
-String msg = I18n.get("player.join.msg", I18n.paramBuilder()
+Map<String, Object> = map = new HashMap<>(1);
-        .add("player", event.getPlayer().getName())
+map.put("player", "David");
-        .build());
+
+String message = Messages.get("welcome", map);
+// Приветствуем, David!
 ```
 
-Можно первым параметром указать код языка.
+через попарное перечисление параметров
 
 ```java
-String msg = I18n.get("ru", "player.join.msg");
+String message = Messages.get("welcome", "player", "David");
+// Приветствуем, David!
 ```
 
-### paramBuilder
+Если по указанному ключу сообщение отсутствует, то **Messages** вернёт значение самого ключа
-
-Инструмент для параметизирования шаблонов сообщений.
 
 ```java
-Map<String, Object> params = I18n.paramBuilder()
+String message = Messages.get("not_exists_key");
-        .add("player", event.getPlayer().getName())
+// not_exists_key
-        .build();
+
-String msg = I18n.get("player.join.msg", params);
+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

build.gradle

@@ -29,8 +29,7 @@ ext {
             ]],
             commons_text: 'org.apache.commons:commons-text:1.9',
             lombok: 'org.projectlombok:lombok:1.18.12',
-            reflection_object: 'ru.dmitriymx:reflection-object:1.0-BETA',
+            reflection_object: 'ru.dmitriymx:reflection-object:1.2',
-            mysql: 'mysql:mysql-connector-java:8.0.22',
             test: [
                     junit5: [
                             "org.junit.jupiter:junit-jupiter-api:$junitVersion",
@@ -66,7 +65,6 @@ dependencies {
     annotationProcessor libs.lombok
 
     compileOnly2 libs.bukkit
-    compileOnly libs.mysql
     implementation libs.commons_text
     implementation libs.reflection_object
 

src/main/java/ghast/BuildHelper.java

@@ -3,26 +3,111 @@ package ghast;
 import lombok.experimental.UtilityClass;
 import org.bukkit.Location;
 import org.bukkit.Material;
+import org.bukkit.SkullType;
 import org.bukkit.block.Block;
 import org.bukkit.block.BlockFace;
 import org.bukkit.block.Sign;
 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
 @SuppressWarnings("unused")
 public class BuildHelper {
 
+    private final Class<?> CLASS_BLOCKPOSITION = getClassForName("net.minecraft.server.v1_12_R1.BlockPosition");
+    private final Class<?> CLASS_GAMEPROFILE = getClassForName("com.mojang.authlib.GameProfile");
+
+    /**
+     * Установка черепа.
+     * <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);
+
         Block block = location.getWorld().getBlockAt(location);
         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 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);
@@ -33,4 +118,30 @@ public class BuildHelper {
 
         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);
+        }
+    }
 }

src/main/java/ghast/GhastTools.java

@@ -2,6 +2,7 @@ package ghast;
 
 import ghast.assets.AssetsManager;
 import lombok.experimental.UtilityClass;
+import org.bukkit.Location;
 import org.bukkit.configuration.file.YamlConfiguration;
 import org.bukkit.plugin.Plugin;
 
@@ -15,16 +16,10 @@ public class GhastTools {
 
     private static WeakReference<Plugin> refPlugin;
 
-	@SuppressWarnings("java:S2696")
     public void setPlugin(Plugin plugin) {
-		if (plugin == null) {
+        refPlugin = plugin == null ? null : new WeakReference<>(plugin);
-			refPlugin = null;
-		} else {
-			refPlugin = new WeakReference<>(plugin);
-		}
     }
 
-	@SuppressWarnings("java:S112")
     public Plugin getPlugin() {
         if (refPlugin == null) {
             throw new RuntimeException("Plugin not set.");
@@ -38,7 +33,6 @@ public class GhastTools {
         return plugin;
     }
 
-	@SuppressWarnings("java:S112")
     public YamlConfiguration loadConfig(boolean saveDefault) {
         if (saveDefault) {
             getPlugin().saveDefaultConfig();
@@ -54,4 +48,8 @@ public class GhastTools {
     public YamlConfiguration loadConfig() {
         return loadConfig(true);
     }
+
+    public Location copyLocation(Location location) {
+        return new Location(location.getWorld(), location.getX(), location.getY(), location.getZ());
+    }
 }

src/main/java/ghast/I18n.java

@@ -14,15 +14,18 @@ import java.io.Reader;
 import java.util.HashMap;
 import java.util.Map;
 
+/**
+ * @deprecated use {@link Messages}
+ */
 @UtilityClass
 @SuppressWarnings("unused")
+@Deprecated
 public class I18n {
 
     private final String DEFAULT_LANG = "en";
     private final Table<String/*Lang*/, String/*Key*/, String/*Template|Message*/> messagesMap = HashBasedTable.create();
 
     //region Load messages
-	@SuppressWarnings("java:S112")
     public void loadMessages(String lang, Reader reader) {
         Map<String, String> map = messagesMap.row(lang.toLowerCase());
 

src/main/java/ghast/Messages.java

@@ -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;
+	}
+}

src/main/java/ghast/command/CommandWrapper.java

@@ -46,7 +46,6 @@ class CommandWrapper extends BukkitCommand {
     }
 
     @Override
-	@SuppressWarnings("java:S1066")
     public boolean execute(CommandSender commandSender, String commandName, String[] args) {
         if (Boolean.TRUE.equals(onlyPlayer)) {
             if (!(commandSender instanceof Player)) {

src/main/java/ghast/database/DataAccessException.java

@@ -2,7 +2,6 @@ package ghast.database;
 
 import lombok.Getter;
 
-@SuppressWarnings("java:S1165")
 @Getter
 public class DataAccessException extends RuntimeException {