Config.java

package esmska.data;

import esmska.gui.ThemeManager;
import esmska.utils.AlphanumComparator;
import java.awt.Dimension;
import java.beans.*;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Date;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.commons.lang.ObjectUtils;
import org.apache.commons.lang.StringUtils;

/** Config properties of the whole program
 * @author ripper
 */
public class Config extends Object implements Serializable {

    /** system-wide config */
    private static GlobalConfig globalConfig = GlobalConfig.getInstance();
    /** shared instance */
    private static Config instance = new Config();
    /** mutex whether config already loaded from disk */
    private static boolean loaded = false;
    
    private static final String LATEST_VERSION = "1.9";
    private static final Logger logger = Logger.getLogger(Config.class.getName());

    private String version = "";
    private Dimension mainDimension;
    private Integer horizontalSplitPaneLocation;
    private Integer verticalSplitPaneLocation;
    private ThemeManager.LAF lookAndFeel = ThemeManager.LAF.SUBSTANCE;
    private String lafJGoodiesTheme = "Experience Blue";
    private String lafSubstanceSkin = "Business Black Steel";
    private boolean removeAccents = true;
    private boolean announceProgramUpdates = globalConfig.announceProgramUpdates;
    private boolean announceUnstableUpdates = false;
    private boolean startCentered = false;
    private boolean toolbarVisible = true;
    private String countryPrefix = "";
    private boolean useProxy = false;
    private boolean sameProxy = true;
    private String httpProxy = "";
    private String httpsProxy = "";
    private String socksProxy = "";
    private boolean notificationIconVisible = false;
    private boolean showTips = true;
    private boolean reducedHistory = false;
    private int reducedHistoryCount = 30;
    private boolean startMinimized = false;
    private boolean showAdvancedSettings = false;
    private boolean debugMode = false;
    private boolean showAdvancedControls = false;
    private String[] favoriteGateways = new String[]{};
    private String[] hiddenGateways = new String[]{};
    private String uuid = null;
    private int uuidMonth = -1;
    private Date lastStatsSent = null;

    /** Get shared instance 
     * @throws IllegalStateException until config is loaded from disk
     */
    public static Config getInstance() {
        if (!loaded && !Beans.isDesignTime()) {
            throw new IllegalStateException("Config not yet loaded!");
        }
        return instance;
    }

    /** Set shared instance */
    public static void setSharedInstance(Config config) {
        loaded = true;
        Config.instance = config;
    }
    
    /** Get latest program version */
    public static String getLatestVersion() {
        return LATEST_VERSION;
    }

    /** Whether the current program version is stable or unstable */
    public static boolean isStableVersion() {
        return !(LATEST_VERSION.contains("beta") || LATEST_VERSION.contains(".99"));
    }

    /** Compares two program versions. Handles if some of them is marked as beta.
     * @param version1 first version. Null means lowest possible version.
     * @param version2 second version. Null means lowest possible version.
     * @return positive number if version1 > version2, zero if version1 == version2,
     *         negative number otherwise
     */
    public static int compareProgramVersions(String version1, String version2) {
        if (version1 == null) {
            return (version2 == null ? 0 : -1);
        }

        String v1 = version1;
        String v2 = version2;

        //handle beta versions
        boolean beta1 = version1.toLowerCase().contains("beta");
        boolean beta2 = version2.toLowerCase().contains("beta");
        if (beta1) {
            v1 = version1.substring(0, version1.toLowerCase().indexOf("beta")).trim();
        }
        if (beta2) {
            v2 = version2.substring(0, version2.toLowerCase().indexOf("beta")).trim();
        }

        AlphanumComparator comparator = new AlphanumComparator();
        if (beta1 && beta2) {
            return comparator.compare(v1, v2) == 0 ? version1.compareTo(version2) :
                comparator.compare(v1, v2);
        } else if (beta1) {
            return (comparator.compare(v1, v2) == 0 ? -1 :
                comparator.compare(v1, v2));
        } else if (beta2) {
            return (comparator.compare(v1, v2) == 0 ? 1 :
                comparator.compare(v1, v2));
        } else {
            return comparator.compare(v1, v2);
        }
    }

    /** Return whether this is the first program run (no config existed before) */
    public boolean isFirstRun() {
        //on first run version is empty
        return StringUtils.isEmpty(version);
    }

    // <editor-fold defaultstate="collapsed" desc="PropertyChange support">
    private PropertyChangeSupport changeSupport = new PropertyChangeSupport(this) {
        @Override
        public void firePropertyChange(PropertyChangeEvent evt) {
            //do nothing if value not changed - the super method will check it anyway
            //but this way we don't have to log it
            if (ObjectUtils.equals(evt.getOldValue(), evt.getNewValue())) {
                return;
            }
            //improve log display for arrays
            Object newValue = evt.getNewValue();
            Object oldValue = evt.getOldValue();
            if (oldValue instanceof Object[]) {
                oldValue = Arrays.toString((Object[])oldValue);
                newValue = Arrays.toString((Object[])newValue);
            }
            //log change
            logger.log(Level.CONFIG, "Config changed - property: {0}, old: {1}, new: {2}",
                    new Object[]{evt.getPropertyName(), oldValue, newValue});
            //fire change
            super.firePropertyChange(evt);
        }
    };

    public void addPropertyChangeListener(PropertyChangeListener listener) {
        changeSupport.addPropertyChangeListener(listener);
    }

    public void removePropertyChangeListener(PropertyChangeListener listener) {
        changeSupport.removePropertyChangeListener(listener);
    }
    // </editor-fold>
    
    // <editor-fold defaultstate="collapsed" desc="Get Methods">
    public Dimension getMainDimension() {
        return this.mainDimension;
    }

    public Integer getHorizontalSplitPaneLocation() {
        return this.horizontalSplitPaneLocation;
    }

    public Integer getVerticalSplitPaneLocation() {
        return this.verticalSplitPaneLocation;
    }

    public ThemeManager.LAF getLookAndFeel() {
        return this.lookAndFeel;
    }

    public String getLafJGoodiesTheme() {
        return this.lafJGoodiesTheme;
    }

    public String getLafSubstanceSkin() {
        return this.lafSubstanceSkin;
    }

    public String getVersion() {
        return this.version;
    }

    public boolean isRemoveAccents() {
        return this.removeAccents;
    }

    public boolean isShowAdvancedControls() {
        return showAdvancedControls;
    }

    public boolean isAnnounceProgramUpdates() {
        return announceProgramUpdates;
    }

    public boolean isAnnounceUnstableUpdates() {
        return announceUnstableUpdates;
    }

    public boolean isStartCentered() {
        return startCentered;
    }

    public boolean isToolbarVisible() {
        return toolbarVisible;
    }
    
    public String getCountryPrefix() {
        return countryPrefix;
    }

    public boolean isUseProxy() {
        return useProxy;
    }
    
    public boolean isSameProxy() {
        return sameProxy;
    }
    
    public String getHttpProxy() {
        return httpProxy;
    }

    public String getHttpsProxy() {
        return httpsProxy;
    }

    public String getSocksProxy() {
        return socksProxy;
    }
    
    public boolean isNotificationIconVisible() {
        return notificationIconVisible;
    }

    public boolean isShowTips() {
        return showTips;
    }
    
    public boolean isReducedHistory() {
        return reducedHistory;
    }
    
    public int getReducedHistoryCount() {
        return reducedHistoryCount;
    }
    
    public boolean isStartMinimized() {
        return startMinimized;
    }
    
    public boolean isShowAdvancedSettings() {
        return showAdvancedSettings;
    }

    public boolean isDebugMode() {
        return debugMode;
    }

    public String[] getFavoriteGateways() {
        return favoriteGateways;
    }

    public String[] getHiddenGateways() {
        return hiddenGateways;
    }
    
    public String getUUID() {
        return uuid;
    }

    public int getUUIDMonth() {
        return uuidMonth;
    }

    public Date getLastStatsSent() {
        return lastStatsSent;
    }
    // </editor-fold>
    
    // <editor-fold defaultstate="collapsed" desc="Set Methods">
    public void setMainDimension(Dimension mainDimension) {
        Dimension oldMainDimension = this.mainDimension;
        this.mainDimension = mainDimension;
        changeSupport.firePropertyChange("mainDimension", oldMainDimension, mainDimension);
    }

    public void setHorizontalSplitPaneLocation(Integer horizontalSplitPaneLocation) {
        Integer oldHorizontalSplitPaneLocation = this.horizontalSplitPaneLocation;
        this.horizontalSplitPaneLocation = horizontalSplitPaneLocation;
        changeSupport.firePropertyChange("horizontalSplitPaneLocation", oldHorizontalSplitPaneLocation, horizontalSplitPaneLocation);
    }

    public void setVerticalSplitPaneLocation(Integer verticalSplitPaneLocation) {
        Integer oldVerticalSplitPaneLocation = this.verticalSplitPaneLocation;
        this.verticalSplitPaneLocation = verticalSplitPaneLocation;
        changeSupport.firePropertyChange("verticalSplitPaneLocation", oldVerticalSplitPaneLocation, verticalSplitPaneLocation);
    }

    /** Set current look and feel.
     * 
     * @param lookAndFeel current look and feel. May not be null.
     */
    public void setLookAndFeel(ThemeManager.LAF lookAndFeel) {
        if (lookAndFeel == null) {
            throw new IllegalArgumentException("lookAndFeel may not be null");
        }
        ThemeManager.LAF oldLookAndFeel = this.lookAndFeel;
        this.lookAndFeel = lookAndFeel;
        changeSupport.firePropertyChange("lookAndFeel", oldLookAndFeel, lookAndFeel);
    }

    public void setLafJGoodiesTheme(String lafJGoodiesTheme) {
        String oldLafJGoodiesTheme = this.lafJGoodiesTheme;
        this.lafJGoodiesTheme = lafJGoodiesTheme;
        changeSupport.firePropertyChange("lafJGoodiesTheme", oldLafJGoodiesTheme, lafJGoodiesTheme);
    }

    public void setLafSubstanceSkin(String lafSubstanceSkin) {
        String oldLafSubstanceSkin = this.lafSubstanceSkin;
        this.lafSubstanceSkin = lafSubstanceSkin;
        changeSupport.firePropertyChange("lafSubstanceSkin", oldLafSubstanceSkin, lafSubstanceSkin);
    }

    public void setVersion(String version) {
        String oldVersion = this.version;
        this.version = version;
        changeSupport.firePropertyChange("version", oldVersion, version);
    }

    public void setRemoveAccents(boolean removeAccents) {
        boolean oldRemoveAccents = this.removeAccents;
        this.removeAccents = removeAccents;
        changeSupport.firePropertyChange("removeAccents", oldRemoveAccents, removeAccents);
    }

    public void setAnnounceProgramUpdates(boolean announceProgramUpdates) {
        boolean old = this.announceProgramUpdates;
        this.announceProgramUpdates = announceProgramUpdates;
        changeSupport.firePropertyChange("announceProgramUpdates", old, announceProgramUpdates);
    }

    /** Set if should announce unstable versions. If currently using unstable
     version this is always set to true, regardless of the input. */
    public void setAnnounceUnstableUpdates(boolean announceUnstableUpdates) {
        if (!isStableVersion()) {
            announceUnstableUpdates = true;
        }
        boolean old = this.announceUnstableUpdates;
        this.announceUnstableUpdates = announceUnstableUpdates;
        changeSupport.firePropertyChange("announceUnstableUpdates", old, announceUnstableUpdates);
    }

    public void setStartCentered(boolean startCentered) {
        boolean old = this.startCentered;
        this.startCentered = startCentered;
        changeSupport.firePropertyChange("startCentered", old, startCentered);
    }

    public void setToolbarVisible(boolean toolbarVisible) {
        boolean old = this.toolbarVisible;
        this.toolbarVisible = toolbarVisible;
        changeSupport.firePropertyChange("toolbarVisible", old, toolbarVisible);
    }
    
    public void setCountryPrefix(String countryPrefix) {
        String old = this.countryPrefix;
        this.countryPrefix = countryPrefix;
        changeSupport.firePropertyChange("countryPrefix", old, countryPrefix);
    }
    
    public void setUseProxy(boolean useProxy) {
        boolean old = this.useProxy;
        this.useProxy = useProxy;
        changeSupport.firePropertyChange("useProxy", old, useProxy);
    }
    
    public void setSameProxy(boolean sameProxy) {
        boolean old = this.sameProxy;
        this.sameProxy = sameProxy;
        changeSupport.firePropertyChange("sameProxy", old, sameProxy);
    }
    
    public void setHttpProxy(String httpProxy) {
        String old = this.httpProxy;
        this.httpProxy = httpProxy;
        changeSupport.firePropertyChange("httpProxy", old, httpProxy);
    }

    public void setHttpsProxy(String httpsProxy) {
        String old = this.httpsProxy;
        this.httpsProxy = httpsProxy;
        changeSupport.firePropertyChange("httpsProxy", old, httpsProxy);
    }

    public void setSocksProxy(String socksProxy) {
        String old = this.socksProxy;
        this.socksProxy = socksProxy;
        changeSupport.firePropertyChange("socksProxy", old, socksProxy);
    }
    
    public void setNotificationIconVisible(boolean notificationIconVisible) {
        boolean old = this.notificationIconVisible;
        this.notificationIconVisible = notificationIconVisible;
        changeSupport.firePropertyChange("notificationIconVisible", old, notificationIconVisible);
    }

    public void setShowTips(boolean showTips) {
        boolean old = this.showTips;
        this.showTips = showTips;
        changeSupport.firePropertyChange("showTips", old, showTips);
    }
    
    public void setReducedHistory(boolean reducedHistory) {
        boolean oldReducedHistory = this.reducedHistory;
        this.reducedHistory = reducedHistory;
        changeSupport.firePropertyChange("reducedHistory", oldReducedHistory, reducedHistory);
    }
    
    public void setReducedHistoryCount(int reducedHistoryCount) {
        int oldReducedHistoryCount = this.reducedHistoryCount;
        this.reducedHistoryCount = reducedHistoryCount;
        changeSupport.firePropertyChange("reducedHistoryCount", oldReducedHistoryCount, reducedHistoryCount);
    }
    
    public void setStartMinimized(boolean startMinimized) {
        boolean old = this.startMinimized;
        this.startMinimized = startMinimized;
        changeSupport.firePropertyChange("startMinimized", old, startMinimized);
    }
    
    public void setShowAdvancedSettings(boolean showAdvancedSettings) {
        boolean old = this.showAdvancedSettings;
        this.showAdvancedSettings = showAdvancedSettings;
        changeSupport.firePropertyChange("showAdvancedSettings", old, showAdvancedSettings);
    }

    public void setDebugMode(boolean debugMode) {
        boolean old = this.debugMode;
        this.debugMode = debugMode;
        changeSupport.firePropertyChange("debugMode", old, debugMode);
    }

    public void setShowAdvancedControls(boolean showAdvancedControls) {
        boolean old = this.showAdvancedControls;
        this.showAdvancedControls = showAdvancedControls;
        changeSupport.firePropertyChange("showAdvancedControls", old, showAdvancedControls);
    }

    public void setFavoriteGateways(String[] favoriteGateways) {
        String[] old = this.favoriteGateways;
        this.favoriteGateways = favoriteGateways;
        changeSupport.firePropertyChange("favoriteGateways", old, favoriteGateways);
    }

    public void setHiddenGateways(String[] hiddenGateways) {
        String[] old = this.hiddenGateways;
        this.hiddenGateways = hiddenGateways;
        changeSupport.firePropertyChange("hiddenGateways", old, hiddenGateways);
    }
    
    public void setUUID(String uuid) {
        String old = this.uuid;
        this.uuid = uuid;
        changeSupport.firePropertyChange("uuid", old, uuid);
    }

    public void setUUIDMonth(int uuidMonth) {
        int old = this.uuidMonth;
        this.uuidMonth = uuidMonth;
        changeSupport.firePropertyChange("uuidMonth", old, uuidMonth);
    }

    public void setLastStatsSent(Date lastStatsSent) {
        Date old = this.lastStatsSent;
        this.lastStatsSent = lastStatsSent;
        changeSupport.firePropertyChange("lastStatsSent", old, lastStatsSent);
    }
    // </editor-fold>

    /** Class representing system-wide config. This holds defaults used in
     * Config class. Only changes to GlobalConfig applied before Config class
     * instantiation are reflected.
     */
    public static class GlobalConfig {
        private static final GlobalConfig instance = new GlobalConfig();

        private boolean announceProgramUpdates = true;

        private GlobalConfig() {
        }

        /** get shared instance */
        public static GlobalConfig getInstance() {
            return instance;
        }

        /** @see Config#setAnnounceProgramUpdates(boolean) */
        public void setAnnounceProgramUpdates(boolean announceProgramUpdates) {
            this.announceProgramUpdates = announceProgramUpdates;
        }

    }

}