Version.php — WP 2FA – Two-factor authentication for WordPress 2.9.0

wp-2fa / includes / classes / bacon / bacon-qr-code / src / Common / Version.php

wp-2fa / includes / classes / bacon / bacon-qr-code / src / Common Last commit date

BitArray.php 11 months ago BitMatrix.php 11 months ago BitUtils.php 11 months ago CharacterSetEci.php 11 months ago EcBlock.php 11 months ago EcBlocks.php 11 months ago ErrorCorrectionLevel.php 11 months ago FormatInformation.php 11 months ago Mode.php 11 months ago ReedSolomonCodec.php 11 months ago Version.php 11 months ago

Version.php

201 lines

1	<?php
2
3	declare (strict_types=1);
4	namespace WP2FA_Vendor\BaconQrCode\Common;
5
6	use WP2FA_Vendor\BaconQrCode\Exception\InvalidArgumentException;
7	use SplFixedArray;
8	/**
9	* Version representation.
10	*/
11	final class Version
12	{
13	private const VERSION_DECODE_INFO = [0x7c94, 0x85bc, 0x9a99, 0xa4d3, 0xbbf6, 0xc762, 0xd847, 0xe60d, 0xf928, 0x10b78, 0x1145d, 0x12a17, 0x13532, 0x149a6, 0x15683, 0x168c9, 0x177ec, 0x18ec4, 0x191e1, 0x1afab, 0x1b08e, 0x1cc1a, 0x1d33f, 0x1ed75, 0x1f250, 0x209d5, 0x216f0, 0x228ba, 0x2379f, 0x24b0b, 0x2542e, 0x26a64, 0x27541, 0x28c69];
14	/**
15	* Version number of this version.
16	*
17	* @var int
18	*/
19	private $versionNumber;
20	/**
21	* Alignment pattern centers.
22	*
23	* @var SplFixedArray
24	*/
25	private $alignmentPatternCenters;
26	/**
27	* Error correction blocks.
28	*
29	* @var EcBlocks[]
30	*/
31	private $ecBlocks;
32	/**
33	* Total number of codewords.
34	*
35	* @var int
36	*/
37	private $totalCodewords;
38	/**
39	* Cached version instances.
40	*
41	* @var array<int, self>\|null
42	*/
43	private static $versions;
44	/**
45	* @param int[] $alignmentPatternCenters
46	*/
47	private function __construct(int $versionNumber, array $alignmentPatternCenters, EcBlocks ...$ecBlocks)
48	{
49	$this->versionNumber = $versionNumber;
50	$this->alignmentPatternCenters = $alignmentPatternCenters;
51	$this->ecBlocks = $ecBlocks;
52	$totalCodewords = 0;
53	$ecCodewords = $ecBlocks[0]->getEcCodewordsPerBlock();
54	foreach ($ecBlocks[0]->getEcBlocks() as $ecBlock) {
55	$totalCodewords += $ecBlock->getCount() * ($ecBlock->getDataCodewords() + $ecCodewords);
56	}
57	$this->totalCodewords = $totalCodewords;
58	}
59	/**
60	* Returns the version number.
61	*/
62	public function getVersionNumber() : int
63	{
64	return $this->versionNumber;
65	}
66	/**
67	* Returns the alignment pattern centers.
68	*
69	* @return int[]
70	*/
71	public function getAlignmentPatternCenters() : array
72	{
73	return $this->alignmentPatternCenters;
74	}
75	/**
76	* Returns the total number of codewords.
77	*/
78	public function getTotalCodewords() : int
79	{
80	return $this->totalCodewords;
81	}
82	/**
83	* Calculates the dimension for the current version.
84	*/
85	public function getDimensionForVersion() : int
86	{
87	return 17 + 4 * $this->versionNumber;
88	}
89	/**
90	* Returns the number of EC blocks for a specific EC level.
91	*/
92	public function getEcBlocksForLevel(ErrorCorrectionLevel $ecLevel) : EcBlocks
93	{
94	return $this->ecBlocks[$ecLevel->ordinal()];
95	}
96	/**
97	* Gets a provisional version number for a specific dimension.
98	*
99	* @throws InvalidArgumentException if dimension is not 1 mod 4
100	*/
101	public static function getProvisionalVersionForDimension(int $dimension) : self
102	{
103	if (1 !== $dimension % 4) {
104	throw new InvalidArgumentException('Dimension is not 1 mod 4');
105	}
106	return self::getVersionForNumber(\intdiv($dimension - 17, 4));
107	}
108	/**
109	* Gets a version instance for a specific version number.
110	*
111	* @throws InvalidArgumentException if version number is out of range
112	*/
113	public static function getVersionForNumber(int $versionNumber) : self
114	{
115	if ($versionNumber < 1 \|\| $versionNumber > 40) {
116	throw new InvalidArgumentException('Version number must be between 1 and 40');
117	}
118	return self::versions()[$versionNumber - 1];
119	}
120	/**
121	* Decodes version information from an integer and returns the version.
122	*/
123	public static function decodeVersionInformation(int $versionBits) : ?self
124	{
125	$bestDifference = \PHP_INT_MAX;
126	$bestVersion = 0;
127	foreach (self::VERSION_DECODE_INFO as $i => $targetVersion) {
128	if ($targetVersion === $versionBits) {
129	return self::getVersionForNumber($i + 7);
130	}
131	$bitsDifference = FormatInformation::numBitsDiffering($versionBits, $targetVersion);
132	if ($bitsDifference < $bestDifference) {
133	$bestVersion = $i + 7;
134	$bestDifference = $bitsDifference;
135	}
136	}
137	if ($bestDifference <= 3) {
138	return self::getVersionForNumber($bestVersion);
139	}
140	return null;
141	}
142	/**
143	* Builds the function pattern for the current version.
144	*/
145	public function buildFunctionPattern() : BitMatrix
146	{
147	$dimension = $this->getDimensionForVersion();
148	$bitMatrix = new BitMatrix($dimension);
149	// Top left finder pattern + separator + format
150	$bitMatrix->setRegion(0, 0, 9, 9);
151	// Top right finder pattern + separator + format
152	$bitMatrix->setRegion($dimension - 8, 0, 8, 9);
153	// Bottom left finder pattern + separator + format
154	$bitMatrix->setRegion(0, $dimension - 8, 9, 8);
155	// Alignment patterns
156	$max = \count($this->alignmentPatternCenters);
157	for ($x = 0; $x < $max; ++$x) {
158	$i = $this->alignmentPatternCenters[$x] - 2;
159	for ($y = 0; $y < $max; ++$y) {
160	if ($x === 0 && ($y === 0 \|\| $y === $max - 1) \|\| $x === $max - 1 && $y === 0) {
161	// No alignment patterns near the three finder paterns
162	continue;
163	}
164	$bitMatrix->setRegion($this->alignmentPatternCenters[$y] - 2, $i, 5, 5);
165	}
166	}
167	// Vertical timing pattern
168	$bitMatrix->setRegion(6, 9, 1, $dimension - 17);
169	// Horizontal timing pattern
170	$bitMatrix->setRegion(9, 6, $dimension - 17, 1);
171	if ($this->versionNumber > 6) {
172	// Version info, top right
173	$bitMatrix->setRegion($dimension - 11, 0, 3, 6);
174	// Version info, bottom left
175	$bitMatrix->setRegion(0, $dimension - 11, 6, 3);
176	}
177	return $bitMatrix;
178	}
179	/**
180	* Returns a string representation for the version.
181	*/
182	public function __toString() : string
183	{
184	return (string) $this->versionNumber;
185	}
186	/**
187	* Build and cache a specific version.
188	*
189	* See ISO 18004:2006 6.5.1 Table 9.
190	*
191	* @return array<int, self>
192	*/
193	private static function versions() : array
194	{
195	if (null !== self::$versions) {
196	return self::$versions;
197	}
198	return self::$versions = [new self(1, [], new EcBlocks(7, new EcBlock(1, 19)), new EcBlocks(10, new EcBlock(1, 16)), new EcBlocks(13, new EcBlock(1, 13)), new EcBlocks(17, new EcBlock(1, 9))), new self(2, [6, 18], new EcBlocks(10, new EcBlock(1, 34)), new EcBlocks(16, new EcBlock(1, 28)), new EcBlocks(22, new EcBlock(1, 22)), new EcBlocks(28, new EcBlock(1, 16))), new self(3, [6, 22], new EcBlocks(15, new EcBlock(1, 55)), new EcBlocks(26, new EcBlock(1, 44)), new EcBlocks(18, new EcBlock(2, 17)), new EcBlocks(22, new EcBlock(2, 13))), new self(4, [6, 26], new EcBlocks(20, new EcBlock(1, 80)), new EcBlocks(18, new EcBlock(2, 32)), new EcBlocks(26, new EcBlock(3, 24)), new EcBlocks(16, new EcBlock(4, 9))), new self(5, [6, 30], new EcBlocks(26, new EcBlock(1, 108)), new EcBlocks(24, new EcBlock(2, 43)), new EcBlocks(18, new EcBlock(2, 15), new EcBlock(2, 16)), new EcBlocks(22, new EcBlock(2, 11), new EcBlock(2, 12))), new self(6, [6, 34], new EcBlocks(18, new EcBlock(2, 68)), new EcBlocks(16, new EcBlock(4, 27)), new EcBlocks(24, new EcBlock(4, 19)), new EcBlocks(28, new EcBlock(4, 15))), new self(7, [6, 22, 38], new EcBlocks(20, new EcBlock(2, 78)), new EcBlocks(18, new EcBlock(4, 31)), new EcBlocks(18, new EcBlock(2, 14), new EcBlock(4, 15)), new EcBlocks(26, new EcBlock(4, 13), new EcBlock(1, 14))), new self(8, [6, 24, 42], new EcBlocks(24, new EcBlock(2, 97)), new EcBlocks(22, new EcBlock(2, 38), new EcBlock(2, 39)), new EcBlocks(22, new EcBlock(4, 18), new EcBlock(2, 19)), new EcBlocks(26, new EcBlock(4, 14), new EcBlock(2, 15))), new self(9, [6, 26, 46], new EcBlocks(30, new EcBlock(2, 116)), new EcBlocks(22, new EcBlock(3, 36), new EcBlock(2, 37)), new EcBlocks(20, new EcBlock(4, 16), new EcBlock(4, 17)), new EcBlocks(24, new EcBlock(4, 12), new EcBlock(4, 13))), new self(10, [6, 28, 50], new EcBlocks(18, new EcBlock(2, 68), new EcBlock(2, 69)), new EcBlocks(26, new EcBlock(4, 43), new EcBlock(1, 44)), new EcBlocks(24, new EcBlock(6, 19), new EcBlock(2, 20)), new EcBlocks(28, new EcBlock(6, 15), new EcBlock(2, 16))), new self(11, [6, 30, 54], new EcBlocks(20, new EcBlock(4, 81)), new EcBlocks(30, new EcBlock(1, 50), new EcBlock(4, 51)), new EcBlocks(28, new EcBlock(4, 22), new EcBlock(4, 23)), new EcBlocks(24, new EcBlock(3, 12), new EcBlock(8, 13))), new self(12, [6, 32, 58], new EcBlocks(24, new EcBlock(2, 92), new EcBlock(2, 93)), new EcBlocks(22, new EcBlock(6, 36), new EcBlock(2, 37)), new EcBlocks(26, new EcBlock(4, 20), new EcBlock(6, 21)), new EcBlocks(28, new EcBlock(7, 14), new EcBlock(4, 15))), new self(13, [6, 34, 62], new EcBlocks(26, new EcBlock(4, 107)), new EcBlocks(22, new EcBlock(8, 37), new EcBlock(1, 38)), new EcBlocks(24, new EcBlock(8, 20), new EcBlock(4, 21)), new EcBlocks(22, new EcBlock(12, 11), new EcBlock(4, 12))), new self(14, [6, 26, 46, 66], new EcBlocks(30, new EcBlock(3, 115), new EcBlock(1, 116)), new EcBlocks(24, new EcBlock(4, 40), new EcBlock(5, 41)), new EcBlocks(20, new EcBlock(11, 16), new EcBlock(5, 17)), new EcBlocks(24, new EcBlock(11, 12), new EcBlock(5, 13))), new self(15, [6, 26, 48, 70], new EcBlocks(22, new EcBlock(5, 87), new EcBlock(1, 88)), new EcBlocks(24, new EcBlock(5, 41), new EcBlock(5, 42)), new EcBlocks(30, new EcBlock(5, 24), new EcBlock(7, 25)), new EcBlocks(24, new EcBlock(11, 12), new EcBlock(7, 13))), new self(16, [6, 26, 50, 74], new EcBlocks(24, new EcBlock(5, 98), new EcBlock(1, 99)), new EcBlocks(28, new EcBlock(7, 45), new EcBlock(3, 46)), new EcBlocks(24, new EcBlock(15, 19), new EcBlock(2, 20)), new EcBlocks(30, new EcBlock(3, 15), new EcBlock(13, 16))), new self(17, [6, 30, 54, 78], new EcBlocks(28, new EcBlock(1, 107), new EcBlock(5, 108)), new EcBlocks(28, new EcBlock(10, 46), new EcBlock(1, 47)), new EcBlocks(28, new EcBlock(1, 22), new EcBlock(15, 23)), new EcBlocks(28, new EcBlock(2, 14), new EcBlock(17, 15))), new self(18, [6, 30, 56, 82], new EcBlocks(30, new EcBlock(5, 120), new EcBlock(1, 121)), new EcBlocks(26, new EcBlock(9, 43), new EcBlock(4, 44)), new EcBlocks(28, new EcBlock(17, 22), new EcBlock(1, 23)), new EcBlocks(28, new EcBlock(2, 14), new EcBlock(19, 15))), new self(19, [6, 30, 58, 86], new EcBlocks(28, new EcBlock(3, 113), new EcBlock(4, 114)), new EcBlocks(26, new EcBlock(3, 44), new EcBlock(11, 45)), new EcBlocks(26, new EcBlock(17, 21), new EcBlock(4, 22)), new EcBlocks(26, new EcBlock(9, 13), new EcBlock(16, 14))), new self(20, [6, 34, 62, 90], new EcBlocks(28, new EcBlock(3, 107), new EcBlock(5, 108)), new EcBlocks(26, new EcBlock(3, 41), new EcBlock(13, 42)), new EcBlocks(30, new EcBlock(15, 24), new EcBlock(5, 25)), new EcBlocks(28, new EcBlock(15, 15), new EcBlock(10, 16))), new self(21, [6, 28, 50, 72, 94], new EcBlocks(28, new EcBlock(4, 116), new EcBlock(4, 117)), new EcBlocks(26, new EcBlock(17, 42)), new EcBlocks(28, new EcBlock(17, 22), new EcBlock(6, 23)), new EcBlocks(30, new EcBlock(19, 16), new EcBlock(6, 17))), new self(22, [6, 26, 50, 74, 98], new EcBlocks(28, new EcBlock(2, 111), new EcBlock(7, 112)), new EcBlocks(28, new EcBlock(17, 46)), new EcBlocks(30, new EcBlock(7, 24), new EcBlock(16, 25)), new EcBlocks(24, new EcBlock(34, 13))), new self(23, [6, 30, 54, 78, 102], new EcBlocks(30, new EcBlock(4, 121), new EcBlock(5, 122)), new EcBlocks(28, new EcBlock(4, 47), new EcBlock(14, 48)), new EcBlocks(30, new EcBlock(11, 24), new EcBlock(14, 25)), new EcBlocks(30, new EcBlock(16, 15), new EcBlock(14, 16))), new self(24, [6, 28, 54, 80, 106], new EcBlocks(30, new EcBlock(6, 117), new EcBlock(4, 118)), new EcBlocks(28, new EcBlock(6, 45), new EcBlock(14, 46)), new EcBlocks(30, new EcBlock(11, 24), new EcBlock(16, 25)), new EcBlocks(30, new EcBlock(30, 16), new EcBlock(2, 17))), new self(25, [6, 32, 58, 84, 110], new EcBlocks(26, new EcBlock(8, 106), new EcBlock(4, 107)), new EcBlocks(28, new EcBlock(8, 47), new EcBlock(13, 48)), new EcBlocks(30, new EcBlock(7, 24), new EcBlock(22, 25)), new EcBlocks(30, new EcBlock(22, 15), new EcBlock(13, 16))), new self(26, [6, 30, 58, 86, 114], new EcBlocks(28, new EcBlock(10, 114), new EcBlock(2, 115)), new EcBlocks(28, new EcBlock(19, 46), new EcBlock(4, 47)), new EcBlocks(28, new EcBlock(28, 22), new EcBlock(6, 23)), new EcBlocks(30, new EcBlock(33, 16), new EcBlock(4, 17))), new self(27, [6, 34, 62, 90, 118], new EcBlocks(30, new EcBlock(8, 122), new EcBlock(4, 123)), new EcBlocks(28, new EcBlock(22, 45), new EcBlock(3, 46)), new EcBlocks(30, new EcBlock(8, 23), new EcBlock(26, 24)), new EcBlocks(30, new EcBlock(12, 15), new EcBlock(28, 16))), new self(28, [6, 26, 50, 74, 98, 122], new EcBlocks(30, new EcBlock(3, 117), new EcBlock(10, 118)), new EcBlocks(28, new EcBlock(3, 45), new EcBlock(23, 46)), new EcBlocks(30, new EcBlock(4, 24), new EcBlock(31, 25)), new EcBlocks(30, new EcBlock(11, 15), new EcBlock(31, 16))), new self(29, [6, 30, 54, 78, 102, 126], new EcBlocks(30, new EcBlock(7, 116), new EcBlock(7, 117)), new EcBlocks(28, new EcBlock(21, 45), new EcBlock(7, 46)), new EcBlocks(30, new EcBlock(1, 23), new EcBlock(37, 24)), new EcBlocks(30, new EcBlock(19, 15), new EcBlock(26, 16))), new self(30, [6, 26, 52, 78, 104, 130], new EcBlocks(30, new EcBlock(5, 115), new EcBlock(10, 116)), new EcBlocks(28, new EcBlock(19, 47), new EcBlock(10, 48)), new EcBlocks(30, new EcBlock(15, 24), new EcBlock(25, 25)), new EcBlocks(30, new EcBlock(23, 15), new EcBlock(25, 16))), new self(31, [6, 30, 56, 82, 108, 134], new EcBlocks(30, new EcBlock(13, 115), new EcBlock(3, 116)), new EcBlocks(28, new EcBlock(2, 46), new EcBlock(29, 47)), new EcBlocks(30, new EcBlock(42, 24), new EcBlock(1, 25)), new EcBlocks(30, new EcBlock(23, 15), new EcBlock(28, 16))), new self(32, [6, 34, 60, 86, 112, 138], new EcBlocks(30, new EcBlock(17, 115)), new EcBlocks(28, new EcBlock(10, 46), new EcBlock(23, 47)), new EcBlocks(30, new EcBlock(10, 24), new EcBlock(35, 25)), new EcBlocks(30, new EcBlock(19, 15), new EcBlock(35, 16))), new self(33, [6, 30, 58, 86, 114, 142], new EcBlocks(30, new EcBlock(17, 115), new EcBlock(1, 116)), new EcBlocks(28, new EcBlock(14, 46), new EcBlock(21, 47)), new EcBlocks(30, new EcBlock(29, 24), new EcBlock(19, 25)), new EcBlocks(30, new EcBlock(11, 15), new EcBlock(46, 16))), new self(34, [6, 34, 62, 90, 118, 146], new EcBlocks(30, new EcBlock(13, 115), new EcBlock(6, 116)), new EcBlocks(28, new EcBlock(14, 46), new EcBlock(23, 47)), new EcBlocks(30, new EcBlock(44, 24), new EcBlock(7, 25)), new EcBlocks(30, new EcBlock(59, 16), new EcBlock(1, 17))), new self(35, [6, 30, 54, 78, 102, 126, 150], new EcBlocks(30, new EcBlock(12, 121), new EcBlock(7, 122)), new EcBlocks(28, new EcBlock(12, 47), new EcBlock(26, 48)), new EcBlocks(30, new EcBlock(39, 24), new EcBlock(14, 25)), new EcBlocks(30, new EcBlock(22, 15), new EcBlock(41, 16))), new self(36, [6, 24, 50, 76, 102, 128, 154], new EcBlocks(30, new EcBlock(6, 121), new EcBlock(14, 122)), new EcBlocks(28, new EcBlock(6, 47), new EcBlock(34, 48)), new EcBlocks(30, new EcBlock(46, 24), new EcBlock(10, 25)), new EcBlocks(30, new EcBlock(2, 15), new EcBlock(64, 16))), new self(37, [6, 28, 54, 80, 106, 132, 158], new EcBlocks(30, new EcBlock(17, 122), new EcBlock(4, 123)), new EcBlocks(28, new EcBlock(29, 46), new EcBlock(14, 47)), new EcBlocks(30, new EcBlock(49, 24), new EcBlock(10, 25)), new EcBlocks(30, new EcBlock(24, 15), new EcBlock(46, 16))), new self(38, [6, 32, 58, 84, 110, 136, 162], new EcBlocks(30, new EcBlock(4, 122), new EcBlock(18, 123)), new EcBlocks(28, new EcBlock(13, 46), new EcBlock(32, 47)), new EcBlocks(30, new EcBlock(48, 24), new EcBlock(14, 25)), new EcBlocks(30, new EcBlock(42, 15), new EcBlock(32, 16))), new self(39, [6, 26, 54, 82, 110, 138, 166], new EcBlocks(30, new EcBlock(20, 117), new EcBlock(4, 118)), new EcBlocks(28, new EcBlock(40, 47), new EcBlock(7, 48)), new EcBlocks(30, new EcBlock(43, 24), new EcBlock(22, 25)), new EcBlocks(30, new EcBlock(10, 15), new EcBlock(67, 16))), new self(40, [6, 30, 58, 86, 114, 142, 170], new EcBlocks(30, new EcBlock(19, 118), new EcBlock(6, 119)), new EcBlocks(28, new EcBlock(18, 47), new EcBlock(31, 48)), new EcBlocks(30, new EcBlock(34, 24), new EcBlock(34, 25)), new EcBlocks(30, new EcBlock(20, 15), new EcBlock(61, 16)))];
199	}
200	}
201