Split out functionality that gathers system specs
[squirrelmail.git] / plugins / filters / filters.php
index 4cbf7b414802d21003887f03347742dfb3244ac7..34ffd31dd5b355784e5c04ef10200e4f74b0b271 100644 (file)
@@ -1,10 +1,6 @@
 <?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.
+ * Message and Spam Filter Plugin - Filtering Functions
  *
  * This plugin filters your inbox into different folders based upon given
  * criteria.  It is most useful for people who are subscibed to mailing lists
  *
  * Also view plugins/README.plugins for more information.
  *
- * $Id$
+ * @version $Id$
+ * @copyright (c) 1999-2004 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @package plugins
+ * @subpackage filters
  */
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function filters_SaveCache () {
     global $data_dir, $SpamFilters_DNScache;
 
@@ -52,6 +56,10 @@ function filters_SaveCache () {
     fclose($fp);
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function filters_LoadCache () {
     global $data_dir, $SpamFilters_DNScache;
 
@@ -71,64 +79,15 @@ function filters_LoadCache () {
     }
 }
 
-function filters_bulkquery($filters_spam_scan, $filters, $read) {
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
+function filters_bulkquery($filters, $IPs) {
     global $SpamFilters_YourHop, $attachment_dir, $username,
            $SpamFilters_DNScache, $SpamFilters_BulkQuery,
            $SpamFilters_CacheTTL;
 
-    $IPs = array();
-    $i = 0;
-    while ($i < count($read)) {
-        // EIMS will give funky results
-        $Chunks = explode(' ', $read[$i]);
-        if ($Chunks[0] != '*') {
-            $i ++;
-            continue;
-        }
-        $MsgNum = $Chunks[1];
-
-        $i ++;
-
-        // 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")) {
-            // Check to see if this line is the right "Received from" line
-            // to check
-            if (is_int(strpos($read[$i], $SpamFilters_YourHop))) {
-                $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);
-                        $IP = $Chunks[3] . '.' . $Chunks[2] . '.' .
-                              $Chunks[1] . '.' . $Chunks[0];
-                        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 == ' ') {
-                            break;  // don't check any more
-                        }
-                    }
-                }
-            }
-            $i ++;
-        }
-    }
-
     if (count($IPs) > 0) {
         $rbls = array();
         foreach ($filters as $key => $value) {
@@ -161,13 +120,17 @@ function filters_bulkquery($filters_spam_scan, $filters, $read) {
     }
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function start_filters() {
     global $mailbox, $imapServerAddress, $imapPort, $imap,
            $imap_general, $filters, $imap_stream, $imapConnection,
-           $UseSeparateImapConnection, $AllowSpamFilters, $_SESSION, $_COOKIE;
+           $UseSeparateImapConnection, $AllowSpamFilters;
 
-    $username = $_SESSION['username'];
-    $key = $_COOKIE['key'];
+    sqgetGlobalVar('username', $username, SQ_SESSION);
+    sqgetGlobalVar('key',      $key,      SQ_COOKIE);
 
 #    if ($mailbox == 'INBOX') {
         // Detect if we have already connected to IMAP or not.
@@ -201,6 +164,10 @@ function start_filters() {
 #    }
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function user_filters($imap_stream) {
     global $data_dir, $username;
     $filters = load_filters();
@@ -208,7 +175,7 @@ function user_filters($imap_stream) {
     $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
 
     sqimap_mailbox_select($imap_stream, 'INBOX');
-    $id = array();
+    $expunge = false;
     // For every rule
     for ($i=0, $num = count($filters); $i < $num; $i++) {
         // If it is the "combo" rule
@@ -217,30 +184,34 @@ function user_filters($imap_stream) {
             *  If it's "TO OR CC", we have to do two searches, one for TO
             *  and the other for CC.
             */
-            $id = filter_search_and_delete($imap_stream, 'TO',
-                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $id);
-            $id = filter_search_and_delete($imap_stream, 'CC',
-                  $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $id);
+            $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 it's a normal TO, CC, SUBJECT, or FROM, then handle it
             *  normally.
             */
-            $id = filter_search_and_delete($imap_stream, $filters[$i]['where'],
-                 $filters[$i]['what'], $filters[$i]['folder'], $filters_user_scan, $id);
+            $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
-    if (count($id)) {
+    if ($expunge) {
         sqimap_mailbox_expunge($imap_stream, 'INBOX');
     }
 }
 
-function filter_search_and_delete($imap, $where, $what, $where_to, $user_scan, 
-                                  $del_id) {
-    global $languages, $squirrelmail_language, $allow_charset_search, 
-           $uid_support, $imap_server_type;
+/**
+ * FIXME: Undocumented function
+ * @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 ($user_scan == 'new') {
         $category = 'UNSEEN';
     } else {
@@ -270,7 +241,7 @@ function filter_search_and_delete($imap, $where, $what, $where_to, $user_scan,
     }
 
     /* read data back from IMAP */
-    $read = sqimap_run_command($imap, $search_str, true, $response, $message, $uid_support);
+    $read = sqimap_run_command($imap_stream, $search_str, true, $response, $message, TRUE);
 
     // This may have problems with EIMS due to it being goofy
 
@@ -278,25 +249,36 @@ function filter_search_and_delete($imap, $where, $what, $where_to, $user_scan,
                 substr($read[$r], 0, 8) != '* SEARCH'; $r++) {}
     if ($response == 'OK') {
         $ids = explode(' ', $read[$r]);
-        if (sqimap_mailbox_exists($imap, $where_to)) {
+        
+        if (sqimap_mailbox_exists($imap_stream, $where_to)) {
+            $del_id = array();
             for ($j=2, $num = count($ids); $j < $num; $j++) {
                 $id = trim($ids[$j]);
-                $del_id[] = $id;
-                sqimap_messages_copy ($imap, $id, $id, $where_to);
-                sqimap_messages_flag ($imap, $id, $id, 'Deleted',false);
+                if (is_numeric($id)) {
+                    $del_id[] = $id;
+                }
+            }
+            if (count($del_id)) {
+                $should_expunge = true;
+                sqimap_msgs_list_move ($imap_stream, $del_id, $where_to);
+                // sqimap_mailbox_expunge($imap_stream, 'INBOX');
             }
         }
     }
-    return $del_id;
+    return $should_expunge;
 }
 
-// These are the spam filters
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function spam_filters($imap_stream) {
-    global $data_dir, $username, $uid_support;
+    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');
@@ -306,16 +288,17 @@ function spam_filters($imap_stream) {
        filters_LoadCache();
     }
 
-    $run = 0;
+    $run = false;
 
-    foreach ($filters as $Key=> $Value) {
+    foreach ($filters as $Key => $Value) {
         if ($Value['enabled']) {
-            $run ++;
+            $run = true;
+            break;
         }
     }
 
     // short-circuit
-    if ($run == 0) {
+    if (!$run) {
         return;
     }
 
@@ -323,111 +306,100 @@ function spam_filters($imap_stream) {
 
     // Ask for a big list of all "Received" headers in the inbox with
     // flags for each message.  Kinda big.
+    
+    // MGK, removed FLAGS from query. It wasn't used.
     if ($filters_spam_scan != 'new') {
-        $read = sqimap_run_command($imap_stream, 'FETCH 1:* (FLAGS BODY.PEEK[HEADER.FIELDS ' .
-            '(RECEIVED)])', true, $reponse, $message, $uid_support);
+        $query = 'FETCH 1:* (BODY.PEEK[HEADER.FIELDS (Received)])';
     } else {
-        $read = sqimap_run_command($imap_stream, 'SEARCH UNSEEN', true, $reponse, $message, $uid_support);
+        $read = sqimap_run_command($imap_stream, 'SEARCH UNSEEN', true, $response, $message, TRUE);
         if ($response != 'OK' || trim($read[0]) == '* SEARCH') {
-           $read = sqimap_run_command($imap_stream, 'FETCH 1:* (FLAGS BODY.PEEK[HEADER.FIELDS ' .
-            '(RECEIVED)])', true, $reponse, $message, $uid_support);
+           $query = 'FETCH 1:* (BODY.PEEK[HEADER.FIELDS (RECEIVED)])';
         } else {
-           $read[0] = trim($read[0]);
-            $i = 0;
-            $imap_query = $sid.' FETCH ';
-            $Chunks = explode(' ', $read[0]);
-            for ($i=2; $i < (count($Chunks)-1) ; $i++) {
-                $imap_query .= $Chunks[$i].',';
+            if (isset($read[0])) {
+                if (preg_match("/^\* SEARCH (.+)$/", $read[0], $regs)) {
+                    $search_array = preg_split("/ /", trim($regs[1]));
+                }
             }
-            $imap_query .= $Chunks[count($Chunks)-1];
-            $imap_query .= ' (FLAGS BODY.PEEK[HEADER.FIELDS ';
-            $imap_query .= '(RECEIVED)])';//\r\n";
-           $read = sqimap_run_command($imap_stream,$imap_query, true, $reponse, $message, $uid_support);
-        }
+            $msgs_str = sqimap_message_list_squisher($search_array);
+            $query =  'FETCH ' . $msgs_str . ' (BODY.PEEK[HEADER.FIELDS (RECEIVED)])';
+           }
     }
-    
-    if (isset($response) && $response != 'OK') {
+    $headers = filter_get_headers ($imap_stream, $query);    
+    if (!$headers) {
         return;
     }
-
-    if (strlen($SpamFilters_BulkQuery) > 0) {
-       filters_bulkquery($filters_spam_scan, $filters, $read);
-    }
-
-    $i = 0;
-    while ($i < count($read)) {
-        // EIMS will give funky results
-        $Chunks = explode(' ', $read[$i]);
-        if ($Chunks[0] != '*') {
-            $i ++;
-            continue;
+    
+    $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;
         }
-        $MsgNum = $Chunks[1];
-
-        $IPs = array();
-        $i ++;
-        $IsSpam = 0;
-
         // 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
-                $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 (isset($aValue['HEADER']['Received'])) {
+            foreach ($aValue['HEADER']['Received'] as $received) {
+                // Check to see if this line is the right "Received from" line
+                // to check
+                
+                // $aValue['HEADER']['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 == ' ') {
+                        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', false);
-            }
-        } 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);
+    }
 
     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
+/**
+ * FIXME: Undocumented function
+ * Does the loop through each enabled filter for the specified IP address.
+ * IP format:  $a.$b.$c.$d
+ * @access private
+ */
 function filters_spam_check_site($a, $b, $c, $d, &$filters) {
     global $SpamFilters_DNScache, $SpamFilters_CacheTTL;
     foreach ($filters as $key => $value) {
@@ -458,6 +430,10 @@ function filters_spam_check_site($a, $b, $c, $d, &$filters) {
     return 0;
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function load_filters() {
     global $data_dir, $username;
 
@@ -471,6 +447,10 @@ function load_filters() {
     return $filters;
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function load_spam_filters() {
     global $data_dir, $username, $SpamFilters_ShowCommercial;
 
@@ -489,7 +469,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';
@@ -497,7 +477,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';
@@ -524,70 +504,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/';
@@ -674,7 +590,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';
@@ -692,29 +608,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';
@@ -812,6 +728,10 @@ function load_spam_filters() {
     return $filters;
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function remove_filter ($id) {
     global $data_dir, $username;
 
@@ -824,6 +744,10 @@ function remove_filter ($id) {
     removePref($data_dir, $username, 'filter' . $id);
 }
 
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
 function filter_swap($id1, $id2) {
     global $data_dir, $username;
 
@@ -836,8 +760,11 @@ function filter_swap($id1, $id2) {
     }
 }
 
-/* This update the filter rules when
-   renaming or deleting folders */
+/**
+ * This update the filter rules when renaming or deleting folders
+ * @param array $args
+ * @access private
+ */
 function update_for_folder ($args) {
     $old_folder = $args[0];
         $new_folder = $args[2];
@@ -864,4 +791,138 @@ function update_for_folder ($args) {
         }
     }
 }
+
+/**
+ * Function extracted from sqimap_get_small_header_list.
+ * The unused FETCH arguments and HEADERS are disabled.
+ * @access private
+ */
+function filter_get_headers ($imap_stream, $query) {
+    /* Get the small headers for each message in $msg_list */
+
+    $read_list = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, TRUE);
+
+    if (isset($response) && $response != 'OK') {
+        return false;
+    }
+
+
+    foreach ($read_list as $r) {
+        $read = implode('',$r);
+        /* 
+            * #id<space>FETCH<space>(
+        */
+        /* extract the message id */
+        $i_space = strpos($read,' ',2);
+        $id = substr($read,2,$i_space-2);
+        $fetch = substr($read,$i_space+1,5);
+        if (!is_numeric($id) && $fetch !== 'FETCH') {
+            set_up_language($squirrelmail_language);
+            echo '<br><b><font color=$color[2]>' .
+                 _("ERROR : Could not complete request.") .
+                 '</b><br>' .
+                 _("Unknown response from IMAP server: ") . ' 1.' .
+                 htmlspecialchars($read) . "</font><br>\n";
+                 break;
+        }
+        $i = strpos($read,'(',$i_space+5);
+        $read = substr($read,$i+1);
+        $i_len = strlen($read);
+        $i = 0;
+        while ($i < $i_len && $i !== false) {
+            /* get argument */
+            $read = trim(substr($read,$i));
+            $i_len = strlen($read);
+            $i = strpos($read,' ');
+            $arg = substr($read,0,$i);
+            ++$i;
+            switch ($arg)
+            {
+            case 'UID':
+                $i_pos = strpos($read,' ',$i);
+                if (!$i_pos) {
+                    $i_pos = strpos($read,')',$i);
+                }
+                if ($i_pos) {
+                    $unique_id = substr($read,$i,$i_pos-$i);
+                    $i = $i_pos+1;
+                } else {
+                    break 3;
+                }
+                $msgs[$id]['UID'] = $unique_id;
+                break;
+            // case 'FLAGS':
+            //    $flags = parseArray($read,$i);
+            //    if (!$flags) break 3;
+            //    $msgs[$id]['FLAGS'] = $flags;
+            //    break;
+            // case 'RFC822.SIZE':
+            //    $i_pos = strpos($read,' ',$i);
+            //    if (!$i_pos) {
+            //        $i_pos = strpos($read,')',$i);
+            //    }
+            //    if ($i_pos) {
+            //        $size = substr($read,$i,$i_pos-$i);
+            //        $i = $i_pos+1;
+            //    } else {
+            //        break 3;
+            //    }
+            //    $msgs[$id]['SIZE'] = $size;
+            //    
+            //    break;
+            // case 'INTERNALDATE':
+            //    $msgs[$id]['INTERNALDATE'] = parseString($read,$i);
+            //    break;
+            case 'BODY.PEEK[HEADER.FIELDS':
+            case 'BODY[HEADER.FIELDS':
+                $i = strpos($read,'{',$i);
+                $header = parseString($read,$i);
+                if ($header === false) break 3;
+                /* First we unfold the header */
+                $hdr = trim(str_replace(array("\r\n\t", "\r\n "),array('', ''), $header));
+                /* Now we can make a new header array with */
+                /* each element representing a headerline  */
+                $hdr = explode("\r\n" , $hdr);
+                foreach ($hdr as $line) {
+                    $pos = strpos($line, ':');
+                    if ($pos > 0) {
+                        $field = strtolower(substr($line, 0, $pos));
+                        if (!strstr($field,' ')) { /* valid field */
+                            $value = trim(substr($line, $pos+1));
+                            switch($field) {
+                            case 'received':    $msgs[$id]['HEADER']['Received'][] =       $value; break;
+                            // case 'to':          $msgs[$id]['HEADER']['To']=             $value; break;
+                            // case 'cc':          $msgs[$id]['HEADER']['Cc'] =            $value; break;
+                            // case 'from':        $msgs[$id]['HEADER']['From'] =          $value; break;
+                            // case 'date':        $msgs[$id]['HEADER']['Date'] =          $value; break;
+                            // case 'x-priority':  $msgs[$id]['HEADER']['Prio'] =          $value; break;
+                            // case 'subject':     $msgs[$id]['HEADER']['Subject'] =       $value; break;
+                            // case 'content-type':$msgs[$id]['HEADER']['Content-Type'] =  $value; break;
+                            default: break;
+                            }
+                        }
+                    }
+                }
+                break;
+            default:
+                ++$i;
+                break;
+            }
+        }
+    }
+    return $msgs;
+}
+
+/**
+ * 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";
+}
 ?>