dist-tools/dist-tool-plugin/src/main/java/org/apache/maven/dist/tools/DistCheckIndexPageMojo.java - maven-sandbox - Git at Google

 package org.apache.maven.dist.tools;

 /*
  * 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.IOException;
 import java.text.DateFormat;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Collections;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;

 import org.apache.maven.doxia.sink.Sink;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.reporting.MavenReportException;
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import org.jsoup.nodes.Element;
 import org.jsoup.select.Elements;

 /**
  * Check index page for information about components.
  *
  * @author skygo
  */
 @Mojo( name = "check-index-page", requiresProject = false )
 public class DistCheckIndexPageMojo
         extends AbstractDistCheckMojo
 {
     static final String FAILURES_FILENAME = "check-index-page.log";

     static final String POMS_INDEX_URL = "http://maven.apache.org/pom/";

     private static final IndexPage[] INDEX_PAGES = new IndexPage[] {
         new IndexPage( "http://maven.apache.org/plugins/", "Plugins", 3, true ),
         new IndexPage( "http://maven.apache.org/shared/", "Shared", 2, true ),
         new IndexPage( "http://maven.apache.org/skins/", "Skins", 2, false ),
         new IndexPage( POMS_INDEX_URL, "Poms", 2, true ) };

     private static final Map<String, IndexPage> INDEX_PAGES_REF;

     private static class IndexPage
     {
         final String url;
         final String name;
         final int versionColumn;
         final boolean containsDate;
         Document document;

         IndexPage( String url, String name, int versionColumn, boolean containsDate )
         {
             this.url = url;
             this.name = name;
             this.versionColumn = versionColumn;
             this.containsDate = containsDate;
         }
     }

     static
     {
         Map<String, IndexPage> aMap = new HashMap<>();
         for ( IndexPage ip : INDEX_PAGES )
         {
             aMap.put(  ip.url, ip );
         }
         INDEX_PAGES_REF = Collections.unmodifiableMap( aMap );
     }

     /**
      * Ignore dist failure for <code>artifactId</code> or <code>artifactId:version</code>
      */
     @Parameter
     protected List<String> ignoreDistFailures;

     @Override
     protected String getFailuresFilename()
     {
         return FAILURES_FILENAME;
     }

     @Override
     public String getName( Locale locale )
     {
         return "Dist Tool> Check Index Pages";
     }

     @Override
     public String getDescription( Locale locale )
     {
         return "Verification of index pages";
     }

     @Override
     boolean isIndexPageCheck()
     {
         return true;
     }


     private static class CheckIndexPageResult
         extends AbstractCheckResult
     {

         private String indexVersion;
         private String indexDate;

         public CheckIndexPageResult( ConfigurationLineInfo r, String version )
         {
             super( r, version );
         }

         private void setIndexVersion( String ownText )
         {
             this.indexVersion = ownText;
         }

         private void setIndexDate( String ownText )
         {
             this.indexDate = ownText;
         }
     }
     private final Map<String, List<CheckIndexPageResult>> results = new HashMap<>();


     private void reportLine( Sink sink, CheckIndexPageResult cipr , boolean displayDate )
     {
         ConfigurationLineInfo cli = cipr.getConfigurationLine();

         sink.tableRow();
         sink.tableCell();
         sink.anchor( cli.getArtifactId() );
         sink.rawText( cli.getArtifactId() );
         sink.anchor_();
         sink.tableCell_();

         // maven-metadata.xml column
         sink.tableCell();
         sink.link( cli.getMetadataFileURL( repoBaseUrl ) );
         sink.rawText( "maven-metadata.xml" );
         sink.link_();
         sink.rawText( ": " + cli.getReleaseDateFromMetadata() + " - " + cipr.indexVersion );
         sink.tableCell_();

         // index page column
         sink.tableCell();
         if ( displayDate )
         {
             sink.rawText( cipr.indexDate );
             if ( isDateSimilar( cli.getReleaseDateFromMetadata(), cipr.indexDate ) )
             {
                 iconSuccess( sink );
             }
             else
             {
                 iconWarning( sink );
             }
             sink.rawText( " - " );
         }

         sink.rawText( cipr.indexVersion );
         if ( cipr.getVersion().equals( cipr.indexVersion ) )
         {
             iconSuccess( sink );
         }
         else
         {
             iconError( sink );

             addErrorLine( cli, null, null,
                           cli.getArtifactId() + ": found " + cipr.indexVersion + " instead of " + cipr.getVersion()
                               + " in " + cli.getIndexPageUrl() );
         }
         sink.tableCell_();

         sink.tableRow_();
     }

     private boolean isDateSimilar( String date1, String date2 )
     {
         try
         {
             DateFormat df = new SimpleDateFormat( "yyyy-MM-dd" );
             Date d1 = df.parse( date1 );
             Date d2 = df.parse( date2 );

             @SuppressWarnings( "checkstyle:magicnumber" )
             long daysDifference = ( d1.getTime() - d2.getTime() ) / ( 24 * 60 * 60 * 1000 );
             return Math.abs( daysDifference ) < 7; // ok for 7 days difference
         }
         catch ( ParseException e )
         {
             return false;
         }
     }

     @Override
     protected void executeReport( Locale locale )
             throws MavenReportException
     {
         if ( !outputDirectory.exists() )
         {
             outputDirectory.mkdirs();
         }
         try
         {
             this.execute();
         }
         catch ( MojoExecutionException ex )
         {
             throw new MavenReportException( ex.getMessage(), ex );
         }

         Sink sink = getSink();
         sink.head();
         sink.title();
         sink.text( "Check index pages" );
         sink.title_();
         sink.head_();

         sink.body();
         sink.section1();
         sink.paragraph();
         sink.rawText( "Check that index pages have been updated with latest release info available in central"
             + " repository <code>maven-metadata.xml</code>." );
         sink.paragraph_();
         sink.section1_();

         for ( Map.Entry<String, List<CheckIndexPageResult>> result: results.entrySet() )
         {
             String indexPageId = result.getKey();
             IndexPage indexPage = INDEX_PAGES_REF.get( indexPageId );
             List<CheckIndexPageResult> indexPageResults = result.getValue();

             sink.anchor( indexPageResults.get( 0 ).getConfigurationLine().getDirectory() );
             sink.anchor_();
             sink.sectionTitle2();
             sink.text( indexPage.name + " index page: " );
             sink.link( indexPage.url );
             sink.text( indexPage.url );
             sink.link_();
             sink.sectionTitle2_();

             sink.table();
             sink.tableRow();
             sink.tableHeaderCell();
             sink.rawText( "Component (" + indexPageResults.size() + ")" );
             sink.tableHeaderCell_();
             sink.tableHeaderCell();
             sink.rawText( "maven-metadata.xml " );
             if ( indexPage.containsDate )
             {
                 sink.rawText( "lastUpdated - " );
             }
             sink.rawText( "latest" );
             sink.tableHeaderCell_();
             sink.tableHeaderCell();
             sink.link( indexPage.url );
             sink.rawText( "index page" );
             sink.link_();
             sink.tableHeaderCell_();
             sink.tableRow_();

             for ( CheckIndexPageResult csr : indexPageResults )
             {
                 reportLine( sink, csr, indexPage.containsDate );
             }
             sink.table_();
         }

         sink.body_();
         sink.flush();
         sink.close();
     }

     private void updateIndexPageInfo( ConfigurationLineInfo cli, CheckIndexPageResult r, IndexPage indexPage )
         throws IOException
     {
         Document doc = indexPage.document;
         if ( doc == null )
         {
             // document not yet downloaded: download and cache
             try
             {
                 doc = Jsoup.connect( indexPage.url ).get();
             }
             catch ( IOException ioe )
             {
                 throw new IOException( "IOException while reading " + indexPage.url, ioe );
             }
             indexPage.document = doc;
         }

         Elements a = doc.select( "tr > td > a[href]:not(.externalLink)" );

         String path = paths.get( cli.getArtifactId() );
         if ( path == null )
         {
             path = '/' + cli.getArtifactId() + '/';
         }

         for ( Element e : a )
         {
             String href = e.attr( "href" );

             if ( href.contains( path ) )
             {
                 Element row = e.parent().parent();
                 r.setIndexVersion( row.child( indexPage.versionColumn - 1 ).ownText() );
                 if ( indexPage.containsDate )
                 {
                     r.setIndexDate( row.child( indexPage.versionColumn ).ownText() );
                 }
                 break;
            }
         }
     }

     @Override
     protected void checkArtifact( ConfigurationLineInfo configLine, String version )
             throws MojoExecutionException
     {
         try
         {
             CheckIndexPageResult result = new CheckIndexPageResult( configLine, version );

             if ( configLine.getIndexPageUrl() != null )
             {
                 if ( results.get( configLine.getIndexPageUrl() ) == null )
                 {
                     results.put( configLine.getIndexPageUrl(), new LinkedList<CheckIndexPageResult>() );
                 }
                 results.get( configLine.getIndexPageUrl() ).add( result );
                 updateIndexPageInfo( configLine, result, INDEX_PAGES_REF.get( configLine.getIndexPageUrl() ) );
             }
         }
         catch ( IOException ex )
         {
             throw new MojoExecutionException( ex.getMessage(), ex );
         }
     }
 }
	package org.apache.maven.dist.tools;

	/*
	* 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.IOException;
	import java.text.DateFormat;
	import java.text.ParseException;
	import java.text.SimpleDateFormat;
	import java.util.Collections;
	import java.util.Date;
	import java.util.HashMap;
	import java.util.LinkedList;
	import java.util.List;
	import java.util.Locale;
	import java.util.Map;

	import org.apache.maven.doxia.sink.Sink;
	import org.apache.maven.plugin.MojoExecutionException;
	import org.apache.maven.plugins.annotations.Mojo;
	import org.apache.maven.plugins.annotations.Parameter;
	import org.apache.maven.reporting.MavenReportException;
	import org.jsoup.Jsoup;
	import org.jsoup.nodes.Document;
	import org.jsoup.nodes.Element;
	import org.jsoup.select.Elements;

	/**
	* Check index page for information about components.
	*
	* @author skygo
	*/
	@Mojo( name = "check-index-page", requiresProject = false )
	public class DistCheckIndexPageMojo
	extends AbstractDistCheckMojo
	{
	static final String FAILURES_FILENAME = "check-index-page.log";

	static final String POMS_INDEX_URL = "http://maven.apache.org/pom/";

	private static final IndexPage[] INDEX_PAGES = new IndexPage[] {
	new IndexPage( "http://maven.apache.org/plugins/", "Plugins", 3, true ),
	new IndexPage( "http://maven.apache.org/shared/", "Shared", 2, true ),
	new IndexPage( "http://maven.apache.org/skins/", "Skins", 2, false ),
	new IndexPage( POMS_INDEX_URL, "Poms", 2, true ) };

	private static final Map<String, IndexPage> INDEX_PAGES_REF;

	private static class IndexPage
	{
	final String url;
	final String name;
	final int versionColumn;
	final boolean containsDate;
	Document document;

	IndexPage( String url, String name, int versionColumn, boolean containsDate )
	{
	this.url = url;
	this.name = name;
	this.versionColumn = versionColumn;
	this.containsDate = containsDate;
	}
	}

	static
	{
	Map<String, IndexPage> aMap = new HashMap<>();
	for ( IndexPage ip : INDEX_PAGES )
	{
	aMap.put( ip.url, ip );
	}
	INDEX_PAGES_REF = Collections.unmodifiableMap( aMap );
	}

	/**
	* Ignore dist failure for <code>artifactId</code> or <code>artifactId:version</code>
	*/
	@Parameter
	protected List<String> ignoreDistFailures;

	@Override
	protected String getFailuresFilename()
	{
	return FAILURES_FILENAME;
	}

	@Override
	public String getName( Locale locale )
	{
	return "Dist Tool> Check Index Pages";
	}

	@Override
	public String getDescription( Locale locale )
	{
	return "Verification of index pages";
	}

	@Override
	boolean isIndexPageCheck()
	{
	return true;
	}


	private static class CheckIndexPageResult
	extends AbstractCheckResult
	{

	private String indexVersion;
	private String indexDate;

	public CheckIndexPageResult( ConfigurationLineInfo r, String version )
	{
	super( r, version );
	}

	private void setIndexVersion( String ownText )
	{
	this.indexVersion = ownText;
	}

	private void setIndexDate( String ownText )
	{
	this.indexDate = ownText;
	}
	}
	private final Map<String, List<CheckIndexPageResult>> results = new HashMap<>();


	private void reportLine( Sink sink, CheckIndexPageResult cipr , boolean displayDate )
	{
	ConfigurationLineInfo cli = cipr.getConfigurationLine();

	sink.tableRow();
	sink.tableCell();
	sink.anchor( cli.getArtifactId() );
	sink.rawText( cli.getArtifactId() );
	sink.anchor_();
	sink.tableCell_();

	// maven-metadata.xml column
	sink.tableCell();
	sink.link( cli.getMetadataFileURL( repoBaseUrl ) );
	sink.rawText( "maven-metadata.xml" );
	sink.link_();
	sink.rawText( ": " + cli.getReleaseDateFromMetadata() + " - " + cipr.indexVersion );
	sink.tableCell_();

	// index page column
	sink.tableCell();
	if ( displayDate )
	{
	sink.rawText( cipr.indexDate );
	if ( isDateSimilar( cli.getReleaseDateFromMetadata(), cipr.indexDate ) )
	{
	iconSuccess( sink );
	}
	else
	{
	iconWarning( sink );
	}
	sink.rawText( " - " );
	}

	sink.rawText( cipr.indexVersion );
	if ( cipr.getVersion().equals( cipr.indexVersion ) )
	{
	iconSuccess( sink );
	}
	else
	{
	iconError( sink );

	addErrorLine( cli, null, null,
	cli.getArtifactId() + ": found " + cipr.indexVersion + " instead of " + cipr.getVersion()
	+ " in " + cli.getIndexPageUrl() );
	}
	sink.tableCell_();

	sink.tableRow_();
	}

	private boolean isDateSimilar( String date1, String date2 )
	{
	try
	{
	DateFormat df = new SimpleDateFormat( "yyyy-MM-dd" );
	Date d1 = df.parse( date1 );
	Date d2 = df.parse( date2 );

	@SuppressWarnings( "checkstyle:magicnumber" )
	long daysDifference = ( d1.getTime() - d2.getTime() ) / ( 24 * 60 * 60 * 1000 );
	return Math.abs( daysDifference ) < 7; // ok for 7 days difference
	}
	catch ( ParseException e )
	{
	return false;
	}
	}

	@Override
	protected void executeReport( Locale locale )
	throws MavenReportException
	{
	if ( !outputDirectory.exists() )
	{
	outputDirectory.mkdirs();
	}
	try
	{
	this.execute();
	}
	catch ( MojoExecutionException ex )
	{
	throw new MavenReportException( ex.getMessage(), ex );
	}

	Sink sink = getSink();
	sink.head();
	sink.title();
	sink.text( "Check index pages" );
	sink.title_();
	sink.head_();

	sink.body();
	sink.section1();
	sink.paragraph();
	sink.rawText( "Check that index pages have been updated with latest release info available in central"
	+ " repository <code>maven-metadata.xml</code>." );
	sink.paragraph_();
	sink.section1_();

	for ( Map.Entry<String, List<CheckIndexPageResult>> result: results.entrySet() )
	{
	String indexPageId = result.getKey();
	IndexPage indexPage = INDEX_PAGES_REF.get( indexPageId );
	List<CheckIndexPageResult> indexPageResults = result.getValue();

	sink.anchor( indexPageResults.get( 0 ).getConfigurationLine().getDirectory() );
	sink.anchor_();
	sink.sectionTitle2();
	sink.text( indexPage.name + " index page: " );
	sink.link( indexPage.url );
	sink.text( indexPage.url );
	sink.link_();
	sink.sectionTitle2_();

	sink.table();
	sink.tableRow();
	sink.tableHeaderCell();
	sink.rawText( "Component (" + indexPageResults.size() + ")" );
	sink.tableHeaderCell_();
	sink.tableHeaderCell();
	sink.rawText( "maven-metadata.xml " );
	if ( indexPage.containsDate )
	{
	sink.rawText( "lastUpdated - " );
	}
	sink.rawText( "latest" );
	sink.tableHeaderCell_();
	sink.tableHeaderCell();
	sink.link( indexPage.url );
	sink.rawText( "index page" );
	sink.link_();
	sink.tableHeaderCell_();
	sink.tableRow_();

	for ( CheckIndexPageResult csr : indexPageResults )
	{
	reportLine( sink, csr, indexPage.containsDate );
	}
	sink.table_();
	}

	sink.body_();
	sink.flush();
	sink.close();
	}

	private void updateIndexPageInfo( ConfigurationLineInfo cli, CheckIndexPageResult r, IndexPage indexPage )
	throws IOException
	{
	Document doc = indexPage.document;
	if ( doc == null )
	{
	// document not yet downloaded: download and cache
	try
	{
	doc = Jsoup.connect( indexPage.url ).get();
	}
	catch ( IOException ioe )
	{
	throw new IOException( "IOException while reading " + indexPage.url, ioe );
	}
	indexPage.document = doc;
	}

	Elements a = doc.select( "tr > td > a[href]:not(.externalLink)" );

	String path = paths.get( cli.getArtifactId() );
	if ( path == null )
	{
	path = '/' + cli.getArtifactId() + '/';
	}

	for ( Element e : a )
	{
	String href = e.attr( "href" );

	if ( href.contains( path ) )
	{
	Element row = e.parent().parent();
	r.setIndexVersion( row.child( indexPage.versionColumn - 1 ).ownText() );
	if ( indexPage.containsDate )
	{
	r.setIndexDate( row.child( indexPage.versionColumn ).ownText() );
	}
	break;
	}
	}
	}

	@Override
	protected void checkArtifact( ConfigurationLineInfo configLine, String version )
	throws MojoExecutionException
	{
	try
	{
	CheckIndexPageResult result = new CheckIndexPageResult( configLine, version );

	if ( configLine.getIndexPageUrl() != null )
	{
	if ( results.get( configLine.getIndexPageUrl() ) == null )
	{
	results.put( configLine.getIndexPageUrl(), new LinkedList<CheckIndexPageResult>() );
	}
	results.get( configLine.getIndexPageUrl() ).add( result );
	updateIndexPageInfo( configLine, result, INDEX_PAGES_REF.get( configLine.getIndexPageUrl() ) );
	}
	}
	catch ( IOException ex )
	{
	throw new MojoExecutionException( ex.getMessage(), ex );
	}
	}
	}