This is Philippe Mingo
[squirrelmail.git] / functions / imap_general.php
index a9e1882bdd82a9613f5abb6bc7985b63e3b3e481..332fee63aaaaf1d274e35f36b633302b09ead283 100755 (executable)
@@ -21,53 +21,77 @@ require_once('../functions/display_messages.php');
  *
  * @return     string  a 4 chars unique string
  */
-function sqimap_session_id() {
 
-    global $data_dir, $username;
+global $sqimap_session_id;
+$sqimap_session_id = 1;
+function sqimap_session_id() {
 
-    $IMAPSessionID = substr(session_id(), -4);
-    if( $IMAPSessionID == '' ) {
-        $IMAPSessionID = 'A001';
-    }
+    global $data_dir, $username, $sqimap_session_id;
 
-    return( $IMAPSessionID );
+    return( sprintf("A%03d", $sqimap_session_id++) );
 }
 
-
 /******************************************************************************
-**  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
+** 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) {
+    $sid = sqimap_session_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) {
+    $sid = sqimap_session_id();
+    fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
+    $read = sqimap_read_data ($imap_stream, $sid, $handle_errors, $response, $message, $query);
+    return $read;
+}
+
+
+/*
+ *  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) {
+                               &$response, &$message, $query = '') {
     global $color, $squirrelmail_language;
-    
+
     $read = '';
+    $bufsize = 9096;
     $resultlist = array();
-    
+
     $more_msgs = true;
     while ($more_msgs) {
         $data = array();
         $total_size = 0;
+
         while (strpos($read, "\n") === false) {
-            $read .= fgets($imap_stream, 9096);
+            if(!($read .= fgets($imap_stream, $bufsize))) {
+                break;
+            }
         }
-        
-        if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) {
+
+        // if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) {
+        if (preg_match('/^\* [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);
+            $read = fgets($imap_stream, $bufsize);
         } else {
             $size = -1;
         }
         while (1) {
             while (strpos($read, "\n") === false) {
-                $read .= fgets($imap_stream, 9096);
+                if(!($read .= fgets($imap_stream, $bufsize))) {
+                    break;
+                }
             }
             // If we know the size, no need to look at the end parameters
             if ($size > 0) {
@@ -83,41 +107,56 @@ function sqimap_read_data_list ($imap_stream, $pre, $handle_errors,
                     break;
                 } else {
                     $data[] = $read;
-                    $read = fgets($imap_stream, 9096);
+                    $read = fgets($imap_stream, $bufsize);
                     while (strpos($read, "\n") === false) {
-                      $read .= fgets($imap_stream, 9096);
+                      $read .= fgets($imap_stream, $bufsize);
                     }
                 }
                 $total_size += strlen($read);
             } else {
-                if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
+                if (preg_match("/^$pre (OK|BAD|NO)(.*)/", $read, $regs) ||
+                // if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
                    (($size == -1) && ereg("^\\* [0-9]+ FETCH.*", $read, $regs))) {
                     break;
+                } else if ( preg_match("/^\* OK \[PARSE.*/", $read, $regs ) ) {
+                    /*
+                        This block has been added in order to avoid the problem
+                        caused by the * OK [PARSE] Missing parameter answer
+                        Please, replace it with a better parsing if you know how.
+                    */
+                    $read = fgets ($imap_stream, $bufsize);
+                    $data[] = $read;
+                    $read = fgets ($imap_stream, $bufsize);
                 } else {
                     $data[] = $read;
-                    $read = fgets ($imap_stream, 9096);
+                    $read = fgets ($imap_stream, $bufsize);
                 }
             }
         }
-        
-        while (($more_msgs = !ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) &&
-            !ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) {
-            $read = fgets($imap_stream, 9096);
+
+        // while (($more_msgs = !ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) &&
+        // !ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) {
+        while (($more_msgs = !preg_match("/^$pre (OK|BAD|NO)(.*)$/", $read, $regs)) &&
+            !preg_match('/^\* [0-9]+ FETCH.*/', $read, $regs)) {
+            $read = fgets($imap_stream, $bufsize);
         }
         $resultlist[] = $data;
     }
+
     $response = $regs[1];
     $message = trim($regs[2]);
-    
-    if ($handle_errors == false) { return $resultlist; }
-    
-    if ($response == 'NO') {
+
+    if ($handle_errors == false) {
+        return( $resultlist );
+    } else 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 "<br><b><font color=$color[2]>\n" .
                  _("ERROR : Could not complete request.") .
                  "</b><br>\n" .
+                 _("Query:") .
+                 $query . '<br>' .
                  _("Reason Given: ") .
                  $message . "</font><br>\n";
             exit;
@@ -127,18 +166,21 @@ function sqimap_read_data_list ($imap_stream, $pre, $handle_errors,
         echo "<br><b><font color=$color[2]>\n" .
              _("ERROR : Bad or malformed request.") .
              "</b><br>\n" .
+             _("Query:") .
+             $query . '<br>' .
              _("Server responded: ") .
              $message . "</font><br>\n";
         exit;
+    } else {
+        return( $resultlist );
     }
-    return $resultlist;
 }
 
-function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) {
+function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message, $query = '') {
 
-    $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message);
+    $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message, $query);
     return $res[0];
-    
+
 }
 
 /******************************************************************************
@@ -169,9 +211,8 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
         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);
+    $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') {
@@ -192,14 +233,16 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
                 }
                 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.
+                /* 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
+                /* $squirrelmail_language is set by a cookie when
+                 * the user selects language and logs out
+                 */
                 
                 set_up_language($squirrelmail_language, true);
                 
@@ -221,16 +264,16 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
  *  Simply logs out the imap session
  */
 function sqimap_logout ($imap_stream) {
-    fputs ($imap_stream, sqimap_session_id() . " LOGOUT\r\n");
+    /* Logout is not valid until the server returns 'BYE' */
+    sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
 }
 
 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);
-    
+        $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]);
@@ -269,8 +312,7 @@ function sqimap_get_delimiter ($imap_stream = false) {
             OS:  * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
             OS:  We want to lookup all personal NAMESPACES...
             */
-            fputs ($imap_stream, sqimap_session_id() . " NAMESPACE\r\n");
-            $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b);
+            $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];
@@ -302,8 +344,7 @@ function sqimap_get_delimiter ($imap_stream = false) {
  */
 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);
+    $read_ary = sqimap_run_command ($imap_stream, "EXAMINE \"$mailbox\"", true, $result, $message);
     for ($i = 0; $i < count($read_ary); $i++) {
      if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
         return $regs[1];
@@ -334,44 +375,51 @@ function sqimap_find_email ($string) {
 
 
 /*
-*  Takes the From: field, and creates a displayable name.
-*    Luke Ehresman <lkehresman@yahoo.com>
-*           becomes:   Luke Ehresman
-*    <lkehresman@yahoo.com>
-*           becomes:   lkehresman@yahoo.com
-*/
+ *  Takes the From: field, and creates a displayable name.
+ *    Luke Ehresman   <lkehresman@yahoo.com>
+ *    "Luke Ehresman" <lkehresman@yahoo.com>
+ *    lkehresman@yahoo.com (Luke Ehresman)
+ *           becomes:   Luke Ehresman
+ *    <lkehresman@yahoo.com>
+ *           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);
-        }
-        
+    $string = trim($string);
+
+    if ( ereg('^(.+)<.*>', $string, $regs) ) {
+        $orig_string = $string;
+        $string = str_replace ('"', '', $regs[1] );
         if (trim($string) == '') {
-            $string = sqimap_find_email($orig_string);
+             $string = sqimap_find_email($orig_string);
+        }
+        if( $string == '' || $string == ' ' ){
+            $string = '&nbsp';
         }
-     } else if (strpos($string, '(') && strpos($string, ')')) {
-         $fn_start = strpos($string, '(') + 1;
-         $fn_len   = strpos($string, ')') - $fn_start;
-         $string = substr($string, $fn_start, $fn_len);
     }
-    return $string;
-}
-
+    elseif ( ereg('\((.*)\)', $string, $regs) ) {
+        if( ( $regs[1] == '' ) || ( $regs[1] == ' ' ) ){
+            if ( ereg('^(.+) \(', $string, $regs) ) {
+               $string = ereg_replace( ' \(\)$', '', $string );
+            } else {
+               $string = '&nbsp';
+            }
+        } 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) {
     //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);
+    $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (UNSEEN)", true, $result, $message);
     ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
     return $regs[1];
 }
@@ -382,7 +430,7 @@ function sqimap_unseen_messages ($imap_stream, $mailbox) {
 */
 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);
+    $tmp = fgets ($imap_stream, 1024);    
 }
 
 function sqimap_append_done ($imap_stream) {