- /*
- * Copyright 2001-2002,2004 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- */
- package org.apache.tools.ant.taskdefs.optional.metamata;
-
- import java.io.BufferedReader;
- import java.io.IOException;
- import java.io.InputStream;
- import java.io.InputStreamReader;
- import java.io.OutputStream;
- import java.util.Date;
- import java.util.Enumeration;
- import java.util.Hashtable;
- import java.util.Vector;
- import javax.xml.parsers.DocumentBuilder;
- import javax.xml.parsers.DocumentBuilderFactory;
- import org.apache.tools.ant.BuildException;
- import org.apache.tools.ant.Project;
- import org.apache.tools.ant.taskdefs.ExecuteStreamHandler;
- import org.apache.tools.ant.taskdefs.LogOutputStream;
- import org.apache.tools.ant.taskdefs.StreamPumper;
- import org.apache.tools.ant.util.DOMElementWriter;
- import org.apache.tools.ant.util.DateUtils;
- import org.w3c.dom.Document;
- import org.w3c.dom.Element;
-
- /**
- * This is a very bad stream handler for the MAudit task.
- * All report to stdout that does not match a specific report pattern is dumped
- * to the Ant output as warn level. The report that match the pattern is stored
- * in a map with the key being the filepath that caused the error report.
- * <p>
- * The limitation with the choosen implementation is clear:
- * <ul>
- * <li>it does not handle multiline report( message that has \n ). the part until
- * the \n will be stored and the other part (which will not match the pattern)
- * will go to Ant output in Warn level.
- * <li>it does not report error that goes to stderr.
- * </ul>
- *
- */
- class MAuditStreamHandler implements ExecuteStreamHandler {
-
- /** parent task */
- private MAudit task;
-
- /** reader for stdout */
- private BufferedReader br;
-
- /**
- * this is where the XML output will go, should mostly be a file
- * the caller is responsible for flushing and closing this stream
- */
- private OutputStream xmlOut = null;
-
- /** error stream, might be useful to spit out error messages */
- private OutputStream errStream;
-
- /** thread pumping out error stream */
- private Thread errThread;
-
- /**
- * the multimap. The key in the map is the filepath that caused the audit
- * error and the value is a vector of MAudit.Violation entries.
- */
- private Hashtable auditedFiles = new Hashtable();
-
- /** program start timestamp for reporting purpose */
- private Date program_start;
-
- MAuditStreamHandler(MAudit task, OutputStream xmlOut) {
- this.task = task;
- this.xmlOut = xmlOut;
- }
-
- /** Ignore. */
- public void setProcessInputStream(OutputStream os) {
- }
-
- /** Ignore. */
- public void setProcessErrorStream(InputStream is) {
- errStream = new LogOutputStream(task, Project.MSG_ERR);
- errThread = createPump(is, errStream);
- }
-
- /** Set the inputstream */
- public void setProcessOutputStream(InputStream is) throws IOException {
- br = new BufferedReader(new InputStreamReader(is));
- }
-
- /** Invokes parseOutput. This will block until the end :-(*/
- public void start() throws IOException {
- program_start = new Date();
- errThread.start();
- parseOutput(br);
- }
-
- /**
- * Pretty dangerous business here. It serializes what was extracted from
- * the MAudit output and write it to the output.
- */
- public void stop() {
- // make sure to flush err stream
- try {
- errThread.join();
- } catch (InterruptedException e) {
- }
- try {
- errStream.flush();
- } catch (IOException e) {
- }
- // serialize the content as XML, move this to another method
- // this is the only code that could be needed to be overriden
- Document doc = getDocumentBuilder().newDocument();
- Element rootElement = doc.createElement("classes");
- Enumeration keys = auditedFiles.keys();
- Hashtable filemapping = task.getFileMapping();
- final Date now = new Date();
- rootElement.setAttribute("snapshot_created",
- DateUtils.format(now, DateUtils.ISO8601_DATETIME_PATTERN));
- rootElement.setAttribute("elapsed_time",
- String.valueOf(now.getTime() - program_start.getTime()));
- rootElement.setAttribute("program_start",
- DateUtils.format(now, DateUtils.ISO8601_DATETIME_PATTERN));
- rootElement.setAttribute("audited",
- String.valueOf(filemapping.size()));
- rootElement.setAttribute("reported",
- String.valueOf(auditedFiles.size()));
- int errors = 0;
- while (keys.hasMoreElements()) {
- String filepath = (String) keys.nextElement();
- Vector v = (Vector) auditedFiles.get(filepath);
- String fullclassname = (String) filemapping.get(filepath);
- if (fullclassname == null) {
- task.getProject().log("Could not find class mapping for "
- + filepath, Project.MSG_WARN);
- continue;
- }
- int pos = fullclassname.lastIndexOf('.');
- String pkg = (pos == -1) ? "" : fullclassname.substring(0, pos);
- String clazzname = (pos == -1) ? fullclassname : fullclassname.substring(pos + 1);
- Element clazz = doc.createElement("class");
- clazz.setAttribute("package", pkg);
- clazz.setAttribute("name", clazzname);
- final int violationCount = v.size();
- clazz.setAttribute("violations", String.valueOf(violationCount));
- errors += violationCount;
- for (int i = 0; i < violationCount; i++) {
- MAuditParser.Violation violation = (MAuditParser.Violation) v.elementAt(i);
- Element error = doc.createElement("violation");
- error.setAttribute("line", violation.line);
- error.setAttribute("message", violation.error);
- clazz.appendChild(error);
- }
- rootElement.appendChild(clazz);
- }
- rootElement.setAttribute("violations", String.valueOf(errors));
-
- // now write it to the outputstream, not very nice code
- DOMElementWriter domWriter = new DOMElementWriter();
- try {
- domWriter.write(rootElement, xmlOut);
- } catch (IOException e) {
- throw new BuildException(e);
- }
- }
-
- protected static DocumentBuilder getDocumentBuilder() {
- try {
- return DocumentBuilderFactory.newInstance().newDocumentBuilder();
- } catch (Exception exc) {
- throw new ExceptionInInitializerError(exc);
- }
- }
-
- /**
- * Creates a stream pumper to copy the given input stream to the given output stream.
- */
- protected Thread createPump(InputStream is, OutputStream os) {
- final Thread result = new Thread(new StreamPumper(is, os));
- result.setDaemon(true);
- return result;
- }
-
-
- /** read each line and process it */
- protected void parseOutput(BufferedReader br) throws IOException {
- String line = null;
- final MAuditParser parser = new MAuditParser();
- while ((line = br.readLine()) != null) {
- final MAuditParser.Violation violation = parser.parseLine(line);
- if (violation != null) {
- addViolation(violation.file, violation);
- } else {
- // this doesn't match..report it as info, it could be
- // either the copyright, summary or a multiline message (damn !)
- task.log(line, Project.MSG_INFO);
- }
- }
- }
-
- /** add a violation entry for the file */
- private void addViolation(String file, MAuditParser.Violation entry) {
- Vector violations = (Vector) auditedFiles.get(file);
- // if there is no decl for this file yet, create it.
- if (violations == null) {
- violations = new Vector();
- auditedFiles.put(file, violations);
- }
- violations.addElement(entry);
- }
-
- }