package net.sf.dtddoc.maven;
   
   import java.io.File;
   import java.io.IOException;
   import java.util.ArrayList;
   import java.util.Collections;
   import java.util.HashSet;
   import java.util.Iterator;
  import java.util.List;
  import java.util.Locale;
  import java.util.Set;
  
  import DTDDoc.DTDCommenter;
  
  import org.apache.maven.doxia.sink.Sink;
  import org.apache.maven.doxia.siterenderer.Renderer;
  import org.apache.maven.plugins.annotations.Component;
  import org.apache.maven.plugins.annotations.Mojo;
  import org.apache.maven.plugins.annotations.Parameter;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.reporting.AbstractMavenReport;
  import org.apache.maven.reporting.MavenReportException;
  import org.codehaus.plexus.util.FileUtils;
  import org.codehaus.plexus.util.StringUtils;
  
  /**
   * DTDDoc Maven2 plugin, generates DTDDoc report.
   */
  @Mojo( name = "dtddoc", threadSafe = true )
  public class DTDDocReport extends AbstractMavenReport {
    /**
     * Specifies the destination directory where DTDDoc saves the generated HTML files.
     */
    @Parameter( defaultValue = "${project.build.directory}/dtddoc/", required = true )
    private File outputDirectory;
  
    /**
     * Specifies the source directory where DTDDoc searches for DTDs.
     */
    @Parameter( defaultValue = "src/main/resources", required = true )
    private File sourceDirectory;
  
    /**
     * List of patterns used to specify the files that should be included in DTD documentation.
     * When not specified, the default includes will be <code>**&#47;*.dtd</code>.
     */
    @Parameter
    private String[] includes;
  
    /**
     * List of patterns used to specify the files that should be excluded in DTD documentation.
     * When not specified, the default excludes will be empty.
     */
    @Parameter
    private String[] excludes;
  
    /**
     * Tells if the content of the <code>@hidden</code> tags must be part of the documentation
     */
    @Parameter( property = "dtddoc.hidden", defaultValue = "false", required = true )
    private boolean showHiddenTags = false;
  
    /**
     * Tells if the content of the <code>@fixme</code> tags must be part of the documentation
     */
    @Parameter( property = "dtddoc.fixme", defaultValue = "true", required = true )
    private boolean showFixmeTags = true;
  
    /**
     * In case you have comments that start with three hyphens, this option will tell DTDDoc
     * to interpret them as regular double hyphens. This was introduced to support NetBeans comments.
     */
    @Parameter( property = "dtddoc.getAroundNetBeansComments", defaultValue = "true", required = true )
    private boolean getAroundNetBeansComments = true;
  
    /**
     * Name of the documentation: it will appear at the top of the index.
     */
    @Parameter( property = "dtddoc.title" )
    private String docTitle = "";
  
    /**
     * The stylesheet to use to render the documentation. This stylesheet will be copied into the documentation.
     * If not specified, DTDDoc's default stylesheet is used.
     */
    @Parameter( property = "dtddoc.styleSheet" )
    private File styleSheet = null;
  
    /**
     * Doxia Site Renderer.
     */
    @Component
    protected Renderer siteRenderer;
  
    /**
     * Maven project
     */
    @Parameter( defaultValue = "${project}", required = true, readonly = true )
   private MavenProject project;
 
   public String getName(Locale locale) {
     return "DTDDoc";
   }
 
   public String getDescription(Locale locale) {
     return "DTD documentation";
   }
 
   /**
    * @see org.apache.maven.reporting.MavenReport#getOutputName()
    */
   public String getOutputName() {
     return "dtddoc/index";
   }
 
   /**
    * @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
    */
   protected String getOutputDirectory() {
     return outputDirectory.getAbsoluteFile().toString();
   }
 
   /**
    * @see org.apache.maven.reporting.AbstractMavenReport#getProject()
    */
   protected MavenProject getProject() {
     return project;
   }
 
   /**
    * @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()
    */
   protected Renderer getSiteRenderer() {
     return siteRenderer;
   }
 
   /**
    * @see org.apache.maven.reporting.MavenReport#generate(org.codehaus.doxia.sink.Sink, java.util.Locale)
    */
   public void generate(Sink sink, Locale locale) throws MavenReportException {
     executeReport(locale);
   }
 
   private List getDtdFiles() {
     if (! (sourceDirectory.exists() && sourceDirectory.isDirectory())) {
       return new ArrayList();
     }
 
     String includesAsString = "**/*.dtd";
     if (includes != null) {
       includesAsString = StringUtils.join(includes, "," );
     }
 
     String excludesAsString = "";
     if (excludes != null) {
       excludesAsString = StringUtils.join(excludes, "," );
     }
 
     try {
       return FileUtils.getFiles(sourceDirectory, includesAsString, excludesAsString, true);
     } catch (IOException ioe) {
       getLog().warn("unable to determine which DTDs to process", ioe);
     }
     return new ArrayList();
   }
 
   protected void executeReport(Locale locale) throws MavenReportException {
     Set dtds = new HashSet(getDtdFiles());
 
     File dtddocDirectory = getReportOutputDirectory();
     if (!dtddocDirectory.getAbsolutePath().equals(getOutputDirectory())) {
       // we're in site-embedded report mode, so Doxia has set the
       // reportOutputDirectory to the basedir of the site : append 'dtddoc'.
       dtddocDirectory = new File(dtddocDirectory, "dtddoc");
     }
     dtddocDirectory.mkdirs();
 
     try {
       getLog().info("documenting " + dtds.size() + " DTD(s), show @hidden tags: " + showHiddenTags + ", show @fixme tags: " + showFixmeTags);
       File commonBase = getCommonBase(sourceDirectory, dtds);
       if (! sourceDirectory.equals(commonBase)) {
         getLog().info("sourceDirectory optimized as " + commonBase.getPath());
       }
       DTDCommenter commenter = new DTDCommenter(new MavenLogger(getLog()));
       commenter
           .commentDTDs(dtds, commonBase, dtddocDirectory, showHiddenTags, showFixmeTags, getAroundNetBeansComments, docTitle, styleSheet);
     } catch (IOException ioe) {
       throw new MavenReportException("error while generating DTDDoc reports : " + ioe.getMessage(), ioe);
     } catch (Exception e) {
       throw new MavenReportException("error while generating DTDDoc reports : " + e.getMessage(), e);
     }
   }
 
   public boolean isExternalReport() {
     return true;
   }
 
   /**
    * @see org.apache.maven.reporting.MavenReport#canGenerateReport()
    */
   public boolean canGenerateReport() {
     return getDtdFiles().size() > 0;
   }
 
   protected static File[] getFileHierarchy(File from, File to) {
     List hierarchy = new ArrayList();
     hierarchy.add(to);
     while (! to.equals(from)) {
       to = to.getParentFile();
       hierarchy.add(to);
     }
     Collections.reverse(hierarchy);
     File[] files = new File[hierarchy.size()];
     return (File[])hierarchy.toArray(files);
   }
 
   protected File getCommonBase(File sourceDirectory, Set files) {
     if (files.size() == 1) {
       // if there is only one file, its directory is the "common" base
       return ((File)files.iterator().next()).getParentFile();
     }
 
     File[] base = null;
     for (Iterator iter = files.iterator(); iter.hasNext(); ) {
       File current = ((File)iter.next()).getParentFile();
       File[] currentHierarchy = getFileHierarchy(sourceDirectory, current);
       if (base == null) {
         base = currentHierarchy;
       } else {
         // compute the common file hierarchy between base and currentHierarchy
         int len = Math.min(base.length, currentHierarchy.length);
         List newHierarchy = new ArrayList();
         for (int i = 0; i < len; i++) {
           File a = base[i];
           File b = currentHierarchy[i];
           if (a.equals(b)) {
             // a directory is shared : great !
             newHierarchy.add(a);
           } else {
             // it's the first directory that is not shared : the common file hierarchy is over
             if (newHierarchy.size() == 1) {
               // we're already to the source directory : don't need to search further, we can't get better
               return sourceDirectory;
             }
             base = new File[newHierarchy.size()];
             newHierarchy.toArray(base);
             break;
           }
         }
       }
     }
     // Yes, this work has lead to a common base different than sourceDirectory
     return base[base.length - 1];
   }
 }