bundles/org.eclipse.equinox.p2.ui/src/org/eclipse/equinox/internal/p2/ui/PlanStatusHelper.java

/*******************************************************************************
 * Copyright (c) 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.p2.ui;

import org.eclipse.core.runtime.*;
import org.eclipse.equinox.internal.provisional.p2.director.ProvisioningPlan;
import org.eclipse.equinox.internal.provisional.p2.engine.InstallableUnitOperand;
import org.eclipse.equinox.internal.provisional.p2.engine.Operand;
import org.eclipse.equinox.internal.provisional.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.internal.provisional.p2.ui.IStatusCodes;
import org.eclipse.equinox.internal.provisional.p2.ui.query.IUPropertyUtils;
import org.eclipse.osgi.util.NLS;

/**
 * This class defines commonly used status objects for communicating issues
 * about provisioning plans to the user and analyzes a proposed provisioning plan
 * to find common problems and report them in a way that makes sense to a user.
 * 
 * @since 3.4
 */
public class PlanStatusHelper {

	public static IStatus getStatus(int statusCode, IInstallableUnit affectedIU) {
		switch (statusCode) {
			case IStatusCodes.IMPLIED_UPDATE :
				return new Status(IStatus.INFO, ProvUIActivator.PLUGIN_ID, statusCode, NLS.bind(ProvUIMessages.PlanStatusHelper_ImpliedUpdate, getIUString(affectedIU)), null);
			case IStatusCodes.IGNORED_IMPLIED_DOWNGRADE :
				return new Status(IStatus.WARNING, ProvUIActivator.PLUGIN_ID, statusCode, NLS.bind(ProvUIMessages.PlanStatusHelper_IgnoringImpliedDowngrade, getIUString(affectedIU)), null);
			case IStatusCodes.IGNORED_ALREADY_INSTALLED :
				return new Status(IStatus.WARNING, ProvUIActivator.PLUGIN_ID, statusCode, NLS.bind(ProvUIMessages.PlanStatusHelper_AlreadyInstalled, getIUString(affectedIU)), null);
			case IStatusCodes.UNEXPECTED_NOTHING_TO_DO :
				return new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, statusCode, NLS.bind(ProvUIMessages.PlanStatusHelper_NothingToDo, getIUString(affectedIU)), null);
			case IStatusCodes.PROFILE_CHANGE_ALTERED :
				return new MultiStatus(ProvUIActivator.PLUGIN_ID, statusCode, ProvUIMessages.PlanStatusHelper_RequestAltered, null);
			default :
				return new Status(IStatus.ERROR, ProvUIActivator.PLUGIN_ID, statusCode, NLS.bind(ProvUIMessages.PlanStatusHelper_UnexpectedError, new Integer(statusCode), getIUString(affectedIU)), null);
		}
	}

	public static MultiStatus getProfileChangeAlteredStatus() {
		return (MultiStatus) getStatus(IStatusCodes.PROFILE_CHANGE_ALTERED, null);
	}

	public static IStatus computeStatus(ProvisioningPlan plan, IInstallableUnit[] ius) {
		if (plan == null)
			return getStatus(IStatusCodes.UNEXPECTED_NOTHING_TO_DO, null);
		// If the plan is ok or cancel, no further analysis is needed
		if (plan.getStatus().isOK() || plan.getStatus().getSeverity() == IStatus.CANCEL)
			return plan.getStatus();

		// If this is a status we have already checked, don't bother doing so again.
		if (plan.getStatus().getCode() == IStatusCodes.UNEXPECTED_NOTHING_TO_DO)
			return plan.getStatus();

		// If the plan has no IU operands and some were expected, then nothing will happen.
		if (ius != null && ius.length > 0) {
			boolean iusInPlan = false;
			Operand[] operands = plan.getOperands();
			for (int i = 0; i < operands.length; i++)
				if (operands[i] instanceof InstallableUnitOperand) {
					iusInPlan = true;
					break;
				}
			if (!iusInPlan) {
				MultiStatus status = new MultiStatus(ProvUIActivator.PLUGIN_ID, IStatusCodes.UNEXPECTED_NOTHING_TO_DO, ProvUIMessages.PlanStatusHelper_NothingToDo, null);
				status.add(getStatus(IStatusCodes.UNEXPECTED_NOTHING_TO_DO, null));
				if (plan.getStatus() != null)
					status.merge(plan.getStatus());
				return status;
			}
		}
		// We have no further interpretation.
		return plan.getStatus();

	}

	private static String getIUString(IInstallableUnit iu) {
		if (iu == null)
			return ProvUIMessages.PlanStatusHelper_Items;
		// Get the iu name in the default locale
		String name = IUPropertyUtils.getIUProperty(iu, IInstallableUnit.PROP_NAME);
		if (name != null)
			return name;
		return iu.getId();
	}
}