plugins/filters/spamoptions.php

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