Updated documentation for sqimap_find_displayable_name()
[squirrelmail.git] / functions / imap_general.php
index 3e8258292270258ac7c481d69890ddf73f126261..9333f177fb8755c6ce067fe08ba85b3d611eebe4 100755 (executable)
-<?
-   /**
-    **  imap.php
-    **
-    **  This implements all functions that do general imap functions.
-    **/
+<?php
 
-   /******************************************************************************
-    **  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;
+/**
+ * imap.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$
+ */
 
-      $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)));
-      }
+require_once('../functions/page_header.php');
+require_once('../functions/display_messages.php');
 
-      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>";
-            exit;
-         }
-      }
-      
-      return $data;
-   }
-   
+/**
+ * Unique SessionId
+ *
+ * Sets an unique session id in order to avoid simultanous sessions crash.
+ *
+ * @return     string  a 4 chars unique string
+ */
+function sqimap_session_id() {
 
+    global $data_dir, $username;
+
+    $IMAPSessionID = substr(session_id(), -4);
+    if( $IMAPSessionID == '' ) {
+        $IMAPSessionID = 'A001';
+    }
+
+    return( $IMAPSessionID );
+}
 
-   
-   /******************************************************************************
-    **  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, $hide) {
-      global $color;
-      $imap_stream = fsockopen ($imap_server_address, 143, &$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";
-            echo "$error_number : $error_string<br>\r\n";
-         }
-         exit;
-      }
 
-      fputs ($imap_stream, "a001 LOGIN \"$username\" \"$password\"\r\n");
-      $read = fgets ($imap_stream, 1024);
+/******************************************************************************
+**  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
+******************************************************************************/
 
-      /** 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>
-               <?
-               exit;
+function sqimap_read_data_list ($imap_stream, $pre, $handle_errors,
+                               &$response, &$message) {
+    global $color, $squirrelmail_language;
+    
+    $read = '';
+    $resultlist = array();
+    
+    $more_msgs = true;
+    while ($more_msgs) {
+        $data = array();
+        $total_size = 0;
+        while (strpos($read, "\n") === false) {
+            $read .= fgets($imap_stream, 9096);
+        }
+        
+        if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) {
+           $size = $regs[1];
+        } else if (ereg("^\\* [0-9]+ FETCH", $read, $regs)) {
+            // Sizeless response, probably single-line
+            $size = -1;
+            $data[] = $read;
+            $read = fgets($imap_stream, 9096);
+        } else {
+            $size = -1;
+        }
+        while (1) {
+            while (strpos($read, "\n") === false) {
+                $read .= fgets($imap_stream, 9096);
+            }
+            // If we know the size, no need to look at the end parameters
+            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) {
+                    $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));
+                    break;
+                } else {
+                    $data[] = $read;
+                    $read = fgets($imap_stream, 9096);
+                    while (strpos($read, "\n") === false) {
+                      $read .= fgets($imap_stream, 9096);
+                    }
+                }
+                $total_size += strlen($read);
             } else {
-               echo "Unknown error: $read<br>";
-               exit;
+                if (ereg("^$pre (OK|BAD|NO)(.*)", $read, $regs) ||
+                   (($size == -1) && ereg("^\\* [0-9]+ FETCH.*", $read, $regs))) {
+                    break;
+                } else {
+                    $data[] = $read;
+                    $read = fgets ($imap_stream, 9096);
+                }
             }
-         } else {
+        }
+        
+        while (($more_msgs = !ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) &&
+            !ereg("^\\* [0-9]+ FETCH.*", $read, $regs)) {
+            $read = fgets($imap_stream, 9096);
+        }
+        $resultlist[] = $data;
+    }
+    $response = $regs[1];
+    $message = trim($regs[2]);
+    
+    if ($handle_errors == false) { return $resultlist; }
+    
+    if ($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" .
+                 _("Reason Given: ") .
+                 $message . "</font><br>\n";
             exit;
-         }
-      }
+        }
+    } else if ($response == 'BAD') {
+        set_up_language($squirrelmail_language);
+        echo "<br><b><font color=$color[2]>\n" .
+             _("ERROR : Bad or malformed request.") .
+             "</b><br>\n" .
+             _("Server responded: ") .
+             $message . "</font><br>\n";
+        exit;
+    }
+    return $resultlist;
+}
 
-      return $imap_stream;
-   }
+function sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) {
 
+    $res = sqimap_read_data_list($imap_stream, $pre, $handle_errors, $response, $message);
+    return $res[0];
+    
+}
 
-   
-   
-   /******************************************************************************
-    **  Simply logs out the imap session
-    ******************************************************************************/
-   function sqimap_logout ($imap_stream) {
-      fputs ($imap_stream, "a001 LOGOUT\r\n");
-   }
+/******************************************************************************
+**  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, $HTTP_ACCEPT_LANGUAGE, $onetimepad;
+    
+    $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, sqimap_session_id() . ' LOGIN "' . quoteIMAP($username) .
+           '" "' . quoteIMAP($password) . "\"\r\n");
+    $read = sqimap_read_data ($imap_stream, sqimap_session_id(), false, $response, $message);
 
-   /******************************************************************************
-    **  Returns the delimeter between mailboxes:  INBOX/Test, or INBOX.Test... 
-    ******************************************************************************/
-   function sqimap_get_delimiter ($imap_stream) {
-      fputs ($imap_stream, ". LIST \"\" *\r\n");
-      $read = sqimap_read_data($imap_stream, ".", true, $a, $b);
-      $quote_position = strpos ($read[0], "\"");
-      $delim = substr ($read[0], $quote_position+1, 1);
+    /** 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 {
+                // 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);
+                
+                displayHtmlHeader( _("Unknown user or password incorrect.") );
+                echo "<body bgcolor=\"#ffffff\">\n";
+                error_username_password_incorrect();
+                session_destroy();
+                exit;
+            }
+        } else {
+            exit;
+        }
+    }
+    
+    return $imap_stream;
+}
 
-      return $delim;
-   }
+/*
+ *  Simply logs out the imap session
+ */
+function sqimap_logout ($imap_stream) {
+    fputs ($imap_stream, sqimap_session_id() . " LOGOUT\r\n");
+}
 
+function sqimap_capability($imap_stream, $capability) {
+    global $sqimap_capabilities;
+    
+    if (!is_array($sqimap_capabilities)) {
+        fputs ($imap_stream, sqimap_session_id() . " CAPABILITY\r\n");
+        $read = sqimap_read_data($imap_stream, sqimap_session_id(), true, $a, $b);
+    
+        $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 (! isset($sqimap_capabilities[$capability])) {
+        return false;
+    } else {
+        return $sqimap_capabilities[$capability];
+    }
+}
 
+/******************************************************************************
+**  Returns the delimeter between mailboxes:  INBOX/Test, or INBOX.Test...
+******************************************************************************/
+function sqimap_get_delimiter ($imap_stream = false) {
 
+    global $sqimap_delimiter;
+    global $optional_delimiter;
+    
+    /* Use configured delimiter if set */
+    if((!empty($optional_delimiter)) && $optional_delimiter != 'detect') {
+        return $optional_delimiter;
+    }
+    
+    /* 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...
+            */
+            fputs ($imap_stream, sqimap_session_id() . " NAMESPACE\r\n");
+            $read = sqimap_read_data($imap_stream, sqimap_session_id(), 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;
+}
 
-   /******************************************************************************
-    **  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
-       **/
+/*
+ *  Gets the number of messages in the current mailbox.
+ */
+function sqimap_get_num_messages ($imap_stream, $mailbox) {
 
-      if (strpos($string, "<") && strpos($string, ">")) {
-         $string = substr($string, strpos($string, "<")+1);
-         $string = substr($string, 0, strpos($string, ">"));
-      }
-      return trim($string); 
-   }
+    fputs ($imap_stream, sqimap_session_id() . " EXAMINE \"$mailbox\"\r\n");
+    $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $result, $message);
+    for ($i = 0; $i < count($read_ary); $i++) {
+     if (ereg("[^ ]+ +([^ ]+) +EXISTS", $read_ary[$i], $regs)) {
+        return $regs[1];
+     }
+    }
+    return sprintf( "BUG!  Couldn't get number of messages in %s!", $mailbox );
+    
+}
 
-   
-   /******************************************************************************
-    **  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 = substr($string, 0, strpos($string, "<"));
-         }   
-      }
-      return $string; 
-   }
 
+/*
+*  Returns a displayable email address
+*/
+function sqimap_find_email ($string) {
+    /** Luke Ehresman <lehresma@css.tayloru.edu>
+    ** <lehresma@css.tayloru.edu>
+    ** lehresma@css.tayloru.edu
+    **
+    ** What about
+    **    lehresma@css.tayloru.edu (Luke Ehresman)
+    **/
+    
+    if (ereg("<([^>]+)>", $string, $regs)) {
+        $string = $regs[1];
+    }
+    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, $mailbox, $body, $to, $cc, $bcc, $subject, $data_dir, $username, $domain, $version) {
-      global $sent_folder, $data_dir;
+/*
+ *  Takes the From: field, and creates a displayable name.
+ *    Luke Ehresman   <lkehresman@yahoo.com>
+ *    "Luke Ehresman" <lkehresman@yahoo.com>
+ *    lkehresman@yahoo.com (Luke Ehresman)
+ *           become:   Luke Ehresman
+ *    <lkehresman@yahoo.com>
+ *           becomes:   lkehresman@yahoo.com
+ */
+function sqimap_find_displayable_name ($string) {
+    $string = trim($string);
+    
+    if ( ereg('^(.+)<.*>', $string, $regs) ) {
+        $string = ereg_replace ('"', '', $regs[1] );
+    }
+    elseif ( ereg('\((.*)\)', $string, $regs) ) {
+        $string = $regs[1];
+    }
+    else {
+        $string = sqimap_find_email($string);
+    }
 
-      $from = getPref($data_dir, $username, "full_name");
-      $from_addr = getPref($data_dir, $username, "email_address");
-      if ($from_addr == "")
-         $from_addr = "$username@$domain";
+    return trim($string);
+}
+    
+/*
+*  Returns the number of unseen messages in this folder
+*/
+function sqimap_unseen_messages ($imap_stream, $mailbox) {
+    //fputs ($imap_stream, sqimap_session_id() . " SEARCH UNSEEN NOT DELETED\r\n");
+    fputs ($imap_stream, sqimap_session_id() . " STATUS \"$mailbox\" (UNSEEN)\r\n");
+    $read_ary = sqimap_read_data ($imap_stream, sqimap_session_id(), true, $result, $message);
+    ereg("UNSEEN ([0-9]+)", $read_ary[0], $regs);
+    return $regs[1];
+}
 
-      if ($from == "")
-         $from = "<$from_addr>";
-      else
-         $from = $from . " <$from_addr>";
 
-      $message  = "Date: ".date("D, j M Y H:i:s ", mktime()) . timezone() . "\r\n";
-      $message .= "Subject: ". $subject."\r\n";
-      $message .= "From: ".$from."\r\n";
-      $message .= "To: ".$to."\r\n";
-      if ($cc_list) {
-         $message .= "Cc: ".$cc."\r\n"; // Who the CCs are
-      }
-      $message .= "Content-Type: text/plain; charset=ISO-8859-1\r\n";
-      $message .= "Content-Transfer-Encoding: 8bit\r\n";
-      $message .= "\r\n";
-      $message .= stripslashes($body) . "\r\n";
-      $message .= "\r\n";
-      
-      $size = count_chars($message);
-      fputs ($imap_stream, "a001 APPEND $sent_folder (\\Seen) \{$size}\r\n");
-      fputs ($imap_stream, "$message");
+/*
+*  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);
+}
 
-      $read_ary = sqimap_read_data ($imap_stream, "a001", true, $result, $message);
-   } 
+function sqimap_append_done ($imap_stream) {
+    fputs ($imap_stream, "\r\n");
+    $tmp = fgets ($imap_stream, 1024);
+}
+   
 ?>