BinLogSocketConnect::getCapabilities() - Code Metrics - Inspection of "## v5.0.0 (2018-04-27)" - krowinski/php-mysql-replication - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 80ac3a...2487f9 )

by kacper

created 2018-04-27 14:32 UTC

BinLogSocketConnect::getCapabilities() B

↳ Parent: BinLogSocketConnect

Complexity

Conditions	1
Paths	1

Size

Total Lines	25
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	0
dl	0
loc	25
ccs	8
cts	8
cp	1
crap	1
rs	8.8571
c	0
b	0
f	0

<?php

namespace MySQLReplication\BinLog;

use MySQLReplication\BinaryDataReader\BinaryDataReader;
use MySQLReplication\Config\Config;
use MySQLReplication\Exception\MySQLReplicationException;
use MySQLReplication\Gtid\GtidException;
use MySQLReplication\Gtid\GtidFactory;
use MySQLReplication\Repository\RepositoryInterface;
use MySQLReplication\Socket\SocketInterface;

/**
 * Class BinLogSocketConnect
 * @package MySQLReplication\BinLog
 */
class BinLogSocketConnect
{
    const COM_BINLOG_DUMP = 0x12;
    const COM_REGISTER_SLAVE = 0x15;
    const COM_BINLOG_DUMP_GTID = 0x1e;

    /**
     * @var bool
     */
    private $checkSum = false;
    /**
     * @var RepositoryInterface
     */
    private $repository;
    /**
     * http://dev.mysql.com/doc/internals/en/auth-phase-fast-path.html 00 FE
     * @var array
     */
    private $packageOkHeader = [0, 254];
    /**
     * @var SocketInterface
     */
    private $socket;
    /**
     * 2^24 - 1 16m
     * @var int
     */
    private $binaryDataMaxLength = 16777215;
    /**
     * @var BinLogCurrent
     */
    private $binLogCurrent;

    /**
     * @param RepositoryInterface $repository
     * @param SocketInterface $socket
     * @throws BinLogException
     * @throws \MySQLReplication\Gtid\GtidException
     * @throws \MySQLReplication\Socket\SocketException
     */
    public function __construct(
        RepositoryInterface $repository,
        SocketInterface $socket
    ) {
        $this->repository = $repository;
        $this->socket = $socket;
        $this->binLogCurrent = new BinLogCurrent();

        $this->socket->connectToStream(Config::getHost(), Config::getPort());
        BinLogServerInfo::parsePackage($this->getResponse(false), $this->repository->getVersion());
        $this->authenticate();
        $this->getBinlogStream();
    }

    /**
     * @param bool $checkResponse
     * @return string
     * @throws \MySQLReplication\BinLog\BinLogException
     * @throws \MySQLReplication\Socket\SocketException
     */
    public function getResponse($checkResponse = true)
    {
        $header = $this->socket->readFromSocket(4);
        if ('' === $header) {
            return '';
        }
        $dataLength = unpack('L', $header[0] . $header[1] . $header[2] . chr(0))[1];

        $result = $this->socket->readFromSocket($dataLength);
        if (true === $checkResponse) {
            $this->isWriteSuccessful($result);
        }

        return $result;
    }

    /**
     * @param string $data
     * @throws BinLogException
     */
    private function isWriteSuccessful($data)
    {
        $head = ord($data[0]);
        if (!in_array($head, $this->packageOkHeader, true)) {
            $errorCode = unpack('v', $data[1] . $data[2])[1];
            $errorMessage = '';
            $packetLength = strlen($data);
            for ($i = 9; $i < $packetLength; ++$i) {
                $errorMessage .= $data[$i];
            }

            throw new BinLogException($errorMessage, $errorCode);
        }
    }

    /**
     * @throws BinLogException
     * @throws \MySQLReplication\Socket\SocketException
     * @link http://dev.mysql.com/doc/internals/en/secure-password-authentication.html#packet-Authentication::Native41
     */
    private function authenticate()
    {
        $data = pack('L', self::getCapabilities());
        $data .= pack('L', $this->binaryDataMaxLength);
        $data .= chr(33);
        for ($i = 0; $i < 23; $i++) {
            $data .= chr(0);
        }
        $result = sha1(Config::getPassword(), true) ^ sha1(
                BinLogServerInfo::getSalt() . sha1(sha1(Config::getPassword(), true), true), true
            );

        $data = $data . Config::getUser() . chr(0) . chr(strlen($result)) . $result;
        $str = pack('L', strlen($data));
        $s = $str[0] . $str[1] . $str[2];
        $data = $s . chr(1) . $data;

        $this->socket->writeToSocket($data);
        $this->getResponse();
    }

    /**
     * http://dev.mysql.com/doc/internals/en/capability-flags.html#packet-protocol::capabilityflags
     * https://github.com/siddontang/mixer/blob/master/doc/protocol.txt
     * @return int
     */
    private static function getCapabilities()
    {
        /*
            Left only as information
            $foundRows = 1 << 1;
            $connectWithDb = 1 << 3;
            $compress = 1 << 5;
            $odbc = 1 << 6;
            $localFiles = 1 << 7;
            $ignoreSpace = 1 << 8;
            $multiStatements = 1 << 16;
            $multiResults = 1 << 17;
            $interactive = 1 << 10;
            $ssl = 1 << 11;
            $ignoreSigPipe = 1 << 12;
        */

        $noSchema = 1 << 4;
        $longPassword = 1;
        $longFlag = 1 << 2;
        $transactions = 1 << 13;
        $secureConnection = 1 << 15;
        $protocol41 = 1 << 9;

        return ($longPassword | $longFlag | $transactions | $protocol41 | $secureConnection | $noSchema);
    }

    /**
     * @throws BinLogException
     * @throws GtidException
     * @throws \MySQLReplication\Socket\SocketException
     */
    private function getBinlogStream()
    {
        $this->checkSum = $this->repository->isCheckSum();
        if ($this->checkSum) {
            $this->execute('SET @master_binlog_checksum = @@global.binlog_checksum');
        }

        if (0 !== Config::getHeartbeatPeriod()) {
            // master_heartbeat_period is in nanoseconds
            $this->execute('SET @master_heartbeat_period = ' . Config::getHeartbeatPeriod() * 1000000000);
        }

        $this->registerSlave();

        if ('' !== Config::getMariaDbGtid()) {
            $this->setBinLogDumpMariaGtid();
        }
        if ('' !== Config::getGtid()) {
            $this->setBinLogDumpGtid();
        } else {
            $this->setBinLogDump();
        }
    }

    /**
     * @param string $sql
     * @throws BinLogException
     * @throws \MySQLReplication\Socket\SocketException
     */
    private function execute($sql)
    {
        $this->socket->writeToSocket(pack('LC', strlen($sql) + 1, 0x03) . $sql);
        $this->getResponse();
    }

    /**
     * @see https://dev.mysql.com/doc/internals/en/com-register-slave.html
     * @throws BinLogException
     * @throws \MySQLReplication\Socket\SocketException
     */
    private function registerSlave()
    {
        $host = gethostname();
        $hostLength = strlen($host);
        $userLength = strlen(Config::getUser());
        $passLength = strlen(Config::getPassword());

        $data = pack('l', 18 + $hostLength + $userLength + $passLength);
        $data .= chr(self::COM_REGISTER_SLAVE);
        $data .= pack('V', Config::getSlaveId());
        $data .= pack('C', $hostLength);
        $data .= $host;
        $data .= pack('C', $userLength);
        $data .= Config::getUser();
        $data .= pack('C', $passLength);
        $data .= Config::getPassword();
        $data .= pack('v', Config::getPort());
        $data .= pack('V', 0);
        $data .= pack('V', 0);

        $this->socket->writeToSocket($data);
        $this->getResponse();
    }

    /**
     * @throws \MySQLReplication\Socket\SocketException
     * @throws \MySQLReplication\BinLog\BinLogException
     */
    private function setBinLogDumpMariaGtid()
    {
        $this->execute('SET @mariadb_slave_capability = 4');
        $this->execute('SET @slave_connect_state = \'' . Config::getMariaDbGtid() . '\'');
        $this->execute('SET @slave_gtid_strict_mode = 0');
        $this->execute('SET @slave_gtid_ignore_duplicates = 0');

        $this->binLogCurrent->setMariaDbGtid(Config::getMariaDbGtid());
    }

    /**
     * @see https://dev.mysql.com/doc/internals/en/com-binlog-dump-gtid.html
     * @throws BinLogException
     * @throws GtidException
     * @throws \MySQLReplication\Socket\SocketException
     */
    private function setBinLogDumpGtid()
    {
        $collection = GtidFactory::makeCollectionFromString(Config::getGtid());

        $data = pack('l', 26 + $collection->getEncodedLength()) . chr(self::COM_BINLOG_DUMP_GTID);
        $data .= pack('S', 0);
        $data .= pack('I', Config::getSlaveId());
        $data .= pack('I', 3);
        $data .= chr(0);
        $data .= chr(0);
        $data .= chr(0);
        $data .= BinaryDataReader::pack64bit(4);
        $data .= pack('I', $collection->getEncodedLength());
        $data .= $collection->getEncoded();

        $this->socket->writeToSocket($data);
        $this->getResponse();

        $this->binLogCurrent->setGtid(Config::getGtid());
    }

    /**
     * @see https://dev.mysql.com/doc/internals/en/com-binlog-dump.html
     * @throws BinLogException
     * @throws \MySQLReplication\Socket\SocketException
     */
    private function setBinLogDump()
    {
        $binFilePos = Config::getBinLogPosition();
        $binFileName = Config::getBinLogFileName();
        if (0 === $binFilePos && '' === $binFileName) {
            $master = $this->repository->getMasterStatus();
            if ([] === $master) {
                throw new BinLogException(
                    MySQLReplicationException::BINLOG_NOT_ENABLED,
                    MySQLReplicationException::BINLOG_NOT_ENABLED_CODE
                );
            }
            $binFilePos = $master['Position'];
            $binFileName = $master['File'];
        }

        $data = pack('i', strlen($binFileName) + 11) . chr(self::COM_BINLOG_DUMP);
        $data .= pack('I', $binFilePos);
        $data .= pack('v', 0);
        $data .= pack('I', Config::getSlaveId());
        $data .= $binFileName;

        $this->socket->writeToSocket($data);
        $this->getResponse();

        $this->binLogCurrent->setBinLogPosition($binFilePos);
        $this->binLogCurrent->setBinFileName($binFileName);
    }

    /**
     * @return BinLogCurrent
     */
    public function getBinLogCurrent()
    {
        return $this->binLogCurrent;
    }

    /**
     * @return bool
     */
    public function getCheckSum()
    {
        return $this->checkSum;
    }
}


1		<?php
2
3		namespace MySQLReplication\BinLog;
4
5		use MySQLReplication\BinaryDataReader\BinaryDataReader;
6		use MySQLReplication\Config\Config;
7		use MySQLReplication\Exception\MySQLReplicationException;
8		use MySQLReplication\Gtid\GtidException;
9		use MySQLReplication\Gtid\GtidFactory;
10		use MySQLReplication\Repository\RepositoryInterface;
11		use MySQLReplication\Socket\SocketInterface;
12
13		/**
14		* Class BinLogSocketConnect
15		* @package MySQLReplication\BinLog
16		*/
17		class BinLogSocketConnect
18		{
19		const COM_BINLOG_DUMP = 0x12;
20		const COM_REGISTER_SLAVE = 0x15;
21		const COM_BINLOG_DUMP_GTID = 0x1e;
22
23		/**
24		* @var bool
25		*/
26		private $checkSum = false;
27		/**
28		* @var RepositoryInterface
29		*/
30		private $repository;
31		/**
32		* http://dev.mysql.com/doc/internals/en/auth-phase-fast-path.html 00 FE
33		* @var array
34		*/
35		private $packageOkHeader = [0, 254];
36		/**
37		* @var SocketInterface
38		*/
39		private $socket;
40		/**
41		* 2^24 - 1 16m
42		* @var int
43		*/
44		private $binaryDataMaxLength = 16777215;
45		/**
46		* @var BinLogCurrent
47		*/
48		private $binLogCurrent;
49
50		/**
51		* @param RepositoryInterface $repository
52		* @param SocketInterface $socket
53		* @throws BinLogException
54		* @throws \MySQLReplication\Gtid\GtidException
55		* @throws \MySQLReplication\Socket\SocketException
56		*/
57	54	public function __construct(
58		RepositoryInterface $repository,
59		SocketInterface $socket
60		) {
61	54	$this->repository = $repository;
62	54	$this->socket = $socket;
63	54	$this->binLogCurrent = new BinLogCurrent();
64
65	54	$this->socket->connectToStream(Config::getHost(), Config::getPort());
66	54	BinLogServerInfo::parsePackage($this->getResponse(false), $this->repository->getVersion());
67	54	$this->authenticate();
68	54	$this->getBinlogStream();
69	54	}
70
71		/**
72		* @param bool $checkResponse
73		* @return string
74		* @throws \MySQLReplication\BinLog\BinLogException
75		* @throws \MySQLReplication\Socket\SocketException
76		*/
77	54	public function getResponse($checkResponse = true)
78		{
79	54	$header = $this->socket->readFromSocket(4);
80	54	if ('' === $header) {
81		return '';
82		}
83	54	$dataLength = unpack('L', $header[0] . $header[1] . $header[2] . chr(0))[1];
84
85	54	$result = $this->socket->readFromSocket($dataLength);
86	54	if (true === $checkResponse) {
87	54	$this->isWriteSuccessful($result);
88	54	}
89
90	54	return $result;
91		}
92
93		/**
94		* @param string $data
95		* @throws BinLogException
96		*/
97	54	private function isWriteSuccessful($data)
98		{
99	54	$head = ord($data[0]);
100	54	if (!in_array($head, $this->packageOkHeader, true)) {
101		$errorCode = unpack('v', $data[1] . $data[2])[1];
102		$errorMessage = '';
103		$packetLength = strlen($data);
104		for ($i = 9; $i < $packetLength; ++$i) {
105		$errorMessage .= $data[$i];
106		}
107
108		throw new BinLogException($errorMessage, $errorCode);
109		}
110	54	}
111
112		/**
113		* @throws BinLogException
114		* @throws \MySQLReplication\Socket\SocketException
115		* @link http://dev.mysql.com/doc/internals/en/secure-password-authentication.html#packet-Authentication::Native41
116		*/
117	54	private function authenticate()
118		{
119	54	$data = pack('L', self::getCapabilities());
120	54	$data .= pack('L', $this->binaryDataMaxLength);
121	54	$data .= chr(33);
122	54	for ($i = 0; $i < 23; $i++) {
123	54	$data .= chr(0);
124	54	}
125	54	$result = sha1(Config::getPassword(), true) ^ sha1(
126	54	BinLogServerInfo::getSalt() . sha1(sha1(Config::getPassword(), true), true), true
127	54	);
128
129	54	$data = $data . Config::getUser() . chr(0) . chr(strlen($result)) . $result;
130	54	$str = pack('L', strlen($data));
131	54	$s = $str[0] . $str[1] . $str[2];
132	54	$data = $s . chr(1) . $data;
133
134	54	$this->socket->writeToSocket($data);
135	54	$this->getResponse();
136	54	}
137
138		/**
139		* http://dev.mysql.com/doc/internals/en/capability-flags.html#packet-protocol::capabilityflags
140		* https://github.com/siddontang/mixer/blob/master/doc/protocol.txt
141		* @return int
142		*/
143	54	private static function getCapabilities()
144		{
145		/*
146		Left only as information
147		$foundRows = 1 << 1;
148		$connectWithDb = 1 << 3;
149		$compress = 1 << 5;
150		$odbc = 1 << 6;
151		$localFiles = 1 << 7;
152		$ignoreSpace = 1 << 8;
153		$multiStatements = 1 << 16;
154		$multiResults = 1 << 17;
155		$interactive = 1 << 10;
156		$ssl = 1 << 11;
157		$ignoreSigPipe = 1 << 12;
158		*/
159
160	54	$noSchema = 1 << 4;
161	54	$longPassword = 1;
162	54	$longFlag = 1 << 2;
163	54	$transactions = 1 << 13;
164	54	$secureConnection = 1 << 15;
165	54	$protocol41 = 1 << 9;
166
167	54	return ($longPassword \| $longFlag \| $transactions \| $protocol41 \| $secureConnection \| $noSchema);
168		}
169
170		/**
171		* @throws BinLogException
172		* @throws GtidException
173		* @throws \MySQLReplication\Socket\SocketException
174		*/
175	54	private function getBinlogStream()
176		{
177	54	$this->checkSum = $this->repository->isCheckSum();
178	54	if ($this->checkSum) {
179	54	$this->execute('SET @master_binlog_checksum = @@global.binlog_checksum');
180	54	}
181
182	54	if (0 !== Config::getHeartbeatPeriod()) {
183		// master_heartbeat_period is in nanoseconds
184		$this->execute('SET @master_heartbeat_period = ' . Config::getHeartbeatPeriod() * 1000000000);
185		}
186
187	54	$this->registerSlave();
188
189	54	if ('' !== Config::getMariaDbGtid()) {
190		$this->setBinLogDumpMariaGtid();
191		}
192	54	if ('' !== Config::getGtid()) {
193		$this->setBinLogDumpGtid();
194		} else {
195	54	$this->setBinLogDump();
196		}
197	54	}
198
199		/**
200		* @param string $sql
201		* @throws BinLogException
202		* @throws \MySQLReplication\Socket\SocketException
203		*/
204	54	private function execute($sql)
205		{
206	54	$this->socket->writeToSocket(pack('LC', strlen($sql) + 1, 0x03) . $sql);
207	54	$this->getResponse();
208	54	}
209
210		/**
211		* @see https://dev.mysql.com/doc/internals/en/com-register-slave.html
212		* @throws BinLogException
213		* @throws \MySQLReplication\Socket\SocketException
214		*/
215	54	private function registerSlave()
216		{
217	54	$host = gethostname();
218	54	$hostLength = strlen($host);
219	54	$userLength = strlen(Config::getUser());
220	54	$passLength = strlen(Config::getPassword());
221
222	54	$data = pack('l', 18 + $hostLength + $userLength + $passLength);
223	54	$data .= chr(self::COM_REGISTER_SLAVE);
224	54	$data .= pack('V', Config::getSlaveId());
225	54	$data .= pack('C', $hostLength);
226	54	$data .= $host;
227	54	$data .= pack('C', $userLength);
228	54	$data .= Config::getUser();
229	54	$data .= pack('C', $passLength);
230	54	$data .= Config::getPassword();
231	54	$data .= pack('v', Config::getPort());
232	54	$data .= pack('V', 0);
233	54	$data .= pack('V', 0);
234
235	54	$this->socket->writeToSocket($data);
236	54	$this->getResponse();
237	54	}
238
239		/**
240		* @throws \MySQLReplication\Socket\SocketException
241		* @throws \MySQLReplication\BinLog\BinLogException
242		*/
243		private function setBinLogDumpMariaGtid()
244		{
245		$this->execute('SET @mariadb_slave_capability = 4');
246		$this->execute('SET @slave_connect_state = \'' . Config::getMariaDbGtid() . '\'');
247		$this->execute('SET @slave_gtid_strict_mode = 0');
248		$this->execute('SET @slave_gtid_ignore_duplicates = 0');
249
250		$this->binLogCurrent->setMariaDbGtid(Config::getMariaDbGtid());
251		}
252
253		/**
254		* @see https://dev.mysql.com/doc/internals/en/com-binlog-dump-gtid.html
255		* @throws BinLogException
256		* @throws GtidException
257		* @throws \MySQLReplication\Socket\SocketException
258		*/
259		private function setBinLogDumpGtid()
260		{
261		$collection = GtidFactory::makeCollectionFromString(Config::getGtid());
262
263		$data = pack('l', 26 + $collection->getEncodedLength()) . chr(self::COM_BINLOG_DUMP_GTID);
264		$data .= pack('S', 0);
265		$data .= pack('I', Config::getSlaveId());
266		$data .= pack('I', 3);
267		$data .= chr(0);
268		$data .= chr(0);
269		$data .= chr(0);
270		$data .= BinaryDataReader::pack64bit(4);
271		$data .= pack('I', $collection->getEncodedLength());
272		$data .= $collection->getEncoded();
273
274		$this->socket->writeToSocket($data);
275		$this->getResponse();
276
277		$this->binLogCurrent->setGtid(Config::getGtid());
278		}
279
280		/**
281		* @see https://dev.mysql.com/doc/internals/en/com-binlog-dump.html
282		* @throws BinLogException
283		* @throws \MySQLReplication\Socket\SocketException
284		*/
285	54	private function setBinLogDump()
286		{
287	54	$binFilePos = Config::getBinLogPosition();
288	54	$binFileName = Config::getBinLogFileName();
289	54	if (0 === $binFilePos && '' === $binFileName) {
290	54	$master = $this->repository->getMasterStatus();
291	54	if ([] === $master) {
292		throw new BinLogException(
293		MySQLReplicationException::BINLOG_NOT_ENABLED,
294		MySQLReplicationException::BINLOG_NOT_ENABLED_CODE
295		);
296		}
297	54	$binFilePos = $master['Position'];
298	54	$binFileName = $master['File'];
299	54	}
300
301	54	$data = pack('i', strlen($binFileName) + 11) . chr(self::COM_BINLOG_DUMP);
302	54	$data .= pack('I', $binFilePos);
303	54	$data .= pack('v', 0);
304	54	$data .= pack('I', Config::getSlaveId());
305	54	$data .= $binFileName;
306
307	54	$this->socket->writeToSocket($data);
308	54	$this->getResponse();
309
310	54	$this->binLogCurrent->setBinLogPosition($binFilePos);
311	54	$this->binLogCurrent->setBinFileName($binFileName);
312	54	}
313
314		/**
315		* @return BinLogCurrent
316		*/
317	54	public function getBinLogCurrent()
318		{
319	54	return $this->binLogCurrent;
320		}
321
322		/**
323		* @return bool
324		*/
325	54	public function getCheckSum()
326		{
327	54	return $this->checkSum;
328		}
329		}
330

krowinski / php-mysql-replication

Push — master ( 80ac3a...2487f9 )

BinLogSocketConnect::getCapabilities() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like