PlasmaPHP / driver-mysql

src/Commands/StatementExecuteCommand.php

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

/**
 * Statement Execute command.
 * @internal
 */
class StatementExecuteCommand extends QueryCommand {
    /**
     * The identifier for this command.
     * @var int
     * @source
     */
    const COMMAND_ID = 0x17;
    
    /**
     * @var mixed
     */
    protected $id;
    
    /**
     * @var array
     */
    protected $params;
    
    /**
     * Constructor.
     * @param \Plasma\DriverInterface  $driver
     * @param mixed                    $id
     * @param string                   $query
     * @param array                    $params
     */
    function __construct(\Plasma\DriverInterface $driver, $id, string $query, array $params) {
        parent::__construct($driver, $query);
        
        $this->id = $id;
        $this->params = $params;
    }
    
    /**
     * Get the encoded message for writing to the database connection.
     * @return string
     */
    function getEncodedMessage(): string {
        $packet = \chr(static::COMMAND_ID);
        $packet .= \Plasma\BinaryBuffer::writeInt4($this->id);
        
        $packet .= "\0"; // Cursor type flag
        $packet .= \Plasma\BinaryBuffer::writeInt4(1); // Iteration count is always 1
        
        $paramCount = \count($this->params);
        
        $bitmapOffset = \strlen($packet);
        $packet .= \str_repeat("\0", (($paramCount + 7) >> 3));
        
        $bound = 0;
        
        $types = '';
        $values = '';
        
        foreach($this->params as $id => $param) {
            if($param === null) {
                $offset = $bitmapOffset + ($id >> 3);
                $packet[$offset] = $packet[$offset] | \chr((1 << ($id % 8)));
            } else {
                $bound = 1;
            }
            
            $unsigned = false;
            
            try {
                $manager = \Plasma\Types\TypeExtensionsManager::getManager('driver-mysql');
                $encode = $manager->encodeType($param);
                
                $unsigned = $encode->isUnsigned();
                $type = $encode->getSQLType();
                $value = $encode->getValue();
            } catch (\Plasma\Exception $e) {
                [ $unsigned, $type, $value ] = $this->stdEncodeValue($param);
            }
            
            $types .= \chr($type);
            $types .= ($unsigned ? "\x80" : "\0");
            
            $values .= $value;
        }
        
        $packet .= \chr($bound);
        
        if($bound) {
            $packet .= $types;
            $packet .= $values;
        }
        
        return $packet;
    }
    
    /**
     * Whether the sequence ID should be resetted.
     * @return bool
     */
    function resetSequence(): bool {
        return false;
    }
    
    /**
     * Parses the binary resultset row and returns the row.
     * @param \Plasma\ColumnDefinitionInterface  $column
     * @param \Plasma\BinaryBuffer               $buffer

Superfluous parameter comment

     * @return array
     */
    protected function parseResultsetRow(\Plasma\BinaryBuffer $buffer): array {
        //var_dump(unpack('C*', $buffer->getContents()));
        //$buffer = $buffer->read(1); // Skip first byte (header)
        
        $nullRow = array();
        $i = 0;
        
        /** @var \Plasma\ColumnDefinitionInterface  $column */
        foreach($this->fields as $column) { // Handle NULL-bitmap
            if((\ord($buffer[(($i + 2) >> 3)]) & (1 << (($i + 2) % 8))) !== 0) {
                $nullRow[$column->getName()] = null;
            }
            
            $i++;
        }
        
        $buffer->read(((\count($this->fields) + 9) >> 3)); // Remove NULL-bitmap
        $row = array();
        
        /** @var \Plasma\ColumnDefinitionInterface  $column */
        foreach($this->fields as $column) {
            if(\array_key_exists($columm->getName(), $nullRow)) {
                $row[$columm->getName()] = $nullRow[$columm->getName()];
                continue;
            }
            
            $value = $this->stdDecodeBinaryValue($column, $buffer);
            
            try {
                $strval = (string) $val;
                $value = $column->parseValue($strval);
            } catch (\Plasma\Exception $e) {
                /* Continue regardless of error */
            }
            
            $row[$column->getName()] = $value;
        }
        
        return $row;
    }
    
    /**
     * Standard encode value, if type extensions failed.
     * @param mixed  $param
     * @return array
     * @throws \Plasma\Exception
     */
    protected function stdEncodeValue($param): array {
        $unsigned = false;
        
        switch(\gettype($param)) {
            case 'boolean':
                $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_TINY;
                $value = ($param ? "\x01" : "\0");
            break;
            case 'integer':
                if($param >= 0) {
                    $unsigned = true;
                }
                
                // TODO: Check if short, long or long long
                if($param >= 0 && $param < (1 << 15)) {
                    $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_SHORT;
                    $value = \Plasma\BinaryBuffer::writeInt2($param);
                } elseif(\PHP_INT_SIZE === 4) {
                    $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_LONG;
                    $value = \Plasma\BinaryBuffer::writeInt4($param);
                } else {
                    $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_LONGLONG;
                    $value = \Plasma\BinaryBuffer::writeInt8($param);
                }

Line indented incorrectly; expected 12 spaces, found 16

            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case 'double':
                $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_DOUBLE;
                $value = \Plasma\BinaryBuffer::writeFloat($param);
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case 'string':
                $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_LONG_BLOB;
                
                $value = \Plasma\BinaryBuffer::writeInt4(\strlen($param));
                $value .= $param;
            break;
            case 'NULL':
                $type = \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_NULL;
                $value = '';
            break;
            default:
                throw new \Plasma\Exception('Unexpected type for binding parameter: '.\gettype($param));
            break;
        }
        
        return array($unsigned, $type, $value);
    }
    
    /**
     * Standard decode value, if type extensions failed.
     * @param \Plasma\ColumnDefinitionInterface  $column
     * @param \Plasma\BinaryBuffer               $buffer
     * @return mixed
     * @throws \Plasma\Exception
     */
    protected function stdDecodeBinaryValue(\Plasma\ColumnDefinitionInterface $column, \Plasma\BinaryBuffer $buffer) {
        $flags = $column->getFlags();
        
        switch(true) {
            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_TINY) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readInt1();
                $value = $this->zeroFillInts($column, $value);
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_SHORT) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_YEAR) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readInt2();
                $value = $this->zeroFillInts($column, $value);
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_INT24) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_LONG) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readInt4();
            
                if(($flags & \Plasma\Drivers\MySQL\FieldFlags::UNSIGNED_FLAG) !== 0 && \PHP_INT_SIZE <= 4) {

Line indented incorrectly; expected 12 spaces, found 16

                    $value = \bcadd($value, '18446744073709551616');
                }

Line indented incorrectly; expected 12 spaces, found 16

                
                $value = $this->zeroFillInts($column, $value);
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_LONGLONG) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readInt8();
                
                if(($flags & \Plasma\Drivers\MySQL\FieldFlags::UNSIGNED_FLAG) !== 0) {

Line indented incorrectly; expected 12 spaces, found 16

                    $value = \bcadd($value, '18446744073709551616');
                } elseif(\PHP_INT_SIZE > 4) {

Line indented incorrectly; expected 12 spaces, found 16

                    $value = (int) $value;
                }

Line indented incorrectly; expected 12 spaces, found 16

                
                $value = $this->zeroFillInts($column, $value);
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_FLOAT) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readFloat();
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_DOUBLE) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readDouble();
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_DATE) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_NEWDATE) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $length = $buffer->readIntLength();
                if($length > 0) {

Line indented incorrectly; expected 12 spaces, found 16

                    $year = $buffer->readInt2();
                    $month = $buffer->readInt1();
                    $day = $buffer->readInt1();
                    
                    $value = \sprintf('%d-%d-%d', $year, $month, $day);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $value = '0000-00-00';
                }

Line indented incorrectly; expected 12 spaces, found 16

            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_DATETIME) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_TIMESTAMP) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $length = $buffer->readIntLength();
                if($length > 0) {

Line indented incorrectly; expected 12 spaces, found 16

                    $year = $buffer->readInt2();
                    $month = $buffer->readInt1();
                    $day = $buffer->readInt1();
                    
                    if($length > 4) {

Line indented incorrectly; expected 16 spaces, found 20

                        $hour = $buffer->readInt1();
                        $min = $buffer->readInt1();
                        $sec = $buffer->readInt1();
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $hour = 0;
                        $min = 0;
                        $sec = 0;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    
                    if($length > 7) {

Line indented incorrectly; expected 16 spaces, found 20

                        $micro = $buffer->readInt4();
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $micro = 0;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    
                    $timestamp = (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_TIMESTAMP) !== 0);
                    
                    $micro = \str_pad($micro, 6, '0', \STR_PAD_LEFT);
                    $micro = ($timestamp ? $micro : \number_format($micro, 0, '', ' '));
                    
                    $value = \sprintf('%d-%d-%d %d:%d:%d'.($micro > 0 ? '.%s' : ''), $year, $month, $day, $hour, $min, $sec, $micro);
                    
                    if($timestamp) {

Line indented incorrectly; expected 16 spaces, found 20

                        $value = \DateTime::createFromFormat('Y-m-d H:i:s'.($micro > 0 ? '.u' : ''), $value)->getTimestamp();
                    }

Line indented incorrectly; expected 16 spaces, found 20

                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $value = '0000-00-00 00:00:00.000 000';
                }

Line indented incorrectly; expected 12 spaces, found 16

            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_TIME) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $length = $buffer->readIntLength();
                if($length > 0) {

Line indented incorrectly; expected 12 spaces, found 16

                    $sign = $buffer->readInt1();
                    $days = $buffer->readInt4();
                    
                    if($sign === 1) {

Line indented incorrectly; expected 16 spaces, found 20

                        $days *= -1;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    
                    $hour = $buffer->readInt1();
                    $min = $buffer->readInt1();
                    $sec = $buffer->readInt1();
                    
                    if($length > 8) {

Line indented incorrectly; expected 16 spaces, found 20

                        $micro = $buffer->readInt4();
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $micro = 0;
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    
                    $micro = \str_pad($micro, 6, '0', \STR_PAD_LEFT);
                    $micro = \number_format($micro, 0, '', ' ');
                    
                    $value = \sprintf('%dd %d:%d:%d'.($micro > 0 ? '.%s' : ''), $days, $hour, $min, $sec, $micro);
                } else {

Line indented incorrectly; expected 12 spaces, found 16

                    $value = '0d 00:00:00';
                }

Line indented incorrectly; expected 12 spaces, found 16

            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_STRING) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_VARCHAR) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_VAR_STRING) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_ENUM) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_SET) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_LONG_BLOB) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_MEDIUM_BLOB) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_BLOB) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_TINY_BLOB) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_GEOMETRY) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_BIT) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_DECIMAL) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_NEWDECIMAL) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_JSON) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = $buffer->readStringLength();
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            case (($flags & \Plasma\Drivers\MySQL\FieldFlags::FIELD_TYPE_NULL) !== 0):

Line indented incorrectly; expected 8 spaces, found 12

                $value = null;
            break;

Case breaking statement indented incorrectly; expected 16 spaces, found 12

            default:

Line indented incorrectly; expected 8 spaces, found 12

                throw new \InvalidArgumentException('Unknown column type (flags: '.$flags.', type: '.$column->getType().')');
            break;
        }
        
        return $value;
    }
    
    /**
     * @param \Plasma\ColumnDefinitionInterface  $column
     * @param string|int                         $value
     * @return string|int
     */
    protected function zeroFillInts(\Plasma\ColumnDefinitionInterface $column, $value) {
        $flags = $column->getFlags();
        
        if(($flags & \Plasma\Drivers\MySQL\FieldFlags::ZEROFILL_FLAG) !== 0) {
            $value = \str_pad(((string) $value), $column->getLength(), '0', \STR_PAD_LEFT);
        }
        
        return $value;
    }
}