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

Passed

Push — v3 ( efc739...bb78f7 )

by Austin

created 2023-03-03 03:26 UTC

Cfx::processStatus() A

↳ Parent: Cfx

Complexity

Conditions	5
Paths	12

Size

Total Lines	39
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	5.0061

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	15
c	1
b	0
f	0
dl	0
loc	39
ccs	15
cts	16
cp	0.9375
rs	9.4555
cc	5
nc	12
nop	1
crap	5.0061

<?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;
use GameQ\Protocols\Http;

/**
 * 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 Cfx 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 = 'cfx';

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

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

    /**
     * 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 using a sub query
     */
    public function beforeSend(Server $server)
    {
        $GameQ = new \GameQ\GameQ();
        $GameQ->addServer([
            'type' => 'cfxplayers',
            'host' => "$server->ip:$server->port_query",
        ]);
        $results = $GameQ->process();
        $this->PlayerList = isset($results[0]) && isset($results[0][0]) ? $results[0][0] : [];
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * 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);
        }

        // Add result of sub http-protocol if available
        if ($this->PlayerList) {
            $result->add('players', $this->PlayerList);
        }

        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		use GameQ\Protocols\Http;
27
28		/**
29		* GTA Five M Protocol Class
30		*
31		* Server base can be found at https://fivem.net/
32		*
33		* Based on code found at https://github.com/LiquidObsidian/fivereborn-query
34		*
35		* @author Austin Bischoff <[email protected]>
36		*
37		* Adding FiveM Player List by
38		* @author Jesse Lukas <[email protected]>
39		*/
40		class Cfx extends Protocol
41		{
42
43		/**
44		* Array of packets we want to look up.
45		* Each key should correspond to a defined method in this or a parent class
46		*
47		* @type array
48		*/
49		protected $packets = [
50		self::PACKET_STATUS => "\xFF\xFF\xFF\xFFgetinfo xxx",
51		];
52
53		/**
54		* Use the response flag to figure out what method to run
55		*
56		* @type array
57		*/
58		protected $responses = [
59		"\xFF\xFF\xFF\xFFinfoResponse" => "processStatus",
60		];
61
62		/**
63		* The query protocol used to make the call
64		*
65		* @type string
66		*/
67		protected $protocol = 'cfx';
68
69		/**
70		* String name of this protocol class
71		*
72		* @type string
73		*/
74		protected $name = 'cfx';
75
76		/**
77		* Longer string name of this protocol class
78		*
79		* @type string
80		*/
81		protected $name_long = "CitizenFX";
82
83		/**
84		* Holds the Player list so we can overwrite it back
85		*
86		* @var string
87		*/
88		protected $PlayerList = [];
89
90		/**
91		* Normalize settings for this protocol
92		*
93		* @type array
94		*/
95		protected $normalize = [
96		// General
97		'general' => [
98		// target => source
99		'gametype' => 'gametype',
100		'hostname' => 'hostname',
101		'mapname' => 'mapname',
102		'maxplayers' => 'sv_maxclients',
103		'mod' => 'gamename',
104		'numplayers' => 'clients',
105		'password' => 'privateClients',
106		],
107		];
108
109		/**
110		* Get FiveM players list using a sub query
111		*/
112	30	public function beforeSend(Server $server)
113		{
114	30	$GameQ = new \GameQ\GameQ();
115	30	$GameQ->addServer([
116	30	'type' => 'cfxplayers',
117	30	'host' => "$server->ip:$server->port_query",
118	25	]);
119	30	$results = $GameQ->process();
120	30	$this->PlayerList = isset($results[0]) && isset($results[0][0]) ? $results[0][0] : [];
		0 ignored issues – show Documentation Bug introduced 2023-02-28 08:04 UTC by Report Bug Copy Issue Report It seems like `IssetNode && IssetNode ? $results[0][0] : array()` can also be of type `array`. However, the property `$PlayerList` is declared as type `string`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
121	5	}
122
123		/**
124		* Process the response
125		*
126		* @return array
127		* @throws \GameQ\Exception\Protocol
128		*/
129	30	public function processResponse()
130		{
131		// In case it comes back as multiple packets (it shouldn't)
132	30	$buffer = new Buffer(implode('', $this->packets_response));
133
134		// Figure out what packet response this is for
135	30	$response_type = $buffer->readString(PHP_EOL);
136
137		// Figure out which packet response this is
138	30	if (empty($response_type) \|\| !array_key_exists($response_type, $this->responses)) {
139	12	throw new Exception(__METHOD__ . " response type '{$response_type}' is not valid");
140		}
141
142		// Offload the call
143	18	$results = call_user_func_array([$this, $this->responses[$response_type]], [$buffer]);
144
145	18	return $results;
146		}
147
148		/*
149		* Internal methods
150		*/
151
152		/**
153		* Handle processing the status response
154		*
155		* @param Buffer $buffer
156		*
157		* @return array
158		*/
159	18	protected function processStatus(Buffer $buffer)
160		{
161		// Set the result to a new result instance
162	18	$result = new Result();
163
164		// Lets peek and see if the data starts with a \
165	18	if ($buffer->lookAhead(1) == '\\') {
166		// Burn the first one
167	18	$buffer->skip(1);
168		}
169
170		// Explode the data
171	18	$data = explode('\\', $buffer->getBuffer());
172
173		// No longer needed
174	18	unset($buffer);
175
176	18	$itemCount = count($data);
177
178		// Now lets loop the array
179	18	for ($x = 0; $x < $itemCount; $x += 2) {
180		// Set some local vars
181	18	$key = $data[$x];
182	18	$val = $data[$x + 1];
183
184	18	if (in_array($key, ['challenge'])) {
185	18	continue; // skip
186		}
187
188		// Regular variable so just add the value.
189	18	$result->add($key, $val);
190		}
191
192		// Add result of sub http-protocol if available
193	18	if ($this->PlayerList) {
194		$result->add('players', $this->PlayerList);
195		}
196
197	18	return $result->fetch();
198		}
199		}
200

Austinb / GameQ

Push — v3 ( efc739...bb78f7 )

Cfx::processStatus() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like