PHPDaemon\Clients\MySQL\Connection

Complexity

Total Complexity

62

Size/Duplication

Total Lines	634
Duplicated Lines	6.15 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	9
Bugs	1	Features	1

19 Methods

Rating	Name	Duplication	Size	Complexity
A	onReady()	0	6	3
A	sendPacket()	0	5	1
B	buildLenEncodedBinary()	0	22	5
B	parseEncodedBinary()	0	20	6
A	parseEncodedString()	0	8	3
A	getAuthToken()	0	4	1
A	query()	0	7	2
A	begin()	0	5	1
A	commit()	0	5	1
A	rollback()	0	5	1
A	ping()	0	4	1
A	command()	11	12	2
A	selectDB()	0	10	2
A	onFinish()	0	5	1
A	onResultDone()	0	8	1
A	onError()	0	16	3
A	onConnected()	13	13	4
B	auth()	7	34	5
F	onRead()	7	148	19

<?php
namespace PHPDaemon\Clients\MySQL;

use PHPDaemon\Core\Daemon;
use PHPDaemon\Network\ClientConnection;
use PHPDaemon\Structures\StackCallbacks;
use PHPDaemon\Utils\Binary;

class Connection extends ClientConnection
{

    /**
     * @var integer Sequence. Pointer of packet sequence
     */
    public $seq = 0;

    /**
     * @var integer Client flags
     */
    public $clientFlags = 239237;

    /**
     * @var integer
     */
    public $threadId;

    /**
     * @var string
     */
    public $scramble;

    /**
     * @var string
     */
    public $serverver;

    /**
     * @var integer
     */
    public $serverCaps;

    /**
     * @var integer
     */
    public $serverLang;

    /**
     * @var integer Server flags: http://dev.mysql.com/doc/internals/en/status-flags.html
     */
    public $serverStatus;

    /**
     * @var integer Number of warnings generated by the command
     */
    public $warnCount;

    /**
     * @var string
     */
    public $message;

    /**
     * @var integer Charset number (see MySQL charset list)
     */
    public $charsetNumber = 0x21;

    /**
     * @var string User name
     */
    protected $user = 'root';

    /**
     * @var string Password
     */
    protected $password = '';

    /**
     * @var string Database name
     */
    public $dbname = '';

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const STATE_STANDBY = 0;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const STATE_BODY = 1;

    /**
     * @var string Phase
     */
    protected $phase = 0;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const PHASE_GOT_INIT = 1;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const PHASE_AUTH_SENT = 2;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const PHASE_AUTH_ERR = 3;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const PHASE_HANDSHAKED = 4;

    /**
     * @var integer State of pointer of incoming data. 0 - Result Set Header Packet, 1 - Field Packet, 2 - Row Packet
     */
    protected $rsState = 0;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const RS_STATE_HEADER = 0;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const RS_STATE_FIELD = 1;

    /**
     * @TODO DESCR

Comment refers to a TODO task

     */
    const RS_STATE_ROW = 2;

    /**
     * @var integer Packet size
     */
    protected $pctSize = 0;

    /**
     * @var array Result rows
     */
    public $resultRows = [];

    /**
     * @var array Result fields
     */
    public $resultFields = [];

    /**
     * @var object Property holds a reference to user's object
     */
    public $context;

    /**
     * @var integer INSERT_ID()
     */
    public $insertId;

    /**
     * @var integer Affected rows
     */
    public $affectedRows;

    /**
     * @var integer Protocol version
     */
    public $protover = 0;

    /**
     * @var integer Timeout
     */
    public $timeout = 120;

    /**
     * @var integer Error number
     */
    public $errno = 0;

    /**
     * @var string Error message
     */
    public $errmsg = '';

    /**
     * @var integer Low mark
     */
    protected $lowMark = 4;

    /**
     * Executes the given callback when/if the connection is handshaked
     * @param  callable $cb Callback
     * @callback $cb ( Connection $conn, boolean $success )
     * @return void
     */
    public function onConnected($cb)

This method seems to be duplicated in your project.

    {
        if ($this->phase === self::PHASE_AUTH_ERR) {

The strict comparison === seems to always evaluate to false as the types of $this->phase (string) and self::PHASE_AUTH_ERR (integer) can never be identical. Maybe you want to use a loose comparison == instead?

            $cb($this, false);
        } elseif ($this->phase === self::PHASE_HANDSHAKED) {

The strict comparison === seems to always evaluate to false as the types of $this->phase (string) and self::PHASE_HANDSHAKED (integer) can never be identical. Maybe you want to use a loose comparison == instead?

            $cb($this, true);
        } else {
            if (!$this->onConnected) {
                $this->onConnected = new StackCallbacks();
            }
            $this->onConnected->push($cb);
        }
    }

    /**
     * Called when the connection is handshaked (at low-level), and peer is ready to recv. data
     * @return void
     */
    public function onReady()
    {
        if (mb_orig_strlen($this->path) && !mb_orig_strlen($this->dbname)) {
            $this->dbname = $this->path;
        }
    }

    /**
     * Sends a packet
     * @param  string $packet Data
     * @return boolean         Success
     */
    public function sendPacket($packet)
    {
        //Daemon::log('Client --> Server: ' . Debug::exportBytes($packet) . "\n\n");

50% of this comment could be valid code. Did you maybe forget this after debugging?

        return $this->write(Binary::int2bytes(3, mb_orig_strlen($packet), true) . chr($this->seq++) . $packet);
    }

    /**
     * Builds length-encoded binary string
     * @param  string $s String
     * @return string    Resulting binary string
     */
    public function buildLenEncodedBinary($s)
    {
        if ($s === null) {
            return "\251";
        }

        $l = mb_orig_strlen($s);

        if ($l <= 250) {
            return chr($l) . $s;
        }

        if ($l <= 0xFFFF) {
            return "\252" . Binary::int2bytes(2, true) . $s;

true is of type boolean, but the function expects a integer.

        }

        if ($l <= 0xFFFFFF) {
            return "\254" . Binary::int2bytes(3, true) . $s;

true is of type boolean, but the function expects a integer.

        }

        return Binary::int2bytes(8, $l, true) . $s;
    }

    /**
     * Parses length-encoded binary integer
     * @return integer Result

Should the return type not be integer|null|false|double?

     */
    public function parseEncodedBinary()
    {
        $f = ord($this->read(1));
        if ($f <= 250) {
            return $f;
        }
        if ($f === 251) {
            return null;
        }
        if ($f === 255) {
            return false;
        }
        if ($f === 252) {
            return Binary::bytes2int($this->read(2), true);

It seems like $this->read(2) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

        }
        if ($f === 253) {
            return Binary::bytes2int($this->read(3), true);

It seems like $this->read(3) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

        }
        return Binary::bytes2int($this->read(8), true);

It seems like $this->read(8) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

    }

    /**
     * Parse length-encoded string
     * @return integer Result

Should the return type not be null|false|string?

     */
    public function parseEncodedString()
    {
        $l = $this->parseEncodedBinary();
        if (($l === null) || ($l === false)) {
            return $l;
        }
        return $this->read($l);
    }

    /**
     * Generates auth. token
     * @param  string $scramble Scramble string
     * @param  string $password Password
     * @return string           Result
     */
    public function getAuthToken($scramble, $password)
    {
        return sha1($scramble . sha1($hash1 = sha1($password, true), true), true) ^ $hash1;
    }

    /**
     * Sends auth. packet
     * @return void
     */
    public function auth()
    {
        if ($this->phase !== self::PHASE_GOT_INIT) {

The strict comparison !== seems to always evaluate to true as the types of $this->phase (string) and self::PHASE_GOT_INIT (integer) can never be identical. Maybe you want to use a loose comparison != instead?

            return;
        }
        $this->phase = self::PHASE_AUTH_SENT;

The property $phase was declared of type string, but self::PHASE_AUTH_SENT is of type integer. Maybe add a type cast?

        $this->onResponse->push(function ($conn, $result) {

This code seems to be duplicated across your project.

            if ($conn->onConnected) {
                $conn->connected = true;
                $conn->onConnected->executeAll($conn, $result);
                $conn->onConnected = null;
            }
        });
        $this->clientFlags =
            Pool::CLIENT_LONG_PASSWORD |
            Pool::CLIENT_LONG_FLAG |
            Pool::CLIENT_LOCAL_FILES |
            Pool::CLIENT_PROTOCOL_41 |
            Pool::CLIENT_INTERACTIVE |
            Pool::CLIENT_TRANSACTIONS |
            Pool::CLIENT_SECURE_CONNECTION |
            Pool::CLIENT_MULTI_STATEMENTS |
            Pool::CLIENT_MULTI_RESULTS;

        $this->sendPacket(
            $packet = pack('VVc', $this->clientFlags, $this->pool->maxAllowedPacket, $this->charsetNumber)
                . "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"
                . $this->user . "\x00"
                . ($this->password === '' ? "\x00" : $this->buildLenEncodedBinary(
                    $this->getAuthToken($this->scramble, $this->password)
                ))
                . ($this->path !== '' ? $this->path . "\x00" : '')
        );
    }

    /**
     * Sends SQL-query
     * @param  string $q Query
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @callback $cb ( Connection $conn, boolean $success )
     * @return boolean            Success
     */
    public function query($q, $cb = null)
    {
        if ($this->finished) {
            throw new ConnectionFinished;
        }
        return $this->command(Pool::COM_QUERY, $q, $cb);
    }

    /**
     * Begins a transaction
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @throws ConnectionFinished
     */
    public function begin($cb = null)
    {
        $this->query('BEGIN', $cb);
        $this->acquire();
    }

    /**
     * Commit a transaction
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @throws ConnectionFinished
     */
    public function commit($cb = null)
    {
        $this->query('COMMIT', $cb);
        $this->release();
    }

    /**
     * Rollback a transaction
     * @throws ConnectionFinished
     */
    public function rollback($cb = null)
    {
        $this->query('ROLLBACK', $cb);
        $this->release();
    }

    /**
     * Sends echo-request
     * @param  callable $cb Optional. Callback called when response received

Should the type for parameter $cb not be callable|null?

     * @callback $cb ( Connection $conn, boolean $success )
     * @return boolean            Success
     */
    public function ping($cb = null)
    {
        return $this->command(Pool::COM_PING, '', $cb);
    }

    /**
     * Sends arbitrary command
     * @param  string $cmd Command
     * @param  string $q Data
     * @param  callable $cb Optional

Should the type for parameter $cb not be callable|null?

     * @throws ConnectionFinished
     * @callback $cb ( Connection $conn, boolean $success )
     * @return boolean            Success
     */
    public function command($cmd, $q = '', $cb = null)

This method seems to be duplicated in your project.

    {
        if ($this->phase !== self::PHASE_HANDSHAKED) {

The strict comparison !== seems to always evaluate to true as the types of $this->phase (string) and self::PHASE_HANDSHAKED (integer) can never be identical. Maybe you want to use a loose comparison != instead?

            return false;
        }

        $this->onResponse->push($cb);

It seems like $cb defined by parameter $cb on line 417 can also be of type null; however, PHPDaemon\Structures\StackCallbacks::push() does only seem to accept callable, maybe add an additional type check?

        $this->seq = 0;
        $this->sendPacket(chr($cmd) . $q);

        return true;
    }

    /**
     * Sets default database name
     * @param  string $name Database name
     * @return boolean         Success
     */
    public function selectDB($name)
    {
        $this->dbname = $name;

        if ($this->phase !== self::PHASE_GOT_INIT) {

The strict comparison !== seems to always evaluate to true as the types of $this->phase (string) and self::PHASE_GOT_INIT (integer) can never be identical. Maybe you want to use a loose comparison != instead?

            return $this->query('USE `' . $name . '`');
        }

        return true;
    }

    /**
     * Called when new data received
     * @return void
     */
    public function onRead()
    {
        packet:
        if ($this->state === self::STATE_STANDBY) {
            if ($this->bev->input->length < 4) {
                return;
            }
            $this->pctSize = Binary::bytes2int($this->read(3), true);

It seems like $this->read(3) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

It seems like \PHPDaemon\Utils\Binary::bytes2int($this->read(3), true) can also be of type double. However, the property $pctSize is declared as type integer. Maybe add an additional type check?

            $this->setWatermark($this->pctSize, $this->pctSize);
            $this->state = self::STATE_BODY;
            $this->seq = ord($this->read(1)) + 1;
        }
        /* STATE_BODY */
        $l = $this->bev->input->length;
        if ($l < $this->pctSize) {
            return;
        }
        $this->state = self::STATE_STANDBY;
        $this->setWatermark(4);
        if ($this->phase === 0) {
            $this->phase = self::PHASE_GOT_INIT;

The property $phase was declared of type string, but self::PHASE_GOT_INIT is of type integer. Maybe add a type cast?

            $this->protover = ord($this->read(1));
            if ($this->protover === 0xFF) { // error
                $fieldCount = $this->protover;
                $this->protover = 0;
                $this->onResponse->push(function ($conn, $result) {

This code seems to be duplicated across your project.

                    if ($conn->onConnected) {
                        $conn->connected = true;
                        $conn->onConnected->executeAll($conn, $result);
                        $conn->onConnected = null;
                    }
                });
                goto field;
            }
            if (($p = $this->search("\x00")) === false) {
                $this->log('nul-terminator of \'serverver\' is not found');
                $this->finish();
                return;
            }
            $this->serverver = $this->read($p);

It seems like $this->read($p) can also be of type false. However, the property $serverver is declared as type string. Maybe add an additional type check?

            $this->drain(1); // drain nul-byte
            $this->threadId = Binary::bytes2int($this->read(4), true);

It seems like $this->read(4) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

It seems like \PHPDaemon\Utils\Binary::bytes2int($this->read(4), true) can also be of type double. However, the property $threadId is declared as type integer. Maybe add an additional type check?

            $this->scramble = $this->read(8);

It seems like $this->read(8) can also be of type false. However, the property $scramble is declared as type string. Maybe add an additional type check?

            $this->drain(1); // ????

            $this->serverCaps = Binary::bytes2int($this->read(2), true);

It seems like $this->read(2) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

It seems like \PHPDaemon\Utils\Binary::bytes2int($this->read(2), true) can also be of type double. However, the property $serverCaps is declared as type integer. Maybe add an additional type check?

            $this->serverLang = ord($this->read(1));
            $this->serverStatus = Binary::bytes2int($this->read(2), true);

It seems like $this->read(2) targeting PHPDaemon\Network\IOStream::read() can also be of type false; however, PHPDaemon\Utils\Binary::bytes2int() does only seem to accept string, did you maybe forget to handle an error condition?

It seems like \PHPDaemon\Utils\Binary::bytes2int($this->read(2), true) can also be of type double. However, the property $serverStatus is declared as type integer. Maybe add an additional type check?

            $this->drain(13);
            $restScramble = $this->read(12);
            $this->scramble .= $restScramble;
            $this->drain(1);

            $this->auth();
        } else {
            $fieldCount = ord($this->read(1));
            field:
            if ($fieldCount === 0xFF) {
                // Error packet
                $u = unpack('v', $this->read(2));
                $this->errno = $u[1];
                $state = $this->read(6);

$state is not used, you could remove the assignment.

                $this->errmsg = $this->read($this->pctSize - $l + $this->bev->input->length);

It seems like $this->read($this->pctSize - $l + $this->bev->input->length) can also be of type false. However, the property $errmsg is declared as type string. Maybe add an additional type check?

                $this->onError();
                $this->errno = 0;
                $this->errmsg = '';
            } elseif ($fieldCount === 0x00) {
                // OK Packet Empty
                if ($this->phase === self::PHASE_AUTH_SENT) {
                    $this->phase = self::PHASE_HANDSHAKED;

The property $phase was declared of type string, but self::PHASE_HANDSHAKED is of type integer. Maybe add a type cast?

                    if ($this->dbname !== '') {
                        $this->query('USE `' . $this->dbname . '`');
                    }
                }

                $this->affectedRows = $this->parseEncodedBinary();

It seems like $this->parseEncodedBinary() can also be of type false or double. However, the property $affectedRows is declared as type integer. Maybe add an additional type check?

                $this->insertId = $this->parseEncodedBinary();

It seems like $this->parseEncodedBinary() can also be of type false or double. However, the property $insertId is declared as type integer. Maybe add an additional type check?

                $u = unpack('v', $this->read(2));
                $this->serverStatus = $u[1];

                $u = unpack('v', $this->read(2));
                $this->warnCount = $u[1];

                $this->message = $this->read($this->pctSize - $l + $this->bev->input->length);

It seems like $this->read($this->pctSize - $l + $this->bev->input->length) can also be of type false. However, the property $message is declared as type string. Maybe add an additional type check?

                $this->onResultDone();
            } elseif ($fieldCount === 0xFE) {
                // EOF Packet
                if ($this->rsState === self::RS_STATE_ROW) {
                    $this->onResultDone();
                } else {
                    ++$this->rsState;
                }
            } else {
                // Data packet
                $this->prependInput(chr($fieldCount));

                if ($this->rsState === self::RS_STATE_HEADER) {
                    // Result Set Header Packet
                    $extra = $this->parseEncodedBinary();

$extra is not used, you could remove the assignment.

                    $this->rsState = self::RS_STATE_FIELD;
                } elseif ($this->rsState === self::RS_STATE_FIELD) {
                    // Field Packet
                    $field = [
                        'catalog' => $this->parseEncodedString(),
                        'db' => $this->parseEncodedString(),
                        'table' => $this->parseEncodedString(),
                        'org_table' => $this->parseEncodedString(),
                        'name' => $this->parseEncodedString(),
                        'org_name' => $this->parseEncodedString()
                    ];

                    $this->drain(1); // filler

                    $u = unpack('v', $this->read(2));

                    $field['charset'] = $u[1];
                    $u = unpack('V', $this->read(4));
                    $field['length'] = $u[1];

                    $field['type'] = ord($this->read(1));

                    $u = unpack('v', $this->read(2));
                    $field['flags'] = $u[1];

                    $field['decimals'] = ord($this->read(1));

                    $this->resultFields[] = $field;
                } elseif ($this->rsState === self::RS_STATE_ROW) {
                    // Row Packet
                    $row = [];

                    for ($i = 0, $nf = sizeof($this->resultFields); $i < $nf; ++$i) {
                        $row[$this->resultFields[$i]['name']] = $this->parseEncodedString();
                    }

                    $this->resultRows[] = $row;
                }
            }
        }
        if ($this->finished) {
            return;
        }
        $this->drain($this->pctSize - $l + $this->bev->input->length); // drain the rest of packet
        goto packet;
    }

    /**
     * Called when connection finishes
     * @return void
     */
    public function onFinish()
    {
        $this->command(Pool::COM_QUIT);
        parent::onFinish();
    }

    /**
     * Called when the whole result received
     * @return void
     */
    public function onResultDone()
    {
        $this->rsState = self::RS_STATE_HEADER;
        $this->onResponse->executeOne($this, true);
        $this->checkFree();
        $this->resultRows = [];
        $this->resultFields = [];
    }

    /**
     * Called when error occured
     * @return void
     */
    public function onError()
    {
        $this->rsState = self::RS_STATE_HEADER;
        $this->onResponse->executeOne($this, false);
        $this->checkFree();
        $this->resultRows = [];
        $this->resultFields = [];

        if (($this->phase === self::PHASE_AUTH_SENT) || ($this->phase === self::PHASE_GOT_INIT)) {

The strict comparison === seems to always evaluate to false as the types of $this->phase (string) and self::PHASE_AUTH_SENT (integer) can never be identical. Maybe you want to use a loose comparison == instead?

The strict comparison === seems to always evaluate to false as the types of $this->phase (string) and self::PHASE_GOT_INIT (integer) can never be identical. Maybe you want to use a loose comparison == instead?

            // in case of auth error
            $this->phase = self::PHASE_AUTH_ERR;

The property $phase was declared of type string, but self::PHASE_AUTH_ERR is of type integer. Maybe add a type cast?

            $this->finish();
        }

        Daemon::log(__METHOD__ . ' #' . $this->errno . ': ' . $this->errmsg);
    }
}