plugins/filters/spamoptions.php

   1 <?php
   2 /**
   3  * Message and Spam Filter Plugin
   4  *
   5  * Copyright (c) 1999-2002 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  * $Id$
  25  */
  26
  27 /* Path for SquirrelMail required files. */
  28 define('SM_PATH','../../');
  29
  30 /* SquirrelMail required files. */
  31 require_once(SM_PATH . 'include/validate.php');
  32 require_once(SM_PATH . 'functions/page_header.php');
  33 require_once(SM_PATH . 'functions/imap.php');
  34 require_once(SM_PATH . 'include/load_prefs.php');
  35 require_once(SM_PATH . 'functions/html.php');
  36 require_once(SM_PATH . 'plugins/filters/filters.php');
  37 global $AllowSpamFilters;
  38
  39 $username = $_SESSION['username'];
  40 $key = $_COOKIE['key'];
  41 $onetimepad = $_SESSION['onetimepad'];
  42 $delimiter = $_SESSION['delimiter'];
  43
  44 if (isset($_GET['action'])) {
  45     $action = $_GET['action'];
  46 }
  47
  48 displayPageHeader($color, 'None');
  49
  50 if (isset($_POST['spam_submit'])) {
  51     $spam_filters = load_spam_filters();
  52     setPref($data_dir, $username, 'filters_spam_folder', $_POST['filters_spam_folder_set']);
  53     setPref($data_dir, $username, 'filters_spam_scan', $_POST['filters_spam_scan_set']);
  54     foreach ($spam_filters as $Key => $Value) {
  55         $input = $spam_filters[$Key]['prefname'] . '_set';
  56         if ( isset( $_POST[$input] ) ) {
  57             setPref( $data_dir, $username, $spam_filters[$Key]['prefname'],
  58                      $_POST[$input]);
  59         } else {
  60             removePref($data_dir, $username, $spam_filters[$Key]['prefname']);
  61         }
  62     }
  63 }
  64
  65 $filters_spam_folder = getPref($data_dir, $username, 'filters_spam_folder');
  66 $filters_spam_scan = getPref($data_dir, $username, 'filters_spam_scan');
  67 $filters = load_filters();
  68
  69 echo html_tag( 'table',
  70             html_tag( 'tr',
  71                 html_tag( 'th', _("Spam Filtering"), 'center' )
  72             ) ,
  73         'center', $color[0], 'width="95%" border="0" cellpadding="2" cellspacing="0"' );
  74
  75 if ($SpamFilters_YourHop == ' ') {
  76     echo '<br>' .
  77         html_tag( 'div', '<b>' .
  78             _("WARNING! Tell your admin to set the SpamFilters_YourHop variable") .
  79             '</b>' ,
  80         'center' ) .
  81         '<br>';
  82 }
  83
  84
  85 if (isset($action) && $action == 'spam') {
  86     $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
  87     $boxes = sqimap_mailbox_list($imapConnection);
  88     sqimap_logout($imapConnection);
  89     for ($i = 0; $i < count($boxes) && $filters_spam_folder == ''; $i++) {
  90         if ((isset($boxes[$i]['flags'][0]) && $boxes[$i]['flags'][0] != 'noselect') &&
  91             (isset($boxes[$i]['flags'][1]) && $boxes[$i]['flags'][1] != 'noselect') &&
  92             (isset($boxes[$i]['flags'][2]) && $boxes[$i]['flags'][2] != 'noselect')) {
  93             $filters_spam_folder = $boxes[$i]['unformatted'];
  94         }
  95     }
  96
  97     echo '<form method=post action="spamoptions.php">'.
  98         '<center>'.
  99         html_tag( 'table', '', '', '', 'width="85%" border="0" cellpadding="2" cellspacing="0"' ) .
 100             html_tag( 'tr' ) .
 101                 html_tag( 'th', _("Move spam to:"), 'right', '', 'nowrap' ) .
 102                 html_tag( 'td', '', 'left' ) .
 103                     '<select name="filters_spam_folder_set">';
 104
 105     for ($i = 0; $i < count($boxes); $i++) {
 106         if (! in_array('noselect', $boxes[$i]['flags'])) {
 107             $box = $boxes[$i]['unformatted'];
 108             $box2 = str_replace(' ', '&nbsp;', $boxes[$i]['formatted']);
 109             if ($filters_spam_folder == $box) {
 110                 echo "<OPTION VALUE=\"$box\" SELECTED>$box2</OPTION>\n";
 111             } else {
 112                 echo "<OPTION VALUE=\"$box\">$box2</OPTION>\n";
 113             }
 114         }
 115     }
 116     echo    '</select>'.
 117         '</td>'.
 118         '</tr>'.
 119         html_tag( 'tr',
 120             html_tag( 'td', '&nbsp;' ) .
 121             html_tag( 'td',
 122                 _("Moving spam directly to the trash may not be a good idea at first, since messages from friends and mailing lists might accidentally be marked as spam. Whatever folder you set this to, make sure that it gets cleaned out periodically, so that you don't have an excessively large mailbox hanging around.") ,
 123             'left' )
 124         ) .
 125         html_tag( 'tr' ) .
 126             html_tag( 'th', _("What to Scan:"), 'right', '', 'nowrap' ) .
 127             html_tag( 'td' ) .
 128             '<select name="filters_spam_scan_set">'.
 129             '<option value=""';
 130     if ($filters_spam_scan == '') {
 131         echo ' SELECTED';
 132     }
 133     echo '>' . _("All messages") . '</option>'.
 134             '<option value="new"';
 135     if ($filters_spam_scan == 'new') {
 136         echo ' SELECTED';
 137     }
 138     echo '>' . _("Only unread messages") . '</option>' .
 139             '</select>'.
 140         '</td>'.
 141     '</tr>'.
 142     html_tag( 'tr',
 143           html_tag( 'td', '&nbsp;' ) .
 144           html_tag( 'td',
 145               _("The more messages you scan, the longer it takes.  I would suggest that you scan only new messages.  If you make a change to your filters, I would set it to scan all messages, then go view my INBOX, then come back and set it to scan only new messages.  That way, your new spam filters will be applied and you'll scan even the spam you read with the new filters.") ,
 146           'left' )
 147       );
 148
 149     $spam_filters = load_spam_filters();
 150
 151     foreach ($spam_filters as $Key => $Value) {
 152         echo html_tag( 'tr' ) .
 153                    html_tag( 'th', $Key, 'right', '', 'nowrap' ) ."\n" .
 154                    html_tag( 'td' ) .
 155             '<input type=checkbox name="' .
 156             $spam_filters[$Key]['prefname'] .
 157             '_set"';
 158         if ($spam_filters[$Key]['enabled']) {
 159             echo ' CHECKED';
 160         }
 161         echo '> - ';
 162         if ($spam_filters[$Key]['link']) {
 163             echo '<a href="' .
 164                  $spam_filters[$Key]['link'] .
 165                  '" target="_blank">';
 166         }
 167         echo $spam_filters[$Key]['name'];
 168         if ($spam_filters[$Key]['link']) {
 169             echo '</a>';
 170         }
 171         echo '</td></tr>' .
 172         html_tag( 'tr',
 173             html_tag( 'td', '&nbsp;' ) .
 174             html_tag( 'td', $spam_filters[$Key]['comment'], 'left' )
 175         ) . "\n";
 176
 177     }
 178     echo html_tag( 'tr',
 179         html_tag( 'td', '<input type=submit name="spam_submit" value="' . _("Save") . '">', 'center', '', 'colspan="2"' )
 180     ) . "\n" .
 181         '</table>'.
 182         '</center>'.
 183         '</form>';
 184
 185 }
 186
 187 if (! isset($_GET['action']) || $_GET['action'] != 'spam') {
 188
 189     echo html_tag( 'p', '', 'center' ) .
 190          '[<a href="spamoptions.php?action=spam">' . _("Edit") . '</a>]' .
 191          ' - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br><br>';
 192     printf( _("Spam is sent to <b>%s</b>"), ($filters_spam_folder?$filters_spam_folder:_("[<i>not set yet</i>]") ) );
 193     echo '<br>';
 194     printf( _("Spam scan is limited to <b>%s</b>"), (($filters_spam_scan == 'new')?_("New Messages Only"):_("All Messages") ) );
 195     echo '</p>'.
 196         "<table border=0 cellpadding=3 cellspacing=0 align=center bgcolor=\"$color[0]\">";
 197
 198     $spam_filters = load_spam_filters();
 199
 200     foreach ($spam_filters as $Key => $Value) {
 201         echo html_tag( 'tr' ) .
 202                     html_tag( 'th', '', 'center' );
 203
 204         if ($spam_filters[$Key]['enabled']) {
 205             echo _("ON");
 206         } else {
 207             echo _("OFF");
 208         }
 209
 210         echo '</th>' .
 211                html_tag( 'td', '&nbsp;-&nbsp;', 'left' ) .
 212                html_tag( 'td', '', 'left' );
 213
 214         if ($spam_filters[$Key]['link']) {
 215         echo '<a href="' .
 216             $spam_filters[$Key]['link'] .
 217             '" target="_blank">';
 218         }
 219
 220         echo $spam_filters[$Key]['name'];
 221         if ($spam_filters[$Key]['link']) {
 222         echo '</a>';
 223         }
 224         echo "</td></tr>\n";
 225     }
 226     echo '</table>';
 227 }
 228
 229 ?>