IRCConnectWizardPage.java

/****************************************************************************
 * Copyright (c) 2007 Remy Suen, Composent Inc., and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Remy Suen <remy.suen@gmail.com> - initial API and implementation
 *    Abner Ballardo <modlost@modlost.net> - bug 193136
 *****************************************************************************/
package org.eclipse.ecf.internal.irc.ui.wizards;

import java.util.*;
import java.util.List;
import org.eclipse.ecf.internal.irc.ui.Activator;
import org.eclipse.ecf.internal.irc.ui.Messages;
import org.eclipse.ecf.ui.SharedImages;
import org.eclipse.ecf.ui.util.PasswordCacheHelper;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.wizard.WizardPage;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.*;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.*;

final class IRCConnectWizardPage extends WizardPage {

	private Combo connectText;

	private Text passwordText;

	private String authorityAndPath;

	private Combo connectTimeOut;

	private String[] connectTimeOutValues = { "10", "20", "30", "40", "50",
			"60" };

	IRCConnectWizardPage() {
		super("IRCConnectWizardPage"); //$NON-NLS-1$
		setTitle(Messages.IRCConnectWizardPage_WIZARD_PAGE_TITLE);
		setDescription(Messages.IRCConnectWizardPage_WIZARD_PAGE_DESCRIPTION);
		setPageComplete(false);
		setImageDescriptor(SharedImages
				.getImageDescriptor(SharedImages.IMG_CHAT_WIZARD));
	}

	IRCConnectWizardPage(String authorityAndPath) {
		this();
		this.authorityAndPath = authorityAndPath;
	}

	private void verify() {
		String text = connectText.getText();
		if (text.equals("")) { //$NON-NLS-1$
			updateStatus(Messages.IRCConnectWizardPage_STATUS_MESSAGE_EMPTY);
		} else if (text.indexOf('@') == -1) {
			updateStatus(Messages.IRCConnectWizardPage_STATUS_MESSAGE_MALFORMED);
		} else {
			updateStatus(null);
			restorePassword(text);
		}
	}

	protected String getPasswordKeyFromUserName(String username) {
		if (username == null || username.equals(""))
			return null;
		else {
			int slashIndex = username.indexOf("/");
			if (slashIndex == -1)
				return username;
			else
				return username.substring(0, username.indexOf("/"));
		}
	}

	protected void restorePassword(String username) {
		PasswordCacheHelper pwStorage = new PasswordCacheHelper(
				getPasswordKeyFromUserName(username));
		String pw = pwStorage.retrievePassword();
		if (pw != null) {
			passwordText.setText(pw);
		}
	}

	public void createControl(Composite parent) {

		parent = new Composite(parent, SWT.NONE);

		parent.setLayout(new GridLayout());
		GridData fillData = new GridData(SWT.FILL, SWT.CENTER, true, false);
		GridData endData = new GridData(SWT.FILL, SWT.CENTER, true, false, 2, 1);

		Label label = new Label(parent, SWT.LEFT);
		label.setText(Messages.IRCConnectWizardPage_CONNECTID_LABEL);

		connectText = new Combo(parent, SWT.SINGLE | SWT.BORDER | SWT.DROP_DOWN);
		connectText.setLayoutData(fillData);
		connectText.addModifyListener(new ModifyListener() {
			public void modifyText(ModifyEvent e) {
				verify();
			}
		});
		connectText.addSelectionListener(new SelectionListener() {
			public void widgetDefaultSelected(SelectionEvent e) {
				verify();
			}

			public void widgetSelected(SelectionEvent e) {
				passwordText.setText("");
				verify();
			}
		});
		connectText.setText(NLS.bind(
				Messages.IRCConnectWizardPage_CONNECTID_DEFAULT,
				getRandomNumber()));

		label = new Label(parent, SWT.RIGHT);
		label.setText(Messages.IRCConnectWizardPage_CONNECTID_EXAMPLE);
		label.setLayoutData(endData);

		label = new Label(parent, SWT.LEFT);
		label.setText(Messages.IRCConnectWizardPage_PASSWORD_LABEL);
		passwordText = new Text(parent, SWT.SINGLE | SWT.PASSWORD | SWT.BORDER);
		passwordText.setLayoutData(fillData);
		label = new Label(parent, SWT.RIGHT);
		label.setText(Messages.IRCConnectWizardPage_PASSWORD_INFO);
		label.setLayoutData(endData);
		restoreCombo();

		if (authorityAndPath != null) {
			connectText.setText(authorityAndPath);
			restorePassword(authorityAndPath);
			passwordText.setFocus();
		}
		label.setLayoutData(endData);

		// New Connect Timeout: Fixed bug 327032.
		label = new Label(parent, SWT.LEFT);
		label.setText(Messages.IRCConnectWizardPage_CONNECT_TIMEOUT);
		connectTimeOut = new Combo(parent, SWT.SINGLE | SWT.BORDER
				| SWT.DROP_DOWN);
		connectTimeOut.setLayoutData(fillData);
		connectTimeOut.setItems(connectTimeOutValues);
		connectTimeOut.select(connectTimeOutValues.length - 1);
		connectText.addListener(SWT.Selection, new Listener() {

			public void handleEvent(Event arg0) {
				System.setProperty(
						"org.eclipse.ecf.provider.irc.connectTimeout",
						connectTimeOut.getText());

			}
		});

		label = new Label(parent, SWT.RIGHT);
		label.setText(Messages.IRCConnectWizardPage_CONNECT_TIMEOUT_INFO);
		label.setLayoutData(endData);

		org.eclipse.jface.dialogs.Dialog.applyDialogFont(parent);
		setControl(parent);
	}

	private String getRandomNumber() {
		Random random = new Random();
		return String.valueOf(random.nextInt(100000));
	}

	String getConnectID() {
		return connectText.getText();
	}

	String getPassword() {
		return passwordText.getText();
	}

	int getConnectTimeOut() {
		return Integer.parseInt(connectTimeOut.getText());
	}

	private void updateStatus(String message) {
		setErrorMessage(message);
		setPageComplete(message == null);
	}

	private static final String PAGE_SETTINGS = IRCConnectWizardPage.class
			.getName();
	private static final int MAX_COMBO_VALUES = 40;
	private static final String COMBO_TEXT_KEY = "connectTextValue"; //$NON-NLS-1$
	private static final String COMBO_BOX_ITEMS_KEY = "comboValues"; //$NON-NLS-1$

	protected void saveComboText() {
		IDialogSettings pageSettings = getPageSettings();
		if (pageSettings != null)
			pageSettings.put(COMBO_TEXT_KEY, connectText.getText());
	}

	protected void saveComboItems() {
		IDialogSettings pageSettings = getPageSettings();
		if (pageSettings != null) {
			String connectTextValue = connectText.getText();
			List rawItems = Arrays.asList(connectText.getItems());
			// If existing text item is not in combo box then add it
			List items = new ArrayList();
			if (!rawItems.contains(connectTextValue))
				items.add(connectTextValue);
			items.addAll(rawItems);
			int itemsToSaveLength = items.size();
			if (itemsToSaveLength > MAX_COMBO_VALUES)
				itemsToSaveLength = MAX_COMBO_VALUES;
			String[] itemsToSave = new String[itemsToSaveLength];
			System.arraycopy(items.toArray(new String[] {}), 0, itemsToSave, 0,
					itemsToSaveLength);
			pageSettings.put(COMBO_BOX_ITEMS_KEY, itemsToSave);
		}
	}

	public IDialogSettings getDialogSettings() {
		return Activator.getDefault().getDialogSettings();
	}

	private IDialogSettings getPageSettings() {
		IDialogSettings pageSettings = null;
		IDialogSettings dialogSettings = this.getDialogSettings();
		if (dialogSettings != null) {
			pageSettings = dialogSettings.getSection(PAGE_SETTINGS);
			if (pageSettings == null)
				pageSettings = dialogSettings.addNewSection(PAGE_SETTINGS);
			return pageSettings;
		}
		return null;
	}

	protected void restoreCombo() {
		IDialogSettings pageSettings = getPageSettings();
		if (pageSettings != null) {
			String[] items = pageSettings.getArray(COMBO_BOX_ITEMS_KEY);
			if (items != null)
				connectText.setItems(items);
			String text = pageSettings.get(COMBO_TEXT_KEY);
			if (text != null)
				connectText.setText(text);
		}
	}

}