Attachment #209697 for bug #236709

Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Lines 25-30 Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/.project (+5 lines)
25	<arguments>	25	<arguments>
26	</arguments>	26	</arguments>
27	</buildCommand>	27	</buildCommand>
		28	<buildCommand>
		29	<name>org.eclipse.pde.ds.core.builder</name>
		30	<arguments>
		31	</arguments>
		32	</buildCommand>
28	</buildSpec>	33	</buildSpec>
29	<natures>	34	<natures>
30	<nature>org.eclipse.pde.PluginNature</nature>	35	<nature>org.eclipse.pde.PluginNature</nature>

Lines 43-49 Import-Package: javax.xml.parsers, Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/META-INF/MANIFEST.MF (+2 lines)
43	org.eclipse.osgi.service.resolver;version="1.2.0";resolution:=optional,	43	org.eclipse.osgi.service.resolver;version="1.2.0";resolution:=optional,
44	org.eclipse.osgi.util;version="1.1.0",	44	org.eclipse.osgi.util;version="1.1.0",
45	org.osgi.framework;version="1.3.0",	45	org.osgi.framework;version="1.3.0",
		46	org.osgi.service.packageadmin;version="1.2.0",
46	org.osgi.service.prefs;version="1.1.1",	47	org.osgi.service.prefs;version="1.1.1",
47	org.osgi.util.tracker;version="1.4.0",	48	org.osgi.util.tracker;version="1.4.0",
48	org.w3c.dom,	49	org.w3c.dom,
49	org.xml.sax	50	org.xml.sax
		51	Service-Component: OSGI-INF/bundleGroup.xml

Added Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/OSGI-INF/bundleGroup.xml (+7 lines)
1	<?xml version="1.0" encoding="UTF-8"?>
2	<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="false" name="org.eclipse.equinox.p2.touchpoint.eclipse.bundlegroup">
3	<implementation class="org.eclipse.equinox.internal.p2.touchpoint.eclipse.BundleGroupComponent"/>
4	<service>
5	<provide interface="org.eclipse.core.runtime.IBundleGroupProvider"/>
6	</service>
7	</scr:component>

Lines 14-20 bin.includes = META-INF/,\ Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/build.properties (-1 / +2 lines)
14	.,\	14	.,\
15	plugin.xml,\	15	plugin.xml,\
16	about.html,\	16	about.html,\
17	plugin.properties	17	plugin.properties,\
		18	OSGI-INF/
18	src.includes = about.html	19	src.includes = about.html
19	javacTarget=jsr14	20	javacTarget=jsr14
20	javacSource=1.5	21	javacSource=1.5




/*******************************************************************************
 * Copyright (c) 2011 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.touchpoint.eclipse;

import java.net.URL;
import java.util.Hashtable;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;

/**
 * The information within this object is obtained from the about INI file.
 * This file resides within an install configurations directory and must be a 
 * standard java property file.  
 * <p>
 * This class is not intended to be instantiated or subclassed by clients.
 * </p>
 */
public final class AboutInfo {
	private final static String INI_FILENAME = "about.ini"; //$NON-NLS-1$
	private final static String PROPERTIES_FILENAME = "about.properties"; //$NON-NLS-1$
	private final static String MAPPINGS_FILENAME = "about.mappings"; //$NON-NLS-1$

	private String featureId;
	private String versionId = ""; //$NON-NLS-1$
	private String providerName;
	private String appName;
	private URL windowImageURL;
	private URL[] windowImagesURLs;
	private URL aboutImageURL;
	private URL featureImageURL;
	private URL welcomePageURL;
	private String aboutText;
	private String welcomePerspective;
	private String tipsAndTricksHref;

	/*
	 * Create a new about info for a feature with the given id.
	 */
	/* package */AboutInfo(String featureId) {
		super();
		this.featureId = featureId;
	}

	/**
	 * Returns the configuration information for the feature with the 
	 * given id.
	 * 
	 * @param featureId the feature id
	 * @param versionId the version id (of the feature)
	 * @param pluginId the plug-in id
	 * @return the configuration information for the feature
	 */
	public static AboutInfo readFeatureInfo(String featureId, String versionId, String pluginId) {

		AboutInfo info = new AboutInfo(featureId);
		IniFileReader reader = new IniFileReader(featureId, pluginId, INI_FILENAME, PROPERTIES_FILENAME, MAPPINGS_FILENAME);
		if (!reader.load().isOK())
			return info;
		Hashtable<String, String> runtimeMappings = new Hashtable<String, String>();
		runtimeMappings.put("{featureVersion}", versionId); //$NON-NLS-1$
		info.versionId = versionId;
		info.providerName = reader.getProviderName();
		info.appName = reader.getString("appName", true, runtimeMappings); //$NON-NLS-1$
		info.aboutText = reader.getString("aboutText", true, runtimeMappings); //$NON-NLS-1$
		info.windowImageURL = reader.getURL("windowImage"); //$NON-NLS-1$
		// look for the newer array, but if its not there then use the older,
		// single image definition
		info.windowImagesURLs = reader.getURLs("windowImages"); //$NON-NLS-1$
		info.aboutImageURL = reader.getURL("aboutImage"); //$NON-NLS-1$
		info.featureImageURL = reader.getURL("featureImage"); //$NON-NLS-1$
		info.welcomePageURL = reader.getURL("welcomePage"); //$NON-NLS-1$
		info.welcomePerspective = reader.getString("welcomePerspective", false, runtimeMappings); //$NON-NLS-1$
		info.tipsAndTricksHref = reader.getString("tipsAndTricksHref", false, runtimeMappings); //$NON-NLS-1$
		return info;
	}

	/**
	 * Returns the URL for an image which can be shown in an "about" dialog 
	 * for this product. Products designed to run "headless" typically would not 
	 * have such an image.
	 * 
	 * @return the URL for an about image, or <code>null</code> if none
	 */
	public URL getAboutImageURL() {
		return aboutImageURL;
	}

	/**
	 * Returns the URL for an image which can be shown in an "about features" 
	 * dialog. Products designed to run "headless" typically would not have such an image.
	 * 
	 * @return the URL for a feature image, or <code>null</code> if none
	 */
	public URL getFeatureImageURL() {
		return featureImageURL;
	}

	/**
	 * Returns the simple name of the feature image file.
	 * 
	 * @return the simple name of the feature image file,
	 * or <code>null</code> if none
	 */
	public String getFeatureImageName() {
		if (featureImageURL != null) {
			IPath path = new Path(featureImageURL.getPath());
			return path.lastSegment();
		}
		return null;
	}

	/**
	 * Returns the id for this feature.
	 * 
	 * @return the feature id
	 */
	public String getFeatureId() {
		return featureId;
	}

	/**
	 * Returns the text to show in an "about" dialog for this product.
	 * Products designed to run "headless" typically would not have such text.
	 * 
	 * @return the about text, or <code>null</code> if none
	 */
	public String getAboutText() {
		return aboutText;
	}

	/**
	 * Returns the application name or <code>null</code>.
	 * Note this is never shown to the user.
	 * It is used to initialize the SWT Display.
	 * <p>
	 * On Motif, for example, this can be used
	 * to set the name used for resource lookup.
	 * </p>
	 *
	 * @return the application name, or <code>null</code>
	 */
	public String getAppName() {
		return appName;
	}

	/**
	 * Returns the provider name or <code>null</code>.
	 *
	 * @return the provider name, or <code>null</code>
	 */
	public String getProviderName() {
		return providerName;
	}

	/**
	 * Returns the feature version id.
	 *
	 * @return the version id of the feature
	 */
	public String getVersionId() {
		return versionId;
	}

	/**
	 * Returns a <code>URL</code> for the welcome page.
	 * Products designed to run "headless" typically would not have such an page.
	 * 
	 * @return the welcome page, or <code>null</code> if none
	 */
	public URL getWelcomePageURL() {
		return welcomePageURL;
	}

	/**
	 * Returns the ID of a perspective in which to show the welcome page.
	 * May be <code>null</code>.
	 * 
	 * @return the welcome page perspective id, or <code>null</code> if none
	 */
	public String getWelcomePerspectiveId() {
		return welcomePerspective;
	}

	/**
	 * Returns a <code>String</code> for the tips and trick href.
	 * 
	 * @return the tips and tricks href, or <code>null</code> if none
	 */
	public String getTipsAndTricksHref() {
		return tipsAndTricksHref;
	}

	/**
	 * Returns the image url for the window image to use for this product.
	 * Products designed to run "headless" typically would not have such an image.
	 * 
	 * @return the image url for the window image, or <code>null</code> if none
	 */
	public URL getWindowImageURL() {
		return windowImageURL;
	}

	/**
	 * Return an array of image URLs for the window images to use for
	 * this product. The expectations is that the elements will be the same
	 * image rendered at different sizes. Products designed to run "headless"
	 * typically would not have such images.
	 * 
	 * @return an array of the image descriptors for the window images, or
	 *         <code>null</code> if none
	 * @since 3.0
	 */
	public URL[] getWindowImagesURLs() {
		return windowImagesURLs;
	}
}

Lines 1-5 Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/src/org/eclipse/equinox/internal/p2/touchpoint/eclipse/Activator.java (-3 / +47 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2007 IBM Corporation and others.	2	* Copyright (c) 2007, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 10-21 Link Here
10	*******************************************************************************/	10	*******************************************************************************/
11	package org.eclipse.equinox.internal.p2.touchpoint.eclipse;	11	package org.eclipse.equinox.internal.p2.touchpoint.eclipse;
12		12
13	import org.osgi.framework.BundleActivator;	13	import org.eclipse.equinox.internal.p2.core.helpers.ServiceHelper;
14	import org.osgi.framework.BundleContext;	14	import org.eclipse.equinox.p2.core.IProvisioningAgent;
		15	import org.eclipse.equinox.p2.engine.IProfile;
		16	import org.eclipse.equinox.p2.engine.IProfileRegistry;
		17	import org.osgi.framework.*;
		18	import org.osgi.service.packageadmin.PackageAdmin;
		19	import org.osgi.util.tracker.ServiceTracker;
15		20
16	public class Activator implements BundleActivator {	21	public class Activator implements BundleActivator {
17	public static final String ID = "org.eclipse.equinox.p2.touchpoint.eclipse"; //$NON-NLS-1$	22	public static final String ID = "org.eclipse.equinox.p2.touchpoint.eclipse"; //$NON-NLS-1$
18	private static BundleContext context = null;	23	private static BundleContext context = null;
		24	private static ServiceTracker<?, ?> bundleTracker;
19		25
20	public void start(BundleContext ctx) throws Exception {	26	public void start(BundleContext ctx) throws Exception {
21	Activator.context = ctx;	27	Activator.context = ctx;
Lines 23-32 public class Activator implements BundleActivator { Link Here
23		29
24	public void stop(BundleContext ctx) throws Exception {	30	public void stop(BundleContext ctx) throws Exception {
25	Activator.context = null;	31	Activator.context = null;
		32	if (Activator.bundleTracker != null) {
		33	Activator.bundleTracker.close();
		34	Activator.bundleTracker = null;
		35	}
26	}	36	}
27		37
28	public static BundleContext getContext() {	38	public static BundleContext getContext() {
29	return Activator.context;	39	return Activator.context;
30	}	40	}
31		41
		42	/*
		43	* Return the current profile or null if it cannot be retrieved.
		44	*/
		45	public static IProfile getProfile() {
		46	IProvisioningAgent agent = getAgent();
		47	IProfileRegistry profileRegistry = (IProfileRegistry) agent.getService(IProfileRegistry.SERVICE_NAME);
		48	if (profileRegistry == null)
		49	return null;
		50	return profileRegistry.getProfile(IProfileRegistry.SELF);
		51	}
		52
		53	private static IProvisioningAgent getAgent() {
		54	return (IProvisioningAgent) ServiceHelper.getService(Activator.getContext(), IProvisioningAgent.SERVICE_NAME);
		55	}
		56
		57	public static synchronized Bundle getBundle(String symbolicName) {
		58	if (bundleTracker == null) {
		59	bundleTracker = new ServiceTracker(getContext(), PackageAdmin.class, null);
		60	bundleTracker.open();
		61	}
		62	PackageAdmin admin = (PackageAdmin) bundleTracker.getService();
		63	if (admin == null)
		64	return null;
		65	Bundle[] bundles = admin.getBundles(symbolicName, null);
		66	if (bundles == null)
		67	return null;
		68	//Return the first bundle that is not installed or uninstalled
		69	for (int i = 0; i < bundles.length; i++) {
		70	if ((bundles[i].getState() & (Bundle.INSTALLED \| Bundle.UNINSTALLED)) == 0) {
		71	return bundles[i];
		72	}
		73	}
		74	return null;
		75	}
32	}	76	}




/*******************************************************************************
 * Copyright (c) 2011 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.touchpoint.eclipse;

import java.net.URL;
import java.util.*;
import org.eclipse.core.runtime.IBundleGroup;
import org.eclipse.core.runtime.IBundleGroupProvider;
import org.eclipse.equinox.internal.p2.metadata.IRequiredCapability;
import org.eclipse.equinox.internal.p2.metadata.TranslationSupport;
import org.eclipse.equinox.p2.engine.IProfile;
import org.eclipse.equinox.p2.metadata.IInstallableUnit;
import org.eclipse.equinox.p2.metadata.IRequirement;
import org.eclipse.equinox.p2.query.IQueryResult;
import org.eclipse.equinox.p2.query.QueryUtil;
import org.osgi.framework.Bundle;

public class BundleGroupComponent implements IBundleGroupProvider {

	TranslationSupport translator = TranslationSupport.getInstance();

	public class IUBundleGroup implements IBundleGroup, IBundleGroupConstants, IProductConstants {
		IInstallableUnit iu;
		AboutInfo branding;

		public IUBundleGroup(IInstallableUnit iu) {
			this.iu = iu;
		}

		private AboutInfo getBranding() {
			if (branding == null)
				branding = AboutInfo.readFeatureInfo(getIdentifier(), getVersion(), getIdentifier());
			return branding;
		}

		public String getIdentifier() {
			String id = iu.getId();
			if (id == null)
				return null;
			// trim the id if it ends in ".feature.group" so it looks more
			// like a feature id than an IU id
			final String END = ".feature.group"; //$NON-NLS-1$
			if (id.endsWith(END))
				id = id.substring(0, id.length() - END.length());
			return id;
		}

		public String getName() {
			return translator.getIUProperty(iu, IInstallableUnit.PROP_NAME);
		}

		public String getVersion() {
			return iu.getVersion().toString();
		}

		public String getDescription() {
			return translator.getIUProperty(iu, IInstallableUnit.PROP_DESCRIPTION);
		}

		public String getProviderName() {
			return translator.getIUProperty(iu, IInstallableUnit.PROP_PROVIDER);
		}

		public Bundle[] getBundles() {
			Collection<Bundle> result = new HashSet<Bundle>();
			Collection<IRequirement> reqs = iu.getRequirements();
			for (IRequirement obj : reqs) {
				if (!(obj instanceof IRequiredCapability))
					continue;
				IRequiredCapability req = (IRequiredCapability) obj;
				// we are only interested in requirements on other IUs
				if (!IInstallableUnit.NAMESPACE_IU_ID.equals(req.getNamespace()))
					continue;
				String id = req.getName();
				Bundle b = Activator.getBundle(id);
				if (b != null)
					result.add(b);
			}
			return result.toArray(new Bundle[result.size()]);
		}

		public String getProperty(String key) {
			AboutInfo branding = getBranding();
			// IBundleGroupConstants
			if (key.equals(FEATURE_IMAGE))
				return branding.getFeatureImageURL() == null ? null : branding.getFeatureImageURL().toExternalForm();
			else if (key.equals(TIPS_AND_TRICKS_HREF))
				return branding.getTipsAndTricksHref();
			else if (key.equals(IBundleGroupConstants.WELCOME_PAGE)) // same value is used by product and bundle group
				return branding.getWelcomePageURL() == null ? null : branding.getWelcomePageURL().toExternalForm();
			else if (key.equals(WELCOME_PERSPECTIVE))
				return branding.getWelcomePerspectiveId();
			else if (key.equals(BRANDING_BUNDLE_ID))
				// TODO
				return getIdentifier();
			else if (key.equals(BRANDING_BUNDLE_VERSION))
				// TODO
				return getVersion();
			// IProductConstants
			else if (key.equals(APP_NAME))
				return branding.getAppName();
			else if (key.equals(ABOUT_TEXT))
				return branding.getAboutText();
			else if (key.equals(ABOUT_IMAGE))
				return branding.getAboutImageURL() == null ? null : branding.getAboutImageURL().toExternalForm();
			else if (key.equals(WINDOW_IMAGE))
				return branding.getWindowImageURL() == null ? null : branding.getWindowImageURL().toExternalForm();
			else if (key.equals(WINDOW_IMAGES)) {
				URL[] urls = branding.getWindowImagesURLs();
				if (urls == null)
					return null;
				StringBuffer windowImagesURLs = new StringBuffer();
				for (int i = 0; i < urls.length; i++) {
					windowImagesURLs.append(urls[i].toExternalForm());
					if (i != urls.length - 1)
						windowImagesURLs.append(',');
				}
				return windowImagesURLs.toString();
			} else if (key.equals(LICENSE_HREF))
				// TODO
				//return getLicenseURL();
				return null;

			return translator.getIUProperty(iu, key);
		}

		public String toString() {
			return "IUBundleGroup(" + getIdentifier() + " " + getVersion() + ")";
		}
	}

	public String getName() {
		return Messages.bundleGroupComponentName;
	}

	public IBundleGroup[] getBundleGroups() {
		if (!isReconciling())
			return new IBundleGroup[0];
		IProfile profile = Activator.getProfile();
		IQueryResult<IInstallableUnit> profileQueryResult = profile.query(QueryUtil.createIUGroupQuery(), null);
		List<IBundleGroup> result = new ArrayList<IBundleGroup>();
		for (Iterator<IInstallableUnit> it = profileQueryResult.iterator(); it.hasNext();) {
			IInstallableUnit iu = it.next();
			result.add(new IUBundleGroup(iu));
		}
		return result.toArray(new IUBundleGroup[result.size()]);
	}

	/**
	 * Returns whether or not we are reconciling. Check the system property to see
	 * if the update manager is doing the work or not. 
	 */
	public static boolean isReconciling() {
		String reconcile = Activator.getContext().getProperty("org.eclipse.update.reconcile"); //$NON-NLS-1$
		return reconcile != null && reconcile.equalsIgnoreCase("false"); //$NON-NLS-1$
	}
}




/*******************************************************************************
 * Copyright (c) 2011 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.touchpoint.eclipse;

/**
 * These constants define the set of properties that the UI expects to
 * be available via <code>IBundleGroup.getProperty(String)</code>.
 * 
 * @since 3.0
 * @see org.eclipse.core.runtime.IBundleGroup#getProperty(String)
 */
public interface IBundleGroupConstants {
	/**
	 * An image which can be shown in an "about features" dialog (32x32).
	 */
	public static final String FEATURE_IMAGE = "featureImage"; //$NON-NLS-1$

	/**
	 * A help reference for the feature's tips and tricks page (optional).
	 */
	public static final String TIPS_AND_TRICKS_HREF = "tipsAndTricksHref"; //$NON-NLS-1$

	/**
	 * A URL for the feature's welcome page (special XML-based format)
	 * ($nl$/ prefix to permit locale-specific translations of entire file).
	 * Products designed to run "headless" typically would not have such a page.
	 */
	public static final String WELCOME_PAGE = "welcomePage"; //$NON-NLS-1$

	/**
	 * The id of a perspective in which to show the welcome page
	 * (optional).
	 */
	public static final String WELCOME_PERSPECTIVE = "welcomePerspective"; //$NON-NLS-1$

	/**
	 * The URL of the license page for the feature
	 * (optional).
	 */
	public static final String LICENSE_HREF = "licenseHref"; //$NON-NLS-1$

	/**
	 * The id of the bundle group's branding bundle.
	 * @see IFeatureEntry#getFeaturePluginIdentifier()
	 * @since 3.3
	 */
	public static final String BRANDING_BUNDLE_ID = "brandingBundleId"; //$NON-NLS-1$

	/**
	 * The version of the feature branding bundle.
	 * @see IFeatureEntry#getFeaturePluginVersion()
	 * @since 3.3
	 */
	public static final String BRANDING_BUNDLE_VERSION = "brandingBundleVersion"; //$NON-NLS-1$
}




/*******************************************************************************
 * Copyright (c) 2011 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.touchpoint.eclipse;

/**
 * These constants define the set of properties that the UI expects to
 * be available via <code>IProduct.getProperty(String)</code>.
 * 
 * @since 3.0
 * @see org.eclipse.core.runtime.IProduct#getProperty(String)
 */
public interface IProductConstants {
	/**
	 * The application name, used to initialize the SWT Display.  This
	 * value is distinct from the string displayed in the application
	 * title bar.
	 * <p>
	 * E.g., On motif, this can be used to set the name used for
	 * resource lookup.
	 * </p>
	 */
	public static final String APP_NAME = "appName"; //$NON-NLS-1$

	/**
	 * The text to show in an "about" dialog for this product.
	 * Products designed to run "headless" typically would not
	 * have such text.
	 */
	public static final String ABOUT_TEXT = "aboutText"; //$NON-NLS-1$

	/**
	 * An image which can be shown in an "about" dialog for this
	 * product. Products designed to run "headless" typically would not 
	 * have such an image.
	 * <p>
	 * A full-sized product image (no larger than 500x330 pixels) is
	 * shown without the "aboutText" blurb.  A half-sized product image
	 * (no larger than 250x330 pixels) is shown with the "aboutText"
	 * blurb beside it.
	 */
	public static final String ABOUT_IMAGE = "aboutImage"; //$NON-NLS-1$

	/**
	 * An image to be used as the window icon for this product (16x16).  
	 * Products designed to run "headless" typically would not have such an image.
	 * <p>
	 * If the <code>WINDOW_IMAGES</code> property is given, then it supercedes
	 * this one.
	 * </p>
	 */
	public static final String WINDOW_IMAGE = "windowImage"; //$NON-NLS-1$

	/**
	 * An array of one or more images to be used for this product.  The
	 * expectation is that the array will contain the same image rendered
	 * at different sizes (16x16 and 32x32).  
	 * Products designed to run "headless" typically would not have such images.
	 * <p>
	 * If this property is given, then it supercedes <code>WINDOW_IMAGE</code>.
	 * </p>
	 */
	public static final String WINDOW_IMAGES = "windowImages"; //$NON-NLS-1$
	/**
	 * A URL for the products's welcome page (special XML-based format)
	 * ($nl$/ prefix to permit locale-specific translations of entire file).
	 * Products designed to run "headless" typically would not have such a page.
	 */
	public static final String WELCOME_PAGE = "welcomePage"; //$NON-NLS-1$
}




/*******************************************************************************
 * Copyright (c) 2011 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.touchpoint.eclipse;

import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.text.MessageFormat;
import java.util.*;
import org.eclipse.core.runtime.*;
import org.eclipse.osgi.util.NLS;
import org.osgi.framework.Bundle;
import org.osgi.framework.Constants;

// Have to use MessageFormat directly, can't use ICU, possible launch problem?

/**
 * Reads the information found in an "INI" file. This file must be in a
 * standard Java properties format. A properties file may also be provided
 * to NL values in the INI file - values must start with the % prefix. A
 * mapping file may also be provided that contains "fill-ins" for the
 * properties file - format being "n = some text", where n is a number.
 */
public class IniFileReader {
	private static final String PID = "org.eclipse.update.configurator"; //$NON-NLS-1$
	private static final Status OK_STATUS = new Status(IStatus.OK, PID, 0, "", null); //$NON-NLS-1$
	private static final String KEY_PREFIX = "%"; //$NON-NLS-1$
	private static final String KEY_DOUBLE_PREFIX = "%%"; //$NON-NLS-1$
	private static final String NLS_TAG = "$nl$"; //$NON-NLS-1$

	private String featureId;
	private String pluginId;
	private String iniFilename;
	private String propertiesFilename;
	private String mappingsFilename;
	private Properties ini = null;
	private PropertyResourceBundle properties = null;
	private String[] mappings = null;
	private Bundle bundle;

	/**
	 * Creates an INI file reader that can parse the contents into key,value pairs.
	 * 
	 * @param featureId the unique identifier of the feature, must not be <code>null</code>
	 * @param pluginId the unique identifier of the feature plug-in, must not be <code>null</code>
	 * @param iniFilename the INI file name, must not be <code>null</code>
	 * @param propertiesFilename the properties filename, can be <code>null</code> if not required
	 * @param mappingsFilename the mappings filename, can be <code>null</code> if not required
	 */
	public IniFileReader(String featureId, String pluginId, String iniFilename, String propertiesFilename, String mappingsFilename) {
		super();

		if (featureId == null || pluginId == null || iniFilename == null) {
			throw new IllegalArgumentException();
		}

		this.featureId = featureId;
		this.pluginId = pluginId;
		this.iniFilename = iniFilename;
		this.propertiesFilename = propertiesFilename;
		this.mappingsFilename = mappingsFilename;
	}

	/**
	 * Read the contents of the INI, properties, and mappings files.
	 * Does nothing if the content has already been read and parsed.
	 * 
	 * @return an <code>IStatus</code> indicating the success or failure
	 * 	of reading and parsing the INI file content
	 */
	public IStatus load() {
		if (ini != null)
			return OK_STATUS;

		// attempt to locate the corresponding plugin
		bundle = Activator.getBundle(pluginId);
		if (bundle == null || bundle.getState() == Bundle.UNINSTALLED || bundle.getState() == Bundle.INSTALLED) {
			bundle = null; // make it null for other test down the road
			String message = NLS.bind("Cannot find plug-in for feature {0}.", (new String[] {featureId}));
			return new Status(IStatus.ERROR, PID, 0, message, null);
		}

		// Determine the ini file location
		URL iniURL = null;
		IOException ioe = null;
		iniURL = FileLocator.find(bundle, new Path(NLS_TAG).append(iniFilename), null);
		if (iniURL == null) {
			String message = NLS.bind("Cannot open branding file {0}.", (new String[] {iniFilename}));
			return new Status(IStatus.ERROR, PID, 0, message, ioe);
		}

		// Determine the properties file location
		URL propertiesURL = null;
		if (propertiesFilename != null & propertiesFilename.length() > 0) {
			propertiesURL = FileLocator.find(bundle, new Path(NLS_TAG).append(propertiesFilename), null);
		}

		// Determine the mappings file location
		URL mappingsURL = null;
		if (mappingsFilename != null && mappingsFilename.length() > 0) {
			mappingsURL = FileLocator.find(bundle, new Path(NLS_TAG).append(mappingsFilename), null);
		}

		// OK to pass null properties and/or mapping file
		return load(iniURL, propertiesURL, mappingsURL);
	}

	/**
	 * Returns the string value for the given key, or <code>null</code>.
	 * The string value is NLS if requested.
	 * 
	 * @return the string value for the given key, or <code>null</code>
	 */
	public String getString(String key, boolean doNls, Hashtable<String, String> runtimeMappings) {
		if (ini == null)
			return null;
		String value = ini.getProperty(key);
		if (value != null && doNls)
			return getResourceString(value, runtimeMappings);
		return value;
	}

	/**
	 * Returns a URL for the given key, or <code>null</code>.
	 * 
	 * @return a URL for the given key, or <code>null</code>
	 */
	public URL getURL(String key) {
		if (ini == null)
			return null;

		URL url = null;
		String fileName = ini.getProperty(key);
		if (fileName != null) {
			if (bundle == null)
				return null;
			url = FileLocator.find(bundle, new Path(fileName), null);
		}
		return url;
	}

	/**
	 * Returns a array of URL for the given key, or <code>null</code>. The
	 * property value should be a comma separated list of urls, tokens for
	 * which bundle cannot build an url will have a null entry.
	 * 
	 * @param key name of the property containing the requested urls
	 * @return a URL for the given key, or <code>null</code>
	 * @since 3.0
	 */
	public URL[] getURLs(String key) {
		if (ini == null || bundle == null)
			return null;

		String value = ini.getProperty(key);
		if (value == null)
			return null;

		StringTokenizer tokens = new StringTokenizer(value, ","); //$NON-NLS-1$
		ArrayList<URL> array = new ArrayList<URL>(10);
		while (tokens.hasMoreTokens()) {
			String str = tokens.nextToken().trim();
			array.add(FileLocator.find(bundle, new Path(str), null));
		}
		return array.toArray(new URL[array.size()]);
	}

	/**
	 * Returns the feature plugin label, or <code>null</code>.
	 * 
	 * @return the feature plugin lable, or <code>null</code> if none.
	 */
	public String getFeaturePluginLabel() {
		return bundle == null ? null : bundle.getHeaders().get(Constants.BUNDLE_NAME);
	}

	/**
	 * Returns the provider name for this feature, or <code>null</code>.
	 * 
	 * @return the provider name for this feature, or <code>null</code>
	 */
	public String getProviderName() {
		return bundle == null ? null : bundle.getHeaders().get(Constants.BUNDLE_VENDOR);
	}

	/*
	 * Returns a resource string corresponding to the given argument 
	 * value and bundle.
	 * If the argument value specifies a resource key, the string
	 * is looked up in the given resource bundle. If the argument does not
	 * specify a valid key, the argument itself is returned as the
	 * resource string. The key lookup is performed against the
	 * specified resource bundle. If a resource string 
	 * corresponding to the key is not found in the resource bundle
	 * the key value, or any default text following the key in the
	 * argument value is returned as the resource string.
	 * A key is identified as a string begining with the "%" character.
	 * Note that the "%" character is stripped off prior to lookup
	 * in the resource bundle.
	 * <p>
	 * For example, assume resource bundle plugin.properties contains
	 * name = Project Name
	 * <pre>
	 *     <li>getResourceString("Hello World") returns "Hello World"</li>
	 *     <li>getResourceString("%name") returns "Project Name"</li>
	 *     <li>getResourceString("%name Hello World") returns "Project Name"</li>
	 *     <li>getResourceString("%abcd Hello World") returns "Hello World"</li>
	 *     <li>getResourceString("%abcd") returns "%abcd"</li>
	 *     <li>getResourceString("%%name") returns "%name"</li>
	 *     <li>getResourceString(<code>null</code>) returns <code>null</code></li>
	 * </pre>
	 * </p>
	 *
	 * @param value the value or <code>null</code>
	 * @param runtimeMappings runtime mappings or <code>null</code>
	 * @return the resource string
	 */
	public String getResourceString(String value, Hashtable<String, String> runtimeMappings) {

		if (value == null)
			return null;
		String s = value.trim();

		if (!s.startsWith(KEY_PREFIX))
			return s;

		if (s.startsWith(KEY_DOUBLE_PREFIX))
			return s.substring(1);

		int ix = s.indexOf(" "); //$NON-NLS-1$
		String key = ix == -1 ? s : s.substring(0, ix);
		String dflt = ix == -1 ? s : s.substring(ix + 1);

		if (properties == null)
			return dflt;

		String result = null;
		try {
			result = properties.getString(key.substring(1));
		} catch (MissingResourceException e) {
			return dflt;
		}
		if (runtimeMappings != null) {
			for (Enumeration<String> e = runtimeMappings.keys(); e.hasMoreElements();) {
				String keyValue = e.nextElement();
				int i = result.indexOf(keyValue);
				if (i != -1) {
					String s1 = result.substring(0, i);
					String s2 = runtimeMappings.get(keyValue);
					String s3 = result.substring(i + keyValue.length());
					result = s1 + s2 + s3;
				}
			}
		}

		if (result.indexOf('{') != -1) {
			// We test for the curly braces since due to NL issues we do not
			// want to use MessageFormat unless we have to.
			try {
				result = MessageFormat.format(result, mappings);
			} catch (IllegalArgumentException e) {
				//ignore and return string without bound parameters
			}
		}

		return result;
	}

	/*
	 * Read the contents of the ini, properties, and mappings files.
	 */
	private IStatus load(URL iniURL, URL propertiesURL, URL mappingsURL) {

		InputStream is = null;
		try {
			is = iniURL.openStream();
			ini = new Properties();
			ini.load(is);
		} catch (IOException e) {
			ini = null;
			String message = NLS.bind("Error reading branding file {0}.", (new String[] {iniURL.toExternalForm()}));
			return new Status(IStatus.ERROR, PID, 0, message, e);
		} finally {
			try {
				if (is != null)
					is.close();
			} catch (IOException e) {
			}
		}

		if (propertiesURL != null) {
			is = null;
			try {
				is = propertiesURL.openStream();
				properties = new PropertyResourceBundle(is);
			} catch (IOException e) {
				properties = null;
				String message = NLS.bind("Error reading branding properties file {0}.", (new String[] {propertiesURL.toExternalForm()}));
				return new Status(IStatus.ERROR, PID, 0, message, e);
			} finally {
				try {
					if (is != null)
						is.close();
				} catch (IOException e) {
				}
			}
		}

		PropertyResourceBundle bundle = null;
		if (mappingsURL != null) {
			is = null;
			try {
				is = mappingsURL.openStream();
				bundle = new PropertyResourceBundle(is);
			} catch (IOException e) {
				bundle = null;
				String message = NLS.bind("Error reading branding mapping file {0}.", (new String[] {mappingsURL.toExternalForm()}));
				return new Status(IStatus.ERROR, PID, 0, message, e);
			} finally {
				try {
					if (is != null)
						is.close();
				} catch (IOException e) {
				}
			}
		}

		ArrayList mappingsList = new ArrayList();
		if (bundle != null) {
			boolean found = true;
			int i = 0;
			while (found) {
				try {
					mappingsList.add(bundle.getString(Integer.toString(i)));
				} catch (MissingResourceException e) {
					found = false;
				}
				i++;
			}
		}
		mappings = (String[]) mappingsList.toArray(new String[mappingsList.size()]);

		return OK_STATUS;
	}
}

Lines 1-5 Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/src/org/eclipse/equinox/internal/p2/touchpoint/eclipse/Messages.java (-1 / +2 lines)
1	/*******************************************************************************	1	/*******************************************************************************
2	* Copyright (c) 2008, 2009 IBM Corporation and others.	2	* Copyright (c) 2008, 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials	3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0	4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at	5	* which accompanies this distribution, and is available at
Lines 28-33 public class Messages extends NLS { Link Here
28	public static String artifact_file_not_found;	28	public static String artifact_file_not_found;
29	public static String artifact_retrieval_unsupported;	29	public static String artifact_retrieval_unsupported;
30	public static String bundle_pool_not_writeable;	30	public static String bundle_pool_not_writeable;
		31	public static String bundleGroupComponentName;
31	public static String cannot_calculate_extension_location;	32	public static String cannot_calculate_extension_location;
32	public static String parent_dir_features;	33	public static String parent_dir_features;
33	public static String platform_config_unavailable;	34	public static String platform_config_unavailable;

Lines 1-5 Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/src/org/eclipse/equinox/internal/p2/touchpoint/eclipse/messages.properties (-1 / +2 lines)
1	###############################################################################	1	###############################################################################
2	# Copyright (c) 2008, 2009 IBM Corporation and others.	2	# Copyright (c) 2008, 2011 IBM Corporation and others.
3	# All rights reserved. This program and the accompanying materials	3	# All rights reserved. This program and the accompanying materials
4	# are made available under the terms of the Eclipse Public License v1.0	4	# are made available under the terms of the Eclipse Public License v1.0
5	# which accompanies this distribution, and is available at	5	# which accompanies this distribution, and is available at
Lines 21-26 artifact_write_unsupported=Repository not writeable. Link Here
21	artifact_file_not_found=The artifact file for {0} was not found.	21	artifact_file_not_found=The artifact file for {0} was not found.
22	artifact_retrieval_unsupported=Repository does not support artifact retrieval	22	artifact_retrieval_unsupported=Repository does not support artifact retrieval
23	bundle_pool_not_writeable=Bundle pool repository not writeable: {0}	23	bundle_pool_not_writeable=Bundle pool repository not writeable: {0}
		24	bundleGroupComponentName=Equinox p2 Bundle Group Provider
24	BundlePool=Bundle pool	25	BundlePool=Bundle pool
25	cannot_calculate_extension_location=Unable to calculate extension location for: {0}.	26	cannot_calculate_extension_location=Unable to calculate extension location for: {0}.
26	parent_dir_features=Parent directory should be "features": {0}.	27	parent_dir_features=Parent directory should be "features": {0}.

Return to bug 236709

Added Link Here

(-)a/bundles/org.eclipse.equinox.p2.touchpoint.eclipse/src/org/eclipse/equinox/internal/p2/touchpoint/eclipse/AboutInfo.java (+224 lines)
1	/*******************************************************************************
2	* Copyright (c) 2011 IBM Corporation and others.
3	* All rights reserved. This program and the accompanying materials
4	* are made available under the terms of the Eclipse Public License v1.0
5	* which accompanies this distribution, and is available at
6	* http://www.eclipse.org/legal/epl-v10.html
7	*
8	* Contributors:
9	* IBM Corporation - initial API and implementation
10	*******************************************************************************/
11	package org.eclipse.equinox.internal.p2.touchpoint.eclipse;
12
13	import java.net.URL;
14	import java.util.Hashtable;
15	import org.eclipse.core.runtime.IPath;
16	import org.eclipse.core.runtime.Path;
17
18	/**
19	* The information within this object is obtained from the about INI file.
20	* This file resides within an install configurations directory and must be a
21	* standard java property file.
22	* <p>
23	* This class is not intended to be instantiated or subclassed by clients.
24	* </p>
25	*/
26	public final class AboutInfo {
27	private final static String INI_FILENAME = "about.ini"; //$NON-NLS-1$
28	private final static String PROPERTIES_FILENAME = "about.properties"; //$NON-NLS-1$
29	private final static String MAPPINGS_FILENAME = "about.mappings"; //$NON-NLS-1$
30
31	private String featureId;
32	private String versionId = ""; //$NON-NLS-1$
33	private String providerName;
34	private String appName;
35	private URL windowImageURL;
36	private URL[] windowImagesURLs;
37	private URL aboutImageURL;
38	private URL featureImageURL;
39	private URL welcomePageURL;
40	private String aboutText;
41	private String welcomePerspective;
42	private String tipsAndTricksHref;
43
44	/*
45	* Create a new about info for a feature with the given id.
46	*/
47	/* package */AboutInfo(String featureId) {
48	super();
49	this.featureId = featureId;
50	}
51
52	/**
53	* Returns the configuration information for the feature with the
54	* given id.
55	*
56	* @param featureId the feature id
57	* @param versionId the version id (of the feature)
58	* @param pluginId the plug-in id
59	* @return the configuration information for the feature
60	*/
61	public static AboutInfo readFeatureInfo(String featureId, String versionId, String pluginId) {
62
63	AboutInfo info = new AboutInfo(featureId);
64	IniFileReader reader = new IniFileReader(featureId, pluginId, INI_FILENAME, PROPERTIES_FILENAME, MAPPINGS_FILENAME);
65	if (!reader.load().isOK())
66	return info;
67	Hashtable<String, String> runtimeMappings = new Hashtable<String, String>();
68	runtimeMappings.put("{featureVersion}", versionId); //$NON-NLS-1$
69	info.versionId = versionId;
70	info.providerName = reader.getProviderName();
71	info.appName = reader.getString("appName", true, runtimeMappings); //$NON-NLS-1$
72	info.aboutText = reader.getString("aboutText", true, runtimeMappings); //$NON-NLS-1$
73	info.windowImageURL = reader.getURL("windowImage"); //$NON-NLS-1$
74	// look for the newer array, but if its not there then use the older,
75	// single image definition
76	info.windowImagesURLs = reader.getURLs("windowImages"); //$NON-NLS-1$
77	info.aboutImageURL = reader.getURL("aboutImage"); //$NON-NLS-1$
78	info.featureImageURL = reader.getURL("featureImage"); //$NON-NLS-1$
79	info.welcomePageURL = reader.getURL("welcomePage"); //$NON-NLS-1$
80	info.welcomePerspective = reader.getString("welcomePerspective", false, runtimeMappings); //$NON-NLS-1$
81	info.tipsAndTricksHref = reader.getString("tipsAndTricksHref", false, runtimeMappings); //$NON-NLS-1$
82	return info;
83	}
84
85	/**
86	* Returns the URL for an image which can be shown in an "about" dialog
87	* for this product. Products designed to run "headless" typically would not
88	* have such an image.
89	*
90	* @return the URL for an about image, or <code>null</code> if none
91	*/
92	public URL getAboutImageURL() {
93	return aboutImageURL;
94	}
95
96	/**
97	* Returns the URL for an image which can be shown in an "about features"
98	* dialog. Products designed to run "headless" typically would not have such an image.
99	*
100	* @return the URL for a feature image, or <code>null</code> if none
101	*/
102	public URL getFeatureImageURL() {
103	return featureImageURL;
104	}
105
106	/**
107	* Returns the simple name of the feature image file.
108	*
109	* @return the simple name of the feature image file,
110	* or <code>null</code> if none
111	*/
112	public String getFeatureImageName() {
113	if (featureImageURL != null) {
114	IPath path = new Path(featureImageURL.getPath());
115	return path.lastSegment();
116	}
117	return null;
118	}
119
120	/**
121	* Returns the id for this feature.
122	*
123	* @return the feature id
124	*/
125	public String getFeatureId() {
126	return featureId;
127	}
128
129	/**
130	* Returns the text to show in an "about" dialog for this product.
131	* Products designed to run "headless" typically would not have such text.
132	*
133	* @return the about text, or <code>null</code> if none
134	*/
135	public String getAboutText() {
136	return aboutText;
137	}
138
139	/**
140	* Returns the application name or <code>null</code>.
141	* Note this is never shown to the user.
142	* It is used to initialize the SWT Display.
143	* <p>
144	* On Motif, for example, this can be used
145	* to set the name used for resource lookup.
146	* </p>
147	*
148	* @return the application name, or <code>null</code>
149	*/
150	public String getAppName() {
151	return appName;
152	}
153
154	/**
155	* Returns the provider name or <code>null</code>.
156	*
157	* @return the provider name, or <code>null</code>
158	*/
159	public String getProviderName() {
160	return providerName;
161	}
162
163	/**
164	* Returns the feature version id.
165	*
166	* @return the version id of the feature
167	*/
168	public String getVersionId() {
169	return versionId;
170	}
171
172	/**
173	* Returns a <code>URL</code> for the welcome page.
174	* Products designed to run "headless" typically would not have such an page.
175	*
176	* @return the welcome page, or <code>null</code> if none
177	*/
178	public URL getWelcomePageURL() {
179	return welcomePageURL;
180	}
181
182	/**
183	* Returns the ID of a perspective in which to show the welcome page.
184	* May be <code>null</code>.
185	*
186	* @return the welcome page perspective id, or <code>null</code> if none
187	*/
188	public String getWelcomePerspectiveId() {
189	return welcomePerspective;
190	}
191
192	/**
193	* Returns a <code>String</code> for the tips and trick href.
194	*
195	* @return the tips and tricks href, or <code>null</code> if none
196	*/
197	public String getTipsAndTricksHref() {
198	return tipsAndTricksHref;
199	}
200
201	/**
202	* Returns the image url for the window image to use for this product.
203	* Products designed to run "headless" typically would not have such an image.
204	*
205	* @return the image url for the window image, or <code>null</code> if none
206	*/
207	public URL getWindowImageURL() {
208	return windowImageURL;
209	}
210
211	/**
212	* Return an array of image URLs for the window images to use for
213	* this product. The expectations is that the elements will be the same
214	* image rendered at different sizes. Products designed to run "headless"
215	* typically would not have such images.
216	*
217	* @return an array of the image descriptors for the window images, or
218	* <code>null</code> if none
219	* @since 3.0
220	*/
221	public URL[] getWindowImagesURLs() {
222	return windowImagesURLs;
223	}
224	}