// Copyright (c) 2008-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:

// MSVSEARCHSORTCACHEMANGER.CPP

// 

//

#include "msvinifile.h"

#include "msvsearchsortcacheentry.h"

#include "msvsearchsortcachemanager.h"

#include "msventryfreepool.h"

#include "MSVSERV.H"

#include "msvsearchsortdbwrapper.h"

#include "msvsearchsortdeltacache.h"

#include "msvdbadapter.h"

#include "msvindexadapter.h"

const TInt KPercentageValue = 20 ; //in percentage

const TInt KDefaultMaxCacheSize = 1024 ; //In Bytes.

const TInt KSearchSortDeltaCacheLimit = 350 ; //Number of maximum Delta Cache Entry .

_LIT(KAttachmentYes, "0");

_LIT(KAttachmentNo, "1");

_LIT(KAttachmentTypeEMsvFile, "2");

_LIT(KAttachmentTypeEMsvLinkedFile, "3"); 

_LIT(KAttachmentTypeEMsvMessageEntry, "4"); 

CMSvSearchSortCacheManager* CMSvSearchSortCacheManager::iMsvSearchSortCacheManager =NULL;

 /**

  * CMsvCacheIndexTableEntry()

  * @param CMsvServer& .

  * @return None.

  * Single Ton Class.

  * Constructor

  */

 CMSvSearchSortCacheManager::CMSvSearchSortCacheManager(CMsvServer& aServer):iServer(aServer)

 	{

   	}

 /**

  * ~CMsvCacheIndexTableEntry()

  * @param None.

  * @return None.

  * Destructor

  */

 CMSvSearchSortCacheManager::~CMSvSearchSortCacheManager()

 	{

	iMsvIdWithSortFieldArray.Close();

	iToFindResultAsIdArray.Close();

	iFinalResultAsIdArray.Close();

	iUpdateIdsToCacheArray.Close();

	iDeltaCacheIdArray.Close();

	delete iSearchSortDeltaCache;

	if(iSearchDbAdapter)

		{

#if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)   	

   		iSearchDbAdapter->CloseResources();

#endif

   		delete iSearchDbAdapter;

   		iSearchDbAdapter = NULL;

		}

   	if(iManagerEntry)

	   	{

	   	if(iManagerEntry->Count()>0)

	   		{

	   		iManagerEntry->ResetAndDestroy();

	   		}

	   	iManagerEntry->Close();	

	   	}

  	delete iManagerEntry;

  	iMsvSearchSortCacheManager = NULL; 

  	}

 /**

 * Instance()

 *

 * The function returns already created instance of

 * this class to the caller. To create a new instance

 * the caller should call CreateL(). If an instance of

 * this object does not already exists, the function

 * throws a panic EMsvSearchSortCacheMangerNotCreated in DEBUG mode.

 *

 * @param CMsvServer& .

 * @return CMSvSearchSortCacheManager*

 *

 */

CMSvSearchSortCacheManager* CMSvSearchSortCacheManager::Instance()

	{

	__ASSERT_DEBUG(iMsvSearchSortCacheManager!=NULL , PanicServer(EMsvSearchSortCacheMangerNotCreated));

	return iMsvSearchSortCacheManager;

	}

/**

 * CreateManagerL()

 * 

 * The only way to create an object of this class.

 * This is a static interface.

 * The function is made private to ensure that only

 * friend function can create instance of this class.

 *

 * @param CMsvServer& .

 * @return CMSvSearchSortCacheManager*

 */

CMSvSearchSortCacheManager* CMSvSearchSortCacheManager::CreateManagerL(CMsvServer& aServer)

	{

	CMSvSearchSortCacheManager* self ;

	self = new (ELeave) CMSvSearchSortCacheManager(aServer);

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop(self);

	iMsvSearchSortCacheManager = self;

	return self;

	}

/**

 * ConstructL()

 *

 * The function is called from InstanceL() and used to

 * initialize the instance of this class. It firsts reads

 * cache configuration information from msgcache.ini file

 * and stores them into member variable. It then allocates

 * creates initial set of entries as described in conf file.

 */

void CMSvSearchSortCacheManager::ConstructL()

	{

	iProgress = KMsvSearchSortOpNone;

	iCancelFlag = EFalse;

	iExplicitSortOnDateTime = EFalse;

	if(CMsvEntryFreePool::Instance()->iMsvMaximumCacheSize != NULL && CMsvEntryFreePool::Instance()->iMsvSearchSortCache)

		{

		iMsvMaximumSearchSortCacheSize = ((CMsvEntryFreePool::Instance()->iMsvMaximumCacheSize * CMsvEntryFreePool::Instance()->iMsvSearchSortCache)/100)*1024 ;		

		}

	else

		{

		iMsvMaximumSearchSortCacheSize = ((KDefaultMaxCacheSize * KPercentageValue)/100)*1024 ;

		}

	//Default Granularity

	iManagerEntry = new(ELeave) RPointerArray<CMsvSearchSortCacheEntry>();

	iSearchSortDeltaCache = CMsvSearchSortDeltaCache::CreateDeltaCacheL();

	iSearchDbAdapter = NULL;

	}

void CMSvSearchSortCacheManager::InstantiateDBwrapperL()

	{

	//Leave with the errorstate if the Db closed

	if(iServer.Context().IndexAdapter()->GetDbAdapter() == NULL)

		{

		if(iSearchDbAdapter)

			{

	#if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)   	

   			iSearchDbAdapter->CloseResources();

	#endif

			delete iSearchDbAdapter;

			iSearchDbAdapter = NULL;

			}

		User::Leave(iServer.Context().IndexAdapter()->ErrorState());

		}

	//If the searchsortwrapper is not instantiated, instantiate it

	else if(iSearchDbAdapter == NULL)

		{

#if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)		

		iSearchDbAdapter = TSearchSortDbWrapper::NewL(iServer);

#else		

		iSearchDbAdapter = TSearchSortDbWrapper::NewL(*(iServer.Context().IndexAdapter()->GetDbAdapter()));

#endif		

		}

	//If the Db pointer has been changed since the last operation, reinstantiate it

	//so get new iDbAdapter

	else

		{

		if(iSearchDbAdapter->GetDbAdapter() != iServer.Context().IndexAdapter()->GetDbAdapter())

			{

#if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)   	

   			iSearchDbAdapter->CloseResources();

#endif			

			delete iSearchDbAdapter;

			iSearchDbAdapter = NULL;

#if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)		

		iSearchDbAdapter = TSearchSortDbWrapper::NewL(iServer);

#else		

		iSearchDbAdapter = TSearchSortDbWrapper::NewL(*(iServer.Context().IndexAdapter()->GetDbAdapter()));

#endif			

			}

		}

	}

/**

 * AddEntryL()

 * @param CMsvSearchSortCacheEntry*& :  apointer toa reference of CMsvSearchSortCacheEntry.

 * @return TInt

 * 				Return  -1 : Not Added into Manager.

 * 				Return 0 : Sussefuly added into manager.

 */

 TInt CMSvSearchSortCacheManager::AddEntryL(const CMsvSearchSortCacheEntry& aEntry)

	{

	if(QueryExists(aEntry)<0) //Query is not Exist

		{

	 	TInt iRequiredSize = sizeof(aEntry);

	 	if(iRequiredSize > iMsvMaximumSearchSortCacheSize)

	 		{

	 		return KErrNoMemory;

	 		}

	 	else

		 	{

		 	if(iMsvSearchSortCacheManager->iManagerEntry->Count() == 0)

		 		{

		 		if(IsInRange(aEntry))

		 			{

		 			User::LeaveIfError(iMsvSearchSortCacheManager->iManagerEntry->Append(&aEntry));

		 			}

		 		}

		 	else

		 		{

		 		if(IsInRange(aEntry))

		 			{

	 				User::LeaveIfError(iMsvSearchSortCacheManager->iManagerEntry->Append(&aEntry));

		 			}

		 		else

		 			{

		 			TInt iRequiredSize = sizeof(aEntry);

		 			if(RemoveEntry(iRequiredSize))

		 				{

		 				User::LeaveIfError(iMsvSearchSortCacheManager->iManagerEntry->Append(&aEntry));

	 					}

	 				}

	 			}

	   		}/* End of  if(iRequiredSize > iMsvMaximumSearchSortCacheSize)*/

		}/* END of if(QueryExists(&aEntry)<0) //Query is not Exist */

	else

		{

		//Query Already Exist

		delete &aEntry;

		}

	return 0;

	}

 /**

  * MoveEntryAtEnd()

  * @param CMsvSearchSortCacheEntry* :Pointer to a Cache entry need to add.

  * @param TInt : aIndex 

  * @return None

  */

void CMSvSearchSortCacheManager::MoveEntryAtEnd(CMsvSearchSortCacheEntry* aEntry,TInt aIndex)

	{

	iMsvSearchSortCacheManager->iManagerEntry->Remove(aIndex);

	iMsvSearchSortCacheManager->iManagerEntry->Append(aEntry);

	}

 /**

  * QueryExists()

  * @param CMsvSearchSortCacheEntry* :Pointer to a Cache entry need to add.

  * @return TInt : index of manager class  if Query Exist , else 0 if query does not exists.

  */

TInt CMSvSearchSortCacheManager::QueryExists(const CMsvSearchSortCacheEntry& aEntry)

	{

	TBool queryNotFound = EFalse;

	TInt return_position  = -1;

	if(iMsvSearchSortCacheManager->iManagerEntry->Count() > 0)

		{

		//Total Number of available Node in SearchSortCacheManager Class.

		for(TInt IndexEntryCount = 0; IndexEntryCount <iMsvSearchSortCacheManager->iManagerEntry->Count(); IndexEntryCount++)

			{

			//Checking ParentID and ResultType

			if((aEntry.iParentId == (*iManagerEntry)[IndexEntryCount]->iParentId) && (aEntry.iQueryLevel == (*iManagerEntry)[IndexEntryCount]->iQueryLevel))/*(aEntry.iResultType == (*iManagerEntry)[IndexEntryCount]->iResultType))*/

				{

				//Checking QueryType(Serach/sort) and Sort Option (Ascending/Desending)

				if(aEntry.IsSortQuery()  == (*iManagerEntry)[IndexEntryCount]->IsSortQuery() && (aEntry.IsAscendingSort() == (*iManagerEntry)[IndexEntryCount]->IsAscendingSort()))

					{

					//Checking WholeWord and WildCharacter

					 if(aEntry.IsWholeWord() == (*iManagerEntry)[IndexEntryCount]->IsWholeWord() && (aEntry.IsWildCharacter() == (*iManagerEntry)[IndexEntryCount]->IsWildCharacter()))

						{

						//Checking ExplicitSort 

						 if(aEntry.IsExplicitSortReq() == (*iManagerEntry)[IndexEntryCount]->IsExplicitSortReq() && (aEntry.iMsgExplicitSortPart == (*iManagerEntry)[IndexEntryCount]->iMsgExplicitSortPart))

							{

							//Checking Explicit Sort part

							if((*iManagerEntry)[IndexEntryCount]->iMsgExplicitSortPart == aEntry.iMsgExplicitSortPart /*EMsgDate*/)

								{

								// For query Level Search

								for (TInt qCount = 0; qCount < aEntry.iQueryLevel; qCount++)

									{

									//Checking mesagepart and relational Op

									if ((*iManagerEntry)[IndexEntryCount]->iMsgQuery[qCount].iMessagePart == aEntry.iMsgQuery[qCount].iMessagePart) 

										{

										//Checking QueryString

										 if(((*iManagerEntry)[IndexEntryCount]->iMsgQuery[qCount].iQueryString.Compare(aEntry.iMsgQuery[qCount].iQueryString) == 0) && ((*iManagerEntry)[IndexEntryCount]->iMsgQuery[qCount].iRelationOp == aEntry.iMsgQuery[qCount].iRelationOp ))

											{

											queryNotFound = EFalse;

											}

										else

											{

											queryNotFound = ETrue;

											}

										}

									else

										{

										queryNotFound = ETrue;

										}

									}/* End of  for (TInt qCount = 0; qCount < aEntry.iQueryLevel; qCount++)  */

									return_position = IndexEntryCount;

								}

							}

						}

					}

				}

			}/*	End of while (iIndexEntryCount--)*/

		//All Check match. Query Found. Returning the index.

		if(queryNotFound)

			{

			iProgress = KMsvSearchSortOpInProgress;

			return KErrNotFound;

			}

		else

			{

			iProgress = KMsvSearchSortOpInProgress;

			return return_position;

			}

		}/*End of if(iMsvSearchSortCacheManager->iManagerEntry->Count() > 0) */

	iProgress = KMsvSearchSortOpInProgress;

	return KErrNotFound;

	}

/**

* QueryExists()

* @param : const TInt : a Query ID. 

* @return :TInt : return index if query exist , else return 0

*/

TInt CMSvSearchSortCacheManager::QueryExists(const TUint32 aQueryID)

	{

	for(TInt IndexEntryCount = 0; IndexEntryCount <iMsvSearchSortCacheManager->iManagerEntry->Count(); IndexEntryCount++)

		{

		if(aQueryID == (*iManagerEntry)[IndexEntryCount]->iQueryID)

			{

			if((*iManagerEntry)[IndexEntryCount]->iMsgExplicitSortPart == EMsvDate)

				{

				iExplicitSortOnDateTime = ETrue;

				}

			else

				{

				iExplicitSortOnDateTime = EFalse;	

				}

			return IndexEntryCount;

			}

		}

	iReturnResultType = KMsvSearchSortQueryIdNotFound;

	return KMsvSearchSortQueryIdNotFound;

	}

/**

* ResetSearchSortCache() : To reste the Search Sort Cache .

* @param :None 

* @return :None.

*/

void CMSvSearchSortCacheManager::ResetSearchSortCache()

	{

	if(iMsvSearchSortCacheManager)

		{

		CMsvSearchSortDeltaCache::Instance()->iNewEntry.Reset();

		CMsvSearchSortDeltaCache::Instance()->iUpdateEntry.Reset();

		CMsvSearchSortDeltaCache::Instance()->iDeleteEntry.Reset();

		iMsvSearchSortCacheManager->iManagerEntry->ResetAndDestroy();

		}

	if(iSearchDbAdapter)

		{

#if (defined SYMBIAN_MESSAGESTORE_HEADER_BODY_USING_SQLDB)   	

		iSearchDbAdapter->CloseResources();

#endif			

		delete iSearchDbAdapter;

		iSearchDbAdapter = NULL;

		}

	}

/**

* IsInRange()

* @param :const CMsvSearchSortCacheEntry* 

* @return :TBool : if cache size is available to grow return TRUE, else return False.

*/

TBool CMSvSearchSortCacheManager::IsInRange(const CMsvSearchSortCacheEntry& aEntry)// Will Chek the Size of the Cache.

	{

	iIndexEntryCount = iMsvSearchSortCacheManager->iManagerEntry->Count();

	iSearchSortDeltaCache = CMsvSearchSortDeltaCache::Instance();

	iSearchSortDeltaCacheSize = sizeof(*iSearchSortDeltaCache);

	TInt usedSize =0;

	for(TInt ii = 0 ; ii < iIndexEntryCount; ii++)

		{

		usedSize += 4 + sizeof(*((*iManagerEntry)[ii])) ;

		}

	iRequiredSize = 4 + sizeof(aEntry);

	iTotalUsedCacheSize = usedSize + iSearchSortDeltaCacheSize;

	iMsvAvailableSearchSortCacheSize = (iMsvMaximumSearchSortCacheSize - iTotalUsedCacheSize);

	if(iMsvAvailableSearchSortCacheSize>iRequiredSize)

		{

		// if delta cache grow too much invalidate the search sort cache and delta cahce.

		if(iSearchSortDeltaCache->iNewEntry.Count() + iSearchSortDeltaCache->iDeleteEntry.Count() + iSearchSortDeltaCache->iUpdateEntry.Count()> KSearchSortDeltaCacheLimit)

			{

			iMsvSearchSortCacheManager->ResetSearchSortCache();

			return ETrue;

			}

		else

			{

			return ETrue;

			}

		}

	else

		return EFalse;

	}

/**

* RemoveEntryL()

* @param const TInt : aRequiredSize

* @return TBool :TRUE : if suscessuly remove ,FALSE: if fails to remove from Cache manager.

*/

TBool CMSvSearchSortCacheManager::RemoveEntry(const TInt aRequiredSize) // Will Remove an entry from manager array based on the requirsed Size.

	{

	TBool AllMarkedEntry = EFalse ;

	if(iManagerEntry->Count() != 0)

		{

			TInt count = iManagerEntry->Count();

			for(TInt iStart = 0;  iStart < count;  iStart++)

				{

					TBool  markQuery = (*iManagerEntry)[iStart]->iMarkQuery;

					if(!markQuery) //Entry is Not Marked

						{

						delete (*iManagerEntry)[iStart];

						iMsvSearchSortCacheManager->iManagerEntry->Remove(iStart);

						iIndexEntryCount = iManagerEntry->Count();

						for(TInt ii =0; ii<iIndexEntryCount; ii++)

							{

							iTotalUsedCacheSize +=  4 + sizeof(*((*iManagerEntry)[ii])) ;

							}

						if(iIndexEntryCount == 0)

							{

							iMsvAvailableSearchSortCacheSize = iMsvMaximumSearchSortCacheSize;

							}

						else

							{

							iMsvAvailableSearchSortCacheSize = (iMsvMaximumSearchSortCacheSize - iTotalUsedCacheSize);

							}

						if(aRequiredSize<iMsvAvailableSearchSortCacheSize)

							{

							return ETrue;

							}

						AllMarkedEntry = EFalse;

						}

					else //Marked

						{

						AllMarkedEntry = ETrue;

						}

				}/* end of for loop*/

			if(AllMarkedEntry)	 //All entry are marked.

				{

				for(TInt start=0;  start< count;  start++)

					{

					//TInt entrySize = 4 + sizeof(*((*iManagerEntry)[start]));

					delete (*iManagerEntry)[start];

					iMsvSearchSortCacheManager->iManagerEntry->Remove(start);

					iIndexEntryCount = iManagerEntry->Count();

					for(TInt i =0; i<iIndexEntryCount; i++)

						{

						iTotalUsedCacheSize +=  4 + sizeof(*((*iManagerEntry)[i])) ;

						}

					if(iIndexEntryCount == 0)

						{

						iMsvAvailableSearchSortCacheSize = iMsvMaximumSearchSortCacheSize;

						}

					else

						{

						iMsvAvailableSearchSortCacheSize = (iMsvMaximumSearchSortCacheSize - iTotalUsedCacheSize);

						}

					if(aRequiredSize<iMsvAvailableSearchSortCacheSize)

						{

						return ETrue;

						}

			  		 }/* END OF for */

				}/* end of if(iAllMarkedEntry)	 //All entry are marked.*/

		}/*End of if(iManagerEntry->Count()!= 0) */

	return EFalse;

	}

/***********