/*

* Copyright (c) 2009 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.carbide.cdt.builder.builder;

import java.io.File;

import java.io.IOException;

import java.util.ArrayList;

import java.util.Collections;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import org.eclipse.cdt.core.CCorePlugin;

import org.eclipse.cdt.core.model.ICModelMarker;

import org.eclipse.cdt.core.resources.IConsole;

import org.eclipse.cdt.utils.spawner.EnvironmentReader;

import org.eclipse.core.resources.IFile;

import org.eclipse.core.resources.IMarker;

import org.eclipse.core.resources.IProject;

import org.eclipse.core.resources.IResource;

import org.eclipse.core.resources.IResourceDelta;

import org.eclipse.core.resources.IWorkspace;

import org.eclipse.core.resources.IncrementalProjectBuilder;

import org.eclipse.core.resources.ResourcesPlugin;

import org.eclipse.core.runtime.CoreException;

import org.eclipse.core.runtime.IPath;

import org.eclipse.core.runtime.IProgressMonitor;

import org.eclipse.core.runtime.IStatus;

import org.eclipse.core.runtime.NullProgressMonitor;

import org.eclipse.core.runtime.Path;

import org.eclipse.core.runtime.Status;

import org.eclipse.core.runtime.SubMonitor;

import org.eclipse.jface.window.Window;

import org.eclipse.swt.widgets.Display;

import com.nokia.carbide.cdt.builder.CarbideBuilderPlugin;

import com.nokia.carbide.cdt.builder.DefaultMMPViewConfiguration;

import com.nokia.carbide.cdt.builder.DefaultViewConfiguration;

import com.nokia.carbide.cdt.builder.EpocEngineHelper;

import com.nokia.carbide.cdt.builder.EpocEnginePathHelper;

import com.nokia.carbide.cdt.builder.PKGViewPathHelper;

import com.nokia.carbide.cdt.builder.project.ICarbideBuildConfiguration;

import com.nokia.carbide.cdt.builder.project.ICarbideProjectInfo;

import com.nokia.carbide.cdt.builder.project.IROMBuilderInfo;

import com.nokia.carbide.cdt.builder.project.ISISBuilderInfo;

import com.nokia.carbide.cdt.internal.api.builder.SISBuilderInfo2;

import com.nokia.carbide.cdt.internal.builder.CarbideSBSv1Builder;

import com.nokia.carbide.cdt.internal.builder.CarbideSBSv2Builder;

import com.nokia.carbide.cdt.internal.builder.ICarbideBuilder;

import com.nokia.carbide.cdt.internal.builder.ui.BuilderPreferencePage;

import com.nokia.carbide.cdt.internal.builder.ui.MMPSelectionDialog;

import com.nokia.carbide.cpp.epoc.engine.EpocEnginePlugin;

import com.nokia.carbide.cpp.epoc.engine.MMPDataRunnableAdapter;

import com.nokia.carbide.cpp.epoc.engine.PKGViewRunnableAdapter;

import com.nokia.carbide.cpp.epoc.engine.model.bldinf.IExtension;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.EMMPLanguage;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.EMMPStatement;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPData;

import com.nokia.carbide.cpp.epoc.engine.model.mmp.IMMPResource;

import com.nokia.carbide.cpp.epoc.engine.preprocessor.AcceptedNodesViewFilter;

import com.nokia.carbide.cpp.internal.x86build.X86BuildPlugin;

import com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext;

import com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.EPKGLanguage;

import com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGEmbeddedSISFile;

import com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGHeader;

import com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGInstallFile;

import com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.IPKGView;

import com.nokia.carbide.internal.api.cpp.epoc.engine.model.pkg.PKGModelHelper;

import com.nokia.cpp.internal.api.utils.core.FileUtils;

import com.nokia.cpp.internal.api.utils.ui.WorkbenchUtils;

/**

 * Main interface for invoking different build stages.

 *

 */

public class CarbideCPPBuilder extends IncrementalProjectBuilder {

	//TODO do we need to pipe output of compiles to files so we get then errors/warnings in order?

	public static final String BUILDER_ID = "com.nokia.carbide.cdt.builder.carbideCPPBuilder"; //$NON-NLS-1$

	public static final int BUILD_COMPONENT_ACTION = 0;

	public static final int CLEAN_COMPONENT_ACTION = 1;

	public static final int FREEZE_COMPONENT_ACTION = 2;

    public static final String RESOLVED_PKG_PREFIX = "_resolved"; //$NON-NLS-1$

    private static final boolean SHOW_ENV_VARS = true;

    private static final String PKG_SYMBOL_EPOCROOT = "$(EPOCROOT)"; //$NON-NLS-1$

    private static final String PKG_SYMBOL_PLATFORM = "$(PLATFORM)"; //$NON-NLS-1$

    private static final String PKG_SYMBOL_TARGET = "$(TARGET)"; //$NON-NLS-1$

    private static final String DEFAULT_KEY_NAME = "key-gen.key"; //$NON-NLS-1$

    private static final String DEFAULT_CERT_NAME = "cert-gen.cer"; //$NON-NLS-1$

    private static final String DEAULT_PASSWORD = "DefaultPassword"; //$NON-NLS-1$

    private static final String MAKEKEYS_EXE = "makekeys.exe"; //$NON-NLS-1$

    private static final String MAKESIS_EXE = "makesis.exe"; //$NON-NLS-1$

    private static final String SIGNSIS_EXE = "signsis.exe"; //$NON-NLS-1$

	private static List<IPath> normalMakMakePaths = Collections.synchronizedList(new ArrayList<IPath>());

	private static List<IPath> testMakMakePaths = Collections.synchronizedList(new ArrayList<IPath>());

	private static ICarbideBuilder v1Builder = new CarbideSBSv1Builder();

	private static ICarbideBuilder v2Builder = new CarbideSBSv2Builder();

	private static ICarbideBuilder getBuilder(IProject project) {

		if (CarbideBuilderPlugin.getBuildManager().isCarbideSBSv2Project(project)) {

			return v2Builder;

		} else {

			return v1Builder;

		}

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see org.eclipse.core.internal.events.InternalBuilder#build(int,

	 *      java.util.Map, org.eclipse.core.runtime.IProgressMonitor)

	 */

	@SuppressWarnings("unchecked")

	protected IProject[] build(int kind, Map args, IProgressMonitor monitor)

			throws CoreException {

		SubMonitor subMonitor = SubMonitor.convert(monitor, 1);

		IProject currentProject = getProject();

		ICarbideProjectInfo cpi = CarbideBuilderPlugin.getBuildManager().getProjectInfo(currentProject);

		if (cpi != null) {

			if (cpi.incrementalBuilderEnabled()) {

				// the callOnEmptyDelta builder attribute is set, so we get called

				// not matter what, even with an empty delta.  this means that when the

				// incremental build option is disabled, we still get called.  when it's

				// enabled, we just check the delta.  if null, we need to build.  otherwise

				// see what's changed and decide from that.

				IResourceDelta delta = getDelta(currentProject);

				if (delta != null) {

					// something in the workspace has changed.  see if a rebuild is needed.

					if (!shouldRebuild(delta)) {

						// also rebuild if the project has errors

						boolean hasErrors = false;

				    	try {

							for (IMarker currMarker : getProject().findMarkers(IMarker.PROBLEM, true, IResource.DEPTH_INFINITE)){

								if (currMarker.getAttribute(IMarker.SEVERITY, IMarker.SEVERITY_ERROR) == IMarker.SEVERITY_ERROR){

									hasErrors = true;

									break;

								}

							}

						} catch (CoreException e){

							e.printStackTrace();

						}

						if (!hasErrors) {

							return null;

						}

					}

				}

			}

			ICarbideBuildConfiguration defaultConfig = cpi.getDefaultConfiguration();

			if (defaultConfig != null) {

				CarbideCommandLauncher launcher = new CarbideCommandLauncher(currentProject, monitor, getParserIdArray(defaultConfig.getErrorParserId()), cpi.getINFWorkingDirectory());

				launcher.showCommand(true);

				invokeBuild(defaultConfig, launcher, subMonitor.newChild(1), true);

			} else {

	   			CarbideBuilderPlugin.createCarbideProjectMarker(currentProject, IMarker.SEVERITY_ERROR,  "Project has no configurations.", IMarker.PRIORITY_HIGH);

			}

		}

		monitor.done();

		return null;

	}

	protected boolean shouldRebuild(IResourceDelta delta) {

		// check for any changed files.  note that even if files are removed or added, they won't

		// affect the build unless the bld.inf or mmp files change.  those files will be picked up

		// by this check, so no need to worry about checking for added and removed resources.

		// I thought about maybe checking by file extension, but there's really no way for us to know the

		// comprehensive list.  note that they could change the input to a hlp file, any random

		// header file with any extension, even .txt files that are included in a pkg file.  so

		// at least for now we'll leave it as rebuilding when any file in the workspace changes.

		for (IResourceDelta child : delta.getAffectedChildren(IResourceDelta.CHANGED)) {

			IResource resource = child.getResource();

			if (resource != null) {

				if (resource.getType() == IResource.FILE) {

					// ignore changes to the .cproject and .project files

					if (!resource.getName().equals(".project") && !resource.getName().equals(".cproject")) {

						return true;

					}

				}

			}

			if (shouldRebuild(child)) {

				return true;

			}

		}

		return false;

	}

	protected void clean(IProgressMonitor monitor) throws CoreException {

		SubMonitor subMonitor = SubMonitor.convert(monitor, 1);

		IProject currentProject = getProject();

		ICarbideProjectInfo cpi = CarbideBuilderPlugin.getBuildManager().getProjectInfo(currentProject);

		if (cpi != null) {

			ICarbideBuildConfiguration defaultConfig = cpi.getDefaultConfiguration();

			if (defaultConfig != null) {

				invokeClean(defaultConfig, subMonitor.newChild(1), true);

			} else {

	   			CarbideBuilderPlugin.createCarbideProjectMarker(currentProject, IMarker.SEVERITY_ERROR,  "Project has no configurations.", IMarker.PRIORITY_HIGH);

			}

		}

		monitor.done();

	}

	/**

	 * Invokes a build for the given build configuration.  Output is piped to the given console and progress is reported

	 * using the given monitor.  Make files are created/updated if necessary.

	 * @param buildConfig the build configuration to build

	 * @param launcher the Carbide launcher

	 * @param monitor the progress monitor to use to report progress

	 * @param clearMarkers true if project markers should be cleared before action is taken

	 */

	public static void invokeBuild(ICarbideBuildConfiguration buildConfig, CarbideCommandLauncher launcher, IProgressMonitor monitor, boolean clearMarkers) {

		ICarbideProjectInfo cpi = buildConfig.getCarbideProject();

		if (clearMarkers) {

    		try {

    			removeAllMarkers(cpi.getProject());

    		} catch (CoreException e) {

    			e.printStackTrace();

    		}

        }

		calculateComponentLists(buildConfig, launcher);

		launcher.startTimingStats();

		launcher.writeToConsole("\n***Building project \"" + cpi.getProject().getName() + "\" for configuration \"" + buildConfig.getDisplayString() + "\"\n");

		getBuilder(cpi.getProject()).preBuildStep(buildConfig, launcher);

		runPreBuildChecks(buildConfig, launcher);

		if (SHOW_ENV_VARS){ 

			launcher.writeToConsole("\n***Printing environment variables modified from default:\n");

			String[] modEnvVars = getModifiedEnvVars(buildConfig);

			for (String envVar : modEnvVars){

				launcher.writeToConsole(envVar + "\n");

			}

			launcher.writeToConsole("\n");	

			launcher.writeToConsole("Working Directory: " + cpi.getINFWorkingDirectory() + "\n\n");	

		}

		boolean success = true;

		if (cpi.isBuildingFromInf()) {

			success = buildAllComponents(buildConfig, launcher, monitor);

		} else {

			success = buildComponentSubset(buildConfig, launcher, monitor);

		}

		// error codes are not always returned from abld.pl and the like.

		// check for error markers on the project as well in case the error

		// parsers picked anything up.

		if (success && !projectHasBuildErrors(cpi.getProject())) {

			launcher.writeToConsole("\n***Build Complete\n");

			// build any sis files

			SubMonitor subMonitor = SubMonitor.convert(monitor, 1);

			invokeSISBuilder(buildConfig, launcher, subMonitor.newChild(1));

			// build ROM if necessary

			subMonitor = SubMonitor.convert(monitor, 1);

			invokeROMBuilder(buildConfig, launcher, subMonitor.newChild(1));

		} else {

			launcher.writeToConsole("\n***Errors were detected in build. See the Problems or Console view for details.\n");

		}

		launcher.writeToConsole(launcher.getTimingStats());

		// only refresh if the auto refresh workspace pref is turned off

        if (!ResourcesPlugin.getPlugin().getPluginPreferences().getBoolean(ResourcesPlugin.PREF_AUTO_REFRESH)) {

    		// refresh the file system to pick up any newly created files under the project

    		try {

    			cpi.getProject().refreshLocal(IResource.DEPTH_INFINITE, monitor);

    		} catch (CoreException e) {

    			// no file system refresh

    			e.printStackTrace();

    		}

        }

	}

	/**

	 * Invokes a clean for the given build configuration.  Output is piped to the given console and progress is reported

	 * using the given monitor.  Make files are created/updated if necessary.

	 * @param buildConfig the build configuration to clean

	 * @param monitor the progress monitor to use to report progress

	 * @param clearMarkers true if project markers should be cleared before action is taken

	 */

	public static void invokeClean(ICarbideBuildConfiguration buildConfig, IProgressMonitor monitor, boolean clearMarkers) {

		ICarbideProjectInfo cpi = buildConfig.getCarbideProject();

		IProject project = cpi.getProject();

		if (clearMarkers) {

    		try {

    			removeAllMarkers(project);

    		} catch (CoreException e) {

    			e.printStackTrace();

    		}

        }

		getBuilder(cpi.getProject()).preCleanStep(buildConfig);

		CarbideCommandLauncher launcher = new CarbideCommandLauncher(project, monitor, getParserIdArray(buildConfig.getErrorParserId()), cpi.getINFWorkingDirectory());

		launcher.showCommand(true);

		calculateComponentLists(buildConfig, launcher);

		launcher.startTimingStats();

		launcher.writeToConsole("\n***Cleaning project \"" + project.getName() + "\" for configuration \"" + buildConfig.getDisplayString() + "\"\n");

		if (cpi.isBuildingFromInf()) {

			cleanAllComponents(buildConfig, launcher, monitor);

		} else {

			cleanComponentSubset(buildConfig, launcher, monitor);

		}

		launcher.writeToConsole("\n***Clean Complete\n");

		launcher.writeToConsole(launcher.getTimingStats());

		// only refresh if the auto refresh workspace pref is turned off

        if (!ResourcesPlugin.getPlugin().getPluginPreferences().getBoolean(ResourcesPlugin.PREF_AUTO_REFRESH)) {

    		// refresh the file system to pick up any newly created files under the project

    		try {

    			cpi.getProject().refreshLocal(IResource.DEPTH_INFINITE, monitor);

    		} catch (CoreException e) {

    			// no file system refresh

    			e.printStackTrace();

    		}

        }

	}

	/**

	 * Invokes a freeze for the given build configuration.  Output is piped to the given console and progress is reported

	 * using the given monitor.  Make files are created/updated if necessary.

	 * @param buildConfig the build configuration to freeze

	 * @param monitor the progress monitor to use to report progress

	 * @param clearMarkers true if project markers should be cleared before action is taken

	 */

	public static void invokeFreeze(ICarbideBuildConfiguration buildConfig, IProgressMonitor monitor, boolean clearMarkers) {

		ICarbideProjectInfo cpi = buildConfig.getCarbideProject();

		IProject project = cpi.getProject();

		CarbideCommandLauncher launcher = new CarbideCommandLauncher(project, monitor, getParserIdArray(buildConfig.getErrorParserId()), cpi.getINFWorkingDirectory());

		launcher.showCommand(true);

		// make sure the project is built

		launcher.writeToConsole("\n***Bringing project up to date before freezing\n");

		invokeBuild(buildConfig, launcher, monitor, clearMarkers);

		launcher.startTimingStats();

		launcher.writeToConsole("\n***Freezing project \"" + project.getName() + "\" for configuration \"" + buildConfig.getDisplayString() + "\"\n");

		if (cpi.isBuildingFromInf()) {

			freezeAllComponents(buildConfig, launcher, monitor);

		} else {

			freezeComponentSubset(buildConfig, launcher, monitor);

		}

		launcher.writeToConsole("\n***Freeze Complete\n");

		launcher.writeToConsole(launcher.getTimingStats());

	}

	/**

	 * Invoke the given action on the given Symbian mmp/make file for the given build configuration.

	 * @param buildConfig the build configuration to act upon

	 * @param action the action to perform, see {@link #BUILD_COMPONENT_ACTION}, {@link #CLEAN_COMPONENT_ACTION}, {@link #FREEZE_COMPONENT_ACTION}

	 * @param componentPath the full path of the mmp or make file

     * @param launcher - The object to use for the process execution

	 * @param monitor the progress monitor to report progress to

	 * @param clearMarkers true if project markers should be cleared before action is taken

	 * @return true if successful, false otherwise

	 * @throws CoreException

	 */

	public static boolean invokeSymbianComponenetAction(ICarbideBuildConfiguration buildConfig, int action, IPath componentPath, CarbideCommandLauncher launcher, IProgressMonitor monitor, boolean clearMarkers) throws CoreException {

		ICarbideProjectInfo cpi = buildConfig.getCarbideProject();		

		List<ISymbianBuildContext> buildConfigList = new ArrayList<ISymbianBuildContext>(1);

		buildConfigList.add(buildConfig);

		if (clearMarkers) {

    		try {

    			removeAllMarkers(cpi.getProject());

    		} catch (CoreException e) {

    			e.printStackTrace();

    		}

        }

		List<IPath> normalMakMakePaths = new ArrayList<IPath>();

		List<IPath> testMakMakePaths = new ArrayList<IPath>();

		// get the list of mmp/make files for this build configuration.  note that we're not calling calculateComponentLists here

		// because then the caller would only be able to build components that are build built by a full build.  but that's kind of

		// limiting.  they may have build test components disabled but just want to verify that one test mmp still builds.

		EpocEngineHelper.getMakMakeFiles(cpi.getAbsoluteBldInfPath(), buildConfigList, normalMakMakePaths, testMakMakePaths, new NullProgressMonitor());

		boolean found = false;

		boolean isTest = false;

		// see if we can find the component

		for (IPath path : normalMakMakePaths) {

			if (path.equals(componentPath)) {

				found = true;

				break;

			}

		}

		if (!found) {

			// try the test components

			for (IPath path : testMakMakePaths) {

				if (path.equals(componentPath)) {

					found = true;

					isTest = true;

					break;

				}

			}

		}

		if (!found) {

			throw new CoreException(new Status(IStatus.ERROR, CarbideBuilderPlugin.PLUGIN_ID, 0, "Component " + componentPath.toOSString() + " not found.", null)); //$NON-NLS-1$ //$NON-NLS-2$

		}

		launcher.startTimingStats();

		String componentName = componentPath.removeFileExtension().lastSegment();

		boolean result = false;

		if (action == BUILD_COMPONENT_ACTION) {

			runPreBuildChecks(buildConfig, launcher);

			launcher.writeToConsole("\n***Building component \"" + componentName + "\" for configuration \"" + buildConfig.getDisplayString() + "\"\n");

			result = getBuilder(cpi.getProject()).buildComponent(buildConfig, componentPath, isTest, launcher, monitor);

		} else if (action == CLEAN_COMPONENT_ACTION) {

			launcher.writeToConsole("\n***Cleaning component \"" + componentName + "\" for configuration \"" + buildConfig.getDisplayString() + "\"\n");

			result = getBuilder(cpi.getProject()).cleanComponent(buildConfig, componentPath, isTest, launcher, monitor);

		} else if (action == FREEZE_COMPONENT_ACTION) {

			SubMonitor progress = SubMonitor.convert(monitor, 3);

			progress.setTaskName("Freezing " + componentName);

			// make sure the component is built

			launcher.writeToConsole("\n***Bringing component up to date before freezing\n");

			boolean success = invokeSymbianComponenetAction(buildConfig, BUILD_COMPONENT_ACTION, componentPath, launcher, progress.newChild(1), false);

			if (success) {

				launcher.writeToConsole("\n***Freezing component \"" + componentName + "\" for configuration \"" + buildConfig.getDisplayString() + "\"\n");

				result = getBuilder(cpi.getProject()).freezeComponent(buildConfig, componentPath, isTest, launcher, progress);

			}

		}

		return result;

	}

	/**

	 * Invokes a compile of the the given file for the given build configuration.  Output is piped to the given console and

	 * progress is reported using the given monitor.  Make files are created/updated if necessary.

	 * @param file the absolute file system path to the file to be compiled (source, resource)

	 * @param buildConfig the build configuration to build

	 * @param console the console to pipe build output to

     * @param launcher - The object to use for the process execution

	 * @param monitor the progress monitor to use to report progress

	 * @param clearMarkers whether or not to clear project markers before compiling

	 * @throws CoreException

	 */

	public static void compileFile(IPath file, ICarbideBuildConfiguration buildConfig, IConsole console, CarbideCommandLauncher launcher, IProgressMonitor monitor, boolean clearMarkers) throws CoreException {

		ICarbideProjectInfo cpi = buildConfig.getCarbideProject();

		if (clearMarkers) {

    		try {

    			removeAllMarkers(cpi.getProject());

    		} catch (CoreException e) {

    			e.printStackTrace();

    		}

        }

		final SubMonitor progress = SubMonitor.convert(monitor, 5);

		progress.setTaskName("Compiling " + file.lastSegment());

		final List<IPath> parentMMPs = EpocEngineHelper.getMMPsForSource(cpi.getProject(), file);

		if (parentMMPs.isEmpty()) {

			throw new CoreException(new Status(IStatus.ERROR, CarbideBuilderPlugin.PLUGIN_ID, 0, "Unable to find parent MMP for file " + file.toOSString(), null)); //$NON-NLS-1$

		}