Changeset 585

Timestamp:

12/30/09 17:21:21 (2 years ago)

Author:

octorian

Message:

Post-expunge cleanup of cache and sync of object model (should fix strange delete issues)

Location:

trunk

Files:

• LogicMail/src/org/logicprobe/LogicMail/mail/AbstractMailStore.java (modified) (3 diffs)
• LogicMail/src/org/logicprobe/LogicMail/mail/FolderListener.java (modified) (1 diff)
• LogicMail/src/org/logicprobe/LogicMail/mail/LocalMailStore.java (modified) (1 diff)
• LogicMail/src/org/logicprobe/LogicMail/mail/NetworkMailStore.java (modified) (1 diff)
• LogicMail/src/org/logicprobe/LogicMail/model/AccountNode.java (modified) (5 diffs)
• LogicMail/src/org/logicprobe/LogicMail/model/MailFileManager.java (modified) (8 diffs)
• LogicMail/src/org/logicprobe/LogicMail/model/MailboxNode.java (modified) (5 diffs)
• LogicMail/src/org/logicprobe/LogicMail/model/MailboxNodeEvent.java (modified) (1 diff)
• LogicMail/src/org/logicprobe/LogicMail/model/MessageNode.java (modified) (3 diffs)
• LogicMail/src/org/logicprobe/LogicMail/ui/MailboxMessageField.java (modified) (1 diff)
• LogicMail/src/org/logicprobe/LogicMail/ui/MailboxScreen.java (modified) (3 diffs)
• LogicMailTests/src/org/logicprobe/LogicMail/mail/NetworkMailStoreTest.java (modified) (1 diff)

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/AbstractMailStore.java

@@ -141 +141 @@
      * 
      * <p>Successful completion is indicated by a call to
-     * {@link FolderListener#folderStatusChanged(FolderEvent)}.
+     * {@link FolderListener#folderExpunged(FolderEvent)}.
      * 
      * @param folder The folder to expunge
@@ -420 +420 @@
     /**
      * Notifies all registered <tt>FolderListener</tt>s that
-     * the the status of a folder has changed.
+     * the status of a folder has changed.
      * 
      * @param root The root node of the updated folder tree
@@ -451 +451 @@
             }
             ((FolderListener)listeners[i]).folderMessagesAvailable(e);
+        }
+    }
+    
+    /**
+     * Notifies all registered <tt>FolderListener</tt>s that
+     * the folder has been expunged.
+     * 
+     * @param root The root node of the updated folder tree
+     */
+    protected void fireFolderExpunged(FolderTreeItem root) {
+        Object[] listeners = listenerList.getListeners(FolderListener.class);
+        FolderEvent e = null;
+        for(int i=0; i<listeners.length; i++) {
+            if(e == null) {
+                e = new FolderEvent(this, root);
+            }
+            ((FolderListener)listeners[i]).folderExpunged(e);
         }
     }

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/FolderListener.java

@@ -51 +51 @@
          */
         public void folderMessagesAvailable(FolderMessagesEvent e);
+        
+    /**
+     * Invoked when a folder has been expunged.
+     * 
+     * @param e Folder event data
+     */
+    public void folderExpunged(FolderEvent e);
 }

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/LocalMailStore.java

@@ -148 +148 @@
             
             if(folderMessages != null) {
-                fireFolderStatusChanged(requestFolder);
+                fireFolderExpunged(requestFolder);
             }
         }

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/NetworkMailStore.java

@@ -195 +195 @@
                         break;
                 case IncomingMailConnectionHandler.REQUEST_FOLDER_EXPUNGE:
-                    fireFolderStatusChanged((FolderTreeItem)result);
+                    fireFolderExpunged((FolderTreeItem)result);
                     break;
                 case IncomingMailConnectionHandler.REQUEST_FOLDER_STATUS:

trunk/LogicMail/src/org/logicprobe/LogicMail/model/AccountNode.java

@@ -136 +136 @@
                     mailStore_FolderMessagesAvailable(e);
                 }
+
+                public void folderExpunged(FolderEvent e) {
+                    mailStore_FolderExpunged(e);
+                }
             });
 
@@ -603 +607 @@
                                 // information, such as POP message indices
                                 messageNode.getMessageToken().updateToken(folderMessages[i].getMessageToken());
+                                messageNode.setExistsOnServer(true);
                         }
                         else {
@@ -621 +626 @@
         
                     for (int i = 0; i < folderMessages.length; i++) {
-                        addedMessages.addElement(new MessageNode(folderMessages[i]));
+                        MessageNode messageNode = new MessageNode(folderMessages[i]);
+                        messageNode.setExistsOnServer(true);
+                        addedMessages.addElement(messageNode);
                     }
         
@@ -631 +638 @@
         else {
             synchronized(folderMessagesToFetch) {
-                Vector messagesToFetch = (Vector)folderMessagesToFetch.remove(e.getFolder());
+                FolderTreeItem fetchFolder = e.getFolder();
+                
+                // Clean out all messages that couldn't be verified against the server
+                MailboxNode mailboxNode = (MailboxNode) pathMailboxMap.get(fetchFolder.getPath());
+                mailboxNode.removeMessagesNotOnServer();
+                
+                // Queue a fetch for messages that do exist
+                Vector messagesToFetch = (Vector)folderMessagesToFetch.remove(fetchFolder);
                 if(messagesToFetch != null) {
                     MessageToken[] fetchArray = new MessageToken[messagesToFetch.size()];
@@ -639 +653 @@
             }
         }
+    }
+
+    /**
+     * Handles a folder being expunged.
+     *
+     * @param e Event data.
+     */
+    private void mailStore_FolderExpunged(FolderEvent e) {
+        FolderTreeItem fetchFolder = e.getFolder();
+        MailboxNode mailboxNode = (MailboxNode) pathMailboxMap.get(fetchFolder.getPath());
+        mailboxNode.handleExpungeNotification();
     }
 

trunk/LogicMail/src/org/logicprobe/LogicMail/model/MailFileManager.java

@@ -94 +94 @@
          * Refreshes the configuration based on any system configuration changes.
          */
-        void refreshConfiguration() {
+        synchronized void refreshConfiguration() {
                 String localDataLocation = mailSettings.getGlobalConfig().getLocalDataLocation();
                 String newCacheUrl = localDataLocation + CACHE_PREFIX;
@@ -131 +131 @@
          * @throws IOException Signals that an I/O exception has occurred.
          */
-        public void writeMessage(MessageNode messageNode) throws IOException {
+        public synchronized void writeMessage(MessageNode messageNode) throws IOException {
                 if(cacheUrl == null) { return; }
                 
@@ -171 +171 @@
          * @throws IOException Signals that an I/O exception has occurred.
          */
-        public MessageToken[] readMessageTokens(MailboxNode mailboxNode) throws IOException {
+        public synchronized MessageToken[] readMessageTokens(MailboxNode mailboxNode) throws IOException {
                 if(cacheUrl == null) { return new MessageToken[0]; }
                 
@@ -192 +192 @@
         }
         
-        public MessageNode[] readMessageNodes(MailboxNode mailboxNode) throws IOException {
+        public synchronized MessageNode[] readMessageNodes(MailboxNode mailboxNode) throws IOException {
                 if(cacheUrl == null) { return new MessageNode[0]; }
 
@@ -210 +210 @@
         }
         
-    public void readMessageNodes(MailboxNode mailboxNode, MessageNodeCallback callback) throws IOException {
+    public synchronized void readMessageNodes(MailboxNode mailboxNode, MessageNodeCallback callback) throws IOException {
         if(cacheUrl == null) { callback.messageNodeUpdated(null); }
         
@@ -250 +250 @@
     }
     
-        public MessageNode readMessageNode(MailboxNode mailboxNode, MessageToken messageToken, boolean loadContent) throws IOException {
+        public synchronized MessageNode readMessageNode(MailboxNode mailboxNode, MessageToken messageToken, boolean loadContent) throws IOException {
                 if(cacheUrl == null) { return null; }
 
@@ -270 +270 @@
         }
         
-        public MimeMessageContent[] readMessageContent(MailboxNode mailboxNode, MessageToken messageToken) throws IOException {
+        public synchronized MimeMessageContent[] readMessageContent(MailboxNode mailboxNode, MessageToken messageToken) throws IOException {
                 if(cacheUrl == null) { return null; }
                 
@@ -391 +391 @@
                 return result;
         }
+        
+        public synchronized void removeMessageNodes(MailboxNode mailboxNode, MessageToken[] messageTokens) throws IOException {
+        if(cacheUrl == null) { return; }
+
+        FileConnection fileConnection = getMailboxFileConnection(mailboxNode);
+        String mailboxUrl = fileConnection.getURL();
+        fileConnection.close();
+        
+        for(int i=0; i<messageTokens.length; i++) {
+            try {
+                FileConnection mailFileConnection =
+                    (FileConnection)Connector.open(mailboxUrl + messageTokens[i].getMessageUid() + MSG_SUFFIX);
+                if(mailFileConnection.exists() && !mailFileConnection.isDirectory() && mailFileConnection.canRead()) {
+                    mailFileConnection.delete();
+                }
+                mailFileConnection.close();
+            } catch (IOException exp) {
+                if (EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
+                    EventLogger.logEvent(AppInfo.GUID,
+                            ("Error deleting message from cache: " + exp.toString()).getBytes(),
+                            EventLogger.DEBUG_INFO);
+                }
+            }
+        }
+        }
 }

trunk/LogicMail/src/org/logicprobe/LogicMail/model/MailboxNode.java

@@ -34 +34 @@
 import java.io.DataOutput;
 import java.io.IOException;
+import java.util.Enumeration;
 import java.util.Hashtable;
 import java.util.Vector;
@@ -72 +73 @@
         private boolean hasAppend;
         private int unseenMessageCount;
+    private Vector pendingExpungeMessages = new Vector();
         
         private Object fetchLock = new Object();
@@ -540 +542 @@
                 }
         updateUnseenMessages(false);
-                fireMailboxStatusChanged(MailboxNodeEvent.TYPE_STATUS, null);
-        }
-
+                fireMailboxStatusChanged(MailboxNodeEvent.TYPE_DELETED_MESSAGES, new MessageNode[] { message });
+        }
+
+
+    /**
+     * Removes all messages not marked as existing on the server.
+     */
+    void removeMessagesNotOnServer() {
+        synchronized(messages) {
+            Vector messagesToRemove = new Vector();
+            
+            // Populate a list of the messages to remove
+            int size = messages.size();
+            for(int i=0; i<size; i++) {
+                MessageNode messageNode = (MessageNode)messages.elementAt(i);
+                if(!messageNode.existsOnServer()) {
+                    messagesToRemove.addElement(messageNode);
+                }
+            }
+            
+            size = messagesToRemove.size();
+            if(size == 0) { return; }
+            
+            MessageNode[] removedMessageNodes = new MessageNode[size];
+            MessageToken[] tokensToRemove = new MessageToken[size];
+            for(int i=0; i<size; i++) {
+                MessageNode messageNode = (MessageNode)messagesToRemove.elementAt(i);
+                messages.removeElement(messageNode);
+                messageNode.setParent(null);
+                messageMap.remove(messageNode);
+                messageTokenMap.remove(messageNode.getMessageToken());
+                tokensToRemove[i] = messageNode.getMessageToken();
+                removedMessageNodes[i] = messageNode;
+            }
+            
+            (new RemoveFromCacheThread(tokensToRemove)).start();
+            updateUnseenMessages(false);
+            fireMailboxStatusChanged(MailboxNodeEvent.TYPE_DELETED_MESSAGES, removedMessageNodes);
+        }
+    }
+        
+    private class RemoveFromCacheThread extends Thread {
+        private MessageToken[] messageTokens;
+        
+        public RemoveFromCacheThread(MessageToken[] messageTokens) {
+            this.messageTokens = messageTokens;
+        }
+        
+        public void run() {
+            yield();
+            try {
+                MailFileManager.getInstance().removeMessageNodes(MailboxNode.this, messageTokens);
+            } catch (IOException e) {
+                EventLogger.logEvent(AppInfo.GUID,
+                        ("Unable to remove messages from the cache\r\n"
+                                + e.getMessage()).getBytes(),
+                                EventLogger.ERROR);
+            }
+        }
+    }
+
+    /**
+     * Called when the mail store notifies of a completed expunge operation on
+     * this folder, so anything we expected to be expunged can be cleaned out.
+     */
+    void handleExpungeNotification() {
+        synchronized(messages) {
+            Enumeration e = pendingExpungeMessages.elements();
+            while(e.hasMoreElements()) {
+                ((MessageNode)e.nextElement()).setExistsOnServer(false);
+            }
+            pendingExpungeMessages.removeAllElements();
+            removeMessagesNotOnServer();
+        }
+    }
+        
         /**
          * Removes all messages from this mailbox.
@@ -710 +785 @@
         return hasDeleted;
     }
-
+    
     /**
      * Tells the underlying mail store to expunge any deleted messages
@@ -716 +791 @@
      */
     public void expungeDeletedMessages() {
+        synchronized(messages) {
+            int size = messages.size();
+            for(int i=0; i<size; i++) {
+                MessageNode messageNode = (MessageNode)messages.elementAt(i);
+                int flags = messageNode.getFlags();
+                if((flags & MessageNode.Flag.DELETED) != 0) {
+                    pendingExpungeMessages.addElement(messageNode);
+                }
+            }
+        }
         parentAccount.getMailStore().requestFolderExpunge(this.folderTreeItem);
     }

trunk/LogicMail/src/org/logicprobe/LogicMail/model/MailboxNodeEvent.java

@@ -53 +53 @@
         public final static int TYPE_NEW_MESSAGES = 1;
         
+    /**
+     * Messages have been deleted.
+     * The <tt>getAffectedMessages()</tt> method will return
+     * a list of deleted messages.
+     */
+    public final static int TYPE_DELETED_MESSAGES = 2;
+        
         /** Creates a new instance of MailboxNodeEvent */
         public MailboxNodeEvent(Object source, int type, MessageNode[] affectedMessages) {

trunk/LogicMail/src/org/logicprobe/LogicMail/model/MessageNode.java

@@ -130 +130 @@
         /** True if the message has cached content available for loading */
         private boolean hasCachedContent;
+        /** True if the message has been verified to exist on a mail server */
+        private boolean existsOnServer;
         /** Bit-field set of message flags. */
         private int flags;
@@ -287 +289 @@
         }
         
+        /**
+         * Sets whether this message has been verified to exist on a server.
+         * 
+         * @param existsOnServer true if the message has been verified to exist on a server
+         */
+        void setExistsOnServer(boolean existsOnServer) {
+            this.existsOnServer = existsOnServer;
+        }
+        
+        /**
+         * Gets whether this message has been verified to exist on a server.
+         * 
+         * @return true if the message has been verified to exist on a server or is on a local account
+         */
+        public boolean existsOnServer() {
+            return existsOnServer;
+        }
+        
         /* (non-Javadoc)
          * @see org.logicprobe.LogicMail.model.Node#accept(org.logicprobe.LogicMail.model.NodeVisitor)
@@ -301 +321 @@
         void setParent(MailboxNode parent) {
                 this.parent = parent;
+                if(!isCachable()) { existsOnServer = true; }
         }
         

trunk/LogicMail/src/org/logicprobe/LogicMail/ui/MailboxMessageField.java

@@ -155 +155 @@
         // Draw the message icon
         Bitmap messageIcon = NodeIcons.getIcon(messageNode);
+        int iconY = (lineHeight / 2) - (messageIcon.getHeight() / 2);
         graphics.drawBitmap(
                 1,
-                (lineHeight / 2) - (messageIcon.getHeight() / 2),
+                iconY,
                 messageIcon.getWidth(),
                 messageIcon.getHeight(),
                 messageIcon, 0, 0);
+        if(!messageNode.existsOnServer()) {
+            graphics.setColor(Color.DARKGRAY);
+            graphics.drawRect(1, iconY, messageIcon.getWidth(), messageIcon.getHeight());
+            graphics.setColor(originalColor);
+        }
         
         if(attachmentIcon != null) {

trunk/LogicMail/src/org/logicprobe/LogicMail/ui/MailboxScreen.java

@@ -323 +323 @@
      */
     private void mailboxNode_MailboxStatusChanged(MailboxNodeEvent e) {
-        if(e.getType() == MailboxNodeEvent.TYPE_NEW_MESSAGES) {
+        int type = e.getType();
+        if(type == MailboxNodeEvent.TYPE_NEW_MESSAGES) {
                 MessageNode[] messageNodes = e.getAffectedMessages();
                 for(int i=0; i<messageNodes.length; i++) {
@@ -337 +338 @@
                         }
                 }
+        }
+        else if(type == MailboxNodeEvent.TYPE_DELETED_MESSAGES) {
+            MessageNode[] messageNodes = e.getAffectedMessages();
+            for(int i=0; i<messageNodes.length; i++) {
+                if(screen != null && screen.isDisplayed()) {
+                    messageNodes[i].removeMessageNodeListener(messageNodeListener);
+                }
+                removeDisplayableMessage(messageNodes[i])              ;  
+                knownMessages.removeElement(messageNodes[i]);
+            }
         }
         }
@@ -407 +418 @@
     }
 
+    /**
+     * Remove a message from the list and associated data structures,
+     * if that message exists in the list.
+     * 
+     * @param messageNode Message to insert.
+     */
+    private void removeDisplayableMessage(MessageNode messageNode) {
+        MailboxMessageField mailboxMessageField = (MailboxMessageField)messageFieldMap.remove(messageNode);
+        if(mailboxMessageField == null) { return; }
+
+        messageFieldManager.delete(mailboxMessageField);
+    }
+    
     /**
      * Gets the last displayed message.

trunk/LogicMailTests/src/org/logicprobe/LogicMail/mail/NetworkMailStoreTest.java

@@ -96 +96 @@
                                 eventFolderStatusChanged = e;
                         }
+            public void folderExpunged(FolderEvent e) {
+            }
         });