| 1: | <?php declare(strict_types=1); |
| 2: | |
| 3: | |
| 4: | |
| 5: | |
| 6: | |
| 7: | |
| 8: | |
| 9: | |
| 10: | |
| 11: | |
| 12: | |
| 13: | namespace Clansuite\ServerQuery\ServerProtocols; |
| 14: | |
| 15: | use function count; |
| 16: | use function file_get_contents; |
| 17: | use function is_array; |
| 18: | use function is_scalar; |
| 19: | use function json_decode; |
| 20: | use function stream_context_create; |
| 21: | use Clansuite\Capture\Protocol\ProtocolInterface; |
| 22: | use Clansuite\Capture\ServerAddress; |
| 23: | use Clansuite\Capture\ServerInfo; |
| 24: | use Clansuite\ServerQuery\CSQuery; |
| 25: | use Override; |
| 26: | |
| 27: | |
| 28: | |
| 29: | |
| 30: | |
| 31: | |
| 32: | |
| 33: | |
| 34: | |
| 35: | class Factorio extends CSQuery implements ProtocolInterface |
| 36: | { |
| 37: | |
| 38: | |
| 39: | |
| 40: | public string $name = 'Factorio'; |
| 41: | |
| 42: | |
| 43: | |
| 44: | |
| 45: | public string $protocol = 'factorio'; |
| 46: | |
| 47: | |
| 48: | |
| 49: | |
| 50: | public function __construct(mixed $address = null, mixed $queryport = null) |
| 51: | { |
| 52: | parent::__construct(); |
| 53: | $this->address = $address !== null ? (string) $address : null; |
| 54: | $this->queryport = $queryport !== null ? (int) $queryport : null; |
| 55: | } |
| 56: | |
| 57: | |
| 58: | |
| 59: | |
| 60: | #[Override] |
| 61: | public function query(ServerAddress $addr): ServerInfo |
| 62: | { |
| 63: | $info = new ServerInfo; |
| 64: | $info->online = false; |
| 65: | |
| 66: | if ($this->queryHTTP($addr, $info)) { |
| 67: | $info->online = true; |
| 68: | } |
| 69: | |
| 70: | return $info; |
| 71: | } |
| 72: | |
| 73: | |
| 74: | |
| 75: | |
| 76: | #[Override] |
| 77: | public function getProtocolName(): string |
| 78: | { |
| 79: | return $this->protocol; |
| 80: | } |
| 81: | |
| 82: | |
| 83: | |
| 84: | |
| 85: | #[Override] |
| 86: | public function getVersion(ServerInfo $info): string |
| 87: | { |
| 88: | return $info->gameversion ?? 'unknown'; |
| 89: | } |
| 90: | |
| 91: | |
| 92: | |
| 93: | |
| 94: | #[Override] |
| 95: | public function query_server(bool $getPlayers = true, bool $getRules = true): bool |
| 96: | { |
| 97: | |
| 98: | $addr = new ServerAddress($this->address ?? '', $this->queryport ?? 0); |
| 99: | $info = $this->query($addr); |
| 100: | |
| 101: | $this->online = $info->online; |
| 102: | $this->servertitle = $info->servertitle ?? ''; |
| 103: | $this->mapname = $info->mapname ?? ''; |
| 104: | $this->numplayers = $info->numplayers; |
| 105: | $this->maxplayers = $info->maxplayers; |
| 106: | $this->gamename = $info->gamename ?? ''; |
| 107: | $this->gameversion = $info->gameversion ?? ''; |
| 108: | $this->gametype = $info->gametype ?? ''; |
| 109: | $this->password = (int) ($info->password ?? false); |
| 110: | |
| 111: | if ($getPlayers && $info->players !== []) { |
| 112: | $this->players = $info->players; |
| 113: | } |
| 114: | |
| 115: | if ($getRules && $info->rules !== []) { |
| 116: | $this->rules = $info->rules; |
| 117: | } |
| 118: | |
| 119: | return $this->online; |
| 120: | } |
| 121: | |
| 122: | private function queryHTTP(ServerAddress $addr, ServerInfo $info): bool |
| 123: | { |
| 124: | $host = $addr->ip; |
| 125: | $port = $addr->port; |
| 126: | $url = "https://multiplayer.factorio.com/get-game-details/{$host}:{$port}"; |
| 127: | |
| 128: | $context = stream_context_create([ |
| 129: | 'http' => [ |
| 130: | 'timeout' => 5, |
| 131: | ], |
| 132: | ]); |
| 133: | |
| 134: | $response = @file_get_contents($url, false, $context); |
| 135: | |
| 136: | if ($response === false) { |
| 137: | return false; |
| 138: | } |
| 139: | |
| 140: | $data = json_decode($response, true); |
| 141: | |
| 142: | if ($data === null || !is_array($data)) { |
| 143: | return false; |
| 144: | } |
| 145: | |
| 146: | |
| 147: | $info->address = $addr->ip . ':' . $addr->port; |
| 148: | $info->queryport = $addr->port; |
| 149: | $info->gamename = 'Factorio'; |
| 150: | $info->servertitle = (string) ($data['name'] ?? ''); |
| 151: | $info->mapname = ''; |
| 152: | $info->gametype = ''; |
| 153: | $playersData = $data['players'] ?? []; |
| 154: | $info->numplayers = is_array($playersData) ? count($playersData) : 0; |
| 155: | $info->maxplayers = (int) ($data['max_players'] ?? 0); |
| 156: | $info->password = (bool) ($data['has_password'] ?? false); |
| 157: | $appVer = $data['application_version'] ?? []; |
| 158: | |
| 159: | if (is_array($appVer)) { |
| 160: | $gameVer = $appVer['game_version'] ?? ''; |
| 161: | $buildVer = $appVer['build_version'] ?? ''; |
| 162: | $info->gameversion = (string) $gameVer . '.' . (string) $buildVer; |
| 163: | } else { |
| 164: | $info->gameversion = ''; |
| 165: | } |
| 166: | |
| 167: | |
| 168: | $players = []; |
| 169: | |
| 170: | if (isset($data['players']) && is_array($data['players'])) { |
| 171: | foreach ($data['players'] as $name) { |
| 172: | $players[] = ['name' => (string) $name, 'score' => 0, 'time' => 0]; |
| 173: | } |
| 174: | } |
| 175: | $info->players = $players; |
| 176: | |
| 177: | |
| 178: | $rules = []; |
| 179: | |
| 180: | foreach ($data as $key => $value) { |
| 181: | if (is_scalar($value)) { |
| 182: | $rules[(string) $key] = (string) $value; |
| 183: | } elseif (is_array($value) && $key === 'application_version') { |
| 184: | $rules['game_version'] = (string) ($value['game_version'] ?? ''); |
| 185: | $rules['build_version'] = (string) ($value['build_version'] ?? ''); |
| 186: | } |
| 187: | } |
| 188: | $info->rules = $rules; |
| 189: | |
| 190: | return true; |
| 191: | } |
| 192: | } |
| 193: | |