Fix more literal mailbox names
[squirrelmail.git] / functions / imap_general.php
index 1268831ce3db932acb1712c1613a6035be2d28cb..63d37823df2aa529f07ccde08ab2cdb63dab2808 100755 (executable)
@@ -3,7 +3,7 @@
 /**
  * imap_general.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
  * This implements all functions that do general imap functions.
@@ -22,9 +22,9 @@ $sqimap_session_id = 1;
 function sqimap_session_id($unique_id = false) {
     global $data_dir, $username, $sqimap_session_id;
     if (!$unique_id) {
-       return( sprintf("A%03d", $sqimap_session_id++) );
+        return( sprintf("A%03d", $sqimap_session_id++) );
     } else {
-       return( sprintf("A%03d", $sqimap_session_id++) . ' UID' );
+        return( sprintf("A%03d", $sqimap_session_id++) . ' UID' );
     }
 }
 
@@ -34,10 +34,15 @@ function sqimap_session_id($unique_id = false) {
  */
 function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
     if ($imap_stream) {
-       $sid = sqimap_session_id($unique_id);
-       fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
-       $read = sqimap_read_data_list ($imap_stream, $sid, $handle_errors, $response, $message, $query );
-       return $read;
+        $sid = sqimap_session_id($unique_id);
+        fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
+        $tag_uid_a = explode(' ',trim($sid));
+        $tag = $tag_uid_a[0];
+        $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]; 
+        return $read[$tag];
     } else {
         global $squirrelmail_language, $color;
         set_up_language($squirrelmail_language);
@@ -46,17 +51,30 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon
                 _("ERROR : No available imapstream.") .
                 "</b></font>\n";
         error_box($string,$color);
-       return false;
+        return false;
     }
-    
 }
 
-function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
+function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, 
+                            &$message, $unique_id = false,$filter=false,
+                             $outputstream=false,$no_return=false) {
     if ($imap_stream) {
         $sid = sqimap_session_id($unique_id);
-       fputs ($imap_stream, $sid . ' ' . $query . "\r\n");
-       $read = sqimap_read_data ($imap_stream, $sid, $handle_errors, $response, $message, $query);
-       return $read;
+        fputs ($imap_stream, $sid . ' ' . $query . "\r\n"); 
+        $tag_uid_a = explode(' ',trim($sid));
+        $tag = $tag_uid_a[0];
+   
+        $read = sqimap_read_data ($imap_stream, $tag, $handle_errors, $response,
+                                  $message, $query,$filter,$outputstream,$no_return);
+        /* retrieve the response and the message */
+        $response = $response[$tag];
+        $message  = $message[$tag];
+        
+        if (!empty($read[$tag])) {
+            return $read[$tag][0];
+        } else {
+            return $read[$tag];
+        }
     } else {
         global $squirrelmail_language, $color;
         set_up_language($squirrelmail_language);
@@ -65,12 +83,80 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, &
                 _("ERROR : No available imapstream.") .
                 "</b></font>\n";
         error_box($string,$color);
-       return false;
+        return false;
+    }    
+}
+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."\r\n";
+    $aQuery[$tag] = $query;
+}
+
+function sqimap_run_pipelined_command ($imap_stream, $aQueryList, $handle_errors, 
+                       &$aServerResponse, &$aServerMessage, $unique_id = false,
+                       $filter=false,$outputstream=false,$no_return=false) {    
+    $aResponse = 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);
     }
     
+    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];
+                }
+            }
+        }
+    }
+    return $aResults;
 }
 
-
 /* 
  * custom fgets function. gets a line from IMAP
  * no matter how big it may be
@@ -80,126 +166,419 @@ function sqimap_fgets($imap_stream) {
     $read = '';
     $buffer = 4096;
     $results = '';
-    while (strpos($read, "\n") === false) {
+    $offset = 0;
+    while (strpos($results, "\r\n", $offset) === false) {
         if (!($read = fgets($imap_stream, $buffer))) {
+        /* this happens in case of an error */
+        /* reset $results because it's useless */
+        $results = false;
             break;
         }
+        if ( $results != '' ) {
+            $offset = strlen($results) - 1;
+        }
         $results .= $read;
     }
     return $results;
 }
 
+function sqimap_fread($imap_stream,$iSize,$filter=false,
+                      $outputstream=false, $no_return=false) {
+    if (!$filter || !$outputstream) {
+        $iBufferSize = $iSize;
+    } else {
+        $iBufferSize = 62400; // multiple of 78 in case of base64 decoding.
+    }
+    $iRet = $iSize - $iBufferSize;
+    $iRetrieved = 0;
+    $i = 0;
+    $results = $sReadRem = '';
+    $bFinished = $bBufferSizeAdapted =  $bBufferIsOk = false;
+    while (($iRetrieved < ($iSize - $iBufferSize))) {
+        $sRead = fread($imap_stream,$iBufferSize);
+        if (!$sRead) {
+            $results = false;
+            break;
+        }
+        $iRetrieved += $iBufferSize;
+        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) {
+               $i = strpos($sRead,"\n");
+               if ($i) {
+                   ++$i;
+                   $iFragments = floor($iBufferSize / $i);
+                   $iNewBufferSize = $iFragments * $i;
+                   $iRemainder = $iNewBufferSize + $i - $iBufferSize;
+                   if ($iNewBufferSize == $iBufferSize) {
+                       $bBufferIsOk = true;
+                       $iRemainder = 0;
+                       $iNewBufferSize = $iBufferSize;
+                       $bBufferSizeAdapted = true;
+                   }
+                   if (!$bBufferIsOk && ($iRemainder + $iBufferSize)  < $iSize) {
+                       $sReadRem = fread($imap_stream,$iRemainder);
+                   } else if (!$bBufferIsOk) {
+                       $sReadRem = fread($imap_stream,$iSize - $iBufferSize);
+                       $bFinished = true;
+                   }
+                   if (!$sReadRem && $sReadRem !== '') {
+                        $results = false;
+                        break;
+                   }
+                   $iBufferSize = $iNewBufferSize;
+                   $bBufferSizeAdapted = true;
+               } else {
+                   $sReadRem = fread($imap_stream,$iSize - $iBufferSize);
+                   $bFinished = true;
+                   if (!$sReadRem) {
+                       $results = false;
+                       break;
+                   }
+               }
+               $sRead .= $sReadRem;
+               $iRetrieved += $iRemainder;
+               unset($sReadRem);
+           }
+           $filter($sRead);
+        }
+        if ($outputstream) {
+           if (is_resource($outputstream)) {
+               fwrite($outputstream,$sRead);
+           } else if ($outputstream == 'php://stdout') {
+               echo $sRead;
+           }
+        }
+        if ($no_return) {
+            $sRead = '';
+        }    
+        $results .= $sRead;
+    }
+    if (!$results && !$bFinished) {
+        $sRead = fread($imap_stream,($iSize - ($iRetrieved)));  
+        if ($filter) {
+           $filter($sRead);
+        }
+        if ($outputstream) {
+           if (is_resource($outputstream)) {      
+               fwrite($outputstream,$sRead);
+           } else if ($outputstream == 'php://stdout') { // FIXME
+               echo $sRead;
+           }
+        }
+        if ($no_return) {
+            $sRead = '';
+        }    
+        $results .= $sRead;
+    }
+    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,
  * 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, $query = '') {
+function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors, 
+          &$response, &$message, $query = '',
+           $filter = false, $outputstream = false, $no_return = false) {
     global $color, $squirrelmail_language;
     $read = '';
-    $pre_a = explode(' ',trim($pre));
-    $pre = $pre_a[0];
+    if (!is_array($message)) $message = array();
+    if (!is_array($response)) $response = array();
     $resultlist = array();
     $data = array();
     $read = sqimap_fgets($imap_stream);
-    while (1) {
-        switch (true) { 
-            case preg_match("/^$pre (OK|BAD|NO)(.*)$/", $read, $regs):
-            case preg_match('/^\* (BYE \[ALERT\])(.*)$/', $read, $regs):
-                $response = $regs[1];
-                $message = trim($regs[2]);
-                break 2;
-            case preg_match("/^\* (OK \[PARSE\])(.*)$/", $read):
-                $read = sqimap_fgets($imap_stream);
-                break 1;
-            case preg_match('/^\* ([0-9]+) FETCH.*/', $read, $regs):
-                $fetch_data = array();
-                $fetch_data[] = $read;
-                $read = sqimap_fgets($imap_stream);
-                while (!preg_match('/^\* [0-9]+ FETCH.*/', $read) &&
-                       !preg_match("/^$pre (OK|BAD|NO)(.*)$/", $read)) {
-                    $fetch_data[] = $read;
-                    $last = $read;
-                    $read = sqimap_fgets($imap_stream);
-                }
-                if (isset($last) && preg_match('/^\)/', $last)) {
-                    array_pop($fetch_data);
+    $i = $k = 0;
+    while ($read) {
+        $char = $read{0};
+        switch ($char)
+        {
+          case '+':
+          default:
+            $read = sqimap_fgets($imap_stream);
+            break;
+
+          case $tag{0}:
+          {
+            /* get the command */
+            $arg = '';
+            $i = strlen($tag)+1;
+            $s = substr($read,$i);
+            if (($j = strpos($s,' ')) || ($j = strpos($s,"\n"))) {
+                $arg = substr($s,0,$j);
+            }
+            $found_tag = substr($read,0,$i-1);
+            if ($found_tag) {
+                switch ($arg)
+                {
+                  case 'OK':
+                  case 'BAD':
+                  case 'NO':
+                  case 'BYE':
+                  case 'PREAUTH':
+                    $response[$found_tag] = $arg;
+                    $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
+                    if (!empty($data)) {
+                        $resultlist[] = $data;
+                    }
+                    $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;
+                    $message[$found_tag] = trim(substr($read,$i+strlen($arg)));
+                    if (!empty($data)) {
+                        $resultlist[] = $data;
+                    }
+                    $aResponse[$found_tag] = $resultlist;
+                    $data = $resultlist = array();
+                    if ($found_tag == $tag) {
+                        break 3; /* switch switch while */
+                    }
                 }
+            }
+            $read = sqimap_fgets($imap_stream);
+            if ($read === false) { /* error */
+                 break 3; /* switch switch while */
+            }
+            break;
+          } // end case $tag{0}
+
+          case '*':
+          {
+            if (preg_match('/^\*\s\d+\sFETCH/',$read)) {
+                /* check for literal */
+                $s = substr($read,-3);
+                $fetch_data = array();
+                do { /* outer loop, continue until next untagged fetch
+                        or tagged reponse */
+                    do { /* innerloop for fetching literals. with this loop
+                            we prohibid that literal responses appear in the
+                            outer loop so we can trust the untagged and
+                            tagged info provided by $read */
+                        if ($s === "}\r\n") {
+                            $j = strrpos($read,'{');
+                            $iLit = substr($read,$j+1,-3);
+                            $fetch_data[] = $read;
+                            $sLiteral = sqimap_fread($imap_stream,$iLit,$filter,$outputstream,$no_return);
+                            if ($sLiteral === false) { /* error */
+                                break 4; /* while while switch while */
+                            }
+                            /* backwards compattibility */
+                            $aLiteral = explode("\n", $sLiteral);
+                            /* release not neaded data */
+                            unset($sLiteral);
+                            foreach ($aLiteral as $line) {
+                                $fetch_data[] = $line ."\n";
+                            }
+                            /* release not neaded data */
+                            unset($aLiteral); 
+                            /* next fgets belongs to this fetch because
+                               we just got the exact literalsize and there
+                               must follow data to complete the response */
+                            $read = sqimap_fgets($imap_stream);
+                            if ($read === false) { /* error */
+                                break 4; /* while while switch while */
+                            }
+                            $fetch_data[] = $read;
+                        } else {
+                            $fetch_data[] = $read;
+                        }
+                        /* retrieve next line and check in the while
+                           statements if it belongs to this fetch response */
+                        $read = sqimap_fgets($imap_stream);
+                        if ($read === false) { /* error */
+                            break 4; /* while while switch while */
+                        }
+                        /* check for next untagged reponse and break */
+                        if ($read{0} == '*') break 2;
+                        $s = substr($read,-3);
+                    } while ($s === "}\r\n");
+                    $s = substr($read,-3);
+                } while ($read{0} !== '*' &&
+                         substr($read,0,strlen($tag)) !== $tag);
                 $resultlist[] = $fetch_data;
+                /* release not neaded data */
+                unset ($fetch_data);
+            } else {
+                $s = substr($read,-3);
+                do {
+                    if ($s === "}\r\n") {
+                        $j = strrpos($read,'{');
+                        $iLit = substr($read,$j+1,-3);
+                        $data[] = $read;
+                        $sLiteral = fread($imap_stream,$iLit);
+                        if ($sLiteral === false) { /* error */
+                            $read = false;
+                            break 3; /* while switch while */
+                        }
+                        $data[] = $sLiteral;
+                        $data[] = sqimap_fgets($imap_stream);
+                    } else {
+                         $data[] = $read;
+                    }
+                    $read = sqimap_fgets($imap_stream);
+                    if ($read === false) {
+                        break 3; /* while switch while */
+                    } else if ($read{0} == '*') {
+                        break;
+                    }
+                    $s = substr($read,-3);
+                } while ($s === "}\r\n");
                 break 1;
-            default:
-                $data[] = $read;
-                $read = sqimap_fgets($imap_stream);
-                break 1;
-        }
+            }    
+            break;
+          } // end case '*'
+        }   // end switch
+    } // end while
+    
+    /* 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);    
+        exit;
     }
+    
+    /* Set $resultlist array */
     if (!empty($data)) {
-        $resultlist[] = $data;
+        //$resultlist[] = $data;
     }
     elseif (empty($resultlist)) {
         $resultlist[] = array(); 
     }
+
+    /* Return result or handle errors */
     if ($handle_errors == false) {
+        return $aResponse;
         return( $resultlist );
-    } 
-    elseif ($response == 'NO') {
-    /* ignore this error from M$ exchange, it is not fatal (aka bug) */
-        if (strstr($message, 'command resulted in') === false) {
+    }
+    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[$tag], 'command resulted in') === false) {
             set_up_language($squirrelmail_language);
-           require_once(SM_PATH . 'functions/display_messages.php');
-           $string = "<b><font color=$color[2]>\n" .
+            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) . "</font><br>\n";
-           error_box($string,$color);
+                htmlspecialchars($message[$tag]) . "</font><br>\n";
+            error_box($string,$color);
+            echo '</body></html>';
             exit;
         }
-    } 
-    elseif ($response == 'BAD') {
+        break;
+    case 'BAD': 
         set_up_language($squirrelmail_language);
-       require_once(SM_PATH . 'functions/display_messages.php');
+        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) . "</font><br>\n";
-       error_box($string,$color);    
+            htmlspecialchars($message[$tag]) . "</font><br>\n";
+        error_box($string,$color);
+        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);
+        echo '</body></html>';        
         exit;
-    } 
-    else {
-        return $resultlist;
+    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);
+       /* the error is displayed but because we don't know the reponse we
+          return the result anyway */
+       return $aResponse;    
+       break;
     }
 }
 
-function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message, $query = '') {
-    $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message, $query);
-  
+function sqimap_read_data ($imap_stream, $tag_uid, $handle_errors, 
+                           &$response, &$message, $query = '',
+                           $filter=false,$outputstream=false,$no_return=false) {
+
+    $tag_uid_a = explode(' ',trim($tag_uid));
+    $tag = $tag_uid_a[0];
+
+    $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. */
   
-    if (isset($res[1]) && is_array($res[1]) && isset($res[1][0]) 
-        && preg_match('/^\* \d+ FETCH/', $res[1][0])) {
-        $result = array();
-        foreach($res as $index=>$value) {
-            $result = array_merge($result, $res["$index"]);
-        }
-    }
+//    if (isset($res[1]) && is_array($res[1]) && isset($res[1][0]) 
+//        && preg_match('/^\* \d+ FETCH/', $res[1][0])) {
+//        $result = array();
+//        foreach($res as $index=>$value) {
+//            $result = array_merge($result, $res["$index"]);
+//        }
+//    }
     if (isset($result)) {
-        return $result;
+        return $result[$tag];
     }
     else {
-        return $res[0];
+        return $res;
     }
-
 }
 
 /*
@@ -209,13 +588,16 @@ 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, $onetimepad, $use_imap_tls, $imap_auth_mech;
 
+    if (!isset($onetimepad) || empty($onetimepad)) {
+        sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION );
+    }
     $imap_server_address = sqimap_get_user_server($imap_server_address, $username);
-       $host=$imap_server_address;
-       
-       if (($use_imap_tls == true) and (check_php_version(4,3)) and (extension_loaded('openssl'))) {
-         /* Use TLS by prefixing "tls://" to the hostname */
-         $imap_server_address = 'tls://' . $imap_server_address;
-       }
+        $host=$imap_server_address;
+        
+        if (($use_imap_tls == true) and (check_php_version(4,3)) and (extension_loaded('openssl'))) {
+          /* Use TLS by prefixing "tls://" to the hostname */
+          $imap_server_address = 'tls://' . $imap_server_address;
+        }
     
     $imap_stream = fsockopen ( $imap_server_address, $imap_port, $error_number, $error_string, 15);
 
@@ -223,11 +605,11 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
     if (!$imap_stream) {
         if (!$hide) {
             set_up_language($squirrelmail_language, true);
-           require_once(SM_PATH . 'functions/display_messages.php');
-           $string = sprintf (_("Error connecting to IMAP server: %s.") .
-                             "<br>\r\n", $imap_server_address) .
+            require_once(SM_PATH . 'functions/display_messages.php');
+            $string = sprintf (_("Error connecting to IMAP server: %s.") .
+                              "<br>\r\n", $imap_server_address) .
                       "$error_number : $error_string<br>\r\n";
-           logout_error($string,$color);
+            logout_error($string,$color);
         }
         exit;
     }
@@ -237,70 +619,77 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
     /* Decrypt the password */
     $password = OneTimePadDecrypt($password, $onetimepad);
 
-       if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) {
-      // We're using some sort of authentication OTHER than plain
-         $tag=sqimap_session_id(false);
-         if ($imap_auth_mech == 'digest-md5') {
-           $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n";
-         } elseif ($imap_auth_mech == 'cram-md5') {
-           $query = $tag . " AUTHENTICATE CRAM-MD5\r\n";
-         }
-         fputs($imap_stream,$query);
-         $answer=sqimap_fgets($imap_stream);
-         // Trim the "+ " off the front
-         $response=explode(" ",$answer,3);
-         if ($response[0] == '+') {
-           // Got a challenge back
-               $challenge=$response[1];
-               if ($imap_auth_mech == 'digest-md5') {
-                 $reply = digest_md5_response($username,$password,$challenge,'imap',$host);
-               } elseif ($imap_auth_mech == 'cram-md5') {
-                 $reply = cram_md5_response($username,$password,$challenge);
-               }
-               fputs($imap_stream,$reply);
-               $read=sqimap_fgets($imap_stream);
-               if ($imap_auth_mech == 'digest-md5') {
-                 // DIGEST-MD5 has an extra step..
-                 if (substr($read,0,1) == '+') { // OK so far..
-                   fputs($imap_stream,"\r\n");
-                   $read=sqimap_fgets($imap_stream);
-                 }
-               }
-               $results=explode(" ",$read,3);
-               $response=$results[1];
-               $message=$results[2];
+        if (($imap_auth_mech == 'cram-md5') OR ($imap_auth_mech == 'digest-md5')) {
+      // We're using some sort of authentication OTHER than plain or login
+          $tag=sqimap_session_id(false);
+          if ($imap_auth_mech == 'digest-md5') {
+            $query = $tag . " AUTHENTICATE DIGEST-MD5\r\n";
+          } elseif ($imap_auth_mech == 'cram-md5') {
+            $query = $tag . " AUTHENTICATE CRAM-MD5\r\n";
+          }
+          fputs($imap_stream,$query);
+          $answer=sqimap_fgets($imap_stream);
+          // Trim the "+ " off the front
+          $response=explode(" ",$answer,3);
+          if ($response[0] == '+') {
+            // Got a challenge back
+                $challenge=$response[1];
+                if ($imap_auth_mech == 'digest-md5') {
+                  $reply = digest_md5_response($username,$password,$challenge,'imap',$host);
+                } elseif ($imap_auth_mech == 'cram-md5') {
+                  $reply = cram_md5_response($username,$password,$challenge);
+                }
+                fputs($imap_stream,$reply);
+                $read=sqimap_fgets($imap_stream);
+                if ($imap_auth_mech == 'digest-md5') {
+                  // DIGEST-MD5 has an extra step..
+                  if (substr($read,0,1) == '+') { // OK so far..
+                    fputs($imap_stream,"\r\n");
+                    $read=sqimap_fgets($imap_stream);
+                  }
+                }
+                $results=explode(" ",$read,3);
+                $response=$results[1];
+                $message=$results[2];
       } else {
-               // Fake the response, so the error trap at the bottom will work
-               $response="BAD";
-               $message='IMAP server does not appear to support the authentication method selected.';
-               $message .= '  Please contact your system administrator.';
+                // Fake the response, so the error trap at the bottom will work
+                $response="BAD";
+                $message='IMAP server does not appear to support the authentication method selected.';
+                $message .= '  Please contact your system administrator.';
       }
-    } else {
-         // Original PLAIN login code
-      $query = 'LOGIN "' . quoteIMAP($username) .  '" "' . quoteIMAP($password) . '"';
+    } elseif ($imap_auth_mech == 'login') {
+          // Original IMAP login code
+      $query = 'LOGIN "' . quoteimap($username) .  '" "' . quoteimap($password) . '"';
       $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
-    }
+    } elseif ($imap_auth_mech == 'plain') {
+                /* Replace this with SASL PLAIN if it ever gets implemented */
+                $response="BAD";
+                $message='SquirrelMail does not support SASL PLAIN yet. Rerun conf.pl and use login instead.';
+        } else {
+                $response="BAD";
+                $message="Internal SquirrelMail error - unknown IMAP authentication method chosen.  Please contact the developers.";
+        }
     
-       /* If the connection was not successful, lets see why */
+        /* If the connection was not successful, lets see why */
     if ($response != 'OK') {
         if (!$hide) {
             if ($response != 'NO') {
                 /* "BAD" and anything else gets reported here. */
-               $message = htmlspecialchars($message);
+                $message = htmlspecialchars($message);
                 set_up_language($squirrelmail_language, true);
-               require_once(SM_PATH . 'functions/display_messages.php');
+                require_once(SM_PATH . 'functions/display_messages.php');
                 if ($response == 'BAD') {
-                   $string = sprintf (_("Bad request: %s")."<br>\r\n", $message);
+                    $string = sprintf (_("Bad request: %s")."<br>\r\n", $message);
                 } else {
-                   $string = sprintf (_("Unknown error: %s") . "<br>\n", $message);
+                    $string = sprintf (_("Unknown error: %s") . "<br>\n", $message);
                 }
-                $string .= '<br>' . _("Read data:") . "<br>\n";
-                if (is_array($read)) {
+                if (isset($read) && is_array($read)) {
+                    $string .= '<br>' . _("Read data:") . "<br>\n";
                     foreach ($read as $line) {
                         $string .= htmlspecialchars($line) . "<br>\n";
                     }
                 }
-               error_box($string,$color);
+                error_box($string,$color);
                 exit;
             } else {
                 /*
@@ -316,7 +705,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
                 
                 set_up_language($squirrelmail_language, true);
                 include_once(SM_PATH . 'functions/display_messages.php' );
-               sqsession_destroy();
+                sqsession_destroy();
                 logout_error( _("Unknown user or password incorrect.") );
                 exit;
             }
@@ -351,11 +740,11 @@ function sqimap_capability($imap_stream, $capability='') {
         }
     }
     if ($capability) {
-       if (isset($sqimap_capabilities[$capability])) {
-           return $sqimap_capabilities[$capability];
-       } else {
-           return false;
-       }
+        if (isset($sqimap_capabilities[$capability])) {
+                return $sqimap_capabilities[$capability];
+        } else {
+                return false;
+        }
     }
     return $sqimap_capabilities;
 }
@@ -406,9 +795,18 @@ function sqimap_get_delimiter ($imap_stream = false) {
 }
 
 
+/* This is a straight copy of imap_mailbox.php:encode_mailbox_name() */
+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];
@@ -418,69 +816,182 @@ function sqimap_get_num_messages ($imap_stream, $mailbox) {
 }
 
 
-/* Returns a displayable email address.
- *     Luke Ehresman <lehresma@css.tayloru.edu>
- *     "Luke Ehresman" <lehresma@css.tayloru.edu>
- *     <lehresma@css.tayloru.edu>
- *     lehresma@css.tayloru.edu (Luke Ehresman)
- *     lehresma@css.tayloru.edu
- * becomes: lehresma@css.tayloru.edu
- */
-function sqimap_find_email ($string) {
-    if (ereg("<([^>]+)>", $string, $regs)) {
-        $string = $regs[1];
-    } else if (ereg("([^ ]+@[^ ]+)", $string, $regs)) {
-        $string = $regs[1];
+function parseAddress($address, $max=0) {
+    $aTokens = array();
+    $aAddress = array();
+    $iCnt = strlen($address);
+    $aSpecials = array('(' ,'<' ,',' ,';' ,':');
+    $aReplace =  array(' (',' <',' ,',' ;',' :');
+    $address = str_replace($aSpecials,$aReplace,$address);
+    $i = $iAddrFound = $bGroup = 0;
+    while ($i < $iCnt) {
+        $cChar = $address{$i};
+        switch($cChar)
+        {
+        case '<':
+            $iEnd = strpos($address,'>',$i+1);
+            if (!$iEnd) {
+               $sToken = substr($address,$i);
+               $i = $iCnt;
+            } else {
+               $sToken = substr($address,$i,$iEnd - $i +1);
+               $i = $iEnd;
+            }
+            $sToken = str_replace($aReplace, $aSpecials,$sToken);
+            $aTokens[] = $sToken;
+            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;
+            } else {
+                // also remove the surrounding quotes
+                $sToken = substr($address,$i+1,$iEnd - $i -1);
+                $i = $iEnd;
+            }
+            $sToken = str_replace($aReplace, $aSpecials,$sToken);
+            if ($sToken) $aTokens[] = $sToken;
+            break;
+        case '(':
+            $iEnd = strpos($address,')',$i);
+            if (!$iEnd) {
+                $sToken = substr($address,$i);
+                $i = $iCnt;
+            } else {
+                $sToken = substr($address,$i,$iEnd - $i + 1);
+                $i = $iEnd;
+            }
+            $sToken = str_replace($aReplace, $aSpecials,$sToken);
+            $aTokens[] = $sToken;
+            break;
+        case ',':
+            ++$iAddrFound;
+        case ';':
+            if (!$bGroup) {
+               ++$iAddrFound;
+            } else {
+               $bGroup = false;
+            }
+            if ($max && $max == $iAddrFound) {
+               break 2;
+            } else {
+               $aTokens[] = $cChar;
+               break;
+            }
+        case ':':
+           $bGroup = true;
+        case ' ':
+            $aTokens[] = $cChar;
+            break;
+        default:
+            $iEnd = strpos($address,' ',$i+1);
+            if ($iEnd) {
+                $sToken = trim(substr($address,$i,$iEnd - $i));
+                $i = $iEnd-1;
+            } else {
+                $sToken = trim(substr($address,$i));
+                $i = $iCnt;
+            }
+            if ($sToken) $aTokens[] = $sToken;
+        }
+        ++$i;
     }
-    return trim($string);
-}
-
-
-/*
- * 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);
-
-    if ( ereg('^(.+)<.*>', $string, $regs) ) {
-        $orig_string = $string;
-        $string = str_replace ('"', '', $regs[1] );
-        if (trim($string) == '') {
-             $string = sqimap_find_email($orig_string);
+    $sPersonal = $sEmail = $sComment = $sGroup = '';
+    $aStack = $aComment = array();
+    foreach ($aTokens as $sToken) {
+        if ($max && $max == count($aAddress)) {
+            return $aAddress;
         }
-        if( $string == '' || $string == ' ' ){
-            $string = '&nbsp';
+        $cChar = $sToken{0};
+        switch ($cChar)
+        {
+          case '=':
+          case '"':
+          case ' ':
+            $aStack[] = $sToken; 
+            break;
+          case '(':
+            $aComment[] = substr($sToken,1,-1);
+            break;
+          case ';':
+            if ($sGroup) {
+                $sEmail = trim(implode(' ',$aStack));
+                $aAddress[] = array($sGroup,$sEmail);
+                $aStack = $aComment = array();
+                $sGroup = '';
+                break;
+            }
+          case ',':
+            if (!$sEmail) {
+                while (count($aStack) && !$sEmail) {
+                    $sEmail = trim(array_pop($aStack));
+                }
+            }
+            if (count($aStack)) {
+                $sPersonal = trim(implode('',$aStack));
+            } else { 
+                $sPersonal = '';
+            }
+            if (!$sPersonal && count($aComment)) {
+                $sComment = implode(' ',$aComment);
+                $sPersonal .= $sComment;
+            }
+            $aAddress[] = array($sEmail,$sPersonal);
+            $sPersonal = $sComment = $sEmail = '';
+            $aStack = $aComment = array();
+            break;
+          case ':': 
+            $sGroup = implode(' ',$aStack); break;
+            $aStack = array();
+            break;
+          case '<':
+            $sEmail = trim(substr($sToken,1,-1));
+            break;
+          case '>':
+            /* skip */
+            break; 
+          default: $aStack[] = $sToken; break;
         }
     }
-    elseif ( ereg('\((.*)\)', $string, $regs) ) {
-        if( ( $regs[1] == '' ) || ( $regs[1] == ' ' ) ){
-            if ( ereg('^(.+) \(', $string, $regs) ) {
-               $string = ereg_replace( ' \(\)$', '', $string );
-            } else {
-               $string = '&nbsp';
-            }
-        } else {
-            $string = $regs[1];
+    /* now do the action again for the last address */
+    if (!$sEmail) {
+        while (count($aStack) && !$sEmail) {
+            $sEmail = trim(array_pop($aStack));
         }
     }
-    else {
-        $string = str_replace ('"', '', sqimap_find_email($string));
+    if (count($aStack)) {
+        $sPersonal = trim(implode('',$aStack));
+    } else {
+        $sPersonal = '';
     }
+    if (!$sPersonal && count($aComment)) {
+        $sComment = implode(' ',$aComment);
+        $sPersonal .= $sComment;
+    }
+    $aAddress[] = array($sEmail,$sPersonal);
+    return $aAddress;
+} 
+
 
-    return trim($string);
-}
 
 /*
  * 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])) {
@@ -496,20 +1007,23 @@ function sqimap_unseen_messages ($imap_stream, $mailbox) {
  * Returns the number of unseen/total messages in this folder
  */
 function sqimap_status_messages ($imap_stream, $mailbox) {
-    $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (MESSAGES UNSEEN)", 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 = false;
+    $messages = $unseen = $recent = false;
     $regs = array(false,false);
     while (isset($read_ary[$i])) {
         if (preg_match('/UNSEEN\s+([0-9]+)/i', $read_ary[$i], $regs)) {
-           $unseen = $regs[1];
-       }
+            $unseen = $regs[1];
+        }
         if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) {
-           $messages = $regs[1];
-       }
+            $messages = $regs[1];
+        }
+        if (preg_match('/RECENT\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+            $recent = $regs[1];
+        }        
         $i++;
     }
-    return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen);
+    return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen, 'RECENT' => $recent);
 }
 
 
@@ -517,7 +1031,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);
 }
 
@@ -528,29 +1042,29 @@ function sqimap_append_done ($imap_stream, $folder='') {
     if (preg_match("/(.*)(BAD|NO)(.*)$/", $tmp, $regs)) {
         set_up_language($squirrelmail_language);
         require_once(SM_PATH . 'functions/display_messages.php');
-       $reason = $regs[3];
-       if ($regs[2] == 'NO') {
-          $string = "<b><font color=$color[2]>\n" .
-                 _("ERROR : Could not append message to") ." $folder." .
-                 "</b><br>\n" .
-                 _("Server responded: ") .
-                 $reason . "<br>\n";
-          if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) {
-             $string .= _("Solution: ") . 
-           _("Remove unneccessary messages from your folder and start with your Trash folder.") 
-             ."<br>\n";
-          }
-          $string .= "</font>\n";
-          error_box($string,$color);
-       } else {
+        $reason = $regs[3];
+        if ($regs[2] == 'NO') {
+           $string = "<b><font color=$color[2]>\n" .
+                  _("ERROR : Could not append message to") ." $folder." .
+                  "</b><br>\n" .
+                  _("Server responded: ") .
+                  $reason . "<br>\n";
+           if (preg_match("/(.*)(quota)(.*)$/i", $reason, $regs)) {
+              $string .= _("Solution: ") . 
+            _("Remove unneccessary messages from your folder and start with your Trash folder.") 
+              ."<br>\n";
+           }
+           $string .= "</font>\n";
+           error_box($string,$color);
+        } else {
            $string = "<b><font color=$color[2]>\n" .
-                 _("ERROR : Bad or malformed request.") .
-                 "</b><br>\n" .
-                 _("Server responded: ") .
-                 $tmp . "</font><br>\n";
-          error_box($string,$color);
+                  _("ERROR : Bad or malformed request.") .
+                  "</b><br>\n" .
+                  _("Server responded: ") .
+                  $tmp . "</font><br>\n";
+           error_box($string,$color);
            exit;
-       }
+        }
     }
 }