Raknet::processResponse() - Code Metrics - Inspection of "Add Raknet protocol class with Minecraft Bedrock E..." - Austinb/GameQ - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v3 ( e344fe...a4d27e )

by Austin

created 2023-02-25 23:06 UTC

Raknet::processResponse() A

↳ Parent: Raknet

Complexity

Conditions	5
Paths	3

Size

Total Lines	65
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	35
c	1
b	0
f	0
dl	0
loc	65
rs	9.0488
cc	5
nc	3
nop	0

How to fix Long Method

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

/**
 * Raknet Protocol Class
 *
 * See https://wiki.vg/Raknet_Protocol for more techinal information
 *
 * @author Austin Bischoff <[email protected]>
 */
class Raknet extends Protocol
{
    /**
     * The magic string that is sent to get access to the server information
     */
    const OFFLINE_MESSAGE_DATA_ID = "\x00\xFF\xFF\x00\xFE\xFE\xFE\xFE\xFD\xFD\xFD\xFD\x12\x34\x56\x78";

    /**
     * Expected first part of the response from the server after query
     */
    const ID_UNCONNECTED_PONG = "\x1C";

    /**
     * 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 => "\x01%s%s\x02\x00\x00\x00\x00\x00\x00\x00", // Format time, magic,
    ];

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

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

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

    /**
     * Do some work to build the packet we need to send out to query
     *
     * @param Server $server
     *
     * @return void
     */
    public function beforeSend(Server $server)
    {
        // Update the server status packet before it is sent
        $this->packets[self::PACKET_STATUS] = sprintf(
            $this->packets[self::PACKET_STATUS],
            pack('Q', time()),
            self::OFFLINE_MESSAGE_DATA_ID
        );
    }

    /**
     * Process the response
     *
     * @return array
     * @throws \GameQ\Exception\Protocol
     */
    public function processResponse()
    {
        // Merge the response array into a buffer. Unknown if this protocol does split packets or not
        $buffer = new Buffer(implode($this->packets_response));

        // Read first character from response. It should match below
        $header = $buffer->read(1);

        // Check first character to make sure the header matches
        if ($header !== self::ID_UNCONNECTED_PONG) {
            throw new Exception(sprintf(
                '%s The header returned "%s" does not match the expected header of "%s"',
                __METHOD__,
                bin2hex($header),
                bin2hex(self::ID_UNCONNECTED_PONG)
            ));
        }

        // Burn the time section
        $buffer->skip(8);

        // Server GUID is next
        $serverGUID = $buffer->readInt64();

        // Read the next set to check to make sure the "magic" matches
        $magicCheck = $buffer->read(16);

        // Magic check fails
        if ($magicCheck !== self::OFFLINE_MESSAGE_DATA_ID) {
            throw new Exception(sprintf(
                '%s The magic value returned "%s" does not match the expected value of "%s"',
                __METHOD__,
                bin2hex($magicCheck),
                bin2hex(self::OFFLINE_MESSAGE_DATA_ID)
            ));
        }

        // According to docs the next character is supposed to be used for a length and string for the following
        // character for the MOTD but it appears to be implemented incorrectly
        // Burn the next two characters instead of trying to do anything useful with them
        $buffer->skip(2);

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

        // Here on is server information delimited by semicolons (;)
        $info = explode(';', $buffer->getBuffer());

        $result->add('edition', $info[0]);
        $result->add('motd_line_1', $info[1]);
        $result->add('protocol_version', (int)$info[2]);
        $result->add('version', $info[3]);
        $result->add('num_players', (int)$info[4]);
        $result->add('max_players', (int)$info[5]);
        $result->add('server_uid', $info[6]);
        $result->add('motd_line_2', $info[7]);
        $result->add('gamemode', $info[8]);
        $result->add('gamemode_numeric', (int)$info[9]);
        $result->add('port_ipv4', (isset($info[10])) ? (int)$info[10] : null);
        $result->add('port_ipv6', (isset($info[11])) ? (int)$info[11] : null);
        $result->add('dedicated', 1);

        unset($header, $serverGUID, $magicCheck, $info);

        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			* Raknet Protocol Class
29			*
30			* See https://wiki.vg/Raknet_Protocol for more techinal information
31			*
32			* @author Austin Bischoff <[email protected]>
33			*/
34			class Raknet extends Protocol
35			{
36			/**
37			* The magic string that is sent to get access to the server information
38			*/
39			const OFFLINE_MESSAGE_DATA_ID = "\x00\xFF\xFF\x00\xFE\xFE\xFE\xFE\xFD\xFD\xFD\xFD\x12\x34\x56\x78";
40
41			/**
42			* Expected first part of the response from the server after query
43			*/
44			const ID_UNCONNECTED_PONG = "\x1C";
45
46			/**
47			* Array of packets we want to look up.
48			* Each key should correspond to a defined method in this or a parent class
49			*
50			* @type array
51			*/
52			protected $packets = [
53			self::PACKET_STATUS => "\x01%s%s\x02\x00\x00\x00\x00\x00\x00\x00", // Format time, magic,
54			];
55
56			/**
57			* The query protocol used to make the call
58			*
59			* @type string
60			*/
61			protected $protocol = 'raknet';
62
63			/**
64			* String name of this protocol class
65			*
66			* @type string
67			*/
68			protected $name = 'raknet';
69
70			/**
71			* Longer string name of this protocol class
72			*
73			* @type string
74			*/
75			protected $name_long = "Raknet Server";
76
77			/**
78			* Do some work to build the packet we need to send out to query
79			*
80			* @param Server $server
81			*
82			* @return void
83			*/
84			public function beforeSend(Server $server)
85			{
86			// Update the server status packet before it is sent
87			$this->packets[self::PACKET_STATUS] = sprintf(
88			$this->packets[self::PACKET_STATUS],
89			pack('Q', time()),
90			self::OFFLINE_MESSAGE_DATA_ID
91			);
92			}
93
94			/**
95			* Process the response
96			*
97			* @return array
98			* @throws \GameQ\Exception\Protocol
99			*/
100			public function processResponse()
101			{
102			// Merge the response array into a buffer. Unknown if this protocol does split packets or not
103			$buffer = new Buffer(implode($this->packets_response));
104
105			// Read first character from response. It should match below
106			$header = $buffer->read(1);
107
108			// Check first character to make sure the header matches
109			if ($header !== self::ID_UNCONNECTED_PONG) {
110			throw new Exception(sprintf(
111			'%s The header returned "%s" does not match the expected header of "%s"',
112			__METHOD__,
113			bin2hex($header),
114			bin2hex(self::ID_UNCONNECTED_PONG)
115			));
116			}
117
118			// Burn the time section
119			$buffer->skip(8);
120
121			// Server GUID is next
122			$serverGUID = $buffer->readInt64();
123
124			// Read the next set to check to make sure the "magic" matches
125			$magicCheck = $buffer->read(16);
126
127			// Magic check fails
128			if ($magicCheck !== self::OFFLINE_MESSAGE_DATA_ID) {
129			throw new Exception(sprintf(
130			'%s The magic value returned "%s" does not match the expected value of "%s"',
131			__METHOD__,
132			bin2hex($magicCheck),
133			bin2hex(self::OFFLINE_MESSAGE_DATA_ID)
134			));
135			}
136
137			// According to docs the next character is supposed to be used for a length and string for the following
138			// character for the MOTD but it appears to be implemented incorrectly
139			// Burn the next two characters instead of trying to do anything useful with them
140			$buffer->skip(2);
141
142			// Set the result to a new result instance
143			$result = new Result();
144
145			// Here on is server information delimited by semicolons (;)
146			$info = explode(';', $buffer->getBuffer());
147
148			$result->add('edition', $info[0]);
149			$result->add('motd_line_1', $info[1]);
150			$result->add('protocol_version', (int)$info[2]);
151			$result->add('version', $info[3]);
152			$result->add('num_players', (int)$info[4]);
153			$result->add('max_players', (int)$info[5]);
154			$result->add('server_uid', $info[6]);
155			$result->add('motd_line_2', $info[7]);
156			$result->add('gamemode', $info[8]);
157			$result->add('gamemode_numeric', (int)$info[9]);
158			$result->add('port_ipv4', (isset($info[10])) ? (int)$info[10] : null);
159			$result->add('port_ipv6', (isset($info[11])) ? (int)$info[11] : null);
160			$result->add('dedicated', 1);
161
162			unset($header, $serverGUID, $magicCheck, $info);
163
164			return $result->fetch();
165			}
166			}
167

Austinb / GameQ

Push — v3 ( e344fe...a4d27e )

Raknet::processResponse() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like