Happy New Year
[squirrelmail.git] / plugins / filters / filters.php
index da0f69821f585e1e985d45577dfebbcab9967702..6092b80b0b9c0c89daabfb5866f883498840d48e 100644 (file)
@@ -3,13 +3,14 @@
 /**
  * Message and Spam Filter Plugin - Filtering Functions
  *
- * @copyright 1999-2013 The SquirrelMail Project Team
+ * @copyright 1999-2020 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @subpackage filters
  */
 
+// TODO: This plugin has an issue that seems to corrupt folder cache for subfolders of INBOX
 /**
  * do not allow to call this file directly
  */
@@ -190,9 +191,26 @@ function filters_bulkquery($filters, $IPs) {
  * @access private
  */
 function start_filters($hook_args) {
-    global $imapServerAddress, $imapPort, $imap_stream, $imapConnection,
-           $UseSeparateImapConnection, $AllowSpamFilters, $filter_inbox_count,
-           $username;
+    global $imapServerAddress, $imapPort, $imap_stream_options, $imap_stream,
+           $imapConnection, $UseSeparateImapConnection, $AllowSpamFilters,
+           $filter_inbox_count, $username;
+
+    // if there were filtering errors previously during
+    // this login session, we won't try again
+    //
+    // (errors that this plugin was able to catch or a "NO"
+    // response/failure from IMAP found in the current session,
+    // which could have resulted from an attempted filter copy
+    // (over quota), in which case execution halts before this
+    // plugin can catch the problem -- note, however, that any
+    // other IMAP "NO" failure (caused by unrelated actions) at
+    // any time during the current session will cause this plugin
+    // to effectively shut down)
+    //
+    sqgetGlobalVar('filters_error', $filters_error, SQ_SESSION, FALSE);
+    sqgetGlobalVar('IMAP_FATAL_ERROR_TYPE', $imap_fatal_error, SQ_SESSION, '');
+    if ($filters_error || $imap_fatal_error == 'NO')
+        return;
 
     /**
      * check hook that calls filtering. If filters are called by right_main_after_header,
@@ -229,7 +247,7 @@ function start_filters($hook_args) {
     if ((!isset($imap_stream) && !isset($imapConnection)) ||
         $UseSeparateImapConnection ) {
             $stream = sqimap_login($username, false, $imapServerAddress,
-                                $imapPort, 10);
+                                $imapPort, 10, $imap_stream_options);
             $previously_connected = false;
     } else if (isset($imapConnection)) {
         $stream = $imapConnection;
@@ -387,8 +405,16 @@ function filter_search_and_delete($imap_stream, $where, $what, $where_to, $user_
         }
         if ($response == 'OK' && count($ids)) {
             if (sqimap_mailbox_exists($imap_stream, $where_to)) {
-                 $should_expunge = true;
-                 sqimap_msgs_list_move ($imap_stream, $ids, $where_to, false);
+                if (!sqimap_msgs_list_move ($imap_stream, $ids, $where_to, false)) {
+                    // if errors occurred, don't try to filter again during this session
+                    sqsession_register(TRUE, 'filters_error');
+                    global $color;
+                    error_box(_("A problem occurred filtering messages. Check filter settings and account quota if applicable. Filtering is disabled for the remainder of this login session."), $color);
+                }
+
+                // expunge even in the case of errors, in case some
+                // messages were filtered before the error happened
+                $should_expunge = true;
             }
         } elseif ($response != 'OK') {
             $query = $search_str . "\r\n".$what ."\r\n";
@@ -518,7 +544,15 @@ function spam_filters($imap_stream) {
     }
     // Lookie!  It's spam!  Yum!
     if (count($aSpamIds) && sqimap_mailbox_exists($imap_stream, $filters_spam_folder)) {
-        sqimap_msgs_list_move($imap_stream, $aSpamIds, $filters_spam_folder);
+        if (!sqimap_msgs_list_move($imap_stream, $aSpamIds, $filters_spam_folder)) {
+           // if errors occurred, don't try to filter again during this session
+           sqsession_register(TRUE, 'filters_error');
+           global $color;
+           error_box(_("A problem occurred filtering messages. Check filter settings and account quota if applicable. Filtering is disabled for the remainder of this login session."), $color);
+        }
+
+        // expunge even in the case of errors, in case some
+        // messages were filtered before the error happened
         sqimap_mailbox_expunge($imap_stream, 'INBOX');
     }