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.util.Iterator;

 import java.util.Map;

 import java.util.ResourceBundle;

 import net.sourceforge.pmd.PMD;

 import net.sourceforge.pmd.cpd.Match;

 import org.apache.maven.project.MavenProject;

 import org.codehaus.doxia.sink.Sink;

 import org.codehaus.plexus.util.StringUtils;

 /**

  * Class that generated the CPD report.

  *

  * @author mperham

  * @version $Id: $

  */

 public class CpdReportGenerator

 {

     private Sink sink;

     private Map fileMap;

     private ResourceBundle bundle;

     private boolean aggregate;

     public CpdReportGenerator( Sink sink, Map fileMap, ResourceBundle bundle, boolean aggregate )

     {

         this.sink = sink;

         this.fileMap = fileMap;

         this.bundle = bundle;

         this.aggregate = aggregate;

     }

     /**

      * Method that returns the title of the CPD Report

      *

      * @return a String that contains the title

      */

     private String getTitle()

     {

         return bundle.getString( "report.cpd.title" );

     }

     /**

      * Method that generates the start of the CPD report.

      */

     public void beginDocument()

     {

         sink.head();

         sink.title();

         sink.text( getTitle() );

         sink.title_();

         sink.head_();

         sink.body();

         sink.section1();

         sink.sectionTitle1();

         sink.text( getTitle() );

         sink.sectionTitle1_();

         sink.paragraph();

         sink.text( bundle.getString( "report.cpd.cpdlink" ) + " " );

         sink.link( "http://pmd.sourceforge.net/cpd.html" );

         sink.text( "CPD" );

         sink.link_();

         sink.text( " " + PMD.VERSION + "." );

         sink.paragraph_();

         // TODO overall summary

         sink.section1_();

         sink.section1();

         sink.sectionTitle1();

         sink.text( bundle.getString( "report.cpd.dupes" ) );

         sink.sectionTitle1_();

         // TODO files summary

     }

     /**

      * Method that generates the contents of the CPD report

      *

      * @param matches

      */

     public void generate( Iterator matches )

     {

         beginDocument();

         if ( !matches.hasNext() )

         {

             sink.text( "CPD found no problems in your source code." );            

         }

         while ( matches.hasNext() )

         {

             Match match = (Match) matches.next();

             String filename1 = match.getFirstMark().getTokenSrcID();

             File file = new File( filename1 );

             PmdFileInfo fileInfo = (PmdFileInfo) fileMap.get( file );

             File sourceDirectory = fileInfo.getSourceDirectory();

             String xrefLocation = fileInfo.getXrefLocation();

             MavenProject projectFile1 = fileInfo.getProject();

             filename1 = StringUtils.substring( filename1, sourceDirectory.getAbsolutePath().length() + 1 );

             String filename2 = match.getSecondMark().getTokenSrcID();

             file = new File( filename2 );

             fileInfo = (PmdFileInfo) fileMap.get( file );

             sourceDirectory = fileInfo.getSourceDirectory();

             String xrefLocation2 = fileInfo.getXrefLocation();

             filename2 = StringUtils.substring( filename2, sourceDirectory.getAbsolutePath().length() + 1 );

             MavenProject projectFile2 = fileInfo.getProject();

             String code = match.getSourceCodeSlice();

             int line1 = match.getFirstMark().getBeginLine();

             int line2 = match.getSecondMark().getBeginLine();

             sink.paragraph();

             sink.table();

             sink.tableRow();

             sink.tableHeaderCell();

             sink.text( bundle.getString( "report.cpd.column.file" ) );

             sink.tableHeaderCell_();

             if ( aggregate )

             {

                 sink.tableHeaderCell();

                 sink.text( bundle.getString( "report.cpd.column.project" ) );

                 sink.tableHeaderCell_();

             }

             sink.tableHeaderCell();

             sink.text( bundle.getString( "report.cpd.column.line" ) );

             sink.tableHeaderCell_();

             sink.tableRow_();

             // File 1

             sink.tableRow();

             sink.tableCell();

             sink.text( filename1 );

             sink.tableCell_();

             if ( aggregate )

             {

                 sink.tableCell();

                 sink.text( projectFile1.getName() );

                 sink.tableCell_();

             }

             sink.tableCell();

             if ( xrefLocation != null )

             {

                 sink.link( xrefLocation + "/" + filename1.replaceAll( "\\.java$", ".html" ).replace( '\\', '/' ) 

                            + "#" + line1 );

             }

             sink.text( String.valueOf( line1 ) );

             if ( xrefLocation != null )

             {

                 sink.link_();

             }

             sink.tableCell_();

             sink.tableRow_();

             // File 2

             sink.tableRow();

             sink.tableCell();

             sink.text( filename2 );

             sink.tableCell_();

             if ( aggregate )

             {

                 sink.tableCell();

                 sink.text( projectFile2.getName() );

                 sink.tableCell_();

             }

             sink.tableCell();

             if ( xrefLocation != null )

             {

                 sink.link( xrefLocation2 + "/" + filename2.replaceAll( "\\.java$", ".html" ).replace( '\\', '/' ) 

                            + "#" + line2 );

             }

             sink.text( String.valueOf( line2 ) );

             if ( xrefLocation != null )

             {

                 sink.link_();

             }

             sink.tableCell_();

             sink.tableRow_();

             // Source snippet

             sink.tableRow();

             int colspan = 2;

             if ( aggregate ) 

             {

                 ++colspan;

             }        

             // TODO Cleaner way to do this?

             sink.rawText( "<td colspan='" + colspan + "'>" );

             sink.verbatim( false );

             sink.text( code );

             sink.verbatim_();

             sink.rawText( "</td>" );

             sink.tableRow_();

             sink.table();

             sink.paragraph_();

         }

         sink.section1_();

         sink.body_();

         sink.flush();

         sink.close();

     }

 }