1
0
mirror of https://github.com/xPaw/PHP-Source-Query.git synced 2026-07-14 10:04:49 +02:00

18 Commits

Author SHA1 Message Date
Pavel Djundik 673e572233 Use challenge straight away if available 2020-12-04 10:20:42 +02:00
Pavel Djundik 7c8e5add77 Support challenges in A2S_INFO 2020-12-04 10:18:46 +02:00
Pavel Djundik fbabd440da Fix variable 2020-12-04 10:14:45 +02:00
Pavel Djundik bbb6c4c23e Revert "Add 1200 byte padding to all requests"
This reverts commit 7231921b0b.
2020-12-04 10:05:37 +02:00
Pavel Djundik 9da781a993 Remove old badges 2020-12-03 13:01:53 +02:00
Pavel Djundik b4601cdf86 Print info if some was received 2020-12-03 12:51:26 +02:00
Pavel Djundik 7231921b0b Add 1200 byte padding to all requests
https://steamcommunity.com/discussions/forum/14/2989789048633291344/
2020-11-19 10:58:23 +02:00
Pavel Djundik 4f88fb0c76 Use actual class 2020-06-23 20:28:39 +03:00
Pavel Djundik 7414334804 Require php 7.4 2020-06-23 20:22:17 +03:00
Pavel Djundik 8a2c16123c Test php 7.4 2020-06-23 20:21:19 +03:00
Pavel Djundik 528d0ef4fc Update phpunit, add psalm 2020-06-23 20:20:41 +03:00
Pavel Djundik 914ec4b79a Add more type info 2020-06-23 20:10:31 +03:00
Pavel Djundik b87c9faab9 Fix up some type information 2020-06-23 19:44:51 +03:00
Pavel Djundik 1078e47b7e Add missing uses 2020-06-23 19:36:17 +03:00
Pavel Djundik e00235c29a Add S2A extra data comments 2020-06-19 17:43:51 +03:00
Pavel Djundik 75d3465690 Drop the email 2019-11-25 16:07:21 +02:00
Pavel Djundik a92e4e4a34 Merge pull request #146 from zavg/master
Add 7 Days to Die to supported games
2019-11-11 16:01:23 +02:00
zavg f22c5494d2 Update README.md 2019-11-11 16:56:49 +03:00
18 changed files with 210 additions and 220 deletions
+3 -1
View File
@@ -7,10 +7,12 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
php: [7.2, 7.3]
php: [7.4]
steps:
- uses: actions/checkout@v1
- name: Install dependencies
run: composer install --no-interaction --no-progress
- name: Run tests
run: php${{ matrix.php }} vendor/bin/phpunit --configuration Tests/phpunit.xml --verbose --fail-on-warning
- name: Run psalm
run: php${{ matrix.php }} vendor/bin/psalm
+5 -7
View File
@@ -17,6 +17,7 @@
$Info = Array( );
$Rules = Array( );
$Players = Array( );
$Exception = null;
try
{
@@ -87,13 +88,11 @@
</div>
<div class="container">
<?php if( isset( $Exception ) ): ?>
<div class="panel panel-primary">
<div class="panel-heading"><?php echo Get_Class( $Exception ); ?> at line <?php echo $Exception->getLine( ); ?></div>
<p><b><?php echo htmlspecialchars( $Exception->getMessage( ) ); ?></b></p>
<p><?php echo nl2br( $e->getTraceAsString(), false ); ?></p>
<?php if( $Exception !== null ): ?>
<div class="panel panel-error">
<pre class="panel-body"><?php echo htmlspecialchars( $Exception->__toString( ) ); ?></pre>
</div>
<?php else: ?>
<?php endif; ?>
<div class="row">
<div class="col-sm-6">
<table class="table table-bordered table-striped">
@@ -193,7 +192,6 @@
</table>
</div>
</div>
<?php endif; ?>
</div>
</body>
</html>
+2 -3
View File
@@ -1,7 +1,5 @@
# PHP Source Query
[![Build Status](https://img.shields.io/travis/com/xPaw/PHP-Source-Query.svg)](https://travis-ci.com/xPaw/PHP-Source-Query)
[![Test Coverage](https://img.shields.io/coveralls/github/xPaw/PHP-Source-Query/master.svg)](https://coveralls.io/github/xPaw/PHP-Source-Query)
[![Packagist Downloads](https://img.shields.io/packagist/dt/xpaw/php-source-query-class.svg)](https://packagist.org/packages/xpaw/php-source-query-class)
[![Packagist Version](https://img.shields.io/packagist/v/xpaw/php-source-query-class.svg)](https://packagist.org/packages/xpaw/php-source-query-class)
@@ -14,7 +12,7 @@ The class also allows you to query servers using RCON although this only works f
**:warning: Please do not create issues when you are unable to retrieve information from a server, unless you can prove that there is a bug within the library.**
## Requirements
* [Modern PHP version](https://php.net/supported-versions.php) (5.5 or newer)
* [Modern PHP version](https://php.net/supported-versions.php) (7.4 or newer)
* 64-bit PHP or [gmp module](https://secure.php.net/manual/en/book.gmp.php)
* Web server must allow UDP connections
@@ -39,6 +37,7 @@ AppID | Game | Query | RCON | Notes
115300 | [Call of Duty: Modern Warfare 3](http://store.steampowered.com/app/115300/) | :white_check_mark: | :white_check_mark: |
211820 | [Starbound](http://store.steampowered.com/app/211820/) | :white_check_mark: | :white_check_mark: | Call `SetUseOldGetChallengeMethod` method after connecting
244850 | [Space Engineers](http://store.steampowered.com/app/244850/) | :white_check_mark: | :x: | Add +1 to the server port
251570 | [7 Days to Die](http://store.steampowered.com/app/251570) | :white_check_mark: | :x: |
252490 | [Rust](http://store.steampowered.com/app/252490/) | :white_check_mark: | :x: |
282440 | [Quake Live](http://store.steampowered.com/app/282440) | :white_check_mark: | :x: | Quake Live uses the ZMQ messaging queue protocol for rcon control.
346110 | [ARK: Survival Evolved](http://store.steampowered.com/app/346110/) | :white_check_mark: | :white_check_mark: |
+19 -11
View File
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -13,6 +13,7 @@
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
/**
* Base socket interface
@@ -20,27 +21,29 @@
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses xPaw\SourceQuery\Exception\SocketException
*/
abstract class BaseSocket
{
/** @var resource */
public $Socket;
public $Engine;
public int $Engine;
public $Address;
public $Port;
public $Timeout;
public string $Address;
public int $Port;
public int $Timeout;
public function __destruct( )
{
$this->Close( );
}
abstract public function Close( );
abstract public function Open( $Address, $Port, $Timeout, $Engine );
abstract public function Write( $Header, $String = '' );
abstract public function Read( $Length = 1400 );
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, $Length, $SherlockFunction )
protected function ReadInternal( Buffer $Buffer, int $Length, callable $SherlockFunction ) : Buffer
{
if( $Buffer->Remaining( ) === 0 )
{
@@ -58,6 +61,7 @@
$Packets = [];
$IsCompressed = false;
$ReadMore = false;
$PacketChecksum = null;
do
{
@@ -92,6 +96,10 @@
break;
}
default:
{
throw new SocketException( 'Unknown engine.', SocketException::INVALID_ENGINE );
}
}
$Packets[ $PacketNumber ] = $Buffer->Get( );
@@ -113,7 +121,7 @@
$Data = bzdecompress( $Data );
if( CRC32( $Data ) !== $PacketChecksum )
if( !is_string( $Data ) || CRC32( $Data ) !== $PacketChecksum )
{
throw new InvalidPacketException( 'CRC32 checksum mismatch of uncompressed packet data.', InvalidPacketException::CHECKSUM_MISMATCH );
}
+17 -39
View File
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -25,31 +25,23 @@
{
/**
* Buffer
*
* @var string
*/
private $Buffer;
private string $Buffer = '';
/**
* Buffer length
*
* @var int
*/
private $Length;
private int $Length = 0;
/**
* Current position in buffer
*
* @var int
*/
private $Position;
private int $Position = 0;
/**
* Sets buffer
*
* @param string $Buffer Buffer
*/
public function Set( $Buffer )
public function Set( string $Buffer ) : void
{
$this->Buffer = $Buffer;
$this->Length = StrLen( $Buffer );
@@ -61,7 +53,7 @@
*
* @return int Remaining bytes in buffer
*/
public function Remaining( )
public function Remaining( ) : int
{
return $this->Length - $this->Position;
}
@@ -70,10 +62,8 @@
* Gets data from buffer
*
* @param int $Length Bytes to read
*
* @return string
*/
public function Get( $Length = -1 )
public function Get( int $Length = -1 ) : string
{
if( $Length === 0 )
{
@@ -100,20 +90,16 @@
/**
* Get byte from buffer
*
* @return int
*/
public function GetByte( )
public function GetByte( ) : int
{
return Ord( $this->Get( 1 ) );
}
/**
* Get short from buffer
*
* @return int
*/
public function GetShort( )
public function GetShort( ) : int
{
if( $this->Remaining( ) < 2 )
{
@@ -122,15 +108,13 @@
$Data = UnPack( 'v', $this->Get( 2 ) );
return $Data[ 1 ];
return (int)$Data[ 1 ];
}
/**
* Get long from buffer
*
* @return int
*/
public function GetLong( )
public function GetLong( ) : int
{
if( $this->Remaining( ) < 4 )
{
@@ -139,15 +123,13 @@
$Data = UnPack( 'l', $this->Get( 4 ) );
return $Data[ 1 ];
return (int)$Data[ 1 ];
}
/**
* Get float from buffer
*
* @return float
*/
public function GetFloat( )
public function GetFloat( ) : float
{
if( $this->Remaining( ) < 4 )
{
@@ -156,15 +138,13 @@
$Data = UnPack( 'f', $this->Get( 4 ) );
return $Data[ 1 ];
return (float)$Data[ 1 ];
}
/**
* Get unsigned long from buffer
*
* @return int
*/
public function GetUnsignedLong( )
public function GetUnsignedLong( ) : int
{
if( $this->Remaining( ) < 4 )
{
@@ -173,15 +153,13 @@
$Data = UnPack( 'V', $this->Get( 4 ) );
return $Data[ 1 ];
return (int)$Data[ 1 ];
}
/**
* Read one string from buffer ending with null byte
*
* @return string
*/
public function GetString( )
public function GetString( ) : string
{
$ZeroBytePosition = StrPos( $this->Buffer, "\0", $this->Position );
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
+2 -1
View File
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -17,4 +17,5 @@
const COULD_NOT_CREATE_SOCKET = 1;
const NOT_CONNECTED = 2;
const CONNECTION_FAILED = 3;
const INVALID_ENGINE = 3;
}
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
+16 -16
View File
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -13,6 +13,7 @@
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
/**
* Class GoldSourceRcon
@@ -20,38 +21,37 @@
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\AuthenticationException
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
*/
class GoldSourceRcon
{
/**
* Points to socket class
*
* @var Socket
* @var BaseSocket
*/
private $Socket;
private $RconPassword;
private $RconRequestId;
private $RconChallenge;
private string $RconPassword = '';
private string $RconChallenge = '';
public function __construct( $Socket )
public function __construct( BaseSocket $Socket )
{
$this->Socket = $Socket;
}
public function Close( )
public function Close( ) : void
{
$this->RconChallenge = 0;
$this->RconRequestId = 0;
$this->RconPassword = 0;
$this->RconChallenge = '';
$this->RconPassword = '';
}
public function Open( )
public function Open( ) : void
{
//
}
public function Write( $Header, $String = '' )
public function Write( int $Header, string $String = '' ) : bool
{
$Command = Pack( 'cccca*', 0xFF, 0xFF, 0xFF, 0xFF, $String );
$Length = StrLen( $Command );
@@ -62,9 +62,9 @@
/**
* @param int $Length
* @throws AuthenticationException
* @return bool
* @return Buffer
*/
public function Read( $Length = 1400 )
public function Read( int $Length = 1400 ) : Buffer
{
// GoldSource RCON has same structure as Query
$Buffer = $this->Socket->Read( );
@@ -115,7 +115,7 @@
return $Buffer;
}
public function Command( $Command )
public function Command( string $Command ) : string
{
if( !$this->RconChallenge )
{
@@ -128,7 +128,7 @@
return $Buffer->Get( );
}
public function Authorize( $Password )
public function Authorize( string $Password ) : void
{
$this->RconPassword = $Password;
+7 -7
View File
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -25,9 +25,9 @@
*/
class Socket extends BaseSocket
{
public function Close( )
public function Close( ) : void
{
if( $this->Socket )
if( $this->Socket !== null )
{
FClose( $this->Socket );
@@ -35,7 +35,7 @@
}
}
public function Open( $Address, $Port, $Timeout, $Engine )
public function Open( string $Address, int $Port, int $Timeout, int $Engine ) : void
{
$this->Timeout = $Timeout;
$this->Engine = $Engine;
@@ -53,7 +53,7 @@
Stream_Set_Blocking( $this->Socket, true );
}
public function Write( $Header, $String = '' )
public function Write( int $Header, string $String = '' ) : bool
{
$Command = Pack( 'ccccca*', 0xFF, 0xFF, 0xFF, 0xFF, $Header, $String );
$Length = StrLen( $Command );
@@ -68,7 +68,7 @@
*
* @return Buffer Buffer
*/
public function Read( $Length = 1400 )
public function Read( int $Length = 1400 ) : Buffer
{
$Buffer = new Buffer( );
$Buffer->Set( FRead( $this->Socket, $Length ) );
@@ -78,7 +78,7 @@
return $Buffer;
}
public function Sherlock( $Buffer, $Length )
public function Sherlock( Buffer $Buffer, int $Length ) : bool
{
$Data = FRead( $this->Socket, $Length );
+52 -42
View File
@@ -2,7 +2,7 @@
/**
* This class provides the public interface to the PHP-Source-Query library.
*
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -12,6 +12,7 @@
namespace xPaw\SourceQuery;
use xPaw\SourceQuery\Exception\AuthenticationException;
use xPaw\SourceQuery\Exception\InvalidArgumentException;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\Exception\SocketException;
@@ -21,6 +22,7 @@
*
* @package xPaw\SourceQuery
*
* @uses xPaw\SourceQuery\Exception\AuthenticationException
* @uses xPaw\SourceQuery\Exception\InvalidArgumentException
* @uses xPaw\SourceQuery\Exception\InvalidPacketException
* @uses xPaw\SourceQuery\Exception\SocketException
@@ -68,37 +70,29 @@
/**
* Points to rcon class
*
* @var SourceRcon
* @var SourceRcon|GoldSourceRcon|null
*/
private $Rcon;
/**
* Points to socket class
*
* @var Socket
*/
private $Socket;
private BaseSocket $Socket;
/**
* True if connection is open, false if not
*
* @var bool
*/
private $Connected;
private bool $Connected = false;
/**
* Contains challenge
*
* @var string
*/
private $Challenge;
private string $Challenge = '';
/**
* Use old method for getting challenge number
*
* @var bool
*/
private $UseOldGetChallengeMethod;
private bool $UseOldGetChallengeMethod = false;
public function __construct( BaseSocket $Socket = null )
{
@@ -121,16 +115,16 @@
* @throws InvalidArgumentException
* @throws SocketException
*/
public function Connect( $Address, $Port, $Timeout = 3, $Engine = self::SOURCE )
public function Connect( string $Address, int $Port, int $Timeout = 3, int $Engine = self::SOURCE ) : void
{
$this->Disconnect( );
if( !is_int( $Timeout ) || $Timeout < 0 )
if( $Timeout < 0 )
{
throw new InvalidArgumentException( 'Timeout must be an integer.', InvalidArgumentException::TIMEOUT_NOT_INTEGER );
throw new InvalidArgumentException( 'Timeout must be a positive integer.', InvalidArgumentException::TIMEOUT_NOT_INTEGER );
}
$this->Socket->Open( $Address, (int)$Port, $Timeout, (int)$Engine );
$this->Socket->Open( $Address, $Port, $Timeout, $Engine );
$this->Connected = true;
}
@@ -142,7 +136,7 @@
*
* @returns bool Previous value
*/
public function SetUseOldGetChallengeMethod( $Value )
public function SetUseOldGetChallengeMethod( bool $Value ) : bool
{
$Previous = $this->UseOldGetChallengeMethod;
@@ -154,10 +148,10 @@
/**
* Closes all open connections
*/
public function Disconnect( )
public function Disconnect( ) : void
{
$this->Connected = false;
$this->Challenge = 0;
$this->Challenge = '';
$this->Socket->Close( );
@@ -178,7 +172,7 @@
*
* @return bool True on success, false on failure
*/
public function Ping( )
public function Ping( ) : bool
{
if( !$this->Connected )
{
@@ -199,17 +193,34 @@
*
* @return array Returns an array with information on success
*/
public function GetInfo( )
public function GetInfo( ) : array
{
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" );
$Buffer = $this->Socket->Read( );
}
$Buffer = $this->Socket->Read( );
$Type = $Buffer->GetByte( );
$Server = [];
if( $Type === self::S2A_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( );
}
// Old GoldSource protocol, HLTV still uses it
if( $Type === self::S2A_INFO_OLD && $this->Socket->Engine === self::GOLDSOURCE )
@@ -235,6 +246,7 @@
if( $Server[ 'IsMod' ] )
{
$Mod = [];
$Mod[ 'Url' ] = $Buffer->GetString( );
$Mod[ 'Download' ] = $Buffer->GetString( );
$Buffer->Get( 1 ); // NULL byte
@@ -242,16 +254,12 @@
$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( );
if( isset( $Mod ) )
{
$Server[ 'Mod' ] = $Mod;
}
return $Server;
}
@@ -289,13 +297,13 @@
{
$Server[ 'ExtraDataFlags' ] = $Flags = $Buffer->GetByte( );
// The server's game port
// S2A_EXTRA_DATA_HAS_GAME_PORT - Next 2 bytes include the game port.
if( $Flags & 0x80 )
{
$Server[ 'GamePort' ] = $Buffer->GetShort( );
}
// The server's steamid
// 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 )
@@ -327,20 +335,20 @@
unset( $SteamIDLower, $SteamIDInstance, $SteamID );
}
// The spectator port and then the spectator server name
// 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( );
}
// The game tag data string for the server
// S2A_EXTRA_DATA_HAS_GAMETAG_DATA - Next bytes are the game tag string
if( $Flags & 0x20 )
{
$Server[ 'GameTags' ] = $Buffer->GetString( );
}
// GameID -- alternative to AppID?
// S2A_EXTRA_DATA_GAMEID - Next 8 bytes are the gameID of the server
if( $Flags & 0x01 )
{
$Server[ 'GameID' ] = $Buffer->GetUnsignedLong( ) | ( $Buffer->GetUnsignedLong( ) << 32 );
@@ -364,7 +372,7 @@
*
* @return array Returns an array with players on success
*/
public function GetPlayers( )
public function GetPlayers( ) : array
{
if( !$this->Connected )
{
@@ -389,6 +397,7 @@
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( );
@@ -409,7 +418,7 @@
*
* @return array Returns an array with rules on success
*/
public function GetRules( )
public function GetRules( ) : array
{
if( !$this->Connected )
{
@@ -448,12 +457,9 @@
/**
* Get challenge (used for players/rules packets)
*
* @param $Header
* @param $ExpectedResult
*
* @throws InvalidPacketException
*/
private function GetChallenge( $Header, $ExpectedResult )
private function GetChallenge( int $Header, int $ExpectedResult ) : void
{
if( $this->Challenge )
{
@@ -504,7 +510,7 @@
* @throws InvalidPacketException
* @throws SocketException
*/
public function SetRconPassword( $Password )
public function SetRconPassword( string $Password ) : void
{
if( !$this->Connected )
{
@@ -525,6 +531,10 @@
break;
}
default:
{
throw new SocketException( 'Unknown engine.', SocketException::INVALID_ENGINE );
}
}
$this->Rcon->Open( );
@@ -542,7 +552,7 @@
*
* @return string Answer from server in string
*/
public function Rcon( $Command )
public function Rcon( string $Command ) : string
{
if( !$this->Connected )
{
+11 -12
View File
@@ -1,6 +1,6 @@
<?php
/**
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
@@ -29,20 +29,19 @@
{
/**
* Points to socket class
*
* @var Socket
*/
private $Socket;
private BaseSocket $Socket;
/** @var resource */
private $RconSocket;
private $RconRequestId;
private int $RconRequestId = 0;
public function __construct( $Socket )
public function __construct( BaseSocket $Socket )
{
$this->Socket = $Socket;
}
public function Close( )
public function Close( ) : void
{
if( $this->RconSocket )
{
@@ -54,7 +53,7 @@
$this->RconRequestId = 0;
}
public function Open( )
public function Open( ) : void
{
if( !$this->RconSocket )
{
@@ -70,7 +69,7 @@
}
}
public function Write( $Header, $String = '' )
public function Write( int $Header, string $String = '' ) : bool
{
// Pack the packet together
$Command = Pack( 'VV', ++$this->RconRequestId, $Header ) . $String . "\x00\x00";
@@ -82,7 +81,7 @@
return $Length === FWrite( $this->RconSocket, $Command, $Length );
}
public function Read( )
public function Read( ) : Buffer
{
$Buffer = new Buffer( );
$Buffer->Set( FRead( $this->RconSocket, 4 ) );
@@ -122,7 +121,7 @@
return $Buffer;
}
public function Command( $Command )
public function Command( string $Command ) : string
{
$this->Write( SourceQuery::SERVERDATA_EXECCOMMAND, $Command );
$Buffer = $this->Read( );
@@ -174,7 +173,7 @@
return rtrim( $Data, "\0" );
}
public function Authorize( $Password )
public function Authorize( string $Password ) : void
{
$this->Write( SourceQuery::SERVERDATA_AUTH, $Password );
$Buffer = $this->Read( );
+1 -1
View File
@@ -5,7 +5,7 @@
* Special thanks to koraktor for his awesome Steam Condenser class,
* I used it as a reference at some points.
*
* @author Pavel Djundik <sourcequery@xpaw.me>
* @author Pavel Djundik
*
* @link https://xpaw.me
* @link https://github.com/xPaw/PHP-Source-Query
+50 -64
View File
@@ -1,13 +1,12 @@
<?php
use PHPUnit\Framework\TestCase;
use xPaw\SourceQuery\BaseSocket;
use xPaw\SourceQuery\Exception\InvalidPacketException;
use xPaw\SourceQuery\SourceQuery;
use xPaw\SourceQuery\Buffer;
class TestableSocket extends BaseSocket
{
private $PacketQueue;
private \SplQueue $PacketQueue;
public function __construct( )
{
@@ -16,17 +15,17 @@
}
public function Queue( $Data )
public function Queue( string $Data ) : void
{
$this->PacketQueue->push( $Data );
}
public function Close( )
public function Close( ) : void
{
//
}
public function Open( $Address, $Port, $Timeout, $Engine )
public function Open( string $Address, int $Port, int $Timeout, int $Engine ) : void
{
$this->Timeout = $Timeout;
$this->Engine = $Engine;
@@ -34,85 +33,77 @@
$this->Address = $Address;
}
public function Write( $Header, $String = '' )
public function Write( int $Header, string $String = '' ) : bool
{
//
return true;
}
public function Read( $Length = 1400 )
public function Read( int $Length = 1400 ) : Buffer
{
$Buffer = new Buffer( );
$Buffer->Set( $this->PacketQueue->shift() );
$Buffer->Set( (string)$this->PacketQueue->shift() );
$this->ReadInternal( $Buffer, $Length, [ $this, 'Sherlock' ] );
return $Buffer;
}
public function Sherlock( $Buffer, $Length )
public function Sherlock( Buffer $Buffer, int $Length ) : bool
{
if( $this->PacketQueue->isEmpty() )
{
return false;
}
$Buffer->Set( $this->PacketQueue->shift() );
$Buffer->Set( (string)$this->PacketQueue->shift() );
return $Buffer->GetLong( ) === -2;
}
}
class SourceQueryTests extends TestCase
class Tests extends \PHPUnit\Framework\TestCase
{
private $Socket;
private $SourceQuery;
private TestableSocket $Socket;
private SourceQuery $SourceQuery;
public function setUp()
public function setUp() : void
{
$this->Socket = new TestableSocket();
$this->SourceQuery = new SourceQuery( $this->Socket );
$this->SourceQuery->Connect( 1, 2 );
$this->SourceQuery->Connect( '', 2 );
}
public function tearDown()
public function tearDown() : void
{
$this->SourceQuery->Disconnect();
unset( $this->Socket, $this->SourceQuery );
}
/**
* @expectedException xPaw\SourceQuery\Exception\InvalidArgumentException
*/
public function testInvalidTimeout()
public function testInvalidTimeout() : void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidArgumentException::class );
$SourceQuery = new SourceQuery( );
$SourceQuery->Connect( 1, 2, -1 );
$SourceQuery->Connect( '', 2, -1 );
}
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedGetInfo()
public function testNotConnectedGetInfo() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Disconnect();
$this->SourceQuery->GetInfo();
}
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedPing()
public function testNotConnectedPing() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Disconnect();
$this->SourceQuery->Ping();
}
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedGetPlayers()
public function testNotConnectedGetPlayers() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Disconnect();
$this->SourceQuery->GetPlayers();
}
@@ -120,42 +111,37 @@
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedGetRules()
public function testNotConnectedGetRules() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Disconnect();
$this->SourceQuery->GetRules();
}
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedSetRconPassword()
public function testNotConnectedSetRconPassword() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Disconnect();
$this->SourceQuery->SetRconPassword('a');
}
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testNotConnectedRcon()
public function testNotConnectedRcon() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Disconnect();
$this->SourceQuery->Rcon('a');
}
/**
* @expectedException xPaw\SourceQuery\Exception\SocketException
*/
public function testRconWithoutPassword()
public function testRconWithoutPassword() : void
{
$this->expectException( xPaw\SourceQuery\Exception\SocketException::class );
$this->SourceQuery->Rcon('a');
}
/**
* @dataProvider InfoProvider
*/
public function testGetInfo( $RawInput, $ExpectedOutput )
public function testGetInfo( string $RawInput, array $ExpectedOutput ) : void
{
if( isset( $ExpectedOutput[ 'IsMod' ] ) )
{
@@ -169,7 +155,7 @@
$this->assertEquals( $ExpectedOutput, $RealOutput );
}
public function InfoProvider()
public function InfoProvider() : array
{
$DataProvider = [];
@@ -188,33 +174,33 @@
}
/**
* @expectedException xPaw\SourceQuery\Exception\InvalidPacketException
* @dataProvider BadPacketProvider
*/
public function testBadGetInfo( $Data )
public function testBadGetInfo( string $Data ) : void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidPacketException::class );
$this->Socket->Queue( $Data );
$this->SourceQuery->GetInfo();
}
/**
* @expectedException xPaw\SourceQuery\Exception\InvalidPacketException
* @dataProvider BadPacketProvider
*/
public function testBadGetChallengeViaPlayers( $Data )
public function testBadGetChallengeViaPlayers( string $Data ) : void
{
$this->expectException( xPaw\SourceQuery\Exception\InvalidPacketException::class );
$this->Socket->Queue( $Data );
$this->SourceQuery->GetPlayers();
}
/**
* @expectedException xPaw\SourceQuery\Exception\InvalidPacketException
* @dataProvider BadPacketProvider
*/
public function testBadGetPlayersAfterCorrectChallenge( $Data )
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 );
@@ -222,18 +208,18 @@
}
/**
* @expectedException xPaw\SourceQuery\Exception\InvalidPacketException
* @dataProvider BadPacketProvider
*/
public function testBadGetRulesAfterCorrectChallenge( $Data )
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->SourceQuery->GetRules();
}
public function BadPacketProvider( )
public function BadPacketProvider( ) : array
{
return
[
@@ -247,7 +233,7 @@
];
}
public function testGetChallengeTwice( )
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" );
@@ -260,7 +246,7 @@
/**
* @dataProvider RulesProvider
*/
public function testGetRules( $RawInput, $ExpectedOutput )
public function testGetRules( array $RawInput, array $ExpectedOutput ) : void
{
$this->Socket->Queue( hex2bin( "ffffffff4104fce20e" ) ); // Challenge
@@ -274,7 +260,7 @@
$this->assertEquals( $ExpectedOutput, $RealOutput );
}
public function RulesProvider()
public function RulesProvider() : array
{
$DataProvider = [];
@@ -295,7 +281,7 @@
/**
* @dataProvider PlayersProvider
*/
public function testGetPlayers( $RawInput, $ExpectedOutput )
public function testGetPlayers( array $RawInput, array $ExpectedOutput ) : void
{
$this->Socket->Queue( hex2bin( "ffffffff4104fce20e" ) ); // Challenge
@@ -309,7 +295,7 @@
$this->assertEquals( $ExpectedOutput, $RealOutput );
}
public function PlayersProvider()
public function PlayersProvider() : array
{
$DataProvider = [];
@@ -327,7 +313,7 @@
return $DataProvider;
}
public function testPing()
public function testPing() : void
{
$this->Socket->Queue( "\xFF\xFF\xFF\xFF\x6A\x00");
$this->assertTrue( $this->SourceQuery->Ping() );
+3 -10
View File
@@ -4,13 +4,6 @@
"homepage": "https://github.com/xPaw/PHP-Source-Query",
"type": "library",
"license": "LGPL-2.1",
"authors":
[
{
"name": "Pavel Djundik",
"email": "sourcequery@xpaw.me"
}
],
"keywords":
[
"rcon",
@@ -25,12 +18,12 @@
],
"require":
{
"php": ">=7.2"
"php": ">=7.4"
},
"require-dev":
{
"phpunit/phpunit": "^6.0",
"php-coveralls/php-coveralls": "^2.1"
"phpunit/phpunit": "9.2",
"vimeo/psalm": "^3.12"
},
"autoload":
{
+16
View File
@@ -0,0 +1,16 @@
<?xml version="1.0"?>
<psalm
errorLevel="1"
resolveFromConfigFile="true"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="https://getpsalm.org/schema/config"
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
>
<projectFiles>
<directory name="SourceQuery" />
<directory name="Tests" />
<ignoreFiles>
<directory name="vendor" />
</ignoreFiles>
</projectFiles>
</psalm>