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

// TS_SimPhBk.CPP

// This tests the GSM Phone Book functions including phonebook searching.

// The PhoneBook search functions are implemented in the T_SEARCH files.

// 

//

/**

 @file

*/

#include "Te_SimPhBk.h"

#include "Te_SimPhBkConstants.h"

#define __TEST_CANCEL__

#define __TEST_WRITE_TO_NEXT_AVAIL__

#define SIM_TSY

//------------------------------------------------------------------

//						** TEST STEPS ***

//------------------------------------------------------------------

CTestPhoneInfo::CTestPhoneInfo()

/** Each test step initialises it's own name

*/

	{

	// store the name of this test case

	// this is the name that is used by the script file

	SetTestStepName(_L("testPhoneInfo"));

	}

//------------------------------------------------------------------

TVerdict CTestPhoneInfo::doTestStepL( void )

/**

 * This function gets information about the phone: the Phone Manufacturer's Id, the

 * Model and Revision ID, the Serial number and the number of phone books supported,

 * as well as information associated with each supported phone book.

 * The functions are called on a RBasicGsmPhone object.

 */

	{

	RMobilePhone::TMobilePhoneIdentityV1 aPhoneId;

	TRequestStatus aStatus;

	RMobilePhoneStore::TMobilePhoneStoreInfoV1 aPhoneStoreInfo;

	RMobilePhoneStore::TMobilePhoneStoreInfoV1Pckg aPhoneStoreInfoPckg(aPhoneStoreInfo);

	iPhone.GetPhoneId(aStatus, aPhoneId);

	User::WaitForRequest(aStatus);

	if(aStatus == KErrNotSupported)

		{

		INFO_PRINTF1(_L("iPhone.GetPhoneId(aStatus, aPhoneId) not supported"));

		}

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelMeMissedPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"MISSED_CALLS\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"MISSED_CALLS\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelMeReceivedPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"RECEIVED_CALLS\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"RECEIVED_CALLS\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelMeAdnPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"ME_PHONEBOOK\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"ME_PHONEBOOK\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelIccVoiceMailBox);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"VOICE_MAILBOX\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"VOICE_MAILBOX\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelIccAdnPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"SIM_PHONEBOOK\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"SIM_PHONEBOOK\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelCombinedAdnPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"COMBINED_SIM_ME\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"COMBINED_SIM_ME\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelIccFdnPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"FIXED_DIAL_NUM\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"FIXED_DIAL_NUM\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelIccSdnPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"SERV_DIAL_NUM\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"SERV_DIAL_NUM\" not supported by this phone"));

	    }

	iPhone.GetPhoneStoreInfo(aStatus, aPhoneStoreInfoPckg, KETelIccBdnPhoneBook);

	User::WaitForRequest(aStatus);

	INFO_PRINTF2(TRefByValue<const TDesC>(_L("Testing \"BARRED_DIAL_NUM\" returned %d")), aStatus.Int());

	if(aStatus.Int() == KErrNone)

	    {

		aPhoneStoreInfo = aPhoneStoreInfoPckg();

		CheckPhoneBookInfoL(aPhoneStoreInfo);

	    }

	else

	    {

		INFO_PRINTF1(_L("Phone Book \"BARRED_DIAL_NUM\" not supported by this phone"));

	    }

	return TestStepResult();

	}

//------------------------------------------------------------------

CTestGetCapsAndInfo::CTestGetCapsAndInfo()

/** Each test step initialises it's own name

*/

	{

	// store the name of this test case

	// this is the name that is used by the script file

	SetTestStepName(_L("testGetCapsAndInfo"));

	}

//------------------------------------------------------------------

TVerdict CTestGetCapsAndInfo::doTestStepL( void )

/**

 * This function gets the SIM phone book's static capabilities (as well as the ME &

 * MT phone books, if supported), and information associated with the phone book.

 * It also validates the obtained information.

 * @test GT83-TPHBK-001.06 Test opening an ICC-based phonebook of abbreviated dialling numbers

 * @test GT83-TPHBK-002.06 Test closing an ICC-based phonebook of abbreviated dialling numbers

 * @test GT83-TPHBK-003.04 Test retrieval of the phone book store info and capabilities of an ME-based phonebook of abbreviated dialling numbers.

 * @test GT83-TPHBK-003.06 Test retrieval of the phone book store info and capabilities of an ICC-based phonebook of abbreviated dialling numbers

 * @test GT83-TPHBK-003.11 Test retrieval of the phone book store info and capabilities of a combination of the ADN stored in ME and ICC

 * @test GT83-TPHBK-003.13 Test cancelling a request to retrieve phone book store info and capabilities

 */

	{

	// SIM phone book - mandatory

	TInt ret=KErrNone;

	TRequestStatus aStatus;

	RMobilePhoneBookStore simPhBk;

	RMobilePhoneBookStore::TMobilePhoneBookInfoV1 aInfo;

	RMobilePhoneBookStore::TMobilePhoneBookInfoV1Pckg aInfoPckg(aInfo);

	RMobilePhoneBookStore::TMobilePhoneBookInfoV1 *aInfob;

	ret=simPhBk.Open(iPhone, KETelIccAdnPhoneBook());

	if( KErrNone ==ret )

		{

		CHECKPOINT(ret, KErrNone, _L("GT83-TPHBK-001.06")) ;

		simPhBk.GetInfo(aStatus, aInfoPckg);

		User::WaitForRequest(aStatus);

		CHECKPOINT(aStatus.Int(), KErrNone, _L("GT83-TPHBK-003.06")) ;

		aInfob = &aInfoPckg();

		//MKV  Print_TMobilePhoneBookInfoV1(aInfoPckg()) ;

		TESTL(aInfob->iCaps & RMobilePhoneStore::KCapsWriteAccess);

		TESTL(!aInfob->iName.Compare(KETelIccAdnPhoneBook()));

		simPhBk.Close();

		}

	else

		{

		INFO_PRINTF1(_L("Does SIM.TSY support KETelIccAdnPhoneBook?")) ;

		simPhBk.Close();

		}

	// ME phone book - optional support by the phones

	RMobilePhoneBookStore mePhBk;

	ret=mePhBk.Open(iPhone, KETelMeAdnPhoneBook());

	if (ret==KErrNone)

		{

		CHECKPOINT(ret, KErrNone, _L("GT83-TPHBK-001.06")) ;

		INFO_PRINTF1(_L("ME phonebook supported"));

		iMESupported=ETrue;

		mePhBk.GetInfo(aStatus, aInfoPckg);

		User::WaitForRequest(aStatus);

		CHECKPOINT(aStatus.Int(), KErrNone, _L("GT83-TPHBK-003.04")) ;

		aInfob = &aInfoPckg();

		TESTL(aInfob->iCaps & RMobilePhoneStore::KCapsWriteAccess);

		TESTL(!aInfob->iName.Compare(KETelMeAdnPhoneBook()));

		mePhBk.Close();

		CHECKPOINT(0, KErrNone, _L("GT83-TPHBK-002.06")) ;

		}

	else

		{

		INFO_PRINTF1(_L("Does SIM.TSY support KETelMeAdnPhoneBook?")) ;

		mePhBk.Close();

		}

	// Combined ME and SIM phone book - optional support by the phones

	if (iMTSupported)

		{

		RMobilePhoneBookStore combPhBk;

		ret=combPhBk.Open(iPhone,  KETelCombinedAdnPhoneBook());

		if (ret==KErrNone)

			{

			INFO_PRINTF1(_L("Combined ME & SIM phonebook supported"));

			iMTSupported=ETrue;

			combPhBk.GetInfo(aStatus, aInfoPckg);

			User::WaitForRequest(aStatus);

			CHECKPOINT(aStatus.Int(), KErrNone, _L("GT83-TPHBK-003.11")) ;

			aInfob = &aInfoPckg();

			TESTL(aInfob->iCaps && RMobilePhoneStore::KCapsWriteAccess);

			TESTL(!aInfob->iName.Compare(KETelCombinedAdnPhoneBook()));

			}

		else

			{

			INFO_PRINTF1(_L("Does SIM.TSY support KETelCombinedAdnPhoneBook?")) ;

			}

			combPhBk.Close();

		// Combined ME and SIM phone book

		if (iMTSupported)

			{

			RMobilePhoneBookStore combPhBk;

			TESTL(combPhBk.Open(iPhone, KETelCombinedAdnPhoneBook())==KErrNone);

			combPhBk.GetInfo(aStatus, aInfoPckg);

			User::WaitForRequest(aStatus);

			CHECKPOINT(aStatus.Int(), KErrNone, _L("GT83-TPHBK-003.11")) ;

			aInfob = &aInfoPckg();

			TESTL(aInfob->iMaxNumLength >0);

			TESTL(aInfob->iMaxTextLength >=0);

			TESTL(!aInfob->iName.Compare(KETelCombinedAdnPhoneBook()));

			TESTL(aInfob->iCaps & RMobilePhoneStore::KCapsWriteAccess);

	#ifdef __TEST_CANCEL__

			combPhBk.GetInfo(aStatus, aInfoPckg);

			combPhBk.CancelAsyncRequest(EMobilePhoneStoreGetInfo);

			User::WaitForRequest(aStatus);

			INFO_PRINTF2(_L("Async MT PhoneBook GetInfo Cancel Status = %d"),aStatus.Int());

			TESTL(aStatus==KErrCancel || aStatus==KErrNone);

			TEST_CHECKL((aStatus==KErrCancel || aStatus==KErrNone), ETrue, _L("GT83-TPHBK-003.13"));

	#endif

			combPhBk.Close();

			}

		}

	return TestStepResult();

	}

//------------------------------------------------------------------

CTestReadAndWrite::CTestReadAndWrite()

/** Each test step initialises it's own name

*/

	{

	// store the name of this test case

	// this is the name that is used by the script file

	SetTestStepName(_L("testReadAndWrite"));

	}

//------------------------------------------------------------------

void CTestReadAndWrite::WriteToMEPhBkL()

/**

 * This function is called from the testReadAndWrite() function. Writes to the 1st 4

 * locations in the ME PhoneBook. Any existing entries in these locations will be overwritten.

 * @test GT83-TPHBK-001.04 Test opening a ME-based phonebook of abbreviated dialling numbers.

 * @test GT83-TPHBK-007.04 "Test writing a single phonebook entry to a specified location in a ME-based phonebook of abbreviated dialling numbers, where the location is empty"

 */

	{

	const TInt KEntries=4;

	RMobilePhoneBookStore mePhBk;

	TRequestStatus aStatus;

	CHECKPOINT(mePhBk.Open(iPhone,KETelMeAdnPhoneBook), KErrNone, _L("GT83-TPHBK-001.04"));

	INFO_PRINTF1(_L("Write to the ME PhoneBook..."));

	TBuf8<KPBDataClientBuf> pbData; // Client reserved space for phonebook data

	_LIT8(KTel,"123456%03d");

	_LIT8(KText,"TelNo %03d");

	TBuf8<13> text(KTel), number(KText);

	TBuf<13> showText;

	CPhoneBookBuffer* pbBuffer = new(ELeave) CPhoneBookBuffer(); // used to write phonebook data

	pbBuffer->Set(&pbData); // Set it to point to the Client buffer

	TInt index(0);

	TInt idx(1);

	while (index <= KEntries)

		{

		// First specify starting index and set iNumofEntries to 1, since it is only

		// possible to write one entry at a time

		//index = idx; // set index

		number.FillZ(); // Reset previous values

		number.Zero();

		text.FillZ();

		text.Zero();

		pbData.FillZ();

		pbData.Zero();

		// convert number into TLV format and append it to allocated buffer

		number.Format(KTel(), index);

		TInt ret=pbBuffer->PutTagAndValue((TUint8)RMobilePhoneBookStore::ETagPBNumber, number);

		TESTL(ret == KErrNone) ;

		// convert number type into TLV format and append it to allocated buffer

		ret=pbBuffer->PutTagAndValue((TUint8)RMobilePhoneBookStore::ETagPBTonNpi, (TUint8)RMobilePhone::EUnknownNumber);

		text.Format(KText(), index);

		showText.Copy(text) ;

		INFO_PRINTF2(_L("Writing %S"), &showText);

		// convert text into TLV format and append it to allocated buffer

		ret=pbBuffer->PutTagAndValue((TUint8)RMobilePhoneBookStore::ETagPBText, text);

		mePhBk.Write(aStatus, pbData, idx);

		CHECKPOINT(aStatus.Int(), KErrNone, _L("GT83-TPHBK-007.04"));

		User::WaitForRequest(aStatus);

		index++;

		}

	mePhBk.Close();

	delete pbBuffer;

	}

//------------------------------------------------------------------

TVerdict CTestReadAndWrite::doTestStepL( void )

/**

 * This function creates an array of names and telephone numbers which are to be used as

 * phone book entries. It then writes these entries synchronously to the SIM phone book

 * and reads them back. If the Combined Phone book is supported, entries are first written

 * to the ME phonebook and then read from the Combined Phone book. This is because the MT

 * (SIM + ME) phonebook does not have write access.

 * @test GT83-TPHBK-001.06 Test opening an ICC-based phonebook of abbreviated dialling numbers

 * @test GT83-TPHBK-002.06 Test closing an ICC-based phonebook of abbreviated dialling numbers

 * @test GT83-TPHBK-002.11 Test closing a combination of the ADN stored in ME and ICC

 * @test GT83-TPHBK-001.11 Test opening a combination of the ADN stored in ME and ICC

 * @test GT83-TPHBK-006.06 Test retrieval of the first entry in an ICC-based phonebook of abbreviated dialling numbers

 * @test GT83-TPHBK-006.11 Test retrieval of the first entry in a combination of the ADN stored in ME and ICC

 * @test GT83-TPHBK-007.06 "Test writing a single phonebook entry to a specified location in an ICC-based phonebook containing voice mailbox numbers, where the location is empty"

 * @test GT83-TPHBK-007.11 "Test writing a single phonebook entry to a specified location in an ICC-based phonebook containing the fixed dialling numbers list, when the phone is in a mode that allows editing the fixed dialling numbers, where the location is empty"

*/

	{

	TInt ret=KErrNone;

	TRequestStatus aStatus;

	RMobilePhoneBookStore* simPhBk = new(ELeave) RMobilePhoneBookStore();

	CleanupStack::PushL(simPhBk);

	// Create array of names and numbers

	const TText16* names[]={(TText16*)KAnnText.iBuf, (TText16*)KMattSText.iBuf, (TText16*)KAndyText.iBuf,

						  (TText16*)KMattMText.iBuf,(TText16*)KPaulText.iBuf, (TText16*)KMumAndDadText.iBuf,

						  (TText16*)KSymbolText.iBuf,(TText16*)KTextTooLong.iBuf};

	const TText16* numbers[]={(TText16*)KAnnPhoneNum.iBuf, (TText16*)KMattSPhoneNum.iBuf, (TText16*)KAndyPhoneNum.iBuf,

							(TText16*)KMattMPhoneNum.iBuf, (TText16*)KPaulPhoneNum.iBuf, (TText16*)KMumAndDadPhoneNum.iBuf,

							(TText16*)KSymbolPhoneNum.iBuf,(TText16*)KNumberTooLong.iBuf};

	TBuf<KBufSize> entryNumber(numbers[0]);

	TBuf<KBufSize> entryName(names[0]);

	CPhoneBookBuffer* pbBuffer = new(ELeave) CPhoneBookBuffer();

	CleanupStack::PushL(pbBuffer);

	// Write the entries to the SIM Phone Book

	TBuf8<KPBDataClientBuf>* pbData = new(ELeave) TBuf8<KPBDataClientBuf>;	// Client reserved space for phonebook data

	CleanupStack::PushL(pbData);

	TBuf8<KPBDataClientBuf>* pbReadData1 = new(ELeave) TBuf8<KPBDataClientBuf>;	// Client reserved space for phonebook data

	CleanupStack::PushL(pbReadData1);

	TBuf8<KPBDataClientBuf>* pbReadData2 = new(ELeave) TBuf8<KPBDataClientBuf>;	// Client reserved space for phonebook data

	CleanupStack::PushL(pbReadData2);

	TBuf8<KPBDataClientBuf>* pbReadEmpty = new(ELeave) TBuf8<KPBDataClientBuf>;	// Client reserved space for phonebook data

	CleanupStack::PushL(pbReadEmpty);

	TInt requestedIndex(0), numOfEntries(1);

	// Read the entries back 

	TPtrC number(NULL,0);

	TPtrC text(NULL,0);

	TUint8 aTagValue(0);

	CPhoneBookBuffer::TPhBkTagType aDataType;

	TPtrC field(NULL,0);

	TUint i(0) ;

	TInt counter(0);

	TUint type;

	ret=simPhBk->Open(iPhone, KETelIccAdnPhoneBook());

	if( ret != KErrNone)

		{

		INFO_PRINTF1(_L("Does SIM.TSY support KETelIccAdnPhoneBook?")) ;

		simPhBk->Close();

		}

	else

		{

		TUint  size(KPPBEntriesNum);

		TInt writeIndex(0);

		TUint index;

		CHECKPOINT(ret, KErrNone, _L("GT83-TPHBK-001.06")) ;

		pbBuffer->Set(pbData); // Set it to point to the Client buffer

		for (i=1; i<=size; ++i)

			{

			//first reset the following three local buffers to delete any existing data

			entryNumber.FillZ();

			entryNumber.Zero();

			entryName.FillZ();

			entryName.Zero();

			pbData->FillZ();

			pbData->Zero();

			entryNumber=numbers[i-1];

			entryName=names[i-1];

			// First specify starting index and set iNumofEntries to 1, since it is only

			// possible to write one entry at a time

			writeIndex = i; // Note that TSY will overwrite any existing data. It is up to

							// the Sync to check whether it is the first available entry

			// convert number into TLV format and append it to allocated buffer

			ret=pbBuffer->PutTagAndValue((TUint8)RMobilePhoneBookStore::ETagPBNumber, entryNumber);

			TESTL(ret == KErrNone) ;

			// convert type into TLV format and append it to allocated buffer

			ret=pbBuffer->PutTagAndValue((TUint8)RMobilePhoneBookStore::ETagPBTonNpi, (TUint8)RMobilePhone::EUnknownNumber);	// AMC - "Unknown" numbers are written, so unknown numbers will be read in the tests below.

			TESTL(ret == KErrNone) ;

			// convert text into TLV format and append it to allocated buffer

			ret=pbBuffer->PutTagAndValue((TUint8)RMobilePhoneBookStore::ETagPBText, entryName);

			TESTL(ret == KErrNone) ;

			simPhBk->Write(aStatus, *pbData, writeIndex);

			User::WaitForRequest(aStatus);

			CHECKPOINT(aStatus.Int(), KErrNone, _L("GT83-TPHBK-007.06")); //???????

			}

		// Reads Forwads and it reads all entries individually 

		for(i=1; i<=size; ++i)

			{