SqueakyCleanMojo.java

package org.ops4j.pax.construct.lifecycle;

/*
 * Copyright 2007 Stuart McCulloch
 *
 * 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.
 */

import java.io.File;
import java.io.IOException;

import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.project.MavenProject;
import org.apache.maven.shared.model.fileset.FileSet;
import org.apache.maven.shared.model.fileset.util.FileSetManager;
import org.ops4j.pax.construct.util.CacheUtils;
import org.ops4j.pax.construct.util.PomUtils;

/**
 * Remove generated IDE files, but support limited recovery during the same build session.<br/>So 'mvn pax:clean
 * pax:eclipse' won't wipe out your Eclipse metadata on a compile error.
 * 
 * @goal clean
 * @phase clean
 * 
 * @execute phase="clean"
 */
public class SqueakyCleanMojo extends AbstractMojo
{
    /**
     * Project base directory.
     * 
     * @parameter expression="${project.basedir}"
     * @required
     * @readonly
     */
    private File m_basedir;

    /**
     * The current Maven project (will be Maven super-POM if no existing project)
     * 
     * @parameter expression="${project}"
     * @required
     * @readonly
     */
    private MavenProject m_project;

    /**
     * {@inheritDoc}
     */
    public void execute()
        throws MojoExecutionException
    {
        // only bundle projects need special cleaning
        if( !PomUtils.isBundleProject( m_project ) )
        {
            return;
        }

        getLog().info( "[caching meta-data]" );

        // cache files that we might have problems re-generating during the current lifecycle
        CacheUtils.pushFile( this, "MANIFEST.MF", new File( m_basedir, "META-INF/MANIFEST.MF" ) );
        CacheUtils.pushFile( this, ".project", new File( m_basedir, ".project" ) );
        CacheUtils.pushFile( this, ".classpath", new File( m_basedir, ".classpath" ) );
        getPluginContext().put( "basedir", m_basedir.getPath() );

        FileSet generatedPaxFiles = new FileSet();
        generatedPaxFiles.setDirectory( m_basedir.getPath() );
        generatedPaxFiles.setUseDefaultExcludes( true );
        generatedPaxFiles.setFollowSymlinks( true );

        // remove Eclipse/PDE files (keep .settings)
        generatedPaxFiles.addInclude( "META-INF/" );
        generatedPaxFiles.addInclude( "OSGI-INF/" );
        generatedPaxFiles.addInclude( ".project" );
        generatedPaxFiles.addInclude( ".classpath" );

        try
        {
            new FileSetManager( getLog(), false ).delete( generatedPaxFiles );
        }
        catch( IOException e )
        {
            throw new MojoExecutionException( "I/O error while deleting files", e );
        }
    }

    /**
     * Recover previously cached IDE files from the current Maven session
     * 
     * @param mojo currently executing mojo
     */
    protected static void recoverMetaData( AbstractMojo mojo )
    {
        mojo.getLog().info( "[recovering meta-data]" );

        String basedir = (String) mojo.getPluginContext().get( "basedir" );

        // Restore generated files (previously removed during clean phase) before re-generation
        CacheUtils.pullFile( mojo, "MANIFEST.MF", new File( basedir, "META-INF/MANIFEST.MF" ) );
        CacheUtils.pullFile( mojo, ".project", new File( basedir, ".project" ) );
        CacheUtils.pullFile( mojo, ".classpath", new File( basedir, ".classpath" ) );
    }
}