missing sprintf around string
[squirrelmail.git] / functions / tree.php
index 5e5c87030a1960778c81ae90749e12b62943db3e..f8503b8110f5de6c9803e3a55e48c76361ea1b77 100644 (file)
@@ -3,11 +3,11 @@
 /**
  * tree.php
  *
- * Copyright (c) 1999-2004 The SquirrelMail Project Team
+ * Copyright (c) 1999-2005 The SquirrelMail Project Team
  * Licensed under the GNU GPL. For full terms see the file COPYING.
  *
- * This code provides various string manipulation functions that are
- * used by the rest of the Squirrelmail code.
+ * This file provides functions to walk trees of folders, for
+ * instance to delete a whole tree.
  *
  * @version $Id$
  * @package squirrelmail
@@ -81,14 +81,27 @@ function addChildNodeToTree($comparisonValue, $value, &$tree) {
  */
 function walkTreeInPreOrderEmptyTrash($index, $imap_stream, $tree) {
     global $trash_folder;
+    walkTreeInPreOrderEmptyFolder($index, $imap_stream, $tree, $trash_folder);
+}
+
+/**
+ * Recursively walk the tree of mailboxes in the given folder and delete all folders and messages
+ *
+ * @param int index the place in the tree to start, usually 0
+ * @param stream imap_stream the IMAP connection to send commands to
+ * @param array tree the tree to walk
+ * @param mailbox the name of the root folder to empty
+ * @return void
+ */
+function walkTreeInPreOrderEmptyFolder($index, $imap_stream, $tree, $mailbox) {
     if ($tree[$index]['doIHaveChildren']) {
         for ($j = 0; $j < count($tree[$index]['subNodes']); $j++) {
             walkTreeInPreOrderEmptyTrash($tree[$index]['subNodes'][$j], $imap_stream, $tree);
         }
-        if ($tree[$index]['value'] != $trash_folder) {
+        if ($tree[$index]['value'] != $mailbox) {
             sqimap_mailbox_delete($imap_stream, $tree[$index]['value']);
         } else {
-            $mbx_response = sqimap_mailbox_select($imap_stream, $trash_folder);
+            $mbx_response = sqimap_mailbox_select($imap_stream, $mailbox);
             if ($mbx_response['EXISTS'] > 0) {
                sqimap_messages_flag ($imap_stream, 1, '*', 'Deleted', true);
                // CLOSE === EXPUNGE and UNSELECT
@@ -96,10 +109,10 @@ function walkTreeInPreOrderEmptyTrash($index, $imap_stream, $tree) {
             }
         }
     } else {
-        if ($tree[$index]['value'] != $trash_folder) {
+        if ($tree[$index]['value'] != $mailbox) {
             sqimap_mailbox_delete($imap_stream, $tree[$index]['value']);
         } else {
-            $mbx_response = sqimap_mailbox_select($imap_stream, $trash_folder);
+            $mbx_response = sqimap_mailbox_select($imap_stream, $mailbox);
             if ($mbx_response['EXISTS'] > 0) {
                 sqimap_messages_flag ($imap_stream, 1, '*', 'Deleted', true);
                 // CLOSE === EXPUNGE and UNSELECT
@@ -143,7 +156,7 @@ function walkTreeInPostOrderCreatingFoldersUnderTrash($index, $imap_stream, $tre
 
     if ($tree[$index]['doIHaveChildren']) {
         sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, "");
-        $mbx_response = sqimap_mailbox_select($imap_stream, $tree[$index]['value']);       
+        $mbx_response = sqimap_mailbox_select($imap_stream, $tree[$index]['value']);
         $messageCount = $mbx_response['EXISTS'];
         if ($messageCount > 0) {
             sqimap_messages_copy($imap_stream, 1, '*', $trash_folder . $delimiter . $subFolderName);
@@ -175,9 +188,9 @@ function simpleWalkTreePre($index, $tree) {
         for ($j = 0; $j < count($tree[$index]['subNodes']); $j++) {
             simpleWalkTreePre($tree[$index]['subNodes'][$j], $tree);
         }
-        echo $tree[$index]['value'] . '<br>';
+        echo $tree[$index]['value'] . '<br />';
     } else {
-        echo $tree[$index]['value'] . '<br>';
+        echo $tree[$index]['value'] . '<br />';
     }
 }
-?>
\ No newline at end of file
+?>