interface/modules/zend_modules/library/Zend/Mime/Decode.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Mime;
  11
  12 use Zend\Mail\Headers;
  13 use Zend\Stdlib\ErrorHandler;
  14
  15 class Decode
  16 {
  17     /**
  18      * Explode MIME multipart string into separate parts
  19      *
  20      * Parts consist of the header and the body of each MIME part.
  21      *
  22      * @param  string $body     raw body of message
  23      * @param  string $boundary boundary as found in content-type
  24      * @return array parts with content of each part, empty if no parts found
  25      * @throws Exception\RuntimeException
  26      */
  27     public static function splitMime($body, $boundary)
  28     {
  29         // TODO: we're ignoring \r for now - is this function fast enough and is it safe to assume noone needs \r?
  30         $body = str_replace("\r", '', $body);
  31
  32         $start = 0;
  33         $res = array();
  34         // find every mime part limiter and cut out the
  35         // string before it.
  36         // the part before the first boundary string is discarded:
  37         $p = strpos($body, '--' . $boundary . "\n", $start);
  38         if ($p === false) {
  39             // no parts found!
  40             return array();
  41         }
  42
  43         // position after first boundary line
  44         $start = $p + 3 + strlen($boundary);
  45
  46         while (($p = strpos($body, '--' . $boundary . "\n", $start)) !== false) {
  47             $res[] = substr($body, $start, $p-$start);
  48             $start = $p + 3 + strlen($boundary);
  49         }
  50
  51         // no more parts, find end boundary
  52         $p = strpos($body, '--' . $boundary . '--', $start);
  53         if ($p===false) {
  54             throw new Exception\RuntimeException('Not a valid Mime Message: End Missing');
  55         }
  56
  57         // the remaining part also needs to be parsed:
  58         $res[] = substr($body, $start, $p-$start);
  59         return $res;
  60     }
  61
  62     /**
  63      * decodes a mime encoded String and returns a
  64      * struct of parts with header and body
  65      *
  66      * @param  string $message  raw message content
  67      * @param  string $boundary boundary as found in content-type
  68      * @param  string $EOL EOL string; defaults to {@link Zend\Mime\Mime::LINEEND}
  69      * @return array|null parts as array('header' => array(name => value), 'body' => content), null if no parts found
  70      * @throws Exception\RuntimeException
  71      */
  72     public static function splitMessageStruct($message, $boundary, $EOL = Mime::LINEEND)
  73     {
  74         $parts = static::splitMime($message, $boundary);
  75         if (count($parts) <= 0) {
  76             return null;
  77         }
  78         $result = array();
  79         $headers = null; // "Declare" variable before the first usage "for reading"
  80         $body    = null; // "Declare" variable before the first usage "for reading"
  81         foreach ($parts as $part) {
  82             static::splitMessage($part, $headers, $body, $EOL);
  83             $result[] = array('header' => $headers,
  84                               'body'   => $body    );
  85         }
  86         return $result;
  87     }
  88
  89     /**
  90      * split a message in header and body part, if no header or an
  91      * invalid header is found $headers is empty
  92      *
  93      * The charset of the returned headers depend on your iconv settings.
  94      *
  95      * @param  string|Headers  $message raw message with header and optional content
  96      * @param  Headers         $headers output param, headers container
  97      * @param  string          $body    output param, content of message
  98      * @param  string          $EOL EOL string; defaults to {@link Zend\Mime\Mime::LINEEND}
  99      * @param  bool         $strict  enable strict mode for parsing message
 100      * @return null
 101      */
 102     public static function splitMessage($message, &$headers, &$body, $EOL = Mime::LINEEND, $strict = false)
 103     {
 104         if ($message instanceof Headers) {
 105             $message = $message->toString();
 106         }
 107         // check for valid header at first line
 108         $firstline = strtok($message, "\n");
 109         if (!preg_match('%^[^\s]+[^:]*:%', $firstline)) {
 110             $headers = array();
 111             // TODO: we're ignoring \r for now - is this function fast enough and is it safe to assume noone needs \r?
 112             $body = str_replace(array("\r", "\n"), array('', $EOL), $message);
 113             return;
 114         }
 115
 116         // see @ZF2-372, pops the first line off a message if it doesn't contain a header
 117         if (!$strict) {
 118             $parts = explode(':', $firstline, 2);
 119             if (count($parts) != 2) {
 120                 $message = substr($message, strpos($message, $EOL)+1);
 121             }
 122         }
 123
 124         // find an empty line between headers and body
 125         // default is set new line
 126         if (strpos($message, $EOL . $EOL)) {
 127             list($headers, $body) = explode($EOL . $EOL, $message, 2);
 128         // next is the standard new line
 129         } elseif ($EOL != "\r\n" && strpos($message, "\r\n\r\n")) {
 130             list($headers, $body) = explode("\r\n\r\n", $message, 2);
 131         // next is the other "standard" new line
 132         } elseif ($EOL != "\n" && strpos($message, "\n\n")) {
 133             list($headers, $body) = explode("\n\n", $message, 2);
 134         // at last resort find anything that looks like a new line
 135         } else {
 136             ErrorHandler::start(E_NOTICE|E_WARNING);
 137             list($headers, $body) = preg_split("%([\r\n]+)\\1%U", $message, 2);
 138             ErrorHandler::stop();
 139         }
 140
 141         $headers = Headers::fromString($headers, $EOL);
 142     }
 143
 144     /**
 145      * split a content type in its different parts
 146      *
 147      * @param  string $type       content-type
 148      * @param  string $wantedPart the wanted part, else an array with all parts is returned
 149      * @return string|array wanted part or all parts as array('type' => content-type, partname => value)
 150      */
 151     public static function splitContentType($type, $wantedPart = null)
 152     {
 153         return static::splitHeaderField($type, $wantedPart, 'type');
 154     }
 155
 156     /**
 157      * split a header field like content type in its different parts
 158      *
 159      * @param  string $field      header field
 160      * @param  string $wantedPart the wanted part, else an array with all parts is returned
 161      * @param  string $firstName  key name for the first part
 162      * @return string|array wanted part or all parts as array($firstName => firstPart, partname => value)
 163      * @throws Exception\RuntimeException
 164      */
 165     public static function splitHeaderField($field, $wantedPart = null, $firstName = '0')
 166     {
 167         $wantedPart = strtolower($wantedPart);
 168         $firstName = strtolower($firstName);
 169
 170         // special case - a bit optimized
 171         if ($firstName === $wantedPart) {
 172             $field = strtok($field, ';');
 173             return $field[0] == '"' ? substr($field, 1, -1) : $field;
 174         }
 175
 176         $field = $firstName . '=' . $field;
 177         if (!preg_match_all('%([^=\s]+)\s*=\s*("[^"]+"|[^;]+)(;\s*|$)%', $field, $matches)) {
 178             throw new Exception\RuntimeException('not a valid header field');
 179         }
 180
 181         if ($wantedPart) {
 182             foreach ($matches[1] as $key => $name) {
 183                 if (strcasecmp($name, $wantedPart)) {
 184                     continue;
 185                 }
 186                 if ($matches[2][$key][0] != '"') {
 187                     return $matches[2][$key];
 188                 }
 189                 return substr($matches[2][$key], 1, -1);
 190             }
 191             return null;
 192         }
 193
 194         $split = array();
 195         foreach ($matches[1] as $key => $name) {
 196             $name = strtolower($name);
 197             if ($matches[2][$key][0] == '"') {
 198                 $split[$name] = substr($matches[2][$key], 1, -1);
 199             } else {
 200                 $split[$name] = $matches[2][$key];
 201             }
 202         }
 203
 204         return $split;
 205     }
 206
 207     /**
 208      * decode a quoted printable encoded string
 209      *
 210      * The charset of the returned string depends on your iconv settings.
 211      *
 212      * @param  string $string encoded string
 213      * @return string decoded string
 214      */
 215     public static function decodeQuotedPrintable($string)
 216     {
 217         return iconv_mime_decode($string, ICONV_MIME_DECODE_CONTINUE_ON_ERROR, 'UTF-8');
 218     }
 219 }