Coverage Report - org.apache.maven.plugins.site.SiteMojo
 
Classes in this File Line Coverage Branch Coverage Complexity
SiteMojo
2%
1/41
0%
0/12
4,333
 
 1  
 package org.apache.maven.plugins.site;
 2  
 
 3  
 /*
 4  
  * Licensed to the Apache Software Foundation (ASF) under one
 5  
  * or more contributor license agreements.  See the NOTICE file
 6  
  * distributed with this work for additional information
 7  
  * regarding copyright ownership.  The ASF licenses this file
 8  
  * to you under the Apache License, Version 2.0 (the
 9  
  * "License"); you may not use this file except in compliance
 10  
  * with the License.  You may obtain a copy of the License at
 11  
  *
 12  
  *   http://www.apache.org/licenses/LICENSE-2.0
 13  
  *
 14  
  * Unless required by applicable law or agreed to in writing,
 15  
  * software distributed under the License is distributed on an
 16  
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 17  
  * KIND, either express or implied.  See the License for the
 18  
  * specific language governing permissions and limitations
 19  
  * under the License.
 20  
  */
 21  
 
 22  
 import org.apache.maven.doxia.siterenderer.RendererException;
 23  
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 24  
 import org.apache.maven.plugin.MojoExecutionException;
 25  
 import org.apache.maven.plugin.MojoFailureException;
 26  
 import org.apache.maven.reporting.MavenReport;
 27  
 
 28  
 import java.io.File;
 29  
 import java.io.IOException;
 30  
 import java.util.Collections;
 31  
 import java.util.Iterator;
 32  
 import java.util.List;
 33  
 import java.util.Locale;
 34  
 import java.util.Map;
 35  
 
 36  
 /**
 37  
  * Generates the site for a single project.
 38  
  * <p>
 39  
  * Note that links between module sites in a multi module build will <b>not</b>
 40  
  * work.
 41  
  * </p>
 42  
  *
 43  
  * @author <a href="mailto:evenisse@apache.org">Emmanuel Venisse</a>
 44  
  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
 45  
  * @version $Id$
 46  
  * @goal site
 47  
  * @requiresDependencyResolution test
 48  
  */
 49  1
 public class SiteMojo
 50  
     extends AbstractSiteRenderingMojo
 51  
 {
 52  
     /**
 53  
      * Directory containing the generated project sites and report distributions.
 54  
      *
 55  
      * @parameter expression="${siteOutputDirectory}" default-value="${project.reporting.outputDirectory}"
 56  
      * @required
 57  
      */
 58  
     protected File outputDirectory;
 59  
 
 60  
     /**
 61  
      * Convenience parameter that allows you to disable report generation.
 62  
      *
 63  
      * @parameter expression="${generateReports}" default-value="true"
 64  
      */
 65  
     private boolean generateReports;
 66  
 
 67  
     /**
 68  
      * Generate a sitemap. The result will be a "sitemap.html" file at the site root.
 69  
      *
 70  
      * @parameter expression="${generateSitemap}" default-value="false"
 71  
      * @since 2.1
 72  
      */
 73  
     private boolean generateSitemap;
 74  
 
 75  
     /**
 76  
      * {@inheritDoc}
 77  
      *
 78  
      * Generate the project site
 79  
      * <p/>
 80  
      * throws MojoExecutionException if any
 81  
      *
 82  
      * @see org.apache.maven.plugin.Mojo#execute()
 83  
      */
 84  
     public void execute()
 85  
         throws MojoExecutionException, MojoFailureException
 86  
     {
 87  
         List filteredReports;
 88  0
         if ( generateReports )
 89  
         {
 90  0
             filteredReports = filterReports( reports );
 91  
         }
 92  
         else
 93  
         {
 94  0
             filteredReports = Collections.EMPTY_LIST;
 95  
         }
 96  
 
 97  
         try
 98  
         {
 99  0
             List localesList = siteTool.getAvailableLocales( locales );
 100  
 
 101  
             // Default is first in the list
 102  0
             Locale defaultLocale = (Locale) localesList.get( 0 );
 103  0
             Locale.setDefault( defaultLocale );
 104  
 
 105  0
             for ( Iterator iterator = localesList.iterator(); iterator.hasNext(); )
 106  
             {
 107  0
                 Locale locale = (Locale) iterator.next();
 108  
 
 109  0
                 renderLocale( locale, filteredReports );
 110  0
             }
 111  
         }
 112  0
         catch ( RendererException e )
 113  
         {
 114  0
             throw new MojoExecutionException( "Error during page generation", e );
 115  
         }
 116  0
         catch ( IOException e )
 117  
         {
 118  0
             throw new MojoExecutionException( "Error during site generation", e );
 119  0
         }
 120  0
     }
 121  
 
 122  
     private void renderLocale( Locale locale,
 123  
                                List reports )
 124  
         throws IOException, RendererException, MojoFailureException, MojoExecutionException
 125  
     {
 126  0
         SiteRenderingContext context = createSiteRenderingContext( locale );
 127  
 
 128  0
         context.setInputEncoding( getInputEncoding() );
 129  0
         context.setOutputEncoding( getOutputEncoding() );
 130  
 
 131  0
         Map documents = locateDocuments( context, reports, locale );
 132  
 
 133  0
         File outputDir = getOutputDirectory( locale );
 134  
 
 135  
         // For external reports
 136  0
         for ( Iterator i = reports.iterator(); i.hasNext(); )
 137  
         {
 138  0
             MavenReport report = (MavenReport) i.next();
 139  0
             report.setReportOutputDirectory( outputDir );
 140  0
         }
 141  
 
 142  0
         siteRenderer.render( documents.values(), context, outputDir );
 143  
 
 144  0
         if ( generateSitemap )
 145  
         {
 146  0
             getLog().info( "Generating Sitemap." );
 147  
 
 148  0
             new SiteMap( getOutputEncoding(), i18n )
 149  
                     .generate( context.getDecoration(), generatedSiteDirectory, locale );
 150  
         }
 151  
 
 152  
         // Generated docs must be done afterwards as they are often generated by reports
 153  0
         context.getSiteDirectories().clear();
 154  0
         context.addSiteDirectory( generatedSiteDirectory );
 155  
 
 156  0
         documents = siteRenderer.locateDocumentFiles( context );
 157  
 
 158  0
         siteRenderer.render( documents.values(), context, outputDir );
 159  0
     }
 160  
 
 161  
     private File getOutputDirectory( Locale locale )
 162  
     {
 163  
         File file;
 164  0
         if ( locale.getLanguage().equals( Locale.getDefault().getLanguage() ) )
 165  
         {
 166  0
             file = outputDirectory;
 167  
         }
 168  
         else
 169  
         {
 170  0
             file = new File( outputDirectory, locale.getLanguage() );
 171  
         }
 172  
 
 173  
         // Safety
 174  0
         if ( !file.exists() )
 175  
         {
 176  0
             file.mkdirs();
 177  
         }
 178  
 
 179  0
         return file;
 180  
     }
 181  
 }