32aa0074 |
1 | <?php |
2 | |
3 | /** |
aa00e648 |
4 | * folder_manip.php |
5 | * |
aa00e648 |
6 | * Functions for IMAP folder manipulation: |
7 | * (un)subscribe, create, rename, delete. |
8 | * |
4b4abf93 |
9 | * @author Thijs Kinkhorst <kink at squirrelmail.org> |
47ccfad4 |
10 | * @copyright © 1999-2006 The SquirrelMail Project Team |
4b4abf93 |
11 | * @license http://opensource.org/licenses/gpl-license.php GNU Public License |
aa00e648 |
12 | * @version $Id$ |
13 | * @package squirrelmail |
14 | * @see folders.php |
aa00e648 |
15 | */ |
32aa0074 |
16 | |
17 | |
18 | /** |
19 | * Helper function for the functions below; checks if the user entered |
20 | * folder name is valid according to the IMAP standard. If not, it |
21 | * bails out with an error and cleanly terminates the IMAP connection. |
22 | */ |
23 | function folders_checkname($imapConnection, $folder_name, $delimiter) |
24 | { |
25 | if (substr_count($folder_name, '"') || substr_count($folder_name, "\\") || |
26 | substr_count($folder_name, $delimiter) || ($folder_name == '')) { |
f8a1ed5a |
27 | |
1b858d86 |
28 | global $color, $oTemplate; |
1dce0de7 |
29 | error_box(_("Illegal folder name.") . "<br />\n" . |
f8a1ed5a |
30 | sprintf(_("The name may not contain any of the following: %s"), '<tt>" \\ '.$delimiter.'</tt>') |
31 | . "<br />\n" . |
32 | _("Please select a different name."). |
33 | '<br /><a href="folders.php">'. |
1b858d86 |
34 | _("Click here to go back") . '</a>.'); |
aa00e648 |
35 | |
32aa0074 |
36 | sqimap_logout($imapConnection); |
1b858d86 |
37 | $oTemplate->display('footer.tpl'); |
aa00e648 |
38 | exit; |
32aa0074 |
39 | } |
40 | } |
41 | |
42 | /** |
43 | * Called from folders.php to create a new folder. |
44 | */ |
45 | function folders_create ($imapConnection, $delimiter, $folder_name, $subfolder, $contain_subs) |
46 | { |
47 | folders_checkname($imapConnection, $folder_name, $delimiter); |
48 | |
49 | global $folder_prefix; |
50 | |
51 | $folder_name = imap_utf7_encode_local($folder_name); |
f8a1ed5a |
52 | |
32aa0074 |
53 | if ( ! empty($contain_subs) ) { |
54 | $folder_name = $folder_name . $delimiter; |
55 | } |
56 | |
57 | if ($folder_prefix && (substr($folder_prefix, -1) != $delimiter)) { |
58 | $folder_prefix = $folder_prefix . $delimiter; |
59 | } |
60 | if ($folder_prefix && (substr($subfolder, 0, strlen($folder_prefix)) != $folder_prefix)) { |
61 | $subfolder_orig = $subfolder; |
62 | $subfolder = $folder_prefix . $subfolder; |
63 | } else { |
64 | $subfolder_orig = $subfolder; |
65 | } |
66 | |
67 | if (trim($subfolder_orig) == '') { |
68 | sqimap_mailbox_create ($imapConnection, $folder_prefix.$folder_name, ''); |
69 | } else { |
70 | sqimap_mailbox_create ($imapConnection, $subfolder.$delimiter.$folder_name, ''); |
71 | } |
72 | |
73 | return; |
74 | } |
75 | |
76 | /** |
77 | * Called from folders.php, given a folder name, ask the user what this |
78 | * folder should be renamed to. |
79 | */ |
80 | function folders_rename_getname ($imapConnection, $delimiter, $old) { |
9829e1d8 |
81 | global $color, $default_folder_prefix, $oTemplate; |
32aa0074 |
82 | |
83 | if ( $old == '' ) { |
84 | plain_error_message(_("You have not selected a folder to rename. Please do so."). |
85 | '<br /><a href="../src/folders.php">'._("Click here to go back").'</a>.', $color); |
f8a1ed5a |
86 | sqimap_logout($imapConnection); |
9829e1d8 |
87 | $oTemplate->display('footer.tpl'); |
32aa0074 |
88 | exit; |
89 | } |
90 | |
91 | if (substr($old, strlen($old) - strlen($delimiter)) == $delimiter) { |
92 | $isfolder = TRUE; |
93 | $old = substr($old, 0, strlen($old) - 1); |
94 | } else { |
95 | $isfolder = FALSE; |
96 | } |
97 | |
98 | $old = imap_utf7_decode_local($old); |
99 | |
100 | if (strpos($old, $delimiter)) { |
101 | $old_name = substr($old, strrpos($old, $delimiter)+1, strlen($old)); |
aa00e648 |
102 | // hide default prefix (INBOX., mail/ or other) |
103 | $quoted_prefix=preg_quote($default_folder_prefix,'/'); |
104 | $prefix_length=(preg_match("/^$quoted_prefix/",$old) ? strlen($default_folder_prefix) : 0); |
105 | if ($prefix_length>strrpos($old, $delimiter)) { |
106 | $old_parent = ''; |
107 | } else { |
108 | $old_parent = substr($old, $prefix_length, (strrpos($old, $delimiter)-$prefix_length)) |
109 | . ' ' . $delimiter; |
110 | } |
32aa0074 |
111 | } else { |
112 | $old_name = $old; |
113 | $old_parent = ''; |
114 | } |
9829e1d8 |
115 | |
116 | sqimap_logout($imapConnection); |
32aa0074 |
117 | |
9829e1d8 |
118 | $oTemplate->assign('dialog_type', 'rename'); |
119 | $oTemplate->assign('color', $color); |
120 | $oTemplate->assign('old_parent', htmlspecialchars($old_parent)); |
121 | $oTemplate->assign('old', htmlspecialchars($old)); |
122 | $oTemplate->assign('old_name', htmlspecialchars($old_name)); |
123 | $oTemplate->assign('isfolder', $isfolder); |
124 | |
125 | $oTemplate->display('folder_manip_dialog.tpl'); |
126 | $oTemplate->display('footer.tpl'); |
f8a1ed5a |
127 | |
32aa0074 |
128 | exit; |
129 | } |
130 | |
131 | /** |
132 | * Given an old and new folder name, renames the folder. |
133 | */ |
134 | function folders_rename_do($imapConnection, $delimiter, $orig, $old_name, $new_name) |
135 | { |
136 | folders_checkname($imapConnection, $new_name, $delimiter); |
137 | |
138 | $orig = imap_utf7_encode_local($orig); |
139 | $old_name = imap_utf7_encode_local($old_name); |
140 | $new_name = imap_utf7_encode_local($new_name); |
f8a1ed5a |
141 | |
32aa0074 |
142 | if ($old_name != $new_name) { |
143 | |
144 | if (strpos($orig, $delimiter)) { |
145 | $old_dir = substr($orig, 0, strrpos($orig, $delimiter)); |
146 | } else { |
147 | $old_dir = ''; |
148 | } |
149 | |
150 | if ($old_dir != '') { |
151 | $newone = $old_dir . $delimiter . $new_name; |
152 | } else { |
153 | $newone = $new_name; |
154 | } |
155 | |
156 | // Renaming a folder doesn't rename the folder but leaves you unsubscribed |
157 | // at least on Cyrus IMAP servers. |
158 | if (isset($isfolder)) { |
159 | $newone = $newone.$delimiter; |
160 | $orig = $orig.$delimiter; |
161 | } |
162 | sqimap_mailbox_rename( $imapConnection, $orig, $newone ); |
163 | |
164 | } |
165 | |
166 | return; |
167 | } |
168 | |
169 | /** |
170 | * Presents a confirmation dialog to the user asking whether they're |
171 | * sure they want to delete this folder. |
172 | */ |
173 | function folders_delete_ask ($imapConnection, $folder_name) |
174 | { |
9829e1d8 |
175 | global $color, $default_folder_prefix, $oTemplate; |
32aa0074 |
176 | |
177 | if ($folder_name == '') { |
178 | plain_error_message(_("You have not selected a folder to delete. Please do so."). |
179 | '<br /><a href="../src/folders.php">'._("Click here to go back").'</a>.', $color); |
9829e1d8 |
180 | sqimap_logout($imapConnection); |
181 | $oTemplate->display('footer.tpl'); |
32aa0074 |
182 | exit; |
183 | } |
184 | |
aa00e648 |
185 | // hide default folder prefix (INBOX., mail/ or other) |
186 | $visible_folder_name = imap_utf7_decode_local($folder_name); |
187 | $quoted_prefix = preg_quote($default_folder_prefix,'/'); |
188 | $prefix_length = (preg_match("/^$quoted_prefix/",$visible_folder_name) ? strlen($default_folder_prefix) : 0); |
189 | $visible_folder_name = substr($visible_folder_name,$prefix_length); |
190 | |
f8a1ed5a |
191 | sqimap_logout($imapConnection); |
9829e1d8 |
192 | |
193 | $oTemplate->assign('dialog_type', 'delete'); |
194 | $oTemplate->assign('color', $color); |
195 | $oTemplate->assign('folder_name', htmlspecialchars($folder_name)); |
196 | $oTemplate->assign('visible_folder_name', htmlspecialchars($visible_folder_name)); |
197 | |
198 | $oTemplate->display('folder_manip_dialog.tpl'); |
199 | $oTemplate->display('footer.tpl'); |
200 | |
32aa0074 |
201 | exit; |
202 | } |
203 | |
204 | /** |
205 | * Given a folder, moves it to trash (and all subfolders of it too). |
206 | */ |
207 | function folders_delete_do ($imapConnection, $delimiter, $folder_name) |
208 | { |
202bcbcc |
209 | include(SM_PATH . 'functions/tree.php'); |
f8a1ed5a |
210 | |
32aa0074 |
211 | $boxes = sqimap_mailbox_list ($imapConnection); |
212 | |
213 | global $delete_folder, $imap_server_type, $trash_folder, $move_to_trash; |
214 | |
215 | if (substr($folder_name, -1) == $delimiter) { |
216 | $folder_name_no_dm = substr($folder_name, 0, strlen($folder_name) - 1); |
217 | } else { |
218 | $folder_name_no_dm = $folder_name; |
219 | } |
220 | |
221 | /** lets see if we CAN move folders to the trash.. otherwise, |
222 | ** just delete them **/ |
223 | |
224 | /* Courier IMAP doesn't like subfolders of Trash |
225 | * If global options say we can't move it into Trash |
226 | * If it's already a subfolder of trash, we'll have to delete it */ |
227 | if (strtolower($imap_server_type) == 'courier' || |
228 | (isset($delete_folder) && $delete_folder) || |
229 | eregi('^'.$trash_folder.'.+', $folder_name) ) |
230 | { |
231 | $can_move_to_trash = FALSE; |
232 | } |
233 | /* Otherwise, check if trash folder exits and support sub-folders */ |
234 | else { |
235 | foreach($boxes as $box) { |
236 | if ($box['unformatted'] == $trash_folder) { |
237 | $can_move_to_trash = !in_array('noinferiors', $box['flags']); |
238 | } |
239 | } |
240 | } |
241 | |
242 | /** First create the top node in the tree **/ |
243 | foreach($boxes as $box) { |
244 | if (($box['unformatted-dm'] == $folder_name) && (strlen($box['unformatted-dm']) == strlen($folder_name))) { |
245 | $foldersTree[0]['value'] = $folder_name; |
246 | $foldersTree[0]['doIHaveChildren'] = false; |
247 | continue; |
248 | } |
249 | } |
250 | |
251 | /* Now create the nodes for subfolders of the parent folder |
252 | You can tell that it is a subfolder by tacking the mailbox delimiter |
253 | on the end of the $folder_name string, and compare to that. */ |
254 | foreach($boxes as $box) { |
255 | if (substr($box['unformatted'], 0, strlen($folder_name_no_dm . $delimiter)) == ($folder_name_no_dm . $delimiter)) { |
256 | addChildNodeToTree($box['unformatted'], $box['unformatted-dm'], $foldersTree); |
257 | } |
258 | } |
259 | |
260 | /** Lets start removing the folders and messages **/ |
261 | if (($move_to_trash == true) && ($can_move_to_trash == true)) { /** if they wish to move messages to the trash **/ |
262 | walkTreeInPostOrderCreatingFoldersUnderTrash(0, $imapConnection, $foldersTree, $folder_name); |
263 | walkTreeInPreOrderDeleteFolders(0, $imapConnection, $foldersTree); |
264 | } else { /** if they do NOT wish to move messages to the trash (or cannot)**/ |
265 | walkTreeInPreOrderDeleteFolders(0, $imapConnection, $foldersTree); |
266 | } |
267 | |
268 | return; |
269 | } |
270 | |
271 | /** |
272 | * Given an array of folder_names, subscribes to each of them. |
273 | */ |
274 | function folders_subscribe($imapConnection, $folder_names) |
275 | { |
9829e1d8 |
276 | global $color, $oTemplate; |
32aa0074 |
277 | |
278 | if (count($folder_names) == 0 || $folder_names[0] == '') { |
279 | plain_error_message(_("You have not selected a folder to subscribe. Please do so."). |
280 | '<br /><a href="../src/folders.php">'._("Click here to go back").'</a>.', $color); |
281 | sqimap_logout($imapConnection); |
9829e1d8 |
282 | $oTemplate->display('footer.tpl'); |
32aa0074 |
283 | exit; |
284 | } |
285 | |
286 | global $no_list_for_subscribe, $imap_server_type; |
287 | |
288 | if($no_list_for_subscribe && $imap_server_type == 'cyrus') { |
289 | /* Cyrus, atleast, does not typically allow subscription to |
290 | * nonexistent folders (this is an optional part of IMAP), |
291 | * lets catch it here and report back cleanly. */ |
292 | if(!sqimap_mailbox_exists($imapConnection, $folder_names[0])) { |
293 | plain_error_message(_("Subscription Unsuccessful - Folder does not exist."). |
294 | '<br /><a href="../src/folders.php">'._("Click here to go back").'</a>.', $color); |
295 | sqimap_logout($imapConnection); |
296 | exit; |
f8a1ed5a |
297 | |
32aa0074 |
298 | } |
299 | } |
300 | foreach ( $folder_names as $folder_name ) { |
301 | sqimap_subscribe ($imapConnection, $folder_name); |
302 | } |
303 | |
304 | return; |
305 | } |
306 | |
307 | /** |
308 | * Given a list of folder names, unsubscribes from each of them. |
309 | */ |
310 | function folders_unsubscribe($imapConnection, $folder_names) |
311 | { |
9829e1d8 |
312 | global $color, $oTemplate; |
32aa0074 |
313 | |
314 | if (count($folder_names) == 0 || $folder_names[0] == '') { |
315 | plain_error_message(_("You have not selected a folder to unsubscribe. Please do so."). |
316 | '<br /><a href="../src/folders.php">'._("Click here to go back").'</a>.', $color); |
317 | sqimap_logout($imapConnection); |
9829e1d8 |
318 | $oTemplate->display('footer.tpl'); |
32aa0074 |
319 | exit; |
320 | } |
321 | |
322 | foreach ( $folder_names as $folder_name ) { |
323 | sqimap_unsubscribe ($imapConnection, $folder_name); |
324 | } |
325 | |
326 | return; |
327 | } |