/**
* folders.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
* Handles all interaction between the user and the other folder
* scripts which do most of the work. Also handles the Special
* Folders.
*
- * $Id$
+ * @copyright © 1999-2006 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
*/
-/*****************************************************************/
-/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/
-/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/
-/*** + Base level indent should begin at left margin, as ***/
-/*** the require_once below looks. ***/
-/*** + All identation should consist of four space blocks ***/
-/*** + Tab characters are evil. ***/
-/*** + all comments should use "slash-star ... star-slash" ***/
-/*** style -- no pound characters, no slash-slash style ***/
-/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/
-/*** ALWAYS USE { AND } CHARACTERS!!! ***/
-/*** + Please use ' instead of ", when possible. Note " ***/
-/*** should always be used in _( ) function calls. ***/
-/*** Thank you for your help making the SM code more readable. ***/
-/*****************************************************************/
-
-require_once('../src/validate.php');
-require_once('../functions/imap.php');
-require_once('../functions/array.php');
-require_once('../functions/plugin.php');
+/**
+ * Include the SquirrelMail initialization file.
+ */
+require('../include/init.php');
+
+/* SquirrelMail required files. */
+require_once(SM_PATH . 'functions/imap_general.php');
+require_once(SM_PATH . 'functions/folder_manip.php');
+require_once(SM_PATH . 'functions/forms.php');
displayPageHeader($color, 'None');
-?>
+/* get globals we may need */
-<br>
-<table bgcolor="<?php echo $color[0] ?>" width="95%" align="center" cellpadding="2" cellspacing="0" border="0">
-<tr><td align="center">
+sqgetGlobalVar('username', $username, SQ_SESSION);
+sqgetGlobalVar('key', $key, SQ_COOKIE);
+sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
+sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
- <b><?php echo _("Folders"); ?></b>
+sqgetGlobalVar('smaction', $action, SQ_POST);
- <table width="100%" border="0" cellpadding="5" cellspacing="0">
- <tr><td bgcolor="<?php echo $color[4] ?>" align="center">
+/* end of get globals */
-<?php
+$imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
-if ((isset($success) && $success) ||
- (isset($sent_create) && $sent_create == "true") ||
- (isset($trash_create) && $trash_create == "true")) {
- echo "<table width=\"100%\" align=center cellpadding=4 cellspacing=0 border=0>\n";
- echo " <tr><td align=center>\n";
- if ($success == "subscribe") {
- echo "<b>" . _("Subscribed successfully!") . "</b><br>";
- } else if ($success == "unsubscribe") {
- echo "<b>" . _("Unsubscribed successfully!") . "</b><br>";
- } else if ($success == "delete") {
- echo "<b>" . _("Deleted folder successfully!") . "</b><br>";
- } else if ($success == "create") {
- echo "<b>" . _("Created folder successfully!") . "</b><br>";
- } else if ($success == "rename") {
- echo "<b>" . _("Renamed successfully!") . "</b><br>";
+/* switch to the right function based on what the user selected */
+if ( sqgetGlobalVar('smaction', $action, SQ_POST) ) {
+
+ switch ($action)
+ {
+ case 'create':
+ sqgetGlobalVar('folder_name', $folder_name, SQ_POST);
+ sqgetGlobalVar('subfolder', $subfolder, SQ_POST);
+ sqgetGlobalVar('contain_subs', $contain_subs, SQ_POST);
+ folders_create($imapConnection, $delimiter, $folder_name, $subfolder, $contain_subs);
+ $td_str = _("Created folder successfully.");
+ break;
+ case 'rename':
+ if ( sqgetGlobalVar('cancelbutton', $dummy, SQ_POST) ) {
+ break;
+ }
+ if ( ! sqgetGlobalVar('new_name', $new_name, SQ_POST) ) {
+ sqgetGlobalVar('old_name', $old_name, SQ_POST);
+ folders_rename_getname($imapConnection, $delimiter, $old_name);
+ } else {
+ sqgetGlobalVar('orig', $orig, SQ_POST);
+ sqgetGlobalVar('old_name', $old_name, SQ_POST);
+ folders_rename_do($imapConnection, $delimiter, $orig, $old_name, $new_name);
+ $td_str = _("Renamed successfully.");
+ }
+ break;
+ case 'delete':
+ if ( sqgetGlobalVar('cancelbutton', $dummy, SQ_POST) ) {
+ break;
+ }
+ sqgetGlobalVar('folder_name', $folder_name, SQ_POST);
+ if ( sqgetGlobalVar('confirmed', $dummy, SQ_POST) ) {
+ folders_delete_do($imapConnection, $delimiter, $folder_name);
+ $td_str = _("Deleted folder successfully.");
+ } else {
+ folders_delete_ask($imapConnection, $folder_name);
+ }
+ break;
+ case 'subscribe':
+ sqgetGlobalVar('folder_names', $folder_names, SQ_POST);
+ folders_subscribe($imapConnection, $folder_names);
+ $td_str = _("Subscribed successfully.");
+ break;
+ case 'unsubscribe':
+ sqgetGlobalVar('folder_names', $folder_names, SQ_POST);
+ folders_unsubscribe($imapConnection, $folder_names);
+ $td_str = _("Unsubscribed successfully.");
+ break;
+ default:
+ // TODO: add hook for plugin action processing.
+ $td_str = '';
+ break;
}
- echo " <a href=\"../src/left_main.php\" target=left>" . _("refresh folder list") . "</a>";
- echo " </td></tr>\n";
- echo "</table><br>\n";
-} else {
- echo "<br>";
}
-$imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
-$boxes = sqimap_mailbox_list($imapConnection);
+
+$boxes = sqimap_mailbox_list($imapConnection,true);
/** CREATING FOLDERS **/
-echo "<TABLE WIDTH=\"70%\" COLS=1 ALIGN=CENTER cellpadding=4 cellspacing=0 border=0>\n";
-
-echo "<TR><TD BGCOLOR=\"$color[9]\" ALIGN=CENTER><B>";
-echo _("Create Folder");
-echo "</B></TD></TR>";
-echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>";
-echo "<FORM NAME=cf ACTION=\"folders_create.php\" METHOD=\"POST\">\n";
-echo "<INPUT TYPE=TEXT SIZE=25 NAME=folder_name><BR>\n";
-echo _("as a subfolder of");
-echo "<BR>";
-echo "<TT><SELECT NAME=subfolder>\n";
-if ($default_sub_of_inbox == false) {
- echo '<OPTION SELECTED VALUE="">[ '._("None")." ]\n";
-} else {
- echo '<OPTION VALUE="">[ '._("None")." ]\n";
-}
-for ($i = 0; $i < count($boxes); $i++) {
- if (!in_array('noinferiors', $boxes[$i]['flags'])) {
- if ((strtolower($boxes[$i]["unformatted"]) == "inbox") && ($default_sub_of_inbox == true)) {
- $box = $boxes[$i]["unformatted"];
- $box2 = str_replace(' ', ' ', $boxes[$i]["unformatted-disp"]);
- echo "<OPTION SELECTED VALUE=\"$box\">$box2\n";
- } else {
- $box = $boxes[$i]["unformatted"];
- $box2 = str_replace(' ', ' ', $boxes[$i]["unformatted-disp"]);
- if (strtolower($imap_server_type) != "courier" ||
- strtolower($box) != "inbox.trash")
- echo "<OPTION VALUE=\"$box\">$box2\n";
- }
+$show_selected = array();
+$skip_folders = array();
+$server_type = strtolower($imap_server_type);
+
+// Special handling for courier
+if ( $server_type == 'courier' ) {
+ /**
+ * If we use courier, we should hide system trash folder
+ * FIXME: (tokul) Who says that courier does not allow storing folders in
+ * INBOX.Trash or inbox.trash? Can't reproduce it 3.0.8. This entry is
+ * useless, because in_array() check is case sensitive and INBOX is in
+ * upper case.
+ */
+ array_push($skip_folders, 'inbox.trash');
+
+ if ( $default_folder_prefix == 'INBOX.' ) {
+ // We don't need INBOX, since it is top folder
+ array_push($skip_folders, 'INBOX');
}
-}
-echo "</SELECT></TT>\n";
-if ($show_contain_subfolders_option) {
- echo "<br><INPUT TYPE=CHECKBOX NAME=\"contain_subs\"> ";
- echo _("Let this folder contain subfolders");
- echo "<BR>";
-}
-echo "<INPUT TYPE=SUBMIT VALUE=\""._("Create")."\">\n";
-echo "</FORM></TD></TR>\n";
-
-echo "<tr><td bgcolor=\"$color[4]\"> </td></tr>\n";
-
-/** RENAMING FOLDERS **/
-echo "<TR><TD BGCOLOR=\"$color[9]\" ALIGN=CENTER><B>";
-echo _("Rename a Folder");
-echo "</B></TD></TR>";
-echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>";
-if ($count_special_folders < count($boxes)) {
- echo "<FORM ACTION=\"folders_rename_getname.php\" METHOD=\"POST\">\n";
- echo "<TT><SELECT NAME=old>\n";
- for ($i = 0; $i < count($boxes); $i++) {
- $use_folder = true;
-
- if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
- ($boxes[$i]["unformatted"] != $trash_folder) &&
- ($boxes[$i]["unformatted"] != $sent_folder) &&
- ($boxes[$i]["unformatted"] != $draft_folder)) {
- $box = $boxes[$i]["unformatted-dm"];
- $box2 = str_replace(' ', ' ', $boxes[$i]["unformatted-disp"]);
- if (strtolower($imap_server_type) != "courier" || strtolower($box) != "inbox.trash")
- echo "<OPTION VALUE=\"$box\">$box2\n";
- }
+} elseif ( $server_type == 'bincimap' ) {
+ if ( $default_folder_prefix == 'INBOX/' ) {
+ // We don't need INBOX, since it is top folder
+ array_push($skip_folders, 'INBOX');
}
- echo "</SELECT></TT>\n";
- echo "<INPUT TYPE=SUBMIT VALUE=\"";
- echo _("Rename");
- echo "\">\n";
- echo "</FORM></TD></TR>\n";
-} else {
- echo _("No folders found") . "<br><br></td></tr>";
-}
-$boxes_sub = $boxes;
-
-echo "<tr><td bgcolor=\"$color[4]\"> </td></tr>\n";
-
-/** DELETING FOLDERS **/
-echo "<TR><TD BGCOLOR=\"$color[9]\" ALIGN=CENTER><B>";
-echo _("Delete Folder");
-echo "</B></TD></TR>";
-echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>";
-
-$count_special_folders = 0;
- $num_max = 1;
- if (strtolower($imap_server_type) == "courier" || $move_to_trash)
- $num_max++;
- if ($move_to_sent)
- $num_max++;
- if ($save_as_draft)
- $num_max++;
-
-for ($p = 0; $p < count($boxes) && $count_special_folders < $num_max; $p++) {
- if (strtolower($boxes[$p]["unformatted"]) == "inbox")
- $count_special_folders++;
- else if (strtolower($imap_server_type) == "courier" &&
- strtolower($boxes[$p]["unformatted"]) == "inbox.trash")
- $count_special_folders++;
- else if ($boxes[$p]["unformatted"] == $trash_folder && $trash_folder)
- $count_special_folders++;
- else if ($boxes[$p]["unformatted"] == $sent_folder && $sent_folder)
- $count_special_folders++;
- else if ($boxes[$p]["unformatted"] == $draft_folder && $draft_folder)
- $count_special_folders++;
}
-if ($count_special_folders < count($boxes)) {
- echo "<FORM ACTION=\"folders_delete.php\" METHOD=\"POST\">\n";
- echo "<TT><SELECT NAME=mailbox>\n";
- for ($i = 0; $i < count($boxes); $i++) {
- $use_folder = true;
- if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
- ($boxes[$i]["unformatted"] != $trash_folder) &&
- ($boxes[$i]["unformatted"] != $sent_folder) &&
- ($boxes[$i]["unformatted"] != $draft_folder) &&
- ((strtolower($imap_server_type) != "courier") ||
- (strtolower($boxes[$i]["unformatted"]) != "inbox.trash"))) {
- $box = $boxes[$i]["unformatted-dm"];
- $box2 = str_replace(' ', ' ', $boxes[$i]["unformatted-disp"]);
- echo " <OPTION VALUE=\"$box\">$box2\n";
- }
- }
- echo "</SELECT></TT>\n";
- echo "<INPUT TYPE=SUBMIT VALUE=\"";
- echo _("Delete");
- echo "\">\n";
- echo "</FORM></TD></TR>\n";
+if ( $default_sub_of_inbox == false ) {
+ $mbx_option_list = '<option selected="selected" value="">[ '._("None")." ]</option>\n";
} else {
- echo _("No folders found") . "<br><br></td><tr>";
+ $mbx_option_list = '<option value="">[ '._("None")." ]</option>\n";
+ $show_selected = array('inbox');
}
-echo "<tr><td bgcolor=\"$color[4]\"> </td></tr></table>\n";
-
-/** UNSUBSCRIBE FOLDERS **/
-echo "<TABLE WIDTH=\"70%\" COLS=2 ALIGN=CENTER cellpadding=4 cellspacing=0 border=0>\n";
-echo "<TR><TD BGCOLOR=\"$color[9]\" ALIGN=CENTER colspan=2><B>";
-echo _("Unsubscribe") . "/" . _("Subscribe");
-echo "</B></TD></TR>\n";
-echo "<TR><TD BGCOLOR=\"$color[0]\" width=\"50%\" ALIGN=CENTER>\n";
-if ($count_special_folders < count($boxes)) {
- echo "<FORM ACTION=\"folders_subscribe.php?method=unsub\" METHOD=\"POST\">\n";
- echo "<TT><SELECT NAME=\"mailbox[]\" multiple size=8>\n";
- for ($i = 0; $i < count($boxes); $i++) {
- $use_folder = true;
- if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
- ($boxes[$i]["unformatted"] != $trash_folder) &&
- ($boxes[$i]["unformatted"] != $sent_folder) &&
- ($boxes[$i]["unformatted"] != $draft_folder)) {
- $box = $boxes[$i]["unformatted-dm"];
- $box2 = str_replace(' ', ' ', $boxes[$i]["unformatted-disp"]);
- echo " <OPTION VALUE=\"$box\">$box2\n";
- }
- }
- echo "</SELECT></TT><br><br>\n";
- echo "<INPUT TYPE=SUBMIT VALUE=\"";
- echo _("Unsubscribe");
- echo "\">\n";
- echo "</FORM></TD>\n";
-} else {
- echo _("No folders were found to unsubscribe from!") . "</td>";
-}
-$boxes_sub = $boxes;
-
-/** SUBSCRIBE TO FOLDERS **/
-echo "<TD BGCOLOR=\"$color[0]\" width=\"50%\" ALIGN=CENTER>";
-$imap_stream = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 1);
-$boxes_all = sqimap_mailbox_list_all ($imap_stream);
-
-$box = "";
-$box2 = "";
-for ($i = 0, $q = 0; $i < count($boxes_all); $i++) {
- $use_folder = true;
- for ($p = 0; $p < count ($boxes); $p++) {
- if ($boxes_all[$i]["unformatted"] == $boxes[$p]["unformatted"]) {
- $use_folder = false;
- continue;
- } else if ($boxes_all[$i]["unformatted-dm"] == $folder_prefix) {
- $use_folder = false;
- }
- }
- if ($use_folder == true) {
- $box[$q] = $boxes_all[$i]["unformatted-dm"];
- $box2[$q] = $boxes_all[$i]["unformatted-disp"];
- $q++;
+
+// Call sqimap_mailbox_option_list, using existing connection to IMAP server,
+// the arrays of folders to include or skip (assembled above),
+// use 'noinferiors' as a mailbox filter to leave out folders that can not contain other folders.
+// use the long format to show subfolders in an intelligible way if parent is missing (special folder)
+$mbx_option_list .= sqimap_mailbox_option_list($imapConnection, $show_selected, $skip_folders, $boxes, 'noinferiors', true);
+
+
+/** count special folders **/
+foreach ($boxes as $index => $aBoxData) {
+ if (isSpecialMailbox($aBoxData['unformatted']) &&
+ ! in_array($aBoxData['unformatted'],$skip_folders)) {
+ $skip_folders[] = $aBoxData['unformatted'];
}
}
-sqimap_logout($imap_stream);
-
-if ($box && $box2) {
- echo "<FORM ACTION=\"folders_subscribe.php?method=sub\" METHOD=\"POST\">\n";
- echo "<tt><select name=\"mailbox[]\" multiple size=8>";
-
- for ($q = 0; $q < count($box); $q++) {
- echo " <OPTION VALUE=\"$box[$q]\">".$box2[$q]."\n";
- }
- echo "</select></tt><br><br>";
- echo "<INPUT TYPE=SUBMIT VALUE=\"". _("Subscribe") . "\">\n";
- echo "</FORM></TD></TR></TABLE><BR>\n";
-} else {
- echo _("No folders were found to subscribe to!") . "</td></tr></table>";
-}
-?>
+
+/**
+ * Retrieve list of folders when special folders are excluded. Special folders
+ * should be unavailable in rename/delete/unsubscribe. Theoretically user can
+ * modify form and perform these operations with special folders, but if user
+ * manages to delete/rename/unsubscribe special folder by hacking form...
+ *
+ * If script or program depends on special folder, they should not assume that
+ * folder is available.
+ *
+ * $filtered_folders contains empty string or html formated option list.
+ */
+$rendel_folder_list = sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
- <?php do_hook("folders_bottom"); ?>
+$subbox_option_list = '';
+if ($show_only_subscribed_folders && !$no_list_for_subscribe) {
+ // FIXME: fix subscription options when top folder is not subscribed and sub folder is subscribed
+ // TODO: use checkboxes instead of select options.
- </td></tr>
- </table>
+ /** SUBSCRIBE TO FOLDERS **/
+ $boxes_all = sqimap_mailbox_list_all ($imapConnection);
-</td></tr>
-</table>
+ // here we filter out all boxes we're already subscribed to,
+ // so we keep only the unsubscribed ones.
+ foreach ($boxes_all as $box_a) {
-<?php
- sqimap_logout($imapConnection);
-?>
+ $use_folder = true;
+ foreach ( $boxes as $box ) {
+ if ($box_a['unformatted'] == $box['unformatted'] ||
+ $box_a['unformatted-dm'] == $folder_prefix ) {
+ $use_folder = false;
+ }
+ }
+
+ if ($use_folder) {
+ $box_enc = htmlspecialchars($box_a['unformatted-dm']);
+ $box_disp = htmlspecialchars(imap_utf7_decode_local($box_a['unformatted-disp']));
+ $subbox_option_list .= '<option value="' . $box_enc . '">'.$box_disp."</option>\n";
+ }
+ }
+}
+
+sqimap_logout($imapConnection);
+
+$oTemplate->assign('td_str', @$td_str);
+$oTemplate->assign('color', $color);
+$oTemplate->assign('mbx_option_list', $mbx_option_list);
+$oTemplate->assign('show_contain_subfolders_option', $show_contain_subfolders_option);
+$oTemplate->assign('show_only_subscribed_folders', $show_only_subscribed_folders);
+$oTemplate->assign('rendel_folder_list', $rendel_folder_list);
+$oTemplate->assign('subbox_option_list', $subbox_option_list);
+$oTemplate->assign('no_list_for_subscribe', $no_list_for_subscribe);
+
+$oTemplate->display('folder_manip.tpl');
+
+$oTemplate->display('footer.tpl');
-</body></html>
projects / squirrelmail.git / blobdiff