MSCompressedSection::getContents() - Code Metrics - mlocati/chm-lib - Measure and Improve Code Quality continuously with Scrutinizer

MSCompressedSection::getContents() C
last analyzed 2020-03-31 15:07 UTC

↳ Parent: MSCompressedSection

Complexity

Conditions	15
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	45
CRAP Score	15.0549

Importance

Changes

Metric	Value
dl	0
loc	64
ccs	45
cts	48
cp	0.9375
rs	5.9166
c	0
b	0
f	0
cc	15
nc	5
nop	2
crap	15.0549

How to fix Long Method Complexity

<?php

namespace CHMLib\Section;

use Exception;
use CHMLib\CHM;
use CHMLib\Reader\StringReader;
use CHMLib\Reader\BitReader;
use CHMLib\Header\LZXC;
use CHMLib\LZX\Inflater;
use CHMLib\LZX\LRUCache;

/**
 * Represent a LXZ-compressed section of data in a CHM file.
 */
class MSCompressedSection extends Section
{
    /**
     * The LZX reset interval.
     *
     * @var int
     */
    protected $resetInterval;

    /**
     * The window size.
     *
     * @var int
     */
    protected $windowSize;

    /**
     * The size of the uncompressed data.
     *
     * @var int
     */
    protected $uncompressedLength;

    /**
     * The size of the compressed data.
     *
     * @var int
     */
    protected $compressedLength;

    /**
     * The block size.
     *
     * @var int
     */
    protected $blockSize;

    /**
     * The address table.
     *
     * @var int[]
     */
    protected $addressTable;

    /**
     * The currently cached blocks.
     *
     * @var \CHMLib\LZX\LRUCache
     */
    protected $cachedBlocks;

    /**
     * Initializes the instance.
     *
     * @param CHM $chm The parent CHM file.
     *
     * @throws Exception Throws an Exception in case of errors.
     */
    public function __construct(CHM $chm)
    {
        parent::__construct($chm);
        $controlDataEntry = $chm->getEntryByPath('::DataSpace/Storage/MSCompressed/ControlData');
        if ($controlDataEntry === null) {
            throw new Exception("Missing required entry: '::DataSpace/Storage/MSCompressed/ControlData'");
        }
        if ($controlDataEntry->getContentSectionIndex() !== 0) {
            throw new Exception("The content of the entry '{$controlDataEntry->getPath()}' should be in section 0, but it's in section {$controlDataEntry->getContentSectionIndex()}");
        }
        $controlDataReader = new StringReader($controlDataEntry->getContents());
        $lzxc = new LZXC($controlDataReader);
        $this->resetInterval = $lzxc->getResetInterval();
        $this->windowSize = $lzxc->getWindowSize() * 32768;
        $this->cachedBlocks = new LRUCache((1 + $lzxc->getCacheSize()) << 2);
        $resetTableEntry = $chm->getEntryByPath('::DataSpace/Storage/MSCompressed/Transform/{7FC28940-9D31-11D0-9B27-00A0C91E9C7C}/InstanceData/ResetTable');
        if ($resetTableEntry === null) {
            throw new Exception("Missing required entry: '::DataSpace/Storage/MSCompressed/Transform/{7FC28940-9D31-11D0-9B27-00A0C91E9C7C}/InstanceData/ResetTable'");
        }
        if ($resetTableEntry->getContentSectionIndex() !== 0) {
            throw new Exception("The content of the entry '{$resetTableEntry->getPath()}' should be in section 0, but it's in section {$resetTableEntry->getContentSectionIndex()}");
        }
        $resetTableReader = new StringReader($resetTableEntry->getContents());
        $resetTableVersion = $resetTableReader->readUInt32();
        if ($resetTableVersion !== 2) {
            throw new Exception("Unsupported LZX Reset Table version: $resetTableVersion");
        }
        $addressTableSize = $resetTableReader->readUInt32();
        /* Size of table entry (8) */ $resetTableReader->readUInt32();
        /* Header length (40) */ $resetTableReader->readUInt32();
        $this->uncompressedLength = $resetTableReader->readUInt64();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->compressedLength = $resetTableReader->readUInt64();
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->blockSize = $resetTableReader->readUInt64(); // We do not support block sizes bigger than 32-bit integers
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->addressTable = array();
        for ($i = 0; $i < $addressTableSize; ++$i) {
            $this->addressTable[$i] = $resetTableReader->readUInt64();
        }
        $contentEntry = $chm->getEntryByPath('::DataSpace/Storage/MSCompressed/Content');
        if ($contentEntry === null) {
            throw new Exception("Missing required entry: '::DataSpace/Storage/MSCompressed/Content");
        }
        if ($this->compressedLength > $contentEntry->getLength()) {
            throw new Exception("Compressed section size should be {$this->compressedLength}, but it's {$contentEntry->getLength()}");
        }
        $this->sectionOffset = $chm->getITSF()->getContentOffset() + $contentEntry->getOffset();
    }

    /**
     * {@inheritdoc}
     *
     * @see Section::getContents()
     */
    public function getContents($offset, $length)
    {
        $result = '';
        if ($length > 0) {
            $startBlockNo = (int) ($offset / $this->blockSize);
            $startOffset = $offset % $this->blockSize;
            $endBlockNo = (int) (($offset + $length) / $this->blockSize);
            $endOffset = (int) (($offset + $length) % $this->blockSize);
            if ($endOffset === 0 && $endBlockNo > $startBlockNo) {
                $endOffset = $this->blockSize;
                --$endBlockNo;
            }
            $blockNo = $startBlockNo - $startBlockNo % $this->resetInterval;
            $inflater = new Inflater($this->windowSize);

            $pos = 0;
            $bytesLeft = 0;
            $reader = $this->chm->getReader();
            while ($bytesLeft > 0 || $blockNo <= $endBlockNo) {
                $data = '';
                while ($bytesLeft <= 0) {
                    // Read block
                    if ($blockNo > $endBlockNo) {
                        throw new Exception('Read after last data block');
                    }
                    $cacheNo = (int) ($blockNo / $this->resetInterval);
                    $cache = $this->cachedBlocks->get($cacheNo);
                    if ($cache === null) {
                        $this->cachedBlocks->prune();
                        $cache = array();
                        $resetBlockNo = $blockNo - $blockNo % $this->resetInterval;
                        for ($i = 0; $i < $this->resetInterval && $resetBlockNo + $i < count($this->addressTable); ++$i) {
                            $thisBlockNo = $resetBlockNo + $i;
                            $len = ($thisBlockNo + 1 < count($this->addressTable)) ?
                                ($this->addressTable[$thisBlockNo + 1] - $this->addressTable[$thisBlockNo])
                                :
                                ($this->compressedLength - $this->addressTable[$thisBlockNo]);
                            $reader->setPosition($this->sectionOffset + $this->addressTable[$thisBlockNo]);
                            $bitReader = new BitReader($reader->readString($len));
                            $cache[$i] = $inflater->inflate(
                                $i === 0,
                                $bitReader,
                                $this->blockSize
                            );
                        }
                        $this->cachedBlocks->put($cacheNo, $cache);
                    }
                    $data = $cache[$blockNo % $this->resetInterval];
                    // the start block has special pos value
                    $pos = ($blockNo === $startBlockNo) ? $startOffset : 0;
                    // the end block has special length
                    $bytesLeft = ($blockNo < $startBlockNo) ? 0 : (($blockNo < $endBlockNo) ? $this->blockSize : $endOffset);
                    $bytesLeft -= $pos;
                    ++$blockNo;
                }
                $togo = $bytesLeft;
                $result .= substr($data, $pos, $togo);
                $pos += $togo;
                $bytesLeft -= $togo;
            }
        }

        return $result;
    }
}


1		<?php
2
3		namespace CHMLib\Section;
4
5		use Exception;
6		use CHMLib\CHM;
7		use CHMLib\Reader\StringReader;
8		use CHMLib\Reader\BitReader;
9		use CHMLib\Header\LZXC;
10		use CHMLib\LZX\Inflater;
11		use CHMLib\LZX\LRUCache;
12
13		/**
14		* Represent a LXZ-compressed section of data in a CHM file.
15		*/
16		class MSCompressedSection extends Section
17		{
18		/**
19		* The LZX reset interval.
20		*
21		* @var int
22		*/
23		protected $resetInterval;
24
25		/**
26		* The window size.
27		*
28		* @var int
29		*/
30		protected $windowSize;
31
32		/**
33		* The size of the uncompressed data.
34		*
35		* @var int
36		*/
37		protected $uncompressedLength;
38
39		/**
40		* The size of the compressed data.
41		*
42		* @var int
43		*/
44		protected $compressedLength;
45
46		/**
47		* The block size.
48		*
49		* @var int
50		*/
51		protected $blockSize;
52
53		/**
54		* The address table.
55		*
56		* @var int[]
57		*/
58		protected $addressTable;
59
60		/**
61		* The currently cached blocks.
62		*
63		* @var \CHMLib\LZX\LRUCache
64		*/
65		protected $cachedBlocks;
66
67		/**
68		* Initializes the instance.
69		*
70		* @param CHM $chm The parent CHM file.
71		*
72		* @throws Exception Throws an Exception in case of errors.
73		*/
74	4	public function __construct(CHM $chm)
75		{
76	4	parent::__construct($chm);
77	4	$controlDataEntry = $chm->getEntryByPath('::DataSpace/Storage/MSCompressed/ControlData');
78	4	if ($controlDataEntry === null) {
79		throw new Exception("Missing required entry: '::DataSpace/Storage/MSCompressed/ControlData'");
80		}
81	4	if ($controlDataEntry->getContentSectionIndex() !== 0) {
82		throw new Exception("The content of the entry '{$controlDataEntry->getPath()}' should be in section 0, but it's in section {$controlDataEntry->getContentSectionIndex()}");
83		}
84	4	$controlDataReader = new StringReader($controlDataEntry->getContents());
85	4	$lzxc = new LZXC($controlDataReader);
86	4	$this->resetInterval = $lzxc->getResetInterval();
87	4	$this->windowSize = $lzxc->getWindowSize() * 32768;
88	4	$this->cachedBlocks = new LRUCache((1 + $lzxc->getCacheSize()) << 2);
89	4	$resetTableEntry = $chm->getEntryByPath('::DataSpace/Storage/MSCompressed/Transform/{7FC28940-9D31-11D0-9B27-00A0C91E9C7C}/InstanceData/ResetTable');
90	4	if ($resetTableEntry === null) {
91		throw new Exception("Missing required entry: '::DataSpace/Storage/MSCompressed/Transform/{7FC28940-9D31-11D0-9B27-00A0C91E9C7C}/InstanceData/ResetTable'");
92		}
93	4	if ($resetTableEntry->getContentSectionIndex() !== 0) {
94		throw new Exception("The content of the entry '{$resetTableEntry->getPath()}' should be in section 0, but it's in section {$resetTableEntry->getContentSectionIndex()}");
95		}
96	4	$resetTableReader = new StringReader($resetTableEntry->getContents());
97	4	$resetTableVersion = $resetTableReader->readUInt32();
98	4	if ($resetTableVersion !== 2) {
99		throw new Exception("Unsupported LZX Reset Table version: $resetTableVersion");
100		}
101	4	$addressTableSize = $resetTableReader->readUInt32();
102	4	/* Size of table entry (8) */ $resetTableReader->readUInt32();
103	4	/* Header length (40) */ $resetTableReader->readUInt32();
104	4	$this->uncompressedLength = $resetTableReader->readUInt64();
		0 ignored issues – show Documentation Bug introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report It seems like `$resetTableReader->readUInt64()` can also be of type `double`. However, the property `$uncompressedLength` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
105	4	$this->compressedLength = $resetTableReader->readUInt64();
		0 ignored issues – show Documentation Bug introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report It seems like `$resetTableReader->readUInt64()` can also be of type `double`. However, the property `$compressedLength` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
106	4	$this->blockSize = $resetTableReader->readUInt64(); // We do not support block sizes bigger than 32-bit integers
		0 ignored issues – show Documentation Bug introduced 2016-05-04 14:16 UTC by Report Bug Copy Issue Report It seems like `$resetTableReader->readUInt64()` can also be of type `double`. However, the property `$blockSize` is declared as type `integer`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
107	4	$this->addressTable = array();
108	4	for ($i = 0; $i < $addressTableSize; ++$i) {
109	4	$this->addressTable[$i] = $resetTableReader->readUInt64();
110		}
111	4	$contentEntry = $chm->getEntryByPath('::DataSpace/Storage/MSCompressed/Content');
112	4	if ($contentEntry === null) {
113		throw new Exception("Missing required entry: '::DataSpace/Storage/MSCompressed/Content");
114		}
115	4	if ($this->compressedLength > $contentEntry->getLength()) {
116		throw new Exception("Compressed section size should be {$this->compressedLength}, but it's {$contentEntry->getLength()}");
117		}
118	4	$this->sectionOffset = $chm->getITSF()->getContentOffset() + $contentEntry->getOffset();
119	4	}
120
121		/**
122		* {@inheritdoc}
123		*
124		* @see Section::getContents()
125		*/
126	485	public function getContents($offset, $length)
127		{
128	485	$result = '';
129	485	if ($length > 0) {
130	483	$startBlockNo = (int) ($offset / $this->blockSize);
131	483	$startOffset = $offset % $this->blockSize;
132	483	$endBlockNo = (int) (($offset + $length) / $this->blockSize);
133	483	$endOffset = (int) (($offset + $length) % $this->blockSize);
134	483	if ($endOffset === 0 && $endBlockNo > $startBlockNo) {
135		$endOffset = $this->blockSize;
136		--$endBlockNo;
137		}
138	483	$blockNo = $startBlockNo - $startBlockNo % $this->resetInterval;
139	483	$inflater = new Inflater($this->windowSize);
140
141	483	$pos = 0;
142	483	$bytesLeft = 0;
143	483	$reader = $this->chm->getReader();
144	483	while ($bytesLeft > 0 \|\| $blockNo <= $endBlockNo) {
145	483	$data = '';
146	483	while ($bytesLeft <= 0) {
147		// Read block
148	483	if ($blockNo > $endBlockNo) {
149		throw new Exception('Read after last data block');
150		}
151	483	$cacheNo = (int) ($blockNo / $this->resetInterval);
152	483	$cache = $this->cachedBlocks->get($cacheNo);
153	483	if ($cache === null) {
154	26	$this->cachedBlocks->prune();
155	26	$cache = array();
156	26	$resetBlockNo = $blockNo - $blockNo % $this->resetInterval;
157	26	for ($i = 0; $i < $this->resetInterval && $resetBlockNo + $i < count($this->addressTable); ++$i) {
158	26	$thisBlockNo = $resetBlockNo + $i;
159	26	$len = ($thisBlockNo + 1 < count($this->addressTable)) ?
160	23	($this->addressTable[$thisBlockNo + 1] - $this->addressTable[$thisBlockNo])
161		:
162	26	($this->compressedLength - $this->addressTable[$thisBlockNo]);
163	26	$reader->setPosition($this->sectionOffset + $this->addressTable[$thisBlockNo]);
164	26	$bitReader = new BitReader($reader->readString($len));
165	26	$cache[$i] = $inflater->inflate(
166	26	$i === 0,
167	26	$bitReader,
168	26	$this->blockSize
169		);
170		}
171	26	$this->cachedBlocks->put($cacheNo, $cache);
172		}
173	483	$data = $cache[$blockNo % $this->resetInterval];
174		// the start block has special pos value
175	483	$pos = ($blockNo === $startBlockNo) ? $startOffset : 0;
176		// the end block has special length
177	483	$bytesLeft = ($blockNo < $startBlockNo) ? 0 : (($blockNo < $endBlockNo) ? $this->blockSize : $endOffset);
178	483	$bytesLeft -= $pos;
179	483	++$blockNo;
180		}
181	483	$togo = $bytesLeft;
182	483	$result .= substr($data, $pos, $togo);
183	483	$pos += $togo;
184	483	$bytesLeft -= $togo;
185		}
186		}
187
188	485	return $result;
189		}
190		}
191

mlocati / chm-lib

MSCompressedSection::getContents() C last analyzed 2020-03-31 15:07 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like

MSCompressedSection::getContents() C
last analyzed 2020-03-31 15:07 UTC