Fix IMAP PARSE reponse matching. This should get rid of retrival errors
[squirrelmail.git] / functions / imap_general.php
index a2e6bac355d36b2816f8ac11d099dc7a05364ac2..64e11117221bb269ec961f5bd110212e40e25892 100755 (executable)
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * imap.php
+ * imap_general.php
  *
  * Copyright (c) 1999-2002 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
@@ -19,7 +19,7 @@ require_once('../functions/display_messages.php');
  *
  * Sets an unique session id in order to avoid simultanous sessions crash.
  *
- * @return     string  a 4 chars unique string
+ * @return  string  a 4 chars unique string
  */
 
 global $sqimap_session_id;
@@ -39,52 +39,60 @@ function sqimap_session_id() {
 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);
+    $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);
+    $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
-******************************************************************************/
+/*
+ *  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)) {
-           $size = $regs[1];
-        } else if (ereg("^\\* [0-9]+ FETCH", $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)) {
+        } else if (preg_match('/^\* [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) {
@@ -100,41 +108,71 @@ 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) ||
-                   (($size == -1) && ereg("^\\* [0-9]+ FETCH.*", $read, $regs))) {
+                if (preg_match("/^$pre (OK|BAD|NO)(.*)/", $read, $regs) ||
+                // if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
+                   (($size == -1) && preg_match('/^\* [0-9]+ FETCH.*/', $read, $regs))) {
                     break;
+                } else if ( preg_match('/^\* OK \[PARSE.*/', $read, $regs ) ) {
+                    while ( preg_match('/^\* OK \[PARSE.*/', $read, $regs ) ) {
+                        $read = fgets($imap_stream, $bufsize);
+                    }
+                    /*
+                        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.
+                        This block has been updated by
+                        Seth E. Randall <sethr@missoulafcu.org>.  Once we see
+                        one OK [PARSE line, we just go through and keep
+                        tossing them out until we get something different.
+                    */
+                    $data[] = $read;
+                    $read = fgets ($imap_stream, $bufsize);
+                } else if (preg_match('/^\* BYE \[ALERT\](.*)/', $read, $regs)) {
+                    /*
+                        It seems that the IMAP server has coughed a lung up
+                        and hung up the connection.  Print any info we have
+                        and abort.
+                     */
+                    echo _("Please contact your system administrator and report the following error:") . "<br>\n";
+                    echo "$regs[1]";
+                    exit(0);
                 } 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;
@@ -144,18 +182,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];
-    
+
 }
 
 /******************************************************************************
@@ -165,17 +206,17 @@ function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$mes
 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) {
@@ -213,14 +254,14 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
                  * 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);
-                
+
                 displayHtmlHeader( _("Unknown user or password incorrect.") );
                 echo "<body bgcolor=\"#ffffff\">\n";
                 error_username_password_incorrect();
@@ -231,7 +272,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
             exit;
         }
     }
-    
+
     return $imap_stream;
 }
 
@@ -245,7 +286,7 @@ function sqimap_logout ($imap_stream) {
 
 function sqimap_capability($imap_stream, $capability) {
     global $sqimap_capabilities;
-    
+
     if (!is_array($sqimap_capabilities)) {
         $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
 
@@ -272,12 +313,12 @@ 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')) {
@@ -321,12 +362,12 @@ function sqimap_get_num_messages ($imap_stream, $mailbox) {
 
     $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];
-     }
+        if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
+            return $regs[1];
+        }
     }
     return sprintf( "BUG!  Couldn't get number of messages in %s!", $mailbox );
-    
+
 }
 
 
@@ -341,7 +382,7 @@ function sqimap_find_email ($string) {
     ** What about
     **    lehresma@css.tayloru.edu (Luke Ehresman)
     **/
-    
+
     if (ereg("<([^>]+)>", $string, $regs)) {
         $string = $regs[1];
     }
@@ -354,15 +395,22 @@ function sqimap_find_email ($string) {
  *    Luke Ehresman   <lkehresman@yahoo.com>
  *    "Luke Ehresman" <lkehresman@yahoo.com>
  *    lkehresman@yahoo.com (Luke Ehresman)
- *           become:   Luke Ehresman
+ *           becomes:   Luke Ehresman
  *    <lkehresman@yahoo.com>
  *           becomes:   lkehresman@yahoo.com
  */
 function sqimap_find_displayable_name ($string) {
     $string = trim($string);
-    
+
     if ( ereg('^(.+)<.*>', $string, $regs) ) {
-        $string = ereg_replace ('"', '', $regs[1] );
+        $orig_string = $string;
+        $string = str_replace ('"', '', $regs[1] );
+        if (trim($string) == '') {
+             $string = sqimap_find_email($orig_string);
+        }
+        if( $string == '' || $string == ' ' ){
+            $string = '&nbsp';
+        }
     }
     elseif ( ereg('\((.*)\)', $string, $regs) ) {
         if( ( $regs[1] == '' ) || ( $regs[1] == ' ' ) ){
@@ -376,19 +424,25 @@ function sqimap_find_displayable_name ($string) {
         }
     }
     else {
-        $string = sqimap_find_email($string);
+        $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");
-    $read_ary = sqimap_run_command ($imap_stream, " STATUS \"$mailbox\" (UNSEEN)", true, $result, $message);
-    ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
+    $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (UNSEEN)", true, $result, $message);
+    $i = 0;
+    while (isset($read_ary[$i])) {
+        if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) {
+            break;
+        }
+        $i++;
+    }
     return $regs[1];
 }
 
@@ -398,12 +452,12 @@ 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) {
     fputs ($imap_stream, "\r\n");
     $tmp = fgets ($imap_stream, 1024);
 }
-   
+
 ?>