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

// Implementation of the Background Sync Engine server. The engine provides

// the ability to perform Phonebook Sync's long running operations (e.g. Sync,

// write contact and delete contact).

// 

//

/**

 @file

 @internalComponent

*/

#include <connect/sbdefs.h>

#include <commsdattypesv1_1.h>

#include <cdblen.h>

#include "common.h"

#include "PhonebookManager.h"

#include "SyncContactICCEntry.h"

#include "phbksynclog.h"

#include "SyncEngineServer.h"

#include "SyncEngineSession.h"

#include "SyncContactsWithICC.h"

#include "WriteContactToICC.h"

#include "DeleteContactFromICC.h"

using namespace CommsDat;

/**

 * Number of retries for connecting to Etel.

 */

const TInt KMaxConnectToEtelRetries = 3;

//

// Teleplate names.  Should be in a resource file for localisation really!

//

_LIT(KPhbkTemplateADN, "SIM Card Contacts ADN");

_LIT(KPhbkTemplateSDN, "SIM Card Contacts SDN");

_LIT(KPhbkTemplateLND, "SIM Card Contacts LND");

_LIT(KPhbkTemplateUSimApp, "SIM Card Contacts USIMAPP");

_LIT(KPhbkTemplateFDN, "SIM Card Contacts FDN");

_LIT(KPhbkTemplateNotSpecified, "SIM Card Contacts Name Not Specified");

//

// Constants for encoding contacts...

//

_LIT(KEngineInternationalPrefix,"+");

//

//  Definition of iPolicy dictating the capability checking for phbksyncsvr...

//

const TUint iEngineRangeCount = 10;

const TInt CSyncEngineServer::iRanges[iEngineRangeCount] = 

	{

	0,		//range is 0

	1,		//range is 1-3 inclusive

	4,		//range is 4-5 inclusive

	6,		//range is 6

	7,		//range is 7-13 inclusive

	14,		//range is 14

	15,		//range is 15-16 inclusive

	17,		//range is 17-24 inclusive

	25,		//range is 25 inclusive

	26,		//range is 26-KMaxTInt inclusive

	};

const TUint8 CSyncEngineServer::iElementsIndex[iEngineRangeCount] = 

	{

	0,

	1,

	2,

	3,

	4,

	5,

	6,

	7,

	8,

	CPolicyServer::ENotSupported,

	};

const CPolicyServer::TPolicyElement CSyncEngineServer::iElements[] = 

	{

	{ _INIT_SECURITY_POLICY_C2( ECapabilityReadUserData, ECapabilityWriteUserData), CPolicyServer::EFailClient},	// policy 0:  range 0 - 0

	{ _INIT_SECURITY_POLICY_C1( ECapability_None), CPolicyServer::EFailClient},	// policy 1:  range 1 - 3

	{ _INIT_SECURITY_POLICY_C1( ECapabilityWriteUserData), CPolicyServer::EFailClient},	// policy 2:  range 4 - 5

	{ _INIT_SECURITY_POLICY_C1( ECapabilityReadUserData), CPolicyServer::EFailClient},	// policy 3:  range 6 - 6

	{ _INIT_SECURITY_POLICY_C1( ECapability_None), CPolicyServer::EFailClient},	// policy 4:  range 7 - 13

	{ _INIT_SECURITY_POLICY_C2( ECapabilityReadUserData, ECapabilityWriteUserData), CPolicyServer::EFailClient},	// policy 5:  range 14 - 14

	{ _INIT_SECURITY_POLICY_C1( ECapabilityWriteUserData), CPolicyServer::EFailClient},	// policy 6:  range 15 - 16

	{ _INIT_SECURITY_POLICY_C1( ECapability_None), CPolicyServer::EFailClient},	// policy 7:  range 17 - 24

#ifdef _DEBUG

	{ _INIT_SECURITY_POLICY_C1( ECapability_None), CPolicyServer::EFailClient}, // policy 8: range 25

#else

	{ _INIT_SECURITY_POLICY_FAIL}, // policy 8: range 25

#endif

	};

const CPolicyServer::TPolicy CSyncEngineServer::iPolicy = 

	{

	CPolicyServer::EAlwaysPass ,

	iEngineRangeCount,

	iRanges,

	iElementsIndex,

	iElements

	};

/**

 *  Static factory method used to create a CSyncEngineServer object.

 *

 *  @param aPhoneBookManager  Reference to the front-end servers's phonebook

 *                            manager.

 *

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

 */

CSyncEngineServer* CSyncEngineServer::NewL(CPhoneBookManager& aPhoneBookManager)

	{

	LOGENGINE1(_L8("NewL()"));

	CSyncEngineServer*  self = new (ELeave) CSyncEngineServer(aPhoneBookManager);

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop(self);

	return self;

	} // CSyncEngineServer::NewL

/**

 *  Standard constructor.

 *

 *  @param aPhoneBookManager  Reference to the front-end servers's phonebook

 *                            manager.

 */

CSyncEngineServer::CSyncEngineServer(CPhoneBookManager& aPhoneBookManager)

	: CPolicyServer(EPriorityNormal, iPolicy, ESharableSessions), 

	iICCCaps(RMobilePhone::KCapsSimAccessSupported), 

	iPhoneBookSyncEngineStarter(NULL),

	iConnectedSession(NULL),

	iPhonebookManager(aPhoneBookManager),

	iSyncContactsWithICC(NULL),

	iWriteContactToICC(NULL),

	iDeleteContactFromICC(NULL)

	{

	__DECLARE_NAME(_L("CSyncEngineServer"));

	} // CSyncEngineServer::CSyncEngineServer

/**

 *  Second phase constructor. Ensures the server is created and ready to run.

 */

void CSyncEngineServer::ConstructL()

	{

	StartL(PHBKSYNC_ENGINE_NAME);

	} // CSyncEngineServer::ConstructL

/**

 *  Destructor.

 */

CSyncEngineServer::~CSyncEngineServer()

	{

	//

	// Stop the engine from starting if it has initiated a startup.

	//

	delete iPhoneBookSyncEngineStarter;

	iPhoneBookSyncEngineStarter = NULL;

	//

	// Unconfigure the engine if needed...

	//

	TRAP_IGNORE(UnconfigureEngineL());

	delete iSyncContactsWithICC;

	delete iWriteContactToICC;

	delete iDeleteContactFromICC;

	} // CSyncEngineServer::~CSyncEngineServer

/**

 *  Configures the engine for use. This includes opening the ETel handles,

 *  connecting to the contacts database and opening the phonebook stores.

 */

void CSyncEngineServer::ConfigureEngineL()

	{

	LOGENGINE1(_L8("CSyncEngineServer::ConfigureEngineL()"));

	//

	// Connect to ETel...

	//

	TInt  etelErr(KErrNone), retryCount;

	for (retryCount = 0;  retryCount < KMaxConnectToEtelRetries;  retryCount++)

		{

		TRAP(etelErr, ConnectToEtelL());	//This can leave due to a denied access 										

											//to CommDb or Etel

		if (etelErr == KErrNone)

			{

			break;

			}

		if (retryCount < KMaxConnectToEtelRetries - 1)

			{

			User::After(1000000);

			}

		}

	User::LeaveIfError(etelErr);

	//

	// Open the Contacts DB...

	//

	TInt  dbErr(KErrNone);

	for (retryCount = 0;  retryCount < KMaxDbAccessRetryCount;  retryCount++)

		{

		TRAP(dbErr, iDb = CContactDatabase::OpenL());	// First try to open existing database

		if (dbErr == KErrNotFound)

			{

			TRAP(dbErr, iDb = CContactDatabase::CreateL()); // Database does not exist so create and open new one

			}

		if (dbErr == KErrNone)

			{

			break;

			}

		if (retryCount < KMaxDbAccessRetryCount - 1)

			{

			User::After(1000000);

			}

		}

	User::LeaveIfError(dbErr);

	//

	// Setup the phonebook parameters, read the settings from the INI

	// file and create the phonebook group IDs...

	//

	if (iPhone.GetIccAccessCaps(iICCCaps) != KErrNone) // Get type of ICC that is being used 

		{

		iICCCaps = RMobilePhone::KCapsSimAccessSupported; // set default value

		}

	CreatePhoneBookIdsL();

	} // CSyncEngineServer::ConfigureEngineL

/**

 *  Unconfigures the engine ready to shutdown.

 */

void CSyncEngineServer::UnconfigureEngineL()

	{

	LOGENGINE1(_L8("CSyncEngineServer::UnconfigureEngineL()"));

	iPhonebookManager.ClosePhoneBookStores();

	delete iDb;

	iDb = NULL;

	iPhone.Close();

	iEtelServer.Close();

	} // CSyncEngineServer::UnconfigureEngineL

/**

 *  Create a Template ID for the specified phonebook.

 *

 *  @param aPhonebookUid  UID of the phonebook to create an ID for.

 *  @param aICCCaps       The capabilities of the phone.

 */

void CSyncEngineServer::CreateTemplateIdL(TUid aPhonebookUid,

										  TUint32 aICCCaps)

	{

	LOGENGINE2(_L8("CreateTemplateIdL(0x%08x)"), aPhonebookUid);

	TContactItemId  templateId(KNullContactId);

	//

	// Check if there is an existing template in the contact database for

	// this phonebook...

	//

	CContactIdArray*  idList = iDb->GetCardTemplateIdListL();

	CleanupStack::PushL(idList);	

	if (idList != NULL  &&  idList->Count() > 0)

		{

		TInt  idCount = idList->Count();

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

			{

			CContactCardTemplate* item = static_cast<CContactCardTemplate*> (iDb->ReadContactLC((*idList)[index]));

			if ((aPhonebookUid == KUidIccGlobalAdnPhonebook  && 

				 item->GetTemplateLabelL() == KPhbkTemplateADN)  ||

				(aPhonebookUid == KUidIccGlobalSdnPhonebook  && 

				 item->GetTemplateLabelL() == KPhbkTemplateSDN)  ||

				(aPhonebookUid == KUidIccGlobalLndPhonebook  && 

				 item->GetTemplateLabelL() == KPhbkTemplateLND)  ||

				(aPhonebookUid == KUidUsimAppAdnPhonebook  && 

				 item->GetTemplateLabelL() == KPhbkTemplateUSimApp)  ||

				(aPhonebookUid == KUidIccGlobalFdnPhonebook  && 

				 item->GetTemplateLabelL() == KPhbkTemplateFDN))

				{

				templateId = (*idList)[index];

				User::LeaveIfError(iPhonebookManager.SetTemplateId(aPhonebookUid,

																   templateId));

				index = idCount; // to terminate loop

				}

			CleanupStack::PopAndDestroy(item);

			}

		}

	CleanupStack::PopAndDestroy(idList);

	//

	// If no suitable template been found create a new one...

	//

	if (templateId == KNullContactId)

		{

		LOGENGINE2(_L8("CreateTemplateIdL(0x%08x): Creating template."),

				   aPhonebookUid);

		CContactItem*  newTemplate;

		if (aPhonebookUid == KUidIccGlobalAdnPhonebook)

			{

			newTemplate = iDb->CreateContactCardTemplateLC(KPhbkTemplateADN);

			}

		else if (aPhonebookUid == KUidIccGlobalSdnPhonebook)

			{

			newTemplate = iDb->CreateContactCardTemplateLC(KPhbkTemplateSDN);

			}

		else if (aPhonebookUid == KUidIccGlobalLndPhonebook)

			{

			newTemplate = iDb->CreateContactCardTemplateLC(KPhbkTemplateLND);

			}

		else if (aPhonebookUid == KUidUsimAppAdnPhonebook)

			{

			newTemplate = iDb->CreateContactCardTemplateLC(KPhbkTemplateUSimApp);

			}

		else if (aPhonebookUid == KUidIccGlobalFdnPhonebook)

			{

			newTemplate = iDb->CreateContactCardTemplateLC(KPhbkTemplateFDN);

			}

		else

			{

			newTemplate = iDb->CreateContactCardTemplateLC(KPhbkTemplateNotSpecified);

			}

		templateId = newTemplate->Id();

		CleanupStack::PopAndDestroy(newTemplate);

		//

		// Remove all the unnecessary fields...

		//

		newTemplate = iDb->OpenContactLX(templateId);

		CleanupStack::PushL(newTemplate);	

		const TInt fieldCount = newTemplate->CardFields().Count();

		for(TInt i=fieldCount-1;i>=0;i--)

			{

			newTemplate->RemoveField(i);

			}

		//

		// Add default name field...

		//

		CContactItemField* name = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldFamilyName);

		name->SetMapping(KUidContactFieldVCardMapUnusedN);

		newTemplate->AddFieldL(*name);

		CleanupStack::Pop(name);

		//

		// Add second name field...

		//

		CContactItemField* secondName = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldSecondName);

		secondName->SetMapping(KUidContactFieldVCardMapSECONDNAME);

		secondName->SetUserFlags(EContactCategoryHome);

		newTemplate->AddFieldL(*secondName);

		CleanupStack::Pop(secondName);

		//

		// Add default number field...

		//

		CContactItemField* number = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldPhoneNumber);

		number->SetMapping(KUidContactFieldVCardMapTEL);

		number->AddFieldTypeL(KUidContactFieldVCardMapWORK);

		number->AddFieldTypeL(KUidContactFieldVCardMapVOICE);

		number->AddFieldTypeL(KUidContactFieldVCardMapCELL);

		newTemplate->AddFieldL(*number);

		CleanupStack::Pop(number);

		//

		// Add Slot Number field...

		//

		CContactItemField* slotnum = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldICCSlot);

		slotnum->SetMapping(KUidContactFieldVCardMapNotRequired);

		newTemplate->AddFieldL(*slotnum);

		CleanupStack::Pop(slotnum);

		//

		// Add Phonebook type field...

		//

		CContactItemField* phonebook = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldICCPhonebook);

		phonebook->SetMapping(KUidContactFieldVCardMapNotRequired);

		newTemplate->AddFieldL(*phonebook);

		CleanupStack::Pop(phonebook);

		//

		// 3G ICC so there are additional fields for ADN and USIM App

		// phonebooks.

		//

		if (aICCCaps & RMobilePhone::KCapsUSimAccessSupported)

			{

			if (aPhonebookUid == KUidIccGlobalAdnPhonebook  || 

			    aPhonebookUid == KUidUsimAppAdnPhonebook)

				{

				//

				// Add e-mail field...

				//

				CContactItemField* emailField = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldEMail);

				emailField->SetMapping(KUidContactFieldVCardMapUnusedN);

				newTemplate->AddFieldL(*emailField);

				CleanupStack::Pop(emailField);

				//

				// Add group field - this is different from contacts group.

				// This field indicates group that this ICC entry belongs to.

				// User can add this entry to a number of groups on ICC i.e.

				// business, private, etc. 

				//

				CContactItemField* group = CContactItemField::NewLC(KStorageTypeText,KUidContactFieldICCGroup);

				group->SetMapping(KUidContactFieldVCardMapUnusedN);

				newTemplate->AddFieldL(*group);

				CleanupStack::Pop(group);

				}

			}

		//

		// Store the new Template ID...

		//

		User::LeaveIfError(iPhonebookManager.SetTemplateId(aPhonebookUid, templateId));

		iDb->CommitContactL(*newTemplate);

		CleanupStack::PopAndDestroy(2); // newTemplate plus locked record

		}

	} // CSyncEngineServer::CreateTemplateIdL

/**

 *  Create a Group ID for the specified phonebook.

 *

 *  @param aPhonebookUid  UID of the phonebook to create an ID for.

 */

void CSyncEngineServer::CreateGroupIdL(TUid aPhonebookUid)

	{

	LOGENGINE2(_L8("CreateGroupIdL(0x%08x)"), aPhonebookUid);

	TContactItemId  groupId(KNullContactId);

	//

	// Check if there is an existing group in the contact database for this

	// phonebook...

	//

	CContactIdArray*  idList = iDb->GetGroupIdListL();

	CleanupStack::PushL(idList);

	if (idList != NULL  &&  idList->Count() > 0)

		{

		LOGENGINE2(_L8("CreateGroupIdL(0x%08x): Creating template."),

				   aPhonebookUid);

		TInt  idCount = idList->Count();

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

			{

			//

			// Retrieve the first entry in each group, obtain that entry's

			// template ID and check the template label to confirm if it

			// relates to this phonebook.

			//

			CContactGroup*  group = static_cast<CContactGroup*> (iDb->ReadContactLC((*idList)[index]));

			CContactIdArray*  itemList = group->ItemsContainedLC();

			if (itemList->Count() > 0)

				{

				CContactItem*  groupItem = iDb->ReadContactLC((*itemList)[0]);

				TContactItemId templateId = groupItem->TemplateRefId();

				if (templateId != KNullContactId)

					{

					CContactCardTemplate*  tempItem = static_cast<CContactCardTemplate*> (iDb->ReadContactLC(templateId));

					TPtrC templateLabel;

					TRAPD(errorCheck, templateLabel.Set(tempItem->GetTemplateLabelL()));

					// Check if the first item in the group uses a template with a label then check to see if the

					// label matches one of the Phonebook template labels

					if(errorCheck != KErrNotFound)

						{

						if(	(aPhonebookUid == KUidIccGlobalAdnPhonebook && templateLabel == KPhbkTemplateADN) ||

				   			(aPhonebookUid == KUidIccGlobalSdnPhonebook && templateLabel == KPhbkTemplateSDN) ||

						   	(aPhonebookUid == KUidIccGlobalLndPhonebook && templateLabel == KPhbkTemplateLND) ||

						   	(aPhonebookUid == KUidIccGlobalFdnPhonebook && templateLabel == KPhbkTemplateFDN) ||

							(aPhonebookUid == KUidUsimAppAdnPhonebook   && templateLabel == KPhbkTemplateUSimApp))

							{

							groupId = (*idList)[index];

							User::LeaveIfError(iPhonebookManager.SetGroupId(aPhonebookUid,groupId));

							index = idCount; // to terminate loop

							}

						}