src/main/java/org/apache/maven/plugin/pmd/AbstractPmdReport.java - maven-pmd-plugin - Git at Google

 package org.apache.maven.plugin.pmd;

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.
  */

 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;

 import net.sourceforge.pmd.PMD;

 import org.apache.maven.doxia.siterenderer.Renderer;
 import org.apache.maven.model.ReportPlugin;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.reporting.AbstractMavenReport;
 import org.codehaus.plexus.util.FileUtils;
 import org.codehaus.plexus.util.PathTool;
 import org.codehaus.plexus.util.ReaderFactory;
 import org.codehaus.plexus.util.StringUtils;

 /**
  * Base class for the PMD reports.
  *
  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  * @version $Id$
  */
 public abstract class AbstractPmdReport
     extends AbstractMavenReport
 {
     /**
      * The output directory for the intermediate XML report.
      *
      * @parameter expression="${project.build.directory}"
      * @required
      */
     protected File targetDirectory;

     /**
      * The output directory for the final HTML report. Note that this parameter is only evaluated if the goal is run
      * directly from the command line or during the default lifecycle. If the goal is run indirectly as part of a site
      * generation, the output directory configured in the Maven Site Plugin is used instead.
      *
      * @parameter expression="${project.reporting.outputDirectory}"
      * @required
      */
     protected File outputDirectory;

     /**
      * Site rendering component for generating the HTML report.
      *
      * @component
      */
     private Renderer siteRenderer;

     /**
      * The project to analyse.
      *
      * @parameter expression="${project}"
      * @required
      * @readonly
      */
     protected MavenProject project;

     /**
      * Set the output format type, in addition to the HTML report.  Must be one of: "none",
      * "csv", "xml", "txt" or the full class name of the PMD renderer to use.
      * See the net.sourceforge.pmd.renderers package javadoc for available renderers.
      * XML is required if the pmd:check goal is being used.
      *
      * @parameter expression="${format}" default-value="xml"
      */
     protected String format = "xml";

     /**
      * Link the violation line numbers to the source xref. Links will be created
      * automatically if the jxr plugin is being used.
      *
      * @parameter expression="${linkXRef}" default-value="true"
      */
     private boolean linkXRef;

     /**
      * Location of the Xrefs to link to.
      *
      * @parameter default-value="${project.reporting.outputDirectory}/xref"
      */
     private File xrefLocation;

     /**
      * Location of the Test Xrefs to link to.
      *
      * @parameter default-value="${project.reporting.outputDirectory}/xref-test"
      */
     private File xrefTestLocation;

     /**
      * A list of files to exclude from checking. Can contain Ant-style wildcards and double wildcards. Note that these
      * exclusion patterns only operate on the path of a source file relative to its source root directory. In other
      * words, files are excluded based on their package and/or class name. If you want to exclude entire source root
      * directories, use the parameter <code>excludeRoots</code> instead.
      *
      * @parameter
      * @since 2.2
      */
     private String[] excludes;

     /**
      * A list of files to include from checking. Can contain Ant-style wildcards and double wildcards.
      * Defaults to **\/*.java.
      *
      * @parameter
      * @since 2.2
      */
     private String[] includes;

     /**
      * The directories containing the sources to be compiled.
      *
      * @parameter expression="${project.compileSourceRoots}"
      * @required
      * @readonly
      */
     private List compileSourceRoots;

     /**
      * The directories containing the test-sources to be compiled.
      *
      * @parameter expression="${project.testCompileSourceRoots}"
      * @required
      * @readonly
      */
     private List testSourceRoots;

     /**
      * The project source directories that should be excluded.
      *
      * @parameter
      * @since 2.2
      */
     private File[] excludeRoots;

     /**
      * Run PMD on the tests.
      *
      * @parameter default-value="false"
      * @since 2.2
      */
     protected boolean includeTests;

     /**
      * Whether to build an aggregated report at the root, or build individual reports.
      *
      * @parameter expression="${aggregate}" default-value="false"
      * @since 2.2
      */
     protected boolean aggregate;

     /**
      * The file encoding to use when reading the Java sources.
      *
      * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"
      * @since 2.3
      */
     private String sourceEncoding;

     /**
      * The file encoding when writing non-HTML reports.
      *
      * @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"
      * @since 2.5
      */
     private String outputEncoding;

     /**
      * The projects in the reactor for aggregation report.
      *
      * @parameter expression="${reactorProjects}"
      * @readonly
      */
     protected List reactorProjects;

     /** {@inheritDoc} */
     protected MavenProject getProject()
     {
         return project;
     }

     /** {@inheritDoc} */
     protected Renderer getSiteRenderer()
     {
         return siteRenderer;
     }

     protected String constructXRefLocation( boolean test )
     {
         String location = null;
         if ( linkXRef )
         {
             File xrefLoc = test ? xrefTestLocation : xrefLocation;

             String relativePath = PathTool.getRelativePath( outputDirectory.getAbsolutePath(), xrefLoc.getAbsolutePath() );
             if ( StringUtils.isEmpty( relativePath ) )
             {
                 relativePath = ".";
             }
             relativePath = relativePath + "/" + xrefLoc.getName();
             if ( xrefLoc.exists() )
             {
                 // XRef was already generated by manual execution of a lifecycle binding
                 location = relativePath;
             }
             else
             {
                 // Not yet generated - check if the report is on its way
                 for ( Iterator reports = project.getReportPlugins().iterator(); reports.hasNext(); )
                 {
                     ReportPlugin plugin = (ReportPlugin) reports.next();

                     String artifactId = plugin.getArtifactId();
                     if ( "maven-jxr-plugin".equals( artifactId ) || "jxr-maven-plugin".equals( artifactId ) )
                     {
                         location = relativePath;
                     }
                 }
             }

             if ( location == null )
             {
                 getLog().warn( "Unable to locate Source XRef to link to - DISABLED" );
             }
         }
         return location;
     }

     /**
      * Convenience method to get the list of files where the PMD tool will be executed
      *
      * @return a List of the files where the PMD tool will be executed
      * @throws java.io.IOException
      */
     protected Map getFilesToProcess()
         throws IOException
     {
         String sourceXref = constructXRefLocation( false );
         String testXref = includeTests ? constructXRefLocation( true ) : "";

         if ( aggregate && !project.isExecutionRoot() )
         {
             return Collections.EMPTY_MAP;
         }

         if ( excludeRoots == null )
         {
             excludeRoots = new File[0];
         }
         Collection excludeRootFiles = new HashSet( excludeRoots.length );

         for ( int i = 0; i < excludeRoots.length; i++ )
         {
             File file = excludeRoots[i];
             if ( file.isDirectory() )
             {
                 excludeRootFiles.add( file );
             }
         }

         List directories = new ArrayList();

         for ( Iterator i = compileSourceRoots.iterator(); i.hasNext(); )
         {
             String root = (String) i.next();
             File sroot = new File( root );
             directories.add( new PmdFileInfo( project, sroot, sourceXref ) );
         }

         if ( includeTests )
         {
             for ( Iterator i = testSourceRoots.iterator(); i.hasNext(); )
             {
                 String root = (String) i.next();
                 File sroot = new File( root );
                 directories.add( new PmdFileInfo( project, sroot, testXref ) );
             }
         }
         if ( aggregate )
         {
             for ( Iterator i = reactorProjects.iterator(); i.hasNext(); )
             {
                 MavenProject localProject = (MavenProject) i.next();
                 for ( Iterator i2 = localProject.getCompileSourceRoots().iterator(); i2.hasNext(); )
                 {
                     String root = (String) i2.next();
                     File sroot = new File( root );
                     directories.add( new PmdFileInfo( localProject, sroot, sourceXref ) );
                 }
                 if ( includeTests )
                 {
                     for ( Iterator i2 = localProject.getTestCompileSourceRoots().iterator(); i2.hasNext(); )
                     {
                         String root = (String) i2.next();
                         File sroot = new File( root );
                         directories.add( new PmdFileInfo( localProject, sroot, testXref ) );
                     }
                 }
             }

         }

         String excluding = getExcludes();
         getLog().debug( "Exclusions: " + excluding );
         String including = getIncludes();
         getLog().debug( "Inclusions: " + including );

         Map files = new TreeMap();

         for ( Iterator it = directories.iterator(); it.hasNext(); )
         {
             PmdFileInfo finfo = (PmdFileInfo) it.next();
             File sourceDirectory = finfo.getSourceDirectory();
             if ( sourceDirectory.isDirectory() && !excludeRootFiles.contains( sourceDirectory ) )
             {
                 List newfiles = FileUtils.getFiles( sourceDirectory, including, excluding );
                 for ( Iterator it2 = newfiles.iterator(); it2.hasNext(); )
                 {
                     files.put( it2.next(), finfo );
                 }
             }
         }

         return files;
     }

     /**
      * Gets the comma separated list of effective include patterns.
      *
      * @return The comma separated list of effective include patterns, never <code>null</code>.
      */
     private String getIncludes()
     {
         Collection patterns = new LinkedHashSet();
         if ( includes != null )
         {
             patterns.addAll( Arrays.asList( includes ) );
         }
         if ( patterns.isEmpty() )
         {
             patterns.add( "**/*.java" );
         }
         return StringUtils.join( patterns.iterator(), "," );
     }

     /**
      * Gets the comma separated list of effective exclude patterns.
      *
      * @return The comma separated list of effective exclude patterns, never <code>null</code>.
      */
     private String getExcludes()
     {
         Collection patterns = new LinkedHashSet( FileUtils.getDefaultExcludesAsList() );
         if ( excludes != null )
         {
             patterns.addAll( Arrays.asList( excludes ) );
         }
         return StringUtils.join( patterns.iterator(), "," );
     }

     protected boolean isHtml()
     {
         return "html".equals( format );
     }

     /** {@inheritDoc} */
     public boolean canGenerateReport()
     {
         if ( aggregate && !project.isExecutionRoot() )
         {
             return false;
         }

         if ( "pom".equals( project.getPackaging() ) && !aggregate )
         {
             return false;
         }

         // if format is XML, we need to output it even if the file list is empty
         // so the "check" goals can check for failures
         if ( "xml".equals( format ) )
         {
             return true;
         }
         try
         {
             Map filesToProcess = getFilesToProcess();
             if ( filesToProcess.isEmpty() )
             {
                 return false;
             }
         }
         catch ( IOException e )
         {
             getLog().error( e );
         }
         return true;
     }

     /** {@inheritDoc} */
     protected String getOutputDirectory()
     {
         return outputDirectory.getAbsolutePath();
     }

     protected String getSourceEncoding()
     {
         return sourceEncoding;
     }

     /**
      * Gets the effective reporting output files encoding.
      *
      * @return The effective reporting output file encoding, never <code>null</code>.
      * @since 2.5
      */
     protected String getOutputEncoding()
     {
         return ( outputEncoding != null ) ? outputEncoding : ReaderFactory.UTF_8;
     }

     static String getPmdVersion()
     {
         try
         {
             return (String) PMD.class.getField( "VERSION" ).get( null );
         }
         catch ( IllegalAccessException e )
         {
             throw new RuntimeException( "PMD VERSION field not accessible", e );
         }
         catch ( NoSuchFieldException e )
         {
             throw new RuntimeException( "PMD VERSION field not found", e );
         }
     }
 }
	package org.apache.maven.plugin.pmd;

	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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.
	*/

	import java.io.File;
	import java.io.IOException;
	import java.util.ArrayList;
	import java.util.Arrays;
	import java.util.Collection;
	import java.util.Collections;
	import java.util.HashSet;
	import java.util.Iterator;
	import java.util.LinkedHashSet;
	import java.util.List;
	import java.util.Map;
	import java.util.TreeMap;

	import net.sourceforge.pmd.PMD;

	import org.apache.maven.doxia.siterenderer.Renderer;
	import org.apache.maven.model.ReportPlugin;
	import org.apache.maven.project.MavenProject;
	import org.apache.maven.reporting.AbstractMavenReport;
	import org.codehaus.plexus.util.FileUtils;
	import org.codehaus.plexus.util.PathTool;
	import org.codehaus.plexus.util.ReaderFactory;
	import org.codehaus.plexus.util.StringUtils;

	/**
	* Base class for the PMD reports.
	*
	* @author <a href="mailto:brett@apache.org">Brett Porter</a>
	* @version $Id$
	*/
	public abstract class AbstractPmdReport
	extends AbstractMavenReport
	{
	/**
	* The output directory for the intermediate XML report.
	*
	* @parameter expression="${project.build.directory}"
	* @required
	*/
	protected File targetDirectory;

	/**
	* The output directory for the final HTML report. Note that this parameter is only evaluated if the goal is run
	* directly from the command line or during the default lifecycle. If the goal is run indirectly as part of a site
	* generation, the output directory configured in the Maven Site Plugin is used instead.
	*
	* @parameter expression="${project.reporting.outputDirectory}"
	* @required
	*/
	protected File outputDirectory;

	/**
	* Site rendering component for generating the HTML report.
	*
	* @component
	*/
	private Renderer siteRenderer;

	/**
	* The project to analyse.
	*
	* @parameter expression="${project}"
	* @required
	* @readonly
	*/
	protected MavenProject project;

	/**
	* Set the output format type, in addition to the HTML report. Must be one of: "none",
	* "csv", "xml", "txt" or the full class name of the PMD renderer to use.
	* See the net.sourceforge.pmd.renderers package javadoc for available renderers.
	* XML is required if the pmd:check goal is being used.
	*
	* @parameter expression="${format}" default-value="xml"
	*/
	protected String format = "xml";

	/**
	* Link the violation line numbers to the source xref. Links will be created
	* automatically if the jxr plugin is being used.
	*
	* @parameter expression="${linkXRef}" default-value="true"
	*/
	private boolean linkXRef;

	/**
	* Location of the Xrefs to link to.
	*
	* @parameter default-value="${project.reporting.outputDirectory}/xref"
	*/
	private File xrefLocation;

	/**
	* Location of the Test Xrefs to link to.
	*
	* @parameter default-value="${project.reporting.outputDirectory}/xref-test"
	*/
	private File xrefTestLocation;

	/**
	* A list of files to exclude from checking. Can contain Ant-style wildcards and double wildcards. Note that these
	* exclusion patterns only operate on the path of a source file relative to its source root directory. In other
	* words, files are excluded based on their package and/or class name. If you want to exclude entire source root
	* directories, use the parameter <code>excludeRoots</code> instead.
	*
	* @parameter
	* @since 2.2
	*/
	private String[] excludes;

	/**
	* A list of files to include from checking. Can contain Ant-style wildcards and double wildcards.
	* Defaults to *\/.java.
	*
	* @parameter
	* @since 2.2
	*/
	private String[] includes;

	/**
	* The directories containing the sources to be compiled.
	*
	* @parameter expression="${project.compileSourceRoots}"
	* @required
	* @readonly
	*/
	private List compileSourceRoots;

	/**
	* The directories containing the test-sources to be compiled.
	*
	* @parameter expression="${project.testCompileSourceRoots}"
	* @required
	* @readonly
	*/
	private List testSourceRoots;

	/**
	* The project source directories that should be excluded.
	*
	* @parameter
	* @since 2.2
	*/
	private File[] excludeRoots;

	/**
	* Run PMD on the tests.
	*
	* @parameter default-value="false"
	* @since 2.2
	*/
	protected boolean includeTests;

	/**
	* Whether to build an aggregated report at the root, or build individual reports.
	*
	* @parameter expression="${aggregate}" default-value="false"
	* @since 2.2
	*/
	protected boolean aggregate;

	/**
	* The file encoding to use when reading the Java sources.
	*
	* @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"
	* @since 2.3
	*/
	private String sourceEncoding;

	/**
	* The file encoding when writing non-HTML reports.
	*
	* @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"
	* @since 2.5
	*/
	private String outputEncoding;

	/**
	* The projects in the reactor for aggregation report.
	*
	* @parameter expression="${reactorProjects}"
	* @readonly
	*/
	protected List reactorProjects;

	/** {@inheritDoc} */
	protected MavenProject getProject()
	{
	return project;
	}

	/** {@inheritDoc} */
	protected Renderer getSiteRenderer()
	{
	return siteRenderer;
	}

	protected String constructXRefLocation( boolean test )
	{
	String location = null;
	if ( linkXRef )
	{
	File xrefLoc = test ? xrefTestLocation : xrefLocation;

	String relativePath = PathTool.getRelativePath( outputDirectory.getAbsolutePath(), xrefLoc.getAbsolutePath() );
	if ( StringUtils.isEmpty( relativePath ) )
	{
	relativePath = ".";
	}
	relativePath = relativePath + "/" + xrefLoc.getName();
	if ( xrefLoc.exists() )
	{
	// XRef was already generated by manual execution of a lifecycle binding
	location = relativePath;
	}
	else
	{
	// Not yet generated - check if the report is on its way
	for ( Iterator reports = project.getReportPlugins().iterator(); reports.hasNext(); )
	{
	ReportPlugin plugin = (ReportPlugin) reports.next();

	String artifactId = plugin.getArtifactId();
	if ( "maven-jxr-plugin".equals( artifactId ) \|\| "jxr-maven-plugin".equals( artifactId ) )
	{
	location = relativePath;
	}
	}
	}

	if ( location == null )
	{
	getLog().warn( "Unable to locate Source XRef to link to - DISABLED" );
	}
	}
	return location;
	}

	/**
	* Convenience method to get the list of files where the PMD tool will be executed
	*
	* @return a List of the files where the PMD tool will be executed
	* @throws java.io.IOException
	*/
	protected Map getFilesToProcess()
	throws IOException
	{
	String sourceXref = constructXRefLocation( false );
	String testXref = includeTests ? constructXRefLocation( true ) : "";

	if ( aggregate && !project.isExecutionRoot() )
	{
	return Collections.EMPTY_MAP;
	}

	if ( excludeRoots == null )
	{
	excludeRoots = new File[0];
	}
	Collection excludeRootFiles = new HashSet( excludeRoots.length );

	for ( int i = 0; i < excludeRoots.length; i++ )
	{
	File file = excludeRoots[i];
	if ( file.isDirectory() )
	{
	excludeRootFiles.add( file );
	}
	}

	List directories = new ArrayList();

	for ( Iterator i = compileSourceRoots.iterator(); i.hasNext(); )
	{
	String root = (String) i.next();
	File sroot = new File( root );
	directories.add( new PmdFileInfo( project, sroot, sourceXref ) );
	}

	if ( includeTests )
	{
	for ( Iterator i = testSourceRoots.iterator(); i.hasNext(); )
	{
	String root = (String) i.next();
	File sroot = new File( root );
	directories.add( new PmdFileInfo( project, sroot, testXref ) );
	}
	}
	if ( aggregate )
	{
	for ( Iterator i = reactorProjects.iterator(); i.hasNext(); )
	{
	MavenProject localProject = (MavenProject) i.next();
	for ( Iterator i2 = localProject.getCompileSourceRoots().iterator(); i2.hasNext(); )
	{
	String root = (String) i2.next();
	File sroot = new File( root );
	directories.add( new PmdFileInfo( localProject, sroot, sourceXref ) );
	}
	if ( includeTests )
	{
	for ( Iterator i2 = localProject.getTestCompileSourceRoots().iterator(); i2.hasNext(); )
	{
	String root = (String) i2.next();
	File sroot = new File( root );
	directories.add( new PmdFileInfo( localProject, sroot, testXref ) );
	}
	}
	}

	}

	String excluding = getExcludes();
	getLog().debug( "Exclusions: " + excluding );
	String including = getIncludes();
	getLog().debug( "Inclusions: " + including );

	Map files = new TreeMap();

	for ( Iterator it = directories.iterator(); it.hasNext(); )
	{
	PmdFileInfo finfo = (PmdFileInfo) it.next();
	File sourceDirectory = finfo.getSourceDirectory();
	if ( sourceDirectory.isDirectory() && !excludeRootFiles.contains( sourceDirectory ) )
	{
	List newfiles = FileUtils.getFiles( sourceDirectory, including, excluding );
	for ( Iterator it2 = newfiles.iterator(); it2.hasNext(); )
	{
	files.put( it2.next(), finfo );
	}
	}
	}

	return files;
	}

	/**
	* Gets the comma separated list of effective include patterns.
	*
	* @return The comma separated list of effective include patterns, never <code>null</code>.
	*/
	private String getIncludes()
	{
	Collection patterns = new LinkedHashSet();
	if ( includes != null )
	{
	patterns.addAll( Arrays.asList( includes ) );
	}
	if ( patterns.isEmpty() )
	{
	patterns.add( "*/.java" );
	}
	return StringUtils.join( patterns.iterator(), "," );
	}

	/**
	* Gets the comma separated list of effective exclude patterns.
	*
	* @return The comma separated list of effective exclude patterns, never <code>null</code>.
	*/
	private String getExcludes()
	{
	Collection patterns = new LinkedHashSet( FileUtils.getDefaultExcludesAsList() );
	if ( excludes != null )
	{
	patterns.addAll( Arrays.asList( excludes ) );
	}
	return StringUtils.join( patterns.iterator(), "," );
	}

	protected boolean isHtml()
	{
	return "html".equals( format );
	}

	/** {@inheritDoc} */
	public boolean canGenerateReport()
	{
	if ( aggregate && !project.isExecutionRoot() )
	{
	return false;
	}

	if ( "pom".equals( project.getPackaging() ) && !aggregate )
	{
	return false;
	}

	// if format is XML, we need to output it even if the file list is empty
	// so the "check" goals can check for failures
	if ( "xml".equals( format ) )
	{
	return true;
	}
	try
	{
	Map filesToProcess = getFilesToProcess();
	if ( filesToProcess.isEmpty() )
	{
	return false;
	}
	}
	catch ( IOException e )
	{
	getLog().error( e );
	}
	return true;
	}

	/** {@inheritDoc} */
	protected String getOutputDirectory()
	{
	return outputDirectory.getAbsolutePath();
	}

	protected String getSourceEncoding()
	{
	return sourceEncoding;
	}

	/**
	* Gets the effective reporting output files encoding.
	*
	* @return The effective reporting output file encoding, never <code>null</code>.
	* @since 2.5
	*/
	protected String getOutputEncoding()
	{
	return ( outputEncoding != null ) ? outputEncoding : ReaderFactory.UTF_8;
	}

	static String getPmdVersion()
	{
	try
	{
	return (String) PMD.class.getField( "VERSION" ).get( null );
	}
	catch ( IllegalAccessException e )
	{
	throw new RuntimeException( "PMD VERSION field not accessible", e );
	}
	catch ( NoSuchFieldException e )
	{
	throw new RuntimeException( "PMD VERSION field not found", e );
	}
	}
	}