XoopsModules25x / xhelp

class/pear/Mail/mimePart.php

<?php
// +-----------------------------------------------------------------------+
// | Copyright (c) 2002  Richard Heyes                                     |
// | All rights reserved.                                                  |
// |                                                                       |
// | Redistribution and use in source and binary forms, with or without    |
// | modification, are permitted provided that the following conditions    |
// | are met:                                                              |
// |                                                                       |
// | o Redistributions of source code must retain the above copyright      |
// |   notice, this list of conditions and the following disclaimer.       |
// | o Redistributions in binary form must reproduce the above copyright   |
// |   notice, this list of conditions and the following disclaimer in the |
// |   documentation and/or other materials provided with the distribution.|
// | o The names of the authors may not be used to endorse or promote      |
// |   products derived from this software without specific prior written  |
// |   permission.                                                         |
// |                                                                       |
// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   |
// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     |
// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
// | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  |
// | OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
// | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT      |
// | LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
// | DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
// | THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   |
// | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
// | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  |
// |                                                                       |
// +-----------------------------------------------------------------------+
// | Author: Richard Heyes <richard@phpguru.org>                           |
// +-----------------------------------------------------------------------+

/**
 *  Raw mime encoding class
 *
 * What is it?
 *   This class enables you to manipulate and build
 *   a mime email from the ground up.
 *
 * Why use this instead of mime.php?
 *   mime.php is a userfriendly api to this class for
 *   people who aren't interested in the internals of
 *   mime mail. This class however allows full control
 *   over the email.
 *
 * Eg.
 *
 * // Since multipart/mixed has no real body, (the body is
 * // the subpart), we set the body argument to blank.
 *
 * $params['content_type'] = 'multipart/mixed';
 * $email = new Mail_mimePart('', $params);
 *
 * // Here we add a text part to the multipart we have
 * // already. Assume $body contains plain text.
 *
 * $params['content_type'] = 'text/plain';
 * $params['encoding']     = '7bit';
 * $text = $email->addSubPart($body, $params);
 *
 * // Now add an attachment. Assume $attach is
 * the contents of the attachment
 *
 * $params['content_type'] = 'application/zip';
 * $params['encoding']     = 'base64';
 * $params['disposition']  = 'attachment';
 * $params['dfilename']    = 'example.zip';
 * $attach =& $email->addSubPart($body, $params);
 *
 * // Now build the email. Note that the encode
 * // function returns an associative array containing two
 * // elements, body and headers. You will need to add extra
 * // headers, (eg. Mime-Version) before sending.
 *
 * $email = $message->encode();
 * $email['headers'][] = 'Mime-Version: 1.0';
 *
 *
 * Further examples are available at https://www.phpguru.org
 *
 * TODO:
 *  - Set encode() to return the $obj->encoded if encode()
 *    has already been run. Unless a flag is passed to specifically
 *    re-build the message.
 *
 * @author  Richard Heyes <richard@phpguru.org>
 * @version $Revision: 1.1 $
 */
class Mail_mimePart
{
    /**
     * The encoding type of this part
     * @var string
     */
    public $_encoding;
    /**
     * An array of subparts
     * @var array
     */
    public $_subparts;
    /**
     * The output of this part after being built
     * @var string
     */
    public $_encoded;
    /**
     * Headers for this part
     * @var array
     */
    public $_headers;
    /**
     * The body of this part (not encoded)
     * @var string
     */
    public $_body;

    /**
     * Constructor.
     *
     * Sets up the object.
     *
     * @param string $body   - The body of the mime part if any.
     * @param array  $params - An associative array of parameters:
     *                       content_type - The content type for this part eg multipart/mixed
     *                       encoding     - The encoding to use, 7bit, 8bit, base64, or quoted-printable
     *                       cid          - Content ID to apply
     *                       disposition  - Content disposition, inline or attachment
     *                       dfilename    - Optional filename parameter for content disposition
     *                       description  - Content description
     *                       charset      - Character set to use
     */
    public function __construct(string $body = '', array $params = [])
    {
        if (!defined('MAIL_MIMEPART_CRLF')) {
            define('MAIL_MIMEPART_CRLF', defined('MAIL_MIME_CRLF') ? MAIL_MIME_CRLF : "\r\n", true);
        }

        foreach ($params as $key => $value) {
            switch ($key) {
                case 'content_type':
                    $headers['Content-Type'] = $value . (isset($charset) ? '; charset="' . $charset . '"' : '');
                    break;
                case 'encoding':
                    $this->_encoding                      = $value;
                    $headers['Content-Transfer-Encoding'] = $value;
                    break;
                case 'cid':
                    $headers['Content-ID'] = '<' . $value . '>';
                    break;
                case 'disposition':
                    $headers['Content-Disposition'] = $value . (isset($dfilename) ? '; filename="' . $dfilename . '"' : '');
                    break;
                case 'dfilename':
                    if (isset($headers['Content-Disposition'])) {
                        $headers['Content-Disposition'] .= '; filename="' . $value . '"';

The variable $headers seems to be defined later in this foreach loop on line 143. Are you sure it is defined here?

                    } else {
                        $dfilename = $value;
                    }
                    break;
                case 'description':
                    $headers['Content-Description'] = $value;
                    break;
                case 'charset':
                    if (isset($headers['Content-Type'])) {
                        $headers['Content-Type'] .= '; charset="' . $value . '"';
                    } else {
                        $charset = $value;
                    }
                    break;
            }
        }

        // Default content-type
        if (!isset($headers['Content-Type'])) {
            $headers['Content-Type'] = 'text/plain';
        }

        //Default encoding
        if (!isset($this->_encoding)) {
            $this->_encoding = '7bit';
        }

        // Assign stuff to member variables
        $this->_encoded = [];

It seems like array() of type array is incompatible with the declared type string of property $_encoded.

        $this->_headers = $headers;
        $this->_body    = $body;
    }

    /**
     * encode()
     *
     * Encodes and returns the email. Also stores
     * it in the encoded member variable
     *
     * @return array|string An associative array containing two elements,
     *            body and headers. The headers element is itself
     *            an indexed array.
     */
    public function encode()
    {
        $encoded = &$this->_encoded;

        if (!empty($this->_subparts)) {
            $boundary                       = '=_' . md5(uniqid((string)mt_rand(), true) . microtime());
            $this->_headers['Content-Type'] .= ';' . MAIL_MIMEPART_CRLF . "\t" . 'boundary="' . $boundary . '"';

            // Add body parts to $subparts
            foreach ($this->_subparts as $iValue) {
                $headers = [];
                $tmp     = $iValue->encode();
                foreach ($tmp['headers'] as $key => $value) {
                    $headers[] = $key . ': ' . $value;
                }
                $subparts[] = implode(MAIL_MIMEPART_CRLF, $headers) . MAIL_MIMEPART_CRLF . MAIL_MIMEPART_CRLF . $tmp['body'];
            }

            $encoded['body'] = '--' . $boundary . MAIL_MIMEPART_CRLF . implode('--' . $boundary . MAIL_MIMEPART_CRLF, $subparts) . '--' . $boundary . '--' . MAIL_MIMEPART_CRLF;

The variable $subparts seems to be defined by a foreach iteration on line 210. Are you sure the iterator is never empty, otherwise this variable is not defined?

        } else {
            $encoded['body'] = $this->_getEncodedData($this->_body, $this->_encoding) . MAIL_MIMEPART_CRLF;
        }

        // Add headers to $encoded
        $encoded['headers'] = &$this->_headers;

        return $encoded;
    }

    /**
     * &addSubPart()
     *
     * Adds a subpart to current mime part and returns
     * a reference to it
     *
     * @param string $body   body of the subpart, if any.
     * @param array  $params parameters for the subpart, same
     *                       as the $params argument for constructor.
     * @return object A reference to the part you just added. It is
     *                       crucial if using multipart/* in your subparts that
     *                       you use =& in your script when calling this function,
     *                       otherwise you will not be able to add further subparts.
     */
    public function &addSubPart(string $body, array $params)
    {
        $this->_subparts[] = new self($body, $params);

        return $this->_subparts[count($this->_subparts) - 1];
    }

    /**
     * _getEncodedData()
     *
     * Returns encoded data based upon encoding passed to it
     *
     * @param string $data     data to encode.
     * @param string $encoding encoding type to use, 7bit, base64,
     *                         or quoted-printable.
     * @return bool|string|
     */
    public function _getEncodedData(string $data, string $encoding)
    {
        switch ($encoding) {
            case '8bit':
            case '7bit':
                return $data;
            case 'quoted-printable':
                return $this->_quotedPrintableEncode($data);
            case 'base64':
                return rtrim(chunk_split(base64_encode($data), 76, MAIL_MIMEPART_CRLF));
            default:
                return $data;
        }
    }

    /**
     * quoteadPrintableEncode()
     *
     * Encodes data to quoted-printable standard.
     *
     * @param string $input    data to encode
     * @param int    $line_max Optional max line length. Should
     *                         not be more than 76 chars
     *
     * @return bool|string
     */
    public function _quotedPrintableEncode(string $input, int $line_max = 76)
    {
        $lines  = preg_split("/\r?\n/", $input);
        $eol    = MAIL_MIMEPART_CRLF;
        $escape = '=';
        $output = '';

        while ([, $line] = each($lines)) {
            $linlen  = mb_strlen($line);
            $newline = '';

            for ($i = 0; $i < $linlen; ++$i) {
                $char = mb_substr($line, $i, 1);
                $dec  = ord($char);

                if ((32 == $dec) && ($i == ($linlen - 1))) {    // convert space at eol only
                    $char = '=20';
                } elseif (9 == $dec) {
                    // Do nothing if a tab.
                } elseif ((61 == $dec) || ($dec < 32) || ($dec > 126)) {
                    $char = $escape . \mb_strtoupper(sprintf('%02s', dechex($dec)));
                }

                if ((mb_strlen($newline) + mb_strlen($char)) >= $line_max) {                                                                                                                                                                                            // MAIL_MIMEPART_CRLF is not counted
                    $output  .= $newline
                                . $escape
                                . $eol;                                                                                                                                                                                                                                 // soft line break; " =\r\n" is okay
                    $newline = '';
                }
                $newline .= $char;
            } // end of for
            $output .= $newline . $eol;
        }
        $output = mb_substr($output, 0, -1 * mb_strlen($eol)); // Don't want last crlf

        return $output;
    }
} // End of class