mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-05 19:37:17 +00:00
Code Issues Projects Releases Wiki Activity

InventoryManager: Track predictions using ItemStack directly, instead of internal Item

Browse Source 
this removes the need for deserializing network itemstacks to core items, thereby eliminating a whole bunch of potential security issues.
This commit is contained in:
Dylan K. Taylor 2023-01-06 20:45:08 +00:00
parent 8633804f15
commit 1123a5aa23
No known key found for this signature in database
GPG Key ID: 8927471A91CAFD3D
2 changed files with 19 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/network/mcpe/InventoryManager.php
View File

@ -38,7 +38,6 @@ use pocketmine\inventory\Inventory;
use pocketmine\inventory\transaction\action\SlotChangeAction;
use pocketmine\inventory\transaction\InventoryTransaction;
use pocketmine\item\Item;
use pocketmine\network\mcpe\convert\TypeConversionException;
use pocketmine\network\mcpe\convert\TypeConverter;
use pocketmine\network\mcpe\protocol\ClientboundPacket;
use pocketmine\network\mcpe\protocol\ContainerClosePacket;
@ -188,7 +187,7 @@ class InventoryManager{
return null;
}
private function addPredictedSlotChange(Inventory $inventory, int $slot, Item $item) : void{
private function addPredictedSlotChange(Inventory $inventory, int $slot, ItemStack $item) : void{
$predictions = ($this->initiatedSlotChanges[spl_object_id($inventory)] ??= new InventoryManagerPredictedChanges($inventory));
$predictions->add($slot, $item);
}
@ -196,7 +195,9 @@ class InventoryManager{
public function addTransactionPredictedSlotChanges(InventoryTransaction $tx) : void{
foreach($tx->getActions() as $action){
if($action instanceof SlotChangeAction){
$this->addPredictedSlotChange($action->getInventory(), $action->getSlot(), $action->getTargetItem());
//TODO: ItemStackRequestExecutor can probably build these predictions with much lower overhead
$itemStack = TypeConverter::getInstance()->coreItemStackToNet($action->getTargetItem());
$this->addPredictedSlotChange($action->getInventory(), $action->getSlot(), $itemStack);
}
}
}
@ -225,12 +226,7 @@ class InventoryManager{
}
[$inventory, $slot] = $info;
try{
$item = TypeConverter::getInstance()->netItemStackToCore($action->newItem->getItemStack());
}catch(TypeConversionException $e){
throw new PacketHandlingException($e->getMessage(), 0, $e);
}
$this->addPredictedSlotChange($inventory, $slot, $item);
$this->addPredictedSlotChange($inventory, $slot, $action->newItem->getItemStack());
}
}
@ -383,10 +379,10 @@ class InventoryManager{
}
public function onSlotChange(Inventory $inventory, int $slot) : void{
$currentItem = $inventory->getItem($slot);
$currentItem = TypeConverter::getInstance()->coreItemStackToNet($inventory->getItem($slot));
$predictions = $this->initiatedSlotChanges[spl_object_id($inventory)] ?? null;
$clientSideItem = $predictions?->getSlot($slot);
if($clientSideItem === null || !$clientSideItem->equalsExact($currentItem)){
if($clientSideItem === null || !$clientSideItem->equals($currentItem)){
//no prediction or incorrect - do not associate this with the currently active itemstack request
$this->trackItemStack($inventory, $slot, $currentItem, null);
$this->syncSlot($inventory, $slot);
@ -452,7 +448,8 @@ class InventoryManager{
unset($this->initiatedSlotChanges[spl_object_id($inventory)]);
$contents = [];
foreach($inventory->getContents(true) as $slot => $item){
$info = $this->trackItemStack($inventory, $slot, $item, null);
$itemStack = TypeConverter::getInstance()->coreItemStackToNet($item);
$info = $this->trackItemStack($inventory, $slot, $itemStack, null);
$contents[] = new ItemStackWrapper($info->getStackId(), $info->getItemStack());
}
if($slotMap !== null){
@ -548,15 +545,14 @@ class InventoryManager{
return $this->itemStackInfos[spl_object_id($inventory)][$slot] ?? null;
}
private function trackItemStack(Inventory $inventory, int $slotId, Item $item, ?int $itemStackRequestId) : ItemStackInfo{
private function trackItemStack(Inventory $inventory, int $slotId, ItemStack $itemStack, ?int $itemStackRequestId) : ItemStackInfo{
$existing = $this->itemStackInfos[spl_object_id($inventory)][$slotId] ?? null;
$typeConverter = TypeConverter::getInstance();
$itemStack = $typeConverter->coreItemStackToNet($item);
if($existing !== null && $existing->getItemStack()->equals($itemStack) && $existing->getRequestId() === $itemStackRequestId){
return $existing;
}
$info = new ItemStackInfo($itemStackRequestId, $item->isNull() ? 0 : $this->newItemStackId(), $itemStack);
//TODO: ItemStack->isNull() would be nice to have here
$info = new ItemStackInfo($itemStackRequestId, $itemStack->getId() === 0 ? 0 : $this->newItemStackId(), $itemStack);
return $this->itemStackInfos[spl_object_id($inventory)][$slotId] = $info;
}

14
src/network/mcpe/InventoryManagerPredictedChanges.php
View File

@ -24,12 +24,12 @@ declare(strict_types=1);
namespace pocketmine\network\mcpe;
use pocketmine\inventory\Inventory;
use pocketmine\item\Item;
use pocketmine\network\mcpe\protocol\types\inventory\ItemStack;
final class InventoryManagerPredictedChanges{
/**
* @var Item[]
* @phpstan-var array<int, Item>
* @var ItemStack[]
* @phpstan-var array<int, ItemStack>
*/
private array $slots = [];
@ -40,18 +40,18 @@ final class InventoryManagerPredictedChanges{
public function getInventory() : Inventory{ return $this->inventory; }
/**
* @return Item[]
* @phpstan-return array<int, Item>
* @return ItemStack[]
* @phpstan-return array<int, ItemStack>
*/
public function getSlots() : array{
return $this->slots;
}
public function getSlot(int $slot) : ?Item{
public function getSlot(int $slot) : ?ItemStack{
return $this->slots[$slot] ?? null;
}
public function add(int $slot, Item $item) : void{
public function add(int $slot, ItemStack $item) : void{
$this->slots[$slot] = $item;
}