/*

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

*

*/

#include <cntitem.h>

#include <f32file.h>

#include <cntfldst.h>   //for ccontactfieldstorage used in setfieldasspeeddiall

#include <phbksync.h>

#include <cntdb.h>

#include "cntstd.h"

#include "rcntmodel.h"

#include "ccontactprivate.h"

#include "clplproxyfactory.h"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include "cntdb_internal.h"

#include "cntsyncecom.h"

const TInt KMajorVersion=1;

const TInt KMinorVersion=0;

const TInt KBuildNumber=40;

#endif

CContactDatabase::CContactDatabase():

		iDbConnectionState(EDbConnectionNotReady),

		iTablesOpen(EFalse),

		iDbViewContactType(KUidContactItem),

		iContactSynchroniser(NULL)

	{

	// Needed to ensure unicode sorting / inserting into sorted lists works the

	// same as er5 i.e. that it encludes all spaces and punctuation.

	iCollateMethod = *Mem::CollationMethodByIndex(0);

	iCollateMethod.iFlags|=TCollationMethod::EIgnoreNone;

	}

/**

Frees all resources owned by the contact database, prior to its destruction.

*/

EXPORT_C CContactDatabase::~CContactDatabase()

	{

	delete iConv;

	delete iProxyFactory;

	delete iView;

	delete iAllFieldsView;

	delete iCardTemplateIds;

	delete iGroupIds;

	delete iTemplateCache;

	delete iTextDef;

	if (iCntSvr)

		{

		iCntSvr->RemoveObserver(*iDataBaseObserver);

		iCntSvr->Close();

		}

	if (iContactSynchroniser)

		{

		iContactSynchroniser->Release();

		iContactSynchroniser = NULL;

		}

	delete iDataBaseObserver;

	delete iCntSvr;

	delete iIdleSorter;

	delete iSortedItems;

	delete iSortOrder;

	REComSession::FinalClose();

	}

/**

Create a new CContactDatabase object 

*/

CContactDatabase* CContactDatabase::NewLC()

	{

	CContactDatabase* db =new(ELeave) CContactDatabase();

	CleanupStack::PushL(db);

	db->ConstructL();

	return db;

	}

void CContactDatabase::ConstructL()

	{

	iCntSvr = new (ELeave) RCntModel;

	iCntSvr->ConnectL();

	iProxyFactory = CProxyFactory::NewL(*this);

	CreateViewDefL();

	iTemplateCache = CCntTemplateCache::NewL(*iCntSvr);

	iDataBaseObserver = CDataBaseChangeObserver::NewL(*this);

	iCntSvr->AddObserverL(*iDataBaseObserver);

	iIdleSorter = CCntIdleSorter::NewL(*this);

	}

void CContactDatabase::CreateViewDefL()

	{

	// The exact same object is created in the Session on the server. If

	// it is changed here it must also be changed in the server code.

	CContactItemViewDef* itemDef = CContactItemViewDef::NewLC(CContactItemViewDef::EIncludeFields,CContactItemViewDef::EMaskHiddenFields);

	itemDef->AddL(KUidContactFieldMatchAll);

	iView = CContactViewDef::NewL(itemDef);

	CleanupStack::Pop(itemDef);

	// iAllFieldView is not created on the server code - an exported getter method

	// allows the user to modify this member and so it cannot be mirrored on the

	// server

	iAllFieldsView = CContactItemViewDef::NewL(CContactItemViewDef::EMaskFields,CContactItemViewDef::EIncludeHiddenFields);

	}

/**

For BC.

@internalComponent

*/

EXPORT_C CContactDatabase* CContactDatabase::LockServerConnectL(const TDesC& /*aFileName*/)

	{

	return NULL;

	}

/**

For BC.

@internalComponent

*/

EXPORT_C CContactDatabase* CContactDatabase::LockServerConnectL(const TDesC& /*aFileName*/, TInt /*aOperation*/)

	{

	return NULL;

	}

/**

For BC.

@internalComponent

*/

EXPORT_C TInt CContactDatabase::LockServerCallBackL(TUint /*aServerOperation*/)

	{

	return NULL;

	}

/**

For BC.

@internalComponent

*/

EXPORT_C void CContactDatabase::LockServerCleanup()

	{

	}

/**

Gets the file name of the default contact database.

By default it is on drive C: but this can be changed using SetDatabaseDriveL().

@capability None

@param aDes On return, contains the drive and filename of the default 

contact database. From v9.0 onwards, this has the form driveletter:filename, 

in other words, it does not include a path.

@see CContactDatabase::SetDatabaseDriveL()

@see CContactDatabase::DatabaseDrive()

@see CContactDatabase::DefaultContactDatabaseExistsL()

*/

EXPORT_C void CContactDatabase::GetDefaultNameL(TDes& aDes)

	{

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->DefaultDatabase(aDes));

	CleanupStack::PopAndDestroy(db);	

	}

/**

Deletes the default contact database.

@capability WriteUserData

@leave	KErrInUse Another client has the database open.

@leave	KErrNotFound The database file was not found or it did not have the correct UIDs.

@see CContactDatabase::DeleteDatabaseL()

@see CContactDatabase::GetDefaultNameL()

@see CContactDatabase::DefaultContactDatabaseExistsL()

*/

EXPORT_C void CContactDatabase::DeleteDefaultFileL()

	{

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->DeleteDatabase(KNullDesC));

	CleanupStack::PopAndDestroy(db);

	}

/**

Gets the current database drive. The database drive is the drive on which 

the default contact database is located. Note: this function can leave.

@capability None

@param aDriveUnit On return, contains the database drive.

@return ETrue if the database drive has been set using SetDatabaseDriveL(). 

Otherwise EFalse and in this case, the function returns drive c: in aDriveUnit 

as the current drive.

@leave KErrNoMemory Out of memory.

@see CContactDatabase::SetDatabaseDrive()

@see CContactDatabase::GetDefaultNameL()

*/

EXPORT_C TBool CContactDatabase::DatabaseDrive(TDriveUnit& aDriveUnit)

	{

	CContactDatabase* db = NewLC(); // this can leave

	TBool ret = db->iCntSvr->DatabaseDrive(aDriveUnit);

	CleanupStack::PopAndDestroy(db);

	return ret;

	}

/**

Sets the contact database drive and optionally moves the default contact database 

from its current location to the new drive. This function guarantees an all 

or nothing operation. If the database is not successfully moved, the drive 

setting is not updated to reflect the change.

In v8.1 when copying the file is moved to \\system\\data on the specified 

drive, and if the destination file already exists it is replaced.

From v9.0 onwards the file copying goes to the correct data caged directory

on the destination drive. If the destination file already exists the copy 

fails.

@capability WriteUserData

@param	aDriveUnit

		The drive to which to move the database.

@param	aCopy

		ETrue moves the existing file to the specified drive. Deletion of

		the source file will fail if it is in use.

		EFalse does not move the file.

@leave KErrNotReady There is no media present in the drive.

@leave KErrInUse The destination file for the copy is already open.

@leave KErrNotFound The source file for the copy was not found.

@leave KErrAlreadyExists The destination file for the copy already exists, (v9.0).

@see CContactdatabase::DatabaseDrive()

@see CContactDatabase::GetDefaultNameL()

@see CContactDatabase::DefaultContactDatabaseExistsL()

*/

EXPORT_C void CContactDatabase::SetDatabaseDriveL(TDriveUnit aDriveUnit, TBool aCopy)

	{

	CContactDatabase* db = NewLC();

	db->iCntSvr->SetDatabaseDriveL(aDriveUnit, aCopy);

	CleanupStack::PopAndDestroy(db); 

	}

/**

Opens the default contact database.

Note: clients should not assume any knowledge of the default database name or location 

because they may be changed in future releases.

@capability ReadUserData

@param  aAccess The default (ESingleThread) allows access to the session with the 

database server from a single client thread only (as in v5 and v5.1). EMultiThread 

allows multiple client threads to share the same session with the server. As 

multi-threaded programs are uncommon in Symbian OS, this argument can be ignored 

by most C++ developers

@return Pointer to the open contact database. 

@leave	KErrNotFound The database file was not found or it did not have the correct UIDs.

@leave	KErrLocked Another client is writing to the database. 

@leave	KErrDiskFull The disk does not have enough free space to perform the operation.

*/

EXPORT_C CContactDatabase* CContactDatabase::OpenL(TThreadAccess aAccess)

	{

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->OpenDatabase(KNullDesC));

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	db->FetchGroupAndTemplateListsL();

	CleanupStack::Pop(db);

	return db;

	}

EXPORT_C CContactDatabase* CContactDatabase::OpenV2L(TThreadAccess aAccess)

	{

    CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->OpenDatabase(KNullDesC));

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	CleanupStack::Pop(db);

	return db;

	}

/**

Opens a named contact database.

From v9.0 onwards, contact databases can only be located in the correct data caged 

subdirectory. The filenames must have no path, for example c:contacts.cdb.

The maximum length for the drive, filename and extension is 190 characters, and empty

string is not accepted.

@capability ReadUserData

@param	aFileName The filename of the database to open.

@param  aAccess The default (ESingleThread) allows access to the session with the 

database server from a single client thread only (as in v5 and v5.1). EMultiThread 

allows multiple client threads to share the same session with the server. As 

multi-threaded programs are uncommon in Symbian OS, this argument can be ignored 

by most C++ developers

@leave	KErrNotFound The database file was not found or it did not have the correct UIDs.

@leave	KErrLocked Another client is writing to the database.

@leave	KErrBadName The filename is invalid; for example it contains 

wildcard characters or the drive is missing.

@leave	KErrDiskFull The disk does not have enough free space to perform the operation.

@leave  KErrArgument if the given descriptor contains more than the maximum length 

        of 190 characters.

@return A pointer to the open contact database.

*/

EXPORT_C CContactDatabase* CContactDatabase::OpenL(const TDesC& aFileName, TThreadAccess aAccess)

	{

	__ASSERT_ALWAYS(aFileName.Length() != 0, User::Leave(KErrBadName) );

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->OpenDatabase(aFileName));

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	db->FetchGroupAndTemplateListsL();

	CleanupStack::Pop(db);

	return db;

	}

/** 

Creates and opens an empty contact database, replacing the existing default 

database. 

@capability WriteUserData

@param  aAccess The default (ESingleThread) allows access to the session with the 

database server from a single client thread only (as in v5 and v5.1). EMultiThread 

allows multiple client threads to share the same session with the server. As 

multi-threaded programs are uncommon in Symbian OS, this argument can be ignored 

by most C++ developers

@return Pointer to the new contact database.

@leave	KErrInUse Another client has an open connection to the database.

@leave	KErrDiskFull The disk does not have enough free space to perform the operation.

@leave	KErrNoMemory There is no memory to perform the operation.

*/

EXPORT_C CContactDatabase* CContactDatabase::ReplaceL(TThreadAccess aAccess)

	{

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->ReplaceDatabase(KNullDesC));

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	db->FetchGroupAndTemplateListsL();

	CleanupStack::Pop(db);

	return db;

	}

/**

Creates and opens an empty contact database, replacing any existing file with 

the same name.

From v9.0 onwards, contact databases can only be located in the correct data caged 

subdirectory. The filenames must have no path, for example c:contacts.cdb.

The maximum length for the drive, filename and extension is 190 characters.

@capability WriteUserData

@param	aFileName The filename of the database to replace.

@param  aAccess The default (ESingleThread) allows access to the session with the 

database server from a single client thread only (as in v5 and v5.1). EMultiThread 

allows multiple client threads to share the same session with the server. As 

multi-threaded programs are uncommon in Symbian OS, this argument can be ignored 

by most C++ developers

@leave	KErrBadName The filename is invalid; for example it contains wildcard characters 

or the drive letter is missing.

@leave	KErrInUse Another client has an open connection to the database.

@leave	KErrDiskFull The disk does not have enough free space to perform the operation.

@leave	KErrNoMemory There is no memory to perform the operation.

@leave  KErrArgument if the given descriptor contains more than the maximum length 

        of 190 characters.

@return A pointer to the new contact database.

*/				

EXPORT_C CContactDatabase* CContactDatabase::ReplaceL(const TDesC& aFileName, TThreadAccess aAccess)

	{

	__ASSERT_ALWAYS(aFileName.Length() != 0, User::Leave(KErrBadName) );

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->ReplaceDatabase(aFileName)); 

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	db->FetchGroupAndTemplateListsL();

	CleanupStack::Pop(db);

	return db;

	}

/** 

Creates and opens an empty contact database using the default database name. 

@capability WriteUserData

@param  aAccess The default (ESingleThread) allows access to the session with the 

database server from a single client thread only (as in v5 and v5.1). EMultiThread 

allows multiple client threads to share the same session with the server. As 

multi-threaded programs are uncommon in Symbian OS, this argument can be ignored 

by most C++ developers

@return A pointer to the new contact database. 

@leave	KErrAlreadyExists The database already exists.

@leave	KErrDiskFull The disk does not have enough free space to perform the operation.

*/

EXPORT_C CContactDatabase* CContactDatabase::CreateL(TThreadAccess aAccess)

	{

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->CreateDatabase(KNullDesC)); 

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	db->FetchGroupAndTemplateListsL();

	CleanupStack::Pop  (db);

	return db;	

	}

EXPORT_C CContactDatabase* CContactDatabase::CreateV2L(TThreadAccess aAccess)

	{

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->CreateDatabase(KNullDesC)); 

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	CleanupStack::Pop  (db);

	return db;	

	}

/**

Creates and opens a named contact database. 

From v9.0 onwards, contact databases can only be located in the correct data caged 

subdirectory. The filenames must have no path, for example c:contacts.cdb.

The maximum length for the drive, filename and extension is 190 characters.

@capability WriteUserData

@param	aFileName The filename of the database to create. 

@param  aAccess The default (ESingleThread) allows access to the session with the 

database server from a single client thread only (as in v5 and v5.1). EMultiThread 

allows multiple client threads to share the same session with the server. As 

multi-threaded programs are uncommon in Symbian OS, this argument can be ignored 

by most C++ developers

@leave	KErrAlreadyExists The database already exists. 

@leave	KErrBadName The filename is invalid; for example it contains wildcard characters 

or the drive letter is missing.

@leave	KErrDiskFull The disk does not have enough free space to perform the operation.

@leave  KErrArgument if the given descriptor contains more than the maximum length 

        of 190 characters.

@return A pointer to the new contact database.

*/

EXPORT_C CContactDatabase* CContactDatabase::CreateL(const TDesC& aFileName,TThreadAccess aAccess)

	{

	__ASSERT_ALWAYS(aFileName.Length() != 0, User::Leave(KErrBadName) );

	CContactDatabase* db = NewLC();

	User::LeaveIfError(db->iCntSvr->CreateDatabase(aFileName)); 

	if( aAccess == EMultiThread )

		{

		db->iCntSvr->ShareAuto();

		} 

	db->FetchGroupAndTemplateListsL();

	CleanupStack::Pop  (db);

	return db;	

	}

/**

This method is no longer required and should not be called.

Closes all database tables. After a rollback and recover all tables need to 

be closed and re-opened before the database can be accessed again.

@capability WriteUserData

@deprecated