|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* This file is part of GameQ. |
|
4
|
|
|
* |
|
5
|
|
|
* GameQ is free software; you can redistribute it and/or modify |
|
6
|
|
|
* it under the terms of the GNU Lesser General Public License as published by |
|
7
|
|
|
* the Free Software Foundation; either version 3 of the License, or |
|
8
|
|
|
* (at your option) any later version. |
|
9
|
|
|
* |
|
10
|
|
|
* GameQ is distributed in the hope that it will be useful, |
|
11
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
12
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
13
|
|
|
* GNU Lesser General Public License for more details. |
|
14
|
|
|
* |
|
15
|
|
|
* You should have received a copy of the GNU Lesser General Public License |
|
16
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
17
|
|
|
*/ |
|
18
|
|
|
|
|
19
|
|
|
namespace GameQ\Protocols; |
|
20
|
|
|
|
|
21
|
|
|
use GameQ\Buffer; |
|
22
|
|
|
use GameQ\Exception\Protocol as Exception; |
|
23
|
|
|
use GameQ\Protocol; |
|
24
|
|
|
use GameQ\Result; |
|
25
|
|
|
use GameQ\Server; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* Raknet Protocol Class |
|
29
|
|
|
* |
|
30
|
|
|
* See https://wiki.vg/Raknet_Protocol for more techinal information |
|
31
|
|
|
* |
|
32
|
|
|
* @author Austin Bischoff <[email protected]> |
|
33
|
|
|
*/ |
|
34
|
|
|
class Raknet extends Protocol |
|
35
|
|
|
{ |
|
36
|
|
|
/** |
|
37
|
|
|
* The magic string that is sent to get access to the server information |
|
38
|
|
|
*/ |
|
39
|
|
|
const OFFLINE_MESSAGE_DATA_ID = "\x00\xFF\xFF\x00\xFE\xFE\xFE\xFE\xFD\xFD\xFD\xFD\x12\x34\x56\x78"; |
|
40
|
|
|
|
|
41
|
|
|
/** |
|
42
|
|
|
* Expected first part of the response from the server after query |
|
43
|
|
|
*/ |
|
44
|
|
|
const ID_UNCONNECTED_PONG = "\x1C"; |
|
45
|
|
|
|
|
46
|
|
|
/** |
|
47
|
|
|
* Array of packets we want to look up. |
|
48
|
|
|
* Each key should correspond to a defined method in this or a parent class |
|
49
|
|
|
* |
|
50
|
|
|
* @type array |
|
51
|
|
|
*/ |
|
52
|
|
|
protected $packets = [ |
|
53
|
|
|
self::PACKET_STATUS => "\x01%s%s\x02\x00\x00\x00\x00\x00\x00\x00", // Format time, magic, |
|
54
|
|
|
]; |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* The query protocol used to make the call |
|
58
|
|
|
* |
|
59
|
|
|
* @type string |
|
60
|
|
|
*/ |
|
61
|
|
|
protected $protocol = 'raknet'; |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* String name of this protocol class |
|
65
|
|
|
* |
|
66
|
|
|
* @type string |
|
67
|
|
|
*/ |
|
68
|
|
|
protected $name = 'raknet'; |
|
69
|
|
|
|
|
70
|
|
|
/** |
|
71
|
|
|
* Longer string name of this protocol class |
|
72
|
|
|
* |
|
73
|
|
|
* @type string |
|
74
|
|
|
*/ |
|
75
|
|
|
protected $name_long = "Raknet Server"; |
|
76
|
|
|
|
|
77
|
|
|
/** |
|
78
|
|
|
* Do some work to build the packet we need to send out to query |
|
79
|
|
|
* |
|
80
|
|
|
* @param Server $server |
|
81
|
|
|
* |
|
82
|
|
|
* @return void |
|
83
|
|
|
*/ |
|
84
|
|
|
public function beforeSend(Server $server) |
|
85
|
|
|
{ |
|
86
|
|
|
// Update the server status packet before it is sent |
|
87
|
|
|
$this->packets[self::PACKET_STATUS] = sprintf($this->packets[self::PACKET_STATUS], pack('Q', time()), |
|
88
|
|
|
self::OFFLINE_MESSAGE_DATA_ID); |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
/** |
|
92
|
|
|
* Process the response |
|
93
|
|
|
* |
|
94
|
|
|
* @return array |
|
95
|
|
|
* @throws \GameQ\Exception\Protocol |
|
96
|
|
|
*/ |
|
97
|
|
|
public function processResponse() |
|
98
|
|
|
{ |
|
99
|
|
|
// Merge the response array into a buffer. Unknown if this protocol does split packets or not |
|
100
|
|
|
$buffer = new Buffer(implode($this->packets_response)); |
|
101
|
|
|
|
|
102
|
|
|
// Read first character from response. It should match below |
|
103
|
|
|
$header = $buffer->read(1); |
|
104
|
|
|
|
|
105
|
|
|
// Check first character to make sure the header matches |
|
106
|
|
|
if ($header !== self::ID_UNCONNECTED_PONG) { |
|
107
|
|
|
throw new Exception(sprintf('The header returned "%s" does not match the expected header of "%s"!', $header, |
|
108
|
|
|
self::ID_UNCONNECTED_PONG)); |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
// Burn the time section |
|
112
|
|
|
$buffer->skip(8); |
|
113
|
|
|
|
|
114
|
|
|
// Server GUID is next |
|
115
|
|
|
$serverGUID = $buffer->readInt64(); |
|
116
|
|
|
|
|
117
|
|
|
// Read the next set to check to make sure the "magic" matches |
|
118
|
|
|
$magicCheck = $buffer->read(16); |
|
119
|
|
|
|
|
120
|
|
|
// Magic check fails |
|
121
|
|
|
if ($magicCheck !== self::OFFLINE_MESSAGE_DATA_ID) { |
|
122
|
|
|
throw new Exception(sprintf('The magic value returned "%s" does not match the expected value of "%s"!', |
|
123
|
|
|
$magicCheck, self::OFFLINE_MESSAGE_DATA_ID)); |
|
124
|
|
|
} |
|
125
|
|
|
|
|
126
|
|
|
// According to docs the next character is supposed to be used for a length and string for the following character for the MOTD but it appears to be implemented incorrectly |
|
127
|
|
|
// Burn the next two characters instead of trying to do anything useful with them |
|
128
|
|
|
$buffer->skip(2); |
|
129
|
|
|
|
|
130
|
|
|
// Set the result to a new result instance |
|
131
|
|
|
$result = new Result(); |
|
132
|
|
|
|
|
133
|
|
|
// Here on is server information delimited by semicolons (;) |
|
134
|
|
|
$info = explode(';', $buffer->getBuffer()); |
|
135
|
|
|
|
|
136
|
|
|
$result->add('edition', $info[0]); |
|
137
|
|
|
$result->add('motd_line_1', $info[1]); |
|
138
|
|
|
$result->add('protocol_version', (int)$info[2]); |
|
139
|
|
|
$result->add('version', $info[3]); |
|
140
|
|
|
$result->add('num_players', $info[4]); |
|
141
|
|
|
$result->add('max_players', $info[5]); |
|
142
|
|
|
$result->add('server_uid', $info[6]); |
|
143
|
|
|
$result->add('motd_line_2', $info[7]); |
|
144
|
|
|
$result->add('gamemode', $info[8]); |
|
145
|
|
|
$result->add('gamemode_numeric', (int)$info[9]); |
|
146
|
|
|
$result->add('port_ipv4', (int)$info[10]); |
|
147
|
|
|
$result->add('port_ipv6', (int)$info[11]); |
|
148
|
|
|
$result->add('dedicated', 1); |
|
149
|
|
|
|
|
150
|
|
|
unset($header, $serverGUID, $magicCheck, $info); |
|
151
|
|
|
|
|
152
|
|
|
return $result->fetch(); |
|
153
|
|
|
} |
|
154
|
|
|
} |
|
155
|
|
|
|
Austinb /
GameQ
