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

Starmade::parseServerParameters() B
last analyzed 2025-02-19 14:42 UTC

↳ Parent: Starmade

Complexity

Conditions	10
Paths	10

Size

Total Lines	63
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	24
CRAP Score	11.1512

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	31
c	1
b	0
f	0
dl	0
loc	63
ccs	24
cts	31
cp	0.7742
rs	7.6666
cc	10
nc	10
nop	1
crap	11.1512

How to fix Long Method Complexity

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

/**
 * StarMade Protocol Class
 *
 * StarMade server query protocol class
 *
 * Credit to Robin Promesberger <[email protected]> for providing Java based querying as a roadmap
 *
 * @author Austin Bischoff <[email protected]>
 */
class Starmade extends Protocol
{
    /**
     * Array of packets we want to query.
     *
     * @var array
     */
    protected $packets = [
        self::PACKET_STATUS => "\x00\x00\x00\x09\x2a\xff\xff\x01\x6f\x00\x00\x00\x00",
    ];

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

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

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

    /**
     * Normalize settings for this protocol
     *
     * @var array
     */
    protected $normalize = [
        // General
        'general' => [
            // target       => source
            'dedicated'  => 'dedicated',
            'hostname'   => 'hostname',
            'maxplayers' => 'max_players',
            'numplayers' => 'num_players',
            'password'   => 'password',
        ],
    ];

    /**
     * Process the response for the StarMade server
     *
     * @return array
     * @throws \GameQ\Exception\Protocol
     */
    public function processResponse()
    {
        // Implode the packets, not sure if there is any split logic for multiple packets
        $buffer = new Buffer(implode('', $this->packets_response), Buffer::NUMBER_TYPE_BIGENDIAN);

        // Get the passed length in the data side of the packet
        $buffer->readInt32Signed();

        // Read off the timestamp (in milliseconds)
        $buffer->readInt64();

        // Burn the check id == 42
        $buffer->readInt8();

        // Read packetId, unused
        $buffer->readInt16Signed();

        // Read commandId, unused
        $buffer->readInt8Signed();

        // Read type, unused
        $buffer->readInt8Signed();

        $parsed = $this->parseServerParameters($buffer);

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

        // Best guess info version is the type of response to expect.  As of this commit the version is "2".
        $result->add('info_version', $parsed[0]);
        $result->add('version', $parsed[1]);
        $result->add('hostname', $parsed[2]);
        $result->add('game_descr', $parsed[3]);
        $result->add('start_time', $parsed[4]);
        $result->add('num_players', $parsed[5]);
        $result->add('max_players', $parsed[6]);
        $result->add('dedicated', 1); // All servers are dedicated as far as I can tell
        $result->add('password', 0); // Unsure if you can password servers, cant read that value
        //$result->add('map', 'Unknown');

        unset($parsed);

        return $result->fetch();
    }

    /**
     * Parse the server response parameters
     *
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     *
     * @param \GameQ\Buffer $buffer
     * @return array
     * @throws \GameQ\Exception\Protocol
     */
    protected function parseServerParameters(Buffer &$buffer)
    {
        // Init the parsed data array
        $parsed = [];

        // Read the number of parameters to parse
        $parameterSize = $buffer->readInt32Signed();

        // Iterate over the parameter size
        for ($i = 0; $i < $parameterSize; $i++) {
            // Read the type of return this is
            $dataType = $buffer->readInt8Signed();

            switch ($dataType) {
                // 32-bit int
                case 1:
                    $parsed[$i] = $buffer->readInt32Signed();
                    break;

                    // 64-bit int
                case 2:
                    $parsed[$i] = $buffer->readInt64();
                    break;

                    // Float
                case 3:
                    $parsed[$i] = $buffer->readFloat32();
                    break;

                    // String
                case 4:
                    // The first 2 bytes are the string length
                    $strLength = $buffer->readInt16Signed();

                    // Read the above length from the buffer
                    $parsed[$i] = $buffer->read($strLength);

                    unset($strLength);
                    break;

                    // Boolean
                case 5:
                    $parsed[$i] = (bool)$buffer->readInt8Signed();
                    break;

                    // 8-bit int
                case 6:
                    $parsed[$i] = $buffer->readInt8Signed();
                    break;

                    // 16-bit int
                case 7:
                    $parsed[$i] = $buffer->readInt16Signed();
                    break;

                    // Array
                case 8:
                    // Not implemented
                    throw new Exception("StarMade array parsing is not implemented!");
            }
        }

        return $parsed;
    }
}


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
26		/**
27		* StarMade Protocol Class
28		*
29		* StarMade server query protocol class
30		*
31		* Credit to Robin Promesberger <[email protected]> for providing Java based querying as a roadmap
32		*
33		* @author Austin Bischoff <[email protected]>
34		*/
35		class Starmade extends Protocol
36		{
37		/**
38		* Array of packets we want to query.
39		*
40		* @var array
41		*/
42		protected $packets = [
43		self::PACKET_STATUS => "\x00\x00\x00\x09\x2a\xff\xff\x01\x6f\x00\x00\x00\x00",
44		];
45
46		/**
47		* The transport mode for this protocol is TCP
48		*
49		* @var string
50		*/
51		protected $transport = self::TRANSPORT_TCP;
52
53		/**
54		* The query protocol used to make the call
55		*
56		* @var string
57		*/
58		protected $protocol = 'starmade';
59
60		/**
61		* String name of this protocol class
62		*
63		* @var string
64		*/
65		protected $name = 'starmade';
66
67		/**
68		* Longer string name of this protocol class
69		*
70		* @var string
71		*/
72		protected $name_long = "StarMade";
73
74		/**
75		* Normalize settings for this protocol
76		*
77		* @var array
78		*/
79		protected $normalize = [
80		// General
81		'general' => [
82		// target => source
83		'dedicated' => 'dedicated',
84		'hostname' => 'hostname',
85		'maxplayers' => 'max_players',
86		'numplayers' => 'num_players',
87		'password' => 'password',
88		],
89		];
90
91		/**
92		* Process the response for the StarMade server
93		*
94		* @return array
95		* @throws \GameQ\Exception\Protocol
96		*/
97	6	public function processResponse()
98		{
99		// Implode the packets, not sure if there is any split logic for multiple packets
100	6	$buffer = new Buffer(implode('', $this->packets_response), Buffer::NUMBER_TYPE_BIGENDIAN);
101
102		// Get the passed length in the data side of the packet
103	6	$buffer->readInt32Signed();
104
105		// Read off the timestamp (in milliseconds)
106	6	$buffer->readInt64();
107
108		// Burn the check id == 42
109	6	$buffer->readInt8();
110
111		// Read packetId, unused
112	6	$buffer->readInt16Signed();
113
114		// Read commandId, unused
115	6	$buffer->readInt8Signed();
116
117		// Read type, unused
118	6	$buffer->readInt8Signed();
119
120	6	$parsed = $this->parseServerParameters($buffer);
121
122		// Set the result to a new result instance
123	6	$result = new Result();
124
125		// Best guess info version is the type of response to expect. As of this commit the version is "2".
126	6	$result->add('info_version', $parsed[0]);
127	6	$result->add('version', $parsed[1]);
128	6	$result->add('hostname', $parsed[2]);
129	6	$result->add('game_descr', $parsed[3]);
130	6	$result->add('start_time', $parsed[4]);
131	6	$result->add('num_players', $parsed[5]);
132	6	$result->add('max_players', $parsed[6]);
133	6	$result->add('dedicated', 1); // All servers are dedicated as far as I can tell
134	6	$result->add('password', 0); // Unsure if you can password servers, cant read that value
135		//$result->add('map', 'Unknown');
136
137	6	unset($parsed);
138
139	6	return $result->fetch();
140		}
141
142		/**
143		* Parse the server response parameters
144		*
145		* @SuppressWarnings(PHPMD.CyclomaticComplexity)
146		*
147		* @param \GameQ\Buffer $buffer
148		* @return array
149		* @throws \GameQ\Exception\Protocol
150		*/
151	6	protected function parseServerParameters(Buffer &$buffer)
152		{
153		// Init the parsed data array
154	6	$parsed = [];
155
156		// Read the number of parameters to parse
157	6	$parameterSize = $buffer->readInt32Signed();
158
159		// Iterate over the parameter size
160	6	for ($i = 0; $i < $parameterSize; $i++) {
161		// Read the type of return this is
162	6	$dataType = $buffer->readInt8Signed();
163
164		switch ($dataType) {
165		// 32-bit int
166	6	case 1:
167	6	$parsed[$i] = $buffer->readInt32Signed();
168	6	break;
169
170		// 64-bit int
171	6	case 2:
172	6	$parsed[$i] = $buffer->readInt64();
173	6	break;
174
175		// Float
176	6	case 3:
177	6	$parsed[$i] = $buffer->readFloat32();
178	6	break;
179
180		// String
181	6	case 4:
182		// The first 2 bytes are the string length
183	6	$strLength = $buffer->readInt16Signed();
184
185		// Read the above length from the buffer
186	6	$parsed[$i] = $buffer->read($strLength);
187
188	6	unset($strLength);
189	6	break;
190
191		// Boolean
192	6	case 5:
193		$parsed[$i] = (bool)$buffer->readInt8Signed();
194		break;
195
196		// 8-bit int
197	6	case 6:
198	6	$parsed[$i] = $buffer->readInt8Signed();
199	6	break;
200
201		// 16-bit int
202		case 7:
203		$parsed[$i] = $buffer->readInt16Signed();
204		break;
205
206		// Array
207		case 8:
208		// Not implemented
209		throw new Exception("StarMade array parsing is not implemented!");
210		}
211		}
212
213	6	return $parsed;
214		}
215		}
216

Austinb / GameQ

Starmade::parseServerParameters() B last analyzed 2025-02-19 14:42 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Starmade::parseServerParameters() B
last analyzed 2025-02-19 14:42 UTC