<?php
/**
- * Message and Spam Filter Plugin
+ * Message and Spam Filter Plugin - Filtering Functions
*
- * Copyright (c) 1999-2003 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.
- *
- * $Id$
+ * @copyright 1999-2017 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
+ */
+if (isset($_SERVER['SCRIPT_FILENAME']) && $_SERVER['SCRIPT_FILENAME'] == __FILE__) {
+ header("Location: ../../src/login.php");
+ die();
+}
+
+/** load globals */
+global $UseSeparateImapConnection,
+ $AllowSpamFilters, $SpamFilters_YourHop, $SpamFilters_ShowCommercial,
+ $SpamFilters_DNScache, $SpamFilters_BulkQuery, $SpamFilters_SharedCache,
+ $SpamFilters_CacheTTL;
+
+/**
+ * load required functions. Plugin depends on IMAP functions and they are not
+ * loaded in src/webmail.php
*/
+include_once (SM_PATH . 'functions/imap.php');
+
+/** load default config */
+if (file_exists(SM_PATH . 'plugins/filters/config_default.php')) {
+ include_once (SM_PATH . 'plugins/filters/config_default.php');
+} else {
+ // default config was removed.
+ $UseSeparateImapConnection = false;
+ $AllowSpamFilters = true;
+ $SpamFilters_YourHop = ' ';
+ $SpamFilters_ShowCommercial = false;
+ $SpamFilters_DNScache = array();
+ $SpamFilters_BulkQuery = '';
+ $SpamFilters_SharedCache = true;
+ $SpamFilters_CacheTTL = 7200;
+}
+if (file_exists(SM_PATH . 'config/filters_config.php')) {
+ include_once (SM_PATH . 'config/filters_config.php');
+} elseif (file_exists(SM_PATH . 'plugins/filters/config.php')) {
+ include_once (SM_PATH . 'plugins/filters/config.php');
+}
+
+/**
+ * Register option blocks
+ * @access private
+ */
+function filters_optpage_register_block() {
+ global $optpage_blocks, $AllowSpamFilters;
+
+ $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
+ );
+ }
+}
+
+/* Receive the status of the folder and do something with it */
+function filters_folder_status($statusarr) {
+
+ global $filter_inbox_count;
+ if (empty($filter_inbox_count)) $filter_inbox_count=0;
+
+ if ($statusarr['MAILBOX'] == 'INBOX')
+ {
+ if (!empty($statusarr['MESSAGES'])) $filter_inbox_count=$statusarr['MESSAGES'];
+ }
+}
+
+/**
+ * Saves the DNS Cache to disk
+ * @access private
+ */
function filters_SaveCache () {
global $data_dir, $SpamFilters_DNScache;
$fp = fopen($data_dir . '/dnscache', 'r');
flock($fp,LOCK_EX);
}
- $fp1=fopen($data_dir . '/dnscache', 'w+');
+ $fp1 = fopen($data_dir . '/dnscache', 'w+');
foreach ($SpamFilters_DNScache as $Key=> $Value) {
$tstr = $Key . ',' . $Value['L'] . ',' . $Value['T'] . "\n";
fclose($fp);
}
+/**
+ * Loads the DNS Cache from disk
+ * @access private
+ */
function filters_LoadCache () {
global $data_dir, $SpamFilters_DNScache;
$SpamFilters_DNScache = array();
if ($fp = fopen ($data_dir . '/dnscache', 'r')) {
flock($fp,LOCK_SH);
- while ($data=fgetcsv($fp,1024)) {
+ 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);
}
}
}
-function filters_bulkquery($filters_spam_scan, $filters, $read) {
- global $SpamFilters_YourHop, $attachment_dir, $username,
+/**
+ * Uses the BulkQuery executable to query all the RBLs at once
+ * @param array $filters Array of SPAM Filters
+ * @param array $IPs Array of IP Addresses
+ * @access private
+ */
+function filters_bulkquery($filters, $IPs) {
+ global $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) {
}
}
-function start_filters() {
- global $mailbox, $imapServerAddress, $imapPort, $imap,
- $imap_general, $filters, $imap_stream, $imapConnection,
- $UseSeparateImapConnection, $AllowSpamFilters;
-
- sqgetGlobalVar('username', $username, SQ_SESSION);
- sqgetGlobalVar('key', $key, SQ_COOKIE);
-
-# 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;
- }
+/**
+ * Starts the filtering process
+ * @param array $hook_args (since 1.5.2) do hook arguments. Is used to check
+ * hook name, array key = 0.
+ * @access private
+ */
+function start_filters($hook_args) {
+ 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,
+ * do filtering only when we are in INBOX folder.
+ */
+ if ($hook_args[0]=='right_main_after_header' &&
+ (sqgetGlobalVar('mailbox',$mailbox,SQ_FORM) && $mailbox!='INBOX')) {
+ return;
+ }
- if (sqimap_get_num_messages($stream, 'INBOX') > 0) {
- // Filter spam from inbox before we sort them into folders
- if ($AllowSpamFilters) {
- spam_filters($stream);
+ $filters = load_filters();
+
+ // No point running spam filters if there aren't any to run //
+ if ($AllowSpamFilters) {
+ $spamfilters = load_spam_filters();
+
+ $AllowSpamFilters = false;
+ foreach($spamfilters as $value) {
+ if ($value['enabled'] == SMPREF_ON) {
+ $AllowSpamFilters = true;
+ break;
}
+ }
+ }
+
+ // No user filters, and no spam filters, no need to continue //
+ if (!$AllowSpamFilters && empty($filters)) {
+ return;
+ }
+
+
+ // 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, false, $imapServerAddress,
+ $imapPort, 10, $imap_stream_options);
+ $previously_connected = false;
+ } else if (isset($imapConnection)) {
+ $stream = $imapConnection;
+ $previously_connected = true;
+ } else {
+ $previously_connected = true;
+ $stream = $imap_stream;
+ }
- // Sort into folders
- user_filters($stream);
+ if (!isset($filter_inbox_count)) {
+ $aStatus = sqimap_status_messages ($stream, 'INBOX', array('MESSAGES'));
+ if (!empty($aStatus['MESSAGES'])) {
+ $filter_inbox_count=$aStatus['MESSAGES'];
+ } else {
+ $filter_inbox_count=0;
}
+ }
- if (!$previously_connected) {
- sqimap_logout($stream);
+ if ($filter_inbox_count > 0) {
+ sqimap_mailbox_select($stream, 'INBOX');
+ // Filter spam from inbox before we sort them into folders
+ if ($AllowSpamFilters) {
+ spam_filters($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');
- $id = array();
+ $expunge = false;
// For every rule
for ($i=0, $num = count($filters); $i < $num; $i++) {
// If it is the "combo" rule
* 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 ($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.
*/
- $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;
+/**
+ * Creates and runs the IMAP command to filter messages
+ * @param string $imap_stream TODO: Document this parameter
+ * @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
+ * @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;
+
+ //TODO: make use of new mailbox cache. See mailbox_display.phpinfo
+
+ 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']) &&
}
if ($where == 'Header') {
$what = explode(':', $what);
+ $where = strtoupper($where);
$where = trim($where . ' ' . $what[0]);
$what = addslashes(trim($what[1]));
}
- if ($imap_server_type == 'macosx') {
- $search_str .= ' ' . $where . ' ' . $what;
+ // see comments in squirrelmail sqimap_search function
+ if ($imap_server_type == 'macosx' || $imap_server_type == 'hmailserver') {
+ $search_str .= ' ' . $where . ' ' . $what;
+ /* read data back from IMAP */
+ $read = sqimap_run_command($imap_stream, $search_str, true, $response, $message, TRUE);
} else {
- $search_str .= ' ' . $where . ' {' . strlen($what) . "}\r\n"
- . $what . "\r\n";
+ $search_str .= ' ' . $where . ' {' . strlen($what) . "}";
+ $sid = sqimap_session_id(true);
+ fputs ($imap_stream, $sid . ' ' . $search_str . "\r\n");
+ $read2 = sqimap_fgets($imap_stream);
+ # server should respond with Ready for argument, then we will send search text
+ #echo "RR2 $read2<br>";
+ fputs ($imap_stream, "$what\r\n");
+ #echo "SS $what<br>";
+ $read2 = sqimap_fgets($imap_stream);
+ #echo "RR2 $read2<br>";
+ $read[]=$read2;
+ $read3 = sqimap_fgets($imap_stream);
+ #echo "RR3 $read3<br>";
+ list($rtag,$response,$message)=explode(' ',$read3,3);
+## $read2 = sqimap_retrieve_imap_response($imap_stream, $sid, true,
+## $response, $message, $search_str, false, true, false);
+ #echo "RR2 $read2 / RESPONSE $response<br>";
}
- /* read data back from IMAP */
- $read = sqimap_run_command($imap, $search_str, true, $response, $message, $uid_support);
-
- // This may have problems with EIMS due to it being goofy
+ if (isset($read[0])) {
+ $ids = array();
+ for ($i = 0, $iCnt = count($read); $i < $iCnt; ++$i) {
+ if (preg_match("/^\* SEARCH (.+)$/", $read[$i], $regs)) {
+ $ids += explode(' ', trim($regs[1]));
+ }
+ }
+ if ($response == 'OK' && count($ids)) {
+ if (sqimap_mailbox_exists($imap_stream, $where_to)) {
+ 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);
+ }
- for ($r=0, $num = count($read); $r < $num &&
- substr($read[$r], 0, 8) != '* SEARCH'; $r++) {}
- if ($response == 'OK') {
- $ids = explode(' ', $read[$r]);
- if (sqimap_mailbox_exists($imap, $where_to)) {
- 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);
+ // 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";
+ if ($response == 'NO') {
+ if (strpos($message,'BADCHARSET') !== false ||
+ strpos($message,'character') !== false) {
+ sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message);
+ } else {
+ sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
+ }
+ } else {
+ sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message);
}
}
}
- return $del_id;
+ 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, $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');
filters_LoadCache();
}
- $run = 0;
+ $run = false;
- foreach ($filters as $Key=> $Value) {
+ foreach ($filters as $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.
- if ($filters_spam_scan != 'new') {
- $read = sqimap_run_command($imap_stream, 'FETCH 1:* (FLAGS BODY.PEEK[HEADER.FIELDS ' .
- '(RECEIVED)])', true, $reponse, $message, $uid_support);
- } else {
- $read = sqimap_run_command($imap_stream, 'SEARCH UNSEEN', true, $reponse, $message, $uid_support);
- 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);
- } 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 ($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 = explode(' ', trim($regs[1]));
+ break;
+ }
}
- $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);
}
}
-
- if (isset($response) && $response != 'OK') {
+ 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;
}
-
- if (strlen($SpamFilters_BulkQuery) > 0) {
- filters_bulkquery($filters_spam_scan, $filters, $read);
+ if (!count($headers)) {
+ return;
}
-
- $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['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 == ' ') {
+ 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)) {
+ 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');
}
- 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
+/**
+ * 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, $SpamFilters_CacheTTL;
foreach ($filters as $key => $value) {
if ($filters[$key]['enabled']) {
if ($filters[$key]['dns']) {
+
+ /**
+ * RFC allows . on end of hostname to force domain lookup to
+ * not use search domain from resolv.conf, i.e. to ensure
+ * search domain isn't used if no hostname is found
+ */
$filter_revip = $d . '.' . $c . '.' . $b . '.' . $a . '.' .
- $filters[$key]['dns'];
+ $filters[$key]['dns'] . '.';
if(!isset($SpamFilters_DNScache[$filter_revip]['L']))
$SpamFilters_DNScache[$filter_revip]['L'] = '';
$SpamFilters_DNScache[$filter_revip]['T'] =
time() + $SpamFilters_CacheTTL;
}
- if ($SpamFilters_DNScache[$filter_revip]['L'] ==
- $filters[$key]['result']) {
+
+ /**
+ * gethostbyname returns ip if resolved, or returns original
+ * host supplied to function if there is no resolution
+ */
+ if ($SpamFilters_DNScache[$filter_revip]['L'] != $filter_revip) {
return 1;
}
}
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];
+ $filters[$i]['what'] = str_replace('###COMMA###', ',', $ary[1]);
$filters[$i]['folder'] = $ary[2];
}
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;
$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';
$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';
_("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/';
- $filters['ORDB']['dns'] = 'relays.ordb.org';
- $filters['ORDB']['result'] = '127.0.0.2';
- $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['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';
$filters['SPAMhaus']['name'] = 'SPAMhaus Lists';
$filters['SPAMhaus']['link'] = 'http://www.spamhaus.org';
$filters['SPAMhaus']['dns'] = 'sbl.spamhaus.org';
- $filters['SPAMhaus']['result'] = '127.0.0.6';
+ $filters['SPAMhaus']['result'] = '127.0.0.2';
$filters['SPAMhaus']['comment'] =
_("FREE - SPAMhaus - A list of well-known SPAM sources.");
$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';
$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';
$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'] = (bool)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 ++;
}
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;
}
}
-/* 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) {
$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') {
}
}
}
-?>
+
+/**
+ * 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";
+}