LegacyStringToItemParser.php

<?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\item;
 
use pocketmine\data\bedrock\item\ItemDeserializer;
use pocketmine\data\bedrock\item\ItemTypeDeserializeException;
use pocketmine\data\bedrock\item\upgrade\ItemDataUpgrader;
use pocketmine\utils\AssumptionFailedError;
use pocketmine\utils\Filesystem;
use pocketmine\utils\SingletonTrait;
use pocketmine\utils\Utils;
use pocketmine\world\format\io\GlobalItemDataHandlers;
use Symfony\Component\Filesystem\Path;
use function explode;
use function is_array;
use function is_numeric;
use function is_string;
use function json_decode;
use function str_replace;
use function strtolower;
use function trim;
 
final class LegacyStringToItemParser{
    use SingletonTrait;
 
    private static function make() : self{
        $result = new self(
            GlobalItemDataHandlers::getUpgrader(),
            GlobalItemDataHandlers::getDeserializer()
        );
 
        $mappingsRaw = Filesystem::fileGetContents(Path::join(\pocketmine\RESOURCE_PATH, 'item_from_string_bc_map.json'));
 
        $mappings = json_decode($mappingsRaw, true);
        if(!is_array($mappings)) throw new AssumptionFailedError("Invalid mappings format, expected array");
 
        foreach(Utils::promoteKeys($mappings) as $name => $id){
            if(!is_string($id)) throw new AssumptionFailedError("Invalid mappings format, expected string values");
            $result->addMapping((string) $name, $id);
        }
 
        return $result;
    }
 
    private array $map = [];
 
    public function __construct(
        private ItemDataUpgrader $itemDataUpgrader,
        private ItemDeserializer $itemDeserializer
    ){}
 
    public function addMapping(string $alias, string $id) : void{
        $this->map[$alias] = $id;
    }
 
    public function getMappings() : array{
        return $this->map;
    }
 
    public function parse(string $input) : Item{
        $key = $this->reprocess($input);
        //TODO: this should be limited to 2 parts, but 3 preserves old behaviour when given a string like 351:4:1
        $b = explode(":", $key, limit: 3);
 
        if(!isset($b[1])){
            $meta = 0;
        }elseif(is_numeric($b[1])){
            $meta = (int) $b[1];
        }else{
            throw new LegacyStringToItemParserException("Unable to parse \"" . $b[1] . "\" from \"" . $input . "\" as a valid meta value");
        }
 
        $lower = strtolower($b[0]);
        if($lower === "0" || $lower === "air"){
            //item deserializer doesn't recognize air items since they aren't supposed to exist
            return VanillaItems::AIR();
        }
 
        $legacyId = $this->map[$lower] ?? null;
        if($legacyId === null){
            throw new LegacyStringToItemParserException("Unable to resolve \"" . $input . "\" to a valid item");
        }
        $itemData = $this->itemDataUpgrader->upgradeItemTypeDataString($legacyId, $meta, 1, null);
 
        try{
            return $this->itemDeserializer->deserializeStack($itemData);
        }catch(ItemTypeDeserializeException $e){
            throw new LegacyStringToItemParserException($e->getMessage(), 0, $e);
        }
    }
 
    protected function reprocess(string $input) : string{
        return str_replace([" ", "minecraft:"], ["_", ""], trim($input));
    }
}