X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=src%2Fleft_main.php;h=f3458cff2faa8aa98c0a39dc8ab0de0551dcffd1;hp=d88bc15f4a0ed05b85149f1a82e7567ee166737a;hb=a3439b271e1b5fa7e61362970dbbcc5bfc75e5b1;hpb=345a8a92d0036bafe902f12dd7c2c00971ac0c04 diff --git a/src/left_main.php b/src/left_main.php index d88bc15f..f3458cff 100644 --- a/src/left_main.php +++ b/src/left_main.php @@ -1,203 +1,360 @@ 0) { + +/** + * left_main.php + * + * Copyright (c) 1999-2001 The Squirrelmail Development 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$ + / + +/*****************************************************************/ +/*** THIS FILE NEEDS TO HAVE ITS FORMATTING FIXED!!! ***/ +/*** PLEASE DO SO AND REMOVE THIS COMMENT SECTION. ***/ +/*** + Base level indent should begin at left margin, as ***/ +/*** the require_once below looks. ***/ +/*** + All identation should consist of four space blocks ***/ +/*** + Tab characters are evil. ***/ +/*** + all comments should use "slash-star ... star-slash" ***/ +/*** style -- no pound characters, no slash-slash style ***/ +/*** + FLOW CONTROL STATEMENTS (if, while, etc) SHOULD ***/ +/*** ALWAYS USE { AND } CHARACTERS!!! ***/ +/*** + Please use ' instead of ", when possible. Note " ***/ +/*** should always be used in _( ) function calls. ***/ +/*** Thank you for your help making the SM code more readable. ***/ +/*****************************************************************/ + +require_once('../src/validate.php'); +require_once('../functions/array.php'); +require_once('../functions/imap.php'); +require_once('../functions/plugin.php'); +require_once('../functions/page_header.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; + global $color, $move_to_sent, $move_to_trash; + global $unseen_notify, $unseen_type, $collapse_folders; + global $draft_folder, $save_as_draft; + global $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; + + if (($unseen_notify == 2 && $real_box == 'INBOX') || + $unseen_notify == 3) { + $unseen = sqimap_unseen_messages($imapConnection, $real_box); + if ($unseen_type == 1 && $unseen > 0) { $unseen_string = "($unseen)"; $unseen_found = true; - } else if ($unseen_type == 2) { + } else if ($unseen_type == 2) { $numMessages = sqimap_get_num_messages($imapConnection, $real_box); $unseen_string = "($unseen/$numMessages)"; $unseen_found = true; - } - } - - $special_color = false; - if ((strtolower($real_box) == "inbox") || - (($real_box == $trash_folder) && ($move_to_trash)) || - (($real_box == $sent_folder) && ($move_to_sent))) - $special_color = true; - - $spaces = ''; - $line = ""; - if (ereg("^( *)([^ ]*)$", $mailbox, $regs)) { - $spaces = $regs[1]; - $mailbox = $regs[2]; - } - - if ($unseen > 0) - $line .= ' '; - $line .= str_replace(' ', ' ', $spaces); - - if ($collapse_folders) { - if (isset($box_array['parent'])) - $line .= FoldLink($box_array['unformatted'], $box_array['parent']); - else - $line .= '   '; - } - - $line .= ""; - if ($special_color == true) - $line .= ""; - $line .= str_replace(' ',' ',$mailbox); - if ($special_color == true) - $line .= ""; - $line .= ''; - - if ($unseen > 0) - $line .= ""; - - if (isset($unseen_found) && $unseen_found) { - $line .= " $unseen_string"; - } - - if (($move_to_trash == true) && ($real_box == $trash_folder)) { - if (! isset($numMessages)) + } + } + + $special_color = false; + if ($use_special_folder_color) { + if ((strtolower($real_box) == 'inbox') + || (($real_box == $trash_folder) && ($move_to_trash)) + || (($real_box == $sent_folder) && ($move_to_sent)) + || (($real_box == $draft_folder) && ($save_as_draft))) { + $special_color = true; + } + } + + /* Start off with a blank line. */ + $line = ''; + + /* If there are unseen message, bold the line. */ + if ($unseen > 0) { $line .= ''; } + + /* Crate the link for this folder. */ + $line .= ""; + if ($special_color == true) + $line .= ""; + $line .= str_replace(' ',' ',$mailbox); + if ($special_color == true) + $line .= ""; + $line .= ''; + + /* If there are unseen message, close bolding. */ + if ($unseen > 0) { $line .= ""; } + + /* Print unseen information. */ + if (isset($unseen_found) && $unseen_found) { + $line .= " $unseen_string"; + } + + if (($move_to_trash == true) && ($real_box == $trash_folder)) { + if (! isset($numMessages)) { $numMessages = sqimap_get_num_messages($imapConnection, $real_box); + } - if ($numMessages > 0) - { + if ($numMessages > 0) { $urlMailbox = urlencode($real_box); - $line .= "\n\n"; - $line .= "   ("._("purge").")"; - $line .= "\n\n"; - } - } - $line .= ""; - return $line; - } - - if (isset($left_refresh) && ($left_refresh != "None") && ($left_refresh != "")) { - echo "\n"; - echo "\n"; - echo "\n"; - } - - echo "\n\n"; - - do_hook("left_main_before"); - - $boxes = sqimap_mailbox_list($imapConnection); - - echo "
"; - echo _("Folders") . "
\n\n"; - - echo "("; - echo _("refresh folder list"); - echo ")

"; - $delimeter = sqimap_get_delimiter($imapConnection); - - if (isset($collapse_folders) && $collapse_folders) { - if (isset($fold)) - setPref($data_dir, $username, 'collapse_folder_' . $fold, 1); - if (isset($unfold)) - setPref($data_dir, $username, 'collapse_folder_' . $unfold, 0); - $IAmAParent = array(); - for ($i = 0; $i < count($boxes); $i ++) { - $parts = explode($delimeter, $boxes[$i]['unformatted']); - $box_name = array_pop($parts); - $box_parent = implode($delimeter, $parts); - $hidden = 0; - if (isset($box_parent)) { - $hidden = getPref($data_dir, $username, - 'collapse_folder_' . $box_parent); - $IAmAParent[$box_parent] = $hidden; - } - $boxes[$i]['folded'] = $hidden; - } - } - - for ($i = 0;$i < count($boxes); $i++) { - if (! isset($boxes[$i]['folded']) || ! $boxes[$i]['folded']) - { - $line = ""; - $mailbox = $boxes[$i]["formatted"]; - - if (isset($collapse_folders) && $collapse_folders && isset($IAmAParent[$boxes[$i]['unformatted']])) { - $boxes[$i]['parent'] = $IAmAParent[$boxes[$i]['unformatted']]; - } - - if (in_array('noselect', $boxes[$i]['flags'])) { - $line .= ""; + $line .= "\n\n" . + "  ("._("empty").")" . + "\n\n"; + } + } + + /* 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. */ + if ($boxes[$parbox]['visible'] && + ($boxes[$parbox]['collapse'] != SM_BOX_COLLAPSED)) { + $boxes[$nextbox]['visible'] = true; + } else { + $boxes[$nextbox]['visible'] = false; + } + + /* 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; + $mailbox = urlencode($boxes[$boxnum]['unformatted']); + + /* Create the link for this collapse link. */ + $link = '+"; + } else { + $link .= "fold=$mailbox\">-"; + } + $link .= ''; + + /* Return the finished product. */ + return ($link); +} + +/** + * This simple function checks if a box is another box's parent. + */ +function is_parent_box($curbox_name, $parbox_name) { + global $delimiter; + + /* Extract the name of the parent of the current box. */ + $curparts = explode($delimiter, $curbox_name); + $curname = array_pop($curparts); + $actual_parname = implode($delimiter, $curparts); + $actual_parname = substr($actual_parname,0,strlen($parbox_name)); + + /* Compare the actual with the given parent name. */ + return ($parbox_name == $actual_parname); +} + + +/* -------------------- MAIN ------------------------ */ + +global $delimiter, $default_folder_prefix; + +// open a connection on the imap port (143) +$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 10); // the 10 is to hide the output + + +if (isset($left_refresh) && ($left_refresh != 'none') && ($left_refresh != '')) { + $xtra = "\n\n" . + "\n". + "\n"; +} else { + $xtra = ''; +} + +displayHtmlHeader( 'SquirrelMail', $xtra ); + +/* If requested and not yet complete, attempt to autocreate folders. */ +if ($auto_create_special && !isset($auto_create_done)) { + $autocreate = array($sent_folder, $trash_folder, $draft_folder); + foreach( $autocreate as $folder ) { + if (($folder != '') && ($folder != 'none')) { + if ( !sqimap_mailbox_exists($imapConnection, $folder)) { + sqimap_mailbox_create($imapConnection, $folder, ''); + } else if (!sqimap_mailbox_is_subscribed($imapConnection, $folder)) { + sqimap_subscribe($imapConnection, $folder); + } + } + } + + /* Let the world know that autocreation is complete! Hurrah! */ + $auto_create_done = true; + session_register('auto_create_done'); +} + +echo "\n\n"; + +do_hook('left_main_before'); + +$boxes = sqimap_mailbox_list($imapConnection); + +echo '
'. _("Folders") . "
\n\n"; + +if ($date_format != 6) { + /* First, display the clock. */ + if ($hour_format == 1) { + $hr = 'G:i'; + if ($date_format == 4) { + $hr .= ':s'; + } + } else { + if ($date_format == 4) { + $hr = 'g:i:s a'; + } else { + $hr = 'g:i a'; + } + } + + switch( $date_format ) { + case 1: + $clk = date('m/d/y '.$hr, time()); + break; + case 2: + $clk = date('d/m/y '.$hr, time()); + break; + case 4: + case 5: + $clk = date($hr, time()); + break; + default: + $clk = date('D, '.$hr, time()); + } + $clk = str_replace(' ',' ',$clk); + + echo '
' . str_replace(' ',' ',_("Last Refresh")) . + ": $clk
"; +} + +/* Next, display the refresh button. */ +echo '('. + _("refresh folder list") . ')

'; + +/* Lastly, display the folder list. */ +if ( $collapse_folders ) { + /* If directed, collapse or uncollapse a folder. */ + if (isset($fold)) { + setPref($data_dir, $username, 'collapse_folder_' . $fold, SM_BOX_COLLAPSED); + } else if (isset($unfold)) { + setPref($data_dir, $username, 'collapse_folder_' . $unfold, SM_BOX_UNCOLLAPSED); + } +} + +/* Prepare do do out collapsedness and visibility computation. */ +$curbox = 0; +$boxcount = count($boxes); + +/* Compute the collapsedness and visibility of each box. */ +while ($curbox < $boxcount) { + $boxes[$curbox]['visible'] = TRUE; + compute_folder_children($curbox, $boxcount); +} + +for ($i = 0;$i < count($boxes); $i++) { + if ( $boxes[$i]['visible'] ) { + $mailbox = $boxes[$i]['formatted']; + $mblevel = substr_count($boxes[$i]['unformatted'], $delimiter) + 1; + + /* Create the prefix for the folder name and link. */ + $prefix = str_repeat(' ',$mblevel); + if (isset($collapse_folders) && $collapse_folders && $boxes[$i]['parent']) { + $prefix = str_replace(' ',' ',substr($prefix,0,strlen($prefix)-2)). + create_collapse_link($i) . ' '; + } else { + $prefix = str_replace(' ',' ',$prefix); + } + $line = "$prefix"; + + /* Add the folder name and link. */ + if (in_array('noselect', $boxes[$i]['flags'])) { + $line .= ""; if (ereg("^( *)([^ ]*)", $mailbox, $regs)) { + $mailbox = str_replace(' ','',$mailbox); $line .= str_replace(' ', ' ', $mailbox); - if (isset($boxes[$i]['parent'])) - $line .= FoldLink($boxes[$i]['unformatted'], $boxes[$i]['parent']); - elseif ($collapse_folders) - $line .= '  '; } $line .= ''; - } else { - $line .= formatMailboxName($imapConnection, $boxes[$i], $delimeter); - } - echo "$line
\n"; - } - } - sqimap_logout($imapConnection); - do_hook("left_main_after"); - - function FoldLink($mailbox, $folded) { - $mailbox = urlencode($mailbox); - $link = ' +"; - else - $link .= "fold=$mailbox\">-"; - $link .= ' '; - return ($link); - } - + } else { + $line .= formatMailboxName($imapConnection, $boxes[$i]); + } + + /* Put the final touches on our folder line. */ + $line .= "

\n"; + + /* Output the line for this folder. */ + echo $line; + } +} + +sqimap_logout($imapConnection); +do_hook('left_main_after'); + +echo "\n"; + ?> -