/**

 @file

 @internalComponent

 @released

*/

#include "persistencelayerimpl.h"

#include "clplcontactproperties.h"

#include <cntfilt.h>

#include "cntsqlprovider.h"

#include "dbsqlconstants.h"

#include "cntpersistenceutility.h"

#include <sqldb.h>

//

// The TFindFieldFlags enumeration is duplicated in cviewiterator.h.  It should

// be refactored into a shared header if possible.

//

enum TFindFieldFlags

	{

	EFindInAllFields				=0x00000001,

	EFindFirstName					=0x00000002,

	EFindLastName					=0x00000004,

	EFindCompanyName				=0x00000008,

	EFindInEmailField				=0x00000010,

	EFindInAnyIdentityField			=0x00000020,

	EFindFirstNamePronunciation		=0x00000040,

	EFindLastNamePronunciation		=0x00000080,

	EFindCompanyNamePronunciation	=0x00000100,

	EFindInSIPField					=0x00000200

	};

// Maximum number of find iterations to perform in the CPlCollection::FindL()

// method before returning.

const TInt KFindIterations = 16;

// These flags must be in the same order as the corresponding fields in

// RPplIdentityTable::TIdentityField.

const TFindFieldFlags KNameFlags[] = 

	{

	EFindFirstName,

	EFindLastName,

	EFindCompanyName,

	EFindFirstNamePronunciation,

	EFindLastNamePronunciation,

	EFindCompanyNamePronunciation

	};

// Collation level that ignore accents (i.e. 'a' == 'ä').

const TInt KCollationLevel= 0;

//

// The TKeyCmpTextLength class is duplicated in ccontactprivate.cpp.  It should

// be refactored into shared code/library if possible.

//

NONSHARABLE_CLASS(TKeyCmpTextLength) : public TKeyArrayFix

	{

public:

	TKeyCmpTextLength();

protected:

	// From TKey.

	virtual TInt Compare(TInt aLeft,TInt aRight) const;

	};

TKeyCmpTextLength::TKeyCmpTextLength()

	// Doesn't matter using ECmpNormal, it's ignored.

	:

	TKeyArrayFix(0,ECmpNormal,0)

	{

	}

/**

Compare the lengths of the words.

*/

TInt TKeyCmpTextLength::Compare(TInt aLeft,TInt aRight) const

	{

	TDesC* left=(*((TDesC**)At(aLeft)));

	TDesC* right=(*((TDesC**)At(aRight)));

	return right->Length()-left->Length();

	}

/**

Used as a cleanup item for buffer allocation in CreateFindTextL().

@param aHBufC The buffer to be cleaned up (deleted).

*/

GLDEF_C void DestroyHBufC(TAny* aHBufC)

	{

	delete *STATIC_CAST(HBufC**, aHBufC);

	}

/**

Create the "find text", used for the SQL query on the view, from the given text.

@param aText Text to turn into "find text".

@return "Find text" form of the given text.

*/

HBufC* CreateFindTextL(const TDesC& aText)

	{

	_LIT(KApostrophe, "'");

	TInt location = aText.Find(KApostrophe);

	HBufC* buf=HBufC::NewL(aText.Length()+2);

	TPtr ptr=buf->Des();

	ptr.Zero();

	ptr.Append('%');

	ptr += aText;

	ptr.Append('%');

	// Insert additional apostrophes if required.  This is so the SQL search

	// string behaves correctly.

	if(location != KErrNotFound)

		{

		CleanupStack::PushL(buf);

		TPtrC rightBuf = *buf;		

		HBufC* leftBuf=HBufC::NewL(0);

		CleanupStack::PushL(TCleanupItem(DestroyHBufC, &leftBuf));

		// Increment location because we have added the * character.

		location++;

		while (location != KErrNotFound)

			{

			// Copy left hand string up to the first apostrophe into a new

			// buffer and append an apostrophe.

			leftBuf = leftBuf->ReAllocL(leftBuf->Length()+location+2); 

			TPtr ptrLeftBuf = leftBuf->Des();

			ptrLeftBuf.Append(rightBuf.Left(location+1));

			ptrLeftBuf += (KApostrophe);

			// Make a copy of the right hand part.

			TInt rightLength = rightBuf.Length()-location-1;

			rightBuf.Set(rightBuf.Right(rightLength));

			// Search for another apostrophe.

			location = rightBuf.Find(KApostrophe);

			}

		// Now append the rest of the right hand part.

		leftBuf = leftBuf->ReAllocL(leftBuf->Length()+rightBuf.Length()); 

		TPtr ptrLeftBuf = leftBuf->Des();

		ptrLeftBuf.Append(rightBuf);

		CleanupStack::Pop(&leftBuf);	

		CleanupStack::PopAndDestroy(buf);

		return (leftBuf);

		}	

	return (buf);	

	}

/**

For the given field type UID, increase aIdentityColumnsCount if the field maps

to one of the columns in the Identity table and add the relevant find flag.

@param aUid Field type UID.

@param aFindFlags Updated with find flag which maps to the given field type UID.

@param aIdentityColumnsCount Incremented if the field type UID maps to a column

in the Identity table.

*/

//

// This method is duplicated in cviewiterator.cpp.  It should be refactored into

// shared code/library if possible.

//

void SetFindFlagsAndColumnsCount(TInt32 aUid,TInt& aFindFlags,TInt& aIdentityColumnsCount)

	{

	switch(aUid)

		{

		case KUidContactFieldGivenNameValue:

			{

			++aIdentityColumnsCount;

			aFindFlags |= EFindFirstName;

			break;

			}

		case KUidContactFieldFamilyNameValue:

			{

			++aIdentityColumnsCount;

			aFindFlags |= EFindLastName;

			break;

			}

		case KUidContactFieldCompanyNameValue:

			{

			++aIdentityColumnsCount;

			aFindFlags |= EFindCompanyName;

			break;

			}

		case KUidContactFieldGivenNamePronunciationValue:

			{

			++aIdentityColumnsCount;

			aFindFlags |= EFindFirstNamePronunciation;

			break;

			}

		case KUidContactFieldFamilyNamePronunciationValue:

			{

			++aIdentityColumnsCount;

			aFindFlags |= EFindLastNamePronunciation;

			break;

			}

		case KUidContactFieldCompanyNamePronunciationValue:

			{

			++aIdentityColumnsCount;

			aFindFlags |= EFindCompanyNamePronunciation;

			break;

			}

		case KUidContactFieldEMailValue:

			{

			aFindFlags |= EFindInEmailField;

			break;

			}

		case KUidContactFieldSIPIDValue:

			{

			aFindFlags |= EFindInSIPField;

			break;			

			}

		case KUidContactFieldMatchAllValue:

			{

			//added to address issues raised in INC049017

			//needed as a seperate case instead of modifying the default value because Identitys should not always be searched

			//if a valid KUid is used. e.g.: KUidContactFieldAddress. If the default value was modified and someone wanted to

			//perform an address search using Elizabeth (as in elizabeth road) contacts of that name would also be found.

			aFindFlags |= EFindInAllFields|EFindInAnyIdentityField;

			break;

			}

		default:

			aFindFlags |= EFindInAllFields;

		}

	}

/**

Determine if the Identity table requires to be searched for the given find

flags.

@param aFindFlags Set of find flags describing which fields will be searched.

@return ETrue If one of the flags in aFindFlags maps to a column in the Identity

table, EFalse otherwise.

*/

//

// This method is duplicated in cviewiterator.cpp.  It should be refactored into

// shared code/library if possible.

//

TBool SearchIdentityFieldsRequired(TInt aFindFlags)

	{

	return aFindFlags &

		( EFindInAnyIdentityField | EFindFirstName | EFindLastName | EFindCompanyName |

			EFindFirstNamePronunciation | EFindLastNamePronunciation | EFindCompanyNamePronunciation);

	}

/**

Determine if only the Identity table requires to be searched for the given find

flags.

@param aFindFlags Set of find flags describing which fields will be searched.

@return ETrue If one of the flags in aFindFlags maps to a column in the Identity

table and no columns in any other table, EFalse otherwise.

*/

//

// This method is duplicated in cviewiterator.cpp.  It should be refactored into

// shared code/library if possible.

//

TBool CPlCollection::UsesIdentityFieldsOnly(TInt aFindFlags)

	{

	return (aFindFlags & (EFindFirstName | EFindLastName | EFindCompanyName |

			EFindFirstNamePronunciation |EFindLastNamePronunciation |EFindCompanyNamePronunciation) ) &&

		! (aFindFlags & (EFindInAllFields | EFindInEmailField | EFindInSIPField) );

	}

/**

Update a set of find flags and an Identity table column count from the field

type UIDs in the given field definition.

@param aFindFlags Updated with those flags which map to the field type UIDs in

aFieldDef.

@param aIdentityColumnsCount Updated with the number of field type UIDs in

aFieldDef which map to columns in the Identity table.

@param aFieldDef Field definition from which to create set of find flags and

Identity table column count.

*/

//

// This method is duplicated in cviewiterator.cpp.  It should be refactored into

// shared code/library if possible.

//

void ConstructBitwiseFindFlags(TInt& aFindFlags,TInt& aIdentityColumnsCount,const CContactItemFieldDef* aFieldDef)

	{

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

		{

		for(TInt ii = 0;ii < aFieldDef->Count();ii++)

			{

			SetFindFlagsAndColumnsCount(aFieldDef->At(ii).iUid,aFindFlags,aIdentityColumnsCount);

			}

		}

	else

		{

		aFindFlags |= EFindInAllFields|EFindInAnyIdentityField;

		}

	}

/**

Update a set of find flags and an Identity table column count from the field

type UIDs in the given text definition.  This can be used to tell the find

method what tables need to be searched for a given text definition.  If the text

definition is NULL we search in all tables.

@param aFindFlags Updated with those flags which map to the field type UIDs in

aTextDef.

@param aIdentityColumnsCount Updated with the number of field type UIDs in

aTextDef which map to columns in the Identity table.

@param aTextDef Text definition from which to create set of find flags and

Identity table column count.

*/

//

// This method is duplicated in cviewiterator.cpp.  It should be refactored into

// shared code/library if possible.

//

void CPlCollection::ConstructBitwiseFlagsFromTextDef(TInt& aFindFlags,TInt& aIdentityColumnsCount,const CContactTextDef* aTextDef)

	{

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

		{

		for(TInt ii = 0;ii < aTextDef->Count();ii++)

			{

			SetFindFlagsAndColumnsCount(aTextDef->At(ii).iFieldType.iUid,aFindFlags,aIdentityColumnsCount);

			}

		TFieldType fallback = aTextDef->FallbackField();

		if (fallback != KUidContactFieldNone)

		SetFindFlagsAndColumnsCount(fallback.iUid,aFindFlags,aIdentityColumnsCount);

		}

	else

		{

		aFindFlags |= EFindInAllFields|EFindInAnyIdentityField;

		}

	}

/**

Utility method used to search a contact id in contact database.

@param aReqId requested contact id to look for

@param aId out parameter; will be filled with the actual found contact item id 

@param aContactType specifies contact type to be search

@param aDeleted set to ETrue if a search through deleted contacts is required

@return ETrue if a contact item with contact id greater or equal with aReqId exists in contact database

		EFalse otherwise

*/

TBool CPlCollection::SeekContactL(TContactItemId aReqId,TContactItemId& aId,TUid& aContactType, TBool& aDeleted)

	{

	TBool ret = ETrue;

	HBufC* selectString = HBufC::NewLC(KSelectTwoFieldsWithGreater().Length() + 

									KContactId().Length() + 

									KContactTypeFlags().Length() + 

									KSqlContactTableName().Length() + 					

									KContactId().Length() + 3); 

	TPtr ptrSelectString = selectString->Des();

	ptrSelectString.Format(KSelectTwoFieldsWithGreater, &KContactId, &KContactTypeFlags, &KSqlContactTableName, &KContactId, aReqId);

	RSqlStatement selectStatement;

	CleanupClosePushL(selectStatement);

	User::LeaveIfError(selectStatement.Prepare(iContactsFile.NamedDatabase(), ptrSelectString));

	const TInt idIndex = selectStatement.ColumnIndex(KContactId);

	User::LeaveIfError(idIndex);

	const TInt typeIndex = selectStatement.ColumnIndex(KContactTypeFlags);

	User::LeaveIfError(typeIndex);

	TInt err;

	if((err = selectStatement.Next()) == KSqlAtRow) 

		{

		aId = selectStatement.ColumnInt(idIndex);

		TInt typeFlags = selectStatement.ColumnInt(typeIndex);

		aContactType = TCntPersistenceUtility::TypeFlagsToContactTypeUid(typeFlags); 

		TInt attr = (typeFlags & EContactAttributes_Mask) >> EContactAttributes_Shift; 

		aDeleted = (attr == EContactAttrsFlags_Deleted);

		}

	else 

		{

		User::LeaveIfError(err);

		ret = EFalse;	

		}

	CleanupStack::PopAndDestroy(2, selectString); //selectStatement, selectString	

	return ret;

	}

/**

CPlCollection constructor.

@param aContactsFile Contacts file object from the Persistence Layer.

*/

CPlCollection::CPlCollection(CPplContactsFile& aContactsFile)

	: 

	iContactsFile(aContactsFile)

	{

	}

/**

CPlCollection ConstructL

*/	

void CPlCollection::ConstructL()

	{

	TCntSqlStatementType statementType(ESelect, KSqlContactTableName);

	iSelectStatement = TSqlProvider::GetSqlStatementL(statementType);

	}

/**

CPlCollection NewL

*/		

CPlCollection* CPlCollection::NewL(CPplContactsFile& aContactsFile)

	{

	CPlCollection* self = new (ELeave) CPlCollection(aContactsFile);

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop(self);

	return self;

	}

/**

CPlCollection destructor.

*/

CPlCollection::~CPlCollection()

	{

	Reset();

	delete iSelectStatement;

	iSelectStatement = NULL;

	}

/**

Get the count of contacts in the Contacts table.

@return Count of contacts in the Contacts table.

*/

TInt CPlCollection::ContactCountL()

	{

	TInt count = 0;

	//count contact cards

	HBufC* selectString = HBufC::NewLC(KCountTypeSelect().Length() + 

						KSqlContactTableName().Length() + KContactTypeFlags().Length() + KContactTypeFlags().Length() + 6); 

	TPtr ptrSelectString = selectString->Des();

	ptrSelectString.Format(KCountTypeSelect, &KSqlContactTableName, &KContactTypeFlags, EContactType_Shift, EContactTypeFlags_ContactCard,

							&KContactTypeFlags, EContactAttributes_Shift, EContactAttrsFlags_Deleted);

	TSqlScalarFullSelectQuery scalarQuery(iContactsFile.NamedDatabase());

	count = scalarQuery.SelectIntL(ptrSelectString);

	CleanupStack::PopAndDestroy(selectString);

	//count own card

	selectString = HBufC::NewLC(KCountTypeSelect().Length() + 

				KSqlContactTableName().Length() + KContactTypeFlags().Length() + KContactTypeFlags().Length() + 6); 

	ptrSelectString = selectString->Des();

	ptrSelectString.Format(KCountTypeSelect, &KSqlContactTableName, &KContactTypeFlags, EContactType_Shift, EContactTypeFlags_OwnCard,

							&KContactTypeFlags, EContactAttributes_Shift, EContactAttrsFlags_Deleted);

	count += scalarQuery.SelectIntL(ptrSelectString);

	CleanupStack::PopAndDestroy(selectString);

	//count groups

	selectString = HBufC::NewLC(KCountTypeSelect().Length() + 

				KSqlContactTableName().Length() + KContactTypeFlags().Length() + KContactTypeFlags().Length() + 6); 

	ptrSelectString = selectString->Des();

	ptrSelectString.Format(KCountTypeSelect, &KSqlContactTableName, &KContactTypeFlags, EContactType_Shift, EContactTypeFlags_Group,

							&KContactTypeFlags, EContactAttributes_Shift, EContactAttrsFlags_Deleted);

	count += scalarQuery.SelectIntL(ptrSelectString);

	CleanupStack::PopAndDestroy(selectString);

	//card template

	selectString = HBufC::NewLC(KCountTypeSelect().Length() + 

				KSqlContactTableName().Length() + KContactTypeFlags().Length() + KContactTypeFlags().Length() + 6); 

	ptrSelectString = selectString->Des();

	ptrSelectString.Format(KCountTypeSelect, &KSqlContactTableName, &KContactTypeFlags, EContactType_Shift, EContactTypeFlags_CardTemplate,

							&KContactTypeFlags, EContactAttributes_Shift, EContactAttrsFlags_Deleted);

	count += scalarQuery.SelectIntL(ptrSelectString);

	CleanupStack::PopAndDestroy(selectString);

	return count;

	}

/**

Get a collection of contact IDs using the specified view/collection parameters.

@param aViewType Type of view/collection.

@param aTime Used if view/collection type is "changed since".

@param aGuid Used if view/collection type is "find GUID".

@return Contact ID array of those contacts which match the specified collection

parameters.

*/

CContactIdArray* CPlCollection::CollectionL(TLplViewType aViewType,TTime aTime,const TDesC& aGuid)