Gta5m::processResponse() - Code Metrics - Inspection of "Modified to show the FiveM player list" - Austinb/GameQ - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — v3 (#656)

unknown

created 2022-10-16 01:36 UTC

Gta5m::processResponse() A

↳ Parent: Gta5m

Complexity

Conditions	3
Paths	2

Size

Total Lines	17
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	6
c	1
b	0
f	0
dl	0
loc	17
ccs	7
cts	7
cp	1
rs	10
cc	3
nc	2
nop	0
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\Protocols;

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

/**
 * GTA Five M Protocol Class
 *
 * Server base can be found at https://fivem.net/
 *
 * Based on code found at https://github.com/LiquidObsidian/fivereborn-query
 *
 * @author Austin Bischoff <[email protected]>
 *
 * Adding FiveM Player List by
 * @author Jesse Lukas <[email protected]>
 */
class Gta5m extends Protocol
{

    /**
     * Array of packets we want to look up.
     * Each key should correspond to a defined method in this or a parent class
     *
     * @type array
     */
    protected $packets = [
        self::PACKET_STATUS => "\xFF\xFF\xFF\xFFgetinfo xxx",
    ];

    /**
     * Use the response flag to figure out what method to run
     *
     * @type array
     */
    protected $responses = [
        "\xFF\xFF\xFF\xFFinfoResponse" => "processStatus",
    ];

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

    /**
     * String name of this protocol class
     *
     * @type string
     */
    protected $name = 'gta5m';

    /**
     * Longer string name of this protocol class
     *
     * @type string
     */
    protected $name_long = "GTA Five M";

    /**
     * Holds the Player List so we can overwrite it back
     *
     * @var string
     */
    protected $PlayerList = [];

    /**
     * Normalize settings for this protocol
     *
     * @type array
     */
    protected $normalize = [
        // General
        'general' => [
            // target       => source
            'gametype'   => 'gametype',
            'hostname'   => 'hostname',
            'mapname'    => 'mapname',
            'maxplayers' => 'sv_maxclients',
            'mod'        => 'gamename',
            'numplayers' => 'clients',
            'password'   => 'privateClients',
        ],
    ];

    /**
     * Get FiveM Players List
     */
    public function beforeSend(Server $server)
    {
        $connection = sprintf('http://%s:%s/players.json', $server->ip, $server->port_query);
        $this->PlayerList = (@file_get_contents(sprintf('%s', $connection)))?@file_get_contents(sprintf('%s', $connection)):[];
    }

    /**
     * Process the response
     *
     * @return array
     * @throws \GameQ\Exception\Protocol
     */
    public function processResponse()
    {
        // In case it comes back as multiple packets (it shouldn't)
        $buffer = new Buffer(implode('', $this->packets_response));

        // Figure out what packet response this is for
        $response_type = $buffer->readString(PHP_EOL);

        // Figure out which packet response this is
        if (empty($response_type) || !array_key_exists($response_type, $this->responses)) {
            throw new Exception(__METHOD__ . " response type '{$response_type}' is not valid");
        }

        // Offload the call
        $results = call_user_func_array([$this, $this->responses[$response_type]], [$buffer]);

        return $results;
    }

    /*
     * Internal methods
     */

    /**
     * Handle processing the status response
     *
     * @param Buffer $buffer
     *
     * @return array
     */
    protected function processStatus(Buffer $buffer)
    {
        // Set the result to a new result instance
        $result = new Result();

        // Lets peek and see if the data starts with a \
        if ($buffer->lookAhead(1) == '\\') {
            // Burn the first one
            $buffer->skip(1);
        }

        // Explode the data
        $data = explode('\\', $buffer->getBuffer());

        // No longer needed
        unset($buffer);

        $itemCount = count($data);

        // Now lets loop the array
        for ($x = 0; $x < $itemCount; $x += 2) {
            // Set some local vars
            $key = $data[$x];
            $val = $data[$x + 1];

            if (in_array($key, ['challenge'])) {
                continue; // skip
            }

            // Regular variable so just add the value.
            $result->add($key, $val);
        }

        if ($this->PlayerList) {
            $players = [];
            $data = json_decode($this->PlayerList);
            foreach ($data as $player) {
                $players[] = array("id"=>$player->id,"name"=>$player->name,"ping"=>$player->ping,"identifiers"=>$player->identifiers);
            }
            $result->add('players', $players);
        }

        return $result->fetch();
    }
}


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		* GTA Five M Protocol Class
29		*
30		* Server base can be found at https://fivem.net/
31		*
32		* Based on code found at https://github.com/LiquidObsidian/fivereborn-query
33		*
34		* @author Austin Bischoff <[email protected]>
35		*
36		* Adding FiveM Player List by
37		* @author Jesse Lukas <[email protected]>
38		*/
39		class Gta5m extends Protocol
40		{
41
42		/**
43		* Array of packets we want to look up.
44		* Each key should correspond to a defined method in this or a parent class
45		*
46		* @type array
47		*/
48		protected $packets = [
49		self::PACKET_STATUS => "\xFF\xFF\xFF\xFFgetinfo xxx",
50		];
51
52		/**
53		* Use the response flag to figure out what method to run
54		*
55		* @type array
56		*/
57		protected $responses = [
58		"\xFF\xFF\xFF\xFFinfoResponse" => "processStatus",
59		];
60
61		/**
62		* The query protocol used to make the call
63		*
64		* @type string
65		*/
66		protected $protocol = 'gta5m';
67
68		/**
69		* String name of this protocol class
70		*
71		* @type string
72		*/
73		protected $name = 'gta5m';
74
75		/**
76		* Longer string name of this protocol class
77		*
78		* @type string
79		*/
80		protected $name_long = "GTA Five M";
81
82		/**
83		* Holds the Player List so we can overwrite it back
84		*
85		* @var string
86		*/
87		protected $PlayerList = [];
88
89		/**
90		* Normalize settings for this protocol
91		*
92		* @type array
93		*/
94		protected $normalize = [
95		// General
96		'general' => [
97		// target => source
98		'gametype' => 'gametype',
99		'hostname' => 'hostname',
100		'mapname' => 'mapname',
101		'maxplayers' => 'sv_maxclients',
102		'mod' => 'gamename',
103		'numplayers' => 'clients',
104		'password' => 'privateClients',
105		],
106		];
107
108		/**
109		* Get FiveM Players List
110		*/
111	30	public function beforeSend(Server $server)
112		{
113	30	$connection = sprintf('http://%s:%s/players.json', $server->ip, $server->port_query);
114	30	$this->PlayerList = (@file_get_contents(sprintf('%s', $connection)))?@file_get_contents(sprintf('%s', $connection)):[];
115	5	}
116
117		/**
118		* Process the response
119		*
120		* @return array
121		* @throws \GameQ\Exception\Protocol
122		*/
123	30	public function processResponse()
124		{
125		// In case it comes back as multiple packets (it shouldn't)
126	30	$buffer = new Buffer(implode('', $this->packets_response));
127
128		// Figure out what packet response this is for
129	30	$response_type = $buffer->readString(PHP_EOL);
130
131		// Figure out which packet response this is
132	30	if (empty($response_type) \|\| !array_key_exists($response_type, $this->responses)) {
133	12	throw new Exception(__METHOD__ . " response type '{$response_type}' is not valid");
134		}
135
136		// Offload the call
137	18	$results = call_user_func_array([$this, $this->responses[$response_type]], [$buffer]);
138
139	18	return $results;
140		}
141
142		/*
143		* Internal methods
144		*/
145
146		/**
147		* Handle processing the status response
148		*
149		* @param Buffer $buffer
150		*
151		* @return array
152		*/
153	18	protected function processStatus(Buffer $buffer)
154		{
155		// Set the result to a new result instance
156	18	$result = new Result();
157
158		// Lets peek and see if the data starts with a \
159	18	if ($buffer->lookAhead(1) == '\\') {
160		// Burn the first one
161	18	$buffer->skip(1);
162		}
163
164		// Explode the data
165	18	$data = explode('\\', $buffer->getBuffer());
166
167		// No longer needed
168	18	unset($buffer);
169
170	18	$itemCount = count($data);
171
172		// Now lets loop the array
173	18	for ($x = 0; $x < $itemCount; $x += 2) {
174		// Set some local vars
175	18	$key = $data[$x];
176	18	$val = $data[$x + 1];
177
178	18	if (in_array($key, ['challenge'])) {
179	18	continue; // skip
180		}
181
182		// Regular variable so just add the value.
183	18	$result->add($key, $val);
184		}
185
186	18	if ($this->PlayerList) {
187		$players = [];
188		$data = json_decode($this->PlayerList);
189		foreach ($data as $player) {
190		$players[] = array("id"=>$player->id,"name"=>$player->name,"ping"=>$player->ping,"identifiers"=>$player->identifiers);
191		}
192		$result->add('players', $players);
193		}
194
195	18	return $result->fetch();
196		}
197		}
198

Austinb / GameQ

Pull Request — v3 (#656)

Gta5m::processResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like