Fix a FIXME
[squirrelmail.git] / src / right_main.php
index b87d4b05fa52a46cd884ad0dedcc0df1707be7a0..6ee921956e7b456bb1b2843ac64678beb4d7d38e 100644 (file)
@@ -1,45 +1,51 @@
 <?php
+
 /**
  * right_main.php
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
  * This is where the mailboxes are listed. This controls most of what
  * goes on in SquirrelMail.
  *
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
  */
 
+/** This is the right_main page */
+define('PAGE_NAME', 'right_main');
+
+//xdebug_start_profiling("/var/spool/xdebug/right_main.txt");
+
+
 /**
- * Path for SquirrelMail required files.
- * @ignore
+ * Include the SquirrelMail initialization file.
  */
-define('SM_PATH','../');
+include('../include/init.php');
+
+/* If email_address not set and admin wants us to ask user for it,
+ * redirect to options page. */
+if ( $ask_user_info && getPref($data_dir, $username,'email_address') == "" ) {
+    header("Location: " . get_location() . "/options.php?optpage=personal");
+    exit;
+}
 
 /* SquirrelMail required files. */
-require_once(SM_PATH . 'include/validate.php');
-require_once(SM_PATH . 'functions/global.php');
-require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'functions/imap_asearch.php');
+require_once(SM_PATH . 'functions/imap_general.php');
+require_once(SM_PATH . 'functions/imap_messages.php');
 require_once(SM_PATH . 'functions/date.php');
 require_once(SM_PATH . 'functions/mime.php');
 require_once(SM_PATH . 'functions/mailbox_display.php');
-require_once(SM_PATH . 'functions/display_messages.php');
-require_once(SM_PATH . 'functions/html.php');
-require_once(SM_PATH . 'functions/plugin.php');
-
-//include_once(SM_PATH . 'templates/default/message_list.tpl');
-include_once(SM_PATH . 'class/template/template.class.php');
-
+require_once(SM_PATH . 'functions/compose.php');
 
 /* lets get the global vars we may need */
-sqgetGlobalVar('key',       $key,           SQ_COOKIE);
-sqgetGlobalVar('username',  $username,      SQ_SESSION);
-sqgetGlobalVar('onetimepad',$onetimepad,    SQ_SESSION);
 sqgetGlobalVar('delimiter', $delimiter,     SQ_SESSION);
-sqgetGlobalVar('base_uri',  $base_uri,      SQ_SESSION);
-
+sqgetGlobalVar('delayed_errors',  $delayed_errors,  SQ_SESSION);
+if (is_array($delayed_errors)) {
+    $oErrorHandler->AssignDelayedErrors($delayed_errors);
+    sqsession_unregister("delayed_errors");
+}
 sqgetGlobalVar('mailbox',   $mailbox);
 sqgetGlobalVar('lastTargetMailbox', $lastTargetMailbox, SQ_SESSION);
 sqgetGlobalVar('targetMailbox', $lastTargetMailbox, SQ_POST);
@@ -47,7 +53,7 @@ sqgetGlobalVar('note',              $note,              SQ_GET);
 sqgetGlobalVar('mail_sent',         $mail_sent,         SQ_GET);
 
 
-if ( sqgetGlobalVar('startMessage', $temp) ) {
+if ( sqGetGlobalVarMultiple('startMessage', $temp, 'paginator_submit') ) {
     $startMessage = (int) $temp;
 } else {
     $startMessage = 1;
@@ -61,8 +67,8 @@ if ( sqgetGlobalVar('showall', $temp, SQ_GET) ) {
     $showall = (int) $temp;
 }
 
-if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
-  $checkall = (int) $temp;
+if (!sqgetGlobalVar('checkall',$checkall,SQ_GET)) {
+    $checkall = false;
 }
 
 /* future work */
@@ -77,25 +83,16 @@ if ( sqgetGlobalVar('account', $account, SQ_GET) ) {
 
 /* Open an imap connection */
 
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+$imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0);
 
 $mailbox = (isset($mailbox) && $mailbox) ? $mailbox : 'INBOX';
 
-/* compensate for the UW vulnerability. */
-if ($imap_server_type == 'uw' && (strstr($mailbox, '../') ||
-                                  substr($mailbox, 0, 1) == '/')) {
-   $mailbox = 'INBOX';
-}
 /**
  * Set the global settings for a mailbox and merge them with the usersettings
  * for the mailbox. In the future we can add more mailbox specific preferences
  * preferences.
  */
 
-
-/* not sure if this hook should be capable to alter the global pref array */
-do_hook ('generic_header');
-
 $aMailboxPrefSer=getPref($data_dir, $username,'pref_'.$account.'_'.$mailbox);
 if ($aMailboxPrefSer) {
     $aMailboxPref = unserialize($aMailboxPrefSer);
@@ -236,16 +233,13 @@ if ($sError) {
    $note = $sError;
 }
 
-/**
- * Which templatedir are we using. TODO, add make a config var of this and make it possible to switch templates
- */
-$sTplDir = SM_PATH . 'templates/default/';
 
 
 /*
  * If we try to forward messages as attachment we have to open a new window
  * in case of compose in new window or redirect to compose.php
  */
+$onload = '';
 if (isset($aMailbox['FORWARD_SESSION'])) {
     if ($compose_new_win) {
         /* add the mailbox to the cache */
@@ -256,7 +250,7 @@ if (isset($aMailbox['FORWARD_SESSION'])) {
         session_write_close();
         // restart the session. Do not use sqsession_is_active because the session_id
         // isn't empty after a session_write_close
-        session_start();
+        sqsession_start();
         if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
             $compose_width = '640';
         }
@@ -265,8 +259,8 @@ if (isset($aMailbox['FORWARD_SESSION'])) {
         }
         // do not use &amp;, it will break the query string and $session will not be detected!!!
         $comp_uri = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
-                    '&session='.$aMailbox['FORWARD_SESSION'];
-        displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri', $compose_width, $compose_height);", '');
+                    '&session='.urlencode($aMailbox['FORWARD_SESSION']);
+        $onload = "comp_in_new('$comp_uri', $compose_width, $compose_height);";
     } else {
         $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
         sqsession_register($mailbox_cache,'mailbox_cache');
@@ -276,54 +270,59 @@ if (isset($aMailbox['FORWARD_SESSION'])) {
         session_write_close();
         // we have to redirect to the compose page
         $location = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
-                    '&amp;session='.$aMailbox['FORWARD_SESSION'];
+                    '&session='.$aMailbox['FORWARD_SESSION'];
         header("Location: $location");
         exit;
     }
-} else {
-    displayPageHeader($color, $mailbox);
 }
 
-do_hook('right_main_after_header');
+// plugins can operate normally here (don't output anything, of course!),
+// but can also return TRUE if they want to enable the MOTD display
+// even when SM's MOTD is empty (there is plugin output that can
+// be then hooked into in motd.tpl)  
+// NOTE a TRUE return value here will cause the display of the MOTD on 
+// *every* page view; if a plugin wants to support true MOTD (one-time 
+// message display upon login), it should also check the value of 
+// "just_logged_in" in the PHP session before returning TRUE.
+//
+$show_motd = boolean_hook_function('right_main_after_header', $null, 1);
+
+
+// get "just_logged_in" from PHP session, save it in a temp variable
+// for use below, and reset its value in PHP session
+//
+if (!sqgetGlobalVar('just_logged_in', $just_logged_in, SQ_SESSION))
+    $just_logged_in = false;
+$temp_just_logged_in = $just_logged_in;
+$just_logged_in = false;
+sqsession_register($just_logged_in, 'just_logged_in');
+
+
+// now we're done with the PHP session, can send output to browser
+//
+displayPageHeader($color, $mailbox, $onload);
+
 
 /* display a message to the user that their mail has been sent */
 if (isset($mail_sent) && $mail_sent == 'yes') {
-    $note = _("Your Message has been sent.");
+    $note = _("Your mail has been sent.");
 }
 if (isset($note)) {
-    echo html_tag( 'div', '<b>' . $note .'</b>', 'center' ) . "<br />\n";
+    $oTemplate->assign('note', htmlspecialchars($note));
+    $oTemplate->display('note.tpl');
 }
 
-if ( sqgetGlobalVar('just_logged_in', $just_logged_in, SQ_SESSION) ) {
-    if ($just_logged_in == true) {
-        $just_logged_in = false;
-        sqsession_register($just_logged_in, 'just_logged_in');
-
-        if (strlen(trim($motd)) > 0) {
-            echo html_tag( 'table',
-                        html_tag( 'tr',
-                            html_tag( 'td',
-                                html_tag( 'table',
-                                    html_tag( 'tr',
-                                        html_tag( 'td', $motd, 'center' )
-                                    ) ,
-                                '', $color[4], 'width="100%" cellpadding="5" cellspacing="1" border="0"' )
-                             )
-                        ) ,
-                    'center', $color[9], 'width="70%" cellpadding="0" cellspacing="3" border="0"' );
-        }
+if ($temp_just_logged_in || $show_motd) {
+    $motd = trim($motd);
+    if ($show_motd || strlen($motd) > 0) {
+        $oTemplate->assign('motd', $motd);
+        $oTemplate->display('motd.tpl');
     }
 }
 
-/**
- * In the future, move this the the initialisation area
- */
-
-
-$oTemplate = new Template($sTplDir);
 
 if ($aMailbox['EXISTS'] > 0) {
-    $aTemplateVars =& showMessagesForMailbox($imapConnection,$aMailbox,$aProps,$iError);
+    $aTemplateVars = showMessagesForMailbox($imapConnection,$aMailbox,$aProps,$iError);
     if ($iError) {
 
     }
@@ -338,40 +337,27 @@ if ($aMailbox['EXISTS'] > 0) {
     $oTemplate->assign('page_selector',  $page_selector);
     $oTemplate->assign('page_selector_max', $page_selector_max);
     $oTemplate->assign('compact_paginator', $compact_paginator);
-    $oTemplate->assign('javascript_on', $javascript_on);
+    $oTemplate->assign('javascript_on', checkForJavascript());
+    $oTemplate->assign('base_uri', sqm_baseuri());
     $oTemplate->assign('enablesort', (isset($aProps['config']['enablesort'])) ? $aProps['config']['enablesort'] : false);
-    // Aaaaaahhhhhhh FIX ME DO NOT USE the string "none" for a var when you mean the boolean false or null
-    $oTemplate->assign('icon_theme', (isset($icon_theme) && $icon_theme !== 'none') ? $icon_theme : false);
-    $oTemplate->assign('use_icons', (isset($use_icons)) ? $use_icons : false);
+    $oTemplate->assign('icon_theme_path', $icon_theme_path);
     $oTemplate->assign('aOrder', array_keys($aColumns));
     $oTemplate->assign('alt_index_colors', isset($alt_index_colors) ? $alt_index_colors: false);
     $oTemplate->assign('color', $color);
     $oTemplate->assign('align', $align);
-    $oTemplate->assign('showall', $showall);
+    $oTemplate->assign('checkall', $checkall);
 
     $oTemplate->display('message_list.tpl');
 
 } else {
-    $string = '<b>' . _("THIS FOLDER IS EMPTY") . '</b>';
-    echo '    <table width="100%" cellpadding="1" cellspacing="0" align="center" border="0" bgcolor="'.$color[9].'">';
-    echo '     <tr><td>';
-    echo '       <table width="100%" cellpadding="0" cellspacing="0" align="center" border="0" bgcolor="'.$color[4].'">';
-    echo '        <tr><td><br />';
-    echo '            <table cellpadding="1" cellspacing="5" align="center" border="0">';
-    echo '              <tr>' . html_tag( 'td', $string."\n", 'left')
-                        . '</tr>';
-    echo '            </table>';
-    echo '        <br /></td></tr>';
-    echo '       </table></td></tr>';
-    echo '    </table>';
+    $oTemplate->display('empty_folder.tpl');
 }
 
-do_hook('right_main_bottom');
+do_hook('right_main_bottom', $null);
 sqimap_logout ($imapConnection);
-echo '</body></html>';
+$oTemplate->display('footer.tpl');
+
 
 /* add the mailbox to the cache */
 $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
 sqsession_register($mailbox_cache,'mailbox_cache');
-
-?>
\ No newline at end of file