Indentation fixes and minor cleanups
[squirrelmail.git] / src / right_main.php
index 07492d1a1d4db104f4939c001f39ca8f37e96f37..00a166e1bcd5fbbf5c1c532367766349e253605d 100644 (file)
@@ -3,22 +3,32 @@
 /**
  * right_main.php
  *
- * Copyright (c) 1999-2002 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 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.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
  */
 
-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');
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+define('SM_PATH','../');
+
+/* 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');
 
 /***********************************************************
  * incoming variables from URL:                            *
@@ -29,124 +39,218 @@ require_once('../functions/display_messages.php');
  *    $mailbox          Full Mailbox name                  *
  *                                                         *
  * incoming from cookie:                                   *
- *    $username         duh                                *
  *    $key              pass                               *
+ * incoming from session:                                  *
+ *    $username         duh                                *
+ *                                                         *
  ***********************************************************/
 
-$bob = getHashedFile($username, $data_dir, "username.pref");
 
-/* Open a connection on the imap port (143) */
-$imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
+/* 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);
 
-if( isset( $PG_SHOWNUM ) ) {
-    $show_num = $PG_SHOWNUM;
-}
+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 (isset($newsort) && $newsort != $sort) {
-    setPref($data_dir, $username, 'sort', $newsort);
-}
 
-/* If the page has been loaded without a specific mailbox, */
-/* send them to the inbox                                  */
-if (!isset($mailbox)) {
-    $mailbox = 'INBOX';
+if ( sqgetGlobalVar('startMessage', $temp) ) {
+    $startMessage = (int) $temp;
+} else {
     $startMessage = 1;
 }
-   
-if (!isset($startMessage) || ($startMessage == '')) {
-    $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;
 }
+/* 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.
+ */
+
 
-sqimap_mailbox_select($imapConnection, $mailbox);
-if( strtolower( $mailbox ) == 'inbox' ) {
-    displayPageHeader($color, _("INBOX"));
+$aMailboxGlobalPref = array(
+                       MBX_PREF_SORT         => 0,
+                       MBX_PREF_LIMIT        => (int)  $show_num,
+                       MBX_PREF_AUTO_EXPUNGE => (bool) $auto_expunge,
+                       MBX_PREF_INTERNALDATE => (bool) getPref($data_dir, $username, 'internal_date_sort')
+                    // MBX_PREF_FUTURE       => (var)  $future
+                     );
+
+/* not sure if this hook should be capable to alter the global pref array */
+do_hook ('generic_header');
+
+$aMailboxPrefSer=getPref($data_dir, $username, "pref_$mailbox");
+if ($aMailboxPrefSer) {
+    $aMailboxPref = unserialize($aMailboxPrefSer);
 } else {
-    displayPageHeader($color, $mailbox);
+    setUserPref($username,"pref_$mailbox",serialize($aMailboxGlobalPref));
+    $aMailboxPref = $aMailboxGlobalPref;
+}
+if (isset($srt)) {
+    $aMailboxPref[MBX_PREF_SORT] = (int) $srt;
 }
-echo "<br>\n";
 
-do_hook('right_main_after_header');
 
-if (isset($note)) {
-    echo "<CENTER><B>$note</B></CENTER><BR>\n";
-}
+/**
+ * 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');
 
-if ($just_logged_in == true) {
-    $just_logged_in = false;
-
-    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>';
-    }
-}
 
-if (isset($newsort)) {
-    $sort = $newsort;
-    session_register('sort');
+/**
+ * system wide admin settings and incoming vars.
+ */
+$aConfig = array(
+                'allow_thread_sort' => $allow_thread_sort,
+                'allow_server_sort' => $allow_server_sort,
+                'user'              => $username,
+                // incoming vars
+                'offset' => $startMessage
+                );
+/**
+ * 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;
 }
 
-/*********************************************************************
- * 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;
-}
+/**
+ * Retrieve the mailbox cache from the session.
+ */
+sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
 
-/* There is a problem with registered vars in 4.1 */
-if( substr( phpversion(), 0, 3 ) == '4.1'  ) {
-    $use_mailbox_cache = FALSE;
-}
 
-if ($use_mailbox_cache && session_is_registered('msgs')) {
-    showMessagesForMailbox($imapConnection, $mailbox, $numMessages, $startMessage, $sort, $color, $show_num, $use_mailbox_cache);
-} else {
-    if (session_is_registered('msgs')) {
-        unset($msgs);
-    }
+$aMailbox = sqm_api_mailbox_select($imapConnection,$mailbox,$aConfig,$aMailboxPref);
 
-    if (session_is_registered('msort')) {
-        unset($msort);
-    }
 
-    if (session_is_registered('numMessages')) {
-        unset($numMessages);
+/*
+ * After initialisation of the mailbox array it's time to handle the FORM data
+ */
+$sError = handleMessageListForm($imapConnection,$aMailbox);
+if ($sError) {
+   $note = $sError;
+}
+
+/*
+ * 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) {
+        // 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();
+        sqsession_is_active();
+        $comp_uri = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
+                    '&session='.$aMailbox['FORWARD_SESSION'];
+        displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri');", false);
+    } else {
+        // save mailboxstate
+        sqsession_register($aMailbox,'aLastSelectedMailbox');
+        session_write_close();
+        // we have to redirect to the compose page
+        global $PHP_SELF;
+        if (!strpos($PHP_SELF,'?')) {
+            $location = $PHP_SELF.'?mailbox=INBOX&amp;startMessage=1';
+        } else {
+            $location = $PHP_SELF;
+        }
+        $location = set_url_var($location, 'session',$aMailbox['FORWARD_SESSION'], false);
+        header("Location: $location");
+        exit;
     }
+} else {
+    displayPageHeader($color, $mailbox);
+}
 
-    $numMessages = sqimap_get_num_messages ($imapConnection, $mailbox);
+do_hook('right_main_after_header');
 
-    showMessagesForMailbox($imapConnection, $mailbox, $numMessages, 
-                           $startMessage, $sort, $color, $show_num,
-                           $use_mailbox_cache);
+/* 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>' . $note .'</b>', 'center' ) . "<br />\n";
+}
 
-    if (session_is_registered('msgs') && isset($msgs)) {
-        session_register('msgs');
-    }
+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) {
+    showMessagesForMailbox($imapConnection,$aMailbox);
+} 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);
+echo '</body></html>';
 
-echo '</BODY></HTML>';
+/* add the mailbox to the cache */
+$mailbox_cache[$aMailbox['NAME']] = $aMailbox;
+sqsession_register($mailbox_cache,'mailbox_cache');
 
 ?>
\ No newline at end of file