Extracted error_box() calling code into sqimap_error_box() for unified imap error...
[squirrelmail.git] / functions / imap_general.php
index ea8ba293981c0869383cea691e2178ba398ecfdb..67efe425dd7112088e85831f336d84130775d73d 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,6 +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 {
@@ -89,31 +90,71 @@ 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) {
-                $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];
+                }
             }
         }
     }
+    return $aResults;
 }
 
 /* 
@@ -160,6 +201,17 @@ function sqimap_fread($imap_stream,$iSize,$filter=false,
             break;
         }
         $iRetrieved += $iBufferSize;
+        // if the returned lines are split, do not end with \n
+        // then we have a problem and need to adjust (happened with uw)
+        if ($bBufferSizeAdapted && substr($sRead,-1) !== "\n") {
+            // use fgets because it stops at \n.
+            // we can do it because it's for correction
+            $sRead .= fgets($imap_stream,$iBufferSize);
+            $iRetrieved += strlen($sRead);
+            if ($iRetrieved == $iSize) {
+                $bFinished = true;
+            }
+        }
         if ($filter) {
            // in case line-endings do not appear at position 78 we adapt the buffersize so we can base64 decode on the fly
            if (!$bBufferSizeAdapted) {
@@ -232,8 +284,43 @@ 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; 
+}
 
+function sqimap_error_box($title, $query = '', $message_title = '', $message = '')
+{
+    global $color, $squirrelmail_language;
 
+    set_up_language($squirrelmail_language);
+    require_once(SM_PATH . 'functions/display_messages.php');
+    $string = "<font color=$color[2]><b>\n" . $title . "</b><br>\n";
+    if ($query != '')
+        $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br>';
+    if ($message_title != '')
+        $string .= $message_title;
+    if ($message != '')
+        $string .= htmlspecialchars($message);
+    $string .= "</font><br>\n";
+    error_box($string,$color);
+}
 
 /*
  * Reads the output from the IMAP stream.  If handle_errors is set to true,
@@ -241,7 +328,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;
@@ -251,7 +338,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)
@@ -271,7 +358,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':
@@ -284,8 +371,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;
@@ -294,21 +385,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 '*':
@@ -380,7 +467,7 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
                             break 3; /* while switch while */
                         }
                         $data[] = $sLiteral;
-                        $fetch_data[] = sqimap_fgets($imap_stream);
+                        $data[] = sqimap_fgets($imap_stream);
                     } else {
                          $data[] = $read;
                     }
@@ -393,7 +480,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
@@ -402,14 +489,7 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
     /* error processing in case $read is false */
     if ($read === false) {
         unset($data);
-        set_up_language($squirrelmail_language);
-        require_once(SM_PATH . 'functions/display_messages.php');
-        $string = "<b><font color=$color[2]>\n" .
-                  _("ERROR : Connection dropped by imap-server.") .
-                  "</b><br>\n" .
-                  _("Query:") . ' '.
-                  htmlspecialchars($query) . '<br>' . "</font><br>\n";
-        error_box($string,$color);    
+        sqimap_error_box(_("ERROR : Connection dropped by imap-server."), $query);
         exit;
     }
     
@@ -424,67 +504,30 @@ function sqimap_read_data_list ($imap_stream, $tag, $handle_errors,
     /* Return result or handle errors */
     if ($handle_errors == false) {
         return $aResponse;
-        return( $resultlist );
+        return( $resultlist ); //?? Why this?
     }
-    switch ($response[$tag])
-    {
+    switch ($response[$tag]) {
     case 'OK':
         return $aResponse;
         break;
     case '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);
-            require_once(SM_PATH . 'functions/display_messages.php');
-            $string = "<b><font color=$color[2]>\n" .
-                _("ERROR : Could not complete request.") .
-                "</b><br>\n" .
-                _("Query:") . ' ' .
-                htmlspecialchars($query) . '<br>' .
-                _("Reason Given: ") .
-                htmlspecialchars($message[$tag]) . "</font><br>\n";
-            error_box($string,$color);
+        if (strstr($message[$tag], 'command resulted in') === false) {
+            sqimap_error_box(_("ERROR : Could not complete request."), $query, _("Reason Given: "), $message[$tag]);
             echo '</body></html>';
             exit;
         }
         break;
     case 'BAD': 
-        set_up_language($squirrelmail_language);
-        require_once(SM_PATH . 'functions/display_messages.php');
-        $string = "<b><font color=$color[2]>\n" .
-            _("ERROR : Bad or malformed request.") .
-            "</b><br>\n" .
-            _("Query:") . ' '.
-            htmlspecialchars($query) . '<br>' .
-            _("Server responded: ") .
-            htmlspecialchars($message[$tag]) . "</font><br>\n";
-        error_box($string,$color);
+        sqimap_error_box(_("ERROR : Bad or malformed request."), $query, _("Server responded: "), $message[$tag]);
         echo '</body></html>';        
         exit; 
     case 'BYE': 
-        set_up_language($squirrelmail_language);
-        require_once(SM_PATH . 'functions/display_messages.php');
-        $string = "<b><font color=$color[2]>\n" .
-            _("ERROR : Imap server closed the connection.") .
-            "</b><br>\n" .
-            _("Query:") . ' '.
-            htmlspecialchars($query) . '<br>' .
-            _("Server responded: ") .
-            htmlspecialchars($message[$tag]) . "</font><br>\n";
-        error_box($string,$color);
+        sqimap_error_box(_("ERROR : Imap server closed the connection."), $query, _("Server responded: "), $message[$tag]);
         echo '</body></html>';        
         exit;
     default: 
-        set_up_language($squirrelmail_language);
-        require_once(SM_PATH . 'functions/display_messages.php');
-        $string = "<b><font color=$color[2]>\n" .
-            _("ERROR : Unknown imap response.") .
-            "</b><br>\n" .
-            _("Query:") . ' '.
-            htmlspecialchars($query) . '<br>' .
-            _("Server responded: ") .
-            htmlspecialchars($message[$tag]) . "</font><br>\n";
-        error_box($string,$color);
+        sqimap_error_box(_("ERROR : Unknown imap response."), $query, _("Server responded: "), $message[$tag]);
        /* the error is displayed but because we don't know the reponse we
           return the result anyway */
        return $aResponse;    
@@ -499,10 +542,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. */
@@ -736,9 +779,17 @@ function sqimap_get_delimiter ($imap_stream = false) {
 }
 
 
+function sqimap_encode_mailbox_name($what)
+{
+       if (ereg("[\"\\\r\n]", $what))
+               return '{' . strlen($what) . "}\r\n" . $what;   /* 4.3 literal form */
+       return '"' . $what . '"';       /* 4.3 quoted string form */
+}
+
+
 /* Gets the number of messages in the current mailbox. */
 function sqimap_get_num_messages ($imap_stream, $mailbox) {
-    $read_ary = sqimap_run_command ($imap_stream, "EXAMINE \"$mailbox\"", false, $result, $message);
+    $read_ary = sqimap_run_command ($imap_stream, 'EXAMINE ' . sqimap_encode_mailbox_name($mailbox), false, $result, $message);
     for ($i = 0; $i < count($read_ary); $i++) {
         if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
             return $regs[1];
@@ -774,6 +825,18 @@ function parseAddress($address, $max=0) {
             break;
         case '"':
             $iEnd = strpos($address,$cChar,$i+1);
+            if ($iEnd) {
+               // skip escaped quotes
+               $prev_char = $address{$iEnd-1};
+               while ($prev_char === '\\' && substr($address,$iEnd-2,2) !== '\\\\') {
+                   $iEnd = strpos($address,$cChar,$iEnd+1);
+                   if ($iEnd) {
+                      $prev_char = $address{$iEnd-1};
+                   } else {
+                      $prev_char = false;
+                   }
+               }
+            }
             if (!$iEnd) {
                 $sToken = substr($address,$i);
                 $i = $iCnt;
@@ -911,7 +974,7 @@ function parseAddress($address, $max=0) {
  * Returns the number of unseen messages in this folder
  */
 function sqimap_unseen_messages ($imap_stream, $mailbox) {
-    $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (UNSEEN)", false, $result, $message);
+    $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (UNSEEN)', false, $result, $message);
     $i = 0;
     $regs = array(false, false);
     while (isset($read_ary[$i])) {
@@ -924,10 +987,10 @@ function sqimap_unseen_messages ($imap_stream, $mailbox) {
 }
 
 /*
- * Returns the number of unseen/total messages in this folder
+ * Returns the number of total/unseen/recent messages in this folder
  */
 function sqimap_status_messages ($imap_stream, $mailbox) {
-    $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (MESSAGES UNSEEN RECENT)", false, $result, $message);
+    $read_ary = sqimap_run_command ($imap_stream, 'STATUS ' . sqimap_encode_mailbox_name($mailbox) . ' (MESSAGES UNSEEN RECENT)', false, $result, $message);
     $i = 0;
     $messages = $unseen = $recent = false;
     $regs = array(false,false);
@@ -951,7 +1014,7 @@ function sqimap_status_messages ($imap_stream, $mailbox) {
  *  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");
+    fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) \{$length}\r\n");
     $tmp = fgets ($imap_stream, 1024);
 }