FrameReader::read() - Code Metrics - Inspection of "Separate ID3 readers and writers" - GravityMedia/Metadata - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — id3-metadata-objects ( e55453...161f4c )

by Daniel

created 2016-03-28 15:39 UTC

FrameReader::read() B

↳ Parent: FrameReader

Complexity

Conditions	6
Paths	17

Size

Total Lines	41
Code Lines	21

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	41
rs	8.439
cc	6
eloc	21
nc	17
nop	0

<?php
/**
 * This file is part of the Metadata package.
 *
 * @author Daniel Schröder <[email protected]>
 */

namespace GravityMedia\Metadata\ID3v2\Reader;

use GravityMedia\Metadata\ID3v2\Encoder\Unsynchronisation;
use GravityMedia\Metadata\ID3v2\Enum\FrameFlag;
use GravityMedia\Metadata\ID3v2\Enum\Version;
use GravityMedia\Metadata\ID3v2\Frame;
use GravityMedia\Metadata\ID3v2\Stream\SynchsafeInteger32Reader;
use GravityMedia\Metadata\Metadata\FrameInterface;
use GravityMedia\Metadata\Metadata\HeaderInterface;
use GravityMedia\Stream\Enum\ByteOrder;
use GravityMedia\Stream\Reader\Integer16Reader;
use GravityMedia\Stream\Reader\Integer24Reader;
use GravityMedia\Stream\Reader\Integer32Reader;
use GravityMedia\Stream\StreamInterface;

/**
 * ID3v2 Frame reader
 *
 * @package GravityMedia\Metadata\ID3v2\Reader
 */
class FrameReader
{
    /**
     * @var StreamInterface
     */
    protected $stream;

    /**
     * @var HeaderInterface
     */
    protected $header;

    /**
     * @var Integer16Reader
     */
    protected $integer16Reader;

    /**
     * @var Integer24Reader
     */
    protected $integer24Reader;

    /**
     * @var Integer32Reader
     */
    protected $integer32Reader;

    /**
     * @var SynchsafeInteger32Reader
     */
    protected $synchsafeInteger32Reader;

    /**
     * Create ID3v2 frame reader.
     *
     * @param StreamInterface $stream
     * @param HeaderInterface $header
     */
    public function __construct(StreamInterface $stream, HeaderInterface $header)
    {
        $this->stream = $stream;
        $this->header = $header;
    }

    /**
     * Get 16-bit integer reader
     *
     * @return Integer16Reader
     */
    public function getInteger16Reader()

    {
        if (null === $this->integer16Reader) {
            $this->integer16Reader = new Integer16Reader($this->stream);
            $this->integer16Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
        }

        return $this->integer16Reader;
    }

    /**
     * Get 24-bit integer reader
     *
     * @return Integer24Reader
     */
    public function getInteger24Reader()

    {
        if (null === $this->integer24Reader) {
            $this->integer24Reader = new Integer24Reader($this->stream);
            $this->integer24Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
        }

        return $this->integer24Reader;
    }

    /**
     * Get 32-bit integer reader
     *
     * @return Integer32Reader
     */
    public function getInteger32Reader()

    {
        if (null === $this->integer32Reader) {
            $this->integer32Reader = new Integer32Reader($this->stream);
            $this->integer32Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
        }

        return $this->integer32Reader;
    }

    /**
     * Get synchsafe 32-bit integer reader
     *
     * @return SynchsafeInteger32Reader
     */
    public function getSynchsafeInteger32Reader()

    {
        if (null === $this->synchsafeInteger32Reader) {
            $this->synchsafeInteger32Reader = new SynchsafeInteger32Reader($this->stream);
            $this->synchsafeInteger32Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
        }

        return $this->synchsafeInteger32Reader;
    }

    /**
     * Read ID3v2 frame name.
     *
     * @return string
     */
    protected function readName()
    {
        if (Version::VERSION_22 === $this->header->getVersion()) {
            return rtrim($this->stream->read(3));
        }

        return rtrim($this->stream->read(4));
    }

    /**
     * Read ID3v2 frame size.
     *
     * @return int
     */
    protected function readSize()
    {
        if (Version::VERSION_22 === $this->header->getVersion()) {
            return $this->getInteger24Reader()->read();
        }

        if (Version::VERSION_23 === $this->header->getVersion()) {
            return $this->getInteger32Reader()->read();
        }

        return $this->getSynchsafeInteger32Reader()->read();
    }

    /**
     * Read ID3v2 frame flags.
     *
     * @return array
     */
    protected function readFlags()
    {
        $flags = $this->getInteger16Reader()->read();

        if (Version::VERSION_23 === $this->header->getVersion()) {
            return [
                FrameFlag::FLAG_TAG_ALTER_PRESERVATION => (bool)($flags & 0x8000),
                FrameFlag::FLAG_FILE_ALTER_PRESERVATION => (bool)($flags & 0x4000),
                FrameFlag::FLAG_READ_ONLY => (bool)($flags & 0x2000),
                FrameFlag::FLAG_COMPRESSION => (bool)($flags & 0x0080),
                FrameFlag::FLAG_ENCRYPTION => (bool)($flags & 0x0040),
                FrameFlag::FLAG_GROUPING_IDENTITY => (bool)($flags & 0x0020),
            ];
        }

        return [
            FrameFlag::FLAG_TAG_ALTER_PRESERVATION => (bool)($flags & 0x4000),
            FrameFlag::FLAG_FILE_ALTER_PRESERVATION => (bool)($flags & 0x2000),
            FrameFlag::FLAG_READ_ONLY => (bool)($flags & 0x1000),
            FrameFlag::FLAG_GROUPING_IDENTITY => (bool)($flags & 0x0040),
            FrameFlag::FLAG_COMPRESSION => (bool)($flags & 0x0008),
            FrameFlag::FLAG_ENCRYPTION => (bool)($flags & 0x0004),
            FrameFlag::FLAG_UNSYNCHRONISATION => (bool)($flags & 0x0002),
            FrameFlag::FLAG_DATA_LENGT_INDICATOR => (bool)($flags & 0x0001),
        ];
    }

    /**
     * Read ID3v2 frame data length.
     *
     * @return int
     */
    public function readDataLength()
    {
        return $this->getSynchsafeInteger32Reader()->read();
    }

    /**
     * Read ID3v2 frame.
     *
     * @return FrameInterface
     */
    public function read()
    {
        $name = $this->readName();
        $size = $this->readSize();

        $frame = new Frame();
        $frame
            ->setName($name)
            ->setSize($size);

        // Return empty frame
        if (0 === $size) {
            return $frame;
        }

        // Only in ID3v2.3 and ID3v2.4
        if (Version::VERSION_22 !== $this->header->getVersion()) {
            $frame->setFlags($this->readFlags());
        }

        // Only in ID3v2.4
        if ($frame->isFlagEnabled(FrameFlag::FLAG_DATA_LENGT_INDICATOR)) {
            $frame->setDataLength($this->readDataLength());

            $size -= 4;
        }


        $data = $this->stream->read($size);
        if ($frame->isFlagEnabled(FrameFlag::FLAG_COMPRESSION)) {
            $data = gzuncompress($data);
        }

        // Only in ID3v2.4
        if ($frame->isFlagEnabled(FrameFlag::FLAG_UNSYNCHRONISATION)) {
            $data = Unsynchronisation::decode($data);
        }

        return $frame
            ->setData($data);
    }
}


1		<?php
2		/**
3		* This file is part of the Metadata package.
4		*
5		* @author Daniel Schröder <[email protected]>
6		*/
7
8		namespace GravityMedia\Metadata\ID3v2\Reader;
9
10		use GravityMedia\Metadata\ID3v2\Encoder\Unsynchronisation;
11		use GravityMedia\Metadata\ID3v2\Enum\FrameFlag;
12		use GravityMedia\Metadata\ID3v2\Enum\Version;
13		use GravityMedia\Metadata\ID3v2\Frame;
14		use GravityMedia\Metadata\ID3v2\Stream\SynchsafeInteger32Reader;
15		use GravityMedia\Metadata\Metadata\FrameInterface;
16		use GravityMedia\Metadata\Metadata\HeaderInterface;
17		use GravityMedia\Stream\Enum\ByteOrder;
18		use GravityMedia\Stream\Reader\Integer16Reader;
19		use GravityMedia\Stream\Reader\Integer24Reader;
20		use GravityMedia\Stream\Reader\Integer32Reader;
21		use GravityMedia\Stream\StreamInterface;
22
23		/**
24		* ID3v2 Frame reader
25		*
26		* @package GravityMedia\Metadata\ID3v2\Reader
27		*/
28		class FrameReader
29		{
30		/**
31		* @var StreamInterface
32		*/
33		protected $stream;
34
35		/**
36		* @var HeaderInterface
37		*/
38		protected $header;
39
40		/**
41		* @var Integer16Reader
42		*/
43		protected $integer16Reader;
44
45		/**
46		* @var Integer24Reader
47		*/
48		protected $integer24Reader;
49
50		/**
51		* @var Integer32Reader
52		*/
53		protected $integer32Reader;
54
55		/**
56		* @var SynchsafeInteger32Reader
57		*/
58		protected $synchsafeInteger32Reader;
59
60		/**
61		* Create ID3v2 frame reader.
62		*
63		* @param StreamInterface $stream
64		* @param HeaderInterface $header
65		*/
66		public function __construct(StreamInterface $stream, HeaderInterface $header)
67		{
68		$this->stream = $stream;
69		$this->header = $header;
70		}
71
72		/**
73		* Get 16-bit integer reader
74		*
75		* @return Integer16Reader
76		*/
77	View Code Duplication	public function getInteger16Reader()
		0 ignored issues – show Duplication introduced 2016-03-28 15:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
78		{
79		if (null === $this->integer16Reader) {
80		$this->integer16Reader = new Integer16Reader($this->stream);
81		$this->integer16Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
82		}
83
84		return $this->integer16Reader;
85		}
86
87		/**
88		* Get 24-bit integer reader
89		*
90		* @return Integer24Reader
91		*/
92	View Code Duplication	public function getInteger24Reader()
		0 ignored issues – show Duplication introduced 2016-03-28 15:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
93		{
94		if (null === $this->integer24Reader) {
95		$this->integer24Reader = new Integer24Reader($this->stream);
96		$this->integer24Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
97		}
98
99		return $this->integer24Reader;
100		}
101
102		/**
103		* Get 32-bit integer reader
104		*
105		* @return Integer32Reader
106		*/
107	View Code Duplication	public function getInteger32Reader()
		0 ignored issues – show Duplication introduced 2016-03-28 15:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
108		{
109		if (null === $this->integer32Reader) {
110		$this->integer32Reader = new Integer32Reader($this->stream);
111		$this->integer32Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
112		}
113
114		return $this->integer32Reader;
115		}
116
117		/**
118		* Get synchsafe 32-bit integer reader
119		*
120		* @return SynchsafeInteger32Reader
121		*/
122	View Code Duplication	public function getSynchsafeInteger32Reader()
		0 ignored issues – show Duplication introduced 2016-03-28 15:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
123		{
124		if (null === $this->synchsafeInteger32Reader) {
125		$this->synchsafeInteger32Reader = new SynchsafeInteger32Reader($this->stream);
126		$this->synchsafeInteger32Reader->setByteOrder(ByteOrder::BIG_ENDIAN);
127		}
128
129		return $this->synchsafeInteger32Reader;
130		}
131
132		/**
133		* Read ID3v2 frame name.
134		*
135		* @return string
136		*/
137		protected function readName()
138		{
139		if (Version::VERSION_22 === $this->header->getVersion()) {
140		return rtrim($this->stream->read(3));
141		}
142
143		return rtrim($this->stream->read(4));
144		}
145
146		/**
147		* Read ID3v2 frame size.
148		*
149		* @return int
150		*/
151		protected function readSize()
152		{
153		if (Version::VERSION_22 === $this->header->getVersion()) {
154		return $this->getInteger24Reader()->read();
155		}
156
157		if (Version::VERSION_23 === $this->header->getVersion()) {
158		return $this->getInteger32Reader()->read();
159		}
160
161		return $this->getSynchsafeInteger32Reader()->read();
162		}
163
164		/**
165		* Read ID3v2 frame flags.
166		*
167		* @return array
168		*/
169		protected function readFlags()
170		{
171		$flags = $this->getInteger16Reader()->read();
172
173		if (Version::VERSION_23 === $this->header->getVersion()) {
174		return [
175		FrameFlag::FLAG_TAG_ALTER_PRESERVATION => (bool)($flags & 0x8000),
176		FrameFlag::FLAG_FILE_ALTER_PRESERVATION => (bool)($flags & 0x4000),
177		FrameFlag::FLAG_READ_ONLY => (bool)($flags & 0x2000),
178		FrameFlag::FLAG_COMPRESSION => (bool)($flags & 0x0080),
179		FrameFlag::FLAG_ENCRYPTION => (bool)($flags & 0x0040),
180		FrameFlag::FLAG_GROUPING_IDENTITY => (bool)($flags & 0x0020),
181		];
182		}
183
184		return [
185		FrameFlag::FLAG_TAG_ALTER_PRESERVATION => (bool)($flags & 0x4000),
186		FrameFlag::FLAG_FILE_ALTER_PRESERVATION => (bool)($flags & 0x2000),
187		FrameFlag::FLAG_READ_ONLY => (bool)($flags & 0x1000),
188		FrameFlag::FLAG_GROUPING_IDENTITY => (bool)($flags & 0x0040),
189		FrameFlag::FLAG_COMPRESSION => (bool)($flags & 0x0008),
190		FrameFlag::FLAG_ENCRYPTION => (bool)($flags & 0x0004),
191		FrameFlag::FLAG_UNSYNCHRONISATION => (bool)($flags & 0x0002),
192		FrameFlag::FLAG_DATA_LENGT_INDICATOR => (bool)($flags & 0x0001),
193		];
194		}
195
196		/**
197		* Read ID3v2 frame data length.
198		*
199		* @return int
200		*/
201		public function readDataLength()
202		{
203		return $this->getSynchsafeInteger32Reader()->read();
204		}
205
206		/**
207		* Read ID3v2 frame.
208		*
209		* @return FrameInterface
210		*/
211		public function read()
212		{
213		$name = $this->readName();
214		$size = $this->readSize();
215
216		$frame = new Frame();
217		$frame
218		->setName($name)
219		->setSize($size);
220
221		// Return empty frame
222		if (0 === $size) {
223		return $frame;
224		}
225
226		// Only in ID3v2.3 and ID3v2.4
227		if (Version::VERSION_22 !== $this->header->getVersion()) {
228		$frame->setFlags($this->readFlags());
229		}
230
231		// Only in ID3v2.4
232		if ($frame->isFlagEnabled(FrameFlag::FLAG_DATA_LENGT_INDICATOR)) {
233		$frame->setDataLength($this->readDataLength());
234
235		$size -= 4;
236		}
237
238
239		$data = $this->stream->read($size);
240		if ($frame->isFlagEnabled(FrameFlag::FLAG_COMPRESSION)) {
241		$data = gzuncompress($data);
242		}
243
244		// Only in ID3v2.4
245		if ($frame->isFlagEnabled(FrameFlag::FLAG_UNSYNCHRONISATION)) {
246		$data = Unsynchronisation::decode($data);
247		}
248
249		return $frame
250		->setData($data);
251		}
252		}
253

GravityMedia / Metadata

Push — id3-metadata-objects ( e55453...161f4c )

FrameReader::read() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like