QRDataAbstract::writeBitBuffer() - Code Metrics - Inspection of ":shower:" - chillerlan/php-qrcode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ef42ef...514bca )

by smiley

created 2020-03-03 09:15 UTC

QRDataAbstract::writeBitBuffer() B

↳ Parent: Project

Complexity

Conditions	7
Paths	13

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
nc	13
nop	1
dl	0
loc	46
rs	8.2448
c	0
b	0
f	0

<?php
/**
 * Class QRDataAbstract
 *
 * @filesource   QRDataAbstract.php
 * @created      25.11.2015
 * @package      chillerlan\QRCode\Data
 * @author       Smiley <[email protected]>
 * @copyright    2015 Smiley
 * @license      MIT
 */

namespace chillerlan\QRCode\Data;

use chillerlan\QRCode\QRCode;
use chillerlan\QRCode\Helpers\{BitBuffer, Polynomial};
use chillerlan\Settings\SettingsContainerInterface;

use function array_fill, array_merge, count, max, mb_convert_encoding, mb_detect_encoding, range, sprintf, strlen;

/**
 * Processes the binary data and maps it on a matrix which is then being returned
 */
abstract class QRDataAbstract implements QRDataInterface{

	/**
	 * the string byte count
	 */
	protected ?int $strlen = null;


	/**
	 * the current data mode: Num, Alphanum, Kanji, Byte
	 */
	protected int $datamode;

	/**
	 * mode length bits for the version breakpoints 1-9, 10-26 and 27-40
	 */
	protected array $lengthBits = [0, 0, 0];

	/**
	 * current QR Code version
	 */
	protected int $version;

	/**
	 * the raw data that's being passed to QRMatrix::mapData()
	 */
	protected array $matrixdata;

	/**
	 * ECC temp data
	 */
	protected array $ecdata;

	/**
	 * ECC temp data
	 */
	protected array $dcdata;

	/**
	 * @var \chillerlan\Settings\SettingsContainerInterface|\chillerlan\QRCode\QROptions
	 */
	protected SettingsContainerInterface $options;

	/**
	 * a BitBuffer instance
	 */
	protected BitBuffer $bitBuffer;

	/**
	 * QRDataInterface constructor.
	 */
	public function __construct(SettingsContainerInterface $options, string $data = null){
		$this->options = $options;

		if($data !== null){
			$this->setData($data);
		}
	}

	/**
	 * @inheritDoc
	 */
	public function setData(string $data):QRDataInterface{

		if($this->datamode === QRCode::DATA_KANJI){
			$data = mb_convert_encoding($data, 'SJIS', mb_detect_encoding($data));
		}

		$this->strlen  = $this->getLength($data);
		$this->version = $this->options->version === QRCode::VERSION_AUTO
			? $this->getMinimumVersion()
			: $this->options->version;

		$this->writeBitBuffer($data);
		$this->matrixdata = $this->maskECC();

		return $this;
	}

	/**
	 * @inheritDoc
	 */
	public function initMatrix(int $maskPattern, bool $test = null):QRMatrix{
		return (new QRMatrix($this->version, $this->options->eccLevel))
			->init($maskPattern, $test)
			->mapData($this->matrixdata, $maskPattern)
		;
	}

	/**
	 * returns the length bits for the version breakpoints 1-9, 10-26 and 27-40
	 *
	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
	 * @codeCoverageIgnore
	 */
	protected function getLengthBits():int{

		 foreach([9, 26, 40] as $key => $breakpoint){
			 if($this->version <= $breakpoint){
				 return $this->lengthBits[$key];
			 }
		 }

		throw new QRCodeDataException(sprintf('invalid version number: %d', $this->version));
	}

	/**
	 * returns the byte count of the $data string
	 */
	protected function getLength(string $data):int{
		return strlen($data);
	}

	/**
	 * returns the minimum version number for the given string
	 *
	 * @throws \chillerlan\QRCode\Data\QRCodeDataException
	 */
	protected function getMinimumVersion():int{
		$maxlength = 0;

		// guess the version number within the given range
		$dataMode = QRCode::DATA_MODES[$this->datamode];
		$eccMode  = QRCode::ECC_MODES[$this->options->eccLevel];

		foreach(range($this->options->versionMin, $this->options->versionMax) as $version){
			$maxlength = $this::MAX_LENGTH[$version][$dataMode][$eccMode];

			if($this->strlen <= $maxlength){
				return $version;
			}
		}

		throw new QRCodeDataException(sprintf('data exceeds %d characters', $maxlength));
	}

	/**
	 * writes the actual data string to the BitBuffer
	 *
	 * @see \chillerlan\QRCode\Data\QRDataAbstract::writeBitBuffer()
	 */
	abstract protected function write(string $data):void;

	/**
	 * creates a BitBuffer and writes the string data to it
	 *
	 * @throws \chillerlan\QRCode\QRCodeException
	 */
	protected function writeBitBuffer(string $data):void{
		$this->bitBuffer = new BitBuffer;

		$MAX_BITS = $this::MAX_BITS[$this->version][QRCode::ECC_MODES[$this->options->eccLevel]];

		$this->bitBuffer
			->clear()
			->put($this->datamode, 4)
			->put($this->strlen, $this->getLengthBits())
		;

		$this->write($data);

		// overflow, likely caused due to invalid version setting
		if($this->bitBuffer->length > $MAX_BITS){
			throw new QRCodeDataException(sprintf('code length overflow. (%d > %d bit)', $this->bitBuffer->length, $MAX_BITS));
		}

		// end code.
		if($this->bitBuffer->length + 4 <= $MAX_BITS){
			$this->bitBuffer->put(0, 4);
		}

		// padding
		while($this->bitBuffer->length % 8 !== 0){
			$this->bitBuffer->putBit(false);
		}

		// padding
		while(true){

			if($this->bitBuffer->length >= $MAX_BITS){
				break;
			}

			$this->bitBuffer->put(0xEC, 8);

			if($this->bitBuffer->length >= $MAX_BITS){
				break;
			}

			$this->bitBuffer->put(0x11, 8);
		}

	}

	/**
	 * ECC masking
	 *
	 * @link http://www.thonky.com/qr-code-tutorial/error-correction-coding
	 */
	protected function maskECC():array{
		[$l1, $l2, $b1, $b2] = $this::RSBLOCKS[$this->version][QRCode::ECC_MODES[$this->options->eccLevel]];

		$rsBlocks     = array_fill(0, $l1, [$b1, $b2]);
		$rsCount      = $l1 + $l2;
		$this->ecdata = array_fill(0, $rsCount, []);
		$this->dcdata = $this->ecdata;

		if($l2 > 0){
			$rsBlocks = array_merge($rsBlocks, array_fill(0, $l2, [$b1 + 1, $b2 + 1]));
		}

		$totalCodeCount = 0;
		$maxDcCount     = 0;
		$maxEcCount     = 0;
		$offset         = 0;

		foreach($rsBlocks as $key => $block){
			[$rsBlockTotal, $dcCount] = $block;

			$ecCount            = $rsBlockTotal - $dcCount;
			$maxDcCount         = max($maxDcCount, $dcCount);
			$maxEcCount         = max($maxEcCount, $ecCount);
			$this->dcdata[$key] = array_fill(0, $dcCount, null);

			foreach($this->dcdata[$key] as $a => $_z){
				$this->dcdata[$key][$a] = 0xff & $this->bitBuffer->buffer[$a + $offset];
			}

			[$num, $add] = $this->poly($key, $ecCount);

			foreach($this->ecdata[$key] as $c => $_z){
				$modIndex               = $c + $add;
				$this->ecdata[$key][$c] = $modIndex >= 0 ? $num[$modIndex] : 0;
			}

			$offset         += $dcCount;
			$totalCodeCount += $rsBlockTotal;
		}

		$data  = array_fill(0, $totalCodeCount, null);
		$index = 0;

		$mask = function(array $arr, int $count) use (&$data, &$index, $rsCount){
			for($x = 0; $x < $count; $x++){
				for($y = 0; $y < $rsCount; $y++){
					if($x < count($arr[$y])){
						$data[$index] = $arr[$y][$x];
						$index++;
					}
				}
			}
		};

		$mask($this->dcdata, $maxDcCount);
		$mask($this->ecdata, $maxEcCount);

		return $data;
	}

	/**
	 *
	 */
	protected function poly(int $key, int $count):array{
		$rsPoly  = new Polynomial;
		$modPoly = new Polynomial;

		for($i = 0; $i < $count; $i++){
			$modPoly->setNum([1, $modPoly->gexp($i)]);
			$rsPoly->multiply($modPoly->getNum());
		}

		$rsPolyCount = count($rsPoly->getNum());

		$modPoly
			->setNum($this->dcdata[$key], $rsPolyCount - 1)
			->mod($rsPoly->getNum())
		;

		$this->ecdata[$key] = array_fill(0, $rsPolyCount - 1, null);
		$num                = $modPoly->getNum();

		return [
			$num,
			count($num) - count($this->ecdata[$key]),
		];
	}

}


1			<?php
2			/**
3			* Class QRDataAbstract
4			*
5			* @filesource QRDataAbstract.php
6			* @created 25.11.2015
7			* @package chillerlan\QRCode\Data
8			* @author Smiley <[email protected]>
9			* @copyright 2015 Smiley
10			* @license MIT
11			*/
12
13			namespace chillerlan\QRCode\Data;
14
15			use chillerlan\QRCode\QRCode;
16			use chillerlan\QRCode\Helpers\{BitBuffer, Polynomial};
17			use chillerlan\Settings\SettingsContainerInterface;
18
19			use function array_fill, array_merge, count, max, mb_convert_encoding, mb_detect_encoding, range, sprintf, strlen;
20
21			/**
22			* Processes the binary data and maps it on a matrix which is then being returned
23			*/
24			abstract class QRDataAbstract implements QRDataInterface{
25
26			/**
27			* the string byte count
28			*/
29			protected ?int $strlen = null;
			0 ignored issues – show Bug introduced 2020-03-03 09:21 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected '?', expecting T_FUNCTION or T_CONST Loading history...
30
31			/**
32			* the current data mode: Num, Alphanum, Kanji, Byte
33			*/
34			protected int $datamode;
35
36			/**
37			* mode length bits for the version breakpoints 1-9, 10-26 and 27-40
38			*/
39			protected array $lengthBits = [0, 0, 0];
40
41			/**
42			* current QR Code version
43			*/
44			protected int $version;
45
46			/**
47			* the raw data that's being passed to QRMatrix::mapData()
48			*/
49			protected array $matrixdata;
50
51			/**
52			* ECC temp data
53			*/
54			protected array $ecdata;
55
56			/**
57			* ECC temp data
58			*/
59			protected array $dcdata;
60
61			/**
62			* @var \chillerlan\Settings\SettingsContainerInterface\|\chillerlan\QRCode\QROptions
63			*/
64			protected SettingsContainerInterface $options;
65
66			/**
67			* a BitBuffer instance
68			*/
69			protected BitBuffer $bitBuffer;
70
71			/**
72			* QRDataInterface constructor.
73			*/
74			public function __construct(SettingsContainerInterface $options, string $data = null){
75			$this->options = $options;
76
77			if($data !== null){
78			$this->setData($data);
79			}
80			}
81
82			/**
83			* @inheritDoc
84			*/
85			public function setData(string $data):QRDataInterface{
86
87			if($this->datamode === QRCode::DATA_KANJI){
88			$data = mb_convert_encoding($data, 'SJIS', mb_detect_encoding($data));
89			}
90
91			$this->strlen = $this->getLength($data);
92			$this->version = $this->options->version === QRCode::VERSION_AUTO
93			? $this->getMinimumVersion()
94			: $this->options->version;
95
96			$this->writeBitBuffer($data);
97			$this->matrixdata = $this->maskECC();
98
99			return $this;
100			}
101
102			/**
103			* @inheritDoc
104			*/
105			public function initMatrix(int $maskPattern, bool $test = null):QRMatrix{
106			return (new QRMatrix($this->version, $this->options->eccLevel))
107			->init($maskPattern, $test)
108			->mapData($this->matrixdata, $maskPattern)
109			;
110			}
111
112			/**
113			* returns the length bits for the version breakpoints 1-9, 10-26 and 27-40
114			*
115			* @throws \chillerlan\QRCode\Data\QRCodeDataException
116			* @codeCoverageIgnore
117			*/
118			protected function getLengthBits():int{
119
120			foreach([9, 26, 40] as $key => $breakpoint){
121			if($this->version <= $breakpoint){
122			return $this->lengthBits[$key];
123			}
124			}
125
126			throw new QRCodeDataException(sprintf('invalid version number: %d', $this->version));
127			}
128
129			/**
130			* returns the byte count of the $data string
131			*/
132			protected function getLength(string $data):int{
133			return strlen($data);
134			}
135
136			/**
137			* returns the minimum version number for the given string
138			*
139			* @throws \chillerlan\QRCode\Data\QRCodeDataException
140			*/
141			protected function getMinimumVersion():int{
142			$maxlength = 0;
143
144			// guess the version number within the given range
145			$dataMode = QRCode::DATA_MODES[$this->datamode];
146			$eccMode = QRCode::ECC_MODES[$this->options->eccLevel];
147
148			foreach(range($this->options->versionMin, $this->options->versionMax) as $version){
149			$maxlength = $this::MAX_LENGTH[$version][$dataMode][$eccMode];
150
151			if($this->strlen <= $maxlength){
152			return $version;
153			}
154			}
155
156			throw new QRCodeDataException(sprintf('data exceeds %d characters', $maxlength));
157			}
158
159			/**
160			* writes the actual data string to the BitBuffer
161			*
162			* @see \chillerlan\QRCode\Data\QRDataAbstract::writeBitBuffer()
163			*/
164			abstract protected function write(string $data):void;
165
166			/**
167			* creates a BitBuffer and writes the string data to it
168			*
169			* @throws \chillerlan\QRCode\QRCodeException
170			*/
171			protected function writeBitBuffer(string $data):void{
172			$this->bitBuffer = new BitBuffer;
173
174			$MAX_BITS = $this::MAX_BITS[$this->version][QRCode::ECC_MODES[$this->options->eccLevel]];
175
176			$this->bitBuffer
177			->clear()
178			->put($this->datamode, 4)
179			->put($this->strlen, $this->getLengthBits())
180			;
181
182			$this->write($data);
183
184			// overflow, likely caused due to invalid version setting
185			if($this->bitBuffer->length > $MAX_BITS){
186			throw new QRCodeDataException(sprintf('code length overflow. (%d > %d bit)', $this->bitBuffer->length, $MAX_BITS));
187			}
188
189			// end code.
190			if($this->bitBuffer->length + 4 <= $MAX_BITS){
191			$this->bitBuffer->put(0, 4);
192			}
193
194			// padding
195			while($this->bitBuffer->length % 8 !== 0){
196			$this->bitBuffer->putBit(false);
197			}
198
199			// padding
200			while(true){
201
202			if($this->bitBuffer->length >= $MAX_BITS){
203			break;
204			}
205
206			$this->bitBuffer->put(0xEC, 8);
207
208			if($this->bitBuffer->length >= $MAX_BITS){
209			break;
210			}
211
212			$this->bitBuffer->put(0x11, 8);
213			}
214
215			}
216
217			/**
218			* ECC masking
219			*
220			* @link http://www.thonky.com/qr-code-tutorial/error-correction-coding
221			*/
222			protected function maskECC():array{
223			[$l1, $l2, $b1, $b2] = $this::RSBLOCKS[$this->version][QRCode::ECC_MODES[$this->options->eccLevel]];
224
225			$rsBlocks = array_fill(0, $l1, [$b1, $b2]);
226			$rsCount = $l1 + $l2;
227			$this->ecdata = array_fill(0, $rsCount, []);
228			$this->dcdata = $this->ecdata;
229
230			if($l2 > 0){
231			$rsBlocks = array_merge($rsBlocks, array_fill(0, $l2, [$b1 + 1, $b2 + 1]));
232			}
233
234			$totalCodeCount = 0;
235			$maxDcCount = 0;
236			$maxEcCount = 0;
237			$offset = 0;
238
239			foreach($rsBlocks as $key => $block){
240			[$rsBlockTotal, $dcCount] = $block;
241
242			$ecCount = $rsBlockTotal - $dcCount;
243			$maxDcCount = max($maxDcCount, $dcCount);
244			$maxEcCount = max($maxEcCount, $ecCount);
245			$this->dcdata[$key] = array_fill(0, $dcCount, null);
246
247			foreach($this->dcdata[$key] as $a => $_z){
248			$this->dcdata[$key][$a] = 0xff & $this->bitBuffer->buffer[$a + $offset];
249			}
250
251			[$num, $add] = $this->poly($key, $ecCount);
252
253			foreach($this->ecdata[$key] as $c => $_z){
254			$modIndex = $c + $add;
255			$this->ecdata[$key][$c] = $modIndex >= 0 ? $num[$modIndex] : 0;
256			}
257
258			$offset += $dcCount;
259			$totalCodeCount += $rsBlockTotal;
260			}
261
262			$data = array_fill(0, $totalCodeCount, null);
263			$index = 0;
264
265			$mask = function(array $arr, int $count) use (&$data, &$index, $rsCount){
266			for($x = 0; $x < $count; $x++){
267			for($y = 0; $y < $rsCount; $y++){
268			if($x < count($arr[$y])){
269			$data[$index] = $arr[$y][$x];
270			$index++;
271			}
272			}
273			}
274			};
275
276			$mask($this->dcdata, $maxDcCount);
277			$mask($this->ecdata, $maxEcCount);
278
279			return $data;
280			}
281
282			/**
283			*
284			*/
285			protected function poly(int $key, int $count):array{
286			$rsPoly = new Polynomial;
287			$modPoly = new Polynomial;
288
289			for($i = 0; $i < $count; $i++){
290			$modPoly->setNum([1, $modPoly->gexp($i)]);
291			$rsPoly->multiply($modPoly->getNum());
292			}
293
294			$rsPolyCount = count($rsPoly->getNum());
295
296			$modPoly
297			->setNum($this->dcdata[$key], $rsPolyCount - 1)
298			->mod($rsPoly->getNum())
299			;
300
301			$this->ecdata[$key] = array_fill(0, $rsPolyCount - 1, null);
302			$num = $modPoly->getNum();
303
304			return [
305			$num,
306			count($num) - count($this->ecdata[$key]),
307			];
308			}
309
310			}
311

chillerlan / php-qrcode

Push — master ( ef42ef...514bca )

QRDataAbstract::writeBitBuffer() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like