Added (c) stuff and some formatting.
[squirrelmail.git] / functions / tree.php
index 933897f84b119b6439ef11556da04da06a6917fd..6265e15f7b534ccd4e7594ae3f2d4b0f6361691a 100644 (file)
@@ -1,23 +1,28 @@
 <?php
 
-   /* $Id$ */
+   /**
+    **  tree.php
+    **
+    **  Copyright (c) 1999-2001 The Squirrelmail Development 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.
+    **
+    **  $Id$
+    */
 
-   $tree_php = true;
-
-   if (!isset($imap_php))
-      include("../functions/imap.php");
-   if (!isset($config_php))
-      include("../config/config.php");
+   require_once('../functions/imap.php');
 
    // Recursive function to find the correct parent for a new node
    function findParentForChild($value, $treeIndexToStart, $tree) {
-      // is $value in $tree[$treeIndexToStart]["value"]
-      if ((isset($tree[$treeIndexToStart])) && (strstr($value, $tree[$treeIndexToStart]["value"]))) {
+      // is $value in $tree[$treeIndexToStart]['value']
+      if ((isset($tree[$treeIndexToStart])) && (strstr($value, $tree[$treeIndexToStart]['value']))) {
          // do I have children, if not then must be a childnode of the current node
-         if ($tree[$treeIndexToStart]["doIHaveChildren"]) {
+         if ($tree[$treeIndexToStart]['doIHaveChildren']) {
             // loop through each subNode checking to see if we are a subNode of one of them
-            for ($i=0;$i< count($tree[$treeIndexToStart]["subNodes"]);$i++) {
-               $result = findParentForChild($value, $tree[$treeIndexToStart]["subNodes"][$i], $tree);
+            for ($i=0;$i< count($tree[$treeIndexToStart]['subNodes']);$i++) {
+               $result = findParentForChild($value, $tree[$treeIndexToStart]['subNodes'][$i], $tree);
                if ($result > -1)
                   return $result;
             }
 
       // create a new subNode
       $newNodeIndex = count($tree);
-      $tree[$newNodeIndex]["value"] = $value;
-      $tree[$newNodeIndex]["doIHaveChildren"] = false;
+      $tree[$newNodeIndex]['value'] = $value;
+      $tree[$newNodeIndex]['doIHaveChildren'] = false;
 
-      if ($tree[$parentNode]["doIHaveChildren"] == false) {
+      if ($tree[$parentNode]['doIHaveChildren'] == false) {
          // make sure the parent knows it has children
-         $tree[$parentNode]["subNodes"][0] = $newNodeIndex;
-         $tree[$parentNode]["doIHaveChildren"] = true;
+         $tree[$parentNode]['subNodes'][0] = $newNodeIndex;
+         $tree[$parentNode]['doIHaveChildren'] = true;
       } else {
-         $nextSubNode = count($tree[$parentNode]["subNodes"]);
+         $nextSubNode = count($tree[$parentNode]['subNodes']);
          // make sure the parent knows it has children
-         $tree[$parentNode]["subNodes"][$nextSubNode] = $newNodeIndex;
+         $tree[$parentNode]['subNodes'][$nextSubNode] = $newNodeIndex;
       }
    }
 
    function walkTreeInPreOrderEmptyTrash($index, $imap_stream, $tree) {
       global $trash_folder;
-      if ($tree[$index]["doIHaveChildren"]) {
-         for ($j = 0; $j < count($tree[$index]["subNodes"]); $j++) {
-            walkTreeInPreOrderEmptyTrash($tree[$index]["subNodes"][$j], $imap_stream, $tree);
+      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) {
-            sqimap_mailbox_delete($imap_stream, $tree[$index]["value"]);
+         if ($tree[$index]['value'] != $trash_folder) {
+            sqimap_mailbox_delete($imap_stream, $tree[$index]['value']);
          } else {
             $numMessages = sqimap_get_num_messages($imap_stream, $trash_folder);
             if ($numMessages > 0) {
                sqimap_mailbox_select($imap_stream, $trash_folder);
-               sqimap_messages_flag ($imap_stream, 1, $numMessages, "Deleted");
+               sqimap_messages_flag ($imap_stream, 1, $numMessages, 'Deleted');
                sqimap_mailbox_expunge($imap_stream, $trash_folder, true);
             }
          }
       } else {
-         if ($tree[$index]["value"] != $trash_folder) {
-            sqimap_mailbox_delete($imap_stream, $tree[$index]["value"]);
+         if ($tree[$index]['value'] != $trash_folder) {
+            sqimap_mailbox_delete($imap_stream, $tree[$index]['value']);
          } else {
             $numMessages = sqimap_get_num_messages($imap_stream, $trash_folder);
             if ($numMessages > 0) {
                sqimap_mailbox_select($imap_stream, $trash_folder);
-               sqimap_messages_flag ($imap_stream, 1, $numMessages, "Deleted");
+               sqimap_messages_flag ($imap_stream, 1, $numMessages, 'Deleted');
                sqimap_mailbox_expunge($imap_stream, $trash_folder, true);
             }
          }
    }
    
    function walkTreeInPreOrderDeleteFolders($index, $imap_stream, $tree) {
-      if ($tree[$index]["doIHaveChildren"]) {
-         for ($j = 0; $j < count($tree[$index]["subNodes"]); $j++) {
-            walkTreeInPreOrderDeleteFolders($tree[$index]["subNodes"][$j], $imap_stream, $tree);
+      if ($tree[$index]['doIHaveChildren']) {
+         for ($j = 0; $j < count($tree[$index]['subNodes']); $j++) {
+            walkTreeInPreOrderDeleteFolders($tree[$index]['subNodes'][$j], $imap_stream, $tree);
          }
-         sqimap_mailbox_delete($imap_stream, $tree[$index]["value"]);
+         sqimap_mailbox_delete($imap_stream, $tree[$index]['value']);
       } else {
-         sqimap_mailbox_delete($imap_stream, $tree[$index]["value"]);
+         sqimap_mailbox_delete($imap_stream, $tree[$index]['value']);
       }
    }
 
-   function walkTreeInPostOrderCreatingFoldersUnderTrash($index, $imap_stream, $tree, $dm, $topFolderName) {
-      global $trash_folder;
+   function walkTreeInPostOrderCreatingFoldersUnderTrash($index, $imap_stream, $tree, $topFolderName) {
+      global $trash_folder, $delimiter;
 
-      $position = strrpos($topFolderName, $dm) + 1;
-      $subFolderName = substr($tree[$index]["value"], $position);
+      $position = strrpos($topFolderName, $delimiter) + 1;
+      $subFolderName = substr($tree[$index]['value'], $position);
 
-      if ($tree[$index]["doIHaveChildren"]) {
-         sqimap_mailbox_create($imap_stream, $trash_folder . $dm . $subFolderName, "");
-         sqimap_mailbox_select($imap_stream, $tree[$index]["value"]);
+      if ($tree[$index]['doIHaveChildren']) {
+         sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, "");
+         sqimap_mailbox_select($imap_stream, $tree[$index]['value']);
         
-         $messageCount = sqimap_get_num_messages($imap_stream, $tree[$index]["value"]);
+         $messageCount = sqimap_get_num_messages($imap_stream, $tree[$index]['value']);
          if ($messageCount > 0)
-            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $dm . $subFolderName);
+            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $delimiter . $subFolderName);
          
-         for ($j = 0;$j < count($tree[$index]["subNodes"]); $j++)
-            walkTreeInPostOrderCreatingFoldersUnderTrash($tree[$index]["subNodes"][$j], $imap_stream, $tree, $dm, $topFolderName);
+         for ($j = 0;$j < count($tree[$index]['subNodes']); $j++)
+            walkTreeInPostOrderCreatingFoldersUnderTrash($tree[$index]['subNodes'][$j], $imap_stream, $tree, $topFolderName);
       } else {
-         sqimap_mailbox_create($imap_stream, $trash_folder . $dm . $subFolderName, "");
-         sqimap_mailbox_select($imap_stream, $tree[$index]["value"]);
+         sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, '');
+         sqimap_mailbox_select($imap_stream, $tree[$index]['value']);
          
-         $messageCount = sqimap_get_num_messages($imap_stream, $tree[$index]["value"]);
+         $messageCount = sqimap_get_num_messages($imap_stream, $tree[$index]['value']);
          if ($messageCount > 0)
-            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $dm . $subFolderName);
+            sqimap_messages_copy($imap_stream, 1, $messageCount, $trash_folder . $delimiter . $subFolderName);
       }
    }
 
    function simpleWalkTreePre($index, $tree) {
-      if ($tree[$index]["doIHaveChildren"]) {
-         for ($j = 0; $j < count($tree[$index]["subNodes"]); $j++) {
-            simpleWalkTreePre($tree[$index]["subNodes"][$j], $tree);
+      if ($tree[$index]['doIHaveChildren']) {
+         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>';
       }
    }
 ?>