<?php/** * Zend Framework * * LICENSE * * This source file is subject to version 1.0 of the Zend Framework * license, that is bundled with this package in the file LICENSE.txt, and * is available through the world-wide-web at the following URL: * http://framework.zend.com/license/new-bsd. If you did not receive * a copy of the Zend Framework license and are unable to obtain it * through the world-wide-web, please send a note to license@zend.com * so we can mail you a copy immediately. *  * @category   Zend * @package    Zend_Mail * @subpackage Storage * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com) * @license    http://framework.zend.com/license/new-bsd     New BSD License * @version    $Id: Mbox.php 8064 2008-02-16 10:58:39Z thomas $ *//** * @see Zend_Mail_Storage_Folder */require_once 'Zend/Mail/Storage/Folder.php';/** * @see Zend_Mail_Storage_Folder_Interface */require_once 'Zend/Mail/Storage/Folder/Interface.php';/** * @see Zend_Mail_Storage_Mbox */require_once 'Zend/Mail/Storage/Mbox.php';/** * @category   Zend * @package    Zend_Mail * @subpackage Storage * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com) * @license    http://framework.zend.com/license/new-bsd     New BSD License */class Zend_Mail_Storage_Folder_Mbox extends Zend_Mail_Storage_Mbox implements Zend_Mail_Storage_Folder_Interface{    /**     * Zend_Mail_Storage_Folder root folder for folder structure     * @var Zend_Mail_Storage_Folder     */    protected $_rootFolder;    /**     * rootdir of folder structure     * @var string     */    protected $_rootdir;    /**     * name of current folder     * @var string     */    protected $_currentFolder;    /**     * Create instance with parameters     *     * Disallowed parameters are:     *   - filename use Zend_Mail_Storage_Mbox for a single file     * Supported parameters are:     *   - dirname rootdir of mbox structure     *   - folder intial selected folder, default is 'INBOX'     *     * @param  $params array mail reader specific parameters     * @throws Zend_Mail_Storage_Exception     */    public function __construct($params)    {        if (is_array($params)) {            $params = (object)$params;        }        if (isset($params->filename)) {            /**             * @see Zend_Mail_Storage_Exception             */            require_once 'Zend/Mail/Storage/Exception.php';            throw new Zend_Mail_Storage_Exception('use Zend_Mail_Storage_Mbox for a single file');        }        if (!isset($params->dirname) || !is_dir($params->dirname)) {            /**             * @see Zend_Mail_Storage_Exception             */            require_once 'Zend/Mail/Storage/Exception.php';            throw new Zend_Mail_Storage_Exception('no valid dirname given in params');        }        $this->_rootdir = rtrim($params->dirname, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;        $this->_buildFolderTree($this->_rootdir);        $this->selectFolder(!empty($params->folder) ? $params->folder : 'INBOX');        $this->_has['top']      = true;        $this->_has['uniqueid'] = false;    }    /**     * find all subfolders and mbox files for folder structure     *     * Result is save in Zend_Mail_Storage_Folder instances with the root in $this->_rootFolder.     * $parentFolder and $parentGlobalName are only used internally for recursion.     *     * @param string $currentDir call with root dir, also used for recursion.     * @param Zend_Mail_Storage_Folder|null $parentFolder used for recursion     * @param string $parentGlobalName used for rescursion     * @return null     * @throws Zend_Mail_Storage_Exception     */    protected function _buildFolderTree($currentDir, $parentFolder = null, $parentGlobalName = '')    {        if (!$parentFolder) {            $this->_rootFolder = new Zend_Mail_Storage_Folder('/', '/', false);            $parentFolder = $this->_rootFolder;        }        $dh = @opendir($currentDir);        if (!$dh) {            /**             * @see Zend_Mail_Storage_Exception             */            require_once 'Zend/Mail/Storage/Exception.php';            throw new Zend_Mail_Storage_Exception("can't read dir $currentDir");        }        while (($entry = readdir($dh)) !== false) {            // ignore hidden files for mbox            if ($entry[0] == '.') {                continue;            }            $absoluteEntry = $currentDir . $entry;            $globalName = $parentGlobalName . DIRECTORY_SEPARATOR . $entry;            if (is_file($absoluteEntry) && $this->_isMboxFile($absoluteEntry)) {                $parentFolder->$entry = new Zend_Mail_Storage_Folder($entry, $globalName);                continue;            }            if (!is_dir($absoluteEntry) /* || $entry == '.' || $entry == '..' */) {                continue;            }            $folder = new Zend_Mail_Storage_Folder($entry, $globalName, false);            $parentFolder->$entry = $folder;            $this->_buildFolderTree($absoluteEntry . DIRECTORY_SEPARATOR, $folder, $globalName);        }        closedir($dh);    }    /**     * get root folder or given folder     *     * @param string $rootFolder get folder structure for given folder, else root     * @return Zend_Mail_Storage_Folder root or wanted folder     * @throws Zend_Mail_Storage_Exception     */    public function getFolders($rootFolder = null)    {        if (!$rootFolder) {            return $this->_rootFolder;        }        $currentFolder = $this->_rootFolder;        $subname = trim($rootFolder, DIRECTORY_SEPARATOR);        while ($currentFolder) {            @list($entry, $subname) = @explode(DIRECTORY_SEPARATOR, $subname, 2);            $currentFolder = $currentFolder->$entry;            if (!$subname) {                break;            }        }        if ($currentFolder->getGlobalName() != DIRECTORY_SEPARATOR . trim($rootFolder, DIRECTORY_SEPARATOR)) {            /**             * @see Zend_Mail_Storage_Exception             */            require_once 'Zend/Mail/Storage/Exception.php';            throw new Zend_Mail_Storage_Exception("folder $rootFolder not found");        }        return $currentFolder;    }    /**     * select given folder     *     * folder must be selectable!     *     * @param Zend_Mail_Storage_Folder|string $globalName global name of folder or instance for subfolder     * @return null     * @throws Zend_Mail_Storage_Exception     */    public function selectFolder($globalName)    {        $this->_currentFolder = (string)$globalName;        // getting folder from folder tree for validation        $folder = $this->getFolders($this->_currentFolder);        try {            $this->_openMboxFile($this->_rootdir . $folder->getGlobalName());        } catch(Zend_Mail_Storage_Exception $e) {            // check what went wrong            if (!$folder->isSelectable()) {                /**                 * @see Zend_Mail_Storage_Exception                 */                require_once 'Zend/Mail/Storage/Exception.php';                throw new Zend_Mail_Storage_Exception("{$this->_currentFolder} is not selectable");            }            // seems like file has vanished; rebuilding folder tree - but it's still an exception            $this->_buildFolderTree($this->_rootdir);            /**             * @see Zend_Mail_Storage_Exception             */            require_once 'Zend/Mail/Storage/Exception.php';            throw new Zend_Mail_Storage_Exception('seems like the mbox file has vanished, I\'ve rebuild the ' .                                                         'folder tree, search for an other folder and try again');        }    }    /**     * get Zend_Mail_Storage_Folder instance for current folder     *     * @return Zend_Mail_Storage_Folder instance of current folder     * @throws Zend_Mail_Storage_Exception     */    public function getCurrentFolder()    {        return $this->_currentFolder;    }    /**     * magic method for serialize()     *     * with this method you can cache the mbox class     *     * @return array name of variables     */    public function __sleep()    {        return array_merge(parent::__sleep(), array('_currentFolder', '_rootFolder', '_rootdir'));    }    /**     * magic method for unserialize()     *     * with this method you can cache the mbox class     *     * @return null     */    public function __wakeup()    {        // if cache is stall selectFolder() rebuilds the tree on error        parent::__wakeup();    }}