Changeset 4306 in subversion

Timestamp:

Dec 3, 2010 7:25:49 AM (2 years ago)

Author:

alec

Message:

• Improve performance of moving or copying of all messages in a folder (use CLOSE intead of EXPUNGE)
• Code cleanup + added more phpdoc comments

Location:

trunk/roundcubemail

Files:

• CHANGELOG (modified) (1 diff)
• program/include/rcube_imap.php (modified) (6 diffs)
• program/include/rcube_imap_generic.php (modified) (12 diffs)

trunk/roundcubemail/CHANGELOG

@@ -13 +13 @@
 - Add folder size and quota indicator in folder manager (#1485780)
 - Add possibility to move a subfolder into root folder (#1486791)
+- Fix copying all messages in a folder copies only messages from current page
+- Improve performance of moving or copying of all messages in a folder
 
 RELEASE 0.5-BETA

trunk/roundcubemail/program/include/rcube_imap.php

@@ -186 +186 @@
     function close()
     {
-        $this->conn->close();
+        $this->conn->closeConnection();
         $this->write_cache();
     }
@@ -199 +199 @@
     function reconnect()
     {
-        $this->close();
+        $this->closeConnection();
         $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl);
 
@@ -618 +618 @@
         // RECENT count is fetched a bit different
         else if ($mode == 'RECENT') {
-            $count = $this->conn->checkForRecent($mailbox);
+            $count = $this->conn->countRecent($mailbox);
         }
         // use SEARCH for message counting
@@ -2583 +2583 @@
         // send expunge command in order to have the moved message
         // really deleted from the source mailbox
+$aa = rcube_timer();
         if ($moved) {
             $this->_expunge($from_mbox, false, $uids);
@@ -2592 +2593 @@
             $moved = $this->delete_message($uids, $fbox);
         }
-
+rcube_print_time($aa);
         if ($moved) {
             // unset threads internal cache
@@ -2775 +2776 @@
             $a_uids = NULL;
 
-        $result = $this->conn->expunge($mailbox, $a_uids);
+        // CLOSE(+SELECT) should be faster than EXPUNGE
+        if (empty($a_uids) || $a_uids == '1:*')
+            $result = $this->conn->close();
+        else
+            $result = $this->conn->expunge($mailbox, $a_uids);
 
         if ($result && $clear_cache) {

trunk/roundcubemail/program/include/rcube_imap_generic.php

@@ -684 +684 @@
 
                 $this->setError(self::ERROR_BAD, $error);
-            $this->close();
+            $this->closeConnection();
                 return false;
             }
@@ -701 +701 @@
 
                 if ($res[0] != self::ERROR_OK) {
-                    $this->close();
+                    $this->closeConnection();
                     return false;
                 }
@@ -707 +707 @@
                             if (!stream_socket_enable_crypto($this->fp, true, STREAM_CRYPTO_METHOD_TLS_CLIENT)) {
                                     $this->setError(self::ERROR_BAD, "Unable to negotiate TLS");
-                    $this->close();
+                    $this->closeConnection();
                                     return false;
                             }
@@ -739 +739 @@
                     if ($auth_method == 'LOGIN' && $this->getCapability('LOGINDISABLED')) {
                             $this->setError(self::ERROR_BAD, "Login disabled by IMAP server");
-                $this->close();
+                $this->closeConnection();
                             return false;
             }
@@ -779 +779 @@
         }
 
-        // Close connection
-        $this->close();
+        $this->closeConnection();
 
         return false;
@@ -790 +789 @@
     }
 
-    function close()
+    function closeConnection()
     {
             if ($this->putLine($this->nextTag() . ' LOGOUT')) {
@@ -800 +799 @@
     }
 
+    /**
+     * Executes SELECT command (if mailbox is already not in selected state)
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return boolean True on success, false on error
+     * @access public
+     */
     function select($mailbox)
     {
@@ -843 +850 @@
 
     /**
-     * Executes STATUS comand
+     * Executes STATUS command
      *
      * @param string $mailbox Mailbox name
@@ -888 +895 @@
     }
 
-    function checkForRecent($mailbox)
-    {
-            if (!strlen($mailbox)) {
-                    $mailbox = 'INBOX';
-            }
-
-            $this->select($mailbox);
-
-            if ($this->selected == $mailbox) {
-                    return $this->data['RECENT'];
-            }
+    /**
+     * Executes EXPUNGE command
+     *
+     * @param string $mailbox  Mailbox name
+     * @param string $messages Message UIDs to expunge
+     *
+     * @return boolean True on success, False on error
+     * @access public
+     */
+    function expunge($mailbox, $messages=NULL)
+    {
+            if (!$this->select($mailbox)) {
+            return false;
+        }
+
+        // Clear internal status cache
+        unset($this->data['STATUS:'.$mailbox]);
+
+                if ($messages)
+                        $result = $this->execute('UID EXPUNGE', array($messages), self::COMMAND_NORESPONSE);
+                else
+                        $result = $this->execute('EXPUNGE', null, self::COMMAND_NORESPONSE);
+
+                if ($result == self::ERROR_OK) {
+                        $this->selected = ''; // state has changed, need to reselect
+                        return true;
+                }
 
             return false;
     }
 
+    /**
+     * Executes CLOSE command
+     *
+     * @return boolean True on success, False on error
+     * @access public
+     * @since 0.5
+     */
+    function close()
+    {
+        $result = $this->execute('CLOSE', NULL, self::COMMAND_NORESPONSE);
+
+        if ($result == self::ERROR_OK) {
+            $this->selected = '';
+            return true;
+        }
+
+            return false;
+    }
+
+    /**
+     * Executes SUBSCRIBE command
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return boolean True on success, False on error
+     * @access public
+     */
+    function subscribe($mailbox)
+    {
+            $result = $this->execute('SUBSCRIBE', array($this->escape($mailbox)),
+                self::COMMAND_NORESPONSE);
+
+            return ($result == self::ERROR_OK);
+    }
+
+    /**
+     * Executes UNSUBSCRIBE command
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return boolean True on success, False on error
+     * @access public
+     */
+    function unsubscribe($mailbox)
+    {
+            $result = $this->execute('UNSUBSCRIBE', array($this->escape($mailbox)),
+                self::COMMAND_NORESPONSE);
+
+            return ($result == self::ERROR_OK);
+    }
+
+    /**
+     * Executes DELETE command
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return boolean True on success, False on error
+     * @access public
+     */
+    function deleteFolder($mailbox)
+    {
+        $result = $this->execute('DELETE', array($this->escape($mailbox)),
+                self::COMMAND_NORESPONSE);
+
+            return ($result == self::ERROR_OK);
+    }
+
+    /**
+     * Removes all messages in a folder
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return boolean True on success, False on error
+     * @access public
+     */
+    function clearFolder($mailbox)
+    {
+            $num_in_trash = $this->countMessages($mailbox);
+            if ($num_in_trash > 0) {
+                    $this->delete($mailbox, '1:*');
+            }
+
+        $res = $this->close();
+//          $res = $this->expunge($mailbox);
+
+            return $res;
+    }
+
+    /**
+     * Returns count of all messages in a folder
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return int Number of messages, False on error
+     * @access public
+     */
     function countMessages($mailbox, $refresh = false)
     {
@@ -926 +1045 @@
 
         return false;
+    }
+
+    /**
+     * Returns count of messages with \Recent flag in a folder
+     *
+     * @param string $mailbox Mailbox name
+     *
+     * @return int Number of messages, False on error
+     * @access public
+     */
+    function countRecent($mailbox)
+    {
+            if (!strlen($mailbox)) {
+                    $mailbox = 'INBOX';
+            }
+
+            $this->select($mailbox);
+
+            if ($this->selected == $mailbox) {
+                    return $this->data['RECENT'];
+            }
+
+            return false;
     }
 
@@ -1566 +1708 @@
     }
 
-    function expunge($mailbox, $messages=NULL)
-    {
-            if (!$this->select($mailbox)) {
-            return false;
-        }
-
-        // Clear internal status cache
-        unset($this->data['STATUS:'.$mailbox]);
-
-                if ($messages)
-                        $result = $this->execute('UID EXPUNGE', array($messages), self::COMMAND_NORESPONSE);
-                else
-                        $result = $this->execute('EXPUNGE', null, self::COMMAND_NORESPONSE);
-
-                if ($result == self::ERROR_OK) {
-                        $this->selected = ''; // state has changed, need to reselect
-                        return true;
-                }
-
-            return false;
-    }
 
     function modFlag($mailbox, $messages, $flag, $mod)
@@ -2154 +2275 @@
     }
 
-    function deleteFolder($mailbox)
-    {
-        $result = $this->execute('DELETE', array($this->escape($mailbox)),
-                self::COMMAND_NORESPONSE);
-
-            return ($result == self::ERROR_OK);
-    }
-
-    function clearFolder($mailbox)
-    {
-            $num_in_trash = $this->countMessages($mailbox);
-            if ($num_in_trash > 0) {
-                    $this->delete($mailbox, '1:*');
-            }
-            return ($this->expunge($mailbox) >= 0);
-    }
-
-    function subscribe($mailbox)
-    {
-            $result = $this->execute('SUBSCRIBE', array($this->escape($mailbox)),
-                self::COMMAND_NORESPONSE);
-
-            return ($result == self::ERROR_OK);
-    }
-
-    function unsubscribe($mailbox)
-    {
-            $result = $this->execute('UNSUBSCRIBE', array($this->escape($mailbox)),
-                self::COMMAND_NORESPONSE);
-
-            return ($result == self::ERROR_OK);
-    }
-
     function append($mailbox, &$message)
     {