bundles/org.eclipse.core.runtime/src/org/eclipse/core/internal/registry/BundleModel.java

/*******************************************************************************
 * Copyright (c) 2003, 2004 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials 
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/cpl-v10.html
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.internal.registry;

import java.net.URL;
import java.util.*;
import org.eclipse.core.internal.runtime.InternalPlatform;
import org.eclipse.core.internal.runtime.ResourceTranslator;
import org.eclipse.core.runtime.IExtension;
import org.eclipse.core.runtime.IExtensionPoint;
import org.osgi.framework.Bundle;

/**
 * An object which represents the user-defined contents of a bundle model
 * in a extensions manifest.
 */
public class BundleModel extends RegistryModelObject implements IRegistryElement {
	private final static String NO_EXTENSION_MUNGING = "eclipse.noExtensionMunging"; //$NON-NLS-1$ //System property

	private String hostId;
	private IExtensionPoint[] extensionPoints;
	private IExtension[] extensions;
	private transient ResourceBundle resourceBundle;
	private long bundleId; //Introduced to fix #46308 //TODO Here may consider keeping the bundle object instead of keeping the id.

	//Introduced for UI backward compatibility
	private static Map renamedUIextensionPoints;
	private String schemaVersion;

	public String getUniqueIdentifier() {
		return getName();
	}

	public void setUniqueIdentifier(String value) {
		setName(value);
	}

	public void setExtensions(IExtension[] value) {
		assertIsWriteable();
		extensions = value;
		fixRenamedExtensionPoints();
	}

	public IExtension getExtension(String id) {
		if (id == null)
			return null;
		IExtension[] list = getExtensions();
		if (list == null)
			return null;
		for (int i = 0; i < list.length; i++) {
			if (id.equals(list[i].getUniqueIdentifier()))
				return list[i];
		}
		return null;
	}

	public IExtension[] getExtensions() {
		return extensions == null ? new IExtension[0] : extensions;
	}

	public void markReadOnly() {
		super.markReadOnly();
		if (extensionPoints != null)
			for (int i = 0; i < extensionPoints.length; i++)
				((ExtensionPoint) extensionPoints[i]).markReadOnly();
		if (extensions != null)
			for (int i = 0; i < extensions.length; i++)
				((Extension) extensions[i]).markReadOnly();
	}

	public void setExtensionPoints(IExtensionPoint[] value) {
		assertIsWriteable();
		extensionPoints = value;
	}

	// TODO is this method needed? does not appear to be called by anyone.
	public IExtensionPoint getExtensionPoint(String xpt) {
		if (xpt == null)
			return null;
		IExtensionPoint[] list = getExtensionPoints();
		if (list == null)
			return null;
		for (int i = 0; i < list.length; i++) {
			if (xpt.equals(list[i].getSimpleIdentifier()))
				return list[i];
		}
		return null;
	}

	public IExtensionPoint[] getExtensionPoints() {
		return extensionPoints == null ? new IExtensionPoint[0] : extensionPoints;
	}

	// TODO should use FindSupport.findInPlugin instead?
	// actually this is dead code to be removed
	private URL findInPlugin(Bundle bundle, String filePath) {
		return bundle.getEntry(filePath);
	}

	// TODO should use FindSupport.findInFragments instead?
	// actually this is dead code to be removed
	private URL findInFragments(Bundle bundle, String filePath) {
		Bundle[] fragments = InternalPlatform.getDefault().getFragments(bundle);
		URL fileURL = null;
		int i = 0;
		while (fragments != null && i < fragments.length && fileURL == null) {
			fileURL = fragments[i].getEntry(filePath);
			i++;
		}
		return fileURL;
	}

	public void setHostIdentifier(String value) {
		hostId = value;
	}

	public String getHostIdentifier() {
		return hostId;
	}

	public boolean isFragment() {
		return hostId != null;
	}

	public String toString() {
		return "BundleModel: " + getName();
	}

	/**
	 * Fixes up the extension declarations in the given pre-3.0 plug-in or fragment to compensate
	 * for extension points that were renamed between release 2.1 and 3.0.
	 * 
	 * @since 3.0
	 */
	private void fixRenamedExtensionPoints() {
		if (extensions == null || (schemaVersion != null && schemaVersion.equals("3.0")) || System.getProperties().get(NO_EXTENSION_MUNGING) != null)
			return;
		if (renamedUIextensionPoints == null) {
			// lazily initialize 
			final Map t = new HashMap(13);
			// TODO should this be hard coded? can we use a properties file?
			t.put("org.eclipse.ui.markerImageProvider", "org.eclipse.ui.ide.markerImageProvider"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.markerHelp", "org.eclipse.ui.ide.markerHelp"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.markerImageProviders", "org.eclipse.ui.ide.markerImageProviders"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.markerResolution", "org.eclipse.ui.ide.markerResolution"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.projectNatureImages", "org.eclipse.ui.ide.projectNatureImages"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.resourceFilters", "org.eclipse.ui.ide.resourceFilters"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.markerUpdaters", "org.eclipse.ui.editors.markerUpdaters"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.documentProviders", "org.eclipse.ui.editors.documentProviders"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.ui.workbench.texteditor.markerAnnotationSpecification", "org.eclipse.ui.editors.markerAnnotationSpecification"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.help.browser", "org.eclipse.help.base.browser"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.help.luceneAnalyzer", "org.eclipse.help.base.luceneAnalyzer"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.help.webapp", "org.eclipse.help.base.webapp"); //$NON-NLS-1$ //$NON-NLS-2$
			t.put("org.eclipse.help.support", "org.eclipse.ui.helpSupport"); //$NON-NLS-1$ //$NON-NLS-2$
			renamedUIextensionPoints = t;
		}
		for (int i = 0; i < extensions.length; i++) {
			Extension extension = (Extension) extensions[i];
			String oldPointId = extension.getExtensionPointIdentifier();
			String newPointId = (String) renamedUIextensionPoints.get(oldPointId);
			if (newPointId != null) {
				extension.setExtensionPointIdentifier(newPointId);
			}
		}
	}

	protected void setSchemaVersion(String schemaVersion) {
		this.schemaVersion = schemaVersion;
	}

	public long getId() {
		return bundleId;
	}

	public void setId(long value) {
		bundleId = value;
	}

	public String getResourceString(String value) {
		if (resourceBundle == null)
			resourceBundle = ResourceTranslator.getResourceBundle(InternalPlatform.getDefault().getBundleContext().getBundle(bundleId));
		if (resourceBundle == null)
			return value;
		return ResourceTranslator.getResourceString(null, value, resourceBundle);
	}
}