/*

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

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "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.s60tools.crashanalyser.model;

import com.nokia.s60tools.crashanalyser.files.*;

import com.nokia.s60tools.crashanalyser.data.*;

import java.io.*;

/**

 * CrashFileBundle class bundles up one folder under Crash Analyser plugin's folder. I.e. one

 * CrashFileBundle is one row in MainView. A bundle can contain an undecoded MobileCrash file, 

 * decoded .crashxml file, partially decoded .crashxml file or an emulator panic xml file. Or a 

 * combination of these. 

 * 

 * All of the files listed above are found e.g. from 

 * c:\my_carbide_workspace\.metadata\.plugins\com.nokia.s60tools.crashanalyser\CrashFiles\[bundle_folder].

 * One bundle contains all files under one [bundle_folder]. 

 * 

 * Bundle can also be an empty bundle, so that 'No crash files found' row can be shown in MainView.

 * 

 * Bundle can also be a waiting bundle, so that 'Loading files. Please wait' row can be shown in MainView.

 *

 */

public class CrashFileBundle {

	public static final int INDEX_TIME = 0;

	public static final int INDEX_THREAD = 1;

	public static final int INDEX_PANIC_CATEGORY = 2;

	public static final int INDEX_PANIC_CODE = 3;

	public static final int INDEX_FILE_NAME = 4;

	public static final String EXTENSION_HTML = ".htm";

	/**

	 * A binary crash file 

	 */

	UndecodedFile undecodedFile = null;

	/**

	 * Fully decoded crash file 

	 */

	CrashFile crashxmlFile = null;

	/**

	 * Partially decoded crash file 

	 */

	SummaryFile summaryFile = null;

	/**

	 * A xml file which contains information about one emulator panic

	 */

	PanicFile emulatorPanicFile = null;

	/**

	 * Bundle name for an empty or waiting bundle  

	 */

	String bundleName = "";

	/**

	 * Folder where all bundle's files can be found from

	 */

	String bundleFolder = "";

	/**

	 * If true, bundle is an empty or waiting bundle

	 */

	boolean emptyFile = false;

	/**

	 * Directory from where files in this bundle originally came from.

	 * This data is not always present.

	 */

	String originatingDirectory = "";

	/**

	 * Used for creating an empty or waiting bundle

	 * @param empty If true, an empty bundle is created. If false, a waiting bundle is created. 

	 */

	public CrashFileBundle(boolean empty) {

		if (empty)

			bundleName = "No Crash Files Found.";

		else

			bundleName = "Loading files. Please wait.";

		emptyFile = true;

	}

	/**

	 * Creates a bundle from folder

	 * @param folder Bundle folder. Bundle's file will be read from here.

	 * @param library ErrorLibrary instance

	 */

	public CrashFileBundle(String folder, ErrorLibrary library) {

		bundleFolder = FileOperations.addSlashToEnd(folder);

		undecodedFile = UndecodedFile.read(bundleFolder);

		crashxmlFile = CrashFile.read(bundleFolder, library);

		emulatorPanicFile = PanicFile.read(bundleFolder, library);

		summaryFile = SummaryFile.read(bundleFolder, library);

		originatingDirectory = folder;

	}

	/**

	 * Initialise bundle with already read Crash file

	 * @param file crash file

	 */

	public CrashFileBundle(CrashFile file, String originalDirectory) {

		crashxmlFile = file;

		originatingDirectory = originalDirectory;

	}

	/**

	 * Initialise bundle with already read Summary file

	 * @param file summary file

	 */

	public CrashFileBundle(SummaryFile file, String originalDirectory) {

		summaryFile = file;

		originatingDirectory = originalDirectory;

	}

	protected CrashFileBundle(String folder) {

		bundleFolder = FileOperations.addSlashToEnd(folder);

	}

	/**

	 * Creates a dummy bundle, which can be used e.g. for comparison reasons.

	 * A dummy bundle can be compared to another bundle.

	 * @param folder bundle folder

	 * @return crash file bundle

	 */

	public static CrashFileBundle createDummyBundle(String folder) {

		return new CrashFileBundle(folder);

	}

	/**

	 * MainView can use this to get description for each column in the grid

	 * @param index index of the column

	 * @return value for asked column

	 */

	public String getText(int index) {

		String retval = "";

		switch (index) {

			case INDEX_TIME:

				retval = getTime();

				break;

			case INDEX_THREAD:

				retval = getThreadName();

				break;

			case INDEX_PANIC_CATEGORY:

				retval = getPanicCategory();

				break;

			case INDEX_PANIC_CODE:

				retval = getPanicCode();

				break;

			case INDEX_FILE_NAME:

				retval = getFileName();

				break;

			default:

				break;

		}

		return retval;

	}

	/**

	 * Returns the file name for this bundle. File name depends on what types

	 * of files this bundle contains (or if this bundle is an empty or waiting bundle).

	 *   

	 * @return the file name for this bundle.

	 */

	public String getFileName() {

		if (emptyFile)

			return bundleName;

		String retval = "";

		if (undecodedFile != null) {

			retval = undecodedFile.getFileName();

		} else if (crashxmlFile != null) {

			retval = crashxmlFile.getFileName();

		} else if (summaryFile != null) {

			retval = summaryFile.getFileName();

		} else if (emulatorPanicFile != null) {

			retval = "Emulator Panic";

		}

		return retval;

	}

	/**

	 * Returns the name of .crashxml or .xml file is they exists

	 * @return the name of .crashxml or .xml file is they exists

	 */

	public String getAnalyzeFileName() {

		String retval = "";

		if (crashxmlFile != null) {

			retval = crashxmlFile.getFileName();

		} else if (summaryFile != null) {

			retval = summaryFile.getFileName();

		return retval;

	}

	/**

	 * Returns the panic code of this bundle. Panic code is available 

	 * only if bundle contains decoded files or emulator panic.

	 * 

	 * @return panic code or empty

	 */

	public String getPanicCode() {

		if (emptyFile)

			return "";

		String retval = "";

		if (crashxmlFile != null) {

			retval = crashxmlFile.getPanicCode();

		} else if (summaryFile != null) {

			retval = summaryFile.getPanicCode();

		} else if (emulatorPanicFile != null) {

			retval = emulatorPanicFile.getPanicCode();

		}

		return retval;

	}

	/**

	 * Returns the panic category of this bundle. Panic category is available 

	 * only if bundle contains decoded files or emulator panic.

	 * 

	 * @return panic category or empty

	 */

	public String getPanicCategory() {

		if (emptyFile)

			return "";

		String retval = "";

		if (crashxmlFile != null) {

			retval = crashxmlFile.getPanicCategory();

		} else if (summaryFile != null) {

			retval = summaryFile.getPanicCategory();

		} else if (emulatorPanicFile != null) {

			retval = emulatorPanicFile.getPanicCategory();

		} else if (undecodedFile != null) {

			retval = "Unknown";

		return retval;

	}

	/**

	 * Returns the name of the paniced thread. Thread name is available

	 * only if bundle contains decoded files or emulator panic.

	 * 

	 * @return paniced thread name or empty

	 */

	public String getThreadName() {

		if (emptyFile)

			return "";

		String retval = "";

			retval = crashxmlFile.getThreadName();

		} else if (summaryFile != null) {

			retval = summaryFile.getThreadName();

		} else if (emulatorPanicFile != null) {

			retval = emulatorPanicFile.getThreadName();

		} else if (undecodedFile != null) {

			retval = "Unknown";

		}

		return retval;

	}

	/**

	 * Returns the time of a crash. Crash time is not always available

	 * (even in decoded crash files).  If crash time is not available,  

	 * the creation time of the crash file is returned.

	 * 

	 * @return crash time

	 */

	public String getTime() {

		if (emptyFile)

			return "";

		String retval = "";

		if (crashxmlFile != null) {

			retval = crashxmlFile.getTime();

			// crashxml does not always contain time

			if ("".equals(retval)) {

				// try to read time: when undecoded file was created

				if (undecodedFile != null) {

					retval = undecodedFile.getTime();

				// there was no undecoded file, read time: when crashxml file was created

				} else {

					retval = crashxmlFile.getCreated();

				}

			}

		}

		else if (summaryFile != null) {

			retval = summaryFile.getTime();

			// summary does not always contain time

			if ("".equals(retval)) {

				// try to read time: when undecoded file was created

				if (undecodedFile != null) {

					retval = undecodedFile.getCreated();

				// there was no undecoded file, read time: when summary.xml file was created

				} else {

					retval = summaryFile.getCreated();

				}

			}

		} else if (undecodedFile != null) {

			retval = undecodedFile.getCreated();

		} else if (emulatorPanicFile != null) {

			retval = emulatorPanicFile.getTime();

			if ("".equals(retval))

				retval = emulatorPanicFile.getCreated();

		return retval;

	}

	/**

	 * Returns the crash files ROM ID if available.

	 * @return ROM ID or empty

	 */

	public String getRomId() {

		if (isEmpty())

			return "";

		if (crashxmlFile != null) {

			return crashxmlFile.getRomId();

		} else if (summaryFile != null) {

			return summaryFile.getRomId();

		} else {

			return "";

		}

	}

	/**

	 * Returns whether this is an empty or waiting bundle.

	 * @return true if bundle is empty or waiting, false if not.

	 */

	public boolean isEmpty() {

		return emptyFile;

	}

	/**

	 * Returns whether this bundle contains an emulator panic

	 * @return true if this bundle contains an emulator panic, false if not

	 */

	public boolean isEmulatorPanic() {

		if (emulatorPanicFile != null)

			return true;

		return false;

	}

	/**

	 * Returns whether this bundle contains a fully decoded crash file (.crashxml)

	 * @return true if this bundle contains a fully decoded crash file, false if not

	 */

	public boolean isFullyDecoded() {

		if (crashxmlFile != null) 

			return true;

		return false;

	}

	/**

	 * Returns whether this bundle contains a partially decoded crash file (.xml)

	 * @return true if this bundle contains a partially decoded crash file, false if not

	 */

	public boolean isPartiallyDecoded() {

		if (summaryFile != null)

			return true;

		return false;

	}

	/**

	 * Returns whether this bundle contains any files.

	 * @return true if bundle contains files, false if not

	 */

	public boolean hasFiles() {

		if (crashxmlFile != null || summaryFile != null ||

			emulatorPanicFile != null || undecodedFile != null)

			return true;

		return false;

	}

	/**

	 * Returns whether this bundle contains xml files (.crashxml or .xml).

	 * @return true if bundle contains files, false if not

	 */

	public boolean hasXml() {

		if (crashxmlFile != null || summaryFile != null)

			return true;

		return false;

	}