/*

 * Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of the License "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description:  

 *

 */

package com.nokia.helium.sbs.ant.taskdefs;

import java.util.List;

import org.apache.tools.ant.BuildException;

import org.apache.tools.ant.Project;

import org.apache.tools.ant.Task;

import com.nokia.helium.core.ant.MappedVariable;

import com.nokia.helium.core.ant.types.VariableSet;

import com.nokia.helium.sbs.SAXSysdefParser;

import com.nokia.helium.sbs.SBSCommandBase;

import com.nokia.helium.sbs.SBSException;

import com.nokia.helium.sbs.plexus.SBSErrorStreamConsumer;

/**

 * 

 * <pre>

 * Example 1:

 * 

 * <sbstask sbsinput="sbs.input" sysdefFile="system.def.file"

 *      layerPatternSetRef="sbs.patternset" errorOutput="sbs.log.file.error.log"

 *      workingDir="build.drive" failOnError="false" outputLog="sbs.log.file"

 *      cleanLog="sbs.log.file.clean.log" statsLog="sbs.log.file.info.xml" />

 * </pre>

 * 

 * @ant.task name="sbstask" category="SBS"

 */

public class SBSTask extends Task {

    private Logger log = Logger.getLogger(SBSTask.class);

    private String sbsInputName;

    private String layerPatternSetRef;

    private File sysDefFile;

    private File workingDir;

    private File errorFile;

    private String logSuffix;

    private File outputLogName;

    private boolean executeCmd = true;

    private boolean failOnError = true;

    private boolean addMakeOptions = true;

    private SBSCommandBase sbsCmd = new SBSCommandBase();;

    private String errorPattern;

    /**

     * @param logPath, path of the clean log file.

     * @deprecated

     */

    @Deprecated

    public void setCleanLog(String logPath) {

        log("The usage of the cleanLog attribute is deprecated.");

    }

    /**

     * @param logPath, path of the clean log file.

     * @deprecated

     */

    @Deprecated

    public void setWhatLog(String logPath) {

        log("The usage of the whatLog attribute is deprecated.");

    }

    /**

     * @param logName, name of the logfile to store the raptor output.

     */

    public void setOutputLog(File logName) {

        outputLogName = logName;

    }

    /**

     * To get the output log.

     * @return

     */

    public File getOutputLog() {

    }

    /**

     * @param log name of the logfile to store the raptor command statistics information.

     * @deprecated

     */

    @Deprecated

    public void setStatsLog(File log) {

    }

    /**

     * @param inputName name of the sbs input which contains the list of sbs parameters.

     */

    public void setSBSInput(String inputName) {

        sbsInputName = inputName;

    }

    /**

     * To get the sbs name.

     * @return

     */

    public String getSBSInput() {

    }

    /**

     * @param file path of the error output to be stored for the raptor command execution.

     */

    public void setErrorOutput(File file) {

        errorFile = file;

    }

    /**

     * To get the error output file.

     * @return

     */

    public File getErrorOutput() {

    }

    /**

     * @param file sysdef file path.

     */

    public void setSysDefFile(File file) {

        sysDefFile = file;

    }

    /**

     * To get the sysdef file.

     * @return

     */

    public File getSysDefFile() {

    }

    /**

     */

    public void setLogSuffix(String suffix) {

        logSuffix = suffix;

    }

    /**

     * To get the logsuffix.

     * @return

     */

    public String getLogSuffix() {

    }

    /**

     */

    public void setLayerPatternSetRef(String id) {

        layerPatternSetRef = id;

    }

    /**

     * 

     * @return

     */

    public String getLayerPatternSetRef() {

    }

    /**

     */

    public void setWorkingDir(File dir) {

        workingDir = dir;

    }

    /**

     * To get the working dir.

     * @return

     */

    public File getWorkingDir() {

    }

    /**

     */

    public void setExecute(boolean execute) {

        executeCmd = execute;

    }

    /**

     * To get execute value.

     * @return

     */

    public boolean getExecute() {

    }

    /**

     * @param failBuild true / false - true to fail the build otherwise false.

     */

    public void setFailOnError(boolean failBuild) {

        failOnError = failBuild;

    }

    /**

     * To get the failonError value.

     * @return

     */

    public boolean getFailOnError() {

    }

    /**

     * @param addMakeOptions the addMakeOptions to set

     */

    protected void setAddMakeOptions(boolean addMakeOptions) {

        this.addMakeOptions = addMakeOptions;

    }

    /**

     * To get the error Pattern.

     * @return

     */

    protected String getErrorStreamPattern() {

        return this.errorPattern;

    }

    /**

     * @throws BuildException

     */

    public void execute() {

        SBSErrorStreamConsumer sbsErrorConsumer = null;

        validateParameter();

        sbsCmd.setWorkingDir(workingDir);

        try {

            log.debug("error stream file : " + errorFile);

            sbsCmd.addOutputLineHandler(new AntStreamConsumer(this));

            if (errorFile == null) {

                log.debug("redirecting error to Antstream");

                sbsCmd.addErrorLineHandler(new AntStreamConsumer(this));

                sbsErrorConsumer = new SBSErrorStreamConsumer(errorFile, getErrorStreamPattern());

                log.debug("redirecting error to file stream");

                sbsCmd.addErrorLineHandler(sbsErrorConsumer);

            }

        }

        try {

            String cmdLine = getSBSCmdLine();

            if (cmdLine == null) {

                // sbs anyway so the output log is generated

                cmdLine = " --logfile " + getOutputLog().getAbsolutePath();

            }

            log(getSbsCmd().getExecutable() + " commands: " + cmdLine);

            if (executeCmd) {

                sbsCmd.execute(cmdLine);

            }

            log.debug("SBS exception occured during sbs execution", sex);

            if (failOnError) {

                throw new BuildException("exception during SBS execution", sex);

            }

            if (sbsErrorConsumer != null) {

                sbsErrorConsumer.close();

            }

        }

    }

    /**

     * 

     */

    private List<String> getFilteredLayers() {

        List<String> filteredLayers = null;

        if (layerPatternSetRef != null) {

            Hashtable references = getProject().getReferences();

                throw new BuildException("Layer Pattern set is not of type PatternSet");

            }

            if (layerPatternSetObject != null) {

                PatternSet layerPatternSet = (PatternSet) layerPatternSetObject;

                SAXSysdefParser sysDefParser = new SAXSysdefParser(sysDefFile);

                filteredLayers = new ArrayList<String>();

                String[] includes = layerPatternSet.getIncludePatterns(getProject());

                String[] excludes = layerPatternSet.getExcludePatterns(getProject());

                if (includes == null && excludes == null) {

                    throw new BuildException("No patterns specified");

                }

                for (String layer : fullLayerList) {

                    if (isIncluded(layer, includes)) {

                        if (!isExcluded(layer, excludes)) {

                            filteredLayers.add(layer);

                        }

                        continue;

                    }

                }

            }

        }

        return filteredLayers;

    }

    /**

     * @param text - layer name to be compared with

     * @param includes - compare the layer name with the includes list.

     * @return true if the text containing layer name to be included.

     */

    private boolean isIncluded(String text, String[] includes) {

        if (includes == null) {

            return true;

            for (String pattern : includes) {

                if (text.matches(pattern)) {

                    return true;

                }

            }

            return false;

        }

    }

    /**

     * @param text - layer name to be compared with

     * @param excludes - compare the layer name with the excludes list.

     * @return true if the text containing layer name to be excluded.

     */

    private boolean isExcluded(String text, String[] excludes) {

        if (excludes != null) {

            for (String pattern : excludes) {

                if (text.matches(pattern)) {

                    return true;

                }

            }

        }

        return false;

    }

    /**

     * To Validate the parameters passed.

     */

    protected void validateParameter() {

        if (getSBSInput() == null) {

            throw new BuildException("'sbsInputName' is not defined");

        }

        if (getSysDefFile() == null) {

            throw new BuildException("'System Definition' file is missing");

        }

        if (getWorkingDir() == null) {

            throw new BuildException("'workingDir' must be set");

        }

        if (getOutputLog() == null) {

            throw new BuildException("'OutputLog' must be set");

        }

    }

    /**

     * To get the SBS command line parameters.

     * @return

     */

    protected String getSBSCmdLine() {

        Object refObject = getProject().getReferences().get(sbsInputName);

        if (refObject == null) {

            throw new BuildException("invalid sbs input reference: " + sbsInputName);

        }

            throw new BuildException("sbs input name " + sbsInputName + "is not valid");

        }

        StringBuffer cmdOptions = new StringBuffer();

        VariableSet sbsOptions = sbsInput.getFullSBSOptions();

        cmdOptions.append(" -s " + sysDefFile);

        }

        cmdOptions.append(" --logfile " + getOutputLog().getAbsolutePath());

        for (MappedVariable variable : variableList) {

            if (variable.getParameter().startsWith("--logfile")) {

                cmdOptions.append(" " + variable.getParameter());

            }

        }

        SBSMakeOptions sbsMakeOptions = sbsInput.getFullSBSMakeOptions();

        variableList = null;

        if (sbsMakeOptions != null && addMakeOptions) {

            cmdOptions.append(" -e " + sbsMakeOptions.getEngine());

            String ppThreads = sbsMakeOptions.getPPThreads();