6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
9 * This is the code for the left bar. The left bar shows the folders
10 * available, and has cookie information.
15 require_once('../src/validate.php');
16 require_once('../functions/array.php');
17 require_once('../functions/imap.php');
18 require_once('../functions/plugin.php');
19 require_once('../functions/page_header.php');
21 /* These constants are used for folder stuff. */
22 define('SM_BOX_UNCOLLAPSED', 0);
23 define('SM_BOX_COLLAPSED', 1);
25 /* --------------------- FUNCTIONS ------------------------- */
27 function formatMailboxName($imapConnection, $box_array) {
29 global $folder_prefix, $trash_folder, $sent_folder,
30 $color, $move_to_sent, $move_to_trash,
31 $unseen_notify, $unseen_type, $collapse_folders,
32 $draft_folder, $save_as_draft,
33 $use_special_folder_color;
35 $real_box = $box_array['unformatted'];
36 $mailbox = str_replace(' ','',$box_array['formatted']);
37 $mailboxURL = urlencode($real_box);
39 /* Strip down the mailbox name. */
40 if (ereg("^( *)([^ ]*)$", $mailbox, $regs)) {
46 if (($unseen_notify == 2 && $real_box == 'INBOX') ||
47 $unseen_notify == 3) {
48 $unseen = sqimap_unseen_messages($imapConnection, $real_box);
49 if ($unseen_type == 1 && $unseen > 0) {
50 $unseen_string = "($unseen)";
52 } else if ($unseen_type == 2) {
53 $numMessages = sqimap_get_num_messages($imapConnection, $real_box);
54 $unseen_string = "<font color=\"$color[11]\">($unseen/$numMessages)</font>";
59 $special_color = ($use_special_folder_color && isSpecialMailbox( $real_box ) );
61 /* Start off with a blank line. */
64 /* If there are unseen message, bold the line. */
65 if ($unseen > 0) { $line .= '<B>'; }
67 /* Crate the link for this folder. */
68 $line .= "<A HREF=\"right_main.php?PG_SHOWALL=0&sort=0&startMessage=1&mailbox=$mailboxURL\" TARGET=\"right\" STYLE=\"text-decoration:none\">";
70 $line .= "<FONT COLOR=\"$color[11]\">";
72 if ( $mailbox == 'INBOX' ) {
75 $line .= str_replace(' ',' ',$mailbox);
77 if ($special_color == TRUE)
81 /* If there are unseen message, close bolding. */
82 if ($unseen > 0) { $line .= "</B>"; }
84 /* Print unseen information. */
85 if (isset($unseen_found) && $unseen_found) {
86 $line .= " <SMALL>$unseen_string</SMALL>";
89 if (($move_to_trash) && ($real_box == $trash_folder)) {
90 if (! isset($numMessages)) {
91 $numMessages = sqimap_get_num_messages($imapConnection, $real_box);
94 if ($numMessages > 0) {
95 $urlMailbox = urlencode($real_box);
96 $line .= "\n<small>\n" .
97 " (<A HREF=\"empty_trash.php\" style=\"text-decoration:none\">"._("purge")."</A>)" .
102 /* Return the final product. */
107 * Recursive function that computes the collapsed status and parent
108 * (or not parent) status of this box, and the visiblity and collapsed
109 * status and parent (or not parent) status for all children boxes.
111 function compute_folder_children(&$parbox, $boxcount) {
112 global $boxes, $data_dir, $username, $collapse_folders;
113 $nextbox = $parbox +
1;
115 /* Retreive the name for the parent box. */
116 $parbox_name = $boxes[$parbox]['unformatted'];
118 /* 'Initialize' this parent box to childless. */
119 $boxes[$parbox]['parent'] = FALSE;
121 /* Compute the collapse status for this box. */
122 if( isset($collapse_folders) && $collapse_folders ) {
123 $collapse = getPref($data_dir, $username, 'collapse_folder_' . $parbox_name);
124 $collapse = ($collapse == '' ? SM_BOX_UNCOLLAPSED
: $collapse);
126 $collapse = SM_BOX_UNCOLLAPSED
;
128 $boxes[$parbox]['collapse'] = $collapse;
130 /* Otherwise, get the name of the next box. */
131 if (isset($boxes[$nextbox]['unformatted'])) {
132 $nextbox_name = $boxes[$nextbox]['unformatted'];
137 /* Compute any children boxes for this box. */
138 while (($nextbox < $boxcount) &&
139 (is_parent_box($boxes[$nextbox]['unformatted'], $parbox_name))) {
141 /* Note that this 'parent' box has at least one child. */
142 $boxes[$parbox]['parent'] = TRUE;
144 /* Compute the visiblity of this box. */
145 $boxes[$nextbox]['visible'] = ($boxes[$parbox]['visible'] &&
146 ($boxes[$parbox]['collapse'] != SM_BOX_COLLAPSED
));
148 /* Compute the visibility of any child boxes. */
149 compute_folder_children($nextbox, $boxcount);
152 /* Set the parent box to the current next box. */
157 * Create the link for a parent folder that will allow that
158 * parent folder to either be collapsed or expaned, as is
159 * currently appropriate.
161 function create_collapse_link($boxnum) {
163 $mailbox = urlencode($boxes[$boxnum]['unformatted']);
165 /* Create the link for this collapse link. */
166 $link = '<a target="left" style="text-decoration:none" ' .
167 'href="left_main.php?';
168 if ($boxes[$boxnum]['collapse'] == SM_BOX_COLLAPSED
) {
169 $link .= "unfold=$mailbox\">+";
171 $link .= "fold=$mailbox\">-";
175 /* Return the finished product. */
180 * This simple function checks if a box is another box's parent.
182 function is_parent_box($curbox_name, $parbox_name) {
185 /* Extract the name of the parent of the current box. */
186 $curparts = explode($delimiter, $curbox_name);
187 $curname = array_pop($curparts);
188 $actual_parname = implode($delimiter, $curparts);
189 $actual_parname = substr($actual_parname,0,strlen($parbox_name));
191 /* Compare the actual with the given parent name. */
192 return ($parbox_name == $actual_parname);
195 function listBoxes ($boxes, $j=0 ) {
196 global $data_dir, $username, $startmessage, $color, $unseen_notify, $unseen_type,
197 $move_to_trash, $trash_folder, $collapse_folders;
202 $mailbox = $boxes->mailboxname_full
;
204 for ($k = 0; $k < $j; $k++
) {
205 $leader.= '   ';
207 $mailboxURL = urlencode($mailbox);
209 /* get unseen/total messages information */
210 if ($boxes->unseen
) {
211 $unseen = $boxes->unseen
;
212 $unseen_string = "($unseen)";
213 if ($unseen>0) $unseen_found = TRUE;
215 $numMessages = $boxes->total
;
216 $unseen_string = "<font color=\"$color[11]\">($unseen/$numMessages)</font>";
222 if (isset($boxes->mbxs
[0]) && $collapse_folders) {
223 $collapse = getPref($data_dir, $username, 'collapse_folder_' . $mailbox);
224 $collapse = ($collapse == '' ? SM_BOX_UNCOLLAPSED
: $collapse);
226 $link = '<a target="left" style="text-decoration:none" ' .'href="left_main.php?';
228 $link .= "unfold=$mailboxURL\">$leader + ";
230 $link .= "fold=$mailboxURL\">$leader - ";
235 $pre.= $leader . '   ';
239 /* If there are unseen message, bold the line. */
240 if ($unseen > 0) { $pre .= '<B>'; }
242 if (($move_to_trash) && ($mailbox == $trash_folder)) {
243 if (! isset($numMessages)) {
244 $numMessages = sqimap_get_num_messages($imapConnection, $mailbox);
247 if ($numMessages > 0) {
248 $urlMailbox = urlencode($mailbox);
249 $pre .= "\n<small>\n" .
250 " (<A HREF=\"empty_trash.php\" style=\"text-decoration:none\">"._("purge")."</A>)" .
254 if (!$boxes->is_noselect
) {
255 $pre .= "<A HREF=\"right_main.php?PG_SHOWALL=0&sort=0&startMessage=1&mailbox=$mailboxURL\" TARGET=\"right\" STYLE=\"text-decoration:none\">";
260 /* If there are unseen message, close bolding. */
261 if ($unseen > 0) { $end .= "</B>"; }
263 /* Print unseen information. */
264 if (isset($unseen_found) && $unseen_found) {
265 $end .= " <SMALL>$unseen_string</SMALL>";
270 if ($boxes->is_special
) {
271 $font = "<FONT COLOR=\"$color[11]\">";
272 $fontend = "</FONT>";
275 if (!$boxes->is_root
) {
276 echo "" . $pre .$font. $boxes->mailboxname_sub
.$fontend . $end. '<br>';
279 if (!$collapse ||
$boxes->is_root
) {
280 for ($i = 0; $i <count($boxes->mbxs
); $i++
) {
281 listBoxes($boxes->mbxs
[$i],$j);
288 function ListAdvancedBoxes ($boxes, $mbx, $j='ID.0' ) {
289 global $data_dir, $username, $startmessage, $color, $unseen_notify, $unseen_type,
290 $move_to_trash, $trash_folder, $collapse_folders;
292 /* use_folder_images only works if the images exist in ../images */
293 $use_folder_images = false;
300 $mailbox = $boxes->mailboxname_full
;
301 $mailboxURL = urlencode($mailbox);
303 /* get unseen/total messages information */
304 if ($boxes->unseen
) {
305 $unseen = $boxes->unseen
;
306 $unseen_string = "($unseen)";
307 if ($unseen>0) $unseen_found = TRUE;
309 $numMessages = $boxes->total
;
310 $unseen_string = "<font color=\"$color[11]\">($unseen/$numMessages)</font>";
315 /* If there are unseen message, bold the line. */
316 if ($unseen > 0) { $pre .= '<B>'; }
318 if (($move_to_trash) && ($mailbox == $trash_folder)) {
319 if (! isset($numMessages)) {
320 $numMessages = $boxes->total
;
322 if ($numMessages > 0) {
323 $urlMailbox = urlencode($mailbox);
324 $pre .= "\n<small>\n" .
325 " (<A HREF=\"empty_trash.php\" style=\"text-decoration:none\">"._("purge")."</A>)" .
329 if (!$boxes->is_noselect
) { /* \Noselect boxes can't be selected */
330 $pre .= "<A HREF=\"right_main.php?PG_SHOWALL=0&sort=0&startMessage=1&mailbox=$mailboxURL\" TARGET=\"right\" STYLE=\"text-decoration:none\">";
335 /* If there are unseen message, close bolding. */
336 if ($unseen > 0) { $end .= "</B>"; }
338 /* Print unseen information. */
339 if (isset($unseen_found) && $unseen_found) {
340 $end .= " <SMALL>$unseen_string</SMALL>";
346 /* color special boxes */
347 if ($boxes->is_special
) {
348 $font = "<FONT COLOR=\"$color[11]\">";
349 $fontend = "</FONT>";
351 if (!$boxes->is_root
) {
352 if ($use_folder_images) {
353 if ($boxes->is_inbox
) {
354 $folder_img = '../images/inbox.gif';
355 } else if ($boxes->is_sent
) {
356 $folder_img = '../images/senti.gif';
357 } else if ($boxes->is_trash
) {
358 $folder_img = '../images/delitem.gif';
359 } else if ($boxes->is_draft
) {
360 $folder_img = '../images/draft.gif';
361 } else $folder_img = '../images/folder.gif';
362 $folder_img = ' <img src="'.$folder_img.'" heigth="15" valign="center"> ';
363 } else $folder_img = '';
364 if (!isset($boxes->mbxs
[0])) {
365 echo ' <div class="mbx_sub" id='.$j. ' onmouseover="changerowcolor(this,true)" onmouseout="changerowcolor(this,false)">' . $folder_img .$pre .$font. $boxes->mailboxname_sub
.$fontend . $end. '</div>'."\n";
367 /* get collapse information */
368 if ($collapse_folders) {
369 $link = '<a target="left" style="text-decoration:none" ' .'href="left_main.php?';
370 $form_entry = $j.'F';
371 if (isset($mbx) && isset($mbx[$form_entry])) {
372 $collapse = $mbx[$form_entry];
374 setPref($data_dir, $username, 'collapse_folder_'.$boxes->mailboxname_full
, SM_BOX_COLLAPSED
);
376 setPref($data_dir, $username, 'collapse_folder_'.$boxes->mailboxname_full
, SM_BOX_UNCOLLAPSED
);
379 $collapse = getPref($data_dir, $username, 'collapse_folder_' . $mailbox);
380 $collapse = ($collapse == '' ? SM_BOX_UNCOLLAPSED
: $collapse);
383 $link = '<a href="javascript:hidechilds(this)">'." <img src=\"../images/plus.gif\" border=\"1\" id=$j onclick=\"hidechilds(this)\"></A>";
385 $link = '<a href="javascript:hidechilds(this)">'."<img src=\"../images/minus.gif\" border=\"1\" id=$j onclick=\"hidechilds(this)\"></a>";
387 $collapse_link = $link;
388 } else $collapse_link='';
389 echo ' <div class="mbx_par" id='.$j. 'P onmouseover="changerowcolor(this,true)" onmouseout="changerowcolor(this,false)">' . $collapse_link . $folder_img .$pre. $font. '  '. $boxes->mailboxname_sub
.$fontend . $end. '</div>'."\n";
390 echo ' <INPUT TYPE="hidden" name=mbx['.$j. 'F] value="'.$collapse.'">'."\n";
394 $visible = ' STYLE="display:none;"';
396 $visible = ' STYLE="display:inline;"';
399 if (isset($boxes->mbxs
[0]) && !$boxes->is_root
) /* mailbox contains childs */
400 echo '<div class="par_area" id='.$j.'.0 '. $visible .'>'."\n";
404 for ($i = 0; $i <count($boxes->mbxs
); $i++
) {
406 listAdvancedBoxes($boxes->mbxs
[$i],$mbx,$j);
408 if (isset($boxes->mbxs
[0]) && !$boxes->is_root
) echo '</div>'."\n\n";
415 /* -------------------- MAIN ------------------------ */
417 global $delimiter, $default_folder_prefix;
419 // open a connection on the imap port (143)
420 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 10); // the 10 is to hide the output
423 * Using stristr since older preferences may contain "None" and "none".
425 if (isset($left_refresh) && ($left_refresh != '') &&
426 !stristr($left_refresh, "none")){
427 $xtra = "\n<META HTTP-EQUIV=\"Expires\" CONTENT=\"Thu, 01 Dec 1994 16:00:00 GMT\">\n" .
428 "<META HTTP-EQUIV=\"Pragma\" CONTENT=\"no-cache\">\n".
429 "<META HTTP-EQUIV=\"REFRESH\" CONTENT=\"$left_refresh;URL=left_main.php\">\n";
435 * $advanced_tree and $oldway are boolean vars which are default set to default
437 * Setting $oldway to false causes left_main.php to use the new experimental
438 * way of getting the mailbox-tree.
439 * Setting $advanced tree to true causes SM to display a experimental
440 * mailbox-tree with dhtml behaviour.
441 * It only works on browsers which supports css and javascript. The used
442 * javascript is experimental and doesn't support all browsers. It is tested on
443 * IE6 an Konquerer 3.0.0-2.
444 * In the function ListAdvancedBoxes there is another var $use_folder_images.
445 * setting this to true is only usefull if the images exists in ../images.
447 * Feel free to experiment with the code and report bugs and enhancements
448 * to marc@its-projects.nl
451 $advanced_tree = false; /* set this to true if you want to see a nicer mailboxtree */
452 $oldway = true; /* default SM behaviour */
454 if ($advanced_tree) {
456 <script language="Javascript">
460 function hidechilds(el) {
462 form_id = "mbx[" + el.id +"F]";
464 ele = document.all[id];
465 if(ele.style.display == 'none') {
466 ele.style.display = 'inline';
467 document.all[el.id].src="../images/minus.gif";
468 document.all[form_id].value=0;
470 ele.style.display = 'none';
471 document.all[el.id].src="../images/plus.gif";
472 document.all[form_id].value=1;
474 } else if (document.getElementById) {
476 ele = document.getElementById(id);
477 img_ele = document.getElementById(el.id);
478 if(ele.style.display == 'none') {
479 ele.style.display = 'inline';
480 img_ele.src="../images/minus.gif";
481 document.getElementById(form_id).value=0;
483 ele.style.display = 'none';
484 img_ele.src="../images/plus.gif";
485 document.getElementById(form_id).value=1;
491 if (!document.images) return;
492 var ar = new Array();
493 var arguments = preload.arguments;
494 for (var i = 0; i<arguments.length; i++) {
496 ar[i].src = arguments[i];
500 function changerowcolor(el,on) {
503 if (!on) { document.all[id].style.background="#FFFFFF"; }
504 else { document.all[id].style.background="#AAAAAA"; }
505 } else if (document.getElementById) {
506 if (!on) { document.getElementById(id).style.background="#FFFFFF"; }
507 else { document.getElementById(id).style.background="#AAAAAA"; }
511 function buttonover(el,on) {
513 el.style.borderColor="blue";}
515 el.style.borderColor="orange";}
518 function buttonclick(el,on) {
520 el.style.border="groove"}
522 el.style.border="ridge";}
530 /* style definitions */
539 background-color:white;
567 border-left-width:0.1em;
568 border-left-color:blue;
569 border-bottom: solid;
570 border-bottom-width:0.1em;
571 border-bottom-color:blue;
583 background-color:white;
597 displayHtmlHeader( 'SquirrelMail', $xtra );
599 /* If requested and not yet complete, attempt to autocreate folders. */
600 if ($auto_create_special && !isset($auto_create_done)) {
601 $autocreate = array($sent_folder, $trash_folder, $draft_folder);
602 foreach( $autocreate as $folder ) {
603 if (($folder != '') && ($folder != 'none')) {
604 if ( !sqimap_mailbox_exists($imapConnection, $folder)) {
605 sqimap_mailbox_create($imapConnection, $folder, '');
606 } else if (!sqimap_mailbox_is_subscribed($imapConnection, $folder)) {
607 sqimap_subscribe($imapConnection, $folder);
612 /* Let the world know that autocreation is complete! Hurrah! */
613 $auto_create_done = TRUE;
614 session_register('auto_create_done');
617 echo "\n<BODY BGCOLOR=\"$color[3]\" TEXT=\"$color[6]\" LINK=\"$color[6]\" VLINK=\"$color[6]\" ALINK=\"$color[6]\">\n";
619 do_hook('left_main_before');
622 echo '<CENTER><FONT SIZE=4><B>'. _("Folders") . "</B><BR></FONT>\n\n";
624 if ($date_format != 6) {
625 /* First, display the clock. */
626 if ($hour_format == 1) {
628 if ($date_format == 4) {
632 if ($date_format == 4) {
639 switch( $date_format ) {
641 $clk = date('m/d/y '.$hr, time());
644 $clk = date('d/m/y '.$hr, time());
648 $clk = date($hr, time());
651 $clk = substr( getDayName( date( 'w', time() ) ), 0, 3 ) . date( ', ' . $hr, time() );
653 $clk = str_replace(' ',' ',$clk);
655 echo '<CENTER><SMALL>' . str_replace(' ',' ',_("Last Refresh")) .
656 ": $clk</SMALL></CENTER>";
659 /* Next, display the refresh button. */
660 echo '<SMALL>(<A HREF="../src/left_main.php" TARGET="left">'.
661 _("refresh folder list") . '</A>)</SMALL></CENTER><BR>';
663 /* Lastly, display the folder list. */
664 if ( $collapse_folders ) {
665 /* If directed, collapse or uncollapse a folder. */
667 setPref($data_dir, $username, 'collapse_folder_' . $fold, SM_BOX_COLLAPSED
);
668 } else if (isset($unfold)) {
669 setPref($data_dir, $username, 'collapse_folder_' . $unfold, SM_BOX_UNCOLLAPSED
);
673 if ($oldway) { /* normal behaviour SM */
675 $boxes = sqimap_mailbox_list($imapConnection);
676 /* Prepare do do out collapsedness and visibility computation. */
678 $boxcount = count($boxes);
680 /* Compute the collapsedness and visibility of each box. */
682 while ($curbox < $boxcount) {
683 $boxes[$curbox]['visible'] = TRUE;
684 compute_folder_children($curbox, $boxcount);
688 for ($i = 0; $i < count($boxes); $i++
) {
689 if ( $boxes[$i]['visible'] ) {
690 $mailbox = $boxes[$i]['formatted'];
691 $mblevel = substr_count($boxes[$i]['unformatted'], $delimiter) +
1;
693 /* Create the prefix for the folder name and link. */
694 $prefix = str_repeat(' ',$mblevel);
695 if (isset($collapse_folders) && $collapse_folders && $boxes[$i]['parent']) {
696 $prefix = str_replace(' ',' ',substr($prefix,0,strlen($prefix)-2)).
697 create_collapse_link($i) . ' ';
699 $prefix = str_replace(' ',' ',$prefix);
701 $line = "<NOBR><TT>$prefix</TT>";
703 /* Add the folder name and link. */
704 if (! isset($color[15])) {
705 $color[15] = $color[6];
708 if (in_array('noselect', $boxes[$i]['flags'])) {
709 if( isSpecialMailbox( $boxes[$i]['unformatted']) ) {
710 $line .= "<FONT COLOR=\"$color[11]\">";
712 $line .= "<FONT COLOR=\"$color[15]\">";
714 if (ereg("^( *)([^ ]*)", $mailbox, $regs)) {
715 $mailbox = str_replace(' ','',$mailbox);
716 $line .= str_replace(' ', ' ', $mailbox);
720 $line .= formatMailboxName($imapConnection, $boxes[$i]);
723 /* Put the final touches on our folder line. */
724 $line .= "</NOBR><BR>\n";
726 /* Output the line for this folder. */
730 } else { /* expiremental code */
731 $boxes = sqimap_mailbox_tree($imapConnection);
732 if (isset($advanced_tree) && $advanced_tree) {
733 echo '<FORM name=collapse action="left_main.php" METHOD=POST' .
734 'ENCTYPE="multipart/form-data"'."\n";
735 echo '<small><button type="submit" class="button" onmouseover="buttonover(this,true)" onmouseout="buttonover(this,false)" onmousedown="buttonclick(this,true)" onmouseup="buttonclick(this,false)">'. _("Save folder tree") .'</button><br><br>';
736 echo '<DIV ID=mailboxes CLASS=mailboxes>'."\n\n";
737 if (!isset($mbx)) $mbx=NULL;
738 ListAdvancedBoxes($boxes, $mbx);
739 echo '</div></small>'."\n";
744 } /* if ($oldway) else ... */
746 do_hook('left_main_after');
747 sqimap_logout($imapConnection);
749 echo "</BODY></HTML>\n";