X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_general.php;h=008d0053231e4da30235e64312ac398d132ab99a;hp=8a7319148ebeeb2614b0c4bb2f96ea5aa0437e25;hb=bef6629cffe522e21ec116f71b86cb69ecdc5e0d;hpb=bb7bf119d59386bb965676cf230a0bf539e61a02 diff --git a/functions/imap_general.php b/functions/imap_general.php index 8a731914..008d0053 100755 --- a/functions/imap_general.php +++ b/functions/imap_general.php @@ -1,400 +1,485 @@ $read
\n"; - flush(); - } - $size = 0; - $data[] = $read; - $read = fgets($imap_stream, 9096); - } else { - $size = 0; - } - while (1) { - while (strpos($read, "\n") === false) { - $read .= fgets($imap_stream, 9096); - } - // For debugging purposes - if ($imap_general_debug) { - echo "$read
\n"; - flush(); - } - // If we know the size, no need to look at the end parameters - if ($size > 0) { - if ($total_size == $size) { - // We've reached the end of this 'message', switch to the next one. - $data[] = $read; - break; - } else if ($total_size > $size) { - $difference = $total_size - $size; - $total_size = $total_size - strlen($read); - $data[] = substr ($read, 0, strlen($read)-$difference); - $read = substr ($read, strlen($read)-$difference, strlen($read)); - break; - } else { - $data[] = $read; - $read = fgets($imap_stream, 9096); - while (strpos($read, "\n") === false) { - $read .= fgets($imap_stream, 9096); - } - } - $total_size += strlen($read); - } else { - if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) || - ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) { - break; - } else { - $data[] = $read; - $read = fgets ($imap_stream, 9096); - } - } - } - - while (($more_msgs = !ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) && - !ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) { - $read = fgets($imap_stream, 9096); - } - $resultlist[] = $data; - } - $response = $regs[1]; - $message = trim($regs[2]); - - if ($imap_general_debug) echo '--
'; - - if ($handle_errors == false) - return $resultlist; - - if ($response == 'NO') { - // ignore this error from m$ exchange, it is not fatal (aka bug) - if (strstr($message, 'command resulted in') === false) { + +/** + * imap_general.php + * + * Copyright (c) 1999-2002 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$ + */ + +require_once(SM_PATH . 'functions/page_header.php'); + +global $sqimap_session_id; +$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 { + return( sprintf("A%03d", $sqimap_session_id++) . ' UID' ); + } +} + +/* + * Both send a command and accept the result from the command. + * This is to allow proper session number handling. + */ +function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) { + $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; +} + +function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) { + $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; +} + + +/* + * custom fgets function. gets a line from IMAP + * no matter how big it may be + */ + +function sqimap_fgets($imap_stream) { + $read = ''; + $buffer = 4096; + $results = ''; + while (strpos($read, "\n") === false) { + if (!($read = fgets($imap_stream, $buffer))) { + break; + } + $results .= $read; + } + return $results; +} + +/* + * 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, $pre, $handle_errors, &$response, &$message, $query = '') { + global $color, $squirrelmail_language; + $read = ''; + $pre_a = explode(' ',trim($pre)); + $pre = $pre_a[0]; + $resultlist = array(); + $data = array(); + $read = sqimap_fgets($imap_stream); + while (1) { + switch (true) { + case preg_match("/^$pre (OK|BAD|NO)(.*)$/", $read, $regs): + case preg_match('/^\* (BYE \[ALERT\])(.*)$/', $read, $regs): + $response = $regs[1]; + $message = trim($regs[2]); + break 2; + case preg_match("/^\* (OK \[PARSE\])(.*)$/", $read): + $read = sqimap_fgets($imap_stream); + break 1; + case preg_match('/^\* ([0-9]+) FETCH.*/', $read, $regs): + $fetch_data = array(); + $fetch_data[] = $read; + $read = sqimap_fgets($imap_stream); + while (!preg_match('/^\* [0-9]+ FETCH.*/', $read) && + !preg_match("/^$pre (OK|BAD|NO)(.*)$/", $read)) { + $fetch_data[] = $read; + $last = $read; + $read = sqimap_fgets($imap_stream); + } + if (isset($last) && preg_match('/^\)/', $last)) { + array_pop($fetch_data); + } + $resultlist[] = $fetch_data; + break 1; + default: + $data[] = $read; + $read = sqimap_fgets($imap_stream); + break 1; + } + } + if (!empty($data)) { + $resultlist[] = $data; + } + elseif (empty($resultlist)) { + $resultlist[] = array(); + } + if ($handle_errors == false) { + return( $resultlist ); + } + elseif ($response == '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); - echo "
\n"; - echo _("ERROR : Could not complete request."); - echo "
\n"; - echo _("Reason Given: "); - echo $message . "

\n"; + require_once(SM_PATH . 'functions/display_messages.php'); + $string = "\n" . + _("ERROR : Could not complete request.") . + "
\n" . + _("Query:") . + $query . '
' . + _("Reason Given: ") . + $message . "

\n"; + error_box($string,$color); exit; - } - } else if ($response == 'BAD') { - set_up_language($squirrelmail_language); - echo "
\n"; - echo _("ERROR : Bad or malformed request."); - echo "
\n"; - echo _("Server responded: "); - echo $message . "

\n"; - exit; - } - return $resultlist; - } + } + } + elseif ($response == 'BAD') { + set_up_language($squirrelmail_language); + require_once(SM_PATH . 'functions/display_messages.php'); + $string = "\n" . + _("ERROR : Bad or malformed request.") . + "
\n" . + _("Query:") . + $query . '
' . + _("Server responded: ") . + $message . "

\n"; + error_box($string,$color); + exit; + } + else { + return $resultlist; + } +} - function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) { - $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message); - return $res[0]; - } - - /****************************************************************************** - ** Logs the user into the imap server. If $hide is set, no error messages - ** will be displayed. This function returns the imap connection handle. - ******************************************************************************/ - function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) { - global $color, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad; - - $imap_stream = fsockopen ($imap_server_address, $imap_port, - $error_number, $error_string, 15); - $server_info = fgets ($imap_stream, 1024); - - // Decrypt the password - $password = OneTimePadDecrypt($password, $onetimepad); - - /** Do some error correction **/ - if (!$imap_stream) { - if (!$hide) { +function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message, $query = '') { + $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message, $query); + + /* sqimap_read_data should be called for one response + but since it just calls sqimap_read_data_list 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; + } + else { + return $res[0]; + } + +} + +/* + * Logs the user into the imap server. If $hide is set, no error messages + * will be displayed. This function returns the imap connection handle. + */ +function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) { + global $color, $squirrelmail_language, $onetimepad; + + $imap_server_address = sqimap_get_user_server($imap_server_address, $username); + + $imap_stream = fsockopen ( $imap_server_address, $imap_port, $error_number, $error_string, 15); + if ( !$imap_stream ) { + return false; + } + $server_info = fgets ($imap_stream, 1024); + + /* Decrypt the password */ + $password = OneTimePadDecrypt($password, $onetimepad); + + /* Do some error correction */ + if (!$imap_stream) { + if (!$hide) { set_up_language($squirrelmail_language, true); - printf (_("Error connecting to IMAP server: %s.")."
\r\n", $imap_server_address); - echo "$error_number : $error_string
\r\n"; - } - exit; - } - - fputs ($imap_stream, "a001 LOGIN \"" . quoteIMAP($username) . - '" "' . quoteIMAP($password) . "\"\r\n"); - $read = sqimap_read_data ($imap_stream, 'a001', false, $response, $message); - - /** If the connection was not successful, lets see why **/ - if ($response != "OK") { - if (!$hide) { + require_once(SM_PATH . 'functions/display_messages.php'); + $string = sprintf (_("Error connecting to IMAP server: %s.") . + "
\r\n", $imap_server_address) . + "$error_number : $error_string
\r\n"; + error_box($string,$color); + } + exit; + } + + $query = 'LOGIN "' . quoteIMAP($username) . '" "' . quoteIMAP($password) . '"'; + $read = sqimap_run_command ($imap_stream, $query, false, $response, $message); + + /* If the connection was not successful, lets see why */ + if ($response != 'OK') { + if (!$hide) { if ($response != 'NO') { - // "BAD" and anything else gets reported here. - set_up_language($squirrelmail_language, true); - if ($response == 'BAD') - printf (_("Bad request: %s")."
\r\n", $message); - else - printf (_("Unknown error: %s") . "
\n", $message); - echo '
'; - echo _("Read data:") . "
\n"; - if (is_array($read)) - { - foreach ($read as $line) - { - echo htmlspecialchars($line) . "
\n"; - } - } - exit; + /* "BAD" and anything else gets reported here. */ + 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); + } else { + $string = sprintf (_("Unknown error: %s") . "
\n", $message); + } + $string .= '
' . _("Read data:") . "
\n"; + if (is_array($read)) { + foreach ($read as $line) { + $string .= htmlspecialchars($line) . "
\n"; + } + } + error_box($string,$color); + exit; } else { - // If the user does not log in with the correct - // username and password it is not possible to get the - // correct locale from the user's preferences. - // Therefore, apply the same hack as on the login - // screen. - - // $squirrelmail_language is set by a cookie when - // the user selects language and logs out - - set_up_language($squirrelmail_language, true); - - ?> - - -
-
- - - - - - - -
- -
- -
-
-
-
-
- -
-
-
- - - + * "Luke Ehresman" + * + * lehresma@css.tayloru.edu (Luke Ehresman) + * lehresma@css.tayloru.edu + * becomes: lehresma@css.tayloru.edu + */ +function sqimap_find_email ($string) { + if (ereg("<([^>]+)>", $string, $regs)) { + $string = $regs[1]; + } else if (ereg("([^ ]+@[^ ]+)", $string, $regs)) { + $string = $regs[1]; + } + return trim($string); +} + + +/* + * Takes the From: field and creates a displayable name. + * Luke Ehresman + * "Luke Ehresman" + * lkehresman@yahoo.com (Luke Ehresman) + * becomes: Luke Ehresman + * + * becomes: lkehresman@yahoo.com + */ +function sqimap_find_displayable_name ($string) { + $string = trim($string); + + if ( ereg('^(.+)<.*>', $string, $regs) ) { + $orig_string = $string; + $string = str_replace ('"', '', $regs[1] ); + if (trim($string) == '') { + $string = sqimap_find_email($orig_string); + } + if( $string == '' || $string == ' ' ){ + $string = ' '; + } + } + elseif ( ereg('\((.*)\)', $string, $regs) ) { + if( ( $regs[1] == '' ) || ( $regs[1] == ' ' ) ){ + if ( ereg('^(.+) \(', $string, $regs) ) { + $string = ereg_replace( ' \(\)$', '', $string ); + } else { + $string = ' '; + } + } else { + $string = $regs[1]; + } + } + else { + $string = str_replace ('"', '', sqimap_find_email($string)); + } + + return trim($string); +} + +/* + * 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); + $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]; +} + +/* + * Returns the number of unseen/total messages in this folder + */ +function sqimap_status_messages ($imap_stream, $mailbox) { + $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (MESSAGES UNSEEN)", false, $result, $message); + $i = 0; + $messages = $unseen = false; + $regs = array(false,false); + while (isset($read_ary[$i])) { + if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) { + $unseen = $regs[1]; } - return $sqimap_delimiter; - } + if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) { + $messages = $regs[1]; + } + $i++; + } + return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen); +} - /****************************************************************************** - ** Gets the number of messages in the current mailbox. - ******************************************************************************/ - function sqimap_get_num_messages ($imap_stream, $mailbox) { - fputs ($imap_stream, "a001 EXAMINE \"$mailbox\"\r\n"); - $read_ary = sqimap_read_data ($imap_stream, 'a001', true, $result, $message); - for ($i = 0; $i < count($read_ary); $i++) { - if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) { - return $regs[1]; - } - } - return "BUG! Couldn't get number of messages in $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"); + $tmp = fgets ($imap_stream, 1024); +} - - /****************************************************************************** - ** Returns a displayable email address - ******************************************************************************/ - function sqimap_find_email ($string) { - /** Luke Ehresman - ** - ** lehresma@css.tayloru.edu - ** - ** What about - ** lehresma@css.tayloru.edu (Luke Ehresman) - **/ - - if (ereg("<([^>]+)>", $string, $regs)) { - $string = $regs[1]; - } - return trim($string); - } +function sqimap_append_done ($imap_stream) { + global $squirrelmail_language, $color; + fputs ($imap_stream, "\r\n"); + $tmp = fgets ($imap_stream, 1024); + if (preg_match("/(.*)(BAD|NO)(.*)$/", $tmp, $regs)) { + set_up_language($squirrelmail_language); + require_once(SM_PATH . 'functions/display_messages.php'); + $string = "\n" . + _("ERROR : Bad or malformed request.") . + "
\n" . + _("Server responded: ") . + $tmp . "

\n"; + error_box($string,$color); + exit; + } +} - - /****************************************************************************** - ** Takes the From: field, and creates a displayable name. - ** Luke Ehresman - ** becomes: Luke Ehresman - ** - ** becomes: lkehresman@yahoo.com - ******************************************************************************/ - function sqimap_find_displayable_name ($string) { - $string = ' '.trim($string); - $orig_string = $string; - if (strpos($string, '<') && strpos($string, '>')) { - if (strpos($string, '<') == 1) { - $string = sqimap_find_email($string); - } else { - $string = trim($string); - $string = substr($string, 0, strpos($string, '<')); - $string = ereg_replace ('"', '', $string); - } - - if (trim($string) == '') { - $string = sqimap_find_email($orig_string); - } - } - return $string; +function sqimap_get_user_server ($imap_server, $username) { + if (substr($imap_server, 0, 4) != "map:") { + return $imap_server; } + $function = substr($imap_server, 4); + 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 + * in config.php use your own function instead map_yp_alias to map your + * LDAP whatever way to find the users imapserver. */ + +function map_yp_alias($username) { + $yp = `ypmatch $username aliases`; + return chop(substr($yp, strlen($username)+1)); +} - /****************************************************************************** - ** Returns the number of unseen messages in this folder - ******************************************************************************/ - function sqimap_unseen_messages ($imap_stream, $mailbox) { - //fputs ($imap_stream, "a001 SEARCH UNSEEN NOT DELETED\r\n"); - fputs ($imap_stream, "a001 STATUS \"$mailbox\" (UNSEEN)\r\n"); - $read_ary = sqimap_read_data ($imap_stream, 'a001', true, $result, $message); - ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs); - return $regs[1]; - } - - - /****************************************************************************** - ** Saves a message to a given folder -- used for saving sent messages - ******************************************************************************/ - function sqimap_append ($imap_stream, $sent_folder, $length) { - fputs ($imap_stream, "a001 APPEND \"$sent_folder\" (\\Seen) \{$length}\r\n"); - $tmp = fgets ($imap_stream, 1024); - } - - function sqimap_append_done ($imap_stream) { - fputs ($imap_stream, "\r\n"); - $tmp = fgets ($imap_stream, 1024); - } ?>