+/**
+ * left_main.php
+ *
+ * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * This is the code for the left bar. The left bar shows the folders
+ * available, and has cookie information.
+ *
+ * $Id$
+ */
+
+/* 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/page_header.php');
+require_once(SM_PATH . 'functions/html.php');
+require_once(SM_PATH . 'functions/date.php');
+
+/* These constants are used for folder stuff. */
+define('SM_BOX_UNCOLLAPSED', 0);
+define('SM_BOX_COLLAPSED', 1);
+
+/* --------------------- FUNCTIONS ------------------------- */
+
+function formatMailboxName($imapConnection, $box_array) {
+
+ global $folder_prefix, $trash_folder, $sent_folder,
+ $color, $move_to_sent, $move_to_trash,
+ $unseen_notify, $unseen_type, $collapse_folders,
+ $draft_folder, $save_as_draft,
+ $use_special_folder_color;
+ $real_box = $box_array['unformatted'];
+ $mailbox = str_replace(' ','',$box_array['formatted']);
+ $mailboxURL = urlencode($real_box);
+
+ /* Strip down the mailbox name. */
+ if (ereg("^( *)([^ ]*)$", $mailbox, $regs)) {
+ $mailbox = $regs[2];
+ }
+ $unseen = 0;
+ $status = array('','');
+ if (($unseen_notify == 2 && $real_box == 'INBOX') ||
+ $unseen_notify == 3) {
+ $tmp_status = create_unseen_string($real_box, $box_array, $imapConnection, $unseen_type );
+ if ($status !== false) {
+ $status = $tmp_status;
+ }
+ }
+ list($unseen_string, $unseen) = $status;
+ $special_color = ($use_special_folder_color && isSpecialMailbox($real_box));
+
+ /* Start off with a blank line. */
+ $line = '';
+
+ /* If there are unseen message, bold the line. */
+ if ($unseen > 0) { $line .= '<B>'; }
+
+ /* Create the link for this folder. */
+ if ($status !== false) {
+ $line .= '<a href="right_main.php?PG_SHOWALL=0&sort=0&startMessage=1&mailbox='.
+ $mailboxURL.'" TARGET="right" STYLE="text-decoration:none">';
+ }
+ if ($special_color) {
+ $line .= "<font color=\"$color[11]\">";
+ }
+ if ( $mailbox == 'INBOX' ) {
+ $line .= _("INBOX");
+ } else {
+ $line .= str_replace(' ',' ',$mailbox);
+ }
+ if ($special_color == TRUE)
+ $line .= '</font>';
+ if ($status !== false) {
+ $line .= '</a>';
+ }
+
+ /* If there are unseen message, close bolding. */
+ if ($unseen > 0) { $line .= "</B>"; }
+
+ /* Print unseen information. */
+ if ($unseen_string != '') {
+ $line .= " <SMALL>$unseen_string</SMALL>";
+ }
+
+ /* If it's the trash folder, show a purge link when needed */
+ if (($move_to_trash) && ($real_box == $trash_folder)) {
+ if (! isset($numMessages)) {
+ $numMessages = sqimap_get_num_messages($imapConnection, $real_box);
+ }
+
+ if (($numMessages > 0) or ($box_array['parent'] == 1)) {
+ $urlMailbox = urlencode($real_box);
+ $line .= "\n<small>\n" .
+ " (<A HREF=\"empty_trash.php\" style=\"text-decoration:none\">"._("purge")."</A>)" .
+ "</small>";
+ } else {
+ $line .= concat_hook_function('left_main_after_each_folder',
+ array(isset($numMessages) ? $numMessages : '',$real_box,$imapConnection));
+ }
+ }
+
+ /* Return the final product. */
+ return ($line);
+}
+
+/**
+ * Recursive function that computes the collapsed status and parent
+ * (or not parent) status of this box, and the visiblity and collapsed
+ * status and parent (or not parent) status for all children boxes.
+ */
+function compute_folder_children(&$parbox, $boxcount) {
+ global $boxes, $data_dir, $username, $collapse_folders;
+ $nextbox = $parbox + 1;
+
+ /* Retreive the name for the parent box. */
+ $parbox_name = $boxes[$parbox]['unformatted'];
+
+ /* 'Initialize' this parent box to childless. */
+ $boxes[$parbox]['parent'] = FALSE;
+
+ /* Compute the collapse status for this box. */
+ if( isset($collapse_folders) && $collapse_folders ) {
+ $collapse = getPref($data_dir, $username, 'collapse_folder_' . $parbox_name);
+ $collapse = ($collapse == '' ? SM_BOX_UNCOLLAPSED : $collapse);
+ } else {
+ $collapse = SM_BOX_UNCOLLAPSED;
+ }
+ $boxes[$parbox]['collapse'] = $collapse;
+
+ /* Otherwise, get the name of the next box. */
+ if (isset($boxes[$nextbox]['unformatted'])) {
+ $nextbox_name = $boxes[$nextbox]['unformatted'];
+ } else {
+ $nextbox_name = '';
+ }
+
+ /* Compute any children boxes for this box. */
+ while (($nextbox < $boxcount) &&
+ (is_parent_box($boxes[$nextbox]['unformatted'], $parbox_name))) {
+
+ /* Note that this 'parent' box has at least one child. */
+ $boxes[$parbox]['parent'] = TRUE;
+
+ /* Compute the visiblity of this box. */
+ $boxes[$nextbox]['visible'] = ($boxes[$parbox]['visible'] &&
+ ($boxes[$parbox]['collapse'] != SM_BOX_COLLAPSED));
+
+ /* Compute the visibility of any child boxes. */
+ compute_folder_children($nextbox, $boxcount);
+ }
+
+ /* Set the parent box to the current next box. */
+ $parbox = $nextbox;
+}
+
+/**
+ * Create the link for a parent folder that will allow that
+ * parent folder to either be collapsed or expaned, as is
+ * currently appropriate.
+ */
+function create_collapse_link($boxnum) {
+ global $boxes, $imapConnection, $unseen_notify, $color;
+ $mailbox = urlencode($boxes[$boxnum]['unformatted']);
+
+ /* Create the link for this collapse link. */
+ $link = '<a target="left" style="text-decoration:none" ' .
+ 'href="left_main.php?';
+ if ($boxes[$boxnum]['collapse'] == SM_BOX_COLLAPSED) {
+ $link .= "unfold=$mailbox\">+";
+ } else {
+ $link .= "fold=$mailbox\">-";
+ }
+ $link .= '</a>';
+
+ $hooklink = do_hook_function('create_collapse_link',$link);
+ if ($hooklink != '')
+ $link = $hooklink;
+
+ /* Return the finished product. */
+ return ($link);
+}
+
+/**
+ * create_unseen_string:
+ *
+ * Create unseen and total message count for both this folder and
+ * it's subfolders.
+ *
+ * @param string $boxName name of the current mailbox
+ * @param array $boxArray array for the current mailbox
+ * @param $imapConnection current imap connection in use
+ * @return array[0] unseen message string (for display)
+ * @return array[1] unseen message count
+ */
+function create_unseen_string($boxName, $boxArray, $imapConnection, $unseen_type) {
+ global $boxes, $unseen_type, $color, $unseen_cum;
+
+ /* Initialize the return value. */
+ $result = array(0,0);
+
+ /* Initialize the counts for this folder. */
+ $boxUnseenCount = 0;
+ $boxMessageCount = 0;
+ $totalUnseenCount = 0;
+ $totalMessageCount = 0;
+
+ /* Collect the counts for this box alone. */
+ $status = sqimap_status_messages($imapConnection, $boxName);
+ $boxUnseenCount = $status['UNSEEN'];
+ if ($boxUnseenCount === false) {
+ return false;
+ }
+ if ($unseen_type == 2) {
+ $boxMessageCount = $status['MESSAGES'];
+ }
+
+ /* Initialize the total counts. */
+
+ if ($boxArray['collapse'] == SM_BOX_COLLAPSED && $unseen_cum) {
+ /* Collect the counts for this boxes subfolders. */
+ $curBoxLength = strlen($boxName);
+ $boxCount = count($boxes);
+
+ for ($i = 0; $i < $boxCount; ++$i) {
+ /* Initialize the counts for this subfolder. */
+ $subUnseenCount = 0;
+ $subMessageCount = 0;
+
+ /* Collect the counts for this subfolder. */
+ if (($boxName != $boxes[$i]['unformatted'])
+ && (substr($boxes[$i]['unformatted'], 0, $curBoxLength) == $boxName)
+ && !in_array('noselect', $boxes[$i]['flags'])) {
+ $status = sqimap_status_messages($imapConnection, $boxes[$i]['unformatted']);
+ $subUnseenCount = $status['UNSEEN'];
+ if ($unseen_type == 2) {
+ $subMessageCount = $status['MESSAGES'];;
+ }
+ /* Add the counts for this subfolder to the total. */
+ $totalUnseenCount += $subUnseenCount;
+ $totalMessageCount += $subMessageCount;
+ }
+ }
+
+ /* Add the counts for all subfolders to that of the box. */
+ $boxUnseenCount += $totalUnseenCount;
+ $boxMessageCount += $totalMessageCount;
+ }
+
+ /* And create the magic unseen count string. */
+ /* Really a lot more then just the unseen count. */
+ if (($unseen_type == 1) && ($boxUnseenCount > 0)) {
+ $result[0] = "($boxUnseenCount)";
+ } else if ($unseen_type == 2) {
+ $result[0] = "($boxUnseenCount/$boxMessageCount)";
+ $result[0] = "<font color=\"$color[11]\">$result[0]</font>";
+ }
+
+ /* Set the unseen count to return to the outside world. */
+ $result[1] = $boxUnseenCount;
+
+ /* Return our happy result. */
+ return ($result);
+}
+
+/**
+ * This simple function checks if a box is another box's parent.
+ */
+function is_parent_box($curbox_name, $parbox_name) {