// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Symbian Foundation License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// This is the Cpp file which contains the utility functions common across the servers

// 

//

/**

 @file

*/

// User includes

#include <t_utils.h>

#include <t_utilscentralrepository.h>

// Epoc includes

#include <msvids.h>

#include <bautils.h>

#include <msvutils.h>

#include <barsc.h>

// Literals Used

const TInt KDefBufferSize = 1024;

/**

CT_MsgUtils()

Constructor

*/

EXPORT_C CT_MsgUtils::CT_MsgUtils()

	{

	}

/**

~CT_MsgUtils()

Constructor

*/

CT_MsgUtils::~CT_MsgUtils()

	{

	}

/**

OpenResourceFileL()

Opens a resource File

@param rFile

Resource File Handle

@param anFs

File Session associated

@param aFileName

The Name of resource File to be opened

*/

EXPORT_C void CT_MsgUtils::OpenResourceFileL(RResourceFile& rFile, RFs& anFs, const TDesC& aFileName )

 	{

 	// open resource file

 	TFileName fileName(aFileName);

 	MsvUtils::AddPathAndExtensionToResFileL(fileName);

 	BaflUtils::NearestLanguageFile( anFs, fileName );

 	if (BaflUtils::FileExists(anFs,fileName))

  		{

 		rFile.OpenL( anFs, fileName );

  		return;

  		}

  	User::Leave(KErrNotFound);

 	}

/**

CloseResourceFile()

Closes a recource File

@param aFile

The Name of resource File to be closed

*/

 EXPORT_C void CT_MsgUtils::CloseResourceFile( TAny* aFile )

 	{

 	((RResourceFile*)aFile)->Close();

 	}

/**

FindEntryByNameL()

Search the entries under a given folder ID by name of the entry

i.e, iDescription or iDetails value of an entry

@param aSession

Session object

@param aParentId

Parent Id under which the entry needs to be found

@param aEntryName

The entry name that needs to be found

@leave KErrNotFound

Leaves if no entry's iDescription or iDetails matches with aEntryName

@return

Id of the entry that match 

*/

EXPORT_C TMsvId CT_MsgUtils::FindEntryByNameL(CMsvSession* aSession, TMsvId aParentId, TDesC& aEntryName, TBool aCaseSensitive)

	{

	TMsvId msgEntryId = KMsvNullIndexEntryId;

	// Set the context to the Parent

	CMsvEntry* entry = CMsvEntry::NewL(*aSession, aParentId,TMsvSelectionOrdering

									(KMsvNoGrouping,EMsvSortByNone, ETrue));

	CleanupStack::PushL(entry);

	entry->SetEntryL(aParentId);

 	msgEntryId = FindEntryByNameL(entry, aEntryName, aCaseSensitive);

 	CleanupStack::PopAndDestroy(entry);

 	return msgEntryId;

	}

/**

FindEntryByNameL()

Search the entries under a given folder ID by name of the entry

i.e, iDescription or iDetails value of an entry

@param aSession

Session object

@param aParentId

Parent Id under which the entry needs to be found

@param aEntryName

The entry name that needs to be found

@param aParentEntryName

The Parent entry name that needs to be matched with the entry found

@leave KErrNotFound

Leaves if no entry's iDescription or iDetails matches with aEntryName

@return

Id of the entry that match 

*/

EXPORT_C TMsvId CT_MsgUtils::FindEntryByNameL(CMsvSession* aSession, TMsvId aParentId, TDesC& aEntryName, TDesC& aParentEntryName, TBool aCaseSensitive)

	{

	TMsvId msgEntryId = KMsvNullIndexEntryId;

	// Set the context to the Parent

	CMsvEntry* entry = CMsvEntry::NewL(*aSession, aParentId,TMsvSelectionOrdering

									(KMsvNoGrouping,EMsvSortByNone, ETrue));

	CleanupStack::PushL(entry);

	entry->SetEntryL(aParentId);

 	msgEntryId = FindEntryByNameL(entry, aEntryName, aParentEntryName, aCaseSensitive);

 	CleanupStack::PopAndDestroy(entry);

 	return msgEntryId;

	}

/**

FindEntryByNameL()

Search the entries under a given entry(an object of CMsvEntry) by name of the entry

i.e, iDescription or iDetails value of an entry

@param aEntry	

Parent entry under which the given entry needs to be searched

@param aEntryName

The entry name that needs to be found

@leave KErrNotFound

Leaves if no entry's iDescription or iDetails matches with aEntryName

@return

Id of the entry that match 

*/

EXPORT_C TMsvId  CT_MsgUtils::FindEntryByNameL(CMsvEntry* aEntry,TDesC& aEntryName, TBool aCaseSensitive)

	{

	TMsvId msgEntryId = KMsvNullIndexEntryId;

	msgEntryId = RecFindEntryByNameL(*aEntry, aEntryName, aCaseSensitive);

	if(msgEntryId == KMsvNullIndexEntryId)

		{

		User::Leave(KErrNotFound);

		}

	return msgEntryId;

	}

/**

FindEntryByNameL()

Search the entries under a given entry(an object of CMsvEntry) by name of the entry

i.e, iDescription or iDetails value of an entry

@param aEntry	

Parent entry under which the given entry needs to be searched

@param aEntryName

The entry name that needs to be found

@param aParentEntryName

The Parent entry name that needs to be matched with the entry found

@leave KErrNotFound

Leaves if no entry's iDescription or iDetails matches with aEntryName

@return

Id of the entry that match 

*/

EXPORT_C TMsvId  CT_MsgUtils::FindEntryByNameL(CMsvEntry* aEntry,TDesC& aEntryName, TDesC& aParentEntryName, TBool aCaseSensitive)

	{

	TMsvId msgEntryId = KMsvNullIndexEntryId;

	msgEntryId = RecFindEntryByNameL(*aEntry, aEntryName, aParentEntryName, aCaseSensitive);

	if(msgEntryId == KMsvNullIndexEntryId)

		{

		User::Leave(KErrNotFound);

		}

	return msgEntryId;

	}

/**

RecFindEntryByNameL()

Recursively search the entries (including all sub entries) under a given entry (an object of CMsvEntry) 

by name of the entry i.e, iDescription or iDetails value of an entry

@param aEntry	

Parent entry under which the given entry needs to be searched

@param aEntryName

The entry name that needs to be found

@leave KErrNotFound

Leaves if no entry's iDescription or iDetails matches with aEntryName

@return

Id of the entry that match 

*/

TMsvId  CT_MsgUtils::RecFindEntryByNameL(CMsvEntry& aEntry, TDesC& aEntryName, TBool aCaseSensitive)

 	{

 	TMsvId msgEntryId = KMsvNullIndexEntryId;

 	CMsvEntrySelection* selection = aEntry.ChildrenL();

 	CleanupStack::PushL(selection);

 	// Search for the entry in the children selection, based on the entry name given

 	TBool	found = EFalse;

 	TInt count = selection->Count();

 	for (TInt index = 0; (index<count) && (!found); index++)

 		{

  		// Set the context to the child entry

  		aEntry.SetEntryL((*selection)[index]);

		if (aCaseSensitive)

			{

			if (( aEntryName.Compare( aEntry.Entry().iDescription ) == 0 ) ||

			    ( aEntryName.Compare( aEntry.Entry().iDetails ) == 0 ))

				{

				found = ETrue;

				}

			}

		else if (( aEntryName.CompareF( aEntry.Entry().iDescription ) == 0 ) ||

		         ( aEntryName.CompareF( aEntry.Entry().iDetails ) == 0 ))

			{

			found = ETrue;

			}

		if (found)

			{

			msgEntryId = (*selection)[index];

			}

		else

			{

			CMsvEntry* nextEntry = CMsvEntry::NewL(aEntry.Session(), (*selection)[index],TMsvSelectionOrdering(KMsvNoGrouping, EMsvSortByNone, ETrue));

			CleanupStack::PushL(nextEntry);

			msgEntryId = RecFindEntryByNameL(*nextEntry, aEntryName, aCaseSensitive);

			if(msgEntryId != KMsvNullIndexEntryId)

				{

				found = ETrue;

				}

   		CleanupStack::PopAndDestroy(nextEntry);  

   		}

 		}

 	CleanupStack::PopAndDestroy(selection);

 	return msgEntryId;

 	}

/**

RecFindEntryByNameL()

Recursively search the entries (including all sub entries) under a given entry (an object of CMsvEntry) 

by name of the entry i.e, iDescription or iDetails value of an entry

@param aEntry	

Parent entry under which the given entry needs to be searched

@param aEntryName

The entry name that needs to be found

@param aParentEntryName

The Parent entry name that needs to be matched with the entry found

@leave KErrNotFound

Leaves if no entry's iDescription or iDetails matches with aEntryName

@return

Id of the entry that match 

*/

TMsvId  CT_MsgUtils::RecFindEntryByNameL(CMsvEntry& aEntry, TDesC& aEntryName, TDesC& aParentEntryName, TBool aCaseSensitive)

 	{

 	TMsvId msgEntryId = KMsvNullIndexEntryId;

 	CMsvEntrySelection* selection = aEntry.ChildrenL();

 	CleanupStack::PushL(selection);

 	// Search for the entry in the children selection, based on the entry name given

 	TBool	found = EFalse;

 	TInt count = selection->Count();

	TBool matched = EFalse;

 	for (TInt index = 0; (index<count) && (!found); index++)

 		{

  		// Set the context to the child entry

  		aEntry.SetEntryL((*selection)[index]);

		matched = EFalse;

		if (aCaseSensitive)

			{

			if (( aEntryName.Compare( aEntry.Entry().iDescription ) == 0 ) ||

			    ( aEntryName.Compare( aEntry.Entry().iDetails ) == 0 ))

				{

				matched = ETrue;

				}

			}

		else if (( aEntryName.CompareF( aEntry.Entry().iDescription ) == 0 ) ||

		         ( aEntryName.CompareF( aEntry.Entry().iDetails ) == 0 ))

			{

			matched = ETrue;

			}

		if (matched)

			{

			//Check Parent

			CMsvEntry* parentEntry = CMsvEntry::NewL(aEntry.Session(), aEntry.Entry().Parent(),TMsvSelectionOrdering(KMsvNoGrouping, EMsvSortByNone, ETrue));

			CleanupStack::PushL(parentEntry);

			if(CheckParent(*parentEntry,aParentEntryName))

				{

				found = ETrue;

				msgEntryId = (*selection)[index];

				}

			CleanupStack::PopAndDestroy(parentEntry);

			}

		if (!found)

			{

			CMsvEntry* nextEntry = CMsvEntry::NewL(aEntry.Session(), (*selection)[index],TMsvSelectionOrdering(KMsvNoGrouping, EMsvSortByNone, ETrue));

			CleanupStack::PushL(nextEntry);

			msgEntryId = RecFindEntryByNameL(*nextEntry, aEntryName, aParentEntryName, aCaseSensitive);

			if(msgEntryId != KMsvNullIndexEntryId)

				{

				found = ETrue;

				}

			CleanupStack::PopAndDestroy(nextEntry);

			}

  		}

 	CleanupStack::PopAndDestroy(selection);

 	return msgEntryId;

 	}

/**

CheckParent()

Checks if the given parent name matches the name of the given parent entry

@param aParentEntry	

Parent entry whose name is to be checked

@param aParentEntryName

The Parent entry name that we are checking against

@return

ETrue if they match and EFalse if they do not

*/

TBool CT_MsgUtils::CheckParent(CMsvEntry& aParentEntry, TDesC& aParentEntryName)

	{

 	TBool ret = EFalse;

 	if (( aParentEntryName.CompareF( aParentEntry.Entry().iDescription ) == 0 ) ||

     	( aParentEntryName.CompareF( aParentEntry.Entry().iDetails ) == 0 ))

 		{

 		ret = ETrue;

 		}

 	return ret;

	}

/**

CreateChildrenSelectionL()

This function creates a selection of the children entries under a given parent Id

@param aSession	

A CMsvSession object

@param aEntryId	

Id of the entry

@return

Returns a selection of all child entries under the given entry

*/

EXPORT_C CMsvEntrySelection* CT_MsgUtils::CreateChildrenSelectionL(CMsvSession* aSession, 

																   TMsvId       aEntryId)

	{

	CMsvEntry* entry = CMsvEntry::NewL(*aSession, aEntryId,TMsvSelectionOrdering

									( KMsvNoGrouping,EMsvSortByNone, ETrue));

	CleanupStack::PushL(entry);

	entry->SetEntryL(aEntryId);

	TMsvSelectionOrdering order;

	order.SetShowInvisibleEntries(ETrue);

	entry->SetSortTypeL(order);

	CMsvEntrySelection* selection = entry->ChildrenL();

	CleanupStack::PopAndDestroy(entry);

	return selection;

	}

/**

CreateChildrenSelectionWithTypeL()

This function creates a selection of the children entries under a given parent Id

which are of a specified type.

@param aSession	

A CMsvSession object

@param aEntryId	

Id of the entry

@param aType

Type of entry to look for

@return

Returns a selection of all child entries under the given entry of the specified type

*/

EXPORT_C CMsvEntrySelection* CT_MsgUtils::CreateChildrenSelectionWithTypeL(CMsvSession* aSession, TMsvId aEntryId, TUid aType)

	{

	CMsvEntry* entry = CMsvEntry::NewL(*aSession, aEntryId, TMsvSelectionOrdering(KMsvNoGrouping, EMsvSortByNone, ETrue));

	CleanupStack::PushL(entry);

	entry->SetEntryL(aEntryId);

	TMsvSelectionOrdering order;

	order.SetShowInvisibleEntries(ETrue);

	entry->SetSortTypeL(order);

	CMsvEntrySelection* selection = entry->ChildrenWithTypeL(aType);

	CleanupStack::PopAndDestroy(entry);

	return selection;

	}

/**

CreateChildrenSelectionRemoteFolderL()

This function creates a selection of the child entries under the 

remote folder Id if the service name is specified

@param aSession		

A CMsvSession object

@param aAccountName	

The account name or service name

@param aFolderName

The name of the remote folder whose entries need to be fetched

@return

The selection of all entries under the given entry

*/

EXPORT_C CMsvEntrySelection*  CT_MsgUtils::CreateChildrenSelectionRemoteFolderL(CMsvSession*

										aSession,TPtrC aAccountName,TPtrC aFolderName)

	{

	TMsvId remoteFolderId = GetRemoteFolderIdByNameL(aSession, aAccountName, aFolderName);

	return 	CreateChildrenSelectionL(aSession,remoteFolderId);

	}

/**

CreateChildrenSelectionRemoteFolderWithTypeL()

This function creates a selection of the child entries under the 

remote folder Id with a specified type if the service name is specified

@param aSession		

A CMsvSession object

@param aAccountName	

The account name or service name