bundles/org.eclipse.equinox.p2.ui/src/org/eclipse/equinox/internal/provisional/p2/ui/dialogs/AddRepositoryDialog.java - equinox/rt.equinox.p2 - Git at Google

 /*******************************************************************************
  * Copyright (c) 2007, 2008 IBM Corporation 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:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/
 package org.eclipse.equinox.internal.provisional.p2.ui.dialogs;

 import java.net.MalformedURLException;
 import java.net.URL;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.equinox.internal.p2.ui.ProvUIActivator;
 import org.eclipse.equinox.internal.p2.ui.ProvUIMessages;
 import org.eclipse.equinox.internal.provisional.p2.ui.IProvHelpContextIds;
 import org.eclipse.equinox.internal.provisional.p2.ui.ProvisioningOperationRunner;
 import org.eclipse.equinox.internal.provisional.p2.ui.operations.ProvisioningOperation;
 import org.eclipse.jface.dialogs.*;
 import org.eclipse.jface.dialogs.Dialog;
 import org.eclipse.swt.SWT;
 import org.eclipse.swt.custom.BusyIndicator;
 import org.eclipse.swt.dnd.*;
 import org.eclipse.swt.events.*;
 import org.eclipse.swt.layout.GridData;
 import org.eclipse.swt.layout.GridLayout;
 import org.eclipse.swt.widgets.*;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.statushandlers.StatusManager;

 /**
  * Abstract dialog class for adding repositories of different types. This class
  * assumes the user view of a repository is a name and URL (and possibly other
  * info as this class develops). Individual subclasses will dictate what kind of
  * repository and how it's created.
  *
  * @since 3.4
  *
  */
 public abstract class AddRepositoryDialog extends StatusDialog {

 	Button okButton;
 	Text url;
 	URLValidator urlValidator;
 	static final String[] ARCHIVE_EXTENSIONS = new String[] {"*.jar;*.zip"}; //$NON-NLS-1$
 	static String lastLocalLocation = null;
 	static String lastArchiveLocation = null;
 	protected int repoFlag;

 	public AddRepositoryDialog(Shell parentShell, int repoFlag) {

 		super(parentShell);
 		this.repoFlag = repoFlag;
 		urlValidator = createURLValidator();
 		setTitle(ProvUIMessages.AddRepositoryDialog_Title);
 		PlatformUI.getWorkbench().getHelpSystem().setHelp(parentShell, IProvHelpContextIds.ADD_REPOSITORY_DIALOG);
 	}

 	protected void createButtonsForButtonBar(Composite parent) {
 		okButton = createButton(parent, IDialogConstants.OK_ID, IDialogConstants.OK_LABEL, true);
 		createButton(parent, IDialogConstants.CANCEL_ID, IDialogConstants.CANCEL_LABEL, false);
 	}

 	protected Control createDialogArea(Composite parent) {
 		Composite comp = new Composite(parent, SWT.NONE);
 		initializeDialogUnits(comp);
 		GridLayout layout = new GridLayout();
 		layout.numColumns = 3;
 		comp.setLayout(layout);
 		GridData data = new GridData();
 		comp.setLayoutData(data);

 		Label urlLabel = new Label(comp, SWT.NONE);
 		urlLabel.setText(ProvUIMessages.RepositoryPropertyPage_URLFieldLabel);
 		url = new Text(comp, SWT.BORDER);
 		data = new GridData(GridData.FILL_HORIZONTAL);
 		data.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.ENTRY_FIELD_WIDTH);
 		url.setLayoutData(data);
 		DropTarget target = new DropTarget(url, DND.DROP_MOVE | DND.DROP_COPY | DND.DROP_LINK);
 		target.setTransfer(new Transfer[] {URLTransfer.getInstance(), FileTransfer.getInstance()});
 		target.addDropListener(new TextURLDropAdapter(url, true));
 		url.addModifyListener(new ModifyListener() {
 			public void modifyText(ModifyEvent e) {
 				validateRepositoryURL(false);
 			}
 		});
 		url.setText("http://"); //$NON-NLS-1$
 		url.setSelection(0, url.getText().length());

 		// add vertical buttons for setting archive or local repos
 		Composite buttonParent = new Composite(comp, SWT.NONE);
 		layout = new GridLayout();
 		layout.numColumns = 1;
 		layout.marginWidth = 5;
 		layout.marginHeight = 0;
 		layout.horizontalSpacing = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_SPACING);
 		layout.verticalSpacing = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_SPACING);
 		buttonParent.setLayout(layout);
 		Button locationButton = new Button(buttonParent, SWT.PUSH);
 		locationButton.setText(ProvUIMessages.RepositoryGroup_LocalRepoBrowseButton);
 		locationButton.addSelectionListener(new SelectionAdapter() {
 			public void widgetSelected(SelectionEvent event) {
 				DirectoryDialog dialog = new DirectoryDialog(getShell(), SWT.APPLICATION_MODAL);
 				dialog.setMessage(ProvUIMessages.RepositoryGroup_SelectRepositoryDirectory);
 				dialog.setFilterPath(lastLocalLocation);
 				String path = dialog.open();
 				if (path != null) {
 					lastLocalLocation = path;
 					url.setText(URLValidator.makeFileURLString(path));
 					validateRepositoryURL(false);
 				}
 			}
 		});
 		setButtonLayoutData(locationButton);
 		locationButton = new Button(buttonParent, SWT.PUSH);
 		locationButton.setText(ProvUIMessages.RepositoryGroup_ArchivedRepoBrowseButton);
 		locationButton.addSelectionListener(new SelectionAdapter() {
 			public void widgetSelected(SelectionEvent event) {
 				FileDialog dialog = new FileDialog(getShell(), SWT.APPLICATION_MODAL);
 				dialog.setText(ProvUIMessages.RepositoryGroup_RepositoryFile);
 				dialog.setFilterExtensions(ARCHIVE_EXTENSIONS);
 				dialog.setFileName(lastArchiveLocation);
 				String path = dialog.open();
 				if (path != null) {
 					lastArchiveLocation = path;
 					url.setText(URLValidator.makeJarURLString(path));
 					validateRepositoryURL(false);
 				}
 			}
 		});
 		setButtonLayoutData(locationButton);
 		Dialog.applyDialogFont(comp);
 		return comp;
 	}

 	protected URLValidator createURLValidator() {
 		DefaultMetadataURLValidator validator = new DefaultMetadataURLValidator();
 		validator.setKnownRepositoriesFlag(repoFlag);
 		return validator;
 	}

 	protected URLValidator getURLValidator() {
 		return urlValidator;
 	}

 	protected void okPressed() {
 		IStatus status = addRepository();
 		if (status.isOK())
 			super.okPressed();

 	}

 	/**
 	 * Get the URL as currently typed in by the user.  Return null if there
 	 * is a problem with the URL.
 	 *
 	 * @return the URL currently typed in by the user.
 	 */
 	protected URL getUserURL() {
 		URL userURL;
 		try {
 			userURL = new URL(url.getText().trim());
 		} catch (MalformedURLException e) {
 			return null;
 		}
 		return userURL;
 	}

 	protected IStatus addRepository() {
 		IStatus status = validateRepositoryURL(false);
 		if (status.isOK()) {
 			ProvisioningOperationRunner.schedule(getOperation(getUserURL()), getShell(), StatusManager.SHOW | StatusManager.LOG);
 		}
 		return status;
 	}

 	protected abstract ProvisioningOperation getOperation(URL repoURL);

 	/**
 	 * Validate the repository URL, returning a status that is appropriate
 	 * for showing the user.  The boolean indicates whether the repositories
 	 * should be consulted for validating the URL.  For example, it is not
 	 * appropriate to contact the repositories on every keystroke.
 	 */
 	protected IStatus validateRepositoryURL(final boolean contactRepositories) {
 		if (url == null || url.isDisposed())
 			return Status.OK_STATUS;
 		final IStatus[] status = new IStatus[1];
 		status[0] = URLValidator.getInvalidURLStatus(url.getText().trim());
 		final URL userURL = getUserURL();
 		if (url.getText().length() == 0)
 			status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, URLValidator.LOCAL_VALIDATION_ERROR, ProvUIMessages.RepositoryGroup_URLRequired, null);
 		else if (userURL == null)
 			status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, URLValidator.LOCAL_VALIDATION_ERROR, ProvUIMessages.AddRepositoryDialog_InvalidURL, null);
 		else {
 			BusyIndicator.showWhile(getShell().getDisplay(), new Runnable() {
 				public void run() {
 					status[0] = getURLValidator().validateRepositoryURL(userURL, contactRepositories, null);
 				}
 			});

 		}

 		// At this point the subclasses may have decided to opt out of
 		// this dialog.
 		if (status[0].getSeverity() == IStatus.CANCEL) {
 			cancelPressed();
 		}

 		setOkEnablement(status[0].isOK());
 		updateStatus(status[0]);
 		return status[0];

 	}

 	protected void updateButtonsEnableState(IStatus status) {
 		setOkEnablement(!status.matches(IStatus.ERROR));
 	}

 	private void setOkEnablement(boolean enable) {
 		if (okButton != null && !okButton.isDisposed())
 			okButton.setEnabled(enable);
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2007, 2008 IBM Corporation 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:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/
	package org.eclipse.equinox.internal.provisional.p2.ui.dialogs;

	import java.net.MalformedURLException;
	import java.net.URL;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.equinox.internal.p2.ui.ProvUIActivator;
	import org.eclipse.equinox.internal.p2.ui.ProvUIMessages;
	import org.eclipse.equinox.internal.provisional.p2.ui.IProvHelpContextIds;
	import org.eclipse.equinox.internal.provisional.p2.ui.ProvisioningOperationRunner;
	import org.eclipse.equinox.internal.provisional.p2.ui.operations.ProvisioningOperation;
	import org.eclipse.jface.dialogs.*;
	import org.eclipse.jface.dialogs.Dialog;
	import org.eclipse.swt.SWT;
	import org.eclipse.swt.custom.BusyIndicator;
	import org.eclipse.swt.dnd.*;
	import org.eclipse.swt.events.*;
	import org.eclipse.swt.layout.GridData;
	import org.eclipse.swt.layout.GridLayout;
	import org.eclipse.swt.widgets.*;
	import org.eclipse.ui.PlatformUI;
	import org.eclipse.ui.statushandlers.StatusManager;

	/**
	* Abstract dialog class for adding repositories of different types. This class
	* assumes the user view of a repository is a name and URL (and possibly other
	* info as this class develops). Individual subclasses will dictate what kind of
	* repository and how it's created.
	*
	* @since 3.4
	*
	*/
	public abstract class AddRepositoryDialog extends StatusDialog {

	Button okButton;
	Text url;
	URLValidator urlValidator;
	static final String[] ARCHIVE_EXTENSIONS = new String[] {".jar;.zip"}; //$NON-NLS-1$
	static String lastLocalLocation = null;
	static String lastArchiveLocation = null;
	protected int repoFlag;

	public AddRepositoryDialog(Shell parentShell, int repoFlag) {

	super(parentShell);
	this.repoFlag = repoFlag;
	urlValidator = createURLValidator();
	setTitle(ProvUIMessages.AddRepositoryDialog_Title);
	PlatformUI.getWorkbench().getHelpSystem().setHelp(parentShell, IProvHelpContextIds.ADD_REPOSITORY_DIALOG);
	}

	protected void createButtonsForButtonBar(Composite parent) {
	okButton = createButton(parent, IDialogConstants.OK_ID, IDialogConstants.OK_LABEL, true);
	createButton(parent, IDialogConstants.CANCEL_ID, IDialogConstants.CANCEL_LABEL, false);
	}

	protected Control createDialogArea(Composite parent) {
	Composite comp = new Composite(parent, SWT.NONE);
	initializeDialogUnits(comp);
	GridLayout layout = new GridLayout();
	layout.numColumns = 3;
	comp.setLayout(layout);
	GridData data = new GridData();
	comp.setLayoutData(data);

	Label urlLabel = new Label(comp, SWT.NONE);
	urlLabel.setText(ProvUIMessages.RepositoryPropertyPage_URLFieldLabel);
	url = new Text(comp, SWT.BORDER);
	data = new GridData(GridData.FILL_HORIZONTAL);
	data.widthHint = convertHorizontalDLUsToPixels(IDialogConstants.ENTRY_FIELD_WIDTH);
	url.setLayoutData(data);
	DropTarget target = new DropTarget(url, DND.DROP_MOVE \| DND.DROP_COPY \| DND.DROP_LINK);
	target.setTransfer(new Transfer[] {URLTransfer.getInstance(), FileTransfer.getInstance()});
	target.addDropListener(new TextURLDropAdapter(url, true));
	url.addModifyListener(new ModifyListener() {
	public void modifyText(ModifyEvent e) {
	validateRepositoryURL(false);
	}
	});
	url.setText("http://"); //$NON-NLS-1$
	url.setSelection(0, url.getText().length());

	// add vertical buttons for setting archive or local repos
	Composite buttonParent = new Composite(comp, SWT.NONE);
	layout = new GridLayout();
	layout.numColumns = 1;
	layout.marginWidth = 5;
	layout.marginHeight = 0;
	layout.horizontalSpacing = convertHorizontalDLUsToPixels(IDialogConstants.HORIZONTAL_SPACING);
	layout.verticalSpacing = convertVerticalDLUsToPixels(IDialogConstants.VERTICAL_SPACING);
	buttonParent.setLayout(layout);
	Button locationButton = new Button(buttonParent, SWT.PUSH);
	locationButton.setText(ProvUIMessages.RepositoryGroup_LocalRepoBrowseButton);
	locationButton.addSelectionListener(new SelectionAdapter() {
	public void widgetSelected(SelectionEvent event) {
	DirectoryDialog dialog = new DirectoryDialog(getShell(), SWT.APPLICATION_MODAL);
	dialog.setMessage(ProvUIMessages.RepositoryGroup_SelectRepositoryDirectory);
	dialog.setFilterPath(lastLocalLocation);
	String path = dialog.open();
	if (path != null) {
	lastLocalLocation = path;
	url.setText(URLValidator.makeFileURLString(path));
	validateRepositoryURL(false);
	}
	}
	});
	setButtonLayoutData(locationButton);
	locationButton = new Button(buttonParent, SWT.PUSH);
	locationButton.setText(ProvUIMessages.RepositoryGroup_ArchivedRepoBrowseButton);
	locationButton.addSelectionListener(new SelectionAdapter() {
	public void widgetSelected(SelectionEvent event) {
	FileDialog dialog = new FileDialog(getShell(), SWT.APPLICATION_MODAL);
	dialog.setText(ProvUIMessages.RepositoryGroup_RepositoryFile);
	dialog.setFilterExtensions(ARCHIVE_EXTENSIONS);
	dialog.setFileName(lastArchiveLocation);
	String path = dialog.open();
	if (path != null) {
	lastArchiveLocation = path;
	url.setText(URLValidator.makeJarURLString(path));
	validateRepositoryURL(false);
	}
	}
	});
	setButtonLayoutData(locationButton);
	Dialog.applyDialogFont(comp);
	return comp;
	}

	protected URLValidator createURLValidator() {
	DefaultMetadataURLValidator validator = new DefaultMetadataURLValidator();
	validator.setKnownRepositoriesFlag(repoFlag);
	return validator;
	}

	protected URLValidator getURLValidator() {
	return urlValidator;
	}

	protected void okPressed() {
	IStatus status = addRepository();
	if (status.isOK())
	super.okPressed();

	}

	/**
	* Get the URL as currently typed in by the user. Return null if there
	* is a problem with the URL.
	*
	* @return the URL currently typed in by the user.
	*/
	protected URL getUserURL() {
	URL userURL;
	try {
	userURL = new URL(url.getText().trim());
	} catch (MalformedURLException e) {
	return null;
	}
	return userURL;
	}

	protected IStatus addRepository() {
	IStatus status = validateRepositoryURL(false);
	if (status.isOK()) {
	ProvisioningOperationRunner.schedule(getOperation(getUserURL()), getShell(), StatusManager.SHOW \| StatusManager.LOG);
	}
	return status;
	}

	protected abstract ProvisioningOperation getOperation(URL repoURL);

	/**
	* Validate the repository URL, returning a status that is appropriate
	* for showing the user. The boolean indicates whether the repositories
	* should be consulted for validating the URL. For example, it is not
	* appropriate to contact the repositories on every keystroke.
	*/
	protected IStatus validateRepositoryURL(final boolean contactRepositories) {
	if (url == null \|\| url.isDisposed())
	return Status.OK_STATUS;
	final IStatus[] status = new IStatus[1];
	status[0] = URLValidator.getInvalidURLStatus(url.getText().trim());
	final URL userURL = getUserURL();
	if (url.getText().length() == 0)
	status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, URLValidator.LOCAL_VALIDATION_ERROR, ProvUIMessages.RepositoryGroup_URLRequired, null);
	else if (userURL == null)
	status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, URLValidator.LOCAL_VALIDATION_ERROR, ProvUIMessages.AddRepositoryDialog_InvalidURL, null);
	else {
	BusyIndicator.showWhile(getShell().getDisplay(), new Runnable() {
	public void run() {
	status[0] = getURLValidator().validateRepositoryURL(userURL, contactRepositories, null);
	}
	});

	}

	// At this point the subclasses may have decided to opt out of
	// this dialog.
	if (status[0].getSeverity() == IStatus.CANCEL) {
	cancelPressed();
	}

	setOkEnablement(status[0].isOK());
	updateStatus(status[0]);
	return status[0];

	}

	protected void updateButtonsEnableState(IStatus status) {
	setOkEnablement(!status.matches(IStatus.ERROR));
	}

	private void setOkEnablement(boolean enable) {
	if (okButton != null && !okButton.isDisposed())
	okButton.setEnabled(enable);
	}
	}