From 68070e448c6c8cd09faa75fd70ff11bfea764cc1 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Mon, 27 Jun 2011 03:09:15 -0400
Subject: [PATCH] - Fix PHP warning in mailbox_info(), - Set namespace/delimiter in constructor (this way some methods could be used before connecting to IMAP server)
---
program/include/rcube_imap.php | 2151 +++++++++++++++++++++++++++++++++++++++--------------------
1 files changed, 1,419 insertions(+), 732 deletions(-)
diff --git a/program/include/rcube_imap.php b/program/include/rcube_imap.php
index 0a27989..c2a4a0d 100644
--- a/program/include/rcube_imap.php
+++ b/program/include/rcube_imap.php
@@ -5,7 +5,7 @@
| program/include/rcube_imap.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2010, Roundcube Dev. - Switzerland |
+ | Copyright (C) 2005-2010, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -32,12 +32,9 @@
class rcube_imap
{
public $debug_level = 1;
- public $error_code = 0;
public $skip_deleted = false;
- public $root_dir = '';
public $page_size = 10;
public $list_page = 1;
- public $delimiter = NULL;
public $threading = false;
public $fetch_add_headers = '';
public $get_all_headers = false;
@@ -55,18 +52,23 @@
* @var rcube_mdb2
*/
private $db;
- private $root_ns = '';
+
+ /**
+ * 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;
@@ -102,19 +104,33 @@
'RETURN-PATH',
);
+ const UNKNOWN = 0;
+ const NOPERM = 1;
+ const READONLY = 2;
+ const TRYCREATE = 3;
+ const INUSE = 4;
+ const OVERQUOTA = 5;
+ const ALREADYEXISTS = 6;
+ const NONEXISTENT = 7;
+ const CONTACTADMIN = 8;
+
/**
- * 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'];
}
-
+
/**
* Connect to an IMAP server
*
@@ -140,6 +156,18 @@
$this->options['port'] = $port;
+ if ($this->options['debug']) {
+ $this->conn->setDebug(true, array($this, 'debug_handler'));
+
+ $this->options['ident'] = array(
+ 'name' => 'Roundcube Webmail',
+ 'version' => RCMAIL_VERSION,
+ 'php' => PHP_VERSION,
+ 'os' => PHP_OS,
+ 'command' => $_SERVER['REQUEST_URI'],
+ );
+ }
+
$attempt = 0;
do {
$data = rcmail::get_instance()->plugins->exec_hook('imap_connect',
@@ -157,33 +185,27 @@
$this->port = $port;
$this->ssl = $use_ssl;
- // print trace messages
if ($this->conn->connected()) {
- if ($this->conn->message && ($this->debug_level & 8)) {
- console($this->conn->message);
- }
-
- // get server properties
- if (!empty($this->conn->rootdir))
- $this->set_rootdir($this->conn->rootdir);
- if (empty($this->delimiter))
- $this->get_hierarchy_delimiter();
-
+ // get namespace and delimiter
+ $this->set_env();
return true;
}
// write error log
else if ($this->conn->error) {
- $this->error_code = $this->conn->errornum;
- if ($pass && $user)
+ if ($pass && $user) {
+ $message = sprintf("Login failed for %s from %s. %s",
+ $user, rcmail_remote_ip(), $this->conn->error);
+
raise_error(array('code' => 403, 'type' => 'imap',
'file' => __FILE__, 'line' => __LINE__,
- 'message' => $this->conn->error), true, false);
+ 'message' => $message), true, false);
+ }
}
return false;
}
-
+
/**
* Close IMAP connection
* Usually done on script shutdown
@@ -192,11 +214,10 @@
*/
function close()
{
- $this->conn->close();
- $this->write_cache();
+ $this->conn->closeConnection();
}
-
+
/**
* Close IMAP connection and re-connect
* This is used to avoid some strange socket errors when talking to Courier IMAP
@@ -205,15 +226,78 @@
*/
function reconnect()
{
- $this->close();
- $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl);
+ $this->conn->closeConnection();
+ $connected = $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl);
// issue SELECT command to restore connection status
- if ($this->mailbox)
+ if ($connected && strlen($this->mailbox))
$this->conn->select($this->mailbox);
}
-
+
+ /**
+ * Returns code of last error
+ *
+ * @return int Error code
+ */
+ function get_error_code()
+ {
+ return $this->conn->errornum;
+ }
+
+
+ /**
+ * Returns message of last error
+ *
+ * @return string Error message
+ */
+ function get_error_str()
+ {
+ return $this->conn->error;
+ }
+
+
+ /**
+ * Returns code of last command response
+ *
+ * @return int Response code
+ */
+ function get_response_code()
+ {
+ switch ($this->conn->resultcode) {
+ case 'NOPERM':
+ return self::NOPERM;
+ case 'READ-ONLY':
+ return self::READONLY;
+ case 'TRYCREATE':
+ return self::TRYCREATE;
+ case 'INUSE':
+ return self::INUSE;
+ case 'OVERQUOTA':
+ return self::OVERQUOTA;
+ case 'ALREADYEXISTS':
+ return self::ALREADYEXISTS;
+ case 'NONEXISTENT':
+ return self::NONEXISTENT;
+ case 'CONTACTADMIN':
+ return self::CONTACTADMIN;
+ default:
+ return self::UNKNOWN;
+ }
+ }
+
+
+ /**
+ * Returns last command response
+ *
+ * @return string Response
+ */
+ function get_response_str()
+ {
+ return $this->conn->result;
+ }
+
+
/**
* Set options to be used in rcube_imap_generic::connect()
*
@@ -224,29 +308,7 @@
$this->options = array_merge($this->options, (array)$opt);
}
-
- /**
- * Set a root folder for the IMAP connection.
- *
- * Only folders within this root folder will be displayed
- * and all folder paths will be translated using this folder name
- *
- * @param string $root Root folder
- * @access public
- */
- function set_rootdir($root)
- {
- if (preg_match('/[.\/]$/', $root)) //(substr($root, -1, 1)==='/')
- $root = substr($root, 0, -1);
- $this->root_dir = $root;
- $this->options['rootdir'] = $root;
-
- if (empty($this->delimiter))
- $this->get_hierarchy_delimiter();
- }
-
-
/**
* Set default message charset
*
@@ -260,7 +322,7 @@
$this->default_charset = $cs;
}
-
+
/**
* This list of folders will be listed above all other folders
*
@@ -278,19 +340,17 @@
}
}
-
+
/**
* Set internal mailbox reference.
*
* All operations will be perfomed on this mailbox/folder
*
- * @param string $new_mbox Mailbox/Folder name
+ * @param string $mailbox Mailbox/Folder name
* @access public
*/
- function set_mailbox($new_mbox)
+ function set_mailbox($mailbox)
{
- $mailbox = $this->mod_mailbox($new_mbox);
-
if ($this->mailbox == $mailbox)
return;
@@ -300,7 +360,29 @@
$this->_clear_messagecount($mailbox);
}
-
+
+ /**
+ * Forces selection of a mailbox
+ *
+ * @param string $mailbox Mailbox/Folder name
+ * @access public
+ */
+ function select_mailbox($mailbox=null)
+ {
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
+
+ $selected = $this->conn->select($mailbox);
+
+ if ($selected && $this->mailbox != $mailbox) {
+ // clear messagecount cache for this mailbox
+ $this->_clear_messagecount($mailbox);
+ $this->mailbox = $mailbox;
+ }
+ }
+
+
/**
* Set internal list page
*
@@ -312,7 +394,7 @@
$this->list_page = (int)$page;
}
-
+
/**
* Set internal page size
*
@@ -324,7 +406,7 @@
$this->page_size = (int)$size;
}
-
+
/**
* Save a set of message ids for future message listing methods
*
@@ -351,7 +433,7 @@
$this->search_sorted = $sorted;
}
-
+
/**
* Return the saved search set as hash array
* @return array Search set
@@ -367,7 +449,7 @@
);
}
-
+
/**
* Returns the currently used mailbox name
*
@@ -376,10 +458,10 @@
*/
function get_mailbox_name()
{
- return $this->conn->connected() ? $this->mod_mailbox($this->mailbox, 'out') : '';
+ return $this->conn->connected() ? $this->mailbox : '';
}
-
+
/**
* Returns the IMAP server's capability
*
@@ -392,7 +474,7 @@
return $this->conn->getCapability(strtoupper($cap));
}
-
+
/**
* Sets threading flag to the best supported THREAD algorithm
*
@@ -404,19 +486,19 @@
{
$this->threading = false;
- if ($enable) {
- if ($this->get_capability('THREAD=REFS'))
+ if ($enable && ($caps = $this->get_capability('THREAD'))) {
+ if (in_array('REFS', $caps))
$this->threading = 'REFS';
- else if ($this->get_capability('THREAD=REFERENCES'))
+ else if (in_array('REFERENCES', $caps))
$this->threading = 'REFERENCES';
- else if ($this->get_capability('THREAD=ORDEREDSUBJECT'))
+ else if (in_array('ORDEREDSUBJECT', $caps))
$this->threading = 'ORDEREDSUBJECT';
}
return $this->threading;
}
-
+
/**
* Checks the PERMANENTFLAGS capability of the current mailbox
* and returns true if the given flag is supported by the IMAP server
@@ -429,10 +511,10 @@
{
$flag = strtoupper($flag);
$imap_flag = $this->conn->flags[$flag];
- return (in_array_nocase($imap_flag, $this->conn->permanentflags));
+ return (in_array_nocase($imap_flag, $this->conn->data['PERMANENTFLAGS']));
}
-
+
/**
* Returns the delimiter that is used by the IMAP server for folder separation
*
@@ -441,34 +523,134 @@
*/
function get_hierarchy_delimiter()
{
- if ($this->conn && empty($this->delimiter))
- $this->delimiter = $this->conn->getHierarchyDelimiter();
-
- if (empty($this->delimiter))
- $this->delimiter = '/';
-
return $this->delimiter;
}
-
+
+ /**
+ * Get namespace
+ *
+ * @param string $name Namespace array index: personal, other, shared, prefix
+ *
+ * @return array Namespace data
+ * @access public
+ */
+ function get_namespace($name=null)
+ {
+ $ns = $this->namespace;
+
+ if ($name) {
+ return isset($ns[$name]) ? $ns[$name] : null;
+ }
+
+ unset($ns['prefix']);
+ return $ns;
+ }
+
+
+ /**
+ * Sets delimiter and namespaces
+ *
+ * @access private
+ */
+ private function set_env()
+ {
+ if ($this->delimiter !== null && $this->namespace !== null) {
+ return;
+ }
+
+ $config = rcmail::get_instance()->config;
+ $imap_personal = $config->get('imap_ns_personal');
+ $imap_other = $config->get('imap_ns_other');
+ $imap_shared = $config->get('imap_ns_shared');
+ $imap_delimiter = $config->get('imap_delimiter');
+
+ if (!$this->conn->connected())
+ return;
+
+ $ns = $this->conn->getNamespace();
+
+ // Set namespaces (NAMESPACE supported)
+ if (is_array($ns)) {
+ $this->namespace = $ns;
+ }
+ else {
+ $this->namespace = array(
+ 'personal' => NULL,
+ 'other' => NULL,
+ 'shared' => NULL,
+ );
+ }
+
+ if ($imap_delimiter) {
+ $this->delimiter = $imap_delimiter;
+ }
+ if (empty($this->delimiter)) {
+ $this->delimiter = $this->namespace['personal'][0][1];
+ }
+ if (empty($this->delimiter)) {
+ $this->delimiter = $this->conn->getHierarchyDelimiter();
+ }
+ if (empty($this->delimiter)) {
+ $this->delimiter = '/';
+ }
+
+ // Overwrite namespaces
+ if ($imap_personal !== null) {
+ $this->namespace['personal'] = NULL;
+ foreach ((array)$imap_personal as $dir) {
+ $this->namespace['personal'][] = array($dir, $this->delimiter);
+ }
+ }
+ if ($imap_other !== null) {
+ $this->namespace['other'] = NULL;
+ foreach ((array)$imap_other as $dir) {
+ if ($dir) {
+ $this->namespace['other'][] = array($dir, $this->delimiter);
+ }
+ }
+ }
+ if ($imap_shared !== null) {
+ $this->namespace['shared'] = NULL;
+ foreach ((array)$imap_shared as $dir) {
+ if ($dir) {
+ $this->namespace['shared'][] = array($dir, $this->delimiter);
+ }
+ }
+ }
+
+ // Find personal namespace prefix for mod_mailbox()
+ // Prefix can be removed when there is only one personal namespace
+ if (is_array($this->namespace['personal']) && count($this->namespace['personal']) == 1) {
+ $this->namespace['prefix'] = $this->namespace['personal'][0][0];
+ }
+
+ $_SESSION['imap_namespace'] = $this->namespace;
+ $_SESSION['imap_delimiter'] = $this->delimiter;
+ }
+
+
/**
* Get message count for a specific mailbox
*
- * @param string $mbox_name Mailbox/folder name
- * @param string $mode Mode for count [ALL|THREADS|UNSEEN|RECENT]
- * @param boolean $force Force reading from server and update cache
- * @param boolean $status Enables storing folder status info (max UID/count),
- * required for mailbox_status()
+ * @param string $mailbox Mailbox/folder name
+ * @param string $mode Mode for count [ALL|THREADS|UNSEEN|RECENT]
+ * @param boolean $force Force reading from server and update cache
+ * @param boolean $status Enables storing folder status info (max UID/count),
+ * required for mailbox_status()
* @return int Number of messages
* @access public
*/
- function messagecount($mbox_name='', $mode='ALL', $force=false, $status=true)
+ function messagecount($mailbox='', $mode='ALL', $force=false, $status=true)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
+
return $this->_messagecount($mailbox, $mode, $force, $status);
}
-
+
/**
* Private method for getting nr of messages
*
@@ -481,12 +663,9 @@
* @access private
* @see rcube_imap::messagecount()
*/
- private function _messagecount($mailbox='', $mode='ALL', $force=false, $status=true)
+ private function _messagecount($mailbox, $mode='ALL', $force=false, $status=true)
{
$mode = strtoupper($mode);
-
- if (empty($mailbox))
- $mailbox = $this->mailbox;
// count search set
if ($this->search_string && $mailbox == $this->mailbox && ($mode == 'ALL' || $mode == 'THREADS') && !$force) {
@@ -506,32 +685,52 @@
$a_mailbox_cache[$mailbox] = array();
if ($mode == 'THREADS') {
- $count = $this->_threadcount($mailbox, $msg_count);
+ $res = $this->_threadcount($mailbox, $msg_count);
+ $count = $res['count'];
+
if ($status) {
- $this->set_folder_stats($mailbox, 'cnt', $msg_count);
- $this->set_folder_stats($mailbox, 'maxuid', $msg_count ? $this->_id2uid($msg_count, $mailbox) : 0);
+ $this->set_folder_stats($mailbox, 'cnt', $res['msgcount']);
+ $this->set_folder_stats($mailbox, 'maxuid', $res['maxuid'] ? $this->_id2uid($res['maxuid'], $mailbox) : 0);
}
}
// RECENT count is fetched a bit different
else if ($mode == 'RECENT') {
- $count = $this->conn->checkForRecent($mailbox);
+ $count = $this->conn->countRecent($mailbox);
}
// use SEARCH for message counting
else if ($this->skip_deleted) {
$search_str = "ALL UNDELETED";
+ $keys = array('COUNT');
+ $need_uid = false;
- // get message count and store in cache
- if ($mode == 'UNSEEN')
+ if ($mode == 'UNSEEN') {
$search_str .= " UNSEEN";
- // get message count using SEARCH
+ }
+ else {
+ if ($this->messages_caching) {
+ $keys[] = 'ALL';
+ }
+ if ($status) {
+ $keys[] = 'MAX';
+ $need_uid = true;
+ }
+ }
+
+ // get message count using (E)SEARCH
// not very performant but more precise (using UNDELETED)
- $index = $this->conn->search($mailbox, $search_str);
+ $index = $this->conn->search($mailbox, $search_str, $need_uid, $keys);
- $count = is_array($index) ? count($index) : 0;
+ $count = is_array($index) ? $index['COUNT'] : 0;
- if ($mode == 'ALL' && $status) {
- $this->set_folder_stats($mailbox, 'cnt', $count);
- $this->set_folder_stats($mailbox, 'maxuid', $index ? $this->_id2uid(max($index), $mailbox) : 0);
+ if ($mode == 'ALL') {
+ if ($need_uid && $this->messages_caching) {
+ // Save messages index for check_cache_status()
+ $this->icache['all_undeleted_idx'] = $index['ALL'];
+ }
+ if ($status) {
+ $this->set_folder_stats($mailbox, 'cnt', $count);
+ $this->set_folder_stats($mailbox, 'maxuid', is_array($index) ? $index['MAX'] : 0);
+ }
}
}
else {
@@ -559,29 +758,41 @@
* Private method for getting nr of threads
*
* @param string $mailbox Folder name
- * @param int $msg_count Number of messages in the folder
+ *
+ * @returns array Array containing items: 'count' - threads count,
+ * 'msgcount' = messages count, 'maxuid' = max. UID in the set
* @access private
- * @see rcube_imap::messagecount()
*/
- private function _threadcount($mailbox, &$msg_count)
+ private function _threadcount($mailbox)
{
- if (!empty($this->icache['threads']))
- return count($this->icache['threads']['tree']);
+ $result = array();
- list ($thread_tree, $msg_depth, $has_children) = $this->_fetch_threads($mailbox);
+ if (!empty($this->icache['threads'])) {
+ $dcount = count($this->icache['threads']['depth']);
+ $result = array(
+ 'count' => count($this->icache['threads']['tree']),
+ 'msgcount' => $dcount,
+ 'maxuid' => $dcount ? max(array_keys($this->icache['threads']['depth'])) : 0,
+ );
+ }
+ else if (is_array($result = $this->_fetch_threads($mailbox))) {
+ $dcount = count($result[1]);
+ $result = array(
+ 'count' => count($result[0]),
+ 'msgcount' => $dcount,
+ 'maxuid' => $dcount ? max(array_keys($result[1])) : 0,
+ );
+ }
- $msg_count = count($msg_depth);
-
-// $this->update_thread_cache($mailbox, $thread_tree, $msg_depth, $has_children);
- return count($thread_tree);
+ return $result;
}
-
+
/**
* Public method for listing headers
* convert mailbox name with root dir first
*
- * @param string $mbox_name Mailbox/folder name
+ * @param string $mailbox Mailbox/folder name
* @param int $page Current page to list
* @param string $sort_field Header field to sort by
* @param string $sort_order Sort order [ASC|DESC]
@@ -589,13 +800,16 @@
* @return array Indexed array with message header objects
* @access public
*/
- function list_headers($mbox_name='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0)
+ function list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
+
return $this->_list_headers($mailbox, $page, $sort_field, $sort_order, false, $slice);
}
-
+
/**
* Private method for listing message headers
*
@@ -625,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) {
@@ -725,7 +939,7 @@
return array_values($a_msg_headers);
}
-
+
/**
* Private method for listing message headers using threads
*
@@ -771,14 +985,14 @@
{
if (empty($this->icache['threads'])) {
// get all threads
- list ($thread_tree, $msg_depth, $has_children) = $this->conn->thread(
- $mailbox, $this->threading, $this->skip_deleted ? 'UNDELETED' : '');
+ $result = $this->conn->thread($mailbox, $this->threading,
+ $this->skip_deleted ? 'UNDELETED' : '');
// add to internal (fast) cache
$this->icache['threads'] = array();
- $this->icache['threads']['tree'] = $thread_tree;
- $this->icache['threads']['depth'] = $msg_depth;
- $this->icache['threads']['has_children'] = $has_children;
+ $this->icache['threads']['tree'] = is_array($result) ? $result[0] : array();
+ $this->icache['threads']['depth'] = is_array($result) ? $result[1] : array();
+ $this->icache['threads']['has_children'] = is_array($result) ? $result[2] : array();
}
return array(
@@ -818,7 +1032,7 @@
// flatten threads array
// @TODO: fetch children only in expanded mode (?)
$all_ids = array();
- foreach($msg_index as $root) {
+ foreach ($msg_index as $root) {
$all_ids[] = $root;
if (!empty($thread_tree[$root]))
$all_ids = array_merge($all_ids, array_keys_recursive($thread_tree[$root]));
@@ -1107,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);
@@ -1130,7 +1344,7 @@
$for_create[] = $headers->uid;
}
-
+
if ($for_remove)
$this->remove_message_cache($cache_key, $for_remove);
@@ -1151,12 +1365,14 @@
* We compare the maximum UID to determine the number of
* new messages because the RECENT flag is not reliable.
*
- * @param string $mbox_name Mailbox/folder name
+ * @param string $mailbox Mailbox/folder name
* @return int Folder status
*/
- function mailbox_status($mbox_name = null)
+ function mailbox_status($mailbox = null)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
$old = $this->get_folder_stats($mailbox);
// refresh message count -> will update
@@ -1183,26 +1399,27 @@
* Stores folder statistic data in session
* @TODO: move to separate DB table (cache?)
*
- * @param string $mbox_name Mailbox name
- * @param string $name Data name
- * @param mixed $data Data value
+ * @param string $mailbox Mailbox name
+ * @param string $name Data name
+ * @param mixed $data Data value
*/
- private function set_folder_stats($mbox_name, $name, $data)
+ private function set_folder_stats($mailbox, $name, $data)
{
- $_SESSION['folders'][$mbox_name][$name] = $data;
+ $_SESSION['folders'][$mailbox][$name] = $data;
}
/**
* Gets folder statistic data
*
- * @param string $mbox_name Mailbox name
+ * @param string $mailbox Mailbox name
+ *
* @return array Stats data
*/
- private function get_folder_stats($mbox_name)
+ private function get_folder_stats($mailbox)
{
- if ($_SESSION['folders'][$mbox_name])
- return (array) $_SESSION['folders'][$mbox_name];
+ if ($_SESSION['folders'][$mailbox])
+ return (array) $_SESSION['folders'][$mailbox];
else
return array();
}
@@ -1211,23 +1428,25 @@
/**
* Return sorted array of message IDs (not UIDs)
*
- * @param string $mbox_name Mailbox to get index from
+ * @param string $mailbox Mailbox to get index from
* @param string $sort_field Sort column
* @param string $sort_order Sort order [ASC, DESC]
* @return array Indexed array with message IDs
*/
- function message_index($mbox_name='', $sort_field=NULL, $sort_order=NULL)
+ function message_index($mailbox='', $sort_field=NULL, $sort_order=NULL)
{
if ($this->threading)
- return $this->thread_index($mbox_name, $sort_field, $sort_order);
+ return $this->thread_index($mailbox, $sort_field, $sort_order);
$this->_set_sort_order($sort_field, $sort_order);
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
$key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.msgi";
// we have a saved search result, get index from there
- if (!isset($this->cache[$key]) && $this->search_string
+ if (!isset($this->icache[$key]) && $this->search_string
&& !$this->search_threads && $mailbox == $this->mailbox) {
// use message index sort as default sorting
if (!$this->sort_field) {
@@ -1237,9 +1456,9 @@
sort($msgs);
if ($this->sort_order == 'DESC')
- $this->cache[$key] = array_reverse($msgs);
+ $this->icache[$key] = array_reverse($msgs);
else
- $this->cache[$key] = $msgs;
+ $this->icache[$key] = $msgs;
}
// sort with SORT command
else if ($this->search_sorted) {
@@ -1247,9 +1466,9 @@
$this->search('', $this->search_string, $this->search_charset, $this->sort_field);
if ($this->sort_order == 'DESC')
- $this->cache[$key] = array_reverse($this->search_set);
+ $this->icache[$key] = array_reverse($this->search_set);
else
- $this->cache[$key] = $this->search_set;
+ $this->icache[$key] = $this->search_set;
}
else {
$a_index = $this->conn->fetchHeaderIndex($mailbox,
@@ -1261,17 +1480,17 @@
else if ($this->sort_order=="DESC")
arsort($a_index);
- $this->cache[$key] = array_keys($a_index);
+ $this->icache[$key] = array_keys($a_index);
}
else {
- $this->cache[$key] = array();
+ $this->icache[$key] = array();
}
}
}
// have stored it in RAM
- if (isset($this->cache[$key]))
- return $this->cache[$key];
+ if (isset($this->icache[$key]))
+ return $this->icache[$key];
// check local cache
$cache_key = $mailbox.'.msg';
@@ -1295,7 +1514,7 @@
if ($a_index !== false && $this->sort_order == 'DESC')
$a_index = array_reverse($a_index);
- $this->cache[$key] = $a_index;
+ $this->icache[$key] = $a_index;
}
// fetch complete message index
else if ($this->get_capability('SORT') &&
@@ -1305,7 +1524,7 @@
if ($this->sort_order == 'DESC')
$a_index = array_reverse($a_index);
- $this->cache[$key] = $a_index;
+ $this->icache[$key] = $a_index;
}
else if ($a_index = $this->conn->fetchHeaderIndex(
$mailbox, "1:*", $this->sort_field, $this->skip_deleted)) {
@@ -1314,39 +1533,41 @@
else if ($this->sort_order=="DESC")
arsort($a_index);
- $this->cache[$key] = array_keys($a_index);
+ $this->icache[$key] = array_keys($a_index);
}
- return $this->cache[$key] !== false ? $this->cache[$key] : array();
+ return $this->icache[$key] !== false ? $this->icache[$key] : array();
}
/**
* Return sorted array of threaded message IDs (not UIDs)
*
- * @param string $mbox_name Mailbox to get index from
+ * @param string $mailbox Mailbox to get index from
* @param string $sort_field Sort column
* @param string $sort_order Sort order [ASC, DESC]
* @return array Indexed array with message IDs
*/
- function thread_index($mbox_name='', $sort_field=NULL, $sort_order=NULL)
+ function thread_index($mailbox='', $sort_field=NULL, $sort_order=NULL)
{
$this->_set_sort_order($sort_field, $sort_order);
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
$key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.thi";
// we have a saved search result, get index from there
- if (!isset($this->cache[$key]) && $this->search_string
+ if (!isset($this->icache[$key]) && $this->search_string
&& $this->search_threads && $mailbox == $this->mailbox) {
// use message IDs for better performance
$ids = array_keys_recursive($this->search_set['tree']);
- $this->cache[$key] = $this->_flatten_threads($mailbox, $this->search_set['tree'], $ids);
+ $this->icache[$key] = $this->_flatten_threads($mailbox, $this->search_set['tree'], $ids);
}
// have stored it in RAM
- if (isset($this->cache[$key]))
- return $this->cache[$key];
+ if (isset($this->icache[$key]))
+ return $this->icache[$key];
/*
// check local cache
$cache_key = $mailbox.'.msg';
@@ -1361,9 +1582,9 @@
// get all threads (default sort order)
list ($thread_tree) = $this->_fetch_threads($mailbox);
- $this->cache[$key] = $this->_flatten_threads($mailbox, $thread_tree);
+ $this->icache[$key] = $this->_flatten_threads($mailbox, $thread_tree);
- return $this->cache[$key];
+ return $this->icache[$key];
}
@@ -1390,7 +1611,7 @@
// flatten threads array
$all_ids = array();
- foreach($msg_index as $root) {
+ foreach ($msg_index as $root) {
$all_ids[] = $root;
if (!empty($thread_tree[$root])) {
foreach (array_keys_recursive($thread_tree[$root]) as $val)
@@ -1498,19 +1719,21 @@
/**
* Invoke search request to IMAP server
*
- * @param string $mbox_name Mailbox name to search in
+ * @param string $mailbox Mailbox name to search in
* @param string $str Search criteria
* @param string $charset Search charset
* @param string $sort_field Header field to sort by
* @return array search results as list of message IDs
* @access public
*/
- function search($mbox_name='', $str=NULL, $charset=NULL, $sort_field=NULL)
+ function search($mailbox='', $str=NULL, $charset=NULL, $sort_field=NULL)
{
if (!$str)
return false;
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
$results = $this->_search_index($mailbox, $str, $charset, $sort_field);
@@ -1559,7 +1782,7 @@
return $a_messages;
}
-
+
if ($sort_field && $this->get_capability('SORT')) {
$charset = $charset ? $charset : $this->default_charset;
$a_messages = $this->conn->sort($mailbox, $sort_field, $criteria, false, $charset);
@@ -1604,18 +1827,20 @@
* Direct (real and simple) SEARCH request to IMAP server,
* without result sorting and caching
*
- * @param string $mbox_name Mailbox name to search in
- * @param string $str Search string
- * @param boolean $ret_uid True if UIDs should be returned
+ * @param string $mailbox Mailbox name to search in
+ * @param string $str Search string
+ * @param boolean $ret_uid True if UIDs should be returned
* @return array Search results as list of message IDs or UIDs
* @access public
*/
- function search_once($mbox_name='', $str=NULL, $ret_uid=false)
+ function search_once($mailbox='', $str=NULL, $ret_uid=false)
{
if (!$str)
return false;
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
return $this->conn->search($mailbox, $str, $ret_uid);
}
@@ -1784,15 +2009,17 @@
/**
* Return message headers object of a specific message
*
- * @param int $id Message ID
- * @param string $mbox_name Mailbox to read from
- * @param boolean $is_uid True if $id is the message UID
- * @param boolean $bodystr True if we need also BODYSTRUCTURE in headers
+ * @param int $id Message ID
+ * @param string $mailbox Mailbox to read from
+ * @param boolean $is_uid True if $id is the message UID
+ * @param boolean $bodystr True if we need also BODYSTRUCTURE in headers
* @return object Message headers representation
*/
- function get_headers($id, $mbox_name=NULL, $is_uid=true, $bodystr=false)
+ function get_headers($id, $mailbox=null, $is_uid=true, $bodystr=false)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
$uid = $is_uid ? $id : $this->_id2uid($id, $mailbox);
// get cached headers
@@ -1867,7 +2094,7 @@
return false;
}
- $struct = &$this->_structure_part($structure);
+ $struct = &$this->_structure_part($structure, 0, '', $headers);
$struct->headers = get_object_vars($headers);
// don't trust given content-type
@@ -1878,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);
}
@@ -1999,6 +2226,11 @@
$struct->charset = $struct->ctype_parameters['charset'];
}
+ // #1487700: workaround for lack of charset in malformed structure
+ if (empty($struct->charset) && !empty($mime_headers) && $mime_headers->charset) {
+ $struct->charset = $mime_headers->charset;
+ }
+
// read content encoding
if (!empty($part[5]) && $part[5]!='NIL') {
$struct->encoding = strtolower($part[5]);
@@ -2047,7 +2279,11 @@
$mime_headers = $this->conn->fetchPartHeader(
$this->mailbox, $this->_msg_id, false, $struct->mime_id);
}
- $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers;
+
+ if (is_string($mime_headers))
+ $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers;
+ else if (is_object($mime_headers))
+ $struct->headers = get_object_vars($mime_headers) + $struct->headers;
// get real content-type of message/rfc822
if ($struct->mimetype == 'message/rfc822') {
@@ -2222,9 +2458,11 @@
* @param rcube_message_part $o_part Part object created by get_structure()
* @param mixed $print True to print part, ressource to write part contents in
* @param resource $fp File pointer to save the message part
+ * @param boolean $skip_charset_conv Disables charset conversion
+ *
* @return string Message/part body if not printed
*/
- function &get_message_part($uid, $part=1, $o_part=NULL, $print=NULL, $fp=NULL)
+ function &get_message_part($uid, $part=1, $o_part=NULL, $print=NULL, $fp=NULL, $skip_charset_conv=false)
{
// get part encoding if not provided
if (!is_object($o_part)) {
@@ -2243,20 +2481,24 @@
// TODO: Add caching for message parts
- if (!$part) $part = 'TEXT';
+ if (!$part) {
+ $part = 'TEXT';
+ }
$body = $this->conn->handlePartBody($this->mailbox, $uid, true, $part,
$o_part->encoding, $print, $fp);
- if ($fp || $print)
+ if ($fp || $print) {
return true;
+ }
// convert charset (if text or message part)
- if ($body && ($o_part->ctype_primary == 'text' || $o_part->ctype_primary == 'message')) {
- // assume default if no charset specified
- if (empty($o_part->charset) || strtolower($o_part->charset) == 'us-ascii')
+ if ($body && !$skip_charset_conv &&
+ preg_match('/^(text|message)$/', $o_part->ctype_primary)
+ ) {
+ if (!$o_part->charset || strtoupper($o_part->charset) == 'US-ASCII') {
$o_part->charset = $this->default_charset;
-
+ }
$body = rcube_charset_convert($body, $o_part->charset);
}
@@ -2280,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);
}
@@ -2319,13 +2564,16 @@
*
* @param mixed $uids Message UIDs as array or comma-separated string, or '*'
* @param string $flag Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT
- * @param string $mbox_name Folder name
+ * @param string $mailbox Folder name
* @param boolean $skip_cache True to skip message cache clean up
- * @return int Number of flagged messages, -1 on failure
+ *
+ * @return boolean Operation status
*/
- function set_flag($uids, $flag, $mbox_name=NULL, $skip_cache=false)
+ function set_flag($uids, $flag, $mailbox=null, $skip_cache=false)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
$flag = strtoupper($flag);
list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
@@ -2335,22 +2583,24 @@
else
$result = $this->conn->flag($mailbox, $uids, $flag);
- if ($result >= 0) {
+ 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);
else
$this->remove_message_cache($cache_key, explode(',', $uids));
}
- // update counters
- if ($flag=='SEEN')
- $this->_set_messagecount($mailbox, 'UNSEEN', $result*(-1));
- else if ($flag=='UNSEEN')
- $this->_set_messagecount($mailbox, 'UNSEEN', $result);
- else if ($flag=='DELETED')
- $this->_set_messagecount($mailbox, 'ALL', $result*(-1));
+
+ // clear cached counters
+ if ($flag == 'SEEN' || $flag == 'UNSEEN') {
+ $this->_clear_messagecount($mailbox, 'SEEN');
+ $this->_clear_messagecount($mailbox, 'UNSEEN');
+ }
+ else if ($flag == 'DELETED') {
+ $this->_clear_messagecount($mailbox, 'DELETED');
+ }
}
return $result;
@@ -2360,34 +2610,37 @@
/**
* Remove message flag for one or several messages
*
- * @param mixed $uids Message UIDs as array or comma-separated string, or '*'
- * @param string $flag Flag to unset: SEEN, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT
- * @param string $mbox_name Folder name
+ * @param mixed $uids Message UIDs as array or comma-separated string, or '*'
+ * @param string $flag Flag to unset: SEEN, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT
+ * @param string $mailbox Folder name
+ *
* @return int Number of flagged messages, -1 on failure
* @see set_flag
*/
- function unset_flag($uids, $flag, $mbox_name=NULL)
+ function unset_flag($uids, $flag, $mailbox=null)
{
- return $this->set_flag($uids, 'UN'.$flag, $mbox_name);
+ return $this->set_flag($uids, 'UN'.$flag, $mailbox);
}
/**
* Append a mail message (source) to a specific mailbox
*
- * @param string $mbox_name Target mailbox
- * @param string $message The message source string or filename
- * @param string $headers Headers string if $message contains only the body
- * @param boolean $is_file True if $message is a filename
+ * @param string $mailbox Target mailbox
+ * @param string $message The message source string or filename
+ * @param string $headers Headers string if $message contains only the body
+ * @param boolean $is_file True if $message is a filename
*
* @return boolean True on success, False on error
*/
- function save_message($mbox_name, &$message, $headers='', $is_file=false)
+ function save_message($mailbox, &$message, $headers='', $is_file=false)
{
- $mailbox = $this->mod_mailbox($mbox_name);
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
// make sure mailbox exists
- if ($this->mailbox_exists($mbox_name, true)) {
+ if ($this->mailbox_exists($mailbox)) {
if ($is_file)
$saved = $this->conn->appendFromFile($mailbox, $message, $headers);
else
@@ -2413,10 +2666,13 @@
*/
function move_message($uids, $to_mbox, $from_mbox='')
{
- $fbox = $from_mbox;
- $tbox = $to_mbox;
- $to_mbox = $this->mod_mailbox($to_mbox);
- $from_mbox = $from_mbox ? $this->mod_mailbox($from_mbox) : $this->mailbox;
+ if (!strlen($from_mbox)) {
+ $from_mbox = $this->mailbox;
+ }
+
+ if ($to_mbox === $from_mbox) {
+ return false;
+ }
list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
@@ -2425,23 +2681,24 @@
return false;
// make sure mailbox exists
- if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox, true)) {
- if (in_array($tbox, $this->default_folders))
- $this->create_mailbox($tbox, true);
+ if ($to_mbox != 'INBOX' && !$this->mailbox_exists($to_mbox)) {
+ if (in_array($to_mbox, $this->default_folders))
+ $this->create_mailbox($to_mbox, true);
else
return false;
}
- // flag messages as read before moving them
$config = rcmail::get_instance()->config;
- if ($config->get('read_when_deleted') && $tbox == $config->get('trash_mbox')) {
+ $to_trash = $to_mbox == $config->get('trash_mbox');
+
+ // flag messages as read before moving them
+ if ($to_trash && $config->get('read_when_deleted')) {
// don't flush cache (4th argument)
- $this->set_flag($uids, 'SEEN', $fbox, true);
+ $this->set_flag($uids, 'SEEN', $from_mbox, true);
}
// move messages
- $move = $this->conn->move($uids, $from_mbox, $to_mbox);
- $moved = !($move === false || $move < 0);
+ $moved = $this->conn->move($uids, $from_mbox, $to_mbox);
// send expunge command in order to have the moved message
// really deleted from the source mailbox
@@ -2451,8 +2708,8 @@
$this->_clear_messagecount($to_mbox);
}
// moving failed
- else if ($config->get('delete_always', false) && $tbox == $config->get('trash_mbox')) {
- $moved = $this->delete_message($uids, $fbox);
+ else if ($to_trash && $config->get('delete_always', false)) {
+ $moved = $this->delete_message($uids, $from_mbox);
}
if ($moved) {
@@ -2494,28 +2751,27 @@
*/
function copy_message($uids, $to_mbox, $from_mbox='')
{
- $fbox = $from_mbox;
- $tbox = $to_mbox;
- $to_mbox = $this->mod_mailbox($to_mbox);
- $from_mbox = $from_mbox ? $this->mod_mailbox($from_mbox) : $this->mailbox;
+ if (!strlen($from_mbox)) {
+ $from_mbox = $this->mailbox;
+ }
list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
// exit if no message uids are specified
- if (empty($uids))
+ if (empty($uids)) {
return false;
+ }
// make sure mailbox exists
- if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox, true)) {
- if (in_array($tbox, $this->default_folders))
- $this->create_mailbox($tbox, true);
+ if ($to_mbox != 'INBOX' && !$this->mailbox_exists($to_mbox)) {
+ if (in_array($to_mbox, $this->default_folders))
+ $this->create_mailbox($to_mbox, true);
else
return false;
}
// copy messages
- $copy = $this->conn->copy($uids, $from_mbox, $to_mbox);
- $copied = !($copy === false || $copy < 0);
+ $copied = $this->conn->copy($uids, $from_mbox, $to_mbox);
if ($copied) {
$this->_clear_messagecount($to_mbox);
@@ -2528,13 +2784,16 @@
/**
* Mark messages as deleted and expunge mailbox
*
- * @param mixed $uids Message UIDs as array or comma-separated string, or '*'
- * @param string $mbox_name Source mailbox
+ * @param mixed $uids Message UIDs as array or comma-separated string, or '*'
+ * @param string $mailbox Source mailbox
+ *
* @return boolean True on success, False on error
*/
- function delete_message($uids, $mbox_name='')
+ function delete_message($uids, $mailbox='')
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
@@ -2582,19 +2841,20 @@
/**
* Clear all messages in a specific mailbox
*
- * @param string $mbox_name Mailbox name
+ * @param string $mailbox Mailbox name
+ *
* @return int Above 0 on success
*/
- function clear_mailbox($mbox_name=NULL)
+ function clear_mailbox($mailbox=null)
{
- $mailbox = !empty($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
- $msg_count = $this->_messagecount($mailbox, 'ALL');
-
- if (!$msg_count) {
- return 0;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
}
- $cleared = $this->conn->clearFolder($mailbox);
+ // SELECT will set messages count for clearFolder()
+ if ($this->conn->select($mailbox)) {
+ $cleared = $this->conn->clearFolder($mailbox);
+ }
// make sure the message count cache is cleared as well
if ($cleared) {
@@ -2611,13 +2871,17 @@
/**
* Send IMAP expunge command and clear cache
*
- * @param string $mbox_name Mailbox name
+ * @param string $mailbox Mailbox name
* @param boolean $clear_cache False if cache should not be cleared
+ *
* @return boolean True on success
*/
- function expunge($mbox_name='', $clear_cache=true)
+ function expunge($mailbox='', $clear_cache=true)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
+
return $this->_expunge($mailbox, $clear_cache);
}
@@ -2639,9 +2903,25 @@
else
$a_uids = NULL;
- $result = $this->conn->expunge($mailbox, $a_uids);
+ // force mailbox selection and check if mailbox is writeable
+ // to prevent a situation when CLOSE is executed on closed
+ // or EXPUNGE on read-only mailbox
+ $result = $this->conn->select($mailbox);
+ if (!$result) {
+ return false;
+ }
+ if (!$this->conn->data['READ-WRITE']) {
+ $this->conn->setError(rcube_imap_generic::ERROR_READONLY, "Mailbox is read-only");
+ return false;
+ }
- if ($result>=0 && $clear_cache) {
+ // CLOSE(+SELECT) should be faster than EXPUNGE
+ if (empty($a_uids) || $a_uids == '1:*')
+ $result = $this->conn->close();
+ else
+ $result = $this->conn->expunge($mailbox, $a_uids);
+
+ if ($result && $clear_cache) {
$this->clear_message_cache($mailbox.'.msg');
$this->_clear_messagecount($mailbox);
}
@@ -2696,13 +2976,17 @@
/**
* Translate UID to message ID
*
- * @param int $uid Message UID
- * @param string $mbox_name Mailbox name
+ * @param int $uid Message UID
+ * @param string $mailbox Mailbox name
+ *
* @return int Message ID
*/
- function get_id($uid, $mbox_name=NULL)
+ function get_id($uid, $mailbox=null)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
+
return $this->_uid2id($uid, $mailbox);
}
@@ -2710,13 +2994,17 @@
/**
* Translate message number to UID
*
- * @param int $id Message ID
- * @param string $mbox_name Mailbox name
+ * @param int $id Message ID
+ * @param string $mailbox Mailbox name
+ *
* @return int Message UID
*/
- function get_uid($id,$mbox_name=NULL)
+ function get_uid($id, $mailbox=null)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
+
return $this->_id2uid($id, $mailbox);
}
@@ -2729,32 +3017,26 @@
/**
* Public method for listing subscribed folders
*
- * Converts mailbox name with root dir first
- *
* @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_out = array();
- $a_mboxes = $this->_list_mailboxes($root, $filter);
-
- foreach ($a_mboxes as $idx => $mbox_row) {
- if ($name = $this->mod_mailbox($mbox_row, 'out'))
- $a_out[] = $name;
- unset($a_mboxes[$idx]);
- }
+ $a_mboxes = $this->_list_mailboxes($root, $name, $filter);
// INBOX should always be available
- if (!in_array('INBOX', $a_out))
- array_unshift($a_out, 'INBOX');
+ if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) {
+ array_unshift($a_mboxes, 'INBOX');
+ }
// sort mailboxes
- $a_out = $this->_sort_mailbox_list($a_out);
+ $a_mboxes = $this->_sort_mailbox_list($a_mboxes);
- return $a_out;
+ return $a_mboxes;
}
@@ -2762,37 +3044,69 @@
* 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'];
}
else {
- // retrieve list of folders from IMAP server
- $a_folders = $this->conn->listSubscribed($this->mod_mailbox($root), $filter);
+ // Server supports LIST-EXTENDED, we can use selection options
+ $config = rcmail::get_instance()->config;
+ // #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, $name,
+ NULL, array('SUBSCRIBED'));
+
+ // remove non-existent folders
+ if (is_array($a_folders)) {
+ foreach ($a_folders as $idx => $folder) {
+ if ($this->conn->data['LIST'] && ($opts = $this->conn->data['LIST'][$folder])
+ && in_array('\\NonExistent', $opts)
+ ) {
+ unset($a_folders[$idx]);
+ }
+ }
+ }
+ }
+ // retrieve list of folders from IMAP server using LSUB
+ else {
+ $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;
}
@@ -2802,41 +3116,39 @@
* 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($this->mod_mailbox($root), $filter);
+ $a_mboxes = $this->conn->listMailboxes($root, $name);
}
- $a_folders = array();
- if (!is_array($a_mboxes))
+ if (!is_array($a_mboxes)) {
$a_mboxes = array();
-
- // modify names with root dir
- foreach ($a_mboxes as $idx => $mbox_name) {
- if ($name = $this->mod_mailbox($mbox_name, 'out'))
- $a_folders[] = $name;
- unset($a_mboxes[$idx]);
}
// INBOX should always be available
- if (!in_array('INBOX', $a_folders))
- array_unshift($a_folders, 'INBOX');
+ if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) {
+ array_unshift($a_mboxes, 'INBOX');
+ }
// filter folders and sort them
- $a_folders = $this->_sort_mailbox_list($a_folders);
- return $a_folders;
+ $a_mboxes = $this->_sort_mailbox_list($a_mboxes);
+
+ return $a_mboxes;
}
@@ -2852,6 +3164,25 @@
return $this->conn->getQuota();
return false;
+ }
+
+
+ /**
+ * Get mailbox size (size of all messages in a mailbox)
+ *
+ * @param string $mailbox Mailbox name
+ *
+ * @return int Mailbox size in bytes, False on error
+ */
+ function get_mailbox_size($mailbox)
+ {
+ // @TODO: could we try to use QUOTA here?
+ $result = $this->conn->fetchHeaderIndex($mailbox, '1:*', 'SIZE', false);
+
+ if (is_array($result))
+ $result = array_sum($result);
+
+ return $result;
}
@@ -2890,129 +3221,120 @@
/**
* Create a new mailbox on the server and register it in local cache
*
- * @param string $name New mailbox name (as utf-7 string)
+ * @param string $mailbox New mailbox name
* @param boolean $subscribe True if the new mailbox should be subscribed
- * @param string Name of the created mailbox, false on error
+ *
+ * @return boolean True on success
*/
- function create_mailbox($name, $subscribe=false)
+ function create_mailbox($mailbox, $subscribe=false)
{
- $result = false;
-
- // reduce mailbox name to 100 chars
- $name = substr($name, 0, 100);
- $abs_name = $this->mod_mailbox($name);
- $result = $this->conn->createFolder($abs_name);
+ $result = $this->conn->createFolder($mailbox);
// try to subscribe it
- if ($result && $subscribe)
- $this->subscribe($name);
+ if ($result) {
+ // clear cache
+ $this->clear_cache('mailboxes', true);
- return $result ? $name : false;
+ if ($subscribe)
+ $this->subscribe($mailbox);
+ }
+
+ return $result;
}
/**
* Set a new name to an existing mailbox
*
- * @param string $mbox_name Mailbox to rename (as utf-7 string)
- * @param string $new_name New mailbox name (as utf-7 string)
- * @return string Name of the renames mailbox, False on error
+ * @param string $mailbox Mailbox to rename
+ * @param string $new_name New mailbox name
+ *
+ * @return boolean True on success
*/
- function rename_mailbox($mbox_name, $new_name)
+ function rename_mailbox($mailbox, $new_name)
{
- $result = false;
+ if (!strlen($new_name)) {
+ return false;
+ }
- // encode mailbox name and reduce it to 100 chars
- $name = substr($new_name, 0, 100);
+ $delm = $this->get_hierarchy_delimiter();
- // make absolute path
- $mailbox = $this->mod_mailbox($mbox_name);
- $abs_name = $this->mod_mailbox($name);
+ // get list of subscribed folders
+ if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) {
+ $a_subscribed = $this->_list_mailboxes('', $mailbox . $delm . '*');
+ $subscribed = $this->mailbox_exists($mailbox, true);
+ }
+ else {
+ $a_subscribed = $this->_list_mailboxes();
+ $subscribed = in_array($mailbox, $a_subscribed);
+ }
- // check if mailbox is subscribed
- $a_subscribed = $this->_list_mailboxes();
- $subscribed = in_array($mailbox, $a_subscribed);
-
- // unsubscribe folder
- if ($subscribed)
- $this->conn->unsubscribe($mailbox);
-
- if (strlen($abs_name))
- $result = $this->conn->renameFolder($mailbox, $abs_name);
+ $result = $this->conn->renameFolder($mailbox, $new_name);
if ($result) {
- $delm = $this->get_hierarchy_delimiter();
+ // unsubscribe the old folder, subscribe the new one
+ if ($subscribed) {
+ $this->conn->unsubscribe($mailbox);
+ $this->conn->subscribe($new_name);
+ }
// check if mailbox children are subscribed
- foreach ($a_subscribed as $c_subscribed)
+ foreach ($a_subscribed as $c_subscribed) {
if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_subscribed)) {
$this->conn->unsubscribe($c_subscribed);
$this->conn->subscribe(preg_replace('/^'.preg_quote($mailbox, '/').'/',
- $abs_name, $c_subscribed));
+ $new_name, $c_subscribed));
}
+ }
// clear cache
$this->clear_message_cache($mailbox.'.msg');
- $this->clear_cache('mailboxes');
+ $this->clear_cache('mailboxes', true);
}
- // try to subscribe it
- if ($result && $subscribed)
- $this->conn->subscribe($abs_name);
-
- return $result ? $name : false;
+ return $result;
}
/**
- * Remove mailboxes from server
+ * Remove mailbox from server
*
- * @param string|array $mbox_name sMailbox name(s) string/array
+ * @param string $mailbox Mailbox name
+ *
* @return boolean True on success
*/
- function delete_mailbox($mbox_name)
+ function delete_mailbox($mailbox)
{
- $deleted = false;
+ $delm = $this->get_hierarchy_delimiter();
- if (is_array($mbox_name))
- $a_mboxes = $mbox_name;
- else if (is_string($mbox_name) && strlen($mbox_name))
- $a_mboxes = explode(',', $mbox_name);
+ // get list of folders
+ if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false))
+ $sub_mboxes = $this->list_unsubscribed('', $mailbox . $delm . '*');
+ else
+ $sub_mboxes = $this->list_unsubscribed();
- if (is_array($a_mboxes)) {
- foreach ($a_mboxes as $mbox_name) {
- $mailbox = $this->mod_mailbox($mbox_name);
- $sub_mboxes = $this->conn->listMailboxes($this->mod_mailbox(''),
- $mbox_name . $this->delimiter . '*');
+ // send delete command to server
+ $result = $this->conn->deleteFolder($mailbox);
- // unsubscribe mailbox before deleting
- $this->conn->unsubscribe($mailbox);
+ if ($result) {
+ // unsubscribe mailbox
+ $this->conn->unsubscribe($mailbox);
- // send delete command to server
- $result = $this->conn->deleteFolder($mailbox);
- if ($result) {
- $deleted = true;
- $this->clear_message_cache($mailbox.'.msg');
- }
-
- foreach ($sub_mboxes as $c_mbox) {
- if ($c_mbox != 'INBOX') {
- $this->conn->unsubscribe($c_mbox);
- $result = $this->conn->deleteFolder($c_mbox);
- if ($result) {
- $deleted = true;
- $this->clear_message_cache($c_mbox.'.msg');
- }
+ foreach ($sub_mboxes as $c_mbox) {
+ if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_mbox)) {
+ $this->conn->unsubscribe($c_mbox);
+ if ($this->conn->deleteFolder($c_mbox)) {
+ $this->clear_message_cache($c_mbox.'.msg');
}
}
}
+
+ // clear mailbox-related cache
+ $this->clear_message_cache($mailbox.'.msg');
+ $this->clear_cache('mailboxes', true);
}
- // clear mailboxlist cache
- if ($deleted)
- $this->clear_cache('mailboxes');
-
- return $deleted;
+ return $result;
}
@@ -3034,31 +3356,32 @@
/**
* Checks if folder exists and is subscribed
*
- * @param string $mbox_name Folder name
+ * @param string $mailbox Folder name
* @param boolean $subscription Enable subscription checking
+ *
* @return boolean TRUE or FALSE
*/
- function mailbox_exists($mbox_name, $subscription=false)
+ function mailbox_exists($mailbox, $subscription=false)
{
- if ($mbox_name) {
- if ($mbox_name == 'INBOX')
- return true;
+ if ($mailbox == 'INBOX') {
+ return true;
+ }
- $key = $subscription ? 'subscribed' : 'existing';
- if (is_array($this->icache[$key]) && in_array($mbox_name, $this->icache[$key]))
- return true;
+ $key = $subscription ? 'subscribed' : 'existing';
- if ($subscription) {
- $a_folders = $this->conn->listSubscribed($this->mod_mailbox(''), $mbox_name);
- }
- else {
- $a_folders = $this->conn->listMailboxes($this->mod_mailbox(''), $mbox_name);
- }
+ if (is_array($this->icache[$key]) && in_array($mailbox, $this->icache[$key]))
+ return true;
- if (is_array($a_folders) && in_array($this->mod_mailbox($mbox_name), $a_folders)) {
- $this->icache[$key][] = $mbox_name;
- return true;
- }
+ if ($subscription) {
+ $a_folders = $this->conn->listSubscribed('', $mailbox);
+ }
+ else {
+ $a_folders = $this->conn->listMailboxes('', $mailbox);
+ }
+
+ if (is_array($a_folders) && in_array($mailbox, $a_folders)) {
+ $this->icache[$key][] = $mailbox;
+ return true;
}
return false;
@@ -3066,25 +3389,161 @@
/**
- * Modify folder name for input/output according to root dir and namespace
+ * Returns the namespace where the folder is in
*
- * @param string $mbox_name Folder name
- * @param string $mode Mode
- * @return string Folder name
+ * @param string $mailbox Folder name
+ *
+ * @return string One of 'personal', 'other' or 'shared'
+ * @access public
*/
- function mod_mailbox($mbox_name, $mode='in')
+ function mailbox_namespace($mailbox)
{
- if ($mbox_name == 'INBOX')
- return $mbox_name;
-
- if (!empty($this->root_dir)) {
- if ($mode=='in')
- $mbox_name = $this->root_dir.$this->delimiter.$mbox_name;
- else if (!empty($mbox_name)) // $mode=='out'
- $mbox_name = substr($mbox_name, strlen($this->root_dir)+1);
+ if ($mailbox == 'INBOX') {
+ return 'personal';
}
- return $mbox_name;
+ foreach ($this->namespace as $type => $namespace) {
+ if (is_array($namespace)) {
+ foreach ($namespace as $ns) {
+ if (strlen($ns[0])) {
+ if ((strlen($ns[0])>1 && $mailbox == substr($ns[0], 0, -1))
+ || strpos($mailbox, $ns[0]) === 0
+ ) {
+ return $type;
+ }
+ }
+ }
+ }
+ }
+
+ return 'personal';
+ }
+
+
+ /**
+ * Modify folder name according to namespace.
+ * For output it removes prefix of the personal namespace if it's possible.
+ * For input it adds the prefix. Use it before creating a folder in root
+ * of the folders tree.
+ *
+ * @param string $mailbox Folder name
+ * @param string $mode Mode name (out/in)
+ *
+ * @return string Folder name
+ */
+ function mod_mailbox($mailbox, $mode = 'out')
+ {
+ if (!strlen($mailbox)) {
+ return $mailbox;
+ }
+
+ $prefix = $this->namespace['prefix']; // see set_env()
+ $prefix_len = strlen($prefix);
+
+ if (!$prefix_len) {
+ return $mailbox;
+ }
+
+ // remove prefix for output
+ if ($mode == 'out') {
+ if (substr($mailbox, 0, $prefix_len) === $prefix) {
+ return substr($mailbox, $prefix_len);
+ }
+ }
+ // add prefix for input (e.g. folder creation)
+ else {
+ return $prefix . $mailbox;
+ }
+
+ return $mailbox;
+ }
+
+
+ /**
+ * Gets folder options from LIST response, e.g. \Noselect, \Noinferiors
+ *
+ * @param string $mailbox Folder name
+ * @param bool $force Set to True if options should be refreshed
+ * Options are available after LIST command only
+ *
+ * @return array Options list
+ */
+ function mailbox_options($mailbox, $force=false)
+ {
+ if ($mailbox == 'INBOX') {
+ return array();
+ }
+
+ if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mailbox])) {
+ if ($force) {
+ $this->conn->listMailboxes('', $mailbox);
+ }
+ else {
+ return array();
+ }
+ }
+
+ $opts = $this->conn->data['LIST'][$mailbox];
+
+ return is_array($opts) ? $opts : array();
+ }
+
+
+ /**
+ * 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;
}
@@ -3098,10 +3557,236 @@
$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));
+ }
+
+
+ /* -----------------------------------------
+ * ACL and METADATA/ANNOTATEMORE methods
+ * ----------------------------------------*/
+
+ /**
+ * Changes the ACL on the specified mailbox (SETACL)
+ *
+ * @param string $mailbox Mailbox name
+ * @param string $user User name
+ * @param string $acl ACL string
+ *
+ * @return boolean True on success, False on failure
+ *
+ * @access public
+ * @since 0.5-beta
+ */
+ function set_acl($mailbox, $user, $acl)
+ {
+ if ($this->get_capability('ACL'))
+ return $this->conn->setACL($mailbox, $user, $acl);
+
+ return false;
+ }
+
+
+ /**
+ * Removes any <identifier,rights> pair for the
+ * specified user from the ACL for the specified
+ * mailbox (DELETEACL)
+ *
+ * @param string $mailbox Mailbox name
+ * @param string $user User name
+ *
+ * @return boolean True on success, False on failure
+ *
+ * @access public
+ * @since 0.5-beta
+ */
+ function delete_acl($mailbox, $user)
+ {
+ if ($this->get_capability('ACL'))
+ return $this->conn->deleteACL($mailbox, $user);
+
+ return false;
+ }
+
+
+ /**
+ * Returns the access control list for mailbox (GETACL)
+ *
+ * @param string $mailbox Mailbox name
+ *
+ * @return array User-rights array on success, NULL on error
+ * @access public
+ * @since 0.5-beta
+ */
+ function get_acl($mailbox)
+ {
+ if ($this->get_capability('ACL'))
+ return $this->conn->getACL($mailbox);
+
+ return NULL;
+ }
+
+
+ /**
+ * Returns information about what rights can be granted to the
+ * user (identifier) in the ACL for the mailbox (LISTRIGHTS)
+ *
+ * @param string $mailbox Mailbox name
+ * @param string $user User name
+ *
+ * @return array List of user rights
+ * @access public
+ * @since 0.5-beta
+ */
+ function list_rights($mailbox, $user)
+ {
+ if ($this->get_capability('ACL'))
+ return $this->conn->listRights($mailbox, $user);
+
+ return NULL;
+ }
+
+
+ /**
+ * Returns the set of rights that the current user has to
+ * mailbox (MYRIGHTS)
+ *
+ * @param string $mailbox Mailbox name
+ *
+ * @return array MYRIGHTS response on success, NULL on error
+ * @access public
+ * @since 0.5-beta
+ */
+ function my_rights($mailbox)
+ {
+ if ($this->get_capability('ACL'))
+ return $this->conn->myRights($mailbox);
+
+ return NULL;
+ }
+
+
+ /**
+ * Sets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)
+ *
+ * @param string $mailbox Mailbox name (empty for server metadata)
+ * @param array $entries Entry-value array (use NULL value as NIL)
+ *
+ * @return boolean True on success, False on failure
+ * @access public
+ * @since 0.5-beta
+ */
+ function set_metadata($mailbox, $entries)
+ {
+ if ($this->get_capability('METADATA') ||
+ (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
+ ) {
+ return $this->conn->setMetadata($mailbox, $entries);
+ }
+ else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
+ foreach ((array)$entries as $entry => $value) {
+ list($ent, $attr) = $this->md2annotate($entry);
+ $entries[$entry] = array($ent, $attr, $value);
+ }
+ return $this->conn->setAnnotation($mailbox, $entries);
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Unsets IMAP metadata/annotations (SETMETADATA/SETANNOTATION)
+ *
+ * @param string $mailbox Mailbox name (empty for server metadata)
+ * @param array $entries Entry names array
+ *
+ * @return boolean True on success, False on failure
+ *
+ * @access public
+ * @since 0.5-beta
+ */
+ function delete_metadata($mailbox, $entries)
+ {
+ if ($this->get_capability('METADATA') ||
+ (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
+ ) {
+ return $this->conn->deleteMetadata($mailbox, $entries);
+ }
+ else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
+ foreach ((array)$entries as $idx => $entry) {
+ list($ent, $attr) = $this->md2annotate($entry);
+ $entries[$idx] = array($ent, $attr, NULL);
+ }
+ return $this->conn->setAnnotation($mailbox, $entries);
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Returns IMAP metadata/annotations (GETMETADATA/GETANNOTATION)
+ *
+ * @param string $mailbox Mailbox name (empty for server metadata)
+ * @param array $entries Entries
+ * @param array $options Command options (with MAXSIZE and DEPTH keys)
+ *
+ * @return array Metadata entry-value hash array on success, NULL on error
+ *
+ * @access public
+ * @since 0.5-beta
+ */
+ function get_metadata($mailbox, $entries, $options=array())
+ {
+ if ($this->get_capability('METADATA') ||
+ (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
+ ) {
+ return $this->conn->getMetadata($mailbox, $entries, $options);
+ }
+ else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) {
+ $queries = array();
+ $res = array();
+
+ // Convert entry names
+ foreach ((array)$entries as $entry) {
+ list($ent, $attr) = $this->md2annotate($entry);
+ $queries[$attr][] = $ent;
+ }
+
+ // @TODO: Honor MAXSIZE and DEPTH options
+ foreach ($queries as $attrib => $entry)
+ if ($result = $this->conn->getAnnotation($mailbox, $entry, $attrib))
+ $res = array_merge($res, $result);
+
+ return $res;
+ }
+
+ return NULL;
+ }
+
+
+ /**
+ * Converts the METADATA extension entry name into the correct
+ * entry-attrib names for older ANNOTATEMORE version.
+ *
+ * @param string $entry Entry name
+ *
+ * @return array Entry-attribute list, NULL if not supported (?)
+ */
+ private function md2annotate($entry)
+ {
+ if (substr($entry, 0, 7) == '/shared') {
+ return array(substr($entry, 7), 'value.shared');
+ }
+ else if (substr($entry, 0, 8) == '/private') {
+ return array(substr($entry, 8), 'value.priv');
+ }
+
+ // @TODO: log error
+ return NULL;
}
@@ -3110,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;
+ }
}
@@ -3133,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
@@ -3311,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);
@@ -3319,45 +3898,43 @@
$cache_count = count($cache_index);
// empty mailbox
- if (!$msg_count)
+ if (!$msg_count) {
return $cache_count ? -2 : 1;
+ }
- if ($cache_count==$msg_count) {
+ if ($cache_count == $msg_count) {
if ($this->skip_deleted) {
- $h_index = $this->conn->fetchHeaderIndex($mailbox, "1:*", 'UID', $this->skip_deleted);
-
- // Save index in internal cache, will be used when syncing the cache
- $this->icache['folder_index'] = $h_index;
-
- if (empty($h_index))
- return -2;
-
- if (sizeof($h_index) == $cache_count) {
- $cache_index = array_flip($cache_index);
- foreach ($h_index as $idx => $uid)
- unset($cache_index[$uid]);
-
- if (empty($cache_index))
- return 1;
- }
- return -2;
+ if (!empty($this->icache['all_undeleted_idx'])) {
+ $uids = rcube_imap_generic::uncompressMessageSet($this->icache['all_undeleted_idx']);
+ $uids = array_flip($uids);
+ foreach ($cache_index as $uid) {
+ unset($uids[$uid]);
+ }
+ }
+ else {
+ // get all undeleted messages excluding cached UIDs
+ $uids = $this->search_once($mailbox, 'ALL UNDELETED NOT UID '.
+ rcube_imap_generic::compressMessageSet($cache_index));
+ }
+ if (empty($uids)) {
+ return 1;
+ }
} else {
// get UID of the message with highest index
$uid = $this->_id2uid($msg_count, $mailbox);
$cache_uid = array_pop($cache_index);
// uids of highest message matches -> cache seems OK
- if ($cache_uid == $uid)
+ if ($cache_uid == $uid) {
return 1;
+ }
}
// cache is dirty
return -1;
}
+
// if cache count differs less than 10% report as dirty
- else if (abs($msg_count - $cache_count) < $msg_count/10)
- return -1;
- else
- return -2;
+ return (abs($msg_count - $cache_count) < $msg_count/10) ? -1 : -2;
}
@@ -3371,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
@@ -3416,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').
@@ -3450,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
@@ -3505,7 +4082,7 @@
}
// no further caching
- if (!$this->caching_enabled)
+ if (!$this->messages_caching)
return;
// known message id
@@ -3572,7 +4149,7 @@
*/
private function remove_message_cache($key, $ids, $idx=false)
{
- if (!$this->caching_enabled)
+ if (!$this->messages_caching)
return;
$this->db->query(
@@ -3594,7 +4171,7 @@
*/
private function clear_message_cache($key, $start_index=1)
{
- if (!$this->caching_enabled)
+ if (!$this->messages_caching)
return;
$this->db->query(
@@ -3613,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)) {
@@ -3647,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)
@@ -3679,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)
@@ -3731,10 +4308,7 @@
foreach ($a as $val) {
$j++;
$address = trim($val['address']);
- $name = trim($val['name']);
-
- if ($name && preg_match('/^[\'"]/', $name) && preg_match('/[\'"]$/', $name))
- $name = trim($name, '\'"');
+ $name = trim($val['name']);
if ($name && $address && $name != $address)
$string = sprintf('%s <%s>', preg_match("/$special_chars/", $name) ? '"'.addcslashes($name, '"').'"' : $name, $address);
@@ -3785,80 +4359,95 @@
*/
public static function decode_mime_string($input, $fallback=null)
{
- // Initialize variable
- $out = '';
+ if (!empty($fallback)) {
+ $default_charset = $fallback;
+ }
+ else {
+ $default_charset = rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1');
+ }
- // Iterate instead of recursing, this way if there are too many values we don't have stack overflows
// rfc: all line breaks or other characters not found
// in the Base64 Alphabet must be ignored by decoding software
// delete all blanks between MIME-lines, differently we can
// receive unnecessary blanks and broken utf-8 symbols
$input = preg_replace("/\?=\s+=\?/", '?==?', $input);
- // Check if there is stuff to decode
- if (strpos($input, '=?') !== false) {
- // Loop through the string to decode all occurences of =? ?= into the variable $out
- while(($pos = strpos($input, '=?')) !== false) {
+ // encoded-word regexp
+ $re = '/=\?([^?]+)\?([BbQq])\?([^?\n]*)\?=/';
+
+ // Find all RFC2047's encoded words
+ if (preg_match_all($re, $input, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER)) {
+ // Initialize variables
+ $tmp = array();
+ $out = '';
+ $start = 0;
+
+ foreach ($matches as $idx => $m) {
+ $pos = $m[0][1];
+ $charset = $m[1][0];
+ $encoding = $m[2][0];
+ $text = $m[3][0];
+ $length = strlen($m[0][0]);
+
// Append everything that is before the text to be decoded
- $out .= substr($input, 0, $pos);
+ if ($start != $pos) {
+ $substr = substr($input, $start, $pos-$start);
+ $out .= rcube_charset_convert($substr, $default_charset);
+ $start = $pos;
+ }
+ $start += $length;
- // Get the location of the text to decode
- $end_cs_pos = strpos($input, "?", $pos+2);
- $end_en_pos = strpos($input, "?", $end_cs_pos+1);
- $end_pos = strpos($input, "?=", $end_en_pos+1);
+ // Per RFC2047, each string part "MUST represent an integral number
+ // of characters . A multi-octet character may not be split across
+ // adjacent encoded-words." However, some mailers break this, so we
+ // try to handle characters spanned across parts anyway by iterating
+ // through and aggregating sequential encoded parts with the same
+ // character set and encoding, then perform the decoding on the
+ // aggregation as a whole.
- // Extract the encoded string
- $encstr = substr($input, $pos+2, ($end_pos-$pos-2));
- // Extract the remaining string
- $input = substr($input, $end_pos+2);
+ $tmp[] = $text;
+ if ($next_match = $matches[$idx+1]) {
+ if ($next_match[0][1] == $start
+ && $next_match[1][0] == $charset
+ && $next_match[2][0] == $encoding
+ ) {
+ continue;
+ }
+ }
- // Decode the string fragement
- $out .= rcube_imap::_decode_mime_string_part($encstr);
+ $count = count($tmp);
+ $text = '';
+
+ // Decode and join encoded-word's chunks
+ if ($encoding == 'B' || $encoding == 'b') {
+ // base64 must be decoded a segment at a time
+ for ($i=0; $i<$count; $i++)
+ $text .= base64_decode($tmp[$i]);
+ }
+ else { //if ($encoding == 'Q' || $encoding == 'q') {
+ // quoted printable can be combined and processed at once
+ for ($i=0; $i<$count; $i++)
+ $text .= $tmp[$i];
+
+ $text = str_replace('_', ' ', $text);
+ $text = quoted_printable_decode($text);
+ }
+
+ $out .= rcube_charset_convert($text, $charset);
+ $tmp = array();
}
- // Deocde the rest (if any)
- if (strlen($input) != 0)
- $out .= rcube_imap::decode_mime_string($input, $fallback);
+ // add the last part of the input string
+ if ($start != strlen($input)) {
+ $out .= rcube_charset_convert(substr($input, $start), $default_charset);
+ }
// return the results
return $out;
}
// no encoding information, use fallback
- return rcube_charset_convert($input,
- !empty($fallback) ? $fallback : rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1'));
- }
-
-
- /**
- * Decode a part of a mime-encoded string
- *
- * @param string $str String to decode
- * @return string Decoded string
- * @access private
- */
- private function _decode_mime_string_part($str)
- {
- $a = explode('?', $str);
- $count = count($a);
-
- // should be in format "charset?encoding?base64_string"
- if ($count >= 3) {
- for ($i=2; $i<$count; $i++)
- $rest .= $a[$i];
-
- if (($a[1]=='B') || ($a[1]=='b'))
- $rest = base64_decode($rest);
- else if (($a[1]=='Q') || ($a[1]=='q')) {
- $rest = str_replace('_', ' ', $rest);
- $rest = quoted_printable_decode($rest);
- }
-
- return rcube_charset_convert($rest, $a[0]);
- }
-
- // we dont' know what to do with this
- return $str;
+ return rcube_charset_convert($input, $default_charset);
}
@@ -3986,45 +4575,50 @@
/**
- * @param int $uid Message UID
- * @param string $mbox_name Mailbox name
+ * @param int $uid Message UID
+ * @param string $mailbox Mailbox name
* @return int Message (sequence) ID
* @access private
*/
- private function _uid2id($uid, $mbox_name=NULL)
+ private function _uid2id($uid, $mailbox=NULL)
{
- if (!$mbox_name)
- $mbox_name = $this->mailbox;
-
- if (!isset($this->uid_id_map[$mbox_name][$uid])) {
- if (!($id = $this->get_cache_uid2id($mbox_name.'.msg', $uid)))
- $id = $this->conn->UID2ID($mbox_name, $uid);
-
- $this->uid_id_map[$mbox_name][$uid] = $id;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
}
- return $this->uid_id_map[$mbox_name][$uid];
+ if (!isset($this->uid_id_map[$mailbox][$uid])) {
+ if (!($id = $this->get_cache_uid2id($mailbox.'.msg', $uid)))
+ $id = $this->conn->UID2ID($mailbox, $uid);
+
+ $this->uid_id_map[$mailbox][$uid] = $id;
+ }
+
+ return $this->uid_id_map[$mailbox][$uid];
}
/**
- * @param int $id Message (sequence) ID
- * @param string $mbox_name Mailbox name
+ * @param int $id Message (sequence) ID
+ * @param string $mailbox Mailbox name
+ *
* @return int Message UID
* @access private
*/
- private function _id2uid($id, $mbox_name=NULL)
+ private function _id2uid($id, $mailbox=null)
{
- if (!$mbox_name)
- $mbox_name = $this->mailbox;
+ if (!strlen($mailbox)) {
+ $mailbox = $this->mailbox;
+ }
- if ($uid = array_search($id, (array)$this->uid_id_map[$mbox_name]))
+ if ($uid = array_search($id, (array)$this->uid_id_map[$mailbox])) {
return $uid;
+ }
- if (!($uid = $this->get_cache_id2uid($mbox_name.'.msg', $id)))
- $uid = $this->conn->ID2UID($mbox_name, $id);
+ if (!($uid = $this->get_cache_id2uid($mailbox.'.msg', $id))) {
+ $uid = $this->conn->ID2UID($mailbox, $id);
+ }
- $this->uid_id_map[$mbox_name][$uid] = $id;
+ $this->uid_id_map[$mailbox][$uid] = $id;
return $uid;
}
@@ -4039,30 +4633,18 @@
$updated = false;
if (is_array($a_mboxes))
- foreach ($a_mboxes as $i => $mbox_name) {
- $mailbox = $this->mod_mailbox($mbox_name);
+ foreach ($a_mboxes as $i => $mailbox) {
$a_mboxes[$i] = $mailbox;
- if ($mode=='subscribe')
+ if ($mode == 'subscribe')
$updated = $this->conn->subscribe($mailbox);
- else if ($mode=='unsubscribe')
+ else if ($mode == 'unsubscribe')
$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;
@@ -4073,12 +4655,9 @@
* Increde/decrese messagecount for a specific mailbox
* @access private
*/
- private function _set_messagecount($mbox_name, $mode, $increment)
+ private function _set_messagecount($mailbox, $mode, $increment)
{
- $a_mailbox_cache = false;
- $mailbox = $mbox_name ? $mbox_name : $this->mailbox;
$mode = strtoupper($mode);
-
$a_mailbox_cache = $this->get_cache('messagecount');
if (!is_array($a_mailbox_cache[$mailbox]) || !isset($a_mailbox_cache[$mailbox][$mode]) || !is_numeric($increment))
@@ -4102,15 +4681,17 @@
* Remove messagecount of a specific mailbox from cache
* @access private
*/
- private function _clear_messagecount($mbox_name='')
+ private function _clear_messagecount($mailbox, $mode=null)
{
- $a_mailbox_cache = false;
- $mailbox = $mbox_name ? $mbox_name : $this->mailbox;
-
$a_mailbox_cache = $this->get_cache('messagecount');
if (is_array($a_mailbox_cache[$mailbox])) {
- unset($a_mailbox_cache[$mailbox]);
+ if ($mode) {
+ unset($a_mailbox_cache[$mailbox][$mode]);
+ }
+ else {
+ unset($a_mailbox_cache[$mailbox]);
+ }
$this->update_cache('messagecount', $a_mailbox_cache);
}
}
@@ -4146,31 +4727,137 @@
private function _parse_address_list($str, $decode=true)
{
// remove any newlines and carriage returns before
- $a = rcube_explode_quoted_string('[,;]', preg_replace( "/[\r\n]/", " ", $str));
+ $str = preg_replace('/\r?\n(\s|\t)?/', ' ', $str);
+
+ // extract list items, remove comments
+ $str = self::explode_header_string(',;', $str, true);
$result = array();
- foreach ($a as $key => $val) {
- $val = preg_replace("/([\"\w])</", "$1 <", $val);
- $sub_a = rcube_explode_quoted_string(' ', $decode ? $this->decode_header($val) : $val);
- $result[$key]['name'] = '';
+ foreach ($str as $key => $val) {
+ $name = '';
+ $address = '';
+ $val = trim($val);
- foreach ($sub_a as $k => $v) {
- // use angle brackets in regexp to not handle names with @ sign
- if (preg_match('/^<\S+@\S+>$/', $v))
- $result[$key]['address'] = trim($v, '<>');
- else
- $result[$key]['name'] .= (empty($result[$key]['name'])?'':' ').str_replace("\"",'',stripslashes($v));
+ if (preg_match('/(.*)<(\S+@\S+)>$/', $val, $m)) {
+ $address = $m[2];
+ $name = trim($m[1]);
+ }
+ else if (preg_match('/^(\S+@\S+)$/', $val, $m)) {
+ $address = $m[1];
+ $name = '';
+ }
+ else {
+ $name = $val;
}
-// if (empty($result[$key]['name']))
-// $result[$key]['name'] = $result[$key]['address'];
- if (empty($result[$key]['address']))
- $result[$key]['address'] = $result[$key]['name'];
+ // dequote and/or decode name
+ if ($name) {
+ if ($name[0] == '"') {
+ $name = substr($name, 1, -1);
+ $name = stripslashes($name);
+ }
+ if ($decode) {
+ $name = $this->decode_header($name);
+ }
+ }
+
+ if (!$address && $name) {
+ $address = $name;
+ }
+
+ if ($address) {
+ $result[$key] = array('name' => $name, 'address' => $address);
+ }
}
return $result;
}
+
+ /**
+ * Explodes header (e.g. address-list) string into array of strings
+ * using specified separator characters with proper handling
+ * of quoted-strings and comments (RFC2822)
+ *
+ * @param string $separator String containing separator characters
+ * @param string $str Header string
+ * @param bool $remove_comments Enable to remove comments
+ *
+ * @return array Header items
+ */
+ static function explode_header_string($separator, $str, $remove_comments=false)
+ {
+ $length = strlen($str);
+ $result = array();
+ $quoted = false;
+ $comment = 0;
+ $out = '';
+
+ for ($i=0; $i<$length; $i++) {
+ // we're inside a quoted string
+ if ($quoted) {
+ if ($str[$i] == '"') {
+ $quoted = false;
+ }
+ else if ($str[$i] == '\\') {
+ if ($comment <= 0) {
+ $out .= '\\';
+ }
+ $i++;
+ }
+ }
+ // we're inside a comment string
+ else if ($comment > 0) {
+ if ($str[$i] == ')') {
+ $comment--;
+ }
+ else if ($str[$i] == '(') {
+ $comment++;
+ }
+ else if ($str[$i] == '\\') {
+ $i++;
+ }
+ continue;
+ }
+ // separator, add to result array
+ else if (strpos($separator, $str[$i]) !== false) {
+ if ($out) {
+ $result[] = $out;
+ }
+ $out = '';
+ continue;
+ }
+ // start of quoted string
+ else if ($str[$i] == '"') {
+ $quoted = true;
+ }
+ // start of comment
+ else if ($remove_comments && $str[$i] == '(') {
+ $comment++;
+ }
+
+ if ($comment <= 0) {
+ $out .= $str[$i];
+ }
+ }
+
+ if ($out && $comment <= 0) {
+ $result[] = $out;
+ }
+
+ return $result;
+ }
+
+
+ /**
+ * This is our own debug handler for the IMAP connection
+ * @access public
+ */
+ public function debug_handler(&$imap, $message)
+ {
+ write_log('imap', $message);
+ }
+
} // end class rcube_imap
--
Gitblit v1.9.1