MessagePack\BufferUnpacker

Complexity

Total Complexity

101

Size/Duplication

Total Lines	427
Duplicated Lines	22.72 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

100%

Importance

Changes	8
Bugs	0	Features	0

24 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	skip()	0	6	1
A	unpackUint8()	0	8	2
A	registerTransformer()	0	4	1
A	append()	0	6	1
A	reset()	0	7	1
B	tryUnpack()	0	21	5
D	unpack()	0	82	44
A	unpackUint16()	0	12	2
A	unpackUint32()	13	13	2
A	unpackUint64()	0	20	3
A	unpackInt8()	0	11	3
A	unpackInt16()	0	16	3
A	unpackInt32()	13	13	2
A	unpackInt64()	13	13	2
A	unpackFloat32()	13	13	2
A	unpackFloat64()	13	13	2
A	unpackStr()	0	11	2
B	unpackArrayLength()	16	16	5
A	unpackArray()	0	9	2
B	unpackMapLength()	16	16	5
A	unpackMap()	0	9	2
A	unpackExt()	0	21	4
A	handleIntOverflow()	0	11	3

<?php

/*
 * This file is part of the rybakit/msgpack.php package.
 *
 * (c) Eugene Leonovich <gen.work@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace MessagePack;

use MessagePack\Exception\InsufficientDataException;
use MessagePack\Exception\IntegerOverflowException;
use MessagePack\Exception\InvalidOptionException;
use MessagePack\Exception\UnpackingFailedException;
use MessagePack\TypeTransformer\Extension;

class BufferUnpacker
{
    private $buffer;
    private $offset = 0;
    private $isBigIntAsStr;
    private $isBigIntAsGmp;

    /**
     * @var Extension[]|null
     */
    private $transformers;

    /**
     * @param string $buffer
     * @param UnpackOptions|int|null $options
     *
     * @throws InvalidOptionException
     */
    public function __construct($buffer = '', $options = null)
    {
        if (!$options instanceof UnpackOptions) {
            $options = UnpackOptions::fromBitmask($options);
        }

        $this->isBigIntAsStr = $options->isBigIntAsStrMode();
        $this->isBigIntAsGmp = $options->isBigIntAsGmpMode();

        $this->buffer = $buffer;
    }

    public function registerTransformer(Extension $ext)
    {
        $this->transformers[$ext->getType()] = $ext;
    }

    /**
     * @param string $data
     *
     * @return $this
     */
    public function append($data)
    {
        $this->buffer .= $data;

        return $this;
    }

    /**
     * @param string $buffer
     *
     * @return $this
     */
    public function reset($buffer = '')
    {
        $this->buffer = $buffer;
        $this->offset = 0;

        return $this;
    }

    /**
     * @param int $length
     *
     * @return $this
     */
    public function skip($length)
    {
        $this->offset += $length;

        return $this;
    }

    /**
     * @return array
     */
    public function tryUnpack()
    {
        $data = [];
        $offset = $this->offset;

        try {
            do {
                $data[] = $this->unpack();
                $offset = $this->offset;
            } while (isset($this->buffer[$this->offset]));
        } catch (InsufficientDataException $e) {
            $this->offset = $offset;
        }

        if ($this->offset) {
            $this->buffer = isset($this->buffer[$this->offset]) ? \substr($this->buffer, $this->offset) : '';
            $this->offset = 0;
        }

        return $data;
    }

    /**
     * @throws UnpackingFailedException
     *
     * @return mixed
     */
    public function unpack()
    {
        if (!isset($this->buffer[$this->offset])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 1);
        }

        $c = \ord($this->buffer[$this->offset]);
        ++$this->offset;

        // fixint
        if ($c <= 0x7f) {
            return $c;
        }
        // fixstr
        if ($c >= 0xa0 && $c <= 0xbf) {
            return ($c & 0x1f) ? $this->unpackStr($c & 0x1f) : '';
        }
        // fixarray
        if ($c >= 0x90 && $c <= 0x9f) {
            return ($c & 0xf) ? $this->unpackArray($c & 0xf) : [];
        }
        // fixmap
        if ($c >= 0x80 && $c <= 0x8f) {
            return ($c & 0xf) ? $this->unpackMap($c & 0xf) : [];
        }
        // negfixint
        if ($c >= 0xe0) {
            return $c - 256;
        }

        switch ($c) {
            case 0xc0: return null;

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc2: return false;

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc3: return true;

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_BIN
            case 0xc4: return $this->unpackStr($this->unpackUint8());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc5: return $this->unpackStr($this->unpackUint16());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc6: return $this->unpackStr($this->unpackUint32());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_FLOAT
            case 0xca: return $this->unpackFloat32();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xcb: return $this->unpackFloat64();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_UINT
            case 0xcc: return $this->unpackUint8();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xcd: return $this->unpackUint16();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xce: return $this->unpackUint32();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xcf: return $this->unpackUint64();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_INT
            case 0xd0: return $this->unpackInt8();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd1: return $this->unpackInt16();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd2: return $this->unpackInt32();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd3: return $this->unpackInt64();

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_STR
            case 0xd9: return $this->unpackStr($this->unpackUint8());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xda: return $this->unpackStr($this->unpackUint16());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xdb: return $this->unpackStr($this->unpackUint32());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_ARRAY
            case 0xdc: return $this->unpackArray($this->unpackUint16());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xdd: return $this->unpackArray($this->unpackUint32());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_MAP
            case 0xde: return $this->unpackMap($this->unpackUint16());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xdf: return $this->unpackMap($this->unpackUint32());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            // MP_EXT
            case 0xd4: return $this->unpackExt(1);

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd5: return $this->unpackExt(2);

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd6: return $this->unpackExt(4);

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd7: return $this->unpackExt(8);

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xd8: return $this->unpackExt(16);

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc7: return $this->unpackExt($this->unpackUint8());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc8: return $this->unpackExt($this->unpackUint16());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

            case 0xc9: return $this->unpackExt($this->unpackUint32());

The case body in a switch statement must start on the line following the statement.

Terminating statement must be on a line by itself

        }

        throw new UnpackingFailedException(\sprintf('Unknown code: 0x%x.', $c));
    }

    public function unpackUint8()
    {
        if (!isset($this->buffer[$this->offset])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 1);
        }

        return \ord($this->buffer[$this->offset++]);
    }

    public function unpackUint16()
    {
        if (!isset($this->buffer[$this->offset + 1])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 2);
        }

        $hi = \ord($this->buffer[$this->offset]);
        $lo = \ord($this->buffer[$this->offset + 1]);
        $this->offset += 2;

        return $hi << 8 | $lo;
    }

    public function unpackUint32()

This method seems to be duplicated in your project.

    {
        if (!isset($this->buffer[$this->offset + 3])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 4);
        }

        $num = \substr($this->buffer, $this->offset, 4);
        $this->offset += 4;

        $num = \unpack('N', $num);

        return $num[1];
    }

    public function unpackUint64()
    {
        if (!isset($this->buffer[$this->offset + 7])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 8);
        }

        $num = \substr($this->buffer, $this->offset, 8);
        $this->offset += 8;

        //$num = \unpack('J', $num);

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

        $set = \unpack('N2', $num);
        $value = $set[1] << 32 | $set[2];

        // PHP does not support unsigned integers.
        // If a number is bigger than 2^63, it will be interpreted as a float.
        // @link http://php.net/manual/en/language.types.integer.php#language.types.integer.overflow

        return $value < 0 ? $this->handleIntOverflow($value) : $value;
    }

    public function unpackInt8()
    {
        if (!isset($this->buffer[$this->offset])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 1);
        }

        $num = \ord($this->buffer[$this->offset]);
        ++$this->offset;

        return $num > 0x7f ? $num - 256 : $num;
    }

    public function unpackInt16()
    {
        if (!isset($this->buffer[$this->offset + 1])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 2);
        }

        $hi = \ord($this->buffer[$this->offset]);
        $lo = \ord($this->buffer[$this->offset + 1]);
        $this->offset += 2;

        if ($hi > 0x7f) {
            return -(0x010000 - ($hi << 8 | $lo));
        }

        return $hi << 8 | $lo;
    }

    public function unpackInt32()

This method seems to be duplicated in your project.

    {
        if (!isset($this->buffer[$this->offset + 3])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 4);
        }

        $num = \substr($this->buffer, $this->offset, 4);
        $this->offset += 4;

        $num = \unpack('i', \strrev($num));

        return $num[1];
    }

    public function unpackInt64()

This method seems to be duplicated in your project.

    {
        if (!isset($this->buffer[$this->offset + 7])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 8);
        }

        $num = \substr($this->buffer, $this->offset, 8);
        $this->offset += 8;

        $set = \unpack('N2', $num);

        return $set[1] << 32 | $set[2];
    }

    public function unpackFloat32()

This method seems to be duplicated in your project.

    {
        if (!isset($this->buffer[$this->offset + 3])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 4);
        }

        $num = \substr($this->buffer, $this->offset, 4);
        $this->offset += 4;

        $num = \unpack('f', \strrev($num));

        return $num[1];
    }

    public function unpackFloat64()

This method seems to be duplicated in your project.

    {
        if (!isset($this->buffer[$this->offset + 7])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, 8);
        }

        $num = \substr($this->buffer, $this->offset, 8);
        $this->offset += 8;

        $num = \unpack('d', \strrev($num));

        return $num[1];
    }

    public function unpackStr($length)
    {
        if (!isset($this->buffer[$this->offset + $length - 1])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, $length);
        }

        $str = \substr($this->buffer, $this->offset, $length);
        $this->offset += $length;

        return $str;
    }

    public function unpackArrayLength()

This method seems to be duplicated in your project.

    {
        $c = $this->unpackUint8();

        if ($c >= 0x90 && $c <= 0x9f) {
            return $c & 0xf;
        }
        if (0xdc === $c) {
            return $this->unpackUint16();
        }
        if (0xdd === $c) {
            return $this->unpackUint32();
        }

        throw new UnpackingFailedException(\sprintf('Unknown array header code: 0x%x.', $c));
    }

    public function unpackArray($size)
    {
        $array = [];
        while ($size--) {
            $array[] = $this->unpack();
        }

        return $array;
    }

    public function unpackMapLength()

This method seems to be duplicated in your project.

    {
        $c = $this->unpackUint8();

        if ($c >= 0x80 && $c <= 0x8f) {
            return $c & 0xf;
        }
        if (0xde === $c) {
            return $this->unpackUint16();
        }
        if (0xdf === $c) {
            return $this->unpackUint32();
        }

        throw new UnpackingFailedException(\sprintf('Unknown map header code: 0x%x.', $c));
    }

    public function unpackMap($size)
    {
        $map = [];
        while ($size--) {
            $map[$this->unpack()] = $this->unpack();
        }

        return $map;
    }

    public function unpackExt($length)
    {
        if (!isset($this->buffer[$this->offset + $length - 1])) {
            throw InsufficientDataException::fromOffset($this->buffer, $this->offset, $length);
        }

        // int8
        $num = \ord($this->buffer[$this->offset]);
        ++$this->offset;

        $type = $num > 0x7f ? $num - 256 : $num;

        if (isset($this->transformers[$type])) {
            return $this->transformers[$type]->unpack($this, $length);
        }

        $data = \substr($this->buffer, $this->offset, $length);
        $this->offset += $length;

        return new Ext($type, $data);
    }

    private function handleIntOverflow($value)
    {
        if ($this->isBigIntAsStr) {
            return \sprintf('%u', $value);
        }
        if ($this->isBigIntAsGmp) {
            return \gmp_init(\sprintf('%u', $value));
        }

        throw new IntegerOverflowException($value);
    }
}