X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_general.php;h=56cc9bae445d0cf2cd394b35be64b5e43ffd8f91;hp=54e3e6141abe4d4c68cf826182890528ed5da1fa;hb=0e6fd2f821eddd307a1c42df6c9362e2d19020e9;hpb=4b4abf93a9624311afef0c385023724ee46a2b60 diff --git a/functions/imap_general.php b/functions/imap_general.php index 54e3e614..56cc9bae 100755 --- a/functions/imap_general.php +++ b/functions/imap_general.php @@ -5,7 +5,7 @@ * * This implements all functions that do general IMAP functions. * - * @copyright © 1999-2005 The SquirrelMail Project Team + * @copyright 1999-2014 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail @@ -13,9 +13,8 @@ */ /** Includes.. */ -require_once(SM_PATH . 'functions/page_header.php'); -require_once(SM_PATH . 'functions/auth.php'); -include_once(SM_PATH . 'functions/rfc822address.php'); + +require_once(SM_PATH . 'functions/rfc822address.php'); /** @@ -61,14 +60,16 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon $message = $message[$tag]; $response = $response[$tag]; return $read[$tag]; +//FIXME: obey $handle_errors below! } else { global $squirrelmail_language, $color; set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); +//FIXME: NO HTML IN CORE! $string = "\n" . _("ERROR: No available IMAP stream.") . +//FIXME: NO HTML IN CORE! "\n"; - error_box($string,$color); + error_box($string); return false; } } @@ -108,18 +109,35 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, $message = $message[$tag]; if (!empty($read[$tag])) { + /* 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 $read[$tag] array IF they are + separated and IF it was a FETCH response. */ + + if (isset($read[$tag][1]) && is_array($read[$tag][1]) && isset($read[$tag][1][0]) + && preg_match('/^\* \d+ FETCH/', $read[$tag][1][0])) { + $result = array(); + foreach($read[$tag] as $index => $value) { + $result = array_merge($result, $read[$tag]["$index"]); + } + return $result; + } + return $read[$tag][0]; } else { return $read[$tag]; } +//FIXME: obey $handle_errors below! } else { global $squirrelmail_language, $color; set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); +//FIXME: NO HTML IN CORE! $string = "\n" . _("ERROR: No available IMAP stream.") . +//FIXME: NO HTML IN CORE! "\n"; - error_box($string,$color); + error_box($string); return false; } } @@ -317,11 +335,12 @@ function sqimap_fread($imap_stream,$iSize,$filter=false, */ function sqimap_read_data_list($imap_stream, $tag, $handle_errors, &$response, &$message, $query = '') { - global $color, $squirrelmail_language; + global $color, $oTemplate, $squirrelmail_language; set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); +//FIXME: NO HTML IN CORE! $string = "\n" . _("ERROR: Bad function call.") . +//FIXME: NO HTML IN CORE! "
\n" . _("Reason:") . ' '. 'There is a plugin installed which make use of the
' . @@ -329,9 +348,10 @@ function sqimap_read_data_list($imap_stream, $tag, $handle_errors, '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 ''; +//FIXME: NO HTML IN CORE! + sm_encode_html_special_chars($query) . '
' . "
\n"; + error_box($string); + $oTemplate->display('footer.tpl'); exit; } @@ -350,21 +370,22 @@ 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'); +//FIXME: NO HTML IN CORE! $string = "\n" . $title . "
\n"; $cmd = explode(' ',$query); $cmd= strtolower($cmd[0]); if ($query != '' && $cmd != 'login') - $string .= _("Query:") . ' ' . htmlspecialchars($query) . '
'; + $string .= _("Query:") . ' ' . sm_encode_html_special_chars($query) . '
'; if ($message_title != '') $string .= $message_title; if ($message != '') - $string .= htmlspecialchars($message); + $string .= sm_encode_html_special_chars($message); +//FIXME: NO HTML IN CORE! $string .= "
\n"; if ($link != '') $string .= $link; - error_box($string,$color); + error_box($string); } /** @@ -392,6 +413,12 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, $aResponse = ''; $resultlist = array(); $data = array(); + $sCommand = ''; + if (preg_match("/^(\w+)\s*/",$query,$aMatch)) { + $sCommand = strtoupper($aMatch[1]); + } else { + // error reporting (shouldn't happen) + } $read = sqimap_fgets($imap_stream); $i = 0; while ($read) { @@ -455,7 +482,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, case '*': { - if (preg_match('/^\*\s\d+\sFETCH/',$read)) { + if (($sCommand == "FETCH" || $sCommand == "STORE") && preg_match('/^\*\s\d+\sFETCH/',$read)) { /* check for literal */ $s = substr($read,-3); $fetch_data = array(); @@ -465,6 +492,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, we prohibid that literal responses appear in the outer loop so we can trust the untagged and tagged info provided by $read */ + $read_literal = false; if ($s === "}\r\n") { $j = strrpos($read,'{'); $iLit = substr($read,$j+1,-3); @@ -489,7 +517,9 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, if ($read === false) { /* error */ break 4; /* while while switch while */ } - $fetch_data[] = $read; + $s = substr($read,-3); + $read_literal = true; + continue; } else { $fetch_data[] = $read; } @@ -502,7 +532,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, /* check for next untagged reponse and break */ if ($read{0} == '*') break 2; $s = substr($read,-3); - } while ($s === "}\r\n"); + } while ($s === "}\r\n" || $read_literal); $s = substr($read,-3); } while ($read{0} !== '*' && substr($read,0,strlen($tag)) !== $tag); @@ -515,14 +545,21 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, if ($s === "}\r\n") { $j = strrpos($read,'{'); $iLit = substr($read,$j+1,-3); - $data[] = $read; - $sLiteral = fread($imap_stream,$iLit); - if ($sLiteral === false) { /* error */ - $read = false; - break 3; /* while switch while */ + // check for numeric value to avoid that untagged responses like: + // * OK [PARSE] Unexpected characters at end of address: {SET:debug=51} + // will trigger literal fetching ({SET:debug=51} !== int ) + if (is_numeric($iLit)) { + $data[] = $read; + $sLiteral = fread($imap_stream,$iLit); + if ($sLiteral === false) { /* error */ + $read = false; + break 3; /* while switch while */ + } + $data[] = $sLiteral; + $data[] = sqimap_fgets($imap_stream); + } else { + $data[] = $read; } - $data[] = $sLiteral; - $data[] = sqimap_fgets($imap_stream); } else { $data[] = $read; } @@ -550,6 +587,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, $query = ''; } sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:"),$sResponse); +//FIXME: NO HTML IN CORE! echo ''; exit; } else if ($handle_errors) { @@ -585,10 +623,12 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, break; case 'BAD': sqimap_error_box(_("ERROR: Bad or malformed request."), $query, _("Server responded:") . ' ', $message[$tag]); +//FIXME: NO HTML IN CORE! echo ''; exit; case 'BYE': sqimap_error_box(_("ERROR: IMAP server closed the connection."), $query, _("Server responded:") . ' ', $message[$tag]); +//FIXME: NO HTML IN CORE! echo ''; exit; default: @@ -625,20 +665,41 @@ function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, /** * Connects to the IMAP server and returns a resource identifier for use with - * the other SquirrelMail IMAP functions. Does NOT login! + * 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. + * @param integer $tls whether to use plain text(0), TLS(1) or STARTTLS(2) when connecting. + * Argument was boolean before 1.5.1. + * @param array $ssl_options SSL context options, see config_local.php + * for more details (OPTIONAL) * @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) { +function sqimap_create_stream($server,$port,$tls=0,$ssl_options=array()) { global $squirrelmail_language; - if ($tls == true) { + if (strstr($server,':') && ! preg_match("/^\[.*\]$/",$server)) { + // numerical IPv6 address must be enclosed in square brackets + $server = '['.$server.']'; + } + + // NB: Using "ssl://" ensures the highest possible TLS version + // will be negotiated with the server (whereas "tls://" only + // uses TLS version 1.0) + // + if ($tls == 1) { if ((check_php_version(4,3)) and (extension_loaded('openssl'))) { - /* Use TLS by prefixing "tls://" to the hostname */ - $server = 'tls://' . $server; + if (function_exists('stream_socket_client')) { + $server_address = 'ssl://' . $server . ':' . $port; + $ssl_context = @stream_context_create($ssl_options); + $connect_timeout = ini_get('default_socket_timeout'); + // null timeout is broken + if ($connect_timeout == 0) + $connect_timeout = 15; + $imap_stream = @stream_socket_client($server_address, $error_number, $error_string, $connect_timeout, STREAM_CLIENT_CONNECT, $ssl_context); + } else { + $imap_stream = @fsockopen('ssl://' . $server, $port, $error_number, $error_string, 15); + } } else { require_once(SM_PATH . 'functions/display_messages.php'); logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). @@ -646,53 +707,165 @@ function sqimap_create_stream($server,$port,$tls=false) { _("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."), - sprintf(_("Error connecting to IMAP server: %s."), $server)); + sprintf(_("Error connecting to IMAP server: %s."), $server)); } + } else { + $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'); logout_error( sprintf(_("Error connecting to IMAP server: %s."), $server). +//FIXME: NO HTML IN CORE! "
\r\n$error_number : $error_string
\r\n", - sprintf(_("Error connecting to IMAP server: %s."), $server) ); + sprintf(_("Error connecting to IMAP server: %s."), $server) ); exit; } $server_info = fgets ($imap_stream, 1024); + + /** + * Implementing IMAP STARTTLS (rfc2595) in php 5.1.0+ + * http://www.php.net/stream-socket-enable-crypto + */ + if ($tls === 2) { + if (function_exists('stream_socket_enable_crypto')) { + // check starttls capability, don't use cached capability version + if (! sqimap_capability($imap_stream, 'STARTTLS', false)) { + // imap server does not declare starttls support + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + '','', + _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used IMAP server does not support STARTTLS.")); + exit; + } + + // issue starttls command and check response + sqimap_run_command($imap_stream, 'STARTTLS', false, $starttls_response, $starttls_message); + // check response + if ($starttls_response!='OK') { + // starttls command failed + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + 'STARTTLS', + _("Server replied:") . ' ', + $starttls_message); + exit(); + } + + // start crypto on connection. suppress function errors. + if (@stream_socket_enable_crypto($imap_stream,true,STREAM_CRYPTO_METHOD_TLS_CLIENT)) { + // starttls was successful + + /** + * RFC 2595 requires to discard CAPABILITY information after successful + * STARTTLS command. We don't follow RFC, because SquirrelMail stores CAPABILITY + * information only after successful login (src/redirect.php) and cached information + * is used only in other php script connections after successful STARTTLS. If script + * issues sqimap_capability() call before sqimap_login() and wants to get initial + * capability response, script should set third sqimap_capability() argument to false. + */ + //sqsession_unregister('sqimap_capabilities'); + } else { + /** + * stream_socket_enable_crypto() call failed. Possible issues: + * - broken ssl certificate (uw drops connection, error is in syslog mail facility) + * - some ssl error (can reproduce with STREAM_CRYPTO_METHOD_SSLv3_CLIENT, PHP E_WARNING + * suppressed in stream_socket_enable_crypto() call) + */ + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + '','', + _("Unable to start TLS.")); + /** + * Bug: stream_socket_enable_crypto() does not register SSL errors in + * openssl_error_string() or stream notification wrapper and displays + * them in E_WARNING level message. It is impossible to retrieve error + * message without own error handler. + */ + exit; + } + } else { + // php install does not support stream_socket_enable_crypto() function + sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server), + '','', + _("IMAP STARTTLS is enabled in SquirrelMail configuration, but used PHP version does not support functions that allow to enable encryption on open socket.")); + exit; + } + } 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. + * will be displayed (if set to 1, just exits, if set to 2, returns FALSE). + * This function returns the IMAP connection handle. * @param string $username user name - * @param string $password encrypted password + * @param string $password password encrypted with onetimepad. Since 1.5.2 + * function can use internal password functions, if parameter is set to + * boolean false. * @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 + * @param int $hide controls display connection errors: + * 0 = do not hide + * 1 = show no errors (just exit) + * 2 = show no errors (return FALSE) + * 3 = show no errors (return error string) + * @param array $ssl_options SSL context options, see config_local.php + * for more details (OPTIONAL) + * @return mixed The IMAP connection stream, or if the connection fails, + * FALSE if $hide is set to 2 or an error string if $hide + * is set to 3. */ -function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) { +function sqimap_login ($username, $password, $imap_server_address, + $imap_port, $hide, $ssl_options=array()) { global $color, $squirrelmail_language, $onetimepad, $use_imap_tls, - $imap_auth_mech, $sqimap_capabilities; + $imap_auth_mech, $sqimap_capabilities, $display_imap_login_error; + + // Note/TODO: This hack grabs the $authz argument from the session. In the short future, + // a new argument in function sqimap_login() will be used instead. + $authz = ''; + global $authz; + sqgetglobalvar('authz' , $authz , SQ_SESSION); + + if(!empty($authz)) { + /* authz plugin - specific: + * Get proxy login parameters from authz plugin configuration. If they + * exist, they will override the current ones. + * This is useful if we want to use different SASL authentication mechanism + * and/or different TLS settings for proxy logins. */ + global $authz_imap_auth_mech, $authz_use_imap_tls, $authz_imapPort_tls; + $imap_auth_mech = !empty($authz_imap_auth_mech) ? strtolower($authz_imap_auth_mech) : $imap_auth_mech; + $use_imap_tls = !empty($authz_use_imap_tls)? $authz_use_imap_tls : $use_imap_tls; + $imap_port = !empty($authz_use_imap_tls)? $authz_imapPort_tls : $imap_port; + + if($imap_auth_mech == 'login' || $imap_auth_mech == 'cram-md5') { + logout_error("Misconfigured Plugin (authz or equivalent):
". + "The LOGIN and CRAM-MD5 authentication mechanisms cannot be used when attempting proxy login."); + exit; + } + } - if (!isset($onetimepad) || empty($onetimepad)) { - sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION ); + /* get imap login password */ + if ($password===false) { + /* standard functions */ + $password = sqauth_read_password(); + } else { + /* old way. $key must be extracted from cookie */ + if (!isset($onetimepad) || empty($onetimepad)) { + sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION ); + } + /* Decrypt the password */ + $password = OneTimePadDecrypt($password, $onetimepad); } + if (!isset($sqimap_capabilities)) { - sqgetglobalvar('sqimap_capabilities' , $capability , SQ_SESSION ); + sqgetglobalvar('sqimap_capabilities' , $sqimap_capabilities , SQ_SESSION ); } $host = $imap_server_address; $imap_server_address = sqimap_get_user_server($imap_server_address, $username); - $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls); - - /* Decrypt the password */ - $password = OneTimePadDecrypt($password, $onetimepad); + $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls,$ssl_options); if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) { // We're using some sort of authentication OTHER than plain or login @@ -710,7 +883,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ // Got a challenge back $challenge=$response[1]; if ($imap_auth_mech == 'digest-md5') { - $reply = digest_md5_response($username,$password,$challenge,'imap',$host); + $reply = digest_md5_response($username,$password,$challenge,'imap',$host,$authz); } elseif ($imap_auth_mech == 'cram-md5') { $reply = cram_md5_response($username,$password,$challenge); } @@ -738,22 +911,25 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ $read = sqimap_run_command ($imap_stream, $query, false, $response, $message); } elseif ($imap_auth_mech == 'plain') { /*** - * SASL PLAIN - * - * RFC 2595 Chapter 6 - * - * The mechanism consists of a single message from the client to the - * server. The client sends the authorization identity (identity to - * login as), followed by a US-ASCII NUL character, followed by the - * authentication identity (identity whose password will be used), - * followed by a US-ASCII NUL character, followed by the clear-text - * password. The client may leave the authorization identity empty to - * indicate that it is the same as the authentication identity. + * SASL PLAIN, RFC 4616 (updates 2595) * - **/ + * The mechanism consists of a single message, a string of [UTF-8] + * encoded [Unicode] characters, from the client to the server. The + * client presents the authorization identity (identity to act as), + * followed by a NUL (U+0000) character, followed by the authentication + * identity (identity whose password will be used), followed by a NUL + * (U+0000) character, followed by the clear-text password. As with + * other SASL mechanisms, the client does not provide an authorization + * identity when it wishes the server to derive an identity from the + * credentials and use that as the authorization identity. + */ $tag=sqimap_session_id(false); - $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ? true : false; - $auth = base64_encode("$username\0$username\0$password"); + $sasl = (isset($sqimap_capabilities['SASL-IR']) && $sqimap_capabilities['SASL-IR']) ? true : false; + if(!empty($authz)) { + $auth = base64_encode("$username\0$authz\0$password"); + } else { + $auth = base64_encode("$username\0$username\0$password"); + } if ($sasl) { // IMAP Extension for SASL Initial Client Response // @@ -772,6 +948,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ $results=explode(" ",$read,3); $response=$results[1]; $message=$results[2]; + } else { $response="BAD"; $message="Internal SquirrelMail error - unknown IMAP authentication method chosen. Please contact the developers."; @@ -779,24 +956,26 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ /* If the connection was not successful, lets see why */ if ($response != 'OK') { - if (!$hide) { + if (!$hide || $hide == 3) { +//FIXME: UUURG... We don't want HTML in error messages, should also do html sanitizing of error messages elsewhere; should't assume output is destined for an HTML browser here if ($response != 'NO') { /* "BAD" and anything else gets reported here. */ - $message = htmlspecialchars($message); + $message = sm_encode_html_special_chars($message); set_up_language($squirrelmail_language, true); - require_once(SM_PATH . 'functions/display_messages.php'); if ($response == 'BAD') { + if ($hide == 3) return sprintf(_("Bad request: %s"), $message); $string = sprintf (_("Bad request: %s")."
\r\n", $message); } else { + if ($hide == 3) return sprintf(_("Unknown error: %s"), $message); $string = sprintf (_("Unknown error: %s") . "
\n", $message); } if (isset($read) && is_array($read)) { $string .= '
' . _("Read data:") . "
\n"; foreach ($read as $line) { - $string .= htmlspecialchars($line) . "
\n"; + $string .= sm_encode_html_special_chars($line) . "
\n"; } } - error_box($string,$color); + error_box($string); exit; } else { /* @@ -811,14 +990,38 @@ 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.") ); + + // determine what error message to use + // + $fail_msg = _("Unknown user or password incorrect."); + if ($display_imap_login_error) { + // See if there is an error message from the server + // Skip any rfc5530 response code: '[something]' at the + // start of the message + if (!empty($message) + && $message{0} == '[' + && ($end = strstr($message, ']')) + && $end != ']') { + $message = substr($end, 1); + } + // Remove surrounding spaces and if there + // is anything left, display that as the + // error message: + $message = trim($message); + if (strlen($message)) + $fail_msg = _($message); + } + + if ($hide == 3) return $fail_msg; + logout_error($fail_msg); exit; } } else { + if ($hide == 2) return FALSE; exit; } } @@ -832,7 +1035,6 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $ 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; @@ -858,26 +1060,33 @@ function sqimap_logout ($imap_stream) { * 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) + * @param string $capability (since 1.3.0) + * @param boolean $bUseCache (since 1.5.1) Controls use of capability data stored in session * @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='') { - sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION); +function sqimap_capability($imap_stream, $capability='', $bUseCache=true) { + // sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION); - if (!is_array($sqimap_capabilities)) { + if (!$bUseCache || ! sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION)) { $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b); - $c = explode(' ', $read[0]); 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]; + if(isset($sqimap_capabilities[trim($cap_list[0])]) && + !is_array($sqimap_capabilities[trim($cap_list[0])])) { + // Remove array key that was added in 'else' block below + // This is to accomodate for capabilities like: + // SORT SORT=MODSEQ + unset($sqimap_capabilities[trim($cap_list[0])]); + } + $sqimap_capabilities[trim($cap_list[0])][] = $cap_list[1]; } else { - $sqimap_capabilities[$cap_list[0]] = TRUE; + if(!isset($sqimap_capabilities[trim($cap_list[0])])) { + $sqimap_capabilities[trim($cap_list[0])] = TRUE; + } } } } @@ -904,32 +1113,38 @@ function sqimap_get_delimiter ($imap_stream = false) { return $optional_delimiter; } + /* Delimiter is stored in the session from redirect. Try fetching from there first */ + if (empty($sqimap_delimiter)) { + sqgetGlobalVar('delimiter',$sqimap_delimiter,SQ_SESSION); + } + /* Do some caching here */ if (!$sqimap_delimiter) { - if (sqimap_capability($imap_stream, 'NAMESPACE')) { + if (sqimap_capability($imap_stream, 'NAMESPACE') /* * According to something that I can't find, this is supposed to work on all systems * OS: This won't work in Courier IMAP. * OS: According to rfc2342 response from NAMESPACE command is: * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES) * OS: We want to lookup all personal NAMESPACES... + * + * TODO: remove this in favour of the information from sqimap_get_namespace() */ - $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b); - if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) { - if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) { - $pn = $data2[1]; - } - $pna = explode(')(', $pn); - while (list($k, $v) = each($pna)) { - $lst = explode('"', $v); - if (isset($lst[3])) { - $pn[$lst[1]] = $lst[3]; - } else { - $pn[$lst[1]] = ''; - } + && ($read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b)) + && preg_match('/\* NAMESPACE +(\( *\(.+\) *\)|NIL) +(\( *\(.+\) *\)|NIL) +(\( *\(.+\) *\)|NIL)/i', $read[0], $data) + && preg_match('/^\( *\((.*)\) *\)/', $data[1], $data2)) { + $pn = $data2[1]; + $pna = explode(')(', $pn); + $delnew = array(); + while (list($k, $v) = each($pna)) { + $lst = explode('"', $v); + if (isset($lst[3])) { + $delnew[$lst[1]] = $lst[3]; + } else { + $delnew[$lst[1]] = ''; } } - $sqimap_delimiter = $pn[0]; + $sqimap_delimiter = array_shift($delnew); } else { fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n"); $read = sqimap_read_data($imap_stream, '.', true, $a, $b); @@ -941,6 +1156,71 @@ function sqimap_get_delimiter ($imap_stream = false) { return $sqimap_delimiter; } +/** + * Retrieves the namespaces from the IMAP server. + * NAMESPACE is an IMAP extension defined in RFC 2342. + * + * @param stream $imap_stream + * @return array + */ +function sqimap_get_namespace($imap_stream) { + $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b); + return sqimap_parse_namespace($read[0]); +} + +/** + * Parses a NAMESPACE response and returns an array with the available + * personal, users and shared namespaces. + * + * @param string $input + * @return array The returned array has the following format: + * 
+ * array(
+ *   'personal' => array(
+ *       0 => array('prefix'=>'INBOX.','delimiter' =>'.'),
+ *       1 => ...
+ *    ),
+ *    'users' => array(..
+ *    ),
+ *    'shared' => array( ..
+ *    )
+ * )
+ *
+ * Note that if a namespace is not defined in the server, then the corresponding + * array will be empty. + */ +function sqimap_parse_namespace(&$input) { + $ns_strings = array(1=>'personal', 2=>'users', 3=>'shared'); + $namespace = array(); + + if (preg_match('/NAMESPACE (\(\(.*\)\)|NIL) (\(\(.*\)\)|NIL) (\(\(.*\)\)|NIL)/', $input, $regs)) { + for($i=1; $i<=3; $i++) { + if($regs[$i] == 'NIL') { + $namespace[$ns_strings[$i]] = array(); + } else { + // Pop-out the first ( and last ) for easier parsing + $ns = substr($regs[$i], 1, sizeof($regs[$i])-2); + if($c = preg_match_all('/\((?:(.*?)\s*?)\)/', $ns, $regs2)) { + $namespace[$ns_strings[$i]] = array(); + for($j=0; $j $messages, + + $status=array('MESSAGES' => $messages, 'UNSEEN'=>$unseen, 'RECENT' => $recent, 'UIDNEXT' => $uidnext, 'UIDVALIDITY' => $uidvalidity); + + if (!empty($messages)) { $hook_status['MESSAGES']=$messages; } + if (!empty($unseen)) { $hook_status['UNSEEN']=$unseen; } + if (!empty($recent)) { $hook_status['RECENT']=$recent; } + if (!empty($hook_status)) { + $hook_status['MAILBOX']=$mailbox; + $hook_status['CALLER']='sqimap_status_messages'; + do_hook('folder_status', $hook_status); + } + return $status; } @@ -1077,61 +1363,103 @@ function sqimap_status_messages ($imap_stream, $mailbox, * @param stream $imap_stream * @param string $sent_folder * @param $length + * @return string $sid */ -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"); +function sqimap_append ($imap_stream, $sMailbox, $length) { + $sid = sqimap_session_id(); + $query = $sid . ' APPEND ' . sqimap_encode_mailbox_name($sMailbox) . " (\\Seen) {".$length."}"; + fputs ($imap_stream, "$query\r\n"); $tmp = fgets ($imap_stream, 1024); - sqimap_append_checkresponse($tmp, $sent_folder); + sqimap_append_checkresponse($tmp, $sMailbox,$sid, $query); + return $sid; } /** * @param stream imap_stream * @param string $folder (since 1.3.2) */ -function sqimap_append_done ($imap_stream, $folder='') { +function sqimap_append_done ($imap_stream, $sMailbox='') { fputs ($imap_stream, "\r\n"); $tmp = fgets ($imap_stream, 1024); - sqimap_append_checkresponse($tmp, $folder); + while (!sqimap_append_checkresponse($tmp, $sMailbox)) { + $tmp = fgets ($imap_stream, 1024); + } } /** * 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 + * @param string $sMailbox + * @return bool $bDone + * @since 1.5.1 and 1.4.5 */ -function sqimap_append_checkresponse($response, $folder) { +function sqimap_append_checkresponse($response, $sMailbox, $sid='', $query='') { + // static vars to keep them available when sqimap_append_done calls this function. + static $imapquery, $imapsid; - if (preg_match("/(.*)(BAD|NO)(.*)$/", $response, $regs)) { - global $squirrelmail_language, $color; - set_up_language($squirrelmail_language); - require_once(SM_PATH . 'functions/display_messages.php'); + $bDone = false; - $reason = $regs[3]; - if ($regs[2] == 'NO') { - $string = "\n" . - _("ERROR: Could not append message to") ." $folder." . - "
\n" . - _("Server responded:") . ' ' . - $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 .= "\n"; - error_box($string,$color); - } else { - $string = "\n" . - _("ERROR: Bad or malformed request.") . - "
\n" . - _("Server responded:") . ' ' . - $reason . "
\n"; - error_box($string,$color); - exit; + if ($query) { + $imapquery = $query; + } + if ($sid) { + $imapsid = $sid; + } + if ($response{0} == '+') { + // continuation request triggerd by sqimap_append() + $bDone = true; + } else { + $i = strpos($response, ' '); + $sRsp = substr($response,0,$i); + $sMsg = substr($response,$i+1); + $aExtra = array('MAILBOX' => $sMailbox); + switch ($sRsp) { + case '*': //untagged response + $i = strpos($sMsg, ' '); + $sRsp = strtoupper(substr($sMsg,0,$i)); + $sMsg = substr($sMsg,$i+1); + if ($sRsp == 'NO' || $sRsp == 'BAD') { + // for the moment disabled. Enable after 1.5.1 release. + // Notices could give valueable information about the mailbox + // Update: seems this was forgotten, but now it is finally enabled + sqm_trigger_imap_error('SQM_IMAP_APPEND_NOTICE',$imapquery,$sRsp,$sMsg); + } + $bDone = false; + case $imapsid: + // A001 OK message + // $imapsid$sRsp$sMsg + $bDone = true; + $i = strpos($sMsg, ' '); + $sRsp = strtoupper(substr($sMsg,0,$i)); + $sMsg = substr($sMsg,$i+1); + switch ($sRsp) { + case 'NO': + if (preg_match("/(.*)(quota)(.*)$/i", $sMsg, $aMatch)) { + sqm_trigger_imap_error('SQM_IMAP_APPEND_QUOTA_ERROR',$imapquery,$sRsp,$sMsg,$aExtra); + } else { + sqm_trigger_imap_error('SQM_IMAP_APPEND_ERROR',$imapquery,$sRsp,$sMsg,$aExtra); + } + break; + case 'BAD': + sqm_trigger_imap_error('SQM_IMAP_ERROR',$imapquery,$sRsp,$sMsg,$aExtra); + break; + case 'BYE': + sqm_trigger_imap_error('SQM_IMAP_BYE',$imapquery,$sRsp,$sMsg,$aExtra); + break; + case 'OK': + break; + default: + break; + } + break; + default: + // should be false because of the unexpected response but i'm not sure if + // that will cause an endless loop in sqimap_append_done + $bDone = true; } } + return $bDone; } /** @@ -1163,8 +1491,7 @@ function sqimap_get_user_server ($imap_server, $username) { * @since 1.3.0 */ function map_yp_alias($username) { - $yp = `ypmatch $username aliases`; + $safe_username = escapeshellarg($username); + $yp = `ypmatch $safe_username aliases`; return chop(substr($yp, strlen($username)+1)); } - -?> \ No newline at end of file