PartStreamFilterManager::getContentHandle() - Code Metrics - Inspection of "Fix tests and code to use Psr7 StreamInterface" - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.0.0 ( 4505d9...06b3ad )

by Zaahid

created 2018-04-24 02:51 UTC

PartStreamFilterManager::getContentHandle() A

↳ Parent: Project

Complexity

Conditions	4
Paths	2

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	7
nc	2
nop	3
dl	0
loc	10
ccs	3
cts	3
cp	1
crap	4
rs	9.2
c	0
b	0
f	0

<?php
/**
 * This file is part of the ZBateson\MailMimeParser project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */
namespace ZBateson\MailMimeParser\Message\Part;

use Psr\Http\Message\StreamInterface;
use ZBateson\MailMimeParser\Stream\StreamDecoratorFactory;

/**
 * Manages attached stream filters for a MessagePart's content resource handle.
 * 
 * The attached stream filters are:
 *  o Content-Transfer-Encoding filter to manage decoding from a supported
 *    encoding: quoted-printable, base64 and x-uuencode.
 *  o Charset conversion filter to convert to UTF-8
 *
 * @author Zaahid Bateson
 */
class PartStreamFilterManager
{
    /**
     * @var StreamInterface the content stream after attaching encoding filters
     */
    protected $filteredStream;
    
    /**
     * @var StreamInterface the underlying content stream without filters
     *      applied
     */
    protected $stream;
    
    /**
     * @var array map of the active encoding filter on the current handle.
     */
    private $encoding = [
        'type' => null,
        'filter' => null
    ];
    
    /**
     * @var array map of the active charset filter on the current handle.
     */
    private $charset = [
        'from' => null,
        'to' => null,
        'filter' => null
    ];

    /**
     * @var StreamDecoratorFactory used to apply psr7 stream decorators to the
     *      attached StreamInterface based on encoding.
     */
    private $streamDecoratorFactory;
    
    /**
     * @var string name of stream filter handling character set conversion
     */
    private $charsetConversionFilter;
    
    /**
     * Sets up filter names used for stream_filter_append
     * 
     * @param StreamDecoratorFactory $streamDecoratorFactory
     */
    public function __construct(StreamDecoratorFactory $streamDecoratorFactory)
    {
        $this->streamDecoratorFactory = $streamDecoratorFactory;
        $this->encodingEncoderMap = [

            'quoted-printable' => '',
            'base64' => '',
            'x-uuencode' => ''
        ];
        $this->charsetConversionFilter = '';
    }
    
    /**
     * Closes the contentHandle if one is attached.
     */
    public function __destruct()
    {
        if ($this->filteredStream !== null) {
            $this->filteredStream->close();
        }
        if ($this->stream !== null) {
            $this->stream->close();
        }
    }
    
    /**
     * Sets the URL used to open the content resource handle.
     * 
     * The function also closes the currently attached handle if any.
     * 
     * @param StreamInterface $stream
     */
    public function setStream(StreamInterface $stream)
    {
        if ($this->filteredStream !== null && $this->filteredStream !== $this->stream) {
            $this->filteredStream->close();
        }
        if ($this->stream !== null) {
            $this->stream->close();
        }
        $this->stream = $stream;
        $this->filteredStream = null;
    }
    
    /**
     * Returns true if the attached stream filter used for decoding the content
     * on the current handle is different from the one passed as an argument.
     * 
     * @param string $transferEncoding
     * @return boolean
     */
    private function isTransferEncodingFilterChanged($transferEncoding)
    {
        return ($transferEncoding !== $this->encoding['type']);
    }
    
    /**
     * Returns true if the attached stream filter used for charset conversion on
     * the current handle is different from the one needed based on the passed 
     * arguments.
     * 
     * @param string $fromCharset
     * @param string $toCharset
     * @return boolean
     */
    private function isCharsetFilterChanged($fromCharset, $toCharset)
    {
        return ($fromCharset !== $this->charset['from']
            || $toCharset !== $this->charset['to']);
    }
    
    /**
     * Attaches a decoding filter to the attached content handle, for the passed
     * $transferEncoding.
     * 
     * @param string $transferEncoding
     */
    protected function attachTransferEncodingFilter($transferEncoding)
    {
        if ($this->filteredStream !== null) {
            $this->encoding['type'] = $transferEncoding;
            switch ($transferEncoding) {
                case 'base64':
                    $this->filteredStream = $this->streamDecoratorFactory->newBase64StreamDecorator($this->filteredStream);
                    break;
                case 'x-uuencode':
                    $this->filteredStream = $this->streamDecoratorFactory->newUUStreamDecorator($this->filteredStream);
                    break;
                case 'quoted-printable':
                    $this->filteredStream = $this->streamDecoratorFactory->newQuotedPrintableStreamDecorator($this->filteredStream);
                    break;
            }
        }
    }
    
    /**
     * Attaches a charset conversion filter to the attached content handle, for
     * the passed arguments.
     * 
     * @param string $fromCharset the character set the content is encoded in
     * @param string $toCharset the target encoding to return
     */
    protected function attachCharsetFilter($fromCharset, $toCharset)
    {
        if ($this->filteredStream !== null) {
            if (!empty($fromCharset) && !empty($toCharset)) {
                $this->filteredStream = $this->streamDecoratorFactory->newCharsetStreamDecorator(
                    $this->filteredStream,
                    $fromCharset,
                    $toCharset
                );
            }
            $this->charset['from'] = $fromCharset;
            $this->charset['to'] = $toCharset;
        }
    }
    
    /**
     * Closes the attached resource handle, resets mapped encoding and charset
     * filters, and reopens the handle seeking back to the current position.
     * 
     * Note that closing/reopening is done because of the following differences
     * discovered between hhvm (up to 3.18 at least) and php:
     * 
     *  o stream_filter_remove wasn't triggering php_user_filter's onClose
     *    callback
     *  o read operations performed after stream_filter_remove weren't calling
     *    filter on php_user_filter
     * 
     * It seems stream_filter_remove doesn't work on hhvm, or isn't implemented
     * in the same way -- so closing and reopening seems to solve that.
     */
    public function reset()
    {
        if ($this->filteredStream !== null && $this->filteredStream !== $this->stream) {
            $this->filteredStream->close();
        }
        $this->encoding = [
            'type' => null,
            'filter' => null
        ];
        $this->charset = [
            'from' => null,
            'to' => null,
            'filter' => null
        ];
        $this->filteredStream = $this->stream;
    }
    
    /**
     * Checks what transfer-encoding decoder filters and charset conversion
     * filters are attached on the handle, closing/reopening the handle if
     * different, before attaching relevant filters for the passed
     * $transferEncoding and charset arguments, and returning a StreamInterface.
     * 
     * @param string $transferEncoding
     * @param string $fromCharset the character set the content is encoded in
     * @param string $toCharset the target encoding to return
     * @return StreamInterface
     */
    public function getContentStream($transferEncoding, $fromCharset, $toCharset)
    {
        if ($this->filteredStream === null
            || $this->isTransferEncodingFilterChanged($transferEncoding)
            || $this->isCharsetFilterChanged($fromCharset, $toCharset)) {
            $this->reset();
            $this->attachTransferEncodingFilter($transferEncoding);
            $this->attachCharsetFilter($fromCharset, $toCharset);
        }
        $this->filteredStream->rewind();
        return $this->filteredStream;
    }
}


1		<?php
2		/**
3		* This file is part of the ZBateson\MailMimeParser project.
4		*
5		* @license http://opensource.org/licenses/bsd-license.php BSD
6		*/
7		namespace ZBateson\MailMimeParser\Message\Part;
8
9		use Psr\Http\Message\StreamInterface;
10		use ZBateson\MailMimeParser\Stream\StreamDecoratorFactory;
11
12		/**
13		* Manages attached stream filters for a MessagePart's content resource handle.
14		*
15		* The attached stream filters are:
16		* o Content-Transfer-Encoding filter to manage decoding from a supported
17		* encoding: quoted-printable, base64 and x-uuencode.
18		* o Charset conversion filter to convert to UTF-8
19		*
20		* @author Zaahid Bateson
21		*/
22		class PartStreamFilterManager
23		{
24		/**
25		* @var StreamInterface the content stream after attaching encoding filters
26		*/
27		protected $filteredStream;
28
29		/**
30		* @var StreamInterface the underlying content stream without filters
31		* applied
32		*/
33		protected $stream;
34
35		/**
36		* @var array map of the active encoding filter on the current handle.
37		*/
38		private $encoding = [
39		'type' => null,
40		'filter' => null
41		];
42
43		/**
44		* @var array map of the active charset filter on the current handle.
45		*/
46		private $charset = [
47		'from' => null,
48		'to' => null,
49		'filter' => null
50		];
51
52		/**
53		* @var StreamDecoratorFactory used to apply psr7 stream decorators to the
54		* attached StreamInterface based on encoding.
55		*/
56		private $streamDecoratorFactory;
57
58		/**
59		* @var string name of stream filter handling character set conversion
60		*/
61		private $charsetConversionFilter;
62
63		/**
64		* Sets up filter names used for stream_filter_append
65		*
66		* @param StreamDecoratorFactory $streamDecoratorFactory
67		*/
68	7	public function __construct(StreamDecoratorFactory $streamDecoratorFactory)
69		{
70	7	$this->streamDecoratorFactory = $streamDecoratorFactory;
71	7	$this->encodingEncoderMap = [
		0 ignored issues – show Bug Best Practice introduced 2018-04-24 02:55 UTC by Report Bug Copy Issue Report The property `encodingEncoderMap` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
72		'quoted-printable' => '',
73		'base64' => '',
74		'x-uuencode' => ''
75		];
76	7	$this->charsetConversionFilter = '';
77	7	}
78
79		/**
80		* Closes the contentHandle if one is attached.
81		*/
82		public function __destruct()
83		{
84		if ($this->filteredStream !== null) {
85		$this->filteredStream->close();
86		}
87		if ($this->stream !== null) {
88		$this->stream->close();
89		}
90		}
91
92		/**
93		* Sets the URL used to open the content resource handle.
94		*
95		* The function also closes the currently attached handle if any.
96		*
97		* @param StreamInterface $stream
98		*/
99	7	public function setStream(StreamInterface $stream)
100		{
101	7	if ($this->filteredStream !== null && $this->filteredStream !== $this->stream) {
102		$this->filteredStream->close();
103		}
104	7	if ($this->stream !== null) {
105		$this->stream->close();
106		}
107	7	$this->stream = $stream;
108	7	$this->filteredStream = null;
109	7	}
110
111		/**
112		* Returns true if the attached stream filter used for decoding the content
113		* on the current handle is different from the one passed as an argument.
114		*
115		* @param string $transferEncoding
116		* @return boolean
117		*/
118	3	private function isTransferEncodingFilterChanged($transferEncoding)
119		{
120	3	return ($transferEncoding !== $this->encoding['type']);
121		}
122
123		/**
124		* Returns true if the attached stream filter used for charset conversion on
125		* the current handle is different from the one needed based on the passed
126		* arguments.
127		*
128		* @param string $fromCharset
129		* @param string $toCharset
130		* @return boolean
131		*/
132	3	private function isCharsetFilterChanged($fromCharset, $toCharset)
133		{
134	3	return ($fromCharset !== $this->charset['from']
135	3	\|\| $toCharset !== $this->charset['to']);
136		}
137
138		/**
139		* Attaches a decoding filter to the attached content handle, for the passed
140		* $transferEncoding.
141		*
142		* @param string $transferEncoding
143		*/
144	7	protected function attachTransferEncodingFilter($transferEncoding)
145		{
146	7	if ($this->filteredStream !== null) {
147	7	$this->encoding['type'] = $transferEncoding;
148		switch ($transferEncoding) {
149	7	case 'base64':
150	1	$this->filteredStream = $this->streamDecoratorFactory->newBase64StreamDecorator($this->filteredStream);
151	1	break;
152	6	case 'x-uuencode':
153	2	$this->filteredStream = $this->streamDecoratorFactory->newUUStreamDecorator($this->filteredStream);
154	2	break;
155	5	case 'quoted-printable':
156	3	$this->filteredStream = $this->streamDecoratorFactory->newQuotedPrintableStreamDecorator($this->filteredStream);
157	3	break;
158		}
159		}
160	7	}
161
162		/**
163		* Attaches a charset conversion filter to the attached content handle, for
164		* the passed arguments.
165		*
166		* @param string $fromCharset the character set the content is encoded in
167		* @param string $toCharset the target encoding to return
168		*/
169	7	protected function attachCharsetFilter($fromCharset, $toCharset)
170		{
171	7	if ($this->filteredStream !== null) {
172	7	if (!empty($fromCharset) && !empty($toCharset)) {
173	3	$this->filteredStream = $this->streamDecoratorFactory->newCharsetStreamDecorator(
174	3	$this->filteredStream,
175	3	$fromCharset,
176	3	$toCharset
177		);
178		}
179	7	$this->charset['from'] = $fromCharset;
180	7	$this->charset['to'] = $toCharset;
181		}
182	7	}
183
184		/**
185		* Closes the attached resource handle, resets mapped encoding and charset
186		* filters, and reopens the handle seeking back to the current position.
187		*
188		* Note that closing/reopening is done because of the following differences
189		* discovered between hhvm (up to 3.18 at least) and php:
190		*
191		* o stream_filter_remove wasn't triggering php_user_filter's onClose
192		* callback
193		* o read operations performed after stream_filter_remove weren't calling
194		* filter on php_user_filter
195		*
196		* It seems stream_filter_remove doesn't work on hhvm, or isn't implemented
197		* in the same way -- so closing and reopening seems to solve that.
198		*/
199	7	public function reset()
200		{
201	7	if ($this->filteredStream !== null && $this->filteredStream !== $this->stream) {
202	1	$this->filteredStream->close();
203		}
204	7	$this->encoding = [
205		'type' => null,
206		'filter' => null
207		];
208	7	$this->charset = [
209		'from' => null,
210		'to' => null,
211		'filter' => null
212		];
213	7	$this->filteredStream = $this->stream;
214	7	}
215
216		/**
217		* Checks what transfer-encoding decoder filters and charset conversion
218		* filters are attached on the handle, closing/reopening the handle if
219		* different, before attaching relevant filters for the passed
220		* $transferEncoding and charset arguments, and returning a StreamInterface.
221		*
222		* @param string $transferEncoding
223		* @param string $fromCharset the character set the content is encoded in
224		* @param string $toCharset the target encoding to return
225		* @return StreamInterface
226		*/
227	7	public function getContentStream($transferEncoding, $fromCharset, $toCharset)
228		{
229	7	if ($this->filteredStream === null
230	3	\|\| $this->isTransferEncodingFilterChanged($transferEncoding)
231	7	\|\| $this->isCharsetFilterChanged($fromCharset, $toCharset)) {
232	7	$this->reset();
233	7	$this->attachTransferEncodingFilter($transferEncoding);
234	7	$this->attachCharsetFilter($fromCharset, $toCharset);
235		}
236	7	$this->filteredStream->rewind();
237	7	return $this->filteredStream;
238		}
239		}
240

zbateson / mail-mime-parser

Push — 1.0.0 ( 4505d9...06b3ad )

PartStreamFilterManager::getContentHandle() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like