Error handling and more templates
[squirrelmail.git] / src / right_main.php
index f10ed956de67b09b25700d9ab5073d336b4e0735..019a4879bc08378aa269c4772dd9bee28f620f7a 100644 (file)
 <?php
-    /**
-     * right_main.php
-     *
-     * Copyright (c) 1999-2001 The Squirrelmail Development 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.
-     *
-     * $Id$
-     */
 
-    require_once('../src/validate.php');
-    require_once('../functions/imap.php');
-    require_once('../functions/date.php');
-    require_once('../functions/array.php');
-    require_once('../functions/mime.php');
-    require_once('../functions/mailbox_display.php');
-    require_once('../functions/display_messages.php');
-
-    /***********************************************************
-     * incoming variables from URL:                            *
-     *   $sort             Direction to sort by date           *
-     *                        values:  0  -  descending order  *
-     *                        values:  1  -  ascending order   *
-     *   $startMessage     Message to start at                 *
-     *    $mailbox          Full Mailbox name                  *
-     *                                                         *
-     * incoming from cookie:                                   *
-     *    $username         duh                                *
-     *    $key              pass                               *
-     ***********************************************************/
-
-    /* Open a connection on the imap port (143) */
-    $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-
-    if (isset($newsort) && $newsort != $sort) {
-        setPref($data_dir, $username, 'sort', $newsort);
-    }
+/**
+ * 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.
+ *
+ * @version $Id$
+ * @package squirrelmail
+ */
 
-    /* If the page has been loaded without a specific mailbox, */
-    /* send them to the inbox                                  */
-    if (!isset($mailbox)) {
-        $mailbox = 'INBOX';
-        $startMessage = 1;
-    }
-    
-    if (! isset($startMessage) || $startMessage == '')
-       $startMessage = 1;
-
-    /* compensate for the UW vulnerability. */
-    if ($imap_server_type == 'uw' && (strstr($mailbox, '../') ||
-                                      substr($mailbox, 0, 1) == '/')) {
-       $mailbox = 'INBOX';
-    }
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../');
 
-    sqimap_mailbox_select($imapConnection, $mailbox);
-    displayPageHeader($color, $mailbox);
-    echo "<br>\n";
+/* 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/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 . 'class/error.class.php');
 
-    do_hook('right_main_after_header');
 
-    if (isset($note)) {
-        echo "<CENTER><B>$note</B></CENTER><BR>\n";
-    }
+//include_once(SM_PATH . 'templates/default/message_list.tpl');
+include_once(SM_PATH . 'class/template/template.class.php');
 
-    if ($just_logged_in == true) {
-        $just_logged_in = false;
+/**
+ * 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 (strlen(trim($motd)) > 0) {
-            echo "<br><table align=center width=70% cellpadding=0 cellspacing=3 border=0 bgcolor=\"$color[9]\">" .
-                 '<tr><td>' .
-                 "<table width=100% cellpadding=5 cellspacing=1 border=0 bgcolor=\"$color[4]\">" .
-                 "<tr><td align=center>$motd";
-            do_hook('motd');
-            echo '</td></tr>' .
-                 '</table>' .
-                 '</td></tr></table>';
+/*
+ * Initialize the template object
+ */
+$oTemplate = new Template($sTplDir);
+
+/*
+ * Initialize our custom error handler object
+ */
+$oErrorHandler = new ErrorHandler($oTemplate,'error_message.tpl');
+
+/*
+ * Activate custom error handling
+ */
+if (version_compare(PHP_VERSION, "4.3.0", ">=")) {
+    $oldErrorHandler = set_error_handler(array($oErrorHandler, 'SquirrelMailErrorhandler'));
+} else {
+    $oldErrorHandler = set_error_handler('SquirrelMailErrorhandler');
+}
+
+// Trigger Developers to look at CSS ;)
+trigger_error("This layout sucks. Adapt squirrelmail.css!!!",E_USER_WARNING);
+//sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',"BLA1",'BAD', 'BLA2', array('test1'=>'test1'));
+
+/* 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('mailbox',   $mailbox);
+sqgetGlobalVar('lastTargetMailbox', $lastTargetMailbox, SQ_SESSION);
+sqgetGlobalVar('targetMailbox', $lastTargetMailbox, SQ_POST);
+sqgetGlobalVar('note',              $note,              SQ_GET);
+sqgetGlobalVar('mail_sent',         $mail_sent,         SQ_GET);
+
+
+if ( sqgetGlobalVar('startMessage', $temp) ) {
+    $startMessage = (int) $temp;
+} else {
+    $startMessage = 1;
+}
+// sort => srt because of the changed behaviour which can break new behaviour
+if ( sqgetGlobalVar('srt', $temp, SQ_GET) ) {
+    $srt = (int) $temp;
+}
+
+if ( sqgetGlobalVar('showall', $temp, SQ_GET) ) {
+    $showall = (int) $temp;
+}
+
+if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
+  $checkall = (int) $temp;
+}
+
+/* future work */
+if ( sqgetGlobalVar('account', $account, SQ_GET) ) {
+  $account = (int) $account;
+} else {
+  $account = 0;
+}
+
+/* end of get globals */
+
+
+/* Open an imap connection */
+
+$imapConnection = sqimap_login($username, $key, $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);
+    $aMailboxPref[MBX_PREF_COLUMNS] = $index_order; // index_order contains the columns to show and the order of the columns
+} else {
+    setUserPref($username,'pref_'.$account.'_'.$mailbox,serialize($default_mailbox_pref));
+    $aMailboxPref = $default_mailbox_pref;
+}
+if (isset($srt)) {
+    $aMailboxPref[MBX_PREF_SORT] = (int) $srt;
+}
+
+$trash_folder = (isset($trash_folder)) ? $trash_folder : false;
+$sent_folder = (isset($sent_folder)) ? $sent_folder : false;
+$draft_folder = (isset($draft_folder)) ? $draft_folder : false;
+
+
+/**
+ * until there is no per mailbox option screen to set prefs we override
+ * the mailboxprefs by the default ones
+ */
+$aMailboxPref[MBX_PREF_LIMIT] = (int)  $show_num;
+$aMailboxPref[MBX_PREF_AUTO_EXPUNGE] = (bool) $auto_expunge;
+$aMailboxPref[MBX_PREF_INTERNALDATE] = (bool) getPref($data_dir, $username, 'internal_date_sort');
+$aMailboxPref[MBX_PREF_COLUMNS] = $index_order;
+
+/**
+ * Replace From => To  in case it concerns a draft or sent folder
+ */
+if (($mailbox == $sent_folder || $mailbox == $draft_folder) &&
+    !in_array(SQM_COL_TO,$aMailboxPref[MBX_PREF_COLUMNS])) {
+    $aNewOrder = array(); // nice var name ;)
+    foreach($aMailboxPref[MBX_PREF_COLUMNS] as $iCol) {
+        if ($iCol == SQM_COL_FROM) {
+            $iCol = SQM_COL_TO;
         }
-    }
+        $aNewOrder[] = $iCol;
+   }
+   $aMailboxPref[MBX_PREF_COLUMNS] = $aNewOrder;
+   setUserPref($username,'pref_'.$account.'_'.$mailbox,serialize($aMailboxPref));
+}
 
-    if (isset($newsort)) {
-        $sort = $newsort;
-        session_register('sort');
-    }
 
-    /*********************************************************************
-     * Check to see if we can use cache or not. Currently the only time  *
-     * when you will not use it is when a link on the left hand frame is *
-     * used. Also check to make sure we actually have the array in the   *
-     * registered session data.  :)                                      *
-     *********************************************************************/
-    if (! isset($use_mailbox_cache)) {
-        $use_mailbox_cache = 0;
-    }
 
-    if ($use_mailbox_cache && session_is_registered('msgs')) {
-        showMessagesForMailbox($imapConnection, $mailbox, $numMessages, $startMessage, $sort, $color, $show_num, $use_mailbox_cache);
+/**
+ * Set the config options for the messages list
+ */
+$aColumns = array(); // contains settings per column. Switch to key -> value based array, order is the order of the array keys
+foreach ($aMailboxPref[MBX_PREF_COLUMNS] as $iCol) {
+    $aColumns[$iCol] = array();
+    switch ($iCol) {
+        case SQM_COL_SUBJ:
+            if ($truncate_subject) {
+                $aColumns[$iCol]['truncate'] = $truncate_subject;
+            }
+            break;
+        case SQM_COL_FROM:
+        case SQM_COL_TO:
+        case SQM_COL_CC:
+        case SQM_COL_BCC:
+            if ($truncate_sender) {
+                $aColumns[$iCol]['truncate'] = $truncate_sender;
+            }
+            break;
+   }
+}
+
+/**
+ * Properties required by showMessagesForMailbox
+ */
+$aProps = array(
+    'columns' => $aColumns, // columns bound settings
+    'config'  => array('alt_index_colors'       => $alt_index_colors,       // alternating row colors (should be a template thing)
+                        'highlight_list'        => $message_highlight_list, // row highlighting rules
+                        'fancy_index_highlite'  => $fancy_index_highlite,   // highlight rows on hover or on click -> check
+                        'show_flag_buttons'     => (isset($show_flag_buttons)) ? $show_flag_buttons : true,
+                        'lastTargetMailbox'     => (isset($lastTargetMailbox)) ? $lastTargetMailbox : '', // last mailbox where messages are moved/copied to
+                        'trash_folder'          => $trash_folder,
+                        'sent_folder'           => $sent_folder,
+                        'draft_folder'          => $draft_folder,
+                        'color'                 => $color,
+                        'enablesort'            => true // enable sorting on columns
+                ),
+    'mailbox' => $mailbox,
+    'account' => (isset($account)) ? $account : 0, // future usage if we support multiple imap accounts
+    'module' => 'read_body',
+    'email'  => false);
+
+
+/**
+ * system wide admin settings and incoming vars.
+ */
+$aConfig = array(
+                'user'              => $username,
+                // incoming vars
+                'offset' => $startMessage // offset in paginator
+                );
+/**
+ * The showall functionality is for the moment added to the config array
+ * to avoid storage of the showall link in the mailbox pref. We could change
+ * this behaviour later and add it to $aMailboxPref instead
+ */
+if (isset($showall)) {
+    $aConfig['showall'] = $showall; // show all messages in a mailbox (paginator is disabled)
+} else {
+    $showall = false;
+}
+
+
+/**
+ * Retrieve the mailbox cache from the session.
+ */
+sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
+
+/**
+ * Select the mailbox and retrieve the cached info.
+ */
+$aMailbox = sqm_api_mailbox_select($imapConnection,$account, $mailbox,$aConfig,$aMailboxPref);
+
+/**
+ * MOVE THIS to a central init section !!!!
+ */
+if (!sqgetGlobalVar('align',$align,SQ_SESSION)) {
+    $dir = ( isset( $languages[$squirrelmail_language]['DIR']) ) ? $languages[$squirrelmail_language]['DIR'] : 'ltr';
+    if ( $dir == 'ltr' ) {
+        $align = array('left' => 'left', 'right' => 'right');
     } else {
-        if (session_is_registered('msgs')) {
-            unset($msgs);
-        }
+        $align = array('left' => 'right', 'right' => 'left');
+    }
+    sqsession_register($align, 'align');
+}
+
+/*
+ * After initialisation of the mailbox array it's time to handle the FORM data
+ */
+$sError = handleMessageListForm($imapConnection,$aMailbox);
+if ($sError) {
+   $note = $sError;
+}
 
-        if (session_is_registered('msort')) {
-            unset($msort);
-        }
 
-        if (session_is_registered('numMessages')) {
-            unset($numMessages);
+
+/*
+ * 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
+ */
+if (isset($aMailbox['FORWARD_SESSION'])) {
+    if ($compose_new_win) {
+        /* add the mailbox to the cache */
+        $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
+        sqsession_register($mailbox_cache,'mailbox_cache');
+        // write the session in order to make sure that the compose window has
+        // access to the composemessages array which is stored in the 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();
+        if (!preg_match("/^[0-9]{3,4}$/", $compose_width)) {
+            $compose_width = '640';
+        }
+        if (!preg_match("/^[0-9]{3,4}$/", $compose_height)) {
+            $compose_height = '550';
         }
+        // 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);", '');
+    } else {
+        $mailbox_cache[$account.'_'.$aMailbox['NAME']] = $aMailbox;
+        sqsession_register($mailbox_cache,'mailbox_cache');
 
-        $numMessages = sqimap_get_num_messages ($imapConnection, $mailbox);
+        // save mailboxstate
+        sqsession_register($aMailbox,'aLastSelectedMailbox');
+        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'];
+        header("Location: $location");
+        exit;
+    }
+} else {
+    displayPageHeader($color, $mailbox);
+}
 
-        showMessagesForMailbox($imapConnection, $mailbox, $numMessages, 
-                               $startMessage, $sort, $color, $show_num,
-                               $use_mailbox_cache);
+do_hook('right_main_after_header');
 
-        if (session_is_registered('msgs') && isset($msgs)) {
-            session_register('msgs');
-        }
+/* 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.");
+}
+if (isset($note)) {
+    echo html_tag( 'div', '<b>' . htmlspecialchars($note) .'</b>', 'center' ) . "<br />\n";
+}
+
+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 (session_is_registered('msort') && isset($msort)) {
-            session_register('msort');
+        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"' );
         }
+    }
+}
+
 
-        session_register('numMessages');
+if ($aMailbox['EXISTS'] > 0) {
+    $aTemplateVars =& showMessagesForMailbox($imapConnection,$aMailbox,$aProps,$iError);
+    if ($iError) {
+
+    }
+    foreach ($aTemplateVars as $k => $v) {
+        $oTemplate->assign($k, $v);
     }
 
-    do_hook('right_main_bottom');
-    sqimap_logout ($imapConnection);
-?>
-</FONT>
-</BODY>
-</HTML>
+    /*
+     * TODO: To many config related vars. We should move all config related vars to
+     * one single associative array and assign that to the template
+     */
+    $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('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('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->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>';
+}
+
+do_hook('right_main_bottom');
+sqimap_logout ($imapConnection);
+$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