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