/*

* Copyright (c) 2001-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 <phbksync.h>

#include "cntstd.h"

#include <cntviewbase.h>

#include <cntitem.h>

#include "cntviewprivate.h"

#include <cntviewsortplugin.h>

#include "persistencelayer.h"

#include "cviewiterator.h"

//uncomment to test

//#define __PROFILE_SORT__

//uncomment for commonly required debug printing

//#define __VERBOSE_DEBUG__

extern void DebugLogNotification(const TDesC& aMethod, const TContactDbObserverEvent &aEvent);

//

// CContactLocalView.

//

// CIdle Callback function's return values: 0 - finished, 1 - call again

// (CIdle is used to Insert & Sort contacts one at a time into the view)

const TInt	KSortFinished = 0;

const TInt	KSortCallAgain = 1;

// Tunable constants

// These seem to be useful values for memory allocations with RPointerArray

const TInt	KContactsArrayGranularity = 100;

const TInt	KUnsortedArrayGranularity = 16;

// Number of Contacts to process per invocation of the Sorter

// Local Views can't do much whilst sorting, but we want to allow other

// Active Objects in the thread to run.

const TInt	KNumberOfContactsPerChunk = 50;

CContactLocalView::CContactLocalView(const CContactDatabase& aDb,TContactViewPreferences aContactTypes, MLplPersistenceLayerFactory* aFactory) 

: CContactViewBase(aDb), 

iFactory(aFactory),

iContacts(KContactsArrayGranularity), 

iUnSortedContacts(KUnsortedArrayGranularity),

iViewPreferences(aContactTypes)

/**

@internalComponent

*/

	{

	}

EXPORT_C CContactLocalView::CContactLocalView(const CContactDatabase& aDb,TContactViewPreferences aContactTypes) 

: CContactViewBase(aDb), iContacts(KContactsArrayGranularity), iUnSortedContacts(KUnsortedArrayGranularity),

iViewPreferences(aContactTypes)

/** Protected C++ constructor.

Called by NewL().

@param aDb The underlying database that contains the contact items.

@param aContactTypes Specifies which types of contact items should be included 

in the view and the behaviour for items that do not have content in any of 

the fields specified in the sort order. */

	{

	}

EXPORT_C CContactLocalView::~CContactLocalView()

/** Destructor.

Deletes all resources owned by the object, and removes itself as the contact 

database observer. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewDestructor);

#endif

	delete iTextDef;

	delete iAsyncSorter;

	iContacts.ResetAndDestroy();

	iUnSortedContacts.ResetAndDestroy();

	iOutstandingEvents.Close();

	iSortOrder.Close();

	if (&iDb != NULL)

		{

        const_cast<CContactDatabase&>(iDb).RemoveObserver(*this);

		}

	delete iViewIterator;

	}

EXPORT_C CContactLocalView* CContactLocalView::NewL(MContactViewObserver& aObserver,const CContactDatabase& aDb,

													const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes)

/** Allocates and constructs the local view object.

The view is sorted according to the sort order and view preferences specified, 

using a low priority idle time active object. The specified view observer 

is notified when the view is sorted and ready for use.

@param aObserver An observer that receives notifications when this view is 

ready for use and when changes take place in it. The observer receives a TContactViewEvent::EReady 

event when the view is ready. Any attempt to use the view before this notification will Leave with KErrNotReady

@param aDb The underlying database that contains the contact items. The view 

observes the database, so that it handles change events sent from the database.

@param aSortOrder Specifies the fields to use to sort the items in the view.

@param aContactTypes Specifies which types of contact items should be included 

in the view and the behaviour for items that do not have content in any of 

the fields specified in the sort order.

@return The newly constructed local view object. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiNewL, aSortOrder, aContactTypes);

#endif

	CContactLocalView* self=new(ELeave) CContactLocalView(aDb,aContactTypes);

	CleanupStack::PushL(self);

	self->ConstructL(aObserver,aSortOrder);

	CleanupStack::Pop(self); 

	return self;

	}

EXPORT_C void CContactLocalView::ConstructL(MContactViewObserver& aObserver,const RContactViewSortOrder& aSortOrder)

/** Protected second phase constructor.

The view is sorted according to the sort order and view preferences specified, 

using a low priority idle time active object. The specified view observer 

is notified when the view is sorted and ready for use.

Called by NewL().

@param aObserver An observer that receives notifications when this view is 

ready for use and when changes take place in it. The observer receives a TContactViewEvent::EReady 

event when the view is ready. Any attempt to use the view before this notification will Leave with KErrNotReady.

@param aSortOrder Specifies the fields to use to sort the items in the view. */

	{

	// call new ConstructL

	ConstructL(aObserver, aSortOrder, EFalse, KNullDesC8);

	}

EXPORT_C CContactLocalView* CContactLocalView::NewL(MContactViewObserver& aObserver,const CContactDatabase& aDb,

													const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes,

													const TDesC8& aSortPluginName)

/** Allocates and constructs the local view object.

The view is sorted according to the sort order and view preferences specified, 

using a low priority idle time active object. The specified view observer 

is notified when the view is sorted and ready for use.

@param aObserver An observer that receives notifications when this view is 

ready for use and when changes take place in it. The observer receives a TContactViewEvent::EReady 

event when the view is ready. Any attempt to use the view before this notification will Leave with KErrNotReady

@param aDb The underlying database that contains the contact items. The view 

observes the database, so that it handles change events sent from the database.

@param aSortOrder Specifies the fields to use to sort the items in the view.

@param aContactTypes Specifies which types of contact items should be included 

in the view and the behaviour for items that do not have content in any of 

the fields specified in the sort order.

@param aSortPluginName Specifies a plug-in that will be used to compare view contacts

when the the view is sorted. This name is used by ECOM to select the plugin, and is matched

with the "default_data" of all ECOM plugins that support the required interface.

@return The newly constructed local view object. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiNewL, aSortOrder, aContactTypes, aSortPluginName);

#endif

	CContactLocalView* self=new(ELeave) CContactLocalView(aDb,aContactTypes);

	CleanupStack::PushL(self);

	self->ConstructL(aObserver, aSortOrder, ETrue, aSortPluginName);

	CleanupStack::Pop(self); 

	return self;

	}

/** CContactLocalView contructor, used in the server

@internalTechnology 

 */

EXPORT_C CContactLocalView* CContactLocalView::NewL(MContactViewObserver& aObserver,const CContactDatabase& aDb,const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes,

		MLplPersistenceLayerFactory* aFactory,const TDesC8& aSortPluginName)

	{

	CContactLocalView* self=new(ELeave) CContactLocalView(aDb,aContactTypes,aFactory);

	CleanupStack::PushL(self);

	self->ConstructL(aObserver, aSortOrder, ETrue, aSortPluginName);

	CleanupStack::Pop(self); 

	return self;

	}

void CContactLocalView::ConstructL(MContactViewObserver& aObserver,const RContactViewSortOrder& aSortOrder,

								   TBool aUseNamedPlugin, const TDesC8& aSortPluginName)

/** Protected second phase constructor.

The view is sorted according to the sort order and view preferences specified, 

using a low priority idle time active object. The specified view observer 

is notified when the view is sorted and ready for use.

Called by NewL().

@internalComponent

@param aObserver An observer that receives notifications when this view is 

ready for use and when changes take place in it. The observer receives a TContactViewEvent::EReady 

event when the view is ready. Any attempt to use the view before this notification will Leave with KErrNotReady.

@param aSortOrder Specifies the fields to use to sort the items in the view. 

@param aUseNamedPlugin A flag indicates whether the aSortPluginName parameter is valid.

@param aSortPluginName Specifies a plug-in that will be used to compare view contacts

when the the view is sorted. This name is used by ECOM to select the plugin, and is matched

with the "default_data" of all ECOM plugins that support the required interface.

*/

	{

	CContactViewBase::ConstructL();

	if(iFactory == NULL)

		{

		iFactory = const_cast<CContactDatabase&>(iDb).FactoryL();

		}

	iAsyncSorter = CIdleContactSorter::NewL(*this, *iFactory);

	OpenL(aObserver);

	if (aUseNamedPlugin)

		{

		// find and load Sort plug-in

		if (aSortPluginName.Length())

			{

			TUid sortPluginUid = FindSortPluginImplL (aSortPluginName);

			LoadViewSortPluginL(sortPluginUid, iViewPreferences);

			}

		}

	else

		{

		// find and load default Sort plug-in (if any)

		TUid sortPluginUid = FindDefaultViewSortPluginImplL();

		if (sortPluginUid != KNullUid)

			{

			LoadViewSortPluginL(sortPluginUid, iViewPreferences);

			}

		}

	// initialise for sort, and start if the database is ready

	InitialiseSortL(aSortOrder, EFalse);

	if (&iDb != NULL)

		{

        const_cast<CContactDatabase&>(iDb).AddObserverL(*this);

		}

	}

EXPORT_C const RContactViewSortOrder& CContactLocalView::SortOrder() const

/** Gets the sort order, as set during construction.

@return The sort order. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiSortOrder);

#endif

	return iSortOrder;

	}

TContactItemId CContactLocalView::AtL(TInt aIndex) const

/** Returns the ID of the contact item at a specified index into the view.

@param aIndex An index into the view.

@leave KErrNotFound The index is out of bounds.

@return The ID of the contact item at the specified index.

@leave KErrNotReady The view is not ready for use.  */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiAtL, aIndex);

#endif

	const CViewContact& contact = ContactAtL(aIndex);

	return contact.Id();

	}

const CViewContact& CContactLocalView::ContactAtL(TInt aIndex) const

/** Returns the contact item at a specified index into the view.

@param aIndex An index into the view.

@leave KErrNotFound The index is out of bounds.

@leave KErrNotReady The view is not ready for use.

@return The contact item at the specified index. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiContactAtL, aIndex);

#endif

	// state cannot be EInitializing or ENotReady

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	TInt offsetIndex=aIndex;

	const TInt unsortedCount=iUnSortedContacts.Count();

	const TInt sortedCount=iContacts.Count();

	if(offsetIndex >= (unsortedCount+sortedCount))

		{

		//Out of Bounds.

		User::Leave(KErrNotFound);

		}

	if(unsortedCount>0)

		{

		if(iViewPreferences & EUnSortedAtBeginning)

			{

			if(aIndex<unsortedCount)

				{

				//contact in unsorted array

				return *iUnSortedContacts[aIndex];

				}

			else

				{

				//contact in sorted array

				offsetIndex-=unsortedCount;

				}

			}

		else if ((iViewPreferences & EUnSortedAtEnd) && (aIndex>=sortedCount))

			{

			offsetIndex-=sortedCount;

			return *iUnSortedContacts[offsetIndex];

			}

		}

	return *iContacts[offsetIndex];

	}

TInt CContactLocalView::CountL() const

/** Gets the total number of contact items in the view.

@return The number of contact items in the view. This includes both sorted 

and unsorted items.

@leave KErrNotReady The view is not ready for use. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiCountL);

#endif

	// state cannot be EInitializing or ENotReady

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	TInt count(iUnSortedContacts.Count());

	count+=iContacts.Count();

	return count;

	}

TInt CContactLocalView::FindL(TContactItemId aId) const

/** Searches for a contact item in the view with the specified ID.

@param aId The ID of the contact item to search for.

@return If found, the index into the view of the matching item. Otherwise, 

KErrNotFound.

@leave KErrNotReady The view is not ready for use.  */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiFindL, aId);

#endif

	// state cannot be EInitializing or ENotReady

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	TInt index=KErrNotFound;

	CViewContact* contact = CViewContact::NewLC(aId);

	const TInt unSortedCount=iUnSortedContacts.Count();

	// first look in unsorted contacts

	if(unSortedCount > 0)

		{

		// contact may be in the unsorted array

		index = iUnSortedContacts.Find(contact,TIdentityRelation<CViewContact>(IdsMatch));

		if ((index != KErrNotFound) && (iViewPreferences & EUnSortedAtEnd))

			{

			// account for sorted array size

			index = index + iContacts.Count();

			}

		}

	// if not found try sorted contacts

	if (index == KErrNotFound)

		{

		//contact may be in the sorted array

		index = iContacts.Find(contact,TIdentityRelation<CViewContact>(IdsMatch));

		if ((index != KErrNotFound) && (iViewPreferences & EUnSortedAtBeginning))

			{

			// account for unsorted array size

			index = index + unSortedCount;

			}

		}

	CleanupStack::PopAndDestroy(contact);

	return index;

	}

HBufC* CContactLocalView::AllFieldsLC(TInt aIndex,const TDesC& aSeparator) const

/** Gets a descriptor containing the contents of all fields specified in the view's 

sort order for an item in the view.

The field separator is used to separate the contents of each field. It is 

not appended to the last field.

@param aIndex The index of the contact item into the view.

@param aSeparator The string to use to separate the fields.

@return Pointer to the contact item descriptor. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiAllFieldsLC, aIndex);

#endif

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	TInt offsetIndex=aIndex;

	const TInt unSortedCount=iUnSortedContacts.Count();

	if(unSortedCount>0)

		{

		if(iViewPreferences & EUnSortedAtBeginning)

			{

			if(aIndex<unSortedCount)

				{

				//contact in unsorted array

				return FieldsWithSeparatorLC(iUnSortedContacts,aIndex,aSeparator);

				}

			else

				{

				//contact in sorted array

				offsetIndex-=unSortedCount;

				}

			}

		else if(iViewPreferences & EUnSortedAtEnd)

			{

			const TInt sortedCount=iContacts.Count();

			if(aIndex>=sortedCount)

				{

				offsetIndex-=sortedCount;

				return FieldsWithSeparatorLC(iUnSortedContacts,offsetIndex,aSeparator);

				}

			}

		}

	return FieldsWithSeparatorLC(iContacts,offsetIndex,aSeparator);

	}

EXPORT_C void CContactLocalView::SortL(const RContactViewSortOrder& aSortOrder)

/** Sorts the view using the specified sort order, using a low priority idle time 

active object.

This function is called during view construction and on receipt of certain 

change events from the underlying database.

@param aSortOrder Specifies the fields to use to sort the items in the view. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassLocalView, TContactsApiProfile::ECntViewApiSortL);

#endif

	// re-initialise sort, and try to start it

	InitialiseSortL(aSortOrder, ETrue);

	}

/*

 Start first sort of view, or restart after SortL() API has changed the order.

 */

void CContactLocalView::InitialiseSortL(const RContactViewSortOrder& aSortOrder, TBool aChangingSortOrder)

	{

	if (aChangingSortOrder)

		{

		if (&iDb != NULL)

			{

			if (!iDb.DatabaseReadyL())

				{

				User::Leave(KErrNotReady);

				}

			}

		}

	// copy new sort order

	TRAPD(sortStartError, iSortOrder.CopyL(aSortOrder));

	if (sortStartError)

		{

		// ensure Db Recover (close then open tables) cannot push view to EReady

		iExtension->iError = sortStartError;

		User::Leave(sortStartError);

		}

	// New sort order for Sort Plugin

	CViewContactSortPlugin* sortPluginImpl = SortPluginImpl();

	if (sortPluginImpl)

		{

		sortPluginImpl->SetSortOrderL(aSortOrder);

		}

	// View can Sort only if database is 'ready'.

	if (&iDb != NULL)

		{

		if (!iDb.DatabaseReadyL())

			{

			return;

			}

		}

	// database is ready for reading - so start the Sort

	SortL();

	}

/**

Safe resort of view after Recover, Backup/Restore, etc...

@internalComponent

@released

*/

void CContactLocalView::SafeResort()

	{

	TInt sortError(KErrNone);

	// Database tables are closed across backup or restore so we may need to