// 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 CPhoneBookServer class which is the front-end server,

// responsible for processing all short and quick requests, and for passing

// longer requests to the engine.

// 

//

/**

 @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 "phbksyncsvr.h"

#include "phbksyncsess.h"

#include "SyncEngineRequest.h"

#include "ActiveNotifications.h"

using namespace CommsDat;

/**

 * Number of retries for connecting to Etel.

 */

const TInt KMaxConnectToEtelRetries = 3;

//

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

//

const TUint iRangeCount = 10;

const TInt CPhoneBookServer::iRanges[iRangeCount] = 

	{

	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 CPhoneBookServer::iElementsIndex[iRangeCount] = 

	{

	0,

	1,

	2,

	3,

	4,

	5,

	6,

	7,

	8,

	CPolicyServer::ENotSupported,

	};

const CPolicyServer::TPolicyElement CPhoneBookServer::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 CPhoneBookServer::iPolicy = 

	{

	CPolicyServer::EAlwaysPass,

	iRangeCount,

	iRanges,

	iElementsIndex,

	iElements

	};

/**

 *  Static factory method used to create a CPhoneBookServer object.

 *

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

 */

CPhoneBookServer* CPhoneBookServer::NewL()

	{

	LOGSERVER1(_L8("NewL()"));

	CPhoneBookServer* self = new (ELeave) CPhoneBookServer();

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop(self);

	return self;

	} // CPhoneBookServer::NewL

/**

 *  Standard constructor.

 */

CPhoneBookServer::CPhoneBookServer()

	: CPolicyServer(EPriorityNormal, iPolicy, ESharableSessions), 

	iServerConfigLevel(EServerConfigurationNone),

	iICCCaps(RMobilePhone::KCapsSimAccessSupported), 

	iPhonebookManager(NULL),

	iShouldShutdownServer(EFalse),

	iShouldShutdownUnconditionally(EFalse)

	{

	__DECLARE_NAME(_L("CPhoneBookServer"));

	} // CPhoneBookServer::CPhoneBookServer

/**

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

 */

void CPhoneBookServer::ConstructL()

	{

	StartL(PHBKSYNC_SERVER_NAME);

	} // CPhoneBookServer::ConstructL

/**

 *  Destructor.

 */

CPhoneBookServer::~CPhoneBookServer()

	{

	//

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

	//

	delete iPhoneBookSyncStarter;

	iPhoneBookSyncStarter = NULL;

	//

	// Unconfigure the server if needed...

	//

	TRAP_IGNORE(ConfigureServerL(EServerConfigurationNone));

	iCacheStateNotificationArray.Reset();

	iSyncEngineRequestArray.ResetAndDestroy();

	iSessionArray.Reset();

	} // CPhoneBookServer::~CPhoneBookServer

/**

 *  Attempts to configure or unconfigure the server as specified. If this

 *  function leaves, the configuration state will be invalid. This function

 *  is therefore a private function and callers should use ConfigureServerL()

 *  instead which protects against such problems.

 *  

 *  @param aLevel  The desired configuration level to initialise the server to.

 */

void CPhoneBookServer::AttemptToConfigureServerL(TServerConfiguration aLevel)

	{

	LOGSERVER2(_L8("AttemptToConfigureServerL() to level %d"), aLevel);

	//

	// Are we configuring or unconfiguring?

	//

	if (iServerConfigLevel < aLevel)

		{

		//

		// Configure from level 'None' to 'Idle'...

		//

		if (iServerConfigLevel == EServerConfigurationNone)

			{

			iServerConfigLevel = EServerConfigurationConfiguringToIdle;

			LOGSERVER1(_L8("Configuration changed from 'None' to 'ConfiguringToIdle'."));

			iNotifyBackupAndRestore = CNotifyBackupAndRestore::NewL(*this);

			User::LeaveIfError(iNotifyBackupAndRestore->Start());

			iServerConfigLevel = EServerConfigurationIdle;

			LOGSERVER1(_L8("Configuration changed from 'ConfiguringToIdle' to 'Idle'."));

			}

		//

		// Configure from level 'Idle' to 'Full'...

		//

		if (iServerConfigLevel < aLevel  &&

			iServerConfigLevel == EServerConfigurationIdle)

			{

			iServerConfigLevel = EServerConfigurationConfiguringToFull;

			LOGSERVER1(_L8("Configuration changed from 'Idle' to 'ConfiguringToFull'."));

			//

			// 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);

			//

			// Setup the phonebook parameters and create the Phonebook Manager.

			// This will also read the settings from the INI file.

			//

			if (iPhone.GetIccAccessCaps(iICCCaps) != KErrNone)

				{

				iICCCaps = RMobilePhone::KCapsSimAccessSupported;

				}

			iPhonebookManager = CPhoneBookManager::NewL(iICCCaps);

			//

			// Initialise and start the Active Objects...

			//

			iGetPhoneStoreInfo = CGetPhoneStoreInfo::NewL(*this,

														  *iPhonebookManager,

														  iPhone);

			User::LeaveIfError(iGetPhoneStoreInfo->Start());

			iNotifyLockInfoChange = CNotifyLockInfoChange::NewL(*this, iPhone);

			User::LeaveIfError(iNotifyLockInfoChange->Start());

			iGetSecurityEvent = CNotifySecurityEvent::NewL(*this, iPhone);

			User::LeaveIfError(iGetSecurityEvent->Start());

			if (IsUsimAppTsy()  &&

				(iICCCaps & RMobilePhone::KCapsUSimAccessSupported))

				{

				iNotifyAppInfoChange = CNotifyAppInfoChange::NewL(*this, iPhone);

				User::LeaveIfError(iNotifyAppInfoChange->Start());

				}

			if (iIsSatSupported)

				{

				iNotifySatUpdates = CNotifySATUpdates::NewL(*this, iSat);

	 			User::LeaveIfError(iNotifySatUpdates->Start());

				}

			//

			// Start the Sync Engine...

			//

			User::LeaveIfError(iSyncEngine.Connect(iPhonebookManager));

			iServerConfigLevel = EServerConfigurationFull;

			LOGSERVER1(_L8("Configuration changed from 'ConfiguringToFull' to 'Full'."));

			}

		}

	else if (iServerConfigLevel > aLevel)

		{

		//

		// Unconfigure from level 'Full' to 'Idle'...

		//

		if (iServerConfigLevel == EServerConfigurationFull  ||

			iServerConfigLevel == EServerConfigurationConfiguringToFull)

			{

			iCacheStateNotificationArray.Reset();

			iSyncEngineRequestArray.ResetAndDestroy();

			iSyncEngine.Close();

			delete iNotifySatUpdates;

			iNotifySatUpdates = NULL;

			delete iGetSecurityEvent;

			iGetSecurityEvent = NULL;

			delete iNotifyLockInfoChange;

			iNotifyLockInfoChange = NULL;

			delete iGetPhoneStoreInfo;

			iGetPhoneStoreInfo = NULL;

			delete iPhonebookManager;

			iPhonebookManager = NULL;

			delete iNotifyAppInfoChange;

			iNotifyAppInfoChange = NULL;

			iSat.Close();

			iPhone.Close();

			iEtelServer.Close();

			iServerConfigLevel = EServerConfigurationIdle;

			LOGSERVER1(_L8("Configuration changed to 'Idle'."));

			}

		//

		// Unconfigure from level 'Idle' to 'None'...

		//

		if (iServerConfigLevel > aLevel  &&

			(iServerConfigLevel == EServerConfigurationIdle  ||

			 iServerConfigLevel == EServerConfigurationConfiguringToIdle))

			{

			delete iNotifyBackupAndRestore;

			iNotifyBackupAndRestore = NULL;

			iServerConfigLevel = EServerConfigurationNone;

			LOGSERVER1(_L8("Configuration changed to 'None'."));

			}

		}

	} // CPhoneBookServer::AttemptToConfigureServerL

/**

 *  Configures or unconfigures the server as specified.

 *  

 *  @param aLevel  The desired configuration level to initialise the server to.

 */

void CPhoneBookServer::ConfigureServerL(TServerConfiguration aLevel)

	{

	//

	// Check parameter is valid...

	//

	if (aLevel != EServerConfigurationNone  &&

		aLevel != EServerConfigurationIdle  &&

		aLevel != EServerConfigurationFull)

		{

		User::Leave(KErrArgument);

		}

	//

	// Save the current configuration level in case AttemptToConfigureServerL()

	// leaves.

	//

	TServerConfiguration  oldConfigLevel = iServerConfigLevel;

	TRAPD(configErr, AttemptToConfigureServerL(aLevel));

	//

	// If the attempt to configure the server failed, then reset the config

	// state and leave.

	//

	if (configErr != KErrNone)

		{

		LOGSERVER2(_L8("ConfigureServerL: Could not config server (Error %d)."),

			     configErr);

		TRAPD(unconfigErr, AttemptToConfigureServerL(oldConfigLevel));

		if (unconfigErr != KErrNone)

			{

			LOGSERVER2(_L8("ConfigureServerL: Could not unconfig server either (Error %d)."),

				     unconfigErr);

			}

		iServerConfigLevel = oldConfigLevel;

		User::Leave(configErr);

		}

	} // CPhoneBookServer::ConfigureServerL

/**

 *  This method is called by the system to indicate that a backup or restore has

 *  started.

 */

void CPhoneBookServer::HandleBackupOrRestoreStarting()

	{

	LOGSERVER1(_L8("HandleBackupOrRestoreStarting()"));

	TRAPD(err, ConfigureServerL(EServerConfigurationIdle));

	if (err != KErrNone)

		{

		LOGSERVER2(_L8("ConfigureServerL() failed with error %d."), err);

		}

	} // CPhoneBookServer::HandleBackupOrRestoreStarting

/**

 *  This method is called by the system to indicate that a backup or restore has

 *  completed.

 */

void CPhoneBookServer::HandleBackupOrRestoreComplete()

	{

	LOGSERVER1(_L8("HandleBackupOrRestoreComplete()"));

	TRAPD(err, ConfigureServerL(EServerConfigurationFull));

	if (err != KErrNone)

		{

		LOGSERVER2(_L8("ConfigureServerL() failed with error %d."), err);

		}

	} // CPhoneBookServer::HandleBackupOrRestoreComplete

/**

 *  Create a new client session.

 *

 *  @note You can not create a new session if the server is shuting down

 *        unconditionally.

 */

CSession2* CPhoneBookServer::NewSessionL(const TVersion&, const RMessage2& /*aMessage*/) const

	{

	LOGSERVER1(_L8("NewSessionL"));

	if (iShouldShutdownUnconditionally)

		{

		User::Leave(KErrPermissionDenied);

		}

	return new(ELeave) CPhoneBookSession();

	} // CPhoneBookServer::NewSessionL

/**

 *  Called by the session class when it is being created.

 *

 *  @param aSession  Server side session.

 */

void CPhoneBookServer::AddSessionL(CPhoneBookSession* aSession)

	{

	LOGSERVER1(_L8("AddSession"));

	//

	// Store this session in the list of sessions...

	//

	iSessionArray.Append(aSession);

	//

	// Queue an Active Object to configure the server straight after this

	// session is created.

	//

	if (iPhoneBookSyncStarter == NULL  &&

	    iServerConfigLevel == EServerConfigurationNone)

		{

		iPhoneBookSyncStarter = new (ELeave) CPhoneBookSyncStarter(*this);

		iPhoneBookSyncStarter->Call();

		}

	} // CPhoneBookServer::AddSessionL

/**

 *  Called by the session class when it is being destroyed.

 *

 *  @param aSession  Server side session.

 */

void CPhoneBookServer::DropSession(CPhoneBookSession* aSession)

	{

	LOGSERVER1(_L8("DropSession"));

	//

	// Remove this session from the session array list...

	//

	TInt  position;

	position = iSessionArray.Find(aSession);

 	if (position != KErrNotFound) 

		{

 		iSessionArray.Remove(position);

 		// 

 		// Also remove any outstanding notifications owned by this session

 		//

		for (TInt index = 0;  index < iCacheStateNotificationArray.Count();  index++)

			{

			TCacheStateNotification  notifyRequest = iCacheStateNotificationArray[index];

			if (notifyRequest.iSession == aSession)

				{

				//

				// If it is in the list then just remove and complete it since session has been closed...

				//

				aSession->CompleteRequest(notifyRequest.iMessage, KErrDisconnected);

				iCacheStateNotificationArray.Remove(index);

				index--;

				}

			} 		

		}

	//

	// If we are shuting down then unconfigure and stop...

	//

	if (iSessionArray.Count() == 0  &&  iShouldShutdownServer)

		{

		TRAP_IGNORE(ConfigureServerL(EServerConfigurationNone));

		CActiveScheduler::Stop();

		}

	} // CPhoneBookServer::DropSession

/**

 *  Requests a synchronisation from the engine. This is an asynchronous

 *  request that will result in an engine request being posted to the engine.

 *

 *  @param aSession       A reference to the client session.

 *  @param aMessage       A reference to the client request.

 *  @param aPhonebookUid  UID of the ICC phonebook to perform the operation on.

 */

void CPhoneBookServer::DoSynchronisationL(CPhoneBookSession& aSession,

										  const RMessage2& aMessage,

										  TUid aPhonebookUid)

	{

	LOGSERVER2(_L8("DoSynchronisationL(0x%08x)"), aPhonebookUid);

	//

	// Is the server configured for use?

	//

	if (iServerConfigLevel != EServerConfigurationFull)

		{