Changeset 628

Timestamp:

02/03/10 16:58:22 (2 years ago)

Author:

octorian

Message:

Integration of better configuration change notifications (#175)

Location:

trunk/LogicMail/src/org/logicprobe/LogicMail

Files:

• conf/GlobalConfig.java (modified) (2 diffs)
• conf/ImapConfig.java (modified) (2 diffs)
• mail/imap/ImapClient.java (modified) (6 diffs)
• mail/pop/PopClient.java (modified) (5 diffs)
• mail/smtp/SmtpClient.java (modified) (3 diffs)
• model/MailFileManager.java (modified) (2 diffs)
• model/MailManager.java (modified) (1 diff)
• ui/AccountConfigScreen.java (modified) (1 diff)
• ui/ConfigScreen.java (modified) (1 diff)

trunk/LogicMail/src/org/logicprobe/LogicMail/conf/GlobalConfig.java

@@ -52 +52 @@
     /** Global network settings. */
     public static final int CHANGE_TYPE_NETWORK = 0x01;
+    /** Global data storage settings. */
+    public static final int CHANGE_TYPE_DATA = 0x02;
     /** Global other settings. */
-    public static final int CHANGE_TYPE_OTHER = 0x02;
+    public static final int CHANGE_TYPE_OTHER = 0x04;
 
     /** Prefer plain text display for messages */
@@ -236 +238 @@
         if(!this.localDataLocation.equals(localDataLocation)) {
             this.localDataLocation = validateLocalDataLocation(localDataLocation);
-            changeType |= CHANGE_TYPE_OTHER;
+            changeType |= CHANGE_TYPE_DATA;
         }
     }

trunk/LogicMail/src/org/logicprobe/LogicMail/conf/ImapConfig.java

@@ -70 +70 @@
         this.maxMessageSize = 32768;
         this.maxFolderDepth = 4;
-        this.folderPrefix = null;
+        this.folderPrefix = "";
         this.onlySubscribedFolders = true;
     }
@@ -192 +192 @@
         if(value instanceof String) {
             folderPrefix = (String)value;
-            if(folderPrefix.length() == 0) {
-                folderPrefix = null;
-            }
         }
         value = table.get("account_imap_maxMessageSize");

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

@@ -72 +72 @@
  */
 public class ImapClient implements IncomingMailClient {
+    private MailSettings mailSettings;
     private ImapConfig accountConfig;
     private Connection connection;
@@ -126 +127 @@
     public ImapClient(GlobalConfig globalConfig, ImapConfig accountConfig) {
         this.accountConfig = accountConfig;
+        this.mailSettings = MailSettings.getInstance();
         connection = UtilFactory.getInstance().createConnection(accountConfig);
         imapProtocol = new ImapProtocol(connection);
@@ -132 +134 @@
         openStarted = false;
         configChanged = false;
-        MailSettings.getInstance().addMailSettingsListener(mailSettingsListener);
+        mailSettings.addMailSettingsListener(mailSettingsListener);
     }
 
@@ -142 +144 @@
 
     private void mailSettings_MailSettingsSaved(MailSettingsEvent e) {
-        if(MailSettings.getInstance().containsAccountConfig(accountConfig)) {
+        // Check for a list change, where we no longer exist afterwards
+        if((e.getListChange() & MailSettingsEvent.LIST_CHANGED_ACCOUNT) != 0
+                && !mailSettings.containsAccountConfig(accountConfig)) {
+            // We have been deleted, so unregister to make sure we
+            // no longer affect the system and can be garbage collected.
+            mailSettings.removeMailSettingsListener(mailSettingsListener);
+        }
+
+        // Check for a change to the global or account network settings
+        if((e.getGlobalChange() & GlobalConfig.CHANGE_TYPE_NETWORK) != 0
+                || (e.getConfigChange(accountConfig) & AccountConfig.CHANGE_TYPE_CONNECTION) != 0) {
             // Refresh authentication information from the configuration
             username = accountConfig.getServerUser();
@@ -157 +169 @@
                 configChanged = true;
             }
-        }
-        else {
-            // We have been deleted, so unregister to make sure we
-            // no longer affect the system and can be garbage collected.
-            MailSettings.getInstance().removeMailSettingsListener(mailSettingsListener);
         }
     }
@@ -694 +701 @@
 
         if(!seenMailboxes.containsKey(activeMailbox)) {
-            int count = MailSettings.getInstance().getGlobalConfig().getRetMsgCount();
+            int count = mailSettings.getGlobalConfig().getRetMsgCount();
             int msgCount = activeMailbox.getMsgCount();
             int firstIndex = Math.max(1, msgCount - count);

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

@@ -68 +68 @@
  */
 public class PopClient implements IncomingMailClient {
+    private MailSettings mailSettings;
     private GlobalConfig globalConfig;
     private PopConfig accountConfig;
@@ -93 +94 @@
         this.globalConfig = globalConfig;
         this.accountConfig = accountConfig;
+        this.mailSettings = MailSettings.getInstance();
         connection = UtilFactory.getInstance().createConnection(accountConfig);
         popProtocol = new PopProtocol(connection);
@@ -103 +105 @@
         openStarted = false;
         configChanged = false;
-        MailSettings.getInstance().addMailSettingsListener(mailSettingsListener);
+        mailSettings.addMailSettingsListener(mailSettingsListener);
     }
 
@@ -113 +115 @@
     
     private void mailSettings_MailSettingsSaved(MailSettingsEvent e) {
-                if(MailSettings.getInstance().containsAccountConfig(accountConfig)) {
-                        // Refresh authentication information from the configuration
-                username = accountConfig.getServerUser();
-                password = accountConfig.getServerPass();
-                
-                if(!isConnected()) {
-                        // Rebuild the connection to include new settings
-                    connection = UtilFactory.getInstance().createConnection(accountConfig);
-                    popProtocol = new PopProtocol(connection);
-                }
-                else {
-                        // Set a flag to make sure we rebuild the Connection object
-                        // the next time we close the connection.
-                        configChanged = true;
-                }
-                }
-                else {
-                        // We have been deleted, so unregister to make sure we
-                        // no longer affect the system and can be garbage collected.
-                        MailSettings.getInstance().removeMailSettingsListener(mailSettingsListener);
-                }
+        // Check for a list change, where we no longer exist afterwards
+        if((e.getListChange() & MailSettingsEvent.LIST_CHANGED_ACCOUNT) != 0
+                && !mailSettings.containsAccountConfig(accountConfig)) {
+            // We have been deleted, so unregister to make sure we
+            // no longer affect the system and can be garbage collected.
+            mailSettings.removeMailSettingsListener(mailSettingsListener);
+        }
+
+        // Check for a change to the global or account network settings
+        if((e.getGlobalChange() & GlobalConfig.CHANGE_TYPE_NETWORK) != 0
+                || (e.getConfigChange(accountConfig) & AccountConfig.CHANGE_TYPE_CONNECTION) != 0) {
+            // Refresh authentication information from the configuration
+            username = accountConfig.getServerUser();
+            password = accountConfig.getServerPass();
+
+            if(!isConnected()) {
+                // Rebuild the connection to include new settings
+                connection = UtilFactory.getInstance().createConnection(accountConfig);
+                popProtocol = new PopProtocol(connection);
+            }
+            else {
+                // Set a flag to make sure we rebuild the Connection object
+                // the next time we close the connection.
+                configChanged = true;
+            }
+        }
     }
 
@@ -435 +442 @@
      */
     public void getNewFolderMessages(boolean flagsOnly, FolderMessageCallback callback, MailProgressHandler progressHandler) throws IOException, MailException {
-        int count = MailSettings.getInstance().getGlobalConfig().getRetMsgCount();
+        int count = globalConfig.getRetMsgCount();
                 int msgCount = activeMailbox.getMsgCount();
         int firstIndex = Math.max(1, msgCount - count);

trunk/LogicMail/src/org/logicprobe/LogicMail/mail/smtp/SmtpClient.java

@@ -55 +55 @@
  */
 public class SmtpClient implements OutgoingMailClient {
+    private MailSettings mailSettings;
     private GlobalConfig globalConfig;
     private OutgoingConfig outgoingConfig;
@@ -80 +81 @@
         this.globalConfig = globalConfig;
         this.outgoingConfig = outgoingConfig;
+        this.mailSettings = MailSettings.getInstance();
         connection = UtilFactory.getInstance().createConnection(outgoingConfig);
         smtpProtocol = new SmtpProtocol(connection);
@@ -93 +95 @@
         openStarted = false;
         configChanged = false;
-        MailSettings.getInstance().addMailSettingsListener(mailSettingsListener);
+        mailSettings.addMailSettingsListener(mailSettingsListener);
     }
 
     private void mailSettings_MailSettingsSaved(MailSettingsEvent e) {
-        if (MailSettings.getInstance().containsOutgoingConfig(outgoingConfig)) {
+        // Check for a list change, where we no longer exist afterwards
+        if((e.getListChange() & MailSettingsEvent.LIST_CHANGED_OUTGOING) != 0
+                && !mailSettings.containsOutgoingConfig(outgoingConfig)) {
+            // We have been deleted, so unregister to make sure we
+            // no longer affect the system and can be garbage collected.
+            mailSettings.removeMailSettingsListener(mailSettingsListener);
+        }
+
+        // Check for a change to the global or account network settings
+        if((e.getGlobalChange() & GlobalConfig.CHANGE_TYPE_NETWORK) != 0
+                || (e.getConfigChange(outgoingConfig) & OutgoingConfig.CHANGE_TYPE_CONNECTION) != 0) {
             // Refresh authentication information from the configuration
             username = outgoingConfig.getServerUser();
             password = outgoingConfig.getServerPass();
 
-            if (!isConnected()) {
+            if(!isConnected()) {
                 // Rebuild the connection to include new settings
                 connection = UtilFactory.getInstance().createConnection(outgoingConfig);
                 smtpProtocol = new SmtpProtocol(connection);
-            } else {
+            }
+            else {
                 // Set a flag to make sure we rebuild the Connection object
                 // the next time we close the connection.
                 configChanged = true;
             }
-        } else {
-            // We have been deleted, so unregister to make sure we
-            // no longer affect the system and can be garbage collected.
-            MailSettings.getInstance().removeMailSettingsListener(mailSettingsListener);
         }
     }

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

@@ -45 +45 @@
 
 import org.logicprobe.LogicMail.AppInfo;
+import org.logicprobe.LogicMail.conf.GlobalConfig;
 import org.logicprobe.LogicMail.conf.MailSettings;
 import org.logicprobe.LogicMail.conf.MailSettingsEvent;
@@ -69 +70 @@
          * Instantiates a new mail file manager.
          */
-        private MailFileManager() {
-                mailSettings = MailSettings.getInstance();
-                
-                // Register a listener for configuration changes
-                mailSettings.addMailSettingsListener(new MailSettingsListener() {
-                        public void mailSettingsSaved(MailSettingsEvent e) {
-                                refreshConfiguration();
-                        }
-                });
-                
-                refreshConfiguration();
-        }
+    private MailFileManager() {
+        mailSettings = MailSettings.getInstance();
+
+        // Register a listener for configuration changes
+        mailSettings.addMailSettingsListener(new MailSettingsListener() {
+            public void mailSettingsSaved(MailSettingsEvent e) {
+                if((e.getGlobalChange() & GlobalConfig.CHANGE_TYPE_DATA) != 0) {
+                    refreshConfiguration();
+                }
+            }
+        });
+
+        refreshConfiguration();
+    }
         
         /**

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

@@ -73 +73 @@
                 MailSettings.getInstance().addMailSettingsListener(new MailSettingsListener() {
                         public void mailSettingsSaved(MailSettingsEvent e) {
-                                mailSettings_MailSettingsSaved(e);
-                                refreshMailboxTypes();
+                            // This logic is rather crude, and will trigger a full refresh
+                            // under a wide variety of circumstances.  Its major intent is
+                            // to avoid a refresh in a few situations where a minor
+                            // configuration change affects future behavior and not
+                            // current state.
+                            
+                            boolean refreshAccounts = false;
+                            // Trigger a refresh if either the account or outgoing list has changed
+                            int listChange = e.getListChange();
+                            if((listChange & MailSettingsEvent.LIST_CHANGED_ACCOUNT) != 0
+                                    || (listChange & MailSettingsEvent.LIST_CHANGED_OUTGOING) != 0) {
+                                refreshAccounts = true;
+                            }
+                            
+                            // Trigger a refresh if certain account settings have changed
+                            if(!refreshAccounts) {
+                                int num = mailSettings.getNumAccounts();
+                                for(int i=0; i<num; i++) {
+                                    AccountConfig accountConfig = mailSettings.getAccountConfig(i);
+                                    int accountChange = e.getConfigChange(accountConfig);
+                                    if((accountChange & AccountConfig.CHANGE_TYPE_NAME) != 0
+                                            || (accountChange & AccountConfig.CHANGE_TYPE_MAILBOXES) != 0
+                                || (accountChange & AccountConfig.CHANGE_TYPE_OUTGOING) != 0) {
+                                        refreshAccounts = true;
+                                        break;
+                                    }
+                                    OutgoingConfig outgoingConfig = accountConfig.getOutgoingConfig();
+                                    if(outgoingConfig != null
+                                            && (e.getConfigChange(outgoingConfig) & OutgoingConfig.CHANGE_TYPE_CONNECTION) != 0) {
+                            refreshAccounts = true;
+                            break;
+                                    }
+                                }
+                            }
+                            
+                            // Trigger a refresh if appropriate
+                            if(refreshAccounts) {
+                            mailSettings_MailSettingsSaved(e);
+                                refreshMailboxTypes();
+                            }
                         }
                 });

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

@@ -628 +628 @@
             ImapConfig imapConfig = (ImapConfig)accountConfig;
 
-            String folderPrefix = imapFolderPrefixField.getText().trim();
-            if(folderPrefix.length() == 0) {
-                imapConfig.setFolderPrefix(null);
-            }
-            else {
-                imapConfig.setFolderPrefix(folderPrefix);
-            }
+            imapConfig.setFolderPrefix(imapFolderPrefixField.getText().trim());
 
             try {

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

@@ -141 +141 @@
 
         buildAccountsList();
-
-        MailSettings.getInstance().addMailSettingsListener(new MailSettingsListener() {
-            public void mailSettingsSaved(MailSettingsEvent e) {
-                buildAccountsList();
-            }
-        });
-    }
-
+    }
+
+    MailSettingsListener mailSettingsListener = new MailSettingsListener() {
+        public void mailSettingsSaved(MailSettingsEvent e) {
+            buildAccountsList();
+        }
+    };
+    
+    protected void onDisplay() {
+        super.onDisplay();
+        MailSettings.getInstance().addMailSettingsListener(mailSettingsListener);
+    }
+    
+    protected void onUndisplay() {
+        MailSettings.getInstance().removeMailSettingsListener(mailSettingsListener);
+        super.onUndisplay();
+    }
+    
     private void initFileSystemChoices() {
         // Populate fileSystemRoots with a list of all