Moving documentation from source code to README
[squirrelmail.git] / plugins / filters / spamoptions.php
1 <?php
2 /**
3 * Message and Spam Filter Plugin - Spam Options
4 *
5 * @version $Id$
6 * @copyright (c) 1999-2005 The SquirrelMail Project Team
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
8 * @package plugins
9 * @subpackage filters
10 */
11
12 /**
13 * Path for SquirrelMail required files.
14 * @ignore
15 */
16 define('SM_PATH','../../');
17
18 /* SquirrelMail required files. */
19 require_once(SM_PATH . 'include/validate.php');
20 require_once(SM_PATH . 'functions/page_header.php');
21 require_once(SM_PATH . 'functions/imap.php');
22 require_once(SM_PATH . 'include/load_prefs.php');
23 require_once(SM_PATH . 'functions/html.php');
24 require_once(SM_PATH . 'plugins/filters/filters.php');
25 global $AllowSpamFilters;
26
27 /* get globals */
28 sqgetGlobalVar('username', $username, SQ_SESSION);
29 sqgetGlobalVar('key', $key, SQ_COOKIE);
30 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
31 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
32
33 sqgetGlobalVar('action', $action, SQ_GET);
34 /* end globals */
35
36 displayPageHeader($color, 'None');
37
38 if (sqgetGlobalVar('spam_submit',$spam_submit,SQ_POST)) {
39 $spam_filters = load_spam_filters();
40
41 // setting spam folder
42 sqgetGlobalVar('filters_spam_folder_set',$filters_spam_folder_set,SQ_POST);
43 if (isset($filters_spam_folder_set)) {
44 setPref($data_dir, $username, 'filters_spam_folder', $filters_spam_folder_set);
45 } else {
46 echo _("You must select a spam folder.");
47 }
48
49 // setting scan type
50 sqgetGlobalVar('filters_spam_scan_set',$filters_spam_scan_set,SQ_POST);
51 if (isset($filters_spam_scan_set)) {
52 setPref($data_dir, $username, 'filters_spam_scan', $filters_spam_scan_set);
53 } else {
54 echo _("You must select a scan type.");
55 }
56
57 foreach ($spam_filters as $Key => $Value) {
58 $input = $spam_filters[$Key]['prefname'] . '_set';
59 if ( sqgetGlobalVar($input,$input_key,SQ_POST) ) {
60 setPref( $data_dir, $username, $spam_filters[$Key]['prefname'],$input_key);
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 sprintf(_("WARNING! Tell the administrator to set the %s variable."), '&quot;SpamFilters_YourHop&quot;') .
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', '', 'style="white-space: 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', '', 'style="white-space: nowrap;"' ) .
124 html_tag( 'td' ) .
125 '<select name="filters_spam_scan_set">'.
126 '<option value=""';
127 if ($filters_spam_scan == '') {
128 echo ' selected="selected"';
129 }
130 echo '>' . _("All messages") . '</option>'.
131 '<option value="new"';
132 if ($filters_spam_scan == 'new') {
133 echo ' selected="selected"';
134 }
135 echo '>' . _("Unread messages only") . '</option>' .
136 '</select>'.
137 '</td>'.
138 '</tr>'.
139 html_tag( 'tr',
140 html_tag( 'td', '&nbsp;' ) .
141 html_tag( 'td',
142 _("The more messages scanned, the longer it takes. It's recommended to scan unread messages only. If a change to the filters is made, it's recommended to set it to scan all messages, then go view the INBOX, then come back and set it to scan unread messages only. That way, the new spam filters will be applied and even the spam you didn't catch with the old filters will be scanned.") ,
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', '', 'style="white-space: 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="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 } else {
182 // action is not set or action is not spam
183 echo html_tag( 'p', '', 'center' ) .
184 '[<a href="spamoptions.php?action=spam">' . _("Edit") . '</a>]' .
185 ' - [<a href="../../src/options.php">' . _("Done") . '</a>]</center><br /><br />';
186 printf( _("Spam is sent to %s."), ($filters_spam_folder?'<b>'.imap_utf7_decode_local($filters_spam_folder).'</b>':'[<i>'._("not set yet").'</i>]' ) );
187 echo '<br />';
188 printf( _("Spam scan is limited to %s."), '<b>' . ( ($filters_spam_scan == 'new')?_("Unread messages only"):_("All messages") ) . '</b>' );
189 echo '</p>'.
190 '<table border="0" cellpadding="3" cellspacing="0" align="center" bgcolor="' . $color[0] . "\">\n";
191
192 $spam_filters = load_spam_filters();
193
194 foreach ($spam_filters as $Key => $Value) {
195 echo html_tag( 'tr' ) .
196 html_tag( 'th', '', 'center' );
197
198 if ($spam_filters[$Key]['enabled']) {
199 echo _("ON");
200 } else {
201 echo _("OFF");
202 }
203
204 echo '</th>' .
205 html_tag( 'td', '&nbsp;-&nbsp;', 'left' ) .
206 html_tag( 'td', '', 'left' );
207
208 if ($spam_filters[$Key]['link']) {
209 echo '<a href="' .
210 $spam_filters[$Key]['link'] .
211 '" target="_blank">';
212 }
213
214 echo $spam_filters[$Key]['name'];
215 if ($spam_filters[$Key]['link']) {
216 echo '</a>';
217 }
218 echo "</td></tr>\n";
219 }
220 echo '</table>';
221 }
222 ?>
223 </body></html>