HandshakeMessage::getID() - Code Metrics - Inspection of "Current state" - PlasmaPHP/driver-mysql - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( f2da15...888a68 )

by Charlotte

created 2018-11-17 21:05 UTC

HandshakeMessage::getID() A

↳ Parent: HandshakeMessage

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
/**
 * Plasma Driver MySQL component
 * Copyright 2018 PlasmaPHP, All Rights Reserved
 *
 * Website: https://github.com/PlasmaPHP
 * License: https://github.com/PlasmaPHP/driver-mysql/blob/master/LICENSE
*/

namespace Plasma\Drivers\MySQL\Messages;

/**
 * Represents a Handshake Message.
 * @internal
 */
class HandshakeMessage implements \Plasma\Drivers\MySQL\Messages\MessageInterface {
    /**
     * The Handshake Protocol version.
     * @var int
     */
    public $protocolVersion;
    
    /**
     * A human readable server version.
     * @var string
     */
    public $serverVersion;
    
    /**
     * The connection ID.
     * @var int
     */
    public $connectionID;
    
    /**
     * Authentication data.
     * @var string
     */
    public $scramble;
    
    /**
     * The server's capability flags.
     * @var int
     */
    public $capability;
    
    /**
     * The character set.
     * @var int|null
     */
    public $characterSet;
    
    /**
     * The status flags.
     * @var int|null
     * @see \Plasma\Drivers\MySQL\StatusFlags
     */
    public $statusFlags;
    
    /**
     * The authentication plugin name.
     * @var string|null
     */
    public $authPluginName;
    
    /**
     * @var \Plasma\Drivers\MySQL\ProtocolParser
     */
    protected $parser;
    
    /**
     * Constructor.
     * @param \Plasma\Drivers\MySQL\ProtocolParser  $parser
     */
    function __construct(\Plasma\Drivers\MySQL\ProtocolParser $parser) {
        $this->parser = $parser;
    }
    
    /**
     * Get the identifier for the packet.
     * @return string
     */
    static function getID(): string {
        return "";
    }
    
    /**
     * Parses the message, once the complete string has been received.
     * Returns false if not enough data has been received, or the remaining buffer.
     * @param \Plasma\BinaryBuffer  $buffer
     * @return bool
     * @throws \Plasma\Drivers\MySQL\Messages\ParseException
     */
    function parseMessage(\Plasma\BinaryBuffer $buffer): bool {
        $protocol = $buffer->readInt1();
        
        switch($protocol) {
            case 0x0A:

                $this->parseProtocol10($buffer);
            break;

            default:

                $exception = new \Plasma\Drivers\MySQL\Messages\ParseException('Unsupported protocol version');
                $exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
                $exception->setBuffer('');
                
                throw $exception;
            break;
        }
        
        return true;
    }
    
    /**
     * Get the parser which created this message.
     * @return \Plasma\Drivers\MySQL\ProtocolParser
     */
    function getParser(): \Plasma\Drivers\MySQL\ProtocolParser {
        return $this->parser;
    }
    
    /**
     * Sets the parser state, if necessary. If not, return `-1`.
     * @return int
     */
    function setParserState(): int {
        return \Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE;
    }
    
    /**

     * Parses the message as Handshake V10.
     * @return bool
     * @throws \Plasma\Drivers\MySQL\Messages\ParseException
     */
    protected function parseProtocol10(\Plasma\BinaryBuffer $buffer): bool {
        $versionLength = \strpos($buffer->getContents(), "\x00");
        if($versionLength === false) {
            return false;
        }
        
        $buffLength = $buffer->getSize();
        $minLength = $versionLength + 1 + 15;
        $moreDataLength = $buffLength - $minLength;
        
        if($buffLength < $minLength) {
            return false;
        } elseif($moreDataLength > 0 && $moreDataLength < 16) {
            return false;
        }
        
        $this->protocolVersion = 10;
        $this->serverVersion = $buffer->readStringNull();
        $this->connectionID = $buffer->readInt4();
        $this->scramble = $buffer->readStringLength(8); // Part 1
        
        $buffer->readStringLength(1); // Remove filler byte
        
        $this->capability = $buffer->readInt2();
        
        if($buffer->getSize() > 0) {
            $this->characterSet = $buffer->readInt1();
            $this->statusFlags = $buffer->readInt2();
            $this->capability += $buffer->readInt2() << 16;
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PROTOCOL_41) === 0) {
                $exception = new \Plasma\Drivers\MySQL\Messages\ParseException('The old MySQL protocol 320 is not supported');
                $exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
                $exception->setBuffer('');
                
                throw $exception;
            }
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PLUGIN_AUTH) !== 0) {
                $authDataLength = $buffer->readInt1();
            } else {
                $authDataLength  = 0;
                $buffer->readStringLength(1);
            }
            
            $buffer->readStringLength(10);
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_SECURE_CONNECTION) !== 0) {
                $len = \max(13, ($authDataLength - 8));
                $this->scramble .= \rtrim($buffer->readStringLength($len), "\x00");
            }
            
            if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PLUGIN_AUTH) !== 0) {
                $this->authPluginName = $buffer->readStringNull();
            }
        }
        
        return true;
    }
}


1		<?php
2		/**
3		* Plasma Driver MySQL component
4		* Copyright 2018 PlasmaPHP, All Rights Reserved
5		*
6		* Website: https://github.com/PlasmaPHP
7		* License: https://github.com/PlasmaPHP/driver-mysql/blob/master/LICENSE
8		*/
9
10		namespace Plasma\Drivers\MySQL\Messages;
11
12		/**
13		* Represents a Handshake Message.
14		* @internal
15		*/
16		class HandshakeMessage implements \Plasma\Drivers\MySQL\Messages\MessageInterface {
17		/**
18		* The Handshake Protocol version.
19		* @var int
20		*/
21		public $protocolVersion;
22
23		/**
24		* A human readable server version.
25		* @var string
26		*/
27		public $serverVersion;
28
29		/**
30		* The connection ID.
31		* @var int
32		*/
33		public $connectionID;
34
35		/**
36		* Authentication data.
37		* @var string
38		*/
39		public $scramble;
40
41		/**
42		* The server's capability flags.
43		* @var int
44		*/
45		public $capability;
46
47		/**
48		* The character set.
49		* @var int\|null
50		*/
51		public $characterSet;
52
53		/**
54		* The status flags.
55		* @var int\|null
56		* @see \Plasma\Drivers\MySQL\StatusFlags
57		*/
58		public $statusFlags;
59
60		/**
61		* The authentication plugin name.
62		* @var string\|null
63		*/
64		public $authPluginName;
65
66		/**
67		* @var \Plasma\Drivers\MySQL\ProtocolParser
68		*/
69		protected $parser;
70
71		/**
72		* Constructor.
73		* @param \Plasma\Drivers\MySQL\ProtocolParser $parser
74		*/
75	13	function __construct(\Plasma\Drivers\MySQL\ProtocolParser $parser) {
76	13	$this->parser = $parser;
77	13	}
78
79		/**
80		* Get the identifier for the packet.
81		* @return string
82		*/
83		static function getID(): string {
84		return "";
85		}
86
87		/**
88		* Parses the message, once the complete string has been received.
89		* Returns false if not enough data has been received, or the remaining buffer.
90		* @param \Plasma\BinaryBuffer $buffer
91		* @return bool
92		* @throws \Plasma\Drivers\MySQL\Messages\ParseException
93		*/
94	13	function parseMessage(\Plasma\BinaryBuffer $buffer): bool {
95	13	$protocol = $buffer->readInt1();
96
97		switch($protocol) {
98	13	case 0x0A:
		1 ignored issue – show Coding Style introduced 2018-11-13 12:15 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
99	13	$this->parseProtocol10($buffer);
100	13	break;
		1 ignored issue – show Coding Style introduced 2018-11-17 21:10 UTC by Report Bug Copy Issue Report Case breaking statement indented incorrectly; expected 16 spaces, found 12 Loading history...
101		default:
		1 ignored issue – show Coding Style introduced 2018-11-13 12:15 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
102		$exception = new \Plasma\Drivers\MySQL\Messages\ParseException('Unsupported protocol version');
103		$exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
104		$exception->setBuffer('');
105
106		throw $exception;
107		break;
108		}
109
110	13	return true;
111		}
112
113		/**
114		* Get the parser which created this message.
115		* @return \Plasma\Drivers\MySQL\ProtocolParser
116		*/
117		function getParser(): \Plasma\Drivers\MySQL\ProtocolParser {
118		return $this->parser;
119		}
120
121		/**
122		* Sets the parser state, if necessary. If not, return `-1`.
123		* @return int
124		*/
125	13	function setParserState(): int {
126	13	return \Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE;
127		}
128
129		/**
		0 ignored issues – show Coding Style introduced 2018-11-13 12:15 UTC by Report Bug Copy Issue Report Parameter `$buffer` should have a doc-comment as per coding-style. Loading history...
130		* Parses the message as Handshake V10.
131		* @return bool
132		* @throws \Plasma\Drivers\MySQL\Messages\ParseException
133		*/
134	13	protected function parseProtocol10(\Plasma\BinaryBuffer $buffer): bool {
135	13	$versionLength = \strpos($buffer->getContents(), "\x00");
136	13	if($versionLength === false) {
137		return false;
138		}
139
140	13	$buffLength = $buffer->getSize();
141	13	$minLength = $versionLength + 1 + 15;
142	13	$moreDataLength = $buffLength - $minLength;
143
144	13	if($buffLength < $minLength) {
145		return false;
146	13	} elseif($moreDataLength > 0 && $moreDataLength < 16) {
147		return false;
148		}
149
150	13	$this->protocolVersion = 10;
151	13	$this->serverVersion = $buffer->readStringNull();
152	13	$this->connectionID = $buffer->readInt4();
153	13	$this->scramble = $buffer->readStringLength(8); // Part 1
154
155	13	$buffer->readStringLength(1); // Remove filler byte
156
157	13	$this->capability = $buffer->readInt2();
158
159	13	if($buffer->getSize() > 0) {
160	13	$this->characterSet = $buffer->readInt1();
161	13	$this->statusFlags = $buffer->readInt2();
162	13	$this->capability += $buffer->readInt2() << 16;
163
164	13	if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PROTOCOL_41) === 0) {
165		$exception = new \Plasma\Drivers\MySQL\Messages\ParseException('The old MySQL protocol 320 is not supported');
166		$exception->setState(\Plasma\Drivers\MySQL\ProtocolParser::STATE_HANDSHAKE_ERROR);
167		$exception->setBuffer('');
168
169		throw $exception;
170		}
171
172	13	if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PLUGIN_AUTH) !== 0) {
173	13	$authDataLength = $buffer->readInt1();
174		} else {
175		$authDataLength = 0;
176		$buffer->readStringLength(1);
177		}
178
179	13	$buffer->readStringLength(10);
180
181	13	if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_SECURE_CONNECTION) !== 0) {
182	13	$len = \max(13, ($authDataLength - 8));
183	13	$this->scramble .= \rtrim($buffer->readStringLength($len), "\x00");
184		}
185
186	13	if(($this->capability & \Plasma\Drivers\MySQL\CapabilityFlags::CLIENT_PLUGIN_AUTH) !== 0) {
187	13	$this->authPluginName = $buffer->readStringNull();
188		}
189		}
190
191	13	return true;
192		}
193		}
194

PlasmaPHP / driver-mysql

GitHub Access Token became invalid

Push — master ( f2da15...888a68 )

HandshakeMessage::getID() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like