Move player data storage handling behind an interface

src/player/DatFilePlayerDataProvider.php

@@ -0,0 +1,99 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\player;
+
+use pocketmine\errorhandler\ErrorToExceptionHandler;
+use pocketmine\nbt\BigEndianNbtSerializer;
+use pocketmine\nbt\NbtDataException;
+use pocketmine\nbt\tag\CompoundTag;
+use pocketmine\nbt\TreeRoot;
+use pocketmine\player;
+use pocketmine\utils\Filesystem;
+use pocketmine\utils\Utils;
+use Symfony\Component\Filesystem\Path;
+use function file_exists;
+use function file_get_contents;
+use function rename;
+use function strtolower;
+use function zlib_decode;
+use function zlib_encode;
+use const ZLIB_ENCODING_GZIP;
+
+final class DatFilePlayerDataProvider implements player\PlayerDataProvider{
+
+	public function __construct(
+		private string $path
+	){}
+
+	private function getPlayerDataPath(string $username) : string{
+		return Path::join($this->path, strtolower($username) . '.dat');
+	}
+
+	private function handleCorruptedPlayerData(string $name) : void{
+		$path = $this->getPlayerDataPath($name);
+		rename($path, $path . '.bak');
+	}
+
+	public function hasData(string $name) : bool{
+		return file_exists($this->getPlayerDataPath($name));
+	}
+
+	public function loadData(string $name) : ?CompoundTag{
+		$name = strtolower($name);
+		$path = $this->getPlayerDataPath($name);
+
+		if(!file_exists($path)){
+			return null;
+		}
+
+		try{
+			$contents = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => file_get_contents($path));
+		}catch(\ErrorException $e){
+			throw new PlayerDataLoadException("Failed to read player data file \"$path\": " . $e->getMessage(), 0, $e);
+		}
+		try{
+			$decompressed = ErrorToExceptionHandler::trapAndRemoveFalse(fn() => zlib_decode($contents));
+		}catch(\ErrorException $e){
+			$this->handleCorruptedPlayerData($name);
+			throw new PlayerDataLoadException("Failed to decompress raw player data for \"$name\": " . $e->getMessage(), 0, $e);
+		}
+
+		try{
+			return (new BigEndianNbtSerializer())->read($decompressed)->mustGetCompoundTag();
+		}catch(NbtDataException $e){ //corrupt data
+			$this->handleCorruptedPlayerData($name);
+			throw new PlayerDataLoadException("Failed to decode NBT data for \"$name\": " . $e->getMessage(), 0, $e);
+		}
+	}
+
+	public function saveData(string $name, CompoundTag $data) : void{
+		$nbt = new BigEndianNbtSerializer();
+		$contents = Utils::assumeNotFalse(zlib_encode($nbt->write(new TreeRoot($data)), ZLIB_ENCODING_GZIP), "zlib_encode() failed unexpectedly");
+		try{
+			Filesystem::safeFilePutContents($this->getPlayerDataPath($name), $contents);
+		}catch(\RuntimeException $e){
+			throw new PlayerDataSaveException("Failed to write player data file: " . $e->getMessage(), 0, $e);
+		}
+	}
+}

src/player/PlayerDataLoadException.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\player;
+
+final class PlayerDataLoadException extends \RuntimeException{
+
+}

src/player/PlayerDataProvider.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\player;
+
+use pocketmine\nbt\tag\CompoundTag;
+
+/**
+ * Handles storage of player data. Implementations must treat player names in a case-insensitive manner.
+ */
+interface PlayerDataProvider{
+
+	/**
+	 * Returns whether there are any data associated with the given player name.
+	 */
+	public function hasData(string $name) : bool;
+
+	/**
+	 * Returns the data associated with the given player name, or null if there is no data.
+	 * TODO: we need an async version of this
+	 *
+	 * @throws PlayerDataLoadException
+	 */
+	public function loadData(string $name) : ?CompoundTag;
+
+	/**
+	 * Saves data for the give player name.
+	 *
+	 * @throws PlayerDataSaveException
+	 */
+	public function saveData(string $name, CompoundTag $data) : void;
+}

src/player/PlayerDataSaveException.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+ */
+
+declare(strict_types=1);
+
+namespace pocketmine\player;
+
+final class PlayerDataSaveException extends \RuntimeException{
+
+}