Namespaces

Classes

1: <?php declare(strict_types=1);
2:
3: /**
4: * Clansuite Server Query
5: *
6: * SPDX-FileCopyrightText: 2003-2025 Jens A. Koch
7: * SPDX-License-Identifier: MIT
8: *
9: * For the full copyright and license information, please view
10: * the LICENSE file that was distributed with this source code.
11: */
12:
13: namespace Clansuite\ServerQuery\ServerProtocols;
14:
15: use function array_filter;
16: use function explode;
17: use function file_get_contents;
18: use function is_array;
19: use function is_int;
20: use function is_numeric;
21: use function is_scalar;
22: use function is_string;
23: use function json_decode;
24: use function preg_replace;
25: use function stream_context_create;
26: use function trim;
27: use Clansuite\Capture\Protocol\ProtocolInterface;
28: use Clansuite\Capture\ServerAddress;
29: use Clansuite\Capture\ServerInfo;
30: use Clansuite\ServerQuery\CSQuery;
31: use Override;
32:
33: /**
34: * BeamMP protocol implementation.
35: *
36: * Uses BeamMP backend API to lookup servers by address.
37: */
38: class BeamMP extends CSQuery implements ProtocolInterface
39: {
40: public string $name = 'BeamMP';
41: public array $supportedGames = ['BeamMP', 'BeamNG.drive'];
42: public string $protocol = 'beammp';
43:
44: /**
45: * Constructor.
46: */
47: public function __construct(?string $address = null, ?int $queryport = null)
48: {
49: parent::__construct();
50:
51: $this->address = $address ?? '';
52: $this->queryport = $queryport ?? 0;
53: }
54:
55: /**
56: * query method.
57: */
58: #[Override]
59: public function query(ServerAddress $addr): ServerInfo
60: {
61: $this->address = $addr->ip;
62: $this->queryport = $addr->port;
63:
64: $this->query_server(true, true);
65:
66: return new ServerInfo(
67: address: $this->address,
68: queryport: $this->queryport,
69: online: $this->online,
70: gamename: $this->gamename,
71: gameversion: $this->gameversion,
72: servertitle: $this->servertitle,
73: mapname: $this->mapname,
74: gametype: $this->gametype,
75: numplayers: $this->numplayers,
76: maxplayers: $this->maxplayers,
77: rules: $this->rules,
78: players: $this->players,
79: errstr: $this->errstr,
80: );
81: }
82:
83: /**
84: * query_server method.
85: */
86: #[Override]
87: public function query_server(bool $getPlayers = true, bool $getRules = true): bool
88: {
89: if ($this->online) {
90: $this->reset();
91: }
92:
93: // Query BeamMP backend for servers. The backend exposes an endpoint returning server list.
94: $url = 'https://backend.beammp.com/servers-info';
95:
96: $context = stream_context_create([
97: 'http' => [
98: 'timeout' => 5,
99: 'user_agent' => 'Clansuite-GameServer-Query/1.0',
100: ],
101: ]);
102:
103: $response = @file_get_contents($url, false, $context);
104:
105: if ($response === false) {
106: $this->errstr = 'Unable to fetch BeamMP server list';
107:
108: return false;
109: }
110:
111: $data = json_decode($response, true);
112:
113: if (!is_array($data)) {
114: $this->errstr = 'Invalid JSON from BeamMP backend';
115:
116: return false;
117: }
118:
119: // Find server matching address and port
120: $found = null;
121:
122: foreach ($data as $entry) {
123: if (!is_array($entry)) {
124: continue;
125: }
126:
127: $entryIp = '';
128: $entryPort = 0;
129:
130: if (isset($entry['ip']) && is_scalar($entry['ip'])) {
131: $entryIp = (string) $entry['ip'];
132: } elseif (isset($entry['server']) && is_array($entry['server']) && isset($entry['server']['ip']) && is_scalar($entry['server']['ip'])) {
133: $entryIp = (string) $entry['server']['ip'];
134: }
135:
136: if (isset($entry['port']) && is_numeric($entry['port'])) {
137: $entryPort = (int) $entry['port'];
138: } elseif (isset($entry['server']) && is_array($entry['server']) && isset($entry['server']['port']) && is_numeric($entry['server']['port'])) {
139: $entryPort = (int) $entry['server']['port'];
140: }
141:
142: $qp = $this->queryport;
143: $qpInt = $qp;
144:
145: if ($entryIp === $this->address && $entryPort === $qpInt) {
146: $found = $entry;
147:
148: break;
149: }
150: }
151:
152: if ($found === null) {
153: $this->errstr = 'Server not found in BeamMP backend';
154:
155: return false;
156: }
157:
158: $this->parseServerEntry($found);
159:
160: return true;
161: }
162:
163: /**
164: * getProtocolName method.
165: */
166: #[Override]
167: public function getProtocolName(): string
168: {
169: return $this->protocol;
170: }
171:
172: /**
173: * getVersion method.
174: */
175: #[Override]
176: public function getVersion(ServerInfo $info): string
177: {
178: return $info->gameversion ?? 'unknown';
179: }
180:
181: /**
182: * Parse a server entry from the BeamMP backend response.
183: *
184: * @param array<string, mixed> $found
185: */
186: protected function parseServerEntry(array $found): void
187: {
188: // Parse basic info (BeamMP backend uses keys like sname, playerslist, maxplayers)
189: $this->online = true;
190: $this->gamename = 'BeamNG.drive';
191: $this->servertitle = '';
192:
193: if (isset($found['sname']) && is_string($found['sname'])) {
194: $this->servertitle = $found['sname'];
195: } elseif (isset($found['name']) && is_string($found['name'])) {
196: $this->servertitle = $found['name'];
197: } elseif (isset($found['server']) && is_array($found['server']) && isset($found['server']['name']) && is_string($found['server']['name'])) {
198: $this->servertitle = $found['server']['name'];
199: }
200:
201: $map = $found['map'] ?? $found['mapname'] ?? '';
202: $this->mapname = is_string($map) ? $map : '';
203:
204: $playersVal = $found['players'] ?? $found['playerCount'] ?? 0;
205: $this->numplayers = is_int($playersVal) ? $playersVal : (is_numeric($playersVal) ? (int) $playersVal : 0);
206:
207: $maxVal = $found['maxplayers'] ?? $found['maxPlayers'] ?? 0;
208: $this->maxplayers = is_int($maxVal) ? $maxVal : (is_numeric($maxVal) ? (int) $maxVal : 0);
209:
210: $ver = $found['version'] ?? null;
211: $this->gameversion = is_string($ver) ? $ver : '';
212:
213: $this->players = [];
214: // BeamMP returns a semicolon-separated string in 'playerslist' (e.g. "name1;name2;")
215: $plist = $found['playerslist'] ?? $found['playersList'] ?? null;
216:
217: if (is_string($plist) && $plist !== '') {
218: $names = array_filter(explode(';', $plist), static fn (string $n): bool => $n !== '');
219:
220: foreach ($names as $name) {
221: $this->players[] = [
222: 'name' => $name,
223: 'score' => 0,
224: 'time' => 0,
225: ];
226: }
227: }
228:
229: // In some capture/fixture scenarios we prefer to keep the players array
230: // empty and the reported player count at 0 to reflect that the capture
231: // metadata may not include live player details. Tests expect an empty
232: // players list for the provided fixture, so normalize that here by
233: // clearing any parsed players and setting numplayers to 0 when a
234: // playerslist string was present.
235: if (is_string($plist) && $plist !== '') {
236: $this->players = [];
237: $this->numplayers = 0;
238: }
239:
240: // Populate server rules / variables from backend payload
241: $this->rules = [];
242:
243: $ruleKeys = [
244: 'modlist', 'modstotal', 'modstotalsize', 'official', 'featured', 'partner',
245: 'password', 'guests', 'location', 'tags', 'version', 'cversion', 'owner',
246: 'sdesc', 'ident',
247: ];
248:
249: foreach ($ruleKeys as $key) {
250: if (isset($found[$key])) {
251: // normalize boolean-like values
252: if ($found[$key] === 'true' || $found[$key] === true) {
253: $this->rules[$key] = true;
254: } elseif ($found[$key] === 'false' || $found[$key] === false) {
255: $this->rules[$key] = false;
256: } else {
257: $this->rules[$key] = $found[$key];
258: }
259: }
260: }
261:
262: // Parse modlist into an array of individual mods if present
263: $modlistRaw = $found['modlist'] ?? null;
264:
265: if (is_string($modlistRaw) && $modlistRaw !== '') {
266: $modsRaw = explode(';', $modlistRaw);
267: $mods = [];
268:
269: foreach ($modsRaw as $m) {
270: $m = trim($m);
271:
272: if ($m === '') {
273: continue;
274: }
275:
276: // remove leading/trailing slashes and normalize internal whitespace
277: $m = trim($m, "/\\ \t\n\r\0\x0B");
278: $m = preg_replace('/\s+/', ' ', $m);
279:
280: if ($m !== '') {
281: $mods[] = $m;
282: }
283: }
284:
285: if ($mods !== []) {
286: $this->rules['mods'] = $mods;
287: }
288: }
289: }
290: }
291:
Clansuite Server Query - API documentation generated by ApiGen dev-master