ZBateson\MailMimeParser\Stream\PartStreamRegistry

Complexity

Total Complexity

21

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

33.33%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	7	2
A	unregister()	0	5	1
A	increaseHandleRefCount()	0	4	1
A	decreaseHandleRefCount()	0	7	2
A	get()	0	7	2
B	attachEncodingFilterToStream()	0	20	7
A	attachCharsetFilterToStream()	0	11	2
A	attachContentPartStreamHandle()	0	13	2
A	attachOriginalPartStreamHandle()	0	11	2

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

use ZBateson\MailMimeParser\Message\MimePart;
use ZBateson\MailMimeParser\Message;

/**
 * Factory class for PartStream objects and registration class for Message
 * handles.
 * 
 * PartStreamRegistry is used for \ZBateson\MailMimeParser\Message\MessageParser to
 * register Message stream handles for opening with PartStreams, and to open
 * file handles for specific mime parts of a message.  The PartStreamRegistry
 * maintains a list of opened resources, closing them either when unregistering
 * a Message or on destruction.
 *
 * @author Zaahid Bateson
 */
class PartStreamRegistry
{
    /**
     * @var array Array of handles, with message IDs as keys.
     */
    private $registeredHandles;
    
    /**
     * @var int[] number of registered part stream handles with message IDs as
     * keys
     */
    private $numRefCountsForHandles;

    /**
     * Registers an ID for the passed resource handle.
     * 
     * @param string $id
     * @param resource $handle
     */
    public function register($id, $handle)
    {
        if (!isset($this->registeredHandles[$id])) {
            $this->registeredHandles[$id] = $handle;
            $this->numRefCountsForHandles[$id] = 0;
        }
    }

    /**
     * Unregisters the given message ID and closes the associated resource
     * handle.
     * 
     * @param string $id
     */
    protected function unregister($id)
    {
        fclose($this->registeredHandles[$id]);
        unset($this->registeredHandles[$id], $this->registeredPartStreamHandles[$id]);
    }
    
    /**
     * Increases the reference count for streams using the resource handle
     * associated with the message id.
     * 
     * @param int $messageId
     */
    public function increaseHandleRefCount($messageId)
    {
        $this->numRefCountsForHandles[$messageId] += 1;
    }
    
    /**
     * Decreases the reference count for streams using the resource handle
     * associated with the message id.  Once the reference count hits 0,
     * unregister is called.
     * 
     * @param int $messageId
     */
    public function decreaseHandleRefCount($messageId)
    {
        $this->numRefCountsForHandles[$messageId] -= 1;
        if ($this->numRefCountsForHandles[$messageId] === 0) {
            $this->unregister($messageId);
        }
    }

    /**
     * Returns the resource handle with the passed $id.
     * 
     * @param string $id
     * @return resource
     */
    public function get($id)
    {
        if (!isset($this->registeredHandles[$id])) {
            return null;
        }
        return $this->registeredHandles[$id];
    }
    
    /**
     * Attaches a stream filter on the passed resource $handle for the part's
     * encoding.
     * 
     * @param \ZBateson\MailMimeParser\Message\MimePart $part
     * @param resource $handle
     */
    private function attachEncodingFilterToStream(MimePart $part, $handle)
    {
        $encoding = strtolower($part->getHeaderValue('Content-Transfer-Encoding'));
        switch ($encoding) {
            case 'quoted-printable':
                stream_filter_append($handle, 'mmp-convert.quoted-printable-decode', STREAM_FILTER_READ);
                break;
            case 'base64':
                stream_filter_append($handle, 'mmp-convert.base64-decode', STREAM_FILTER_READ);
                break;
            case 'x-uuencode':
            case 'x-uue':
            case 'uuencode':
            case 'uue':
                stream_filter_append($handle, 'mailmimeparser-uudecode', STREAM_FILTER_READ);
                break;
            default:
                break;
        }
    }
    
    /**
     * Attaches a mailmimeparser-encode stream filter based on the part's
     * defined charset.
     * 
     * @param \ZBateson\MailMimeParser\Message\MimePart $part
     * @param resource $handle
     */
    private function attachCharsetFilterToStream(MimePart $part, $handle)
    {
        if ($part->isTextPart()) {
            stream_filter_append(
                $handle,
                'mailmimeparser-encode',
                STREAM_FILTER_READ,
                [ 'charset' => $part->getHeaderParameter('Content-Type', 'charset') ]
            );
        }
    }

    /**
     * Creates a part stream handle for the start and end position of the
     * message stream, and attaches it to the passed MimePart.
     * 
     * @param MimePart $part
     * @param Message $message
     * @param int $start
     * @param int $end
     */
    public function attachContentPartStreamHandle(MimePart $part, Message $message, $start, $end)
    {
        $id = $message->getObjectId();
        if (empty($this->registeredHandles[$id])) {
            return null;
        }
        $handle = fopen('mmp-mime-message://' . $id . '?start=' .
            $start . '&end=' . $end, 'r');
        
        $this->attachEncodingFilterToStream($part, $handle);
        $this->attachCharsetFilterToStream($part, $handle);
        $part->attachContentResourceHandle($handle);
    }
    
    /**
     * Creates a part stream handle for the start and end position of the
     * message stream, and attaches it to the passed MimePart.
     * 
     * @param MimePart $part
     * @param Message $message
     * @param int $start
     * @param int $end
     */
    public function attachOriginalPartStreamHandle(MimePart $part, Message $message, $start, $end)
    {
        $id = $message->getObjectId();
        if (empty($this->registeredHandles[$id])) {
            return null;
        }
        $handle = fopen('mmp-mime-message://' . $id . '?start=' .
            $start . '&end=' . $end, 'r');
        
        $part->attachOriginalStreamHandle($handle);
    }
}