phpdocumentor preparation and a few corrections to earlier phpdocumentor work
[squirrelmail.git] / src / folders.php
index 69ee1a29e9a6a78c6183e32c934732116ac75816..7e4966eeba582d437c50f5c709e29b972a0eac4c 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * folders.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2003 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
  * Folders.
  *
  * $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');
+/** Path for SquirrelMail required files. */
+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');
 
 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' ) .
@@ -30,40 +44,52 @@ echo '<br>' .
                     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>";
+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>" ,
+                               '<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>";
+            '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);
 
 /** CREATING FOLDERS **/
-echo html_tag( 'table', '', 'center', '', 'width="70%" cols="1" cellpadding="4" cellspacing="0" border="0"' ) .
+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] )
             ) .
@@ -73,38 +99,37 @@ echo html_tag( 'table', '', 'center', '', 'width="70%" cols="1" cellpadding="4"
      "<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>".
+     '<BR>'.
      "<TT><SELECT NAME=subfolder>\n";
-if ($default_sub_of_inbox == false) {
+
+$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 VALUE="">[ '._("None")." ]\n";
 } else {
     echo '<OPTION VALUE="">[ '._("None")." ]\n";
+    $show_selected = array('inbox');
 }
 
-for ($i = 0; $i < count($boxes); $i++) {
-    if (!in_array('noinferiors', $boxes[$i]['flags'])) {
-        if ((strtolower($boxes[$i]['unformatted']) == 'inbox') &&
-            $default_sub_of_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);
 
-            $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";
-        }
-    }
-}
 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>";
+    echo '<br><input type=CHECKBOX NAME="contain_subs"> &nbsp;'
+       . _("Let this folder contain subfolders")
+       . '<BR>';
 }
 echo "<input type=SUBMIT VALUE=\""._("Create")."\">\n";
 echo "</FORM></td></tr>\n";
@@ -114,29 +139,49 @@ echo html_tag( 'tr',
         ) ."\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++;
+    $num_max++;
 }
 if ($move_to_sent) {
-        $num_max++;
+    $num_max++;
 }
 if ($save_as_draft) {
-        $num_max++;
+    $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++;
+
+// 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;
+    }    
 }
 
 
@@ -151,29 +196,20 @@ 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'];
+    // 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);
 
-            $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";
-            }
-        }
-    }
     echo "</SELECT></TT>\n".
          "<input type=SUBMIT VALUE=\"".
          _("Rename").
          "\">\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;
 
@@ -192,26 +228,16 @@ 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";
-        }
-    }
-    echo "</SELECT></TT>\n";
-    echo "<input type=SUBMIT VALUE=\"";
-    echo _("Delete");
-    echo "\">\n";
-    echo "</form></td></tr>\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>";
 }
@@ -222,7 +248,7 @@ echo html_tag( 'tr',
 
 
 /** UNSUBSCRIBE FOLDERS **/
-echo html_tag( 'table', '', 'center', '', 'width="70%" cols="2" cellpadding="4" cellspacing="0" border="0"' ) .
+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"' )
             ) .
@@ -230,83 +256,78 @@ echo html_tag( 'table', '', 'center', '', 'width="70%" cols="2" cellpadding="4"
                 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";
+    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 = $boxes[$i]["unformatted-dm"];
+            $box = htmlspecialchars($boxes[$i]["unformatted-dm"]);
             $box2 = str_replace(' ', '&nbsp;',
-                                imap_utf7_decode_local($boxes[$i]["unformatted-disp"]));
+                                htmlspecialchars(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";
+    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 _("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) {
-  $imap_stream = sqimap_login ($username, $key, $imapServerAddress,
-                               $imapPort, 1);
-  $boxes_all = sqimap_mailbox_list_all ($imap_stream);
+  $boxes_all = sqimap_mailbox_list_all ($imapConnection);
 
-  $box = "";
-  $box2 = "";
+  $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"]) {
+        if ($boxes_all[$i]['unformatted'] == $boxes[$p]['unformatted']) {
             $use_folder = false;
             continue;
-        } else if ($boxes_all[$i]["unformatted-dm"] == $folder_prefix) {
+        } 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"]);
+        $box[$q] = htmlspecialchars($boxes_all[$i]['unformatted-dm']);
+        $box2[$q] = htmlspecialchars(imap_utf7_decode_local($boxes_all[$i]['unformatted-disp']));
         $q++;
     }
   }
-  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>";
+    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>";
-    echo "<input type=SUBMIT VALUE=\"". _("Subscribe") . "\">\n";
-    echo "</FORM></td></tr></table><BR>\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>";
+    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";
+  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");
+do_hook('folders_bottom');
 ?>
 
-
     </td></tr>
     </table>