3ca3e869494597d70c31bba66b59601ca2d51ed3
[squirrelmail.git] / src / folders.php
1 <?php
2
3 /**
4 * folders.php
5 *
6 * Handles all interaction between the user and the other folder
7 * scripts which do most of the work. Also handles the Special
8 * Folders.
9 *
10 * @copyright &copy; 1999-2006 The SquirrelMail Project Team
11 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
12 * @version $Id$
13 * @package squirrelmail
14 */
15
16 /**
17 * Include the SquirrelMail initialization file.
18 */
19 require('../include/init.php');
20
21 /* SquirrelMail required files. */
22 require_once(SM_PATH . 'functions/imap_general.php');
23 require_once(SM_PATH . 'functions/folder_manip.php');
24 require_once(SM_PATH . 'functions/forms.php');
25
26 displayPageHeader($color, 'None');
27
28 /* get globals we may need */
29
30 sqgetGlobalVar('username', $username, SQ_SESSION);
31 sqgetGlobalVar('key', $key, SQ_COOKIE);
32 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
33 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
34
35 sqgetGlobalVar('smaction', $action, SQ_POST);
36
37 /* end of get globals */
38
39 echo '<br />' .
40 html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="1" cellspacing="0" border="0"' ) .
41 html_tag( 'tr' ) .
42 html_tag( 'td', '', 'center' ) . '<b>' . _("Folders") . '</b>' .
43 html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) .
44 html_tag( 'tr' ) .
45 html_tag( 'td', '', 'center', $color[4] );
46
47 $imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
48
49 /* switch to the right function based on what the user selected */
50 if ( sqgetGlobalVar('smaction', $action, SQ_POST) ) {
51
52 switch ($action)
53 {
54 case 'create':
55 sqgetGlobalVar('folder_name', $folder_name, SQ_POST);
56 sqgetGlobalVar('subfolder', $subfolder, SQ_POST);
57 sqgetGlobalVar('contain_subs', $contain_subs, SQ_POST);
58 folders_create($imapConnection, $delimiter, $folder_name, $subfolder, $contain_subs);
59 $td_str = _("Created folder successfully.");
60 break;
61 case 'rename':
62 if ( sqgetGlobalVar('cancelbutton', $dummy, SQ_POST) ) {
63 break;
64 }
65 if ( ! sqgetGlobalVar('new_name', $new_name, SQ_POST) ) {
66 sqgetGlobalVar('old_name', $old_name, SQ_POST);
67 folders_rename_getname($imapConnection, $delimiter, $old_name);
68 } else {
69 sqgetGlobalVar('orig', $orig, SQ_POST);
70 sqgetGlobalVar('old_name', $old_name, SQ_POST);
71 folders_rename_do($imapConnection, $delimiter, $orig, $old_name, $new_name);
72 $td_str = _("Renamed successfully.");
73 }
74 break;
75 case 'delete':
76 if ( sqgetGlobalVar('cancelbutton', $dummy, SQ_POST) ) {
77 break;
78 }
79 sqgetGlobalVar('folder_name', $folder_name, SQ_POST);
80 if ( sqgetGlobalVar('confirmed', $dummy, SQ_POST) ) {
81 folders_delete_do($imapConnection, $delimiter, $folder_name);
82 $td_str = _("Deleted folder successfully.");
83 } else {
84 folders_delete_ask($imapConnection, $folder_name);
85 }
86 break;
87 case 'subscribe':
88 sqgetGlobalVar('folder_names', $folder_names, SQ_POST);
89 folders_subscribe($imapConnection, $folder_names);
90 $td_str = _("Subscribed successfully.");
91 break;
92 case 'unsubscribe':
93 sqgetGlobalVar('folder_names', $folder_names, SQ_POST);
94 folders_unsubscribe($imapConnection, $folder_names);
95 $td_str = _("Unsubscribed successfully.");
96 break;
97 default:
98 // TODO: add hook for plugin action processing.
99 $td_str = '';
100 break;
101 }
102
103 // if there are any messages, output them.
104 if ( !empty($td_str) ) {
105 echo html_tag( 'table',
106 html_tag( 'tr',
107 html_tag( 'td', '<b>' . $td_str . "</b><br />\n" .
108 '<a href="../src/left_main.php" target="left">' .
109 _("refresh folder list") . '</a>' ,
110 'center' )
111 ) ,
112 'center', '', 'width="100%" cellpadding="4" cellspacing="0" border="0"' );
113 }
114 }
115
116 echo "\n<br />";
117
118 $boxes = sqimap_mailbox_list($imapConnection,true);
119
120 /** CREATING FOLDERS **/
121 echo html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspacing="0" border="0"' ) .
122 html_tag( 'tr',
123 html_tag( 'td', '<b>' . _("Create Folder") . '</b>', 'center', $color[9] )
124 ) .
125 html_tag( 'tr' ) .
126 html_tag( 'td', '', 'center', $color[0] ) .
127 addForm('folders.php', 'post', 'cf').
128 addHidden('smaction','create').
129 addInput('folder_name', '', 25).
130 "<br />\n". _("as a subfolder of"). '<br />'.
131 "<tt><select name=\"subfolder\">\n";
132
133 $show_selected = array();
134 $skip_folders = array();
135 $server_type = strtolower($imap_server_type);
136
137 // Special handling for courier
138 if ( $server_type == 'courier' ) {
139 /**
140 * If we use courier, we should hide system trash folder
141 * FIXME: (tokul) Who says that courier does not allow storing folders in
142 * INBOX.Trash or inbox.trash? Can't reproduce it 3.0.8. This entry is
143 * useless, because in_array() check is case sensitive and INBOX is in
144 * upper case.
145 */
146 array_push($skip_folders, 'inbox.trash');
147
148 if ( $default_folder_prefix == 'INBOX.' ) {
149 // We don't need INBOX, since it is top folder
150 array_push($skip_folders, 'INBOX');
151 }
152 } elseif ( $server_type == 'bincimap' ) {
153 if ( $default_folder_prefix == 'INBOX/' ) {
154 // We don't need INBOX, since it is top folder
155 array_push($skip_folders, 'INBOX');
156 }
157 }
158
159 if ( $default_sub_of_inbox == false ) {
160 echo '<option selected="selected" value="">[ '._("None")." ]</option>\n";
161 } else {
162 echo '<option value="">[ '._("None")." ]</option>\n";
163 $show_selected = array('inbox');
164 }
165
166 // Call sqimap_mailbox_option_list, using existing connection to IMAP server,
167 // the arrays of folders to include or skip (assembled above),
168 // use 'noinferiors' as a mailbox filter to leave out folders that can not contain other folders.
169 // use the long format to show subfolders in an intelligible way if parent is missing (special folder)
170 echo sqimap_mailbox_option_list($imapConnection, $show_selected, $skip_folders, $boxes, 'noinferiors', true);
171
172 echo "</select></tt>\n";
173 if ($show_contain_subfolders_option) {
174 echo '<br />'.
175 addCheckBox('contain_subs', FALSE, '1') .' &nbsp;'
176 . _("Let this folder contain subfolders")
177 . '<br />';
178 }
179 echo "<input type=\"submit\" value=\""._("Create")."\" />\n";
180 echo "</form></td></tr>\n";
181
182 echo html_tag( 'tr',
183 html_tag( 'td', '&nbsp;', 'left', $color[4] )
184 ) ."\n";
185
186 /** count special folders **/
187 foreach ($boxes as $index => $aBoxData) {
188 if (isSpecialMailbox($aBoxData['unformatted']) &&
189 ! in_array($aBoxData['unformatted'],$skip_folders)) {
190 $skip_folders[] = $aBoxData['unformatted'];
191 }
192 }
193
194 /**
195 * Retrieve list of folders when special folders are excluded. Special folders
196 * should be unavailable in rename/delete/unsubscribe. Theoretically user can
197 * modify form and perform these operations with special folders, but if user
198 * manages to delete/rename/unsubscribe special folder by hacking form...
199 *
200 * If script or program depends on special folder, they should not assume that
201 * folder is available.
202 *
203 * $filtered_folders contains empty string or html formated option list.
204 */
205 $filtered_folders = sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
206
207 /** RENAMING FOLDERS **/
208 echo html_tag( 'tr',
209 html_tag( 'td', '<b>' . _("Rename a Folder") . '</b>', 'center', $color[9] )
210 ) .
211 html_tag( 'tr' ) .
212 html_tag( 'td', '', 'center', $color[0] );
213
214 /* show only if we have folders to rename */
215 if (! empty($filtered_folders)) {
216 echo addForm('folders.php')
217 . addHidden('smaction', 'rename')
218 . "<tt><select name=\"old_name\">\n"
219 . ' <option value="">[ ' . _("Select a folder") . " ]</option>\n";
220
221 // use existing IMAP connection, we have no special values to show,
222 // but we do include values to skip. Use the pre-created $boxes to save an IMAP query.
223 // send NULL for the flag - ALL folders are eligible for rename!
224 // use long format to make sure folder names make sense when parents may be missing.
225 echo $filtered_folders;
226
227 echo "</select></tt>\n".
228 '<input type="submit" value="'.
229 _("Rename").
230 "\" />\n".
231 "</form></td></tr>\n";
232 } else {
233 echo _("No folders found") . '<br /><br /></td></tr>';
234 }
235
236 echo html_tag( 'tr',
237 html_tag( 'td', '&nbsp;', 'left', $color[4] )
238 ) ."\n";
239
240 /** DELETING FOLDERS **/
241 echo html_tag( 'tr',
242 html_tag( 'td', '<b>' . _("Delete Folder") . '</b>', 'center', $color[9] )
243 ) .
244 html_tag( 'tr' ) .
245 html_tag( 'td', '', 'center', $color[0] );
246
247 /* show only if we have folders to delete */
248 if (!empty($filtered_folders)) {
249 echo addForm('folders.php')
250 . addHidden('smaction', 'delete')
251 . "<tt><select name=\"folder_name\">\n"
252 . ' <option value="">[ ' . _("Select a folder") . " ]</option>\n";
253
254 // send NULL for the flag - ALL folders are eligible for delete (except what we've got in skiplist)
255 // use long format to make sure folder names make sense when parents may be missing.
256 echo $filtered_folders;
257
258 echo "</select></tt>\n"
259 . '<input type="submit" value="'
260 . _("Delete")
261 . "\" />\n"
262 . "</form></td></tr>\n";
263 } else {
264 echo _("No folders found") . "<br /><br /></td></tr>";
265 }
266
267 echo html_tag( 'tr',
268 html_tag( 'td', '&nbsp;', 'left', $color[4] )
269 ) ."</table>\n";
270
271
272 if ($show_only_subscribed_folders) {
273 // FIXME: fix subscription options when top folder is not subscribed and sub folder is subscribed
274 // TODO: use checkboxes instead of select options.
275
276 /** UNSUBSCRIBE FOLDERS **/
277 echo html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspacing="0" border="0"' ) .
278 html_tag( 'tr',
279 html_tag( 'td', '<b>' . _("Unsubscribe") . '/' . _("Subscribe") . '</b>', 'center', $color[9], 'colspan="2"' )
280 ) .
281 html_tag( 'tr' ) .
282 html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
283
284 if (!empty($filtered_folders)) {
285 echo addForm('folders.php')
286 . addHidden('smaction', 'unsubscribe')
287 . "<tt><select name=\"folder_names[]\" multiple=\"multiple\" size=\"8\">\n"
288 . $filtered_folders
289 . "</select></tt><br /><br />\n"
290 . '<input type="submit" value="'
291 . _("Unsubscribe")
292 . "\" />\n"
293 . "</form></td>\n";
294 } else {
295 echo _("No folders were found to unsubscribe from.") . '</td>';
296 }
297
298 /** SUBSCRIBE TO FOLDERS **/
299 echo html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
300 if(!$no_list_for_subscribe) {
301 $boxes_all = sqimap_mailbox_list_all ($imapConnection);
302
303 $subboxes = array();
304 // here we filter out all boxes we're already subscribed to,
305 // so we keep only the unsubscribed ones.
306 foreach ($boxes_all as $box_a) {
307
308 $use_folder = true;
309 foreach ( $boxes as $box ) {
310 if ($box_a['unformatted'] == $box['unformatted'] ||
311 $box_a['unformatted-dm'] == $folder_prefix ) {
312 $use_folder = false;
313 }
314 }
315
316 if ($use_folder == true) {
317 $box_enc = htmlspecialchars($box_a['unformatted-dm']);
318 $box_disp = htmlspecialchars(imap_utf7_decode_local($box_a['unformatted-disp']));
319 $subboxes[$box_enc] = $box_disp;
320 }
321 }
322
323 if ( count($subboxes) > 0 ) {
324 echo addForm('folders.php')
325 . addHidden('smaction', 'subscribe')
326 . '<tt><select name="folder_names[]" multiple="multiple" size="8">';
327
328 foreach($subboxes as $subbox_enc => $subbox_disp) {
329 echo ' <option value="' . $subbox_enc . '">'.$subbox_disp."</option>\n";
330 }
331
332 echo '</select></tt><br /><br />'
333 . '<input type="submit" value="'. _("Subscribe") . "\" />\n"
334 . "</form></td></tr></table><br />\n";
335 } else {
336 echo _("No folders were found to subscribe to.") . '</td></tr></table>';
337 }
338 } else {
339 /* don't perform the list action -- this is much faster */
340 echo addForm('folders.php')
341 . addHidden('smaction', 'subscribe')
342 . _("Subscribe to:") . '<br />'
343 . '<tt><input type="text" name="folder_names[]" size="35" />'
344 . '<input type="submit" value="'. _("Subscribe") . "\" />\n"
345 . "</form></td></tr></table><br />\n";
346 }
347 }
348
349 do_hook('folders_bottom');
350 sqimap_logout($imapConnection);
351
352 ?>
353 </td></tr>
354 </table>
355 </td></tr>
356 </table>
357 <?php
358 $oTemplate->display('footer.tpl');
359 ?>