diff --git a/src/Xash3D/Master.php b/src/Xash3D/Master.php index d710254..5ea743e 100644 --- a/src/Xash3D/Master.php +++ b/src/Xash3D/Master.php @@ -4,6 +4,27 @@ declare(strict_types=1); namespace Yggverse\Hl\Xash3D; +enum Family: int { + case IPv4 = 4; + case IPv6 = 16; +} + +enum Region: string { + case USEastCoast = "0x00"; + case USWestCoast = "0x01"; + case SouthAmerica = "0x02"; + case Europe = "0x03"; + case Asia = "0x04"; + case Australia = "0x05"; + case MiddleEast = "0x06"; + case Africa = "0x07"; + case World = "0xff"; +} + +enum Game: string { + case Valve = "valve"; +} + class Master { private string $_host; @@ -14,7 +35,7 @@ class Master public function __construct( string $host, - int $port, + int $port = 27010, int $timeout = 5 ) { @@ -35,14 +56,18 @@ class Master } } - public function getServersIPv6( + // Legacy protocol implementation does not support mixed address families + // in the binary master socket response, use separated method for IPv4 servers. + public function getServers( int $limit = 100, - string $region = "\xFF", - string $host = "0.0.0.0:0", + string $host = "0.0.0.0", int $port = 0, - string $gamedir = "valve" + Game $game = Game::Valve, + Region $region = Region::World ): ?array { + $family = filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) ? Family::IPv4 : Family::IPv6; + // Init connection $socket = fsockopen( "udp://{$this->_host}", @@ -52,6 +77,8 @@ class Master $this->_timeout ); + $master = "{$this->_host}:{$this->_port}"; + // Is connected if (true === is_resource($socket)) { @@ -64,7 +91,7 @@ class Master else { $this->_errors[] = sprintf( - _('Connection error: %s'), + _("Connection error for $master: %s"), $message ); @@ -76,9 +103,9 @@ class Master } // Filter query - if (false === fwrite($socket, "1{$region}{$host}:{$port}\0\gamedir\t{$gamedir}\0")) + if (false === fwrite($socket, "1{$region->value}{$host}:{$port}\0\\gamedir\\{$game->value}\0")) { - $this->_errors[] = _('Could not send socket query'); + $this->_errors[] = _("Could not send socket query for $master"); $this->_fclose( $socket @@ -90,7 +117,7 @@ class Master // Skip header if (false === fread($socket, 6)) { - $this->_errors[] = _('Could not init packet header'); + $this->_errors[] = _("Could not init packet header for $master"); $this->_fclose( $socket @@ -104,59 +131,52 @@ class Master for ($i = 0; $i < $limit; $i++) { - // Get host - if (false === $host = fread($socket, 16)) + // Get host bytes + if (false === $host = fread($socket, $family->value)) { + $this->_errors[] = _("Invalid `host` fragment in packet at $i for $master"); break; } - // Is end of packet + // End of packet if (true === str_ends_with(bin2hex($host), bin2hex("\0\0\0\0\0\0"))) { break; } - // Skip invalid host value + // Get host string if (false === $host = inet_ntop($host)) { - // Shift port bytes - fread($socket, 2); - - continue; + $this->_errors[] = _("Invalid `host` value in packet at $i for $master"); + break; } - // Decode first byte of port - if (false === $byte1 = fread($socket, 1)) + // Get port bytes + if (false === $p = fread($socket, 2)) { - // Shift port byte - fread($socket, 1); - - continue; + $this->_errors[] = _("Invalid `port` fragment in packet at $i for $master"); + break; } - // Decode second byte of port - if (false === $byte2 = fread($socket, 1)) + // Get port value + if (false === $p = unpack('nport', $p)) { - continue; + $this->_errors[] = _("Invalid `port` value in packet at $i for $master"); + break; } - // Calculate port value - $port = ord($byte1) * 256 + ord($byte2); - - // Validate IPv6 result - if ( - false !== strpos($host, '.') || // filter_var not always works with mixed IPv6 - false === filter_var($host, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) || - false === filter_var($port, FILTER_VALIDATE_INT) - ) + // Validate result + if (false === filter_var($host, FILTER_VALIDATE_IP, $family == Family::IPv6 ? FILTER_FLAG_IPV6 + : FILTER_FLAG_IPV4) || empty($p['port'])) { - continue; + $this->_errors[] = _("Invalid socket address in packet at $i for $master"); + break; } - $servers["[{$host}]:{$port}"] = // keep unique + $servers["{$host}{$p['port']}"] = // keep unique [ 'host' => $host, - 'port' => $port + 'port' => $p['port'] ]; }