Number::buffer() - Code Metrics - Inspection of "Replace gmp_init($buffer->getInt()) with $buffer->..." - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#326)

by thomas

created 2016-06-28 15:09 UTC

Number::buffer() C

↳ Parent: Number

Complexity

Conditions	8
Paths	8

Size

Total Lines	22
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	8.2964

Importance

Changes

Metric	Value
cc	8
eloc	14
c	0
b	0
f	0
nc	8
nop	4
dl	0
loc	22
ccs	10
cts	12
cp	0.8333
crap	8.2964
rs	6.6037

<?php

namespace BitWasp\Bitcoin\Script\Interpreter;

use BitWasp\Bitcoin\Bitcoin;
use BitWasp\Bitcoin\Math\Math;
use BitWasp\Bitcoin\Serializable;
use BitWasp\Buffertools\Buffer;
use BitWasp\Buffertools\BufferInterface;

class Number extends Serializable
{
    const MAX_NUM_SIZE = 4;
    const MAX = 2**31-1;
    const MIN = -2**31+1;

    /**
     * @var Math
     */
    private $math;

    /**
     * @var int
     */
    private $number;

    /**
     * Number constructor.
     * @param int $number
     * @param Math $math
     */
    public function __construct($number, Math $math)
    {
        $this->number = $number;
        $this->math = $math;
    }

    /**
     * @param int $number
     * @param Math|null $math
     * @return self
     */
    public static function int($number, Math $math = null)
    {
        return new self(
            $number,
            $math ?: Bitcoin::getMath()
        );
    }

    /**
     * @param \GMP $number
     * @param Math|null $math
     * @return self
     */
    public static function gmp(\GMP $number, Math $math = null)
    {
        return new self(
            gmp_strval($number, 10),
            $math ?: Bitcoin::getMath()
        );
    }

    /**
     * @param BufferInterface $vch
     * @param bool $fRequireMinimal
     * @param int $maxNumSize
     * @param Math|null $math
     * @return self
     */
    public static function buffer(BufferInterface $vch, $fRequireMinimal, $maxNumSize = self::MAX_NUM_SIZE, Math $math = null)
    {
        $size = $vch->getSize();
        if ($size > $maxNumSize) {
            throw new \RuntimeException('Script number overflow');
        }

        if ($fRequireMinimal && $size > 0) {
            $binary = $vch->getBinary();
            $chars = array_values(unpack("C*", $binary));
            if ($chars[$size - 1] & 0x7f === 0) {
                if ($size <= 1 || $chars[$size - 2] & 0x80 === 0) {
                    throw new \RuntimeException('Non-minimally encoded script number');
                }
            }
        }

        $math = $math ?: Bitcoin::getMath();
        $number = new self(0, $math);
        $number->number = $number->parseBuffer($vch);
$answer = 42;

$correct = false;

$correct = (bool) $answer;
        return $number;
    }

    /**
     * @param BufferInterface $buffer
     * @return int
     */
    private function parseBuffer(BufferInterface $buffer)
    {
        $size = $buffer->getSize();
        if ($size === 0) {
            return '0';
        }

        $chars = array_values(unpack("C*", $buffer->getBinary()));

        $result = gmp_init(0);
        for ($i = 0; $i < $size; $i++) {
            $mul = $i * 8;
            $byte = $this->math->leftShift(gmp_init($chars[$i], 10), $mul);
            $result = $this->math->bitwiseOr($result, $byte);
        }

        if ($chars[count($chars)-1] & 0x80) {
            $mask = gmp_com($this->math->leftShift(gmp_init(0x80), (8 * ($size - 1))));
            $result = $this->math->sub(gmp_init(0), $this->math->bitwiseAnd($result, $mask));
        }

        return gmp_strval($result, 10);
    }

    /**
     * @return BufferInterface
     */
    private function serialize()
    {
        if ($this->number == 0) {
            return new Buffer('', 0);
        }

        $zero = gmp_init(0);
        // Using array of integers instead of bytes
        $result = [];
        $negative = $this->math->cmp(gmp_init($this->number), $zero) < 0;
        $abs = $negative ? $this->math->sub($zero, gmp_init($this->number, 10)) : gmp_init($this->number, 10);
        $mask = gmp_init(0xff);
        while ($this->math->cmp($abs, $zero) > 0) {
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $result[] = (int) gmp_strval($this->math->bitwiseAnd($abs, $mask), 10);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $abs = $this->math->rightShift($abs, 8);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }

        if ($result[count($result) - 1] & 0x80) {
            $result[] = $negative ? 0x80 : 0;
        } else if ($negative) {
            $result[count($result) - 1] |= 0x80;
        }

        $s = '';
        foreach ($result as $i) {
            $s .= chr($i);
        }

        return new Buffer($s, null, $this->math);

    }

    /**
     * @return BufferInterface
     */
    public function getBuffer()
    {
        return $this->serialize();
    }

    /**
     * @return int
     */
    public function getInt()
    {
        if ($this->math->cmp(gmp_init($this->number, 10), gmp_init(self::MAX)) > 0) {
            return self::MAX;
        } else if ($this->math->cmp(gmp_init($this->number, 10), gmp_init(self::MIN)) < 0) {
            return self::MIN;
        }

        return $this->number;
    }

    /**
     * @return \GMP
     */
    public function getGmp()
    {
        return gmp_init($this->number, 10);
    }
}


1		<?php
2
3		namespace BitWasp\Bitcoin\Script\Interpreter;
4
5		use BitWasp\Bitcoin\Bitcoin;
6		use BitWasp\Bitcoin\Math\Math;
7		use BitWasp\Bitcoin\Serializable;
8		use BitWasp\Buffertools\Buffer;
9		use BitWasp\Buffertools\BufferInterface;
10
11		class Number extends Serializable
12		{
13		const MAX_NUM_SIZE = 4;
14		const MAX = 2**31-1;
15		const MIN = -2**31+1;
16
17		/**
18		* @var Math
19		*/
20		private $math;
21
22		/**
23		* @var int
24		*/
25		private $number;
26
27		/**
28		* Number constructor.
29		* @param int $number
30		* @param Math $math
31		*/
32	225	public function __construct($number, Math $math)
33		{
34	225	$this->number = $number;
35	225	$this->math = $math;
36	225	}
37
38		/**
39		* @param int $number
40		* @param Math\|null $math
41		* @return self
42		*/
43	183	public static function int($number, Math $math = null)
44		{
45	183	return new self(
46	122	$number,
47	183	$math ?: Bitcoin::getMath()
48	122	);
49		}
50
51		/**
52		* @param \GMP $number
53		* @param Math\|null $math
54		* @return self
55		*/
56		public static function gmp(\GMP $number, Math $math = null)
57		{
58	144	return new self(
59		gmp_strval($number, 10),
60	144	$math ?: Bitcoin::getMath()
61	144	);
62		}
63
64		/**
65	144	* @param BufferInterface $vch
66		* @param bool $fRequireMinimal
67		* @param int $maxNumSize
68		* @param Math\|null $math
69		* @return self
70		*/
71		public static function buffer(BufferInterface $vch, $fRequireMinimal, $maxNumSize = self::MAX_NUM_SIZE, Math $math = null)
72		{
73		$size = $vch->getSize();
74	144	if ($size > $maxNumSize) {
75	144	throw new \RuntimeException('Script number overflow');
76	144	}
77	144
78		if ($fRequireMinimal && $size > 0) {
79		$binary = $vch->getBinary();
80		$chars = array_values(unpack("C*", $binary));
81		if ($chars[$size - 1] & 0x7f === 0) {
82		if ($size <= 1 \|\| $chars[$size - 2] & 0x80 === 0) {
83		throw new \RuntimeException('Non-minimally encoded script number');
84	144	}
85		}
86	144	}
87	144
88	33	$math = $math ?: Bitcoin::getMath();
89		$number = new self(0, $math);
90		$number->number = $number->parseBuffer($vch);
		0 ignored issues – show Documentation Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report The property `$number` was declared of type `integer`, but `$number->parseBuffer($vch)` is of type `string`. Maybe add a type cast? This check looks for assignments to scalar types that may be of the wrong type. To ensure the code behaves as expected, it may be a good idea to add an explicit type cast. $answer = 42; $correct = false; $correct = (bool) $answer; Loading history...
91	132	return $number;
92	132	}
93
94	132	/**
95		* @param BufferInterface $buffer
96	132	* @return int
97	132	*/
98	132	private function parseBuffer(BufferInterface $buffer)
99	132	{
100	132	$size = $buffer->getSize();
101	88	if ($size === 0) {
102		return '0';
103	132	}
104	15
105	15	$chars = array_values(unpack("C*", $buffer->getBinary()));
106	10
107		$result = gmp_init(0);
108	132	for ($i = 0; $i < $size; $i++) {
109		$mul = $i * 8;
110		$byte = $this->math->leftShift(gmp_init($chars[$i], 10), $mul);
111		$result = $this->math->bitwiseOr($result, $byte);
112		}
113
114	183	if ($chars[count($chars)-1] & 0x80) {
115		$mask = gmp_com($this->math->leftShift(gmp_init(0x80), (8 * ($size - 1))));
116	183	$result = $this->math->sub(gmp_init(0), $this->math->bitwiseAnd($result, $mask));
117	51	}
118
119		return gmp_strval($result, 10);
120	153	}
121
122	153	/**
123	153	* @return BufferInterface
124	153	*/
125		private function serialize()
126	153	{
127	153	if ($this->number == 0) {
128	153	return new Buffer('', 0);
129	102	}
130
131	153	$zero = gmp_init(0);
132	6	// Using array of integers instead of bytes
133	151	$result = [];
134	12	$negative = $this->math->cmp(gmp_init($this->number), $zero) < 0;
135	8	$abs = $negative ? $this->math->sub($zero, gmp_init($this->number, 10)) : gmp_init($this->number, 10);
136		$mask = gmp_init(0xff);
137	153	while ($this->math->cmp($abs, $zero) > 0) {
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$abs` defined by `$negative ? $this->math-...init($this->number, 10)` on line `135` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::cmp()` does only seem to accept `object<GMP>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
138	153	$result[] = (int) gmp_strval($this->math->bitwiseAnd($abs, $mask), 10);
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$abs` defined by `$negative ? $this->math-...init($this->number, 10)` on line `135` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::bitwiseAnd()` does only seem to accept `object<GMP>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
139	153	$abs = $this->math->rightShift($abs, 8);
		0 ignored issues – show Bug introduced 2016-06-17 14:28 UTC by Report Bug Copy Issue Report It seems like `$abs` can also be of type `resource`; however, `Mdanter\Ecc\Math\GmpMath::rightShift()` does only seem to accept `object<GMP>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
140	102	}
141
142	153	if ($result[count($result) - 1] & 0x80) {
143		$result[] = $negative ? 0x80 : 0;
144		} else if ($negative) {
145		$result[count($result) - 1] \|= 0x80;
146		}
147
148		$s = '';
149	183	foreach ($result as $i) {
150		$s .= chr($i);
151	183	}
152
153		return new Buffer($s, null, $this->math);
154
155		}
156
157	144	/**
158		* @return BufferInterface
159	144	*/
160		public function getBuffer()
161	144	{
162		return $this->serialize();
163		}
164
165	144	/**
166		* @return int
167		*/
168		public function getInt()
169		{
170		if ($this->math->cmp(gmp_init($this->number, 10), gmp_init(self::MAX)) > 0) {
171		return self::MAX;
172		} else if ($this->math->cmp(gmp_init($this->number, 10), gmp_init(self::MIN)) < 0) {
173		return self::MIN;
174		}
175
176		return $this->number;
177		}
178
179		/**
180		* @return \GMP
181		*/
182		public function getGmp()
183		{
184		return gmp_init($this->number, 10);
185		}
186		}
187

Bit-Wasp / bitcoin-php

Pull Request — master (#326)

Number::buffer() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like