/*

* Copyright (c) 2006 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.appdep.ui.wizards;

import java.util.ArrayList;

import java.util.List;

import org.eclipse.jface.dialogs.IMessageProvider;

import org.eclipse.jface.viewers.CheckboxTableViewer;

import org.eclipse.jface.viewers.ISelectionChangedListener;

import org.eclipse.jface.viewers.SelectionChangedEvent;

import org.eclipse.jface.viewers.ViewerFilter;

import org.eclipse.jface.window.Window;

import org.eclipse.swt.SWT;

import org.eclipse.swt.custom.BusyIndicator;

import org.eclipse.swt.events.FocusEvent;

import org.eclipse.swt.events.FocusListener;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.events.SelectionListener;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Display;

import org.eclipse.swt.widgets.Shell;

import org.eclipse.swt.widgets.Text;

import org.eclipse.swt.widgets.Widget;

import com.nokia.s60tools.appdep.AppDepHelpContextIDs;

import com.nokia.s60tools.appdep.core.AppDepSettings;

import com.nokia.s60tools.appdep.core.ICacheIndexListener;

import com.nokia.s60tools.appdep.core.ITargetPlatform;

import com.nokia.s60tools.appdep.core.data.CacheIndex;

import com.nokia.s60tools.appdep.core.job.IJobCompletionListener;

import com.nokia.s60tools.appdep.core.job.IManageableJob;

import com.nokia.s60tools.appdep.exceptions.InvalidCmdLineToolSettingException;

import com.nokia.s60tools.appdep.plugin.AppDepPlugin;

import com.nokia.s60tools.appdep.resources.Messages;

import com.nokia.s60tools.appdep.ui.dialogs.AddSISFilesDialog;

import com.nokia.s60tools.appdep.ui.wizards.BuildTargetEntry.BuildTargetStatusEnum;

import com.nokia.s60tools.appdep.ui.wizards.BuildTargetSelectionBuildTypeFilter.BuildTargetFilterModeEnum;

import com.nokia.s60tools.appdep.util.LogUtils;

import com.nokia.s60tools.sdk.SdkInformation;

import com.nokia.s60tools.ui.S60ToolsTable;

import com.nokia.s60tools.ui.S60ToolsTableColumnData;

import com.nokia.s60tools.ui.S60ToolsTableFactory;

import com.nokia.s60tools.ui.wizards.S60ToolsWizardPage;

import com.nokia.s60tools.util.debug.DbgUtility;

/**

 * Wizard page showing the available targets among which 

 * the user select a target(s) for seeking components to analyze. 

 */

public class SelectBuildTargetWizardPage extends S60ToolsWizardPage implements SelectionListener,

												   IJobCompletionListener,

                                                   FocusListener,

                                                   ICacheIndexListener, 

                                                   IRefreshable{	

	//

	// Constants

	//

	/**

	 * Build type text for release (urel) builds.

	 */

	private static final String BUILD_TYPE_RELEASE_STR = Messages.getString("SelectBuildTargetWizardPage.BuildType_Release_InfoMsg");	 //$NON-NLS-1$

	/**

	 * Build type text for release (urel) builds.

	 */

	private static final String BUILD_TYPE_DEBUG_STR = Messages.getString("SelectBuildTargetWizardPage.BuildType_Debug_InfoMsg");	 //$NON-NLS-1$

	/**

	 * Style bits used for read only labels.

	 */

	private static final int READ_ONLY_LABEL_FIELD_STYLEBITS = SWT.READ_ONLY | SWT.NO_FOCUS;

	/**

	 * States used to store the button state

	 * result based on the multiselection.

	 * The actual resolution of button statuses

	 * is done after the state for current selection

	 * is resolved.

	 * 

	 * Cancel can be pressed in wizard regardless of the state.

	 * The order of the state's under this enumerator is IMPORTANT!

	 * Because values run from 0...N the states with bigger value

	 * are regarded as more important problems to be reported to 

	 * a user in case there are more than one problem issue in 

	 * multiselection. I.e. problems that prohibit proceeding 

	 * in the wizard.

	 */

	private enum TargetSelStateEnum {

						 EStateNotSet,                        // Initial state that should not exist after target check.

						 EAllTargetCachesUpToDate, 	          // => Can press Next not Finish,

						 ECacheNotGeneratedForSomeTarget,     // => Can press Next or Finish 

						 ECacheNeedsUpdateForSomeTarget,      // => Can press Next or Finish 

						 ESISFileCacheNeedsToBeGenerated, 	  // => Can press Next or Finish, generation will be started

						 EDumpsisDoesNotExist,                // => Cannot press Next nor Finish, dumpsis.exe does not exist, checked when in SIS analysis mode

						 EElftranDoesNotExist,                 // => Cannot press Next nor Finish

						 ECachesIsBeingIndexedForSomeTarget,  // => Cannot press Next nor Finish

						 ENoComponentsForSomeTarget,          // => Cannot press Next nor Finish

						 EInvalidToolchainMix,                // => Cannot press Next nor Finish

						 ESomeTargetNotSupported,             // => Cannot press Next nor Finish

						 ESomeTargetStateNotResolved,         // => Cannot press Next nor Finish

						 ECacheIsBeingGeneratedForSomeTarget // => Cannot press Next nor Finish, severity changed into this level because cache generation forbids actions for whole SDK 

		 								};

	/**

	 * Title for the currently selected SDK.

	 */

	private Text sdkNameFieldTitleText;

	/**

	 * Name of the currently selected SDK.

	 */

	private Text sdkNameFieldValueText;

	/**

	 * Title for the currently used build type.

	 */

	private Text buildTypeFieldTitleText;

	/**

	 * Name of the currently the currently used build type.

	 */

	private Text buildTypeFieldValueText;

	/**

	 * Viewer component for showing available targets.

	 */

	private CheckboxTableViewer buildTargetViewer;

	/**

	 * Checkbox that can be used to toggle between showing

	 * of release and debug build type targets.

	 */

	private Button showDebugTargetsInsteadOfReleaseTargetsCheckbox;

	/**

	 * Checkbox that can be used to limit amount of showed 

	 * targets into supported and non-empty ones.

	 */

	private Button showOnlySupportedAndNonEmptyTargetsCheckbox;

	/**

	 * Content provider for the viewer component.

	 */

	private SelectBuildTargetWizardPageContentProvider contentProvider;

	/**

	 * This field determines the current status for the selection of multiple

	 * targets.

	 * IMPORTANT: Value should be set always by using setSelectionState method, not directly

	 *            unless purpose is to initialize, or re-initialize the value!

	 */

	private TargetSelStateEnum selectionState = TargetSelStateEnum.EStateNotSet;

	/**

	 * This filter is used to filter target viewer elements based on the build type.

	 */

	private BuildTargetSelectionBuildTypeFilter buildTypeFilter;

	/**

	 * Accepts in Build Target Selection -wizard page only the targets

	 * that are non-empty or supported. 

	 */

	private BuildTargetSelectionNonEmptyAndNonSuppTargetFilter nonEmptyAndNonSuppTargetFilter;

	/**

	 * Set to <code>true</code> if programmatic selection is ongoing, otherwise <code>false</code>.

	 * If programmatic selection is ongoing and therefore

	 * not need to trigger similar event handling as due to UI selection.

	 */

	private boolean isProgrammaticSelectionOngoingFlag;

	/**

	 * Open Add SIS files dialog -button

	 */

	private Button addSISFilesButton = null;

	 /**

	 * Constructor.

	 */

	public SelectBuildTargetWizardPage(){

		super(Messages.getString("SelectBuildTargetWizardPage.WizardPageName")); //$NON-NLS-1$

		setTitle(Messages.getString("SelectBuildTargetWizardPage.WizardPageTitle"));			 //$NON-NLS-1$

		setDescription(Messages.getString("SelectBuildTargetWizardPage.WizardPageDescription"));  //$NON-NLS-1$

		// User cannot finish the page before some valid 

		// selection is made.

		setPageComplete(false);

	 }

	/**

	 * Creates checkbox viewer component for showing build targets. 

	 * @param parent Parent composite for the created composite.

	 * @return New <code>CheckboxTableViewer</code> object instance.

	 */

	protected CheckboxTableViewer createBuildTargetTableViewer(Composite parent) {

		ArrayList<S60ToolsTableColumnData> columnDataArr = new ArrayList<S60ToolsTableColumnData>();

		//

		// NOTE: Column indices must start from zero (0) and

		// the columns must be added in ascending numeric

		// order.

		//

		columnDataArr.add(new S60ToolsTableColumnData(Messages.getString("SelectBuildTargetWizardPage.TargetType_ColumnText"), //$NON-NLS-1$

														120,

														BuildTargetEntry.TARGET_TYPE_COLUMN_INDEX,

														BuildTargetTableViewerSorter.CRITERIA_TARGET_TYPE));

		columnDataArr.add(new S60ToolsTableColumnData(Messages.getString("SelectBuildTargetWizardPage.ComponentCount_ColumnText"),  //$NON-NLS-1$

														100,

														BuildTargetEntry.COMPONENT_COUNT_COLUMN_INDEX,

														BuildTargetTableViewerSorter.CRITERIA_COMPONENT_COUNT,

														SWT.RIGHT));

		columnDataArr.add(new S60ToolsTableColumnData(Messages.getString("SelectBuildTargetWizardPage.Status_ColumnText"), //$NON-NLS-1$

														160,

														BuildTargetEntry.STATUS_COLUMN_INDEX,

														BuildTargetTableViewerSorter.CRITERIA_STATUS));

		S60ToolsTableColumnData[] arr 

				= columnDataArr.toArray(

									   new S60ToolsTableColumnData[0]);

		S60ToolsTable tbl = S60ToolsTableFactory.createCheckboxTable(parent, arr);

		CheckboxTableViewer tblViewer = new CheckboxTableViewer(tbl.getTableInstance());

		tbl.setHostingViewer(tblViewer);

		return tblViewer;

	}

	/* (non-Javadoc)

	 * @see org.eclipse.jface.dialogs.IDialogPage#createControl(org.eclipse.swt.widgets.Composite)

	 */

	public void createControl(Composite parent) {

	  // Creating one column only sub composite for controls 	

	  Composite c = new Composite(parent, SWT.NONE); 	  

	  final int cols = 1;	  

	  GridLayout gdl = new GridLayout(cols, false);	  

	  GridData gd = new GridData(GridData.FILL_BOTH);

	  c.setLayout(gdl);

	  c.setLayoutData(gd);

	  // Creating grid layout composite for information labels

	  Composite titleAreaComposite = new Composite(c, SWT.NONE);

	  GridLayout gdl2 = new GridLayout(2, false);

	  GridData gd2 = new GridData(GridData.FILL_HORIZONTAL);

	  titleAreaComposite.setLayout(gdl2);

	  titleAreaComposite.setLayoutData(gd2);

	  // Adding SDK and build type information labels

	  addSDKInformationLabels(titleAreaComposite);	  

	  addBuildTypeInformationLabels(titleAreaComposite);

	  // Creating build target viewer component

	  buildTargetViewer = createBuildTargetTableViewer(c);

	  GridData targetViewerGd = new GridData(GridData.FILL_BOTH);

	  buildTargetViewer.getControl().setLayoutData(targetViewerGd);

	  buildTargetViewer.setSorter(new BuildTargetTableViewerSorter());

	  // Adding checkboxes and Add SIS files -button inside a new composite object

	  final int compBottomControlsCols = 2;

	  Composite compBottomControls = new Composite(c, SWT.NONE);

	  GridLayout gLToBottomControls = new GridLayout(compBottomControlsCols, false);

	  compBottomControls.setLayout(gLToBottomControls);

	  compBottomControls.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));

	  // Checkbox for showing debug build type targets instead of release targets

	  String checkBoxLabelText = Messages.getString("SelectBuildTargetWizardPage.ShowDebugBuild_CheckboxCaptionText"); //$NON-NLS-1$

	  // Creating viewer filter for doing filtering according build type	  

	  buildTypeFilter = new BuildTargetSelectionBuildTypeFilter(BuildTargetFilterModeEnum.EShowReleaseTargets);

	  showDebugTargetsInsteadOfReleaseTargetsCheckbox = addCheckBoxControl(compBottomControls, checkBoxLabelText, false, 

			  															   buildTypeFilter, null);	 

	  // Adding SIS file addition dialog launching button		

	  addSISFilesButton = new Button(compBottomControls, SWT.PUSH );

	  addSISFilesButton.setText(Messages.getString("SelectBuildTargetWizardPage.AddSISFile_BtnCaptionText"));  //$NON-NLS-1$

	  addSISFilesButton.addSelectionListener(this);

	  GridData gDToButton = new GridData(GridData.HORIZONTAL_ALIGN_END);

	  addSISFilesButton.setLayoutData(gDToButton);

	  // Checkbox for showing only supported and non-empty targets

	  checkBoxLabelText = Messages.getString("SelectBuildTargetWizardPage.ShowSupportedAndNonEmptyTargets_CheckboxCaptionText"); //$NON-NLS-1$

	  // Creating viewer filter for checkbox  

	  nonEmptyAndNonSuppTargetFilter = new BuildTargetSelectionNonEmptyAndNonSuppTargetFilter(true);

	  GridData cbLayoutData2 = new GridData(GridData.GRAB_HORIZONTAL);

	  showOnlySupportedAndNonEmptyTargetsCheckbox = addCheckBoxControl(compBottomControls, checkBoxLabelText, true, 

			  														   nonEmptyAndNonSuppTargetFilter, cbLayoutData2);	 

	  // Providers cannot be created before all the controls have been created

	  setProvidersAndListenersForBuildTargetViewer();

	  // Setting initial focus of the wizard page

	  setInitialFocus();

	  // Setting control for this page

	  setControl(c);

	  // Setting context help ID	

      AppDepPlugin.setContextSensitiveHelpID(getControl(), AppDepHelpContextIDs.APPDEP_WIZARD_PAGE_BUILD_TARGET_SELECT);

	}

	/**

	 * Adds checkbox control with given parameters.

	 * @param compBottomControls Parent composite.

	 * @param checkBoxLabelText	 Label text for the checkbox.

	 * @param initialSelectionStatus set to <code>true</code> if initially selected, otherwise <code>false</code>. 

	 * @param filter Filter to be applied related to checkbox, or <code>null</code> if not used.

	 * @param gdData grid data to be applied related to checkbox, or <code>null</code> if not used.

	 */

	private Button addCheckBoxControl(Composite compBottomControls, String checkBoxLabelText, boolean initialSelectionStatus, 

									  ViewerFilter filter, GridData gdData) {

		  Button checkboxControl  = new Button(compBottomControls, SWT.CHECK);

		  checkboxControl.setText(checkBoxLabelText);

		  checkboxControl.setSelection(initialSelectionStatus); // By default showing release targets

		  checkboxControl.addSelectionListener(this);

		  if(filter != null){

			  buildTargetViewer.addFilter(filter);			  

		  }

		  if(gdData != null){

			  checkboxControl.setLayoutData(gdData);

		  }

		  return checkboxControl;

	}

	/**

	 * Adds SDK information labels.

	 * @param titleAreaComposite parent composite to labels.

	 */

	private void addSDKInformationLabels(Composite titleAreaComposite) {

		  sdkNameFieldTitleText = new Text(titleAreaComposite, READ_ONLY_LABEL_FIELD_STYLEBITS);	  

		  String titleText = Messages.getString("SelectBuildTargetWizardPage.SDK_Str") + ": "; //$NON-NLS-1$ //$NON-NLS-2$

		  sdkNameFieldTitleText.setText(titleText); 

		  sdkNameFieldTitleText.addFocusListener(this);

		  sdkNameFieldValueText = new Text(titleAreaComposite, READ_ONLY_LABEL_FIELD_STYLEBITS);	  	  

		  sdkNameFieldValueText.addFocusListener(this);

		}

	/**

	 * Adds build type information labels.

	 * @param titleAreaComposite parent composite to labels.

	 */

	private void addBuildTypeInformationLabels(Composite titleAreaComposite) {

		buildTypeFieldTitleText = new Text(titleAreaComposite, READ_ONLY_LABEL_FIELD_STYLEBITS);

		buildTypeFieldTitleText.setText(Messages.getString("SelectBuildTargetWizardPage.BuildType_Str") + ": ");	   //$NON-NLS-1$ //$NON-NLS-2$

		buildTypeFieldTitleText.addFocusListener(this);	  

		buildTypeFieldValueText = new Text(titleAreaComposite, READ_ONLY_LABEL_FIELD_STYLEBITS);

		// Setting default build type value...

		buildTypeFieldValueText.setText(BUILD_TYPE_RELEASE_STR);

		// ...and storing the default value also to dialog settings

		updateDialogSettings(SelectSDKWizard.BUILD_TYPE_DESCR_DLG_SETTING_KEY, BUILD_TYPE_RELEASE_STR);

		buildTypeFieldValueText.addFocusListener(this);

		}

	/**

	 * Sets providers and listeners for build target viewer control.

	 */

	private void setProvidersAndListenersForBuildTargetViewer() {

		contentProvider = new SelectBuildTargetWizardPageContentProvider(this);

		  buildTargetViewer.setContentProvider(contentProvider); 

		  buildTargetViewer.setLabelProvider(new SelectBuildTargetWizardPageLabelProvider());

		  buildTargetViewer.setInput(contentProvider);

		  // Adding selection change listener

		  buildTargetViewer.addSelectionChangedListener(new ISelectionChangedListener(){

				/* (non-Javadoc)

				 * @see org.eclipse.jface.viewers.ISelectionChangedListener#selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)

				 */

				public void selectionChanged(SelectionChangedEvent event) {

					// Triggering status recalculation only if non-programmatic selection

					if(! isProgrammaticSelectionOngoing()){

						 // Skipping programmatic selection because we are sure that event came from UI selection

						recalculateButtonStates(true, null); 								

					}

				}

		  });

	}

	/* (non-Javadoc)

	 * @see com.nokia.s60tools.appdep.ui.wizards.S60ToolsWizardPage#setInitialFocus()

	 */

	public void setInitialFocus() {

		buildTargetViewer.getTable().setFocus();			

	}

	/* (non-Javadoc)

	 * @see com.nokia.s60tools.appdep.ui.wizards.S60ToolsWizardPage#recalculateButtonStates()

	 */

	public void recalculateButtonStates() {

		// By default we check, if programmatic selection is possible

		recalculateButtonStates(false, null);		

	}

	/**

	 * Page specific recalculate buttons implementation.

	 * @param skipProgrammaticSelectionCheck set to <code>true</code> if needed to skip, automatic programmatic

	 * 										 selection based on current settings, otherwise set to <code>false</code>.

	 * @param forceCheckedEntriesArr If this is not <code>null</code>, using these entries instead of current selection

	 * 								 if current selection do not have any components (used in double-click event).			

	 */

	public void recalculateButtonStates(boolean skipProgrammaticSelectionCheck, Object[] forceCheckedEntriesArr) {

		try {			

			SelectSDKWizard wiz = (SelectSDKWizard) getWizard();

			AppDepSettings settings = wiz.getSettings();

			Object[] checkedEntriesArr = buildTargetViewer.getCheckedElements();; // Getting all checked targets

			if(checkedEntriesArr.length == 0 && forceCheckedEntriesArr != null){

				// Using forced target set instead

				checkedEntriesArr = forceCheckedEntriesArr;								

			}

			// Re-initializing selection state

			selectionState = TargetSelStateEnum.EStateNotSet;

			// If programmatic selection is not skipped and there are no target nodes selected...

			if( checkedEntriesArr.length == 0){

				// Trying to make selection based on the settings if allowed according boolean flag

				if(!skipProgrammaticSelectionCheck && makeProgrammaticElementCheckingBasedOnSettings(settings)){

					// Getting all targets checked by programmatic selection

					checkedEntriesArr = buildTargetViewer.getCheckedElements(); 

					if(checkedEntriesArr.length == 0){

						// Trying to avoid internal errors, but this is something that should be trapped during 

						// development time. Internal error messages are not localized.

						String errMsg = "Programmatic selection failed unexpectedly in class '" //$NON-NLS-1$

										+ SelectBuildTargetWizardPage.class.getSimpleName()

										+ "'."; //$NON-NLS-1$

						LogUtils.logInternalErrorAndThrowException(errMsg);

						return;

					}

				}

				else{

					// Failed to make programmatic selection, or programmatic selection was skipped.

					// Making sure that no targets are selected in settings

					settings.clearCurrentlyUsedTargetPlatforms();

					// And showing initial message, because no items are selected currently

					showInitialStateMessage(wiz);

					//.. and returning

					return; 

				}

			}

			// Going through all the selected nodes one by one and setting selection state.	

			// State can be multiple times during method execution because only more severe

			// error state will override existing selection state. 

			// See comment block from TargetSelStateEnum enumeration for detailed info.

			List<BuildTargetEntry> selectedTargetsArr = new ArrayList<BuildTargetEntry>();

			// SDK information is needed for finding out SDK supports required tools (dumpsis.exe and elftran.exe)

			SdkInformation sdkInfo = getSelectedSdk();

			// Checking if we are in SIS mode and settings selection state if needed

			checkSISModeStatusAndSetSelectionStateIfNeeded(settings, sdkInfo);

			DbgUtility.println(DbgUtility.PRIORITY_LOOP, "----- Checked items START ==>"); // //$NON-NLS-1$

			//Recalculate state based on the selection made by a user

			for (int i = 0; i < checkedEntriesArr.length; i++) {

				// Casting selected node to correct type

				BuildTargetEntry targetEntry = (BuildTargetEntry) checkedEntriesArr[i];

				// Debug printing checked items

				DbgUtility.println(DbgUtility.PRIORITY_LOOP, targetEntry.getTargetDescription()); 

				// Added target to target selection array

				selectedTargetsArr.add(targetEntry);

				// Resolves selection state based on target's status

				BuildTargetStatusEnum status = targetEntry.getStatus();

				setSelectionStateBasedOnTargetStatus(settings, sdkInfo, status, targetEntry.getTargetName());

				// In case we are about to generate/update cache files...

				if(selectionState == TargetSelStateEnum.ECacheNotGeneratedForSomeTarget

				    ||

				   selectionState == TargetSelStateEnum.ECacheNeedsUpdateForSomeTarget

				    ||

				   selectionState == TargetSelStateEnum.ESISFileCacheNeedsToBeGenerated){					

					//... we finally check, if we cannot start cache generation due to fact

					// that there is already a cache generation process for this SDK ongoing.

					if(settings.isCacheGenerationOngoingForSdk(sdkInfo)){

						setSelectionState(TargetSelStateEnum.ECacheIsBeingGeneratedForSomeTarget);

					}					

				}				

			} 

			DbgUtility.println(DbgUtility.PRIORITY_LOOP, "<== Checked items END -----"); // //$NON-NLS-1$

			// Checking that the selected combination is otherwise valid.

			// Updates selection state accordingly. Must be called before

			// page completion check and before settings button statuses.

			CheckValidityOfTargetSelection(selectedTargetsArr, settings);

			// Storing user selection if we have a valid selection

			boolean isPageCompleted = checkPageCompleteStatus();

			//If page is completed it means there is a valid selection existing

			if(isPageCompleted){

				// Storing user selection

				wiz.setUserSelection(sdkInfo, selectedTargetsArr.toArray(new BuildTargetEntry[0]));

			}			

			// Setting buttons states and visible messages according selection state.

			// Must be called before calling updateInformationForNextPage.

			setUserMessageAndButtonState(wiz, isPageCompleted, selectedTargetsArr);		

		} catch (Exception e) {