359 lines
13 KiB
Java
359 lines
13 KiB
Java
/*******************************************************************************
|
|
* Copyright (c) 2007 IBM Corporation.
|
|
* 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 com.ibm.wala.eclipse.util;
|
|
|
|
import java.io.File;
|
|
import java.io.FileNotFoundException;
|
|
import java.io.IOException;
|
|
import java.util.ArrayList;
|
|
import java.util.Collection;
|
|
import java.util.Collections;
|
|
import java.util.HashMap;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
import java.util.Set;
|
|
import java.util.jar.JarFile;
|
|
import java.util.zip.ZipException;
|
|
|
|
import org.eclipse.core.resources.IFile;
|
|
import org.eclipse.core.resources.IProject;
|
|
import org.eclipse.core.resources.IWorkspace;
|
|
import org.eclipse.core.resources.IWorkspaceRoot;
|
|
import org.eclipse.core.resources.ResourcesPlugin;
|
|
import org.eclipse.core.runtime.CoreException;
|
|
import org.eclipse.core.runtime.IPath;
|
|
import org.eclipse.jdt.core.IClasspathContainer;
|
|
import org.eclipse.jdt.core.IClasspathEntry;
|
|
import org.eclipse.jdt.core.IJavaProject;
|
|
import org.eclipse.jdt.core.JavaCore;
|
|
import org.eclipse.jdt.core.JavaModelException;
|
|
import org.eclipse.osgi.service.resolver.BundleDescription;
|
|
import org.eclipse.pde.core.plugin.IPluginModelBase;
|
|
import org.eclipse.pde.internal.core.ClasspathUtilCore;
|
|
import org.eclipse.pde.internal.core.PDECore;
|
|
import org.eclipse.pde.internal.core.PDEStateHelper;
|
|
|
|
import com.ibm.wala.classLoader.BinaryDirectoryTreeModule;
|
|
import com.ibm.wala.classLoader.EclipseSourceFileModule;
|
|
import com.ibm.wala.classLoader.FileModule;
|
|
import com.ibm.wala.classLoader.JarFileModule;
|
|
import com.ibm.wala.classLoader.Module;
|
|
import com.ibm.wala.classLoader.SourceDirectoryTreeModule;
|
|
import com.ibm.wala.client.AbstractAnalysisEngine;
|
|
import com.ibm.wala.ipa.callgraph.AnalysisScope;
|
|
import com.ibm.wala.types.ClassLoaderReference;
|
|
import com.ibm.wala.util.collections.HashSetFactory;
|
|
import com.ibm.wala.util.collections.MapUtil;
|
|
import com.ibm.wala.util.config.AnalysisScopeReader;
|
|
import com.ibm.wala.util.debug.Assertions;
|
|
|
|
/**
|
|
* Representation of an analysis scope from an Eclipse project.
|
|
*
|
|
* We set up classloaders as follows:
|
|
* <ul>
|
|
* <li>The project being analyzed is in the Application Loader
|
|
* <li>Projects on which the main project depends are in the Extension loader
|
|
* <li>System libraries are in the primordial loader.
|
|
* <li>Source modules go in a special Source loader.
|
|
* </ul>
|
|
*
|
|
* @author sjfink
|
|
* @author jdolby (some code moved here from EclipseProjectAnalysisEngine)
|
|
* @author smarkstr (added support for language file extensions)
|
|
*
|
|
*/
|
|
@SuppressWarnings("restriction")
|
|
public class EclipseProjectPath {
|
|
|
|
public enum Loader {
|
|
APPLICATION(ClassLoaderReference.Application), EXTENSION(ClassLoaderReference.Extension), PRIMORDIAL(
|
|
ClassLoaderReference.Primordial);
|
|
|
|
private ClassLoaderReference ref;
|
|
|
|
Loader(ClassLoaderReference ref) {
|
|
this.ref = ref;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* The project whose path this object represents
|
|
*/
|
|
private final IJavaProject project;
|
|
|
|
// names of OSGi bundles already processed.
|
|
private final Set<String> bundlesProcessed = HashSetFactory.make();
|
|
|
|
// SJF: Intentionally do not use HashMapFactory, since the Loader keys in the following must use
|
|
// identityHashCode. TODO: fix this source of non-determinism?
|
|
private final Map<Loader, List<Module>> modules = new HashMap<Loader, List<Module>>();
|
|
|
|
private final Collection<IClasspathEntry> alreadyResolved = HashSetFactory.make();
|
|
|
|
protected EclipseProjectPath(IJavaProject project, boolean analyzeSource) throws IOException, CoreException {
|
|
if (project == null) {
|
|
throw new IllegalArgumentException("null project");
|
|
}
|
|
this.project = project;
|
|
assert project != null;
|
|
for (Loader loader : Loader.values()) {
|
|
MapUtil.findOrCreateList(modules, loader);
|
|
}
|
|
resolveProjectClasspathEntries();
|
|
if (isPluginProject(project)) {
|
|
resolvePluginClassPath(project.getProject());
|
|
}
|
|
}
|
|
|
|
@Deprecated
|
|
public static EclipseProjectPath make(IPath workspaceRootPath, IJavaProject project) throws IOException, CoreException {
|
|
return new EclipseProjectPath(project, false);
|
|
}
|
|
|
|
public static EclipseProjectPath make(IJavaProject project) throws IOException, CoreException {
|
|
return make(project, false);
|
|
}
|
|
|
|
@Deprecated
|
|
public static EclipseProjectPath make(IJavaProject project, boolean analyzeSource) throws IOException, CoreException {
|
|
if (project == null) {
|
|
throw new IllegalArgumentException("null project");
|
|
}
|
|
return new EclipseProjectPath(project, analyzeSource);
|
|
}
|
|
|
|
/**
|
|
* Figure out what a classpath entry means and add it to the appropriate set of modules
|
|
*/
|
|
private void resolveClasspathEntry(IClasspathEntry entry, Loader loader) throws JavaModelException, IOException {
|
|
IClasspathEntry e = JavaCore.getResolvedClasspathEntry(entry);
|
|
if (alreadyResolved.contains(e)) {
|
|
return;
|
|
} else {
|
|
alreadyResolved.add(e);
|
|
}
|
|
|
|
if (e.getEntryKind() == IClasspathEntry.CPE_CONTAINER) {
|
|
IClasspathContainer cont = JavaCore.getClasspathContainer(entry.getPath(), project);
|
|
IClasspathEntry[] entries = cont.getClasspathEntries();
|
|
resolveClasspathEntries(entries, cont.getKind() == IClasspathContainer.K_APPLICATION ? loader : Loader.PRIMORDIAL);
|
|
} else if (e.getEntryKind() == IClasspathEntry.CPE_LIBRARY) {
|
|
File file = makeAbsolute(e.getPath()).toFile();
|
|
JarFile j;
|
|
try {
|
|
j = new JarFile(file);
|
|
} catch (ZipException z) {
|
|
// a corrupted file. ignore it.
|
|
return;
|
|
} catch (FileNotFoundException z) {
|
|
// should ignore directories as well..
|
|
return;
|
|
}
|
|
if (isPrimordialJarFile(j)) {
|
|
List<Module> s = MapUtil.findOrCreateList(modules, loader);
|
|
s.add(file.isDirectory() ? (Module) new BinaryDirectoryTreeModule(file) : (Module) new JarFileModule(j));
|
|
}
|
|
} else if (e.getEntryKind() == IClasspathEntry.CPE_SOURCE) {
|
|
final File dir = makeAbsolute(e.getPath()).toFile();
|
|
final File relDir = e.getPath().removeFirstSegments(1).toFile();
|
|
List<Module> s = MapUtil.findOrCreateList(modules, loader);
|
|
s.add(new SourceDirectoryTreeModule(dir) {
|
|
@Override
|
|
protected FileModule makeFile(File file) {
|
|
assert file.toString().startsWith(dir.toString()) : file + " " + dir + " " + relDir;
|
|
file = new File(file.toString().substring(dir.toString().length()));
|
|
IFile f = project.getProject().getFile(relDir.toString() + file.toString());
|
|
return new EclipseSourceFileModule(f);
|
|
}
|
|
});
|
|
if (e.getOutputLocation() != null) {
|
|
File output = makeAbsolute(e.getOutputLocation()).toFile();
|
|
s = MapUtil.findOrCreateList(modules, loader);
|
|
s.add(new BinaryDirectoryTreeModule(output));
|
|
}
|
|
} else if (e.getEntryKind() == IClasspathEntry.CPE_PROJECT) {
|
|
IPath projectPath = makeAbsolute(e.getPath());
|
|
IWorkspace ws = ResourcesPlugin.getWorkspace();
|
|
IWorkspaceRoot root = ws.getRoot();
|
|
IProject project = (IProject) root.getContainerForLocation(projectPath);
|
|
try {
|
|
if (project.hasNature(JavaCore.NATURE_ID)) {
|
|
IJavaProject javaProject = JavaCore.create(project);
|
|
if (isPluginProject(javaProject)) {
|
|
resolvePluginClassPath(javaProject.getProject());
|
|
}
|
|
resolveClasspathEntries(javaProject.getRawClasspath(), loader);
|
|
File output = makeAbsolute(javaProject.getOutputLocation()).toFile();
|
|
List<Module> s = MapUtil.findOrCreateList(modules, loader);
|
|
s.add(new BinaryDirectoryTreeModule(output));
|
|
}
|
|
} catch (CoreException e1) {
|
|
e1.printStackTrace();
|
|
Assertions.UNREACHABLE();
|
|
}
|
|
} else {
|
|
throw new RuntimeException("unexpected entry " + e);
|
|
}
|
|
}
|
|
|
|
private void resolvePluginClassPath(IProject p) throws CoreException, IOException {
|
|
BundleDescription bd = findModel(p).getBundleDescription();
|
|
if (bd == null) {
|
|
throw new IllegalStateException("bundle description was null for " + p);
|
|
}
|
|
resolveBundleDescriptionClassPath(bd, Loader.APPLICATION);
|
|
}
|
|
|
|
private void resolveBundleDescriptionClassPath(BundleDescription bd, Loader loader) throws CoreException, IOException {
|
|
assert bd != null;
|
|
if (alreadyProcessed(bd)) {
|
|
return;
|
|
}
|
|
bundlesProcessed.add(bd.getName());
|
|
|
|
// handle the classpath entries for bd
|
|
ArrayList l = new ArrayList();
|
|
ClasspathUtilCore.addLibraries(findModel(bd), l);
|
|
IClasspathEntry[] entries = new IClasspathEntry[l.size()];
|
|
int i = 0;
|
|
for (Object o : l) {
|
|
IClasspathEntry e = (IClasspathEntry) o;
|
|
entries[i++] = e;
|
|
}
|
|
resolveClasspathEntries(entries, loader);
|
|
|
|
// recurse to handle dependencies. put these in the Extension loader
|
|
for (BundleDescription b : PDEStateHelper.getImportedBundles(bd)) {
|
|
resolveBundleDescriptionClassPath(b, Loader.EXTENSION);
|
|
}
|
|
for (BundleDescription b : bd.getResolvedRequires()) {
|
|
resolveBundleDescriptionClassPath(b, Loader.EXTENSION);
|
|
}
|
|
for (BundleDescription b : bd.getFragments()) {
|
|
resolveBundleDescriptionClassPath(b, Loader.EXTENSION);
|
|
}
|
|
}
|
|
|
|
private boolean alreadyProcessed(BundleDescription bd) {
|
|
return bundlesProcessed.contains(bd.getName());
|
|
}
|
|
|
|
private boolean isPluginProject(IJavaProject javaProject) {
|
|
IPluginModelBase model = findModel(javaProject.getProject());
|
|
if (model == null) {
|
|
return false;
|
|
}
|
|
if (model.getPluginBase().getId() == null) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @return true if the given jar file should be handled by the Primordial loader. If false, other provisions should be made to add
|
|
* the jar file to the appropriate component of the AnalysisScope. Subclasses can override this method.
|
|
*/
|
|
protected boolean isPrimordialJarFile(JarFile j) {
|
|
return true;
|
|
}
|
|
|
|
protected void resolveClasspathEntries(IClasspathEntry[] entries, Loader loader) throws JavaModelException, IOException {
|
|
for (int i = 0; i < entries.length; i++) {
|
|
resolveClasspathEntry(entries[i], loader);
|
|
}
|
|
}
|
|
|
|
protected IPath makeAbsolute(IPath p) {
|
|
if (p.toFile().exists()) {
|
|
return p;
|
|
}
|
|
String projectName = p.segment(0);
|
|
IJavaProject jp = JdtUtil.getJavaProject(projectName);
|
|
if (jp != null) {
|
|
if (jp.getProject().getRawLocation() != null) {
|
|
return jp.getProject().getRawLocation().append(p.removeFirstSegments(1));
|
|
} else {
|
|
IWorkspaceRoot workspaceRoot = ResourcesPlugin.getWorkspace().getRoot();
|
|
return workspaceRoot.getLocation().append(p);
|
|
}
|
|
} else {
|
|
Assertions.UNREACHABLE("Unsupported path " + p);
|
|
return null;
|
|
}
|
|
}
|
|
|
|
private void resolveProjectClasspathEntries() throws JavaModelException, IOException {
|
|
resolveClasspathEntries(project.getRawClasspath(), Loader.EXTENSION);
|
|
}
|
|
|
|
/**
|
|
* Convert this path to a WALA analysis scope
|
|
*/
|
|
public AnalysisScope toAnalysisScope(ClassLoader classLoader, File exclusionsFile) {
|
|
AnalysisScope scope = AnalysisScopeReader.readJavaScope(AbstractAnalysisEngine.SYNTHETIC_J2SE_MODEL, exclusionsFile,
|
|
classLoader);
|
|
return toAnalysisScope(scope);
|
|
}
|
|
|
|
public AnalysisScope toAnalysisScope(AnalysisScope scope) {
|
|
try {
|
|
List<Module> l = MapUtil.findOrCreateList(modules, Loader.APPLICATION);
|
|
File dir = makeAbsolute(project.getOutputLocation()).toFile();
|
|
if (!dir.isDirectory()) {
|
|
System.err.println("PANIC: project output location is not a directory: " + dir);
|
|
} else {
|
|
l.add(new BinaryDirectoryTreeModule(dir));
|
|
}
|
|
|
|
for (Loader loader : Loader.values()) {
|
|
for (Module m : modules.get(loader)) {
|
|
scope.addToScope(loader.ref, m);
|
|
}
|
|
}
|
|
return scope;
|
|
} catch (JavaModelException e) {
|
|
e.printStackTrace();
|
|
Assertions.UNREACHABLE();
|
|
return null;
|
|
}
|
|
}
|
|
|
|
public AnalysisScope toAnalysisScope(final File exclusionsFile) {
|
|
return toAnalysisScope(getClass().getClassLoader(), exclusionsFile);
|
|
}
|
|
|
|
public AnalysisScope toAnalysisScope() {
|
|
return toAnalysisScope(getClass().getClassLoader(), null);
|
|
}
|
|
|
|
public Collection<Module> getModules(Loader loader, boolean binary) {
|
|
return Collections.unmodifiableCollection(modules.get(loader));
|
|
}
|
|
|
|
@Override
|
|
public String toString() {
|
|
return toAnalysisScope((File) null).toString();
|
|
}
|
|
|
|
private IPluginModelBase findModel(IProject p) {
|
|
// PluginRegistry is specific to Eclipse 3.3+. Use PDECore for compatibility with 3.2
|
|
// return PluginRegistry.findModel(p);
|
|
return PDECore.getDefault().getModelManager().findModel(p);
|
|
}
|
|
|
|
private IPluginModelBase findModel(BundleDescription bd) {
|
|
// PluginRegistry is specific to Eclipse 3.3+. Use PDECore for compatibility with 3.2
|
|
// return PluginRegistry.findModel(bd);
|
|
return PDECore.getDefault().getModelManager().findModel(bd);
|
|
}
|
|
}
|