Trimming whitespace and replacing tabs
[squirrelmail.git] / plugins / filters / filters.php
index 5259d1bb6eab19f8af377af0663037369e8dbb6d..c326a1f5a7942b1f2cc85f5e044b507455c21d9e 100644 (file)
 <?php
-
 /**
- * Message and Spam Filter Plugin
- *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- * This plugin filters your inbox into different folders based upon given
- * criteria.  It is most useful for people who are subscibed to mailing lists
- * to help organize their messages.  The argument stands that filtering is
- * not the place of the client, which is why this has been made a plugin for
- * SquirrelMail.  You may be better off using products such as Sieve or
- * Procmail to do your filtering so it happens even when SquirrelMail isn't
- * running.
- *
- * If you need help with this, or see improvements that can be made, please
- * email me directly at the address above.  I definately welcome suggestions
- * and comments.  This plugin, as is the case with all SquirrelMail plugins,
- * is not directly supported by the developers.  Please come to me off the
- * mailing list if you have trouble with it.
- *
- * Also view plugins/README.plugins for more information.
+ * Message and Spam Filter Plugin - Filtering Functions
  *
- * $Id$
+ * @version $Id$
+ * @copyright (c) 1999-2005 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @package plugins
+ * @subpackage filters
  */
 
-function filters_sqimap_read_data ($imap_stream, $pre, $handle_errors, &$response, &$message) {
-    global $color, $squirrelmail_language, $imap_general_debug;
+/** load config */
+if (file_exists(SM_PATH . 'plugins/filters/config.php'))
+    include_once (SM_PATH . 'plugins/filters/config.php');
 
-    $data = array();
-    $size = 0;
-
-    do {
-        $read = fgets($imap_stream, 9096);
-        if (ereg("^$pre (OK|BAD|NO)(.*)$", $read, $regs)) {
-            break;  // found end of reply
-        }
-
-        // Continue if needed for this single line
-        while (strpos($read, "\n") === false) {
-            $read .= fgets($imap_stream, 9096);
-        }
-
-        $data[] = $read;
-
-        if (ereg("^\\* [0-9]+ FETCH.*\\{([0-9]+)\\}", $read, $regs)) {
-            $size = $regs[1];
-            if ($imap_general_debug) {
-                echo "<small><tt><font color=\"#CC0000\">Size is $size</font></tt></small><br>\n";
-            }
+/**
+ * Init Hooks
+ * @access private
+ */
+function filters_init_hooks () {
+    global $squirrelmail_plugin_hooks;
+    if (!file_exists(SM_PATH . 'plugins/filters/config.php')) return;
+    if (sqgetGlobalVar('mailbox',$mailbox,SQ_FORM)) {
+        sqgetGlobalVar('mailbox',$mailbox,SQ_FORM);
+    } else {
+        $mailbox = 'INBOX';
+    }
 
-            $total_size = 0;
-            do {
-                $read = fgets($imap_stream, 9096);
-                if ($imap_general_debug) {
-                    echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\n";
-                    flush();
-                }
-                $data[] = $read;
-                $total_size += strlen($read);
-            } while ($total_size < $size);
+    $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters_hook';
+    if (isset($mailbox) && $mailbox == 'INBOX') {
+        $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters_hook';
+    }
+    $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'filters_optpage_register_block_hook';
+    $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
+    $squirrelmail_plugin_hooks['rename_or_delete_folder']['filters'] = 'update_for_folder_hook';
+    $squirrelmail_plugin_hooks['webmail_bottom']['filters'] = 'start_filters_hook';
+}
 
-            $size = 0;
-        }
-        // For debugging purposes
-        if ($imap_general_debug) {
-            echo "<small><tt><font color=\"#CC0000\">$read</font></tt></small><br>\n";
-            flush();
-        }
-    } while (true);
+/**
+ * Register option blocks
+ * @access private
+ */
+function filters_optpage_register_block() {
+    global $optpage_blocks, $AllowSpamFilters;
+    if (!file_exists(SM_PATH . 'plugins/filters/config.php')) return;
+
+    $optpage_blocks[] = array(
+        'name' => _("Message Filters"),
+        'url'  => SM_PATH . 'plugins/filters/options.php',
+        'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
+        'js'   => false
+    );
+
+    if ($AllowSpamFilters) {
+        $optpage_blocks[] = array(
+            'name' => _("SPAM Filters"),
+            'url'  => SM_PATH . 'plugins/filters/spamoptions.php',
+            'desc' => _("SPAM filters allow you to select from various DNS based blacklists to detect junk email in your INBOX and move it to another folder (like Trash)."),
+            'js'   => false
+        );
+    }
+}
 
-    $response = $regs[1];
-    $message = trim($regs[2]);
+/**
+ * Saves the DNS Cache to disk
+ * @access private
+ */
+function filters_SaveCache () {
+    global $data_dir, $SpamFilters_DNScache;
 
-    if ($imap_general_debug) {
-        echo '--<br>';
+    if (file_exists($data_dir . '/dnscache')) {
+        $fp = fopen($data_dir . '/dnscache', 'r');
+    } else {
+        $fp = false;
+    }
+    if ($fp) {
+        flock($fp,LOCK_EX);
+    } else {
+       $fp = fopen($data_dir . '/dnscache', 'w+');
+       fclose($fp);
+       $fp = fopen($data_dir . '/dnscache', 'r');
+       flock($fp,LOCK_EX);
     }
+    $fp1 = fopen($data_dir . '/dnscache', 'w+');
 
-    if (!$handle_errors) {
-        return $data;
+    foreach ($SpamFilters_DNScache as $Key=> $Value) {
+       $tstr = $Key . ',' . $Value['L'] . ',' . $Value['T'] . "\n";
+       fputs ($fp1, $tstr);
     }
+    fclose($fp1);
+    flock($fp,LOCK_UN);
+    fclose($fp);
+}
 
-    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;
+/**
+ * Loads the DNS Cache from disk
+ * @access private
+ */
+function filters_LoadCache () {
+    global $data_dir, $SpamFilters_DNScache;
+
+    if (file_exists($data_dir . '/dnscache')) {
+        $SpamFilters_DNScache = array();
+        if ($fp = fopen ($data_dir . '/dnscache', 'r')) {
+            flock($fp,LOCK_SH);
+            while ($data = fgetcsv($fp,1024)) {
+               if ($data[2] > time()) {
+                  $SpamFilters_DNScache[$data[0]]['L'] = $data[1];
+                  $SpamFilters_DNScache[$data[0]]['T'] = $data[2];
+               }
+            }
+            flock($fp,LOCK_UN);
         }
-    } 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 $data;
 }
 
+/**
+ * Uses the BulkQuery executable to query all the RBLs at once
+ * @param array $filters Array of SPAM Fitlers
+ * @param array $IPs Array of IP Addresses
+ * @access private
+ */
+function filters_bulkquery($filters, $IPs) {
+    global $attachment_dir, $username,
+           $SpamFilters_DNScache, $SpamFilters_BulkQuery,
+           $SpamFilters_CacheTTL;
+
+    if (count($IPs) > 0) {
+        $rbls = array();
+        foreach ($filters as $key => $value) {
+            if ($filters[$key]['enabled']) {
+                if ($filters[$key]['dns']) {
+                    $rbls[$filters[$key]['dns']] = true;
+                }
+            }
+        }
 
-function start_filters() {
-    global $mailbox, $username, $key, $imapServerAddress, $imapPort, $imap,
-        $imap_general, $filters, $imap_stream, $imapConnection,
-    $UseSeparateImapConnection, $AllowSpamFilters;
-
-#    if ($mailbox == 'INBOX') {
-        // Detect if we have already connected to IMAP or not.
-        // Also check if we are forced to use a separate IMAP connection
-        if ((!isset($imap_stream) && !isset($imapConnection)) ||
-            $UseSeparateImapConnection) {
-                $stream = sqimap_login($username, $key, $imapServerAddress,
-                                    $imapPort, 10);
-                $previously_connected = false;
-        } elseif (isset($imapConnection)) {
-            $stream = $imapConnection;
-            $previously_connected = true;
-        } else {
-            $previously_connected = true;
-            $stream = $imap_stream;
+        $bqfil = $attachment_dir . $username . '-bq.in';
+        $fp = fopen($bqfil, 'w');
+        fputs ($fp, $SpamFilters_CacheTTL . "\n");
+        foreach ($rbls as $key => $value) {
+            fputs ($fp, '.' . $key . "\n");
+        }
+        fputs ($fp, "----------\n");
+        foreach ($IPs as $key => $value) {
+            fputs ($fp, $key . "\n");
+        }
+        fclose ($fp);
+        $bqout = array();
+        exec ($SpamFilters_BulkQuery . ' < ' . $bqfil, $bqout);
+        foreach ($bqout as $value) {
+            $Chunks = explode(',', $value);
+            $SpamFilters_DNScache[$Chunks[0]]['L'] = $Chunks[1];
+            $SpamFilters_DNScache[$Chunks[0]]['T'] = $Chunks[2] + time();
         }
+        unlink($bqfil);
+    }
+}
 
-        if (sqimap_get_num_messages($stream, 'INBOX') > 0) {
-            // Filter spam from inbox before we sort them into folders
-            if ($AllowSpamFilters) {
-                spam_filters($stream);
-            }
+/**
+ * Starts the filtering process
+ * @access private
+ */
+function start_filters() {
+    global $imapServerAddress, $imapPort, $imap_stream, $imapConnection,
+           $UseSeparateImapConnection, $AllowSpamFilters;
+
+    if (!file_exists(SM_PATH . 'plugins/filters/config.php')) return;
+
+    sqgetGlobalVar('username', $username, SQ_SESSION);
+    sqgetGlobalVar('key',      $key,      SQ_COOKIE);
+
+    // Detect if we have already connected to IMAP or not.
+    // Also check if we are forced to use a separate IMAP connection
+    if ((!isset($imap_stream) && !isset($imapConnection)) ||
+        $UseSeparateImapConnection ) {
+            $stream = sqimap_login($username, $key, $imapServerAddress,
+                                $imapPort, 10);
+            $previously_connected = false;
+    } else if (isset($imapConnection)) {
+        $stream = $imapConnection;
+        $previously_connected = true;
+    } else {
+        $previously_connected = true;
+        $stream = $imap_stream;
+    }
+    $aStatus = sqimap_status_messages ($stream, 'INBOX', array('MESSAGES'));
 
-            // Sort into folders
-            user_filters($stream);
+    if ($aStatus['MESSAGES']) {
+        sqimap_mailbox_select($stream, 'INBOX');
+        // Filter spam from inbox before we sort them into folders
+        if ($AllowSpamFilters) {
+            spam_filters($stream);
         }
 
-        if (!$previously_connected) {
-            sqimap_logout($stream);
-        }
-#    }
-}
+        // Sort into folders
+        user_filters($stream);
+    }
 
+    if (!$previously_connected) {
+        sqimap_logout($stream);
+    }
+}
 
+/**
+ * Does the loop through each filter
+ * @param stream imap_stream the stream to read from
+ * @access private
+ */
 function user_filters($imap_stream) {
+    global $data_dir, $username;
     $filters = load_filters();
     if (! $filters) return;
+    $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
 
-    sqimap_mailbox_select($imap_stream, 'INBOX');
-
+    $expunge = false;
     // For every rule
-    for ($i=0; $i < count($filters); $i++) {
+    for ($i=0, $num = count($filters); $i < $num; $i++) {
         // If it is the "combo" rule
         if ($filters[$i]['where'] == 'To or Cc') {
             /*
             *  If it's "TO OR CC", we have to do two searches, one for TO
             *  and the other for CC.
             */
-            filter_search_and_delete($imap_stream, 'TO',
-            $filters[$i]['what'], $filters[$i]['folder']);
-            filter_search_and_delete($imap_stream, 'CC',
-            $filters[$i]['what'], $filters[$i]['folder']);
+            $expunge = filter_search_and_delete($imap_stream, 'TO',
+                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
+            $expunge = filter_search_and_delete($imap_stream, 'CC',
+                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
+        } else if ($filters[$i]['where'] == 'Header and Body') {
+            $expunge = filter_search_and_delete($imap_stream, 'TEXT',
+                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
+        } else if ($filters[$i]['where'] == 'Message Body') {
+            $expunge = filter_search_and_delete($imap_stream, 'BODY',
+                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
         } else {
             /*
             *  If it's a normal TO, CC, SUBJECT, or FROM, then handle it
             *  normally.
             */
-            filter_search_and_delete($imap_stream, $filters[$i]['where'],
-            $filters[$i]['what'], $filters[$i]['folder']);
+            $expunge = filter_search_and_delete($imap_stream, $filters[$i]['where'],
+                 $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $expunge);
         }
     }
     // Clean out the mailbox whether or not auto_expunge is on
     // That way it looks like it was redirected properly
-    sqimap_mailbox_expunge($imap_stream, 'INBOX');
+    if ($expunge) {
+        sqimap_mailbox_expunge($imap_stream, 'INBOX');
+    }
 }
 
-function filter_search_and_delete($imap, $where, $what, $where_to) {
-    // Don't mess with the " characters on this fputs line!
-    fputs ($imap, 'a001 SEARCH ALL ' . $where . ' "' . addslashes($what) .
-        "\"\r\n");
-    $read = filters_sqimap_read_data ($imap, 'a001', true, $response, $message);
-
-    // This may have problems with EIMS due to it being goofy
-
-    for ($r=0; $r < count($read) &&
-                substr($read[$r], 0, 8) != '* SEARCH'; $r++) {}
-    if ($response == 'OK') {
-        $ids = explode(' ', $read[$r]);
-        if (sqimap_mailbox_exists($imap, $where_to)) {
-            for ($j=2; $j < count($ids); $j++) {
-                $id = trim($ids[$j]);
-                sqimap_messages_copy ($imap, $id, $id, $where_to);
-                sqimap_messages_flag ($imap, $id, $id, 'Deleted');
+/**
+ * Creates and runs the IMAP command to filter messages
+ * @param string $where Which part of the message to search (TO, CC, SUBJECT, etc...)
+ * @param string $what String to search for
+ * @param string $where_to Folder it will move to
+ * @param string $user_scan Whether to search all or just unseen
+ * @param string $should_expunge
+ * @param boolean $where Which part of location to search
+ * @access private
+ */
+function filter_search_and_delete($imap_stream, $where, $what, $where_to, $user_scan,
+                                  $should_expunge) {
+    global $languages, $squirrelmail_language, $allow_charset_search, $imap_server_type;
+
+    if (strtolower($where_to) == 'inbox') {
+        return array();
+    }
+
+    if ($user_scan == 'new') {
+        $category = 'UNSEEN';
+    } else {
+        $category = 'ALL';
+    }
+    $category .= ' UNDELETED';
+
+    if ($allow_charset_search &&
+        isset($languages[$squirrelmail_language]['CHARSET']) &&
+        $languages[$squirrelmail_language]['CHARSET']) {
+        $search_str = 'SEARCH CHARSET '
+                    . strtoupper($languages[$squirrelmail_language]['CHARSET'])
+                    . ' ' . $category;
+    } else {
+        $search_str = 'SEARCH CHARSET US-ASCII ' . $category;
+    }
+    if ($where == 'Header') {
+        $what  = explode(':', $what);
+        $where = trim($where . ' ' . $what[0]);
+        $what  = addslashes(trim($what[1]));
+    }
+
+    // see comments in squirrelmail sqimap_search function
+    if ($imap_server_type == 'macosx' || $imap_server_type == 'hmailserver') {
+        $search_str .= ' ' . $where . ' ' . $what;
+    } else {
+        $search_str .= ' ' . $where . ' {' . strlen($what) . "}\r\n"
+                    . $what . "\r\n";
+    }
+
+    /* read data back from IMAP */
+    $read = sqimap_run_command($imap_stream, $search_str, true, $response, $message, TRUE);
+    if (isset($read[0])) {
+        $ids = array();
+        for ($i = 0, $iCnt = count($read); $i < $iCnt; ++$i) {
+            if (preg_match("/^\* SEARCH (.+)$/", $read[$i], $regs)) {
+                $ids = preg_split("/ /", trim($regs[1]));
+            break;
+            }
+        }
+        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);
             }
         }
     }
+    return $should_expunge;
 }
 
-// These are the spam filters
+/**
+ * Loops through all the Received Headers to find IP Addresses
+ * @param stream imap_stream the stream to read from
+ * @access private
+ */
 function spam_filters($imap_stream) {
     global $data_dir, $username;
     global $SpamFilters_YourHop;
     global $SpamFilters_DNScache;
+    global $SpamFilters_SharedCache;
+    global $SpamFilters_BulkQuery;
+    global $SpamFilters_CacheTTL;
 
     $filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
     $filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
     $filters = load_spam_filters();
 
-    $run = 0;
+    if ($SpamFilters_SharedCache) {
+       filters_LoadCache();
+    }
 
-    foreach ($filters as $Key=> $Value) {
+    $run = false;
+
+    foreach ($filters as $Key => $Value) {
         if ($Value['enabled']) {
-            $run ++;
+            $run = true;
+            break;
         }
     }
 
     // short-circuit
-    if ($run == 0) {
+    if (!$run) {
         return;
     }
 
-    sqimap_mailbox_select($imap_stream, 'INBOX');
-
     // Ask for a big list of all "Received" headers in the inbox with
     // flags for each message.  Kinda big.
-    fputs($imap_stream, 'A3999 FETCH 1:* (FLAGS BODY.PEEK[HEADER.FIELDS ' .
-        "(RECEIVED)])\r\n");
-
-    $read = filters_sqimap_read_data ($imap_stream, 'A3999', true,
-                                    $response, $message);
 
-    if ($response != 'OK') {
+    if ($filters_spam_scan == 'new') {
+        $search_array = array();
+        $read = sqimap_run_command($imap_stream, 'SEARCH UNSEEN', true, $response, $message, TRUE);
+        if (isset($read[0])) {
+            for ($i = 0, $iCnt = count($read); $i < $iCnt; ++$i) {
+                if (preg_match("/^\* SEARCH (.+)$/", $read[$i], $regs)) {
+                    $search_array = preg_split("/ /", trim($regs[1]));
+                break;
+                }
+            }
+        }
+    }
+    if ($filters_spam_scan == 'new' && count($search_array)) {
+        $headers = sqimap_get_small_header_list ($imap_stream, $search_array, array('Received'),array());
+    } else if ($filters_spam_scan != 'new') {
+        $headers = sqimap_get_small_header_list ($imap_stream, null , array('Received'),array());
+    } else {
         return;
     }
-
-    $i = 0;
-    while ($i < count($read)) {
-        // EIMS will give funky results
-        $Chunks = explode(' ', $read[$i]);
-        if ($Chunks[0] != '*') {
-            $i ++;
-            continue;
-        }
-        $MsgNum = $Chunks[1];
-
-        $IPs = array();
-        $i ++;
-        $IsSpam = 0;
-        $Scan = 1;
-
-        // Check for normal IMAP servers
-        if ($filters_spam_scan == 'new') {
-            if (is_int(strpos($Chunks[4], '\Seen'))) {
-                $Scan = 0;
-            }
+    if (!count($headers)) {
+        return;
+    }
+    $bulkquery = (strlen($SpamFilters_BulkQuery) > 0 ? true : false);
+    $IPs = array();
+    $aSpamIds = array();
+    foreach ($headers as $id => $aValue) {
+        if (isset($aValue['UID'])) {
+            $MsgNum = $aValue['UID'];
+        } else {
+            $MsgNum = $id;
         }
-
         // Look through all of the Received headers for IP addresses
-        // Stop when I get ")" on a line
-        // Stop if I get "*" on a line (don't advance)
-        // and above all, stop if $i is bigger than the total # of lines
-        while (($i < count($read)) &&
-                ($read[$i][0] != ')' && $read[$i][0] != '*' &&
-                $read[$i][0] != "\n") && (! $IsSpam)) {
-            // Check to see if this line is the right "Received from" line
-            // to check
-            if (is_int(strpos($read[$i], $SpamFilters_YourHop))) {
-
-                // short-circuit and skip work if we don't scan this one
-                if ($Scan) {
-                    $read[$i] = ereg_replace('[^0-9\.]', ' ', $read[$i]);
-                    $elements = explode(' ', $read[$i]);
-                    foreach ($elements as $value) {
-                        if ($value != '' &&
-                            ereg('[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}',
-                                $value, $regs)) {
-                            $Chunks = explode('.', $value);
-                            if (filters_spam_check_site($Chunks[0],
-                                    $Chunks[1], $Chunks[2], $Chunks[3],
-                                    $filters)) {
-                                $IsSpam ++;
-                                break;  // no sense in checking more IPs
-                            }
-                            // If we've checked one IP and YourHop is
-                            // just a space
-                            if ($SpamFilters_YourHop == ' ') {
-                                break;  // don't check any more
+        if (isset($aValue['RECEIVED'])) {
+            foreach ($aValue['RECEIVED'] as $received) {
+                // Check to see if this line is the right "Received from" line
+                // to check
+
+                // $aValue['Received'] is an array with all the received lines.
+                // We should check them from bottom to top and only check the first 2.
+                // Currently we check only the header where $SpamFilters_YourHop in occures
+
+                if (is_int(strpos($received, $SpamFilters_YourHop))) {
+                    if (preg_match('/([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})/',$received,$aMatch)) {
+                        $isspam = false;
+                        if (filters_spam_check_site($aMatch[1],$aMatch[2],$aMatch[3],$aMatch[4],$filters)) {
+                            $aSpamIds[] = $MsgNum;
+                            $isspam = true;
+                        }
+                        if ($bulkquery) {
+                            array_shift($aMatch);
+                            $IP = explode('.',$aMatch);
+                            foreach ($filters as $key => $value) {
+                                if ($filters[$key]['enabled'] && $filters[$key]['dns']) {
+                                    if (strlen($SpamFilters_DNScache[$IP.'.'.$filters[$key]['dns']]) == 0) {
+                                       $IPs[$IP] = true;
+                                       break;
+                                    }
+                                }
                             }
                         }
+                        // If we've checked one IP and YourHop is
+                        // just a space
+                        if ($SpamFilters_YourHop == ' ' || $isspam) {
+                            break;  // don't check any more
+                        }
                     }
                 }
             }
-            $i ++;
-        }
-
-        // Lookie!  It's spam!  Yum!
-        if ($IsSpam) {
-            if (sqimap_mailbox_exists($imap_stream, $filters_spam_folder)) {
-                sqimap_messages_copy ($imap_stream, $MsgNum, $MsgNum,
-                                    $filters_spam_folder);
-                sqimap_messages_flag ($imap_stream, $MsgNum, $MsgNum,
-                                    'Deleted');
-            }
-        } else {
         }
     }
+    // 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);
+        sqimap_mailbox_expunge($imap_stream, 'INBOX');
+    }
 
-    sqimap_mailbox_expunge($imap_stream, 'INBOX');
+    if ($bulkquery && count($IPs)) {
+        filters_bulkquery($filters, $IPs);
+    }
 
-    session_register('SpamFilters_DNScache');
+    if ($SpamFilters_SharedCache) {
+       filters_SaveCache();
+    } else {
+       sqsession_register($SpamFilters_DNScache, 'SpamFilters_DNScache');
+    }
 }
 
-
-// Does the loop through each enabled filter for the specified IP address.
-// IP format:  $a.$b.$c.$d
+/**
+ * Does the loop through each enabled filter for the specified IP address.
+ * IP format:  $a.$b.$c.$d
+ * @param int $a First subset of IP
+ * @param int $b Second subset of IP
+ * @param int $c Third subset of IP
+ * @param int $d Forth subset of IP
+ * @param array $filters The Spam Filters
+ * @return boolean Whether the IP is Spam
+ * @access private
+ */
 function filters_spam_check_site($a, $b, $c, $d, &$filters) {
-    global $SpamFilters_DNScache;
+    global $SpamFilters_DNScache, $SpamFilters_CacheTTL;
     foreach ($filters as $key => $value) {
         if ($filters[$key]['enabled']) {
             if ($filters[$key]['dns']) {
                 $filter_revip = $d . '.' . $c . '.' . $b . '.' . $a . '.' .
                                 $filters[$key]['dns'];
-                if (strlen($SpamFilters_DNScache[$filter_revip]) == 0) {
-                    $SpamFilters_DNScache[$filter_revip] =
-                                        gethostbyname($filter_revip);
+
+                if(!isset($SpamFilters_DNScache[$filter_revip]['L']))
+                        $SpamFilters_DNScache[$filter_revip]['L'] = '';
+
+                if(!isset($SpamFilters_DNScache[$filter_revip]['T']))
+                        $SpamFilters_DNScache[$filter_revip]['T'] = '';
+
+                if (strlen($SpamFilters_DNScache[$filter_revip]['L']) == 0) {
+                    $SpamFilters_DNScache[$filter_revip]['L'] =
+                                    gethostbyname($filter_revip);
+                    $SpamFilters_DNScache[$filter_revip]['T'] =
+                                       time() + $SpamFilters_CacheTTL;
                 }
-                if ($SpamFilters_DNScache[$filter_revip] ==
+                if ($SpamFilters_DNScache[$filter_revip]['L'] ==
                     $filters[$key]['result']) {
                     return 1;
                 }
@@ -336,10 +482,16 @@ function filters_spam_check_site($a, $b, $c, $d, &$filters) {
     return 0;
 }
 
+/**
+ * Loads the filters from the user preferences
+ * @return array All the user filters
+ * @access private
+ */
 function load_filters() {
     global $data_dir, $username;
+
     $filters = array();
-    for ($i=0; $fltr = getPref($data_dir, $username, 'filter' . $i); $i++) {
+    for ($i = 0; $fltr = getPref($data_dir, $username, 'filter' . $i); $i++) {
         $ary = explode(',', $fltr);
         $filters[$i]['where'] = $ary[0];
         $filters[$i]['what'] = $ary[1];
@@ -348,6 +500,11 @@ function load_filters() {
     return $filters;
 }
 
+/**
+ * Loads the Spam Filters and checks the preferences for the enabled status
+ * @return array All the spam filters
+ * @access private
+ */
 function load_spam_filters() {
     global $data_dir, $username, $SpamFilters_ShowCommercial;
 
@@ -366,7 +523,7 @@ function load_spam_filters() {
         $filters['MAPS RSS']['dns'] = 'relays.mail-abuse.org';
         $filters['MAPS RSS']['result'] = '127.0.0.2';
         $filters['MAPS RSS']['comment'] =
-            _("COMMERCIAL - Servers that are configured (or misconfigured) to allow spam to be relayed through their system will be banned with this.  Another good one to use.");
+            _("COMMERCIAL - Servers that are configured (or misconfigured) to allow spam to be relayed through their system will be banned with this. Another good one to use.");
 
         $filters['MAPS DUL']['prefname'] = 'filters_spam_maps_dul';
         $filters['MAPS DUL']['name'] = 'MAPS Dial-Up List';
@@ -374,7 +531,7 @@ function load_spam_filters() {
         $filters['MAPS DUL']['dns'] = 'dialups.mail-abuse.org';
         $filters['MAPS DUL']['result'] = '127.0.0.3';
         $filters['MAPS DUL']['comment'] =
-            _("COMMERCIAL - Dial-up users are often filtered out since they should use their ISP's mail servers to send mail.  Spammers typically get a dial-up account and send spam directly from there.");
+            _("COMMERCIAL - Dial-up users are often filtered out since they should use their ISP's mail servers to send mail. Spammers typically get a dial-up account and send spam directly from there.");
 
         $filters['MAPS RBLplus-RBL']['prefname'] = 'filters_spam_maps_rblplus_rbl';
         $filters['MAPS RBLplus-RBL']['name'] = 'MAPS RBL+ RBL List';
@@ -401,70 +558,6 @@ function load_spam_filters() {
             _("COMMERCIAL - RBL+ Dial-up entries.");
     }
 
-    $filters['Osirusoft Relays']['prefname'] = 'filters_spam_maps_osirusoft_relay';
-    $filters['Osirusoft Relays']['name'] = 'Osirusoft Relay List';
-    $filters['Osirusoft Relays']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft Relays']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft Relays']['result'] = '127.0.0.2';
-    $filters['Osirusoft Relays']['comment'] =
-        _("FREE - Osirusoft Relays - Osirusofts list of verified open relays. Seems to include servers used by abuse@uunet.net auto-replies too.");
-
-    $filters['Osirusoft DUL']['prefname'] = 'filters_spam_maps_osirusoft_dul';
-    $filters['Osirusoft DUL']['name'] = 'Osirusoft Dialup List';
-    $filters['Osirusoft DUL']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft DUL']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft DUL']['result'] = '127.0.0.3';
-    $filters['Osirusoft DUL']['comment'] =
-        _("FREE - Osirusoft Dialups - Osirusofts Dialup Spam Source list.");
-
-    $filters['Osirusoft Spam Source']['prefname'] = 'filters_spam_maps_osirusoft_rc';
-    $filters['Osirusoft Spam Source']['name'] = 'Osirusoft Confirmed Spam Source List';
-    $filters['Osirusoft Spam Source']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft Spam Source']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft Spam Source']['result'] = '127.0.0.4';
-    $filters['Osirusoft Spam Source']['comment'] =
-        _("FREE - Osirusoft Confirmed Spam Source - Sites that continually spam and have been manually added after multiple nominations. Use with caution. Seems to catch abuse auto-replies from some ISPs.");
-
-    $filters['Osirusoft Smart Host']['prefname'] = 'filters_spam_maps_osirusoft_sh';
-    $filters['Osirusoft Smart Host']['name'] = 'Osirusoft Smart Host List';
-    $filters['Osirusoft Smart Host']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft Smart Host']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft Smart Host']['result'] = '127.0.0.5';
-    $filters['Osirusoft Smart Host']['comment'] =
-        _("FREE - Osirusoft Smart Hosts - List of hosts that are secure but relay for other mail servers that are not secure.");
-
-    $filters['Osirusoft SPAMware']['prefname'] = 'filters_spam_maps_osirusoft_ss';
-    $filters['Osirusoft SPAMware']['name'] = 'Osirusoft Spamware Developers List';
-    $filters['Osirusoft SPAMware']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft SPAMware']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft SPAMware']['result'] = '127.0.0.6';
-    $filters['Osirusoft SPAMware']['comment'] =
-        _("FREE - Osirusoft Spamware Developers - It is believed that these are IP ranges of companies that are known to produce spam software. Seems to catch abuse auto-replies from some ISPs.");
-
-    $filters['Osirusoft Unc. OptIn']['prefname'] = 'filters_spam_maps_osirusoft_sl';
-    $filters['Osirusoft Unc. OptIn']['name'] = 'Osirusoft Unconfirmed OptIn Server List';
-    $filters['Osirusoft Unc. OptIn']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft Unc. OptIn']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft Unc. OptIn']['result'] = '127.0.0.7';
-    $filters['Osirusoft Unc. OptIn']['comment'] =
-        _("FREE - Osirusoft Unconfirmed OptIn Servers - List of listservers that opt users in without confirmation.");
-
-    $filters['Osirusoft Insecure Formmail']['prefname'] = 'filters_spam_maps_osirusoft_fm';
-    $filters['Osirusoft Insecure Formmail']['name'] = 'Osirusoft Insecure formmail.cvi Script List';
-    $filters['Osirusoft Insecure Formmail']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft Insecure Formmail']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft Insecure Formmail']['result'] = '127.0.0.8';
-    $filters['Osirusoft Insecure Formmail']['comment'] =
-        _("FREE - Osirusoft Insecure formmail.cgi scripts - List of insecure formmail.cgi scripts. (planned).");
-
-    $filters['Osirusoft Open Proxy']['prefname'] = 'filters_spam_maps_osirusoft_op';
-    $filters['Osirusoft Open Proxy']['name'] = 'Osirusoft Open Proxy Server List';
-    $filters['Osirusoft Open Proxy']['link'] = 'http://relays.osirusoft.com/';
-    $filters['Osirusoft Open Proxy']['dns'] = 'relays.osirusoft.com';
-    $filters['Osirusoft Open Proxy']['result'] = '127.0.0.9';
-    $filters['Osirusoft Open Proxy']['comment'] =
-        _("FREE - Osirusoft Open Proxy Servers - List of Open Proxy Servers.");
-
     $filters['ORDB']['prefname'] = 'filters_spam_ordb';
     $filters['ORDB']['name'] = 'Open Relay Database List';
     $filters['ORDB']['link'] = 'http://www.ordb.org/';
@@ -473,22 +566,6 @@ function load_spam_filters() {
     $filters['ORDB']['comment'] =
         _("FREE - ORDB was born when ORBS went off the air. It seems to have fewer false positives than ORBS did though.");
 
-    $filters['ORBZ Inputs']['prefname'] = 'filters_spam_orbz';
-    $filters['ORBZ Inputs']['name'] = 'ORBZ Inputs List';
-    $filters['ORBZ Inputs']['link'] = 'http://www.orbz.org/';
-    $filters['ORBZ Inputs']['dns'] = 'inputs.orbz.org';
-    $filters['ORBZ Inputs']['result'] = '127.0.0.2';
-    $filters['ORBZ Inputs']['comment'] =
-        _("FREE - Another ORBS replacement (just the INPUTS database used here).");
-
-    $filters['ORBZ Outputs']['prefname'] = 'filters_spam_orbz_outputs';
-    $filters['ORBZ Outputs']['name'] = 'ORBZ Outputs List';
-    $filters['ORBZ Outputs']['link'] = 'http://www.orbz.org/';
-    $filters['ORBZ Outputs']['dns'] = 'outputs.orbz.org';
-    $filters['ORBZ Outputs']['result'] = '127.0.0.2';
-    $filters['ORBZ Outputs']['comment'] =
-        _("FREE - Another ORBS replacement (just the OUTPUTS database used here).");
-
     $filters['FiveTen Direct']['prefname'] = 'filters_spam_fiveten_src';
     $filters['FiveTen Direct']['name'] = 'Five-Ten-sg.com Direct SPAM Sources';
     $filters['FiveTen Direct']['link'] = 'http://www.five-ten-sg.com/blackhole.php';
@@ -567,7 +644,7 @@ function load_spam_filters() {
     $filters['SPAMcop']['dns'] = 'bl.spamcop.net';
     $filters['SPAMcop']['result'] = '127.0.0.2';
     $filters['SPAMcop']['comment'] =
-        _("FREE, for now - SPAMCOP - An interesting solution that lists servers that have a very high spam to legit email ratio (85% or more).");
+        _("FREE, for now - SpamCop - An interesting solution that lists servers that have a very high spam to legit email ratio (85 percent or more).");
 
     $filters['dev.null.dk']['prefname'] = 'filters_spam_devnull';
     $filters['dev.null.dk']['name'] = 'dev.null.dk Lists';
@@ -585,29 +662,29 @@ function load_spam_filters() {
     $filters['visi.com']['comment'] =
         _("FREE - visi.com - Relay Stop List. Very conservative OpenRelay List.");
 
-    $filters['2mbit.com Open Relays']['prefname'] = 'filters_spam_2mb_or';
-    $filters['2mbit.com Open Relays']['name'] = '2mbit.com Open Relays List';
-    $filters['2mbit.com Open Relays']['link'] = 'http://www.2mbit.com/sbl.php';
-    $filters['2mbit.com Open Relays']['dns'] = 'blackholes.2mbit.com';
-    $filters['2mbit.com Open Relays']['result'] = '127.0.0.2';
-    $filters['2mbit.com Open Relays']['comment'] =
-        _("FREE - 2mbit.com Open Relays - Another list of Open Relays.");
-
-    $filters['2mbit.com SPAM Source']['prefname'] = 'filters_spam_2mb_ss';
-    $filters['2mbit.com SPAM Source']['name'] = '2mbit.com SPAM Source List';
-    $filters['2mbit.com SPAM Source']['link'] = 'http://www.2mbit.com/sbl.php';
-    $filters['2mbit.com SPAM Source']['dns'] = 'blackholes.2mbit.com';
-    $filters['2mbit.com SPAM Source']['result'] = '127.0.0.4';
-    $filters['2mbit.com SPAM Source']['comment'] =
-        _("FREE - 2mbit.com SPAM Source - List of Direct SPAM Sources.");
-
-    $filters['2mbit.com SPAM ISPs']['prefname'] = 'filters_spam_2mb_isp';
-    $filters['2mbit.com SPAM ISPs']['name'] = '2mbit.com SPAM-friendly ISP List';
-    $filters['2mbit.com SPAM ISPs']['link'] = 'http://www.2mbit.com/sbl.php';
-    $filters['2mbit.com SPAM ISPs']['dns'] = 'blackholes.2mbit.com';
-    $filters['2mbit.com SPAM ISPs']['result'] = '127.0.0.10';
-    $filters['2mbit.com SPAM ISPs']['comment'] =
-        _("FREE - 2mbit.com SPAM ISPs - List of SPAM-friendly ISPs.");
+    $filters['ahbl.org Open Relays']['prefname'] = 'filters_spam_2mb_or';
+    $filters['ahbl.org Open Relays']['name'] = 'ahbl.org Open Relays List';
+    $filters['ahbl.org Open Relays']['link'] = 'http://www.ahbl.org/';
+    $filters['ahbl.org Open Relays']['dns'] = 'dnsbl.ahbl.org';
+    $filters['ahbl.org Open Relays']['result'] = '127.0.0.2';
+    $filters['ahbl.org Open Relays']['comment'] =
+        _("FREE - ahbl.org Open Relays - Another list of Open Relays.");
+
+    $filters['ahbl.org SPAM Source']['prefname'] = 'filters_spam_2mb_ss';
+    $filters['ahbl.org SPAM Source']['name'] = 'ahbl.org SPAM Source List';
+    $filters['ahbl.org SPAM Source']['link'] = 'http://www.ahbl.org/';
+    $filters['ahbl.org SPAM Source']['dns'] = 'dnsbl.ahbl.org';
+    $filters['ahbl.org SPAM Source']['result'] = '127.0.0.4';
+    $filters['ahbl.org SPAM Source']['comment'] =
+        _("FREE - ahbl.org SPAM Source - List of Direct SPAM Sources.");
+
+    $filters['ahbl.org SPAM ISPs']['prefname'] = 'filters_spam_2mb_isp';
+    $filters['ahbl.org SPAM ISPs']['name'] = 'ahbl.org SPAM-friendly ISP List';
+    $filters['ahbl.org SPAM ISPs']['link'] = 'http://www.ahbl.org/';
+    $filters['ahbl.org SPAM ISPs']['dns'] = 'dnsbl.ahbl.org';
+    $filters['ahbl.org SPAM ISPs']['result'] = '127.0.0.7';
+    $filters['ahbl.org SPAM ISPs']['comment'] =
+        _("FREE - ahbl.org SPAM ISPs - List of SPAM-friendly ISPs.");
 
     $filters['Leadmon DUL']['prefname'] = 'filters_spam_lm_dul';
     $filters['Leadmon DUL']['name'] = 'Leadmon.net DUL List';
@@ -673,19 +750,46 @@ function load_spam_filters() {
     $filters['NJABL DUL']['comment'] =
         _("FREE, for now - Not Just Another Blacklist - Dial-up IPs.");
 
+    $filters['Conf DSBL.ORG Relay']['prefname'] = 'filters_spam_dsbl_conf_ss';
+    $filters['Conf DSBL.ORG Relay']['name'] = 'DSBL.org Confirmed Relay List';
+    $filters['Conf DSBL.ORG Relay']['link'] = 'http://www.dsbl.org/';
+    $filters['Conf DSBL.ORG Relay']['dns'] = 'list.dsbl.org';
+    $filters['Conf DSBL.ORG Relay']['result'] = '127.0.0.2';
+    $filters['Conf DSBL.ORG Relay']['comment'] =
+        _("FREE - Distributed Sender Boycott List - Confirmed Relays");
+
+    $filters['Conf DSBL.ORG Multi-Stage']['prefname'] = 'filters_spam_dsbl_conf_ms';
+    $filters['Conf DSBL.ORG Multi-Stage']['name'] = 'DSBL.org Confirmed Multi-Stage Relay List';
+    $filters['Conf DSBL.ORG Multi-Stage']['link'] = 'http://www.dsbl.org/';
+    $filters['Conf DSBL.ORG Multi-Stage']['dns'] = 'multihop.dsbl.org';
+    $filters['Conf DSBL.ORG Multi-Stage']['result'] = '127.0.0.2';
+    $filters['Conf DSBL.ORG Multi-Stage']['comment'] =
+        _("FREE - Distributed Sender Boycott List - Confirmed Multi-stage Relays");
+
+    $filters['UN-Conf DSBL.ORG']['prefname'] = 'filters_spam_dsbl_unc';
+    $filters['UN-Conf DSBL.ORG']['name'] = 'DSBL.org UN-Confirmed Relay List';
+    $filters['UN-Conf DSBL.ORG']['link'] = 'http://www.dsbl.org/';
+    $filters['UN-Conf DSBL.ORG']['dns'] = 'unconfirmed.dsbl.org';
+    $filters['UN-Conf DSBL.ORG']['result'] = '127.0.0.2';
+    $filters['UN-Conf DSBL.ORG']['comment'] =
+        _("FREE - Distributed Sender Boycott List - UN-Confirmed Relays");
+
     foreach ($filters as $Key => $Value) {
-        $filters[$Key]['enabled'] = getPref($data_dir, $username,
-            $filters[$Key]['prefname']);
+        $filters[$Key]['enabled'] = getPref($data_dir, $username, $filters[$Key]['prefname']);
     }
 
     return $filters;
 }
 
+/**
+ * Removes a User filter
+ * @param int $id ID of the filter to remove
+ * @access private
+ */
 function remove_filter ($id) {
     global $data_dir, $username;
 
-    while ($nextFilter = getPref($data_dir, $username, 'filter' .
-        ($id + 1))) {
+    while ($nextFilter = getPref($data_dir, $username, 'filter' . ($id + 1))) {
         setPref($data_dir, $username, 'filter' . $id, $nextFilter);
         $id ++;
     }
@@ -693,6 +797,12 @@ function remove_filter ($id) {
     removePref($data_dir, $username, 'filter' . $id);
 }
 
+/**
+ * Swaps two filters
+ * @param int $id1 ID of first filter to swap
+ * @param int $id2 ID of second filter to swap
+ * @access private
+ */
 function filter_swap($id1, $id2) {
     global $data_dir, $username;
 
@@ -705,18 +815,24 @@ function filter_swap($id1, $id2) {
     }
 }
 
-/* This update the filter rules when
-   renaming or deleting folders */
+/**
+ * This updates the filter rules when renaming or deleting folders
+ * @param array $args
+ * @access private
+ */
 function update_for_folder ($args) {
+
+    if (!file_exists(SM_PATH . 'plugins/filters/config.php')) return;
+
     $old_folder = $args[0];
-       $new_folder = $args[2];
-       $action = $args[1];
-    global $plugins, $data_dir, $username;
+    $new_folder = $args[2];
+    $action = $args[1];
+    global $data_dir, $username;
     $filters = array();
     $filters = load_filters();
     $filter_count = count($filters);
     $p = 0;
-    for ($i=0;$i<$filter_count;$i++) {
+    for ($i = 0; $i < $filter_count; $i++) {
         if (!empty($filters)) {
             if ($old_folder == $filters[$i]['folder']) {
                 if ($action == 'rename') {
@@ -733,4 +849,18 @@ function update_for_folder ($args) {
         }
     }
 }
-?>
+
+/**
+ * Display formated error message
+ * @param string $string text message
+ * @return string html formated text message
+ * @access private
+ */
+function do_error($string) {
+    global $color;
+    echo "<p align=\"center\"><font color=\"$color[2]\">";
+    echo $string;
+    echo "</font></p>\n";
+}
+
+?>
\ No newline at end of file