/*
    * Copyright 2007-2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.maven.exceptions;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.List;
  import java.util.Locale;
  import java.util.ResourceBundle;
  
  import org.apache.maven.artifact.DependencyResolutionRequiredException;
  import org.apache.maven.doxia.sink.Sink;
  import org.apache.maven.plugin.logging.Log;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.reporting.MavenReportException;
  
  import de.smartics.exceptions.report.ReportBuilder;
  import de.smartics.exceptions.report.ReportConfiguration;
  import de.smartics.exceptions.report.data.InMemoryExceptionCodesReport;
  import de.smartics.exceptions.report.data.ProjectConfiguration;
  import de.smartics.exceptions.report.data.ReportProblem;
  import de.smartics.exceptions.report.generator.ReportGenerator;
  import de.smartics.exceptions.report.utils.StringFunction;
  import de.smartics.maven.exceptions.conf.ConfigUtils;
  import de.smartics.maven.exceptions.conf.DefaultProjectConfiguration;
  import de.smartics.maven.exceptions.runtime.ProjectClassLoader;
  import de.smartics.maven.util.PathUtils;
  
  /**
   * Generates exception code documentation.
   *
   * @goal report
   * @phase site
   * @requiresProject
   * @requiresDependencyResolution
   * @description Generates documentation for the exception codes used in the
   *              project.
   */
  public class ExceptionCodeReport extends AbstractElementReport
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ... plugin infrastructure ................................................
  
    // ... references to artifacts of other plugins .............................
  
    // ... own configuration parameters .........................................
  
    // ... basics
  
    /**
     * Specifies the name of the file to save the properties report (without
     * extension).
     *
     * @parameter expression="${properties.report.fileName}" default-value=
     *            "exception-codes-report"
     */
    private String outputName;
  
    // ... sources
  
    /**
     * Specifies additional root directories of source files to consider. Please
     * note that source file archives found at the same location as the class file
     * archives are automatically visible. The source archive is required to have
     * the suffix <code>-sources</code> in front of the extension and only jar-
     * and zip-archives are supported.
     *
     * @parameter expression="${exceptioncodes.additionalSources}"
     */
    private String additionalSources;
  
    /**
     * Specifies the encoding the sources will be read.
     *
     * @parameter expression="${exceptioncodes.build.sourceEncoding}"
     *            default-value="UTF-8"
     */
    private String sourceEncoding;
  
    /**
     * Specifies the Java version of the sources.
    *
    * @parameter expression="${exceptioncodes.build.sourceVersion}"
    *            default-value="1.5"
    */
   private String sourceVersion;
 
   /**
    * Specifies the names filter of the source and class files to be included in
    * the reports. The path starts at the source path root, not at the project
    * root.
    *
    * @parameter expression="${exceptioncodes.includes}"
    * @since 1.0
    */
   @SuppressWarnings("rawtypes")
   private ArrayList includes; // NOPMD
 
   /**
    * Specifies the names filter of the source and class files to be excluded
    * from the reports. The path starts at the source path root, not at the
    * project root.
    *
    * @parameter expression="${exceptioncodes.excludes}"
    * @since 1.0
    */
   @SuppressWarnings("rawtypes")
   private ArrayList excludes; // NOPMD
 
   // ... report
 
   /**
    * Specifies the name of the report generator instance. This class has to
    * implement <code>de.smartics.exceptions.report.ReportGenerator</code>. <br/>
    * Currently three implementations are provided:
    * <code>de.smartics.maven.exceptions.report.PackageSortedSinkReportGenerator</code>
    * ,
    * <code>de.smartics.maven.exceptions.report.CodeSortedSinkReportGenerator</code>
    * , and
    * <code>de.smartics.maven.exceptions.report.ComponentCodeSortedSinkReportGenerator</code>
    * . <br/>
    *
    * @parameter expression="${exceptioncodes.report.generator}" default-value=
    *            "de.smartics.maven.exceptions.report.PackageSortedSinkReportGenerator"
    */
   private String reportGenerator;
 
   /**
    * Specifies the encoding the report will be written.
    *
    * @parameter expression="${exceptioncodes.report.encoding}"
    *            default-value="UTF-8"
    */
   private String reportEncoding;
 
   /**
    * A simple flag to skip the generation of the report. If set on the command
    * line use <code>-Dexceptioncodes.skip</code>.
    *
    * @parameter expression="${exceptioncodes.skip}" default-value="false"
    * @since 1.0
    */
   private boolean skip;
 
   /**
    * Flag to add source pathes of modules of a multi module build. This allows
    * to reference codes of all dependent modules.
    *
    * @parameter expression="${exceptioncodes.addModuleSrcFolders}"
    *            default-value="true"
    * @since 1.0
    */
   private boolean addModuleSrcFolders;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   // ... plugin metadata ......................................................
 
   // ... plugin infrastructure ................................................
 
   /**
    * {@inheritDoc}
    *
    * @see org.apache.maven.reporting.AbstractMavenReport#getOutputName()
    */
   public String getOutputName()
   {
     return outputName;
   }
 
   // --- business -------------------------------------------------------------
 
   @Override
   public void executeReport(final Locale locale) throws MavenReportException
   {
     if (skip)
     {
       final Log log = getLog();
       if (log.isInfoEnabled())
       {
         log.info("Report '" + getName(locale) + "' skipped.");
       }
       return;
     }
 
     try
     {
       final ProjectConfiguration<Sink> projectConfig =
           createProjectConfiguration(locale);
       final ReportConfiguration reportConfig =
           createReportConfiguration(projectConfig);
 
       final ReportBuilder builder = ReportBuilder.create(reportConfig);
       final InMemoryExceptionCodesReport report =
           new InMemoryExceptionCodesReport();
       builder.reportTo(report);
 
       if (report.hasProblems())
       {
         final String message = toString(report.getProblems());
         getLog().error(message);
         throw new MavenReportException(
             "Problems encountered while generating report.\n"
                 + " Please refer to error log for details.");
       }
 
       final ReportGenerator<Sink> generator =
           projectConfig.getReporterInstance();
       generator.writeReport(projectConfig, report);
     }
     catch (final Exception e)
     {
       e.printStackTrace();
       throw new MavenReportException(
           "Cannot generate " + getName(locale) + ".", e);
     }
   }
 
   private static String toString(final List<ReportProblem> problems)
   {
     final StringBuilder buffer = new StringBuilder(512);
 
     for (final ReportProblem problem : problems)
     {
       buffer.append(problem).append('\n');
     }
 
     return buffer.toString();
   }
 
   @SuppressWarnings("unchecked")
   private ProjectConfiguration<Sink> createProjectConfiguration(
       final Locale locale) throws DependencyResolutionRequiredException
   {
     final List<String> classRootDirectoryNames =
         project.getCompileClasspathElements();
 
     final List<String> sourceRootDirectoryNames = new ArrayList<String>();
     sourceRootDirectoryNames.addAll(StringFunction.split(
         this.additionalSources, ","));
     addModuleSources(sourceRootDirectoryNames);
     sourceRootDirectoryNames.addAll(project.getCompileSourceRoots());
     sourceRootDirectoryNames.addAll(ConfigUtils
         .discoverSourceJars(classRootDirectoryNames));
     final List<String> toolClassPath = PathUtils.toClassPath(pluginArtifacts);
 
     final Log log = getLog();
     if (log.isDebugEnabled())
     {
       log.debug("Tool class path: " + toolClassPath);
       log.debug("Class roots    : " + classRootDirectoryNames);
       log.debug("Source roots   : " + sourceRootDirectoryNames);
     }
 
     final DefaultProjectConfiguration.Builder<Sink> builder =
         new DefaultProjectConfiguration.Builder<Sink>(project.getName());
 
     builder.setIncludes(includes);
     builder.setExcludes(excludes);
     builder.setSourceEncoding(this.sourceEncoding);
     builder.setSourceVersion(this.sourceVersion);
     builder.setToolClassPath(toolClassPath);
     builder.setClassRootDirectoryNames(classRootDirectoryNames);
     builder.setSourceRootDirectoryNames(sourceRootDirectoryNames);
     builder.setJavadocDir(javadocDir);
 
     builder.setReportEncoding(this.reportEncoding);
     builder.setReporter(this.reportGenerator);
     builder.setReport(new File(this.outputDirectory.getAbsolutePath(),
         outputName).getPath());
 
     final ResourceBundle bundle = getBundle(locale);
     builder.setBundle(bundle);
 
     final ProjectConfiguration<Sink> config = builder.build();
 
     final Sink sink = getSink();
     final ReportGenerator<Sink> generator = config.getReporterInstance();
     generator.setOutput(sink);
 
     return config;
   }
 
   private void addModuleSources(final List<String> sourceRootDirectoryNames)
   {
     if (!addModuleSrcFolders)
     {
       return;
     }
 
     final List<MavenProject> projects = session.getProjects();
     for (final MavenProject current : projects)
     {
       if (project.getDependencyArtifacts().contains(current.getArtifact()))
       {
         final String sourceDir = current.getBuild().getSourceDirectory();
         if (new File(sourceDir).exists())
         {
           sourceRootDirectoryNames.add(sourceDir);
         }
       }
     }
   }
 
   private ReportConfiguration createReportConfiguration(
       final ProjectConfiguration<Sink> projectConfig)
   {
     final ReportConfiguration reportConfig = new ReportConfiguration();
     reportConfig.setEncoding(this.sourceEncoding);
     final ProjectClassLoader classLoader =
         new ProjectClassLoader(Thread.currentThread().getContextClassLoader(),
             projectConfig.getClassRootDirectoryNames());
     reportConfig.setProjectClassLoader(classLoader);
     for (final String name : projectConfig.getSourceRootDirectoryNames())
     {
       final File file = new File(name);
       reportConfig.addSourceTree(file);
     }
 
     reportConfig.addIncludes(projectConfig.getIncludes());
     reportConfig.addExcludes(projectConfig.getExcludes());
 
     return reportConfig;
   }
 
   @Override
   protected String getBundleName()
   {
     return "de/smartics/exceptions/report/ExceptionCodeReportBundle";
   }
 
   // --- object basics --------------------------------------------------------
 
 }