From 9acb4d64dbf641601ac7085a41fdec78cb8f94c9 Mon Sep 17 00:00:00 2001
From: "Dylan K. Taylor" <dktapps@pmmp.io>
Date: Thu, 23 Feb 2023 21:45:12 +0000
Subject: [PATCH] Added generated constants for available BedrockData files
 this makes it easier to detect unused files, detect removed files, and also
 avoid typos in usages.

---
 .github/workflows/main.yml                    |   3 +
 build/generate-bedrockdata-path-consts.php    | 128 ++++++++++++++++++
 src/data/bedrock/BedrockDataFiles.php         |  54 ++++++++
 .../bedrock/LegacyBiomeIdToStringIdMap.php    |   3 +-
 .../bedrock/LegacyEntityIdToStringIdMap.php   |   3 +-
 src/network/mcpe/cache/StaticPacketCache.php  |   6 +-
 .../mcpe/convert/GlobalItemTypeDictionary.php |   4 +-
 src/network/mcpe/convert/ItemTranslator.php   |   4 +-
 .../mcpe/convert/RuntimeBlockMapping.php      |   6 +-
 9 files changed, 197 insertions(+), 14 deletions(-)
 create mode 100644 build/generate-bedrockdata-path-consts.php
 create mode 100644 src/data/bedrock/BedrockDataFiles.php

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index ad9fc56ec..029676a3f 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -186,6 +186,9 @@ jobs:
       - name: Regenerate KnownTranslation APIs
         run: php build/generate-known-translation-apis.php
 
+      - name: Regenerate BedrockData available files constants
+        run: php build/generate-bedrockdata-path-consts.php
+
       - name: Verify code is unchanged
         run: |
           git diff
diff --git a/build/generate-bedrockdata-path-consts.php b/build/generate-bedrockdata-path-consts.php
new file mode 100644
index 000000000..31e23c9b6
--- /dev/null
+++ b/build/generate-bedrockdata-path-consts.php
@@ -0,0 +1,128 @@
+<?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\build\generate_bedrockdata_path_consts;
+
+use Webmozart\PathUtil\Path;
+use function dirname;
+use function fclose;
+use function fopen;
+use function fwrite;
+use function is_file;
+use function scandir;
+use function str_replace;
+use function strtoupper;
+use const PHP_EOL;
+use const pocketmine\BEDROCK_DATA_PATH;
+use const SCANDIR_SORT_ASCENDING;
+use const STDERR;
+
+require dirname(__DIR__) . '/vendor/autoload.php';
+
+function constantify(string $permissionName) : string{
+	return strtoupper(str_replace([".", "-"], "_", $permissionName));
+}
+
+$files = scandir(BEDROCK_DATA_PATH, SCANDIR_SORT_ASCENDING);
+if($files === false){
+	fwrite(STDERR, "Couldn't find any files in " . BEDROCK_DATA_PATH . PHP_EOL);
+	exit(1);
+}
+
+$consts = [];
+
+foreach($files as $file){
+	if($file === '.' || $file === '..'){
+		continue;
+	}
+	if($file[0] === '.'){
+		continue;
+	}
+	$path = Path::join(BEDROCK_DATA_PATH, $file);
+	if(!is_file($path)){
+		continue;
+	}
+
+	foreach([
+		'README.md',
+		'LICENSE',
+		'composer.json',
+	] as $ignored){
+		if($file === $ignored){
+			continue 2;
+		}
+	}
+
+	$consts[] = $file;
+}
+
+$output = fopen(dirname(__DIR__) . '/src/data/bedrock/BedrockDataFiles.php', 'wb');
+if($output === false){
+	fwrite(STDERR, "Couldn't open output file" . PHP_EOL);
+	exit(1);
+}
+fwrite($output, <<<'HEADER'
+<?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\data\bedrock;
+
+use const pocketmine\BEDROCK_DATA_PATH;
+
+final class BedrockDataFiles{
+	private function __construct(){
+		//NOOP
+	}
+
+
+HEADER
+);
+
+foreach($consts as $constName => $fileName){
+	fwrite($output, "\tpublic const " . constantify($fileName) . " = BEDROCK_DATA_PATH . '/$fileName';\n");
+}
+
+fwrite($output, "}\n");
+fclose($output);
+
+echo "Done. Don't forget to run CS fixup after generating code.\n";
diff --git a/src/data/bedrock/BedrockDataFiles.php b/src/data/bedrock/BedrockDataFiles.php
new file mode 100644
index 000000000..731c91120
--- /dev/null
+++ b/src/data/bedrock/BedrockDataFiles.php
@@ -0,0 +1,54 @@
+<?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\data\bedrock;
+
+use const pocketmine\BEDROCK_DATA_PATH;
+
+final class BedrockDataFiles{
+	private function __construct(){
+		//NOOP
+	}
+
+	public const BANNER_PATTERNS_JSON = BEDROCK_DATA_PATH . '/banner_patterns.json';
+	public const BIOME_DEFINITIONS_NBT = BEDROCK_DATA_PATH . '/biome_definitions.nbt';
+	public const BIOME_DEFINITIONS_FULL_NBT = BEDROCK_DATA_PATH . '/biome_definitions_full.nbt';
+	public const BIOME_ID_MAP_JSON = BEDROCK_DATA_PATH . '/biome_id_map.json';
+	public const BLOCK_ID_MAP_JSON = BEDROCK_DATA_PATH . '/block_id_map.json';
+	public const BLOCK_ID_TO_ITEM_ID_MAP_JSON = BEDROCK_DATA_PATH . '/block_id_to_item_id_map.json';
+	public const BLOCK_STATE_META_MAP_JSON = BEDROCK_DATA_PATH . '/block_state_meta_map.json';
+	public const CANONICAL_BLOCK_STATES_NBT = BEDROCK_DATA_PATH . '/canonical_block_states.nbt';
+	public const COMMAND_ARG_TYPES_JSON = BEDROCK_DATA_PATH . '/command_arg_types.json';
+	public const CREATIVEITEMS_JSON = BEDROCK_DATA_PATH . '/creativeitems.json';
+	public const ENTITY_ID_MAP_JSON = BEDROCK_DATA_PATH . '/entity_id_map.json';
+	public const ENTITY_IDENTIFIERS_NBT = BEDROCK_DATA_PATH . '/entity_identifiers.nbt';
+	public const ITEM_ID_MAP_JSON = BEDROCK_DATA_PATH . '/item_id_map.json';
+	public const ITEM_TAGS_JSON = BEDROCK_DATA_PATH . '/item_tags.json';
+	public const LEVEL_SOUND_ID_MAP_JSON = BEDROCK_DATA_PATH . '/level_sound_id_map.json';
+	public const PARTICLE_ID_MAP_JSON = BEDROCK_DATA_PATH . '/particle_id_map.json';
+	public const R12_BLOCK_STATES_JSON = BEDROCK_DATA_PATH . '/r12_block_states.json';
+	public const R12_TO_CURRENT_BLOCK_MAP_BIN = BEDROCK_DATA_PATH . '/r12_to_current_block_map.bin';
+	public const R16_TO_CURRENT_ITEM_MAP_JSON = BEDROCK_DATA_PATH . '/r16_to_current_item_map.json';
+	public const RECIPES_JSON = BEDROCK_DATA_PATH . '/recipes.json';
+	public const REQUIRED_ITEM_LIST_JSON = BEDROCK_DATA_PATH . '/required_item_list.json';
+}
diff --git a/src/data/bedrock/LegacyBiomeIdToStringIdMap.php b/src/data/bedrock/LegacyBiomeIdToStringIdMap.php
index eba0034e8..0490f4abe 100644
--- a/src/data/bedrock/LegacyBiomeIdToStringIdMap.php
+++ b/src/data/bedrock/LegacyBiomeIdToStringIdMap.php
@@ -24,12 +24,11 @@ declare(strict_types=1);
 namespace pocketmine\data\bedrock;
 
 use pocketmine\utils\SingletonTrait;
-use Symfony\Component\Filesystem\Path;
 
 final class LegacyBiomeIdToStringIdMap extends LegacyToStringBidirectionalIdMap{
 	use SingletonTrait;
 
 	public function __construct(){
-		parent::__construct(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'biome_id_map.json'));
+		parent::__construct(BedrockDataFiles::BIOME_ID_MAP_JSON);
 	}
 }
diff --git a/src/data/bedrock/LegacyEntityIdToStringIdMap.php b/src/data/bedrock/LegacyEntityIdToStringIdMap.php
index 8427e4594..0b5b014d0 100644
--- a/src/data/bedrock/LegacyEntityIdToStringIdMap.php
+++ b/src/data/bedrock/LegacyEntityIdToStringIdMap.php
@@ -24,12 +24,11 @@ declare(strict_types=1);
 namespace pocketmine\data\bedrock;
 
 use pocketmine\utils\SingletonTrait;
-use Symfony\Component\Filesystem\Path;
 
 final class LegacyEntityIdToStringIdMap extends LegacyToStringBidirectionalIdMap{
 	use SingletonTrait;
 
 	public function __construct(){
-		parent::__construct(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'entity_id_map.json'));
+		parent::__construct(BedrockDataFiles::ENTITY_ID_MAP_JSON);
 	}
 }
diff --git a/src/network/mcpe/cache/StaticPacketCache.php b/src/network/mcpe/cache/StaticPacketCache.php
index 4cf878fc3..88a522600 100644
--- a/src/network/mcpe/cache/StaticPacketCache.php
+++ b/src/network/mcpe/cache/StaticPacketCache.php
@@ -23,13 +23,13 @@ declare(strict_types=1);
 
 namespace pocketmine\network\mcpe\cache;
 
+use pocketmine\data\bedrock\BedrockDataFiles;
 use pocketmine\network\mcpe\protocol\AvailableActorIdentifiersPacket;
 use pocketmine\network\mcpe\protocol\BiomeDefinitionListPacket;
 use pocketmine\network\mcpe\protocol\serializer\NetworkNbtSerializer;
 use pocketmine\network\mcpe\protocol\types\CacheableNbt;
 use pocketmine\utils\Filesystem;
 use pocketmine\utils\SingletonTrait;
-use Symfony\Component\Filesystem\Path;
 
 class StaticPacketCache{
 	use SingletonTrait;
@@ -43,8 +43,8 @@ class StaticPacketCache{
 
 	private static function make() : self{
 		return new self(
-			BiomeDefinitionListPacket::create(self::loadCompoundFromFile(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'biome_definitions.nbt'))),
-			AvailableActorIdentifiersPacket::create(self::loadCompoundFromFile(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'entity_identifiers.nbt')))
+			BiomeDefinitionListPacket::create(self::loadCompoundFromFile(BedrockDataFiles::BIOME_DEFINITIONS_NBT)),
+			AvailableActorIdentifiersPacket::create(self::loadCompoundFromFile(BedrockDataFiles::ENTITY_IDENTIFIERS_NBT))
 		);
 	}
 
diff --git a/src/network/mcpe/convert/GlobalItemTypeDictionary.php b/src/network/mcpe/convert/GlobalItemTypeDictionary.php
index 0795d2fde..a5a00235d 100644
--- a/src/network/mcpe/convert/GlobalItemTypeDictionary.php
+++ b/src/network/mcpe/convert/GlobalItemTypeDictionary.php
@@ -23,12 +23,12 @@ declare(strict_types=1);
 
 namespace pocketmine\network\mcpe\convert;
 
+use pocketmine\data\bedrock\BedrockDataFiles;
 use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
 use pocketmine\network\mcpe\protocol\types\ItemTypeEntry;
 use pocketmine\utils\AssumptionFailedError;
 use pocketmine\utils\Filesystem;
 use pocketmine\utils\SingletonTrait;
-use Symfony\Component\Filesystem\Path;
 use function is_array;
 use function is_bool;
 use function is_int;
@@ -39,7 +39,7 @@ final class GlobalItemTypeDictionary{
 	use SingletonTrait;
 
 	private static function make() : self{
-		$data = Filesystem::fileGetContents(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'required_item_list.json'));
+		$data = Filesystem::fileGetContents(BedrockDataFiles::REQUIRED_ITEM_LIST_JSON);
 		$table = json_decode($data, true);
 		if(!is_array($table)){
 			throw new AssumptionFailedError("Invalid item list format");
diff --git a/src/network/mcpe/convert/ItemTranslator.php b/src/network/mcpe/convert/ItemTranslator.php
index 375199601..8342db61f 100644
--- a/src/network/mcpe/convert/ItemTranslator.php
+++ b/src/network/mcpe/convert/ItemTranslator.php
@@ -23,13 +23,13 @@ declare(strict_types=1);
 
 namespace pocketmine\network\mcpe\convert;
 
+use pocketmine\data\bedrock\BedrockDataFiles;
 use pocketmine\data\bedrock\LegacyItemIdToStringIdMap;
 use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
 use pocketmine\utils\AssumptionFailedError;
 use pocketmine\utils\Filesystem;
 use pocketmine\utils\SingletonTrait;
 use pocketmine\utils\Utils;
-use Symfony\Component\Filesystem\Path;
 use function array_key_exists;
 use function is_array;
 use function is_numeric;
@@ -67,7 +67,7 @@ final class ItemTranslator{
 	private array $complexNetToCoreMapping = [];
 
 	private static function make() : self{
-		$data = Filesystem::fileGetContents(Path::join(\pocketmine\BEDROCK_DATA_PATH, 'r16_to_current_item_map.json'));
+		$data = Filesystem::fileGetContents(BedrockDataFiles::R16_TO_CURRENT_ITEM_MAP_JSON);
 		$json = json_decode($data, true);
 		if(!is_array($json) || !isset($json["simple"], $json["complex"]) || !is_array($json["simple"]) || !is_array($json["complex"])){
 			throw new AssumptionFailedError("Invalid item table format");
diff --git a/src/network/mcpe/convert/RuntimeBlockMapping.php b/src/network/mcpe/convert/RuntimeBlockMapping.php
index 53b146be6..b7c78a20b 100644
--- a/src/network/mcpe/convert/RuntimeBlockMapping.php
+++ b/src/network/mcpe/convert/RuntimeBlockMapping.php
@@ -25,6 +25,7 @@ namespace pocketmine\network\mcpe\convert;
 
 use pocketmine\block\Block;
 use pocketmine\block\BlockLegacyIds;
+use pocketmine\data\bedrock\BedrockDataFiles;
 use pocketmine\data\bedrock\LegacyBlockIdToStringIdMap;
 use pocketmine\nbt\tag\CompoundTag;
 use pocketmine\network\mcpe\protocol\serializer\NetworkNbtSerializer;
@@ -32,7 +33,6 @@ use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
 use pocketmine\network\mcpe\protocol\serializer\PacketSerializerContext;
 use pocketmine\utils\Filesystem;
 use pocketmine\utils\SingletonTrait;
-use Symfony\Component\Filesystem\Path;
 
 /**
  * @internal
@@ -49,8 +49,8 @@ final class RuntimeBlockMapping{
 
 	private static function make() : self{
 		return new self(
-			Path::join(\pocketmine\BEDROCK_DATA_PATH, "canonical_block_states.nbt"),
-			Path::join(\pocketmine\BEDROCK_DATA_PATH, "r12_to_current_block_map.bin")
+			BedrockDataFiles::CANONICAL_BLOCK_STATES_NBT,
+			BedrockDataFiles::R12_TO_CURRENT_BLOCK_MAP_BIN
 		);
 	}