X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_general.php;h=c58f0907cffe6df997395aa357e2267fff3e568f;hp=9d9638258f44e5468fcc22b645bff99a049f972e;hb=0b97a708e71c931153cd1ceee1495c9f4e1e209b;hpb=2a32fc83f95eba42be0d1752ef685adf10e1edc9

diff --git a/functions/imap_general.php b/functions/imap_general.php
index 9d963825..c58f0907 100755
--- a/functions/imap_general.php
+++ b/functions/imap_general.php
@@ -1,249 +1,445 @@
-<?
-   /**
-    **  imap.php
-    **
-    **  This implements all functions that do general imap functions.
-    **/
-
-   /******************************************************************************
-    **  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 ($imap_stream, $pre, $handle_errors, $response, $message) {
-      global $color;
-
-      $read = fgets ($imap_stream, 1024);
-      $counter = 0;
-      while ((substr($read, 0, strlen("$pre OK")) != "$pre OK") &&
-             (substr($read, 0, strlen("$pre BAD")) != "$pre BAD") &&
-             (substr($read, 0, strlen("$pre NO")) != "$pre NO")) {
-         $data[$counter] = $read;
-         $read = fgets ($imap_stream, 1024);
-         $counter++;
-      }       
-      if (substr($read, 0, strlen("$pre OK")) == "$pre OK") {
-         $response = "OK";
-         $message = trim(substr($read, strlen("$pre OK"), strlen($read)));
-      }
-      else if (substr($read, 0, strlen("$pre BAD")) == "$pre BAD") {
-         $response = "BAD";
-         $message = trim(substr($read, strlen("$pre BAD"), strlen($read)));
-      }
-      else {   
-         $response = "NO";
-         $message = trim(substr($read, strlen("$pre NO"), strlen($read)));
-      }
-
-      if ($handle_errors == true) {
-         if ($response == "NO") {
-            echo "<br><b><font color=$color[2]>";
-            echo _("ERROR : Could not complete request.");
-            echo "</b><br>";
-            echo _("Reason Given: ");
-            echo "$message</font><br>";
-            exit;
-         } else if ($response == "BAD") {
-            echo "<br><b><font color=$color[2]>";
-            echo _("ERROR : Bad or malformed request.");
-            echo "</b><br>";
-            echo _("Server responded: ");
-            echo "$message</font><br>";
+<?php
+
+/**
+ * imap_general.php
+ *
+ * Copyright (c) 1999-2002 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.
+ *
+ * $Id$
+ */
+
+require_once(SM_PATH . 'functions/page_header.php');
+
+global $sqimap_session_id;
+$sqimap_session_id = 1;
+
+/* Sets an unique session id in order to avoid simultanous sessions crash. */
+function sqimap_session_id($unique_id = false) {
+    global $data_dir, $username, $sqimap_session_id;
+    if (!$unique_id) {
+	return( sprintf("A%03d", $sqimap_session_id++) );
+    } else {
+	return( sprintf("A%03d", $sqimap_session_id++) . ' UID' );
+    }
+}
+
+/*
+ * Both send a command and accept the result from the command.
+ * 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;
+}
+
+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;
+}
+
+
+/* 
+ * custom fgets function. gets a line from IMAP
+ * no matter how big it may be
+ */
+
+function sqimap_fgets($imap_stream) {
+    $read = '';
+    $buffer = 4096;
+    $results = '';
+    while (strpos($read, "\n") === false) {
+        if (!($read = fgets($imap_stream, $buffer))) {
+            break;
+        }
+        $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 = '';
+    $pre_a = explode(' ',trim($pre));
+    $pre = $pre_a[0];
+    $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);
+                }
+                $resultlist[] = $fetch_data;
+                break 1;
+            default:
+                $data[] = $read;
+                $read = sqimap_fgets($imap_stream);
+                break 1;
+        }
+    }
+    if (!empty($data)) {
+        $resultlist[] = $data;
+    }
+    elseif (empty($resultlist)) {
+        $resultlist[] = array(); 
+    }
+    if ($handle_errors == false) {
+        return( $resultlist );
+    } 
+    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";
             exit;
-         }
-      }
-      
-      return $data;
-   }
-   
-
-
-   
-   /******************************************************************************
-    **  Logs the user into the imap server.  If $hide is set, no error messages
-    **  will be displayed.  This function returns the imap connection handle.
-    ******************************************************************************/
-   function sqimap_login ($username, $password, $imap_server_address, $imap_port, $hide) {
-      global $color;
-      global $PHPSESSID;
-      $imap_stream = fsockopen ($imap_server_address, $imap_port, &$error_number, &$error_string);
-      $server_info = fgets ($imap_stream, 1024);
-      
-      /** Do some error correction **/
-      if (!$imap_stream) {
-         if (!$hide) {
-            echo "Error connecting to IMAP server: $imap_server_address.<br>\r\n";
+        }
+    } 
+    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";
+        exit;
+    } 
+    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);
+  
+    /* 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];
+    }
+
+}
+
+/*
+ * Logs the user into the imap server.  If $hide is set, no error messages
+ * 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, $onetimepad;
+
+    $imap_server_address = sqimap_get_user_server($imap_server_address, $username);
+
+    $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";
-         }
-         exit;
-      }
-
-      fputs ($imap_stream, "a001 LOGIN \"$username\" \"$password\"\r\n");
-      $read = fgets ($imap_stream, 1024);
-
-      /** If the connection was not successful, lets see why **/
-      if (substr($read, 0, 7) != "a001 OK") {
-         if (!$hide) {
-            if (substr($read, 0, 8) == "a001 BAD") {
-               echo "Bad request: $read<br>\r\n";
-               exit;
-            } else if (substr($read, 0, 7) == "a001 NO") {
-               ?>
-                  <html>
-                     <body bgcolor=ffffff>
-                        <br>
-                        <center>
-                        <table width=70% noborder bgcolor=ffffff align=center>
-                           <tr>
-                              <td bgcolor=dcdcdc>
-                                 <font color=cc0000>
-                                 <center>
-                                 <? echo _("ERROR") ?>
-                                 </center>
-                                 </font>
-                              </td>
-                           </tr>
-                           <tr>
-                              <td>
-                                 <center>
-                                 <? echo _("Unknown user or password incorrect.") ?><br>
-                                 <a href="login.php"><? echo _("Click here to try again") ?></a>
-                                 </center>
-                              </td>
-                           </tr>
-                        </table>
-                        </center>
-                     </body>
-                  </html>
-               <?
-               session_destroy();
-               exit;
+        }
+        exit;
+    }
+
+    $query = 'LOGIN "' . quoteIMAP($username) .  '" "' . quoteIMAP($password) . '"';
+    $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
+
+    /* If the connection was not successful, lets see why */
+    if ($response != 'OK') {
+        if (!$hide) {
+            if ($response != 'NO') {
+                /* "BAD" and anything else gets reported here. */
+                set_up_language($squirrelmail_language, true);
+                if ($response == 'BAD') {
+                   printf (_("Bad request: %s")."<br>\r\n", $message);
+                } else {
+                   printf (_("Unknown error: %s") . "<br>\n", $message);
+                }
+                echo '<br>' . _("Read data:") . "<br>\n";
+                if (is_array($read)) {
+                    foreach ($read as $line) {
+                        echo htmlspecialchars($line) . "<br>\n";
+                    }
+                }
+                exit;
             } else {
-               echo "Unknown error: $read<br>";
-               exit;
+                /*
+                 * If the user does not log in with the correct
+                 * username and password it is not possible to get the
+                 * correct locale from the user's preferences.
+                 * Therefore, apply the same hack as on the login
+                 * screen.
+                 *
+                 * $squirrelmail_language is set by a cookie when
+                 * the user selects language and logs out
+                 */
+                
+                set_up_language($squirrelmail_language, true);
+                include_once(SM_PATH . 'functions/display_messages.php' );
+                logout_error( _("Unknown user or password incorrect.") );
+                session_destroy();
+                exit;
             }
-         } else {
+        } else {
             exit;
-         }
-      }
+        }
+    }
+    return $imap_stream;
+}
 
-      return $imap_stream;
-   }
+/* 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);
+}
 
+function sqimap_capability($imap_stream, $capability='') {
+    global $sqimap_capabilities;
+    if (!is_array($sqimap_capabilities)) {
+        $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
 
-   
-   
-   /******************************************************************************
-    **  Simply logs out the imap session
-    ******************************************************************************/
-   function sqimap_logout ($imap_stream) {
-      fputs ($imap_stream, "a001 LOGOUT\r\n");
-   }
+        $c = explode(' ', $read[0]);
+        for ($i=2; $i < count($c); $i++) {
+            $cap_list = explode('=', $c[$i]);
+            if (isset($cap_list[1])) {
+                $sqimap_capabilities[$cap_list[0]] = $cap_list[1];
+            } else {
+                $sqimap_capabilities[$cap_list[0]] = TRUE;
+            }
+        }
+    }
+    if ($capability) {
+	if (isset($sqimap_capabilities[$capability])) {
+    	    return $sqimap_capabilities[$capability];
+	} else {
+    	    return false;
+	}
+    }
+    return $sqimap_capabilities;
+}
 
+/* Returns the delimeter between mailboxes: INBOX/Test, or INBOX.Test */
+function sqimap_get_delimiter ($imap_stream = false) {
+    global $sqimap_delimiter, $optional_delimiter;
 
+    /* Use configured delimiter if set */
+    if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
+        return $optional_delimiter;
+    }
 
-   /******************************************************************************
-    **  Returns the delimeter between mailboxes:  INBOX/Test, or INBOX.Test... 
-    ******************************************************************************/
-   function sqimap_get_delimiter ($imap_stream) {
-      fputs ($imap_stream, ". LSUB \"\" *\r\n");
-      $read = sqimap_read_data($imap_stream, ".", true, $a, $b);
-      $quote_position = strpos ($read[0], "\"");
-      $delim = substr ($read[0], $quote_position+1, 1);
+    /* Do some caching here */
+    if (!$sqimap_delimiter) {
+        if (sqimap_capability($imap_stream, 'NAMESPACE')) {
+            /*
+             * According to something that I can't find, this is supposed to work on all systems
+             * OS: This won't work in Courier IMAP.
+             * OS: According to rfc2342 response from NAMESPACE command is:
+             * OS: * NAMESPACE (PERSONAL NAMESPACES) (OTHER_USERS NAMESPACE) (SHARED NAMESPACES)
+             * OS: We want to lookup all personal NAMESPACES...
+             */
+            $read = sqimap_run_command($imap_stream, 'NAMESPACE', true, $a, $b);
+            if (eregi('\\* NAMESPACE +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL) +(\\( *\\(.+\\) *\\)|NIL)', $read[0], $data)) {
+                if (eregi('^\\( *\\((.*)\\) *\\)', $data[1], $data2)) {
+                    $pn = $data2[1];
+                }
+                $pna = explode(')(', $pn);
+                while (list($k, $v) = each($pna)) {
+                    $lst = explode('"', $v);
+                    if (isset($lst[3])) {
+                        $pn[$lst[1]] = $lst[3];
+                    } else {
+                        $pn[$lst[1]] = '';
+                    }
+                }
+            }
+            $sqimap_delimiter = $pn[0];
+        } else {
+            fputs ($imap_stream, ". LIST \"INBOX\" \"\"\r\n");
+            $read = sqimap_read_data($imap_stream, '.', true, $a, $b);
+            $quote_position = strpos ($read[0], '"');
+            $sqimap_delimiter = substr ($read[0], $quote_position+1, 1);
+        }
+    }
+    return $sqimap_delimiter;
+}
 
-      return $delim;
-   }
 
+/* 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);
+    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!";
+}
 
 
+/* 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];
+    }
+    return trim($string);
+}
 
-   /******************************************************************************
-    **  Gets the number of messages in the current mailbox. 
-    ******************************************************************************/
-   function sqimap_get_num_messages ($imap_stream, $mailbox) {
-      fputs ($imap_stream, "a001 EXAMINE \"$mailbox\"\r\n");
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
-      for ($i = 0; $i < count($read_ary); $i++) {
-         if (substr(trim($read_ary[$i]), -6) == EXISTS) {
-            $array = explode (" ", $read_ary[$i]);
-            $num = $array[1];
-         }
-      }
-      return $num;
-   }
 
-   
-   /******************************************************************************
-    **  Returns a displayable email address 
-    ******************************************************************************/
-   function sqimap_find_email ($string) {
-      /** Luke Ehresman <lehresma@css.tayloru.edu>
-       ** <lehresma@css.tayloru.edu>
-       ** lehresma@css.tayloru.edu
-       **/
-
-      if (strpos($string, "<") && strpos($string, ">")) {
-         $string = substr($string, strpos($string, "<")+1);
-         $string = substr($string, 0, strpos($string, ">"));
-      }
-      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);
 
-   
-   /******************************************************************************
-    **  Takes the From: field, and creates a displayable name.
-    **    Luke Ehresman <lkehresman@yahoo.com>
-    **           becomes:   Luke Ehresman
-    **    <lkehresman@yahoo.com>
-    **           becomes:   lkehresman@yahoo.com
-    ******************************************************************************/
-   function sqimap_find_displayable_name ($string) {
-      $string = " ".trim($string);
-      if (strpos($string, "<") && strpos($string, ">")) {
-         if (strpos($string, "<") == 1) {
-            $string = sqimap_find_email($string);
-         } else {
-            $string = trim($string);
-            $string = substr($string, 0, strpos($string, "<"));
-            $string = ereg_replace ("\"", "", $string);   
-         }   
-      }
-      return $string; 
-   }
+    if ( ereg('^(.+)<.*>', $string, $regs) ) {
+        $orig_string = $string;
+        $string = str_replace ('"', '', $regs[1] );
+        if (trim($string) == '') {
+             $string = sqimap_find_email($orig_string);
+        }
+        if( $string == '' || $string == ' ' ){
+            $string = '&nbsp';
+        }
+    }
+    elseif ( ereg('\((.*)\)', $string, $regs) ) {
+        if( ( $regs[1] == '' ) || ( $regs[1] == ' ' ) ){
+            if ( ereg('^(.+) \(', $string, $regs) ) {
+               $string = ereg_replace( ' \(\)$', '', $string );
+            } else {
+               $string = '&nbsp';
+            }
+        } else {
+            $string = $regs[1];
+        }
+    }
+    else {
+        $string = str_replace ('"', '', sqimap_find_email($string));
+    }
 
+    return trim($string);
+}
 
-   
-   /******************************************************************************
-    **  Returns the number of unseen messages in this folder 
-    ******************************************************************************/
-   function sqimap_unseen_messages ($imap_stream, &$num_unseen) {
-      fputs ($imap_stream, "a001 SEARCH UNSEEN NOT DELETED\r\n");
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
-      $unseen = false;
-      
-      if (strlen($read_ary[0]) > 10) {
-         $unseen = true;
-         $ary = explode (" ", $read_ary[0]);
-         $num_unseen = count($ary) - 2;
-      } else {
-         $unseen = false;
-         $num_unseen = 0;
-      }
-
-      return $unseen;
-   }
- 
-  
-   /******************************************************************************
-    **  Saves a message to a given folder -- used for saving sent messages
-    ******************************************************************************/
-   function sqimap_append ($imap_stream, $sent_folder, $length) {
-      fputs ($imap_stream, "a001 APPEND \"$sent_folder\" (\\Seen) \{$length}\r\n");
-      $tmp = fgets ($imap_stream, 1024);
-   } 
-
-   function sqimap_append_done ($imap_stream) {
-      fputs ($imap_stream, "\r\n");
-      $tmp = fgets ($imap_stream, 1024);
+/*
+ * 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);
+    $i = 0;
+    while (isset($read_ary[$i])) {
+        if (ereg("UNSEEN ([0-9]+)", $read_ary[$i], $regs)) {
+            break;
+        }
+        $i++;
+    }
+    return $regs[1];
+}
+
+
+/*
+ *  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");
+    $tmp = fgets ($imap_stream, 1024);
+}
+
+function sqimap_append_done ($imap_stream) {
+    fputs ($imap_stream, "\r\n");
+    $tmp = fgets ($imap_stream, 1024);
+}
+
+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));
+} 
+
 ?>