Changeset 582

Timestamp:

12/30/09 14:51:50 (2 years ago)

Author:

octorian

Message:

Expunge support for IMAP and Local folders. (still need post-delete cache scrub)

Location:

trunk/LogicMail/src/org/logicprobe/LogicMail

Files:

• mail/AbstractMailStore.java (modified) (2 diffs)
• mail/IncomingMailClient.java (modified) (2 diffs)
• mail/IncomingMailConnectionHandler.java (modified) (5 diffs)
• mail/LocalMailStore.java (modified) (1 diff)
• mail/MaildirFolder.java (modified) (1 diff)
• mail/NetworkMailStore.java (modified) (3 diffs)
• mail/imap/ImapClient.java (modified) (2 diffs)
• mail/imap/ImapProtocol.java (modified) (1 diff)
• mail/pop/PopClient.java (modified) (2 diffs)
• model/AccountNode.java (modified) (1 diff)
• model/MailboxNode.java (modified) (1 diff)
• ui/MailboxScreen.java (modified) (2 diffs)

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

@@ -120 +120 @@
 
     /**
+     * Returns whether the mail store supports expunging of deleted messages.
+     * 
+     * @return True if expunge supported, false otherwise
+     */
+    public abstract boolean hasExpunge();
+    
+    /**
      * Requests the regeneration of the mail folder tree.
      * 
@@ -129 +136 @@
      */
     public abstract void requestFolderTree();
+    
+    /**
+     * Requests that a folder be expunged of deleted messages.
+     * 
+     * <p>Successful completion is indicated by a call to
+     * {@link FolderListener#folderStatusChanged(FolderEvent)}.
+     * 
+     * @param folder The folder to expunge
+     */
+    public abstract void requestFolderExpunge(FolderTreeItem folder);
     
     /**

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

@@ -92 +92 @@
     
     /**
+     * Return whether the underlying protocol supports expunging of deleted messages.
+     *
+     * @return True if expunge supported, false otherwise
+     */
+    boolean hasExpunge();
+    
+    /**
      * Return whether the underlying protocol supports an idle connection mode.
      * 
@@ -183 +190 @@
      */
     void setActiveFolder(MessageToken messageToken)
+        throws IOException, MailException;
+    
+    /**
+     * Expunges deleted messages from the currently active mail folder.
+     * This should do nothing if the underlying protocol does not support expunge.
+     *
+     * @throws IOException on I/O errors
+     * @throws MailException on protocol errors
+     */
+    void expungeActiveFolder()
         throws IOException, MailException;
     

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

@@ -49 +49 @@
         // "requestXXXX()" methods from AbstractMailStore
         public static final int REQUEST_FOLDER_TREE             = 10;
-        public static final int REQUEST_FOLDER_STATUS           = 11;
-        public static final int REQUEST_FOLDER_MESSAGES_RANGE   = 12;
-        public static final int REQUEST_FOLDER_MESSAGES_SET     = 13;
-        public static final int REQUEST_FOLDER_MESSAGES_RECENT  = 14;
+    public static final int REQUEST_FOLDER_EXPUNGE          = 11;
+        public static final int REQUEST_FOLDER_STATUS           = 12;
+        public static final int REQUEST_FOLDER_MESSAGES_RANGE   = 13;
+        public static final int REQUEST_FOLDER_MESSAGES_SET     = 14;
+        public static final int REQUEST_FOLDER_MESSAGES_RECENT  = 15;
         public static final int REQUEST_MESSAGE                 = 20;
         public static final int REQUEST_MESSAGE_PARTS           = 21;
@@ -91 +92 @@
                         handleRequestFolderTree();
                         break;
+                case REQUEST_FOLDER_EXPUNGE:
+                    handleRequestFolderExpunge((FolderTreeItem)params[0]);
+                    break;
                 case REQUEST_FOLDER_STATUS:
                         handleRequestFolderStatus((FolderTreeItem[])params[0]);
@@ -132 +136 @@
         }
 
-        /**
+    /**
          * Handles the start of the IDLE state.
          */
@@ -211 +215 @@
                 }
         }
-        
+
+    private void handleRequestFolderExpunge(FolderTreeItem folder) throws IOException, MailException {
+        String message = resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_FOLDER_EXPUNGE);
+        showStatus(message);
+        checkActiveFolder(folder);
+        incomingClient.expungeActiveFolder();
+        
+        MailConnectionHandlerListener listener = getListener();
+        if(listener != null) {
+            listener.mailConnectionRequestComplete(REQUEST_FOLDER_EXPUNGE, folder);
+        }
+    }
+    
         private void handleRequestFolderStatus(FolderTreeItem[] folders) throws IOException, MailException {
                 String message = resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_FOLDER_STATUS);
@@ -243 +259 @@
             this.param = param;
             this.count = 0;
-            
         }
         

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

@@ -115 +115 @@
     }
 
+    public boolean hasExpunge() {
+        return true;
+    }
+    
     public void requestFolderTree() {
         fireFolderTreeUpdated(rootFolder);
     }
 
+    public void requestFolderExpunge(FolderTreeItem folder) {
+        // TODO: Implement local expunge
+        FolderTreeItem requestFolder = getMatchingFolderTreeItem(folder.getPath());
+        
+        if(requestFolder != null) {
+            threadQueue.invokeLater(new ExpungeFolderRunnable(requestFolder));
+        }
+    }
+    
+    private class ExpungeFolderRunnable extends MaildirRunnable {
+        public ExpungeFolderRunnable(FolderTreeItem requestFolder) {
+            super(requestFolder);
+        }
+        
+        public void run() {
+            FolderMessage[] folderMessages = null;
+            try {
+                maildirFolder.open();
+                maildirFolder.expunge();
+                maildirFolder.close();
+            } catch (IOException e) {
+                System.err.println("Unable to expunge folder: " + e.toString());
+            }
+            
+            if(folderMessages != null) {
+                fireFolderStatusChanged(requestFolder);
+            }
+        }
+    }
+    
     public void requestFolderStatus(FolderTreeItem[] folders) {
         // Make every entry in the provided array match the local folder

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

@@ -480 +480 @@
         if(mailFileConnection.exists() && !mailFileConnection.isDirectory() && mailFileConnection.canRead()) {
             mailFileConnection.rename(updatedFilename);
+            mailFileConnection.close();
             return true;
         }
         else {
+            mailFileConnection.close();
             return false;
+        }
+    }
+
+    /**
+     * Remove all deleted messages from this folder.
+     */
+    public void expunge() throws IOException {
+        if (EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
+            EventLogger.logEvent(AppInfo.GUID,
+                ("expunge()").getBytes(),
+                EventLogger.DEBUG_INFO);
+        }
+
+        // Build a list of deleted files in the current directory
+        Vector deletedFiles = new Vector();
+        Enumeration e = fileConnection.list();
+        while(e.hasMoreElements()) {
+            String messageFilename = (String)e.nextElement();
+            int p = messageFilename.indexOf('_');
+            if(p != -1 && messageFilename.indexOf('T', p) != -1) {
+                deletedFiles.addElement(messageFilename);
+            }
+        }
+        
+        // Iterate through the list and actually delete from storage
+        String baseUrl = fileConnection.getURL() + '/';
+        e = deletedFiles.elements();
+        while(e.hasMoreElements()) {
+            String messageFilename = (String)e.nextElement();
+            try {
+                FileConnection mailFileConnection =
+                    (FileConnection)Connector.open(baseUrl + messageFilename);
+                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: " + exp.toString()).getBytes(),
+                            EventLogger.DEBUG_INFO);
+                }
+            }
         }
     }

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

@@ -110 +110 @@
         }
 
+        public boolean hasExpunge() {
+            return client.hasExpunge();
+        }
+        
         public boolean isConnected() {
                 return client.isConnected();
@@ -118 +122 @@
         }
 
+        public void requestFolderExpunge(FolderTreeItem folder) {
+            connectionHandler.addRequest(IncomingMailConnectionHandler.REQUEST_FOLDER_EXPUNGE, new Object[] { folder });
+        }
+        
         public void requestFolderStatus(FolderTreeItem[] folders) {
                 connectionHandler.addRequest(IncomingMailConnectionHandler.REQUEST_FOLDER_STATUS, new Object[] { folders });
@@ -186 +194 @@
                         fireFolderTreeUpdated((FolderTreeItem)result);
                         break;
+                case IncomingMailConnectionHandler.REQUEST_FOLDER_EXPUNGE:
+                    fireFolderStatusChanged((FolderTreeItem)result);
+                    break;
                 case IncomingMailConnectionHandler.REQUEST_FOLDER_STATUS:
                         FolderTreeItem[] folders = (FolderTreeItem[])result;

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/imap/ImapClient.java

@@ -331 +331 @@
 
     /* (non-Javadoc)
+     * @see org.logicprobe.LogicMail.mail.IncomingMailClient#hasExpunge()
+     */
+    public boolean hasExpunge() {
+        return true;
+    }
+    
+    /* (non-Javadoc)
      * @see org.logicprobe.LogicMail.mail.IncomingMailClient#hasAppend()
      */
@@ -584 +591 @@
     
     /* (non-Javadoc)
+     * @see org.logicprobe.LogicMail.mail.IncomingMailClient#expungeActiveFolder()
+     */
+    public void expungeActiveFolder() throws IOException, MailException {
+        imapProtocol.executeExpunge();
+    }
+    
+    /* (non-Javadoc)
      * @see org.logicprobe.LogicMail.mail.IncomingMailClient#getFolderMessages(int, int, org.logicprobe.LogicMail.mail.FolderMessageCallback, org.logicprobe.LogicMail.mail.MailProgressHandler)
      */

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/imap/ImapProtocol.java

@@ -367 +367 @@
     }
 
+    public void executeExpunge() throws IOException, MailException {
+        if (EventLogger.getMinimumLevel() >= EventLogger.DEBUG_INFO) {
+            EventLogger.logEvent(AppInfo.GUID,
+                ("ImapProtocol.executeExpunge()").getBytes(),
+                EventLogger.DEBUG_INFO);
+        }
+
+        execute("EXPUNGE", null, null);
+    }
+    
     public StatusResponse[] executeStatus(String[] mboxpaths, MailProgressHandler progressHandler)
         throws IOException, MailException {

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/pop/PopClient.java

@@ -266 +266 @@
 
     /* (non-Javadoc)
+     * @see org.logicprobe.LogicMail.mail.IncomingMailClient#hasExpunge()
+     */
+    public boolean hasExpunge() {
+        return false;
+    }
+    
+    /* (non-Javadoc)
      * @see org.logicprobe.LogicMail.mail.IncomingMailClient#hasAppend()
      */
@@ -334 +341 @@
         // Mailbox cannot be changed, so we just pull the message counts
         activeMailbox.setMsgCount(popProtocol.executeStat());
+    }
+    
+    /* (non-Javadoc)
+     * @see org.logicprobe.LogicMail.mail.IncomingMailClient#expungeActiveFolder()
+     */
+    public void expungeActiveFolder() throws IOException, MailException {
+        // Expunge is not supported, so we do nothing here.
     }
     

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

@@ -346 +346 @@
 
     /**
+     * Gets whether this account supports expunging deleted messages.
+     *
+     * @return True if supported, false otherwise.
+     */
+    public boolean hasExpunge() {
+        return this.mailStore.hasExpunge();
+    }
+
+    /**
      * Called to trigger a refresh of the mailboxes under
      * this account.  Completion is signaled by an

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

@@ -690 +690 @@
 
     /**
+     * Check if this mailbox has messages marked as deleted.
+     * This is the recommended way to check for deleted messages,
+     * since the UI may not always track such messages.
+     * 
+     * @return True if deleted messages exist
+     */
+    public boolean hasDeletedMessages() {
+        boolean hasDeleted = false;
+        synchronized(messages) {
+            int size = messages.size();
+            for(int i=0; i<size; i++) {
+                int flags = ((MessageNode)messages.elementAt(i)).getFlags();
+                if((flags & MessageNode.Flag.DELETED) != 0) {
+                    hasDeleted = true;
+                    break;
+                }
+            }
+        }
+        return hasDeleted;
+    }
+
+    /**
+     * Tells the underlying mail store to expunge any deleted messages
+     * from the mailbox, if possible.
+     */
+    public void expungeDeletedMessages() {
+        parentAccount.getMailStore().requestFolderExpunge(this.folderTreeItem);
+    }
+
+    /**
      * Update the unseen message count from the local messages collection.
      * 

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

@@ -41 +41 @@
 import net.rim.device.api.ui.MenuItem;
 import net.rim.device.api.ui.Screen;
+import net.rim.device.api.ui.component.Dialog;
 import net.rim.device.api.ui.component.Menu;
 import net.rim.device.api.ui.container.VerticalFieldManager;
@@ -294 +295 @@
     }
 
+    
+    public boolean onClose() {
+        // Check for deleted messages in the mailbox
+        if(mailboxNode.getParentAccount().hasExpunge()
+                && mailboxNode.hasDeletedMessages()) {
+            // Prompt for expunge if possible and supported
+            int choice = Dialog.ask(
+                    Dialog.D_YES_NO,
+                    resources.getString(LogicMailResource.MAILBOX_EXPUNGE_PROMPT),
+                    Dialog.YES);
+            
+            // Request expunge if desired
+            if(choice == Dialog.YES) {
+                mailboxNode.expungeDeletedMessages();
+            }
+        }
+        
+        // Close the screen
+        screen.close();
+        return true;
+    }
+    
     /**
      * Handles mailbox status change events.