Added IMAP speed imrpovements from the guys at XS4ALL
[squirrelmail.git] / functions / imap_general.php
index c91c3ec1381775b6cc2e7af489da446b0d8f957d..fc7626e29cf4f9a29d1dfd39b120d309ff23cdea 100755 (executable)
@@ -3,8 +3,15 @@
     **  imap.php
     **
     **  This implements all functions that do general imap functions.
+    **
+    **  $Id$
     **/
 
+   if (defined ('imap_general_php'))
+      return;
+   define ('imap_general_php', true);
+
+   global $imap_general_debug;
    $imap_general_debug = false;
 
    /******************************************************************************
     **  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 ($imap_stream, $pre, $handle_errors, &$response, &$message) {
+
+   function sqimap_read_data_list ($imap_stream, $pre, $handle_errors,
+                                  &$response, &$message) {
       global $color, $squirrelmail_language, $imap_general_debug;
 
-      $read = fgets($imap_stream, 9096);
-      if (preg_match ("/^\* [0-9]+ FETCH.*{([0-9]+)}/", $read, $regs)) {
-         $size = $regs[1];
-      }
+      $read = "";
+      $resultlist = array();
       
-      $continue = true;
-      while ($continue) {
-         // Continue if needed for this single line
+      $more_msgs = true;
+      while ($more_msgs) {
+         $data = array();
+         $total_size = 0;
          while (strpos($read, "\n") === false) {
             $read .= fgets($imap_stream, 9096);
          }
-         if ($imap_general_debug) {
-            echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\n";
-            flush();
+
+         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
+            // For debugging purposes
+            if ($imap_general_debug) {
+               echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\n";
+               flush();
+            }
+            $size = 0;
+            $data[] = $read;
+            $read = fgets($imap_stream, 9096);
+         } else {
+            $size = 0;
          }
-         
-         if (ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) {
-            if ($size) {
-               $dt = $data;
-               $dt[0] = $dt[count($dt)-1] = "";
-               $d = implode ("", $dt);
-               if (strlen($d) >= $size) {
-                  $continue = false;
+         while (1) {
+            while (strpos($read, "\n") === false) {
+               $read .= fgets($imap_stream, 9096);
+            }
+            // For debugging purposes
+            if ($imap_general_debug) {
+               echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\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);
+                  $read = fgets($imap_stream, 9096);
                }
+               $total_size += strlen($read);
             } else {
-               $continue = false;
+               if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
+                   ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) {
+                  break;
+               } else {
+                  $data[] = $read;
+                  $read = fgets ($imap_stream, 9096);
+               }
             }
-         } 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 "--<br>";
+      if ($imap_general_debug) echo '--<br>';
 
       if ($handle_errors == false)
-          return $data;
+          return $resultlist;
      
-      if ($response == "NO") {
+      if ($response == 'NO') {
          // ignore this error from m$ exchange, it is not fatal (aka bug)
-         if (!ereg("command resulted in",$message)) { 
+         if (strstr($message, 'command resulted in') === false) {
             set_up_language($squirrelmail_language);
             echo "<br><b><font color=$color[2]>\n";
             echo _("ERROR : Could not complete request.");
             echo $message . "</font><br>\n";
             exit;
          }
-      } else if ($response == "BAD") {
+      } else if ($response == 'BAD') {
          set_up_language($squirrelmail_language);
          echo "<br><b><font color=$color[2]>\n";
          echo _("ERROR : Bad or malformed request.");
          echo $message . "</font><br>\n";
          exit;
       }
-      
-      return $data;
+      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];
    }
    
    /******************************************************************************
       global $color, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
 
       $imap_stream = fsockopen ($imap_server_address, $imap_port,
-         &$error_number, &$error_string, 15);
+         $error_number, $error_string, 15);
       $server_info = fgets ($imap_stream, 1024);
       
       // Decrypt the password
          exit;
       }
 
-      fputs ($imap_stream, "a001 LOGIN \"" . quotemeta($username) . 
-         "\" \"" . quotemeta($password) . "\"\r\n");
-      $read = sqimap_read_data ($imap_stream, "a001", false, $response, $message);
+      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) {
-            if ($response != "NO") {
+            if ($response != 'NO') {
                // "BAD" and anything else gets reported here.
                set_up_language($squirrelmail_language, true);
-               if ($response == "BAD")
+               if ($response == 'BAD')
                    printf (_("Bad request: %s")."<br>\r\n", $message);
                else
                    printf (_("Unknown error: %s") . "<br>\n", $message);
-               echo "<br>";
+               echo '<br>';
                echo _("Read data:") . "<br>\n";
               if (is_array($read))
               {
                
                ?>
                   <html>
-                     <body bgcolor=ffffff>
+                     <body bgcolor="ffffff">
                         <br>
                         <center>
-                        <table width=70% noborder bgcolor=ffffff align=center>
+                        <table width="70%" noborder bgcolor="ffffff" align="center">
                            <tr>
-                              <td bgcolor=dcdcdc>
-                                 <font color=cc0000>
+                              <td bgcolor="dcdcdc">
+                                 <font color="cc0000">
                                  <center>
                                  <?php echo _("ERROR") ?>
                                  </center>
       fputs ($imap_stream, "a001 LOGOUT\r\n");
    }
 
-function sqimap_capability($imap_stream, $capability) {
+   function sqimap_capability($imap_stream, $capability) {
        global $sqimap_capabilities;
        global $imap_general_debug;
 
        if (!is_array($sqimap_capabilities)) {
                fputs ($imap_stream, "a001 CAPABILITY\r\n");
-               $read = sqimap_read_data($imap_stream, "a001", true, $a, $b);
+               $read = sqimap_read_data($imap_stream, 'a001', true, $a, $b);
 
                $c = explode(' ', $read[0]);
                for ($i=2; $i < count($c); $i++) {
-                       list($k, $v) = explode('=', $c[$i]);
-                       $sqimap_capabilities[$k] = ($v)?$v:TRUE;
+                       $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;
                }
        }
        return $sqimap_capabilities[$capability];
@@ -212,18 +261,17 @@ function sqimap_capability($imap_stream, $capability) {
    /******************************************************************************
     **  Returns the delimeter between mailboxes:  INBOX/Test, or INBOX.Test... 
     ******************************************************************************/
-function sqimap_get_delimiter ($imap_stream = false) {
-   global $imap_general_debug;
-   global $sqimap_delimiter;
-   global $optional_delimiter;
+   function sqimap_get_delimiter ($imap_stream = false) {
+      global $imap_general_debug;
+      global $sqimap_delimiter;
+      global $optional_delimiter;
 
-   /* Use configured delimiter if set */
-   if((!empty($optional_delimiter)) && $optional_delimiter != "detect") {
-      return $optional_delimiter;
-   }
+      /* Use configured delimiter if set */
+      if((!empty($optional_delimiter)) && $optional_delimiter != "detect")
+         return $optional_delimiter;
 
-       /* Do some caching here */
-    if (!$sqimap_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.
@@ -232,46 +280,31 @@ function sqimap_get_delimiter ($imap_stream = false) {
                           OS:  We want to lookup all personal NAMESPACES...
                        */
                        fputs ($imap_stream, "a001 NAMESPACE\r\n");
-                       $read = sqimap_read_data($imap_stream, "a001", true, $a, $b);
-                       if (eregi('\* NAMESPACE +(\( *\(.+\) *\)|NIL) +(\( *\(.+\) *\)|NIL) +(\( *\(.+\) *\)|NIL)', $read[0], $data)) {
-                               if (eregi('^\( *\((.*)\) *\)', $data[1], $data2))
+                       $read = sqimap_read_data($imap_stream, 'a001', 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))
                                {
-                                       list($_, $n, $_, $d) = explode('"', $v);
-                                       $pn[$n] = $d;
-                               }
-/* OS: We don't need this code right now, it is for other_users and shared folders
-                               if (eregi('^\( *\((.*)\) *\)', $data[2], $data2))
-                                       $on = $data2[1];
-                               if (eregi('^\( *\((.*)\) *\)', $data[3], $data2))
-                                       $sn = $data2[1];
-                               unset($data);
-                               $ona = explode(')(', $on);
-                               while (list($k, $v) = each($ona))
-                               {
-                                       list($_, $n, $_, $d) = explode('"', $v);
-                                       $on[$n] = $d;
+                    $lst = explode('"', $v);
+                    if (isset($lst[3])) {
+                        $pn[$lst[1]] = $lst[3];
+                    } else {
+                        $pn[$lst[1]] = '';
+                    }
                                }
-                               $sna = explode(')(', $sn);
-                               while (list($k, $v) = each($sna))
-                               {
-                                       list($_, $n, $_, $d) = explode('"', $v);
-                                       $sn[$n] = $d;
-                               }
-*/
                        }
                        $sqimap_delimiter = $pn[0];
                } else {
                        fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
-                       $read = sqimap_read_data($imap_stream, ".", true, $a, $b);
-                       $quote_position = strpos ($read[0], "\"");
+                       $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
+                       $quote_position = strpos ($read[0], '"');
                        $sqimap_delimiter = substr ($read[0], $quote_position+1, 1);
                }
        }
        return $sqimap_delimiter;
-}
+   }
 
 
    /******************************************************************************
@@ -279,7 +312,7 @@ function sqimap_get_delimiter ($imap_stream = false) {
     ******************************************************************************/
    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);
+      $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];
@@ -316,18 +349,18 @@ function sqimap_get_delimiter ($imap_stream = false) {
     **           becomes:   lkehresman@yahoo.com
     ******************************************************************************/
    function sqimap_find_displayable_name ($string) {
-      $string = " ".trim($string);
+      $string = ' '.trim($string);
       $orig_string = $string;
-      if (strpos($string, "<") && strpos($string, ">")) {
-         if (strpos($string, "<") == 1) {
+      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 = substr($string, 0, strpos($string, '<'));
+            $string = ereg_replace ('"', '', $string);   
          }   
 
-         if (trim($string) == "") {
+         if (trim($string) == '') {
             $string = sqimap_find_email($orig_string);
          }
       }
@@ -338,10 +371,10 @@ function sqimap_get_delimiter ($imap_stream = false) {
    /******************************************************************************
     **  Returns the number of unseen messages in this folder 
     ******************************************************************************/
-   function sqimap_unseen_messages ($imap_stream, &$num_unseen, $mailbox) {
+   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);
+      $read_ary = sqimap_read_data ($imap_stream, 'a001', true, $result, $message);
       ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
       return $regs[1];
    }