interface/modules/zend_modules/library/Zend/Mail/Storage/Folder/Maildir.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\Folder;
  11
  12 use Zend\Mail\Storage;
  13 use Zend\Mail\Storage\Exception;
  14 use Zend\Stdlib\ErrorHandler;
  15
  16 class Maildir extends Storage\Maildir implements FolderInterface
  17 {
  18     /**
  19      * root folder for folder structure
  20      * @var \Zend\Mail\Storage\Folder
  21      */
  22     protected $rootFolder;
  23
  24     /**
  25      * rootdir of folder structure
  26      * @var string
  27      */
  28     protected $rootdir;
  29
  30     /**
  31      * name of current folder
  32      * @var string
  33      */
  34     protected $currentFolder;
  35
  36     /**
  37      * delim char for subfolders
  38      * @var string
  39      */
  40     protected $delim;
  41
  42     /**
  43      * Create instance with parameters
  44      * Supported parameters are:
  45      *   - dirname rootdir of maildir structure
  46      *   - delim   delim char for folder structure, default is '.'
  47      *   - folder initial selected folder, default is 'INBOX'
  48      *
  49      * @param  $params array mail reader specific parameters
  50      * @throws \Zend\Mail\Storage\Exception\InvalidArgumentException
  51      */
  52     public function __construct($params)
  53     {
  54         if (is_array($params)) {
  55             $params = (object) $params;
  56         }
  57
  58         if (!isset($params->dirname) || !is_dir($params->dirname)) {
  59             throw new Exception\InvalidArgumentException('no valid dirname given in params');
  60         }
  61
  62         $this->rootdir = rtrim($params->dirname, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
  63
  64         $this->delim = isset($params->delim) ? $params->delim : '.';
  65
  66         $this->_buildFolderTree();
  67         $this->selectFolder(!empty($params->folder) ? $params->folder : 'INBOX');
  68         $this->has['top'] = true;
  69         $this->has['flags'] = true;
  70     }
  71
  72     /**
  73      * find all subfolders and mbox files for folder structure
  74      *
  75      * Result is save in \Zend\Mail\Storage\Folder instances with the root in $this->rootFolder.
  76      * $parentFolder and $parentGlobalName are only used internally for recursion.
  77      *
  78      * @throws \Zend\Mail\Storage\Exception\RuntimeException
  79      */
  80     protected function _buildFolderTree()
  81     {
  82         $this->rootFolder = new Storage\Folder('/', '/', false);
  83         $this->rootFolder->INBOX = new Storage\Folder('INBOX', 'INBOX', true);
  84
  85         ErrorHandler::start(E_WARNING);
  86         $dh    = opendir($this->rootdir);
  87         $error = ErrorHandler::stop();
  88         if (!$dh) {
  89             throw new Exception\RuntimeException("can't read folders in maildir", 0, $error);
  90         }
  91         $dirs = array();
  92
  93         while (($entry = readdir($dh)) !== false) {
  94
  95             // maildir++ defines folders must start with .
  96             if ($entry[0] != '.' || $entry == '.' || $entry == '..') {
  97                 continue;
  98             }
  99
 100             if ($this->_isMaildir($this->rootdir . $entry)) {
 101                 $dirs[] = $entry;
 102             }
 103         }
 104         closedir($dh);
 105
 106         sort($dirs);
 107         $stack = array(null);
 108         $folderStack = array(null);
 109         $parentFolder = $this->rootFolder;
 110         $parent = '.';
 111
 112         foreach ($dirs as $dir) {
 113             do {
 114                 if (strpos($dir, $parent) === 0) {
 115                     $local = substr($dir, strlen($parent));
 116                     if (strpos($local, $this->delim) !== false) {
 117                         throw new Exception\RuntimeException('error while reading maildir');
 118                     }
 119                     array_push($stack, $parent);
 120                     $parent = $dir . $this->delim;
 121                     $folder = new Storage\Folder($local, substr($dir, 1), true);
 122                     $parentFolder->$local = $folder;
 123                     array_push($folderStack, $parentFolder);
 124                     $parentFolder = $folder;
 125                     break;
 126                 } elseif ($stack) {
 127                     $parent = array_pop($stack);
 128                     $parentFolder = array_pop($folderStack);
 129                 }
 130             } while ($stack);
 131             if (!$stack) {
 132                 throw new Exception\RuntimeException('error while reading maildir');
 133             }
 134         }
 135     }
 136
 137     /**
 138      * get root folder or given folder
 139      *
 140      * @param string $rootFolder get folder structure for given folder, else root
 141      * @throws \Zend\Mail\Storage\Exception\InvalidArgumentException
 142      * @return \Zend\Mail\Storage\Folder root or wanted folder
 143      */
 144     public function getFolders($rootFolder = null)
 145     {
 146         if (!$rootFolder || $rootFolder == 'INBOX') {
 147             return $this->rootFolder;
 148         }
 149
 150         // rootdir is same as INBOX in maildir
 151         if (strpos($rootFolder, 'INBOX' . $this->delim) === 0) {
 152             $rootFolder = substr($rootFolder, 6);
 153         }
 154         $currentFolder = $this->rootFolder;
 155         $subname = trim($rootFolder, $this->delim);
 156
 157         while ($currentFolder) {
 158             ErrorHandler::start(E_NOTICE);
 159             list($entry, $subname) = explode($this->delim, $subname, 2);
 160             ErrorHandler::stop();
 161             $currentFolder = $currentFolder->$entry;
 162             if (!$subname) {
 163                 break;
 164             }
 165         }
 166
 167         if ($currentFolder->getGlobalName() != rtrim($rootFolder, $this->delim)) {
 168             throw new Exception\InvalidArgumentException("folder $rootFolder not found");
 169         }
 170         return $currentFolder;
 171     }
 172
 173     /**
 174      * select given folder
 175      *
 176      * folder must be selectable!
 177      *
 178      * @param \Zend\Mail\Storage\Folder|string $globalName global name of folder or instance for subfolder
 179      * @throws \Zend\Mail\Storage\Exception\RuntimeException
 180      */
 181     public function selectFolder($globalName)
 182     {
 183         $this->currentFolder = (string) $globalName;
 184
 185         // getting folder from folder tree for validation
 186         $folder = $this->getFolders($this->currentFolder);
 187
 188         try {
 189             $this->_openMaildir($this->rootdir . '.' . $folder->getGlobalName());
 190         } catch (Exception\ExceptionInterface $e) {
 191             // check what went wrong
 192             if (!$folder->isSelectable()) {
 193                 throw new Exception\RuntimeException("{$this->currentFolder} is not selectable", 0, $e);
 194             }
 195             // seems like file has vanished; rebuilding folder tree - but it's still an exception
 196             $this->_buildFolderTree();
 197             throw new Exception\RuntimeException('seems like the maildir has vanished, I\'ve rebuild the ' .
 198                                                          'folder tree, search for an other folder and try again', 0, $e);
 199         }
 200     }
 201
 202     /**
 203      * get \Zend\Mail\Storage\Folder instance for current folder
 204      *
 205      * @return \Zend\Mail\Storage\Folder instance of current folder
 206      */
 207     public function getCurrentFolder()
 208     {
 209         return $this->currentFolder;
 210     }
 211 }