plugins/filters/setup.php

   1 <?php
   2 /**
   3  * Message and Spam Filter Plugin
   4  *
   5  * Copyright (c) 1999-2004 The SquirrelMail Project Team
   6  * Licensed under the GNU GPL. For full terms see the file COPYING.
   7  *
   8  * This plugin filters your inbox into different folders based upon given
   9  * criteria.  It is most useful for people who are subscibed to mailing lists
  10  * to help organize their messages.  The argument stands that filtering is
  11  * not the place of the client, which is why this has been made a plugin for
  12  * SquirrelMail.  You may be better off using products such as Sieve or
  13  * Procmail to do your filtering so it happens even when SquirrelMail isn't
  14  * running.
  15  *
  16  * If you need help with this, or see improvements that can be made, please
  17  * email me directly at the address above.  I definately welcome suggestions
  18  * and comments.  This plugin, as is the case with all SquirrelMail plugins,
  19  * is not directly supported by the developers.  Please come to me off the
  20  * mailing list if you have trouble with it.
  21  *
  22  * Also view plugins/README.plugins for more information.
  23  *
  24  * @version $Id$
  25  * @package plugins
  26  * @subpackage filters
  27  */
  28
  29 /** SquirrelMail required files. */
  30 require_once(SM_PATH . 'plugins/filters/filters.php');
  31
  32 /**
  33  * Imap connection control
  34  *
  35  * Set this to true if you have problems -- check the README file
  36  * Note:  This doesn't work all of the time (No idea why)
  37  *        Seems to be related to UW
  38  * @global bool $UseSeparateImapConnection
  39  */
  40 global $UseSeparateImapConnection;
  41 $UseSeparateImapConnection = false;
  42
  43 /**
  44  * User level spam filters control
  45  *
  46  * Set this to false if you do not want the user to be able to enable
  47  * spam filters
  48  * @global bool $AllowSpamFilters
  49  */
  50 global $AllowSpamFilters;
  51 $AllowSpamFilters = true;
  52
  53 /**
  54  * SpamFilters YourHop Setting
  55  *
  56  * Set this to a string containing something unique to the line in the
  57  * header you want me to find IPs to scan the databases with.  For example,
  58  * All the email coming IN from the internet to my site has a line in
  59  * the header that looks like (all on one line):
  60  * Received: [from usw-sf-list1.sourceforge.net (usw-sf-fw2.sourceforge.net
  61  *    [216.136.171.252]) by firewall.persistence.com (SYSADMIN-antispam
  62  *     0.2) with
  63  * Since this line indicates the FIRST hop the email takes into my network,
  64  * I set my SpamFilters_YourHop to 'by firewall.persistence.com' but any
  65  * case-sensitive string will do.  You can set it to something found on
  66  * every line in the header (like ' ') if you want to scan all IPs in
  67  * the header (lots of false alarms here tho).
  68  * @global string $SpamFilters_YourHop
  69  */
  70 global $SpamFilters_YourHop;
  71 $SpamFilters_YourHop = ' ';
  72
  73 /**
  74  * Commercial Spam Filters Control
  75  *
  76  * Some of the SPAM filters are COMMERCIAL and require a fee. If your users
  77  * select them and you're not allowed to use them, it will make SPAM filtering
  78  * very slow. If you don't want them to even be offered to the users, you
  79  * should set SpamFilters_ShowCommercial to false.
  80  * @global bool $SpamFilters_ShowCommercial
  81  */
  82 global $SpamFilters_ShowCommercial;
  83 $SpamFilters_ShowCommercial = false;
  84
  85 /**
  86  * SpamFiltring Cache
  87  *
  88  * A cache of IPs we've already checked or are known bad boys or good boys
  89  * ie. $SpamFilters_DNScache["210.54.220.18"] = true;
  90  * would tell filters to not even bother doing the DNS queries for that
  91  * IP and any email coming from it are SPAM - false would mean that any
  92  * email coming from it would NOT be SPAM
  93  * @global array $SpamFilters_DNScache
  94  */
  95 global $SpamFilters_DNScache;
  96
  97 /**
  98  * Path to bulkquery program
  99  *
 100  * Absolute path to the bulkquery program. Leave blank if you don't have
 101  * bulkquery compiled, installed, and lwresd running. See the README file
 102  * in the bulkquery directory for more information on using bulkquery.
 103  * @global string $SpamFilters_BulkQuery
 104  */
 105 global $SpamFilters_BulkQuery;
 106 $SpamFilters_BulkQuery = '';
 107
 108 /**
 109  * Shared filtering cache control
 110  *
 111  * Do you want to use a shared file for the DNS cache or a session variable?
 112  * Using a shared file means that every user can benefit from any queries
 113  * made by other users. The shared file is named "dnscache" and is in the
 114  * data directory.
 115  * @global bool $SpamFilters_SharedCache
 116  */
 117 global $SpamFilters_SharedCache;
 118 $SpamFilters_SharedCache = true;
 119
 120 /**
 121  * DNS query TTL
 122  *
 123  * How long should DNS query results be cached for by default (in seconds)?
 124  * @global integer $SpamFilters_CacheTTL
 125  */
 126 global $SpamFilters_CacheTTL;
 127 $SpamFilters_CacheTTL = 7200;
 128
 129 /**
 130  * Init plugin
 131  * @access private
 132  */
 133 function squirrelmail_plugin_init_filters() {
 134     global $squirrelmail_plugin_hooks;
 135
 136     if (sqgetGlobalVar('mailbox',$mailbox,SQ_FORM)) {
 137         sqgetGlobalVar('mailbox',$mailbox,SQ_FORM);
 138     } else {
 139         $mailbox = 'INBOX';
 140     }
 141
 142     $squirrelmail_plugin_hooks['left_main_before']['filters'] = 'start_filters';
 143     if (isset($mailbox) && $mailbox == 'INBOX') {
 144         $squirrelmail_plugin_hooks['right_main_after_header']['filters'] = 'start_filters';
 145     }
 146     $squirrelmail_plugin_hooks['optpage_register_block']['filters'] = 'filters_optpage_register_block';
 147     $squirrelmail_plugin_hooks['special_mailbox']['filters'] = 'filters_special_mailbox';
 148     $squirrelmail_plugin_hooks['rename_or_delete_folder']['filters'] = 'update_for_folder';
 149     $squirrelmail_plugin_hooks['webmail_bottom']['filters'] = 'start_filters';
 150 }
 151
 152 /**
 153  * Report spam folter as special mailbox
 154  * @param string $mb variable used by hook
 155  * @return string spam folder name
 156  * @access private
 157  */
 158 function filters_special_mailbox( $mb ) {
 159     global $data_dir, $username;
 160
 161     return( $mb == getPref($data_dir, $username, 'filters_spam_folder', 'na' ) );
 162
 163 }
 164
 165 /**
 166  * Register option blocks
 167  * @access private
 168  */
 169 function filters_optpage_register_block() {
 170     global $optpage_blocks;
 171     global $AllowSpamFilters;
 172
 173     $optpage_blocks[] = array(
 174         'name' => _("Message Filters"),
 175         'url'  => '../plugins/filters/options.php',
 176         'desc' => _("Filtering enables messages with different criteria to be automatically filtered into different folders for easier organization."),
 177         'js'   => false
 178     );
 179
 180     if ($AllowSpamFilters) {
 181         $optpage_blocks[] = array(
 182             'name' => _("SPAM Filters"),
 183             'url'  => '../plugins/filters/spamoptions.php',
 184             '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)."),
 185             'js'   => false
 186         );
 187     }
 188 }
 189 ?>