CpdTask.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/>.
 */
package org.squale.squalix.tools.cpd;

import java.util.Iterator;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.squale.squalecommon.enterpriselayer.businessobject.config.TaskParameterBO;
import org.squale.squalecommon.enterpriselayer.businessobject.result.ErrorBO;
import org.squale.squalix.core.AbstractTask;
import org.squale.squalix.core.TaskData;
import org.squale.squalix.core.TaskException;
import org.squale.squalix.core.exception.ConfigurationException;

/**
 * T�che de d�tection de copier/coller La t�che est configur�e par un ou plusieurs param�tres nomm�s 'language', chaque
 * param�tre donne lieu au lancement du de la d�tection du copy/paste correspondant
 */
public class CpdTask
    extends AbstractTask
{
    /**
     * Logger
     */
    private static final Log LOGGER = LogFactory.getLog( CpdTask.class );

    /**
     * Constructeur
     */
    public CpdTask()
    {
        mName = "CpdTask";
    }

    /**
     * {@inheritDoc}
     * 
     * @see org.squale.squalix.core.Task#execute()
     */
    public void execute()
        throws TaskException
    {
        try
        {
            // Cr�ation du persistor
            CpdPersistor persistor =
                new CpdPersistor( getProject(), getAudit(), (String) getData().getData( TaskData.VIEW_PATH ) );
            // Factory
            CpdProcessingFactory factory = new CpdProcessingFactory();
            // Pracours sur les langages
            boolean langFound = false;
            for ( Iterator it = getTaskParameters().iterator(); it.hasNext(); )
            {
                TaskParameterBO param = (TaskParameterBO) it.next();
                if ( param.getName().equals( "language" ) )
                {
                    LOGGER.info( CpdMessages.getString( "cpd.processing.language", param.getValue() ) );
                    langFound = true;
                    AbstractCpdProcessing processing = factory.createCpdProcessing( param.getValue() );
                    Iterator matches = processing.process( getData(), getProject().getParameters() );
                    // Stockage du langage
                    persistor.addResult( param.getValue(), matches );
                }
                else
                {
                    throw new ConfigurationException( CpdMessages.getString( "exception.parameter.invalid",
                                                                             new Object[] { param.getName(),
                                                                                 param.getValue() } ) );
                }
            }
            // V�rification qu'il existe au moins un language d�fini
            if ( !langFound )
            {
                throw new ConfigurationException( CpdMessages.getString( "exception.parameter.missing" ) );
            }
            // On fait persister les donn�es
            persistor.storeResults( getSession() );
        }
        catch ( Exception e )
        {
            // Traitement sp�cial pour les erreurs remont�es quand le code analys� n'est pas conforme
            // � la norme XHTML, on remonte ces erreurs juste avec un niveau warning
            if ( e.getMessage().indexOf( "net.sourceforge.pmd.jsp.ast.TokenMgrError: Lexical error" ) != -1 )
            {
                ErrorBO error = new ErrorBO();
                error.setInitialMessage( e.getMessage() );
                error.setMessage( CpdMessages.getString( "warning.code.no.conform.XHTML" ) );
                error.setLevel( ErrorBO.CRITICITY_WARNING );
                mErrors.add( error );
            }
            else
            {
                throw new TaskException( e );
            }
        }
    }
}