Stream options were forgot here
[squirrelmail.git] / src / folders.php
index 7dc1947d8198259084b6b62324cbb5f65587a7bb..e0aab0643ae44be00259b0451bd3c507723834a3 100644 (file)
-<HTML><BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000EE" VLINK="#0000EE" ALINK="#0000EE">
-<?
-   function getBoxForCreate($mailbox) {
-      if (substr($mailbox, 0, 6) == "INBOX.")
-         $box = substr($mailbox, 6, strlen($mailbox));
-      else
-         $box = $mailbox;
-
-      return $box;
-   }
-
-   include("../config/config.php");
-   include("../functions/strings.php");
-   include("../functions/page_header.php");
-   include("../functions/imap.php");
-
-   displayPageHeader("None");
-
-   echo "<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>\n";
-   echo "   <TR><TD BGCOLOR=DCDCDC ALIGN=CENTER>\n";
-   echo "      <FONT FACE=\"Arial,Helvetica\">Folders</FONT>\n";
-   echo "   </TD></TR>\n";
-   echo "</TABLE>\n";
-
-   $imapConnection = fsockopen($imapServerAddress, 143, &$errorNumber, &$errorString);
-   if (!$imapConnection) {
-      echo "Error connecting to IMAP Server.<br>";
-      echo "$errorNumber : $errorString<br>";
-      exit;
-   }
-   $serverInfo = fgets($imapConnection, 256);
-
-   fputs($imapConnection, "1 login $username $key\n");
-   $read = fgets($imapConnection, 1024);
-
-   fputs($imapConnection, "1 list \"\" *\n");
-   $str = imapReadData($imapConnection);
-
-   for ($i = 0;$i < count($str); $i++) {
-      $mailbox = Chop($str[$i]);
-      // find the quote at the begining of the mailbox name.
-      //    i subtract 1 from the strlen so it doesn't find the quote at the end of the mailbox name.
-      $mailbox = findMailboxName($mailbox);
-      $periodCount = countCharInString($mailbox, ".");
-
-      // indent the correct number of spaces.
-      for ($j = 0;$j < $periodCount;$j++)
-         $boxes[$i] = "$boxes[$i]&nbsp;&nbsp;&nbsp;";
-
-      $boxes[$i] = $boxes[$i] . readShortMailboxName($mailbox, ".");
-      $long_name_boxes[$i] = $mailbox;
-   }
-
-   /** DELETING FOLDERS **/
-   echo "<FORM ACTION=folders_delete.php METHOD=POST>\n";
-   echo "<SELECT NAME=folder_list><FONT FACE=\"Arial,Helvetica\">\n";
-   for ($i = 0; $i < count($str); $i++) {
-      $use_folder = true;
-      for ($p = 0; $p < count($special_folders); $p++) {
-         if ($special_folders[$p] == $long_name_boxes[$i])
-            $use_folder = false;
-      }
-      if ($use_folder == true)
-         echo "   <OPTION>$boxes[$i]\n";
-   }
-   echo "</SELECT>\n";
-   echo "<INPUT TYPE=SUBMIT VALUE=Delete>\n";
-   echo "</FORM><BR>\n";
-
-   /** CREATING FOLDERS **/
-   echo "<FORM ACTION=folders_create.php METHOD=POST>\n";
-   echo "<INPUT TYPE=TEXT SIZE=25 NAME=folder_name>\n";
-   echo "&nbsp;&nbsp;as a subfolder of&nbsp;&nbsp;";
-   echo "<SELECT NAME=subfolder><FONT FACE=\"Arial,Helvetica\">\n";
-   for ($i = 0;$i < count($str); $i++) {
-      $thisbox = Chop($str[$i]);
-      $thisbox = findMailboxName($thisbox);
-      $thisbox = getBoxForCreate($thisbox);
-      echo "<OPTION>$thisbox\n";
-   }
-   echo "</SELECT>\n";
-   echo "<INPUT TYPE=SUBMIT VALUE=Create>\n";
-   echo "</FORM><BR>\n";
-
-   /** RENAMING FOLDERS **/
-   echo "<FORM ACTION=folders_rename.php METHOD=POST>\n";
-   echo "<SELECT NAME=folder_list><FONT FACE=\"Arial,Helvetica\">\n";
-   for ($i = 0; $i < count($str); $i++) {
-      $use_folder = true;
-      for ($p = 0; $p < count($special_folders); $p++) {
-         if ($special_folders[$p] == $long_name_boxes[$i])
-            $use_folder = false;
-      }
-      if ($use_folder == true)
-         echo "   <OPTION>$boxes[$i]\n";
-   }
-   echo "</SELECT>\n";
-   echo "<INPUT TYPE=TEXT SIZE=25 NAME=new_folder_name>\n";
-   echo "<INPUT TYPE=SUBMIT VALUE=Rename>\n";
-   echo "</FORM><BR>\n";
-
-?>
-</BODY></HTML>
\ No newline at end of file
+<?php
+/**
+ * folders.php
+ *
+ * Handles all interaction between the user and the other folder
+ * scripts which do most of the work. Also handles the Special
+ * Folders.
+ *
+ * @copyright 1999-2018 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+/** This is the folders page */
+define('PAGE_NAME', 'folders');
+
+/**
+ * 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) ) {
+
+                // first, validate security token
+                sm_validate_security_token($submitted_token, -1, TRUE);
+
+                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;
+    }
+
+}
+
+if (isset($td_str)) {
+    $oTemplate->assign('note', sm_encode_html_special_chars($td_str));
+    $oTemplate->display('note.tpl');
+}
+
+$boxes = sqimap_mailbox_list($imapConnection,true);
+
+/** CREATING FOLDERS **/
+
+$show_selected = array();
+$skip_folders = array();
+$server_type = strtolower($imap_server_type);
+
+// 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');
+    }
+} elseif ( $server_type == 'bincimap' ) {
+    if ( $default_folder_prefix == 'INBOX/' ) {
+        // We don't need INBOX, since it is top folder
+        array_push($skip_folders, 'INBOX');
+    }
+}
+
+if ( $default_sub_of_inbox == false ) {
+    $mbx_option_list = '<option selected="selected" value="">[ '._("None")." ]</option>\n";
+} else {
+    $mbx_option_list = '<option value="">[ '._("None")." ]</option>\n";
+    $show_selected = array('inbox');
+}
+
+// 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'];
+    }
+}
+
+/**
+ * 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);
+
+
+$subbox_option_list = array();
+
+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.
+    // 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');
+
+$oTemplate->display('footer.tpl');