add parameter to allow analyzing jsp/xhtml files for public code use

Author: evernat

src/main/java/dcd/DcdHelper.java

@@ -153,7 +153,9 @@ static File unzipIntoTempDirectory(File file) throws IOException {
 			final Enumeration<? extends ZipEntry> entries = zipFile.entries();
 			while (entries.hasMoreElements() && !Thread.currentThread().isInterrupted()) {
 				final ZipEntry zipEntry = entries.nextElement();
-				if (zipEntry.getName().endsWith(".class") && !zipEntry.isDirectory()) {
+				final boolean toBeCopied = zipEntry.getName().endsWith(".class")
+						|| isViewFile(zipEntry.getName());
+				if (toBeCopied && !zipEntry.isDirectory()) {
 					final File tmpFile = new File(tmpDirectory, zipEntry.getName());
 					if (!tmpFile.getParentFile().exists() && !tmpFile.getParentFile().mkdirs()) {
 						throw new IOException(tmpFile.getParentFile() + " can't be created");
@@ -175,6 +177,10 @@ static File unzipIntoTempDirectory(File file) throws IOException {
 		return tmpDirectory;
 	}
 
+	static boolean isViewFile(String fileName) {
+		return fileName.endsWith(".xhtml") || fileName.endsWith(".jsp");
+	}
+
 	private static void copy(byte[] buffer, InputStream input, OutputStream output)
 			throws IOException {
 		int read = input.read(buffer);

src/main/java/dcd/DeadCodeDetector.java

@@ -19,13 +19,17 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.regex.Pattern;
 
 import javax.xml.stream.XMLStreamException;
 
@@ -147,6 +151,29 @@ private void launchAnalyze(String dir) throws IOException, XMLStreamException {
 		}
 	}
 
+	private void analyzeViewFiles(File dir, Map<String, Pattern> patternsByMethod)
+			throws IOException {
+		for (final File file : DcdHelper.listFiles(dir)) {
+			if (isInterrupted()) {
+				break;
+			}
+			if (file.isDirectory()) {
+				analyzeViewFiles(file, patternsByMethod);
+			} else if (DcdHelper.isViewFile(file.getName())) {
+				final byte[] bytes = Files.readAllBytes(file.toPath());
+				final String string = new String(bytes, StandardCharsets.UTF_8);
+				for (final Map.Entry<String, Pattern> entry : patternsByMethod.entrySet()) {
+					final Pattern pattern = entry.getValue();
+					if (pattern.matcher(string).matches()) {
+						final String method = entry.getKey();
+						result.methodCalled(method);
+						patternsByMethod.remove(method);
+					}
+				}
+			}
+		}
+	}
+
 	private void analyzeDirectory(String dir, String packageName)
 			throws IOException, XMLStreamException {
 		final Set<String> classNameList = listClassesAndAnalyzeSubDirectories(dir, packageName);
@@ -226,11 +253,11 @@ private Set<String> listClassesAndAnalyzeSubDirectories(String dir, String packa
 			if (isInterrupted()) {
 				break;
 			}
-			final String name = packageName != null ? packageName + '.' + file.getName()
-					: file.getName();
-			if (file.isDirectory() && file.getName().indexOf('.') == -1) {
+			final String fileName = file.getName();
+			final String name = packageName != null ? packageName + '.' + fileName : fileName;
+			if (file.isDirectory() && fileName.indexOf('.') == -1) {
 				analyzeDirectory(dir, name);
-			} else if (file.getName().endsWith(".class")) {
+			} else if (fileName.endsWith(".class")) {
 				classNameList.add(name.substring(0, name.length() - ".class".length()));
 			}
 		}
@@ -542,6 +569,18 @@ private void launchAllAnalyses() throws IOException, XMLStreamException {
 						// analyse des classes du répertoire WEB-INF/classes du war
 						launchAnalyze(tmpDirectory.getPath() + webInfClasses);
 					}
+					if (parameters.includesViewFiles() && currentStep == Step.PUBLIC_ANALYSIS) {
+						final Set<String> allMethods = result.getAllMethods();
+						final Map<String, Pattern> patternsByMethod = new ConcurrentHashMap<>();
+						for (final String method : allMethods) {
+							// regex to search with word boundaries, for less false negatives in view files
+							final String regex = ".*\\b" + DcdHelper.getMethodName(method)
+									+ "\\b.*";
+							final Pattern pattern = Pattern.compile(regex, Pattern.DOTALL);
+							patternsByMethod.put(method, pattern);
+						}
+						analyzeViewFiles(tmpDirectory, patternsByMethod);
+					}
 				} else {
 					// analyse des classes du jar
 					launchAnalyze(tmpDirectory.getPath());

src/main/java/dcd/Parameters.java

@@ -47,6 +47,7 @@ public class Parameters {
 	private static final String LOCAL_DEAD_CODE_KEY = "localDeadCode";
 	private static final String INIT_DEAD_CODE_KEY = "initDeadCode";
 	private static final String XML_REPORT_FILE_KEY = "xmlReportFile";
+	private static final String INCLUDE_VIEW_FILES_KEY = "includeViewFiles";
 	private static final String SEPARATORS = "[;,]";
 	private final List<File> directories;
 	private final List<Pattern> excludedClasses;
@@ -56,6 +57,7 @@ public class Parameters {
 	private final boolean localDeadCode;
 	private final boolean initDeadCode;
 	private File xmlReportFile; // can be null
+	private final boolean includeViewFiles;
 
 	/**
 	 * Constructeur.
@@ -84,6 +86,8 @@ public Parameters(Properties properties) {
 		xmlReportFile = properties.getProperty(XML_REPORT_FILE_KEY) == null
 				|| properties.getProperty(XML_REPORT_FILE_KEY).trim().isEmpty() ? null
 						: new File(properties.getProperty(XML_REPORT_FILE_KEY));
+		includeViewFiles = Boolean.valueOf(properties.getProperty(INCLUDE_VIEW_FILES_KEY,
+				System.getProperty(INCLUDE_VIEW_FILES_KEY)));
 	}
 
 	/**
@@ -115,6 +119,7 @@ public Parameters(List<File> directories, boolean publicDeadCode, boolean privat
 				: Collections.<Pattern> emptyList();
 		this.excludedMethods = excludedMethods != null ? excludedMethods
 				: Collections.<Pattern> emptyList();
+		this.includeViewFiles = Boolean.valueOf(System.getProperty(INCLUDE_VIEW_FILES_KEY));
 	}
 
 	/**
@@ -131,6 +136,7 @@ public static Parameters createFromSystemProperties() {
 		properties.put(LOCAL_DEAD_CODE_KEY, System.getProperty(LOCAL_DEAD_CODE_KEY));
 		properties.put(INIT_DEAD_CODE_KEY, System.getProperty(INIT_DEAD_CODE_KEY));
 		properties.put(XML_REPORT_FILE_KEY, System.getProperty(XML_REPORT_FILE_KEY));
+		properties.put(INCLUDE_VIEW_FILES_KEY, System.getProperty(INCLUDE_VIEW_FILES_KEY));
 		return new Parameters(properties);
 	}
 
@@ -313,6 +319,13 @@ public void setXmlReportFile(File xmlReporFile) {
 		this.xmlReportFile = xmlReporFile;
 	}
 
+	/**
+	 * @return includes jsp/xhtml files for public dead code analysis
+	 */
+	public boolean includesViewFiles() {
+		return includeViewFiles;
+	}
+
 	/**
 	 * @param xmlReportFileName Nom du fichier pour export xml ou null sinon
 	 */

src/main/java/dcd/Report.java

@@ -123,6 +123,10 @@ void close(long durationMillis, int suspectCount, int analyzedClassCount, File x
 
 	void reportDeadCodeSuspects(boolean publicDeadCode, String asmClassName, Set<String> descs)
 			throws XMLStreamException {
+		if (descs.isEmpty()) {
+			// analyzeViewFiles peut avoir laisser des listes vides
+			return;
+		}
 		final String type = publicDeadCode ? "publicDeadCode" : "privateDeadCode";
 		final String className = Type.getObjectType(asmClassName).getClassName();
 		final String msg = (publicDeadCode ? "Public suspects in class "

src/main/java/dcd/Result.java

@@ -331,6 +331,20 @@ private Set<String> getJavaMethods(String asmClassName) {
 		return methods;
 	}
 
+	Set<String> getAllMethods() {
+		final Set<String> result = new HashSet<>();
+		for (final Set<String> methods : methodsByClassMap.values()) {
+			result.addAll(methods);
+		}
+		return result;
+	}
+
+	void methodCalled(String methodKey) {
+		for (final Set<String> methods : methodsByClassMap.values()) {
+			methods.remove(methodKey);
+		}
+	}
+
 	void methodCalled(String className, String name, String desc) {
 		methodCalled(className, name, desc, methodsByClassMap);
 	}