add PAGE_NAME constant to every page under src/.
[squirrelmail.git] / src / left_main.php
index 9354d26583f2f89d99839f55a44060e0d7eef761..de0055379db18f7c5391a2eb0c3de9f427680cc1 100644 (file)
 /**
  * left_main.php
  *
- * Copyright (c) 1999-2002 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$
+ * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
+ * @package squirrelmail
  */
 
-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,
-           $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;
-
-    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) {
-            $numMessages = sqimap_get_num_messages($imapConnection, $real_box);
-            $unseen_string = "<font color=\"$color[11]\">($unseen/$numMessages)</font>";
-            $unseen_found = TRUE;
-        }
-    }
-
-    $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>'; }
-
-    /* Crate the link for this folder. */
-    $line .= "<A HREF=\"right_main.php?sort=0&startMessage=1&mailbox=$mailboxURL\" TARGET=\"right\" STYLE=\"text-decoration:none\">";
-    if ($special_color) {
-        $line .= "<FONT COLOR=\"$color[11]\">";
-    }
-    $line .= str_replace(' ','&nbsp;',$mailbox);
-    if ($special_color == TRUE)
-        $line .= "</FONT>";
-    $line .= '</A>';
-
-    /* If there are unseen message, close bolding. */
-    if ($unseen > 0) { $line .= "</B>"; }
-
-    /* Print unseen information. */
-    if (isset($unseen_found) && $unseen_found) {
-        $line .= "&nbsp;<SMALL>$unseen_string</SMALL>";
-    }
-
-    if (($move_to_trash) && ($real_box == $trash_folder)) {
-        if (! isset($numMessages)) {
-            $numMessages = sqimap_get_num_messages($imapConnection, $real_box);
-        }
-
-        if ($numMessages > 0) {
-            $urlMailbox = urlencode($real_box);
-            $line .= "\n<small>\n" .
-                    "&nbsp;&nbsp;(<A HREF=\"empty_trash.php\" style=\"text-decoration:none\">"._("empty")."</A>)" .
-                    "\n</small>\n";
-        }
-    }
-
-    /* Return the final product. */
-    return ($line);
-}
+/** This is the left_main page */
+define('PAGE_NAME', 'left_main');
 
 /**
- * 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.
+ * Include the SquirrelMail initialization file.
  */
-function compute_folder_children(&$parbox, $boxcount) {
-    global $boxes, $data_dir, $username, $collapse_folders;
-    $nextbox = $parbox + 1;
+require('../include/init.php');
 
-    /* Retreive the name for the parent box. */
-    $parbox_name = $boxes[$parbox]['unformatted'];
+/* SquirrelMail required files. */
+require_once(SM_PATH . 'functions/imap_general.php');
+require_once(SM_PATH . 'functions/date.php');
+require_once(SM_PATH . 'functions/template/folder_list_util.php');
 
-    /* '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;
+/* These constants are used for folder stuff. */
+define('SM_BOX_UNCOLLAPSED', 0);
+define('SM_BOX_COLLAPSED',   1);
 
-        /* Compute the visiblity of this box. */
-        $boxes[$nextbox]['visible'] = ($boxes[$parbox]['visible'] &&
-                                       ($boxes[$parbox]['collapse'] != SM_BOX_COLLAPSED));
+/* get globals */
+sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION);
 
-        /* Compute the visibility of any child boxes. */
-        compute_folder_children($nextbox, $boxcount);
-    }
+sqgetGlobalVar('fold', $fold, SQ_GET);
+sqgetGlobalVar('unfold', $unfold, SQ_GET);
+/* end globals */
 
-    /* Set the parent box to the current next box. */
-    $parbox = $nextbox;
-}
+// open a connection on the imap port (143)
+// why hide the output?
+$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, true);
 
 /**
- * Create the link for a parent folder that will allow that
- * parent folder to either be collapsed or expaned, as is
- * currently appropriate.
+ * Using stristr since very old preferences may contain "None" and "none".
  */
-function create_collapse_link($boxnum) {
-    global $boxes;
-    $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>';
-
-    /* Return the finished product. */
-    return ($link);
+if (!empty($left_refresh) &&
+    !stristr($left_refresh, 'none')){
+    $xtra =  "\n<meta http-equiv=\"Expires\" content=\"Thu, 01 Dec 1994 16:00:00 GMT\" />\n" .
+             "<meta http-equiv=\"Pragma\" content=\"no-cache\" />\n".
+             "<meta http-equiv=\"REFRESH\" content=\"$left_refresh;URL=left_main.php\" />\n";
+} else {
+    $xtra = '';
 }
 
 /**
- * This simple function checks if a box is another box's parent.
+ * Include extra javascript files needed by template
  */
-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);
+$js_includes = $oTemplate->get_javascript_includes(TRUE);
+foreach ($js_includes as $js_file) {
+    $xtra .= '<script src="'.$js_file.'" type="text/javascript"></script>' ."\n";
 }
 
+// get mailbox list and cache it
+$mailboxes=sqimap_get_mailboxes($imapConnection,false,$show_only_subscribed_folders);
 
-/* -------------------- 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<META HTTP-EQUIV=\"Expires\" CONTENT=\"Thu, 01 Dec 1994 16:00:00 GMT\">\n" .
-             "<META HTTP-EQUIV=\"Pragma\" CONTENT=\"no-cache\">\n".
-             "<META HTTP-EQUIV=\"REFRESH\" CONTENT=\"$left_refresh;URL=left_main.php\">\n";
-} else {
-    $xtra = '';
-}
-
-displayHtmlHeader( 'SquirrelMail', $xtra );
+displayHtmlHeader( $org_title, $xtra );
+$oErrorHandler->setDelayedErrors(true);
 
+sqgetGlobalVar('auto_create_done',$auto_create_done,SQ_SESSION);
 /* 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);
+    $folders_created = false;
     foreach( $autocreate as $folder ) {
-        if (($folder != '') && ($folder != 'none')) {
-            if ( !sqimap_mailbox_exists($imapConnection, $folder)) {
+        if ($folder != '') {
+            /**
+             * If $show_only_subscribed_folders is true, don't use 
+             * $mailboxes array for checking if mailbox exists.
+             * Mailbox list contains only subscribed folders. 
+             * sqimap_mailbox_create() will fail, if folder exists.
+             */
+            if ($show_only_subscribed_folders) {
+                $mailbox_cache = false;
+            } else {
+                $mailbox_cache = $mailboxes;
+            }
+            if ( !sqimap_mailbox_exists($imapConnection, $folder, $mailbox_cache)) {
                 sqimap_mailbox_create($imapConnection, $folder, '');
-            } else if (!sqimap_mailbox_is_subscribed($imapConnection, $folder)) {
-                sqimap_subscribe($imapConnection, $folder);
+                $folders_created = true;
+            } else {
+                // check for subscription is useless and expensive, just
+                // surpress the NO response. Unless we're on Mecury, which
+                // will just subscribe a folder again if it's already
+                // subscribed.
+                if ( strtolower($imap_server_type) != 'mercury32' ||
+                    !sqimap_mailbox_is_subscribed($imapConnection, $folder) ) {
+                    sqimap_subscribe($imapConnection, $folder, false);
+                    $folders_created = true;
+                }
             }
         }
     }
 
     /* Let the world know that autocreation is complete! Hurrah! */
     $auto_create_done = TRUE;
-    session_register('auto_create_done');
+    sqsession_register($auto_create_done, 'auto_create_done');
+    // reload mailbox list
+    if ($folders_created)
+        $mailboxes=sqimap_get_mailboxes($imapConnection,true,$show_only_subscribed_folders);
 }
 
-echo "\n<BODY BGCOLOR=\"$color[3]\" TEXT=\"$color[6]\" LINK=\"$color[6]\" VLINK=\"$color[6]\" ALINK=\"$color[6]\">\n";
-
-do_hook('left_main_before');
-
-$boxes = sqimap_mailbox_list($imapConnection);
-
-echo '<CENTER><FONT SIZE=4><B>'. _("Folders") . "</B><BR></FONT>\n\n";
-
+$clock = '';
 if ($date_format != 6) {
     /* First, display the clock. */
     if ($hour_format == 1) {
-        $hr = 'G:i';
+        $hr = 'H:i';
         if ($date_format == 4) {
             $hr .= ':s';
         }
@@ -249,6 +126,9 @@ if ($date_format != 6) {
     }
 
     switch( $date_format ) {
+    case 0:
+        $clk = date('Y-m-d '.$hr. ' T', time());
+        break;
     case 1:
         $clk = date('m/d/y '.$hr, time());
         break;
@@ -260,19 +140,16 @@ if ($date_format != 6) {
         $clk = date($hr, time());
         break;
     default:
-        $clk = substr( getDayName( date( 'w', time() ) ), 0, 3 ) . date( ', ' . $hr, time() );
+        $clk = getDayAbrv( date( 'w', time() ) ) . date( ', ' . $hr, time() );
     }
     $clk = str_replace(' ','&nbsp;',$clk);
 
-    echo '<CENTER><SMALL>' . str_replace(' ','&nbsp;',_("Last Refresh")) .
-         ": $clk</SMALL></CENTER>";
+//FIXME don't build HTML here - do it in template
+    $clock = '<small><span style="white-space: nowrap;">'
+       . str_replace(' ', '&nbsp;', _("Last Refresh"))
+       . ":</span><br /><span style=\"white-space: nowrap;\">$clk</span></small><br />\n";
 }
 
-/* Next, display the refresh button. */
-echo '<SMALL>(<A HREF="../src/left_main.php" TARGET="left">'.
-     _("refresh folder list") . '</A>)</SMALL></CENTER><BR>';
-
-/* Lastly, display the folder list. */
 if ( $collapse_folders ) {
     /* If directed, collapse or uncollapse a folder. */
     if (isset($fold)) {
@@ -282,64 +159,53 @@ if ( $collapse_folders ) {
     }
 }
 
-/* Prepare do do out collapsedness and visibility computation. */
-$curbox = 0;
-$boxcount = count($boxes);
-
-/* Compute the collapsedness and visibility of each box. */
+/* Get unseen/total display prefs */
+$unseen_type = getPref( $data_dir , $username , 'unseen_type' );
+$unseen_notify = getPref( $data_dir , $username , 'unseen_notify' );
 
-while ($curbox < $boxcount) {
-    $boxes[$curbox]['visible'] = TRUE;
-    compute_folder_children($curbox, $boxcount);
+if (empty($unseen_type)) {
+    if (!empty($default_unseen_type)) {
+        $unseen_type = $default_unseen_type;
+    } else {
+        $unseen_type = 1;
+    }
 }
 
-
-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(' ','&nbsp;',substr($prefix,0,strlen($prefix)-2)).
-                      create_collapse_link($i) . '&nbsp;';
-        } else {
-            $prefix = str_replace(' ','&nbsp;',$prefix);
-        }
-        $line = "<NOBR><TT>$prefix</TT>";
-
-        /* Add the folder name and link. */
-        if (! isset($color[15])) {
-            $color[15] = $color[6];
-        }
-
-        if (in_array('noselect', $boxes[$i]['flags'])) {
-            if( isSpecialMailbox( $boxes[$i]['unformatted']) ) {
-                $line .= "<FONT COLOR=\"$color[11]\">";
-            } else {
-                $line .= "<FONT COLOR=\"$color[15]\">";
-            }
-            if (ereg("^( *)([^ ]*)", $mailbox, $regs)) {
-                $mailbox = str_replace('&nbsp;','',$mailbox);
-                $line .= str_replace(' ', '&nbsp;', $mailbox);
-            }
-            $line .= '</FONT>';
-        } else {
-            $line .= formatMailboxName($imapConnection, $boxes[$i]);
-        }
-
-        /* Put the final touches on our folder line. */
-        $line .= "</NOBR><BR>\n";
-
-        /* Output the line for this folder. */
-        echo $line;
+if (empty($unseen_notify)) {
+    if (!empty($default_unseen_notify)) {
+        $unseen_notify = $default_unseen_notify;
+    } else {
+        $unseen_notify = 0;
     }
 }
 
-sqimap_logout($imapConnection);
-do_hook('left_main_after');
+/**
+ * pass $mailboxes now instead of $imapconnection - sqimap_get_mailboxes() has been separated from
+ * sqimap_mailbox_tree() so that the cached mailbox list can be used elsewhere in left_main and beyond
+ */
+$boxes = sqimap_mailbox_tree($imapConnection,$mailboxes,$show_only_subscribed_folders);
+$mailbox_structure = getBoxStructure($boxes);
 
-echo "</BODY></HTML>\n";
+$oTemplate->assign('clock', $clock);
+$oTemplate->assign('mailboxes', $mailbox_structure);
 
-?>
\ No newline at end of file
+/*
+ * Build an array to pass user prefs to the template in order to avoid using
+ * globals, which are dirty, filthy things in templates. :)
+ */
+$settings = array();
+#$settings['imapConnection'] = $imapConnection;
+$settings['templateID'] = $sTemplateID;
+$settings['unreadNotificationEnabled'] = $unseen_notify!=1;
+$settings['unreadNotificationAllFolders'] = $unseen_notify == 3;
+$settings['unreadNotificationDisplayTotal'] = $unseen_type == 2;
+$settings['unreadNotificationCummulative'] = $unseen_cum==1;
+$settings['useSpecialFolderColor'] = $use_special_folder_color;
+$settings['messageRecyclingEnabled'] = $move_to_trash;
+$settings['collapsableFoldersEnabled'] = $collapse_folders==1;
+$oTemplate->assign('settings', $settings);
+
+$oTemplate->display('left_main.tpl');
+
+sqimap_logout($imapConnection);
+$oTemplate->display('footer.tpl');