- Fix PHP warning in mailbox_info(), - Set namespace/delimiter in construct...

alecpl

2011-06-27 68070e448c6c8cd09faa75fd70ff11bfea764cc1

 program/include/rcube_imap.php

@@ -52,19 +52,23 @@
     * @var rcube_mdb2
     */
    private $db;

    /**
     * Instance of rcube_cache
     *
     * @var rcube_cache
     */
    private $cache;
    private $mailbox = 'INBOX';
    private $delimiter = NULL;
    private $namespace = NULL;
    private $sort_field = '';
    private $sort_order = 'DESC';
    private $caching_enabled = false;
    private $default_charset = 'ISO-8859-1';
    private $struct_charset = NULL;
    private $default_folders = array('INBOX');
    private $messages_caching = false;
    private $icache = array();
    private $cache = array();
    private $cache_keys = array();
    private $cache_changes = array();
    private $uid_id_map = array();
    private $msg_headers = array();
    public  $search_set = NULL;
@@ -112,14 +116,18 @@


    /**
     * Object constructor
     *
     * @param object DB Database connection
     * Object constructor.
     */
    function __construct($db_conn)
    function __construct()
    {
        $this->db = $db_conn;
        $this->conn = new rcube_imap_generic();

        // Set namespace and delimiter from session,
        // so some methods would work before connection
        if (isset($_SESSION['imap_namespace']))
            $this->namespace = $_SESSION['imap_namespace'];
        if (isset($_SESSION['imap_delimiter']))
            $this->delimiter = $_SESSION['imap_delimiter'];
    }


@@ -207,7 +215,6 @@
    function close()
    {
        $this->conn->closeConnection();
        $this->write_cache();
    }


@@ -552,12 +559,6 @@
            return;
        }

        if (isset($_SESSION['imap_namespace']) && isset($_SESSION['imap_delimiter'])) {
            $this->namespace = $_SESSION['imap_namespace'];
            $this->delimiter = $_SESSION['imap_delimiter'];
            return;
        }

        $config = rcmail::get_instance()->config;
        $imap_personal  = $config->get('imap_ns_personal');
        $imap_other     = $config->get('imap_ns_other');
@@ -706,7 +707,7 @@
                $search_str .= " UNSEEN";
            }
            else {
                if ($this->caching_enabled) {
                if ($this->messages_caching) {
                    $keys[] = 'ALL';
                }
                if ($status) {
@@ -722,7 +723,7 @@
            $count = is_array($index) ? $index['COUNT'] : 0;

            if ($mode == 'ALL') {
                if ($need_uid && $this->caching_enabled) {
                if ($need_uid && $this->messages_caching) {
                    // Save messages index for check_cache_status()
                    $this->icache['all_undeleted_idx'] = $index['ALL'];
                }
@@ -838,7 +839,7 @@
        $page         = $page ? $page : $this->list_page;
        $cache_key    = $mailbox.'.msg';

        if ($this->caching_enabled) {
        if ($this->messages_caching) {
            // cache is OK, we can get messages from local cache
            // (assume cache is in sync when in recursive mode)
            if ($recursive || $this->check_cache_status($mailbox, $cache_key)>0) {
@@ -1320,7 +1321,7 @@
        }

        // Update cache
        if ($this->caching_enabled && $cache_key) {
        if ($this->messages_caching && $cache_key) {
            // cache is incomplete?
            $cache_index = $this->get_message_cache_index($cache_key);

@@ -2104,7 +2105,7 @@
        }

        // write structure to cache
        if ($this->caching_enabled)
        if ($this->messages_caching)
            $this->add_message_cache($cache_key, $this->_msg_id, $headers, $struct,
                $this->icache['message.id'][$uid], true);
        }
@@ -2521,14 +2522,17 @@


    /**
     * Returns the whole message source as string
     * Returns the whole message source as string (or saves to a file)
     *
     * @param int $uid Message UID
     * @param int      $uid Message UID
     * @param resource $fp  File pointer to save the message
     *
     * @return string Message source string
     */
    function &get_raw_body($uid)
    function &get_raw_body($uid, $fp=null)
    {
        return $this->conn->handlePartBody($this->mailbox, $uid, true);
        return $this->conn->handlePartBody($this->mailbox, $uid,
            true, null, null, false, $fp);
    }


@@ -2581,7 +2585,7 @@

        if ($result) {
            // reload message headers if cached
            if ($this->caching_enabled && !$skip_cache) {
            if ($this->messages_caching && !$skip_cache) {
                $cache_key = $mailbox.'.msg';
                if ($all_mode)
                    $this->clear_message_cache($cache_key);
@@ -3014,18 +3018,20 @@
     * Public method for listing subscribed folders
     *
     * @param   string  $root   Optional root folder
     * @param   string  $filter Optional filter for mailbox listing
     * @param   string  $name   Optional name pattern
     * @param   string  $filter Optional filter
     *
     * @return  array   List of mailboxes/folders
     * @access  public
     */
    function list_mailboxes($root='', $filter='*')
    function list_mailboxes($root='', $name='*', $filter=null)
    {
        $a_mboxes = $this->_list_mailboxes($root, $filter);
        $a_mboxes = $this->_list_mailboxes($root, $name, $filter);

        // INBOX should always be available
        if (!in_array('INBOX', $a_mboxes))
        if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) {
            array_unshift($a_mboxes, 'INBOX');
        }

        // sort mailboxes
        $a_mboxes = $this->_sort_mailbox_list($a_mboxes);
@@ -3038,23 +3044,33 @@
     * Private method for mailbox listing
     *
     * @param   string  $root   Optional root folder
     * @param   string  $filter Optional filter for mailbox listing
     * @param   string  $name   Optional name pattern
     * @param   mixed   $filter Optional filter
     *
     * @return  array   List of mailboxes/folders
     * @see     rcube_imap::list_mailboxes()
     * @access  private
     */
    private function _list_mailboxes($root='', $filter='*')
    private function _list_mailboxes($root='', $name='*', $filter=null)
    {
        $cache_key = $root.':'.$name;
        if (!empty($filter)) {
            $cache_key .= ':'.(is_string($filter) ? $filter : serialize($filter));
        }

        $cache_key = 'mailboxes.'.md5($cache_key);

        // get cached folder list
        $a_mboxes = $this->get_cache('mailboxes');
        if (is_array($a_mboxes))
        $a_mboxes = $this->get_cache($cache_key);
        if (is_array($a_mboxes)) {
            return $a_mboxes;
        }

        $a_defaults = $a_out = array();

        // Give plugins a chance to provide a list of mailboxes
        $data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list',
            array('root' => $root, 'filter' => $filter, 'mode' => 'LSUB'));
            array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LSUB'));

        if (isset($data['folders'])) {
            $a_folders = $data['folders'];
@@ -3065,7 +3081,7 @@
            // #1486225: Some dovecot versions returns wrong result using LIST-EXTENDED
            if (!$config->get('imap_force_lsub') && $this->get_capability('LIST-EXTENDED')) {
                // This will also set mailbox options, LSUB doesn't do that
                $a_folders = $this->conn->listMailboxes($root, $filter,
                $a_folders = $this->conn->listMailboxes($root, $name,
                    NULL, array('SUBSCRIBED'));

                // remove non-existent folders
@@ -3081,15 +3097,16 @@
            }
            // retrieve list of folders from IMAP server using LSUB
            else {
                $a_folders = $this->conn->listSubscribed($root, $filter);
                $a_folders = $this->conn->listSubscribed($root, $name);
            }
        }

        if (!is_array($a_folders) || !sizeof($a_folders))
        if (!is_array($a_folders) || !sizeof($a_folders)) {
            $a_folders = array();
        }

        // write mailboxlist to cache
        $this->update_cache('mailboxes', $a_folders);
        $this->update_cache($cache_key, $a_folders);

        return $a_folders;
    }
@@ -3099,21 +3116,24 @@
     * Get a list of all folders available on the IMAP server
     *
     * @param string $root   IMAP root dir
     * @param string $filter Optional filter for mailbox listing
     * @param string  $name   Optional name pattern
     * @param mixed   $filter Optional filter
     *
     * @return array Indexed array with folder names
     */
    function list_unsubscribed($root='', $filter='*')
    function list_unsubscribed($root='', $name='*', $filter=null)
    {
        // @TODO: caching
        // Give plugins a chance to provide a list of mailboxes
        $data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list',
            array('root' => $root, 'filter' => $filter, 'mode' => 'LIST'));
            array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LIST'));

        if (isset($data['folders'])) {
            $a_mboxes = $data['folders'];
        }
        else {
            // retrieve list of folders from IMAP server
            $a_mboxes = $this->conn->listMailboxes($root, $filter);
            $a_mboxes = $this->conn->listMailboxes($root, $name);
        }

        if (!is_array($a_mboxes)) {
@@ -3121,8 +3141,9 @@
        }

        // INBOX should always be available
        if (!in_array('INBOX', $a_mboxes))
        if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) {
            array_unshift($a_mboxes, 'INBOX');
        }

        // filter folders and sort them
        $a_mboxes = $this->_sort_mailbox_list($a_mboxes);
@@ -3210,8 +3231,13 @@
        $result = $this->conn->createFolder($mailbox);

        // try to subscribe it
        if ($result && $subscribe)
            $this->subscribe($mailbox);
        if ($result) {
            // clear cache
            $this->clear_cache('mailboxes', true);

            if ($subscribe)
                $this->subscribe($mailbox);
        }

        return $result;
    }
@@ -3263,7 +3289,7 @@

            // clear cache
            $this->clear_message_cache($mailbox.'.msg');
            $this->clear_cache('mailboxes');
            $this->clear_cache('mailboxes', true);
        }

        return $result;
@@ -3305,7 +3331,7 @@

            // clear mailbox-related cache
            $this->clear_message_cache($mailbox.'.msg');
            $this->clear_cache('mailboxes');
            $this->clear_cache('mailboxes', true);
        }

        return $result;
@@ -3464,6 +3490,64 @@


    /**
     * Returns extended information about the folder
     *
     * @param string $mailbox Folder name
     *
     * @return array Data
     */
    function mailbox_info($mailbox)
    {
        $acl       = $this->get_capability('ACL');
        $namespace = $this->get_namespace();
        $options   = array();

        // check if the folder is a namespace prefix
        if (!empty($namespace)) {
            $mbox = $mailbox . $this->delimiter;
            foreach ($namespace as $ns) {
                if (!empty($ns)) {
                    foreach ($ns as $item) {
                        if ($item[0] === $mbox) {
                            $options['is_root'] = true;
                            break;
                        }
                    }
                }
            }
        }

        $options['name']      = $mailbox;
        $options['options']   = $this->mailbox_options($mailbox, true);
        $options['namespace'] = $this->mailbox_namespace($mailbox);
        $options['rights']    = $acl && !$options['is_root'] ? (array)$this->my_rights($mailbox) : array();
        $options['special']   = in_array($mailbox, $this->default_folders);

        if (is_array($options['options'])) {
            foreach ($options['options'] as $opt) {
                $opt = strtolower($opt);
                if ($opt == '\noselect' || $opt == '\nonexistent') {
                    $options['noselect'] = true;
                }
            }
        }
        else {
            $options['noselect'] = true;
        }

        if (!empty($options['rights'])) {
            $options['norename'] = !in_array('x', $options['rights']) &&
                (!in_array('c', $options['rights']) || !in_array('d', $options['rights']));
            if (!$options['noselect']) {
                $options['noselect'] = !in_array('r', $options['rights']);
            }
        }

        return $options;
    }


    /**
     * Get message header names for rcube_imap_generic::fetchHeader(s)
     *
     * @return string Space-separated list of header names
@@ -3473,7 +3557,7 @@
        $headers = explode(' ', $this->fetch_add_headers);
        $headers = array_map('strtoupper', $headers);

        if ($this->caching_enabled || $this->get_all_headers)
        if ($this->messages_caching || $this->get_all_headers)
            $headers = array_merge($headers, $this->all_headers);

        return implode(' ', array_unique($headers));
@@ -3602,7 +3686,7 @@
            return $this->conn->setMetadata($mailbox, $entries);
        }
        else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
            foreach ($entries as $entry => $value) {
            foreach ((array)$entries as $entry => $value) {
                list($ent, $attr) = $this->md2annotate($entry);
                $entries[$entry] = array($ent, $attr, $value);
            }
@@ -3632,7 +3716,7 @@
            return $this->conn->deleteMetadata($mailbox, $entries);
        }
        else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
            foreach ($entries as $idx => $entry) {
            foreach ((array)$entries as $idx => $entry) {
                list($ent, $attr) = $this->md2annotate($entry);
                $entries[$idx] = array($ent, $attr, NULL);
            }
@@ -3658,7 +3742,7 @@
    function get_metadata($mailbox, $entries, $options=array())
    {
        if ($this->get_capability('METADATA') || 
            !strlen(($mailbox) && $this->get_capability('METADATA-SERVER'))
            (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
        ) {
            return $this->conn->getMetadata($mailbox, $entries, $options);
        }
@@ -3667,7 +3751,7 @@
            $res     = array();

            // Convert entry names
            foreach ($entries as $entry) {
            foreach ((array)$entries as $entry) {
                list($ent, $attr) = $this->md2annotate($entry);
                $queries[$attr][] = $ent;
            }
@@ -3688,11 +3772,11 @@
     * Converts the METADATA extension entry name into the correct
     * entry-attrib names for older ANNOTATEMORE version.
     *
     * @param string Entry name
     * @param string $entry Entry name
     *
     * @return array Entry-attribute list, NULL if not supported (?)
     */
    private function md2annotate($name)
    private function md2annotate($entry)
    {
        if (substr($entry, 0, 7) == '/shared') {
            return array(substr($entry, 7), 'value.shared');
@@ -3711,17 +3795,22 @@
     * --------------------------------*/

    /**
     * Enable or disable caching
     * Enable or disable indexes caching
     *
     * @param boolean $set Flag
     * @param boolean $type Cache type (@see rcmail::get_cache)
     * @access public
     */
    function set_caching($set)
    function set_caching($type)
    {
        if ($set && is_object($this->db))
            $this->caching_enabled = true;
        else
            $this->caching_enabled = false;
        if ($type) {
            $rcmail = rcmail::get_instance();
            $this->cache = $rcmail->get_cache('IMAP', $type);
        }
        else {
            if ($this->cache)
                $this->cache->close();
            $this->cache = null;
        }
    }


@@ -3734,174 +3823,63 @@
     */
    function get_cache($key)
    {
        // read cache (if it was not read before)
        if (!count($this->cache) && $this->caching_enabled) {
            return $this->_read_cache_record($key);
        if ($this->cache) {
            return $this->cache->get($key);
        }

        return $this->cache[$key];
    }


    /**
     * Update cache
     *
     * @param string $key  Cache key
     * @param mixed  $data Data
     * @access private
     * @access public
     */
    private function update_cache($key, $data)
    function update_cache($key, $data)
    {
        $this->cache[$key] = $data;
        $this->cache_changed = true;
        $this->cache_changes[$key] = true;
    }


    /**
     * Writes the cache
     *
     * @access private
     */
    private function write_cache()
    {
        if ($this->caching_enabled && $this->cache_changed) {
            foreach ($this->cache as $key => $data) {
                if ($this->cache_changes[$key])
                    $this->_write_cache_record($key, serialize($data));
            }
        if ($this->cache) {
            $this->cache->set($key, $data);
        }
    }


    /**
     * Clears the cache.
     *
     * @param string $key Cache key
     * @param string  $key         Cache key name or pattern
     * @param boolean $prefix_mode Enable it to clear all keys starting
     *                             with prefix specified in $key
     * @access public
     */
    function clear_cache($key=NULL)
    function clear_cache($key=null, $prefix_mode=false)
    {
        if (!$this->caching_enabled)
            return;

        if ($key===NULL) {
            foreach ($this->cache as $key => $data)
                $this->_clear_cache_record($key);

            $this->cache = array();
            $this->cache_changed = false;
            $this->cache_changes = array();
        }
        else {
            $this->_clear_cache_record($key);
            $this->cache_changes[$key] = false;
            unset($this->cache[$key]);
        if ($this->cache) {
            $this->cache->remove($key, $prefix_mode);
        }
    }


    /**
     * Returns cached entry
     *
     * @param string $key Cache key
     * @return mixed Cached value
     * @access private
     */
    private function _read_cache_record($key)
    {
        if ($this->db) {
            // get cached data from DB
            $sql_result = $this->db->query(
                "SELECT cache_id, data, cache_key ".
                "FROM ".get_table_name('cache').
                " WHERE user_id=? ".
               "AND cache_key LIKE 'IMAP.%'",
                $_SESSION['user_id']);

            while ($sql_arr = $this->db->fetch_assoc($sql_result)) {
               $sql_key = preg_replace('/^IMAP\./', '', $sql_arr['cache_key']);
                $this->cache_keys[$sql_key] = $sql_arr['cache_id'];
               if (!isset($this->cache[$sql_key]))
                   $this->cache[$sql_key] = $sql_arr['data'] ? unserialize($sql_arr['data']) : false;
            }
        }

        return $this->cache[$key];
    }


    /**
     * Writes single cache record
     *
     * @param string $key  Cache key
     * @param mxied  $data Cache value
     * @access private
     */
    private function _write_cache_record($key, $data)
    {
        if (!$this->db)
            return false;

        // update existing cache record
        if ($this->cache_keys[$key]) {
            $this->db->query(
                "UPDATE ".get_table_name('cache').
                " SET created=". $this->db->now().", data=? ".
                "WHERE user_id=? ".
                "AND cache_key=?",
                $data,
                $_SESSION['user_id'],
                'IMAP.'.$key);
        }
        // add new cache record
        else {
            $this->db->query(
                "INSERT INTO ".get_table_name('cache').
                " (created, user_id, cache_key, data) ".
                "VALUES (".$this->db->now().", ?, ?, ?)",
                $_SESSION['user_id'],
                'IMAP.'.$key,
                $data);

            // get cache entry ID for this key
            $sql_result = $this->db->query(
                "SELECT cache_id ".
                "FROM ".get_table_name('cache').
                " WHERE user_id=? ".
                "AND cache_key=?",
                $_SESSION['user_id'],
                'IMAP.'.$key);

            if ($sql_arr = $this->db->fetch_assoc($sql_result))
                $this->cache_keys[$key] = $sql_arr['cache_id'];
        }
    }


    /**
     * Clears cache for single record
     *
     * @param string $ket Cache key
     * @access private
     */
    private function _clear_cache_record($key)
    {
        $this->db->query(
            "DELETE FROM ".get_table_name('cache').
            " WHERE user_id=? ".
            "AND cache_key=?",
            $_SESSION['user_id'],
            'IMAP.'.$key);

        unset($this->cache_keys[$key]);
    }



    /* --------------------------------
     *   message caching methods
     * --------------------------------*/

    /**
     * Enable or disable messages caching
     *
     * @param boolean $set Flag
     * @access public
     */
    function set_messages_caching($set)
    {
        $rcmail = rcmail::get_instance();

        if ($set && ($dbh = $rcmail->get_dbh())) {
            $this->db = $dbh;
            $this->messages_caching = true;
        }
        else {
            $this->messages_caching = false;
        }
    }

    /**
     * Checks if the cache is up-to-date
@@ -3912,7 +3890,7 @@
     */
    private function check_cache_status($mailbox, $cache_key)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return -3;

        $cache_index = $this->get_message_cache_index($cache_key);
@@ -3970,7 +3948,7 @@
     */
    private function get_message_cache($key, $from, $to, $sort_field, $sort_order)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return NULL;

        // use idx sort as default sorting
@@ -4015,7 +3993,7 @@
    {
        $internal_key = 'message';

        if ($this->caching_enabled && !isset($this->icache[$internal_key][$uid])) {
        if ($this->messages_caching && !isset($this->icache[$internal_key][$uid])) {
            $sql_result = $this->db->query(
                "SELECT idx, headers, structure, message_id".
                " FROM ".get_table_name('messages').
@@ -4049,7 +4027,7 @@
     */
    private function get_message_cache_index($key, $sort_field='idx', $sort_order='ASC')
    {
        if (!$this->caching_enabled || empty($key))
        if (!$this->messages_caching || empty($key))
            return NULL;

        // use idx sort as default
@@ -4104,7 +4082,7 @@
        }

        // no further caching
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return;

        // known message id
@@ -4171,7 +4149,7 @@
     */
    private function remove_message_cache($key, $ids, $idx=false)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return;

        $this->db->query(
@@ -4193,7 +4171,7 @@
     */
    private function clear_message_cache($key, $start_index=1)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return;

        $this->db->query(
@@ -4212,7 +4190,7 @@
     */
    private function get_message_cache_index_min($key, $uids=NULL)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return;

        if (!empty($uids) && !is_array($uids)) {
@@ -4246,7 +4224,7 @@
     */
    private function get_cache_id2uid($key, $id)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return null;

        if (array_key_exists('index', $this->icache)
@@ -4278,7 +4256,7 @@
     */
    private function get_cache_uid2id($key, $uid)
    {
        if (!$this->caching_enabled)
        if (!$this->messages_caching)
            return null;

        if (array_key_exists('index', $this->icache)
@@ -4664,20 +4642,9 @@
                    $updated = $this->conn->unsubscribe($mailbox);
            }

        // get cached mailbox list
        // clear cached mailbox list(s)
        if ($updated) {
            $a_mailbox_cache = $this->get_cache('mailboxes');
            if (!is_array($a_mailbox_cache))
                return $updated;

            // modify cached list
            if ($mode == 'subscribe')
                $a_mailbox_cache = array_merge($a_mailbox_cache, $a_mboxes);
            else if ($mode == 'unsubscribe')
                $a_mailbox_cache = array_diff($a_mailbox_cache, $a_mboxes);

            // write mailboxlist to cache
            $this->update_cache('mailboxes', $this->_sort_mailbox_list($a_mailbox_cache));
            $this->clear_cache('mailboxes', true);
        }

        return $updated;