package org.apache.maven.plugins.linkcheck;

 /*

  * 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.net.URL;

 import java.util.ArrayList;

 import java.util.Arrays;

 import java.util.List;

 import java.util.Locale;

 import java.util.Properties;

 import org.apache.maven.artifact.repository.ArtifactRepository;

 import org.apache.maven.doxia.linkcheck.HttpBean;

 import org.apache.maven.doxia.linkcheck.LinkCheck;

 import org.apache.maven.doxia.linkcheck.LinkCheckException;

 import org.apache.maven.doxia.linkcheck.model.LinkcheckModel;

 import org.apache.maven.doxia.siterenderer.Renderer;

 import org.apache.maven.plugin.MojoExecutionException;

 import org.apache.maven.project.MavenProject;

 import org.apache.maven.reporting.AbstractMavenReport;

 import org.apache.maven.reporting.MavenReportException;

 import org.apache.maven.settings.Proxy;

 import org.apache.maven.settings.Settings;

 import org.codehaus.plexus.i18n.I18N;

 import org.codehaus.plexus.util.FileUtils;

 import org.codehaus.plexus.util.ReaderFactory;

 import org.codehaus.plexus.util.StringUtils;

 /**

  * Generates a <code>Linkcheck</code> report.

  *

  * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>

  * @version $Id: LinkcheckReport.java 1021298 2010-10-11 10:18:19Z ltheussl $

  * @since 1.0

  * @goal linkcheck

  */

 public class LinkcheckReport

     extends AbstractMavenReport

 {

     // ----------------------------------------------------------------------

     // Report Components

     // ----------------------------------------------------------------------

     /**

      * Internationalization.

      *

      * @component

      */

     private I18N i18n;

     /**

      * Doxia Site Renderer.

      *

      * @component

      */

     private Renderer siteRenderer;

     /**

      * LinkCheck component.

      *

      * @component

      */

     private LinkCheck linkCheck;

     // ----------------------------------------------------------------------

     // Report Parameters

     // ----------------------------------------------------------------------

     /**

      * The Maven Project.

      *

      * @parameter expression="${project}"

      * @required

      * @readonly

      */

     private MavenProject project;

     /**

      * Local Repository.

      *

      * @parameter expression="${localRepository}"

      * @required

      * @readonly

      */

     private ArtifactRepository localRepository;

     /**

      * Report output directory.

      *

      * @parameter expression="${project.reporting.outputDirectory}"

      * @required

      */

     private File outputDirectory;

     /**

      * The Maven Settings.

      *

      * @parameter default-value="${settings}"

      * @required

      * @readonly

      */

     private Settings settings;

     // ----------------------------------------------------------------------

     // Linkcheck parameters

     // ----------------------------------------------------------------------

     /**

      * Whether we are offline or not.

      *

      * @parameter default-value="${settings.offline}" expression="${linkcheck.offline}"

      * @required

      */

     private boolean offline;

     /**

      * If online, the HTTP method should automatically follow HTTP redirects,

      * <tt>false</tt> otherwise.

      *

      * @parameter default-value="true"

      */

     private boolean httpFollowRedirect;

     /**

      * The location of the Linkcheck cache file.

      *

      * @parameter default-value="${project.build.directory}/linkcheck/linkcheck.cache"

      * @required

      */

     protected File linkcheckCache;

     /**

      * The location of the Linkcheck report file.

      *

      * @parameter default-value="${project.build.directory}/linkcheck/linkcheck.xml"

      * @required

      */

     protected File linkcheckOutput;

     /**

      * The HTTP method to use. Currently supported are "GET" and "HEAD".

      * <dl>

      * <dt>HTTP GET</dt>

      * <dd>

      * The HTTP GET method is defined in section 9.3 of

      * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:

      * The GET method means retrieve whatever information (in the form of an

      * entity) is identified by the Request-URI.

      * </dd>

      * <dt>HTTP HEAD</dt>

      * <dd>

      * The HTTP HEAD method is defined in section 9.4 of

      * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:

      * The HEAD method is identical to GET except that the server MUST NOT

      * return a message-body in the response.

      * </dd>

      * </dl>

      *

      * @parameter default-value="head"

      * @required

      */

     private String httpMethod;

     /**

      * The list of HTTP errors to ignored, like <code>404</code>.

      *

      * @parameter

      * @see {@link org.apache.commons.httpclient.HttpStatus} for all defined values.

      */

     private Integer[] excludedHttpStatusErrors;

     /**

      * The list of HTTP warnings to ignored, like <code>301</code>.

      *

      * @parameter

      * @see {@link org.apache.commons.httpclient.HttpStatus} for all defined values.

      */

     private Integer[] excludedHttpStatusWarnings;

     /**

      * A list of pages to exclude.

      * <br/>

      * <b>Note</b>:

      * <br/>

      * <ul>

      * <li>This report, i.e. <code>linkcheck.html</code>, is always excluded.</li>

      * <li>May contain Ant-style wildcards and double wildcards, e.g. <code>apidocs/**</code>, etc.</li>

      * </ul>

      *

      * @parameter

      */

     private String[] excludedPages;

     /**

      * The list of links to exclude.

      * <br/>

      * <b>Note</b>: Patterns like <code>&#42;&#42;/dummy/&#42;</code> are allowed for excludedLink.

      *

      * @parameter

      */

     private String[] excludedLinks;

     /**

      * The file encoding to use when Linkcheck reads the source files. If the property

      * <code>project.build.sourceEncoding</code> is not set, the platform default encoding is used.

      *

      * @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"

      */

     private String encoding;

     /**

      * The extra HttpClient parameters to be used when fetching links. For instance:

      * <pre>

      * <httpClientParameters>

      *  <property>

      *   <name>http.protocol.max-redirects</name>

      *   <value>10</value>

      *  </property>

      * </httpClientParameters>

      * </pre>

      * See <a href="http://hc.apache.org/httpclient-3.x/preference-api.html">HttpClient preference page</a>

      *

      * @parameter expression="${httpClientParameters}"

      */

     private Properties httpClientParameters;

     /**

      * Set the timeout to be used when fetching links. A value of zero means the timeout is not used.

      *

      * @parameter expression="${timeout}" default-value="2000"

      */

     private int timeout;

     /**

      * <code>true</code> to skip the report execution, <code>false</code> otherwise.

      * The purpose is to prevent infinite call when {@link #forceSite} is enable.

      *

      * @parameter expression="${linkcheck.skip}" default-value="false"

      */

     private boolean skip;

     /**

      * <code>true</code> to force the site generation, <code>false</code> otherwise.

      * Using this parameter ensures that all documents have been correctly generated.

      *

      * @parameter expression="${linkcheck.forceSite}" default-value="true"

      */

     private boolean forceSite;

     /**

      * The base URL to use for absolute links (eg <code>/index.html</code>) in the site.

      *

      * @parameter expression="${linkcheck.baseURL}" default-value="${project.url}"

      */

     private String baseURL;

     // ----------------------------------------------------------------------

     // Instance fields

     // ----------------------------------------------------------------------

     /** Result of the linkcheck in {@link #execute()} */

     private LinkcheckModel result;

     protected static final String ICON_SUCCESS = "images/icon_success_sml.gif";

     protected static final String ICON_WARNING = "images/icon_warning_sml.gif";

     protected static final String ICON_INFO = "images/icon_info_sml.gif";

     protected static final String ICON_ERROR = "images/icon_error_sml.gif";

     private static final String pluginResourcesBase = "org/apache/maven/plugin/linkcheck";

     private static final String resourceNames[] = { ICON_SUCCESS, ICON_WARNING, ICON_INFO, ICON_ERROR };

     // ----------------------------------------------------------------------

     // Public methods

     // ----------------------------------------------------------------------

     /** {@inheritDoc} */

     public String getDescription( Locale locale )

     {

         return i18n.getString( "linkcheck-report", locale, "report.linkcheck.description" );

     }

     /** {@inheritDoc} */

     public String getName( Locale locale )

     {

         return i18n.getString( "linkcheck-report", locale, "report.linkcheck.name" );

     }

     /** {@inheritDoc} */

     public String getOutputName()

     {

         return "linkcheck";

     }

     /** {@inheritDoc} */

     public boolean canGenerateReport()

     {

         if ( skip )

         {

             return false;

         }

         return true;

     }

     /** {@inheritDoc} */

     public void execute()

         throws MojoExecutionException

     {

         if ( !canGenerateReport() )

         {

             return;

         }

         checkEncoding();

         try

         {

             result = executeLinkCheck( getBasedir() );

         }

         catch ( LinkCheckException e )

         {

             throw new MojoExecutionException( "LinkCheckException: " + e.getMessage(), e );

         }

     }

     // ----------------------------------------------------------------------

     // Protected methods

     // ----------------------------------------------------------------------

     /** {@inheritDoc} */

     protected String getOutputDirectory()

     {

         return outputDirectory.getAbsolutePath();

     }

     /** {@inheritDoc} */

     protected MavenProject getProject()

     {

         return project;

     }

     /** {@inheritDoc} */

     protected Renderer getSiteRenderer()

     {

         return siteRenderer;

     }

     /** {@inheritDoc} */

     protected void executeReport( Locale locale )

         throws MavenReportException

     {

         if ( result == null )

         {

             getLog().debug( "Calling execute()" );

             try

             {

                 this.execute();

             }

             catch ( MojoExecutionException e )

             {

                 throw new MavenReportException( "MojoExecutionException: " + e.getMessage(), e );

             }

         }

         if ( result != null )

         {

             generateReport( locale, result );

             // free memory

             result = null;

         }

     }

     // ----------------------------------------------------------------------

     // Private methods

     // ----------------------------------------------------------------------

     private void checkEncoding()

     {

         if ( StringUtils.isEmpty( encoding ) )

         {

             if ( getLog().isWarnEnabled() )

             {

                 getLog().warn( "File encoding has not been set, using platform encoding "

                     + ReaderFactory.FILE_ENCODING + ", i.e. build is platform dependent!" );

             }

             encoding = ReaderFactory.FILE_ENCODING;

         }

     }

     private File getBasedir()

         throws MojoExecutionException

     {

         File basedir;

         if ( forceSite )

         {

             basedir = new File( linkcheckOutput.getParentFile(), "tmpsite" );

             basedir.mkdirs();

             List documents = null;

             try

             {

                 documents = FileUtils.getFiles( basedir, "**/*.html", null );

             }

             catch ( IOException e )

             {

                 getLog().error( "IOException: " + e.getMessage() );

                 getLog().debug( e );

             }

             // if the site was not already generated, invoke it

             if ( documents == null || ( documents != null && documents.size() == 0 ) )

             {

                 getLog().info( "Invoking the maven-site-plugin to ensure that all files are generated..." );

                 try

                 {

                     SiteInvoker invoker = new SiteInvoker( localRepository, getLog() );

                     invoker.invokeSite( project, basedir );

                 }

                 catch ( IOException e )

                 {

                     throw new MojoExecutionException( "IOException: " + e.getMessage(), e );

                 }

             }

         }

         else

         {

             getLog().warn( "The number of documents analyzed by Linkcheck could differ from the actual "

                                    + "number of documents!" );

             basedir = outputDirectory;

             basedir.mkdirs();

         }

         return basedir;

     }

     /**

      * Execute the <code>Linkcheck</code> tool.

      *

      * @param basedir not null

      * @throws LinkCheckException if any

      */

     private LinkcheckModel executeLinkCheck( File basedir )

         throws LinkCheckException

     {

         // Wrap linkcheck

         linkCheck.setOnline( !offline );

         linkCheck.setBasedir( basedir );

         linkCheck.setBaseURL( baseURL );

         linkCheck.setReportOutput( linkcheckOutput );

         linkCheck.setLinkCheckCache( linkcheckCache );

         linkCheck.setExcludedLinks( excludedLinks );

         linkCheck.setExcludedPages( getExcludedPages() );

         linkCheck.setExcludedHttpStatusErrors( asIntArray( excludedHttpStatusErrors ) );

         linkCheck.setExcludedHttpStatusWarnings( asIntArray( excludedHttpStatusWarnings ) );

         linkCheck.setEncoding( ( StringUtils.isNotEmpty( encoding ) ? encoding : ReaderFactory.UTF_8 ) );

         HttpBean bean = new HttpBean();

         bean.setMethod( httpMethod );

         bean.setFollowRedirects( httpFollowRedirect );

         bean.setTimeout( timeout );

         if ( httpClientParameters != null )

         {

             bean.setHttpClientParameters( httpClientParameters );

         }

         Proxy proxy = settings.getActiveProxy();

         if ( proxy != null )

         {

             bean.setProxyHost( proxy.getHost() );

             bean.setProxyPort( proxy.getPort() );

             bean.setProxyUser( proxy.getUsername() );

             bean.setProxyPassword( proxy.getPassword() );

         }

         linkCheck.setHttp( bean );

         return linkCheck.execute();

     }

     /**

      * @return the excludedPages defined by the user and also this report.

      */

     private String[] getExcludedPages()

     {

         List pagesToExclude =

             ( excludedPages != null ? new ArrayList( Arrays.asList( excludedPages ) ) : new ArrayList() );

         // Exclude this report

         pagesToExclude.add( getOutputName() + ".html" );

         return (String[]) pagesToExclude.toArray( new String[0] );

     }

     // ----------------------------------------------------------------------

     // Linkcheck report

     // ----------------------------------------------------------------------

     private void generateReport( Locale locale, LinkcheckModel linkcheckModel )

     {

         LinkcheckReportGenerator reportGenerator = new LinkcheckReportGenerator( i18n );

         reportGenerator.setExcludedHttpStatusErrors( excludedHttpStatusErrors );

         reportGenerator.setExcludedHttpStatusWarnings( excludedHttpStatusWarnings );

         reportGenerator.setExcludedLinks( excludedLinks );

         reportGenerator.setExcludedPages( excludedPages );

         reportGenerator.setHttpFollowRedirect( httpFollowRedirect );

         reportGenerator.setHttpMethod( httpMethod );

         reportGenerator.setOffline( offline );

         reportGenerator.generateReport( locale, linkcheckModel, getSink() );

         closeReport();

         // Copy the images

         copyStaticResources();

     }

     private void copyStaticResources()

     {

         try

         {

             getLog().debug( "Copying static linkcheck resources." );

             for ( int i = 0; i < resourceNames.length; i++ )

             {

                 URL url = this.getClass().getClassLoader().getResource( pluginResourcesBase + "/" + resourceNames[i] );

                 FileUtils.copyURLToFile( url, new File( getReportOutputDirectory(), resourceNames[i] ) );

             }

         }

         catch ( IOException e )

         {

             getLog().error( "Unable to copy icons for linkcheck report." );

             getLog().debug( e );

         }

     }

     private static int[] asIntArray( Integer[] array )

     {

         if ( array == null )

         {

             return null;

         }

         int[] newArray = new int[array.length];

         for ( int i = 0; i < array.length; i++ )

         {

             newArray[i] = array[i].intValue();

         }

         return newArray;

     }

 }