All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.code.play2.plugin.Play2EnhanceClassesMojo Maven / Gradle / Ivy

There is a newer version: 1.0.0-rc5
Show newest version
/*
 * Copyright 2013-2014 Grzegorz Slowikowski (gslowikowski at gmail dot com)
 *
 * 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.
 */

package com.google.code.play2.plugin;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;

import org.codehaus.plexus.util.DirectoryScanner;
import org.codehaus.plexus.util.FileUtils;

import com.google.code.play2.provider.api.Play2JavaEnhancer;
import com.google.code.play2.provider.api.Play2Provider;

import com.google.code.sbt.compiler.api.Analysis;
import com.google.code.sbt.compiler.api.AnalysisProcessor;

/**
 * Java classes enhance
 * 
 * @author Grzegorz Slowikowski
 * @since 1.0.0
 */
@Mojo( name = "enhance", defaultPhase = LifecyclePhase.PROCESS_CLASSES, requiresDependencyResolution = ResolutionScope.COMPILE )
public class Play2EnhanceClassesMojo
    extends AbstractPlay2EnhanceMojo
{
    private static final String appDirectoryName = "app";

    private static final String srcManagedDirectoryName = "src_managed/main";

    /**
     * Project classpath.
     */
    @Parameter( defaultValue = "${project.compileClasspathElements}", readonly = true, required = true )
    private List classpathElements;

    /**
     * The directory for compiled classes.
     */
    @Parameter( defaultValue = "${project.build.outputDirectory}", required = true, readonly = true )
    private File outputDirectory;

    @Override
    protected void internalExecute()
        throws MojoExecutionException, MojoFailureException, IOException
    {
        List classpathElementsCopy = classpathElements;
        // ?classpathElementsCopy.remove( outputDirectory.getAbsolutePath() );

        List classpath = new ArrayList( classpathElementsCopy.size() );
        for ( String path : classpathElementsCopy )
        {
            classpath.add( new File( path ) );
        }

        enhanceClasses( classpath );
    }

    private void enhanceClasses( List classpathFiles )
        throws MojoExecutionException, IOException
    {
        File analysisCacheFile = getAnalysisCacheFile();
        if ( !analysisCacheFile.exists() )
        {
            throw new MojoExecutionException( String.format( "Analysis cache file \"%s\" not found", analysisCacheFile.getAbsolutePath() ) );
        }
        if ( !analysisCacheFile.isFile() )
        {
            throw new MojoExecutionException( String.format( "Analysis cache \"%s\" is not a file", analysisCacheFile.getAbsolutePath() ) );
        }

        AnalysisProcessor sbtAnalysisProcessor = getSbtAnalysisProcessor();
        Analysis analysis = sbtAnalysisProcessor.readFromFile( analysisCacheFile );

        Play2Provider play2Provider = getProvider();
        Play2JavaEnhancer enhancer = play2Provider.getEnhancer();
        try
        {
            /*StringBuilder sb = new StringBuilder();
            for (File classpathFile: classpathFiles)
            {
                sb.append(classpathFile.getAbsolutePath()).append(java.io.File.pathSeparator);
            }
            sb.append(getOutputDirectory().getAbsolutePath());
            String classpath = sb.toString();*/

            // enhancer.setClasspath( classpath );//TODO Change type
            enhancer.setClasspathFiles( classpathFiles );

            File timestampFile = new File( getAnalysisCacheFile().getParentFile(), "play_instrumentation" );
            long lastEnhanced = 0L;
            if ( timestampFile.exists() )
            {
                String line = readFileFirstLine( timestampFile );
                lastEnhanced = Long.parseLong( line );
            }

            boolean anyJavaClassesEnhanced = enhanceJavaClasses( lastEnhanced, analysis, enhancer );
            boolean anyTemplateClassesEnhanced = enhanceTemplateClasses( lastEnhanced, analysis, enhancer );

            if ( anyJavaClassesEnhanced || anyTemplateClassesEnhanced )
            {
                if ( analysis != null )
                {
                    analysis.writeToFile( analysisCacheFile );
                }
                writeToFile( timestampFile, Long.toString( System.currentTimeMillis() ) );
            }
        }
        catch ( IOException e )
        {
            throw e;
        }
        catch ( Exception e )// TODO-???
        {
            throw new MojoExecutionException( "Enhancement exception", e );
        }

        synchronizeManagedClasses( analysis );
    }

    private boolean enhanceJavaClasses( long lastEnhanced/*, AnalysisProcessor sbtAnalysisProcessor*/, Analysis analysis, Play2JavaEnhancer enhancer ) throws Exception
    {
        File scannerBaseDir = new File( project.getBasedir(), appDirectoryName );
        if ( !scannerBaseDir.isDirectory() )
        {
            getLog().info( "No classes to enhance" );
            return false;
        }

        DirectoryScanner scanner = new DirectoryScanner();
        scanner.setBasedir( scannerBaseDir );
        scanner.setIncludes( new String[] { "**/*.java" } );
        scanner.addDefaultExcludes();
        scanner.scan();
        String[] javaSources = scanner.getIncludedFiles();

        int processedFiles = 0;
        int enhancedFiles = 0;

        if ( javaSources.length > 0 )
        {
            for ( String source : javaSources )
            {
                File sourceFile = new File( scannerBaseDir, source );
                if ( analysis.getCompilationTime( sourceFile ) > lastEnhanced )
                {
                    Set javaClasses = analysis.getProducts( sourceFile );
                    for ( File classFile : javaClasses )
                    {
                        processedFiles++;
                        if ( enhancer.enhanceJavaClass( classFile ) )
                        {
                            enhancedFiles++;
                            getLog().debug( String.format( "\"%s\" enhanced", classFile.getPath() ) );
                            //if ( sbtAnalysisProcessor.areClassFileTimestampsSupported() )
                            //{
                                analysis.updateClassFileTimestamp( classFile );
                            //}
                        }
                        else
                        {
                            getLog().debug( String.format( "\"%s\" skipped", classFile.getPath() ) );
                        }
                    }
                }
            }
        }

        if ( processedFiles > 0 )
        {
            getLog().info( String.format( "%d classes processed, %d enhanced", Integer.valueOf( processedFiles ),
                                          Integer.valueOf( enhancedFiles ) ) );
        }
        else
        {
            getLog().info( "No classes to enhance" );
        }

        return enhancedFiles > 0;
    }

    private boolean enhanceTemplateClasses( long lastEnhanced, Analysis analysis, Play2JavaEnhancer enhancer ) throws Exception
    {
        File scannerBaseDir = new File( project.getBuild().getDirectory(), srcManagedDirectoryName ); // TODO-parametrize
        if ( !scannerBaseDir.isDirectory() )
        {
            getLog().info( "No templates to enhance" );
            return false;
        }

        DirectoryScanner scanner = new DirectoryScanner();
        scanner.setBasedir( scannerBaseDir );
        scanner.setIncludes( new String[] { "**/*.template.scala" } );
        scanner.scan();
        String[] scalaTemplateSources = scanner.getIncludedFiles();

        int processedFiles = 0;
        int enhancedFiles = 0;

        if ( scalaTemplateSources.length > 0 )
        {
            for ( String source : scalaTemplateSources )
            {
                File sourceFile = new File( scannerBaseDir, source );
                if ( analysis.getCompilationTime( sourceFile ) > lastEnhanced )
                {
                    Set templateClasses = analysis.getProducts( sourceFile );
                    for ( File classFile : templateClasses )
                    {
                        processedFiles++;
                        if ( enhancer.enhanceTemplateClass( classFile ) )
                        {
                            enhancedFiles++;
                            getLog().debug( String.format( "\"%s\" enhanced", classFile.getPath() ) );
                            analysis.updateClassFileTimestamp( classFile );
                        }
                        else
                        {
                            getLog().debug( String.format( "\"%s\" skipped", classFile.getPath() ) );
                        }
                    }
                }
            }
        }

        if ( processedFiles > 0 )
        {
            getLog().info( String.format( "%d templates processed, %d enhanced", Integer.valueOf( processedFiles ),
                                          Integer.valueOf( enhancedFiles ) ) );
        }
        else
        {
            getLog().info( "No templates to enhance" );
        }
        return enhancedFiles > 0;
    }

    private void synchronizeManagedClasses( Analysis analysis ) throws IOException
    {
        File managedSrcDir = new File( project.getBuild().getDirectory(), srcManagedDirectoryName );
        if ( !managedSrcDir.isDirectory() )
        {
            return;
        }

        // Play 2.1.5 - PlayCommands.scala from line 371
        // Play 2.2.0 - PlayCommands.scala from line 160
        File managedClassesDir = new File( outputDirectory.getParentFile(), outputDirectory.getName() + "_managed" );
        Set managedClassesSet = new HashSet();
        if ( managedClassesDir.isDirectory() )
        {
            DirectoryScanner scanner = new DirectoryScanner();
            scanner.setBasedir( managedClassesDir );
            scanner.scan();
            String[] managedClasses = scanner.getIncludedFiles();
            managedClassesSet.addAll( Arrays.asList( managedClasses ) );
        }

        DirectoryScanner scanner = new DirectoryScanner();
        scanner.setBasedir( managedSrcDir );
        scanner.setIncludes( new String[] { "**/*.scala", "**/*.java" } );
        scanner.scan();
        String[] managedSources = scanner.getIncludedFiles();
        if ( managedSources.length > 0 )
        {
            if ( !managedClassesDir.exists() )
            {
                if ( !managedClassesDir.mkdirs() )
                {
                    // ??
                }
            }
        }
        for ( String source : managedSources )
        {
            File sourceFile = new File( managedSrcDir, source );
            Set sourceProducts = analysis.getProducts( sourceFile );
            // sbt.IO$.MODULE$.copy(ma byc Seq sourceProducts, sbt.IO$.MODULE$.copy$default$2(),
            // sbt.IO$.MODULE$.copyDirectory$default$3());
            // System.out.println("outdir: " + getOutputDirectory().getPath());
            for ( File file : sourceProducts )
            {
                // System.out.println("path: " + file.getPath());
                // String relativePath = PathTool.getRelativePath( getOutputDirectory().getPath(),
                // file.getPath() );
                String relativePath = file.getPath().substring( outputDirectory.getPath().length() );
                if ( relativePath.startsWith( File.separator ) )
                {
                    relativePath = relativePath.substring( 1 );
                }
                // System.out.println("product: " + relativePath);
                File destinationFile = new File( managedClassesDir, relativePath );
                FileUtils.copyFile( file, destinationFile );
                managedClassesSet.remove( relativePath );
            }
        }

        for ( String managedClassPath : managedClassesSet )
        {
            // System.out.println('*' + managedClsssPath);
            File fileToDelete = new File( managedClassesDir, managedClassPath );
            if ( !fileToDelete.delete() )
            {
                // ??
            }
        }
    }

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy