Indentation fixes and minor cleanups
[squirrelmail.git] / src / right_main.php
index 47f488a380b2f8c9ab662d64aa26489ac5119814..00a166e1bcd5fbbf5c1c532367766349e253605d 100644 (file)
@@ -1,4 +1,5 @@
 <?php
+
 /**
  * right_main.php
  *
@@ -54,32 +55,28 @@ sqgetGlobalVar('base_uri',  $base_uri,      SQ_SESSION);
 
 sqgetGlobalVar('mailbox',   $mailbox);
 sqgetGlobalVar('lastTargetMailbox', $lastTargetMailbox, SQ_SESSION);
-sqgetGlobalVar('sort'             , $sort,              SQ_SESSION);
-sqgetGlobalVar('session',           $session,           SQ_GET);
+sqgetGlobalVar('targetMailbox', $lastTargetMailbox, SQ_POST);
 sqgetGlobalVar('note',              $note,              SQ_GET);
 sqgetGlobalVar('mail_sent',         $mail_sent,         SQ_GET);
 
+
 if ( sqgetGlobalVar('startMessage', $temp) ) {
-  $startMessage = (int) $temp;
-}
-if ( sqgetGlobalVar('PG_SHOWNUM', $temp) ) {
-  $PG_SHOWNUM = (int) $temp;
+    $startMessage = (int) $temp;
+} else {
+    $startMessage = 1;
 }
-if ( sqgetGlobalVar('PG_SHOWALL', $temp, SQ_GET) ) {
-  $PG_SHOWALL = (int) $temp;
+// sort => srt because of the changed behaviour which can break new behaviour
+if ( sqgetGlobalVar('srt', $temp, SQ_GET) ) {
+    $srt = (int) $temp;
 }
-if ( sqgetGlobalVar('newsort', $temp, SQ_GET) ) {
-  $newsort = (int) $temp;
+
+if ( sqgetGlobalVar('showall', $temp, SQ_GET) ) {
+    $showall = (int) $temp;
 }
+
 if ( sqgetGlobalVar('checkall', $temp, SQ_GET) ) {
   $checkall = (int) $temp;
 }
-if ( sqgetGlobalVar('set_thread', $temp, SQ_GET) ) {
-  $set_thread = (int) $temp;
-}
-if ( !sqgetGlobalVar('composenew', $composenew, SQ_GET) ) {
-    $composenew = false;
-}
 /* end of get globals */
 
 
@@ -87,132 +84,120 @@ if ( !sqgetGlobalVar('composenew', $composenew, SQ_GET) ) {
 
 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
 
-if (isset($PG_SHOWALL)) {
-    if ($PG_SHOWALL) {
-       $PG_SHOWNUM=999999;
-       $show_num=$PG_SHOWNUM;
-       sqsession_register($PG_SHOWNUM, 'PG_SHOWNUM');
-    }
-    else {
-       sqsession_unregister('PG_SHOWNUM');
-       unset($PG_SHOWNUM);
-    }
-}
-else if( isset( $PG_SHOWNUM ) ) {
-    $show_num = $PG_SHOWNUM;
-}
 $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.
+ */
 
-if (isset($newsort) ) {
-    if ( $newsort != $sort ) {
-        setPref($data_dir, $username, 'sort', $newsort);
-    }
-    $oldsort = $sort;
-    $sort = $newsort;
-    sqsession_register($sort, 'sort');
-}
 
+$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');
 
-$aMbxResponse = sqimap_mailbox_select($imapConnection, $mailbox);
-$aMbxResponse['SORT_ARRAY'] = false;
+$aMailboxPrefSer=getPref($data_dir, $username, "pref_$mailbox");
+if ($aMailboxPrefSer) {
+    $aMailboxPref = unserialize($aMailboxPrefSer);
+} else {
+    setUserPref($username,"pref_$mailbox",serialize($aMailboxGlobalPref));
+    $aMailboxPref = $aMailboxGlobalPref;
+}
+if (isset($srt)) {
+    $aMailboxPref[MBX_PREF_SORT] = (int) $srt;
+}
+
+
+/**
+ * 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');
 
-sqgetGlobalVar('aLastSelectedMailbox',$aLastSelectedMailbox,SQ_SESSION);
 
-// deal with imap servers that do not return the required UIDNEXT or
-// UIDVALIDITY response
-// from a SELECT call (since rfc 3501 it's required)
-if (!isset($aMbxResponse['UIDNEXT']) || !isset($aMbxResponse['UIDVALIDITY'])) {
-    $aStatus = sqimap_status_messages($imapConnection,$mailbox,
-                                      array('UIDNEXT','UIDVALIDITY'));
-    $aMbxResponse['UIDNEXT'] = $aStatus['UIDNEXT'];
-    $aMbxResponse['UIDVALIDTY'] = $aStatus['UIDVALIDITY'];
+/**
+ * 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;
 }
 
-if ($aLastSelectedMailbox) {
-    // check if we deal with the same mailbox
-    if ($aLastSelectedMailbox['NAME'] == $mailbox) {
-       if ($aLastSelectedMailbox['EXISTS'] == $aMbxResponse['EXISTS'] &&
-           $aLastSelectedMailbox['UIDVALIDITY'] == $aMbxResponse['UIDVALIDITY'] &&
-           $aLastSelectedMailbox['UIDNEXT']  == $aMbxResponse['UIDNEXT']) {
-           sqgetGlobalVar('server_sort_array',$server_sort_array,SQ_SESSION);
-           if ($server_sort_array && is_array($server_sort_array)) {
-               $aMbxResponse['SORT_ARRAY'] = $server_sort_array;
-               // check if oldsort can be used in case we changed the sort order of the same column
-               if (isset($newsort) ) {
-                    if ((($newsort % 2) && ($newsort + 1 == $oldsort)) ||
-                        (!($newsort % 2) && ($newsort - 1 == $oldsort))) {
-                        $server_sort_array = array_reverse($server_sort_array);
-                    } else {
-                        $server_sort_array = false;
-                    }
-               }
-               $aMbxResponse['SORT_ARRAY'] = $server_sort_array;
-           }
-       }
-    }
+/**
+ * Retrieve the mailbox cache from the session.
+ */
+sqgetGlobalVar('mailbox_cache',$mailbox_cache,SQ_SESSION);
+
+
+$aMailbox = sqm_api_mailbox_select($imapConnection,$mailbox,$aConfig,$aMailboxPref);
+
+
+/*
+ * After initialisation of the mailbox array it's time to handle the FORM data
+ */
+$sError = handleMessageListForm($imapConnection,$aMailbox);
+if ($sError) {
+   $note = $sError;
 }
 
-$aLastSelectedMailbox['NAME'] = $mailbox;
-$aLastSelectedMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
-$aLastSelectedMailbox['UIDVALIDITY'] = $aMbxResponse['UIDVALIDITY'];
-$aLastSelectedMailbox['UIDNEXT'] = $aMbxResponse['UIDNEXT'];
-$aLastSelectedMailbox['PERMANENTFLAGS'] = $aMbxResponse['PERMANENTFLAGS'];
-$aLastSelectedMailbox['OFFSET'] = (isset($startMessage) && $startMessage) ? $startMessage -1 : 0;
-$aLastSelectedMailbox['PAGEOFFSET'] = (isset($startMessage) && $startMessage) ? $startMessage : 1;
-$aLastSelectedMailbox['SORT'] = ($sort !== false) ? $sort : 0;
-$aLastSelectedMailbox['LIMIT'] = ($show_num != 999999) ? $show_num : $aMbxResponse['EXISTS'];
-
-$aLastSelectedMailbox['UIDSET'] = $aMbxResponse['SORT_ARRAY'];
-$aLastSelectedMailbox['SEEN'] = (isset($aMbxResponse['SEEN'])) ? $aMbxResponse['SEEN'] : $aMbxResponse['EXISTS'];
-$aLastSelectedMailbox['RECENT'] = (isset($aMbxResponse['RECENT'])) ? $aMbxResponse['RECENT'] : 0;
-
-$aLastSelectedMailbox['AUTO_EXPUNGE'] = $auto_expunge;
-
-/* decide if we are thread sorting or not */
-$aLastSelectedMailbox['ALLOW_THREAD'] = $allow_thread_sort;
-if ($allow_thread_sort == TRUE) {
-    if (isset($set_thread)) {
-        $aLastSelectedMailbox['SORT_ARRAY'] = false;
-        if (sqsession_is_registered('indent_array')) {
-            sqsession_unregister('indent_array');
-        }
-        if (sqsession_is_registered('server_sort_array')) {
-            sqsession_unregister('server_sort_array');
-        }
-        if ($set_thread == 1) {
-            setPref($data_dir, $username, "thread_$mailbox", 1);
-            $thread_sort_messages = '1';
-        } else if ($set_thread == 2)  {
-            setPref($data_dir, $username, "thread_$mailbox", 0);
-            $thread_sort_messages = '0';
-        }
+/*
+ * 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 {
-        $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox");
+        // 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 {
-    $thread_sort_messages = 0;
-}
-if ($thread_sort_messages == 1) {
-    $aLastSelectedMailbox['SORT_METHOD'] = 'THREAD';
-} else if ($allow_server_sort) {
-    $aLastSelectedMailbox['SORT_METHOD'] = 'SERVER';
-} else {
-    $aLastSelectedMailbox['SORT_METHOD'] = 'SQUIRREL';
-}
-
-if ($composenew) {
-    $comp_uri = SM_PATH . 'src/compose.php?mailbox='. urlencode($mailbox).
-        "&session=$session";
-    displayPageHeader($color, $mailbox, "comp_in_new('$comp_uri');", false);
 } else {
     displayPageHeader($color, $mailbox);
 }
+
 do_hook('right_main_after_header');
 
 /* display a message to the user that their mail has been sent */
@@ -220,7 +205,7 @@ 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";
+    echo html_tag( 'div', '<b>' . $note .'</b>', 'center' ) . "<br />\n";
 }
 
 if ( sqgetGlobalVar('just_logged_in', $just_logged_in, SQ_SESSION) ) {
@@ -243,13 +228,29 @@ if ( sqgetGlobalVar('just_logged_in', $just_logged_in, SQ_SESSION) ) {
         }
     }
 }
-
-showMessagesForMailbox($imapConnection,$aLastSelectedMailbox);
+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>';
 
-sqsession_register($aLastSelectedMailbox,'aLastSelectedMailbox');
+/* add the mailbox to the cache */
+$mailbox_cache[$aMailbox['NAME']] = $aMailbox;
+sqsession_register($mailbox_cache,'mailbox_cache');
 
-?>
+?>
\ No newline at end of file