added flag related functions for handling sets of messages instead of using
[squirrelmail.git] / functions / imap_general.php
index 11586a1853888a134669a487fa59ffbba099aad1..8575e7eb032b8be65c87ae277caf46b6b319e2cf 100755 (executable)
@@ -11,7 +11,7 @@
  * $Id$
  */
 
-require_once('../functions/page_header.php');
+require_once(SM_PATH . 'functions/page_header.php');
 
 global $sqimap_session_id;
 $sqimap_session_id = 1;
@@ -31,17 +31,41 @@ 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;
+    }
+    
 }
 
 
@@ -87,15 +111,19 @@ function sqimap_read_data_list ($imap_stream, $pre, $handle_errors, &$response,
             case preg_match("/^\* (OK \[PARSE\])(.*)$/", $read):
                 $read = sqimap_fgets($imap_stream);
                 break 1;
-            case preg_match('/^\* [0-9]+ FETCH.*/', $read):
+            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) && 
+                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:
@@ -117,25 +145,29 @@ function sqimap_read_data_list ($imap_stream, $pre, $handle_errors, &$response,
     /* 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" .
+           require_once(SM_PATH . 'functions/display_messages.php');
+           $string = "<b><font color=$color[2]>\n" .
                 _("ERROR : Could not complete request.") .
                 "</b><br>\n" .
                 _("Query:") .
                 $query . '<br>' .
                 _("Reason Given: ") .
                 $message . "</font><br>\n";
+           error_box($string,$color);
             exit;
         }
     } 
     elseif ($response == 'BAD') {
         set_up_language($squirrelmail_language);
-        echo "<br><b><font color=$color[2]>\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:") .
             $query . '<br>' .
             _("Server responded: ") .
             $message . "</font><br>\n";
+       error_box($string,$color);    
         exit;
     } 
     else {
@@ -145,7 +177,27 @@ function sqimap_read_data_list ($imap_stream, $pre, $handle_errors, &$response,
 
 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];
+    }
+
 }
 
 /*
@@ -153,29 +205,30 @@ 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;
 
     $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";
+           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;
     }
 
+    $server_info = fgets ($imap_stream, 1024);
+
+    /* Decrypt the password */
+    $password = OneTimePadDecrypt($password, $onetimepad);
+
     $query = 'LOGIN "' . quoteIMAP($username) .  '" "' . quoteIMAP($password) . '"';
     $read = sqimap_run_command ($imap_stream, $query, false, $response, $message);
 
@@ -185,17 +238,19 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
             if ($response != 'NO') {
                 /* "BAD" and anything else gets reported here. */
                 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";
+                $string .= '<br>' . _("Read data:") . "<br>\n";
                 if (is_array($read)) {
                     foreach ($read as $line) {
-                        echo htmlspecialchars($line) . "<br>\n";
+                        $string .= htmlspecialchars($line) . "<br>\n";
                     }
                 }
+               error_box($string,$color);
                 exit;
             } else {
                 /*
@@ -210,9 +265,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 {
@@ -224,8 +279,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='') {
@@ -301,13 +358,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!";
 }
 
 
@@ -373,8 +430,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;
@@ -384,6 +442,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
@@ -393,17 +471,43 @@ 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);
 }