vendor/zendframework/zend-mail/src/Storage/Mbox.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-mail for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-mail/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Mail\Storage;
   9
  10 use Zend\Stdlib\ErrorHandler;
  11
  12 class Mbox extends AbstractStorage
  13 {
  14     /**
  15      * file handle to mbox file
  16      * @var null|resource
  17      */
  18     protected $fh;
  19
  20     /**
  21      * filename of mbox file for __wakeup
  22      * @var string
  23      */
  24     protected $filename;
  25
  26     /**
  27      * modification date of mbox file for __wakeup
  28      * @var int
  29      */
  30     protected $filemtime;
  31
  32     /**
  33      * start and end position of messages as array('start' => start, 'separator' => headersep, 'end' => end)
  34      * @var array
  35      */
  36     protected $positions;
  37
  38     /**
  39      * used message class, change it in an extended class to extend the returned message class
  40      * @var string
  41      */
  42     protected $messageClass = '\Zend\Mail\Storage\Message\File';
  43
  44     /**
  45      * end of Line for messages
  46      *
  47      * @var string|null
  48      */
  49     protected $messageEOL;
  50
  51     /**
  52      * Count messages all messages in current box
  53      *
  54      * @return int number of messages
  55      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
  56      */
  57     public function countMessages()
  58     {
  59         return count($this->positions);
  60     }
  61
  62     /**
  63      * Get a list of messages with number and size
  64      *
  65      * @param  int|null $id  number of message or null for all messages
  66      * @return int|array size of given message of list with all messages as array(num => size)
  67      */
  68     public function getSize($id = 0)
  69     {
  70         if ($id) {
  71             $pos = $this->positions[$id - 1];
  72             return $pos['end'] - $pos['start'];
  73         }
  74
  75         $result = [];
  76         foreach ($this->positions as $num => $pos) {
  77             $result[$num + 1] = $pos['end'] - $pos['start'];
  78         }
  79
  80         return $result;
  81     }
  82
  83     /**
  84      * Get positions for mail message or throw exception if id is invalid
  85      *
  86      * @param int $id number of message
  87      * @throws Exception\InvalidArgumentException
  88      * @return array positions as in positions
  89      */
  90     protected function getPos($id)
  91     {
  92         if (! isset($this->positions[$id - 1])) {
  93             throw new Exception\InvalidArgumentException('id does not exist');
  94         }
  95
  96         return $this->positions[$id - 1];
  97     }
  98
  99     /**
 100      * Fetch a message
 101      *
 102      * @param  int $id number of message
 103      * @return \Zend\Mail\Storage\Message\File
 104      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
 105      */
 106     public function getMessage($id)
 107     {
 108         // TODO that's ugly, would be better to let the message class decide
 109         if (strtolower($this->messageClass) == '\zend\mail\storage\message\file'
 110             || is_subclass_of($this->messageClass, '\Zend\Mail\Storage\Message\File')) {
 111             // TODO top/body lines
 112             $messagePos = $this->getPos($id);
 113
 114             $messageClassParams = [
 115                 'file' => $this->fh,
 116                 'startPos' => $messagePos['start'],
 117                 'endPos' => $messagePos['end']
 118             ];
 119
 120             if (isset($this->messageEOL)) {
 121                 $messageClassParams['EOL'] = $this->messageEOL;
 122             }
 123
 124             return new $this->messageClass($messageClassParams);
 125         }
 126
 127         $bodyLines = 0; // TODO: need a way to change that
 128
 129         $message = $this->getRawHeader($id);
 130         // file pointer is after headers now
 131         if ($bodyLines) {
 132             $message .= "\n";
 133             while ($bodyLines-- && ftell($this->fh) < $this->positions[$id - 1]['end']) {
 134                 $message .= fgets($this->fh);
 135             }
 136         }
 137
 138         return new $this->messageClass(['handler' => $this, 'id' => $id, 'headers' => $message]);
 139     }
 140
 141     /*
 142      * Get raw header of message or part
 143      *
 144      * @param  int               $id       number of message
 145      * @param  null|array|string $part     path to part or null for message header
 146      * @param  int               $topLines include this many lines with header (after an empty line)
 147      * @return string raw header
 148      * @throws \Zend\Mail\Protocol\Exception\ExceptionInterface
 149      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
 150      */
 151     public function getRawHeader($id, $part = null, $topLines = 0)
 152     {
 153         if ($part !== null) {
 154             // TODO: implement
 155             throw new Exception\RuntimeException('not implemented');
 156         }
 157         $messagePos = $this->getPos($id);
 158         // TODO: toplines
 159         return stream_get_contents($this->fh, $messagePos['separator'] - $messagePos['start'], $messagePos['start']);
 160     }
 161
 162     /*
 163      * Get raw content of message or part
 164      *
 165      * @param  int               $id   number of message
 166      * @param  null|array|string $part path to part or null for message content
 167      * @return string raw content
 168      * @throws \Zend\Mail\Protocol\Exception\ExceptionInterface
 169      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
 170      */
 171     public function getRawContent($id, $part = null)
 172     {
 173         if ($part !== null) {
 174             // TODO: implement
 175             throw new Exception\RuntimeException('not implemented');
 176         }
 177         $messagePos = $this->getPos($id);
 178         return stream_get_contents($this->fh, $messagePos['end'] - $messagePos['separator'], $messagePos['separator']);
 179     }
 180
 181     /**
 182      * Create instance with parameters
 183      * Supported parameters are:
 184      *   - filename filename of mbox file
 185      *
 186      * @param  $params array mail reader specific parameters
 187      * @throws Exception\InvalidArgumentException
 188      */
 189     public function __construct($params)
 190     {
 191         if (is_array($params)) {
 192             $params = (object) $params;
 193         }
 194
 195         if (! isset($params->filename)) {
 196             throw new Exception\InvalidArgumentException('no valid filename given in params');
 197         }
 198
 199         if (isset($params->messageEOL)) {
 200             $this->messageEOL = (string) $params->messageEOL;
 201         }
 202
 203         $this->openMboxFile($params->filename);
 204         $this->has['top']      = true;
 205         $this->has['uniqueid'] = false;
 206     }
 207
 208     /**
 209      * check if given file is a mbox file
 210      *
 211      * if $file is a resource its file pointer is moved after the first line
 212      *
 213      * @param  resource|string $file stream resource of name of file
 214      * @param  bool $fileIsString file is string or resource
 215      * @return bool file is mbox file
 216      */
 217     protected function isMboxFile($file, $fileIsString = true)
 218     {
 219         if ($fileIsString) {
 220             ErrorHandler::start(E_WARNING);
 221             $file = fopen($file, 'r');
 222             ErrorHandler::stop();
 223             if (! $file) {
 224                 return false;
 225             }
 226         } else {
 227             fseek($file, 0);
 228         }
 229
 230         $result = false;
 231
 232         $line = fgets($file) ?: '';
 233         if (strpos($line, 'From ') === 0) {
 234             $result = true;
 235         }
 236
 237         if ($fileIsString) {
 238             ErrorHandler::start(E_WARNING);
 239             fclose($file);
 240             ErrorHandler::stop();
 241         }
 242
 243         return $result;
 244     }
 245
 246     /**
 247      * open given file as current mbox file
 248      *
 249      * @param  string $filename filename of mbox file
 250      * @throws Exception\RuntimeException
 251      * @throws Exception\InvalidArgumentException
 252      */
 253     protected function openMboxFile($filename)
 254     {
 255         if ($this->fh) {
 256             $this->close();
 257         }
 258
 259         ErrorHandler::start();
 260         $this->fh = fopen($filename, 'r');
 261         $error = ErrorHandler::stop();
 262         if (! $this->fh) {
 263             throw new Exception\RuntimeException('cannot open mbox file', 0, $error);
 264         }
 265         $this->filename = $filename;
 266         $this->filemtime = filemtime($this->filename);
 267
 268         if (! $this->isMboxFile($this->fh, false)) {
 269             ErrorHandler::start(E_WARNING);
 270             fclose($this->fh);
 271             $error = ErrorHandler::stop();
 272             throw new Exception\InvalidArgumentException('file is not a valid mbox format', 0, $error);
 273         }
 274
 275         $messagePos = ['start' => ftell($this->fh), 'separator' => 0, 'end' => 0];
 276         while (($line = fgets($this->fh)) !== false) {
 277             if (strpos($line, 'From ') === 0) {
 278                 $messagePos['end'] = ftell($this->fh) - strlen($line) - 2; // + newline
 279                 if (! $messagePos['separator']) {
 280                     $messagePos['separator'] = $messagePos['end'];
 281                 }
 282                 $this->positions[] = $messagePos;
 283                 $messagePos = ['start' => ftell($this->fh), 'separator' => 0, 'end' => 0];
 284             }
 285             if (! $messagePos['separator'] && ! trim($line)) {
 286                 $messagePos['separator'] = ftell($this->fh);
 287             }
 288         }
 289
 290         $messagePos['end'] = ftell($this->fh);
 291         if (! $messagePos['separator']) {
 292             $messagePos['separator'] = $messagePos['end'];
 293         }
 294         $this->positions[] = $messagePos;
 295     }
 296
 297     /**
 298      * Close resource for mail lib. If you need to control, when the resource
 299      * is closed. Otherwise the destructor would call this.
 300      *
 301      */
 302     public function close()
 303     {
 304         ErrorHandler::start(E_WARNING);
 305         fclose($this->fh);
 306         ErrorHandler::stop();
 307         $this->positions = [];
 308     }
 309
 310
 311     /**
 312      * Waste some CPU cycles doing nothing.
 313      *
 314      * @return bool always return true
 315      */
 316     public function noop()
 317     {
 318         return true;
 319     }
 320
 321
 322     /**
 323      * stub for not supported message deletion
 324      *
 325      * @param $id
 326      * @throws Exception\RuntimeException
 327      */
 328     public function removeMessage($id)
 329     {
 330         throw new Exception\RuntimeException('mbox is read-only');
 331     }
 332
 333     /**
 334      * get unique id for one or all messages
 335      *
 336      * Mbox does not support unique ids (yet) - it's always the same as the message number.
 337      * That shouldn't be a problem, because we can't change mbox files. Therefor the message
 338      * number is save enough.
 339      *
 340      * @param int|null $id message number
 341      * @return array|string message number for given message or all messages as array
 342      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
 343      */
 344     public function getUniqueId($id = null)
 345     {
 346         if ($id) {
 347             // check if id exists
 348             $this->getPos($id);
 349             return $id;
 350         }
 351
 352         $range = range(1, $this->countMessages());
 353         return array_combine($range, $range);
 354     }
 355
 356     /**
 357      * get a message number from a unique id
 358      *
 359      * I.e. if you have a webmailer that supports deleting messages you should use unique ids
 360      * as parameter and use this method to translate it to message number right before calling removeMessage()
 361      *
 362      * @param string $id unique id
 363      * @return int message number
 364      * @throws \Zend\Mail\Storage\Exception\ExceptionInterface
 365      */
 366     public function getNumberByUniqueId($id)
 367     {
 368         // check if id exists
 369         $this->getPos($id);
 370         return $id;
 371     }
 372
 373     /**
 374      * magic method for serialize()
 375      *
 376      * with this method you can cache the mbox class
 377      *
 378      * @return array name of variables
 379      */
 380     public function __sleep()
 381     {
 382         return ['filename', 'positions', 'filemtime'];
 383     }
 384
 385     /**
 386      * magic method for unserialize()
 387      *
 388      * with this method you can cache the mbox class
 389      * for cache validation the mtime of the mbox file is used
 390      *
 391      * @throws Exception\RuntimeException
 392      */
 393     public function __wakeup()
 394     {
 395         ErrorHandler::start();
 396         $filemtime = filemtime($this->filename);
 397         ErrorHandler::stop();
 398         if ($this->filemtime != $filemtime) {
 399             $this->close();
 400             $this->openMboxFile($this->filename);
 401         } else {
 402             ErrorHandler::start();
 403             $this->fh = fopen($this->filename, 'r');
 404             $error    = ErrorHandler::stop();
 405             if (! $this->fh) {
 406                 throw new Exception\RuntimeException('cannot open mbox file', 0, $error);
 407             }
 408         }
 409     }
 410 }