aandrieux
/
Test-Miroir
mirror of https://github.com/xPaw/PHP-Source-Query.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Bring in CS-Fixer, reformat.

Browse Source
pull/150/head
Anthony Birkett 4 years ago
parent 3bfc073211
commit e62d011689
20 changed files with 1822 additions and 1901 deletions
Show Stats Download Patch File Download Diff File

8
.editorconfig
Unescape View File

@ -1,8 +0,0 @@
# http://editorconfig.org
root = true
[*]
charset = utf-8
indent_style = tab
insert_final_newline = true

1
.gitattributes vendored
Unescape View File

@ -1 +0,0 @@
* text=auto

2
.gitignore vendored
Unescape View File

@ -1,2 +1,4 @@
vendor/
composer.lock
.php-cs-fixer.cache
.idea/

64
Examples/Example.php
Unescape View File

@ -1,34 +1,32 @@
<?php
require __DIR__ . '/../SourceQuery/bootstrap.php';
use xPaw\SourceQuery\SourceQuery;
// For the sake of this example
header( 'Content-Type: text/plain' );
header( 'X-Content-Type-Options: nosniff' );
// Edit this ->
define( 'SQ_SERVER_ADDR', 'localhost' );
define( 'SQ_SERVER_PORT', 27015 );
define( 'SQ_TIMEOUT', 1 );
define( 'SQ_ENGINE', SourceQuery::SOURCE );
// Edit this <-
$Query = new SourceQuery( );
try
{
$Query->Connect( SQ_SERVER_ADDR, SQ_SERVER_PORT, SQ_TIMEOUT, SQ_ENGINE );
print_r( $Query->GetInfo( ) );
print_r( $Query->GetPlayers( ) );
print_r( $Query->GetRules( ) );
}
catch( Exception $e )
{
echo $e->getMessage( );
}
finally
{
$Query->Disconnect( );
}
declare(strict_types=1);
require __DIR__ . '/../SourceQuery/bootstrap.php';
use xPaw\SourceQuery\SourceQuery;
// For the sake of this example
header('Content-Type: text/plain');
header('X-Content-Type-Options: nosniff');
// Edit this ->
define('SQ_SERVER_ADDR', 'localhost');
define('SQ_SERVER_PORT', 27015);
define('SQ_TIMEOUT', 1);
define('SQ_ENGINE', SourceQuery::SOURCE);
// Edit this <-
$Query = new SourceQuery();
try {
$Query->Connect(SQ_SERVER_ADDR, SQ_SERVER_PORT, SQ_TIMEOUT, SQ_ENGINE);
print_r($Query->GetInfo());
print_r($Query->GetPlayers());
print_r($Query->GetRules());
} catch (Exception $e) {
echo $e->getMessage();
} finally {
$Query->Disconnect();
}

64
Examples/RconExample.php
Unescape View File

@ -1,34 +1,32 @@
<?php
require __DIR__ . '/../SourceQuery/bootstrap.php';
use xPaw\SourceQuery\SourceQuery;
// For the sake of this example
header( 'Content-Type: text/plain' );
header( 'X-Content-Type-Options: nosniff' );
// Edit this ->
define( 'SQ_SERVER_ADDR', 'localhost' );
define( 'SQ_SERVER_PORT', 27015 );
define( 'SQ_TIMEOUT', 1 );
define( 'SQ_ENGINE', SourceQuery::SOURCE );
// Edit this <-
$Query = new SourceQuery( );
try
{
$Query->Connect( SQ_SERVER_ADDR, SQ_SERVER_PORT, SQ_TIMEOUT, SQ_ENGINE );
$Query->SetRconPassword( 'my_awesome_password' );
var_dump( $Query->Rcon( 'say hello' ) );
}
catch( Exception $e )
{
echo $e->getMessage( );
}
finally
{
$Query->Disconnect( );
}
declare(strict_types=1);
require __DIR__ . '/../SourceQuery/bootstrap.php';
use xPaw\SourceQuery\SourceQuery;
// For the sake of this example
header('Content-Type: text/plain');
header('X-Content-Type-Options: nosniff');
// Edit this ->
define('SQ_SERVER_ADDR', 'localhost');
define('SQ_SERVER_PORT', 27015);
define('SQ_TIMEOUT', 1);
define('SQ_ENGINE', SourceQuery::SOURCE);
// Edit this <-
$Query = new SourceQuery();
try {
$Query->Connect(SQ_SERVER_ADDR, SQ_SERVER_PORT, SQ_TIMEOUT, SQ_ENGINE);
$Query->SetRconPassword('my_awesome_password');
var_dump($Query->Rcon('say hello'));
} catch (Exception $e) {
echo $e->getMessage();
} finally {
$Query->Disconnect();
}

107
Examples/View.php
Unescape View File

@ -1,43 +1,42 @@
<?php
require __DIR__ . '/../SourceQuery/bootstrap.php';
use xPaw\SourceQuery\SourceQuery;
declare(strict_types=1);
// Edit this ->
define( 'SQ_SERVER_ADDR', 'localhost' );
define( 'SQ_SERVER_PORT', 27015 );
define( 'SQ_TIMEOUT', 3 );
define( 'SQ_ENGINE', SourceQuery::SOURCE );
// Edit this <-
require __DIR__ . '/../SourceQuery/bootstrap.php';
$Timer = microtime( true );
use xPaw\SourceQuery\SourceQuery;
$Query = new SourceQuery( );
// Edit this ->
define('SQ_SERVER_ADDR', 'localhost');
define('SQ_SERVER_PORT', 27015);
define('SQ_TIMEOUT', 3);
define('SQ_ENGINE', SourceQuery::SOURCE);
// Edit this <-
$Info = [];
$Rules = [];
$Players = [];
$Exception = null;
$Timer = microtime(true);
try
{
$Query->Connect( SQ_SERVER_ADDR, SQ_SERVER_PORT, SQ_TIMEOUT, SQ_ENGINE );
$Query = new SourceQuery();
$Info = [];
$Rules = [];
$Players = [];
$Exception = null;
try {
$Query->Connect(SQ_SERVER_ADDR, SQ_SERVER_PORT, SQ_TIMEOUT, SQ_ENGINE);
//$Query->SetUseOldGetChallengeMethod( true ); // Use this when players/rules retrieval fails on games like Starbound
$Info = $Query->GetInfo( );
$Players = $Query->GetPlayers( );
$Rules = $Query->GetRules( );
}
catch( Exception $e )
{
$Info = $Query->GetInfo();
$Players = $Query->GetPlayers();
$Rules = $Query->GetRules();
} catch (Exception $e) {
$Exception = $e;
}
finally
{
$Query->Disconnect( );
}
} finally {
$Query->Disconnect();
}
$Timer = number_format(microtime(true) - $Timer, 4, '.', '');
$Timer = number_format( microtime( true ) - $Timer, 4, '.', '' );
?>
<!DOCTYPE html>
<html>
@ -88,9 +87,9 @@
</div>
<div class="container">
<?php if( $Exception !== null ): ?>
<?php if ($Exception !== null): ?>
<div class="panel panel-error">
<pre class="panel-body"><?php echo htmlspecialchars( $Exception->__toString( ) ); ?></pre>
<pre class="panel-body"><?php echo htmlspecialchars($Exception->__toString()); ?></pre>
</div>
<?php endif; ?>
<div class="row">
@ -103,30 +102,22 @@
</tr>
</thead>
<tbody>
<?php if( !empty( $Info ) ): ?>
<?php foreach( $Info as $InfoKey => $InfoValue ): ?>
<?php if (!empty($Info)): ?>
<?php foreach ($Info as $InfoKey => $InfoValue): ?>
<tr>
<td><?php echo htmlspecialchars( $InfoKey ); ?></td>
<td><?php echo htmlspecialchars($InfoKey); ?></td>
<td><?php
if( is_array( $InfoValue ) )
{
if (is_array($InfoValue)) {
echo "<pre>";
print_r( $InfoValue );
print_r($InfoValue);
echo "</pre>";
}
else
{
if( $InfoValue === true )
{
} else {
if ($InfoValue === true) {
echo 'true';
}
else if( $InfoValue === false )
{
} elseif ($InfoValue === false) {
echo 'false';
}
else
{
echo htmlspecialchars( $InfoValue );
} else {
echo htmlspecialchars($InfoValue);
}
}
?></td>
@ -144,16 +135,16 @@
<table class="table table-bordered table-striped">
<thead>
<tr>
<th>Player <span class="label label-info"><?php echo count( $Players ); ?></span></th>
<th>Player <span class="label label-info"><?php echo count($Players); ?></span></th>
<th class="frags-column">Frags</th>
<th class="frags-column">Time</th>
</tr>
</thead>
<tbody>
<?php if( !empty( $Players ) ): ?>
<?php foreach( $Players as $Player ): ?>
<?php if (!empty($Players)): ?>
<?php foreach ($Players as $Player): ?>
<tr>
<td><?php echo htmlspecialchars( $Player[ 'Name' ] ); ?></td>
<td><?php echo htmlspecialchars($Player[ 'Name' ]); ?></td>
<td><?php echo $Player[ 'Frags' ]; ?></td>
<td><?php echo $Player[ 'TimeF' ]; ?></td>
</tr>
@ -172,15 +163,15 @@
<table class="table table-bordered table-striped">
<thead>
<tr>
<th colspan="2">Rules <span class="label label-info"><?php echo count( $Rules ); ?></span></th>
<th colspan="2">Rules <span class="label label-info"><?php echo count($Rules); ?></span></th>
</tr>
</thead>
<tbody>
<?php if( !empty( $Rules ) ): ?>
<?php foreach( $Rules as $Rule => $Value ): ?>
<?php if (!empty($Rules)): ?>
<?php foreach ($Rules as $Rule => $Value): ?>
<tr>
<td><?php echo htmlspecialchars( $Rule ); ?></td>
<td><?php echo htmlspecialchars( $Value ); ?></td>
<td><?php echo htmlspecialchars($Rule); ?></td>
<td><?php echo htmlspecialchars($Value); ?></td>
</tr>
<?php endforeach; ?>
<?php else: ?>

110
SourceQuery/BaseSocket.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,12 +13,12 @@
* @internal
*/
namespace xPaw\SourceQuery;
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
/**
/**
* Base socket interface
*
* @package xPaw\SourceQuery
@ -23,8 +26,8 @@
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses xPaw\SourceQuery\Exception\SocketException
*/
abstract class BaseSocket
{
abstract class BaseSocket
{
/** @var ?resource */
public $Socket;
public int $Engine;
@ -33,45 +36,39 @@
public int $Port;
public int $Timeout;
public function __destruct( )
public function __destruct()
{
$this->Close( );
$this->Close();
}
abstract public function Close( ) : void;
abstract public function Open( string $Address, int $Port, int $Timeout, int $Engine ) : void;
abstract public function Write( int $Header, string $String = '' ) : bool;
abstract public function Read( int $Length = 1400 ) : Buffer;
abstract public function Close(): void;
abstract public function Open(string $Address, int $Port, int $Timeout, int $Engine): void;
abstract public function Write(int $Header, string $String = ''): bool;
abstract public function Read(int $Length = 1400): Buffer;
protected function ReadInternal( Buffer $Buffer, int $Length, callable $SherlockFunction ) : Buffer
protected function ReadInternal(Buffer $Buffer, int $Length, callable $SherlockFunction): Buffer
{
if( $Buffer->Remaining( ) === 0 )
{
throw new InvalidPacketException( 'Failed to read any data from socket', InvalidPacketException::BUFFER_EMPTY );
if ($Buffer->Remaining() === 0) {
throw new InvalidPacketException('Failed to read any data from socket', InvalidPacketException::BUFFER_EMPTY);
}
$Header = $Buffer->GetLong( );
$Header = $Buffer->GetLong();
if( $Header === -1 ) // Single packet
{
if ($Header === -1) { // Single packet
// We don't have to do anything
}
else if( $Header === -2 ) // Split packet
{
} elseif ($Header === -2) { // Split packet
$Packets = [];
$IsCompressed = false;
$ReadMore = false;
$PacketChecksum = null;
do
{
$RequestID = $Buffer->GetLong( );
do {
$RequestID = $Buffer->GetLong();
switch( $this->Engine )
{
switch ($this->Engine) {
case SourceQuery::GOLDSOURCE:
{
$PacketCountAndNumber = $Buffer->GetByte( );
$PacketCountAndNumber = $Buffer->GetByte();
$PacketCount = $PacketCountAndNumber & 0xF;
$PacketNumber = $PacketCountAndNumber >> 4;
@ -79,61 +76,52 @@
}
case SourceQuery::SOURCE:
{
$IsCompressed = ( $RequestID & 0x80000000 ) !== 0;
$PacketCount = $Buffer->GetByte( );
$PacketNumber = $Buffer->GetByte( ) + 1;
$IsCompressed = ($RequestID & 0x80000000) !== 0;
$PacketCount = $Buffer->GetByte();
$PacketNumber = $Buffer->GetByte() + 1;
if( $IsCompressed )
{
$Buffer->GetLong( ); // Split size
if ($IsCompressed) {
$Buffer->GetLong(); // Split size
$PacketChecksum = $Buffer->GetUnsignedLong( );
}
else
{
$Buffer->GetShort( ); // Split size
$PacketChecksum = $Buffer->GetUnsignedLong();
} else {
$Buffer->GetShort(); // Split size
}
break;
}
default:
{
throw new SocketException( 'Unknown engine.', SocketException::INVALID_ENGINE );
throw new SocketException('Unknown engine.', SocketException::INVALID_ENGINE);
}
}
$Packets[ $PacketNumber ] = $Buffer->Get( );
$Packets[ $PacketNumber ] = $Buffer->Get();
$ReadMore = $PacketCount > sizeof( $Packets );
}
while( $ReadMore && $SherlockFunction( $Buffer, $Length ) );
$ReadMore = $PacketCount > sizeof($Packets);
} while ($ReadMore && $SherlockFunction($Buffer, $Length));
$Data = implode( $Packets );
$Data = implode($Packets);
// TODO: Test this
if( $IsCompressed )
{
if ($IsCompressed) {
// Let's make sure this function exists, it's not included in PHP by default
if( !function_exists( 'bzdecompress' ) )
{
throw new \RuntimeException( 'Received compressed packet, PHP doesn\'t have Bzip2 library installed, can\'t decompress.' );
if (!function_exists('bzdecompress')) {
throw new \RuntimeException('Received compressed packet, PHP doesn\'t have Bzip2 library installed, can\'t decompress.');
}
$Data = bzdecompress( $Data );
$Data = bzdecompress($Data);
if( !is_string( $Data ) || crc32( $Data ) !== $PacketChecksum )
{
throw new InvalidPacketException( 'CRC32 checksum mismatch of uncompressed packet data.', InvalidPacketException::CHECKSUM_MISMATCH );
if (!is_string($Data) || crc32($Data) !== $PacketChecksum) {
throw new InvalidPacketException('CRC32 checksum mismatch of uncompressed packet data.', InvalidPacketException::CHECKSUM_MISMATCH);
}
}
$Buffer->Set( substr( $Data, 4 ) );
}
else
{
throw new InvalidPacketException( 'Socket read: Raw packet header mismatch. (0x' . dechex( $Header ) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH );
$Buffer->Set(substr($Data, 4));
} else {
throw new InvalidPacketException('Socket read: Raw packet header mismatch. (0x' . dechex($Header) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
return $Buffer;
}
}
}

88
SourceQuery/Buffer.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,19 +13,19 @@
* @internal
*/
namespace xPaw\SourceQuery;
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
/**
/**
* Class Buffer
*
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
*/
class Buffer
{
final class Buffer
{
/**
* Buffer
*/
@ -41,10 +44,10 @@
/**
* Sets buffer
*/
public function Set( string $Buffer ) : void
public function Set(string $Buffer): void
{
$this->Buffer = $Buffer;
$this->Length = strlen( $Buffer );
$this->Length = strlen($Buffer);
$this->Position = 0;
}
@ -53,7 +56,7 @@
*
* @return int Remaining bytes in buffer
*/
public function Remaining( ) : int
public function Remaining(): int
{
return $this->Length - $this->Position;
}
@ -63,25 +66,21 @@
*
* @param int $Length Bytes to read
*/
public function Get( int $Length = -1 ) : string
{
if( $Length === 0 )
public function Get(int $Length = -1): string
{
if ($Length === 0) {
return '';
}
$Remaining = $this->Remaining( );
$Remaining = $this->Remaining();
if( $Length === -1 )
{
if ($Length === -1) {
$Length = $Remaining;
}
else if( $Length > $Remaining )
{
} elseif ($Length > $Remaining) {
return '';
}
$Data = substr( $this->Buffer, $this->Position, $Length );
$Data = substr($this->Buffer, $this->Position, $Length);
$this->Position += $Length;
@ -91,22 +90,21 @@
/**
* Get byte from buffer
*/
public function GetByte( ) : int
public function GetByte(): int
{
return ord( $this->Get( 1 ) );
return ord($this->Get(1));
}
/**
* Get short from buffer
*/
public function GetShort( ) : int
{
if( $this->Remaining( ) < 2 )
public function GetShort(): int
{
throw new InvalidPacketException( 'Not enough data to unpack a short.', InvalidPacketException::BUFFER_EMPTY );
if ($this->Remaining() < 2) {
throw new InvalidPacketException('Not enough data to unpack a short.', InvalidPacketException::BUFFER_EMPTY);
}
$Data = unpack( 'v', $this->Get( 2 ) );
$Data = unpack('v', $this->Get(2));
return (int)$Data[ 1 ];
}
@ -114,14 +112,13 @@
/**
* Get long from buffer
*/
public function GetLong( ) : int
public function GetLong(): int
{
if( $this->Remaining( ) < 4 )
{
throw new InvalidPacketException( 'Not enough data to unpack a long.', InvalidPacketException::BUFFER_EMPTY );
if ($this->Remaining() < 4) {
throw new InvalidPacketException('Not enough data to unpack a long.', InvalidPacketException::BUFFER_EMPTY);
}
$Data = unpack( 'l', $this->Get( 4 ) );
$Data = unpack('l', $this->Get(4));
return (int)$Data[ 1 ];
}
@ -129,14 +126,13 @@
/**
* Get float from buffer
*/
public function GetFloat( ) : float
{
if( $this->Remaining( ) < 4 )
public function GetFloat(): float
{
throw new InvalidPacketException( 'Not enough data to unpack a float.', InvalidPacketException::BUFFER_EMPTY );
if ($this->Remaining() < 4) {
throw new InvalidPacketException('Not enough data to unpack a float.', InvalidPacketException::BUFFER_EMPTY);
}
$Data = unpack( 'f', $this->Get( 4 ) );
$Data = unpack('f', $this->Get(4));
return (float)$Data[ 1 ];
}
@ -144,14 +140,13 @@
/**
* Get unsigned long from buffer
*/
public function GetUnsignedLong( ) : int
public function GetUnsignedLong(): int
{
if( $this->Remaining( ) < 4 )
{
throw new InvalidPacketException( 'Not enough data to unpack an usigned long.', InvalidPacketException::BUFFER_EMPTY );
if ($this->Remaining() < 4) {
throw new InvalidPacketException('Not enough data to unpack an usigned long.', InvalidPacketException::BUFFER_EMPTY);
}
$Data = unpack( 'V', $this->Get( 4 ) );
$Data = unpack('V', $this->Get(4));
return (int)$Data[ 1 ];
}
@ -159,19 +154,18 @@
/**
* Read one string from buffer ending with null byte
*/
public function GetString( ) : string
public function GetString(): string
{
$ZeroBytePosition = strpos( $this->Buffer, "\0", $this->Position );
$ZeroBytePosition = strpos($this->Buffer, "\0", $this->Position);
if( $ZeroBytePosition === false )
{
if ($ZeroBytePosition === false) {
return '';
}
$String = $this->Get( $ZeroBytePosition - $this->Position );
$String = $this->Get($ZeroBytePosition - $this->Position);
$this->Position++;
return $String;
}
}
}

17
SourceQuery/Exception/AuthenticationException.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,10 +13,10 @@
* @internal
*/
namespace xPaw\SourceQuery\Exception;
namespace xPaw\SourceQuery\Exception;
class AuthenticationException extends SourceQueryException
{
const BAD_PASSWORD = 1;
const BANNED = 2;
}
final class AuthenticationException extends SourceQueryException
{
public const BAD_PASSWORD = 1;
public const BANNED = 2;
}

15
SourceQuery/Exception/InvalidArgumentException.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,9 +13,9 @@
* @internal
*/
namespace xPaw\SourceQuery\Exception;
namespace xPaw\SourceQuery\Exception;
class InvalidArgumentException extends SourceQueryException
{
const TIMEOUT_NOT_INTEGER = 1;
}
final class InvalidArgumentException extends SourceQueryException
{
public const TIMEOUT_NOT_INTEGER = 1;
}

21
SourceQuery/Exception/InvalidPacketException.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,12 +13,12 @@
* @internal
*/
namespace xPaw\SourceQuery\Exception;
namespace xPaw\SourceQuery\Exception;
class InvalidPacketException extends SourceQueryException
{
const PACKET_HEADER_MISMATCH = 1;
const BUFFER_EMPTY = 2;
const BUFFER_NOT_EMPTY = 3;
const CHECKSUM_MISMATCH = 4;
}
final class InvalidPacketException extends SourceQueryException
{
public const PACKET_HEADER_MISMATCH = 1;
public const BUFFER_EMPTY = 2;
public const BUFFER_NOT_EMPTY = 3;
public const CHECKSUM_MISMATCH = 4;
}

21
SourceQuery/Exception/SocketException.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,12 +13,12 @@
* @internal
*/
namespace xPaw\SourceQuery\Exception;
namespace xPaw\SourceQuery\Exception;
class SocketException extends SourceQueryException
{
const COULD_NOT_CREATE_SOCKET = 1;
const NOT_CONNECTED = 2;
const CONNECTION_FAILED = 3;
const INVALID_ENGINE = 3;
}
final class SocketException extends SourceQueryException
{
public const COULD_NOT_CREATE_SOCKET = 1;
public const NOT_CONNECTED = 2;
public const CONNECTION_FAILED = 3;
public const INVALID_ENGINE = 3;
}

13
SourceQuery/Exception/SourceQueryException.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,9 +13,9 @@
* @internal
*/
namespace xPaw\SourceQuery\Exception;
namespace xPaw\SourceQuery\Exception;
abstract class SourceQueryException extends \Exception
{
abstract class SourceQueryException extends \Exception
{
// Base exception class
}
}

107
SourceQuery/GoldSourceRcon.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,21 +13,21 @@
* @internal
*/
namespace xPaw\SourceQuery;
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
/**
/**
* Class GoldSourceRcon
*
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\AuthenticationException
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses AuthenticationException
* @uses InvalidPacketException
*/
class GoldSourceRcon
{
final class GoldSourceRcon
{
/**
* Points to socket class
*
@ -35,28 +38,28 @@
private string $RconPassword = '';
private string $RconChallenge = '';
public function __construct( BaseSocket $Socket )
public function __construct(BaseSocket $Socket)
{
$this->Socket = $Socket;
}
public function Close( ) : void
public function Close(): void
{
$this->RconChallenge = '';
$this->RconPassword = '';
}
public function Open( ) : void
public function Open(): void
{
//
}
public function Write( int $Header, string $String = '' ) : bool
public function Write(int $Header, string $String = ''): bool
{
$Command = pack( 'cccca*', 0xFF, 0xFF, 0xFF, 0xFF, $String );
$Length = strlen( $Command );
$Command = pack('cccca*', 0xFF, 0xFF, 0xFF, 0xFF, $String);
$Length = strlen($Command);
return $Length === fwrite( $this->Socket->Socket, $Command, $Length );
return $Length === fwrite($this->Socket->Socket, $Command, $Length);
}
/**
@ -64,82 +67,72 @@
* @throws AuthenticationException
* @return Buffer
*/
public function Read( int $Length = 1400 ) : Buffer
public function Read(int $Length = 1400): Buffer
{
// GoldSource RCON has same structure as Query
$Buffer = $this->Socket->Read( );
$Buffer = $this->Socket->Read();
$StringBuffer = '';
$ReadMore = false;
// There is no indentifier of the end, so we just need to continue reading
do
{
$ReadMore = $Buffer->Remaining( ) > 0;
do {
$ReadMore = $Buffer->Remaining() > 0;
if( $ReadMore )
{
if( $Buffer->GetByte( ) !== SourceQuery::S2A_RCON )
{
throw new InvalidPacketException( 'Invalid rcon response.', InvalidPacketException::PACKET_HEADER_MISMATCH );
if ($ReadMore) {
if ($Buffer->GetByte() !== SourceQuery::S2A_RCON) {
throw new InvalidPacketException('Invalid rcon response.', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
$Packet = $Buffer->Get( );
$Packet = $Buffer->Get();
$StringBuffer .= $Packet;
//$StringBuffer .= SubStr( $Packet, 0, -2 );
// Let's assume if this packet is not long enough, there are no more after this one
$ReadMore = strlen( $Packet ) > 1000; // use 1300?
$ReadMore = strlen($Packet) > 1000; // use 1300?
if( $ReadMore )
{
$Buffer = $this->Socket->Read( );
}
if ($ReadMore) {
$Buffer = $this->Socket->Read();
}
}
while( $ReadMore );
} while ($ReadMore);
$Trimmed = trim( $StringBuffer );
$Trimmed = trim($StringBuffer);
if( $Trimmed === 'Bad rcon_password.' )
{
throw new AuthenticationException( $Trimmed, AuthenticationException::BAD_PASSWORD );
}
else if( $Trimmed === 'You have been banned from this server.' )
{
throw new AuthenticationException( $Trimmed, AuthenticationException::BANNED );
if ($Trimmed === 'Bad rcon_password.') {
throw new AuthenticationException($Trimmed, AuthenticationException::BAD_PASSWORD);
} elseif ($Trimmed === 'You have been banned from this server.') {
throw new AuthenticationException($Trimmed, AuthenticationException::BANNED);
}
$Buffer->Set( $Trimmed );
$Buffer->Set($Trimmed);
return $Buffer;
}
public function Command( string $Command ) : string
{
if( !$this->RconChallenge )
public function Command(string $Command): string
{
throw new AuthenticationException( 'Tried to execute a RCON command before successful authorization.', AuthenticationException::BAD_PASSWORD );
if (!$this->RconChallenge) {
throw new AuthenticationException('Tried to execute a RCON command before successful authorization.', AuthenticationException::BAD_PASSWORD);
}
$this->Write( 0, 'rcon ' . $this->RconChallenge . ' "' . $this->RconPassword . '" ' . $Command . "\0" );
$Buffer = $this->Read( );
$this->Write(0, 'rcon ' . $this->RconChallenge . ' "' . $this->RconPassword . '" ' . $Command . "\0");
$Buffer = $this->Read();
return $Buffer->Get( );
return $Buffer->Get();
}
public function Authorize( string $Password ) : void
public function Authorize(string $Password): void
{
$this->RconPassword = $Password;
$this->Write( 0, 'challenge rcon' );
$Buffer = $this->Socket->Read( );
$this->Write(0, 'challenge rcon');
$Buffer = $this->Socket->Read();
if( $Buffer->Get( 14 ) !== 'challenge rcon' )
{
throw new AuthenticationException( 'Failed to get RCON challenge.', AuthenticationException::BAD_PASSWORD );
if ($Buffer->Get(14) !== 'challenge rcon') {
throw new AuthenticationException('Failed to get RCON challenge.', AuthenticationException::BAD_PASSWORD);
}
$this->RconChallenge = trim( $Buffer->Get( ) );
}
$this->RconChallenge = trim($Buffer->Get());
}
}

70
SourceQuery/Socket.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,56 +13,54 @@
* @internal
*/
namespace xPaw\SourceQuery;
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
/**
/**
* Class Socket
*
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses xPaw\SourceQuery\Exception\SocketException
* @uses InvalidPacketException
* @uses SocketException
*/
class Socket extends BaseSocket
{
public function Close( ) : void
final class Socket extends BaseSocket
{
public function Close(): void
{
if( $this->Socket !== null )
{
fclose( $this->Socket );
if ($this->Socket !== null) {
fclose($this->Socket);
$this->Socket = null;
}
}
public function Open( string $Address, int $Port, int $Timeout, int $Engine ) : void
public function Open(string $Address, int $Port, int $Timeout, int $Engine): void
{
$this->Timeout = $Timeout;
$this->Engine = $Engine;
$this->Port = $Port;
$this->Address = $Address;
$Socket = @fsockopen( 'udp://' . $Address, $Port, $ErrNo, $ErrStr, $Timeout );
$Socket = @fsockopen('udp://' . $Address, $Port, $ErrNo, $ErrStr, $Timeout);
if( $ErrNo || $Socket === false )
{
throw new SocketException( 'Could not create socket: ' . $ErrStr, SocketException::COULD_NOT_CREATE_SOCKET );
if ($ErrNo || $Socket === false) {
throw new SocketException('Could not create socket: ' . $ErrStr, SocketException::COULD_NOT_CREATE_SOCKET);
}
$this->Socket = $Socket;
stream_set_timeout( $this->Socket, $Timeout );
stream_set_blocking( $this->Socket, true );
stream_set_timeout($this->Socket, $Timeout);
stream_set_blocking($this->Socket, true);
}
public function Write( int $Header, string $String = '' ) : bool
public function Write(int $Header, string $String = ''): bool
{
$Command = pack( 'ccccca*', 0xFF, 0xFF, 0xFF, 0xFF, $Header, $String );
$Length = strlen( $Command );
$Command = pack('ccccca*', 0xFF, 0xFF, 0xFF, 0xFF, $Header, $String);
$Length = strlen($Command);
return $Length === fwrite( $this->Socket, $Command, $Length );
return $Length === fwrite($this->Socket, $Command, $Length);
}
/**
@ -69,27 +70,26 @@
*
* @return Buffer Buffer
*/
public function Read( int $Length = 1400 ) : Buffer
public function Read(int $Length = 1400): Buffer
{
$Buffer = new Buffer( );
$Buffer->Set( fread( $this->Socket, $Length ) );
$Buffer = new Buffer();
$Buffer->Set(fread($this->Socket, $Length));
$this->ReadInternal( $Buffer, $Length, [ $this, 'Sherlock' ] );
$this->ReadInternal($Buffer, $Length, [ $this, 'Sherlock' ]);
return $Buffer;
}
public function Sherlock( Buffer $Buffer, int $Length ) : bool
public function Sherlock(Buffer $Buffer, int $Length): bool
{
$Data = fread( $this->Socket, $Length );
$Data = fread($this->Socket, $Length);
if( strlen( $Data ) < 4 )
{
if (strlen($Data) < 4) {
return false;
}
$Buffer->Set( $Data );
$Buffer->Set($Data);
return $Buffer->GetLong( ) === -2;
}
return $Buffer->GetLong() === -2;
}
}

434
SourceQuery/SourceQuery.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* This class provides the public interface to the PHP-Source-Query library.
*
* @author Pavel Djundik
@ -10,63 +13,63 @@
* @license GNU Lesser General Public License, version 2.1
*/
namespace xPaw\SourceQuery;
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidArgumentException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidArgumentException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
/**
/**
* Class SourceQuery
*
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\AuthenticationException
* @uses xPaw\SourceQuery\Exception\InvalidArgumentException
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses xPaw\SourceQuery\Exception\SocketException
* @uses AuthenticationException
* @uses InvalidArgumentException
* @uses InvalidPacketException
* @uses SocketException
*/
class SourceQuery
{
final class SourceQuery
{
/**
* Engines
*/
const GOLDSOURCE = 0;
const SOURCE = 1;
public const GOLDSOURCE = 0;
public const SOURCE = 1;
/**
* Packets sent
*/
const A2A_PING = 0x69;
const A2S_INFO = 0x54;
const A2S_PLAYER = 0x55;
const A2S_RULES = 0x56;
const A2S_SERVERQUERY_GETCHALLENGE = 0x57;
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
*/
const A2A_ACK = 0x6A;
const S2C_CHALLENGE = 0x41;
const S2A_INFO_SRC = 0x49;
const S2A_INFO_OLD = 0x6D; // Old GoldSource, HLTV uses it (actually called S2A_INFO_DETAILED)
const S2A_PLAYER = 0x44;
const S2A_RULES = 0x45;
const S2A_RCON = 0x6C;
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;
/**
* Source rcon sent
*/
const SERVERDATA_REQUESTVALUE = 0;
const SERVERDATA_EXECCOMMAND = 2;
const SERVERDATA_AUTH = 3;
public const SERVERDATA_REQUESTVALUE = 0;
public const SERVERDATA_EXECCOMMAND = 2;
public const SERVERDATA_AUTH = 3;
/**
* Source rcon received
*/
const SERVERDATA_RESPONSE_VALUE = 0;
const SERVERDATA_AUTH_RESPONSE = 2;
public const SERVERDATA_RESPONSE_VALUE = 0;
public const SERVERDATA_AUTH_RESPONSE = 2;
/**
* Points to rcon class
@ -95,14 +98,14 @@
*/
private bool $UseOldGetChallengeMethod = false;
public function __construct( BaseSocket $Socket = null )
public function __construct(BaseSocket $Socket = null)
{
$this->Socket = $Socket ?: new Socket( );
$this->Socket = $Socket ?: new Socket();
}
public function __destruct( )
public function __destruct()
{
$this->Disconnect( );
$this->Disconnect();
}
/**
@ -116,16 +119,15 @@
* @throws InvalidArgumentException
* @throws SocketException
*/
public function Connect( string $Address, int $Port, int $Timeout = 3, int $Engine = self::SOURCE ) : void
public function Connect(string $Address, int $Port, int $Timeout = 3, int $Engine = self::SOURCE): void
{
$this->Disconnect( );
$this->Disconnect();
if( $Timeout < 0 )
{
throw new InvalidArgumentException( 'Timeout must be a positive integer.', InvalidArgumentException::TIMEOUT_NOT_INTEGER );
if ($Timeout < 0) {
throw new InvalidArgumentException('Timeout must be a positive integer.', InvalidArgumentException::TIMEOUT_NOT_INTEGER);
}
$this->Socket->Open( $Address, $Port, $Timeout, $Engine );
$this->Socket->Open($Address, $Port, $Timeout, $Engine);
$this->Connected = true;
}
@ -137,7 +139,7 @@
*
* @returns bool Previous value
*/
public function SetUseOldGetChallengeMethod( bool $Value ) : bool
public function SetUseOldGetChallengeMethod(bool $Value): bool
{
$Previous = $this->UseOldGetChallengeMethod;
@ -149,16 +151,15 @@
/**
* Closes all open connections
*/
public function Disconnect( ) : void
public function Disconnect(): void
{
$this->Connected = false;
$this->Challenge = '';
$this->Socket->Close( );
$this->Socket->Close();
if( $this->Rcon )
{
$this->Rcon->Close( );
if ($this->Rcon) {
$this->Rcon->Close();
$this->Rcon = null;
}
@ -173,17 +174,16 @@
*
* @return bool True on success, false on failure
*/
public function Ping( ) : bool
{
if( !$this->Connected )
public function Ping(): bool
{
throw new SocketException( 'Not connected.', SocketException::NOT_CONNECTED );
if (!$this->Connected) {
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
$this->Socket->Write( self::A2A_PING );
$Buffer = $this->Socket->Read( );
$this->Socket->Write(self::A2A_PING);
$Buffer = $this->Socket->Read();
return $Buffer->GetByte( ) === self::A2A_ACK;
return $Buffer->GetByte() === self::A2A_ACK;
}
/**
@ -194,171 +194,151 @@
*
* @return array Returns an array with information on success
*/
public function GetInfo( ) : array
{
if( !$this->Connected )
public function GetInfo(): array
{
throw new SocketException( 'Not connected.', SocketException::NOT_CONNECTED );
if (!$this->Connected) {
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
if( $this->Challenge )
{
$this->Socket->Write( self::A2S_INFO, "Source Engine Query\0" . $this->Challenge );
}
else
{
$this->Socket->Write( self::A2S_INFO, "Source Engine Query\0" );
if ($this->Challenge) {
$this->Socket->Write(self::A2S_INFO, "Source Engine Query\0" . $this->Challenge);
} else {
$this->Socket->Write(self::A2S_INFO, "Source Engine Query\0");
}
$Buffer = $this->Socket->Read( );
$Type = $Buffer->GetByte( );
$Buffer = $this->Socket->Read();
$Type = $Buffer->GetByte();
$Server = [];
if( $Type === self::S2C_CHALLENGE )
{
$this->Challenge = $Buffer->Get( 4 );
if ($Type === self::S2C_CHALLENGE) {
$this->Challenge = $Buffer->Get(4);
$this->Socket->Write( self::A2S_INFO, "Source Engine Query\0" . $this->Challenge );
$Buffer = $this->Socket->Read( );
$Type = $Buffer->GetByte( );
$this->Socket->Write(self::A2S_INFO, "Source Engine Query\0" . $this->Challenge);
$Buffer = $this->Socket->Read();
$Type = $Buffer->GetByte();
}
// Old GoldSource protocol, HLTV still uses it
if( $Type === self::S2A_INFO_OLD && $this->Socket->Engine === self::GOLDSOURCE )
{
if ($Type === self::S2A_INFO_OLD && $this->Socket->Engine === self::GOLDSOURCE) {
/**
* 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;
if( $Server[ 'IsMod' ] )
{
$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;
if ($Server[ 'IsMod' ]) {
$Mod = [];
$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;
$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;
}
$Server[ 'Secure' ] = $Buffer->GetByte( ) === 1;
$Server[ 'Bots' ] = $Buffer->GetByte( );
$Server[ 'Secure' ] = $Buffer->GetByte() === 1;
$Server[ 'Bots' ] = $Buffer->GetByte();
return $Server;
}
if( $Type !== self::S2A_INFO_SRC )
{
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;
if ($Type !== self::S2A_INFO_SRC) {
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;
// 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 ($Server[ 'AppID' ] === 2400) {
$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( );
if ($Buffer->Remaining() > 0) {
$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( );
if ($Flags & 0x80) {
$Server[ 'GamePort' ] = $Buffer->GetShort();
}
// S2A_EXTRA_DATA_HAS_STEAMID - Next 8 bytes are the steamID
// Want to play around with this?
// You can use https://github.com/xPaw/SteamID.php
if( $Flags & 0x10 )
{
$SteamIDLower = $Buffer->GetUnsignedLong( );
$SteamIDInstance = $Buffer->GetUnsignedLong( ); // This gets shifted by 32 bits, which should be steamid instance
if ($Flags & 0x10) {
$SteamIDLower = $Buffer->GetUnsignedLong();
$SteamIDInstance = $Buffer->GetUnsignedLong(); // This gets shifted by 32 bits, which should be steamid instance
$SteamID = 0;
if( PHP_INT_SIZE === 4 )
{
if( extension_loaded( 'gmp' ) )
{
$SteamIDLower = gmp_abs( $SteamIDLower );
$SteamIDInstance = gmp_abs( $SteamIDInstance );
$SteamID = gmp_strval( gmp_or( $SteamIDLower, gmp_mul( $SteamIDInstance, gmp_pow( 2, 32 ) ) ) );
if (PHP_INT_SIZE === 4) {
if (extension_loaded('gmp')) {
$SteamIDLower = gmp_abs($SteamIDLower);
$SteamIDInstance = gmp_abs($SteamIDInstance);
$SteamID = gmp_strval(gmp_or($SteamIDLower, gmp_mul($SteamIDInstance, gmp_pow(2, 32))));
} else {
throw new \RuntimeException('Either 64-bit PHP installation or "gmp" module is required to correctly parse server\'s steamid.');
}
else
{
throw new \RuntimeException( 'Either 64-bit PHP installation or "gmp" module is required to correctly parse server\'s steamid.' );
}
}
else
{
$SteamID = $SteamIDLower | ( $SteamIDInstance << 32 );
} else {
$SteamID = $SteamIDLower | ($SteamIDInstance << 32);
}
$Server[ 'SteamID' ] = $SteamID;
unset( $SteamIDLower, $SteamIDInstance, $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( );
if ($Flags & 0x40) {
$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( );
if ($Flags & 0x20) {
$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 );
if ($Flags & 0x01) {
$Server[ 'GameID' ] = $Buffer->GetUnsignedLong() | ($Buffer->GetUnsignedLong() << 32);
}
if( $Buffer->Remaining( ) > 0 )
{
throw new InvalidPacketException( 'GetInfo: unread data? ' . $Buffer->Remaining( ) . ' bytes remaining in the buffer. Please report it to the library developer.',
InvalidPacketException::BUFFER_NOT_EMPTY );
if ($Buffer->Remaining() > 0) {
throw new InvalidPacketException(
'GetInfo: unread data? ' . $Buffer->Remaining() . ' bytes remaining in the buffer. Please report it to the library developer.',
InvalidPacketException::BUFFER_NOT_EMPTY
);
}
}
@ -373,37 +353,34 @@
*
* @return array Returns an array with players on success
*/
public function GetPlayers( ) : array
{
if( !$this->Connected )
public function GetPlayers(): array
{
throw new SocketException( 'Not connected.', SocketException::NOT_CONNECTED );
if (!$this->Connected) {
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
$this->GetChallenge( self::A2S_PLAYER, self::S2A_PLAYER );
$this->GetChallenge(self::A2S_PLAYER, self::S2A_PLAYER);
$this->Socket->Write( self::A2S_PLAYER, $this->Challenge );
$Buffer = $this->Socket->Read( 14000 ); // Moronic Arma 3 developers do not split their packets, so we have to read more data
$this->Socket->Write(self::A2S_PLAYER, $this->Challenge);
$Buffer = $this->Socket->Read(14000); // Moronic Arma 3 developers do not split their packets, so we have to read more data
// This violates the protocol spec, and they probably should fix it: https://developer.valvesoftware.com/wiki/Server_queries#Protocol
$Type = $Buffer->GetByte( );
$Type = $Buffer->GetByte();
if( $Type !== self::S2A_PLAYER )
{
throw new InvalidPacketException( 'GetPlayers: Packet header mismatch. (0x' . dechex( $Type ) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH );
if ($Type !== self::S2A_PLAYER) {
throw new InvalidPacketException('GetPlayers: Packet header mismatch. (0x' . dechex($Type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
$Players = [];
$Count = $Buffer->GetByte( );
$Count = $Buffer->GetByte();
while( $Count-- > 0 && $Buffer->Remaining( ) > 0 )
{
while ($Count-- > 0 && $Buffer->Remaining() > 0) {
$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;
}
@ -419,35 +396,31 @@
*
* @return array Returns an array with rules on success
*/
public function GetRules( ) : array
{
if( !$this->Connected )
public function GetRules(): array
{
throw new SocketException( 'Not connected.', SocketException::NOT_CONNECTED );
if (!$this->Connected) {
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
$this->GetChallenge( self::A2S_RULES, self::S2A_RULES );
$this->GetChallenge(self::A2S_RULES, self::S2A_RULES);
$this->Socket->Write( self::A2S_RULES, $this->Challenge );
$Buffer = $this->Socket->Read( );
$this->Socket->Write(self::A2S_RULES, $this->Challenge);
$Buffer = $this->Socket->Read();
$Type = $Buffer->GetByte( );
$Type = $Buffer->GetByte();
if( $Type !== self::S2A_RULES )
{
throw new InvalidPacketException( 'GetRules: Packet header mismatch. (0x' . dechex( $Type ) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH );
if ($Type !== self::S2A_RULES) {
throw new InvalidPacketException('GetRules: Packet header mismatch. (0x' . dechex($Type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
$Rules = [];
$Count = $Buffer->GetShort( );
$Count = $Buffer->GetShort();
while( $Count-- > 0 && $Buffer->Remaining( ) > 0 )
{
$Rule = $Buffer->GetString( );
$Value = $Buffer->GetString( );
while ($Count-- > 0 && $Buffer->Remaining() > 0) {
$Rule = $Buffer->GetString();
$Value = $Buffer->GetString();
if( !empty( $Rule ) )
{
if (!empty($Rule)) {
$Rules[ $Rule ] = $Value;
}
}
@ -460,28 +433,25 @@
*
* @throws InvalidPacketException
*/
private function GetChallenge( int $Header, int $ExpectedResult ) : void
{
if( $this->Challenge )
private function GetChallenge(int $Header, int $ExpectedResult): void
{
if ($this->Challenge) {
return;
}
if( $this->UseOldGetChallengeMethod )
{
if ($this->UseOldGetChallengeMethod) {
$Header = self::A2S_SERVERQUERY_GETCHALLENGE;
}
$this->Socket->Write( $Header, "\xFF\xFF\xFF\xFF" );
$Buffer = $this->Socket->Read( );
$this->Socket->Write($Header, "\xFF\xFF\xFF\xFF");
$Buffer = $this->Socket->Read();
$Type = $Buffer->GetByte( );
$Type = $Buffer->GetByte();
switch( $Type )
{
switch ($Type) {
case self::S2C_CHALLENGE:
{
$this->Challenge = $Buffer->Get( 4 );
$this->Challenge = $Buffer->Get(4);
return;
}
@ -493,11 +463,11 @@
}
case 0:
{
throw new InvalidPacketException( 'GetChallenge: Failed to get challenge.' );
throw new InvalidPacketException('GetChallenge: Failed to get challenge.');
}
default:
{
throw new InvalidPacketException( 'GetChallenge: Packet header mismatch. (0x' . dechex( $Type ) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH );
throw new InvalidPacketException('GetChallenge: Packet header mismatch. (0x' . dechex($Type) . ')', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
}
}
@ -511,35 +481,33 @@
* @throws InvalidPacketException
* @throws SocketException
*/
public function SetRconPassword( string $Password ) : void
public function SetRconPassword(string $Password): void
{
if( !$this->Connected )
{
throw new SocketException( 'Not connected.', SocketException::NOT_CONNECTED );
if (!$this->Connected) {
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
switch( $this->Socket->Engine )
{
switch ($this->Socket->Engine) {
case SourceQuery::GOLDSOURCE:
{
$this->Rcon = new GoldSourceRcon( $this->Socket );
$this->Rcon = new GoldSourceRcon($this->Socket);
break;
}
case SourceQuery::SOURCE:
{
$this->Rcon = new SourceRcon( $this->Socket );
$this->Rcon = new SourceRcon($this->Socket);
break;
}
default:
{
throw new SocketException( 'Unknown engine.', SocketException::INVALID_ENGINE );
throw new SocketException('Unknown engine.', SocketException::INVALID_ENGINE);
}
}
$this->Rcon->Open( );
$this->Rcon->Authorize( $Password );
$this->Rcon->Open();
$this->Rcon->Authorize($Password);
}
/**
@ -553,18 +521,16 @@
*
* @return string Answer from server in string
*/
public function Rcon( string $Command ) : string
{
if( !$this->Connected )
public function Rcon(string $Command): string
{
throw new SocketException( 'Not connected.', SocketException::NOT_CONNECTED );
if (!$this->Connected) {
throw new SocketException('Not connected.', SocketException::NOT_CONNECTED);
}
if( $this->Rcon === null )
{
throw new SocketException( 'You must set a RCON password before trying to execute a RCON command.', SocketException::NOT_CONNECTED );
if ($this->Rcon === null) {
throw new SocketException('You must set a RCON password before trying to execute a RCON command.', SocketException::NOT_CONNECTED);
}
return $this->Rcon->Command( $Command );
}
return $this->Rcon->Command($Command);
}
}

167
SourceQuery/SourceRcon.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* @author Pavel Djundik
*
* @link https://xpaw.me
@ -10,23 +13,23 @@
* @internal
*/
namespace xPaw\SourceQuery;
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
/**
/**
* Class SourceRcon
*
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\AuthenticationException
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses xPaw\SourceQuery\Exception\SocketException
* @uses AuthenticationException
* @uses InvalidPacketException
* @uses SocketException
*/
class SourceRcon
{
final class SourceRcon
{
/**
* Points to socket class
*/
@ -36,16 +39,15 @@
private $RconSocket;
private int $RconRequestId = 0;
public function __construct( BaseSocket $Socket )
public function __construct(BaseSocket $Socket)
{
$this->Socket = $Socket;
}
public function Close( ) : void
{
if( $this->RconSocket )
public function Close(): void
{
fclose( $this->RconSocket );
if ($this->RconSocket) {
fclose($this->RconSocket);
$this->RconSocket = null;
}
@ -53,147 +55,132 @@
$this->RconRequestId = 0;
}
public function Open( ) : void
public function Open(): void
{
if( !$this->RconSocket )
{
$RconSocket = @fsockopen( $this->Socket->Address, $this->Socket->Port, $ErrNo, $ErrStr, $this->Socket->Timeout );
if (!$this->RconSocket) {
$RconSocket = @fsockopen($this->Socket->Address, $this->Socket->Port, $ErrNo, $ErrStr, $this->Socket->Timeout);
if( $ErrNo || !$RconSocket )
{
throw new SocketException( 'Can\'t connect to RCON server: ' . $ErrStr, SocketException::CONNECTION_FAILED );
if ($ErrNo || !$RconSocket) {
throw new SocketException('Can\'t connect to RCON server: ' . $ErrStr, SocketException::CONNECTION_FAILED);
}
$this->RconSocket = $RconSocket;
stream_set_timeout( $this->RconSocket, $this->Socket->Timeout );
stream_set_blocking( $this->RconSocket, true );
stream_set_timeout($this->RconSocket, $this->Socket->Timeout);
stream_set_blocking($this->RconSocket, true);
}
}
public function Write( int $Header, string $String = '' ) : bool
public function Write(int $Header, string $String = ''): bool
{
// Pack the packet together
$Command = pack( 'VV', ++$this->RconRequestId, $Header ) . $String . "\x00\x00";
$Command = pack('VV', ++$this->RconRequestId, $Header) . $String . "\x00\x00";
// Prepend packet length
$Command = pack( 'V', strlen( $Command ) ) . $Command;
$Length = strlen( $Command );
$Command = pack('V', strlen($Command)) . $Command;
$Length = strlen($Command);
return $Length === fwrite( $this->RconSocket, $Command, $Length );
return $Length === fwrite($this->RconSocket, $Command, $Length);
}
public function Read( ) : Buffer
public function Read(): Buffer
{
$Buffer = new Buffer( );
$Buffer->Set( fread( $this->RconSocket, 4 ) );
$Buffer = new Buffer();
$Buffer->Set(fread($this->RconSocket, 4));
if( $Buffer->Remaining( ) < 4 )
{
throw new InvalidPacketException( 'Rcon read: Failed to read any data from socket', InvalidPacketException::BUFFER_EMPTY );
if ($Buffer->Remaining() < 4) {
throw new InvalidPacketException('Rcon read: Failed to read any data from socket', InvalidPacketException::BUFFER_EMPTY);
}
$PacketSize = $Buffer->GetLong( );
$PacketSize = $Buffer->GetLong();
$Buffer->Set( fread( $this->RconSocket, $PacketSize ) );
$Buffer->Set(fread($this->RconSocket, $PacketSize));
$Data = $Buffer->Get( );
$Data = $Buffer->Get();
$Remaining = $PacketSize - strlen( $Data );
$Remaining = $PacketSize - strlen($Data);
while( $Remaining > 0 )
{
$Data2 = fread( $this->RconSocket, $Remaining );
while ($Remaining > 0) {
$Data2 = fread($this->RconSocket, $Remaining);
$PacketSize = strlen( $Data2 );
$PacketSize = strlen($Data2);
if( $PacketSize === 0 )
{
throw new InvalidPacketException( 'Read ' . strlen( $Data ) . ' bytes from socket, ' . $Remaining . ' remaining', InvalidPacketException::BUFFER_EMPTY );
if ($PacketSize === 0) {
throw new InvalidPacketException('Read ' . strlen($Data) . ' bytes from socket, ' . $Remaining . ' remaining', InvalidPacketException::BUFFER_EMPTY);
}
$Data .= $Data2;
$Remaining -= $PacketSize;
}
$Buffer->Set( $Data );
$Buffer->Set($Data);
return $Buffer;
}
public function Command( string $Command ) : string
public function Command(string $Command): string
{
$this->Write( SourceQuery::SERVERDATA_EXECCOMMAND, $Command );
$Buffer = $this->Read( );
$this->Write(SourceQuery::SERVERDATA_EXECCOMMAND, $Command);
$Buffer = $this->Read();
$Buffer->GetLong( ); // RequestID
$Buffer->GetLong(); // RequestID
$Type = $Buffer->GetLong( );
$Type = $Buffer->GetLong();
if( $Type === SourceQuery::SERVERDATA_AUTH_RESPONSE )
{
throw new AuthenticationException( 'Bad rcon_password.', AuthenticationException::BAD_PASSWORD );
}
else if( $Type !== SourceQuery::SERVERDATA_RESPONSE_VALUE )
{
throw new InvalidPacketException( 'Invalid rcon response.', InvalidPacketException::PACKET_HEADER_MISMATCH );
if ($Type === SourceQuery::SERVERDATA_AUTH_RESPONSE) {
throw new AuthenticationException('Bad rcon_password.', AuthenticationException::BAD_PASSWORD);
} elseif ($Type !== SourceQuery::SERVERDATA_RESPONSE_VALUE) {
throw new InvalidPacketException('Invalid rcon response.', InvalidPacketException::PACKET_HEADER_MISMATCH);
}
$Data = $Buffer->Get( );
$Data = $Buffer->Get();
// We do this stupid hack to handle split packets
// See https://developer.valvesoftware.com/wiki/Source_RCON_Protocol#Multiple-packet_Responses
if( strlen( $Data ) >= 4000 )
{
$this->Write( SourceQuery::SERVERDATA_REQUESTVALUE );
if (strlen($Data) >= 4000) {
$this->Write(SourceQuery::SERVERDATA_REQUESTVALUE);
do
{
$Buffer = $this->Read( );
do {
$Buffer = $this->Read();
$Buffer->GetLong( ); // RequestID
$Buffer->GetLong(); // RequestID
if( $Buffer->GetLong( ) !== SourceQuery::SERVERDATA_RESPONSE_VALUE )
{
if ($Buffer->GetLong() !== SourceQuery::SERVERDATA_RESPONSE_VALUE) {
break;
}
$Data2 = $Buffer->Get( );
$Data2 = $Buffer->Get();
if( $Data2 === "\x00\x01\x00\x00\x00\x00" )
{
if ($Data2 === "\x00\x01\x00\x00\x00\x00") {
break;
}
$Data .= $Data2;
}
while( true );
} while (true);
}
return rtrim( $Data, "\0" );
return rtrim($Data, "\0");
}
public function Authorize( string $Password ) : void
public function Authorize(string $Password): void
{
$this->Write( SourceQuery::SERVERDATA_AUTH, $Password );
$Buffer = $this->Read( );
$this->Write(SourceQuery::SERVERDATA_AUTH, $Password);
$Buffer = $this->Read();
$RequestID = $Buffer->GetLong( );
$Type = $Buffer->GetLong( );
$RequestID = $Buffer->GetLong();
$Type = $Buffer->GetLong();
// 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 )
{
$Buffer = $this->Read( );
if ($Type === SourceQuery::SERVERDATA_RESPONSE_VALUE) {
$Buffer = $this->Read();
$RequestID = $Buffer->GetLong( );
$Type = $Buffer->GetLong( );
$RequestID = $Buffer->GetLong();
$Type = $Buffer->GetLong();
}
if( $RequestID === -1 || $Type !== SourceQuery::SERVERDATA_AUTH_RESPONSE )
{
throw new AuthenticationException( 'RCON authorization failed.', AuthenticationException::BAD_PASSWORD );
}
if ($RequestID === -1 || $Type !== SourceQuery::SERVERDATA_AUTH_RESPONSE) {
throw new AuthenticationException('RCON authorization failed.', AuthenticationException::BAD_PASSWORD);
}
}
}

27
SourceQuery/bootstrap.php
Unescape View File

@ -1,5 +1,8 @@
<?php
/**
declare(strict_types=1);
/**
* Library to query servers that implement Source Engine Query protocol.
*
* Special thanks to koraktor for his awesome Steam Condenser class,
@ -13,15 +16,15 @@
* @license GNU Lesser General Public License, version 2.1
*/
require_once __DIR__ . '/Exception/SourceQueryException.php';
require_once __DIR__ . '/Exception/AuthenticationException.php';
require_once __DIR__ . '/Exception/InvalidArgumentException.php';
require_once __DIR__ . '/Exception/SocketException.php';
require_once __DIR__ . '/Exception/InvalidPacketException.php';
require_once __DIR__ . '/Exception/SourceQueryException.php';
require_once __DIR__ . '/Exception/AuthenticationException.php';
require_once __DIR__ . '/Exception/InvalidArgumentException.php';
require_once __DIR__ . '/Exception/SocketException.php';
require_once __DIR__ . '/Exception/InvalidPacketException.php';
require_once __DIR__ . '/Buffer.php';
require_once __DIR__ . '/BaseSocket.php';
require_once __DIR__ . '/Socket.php';
require_once __DIR__ . '/SourceRcon.php';
require_once __DIR__ . '/GoldSourceRcon.php';
require_once __DIR__ . '/SourceQuery.php';
require_once __DIR__ . '/Buffer.php';
require_once __DIR__ . '/BaseSocket.php';
require_once __DIR__ . '/Socket.php';
require_once __DIR__ . '/SourceRcon.php';
require_once __DIR__ . '/GoldSourceRcon.php';
require_once __DIR__ . '/SourceQuery.php';

218
Tests/Tests.php
Unescape View File

@ -1,33 +1,34 @@
<?php
use PHPUnit\Framework\TestCase;
use xPaw\SourceQuery\BaseSocket;
use xPaw\SourceQuery\SourceQuery;
use xPaw\SourceQuery\Buffer;
class TestableSocket extends BaseSocket
{
declare(strict_types=1);
use PHPUnit\Framework\TestCase;
use xPaw\SourceQuery\BaseSocket;
use xPaw\SourceQuery\SourceQuery;
use xPaw\SourceQuery\Buffer;
final class TestableSocket extends BaseSocket
{
/** @var \SplQueue<string> */
private \SplQueue $PacketQueue;
public function __construct( )
public function __construct()
{
/** @var \SplQueue<string> */
$this->PacketQueue = new \SplQueue();
$this->PacketQueue->setIteratorMode( \SplDoublyLinkedList::IT_MODE_DELETE );
$this->PacketQueue->setIteratorMode(\SplDoublyLinkedList::IT_MODE_DELETE);
}
public function Queue( string $Data ) : void
public function Queue(string $Data): void
{
$this->PacketQueue->push( $Data );
$this->PacketQueue->push($Data);
}
public function Close( ) : void
public function Close(): void
{
//
}
public function Open( string $Address, int $Port, int $Timeout, int $Engine ) : void
public function Open(string $Address, int $Port, int $Timeout, int $Engine): void
{
$this->Timeout = $Timeout;
$this->Engine = $Engine;
@ -35,77 +36,76 @@
$this->Address = $Address;
}
public function Write( int $Header, string $String = '' ) : bool
public function Write(int $Header, string $String = ''): bool
{
return true;
}
public function Read( int $Length = 1400 ) : Buffer
public function Read(int $Length = 1400): Buffer
{
$Buffer = new Buffer( );
$Buffer->Set( $this->PacketQueue->shift() );
$Buffer = new Buffer();
$Buffer->Set($this->PacketQueue->shift());
$this->ReadInternal( $Buffer, $Length, [ $this, 'Sherlock' ] );
$this->ReadInternal($Buffer, $Length, [ $this, 'Sherlock' ]);
return $Buffer;
}
public function Sherlock( Buffer $Buffer, int $Length ) : bool
{
if( $this->PacketQueue->isEmpty() )
public function Sherlock(Buffer $Buffer, int $Length): bool
{
if ($this->PacketQueue->isEmpty()) {
return false;
}
$Buffer->Set( $this->PacketQueue->shift() );
$Buffer->Set($this->PacketQueue->shift());
return $Buffer->GetLong( ) === -2;
}
return $Buffer->GetLong() === -2;
}
}
class Tests extends \PHPUnit\Framework\TestCase
{
final class Tests extends TestCase
{
private TestableSocket $Socket;
private SourceQuery $SourceQuery;
public function setUp() : void
public function setUp(): void
{
$this->Socket = new TestableSocket();
$this->SourceQuery = new SourceQuery( $this->Socket );
$this->SourceQuery->Connect( '', 2 );
$this->SourceQuery = new SourceQuery($this->Socket);
$this->SourceQuery->Connect('', 2);
}
public function tearDown() : void
public function tearDown(): void
{
$this->SourceQuery->Disconnect();
unset( $this->Socket, $this->SourceQuery );
unset($this->Socket, $this->SourceQuery);
}
public function testInvalidTimeout() : void
public function testInvalidTimeout(): void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidArgumentException::class );
$SourceQuery = new SourceQuery( );
$SourceQuery->Connect( '', 2, -1 );
$this->expectException(xPaw\SourceQuery\Exception\InvalidArgumentException::class);
$SourceQuery = new SourceQuery();
$SourceQuery->Connect('', 2, -1);
}
public function testNotConnectedGetInfo() : void
public function testNotConnectedGetInfo(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Disconnect();
$this->SourceQuery->GetInfo();
}
public function testNotConnectedPing() : void
public function testNotConnectedPing(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Disconnect();
$this->SourceQuery->Ping();
}
public function testNotConnectedGetPlayers() : void
public function testNotConnectedGetPlayers(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Disconnect();
$this->SourceQuery->GetPlayers();
}
@ -113,62 +113,60 @@
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedGetRules() : void
public function testNotConnectedGetRules(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Disconnect();
$this->SourceQuery->GetRules();
}
public function testNotConnectedSetRconPassword() : void
public function testNotConnectedSetRconPassword(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Disconnect();
$this->SourceQuery->SetRconPassword('a');
}
public function testNotConnectedRcon() : void
public function testNotConnectedRcon(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Disconnect();
$this->SourceQuery->Rcon('a');
}
public function testRconWithoutPassword() : void
public function testRconWithoutPassword(): void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->expectException(xPaw\SourceQuery\Exception\SocketException::class);
$this->SourceQuery->Rcon('a');
}
/**
* @dataProvider InfoProvider
*/
public function testGetInfo( string $RawInput, array $ExpectedOutput ) : void
{
if( isset( $ExpectedOutput[ 'IsMod' ] ) )
public function testGetInfo(string $RawInput, array $ExpectedOutput): void
{
if (isset($ExpectedOutput[ 'IsMod' ])) {
$this->Socket->Engine = SourceQuery::GOLDSOURCE;
}
$this->Socket->Queue( $RawInput );
$this->Socket->Queue($RawInput);
$RealOutput = $this->SourceQuery->GetInfo();
$this->assertEquals( $ExpectedOutput, $RealOutput );
self::assertEquals($ExpectedOutput, $RealOutput);
}
public function InfoProvider() : array
public function InfoProvider(): array
{
$DataProvider = [];
$Files = glob( __DIR__ . '/Info/*.raw', GLOB_ERR );
$Files = glob(__DIR__ . '/Info/*.raw', GLOB_ERR);
foreach( $Files as $File )
{
foreach ($Files as $File) {
$DataProvider[] =
[
hex2bin( trim( file_get_contents( $File ) ) ),
json_decode( file_get_contents( str_replace( '.raw', '.json', $File ) ), true )
hex2bin(trim(file_get_contents($File))),
json_decode(file_get_contents(str_replace('.raw', '.json', $File)), true)
];
}
@ -178,10 +176,10 @@
/**
* @dataProvider BadPacketProvider
*/
public function testBadGetInfo( string $Data ) : void
public function testBadGetInfo(string $Data): void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidPacketException::class );
$this->Socket->Queue( $Data );
$this->expectException(xPaw\SourceQuery\Exception\InvalidPacketException::class);
$this->Socket->Queue($Data);
$this->SourceQuery->GetInfo();
}
@ -189,10 +187,10 @@
/**
* @dataProvider BadPacketProvider
*/
public function testBadGetChallengeViaPlayers( string $Data ) : void
public function testBadGetChallengeViaPlayers(string $Data): void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidPacketException::class );
$this->Socket->Queue( $Data );
$this->expectException(xPaw\SourceQuery\Exception\InvalidPacketException::class);
$this->Socket->Queue($Data);
$this->SourceQuery->GetPlayers();
}
@ -200,11 +198,11 @@
/**
* @dataProvider BadPacketProvider
*/
public function testBadGetPlayersAfterCorrectChallenge( string $Data ) : void
public function testBadGetPlayersAfterCorrectChallenge(string $Data): void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidPacketException::class );
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x41\x11\x11\x11\x11" );
$this->Socket->Queue( $Data );
$this->expectException(xPaw\SourceQuery\Exception\InvalidPacketException::class);
$this->Socket->Queue("\xFF\xFF\xFF\xFF\x41\x11\x11\x11\x11");
$this->Socket->Queue($Data);
$this->SourceQuery->GetPlayers();
}
@ -212,16 +210,16 @@
/**
* @dataProvider BadPacketProvider
*/
public function testBadGetRulesAfterCorrectChallenge( string $Data ) : void
public function testBadGetRulesAfterCorrectChallenge(string $Data): void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidPacketException::class );
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x41\x11\x11\x11\x11" );
$this->Socket->Queue( $Data );
$this->expectException(xPaw\SourceQuery\Exception\InvalidPacketException::class);
$this->Socket->Queue("\xFF\xFF\xFF\xFF\x41\x11\x11\x11\x11");
$this->Socket->Queue($Data);
$this->SourceQuery->GetRules();
}
public function BadPacketProvider( ) : array
public function BadPacketProvider(): array
{
return
[
@ -235,46 +233,44 @@
];
}
public function testGetChallengeTwice( ) : void
public function testGetChallengeTwice(): void
{
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x41\x11\x11\x11\x11" );
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x45\x01\x00ayy\x00lmao\x00" );
$this->assertEquals( [ 'ayy' => 'lmao' ], $this->SourceQuery->GetRules() );
$this->Socket->Queue("\xFF\xFF\xFF\xFF\x41\x11\x11\x11\x11");
$this->Socket->Queue("\xFF\xFF\xFF\xFF\x45\x01\x00ayy\x00lmao\x00");
self::assertEquals([ 'ayy' => 'lmao' ], $this->SourceQuery->GetRules());
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x45\x01\x00wow\x00much\x00" );
$this->assertEquals( [ 'wow' => 'much' ], $this->SourceQuery->GetRules() );
$this->Socket->Queue("\xFF\xFF\xFF\xFF\x45\x01\x00wow\x00much\x00");
self::assertEquals([ 'wow' => 'much' ], $this->SourceQuery->GetRules());
}
/**
* @dataProvider RulesProvider
* @param array<string> $RawInput
*/
public function testGetRules( array $RawInput, array $ExpectedOutput ) : void
public function testGetRules(array $RawInput, array $ExpectedOutput): void
{
$this->Socket->Queue( hex2bin( "ffffffff4104fce20e" ) ); // Challenge
$this->Socket->Queue(hex2bin("ffffffff4104fce20e")); // Challenge
foreach( $RawInput as $Packet )
{
$this->Socket->Queue( hex2bin( $Packet ) );
foreach ($RawInput as $Packet) {
$this->Socket->Queue(hex2bin($Packet));
}
$RealOutput = $this->SourceQuery->GetRules();
$this->assertEquals( $ExpectedOutput, $RealOutput );
self::assertEquals($ExpectedOutput, $RealOutput);
}
public function RulesProvider() : array
public function RulesProvider(): array
{
$DataProvider = [];
$Files = glob( __DIR__ . '/Rules/*.raw', GLOB_ERR );
$Files = glob(__DIR__ . '/Rules/*.raw', GLOB_ERR);
foreach( $Files as $File )
{
foreach ($Files as $File) {
$DataProvider[] =
[
file( $File, FILE_SKIP_EMPTY_LINES | FILE_IGNORE_NEW_LINES ),
json_decode( file_get_contents( str_replace( '.raw', '.json', $File ) ), true )
file($File, FILE_SKIP_EMPTY_LINES | FILE_IGNORE_NEW_LINES),
json_decode(file_get_contents(str_replace('.raw', '.json', $File)), true)
];
}
@ -285,44 +281,42 @@
* @dataProvider PlayersProvider
* @param array<string> $RawInput
*/
public function testGetPlayers( array $RawInput, array $ExpectedOutput ) : void
public function testGetPlayers(array $RawInput, array $ExpectedOutput): void
{
$this->Socket->Queue( hex2bin( "ffffffff4104fce20e" ) ); // Challenge
$this->Socket->Queue(hex2bin("ffffffff4104fce20e")); // Challenge
foreach( $RawInput as $Packet )
{
$this->Socket->Queue( hex2bin( $Packet ) );
foreach ($RawInput as $Packet) {
$this->Socket->Queue(hex2bin($Packet));
}
$RealOutput = $this->SourceQuery->GetPlayers();
$this->assertEquals( $ExpectedOutput, $RealOutput );
self::assertEquals($ExpectedOutput, $RealOutput);
}
public function PlayersProvider() : array
public function PlayersProvider(): array
{
$DataProvider = [];
$Files = glob( __DIR__ . '/Players/*.raw', GLOB_ERR );
$Files = glob(__DIR__ . '/Players/*.raw', GLOB_ERR);
foreach( $Files as $File )
{
foreach ($Files as $File) {
$DataProvider[] =
[
file( $File, FILE_SKIP_EMPTY_LINES | FILE_IGNORE_NEW_LINES ),
json_decode( file_get_contents( str_replace( '.raw', '.json', $File ) ), true )
file($File, FILE_SKIP_EMPTY_LINES | FILE_IGNORE_NEW_LINES),
json_decode(file_get_contents(str_replace('.raw', '.json', $File)), true)
];
}
return $DataProvider;
}
public function testPing() : void
public function testPing(): void
{
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x6A\x00");
$this->assertTrue( $this->SourceQuery->Ping() );
$this->Socket->Queue("\xFF\xFF\xFF\xFF\x6A\x00");
self::assertTrue($this->SourceQuery->Ping());
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\xEE");
$this->assertFalse( $this->SourceQuery->Ping() );
}
$this->Socket->Queue("\xFF\xFF\xFF\xFF\xEE");
self::assertFalse($this->SourceQuery->Ping());
}
}

3
composer.json
Unescape View File

@ -24,7 +24,8 @@
{
"phpunit/phpunit": "^9.5",
"vimeo/psalm": "^4.7",
"phpstan/phpstan": "^0.12.83"
"phpstan/phpstan": "^0.12.83",
"friendsofphp/php-cs-fixer": "^3.0"
},
"autoload":
{

Write Preview
Loading…
Cancel
Save