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

// Implements the Phonebook Store manipulation code.

// 

//

/**

 @file

*/

#include "CSimPhBkUsimStore.h"

#include "CSimPhone.h"

#include "Simlog.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 KMaxGroups = 10;					// < The maximum allowed number of groups associated with a phonebook entry

const TInt KMaxSecondNames = 1;				// < The maximum allowed number of Second Names associated with a phonebook entry

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

const TUint DELETED=0xdededede; 

//

// CSimPhBkUSimStore

//

void CSimPhBkUSimStore::ClosePhone(TAny* aObj)

/**

 * A utility function for cleaning up the stack.

 */

	{

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

	}

CSimPhBkUSimStore* CSimPhBkUSimStore::NewL(CSimPhone* aPhone, const TDesC8& aStore, const TDesC8& aName, TInt aMaxNumSlots, TInt aMaxNumLen, TInt aMaxTextLen, TInt aAdditional, TInt aMaxEmail, TInt aMaxAdditionalTelNumLen, TInt aMaxAdditionalTextLen)

/**

 * 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.

 * @param aMaxNumLen		The maximum length of the telephone number (<100)

 * @param aMaxTextLen		The maximum length of the alpha text strings (<100)

 * @param aAdditional		The maximum number of additional numbers associated with an entry

 * @param aMaxEmail			The maximum number of email addresses associated with an entry

 * @param aMaxAdditionalTelNumLen	The maximum length of the an additional telephone number.

 * @param aMaxAdditionalTextLen		The maximum length of the alpha tag in an additional telephone number.

 * @return CSimPhBkUSimStore*			The newly created object.

 */

	{

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

	TCleanupItem newObjClose(ClosePhone,store);

	CleanupStack::PushL(newObjClose);

	store->ConstructL(aStore,aName,aMaxNumSlots,aMaxNumLen,aMaxTextLen,aAdditional,aMaxEmail, aMaxAdditionalTelNumLen, aMaxAdditionalTextLen);	

	CleanupStack::Pop();

	return store;

	}

CSimPhBkUSimStore::CSimPhBkUSimStore(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 CSimPhBkUSimStore::ConstructL(const TDesC8& aStore, const TDesC8& aName, TInt aMaxNumSlots, TInt aMaxNumLen, TInt aMaxTextLen, TInt aAdditional, TInt aMaxEmail, TInt aMaxAdditionalTelNumLen, TInt aMaxAdditionalTextLen)

/**

 * 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.

 * @param aMaxNumLen	The maximum length of the telephone number (<100).

 * @param aMaxTextLen	The maximum length of the alpha text strings (<100).

 * @param aAdditional	The maximum number of additional numbers associated with an entry.

 * @param aMaxEmail		The maximum number of email addresses associated with an entry.

 * @param aMaxAdditionalTelNumLen	The maximum length of the an additional telephone number.

 * @param aMaxAdditionalTextLen		The maximum length of the alpha tag in an additional telephone number.

 */

	{

	LOGPHBK1("Starting to parse Phonebook store additional config parameters...");

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

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

	iPhBkMaxNumSlots=aMaxNumSlots;

	iPhBkMaxTelNumLen=aMaxNumLen;

	iPhBkMaxTextLen=aMaxTextLen;

	iPhBkStoreName.Copy(aName);

	iPhBkStore.Copy(aStore);

	iPhBkAdditional=aAdditional;

	iPhBkMaxEmail=aMaxEmail;

	iPhBkMaxAdditionalTelNumLen = aMaxAdditionalTelNumLen;

	iPhBkMaxAdditionalTextLen = aMaxAdditionalTextLen;	

	iPhBkAid.Zero();

	iPhBkAidUSim1.Zero();

	iPhBkAidUSim2.Zero();

	if(iPhBkStore.Compare(KUSimPhoneBook)==KErrNone)

		{

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

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

		}

	else

		{

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

		iPhBkUSimStoreEntries=iPhBkUSim1StoreEntries;

		}

	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)

			{

			LOGPARSERR("ipc",ret,0,&KTriggerEventIPC);

			}

		else

			iTriggerEventIPC.iIPC=ipc;

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

		if(ret!=KErrNone)

			{

			LOGPARSERR("cnt",ret,1,&KTriggerEventIPC);

			}

		else

			iTriggerEventIPC.iIPCCnt=cnt;

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

		if(ret!=KErrNone)

			{

			LOGPARSERR("event",ret,2,&KTriggerEventIPC);

			}

		else

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

		}

	const CTestConfigItem* item0=NULL;

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

	if(count==0)

		iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

	else

		{

		TBool capsFound=EFalse;

		for(TInt i=0;(i<count || !capsFound);i++)

		{

			item0=CfgFile()->Item(KPhBkPhoneUSimStoreCaps,i);

			if (item0)

				{

				TPtrC8 value0,phonebookStore, phonebookName;

				TInt ret0;

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

				if(ret0!=KErrNone)

					{

					iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

					LOGPARSERR("Caps:PhonebookStore",ret,0,&KPhBkPhoneUSimStoreCaps);

					}	

				if(phonebookStore.MatchF(iPhBkStore)!=0)// Not this PhBkStore type

					continue;

				ret0=CTestConfig::GetElement(item0->Value(),KStdDelimiter,1,phonebookName);

				if(ret0!=KErrNone)

					{

					iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

					LOGPARSERR("phonebookName",ret,1,&KPhBkPhoneUSimStoreCaps);

					}	

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

					continue;

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

				if(ret0!=KErrNone)

					{

					iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

					LOGPARSERR("caps",ret,2,&KPhBkPhoneUSimStoreCaps);

					}	

				else

					{

					TUint32 intValue;

					TInt ret = AsciiToNum(value0, intValue);

					if(ret!=KErrNone)

						iPhBkStoreCaps=KDefaultPhBkPhoneStoreCaps;

					else

						{

						iPhBkStoreCaps = intValue;

						capsFound=ETrue;

						}

					}

				}

			}

	}

	LOGPHBK1("...Finished parsing Phonebook store additional config parameters...");

	}

void CSimPhBkUSimStore::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.

//alex

 *

 * The store entries comply to the following format:

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

 */

	{

	LOGPHBK1("Starting to read Phonebook store entries...");

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

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

	const CTestConfigItem* item=NULL;

	TInt ret=KErrNone;

	TInt i;

	// Get Phonebook entries

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

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

		{

		TInt parseIndex=0;

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

		if(!item)

			break;

		TPtrC8 phonebookStore,aid, phonebookName,alphaTag,telNum,alphaTag2,emails, groups, additional;

		TInt index;

		TUint8 npiTon;

		ret=GetPhBkUSimEntry(item,parseIndex,phonebookStore,phonebookName,aid,index,telNum,alphaTag,npiTon,alphaTag2);

		if(ret!=KErrNone)

			{

			LOGPARSERR("Phonebook Entry",ret,index,&KPhBkUSimStoreEntry);

			continue;

			}

		if(phonebookStore.MatchF(iPhBkStore)!=0)// Not this PhBkStore type

			continue;

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

			continue;

		if(phonebookStore.MatchF(KUSimPhoneBook)==0 &&

			iPhBkAid.Length()==0) //starting up

			{

			iPhBkAid.Copy(aid);

			iPhBkAidUSim1.Copy(aid);

			iPhBkUSimStoreEntries=iPhBkUSim1StoreEntries;

			}

		else if(phonebookStore.MatchF(KUSimPhoneBook)==0 &&

			iPhBkAid.Length()!=0 && iPhBkAid.Compare(aid)!=KErrNone)

			{

			if(iPhBkAidUSim2.Length()==0)

				{

				iPhBkAid.Copy(aid);

				iPhBkAidUSim2.Copy(aid);

				iPhBkUSimStoreEntries=iPhBkUSim2StoreEntries;

				}

			else if(iPhBkAidUSim2.Compare(aid)==KErrNone)

				{

				iPhBkAid.Copy(aid);

				iPhBkUSimStoreEntries=iPhBkUSim2StoreEntries;	

				}

			else if(iPhBkAidUSim2.Compare(aid)!=KErrNone)

				//Currently there is support for only 2 USim phonebooks

				{continue;} //...so, a possible third one will be ignored!!!

			}

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

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

		iPhBkUSimStoreEntries[index].iTonNpi=npiTon;

		iPhBkUSimStoreEntries[index].iAlphaTag2.Copy(alphaTag2);

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,parseIndex++,additional);

		if(ret!=KErrNone)

			{

			LOGPARSERR("additional",ret,parseIndex,&KPhBkUSimStoreEntry);

			}

		else

			{	

			TPtrC8 myName,myNum;

			TUint8 myTon;

			TInt myindex=0,pIndex=0;

			iPhBkUSimStoreEntries[index].iAdditional=new(ELeave) CArrayFixFlat<TPhBkStoreEntry>(iPhBkAdditional+1);

			while((GetPhBkAdditionalEntry(additional,pIndex,myNum,myName,myTon)==KErrNone)

					&& (myindex < iPhBkAdditional))

				{

				TPhBkStoreEntry entry;

				entry.iAlphaTag.Copy(myName);

				entry.iTelNum.Copy(myNum);

				entry.iTonNpi=myTon;

				TRAP_IGNORE(iPhBkUSimStoreEntries[index].iAdditional->AppendL(entry));

				myindex++;

				}

			}

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,parseIndex++,emails);

		if(ret!=KErrNone)

			{

			LOGPARSERR("emails",ret,parseIndex,&KPhBkUSimStoreEntry);

			}

		else

		{	

			TPtrC8 myemail;

			TInt myindex=0;

			iPhBkUSimStoreEntries[index].iEmails=new(ELeave) CArrayFixFlat<TPhBkUSimEmail>(iPhBkMaxEmail+1);

			while((CTestConfig::GetElement(emails,';',myindex,myemail)==KErrNone) &&

					(myindex < iPhBkMaxEmail))

			{

			TPhBkUSimEmail entry;

			entry.Copy(myemail);

			TRAP_IGNORE(iPhBkUSimStoreEntries[index].iEmails->AppendL(entry));

			myindex++;

			}

		}

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,parseIndex++,groups);

		if(ret!=KErrNone)

			{

			LOGPARSERR("groups",ret,parseIndex,&KPhBkUSimStoreEntry);

			}

		else

		{	

			TPtrC8 mygroup;

			TInt myindex=0;

			iPhBkUSimStoreEntries[index].iGroups=new(ELeave) CArrayFixFlat<TPhBkUSimGroup>(KMaxGroups+1);

			while((CTestConfig::GetElement(groups,';',myindex,mygroup)==KErrNone) &&

					(myindex < KMaxGroups))

			{

			TPhBkUSimGroup entry;

			entry.Copy(mygroup);

			TRAP_IGNORE(iPhBkUSimStoreEntries[index].iGroups->AppendL(entry));

			myindex++;

			}

		}

		TBool hidden;

		ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,parseIndex++,hidden);

		if(ret!=KErrNone)

			{

			LOGPARSERR("emails",ret,parseIndex,&KPhBkUSimStoreEntry);

			}

		else

			iPhBkUSimStoreEntries[index].iHiddenEntry=hidden;

		}

	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)

			{

			LOGPARSERR("count",ret,0,&KPhBkError);

			continue;

			}

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

		if(ret!=KErrNone)

			{

			LOGPARSERR("error",ret,1,&KPhBkError);

			continue;

			}

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

		if(ret!=KErrNone)

			{

			LOGPARSERR("phonebookName",ret,2,&KPhBkError);

			continue;

			}

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

		if(ret!=KErrNone)

			{

			LOGPARSERR("phonebookStore",ret,3,&KPhBkError);

			//global phonebook error

			continue;

			}

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

			continue;

		else if(phonebookStore.MatchF(iPhBkStore)!=0)// Not this phonebook

			continue;

		TPhBkError entry;

		entry.iCount=count;

		entry.iError=error;

		TRAP_IGNORE(iPhBkError->AppendL(entry));

		}

	PopulateOOBWrite();

	PopulateOOBDelete();

	LOGPHBK1("...Finished reading Phonebook store entries...");

	if(iPhBkOOBWriteDuration!=-1)

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

	if(iPhBkOOBDeleteDuration!=-1)

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

	}

void CSimPhBkUSimStore::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>"

 */

	{

	TInt parseIndex=0;

	iPhBkOOBWriteDuration=KErrNotFound;

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

	if(!item)

		return;

	TInt count;

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

	if(ret!=KErrNone)

		{

		LOGPARSERR("count",ret,parseIndex,&KOOBPhBkUSimWrite);

		return;

		}

	TPtrC8 phonebookStore,aid, phonebookName,alphaTag,telNum,alphaTag2,emails, groups, additional;

	TInt index;

	TUint8 npiTon;

	ret=GetPhBkUSimEntry(item,parseIndex,phonebookStore,phonebookName,aid,index,telNum,alphaTag,npiTon,alphaTag2);

	if(ret!=KErrNone)

		{

		LOGPARSERR("Phonebook Entry",ret,parseIndex,&KOOBPhBkUSimWrite);

		return;

		}

	if(phonebookStore.MatchF(iPhBkStore)!=0)// Not this PhBkStore type

		return;

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

		return;

	iPhBkOOBWriteDuration=count;

	iPhBkOOBWriteIndex=index;

	iPhBkOOBWrite.iAlphaTag.Copy(alphaTag);

	iPhBkOOBWrite.iTelNum.Copy(telNum);

	iPhBkOOBWrite.iTonNpi=npiTon;

	iPhBkOOBWrite.iAlphaTag2.Copy(alphaTag2);

	ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,parseIndex++,additional);

	if(ret!=KErrNone)

		{

		LOGPARSERR("additional",ret,parseIndex,&KOOBPhBkUSimWrite);

		}

	else

	{	

		TPtrC8 myName,myNum;

		TUint8 myTon;

		TInt myindex=0,pIndex=0;

		TRAPD(err,iPhBkOOBWrite.iAdditional=new(ELeave) CArrayFixFlat<TPhBkStoreEntry>(iPhBkAdditional+1));

		if (err!=KErrNone)

			return;

		while((GetPhBkAdditionalEntry(additional,pIndex,myNum,myName,myTon)==KErrNone)

				&& (myindex < iPhBkAdditional))

		{

		TPhBkStoreEntry entry; 

		entry.iAlphaTag.Copy(myName);

		entry.iTelNum.Copy(myNum);

		entry.iTonNpi=myTon;

		TRAP_IGNORE(iPhBkOOBWrite.iAdditional->AppendL(entry));

		myindex++;

		}

	}

	ret=CTestConfig::GetElement(item->Value(),KStdDelimiter,parseIndex++,groups);

	if(ret!=KErrNone)

		{

		LOGPARSERR("groups",ret,parseIndex,&KOOBPhBkUSimWrite);

		}

	else

	{	

		TPtrC8 mygroup;

		TInt myindex=0;

		TRAPD(err,iPhBkOOBWrite.iGroups=new(ELeave) CArrayFixFlat<TPhBkUSimGroup>(KMaxGroups+1));

		if (err!=KErrNone)

			return;

		while((CTestConfig::GetElement(groups,';',myindex,mygroup)==KErrNone) &&

				(myindex < KMaxGroups))

		{

		TPhBkUSimGroup entry;