From 6c76c91951d259f59b2b7a42b8fe895dcc0ef21b Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Wed, 23 Aug 2006 17:36:37 -0400
Subject: [PATCH] Updated Polish, Portuguese, Latvian, Chinese and Japanese localization
---
program/include/rcube_imap.inc | 510 ++++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 419 insertions(+), 91 deletions(-)
diff --git a/program/include/rcube_imap.inc b/program/include/rcube_imap.inc
index 630d2fb..fe97a92 100644
--- a/program/include/rcube_imap.inc
+++ b/program/include/rcube_imap.inc
@@ -26,7 +26,6 @@
*/
require_once('lib/imap.inc');
require_once('lib/mime.inc');
-require_once('lib/utf7.inc');
/**
@@ -36,7 +35,7 @@
*
* @package RoundCube Webmail
* @author Thomas Bruederli <roundcube@gmail.com>
- * @version 1.30
+ * @version 1.31
* @link http://ilohamail.org
*/
class rcube_imap
@@ -52,7 +51,8 @@
var $sort_order = 'DESC';
var $delimiter = NULL;
var $caching_enabled = FALSE;
- var $default_folders = array('inbox', 'drafts', 'sent', 'junk', 'trash');
+ var $default_folders = array('INBOX');
+ var $default_folders_lc = array('inbox');
var $cache = array();
var $cache_keys = array();
var $cache_changes = array();
@@ -208,15 +208,16 @@
{
if (is_array($arr))
{
- $this->default_folders = array();
-
- // add mailbox names lower case
- foreach ($arr as $mbox_row)
- $this->default_folders[] = strtolower($mbox_row);
-
+ $this->default_folders = $arr;
+ $this->default_folders_lc = array();
+
// add inbox if not included
- if (!in_array('inbox', $this->default_folders))
- array_unshift($arr, 'inbox');
+ if (!in_array_nocase('INBOX', $this->default_folders))
+ array_unshift($this->default_folders, 'INBOX');
+
+ // create a second list with lower cased names
+ foreach ($this->default_folders as $mbox)
+ $this->default_folders_lc[] = strtolower($mbox);
}
}
@@ -333,6 +334,10 @@
$a_out[] = $name;
}
+ // INBOX should always be available
+ if (!in_array_nocase('INBOX', $a_out))
+ array_unshift($a_out, 'INBOX');
+
// sort mailboxes
$a_out = $this->_sort_mailbox_list($a_out);
@@ -361,20 +366,6 @@
if (!is_array($a_folders) || !sizeof($a_folders))
$a_folders = array();
-
- // create Default folders if they do not exist
- global $CONFIG;
- foreach ($CONFIG['default_imap_folders'] as $folder)
- {
- if (!in_array_nocase($folder, $a_folders))
- {
- $this->create_mailbox($folder, TRUE);
- $this->subscribe($folder);
- }
- }
-
- $a_folders = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox($root), $filter);
- $a_mailbox_cache = array();
// write mailboxlist to cache
$this->update_cache('mailboxes', $a_folders);
@@ -516,32 +507,33 @@
$a_msg_headers = $this->get_message_cache($cache_key, $start_msg, $start_msg+$this->page_size, $this->sort_field, $this->sort_order);
$headers_sorted = TRUE;
}
+ // cache is dirty, sync it
+ else if ($this->caching_enabled && $cache_status==-1 && !$recursive)
+ {
+ $this->sync_header_index($mailbox);
+ return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, TRUE);
+ }
else
{
- $sorter = new rcube_header_sorter();
-
// retrieve headers from IMAP
if ($this->get_capability('sort') && ($msg_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : '')))
- {
- $sorter->set_sequence_numbers($msg_index);
-
+ {
$msgs = $msg_index[$begin];
for ($i=$begin+1; $i < $end; $i++)
$msgs = $msgs.','.$msg_index[$i];
}
else
{
- $msgs = sprintf("%d:%d", $begin+1, $end);
+ $msgs = sprintf("%d:%d", $begin+1, $end);
+
+ $i = 0;
+ for ($msg_seqnum = $begin; $msg_seqnum <= $end; $msg_seqnum++)
+ $msg_index[$i++] = $msg_seqnum;
}
-
- // cache is dirty, sync it
- if ($this->caching_enabled && $cache_status==-1 && !$recursive)
- {
- $this->sync_header_index($mailbox);
- return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, TRUE);
- }
-
+ // use this class for message sorting
+ $sorter = new rcube_header_sorter();
+ $sorter->set_sequence_numbers($msg_index);
// fetch reuested headers from server
$a_msg_headers = array();
@@ -573,16 +565,6 @@
return array_values($a_msg_headers);
}
-
-
-
-
-
-function gethdrids($hdr)
-{
- return $hdr->uid . ',' . $hdr->id;
-}
-
@@ -727,7 +709,14 @@
}
- // return sorted array of message UIDs
+ /**
+ * Return sorted array of message UIDs
+ *
+ * @param string Mailbox to get index from
+ * @param string Sort column
+ * @param string Sort order [ASC, DESC]
+ * @return array Indexed array with message ids
+ */
function message_index($mbox_name='', $sort_field=NULL, $sort_order=NULL)
{
if ($sort_field!=NULL)
@@ -798,7 +787,6 @@
// message in cache at correct position
if ($cache_index[$id] == $uid)
{
-// console("$id / $uid: OK");
unset($cache_index[$id]);
continue;
}
@@ -806,20 +794,16 @@
// message in cache but in wrong position
if (in_array((string)$uid, $cache_index, TRUE))
{
-// console("$id / $uid: Moved");
unset($cache_index[$id]);
}
// other message at this position
if (isset($cache_index[$id]))
{
-// console("$id / $uid: Delete");
$this->remove_message_cache($cache_key, $id);
unset($cache_index[$id]);
}
-
-// console("$id / $uid: Add");
// fetch complete headers and add to cache
$headers = iil_C_FetchHeader($this->conn, $mailbox, $id);
@@ -844,13 +828,19 @@
* @return array search results as list of message ids
* @access public
*/
- function search($mbox_name='', $criteria='ALL', $str=NULL)
+ function search($mbox_name='', $criteria='ALL', $str=NULL, $charset=NULL)
{
$mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox;
if ($str && $criteria)
{
- $criteria = 'CHARSET UTF-8 '.$criteria.' "'.UTF7EncodeString($str).'"';
- return $this->_search_index($mailbox, $criteria);
+ $search = (!empty($charset) ? "CHARSET $charset " : '') . sprintf("%s {%d}\r\n%s", $criteria, strlen($str), $str);
+ $results = $this->_search_index($mailbox, $search);
+
+ // try search with ISO charset (should be supported by server)
+ if (empty($results) && !empty($charset) && $charset!='ISO-8859-1')
+ $results = $this->search($mbox_name, $criteria, rcube_charset_convert($str, $charset, 'ISO-8859-1'), 'ISO-8859-1');
+
+ return $results;
}
else
return $this->_search_index($mailbox, $criteria);
@@ -879,12 +869,21 @@
}
+ /**
+ * Return message headers object of a specific message
+ *
+ * @param int Message ID
+ * @param string Mailbox to read from
+ * @param boolean True if $id is the message UID
+ * @return object Message headers representation
+ */
function get_headers($id, $mbox_name=NULL, $is_uid=TRUE)
{
$mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox;
+ $uid = $is_uid ? $id : $this->_id2uid($id);
// get cached headers
- if ($is_uid && ($headers = $this->get_cached_message($mailbox.'.msg', $id)))
+ if ($uid && ($headers = $this->get_cached_message($mailbox.'.msg', $uid)))
return $headers;
$msg_id = $is_uid ? $this->_uid2id($id) : $id;
@@ -898,25 +897,246 @@
}
- function get_body($uid, $part=1)
+ /**
+ * Fetch body structure from the IMAP server and build
+ * an object structure similar to the one generated by PEAR::Mail_mimeDecode
+ *
+ * @param Int Message UID to fetch
+ * @return object Standard object tree or False on failure
+ */
+ function &get_structure($uid)
{
if (!($msg_id = $this->_uid2id($uid)))
return FALSE;
$structure_str = iil_C_FetchStructureString($this->conn, $this->mailbox, $msg_id);
$structure = iml_GetRawStructureArray($structure_str);
- $body = iil_C_FetchPartBody($this->conn, $this->mailbox, $msg_id, $part);
+ $struct = false;
+
+ // parse structure and add headers
+ if (!empty($structure))
+ {
+ $this->_msg_id = $msg_id;
+ $headers = $this->get_headers($msg_id, NULL, FALSE);
+
+ $struct = &$this->_structure_part($structure);
+ $struct->headers = get_object_vars($headers);
+
+ // don't trust given content-type
+ if (empty($struct->parts))
+ {
+ $struct->mime_id = '1';
+ $struct->mimetype = strtolower($struct->headers['ctype']);
+ list($struct->ctype_primary, $struct->ctype_secondary) = explode('/', $struct->mimetype);
+ }
+ }
+
+ return $struct;
+ }
- $encoding = iml_GetPartEncodingCode($structure, $part);
+
+ /**
+ * Build message part object
+ *
+ * @access private
+ */
+ function &_structure_part($part, $count=0, $parent='')
+ {
+ $struct = new rcube_message_part;
+ $struct->mime_id = empty($parent) ? (string)$count : "$parent.$count";
- if ($encoding==3) $body = $this->mime_decode($body, 'base64');
- else if ($encoding==4) $body = $this->mime_decode($body, 'quoted-printable');
+ // multipart
+ if (is_array($part[0]))
+ {
+ $struct->ctype_primary = 'multipart';
+
+ // find first non-array entry
+ for ($i=1; count($part); $i++)
+ if (!is_array($part[$i]))
+ {
+ $struct->ctype_secondary = strtolower($part[$i]);
+ break;
+ }
+
+ $struct->mimetype = 'multipart/'.$struct->ctype_secondary;
+
+ $struct->parts = array();
+ for ($i=0, $count=0; $i<count($part); $i++)
+ if (is_array($part[$i]) && count($part[$i]) > 5)
+ $struct->parts[] = $this->_structure_part($part[$i], ++$count, $struct->mime_id);
+
+ return $struct;
+ }
+
+
+ // regular part
+ $struct->ctype_primary = strtolower($part[0]);
+ $struct->ctype_secondary = strtolower($part[1]);
+ $struct->mimetype = $struct->ctype_primary.'/'.$struct->ctype_secondary;
+
+ // read content type parameters
+ if (is_array($part[2]))
+ {
+ $struct->ctype_parameters = array();
+ for ($i=0; $i<count($part[2]); $i+=2)
+ $struct->ctype_parameters[strtolower($part[2][$i])] = $part[2][$i+1];
+
+ if (isset($struct->ctype_parameters['charset']))
+ $struct->charset = $struct->ctype_parameters['charset'];
+ }
+
+ // read content encoding
+ if (!empty($part[5]) && $part[5]!='NIL')
+ {
+ $struct->encoding = strtolower($part[5]);
+ $struct->headers['content-transfer-encoding'] = $struct->encoding;
+ }
+
+ // get part size
+ if (!empty($part[6]) && $part[6]!='NIL')
+ $struct->size = intval($part[6]);
+
+ // read part disposition
+ $di = count($part) - 3;
+ if (is_array($part[$di]))
+ {
+ $struct->disposition = strtolower($part[$di][0]);
+
+ if (is_array($part[$di][1]))
+ for ($n=0; $n<count($part[$di][1]); $n+=2)
+ $struct->d_parameters[strtolower($part[$di][1][$n])] = $part[$di][1][$n+1];
+ }
+
+ // get child parts
+ if (is_array($part[8]) && $di != 8)
+ {
+ $struct->parts = array();
+ for ($i=0, $count=0; $i<count($part[8]); $i++)
+ if (is_array($part[8][$i]) && count($part[8][$i]) > 5)
+ $struct->parts[] = $this->_structure_part($part[8][$i], ++$count, $struct->mime_id);
+ }
+
+ // get part ID
+ if (!empty($part[3]) && $part[3]!='NIL')
+ {
+ $struct->content_id = $part[3];
+ $struct->headers['content-id'] = $part[3];
+
+ if (empty($struct->disposition))
+ $struct->disposition = 'inline';
+ }
+
+ // fetch message headers if message/rfc822
+ if ($struct->ctype_primary=='message')
+ {
+ $headers = iil_C_FetchPartBody($this->conn, $this->mailbox, $this->_msg_id, $struct->mime_id.'.HEADER');
+ $struct->headers = $this->_parse_headers($headers);
+ }
+
+ return $struct;
+ }
+
+
+ /**
+ * Return a flat array with references to all parts, indexed by part numbmers
+ *
+ * @param object Message body structure
+ * @return Array with part number -> object pairs
+ */
+ function get_mime_numbers(&$structure)
+ {
+ $a_parts = array();
+ $this->_get_part_numbers($structure, $a_parts);
+ return $a_parts;
+ }
+
+
+ /**
+ * Helper method for recursive calls
+ *
+ * @access
+ */
+ function _get_part_numbers(&$part, &$a_parts)
+ {
+ if ($part->mime_id)
+ $a_parts[$part->mime_id] = &$part;
+
+ if (is_array($part->parts))
+ for ($i=0; $i<count($part->parts); $i++)
+ $this->_get_part_numbers($part->parts[$i], $a_parts);
+ }
+
+
+ /**
+ * Fetch message body of a specific message from the server
+ *
+ * @param int Message UID
+ * @param string Part number
+ * @param object Part object created by get_structure()
+ * @param mixed True to print part, ressource to write part contents in
+ * @return Message/part body if not printed
+ */
+ function &get_message_part($uid, $part=1, $o_part=NULL, $print=NULL)
+ {
+ if (!($msg_id = $this->_uid2id($uid)))
+ return FALSE;
+
+ // get part encoding if not provided
+ if (!is_object($o_part))
+ {
+ $structure_str = iil_C_FetchStructureString($this->conn, $this->mailbox, $msg_id);
+ $structure = iml_GetRawStructureArray($structure_str);
+ $part_type = iml_GetPartTypeCode($structure, $part);
+ $o_part = new rcube_message_part;
+ $o_part->ctype_primary = $part_type==0 ? 'text' : ($part_type==2 ? 'message' : 'other');
+ $o_part->encoding = strtolower(iml_GetPartEncodingString($structure, $part));
+ $o_part->charset = iml_GetPartCharset($structure, $part);
+ }
+
+ // TODO: Add caching for message parts
+
+ if ($print)
+ {
+ iil_C_HandlePartBody($this->conn, $this->mailbox, $msg_id, $part, ($o_part->encoding=='base64'?3:2));
+ $body = TRUE;
+ }
+ else
+ {
+ $body = iil_C_HandlePartBody($this->conn, $this->mailbox, $msg_id, $part, 1);
+
+ // decode part body
+ if ($o_part->encoding=='base64' || $o_part->encoding=='quoted-printable')
+ $body = $this->mime_decode($body, $o_part->encoding);
+
+ // convert charset (if text or message part)
+ if (!empty($o_part->charset) && ($o_part->ctype_primary=='text' || $o_part->ctype_primary=='message') && !stristr($body, 'charset='))
+ $body = rcube_charset_convert($body, $o_part->charset);
+ }
return $body;
}
- function get_raw_body($uid)
+ /**
+ * Fetch message body of a specific message from the server
+ *
+ * @param int Message UID
+ * @return Message/part body
+ * @see ::get_message_part()
+ */
+ function &get_body($uid, $part=1)
+ {
+ return $this->get_message_part($uid, $part);
+ }
+
+
+ /**
+ * Returns the whole message source as string
+ *
+ * @param int Message UID
+ * @return Message source string
+ */
+ function &get_raw_body($uid)
{
if (!($msg_id = $this->_uid2id($uid)))
return FALSE;
@@ -926,10 +1146,31 @@
return $body;
}
+
+
+ /**
+ * Sends the whole message source to stdout
+ *
+ * @param int Message UID
+ */
+ function print_raw_body($uid)
+ {
+ if (!($msg_id = $this->_uid2id($uid)))
+ return FALSE;
+
+ print iil_C_FetchPartHeader($this->conn, $this->mailbox, $msg_id, NULL);
+ flush();
+ iil_C_HandlePartBody($this->conn, $this->mailbox, $msg_id, NULL, 2);
+ }
- // set message flag to one or several messages
- // possible flags are: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT
+ /**
+ * Set message flag to one or several messages
+ *
+ * @param mixed Message UIDs as array or as comma-separated string
+ * @param string Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT
+ * @return True on success, False on failure
+ */
function set_flag($uids, $flag)
{
$flag = strtoupper($flag);
@@ -1164,7 +1405,12 @@
* --------------------------------*/
- // return an array with all folders available in IMAP server
+ /**
+ * Get a list of all folders available on the IMAP server
+ *
+ * @param string IMAP root dir
+ * @return array Inbdexed array with folder names
+ */
function list_unsubscribed($root='')
{
static $sa_unsubscribed;
@@ -1206,7 +1452,9 @@
}
- // subscribe to a specific mailbox(es)
+ /**
+ * subscribe to a specific mailbox(es)
+ */
function subscribe($mbox_name, $mode='subscribe')
{
if (is_array($mbox_name))
@@ -1219,7 +1467,9 @@
}
- // unsubscribe mailboxes
+ /**
+ * unsubscribe mailboxes
+ */
function unsubscribe($mbox_name)
{
if (is_array($mbox_name))
@@ -1232,7 +1482,13 @@
}
- // create a new mailbox on the server and register it in local cache
+ /**
+ * Create a new mailbox on the server and register it in local cache
+ *
+ * @param string New mailbox name (as utf-7 string)
+ * @param boolean True if the new mailbox should be subscribed
+ * @param string Name of the created mailbox, false on error
+ */
function create_mailbox($name, $subscribe=FALSE)
{
$result = FALSE;
@@ -1240,26 +1496,30 @@
// replace backslashes
$name = preg_replace('/[\\\]+/', '-', $name);
- $name_enc = UTF7EncodeString($name);
-
// reduce mailbox name to 100 chars
- $name_enc = substr($name_enc, 0, 100);
+ $name = substr($name, 0, 100);
- $abs_name = $this->_mod_mailbox($name_enc);
+ $abs_name = $this->_mod_mailbox($name);
$a_mailbox_cache = $this->get_cache('mailboxes');
-
- if (strlen($abs_name) && (!is_array($a_mailbox_cache) || !in_array($abs_name, $a_mailbox_cache)))
+
+ if (strlen($abs_name) && (!is_array($a_mailbox_cache) || !in_array_nocase($abs_name, $a_mailbox_cache)))
$result = iil_C_CreateFolder($this->conn, $abs_name);
- // update mailboxlist cache
- if ($result && $subscribe)
- $this->subscribe($name_enc);
+ // try to subscribe it
+ if ($subscribe)
+ $this->subscribe($name);
return $result ? $name : FALSE;
}
- // set a new name to an existing mailbox
+ /**
+ * Set a new name to an existing mailbox
+ *
+ * @param string Mailbox to rename (as utf-7 string)
+ * @param string New mailbox name (as utf-7 string)
+ * @param string Name of the renames mailbox, false on error
+ */
function rename_mailbox($mbox_name, $new_name)
{
$result = FALSE;
@@ -1268,27 +1528,32 @@
$name = preg_replace('/[\\\]+/', '-', $new_name);
// encode mailbox name and reduce it to 100 chars
- $name_enc = substr(UTF7EncodeString($new_name), 0, 100);
+ $name = substr($new_name, 0, 100);
// make absolute path
$mailbox = $this->_mod_mailbox($mbox_name);
- $abs_name = $this->_mod_mailbox($name_enc);
-
+ $abs_name = $this->_mod_mailbox($name);
+
if (strlen($abs_name))
$result = iil_C_RenameFolder($this->conn, $mailbox, $abs_name);
-
+
// clear cache
if ($result)
{
$this->clear_message_cache($mailbox.'.msg');
$this->clear_cache('mailboxes');
}
+
+ // try to subscribe it
+ $this->subscribe($name);
return $result ? $name : FALSE;
}
- // remove mailboxes from server
+ /**
+ * remove mailboxes from server
+ */
function delete_mailbox($mbox_name)
{
$deleted = FALSE;
@@ -1305,7 +1570,7 @@
// unsubscribe mailbox before deleting
iil_C_UnSubscribe($this->conn, $mailbox);
-
+
// send delete command to server
$result = iil_C_DeleteFolder($this->conn, $mailbox);
if ($result>=0)
@@ -1322,6 +1587,28 @@
return $deleted;
}
+
+ /**
+ * Create all folders specified as default
+ */
+ function create_default_folders()
+ {
+ $a_folders = iil_C_ListMailboxes($this->conn, $this->_mod_mailbox(''), '*');
+ $a_subscribed = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox(''), '*');
+
+ // create default folders if they do not exist
+ foreach ($this->default_folders as $folder)
+ {
+ $abs_name = $this->_mod_mailbox($folder);
+ if (!in_array_nocase($abs_name, $a_subscribed))
+ {
+ if (!in_array_nocase($abs_name, $a_folders))
+ $this->create_mailbox($folder, TRUE);
+ else
+ $this->subscribe($folder);
+ }
+ }
+ }
@@ -1555,7 +1842,7 @@
}
- function get_cached_message($key, $uid, $body=FALSE)
+ function &get_cached_message($key, $uid, $body=FALSE)
{
if (!$this->caching_enabled)
return FALSE;
@@ -1839,7 +2126,7 @@
function _mod_mailbox($mbox_name, $mode='in')
{
- if ((!empty($this->root_ns) && $this->root_ns == $mbox_name) || ($mbox_name == 'INBOX' && $mode == 'in'))
+ if ((!empty($this->root_ns) && $this->root_ns == $mbox_name) || $mbox_name == 'INBOX')
return $mbox_name;
if (!empty($this->root_dir) && $mode=='in')
@@ -1861,8 +2148,8 @@
{
if ($folder{0}=='.')
continue;
-
- if (($p = array_search(strtolower($folder), $this->default_folders))!==FALSE)
+
+ if (($p = array_search(strtolower($folder), $this->default_folders_lc))!==FALSE)
$a_defaults[$p] = $folder;
else
$a_out[] = $folder;
@@ -2014,6 +2301,27 @@
}
+ // split RFC822 header string into an associative array
+ function _parse_headers($headers)
+ {
+ $a_headers = array();
+ $lines = explode("\n", $headers);
+ $c = count($lines);
+ for ($i=0; $i<$c; $i++)
+ {
+ if ($p = strpos($lines[$i], ': '))
+ {
+ $field = strtolower(substr($lines[$i], 0, $p));
+ $value = trim(substr($lines[$i], $p+1));
+ if (!empty($value))
+ $a_headers[$field] = $value;
+ }
+ }
+
+ return $a_headers;
+ }
+
+
function _parse_address_list($str)
{
$a = $this->_explode_quoted_string(',', $str);
@@ -2058,6 +2366,25 @@
}
}
+
+/**
+ * Class representing a message part
+ */
+class rcube_message_part
+{
+ var $mime_id = '';
+ var $ctype_primary = 'text';
+ var $ctype_secondary = 'plain';
+ var $mimetype = 'text/plain';
+ var $disposition = '';
+ var $encoding = '8bit';
+ var $charset = '';
+ var $size = 0;
+ var $headers = array();
+ var $d_parameters = array();
+ var $ctype_parameters = array();
+
+}
/**
@@ -2199,4 +2526,5 @@
return trim($output);
}
+
?>
--
Gitblit v1.9.1