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

// Implements the Phonebook Store manipulation code.

// 

//

/**

 @file

*/

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "CSimPhBkStoreTraces.h"

#endif

#include "CSimPhBkStore.h"

#include "CSimPhone.h"

#include <testconfigfileparser.h>

const TUint16 KNpiTonInternational=145;		// < The Number Plan Identifier and Type of Number for an international telephone number.

const TUint16 KNpiTonNational=129;			// < The Number Plan Identifier and Type of Number for a national telephone number.

const TInt KPhonebookErrorGranularity=3;	// < Granularity of phonebook error list array.

//

// CSimPhBkStore

//

void CSimPhBkStore::ClosePhone(TAny* aObj)

/**

 * A utility function for cleaning up the stack.

 */

	{

	((CObject*)aObj)->Close();

	}

CSimPhBkStore* CSimPhBkStore::NewL(CSimPhone* aPhone, const TDesC8& aName, TInt aMaxNumSlots, TInt aMaxNumLen, TInt aMaxTextLen)

/**

 * Standard two phase constructor.

 * @param aPhone			The phone object from which this Phonebook was opened.

 * @param aName				The name of the created Phonebook.

 * @param aMaxNumSlots		The maximum number of slots in the Phonebook.

 * @return CSimPhBkStore*	The newly created object.

 */

	{

	CSimPhBkStore* store=new(ELeave) CSimPhBkStore(aPhone);

	TCleanupItem newObjClose(ClosePhone,store);

	CleanupStack::PushL(newObjClose);

	store->ConstructL(aName,aMaxNumSlots,aMaxNumLen,aMaxTextLen);

	CleanupStack::Pop();

	return store;

	}

CSimPhBkStore::CSimPhBkStore(CSimPhone* aPhone)

		: CSimPhone(iDummyPhoneBaseRef), iPhone(aPhone),iIpcCnt(0),iEvOutstandingReq(EFalse)

/**

 * Trivial first phase constructor.

 * @param aPhone	The phone object from which this phonebook was opened.

 */

	{}

void CSimPhBkStore::ConstructL(const TDesC8& aName, TInt aMaxNumSlots, TInt aMaxNumLen, TInt aMaxTextLen)

/**

 * Second phase constructor that allocates memory for the phonebook, batch read buffer and

 * a delayed completion timer.  The constructor also reads the individual and batch read

 * delays from the configuration file.

 * 

 * @param aName			The name of the created phonebook.

 * @param aMaxNumLen	The maximum length of a telephone number.

 * @param aMaxTextLen	The maximum length of an alpha tag.

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_CONSTRUCTL_1, "Starting to parse Phonebook store additional config parameters...");

	__ASSERT_ALWAYS(aMaxNumLen<=KPhBkMaxTelNumSize,SimPanic(EPhonebookNameOrNumberTooLarge));

	__ASSERT_ALWAYS(aMaxTextLen<=KPhBkMaxAlphaTagSize,SimPanic(EPhonebookNameOrNumberTooLarge));

	iPhBkStoreEntries=new(ELeave) TPhBkStoreEntry[aMaxNumSlots+1]; //slot 0 is unused

	iPhBkMaxNumSlots=aMaxNumSlots;

	iPhBkMaxTelNumLen=aMaxNumLen;

	iPhBkMaxTextLen=aMaxTextLen;

	iPhBkStoreName.Copy(aName);

	iReqTimer=CSimTimer::NewL(iPhone);

	iOOBWriteTimer=CSimTimer::NewL(iPhone);

	iOOBDeleteTimer=CSimTimer::NewL(iPhone);

	iPhBkRwBuffer=new(ELeave) CPhoneBookBuffer();

	iPhBkError=new(ELeave) CArrayFixFlat<TPhBkError>(KPhonebookErrorGranularity);

	const CTestConfigItem* item=NULL;

	TInt ret=KErrNone;

	item=CfgFile()->Item(KTriggerEventIPC,0);

	if(item)

		{

		TInt ipc, cnt, event;

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,0,ipc);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_CONSTRUCTL_2, "WARNING - CONFIGURATION FILE PARSING - Reading element IPC returned %d (element no. %d) from tag %s.",ret,0,KTriggerEventIPC);

			}

		else

			iTriggerEventIPC.iIPC=ipc;

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,1,cnt);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_CONSTRUCTL_3, "WARNING - CONFIGURATION FILE PARSING - Reading element CNT returned %d (element no. %d) from tag %s.",ret,1,KTriggerEventIPC);

			}

		else

			iTriggerEventIPC.iIPCCnt=cnt;

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,2,event);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_CONSTRUCTL_4, "WARNING - CONFIGURATION FILE PARSING - Reading element EVENT returned %d (element no. %d) from tag %s.",ret,2,KTriggerEventIPC);

			}

		else

			iTriggerEventIPC.iEvent=RMobilePhone::TMobilePhoneSecurityEvent(event);

		}

	const CTestConfigItem* item0=NULL;

	item0=CfgFile()->Item(KPhBkPhoneStoreCaps,0);

	if (item0)

		{

		TPtrC8 value0;

		TInt ret0=CTestConfig::GetElement(item0->Value(),KStdDelimiter,0,value0);

		if(ret0!=KErrNone)

			{

			iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_CONSTRUCTL_5, "WARNING - CONFIGURATION FILE PARSING - Reading element VALUE0 returned %d (element no. %d) from tag %s.",ret0,0,KPhBkPhoneStoreCaps);

			}	

		else

			{

			TUint32 intValue;

			TInt ret = AsciiToNum(value0, intValue);

			if(ret!=KErrNone)

				iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

			else

				iPhBkStoreCaps = intValue;

			}

		}

	else

		iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_CONSTRUCTL_6, "...Finished parsing Phonebook store additional config parameters...");

	}

void CSimPhBkStore::PopulateStoreFromConfigFileL()

/**

 * Populate the Phonebook Store from information in the configuration file.  This is performed

 * after the standard Phonebook Store construction in order to prevent reseting the configuation

 * file accessor class' pointers while possibly multiple Phonebook Stores are created.

 *

 * The store entries comply to the following format:

 * "PhBkStoreEntry = <store name>, <slot number>, <telephone number>, <alphatag>"

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_1, "Starting to read Phonebook store entries...");

	iPhBkIndividualPause=CfgFile()->ItemValue(KPhBkStoreIndividualReqPause,KDefaultPhBkStoreIndividualReqPause);

	iPhBkBatchPause=CfgFile()->ItemValue(KPhBkStoreBatchReqPause,KDefaultPhBkStoreBatchReqPause);

	TInt count=CfgFile()->ItemCount(KPhBkStoreEntry);

	const CTestConfigItem* item=NULL;

	TInt ret=KErrNone;

	TInt i;

	for(i=0;i<count;i++)

		{

		item=CfgFile()->Item(KPhBkStoreEntry,i);

		if(!item)

			break;

		TPtrC8 phonebookName,alphaTag,telNum;

		TInt index;

		TUint8 npiTon;

		ret=GetPhBkEntry(item,0,phonebookName,index,telNum,alphaTag,npiTon);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_2, "WARNING - CONFIGURATION FILE PARSING - Reading element PHONEBOOK ENTRY returned %d (element no. %d) from tag %s.",ret,index,KPhBkStoreEntry);

			continue;

			}

		if(phonebookName.MatchF(iPhBkStoreName)!=0)// Not this phonebook

			continue;

		iPhBkStoreEntries[index].iAlphaTag.Copy(alphaTag);

		iPhBkStoreEntries[index].iTelNum.Copy(telNum);

		iPhBkStoreEntries[index].iTonNpi=npiTon;

		}

	count=CfgFile()->ItemCount(KPhBkError);

	item=NULL;

	for(i=0;i<count;i++)

		{

		item=CfgFile()->Item(KPhBkError,i);

		if(!item)

			break;

		TInt count,error;

		TPtrC8 phonebookName, phonebookStore;

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,0,count);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_3, "WARNING - CONFIGURATION FILE PARSING - Reading element COUNT returned %d (element no. %d) from tag %s.",ret,0,KPhBkError);

			continue;

			}

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,1,error);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_4, "WARNING - CONFIGURATION FILE PARSING - Reading element ERROR returned %d (element no. %d) from tag %s.",ret,1,KPhBkError);

			continue;

			}	

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,2,phonebookName);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_5, "WARNING - CONFIGURATION FILE PARSING - Reading element PHONEBOOKNAME returned %d (element no. %d) from tag %s.",ret,2,KPhBkError);

			continue;

			}

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,3,phonebookStore);

		if(ret!=KErrNone)

			{

			OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_6, "WARNING - CONFIGURATION FILE PARSING - Reading element PHONEBOOKSTORE returned %d (element no. %d) from tag %s.",ret,3,KPhBkError);

			}

		else  //not for the global phonebook

			continue;

		if(phonebookName.MatchF(iPhBkStoreName)!=0)// Not this phonebook

			continue;

		TPhBkError entry;

		entry.iCount=count;

		entry.iError=error;

		iPhBkError->AppendL(entry);

		}

	PopulateOOBWrite();

	PopulateOOBDelete();

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATESTOREFROMCONFIGFILEL_7, "...Finished reading Phonebook store entries...");

	if(iPhBkOOBWriteDuration!=-1)

		iOOBWriteTimer->Start(iPhBkOOBWriteDuration,this,ETimerIdPhBkStorOOBWrite);

	if(iPhBkOOBDeleteDuration!=-1)

		iOOBDeleteTimer->Start(iPhBkOOBDeleteDuration,this,ETimerIdPhBkStorOOBDelete);

	}

void CSimPhBkStore::PopulateOOBWrite()

/**

 * Populate the member variables required to operate the OOB Store functionality from

 * the configuration file.

 * The OOBPhBkStore configuration file tag should have the following format:

 * "OOBPhBkStore= <duration>, <phonebook name>, <index>, <telephone number>, <alpha tag>"

 */

	{

	iPhBkOOBWriteDuration=KErrNotFound;

	const CTestConfigItem* item=CfgFile()->Item(KOOBPhBkWrite);

	if(!item)

		return;

	TInt count;

	TInt ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,0,count);

	if(ret!=KErrNone)

		{

		OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATEOOBWRITE_1, "WARNING - CONFIGURATION FILE PARSING - Reading element COUNT returned %d (element no. %d) from tag %s.",ret,0,KOOBPhBkWrite);

		return;

		}

	TPtrC8 phonebookName,alphaTag,telNum;

	TInt index;

	TUint8 npiTon;

	ret=GetPhBkEntry(item,1,phonebookName,index,telNum,alphaTag,npiTon);

	if(ret!=KErrNone)

		{

		OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATEOOBWRITE_2, "WARNING - CONFIGURATION FILE PARSING - Reading element NPITON returned %d (element no. %d) from tag %s.",ret,index,KOOBPhBkWrite);

		return;

		}

	if(phonebookName.MatchF(iPhBkStoreName)!=0)

		return;						// Not this phonebook

	iPhBkOOBWriteDuration=count;

	iPhBkOOBWriteIndex=index;

	iPhBkOOBWrite.iAlphaTag.Copy(alphaTag);

	iPhBkOOBWrite.iTelNum.Copy(telNum);

	iPhBkOOBWrite.iTonNpi=npiTon;

	}

void CSimPhBkStore::PopulateOOBDelete()

/**

 * Populate the member variables required to operate the OOB Delete functionality from

 * the configuration file.

 * The OOBPhBkDelete configuration file tag should have the following format:

 * "OOBPhBkDelete= <duration>, <phonebook name>, <index>

 */

	{

	iPhBkOOBDeleteDuration=KErrNotFound;

	const CTestConfigItem* item=CfgFile()->Item(KOOBPhBkDelete);

	if(!item)

		return;

	TInt count;

	TInt ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,0,count);

	if(ret!=KErrNone)

		{

		OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATEOOBDELETE_1, "WARNING - CONFIGURATION FILE PARSING - Reading element COUNT returned %d (element no. %d) from tag %s.",ret,0,KOOBPhBkDelete);

		return;

		}

	TPtrC8 phonebookName;

	ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,1,phonebookName);

	if(ret!=KErrNone)

		{

		OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATEOOBDELETE_2, "WARNING - CONFIGURATION FILE PARSING - Reading element PHONEBOOKNAME returned %d (element no. %d) from tag %s.",ret,1,KOOBPhBkDelete);

		return;

		}

	if(phonebookName.MatchF(iPhBkStoreName)!=0)

		return;						// Not this phonebook

	TInt index;

	ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,2,index);

	if(ret!=KErrNone)

		{

		OstTraceDefExt3(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CSIMPHBKSTORE_POPULATEOOBDELETE_3, "WARNING - CONFIGURATION FILE PARSING - Reading element INDEX returned %d (element no. %d) from tag %s.",ret,2,KOOBPhBkDelete);

		return;

		}

	iPhBkOOBDeleteDuration=count;

	iPhBkOOBDeleteIndex=index;

	}

TInt CSimPhBkStore::GetPhBkEntry(const CTestConfigItem* aItem, TInt aItemIndex,

								 TPtrC8& aPhonebookName, TInt& aIndex,

								 TPtrC8& aTelNum, TPtrC8& aAlphaTag, TUint8& aNpiTon)

/**

 * Retrieve a phonebook entry from the configuration file, starting at a given item index

 * value.

 * @param aItem				Pointer to the config file item from which the phonebook entry will be read.

 * @param aItemIndex		The index number within the item from which the phonebook entry will be read.

 * @param aPhonebookName	The returned phonebook name

 * @param aIndex			The returned index number

 * @param aTelNum			The returned telephone number

 * @param aAlphaTag			The returned alpha tag

 * @param aNpiTon			The returned Number Plan Identifier and Type of Number information

 * @return TInt				Standard error value.

 */

	{

	TInt ret;

	ret=CTestConfig::GetElement(aItem->Value(),KStdDelimiter,aItemIndex++,aPhonebookName);

	if(ret!=KErrNone)

		return ret;

	ret=CTestConfig::GetElement(aItem->Value(),KStdDelimiter,aItemIndex++,aIndex);

	if(ret!=KErrNone)

		return ret;

	if(aIndex>iPhBkMaxNumSlots) //the max number of slot is a valid slot

		return KErrArgument;

	ret=CTestConfig::GetElement(aItem->Value(),KStdDelimiter,aItemIndex++,aTelNum);

	if(ret!=KErrNone)

		return ret;

	if(aTelNum.Length()>iPhBkMaxTelNumLen)

		return KErrArgument;

	ret=CTestConfig::GetElement(aItem->Value(),KStdDelimiter,aItemIndex++,aAlphaTag);

	if(ret!=KErrNone)

		return ret;

	if(aAlphaTag.Length()>iPhBkMaxTextLen)

		return KErrArgument;

	if((aTelNum.Length()>0) && (aTelNum[0]=='+'))

		{

		aTelNum.Set(aTelNum.Mid(1));

		aNpiTon=KNpiTonInternational;

		}

	else

		aNpiTon=KNpiTonNational;

	return ret;

	}

CSimPhBkStore::~CSimPhBkStore()

/**

 * Standard destructor.  Any objects created by the ::ConstructL() function

 * will be destroyed here.

 */

	{

	delete[] iPhBkStoreEntries;

	delete iPhBkError;

	delete iPhBkRwBuffer;

	delete iOOBWriteTimer;

	delete iOOBDeleteTimer;

	delete iReqTimer;

	}

TInt CSimPhBkStore::ExtFunc(const TTsyReqHandle aReqHandle,const TInt aIpc, const TDataPackage& aPckg)

/**

 * Dispatch function for all Phonebook Store requests.

 * @param aReqHandle	The TSY request handle for this request.

 * @param aIpc			The IPC number of this request.

 * @param aPckg			The parameter package related to this request.

 * @return TInt			The return error condition.

 */

	{

	iIpcCnt++;

	TInt error=KErrNone;

	if(FindIpcErrorMatch(error))

		{

		ReqCompleted(aReqHandle,error);

		return KErrNone;

		}

// The following requests can be completed even if the completion of another request is pending.

	switch(aIpc)

		{

	case EMobilePhoneStoreGetInfo:

		error = GetInfo(aReqHandle,aPckg.Des1n());

		if(iTriggerEventIPC.iIPC==aIpc)

			{

			iTriggerCnt++;

			if(iTriggerEventIPC.iIPCCnt==iTriggerCnt)

				iPhone->SecurityEvent(iTriggerEventIPC.iEvent);

			}

		return error;

	case EMobilePhoneStoreNotifyStoreEvent:

		error = NotifyStoreEvent(aReqHandle,aPckg.Des1n(),aPckg.Des2n());

		if(iTriggerEventIPC.iIPC==aIpc)

			{

			iTriggerCnt++;

			if(iTriggerEventIPC.iIPCCnt==iTriggerCnt)

				iPhone->SecurityEvent(iTriggerEventIPC.iEvent);

			}

		return error;

	default:

		break;

		}

// The TSY can only process one of the following requests at a time.  If a second is received

// while processing the first, then it will be errored with KErrInUse.  This restriction will

// be removed later, by inserting a request queuing mechanism.  Note that the standard TSY

// "flow control" mechanism works phone-wide and so is not suitable.

	if(iReqTimer->IsActive())

		{

		ReqCompleted(aReqHandle,KErrInUse);

		return KErrNone;

		}

	switch(aIpc)

		{

// The standard multimode store read and write are not supported.

	case EMobilePhoneStoreRead:

	case EMobilePhoneStoreWrite:

	case EMobilePhoneStoreReadAllPhase1:

	case EMobilePhoneStoreReadAllPhase2:

		ReqCompleted(aReqHandle,KErrNotSupported);

		return KErrNone;

	case EMobilePhoneBookStoreRead:

		 error = Read(aReqHandle,aPckg.Des1n(),aPckg.Des2n());

		 if(iTriggerEventIPC.iIPC==aIpc)

			{

			iTriggerCnt++;

			if(iTriggerEventIPC.iIPCCnt==iTriggerCnt)

				iPhone->SecurityEvent(iTriggerEventIPC.iEvent);

			}

		 return error;

	case EMobilePhoneBookStoreWrite:

		error = Write(aReqHandle,aPckg.Des1n(),aPckg.Des2n());

		if(iTriggerEventIPC.iIPC==aIpc)

			{

			iTriggerCnt++;

			if(iTriggerEventIPC.iIPCCnt==iTriggerCnt)

				iPhone->SecurityEvent(iTriggerEventIPC.iEvent);

			}

		 return error;

	case EMobilePhoneStoreDelete:

		error =  Delete(aReqHandle,aPckg.Des1n());

		if(iTriggerEventIPC.iIPC==aIpc)

			{

			iTriggerCnt++;

			if(iTriggerEventIPC.iIPCCnt==iTriggerCnt)

				iPhone->SecurityEvent(iTriggerEventIPC.iEvent);

			}

		 return error;

	case EMobilePhoneStoreDeleteAll:

		error =  DeleteAll(aReqHandle);

		if(iTriggerEventIPC.iIPC==aIpc)

			{

			iTriggerCnt++;

			if(iTriggerEventIPC.iIPCCnt==iTriggerCnt)

				iPhone->SecurityEvent(iTriggerEventIPC.iEvent);

			}

		 return error;

	default:

		break;

		}

	return KErrNotSupported;

	}

CTelObject* CSimPhBkStore::OpenNewObjectByNameL(const TDesC& /*aName*/)

/**

 * The API does not support any objects that could be opened from this one.

 */

	{