plugins/filters/options.php

   1 <?php
   2
   3 /**
   4  * Message and Spam Filter Plugin
   5  *
   6  * Copyright (c) 1999-2004 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This plugin filters your inbox into different folders based upon given
  10  * criteria. It is most useful for people who are subscibed to mailing lists
  11  * to help organize their messages.  The argument stands that filtering is
  12  * not the place of the client, which is why this has been made a plugin for
  13  * SquirrelMail.  You may be better off using products such as Sieve or
  14  * Procmail to do your filtering so it happens even when SquirrelMail isn't
  15  * running.
  16  *
  17  * If you need help with this, or see improvements that can be made, please
  18  * email me directly at the address above.  I definately welcome suggestions
  19  * and comments.  This plugin, as is the case with all SquirrelMail plugins,
  20  * is not directly supported by the developers.  Please come to me off the
  21  * mailing list if you have trouble with it.
  22  *
  23  * Also view plugins/README.plugins for more information.
  24  *
  25  * @version $Id$
  26  * @package plugins
  27  * @subpackage filters
  28  */
  29
  30 /**
  31  * Path for SquirrelMail required files.
  32  * @ignore
  33  */
  34 define('SM_PATH','../../');
  35
  36 /* SquirrelMail required files. */
  37 require_once(SM_PATH . 'include/validate.php');
  38 require_once(SM_PATH . 'functions/page_header.php');
  39 require_once(SM_PATH . 'functions/imap.php');
  40 require_once(SM_PATH . 'functions/imap_mailbox.php');
  41 require_once(SM_PATH . 'include/load_prefs.php');
  42 require_once(SM_PATH . 'plugins/filters/filters.php');
  43
  44 global $AllowSpamFilters;
  45
  46 displayPageHeader($color, 'None');
  47
  48 /* get globals */
  49 sqgetGlobalVar('username', $username, SQ_SESSION);
  50 sqgetGlobalVar('key', $key, SQ_COOKIE);
  51 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
  52 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  53
  54 sqgetGlobalVar('theid', $theid);
  55 sqgetGlobalVar('action', $action, SQ_GET);
  56
  57 // FIXME: use sqgetGlobalVar below.
  58
  59    if (isset($_POST['filter_submit'])) {
  60       if(isset($_GET['theid'])) {
  61           $theid = $_GET['theid'];
  62       } elseif (isset($_POST['theid'])) {
  63           $theid = $_POST['theid'];
  64       } else {
  65           $theid = 0;
  66       }
  67       $filter_what   = $_POST['filter_what'];
  68       $filter_where  = $_POST['filter_where'];
  69       $filter_folder = $_POST['filter_folder'];
  70
  71       $filter_what = str_replace(',', ' ', $filter_what);
  72       $filter_what = str_replace("\\\\", "\\", $filter_what);
  73       $filter_what = str_replace("\\\"", '"', $filter_what);
  74       $filter_what = str_replace('"', '&quot;', $filter_what);
  75
  76       if (($filter_where == 'Header') && (strchr($filter_what,':') == '')) {
  77          print ('WARNING! Header filters should be of the format "Header: value"<BR>');
  78          $action = 'edit';
  79       }
  80       setPref($data_dir, $username, 'filter'.$theid, $filter_where.','.$filter_what.','.$filter_folder);
  81       $filters[$theid]['where'] = $filter_where;
  82       $filters[$theid]['what'] = $filter_what;
  83       $filters[$theid]['folder'] = $filter_folder;
  84    } elseif (isset($action) && $action == 'delete') {
  85       remove_filter($theid);
  86    } elseif (isset($action) && $action == 'move_up') {
  87       filter_swap($theid, $theid - 1);
  88    } elseif (isset($action) && $action == 'move_down') {
  89       filter_swap($theid, $theid + 1);
  90    } elseif (isset($_POST['user_submit'])) {
  91        setPref($data_dir, $username, 'filters_user_scan', $_POST['filters_user_scan_set']);
  92        echo '<br><center><b>'._("Saved Scan type")."</b></center>\n";
  93    }
  94
  95    $filters = load_filters();
  96    $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
  97
  98    echo html_tag( 'table',
  99             html_tag( 'tr',
 100                 html_tag( 'td',
 101                     '<center><b>' . _("Options") . ' -  ' . _("Message Filtering") . '</b></center>' ,
 102                 'left', $color[0] )
 103             ) ,
 104          'center', '', 'width="95%" border="0" cellpadding="2" cellspacing="0"' ) .
 105
 106         '<br><form method=post action="options.php">'.
 107         '<center>'.
 108         html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
 109             html_tag( 'tr' ) .
 110                 html_tag( 'th', _("What to Scan:"), 'right', '', 'nowrap' ) .
 111                 html_tag( 'td', '', 'left' ) .
 112             '<select name="filters_user_scan_set">'.
 113             '<option value=""';
 114     if ($filters_user_scan == '') {
 115         echo ' selected';
 116     }
 117     echo '>' . _("All messages") . '</option>'.
 118             '<option value="new"';
 119     if ($filters_user_scan == 'new') {
 120         echo ' selected';
 121     }
 122     echo '>' . _("Only unread messages") . '</option>' .
 123             '</select>'.
 124         '</td>'.
 125         html_tag( 'td', '<input type=submit name="user_submit" value="' . _("Save") . '">', 'left' ) .
 126         '</table>'.
 127         '</center>'.
 128         '</form>'.
 129
 130         html_tag( 'div', '[<a href="options.php?action=add">' . _("New") .
 131             '</a>] - [<a href="'.SM_PATH.'src/options.php">' . _("Done") . '</a>]' ,
 132         'center' ) . '<br>';
 133
 134     if (isset($action) && ($action == 'add' || $action == 'edit')) {
 135
 136         $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 137         $boxes = sqimap_mailbox_list($imapConnection);
 138         sqimap_logout($imapConnection);
 139         if ( !isset($theid) ) {
 140             $theid = count($filters);
 141         }
 142         echo html_tag( 'div', '', 'center' ) .
 143              '<form action="options.php" method=post>'.
 144              html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
 145              html_tag( 'tr' ) .
 146                 html_tag( 'td', _("Match:"), 'left' ) .
 147                 html_tag( 'td', '', 'left' ) .
 148                     '<select name=filter_where>';
 149
 150         $L = isset($filters[$theid]['where']);
 151
 152         $sel = (($L && $filters[$theid]['where'] == 'From')?'selected':'');
 153         echo "<option value=\"From\" $sel>" . _ ("From") . '</option>';
 154
 155         $sel = (($L && $filters[$theid]['where'] == 'To')?'selected':'');
 156         echo "<option value=\"To\" $sel>" . _ ("To") . '</option>';
 157
 158         $sel = (($L && $filters[$theid]['where'] == 'Cc')?'selected':'');
 159         echo "<option value=\"Cc\" $sel>" . _ ("Cc") . '</option>';
 160
 161         $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?'selected':'');
 162         echo "<option value=\"To or Cc\" $sel>" . _ ("To or Cc") . '</option>';
 163
 164         $sel = (($L && $filters[$theid]['where'] == 'Subject')?'selected':'');
 165         echo "<option value=\"Subject\" $sel>" . _ ("Subject") . '</option>';
 166
 167         $sel = (($L && $filters[$theid]['where'] == 'Header')?'selected':'');
 168         echo "<option value=\"Header\" $sel>" . _ ("Header") . '</option>';
 169
 170         echo         '</select>'.
 171                 '</td>'.
 172             '</tr>'.
 173             html_tag( 'tr' ) .
 174                 html_tag( 'td', _("Contains:"), 'right' ) .
 175                 html_tag( 'td', '', 'left' ) .
 176                     '<input type=text size=32 name=filter_what value="';
 177         if (isset($filters[$theid]['what'])) {
 178             echo $filters[$theid]["what"];
 179         }
 180         echo '">'.
 181                 '</td>'.
 182             '</tr>'.
 183             html_tag( 'tr' ) .
 184                 html_tag( 'td', _("Move to:"), 'left' ) .
 185                 html_tag( 'td', '', 'left' ) .
 186                     '<tt>'.
 187                     '<select name=filter_folder>';
 188         $selected = 0;
 189         if ( isset($filters[$theid]['folder']) )
 190           $selected = array(strtolower($filters[$theid]['folder']));
 191         echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
 192         echo         '</tt>'.
 193                     '</select>'.
 194                 '</td>'.
 195             '</tr>'.
 196             '</table>'.
 197             '<input type=submit name=filter_submit value=' . _("Submit") . '>'.
 198             "<input type=hidden name=theid value=$theid>".
 199             '</form>'.
 200             '</div>';
 201
 202     }
 203
 204         echo html_tag( 'table', '', 'center', '', 'border="0" cellpadding="3" cellspacing="0"' );
 205
 206     for ($i=0, $num = count($filters); $i < $num; $i++) {
 207
 208         $clr = (($i % 2)?$color[0]:$color[9]);
 209         $fdr = ($folder_prefix)?str_replace($folder_prefix, "", $filters[$i]["folder"]):$filters[$i]["folder"];
 210         echo html_tag( 'tr', '', '', $clr ) .
 211                    html_tag( 'td',
 212                        '<small>' .
 213                        "[<a href=\"options.php?theid=$i&action=edit\">" . _("Edit") . '</a>]'.
 214                        '</small>' ,
 215                    'left' ) .
 216                    html_tag( 'td',
 217                        '<small>' .
 218                        "[<a href=\"options.php?theid=$i&action=delete\">" . _("Delete") . '</a>]'.
 219                        '</small>' ,
 220                    'left' ) .
 221                    html_tag( 'td', '', 'center' ) . '<small>[';
 222
 223         if (isset($filters[$i + 1])) {
 224             echo "<a href=\"options.php?theid=$i&action=move_down\">" . _("Down") . '</a>';
 225             if ($i > 0) {
 226                 echo '&nbsp;|&nbsp;';
 227             }
 228         }
 229         if ($i > 0) {
 230             echo "<a href=\"options.php?theid=$i&action=move_up\">" . _("Up") . '</a>';
 231         }
 232         echo ']</small></td>'.
 233             html_tag( 'td', '-', 'left' ) .
 234             html_tag( 'td', '', 'left' );
 235         printf( _("If <b>%s</b> contains <b>%s</b> then move to <b>%s</b>"), $filters[$i]['where'], $filters[$i]['what'], $fdr );
 236         echo '</td></tr>';
 237
 238     }
 239     echo '</table>'.
 240         html_tag( 'table',
 241             html_tag( 'tr',
 242                 html_tag( 'td', '&nbsp;', 'left' )
 243             ) ,
 244         'center', '', 'width="80%" border="0" cellpadding="2" cellspacing="0"' );
 245     echo '</body></html>';
 246 ?>