/********************************************************************************
* CruiseControl, a Continuous Integration Toolkit
* Copyright (c) 2003, ThoughtWorks, Inc.
* 200 E. Randolph, 25th Floor
* Chicago, IL 60601 USA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* + Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* + Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/
package net.sourceforge.cruisecontrol.buildloggers;
import net.sourceforge.cruisecontrol.BuildLogger;
import net.sourceforge.cruisecontrol.CruiseControlException;
import net.sourceforge.cruisecontrol.util.PruneElementFilter;
import net.sourceforge.cruisecontrol.util.ValidationHelper;
import org.jdom.Element;
import org.jdom.JDOMException;
import org.jdom.input.SAXBuilder;
import org.apache.log4j.Logger;
import org.apache.oro.io.GlobFilenameFilter;
import org.apache.oro.text.MalformedCachePatternException;
import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.util.Arrays;
/**
* This BuildLogger implementation merges other XML logs into the CruiseControl
* main log. It can work with either a single file, or a directory. If a
* directory is specified, then all the XML files in that directory will be
* merged into the CruiseControl log.
*
*/
public class MergeLogger implements BuildLogger {
private static final Logger LOG = Logger.getLogger(MergeLogger.class);
private String file;
private String dir;
private String pattern = "*.xml";
private GlobFilenameFilter fileNameFilter;
private boolean removeProperties = true;
public void setFile(String file) {
this.file = file;
}
public void setDir(String dir) {
this.dir = dir;
}
/**
* Sets the pattern which the filenames in a directory must match.
* Default pattern is "*.xml". Invalidates the current filename
* filter. The filename filter is compiled using compilePattern().
* @param pattern a valid Jakarta-ORO Glob pattern.
*/
public void setPattern(String pattern) {
this.pattern = pattern;
this.fileNameFilter = null;
}
public void validate() throws CruiseControlException {
ValidationHelper.assertFalse(file == null && dir == null,
"one of file or dir are required attributes");
ValidationHelper.assertFalse(file != null && dir != null,
"only one of file or dir may be specified");
ValidationHelper.assertFalse(dir != null && pattern == null,
"no file pattern was specified");
compilePattern();
}
/**
* Compiles the pattern in the a filename filter. Only compiles
* if a pattern is specified and fileNameFilter == null.
* @throws CruiseControlException if an invalid pattern is specified.
*/
private void compilePattern() throws CruiseControlException {
if (fileNameFilter == null && pattern != null) {
try {
fileNameFilter = new GlobFilenameFilter(pattern);
} catch (MalformedCachePatternException e) {
ValidationHelper.fail("Invalid filename pattern " + pattern, e);
}
}
}
/**
* Note: the plugin must be {@link #validate() validated} before calling this method.
*/
public void log(Element buildLog) throws CruiseControlException {
String nextLogFilename = ((file != null) ? file : dir);
mergeFile(new File(nextLogFilename), buildLog);
}
/**
* Recursive method that merges the specified file into the buildLog. If
* the file is a directory, then all it's children that are XML files
* are merged matching the specified pattern.
*/
private void mergeFile(File nextLogFile, Element buildLog) {
if (!nextLogFile.exists()) {
LOG.info(nextLogFile.toString() + " does not exist. Skipping ...");
} else if (nextLogFile.isDirectory()) {
File[] children = nextLogFile.listFiles(new FileFilter() {
public boolean accept(File file) {
return file.isDirectory()
|| fileNameFilter.accept(file);
}
});
Arrays.sort(children);
for (int j = 0; j < children.length; j++) {
mergeFile(children[j], buildLog);
}
} else if (nextLogFile.isFile()) {
if (nextLogFile.length() == 0) {
LOG.warn(nextLogFile.toString() + " is empty. Skipping ...");
} else {
Element auxLogElement = getElement(nextLogFile);
if (auxLogElement != null) {
buildLog.addContent(auxLogElement.detach());
}
}
} else {
LOG.warn(nextLogFile.toString() + " is not a directory or a file. Skipping ...");
}
}
/**
* Get a JDOM <code>Element</code> from an XML file.
*
* @param xmlFile The file name to read.
* @return JDOM <code>Element</code> representing that xml file.
*/
Element getElement(File xmlFile) {
try {
SAXBuilder builder =
new SAXBuilder("org.apache.xerces.parsers.SAXParser");
if (removeProperties) {
builder.setXMLFilter(new PruneElementFilter("properties"));
}
return builder.build(xmlFile).getRootElement();
} catch (JDOMException e) {
LOG.warn("Could not read log: " + xmlFile + ". Skipping...", e);
} catch (IOException e) {
LOG.warn("Could not read log: " + xmlFile + ". Skipping...", e);
}
return null;
}
public void setRemoveProperties(boolean b) {
removeProperties = b;
}
}