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.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.doxia.site.decoration.DecorationModel;
import org.apache.maven.doxia.site.decoration.Menu;
import org.apache.maven.doxia.site.decoration.MenuItem;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.MavenReport;
import org.codehaus.plexus.i18n.I18N;
import org.codehaus.plexus.util.ReaderFactory;
/**
* Base class for site mojos.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
public abstract class AbstractSiteMojo
extends AbstractMojo
{
/**
* A comma separated list of locales supported by Maven. The first valid token will be the default Locale
* for this instance of the Java Virtual Machine.
*
* @parameter expression="${locales}"
*/
protected String locales;
/**
* SiteTool.
*
* @component
*/
protected SiteTool siteTool;
/**
* Internationalization.
*
* @component
*/
protected I18N i18n;
/**
* Directory containing the site.xml file and the source for apt, fml and xdoc docs.
*
* @parameter expression="${basedir}/src/site"
* @required
*/
protected File siteDirectory;
/**
* The maven project.
*
* @parameter expression="${project}"
* @required
* @readonly
*/
protected MavenProject project;
/**
* The local repository.
*
* @parameter expression="${localRepository}"
*/
protected ArtifactRepository localRepository;
/**
* The reactor projects.
*
* @parameter expression="${reactorProjects}"
* @required
* @readonly
*/
protected List reactorProjects;
/**
* Specifies the input encoding.
*
* @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"
*/
private String inputEncoding;
/**
* Specifies the output encoding.
*
* @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"
*/
private String outputEncoding;
/**
* Gets the input files encoding.
*
* @return The input files encoding, never <code>null</code>.
*/
protected String getInputEncoding()
{
return ( inputEncoding == null ) ? ReaderFactory.ISO_8859_1 : inputEncoding;
}
/**
* Gets the effective reporting output files encoding.
*
* @return The effective reporting output file encoding, never <code>null</code>.
*/
protected String getOutputEncoding()
{
return ( outputEncoding == null ) ? ReaderFactory.UTF_8 : outputEncoding;
}
protected void populateReportItems( DecorationModel decorationModel, Locale locale, Map reportsByOutputName )
{
for ( Iterator i = decorationModel.getMenus().iterator(); i.hasNext(); )
{
Menu menu = (Menu) i.next();
populateItemRefs( menu.getItems(), locale, reportsByOutputName );
}
}
private void populateItemRefs( List items, Locale locale, Map reportsByOutputName )
{
for ( Iterator i = items.iterator(); i.hasNext(); )
{
MenuItem item = (MenuItem) i.next();
if ( item.getRef() != null )
{
if ( reportsByOutputName.containsKey( item.getRef() ) )
{
MavenReport report = (MavenReport) reportsByOutputName.get( item.getRef() );
if ( item.getName() == null )
{
item.setName( report.getName( locale ) );
}
if ( item.getHref() == null || item.getHref().length() == 0 )
{
item.setHref( report.getOutputName() + ".html" );
}
}
else
{
getLog().warn( "Unrecognised reference: '" + item.getRef() + "'" );
i.remove();
}
}
populateItemRefs( item.getItems(), locale, reportsByOutputName );
}
}
/**
* TODO should be removed see PLXUTILS-61
*
* @param basedir
* @param absolutePath
* @return
*/
protected static String toRelative( File basedir, String absolutePath )
{
String relative;
absolutePath = absolutePath.replace( '\\', '/' );
String basedirPath = basedir.getAbsolutePath().replace( '\\', '/' );
if ( absolutePath.startsWith( basedirPath ) )
{
relative = absolutePath.substring( basedirPath.length() + 1 );
}
else
{
relative = absolutePath;
}
return relative;
}
}