bundles/org.eclipse.equinox.p2.publisher/src/org/eclipse/equinox/internal/p2/publisher/actions/ConfigCUsAction.java - equinox/rt.equinox.p2 - Git at Google

 /*******************************************************************************
  * Copyright (c) 2008 Code 9 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:
  *   Code 9 - initial API and implementation
  ******************************************************************************/
 package org.eclipse.equinox.internal.p2.publisher.actions;

 import java.io.File;
 import java.io.IOException;
 import java.net.URL;
 import java.util.*;
 import java.util.Map.Entry;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.equinox.internal.p2.publisher.*;
 import org.eclipse.equinox.internal.provisional.frameworkadmin.BundleInfo;
 import org.eclipse.equinox.internal.provisional.p2.metadata.IInstallableUnit;
 import org.eclipse.equinox.internal.provisional.p2.metadata.query.InstallableUnitQuery;
 import org.eclipse.equinox.internal.provisional.p2.metadata.repository.IMetadataRepository;
 import org.eclipse.equinox.internal.provisional.p2.query.Collector;
 import org.eclipse.equinox.internal.provisional.p2.query.Query;
 import org.eclipse.osgi.util.ManifestElement;
 import org.osgi.framework.*;

 /**
  * Publish CUs for all the configuration data in the current result.
  * This adds config-specific CUs to capture start levels etc found in the config.ini
  * etc for is os, ws, arch combination seen so far.
  */
 public class ConfigCUsAction extends AbstractPublishingAction {

 	protected static final String ORG_ECLIPSE_UPDATE_CONFIGURATOR = "org.eclipse.update.configurator"; //$NON-NLS-1$
 	protected String version;
 	protected String id;
 	protected String flavor;

 	public ConfigCUsAction(IPublisherInfo info, String flavor, String id, String version) {
 		this.flavor = flavor;
 		this.id = id;
 		this.version = version;
 	}

 	public IStatus perform(IPublisherInfo info, IPublisherResult results) {
 		// generation from remembered config.ini's
 		// we have N platforms, generate a CU for each
 		// TODO try and find common properties across platforms
 		String[] configSpecs = info.getConfigurations();
 		for (int i = 0; i < configSpecs.length; i++) {
 			String configSpec = configSpecs[i];
 			Collection configAdvice = info.getAdvice(configSpec, false, null, null, IConfigAdvice.class);
 			BundleInfo[] bundles = fillInBundles(configAdvice, results);
 			generateBundleConfigIUs(info, bundles, configSpec, results);

 			Collection launchingAdvice = info.getAdvice(configSpec, false, null, null, ILaunchingAdvice.class);
 			publishIniIUs(configAdvice, launchingAdvice, results, configSpec);
 		}
 		return Status.OK_STATUS;
 	}

 	// there seem to be cases where the bundle infos are not filled in with symbolic name and version.
 	// fill in the missing data.
 	private BundleInfo[] fillInBundles(Collection configAdvice, IPublisherResult results) {
 		ArrayList result = new ArrayList();
 		for (Iterator j = configAdvice.iterator(); j.hasNext();) {
 			IConfigAdvice advice = (IConfigAdvice) j.next();
 			BundleInfo[] bundles = advice.getBundles();
 			for (int i = 0; i < bundles.length; i++) {
 				BundleInfo bundleInfo = bundles[i];
 				// prime the result with the current info.  This will be replaced if there is more info...
 				if ((bundleInfo.getSymbolicName() != null && bundleInfo.getVersion() != null) || bundleInfo.getLocation() == null)
 					result.add(bundles[i]);
 				else {
 					try {
 						File location = new File(new URL(bundleInfo.getLocation()).getPath());
 						Dictionary manifest = BundleDescriptionFactory.loadManifest(location);
 						if (manifest == null)
 							continue;
 						GeneratorBundleInfo newInfo = new GeneratorBundleInfo(bundleInfo);
 						ManifestElement[] element = ManifestElement.parseHeader("dummy-bsn", (String) manifest.get(Constants.BUNDLE_SYMBOLICNAME)); //$NON-NLS-1$
 						newInfo.setSymbolicName(element[0].getValue());
 						newInfo.setVersion((String) manifest.get(Constants.BUNDLE_VERSION));
 						result.add(newInfo);
 					} catch (BundleException e) {
 						// TODO Auto-generated catch block
 						e.printStackTrace();
 					} catch (IOException e) {
 						// TODO Auto-generated catch block
 						e.printStackTrace();
 					}
 				}
 			}
 		}
 		return (BundleInfo[]) result.toArray(new BundleInfo[result.size()]);
 	}

 	private void publishIniIUs(Collection configAdvice, Collection launchingAdvice, IPublisherResult results, String configSpec) {
 		if (configAdvice.isEmpty() && launchingAdvice.isEmpty())
 			return;

 		String configureData = ""; //$NON-NLS-1$
 		String unconfigureData = ""; //$NON-NLS-1$

 		if (!configAdvice.isEmpty()) {
 			String[] dataStrings = getConfigurationStrings(configAdvice);
 			configureData += dataStrings[0];
 			unconfigureData += dataStrings[1];
 		}

 		if (!launchingAdvice.isEmpty()) {
 			String[] dataStrings = getLauncherConfigStrings(launchingAdvice);
 			configureData += dataStrings[0];
 			unconfigureData += dataStrings[1];
 		}

 		// if there is nothing to configure or unconfigure, then don't even bother generating this IU
 		if (configureData.length() == 0 && unconfigureData.length() == 0)
 			return;

 		Map touchpointData = new HashMap();
 		touchpointData.put("configure", configureData); //$NON-NLS-1$
 		touchpointData.put("unconfigure", unconfigureData); //$NON-NLS-1$
 		IInstallableUnit cu = MetadataGeneratorHelper.createIUFragment(id, version, flavor, configSpec, touchpointData);
 		results.addIU(cu, IPublisherResult.ROOT);
 	}

 	protected String[] getConfigurationStrings(Collection configAdvice) {
 		String configurationData = ""; //$NON-NLS-1$
 		String unconfigurationData = ""; //$NON-NLS-1$
 		for (Iterator i = configAdvice.iterator(); i.hasNext();) {
 			IConfigAdvice advice = (IConfigAdvice) i.next();
 			for (Iterator iterator = advice.getProperties().entrySet().iterator(); iterator.hasNext();) {
 				Entry aProperty = (Entry) iterator.next();
 				String key = ((String) aProperty.getKey());
 				if (key.equals("osgi.frameworkClassPath") || key.equals("osgi.framework") || key.equals("osgi.bundles") || key.equals("eof")) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
 					continue;
 				configurationData += "setProgramProperty(propName:" + key + ", propValue:" + ((String) aProperty.getValue()) + ");"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 				unconfigurationData += "setProgramProperty(propName:" + key + ", propValue:);"; //$NON-NLS-1$ //$NON-NLS-2$
 			}
 		}
 		return new String[] {configurationData, unconfigurationData};
 	}

 	protected String[] getLauncherConfigStrings(Collection launchingAdvice) {
 		String configurationData = ""; //$NON-NLS-1$
 		String unconfigurationData = ""; //$NON-NLS-1$

 		for (Iterator j = launchingAdvice.iterator(); j.hasNext();) {
 			ILaunchingAdvice advice = (ILaunchingAdvice) j.next();
 			String[] jvmArgs = advice.getVMArguments();
 			for (int i = 0; i < jvmArgs.length; i++) {
 				configurationData += "addJvmArg(jvmArg:" + jvmArgs[i] + ");"; //$NON-NLS-1$ //$NON-NLS-2$
 				unconfigurationData += "removeJvmArg(jvmArg:" + jvmArgs[i] + ");"; //$NON-NLS-1$ //$NON-NLS-2$
 			}
 			String[] programArgs = advice.getProgramArguments();
 			for (int i = 0; i < programArgs.length; i++) {
 				String programArg = programArgs[i];
 				if (programArg.equals("--launcher.library") || programArg.equals("-startup") || programArg.equals("-configuration")) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
 					i++;
 				configurationData += "addProgramArg(programArg:" + programArg + ");"; //$NON-NLS-1$ //$NON-NLS-2$
 				unconfigurationData += "removeProgramArg(programArg:" + programArg + ");"; //$NON-NLS-1$ //$NON-NLS-2$
 			}
 		}
 		return new String[] {configurationData, unconfigurationData};
 	}

 	protected void generateBundleConfigIUs(IPublisherInfo info, BundleInfo[] bundles, String configSpec, IPublisherResult result) {
 		if (bundles == null)
 			return;

 		String cuIdPrefix = ""; //$NON-NLS-1$
 		String filter = null;
 		if (configSpec != null) {
 			cuIdPrefix = createIdString(configSpec);
 			filter = createFilterSpec(configSpec);
 		}

 		for (int i = 0; i < bundles.length; i++) {
 			GeneratorBundleInfo bundle = createGeneratorBundleInfo(info, bundles[i], result);
 			if (bundle == null)
 				continue;

 			if (bundle.getSymbolicName().equals(ORG_ECLIPSE_UPDATE_CONFIGURATOR)) {
 				bundle.setStartLevel(BundleInfo.NO_LEVEL);
 				bundle.setMarkedAsStarted(false);
 				bundle.setSpecialConfigCommands("setProgramProperty(propName:org.eclipse.update.reconcile, propValue:false);"); //$NON-NLS-1$
 				bundle.setSpecialUnconfigCommands("setProgramProperty(propName:org.eclipse.update.reconcile, propValue:);"); //$NON-NLS-1$
 			} else if (bundle.getStartLevel() == BundleInfo.NO_LEVEL && !bundle.isMarkedAsStarted()) {
 				// this bundle does not require any particular configuration, the plug-in default IU will handle installing it
 				continue;
 			}

 			IInstallableUnit cu = MetadataGeneratorHelper.createBundleConfigurationUnit(bundle.getSymbolicName(), new Version(bundle.getVersion()), false, bundle, flavor + cuIdPrefix, filter);
 			if (cu != null) {
 				// Product Query will run against the repo, make sure these CUs are in before then
 				IMetadataRepository metadataRepository = info.getMetadataRepository();
 				if (metadataRepository != null) {
 					metadataRepository.addInstallableUnits(new IInstallableUnit[] {cu});
 				}
 				result.addIU(cu, IPublisherResult.ROOT);
 			}
 		}
 	}

 	protected GeneratorBundleInfo createGeneratorBundleInfo(IPublisherInfo info, BundleInfo bundleInfo, IPublisherResult result) {
 		if (bundleInfo.getLocation() != null)
 			return new GeneratorBundleInfo(bundleInfo);

 		String name = bundleInfo.getSymbolicName();

 		//easy case: do we have a matching IU?
 		IInstallableUnit iu = result.getIU(name, null);
 		if (iu != null) {
 			bundleInfo.setVersion(iu.getVersion().toString());
 			return new GeneratorBundleInfo(bundleInfo);
 		}

 		//harder: try id_version
 		int i = name.indexOf('_');
 		while (i > -1) {
 			Version version = null;
 			try {
 				version = new Version(name.substring(i));
 				bundleInfo.setSymbolicName(name.substring(0, i));
 				bundleInfo.setVersion(version.toString());
 				return new GeneratorBundleInfo(bundleInfo);
 			} catch (IllegalArgumentException e) {
 				// the '_' found was probably part of the symbolic id
 				i = name.indexOf('_', i);
 			}
 		}

 		//Query the repo
 		Query query = new InstallableUnitQuery(name);
 		Collector collector = new Collector();
 		Iterator matches = info.getMetadataRepository().query(query, collector, null).iterator();
 		//pick the newest match
 		IInstallableUnit newest = null;
 		while (matches.hasNext()) {
 			IInstallableUnit candidate = (IInstallableUnit) matches.next();
 			if (newest == null || (newest.getVersion().compareTo(candidate.getVersion()) < 0))
 				newest = candidate;
 		}
 		if (newest != null) {
 			bundleInfo.setVersion(newest.getVersion().toString());
 			return new GeneratorBundleInfo(bundleInfo);
 		}

 		return null;
 	}

 }
	/*******************************************************************************
	* Copyright (c) 2008 Code 9 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:
	* Code 9 - initial API and implementation
	******************************************************************************/
	package org.eclipse.equinox.internal.p2.publisher.actions;

	import java.io.File;
	import java.io.IOException;
	import java.net.URL;
	import java.util.*;
	import java.util.Map.Entry;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.equinox.internal.p2.publisher.*;
	import org.eclipse.equinox.internal.provisional.frameworkadmin.BundleInfo;
	import org.eclipse.equinox.internal.provisional.p2.metadata.IInstallableUnit;
	import org.eclipse.equinox.internal.provisional.p2.metadata.query.InstallableUnitQuery;
	import org.eclipse.equinox.internal.provisional.p2.metadata.repository.IMetadataRepository;
	import org.eclipse.equinox.internal.provisional.p2.query.Collector;
	import org.eclipse.equinox.internal.provisional.p2.query.Query;
	import org.eclipse.osgi.util.ManifestElement;
	import org.osgi.framework.*;

	/**
	* Publish CUs for all the configuration data in the current result.
	* This adds config-specific CUs to capture start levels etc found in the config.ini
	* etc for is os, ws, arch combination seen so far.
	*/
	public class ConfigCUsAction extends AbstractPublishingAction {

	protected static final String ORG_ECLIPSE_UPDATE_CONFIGURATOR = "org.eclipse.update.configurator"; //$NON-NLS-1$
	protected String version;
	protected String id;
	protected String flavor;

	public ConfigCUsAction(IPublisherInfo info, String flavor, String id, String version) {
	this.flavor = flavor;
	this.id = id;
	this.version = version;
	}

	public IStatus perform(IPublisherInfo info, IPublisherResult results) {
	// generation from remembered config.ini's
	// we have N platforms, generate a CU for each
	// TODO try and find common properties across platforms
	String[] configSpecs = info.getConfigurations();
	for (int i = 0; i < configSpecs.length; i++) {
	String configSpec = configSpecs[i];
	Collection configAdvice = info.getAdvice(configSpec, false, null, null, IConfigAdvice.class);
	BundleInfo[] bundles = fillInBundles(configAdvice, results);
	generateBundleConfigIUs(info, bundles, configSpec, results);

	Collection launchingAdvice = info.getAdvice(configSpec, false, null, null, ILaunchingAdvice.class);
	publishIniIUs(configAdvice, launchingAdvice, results, configSpec);
	}
	return Status.OK_STATUS;
	}

	// there seem to be cases where the bundle infos are not filled in with symbolic name and version.
	// fill in the missing data.
	private BundleInfo[] fillInBundles(Collection configAdvice, IPublisherResult results) {
	ArrayList result = new ArrayList();
	for (Iterator j = configAdvice.iterator(); j.hasNext();) {
	IConfigAdvice advice = (IConfigAdvice) j.next();
	BundleInfo[] bundles = advice.getBundles();
	for (int i = 0; i < bundles.length; i++) {
	BundleInfo bundleInfo = bundles[i];
	// prime the result with the current info. This will be replaced if there is more info...
	if ((bundleInfo.getSymbolicName() != null && bundleInfo.getVersion() != null) \|\| bundleInfo.getLocation() == null)
	result.add(bundles[i]);
	else {
	try {
	File location = new File(new URL(bundleInfo.getLocation()).getPath());
	Dictionary manifest = BundleDescriptionFactory.loadManifest(location);
	if (manifest == null)
	continue;
	GeneratorBundleInfo newInfo = new GeneratorBundleInfo(bundleInfo);
	ManifestElement[] element = ManifestElement.parseHeader("dummy-bsn", (String) manifest.get(Constants.BUNDLE_SYMBOLICNAME)); //$NON-NLS-1$
	newInfo.setSymbolicName(element[0].getValue());
	newInfo.setVersion((String) manifest.get(Constants.BUNDLE_VERSION));
	result.add(newInfo);
	} catch (BundleException e) {
	// TODO Auto-generated catch block
	e.printStackTrace();
	} catch (IOException e) {
	// TODO Auto-generated catch block
	e.printStackTrace();
	}
	}
	}
	}
	return (BundleInfo[]) result.toArray(new BundleInfo[result.size()]);
	}

	private void publishIniIUs(Collection configAdvice, Collection launchingAdvice, IPublisherResult results, String configSpec) {
	if (configAdvice.isEmpty() && launchingAdvice.isEmpty())
	return;

	String configureData = ""; //$NON-NLS-1$
	String unconfigureData = ""; //$NON-NLS-1$

	if (!configAdvice.isEmpty()) {
	String[] dataStrings = getConfigurationStrings(configAdvice);
	configureData += dataStrings[0];
	unconfigureData += dataStrings[1];
	}

	if (!launchingAdvice.isEmpty()) {
	String[] dataStrings = getLauncherConfigStrings(launchingAdvice);
	configureData += dataStrings[0];
	unconfigureData += dataStrings[1];
	}

	// if there is nothing to configure or unconfigure, then don't even bother generating this IU
	if (configureData.length() == 0 && unconfigureData.length() == 0)
	return;

	Map touchpointData = new HashMap();
	touchpointData.put("configure", configureData); //$NON-NLS-1$
	touchpointData.put("unconfigure", unconfigureData); //$NON-NLS-1$
	IInstallableUnit cu = MetadataGeneratorHelper.createIUFragment(id, version, flavor, configSpec, touchpointData);
	results.addIU(cu, IPublisherResult.ROOT);
	}

	protected String[] getConfigurationStrings(Collection configAdvice) {
	String configurationData = ""; //$NON-NLS-1$
	String unconfigurationData = ""; //$NON-NLS-1$
	for (Iterator i = configAdvice.iterator(); i.hasNext();) {
	IConfigAdvice advice = (IConfigAdvice) i.next();
	for (Iterator iterator = advice.getProperties().entrySet().iterator(); iterator.hasNext();) {
	Entry aProperty = (Entry) iterator.next();
	String key = ((String) aProperty.getKey());
	if (key.equals("osgi.frameworkClassPath") \|\| key.equals("osgi.framework") \|\| key.equals("osgi.bundles") \|\| key.equals("eof")) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
	continue;
	configurationData += "setProgramProperty(propName:" + key + ", propValue:" + ((String) aProperty.getValue()) + ");"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	unconfigurationData += "setProgramProperty(propName:" + key + ", propValue:);"; //$NON-NLS-1$ //$NON-NLS-2$
	}
	}
	return new String[] {configurationData, unconfigurationData};
	}

	protected String[] getLauncherConfigStrings(Collection launchingAdvice) {
	String configurationData = ""; //$NON-NLS-1$
	String unconfigurationData = ""; //$NON-NLS-1$

	for (Iterator j = launchingAdvice.iterator(); j.hasNext();) {
	ILaunchingAdvice advice = (ILaunchingAdvice) j.next();
	String[] jvmArgs = advice.getVMArguments();
	for (int i = 0; i < jvmArgs.length; i++) {
	configurationData += "addJvmArg(jvmArg:" + jvmArgs[i] + ");"; //$NON-NLS-1$ //$NON-NLS-2$
	unconfigurationData += "removeJvmArg(jvmArg:" + jvmArgs[i] + ");"; //$NON-NLS-1$ //$NON-NLS-2$
	}
	String[] programArgs = advice.getProgramArguments();
	for (int i = 0; i < programArgs.length; i++) {
	String programArg = programArgs[i];
	if (programArg.equals("--launcher.library") \|\| programArg.equals("-startup") \|\| programArg.equals("-configuration")) //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
	i++;
	configurationData += "addProgramArg(programArg:" + programArg + ");"; //$NON-NLS-1$ //$NON-NLS-2$
	unconfigurationData += "removeProgramArg(programArg:" + programArg + ");"; //$NON-NLS-1$ //$NON-NLS-2$
	}
	}
	return new String[] {configurationData, unconfigurationData};
	}

	protected void generateBundleConfigIUs(IPublisherInfo info, BundleInfo[] bundles, String configSpec, IPublisherResult result) {
	if (bundles == null)
	return;

	String cuIdPrefix = ""; //$NON-NLS-1$
	String filter = null;
	if (configSpec != null) {
	cuIdPrefix = createIdString(configSpec);
	filter = createFilterSpec(configSpec);
	}

	for (int i = 0; i < bundles.length; i++) {
	GeneratorBundleInfo bundle = createGeneratorBundleInfo(info, bundles[i], result);
	if (bundle == null)
	continue;

	if (bundle.getSymbolicName().equals(ORG_ECLIPSE_UPDATE_CONFIGURATOR)) {
	bundle.setStartLevel(BundleInfo.NO_LEVEL);
	bundle.setMarkedAsStarted(false);
	bundle.setSpecialConfigCommands("setProgramProperty(propName:org.eclipse.update.reconcile, propValue:false);"); //$NON-NLS-1$
	bundle.setSpecialUnconfigCommands("setProgramProperty(propName:org.eclipse.update.reconcile, propValue:);"); //$NON-NLS-1$
	} else if (bundle.getStartLevel() == BundleInfo.NO_LEVEL && !bundle.isMarkedAsStarted()) {
	// this bundle does not require any particular configuration, the plug-in default IU will handle installing it
	continue;
	}

	IInstallableUnit cu = MetadataGeneratorHelper.createBundleConfigurationUnit(bundle.getSymbolicName(), new Version(bundle.getVersion()), false, bundle, flavor + cuIdPrefix, filter);
	if (cu != null) {
	// Product Query will run against the repo, make sure these CUs are in before then
	IMetadataRepository metadataRepository = info.getMetadataRepository();
	if (metadataRepository != null) {
	metadataRepository.addInstallableUnits(new IInstallableUnit[] {cu});
	}
	result.addIU(cu, IPublisherResult.ROOT);
	}
	}
	}

	protected GeneratorBundleInfo createGeneratorBundleInfo(IPublisherInfo info, BundleInfo bundleInfo, IPublisherResult result) {
	if (bundleInfo.getLocation() != null)
	return new GeneratorBundleInfo(bundleInfo);

	String name = bundleInfo.getSymbolicName();

	//easy case: do we have a matching IU?
	IInstallableUnit iu = result.getIU(name, null);
	if (iu != null) {
	bundleInfo.setVersion(iu.getVersion().toString());
	return new GeneratorBundleInfo(bundleInfo);
	}

	//harder: try id_version
	int i = name.indexOf('_');
	while (i > -1) {
	Version version = null;
	try {
	version = new Version(name.substring(i));
	bundleInfo.setSymbolicName(name.substring(0, i));
	bundleInfo.setVersion(version.toString());
	return new GeneratorBundleInfo(bundleInfo);
	} catch (IllegalArgumentException e) {
	// the '_' found was probably part of the symbolic id
	i = name.indexOf('_', i);
	}
	}

	//Query the repo
	Query query = new InstallableUnitQuery(name);
	Collector collector = new Collector();
	Iterator matches = info.getMetadataRepository().query(query, collector, null).iterator();
	//pick the newest match
	IInstallableUnit newest = null;
	while (matches.hasNext()) {
	IInstallableUnit candidate = (IInstallableUnit) matches.next();
	if (newest == null \|\| (newest.getVersion().compareTo(candidate.getVersion()) < 0))
	newest = candidate;
	}
	if (newest != null) {
	bundleInfo.setVersion(newest.getVersion().toString());
	return new GeneratorBundleInfo(bundleInfo);
	}

	return null;
	}

	}