mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-06-29 14:49:59 +00:00
bdd9a7eb52
DataPacketSendEvent and DataPacketReceiveEvent will no longer capture BatchPackets In most places strings are now used instead of DataPackets, to remove limitations on what data can be sent to a network interface Removed CraftingManager's cyclic dependency on Server There is a lot more work to do aside from this, but this commit is intended to clean up what is necessary to fix the handling of BatchPacket.
141 lines
3.7 KiB
PHP
141 lines
3.7 KiB
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\protocol;
|
|
|
|
#include <rules/DataPacket.h>
|
|
|
|
use pocketmine\network\mcpe\NetworkBinaryStream;
|
|
use pocketmine\network\mcpe\NetworkSession;
|
|
use pocketmine\utils\Utils;
|
|
|
|
abstract class DataPacket extends NetworkBinaryStream{
|
|
|
|
public const NETWORK_ID = 0;
|
|
|
|
/** @var bool */
|
|
public $isEncoded = false;
|
|
|
|
/** @var int */
|
|
public $senderSubId = 0;
|
|
/** @var int */
|
|
public $recipientSubId = 0;
|
|
|
|
public function pid() : int{
|
|
return $this::NETWORK_ID;
|
|
}
|
|
|
|
public function getName() : string{
|
|
return (new \ReflectionClass($this))->getShortName();
|
|
}
|
|
|
|
public function canBeSentBeforeLogin() : bool{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns whether the packet may legally have unread bytes left in the buffer.
|
|
* @return bool
|
|
*/
|
|
public function mayHaveUnreadBytes() : bool{
|
|
return false;
|
|
}
|
|
|
|
public function decode() : void{
|
|
$this->offset = 0;
|
|
$this->decodeHeader();
|
|
$this->decodePayload();
|
|
}
|
|
|
|
protected function decodeHeader() : void{
|
|
$pid = $this->getUnsignedVarInt();
|
|
assert($pid === static::NETWORK_ID);
|
|
|
|
$this->senderSubId = $this->getByte();
|
|
$this->recipientSubId = $this->getByte();
|
|
assert($this->senderSubId === 0 and $this->recipientSubId === 0, "Got unexpected non-zero split-screen bytes (byte1: $this->senderSubId, byte2: $this->recipientSubId");
|
|
}
|
|
|
|
/**
|
|
* Note for plugin developers: If you're adding your own packets, you should perform decoding in here.
|
|
*/
|
|
protected function decodePayload() : void{
|
|
|
|
}
|
|
|
|
public function encode() : void{
|
|
$this->reset();
|
|
$this->encodeHeader();
|
|
$this->encodePayload();
|
|
$this->isEncoded = true;
|
|
}
|
|
|
|
protected function encodeHeader() : void{
|
|
$this->putUnsignedVarInt(static::NETWORK_ID);
|
|
|
|
$this->putByte($this->senderSubId);
|
|
$this->putByte($this->recipientSubId);
|
|
}
|
|
|
|
/**
|
|
* Note for plugin developers: If you're adding your own packets, you should perform encoding in here.
|
|
*/
|
|
protected function encodePayload() : void{
|
|
|
|
}
|
|
|
|
/**
|
|
* Performs handling for this packet. Usually you'll want an appropriately named method in the NetworkSession for this.
|
|
*
|
|
* This method returns a bool to indicate whether the packet was handled or not. If the packet was unhandled, a debug message will be logged with a hexdump of the packet.
|
|
* Typically this method returns the return value of the handler in the supplied NetworkSession. See other packets for examples how to implement this.
|
|
*
|
|
* @param NetworkSession $session
|
|
*
|
|
* @return bool true if the packet was handled successfully, false if not.
|
|
*/
|
|
abstract public function handle(NetworkSession $session) : bool;
|
|
|
|
public function clean(){
|
|
$this->buffer = null;
|
|
$this->isEncoded = false;
|
|
$this->offset = 0;
|
|
return $this;
|
|
}
|
|
|
|
public function __debugInfo(){
|
|
$data = [];
|
|
foreach($this as $k => $v){
|
|
if($k === "buffer" and is_string($v)){
|
|
$data[$k] = bin2hex($v);
|
|
}elseif(is_string($v) or (is_object($v) and method_exists($v, "__toString"))){
|
|
$data[$k] = Utils::printable((string) $v);
|
|
}else{
|
|
$data[$k] = $v;
|
|
}
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
}
|