This makes more sense to me, and has been shown not to break anything, and while...
[squirrelmail.git] / functions / imap_general.php
index 82c1b832d6e29ddafca950a53d02415245ae226e..4a97406fa62cf00b7cf70c288323d160820157e9 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.
@@ -11,7 +11,9 @@
  * $Id$
  */
 
-require_once('../functions/page_header.php');
+require_once(SM_PATH . 'functions/page_header.php');
+require_once(SM_PATH . 'functions/auth.php');
+
 
 global $sqimap_session_id;
 $sqimap_session_id = 1;
@@ -31,160 +33,177 @@ function sqimap_session_id($unique_id = false) {
  * This is to allow proper session number handling.
  */
 function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
-    $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;
+    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;
+    } else {
+        global $squirrelmail_language, $color;
+        set_up_language($squirrelmail_language);
+        require_once(SM_PATH . 'functions/display_messages.php');
+        $string = "<b><font color=$color[2]>\n" .
+                _("ERROR : No available imapstream.") .
+                "</b></font>\n";
+        error_box($string,$color);
+       return false;
+    }
+    
 }
 
 function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response, &$message, $unique_id = false) {
-    $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;
+    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;
+    } else {
+        global $squirrelmail_language, $color;
+        set_up_language($squirrelmail_language);
+        require_once(SM_PATH . 'functions/display_messages.php');
+        $string = "<b><font color=$color[2]>\n" .
+                _("ERROR : No available imapstream.") .
+                "</b></font>\n";
+        error_box($string,$color);
+       return false;
+    }
+    
 }
 
 
+/* 
+ * custom fgets function. gets a line from IMAP
+ * no matter how big it may be
+ */
+
+function sqimap_fgets($imap_stream) {
+    $read = '';
+    $buffer = 4096;
+    $results = '';
+    $offset = 0;
+    while (strpos($results, "\r\n", $offset) === false) {
+        if (!($read = fgets($imap_stream, $buffer))) {
+            break;
+        }
+        if ( $results != '' ) {
+            $offset = strlen($results) - 1;
+        }
+        $results .= $read;
+    }
+    return $results;
+}
+
 /*
  * 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 = '') {
     global $color, $squirrelmail_language;
-
     $read = '';
-    $bufsize = 9096;
-    $resultlist = array();
     $pre_a = explode(' ',trim($pre));
     $pre = $pre_a[0];
-    $more_msgs = true;
-    while ($more_msgs) {
-        $data = array();
-        $total_size = 0;
-
-        while (strpos($read, "\n") === false) {
-            if(!($read .= fgets($imap_stream, $bufsize))) {
-                break;
-            }
-        }
-        if (preg_match('/^\* [0-9]+ FETCH.*\{([0-9]+)\}/', $read, $regs)) {
-           $size = $regs[1];
-        } else if (preg_match('/^\* [0-9]+ FETCH/', $read, $regs)) {
-            /* Sizeless response, probably single-line */
-            $size = -1;
-            $data[] = $read;
-            $read = fgets($imap_stream, $bufsize);
-        } else {
-            $size = -1;
-        }
-        while (1) {
-            while (strpos($read, "\n") === false) {
-                if(!($read .= fgets($imap_stream, $bufsize))) {
-                    break;
+    $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 we know the size, no need to look at the end parameters */
-           /* In case of a totalsize > size we do have to look at the end
-              parameters because there can exists literals inside bodystructures.
-           */  
-            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) {
-                   $size = -1; /* switch to end parameters in case of literals inside a bodystructure */
-                    $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));
-                } else {
-                    $data[] = $read;
-                    $read = fgets($imap_stream, $bufsize);
-                    while (strpos($read, "\n") === false) {
-                      $read .= fgets($imap_stream, $bufsize);
-                    }
+                if (isset($last) && preg_match('/^\)/', $last)) {
+                    array_pop($fetch_data);
                 }
-                $total_size += strlen($read);
-            } else {
-                if (preg_match("/^$pre (OK|BAD|NO)(.*)/", $read, $regs) ||
-                    (($size == -1) && preg_match('/^\* [0-9]+ FETCH.*/', $read, $regs))) {
-                    break;
-                } else if ( preg_match('/^\* OK \[PARSE.*/', $read, $regs ) ) {
-                    /*
-                     * This block has been added in order to avoid the problem
-                     * caused by the * OK [PARSE] Missing parameter answer
-                     * Please, replace it with a better parsing if you know how.
-                     * This block has been updated by
-                     * Seth E. Randall <sethr@missoulafcu.org>.  Once we see
-                     * one OK [PARSE line, we just go through and keep
-                     * tossing them out until we get something different.
-                     */
-                    while ( preg_match('/^\* OK \[PARSE.*/', $read, $regs ) ) {
-                        $read = fgets($imap_stream, $bufsize);
-                    }
-                    $data[] = $read;
-                    $read = fgets ($imap_stream, $bufsize);
-                } else if (preg_match('/^\* BYE \[ALERT\](.*)/', $read, $regs)) {
-                    /*
-                     * It seems that the IMAP server has coughed up a lung
-                     * and hung up the connection.  Print any info we have
-                     * and abort.
-                     */
-                    echo _("Please contact your system administrator and report the following error:") . "<br>\n";
-                    echo $regs[1];
-                    exit;
-                } else {
-                    $data[] = $read;
-                    $read = fgets ($imap_stream, $bufsize);
-                }
-            }
-        }
-
-        while (($more_msgs = !preg_match("/^$pre (OK|BAD|NO)(.*)$/", $read, $regs)) &&
-            !preg_match("/^\* [0-9]+ FETCH.*/", $read, $regs)) {
-            $read = fgets($imap_stream, $bufsize);
+                $resultlist[] = $fetch_data;
+                break 1;
+            default:
+                $data[] = $read;
+                $read = sqimap_fgets($imap_stream);
+                break 1;
         }
+    }
+    if (!empty($data)) {
         $resultlist[] = $data;
     }
-
-    $response = $regs[1];
-    $message = trim($regs[2]);
-
+    elseif (empty($resultlist)) {
+        $resultlist[] = array(); 
+    }
     if ($handle_errors == false) {
         return( $resultlist );
-    } else if ($response == 'NO') {
-        /* ignore this error from M$ exchange, it is not fatal (aka bug) */
+    } 
+    elseif ($response == 'NO') {
+    /* ignore this error from M$ exchange, it is not fatal (aka bug) */
         if (strstr($message, 'command resulted in') === false) {
             set_up_language($squirrelmail_language);
-            echo "<br><b><font color=$color[2]>\n" .
-                 _("ERROR : Could not complete request.") .
-                 "</b><br>\n" .
-                 _("Query:") .
-                 $query . '<br>' .
-                 _("Reason Given: ") .
-                 $message . "</font><br>\n";
+           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);
             exit;
         }
-    } else if ($response == 'BAD') {
+    } 
+    elseif ($response == 'BAD') {
         set_up_language($squirrelmail_language);
-        echo "<br><b><font color=$color[2]>\n" .
-             _("ERROR : Bad or malformed request.") .
-             "</b><br>\n" .
-             _("Query:") .
-             $query . '<br>' .
-             _("Server responded: ") .
-             $message . "</font><br>\n";
+       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);    
         exit;
-    } else {
+    } 
+    else {
         return $resultlist;
     }
 }
 
 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);
-    return $res[0];
+  
+    /* sqimap_read_data should be called for one response
+       but since it just calls sqimap_read_data_list 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($result)) {
+        return $result;
+    }
+    else {
+        return $res[0];
+    }
+
 }
 
 /*
@@ -192,47 +211,107 @@ function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$mes
  * will be displayed.  This function returns the imap connection handle.
  */
 function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
-    global $color, $squirrelmail_language, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
-
+    global $color, $squirrelmail_language, $onetimepad, $use_imap_tls, $imap_auth_mech;
+
+    $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;
+       }
+    
     $imap_stream = fsockopen ( $imap_server_address, $imap_port, $error_number, $error_string, 15);
-    if ( !$imap_stream ) {
-        return false;
-    }
-    $server_info = fgets ($imap_stream, 1024);
-
-    /* Decrypt the password */
-    $password = OneTimePadDecrypt($password, $onetimepad);
 
     /* Do some error correction */
     if (!$imap_stream) {
         if (!$hide) {
             set_up_language($squirrelmail_language, true);
-            printf (_("Error connecting to IMAP server: %s.")."<br>\r\n", $imap_server_address);
-            echo "$error_number : $error_string<br>\r\n";
+           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);
         }
         exit;
     }
 
-    $query = 'LOGIN "' . quoteIMAP($username) .  '" "' . quoteIMAP($password) . '"';
-    $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
+    $server_info = fgets ($imap_stream, 1024);
 
-    /* If the connection was not successful, lets see why */
+    /* 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 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.';
+      }
+    } 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 ($response != 'OK') {
         if (!$hide) {
             if ($response != 'NO') {
                 /* "BAD" and anything else gets reported here. */
+               $message = htmlspecialchars($message);
                 set_up_language($squirrelmail_language, true);
+               require_once(SM_PATH . 'functions/display_messages.php');
                 if ($response == 'BAD') {
-                   printf (_("Bad request: %s")."<br>\r\n", $message);
+                   $string = sprintf (_("Bad request: %s")."<br>\r\n", $message);
                 } else {
-                   printf (_("Unknown error: %s") . "<br>\n", $message);
+                   $string = sprintf (_("Unknown error: %s") . "<br>\n", $message);
                 }
-                echo '<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) {
-                        echo htmlspecialchars($line) . "<br>\n";
+                        $string .= htmlspecialchars($line) . "<br>\n";
                     }
                 }
+               error_box($string,$color);
                 exit;
             } else {
                 /*
@@ -247,9 +326,9 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
                  */
                 
                 set_up_language($squirrelmail_language, true);
-                include_once( '../functions/display_messages.php' );
-                logout_error( _("Unknown user or password incorrect.") );                
-                session_destroy();
+                include_once(SM_PATH . 'functions/display_messages.php' );
+               sqsession_destroy();
+                logout_error( _("Unknown user or password incorrect.") );
                 exit;
             }
         } else {
@@ -261,8 +340,10 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
 
 /* Simply logs out the IMAP session */
 function sqimap_logout ($imap_stream) {
-    /* Logout is not valid until the server returns 'BYE' */
-    sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
+    /* Logout is not valid until the server returns 'BYE'
+     * If we don't have an imap_ stream we're already logged out */
+    if(isset($imap_stream) && $imap_stream)
+        sqimap_run_command($imap_stream, 'LOGOUT', false, $response, $message);
 }
 
 function sqimap_capability($imap_stream, $capability='') {
@@ -338,13 +419,13 @@ function sqimap_get_delimiter ($imap_stream = false) {
 
 /* 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\"", true, $result, $message);
+    $read_ary = sqimap_run_command ($imap_stream, "EXAMINE \"$mailbox\"", false, $result, $message);
     for ($i = 0; $i < count($read_ary); $i++) {
         if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
             return $regs[1];
         }
     }
-    return "BUG! Couldn't get number of messages in $mailbox!";
+    return false; //"BUG! Couldn't get number of messages in $mailbox!";
 }
 
 
@@ -385,7 +466,7 @@ function sqimap_find_displayable_name ($string) {
              $string = sqimap_find_email($orig_string);
         }
         if( $string == '' || $string == ' ' ){
-            $string = '&nbsp';
+            $string = '&nbsp;';
         }
     }
     elseif ( ereg('\((.*)\)', $string, $regs) ) {
@@ -393,7 +474,7 @@ function sqimap_find_displayable_name ($string) {
             if ( ereg('^(.+) \(', $string, $regs) ) {
                $string = ereg_replace( ' \(\)$', '', $string );
             } else {
-               $string = '&nbsp';
+               $string = '&nbsp;';
             }
         } else {
             $string = $regs[1];
@@ -410,8 +491,9 @@ function sqimap_find_displayable_name ($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)", true, $result, $message);
+    $read_ary = sqimap_run_command ($imap_stream, "STATUS \"$mailbox\" (UNSEEN)", false, $result, $message);
     $i = 0;
+    $regs = array(false, false);
     while (isset($read_ary[$i])) {
         if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) {
             break;
@@ -421,6 +503,26 @@ function sqimap_unseen_messages ($imap_stream, $mailbox) {
     return $regs[1];
 }
 
+/*
+ * 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);
+    $i = 0;
+    $messages = $unseen = 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];
+       }
+        if (preg_match('/MESSAGES\s+([0-9]+)/i', $read_ary[$i], $regs)) {
+           $messages = $regs[1];
+       }
+        $i++;
+    }
+    return array('MESSAGES' => $messages, 'UNSEEN'=>$unseen);
+}
+
 
 /*
  *  Saves a message to a given folder -- used for saving sent messages
@@ -430,9 +532,55 @@ function sqimap_append ($imap_stream, $sent_folder, $length) {
     $tmp = fgets ($imap_stream, 1024);
 }
 
-function sqimap_append_done ($imap_stream) {
+function sqimap_append_done ($imap_stream, $folder='') {
+    global $squirrelmail_language, $color;
     fputs ($imap_stream, "\r\n");
     $tmp = fgets ($imap_stream, 1024);
+    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 {
+           $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);
+           exit;
+       }
+    }
 }
 
+function sqimap_get_user_server ($imap_server, $username) {
+   if (substr($imap_server, 0, 4) != "map:") {
+       return $imap_server;
+   }
+   $function = substr($imap_server, 4);
+   return $function($username);
+}
+
+/* This is an example that gets imapservers from yellowpages (NIS).
+ * you can simple put map:map_yp_alias in your $imap_server_address 
+ * in config.php use your own function instead map_yp_alias to map your
+ * LDAP whatever way to find the users imapserver. */
+
+function map_yp_alias($username) {
+   $yp = `ypmatch $username aliases`;
+   return chop(substr($yp, strlen($username)+1));
+} 
+
 ?>