/**
* tree.php
*
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
+ * This file provides functions to walk trees of folders, for
+ * instance to delete a whole tree.
*
- * This code provides various string manipulation functions that are
- * used by the rest of the Squirrelmail code.
- *
- * $Id$
+ * @copyright 1999-2018 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
*/
-require_once('../functions/imap.php');
+require_once(SM_PATH . 'functions/imap.php');
/**
- * findParentForChild
+ * Recursive function to find the correct parent for a new node.
*
- * Recursive function to find the correct parent for a new node
+ * @param mixed value the value to find a parent for
+ * @param int treeIndexToStart where to start the search, usually the root node (0)
+ * @param array tree the tree to search
+ * @return int the index of the parent
*/
-
function findParentForChild($value, $treeIndexToStart, $tree) {
// is $value in $tree[$treeIndexToStart]['value']
if ((isset($tree[$treeIndexToStart])) && (strstr($value, $tree[$treeIndexToStart]['value']))) {
}
}
+/**
+ * Will insert a new value into the tree, based on a given comparison value.
+ *
+ * @param mixed comparisonValue the value to determine where the new element should be placed.
+ * @param mixed value the new node to insert
+ * @param array tree the tree to insert the node in, by ref
+ */
function addChildNodeToTree($comparisonValue, $value, &$tree) {
$parentNode = findParentForChild($comparisonValue, 0, $tree);
}
}
+/**
+ * Recursively walk the tree of trash mailboxes 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
+ * @return void
+ */
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);
- if ($mbx_response['EXISTS'] > 0) {
- sqimap_messages_flag ($imap_stream, 1, '*', 'Deleted', true);
- sqimap_mailbox_expunge($imap_stream, $trash_folder, true);
+ $mbx_response = sqimap_mailbox_select($imap_stream, $mailbox);
+ if ($mbx_response['EXISTS'] > 0) {
+ sqimap_toggle_flag($imap_stream, '1:*', '\\Deleted', true, true);
+ // CLOSE === EXPUNGE and UNSELECT
+ sqimap_run_command($imap_stream,'CLOSE',false,$response,$message);
}
}
} 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);
- if ($mbx_response['EXISTS'] > 0) {
- sqimap_messages_flag ($imap_stream, 1, '*', 'Deleted', true);
- sqimap_mailbox_expunge($imap_stream, $trash_folder, true);
+ $mbx_response = sqimap_mailbox_select($imap_stream, $mailbox);
+ if ($mbx_response['EXISTS'] > 0) {
+ sqimap_toggle_flag($imap_stream, '1:*', '\\Deleted', true, true);
+ // CLOSE === EXPUNGE and UNSELECT
+ sqimap_run_command($imap_stream,'CLOSE',false,$response,$message);
}
}
}
}
+/**
+ * Recursively delete a tree of mail folders.
+ *
+ * @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
+ * @return void
+ */
function walkTreeInPreOrderDeleteFolders($index, $imap_stream, $tree) {
if ($tree[$index]['doIHaveChildren']) {
for ($j = 0; $j < count($tree[$index]['subNodes']); $j++) {
}
}
+/**
+ * Recursively walk a tree of folders to create them under the trash folder.
+ */
function walkTreeInPostOrderCreatingFoldersUnderTrash($index, $imap_stream, $tree, $topFolderName) {
global $trash_folder, $delimiter;
- $position = strrpos($topFolderName, $delimiter) + 1;
+ $position = strrpos($topFolderName, $delimiter);
+ if ($position !== FALSE) {
+ $position++;
+ }
$subFolderName = substr($tree[$index]['value'], $position);
if ($tree[$index]['doIHaveChildren']) {
- sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, "");
- $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);
+ // create new trash subfolder only if it does not exist.
+ if (!sqimap_mailbox_exists($imap_stream, $trash_folder . $delimiter . $subFolderName))
+ sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, "");
+
+ $mbx_response = sqimap_mailbox_select($imap_stream, $tree[$index]['value']);
+ $messageCount = $mbx_response['EXISTS'];
+ if ($messageCount > 0) {
+ sqimap_msgs_list_copy($imap_stream, '1:*', $trash_folder . $delimiter . $subFolderName);
+ }
+ // after copy close the mailbox to get in unselected state
+ sqimap_run_command($imap_stream,'CLOSE',false,$response,$message);
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 . $delimiter . $subFolderName, '');
+ if (!sqimap_mailbox_exists($imap_stream, $trash_folder . $delimiter . $subFolderName))
+ sqimap_mailbox_create($imap_stream, $trash_folder . $delimiter . $subFolderName, '');
$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);
+ if ($messageCount > 0) {
+ sqimap_msgs_list_copy($imap_stream, '1:*', $trash_folder . $delimiter . $subFolderName);
+ }
+ // after copy close the mailbox to get in unselected state
+ sqimap_run_command($imap_stream,'CLOSE',false,$response,$message);
}
}
+/**
+ * Recursive function that outputs a tree In-Pre-Order.
+ * @param int index the node to start (usually 0)
+ * @param array tree the tree to walk
+ * @return void
+ */
function simpleWalkTreePre($index, $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 />';
}
}
-?>
projects / squirrelmail.git / blobdiff