X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_messages.php;h=952f25987e31a9d6b0c2845a6b7abdb97c6f33b9;hb=9bc67baaba05305e962e911aee4c8c9aa2e1290f;hp=c219b80d8f023333be8cb71f8935438c03415cfa;hpb=4a691c9b2444774dd9b18d8feafe095956a7351e;p=squirrelmail.git diff --git a/functions/imap_messages.php b/functions/imap_messages.php index c219b80d..952f2598 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -1,296 +1,965 @@ - 0) { - $bound = substr($bound, $pos, strpos($line, " ", $pos)); - } else { - $bound = substr($bound, $pos); - } - $bound = str_replace("\"", "", $bound); - $header["BOUNDARY"] = $bound; + /* + * now the children, checking each thread portion for + * ),(, and space, adjusting the level and space values + * to get the indent level + */ + $level = 0; + $spaces = array(); + $spaces_total = 0; + $indent = 0; + $fake = FALSE; + for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++$k) { + $chars = count_chars($thread_new[$i][$k], 1); + if (isset($chars['40'])) { /* testing for ( */ + $level += $chars['40']; + } + if (isset($chars['41'])) { /* testing for ) */ + $level -= $chars['41']; + $spaces[$level] = 0; + /* if we were faking lets stop, this portion + * of the thread is over + */ + if ($level == $cutoff) { + $fake = FALSE; + } + } + if (isset($chars['32'])) { /* testing for space */ + if (!isset($spaces[$level])) { + $spaces[$level] = 0; + } + $spaces[$level] += $chars['32']; } + for ($x=0;$x<=$level;$x++) { + if (isset($spaces[$x])) { + $spaces_total += $spaces[$x]; + } + } + $indent = $level + $spaces_total; + /* must have run into a message that broke the thread + * so we are adjusting for that portion + */ + if ($fake == TRUE) { + $indent = $indent +1; + } + if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) { + $child = $regs[1]; + } + /* the thread must be broken if $indent == 0 + * so indent the message once and start faking it + */ + if ($indent == 0) { + $indent = 1; + $fake = TRUE; + $cutoff = $level; + } + /* dont need abs but if indent was negative + * errors would occur + */ + $indent_array[$child] = ($indent < 0) ? 0 : $indent; + $spaces_total = 0; + } + } + return $indent_array; +} - /** Detect the charset **/ - if (strpos(strtolower(trim($line)), "charset=")) { - $pos = strpos($line, "charset=") + 8; - $charset = trim($line); - if (strpos($line, " ", $pos) > 0) { - $charset = substr($charset, $pos, strpos($line, " ", $pos)); - } else { - $charset = substr($charset, $pos); - } - $charset = str_replace("\"", "", $charset); - $header["CHARSET"] = $charset; + +/** + * Returns an array with each element as a string representing one + * message-thread as returned by the IMAP server. + * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt + */ +function get_thread_sort($imap_stream, $search='ALL') { + global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array; + + $thread_temp = array (); + if ($sort_by_ref == 1) { + $sort_type = 'REFERENCES'; + } else { + $sort_type = 'ORDEREDSUBJECT'; + } + $query = "THREAD $sort_type ".strtoupper($default_charset)." $search"; + + $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE); + /* fallback to default charset */ + if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) { + $query = "THREAD $sort_type US-ASCII $search"; + $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); + } + if (isset($thread_test[0])) { + for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) { + if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) { + $thread_list = trim($regs[1]); + break; + } + } + } else { + $thread_list = ""; + } + if (!preg_match("/OK/", $response)) { + $server_sort_array = 'no'; + return $server_sort_array; + } + if (isset($thread_list)) { + $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY); + } + + $counter = 0; + $thread_new = array(); + $k = 0; + $thread_new[0] = ""; + /* + * parse the thread response into separate threads + * + * example: + * [0] => (540) + * [1] => (1386) + * [2] => (1599 759 959 37) + * [3] => (492 1787) + * [4] => ((933)(1891)) + * [5] => (1030 (1497)(845)(1637)) + */ + for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++) { + if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') { + $thread_new[$k] = $thread_new[$k] . $thread_temp[$i]; + } elseif ($thread_temp[$i] == '(') { + $thread_new[$k] .= $thread_temp[$i]; + $counter++; + } elseif ($thread_temp[$i] == ')') { + if ($counter > 1) { + $thread_new[$k] .= $thread_temp[$i]; + $counter = $counter - 1; } else { - $header["CHARSET"] = "us-ascii"; + $thread_new[$k] .= $thread_temp[$i]; + $k++; + $thread_new[$k] = ""; + $counter = $counter - 1; } + } + } + + $thread_new = array_reverse($thread_new); + /* place the threads after each other in one string */ + $thread_list = implode(" ", $thread_new); + $thread_list = str_replace("(", " ", $thread_list); + $thread_list = str_replace(")", " ", $thread_list); + $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY); + $server_sort_array = $thread_list; + + $indent_array = get_parent_level ($thread_new); + return array($thread_list,$indent_array); +} + + +function elapsedTime($start) { + $stop = gettimeofday(); + $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec']; + return $timepassed; +} - /** Detects filename if any **/ - if (strpos(strtolower(trim($line)), "name=")) { - $pos = strpos($line, "name=") + 5; - $name = trim($line); - if (strpos($line, " ", $pos) > 0) { - $name = substr($name, $pos, strpos($line, " ", $pos)); - } else { - $name = substr($name, $pos); - } - $name = str_replace("\"", "", $name); - $header["FILENAME"] = $name; + +/** + * Normalise the different Priority headers into a uniform value, + * namely that of the X-Priority header (1, 3, 5). Supports: + * Prioirty, X-Priority, Importance. + * X-MS-Mail-Priority is not parsed because it always coincides + * with one of the other headers. + * + * DUPLICATE CODE ALERT: + * NOTE: this is actually a duplicate from the function in + * class/mime/Rfc822Header.php. + */ +function parsePriority($value) { + $value = strtolower(array_shift(split('/\w/',trim($value)))); + if ( is_numeric($value) ) { + return $value; + } + if ( $value == 'urgent' || $value == 'high' ) { + return 1; + } elseif ( $value == 'non-urgent' || $value == 'low' ) { + return 5; + } + return 3; +} + +/** + * Parses a string in an imap response. String starts with " or { which means it + * can handle double quoted strings and literal strings + * + * @param string $read imap response + * @param integer $i (reference) offset in string + * @return string $s parsed string without the double quotes or literal count + */ +function parseString($read,&$i) { + $char = $read{$i}; + $s = ''; + if ($char == '"') { + $iPos = ++$i; + while (true) { + $iPos = strpos($read,'"',$iPos); + if (!$iPos) break; + if ($iPos && $read{$iPos -1} != '\\') { + $s = substr($read,$i,($iPos-$i)); + $i = $iPos; + break; } - } - - /** REPLY-TO **/ - else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") { - $header["REPLYTO"] = trim(substr($read[$i], 9, strlen($read[$i]))); - $i++; - } - - /** FROM **/ - else if (strtolower(substr($read[$i], 0, 5)) == "from:") { - $header["FROM"] = trim(substr($read[$i], 5, strlen($read[$i]) - 6)); - if ($header["REPLYTO"] == "") - $header["REPLYTO"] = $header["FROM"]; - $i++; - } - /** DATE **/ - else if (strtolower(substr($read[$i], 0, 5)) == "date:") { - $d = substr($read[$i], 5); - $d = trim($d); - $d = ereg_replace(" ", " ", $d); - $d = explode(" ", $d); - $header["DATE"] = getTimeStamp($d); - $i++; - } - /** SUBJECT **/ - else if (strtolower(substr($read[$i], 0, 8)) == "subject:") { - $header["SUBJECT"] = trim(substr($read[$i], 8, strlen($read[$i]) - 9)); - if (strlen(Chop($header["SUBJECT"])) == 0) - $header["SUBJECT"] = _("(no subject)"); - $i++; - } - /** CC **/ - else if (strtolower(substr($read[$i], 0, 3)) == "cc:") { - $pos = 0; - $header["CC"][$pos] = trim(substr($read[$i], 4)); - $i++; - while ((substr($read[$i], 0, 1) == " ") && (trim($read[$i]) != "")) { - $pos++; - $header["CC"][$pos] = trim($read[$i]); - $i++; + $iPos++; + if ($iPos > strlen($read)) { + break; } - } - /** TO **/ - else if (strtolower(substr($read[$i], 0, 3)) == "to:") { - $pos = 0; - $header["TO"][$pos] = trim(substr($read[$i], 4)); - $i++; - while ((substr($read[$i], 0, 1) == " ") && (trim($read[$i]) != "")){ - $pos++; - $header["TO"][$pos] = trim($read[$i]); - $i++; + } + } else if ($char == '{') { + $lit_cnt = ''; + ++$i; + $iPos = strpos($read,'}',$i); + if ($iPos) { + $lit_cnt = substr($read, $i, $iPos - $i); + $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */ + /* Now read the literal */ + $s = ($lit_cnt ? substr($read,$i,$lit_cnt): ''); + $i += $lit_cnt; + /* temp bugfix (SM 1.5 will have a working clean version) + too much work to implement that version right now */ + --$i; + } else { /* should never happen */ + $i += 3; /* } + \r + \n */ + $s = ''; + } + } else { + return false; + } + ++$i; + return $s; +} + + +/** + * Parses a string containing an array from an imap response. String starts with ( and end with ) + * + * @param string $read imap response + * @param integer $i (reference) offset in string + * @return array $a + */ +function parseArray($read,&$i) { + $i = strpos($read,'(',$i); + $i_pos = strpos($read,')',$i); + $s = substr($read,$i+1,$i_pos - $i -1); + $a = explode(' ',$s); + if ($i_pos) { + $i = $i_pos+1; + return $a; + } else { + return false; + } +} + + +/** + * Retrieves a list with headers, flags, size or internaldate from the imap server + * + * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x. + * Output format, third argument and $msg_list array format requirements differ. + * @param stream $imap_stream imap connection + * @param array $msg_list array with id's to create a msgs set from + * @param array $aHeaderFields (since 1.5.0) requested header fields + * @param array $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE + * @return array $aMessages associative array with messages. Key is the UID, value is an associative array + * @since 1.1.3 + */ +function sqimap_get_small_header_list($imap_stream, $msg_list, + $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'), + $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) { + + $aMessageList = array(); + + /** + * Catch other priority headers as well + */ + if (in_array('X-Priority',$aHeaderFields,true)) { + $aHeaderFields[] = 'Importance'; + $aHeaderFields[] = 'Priority'; + } + + $bUidFetch = ! in_array('UID', $aFetchItems, true); + + /* Get the small headers for each message in $msg_list */ + if ($msg_list !== NULL) { + $msgs_str = sqimap_message_list_squisher($msg_list); + /* + * We need to return the data in the same order as the caller supplied + * in $msg_list, but IMAP servers are free to return responses in + * whatever order they wish... So we need to re-sort manually + */ + if ($bUidFetch) { + for ($i = 0; $i < sizeof($msg_list); $i++) { + $aMessageList["$msg_list[$i]"] = array(); } - } - - /** ERROR CORRECTION **/ - else if (substr($read[$i], 0, 1) == ")") { - if ($header["SUBJECT"] == "") - $header["SUBJECT"] = _("(no subject)"); - - if ($header["FROM"] == "") - $header["FROM"] = _("(unknown sender)"); - - if ($header["DATE"] == "") - $header["DATE"] = time(); - $i++; - } - else { - $i++; - } - } - return $header; - } - - - /****************************************************************************** - ** Returns the body of a message. - ******************************************************************************/ - function sqimap_get_message_body ($imap_stream, $bound, $id, $type0, $type1, $encoding) { - fputs ($imap_stream, "a001 FETCH $id:$id BODY[TEXT]\n"); - $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message); - - $i = 0; - $j = 0; - while ($i < count($read)-1) { - if ( ($i != 0) ) { - $bodytmp[$j] = $read[$i]; - $j++; - } - $i++; - } - $body = $bodytmp; - - return decodeMime($body, $bound, $type0, $type1, $encoding); - } + } + } else { + $msgs_str = '1:*'; + } + + /* + * Create the query + */ + + $sFetchItems = ''; + $query = "FETCH $msgs_str ("; + if (count($aFetchItems)) { + $sFetchItems = implode(' ',$aFetchItems); + } + if (count($aHeaderFields)) { + $sHeaderFields = implode(' ',$aHeaderFields); + $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]'; + } + $query .= trim($sFetchItems) . ')'; + $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch); + $aMessages = parseFetch($aResponse,$aMessageList); + array_reverse($aMessages); + return $aMessages; +} + + +/** + * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID + * @param array $aResponse Imap response + * @param array $aMessageList Placeholder array for results. The keys of the + * placeholder array should be the UID so we can reconstruct the order. + * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array + * @author Marc Groot Koerkamp + */ +function parseFetch($aResponse,$aMessageList = array()) { + for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) { + $aMsg = array(); + + $read = implode('',$aResponse[$j]); + // free up memmory + unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */ + /* + * #idFETCH( + */ + + /* extract the message id */ + $i_space = strpos($read,' ',2);/* position 2ed */ + $id = substr($read,2/* skip "*" */,$i_space -2); + $aMsg['ID'] = $id; + $fetch = substr($read,$i_space+1,5); + if (!is_numeric($id) && $fetch !== 'FETCH') { + $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code + break; + } + $i = strpos($read,'(',$i_space+5); + $read = substr($read,$i+1); + $i_len = strlen($read); + $i = 0; + while ($i < $i_len && $i !== false) { + /* get argument */ + $read = trim(substr($read,$i)); + $i_len = strlen($read); + $i = strpos($read,' '); + $arg = substr($read,0,$i); + ++$i; + /* + * use allcaps for imap items and lowcaps for headers as key for the $aMsg array + */ + switch ($arg) + { + case 'UID': + $i_pos = strpos($read,' ',$i); + if (!$i_pos) { + $i_pos = strpos($read,')',$i); + } + if ($i_pos) { + $unique_id = substr($read,$i,$i_pos-$i); + $i = $i_pos+1; + } else { + break 3; + } + break; + case 'FLAGS': + $flags = parseArray($read,$i); + if (!$flags) break 3; + $aFlags = array(); + foreach ($flags as $flag) { + $flag = strtolower($flag); + $aFlags[$flag] = true; + } + $aMsg['FLAGS'] = $aFlags; + break; + case 'RFC822.SIZE': + $i_pos = strpos($read,' ',$i); + if (!$i_pos) { + $i_pos = strpos($read,')',$i); + } + if ($i_pos) { + $aMsg['SIZE'] = substr($read,$i,$i_pos-$i); + $i = $i_pos+1; + } else { + break 3; + } + break; + case 'ENVELOPE': + // sqimap_parse_address($read,$i,$aMsg); + break; // to be implemented, moving imap code out of the Message class + case 'BODYSTRUCTURE': + break; // to be implemented, moving imap code out of the Message class + case 'INTERNALDATE': + $aMsg['INTERNALDATE'] = trim(str_replace(' ', ' ',parseString($read,$i))); + break; + case 'BODY.PEEK[HEADER.FIELDS': + case 'BODY[HEADER.FIELDS': + $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters + $header = parseString($read,$i); + if ($header === false) break 2; + /* First we replace all \r\n by \n, and unfold the header */ + $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header)); + /* Now we can make a new header array with + each element representing a headerline */ + $aHdr = explode("\n" , $hdr); + $aReceived = array(); + foreach ($aHdr as $line) { + $pos = strpos($line, ':'); + if ($pos > 0) { + $field = strtolower(substr($line, 0, $pos)); + if (!strstr($field,' ')) { /* valid field */ + $value = trim(substr($line, $pos+1)); + switch($field) { + case 'date': + $aMsg['date'] = trim(str_replace(' ', ' ', $value)); + break; + case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break; + case 'priority': + case 'importance': + if (!isset($aMsg['x-priority'])) { + $value = strtolower(array_shift(split('/\w/',trim($value)))); + if (is_numeric($value)) { + $value = (int) $value; + } elseif ( $value == 'non-urgent' || $value == 'low' ) { + $value = 3; + } elseif ( $value == 'urgent' || $value == 'high' ) { + $value = 1; + } else { + // default is normal priority + $value = 3; + } + $aMsg['x-priority'] = $value; + } + break; + case 'content-type': + $type = $value; + if ($pos = strpos($type, ";")) { + $type = substr($type, 0, $pos); + } + $type = explode("/", $type); + if(!is_array($type) || count($type) < 2) { + $aMsg['content-type'] = array('text','plain'); + } else { + $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1])); + } + break; + case 'received': + $aMsg['received'][] = $value; + break; + default: + $aMsg[$field] = $value; + break; + } + } + } + } + break; + default: + ++$i; + break; + } + } + $msgi ="$unique_id"; + $msg['UID'] = $unique_id; + $aMessageList[$msgi] = $aMsg; + } + return $aMessageList; +} + +/** + * Work in process + * @private + * @author Marc Groot Koerkamp + */ +function sqimap_parse_envelope($read, &$i, &$msg) { + $arg_no = 0; + $arg_a = array(); + ++$i; + for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) { + $char = strtoupper($read{$i}); + switch ($char) { + case '{': + case '"': + $arg_a[] = parseString($read,$i); + ++$arg_no; + break; + case 'N': + /* probably NIL argument */ + if (strtoupper(substr($read, $i, 3)) == 'NIL') { + $arg_a[] = ''; + ++$arg_no; + $i += 2; + } + break; + case '(': + /* Address structure (with group support) + * Note: Group support is useless on SMTP connections + * because the protocol doesn't support it + */ + $addr_a = array(); + $group = ''; + $a=0; + for (; $i < $cnt && $read{$i} != ')'; ++$i) { + if ($read{$i} == '(') { + $addr = sqimap_parse_address($read, $i); + if (($addr[3] == '') && ($addr[2] != '')) { + /* start of group */ + $group = $addr[2]; + $group_addr = $addr; + $j = $a; + } else if ($group && ($addr[3] == '') && ($addr[2] == '')) { + /* end group */ + if ($a == ($j+1)) { /* no group members */ + $group_addr[4] = $group; + $group_addr[2] = ''; + $group_addr[0] = "$group: Undisclosed recipients;"; + $addr_a[] = $group_addr; + $group =''; + } + } else { + $addr[4] = $group; + $addr_a[] = $addr; + } + ++$a; + } + } + $arg_a[] = $addr_a; + break; + default: break; + } + } + + if (count($arg_a) > 9) { + $d = strtr($arg_a[0], array(' ' => ' ')); + $d = explode(' ', $d); + if (!$arg_a[1]) $arg_a[1] = ''; + $msg['DATE'] = $d; /* argument 1: date */ + $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */ + $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : ''; /* argument 3: from */ + $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : ''; /* argument 4: sender */ + $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : ''; /* argument 5: reply-to */ + $msg['TO'] = $arg_a[5]; /* argument 6: to */ + $msg['CC'] = $arg_a[6]; /* argument 7: cc */ + $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */ + $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */ + $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */ + } +} + + +/** + * Work in process + * @private + * @author Marc Groot Koerkamp + */ +function sqimap_parse_address($read, &$i) { + $arg_a = array(); + for (; $read{$i} != ')'; ++$i) { + $char = strtoupper($read{$i}); + switch ($char) { + case '{': + case '"': $arg_a[] = parseString($read,$i); break; + case 'n': + case 'N': + if (strtoupper(substr($read, $i, 3)) == 'NIL') { + $arg_a[] = ''; + $i += 2; + } + break; + default: break; + } + } + + if (count($arg_a) == 4) { + return $arg_a; + +// $adr = new AddressStructure(); +// $adr->personal = $arg_a[0]; +// $adr->adl = $arg_a[1]; +// $adr->mailbox = $arg_a[2]; +// $adr->host = $arg_a[3]; + } else { + $adr = ''; + } + return $adr; +} + + +/** + * Returns a message array with all the information about a message. + * See the documentation folder for more information about this array. + * + * @param resource $imap_stream imap connection + * @param integer $id uid of the message + * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere + * @return Message Message object + */ +function sqimap_get_message($imap_stream, $id, $mailbox) { + // typecast to int to prohibit 1:* msgs sets + $id = (int) $id; + $flags = array(); + $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE); + if ($read) { + if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) { + if (trim($regs[1])) { + $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY'); + } + } + } else { + /* the message was not found, maybe the mailbox was modified? */ + global $sort, $startMessage, $color; + + $errmessage = _("The server couldn't find the message you requested.") . + '

'._("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)."); + /* this will include a link back to the message list */ + error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color); + exit; + } + $bodystructure = implode('',$read); + $msg = mime_structure($bodystructure,$flags); + $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE); + $rfc822_header = new Rfc822Header(); + $rfc822_header->parseHeader($read); + $msg->rfc822_header = $rfc822_header; + return $msg; +} + ?>