package org.apache.maven.plugins.site;
   
   /*
    * 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.Collections;
  import java.util.List;
  import java.util.Locale;
  import java.util.Map;
  
  import org.apache.maven.doxia.siterenderer.DocumentRenderer;
  import org.apache.maven.doxia.siterenderer.RendererException;
  import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.plugin.MojoFailureException;
  import org.apache.maven.reporting.MavenReport;
  import org.apache.maven.reporting.exec.MavenReportExecution;
  
  /**
   * Generates the site for a single project.
   * <p>
   * Note that links between module sites in a multi module build will <b>not</b>
   * work.
   * </p>
   *
   * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
   * @version $Id: SiteMojo.html 816568 2012-05-08 12:09:38Z hboutemy $
   * @goal site
   * @requiresDependencyResolution test
   */
  public class SiteMojo
      extends AbstractSiteRenderingMojo
  {
      /**
       * Directory where the project sites and report distributions will be generated.
       *
       * @parameter expression="${siteOutputDirectory}" default-value="${project.reporting.outputDirectory}"
       */
      protected File outputDirectory;
  
      /**
       * Convenience parameter that allows you to disable report generation.
       *
       * @parameter expression="${generateReports}" default-value="true"
       */
      private boolean generateReports;
  
      /**
       * Generate a sitemap. The result will be a "sitemap.html" file at the site root.
       *
       * @parameter expression="${generateSitemap}" default-value="false"
       * @since 2.1
       */
      private boolean generateSitemap;
  
      /**
       * Whether to validate xml input documents.
       * If set to true, <strong>all</strong> input documents in xml format
       * (in particular xdoc and fml) will be validated and any error will
       * lead to a build failure.
       *
       * @parameter expression="${validate}" default-value="false"
       * @since 2.1.1
       */
      private boolean validate;
  
      /**
       * Set this to 'true' to skip site generation.
       *
       * @parameter expression="${maven.site.skip}" default-value="false"
       * @since 3.0
       */
      private boolean skip;
  
      /**
       * {@inheritDoc}
       *
       * Generate the project site
       * <p/>
      * throws MojoExecutionException if any
      *
      * @see org.apache.maven.plugin.Mojo#execute()
      */
     public void execute()
         throws MojoExecutionException, MojoFailureException
     {
         if ( skip )
         {
             getLog().info( "maven.site.skip = true: Skipping site generation" );
             return;
         }
 
         if ( getLog().isDebugEnabled() )
         {
             getLog().debug( "executing Site Mojo" );
         }
 
         List<MavenReportExecution> reports;
         if ( generateReports )
         {
             reports = getReports();
         }
         else
         {
             reports = Collections.emptyList();
         }
 
         try
         {
             List<Locale> localesList = siteTool.getAvailableLocales( locales );
 
             // Default is first in the list
             Locale defaultLocale = localesList.get( 0 );
             Locale.setDefault( defaultLocale );
 
             for ( Locale locale : localesList )
             {
                 renderLocale( locale, reports );
             }
         }
         catch ( RendererException e )
         {
             throw new MojoExecutionException( "Error during page generation", e );
         }
         catch ( IOException e )
         {
             throw new MojoExecutionException( "Error during site generation", e );
         }
     }
 
     private void renderLocale( Locale locale, List<MavenReportExecution> reports )
         throws IOException, RendererException, MojoFailureException, MojoExecutionException
     {
         SiteRenderingContext context = createSiteRenderingContext( locale );
 
         context.setInputEncoding( getInputEncoding() );
         context.setOutputEncoding( getOutputEncoding() );
         context.setValidate( validate );
         if ( validate )
         {
             getLog().info( "Validation is switched on, xml input documents will be validated!" );
         }
 
         Map<String, DocumentRenderer> documents = locateDocuments( context, reports, locale );
 
         File outputDir = getOutputDirectory( locale );
 
         // For external reports
         for ( MavenReportExecution mavenReportExecution : reports )
         {
             MavenReport report = mavenReportExecution.getMavenReport();
             report.setReportOutputDirectory( outputDir );
         }
 
         siteRenderer.render( documents.values(), context, outputDir );
 
         if ( generateSitemap )
         {
             getLog().info( "Generating Sitemap." );
 
             new SiteMap( getOutputEncoding(), i18n )
                     .generate( context.getDecoration(), generatedSiteDirectory, locale );
         }
 
         // Generated docs must be done afterwards as they are often generated by reports
         context.getSiteDirectories().clear();
         context.addSiteDirectory( generatedSiteDirectory );
 
         documents = siteRenderer.locateDocumentFiles( context );
 
         siteRenderer.render( documents.values(), context, outputDir );
     }
 
     private File getOutputDirectory( Locale locale )
     {
         File file;
         if ( locale.getLanguage().equals( Locale.getDefault().getLanguage() ) )
         {
             file = outputDirectory;
         }
         else
         {
             file = new File( outputDirectory, locale.getLanguage() );
         }
 
         // Safety
         if ( !file.exists() )
         {
             file.mkdirs();
         }
 
         return file;
     }
 }