X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_general.php;h=4bf4151e25b5ff63ca3779c47349f22fca7374bb;hb=d0b119a5463cbdf99e4cef5079e840706995cb79;hp=adad93496b55700c6622fa4682b70b3f65cb12f5;hpb=fe55c7c794596d1febd00277d989bb09fe1dcc1f;p=squirrelmail.git diff --git a/functions/imap_general.php b/functions/imap_general.php index adad9349..4bf4151e 100755 --- a/functions/imap_general.php +++ b/functions/imap_general.php @@ -3,24 +3,33 @@ /** * imap_general.php * - * Copyright (c) 1999-2003 The SquirrelMail Project Team + * Copyright (c) 1999-2005 The SquirrelMail Project Team * Licensed under the GNU GPL. For full terms see the file COPYING. * * This implements all functions that do general imap functions. * - * $Id$ + * @version $Id$ + * @package squirrelmail + * @subpackage imap */ +/** Includes.. */ require_once(SM_PATH . 'functions/page_header.php'); require_once(SM_PATH . 'functions/auth.php'); -global $sqimap_session_id; -$sqimap_session_id = 1; +/** + * Generates a new session ID by incrementing the last one used; + * this ensures that each command has a unique ID. + * @param bool $unique_id (since 1.3.0) controls use of unique + * identifiers/message sequence numbers in IMAP commands. See IMAP + * rfc 'UID command' chapter. + * @return string IMAP session id of the form 'A000'. + * @since 1.2.0 + */ +function sqimap_session_id($unique_id = FALSE) { + static $sqimap_session_id = 1; -/* Sets an unique session id in order to avoid simultanous sessions crash. */ -function sqimap_session_id($unique_id = false) { - global $data_dir, $username, $sqimap_session_id; if (!$unique_id) { return( sprintf("A%03d", $sqimap_session_id++) ); } else { @@ -28,9 +37,18 @@ function sqimap_session_id($unique_id = false) { } } -/* +/** * Both send a command and accept the result from the command. * This is to allow proper session number handling. + * @param stream $imap_stream imap connection resource + * @param string $query imap command + * @param boolean $handle_errors see sqimap_retrieve_imap_response() + * @param array $response + * @param array $message + * @param boolean $unique_id (since 1.3.0) see sqimap_session_id(). + * @return mixed returns false on imap error. displays error message + * if imap stream is not available. + * @since 1.2.3 */ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) { if ($imap_stream) { @@ -41,13 +59,13 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon $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]; + $response = $response[$tag]; return $read[$tag]; } else { global $squirrelmail_language, $color; set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . + $string = "\n" . _("ERROR : No available imapstream.") . "\n"; error_box($string,$color); @@ -55,21 +73,40 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon } } -function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, +/** + * @param stream $imap_stream imap connection resource + * @param string $query imap command + * @param boolean $handle_errors see sqimap_retrieve_imap_response() + * @param array $response empty string, if return = false + * @param array $message empty string, if return = false + * @param boolean $unique_id (since 1.3.0) see sqimap_session_id() + * @param boolean $filter (since 1.4.1 and 1.5.0) see sqimap_fread() + * @param mixed $outputstream (since 1.4.1 and 1.5.0) see sqimap_fread() + * @param boolean $no_return (since 1.4.1 and 1.5.0) see sqimap_fread() + * @return mixed returns false on imap error. displays error message + * if imap stream is not available. + * @since 1.2.3 + */ +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"); + 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); + if (empty($read)) { //Imap server dropped its connection + $response = ''; + $message = ''; + return false; + } /* retrieve the response and the message */ $response = $response[$tag]; $message = $message[$tag]; - + if (!empty($read[$tag])) { return $read[$tag][0]; } else { @@ -79,13 +116,21 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, global $squirrelmail_language, $color; set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . + $string = "\n" . _("ERROR : No available imapstream.") . "\n"; error_box($string,$color); return false; - } + } } + +/** + * @param mixed $new_query + * @param string $tag + * @param array $aQuery + * @param boolean $unique_id see sqimap_session_id() + * @since 1.5.0 + */ function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) { $sid = sqimap_session_id($unique_id); $tag_uid_a = explode(' ',trim($sid)); @@ -94,19 +139,31 @@ function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) { $aQuery[$tag] = $query; } -function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors, +/** + * @param stream $imap_stream imap stream + * @param array $aQueryList + * @param boolean $handle_errors + * @param array $aServerResponse + * @param array $aServerMessage + * @param boolean $unique_id see sqimap_session_id() + * @param boolean $filter see sqimap_fread() + * @param mixed $outputstream see sqimap_fread() + * @param boolean $no_return see sqimap_fread() + * @since 1.5.0 + */ +function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors, &$aServerResponse, &$aServerMessage, $unique_id = false, - $filter=false,$outputstream=false,$no_return=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 + 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 + + 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); @@ -126,11 +183,11 @@ function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors 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) { @@ -139,7 +196,7 @@ function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors } foreach($aQuery as $tag => $query) { if ($aResults[$tag] == false) { - $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag, + $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query, $filter,$outputstream,$no_return); foreach ($aReturnedResponse as $returned_tag => $aResponse) { @@ -157,11 +214,13 @@ function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors return $aResults; } -/* - * custom fgets function. gets a line from IMAP - * no matter how big it may be +/** + * Custom fgets function: gets a line from the IMAP-server, + * no matter how big it may be. + * @param stream $imap_stream the stream to read from + * @return string a line + * @since 1.2.8 */ - function sqimap_fgets($imap_stream) { $read = ''; $buffer = 4096; @@ -182,6 +241,15 @@ function sqimap_fgets($imap_stream) { return $results; } +/** + * @param stream $imap_stream + * @param integer $iSize + * @param boolean $filter + * @param mixed $outputstream stream or 'php://stdout' string + * @param boolean $no_return controls data returned by function + * @return string + * @since 1.4.1 + */ function sqimap_fread($imap_stream,$iSize,$filter=false, $outputstream=false, $no_return=false) { if (!$filter || !$outputstream) { @@ -193,10 +261,11 @@ function sqimap_fread($imap_stream,$iSize,$filter=false, if ($iSize < $iBufferSize) { $iBufferSize = $iSize; } + $iRetrieved = 0; $results = ''; $sRead = $sReadRem = ''; - // NB: fread can also stop at end of a packet on sockets. + // NB: fread can also stop at end of a packet on sockets. while ($iRetrieved < $iSize) { $sRead = fread($imap_stream,$iBufferSize); $iLength = strlen($sRead); @@ -205,29 +274,20 @@ function sqimap_fread($imap_stream,$iSize,$filter=false, if ($iRemaining < $iBufferSize) { $iBufferSize = $iRemaining; } - if (!$sRead) { + if ($sRead == '') { $results = false; break; } - if ($sReadRem) { + if ($sReadRem != '') { $sRead = $sReadRem . $sRead; $sReadRem = ''; } - if (substr($sRead,-1) !== "\n") { - $i = strrpos($sRead,"\n"); - if ($i !== false && $iRetrieved<$iSize) { - ++$i; - $sReadRem = substr($sRead,$i); - $sRead = substr($sRead,0,$i); - } else if ($iLength && $iRetrieved<$iSize) { // linelength > received buffer - $sReadRem = $sRead; - $sRead = ''; - } - } - if ($filter && $sRead) { - $filter($sRead); + + if ($filter && $sRead != '') { + // in case the filter is base64 decoding we return a remainder + $sReadRem = $filter($sRead); } - if ($outputstream && $sRead) { + if ($outputstream && $sRead != '') { if (is_resource($outputstream)) { fwrite($outputstream,$sRead); } else if ($outputstream == 'php://stdout') { @@ -236,71 +296,104 @@ function sqimap_fread($imap_stream,$iSize,$filter=false, } if ($no_return) { $sRead = ''; - } else { + } else { $results .= $sRead; } } - return $results; -} + return $results; +} + -/* obsolete function, inform plugins that use it */ -function sqimap_read_data_list($imap_stream, $tag, $handle_errors, +/** + * Obsolete function, inform plugins that use it + * @param stream $imap_stream + * @param string $tag + * @param boolean $handle_errors + * @param array $response + * @param array $message + * @param string $query + * @since 1.1.3 + * @deprecated (since 1.5.0) use sqimap_run_command or sqimap_run_command_list instead + */ +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" . + $string = "\n" . _("ERROR : Bad function call.") . - "
\n" . + "
\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"; + '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; + echo ''; + exit; } -function sqimap_error_box($title, $query = '', $message_title = '', $message = '') +/** + * Function to display an error related to an IMAP-query. + * @param string title the caption of the error box + * @param string query the query that went wrong + * @param string message_title optional message title + * @param string message optional error message + * @param string $link an optional link to try again + * @return void + * @since 1.5.0 + */ +function sqimap_error_box($title, $query = '', $message_title = '', $message = '', $link = '') { global $color, $squirrelmail_language; set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); - $string = "\n" . $title . "
\n"; + $string = "\n" . $title . "
\n"; $cmd = explode(' ',$query); $cmd= strtolower($cmd[0]); if ($query != '' && $cmd != 'login') - $string .= _("Query:") . ' ' . htmlspecialchars($query) . '
'; + $string .= _("Query:") . ' ' . htmlspecialchars($query) . '
'; if ($message_title != '') $string .= $message_title; if ($message != '') $string .= htmlspecialchars($message); - $string .= "
\n"; + $string .= "
\n"; + if ($link != '') + $string .= $link; 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 + * the errors will be sent back through $response and $message. + * @param stream $imap_stream imap stream + * @param string $tag + * @param boolean $handle_errors handle errors internally or send them in $response and $message. + * @param array $response + * @param array $message + * @param string $query command that can be printed if something fails + * @param boolean $filter see sqimap_fread() + * @param mixed $outputstream see sqimap_fread() + * @param boolean $no_return see sqimap_fread() + * @since 1.5.0 */ - -function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, +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 = ''; if (!is_array($message)) $message = array(); if (!is_array($response)) $response = array(); + $aResponse = ''; $resultlist = array(); $data = array(); $read = sqimap_fgets($imap_stream); - $i = $k = 0; + $i = 0; while ($read) { $char = $read{0}; switch ($char) @@ -339,7 +432,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, break 3; /* switch switch while */ } break; - default: + default: /* this shouldn't happen */ $response[$found_tag] = $arg; $message[$found_tag] = trim(substr($read,$i+strlen($arg))); @@ -355,7 +448,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, } $read = sqimap_fgets($imap_stream); if ($read === false) { /* error */ - break 3; /* switch switch while */ + break 2; /* switch while */ } break; } // end case $tag{0} @@ -388,7 +481,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, $fetch_data[] = $line ."\n"; } /* release not neaded data */ - unset($aLiteral); + unset($aLiteral); /* next fgets belongs to this fetch because we just got the exact literalsize and there must follow data to complete the response */ @@ -442,37 +535,47 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, $s = substr($read,-3); } while ($s === "}\r\n"); break 1; - } + } break; } // end case '*' } // end switch } // end while - + /* error processing in case $read is false */ if ($read === false) { - unset($data); - sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query); - exit; + // try to retrieve an untagged bye respons from the results + $sResponse = array_pop($data); + if ($sResponse !== NULL && strpos($sResponse,'* BYE') !== false) { + if (!$handle_errors) { + $query = ''; + } + sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded:"),$sResponse); + echo ''; + exit; + } else if ($handle_errors) { + unset($data); + sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query); + exit; + } } - + /* Set $resultlist array */ if (!empty($data)) { //$resultlist[] = $data; } elseif (empty($resultlist)) { - $resultlist[] = array(); + $resultlist[] = array(); } /* Return result or handle errors */ if ($handle_errors == false) { return $aResponse; - return( $resultlist ); //?? Why this? } switch ($response[$tag]) { case 'OK': return $aResponse; break; - case 'NO': + case 'NO': /* ignore this error from M$ exchange, it is not fatal (aka bug) */ if (strstr($message[$tag], 'command resulted in') === false) { sqimap_error_box(_("ERROR : Could not complete request."), $query, _("Reason Given: "), $message[$tag]); @@ -480,93 +583,95 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, exit; } break; - case 'BAD': + case 'BAD': sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]); - echo ''; - exit; - case 'BYE': + echo ''; + exit; + case 'BYE': sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]); - echo ''; + echo ''; exit; - default: + default: 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 $aResponse; + return $aResponse; break; } } -function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, +/** + * @param stream $imap_stream imap string + * @param string $tag_uid + * @param boolean $handle_errors + * @param array $response + * @param array $message + * @param string $query (since 1.2.5) + * @param boolean $filter (since 1.4.1) see sqimap_fread() + * @param mixed $outputstream (since 1.4.1) see sqimap_fread() + * @param boolean $no_return (since 1.4.1) see sqimap_fread() + */ +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_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. */ - -// if (isset($res[1]) && is_array($res[1]) && isset($res[1][0]) -// && preg_match('/^\* \d+ FETCH/', $res[1][0])) { -// $result = array(); -// foreach($res as $index=>$value) { -// $result = array_merge($result, $res["$index"]); -// } -// } - if (isset($result)) { - return $result[$tag]; - } - else { - return $res; - } + $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, + $response, $message, $query,$filter,$outputstream,$no_return); + return $res; } -/** sqimap_create_stream() - * @return imap-stream resource identifier +/** * Connects to the IMAP server and returns a resource identifier for use with * the other SquirrelMail IMAP functions. Does NOT login! + * @param string server hostname of IMAP server + * @param int port port number to connect to + * @param bool tls whether to use TLS when connecting. + * @return imap-stream resource identifier + * @since 1.5.0 (usable only in 1.5.1 or later) */ function sqimap_create_stream($server,$port,$tls=false) { - global $username, $use_imap_tls; + global $squirrelmail_language; - if ($use_imap_tls == true) { + if ($tls == true) { if ((check_php_version(4,3)) and (extension_loaded('openssl'))) { /* Use TLS by prefixing "tls://" to the hostname */ - $server = 'tls://' . $imap_server_address; + $server = 'tls://' . $server; } else { require_once(SM_PATH . 'functions/display_messages.php'); - $string = "Unable to connect to IMAP server!
TLS is enabled, but this " . - "version of PHP does not support TLS sockets, or is missing the openssl " . - "extension.

Please contact your system administrator."; - logout_error($string,$color); + logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). + '
'. + _("TLS is enabled, but this version of PHP does not support TLS sockets, or is missing the openssl extension."). + '

'. + _("Please contact your system administrator and report this error.") ); } } - $imap_stream = fsockopen($server, $port, $error_number, $error_string, 15); + $imap_stream = @fsockopen($server, $port, $error_number, $error_string, 15); /* Do some error correction */ if (!$imap_stream) { set_up_language($squirrelmail_language, true); require_once(SM_PATH . 'functions/display_messages.php'); - $string = sprintf (_("Error connecting to IMAP server: %s.") . - "
\r\n", $server) . - "$error_number : $error_string
\r\n"; - logout_error($string,$color); + logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). + "
\r\n$error_number : $error_string
\r\n" ); exit; } $server_info = fgets ($imap_stream, 1024); return $imap_stream; } -/* +/** * Logs the user into the imap server. If $hide is set, no error messages * will be displayed. This function returns the imap connection handle. + * @param string $username user name + * @param string $password encrypted password + * @param string $imap_server_address address of imap server + * @param integer $imap_port port of imap server + * @param boolean $hide controls display connection errors + * @return stream */ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) { global $color, $squirrelmail_language, $onetimepad, $use_imap_tls, @@ -588,7 +693,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ $password = OneTimePadDecrypt($password, $onetimepad); if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) { - // We're using some sort of authentication OTHER than plain or login + // We're using some sort of authentication OTHER than plain or login $tag=sqimap_session_id(false); if ($imap_auth_mech == 'digest-md5') { $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n"; @@ -610,7 +715,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ fputs($imap_stream,$reply); $read=sqimap_fgets($imap_stream); if ($imap_auth_mech == 'digest-md5') { - // DIGEST-MD5 has an extra step.. + // DIGEST-MD5 has an extra step.. if (substr($read,0,1) == '+') { // OK so far.. fputs($imap_stream,"\r\n"); $read=sqimap_fgets($imap_stream); @@ -620,7 +725,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ $response=$results[1]; $message=$results[2]; } else { - // Fake the response, so the error trap at the bottom will work + // Fake the response, so the error trap at the bottom will work $response="BAD"; $message='IMAP server does not appear to support the authentication method selected.'; $message .= ' Please contact your system administrator.'; @@ -645,11 +750,11 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ * **/ $tag=sqimap_session_id(false); - $sasl = (isset($capability['SASL']) && $capability['SASL']) ? true : false; + $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ? true : false; $auth = base64_encode("$username\0$username\0$password"); if ($sasl) { // IMAP Extension for SASL Initial Client Response - // + // $query = $tag . " AUTHENTICATE PLAIN $auth\r\n"; fputs($imap_stream, $query); $read = sqimap_fgets($imap_stream); @@ -679,14 +784,14 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ set_up_language($squirrelmail_language, true); require_once(SM_PATH . 'functions/display_messages.php'); if ($response == 'BAD') { - $string = sprintf (_("Bad request: %s")."
\r\n", $message); + $string = sprintf (_("Bad request: %s")."
\r\n", $message); } else { - $string = sprintf (_("Unknown error: %s") . "
\n", $message); + $string = sprintf (_("Unknown error: %s") . "
\n", $message); } if (isset($read) && is_array($read)) { - $string .= '
' . _("Read data:") . "
\n"; + $string .= '
' . _("Read data:") . "
\n"; foreach ($read as $line) { - $string .= htmlspecialchars($line) . "
\n"; + $string .= htmlspecialchars($line) . "
\n"; } } error_box($string,$color); @@ -706,6 +811,8 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ set_up_language($squirrelmail_language, true); include_once(SM_PATH . 'functions/display_messages.php' ); sqsession_destroy(); + /* terminate the session nicely */ + sqimap_logout($imap_stream); logout_error( _("Unknown user or password incorrect.") ); exit; } @@ -713,10 +820,30 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ exit; } } + + /* Special error case: + * Login referrals. The server returns: + * ? OK [REFERRAL ] + * Check RFC 2221 for details. Since we do not support login referrals yet + * we log the user out. + */ + if ( stristr($message, 'REFERRAL imap') === TRUE ) { + sqimap_logout($imap_stream); + set_up_language($squirrelmail_language, true); + include_once(SM_PATH . 'functions/display_messages.php' ); + sqsession_destroy(); + logout_error( _("Your mailbox is not located at this server. Try a different server or consult your system administrator") ); + exit; + } + return $imap_stream; } -/* Simply logs out the IMAP session */ +/** + * Simply logs out the IMAP session + * @param stream $imap_stream the IMAP connection to log out. + * @return void + */ function sqimap_logout ($imap_stream) { /* Logout is not valid until the server returns 'BYE' * If we don't have an imap_ stream we're already logged out */ @@ -724,6 +851,16 @@ function sqimap_logout ($imap_stream) { sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message); } +/** + * Retrieve the CAPABILITY string from the IMAP server. + * If capability is set, returns only that specific capability, + * else returns array of all capabilities. + * @param stream $imap_stream + * @param string $capability (optional since 1.3.0) + * @return mixed (string if $capability is set and found, + * false, if $capability is set and not found, + * array if $capability not set) + */ function sqimap_capability($imap_stream, $capability='') { global $sqimap_capabilities; if (!is_array($sqimap_capabilities)) { @@ -733,6 +870,8 @@ function sqimap_capability($imap_stream, $capability='') { for ($i=2; $i < count($c); $i++) { $cap_list = explode('=', $c[$i]); if (isset($cap_list[1])) { + // FIX ME. capabilities can occure multiple times. + // THREAD=REFERENCES THREAD=ORDEREDSUBJECT $sqimap_capabilities[$cap_list[0]] = $cap_list[1]; } else { $sqimap_capabilities[$cap_list[0]] = TRUE; @@ -749,7 +888,11 @@ function sqimap_capability($imap_stream, $capability='') { return $sqimap_capabilities; } -/* Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test */ +/** + * Returns the delimiter between mailboxes: INBOX/Test, or INBOX.Test + * @param stream $imap_stream + * @return string + */ function sqimap_get_delimiter ($imap_stream = false) { global $sqimap_delimiter, $optional_delimiter; @@ -787,7 +930,7 @@ function sqimap_get_delimiter ($imap_stream = false) { } else { fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n"); $read = sqimap_read_data($imap_stream, '.', true, $a, $b); - $read = $read['.'][0]; //sqimap_read_data() now returns a tag array of response array + $read = $read['.'][0]; //sqimap_read_data() now returns a tag array of response array $quote_position = strpos ($read[0], '"'); $sqimap_delimiter = substr ($read[0], $quote_position+1, 1); } @@ -795,16 +938,27 @@ function sqimap_get_delimiter ($imap_stream = false) { return $sqimap_delimiter; } - +/** + * This encodes a mailbox name for use in IMAP commands. + * @param string $what the mailbox to encode + * @return string the encoded mailbox string + * @since 1.5.0 + */ 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 */ + 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. */ +/** + * Gets the number of messages in the current mailbox. + * + * OBSOLETE use sqimap_status_messages instead. + * @param stream $imap_stream imap stream + * @param string $mailbox + * @deprecated + */ function sqimap_get_num_messages ($imap_stream, $mailbox) { $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message); for ($i = 0; $i < count($read_ary); $i++) { @@ -815,201 +969,82 @@ function sqimap_get_num_messages ($imap_stream, $mailbox) { return false; //"BUG! Couldn't get number of messages in $mailbox!"; } +/** FIXME: include is inserted in the middle of the code */ +include_once(SM_PATH . 'functions/rfc822address.php'); +/** + * OBSOLETE FUNCTION should be removed after mailbox_display, + * printMessage function is adapted + * $addr_ar = array(), $group = '' and $host='' arguments are used in 1.4.0 + * @param string $address + * @param integer $max + * @since 1.4.0 + * @deprecated See Rfc822Address.php + */ function parseAddress($address, $max=0) { - $aTokens = array(); - $aAddress = array(); - $iCnt = strlen($address); - $aSpecials = array('(' ,'<' ,',' ,';' ,':'); - $aReplace = array(' (',' <',' ,',' ;',' :'); - $address = str_replace($aSpecials,$aReplace,$address); - $i = $iAddrFound = $bGroup = 0; - while ($i < $iCnt) { - $cChar = $address{$i}; - switch($cChar) - { - case '<': - $iEnd = strpos($address,'>',$i+1); - if (!$iEnd) { - $sToken = substr($address,$i); - $i = $iCnt; - } else { - $sToken = substr($address,$i,$iEnd - $i +1); - $i = $iEnd; - } - $sToken = str_replace($aReplace, $aSpecials,$sToken); - $aTokens[] = $sToken; - 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; - } else { - // also remove the surrounding quotes - $sToken = substr($address,$i+1,$iEnd - $i -1); - $i = $iEnd; - } - $sToken = str_replace($aReplace, $aSpecials,$sToken); - if ($sToken) $aTokens[] = $sToken; - break; - case '(': - $iEnd = strpos($address,')',$i); - if (!$iEnd) { - $sToken = substr($address,$i); - $i = $iCnt; - } else { - $sToken = substr($address,$i,$iEnd - $i + 1); - $i = $iEnd; - } - $sToken = str_replace($aReplace, $aSpecials,$sToken); - $aTokens[] = $sToken; - break; - case ',': - ++$iAddrFound; - case ';': - if (!$bGroup) { - ++$iAddrFound; - } else { - $bGroup = false; - } - if ($max && $max == $iAddrFound) { - break 2; - } else { - $aTokens[] = $cChar; - break; - } - case ':': - $bGroup = true; - case ' ': - $aTokens[] = $cChar; - break; - default: - $iEnd = strpos($address,' ',$i+1); - if ($iEnd) { - $sToken = trim(substr($address,$i,$iEnd - $i)); - $i = $iEnd-1; - } else { - $sToken = trim(substr($address,$i)); - $i = $iCnt; - } - if ($sToken) $aTokens[] = $sToken; - } - ++$i; - } - $sPersonal = $sEmail = $sComment = $sGroup = ''; - $aStack = $aComment = array(); - foreach ($aTokens as $sToken) { - if ($max && $max == count($aAddress)) { - return $aAddress; - } - $cChar = $sToken{0}; - switch ($cChar) - { - case '=': - case '"': - case ' ': - $aStack[] = $sToken; - break; - case '(': - $aComment[] = substr($sToken,1,-1); - break; - case ';': - if ($sGroup) { - $sEmail = trim(implode(' ',$aStack)); - $aAddress[] = array($sGroup,$sEmail); - $aStack = $aComment = array(); - $sGroup = ''; - break; - } - case ',': - if (!$sEmail) { - while (count($aStack) && !$sEmail) { - $sEmail = trim(array_pop($aStack)); - } - } - if (count($aStack)) { - $sPersonal = trim(implode('',$aStack)); - } else { - $sPersonal = ''; - } - if (!$sPersonal && count($aComment)) { - $sComment = implode(' ',$aComment); - $sPersonal .= $sComment; - } - $aAddress[] = array($sEmail,$sPersonal); - $sPersonal = $sComment = $sEmail = ''; - $aStack = $aComment = array(); - break; - case ':': - $sGroup = implode(' ',$aStack); break; - $aStack = array(); - break; - case '<': - $sEmail = trim(substr($sToken,1,-1)); - break; - case '>': - /* skip */ - break; - default: $aStack[] = $sToken; break; - } - } - /* now do the action again for the last address */ - if (!$sEmail) { - while (count($aStack) && !$sEmail) { - $sEmail = trim(array_pop($aStack)); - } - } - if (count($aStack)) { - $sPersonal = trim(implode('',$aStack)); - } else { - $sPersonal = ''; - } - if (!$sPersonal && count($aComment)) { - $sComment = implode(' ',$aComment); - $sPersonal .= $sComment; - } - $aAddress[] = array($sEmail,$sPersonal); - return $aAddress; -} - + $aAddress = parseRFC822Address($address,array('limit'=> $max)); + /* + * Because the expected format of the array element is changed we adapt it now. + * This also implies that this function is obsolete and should be removed after the + * rest of the source is adapted. See Rfc822Address.php for the new function. + */ + array_walk($aAddress, '_adaptAddress'); + return $aAddress; +} +/** + * OBSOLETE FUNCTION should be removed after mailbox_display, + * printMessage function is adapted + * + * callback function used for formating of addresses array in + * parseAddress() function + * @param array $aAddr + * @param integer $k array key + * @since 1.5.1 + * @deprecated + */ +function _adaptAddress(&$aAddr,$k) { + $sPersonal = (isset($aAddr[SQM_ADDR_PERSONAL]) && $aAddr[SQM_ADDR_PERSONAL]) ? + $aAddr[SQM_ADDR_PERSONAL] : ''; + $sEmail = ($aAddr[SQM_ADDR_HOST]) ? + $aAddr[SQM_ADDR_MAILBOX] . '@'.$aAddr[SQM_ADDR_HOST] : + $aAddr[SQM_ADDR_MAILBOX]; + $aAddr = array($sEmail,$sPersonal); +} -/* - * Returns the number of unseen messages in this folder +/** + * Returns the number of unseen messages in this folder. + * obsoleted by sqimap_status_messages ! + * Arguments differ in 1.0.x + * @param stream $imap_stream + * @param string $mailbox + * @return integer + * @deprecated */ function sqimap_unseen_messages ($imap_stream, $mailbox) { - $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])) { - if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) { - break; - } - $i++; - } - return $regs[1]; + $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('UNSEEN')); + return $aStatus['UNSEEN']; } -/* - * Returns the number of total/unseen/recent messages in this folder +/** + * Returns the status items of a mailbox. + * Default it returns MESSAGES,UNSEEN and RECENT + * Supported status items are MESSAGES, UNSEEN, RECENT (since 1.4.0), + * UIDNEXT (since 1.5.1) and UIDVALIDITY (since 1.5.1) + * @param stream $imap_stream imap stream + * @param string $mailbox mail folder + * @param array $aStatusItems status items + * @return array + * @since 1.3.2 */ -function sqimap_status_messages ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (MESSAGES UNSEEN RECENT)', false, $result, $message); +function sqimap_status_messages ($imap_stream, $mailbox, + $aStatusItems = array('MESSAGES','UNSEEN','RECENT')) { + + $aStatusItems = implode(' ',$aStatusItems); + $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . + " ($aStatusItems)", false, $result, $message); $i = 0; - $messages = $unseen = $recent = false; + $messages = $unseen = $recent = $uidnext = $uidvalidity = false; $regs = array(false,false); while (isset($read_ary[$i])) { if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) { @@ -1020,54 +1055,93 @@ function sqimap_status_messages ($imap_stream, $mailbox) { } if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) { $recent = $regs[1]; - } + } + if (preg_match('/UIDNEXT\s+([0-9]+)/i', $read_ary[$i], $regs)) { + $uidnext = $regs[1]; + } + if (preg_match('/UIDVALIDITY\s+([0-9]+)/i', $read_ary[$i], $regs)) { + $uidvalidity = $regs[1]; + } $i++; } - return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen, 'RECENT' => $recent); + return array('MESSAGES' => $messages, + 'UNSEEN'=>$unseen, + 'RECENT' => $recent, + 'UIDNEXT' => $uidnext, + 'UIDVALIDITY' => $uidvalidity); } -/* - * Saves a message to a given folder -- used for saving sent messages +/** + * Saves a message to a given folder -- used for saving sent messages + * @param stream $imap_stream + * @param string $sent_folder + * @param $length */ function sqimap_append ($imap_stream, $sent_folder, $length) { fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) \{$length}\r\n"); $tmp = fgets ($imap_stream, 1024); + sqimap_append_checkresponse($tmp, $sent_folder); } +/** + * @param stream imap_stream + * @param string $folder (since 1.3.2) + */ function sqimap_append_done ($imap_stream, $folder='') { - global $squirrelmail_language, $color; fputs ($imap_stream, "\r\n"); $tmp = fgets ($imap_stream, 1024); - if (preg_match("/(.*)(BAD|NO)(.*)$/", $tmp, $regs)) { + sqimap_append_checkresponse($tmp, $folder); +} + +/** + * Displays error messages, if there are errors in responses to + * commands issues by sqimap_append() and sqimap_append_done() functions. + * @param string $response + * @param string $folder + * @since 1.5.1 + */ +function sqimap_append_checkresponse($response, $folder) { + + if (preg_match("/(.*)(BAD|NO)(.*)$/", $response, $regs)) { + global $squirrelmail_language, $color; set_up_language($squirrelmail_language); require_once(SM_PATH . 'functions/display_messages.php'); + $reason = $regs[3]; if ($regs[2] == 'NO') { - $string = "\n" . + $string = "\n" . _("ERROR : Could not append message to") ." $folder." . - "
\n" . + "
\n" . _("Server responded: ") . - $reason . "
\n"; + $reason . "
\n"; if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) { - $string .= _("Solution: ") . - _("Remove unneccessary messages from your folder and start with your Trash folder.") - ."
\n"; + $string .= _("Solution: ") . + _("Remove unneccessary messages from your folder and start with your Trash folder.") + ."
\n"; } $string .= "\n"; error_box($string,$color); } else { - $string = "\n" . + $string = "\n" . _("ERROR : Bad or malformed request.") . - "
\n" . + "
\n" . _("Server responded: ") . - $tmp . "
\n"; + $reason . "
\n"; error_box($string,$color); exit; } } } +/** + * Allows mapping of imap server address with custom function + * see map_yp_alias() + * @param string $imap_server imap server address or mapping + * @param string $username + * @return string + * @since 1.3.0 + */ function sqimap_get_user_server ($imap_server, $username) { if (substr($imap_server, 0, 4) != "map:") { return $imap_server; @@ -1076,14 +1150,21 @@ function sqimap_get_user_server ($imap_server, $username) { return $function($username); } -/* This is an example that gets imapservers from yellowpages (NIS). - * you can simple put map:map_yp_alias in your $imap_server_address +/** + * This is an example that gets imapservers from yellowpages (NIS). + * you can simple put map:map_yp_alias in your $imap_server_address * in config.php use your own function instead map_yp_alias to map your - * LDAP whatever way to find the users imapserver. */ - + * LDAP whatever way to find the users imapserver. + * + * Requires access to external ypmatch program + * FIXME: it can be implemented in php yp extension or pecl (since php 5.1.0) + * @param string $username + * @return string + * @since 1.3.0 + */ function map_yp_alias($username) { $yp = `ypmatch $username aliases`; return chop(substr($yp, strlen($username)+1)); -} +} -?> +?> \ No newline at end of file