blob: c7502af30ab36a2c895f2e593febe183d3bc5350 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2007, 2009 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;
import java.lang.reflect.InvocationTargetException;
import java.net.URI;
import java.util.*;
import org.eclipse.core.commands.*;
import org.eclipse.core.commands.common.NotDefinedException;
import org.eclipse.core.commands.operations.*;
import org.eclipse.core.runtime.*;
import org.eclipse.equinox.internal.p2.ui.ProvUIActivator;
import org.eclipse.equinox.internal.p2.ui.ProvUIMessages;
import org.eclipse.equinox.internal.p2.ui.dialogs.RepositoryNameAndLocationDialog;
import org.eclipse.equinox.internal.provisional.p2.core.ProvisionException;
import org.eclipse.equinox.internal.provisional.p2.repository.IRepository;
import org.eclipse.equinox.internal.provisional.p2.ui.operations.ProvisioningOperation;
import org.eclipse.equinox.internal.provisional.p2.ui.operations.ProvisioningUtil;
import org.eclipse.equinox.internal.provisional.p2.ui.policy.Policy;
import org.eclipse.equinox.internal.provisional.p2.ui.policy.RepositoryManipulator;
import org.eclipse.equinox.internal.provisional.p2.ui.viewers.IUColumnConfig;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.dialogs.ProgressMonitorDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.window.Window;
import org.eclipse.osgi.util.NLS;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.*;
import org.eclipse.ui.commands.ICommandService;
import org.eclipse.ui.handlers.IHandlerService;
import org.eclipse.ui.statushandlers.StatusManager;
/**
* Generic provisioning UI utility and policy methods.
*
* @since 3.4
*/
public class ProvUI {
// Public constants for common command and tooltip names
public static final String INSTALL_COMMAND_LABEL = ProvUIMessages.InstallIUCommandLabel;
public static final String INSTALL_COMMAND_TOOLTIP = ProvUIMessages.InstallIUCommandTooltip;
public static final String UNINSTALL_COMMAND_LABEL = ProvUIMessages.UninstallIUCommandLabel;
public static final String UNINSTALL_COMMAND_TOOLTIP = ProvUIMessages.UninstallIUCommandTooltip;
public static final String UPDATE_COMMAND_LABEL = ProvUIMessages.UpdateIUCommandLabel;
public static final String UPDATE_COMMAND_TOOLTIP = ProvUIMessages.UpdateIUCommandTooltip;
public static final String REVERT_COMMAND_LABEL = ProvUIMessages.RevertIUCommandLabel;
public static final String REVERT_COMMAND_TOOLTIP = ProvUIMessages.RevertIUCommandTooltip;
static ObjectUndoContext provisioningUndoContext;
private static final int DEFAULT_COLUMN_WIDTH = 200;
private static IUColumnConfig[] iuColumnConfig = new IUColumnConfig[] {new IUColumnConfig(ProvUIMessages.ProvUI_NameColumnTitle, IUColumnConfig.COLUMN_NAME, DEFAULT_COLUMN_WIDTH), new IUColumnConfig(ProvUIMessages.ProvUI_VersionColumnTitle, IUColumnConfig.COLUMN_VERSION, DEFAULT_COLUMN_WIDTH)};
/**
* List<URI> of repositories that have already been reported to the user as not found.
*/
private static final List reposNotFound = Collections.synchronizedList(new ArrayList());
// These values rely on the command markup in org.eclipse.ui.ide that defines the update commands
private static final String UPDATE_MANAGER_FIND_AND_INSTALL = "org.eclipse.ui.update.findAndInstallUpdates"; //$NON-NLS-1$
private static final String UPDATE_MANAGER_MANAGE_CONFIGURATION = "org.eclipse.ui.update.manageConfiguration"; //$NON-NLS-1$
// This value relies on the command markup in org.eclipse.ui
private static final String INSTALLATION_DIALOG = "org.eclipse.ui.help.installationDialog"; //$NON-NLS-1$
public static IStatus handleException(Throwable t, String message, int style) {
if (message == null && t != null) {
message = t.getMessage();
}
IStatus status = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, 0, message, t);
StatusManager.getManager().handle(status, style);
return status;
}
public static void reportLoadFailure(final URI location, IStatus status, int style, final RepositoryManipulator repoManipulator) {
int code = status.getCode();
// Special handling when the location is bad (not found, etc.) vs. a failure
// associated with a known repo.
if (code == ProvisionException.REPOSITORY_NOT_FOUND || code == ProvisionException.REPOSITORY_INVALID_LOCATION) {
if (!hasNotFoundStatusBeenReported(location)) {
PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
public void run() {
IWorkbench workbench = PlatformUI.getWorkbench();
if (workbench.isClosing())
return;
Shell shell = ProvUI.getDefaultParentShell();
if (MessageDialog.openQuestion(shell, ProvUIMessages.ProvUI_LoadErrorTitle, NLS.bind(ProvUIMessages.ProvUI_PromptForSiteEdit, URIUtil.toUnencodedString(location)))) {
RepositoryNameAndLocationDialog dialog = new RepositoryNameAndLocationDialog(shell, Policy.getDefault()) {
protected String getInitialLocationText() {
return URIUtil.toUnencodedString(location);
}
protected String getInitialNameText() {
String nickname = null;
try {
nickname = ProvisioningUtil.getMetadataRepositoryProperty(location, IRepository.PROP_NICKNAME);
} catch (ProvisionException e) {
// nickname remains null
}
return nickname == null ? "" : nickname; //$NON-NLS-1$
}
};
int ret = dialog.open();
if (ret == Window.OK) {
URI correctedLocation = dialog.getLocation();
if (correctedLocation != null) {
ProvUI.startBatchOperation();
try {
RepositoryManipulator repoMan = repoManipulator;
if (repoManipulator == null)
repoMan = Policy.getDefault().getRepositoryManipulator();
ProvisioningOperation op = repoMan.getRemoveOperation(new URI[] {location});
op.execute(null);
ProvUI.endBatchOperation(false);
op = repoMan.getAddOperation(correctedLocation);
op.execute(null);
String nickname = dialog.getName();
if (nickname != null && nickname.length() > 0)
ProvisioningUtil.setMetadataRepositoryProperty(correctedLocation, IRepository.PROP_NICKNAME, nickname);
} catch (ProvisionException e) {
ProvUI.handleException(e, null, StatusManager.SHOW | StatusManager.LOG);
ProvUI.endBatchOperation(true);
}
}
}
}
}
});
reposNotFound.add(location);
}
} else {
reportStatus(status, style);
}
}
// This assumes that callers already checked whether it *should*
// be reported so that we don't need to loop through the list
// when the caller just has done so in order to know whether to report.
public static void notFoundStatusReported(URI location) {
reposNotFound.add(location);
}
// We don't check for things like case variants or end slash variants
// because we know that the repository managers already did this.
public static boolean hasNotFoundStatusBeenReported(URI location) {
return reposNotFound.contains(location);
}
public static void clearRepositoriesNotFound() {
reposNotFound.clear();
}
public static void clearRepositoryNotFound(URI location) {
reposNotFound.remove(location);
}
public static void reportStatus(IStatus status, int style) {
// workaround for
// https://bugs.eclipse.org/bugs/show_bug.cgi?id=211933
// Note we'd rather have a proper looking dialog than get the
// blocking right.
if ((style & StatusManager.BLOCK) == StatusManager.BLOCK || (style & StatusManager.SHOW) == StatusManager.SHOW) {
if (status.getSeverity() == IStatus.INFO) {
MessageDialog.openInformation(ProvUI.getDefaultParentShell(), ProvUIMessages.ProvUI_InformationTitle, status.getMessage());
// unset the dialog bits
style = style & ~StatusManager.BLOCK;
style = style & ~StatusManager.SHOW;
// unset logging for statuses that should never be logged.
// Ideally the caller would do this but this bug keeps coming back.
// see https://bugs.eclipse.org/bugs/show_bug.cgi?id=274074
if (status.getCode() == IStatusCodes.NOTHING_TO_UPDATE)
style = 0;
} else if (status.getSeverity() == IStatus.WARNING) {
MessageDialog.openWarning(ProvUI.getDefaultParentShell(), ProvUIMessages.ProvUI_WarningTitle, status.getMessage());
// unset the dialog bits
style = style & ~StatusManager.BLOCK;
style = style & ~StatusManager.SHOW;
}
}
if (style != 0)
StatusManager.getManager().handle(status, style);
}
public static IUColumnConfig[] getIUColumnConfig() {
return iuColumnConfig;
}
public static void setIUColumnConfig(IUColumnConfig[] columnConfig) {
iuColumnConfig = columnConfig;
}
public static Object getAdapter(Object object, Class adapterType) {
if (object == null)
return null;
if (adapterType.isInstance(object))
return object;
if (object instanceof IAdaptable)
return ((IAdaptable) object).getAdapter(adapterType);
return null;
}
/**
* Returns a shell that is appropriate to use as the parent
* for a modal dialog. This returns the existing modal dialog, if any,
* or a workbench window if no modal dialogs open. Returns <code>null</code>
* if there is no appropriate default parent.
*
* This method is copied from ProgressManagerUtil#getDefaultParent()
*/
public static Shell getDefaultParentShell() {
IWorkbench workbench = PlatformUI.getWorkbench();
//look first for the topmost modal shell
Shell shell = getDefaultParentShell(workbench.getDisplay().getShells());
if (shell != null) {
return shell;
}
//try the active workbench window
IWorkbenchWindow window = workbench.getActiveWorkbenchWindow();
if (window != null)
return window.getShell();
IWorkbenchWindow[] windows = PlatformUI.getWorkbench().getWorkbenchWindows();
if (windows.length > 0)
return windows[0].getShell();
//there is no modal shell and no active window, so just return a null parent shell
return null;
}
/**
* Return the modal shell that is currently open. If there isn't one then
* return null.
*
* @param shells shells to search for modal children
* @return the most specific modal child, or null if none
*
* This method is copied from ProgressManagerUtil#getDefaultParent()
*/
private static Shell getDefaultParentShell(Shell[] shells) {
//first look for a modal shell
for (int i = shells.length - 1; i >= 0; i--) {
Shell shell = shells[i];
// Check if this shell has a modal child
Shell modalChild = getDefaultParentShell(shell.getShells());
if (modalChild != null) {
return modalChild;
}
// Do not worry about shells that will not block the user.
if (shell.isVisible()) {
int modal = SWT.APPLICATION_MODAL | SWT.SYSTEM_MODAL | SWT.PRIMARY_MODAL;
if ((shell.getStyle() & modal) != 0) {
return shell;
}
}
}
return null;
}
static IOperationApprover getOperationApprover() {
return new IOperationApprover() {
public IStatus proceedUndoing(final IUndoableOperation operation, IOperationHistory history, IAdaptable info) {
final IStatus[] status = new IStatus[1];
status[0] = Status.OK_STATUS;
if (operation.hasContext(provisioningUndoContext) && operation instanceof IAdvancedUndoableOperation) {
final IRunnableWithProgress runnable = new IRunnableWithProgress() {
public void run(IProgressMonitor monitor) {
try {
status[0] = ((IAdvancedUndoableOperation) operation).computeUndoableStatus(monitor);
if (!status[0].isOK()) {
ProvUI.reportStatus(status[0], StatusManager.SHOW | StatusManager.LOG);
}
} catch (ExecutionException e) {
status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
}
}
};
PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
public void run() {
try {
new ProgressMonitorDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()).run(true, true, runnable);
} catch (InterruptedException e) {
// don't report thread interruption
} catch (InvocationTargetException e) {
status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
}
}
});
}
return status[0];
}
public IStatus proceedRedoing(final IUndoableOperation operation, IOperationHistory history, IAdaptable info) {
final IStatus[] status = new IStatus[1];
status[0] = Status.OK_STATUS;
if (operation.hasContext(provisioningUndoContext) && operation instanceof IAdvancedUndoableOperation) {
final IRunnableWithProgress runnable = new IRunnableWithProgress() {
public void run(IProgressMonitor monitor) {
try {
status[0] = ((IAdvancedUndoableOperation) operation).computeRedoableStatus(monitor);
if (!status[0].isOK()) {
ProvUI.reportStatus(status[0], StatusManager.SHOW);
}
} catch (ExecutionException e) {
status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
}
}
};
PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {
public void run() {
try {
new ProgressMonitorDialog(PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell()).run(true, true, runnable);
} catch (InterruptedException e) {
// don't report thread interruption
} catch (InvocationTargetException e) {
status[0] = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, e.getMessage(), e);
ProvUI.handleException(e.getCause(), null, StatusManager.SHOW | StatusManager.LOG);
}
}
});
}
return status[0];
}
};
}
public static void addProvisioningListener(ProvUIProvisioningListener listener) {
ProvUIActivator.getDefault().addProvisioningListener(listener);
}
public static void removeProvisioningListener(ProvUIProvisioningListener listener) {
ProvUIActivator.getDefault().removeProvisioningListener(listener);
}
public static void startBatchOperation() {
ProvUIActivator.getDefault().signalBatchOperationStart();
}
public static void endBatchOperation(boolean notify) {
ProvUIActivator.getDefault().signalBatchOperationComplete(notify);
}
public static void openUpdateManagerInstaller(Event event) {
runCommand(UPDATE_MANAGER_FIND_AND_INSTALL, ProvUIMessages.UpdateManagerCompatibility_UnableToOpenFindAndInstall, event);
}
public static void openUpdateManagerConfigurationManager(Event event) {
runCommand(UPDATE_MANAGER_MANAGE_CONFIGURATION, ProvUIMessages.UpdateManagerCompatibility_UnableToOpenManageConfiguration, event);
}
public static void openInstallationDialog(Event event) {
runCommand(INSTALLATION_DIALOG, ProvUIMessages.ProvUI_InstallDialogError, event);
}
private static void runCommand(String commandId, String errorMessage, Event event) {
ICommandService commandService = (ICommandService) PlatformUI.getWorkbench().getService(ICommandService.class);
Command command = commandService.getCommand(commandId);
if (!command.isDefined()) {
return;
}
IHandlerService handlerService = (IHandlerService) PlatformUI.getWorkbench().getService(IHandlerService.class);
try {
handlerService.executeCommand(commandId, event);
} catch (ExecutionException e) {
reportFail(errorMessage, e);
} catch (NotDefinedException e) {
reportFail(errorMessage, e);
} catch (NotEnabledException e) {
reportFail(errorMessage, e);
} catch (NotHandledException e) {
reportFail(errorMessage, e);
}
}
private static void reportFail(String message, Throwable t) {
Status failStatus = new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, message, t);
reportStatus(failStatus, StatusManager.BLOCK | StatusManager.LOG);
}
}