| /******************************************************************************* |
| * Copyright (c) 2007, 2017 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.equinox.internal.p2.engine; |
| |
| import java.util.*; |
| import org.eclipse.core.runtime.*; |
| import org.eclipse.equinox.p2.engine.*; |
| import org.eclipse.equinox.p2.engine.spi.ProvisioningAction; |
| import org.eclipse.osgi.util.NLS; |
| |
| public class PhaseSet implements IPhaseSet { |
| |
| private final Phase[] phases; |
| private boolean isRunning = false; |
| private boolean isPaused = false; |
| |
| public PhaseSet(Phase[] phases) { |
| if (phases == null) |
| throw new IllegalArgumentException(Messages.null_phases); |
| |
| this.phases = phases; |
| } |
| |
| public final MultiStatus perform(EngineSession session, Operand[] operands, IProgressMonitor monitor) { |
| MultiStatus status = new MultiStatus(EngineActivator.ID, IStatus.OK, null, null); |
| int[] weights = getProgressWeights(operands); |
| int totalWork = getTotalWork(weights); |
| SubMonitor pm = SubMonitor.convert(monitor, totalWork); |
| try { |
| isRunning = true; |
| for (int i = 0; i < phases.length; i++) { |
| if (pm.isCanceled()) { |
| status.add(Status.CANCEL_STATUS); |
| return status; |
| } |
| Phase phase = phases[i]; |
| phase.actionManager = session.getAgent().getService(ActionManager.class); |
| try { |
| phase.perform(status, session, operands, pm.newChild(weights[i])); |
| } catch (OperationCanceledException e) { |
| // propagate operation cancellation |
| status.add(new Status(IStatus.CANCEL, EngineActivator.ID, e.getMessage(), e)); |
| } catch (RuntimeException e) { |
| // "perform" calls user code and might throw an unchecked exception |
| // we catch the error here to gather information on where the problem occurred. |
| status.add(new Status(IStatus.ERROR, EngineActivator.ID, e.getMessage(), e)); |
| } catch (LinkageError e) { |
| // Catch linkage errors as these are generally recoverable but let other Errors propagate (see bug 222001) |
| status.add(new Status(IStatus.ERROR, EngineActivator.ID, e.getMessage(), e)); |
| } finally { |
| phase.actionManager = null; |
| } |
| if (status.matches(IStatus.CANCEL)) { |
| MultiStatus result = new MultiStatus(EngineActivator.ID, IStatus.CANCEL, Messages.Engine_Operation_Canceled_By_User, null); |
| result.merge(status); |
| return result; |
| } else if (status.matches(IStatus.ERROR)) { |
| MultiStatus result = new MultiStatus(EngineActivator.ID, IStatus.ERROR, phase.getProblemMessage(), null); |
| result.add(new Status(IStatus.ERROR, EngineActivator.ID, session.getContextString(), null)); |
| result.merge(status); |
| return result; |
| } |
| } |
| } finally { |
| pm.done(); |
| isRunning = false; |
| } |
| return status; |
| } |
| |
| public synchronized boolean pause() { |
| if (isRunning && !isPaused) { |
| isPaused = true; |
| for (Phase phase : phases) { |
| phase.setPaused(isPaused); |
| } |
| return true; |
| } |
| return false; |
| } |
| |
| public synchronized boolean resume() { |
| if (isRunning && isPaused) { |
| isPaused = false; |
| for (Phase phase : phases) { |
| phase.setPaused(isPaused); |
| } |
| return true; |
| } |
| return false; |
| } |
| |
| public final IStatus validate(ActionManager actionManager, IProfile profile, Operand[] operands, ProvisioningContext context, IProgressMonitor monitor) { |
| Set<MissingAction> missingActions = new HashSet<>(); |
| for (Phase phase2 : phases) { |
| Phase phase = phase2; |
| phase.actionManager = actionManager; |
| try { |
| for (Operand operand : operands) { |
| try { |
| if (!phase.isApplicable(operand)) |
| continue; |
| |
| List<ProvisioningAction> actions = phase.getActions(operand); |
| if (actions == null) |
| continue; |
| for (int k = 0; k < actions.size(); k++) { |
| ProvisioningAction action = actions.get(k); |
| if (action instanceof MissingAction) |
| missingActions.add((MissingAction) action); |
| } |
| } catch (RuntimeException e) { |
| // "perform" calls user code and might throw an unchecked exception |
| // we catch the error here to gather information on where the problem occurred. |
| return new Status(IStatus.ERROR, EngineActivator.ID, e.getMessage() + " " + getContextString(profile, phase, operand), e); //$NON-NLS-1$ |
| } catch (LinkageError e) { |
| // Catch linkage errors as these are generally recoverable but let other Errors propagate (see bug 222001) |
| return new Status(IStatus.ERROR, EngineActivator.ID, e.getMessage() + " " + getContextString(profile, phase, operand), e); //$NON-NLS-1$ |
| } |
| } |
| } finally { |
| phase.actionManager = null; |
| } |
| } |
| if (!missingActions.isEmpty()) { |
| MissingAction[] missingActionsArray = missingActions.toArray(new MissingAction[missingActions.size()]); |
| MissingActionsException exception = new MissingActionsException(missingActionsArray); |
| return (new Status(IStatus.ERROR, EngineActivator.ID, exception.getMessage(), exception)); |
| } |
| return Status.OK_STATUS; |
| } |
| |
| private String getContextString(IProfile profile, Phase phase, Operand operand) { |
| return NLS.bind(Messages.session_context, new Object[] {profile.getProfileId(), phase.getClass().getName(), operand.toString(), ""}); //$NON-NLS-1$ |
| } |
| |
| private int getTotalWork(int[] weights) { |
| int sum = 0; |
| for (int weight : weights) |
| sum += weight; |
| return sum; |
| } |
| |
| private int[] getProgressWeights(Operand[] operands) { |
| int[] weights = new int[phases.length]; |
| for (int i = 0; i < phases.length; i += 1) { |
| if (operands.length > 0) |
| //alter weights according to the number of operands applicable to that phase |
| weights[i] = (phases[i].weight * countApplicable(phases[i], operands) / operands.length); |
| else |
| weights[i] = phases[i].weight; |
| } |
| return weights; |
| } |
| |
| private int countApplicable(Phase phase, Operand[] operands) { |
| int count = 0; |
| for (Operand operand : operands) { |
| if (phase.isApplicable(operand)) |
| count++; |
| } |
| return count; |
| } |
| |
| @Override |
| public String[] getPhaseIds() { |
| String[] ids = new String[phases.length]; |
| for (int i = 0; i < ids.length; i++) { |
| ids[i] = phases[i].phaseId; |
| } |
| return ids; |
| } |
| |
| public Phase[] getPhases() { |
| return phases; |
| } |
| } |