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

GameQ::doApplyFilters() A
last analyzed 2025-02-19 14:42 UTC

↳ Parent: GameQ

Complexity

Conditions	3
Paths	5

Size

Total Lines	21
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	3

Importance

Changes

Metric	Value
eloc	8
c	0
b	0
f	0
dl	0
loc	21
ccs	8
cts	8
cp	1
rs	10
cc	3
nc	5
nop	2
crap	3

<?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;

use GameQ\Exception\Protocol as ProtocolException;
use GameQ\Exception\Query as QueryException;

/**
 * Base GameQ Class
 *
 * This class should be the only one that is included when you use GameQ to query
 * any games servers.
 *
 * Requirements: See wiki or README for more information on the requirements
 *  - PHP 5.4.14+
 *    * Bzip2 - http://www.php.net/manual/en/book.bzip2.php
 *
 * @author Austin Bischoff <[email protected]>
 *
 * @property bool   $debug
 * @property string $capture_packets_file
 * @property int    $stream_timeout
 * @property int    $timeout
 * @property int    $write_wait
 */
class GameQ
{
    // Constants
    const PROTOCOLS_DIRECTORY = __DIR__ . '/Protocols';

    // Static Section

    /**
     * Holds the instance of itself
     *
     * @var self
     */
    protected static $instance = null;

    /**
     * Create a new instance of this class
     *
     * @return \GameQ\GameQ
     */
    public static function factory()
    {
        // Create a new instance
        self::$instance = new self();

        // Return this new instance
        return self::$instance;
    }

    // Dynamic Section

    /**
     * Default options
     *
     * @var array
     */
    protected $options = [
        'debug'                => false,
        'timeout'              => 3, // Seconds
        'filters'              => [
            // Default normalize
            'normalize_d751713988987e9331980363e24189ce' => [
                'filter'  => 'normalize',
                'options' => [],
            ],
        ],
        // Advanced settings
        'stream_timeout'       => 200000, // See http://www.php.net/manual/en/function.stream-select.php for more info
        'write_wait'           => 500,
        // How long (in micro-seconds) to pause between writing to server sockets, helps cpu usage

        // Used for generating protocol test data
        'capture_packets_file' => null,
    ];

    /**
     * Array of servers being queried
     *
     * @var array
     */
    protected $servers = [];

    /**
     * The query library to use.  Default is Native
     *
     * @var string
     */
    protected $queryLibrary = 'GameQ\\Query\\Native';

    /**
     * Holds the instance of the queryLibrary
     *
     * @var \GameQ\Query\Core|null
     */
    protected $query = null;

    /**
     * Get an option's value
     *
     * @param mixed $option
     *
     * @return mixed|null
     */
    public function __get($option)
    {
        return isset($this->options[$option]) ? $this->options[$option] : null;
    }

    /**
     * Set an option's value
     *
     * @param mixed $option
     * @param mixed $value
     *
     * @return bool
     */
    public function __set($option, $value)
    {
        $this->options[$option] = $value;

        return true;
    }

    public function getServers()
    {
        return $this->servers;
    }

    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Chainable call to __set, uses set as the actual setter
     *
     * @param mixed $var
     * @param mixed $value
     *
     * @return $this
     */
    public function setOption($var, $value)
    {
        // Use magic
        $this->{$var} = $value;

        return $this; // Make chainable
    }

    /**
     * Add a single server
     *
     * @param array $server_info
     *
     * @return $this
     */
    public function addServer(array $server_info = [])
    {
        // Add and validate the server
        $this->servers[uniqid()] = new Server($server_info);

        return $this; // Make calls chainable
    }

    /**
     * Add multiple servers in a single call
     *
     * @param array $servers
     *
     * @return $this
     */
    public function addServers(array $servers = [])
    {
        // Loop through all the servers and add them
        foreach ($servers as $server_info) {
            $this->addServer($server_info);
        }

        return $this; // Make calls chainable
    }

    /**
     * Add a set of servers from a file or an array of files.
     * Supported formats:
     * JSON
     *
     * @param array $files
     *
     * @return $this
     * @throws \Exception
     */
    public function addServersFromFiles($files = [])
    {
        // Since we expect an array let us turn a string (i.e. single file) into an array
        if (!is_array($files)) {

            $files = [$files];
        }

        // Iterate over the file(s) and add them
        foreach ($files as $file) {
            // Check to make sure the file exists and we can read it
            if (!file_exists($file) || !is_readable($file)) {
                continue;
            }

            // See if this file is JSON
            if (($servers = json_decode(file_get_contents($file), true)) === null
                && json_last_error() !== JSON_ERROR_NONE
            ) {
                // Type not supported
                continue;
            }

            // Add this list of servers
            $this->addServers($servers);
        }

        return $this;
    }

    /**
     * Clear all of the defined servers
     *
     * @return $this
     */
    public function clearServers()
    {
        // Reset all the servers
        $this->servers = [];

        return $this; // Make Chainable
    }

    /**
     * Add a filter to the processing list
     *
     * @param string $filterName
     * @param array  $options
     *
     * @return $this
     */
    public function addFilter($filterName, $options = [])
    {
        // Create the filter hash so we can run multiple versions of the same filter
        $filterHash = sprintf('%s_%s', strtolower($filterName), md5(json_encode($options)));

        // Add the filter
        $this->options['filters'][$filterHash] = [
            'filter'  => strtolower($filterName),
            'options' => $options,
        ];

        unset($filterHash);

        return $this;
    }

    /**
     * Remove an added filter
     *
     * @param string $filterHash
     *
     * @return $this
     */
    public function removeFilter($filterHash)
    {
        // Make lower case
        $filterHash = strtolower($filterHash);

        // Remove this filter if it has been defined
        if (array_key_exists($filterHash, $this->options['filters'])) {
            unset($this->options['filters'][$filterHash]);
        }

        unset($filterHash);

        return $this;
    }

    /**
     * Return the list of applied filters
     *
     * @return array
     */
    public function listFilters()
    {
        return $this->options['filters'];
    }

    /**
     * Main method used to actually process all of the added servers and return the information
     *
     * @return array
     * @throws \Exception
     */
    public function process()
    {
        // Initialize the query library we are using
        $class = new \ReflectionClass($this->queryLibrary);

        // Set the query pointer to the new instance of the library
        $this->query = $class->newInstance();

        unset($class);

        // Define the return
        $results = [];

        // @todo: Add break up into loop to split large arrays into smaller chunks

        // Do server challenge(s) first, if any
        $this->doChallenges();

        // Do packets for server(s) and get query responses
        $this->doQueries();

        // Now we should have some information to process for each server
        foreach ($this->servers as $server) {
            // @var $server \GameQ\Server

            // Parse the responses for this server
            $result = $this->doParseResponse($server);

            // Apply the filters
            $result = array_merge($result, $this->doApplyFilters($result, $server));

            // Sort the keys so they are alphabetical and nicer to look at
            ksort($result);

            // Add the result to the results array
            $results[$server->id()] = $result;
        }

        return $results;
    }

    /**
     * Do server challenges, where required
     */
    protected function doChallenges()
    {
        // Initialize the sockets for reading
        $sockets = [];

        // By default we don't have any challenges to process
        $server_challenge = false;

        // Do challenge packets
        foreach ($this->servers as $server_id => $server) {
            // @var $server \GameQ\Server

            // This protocol has a challenge packet that needs to be sent
            if ($server->protocol()->hasChallenge()) {
                // We have a challenge, set the flag
                $server_challenge = true;

                // Let's make a clone of the query class
                $socket = clone $this->query;

                // Set the information for this query socket
                $socket->set(
                    $server->protocol()->transport(),
                    $server->ip,
                    $server->port_query,
                    $this->timeout
                );

                try {
                    // Now write the challenge packet to the socket.
                    $socket->write($server->protocol()->getPacket(Protocol::PACKET_CHALLENGE));

                    // Add the socket information so we can reference it easily
                    $sockets[(int)$socket->get()] = [
                        'server_id' => $server_id,
                        'socket'    => $socket,
                    ];
                } catch (QueryException $exception) {
                    // Check to see if we are in debug, if so bubble up the exception
                    if ($this->debug) {
                        throw new \Exception($exception->getMessage(), $exception->getCode(), $exception);
                    }
                }

                unset($socket);

                // Let's sleep shortly so we are not hammering out calls rapid fire style hogging cpu
                usleep($this->write_wait);
            }
        }

        // We have at least one server with a challenge, we need to listen for responses
        if ($server_challenge) {
            // Now we need to listen for and grab challenge response(s)
            $responses = call_user_func_array(
                [$this->query, 'getResponses'],
                [$sockets, $this->timeout, $this->stream_timeout]
            );

            // Iterate over the challenge responses
            foreach ($responses as $socket_id => $response) {
                // Back out the server_id we need to update the challenge response for
                $server_id = $sockets[$socket_id]['server_id'];

                // Make this into a buffer so it is easier to manipulate
                $challenge = new Buffer(implode('', $response));

                // Grab the server instance
                // @var $server \GameQ\Server
                $server = $this->servers[$server_id];

                // Apply the challenge
                $server->protocol()->challengeParseAndApply($challenge);

                // Add this socket to be reused, has to be reused in GameSpy3 for example
                $server->socketAdd($sockets[$socket_id]['socket']);

                // Clear
                unset($server);
            }
        }
    }

    /**
     * Run the actual queries and get the response(s)
     */
    protected function doQueries()
    {
        // Initialize the array of sockets
        $sockets = [];

        // Iterate over the server list
        foreach ($this->servers as $server_id => $server) {
            // @var $server \GameQ\Server

            // Invoke the beforeSend method
            $server->protocol()->beforeSend($server);

            // Get all the non-challenge packets we need to send
            $packets = $server->protocol()->getPacket('!' . Protocol::PACKET_CHALLENGE);

            if (count($packets) == 0) {
                // Skip nothing else to do for some reason.
                continue;
            }

            // Try to use an existing socket
            if (($socket = $server->socketGet()) === null) {
                // Let's make a clone of the query class
                $socket = clone $this->query;

                // Set the information for this query socket
                $socket->set(
                    $server->protocol()->transport(),
                    $server->ip,
                    $server->port_query,
                    $this->timeout
                );
            }

            try {
                // Iterate over all the packets we need to send
                foreach ($packets as $packet_data) {
                    // Now write the packet to the socket.
                    $socket->write($packet_data);

                    // Let's sleep shortly so we are not hammering out calls rapid fire style
                    usleep($this->write_wait);
                }

                unset($packets);

                // Add the socket information so we can reference it easily
                $sockets[(int)$socket->get()] = [
                    'server_id' => $server_id,
                    'socket'    => $socket,
                ];
            } catch (QueryException $exception) {
                // Check to see if we are in debug, if so bubble up the exception
                if ($this->debug) {
                    throw new \Exception($exception->getMessage(), $exception->getCode(), $exception);
                }

                continue;
            }

            // Clean up the sockets, if any left over
            $server->socketCleanse();
        }

        // Now we need to listen for and grab response(s)
        $responses = call_user_func_array(
            [$this->query, 'getResponses'],
            [$sockets, $this->timeout, $this->stream_timeout]
        );

        // Iterate over the responses
        foreach ($responses as $socket_id => $response) {
            // Back out the server_id
            $server_id = $sockets[$socket_id]['server_id'];

            // Grab the server instance
            // @var $server \GameQ\Server
            $server = $this->servers[$server_id];

            // Save the response from this packet
            $server->protocol()->packetResponse($response);

            unset($server);
        }

        // Now we need to close all of the sockets
        foreach ($sockets as $socketInfo) {
            // @var $socket \GameQ\Query\Core
            $socket = $socketInfo['socket'];

            // Close the socket
            $socket->close();

            unset($socket);
        }

        unset($sockets);
    }

    /**
     * Parse the response for a specific server
     *
     * @param \GameQ\Server $server
     *
     * @return array
     * @throws \Exception
     */
    protected function doParseResponse(Server $server)
    {
        try {
            // @codeCoverageIgnoreStart
            // We want to save this server's response to a file (useful for unit testing)
            if (!is_null($this->capture_packets_file)) {

                file_put_contents(
                    $this->capture_packets_file,
                    implode(PHP_EOL . '||' . PHP_EOL, $server->protocol()->packetResponse())
                );
            }
            // @codeCoverageIgnoreEnd

            // Get the server response
            $results = $server->protocol()->processResponse();

            // Check for online before we do anything else
            $results['gq_online'] = (count($results) > 0);
        } catch (ProtocolException $e) {
            // Check to see if we are in debug, if so bubble up the exception
            if ($this->debug) {
                throw new \Exception($e->getMessage(), $e->getCode(), $e);
            }

            // We ignore this server
            $results = [
                'gq_online' => false,
            ];
        }

        // Now add some default stuff
        $results['gq_address'] = (isset($results['gq_address'])) ? $results['gq_address'] : $server->ip();
        $results['gq_port_client'] = $server->portClient();
        $results['gq_port_query'] = (isset($results['gq_port_query'])) ? $results['gq_port_query'] : $server->portQuery();
        $results['gq_protocol'] = $server->protocol()->getProtocol();
        $results['gq_type'] = (string)$server->protocol();
        $results['gq_name'] = $server->protocol()->nameLong();
        $results['gq_transport'] = $server->protocol()->transport();

        // Process the join link
        if (!isset($results['gq_joinlink']) || empty($results['gq_joinlink'])) {
            $results['gq_joinlink'] = $server->getJoinLink();
        }

        return $results;
    }

    /**
     * Apply any filters to the results
     *
     * @param array         $results
     * @param \GameQ\Server $server
     *
     * @return array
     */
    protected function doApplyFilters(array $results, Server $server)
    {
        // Loop over the filters
        foreach ($this->options['filters'] as $filterOptions) {
            // Try to do this filter
            try {
                // Make a new reflection class
                $class = new \ReflectionClass(sprintf('GameQ\\Filters\\%s', ucfirst($filterOptions['filter'])));

                // Create a new instance of the filter class specified
                $filter = $class->newInstanceArgs([$filterOptions['options']]);

                // Apply the filter to the data
                $results = $filter->apply($results, $server);
            } catch (\ReflectionException $exception) {
                // Invalid, skip it
                continue;
            }
        }

        return $results;
    }
}


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;
20
21		use GameQ\Exception\Protocol as ProtocolException;
22		use GameQ\Exception\Query as QueryException;
23
24		/**
25		* Base GameQ Class
26		*
27		* This class should be the only one that is included when you use GameQ to query
28		* any games servers.
29		*
30		* Requirements: See wiki or README for more information on the requirements
31		* - PHP 5.4.14+
32		* * Bzip2 - http://www.php.net/manual/en/book.bzip2.php
33		*
34		* @author Austin Bischoff <[email protected]>
35		*
36		* @property bool $debug
37		* @property string $capture_packets_file
38		* @property int $stream_timeout
39		* @property int $timeout
40		* @property int $write_wait
41		*/
42		class GameQ
43		{
44		// Constants
45		const PROTOCOLS_DIRECTORY = __DIR__ . '/Protocols';
46
47		// Static Section
48
49		/**
50		* Holds the instance of itself
51		*
52		* @var self
53		*/
54		protected static $instance = null;
55
56		/**
57		* Create a new instance of this class
58		*
59		* @return \GameQ\GameQ
60		*/
61	6	public static function factory()
62		{
63		// Create a new instance
64	6	self::$instance = new self();
65
66		// Return this new instance
67	6	return self::$instance;
68		}
69
70		// Dynamic Section
71
72		/**
73		* Default options
74		*
75		* @var array
76		*/
77		protected $options = [
78		'debug' => false,
79		'timeout' => 3, // Seconds
80		'filters' => [
81		// Default normalize
82		'normalize_d751713988987e9331980363e24189ce' => [
83		'filter' => 'normalize',
84		'options' => [],
85		],
86		],
87		// Advanced settings
88		'stream_timeout' => 200000, // See http://www.php.net/manual/en/function.stream-select.php for more info
89		'write_wait' => 500,
90		// How long (in micro-seconds) to pause between writing to server sockets, helps cpu usage
91
92		// Used for generating protocol test data
93		'capture_packets_file' => null,
94		];
95
96		/**
97		* Array of servers being queried
98		*
99		* @var array
100		*/
101		protected $servers = [];
102
103		/**
104		* The query library to use. Default is Native
105		*
106		* @var string
107		*/
108		protected $queryLibrary = 'GameQ\\Query\\Native';
109
110		/**
111		* Holds the instance of the queryLibrary
112		*
113		* @var \GameQ\Query\Core\|null
114		*/
115		protected $query = null;
116
117		/**
118		* Get an option's value
119		*
120		* @param mixed $option
121		*
122		* @return mixed\|null
123		*/
124	1914	public function __get($option)
125		{
126	1914	return isset($this->options[$option]) ? $this->options[$option] : null;
127		}
128
129		/**
130		* Set an option's value
131		*
132		* @param mixed $option
133		* @param mixed $value
134		*
135		* @return bool
136		*/
137	1926	public function __set($option, $value)
138		{
139	1926	$this->options[$option] = $value;
140
141	1926	return true;
142		}
143
144	18	public function getServers()
145		{
146	18	return $this->servers;
147		}
148
149		public function getOptions()
150		{
151		return $this->options;
152		}
153
154		/**
155		* Chainable call to __set, uses set as the actual setter
156		*
157		* @param mixed $var
158		* @param mixed $value
159		*
160		* @return $this
161		*/
162	1926	public function setOption($var, $value)
163		{
164		// Use magic
165	1926	$this->{$var} = $value;
166
167	1926	return $this; // Make chainable
168		}
169
170		/**
171		* Add a single server
172		*
173		* @param array $server_info
174		*
175		* @return $this
176		*/
177	48	public function addServer(array $server_info = [])
178		{
179		// Add and validate the server
180	48	$this->servers[uniqid()] = new Server($server_info);
181
182	48	return $this; // Make calls chainable
183		}
184
185		/**
186		* Add multiple servers in a single call
187		*
188		* @param array $servers
189		*
190		* @return $this
191		*/
192	12	public function addServers(array $servers = [])
193		{
194		// Loop through all the servers and add them
195	12	foreach ($servers as $server_info) {
196	12	$this->addServer($server_info);
197		}
198
199	12	return $this; // Make calls chainable
200		}
201
202		/**
203		* Add a set of servers from a file or an array of files.
204		* Supported formats:
205		* JSON
206		*
207		* @param array $files
208		*
209		* @return $this
210		* @throws \Exception
211		*/
212	6	public function addServersFromFiles($files = [])
213		{
214		// Since we expect an array let us turn a string (i.e. single file) into an array
215	6	if (!is_array($files)) {
		0 ignored issues – show introduced 2019-12-08 03:49 UTC by Report Bug Copy Issue Report The condition `is_array($files)` is always `true`. Loading history...
216	6	$files = [$files];
217		}
218
219		// Iterate over the file(s) and add them
220	6	foreach ($files as $file) {
221		// Check to make sure the file exists and we can read it
222	6	if (!file_exists($file) \|\| !is_readable($file)) {
223	6	continue;
224		}
225
226		// See if this file is JSON
227	6	if (($servers = json_decode(file_get_contents($file), true)) === null
228	6	&& json_last_error() !== JSON_ERROR_NONE
229		) {
230		// Type not supported
231	6	continue;
232		}
233
234		// Add this list of servers
235	6	$this->addServers($servers);
236		}
237
238	6	return $this;
239		}
240
241		/**
242		* Clear all of the defined servers
243		*
244		* @return $this
245		*/
246	12	public function clearServers()
247		{
248		// Reset all the servers
249	12	$this->servers = [];
250
251	12	return $this; // Make Chainable
252		}
253
254		/**
255		* Add a filter to the processing list
256		*
257		* @param string $filterName
258		* @param array $options
259		*
260		* @return $this
261		*/
262	18	public function addFilter($filterName, $options = [])
263		{
264		// Create the filter hash so we can run multiple versions of the same filter
265	18	$filterHash = sprintf('%s_%s', strtolower($filterName), md5(json_encode($options)));
266
267		// Add the filter
268	18	$this->options['filters'][$filterHash] = [
269	18	'filter' => strtolower($filterName),
270	18	'options' => $options,
271	18	];
272
273	18	unset($filterHash);
274
275	18	return $this;
276		}
277
278		/**
279		* Remove an added filter
280		*
281		* @param string $filterHash
282		*
283		* @return $this
284		*/
285	1926	public function removeFilter($filterHash)
286		{
287		// Make lower case
288	1926	$filterHash = strtolower($filterHash);
289
290		// Remove this filter if it has been defined
291	1926	if (array_key_exists($filterHash, $this->options['filters'])) {
292	18	unset($this->options['filters'][$filterHash]);
293		}
294
295	1926	unset($filterHash);
296
297	1926	return $this;
298		}
299
300		/**
301		* Return the list of applied filters
302		*
303		* @return array
304		*/
305	6	public function listFilters()
306		{
307	6	return $this->options['filters'];
308		}
309
310		/**
311		* Main method used to actually process all of the added servers and return the information
312		*
313		* @return array
314		* @throws \Exception
315		*/
316	30	public function process()
317		{
318		// Initialize the query library we are using
319	30	$class = new \ReflectionClass($this->queryLibrary);
320
321		// Set the query pointer to the new instance of the library
322	30	$this->query = $class->newInstance();
323
324	30	unset($class);
325
326		// Define the return
327	30	$results = [];
328
329		// @todo: Add break up into loop to split large arrays into smaller chunks
330
331		// Do server challenge(s) first, if any
332	30	$this->doChallenges();
333
334		// Do packets for server(s) and get query responses
335	30	$this->doQueries();
336
337		// Now we should have some information to process for each server
338	30	foreach ($this->servers as $server) {
339		// @var $server \GameQ\Server
340
341		// Parse the responses for this server
342	30	$result = $this->doParseResponse($server);
343
344		// Apply the filters
345	30	$result = array_merge($result, $this->doApplyFilters($result, $server));
346
347		// Sort the keys so they are alphabetical and nicer to look at
348	30	ksort($result);
349
350		// Add the result to the results array
351	30	$results[$server->id()] = $result;
352		}
353
354	30	return $results;
355		}
356
357		/**
358		* Do server challenges, where required
359		*/
360	30	protected function doChallenges()
361		{
362		// Initialize the sockets for reading
363	30	$sockets = [];
364
365		// By default we don't have any challenges to process
366	30	$server_challenge = false;
367
368		// Do challenge packets
369	30	foreach ($this->servers as $server_id => $server) {
370		// @var $server \GameQ\Server
371
372		// This protocol has a challenge packet that needs to be sent
373	30	if ($server->protocol()->hasChallenge()) {
374		// We have a challenge, set the flag
375		$server_challenge = true;
376
377		// Let's make a clone of the query class
378		$socket = clone $this->query;
379
380		// Set the information for this query socket
381		$socket->set(
382		$server->protocol()->transport(),
383		$server->ip,
384		$server->port_query,
385		$this->timeout
386		);
387
388		try {
389		// Now write the challenge packet to the socket.
390		$socket->write($server->protocol()->getPacket(Protocol::PACKET_CHALLENGE));
391
392		// Add the socket information so we can reference it easily
393		$sockets[(int)$socket->get()] = [
394		'server_id' => $server_id,
395		'socket' => $socket,
396		];
397		} catch (QueryException $exception) {
398		// Check to see if we are in debug, if so bubble up the exception
399		if ($this->debug) {
400		throw new \Exception($exception->getMessage(), $exception->getCode(), $exception);
401		}
402		}
403
404		unset($socket);
405
406		// Let's sleep shortly so we are not hammering out calls rapid fire style hogging cpu
407		usleep($this->write_wait);
408		}
409		}
410
411		// We have at least one server with a challenge, we need to listen for responses
412	30	if ($server_challenge) {
413		// Now we need to listen for and grab challenge response(s)
414		$responses = call_user_func_array(
415		[$this->query, 'getResponses'],
416		[$sockets, $this->timeout, $this->stream_timeout]
417		);
418
419		// Iterate over the challenge responses
420		foreach ($responses as $socket_id => $response) {
421		// Back out the server_id we need to update the challenge response for
422		$server_id = $sockets[$socket_id]['server_id'];
423
424		// Make this into a buffer so it is easier to manipulate
425		$challenge = new Buffer(implode('', $response));
426
427		// Grab the server instance
428		// @var $server \GameQ\Server
429		$server = $this->servers[$server_id];
430
431		// Apply the challenge
432		$server->protocol()->challengeParseAndApply($challenge);
433
434		// Add this socket to be reused, has to be reused in GameSpy3 for example
435		$server->socketAdd($sockets[$socket_id]['socket']);
436
437		// Clear
438		unset($server);
439		}
440		}
441		}
442
443		/**
444		* Run the actual queries and get the response(s)
445		*/
446	30	protected function doQueries()
447		{
448		// Initialize the array of sockets
449	30	$sockets = [];
450
451		// Iterate over the server list
452	30	foreach ($this->servers as $server_id => $server) {
453		// @var $server \GameQ\Server
454
455		// Invoke the beforeSend method
456	30	$server->protocol()->beforeSend($server);
457
458		// Get all the non-challenge packets we need to send
459	30	$packets = $server->protocol()->getPacket('!' . Protocol::PACKET_CHALLENGE);
460
461	30	if (count($packets) == 0) {
462		// Skip nothing else to do for some reason.
463		continue;
464		}
465
466		// Try to use an existing socket
467	30	if (($socket = $server->socketGet()) === null) {
468		// Let's make a clone of the query class
469	30	$socket = clone $this->query;
470
471		// Set the information for this query socket
472	30	$socket->set(
473	30	$server->protocol()->transport(),
474	30	$server->ip,
475	30	$server->port_query,
476	30	$this->timeout
477	30	);
478		}
479
480		try {
481		// Iterate over all the packets we need to send
482	30	foreach ($packets as $packet_data) {
483		// Now write the packet to the socket.
484	30	$socket->write($packet_data);
485
486		// Let's sleep shortly so we are not hammering out calls rapid fire style
487		usleep($this->write_wait);
488		}
489
490		unset($packets);
491
492		// Add the socket information so we can reference it easily
493		$sockets[(int)$socket->get()] = [
494		'server_id' => $server_id,
495		'socket' => $socket,
496		];
497	30	} catch (QueryException $exception) {
498		// Check to see if we are in debug, if so bubble up the exception
499	30	if ($this->debug) {
500		throw new \Exception($exception->getMessage(), $exception->getCode(), $exception);
501		}
502
503	30	continue;
504		}
505
506		// Clean up the sockets, if any left over
507		$server->socketCleanse();
508		}
509
510		// Now we need to listen for and grab response(s)
511	30	$responses = call_user_func_array(
512	30	[$this->query, 'getResponses'],
513	30	[$sockets, $this->timeout, $this->stream_timeout]
514	30	);
515
516		// Iterate over the responses
517	30	foreach ($responses as $socket_id => $response) {
518		// Back out the server_id
519		$server_id = $sockets[$socket_id]['server_id'];
520
521		// Grab the server instance
522		// @var $server \GameQ\Server
523		$server = $this->servers[$server_id];
524
525		// Save the response from this packet
526		$server->protocol()->packetResponse($response);
527
528		unset($server);
529		}
530
531		// Now we need to close all of the sockets
532	30	foreach ($sockets as $socketInfo) {
533		// @var $socket \GameQ\Query\Core
534		$socket = $socketInfo['socket'];
535
536		// Close the socket
537		$socket->close();
538
539		unset($socket);
540		}
541
542	30	unset($sockets);
543		}
544
545		/**
546		* Parse the response for a specific server
547		*
548		* @param \GameQ\Server $server
549		*
550		* @return array
551		* @throws \Exception
552		*/
553	1908	protected function doParseResponse(Server $server)
554		{
555		try {
556		// @codeCoverageIgnoreStart
557		// We want to save this server's response to a file (useful for unit testing)
558		if (!is_null($this->capture_packets_file)) {
		0 ignored issues – show introduced 2019-12-08 03:49 UTC by Report Bug Copy Issue Report The condition `is_null($this->capture_packets_file)` is always `false`. Loading history...
559		file_put_contents(
560		$this->capture_packets_file,
561		implode(PHP_EOL . '\|\|' . PHP_EOL, $server->protocol()->packetResponse())
562		);
563		}
564		// @codeCoverageIgnoreEnd
565
566		// Get the server response
567	1908	$results = $server->protocol()->processResponse();
568
569		// Check for online before we do anything else
570	1656	$results['gq_online'] = (count($results) > 0);
571	264	} catch (ProtocolException $e) {
572		// Check to see if we are in debug, if so bubble up the exception
573	264	if ($this->debug) {
574	144	throw new \Exception($e->getMessage(), $e->getCode(), $e);
575		}
576
577		// We ignore this server
578	120	$results = [
579	120	'gq_online' => false,
580	120	];
581		}
582
583		// Now add some default stuff
584	1770	$results['gq_address'] = (isset($results['gq_address'])) ? $results['gq_address'] : $server->ip();
585	1770	$results['gq_port_client'] = $server->portClient();
586	1770	$results['gq_port_query'] = (isset($results['gq_port_query'])) ? $results['gq_port_query'] : $server->portQuery();
587	1770	$results['gq_protocol'] = $server->protocol()->getProtocol();
588	1770	$results['gq_type'] = (string)$server->protocol();
589	1770	$results['gq_name'] = $server->protocol()->nameLong();
590	1770	$results['gq_transport'] = $server->protocol()->transport();
591
592		// Process the join link
593	1770	if (!isset($results['gq_joinlink']) \|\| empty($results['gq_joinlink'])) {
594	1770	$results['gq_joinlink'] = $server->getJoinLink();
595		}
596
597	1770	return $results;
598		}
599
600		/**
601		* Apply any filters to the results
602		*
603		* @param array $results
604		* @param \GameQ\Server $server
605		*
606		* @return array
607		*/
608	42	protected function doApplyFilters(array $results, Server $server)
609		{
610		// Loop over the filters
611	42	foreach ($this->options['filters'] as $filterOptions) {
612		// Try to do this filter
613		try {
614		// Make a new reflection class
615	42	$class = new \ReflectionClass(sprintf('GameQ\\Filters\\%s', ucfirst($filterOptions['filter'])));
616
617		// Create a new instance of the filter class specified
618	36	$filter = $class->newInstanceArgs([$filterOptions['options']]);
619
620		// Apply the filter to the data
621	36	$results = $filter->apply($results, $server);
622	6	} catch (\ReflectionException $exception) {
623		// Invalid, skip it
624	6	continue;
625		}
626		}
627
628	42	return $results;
629		}
630		}
631

Austinb / GameQ

GameQ::doApplyFilters() A last analyzed 2025-02-19 14:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GameQ::doApplyFilters() A
last analyzed 2025-02-19 14:42 UTC