File GameQ/Protocols/Raknet.php

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 <austin@codebeard.com>
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(
88:	$this->packets[self::PACKET_STATUS],
89:	pack('Q', time()),
90:	self::OFFLINE_MESSAGE_DATA_ID
91:	);
92:	}
93:
94:	/**
95:	* Process the response
96:	*
97:	* @return array
98:	* @throws \GameQ\Exception\Protocol
99:	*/
100:	public function processResponse()
101:	{
102:	// Merge the response array into a buffer. Unknown if this protocol does split packets or not
103:	$buffer = new Buffer(implode($this->packets_response));
104:
105:	// Read first character from response. It should match below
106:	$header = $buffer->read(1);
107:
108:	// Check first character to make sure the header matches
109:	if ($header !== self::ID_UNCONNECTED_PONG) {
110:	throw new Exception(sprintf(
111:	'%s The header returned "%s" does not match the expected header of "%s"',
112:	__METHOD__,
113:	bin2hex($header),
114:	bin2hex(self::ID_UNCONNECTED_PONG)
115:	));
116:	}
117:
118:	// Burn the time section
119:	$buffer->skip(8);
120:
121:	// Server GUID is next
122:	$serverGUID = $buffer->readInt64();
123:
124:	// Read the next set to check to make sure the "magic" matches
125:	$magicCheck = $buffer->read(16);
126:
127:	// Magic check fails
128:	if ($magicCheck !== self::OFFLINE_MESSAGE_DATA_ID) {
129:	throw new Exception(sprintf(
130:	'%s The magic value returned "%s" does not match the expected value of "%s"',
131:	__METHOD__,
132:	bin2hex($magicCheck),
133:	bin2hex(self::OFFLINE_MESSAGE_DATA_ID)
134:	));
135:	}
136:
137:	// According to docs the next character is supposed to be used for a length and string for the following
138:	// character for the MOTD but it appears to be implemented incorrectly
139:	// Burn the next two characters instead of trying to do anything useful with them
140:	$buffer->skip(2);
141:
142:	// Set the result to a new result instance
143:	$result = new Result();
144:
145:	// Here on is server information delimited by semicolons (;)
146:	$info = explode(';', $buffer->getBuffer());
147:
148:	$result->add('edition', $info[0]);
149:	$result->add('motd_line_1', $info[1]);
150:	$result->add('protocol_version', (int)$info[2]);
151:	$result->add('version', $info[3]);
152:	$result->add('num_players', (int)$info[4]);
153:	$result->add('max_players', (int)$info[5]);
154:	$result->add('server_uid', $info[6]);
155:	$result->add('motd_line_2', $info[7]);
156:	$result->add('gamemode', $info[8]);
157:	$result->add('gamemode_numeric', (int)$info[9]);
158:	$result->add('port_ipv4', (isset($info[10])) ? (int)$info[10] : null);
159:	$result->add('port_ipv6', (isset($info[11])) ? (int)$info[11] : null);
160:	$result->add('dedicated', 1);
161:
162:	unset($header, $serverGUID, $magicCheck, $info);
163:
164:	return $result->fetch();
165:	}
166:	}
167:

Namespaces

Classes