org.codehaus.mojo.dita.AbstractDitaMojo 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.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.shared.model.fileset.FileSet;
import org.apache.maven.shared.model.fileset.util.FileSetManager;
import org.codehaus.plexus.util.cli.Commandline;

/*
 * 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 DITA specific MOJOs
 */
public abstract class AbstractDitaMojo
    extends AbstractProjectMojo
{
    /**
     * Add jar files under DITA Open Toolkit's lib directory to execution classpath
     * 
     * @parameter expression="${dita.useDitaClasspath}" default-value="true"
     * @since 1.0-beta-1
     */
    protected boolean useDitaClasspath;
    
    /**
     * Internal. Compile time project dependencies to be add ed to Ant's classpath
     * @parameter expression="${project.compileClasspathElements}"
     * @since 1.0-beta-1
     */
    protected List classpathElements;

    
    /**
     * Ant key/value pair properties. 
     * 
     * Default properties for all dita's goals
     *   
     *     dita.dir=${env.DITA_HOME}
     *   
     * Default properties for dita:run goal
     *   
     *   basedir=${project.basedir}
     *   output.dir=${project.build.directory}/dita/out
     *   dita.temp.dir=${project.build.directory}/dita/temp
     *   args.logdir=${project.build.directory}/dita/log
     *   args.input=${project.basedir}/src/main/dita/${artifactId}.ditamap
     *   
     *   
     * @parameter
     * @since 1.0-beta-1
     */
    protected Map antProperties = new HashMap();
    
    ////////////////////////////////////////////////////////////////////////
    // internal
    ////////////////////////////////////////////////////////////////////////
    protected File ditaDirectory;
    
    protected void setupDitaDirectory()
      throws MojoExecutionException
    {
        if ( antProperties.get( "dita.dir" ) == null )
        {
            antProperties.put( "dita.dir", System.getenv( "DITA_HOME" ) );
        }

        if ( antProperties.get( "dita.dir" ) == null )
        {
            throw new MojoExecutionException( "antProperties' dita.dir or env.DITA_HOME configuration not set." );
        }
        
        this.ditaDirectory = new File( antProperties.get( "dita.dir" ) );

        if ( !ditaDirectory.isDirectory() )
        {
            throw new MojoExecutionException( "DITA Open Toolkit at " + ditaDirectory + " not found. " );
        }
    }

    /**
     * setup CLASSPATH env so that Ant can use it
     * 
     * @param cl
     */
    protected void setupClasspathEnv( Commandline cl )
    {
        String classpath = this.buildClasspathString();
        cl.addEnvironment( "CLASSPATH", classpath );
        this.getLog().debug( "CLASSPATH: " + classpath );
    }

    /**
     * Create classpath value
     * 
     * @return String
     */
    protected String buildClasspathString()
    {

        StringBuilder classpath = new StringBuilder();

        //Pick up dependency list. 
        Iterator it = classpathElements.iterator();
        while ( it.hasNext() )
        {
            String cpElement = it.next();
            classpath.append( cpElement ).append( File.pathSeparator );
        }

        if ( this.useDitaClasspath )
        {
            FileSetManager fileSetManager = new FileSetManager( this.getLog(), false );

            FileSet fileSet = new FileSet();
            fileSet.setDirectory( this.ditaDirectory.getAbsolutePath() + "/lib" );
            ArrayList includes = new ArrayList();
            includes.add( "**/*.jar" );
            fileSet.setIncludes( includes );

            String[] files = fileSetManager.getIncludedFiles( fileSet );

            for ( int i = 0; i < files.length; ++i )
            {
                File jarFile = new File( fileSet.getDirectory(), files[i] );
                classpath.append( jarFile.getAbsolutePath() ).append( File.pathSeparator );
            }
        }
        
        return classpath.toString();
    }

    protected void setupDitaMainClass( Commandline cl )
    {
        cl.createArg().setValue( "org.dita.dost.invoker.CommandLineInvoker" );
    }


}