ResourcePacksPacketHandler.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\handler;
 
use pocketmine\lang\KnownTranslationFactory;
use pocketmine\network\mcpe\NetworkSession;
use pocketmine\network\mcpe\protocol\ProtocolInfo;
use pocketmine\network\mcpe\protocol\ResourcePackChunkDataPacket;
use pocketmine\network\mcpe\protocol\ResourcePackChunkRequestPacket;
use pocketmine\network\mcpe\protocol\ResourcePackClientResponsePacket;
use pocketmine\network\mcpe\protocol\ResourcePackDataInfoPacket;
use pocketmine\network\mcpe\protocol\ResourcePacksInfoPacket;
use pocketmine\network\mcpe\protocol\ResourcePackStackPacket;
use pocketmine\network\mcpe\protocol\types\Experiments;
use pocketmine\network\mcpe\protocol\types\resourcepacks\ResourcePackInfoEntry;
use pocketmine\network\mcpe\protocol\types\resourcepacks\ResourcePackStackEntry;
use pocketmine\network\mcpe\protocol\types\resourcepacks\ResourcePackType;
use pocketmine\network\PacketHandlingException;
use pocketmine\resourcepacks\ResourcePack;
use Ramsey\Uuid\Uuid;
use function array_keys;
use function array_map;
use function ceil;
use function count;
use function implode;
use function sprintf;
use function strpos;
use function strtolower;
use function substr;
 
class ResourcePacksPacketHandler extends PacketHandler{
    private const PACK_CHUNK_SIZE = 256 * 1024; //256KB
 
    private const MAX_CONCURRENT_CHUNK_REQUESTS = 1;
 
    private const CHEMISTRY_RESOURCE_PACKS = [
        ["b41c2785-c512-4a49-af56-3a87afd47c57", "1.21.30"],
        ["a4df0cb3-17be-4163-88d7-fcf7002b935d", "1.21.20"],
        ["d19adffe-a2e1-4b02-8436-ca4583368c89", "1.21.10"],
        ["85d5603d-2824-4b21-8044-34f441f4fce1", "1.21.0"],
        ["e977cd13-0a11-4618-96fb-03dfe9c43608", "1.20.60"],
        ["0674721c-a0aa-41a1-9ba8-1ed33ea3e7ed", "1.20.50"],
        ["0fba4063-dba1-4281-9b89-ff9390653530", "1.0.0"],
    ];
 
    private array $resourcePacksByPrintableId = [];
 
    private bool $requestedMetadata = false;
    private bool $requestedStack = false;
 
    private array $downloadedChunks = [];
 
    private \SplQueue $requestQueue;
 
    private int $activeRequests = 0;
 
    public function __construct(
        private NetworkSession $session,
        private array $resourcePackStack,
        private array $encryptionKeys,
        private bool $mustAccept,
        private \Closure $completionCallback
    ){
        $this->requestQueue = new \SplQueue();
        foreach($resourcePackStack as $pack){
            $this->resourcePacksByPrintableId[$pack->getPackId()->toString()] = $pack;
        }
    }
 
    private function getPackByPrintableId(string $printableId) : ?ResourcePack{
        return $this->resourcePacksByPrintableId[strtolower($printableId)] ?? null;
    }
 
    public function setUp() : void{
        $resourcePackEntries = array_map(function(ResourcePack $pack) : ResourcePackInfoEntry{
            //TODO: more stuff
 
            $uuid = $pack->getPackId();
            $printableId = $uuid->toString();
            return new ResourcePackInfoEntry(
                $uuid,
                $pack->getPackVersion(),
                $pack->getPackSize(),
                $this->encryptionKeys[$printableId] ?? "",
                "",
                $printableId,
                false
            );
        }, $this->resourcePackStack);
        //TODO: support forcing server packs
        $this->session->sendDataPacket(ResourcePacksInfoPacket::create(
            resourcePackEntries: $resourcePackEntries,
            mustAccept: $this->mustAccept,
            hasAddons: false,
            hasScripts: false,
            worldTemplateId: Uuid::fromString(Uuid::NIL),
            worldTemplateVersion: "",
            forceDisableVibrantVisuals: true,
        ));
        $this->session->getLogger()->debug("Waiting for client to accept resource packs");
    }
 
    private function disconnectWithError(string $error) : void{
        $this->session->disconnectWithError(
            reason: "Error downloading resource packs: " . $error,
            disconnectScreenMessage: KnownTranslationFactory::disconnectionScreen_resourcePack()
        );
    }
 
    public function handleResourcePackClientResponse(ResourcePackClientResponsePacket $packet) : bool{
        switch($packet->status){
            case ResourcePackClientResponsePacket::STATUS_REFUSED:
                //TODO: add lang strings for this
                $this->session->disconnect("Refused resource packs", "You must accept resource packs to join this server.", true);
                break;
            case ResourcePackClientResponsePacket::STATUS_SEND_PACKS:
                if($this->requestedMetadata){
                    throw new PacketHandlingException("Cannot request resource pack metadata multiple times");
                }
                $this->requestedMetadata = true;
 
                if($this->requestedStack){
                    //client already told us that they have all the packs, they shouldn't be asking for more
                    throw new PacketHandlingException("Cannot request resource pack metadata after resource pack stack");
                }
 
                if(count($packet->packIds) > count($this->resourcePacksByPrintableId)){
                    throw new PacketHandlingException(sprintf("Requested metadata for more resource packs (%d) than available on the server (%d)", count($packet->packIds), count($this->resourcePacksByPrintableId)));
                }
 
                $seen = [];
                foreach($packet->packIds as $requestedPrintableId){
                    //dirty hack for mojang's dirty hack for versions
                    $splitPos = strpos($requestedPrintableId, "_");
                    if($splitPos !== false){
                        $requestedPrintableId = substr($requestedPrintableId, 0, $splitPos);
                    }
                    $pack = $this->getPackByPrintableId($requestedPrintableId);
 
                    if(!($pack instanceof ResourcePack)){
                        //Client requested a resource pack but we don't have it available on the server
                        $this->disconnectWithError("Unknown pack $requestedPrintableId requested, available packs: " . implode(", ", array_keys($this->resourcePacksByPrintableId)));
                        return false;
                    }
                    $printableId = $pack->getPackId()->toString();
                    if(isset($seen[$printableId])){
                        throw new PacketHandlingException("Repeated metadata request for pack $requestedPrintableId");
                    }
 
                    $this->session->sendDataPacket(ResourcePackDataInfoPacket::create(
                        $printableId,
                        self::PACK_CHUNK_SIZE,
                        (int) ceil($pack->getPackSize() / self::PACK_CHUNK_SIZE),
                        $pack->getPackSize(),
                        $pack->getSha256(),
                        false,
                        ResourcePackType::RESOURCES //TODO: this might be an addon (not behaviour pack), needed to properly support client-side custom items
                    ));
                    $seen[$printableId] = true;
                }
                $this->session->getLogger()->debug("Player requested download of " . count($packet->packIds) . " resource packs");
                break;
            case ResourcePackClientResponsePacket::STATUS_HAVE_ALL_PACKS:
                if($this->requestedStack){
                    throw new PacketHandlingException("Cannot request resource pack stack multiple times");
                }
                $this->requestedStack = true;
 
                $stack = array_map(static function(ResourcePack $pack) : ResourcePackStackEntry{
                    return new ResourcePackStackEntry($pack->getPackId()->toString(), $pack->getPackVersion(), ""); //TODO: subpacks
                }, $this->resourcePackStack);
 
                //we support chemistry blocks by default, the client should already have these installed
                foreach(self::CHEMISTRY_RESOURCE_PACKS as [$uuid, $version]){
                    $stack[] = new ResourcePackStackEntry($uuid, $version, "");
                }
 
                //we don't force here, because it doesn't have user-facing effects
                //but it does have an annoying side-effect when true: it makes
                //the client remove its own non-server-supplied resource packs.
                $this->session->sendDataPacket(ResourcePackStackPacket::create($stack, false, ProtocolInfo::MINECRAFT_VERSION_NETWORK, new Experiments([], false), false));
                $this->session->getLogger()->debug("Applying resource pack stack");
                break;
            case ResourcePackClientResponsePacket::STATUS_COMPLETED:
                $this->session->getLogger()->debug("Resource packs sequence completed");
                ($this->completionCallback)();
                break;
            default:
                return false;
        }
 
        return true;
    }
 
    public function handleResourcePackChunkRequest(ResourcePackChunkRequestPacket $packet) : bool{
        $pack = $this->getPackByPrintableId($packet->packId);
        if(!($pack instanceof ResourcePack)){
            $this->disconnectWithError("Invalid request for chunk $packet->chunkIndex of unknown pack $packet->packId, available packs: " . implode(", ", array_keys($this->resourcePacksByPrintableId)));
            return false;
        }
 
        $printableId = $pack->getPackId()->toString(); //use this because case may be different in the packet vs locally
 
        if(isset($this->downloadedChunks[$printableId][$packet->chunkIndex])){
            $this->disconnectWithError("Duplicate request for chunk $packet->chunkIndex of pack $packet->packId");
            return false;
        }
 
        $offset = $packet->chunkIndex * self::PACK_CHUNK_SIZE;
        if($offset < 0 || $offset >= $pack->getPackSize()){
            $this->disconnectWithError("Invalid out-of-bounds request for chunk $packet->chunkIndex of $packet->packId: offset $offset, file size " . $pack->getPackSize());
            return false;
        }
 
        if(!isset($this->downloadedChunks[$printableId])){
            $this->downloadedChunks[$printableId] = [$packet->chunkIndex => true];
        }else{
            $this->downloadedChunks[$printableId][$packet->chunkIndex] = true;
        }
 
        $this->requestQueue->enqueue([$pack, $packet->chunkIndex]);
        $this->processChunkRequestQueue();
 
        return true;
    }
 
    private function processChunkRequestQueue() : void{
        if($this->activeRequests >= self::MAX_CONCURRENT_CHUNK_REQUESTS || $this->requestQueue->isEmpty()){
            return;
        }
        [$pack, $chunkIndex] = $this->requestQueue->dequeue();
 
        $printableId = $pack->getPackId()->toString();
        $offset = $chunkIndex * self::PACK_CHUNK_SIZE;
        $chunkData = $pack->getPackChunk($offset, self::PACK_CHUNK_SIZE);
        $this->activeRequests++;
        $this->session
            ->sendDataPacketWithReceipt(ResourcePackChunkDataPacket::create($printableId, $chunkIndex, $offset, $chunkData))
            ->onCompletion(
                function() : void{
                    $this->activeRequests--;
                    $this->processChunkRequestQueue();
                },
                function() : void{
                    //this may have been rejected because of a disconnection - this will do nothing in that case
                    $this->disconnectWithError("Plugin interrupted sending of resource packs");
                }
            );
    }
}