Parser.php

<?php

/*
 * This file is part of BeSimpleSoapCommon.
 *
 * (c) Christian Kerl <christian-kerl@web.de>
 * (c) Francis Besset <francis.besset@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace BeSimple\SoapCommon\Mime;

/**
 * Simple Multipart-Mime parser.
 *
 * @author Andreas Schamberger <mail@andreass.net>
 */
class Parser
{
    /**
     * Parse the given Mime-Message and return a \BeSimple\SoapCommon\Mime\MultiPart object.
     *
     * @param string                $mimeMessage Mime message string
     * @param array(string=>string) $headers     Array of header elements (e.g. coming from http request)
     *
     * @return \BeSimple\SoapCommon\Mime\MultiPart
     */
    public static function parseMimeMessage($mimeMessage, array $headers = array())
    {
        $boundary = null;
        $start = null;
        $multipart = new MultiPart();
        $hitFirstBoundary = false;
        $inHeader = true;
        // add given headers, e.g. coming from HTTP headers
        if (count($headers) > 0) {
            foreach ($headers as $name => $value) {
                if ($name == 'Content-Type') {
                    self::parseContentTypeHeader($multipart, $name, $value);
                    $boundary = $multipart->getHeader('Content-Type', 'boundary');
                    $start = $multipart->getHeader('Content-Type', 'start');
                } else {
                    $multipart->setHeader($name, $value);
                }
            }
            $inHeader = false;
        }
        $content = '';
        $currentPart = $multipart;
        $lines = preg_split("/(\r\n)/", $mimeMessage);
        foreach ($lines as $line) {
            // ignore http status code and POST *
            if (substr($line, 0, 5) == 'HTTP/' || substr($line, 0, 4) == 'POST') {
                continue;
            }
            if (isset($currentHeader)) {
                if (isset($line[0]) && ($line[0] === ' ' || $line[0] === "\t")) {
                    $currentHeader .= $line;
                    continue;
                }
                if (strpos($currentHeader, ':') !== false) {
                    list($headerName, $headerValue) = explode(':', $currentHeader, 2);
                    $headerValue = iconv_mime_decode($headerValue, 0, 'utf-8');
                    if (strpos($headerValue, ';') !== false) {
                        self::parseContentTypeHeader($currentPart, $headerName, $headerValue);
                        $boundary = $multipart->getHeader('Content-Type', 'boundary');
                        $start = $multipart->getHeader('Content-Type', 'start');
                    } else {
                        $currentPart->setHeader($headerName, trim($headerValue));
                    }
                }
                unset($currentHeader);
            }
            if ($inHeader) {
                if (trim($line) == '') {
                    $inHeader = false;
                    continue;
                }
                $currentHeader = $line;
                continue;
            } else {
                // check if we hit any of the boundaries
                if (strlen($line) > 0 && $line[0] == "-") {
                    if (strcmp(trim($line), '--' . $boundary) === 0) {
                        if ($currentPart instanceof Part) {
                            $content = substr($content, 0, -2);
                            self::decodeContent($currentPart, $content);
                            // check if there is a start parameter given, if not set first part
                            $isMain = (is_null($start) || $start == $currentPart->getHeader('Content-ID')) ? true : false;
                            if ($isMain === true) {
                                $start = $currentPart->getHeader('Content-ID');
                            }
                            $multipart->addPart($currentPart, $isMain);
                        }
                        $currentPart = new Part();
                        $hitFirstBoundary = true;
                        $inHeader = true;
                        $content = '';
                    } elseif (strcmp(trim($line), '--' . $boundary . '--') === 0) {
                        $content = substr($content, 0, -2);
                        self::decodeContent($currentPart, $content);
                        // check if there is a start parameter given, if not set first part
                        $isMain = (is_null($start) || $start == $currentPart->getHeader('Content-ID')) ? true : false;
                        if ($isMain === true) {
                            $start = $currentPart->getHeader('Content-ID');
                        }
                        $multipart->addPart($currentPart, $isMain);
                        $content = '';
                    } else {
                        $content .= $line . "\r\n";                        
                    } 
                } else {
                    if ($hitFirstBoundary === false) {
                        if (trim($line) != '') {
                            $inHeader = true;
                            $currentHeader = $line;
                            continue;
                        }
                    }
                    $content .= $line . "\r\n";
                }
            }
        }
        return $multipart;
    }

    /**
     * Parse a "Content-Type" header with multiple sub values.
     * e.g. Content-Type: multipart/related; boundary=boundary; type=text/xml;
     * start="<123@abc>"
     *
     * Based on: https://labs.omniti.com/alexandria/trunk/OmniTI/Mail/Parser.php
     *
     * @param \BeSimple\SoapCommon\Mime\PartHeader $part        Header part
     * @param string                               $headerName  Header name
     * @param string                               $headerValue Header value
     *
     * @return null
     */
    private static function parseContentTypeHeader(PartHeader $part, $headerName, $headerValue)
    {
        list($value, $remainder) = explode(';', $headerValue, 2);
        $value = trim($value);
        $part->setHeader($headerName, $value);
        $remainder = trim($remainder);
        while (strlen($remainder) > 0) {
            if (!preg_match('/^([a-zA-Z0-9_-]+)=(.{1})/', $remainder, $matches)) {
                break;
            }
            $name = $matches[1];
            $delimiter = $matches[2];
            $remainder = substr($remainder, strlen($name)+1);
            if (!preg_match('/([^;]+)(;)?(\s|$)?/', $remainder, $matches)) {
                break;
            }
            $value = rtrim($matches[1], ';');
            if ($delimiter == "'" || $delimiter == '"') {
                $value = trim($value, $delimiter);
            }
            $part->setHeader($headerName, $name, $value);
            $remainder = substr($remainder, strlen($matches[0]));
        }
    }

    /**
     * Decodes the content of a Mime part.
     *
     * @param \BeSimple\SoapCommon\Mime\Part $part    Part to add content
     * @param string                         $content Content to decode
     *
     * @return null
     */
    private static function decodeContent(Part $part, $content)
    {
        $encoding = strtolower($part->getHeader('Content-Transfer-Encoding'));
        $charset = strtolower($part->getHeader('Content-Type', 'charset'));
        if ($encoding == Part::ENCODING_BASE64) {
            $content = base64_decode($content);
        } elseif ($encoding == Part::ENCODING_QUOTED_PRINTABLE) {
            $content = quoted_printable_decode($content);
        }
        if ($charset != 'utf-8') {
            $content = iconv($charset, 'utf-8', $content);
        }
        $part->setContent($content);
    }
}