Wrong variable name used
[squirrelmail.git] / functions / imap_general.php
index e45f5d41b1eb3dd4c072fc43690e7739c49ab242..8d6d27ee218abf35964e7e5f28e610fc48636466 100755 (executable)
@@ -13,9 +13,8 @@
  */
 
 /** Includes.. */
-require_once(SM_PATH . 'functions/page_header.php');
-require_once(SM_PATH . 'functions/auth.php');
-include_once(SM_PATH . 'functions/rfc822address.php');
+
+require_once(SM_PATH . 'functions/rfc822address.php');
 
 
 /**
@@ -64,11 +63,10 @@ function sqimap_run_command_list ($imap_stream, $query, $handle_errors, &$respon
     } 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 IMAP stream.") .
                 "</b></font>\n";
-        error_box($string,$color);
+        error_box($string);
         return false;
     }
 }
@@ -115,11 +113,10 @@ function sqimap_run_command ($imap_stream, $query, $handle_errors, &$response,
     } 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 IMAP stream.") .
                 "</b></font>\n";
-        error_box($string,$color);
+        error_box($string);
         return false;
     }
 }
@@ -317,9 +314,8 @@ function sqimap_fread($imap_stream,$iSize,$filter=false,
  */
 function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
           &$response, &$message, $query = '') {
-    global $color, $squirrelmail_language;
+    global $color, $oTemplate, $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" .
@@ -330,8 +326,8 @@ function sqimap_read_data_list($imap_stream, $tag, $handle_errors,
           '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>';
+    error_box($string);
+    $oTemplate->display('footer.tpl');
     exit;
 }
 
@@ -350,7 +346,6 @@ function sqimap_error_box($title, $query = '', $message_title = '', $message = '
     global $color, $squirrelmail_language;
 
     set_up_language($squirrelmail_language);
-    require_once(SM_PATH . 'functions/display_messages.php');
     $string = "<font color=\"$color[2]\"><b>\n" . $title . "</b><br />\n";
     $cmd = explode(' ',$query);
     $cmd= strtolower($cmd[0]);
@@ -364,7 +359,7 @@ function sqimap_error_box($title, $query = '', $message_title = '', $message = '
     $string .= "</font><br />\n";
     if ($link != '')
         $string .= $link;
-    error_box($string,$color);
+    error_box($string);
 }
 
 /**
@@ -392,6 +387,12 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
     $aResponse = '';
     $resultlist = array();
     $data = array();
+    $sCommand = '';
+    if (preg_match("/^(\w+)\s*/",$query,$aMatch)) {
+        $sCommand = strtoupper($aMatch[1]);
+    } else {
+        // error reporting (shouldn't happen)
+    }
     $read = sqimap_fgets($imap_stream);
     $i = 0;
     while ($read) {
@@ -455,7 +456,7 @@ function sqimap_retrieve_imap_response($imap_stream, $tag, $handle_errors,
 
           case '*':
           {
-            if (preg_match('/^\*\s\d+\sFETCH/',$read)) {
+            if (($sCommand == "FETCH" || $sCommand == "STORE")  && preg_match('/^\*\s\d+\sFETCH/',$read)) {
                 /* check for literal */
                 $s = substr($read,-3);
                 $fetch_data = array();
@@ -673,7 +674,7 @@ function sqimap_create_stream($server,$port,$tls=0) {
      * Implementing IMAP STARTTLS (rfc2595) in php 5.1.0+
      * http://www.php.net/stream-socket-enable-crypto
      */
-    if ($tls == 2) {
+    if ($tls === 2) {
         if (function_exists('stream_socket_enable_crypto')) {
             // check starttls capability, don't use cached capability version
             if (! sqimap_capability($imap_stream, 'STARTTLS', false)) {
@@ -701,28 +702,28 @@ function sqimap_create_stream($server,$port,$tls=0) {
                 // starttls was successful
 
                 /**
-                 * RFC 2595 requires to discard CAPABILITY information after successful 
-                 * STARTTLS command. We don't follow RFC, because SquirrelMail stores CAPABILITY 
-                 * information only after successful login (src/redirect.php) and cached information 
-                 * is used only in other php script connections after successful STARTTLS. If script 
-                 * issues sqimap_capability() call before sqimap_login() and wants to get initial 
-                 * capability response, script should set third sqimap_capability() argument to false. 
+                 * RFC 2595 requires to discard CAPABILITY information after successful
+                 * STARTTLS command. We don't follow RFC, because SquirrelMail stores CAPABILITY
+                 * information only after successful login (src/redirect.php) and cached information
+                 * is used only in other php script connections after successful STARTTLS. If script
+                 * issues sqimap_capability() call before sqimap_login() and wants to get initial
+                 * capability response, script should set third sqimap_capability() argument to false.
                  */
-                //sqsession_unregister('sqimap_capabilities');            
+                //sqsession_unregister('sqimap_capabilities');
             } else {
                 /**
                  * stream_socket_enable_crypto() call failed. Possible issues:
                  * - broken ssl certificate (uw drops connection, error is in syslog mail facility)
-                 * - some ssl error (can reproduce with STREAM_CRYPTO_METHOD_SSLv3_CLIENT, PHP E_WARNING 
+                 * - some ssl error (can reproduce with STREAM_CRYPTO_METHOD_SSLv3_CLIENT, PHP E_WARNING
                  *   suppressed in stream_socket_enable_crypto() call)
                  */
                 sqimap_error_box(sprintf(_("Error connecting to IMAP server: %s."), $server),
                                  '','',
                                  _("Unable to start TLS."));
                 /**
-                 * Bug: stream_socket_enable_crypto() does not register SSL errors in 
-                 * openssl_error_string() or stream notification wrapper and displays 
-                 * them in E_WARNING level message. It is impossible to retrieve error 
+                 * Bug: stream_socket_enable_crypto() does not register SSL errors in
+                 * openssl_error_string() or stream notification wrapper and displays
+                 * them in E_WARNING level message. It is impossible to retrieve error
                  * message without own error handler.
                  */
                 exit;
@@ -742,7 +743,9 @@ function sqimap_create_stream($server,$port,$tls=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.
  * @param string $username user name
- * @param string $password encrypted password
+ * @param string $password password encrypted with onetimepad. Since 1.5.2 
+ *  function can use internal password functions, if parameter is set to 
+ *  boolean false. 
  * @param string $imap_server_address address of imap server
  * @param integer $imap_port port of imap server
  * @param boolean $hide controls display connection errors
@@ -752,11 +755,21 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
     global $color, $squirrelmail_language, $onetimepad, $use_imap_tls,
            $imap_auth_mech, $sqimap_capabilities;
 
-    if (!isset($onetimepad) || empty($onetimepad)) {
-        sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION );
+    /* get imap login password */
+    if ($password===false) {
+        /* standard functions */
+        $password = sqauth_read_password();
+    } else {
+        /* old way. $key must be extracted from cookie */
+        if (!isset($onetimepad) || empty($onetimepad)) {
+            sqgetglobalvar('onetimepad' , $onetimepad , SQ_SESSION );
+        }
+        /* Decrypt the password */
+        $password = OneTimePadDecrypt($password, $onetimepad);
     }
+
     if (!isset($sqimap_capabilities)) {
-        sqgetglobalvar('sqimap_capabilities' , $capability , SQ_SESSION );
+        sqgetglobalvar('sqimap_capabilities' , $sqimap_capabilities , SQ_SESSION );
     }
 
     $host = $imap_server_address;
@@ -764,9 +777,6 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
 
     $imap_stream = sqimap_create_stream($imap_server_address,$imap_port,$use_imap_tls);
 
-    /* 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);
@@ -825,7 +835,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
          *
          **/
         $tag=sqimap_session_id(false);
-        $sasl = (isset($capability['SASL-IR']) && $capability['SASL-IR']) ? true : false;
+        $sasl = (isset($sqimap_capabilities['SASL-IR']) && $sqimap_capabilities['SASL-IR']) ? true : false;
         $auth = base64_encode("$username\0$username\0$password");
         if ($sasl) {
             // IMAP Extension for SASL Initial Client Response
@@ -857,7 +867,6 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
                 /* "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') {
                     $string = sprintf (_("Bad request: %s")."<br />\r\n", $message);
                 } else {
@@ -869,7 +878,7 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
                         $string .= htmlspecialchars($line) . "<br />\n";
                     }
                 }
-                error_box($string,$color);
+                error_box($string);
                 exit;
             } else {
                 /*
@@ -884,8 +893,8 @@ 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();
+                sqsetcookieflush();
                 /* terminate the session nicely */
                 sqimap_logout($imap_stream);
                 logout_error( _("Unknown user or password incorrect.") );
@@ -905,7 +914,6 @@ function sqimap_login ($username, $password, $imap_server_address, $imap_port, $
     if ( stristr($message, 'REFERRAL imap') === TRUE ) {
         sqimap_logout($imap_stream);
         set_up_language($squirrelmail_language, true);
-        include_once(SM_PATH . 'functions/display_messages.php' );
         sqsession_destroy();
         logout_error( _("Your mailbox is not located at this server. Try a different server or consult your system administrator") );
         exit;
@@ -932,7 +940,7 @@ function sqimap_logout ($imap_stream) {
  * else returns array of all capabilities.
  * @param stream $imap_stream
  * @param string $capability (since 1.3.0)
- * @param boolean $bUseCache (since 1.5.1) Controls use of capability data stored in session 
+ * @param boolean $bUseCache (since 1.5.1) Controls use of capability data stored in session
  * @return mixed (string if $capability is set and found,
  *  false, if $capability is set and not found,
  *  array if $capability not set)
@@ -942,14 +950,22 @@ function sqimap_capability($imap_stream, $capability='', $bUseCache=true) {
 
     if (!$bUseCache || ! sqgetGlobalVar('sqimap_capabilities', $sqimap_capabilities, SQ_SESSION)) {
         $read = sqimap_run_command($imap_stream, 'CAPABILITY', true, $a, $b);
-
         $c = explode(' ', $read[0]);
         for ($i=2; $i < count($c); $i++) {
             $cap_list = explode('=', $c[$i]);
             if (isset($cap_list[1])) {
+                if(isset($sqimap_capabilities[trim($cap_list[0])]) &&
+                 !is_array($sqimap_capabilities[trim($cap_list[0])])) {
+                    // Remove array key that was added in 'else' block below
+                    // This is to accomodate for capabilities like:
+                    // SORT SORT=MODSEQ
+                    unset($sqimap_capabilities[trim($cap_list[0])]);
+                }
                 $sqimap_capabilities[trim($cap_list[0])][] = $cap_list[1];
             } else {
-                $sqimap_capabilities[trim($cap_list[0])] = TRUE;
+                if(!isset($sqimap_capabilities[trim($cap_list[0])])) {
+                    $sqimap_capabilities[trim($cap_list[0])] = TRUE;
+                }
             }
         }
     }
@@ -1040,13 +1056,8 @@ function sqimap_encode_mailbox_name($what)
  * @deprecated
  */
 function sqimap_get_num_messages ($imap_stream, $mailbox) {
-    $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];
-        }
-    }
-    return false; //"BUG! Couldn't get number of messages in $mailbox!";
+    $aStatus = sqimap_status_messages($imap_stream,$mailbox,array('MESSAGES'));
+    return $aStatus['MESSAGES'];
 }
 
 /**
@@ -1141,11 +1152,22 @@ function sqimap_status_messages ($imap_stream, $mailbox,
         }
         $i++;
     }
-    return array('MESSAGES' => $messages,
+
+    $status=array('MESSAGES' => $messages,
                  'UNSEEN'=>$unseen,
                  'RECENT' => $recent,
                  'UIDNEXT' => $uidnext,
                  'UIDVALIDITY' => $uidvalidity);
+
+    if (!empty($messages)) { $hook_status['MESSAGES']=$messages; }
+    if (!empty($unseen)) { $hook_status['UNSEEN']=$unseen; }
+    if (!empty($recent)) { $hook_status['RECENT']=$recent; }
+    if (!empty($hook_status)) {
+         $hook_status['MAILBOX']=$mailbox;
+         $hook_status['CALLER']='sqimap_status_messages';
+         do_hook_function('folder_status',$hook_status);
+    }
+    return $status;
 }
 
 
@@ -1154,61 +1176,102 @@ function sqimap_status_messages ($imap_stream, $mailbox,
  * @param stream $imap_stream
  * @param string $sent_folder
  * @param $length
+ * @return string $sid
  */
-function sqimap_append ($imap_stream, $sent_folder, $length) {
-    fputs ($imap_stream, sqimap_session_id() . ' APPEND ' . sqimap_encode_mailbox_name($sent_folder) . " (\\Seen) {".$length."}\r\n");
+function sqimap_append ($imap_stream, $sMailbox, $length) {
+    $sid = sqimap_session_id();
+    $query = $sid . ' APPEND ' . sqimap_encode_mailbox_name($sMailbox) . " (\\Seen) {".$length."}";
+    fputs ($imap_stream, "$query\r\n");
     $tmp = fgets ($imap_stream, 1024);
-    sqimap_append_checkresponse($tmp, $sent_folder);
+    sqimap_append_checkresponse($tmp, $sMailbox,$sid, $query);
+    return $sid;
 }
 
 /**
  * @param stream imap_stream
  * @param string $folder (since 1.3.2)
  */
-function sqimap_append_done ($imap_stream, $folder='') {
+function sqimap_append_done ($imap_stream, $sMailbox='') {
     fputs ($imap_stream, "\r\n");
     $tmp = fgets ($imap_stream, 1024);
-    sqimap_append_checkresponse($tmp, $folder);
+    while (!sqimap_append_checkresponse($tmp, $sMailbox)) {
+        $tmp = fgets ($imap_stream, 1024);
+    }
 }
 
 /**
  * Displays error messages, if there are errors in responses to
  * commands issues by sqimap_append() and sqimap_append_done() functions.
  * @param string $response
- * @param string $folder
+ * @param string $sMailbox
+ * @return bool $bDone
  * @since 1.5.1 and 1.4.5
  */
-function sqimap_append_checkresponse($response, $folder) {
+function sqimap_append_checkresponse($response, $sMailbox, $sid='', $query='') {
+    // static vars to keep them available when sqimap_append_done calls this function.
+    static $imapquery, $imapsid;
 
-    if (preg_match("/(.*)(BAD|NO)(.*)$/", $response, $regs)) {
-        global $squirrelmail_language, $color;
-        set_up_language($squirrelmail_language);
-        require_once(SM_PATH . 'functions/display_messages.php');
+    $bDone = false;
 
-        $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:") . ' ' .
-                  $reason . "</font><br />\n";
-           error_box($string,$color);
-           exit;
+    if ($query) {
+        $imapquery = $query;
+    }
+    if ($sid) {
+        $imapsid = $sid;
+    }
+    if ($response{0} == '+') {
+        // continuation request triggerd by sqimap_append()
+        $bDone = true;
+    } else {
+        $i = strpos($response, ' ');
+        $sRsp = substr($response,0,$i);
+        $sMsg = substr($response,$i+1);
+        $aExtra = array('MAILBOX' => $sMailbox);
+        switch ($sRsp) {
+            case '*': //untagged response
+                $i = strpos($sMsg, ' ');
+                $sRsp = strtoupper(substr($sMsg,0,$i));
+                $sMsg = substr($sMsg,$i+1);
+                if ($sRsp == 'NO' || $sRsp == 'BAD') {
+                    // for the moment disabled. Enable after 1.5.1 release.
+                    // Notices could give valueable information about the mailbox
+                    // sqm_trigger_imap_error('SQM_IMAP_APPEND_NOTICE',$imapquery,$sRsp,$sMsg);
+                }
+                $bDone = false;
+            case $imapsid:
+                // A001 OK message
+                // $imapsid<space>$sRsp<space>$sMsg
+                $bDone = true;
+                $i = strpos($sMsg, ' ');
+                $sRsp = strtoupper(substr($sMsg,0,$i));
+                $sMsg = substr($sMsg,$i+1);
+                switch ($sRsp) {
+                    case 'NO':
+                        if (preg_match("/(.*)(quota)(.*)$/i", $sMsg, $aMatch)) {
+                            sqm_trigger_imap_error('SQM_IMAP_APPEND_QUOTA_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
+                        } else {
+                            sqm_trigger_imap_error('SQM_IMAP_APPEND_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
+                        }
+                        break;
+                    case 'BAD':
+                        sqm_trigger_imap_error('SQM_IMAP_ERROR',$imapquery,$sRsp,$sMsg,$aExtra);
+                        break;
+                    case 'BYE':
+                        sqm_trigger_imap_error('SQM_IMAP_BYE',$imapquery,$sRsp,$sMsg,$aExtra);
+                        break;
+                    case 'OK':
+                        break;
+                    default:
+                        break;
+                }
+                break;
+            default:
+                // should be false because of the unexpected response but i'm not sure if
+                // that will cause an endless loop in sqimap_append_done
+                $bDone = true;
         }
     }
+    return $bDone;
 }
 
 /**
@@ -1243,5 +1306,3 @@ function map_yp_alias($username) {
    $yp = `ypmatch $username aliases`;
    return chop(substr($yp, strlen($username)+1));
 }
-
-?>
\ No newline at end of file