Cfx::processStatus() - Code Metrics - Inspection of "Added Epic Online Services and ARK: Survival Ascen..." - Austinb/GameQ - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v3 ( 836575...105154 )

unknown

created 2025-01-23 16:22 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;

/**
 * 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
     *
     * @var array
     */
    protected $packets = [
        self::PACKET_STATUS => "\xFF\xFF\xFF\xFFgetinfo xxx",
    ];

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

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

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

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

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

    /**
     * Normalize settings for this protocol
     *
     * @var 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
     *
     * @throws \Exception
     */
    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
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 Cfx extends Protocol
40		{
41		/**
42		* Array of packets we want to look up.
43		* Each key should correspond to a defined method in this or a parent class
44		*
45		* @var array
46		*/
47		protected $packets = [
48		self::PACKET_STATUS => "\xFF\xFF\xFF\xFFgetinfo xxx",
49		];
50
51		/**
52		* Use the response flag to figure out what method to run
53		*
54		* @var array
55		*/
56		protected $responses = [
57		"\xFF\xFF\xFF\xFFinfoResponse" => "processStatus",
58		];
59
60		/**
61		* The query protocol used to make the call
62		*
63		* @var string
64		*/
65		protected $protocol = 'cfx';
66
67		/**
68		* String name of this protocol class
69		*
70		* @var string
71		*/
72		protected $name = 'cfx';
73
74		/**
75		* Longer string name of this protocol class
76		*
77		* @var string
78		*/
79		protected $name_long = "CitizenFX";
80
81		/**
82		* Holds the Player list so we can overwrite it back
83		*
84		* @var string
85		*/
86		protected $PlayerList = [];
87
88		/**
89		* Normalize settings for this protocol
90		*
91		* @var array
92		*/
93		protected $normalize = [
94		// General
95		'general' => [
96		// target => source
97		'gametype' => 'gametype',
98		'hostname' => 'hostname',
99		'mapname' => 'mapname',
100		'maxplayers' => 'sv_maxclients',
101		'mod' => 'gamename',
102		'numplayers' => 'clients',
103		'password' => 'privateClients',
104		],
105		];
106
107		/**
108		* Get FiveM players list using a sub query
109		*
110		* @throws \Exception
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	30	]);
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		}
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		// Internal methods
149
150		/**
151		* Handle processing the status response
152		*
153		* @param Buffer $buffer
154		*
155		* @return array
156		*/
157	18	protected function processStatus(Buffer $buffer)
158		{
159		// Set the result to a new result instance
160	18	$result = new Result();
161
162		// Lets peek and see if the data starts with a \
163	18	if ($buffer->lookAhead(1) == '\\') {
164		// Burn the first one
165	18	$buffer->skip(1);
166		}
167
168		// Explode the data
169	18	$data = explode('\\', $buffer->getBuffer());
170
171		// No longer needed
172	18	unset($buffer);
173
174	18	$itemCount = count($data);
175
176		// Now lets loop the array
177	18	for ($x = 0; $x < $itemCount; $x += 2) {
178		// Set some local vars
179	18	$key = $data[$x];
180	18	$val = $data[$x + 1];
181
182	18	if (in_array($key, ['challenge'])) {
183	18	continue; // skip
184		}
185
186		// Regular variable so just add the value.
187	18	$result->add($key, $val);
188		}
189
190		// Add result of sub http-protocol if available
191	18	if ($this->PlayerList) {
192		$result->add('players', $this->PlayerList);
193		}
194
195	18	return $result->fetch();
196		}
197		}
198

Austinb / GameQ

Push — v3 ( 836575...105154 )

Cfx::processStatus() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like