| /******************************************************************************* |
| * Copyright (c) 2000, 2004 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.team.internal.ccvs.ui.operations; |
| |
| import java.lang.reflect.InvocationTargetException; |
| import java.net.MalformedURLException; |
| import java.net.URL; |
| import java.util.*; |
| |
| import org.eclipse.core.runtime.*; |
| import org.eclipse.jface.action.Action; |
| import org.eclipse.jface.action.IAction; |
| import org.eclipse.jface.dialogs.IDialogConstants; |
| import org.eclipse.jface.dialogs.MessageDialog; |
| import org.eclipse.osgi.util.NLS; |
| import org.eclipse.swt.widgets.Shell; |
| import org.eclipse.team.internal.ccvs.core.CVSException; |
| import org.eclipse.team.internal.ccvs.core.CVSStatus; |
| import org.eclipse.team.internal.ccvs.core.util.Assert; |
| import org.eclipse.team.internal.ccvs.ui.*; |
| import org.eclipse.team.internal.ccvs.ui.CVSUIPlugin; |
| import org.eclipse.team.internal.ccvs.ui.Policy; |
| import org.eclipse.team.internal.ccvs.ui.console.CVSOutputConsole; |
| import org.eclipse.team.ui.TeamOperation; |
| import org.eclipse.ui.IWorkbenchPart; |
| |
| |
| /** |
| * This class is the abstract superclass for CVS operations. It provides |
| * error handling, prompting and other UI. |
| */ |
| public abstract class CVSOperation extends TeamOperation { |
| |
| private int statusCount; |
| |
| private boolean involvesMultipleResources = false; |
| |
| private List errors = new ArrayList(); // of IStatus |
| |
| protected static final IStatus OK = Status.OK_STATUS; //$NON-NLS-1$ |
| |
| private Shell shell; |
| |
| // instance variable used to indicate behavior while prompting for overwrite |
| private boolean confirmOverwrite = true; |
| |
| protected CVSOperation(IWorkbenchPart part) { |
| super(part); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.team.internal.ui.actions.TeamOperation#getJobName() |
| */ |
| protected String getJobName() { |
| return getTaskName(); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.team.ui.TeamOperation#getOperationIcon() |
| */ |
| protected URL getOperationIcon() { |
| try { |
| URL baseURL = CVSUIPlugin.getPlugin().getBundle().getEntry("/"); //$NON-NLS-1$ |
| return new URL(baseURL, ICVSUIConstants.ICON_PATH + ICVSUIConstants.IMG_CVS_PERSPECTIVE); |
| } catch (MalformedURLException e) { |
| return null; |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.jface.operation.IRunnableWithProgress#run(org.eclipse.core.runtime.IProgressMonitor) |
| */ |
| public final void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException { |
| startOperation(); |
| try { |
| monitor = Policy.monitorFor(monitor); |
| monitor.beginTask(null, 100); |
| monitor.setTaskName(getTaskName()); |
| execute(Policy.subMonitorFor(monitor, 100)); |
| endOperation(); |
| } catch (CVSException e) { |
| // TODO: errors may not be empty (i.e. endOperation has not been executed) |
| throw new InvocationTargetException(e); |
| } finally { |
| monitor.done(); |
| } |
| } |
| |
| protected void startOperation() { |
| statusCount = 0; |
| resetErrors(); |
| confirmOverwrite = true; |
| } |
| |
| protected void endOperation() throws CVSException { |
| handleErrors((IStatus[]) errors.toArray(new IStatus[errors.size()])); |
| } |
| |
| /** |
| * Subclasses must override this method to perform the operation. |
| * Clients should never call this method directly. |
| * |
| * @param monitor |
| * @throws CVSException |
| * @throws InterruptedException |
| */ |
| protected abstract void execute(IProgressMonitor monitor) throws CVSException, InterruptedException; |
| |
| protected void addError(IStatus status) { |
| if (status.isOK()) return; |
| if (isLastError(status)) return; |
| errors.add(status); |
| } |
| |
| protected void collectStatus(IStatus status) { |
| if (isLastError(status)) return; |
| statusCount++; |
| if (!status.isOK()) addError(status); |
| } |
| |
| protected void resetErrors() { |
| errors.clear(); |
| statusCount = 0; |
| } |
| |
| protected IStatus[] getErrors() { |
| return (IStatus[]) errors.toArray(new IStatus[errors.size()]); |
| } |
| |
| /** |
| * Get the last error taht occured. This can be useful when a method |
| * has a return type but wants to signal an error. The method in question |
| * can add the error using <code>addError(IStatus)</code> and return null. |
| * The caller can then query the error using this method. Also, <code>addError(IStatus)</code> |
| * will not add the error if it is already on the end of the list (using identity comparison) |
| * which allows the caller to still perform a <code>collectStatus(IStatus)</code> |
| * to get a valid operation count. |
| * @return |
| */ |
| protected IStatus getLastError() { |
| Assert.isTrue(errors.size() > 0); |
| IStatus status = (IStatus)errors.get(errors.size() - 1); |
| return status; |
| } |
| |
| private boolean isLastError(IStatus status) { |
| return (errors.size() > 0 && getLastError() == status); |
| } |
| |
| /** |
| * Throw an exception that contains the given error status |
| * @param errors the errors that occurred during the operation |
| * @throws CVSException an exception that wraps the errors |
| */ |
| protected void asException(IStatus[] errors) throws CVSException { |
| if (errors.length == 0) return; |
| if (errors.length == 1 && statusCount == 1) { |
| throw new CVSException(errors[0]); |
| } |
| MultiStatus result = new MultiStatus(CVSUIPlugin.ID, 0, getErrorMessage(errors, statusCount), null); |
| for (int i = 0; i < errors.length; i++) { |
| IStatus s = errors[i]; |
| if (s.isMultiStatus()) { |
| result.add(new CVSStatus(s.getSeverity(), s.getMessage(), s.getException())); |
| result.addAll(s); |
| } else { |
| result.add(s); |
| } |
| } |
| throw new CVSException(result); |
| } |
| |
| /** |
| * Handle the errors that occured during an operation. |
| * The default is to throw an exception containing an status |
| * that are reportable (determined using <code>isReportableError</code>). |
| * @param errors the errors that occurred during the operation. |
| * Subclasses may override. |
| * @throws CVSException an exception if appropriate |
| */ |
| protected final void handleErrors(IStatus[] errors) throws CVSException { |
| // We are only concerned with reportable errors. |
| // Others will appear in the console |
| List reportableErrors = new ArrayList(); |
| for (int i = 0; i < errors.length; i++) { |
| IStatus status = errors[i]; |
| if (isReportableError(status)) { |
| reportableErrors.add(status); |
| } else if (status.isMultiStatus()) { |
| IStatus[] children = status.getChildren(); |
| for (int j = 0; j < children.length; j++) { |
| IStatus child = children[j]; |
| if (isReportableError(child)) { |
| reportableErrors.add(status); |
| break; |
| } |
| } |
| } |
| } |
| if (!reportableErrors.isEmpty()) |
| asException((IStatus[]) reportableErrors.toArray(new IStatus[reportableErrors.size()])); |
| } |
| |
| /** |
| * Return whether the given status is reportable. By default, |
| * only server errors are reportable. Subclasses may override. |
| * @param status an error status |
| * @return whether the status is reportable or should be ignored |
| */ |
| protected boolean isReportableError(IStatus status) { |
| return status.getCode() == CVSStatus.SERVER_ERROR || CVSStatus.isInternalError(status); |
| } |
| |
| protected String getErrorMessage(IStatus[] failures, int totalOperations) { |
| return NLS.bind(CVSUIMessages.CVSOperation_0, new String[] { String.valueOf(failures.length), String.valueOf(totalOperations) }); //$NON-NLS-1$ |
| } |
| |
| /** |
| * This method prompts the user to overwrite an existing resource. It uses the |
| * <code>involvesMultipleResources</code> to determine what buttons to show. |
| * @param project |
| * @return |
| */ |
| protected boolean promptToOverwrite(final String title, final String msg) { |
| if (!confirmOverwrite) { |
| return true; |
| } |
| final String buttons[]; |
| if (involvesMultipleResources()) { |
| buttons = new String[] { |
| IDialogConstants.YES_LABEL, |
| IDialogConstants.YES_TO_ALL_LABEL, |
| IDialogConstants.NO_LABEL, |
| IDialogConstants.CANCEL_LABEL}; |
| } else { |
| buttons = new String[] {IDialogConstants.OK_LABEL, IDialogConstants.CANCEL_LABEL}; |
| } |
| final Shell displayShell = getShell(); |
| if (displayShell == null) { |
| // We couldn't get a shell (perhaps due to shutdown) |
| return false; |
| } |
| |
| // run in syncExec because callback is from an operation, |
| // which is probably not running in the UI thread. |
| final int[] code = new int[] {0}; |
| displayShell.getDisplay().syncExec( |
| new Runnable() { |
| public void run() { |
| MessageDialog dialog = |
| new MessageDialog(displayShell, title, null, msg, MessageDialog.QUESTION, buttons, 0); |
| dialog.open(); |
| code[0] = dialog.getReturnCode(); |
| } |
| }); |
| if (involvesMultipleResources()) { |
| switch (code[0]) { |
| case 0://Yes |
| return true; |
| case 1://Yes to all |
| confirmOverwrite = false; |
| return true; |
| case 2://No |
| return false; |
| case 3://Cancel |
| default: |
| throw new OperationCanceledException(); |
| } |
| } else { |
| return code[0] == 0; |
| } |
| } |
| |
| /** |
| * This method is used by <code>promptToOverwrite</code> to determine which |
| * buttons to show in the prompter. |
| * |
| * @return |
| */ |
| protected boolean involvesMultipleResources() { |
| return involvesMultipleResources; |
| } |
| |
| public void setInvolvesMultipleResources(boolean b) { |
| involvesMultipleResources = b; |
| } |
| |
| /** |
| * Return the string that is to be used as the task name for the operation |
| * |
| * @param remoteFolders |
| * @return |
| */ |
| protected abstract String getTaskName(); |
| |
| /** |
| * Return true if any of the accumulated status have a severity of ERROR |
| * @return |
| */ |
| protected boolean errorsOccurred() { |
| for (Iterator iter = errors.iterator(); iter.hasNext();) { |
| IStatus status = (IStatus) iter.next(); |
| if (isReportableError(status)) return true; |
| if (status.isMultiStatus()) { |
| IStatus[] children = status.getChildren(); |
| for (int j = 0; j < children.length; j++) { |
| IStatus child = children[j]; |
| if (isReportableError(child)) { |
| return true; |
| } |
| } |
| } |
| } |
| return false; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.team.internal.ui.actions.TeamOperation#getShell() |
| */ |
| protected Shell getShell() { |
| // Use the shell assigned to the operation if possible |
| if (shell != null && !shell.isDisposed()) { |
| return shell; |
| } |
| return super.getShell(); |
| } |
| |
| /** |
| * Set the shell to be used by the operation. This only needs |
| * to be done if the operation does not have a workbench part. |
| * For example, if the operation is being run in a wizard. |
| * @param shell The shell to set. |
| */ |
| public void setShell(Shell shell) { |
| this.shell = shell; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.team.ui.TeamOperation#canRunAsJob() |
| */ |
| protected boolean canRunAsJob() { |
| // Put CVS jobs in the background by default. |
| return true; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.team.ui.TeamOperation#isSameFamilyAs(org.eclipse.team.ui.TeamOperation) |
| */ |
| protected boolean isSameFamilyAs(TeamOperation operation) { |
| // Trat all CVS operations as a single family |
| return operation instanceof CVSOperation; |
| } |
| |
| /* |
| * Action to show the console that can be used by subclasses |
| * that wish to link the progress service to the console |
| */ |
| protected IAction getShowConsoleAction() { |
| // Show the console as the goto action |
| return new Action(CVSUIMessages.CVSOperation_1) { //$NON-NLS-1$ |
| public void run() { |
| CVSOutputConsole console = CVSUIPlugin.getPlugin().getConsole(); |
| if (console != null) |
| console.show(true); |
| } |
| public String getToolTipText() { |
| return CVSUIMessages.CVSOperation_2; //$NON-NLS-1$ |
| } |
| }; |
| } |
| } |