/*

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

*

*/

/**

 @file

 @internalComponent

 @released

*/

#include <cntviewbase.h>

#include <cntitem.h>

#include "cntviewprivate.h"

#include <cntviewsortplugin.h>

#include "persistencelayer.h"

#include "cviewcontactmanager.h"

#include "cntstd.h"

#include <phbksync.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <cntviewsortpluginbase.h>

#endif

//uncomment to test

//#define __PROFILE_SORT__

//uncomment for commonly required debug printing

//#define __VERBOSE_DEBUG__

//Define the patchable constants for the number of CViewContacts to read into memory 

//before merging them into a larger sorted list (via a heap sort).This is actually used

//in cviewcontactmanager.cpp but must be defined here so that the compiler can not 

//perform any "constant folding" with the value   

EXPORT_C extern const TInt KNumberOfContactsToReadPerMerge = 500;

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

//

// CContactLocalView.

//

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

: CContactViewBase(aDb), 

  iFactory(aFactory),

  iContacts(), 

  iUnSortedContacts(),

  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(const CContactDatabase& aDb,TContactViewPreferences aContactTypes) 

: CContactViewBase(aDb), 

  iContacts(), 

  iUnSortedContacts(),

  iViewPreferences(aContactTypes)

	{

	}

/**

Destructor.

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

database observer. 

*/

EXPORT_C CContactLocalView::~CContactLocalView()

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	delete iTextDef;

	iContacts.ResetAndDestroy();

	iUnSortedContacts.ResetAndDestroy();

	iOutstandingEvents.Close();

	iSortOrder.Close();

	if (&iDb != NULL)

		{

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

		}

	delete iAsyncSorter; //Add this though we don't use it in local view any more

	delete iViewCntMgr;

	}

/**

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. 

*/

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

													const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes)

	{

#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;

	}

/**

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. 

*/

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

	{

	// call new ConstructL

	ConstructL(aObserver, aSortOrder, EFalse, KNullDesC8);

	}

/**

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. 

*/

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

	{

#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;

	}

/**

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. 

@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.

*/

void CContactLocalView::ConstructL(MContactViewObserver& aObserver,const RContactViewSortOrder& aSortOrder, TBool aUseNamedPlugin, const TDesC8& aSortPluginName)

	{

	CContactViewBase::ConstructL();

	if(iFactory == NULL)

		{

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

		}

	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 sort order and textdef.

	SetSortOrderL(aSortOrder);

	//Create view contact manager to handle sorting

    iViewCntMgr = CViewContactManager::NewL(*this, *iFactory, *iTextDef, iViewPreferences, SortPluginImpl());

	if (&iDb != NULL)

		{

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

		}

	//Doing the sort.

	SortL();

	}

/**

Gets the sort order, as set during construction.

@return The sort order. 

*/

EXPORT_C const RContactViewSortOrder& CContactLocalView::SortOrder() const

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	return iSortOrder;

	}

/**

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.  

*/

TContactItemId CContactLocalView::AtL(TInt aIndex) const

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	return iViewCntMgr->AtL(aIndex);

	}

/**

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 reference to the copy of contact item at the specified index. 

*/

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

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	// state cannot be EInitializing or ENotReady

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	return iViewCntMgr->ContactAtL(aIndex);

	}

/**

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. 

*/

TInt CContactLocalView::CountL() const

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	// state cannot be EInitializing or ENotReady

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	return iViewCntMgr->Count();

	}

/**

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.  

*/

TInt CContactLocalView::FindL(TContactItemId aId) const

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	// state cannot be EInitializing or ENotReady

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	return iViewCntMgr->FindL(aId);

	}

/**

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. 

*/

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

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	if( iState != EReady )

		{

		User::Leave(KErrNotReady);

		}

	return iViewCntMgr->AllFieldsLC(aIndex, aSeparator);

	}

/**

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. 

*/

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

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	if (&iDb != NULL)

		{

		if (!iDb.DatabaseReadyL())

			{

			User::Leave(KErrNotReady);

			}

		}

	//set new sort order which also updates iTextDef.

	SetSortOrderL(aSortOrder);	

	// reset sort error

	iExtension->iError = KErrNone;

	iViewCntMgr->SortL(*iTextDef);

	}

/**

 Set sort order used to sorting the view contacts.

 */

void CContactLocalView::SetSortOrderL(const RContactViewSortOrder& aSortOrder)

	{

	// copy new sort order

	iSortOrder.CopyL(aSortOrder);

	// New sort order for Sort Plugin

	CViewContactSortPlugin* sortPluginImpl = SortPluginImpl();

	if (sortPluginImpl)

		{

		sortPluginImpl->SetSortOrderL(aSortOrder);

		}

	// Initialisation for each explicitly requested sort or initialise sort

	// Construct a text def to read out the required fields from the db.

	CContactTextDef* textDef=CContactTextDef::NewLC();

	TInt sortOrderCount=iSortOrder.Count();

	for (TInt sortIndex=0;sortIndex<sortOrderCount;sortIndex++)

		{

		textDef->AppendL(TContactTextDefItem(iSortOrder[sortIndex]));

		}

	CleanupStack::Pop(); // textDef.

	delete iTextDef;

	iTextDef=textDef;

	}

/**

Start sorting if database is ready

*/

void CContactLocalView::SortL()

	{

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

	if (&iDb != NULL)

		{

		if (!iDb.DatabaseReadyL())

			{

			return;

			}

		}

	// reset sort error

	iExtension->iError = KErrNone;

	iViewCntMgr->SortL();

	}

/**

Unleavable(safe) resorting

*/

void CContactLocalView::SafeResort()

	{

	TRAPD(sortError, SortL());

	// notify any error

	if (sortError)

		{

		NotifySortError(sortError);

		}

	}

/**

Inserts a contact item into the view, maintaining the view's sort order.

For the item to be inserted, it must exist in the underlying database, and 

it must be of the correct type according to the view preferences.

This function is called when a contact item or group is added to or changed 

in the underlying database.

@param aId The ID of a contact item that exists in the underlying database.

@return The index at which the item was inserted into the view, or KErrNotFound 

if the contact item was not found in the underlying database, or it already 

exists in the view. 

*/

EXPORT_C TInt CContactLocalView::InsertL(TContactItemId aId)

	{

#if defined(__VERBOSE_DEBUG__)

	RDebug::Print(_L("[CNTMODEL] CContactLocalView{ViewPrefs = 0x%08X}::InsertL into view Contact Id %i\r\n"), 

		iViewPreferences, aId);

#endif

	TContactViewPreferences view = iViewPreferences;

	return iViewCntMgr->InsertL(aId, view);

	}

/**

Removes a contact item from the view.

This function is called when a contact item or group is deleted from or changed 

in the underlying database.

@param aId The ID of the contact item to remove from the view.