phpDocumentor updates
[squirrelmail.git] / plugins / filters / options.php
1 <?php
2
3 /**
4 * Message and Spam Filter Plugin - Filtering Options
5 *
6 * @copyright &copy; 1999-2005 The SquirrelMail Project Team
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
8 * @version $Id$
9 * @package plugins
10 * @subpackage filters
11 */
12
13 /**
14 * Path for SquirrelMail required files.
15 * @ignore
16 */
17 define('SM_PATH','../../');
18
19 /* SquirrelMail required files. */
20 require_once(SM_PATH . 'include/validate.php');
21 include_once(SM_PATH . 'functions/imap.php');
22 include_once(SM_PATH . 'plugins/filters/filters.php');
23
24 displayPageHeader($color, 'None');
25
26 /* get globals */
27 sqgetGlobalVar('username', $username, SQ_SESSION);
28 sqgetGlobalVar('key', $key, SQ_COOKIE);
29 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
30 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
31
32 sqgetGlobalVar('theid', $theid);
33 sqgetGlobalVar('action', $action, SQ_GET);
34
35 if (sqgetGlobalVar('filter_submit',$filter_submit,SQ_POST)) {
36
37 if(! isset($theid) ) $theid = 0;
38
39 $complete_post=true;
40
41 // FIXME: write human readable error messages
42 sqgetGlobalVar('filter_what', $filter_what, SQ_POST);
43 if (!sqgetGlobalVar('filter_what', $filter_what, SQ_POST)) {
44 do_error("Post error");
45 $complete_post=false;
46 }
47
48 sqgetGlobalVar('filter_where', $filter_where, SQ_POST);
49 if (!sqgetGlobalVar('filter_where', $filter_where, SQ_POST)) {
50 do_error("Post error");
51 $complete_post=false;
52 }
53
54 sqgetGlobalVar('filter_folder', $filter_folder, SQ_POST);
55 if (!sqgetGlobalVar('filter_folder', $filter_folder, SQ_POST)) {
56 do_error("Post error");
57 $complete_post=false;
58 }
59
60 if ($complete_post) {
61 $filter_what = str_replace(',', ' ', $filter_what);
62 $filter_what = str_replace("\\\\", "\\", $filter_what);
63 $filter_what = str_replace("\\\"", '"', $filter_what);
64 $filter_what = str_replace('"', '&quot;', $filter_what);
65
66 if (empty($filter_what)) {
67 do_error(_("WARNING! You must enter something to search for."));
68 $action = 'edit';
69 }
70
71 if (($filter_where == 'Header') && (strchr($filter_what,':') == '')) {
72 do_error(_("WARNING! Header filters should be of the format &quot;Header: value&quot;"));
73 $action = 'edit';
74 }
75 if ($action != 'edit') {
76 setPref($data_dir, $username, 'filter'.$theid, $filter_where.','.$filter_what.','.$filter_folder);
77 }
78 $filters[$theid]['where'] = $filter_where;
79 $filters[$theid]['what'] = $filter_what;
80 $filters[$theid]['folder'] = $filter_folder;
81 }
82 } elseif (isset($action) && $action == 'delete') {
83 remove_filter($theid);
84 } elseif (isset($action) && $action == 'move_up') {
85 filter_swap($theid, $theid - 1);
86 } elseif (isset($action) && $action == 'move_down') {
87 filter_swap($theid, $theid + 1);
88 } elseif (sqgetGlobalVar('user_submit',$user_submit,SQ_POST)) {
89 sqgetGlobalVar('filters_user_scan_set',$filters_user_scan_set,SQ_POST);
90 setPref($data_dir, $username, 'filters_user_scan', $filters_user_scan_set);
91 echo '<br /><center><b>'._("Saved Scan type")."</b></center>\n";
92 }
93
94 $filters = load_filters();
95 $filters_user_scan = getPref($data_dir, $username, 'filters_user_scan');
96
97 echo html_tag( 'table',
98 html_tag( 'tr',
99 html_tag( 'td',
100 '<center><b>' . _("Options") . ' - ' . _("Message Filtering") . '</b></center>' ,
101 'left', $color[0]
102 )
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', '', 'style="white-space: nowrap;"' ) .
111 html_tag( 'td', '', 'left' ) .
112 '<select name="filters_user_scan_set">'.
113 '<option value=""';
114 if ($filters_user_scan == '') {
115 echo ' selected="selected"';
116 }
117 echo '>' . _("All messages") . '</option>'.
118 '<option value="new"';
119 if ($filters_user_scan == 'new') {
120 echo ' selected="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
139 for ($a = 0, $cnt = count($boxes); $a < $cnt; $a++) {
140 if (strtolower($boxes[$a]['formatted']) == 'inbox') {
141 unset($boxes[$a]);
142 }
143 }
144
145 sqimap_logout($imapConnection);
146 if ( !isset($theid) ) {
147 $theid = count($filters);
148 }
149 echo html_tag( 'div', '', 'center' ) .
150 '<form action="options.php" method="post">'.
151 html_tag( 'table', '', '', '', 'border="0" cellpadding="2" cellspacing="0"' ) .
152 html_tag( 'tr' ) .
153 html_tag( 'td', _("Match:"), 'left' ) .
154 html_tag( 'td', '', 'left' ) .
155 '<select name="filter_where">';
156
157 $L = isset($filters[$theid]['where']);
158
159 $sel = (($L && $filters[$theid]['where'] == 'From')?' selected="selected"':'');
160 echo "<option value=\"From\"$sel>" . _("From") . '</option>';
161
162 $sel = (($L && $filters[$theid]['where'] == 'To')?' selected="selected"':'');
163 echo "<option value=\"To\"$sel>" . _("To") . '</option>';
164
165 $sel = (($L && $filters[$theid]['where'] == 'Cc')?' selected="selected"':'');
166 echo "<option value=\"Cc\"$sel>" . _("Cc") . '</option>';
167
168 $sel = (($L && $filters[$theid]['where'] == 'To or Cc')?' selected="selected"':'');
169 echo "<option value=\"To or Cc\"$sel>" . _("To or Cc") . '</option>';
170
171 $sel = (($L && $filters[$theid]['where'] == 'Subject')?' selected="selected"':'');
172 echo "<option value=\"Subject\"$sel>" . _("Subject") . '</option>';
173
174 $sel = (($L && $filters[$theid]['where'] == 'Message Body')?' selected="selected"':'');
175 echo "<option value=\"Message Body\"$sel>" . _("Message Body") . '</option>';
176
177 $sel = (($L && $filters[$theid]['where'] == 'Header and Body')?' selected="selected"':'');
178 echo "<option value=\"Header and Body\"$sel>" . _("Header and Body") . '</option>';
179
180 $sel = (($L && $filters[$theid]['where'] == 'Header')?' selected="selected"':'');
181 echo "<option value=\"Header\"$sel>" . _("Header") . '</option>';
182
183 echo '</select>'.
184 '</td>'.
185 '</tr>'.
186 html_tag( 'tr' ) .
187 html_tag( 'td', _("Contains:"), 'right' ) .
188 html_tag( 'td', '', 'left' ) .
189 '<input type="text" size="32" name="filter_what" value="';
190 if (isset($filters[$theid]['what'])) {
191 echo htmlspecialchars($filters[$theid]['what']);
192 }
193 echo '" />'.
194 '</td>'.
195 '</tr>'.
196 html_tag( 'tr' ) .
197 html_tag( 'td', _("Move to:"), 'left' ) .
198 html_tag( 'td', '', 'left' ) .
199 '<tt>'.
200 '<select name="filter_folder">';
201 $selected = 0;
202 if ( isset($filters[$theid]['folder']) )
203 $selected = array(strtolower($filters[$theid]['folder']));
204 echo sqimap_mailbox_option_list(0, $selected, 0, $boxes);
205 echo '</tt>'.
206 '</select>'.
207 '</td>'.
208 '</tr>'.
209 '</table>'.
210 '<input type="submit" name="filter_submit" value="' . _("Submit") . "\" />\n".
211 addHidden('theid', $theid).
212 '</form>'.
213 '</div>';
214
215 }
216
217 echo html_tag( 'table', '', 'center', '', 'border="0" cellpadding="3" cellspacing="0"' );
218
219 for ($i=0, $num = count($filters); $i < $num; $i++) {
220
221 $clr = (($i % 2)?$color[0]:$color[9]);
222 $fdr = ($folder_prefix)?str_replace($folder_prefix, "", $filters[$i]["folder"]):$filters[$i]["folder"];
223 echo html_tag( 'tr', '', '', $clr ) .
224 html_tag( 'td',
225 '<small>' .
226 "[<a href=\"options.php?theid=$i&amp;action=edit\">" . _("Edit") . '</a>]'.
227 '</small>' ,
228 'left' ) .
229 html_tag( 'td',
230 '<small>' .
231 "[<a href=\"options.php?theid=$i&amp;action=delete\">" . _("Delete") . '</a>]'.
232 '</small>' ,
233 'left' );
234
235 if ($num > 1) {
236 echo html_tag( 'td', '', 'center' ) . '<small>[';
237 if (isset($filters[$i + 1])) {
238 echo "<a href=\"options.php?theid=$i&amp;action=move_down\">" . _("Down") . '</a>';
239 if ($i > 0) {
240 echo '&nbsp;|&nbsp;';
241 }
242 }
243 if ($i > 0) {
244 echo "<a href=\"options.php?theid=$i&amp;action=move_up\">" . _("Up") . '</a>';
245 }
246 echo ']</small></td>';
247 }
248 echo html_tag( 'td', '-', 'left' ) .
249 html_tag( 'td', '', 'left' );
250 printf( _("If %s contains %s then move to %s"),
251 '<b>'.$filters[$i]['where'].'</b>',
252 '<b>'.$filters[$i]['what'].'</b>',
253 '<b>'.imap_utf7_decode_local($fdr).'</b>');
254 echo '</td></tr>';
255
256 }
257 echo '</table>'.
258 html_tag( 'table',
259 html_tag( 'tr',
260 html_tag( 'td', '&nbsp;', 'left' )
261 ) ,
262 'center', '', 'width="80%" border="0" cellpadding="2" cellspacing="0"' );
263 echo '</body></html>';
264 ?>