NetworkPanel.java

/*
 * Syncany, www.syncany.org
 * Copyright (C) 2011-2013 Philipp C. Heckel <philipp.heckel@gmail.com> 
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.syncany.gui.preferences;

import java.util.logging.Level;
import java.util.logging.Logger;

import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.events.VerifyEvent;
import org.eclipse.swt.events.VerifyListener;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.syncany.config.ConfigException;
import org.syncany.config.UserConfig;
import org.syncany.config.to.UserConfigTO;
import org.syncany.gui.Panel;
import org.syncany.gui.util.I18n;
import org.syncany.gui.util.WidgetDecorator;

/**
 * 
 * @see http://stackoverflow.com/questions/120797/how-do-i-set-the-proxy-to-be-used-by-the-jvm
 */
public class NetworkPanel extends Panel {
	private static final Logger logger = Logger.getLogger(NetworkPanel.class.getSimpleName());		

	private UserConfigTO userConfig;	
	
	private Button noProxyButton;
	private Button useSystemProxyButton;
	private Button manualProxyButton;
	 
	private Combo proxyTypeCombo;
	private Text proxyServerHostText;
	private Text proxyServerPortText;
	
	private Button proxyNeedsAuthCheckButton;
	private Label proxyAuthUserLabel;
	private Text proxyAuthUserText;
	private Label proxyAuthPassLabel;
	private Text proxyAuthPassText;
	
	private Composite proxyChangesNeedRestartComposite;
	
	public NetworkPanel(PreferencesDialog parentDialog, Composite composite, int style) {
		super(parentDialog, composite, style);
				
		createContents();		
		loadConfig();
	}

	private void createContents() {
		// Main composite
		GridLayout mainCompositeGridLayout = new GridLayout(5, false);
		mainCompositeGridLayout.marginTop = 15;
		mainCompositeGridLayout.marginLeft = 10;
		mainCompositeGridLayout.marginRight = 20;

		setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false, 5, 1));
		setLayout(mainCompositeGridLayout);

		// Title and welcome text
		Label titleLabel = new Label(this, SWT.WRAP);
		titleLabel.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, true, false, 5, 1));
		titleLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.title"));

		WidgetDecorator.title(titleLabel);

		// Common listener to react on radio button changes, and save the config	
		SelectionListener commonSelectionListener = new SelectionAdapter() {			
			@Override
			public void widgetSelected(SelectionEvent e) {
				updateControls();
				saveConfig();
			}			
		};
		
		ModifyListener commonModifyListener = new ModifyListener() {			
			@Override
			public void modifyText(ModifyEvent e) {
				updateControls();
				saveConfig();
			}			
		};
		
		// Proxy settings
		Label proxySettingsLabel = new Label(this, SWT.NONE);
		proxySettingsLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxySettings"));
		
	    noProxyButton = new Button(this, SWT.RADIO);
	    noProxyButton.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, true, false, 4, 1));
	    noProxyButton.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.noProxy"));	    
	    noProxyButton.addSelectionListener(commonSelectionListener);
	    
		Label fillerBelowProxySettingsLabel = new Label(this, SWT.NONE);
		fillerBelowProxySettingsLabel.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, false, false, 1, 2));
	    
	    useSystemProxyButton = new Button(this, SWT.RADIO);
	    useSystemProxyButton.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, true, false, 4, 1));
	    useSystemProxyButton.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.useSystemProxy"));
	    useSystemProxyButton.addSelectionListener(commonSelectionListener);
	    
	    manualProxyButton = new Button(this, SWT.RADIO);
	    manualProxyButton.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, false, false, 4, 1));
	    manualProxyButton.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.manualProxy"));
	    manualProxyButton.addSelectionListener(commonSelectionListener);
	    
	    // Proxy type
		Label proxyTypeLabel = new Label(this, SWT.NONE);
		proxyTypeLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyType"));

	    proxyTypeCombo = new Combo(this, SWT.DROP_DOWN | SWT.BORDER | SWT.READ_ONLY);
	    proxyTypeCombo.setLayoutData(new GridData(SWT.LEFT, SWT.CENTER, true, false, 4, 1));
	    proxyTypeCombo.addSelectionListener(commonSelectionListener);

	    proxyTypeCombo.add("HTTP");
	    proxyTypeCombo.add("SOCKS");
	    proxyTypeCombo.select(0);
	    
		Label proxyServerLabel = new Label(this, SWT.NONE);
		proxyServerLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyServer"));

		GridData proxyServerHostTextGridData = new GridData(SWT.LEFT, SWT.CENTER, false, false, 2, 1);
		proxyServerHostTextGridData.widthHint = 180;
		
		proxyServerHostText = new Text(this, SWT.BORDER);
		proxyServerHostText.setBackground(WidgetDecorator.WHITE);
		proxyServerHostText.setLayoutData(proxyServerHostTextGridData);
		proxyServerHostText.addModifyListener(commonModifyListener);
		
		WidgetDecorator.normal(proxyServerHostText);
		
		Label proxyPortColonLabel = new Label(this, SWT.NONE);
		proxyPortColonLabel.setText(":");
		
		GridData proxyServerPortTextGridData = new GridData(SWT.LEFT, SWT.CENTER, false, false, 1, 1);
		proxyServerPortTextGridData.widthHint = 50;
		
		proxyServerPortText = new Text(this, SWT.BORDER);
		proxyServerPortText.setBackground(WidgetDecorator.WHITE);
		proxyServerPortText.setLayoutData(proxyServerPortTextGridData);
		proxyServerPortText.addModifyListener(commonModifyListener);		
		proxyServerPortText.addVerifyListener(new VerifyListener() {
	        @Override
	        public void verifyText(VerifyEvent e) {
	        	proxyServerPortTextVerify(e);
	        }
	    });		
	    
		WidgetDecorator.normal(proxyServerPortText);
		
		Label fillerBelowServerLabel = new Label(this, SWT.NONE);
		fillerBelowServerLabel.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, false, false, 1, 3));

	    proxyNeedsAuthCheckButton = new Button(this, SWT.CHECK);
	    proxyNeedsAuthCheckButton.setLayoutData(new GridData(SWT.LEFT, SWT.TOP, false, false, 4, 1));
	    proxyNeedsAuthCheckButton.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyNeedsAuth"));
	    proxyNeedsAuthCheckButton.addSelectionListener(commonSelectionListener);	    

		proxyAuthUserLabel = new Label(this, SWT.NONE);
		proxyAuthUserLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyAuthUser"));

		GridData proxyAuthFieldGridData = new GridData(SWT.LEFT, SWT.CENTER, true, false, 3, 1);
		proxyAuthFieldGridData.widthHint = 110;
		proxyAuthFieldGridData.grabExcessHorizontalSpace = true;
		
		proxyAuthUserText = new Text(this, SWT.BORDER);		
		proxyAuthUserText.setBackground(WidgetDecorator.WHITE);
		proxyAuthUserText.setLayoutData(proxyAuthFieldGridData);
		proxyAuthUserText.addModifyListener(commonModifyListener);

		WidgetDecorator.normal(proxyAuthUserText);
		
		proxyAuthPassLabel = new Label(this, SWT.NONE);
		proxyAuthPassLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyAuthPass"));

		proxyAuthPassText = new Text(this, SWT.BORDER | SWT.PASSWORD);		
		proxyAuthPassText.setBackground(WidgetDecorator.WHITE);
		proxyAuthPassText.setLayoutData(proxyAuthFieldGridData);
		proxyAuthPassText.addModifyListener(commonModifyListener);	
		
		WidgetDecorator.normal(proxyAuthPassText);
		
		GridLayout proxyChangesNeedRestartGridLayout = new GridLayout(1, false);
		proxyChangesNeedRestartGridLayout.marginLeft = 0;
		proxyChangesNeedRestartGridLayout.marginBottom = 7;
		
		proxyChangesNeedRestartComposite = new Composite(this, SWT.NONE);
		proxyChangesNeedRestartComposite.setVisible(false);
		proxyChangesNeedRestartComposite.setLayout(proxyChangesNeedRestartGridLayout);
		proxyChangesNeedRestartComposite.setLayoutData(new GridData(SWT.LEFT, SWT.BOTTOM, false, true, 4, 1));
		
		Label proxyChangesNeedRestartNoteLabel = new Label(proxyChangesNeedRestartComposite, SWT.NONE);
		proxyChangesNeedRestartNoteLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyChangesNeedRestartNote"));
		
		Label proxyChangesNeedRestartTextLabel = new Label(proxyChangesNeedRestartComposite, SWT.NONE);
		proxyChangesNeedRestartTextLabel.setText(I18n.getText("org.syncany.gui.preferences.NetworkPanel.proxyChangesNeedRestartText"));
		
		WidgetDecorator.bold(proxyChangesNeedRestartNoteLabel);
		WidgetDecorator.normal(proxyChangesNeedRestartTextLabel);
	}

	private void proxyServerPortTextVerify(VerifyEvent e) {
		Text text = (Text) e.getSource();

        // Get old text and create new text by using the VerifyEvent.text
        final String oldValue = text.getText();
        String newValue = oldValue.substring(0, e.start) + e.text + oldValue.substring(e.end);
        
        // Validate correct type
        if (newValue.isEmpty()) {
        	e.doit = true;
        }
        else {
            try {
            	int newPort = Integer.parseInt(newValue);	            	
            	e.doit = newPort > 0 && newPort <= 65535; 
            }
            catch (NumberFormatException ex) {
            	e.doit = false;
            }
        }
    }

	private void updateControls() {
		proxyChangesNeedRestartComposite.setVisible(true);
		
		if (noProxyButton.getSelection()) {
			 toggleManualControls(false);
		}
		else if (useSystemProxyButton.getSelection()) {
			 toggleManualControls(false);			
		}
		else {
			 toggleManualControls(true);			
		}
	}
	
	private void loadConfig() {
		try {
			userConfig = UserConfigTO.load(UserConfig.getUserConfigFile());
			
			String useSystemProxiesProperty = userConfig.getSystemProperties().get("java.net.useSystemProxies");
			String httpProxyHostProperty = userConfig.getSystemProperties().get("http.proxyHost");
			String socksProxyHostProperty = userConfig.getSystemProperties().get("socksProxyHost");
						
			if (useSystemProxiesProperty != null) {
				loadUseSystemProxySettings();
			}
			else if (httpProxyHostProperty != null) {
				loadHttpProxySettings();
			}
			else if (socksProxyHostProperty != null) {
				loadSocksProxySettings();
			}
			else {
				loadNoProxySettings();
			}			
		}
		catch (ConfigException e) {
			disableAllControls();
		}
	}

	private void loadNoProxySettings() {
		noProxyButton.setSelection(true);
		toggleManualControls(false);
	}

	private void loadUseSystemProxySettings() {
		useSystemProxyButton.setSelection(true);
		toggleManualControls(false);
	}

	private void loadSocksProxySettings() {
		String socksProxyHostProperty = userConfig.getSystemProperties().get("socksProxyHost");
		String socksProxyPortProperty = userConfig.getSystemProperties().get("socksProxyPort");
		String socksProxyUserProperty = userConfig.getSystemProperties().get("java.net.socks.username");
		String socksProxyPassProperty = userConfig.getSystemProperties().get("java.net.socks.password");

		manualProxyButton.setSelection(true);
		proxyTypeCombo.select(1);
		
		loadProxySettings(socksProxyHostProperty, socksProxyPortProperty, socksProxyUserProperty, socksProxyPassProperty);		
		toggleManualControls(true);
	}

	private void loadHttpProxySettings() {
		String httpProxyHostProperty = userConfig.getSystemProperties().get("http.proxyHost");
		String httpProxyPortProperty = userConfig.getSystemProperties().get("http.proxyPort");
		String httpProxyUserProperty = userConfig.getSystemProperties().get("http.proxyUser");
		String httpProxyPassProperty = userConfig.getSystemProperties().get("http.proxyPass");

		manualProxyButton.setSelection(true);
		proxyTypeCombo.select(0);
		
		loadProxySettings(httpProxyHostProperty, httpProxyPortProperty, httpProxyUserProperty, httpProxyPassProperty);		
		toggleManualControls(true);
	}

	private void loadProxySettings(String proxyHost, String proxyPort, String proxyUser, String proxyPass) {		
		if (proxyHost != null) {
			proxyServerHostText.setText(proxyHost);
		}
		
		if (proxyPort != null) {
			proxyServerPortText.setText(proxyPort);
		}
		
		if (proxyUser != null) {
			proxyNeedsAuthCheckButton.setSelection(true);
			proxyAuthUserText.setText(proxyUser);
		}
		
		if (proxyPass != null) {
			proxyAuthPassText.setText(proxyPass);
		}
	}

	private void disableAllControls() {
		noProxyButton.setEnabled(false);
		useSystemProxyButton.setEnabled(false);
		manualProxyButton.setEnabled(false);
		
		toggleManualControls(false);
	}

	private void toggleManualControls(boolean enable) {
		proxyTypeCombo.setEnabled(enable);
		proxyServerHostText.setEnabled(enable);
		proxyServerPortText.setEnabled(enable);
		proxyNeedsAuthCheckButton.setEnabled(enable);
		
		if (enable) {
			boolean needsAuth = proxyNeedsAuthCheckButton.getSelection();
			
			proxyAuthUserLabel.setEnabled(needsAuth);
			proxyAuthUserText.setEnabled(needsAuth);
			proxyAuthPassLabel.setEnabled(needsAuth);
			proxyAuthPassText.setEnabled(needsAuth);
		}
		else {
			proxyAuthUserLabel.setEnabled(false);
			proxyAuthUserText.setEnabled(false);
			proxyAuthPassLabel.setEnabled(false);
			proxyAuthPassText.setEnabled(false);			
		}
	}
	
	private void saveConfig() {
		clearUserConfigProxySettings();
		
		if (noProxyButton.getSelection()) {
			// Nothing!
		}
		else if (useSystemProxyButton.getSelection()) {
			userConfig.getSystemProperties().put("java.net.useSystemProxies", "true");
		}
		else {
			boolean isHttpProxy = proxyTypeCombo.getSelectionIndex() == 0;
		
			if (isHttpProxy) {
				userConfig.getSystemProperties().put("http.proxyHost", proxyServerHostText.getText());
				userConfig.getSystemProperties().put("http.proxyPort", proxyServerPortText.getText());
				userConfig.getSystemProperties().put("https.proxyHost", proxyServerHostText.getText());
				userConfig.getSystemProperties().put("https.proxyPort", proxyServerPortText.getText());

				if (proxyNeedsAuthCheckButton.getSelection()) {
					userConfig.getSystemProperties().put("http.proxyUser", proxyAuthUserText.getText());
					userConfig.getSystemProperties().put("http.proxyPass", proxyAuthPassText.getText());
					userConfig.getSystemProperties().put("https.proxyUser", proxyAuthUserText.getText());
					userConfig.getSystemProperties().put("https.proxyPass", proxyAuthPassText.getText());
				}
			}
			else {
				userConfig.getSystemProperties().put("socksProxyHost", proxyServerHostText.getText());
				userConfig.getSystemProperties().put("socksProxyPort", proxyServerPortText.getText());

				if (proxyNeedsAuthCheckButton.getSelection()) {
					userConfig.getSystemProperties().put("java.net.socks.username", proxyAuthUserText.getText());
					userConfig.getSystemProperties().put("java.net.socks.password", proxyAuthPassText.getText());
				}
			}
		}
		
		try {
			userConfig.save(UserConfig.getUserConfigFile());
		}
		catch (ConfigException e) {
			logger.log(Level.WARNING, "Unable to save GUI config.", e);
		}
	}

	private void clearUserConfigProxySettings() {
		userConfig.getSystemProperties().remove("java.net.useSystemProxies");

		userConfig.getSystemProperties().remove("http.proxyHost");
		userConfig.getSystemProperties().remove("http.proxyPort");
		userConfig.getSystemProperties().remove("http.proxyUser");
		userConfig.getSystemProperties().remove("http.proxyPass");
		userConfig.getSystemProperties().remove("https.proxyHost");
		userConfig.getSystemProperties().remove("https.proxyPort");
		userConfig.getSystemProperties().remove("https.proxyUser");
		userConfig.getSystemProperties().remove("https.proxyPass");
		
		userConfig.getSystemProperties().remove("socksProxyHost");
		userConfig.getSystemProperties().remove("socksProxyPort");
		userConfig.getSystemProperties().remove("java.net.socks.username");
		userConfig.getSystemProperties().remove("java.net.socks.password");		
	}

	@Override
	public boolean validatePanel() {
		return true;
	}
}