/*
    * DaCapo Benchmark Maven Plugin
    * Copyright (C) 2010 Technische Universität Darmstadt
    * info@scalabench.org
    *
    * 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 org.scalabench.plugins.dacapo.reporting;
  
  import java.io.File;
  import java.util.Locale;
  import java.util.ResourceBundle;
  
  import org.apache.maven.doxia.siterenderer.Renderer;
  import org.apache.maven.project.MavenProject;
  import org.apache.maven.reporting.AbstractMavenReport;
  import org.apache.maven.reporting.AbstractMavenReportRenderer;
  import org.apache.maven.reporting.MavenReportException;
  import org.dacapo.parser.Config;
  import org.scalabench.plugins.dacapo.AbstractDacapoBenchmarkMojo;
  
  /**
   * Reports the benchmark's configuration.
   * 
   * @since 0.1.0
   * 
   * @threadSafe
   * @goal report-configuration
   * @phase site
   * @execute phase="process-resources"
   */
  public class ConfigurationReport extends AbstractMavenReport {
      
      /**
       * The Maven project being built.
       * 
       * @required
       * @readonly
       * @parameter expression="${project}"
       */
      private MavenProject project;
      
      /**
       * The name of the benchmark. If unspecified, it is derived from the project's <code>artifactId</code>.
       * 
       * If the <code>artifactId</code> matches one of the following patterns, the benchmark name is extracted from it as
       * indicated:
       * 
       * <ul>
       *   <li><code>${benchmarkName}</code>-dacapo-benchmark</li>
       *   <li>dacapo-<code>${benchmarkName}</code>-benchmark</li>
       * </ul>
       * 
       * Otherwise, the <code>artifactId</code> is taken wholesale.
       * 
       * @parameter
       */
      private String benchmarkName;
      
      /**
       * The directory where the benchmark configuration is located.
       * 
       * @required
       * @readonly
       * @parameter expression="${project.build.outputDirectory}/cnf"
       */
      private File configurationDirectory;
      
      /**
       * @required
       * @readonly
       * @parameter expression="${project.reporting.outputDirectory}"
       */
      private String outputDirectory;
      
      /**
       * @component
       */
      private Renderer siteRenderer;
      
      public MavenProject getProject() {
          return project;
      }
      
      public String getBenchmarkName() {
          if (benchmarkName == null)
              return AbstractDacapoBenchmarkMojo.getBenchmarkNameFromArtifactId(getProject().getArtifactId());
          else
              return benchmarkName;
     }
     
     @Override
     protected void executeReport(Locale locale) throws MavenReportException {
         final Config config = Config.parse(getConfigurationFile());
         final AbstractMavenReportRenderer renderer =
             new ConfigurationReportRenderer(getSink(), config, locale);
         renderer.render();
     }
     
     @Override
     public boolean canGenerateReport() {
         return getConfigurationFile().exists();
     }
     
     public File getConfigurationFile() {
         return new File(getConfigurationDirectory(), getBenchmarkName() + ".cnf");
     }
     
     public File getConfigurationDirectory() {
         return configurationDirectory;
     }
     
     @Override
     public String getOutputName() {
         return "dacapo-benchmark-configuration";
     }
     
     @Override
     public String getOutputDirectory() {
         return outputDirectory;
     }
     
     @Override
     public Renderer getSiteRenderer() {
         return siteRenderer;
     }
     
     @Override
     public String getName(Locale locale) {
         return getBundle(locale).getString("report.dacapo.name");
     }
     
     @Override
     public String getDescription(Locale locale) {
         return getBundle(locale).getString("report.dacapo.description");
     }
     
     public static ResourceBundle getBundle(Locale locale) {
         return ResourceBundle.getBundle("configuration-report", locale, ConfigurationReport.class.getClassLoader());
     }
 }