HeaderFactory::newInstance() - Code Metrics - zbateson/mail-mime-parser - Measure and Improve Code Quality continuously with Scrutinizer

HeaderFactory::newInstance() A
last analyzed 2024-12-20 22:32 UTC

↳ Parent: HeaderFactory
Complexity

Conditions	1
Paths	1
Size

Total Lines	8
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	7
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
eloc	5
c	1
b	0
f	0
dl	0
loc	8
ccs	7
cts	7
cp	1
rs	10
cc	1
nc	1
nop	2
crap	1
<?php
/**
 * This file is part of the ZBateson\MailMimeParser project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD
 */

namespace ZBateson\MailMimeParser\Header;

use Psr\Log\LoggerInterface;
use ReflectionClass;
use ZBateson\MailMimeParser\Header\Consumer\AddressBaseConsumerService;
use ZBateson\MailMimeParser\Header\Consumer\DateConsumerService;
use ZBateson\MailMimeParser\Header\Consumer\GenericConsumerMimeLiteralPartService;
use ZBateson\MailMimeParser\Header\Consumer\IConsumerService;
use ZBateson\MailMimeParser\Header\Consumer\IdBaseConsumerService;
use ZBateson\MailMimeParser\Header\Consumer\ParameterConsumerService;
use ZBateson\MailMimeParser\Header\Consumer\ReceivedConsumerService;
use ZBateson\MailMimeParser\Header\Consumer\SubjectConsumerService;
use ZBateson\MailMimeParser\Header\Part\MimeTokenPartFactory;

/**
 * Constructs various IHeader types depending on the type of header passed.
 *
 * If the passed header resolves to a specific defined header type, it is parsed
 * as such.  Otherwise, a GenericHeader is instantiated and returned.  Headers
 * are mapped as follows:
 *
 *  - {@see AddressHeader}: From, To, Cc, Bcc, Sender, Reply-To, Resent-From,
 *    Resent-To, Resent-Cc, Resent-Bcc, Resent-Reply-To, Return-Path,
 *    Delivered-To
 *  - {@see DateHeader}: Date, Resent-Date, Delivery-Date, Expires, Expiry-Date,
 *    Reply-By
 *  - {@see ParameterHeader}: Content-Type, Content-Disposition, Received-SPF,
 *    Authentication-Results, DKIM-Signature, Autocrypt
 *  - {@see SubjectHeader}: Subject
 *  - {@see IdHeader}: Message-ID, Content-ID, In-Reply-To, References
 *  - {@see ReceivedHeader}: Received
 *
 * @author Zaahid Bateson
 */
class HeaderFactory
{
    protected LoggerInterface $logger;

    /**
     * @var IConsumerService[] array of available consumer service classes
     */
    protected array $consumerServices;

    /**
     * @var MimeTokenPartFactory for mime decoding.
     */
    protected MimeTokenPartFactory $mimeTokenPartFactory;

    /**
     * @var string[][] maps IHeader types to headers.
     */
    protected $types = [
        AddressHeader::class => [
            'from',
            'to',
            'cc',
            'bcc',
            'sender',
            'replyto',
            'resentfrom',
            'resentto',
            'resentcc',
            'resentbcc',
            'resentreplyto',
            'returnpath',
            'deliveredto',
        ],
        DateHeader::class => [
            'date',
            'resentdate',
            'deliverydate',
            'expires',
            'expirydate',
            'replyby',
        ],
        ParameterHeader::class => [
            'contenttype',
            'contentdisposition',
            'receivedspf',
            'authenticationresults',
            'dkimsignature',
            'autocrypt',
        ],
        SubjectHeader::class => [
            'subject',
        ],
        IdHeader::class => [
            'messageid',
            'contentid',
            'inreplyto',
            'references'
        ],
        ReceivedHeader::class => [
            'received'
        ]
    ];

    /**
     * @var string Defines the generic IHeader type to use for headers that
     *      aren't mapped in $types
     */
    protected $genericType = GenericHeader::class;

    public function __construct(
        LoggerInterface $logger,
        MimeTokenPartFactory $mimeTokenPartFactory,
        AddressBaseConsumerService $addressBaseConsumerService,
        DateConsumerService $dateConsumerService,
        GenericConsumerMimeLiteralPartService $genericConsumerMimeLiteralPartService,
        IdBaseConsumerService $idBaseConsumerService,
        ParameterConsumerService $parameterConsumerService,
        ReceivedConsumerService $receivedConsumerService,
        SubjectConsumerService $subjectConsumerService
    ) {
        $this->logger = $logger;
        $this->mimeTokenPartFactory = $mimeTokenPartFactory;
        $this->consumerServices = [
            AddressBaseConsumerService::class => $addressBaseConsumerService,
            DateConsumerService::class => $dateConsumerService,
            GenericConsumerMimeLiteralPartService::class => $genericConsumerMimeLiteralPartService,
            IdBaseConsumerService::class => $idBaseConsumerService,
            ParameterConsumerService::class => $parameterConsumerService,
            ReceivedConsumerService::class => $receivedConsumerService,
            SubjectConsumerService::class => $subjectConsumerService
        ];
    }

    /**
     * Returns the string in lower-case, and with non-alphanumeric characters
     * stripped out.
     *
     * @param string $header The header name
     * @return string The normalized header name
     */
    public function getNormalizedHeaderName(string $header) : string
    {
        return \preg_replace('/[^a-z0-9]/', '', \strtolower($header));
    }

    /**
     * Returns the name of an IHeader class for the passed header name.
     *
     * @param string $name The header name.
     * @return string The Fully Qualified class name.
     */
    private function getClassFor(string $name) : string
    {
        $test = $this->getNormalizedHeaderName($name);
        foreach ($this->types as $class => $matchers) {
            foreach ($matchers as $matcher) {
                if ($test === $matcher) {
                    return $class;
                }
            }
        }
        return $this->genericType;
    }

    /**
     * Creates an IHeader instance for the passed header name and value, and
     * returns it.
     *
     * @param string $name The header name.
     * @param string $value The header value.
     * @return IHeader The created header object.
     */
    public function newInstance(string $name, string $value) : IHeader
    {
        $class = $this->getClassFor($name);
        $this->logger->debug(
            'Creating {class} for header with name "{name}" and value "{value}"',
            ['class' => $class, 'name' => $name, 'value' => $value]
        );
        return $this->newInstanceOf($name, $value, $class);
    }

    /**
     * Creates an IHeader instance for the passed header name and value using
     * the passed IHeader class, and returns it.
     *
     * @param string $name The header name.
     * @param string $value The header value.
     * @param string $iHeaderClass The class to use for header creation
     * @return IHeader The created header object.
     */
    public function newInstanceOf(string $name, string $value, string $iHeaderClass) : IHeader
    {
        $ref = new ReflectionClass($iHeaderClass);
        $params = $ref->getConstructor()->getParameters();
        if ($ref->isSubclassOf(MimeEncodedHeader::class)) {
            return new $iHeaderClass(
                $name,
                $value,
                $this->logger,
                $this->mimeTokenPartFactory,
                $this->consumerServices[$params[4]->getType()->getName()]
                $this->consumerServices[$params[4]->getType()->/** @scrutinizer ignore-call */ getName()]
            );
        }
        return new $iHeaderClass(
            $name,
            $value,
            $this->logger,
            $this->consumerServices[$params[3]->getType()->getName()]
        );
    }
}

zbateson / mail-mime-parser

HeaderFactory::newInstance() A last analyzed 2024-12-20 22:32 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

HeaderFactory::newInstance() A
last analyzed 2024-12-20 22:32 UTC
