OLERead::read() - Code Metrics - Inspection of "Explicit 0 for a decimals value when using Currenc..." - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#3384)

by Mark

created 2023-02-20 17:35 UTC

OLERead::read() B

↳ Parent: OLERead

Complexity

Conditions	9
Paths	81

Size

Total Lines	87
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	37
CRAP Score	9.607

Importance

Changes

Metric	Value
eloc	45
dl	0
loc	87
ccs	37
cts	46
cp	0.8043
rs	7.6444
c	0
b	0
f	0
cc	9
nc	81
nop	1
crap	9.607

How to fix Long Method

<?php

namespace PhpOffice\PhpSpreadsheet\Shared;

use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;

class OLERead
{
    /** @var string */
    private $data = '';

    // Size of a sector = 512 bytes
    const BIG_BLOCK_SIZE = 0x200;

    // Size of a short sector = 64 bytes
    const SMALL_BLOCK_SIZE = 0x40;

    // Size of a directory entry always = 128 bytes
    const PROPERTY_STORAGE_BLOCK_SIZE = 0x80;

    // Minimum size of a standard stream = 4096 bytes, streams smaller than this are stored as short streams
    const SMALL_BLOCK_THRESHOLD = 0x1000;

    // header offsets
    const NUM_BIG_BLOCK_DEPOT_BLOCKS_POS = 0x2c;
    const ROOT_START_BLOCK_POS = 0x30;
    const SMALL_BLOCK_DEPOT_BLOCK_POS = 0x3c;
    const EXTENSION_BLOCK_POS = 0x44;
    const NUM_EXTENSION_BLOCK_POS = 0x48;
    const BIG_BLOCK_DEPOT_BLOCKS_POS = 0x4c;

    // property storage offsets (directory offsets)
    const SIZE_OF_NAME_POS = 0x40;
    const TYPE_POS = 0x42;
    const START_BLOCK_POS = 0x74;
    const SIZE_POS = 0x78;

    /** @var int */
    public $wrkbook;

    /** @var int */
    public $summaryInformation;

    /** @var int */
    public $documentSummaryInformation;

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

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

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

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

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

    /**
     * @var string
     */
    private $bigBlockChain;

    /**
     * @var string
     */
    private $smallBlockChain;

    /**
     * @var string
     */
    private $entry;

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

    /**
     * @var array
     */
    private $props = [];

    /**
     * Read the file.
     */
    public function read(string $filename): void
    {
        File::assertFile($filename);

        // Get the file identifier
        // Don't bother reading the whole file until we know it's a valid OLE file
        $this->data = (string) file_get_contents($filename, false, null, 0, 8);

        // Check OLE identifier
        $identifierOle = pack('CCCCCCCC', 0xd0, 0xcf, 0x11, 0xe0, 0xa1, 0xb1, 0x1a, 0xe1);
        if ($this->data != $identifierOle) {
            throw new ReaderException('The filename ' . $filename . ' is not recognised as an OLE file');
        }

        // Get the file data
        $this->data = (string) file_get_contents($filename);

        // Total number of sectors used for the SAT
        $this->numBigBlockDepotBlocks = self::getInt4d($this->data, self::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS);

        // SecID of the first sector of the directory stream
        $this->rootStartBlock = self::getInt4d($this->data, self::ROOT_START_BLOCK_POS);

        // SecID of the first sector of the SSAT (or -2 if not extant)
        $this->sbdStartBlock = self::getInt4d($this->data, self::SMALL_BLOCK_DEPOT_BLOCK_POS);

        // SecID of the first sector of the MSAT (or -2 if no additional sectors are used)
        $this->extensionBlock = self::getInt4d($this->data, self::EXTENSION_BLOCK_POS);

        // Total number of sectors used by MSAT
        $this->numExtensionBlocks = self::getInt4d($this->data, self::NUM_EXTENSION_BLOCK_POS);

        $bigBlockDepotBlocks = [];
        $pos = self::BIG_BLOCK_DEPOT_BLOCKS_POS;

        $bbdBlocks = $this->numBigBlockDepotBlocks;

        if ($this->numExtensionBlocks != 0) {
            $bbdBlocks = (self::BIG_BLOCK_SIZE - self::BIG_BLOCK_DEPOT_BLOCKS_POS) / 4;
        }

        for ($i = 0; $i < $bbdBlocks; ++$i) {
            $bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos);
            $pos += 4;
        }

        for ($j = 0; $j < $this->numExtensionBlocks; ++$j) {
            $pos = ($this->extensionBlock + 1) * self::BIG_BLOCK_SIZE;
            $blocksToRead = min($this->numBigBlockDepotBlocks - $bbdBlocks, self::BIG_BLOCK_SIZE / 4 - 1);

            for ($i = $bbdBlocks; $i < $bbdBlocks + $blocksToRead; ++$i) {
                $bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos);
                $pos += 4;
            }

            $bbdBlocks += $blocksToRead;
            if ($bbdBlocks < $this->numBigBlockDepotBlocks) {
                $this->extensionBlock = self::getInt4d($this->data, $pos);
            }
        }

        $pos = 0;
        $this->bigBlockChain = '';
        $bbs = self::BIG_BLOCK_SIZE / 4;
        for ($i = 0; $i < $this->numBigBlockDepotBlocks; ++$i) {
            $pos = ($bigBlockDepotBlocks[$i] + 1) * self::BIG_BLOCK_SIZE;

            $this->bigBlockChain .= substr($this->data, $pos, 4 * $bbs);
            $pos += 4 * $bbs;
        }

        $sbdBlock = $this->sbdStartBlock;
        $this->smallBlockChain = '';
        while ($sbdBlock != -2) {
            $pos = ($sbdBlock + 1) * self::BIG_BLOCK_SIZE;

            $this->smallBlockChain .= substr($this->data, $pos, 4 * $bbs);
            $pos += 4 * $bbs;

            $sbdBlock = self::getInt4d($this->bigBlockChain, $sbdBlock * 4);
        }

        // read the directory stream
        $block = $this->rootStartBlock;
        $this->entry = $this->readData($block);

        $this->readPropertySets();
    }

    /**
     * Extract binary stream data.
     *
     * @param ?int $stream
     *
     * @return null|string
     */
    public function getStream($stream)
    {
        if ($stream === null) {
            return null;
        }

        $streamData = '';

        if ($this->props[$stream]['size'] < self::SMALL_BLOCK_THRESHOLD) {
            $rootdata = $this->readData($this->props[$this->rootentry]['startBlock']);

            $block = $this->props[$stream]['startBlock'];

            while ($block != -2) {
                $pos = $block * self::SMALL_BLOCK_SIZE;
                $streamData .= substr($rootdata, $pos, self::SMALL_BLOCK_SIZE);

                $block = self::getInt4d($this->smallBlockChain, $block * 4);
            }

            return $streamData;
        }
        $numBlocks = $this->props[$stream]['size'] / self::BIG_BLOCK_SIZE;
        if ($this->props[$stream]['size'] % self::BIG_BLOCK_SIZE != 0) {
            ++$numBlocks;
        }

        if ($numBlocks == 0) {
            return '';
        }

        $block = $this->props[$stream]['startBlock'];

        while ($block != -2) {
            $pos = ($block + 1) * self::BIG_BLOCK_SIZE;
            $streamData .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
            $block = self::getInt4d($this->bigBlockChain, $block * 4);
        }

        return $streamData;
    }

    /**
     * Read a standard stream (by joining sectors using information from SAT).
     *
     * @param int $block Sector ID where the stream starts
     *
     * @return string Data for standard stream
     */
    private function readData($block)
    {
        $data = '';

        while ($block != -2) {
            $pos = ($block + 1) * self::BIG_BLOCK_SIZE;
            $data .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
            $block = self::getInt4d($this->bigBlockChain, $block * 4);
        }

        return $data;
    }

    /**
     * Read entries in the directory stream.
     */
    private function readPropertySets(): void
    {
        $offset = 0;

        // loop through entires, each entry is 128 bytes
        $entryLen = strlen($this->entry);
        while ($offset < $entryLen) {
            // entry data (128 bytes)
            $d = substr($this->entry, $offset, self::PROPERTY_STORAGE_BLOCK_SIZE);

            // size in bytes of name
            $nameSize = ord($d[self::SIZE_OF_NAME_POS]) | (ord($d[self::SIZE_OF_NAME_POS + 1]) << 8);

            // type of entry
            $type = ord($d[self::TYPE_POS]);

            // sectorID of first sector or short sector, if this entry refers to a stream (the case with workbook)
            // sectorID of first sector of the short-stream container stream, if this entry is root entry
            $startBlock = self::getInt4d($d, self::START_BLOCK_POS);

            $size = self::getInt4d($d, self::SIZE_POS);

            $name = str_replace("\x00", '', substr($d, 0, $nameSize));

            $this->props[] = [
                'name' => $name,
                'type' => $type,
                'startBlock' => $startBlock,
                'size' => $size,
            ];

            // tmp helper to simplify checks
            $upName = strtoupper($name);

            // Workbook directory entry (BIFF5 uses Book, BIFF8 uses Workbook)
            if (($upName === 'WORKBOOK') || ($upName === 'BOOK')) {
                $this->wrkbook = count($this->props) - 1;
            } elseif ($upName === 'ROOT ENTRY' || $upName === 'R') {
                // Root entry
                $this->rootentry = count($this->props) - 1;
            }

            // Summary information
            if ($name == chr(5) . 'SummaryInformation') {
                $this->summaryInformation = count($this->props) - 1;
            }

            // Additional Document Summary information
            if ($name == chr(5) . 'DocumentSummaryInformation') {
                $this->documentSummaryInformation = count($this->props) - 1;
            }

            $offset += self::PROPERTY_STORAGE_BLOCK_SIZE;
        }
    }

    /**
     * Read 4 bytes of data at specified position.
     *
     * @param string $data
     * @param int $pos
     *
     * @return int
     */
    private static function getInt4d($data, $pos)
    {
        if ($pos < 0) {
            // Invalid position
            throw new ReaderException('Parameter pos=' . $pos . ' is invalid.');
        }

        $len = strlen($data);
        if ($len < $pos + 4) {
            $data .= str_repeat("\0", $pos + 4 - $len);
        }

        // FIX: represent numbers correctly on 64-bit system
        // http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334
        // Changed by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems
        $_or_24 = ord($data[$pos + 3]);
        if ($_or_24 >= 128) {
            // negative number
            $_ord_24 = -abs((256 - $_or_24) << 24);
        } else {
            $_ord_24 = ($_or_24 & 127) << 24;
        }

        return ord($data[$pos]) | (ord($data[$pos + 1]) << 8) | (ord($data[$pos + 2]) << 16) | $_ord_24;
    }
}


1		<?php
2
3		namespace PhpOffice\PhpSpreadsheet\Shared;
4
5		use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;
6
7		class OLERead
8		{
9		/** @var string */
10		private $data = '';
11
12		// Size of a sector = 512 bytes
13		const BIG_BLOCK_SIZE = 0x200;
14
15		// Size of a short sector = 64 bytes
16		const SMALL_BLOCK_SIZE = 0x40;
17
18		// Size of a directory entry always = 128 bytes
19		const PROPERTY_STORAGE_BLOCK_SIZE = 0x80;
20
21		// Minimum size of a standard stream = 4096 bytes, streams smaller than this are stored as short streams
22		const SMALL_BLOCK_THRESHOLD = 0x1000;
23
24		// header offsets
25		const NUM_BIG_BLOCK_DEPOT_BLOCKS_POS = 0x2c;
26		const ROOT_START_BLOCK_POS = 0x30;
27		const SMALL_BLOCK_DEPOT_BLOCK_POS = 0x3c;
28		const EXTENSION_BLOCK_POS = 0x44;
29		const NUM_EXTENSION_BLOCK_POS = 0x48;
30		const BIG_BLOCK_DEPOT_BLOCKS_POS = 0x4c;
31
32		// property storage offsets (directory offsets)
33		const SIZE_OF_NAME_POS = 0x40;
34		const TYPE_POS = 0x42;
35		const START_BLOCK_POS = 0x74;
36		const SIZE_POS = 0x78;
37
38		/** @var int */
39		public $wrkbook;
40
41		/** @var int */
42		public $summaryInformation;
43
44		/** @var int */
45		public $documentSummaryInformation;
46
47		/**
48		* @var int
49		*/
50		private $numBigBlockDepotBlocks;
51
52		/**
53		* @var int
54		*/
55		private $rootStartBlock;
56
57		/**
58		* @var int
59		*/
60		private $sbdStartBlock;
61
62		/**
63		* @var int
64		*/
65		private $extensionBlock;
66
67		/**
68		* @var int
69		*/
70		private $numExtensionBlocks;
71
72		/**
73		* @var string
74		*/
75		private $bigBlockChain;
76
77		/**
78		* @var string
79		*/
80		private $smallBlockChain;
81
82		/**
83		* @var string
84		*/
85		private $entry;
86
87		/**
88		* @var int
89		*/
90		private $rootentry;
91
92		/**
93		* @var array
94		*/
95		private $props = [];
96
97		/**
98		* Read the file.
99		*/
100	95	public function read(string $filename): void
101		{
102	95	File::assertFile($filename);
103
104		// Get the file identifier
105		// Don't bother reading the whole file until we know it's a valid OLE file
106	95	$this->data = (string) file_get_contents($filename, false, null, 0, 8);
107
108		// Check OLE identifier
109	95	$identifierOle = pack('CCCCCCCC', 0xd0, 0xcf, 0x11, 0xe0, 0xa1, 0xb1, 0x1a, 0xe1);
110	95	if ($this->data != $identifierOle) {
111	6	throw new ReaderException('The filename ' . $filename . ' is not recognised as an OLE file');
112		}
113
114		// Get the file data
115	89	$this->data = (string) file_get_contents($filename);
116
117		// Total number of sectors used for the SAT
118	89	$this->numBigBlockDepotBlocks = self::getInt4d($this->data, self::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS);
119
120		// SecID of the first sector of the directory stream
121	89	$this->rootStartBlock = self::getInt4d($this->data, self::ROOT_START_BLOCK_POS);
122
123		// SecID of the first sector of the SSAT (or -2 if not extant)
124	89	$this->sbdStartBlock = self::getInt4d($this->data, self::SMALL_BLOCK_DEPOT_BLOCK_POS);
125
126		// SecID of the first sector of the MSAT (or -2 if no additional sectors are used)
127	89	$this->extensionBlock = self::getInt4d($this->data, self::EXTENSION_BLOCK_POS);
128
129		// Total number of sectors used by MSAT
130	89	$this->numExtensionBlocks = self::getInt4d($this->data, self::NUM_EXTENSION_BLOCK_POS);
131
132	89	$bigBlockDepotBlocks = [];
133	89	$pos = self::BIG_BLOCK_DEPOT_BLOCKS_POS;
134
135	89	$bbdBlocks = $this->numBigBlockDepotBlocks;
136
137	89	if ($this->numExtensionBlocks != 0) {
138		$bbdBlocks = (self::BIG_BLOCK_SIZE - self::BIG_BLOCK_DEPOT_BLOCKS_POS) / 4;
139		}
140
141	89	for ($i = 0; $i < $bbdBlocks; ++$i) {
142	89	$bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos);
143	89	$pos += 4;
144		}
145
146	89	for ($j = 0; $j < $this->numExtensionBlocks; ++$j) {
147		$pos = ($this->extensionBlock + 1) * self::BIG_BLOCK_SIZE;
148		$blocksToRead = min($this->numBigBlockDepotBlocks - $bbdBlocks, self::BIG_BLOCK_SIZE / 4 - 1);
149
150		for ($i = $bbdBlocks; $i < $bbdBlocks + $blocksToRead; ++$i) {
151		$bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos);
152		$pos += 4;
153		}
154
155		$bbdBlocks += $blocksToRead;
156		if ($bbdBlocks < $this->numBigBlockDepotBlocks) {
157		$this->extensionBlock = self::getInt4d($this->data, $pos);
158		}
159		}
160
161	89	$pos = 0;
162	89	$this->bigBlockChain = '';
163	89	$bbs = self::BIG_BLOCK_SIZE / 4;
164	89	for ($i = 0; $i < $this->numBigBlockDepotBlocks; ++$i) {
165	89	$pos = ($bigBlockDepotBlocks[$i] + 1) * self::BIG_BLOCK_SIZE;
166
167	89	$this->bigBlockChain .= substr($this->data, $pos, 4 * $bbs);
168	89	$pos += 4 * $bbs;
169		}
170
171	89	$sbdBlock = $this->sbdStartBlock;
172	89	$this->smallBlockChain = '';
173	89	while ($sbdBlock != -2) {
174	55	$pos = ($sbdBlock + 1) * self::BIG_BLOCK_SIZE;
175
176	55	$this->smallBlockChain .= substr($this->data, $pos, 4 * $bbs);
177	55	$pos += 4 * $bbs;
178
179	55	$sbdBlock = self::getInt4d($this->bigBlockChain, $sbdBlock * 4);
180		}
181
182		// read the directory stream
183	89	$block = $this->rootStartBlock;
184	89	$this->entry = $this->readData($block);
185
186	89	$this->readPropertySets();
187		}
188
189		/**
190		* Extract binary stream data.
191		*
192		* @param ?int $stream
193		*
194		* @return null\|string
195		*/
196	87	public function getStream($stream)
197		{
198	87	if ($stream === null) {
199	4	return null;
200		}
201
202	87	$streamData = '';
203
204	87	if ($this->props[$stream]['size'] < self::SMALL_BLOCK_THRESHOLD) {
205	55	$rootdata = $this->readData($this->props[$this->rootentry]['startBlock']);
206
207	55	$block = $this->props[$stream]['startBlock'];
208
209	55	while ($block != -2) {
210	55	$pos = $block * self::SMALL_BLOCK_SIZE;
211	55	$streamData .= substr($rootdata, $pos, self::SMALL_BLOCK_SIZE);
212
213	55	$block = self::getInt4d($this->smallBlockChain, $block * 4);
214		}
215
216	55	return $streamData;
217		}
218	55	$numBlocks = $this->props[$stream]['size'] / self::BIG_BLOCK_SIZE;
219	55	if ($this->props[$stream]['size'] % self::BIG_BLOCK_SIZE != 0) {
220	55	++$numBlocks;
221		}
222
223	55	if ($numBlocks == 0) {
224		return '';
225		}
226
227	55	$block = $this->props[$stream]['startBlock'];
228
229	55	while ($block != -2) {
230	55	$pos = ($block + 1) * self::BIG_BLOCK_SIZE;
231	55	$streamData .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
232	55	$block = self::getInt4d($this->bigBlockChain, $block * 4);
233		}
234
235	55	return $streamData;
236		}
237
238		/**
239		* Read a standard stream (by joining sectors using information from SAT).
240		*
241		* @param int $block Sector ID where the stream starts
242		*
243		* @return string Data for standard stream
244		*/
245	89	private function readData($block)
246		{
247	89	$data = '';
248
249	89	while ($block != -2) {
250	89	$pos = ($block + 1) * self::BIG_BLOCK_SIZE;
251	89	$data .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
252	89	$block = self::getInt4d($this->bigBlockChain, $block * 4);
253		}
254
255	89	return $data;
256		}
257
258		/**
259		* Read entries in the directory stream.
260		*/
261	89	private function readPropertySets(): void
262		{
263	89	$offset = 0;
264
265		// loop through entires, each entry is 128 bytes
266	89	$entryLen = strlen($this->entry);
267	89	while ($offset < $entryLen) {
268		// entry data (128 bytes)
269	89	$d = substr($this->entry, $offset, self::PROPERTY_STORAGE_BLOCK_SIZE);
270
271		// size in bytes of name
272	89	$nameSize = ord($d[self::SIZE_OF_NAME_POS]) \| (ord($d[self::SIZE_OF_NAME_POS + 1]) << 8);
273
274		// type of entry
275	89	$type = ord($d[self::TYPE_POS]);
276
277		// sectorID of first sector or short sector, if this entry refers to a stream (the case with workbook)
278		// sectorID of first sector of the short-stream container stream, if this entry is root entry
279	89	$startBlock = self::getInt4d($d, self::START_BLOCK_POS);
280
281	89	$size = self::getInt4d($d, self::SIZE_POS);
282
283	89	$name = str_replace("\x00", '', substr($d, 0, $nameSize));
284
285	89	$this->props[] = [
286	89	'name' => $name,
287	89	'type' => $type,
288	89	'startBlock' => $startBlock,
289	89	'size' => $size,
290	89	];
291
292		// tmp helper to simplify checks
293	89	$upName = strtoupper($name);
294
295		// Workbook directory entry (BIFF5 uses Book, BIFF8 uses Workbook)
296	89	if (($upName === 'WORKBOOK') \|\| ($upName === 'BOOK')) {
297	89	$this->wrkbook = count($this->props) - 1;
298	89	} elseif ($upName === 'ROOT ENTRY' \|\| $upName === 'R') {
299		// Root entry
300	89	$this->rootentry = count($this->props) - 1;
301		}
302
303		// Summary information
304	89	if ($name == chr(5) . 'SummaryInformation') {
305	85	$this->summaryInformation = count($this->props) - 1;
306		}
307
308		// Additional Document Summary information
309	89	if ($name == chr(5) . 'DocumentSummaryInformation') {
310	85	$this->documentSummaryInformation = count($this->props) - 1;
311		}
312
313	89	$offset += self::PROPERTY_STORAGE_BLOCK_SIZE;
314		}
315		}
316
317		/**
318		* Read 4 bytes of data at specified position.
319		*
320		* @param string $data
321		* @param int $pos
322		*
323		* @return int
324		*/
325	89	private static function getInt4d($data, $pos)
326		{
327	89	if ($pos < 0) {
328		// Invalid position
329		throw new ReaderException('Parameter pos=' . $pos . ' is invalid.');
330		}
331
332	89	$len = strlen($data);
333	89	if ($len < $pos + 4) {
334		$data .= str_repeat("\0", $pos + 4 - $len);
335		}
336
337		// FIX: represent numbers correctly on 64-bit system
338		// http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334
339		// Changed by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems
340	89	$_or_24 = ord($data[$pos + 3]);
341	89	if ($_or_24 >= 128) {
342		// negative number
343	89	$_ord_24 = -abs((256 - $_or_24) << 24);
344		} else {
345	89	$_ord_24 = ($_or_24 & 127) << 24;
346		}
347
348	89	return ord($data[$pos]) \| (ord($data[$pos + 1]) << 8) \| (ord($data[$pos + 2]) << 16) \| $_ord_24;
349		}
350		}
351

PHPOffice / PhpSpreadsheet

Pull Request — master (#3384)

OLERead::read() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like