/*******************************************************************************
* Copyright (c) 2008-2010 Sonatype, Inc.
* 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:
* Sonatype, Inc. - initial API and implementation
*******************************************************************************/
package org.eclipse.m2e.internal.launch;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.debug.core.ILaunchConfiguration;
import org.eclipse.debug.core.sourcelookup.ISourceContainer;
import org.eclipse.debug.core.sourcelookup.ISourcePathComputer;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.launching.IRuntimeClasspathEntry;
import org.eclipse.jdt.launching.JavaRuntime;
import org.codehaus.plexus.util.DirectoryScanner;
import org.apache.maven.artifact.Artifact;
import org.eclipse.m2e.core.MavenPlugin;
import org.eclipse.m2e.core.embedder.IMaven;
import org.eclipse.m2e.core.embedder.IMavenLauncherConfiguration;
import org.eclipse.m2e.core.internal.launch.AbstractMavenRuntime;
import org.eclipse.m2e.core.project.IMavenProjectFacade;
/**
* Computes Maven launch configuration default source lookup path. Default source lookup includes Maven core libraries
* only. It does not (and cannot) include entries for any Maven plugins which are loaded dynamically at runtime.
*
* @author Eugene Kuleshov
*/
@SuppressWarnings({"restriction", "deprecation"})
public class MavenSourcePathComputer implements ISourcePathComputer {
public MavenSourcePathComputer() {
}
public String getId() {
return "org.eclipse.m2e.launching.MavenSourceComputer"; //$NON-NLS-1$
}
public ISourceContainer[] computeSourceContainers(ILaunchConfiguration configuration, IProgressMonitor monitor)
throws CoreException {
final List<IRuntimeClasspathEntry> entries = new ArrayList<IRuntimeClasspathEntry>();
IRuntimeClasspathEntry jreEntry = JavaRuntime.computeJREEntry(configuration);
if(jreEntry != null) {
entries.add(jreEntry);
}
AbstractMavenRuntime runtime = MavenLaunchUtils.getMavenRuntime(configuration);
IMavenLauncherConfiguration collector = new IMavenLauncherConfiguration() {
public void addArchiveEntry(String entry) {
addArchiveRuntimeClasspathEntry(entries, entry);
}
public void addProjectEntry(IMavenProjectFacade facade) {
IJavaProject javaProject = JavaCore.create(facade.getProject());
if(javaProject != null) {
entries.add(JavaRuntime.newDefaultProjectClasspathEntry(javaProject));
}
}
public void addRealm(String world) {
}
public void setMainType(String type, String world) {
}
};
for(String entry : MavenLaunchUtils.getCliResolver(runtime)) {
collector.addArchiveEntry(entry);
}
runtime.createLauncherConfiguration(collector, monitor);
IRuntimeClasspathEntry[] resolved = JavaRuntime.resolveSourceLookupPath( //
entries.toArray(new IRuntimeClasspathEntry[entries.size()]), configuration);
return JavaRuntime.getSourceContainers(resolved);
}
protected void addArchiveRuntimeClasspathEntry(List<IRuntimeClasspathEntry> entries, String entryPath) {
File entryFile = new File(entryPath);
if(!entryFile.exists()) {
return;
}
if(entryFile.isDirectory()) {
DirectoryScanner ds = new DirectoryScanner();
ds.setBasedir(entryFile);
ds.setIncludes(new String[] {"META-INF/maven/*/*/pom.properties", //$NON-NLS-1$
});
ds.scan();
String[] files = ds.getIncludedFiles();
for(String file : files) {
try {
BufferedInputStream is = new BufferedInputStream(new FileInputStream(new File(entryFile, file)));
try {
addArchiveRuntimeClasspathEntry(entries, entryPath, is);
} finally {
is.close();
}
} catch(IOException e) {
// ignore it
}
}
} else {
try {
JarFile jar = new JarFile(entryFile);
try {
Enumeration<JarEntry> zes = jar.entries();
while(zes.hasMoreElements()) {
JarEntry ze = zes.nextElement();
String name = ze.getName();
if(!ze.isDirectory() && name.startsWith("META-INF/maven/") && name.endsWith("pom.properties")) { //$NON-NLS-1$ //$NON-NLS-2$
addArchiveRuntimeClasspathEntry(entries, entryPath, jar.getInputStream(ze));
}
}
} finally {
jar.close();
}
} catch(IOException e) {
// ignore it
}
}
}
private void addArchiveRuntimeClasspathEntry(List<IRuntimeClasspathEntry> entries, String entryPath, InputStream is)
throws IOException {
Properties p = new Properties();
p.load(is);
String groupId = p.getProperty("groupId"); //$NON-NLS-1$
String artifactId = p.getProperty("artifactId"); //$NON-NLS-1$
String version = p.getProperty("version"); //$NON-NLS-1$
File sourcesJar = getSourcesJar(groupId, artifactId, version);
if(sourcesJar != null) {
IRuntimeClasspathEntry entry = null;
entry = JavaRuntime.newArchiveRuntimeClasspathEntry(Path.fromOSString(entryPath));
entry.setSourceAttachmentPath(Path.fromOSString(sourcesJar.getAbsolutePath()));
entries.add(entry);
}
}
private File getSourcesJar(String groupId, String artifactId, String version) {
if(groupId != null && artifactId != null && version != null) {
IMaven maven = MavenPlugin.getMaven();
try {
Artifact artifact = maven.resolve(groupId, artifactId, version, "jar", "sources", null, null); //$NON-NLS-1$ //$NON-NLS-2$
File file = artifact.getFile();
if(file != null && file.exists() && file.canRead()) {
return file;
}
} catch(CoreException ex) {
// artifact not found, most likely...
// TODO add special status code so it is possible to know for sure
}
}
return null;
}
}