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