phpdoc updates
[squirrelmail.git] / src / folders.php
1 <?php
2
3 /**
4 * folders.php
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 * Handles all interaction between the user and the other folder
10 * scripts which do most of the work. Also handles the Special
11 * Folders.
12 *
13 * $Id$
14 * @package squirrelmail
15 */
16
17 /** Path for SquirrelMail required files. */
18 define('SM_PATH','../');
19
20 /* SquirrelMail required files. */
21 require_once(SM_PATH . 'include/validate.php');
22 require_once(SM_PATH . 'functions/imap.php');
23 require_once(SM_PATH . 'functions/plugin.php');
24 require_once(SM_PATH . 'functions/html.php');
25 require_once(SM_PATH . 'functions/forms.php');
26
27 displayPageHeader($color, 'None');
28
29 /* get globals we may need */
30
31 sqgetGlobalVar('username', $username, SQ_SESSION);
32 sqgetGlobalVar('key', $key, SQ_COOKIE);
33 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
34 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
35
36 sqgetGlobalVar('success', $success, SQ_GET);
37
38 /* end of get globals */
39
40 echo '<br>' .
41 html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="1" cellspacing="0" border="0"' ) .
42 html_tag( 'tr' ) .
43 html_tag( 'td', '', 'center' ) . '<b>' . _("Folders") . '</b>' .
44 html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) .
45 html_tag( 'tr' ) .
46 html_tag( 'td', '', 'center', $color[4] );
47
48 if ( isset($success) && $success ) {
49
50 $td_str = '<b>';
51
52 switch ($success)
53 {
54 case 'subscribe':
55 $td_str .= _("Subscribed successfully!");
56 break;
57 case 'unsubscribe':
58 $td_str .= _("Unsubscribed successfully!");
59 break;
60 case 'delete':
61 $td_str .= _("Deleted folder successfully!");
62 break;
63 case 'create':
64 $td_str .= _("Created folder successfully!");
65 break;
66 case 'rename':
67 $td_str .= _("Renamed successfully!");
68 break;
69 case 'subscribe-doesnotexist':
70 $td_str .= _("Subscription Unsuccessful - Folder does not exist.");
71 break;
72 }
73
74 $td_str .= '</b><br>';
75
76
77 echo html_tag( 'table',
78 html_tag( 'tr',
79 html_tag( 'td', $td_str .
80 '<a href="../src/left_main.php" target=left>' .
81 _("refresh folder list") . '</a>' ,
82 'center' )
83 ) ,
84 'center', '', 'width="100%" cellpadding="4" cellspacing="0" border="0"' );
85 }
86
87 echo "\n<br>";
88
89 $imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
90 $boxes = sqimap_mailbox_list($imapConnection);
91
92 /** CREATING FOLDERS **/
93 echo html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspacing="0" border="0"' ) .
94 html_tag( 'tr',
95 html_tag( 'td', '<b>' . _("Create Folder") . '</b>', 'center', $color[9] )
96 ) .
97 html_tag( 'tr' ) .
98 html_tag( 'td', '', 'center', $color[0] ) .
99 addForm('folders_create.php', 'POST', 'cf').
100 addInput('folder_name', '', 25).
101 "<BR>\n". _("as a subfolder of"). '<BR>'.
102 "<TT><SELECT NAME=subfolder>\n";
103
104 $show_selected = array();
105 $skip_folders = array();
106 $server_type = strtolower($imap_server_type);
107 if ( $server_type == 'courier' ) {
108 array_push($skip_folders, 'inbox.trash');
109 if ( $default_folder_prefix == 'INBOX.' ) {
110 array_push($skip_folders, 'inbox');
111 }
112 }
113
114 if ( $default_sub_of_inbox == false ) {
115 echo '<OPTION SELECTED VALUE="">[ '._("None")." ]\n";
116 } else {
117 echo '<OPTION VALUE="">[ '._("None")." ]\n";
118 $show_selected = array('inbox');
119 }
120
121 // Call sqimap_mailbox_option_list, using existing connection to IMAP server,
122 // the arrays of folders to include or skip (assembled above),
123 // use 'noinferiors' as a mailbox filter to leave out folders that can not contain other folders.
124 // use the long format to show subfolders in an intelligible way if parent is missing (special folder)
125 echo sqimap_mailbox_option_list($imapConnection, $show_selected, $skip_folders, $boxes, 'noinferiors', true);
126
127 echo "</SELECT></TT>\n";
128 if ($show_contain_subfolders_option) {
129 echo '<br>'.
130 addCheckBox('contain_subs', FALSE, '1') .' &nbsp;'
131 . _("Let this folder contain subfolders")
132 . '<BR>';
133 }
134 echo "<input type=SUBMIT VALUE=\""._("Create")."\">\n";
135 echo "</FORM></td></tr>\n";
136
137 echo html_tag( 'tr',
138 html_tag( 'td', '&nbsp;', 'left', $color[4] )
139 ) ."\n";
140
141 /** count special folders **/
142
143 // FIX ME, why not check if the folders are defined IMHO move_to_sent, move_to_trash has nothing todo with it
144 $count_special_folders = 0;
145 $num_max = 1;
146 if (strtolower($imap_server_type) == "courier" || $move_to_trash) {
147 $num_max++;
148 }
149 if ($move_to_sent) {
150 $num_max++;
151 }
152 if ($save_as_draft) {
153 $num_max++;
154 }
155
156 // What if move_to_sent = false and $sent_folder is set? Should it still be skipped?
157
158 for ($p = 0, $cnt = count($boxes); $p < $cnt && $count_special_folders < $num_max; $p++) {
159 switch ($boxes[$p]['unformatted'])
160 {
161 case (strtoupper($boxes[$p]['unformatted']) == 'INBOX'):
162 ++$count_special_folders;
163 $skip_folders[] = $boxes[$p]['unformatted'];
164 break;
165 // FIX ME inbox.trash should be set in conf.pl
166 case 'inbox.trash':
167 if (strtolower($imap_server_type) == 'courier') {
168 ++$count_special_folders;
169 }
170 break;
171 case $trash_folder:
172 ++$count_special_folders;
173 $skip_folders[] = $trash_folder;
174 break;
175 case $sent_folder:
176 ++$count_special_folders;
177 $skip_folders[] = $sent_folder;
178 break;
179 case $draft_folder:
180 ++$count_special_folders;
181 $skip_folders[] = $draft_folder;
182 break;
183 default: break;
184 }
185 }
186
187
188 /** RENAMING FOLDERS **/
189 echo html_tag( 'tr',
190 html_tag( 'td', '<b>' . _("Rename a Folder") . '</b>', 'center', $color[9] )
191 ) .
192 html_tag( 'tr' ) .
193 html_tag( 'td', '', 'center', $color[0] );
194
195 if ($count_special_folders < count($boxes)) {
196 echo addForm('folders_rename_getname.php')
197 . "<TT><SELECT NAME=old>\n"
198 . ' <OPTION VALUE="">[ ' . _("Select a folder") . " ]</OPTION>\n";
199
200 // use existing IMAP connection, we have no special values to show,
201 // but we do include values to skip. Use the pre-created $boxes to save an IMAP query.
202 // send NULL for the flag - ALL folders are eligible for rename!
203 // use long format to make sure folder names make sense when parents may be missing.
204 echo sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
205
206 echo "</SELECT></TT>\n".
207 "<input type=SUBMIT VALUE=\"".
208 _("Rename").
209 "\">\n".
210 "</FORM></td></tr>\n";
211 } else {
212 echo _("No folders found") . '<br><br></td></tr>';
213 }
214 $boxes_sub = $boxes;
215
216 echo html_tag( 'tr',
217 html_tag( 'td', '&nbsp;', 'left', $color[4] )
218 ) ."\n";
219
220 /** DELETING FOLDERS **/
221 echo html_tag( 'tr',
222 html_tag( 'td', '<b>' . _("Delete Folder") . '</b>', 'center', $color[9] )
223 ) .
224 html_tag( 'tr' ) .
225 html_tag( 'td', '', 'center', $color[0] );
226
227 if ($count_special_folders < count($boxes)) {
228 echo addForm('folders_delete.php')
229 . "<TT><SELECT NAME=mailbox>\n"
230 . ' <OPTION VALUE="">[ ' . _("Select a folder") . " ]</OPTION>\n";
231
232 // send NULL for the flag - ALL folders are eligible for delete (except what we've got in skiplist)
233 // use long format to make sure folder names make sense when parents may be missing.
234 echo sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
235
236 echo "</SELECT></TT>\n"
237 . '<input type=SUBMIT VALUE="'
238 . _("Delete")
239 . "\">\n"
240 . "</form></td></tr>\n";
241 } else {
242 echo _("No folders found") . "<br><br></td></tr>";
243 }
244
245 echo html_tag( 'tr',
246 html_tag( 'td', '&nbsp;', 'left', $color[4] )
247 ) ."</table>\n";
248
249
250 /** UNSUBSCRIBE FOLDERS **/
251 echo html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspacing="0" border="0"' ) .
252 html_tag( 'tr',
253 html_tag( 'td', '<b>' . _("Unsubscribe") . '/' . _("Subscribe") . '</b>', 'center', $color[9], 'colspan="2"' )
254 ) .
255 html_tag( 'tr' ) .
256 html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
257
258 if ($count_special_folders < count($boxes)) {
259 echo addForm('folders_subscribe.php?method=unsub')
260 . "<TT><SELECT NAME=\"mailbox[]\" multiple size=8>\n";
261 for ($i = 0; $i < count($boxes); $i++) {
262 $use_folder = true;
263 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
264 ($boxes[$i]["unformatted"] != $trash_folder) &&
265 ($boxes[$i]["unformatted"] != $sent_folder) &&
266 ($boxes[$i]["unformatted"] != $draft_folder)) {
267 $box = htmlspecialchars($boxes[$i]["unformatted-dm"]);
268 $box2 = str_replace(' ', '&nbsp;',
269 htmlspecialchars(imap_utf7_decode_local($boxes[$i]["unformatted-disp"])));
270 echo " <OPTION VALUE=\"$box\">$box2\n";
271 }
272 }
273 echo "</SELECT></TT><br><br>\n"
274 . '<input type=SUBMIT VALUE="'
275 . _("Unsubscribe")
276 . "\">\n"
277 . "</FORM></td>\n";
278 } else {
279 echo _("No folders were found to unsubscribe from!") . '</td>';
280 }
281 $boxes_sub = $boxes;
282
283 /** SUBSCRIBE TO FOLDERS **/
284 echo html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
285 if(!$no_list_for_subscribe) {
286 $boxes_all = sqimap_mailbox_list_all ($imapConnection);
287
288 $box = '';
289 $box2 = '';
290 for ($i = 0, $q = 0; $i < count($boxes_all); $i++) {
291 $use_folder = true;
292 for ($p = 0; $p < count ($boxes); $p++) {
293 if ($boxes_all[$i]['unformatted'] == $boxes[$p]['unformatted']) {
294 $use_folder = false;
295 continue;
296 } else if ($boxes_all[$i]['unformatted-dm'] == $folder_prefix) {
297 $use_folder = false;
298 }
299 }
300 if ($use_folder == true) {
301 $box[$q] = htmlspecialchars($boxes_all[$i]['unformatted-dm']);
302 $box2[$q] = htmlspecialchars(imap_utf7_decode_local($boxes_all[$i]['unformatted-disp']));
303 $q++;
304 }
305 }
306 if ($box && $box2) {
307 echo addForm('folders_subscribe.php?method=sub')
308 . '<tt><select name="mailbox[]" multiple size=8>';
309
310 for ($q = 0; $q < count($box); $q++) {
311 echo " <OPTION VALUE=\"$box[$q]\">".$box2[$q]."\n";
312 }
313 echo '</select></tt><br><br>'
314 . '<input type=SUBMIT VALUE="'. _("Subscribe") . "\">\n"
315 . "</FORM></td></tr></table><BR>\n";
316 } else {
317 echo _("No folders were found to subscribe to!") . '</td></tr></table>';
318 }
319 } else {
320 /* don't perform the list action -- this is much faster */
321 echo addForm('folders_subscribe.php?method=sub')
322 . _("Subscribe to:") . '<br>'
323 . '<tt><input type="text" name="mailbox[]" size=35>'
324 . '<INPUT TYPE=SUBMIT VALUE="'. _("Subscribe") . "\">\n"
325 . "</FORM></TD></TR></TABLE><BR>\n";
326 }
327
328 do_hook('folders_bottom');
329 ?>
330
331 </td></tr>
332 </table>
333
334 </td></tr>
335 </table>
336
337 <?php
338 sqimap_logout($imapConnection);
339 ?>
340
341 </body></html>