thomascube
2007-03-23 28bfe4dc80a1431655666cfb3cec30f89e3459c7
program/include/rcube_imap.inc
@@ -5,7 +5,7 @@
 | program/include/rcube_imap.inc                                        |
 |                                                                       |
 | This file is part of the RoundCube Webmail client                     |
 | Copyright (C) 2005, RoundCube Dev. - Switzerland                      |
 | Copyright (C) 2005-2006, RoundCube Dev. - Switzerland                 |
 | Licensed under the GNU GPL                                            |
 |                                                                       |
 | PURPOSE:                                                              |
@@ -35,7 +35,7 @@
 *
 * @package    RoundCube Webmail
 * @author     Thomas Bruederli <roundcube@gmail.com>
 * @version    1.34
 * @version    1.36
 * @link       http://ilohamail.org
 */
class rcube_imap
@@ -60,6 +60,10 @@
  var $msg_headers = array();
  var $capabilities = array();
  var $skip_deleted = FALSE;
  var $search_set = NULL;
  var $search_subject = '';
  var $search_string = '';
  var $search_charset = '';
  var $debug_level = 1;
@@ -265,6 +269,36 @@
    {
    $this->page_size = (int)$size;
    }
  /**
   * Save a set of message ids for future message listing methods
   *
   * @param  array  List of IMAP fields to search in
   * @param  string Search string
   * @param  array  List of message ids or NULL if empty
   */
  function set_search_set($subject, $str=null, $msgs=null, $charset=null)
    {
    if (is_array($subject) && $str == null && $msgs == null)
      list($subject, $str, $msgs, $charset) = $subject;
    if ($msgs != null && !is_array($msgs))
      $msgs = split(',', $msgs);
    $this->search_subject = $subject;
    $this->search_string = $str;
    $this->search_set = is_array($msgs) ? $msgs : NULL;
    $this->search_charset = $charset;
    }
  /**
   * Return the saved search set as hash array
   */
  function get_search_set()
    {
    return array($this->search_subject, $this->search_string, $this->search_set, $this->search_charset);
    }
  /**
@@ -402,6 +436,10 @@
    if (empty($mailbox))
      $mailbox = $this->mailbox;
    // count search set
    if ($this->search_set && $mailbox == $this->mailbox && $mode == 'ALL')
      return count($this->search_set);
    $a_mailbox_cache = $this->get_cache('messagecount');
    
@@ -481,7 +519,11 @@
    {
    if (!strlen($mailbox))
      return array();
    // use saved message set
    if ($this->search_set && $mailbox == $this->mailbox)
      return $this->_list_header_set($mailbox, $this->search_set, $page, $sort_field, $sort_order);
    if ($sort_field!=NULL)
      $this->sort_field = $sort_field;
    if ($sort_order!=NULL)
@@ -492,10 +534,10 @@
    list($begin, $end) = $this->_get_message_range($max, $page);
     // mailbox is empty
    // mailbox is empty
    if ($begin >= $end)
      return array();
    $headers_sorted = FALSE;
    $cache_key = $mailbox.'.msg';
    $cache_status = $this->check_cache_status($mailbox, $cache_key);
@@ -538,8 +580,9 @@
      $a_msg_headers = array();
      $deleted_count = $this->_fetch_headers($mailbox, $msgs, $a_msg_headers, $cache_key);
      // delete cached messages with a higher index than $max
      $this->clear_message_cache($cache_key, $max);
      // delete cached messages with a higher index than $max+1
      // Changed $max to $max+1 to fix this bug : #1484295
      $this->clear_message_cache($cache_key, $max + 1);
      // kick child process to sync cache
@@ -614,14 +657,14 @@
    $this->_fetch_headers($mailbox, join(',', $msgs), $a_msg_headers, NULL);
    // return empty array if no messages found
   if (!is_array($a_msg_headers) || empty($a_msg_headers))
      return array();
    if (!is_array($a_msg_headers) || empty($a_msg_headers))
      return array();
    // if not already sorted
    $a_msg_headers = iil_SortHeaders($a_msg_headers, $this->sort_field, $this->sort_order);
   // only return the requested part of the set
   return array_slice(array_values($a_msg_headers), $start_msg, min($max-$start_msg, $this->page_size));
    // only return the requested part of the set
    return array_slice(array_values($a_msg_headers), $start_msg, min($max-$start_msg, $this->page_size));
    }
@@ -830,7 +873,20 @@
  function search($mbox_name='', $criteria='ALL', $str=NULL, $charset=NULL)
    {
    $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox;
    if ($str && $criteria)
    // have an array of criterias => execute multiple searches
    if (is_array($criteria) && $str)
      {
      $results = array();
      foreach ($criteria as $crit)
        if ($search_result = $this->search($mbox_name, $crit, $str, $charset))
          $results = array_merge($results, $search_result);
      $results = array_unique($results);
      $this->set_search_set($criteria, $str, $results, $charset);
      return $results;
      }
    else if ($str && $criteria)
      {
      $search = (!empty($charset) ? "CHARSET $charset " : '') . sprintf("%s {%d}\r\n%s", $criteria, strlen($str), $str);
      $results = $this->_search_index($mailbox, $search);
@@ -839,6 +895,7 @@
      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');
      
      $this->set_search_set($criteria, $str, $results, $charset);
      return $results;
      }
    else
@@ -865,6 +922,18 @@
      }
        
    return $a_messages;
    }
  /**
   * Refresh saved search set
   */
  function refresh_search()
    {
    if (!empty($this->search_subject) && !empty($this->search_string))
      $this->search_set = $this->search('', $this->search_subject, $this->search_string, $this->search_charset);
    return $this->get_search_set();
    }
@@ -920,10 +989,10 @@
    if (!($msg_id = $this->_uid2id($uid)))
      return FALSE;
   $structure_str = iil_C_FetchStructureString($this->conn, $this->mailbox, $msg_id);
   $structure = iml_GetRawStructureArray($structure_str);
   $struct = false;
    $structure_str = iil_C_FetchStructureString($this->conn, $this->mailbox, $msg_id);
    $structure = iml_GetRawStructureArray($structure_str);
    $struct = false;
    // parse structure and add headers
    if (!empty($structure))
      {
@@ -945,9 +1014,9 @@
      if ($this->caching_enabled)
        $this->add_message_cache($cache_key, $msg_id, $headers, $struct);
      }
   return $struct;
   }
    return $struct;
    }
  
  /**
@@ -979,8 +1048,8 @@
      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;
      return $struct;
      }
    
    
@@ -988,30 +1057,30 @@
    $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();
    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 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
    // read part disposition
    $di = count($part) - 2;
    if ((is_array($part[$di]) && count($part[$di]) == 2 && is_array($part[$di][1])) ||
        (is_array($part[--$di]) && count($part[$di]) == 2))
@@ -1031,30 +1100,41 @@
        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';
     }
    // 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);
      if (is_array($part[8]) && empty($struct->parts))
        $struct->parts[] = $this->_structure_part($part[8], ++$count, $struct->mime_id);
      }
     return $struct;
    // normalize filename property
    if (!empty($struct->d_parameters['filename']))
      $struct->filename = $this->decode_mime_string($struct->d_parameters['filename']);
    else if (!empty($struct->ctype_parameters['name']))
      $struct->filename = $this->decode_mime_string($struct->ctype_parameters['name']);
    else if (!empty($struct->headers['content-description']))
      $struct->filename = $this->decode_mime_string($struct->headers['content-description']);
    return $struct;
    }
    
  
  /**
   * Return a flat array with references to all parts, indexed by part numbmers
   * Return a flat array with references to all parts, indexed by part numbers
   *
   * @param object Message body structure
   * @return Array with part number -> object pairs
@@ -1303,6 +1383,10 @@
      $this->_clear_messagecount($from_mbox);
      $this->_clear_messagecount($to_mbox);
      }
    // remove message ids from search set
    if ($moved && $this->search_set && $from_mbox == $this->mailbox)
      $this->search_set = array_diff($this->search_set, $a_mids);
    // update cached message headers
    $cache_key = $from_mbox.'.msg';
@@ -1311,8 +1395,8 @@
      $start_index = 100000;
      foreach ($a_uids as $uid)
        {
        if(($index = array_search($uid, $a_cache_index)) !== FALSE)
     $start_index = min($index, $start_index);
        if (($index = array_search($uid, $a_cache_index)) !== FALSE)
          $start_index = min($index, $start_index);
        }
      // clear cache from the lowest index on
@@ -1352,6 +1436,10 @@
      $this->_clear_messagecount($mailbox);
      }
    // remove message ids from search set
    if ($moved && $this->search_set && $mailbox == $this->mailbox)
      $this->search_set = array_diff($this->search_set, $a_mids);
    // remove deleted messages from cache
    $cache_key = $mailbox.'.msg';
    if ($deleted && ($a_cache_index = $this->get_message_cache_index($cache_key)))
@@ -1359,8 +1447,8 @@
      $start_index = 100000;
      foreach ($a_uids as $uid)
        {
        $index = array_search($uid, $a_cache_index);
        $start_index = min($index, $start_index);
        if (($index = array_search($uid, $a_cache_index)) !== FALSE)
          $start_index = min($index, $start_index);
        }
      // clear cache from the lowest index on
@@ -2030,7 +2118,12 @@
      $j++;
      $address = $val['address'];
      $name = preg_replace(array('/^[\'"]/', '/[\'"]$/'), '', trim($val['name']));
      $string = $name!==$address ? sprintf('%s <%s>', strpos($name, ',')!==FALSE ? '"'.$name.'"' : $name, $address) : $address;
      if ($name && $address && $name != $address)
        $string = sprintf('%s <%s>', strpos($name, ',')!==FALSE ? '"'.$name.'"' : $name, $address);
      else if ($address)
        $string = $address;
      else if ($name)
        $string = $name;
      
      $out[$j] = array('name' => $name,
                       'mailto' => $address,
@@ -2179,7 +2272,7 @@
  function _mod_mailbox($mbox_name, $mode='in')
    {
    if ((!empty($this->root_ns) && $this->root_ns == $mbox_name) || $mbox_name == 'INBOX')
    if (empty($mbox_name) || (!empty($this->root_ns) && $this->root_ns == $mbox_name) || $mbox_name == 'INBOX')
      return $mbox_name;
    if (!empty($this->root_dir) && $mode=='in') 
@@ -2216,12 +2309,12 @@
  function get_id($uid, $mbox_name=NULL) 
    {
      return $this->_uid2id($uid, $mbox_name);
      return $this->_uid2id($uid, $this->_mod_mailbox($mbox_name));
    }
  
  function get_uid($id,$mbox_name=NULL)
    {
      return $this->_id2uid($id, $mbox_name);
      return $this->_id2uid($id, $this->_mod_mailbox($mbox_name));
    }
  function _uid2id($uid, $mbox_name=NULL)
@@ -2377,18 +2470,19 @@
  function _parse_address_list($str)
    {
    $a = $this->_explode_quoted_string(',', $str);
    // remove any newlines and carriage returns before
    $a = $this->_explode_quoted_string('[,;]', preg_replace( "/[\r\n]/", " ", $str));
    $result = array();
    
    foreach ($a as $key => $val)
      {
      $val = str_replace("\"<", "\" <", $val);
      $val = preg_replace("/([\"\w])</", "$1 <", $val);
      $sub_a = $this->_explode_quoted_string(' ', $this->decode_header($val));
      $result[$key]['name'] = '';
      foreach ($sub_a as $k => $v)
        {
        if ((strpos($v, '@') > 0) && (strpos($v, '.') > 0))
        if (strpos($v, '@') > 0)
          $result[$key]['address'] = str_replace('<', '', str_replace('>', '', $v));
        else
          $result[$key]['name'] .= (empty($result[$key]['name'])?'':' ').str_replace("\"",'',stripslashes($v));
@@ -2404,17 +2498,20 @@
  function _explode_quoted_string($delimiter, $string)
    {
    $quotes = explode("\"", $string);
    foreach ($quotes as $key => $val)
      if (($key % 2) == 1)
        $quotes[$key] = str_replace($delimiter, "_!@!_", $quotes[$key]);
    $string = implode("\"", $quotes);
    $result = explode($delimiter, $string);
    foreach ($result as $key => $val)
      $result[$key] = str_replace("_!@!_", $delimiter, $result[$key]);
    $result = array();
    $strlen = strlen($string);
    for ($q=$p=$i=0; $i < $strlen; $i++)
    {
      if ($string{$i} == "\"" && $string{$i-1} != "\\")
        $q = $q ? false : true;
      else if (!$q && preg_match("/$delimiter/", $string{$i}))
      {
        $result[] = substr($string, $p, $i - $p);
        $p = $i + 1;
      }
    }
    
    $result[] = substr($string, $p);
    return $result;
    }
  }
@@ -2430,6 +2527,7 @@
  var $ctype_secondary = 'plain';
  var $mimetype = 'text/plain';
  var $disposition = '';
  var $filename = '';
  var $encoding = '8bit';
  var $charset = '';
  var $size = 0;