File GameQ/Protocols/Etqw.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:
26:	/**
27:	* Enemy Territory Quake Wars Protocol Class
28:	*
29:	* @author Austin Bischoff <austin@codebeard.com>
30:	*/
31:	class Etqw extends Protocol
32:	{
33:
34:	/**
35:	* Array of packets we want to look up.
36:	* Each key should correspond to a defined method in this or a parent class
37:	*
38:	* @type array
39:	*/
40:	protected $packets = [
41:	self::PACKET_STATUS => "\xFF\xFFgetInfoEx\x00\x00\x00\x00",
42:	//self::PACKET_STATUS => "\xFF\xFFgetInfo\x00\x00\x00\x00\x00",
43:	];
44:
45:	/**
46:	* Use the response flag to figure out what method to run
47:	*
48:	* @type array
49:	*/
50:	protected $responses = [
51:	"\xFF\xFFinfoExResponse" => "processStatus",
52:	];
53:
54:	/**
55:	* The query protocol used to make the call
56:	*
57:	* @type string
58:	*/
59:	protected $protocol = 'etqw';
60:
61:	/**
62:	* String name of this protocol class
63:	*
64:	* @type string
65:	*/
66:	protected $name = 'etqw';
67:
68:	/**
69:	* Longer string name of this protocol class
70:	*
71:	* @type string
72:	*/
73:	protected $name_long = "Enemy Territory Quake Wars";
74:
75:	/**
76:	* Normalize settings for this protocol
77:	*
78:	* @type array
79:	*/
80:	protected $normalize = [
81:	// General
82:	'general' => [
83:	// target => source
84:	'gametype' => 'campaign',
85:	'hostname' => 'name',
86:	'mapname' => 'map',
87:	'maxplayers' => 'maxPlayers',
88:	'mod' => 'gamename',
89:	'numplayers' => 'numplayers',
90:	'password' => 'privateClients',
91:	],
92:	// Individual
93:	'player' => [
94:	'name' => 'name',
95:	'score' => 'score',
96:	'time' => 'time',
97:	],
98:	];
99:
100:	/**
101:	* Process the response
102:	*
103:	* @return array
104:	* @throws \GameQ\Exception\Protocol
105:	*/
106:	public function processResponse()
107:	{
108:	// In case it comes back as multiple packets (it shouldn't)
109:	$buffer = new Buffer(implode('', $this->packets_response));
110:
111:	// Figure out what packet response this is for
112:	$response_type = $buffer->readString();
113:
114:	// Figure out which packet response this is
115:	if (!array_key_exists($response_type, $this->responses)) {
116:	throw new Exception(__METHOD__ . " response type '{$response_type}' is not valid");
117:	}
118:
119:	// Offload the call
120:	$results = call_user_func_array([$this, $this->responses[$response_type]], [$buffer]);
121:
122:	return $results;
123:	}
124:
125:	/*
126:	* Internal methods
127:	*/
128:
129:	/**
130:	* Handle processing the status response
131:	*
132:	* @param Buffer $buffer
133:	*
134:	* @return array
135:	*/
136:	protected function processStatus(Buffer $buffer)
137:	{
138:	// Set the result to a new result instance
139:	$result = new Result();
140:
141:	// Defaults
142:	$result->add('dedicated', 1);
143:
144:	// Now burn the challenge, version and size
145:	$buffer->skip(16);
146:
147:	// Key / value pairs
148:	while ($buffer->getLength()) {
149:	$var = str_replace('si_', '', $buffer->readString());
150:	$val = $buffer->readString();
151:	if (empty($var) && empty($val)) {
152:	break;
153:	}
154:	// Add the server prop
155:	$result->add($var, $val);
156:	}
157:	// Now let's do the basic player info
158:	$this->parsePlayers($buffer, $result);
159:
160:	// Now grab the rest of the server info
161:	$result->add('osmask', $buffer->readInt32());
162:	$result->add('ranked', $buffer->readInt8());
163:	$result->add('timeleft', $buffer->readInt32());
164:	$result->add('gamestate', $buffer->readInt8());
165:	$result->add('servertype', $buffer->readInt8());
166:
167:	// 0: regular server
168:	if ($result->get('servertype') == 0) {
169:	$result->add('interested_clients', $buffer->readInt8());
170:	} else {
171:	// 1: tv server
172:	$result->add('connected_clients', $buffer->readInt32());
173:	$result->add('max_clients', $buffer->readInt32());
174:	}
175:
176:	// Now let's parse the extended player info
177:	$this->parsePlayersExtra($buffer, $result);
178:
179:	unset($buffer);
180:
181:	return $result->fetch();
182:	}
183:
184:	/**
185:	* Parse players out of the status ex response
186:	*
187:	* @param Buffer $buffer
188:	* @param Result $result
189:	*/
190:	protected function parsePlayers(Buffer &$buffer, Result &$result)
191:	{
192:	// By default there are 0 players
193:	$players = 0;
194:
195:	// Iterate over the players until we run out
196:	while (($id = $buffer->readInt8()) != 32) {
197:	$result->addPlayer('id', $id);
198:	$result->addPlayer('ping', $buffer->readInt16());
199:	$result->addPlayer('name', $buffer->readString());
200:	$result->addPlayer('clantag_pos', $buffer->readInt8());
201:	$result->addPlayer('clantag', $buffer->readString());
202:	$result->addPlayer('bot', $buffer->readInt8());
203:	$players++;
204:	}
205:
206:	// Let's add in the current players as a result
207:	$result->add('numplayers', $players);
208:
209:	// Free some memory
210:	unset($id);
211:	}
212:
213:	/**
214:	* Handle parsing extra player data
215:	*
216:	* @param Buffer $buffer
217:	* @param Result $result
218:	*/
219:	protected function parsePlayersExtra(Buffer &$buffer, Result &$result)
220:	{
221:	// Iterate over the extra player info
222:	while (($id = $buffer->readInt8()) != 32) {
223:	$result->addPlayer('total_xp', $buffer->readFloat32());
224:	$result->addPlayer('teamname', $buffer->readString());
225:	$result->addPlayer('total_kills', $buffer->readInt32());
226:	$result->addPlayer('total_deaths', $buffer->readInt32());
227:	}
228:
229:	// @todo: Add team stuff
230:
231:	// Free some memory
232:	unset($id);
233:	}
234:	}
235:

Namespaces

Classes