plugins/filters/options.php

   1 <?php
   2
   3 /**
   4  * Message and Spam Filter Plugin
   5  *
   6  * Copyright (c) 1999-2003 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  * $Id$
  26  */
  27
  28 /* Path for SquirrelMail required files. */
  29 define('SM_PATH','../../');
  30
  31 /* SquirrelMail required files. */
  32 require_once(SM_PATH . 'include/validate.php');
  33 require_once(SM_PATH . 'functions/page_header.php');
  34 require_once(SM_PATH . 'functions/imap.php');
  35 require_once(SM_PATH . 'functions/imap_mailbox.php');
  36 require_once(SM_PATH . 'include/load_prefs.php');
  37 require_once(SM_PATH . 'plugins/filters/filters.php');
  38
  39 global $AllowSpamFilters;
  40
  41 displayPageHeader($color, 'None');
  42
  43 /* get globals */
  44 sqgetGlobalVar('username', $username, SQ_SESSION);
  45 sqgetGlobalVar('key', $key, SQ_COOKIE);
  46 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
  47 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
  48
  49 sqgetGlobalVar('theid', $theid);
  50 sqgetGlobalVar('action', $action, SQ_GET);
  51
  52 // FIXME: use sqgetGlobalVar below.
  53
  54    if (isset($_POST['filter_submit'])) {
  55       if(isset($_GET['theid'])) {
  56           $theid = $_GET['theid'];
  57       } elseif (isset($_POST['theid'])) {
  58           $theid = $_POST['theid'];
  59       } else {
  60           $theid = 0;
  61       }
  62       $filter_what   = $_POST['filter_what'];
  63       $filter_where  = $_POST['filter_where'];
  64       $filter_folder = $_POST['filter_folder'];
  65
  66       $filter_what = str_replace(',', ' ', $filter_what);
  67       $filter_what = str_replace("\\\\", "\\", $filter_what);
  68       $filter_what = str_replace("\\\"", '"', $filter_what);
  69       $filter_what = str_replace('"', '&quot;', $filter_what);
  70
  71       if (($filter_where == 'Header') && (strchr($filter_what,':') == '')) {
  72          print ('WARNING! Header filters should be of the format "Header: value"<BR>');
  73          $action = 'edit';
  74       }
  75       setPref($data_dir, $username, 'filter'.$theid, $filter_where.','.$filter_what.','.$filter_folder);
  76       $filters[$theid]['where'] = $filter_where;
  77       $filters[$theid]['what'] = $filter_what;
  78       $filters[$theid]['folder'] = $filter_folder;
  79    } elseif (isset($action) && $action == 'delete') {
  80       remove_filter($theid);
  81    } elseif (isset($action) && $action == 'move_up') {
  82       filter_swap($theid, $theid - 1);
  83    } elseif (isset($action) && $action == 'move_down') {
  84       filter_swap($theid, $theid + 1);
  85    } elseif (isset($_POST['user_submit'])) {
  86        setPref($data_dir, $username, 'filters_user_scan', $_POST['filters_user_scan_set']);
  87        echo '<br><center><b>'._("Saved Scan type")."</b></center>\n";
  88    }
  89
  90    $filters = load_filters();
  91    $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
  92
  93    echo html_tag( 'table',
  94             html_tag( 'tr',
  95                 html_tag( 'td',
  96                     '<center><b>' . _("Options") . ' -  ' . _("Message Filtering") . '</b></center>' ,
  97                 'left', $color[0] )
  98             ) ,
  99          'center', '', 'width="95%" border="0" cellpadding="2" cellspacing="0"' ) .
 100
 101         '<br><form method=post action="options.php">'.
 102         '<center>'.
 103         html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
 104             html_tag( 'tr' ) .
 105                 html_tag( 'th', _("What to Scan:"), 'right', '', 'nowrap' ) .
 106                 html_tag( 'td', '', 'left' ) .
 107             '<select name="filters_user_scan_set">'.
 108             '<option value=""';
 109     if ($filters_user_scan == '') {
 110         echo ' selected';
 111     }
 112     echo '>' . _("All messages") . '</option>'.
 113             '<option value="new"';
 114     if ($filters_user_scan == 'new') {
 115         echo ' selected';
 116     }
 117     echo '>' . _("Only unread messages") . '</option>' .
 118             '</select>'.
 119         '</td>'.
 120         html_tag( 'td', '<input type=submit name="user_submit" value="' . _("Save") . '">', 'left' ) .
 121         '</table>'.
 122         '</center>'.
 123         '</form>'.
 124
 125         html_tag( 'div', '[<a href="options.php?action=add">' . _("New") .
 126             '</a>] - [<a href="'.SM_PATH.'src/options.php">' . _("Done") . '</a>]' ,
 127         'center' ) . '<br>';
 128
 129     if (isset($action) && ($action == 'add' || $action == 'edit')) {
 130
 131         $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 132         $boxes = sqimap_mailbox_list($imapConnection);
 133         sqimap_logout($imapConnection);
 134         if ( !isset($theid) ) {
 135             $theid = count($filters);
 136         }
 137         echo html_tag( 'div', '', 'center' ) .
 138              '<form action="options.php" method=post>'.
 139              html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
 140              html_tag( 'tr' ) .
 141                 html_tag( 'td', _("Match:"), 'left' ) .
 142                 html_tag( 'td', '', 'left' ) .
 143                     '<select name=filter_where>';
 144
 145         $L = isset($filters[$theid]['where']);
 146
 147         $sel = (($L && $filters[$theid]['where'] == 'From')?'selected':'');
 148         echo "<option value=\"From\" $sel>" . _ ("From") . '</option>';
 149
 150         $sel = (($L && $filters[$theid]['where'] == 'To')?'selected':'');
 151         echo "<option value=\"To\" $sel>" . _ ("To") . '</option>';
 152
 153         $sel = (($L && $filters[$theid]['where'] == 'Cc')?'selected':'');
 154         echo "<option value=\"Cc\" $sel>" . _ ("Cc") . '</option>';
 155
 156         $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?'selected':'');
 157         echo "<option value=\"To or Cc\" $sel>" . _ ("To or Cc") . '</option>';
 158
 159         $sel = (($L && $filters[$theid]['where'] == 'Subject')?'selected':'');
 160         echo "<option value=\"Subject\" $sel>" . _ ("Subject") . '</option>';
 161
 162         $sel = (($L && $filters[$theid]['where'] == 'Header')?'selected':'');
 163         echo "<option value=\"Header\" $sel>" . _ ("Header") . '</option>';
 164
 165         echo         '</select>'.
 166                 '</td>'.
 167             '</tr>'.
 168             html_tag( 'tr' ) .
 169                 html_tag( 'td', _("Contains:"), 'right' ) .
 170                 html_tag( 'td', '', 'left' ) .
 171                     '<input type=text size=32 name=filter_what value="';
 172         if (isset($filters[$theid]['what'])) {
 173             echo $filters[$theid]["what"];
 174         }
 175         echo '">'.
 176                 '</td>'.
 177             '</tr>'.
 178             html_tag( 'tr' ) .
 179                 html_tag( 'td', _("Move to:"), 'left' ) .
 180                 html_tag( 'td', '', 'left' ) .
 181                     '<tt>'.
 182                     '<select name=filter_folder>';
 183         $selected = 0;
 184         if ( isset($filters[$theid]['folder']) )
 185           $selected = array(strtolower($filters[$theid]['folder']));
 186         echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
 187         echo         '</tt>'.
 188                     '</select>'.
 189                 '</td>'.
 190             '</tr>'.
 191             '</table>'.
 192             '<input type=submit name=filter_submit value=' . _("Submit") . '>'.
 193             "<input type=hidden name=theid value=$theid>".
 194             '</form>'.
 195             '</div>';
 196
 197     }
 198
 199         echo html_tag( 'table', '', 'center', '', 'border="0" cellpadding="3" cellspacing="0"' );
 200
 201     for ($i=0, $num = count($filters); $i < $num; $i++) {
 202
 203         $clr = (($i % 2)?$color[0]:$color[9]);
 204         $fdr = ($folder_prefix)?str_replace($folder_prefix, "", $filters[$i]["folder"]):$filters[$i]["folder"];
 205         echo html_tag( 'tr', '', '', $clr ) .
 206                    html_tag( 'td',
 207                        '<small>' .
 208                        "[<a href=\"options.php?theid=$i&action=edit\">" . _("Edit") . '</a>]'.
 209                        '</small>' ,
 210                    'left' ) .
 211                    html_tag( 'td',
 212                        '<small>' .
 213                        "[<a href=\"options.php?theid=$i&action=delete\">" . _("Delete") . '</a>]'.
 214                        '</small>' ,
 215                    'left' ) .
 216                    html_tag( 'td', '', 'center' ) . '<small>[';
 217
 218         if (isset($filters[$i + 1])) {
 219             echo "<a href=\"options.php?theid=$i&action=move_down\">" . _("Down") . '</a>';
 220             if ($i > 0) {
 221                 echo '&nbsp;|&nbsp;';
 222             }
 223         }
 224         if ($i > 0) {
 225             echo "<a href=\"options.php?theid=$i&action=move_up\">" . _("Up") . '</a>';
 226         }
 227         echo ']</small></td>'.
 228             html_tag( 'td', '-', 'left' ) .
 229             html_tag( 'td', '', 'left' );
 230         printf( _("If <b>%s</b> contains <b>%s</b> then move to <b>%s</b>"), _($filters[$i]['where']), $filters[$i]['what'], $fdr );
 231         echo '</td></tr>';
 232
 233     }
 234     echo '</table>'.
 235         html_tag( 'table',
 236             html_tag( 'tr',
 237                 html_tag( 'td', '&nbsp;', 'left' )
 238             ) ,
 239         'center', '', 'width="80%" border="0" cellpadding="2" cellspacing="0"' );
 240 ?>