Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package sootup.java.bytecode.inputlocation;
/*-
* #%L
* Soot
* %%
* Copyright (C) 2018-2020 Manuel Benz, Christian Brüggemann, Kaustubh Kelkar and others
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 2.1 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
import java.io.*;
import java.nio.file.*;
import java.util.*;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import sootup.core.frontend.AbstractClassSource;
import sootup.core.inputlocation.AnalysisInputLocation;
import sootup.core.model.SourceType;
import sootup.core.types.ClassType;
import sootup.core.util.PathUtils;
import sootup.core.util.StreamUtils;
import sootup.core.views.View;
import sootup.java.core.JavaSootClass;
/**
* An implementation of the {@link AnalysisInputLocation} interface for the Java class path. Handles
* directories, archives (including wildcard denoted archives) as stated in the official
* documentation: https://docs.oracle.com/javase/8/docs/technotes/tools/windows/classpath.html
*
* @author Manuel Benz created on 22.05.18
* @author Kaustubh Kelkar updated on 20.07.2020
*/
public class JavaClassPathAnalysisInputLocation implements AnalysisInputLocation {
private static final @Nonnull Logger logger =
LoggerFactory.getLogger(JavaClassPathAnalysisInputLocation.class);
private static final @Nonnull String WILDCARD_CHAR = "*";
@Nonnull private final Collection> cpEntries;
/** Variable to track if user has specified the SourceType. By default, it will be set to null. */
private SourceType srcType = null;
/**
* Creates a {@link JavaClassPathAnalysisInputLocation} which locates classes in the given class
* path.
*
* @param classPath The class path to search in
*/
public JavaClassPathAnalysisInputLocation(@Nonnull String classPath) {
if (classPath.length() <= 0) {
throw new IllegalStateException("Empty class path given");
}
cpEntries = explodeClassPath(classPath);
if (cpEntries.isEmpty()) {
throw new IllegalStateException("Empty class path is given.");
}
}
/**
* Creates a {@link JavaClassPathAnalysisInputLocation} which locates classes in the given class
* path.
*
* @param classPath the class path to search in
* @param srcType the source type for the path can be Library, Application, Phantom.
*/
public JavaClassPathAnalysisInputLocation(
@Nonnull String classPath, @Nullable SourceType srcType) {
if (classPath.length() <= 0) {
throw new IllegalStateException("Empty class path given");
}
setSpecifiedAsBuiltInByUser(srcType);
cpEntries = explodeClassPath(classPath);
if (cpEntries.isEmpty()) {
throw new IllegalStateException("Empty class path is given.");
}
}
/**
* The method sets the value of the variable srcType.
*
* @param srcType the source type for the path can be Library, Application, Phantom.
*/
public void setSpecifiedAsBuiltInByUser(@Nullable SourceType srcType) {
this.srcType = srcType;
}
@Override
public SourceType getSourceType() {
return srcType;
}
/**
* Explode the class or modulepath entries, separated by {@link File#pathSeparator}.
*
* @param paths entries as one string
* @param fileSystem filesystem in which the paths are resolved
* @return path entries
*/
static @Nonnull Stream explode(@Nonnull String paths, FileSystem fileSystem) {
// the classpath is split at every path separator which is not escaped
String regex = "(? exploded =
Stream.of(paths.split(regex)).flatMap(e -> handleWildCards(e, fileSystem));
// we need to filter out duplicates of the same files to not generate duplicate input locations
return exploded.map(Path::normalize).distinct();
}
/**
* Explode the class or modulepath entries, separated by {@link File#pathSeparator}.
*
* @param paths entries as one string
* @return path entries
*/
static @Nonnull Stream explode(@Nonnull String paths) {
return explode(paths, FileSystems.getDefault());
}
/**
* The class path can have directories with wildcards as entries. All jar/JAR files inside those
* directories have to be added to the class path.
*
* @param entry A class path entry
* @param fileSystem The filesystem the paths should be resolved for
* @return A stream of class path entries with wildcards exploded
*/
private static @Nonnull Stream handleWildCards(
@Nonnull String entry, FileSystem fileSystem) {
if (entry.endsWith(WILDCARD_CHAR)) {
Path baseDir = fileSystem.getPath(entry.substring(0, entry.indexOf(WILDCARD_CHAR)));
try {
return StreamUtils.iteratorToStream(
Files.newDirectoryStream(baseDir, "*.{jar,JAR}").iterator());
} catch (PatternSyntaxException | NotDirectoryException e) {
throw new IllegalStateException("Malformed wildcard entry", e);
} catch (IOException e) {
throw new IllegalStateException("Couldn't access entries denoted by wildcard", e);
}
} else {
return Stream.of(fileSystem.getPath(entry));
}
}
/**
* The class path can have directories with wildcards as entries. All jar/JAR files inside those
* directories have to be added to the class path.
*
* @param entry A class path entry
* @return A stream of class path entries with wildcards exploded
*/
private static @Nonnull Stream handleWildCards(@Nonnull String entry) {
return handleWildCards(entry, FileSystems.getDefault());
}
@Override
@Nonnull
public Collection> getClassSources(
@Nonnull View view) {
// By using a set here, already added classes won't be overwritten and the class which is found
// first will be kept
Set> found = new HashSet<>();
for (AnalysisInputLocation inputLocation : cpEntries) {
found.addAll(inputLocation.getClassSources(view));
}
return found;
}
@Override
@Nonnull
public Optional> getClassSource(
@Nonnull ClassType type, @Nonnull View view) {
for (AnalysisInputLocation inputLocation : cpEntries) {
final Optional> classSource =
inputLocation.getClassSource(type, view);
if (classSource.isPresent()) {
return classSource;
}
}
return Optional.empty();
}
@Nonnull
private Optional> inputLocationForPath(@Nonnull Path path) {
if (Files.exists(path) && (Files.isDirectory(path) || PathUtils.isArchive(path))) {
return Optional.of(new PathBasedAnalysisInputLocation(path, srcType));
} else {
logger.warn("Invalid/Unknown class path entry: " + path);
return Optional.empty();
}
}
/**
* extract the classes from the classpath
*
* @param jarPath The jar path for which the classes need to be listed
* @return list of classpath entries
*/
private List> explodeClassPath(@Nonnull String jarPath) {
return explodeClassPath(jarPath, FileSystems.getDefault());
}
/**
* extract the classes from the classpath
*
* @param jarPath The jar path for which the classes need to be listed
* @param fileSystem the filesystem the path should be resolved for
* @return list of classpath entries
*/
private List> explodeClassPath(
@Nonnull String jarPath, @Nonnull FileSystem fileSystem) {
try {
return explode(jarPath, fileSystem)
.flatMap(cp -> StreamUtils.optionalToStream(inputLocationForPath(cp)))
.collect(Collectors.toList());
} catch (IllegalArgumentException e) {
throw new IllegalStateException("Malformed class path given: " + jarPath, e);
}
}
@Override
public int hashCode() {
return cpEntries.hashCode();
}
@Override
public boolean equals(Object o) {
if (!(o instanceof JavaClassPathAnalysisInputLocation)) {
return false;
}
return cpEntries.equals(((JavaClassPathAnalysisInputLocation) o).cpEntries);
}
}
