aandrieux/Test-Miroir
1
0
Fork 0
mirror of https://github.com/xPaw/PHP-Source-Query.git synced 2026-06-10 23:03:15 +02:00
Code Issues Releases Wiki Activity

Bring in stricter CS Fixer rules.

Browse Source
This commit is contained in:
Anthony Birkett
2021-05-31 13:42:44 +01:00
parent 48b89017c4
commit 0e4d7d4a6b
23 changed files with 287 additions and 509 deletions
Download Patch File Download Diff File Expand all files Collapse all files
SourceQuery/Buffer.php
+18 -25
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -20,24 +20,22 @@ use xPaw\SourceQuery\Exception\InvalidPacketException;
final class Buffer
{
/**
* Buffer
* Buffer.
*/
private string $buffer = '';
/**
* Buffer length
* Buffer length.
*/
private int $length = 0;
/**
* Current position in buffer
* Current position in buffer.
*/
private int $position = 0;
/**
* Sets buffer
*
* @param string $buffer
* Sets buffer.
*/
public function set(string $buffer): void
{
@@ -47,7 +45,7 @@ final class Buffer
}
/**
* Get remaining bytes
* Get remaining bytes.
*
* @return int Remaining bytes in buffer
*/
@@ -56,30 +54,25 @@ final class Buffer
return $this->length - $this->position;
}
/**
* @return bool
*/
public function isEmpty(): bool
{
return $this->remaining() <= 0;
}
/**
* Gets data from buffer
* Gets data from buffer.
*
* @param int $length Bytes to read
*
* @return string
*/
public function get(int $length = -1): string
{
if ($length === 0) {
if (0 === $length) {
return '';
}
$remaining = $this->remaining();
if ($length === -1) {
if (-1 === $length) {
$length = $remaining;
} elseif ($length > $remaining) {
return '';
@@ -93,7 +86,7 @@ final class Buffer
}
/**
* Get byte from buffer
* Get byte from buffer.
*/
public function getByte(): int
{
@@ -101,7 +94,7 @@ final class Buffer
}
/**
* Get short from buffer
* Get short from buffer.
*
* @throws InvalidPacketException
*/
@@ -121,7 +114,7 @@ final class Buffer
}
/**
* Get long from buffer
* Get long from buffer.
*
* @throws InvalidPacketException
*/
@@ -141,7 +134,7 @@ final class Buffer
}
/**
* Get float from buffer
* Get float from buffer.
*
* @throws InvalidPacketException
*/
@@ -161,7 +154,7 @@ final class Buffer
}
/**
* Get unsigned long from buffer
* Get unsigned long from buffer.
*
* @throws InvalidPacketException
*/
@@ -181,19 +174,19 @@ final class Buffer
}
/**
* Read one string from buffer ending with null byte
* Read one string from buffer ending with null byte.
*/
public function getString(): string
{
$zeroBytePosition = strpos($this->buffer, "\0", $this->position);
if ($zeroBytePosition === false) {
if (false === $zeroBytePosition) {
return '';
}
$string = $this->get($zeroBytePosition - $this->position);
$this->position++;
++$this->position;
return $string;
}
SourceQuery/Exception/AuthenticationException.php
+2 -2
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
SourceQuery/Exception/InvalidArgumentException.php
+2 -2
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
SourceQuery/Exception/InvalidPacketException.php
+2 -2
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
SourceQuery/Exception/SocketException.php
+2 -2
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
SourceQuery/Exception/SourceQueryException.php
+2 -2
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
SourceQuery/Rcon/AbstractRcon.php
+2 -10
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -24,16 +24,8 @@ abstract class AbstractRcon implements RconInterface
/**
* @throws AuthenticationException
* @throws InvalidPacketException
*
* @return Buffer
*/
abstract protected function read(): Buffer;
/**
* @param int|null $header
* @param string $string
*
* @return bool
*/
abstract protected function write(?int $header, string $string = ''): bool;
}
SourceQuery/Rcon/GoldSourceRcon.php
+11 -35
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -24,49 +24,36 @@ use xPaw\SourceQuery\SourceQuery;
final class GoldSourceRcon extends AbstractRcon
{
/**
* Points to socket class
*
* @var SocketInterface
* Points to socket class.
*/
private SocketInterface $socket;
/**
* @var string
*/
private string $rconPassword = '';
/**
* @var string
*/
private string $rconChallenge = '';
/**
* @param SocketInterface $socket
*/
public function __construct(SocketInterface $socket)
{
$this->socket = $socket;
}
/**
* Open
* Open.
*/
public function open(): void
{
}
/**
* Close
* Close.
*/
public function close(): void
{
$this->rconChallenge = '';
$this->rconPassword = '';
$this->rconPassword = '';
}
/**
* @param string $password
*
* @throws AuthenticationException
*/
public function authorize(string $password): void
@@ -76,7 +63,7 @@ final class GoldSourceRcon extends AbstractRcon
$this->write(null, 'challenge rcon');
$buffer = $this->socket->read();
if ($buffer->get(14) !== 'challenge rcon') {
if ('challenge rcon' !== $buffer->get(14)) {
throw new AuthenticationException('Failed to get RCON challenge.', AuthenticationException::BAD_PASSWORD);
}
@@ -84,10 +71,6 @@ final class GoldSourceRcon extends AbstractRcon
}
/**
* @param string $command
*
* @return string
*
* @throws AuthenticationException
* @throws InvalidPacketException
*/
@@ -106,8 +89,6 @@ final class GoldSourceRcon extends AbstractRcon
/**
* @throws AuthenticationException
* @throws InvalidPacketException
*
* @return Buffer
*/
protected function read(): Buffer
{
@@ -121,7 +102,7 @@ final class GoldSourceRcon extends AbstractRcon
$readMore = !$buffer->isEmpty();
if ($readMore) {
if ($buffer->getByte() !== SourceQuery::S2A_RCON) {
if (SourceQuery::S2A_RCON !== $buffer->getByte()) {
throw new InvalidPacketException('Invalid rcon response.', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
@@ -140,9 +121,10 @@ final class GoldSourceRcon extends AbstractRcon
$trimmed = trim($stringBuffer);
if ($trimmed === 'Bad rcon_password.') {
if ('Bad rcon_password.' === $trimmed) {
throw new AuthenticationException($trimmed, AuthenticationException::BAD_PASSWORD);
} elseif ($trimmed === 'You have been banned from this server.') {
}
if ('You have been banned from this server.' === $trimmed) {
throw new AuthenticationException($trimmed, AuthenticationException::BANNED);
}
@@ -151,12 +133,6 @@ final class GoldSourceRcon extends AbstractRcon
return $buffer;
}
/**
* @param int|null $header
* @param string $string
*
* @return bool
*/
protected function write(?int $header, string $string = ''): bool
{
$command = pack('cccca*', 0xFF, 0xFF, 0xFF, 0xFF, $string);
SourceQuery/Rcon/RconInterface.php
+4 -13
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -21,33 +21,24 @@ use xPaw\SourceQuery\Socket\SocketInterface;
interface RconInterface
{
/**
* @param SocketInterface $socket
*/
public function __construct(SocketInterface $socket);
/**
* Open
* Open.
*/
public function open(): void;
/**
* Close
* Close.
*/
public function close(): void;
/**
* @param string $password
*
* @throws AuthenticationException
*/
public function authorize(string $password): void;
/**
* @param string $command
*
* @return string
*
* @throws AuthenticationException
* @throws InvalidPacketException
*/
SourceQuery/Rcon/SourceRcon.php
+12 -30
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -25,7 +25,7 @@ use xPaw\SourceQuery\SourceQuery;
final class SourceRcon extends AbstractRcon
{
/**
* Points to socket class
* Points to socket class.
*/
private SocketInterface $socket;
@@ -36,14 +36,8 @@ final class SourceRcon extends AbstractRcon
*/
private $rconSocket;
/**
* @var int
*/
private int $rconRequestId = 0;
/**
* @param SocketInterface $socket
*/
public function __construct(SocketInterface $socket)
{
$this->socket = $socket;
@@ -74,7 +68,7 @@ final class SourceRcon extends AbstractRcon
}
/**
* Close
* Close.
*/
public function close(): void
{
@@ -88,8 +82,6 @@ final class SourceRcon extends AbstractRcon
}
/**
* @param string $password
*
* @throws AuthenticationException
* @throws InvalidPacketException
*/
@@ -104,23 +96,19 @@ final class SourceRcon extends AbstractRcon
// If we receive SERVERDATA_RESPONSE_VALUE, then we need to read again.
// More info: https://developer.valvesoftware.com/wiki/Source_RCON_Protocol#Additional_Comments
if ($type === SourceQuery::SERVERDATA_RESPONSE_VALUE) {
if (SourceQuery::SERVERDATA_RESPONSE_VALUE === $type) {
$buffer = $this->read();
$requestId = $buffer->getLong();
$type = $buffer->getLong();
}
if ($requestId === -1 || $type !== SourceQuery::SERVERDATA_AUTH_RESPONSE) {
if (-1 === $requestId || SourceQuery::SERVERDATA_AUTH_RESPONSE !== $type) {
throw new AuthenticationException('RCON authorization failed.', AuthenticationException::BAD_PASSWORD);
}
}
/**
* @param string $command
*
* @return string
*
* @throws AuthenticationException
* @throws InvalidPacketException
*/
@@ -133,9 +121,10 @@ final class SourceRcon extends AbstractRcon
$type = $buffer->getLong();
if ($type === SourceQuery::SERVERDATA_AUTH_RESPONSE) {
if (SourceQuery::SERVERDATA_AUTH_RESPONSE === $type) {
throw new AuthenticationException('Bad rcon_password.', AuthenticationException::BAD_PASSWORD);
} elseif ($type !== SourceQuery::SERVERDATA_RESPONSE_VALUE) {
}
if (SourceQuery::SERVERDATA_RESPONSE_VALUE !== $type) {
throw new InvalidPacketException('Invalid rcon response.', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
@@ -151,13 +140,13 @@ final class SourceRcon extends AbstractRcon
$buffer->getLong(); // RequestID.
if ($buffer->getLong() !== SourceQuery::SERVERDATA_RESPONSE_VALUE) {
if (SourceQuery::SERVERDATA_RESPONSE_VALUE !== $buffer->getLong()) {
break;
}
$data2 = $buffer->get();
if ($data2 === "\x00\x01\x00\x00\x00\x00") {
if ("\x00\x01\x00\x00\x00\x00" === $data2) {
break;
}
@@ -169,8 +158,6 @@ final class SourceRcon extends AbstractRcon
}
/**
* @return Buffer
*
* @throws InvalidPacketException
*/
protected function read(): Buffer
@@ -229,11 +216,6 @@ final class SourceRcon extends AbstractRcon
}
/**
* @param int|null $header
* @param string $string
*
* @return bool
*
* @throws InvalidPacketException
*/
protected function write(?int $header, string $string = ''): bool
@@ -247,7 +229,7 @@ final class SourceRcon extends AbstractRcon
// Prepend packet length.
$command = pack('V', strlen($command)) . $command;
$length = strlen($command);
$length = strlen($command);
return $length === fwrite($this->rconSocket, $command, $length);
}
SourceQuery/Socket/AbstractSocket.php
+15 -63
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -22,14 +22,8 @@ use xPaw\SourceQuery\Exception\SocketException;
abstract class AbstractSocket implements SocketInterface
{
/**
* @var string $address
*/
public string $address = '';
/**
* @var int $port
*/
public int $port = 0;
/**
@@ -39,39 +33,30 @@ abstract class AbstractSocket implements SocketInterface
*/
public $socket;
/**
* @var int $timeout
*/
public int $timeout = 0;
/**
* Destructor
* Destructor.
*/
public function __destruct()
{
$this->close();
}
/**
* @return string
*/
public function getAddress(): string
{
return $this->address;
}
/**
* @return int
*/
public function getPort(): int
{
return $this->port;
}
/**
* @return resource
*
* @throws InvalidArgumentException
*
* @return resource
*/
public function getSocket()
{
@@ -82,30 +67,23 @@ abstract class AbstractSocket implements SocketInterface
return $this->socket;
}
/**
* @return int
*/
public function getTimeout(): int
{
return $this->timeout;
}
/**
* @param string $address
* @param int $port
* @param int $timeout
*
* @throws SocketException
*/
public function open(string $address, int $port, int $timeout): void
{
$this->timeout = $timeout;
$this->port = $port;
$this->port = $port;
$this->address = $address;
$socket = @fsockopen('udp://' . $address, $port, $errNo, $errStr, $timeout);
if ($errNo || $socket === false) {
if ($errNo || false === $socket) {
throw new SocketException('Could not create socket: ' . $errStr, SocketException::COULD_NOT_CREATE_SOCKET);
}
@@ -115,7 +93,7 @@ abstract class AbstractSocket implements SocketInterface
}
/**
* Close
* Close.
*/
public function close(): void
{
@@ -129,13 +107,10 @@ abstract class AbstractSocket implements SocketInterface
/**
* Reads from socket and returns Buffer.
*
* @param int $length
*
* @return Buffer Buffer
*
* @throws InvalidPacketException
* @throws SocketException
*
* @return Buffer Buffer
*/
public function read(int $length = 1400): Buffer
{
@@ -152,17 +127,12 @@ abstract class AbstractSocket implements SocketInterface
$buffer->set($data);
$this->readInternal($buffer, $length, [ $this, 'sherlock' ]);
$this->readInternal($buffer, $length, [$this, 'sherlock']);
return $buffer;
}
/**
* @param int $header
* @param string $string
*
* @return bool
*
* @throws InvalidPacketException
*/
public function write(int $header, string $string = ''): bool
@@ -172,17 +142,12 @@ abstract class AbstractSocket implements SocketInterface
}
$command = pack('ccccca*', 0xFF, 0xFF, 0xFF, 0xFF, $header, $string);
$length = strlen($command);
$length = strlen($command);
return $length === fwrite($this->socket, $command, $length);
}
/**
* @param Buffer $buffer
* @param int $length
*
* @return bool
*
* @throws InvalidPacketException
*/
public function sherlock(Buffer $buffer, int $length): bool
@@ -203,18 +168,11 @@ abstract class AbstractSocket implements SocketInterface
$buffer->set($data);
return $buffer->getLong() === -2;
return -2 === $buffer->getLong();
}
/**
*
* Get packet data (count, number, checksum) from the buffer. Different for goldsrc/src.
*
* @param Buffer $buffer
* @param int $count
* @param int $number
* @param bool $isCompressed
* @param int|null $checksum
*/
abstract protected function readInternalPacketData(
Buffer $buffer,
@@ -225,12 +183,6 @@ abstract class AbstractSocket implements SocketInterface
): void;
/**
* @param Buffer $buffer
* @param int $length
* @param callable $sherlockFunction
*
* @return Buffer
*
* @throws InvalidPacketException
*/
protected function readInternal(Buffer $buffer, int $length, callable $sherlockFunction): Buffer
@@ -242,11 +194,11 @@ abstract class AbstractSocket implements SocketInterface
$header = $buffer->getLong();
// Single packet, do nothing.
if ($header === -1) {
if (-1 === $header) {
return $buffer;
}
if ($header === -2) { // Split packet
if (-2 === $header) { // Split packet
$packets = [];
$packetCount = 0;
$packetNumber = 0;
@@ -269,7 +221,7 @@ abstract class AbstractSocket implements SocketInterface
$readMore = $packetCount > count($packets);
} while ($readMore && $sherlockFunction($buffer, $length));
$data = implode($packets);
$data = implode('', $packets);
// TODO: Test this
if ($isCompressed) {
SourceQuery/Socket/GoldSourceSocket.php
+2 -12
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -19,21 +19,11 @@ use xPaw\SourceQuery\Buffer;
final class GoldSourceSocket extends AbstractSocket
{
/**
* @return int
*/
public function getType(): int
{
return SocketType::GOLDSOURCE;
}
/**
* @param Buffer $buffer
* @param int $count
* @param int $number
* @param bool $isCompressed
* @param int|null $checksum
*/
protected function readInternalPacketData(
Buffer $buffer,
int &$count,
SourceQuery/Socket/SocketInterface.php
+4 -31
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -18,20 +18,12 @@ namespace xPaw\SourceQuery\Socket;
use xPaw\SourceQuery\Buffer;
/**
* Base socket interface
*
* @package xPaw\SourceQuery\Socket
* Base socket interface.
*/
interface SocketInterface
{
/**
* @return string
*/
public function getAddress(): string;
/**
* @return int
*/
public function getPort(): int;
/**
@@ -39,9 +31,6 @@ interface SocketInterface
*/
public function getSocket();
/**
* @return int
*/
public function getTimeout(): int;
/**
@@ -49,30 +38,14 @@ interface SocketInterface
*/
public function getType(): int;
/**
* @param string $address
* @param int $port
* @param int $timeout
*/
public function open(string $address, int $port, int $timeout): void;
/**
* Close
* Close.
*/
public function close(): void;
/**
* @param int $length
*
* @return Buffer
*/
public function read(int $length = 1400): Buffer;
/**
* @param int $header
* @param string $string
*
* @return bool
*/
public function write(int $header, string $string = ''): bool;
}
SourceQuery/Socket/SocketType.php
+2 -2
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
SourceQuery/Socket/SourceSocket.php
+2 -11
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -20,21 +20,12 @@ use xPaw\SourceQuery\Exception\InvalidPacketException;
final class SourceSocket extends AbstractSocket
{
/**
* @return int
*/
public function getType(): int
{
return SocketType::SOURCE;
}
/**
* @param Buffer $buffer
* @param int $count
* @param int $number
* @param bool $isCompressed
* @param int|null $checksum
*
* @throws InvalidPacketException
*/
protected function readInternalPacketData(
SourceQuery/Socket/TestableSocket.php
+6 -55
View File
@@ -5,8 +5,8 @@ declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*
@@ -25,15 +25,10 @@ final class TestableSocket extends AbstractSocket
*/
private array $packetQueue;
/**
* @var int
*/
private int $type;
/**
* TestableSocket constructor.
*
* @param int $type
*/
public function __construct(int $type)
{
@@ -41,31 +36,20 @@ final class TestableSocket extends AbstractSocket
$this->type = $type;
}
/**
* @return int
*/
public function getType(): int
{
return $this->type;
}
/**
* @param string $data
*/
public function queue(string $data): void
{
$this->packetQueue[] = $data;
}
/**
* @param string $address
* @param int $port
* @param int $timeout
*/
public function open(string $address, int $port, int $timeout): void
{
$this->timeout = $timeout;
$this->port = $port;
$this->port = $port;
$this->address = $address;
}
@@ -77,10 +61,6 @@ final class TestableSocket extends AbstractSocket
}
/**
* @param int $length
*
* @return Buffer
*
* @throws InvalidPacketException
*/
public function read(int $length = 1400): Buffer
@@ -95,48 +75,31 @@ final class TestableSocket extends AbstractSocket
$buffer->set($packet);
$this->readInternal($buffer, $length, [ $this, 'sherlock' ]);
$this->readInternal($buffer, $length, [$this, 'sherlock']);
return $buffer;
}
/**
* @param int $header
* @param string $string
*
* @return bool
*/
public function write(int $header, string $string = ''): bool
{
return true;
}
/**
* @param Buffer $buffer
* @param int $length
*
* @return bool
*
* @throws InvalidPacketException
*/
public function sherlock(Buffer $buffer, int $length): bool
{
if (count($this->packetQueue) === 0) {
if (0 === count($this->packetQueue)) {
return false;
}
$buffer->set(array_shift($this->packetQueue));
return $buffer->getLong() === -2;
return -2 === $buffer->getLong();
}
/**
* @param Buffer $buffer
* @param int $count
* @param int $number
* @param bool $isCompressed
* @param int|null $checksum
*
* @throws InvalidPacketException
*/
protected function readInternalPacketData(
@@ -172,12 +135,6 @@ final class TestableSocket extends AbstractSocket
/**
* Same as GoldSourceSocket::readInternalPacketData.
*
* @param Buffer $buffer
* @param int $count
* @param int $number
* @param bool $isCompressed
* @param int|null $checksum
*/
private function readInternalPacketDataGoldSource(
Buffer $buffer,
@@ -195,12 +152,6 @@ final class TestableSocket extends AbstractSocket
/**
* Same as SourceSocket::readInternalPacketData.
*
* @param Buffer $buffer
* @param int $count
* @param int $number
* @param bool $isCompressed
* @param int|null $checksum
*
* @throws InvalidPacketException
*/
private function readInternalPacketDataSource(
SourceQuery/SourceQuery.php
+105 -126
View File
@@ -7,8 +7,8 @@ declare(strict_types=1);
*
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
* @see https://xpaw.me
* @see https://github.com/xPaw/PHP-Source-Query
*
* @license GNU Lesser General Public License, version 2.1
*/
@@ -29,68 +29,63 @@ use xPaw\SourceQuery\Socket\SocketType;
final class SourceQuery
{
/**
* Packets sent
* Packets sent.
*/
private const A2A_PING = 0x69;
private const A2S_INFO = 0x54;
private const A2S_PLAYER = 0x55;
private const A2S_RULES = 0x56;
private const A2A_PING = 0x69;
private const A2S_INFO = 0x54;
private const A2S_PLAYER = 0x55;
private const A2S_RULES = 0x56;
private const A2S_SERVERQUERY_GETCHALLENGE = 0x57;
/**
* Packets received
* Packets received.
*/
private const A2A_ACK = 0x6A;
private const A2A_ACK = 0x6A;
private const S2C_CHALLENGE = 0x41;
private const S2A_INFO_SRC = 0x49;
private const S2A_INFO_OLD = 0x6D; // Old GoldSource, HLTV uses it (actually called S2A_INFO_DETAILED).
private const S2A_PLAYER = 0x44;
private const S2A_RULES = 0x45;
public const S2A_RCON = 0x6C;
private const S2A_INFO_SRC = 0x49;
private const S2A_INFO_OLD = 0x6D; // Old GoldSource, HLTV uses it (actually called S2A_INFO_DETAILED).
private const S2A_PLAYER = 0x44;
private const S2A_RULES = 0x45;
public const S2A_RCON = 0x6C;
/**
* Source rcon sent
* Source rcon sent.
*/
public const SERVERDATA_REQUESTVALUE = 0;
public const SERVERDATA_EXECCOMMAND = 2;
public const SERVERDATA_AUTH = 3;
public const SERVERDATA_REQUESTVALUE = 0;
public const SERVERDATA_EXECCOMMAND = 2;
public const SERVERDATA_AUTH = 3;
/**
* Source rcon received
* Source rcon received.
*/
public const SERVERDATA_RESPONSE_VALUE = 0;
public const SERVERDATA_AUTH_RESPONSE = 2;
public const SERVERDATA_AUTH_RESPONSE = 2;
/**
* Points to rcon class
*
* @var RconInterface|null
* Points to rcon class.
*/
private ?RconInterface $rcon;
/**
* Points to socket class
* Points to socket class.
*/
private SocketInterface $socket;
/**
* True if connection is open, false if not
* True if connection is open, false if not.
*/
private bool $connected = false;
/**
* Contains challenge
* Contains challenge.
*/
private string $challenge = '';
/**
* Use old method for getting challenge number
* Use old method for getting challenge number.
*/
private bool $useOldGetChallengeMethod = false;
/**
* @param SocketInterface $socket
*/
public function __construct(SocketInterface $socket)
{
$this->socket = $socket;
@@ -98,7 +93,7 @@ final class SourceQuery
}
/**
* Destructor
* Destructor.
*/
public function __destruct()
{
@@ -106,11 +101,11 @@ final class SourceQuery
}
/**
* Opens connection to server
* Opens connection to server.
*
* @param string $address Server ip
* @param int $port Server port
* @param int $timeout Timeout period
* @param int $port Server port
* @param int $timeout Timeout period
*
* @throws InvalidArgumentException
*/
@@ -128,7 +123,7 @@ final class SourceQuery
}
/**
* Closes all open connections
* Closes all open connections.
*/
public function disconnect(): void
{
@@ -145,7 +140,7 @@ final class SourceQuery
}
/**
* Forces GetChallenge to use old method for challenge retrieval because some games use outdated protocol (e.g Starbound)
* Forces GetChallenge to use old method for challenge retrieval because some games use outdated protocol (e.g Starbound).
*
* @param bool $value Set to true to force old method
*
@@ -155,14 +150,14 @@ final class SourceQuery
{
$previous = $this->useOldGetChallengeMethod;
$this->useOldGetChallengeMethod = $value === true;
$this->useOldGetChallengeMethod = true === $value;
return $previous;
}
/**
* Sends ping packet to the server
* NOTE: This may not work on some games (TF2 for example)
* NOTE: This may not work on some games (TF2 for example).
*
* @throws SocketException
*
@@ -177,11 +172,11 @@ final class SourceQuery
$this->socket->write(self::A2A_PING);
$buffer = $this->socket->read();
return $buffer->getByte() === self::A2A_ACK;
return self::A2A_ACK === $buffer->getByte();
}
/**
* Get server information
* Get server information.
*
* @throws InvalidPacketException
* @throws SocketException
@@ -204,7 +199,7 @@ final class SourceQuery
$type = $buffer->getByte();
$server = [];
if ($type === self::S2C_CHALLENGE) {
if (self::S2C_CHALLENGE === $type) {
$this->challenge = $buffer->get(4);
$this->socket->write(self::A2S_INFO, "Source Engine Query\0" . $this->challenge);
@@ -213,78 +208,78 @@ final class SourceQuery
}
// Old GoldSource protocol, HLTV still uses it.
if ($type === self::S2A_INFO_OLD && $this->socket->getType() === SocketType::GOLDSOURCE) {
/**
if (self::S2A_INFO_OLD === $type && SocketType::GOLDSOURCE === $this->socket->getType()) {
/*
* If we try to read data again, and we get the result with type S2A_INFO (0x49)
* That means this server is running dproto,
* Because it sends answer for both protocols
*/
$server[ 'Address' ] = $buffer->getString();
$server[ 'HostName' ] = $buffer->getString();
$server[ 'Map' ] = $buffer->getString();
$server[ 'ModDir' ] = $buffer->getString();
$server[ 'ModDesc' ] = $buffer->getString();
$server[ 'Players' ] = $buffer->getByte();
$server[ 'MaxPlayers' ] = $buffer->getByte();
$server[ 'Protocol' ] = $buffer->getByte();
$server[ 'Dedicated' ] = chr($buffer->getByte());
$server[ 'Os' ] = chr($buffer->getByte());
$server[ 'Password' ] = $buffer->getByte() === 1;
$server[ 'IsMod' ] = $buffer->getByte() === 1;
$server['Address'] = $buffer->getString();
$server['HostName'] = $buffer->getString();
$server['Map'] = $buffer->getString();
$server['ModDir'] = $buffer->getString();
$server['ModDesc'] = $buffer->getString();
$server['Players'] = $buffer->getByte();
$server['MaxPlayers'] = $buffer->getByte();
$server['Protocol'] = $buffer->getByte();
$server['Dedicated'] = chr($buffer->getByte());
$server['Os'] = chr($buffer->getByte());
$server['Password'] = 1 === $buffer->getByte();
$server['IsMod'] = 1 === $buffer->getByte();
if ($server[ 'IsMod' ]) {
if ($server['IsMod']) {
$Mod = [];
$Mod[ 'Url' ] = $buffer->getString();
$Mod[ 'Download' ] = $buffer->getString();
$Mod['Url'] = $buffer->getString();
$Mod['Download'] = $buffer->getString();
$buffer->get(1); // NULL byte
$Mod[ 'Version' ] = $buffer->getLong();
$Mod[ 'Size' ] = $buffer->getLong();
$Mod[ 'ServerSide' ] = $buffer->getByte() === 1;
$Mod[ 'CustomDLL' ] = $buffer->getByte() === 1;
$server[ 'Mod' ] = $Mod;
$Mod['Version'] = $buffer->getLong();
$Mod['Size'] = $buffer->getLong();
$Mod['ServerSide'] = 1 === $buffer->getByte();
$Mod['CustomDLL'] = 1 === $buffer->getByte();
$server['Mod'] = $Mod;
}
$server[ 'Secure' ] = $buffer->getByte() === 1;
$server[ 'Bots' ] = $buffer->getByte();
$server['Secure'] = 1 === $buffer->getByte();
$server['Bots'] = $buffer->getByte();
return $server;
}
if ($type !== self::S2A_INFO_SRC) {
if (self::S2A_INFO_SRC !== $type) {
throw new InvalidPacketException('GetInfo: Packet header mismatch. (0x' . dechex($type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
$server[ 'Protocol' ] = $buffer->getByte();
$server[ 'HostName' ] = $buffer->getString();
$server[ 'Map' ] = $buffer->getString();
$server[ 'ModDir' ] = $buffer->getString();
$server[ 'ModDesc' ] = $buffer->getString();
$server[ 'AppID' ] = $buffer->getShort();
$server[ 'Players' ] = $buffer->getByte();
$server[ 'MaxPlayers' ] = $buffer->getByte();
$server[ 'Bots' ] = $buffer->getByte();
$server[ 'Dedicated' ] = chr($buffer->getByte());
$server[ 'Os' ] = chr($buffer->getByte());
$server[ 'Password' ] = $buffer->getByte() === 1;
$server[ 'Secure' ] = $buffer->getByte() === 1;
$server['Protocol'] = $buffer->getByte();
$server['HostName'] = $buffer->getString();
$server['Map'] = $buffer->getString();
$server['ModDir'] = $buffer->getString();
$server['ModDesc'] = $buffer->getString();
$server['AppID'] = $buffer->getShort();
$server['Players'] = $buffer->getByte();
$server['MaxPlayers'] = $buffer->getByte();
$server['Bots'] = $buffer->getByte();
$server['Dedicated'] = chr($buffer->getByte());
$server['Os'] = chr($buffer->getByte());
$server['Password'] = 1 === $buffer->getByte();
$server['Secure'] = 1 === $buffer->getByte();
// The Ship (they violate query protocol spec by modifying the response)
if ($server[ 'AppID' ] === 2400) {
$server[ 'GameMode' ] = $buffer->getByte();
$server[ 'WitnessCount' ] = $buffer->getByte();
$server[ 'WitnessTime' ] = $buffer->getByte();
if (2400 === $server['AppID']) {
$server['GameMode'] = $buffer->getByte();
$server['WitnessCount'] = $buffer->getByte();
$server['WitnessTime'] = $buffer->getByte();
}
$server[ 'Version' ] = $buffer->getString();
$server['Version'] = $buffer->getString();
// Extra Data Flags.
if ($buffer->remaining() > 0) {
$server[ 'ExtraDataFlags' ] = $Flags = $buffer->getByte();
$server['ExtraDataFlags'] = $Flags = $buffer->getByte();
// S2A_EXTRA_DATA_HAS_GAME_PORT - Next 2 bytes include the game port.
if ($Flags & 0x80) {
$server[ 'GamePort' ] = $buffer->getShort();
$server['GamePort'] = $buffer->getShort();
}
// S2A_EXTRA_DATA_HAS_STEAMID - Next 8 bytes are the steamID.
@@ -306,32 +301,29 @@ final class SourceQuery
$steamId = $steamIdLower | ($steamIdInstance << 32);
}
$server[ 'SteamID' ] = $steamId;
$server['SteamID'] = $steamId;
unset($steamIdLower, $steamIdInstance, $steamId);
}
// S2A_EXTRA_DATA_HAS_SPECTATOR_DATA - Next 2 bytes include the spectator port, then the spectator server name.
if ($Flags & 0x40) {
$server[ 'SpecPort' ] = $buffer->getShort();
$server[ 'SpecName' ] = $buffer->getString();
$server['SpecPort'] = $buffer->getShort();
$server['SpecName'] = $buffer->getString();
}
// S2A_EXTRA_DATA_HAS_GAMETAG_DATA - Next bytes are the game tag string.
if ($Flags & 0x20) {
$server[ 'GameTags' ] = $buffer->getString();
$server['GameTags'] = $buffer->getString();
}
// S2A_EXTRA_DATA_GAMEID - Next 8 bytes are the gameID of the server.
if ($Flags & 0x01) {
$server[ 'GameID' ] = $buffer->getUnsignedLong() | ($buffer->getUnsignedLong() << 32);
$server['GameID'] = $buffer->getUnsignedLong() | ($buffer->getUnsignedLong() << 32);
}
if (!$buffer->isEmpty()) {
throw new InvalidPacketException(
'GetInfo: unread data? ' . $buffer->remaining() . ' bytes remaining in the buffer. Please report it to the library developer.',
InvalidPacketException::BUFFER_NOT_EMPTY
);
throw new InvalidPacketException('GetInfo: unread data? ' . $buffer->remaining() . ' bytes remaining in the buffer. Please report it to the library developer.', InvalidPacketException::BUFFER_NOT_EMPTY);
}
}
@@ -339,7 +331,7 @@ final class SourceQuery
}
/**
* Get players on the server
* Get players on the server.
*
* @throws InvalidPacketException
* @throws SocketException
@@ -360,7 +352,7 @@ final class SourceQuery
$type = $buffer->getByte();
if ($type !== self::S2A_PLAYER) {
if (self::S2A_PLAYER !== $type) {
throw new InvalidPacketException('GetPlayers: Packet header mismatch. (0x' . dechex($type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
@@ -369,11 +361,11 @@ final class SourceQuery
while ($count-- > 0 && !$buffer->isEmpty()) {
$player = [];
$player[ 'Id' ] = $buffer->getByte(); // PlayerID, is it just always 0?
$player[ 'Name' ] = $buffer->getString();
$player[ 'Frags' ] = $buffer->getLong();
$player[ 'Time' ] = (int)$buffer->getFloat();
$player[ 'TimeF' ] = gmdate(($player[ 'Time' ] > 3600 ? 'H:i:s' : 'i:s'), $player[ 'Time' ]);
$player['Id'] = $buffer->getByte(); // PlayerID, is it just always 0?
$player['Name'] = $buffer->getString();
$player['Frags'] = $buffer->getLong();
$player['Time'] = (int) $buffer->getFloat();
$player['TimeF'] = gmdate(($player['Time'] > 3600 ? 'H:i:s' : 'i:s'), $player['Time']);
$players[] = $player;
}
@@ -382,7 +374,7 @@ final class SourceQuery
}
/**
* Get rules (cvars) from the server
* Get rules (cvars) from the server.
*
* @throws InvalidPacketException
* @throws SocketException
@@ -402,7 +394,7 @@ final class SourceQuery
$type = $buffer->getByte();
if ($type !== self::S2A_RULES) {
if (self::S2A_RULES !== $type) {
throw new InvalidPacketException('GetRules: Packet header mismatch. (0x' . dechex($type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
@@ -422,7 +414,7 @@ final class SourceQuery
}
/**
* Sets rcon password, for future use in Rcon()
* Sets rcon password, for future use in Rcon().
*
* @param string $password Rcon Password
*
@@ -438,21 +430,17 @@ final class SourceQuery
switch ($this->socket->getType()) {
case SocketType::GOLDSOURCE:
{
$this->rcon = new GoldSourceRcon($this->socket);
break;
}
case SocketType::SOURCE:
{
$this->rcon = new SourceRcon($this->socket);
break;
}
default:
{
throw new SocketException('Unknown engine.', SocketException::INVALID_ENGINE);
}
}
$this->rcon->open();
@@ -464,11 +452,11 @@ final class SourceQuery
*
* @param string $command Command to execute
*
* @return string Answer from server in string
* @throws InvalidPacketException
* @throws SocketException
*
* @throws AuthenticationException
*
* @return string Answer from server in string
*/
public function rcon(string $command): string
{
@@ -476,7 +464,7 @@ final class SourceQuery
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
if ($this->rcon === null) {
if (null === $this->rcon) {
throw new SocketException('You must set a RCON password before trying to execute a RCON command.', SocketException::NOT_CONNECTED);
}
@@ -484,10 +472,7 @@ final class SourceQuery
}
/**
* Get challenge (used for players/rules packets)
*
* @param int $header
* @param int $expectedResult
* Get challenge (used for players/rules packets).
*
* @throws InvalidPacketException
*/
@@ -508,24 +493,18 @@ final class SourceQuery
switch ($type) {
case self::S2C_CHALLENGE:
{
$this->challenge = $buffer->get(4);
return;
}
case $expectedResult:
{
// Goldsource (HLTV).
return;
}
case 0:
{
throw new InvalidPacketException('GetChallenge: Failed to get challenge.');
}
default:
{
throw new InvalidPacketException('GetChallenge: Packet header mismatch. (0x' . dechex($type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
}
}
}