// 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:

// Contains method implementations for Phonebook Synchroniser's

// CPhoneBookManager class which manages the parameters for the phone and

// each phonebook, including the Look-Up Tables, Phonebook store handles

// and flags for the synchroniser engine.

// This class can be accessed from either the server side or engine side.

// All applicable functions are mutex protected to prevent corruption from

// being accessed simutantiously from two threads. CPhoneBook is not protected

// hence why CPhoneBookManager does not give out the CPhoneBook object pointers,

// but performs all operations itself, with mutex protection.

// 

//

/**

 @file

 @internalComponent

*/

#include "phbksync.h"

#include "PhonebookManager.h"

#include "SyncContactICCEntry.h"

#include "phbksyncsvr.h"

#include "phbksynclog.h"

/**

 *  Static factory method used to create a CPhoneBookManager object.

 *

 *  @param aICCCaps  The capabilities of the ICC.

 *

 *  @return  Pointer to the created CPhoneBookManager object, or NULL.

 */

CPhoneBookManager* CPhoneBookManager::NewL(TUint32 aICCCaps)

	{

	CPhoneBookManager*  ptr = new (ELeave) CPhoneBookManager();

	CleanupStack::PushL(ptr);

	ptr->ConstructL(aICCCaps);

	CleanupStack::Pop(ptr);

	return ptr;

	} // CPhoneBookManager::NewL

/**

 *  Standard constructor.

 */

CPhoneBookManager::CPhoneBookManager()

  : iMutex(),

  	iPhonebookList(),

  	iIniFile(NULL),

	iIsPuk1Verified(ETrue),

	iPin1LockStatus(RMobilePhone::EStatusLockUnknown),

	iPin2LockStatus(RMobilePhone::EStatusLockUnknown),

	iHiddenKeyLockStatus(RMobilePhone::EStatusLockUnknown),

	iUsimAppLockStatus(RMobilePhone::EStatusLockUnknown),

	iUsimUniversalPinLockStatus(RMobilePhone::EStatusLockUnknown)

	{

	// NOP

	} // CPhoneBookManager::CPhoneBookManager

/**

 *  Standard denstructor.

 */

CPhoneBookManager::~CPhoneBookManager()

	{

	delete iIniFile;

	iPhonebookList.ResetAndDestroy();

	iMutex.Close();

	} // CPhoneBookManager::~CPhoneBookManager

/**

 *  Construct the list containing a table of parameters associated with each

 *  supported phonebook.  The list is constructed according to the type of the

 *  ICC specified by the aICCCaps parameter.

 *

 *  @note  The tables for supported phonebooks are created and added in the

 *         priority order. Therefore the global ADN will be synchronised first

 *         if its auto-sync setting is set.

 *

 *  @param aICCCaps  ICC caps indicating the type of ICC. 

 */

void CPhoneBookManager::ConstructL(TUint32 aICCCaps)

	{

	LOGPARAMS2(_L8("ConstructL(0x%08x)"), aICCCaps);

	//

	// Create the mutex which will protect the shared data...

	//

	iMutex.CreateLocal();

	//

	// By default following phonebook types are supported for all ICC types (SIM, R-UIM and USIM)

	//

	CPhoneBook*  ADNphonebook = CPhoneBook::NewL(KUidIccGlobalAdnPhonebook);

	iPhonebookList.Append(ADNphonebook);

	CPhoneBook*  SDNphonebook = CPhoneBook::NewL(KUidIccGlobalSdnPhonebook);

	iPhonebookList.Append(SDNphonebook);

	CPhoneBook*  LNDphonebook = CPhoneBook::NewL(KUidIccGlobalLndPhonebook);

	iPhonebookList.Append(LNDphonebook);

	// 3GPP USIM specific phonebook 

	if (aICCCaps & RMobilePhone::KCapsUSimAccessSupported)

		{

		CPhoneBook*  USIMphonebook = CPhoneBook::NewL(KUidUsimAppAdnPhonebook);

		iPhonebookList.Append(USIMphonebook);

		}

	CPhoneBook*  FDNphonebook = CPhoneBook::NewL(KUidIccGlobalFdnPhonebook);

	iPhonebookList.Append(FDNphonebook);

	//

	// Create the INI File class...

	//

	iIniFile = CPhoneBookIniFile::NewL(iPhonebookList);

	} // CPhoneBookManager::ConstructL

/**

 *  Gets the phonebook UID for the phonebook that contains the supplied

 *  Contact UID. Phonebooks are searched in order.

 *

 *  @param aContactId  Contact ID to search for.

 *

 *  @return The phonebook UID of the containing phonebook, or

 *          KUidIccPhonebookNotSpecified.

 */

TUid CPhoneBookManager::GetPhonebookUidFromContactId(TContactItemId aContactId)

	{

	LOGPARAMS2(_L8("GetPhonebookUidFromContactId(0x%08x)"), aContactId);

	TInt  count(iPhonebookList.Count());

	TUid  result(KUidIccPhonebookNotSpecified);

	AcquireMutex();

	for (TInt index = 0;  index < count;  index++)

		{

		TInt  slotNum = iPhonebookList[index]->GetSlotNumFromContactId(aContactId);

		if (slotNum > 0)

			{

			result = iPhonebookList[index]->GetPhonebookUid();

			break;

			}

		}

	ReleaseMutex();

	return result;

	} // CPhoneBookManager::GetPhonebookUidFromContactId

/**

 *  Return the phonebook type for the given template ID.

 *

 *  @param aTemplateId  The template ID associated with the phonebook.

 *

 *  @return TUid  UID for the phonebook or KUidIccPhonebookNotSpecified.

 */

TUid CPhoneBookManager::GetPhonebookUidFromTemplateId(TContactItemId aTemplateId)

	{

	LOGPARAMS2(_L8("GetPhonebookUidFromTemplateId(0x%08x)"), aTemplateId);

	TInt  count(iPhonebookList.Count());

	TUid  result(KUidIccPhonebookNotSpecified);

	AcquireMutex();

	for (TInt index = 0;  index < count;  index++)

		{

		if (iPhonebookList[index]->GetTemplateId() == aTemplateId)

			{

			result = iPhonebookList[index]->GetPhonebookUid();

			break;

			}

		}

	ReleaseMutex();

	return result;

	} // CPhoneBookManager::GetPhonebookUidFromTemplateId

/**

 *  Returns the stored PIN1 lock status.

 *

 *  @param aLockStatus  Filled on return with the stored value.

 */

void CPhoneBookManager::GetPin1LockStatus(RMobilePhone::TMobilePhoneLockStatus& aLockStatus)

	{

	LOGPARAMS1(_L8("GetPin1LockStatus()"));

	AcquireMutex();

	aLockStatus = iPin1LockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::GetPin1LockStatus

/**

 *  Sets the stored PIN1 lock status.

 *

 *  @param aLockStatus  Value of the lock to store.

 */

void CPhoneBookManager::SetPin1LockStatus(RMobilePhone::TMobilePhoneLockStatus aLockStatus)

	{

	LOGPARAMS1(_L8("SetPin1LockStatus()"));

	AcquireMutex();

	iPin1LockStatus = aLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::SetPin1LockStatus

/**

 *  Returns the stored PIN2 lock status.

 *

 *  @param aLockStatus  Filled on return with the stored value.

 */

void CPhoneBookManager::GetPin2LockStatus(RMobilePhone::TMobilePhoneLockStatus& aLockStatus)

	{

	LOGPARAMS1(_L8("GetPin2LockStatus()"));

	AcquireMutex();

	aLockStatus = iPin2LockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::GetPin2LockStatus

/**

 *  Sets the stored PIN2 lock status.

 *

 *  @param aLockStatus  Value of the lock to store.

 */

void CPhoneBookManager::SetPin2LockStatus(RMobilePhone::TMobilePhoneLockStatus aLockStatus)

	{

	LOGPARAMS1(_L8("SetPin2LockStatus()"));

	AcquireMutex();

	iPin2LockStatus = aLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::SetPin2LockStatus

/**

 *  Returns the stored Hidden Key lock status.

 *

 *  @param aLockStatus  Filled on return with the stored value.

 */

void CPhoneBookManager::GetHiddenKeyLockStatus(RMobilePhone::TMobilePhoneLockStatus& aLockStatus)

	{

	LOGPARAMS1(_L8("GetHiddenKeyLockStatus()"));

	AcquireMutex();

	aLockStatus = iHiddenKeyLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::GetHiddenKeyLockStatus

/**

 *  Sets the stored Hidden Key lock status.

 *

 *  @param aLockStatus  Value of the lock to store.

 */

void CPhoneBookManager::SetHiddenKeyLockStatus(RMobilePhone::TMobilePhoneLockStatus aLockStatus)

	{

	LOGPARAMS1(_L8("SetHiddenKeyLockStatus()"));

	AcquireMutex();

	iHiddenKeyLockStatus = aLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::SetHiddenKeyLockStatus

/**

 *  Returns the stored USIM App lock status.

 *

 *  @param aLockStatus  Filled on return with the stored value.

 */

void CPhoneBookManager::GetUsimAppLockStatus(RMobilePhone::TMobilePhoneLockStatus& aLockStatus)

	{

	LOGPARAMS1(_L8("GetUsimAppLockStatus()"));

	AcquireMutex();

	aLockStatus = iUsimAppLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::GetUsimAppLockStatus

/**

 *  Sets the stored USIM App lock status.

 *

 *  @param aLockStatus  Value of the lock to store.

 */

void CPhoneBookManager::SetUsimAppLockStatus(RMobilePhone::TMobilePhoneLockStatus aLockStatus)

	{

	LOGPARAMS1(_L8("SetUsimAppLockStatus()"));

	AcquireMutex();

	iUsimAppLockStatus = aLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::SetPin2UsimAppLockStatus

/**

 *  Returns the stored Universal PIN lock status.

 *

 *  @param aLockStatus  Filled on return with the stored value.

 */

void CPhoneBookManager::GetUsimUniversalPinLockStatus(RMobilePhone::TMobilePhoneLockStatus& aLockStatus)

	{

	LOGPARAMS1(_L8("GetUsimUniversalPinLockStatus()"));

	AcquireMutex();

	aLockStatus = iUsimUniversalPinLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::GetUsimUniversalPinLockStatus

/**

 *  Sets the stored USIM Universal PIN lock status.

 *

 *  @param aLockStatus  Value of the lock to store.

 */

void CPhoneBookManager::SetUsimUniversalPinLockStatus(RMobilePhone::TMobilePhoneLockStatus aLockStatus)

	{

	LOGPARAMS1(_L8("SetUsimUniversalPinLockStatus()"));

	AcquireMutex();

	iUsimUniversalPinLockStatus = aLockStatus;

	ReleaseMutex();

	} // CPhoneBookManager::SetUsimUniversalPinLockStatus

/**

 *  Records a security event. Since events are stateless, the event is not actually

 *  stored for retrieval but an internal state is updated.

 *

 *  @param aSecurityEvent  Security event to store.

 */

void CPhoneBookManager::RecordSecurityEvent(RMobilePhone::TMobilePhoneSecurityEvent aSecurityEvent)

	{

	LOGPARAMS2(_L8("RecordSecurityEvent(%d)"), aSecurityEvent);

	if (aSecurityEvent == RMobilePhone::ENoICCFound  ||

		aSecurityEvent == RMobilePhone::EICCTerminated  ||

		aSecurityEvent == RMobilePhone::EPuk1Required)

		{

		iIsPuk1Verified = EFalse;

		}

	else if (aSecurityEvent == RMobilePhone::EPuk1Verified)

		{

		iIsPuk1Verified = ETrue;

		}

	} // CPhoneBookManager::RecordSecurityEvent

/**

 *  Returns the current state of access to PIN 1 priviledged facilities.

 *

 *  @return ETrue if the ICC is in a usable state with PIN 1 access, otherwise

 *          return EFalse.

 */

TBool CPhoneBookManager::IsPin1Valid()

	{

	LOGPARAMS1(_L8("IsPin1Valid()"));

	AcquireMutex();

	//

	// Return true if all of the following conditions are true.  Note that we

	// only look for specific statuses, and ignore unknowns.  Thus if the TSY

	// doesn't implement some locks, then the default expected behaviour will

	// occur.

	//

	TBool  result = (iIsPuk1Verified  &&

					 iPin1LockStatus != RMobilePhone::EStatusLocked  &&

					 iPin1LockStatus != RMobilePhone::EStatusBlocked  &&

					 iHiddenKeyLockStatus != RMobilePhone::EStatusLocked  &&

					 iHiddenKeyLockStatus != RMobilePhone::EStatusBlocked);

	ReleaseMutex();

	return result;

	} // CPhoneBookManager::IsPin1Valid

/**

 *  Returns the current state of access to PIN 2 priviledged facilities.

 *

 *  @return ETrue if the ICC is in a usable state with PIN 2 access, otherwise

 *          return EFalse.

 */

TBool CPhoneBookManager::IsPin2Valid()

	{

	LOGPARAMS1(_L8("IsPin2Valid()"));

	AcquireMutex();

	//

	// Return true if PIN2 is unlocked.  Note that we only look for specific

	// statuses, and ignore unknowns.  Thus if the TSY doesn't implement some

	// locks, then the default expected behaviour will occur.

	//

	TBool  result = (iPin2LockStatus == RMobilePhone::EStatusUnlocked);

	ReleaseMutex();

	return result;

	} // CPhoneBookManager::IsPin2Valid

/**

 *  Returns the current state of access to USIM App priviledged facilities.

 *

 *  @return ETrue if the USIM App is in a usable state with PIN access, otherwise

 *          return EFalse.

 */

TBool CPhoneBookManager::IsUsimAppPinValid()

	{

	LOGPARAMS1(_L8("IsUsimAppPinValid()"));

	AcquireMutex();

	//

	// Return true if all of the following conditions are true.  Note that we

	// only look for specific statuses, and ignore unknowns.  Thus if the TSY

	// doesn't implement some locks, then the default expected behaviour will

	// occur.

	//

	TBool  result = (iUsimAppLockStatus != RMobilePhone::EStatusLocked  &&

					 iUsimAppLockStatus != RMobilePhone::EStatusBlocked  &&

					 iUsimUniversalPinLockStatus != RMobilePhone::EStatusLocked  &&

					 iUsimUniversalPinLockStatus != RMobilePhone::EStatusBlocked);

	ReleaseMutex();

	return result;

	} // CPhoneBookManager::IsUsimAppPinValid

/**

 *  Returns the result for the given phonebook which specifies whether the

 *  PhBkInfo data has been stored or if the phonebook is not supported.

 *

 *  @param aPhonebookUid  Phonebook UID to get the value from.

 *  @param aErrorCode     Filled with the value on successful exit.

 *

 *  @return KErrNone if the result is retrieved, otherwise a system error code.

 */

TInt CPhoneBookManager::GetPhBkInfoRetrievedResult(TUid aPhonebookUid,

											       TInt& aErrorCode)

	{

	LOGPARAMS2(_L8("GetPhBkInfoRetrievedResult(0x%08x)"), aPhonebookUid);

	//	

	// Get the pointer to the object containing parameters associated

	// with this phonebook.

	//

	CPhoneBook*  phonebook;

	TInt  result = GetPhonebook(aPhonebookUid, phonebook);

	if (result != KErrNone)

		{

		return result;

		}

	//

	// Get the PhBkInfo retrieved flag from the phonebook parameters.

	//

	AcquireMutex();

	aErrorCode = phonebook->GetPhBkInfoRetrievedResult();

	ReleaseMutex();

	return KErrNone;

	} // CPhoneBookManager::GetPhBkInfoRetrievedResult

/**

 *  Sets the result for the given phonebook which specifies whether the

 *  PhBkInfo data has been stored or if it is not supported.

 *

 *  @param aPhonebookUid  Phonebook UID to set the value on.

 *  @param aErrorCode     Value to set.

 *

 *  @return KErrNone if the flag is set, otherwise a system error code.

 */

TInt CPhoneBookManager::SetPhBkInfoRetrievedResult(TUid aPhonebookUid,

											       TInt aErrorCode)

	{

	LOGPARAMS3(_L8("SetPhBkInfoRetrievedResult(0x%08x, %d)"),

			   aPhonebookUid, aErrorCode);

	//	

	// Get the pointer to the object containing parameters associated

	// with this phonebook.

	//

	CPhoneBook*  phonebook;

	TInt  result = GetPhonebook(aPhonebookUid, phonebook);

	if (result != KErrNone)

		{

		return result;

		}

	//

	// Set the PhBkInfo retrieved flag in the phonebook parameters.

	//

	AcquireMutex();

	phonebook->SetPhBkInfoRetrievedResult(aErrorCode);

	ReleaseMutex();

	return KErrNone;

	} // CPhoneBookManager::SetPhBkInfoRetrievedResult