functions/imap_messages.php

   1 <?php
   2
   3 /**
   4  * imap_messages.php
   5  *
   6  * This implements functions that manipulate messages
   7  * NOTE: Quite a few functions in this file are obsolete
   8  *
   9  * @copyright &copy; 1999-2007 The SquirrelMail Project Team
  10  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  11  * @version $Id$
  12  * @package squirrelmail
  13  * @subpackage imap
  14  */
  15
  16
  17 /**
  18  * Copy a set of messages ($id) to another mailbox ($mailbox)
  19  * @param int $imap_stream The resource ID for the IMAP socket
  20  * @param string $id The list of messages to copy
  21  * @param string $mailbox The destination to copy to
  22  * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
  23  * @return bool If the copy completed without errors
  24  */
  25 function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = true) {
  26     $msgs_id = sqimap_message_list_squisher($id);
  27     $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), $handle_errors, $response, $message, TRUE);
  28     if ($response == 'OK') {
  29         return true;
  30     } else {
  31         return false;
  32     }
  33 }
  34
  35
  36 /**
  37  * Move a set of messages ($id) to another mailbox. Deletes the originals.
  38  * @param int $imap_stream The resource ID for the IMAP socket
  39  * @param string $id The list of messages to move
  40  * @param string $mailbox The destination to move to
  41  * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response
  42  * @param string $source_mailbox (since 1.5.1) name of source mailbox. It is used to
  43  *  validate that target mailbox != source mailbox.
  44  * @return bool If the move completed without errors
  45  */
  46 function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = true, $source_mailbox = false) {
  47     if ($source_mailbox!==false && $source_mailbox==$mailbox) {
  48         return false;
  49     }
  50     $msgs_id = sqimap_message_list_squisher($id);
  51     if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) {
  52         return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
  53     } else {
  54         return false;
  55     }
  56 }
  57
  58
  59 /**
  60  * Deletes a message and move it to trash or expunge the mailbox
  61  * @param  resource imap connection
  62  * @param  string $mailbox mailbox, used for checking if it concerns the trash_folder
  63  * @param  array $id list with uid's
  64  * @param  bool   $bypass_trash (since 1.5.0) skip copy to trash
  65  * @return array  $aMessageList array with messages containing the new flags and UID @see parseFetch
  66  * @since 1.4.0
  67  */
  68 function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) {
  69     // FIX ME, remove globals by introducing an associative array with properties
  70     // as 4th argument as replacement for the bypass_trash var
  71     global $move_to_trash, $trash_folder;
  72     if (($move_to_trash == true) && ($bypass_trash != true) &&
  73         (sqimap_mailbox_exists($imap_stream, $trash_folder) &&  ($mailbox != $trash_folder)) ) {
  74         /**
  75          * turn off internal error handling (fourth argument = false) and
  76          * ignore copy to trash errors (allows to delete messages when overquota)
  77          */
  78         sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder, false);
  79     }
  80     return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true);
  81 }
  82
  83
  84 /**
  85  * Set a flag on the provided uid list
  86  * @param  resource imap connection
  87  * @param  array $id list with uid's
  88  * @param  string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered'
  89  * @param  bool   $set  add (true) or remove (false) the provided flag
  90  * @param  bool   $handle_errors Show error messages in case of a NO, BAD or BYE response
  91  * @return array  $aMessageList array with messages containing the new flags and UID @see parseFetch
  92  */
  93 function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) {
  94     $msgs_id = sqimap_message_list_squisher($id);
  95     $set_string = ($set ? '+' : '-');
  96
  97     for ($i=0; $i<sizeof($id); $i++) {
  98         $aMessageList["$id[$i]"] = array();
  99     }
 100
 101     $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE);
 102
 103     // parse the fetch response
 104     $parseFetchResults=parseFetch($aResponse,$aMessageList);
 105
 106     // some broken IMAP servers do not return UID elements on UID STORE
 107     // if this is the case, then we need to do a UID FETCH
 108     $testkey=$id[0];
 109     if (!isset($parseFetchResults[$testkey]['UID'])) {
 110         $aResponse = sqimap_run_command_list($imap_stream, "FETCH $msgs_id (FLAGS)", $handle_errors, $response, $message, TRUE);
 111         $parseFetchResults = parseFetch($aResponse,$aMessageList);
 112     }
 113
 114     return ($parseFetchResults);
 115 }
 116
 117
 118 /**
 119  * Sort the message list and crunch to be as small as possible
 120  * (overflow could happen, so make it small if possible)
 121  * @param array $aUid array with uid's
 122  * @return string $s message set string
 123  */
 124 function sqimap_message_list_squisher($aUid) {
 125     if( !is_array( $aUid ) ) {
 126         return $aUid;
 127     }
 128     sort($aUid, SORT_NUMERIC);
 129
 130     if (count($aUid)) {
 131         $s = '';
 132         for ($i=0,$iCnt=count($aUid);$i<$iCnt;++$i) {
 133             $iStart = $aUid[$i];
 134             $iEnd = $iStart;
 135             while ($i<($iCnt-1) && $aUid[$i+1] == $iEnd +1) {
 136                 $iEnd = $aUid[$i+1];
 137                 ++$i;
 138             }
 139             if ($s) {
 140                 $s .= ',';
 141             }
 142             $s .= $iStart;
 143             if ($iStart != $iEnd) {
 144                 $s .= ':' . $iEnd;
 145             }
 146         }
 147     }
 148     return $s;
 149 }
 150
 151
 152 /**
 153  * Retrieves an array with a sorted uid list. Sorting is done on the imap server
 154  * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt
 155  * @param resource $imap_stream IMAP socket connection
 156  * @param string $sSortField Field to sort on
 157  * @param bool $reverse Reverse order search
 158  * @return array $id sorted uid list
 159  */
 160 function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') {
 161     global  $default_charset;
 162
 163     if ($sSortField) {
 164         if ($reverse) {
 165             $sSortField = 'REVERSE '.$sSortField;
 166         }
 167         $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search";
 168         // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT']
 169         // use sqimap_run_command_list in case of unsollicited responses. If we don't we could loose the SORT response
 170         $aData = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, TRUE);
 171         /* fallback to default charset */
 172         if ($response == 'NO') {
 173             if (strpos($message,'BADCHARSET') !== false ||
 174                 strpos($message,'character') !== false) {
 175                 sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
 176                 $query = "SORT ($sSortField) US-ASCII $search";
 177                 $aData = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, TRUE);
 178             } else {
 179                 sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
 180             }
 181         } else if ($response == 'BAD') {
 182             sqm_trigger_imap_error('SQM_IMAP_NO_SORT',$query, $response, $message);
 183         }
 184     }
 185
 186     if ($response == 'OK') {
 187         return parseUidList($aData,'SORT');
 188     } else {
 189         return false;
 190     }
 191 }
 192
 193
 194 /**
 195  * Parses a UID list returned on a SORT or SEARCH request
 196  * @param array $aData imap response (retrieved from sqimap_run_command_list)
 197  * @param string $sCommand issued imap command (SEARCH or SORT)
 198  * @return array $aUid uid list
 199  */
 200 function parseUidList($aData,$sCommand) {
 201     $aUid = array();
 202     if (isset($aData) && count($aData)) {
 203         for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) {
 204             for ($j=0,$jCnt=count($aData[$i]);$j<$jCnt;++$j) {
 205                 if (preg_match("/^\* $sCommand (.+)$/", $aData[$i][$j], $aMatch)) {
 206                     $aUid += explode(' ', trim($aMatch[1]));
 207                 }
 208             }
 209         }
 210     }
 211     return array_unique($aUid);
 212 }
 213
 214 /**
 215  * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail
 216  *
 217  * @param resource $imap_stream IMAP socket connection
 218  * @param string $sSortField Field to sort on
 219  * @param bool $reverse Reverse order search
 220  * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:*
 221  * @return array $aUid sorted uid list
 222  */
 223 function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) {
 224     if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') {
 225         $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
 226                                       array($sSortField), array());
 227     } else {
 228         $msgs = sqimap_get_small_header_list($imap_stream, $aUid,
 229                                       array(), array($sSortField));
 230     }
 231     $aUid = array();
 232     $walk = false;
 233     switch ($sSortField) {
 234       // natcasesort section
 235       case 'FROM':
 236       case 'TO':
 237       case 'CC':
 238         if(!$walk) {
 239             array_walk($msgs, create_function('&$v,&$k,$f',
 240                 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
 241                  $addr = reset(parseRFC822Address($v[$f],1));
 242                  $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ?
 243                    $addr[SQM_ADDR_PERSONAL] : "";
 244                  $sEmail = ($addr[SQM_ADDR_HOST]) ?
 245                       $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] :
 246                       $addr[SQM_ADDR_HOST];
 247                  $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField);
 248             $walk = true;
 249         }
 250         // nobreak
 251       case 'SUBJECT':
 252         if(!$walk) {
 253             array_walk($msgs, create_function('&$v,&$k,$f',
 254                 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
 255                  $v[$f] = strtolower(decodeHeader(trim($v[$f])));
 256                  $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ?
 257                                     $matches[2] : $v[$f];'),$sSortField);
 258             $walk = true;
 259         }
 260         foreach ($msgs as $item) {
 261             $aUid[$item['UID']] = $item[$sSortField];
 262         }
 263         natcasesort($aUid);
 264         $aUid = array_keys($aUid);
 265         if ($reverse) {
 266              $aUid = array_reverse($aUid);
 267         }
 268         break;
 269         //  \natcasesort section
 270       // sort_numeric section
 271       case 'DATE':
 272       case 'INTERNALDATE':
 273         if(!$walk) {
 274             array_walk($msgs, create_function('&$v,$k,$f',
 275                 '$v[$f] = (isset($v[$f])) ? $v[$f] : "";
 276                  $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField);
 277             $walk = true;
 278         }
 279         // nobreak;
 280       case 'RFC822.SIZE':
 281         if(!$walk) {
 282             // redefine $sSortField to maintain the same namespace between
 283             // server-side sorting and SquirrelMail sorting
 284             $sSortField = 'SIZE';
 285         }
 286         foreach ($msgs as $item) {
 287             $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0;
 288         }
 289         if ($reverse) {
 290             arsort($aUid,SORT_NUMERIC);
 291         } else {
 292             asort($aUid, SORT_NUMERIC);
 293         }
 294         $aUid = array_keys($aUid);
 295         break;
 296         // \sort_numeric section
 297       case 'UID':
 298         $aUid = array_reverse($msgs);
 299         break;
 300     }
 301     return $aUid;
 302 }
 303
 304 /**
 305  * Returns an array with each element as a string representing one
 306  * message-thread as returned by the IMAP server.
 307  * @param resource $imap_stream IMAP socket connection
 308  * @param string $search optional search string
 309  * @return array
 310  * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
 311  */
 312 function get_thread_sort($imap_stream, $search='ALL') {
 313     global $sort_by_ref, $default_charset;
 314
 315     if ($sort_by_ref == 1) {
 316         $sort_type = 'REFERENCES';
 317     } else {
 318         $sort_type = 'ORDEREDSUBJECT';
 319     }
 320     $query = "THREAD $sort_type ".strtoupper($default_charset)." $search";
 321
 322     // TODO use sqimap_run_command_list as we do in get_server_sort()
 323     $sRead = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE);
 324
 325     /* fallback to default charset */
 326     if ($response == 'NO') {
 327         if (strpos($message,'BADCHARSET') !== false ||
 328             strpos($message,'character') !== false) {
 329             sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
 330             $query = "THREAD $sort_type US-ASCII $search";
 331             $sRead = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE);
 332         } else {
 333             sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
 334         }
 335     } elseif ($response == 'BAD') {
 336         sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',$query, $response, $message);
 337     }
 338     if (isset($sRead[0])) {
 339         for ($i=0,$iCnt=count($sRead);$i<$iCnt;++$i) {
 340             if (preg_match("/^\* THREAD (.+)$/", $sRead[$i], $aMatch)) {
 341                 $sThreadResponse = trim($aMatch[1]);
 342                 break;
 343             }
 344         }
 345     } else {
 346         $sThreadResponse = "";
 347     }
 348     unset($sRead);
 349
 350     if ($response !== 'OK') {
 351         return false;
 352     }
 353
 354     /* Example response
 355      *  S: * THREAD (2)(3 6 (4 23)(44 7 96))
 356      * -- 2
 357      *
 358      * -- 3
 359      *    \-- 6
 360      *        |-- 4
 361      *        |   \-- 23
 362      *        |
 363      *        \-- 44
 364      *             \-- 7
 365      *                 \-- 96
 366      */
 367 /*
 368  * Notes for future work:
 369  * indent_array should contain: indent_level, parent and flags,
 370  * sibling nodes ..
 371  * To achieve that we  need to define the following flags:
 372  * 0: hasnochildren
 373  * 1: haschildren
 374  * 2: is first
 375  * 4: is last
 376  * a node has sibling nodes if it's not the last node
 377  * a node has no sibling nodes if it's the last node
 378  * By using binary comparations we can store the flag in one var
 379  *
 380  * example:
 381  * -1      par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren,   isfirst, islast)
 382  *  \-2    par = 1, level = 1, flag = 0 + 2     = 2 (hasnochildren, isfirst)
 383  *  |-3    par = 1, level = 1, flag = 1 + 4     = 5 (haschildren,   islast)
 384  *   \-4   par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren,   isfirst, islast)
 385  *     \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast)
 386  */
 387
 388     $j = 0;
 389     $k = 0;
 390     $l = 0;
 391     $aUidThread = array();
 392     $aIndent = array();
 393     $aUidSubThread = array();
 394     $aDepthStack = array();
 395     $sUid = '';
 396
 397     if ($sThreadResponse) {
 398         for ($i=0,$iCnt = strlen($sThreadResponse);$i<$iCnt;++$i) {
 399             $cChar = $sThreadResponse{$i};
 400             switch ($cChar) {
 401                 case '(': // new sub thread
 402                     // correction for a subthread of a thread with no parents in thread
 403                     if (!count($aUidSubThread) && $j > 0) {
 404                        --$l;
 405                     }
 406                     $aDepthStack[$j] = $l;
 407                     ++$j;
 408                     break;
 409                 case ')': // close sub thread
 410                     if($sUid !== '') {
 411                         $aUidSubThread[] = $sUid;
 412                         $aIndent[$sUid] = $j + $l - 1;
 413                         ++$l;
 414                         $sUid = '';
 415                     }
 416                     --$j;
 417                     if ($j === 0) {
 418                         // show message that starts the thread first.
 419                         $aUidSubThread = array_reverse($aUidSubThread);
 420                         // do not use array_merge because it's extremely slow and is causing timeouts
 421                         foreach ($aUidSubThread as $iUid) {
 422                             $aUidThread[] = $iUid;
 423                         }
 424                         $aUidSubThread = array();
 425                         $l = 0;
 426                         $aDepthStack = array();
 427                     } else {
 428                         $l = $aDepthStack[$j];
 429                     }
 430                     break;
 431                 case ' ': // new child
 432                     if ($sUid !== '') {
 433                         $aUidSubThread[] = $sUid;
 434                         $aIndent[$sUid] = $j + $l - 1;
 435                         ++$l;
 436                         $sUid = '';
 437                     }
 438                     break;
 439                 default: // part of UID
 440                     $sUid .= $cChar;
 441                     break;
 442             }
 443         }
 444     }
 445     unset($sThreadResponse);
 446     // show newest threads first
 447     $aUidThread = array_reverse($aUidThread);
 448     return array($aUidThread,$aIndent);
 449 }
 450
 451
 452 function elapsedTime($start) {
 453     $stop = gettimeofday();
 454     $timepassed =  1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
 455     return $timepassed;
 456 }
 457
 458 /**
 459  * Parses a string in an imap response. String starts with " or { which means it
 460  * can handle double quoted strings and literal strings
 461  *
 462  * @param string $read imap response
 463  * @param integer $i (reference) offset in string
 464  * @return string $s parsed string without the double quotes or literal count
 465  */
 466 function parseString($read,&$i) {
 467     $char = $read{$i};
 468     $s = '';
 469     if ($char == '"') {
 470         $iPos = ++$i;
 471         while (true) {
 472             $iPos = strpos($read,'"',$iPos);
 473             if (!$iPos) break;
 474             if ($iPos && $read{$iPos -1} != '\\') {
 475                 $s = substr($read,$i,($iPos-$i));
 476                 $i = $iPos;
 477                 break;
 478             }
 479             $iPos++;
 480             if ($iPos > strlen($read)) {
 481                 break;
 482             }
 483         }
 484     } else if ($char == '{') {
 485         $lit_cnt = '';
 486         ++$i;
 487         $iPos = strpos($read,'}',$i);
 488         if ($iPos) {
 489             $lit_cnt = substr($read, $i, $iPos - $i);
 490             $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */
 491             /* Now read the literal */
 492             $s = ($lit_cnt ? substr($read,$i,$lit_cnt): '');
 493             $i += $lit_cnt;
 494             /* temp bugfix (SM 1.5 will have a working clean version)
 495                too much work to implement that version right now */
 496             --$i;
 497         } else { /* should never happen */
 498             $i += 3; /* } + \r + \n */
 499             $s = '';
 500         }
 501     } else {
 502         return false;
 503     }
 504     ++$i;
 505     return $s;
 506 }
 507
 508
 509 /**
 510  * Parses a string containing an array from an imap response. String starts with ( and end with )
 511  *
 512  * @param string $read imap response
 513  * @param integer $i (reference) offset in string
 514  * @return array $a
 515  */
 516 function parseArray($read,&$i) {
 517     $i = strpos($read,'(',$i);
 518     $i_pos = strpos($read,')',$i);
 519     $s = substr($read,$i+1,$i_pos - $i -1);
 520     $a = explode(' ',$s);
 521     if ($i_pos) {
 522         $i = $i_pos+1;
 523         return $a;
 524     } else {
 525         return false;
 526     }
 527 }
 528
 529
 530 /**
 531  * Retrieves a list with headers, flags, size or internaldate from the imap server
 532  *
 533  * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x.
 534  * Output format, third argument and $msg_list array format requirements differ.
 535  * @param stream $imap_stream imap connection
 536  * @param array  $msg_list array with id's to create a msgs set from
 537  * @param array  $aHeaderFields (since 1.5.0) requested header fields
 538  * @param array  $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE
 539  * @return array $aMessages associative array with messages. Key is the UID, value is an associative array
 540  * @since 1.1.3
 541  */
 542 function sqimap_get_small_header_list($imap_stream, $msg_list,
 543     $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'),
 544     $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) {
 545
 546     $aMessageList = array();
 547
 548     /**
 549      * Catch other priority headers as well
 550      */
 551     if (in_array('X-Priority',$aHeaderFields,true)) {
 552         $aHeaderFields[] = 'Importance';
 553         $aHeaderFields[] = 'Priority';
 554     }
 555
 556     $bUidFetch = ! in_array('UID', $aFetchItems, true);
 557
 558     /* Get the small headers for each message in $msg_list */
 559     if ($msg_list !== NULL) {
 560         $msgs_str = sqimap_message_list_squisher($msg_list);
 561         /*
 562         * We need to return the data in the same order as the caller supplied
 563         * in $msg_list, but IMAP servers are free to return responses in
 564         * whatever order they wish... So we need to re-sort manually
 565         */
 566         if ($bUidFetch) {
 567             for ($i = 0; $i < sizeof($msg_list); $i++) {
 568                 $aMessageList["$msg_list[$i]"] = array();
 569             }
 570         }
 571     } else {
 572         $msgs_str = '1:*';
 573     }
 574
 575     /*
 576      * Create the query
 577      */
 578
 579     $sFetchItems = '';
 580     $query = "FETCH $msgs_str (";
 581     if (count($aFetchItems)) {
 582         $sFetchItems = implode(' ',$aFetchItems);
 583     }
 584     if (count($aHeaderFields)) {
 585         $sHeaderFields = implode(' ',$aHeaderFields);
 586         $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]';
 587     }
 588     $query .= trim($sFetchItems) . ')';
 589     $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch);
 590     $aMessages = parseFetch($aResponse,$aMessageList);
 591     array_reverse($aMessages);
 592     return $aMessages;
 593 }
 594
 595
 596 /**
 597  * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID
 598  * @param array    $aResponse Imap response
 599  * @param array    $aMessageList Placeholder array for results. The keys of the
 600  *                 placeholder array should be the UID so we can reconstruct the order.
 601  * @return array   $aMessageList associative array with messages. Key is the UID, value is an associative array
 602  * @author Marc Groot Koerkamp
 603  */
 604 function parseFetch(&$aResponse,$aMessageList = array()) {
 605     for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) {
 606         $aMsg = array();
 607
 608         $read = implode('',$aResponse[$j]);
 609         // free up memmory
 610         unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */
 611         /*
 612             * #id<space>FETCH<space>(
 613         */
 614
 615         /* extract the message id */
 616         $i_space = strpos($read,' ',2);/* position 2ed <space> */
 617         $id = substr($read,2/* skip "*<space>" */,$i_space -2);
 618         $aMsg['ID'] = $id;
 619         $fetch = substr($read,$i_space+1,5);
 620         if (!is_numeric($id) && $fetch !== 'FETCH') {
 621             $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code
 622             break;
 623         }
 624         $i = strpos($read,'(',$i_space+5);
 625         $read = substr($read,$i+1);
 626         $i_len = strlen($read);
 627         $i = 0;
 628         while ($i < $i_len && $i !== false) {
 629             /* get argument */
 630             $read = trim(substr($read,$i));
 631             $i_len = strlen($read);
 632             $i = strpos($read,' ');
 633             $arg = substr($read,0,$i);
 634             ++$i;
 635             /*
 636              * use allcaps for imap items and lowcaps for headers as key for the $aMsg array
 637              */
 638             switch ($arg)
 639             {
 640             case 'UID':
 641                 $i_pos = strpos($read,' ',$i);
 642                 if (!$i_pos) {
 643                     $i_pos = strpos($read,')',$i);
 644                 }
 645                 if ($i_pos) {
 646                     $unique_id = substr($read,$i,$i_pos-$i);
 647                     $i = $i_pos+1;
 648                 } else {
 649                     break 3;
 650                 }
 651                 break;
 652             case 'FLAGS':
 653                 $flags = parseArray($read,$i);
 654                 if (!$flags) break 3;
 655                 $aFlags = array();
 656                 foreach ($flags as $flag) {
 657                     $flag = strtolower($flag);
 658                     $aFlags[$flag] = true;
 659                 }
 660                 $aMsg['FLAGS'] = $aFlags;
 661                 break;
 662             case 'RFC822.SIZE':
 663                 $i_pos = strpos($read,' ',$i);
 664                 if (!$i_pos) {
 665                     $i_pos = strpos($read,')',$i);
 666                 }
 667                 if ($i_pos) {
 668                     $aMsg['SIZE'] = substr($read,$i,$i_pos-$i);
 669                     $i = $i_pos+1;
 670                 } else {
 671                     break 3;
 672                 }
 673                 break;
 674             case 'ENVELOPE':
 675                 // sqimap_parse_address($read,$i,$aMsg);
 676                 break; // to be implemented, moving imap code out of the Message class
 677             case 'BODYSTRUCTURE':
 678                 break; // to be implemented, moving imap code out of the Message class
 679             case 'INTERNALDATE':
 680                 $aMsg['INTERNALDATE'] = trim(str_replace('  ', ' ',parseString($read,$i)));
 681                 break;
 682             case 'BODY.PEEK[HEADER.FIELDS':
 683             case 'BODY[HEADER.FIELDS':
 684                 $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters
 685                 $header = parseString($read,$i);
 686                 if ($header === false) break 2;
 687                 /* First we replace all \r\n by \n, and unfold the header */
 688                 $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header));
 689                 /* Now we can make a new header array with
 690                    each element representing a headerline  */
 691                 $aHdr = explode("\n" , $hdr);
 692                 $aReceived = array();
 693                 foreach ($aHdr as $line) {
 694                     $pos = strpos($line, ':');
 695                     if ($pos > 0) {
 696                         $field = strtolower(substr($line, 0, $pos));
 697                         if (!strstr($field,' ')) { /* valid field */
 698                             $value = trim(substr($line, $pos+1));
 699                             switch($field) {
 700                                 case 'date':
 701                                     $aMsg['date'] = trim(str_replace('  ', ' ', $value));
 702                                     break;
 703                                 case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break;
 704                                 case 'priority':
 705                                 case 'importance':
 706                                     // duplicate code with Rfc822Header.cls:parsePriority()
 707                                     if (!isset($aMsg['x-priority'])) {
 708                                         $aPrio = preg_split('/\s/',trim($value));
 709                                         $sPrio = strtolower(array_shift($aPrio));
 710                                         if  (is_numeric($sPrio)) {
 711                                             $iPrio = (int) $sPrio;
 712                                         } elseif ( $sPrio == 'non-urgent' || $sPrio == 'low' ) {
 713                                             $iPrio = 3;
 714                                         } elseif ( $sPrio == 'urgent' || $sPrio == 'high' ) {
 715                                             $iPrio = 1;
 716                                         } else {
 717                                             // default is normal priority
 718                                             $iPrio = 3;
 719                                         }
 720                                         $aMsg['x-priority'] = $iPrio;
 721                                     }
 722                                     break;
 723                                 case 'content-type':
 724                                     $type = $value;
 725                                     if ($pos = strpos($type, ";")) {
 726                                         $type = substr($type, 0, $pos);
 727                                     }
 728                                     $type = explode("/", $type);
 729                                     if(!is_array($type) || count($type) < 2) {
 730                                         $aMsg['content-type'] = array('text','plain');
 731                                     } else {
 732                                         $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1]));
 733                                     }
 734                                     break;
 735                                 case 'received':
 736                                     $aMsg['received'][] = $value;
 737                                     break;
 738                                 default:
 739                                     $aMsg[$field] = $value;
 740                                     break;
 741                             }
 742                         }
 743                     }
 744                 }
 745                 break;
 746             default:
 747                 ++$i;
 748                 break;
 749             }
 750         }
 751         if (!empty($unique_id)) {
 752             $msgi = "$unique_id";
 753             $aMsg['UID'] = $unique_id;
 754        } else {
 755             $msgi = '';
 756        }
 757        $aMessageList[$msgi] = $aMsg;
 758        $aResponse[$j] = NULL;
 759     }
 760     return $aMessageList;
 761 }
 762
 763 /**
 764  * Work in process
 765  * @private
 766  * @author Marc Groot Koerkamp
 767  */
 768 function sqimap_parse_envelope($read, &$i, &$msg) {
 769     $arg_no = 0;
 770     $arg_a = array();
 771     ++$i;
 772     for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) {
 773         $char = strtoupper($read{$i});
 774         switch ($char) {
 775             case '{':
 776             case '"':
 777                 $arg_a[] = parseString($read,$i);
 778                 ++$arg_no;
 779                 break;
 780             case 'N':
 781                 /* probably NIL argument */
 782                 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
 783                     $arg_a[] = '';
 784                     ++$arg_no;
 785                     $i += 2;
 786                 }
 787                 break;
 788             case '(':
 789                 /* Address structure (with group support)
 790                 * Note: Group support is useless on SMTP connections
 791                 *       because the protocol doesn't support it
 792                 */
 793                 $addr_a = array();
 794                 $group = '';
 795                 $a=0;
 796                 for (; $i < $cnt && $read{$i} != ')'; ++$i) {
 797                     if ($read{$i} == '(') {
 798                         $addr = sqimap_parse_address($read, $i);
 799                         if (($addr[3] == '') && ($addr[2] != '')) {
 800                             /* start of group */
 801                             $group = $addr[2];
 802                             $group_addr = $addr;
 803                             $j = $a;
 804                         } else if ($group && ($addr[3] == '') && ($addr[2] == '')) {
 805                         /* end group */
 806                             if ($a == ($j+1)) { /* no group members */
 807                                 $group_addr[4] = $group;
 808                                 $group_addr[2] = '';
 809                                 $group_addr[0] = "$group: Undisclosed recipients;";
 810                                 $addr_a[] = $group_addr;
 811                                 $group ='';
 812                             }
 813                         } else {
 814                             $addr[4] = $group;
 815                             $addr_a[] = $addr;
 816                         }
 817                         ++$a;
 818                     }
 819                 }
 820                 $arg_a[] = $addr_a;
 821                 break;
 822             default: break;
 823         }
 824     }
 825
 826     if (count($arg_a) > 9) {
 827         $d = strtr($arg_a[0], array('  ' => ' '));
 828         $d = explode(' ', $d);
 829         if (!$arg_a[1]) $arg_a[1] = '';
 830         $msg['DATE'] = $d; /* argument 1: date */
 831         $msg['SUBJECT'] = $arg_a[1];     /* argument 2: subject */
 832         $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : '';     /* argument 3: from        */
 833         $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : '';   /* argument 4: sender      */
 834         $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : '';  /* argument 5: reply-to    */
 835         $msg['TO'] = $arg_a[5];          /* argument 6: to          */
 836         $msg['CC'] = $arg_a[6];          /* argument 7: cc          */
 837         $msg['BCC'] = $arg_a[7];         /* argument 8: bcc         */
 838         $msg['IN-REPLY-TO'] = $arg_a[8];   /* argument 9: in-reply-to */
 839         $msg['MESSAGE-ID'] = $arg_a[9];  /* argument 10: message-id */
 840     }
 841 }
 842
 843
 844 /**
 845  * Work in process
 846  * @private
 847  * @author Marc Groot Koerkamp
 848  */
 849 function sqimap_parse_address($read, &$i) {
 850     $arg_a = array();
 851     for (; $read{$i} != ')'; ++$i) {
 852         $char = strtoupper($read{$i});
 853         switch ($char) {
 854             case '{':
 855             case '"': $arg_a[] =  parseString($read,$i); break;
 856             case 'n':
 857             case 'N':
 858                 if (strtoupper(substr($read, $i, 3)) == 'NIL') {
 859                     $arg_a[] = '';
 860                     $i += 2;
 861                 }
 862                 break;
 863             default: break;
 864         }
 865     }
 866
 867     if (count($arg_a) == 4) {
 868         return $arg_a;
 869
 870 //        $adr = new AddressStructure();
 871 //        $adr->personal = $arg_a[0];
 872 //        $adr->adl = $arg_a[1];
 873 //        $adr->mailbox = $arg_a[2];
 874 //        $adr->host = $arg_a[3];
 875     } else {
 876         $adr = '';
 877     }
 878     return $adr;
 879 }
 880
 881
 882 /**
 883  * Returns a message array with all the information about a message.
 884  * See the documentation folder for more information about this array.
 885  *
 886  * @param  resource $imap_stream imap connection
 887  * @param  integer  $id uid of the message
 888  * @param  string   $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere
 889  * @param  int      $hide Indicates whether or not to hide any errors: 0 = don't hide, 1 = hide (just exit), 2 = hide (return FALSE), 3 = hide (return error string) (OPTIONAL; default don't hide)
 890  * @return mixed  Message object or FALSE/error string if error occurred and $hide is set to 2/3
 891  */
 892 function sqimap_get_message($imap_stream, $id, $mailbox, $hide=0) {
 893     // typecast to int to prohibit 1:* msgs sets
 894     $id = (int) $id;
 895     $flags = array();
 896     $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE);
 897     if ($read) {
 898         if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) {
 899             if (trim($regs[1])) {
 900                 $flags = preg_split('/ /', $regs[1],-1,PREG_SPLIT_NO_EMPTY);
 901             }
 902         }
 903     } else {
 904
 905         if ($hide == 1) exit;
 906         if ($hide == 2) return FALSE;
 907
 908         /* the message was not found, maybe the mailbox was modified? */
 909         global $sort, $startMessage, $color;
 910
 911         $errmessage = _("The server couldn't find the message you requested.");
 912
 913         if ($hide == 3) return $errmessage;
 914
 915         $errmessage .= '<p>'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox).");
 916
 917         /* this will include a link back to the message list */
 918         error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color);
 919         exit;
 920     }
 921     $bodystructure = implode('',$read);
 922     $msg =  mime_structure($bodystructure,$flags);
 923     $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE);
 924     $rfc822_header = new Rfc822Header();
 925     $rfc822_header->parseHeader($read);
 926     $msg->rfc822_header = $rfc822_header;
 927     return $msg;
 928 }