X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_general.php;h=67efe425dd7112088e85831f336d84130775d73d;hb=4974c2a00e1d305761d51242a716e2e7e203d9ba;hp=e3493e34ad9dee48095368cd08785c306d4d7add;hpb=329a7ca54997fa9cb6a63e97897b29759d94b984;p=squirrelmail.git diff --git a/functions/imap_general.php b/functions/imap_general.php index e3493e34..67efe425 100755 --- a/functions/imap_general.php +++ b/functions/imap_general.php @@ -36,8 +36,13 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon if ($imap_stream) { $sid = sqimap_session_id($unique_id); fputs ($imap_stream, $sid . ' ' . $query . "\r\n"); - $read = sqimap_read_data_list ($imap_stream, $sid, $handle_errors, $response, $message, $query ); - return $read; + $tag_uid_a = explode(' ',trim($sid)); + $tag = $tag_uid_a[0]; + $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query ); + /* get the response and the message */ + $message = $message[$tag]; + $response = $response[$tag]; + return $read[$tag]; } else { global $squirrelmail_language, $color; set_up_language($squirrelmail_language); @@ -48,15 +53,28 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon error_box($string,$color); return false; } - } -function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) { +function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, + &$message, $unique_id = false,$filter=false, + $outputstream=false,$no_return=false) { if ($imap_stream) { $sid = sqimap_session_id($unique_id); - fputs ($imap_stream, $sid . ' ' . $query . "\r\n"); - $read = sqimap_read_data ($imap_stream, $sid, $handle_errors, $response, $message, $query); - return $read; + fputs ($imap_stream, $sid . ' ' . $query . "\r\n"); + $tag_uid_a = explode(' ',trim($sid)); + $tag = $tag_uid_a[0]; + + $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response, + $message, $query,$filter,$outputstream,$no_return); + /* retrieve the response and the message */ + $response = $response[$tag]; + $message = $message[$tag]; + + if (!empty($read[$tag])) { + return $read[$tag][0]; + } else { + return $read[$tag]; + } } else { global $squirrelmail_language, $color; set_up_language($squirrelmail_language); @@ -66,11 +84,79 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, & "\n"; error_box($string,$color); return false; + } +} +function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) { + $sid = sqimap_session_id($unique_id); + $tag_uid_a = explode(' ',trim($sid)); + $tag = $tag_uid_a[0]; + $query = $sid . ' '.$new_query."\r\n"; + $aQuery[$tag] = $query; +} + +function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors, + &$aServerResponse, &$aServerMessage, $unique_id = false, + $filter=false,$outputstream=false,$no_return=false) { + $aResponse = false; + + /* + Do not fire all calls at once to the imap-server but split the calls up + in portions of $iChunkSize. If we do not do that I think we misbehave as + IMAP client or should handle BYE calls if the IMAP-server drops the + connection because the number of queries is to large. This isn't tested + but a wild guess how it could work in the field. + + After testing it on Exchange 2000 we discovered that a chunksize of 32 + was quicker then when we raised it to 128. + */ + $iQueryCount = count($aQueryList); + $iChunkSize = 32; + // array_chunk would also do the job but it's supported from php > 4.2 + $aQueryChunks = array(); + $iLoops = floor($iQueryCount / $iChunkSize); + + if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops; + + if (!function_exists('array_chunk')) { // arraychunk replacement + reset($aQueryList); + for($i=0;$i<$iLoops;++$i) { + for($j=0;$j<$iChunkSize;++$j) { + $key = key($aQueryList); + $aTmp[$key] = $aQueryList[$key]; + if (next($aQueryList) === false) break; + } + $aQueryChunks[] = $aTmp; + } + } else { + $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true); } + for ($i=0;$i<$iLoops;++$i) { + $aQuery = $aQueryChunks[$i]; + foreach($aQuery as $tag => $query) { + fputs($imap_stream,$query); + $aResults[$tag] = false; + } + foreach($aQuery as $tag => $query) { + if ($aResults[$tag] == false) { + $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag, + $handle_errors, $response, $message, $query, + $filter,$outputstream,$no_return); + foreach ($aReturnedResponse as $returned_tag => $aResponse) { + if (!empty($aResponse)) { + $aResults[$returned_tag] = $aResponse[0]; + } else { + $aResults[$returned_tag] = $aResponse; + } + $aServerResponse[$returned_tag] = $response[$returned_tag]; + $aServerMessage[$returned_tag] = $message[$returned_tag]; + } + } + } + } + return $aResults; } - /* * custom fgets function. gets a line from IMAP * no matter how big it may be @@ -96,21 +182,163 @@ function sqimap_fgets($imap_stream) { return $results; } +function sqimap_fread($imap_stream,$iSize,$filter=false, + $outputstream=false, $no_return=false) { + if (!$filter || !$outputstream) { + $iBufferSize = $iSize; + } else { + $iBufferSize = 62400; // multiple of 78 in case of base64 decoding. + } + $iRet = $iSize - $iBufferSize; + $iRetrieved = 0; + $i = 0; + $results = $sReadRem = ''; + $bFinished = $bBufferSizeAdapted = $bBufferIsOk = false; + while (($iRetrieved < ($iSize - $iBufferSize))) { + $sRead = fread($imap_stream,$iBufferSize); + if (!$sRead) { + $results = false; + break; + } + $iRetrieved += $iBufferSize; + // if the returned lines are split, do not end with \n + // then we have a problem and need to adjust (happened with uw) + if ($bBufferSizeAdapted && substr($sRead,-1) !== "\n") { + // use fgets because it stops at \n. + // we can do it because it's for correction + $sRead .= fgets($imap_stream,$iBufferSize); + $iRetrieved += strlen($sRead); + if ($iRetrieved == $iSize) { + $bFinished = true; + } + } + if ($filter) { + // in case line-endings do not appear at position 78 we adapt the buffersize so we can base64 decode on the fly + if (!$bBufferSizeAdapted) { + $i = strpos($sRead,"\n"); + if ($i) { + ++$i; + $iFragments = floor($iBufferSize / $i); + $iNewBufferSize = $iFragments * $i; + $iRemainder = $iNewBufferSize + $i - $iBufferSize; + if ($iNewBufferSize == $iBufferSize) { + $bBufferIsOk = true; + $iRemainder = 0; + $iNewBufferSize = $iBufferSize; + $bBufferSizeAdapted = true; + } + if (!$bBufferIsOk && ($iRemainder + $iBufferSize) < $iSize) { + $sReadRem = fread($imap_stream,$iRemainder); + } else if (!$bBufferIsOk) { + $sReadRem = fread($imap_stream,$iSize - $iBufferSize); + $bFinished = true; + } + if (!$sReadRem && $sReadRem !== '') { + $results = false; + break; + } + $iBufferSize = $iNewBufferSize; + $bBufferSizeAdapted = true; + } else { + $sReadRem = fread($imap_stream,$iSize - $iBufferSize); + $bFinished = true; + if (!$sReadRem) { + $results = false; + break; + } + } + $sRead .= $sReadRem; + $iRetrieved += $iRemainder; + unset($sReadRem); + } + $filter($sRead); + } + if ($outputstream) { + if (is_resource($outputstream)) { + fwrite($outputstream,$sRead); + } else if ($outputstream == 'php://stdout') { + echo $sRead; + } + } + if ($no_return) { + $sRead = ''; + } + $results .= $sRead; + } + if (!$results && !$bFinished) { + $sRead = fread($imap_stream,($iSize - ($iRetrieved))); + if ($filter) { + $filter($sRead); + } + if ($outputstream) { + if (is_resource($outputstream)) { + fwrite($outputstream,$sRead); + } else if ($outputstream == 'php://stdout') { // FIXME + echo $sRead; + } + } + if ($no_return) { + $sRead = ''; + } + $results .= $sRead; + } + return $results; +} +/* obsolete function, inform plugins that use it */ +function sqimap_read_data_list($imap_stream, $tag, $handle_errors, + &$response, &$message, $query = '') { + global $color, $squirrelmail_language; + set_up_language($squirrelmail_language); + require_once(SM_PATH . 'functions/display_messages.php'); + $string = "\n" . + _("ERROR : Bad function call.") . + "
\n" . + _("Reason:") . ' '. + 'There is a plugin installed which make use of the
' . + 'SquirrelMail internal function sqimap_read_data_list.
'. + 'Please adapt the installed plugin and let it use
'. + 'sqimap_run_command or sqimap_run_command_list instead

'. + 'The following query was issued:
'. + htmlspecialchars($query) . '
' . "
\n"; + error_box($string,$color); + echo ''; + exit; +} + +function sqimap_error_box($title, $query = '', $message_title = '', $message = '') +{ + global $color, $squirrelmail_language; + + set_up_language($squirrelmail_language); + require_once(SM_PATH . 'functions/display_messages.php'); + $string = "\n" . $title . "
\n"; + if ($query != '') + $string .= _("Query:") . ' ' . htmlspecialchars($query) . '
'; + if ($message_title != '') + $string .= $message_title; + if ($message != '') + $string .= htmlspecialchars($message); + $string .= "
\n"; + error_box($string,$color); +} + /* * Reads the output from the IMAP stream. If handle_errors is set to true, * this will also handle all errors that are received. If it is not set, * the errors will be sent back through $response and $message */ -function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$response, &$message, $query = '') { +function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, + &$response, &$message, $query = '', + $filter = false, $outputstream = false, $no_return = false) { global $color, $squirrelmail_language; $read = ''; - $tag_uid_a = explode(' ',trim($tag_uid)); - $tag = $tag_uid_a[0]; + if (!is_array($message)) $message = array(); + if (!is_array($response)) $response = array(); $resultlist = array(); $data = array(); $read = sqimap_fgets($imap_stream); - $i = 0; + $i = $k = 0; while ($read) { $char = $read{0}; switch ($char) @@ -130,7 +358,7 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon $arg = substr($s,0,$j); } $found_tag = substr($read,0,$i-1); - if ($arg && $found_tag==$tag) { + if ($found_tag) { switch ($arg) { case 'OK': @@ -138,21 +366,36 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon case 'NO': case 'BYE': case 'PREAUTH': - $response = $arg; - $message = trim(substr($read,$i+strlen($arg))); - break 3; /* switch switch while */ + $response[$found_tag] = $arg; + $message[$found_tag] = trim(substr($read,$i+strlen($arg))); + if (!empty($data)) { + $resultlist[] = $data; + } + $aResponse[$found_tag] = $resultlist; + $data = $resultlist = array(); + if ($found_tag == $tag) { + break 3; /* switch switch while */ + } + break; default: /* this shouldn't happen */ - $response = $arg; - $message = trim(substr($read,$i+strlen($arg))); - break 3; /* switch switch while */ + $response[$found_tag] = $arg; + $message[$found_tag] = trim(substr($read,$i+strlen($arg))); + if (!empty($data)) { + $resultlist[] = $data; + } + $aResponse[$found_tag] = $resultlist; + $data = $resultlist = array(); + if ($found_tag == $tag) { + break 3; /* switch switch while */ + } } - } elseif($found_tag !== $tag) { - /* reset data array because we do not need this reponse */ - $data = array(); - $read = sqimap_fgets($imap_stream); - break; } + $read = sqimap_fgets($imap_stream); + if ($read === false) { /* error */ + break 3; /* switch switch while */ + } + break; } // end case $tag{0} case '*': @@ -171,7 +414,7 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon $j = strrpos($read,'{'); $iLit = substr($read,$j+1,-3); $fetch_data[] = $read; - $sLiteral = fread($imap_stream,$iLit); + $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return); if ($sLiteral === false) { /* error */ break 4; /* while while switch while */ } @@ -224,7 +467,7 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon break 3; /* while switch while */ } $data[] = $sLiteral; - $fetch_data[] = sqimap_fgets($imap_stream); + $data[] = sqimap_fgets($imap_stream); } else { $data[] = $read; } @@ -237,7 +480,7 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon $s = substr($read,-3); } while ($s === "}\r\n"); break 1; - } + } break; } // end case '*' } // end switch @@ -246,20 +489,13 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon /* error processing in case $read is false */ if ($read === false) { unset($data); - set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . - _("ERROR : Connection dropped by imap-server.") . - "
\n" . - _("Query:") . ' '. - htmlspecialchars($query) . '
' . "
\n"; - error_box($string,$color); + sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query); exit; } /* Set $resultlist array */ if (!empty($data)) { - $resultlist[] = $data; + //$resultlist[] = $data; } elseif (empty($resultlist)) { $resultlist[] = array(); @@ -267,79 +503,49 @@ function sqimap_read_data_list ($imap_stream, $tag_uid, $handle_errors, &$respon /* Return result or handle errors */ if ($handle_errors == false) { - return( $resultlist ); + return $aResponse; + return( $resultlist ); //?? Why this? } - switch ($response) - { + switch ($response[$tag]) { case 'OK': - return $resultlist; + return $aResponse; break; case 'NO': /* ignore this error from M$ exchange, it is not fatal (aka bug) */ - if (strstr($message, 'command resulted in') === false) { - set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . - _("ERROR : Could not complete request.") . - "
\n" . - _("Query:") . ' ' . - htmlspecialchars($query) . '
' . - _("Reason Given: ") . - htmlspecialchars($message) . "
\n"; - error_box($string,$color); + if (strstr($message[$tag], 'command resulted in') === false) { + sqimap_error_box(_("ERROR : Could not complete request."), $query, _("Reason Given: "), $message[$tag]); echo ''; exit; } break; case 'BAD': - set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . - _("ERROR : Bad or malformed request.") . - "
\n" . - _("Query:") . ' '. - htmlspecialchars($query) . '
' . - _("Server responded: ") . - htmlspecialchars($message) . "
\n"; - error_box($string,$color); + sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]); echo ''; exit; case 'BYE': - set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . - _("ERROR : Imap server closed the connection.") . - "
\n" . - _("Query:") . ' '. - htmlspecialchars($query) . '
' . - _("Server responded: ") . - htmlspecialchars($message) . "
\n"; - error_box($string,$color); + sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]); echo ''; exit; default: - set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . - _("ERROR : Unknown imap response.") . - "
\n" . - _("Query:") . ' '. - htmlspecialchars($query) . '
' . - _("Server responded: ") . - htmlspecialchars($message) . "
\n"; - error_box($string,$color); + sqimap_error_box(_("ERROR : Unknown imap response."), $query, _("Server responded: "), $message[$tag]); /* the error is displayed but because we don't know the reponse we return the result anyway */ - return $resultlist; + return $aResponse; break; } } -function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, &$response, &$message, $query = '') { - $res = sqimap_read_data_list($imap_stream, $tag_uid, $handle_errors, $response, $message, $query); - +function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, + &$response, &$message, $query = '', + $filter=false,$outputstream=false,$no_return=false) { + + $tag_uid_a = explode(' ',trim($tag_uid)); + $tag = $tag_uid_a[0]; + + $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, + $response, $message, $query,$filter,$outputstream,$no_return); /* sqimap_read_data should be called for one response - but since it just calls sqimap_read_data_list which + but since it just calls sqimap_retrieve_imap_response which handles multiple responses we need to check for that and merge the $res array IF they are seperated and IF it was a FETCH response. */ @@ -352,12 +558,11 @@ function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, &$response, & // } // } if (isset($result)) { - return $result; + return $result[$tag]; } else { - return $res[0]; + return $res; } - } /* @@ -574,9 +779,17 @@ function sqimap_get_delimiter ($imap_stream = false) { } +function sqimap_encode_mailbox_name($what) +{ + if (ereg("[\"\\\r\n]", $what)) + return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */ + return '"' . $what . '"'; /* 4.3 quoted string form */ +} + + /* Gets the number of messages in the current mailbox. */ function sqimap_get_num_messages ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command ($imap_stream, "EXAMINE \"$mailbox\"", false, $result, $message); + $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message); for ($i = 0; $i < count($read_ary); $i++) { if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) { return $regs[1]; @@ -593,7 +806,7 @@ function parseAddress($address, $max=0) { $aSpecials = array('(' ,'<' ,',' ,';' ,':'); $aReplace = array(' (',' <',' ,',' ;',' :'); $address = str_replace($aSpecials,$aReplace,$address); - $i = 0; + $i = $iAddrFound = $bGroup = 0; while ($i < $iCnt) { $cChar = $address{$i}; switch($cChar) @@ -612,6 +825,18 @@ function parseAddress($address, $max=0) { break; case '"': $iEnd = strpos($address,$cChar,$i+1); + if ($iEnd) { + // skip escaped quotes + $prev_char = $address{$iEnd-1}; + while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') { + $iEnd = strpos($address,$cChar,$iEnd+1); + if ($iEnd) { + $prev_char = $address{$iEnd-1}; + } else { + $prev_char = false; + } + } + } if (!$iEnd) { $sToken = substr($address,$i); $i = $iCnt; @@ -621,7 +846,7 @@ function parseAddress($address, $max=0) { $i = $iEnd; } $sToken = str_replace($aReplace, $aSpecials,$sToken); - $aTokens[] = $sToken; + if ($sToken) $aTokens[] = $sToken; break; case '(': $iEnd = strpos($address,')',$i); @@ -636,8 +861,21 @@ function parseAddress($address, $max=0) { $aTokens[] = $sToken; break; case ',': + ++$iAddrFound; case ';': - case ';': + if (!$bGroup) { + ++$iAddrFound; + } else { + $bGroup = false; + } + if ($max && $max == $iAddrFound) { + break 2; + } else { + $aTokens[] = $cChar; + break; + } + case ':': + $bGroup = true; case ' ': $aTokens[] = $cChar; break; @@ -736,7 +974,7 @@ function parseAddress($address, $max=0) { * Returns the number of unseen messages in this folder */ function sqimap_unseen_messages ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (UNSEEN)", false, $result, $message); + $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (UNSEEN)', false, $result, $message); $i = 0; $regs = array(false, false); while (isset($read_ary[$i])) { @@ -749,10 +987,10 @@ function sqimap_unseen_messages ($imap_stream, $mailbox) { } /* - * Returns the number of unseen/total messages in this folder + * Returns the number of total/unseen/recent messages in this folder */ function sqimap_status_messages ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (MESSAGES UNSEEN RECENT)", false, $result, $message); + $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (MESSAGES UNSEEN RECENT)', false, $result, $message); $i = 0; $messages = $unseen = $recent = false; $regs = array(false,false); @@ -776,7 +1014,7 @@ function sqimap_status_messages ($imap_stream, $mailbox) { * Saves a message to a given folder -- used for saving sent messages */ function sqimap_append ($imap_stream, $sent_folder, $length) { - fputs ($imap_stream, sqimap_session_id() . " APPEND \"$sent_folder\" (\\Seen) \{$length}\r\n"); + fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) \{$length}\r\n"); $tmp = fgets ($imap_stream, 1024); }