Completely cleanup the folders management (create/subscribe etc) code.
[squirrelmail.git] / src / folders.php
index 73aa9eced00f28c73d57b399fa7ba5cbe64275ff..f34dc044639945a95e0ffdb98a2a0d910c200e98 100644 (file)
@@ -3,24 +3,30 @@
 /**
  * folders.php
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 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$
+ * @version $Id$
+ * @package squirrelmail
  */
 
-/* Path for SquirrelMail required files. */
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
 define('SM_PATH','../');
 
 /* SquirrelMail required files. */
 require_once(SM_PATH . 'include/validate.php');
 require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'functions/folder_manip.php');
 require_once(SM_PATH . 'functions/plugin.php');
 require_once(SM_PATH . 'functions/html.php');
+require_once(SM_PATH . 'functions/forms.php');
 
 displayPageHeader($color, 'None');
 
@@ -31,11 +37,11 @@ sqgetGlobalVar('key', $key, SQ_COOKIE);
 sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
 
-sqgetGlobalVar('success', $success, SQ_GET);
+sqgetGlobalVar('smaction', $action, SQ_POST);
 
 /* end of get globals */
 
-echo '<br>' .
+echo '<br />' .
     html_tag( 'table', '', 'center', $color[0], 'width="95%" cellpadding="1" cellspacing="0" border="0"' ) .
         html_tag( 'tr' ) .
             html_tag( 'td', '', 'center' ) . '<b>' . _("Folders") . '</b>' .
@@ -43,49 +49,71 @@ echo '<br>' .
                     html_tag( 'tr' ) .
                         html_tag( 'td', '', 'center', $color[4] );
 
-if ( isset($success) && $success ) {
+$imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
 
-    $td_str = '<b>';
+/* switch to the right function based on what the user selected */
+if ( sqgetGlobalVar('smaction', $action, SQ_POST) ) {
 
-    switch ($success)
+    switch ($action)
     {
-        case 'subscribe':
-            $td_str .=  _("Subscribed successfully!");
+        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 'unsubscribe':
-            $td_str .=  _("Unsubscribed successfully!");
+        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':
-            $td_str .=  _("Deleted folder successfully!");
-            break;
-        case 'create':
-            $td_str .=  _("Created folder successfully!");
+            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 'rename':
-            $td_str .=  _("Renamed successfully!");
+        case 'subscribe':
+            sqgetGlobalVar('folder_names',  $folder_names,  SQ_POST);
+            folders_subscribe($imapConnection, $folder_names);
+            $td_str =  _("Subscribed successfully.");
             break;
-        case 'subscribe-doesnotexist':
-            $td_str .=  _("Subscription Unsuccessful - Folder does not exist.");
+        case 'unsubscribe':
+            sqgetGlobalVar('folder_names',  $folder_names,  SQ_POST);
+            folders_unsubscribe($imapConnection, $folder_names);
+            $td_str =  _("Unsubscribed successfully.");
             break;
-    }
-
-    $td_str .= '</b><br>';        
-
+    } 
 
     echo html_tag( 'table',
                 html_tag( 'tr',
-                     html_tag( 'td', $td_str .
-                               '<a href="../src/left_main.php" target=left>' .
+                     html_tag( 'td', '<b>' . $td_str . "</b><br />\n" .
+                               '<a href="../src/left_main.php" target="left">' .
                                _("refresh folder list") . '</a>' ,
                      'center' )
                 ) ,
             'center', '', 'width="100%" cellpadding="4" cellspacing="0" border="0"' );
 }
 
-echo "\n<br>";
+echo "\n<br />";
 
-$imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
-$boxes = sqimap_mailbox_list($imapConnection);
+$boxes = sqimap_mailbox_list($imapConnection,true);
 
 /** CREATING FOLDERS **/
 echo html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspacing="0" border="0"' ) .
@@ -94,12 +122,11 @@ echo html_tag( 'table', '', 'center', '', 'width="70%" cellpadding="4" cellspaci
             ) .
             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";
+     addForm('folders.php', 'post', 'cf').
+     addHidden('smaction','create').
+     addInput('folder_name', '', 25).
+     "<br />\n". _("as a subfolder of"). '<br />'.
+     "<tt><select name=\"subfolder\">\n";
 
 $show_selected = array();
 $skip_folders = array();
@@ -107,31 +134,32 @@ $server_type = strtolower($imap_server_type);
 if ( $server_type == 'courier' ) {
   array_push($skip_folders, 'inbox.trash');
   if ( $default_folder_prefix == 'INBOX.' ) {
-    array_push($skip_folders, 'inbox');
+    array_push($skip_folders, 'INBOX');
   }
 }
 
 if ( $default_sub_of_inbox == false ) {
-    echo '<OPTION SELECTED VALUE="">[ '._("None")." ]\n";
+    echo '<option selected="selected" value="">[ '._("None")." ]</option>\n";
 } else {
-    echo '<OPTION VALUE="">[ '._("None")." ]\n";
+    echo '<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), 
+// 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)
 echo sqimap_mailbox_option_list($imapConnection, $show_selected, $skip_folders, $boxes, 'noinferiors', true);
 
-echo "</SELECT></TT>\n";
+echo "</select></tt>\n";
 if ($show_contain_subfolders_option) {
-    echo '<br><input type=CHECKBOX NAME="contain_subs"> &nbsp;'
+    echo '<br />'.
+         addCheckBox('contain_subs', FALSE, '1') .' &nbsp;'
        . _("Let this folder contain subfolders")
-       . '<BR>';
+       . '<br />';
 }
-echo "<input type=SUBMIT VALUE=\""._("Create")."\">\n";
-echo "</FORM></td></tr>\n";
+echo "<input type=\"submit\" value=\""._("Create")."\" />\n";
+echo "</form></td></tr>\n";
 
 echo html_tag( 'tr',
             html_tag( 'td', '&nbsp;', 'left', $color[4] )
@@ -155,32 +183,31 @@ if ($save_as_draft) {
 // What if move_to_sent = false and $sent_folder is set? Should it still be skipped?
 
 for ($p = 0, $cnt = count($boxes); $p < $cnt && $count_special_folders < $num_max; $p++) {
-    switch ($boxes[$p]['unformatted'])
-    {
-       case (strtoupper($boxes[$p]['unformatted']) == 'INBOX'):
-          ++$count_special_folders;
-         $skip_folders[] = $boxes[$p]['unformatted'];
-         break;
-       // FIX ME inbox.trash should be set in conf.pl
-       case 'inbox.trash':
-          if (strtolower($imap_server_type) == 'courier') {
-             ++$count_special_folders;
-         }
-         break;
-       case $trash_folder:
-           ++$count_special_folders;
-           $skip_folders[] = $trash_folder;
-          break;
-       case $sent_folder:
-           ++$count_special_folders;
-           $skip_folders[] = $sent_folder;
-          break;
-       case $draft_folder:
-           ++$count_special_folders;
-           $skip_folders[] = $draft_folder;
-          break;
-       default: break;
-    }    
+    switch ($boxes[$p]['unformatted']) {
+        case (strtoupper($boxes[$p]['unformatted']) == 'INBOX'):
+            ++$count_special_folders;
+            $skip_folders[] = $boxes[$p]['unformatted'];
+            break;
+        // FIX ME inbox.trash should be set in conf.pl
+        case 'inbox.trash':
+            if (strtolower($imap_server_type) == 'courier') {
+                ++$count_special_folders;
+            }
+            break;
+        case $trash_folder:
+            ++$count_special_folders;
+            $skip_folders[] = $trash_folder;
+            break;
+        case $sent_folder:
+            ++$count_special_folders;
+            $skip_folders[] = $sent_folder;
+            break;
+        case $draft_folder:
+            ++$count_special_folders;
+            $skip_folders[] = $draft_folder;
+            break;
+        default: break;
+    }
 }
 
 
@@ -191,26 +218,27 @@ echo html_tag( 'tr',
         html_tag( 'tr' ) .
         html_tag( 'td', '', 'center', $color[0] );
 
+/* show only if we have folders to rename */
 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";
+    echo addForm('folders.php')
+       . addHidden('smaction', 'rename')
+       . "<tt><select name=\"old_name\">\n"
+       . '         <option value="">[ ' . _("Select a folder") . " ]</option>\n";
 
-    // use existing IMAP connection, we have no special values to show, 
+    // use existing IMAP connection, we have no special values to show,
     // but we do include values to skip. Use the pre-created $boxes to save an IMAP query.
     // send NULL for the flag - ALL folders are eligible for rename!
     // use long format to make sure folder names make sense when parents may be missing.
     echo sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
 
-    echo "</SELECT></TT>\n".
-         "<input type=SUBMIT VALUE=\"".
+    echo "</select></tt>\n".
+         '<input type="submit" value="'.
          _("Rename").
-         "\">\n".
-         "</FORM></td></tr>\n";
+         "\" />\n".
+         "</form></td></tr>\n";
 } else {
-    echo _("No folders found") . '<br><br></td></tr>';
+    echo _("No folders found") . '<br /><br /></td></tr>';
 }
-$boxes_sub = $boxes;
 
 echo html_tag( 'tr',
             html_tag( 'td', '&nbsp;', 'left', $color[4] )
@@ -223,22 +251,24 @@ echo html_tag( 'tr',
         html_tag( 'tr' ) .
         html_tag( 'td', '', 'center', $color[0] );
 
+/* show only if we have folders to delete */
 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";
+    echo addForm('folders.php')
+       . addHidden('smaction', 'delete')
+       . "<tt><select name=\"folder_name\">\n"
+       . '         <option value="">[ ' . _("Select a folder") . " ]</option>\n";
 
     // send NULL for the flag - ALL folders are eligible for delete (except what we've got in skiplist)
     // use long format to make sure folder names make sense when parents may be missing.
     echo sqimap_mailbox_option_list($imapConnection, 0, $skip_folders, $boxes, NULL, true);
 
-    echo "</SELECT></TT>\n"
-       . '<input type=SUBMIT VALUE="'
+    echo "</select></tt>\n"
+       . '<input type="submit" value="'
        . _("Delete")
-       . "\">\n"
+       . "\" />\n"
        . "</form></td></tr>\n";
 } else {
-    echo _("No folders found") . "<br><br></td></tr>";
+    echo _("No folders found") . "<br /><br /></td></tr>";
 }
 
 echo html_tag( 'tr',
@@ -246,95 +276,97 @@ echo html_tag( 'tr',
         ) ."</table>\n";
 
 
-/** UNSUBSCRIBE FOLDERS **/
-echo html_tag( 'table', '', 'center', '', 'width="70%" 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 ($show_only_subscribed_folders) {
 
-if ($count_special_folders < count($boxes)) {
-    echo "<FORM ACTION=\"folders_subscribe.php?method=unsub\" METHOD=\"POST\">\n"
-       . "<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 = htmlspecialchars($boxes[$i]["unformatted-dm"]);
-            $box2 = str_replace(' ', '&nbsp;',
-                                htmlspecialchars(imap_utf7_decode_local($boxes[$i]["unformatted-disp"])));
-            echo "         <OPTION VALUE=\"$box\">$box2\n";
+        /** UNSUBSCRIBE FOLDERS **/
+        echo html_tag( 'table', '', 'center', '', 'width="70%" 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 addForm('folders.php')
+               . addHidden('smaction', 'unsubscribe')
+               . "<tt><select name=\"folder_names[]\" multiple=\"multiple\" size=\"8\">\n";
+           foreach ( $boxes as $box ) {
+                $use_folder = true;
+                if ((strtolower($box["unformatted"]) != "inbox") &&
+                    ($box['unformatted'] != $trash_folder) &&
+                    ($box['unformatted'] != $sent_folder) &&
+                    ($box['unformatted'] != $draft_folder)) {
+                    $box_enc  = htmlspecialchars($box['unformatted-dm']);
+                    $box_disp = str_replace(' ', '&nbsp;',
+                                        htmlspecialchars(imap_utf7_decode_local($box["unformatted-disp"])));
+                    echo "         <option value=\"$box_enc\">$box_disp</option>\n";
+                }
+            }
+            echo "</select></tt><br /><br />\n"
+               . '<input type="submit" value="'
+               . _("Unsubscribe")
+               . "\" />\n"
+               . "</form></td>\n";
+        } else {
+            echo _("No folders were found to unsubscribe from!") . '</td>';
         }
-    }
-    echo "</SELECT></TT><br><br>\n"
-       . '<input type=SUBMIT VALUE="'
-       . _("Unsubscribe")
-       . "\">\n"
-       . "</FORM></td>\n";
-} else {
-    echo _("No folders were found to unsubscribe from!") . '</td>';
-}
-$boxes_sub = $boxes;
-
-/** SUBSCRIBE TO FOLDERS **/
-echo html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
-if(!$no_list_for_subscribe) {
-  $boxes_all = sqimap_mailbox_list_all ($imapConnection);
-
-  $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;
+
+        /** SUBSCRIBE TO FOLDERS **/
+        echo html_tag( 'td', '', 'center', $color[0], 'width="50%"' );
+        if(!$no_list_for_subscribe) {
+            $boxes_all = sqimap_mailbox_list_all ($imapConnection);
+
+            $subboxes = array();
+            // 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 == true) {
+                       $box_enc  = htmlspecialchars($box_a['unformatted-dm']);
+                    $box_disp = htmlspecialchars(imap_utf7_decode_local($box_a['unformatted-disp']));
+                    $subboxes[$box_enc] = $box_disp;
+                }
+            }
+            
+            if ( count($subboxes) > 0 ) {
+                echo addForm('folders.php')
+                 . addHidden('smaction', 'subscribe')
+                 . '<tt><select name="folder_names[]" multiple="multiple" size="8">';
+
+                foreach($subboxes as $subbox_enc => $subbox_disp) {
+                    echo '         <option value="' . $subbox_enc . '">'.$subbox_disp."</option>\n";
+                }
+
+                echo '</select></tt><br /><br />'
+                 . '<input type="submit" value="'. _("Subscribe") . "\" />\n"
+                 . "</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 addForm('folders.php')
+             . addHidden('smaction', 'subscribe')
+             . _("Subscribe to:") . '<br />'
+             . '<tt><input type="text" name="folder_names[]" size="35" />'
+             . '<input type="submit" value="'. _("Subscribe") . "\" />\n"
+             . "</form></td></tr></table><br />\n";
         }
-    }
-    if ($use_folder == true) {
-        $box[$q] = htmlspecialchars($boxes_all[$i]['unformatted-dm']);
-        $box2[$q] = htmlspecialchars(imap_utf7_decode_local($boxes_all[$i]['unformatted-disp']));
-        $q++;
-    }
-  }
-  if ($box && $box2) {
-    echo "<FORM ACTION=\"folders_subscribe.php?method=sub\" METHOD=\"POST\">\n"
-       . '<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>'
-       . '<input type=SUBMIT VALUE="'. _("Subscribe") . "\">\n"
-       . "</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"
-     . _("Subscribe to:") . '<br>'
-     . '<tt><input type="text" name="mailbox[]" size=35>'
-     . '<INPUT TYPE=SUBMIT VALUE="'. _("Subscribe") . "\">\n"
-     . "</FORM></TD></TR></TABLE><BR>\n";
 }
 
 do_hook('folders_bottom');
+sqimap_logout($imapConnection);
 ?>
-
     </td></tr>
     </table>
-
 </td></tr>
 </table>
-
-<?php
-   sqimap_logout($imapConnection);
-?>
-
 </body></html>