Teamspeak2::processResponse() - Code Metrics - Austinb/GameQ - Measure and Improve Code Quality continuously with Scrutinizer

Teamspeak2::processResponse() A
last analyzed 2025-02-19 14:42 UTC

↳ Parent: Teamspeak2

Complexity

Conditions	6
Paths	6

Size

Total Lines	44
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	18
c	1
b	0
f	0
dl	0
loc	44
ccs	20
cts	20
cp	1
rs	9.0444
cc	6
nc	6
nop	0
crap	6

<?php
/**
 * This file is part of GameQ.
 *
 * GameQ is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * GameQ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace GameQ\Protocols;

use GameQ\Buffer;
use GameQ\Exception\Protocol as Exception;
use GameQ\Helpers\Str;
use GameQ\Protocol;
use GameQ\Result;
use GameQ\Server;

/**
 * Teamspeak 2 Protocol Class
 *
 * All values are utf8 encoded upon processing
 *
 * This code ported from GameQ v1/v2. Credit to original author(s) as I just updated it to
 * work within this new system.
 *
 * @author Austin Bischoff <[email protected]>
 */
class Teamspeak2 extends Protocol
{
    /**
     * Array of packets we want to look up.
     * Each key should correspond to a defined method in this or a parent class
     *
     * @var array
     */
    protected $packets = [
        self::PACKET_DETAILS  => "sel %d\x0asi\x0a",
        self::PACKET_CHANNELS => "sel %d\x0acl\x0a",
        self::PACKET_PLAYERS  => "sel %d\x0apl\x0a",
    ];

    /**
     * The transport mode for this protocol is TCP
     *
     * @var string
     */
    protected $transport = self::TRANSPORT_TCP;

    /**
     * The query protocol used to make the call
     *
     * @var string
     */
    protected $protocol = 'teamspeak2';

    /**
     * String name of this protocol class
     *
     * @var string
     */
    protected $name = 'teamspeak2';

    /**
     * Longer string name of this protocol class
     *
     * @var string
     */
    protected $name_long = "Teamspeak 2";

    /**
     * The client join link
     *
     * @var string
     */
    protected $join_link = "teamspeak://%s:%d/";

    /**
     * Normalize settings for this protocol
     *
     * @var array
     */
    protected $normalize = [
        // General
        'general' => [
            'dedicated'  => 'dedicated',
            'hostname'   => 'server_name',
            'password'   => 'server_password',
            'numplayers' => 'server_currentusers',
            'maxplayers' => 'server_maxusers',
        ],
        // Player
        'player'  => [
            'id'   => 'p_id',
            'team' => 'c_id',
            'name' => 'nick',
        ],
        // Team
        'team'    => [
            'id'   => 'id',
            'name' => 'name',
        ],
    ];

    /**
     * Before we send off the queries we need to update the packets
     *
     * @param \GameQ\Server $server
     *
     * @throws \GameQ\Exception\Protocol
     */
    public function beforeSend(Server $server)
    {
        // Check to make sure we have a query_port because it is required
        if (!isset($this->options[Server::SERVER_OPTIONS_QUERY_PORT])
            || empty($this->options[Server::SERVER_OPTIONS_QUERY_PORT])
        ) {
            throw new Exception(__METHOD__ . " Missing required setting '" . Server::SERVER_OPTIONS_QUERY_PORT . "'.");
        }

        // Let's loop the packets and set the proper pieces
        foreach ($this->packets as $packet_type => $packet) {
            // Update with the client port for the server
            $this->packets[$packet_type] = sprintf($packet, $server->portClient());
        }
    }

    /**
     * Process the response
     *
     * @return array
     * @throws \GameQ\Exception\Protocol
     */
    public function processResponse()
    {
        // Make a new buffer out of all of the packets
        $buffer = new Buffer(implode('', $this->packets_response));

        // Check the header [TS]
        if (($header = trim($buffer->readString("\n"))) !== '[TS]') {
            throw new Exception(__METHOD__ . " Expected header '{$header}' does not match expected '[TS]'.");
        }

        // Split this buffer as the data blocks are bound by "OK" and drop any empty values
        $sections = array_filter(explode("OK", $buffer->getBuffer()), function ($value) {
            $value = trim($value);

            return !empty($value);
        });

        // Trim up the values to remove extra whitespace
        $sections = array_map('trim', $sections);

        // Set the result to a new result instance
        $result = new Result();

        // Now we need to iterate over the sections and off load the processing
        foreach ($sections as $section) {
            // Grab a snip of the data so we can figure out what it is
            $check = substr($section, 0, 7);

            // Offload to the proper method
            if ($check == 'server_') {
                // Server settings and info
                $this->processDetails($section, $result);
            } elseif ($check == "id\tcode") {
                // Channel info
                $this->processChannels($section, $result);
            } elseif ($check == "p_id\tc_") {
                // Player info
                $this->processPlayers($section, $result);
            }
        }

        unset($buffer, $sections, $section, $check);

        return $result->fetch();
    }

    // Internal methods


    /**
     * Handles processing the details data into a usable format
     *
     * @param string        $data
     * @param \GameQ\Result $result
     * @return void
     * @throws \GameQ\Exception\Protocol
     */
    protected function processDetails($data, Result &$result)
    {
        // Create a buffer
        $buffer = new Buffer($data);

        // Always dedicated
        $result->add('dedicated', 1);

        // Let's loop until we run out of data
        while ($buffer->getLength()) {
            // Grab the row, which is an item
            $row = trim($buffer->readString("\n"));

            // Split out the information
            list($key, $value) = explode('=', $row, 2);

            // Add this to the result
            $result->add($key, Str::isoToUtf8($value));
        }

        unset($data, $buffer, $row, $key, $value);
    }

    /**
     * Process the channel listing
     *
     * @param string        $data
     * @param \GameQ\Result $result
     * @return void
     * @throws \GameQ\Exception\Protocol
     */
    protected function processChannels($data, Result &$result)
    {
        // Create a buffer
        $buffer = new Buffer($data);

        // The first line holds the column names, data returned is in column/row format
        $columns = explode("\t", trim($buffer->readString("\n")), 9);

        // Loop through the rows until we run out of information
        while ($buffer->getLength()) {
            // Grab the row, which is a tabbed list of items
            $row = trim($buffer->readString("\n"));

            // Explode and merge the data with the columns, then parse
            $data = array_combine($columns, explode("\t", $row, 9));

            foreach ($data as $key => $value) {
                // Now add the data to the result
                $result->addTeam($key, Str::isoToUtf8($value));
            }
        }

        unset($data, $buffer, $row, $columns, $key, $value);
    }

    /**
     * Process the user listing
     *
     * @param string        $data
     * @param \GameQ\Result $result
     * @return void
     * @throws \GameQ\Exception\Protocol
     */
    protected function processPlayers($data, Result &$result)
    {
        // Create a buffer
        $buffer = new Buffer($data);

        // The first line holds the column names, data returned is in column/row format
        $columns = explode("\t", trim($buffer->readString("\n")), 16);

        // Loop through the rows until we run out of information
        while ($buffer->getLength()) {
            // Grab the row, which is a tabbed list of items
            $row = trim($buffer->readString("\n"));

            // Explode and merge the data with the columns, then parse
            $data = array_combine($columns, explode("\t", $row, 16));

            foreach ($data as $key => $value) {
                // Now add the data to the result
                $result->addPlayer($key, Str::isoToUtf8($value));
            }
        }

        unset($data, $buffer, $row, $columns, $key, $value);
    }
}


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\Helpers\Str;
24		use GameQ\Protocol;
25		use GameQ\Result;
26		use GameQ\Server;
27
28		/**
29		* Teamspeak 2 Protocol Class
30		*
31		* All values are utf8 encoded upon processing
32		*
33		* This code ported from GameQ v1/v2. Credit to original author(s) as I just updated it to
34		* work within this new system.
35		*
36		* @author Austin Bischoff <[email protected]>
37		*/
38		class Teamspeak2 extends Protocol
39		{
40		/**
41		* Array of packets we want to look up.
42		* Each key should correspond to a defined method in this or a parent class
43		*
44		* @var array
45		*/
46		protected $packets = [
47		self::PACKET_DETAILS => "sel %d\x0asi\x0a",
48		self::PACKET_CHANNELS => "sel %d\x0acl\x0a",
49		self::PACKET_PLAYERS => "sel %d\x0apl\x0a",
50		];
51
52		/**
53		* The transport mode for this protocol is TCP
54		*
55		* @var string
56		*/
57		protected $transport = self::TRANSPORT_TCP;
58
59		/**
60		* The query protocol used to make the call
61		*
62		* @var string
63		*/
64		protected $protocol = 'teamspeak2';
65
66		/**
67		* String name of this protocol class
68		*
69		* @var string
70		*/
71		protected $name = 'teamspeak2';
72
73		/**
74		* Longer string name of this protocol class
75		*
76		* @var string
77		*/
78		protected $name_long = "Teamspeak 2";
79
80		/**
81		* The client join link
82		*
83		* @var string
84		*/
85		protected $join_link = "teamspeak://%s:%d/";
86
87		/**
88		* Normalize settings for this protocol
89		*
90		* @var array
91		*/
92		protected $normalize = [
93		// General
94		'general' => [
95		'dedicated' => 'dedicated',
96		'hostname' => 'server_name',
97		'password' => 'server_password',
98		'numplayers' => 'server_currentusers',
99		'maxplayers' => 'server_maxusers',
100		],
101		// Player
102		'player' => [
103		'id' => 'p_id',
104		'team' => 'c_id',
105		'name' => 'nick',
106		],
107		// Team
108		'team' => [
109		'id' => 'id',
110		'name' => 'name',
111		],
112		];
113
114		/**
115		* Before we send off the queries we need to update the packets
116		*
117		* @param \GameQ\Server $server
118		*
119		* @throws \GameQ\Exception\Protocol
120		*/
121	24	public function beforeSend(Server $server)
122		{
123		// Check to make sure we have a query_port because it is required
124	24	if (!isset($this->options[Server::SERVER_OPTIONS_QUERY_PORT])
125	24	\|\| empty($this->options[Server::SERVER_OPTIONS_QUERY_PORT])
126		) {
127	6	throw new Exception(__METHOD__ . " Missing required setting '" . Server::SERVER_OPTIONS_QUERY_PORT . "'.");
128		}
129
130		// Let's loop the packets and set the proper pieces
131	18	foreach ($this->packets as $packet_type => $packet) {
132		// Update with the client port for the server
133	18	$this->packets[$packet_type] = sprintf($packet, $server->portClient());
134		}
135		}
136
137		/**
138		* Process the response
139		*
140		* @return array
141		* @throws \GameQ\Exception\Protocol
142		*/
143	12	public function processResponse()
144		{
145		// Make a new buffer out of all of the packets
146	12	$buffer = new Buffer(implode('', $this->packets_response));
147
148		// Check the header [TS]
149	12	if (($header = trim($buffer->readString("\n"))) !== '[TS]') {
150	6	throw new Exception(__METHOD__ . " Expected header '{$header}' does not match expected '[TS]'.");
151		}
152
153		// Split this buffer as the data blocks are bound by "OK" and drop any empty values
154	6	$sections = array_filter(explode("OK", $buffer->getBuffer()), function ($value) {
155	6	$value = trim($value);
156
157	6	return !empty($value);
158	6	});
159
160		// Trim up the values to remove extra whitespace
161	6	$sections = array_map('trim', $sections);
162
163		// Set the result to a new result instance
164	6	$result = new Result();
165
166		// Now we need to iterate over the sections and off load the processing
167	6	foreach ($sections as $section) {
168		// Grab a snip of the data so we can figure out what it is
169	6	$check = substr($section, 0, 7);
170
171		// Offload to the proper method
172	6	if ($check == 'server_') {
173		// Server settings and info
174	6	$this->processDetails($section, $result);
175	6	} elseif ($check == "id\tcode") {
176		// Channel info
177	6	$this->processChannels($section, $result);
178	6	} elseif ($check == "p_id\tc_") {
179		// Player info
180	6	$this->processPlayers($section, $result);
181		}
182		}
183
184	6	unset($buffer, $sections, $section, $check);
185
186	6	return $result->fetch();
187		}
188
189		// Internal methods
190
191
192		/**
193		* Handles processing the details data into a usable format
194		*
195		* @param string $data
196		* @param \GameQ\Result $result
197		* @return void
198		* @throws \GameQ\Exception\Protocol
199		*/
200	6	protected function processDetails($data, Result &$result)
201		{
202		// Create a buffer
203	6	$buffer = new Buffer($data);
204
205		// Always dedicated
206	6	$result->add('dedicated', 1);
207
208		// Let's loop until we run out of data
209	6	while ($buffer->getLength()) {
210		// Grab the row, which is an item
211	6	$row = trim($buffer->readString("\n"));
212
213		// Split out the information
214	6	list($key, $value) = explode('=', $row, 2);
215
216		// Add this to the result
217	6	$result->add($key, Str::isoToUtf8($value));
218		}
219
220	6	unset($data, $buffer, $row, $key, $value);
221		}
222
223		/**
224		* Process the channel listing
225		*
226		* @param string $data
227		* @param \GameQ\Result $result
228		* @return void
229		* @throws \GameQ\Exception\Protocol
230		*/
231	6	protected function processChannels($data, Result &$result)
232		{
233		// Create a buffer
234	6	$buffer = new Buffer($data);
235
236		// The first line holds the column names, data returned is in column/row format
237	6	$columns = explode("\t", trim($buffer->readString("\n")), 9);
238
239		// Loop through the rows until we run out of information
240	6	while ($buffer->getLength()) {
241		// Grab the row, which is a tabbed list of items
242	6	$row = trim($buffer->readString("\n"));
243
244		// Explode and merge the data with the columns, then parse
245	6	$data = array_combine($columns, explode("\t", $row, 9));
246
247	6	foreach ($data as $key => $value) {
248		// Now add the data to the result
249	6	$result->addTeam($key, Str::isoToUtf8($value));
250		}
251		}
252
253	6	unset($data, $buffer, $row, $columns, $key, $value);
254		}
255
256		/**
257		* Process the user listing
258		*
259		* @param string $data
260		* @param \GameQ\Result $result
261		* @return void
262		* @throws \GameQ\Exception\Protocol
263		*/
264	6	protected function processPlayers($data, Result &$result)
265		{
266		// Create a buffer
267	6	$buffer = new Buffer($data);
268
269		// The first line holds the column names, data returned is in column/row format
270	6	$columns = explode("\t", trim($buffer->readString("\n")), 16);
271
272		// Loop through the rows until we run out of information
273	6	while ($buffer->getLength()) {
274		// Grab the row, which is a tabbed list of items
275	6	$row = trim($buffer->readString("\n"));
276
277		// Explode and merge the data with the columns, then parse
278	6	$data = array_combine($columns, explode("\t", $row, 16));
279
280	6	foreach ($data as $key => $value) {
281		// Now add the data to the result
282	6	$result->addPlayer($key, Str::isoToUtf8($value));
283		}
284		}
285
286	6	unset($data, $buffer, $row, $columns, $key, $value);
287		}
288		}
289

Austinb / GameQ

Teamspeak2::processResponse() A last analyzed 2025-02-19 14:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Teamspeak2::processResponse() A
last analyzed 2025-02-19 14:42 UTC