interface/modules/zend_modules/library/Zend/Mail/Storage/Part/File.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\Mail\Storage\Part;
  11
  12 use Zend\Mail\Headers;
  13 use Zend\Mail\Storage\Part;
  14
  15 class File extends Part
  16 {
  17     protected $contentPos = array();
  18     protected $partPos = array();
  19     protected $fh;
  20
  21     /**
  22      * Public constructor
  23      *
  24      * This handler supports the following params:
  25      * - file     filename or open file handler with message content (required)
  26      * - startPos start position of message or part in file (default: current position)
  27      * - endPos   end position of message or part in file (default: end of file)
  28      *
  29      * @param   array $params  full message with or without headers
  30      * @throws Exception\RuntimeException
  31      * @throws Exception\InvalidArgumentException
  32      */
  33     public function __construct(array $params)
  34     {
  35         if (empty($params['file'])) {
  36             throw new Exception\InvalidArgumentException('no file given in params');
  37         }
  38
  39         if (!is_resource($params['file'])) {
  40             $this->fh = fopen($params['file'], 'r');
  41         } else {
  42             $this->fh = $params['file'];
  43         }
  44         if (!$this->fh) {
  45             throw new Exception\RuntimeException('could not open file');
  46         }
  47         if (isset($params['startPos'])) {
  48             fseek($this->fh, $params['startPos']);
  49         }
  50         $header = '';
  51         $endPos = isset($params['endPos']) ? $params['endPos'] : null;
  52         while (($endPos === null || ftell($this->fh) < $endPos) && trim($line = fgets($this->fh))) {
  53             $header .= $line;
  54         }
  55
  56         $this->headers = Headers::fromString($header);
  57
  58         $this->contentPos[0] = ftell($this->fh);
  59         if ($endPos !== null) {
  60             $this->contentPos[1] = $endPos;
  61         } else {
  62             fseek($this->fh, 0, SEEK_END);
  63             $this->contentPos[1] = ftell($this->fh);
  64         }
  65         if (!$this->isMultipart()) {
  66             return;
  67         }
  68
  69         $boundary = $this->getHeaderField('content-type', 'boundary');
  70         if (!$boundary) {
  71             throw new Exception\RuntimeException('no boundary found in content type to split message');
  72         }
  73
  74         $part = array();
  75         $pos = $this->contentPos[0];
  76         fseek($this->fh, $pos);
  77         while (!feof($this->fh) && ($endPos === null || $pos < $endPos)) {
  78             $line = fgets($this->fh);
  79             if ($line === false) {
  80                 if (feof($this->fh)) {
  81                     break;
  82                 }
  83                 throw new Exception\RuntimeException('error reading file');
  84             }
  85
  86             $lastPos = $pos;
  87             $pos = ftell($this->fh);
  88             $line = trim($line);
  89
  90             if ($line == '--' . $boundary) {
  91                 if ($part) {
  92                     // not first part
  93                     $part[1] = $lastPos;
  94                     $this->partPos[] = $part;
  95                 }
  96                 $part = array($pos);
  97             } elseif ($line == '--' . $boundary . '--') {
  98                 $part[1] = $lastPos;
  99                 $this->partPos[] = $part;
 100                 break;
 101             }
 102         }
 103         $this->countParts = count($this->partPos);
 104
 105     }
 106
 107
 108     /**
 109      * Body of part
 110      *
 111      * If part is multipart the raw content of this part with all sub parts is returned
 112      *
 113      * @param resource $stream Optional
 114      * @return string body
 115      */
 116     public function getContent($stream = null)
 117     {
 118         fseek($this->fh, $this->contentPos[0]);
 119         if ($stream !== null) {
 120             return stream_copy_to_stream($this->fh, $stream, $this->contentPos[1] - $this->contentPos[0]);
 121         }
 122         $length = $this->contentPos[1] - $this->contentPos[0];
 123         return $length < 1 ? '' : fread($this->fh, $length);
 124     }
 125
 126     /**
 127      * Return size of part
 128      *
 129      * Quite simple implemented currently (not decoding). Handle with care.
 130      *
 131      * @return int size
 132      */
 133     public function getSize()
 134     {
 135         return $this->contentPos[1] - $this->contentPos[0];
 136     }
 137
 138     /**
 139      * Get part of multipart message
 140      *
 141      * @param  int $num number of part starting with 1 for first part
 142      * @throws Exception\RuntimeException
 143      * @return Part wanted part
 144      */
 145     public function getPart($num)
 146     {
 147         --$num;
 148         if (!isset($this->partPos[$num])) {
 149             throw new Exception\RuntimeException('part not found');
 150         }
 151
 152         return new static(array('file' => $this->fh, 'startPos' => $this->partPos[$num][0],
 153                               'endPos' => $this->partPos[$num][1]));
 154     }
 155 }