X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Ffolders.php;h=ef7623b6c2c6645fe54020727da3a38d88105d00;hp=3f4936df3ada6676f1f7d9362d7383c1ee6a79a3;hb=c4faef335b2362c81b8ebf026d4066c12d70536c;hpb=52ed2f8826e0497d4683280183feb98f805a78e4

diff --git a/src/folders.php b/src/folders.php
index 3f4936df..ef7623b6 100644
--- a/src/folders.php
+++ b/src/folders.php
@@ -1,320 +1,220 @@
 <?php
-
 /**
  * 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-2020 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
-require_once('../src/validate.php');
-require_once('../functions/imap_utf7_decode_local.php');
-require_once('../functions/imap.php');
-require_once('../functions/array.php');
-require_once('../functions/plugin.php');
-require_once('../functions/html.php');
-
-displayPageHeader($color, 'None');
-
-echo '<br>' .
-    html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="2" cellspacing="0" border="0"' ) .
-        html_tag( 'tr' ) .
-            html_tag( 'td', '', 'center' ) . '<b>' . _("Folders") . '</b>' .
-                html_tag( 'table', '', 'center', '', 'width="100%" cellpadding="5" cellspacing="0" border="0"' ) .
-                    html_tag( 'tr' ) .
-                        html_tag( 'td', '', 'center', $color[4] );
-
-if ((isset($success) && $success) ||
-    (isset($sent_create) && $sent_create == 'true') ||
-    (isset($trash_create) && $trash_create == 'true')) {
-    if ($success == "subscribe") {
-        $td_str = "<b>" . _("Subscribed successfully!") . "</b><br>";
-    } else if ($success == "unsubscribe") {
-        $td_str = "<b>" . _("Unsubscribed successfully!") . "</b><br>";
-    } else if ($success == "delete") {
-        $td_str = "<b>" . _("Deleted folder successfully!") . "</b><br>";
-    } else if ($success == "create") {
-        $td_str = "<b>" . _("Created folder successfully!") . "</b><br>";
-    } else if ($success == "rename") {
-        $td_str = "<b>" . _("Renamed successfully!") . "</b><br>";
-    } else if ($success == "subscribe-doesnotexist") {
-        $td_str = "<b>" .
-                  _("Subscription Unsuccessful - Folder does not exist.") .
-                  "</b><br>";
-    }
+/** This is the folders page */
+define('PAGE_NAME', 'folders');
 
-    echo html_tag( 'table',
-                html_tag( 'tr',
-                     html_tag( 'td', $td_str .
-                               "<a href=\"../src/left_main.php\" target=left>" . _("refresh folder list") . "</a>" ,
-                     'center' )
-                ) ,
-            'center', '', 'width="100%" cellpadding="4" cellspacing="0" border="0"' ) . "<br>\n";
-} else {
-    echo "<br>";
-}
-$imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
-$boxes = sqimap_mailbox_list($imapConnection);
+/**
+ * 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);
+
+/* get globals we may need */
+sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
+sqgetGlobalVar('smaction', $action, SQ_POST);
+sqgetGlobalVar('smtoken', $submitted_token, SQ_POST, '');
+
+/* end of get globals */
+
+global $imap_stream_options; // in case not defined in config
+$imapConnection = sqimap_login ($username, false, $imapServerAddress, $imapPort, 0, $imap_stream_options);
+
+/* switch to the right function based on what the user selected */
+if ( sqgetGlobalVar('smaction', $action, SQ_POST) ) {
+    switch ($action)
+    {
+        case 'create':
+
+            // first, validate security token
+            sm_validate_security_token($submitted_token, -1, TRUE);
+
+            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 {
+
+                // first, validate security token
+                sm_validate_security_token($submitted_token, -1, TRUE);
+
+                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) ) {
 
-/** CREATING FOLDERS **/
-echo html_tag( 'table', '', 'center', '', 'width="70%" cols="1" cellpadding="4" cellspacing="0" border="0"' ) .
-            html_tag( 'tr',
-                html_tag( 'td', '<b>' . _("Create Folder") . '</b>', 'center', $color[9] )
-            ) .
-            html_tag( 'tr' ) .
-                html_tag( 'td', '', 'center', $color[0] ) .
-
-     "<FORM NAME=cf ACTION=\"folders_create.php\" METHOD=\"POST\">\n".
-     "<input type=TEXT SIZE=25 NAME=folder_name><BR>\n".
-     _("as a subfolder of").
-     "<BR>".
-     "<TT><SELECT NAME=subfolder>\n";
-if ($default_sub_of_inbox == false) {
-    echo '<OPTION SELECTED VALUE="">[ '._("None")." ]\n";
-} else {
-    echo '<OPTION VALUE="">[ '._("None")." ]\n";
-}
+                // first, validate security token
+                sm_validate_security_token($submitted_token, -1, TRUE);
 
-for ($i = 0; $i < count($boxes); $i++) {
-    if (!in_array('noinferiors', $boxes[$i]['flags'])) {
-        if ((strtolower($boxes[$i]['unformatted']) == 'inbox') &&
-            $default_sub_of_inbox) {
-
-            $box = $boxes[$i]['unformatted'];
-            $box2 = str_replace(' ', '&nbsp;',
-                                imap_utf7_decode_local($boxes[$i]['unformatted-disp']));
-            echo "<OPTION SELECTED VALUE=\"$box\">$box2</option>\n";
-        } else {
-            $box = $boxes[$i]['unformatted'];
-            $box2 = str_replace(' ', '&nbsp;',
-                                imap_utf7_decode_local($boxes[$i]['unformatted-disp'])); 
-            if (strtolower($imap_server_type) != 'courier' ||
-                  strtolower($box) != "inbox.trash")
-                echo "<OPTION VALUE=\"$box\">$box2</option>\n";
-        }
+                folders_delete_do($imapConnection, $delimiter, $folder_name);
+                $td_str =  _("Deleted folder successfully.");
+            } else {
+                folders_delete_ask($imapConnection, $folder_name);
+            }
+            break;
+        case 'subscribe':
+
+            // first, validate security token
+            sm_validate_security_token($submitted_token, -1, TRUE);
+
+            sqgetGlobalVar('folder_names',  $folder_names,  SQ_POST);
+            folders_subscribe($imapConnection, $folder_names);
+            $td_str =  _("Subscribed successfully.");
+            break;
+        case 'unsubscribe':
+
+            // first, validate security token
+            sm_validate_security_token($submitted_token, -1, TRUE);
+
+            sqgetGlobalVar('folder_names',  $folder_names,  SQ_POST);
+            folders_unsubscribe($imapConnection, $folder_names);
+            $td_str =  _("Unsubscribed successfully.");
+            break;
+        default:
+// TODO: this is a new hook for plugin action processing that has not been TESTED.
+            $td_str = do_hook('folder_action', $action);
+            break;
     }
+
 }
-echo "</SELECT></TT>\n";
-if ($show_contain_subfolders_option) {
-    echo "<br><input type=CHECKBOX NAME=\"contain_subs\"> &nbsp;";
-    echo _("Let this folder contain subfolders");
-    echo "<BR>";
+
+if (isset($td_str)) {
+    $oTemplate->assign('note', sm_encode_html_special_chars($td_str));
+    $oTemplate->display('note.tpl');
 }
-echo "<input type=SUBMIT VALUE=\""._("Create")."\">\n";
-echo "</FORM></td></tr>\n";
 
-echo html_tag( 'tr',
-            html_tag( 'td', '&nbsp;', 'left', $color[4] )
-        ) ."\n";
+$boxes = sqimap_mailbox_list($imapConnection,true);
 
-/** count special folders **/
-$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++;
-}
+/** CREATING FOLDERS **/
 
+$show_selected = array();
+$skip_folders = array();
+$server_type = strtolower($imap_server_type);
 
-/** RENAMING FOLDERS **/
-echo html_tag( 'tr',
-            html_tag( 'td', '<b>' . _("Rename a Folder") . '</b>', 'center', $color[9] )
-        ) .
-        html_tag( 'tr' ) .
-        html_tag( 'td', '', 'center', $color[0] );
-
-if ($count_special_folders < count($boxes)) {
-    echo "<FORM ACTION=\"folders_rename_getname.php\" METHOD=\"POST\">\n"
-       . "<TT><SELECT NAME=old>\n"
-       . '         <OPTION VALUE="">[ ' . _("Select a folder") . " ]</OPTION>\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(' ', '&nbsp;',
-                                imap_utf7_decode_local($boxes[$i]['unformatted-disp']));
-            if (strtolower($imap_server_type) != 'courier' || strtolower($box) != 'inbox.trash') {
-                echo "<OPTION VALUE=\"$box\">$box2</option>\n";
-            }
-        }
+// Special handling for courier
+if ( $server_type == 'courier' ) {
+    if ( $default_folder_prefix == 'INBOX.' ) {
+        // We don't need INBOX, since it is top folder
+        array_push($skip_folders, 'INBOX');
     }
-    echo "</SELECT></TT>\n".
-         "<input type=SUBMIT VALUE=\"".
-         _("Rename").
-         "\">\n".
-         "</FORM></td></tr>\n";
-} else {
-    echo _("No folders found") . "<br><br></td></tr>";
-}
-$boxes_sub = $boxes;
-
-echo html_tag( 'tr',
-            html_tag( 'td', '&nbsp;', 'left', $color[4] )
-        ) ."\n";
-
-/** DELETING FOLDERS **/
-echo html_tag( 'tr',
-            html_tag( 'td', '<b>' . _("Delete Folder") . '</b>', 'center', $color[9] )
-        ) .
-        html_tag( 'tr' ) .
-        html_tag( 'td', '', 'center', $color[0] );
-
-if ($count_special_folders < count($boxes)) {
-    echo "<FORM ACTION=\"folders_delete.php\" METHOD=\"POST\">\n"
-       . "<TT><SELECT NAME=mailbox>\n"
-       . '         <OPTION VALUE="">[ ' . _("Select a folder") . " ]</OPTION>\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) &&
-            (!in_array('noselect', $boxes[$i]['flags'])) &&
-            ((strtolower($imap_server_type) != 'courier') ||
-             (strtolower($boxes[$i]['unformatted']) != 'inbox.trash'))) {
-            $box = $boxes[$i]['unformatted-dm'];
-            $box2 = str_replace(' ', '&nbsp;',
-                                imap_utf7_decode_local($boxes[$i]['unformatted-disp']));
-            echo "         <OPTION VALUE=\"$box\">$box2</option>\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 _("Delete");
-    echo "\">\n";
-    echo "</form></td></tr>\n";
-} else {
-    echo _("No folders found") . "<br><br></td></tr>";
 }
 
-echo html_tag( 'tr',
-            html_tag( 'td', '&nbsp;', 'left', $color[4] )
-        ) ."</table>\n";
-
-
-/** UNSUBSCRIBE FOLDERS **/
-echo html_tag( 'table', '', 'center', '', 'width="70%" cols="2" cellpadding="4" cellspacing="0" border="0"' ) .
-            html_tag( 'tr',
-                html_tag( 'td', '<b>' . _("Unsubscribe") . '/' . _("Subscribe") . '</b>', 'center', $color[9], 'colspan="2"' )
-            ) .
-            html_tag( 'tr' ) .
-                html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
-
-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(' ', '&nbsp;',
-                                imap_utf7_decode_local($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";
+if ( $default_sub_of_inbox == false ) {
+    $mbx_option_list = '<option selected="selected" value="">[ '._("None")." ]</option>\n";
 } else {
-    echo _("No folders were found to unsubscribe from!") . "</td>";
+    $mbx_option_list = '<option value="">[ '._("None")." ]</option>\n";
+    $show_selected = array('inbox');
 }
-$boxes_sub = $boxes;
-
-/** SUBSCRIBE TO FOLDERS **/
-echo html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
-if(!$no_list_for_subscribe) {
-  $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] = imap_utf7_decode_local($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'],false) &&
+        ! 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>";
-  }
-} else {
-  /* don't perform the list action -- this is much faster */
-  echo "<FORM ACTION=\"folders_subscribe.php?method=sub\" METHOD=\"POST\">\n";
-  echo _("Subscribe to:") . "<br>";
-  echo "<tt><input type=\"text\" name=\"mailbox[]\" size=35>";
-  echo "<INPUT TYPE=SUBMIT VALUE=\"". _("Subscribe") . "\">\n";
-  echo "</FORM></TD></TR></TABLE><BR>\n";
 }
 
-do_hook("folders_bottom");
-?>
+/**
+ * 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);
 
 
-    </td></tr>
-    </table>
+$subbox_option_list = array();
 
-</td></tr>
-</table>
+if ($show_only_subscribed_folders && !$no_list_for_subscribe) {
+    // FIXME: fix subscription options when top folder is not subscribed and sub folder is subscribed
 
-<?php
-   sqimap_logout($imapConnection);
-?>
+    // TODO: use checkboxes instead of select options.
+    // DONE Steve Brown 2006-08-08
+
+    /** SUBSCRIBE TO FOLDERS **/
+    $boxes_all = sqimap_mailbox_list_all ($imapConnection);
+
+    // here we filter out all boxes we're already subscribed to,
+    // so we keep only the unsubscribed ones.
+    foreach ($boxes_all as $box_a) {
+
+    	$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  = sm_encode_html_special_chars($box_a['unformatted-dm']);
+    	    $box_disp = sm_encode_html_special_chars(imap_utf7_decode_local($box_a['unformatted-disp']));
+            $subbox_option_list[] = array( 'Value' => $box_enc, 'Display' => $box_disp);
+    	}
+    }
+}
+
+sqimap_logout($imapConnection);
+
+$oTemplate->assign('show_subfolders_option', $show_contain_subfolders_option);
+$oTemplate->assign('show_only_subscribed_folders', $show_only_subscribed_folders==1);
+$oTemplate->assign('no_list_for_subscribe', $no_list_for_subscribe);
+
+$oTemplate->assign('mbx_option_list', $mbx_option_list);
+$oTemplate->assign('rendel_folder_list', $rendel_folder_list);
+$oTemplate->assign('subbox_option_list', $subbox_option_list);
+
+$oTemplate->display('folder_manip.tpl');
 
-</body></html>
+$oTemplate->display('footer.tpl');