com.cflint.XMLOutput Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CFLint Show documentation
A static code analysis tool for ColdFusion (in the spirit of FindBugs and Lint). With CFLint, you are able to analyze your ColdFusion code base for code violations.
There is a newer version: 1.5.0
Show newest version
package com.cflint;

import java.io.IOException;
import java.io.InputStream;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Map.Entry;

import javax.xml.transform.TransformerException;
import javax.xml.transform.stream.StreamSource;

public class XMLOutput {

	public static final String LINE_SEPARATOR = "line.separator";

	public void output(final BugList bugList, final Writer writer, final boolean showStats) throws IOException {
		final BugCounts counts = new BugCounts();
		// final StringBuilder sb = new StringBuilder();
		writer.append("").append(System.getProperty(LINE_SEPARATOR));
		for (final Entry> bugEntry : bugList.getBugList().entrySet()) {
			final Iterator iterator = bugEntry.getValue().iterator();
			BugInfo bugInfo = iterator.hasNext() ? iterator.next() : null;
			BugInfo prevbugInfo;

			while (bugInfo != null) {
				final String severity = bugEntry.getValue().get(0).getSeverity();
				final String code = bugEntry.getValue().get(0).getMessageCode();
				counts.add(code, severity);
				writer.append("");
				do {
					writer.append("");
					writer.append("", ""))
							.append("]]>");
					writer.append("").append(System.getProperty(LINE_SEPARATOR));
					prevbugInfo = bugInfo;
					bugInfo = iterator.hasNext() ? iterator.next() : null;
				} while (isGrouped(prevbugInfo, bugInfo));
				// writer.append("
				// function=\"").append(bugInfo.getFunction()).append("\"");
				writer.append("").append(System.getProperty(LINE_SEPARATOR));
			}
		}

		if (showStats) {
			writer.append("").append(System.getProperty(LINE_SEPARATOR));

			for (final String code : counts.bugTypes()) {
				writer.append("");
				writer.append(System.getProperty(LINE_SEPARATOR));
			}

			for (final String severity : BugCounts.levels) {
				if (counts.getSeverity(severity) > 0) {
					writer.append("");
					writer.append(System.getProperty(LINE_SEPARATOR));
				}
			}

			writer.append("").append(System.getProperty(LINE_SEPARATOR));
		}

		writer.append("");
		writer.close();
	}

	List CODE_GROUPBY_FUNCTION = Arrays.asList("PARSE_ERROR");

	private boolean isGrouped(final BugInfo prevbugInfo, final BugInfo bugInfo) {
		if (prevbugInfo == null || bugInfo == null) {
			return false;
		}
		// Different message types are not grouped
		if (!safeEquals(prevbugInfo.getMessageCode(), bugInfo.getMessageCode())) {
			return false;
		}
		// Different files are not grouped
		if (!safeEquals(prevbugInfo.getFilename(), bugInfo.getFilename())) {
			return false;
		}
		// Some message codes (such as parse error are grouped at the function
		// level
		if (CODE_GROUPBY_FUNCTION.contains(bugInfo.getMessageCode())
				&& safeEquals(prevbugInfo.getFunction(), bugInfo.getFunction())) {
			return true;
		}
		return false;
	}

	private boolean safeEquals(final String a, final String b) {
		return a != null && b != null && a.equals(b);
	}

	public void outputFindBugs(final BugList bugList, final Writer writer, final boolean showStats)
			throws IOException, TransformerException {
		final StringWriter sw = new StringWriter();
		output(bugList, sw, showStats);
		// 1. Instantiate a TransformerFactory.
		final javax.xml.transform.TransformerFactory tFactory = javax.xml.transform.TransformerFactory.newInstance();

		// 2. Use the TransformerFactory to process the stylesheet Source and
		// generate a Transformer.

		final InputStream is = getClass().getResourceAsStream("/findbugs/cflint-to-findbugs.xsl");
		final javax.xml.transform.Transformer transformer = tFactory
				.newTransformer(new javax.xml.transform.stream.StreamSource(is));

		// 3. Use the Transformer to transform an XML Source and send the
		// output to a Result object.
		System.out.println(sw.toString());
		transformer.transform(new StreamSource(new StringReader(sw.toString())),
				new javax.xml.transform.stream.StreamResult(writer));
		writer.close();
	}

	private CharSequence filename(final String filename) {
		if (filename == null) {
			return "";
		}
		return filename.substring(Math.max(filename.lastIndexOf('/'), filename.lastIndexOf('\\')) + 1);
	}

	private CharSequence abbrev(final String messageCode) {
		if (messageCode.length() <= 2) {
			return messageCode;
		}
		final String[] ms = messageCode.split("_");
		if (ms.length >= 2) {
			return (ms[0].substring(0, 1) + ms[1].substring(0, 1)).toUpperCase();
		} else {
			return ms[0].substring(0, 2).toUpperCase();
		}
	}

	String xmlEscapeText(final CharSequence t) {
		if (t == null) {
			return "";
		}
		final StringBuilder sb = new StringBuilder();
		for (int i = 0; i < t.length(); i++) {
			final char c = t.charAt(i);
			switch (c) {
			case '<':
				sb.append("<");
				break;
			case '>':
				sb.append(">");
				break;
			case '\"':
				sb.append(""");
				break;
			case '&':
				sb.append("&");
				break;
			case '\'':
				sb.append("'");
				break;
			default:
				if (c > 0x7e) {
					sb.append("&#" + ((int) c) + ";");
				} else {
					sb.append(c);
				}
			}
		}
		return sb.toString();
	}
}