ItemTranslator.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\network\mcpe\convert;
 
use pocketmine\data\bedrock\item\BlockItemIdMap;
use pocketmine\data\bedrock\item\ItemDeserializer;
use pocketmine\data\bedrock\item\ItemSerializer;
use pocketmine\data\bedrock\item\ItemTypeDeserializeException;
use pocketmine\data\bedrock\item\ItemTypeSerializeException;
use pocketmine\data\bedrock\item\SavedItemData;
use pocketmine\item\Item;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\network\mcpe\protocol\serializer\ItemTypeDictionary;
use pocketmine\utils\AssumptionFailedError;
 
final class ItemTranslator{
    public const NO_BLOCK_RUNTIME_ID = 0; //this is technically a valid block runtime ID, but is used to represent "no block" (derp mojang)
 
    public function __construct(
        private ItemTypeDictionary $itemTypeDictionary,
        private BlockStateDictionary $blockStateDictionary,
        private ItemSerializer $itemSerializer,
        private ItemDeserializer $itemDeserializer,
        private BlockItemIdMap $blockItemIdMap
    ){}
 
    public function toNetworkIdQuiet(Item $item) : ?array{
        try{
            return $this->toNetworkId($item);
        }catch(ItemTypeSerializeException){
            return null;
        }
    }
 
    public function toNetworkId(Item $item) : array{
        //TODO: we should probably come up with a cache for this
 
        $itemData = $this->itemSerializer->serializeType($item);
 
        $numericId = $this->itemTypeDictionary->fromStringId($itemData->getName());
        $blockStateData = $itemData->getBlock();
 
        if($blockStateData !== null){
            $blockRuntimeId = $this->blockStateDictionary->lookupStateIdFromData($blockStateData);
            if($blockRuntimeId === null){
                throw new AssumptionFailedError("Unmapped blockstate returned by blockstate serializer: " . $blockStateData->toNbt());
            }
        }else{
            $blockRuntimeId = null;
        }
 
        return [$numericId, $itemData->getMeta(), $blockRuntimeId];
    }
 
    public function toNetworkNbt(Item $item) : CompoundTag{
        //TODO: this relies on the assumption that network item NBT is the same as disk item NBT, which may not always
        //be true - if we stick on an older world version while updating network version, this could be a problem (and
        //may be a problem for multi version implementations)
        return $this->itemSerializer->serializeStack($item)->toNbt();
    }
 
    public function fromNetworkId(int $networkId, int $networkMeta, int $networkBlockRuntimeId) : Item{
        try{
            $stringId = $this->itemTypeDictionary->fromIntId($networkId);
        }catch(\InvalidArgumentException $e){
            //TODO: a quiet version of fromIntId() would be better than catching InvalidArgumentException
            throw TypeConversionException::wrap($e, "Invalid network itemstack ID $networkId");
        }
 
        $blockStateData = null;
        if($this->blockItemIdMap->lookupBlockId($stringId) !== null){
            $blockStateData = $this->blockStateDictionary->generateDataFromStateId($networkBlockRuntimeId);
            if($blockStateData === null){
                throw new TypeConversionException("Blockstate runtimeID $networkBlockRuntimeId does not correspond to any known blockstate");
            }
        }elseif($networkBlockRuntimeId !== self::NO_BLOCK_RUNTIME_ID){
            throw new TypeConversionException("Item $stringId is not a blockitem, but runtime ID $networkBlockRuntimeId was provided");
        }
 
        try{
            return $this->itemDeserializer->deserializeType(new SavedItemData($stringId, $networkMeta, $blockStateData));
        }catch(ItemTypeDeserializeException $e){
            throw TypeConversionException::wrap($e, "Invalid network itemstack data");
        }
    }
}