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.Iterator;
import java.util.List;
import java.util.Map.Entry;

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

/**
 * Output bug list in XML format.
 */
public class XMLOutput extends StructuredOutput {

    /**
     * Line separator.
     */
    private static final String LINE_SEPARATOR = "line.separator";

    /**
     * Output bug list in XML format.
     */
    public void output(final BugList bugList, final Writer writer, final CFLintStats stats) throws IOException {
        final BugCounts counts = stats.getCounts();

        outputStartIssues(writer, stats);

        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) {
                outputStartIssue(writer, bugEntry);
                do {
                    outputLocation(writer, bugInfo);
                    prevbugInfo = bugInfo;
                    bugInfo = iterator.hasNext() ? iterator.next() : null;
                } while (bugInfo != null && isGrouped(prevbugInfo, bugInfo));
                outputCloseIssue(writer);
            }
        }

        outputCounts(writer, stats, counts);
        outputCloseIssues(writer);
        writer.close();
    }

    /**
     * Output start of XML issues.
     */
    private void outputStartIssues(final Writer writer, final CFLintStats stats) throws IOException {
        writer.append("")
                .append(System.getProperty(LINE_SEPARATOR));
    }

    /**
     * Output close of XML issues.
     */
    private void outputCloseIssues(final Writer writer) throws IOException {
        writer.append("");
    }

    /**
     * Output start of XML issue.
     */
    private void outputStartIssue(final Writer writer, final Entry> bugEntry) throws IOException {
        final String severity = bugEntry.getValue().get(0).getSeverity().toString();
        final String code = bugEntry.getValue().get(0).getMessageCode();
        writer.append("");
    }

    /**
     * Output start of XML issue location.
     */
    private void outputLocation(final Writer writer, final BugInfo bugInfo) throws IOException {
        writer.append("");
        writer.append("", ""))
                .append("]]>");
        writer.append("").append(System.getProperty(LINE_SEPARATOR));
    }

    /**
     * Output end of XML issue.
     */
    private void outputCloseIssue(Writer writer) throws IOException {
        writer.append("").append(System.getProperty(LINE_SEPARATOR));
    }

    /**
     * Output XML count statistics.
     */
    private void outputCounts(final Writer writer, final CFLintStats stats, final BugCounts counts) throws IOException {
        writer.append("").append(System.getProperty(LINE_SEPARATOR));

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

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

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

    /**
     * Output findbugs XML format.
     */
    public void outputFindBugs(final BugList bugList, final Writer writer, final CFLintStats stats)
            throws IOException, TransformerException {

        final StringWriter sw = new StringWriter();
        output(bugList, sw, stats);

        // 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 StreamSource(is));

        // 3. Use the Transformer to transform an XML Source and send the output to a Result object.
        transformer.transform(new StreamSource(new StringReader(sw.toString())), new StreamResult(writer));

        writer.close();
    }

    /**
     * XML escape a character sequence.
     */
    private 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);
                }
                break;
            }
        }
        return sb.toString();
    }
}