Bug. 765828. Rewrote patch in order to process locales correctly. If locale
[squirrelmail.git] / functions / imap_general.php
index fb62ebd1773682c06f9ef805b94ca978e5818bbd..92bb13f4d914c99de2645c927512694573b63819 100755 (executable)
@@ -38,7 +38,7 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon
         fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
         $tag_uid_a = explode(' ',trim($sid));
         $tag = $tag_uid_a[0];
-        $read = sqimap_read_data_list ($imap_stream, $tag, $handle_errors, $response, $message, $query );
+        $read = sqimap_retrieve_imap_response ($imap_stream, $tag, $handle_errors, $response, $message, $query );
         /* get the response and the message */
         $message = $message[$tag];
         $response = $response[$tag]; 
@@ -69,7 +69,7 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
         /* retrieve the response and the message */
         $response = $response[$tag];
         $message  = $message[$tag];
-       
+        
         if (!empty($read[$tag])) {
             return $read[$tag][0];
         } else {
@@ -90,32 +90,67 @@ function sqimap_prepare_pipelined_query($new_query,&$tag,&$aQuery,$unique_id) {
     $sid = sqimap_session_id($unique_id);
     $tag_uid_a = explode(' ',trim($sid));
     $tag = $tag_uid_a[0];
-    $query = $sid . ' '.$new_query."\n";
+    $query = $sid . ' '.$new_query."\r\n";
     $aQuery[$tag] = $query;
 }
 
-function sqimap_run_pipelined_command ($imap_stream, $aQuery, $handle_errors, 
+function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors, 
                        &$aServerResponse, &$aServerMessage, $unique_id = false,
-                       $filter=false,$outputstream=false,$no_return=false) {
+                       $filter=false,$outputstream=false,$no_return=false) {    
     $aResponse = false;
-    foreach($aQuery as $tag => $query) {
-        fputs($imap_stream,$query);
-        $aResults[$tag] = false;
+
+    /* 
+       Do not fire all calls at once to the imap-server but split the calls up
+       in portions of $iChunkSize. If we do not do that I think we misbehave as 
+       IMAP client or should handle BYE calls if the IMAP-server drops the
+       connection because the number of queries is to large. This isn't tested
+       but a wild guess how it could work in the field.
+       
+       After testing it on Exchange 2000 we discovered that a chunksize of 32 
+       was quicker then when we raised it to 128.
+    */
+    $iQueryCount = count($aQueryList);
+    $iChunkSize = 32;
+    // array_chunk would also do the job but it's supported from php > 4.2
+    $aQueryChunks = array();
+    $iLoops = floor($iQueryCount / $iChunkSize);
+
+    if ($iLoops * $iChunkSize != $iQueryCount) ++$iLoops;
+
+    if (!function_exists('array_chunk')) { // arraychunk replacement
+        reset($aQueryList);
+        for($i=0;$i<$iLoops;++$i) {
+            for($j=0;$j<$iChunkSize;++$j) {
+                $key = key($aQueryList);
+                $aTmp[$key] = $aQueryList[$key];
+                if (next($aQueryList) === false) break;
+            }
+            $aQueryChunks[] = $aTmp;
+        } 
+    } else {
+        $aQueryChunks = array_chunk($aQueryList,$iChunkSize,true);
     }
-   
-    foreach($aQuery as $tag => $query) {
-        if (!$aResults[$tag]) {
-            $aReturnedResponse = sqimap_read_data_list ($imap_stream, $tag, 
+    
+    for ($i=0;$i<$iLoops;++$i) {
+        $aQuery = $aQueryChunks[$i];
+        foreach($aQuery as $tag => $query) {
+            fputs($imap_stream,$query);
+            $aResults[$tag] = false;
+        }
+        foreach($aQuery as $tag => $query) {
+            if ($aResults[$tag] == false) {
+                $aReturnedResponse = sqimap_retrieve_imap_response ($imap_stream, $tag, 
                                     $handle_errors, $response, $message, $query,
                                     $filter,$outputstream,$no_return);
-            foreach ($aReturnedResponse as $returned_tag => $aResponse) {
-               if (!empty($aResponse)) {
-                    $aResults[$returned_tag] = $aResponse[0];
-               } else {
-                   $aResults[$returned_tag] = $aResponse;
-               }
-                $aServerResponse[$returned_tag] = $response[$returned_tag];
-                $aServerMessage[$returned_tag] = $message[$returned_tag];
+                foreach ($aReturnedResponse as $returned_tag => $aResponse) {
+                    if (!empty($aResponse)) {
+                        $aResults[$returned_tag] = $aResponse[0];
+                    } else {
+                        $aResults[$returned_tag] = $aResponse;
+                    }
+                    $aServerResponse[$returned_tag] = $response[$returned_tag];
+                    $aServerMessage[$returned_tag] = $message[$returned_tag];
+                }
             }
         }
     }
@@ -238,8 +273,26 @@ function sqimap_fread($imap_stream,$iSize,$filter=false,
     }
     return $results;       
 }        
-
-
+/* obsolete function, inform plugins that use it */
+function sqimap_read_data_list($imap_stream, $tag, $handle_errors, 
+          &$response, &$message, $query = '') {
+    global $color, $squirrelmail_language;
+    set_up_language($squirrelmail_language);
+    require_once(SM_PATH . 'functions/display_messages.php');
+    $string = "<b><font color=$color[2]>\n" .
+        _("ERROR : Bad function call.") .
+        "</b><br>\n" .
+        _("Reason:") . ' '.
+          'There is a plugin installed which make use of the  <br>' .
+          'SquirrelMail internal function sqimap_read_data_list.<br>'.
+          'Please adapt the installed plugin and let it use<br>'.
+          'sqimap_run_command or sqimap_run_command_list instead<br><br>'.
+          'The following query was issued:<br>'.
+           htmlspecialchars($query) . '<br>' . "</font><br>\n";
+    error_box($string,$color);
+    echo '</body></html>';        
+    exit; 
+}
 
 /*
  * Reads the output from the IMAP stream.  If handle_errors is set to true,
@@ -247,7 +300,7 @@ function sqimap_fread($imap_stream,$iSize,$filter=false,
  * the errors will be sent back through $response and $message
  */
 
-function sqimap_read_data_list ($imap_stream, $tag, $handle_errors, 
+function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, 
           &$response, &$message, $query = '',
            $filter = false, $outputstream = false, $no_return = false) {
     global $color, $squirrelmail_language;
@@ -257,7 +310,7 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
     $resultlist = array();
     $data = array();
     $read = sqimap_fgets($imap_stream);
-    $i = 0;
+    $i = $k = 0;
     while ($read) {
         $char = $read{0};
         switch ($char)
@@ -277,7 +330,7 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
                 $arg = substr($s,0,$j);
             }
             $found_tag = substr($read,0,$i-1);
-            if ($arg && $found_tag==$tag) {
+            if ($found_tag) {
                 switch ($arg)
                 {
                   case 'OK':
@@ -290,8 +343,12 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
                     if (!empty($data)) {
                         $resultlist[] = $data;
                     }
-                    $aResponse[$tag] = $resultlist;
-                    break 3; /* switch switch while */
+                    $aResponse[$found_tag] = $resultlist;
+                    $data = $resultlist = array();
+                    if ($found_tag == $tag) {
+                        break 3; /* switch switch while */
+                    }
+                  break;
                   default: 
                     /* this shouldn't happen */
                     $response[$found_tag] = $arg;
@@ -300,21 +357,17 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
                         $resultlist[] = $data;
                     }
                     $aResponse[$found_tag] = $resultlist;
-                    break 3; /* switch switch while */
-                }
-            } elseif($found_tag !== $tag) {
-                /* not the tag we are looking for, continue */
-                if (!empty($data)) {
-                    $resultlist[] = $data;
-                }
-                $aResponse[$found_tag] = $resultlist;
-                $resultlist = $data = array();
-                $read = sqimap_fgets($imap_stream);
-                if ($read === false) { /* error */
-                     break 3; /* switch switch while */
+                    $data = $resultlist = array();
+                    if ($found_tag == $tag) {
+                        break 3; /* switch switch while */
+                    }
                 }
-                break;
             }
+            $read = sqimap_fgets($imap_stream);
+            if ($read === false) { /* error */
+                 break 3; /* switch switch while */
+            }
+            break;
           } // end case $tag{0}
 
           case '*':
@@ -399,7 +452,7 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
                     $s = substr($read,-3);
                 } while ($s === "}\r\n");
                 break 1;
-            }
+            }    
             break;
           } // end case '*'
         }   // end switch
@@ -505,10 +558,10 @@ function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors,
     $tag_uid_a = explode(' ',trim($tag_uid));
     $tag = $tag_uid_a[0];
 
-    $res = sqimap_read_data_list($imap_stream, $tag, $handle_errors, 
+    $res = sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, 
               $response, $message, $query,$filter,$outputstream,$no_return); 
     /* sqimap_read_data should be called for one response
-       but since it just calls sqimap_read_data_list which 
+       but since it just calls sqimap_retrieve_imap_response 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. */