--- /dev/null
+<?php
+/**
+ * Message and Spam Filter Plugin - Setup script
+ *
+ * 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.
+ *
+ * @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
+ */
+
+/**
+ * Imap connection control
+ *
+ * Set this to true if you have problems -- check the README file
+ * Note: This doesn't work all of the time (No idea why)
+ * Seems to be related to UW
+ * @global bool $UseSeparateImapConnection
+ */
+
+global $UseSeparateImapConnection;
+$UseSeparateImapConnection = false;
+
+/**
+ * User level spam filters control
+ *
+ * Set this to false if you do not want the user to be able to enable
+ * spam filters
+ * @global bool $AllowSpamFilters
+ */
+
+global $AllowSpamFilters;
+$AllowSpamFilters = true;
+
+/**
+ * SpamFilters YourHop Setting
+ *
+ * Set this to a string containing something unique to the line in the
+ * header you want me to find IPs to scan the databases with. For example,
+ * All the email coming IN from the internet to my site has a line in
+ * the header that looks like (all on one line):
+ * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
+ * [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
+ * 0.2) with
+ * Since this line indicates the FIRST hop the email takes into my network,
+ * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
+ * case-sensitive string will do. You can set it to something found on
+ * every line in the header (like ' ') if you want to scan all IPs in
+ * the header (lots of false alarms here tho).
+ * @global string $SpamFilters_YourHop
+ */
+
+global $SpamFilters_YourHop;
+$SpamFilters_YourHop = ' ';
+
+/**
+ * Commercial Spam Filters Control
+ *
+ * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
+ * select them and you're not allowed to use them, it will make SPAM filtering
+ * very slow. If you don't want them to even be offered to the users, you
+ * should set SpamFilters_ShowCommercial to false.
+ * @global bool $SpamFilters_ShowCommercial
+ */
+
+global $SpamFilters_ShowCommercial;
+$SpamFilters_ShowCommercial = false;
+
+/**
+ * SpamFiltring Cache
+ *
+ * A cache of IPs we've already checked or are known bad boys or good boys
+ * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
+ * would tell filters to not even bother doing the DNS queries for that
+ * IP and any email coming from it are SPAM - false would mean that any
+ * email coming from it would NOT be SPAM
+ * @global array $SpamFilters_DNScache
+ */
+
+global $SpamFilters_DNScache;
+
+/**
+ * Path to bulkquery program
+ *
+ * Absolute path to the bulkquery program. Leave blank if you don't have
+ * bulkquery compiled, installed, and lwresd running. See the README file
+ * in the bulkquery directory for more information on using bulkquery.
+ * @global string $SpamFilters_BulkQuery
+ */
+
+global $SpamFilters_BulkQuery;
+$SpamFilters_BulkQuery = '';
+
+/**
+ * Shared filtering cache control
+ *
+ * Do you want to use a shared file for the DNS cache or a session variable?
+ * Using a shared file means that every user can benefit from any queries
+ * made by other users. The shared file is named "dnscache" and is in the
+ * data directory.
+ * @global bool $SpamFilters_SharedCache
+ */
+
+global $SpamFilters_SharedCache;
+$SpamFilters_SharedCache = true;
+
+/**
+ * DNS query TTL
+ *
+ * How long should DNS query results be cached for by default (in seconds)?
+ * @global integer $SpamFilters_CacheTTL
+ */
+
+global $SpamFilters_CacheTTL;
+$SpamFilters_CacheTTL = 7200;
+
+?>
\ No newline at end of file
* 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
+ * email me directly at the address above. I definitely 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.
* @subpackage filters
*/
+@include_once (SM_PATH . 'plugins/filters/config.php');
+
/**
- * FIXME: Undocumented function
+ * 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';
+ }
+
+ $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';
+}
+
+/**
+ * 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
+ );
+ }
+}
+
+/**
+ * Saves the DNS Cache to disk
* @access private
*/
function filters_SaveCache () {
$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";
}
/**
- * FIXME: Undocumented function
+ * Loads the DNS Cache from disk
* @access private
*/
function filters_LoadCache () {
$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);
}
}
}
/**
- * FIXME: Undocumented function
+ * 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) {
}
/**
- * FIXME: Undocumented function
+ * 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);
}
/**
- * FIXME: Undocumented function
+ * Does the loop through each filter
+ * @param stream imap_stream the stream to read from
* @access private
*/
function user_filters($imap_stream) {
}
/**
- * FIXME: Undocumented function
+ * 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,
return array();
}
-
if ($user_scan == 'new') {
$category = 'UNSEEN';
} else {
$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) {
+ for ($i = 0, $iCnt = count($read); $i < $iCnt; ++$i) {
if (preg_match("/^\* SEARCH (.+)$/", $read[$i], $regs)) {
$ids = preg_split("/ /", trim($regs[1]));
break;
}
/**
- * FIXME: Undocumented function
+ * 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) {
$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) {
+ for ($i = 0, $iCnt = count($read); $i < $iCnt; ++$i) {
if (preg_match("/^\* SEARCH (.+)$/", $read[$i], $regs)) {
$search_array = preg_split("/ /", trim($regs[1]));
break;
}
/**
- * FIXME: Undocumented function
* 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) {
}
/**
- * FIXME: Undocumented function
+ * 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];
}
/**
- * FIXME: Undocumented function
+ * Loads the Spam Filters and checks the preferences for the enabled status
+ * @return array All the spam filters
* @access private
*/
function load_spam_filters() {
_("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;
}
/**
- * FIXME: Undocumented function
+ * 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 ++;
}
}
/**
- * FIXME: Undocumented function
+ * 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) {
}
/**
- * 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];
+ $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') {
echo $string;
echo "</font></p>\n";
}
-?>
+
+?>
\ No newline at end of file
/* SquirrelMail required files. */
require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/page_header.php');
require_once(SM_PATH . 'functions/imap.php');
-require_once(SM_PATH . 'functions/imap_mailbox.php');
-require_once(SM_PATH . 'include/load_prefs.php');
-require_once(SM_PATH . 'functions/forms.php');
require_once(SM_PATH . 'plugins/filters/filters.php');
+if (!file_exists(SM_PATH . 'plugins/filters/config.php')) return;
+@include_once (SM_PATH . 'plugins/filters/config.php');
+
global $AllowSpamFilters;
displayPageHeader($color, 'None');
<?php
/**
- * Message and Spam Filter Plugin - Setup script
- *
- * 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.
- *
* @version $Id$
* @copyright (c) 1999-2005 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @subpackage filters
*/
-/** SquirrelMail required files. */
-require_once(SM_PATH . 'plugins/filters/filters.php');
-
-/**
- * Imap connection control
- *
- * Set this to true if you have problems -- check the README file
- * Note: This doesn't work all of the time (No idea why)
- * Seems to be related to UW
- * @global bool $UseSeparateImapConnection
- */
-global $UseSeparateImapConnection;
-$UseSeparateImapConnection = false;
-
-/**
- * User level spam filters control
- *
- * Set this to false if you do not want the user to be able to enable
- * spam filters
- * @global bool $AllowSpamFilters
- */
-global $AllowSpamFilters;
-$AllowSpamFilters = true;
-
-/**
- * SpamFilters YourHop Setting
- *
- * Set this to a string containing something unique to the line in the
- * header you want me to find IPs to scan the databases with. For example,
- * All the email coming IN from the internet to my site has a line in
- * the header that looks like (all on one line):
- * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
- * [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
- * 0.2) with
- * Since this line indicates the FIRST hop the email takes into my network,
- * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
- * case-sensitive string will do. You can set it to something found on
- * every line in the header (like ' ') if you want to scan all IPs in
- * the header (lots of false alarms here tho).
- * @global string $SpamFilters_YourHop
- */
-global $SpamFilters_YourHop;
-$SpamFilters_YourHop = ' ';
-
-/**
- * Commercial Spam Filters Control
- *
- * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
- * select them and you're not allowed to use them, it will make SPAM filtering
- * very slow. If you don't want them to even be offered to the users, you
- * should set SpamFilters_ShowCommercial to false.
- * @global bool $SpamFilters_ShowCommercial
- */
-global $SpamFilters_ShowCommercial;
-$SpamFilters_ShowCommercial = false;
-
-/**
- * SpamFiltring Cache
- *
- * A cache of IPs we've already checked or are known bad boys or good boys
- * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
- * would tell filters to not even bother doing the DNS queries for that
- * IP and any email coming from it are SPAM - false would mean that any
- * email coming from it would NOT be SPAM
- * @global array $SpamFilters_DNScache
- */
-global $SpamFilters_DNScache;
-
-/**
- * Path to bulkquery program
- *
- * Absolute path to the bulkquery program. Leave blank if you don't have
- * bulkquery compiled, installed, and lwresd running. See the README file
- * in the bulkquery directory for more information on using bulkquery.
- * @global string $SpamFilters_BulkQuery
- */
-global $SpamFilters_BulkQuery;
-$SpamFilters_BulkQuery = '';
-
-/**
- * Shared filtering cache control
- *
- * Do you want to use a shared file for the DNS cache or a session variable?
- * Using a shared file means that every user can benefit from any queries
- * made by other users. The shared file is named "dnscache" and is in the
- * data directory.
- * @global bool $SpamFilters_SharedCache
- */
-global $SpamFilters_SharedCache;
-$SpamFilters_SharedCache = true;
-
-/**
- * DNS query TTL
- *
- * How long should DNS query results be cached for by default (in seconds)?
- * @global integer $SpamFilters_CacheTTL
- */
-global $SpamFilters_CacheTTL;
-$SpamFilters_CacheTTL = 7200;
-
/**
* Init plugin
* @access private
*/
function squirrelmail_plugin_init_filters() {
- global $squirrelmail_plugin_hooks;
-
- if (sqgetGlobalVar('mailbox',$mailbox,SQ_FORM)) {
- sqgetGlobalVar('mailbox',$mailbox,SQ_FORM);
- } else {
- $mailbox = 'INBOX';
- }
-
- $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
- if (isset($mailbox) && $mailbox == 'INBOX') {
- $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
- }
- $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'filters_optpage_register_block';
- $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
- $squirrelmail_plugin_hooks['rename_or_delete_folder']['filters'] = 'update_for_folder';
- $squirrelmail_plugin_hooks['webmail_bottom']['filters'] = 'start_filters';
+ @include_once(SM_PATH . 'plugins/filters/filters.php');
+ filters_init_hooks ();
}
/**
*/
function filters_special_mailbox( $mb ) {
global $data_dir, $username;
-
return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
-
}
/**
- * Register option blocks
+ * Called by hook to Register option blocks
* @access private
*/
-function filters_optpage_register_block() {
- global $optpage_blocks;
- global $AllowSpamFilters;
+function filters_optpage_register_block_hook() {
+ @include_once(SM_PATH . 'plugins/filters/filters.php');
+ filters_optpage_register_block ();
+}
- $optpage_blocks[] = array(
- 'name' => _("Message Filters"),
- 'url' => '../plugins/filters/options.php',
- 'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
- 'js' => false
- );
+/**
+ * Called by hook to Start Filtering
+ * @param mixed $args optional variable passed by hook
+ * @access private
+ */
+function start_filters_hook($args) {
+ @include_once(SM_PATH . 'plugins/filters/filters.php');
+ start_filters ();
+}
- if ($AllowSpamFilters) {
- $optpage_blocks[] = array(
- 'name' => _("SPAM Filters"),
- 'url' => '../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
- );
- }
+/**
+ * Called by hook to Update filters when Folders Change
+ * @access private
+ */
+function update_for_folder_hook() {
+ @include_once(SM_PATH . 'plugins/filters/filters.php');
+ update_for_folder ();
}
+
?>
\ No newline at end of file
projects / squirrelmail.git / commitdiff