blob: caa5aaf2dd927714adb9e3d5d8a035176859657f [file] [log] [blame]
/*******************************************************************************
* 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 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.core.internal.runtime;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.ArrayList;
import java.util.Map;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.osgi.framework.Bundle;
// This class provides implements the find* methods exposed on Platform.
// It does the lookup in bundles and fragments and does the variable replacement.
// Can only be used if OSGi is available.
public class FindSupport {
// OSGI system properties
public static final String PROP_NL = "osgi.nl"; //$NON-NLS-1$
public static final String PROP_OS = "osgi.os"; //$NON-NLS-1$
public static final String PROP_WS = "osgi.ws"; //$NON-NLS-1$
public static final String PROP_ARCH = "osgi.arch"; //$NON-NLS-1$
private static String[] NL_JAR_VARIANTS = buildNLVariants(Activator.getContext() == null ? System.getProperty(PROP_NL) : Activator.getContext().getProperty(PROP_NL));
private static String[] buildNLVariants(String nl) {
ArrayList result = new ArrayList();
IPath base = new Path("nl"); //$NON-NLS-1$
IPath path = new Path(nl.replace('_', '/'));
while (path.segmentCount() > 0) {
result.add(base.append(path).toString());
// for backwards compatibility only, don't replace the slashes
if (path.segmentCount() > 1)
result.add(base.append(path.toString().replace('/', '_')).toString());
path = path.removeLastSegments(1);
}
return (String[]) result.toArray(new String[result.size()]);
}
/**
* See doc on @link Platform#find(Bundle, IPath) Platform#find(Bundle, IPath)
*/
public static URL find(Bundle bundle, IPath path) {
return find(bundle, path, null);
}
/**
* See doc on @link Platform#find(Bundle, IPath, Map) Platform#find(Bundle, IPath, Map)
*/
public static URL find(Bundle b, IPath path, Map override) {
if (path == null)
return null;
URL result = null;
// Check for the empty or root case first
if (path.isEmpty() || path.isRoot()) {
// Watch for the root case. It will produce a new
// URL which is only the root directory (and not the
// root of this plugin).
result = findInPlugin(b, Path.EMPTY);
if (result == null)
result = findInFragments(b, Path.EMPTY);
return result;
}
// Now check for paths without variable substitution
String first = path.segment(0);
if (first.charAt(0) != '$') {
result = findInPlugin(b, path);
if (result == null)
result = findInFragments(b, path);
return result;
}
// Worry about variable substitution
IPath rest = path.removeFirstSegments(1);
if (first.equalsIgnoreCase("$nl$")) //$NON-NLS-1$
return findNL(b, rest, override);
if (first.equalsIgnoreCase("$os$")) //$NON-NLS-1$
return findOS(b, rest, override);
if (first.equalsIgnoreCase("$ws$")) //$NON-NLS-1$
return findWS(b, rest, override);
if (first.equalsIgnoreCase("$files$")) //$NON-NLS-1$
return null;
return null;
}
private static URL findOS(Bundle b, IPath path, Map override) {
String os = null;
if (override != null)
try {
// check for override
os = (String) override.get("$os$"); //$NON-NLS-1$
} catch (ClassCastException e) {
// just in case
}
if (os == null)
// use default
os = Activator.getContext().getProperty(PROP_OS);
if (os.length() == 0)
return null;
// Now do the same for osarch
String osArch = null;
if (override != null)
try {
// check for override
osArch = (String) override.get("$arch$"); //$NON-NLS-1$
} catch (ClassCastException e) {
// just in case
}
if (osArch == null)
// use default
osArch = Activator.getContext().getProperty(PROP_ARCH);
if (osArch.length() == 0)
return null;
URL result = null;
IPath base = new Path("os").append(os).append(osArch); //$NON-NLS-1$
// Keep doing this until all you have left is "os" as a path
while (base.segmentCount() != 1) {
IPath filePath = base.append(path);
result = findInPlugin(b, filePath);
if (result != null)
return result;
result = findInFragments(b, filePath);
if (result != null)
return result;
base = base.removeLastSegments(1);
}
// If we get to this point, we haven't found it yet.
// Look in the plugin and fragment root directories
result = findInPlugin(b, path);
if (result != null)
return result;
return findInFragments(b, path);
}
private static URL findWS(Bundle b, IPath path, Map override) {
String ws = null;
if (override != null)
try {
// check for override
ws = (String) override.get("$ws$"); //$NON-NLS-1$
} catch (ClassCastException e) {
// just in case
}
if (ws == null)
// use default
ws = Activator.getContext().getProperty(PROP_WS);
IPath filePath = new Path("ws").append(ws).append(path); //$NON-NLS-1$
// We know that there is only one segment to the ws path
// e.g. ws/win32
URL result = findInPlugin(b, filePath);
if (result != null)
return result;
result = findInFragments(b, filePath);
if (result != null)
return result;
// If we get to this point, we haven't found it yet.
// Look in the plugin and fragment root directories
result = findInPlugin(b, path);
if (result != null)
return result;
return findInFragments(b, path);
}
private static URL findNL(Bundle b, IPath path, Map override) {
String nl = null;
String[] nlVariants = null;
if (override != null)
try {
// check for override
nl = (String) override.get("$nl$"); //$NON-NLS-1$
} catch (ClassCastException e) {
// just in case
}
nlVariants = nl == null ? NL_JAR_VARIANTS : buildNLVariants(nl);
if (nl != null && nl.length() == 0)
return null;
URL result = null;
for (int i = 0; i < nlVariants.length; i++) {
IPath filePath = new Path(nlVariants[i]).append(path);
result = findInPlugin(b, filePath);
if (result != null)
return result;
result = findInFragments(b, filePath);
if (result != null)
return result;
}
// If we get to this point, we haven't found it yet.
// Look in the plugin and fragment root directories
result = findInPlugin(b, path);
if (result != null)
return result;
return findInFragments(b, path);
}
private static URL findInPlugin(Bundle b, IPath filePath) {
return b.getEntry(filePath.toString());
}
private static URL findInFragments(Bundle b, IPath filePath) {
Bundle[] fragments = CommonOSGiUtils.getDefault().getFragments(b);
if (fragments == null)
return null;
URL fileURL = null;
int i = 0;
while (i < fragments.length && fileURL == null) {
fileURL = fragments[i].getEntry(filePath.toString());
i++;
}
return fileURL;
}
/**
* See doc on @link Platform#openStream(Bundle, IPath, boolean) Platform#Platform#openStream(Bundle, IPath, boolean)
*/
public static final InputStream openStream(Bundle bundle, IPath file, boolean localized) throws IOException {
URL url = null;
if (!localized) {
url = findInPlugin(bundle, file);
if (url == null)
url = findInFragments(bundle, file);
} else {
url = FindSupport.find(bundle, file);
}
if (url != null)
return url.openStream();
throw new IOException("Cannot find " + file.toString()); //$NON-NLS-1$
}
}