JXMLCompiler.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
//Source file: D:\\cc_views\\squale_v0_0_act\\squale\\src\\squalix\\src\\org\\squale\\squalix\\tools\\compiling\\java\\compiler\\xml\\XMLCompiler.java

package org.squale.squalix.tools.compiling.java.compiler.xml;

import java.io.File;
import java.io.FileNotFoundException;
import java.util.ArrayList;
import java.util.List;
import java.util.Vector;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.ProjectHelper;
import org.apache.tools.ant.types.Path;
import org.squale.squalix.core.TaskData;
import org.squale.squalix.tools.compiling.CompilingMessages;
import org.squale.squalix.tools.compiling.java.JCompilingTask;
import org.squale.squalix.tools.compiling.java.beans.JXMLProject;

/**
 * Ant Compilation
 * 
 * @author m400832 (by rose)
 * @version 1.0
 */
public class JXMLCompiler
{

    /**
     * Logger.
     */
    private static final Log LOGGER = LogFactory.getLog( JXMLCompiler.class );

    /**
     * Projet � compiler.
     */
    private JXMLProject mProject;

    /**
     * Constructeur.
     * 
     * @param pProject projet � compiler.
     */
    public JXMLCompiler( JXMLProject pProject )
    {
        mProject = pProject;
    }

    /**
     * Cette m�thode lance la proc�dure de compilation.
     * 
     * @throws Exception en cas d'erreur lors de l'ex�cution du script ANT.
     * @see #doCompilation()
     */
    public void execute()
        throws Exception
    {
        LOGGER.trace( CompilingMessages.getString( "logs.task.entering_method" ) );
        doCompilation();
    }

    /**
     * Cette m�thode lance effectivement la compilation.
     * 
     * @throws Exception exception lors de la compilation par ANT.
     */
    private void doCompilation()
        throws Exception
    {
        LOGGER.trace( CompilingMessages.getString( "logs.task.entering_method" ) );

        /*
         * Cr�ation d'un descripteur de fichier avec un chemin UNIX.
         */
        File buildFile =
            new File ( mProject.getPath() );

        /*
         * La proc�dure n'est lanc�e que si le fichier XML est trouv�.
         */
        if ( buildFile.exists() && buildFile.isFile() )
        {
            /*
             * Initialisation du projet ANT.
             */
            Project project = new Project();
            project.setCoreLoader( null );
            project.init();

            /*
             * Propri�t�s du projet ANT.
             */
            project.setUserProperty( CompilingMessages.getString( "java.compiling.ant.key.ant.version" ),
                                     CompilingMessages.getString( "java.compiling.ant.value.ant.version" ) );
            project.setUserProperty( CompilingMessages.getString( "java.compiling.ant.key.ant.file" ),
                                     buildFile.getAbsolutePath() );

            /* mode keep-going � false */
            project.setKeepGoingMode( false );

            // Ajout du listener pour les traces
            project.addBuildListener( mProject.getListener() );
            /*
             * Parsing du fichier xml.
             */
            ProjectHelper helper = ProjectHelper.getProjectHelper();
            project.addReference( CompilingMessages.getString( "java.compiling.ant.key.ant.project_helper" ), helper );
            helper.parse( project, buildFile );

            /*
             * Ajout de la t�che � lancer.
             */
            Vector targets = new Vector();
            /* si une target a �t� d�finie dans le JXMLProject */
            if ( null != mProject.getTarget() && !"".equals( mProject.getTarget() ) )
            {
                targets.addElement( (String) mProject.getTarget() );

                /* sinon on ajoute la target par d�faut du projet ANT */
            }
            else
            {
                targets.addElement( project.getDefaultTarget() );
            }

            /*
             * Ex�cution de la t�che ANT.
             */
            project.executeTargets( targets );

            /*
             * R�cup�ration du classpath dans le fichier build.xml et du classes_dir.
             */
            antClasspath( project );

            /* m�nage */
            project = null;
            targets = null;
            helper = null;

        }
        else
        {
            /* exception lanc�e si le fichier xml n'est pas trouv� */
            throw new FileNotFoundException(
                                             CompilingMessages.getString( "java.exception.compiling.ant.build_file_not_found" ) );
        }

    }

    /**
     * Getter.
     * 
     * @return un projet JXMLProject.
     */
    public JXMLProject getXMLProject()
    {
        return mProject;
    }

    /**
     * M�thode qui permet de recuperer le classpath et de redefinir pr�cis�ment l'emplacement des fichiers compil�s.
     * Pour que cette m�thode marche, il faut que l'utilisateur ait d�fini dans le fichier build.xml : Une propri�t�
     * nomm�e SqualeClassesDir qui indique l'emplacement des fichiers compil�s et une r�f�rence g�n�rant le classpath
     * portant l'identifiant SqualeClasspath
     * 
     * @param antProject projet ant dans lequel on effectue la recherche
     */
    private void antClasspath( Project antProject )
    {
        JCompilingTask compilingTask = (JCompilingTask) mProject.getListener();
        String classesDir = antProject.getProperty( "SqualeClassesDir" );
        File baseDir = antProject.getBaseDir();
        File test = new File( classesDir );
        if ( !test.isAbsolute() )
        {
            // if(!classesDir.startsWith("/")){
            classesDir = baseDir.getAbsolutePath() + "/" + classesDir;
        }
        List classesDirs = new ArrayList();
        classesDirs.add( classesDir );
        compilingTask.getData().putData( TaskData.CLASSES_DIRS, classesDirs );
        Path antClassPath = (Path) antProject.getReference( "SqualeClasspath" );
        String classpath = antClassPath.toString();
        String[] allpath = classpath.split( ":" );
        for ( int i = 0; i < allpath.length; i++ )
        {
            int index = allpath[i].indexOf( "${" );
            if ( index != -1 )
            {
                LOGGER.warn( CompilingMessages.getString( "java.exception.compiling.ant.classpath_warning" )
                    + allpath[i] );
            }
        }
        classpath = classpath.replace( ':', ';' );
        classpath = classpath + ';' + classesDir;
        compilingTask.getData().putData( TaskData.CLASSPATH, classpath );
    }
}