Fix bug where it was impossible to subscribe to any folder through the UI.
[squirrelmail.git] / src / folders.php
index 6354c9b42a7b7ce431d04b9d4002cf79005633d2..cc1fc279b90176b81929929231230dcff095284c 100644 (file)
-<?
-   session_start();
-
-   if (!isset($config_php))
-      include("../config/config.php");
-   if (!isset($strings_php))
-      include("../functions/strings.php");
-   if (!isset($page_header_php))
-      include("../functions/page_header.php");
-   if (!isset($imap_php))
-      include("../functions/imap.php");
-   if (!isset($array_php))
-      include("../functions/array.php");
-
-   include("../src/load_prefs.php");
-
-   echo "<HTML><BODY TEXT=\"$color[8]\" BGCOLOR=\"$color[4]\" LINK=\"$color[7]\" VLINK=\"$color[7]\" ALINK=\"$color[7]\">\n";
-
-   displayPageHeader($color, "None");
-
-   echo "<TABLE WIDTH=100% COLS=1 ALIGN=CENTER>\n";
-   echo "   <TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER>\n";
-   echo _("Folders");
-   echo "   </TD></TR>\n";
-   echo "</TABLE>\n";
-
-   $imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
-   $boxes = sqimap_mailbox_list($imapConnection);
-
-   /** DELETING FOLDERS **/
-   echo "<TABLE WIDTH=70% COLS=1 ALIGN=CENTER>\n";
-   echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER><B>";
-   echo _("Delete Folder");
-   echo "</B></TD></TR>";
-   echo "<TR><TD BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-   $count_special_folders = 0;
-   for ($i = 0; $i < count($special_folders); $i++) {
-      for ($p = 0; $p < count($special_folders); $p++) {
-         if ($boxes[$i]["unformatted"] == $special_folders[$p]) {
-            $count_special_folders++;
-         }
-      }   
-   }
-
-   if ($count_special_folders < count($boxes)) {
-      echo "<FORM ACTION=\"folders_delete.php?PHPSESSID=$PHPSESSID\" METHOD=\"POST\">\n";
-      echo "<TT><SELECT NAME=mailbox>\n";
-      for ($i = 0; $i < count($boxes); $i++) {
-         $use_folder = true;
-         for ($p = 0; $p < count($special_folders); $p++) {
-            if ($boxes[$i]["unformatted"] == $special_folders[$p]) {
-               $use_folder = false;
-            } else if (substr($boxes[$i]["unformatted"], 0, strlen($trash_folder)) == $trash_folder) {
-               $use_folder = false;
-            }
-         }
-         if ($use_folder == true) {
-            $box = $boxes[$i]["unformatted-dm"];
-            $box2 = replace_spaces($boxes[$i]["formatted"]);
-            echo "         <OPTION VALUE=\"$box\">$box2\n";
-         }
-      }
-      echo "</SELECT></TT>\n";
-      echo "<INPUT TYPE=SUBMIT VALUE=\"";
-      echo _("Delete");
-      echo "\">\n";
-      echo "</FORM><BR></TD></TR>\n";
-   } else {
-      echo _("No mailboxes found") . "<br><br></td><tr>";
-   }
-
-
-   /** CREATING FOLDERS **/
-   echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER><B>";
-   echo _("Create Folder");
-   echo "</B></TD></TR>";
-   echo "<TR><TD BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-   echo "<FORM ACTION=\"folders_create.php?PHPSESSID=$PHPSESSID\" 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>[ None ]\n";
-   else
-      echo "<OPTION>[ None ]\n";
-
-   for ($i = 0; $i < count($boxes); $i++) {
-      if (count($boxes[$i]["flags"]) > 0) {
-         for ($j = 0; $j < count($boxes[$i]["flags"]); $j++) {
-            if ($boxes[$i]["flags"][$j] != "noinferiors") {
-               if (($boxes[$i]["unformatted"] == $special_folders[0]) && ($default_sub_of_inbox == true)) {
-                  $box = $boxes[$i]["unformatted"];
-                  $box2 = replace_spaces($boxes[$i]["formatted"]);
-                  echo "<OPTION SELECTED VALUE=\"$box\">$box2\n";
-               } else {
-                  $box = $boxes[$i]["unformatted"];
-                  $box2 = replace_spaces($boxes[$i]["formatted"]);
-                  echo "<OPTION VALUE=\"$box\">$box2\n";
-               }
-            }   
-         }    
-      } else {
-         if (($boxes[$i]["unformatted"] == $special_folders[0]) && ($default_sub_of_inbox == true)) {
-            $box = $boxes[$i]["unformatted"];
-            $box2 = replace_spaces($boxes[$i]["formatted"]);
-            echo "<OPTION SELECTED VALUE=\"$box\">$box2\n";
-         } else {
-            $box = $boxes[$i]["unformatted"];
-            $box2 = replace_spaces($boxes[$i]["formatted"]);
-            echo "<OPTION VALUE=\"$box\">$box2\n";
-         }
-      }
-   }
-   echo "</SELECT></TT><BR>\n";
-   if ($show_contain_subfolders_option) {
-      echo "<INPUT TYPE=CHECKBOX NAME=\"contain_subs\"> &nbsp;";
-      echo _("Let this folder contain subfolders");
-      echo "<BR>";
-   }   
-   echo "<INPUT TYPE=SUBMIT VALUE=Create>\n";
-   echo "</FORM><BR></TD></TR><BR>\n";
-
-   /** RENAMING FOLDERS **/
-   echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER><B>";
-   echo _("Rename a Folder");
-   echo "</B></TD></TR>";
-   echo "<TR><TD BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-   if ($count_special_folders < count($boxes)) {
-      echo "<FORM ACTION=\"folders_rename_getname.php?PHPSESSID=$PHPSESSID\" METHOD=\"POST\">\n";
-      echo "<TT><SELECT NAME=old>\n";
-      for ($i = 0; $i < count($boxes); $i++) {
-         $use_folder = true;
-         for ($p = 0; $p < count($special_folders); $p++) {
-            if ($boxes[$i]["unformatted"] == $special_folders[$p]) {
-               $use_folder = false;
-            } else if (substr($boxes[$i]["unformatted"], 0, strlen($trash_folder)) == $trash_folder) {
-               $use_folder = false;
-            }
-         }
-         if ($use_folder == true) {
-            $box = $boxes[$i]["unformatted-dm"];
-            $box2 = replace_spaces($boxes[$i]["formatted"]);
-            echo "         <OPTION VALUE=\"$box\">$box2\n";
-         }
-      }
-      echo "</SELECT></TT>\n";
-      echo "<INPUT TYPE=SUBMIT VALUE=\"";
-      echo _("Rename");
-      echo "\">\n";
-      echo "</FORM></TD></TR>\n";
-   } else {
-      echo _("No mailboxes found") . "<br><br></td></tr>";
-   }
-   $boxes_sub = $boxes;
-   
-   /** UNSUBSCRIBE FOLDERS **/
-   echo "<TR><TD BGCOLOR=\"$color[0]\" ALIGN=CENTER><B>";
-   echo _("Unsubscribe/Subscribe");
-   echo "</B></TD></TR>";
-   echo "<TR><TD BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-   if ($count_special_folders < count($boxes)) {
-      echo "<FORM ACTION=\"folders_subscribe.php?PHPSESSID=$PHPSESSID&method=unsub\" METHOD=\"POST\">\n";
-      echo "<TT><SELECT NAME=mailbox>\n";
-      for ($i = 0; $i < count($boxes); $i++) {
-         $use_folder = true;
-         for ($p = 0; $p < count($special_folders); $p++) {
-            if ($boxes[$i]["unformatted"] == $special_folders[$p]) {
-               $use_folder = false;
-            } else if (substr($boxes[$i]["unformatted"], 0, strlen($trash_folder)) == $trash_folder) {
-               $use_folder = false;
+<?php
+
+/**
+ * folders.php
+ *
+ * Copyright (c) 1999-2004 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.
+ *
+ * @version $Id$
+ * @package squirrelmail
+ */
+
+/**
+ * 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/plugin.php');
+require_once(SM_PATH . 'functions/html.php');
+require_once(SM_PATH . 'functions/forms.php');
+
+displayPageHeader($color, 'None');
+
+/* get globals we may need */
+
+sqgetGlobalVar('username', $username, SQ_SESSION);
+sqgetGlobalVar('key', $key, SQ_COOKIE);
+sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
+sqgetGlobalVar('onetimepad', $onetimepad, SQ_SESSION);
+
+sqgetGlobalVar('success', $success, SQ_GET);
+
+/* end of get globals */
+
+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>' .
+                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 ) {
+
+    $td_str = '<b>';
+
+    switch ($success)
+    {
+        case 'subscribe':
+            $td_str .=  _("Subscribed successfully!");
+            break;
+        case 'unsubscribe':
+            $td_str .=  _("Unsubscribed successfully!");
+            break;
+        case 'delete':
+            $td_str .=  _("Deleted folder successfully!");
+            break;
+        case 'create':
+            $td_str .=  _("Created folder successfully!");
+            break;
+        case 'rename':
+            $td_str .=  _("Renamed successfully!");
+            break;
+        case 'subscribe-doesnotexist':
+            $td_str .=  _("Subscription Unsuccessful - Folder does not exist.");
+            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">' .
+                               _("refresh folder list") . '</a>' ,
+                     'center' )
+                ) ,
+            'center', '', 'width="100%" cellpadding="4" cellspacing="0" border="0"' );
+}
+
+echo "\n<br />";
+
+$imapConnection = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 0);
+$boxes = sqimap_mailbox_list($imapConnection,true);
+
+/** CREATING FOLDERS **/
+echo html_tag( 'table', '', 'center', '', 'width="70%" 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] ) .
+     addForm('folders_create.php', 'POST', 'cf').
+     addInput('folder_name', '', 25).
+     "<br />\n". _("as a subfolder of"). '<br />'.
+     "<tt><select name=\"subfolder\">\n";
+
+$show_selected = array();
+$skip_folders = array();
+$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');
+  }
+}
+
+if ( $default_sub_of_inbox == false ) {
+    echo '<option selected="selected" value="">[ '._("None")." ]</option>\n";
+} else {
+    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), 
+// 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";
+if ($show_contain_subfolders_option) {
+    echo '<br />'.
+         addCheckBox('contain_subs', FALSE, '1') .' &nbsp;'
+       . _("Let this folder contain subfolders")
+       . '<br />';
+}
+echo "<input type=\"submit\" value=\""._("Create")."\" />\n";
+echo "</form></td></tr>\n";
+
+echo html_tag( 'tr',
+            html_tag( 'td', '&nbsp;', 'left', $color[4] )
+        ) ."\n";
+
+/** count special folders **/
+
+// FIX ME, why not check if the folders are defined IMHO move_to_sent, move_to_trash has nothing todo with it
+$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++;
+}
+
+// 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;
             }
-         }
-         if ($use_folder == true) {
-            $box = $boxes[$i]["unformatted-dm"];
-            $box2 = replace_spaces($boxes[$i]["formatted"]);
-            echo "         <OPTION VALUE=\"$box\">$box2\n";
-         }
-      }
-      echo "</SELECT></TT>\n";
-      echo "<INPUT TYPE=SUBMIT VALUE=\"";
-      echo _("Unsubscribe");
-      echo "\">\n";
-      echo "</FORM></TD></TR>\n";
-   } else {
-      echo _("No mailboxes found") . "<br><br></td></tr>";
-   }
-   $boxes_sub = $boxes;
-   
-   /** SUBSCRIBE TO FOLDERS **/
-
-   echo "<TR><TD BGCOLOR=\"$color[4]\" ALIGN=CENTER>";
-   if ($count_special_folders < count($boxes)) {
-      $imap_stream = sqimap_login ($username, $key, $imapServerAddress, $imapPort, 1);
-      $boxes = sqimap_mailbox_list_all ($imap_stream);
-      
-      echo "<FORM ACTION=\"folders_subscribe.php?PHPSESSID=$PHPSESSID&method=sub\" METHOD=\"POST\">\n";
-      echo "<tt><input type=text size=32 name=mailbox></tt>";
-      echo "<INPUT TYPE=SUBMIT VALUE=\"";
-      echo _("Subscribe");
-      echo "\">\n";
-      echo "</FORM></TD></TR></TABLE><BR>\n";
-   } else {
-      echo _("No mailboxes found") . "<br><br></td></tr></table>";
-   }
+            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;
+    }
+}
+
+
+/** 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 addForm('folders_rename_getname.php')
+       . "<tt><select name=\"old\">\n"
+       . '         <option value="">[ ' . _("Select a folder") . " ]</option>\n";
+
+    // 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="'.
+         _("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 addForm('folders_delete.php')
+       . "<tt><select name=\"mailbox\">\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="'
+       . _("Delete")
+       . "\" />\n"
+       . "</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%" 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_subscribe.php?method=unsub')
+       . "<tt><select name=\"mailbox[]\" multiple=\"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</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>';
+}
+$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;
+        }
+    }
+    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 addForm('folders_subscribe.php?method=sub')
+       . '<tt><select name="mailbox[]" multiple="multiple" size="8">';
+
+    for ($q = 0; $q < count($box); $q++) {      
+       echo '         <option value="' . $box[$q] . '">'.$box2[$q]."</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_subscribe.php?method=sub')
+     . _("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');
+?>
+    </td></tr>
+    </table>
+</td></tr>
+</table>
+<?php
+   sqimap_logout($imapConnection);
 ?>
-</BODY></HTML>
+</body></html>