Changeset 470

Timestamp:

07/19/09 16:02:17 (3 years ago)

Author:

octorian

Message:

More detailed progress

Location:

trunk/LogicMail/src/org/logicprobe/LogicMail

Files:

• LogicMail.rrc (modified) (1 diff)
• LogicMail.rrh (modified) (1 diff)
• mail/AbstractMailConnectionHandler.java (modified) (7 diffs)
• mail/IncomingMailConnectionHandler.java (modified) (11 diffs)
• mail/MailConnectionManager.java (modified) (1 diff)
• mail/MailConnectionStatusEvent.java (modified) (2 diffs)
• mail/OutgoingMailConnectionHandler.java (modified) (2 diffs)
• message/MimeMessagePartFactory.java (modified) (1 diff)
• message/MimeMessagePartTransformer.java (modified) (1 diff)
• ui/BrowserFieldManager.java (modified) (1 diff)
• ui/MessageScreen.java (modified) (1 diff)

trunk/LogicMail/src/org/logicprobe/LogicMail/LogicMail.rrc

@@ -68 +68 @@
 MAILBOX_DELETE_PROMPT#0="Are you sure you want to delete this message?";
 MAILBOX_DRAFT_MULTIPLE_ACCOUNTS#0="Which account would you like this message to be sent from?";
+MAILCONNECTION_CLOSING_CONNECTION#0="Closing connection...";
+MAILCONNECTION_OPENING_CONNECTION#0="Opening connection...";
+MAILCONNECTION_REQUEST_FOLDER_MESSAGES#0="Getting folder messages...";
+MAILCONNECTION_REQUEST_FOLDER_STATUS#0="Refreshing folder status...";
+MAILCONNECTION_REQUEST_FOLDER_TREE#0="Getting folder tree...";
+MAILCONNECTION_REQUEST_MESSAGE#0="Loading message...";
+MAILCONNECTION_REQUEST_MESSAGE_ANSWERED#0="Updating message flags...";
+MAILCONNECTION_REQUEST_MESSAGE_APPEND#0="Storing message...";
+MAILCONNECTION_REQUEST_MESSAGE_DELETE#0="Deleting message...";
+MAILCONNECTION_REQUEST_MESSAGE_UNDELETE#0="Undeleting message...";
+MAILCONNECTION_REQUEST_SEND_MESSAGE#0="Sending message...";
 MAILHOME_NOACCOUNTS#0="No accounts";
 MAILHOME_TITLE#0="Home";

trunk/LogicMail/src/org/logicprobe/LogicMail/LogicMail.rrh

@@ -161 +161 @@
 MESSAGE_SAVING_ATTACHMENT#0=159;
 MESSAGE_UNABLE_TO_SAVE_ATTACHMENT#0=160;
+MAILCONNECTION_OPENING_CONNECTION#0=161;
+MAILCONNECTION_CLOSING_CONNECTION#0=162;
+MAILCONNECTION_REQUEST_SEND_MESSAGE#0=163;
+MAILCONNECTION_REQUEST_FOLDER_TREE#0=164;
+MAILCONNECTION_REQUEST_FOLDER_STATUS#0=165;
+MAILCONNECTION_REQUEST_FOLDER_MESSAGES#0=166;
+MAILCONNECTION_REQUEST_MESSAGE#0=167;
+MAILCONNECTION_REQUEST_MESSAGE_DELETE#0=168;
+MAILCONNECTION_REQUEST_MESSAGE_UNDELETE#0=169;
+MAILCONNECTION_REQUEST_MESSAGE_ANSWERED#0=170;
+MAILCONNECTION_REQUEST_MESSAGE_APPEND#0=171;

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

@@ -34 +34 @@
 import java.io.IOException;
 
+import net.rim.device.api.i18n.ResourceBundle;
 import net.rim.device.api.system.EventLogger;
 
 import org.logicprobe.LogicMail.AppInfo;
+import org.logicprobe.LogicMail.LogicMailResource;
 import org.logicprobe.LogicMail.util.Queue;
 
@@ -45 +47 @@
  */
 public abstract class AbstractMailConnectionHandler {
+        protected static ResourceBundle resources = ResourceBundle.getBundle(LogicMailResource.BUNDLE_ID, LogicMailResource.BUNDLE_NAME);
         private MailClient client;
         private ConnectionThread connectionThread;
@@ -195 +198 @@
      */
         private void handleOpeningConnection() throws IOException, MailException {
-                showStatus("Opening connection...");
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_OPENING_CONNECTION));
                 if(checkLogin(client)) {
                         if(client.open()) {
@@ -256 +259 @@
                         Object[] params = (Object[])request[1];
                         
-                        // Handle the specific request
-                        showStatus("Processing requests...");
+                        // Delegate to subclasses to handle the specific request
                         handleRequest(type, params);
                         
@@ -269 +271 @@
         /**
          * Handles a specific request during the REQUESTS state.
+         * <p>
          * Subclasses should implement this to dispatch requests for all
          * the request types they know how to handle.
+         * Subclasses should also call {@link #showStatus(String)} and/or
+         * {@link #showStatus(String, int)} as necessary to update the
+         * user on the status of the operation.
+         * </p>
          * 
          * @param type Type identifier for the request.
@@ -325 +332 @@
      */
         private void handleClosingConnection() throws IOException, MailException {
-                showStatus("Closing connection...");
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_CLOSING_CONNECTION));
                 handleBeforeClosing();
                 try { client.close(); } catch (IOException e) {} catch (MailException e) {}
@@ -398 +405 @@
          * @param message The message to show
          */
-        private void showStatus(String message) {
+        protected void showStatus(String message) {
                 MailConnectionManager.getInstance().fireMailConnectionStatus(client.getConnectionConfig(), message);
+        }
+        
+        /**
+         * Show a status message with a progress percentage.
+         * 
+         * @param message The message to show
+         * @param progress The progress percentage
+         */
+        protected void showStatus(String message, int progress) {
+                MailConnectionManager.getInstance().fireMailConnectionStatus(client.getConnectionConfig(), message, progress);
         }
         

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

@@ -37 +37 @@
 import net.rim.device.api.system.UnsupportedOperationException;
 
+import org.logicprobe.LogicMail.LogicMailResource;
 import org.logicprobe.LogicMail.message.FolderMessage;
 import org.logicprobe.LogicMail.message.Message;
@@ -200 +201 @@
 
         private void handleRequestFolderTree() throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_FOLDER_TREE));
                 FolderTreeItem root = incomingClient.getFolderTree();
 
@@ -209 +211 @@
         
         private void handleRequestFolderStatus(FolderTreeItem[] folders) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_FOLDER_STATUS));
                 incomingClient.refreshFolderStatus(folders);
                 
@@ -218 +221 @@
         
         private void handleRequestFolderMessagesRange(FolderTreeItem folder, int firstIndex, int lastIndex) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_FOLDER_MESSAGES));
                 checkActiveFolder(folder);
                 
@@ -241 +245 @@
         
         private void handleRequestFolderMessagesRecent(FolderTreeItem folder) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_FOLDER_MESSAGES));
                 checkActiveFolder(folder);
         
@@ -252 +257 @@
         
         private void handleRequestMessage(MessageToken messageToken) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_MESSAGE));
                 checkActiveFolder(messageToken);
                 
@@ -263 +269 @@
 
         private void handleRequestMessageParts(MessageToken messageToken, MimeMessagePart[] messageParts) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_MESSAGE));
                 checkActiveFolder(messageToken);
 
@@ -291 +298 @@
         
         private void handleRequestMessageDelete(MessageToken messageToken, MessageFlags messageFlags) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_MESSAGE_DELETE));
                 checkActiveFolder(messageToken);
                 
@@ -302 +310 @@
         
         private void handleRequestMessageUndelete(MessageToken messageToken, MessageFlags messageFlags) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_MESSAGE_UNDELETE));
                 checkActiveFolder(messageToken);
                 
@@ -313 +322 @@
         
         private void handleRequestMessageAnswered(MessageToken messageToken, MessageFlags messageFlags) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_MESSAGE_ANSWERED));
                 // Replace this with a more general method:
                 if(incomingClient instanceof org.logicprobe.LogicMail.mail.imap.ImapClient) {
@@ -326 +336 @@
         
         private void handleRequestMessageAppend(FolderTreeItem folder, String rawMessage, MessageFlags initialFlags) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_MESSAGE_APPEND));
                 // Clean up this interface:
                 if(incomingClient instanceof org.logicprobe.LogicMail.mail.imap.ImapClient) {

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

@@ -126 +126 @@
     /**
      * Notifies all registered <tt>MailConnectionListener</tt>s
+     * of an updated status message with a progress percentage.
+     * 
+     * @param connectionConfig The configuration for the connection that generated this event.
+     * @param message The status message.
+     * @param progress The progress percentage.
+     */
+    void fireMailConnectionStatus(ConnectionConfig connectionConfig, String message, int progress) {
+        Object[] listeners = listenerList.getListeners(MailConnectionListener.class);
+        MailConnectionStatusEvent e = null;
+        for(int i=0; i<listeners.length; i++) {
+                if(e == null) {
+                        e = new MailConnectionStatusEvent(
+                                        this, connectionConfig, message,
+                                        MailConnectionStatusEvent.PROGRESS_MEASURED, progress);
+                }
+                ((MailConnectionListener)listeners[i]).mailConnectionStatus(e);
+        }
+    }
+    
+    /**
+     * Notifies all registered <tt>MailConnectionListener</tt>s
      * of an error with the mail connection.
      * 

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

@@ -39 +39 @@
 public class MailConnectionStatusEvent extends MailConnectionEvent {
         private String message;
+        private int progressType;
+        private int progressPercentage;
         
-        /** Creates a new instance of MailConnectionStatusEvent */
-        public MailConnectionStatusEvent(Object source, ConnectionConfig connectionConfig, String message) {
+        /** The progress is indeterminate. */
+        public static final int PROGRESS_INDETERMINATE = 0;
+        /** The progress is measured incrementally. */
+        public static final int PROGRESS_MEASURED = 0;
+        
+        /**
+         * Creates a new instance of MailConnectionStatusEvent.
+         * 
+         * @param source the source
+         * @param connectionConfig the connection configuration instance
+         * @param message the status message
+         * @param progressType the progress type
+         * @param progressPercentage the progress percentage
+         */
+        public MailConnectionStatusEvent(Object source, ConnectionConfig connectionConfig, String message, int progressType, int progressPercentage) {
                 super(source, connectionConfig);
                 this.message = message;
+                this.progressType = progressType;
+                this.progressPercentage = progressPercentage;
         }
         
         /**
+         * Creates a new instance of MailConnectionStatusEvent
+         * with indeterminate progress.
+         * 
+         * @param source the source
+         * @param connectionConfig the connection configuration instance
+         * @param message the status message
+         */
+        public MailConnectionStatusEvent(Object source, ConnectionConfig connectionConfig, String message) {
+                this(source, connectionConfig, message, PROGRESS_INDETERMINATE, 0);
+        }
+
+        /**
          * Gets the status message.
+         * 
          * @return Status message
          */
@@ -53 +83 @@
                 return message;
         }
+        
+        /**
+         * Gets the progress type.
+         * 
+         * @return The progress type.
+         */
+        public int getProgressType() {
+                return progressType;
+        }
+
+        /**
+         * Gets the progress percentage.
+         * Only valid if the progress type is <tt>PROGRESS_MEASURED</tt>.
+         * 
+         * @return The progress percentage.
+         */
+        public int getProgressPercentage() {
+                return progressPercentage;
+        }
 }

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

@@ -5 +5 @@
 import java.util.TimerTask;
 
+import org.logicprobe.LogicMail.LogicMailResource;
 import org.logicprobe.LogicMail.message.Message;
 import org.logicprobe.LogicMail.message.MessageEnvelope;
@@ -94 +95 @@
         
         private void handleRequestSendMessage(MessageEnvelope envelope, Message message) throws IOException, MailException {
+                showStatus(resources.getString(LogicMailResource.MAILCONNECTION_REQUEST_SEND_MESSAGE));
                 String messageSource = outgoingClient.sendMessage(envelope, message);
                 

trunk/LogicMail/src/org/logicprobe/LogicMail/message/MimeMessagePartFactory.java

@@ -110 +110 @@
     /**
      * Find out if a particular message part type is supported
-     * without having to create it.  This is useful to optimize
+     * as displayable content.  This is useful to optimize
      * downloads on protocols that support selective retrieval
      * of message parts.

trunk/LogicMail/src/org/logicprobe/LogicMail/message/MimeMessagePartTransformer.java

@@ -172 +172 @@
                 }
                 
-                // TODO: Add ApplicationPart, AudioPart, VideoPart, and MessagePart
+                public void visitApplicationPart(ApplicationPart part) {
+                        attachmentParts.addElement(part);
+                }
+                
+                public void visitAudioPart(AudioPart part) {
+                        attachmentParts.addElement(part);
+                }
+                
+                public void visitVideoPart(VideoPart part) {
+                        attachmentParts.addElement(part);
+                }
         }
 }

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

@@ -35 +35 @@
 import net.rim.device.api.ui.FieldChangeListener;
 import net.rim.device.api.ui.MenuItem;
-import net.rim.device.api.ui.XYRect;
 import net.rim.device.api.ui.component.Menu;
 import net.rim.device.api.ui.container.VerticalFieldManager;

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

@@ -426 +426 @@
         // TODO: Support on-demand downloading of additional content
         MimeMessageContent content = messageNode.getMessageContent(contentPart);
-        if(content != null) {
-                FileSaveDialog dialog = new FileSaveDialog(contentPart.getName());
-                if(dialog.doModal() != Dialog.CANCEL) {
-                        (new SaveAttachmentThread(content, dialog.getFileUrl())).start();
-                        Status.show(resources.getString(LogicMailResource.MESSAGE_SAVING_ATTACHMENT));
-                }
-        }
+        FileSaveDialog dialog = new FileSaveDialog(contentPart.getName());
+                if(dialog.doModal() != Dialog.CANCEL) {
+                if(content != null) {
+                        // Content has been downloaded already, so just save it
+                                (new SaveAttachmentThread(content, dialog.getFileUrl())).start();
+                                Status.show(resources.getString(LogicMailResource.MESSAGE_SAVING_ATTACHMENT));
+                }
+                else {
+                        // Download content from server, then save it
+                        // TODO: Implement on-demand attachment downloading
+                        Status.show("Attachment has not been downloaded from the server");
+                }
+                }
         }