/*

* Copyright (c) 2004-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: 

*

*/

/**

 @file

 @internalComponent

 @released

*/

#include <s32mem.h>

#include <cntitem.h>

#include <cntdb.h>

#include <cntfilt.h>

#include "rcntmodel.h"

#include "persistencelayer.h" // for mlplcollection.

#include "ccntnotificationmonitor.h"

#include "ccontactprivate.h" // for mprogresseventhander.

#include "ccntpackager.h"

#include <cntviewstore.h>

/** Contacts server version number. */ 

const TInt KCntServerMajorVersionNumber=1;

const TInt KCntServerMinorVersionNumber=1;

const TInt KCntServerBuildVersionNumber=1;

/** Number of attempts to try restart the server after premature termination. */

const TInt KMaxTimesToRestartServer = 3;

/** Maximum number of asynchronous IPC calls. */

const TInt KAsyncMessageSlots=6;

/**

Unlock the last locked contact item on the server.  Used by OpenLX().  If any

method which locks a contact item leaves thenccnt this method is called as the

cleanup stack unwinds, removing the lock for the last locked contact item.

@capability None

*/

void CleanupUnlockRecord(TAny *aSession)

	{

	static_cast<RCntModel*>(aSession)->UnlockLastLockedContact();

	}

/**

Unlock the last locked contact item on the server.  Used by OpenLX().

@capability None

*/

void RCntModel::UnlockLastLockedContact()

	{

	CloseContact(KNullContactId);

	}

/**

Push a Contact item unlock cleanup item on the cleanup stack.

*/

void RCntModel::PushUnlockL() const

	{

	CleanupStack::PushL( TCleanupItem(CleanupUnlockRecord, const_cast<RCntModel *>(this)));

	}

/**

RCntModel constructor.

Member variables must be initialised (zero'd) in the constructor since

RCntModel does not derive from CBase.

*/

RCntModel::RCntModel()

	:

	iDbNotifyMonitor(NULL), 

	iPackager(NULL),

	iConnectionId(0),

	iNoOfSvrStartAttempts(0)

	{

	}

/**

Get the Contacts server version number.

@return Contacts server version number.

*/

TVersion RCntModel::Version() const

	{

	return(TVersion(KCntServerMajorVersionNumber,KCntServerMinorVersionNumber,KCntServerBuildVersionNumber));

	}

/** Name of the executable for the Contacts server. */

_LIT(KCntServerExe,"CNTSRV.EXE");

/** Name used to connect a session to the Contacts server. */

_LIT(KCntServerName,"CNTSRV");

/**

Open a Contacts server session.

*/

void RCntModel::ConnectL()

	{

	// Assume the server is already running and attempt to create a session

	// with a maximum of KAsyncMessageSlots message slots.

	TInt err = CreateSession(KCntServerName,Version(),KAsyncMessageSlots);

	if(err == KErrNotFound) // Server not running?

		{

		// Use the RProcess API to start the server.

		RProcess server;

		User::LeaveIfError(server.Create(KCntServerExe,KNullDesC));

		//Enforce server to be at system default priority EPriorityForeground

		//Contact server used to set as EPriorityHigh and this caused client could

		//not get control or responsive until sorting by the idle sorter in remote 

		//view was done.

		server.SetPriority(EPriorityForeground);

		// Synchronise with the server.

		TRequestStatus reqStatus;

		server.Rendezvous(reqStatus);

		server.Resume();

		// Server will call the reciprocal static synchronisation call.

		User::WaitForRequest(reqStatus);

		server.Close();

		User::LeaveIfError(reqStatus.Int());

		// Create the server session.

		User::LeaveIfError(CreateSession(KCntServerName,Version(),KAsyncMessageSlots));

		}

	else

		{

		User::LeaveIfError(err);

		}

	// Create object packer/unpacker if it doesn't already exist.

	if (iPackager == NULL)	

		{

		iPackager = CCntPackager::NewL();

		}

	// Each session (client) will be given a unique ID known as the Connection

	// ID.  This ID forms part of the database event notification message.  This

	// ID is created during the connection to the server.

	ConnectionId();

	}

/**

Close session.

*/

void RCntModel::Close()

	{

	delete iPackager;

	iPackager = NULL;

	delete iDbNotifyMonitor;

	iDbNotifyMonitor = NULL;

	RHandleBase::Close();

	}

/**

Open a named contact database.

Opens the default contacts database if the default argument is used.  The given

descriptor must not contain more than KCntMaxFilePath characters.

@param aCntFile Filename (in the form drive:database).  Defaults to

KCntDefaultDrive.

@return KErrNone if success, KErrArgument if the given descriptor contains more than the 

        maximum length of 190 characters, otherwise one of the System error codes.

@capability ReadUserData

*/

TInt RCntModel::OpenDatabase(const TDesC& aCntFile) const

    {

    TInt err = SetFileName(aCntFile);

    if (err == KErrNone)

        {

        TIpcArgs args;

        args.Set(0,&aCntFile);

        err = SendReceive(ECntOpenDataBase, args);

        }

    return err;

    }

/**

Open a named contact database asynchronously.

Opens the default contacts database if the default argument is used.  The given

descriptor must not contain more than KCntMaxFilePath characters.

@param aStatus Asynchronous request object.  Request is completed when database

has been opened.

@param aCntFile Contacts database filename (in the form drive:database).

Defaults to KCntDefaultDrive.

@capability ReadUserData

*/

void RCntModel::OpenDatabaseAsyncL(TRequestStatus& aStatus, const TDesC& aCntFile)

    {

    User::LeaveIfError(SetFileName(aCntFile));

    TIpcArgs args;

    args.Set(0,&aCntFile);

    SendReceive(ECntOpenDataBase, args, aStatus);

    }

/**

Cancel last asynchronous database open request.

@capability None

*/

void RCntModel::CancelAsyncOpen() 

	{

	SendReceive(ECntCancelAsyncOpenDatabase);		

	}

/**

Handle a premature termination of the contact server process by re-connecting

the session and re-opening the database.

@capability ReadUserData

*/

void RCntModel::HandlePrematureServerTerminationL()

	{

	if (iNoOfSvrStartAttempts > KMaxTimesToRestartServer)

		{

		User::Leave(KErrServerTerminated);

		}

	ConnectL();

	User::LeaveIfError(OpenDatabase(iFileName));

	++iNoOfSvrStartAttempts;

	}

/**

Set the database filename. Used to re-open the database if the server is

terminated prematurely.

@param aCntFile Contacts database filename (in the form drive:database).

@return KErrNone if success, KErrArgument if the given descriptor contains more than the 

        maximum length of 190 characters.         

*/

TInt RCntModel::SetFileName(const TDesC& aCntFile) const

    {

    if(aCntFile.Length() > KCntMaxFilePath)

        {

        return KErrArgument;

        }

    iFileName = aCntFile;

    return KErrNone;

    }

/**

Close currently open database.

@capability None

*/

void RCntModel::CloseDatabase() const

	{

	(void)SendReceive(ECntCloseDataBase);

	}

/**

Get the machine ID. 

Note: This function can leave.

@return Machine ID.

@leave KErrNone The send operation is successful

@leave KErrServerTerminated The server no longer present

@leave KErrServerBusy There are no message slots available

@leave KErrNoMemory There is insufficient memory available

@capability None

*/

TInt64 RCntModel::MachineId() const

	{

	TIpcArgs args;

	TPckgBuf<TInt64> machineID;

	args.Set(0, &machineID);

	User::LeaveIfError(SendReceive(ECntMachineID, args)); // this can leave

	return machineID();	

	}

/**

Set the machine ID (debug only).

@param aMachineUniqueId New machine ID.

@capability None

*/

void RCntModel::OverrideMachineUniqueId(TInt64 aMachineUniqueId)

	{

	TIpcArgs args;

	TPckgBuf<TInt64> machineID(aMachineUniqueId);

	args.Set(0, &machineID);

	(void)SendReceive(ECntOverrideMachineID, args);	

	}

/**

Replace a named contact database with an empty one, replacing any database with

the same name.  Replaces the default contacts database if the default argument

is used.  The given descriptor must not contain more than KCntMaxFilePath

characters.

@param aCntFile Contacts database filename (in the form drive:database).

Defaults to KCntDefaultDrive.

@return KErrNone if success, KErrArgument if the given descriptor contains more than the 

        maximum length of 190 characters, KErrInUse if the database is currently open, 

        otherwise one of the System error codes.

@capability WriteUserData

*/

TInt RCntModel::ReplaceDatabase(const TDesC& aCntFile) const

    {

    TInt err = SetFileName(aCntFile);

    if (err == KErrNone)

        {

        TIpcArgs args;

        args.Set(0,&aCntFile);

        err = SendReceive(ECntReplaceDatabase, args);

        }

    return err;

    }

/**

Returns an array of contact item IDs for all the contact items which may contain

the specified telephone number in a telephone, fax or SMS type field.

@see CContactDatabase::MatchPhoneNumberL() for more details on the match.

@param aNumber Phone number string

@param aMatchLengthFromRight Number of digits from the right of the phone number

to use.  Up to 15 digits can be specified and it is recommended that at least 7

match digits are specified.

@return CContactIdArray of candidate matches.

@capability ReadUserData

*/

CContactIdArray* RCntModel::MatchPhoneNumberL(const TDesC& aNumber, const TInt aMatchLengthFromRight)

	{

	TIpcArgs args;

	args.Set(0, &iPackager->GetReceivingBufferL());

	args.Set(1, MLplCollection::EMatchPhoneNos);

	args.Set(2, &aNumber);

	args.Set(3, aMatchLengthFromRight);

	TInt newBuffSize = 0;

	User::LeaveIfError(newBuffSize = SendReceive(ECntGetCollection, args));

	if (newBuffSize > 0)

		{

		// If the buffer is not large enough resize the packager's internal

		// buffer and make the call again.

		args.Set(0, &iPackager->GetReceivingBufferL(newBuffSize));

		User::LeaveIfError(newBuffSize = SendReceive(ECntGetCollection, args));		

		}

	CContactIdArray* idArray = iPackager->UnpackCntIdArrayLC();	

	CleanupStack::Pop(idArray);

	return idArray;

	}

/**

Create an empty named contact database.

Creates the default contacts database if the default argument is used.  The

given descriptor must not contain more than KCntMaxFilePath characters.

@param aCntFile Contacts database filename (in the form drive:database).

Defaults to KCntDefaultDrive.

@return KErrNone if success, KErrArgument if the given descriptor contains more than the 

        maximum length of 190 characters, KErrAlreadyExists if the database already 

        exists otherwise one of the System error codes.

@capability WriteUserData

*/

TInt RCntModel::CreateDatabase(const TDesC& aCntFile) const

    {

    TInt err = SetFileName(aCntFile);

    if (err == KErrNone)

        {

        TIpcArgs args;

        args.Set(0,&aCntFile);

        err = SendReceive(ECntCreateDatabase, args);

        }

    return err;

    }

/**

Create the system template.

@return KErrNone if success otherwise one of the System error codes.

@capability WriteUserData

*/

TInt RCntModel::ReCreateTemplate() const

	{

	return SendReceive(ECntReCreateTemplate);

	}

/**

Get the database file UID.

@return Pointer to file UID.

@capability None

*/

TPtrC RCntModel::FileUidL() const

	{

	TIpcArgs args;

	args.Set(0, &iFileUid);

	User::LeaveIfError (SendReceive(ECntFileUniqueId, args));

    return iFileUid;

	}

/**

Determine if the database is ready.  Ready in this context means that the

database is open and readable/writable (i.e. the state machine is in

CStateWritable).

@capability None

@return ETrue if the database is ready, EFalse if the database is not ready.

*/

TBool RCntModel::DatabaseReadyL() const

    {

    TBool retVal = EFalse;

    // Although the ECntGetDatabaseReady msg. is completed with TBool values,

    // during message processing, it is possible that ServiceError() occurs,

    // causing the message to be completed with negative error codes.

    // LeaveIfError() would protect against such cases.

    User::LeaveIfError(retVal = SendReceive(ECntGetDatabaseReady));

    return retVal;

    }

/**

Tests whether a contact item's hint bit field matches a filter.

@param aBitWiseFilter The filter to compare the item against.  This is a

combination of TContactViewFilter values.

@param aContactId The ID of the item in the database.

@return ETrue if the item is of the correct type for inclusion in the database 

and its hint bit field matches the specified filter, EFalse if either of these

conditions are not met.

@capability None

*/

TBool RCntModel::ContactMatchesHintFieldL(TInt aBitWiseFilter, TContactItemId aContactId)

    {

    TIpcArgs args;

    args.Set(0, aBitWiseFilter);

    args.Set(1, aContactId);

    TBool retVal = EFalse;

    // Although the ECntMatchesHintField msg. is completed with TBool values,

    // during message processing, it is possible that ServiceError() occurs,

    // causing the message to be completed with negative error codes.

    // LeaveIfError() would protect against such cases.

    User::LeaveIfError (retVal = SendReceive(ECntMatchesHintField, args));

    return retVal;

    }

/**

Delete a named contact database.

Deletes the default contacts database if the default argument is used.  The

given descriptor must not contain more than KCntMaxFilePath characters.

@param aCntFile Contacts database filename (in the form drive:database).

Defaults to KCntDefaultDrive.

@return KErrNone if success, KErrArgument if the given descriptor contains more 

        than the maximum length of 190 characters, KErrInUse if the database is 

        in use, KErrNotFound if the database does not exist otherwise one of the 

        System error codes.