Rewrite of internal message caching
[squirrelmail.git] / src / move_messages.php
index 684e63c5bb00bd1976a27c5dcb2e083795ce388a..d142747de2d3b05a8198f7ebc11857b6fcb5efe1 100644 (file)
 <?php
-
+exit;
 /**
  * move_messages.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.
  *
  * Enables message moving between folders on the IMAP server.
  *
- * $Id$
+ * @version $Id$
+ * @package squirrelmail
  */
 
-require_once('../src/validate.php');
-require_once('../functions/display_messages.php');
-require_once('../functions/imap.php');
-require_once('../functions/html.php');
+/**
+ * Path for SquirrelMail required files.
+ * @ignore
+ */
+
+
+/**
+ * FIX ME REMOVE ME FIX ME REMOVE ME I DON'T DESERVE TO EXIST
+ *
+ * Integrate this is a clean manner in right_main.php and rename right_main to
+ * messageslist or whatever
+ **/
+
+
+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/display_messages.php');
+require_once(SM_PATH . 'functions/imap.php');
+require_once(SM_PATH . 'functions/html.php');
+
 global $compose_new_win;
 
-function putSelectedMessagesIntoString($msg) {
-    $j = 0;
-    $i = 0;
-    $firstLoop = true;
-    // If they have selected nothing msg is size one still, but will
-    // be an infinite loop because we never increment j. so check to
-    // see if msg[0] is set or not to fix this.
-    while (($j < count($msg)) && ($msg[0])) {
-        if ($msg[$i]) {
-            if ($firstLoop != true) {
-                $selectedMessages .= "&amp;";
-            } else {
-                $firstLoop = false;
-            }
-            $selectedMessages .= "selMsg[$j]=$msg[$i]";
-            $j++;
-        }
-        $i++;
-    }
+if ( !sqgetGlobalVar('composesession', $composesession, SQ_SESSION) ) {
+    $composesession = 0;
 }
 
 function attachSelectedMessages($msg, $imapConnection) {
-    global $mailbox, $username, $attachment_dir, $attachments, $identity, 
-           $data_dir, $composesession, $lastTargetMailbox, $uid_support,
-          $msgs, $startMessage, $show_num, $thread_sort_messages,
-          $allow_server_sort;
-
-    if (!isset($attachments)) {
-           $attachments = array();
-           session_register('attachments');
+    global $username, $attachment_dir, $startMessage,
+           $data_dir, $composesession,
+           $msgs, $show_num, $compose_messages;
+
+    if (!isset($compose_messages)) {
+        $compose_messages = array();
+        sqsession_register($compose_messages,'compose_messages');
     }
 
-    if (!isset($composesession) ) {
-           $composesession = 1;
-           session_register('composesession');
+    if (!$composesession) {
+        $composesession = 1;
+        sqsession_register($composesession,'composesession');
     } else {
-           $composesession++;
+        $composesession++;
+        sqsession_register($composesession,'composesession');
     }
 
-    $hashed_attachment_dir = getHashedDir($username, $attachment_dir, $composesession);
-
-    $rem_attachments = array();
-    foreach ($attachments as $info) {
-       if ($info['session'] == $composesession) {
-           $attached_file = "$hashed_attachment_dir/$info[localfilename]";
-           if (file_exists($attached_file)) {
-                   unlink($attached_file);
-           }
-       } else {
-           $rem_attachments[] = $info;
-       }
-    }
+    $hashed_attachment_dir = getHashedDir($username, $attachment_dir);
 
-    $attachments = $rem_attachments;
+    $composeMessage = new Message();
+    $rfc822_header = new Rfc822Header();
+    $composeMessage->rfc822_header = $rfc822_header;
+    $composeMessage->reply_rfc822_header = '';
 
-    if ($thread_sort_messages || $allow_server_sort) {
-       $start_index=0;
-    } else {
-       $start_index = ($startMessage-1) * $show_num;
-    }
+    foreach($msg as $id) {
+        $body_a = sqimap_run_command($imapConnection, "FETCH $id RFC822", true, $response, $readmessage, TRUE);
 
-    $i = 0;
-    $j = 0;
-    $hashed_attachment_dir = getHashedDir($username, $attachment_dir);
-    while ($j < count($msg)) {
-        if (isset($msg[$i])) {
-           $id = $msg[$i];
-           $body_a = sqimap_run_command($imapConnection, "FETCH $id RFC822",true, $response, $readmessage, $uid_support);
-           if ($response = 'OK') {
-               $k = $i + $start_index;
-               $subject = $msgs[$k]['SUBJECT'];
-    
-               array_shift($body_a);
-               $body = implode('', $body_a);
-               $body .= "\r\n";
-                       
-               $localfilename = GenerateRandomString(32, 'FILE', 7);
-               $full_localfilename = "$hashed_attachment_dir/$localfilename";
-               
-               $fp = fopen( $full_localfilename, 'w');
-               fwrite ($fp, $body);
-               fclose($fp);
-               $newAttachment = array();
-               $newAttachment['localfilename'] = $localfilename;
-               $newAttachment['type'] = "message/rfc822";
-               $newAttachment['remotefilename'] = $subject.'.eml';
-               $newAttachment['session'] = $composesession;
-               $attachments[] = $newAttachment;
-               flush();
-           }
-           $j++;
-       }
-       $i++;   
+        if ($response == 'OK') {
+            // fetch the subject for the message with $id from msgs.
+            // is there a more efficient way to do this?
+            foreach($msgs as $k => $vals) {
+                if($vals['ID'] == $id) {
+                    $subject = $msgs[$k]['SUBJECT'];
+                    break;
+                }
+            }
+
+            array_shift($body_a);
+            array_pop($body_a);
+            $body = implode('', $body_a);
+            $body .= "\r\n";
+
+            $localfilename = GenerateRandomString(32, 'FILE', 7);
+            $full_localfilename = "$hashed_attachment_dir/$localfilename";
+
+            $fp = fopen( $full_localfilename, 'wb');
+            fwrite ($fp, $body);
+            fclose($fp);
+            $composeMessage->initAttachment('message/rfc822',$subject.'.msg',
+                 $full_localfilename);
+        }
     }
-    setPref($data_dir, $username, 'attachments', serialize($attachments));
+
+    $compose_messages[$composesession] = $composeMessage;
+    sqsession_register($compose_messages,'compose_messages');
+    session_write_close();
     return $composesession;
 }
 
+/* get globals */
+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('startMessage', $startMessage);
+sqgetGlobalVar('msg', $msg);
+
+sqgetGlobalVar('msgs',              $msgs,              SQ_SESSION);
+sqgetGlobalVar('composesession',    $composesession,    SQ_SESSION);
+sqgetGlobalVar('lastTargetMailbox', $lastTargetMailbox, SQ_SESSION);
+
+sqgetGlobalVar('moveButton',      $moveButton,      SQ_POST);
+sqgetGlobalVar('expungeButton',   $expungeButton,   SQ_POST);
+sqgetGlobalVar('targetMailbox',   $targetMailbox,   SQ_POST);
+sqgetGlobalVar('expungeButton',   $expungeButton,   SQ_POST);
+sqgetGlobalVar('undeleteButton',  $undeleteButton,  SQ_POST);
+sqgetGlobalVar('markRead',        $markRead,        SQ_POST);
+sqgetGlobalVar('markUnread',      $markUnread,      SQ_POST);
+sqgetGlobalVar('markFlagged',     $markFlagged,     SQ_POST);
+sqgetGlobalVar('markUnflagged',   $markUnflagged,   SQ_POST);
+sqgetGlobalVar('attache',         $attache,         SQ_POST);
+sqgetGlobalVar('location',        $location,        SQ_POST);
+sqgetGlobalVar('bypass_trash',    $bypass_trash,    SQ_POST);
+sqgetGlobalVar('dmn',             $is_dmn,          SQ_POST);
+
+
+
+/* end of get globals */
+
 $imapConnection = sqimap_login($username, $key, $imapServerAddress, $imapPort, 0);
-sqimap_mailbox_select($imapConnection, $mailbox);
+$mbx_response=sqimap_mailbox_select($imapConnection, $mailbox);
 
-$location = set_url_var($location,'composenew');
-$location = set_url_var($location,'composesession');
-$location = set_url_var($location,'session');
 
+global $allow_thread_sort, $auto_expunge;
+
+if ($allow_thread_sort && getPref($data_dir, $username, "thread_$mailbox",0)) {
+    $aMailbox['SORT_METHOD'] = 'THREAD';
+} else if ($allow_server_sort) {
+    $aMailbox['SORT_METHOD'] = 'SERVER';
+} else {
+    $aMailbox['SORT_METHOD'] = 'SQUIRREL';
+}
+sqgetGlobalVar('aLastSelectedMailbox',$aMailbox,SQ_SESSION);
+sqgetGlobalVar('server_sort_array', $server_sort_array, SQ_SESSION);
+$aMailbox['UIDSET'] = $server_sort_array;
+$aMailbox['SORT'] = $sort;
+$aMailbox['NAME'] = $mailbox;
+$aMailbox['EXISTS'] = $mbx_response['EXISTS'];
+$aMailbox['AUTO_EXPUNGE'] = $auto_expunge;
+$aMailbox['MSG_HEADERS'] = $msgs;
+
+$location = set_url_var($location,'composenew',0,false);
+$location = set_url_var($location,'composesession',0,false);
+$location = set_url_var($location,'session',0,false);
 
 /* remember changes to mailbox setting */
 if (!isset($lastTargetMailbox)) {
@@ -129,103 +166,235 @@ if (!isset($lastTargetMailbox)) {
 }
 if ($targetMailbox != $lastTargetMailbox) {
     $lastTargetMailbox = $targetMailbox;
-    session_register('lastTargetMailbox');
+    sqsession_register($lastTargetMailbox, 'lastTargetMailbox');
+}
+$exception = false;
+$change    = false;
+
+do_hook('move_before_move');
+
+/*
+    Move msg list sorting up here, as it is used several times,
+    makes it more efficient to do it in one place for the code
+*/
+$id = array();
+if (isset($msg) && is_array($msg)) {
+    foreach( $msg as $key=>$uid ) {
+        // using foreach removes the risk of infinite loops that was there //
+        $id[] = $uid;
+    }
 }
+$num_ids = count($id);
 
 // expunge-on-demand if user isn't using move_to_trash or auto_expunge
 if(isset($expungeButton)) {
-    sqimap_mailbox_expunge($imapConnection, $mailbox, true);
-    header("Location: $location");
+    $num_ids = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
+    $change = true;
 } elseif(isset($undeleteButton)) {
     // undelete messages if user isn't using move_to_trash or auto_expunge
-
-    if (is_array($msg) == 1) {
-        // Removes \Deleted flag from selected messages
-        $j = 0;
-        $i = 0;
-        // If they have selected nothing msg is size one still, but will be an infinite
-        //    loop because we never increment j.  so check to see if msg[0] is set or not to fix this.
-        while ($j < count($msg)) {
-            if ($msg[$i]) {
-                sqimap_messages_remove_flag ($imapConnection, $msg[$i], $msg[$i], "Deleted");
-                $j++;
-            }
-            $i++;
-        }
-       header ("Location: $location"); 
+    // Removes \Deleted flag from selected messages
+    if ($num_ids) {
+        sqimap_toggle_flag($imapConnection, $id, '\\Deleted',false,true);
     } else {
-        displayPageHeader($color, $mailbox);
-        error_message(_("No messages were selected."), $mailbox, $sort, $startMessage, $color);
+        $exception = true;
     }
 } elseif (!isset($moveButton)) {
-    // If the delete button was pressed, the moveButton variable will not be set.
-    if (is_array($msg) == 1) {
-        // Marks the selected messages as 'Deleted'
-        $j = 0;
-        $i = 0;
-        // If they have selected nothing msg is size one still, but will be an infinite
-        //    loop because we never increment j.  so check to see if msg[0] is set or not to fix this.
-        while ($j < count($msg)) {
-            if (isset($msg[$i])) {
-                if (isset($markRead)) {
-                    sqimap_messages_flag($imapConnection, $msg[$i], $msg[$i], "Seen");
-                } else if (isset($markUnread)) {
-                    sqimap_messages_remove_flag($imapConnection, $msg[$i], $msg[$i], "Seen");
-                } else if (isset($attache)) {
-                   break;
-                } else  {
-                    sqimap_messages_delete($imapConnection, $msg[$i], $msg[$i], $mailbox);
+    if ($num_ids) {
+        if (!isset($attache)) {
+            if (isset($markRead)) {
+                sqimap_toggle_flag($imapConnection, $id, '\\Seen',true,true);
+            } else if (isset($markUnread)) {
+                sqimap_toggle_flag($imapConnection, $id, '\\Seen',false,true);
+            } else if (isset($markFlagged)) {
+                sqimap_toggle_flag($imapConnection, $id, '\\Flagged', true, true);
+            } else if (isset($markUnflagged)) {
+                sqimap_toggle_flag($imapConnection, $id, '\\Flagged', false, true);
+            } else  { // Delete messages
+                if (!boolean_hook_function('move_messages_button_action', NULL, 1)) {
+                    sqimap_msgs_list_delete($imapConnection, $mailbox, $id,$bypass_trash);
+                    if ($auto_expunge) {
+                        $num_ids = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
+                    }
+                    $change = true;
                 }
-                $j++;
             }
-            $i++;
-        }
-        if ($auto_expunge) {
-            sqimap_mailbox_expunge($imapConnection, $mailbox, true);
+        } else {
+            $composesession = attachSelectedMessages($id, $imapConnection);
+            $location = set_url_var($location, 'session', $composesession, false);
+            if ($compose_new_win) {
+                $location = set_url_var($location, 'composenew', 1, false);
+            } else {
+                $location = str_replace('search.php','compose.php',$location);
+                $location = str_replace('right_main.php','compose.php',$location);
+            }
         }
-        if (isset($attache)) {
-           $composesession = attachSelectedMessages($msg, $imapConnection);
-           if ($compose_new_win) {
-               header ("Location: $location&composenew=1&session=$composesession");
-           } else {
-               $location = str_replace('search.php','compose.php',$location);
-               $location = str_replace('right_main.php','compose.php',$location);
-               header ("Location: $location&session=$composesession");
-           }
-       } else {                
-            header ("Location: $location");
-        } 
     } else {
-        displayPageHeader($color, $mailbox);
-        error_message(_("No messages were selected."), $mailbox, $sort, $startMessage, $color);
+        $exception = true;
     }
 } else {    // Move messages
-    // lets check to see if they selected any messages
-    if (is_array($msg) == 1) {
-        $j = 0;
-        $i = 0;
-        // If they have selected nothing msg is size one still, but will be an infinite
-        //    loop because we never increment j.  so check to see if msg[0] is set or not to fix this.
-        while ($j < count($msg)) {
-            if (isset($msg[$i])) {
-                /** check if they would like to move it to the trash folder or not */
-                sqimap_messages_copy($imapConnection, $msg[$i], $msg[$i], $targetMailbox);
-                sqimap_messages_flag($imapConnection, $msg[$i], $msg[$i], "Deleted");
-                $j++;
+    if ( $num_ids > 0 ) {
+        if ( $is_dmn && $num_ids == 1 ) {
+            sqimap_msgs_list_move($imapConnection,$id[0],$targetMailbox);
+            $num_ids = sqimap_mailbox_expunge_dmn($imapConnection,$aMailbox, $id[0]);
+        } else {
+            sqimap_msgs_list_move($imapConnection,$id,$targetMailbox);
+            if ($auto_expunge) {
+                $num_ids = sqimap_mailbox_expunge($imapConnection, $mailbox, true);
             }
-            $i++;
         }
-        if ($auto_expunge) {
-            sqimap_mailbox_expunge($imapConnection, $mailbox, true);
-       }
-       header ("Location: $location"); 
+        $change = true;
     } else {
-        displayPageHeader($color, $mailbox);
-        error_message(_("No messages were selected."), $mailbox, $sort, $startMessage, $color);
+        $exception = true;
+    }
+}
+if($change) { // Change the startMessage number if the mailbox was changed
+    if (($startMessage+$num_ids-1) >= $mbx_response['EXISTS']) {
+        if ($startMessage > $show_num) {
+            $location = set_url_var($location,'startMessage',$startMessage-$show_num,false);
+        } else {
+            $location = set_url_var($location,'startMessage',1,false);
+        }
     }
 }
 // Log out this session
 sqimap_logout($imapConnection);
+if ($exception) {
+    displayPageHeader($color, $mailbox);
+    error_message(_("No messages were selected."), $mailbox, $sort, $startMessage, $color);
+} else {
+    header("Location: $location");
+    exit;
+}
+
+function handleMessageListForm($imapConnection,&$aMailbox) {
+    /* incoming formdata */
+    sqgetGlobalVar('moveButton',      $moveButton,      SQ_POST);
+    sqgetGlobalVar('expungeButton',   $expungeButton,   SQ_POST);
+    sqgetGlobalVar('targetMailbox',   $targetMailbox,   SQ_POST);
+    sqgetGlobalVar('expungeButton',   $expungeButton,   SQ_POST);
+    sqgetGlobalVar('undeleteButton',  $undeleteButton,  SQ_POST);
+    sqgetGlobalVar('markRead',        $markRead,        SQ_POST);
+    sqgetGlobalVar('markUnread',      $markUnread,      SQ_POST);
+    sqgetGlobalVar('markFlagged',     $markFlagged,     SQ_POST);
+    sqgetGlobalVar('markUnflagged',   $markUnflagged,   SQ_POST);
+    sqgetGlobalVar('attache',         $attache,         SQ_POST);
+    sqgetGlobalVar('location',        $location,        SQ_POST);
+    sqgetGlobalVar('bypass_trash',    $bypass_trash,    SQ_POST);
+    sqgetGlobalVar('msg',             $msg,             SQ_POST);
 
+    $sError = '';
+    /* retrieve the check boxes */
+    $aUid = array();
+    if (isset($msg) && is_array($msg)) {
+        foreach( $msg as $key=>$iUid ) {
+            // using foreach removes the risk of infinite loops that was there //
+            $aUid[] = $iUid;
+        }
+    }
+    $num_ids = count($id);
+
+    if (count($num_ids) && !isset($expungeButton)) {
+        /* handle submit buttons */
+        $sButton = '';
+        $sButton = (isset($expungeButton)) ? 'expunge'      : $sButton;
+        $sButton = (isset($attache))       ? 'attache'      : $sButton;
+        $sButton = (isset($moveButton))    ? 'move'         : $sButton;
+        $sButton = (isset($copyButton))    ? 'copy'         : $sButton;
+        $sButton = (isset($markDelete))    ? 'setDeleted'   : $sButton;
+        $sButton = (isset($markUndelete))  ? 'unsetDeleted' : $sButton;
+        $sButton = (isset($markSeen))      ? 'setSeen'      : $sButton;
+        $sButton = (isset($markUnseen))    ? 'unsetSeen'    : $sButton;
+        $sButton = (isset($markFlagged))   ? 'setFlagged'   : $sButton;
+        $sButton = (isset($markUnflagged)) ? 'unsetFlagged' : $sButton;
+
+        $aUpdatedMsgs = false;
+        $bExpunge = false;
+        switch ($sButton) {
+          case 'setDeleted':
+            // What kind of hook is this, can it be removed?
+            if (!boolean_hook_function('move_messages_button_action', NULL, 1)) {
+                $aUpdatedMsgs = sqimap_msgs_list_delete($imapConnection, $mailbox, $aUid,$bypass_trash);
+                $bExpunge = true;
+            }
+            break;
+          case 'unsetDeleted':
+          case 'setSeen':
+          case 'unsetSeen':
+          case 'setFlagged':
+          case 'unsetFlagged':
+            // get flag
+            $sFlag = (substr($sButton,0,3) == 'set') ? '\\'.substr($sButton,3) : '\\'.substr($sButton,5);
+            $bSet  = (substr($sButton,0,3) == 'set') ? true : false;
+            $aUpdatedMsgs = sqimap_toggle_flag($imapConnection, $aUid, $sFlag, $bSet, true);
+            break;
+          case 'move':
+            $aUpdatedMsgs = sqimap_msgs_list_move($imapConnection,$aId,$targetMailbox);
+            $bExpunge = true;
+            break;
+          case 'attache':
+            $composesession = attachSelectedMessages($id, $imapConnection);
+            // dirty hack, add info to $aMailbox
+            $aMailbox['FORWARD_SESSION'] = $composesession;
+            break;
+        }
+
+        if ($aUpdatedMsgs) {
+            foreach ($aUpdatedMsgs as $iUid => $aMsg) {
+                if (isset($aMsg['FLAGS'])) {
+                    $aMailbox['MSG_HEADERS'][$iUid]['FLAGS'] = $aMsg['FLAGS'];
+                }
+            }
+            if ($bExpunge && $aMailbox['AUTO_EXPUNGE'] &&
+                $iExpungedMessages = sqimap_mailbox_expunge($imapConnection, $aMailbox['NAME'], true))
+                {
+                if (count($aUpdateMsgs != $iExpungedMessages)) {
+                    // there are more messages deleted permanently then we expected
+                    // invalidate the cache
+                    $aMailbox['UIDSET'] = false;
+                    $aMailbox['MSG_HEADERS'] = false;
+                } else {
+                    // remove expunged messages from cache
+                    $aUidSet = $aMailbox['UIDSET'];
+                    $aDeleted = array();
+                    foreach ($aUpdatedMsgs as $iUid => $aValue) {
+                        if (isset($aValue['FLAGS']['\\deleted']) && $aValue['FLAGS']['\\deleted']) {
+                            $aDeleted[] = $iUid;
+                        }
+                    }
+                    if (count($aDeleted)) {
+                        // create a UID => array index temp array
+                        $aUidSetDummy = array_flip($aUidSet);
+                        foreach ($aDeleted as $iUid) {
+                            unset($aUidSetDummy[$iUid]);
+                        }
+                        $aUidSet = array_keys($aUidSetDummy);
+                        $aMailbox['UIDSET'] = $aUidSet;
+                        // update EXISTS info
+                        $aMailbox['EXISTS'] -= $iExpungedMessages;
+                    }
+                }
+                // Change the startMessage number if the mailbox was changed
+                if (($aMailbox['PAGEOFFSET']+$iExpungedMessages-1) >= $aMailbox['EXISTS']) {
+                    $aMailbox['PAGEOFFSET'] = ($aMailbox['PAGEOFFSET'] > $aMailbox['LIMIT']) ?
+                        $aMailbox['PAGEOFFSET'] - $aMailbox['LIMIT'] : 1;
+                }
+            }
+        }
+    } else {
+        if (isset($expungeButton)) {
+            // on expunge we do not know which messages will be deleted
+            // so it's useless to try to sync the cache
+
+            // Close the mailbox so we do not need to parse the untagged expunge responses
+            sqimap_run_command($imapConnection,'CLOSE',false,$result,$message);
+            $aMbxResponse = sqimap_select($imapConnection,$aMailbox['NAME'];
+            // update the $aMailbox array
+            $aMailbox['EXISTS'] = $aMbxResponse['EXISTS'];
+            $aMailbox['UIDSET'] = false;
+        } else {
+            $sError = _("No messages were selected.");
+        }
+    }
+}
 ?>
 </BODY></HTML>