From: philippe_mingo Date: Wed, 12 Dec 2001 08:59:31 +0000 (+0000) Subject: Sintax fix plus display_messages usage X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=commitdiff_plain;h=9c737111a3bebfe76e78072e811addf83c8c1e76 Sintax fix plus display_messages usage git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@1851 7612ce4b-ef26-0410-bec9-ea0150e637f0 --- diff --git a/functions/imap_general.php b/functions/imap_general.php index bc6b4f8e..593187bc 100755 --- a/functions/imap_general.php +++ b/functions/imap_general.php @@ -11,21 +11,8 @@ * $Id$ */ -/*****************************************************************/ -/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/ -/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/ -/*** + Base level indent should begin at left margin, as ***/ -/*** the function definition and comments start below. ***/ -/*** + All identation should consist of four space blocks ***/ -/*** + Tab characters are evil. ***/ -/*** + all comments should use "slash-star ... star-slash" ***/ -/*** style -- no pound characters, no slash-slash style ***/ -/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/ -/*** ALWAYS USE { AND } CHARACTERS!!! ***/ -/*** + Please use ' instead of ", when possible. Note " ***/ -/*** should always be used in _( ) function calls. ***/ -/*** Thank you for your help making the SM code more readable. ***/ -/*****************************************************************/ +require_once('../functions/page_header.php'); +require_once('../functions/display_messages.php'); /** * Unique SessionId @@ -36,271 +23,246 @@ */ function sqimap_session_id() { - global $data_dir, $username; + global $data_dir, $username; - $IMAPSessionID = substr(session_id(), -4); - if( $IMAPSessionID == '' ) { - $IMAPSessionID = 'A001'; - } - - return( $IMAPSessionID ); - } - - - /****************************************************************************** - ** 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) { - global $color, $squirrelmail_language; - - $read = ''; - $resultlist = array(); + $IMAPSessionID = substr(session_id(), -4); + if( $IMAPSessionID == '' ) { + $IMAPSessionID = 'A001'; + } - $more_msgs = true; - while ($more_msgs) { - $data = array(); - $total_size = 0; - while (strpos($read, "\n") === false) { + return( $IMAPSessionID ); +} + + +/****************************************************************************** +** 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) { + global $color, $squirrelmail_language; + + $read = ''; + $resultlist = array(); + + $more_msgs = true; + while ($more_msgs) { + $data = array(); + $total_size = 0; + while (strpos($read, "\n") === false) { $read .= fgets($imap_stream, 9096); - } - - if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) { - $size = $regs[1]; - } else if (ereg("^\\* [0-9]+ FETCH", $read, $regs)) { + } + + if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) { + $size = $regs[1]; + } else if (ereg("^\\* [0-9]+ FETCH", $read, $regs)) { // Sizeless response, probably single-line $size = -1; $data[] = $read; $read = fgets($imap_stream, 9096); - } else { + } else { $size = -1; - } - while (1) { + } + while (1) { while (strpos($read, "\n") === false) { - $read .= fgets($imap_stream, 9096); + $read .= fgets($imap_stream, 9096); } // 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) { + 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); + } + } + $total_size += strlen($read); } else { - if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) || + if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) || (($size == -1) && ereg("^\\* [0-9]+ FETCH.*", $read, $regs))) { - break; - } else { - $data[] = $read; - $read = fgets ($imap_stream, 9096); - } + 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)) { + } + + 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 ($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) { + } + $resultlist[] = $data; + } + $response = $regs[1]; + $message = trim($regs[2]); + + 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) { set_up_language($squirrelmail_language); - echo "
\n"; - echo _("ERROR : Could not complete request."); - echo "
\n"; - echo _("Reason Given: "); - echo $message . "

\n"; + echo "
\n" . + _("ERROR : Could not complete request.") . + "
\n" . + _("Reason Given: ") . + $message . "

\n"; 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; - } - - 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); - 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) { + } + } else if ($response == 'BAD') { + set_up_language($squirrelmail_language); + echo "
\n" . + _("ERROR : Bad or malformed request.") . + "
\n" . + _("Server responded: ") . + $message . "

\n"; + exit; + } + 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); + 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; - } + } + exit; + } - fputs ($imap_stream, sqimap_session_id() . ' LOGIN "' . quoteIMAP($username) . - '" "' . quoteIMAP($password) . "\"\r\n"); - $read = sqimap_read_data ($imap_stream, sqimap_session_id(), false, $response, $message); + fputs ($imap_stream, sqimap_session_id() . ' LOGIN "' . quoteIMAP($username) . + '" "' . quoteIMAP($password) . "\"\r\n"); + $read = sqimap_read_data ($imap_stream, sqimap_session_id(), false, $response, $message); - /** If the connection was not successful, lets see why **/ - if ($response != "OK") { - if (!$hide) { + /** 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') + // "BAD" and anything else gets reported here. + set_up_language($squirrelmail_language, true); + if ($response == 'BAD') { printf (_("Bad request: %s")."
\r\n", $message); - else + } 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; + } + echo '
' . _("Read data:") . "
\n"; + if (is_array($read)) { + foreach ($read as $line) { + echo htmlspecialchars($line) . "
\n"; + } + } + 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); - - ?> - - -
-
- - - - - - - -
- -
- -
-
-
-
-
- -
-
-
- - - \n"; + error_username_password_incorrect(); + session_destroy(); + exit; } - } else { + } else { exit; - } - } - - return $imap_stream; - } - - - - - /****************************************************************************** - ** Simply logs out the imap session - ******************************************************************************/ - function sqimap_logout ($imap_stream) { - fputs ($imap_stream, sqimap_session_id() . " LOGOUT\r\n"); - } - - function sqimap_capability($imap_stream, $capability) { - global $sqimap_capabilities; - - if (!is_array($sqimap_capabilities)) { - fputs ($imap_stream, sqimap_session_id() . " CAPABILITY\r\n"); - $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b); + } + } + + return $imap_stream; +} - $c = explode(' ', $read[0]); - for ($i=2; $i < count($c); $i++) { - $cap_list = explode('=', $c[$i]); - if (isset($cap_list[1])) - $sqimap_capabilities[$cap_list[0]] = $cap_list[1]; - else - $sqimap_capabilities[$cap_list[0]] = TRUE; - } +/* + * Simply logs out the imap session + */ +function sqimap_logout ($imap_stream) { + fputs ($imap_stream, sqimap_session_id() . " LOGOUT\r\n"); +} + +function sqimap_capability($imap_stream, $capability) { + global $sqimap_capabilities; + + if (!is_array($sqimap_capabilities)) { + fputs ($imap_stream, sqimap_session_id() . " CAPABILITY\r\n"); + $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b); + + $c = explode(' ', $read[0]); + for ($i=2; $i < count($c); $i++) { + $cap_list = explode('=', $c[$i]); + if (isset($cap_list[1])) + $sqimap_capabilities[$cap_list[0]] = $cap_list[1]; + else + $sqimap_capabilities[$cap_list[0]] = TRUE; } - if (! isset($sqimap_capabilities[$capability])) + } + if (! isset($sqimap_capabilities[$capability])) { return false; + } else { return $sqimap_capabilities[$capability]; } - - /****************************************************************************** - ** Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test... - ******************************************************************************/ - function sqimap_get_delimiter ($imap_stream = false) { - - global $sqimap_delimiter; - global $optional_delimiter; - - /* Use configured delimiter if set */ - if((!empty($optional_delimiter)) && $optional_delimiter != "detect") - return $optional_delimiter; - - /* Do some caching here */ - if (!$sqimap_delimiter) { - if (sqimap_capability($imap_stream, "NAMESPACE")) { +} + +/****************************************************************************** +** Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test... +******************************************************************************/ +function sqimap_get_delimiter ($imap_stream = false) { + + global $sqimap_delimiter; + global $optional_delimiter; + + /* Use configured delimiter if set */ + if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') { + return $optional_delimiter; + } + + /* Do some caching here */ + if (!$sqimap_delimiter) { + 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: @@ -310,11 +272,11 @@ function sqimap_session_id() { fputs ($imap_stream, sqimap_session_id() . " NAMESPACE\r\n"); $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b); if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) { - if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) + if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) { $pn = $data2[1]; + } $pna = explode(')(', $pn); - while (list($k, $v) = each($pna)) - { + while (list($k, $v) = each($pna)) { $lst = explode('"', $v); if (isset($lst[3])) { $pn[$lst[1]] = $lst[3]; @@ -332,92 +294,95 @@ function sqimap_session_id() { } } return $sqimap_delimiter; - } +} - /****************************************************************************** - ** Gets the number of messages in the current mailbox. - ******************************************************************************/ - function sqimap_get_num_messages ($imap_stream, $mailbox) { - fputs ($imap_stream, sqimap_session_id() . " EXAMINE \"$mailbox\"\r\n"); - $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), 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!"; - } - - - /****************************************************************************** - ** 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); - } - - - /****************************************************************************** - ** 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) { +/* + * Gets the number of messages in the current mailbox. + */ +function sqimap_get_num_messages ($imap_stream, $mailbox) { + + fputs ($imap_stream, sqimap_session_id() . " EXAMINE \"$mailbox\"\r\n"); + $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $result, $message); + for ($i = 0; $i < count($read_ary); $i++) { + if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) { + return $regs[1]; + } + } + return sprintf( "BUG! Couldn't get number of messages in %s!", $mailbox ); + +} + + +/* +* 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); +} + + +/* +* 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 { + } else { $string = trim($string); $string = substr($string, 0, strpos($string, '<')); - $string = ereg_replace ('"', '', $string); - } - - if (trim($string) == '') { + $string = ereg_replace ('"', '', $string); + } + + if (trim($string) == '') { $string = sqimap_find_email($orig_string); - } - } - return $string; - } - - - /****************************************************************************** - ** Returns the number of unseen messages in this folder - ******************************************************************************/ - function sqimap_unseen_messages ($imap_stream, $mailbox) { - //fputs ($imap_stream, sqimap_session_id() . " SEARCH UNSEEN NOT DELETED\r\n"); - fputs ($imap_stream, sqimap_session_id() . " STATUS \"$mailbox\" (UNSEEN)\r\n"); - $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), 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, sqimap_session_id() . " 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); - } -?> + } + } + return $string; +} + + +/* +* Returns the number of unseen messages in this folder +*/ +function sqimap_unseen_messages ($imap_stream, $mailbox) { + //fputs ($imap_stream, sqimap_session_id() . " SEARCH UNSEEN NOT DELETED\r\n"); + fputs ($imap_stream, sqimap_session_id() . " STATUS \"$mailbox\" (UNSEEN)\r\n"); + $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), 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, sqimap_session_id() . " 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); +} + +?> \ No newline at end of file