<?php
-
/**
- * Message and Spam Filter Plugin
- *
- * Copyright (c) 1999-2003 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-2005 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;
fclose($fp);
}
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
function filters_LoadCache () {
global $data_dir, $SpamFilters_DNScache;
}
}
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
function filters_bulkquery($filters, $IPs) {
- global $SpamFilters_YourHop, $attachment_dir, $username,
+ global $attachment_dir, $username,
$SpamFilters_DNScache, $SpamFilters_BulkQuery,
$SpamFilters_CacheTTL;
}
}
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
function start_filters() {
- global $mailbox, $imapServerAddress, $imapPort, $imap,
- $imap_general, $filters, $imap_stream, $imapConnection,
+ global $imapServerAddress, $imapPort, $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;
- }
-
- if (sqimap_get_num_messages($stream, 'INBOX') > 0) {
- // Filter spam from inbox before we sort them into folders
- if ($AllowSpamFilters) {
- spam_filters($stream);
- }
+ // 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);
+ }
}
+/**
+ * FIXME: Undocumented function
+ * @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, $num = count($filters); $i < $num; $i++) {
}
}
-function filter_search_and_delete($imap_stream, $where, $what, $where_to, $user_scan,
+/**
+ * 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,
- $uid_support, $imap_server_type;
+ global $languages, $squirrelmail_language, $allow_charset_search, $imap_server_type;
+
+ if (strtolower($where_to) == 'inbox') {
+ return array();
+ }
+
+
if ($user_scan == 'new') {
$category = 'UNSEEN';
} else {
$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;
} else {
- $search_str .= ' ' . $where . ' {' . strlen($what) . "}\r\n"
+ $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, $uid_support);
-
- // This may have problems with EIMS due to it being goofy
-
- 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_stream, $where_to)) {
- $del_id = array();
- for ($j=2, $num = count($ids); $j < $num; $j++) {
- $id = trim($ids[$j]);
- if (is_numeric($id)) {
- $del_id[] = $id;
- }
+ $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 (count($del_id)) {
- $should_expunge = true;
- sqimap_msgs_list_move ($imap_stream, $del_id, $where_to);
- // sqimap_mailbox_expunge($imap_stream, 'INBOX');
+ }
+ 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);
}
}
}
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;
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.
-
- // MGK, removed FLAGS from query. It wasn't used.
- if ($filters_spam_scan != 'new') {
- $query = 'FETCH 1:* (BODY.PEEK[HEADER.FIELDS (Received)])';
- } else {
- $read = sqimap_run_command($imap_stream, 'SEARCH UNSEEN', true, $response, $message, $uid_support);
- if ($response != 'OK' || trim($read[0]) == '* SEARCH') {
- $query = 'FETCH 1:* (BODY.PEEK[HEADER.FIELDS (RECEIVED)])';
- } else {
- if (isset($read[0])) {
- if (preg_match("/^\* SEARCH (.+)$/", $read[0], $regs)) {
+
+ 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;
}
}
- $msgs_str = sqimap_message_list_squisher($search_array);
- $query = 'FETCH ' . $msgs_str . ' (BODY.PEEK[HEADER.FIELDS (RECEIVED)])';
- }
+ }
+ }
+ 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;
}
- $headers = filter_get_headers ($imap_stream, $query);
- if (!$headers) {
+ if (!count($headers)) {
return;
}
-
$bulkquery = (strlen($SpamFilters_BulkQuery) > 0 ? true : false);
$IPs = array();
$aSpamIds = array();
foreach ($headers as $id => $aValue) {
- if (isset($aValue['UID'])) {
+ if (isset($aValue['UID'])) {
$MsgNum = $aValue['UID'];
} else {
$MsgNum = $id;
}
// Look through all of the Received headers for IP addresses
- if (isset($aValue['HEADER']['Received'])) {
- foreach ($aValue['HEADER']['Received'] as $received) {
+ if (isset($aValue['RECEIVED'])) {
+ foreach ($aValue['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.
+
+ // $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;
}
}
-// 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) {
return 0;
}
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
function load_filters() {
global $data_dir, $username;
return $filters;
}
+/**
+ * FIXME: Undocumented function
+ * @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';
$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 percent 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';
return $filters;
}
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
function remove_filter ($id) {
global $data_dir, $username;
removePref($data_dir, $username, 'filter' . $id);
}
+/**
+ * FIXME: Undocumented function
+ * @access private
+ */
function filter_swap($id1, $id2) {
global $data_dir, $username;
}
}
-/* 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];
$action = $args[1];
- global $plugins, $data_dir, $username;
+ global $data_dir, $username;
$filters = array();
$filters = load_filters();
$filter_count = count($filters);
}
}
}
-/*
- * Function extracted from sqimap_get_small_header_list.
- * The unused FETCH arguments and HEADERS are disabled.
+
+/**
+ * Display formated error message
+ * @param string $string text message
+ * @return string html formated text message
+ * @access private
*/
-function filter_get_headers ($imap_stream, $query) {
- global $uid_support;
- /* Get the small headers for each message in $msg_list */
-
- $read_list = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, $uid_support);
-
- 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;
+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
+?>
projects / squirrelmail.git / blobdiff