org.codehaus.mojo.dita.AbstractProjectMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dita-maven-plugin Show documentation
The DITA Open Toolkit is an implementation of the OASIS DITA XML Specification. The Toolkit transforms DITA content into many deliverable formats.
There is a newer version: 1.0-beta-3
Show newest version
package org.codehaus.mojo.dita;

import java.io.File;
import java.util.Iterator;
import java.util.List;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectHelper;
import org.codehaus.plexus.archiver.Archiver;
import org.codehaus.plexus.archiver.manager.ArchiverManager;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.cli.CommandLineException;
import org.codehaus.plexus.util.cli.CommandLineUtils;
import org.codehaus.plexus.util.cli.Commandline;
import org.codehaus.plexus.util.cli.DefaultConsumer;

/*
 * Copyright 2000-2006 The Apache Software Foundation
 * 
 * Licensed 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.
 */

/**
 * Base class of all dita-maven-plugin's MOJOs
 */
public abstract class AbstractProjectMojo
    extends AbstractMojo
{

    /**
     * Skip the execution
     * 
     * @parameter expression="${dita.skip}" default-value="false"
     * @since 1.0-beta-1
     */
    protected boolean skip;

    /**
     * Internal
     * 
     * @parameter expression="${project}"
     * @readonly
     * @since 1.0-beta-1
     */
    protected MavenProject project;

    /**
     * Internal Maven component to install/deploy the installer(s)
     * 
     * @component
     * @readonly
     */
    protected MavenProjectHelper projectHelper;

    /**
     * Internal component for archiving purposes
     * 
     * @component
     * @readonly
     * @since beta-1
     */
    private ArchiverManager archiverManager;
    
    
    protected void executeCommandline( Commandline cl )
        throws MojoExecutionException
    {
        int ok;

        try
        {
            DefaultConsumer stdout = new DefaultConsumer();

            DefaultConsumer stderr = stdout;

            this.getLog().debug( cl.toString() );

            ok = CommandLineUtils.executeCommandLine( cl, stdout, stderr );
        }
        catch ( CommandLineException ecx )
        {
            throw new MojoExecutionException( "Error executing command line", ecx );
        }

        if ( ok != 0 )
        {
            throw new MojoExecutionException( "Error executing command line. Exit code:" + ok );
        }

    }

    protected void archiveAndAttachTheOutput( File outputDirectory, String classifier, String type )
        throws MojoExecutionException
    {
        String archiveOutputFileName = this.project.getArtifactId();
        if ( ! StringUtils.isBlank( classifier ) )
        {
            archiveOutputFileName += "-" + classifier;
        }
        archiveOutputFileName += "." + type;

        File archiveOutputFile = new File( this.project.getBuild().getDirectory(), archiveOutputFileName );

        this.checkForDuplicateAttachArtifact( archiveOutputFile );

        try
        {
            Archiver archiver = this.archiverManager.getArchiver( archiveOutputFile );
            archiver.addDirectory( outputDirectory );
            archiver.setDestFile( archiveOutputFile );
            archiver.createArchive();
        }
        catch ( Exception e )
        {
            throw new MojoExecutionException( e.getMessage(), e );
        }

        attachArtifact( classifier, type, archiveOutputFile );

    }
    
    protected void attachArtifact( String classifier, String type, File file )
    {
        if ( StringUtils.isBlank( classifier ) )
        {
            projectHelper.attachArtifact( project, type, file );
        }
        else
        {
            projectHelper.attachArtifact( project, type, classifier, file );
        }
    }

    @SuppressWarnings("unchecked")
    protected void checkForDuplicateAttachArtifact( File attachFile )
        throws MojoExecutionException
    {
        List attachedArtifacts = ( List )project.getAttachedArtifacts();

        Iterator iter = attachedArtifacts.iterator();

        while ( iter.hasNext() )
        {
            Artifact artifact = (Artifact) iter.next();
            if ( attachFile.equals( artifact.getFile() ) )
            {
                throw new MojoExecutionException( "Duplicate file attachment found: " + attachFile );
            }
        }
    }

}