// Copyright (c) 2006-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:

// @file CT_Utils.cpp

// This is the Cpp file which contains the utility functions common across the servers

// 

//

// User includes

#include "tlbsutils.h"

#include "ctlbsconfigreader.h"

#include "ctlbsasyncwaiter.h"

#include "ctlbstestloggermacros.h"

// Epoc includes

#include <f32file.h>

#include <e32math.h>

#include <e32property.h>

// Lbs includes

#include <lbsclasstypes.h>

#include <lbssatellite.h>

// defines

#define BAD_MODULE_ID	0x87654321

/**

*/

EXPORT_C TLbsModuleUpdateItem::TLbsModuleUpdateItem()

	{

	}

/**

*/

EXPORT_C const TPositionSatelliteInfo& TLbsModuleUpdateItem::Position() const

	{

	return iPosition;

	}

/**

*/

EXPORT_C void TLbsModuleUpdateItem::SetPosition(const TPositionSatelliteInfo& aPosition)

	{

	iPosition = aPosition;

	}

/**

*/

EXPORT_C const TPositionGpsMeasurementInfo& TLbsModuleUpdateItem::Measurement() const

	{

	return iMeasurement;

	}

/**

*/

EXPORT_C void TLbsModuleUpdateItem::SetMeasurement(const TPositionGpsMeasurementInfo& aMeasurement)

	{

	iMeasurement = aMeasurement;

	}

/**

*/

EXPORT_C TInt TLbsModuleUpdateItem::Error() const

	{

	return iError;

	}

/**

*/

EXPORT_C void TLbsModuleUpdateItem::SetDelay(TInt aDelay)

	{

	iDelay = aDelay;

	}

/**

*/

EXPORT_C TInt TLbsModuleUpdateItem::Delay() const

	{

	return iDelay;

	}

/**

*/

EXPORT_C void TLbsModuleUpdateItem::SetError(TInt aError)

	{

	iError = aError;

	}

EXPORT_C T_LbsUtils::T_LbsUtils()

/** Constructor.

*/

	{

	}

EXPORT_C T_LbsUtils::~T_LbsUtils()

/** Destructor.

*/

	{

	}

/*EXPORT_C static*/ /*void GetDefault_ModuleStatusInfo(TModuleConfiguredStatus& aStatusInfo)

	{

		(void)aStatusInfo;	

	}

*/

EXPORT_C void T_LbsUtils::CreateTestPropertiesL()

/** Creates the test properties for the test module. To allow data to be passed between

	test steps and the test module.

*/

	{

	const TSecurityPolicy KReadPolicy(ECapability_None);

	const TSecurityPolicy KWritePolicy(ECapabilityWriteDeviceData);

	// Create the test module data bus properties.

	TInt err;

	// Data to the test module.

	err = RProperty::Define(KUidSystemCategory, ELbsTestAGpsModuleIn, RProperty::ELargeByteArray, KReadPolicy, KWritePolicy, sizeof(TModuleDataIn));

	if ((KErrNone != err) && (KErrAlreadyExists != err))

	{

		User::LeaveIfError(err);

	}

	// Data from the test module.

	err = RProperty::Define(KUidSystemCategory, ELbsTestAGpsModuleOut, RProperty::ELargeByteArray, KReadPolicy, KWritePolicy, sizeof(TModuleDataOut));

	if ((KErrNone != err) && (KErrAlreadyExists != err))

	{

		User::LeaveIfError(err);

	}

	// Data from the test clock plugin.

	err = RProperty::Define(KUidSystemCategory, ELbsTestClockPluginOut, RProperty::ELargeByteArray, KReadPolicy, KWritePolicy, sizeof(TClockPluginDataOut));

	if ((KErrNone != err) && (KErrAlreadyExists != err))

	{

		User::LeaveIfError(err);

	}

	// Creating the property for allowing the AGPS module to report when the mode it's running in changes

	err = RProperty::Define(KUidSystemCategory, ELbsTestAGpsModuleModeChanges, RProperty::ELargeByteArray, KReadPolicy, KWritePolicy, sizeof(TLbsGpsOptionsArray));

	if ((KErrNone != err) && (KErrAlreadyExists != err))

		{

			User::LeaveIfError(err);

		}

	// Create other test properties here also - just update the TLbsTestPropertyKeys enum don't add extra Categories.

	}

EXPORT_C void T_LbsUtils::GetConfigured_PosInfosL(const TDesC& aConfigFileName, const TDesC& aConfigSection, RPointerArray<TAny>& aPosInfoArr)

/** Fills a position info array with values read from a configuration ini file.

@param aConfigFileName	The name of the ini file to read. If the file name is empty (0 length) then

						the array will contain a single pos info item with default values.

@param aConfigSection	The section within the ini file to read data from.

@param aPosInfoArr		The pos info array to which the items are added. The array will cleared of

						existing items.

*/

	{

	// Clear array.

	ResetAndDestroy_PosInfoArr(aPosInfoArr);

	// Check for config file, if not present create a single default TPositionInfo.

	if (aConfigFileName.Length() == 0)

		{

		TPositionSatelliteInfo* posInfo = new(ELeave) TPositionSatelliteInfo();

		TPosition position;

		position.SetCoordinate(DEFAULT_NOTIFY_POS_UPDATE_LATITUDE, DEFAULT_NOTIFY_POS_UPDATE_LONGITUDE, DEFAULT_NOTIFY_POS_UPDATE_ALTITUDE);

		position.SetAccuracy(DEFAULT_NOTIFY_POS_UPDATE_HORIZONTAL_ACCURACY, DEFAULT_NOTIFY_POS_UPDATE_VERTICAL_ACCURACY);

		position.SetCurrentTime();

		posInfo->SetPosition(position);

		User::LeaveIfError(aPosInfoArr.Append(posInfo));			

		}

	else

		{

		CPosInfoConfigReader* reader;

		reader = CPosInfoConfigReader::NewL(aConfigFileName, aConfigSection, aPosInfoArr);

		CleanupStack::PushL(reader);

		reader->ProcessL();

		CleanupStack::PopAndDestroy(reader);

		}

	}

EXPORT_C void T_LbsUtils::GetConfigured_UpdateArrayL(const TDesC& aConfigFileName, const TDesC& aConfigSection, RPointerArray<TLbsModuleUpdateItem>& aUpdateArr)

/** Fills an updata array structure with values read from a configuration ini file.

@param aConfigFileName	The name of the ini file to read. If the file name is empty (0 length) then

						default values will be used.

@param aConfigSection	The section within the ini file to read data from.

@param aUpdateArr		The update array to be populated.

*/

	{

	// Use default values if file name not given.

	if (aConfigFileName.Length() == 0)

		{

		// I am not sure we want to fill in the array with default values - ??

		}

	else

		{

		CUpdateConfigReader* reader;

		reader = CUpdateConfigReader::NewL(aConfigFileName, aConfigSection, aUpdateArr);

		CleanupStack::PushL(reader);

		reader->ProcessL();

		CleanupStack::PopAndDestroy(reader);

		}

	}

// don't think we need this...

EXPORT_C void T_LbsUtils::GetConfigured_ModuleStatusL(const TDesC& aConfigFileName, const TDesC& aConfigSection, TPositionModuleStatus& aModuleStatus)

	{

	// Use default values if file name not given.

	if (aConfigFileName.Length() == 0)

		{

		aModuleStatus.SetDeviceStatus(TPositionModuleStatus::EDeviceReady);

		aModuleStatus.SetDataQualityStatus(TPositionModuleStatus::EDataQualityNormal);

		}

	else

		{

		CModuleStatusConfigReader* reader;

		reader = CModuleStatusConfigReader::NewL(aConfigFileName, aConfigSection, aModuleStatus);

		CleanupStack::PushL(reader);

		reader->ProcessL();

		CleanupStack::PopAndDestroy(reader);

		}

	}

EXPORT_C void T_LbsUtils::GetConfigured_ModuleUpdateOptionsL(const TDesC& aConfigFileName, const TDesC& aConfigSection, TPositionUpdateOptions& aUpdateOpts)

/** Fills a module updata options class/structure with values read from a configuration ini file.

@param aConfigFileName	The name of the ini file to read. If the file name is empty (0 length) then

						default values will be used.

@param aConfigSection	The section within the ini file to read data from.

@param aUpdateOpts		The modified update options structure.

*/

	{

	// Use default values if file name not given.

	if (aConfigFileName.Length() == 0)

		{

		aUpdateOpts.SetUpdateInterval(0);

		aUpdateOpts.SetUpdateTimeOut(0);

		aUpdateOpts.SetMaxUpdateAge(0);

		aUpdateOpts.SetAcceptPartialUpdates(EFalse);			

		}

	else

		{

		CUpdateOptsConfigReader* reader;

		reader = CUpdateOptsConfigReader::NewL(aConfigFileName, aConfigSection, aUpdateOpts);

		CleanupStack::PushL(reader);

		reader->ProcessL();

		CleanupStack::PopAndDestroy(reader);

		}

	}

EXPORT_C void T_LbsUtils::GetConfigured_ClientDetailsL(const TDesC& aConfigFileName, const TDesC& aConfigSection, 

						RArray<TCTClientDetails>& aClientDetailsArray)

/** Gets the delays for each client with values read from a configuration ini file.

@param aConfigFileName		The name of the ini file to read. If the file name is empty (0 length) then

							default values will be used.

@param aConfigSection		The section within the ini file to read data from.

@param aClientDelayArray	The array of client delays.

*/

	{

	// Use default values if file name not given.

	if (aConfigFileName.Length() == 0)

		{ // by default have one client

		TCTClientDetails client;

		aClientDetailsArray.AppendL(client);

		return;

		}

	else

		{

		CClientDetailsConfigReader* reader;

		reader = CClientDetailsConfigReader::NewL(aConfigFileName, aConfigSection, aClientDetailsArray);

		CleanupStack::PushL(reader);

		reader->ProcessL();

		CleanupStack::PopAndDestroy(reader);

		if(aClientDetailsArray.Count() == 0)

			{ // by default have one client

			TCTClientDetails client;

			aClientDetailsArray.AppendL(client);

			}

		}

	}

EXPORT_C void T_LbsUtils::GetExpected_ModuleModes(const TDesC& aConfigFileName, const TDesC& aConfigSection, RPointerArray<TLbsGpsOptions>& aModuleModes)

	{

	if (aConfigFileName.Length() == 0)

		{

		return;

		}

	CAgpsModuleModesConfigReader* reader;

	reader = CAgpsModuleModesConfigReader::NewL(aConfigFileName, aConfigSection, aModuleModes);

	CleanupStack::PushL(reader);

	reader->ProcessL();

	CleanupStack::PopAndDestroy(reader);

	}

EXPORT_C void T_LbsUtils::NotifyModuleOfConfigChangeL(const TModuleDataIn& aModuleDataIn)

/** Notify the module of a configuration change.

Used when the test harness has read a configuration file and wishes to notify the test module

that it should also do a read of the configuration file. To ensure both the test harness and

the test module are using the same reference data.

The ELbsTestAGpsModuleIn property is used to pass the ini file and section names to the

test module. The ELbsTestAGpsModuleOut is then used to receive an response from the test module.

@param aConfigFileName	The file name string to send to the test mdoule.

@param aConfigSection	The ini section name string to send to the test module.

*/

	{

	// Ask to be notified when the module receives the ini file re-read request.

	// Attach and subscribe to listen for data bus updates. Use the async waiter to process

	// the update.

	RProperty modDataOutProperty;

	User::LeaveIfError(modDataOutProperty.Attach(KUidSystemCategory, ELbsTestAGpsModuleOut));

	CT_LbsAsyncWaiter* waiter = CT_LbsAsyncWaiter::NewL();

	CleanupStack::PushL(waiter);

	modDataOutProperty.Subscribe(waiter->iStatus);

	// Publish the file and section names to the module, to inform the module it has to

	// carry out a re-read of the ini file.

	TPckgBuf<TModuleDataIn> modDataInBuf;

	TModuleDataIn& modDataIn = modDataInBuf();

	// Copy across all the data items.

	modDataIn.iRequestType = aModuleDataIn.iRequestType;

	modDataIn.iConfigFileName = aModuleDataIn.iConfigFileName;

	modDataIn.iConfigSection = aModuleDataIn.iConfigSection;

	modDataIn.iAssDataEventType = aModuleDataIn.iAssDataEventType;

	modDataIn.iAssDataTestMode = aModuleDataIn.iAssDataTestMode;

	modDataIn.iKickOffEventType = aModuleDataIn.iKickOffEventType;

	modDataIn.iTimeOut = aModuleDataIn.iTimeOut;

	modDataIn.iError = aModuleDataIn.iError;

	modDataIn.iTimeStampOffset = aModuleDataIn.iTimeStampOffset;

    modDataIn.iOptionsChangeReportMode = aModuleDataIn.iOptionsChangeReportMode;

	User::LeaveIfError(RProperty::Set(KUidSystemCategory, ELbsTestAGpsModuleIn, modDataInBuf));

	TBool noResponse = ETrue;

	// Wait for the notification from the test module.	

	while(noResponse)

		{

	waiter->StartAndWait();

	User::LeaveIfError(waiter->Result());

	// Now ensure the notification response was good.

	TModuleDataOut modDataOut;

	TPckg<TModuleDataOut> modDataOutPckg(modDataOut);

	User::LeaveIfError(modDataOutProperty.Get(modDataOutPckg));

		if ((TModuleDataOut::EModuleResponse == modDataOut.iRequestType) && (TModuleDataOut::EModuleResponseOk == modDataOut.iResponse)) 

		{

			noResponse = EFalse;

			}

		}

	CleanupStack::PopAndDestroy(waiter);

	}

EXPORT_C void T_LbsUtils::WaitForModuleToRequestAssistanceDataL()

/** Wait for notification that the test AGPS module as requested assistance data.

	Blocking function used to determine when the test module has requested assistance data as part of its location update.

*/

	{

	RProperty modDataOutProperty;

	User::LeaveIfError(modDataOutProperty.Attach(KUidSystemCategory, ELbsTestAGpsModuleOut));

	CT_LbsAsyncWaiter* waiter = CT_LbsAsyncWaiter::NewL();

	CleanupStack::PushL(waiter);

	modDataOutProperty.Subscribe(waiter->iStatus);

	// Wait for the notification from the test module.	

	waiter->StartAndWait();

	User::LeaveIfError(waiter->Result());

	// Ensure the correct response is given.

	TModuleDataOut modDataOut;

	TPckg<TModuleDataOut> modDataOutPckg(modDataOut);

	User::LeaveIfError(modDataOutProperty.Get(modDataOutPckg));

	if (TModuleDataOut::EModuleAssDataRequestedOk != modDataOut.iResponse)

		{

		User::LeaveIfError(KErrArgument);

		}

	CleanupStack::PopAndDestroy(waiter);

	}

EXPORT_C TBool T_LbsUtils::Compare_PosInfo(const TPositionInfoBase& aPosInfoSideA, const TPositionInfoBase& aPosInfoSideB)

/** Compare two position info structures. Ensure all fields match excatly.

@param aPosInfoSideA	The first structure to compare.

@param aPosInfoSideB	The second structure to compare.

@return					ETrue if both structure match excatly else EFalse.

*/

	{

	return Compare_PosInfo(aPosInfoSideA, aPosInfoSideB, EExactAccuracy);

	}

EXPORT_C TBool T_LbsUtils::Compare_PosInfo(const TPositionInfoBase& aPosInfoSideA, const TPositionInfoBase& aPosInfoSideB, TComparisonAccuracyType aCmpAccuracy)

	{

	// TODO compare base class items, such as module id, position mode, etc.

	TUint32 typeA = aPosInfoSideA.PositionClassType();

	TUint32 typeB = aPosInfoSideB.PositionClassType();

	// Compare TPositionInfo type items.

	if(typeA & typeB & EPositionInfoClass)

		{

		TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Both positions are of type EPositionInfoClass");

		const TPositionInfo& posInfoSideA = reinterpret_cast<const TPositionInfo&>(aPosInfoSideA);

		const TPositionInfo& posInfoSideB = reinterpret_cast<const TPositionInfo&>(aPosInfoSideB);

		TPosition posSideA;

		TPosition posSideB;

		posInfoSideA.GetPosition(posSideA);

		posInfoSideB.GetPosition(posSideB);

		// Carry out an exact check when comparing items.

		if (EExactAccuracy == aCmpAccuracy)

			{

			TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Comparing positions for exact match");

			// Compare latitude. 

			if (Math::IsNaN(posSideA.Latitude()) && Math::IsNaN(posSideB.Latitude()))

				;

			else if (posSideA.Latitude() != posSideB.Latitude())

				{

				TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Positions don't match!");

				TESTLOG3(ELogP1, "Latitudes %d and %d respectively", posSideA.Latitude(), posSideB.Latitude());

				return EFalse;

				}

			// Compare longitude.

			if (Math::IsNaN(posSideA.Longitude()) && Math::IsNaN(posSideB.Longitude()))

				;

			else if (posSideA.Longitude() != posSideB.Longitude())

				{

				TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Positions don't match!");

				TESTLOG3(ELogP1, "Longitudes %d and %d respectively", posSideA.Longitude(), posSideB.Longitude());

				return EFalse;

				}		

			// Compare altitude.

			if (Math::IsNaN(posSideA.Altitude()) && Math::IsNaN(posSideB.Altitude()))

				;

			else if (posSideA.Altitude() != posSideB.Altitude())

				{

				TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Positions don't match!");

				TESTLOG3(ELogP1, "Altitudes %d and %d respectively", posSideA.Altitude(), posSideB.Altitude());				

				return EFalse;

				}

			// Compare datum.

			if (posSideA.Datum() != posSideB.Datum())

				{

				TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Positions don't match!");

				TESTLOG3(ELogP1, "Datums %d and %d respectively", posSideA.Datum(), posSideB.Datum());				

				return EFalse;

				}				

			// Compare horizontal accuracy.

			if (Math::IsNaN(posSideA.HorizontalAccuracy()) && Math::IsNaN(posSideB.HorizontalAccuracy()))

				;

			else if (posSideA.HorizontalAccuracy() != posSideB.HorizontalAccuracy())

				{

				TESTLOG(ELogP1, "T_LbsUtils::Compare_PosInfo() Positions don't match!");

				TESTLOG3(ELogP1, "Horizontal Accuracies %d and %d respectively", posSideA.HorizontalAccuracy(), posSideB.HorizontalAccuracy());				

				return EFalse;