// 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:

//

// System includess

#include "ecom/ecom.h"		// For REComSession

#include <ecom/ecomresolverparams.h>

// User includes

#include <cntviewbase.h>

#include "CNTSTD.H"

#include <cntviewfindconfig.h>

#include "CVIEWCONTACTEXTENSION.h"

#include <cntviewsortplugin.h>

#include "cntviewprivate.h"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <cntviewsortpluginbase.h>

#endif

extern void DebugLogViewNotification(const TDesC& aMethod, const TContactViewEvent& aEvent);

//uncomment in conjunction with LocalView and T_Cnt_ViewSortProfiling

//#define __PROFILE_SORT__

EXPORT_C RContactViewSortOrder::RContactViewSortOrder() : iSpare(KErrNone), iSpare2(0), iSpare3(0)

/** Default C++ constructor. */

	{

	}

EXPORT_C void RContactViewSortOrder::Close()

/** Closes the sort order array and frees all memory allocated to it. */

	{

	iFields.Close();

	}

EXPORT_C void RContactViewSortOrder::CopyL(const RContactViewSortOrder& aSortOrder)

/** Copies the field types contained in the specified sort order object into this 

object.

Any existing field types in this object are replaced.

@param aSortOrder The sort order to be copied. */

	{

	iFields.Reset();

	const TInt numFields=aSortOrder.iFields.Count();

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

		{

		TFieldType field = aSortOrder.iFields[ii];

		AppendL(field);

		}

	}

EXPORT_C void RContactViewSortOrder::InternalizeL(RReadStream& aStream) 

/** Internalises a sort order object from a read stream.

@param aStream The stream to read from. */

	{

	iSpare = aStream.ReadInt32L();

	iSpare2 = aStream.ReadInt32L();

	iSpare3 = aStream.ReadInt32L();

	TInt numFields;

	numFields = aStream.ReadInt32L();

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

		{

		TFieldType thisField;

		aStream >> thisField.iUid;

		AppendL(thisField);

		}

	}

EXPORT_C void RContactViewSortOrder::ExternalizeL(RWriteStream& aStream) const

/** Externalises a sort order object to a write stream.

@param aStream The stream to write to. */

	{

	aStream.WriteInt32L(iSpare);

	aStream.WriteInt32L(iSpare2);

	aStream.WriteInt32L(iSpare3);

	const TInt numFields=iFields.Count();

	aStream.WriteInt32L(numFields);

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

		{

		aStream << iFields[ii].iUid;

		}

	}

/* 

 * The current implementation relies on the externalized size provided by 

 * the STORE implementation.

 */

EXPORT_C TInt RContactViewSortOrder::ExternalizedSize() const

/** Retrieves the number of bytes required to store the sort order when externalised.

@return The size of the sort order object. */

	{

	return (sizeof(TInt)*4)+(iFields.Count()*sizeof(TFieldType));

	}

EXPORT_C TBool RContactViewSortOrder::operator==(const RContactViewSortOrder& aSortOrder) const

/** Compares two sort order objects for equivalence.

@param aSortOrder The sort order object to compare with this one.

@return ETrue if the two sort orders are the same, EFalse if not. */

	{

	TBool sortOrdersMatch = ETrue;

	const TInt numFields=iFields.Count();

	if (numFields!=aSortOrder.Count())

		{

		sortOrdersMatch = EFalse;

		}

	else

		{

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

			{

			if (iFields[ii]!=aSortOrder.iFields[ii])

				{

				sortOrdersMatch = EFalse;

				break;

				}

			}

		}

	return sortOrdersMatch;

	}

EXPORT_C void CContactViewBase::OpenL(MContactViewObserver& aObserver)

/** Appends an observer to the view's observer array.

If the view's state is EReady, the observer is notified asynchronously that 

the view is ready.

An error causes the function to leave. 

@param aObserver The contact view observer to be added. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiOpenL);

#endif

    iObserverArray.AppendL(&aObserver);

	if (GetErrorValueFromExtensionClass()!=KErrNone)

		{

		NotifyObservers(TContactViewEvent(TContactViewEvent::ESortError,iExtension->iError));

		}

	if (iState==EReady)

		{

		User::LeaveIfError(NotifyObserverAsync(aObserver,TContactViewEvent(TContactViewEvent::EReady)));

		}

	}

EXPORT_C TInt CContactViewBase::Open(MContactViewObserver& aObserver)

/** Appends an observer to the view's observer array.

If the view's state is EReady, the observer is notified asynchronously that 

the view is ready.

This function does not leave; an error code is returned instead.

@param aObserver The contact view observer to add. 

@return A standard error code, or KErrNone if the function completed without 

an error. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiOpen);

#endif

	TInt err=iObserverArray.Append(&aObserver);

	if (iExtension->iError!=KErrNone)

		{

		NotifyObservers(TContactViewEvent(TContactViewEvent::ESortError,iExtension->iError));

		}

	if (err)

		{

		return err;

		}

	if (iState==EReady)

		{

		err = NotifyObserverAsync(aObserver,TContactViewEvent(TContactViewEvent::EReady));

		if (err!=KErrNone)

			{

			return err;

			}

		}

	return err;

	}

/** 

Removes an observer from the view's observer array.

Any outstanding notifications for aObserver are first cancelled.

@capability None

@param aObserver The contact view observer to be removed.

@return ETrue if the view's observer array is empty as a result of the removal; 

EFalse if it is not empty or if aObserver could not be found in the observer 

array. 

*/

EXPORT_C TBool CContactViewBase::Close(const MContactViewObserver& aObserver)

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiClose);

#endif

	const TInt observerIndex = iObserverArray.Find(&aObserver);

	if (observerIndex != KErrNotFound)

		{

		//the observer that just closed may be expecting a notification

        for (TInt outstandingIndex=iOutstandingNotifications.Count()-1; outstandingIndex>=0; --outstandingIndex)

            {

            if (iOutstandingNotifications[outstandingIndex].iObserverToNotify == &aObserver)

                {

			    iOutstandingNotifications.Remove(outstandingIndex);

                }

            }

		if(iOutstandingNotifications.Count()==0)

			{

			iOutstandingNotifications.Reset();

			if(iAsyncNotifier->IsActive())

				{

				//AsyncNotifier is Active with nothing to notifiy so we need to cancel it.

				iAsyncNotifier->Cancel();

				}

			}

		//remove observer from main array.

		iObserverArray.Remove(observerIndex);

		if (iObserverArray.Count()==0)

			{

			delete this;

			return ETrue;

			}

		}

	return EFalse;

	}

EXPORT_C CContactViewBase::CContactViewBase(const CContactDatabase& aDb)

	: iDb(aDb),iState(EInitializing)

/** Protected C++ constructor.

Initialises the view's state to EInitializing.

@param aDb The database that contains the contact items. */

	{

	}

EXPORT_C CContactViewBase::~CContactViewBase()

/** Destructor.

Cancels all outstanding notifications and deletes all resources owned by the object. */

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	delete iExtension;

	REComSession::FinalClose(); // This line is necessary to make sure the plug-in is unloaded properly

	iObserverArray.Close();

	delete iAsyncNotifier;

	iOutstandingNotifications.Close();

	}

EXPORT_C void CContactViewBase::ConstructL()

/** Protected second phase constructor.

Called from a derived class's ConstructL(). Creates the view's asynchronous 

notifier and adds it to the active scheduler. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiConstructL);

#endif

	iAsyncNotifier=CIdle::NewL(CActive::EPriorityStandard);

    iExtension = CContactViewBaseExtension::NewL();

	if(iExtension)

		{

		iExtension->iFindPluginUid = KNullUid;

		iExtension->iError = KErrNone;

		}	

	}

EXPORT_C void CContactViewBase::NotifyObservers(const TContactViewEvent& aEvent)

/** Called by derived view classes to notify their observers synchronously of an 

event, by calling their HandleContactViewEvent() function.

@param aEvent Identifies the event that occurred. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiNotifyObservers, aEvent);

#endif

	TInt Observer=iObserverArray.Count();

#if defined(__VERBOSE_DEBUG__)

	//Print the message to be broadcated to the views

	if (Observer)

		{	

		DebugLogViewNotification(_L("[CNTMODEL] CContactViewBase::NotifyObservers"), aEvent);

		}

#endif

	// We iterate backwards to allow for observers removing themselves from the array

	while (Observer--)

		{

		iObserverArray[Observer]->HandleContactViewEvent(*this,aEvent);

		}

	}

EXPORT_C TInt CContactViewBase::NotifyObserverAsync(MContactViewObserver& aObserver,const TContactViewEvent& aEvent)

/** Called to notify a single view observer asynchronously of an event.

If other notifications are outstanding, this notification is appended to the 

queue.

If the view's asynchronous notifier is not active, it is started as a background 

task. 

This function is called by OpenL() and Open() to notify the observer that 

the view is ready.

@param aObserver The contact view observer to notify. This must have previously 

been added to the view's observer array.

@param aEvent Identifies the event that occurred. 

@return KErrNone if the function completed without error, otherwise one of 

the standard error codes. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiNotifyObserverAsync, aEvent);

#endif

	TInt err = KErrNone;

	__ASSERT_DEBUG(iObserverArray.Find(&aObserver)!=KErrNotFound,Panic(ECntPanicObserverNotFound));

	TObserverAndEvent outstandingNotification;

	outstandingNotification.iAsyncEvent=aEvent;

	outstandingNotification.iObserverToNotify=&aObserver;

	err = iOutstandingNotifications.Append(outstandingNotification);

	if (err==KErrNone)

		{

		if(!(iAsyncNotifier->IsActive()))

			{

			//No current outstanding notifications, start the asyn notifier to deal with the event that

			//was just added

			__ASSERT_DEBUG(iAsyncNotifier->IsActive()==EFalse,Panic(ECntPanicAsyncViewNotificationPending));

			iAsyncNotifier->Start(TCallBack(AsyncNotifyCallBack,this));

			}

		}

	return err;

	}

TInt CContactViewBase::AsyncNotifyCallBack(TAny* aSelf)

	{

	//Notifiy the bottom element in the outstanding notifiers array,

	//at the end of the function if the array is not empty there are further observers to notify.

	CContactViewBase* self=STATIC_CAST(CContactViewBase*,aSelf);

#ifdef _DEBUG

	TInt outstandingNotifCount = self->iOutstandingNotifications.Count();

	__ASSERT_DEBUG(outstandingNotifCount>0,Panic(ECntPanicObserverNotFound));

#endif

	TContactViewEvent event=self->iOutstandingNotifications[0].iAsyncEvent;

	MContactViewObserver* observerToNotify=self->iOutstandingNotifications[0].iObserverToNotify;

    __ASSERT_DEBUG(observerToNotify && self->iObserverArray.Find(observerToNotify)!=KErrNotFound,Panic(ECntPanicObserverNotFound));

	self->iOutstandingNotifications.Remove(0);

	observerToNotify->HandleContactViewEvent(*self,event);

	return self->iOutstandingNotifications.Count();

	}

EXPORT_C TBool CContactViewBase::IdsMatch(const CViewContact& aFirst,const CViewContact& aSecond)

/** Tests whether the IDs of two contact items are the same.

@param aFirst The first contact item.

@param aSecond The second contact item.

@return True if the IDs match, otherwise false. */

	{

	return (aFirst.Id()==aSecond.Id());

	}

EXPORT_C HBufC* CContactViewBase::FieldsWithSeparatorLC(const RPointerArray<CViewContact>& aContacts,TInt aIndex,const TDesC& aSeparator) const

/** Allocates and returns a descriptor filled with the contents of all the fields 

in a contact item.

The fields are separated by the specified separator.

@param aContacts An array of contact items.

@param aIndex An index into the specified array.

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

@return A pointer to a heap descriptor containing the contents of each of the 

contact item's fields. The field separator is appended to each field except 

the last one. The pointer is left on the cleanup stack. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiFieldsWithSeparatorLC);

#endif

	// Calculate the length of the buffer.

	TInt bufLength=0;

	const CViewContact& viewContact = *(aContacts[aIndex]);

	const TInt separatorLength=aSeparator.Length();

	const TInt numFields=viewContact.FieldCount();

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

		{

		bufLength+=viewContact.Field(ii).Length()+separatorLength;

		}

	HBufC* buf=HBufC::NewLC(bufLength);

	TPtr bufPtr(buf->Des());

	// Fill the buffer.

	for (TInt j=0;j<numFields;++j)

		{

		bufPtr.Append(viewContact.Field(j));

		// Only put a separator in if this isn't the last field.

		if (j!=numFields-1)

			{

			bufPtr.Append(aSeparator);

			}

		}

	return buf;

	}

EXPORT_C TBool CContactViewBase::MatchesCriteriaL(const CViewContact& aContact,const MDesCArray& aFindWords)

/** Searches a single contact item for fields that contain one or more search strings.

The search uses wildcard matching so that the search strings can occur anywhere 

in any of the item's fields. For a match to occur, all of the search strings 

must be found in the contact item.

Any find configuration plug-in that has been set (by calling SetViewFindConfigPlugin()) 

will be used.

@param aContact The contact item to search.

@param aFindWords A descriptor array containing one or more search strings.

@return True if all of the search strings were present in the contact item's 

fields. False if not. */

	{

	return MatchesCriteriaL(aContact,aFindWords,EFullSearch,iExtension);

	}

EXPORT_C TBool CContactViewBase::MatchesCriteriaL(const CViewContact& aContact,const MDesCArray& aFindWords, TSearchType aSearchType)

/** Searches a single contact item for fields that contain one or more search strings.

The search type indicates whether the search strings can occur anywhere in 

a field, or must occur at the start of a field only. For a match to occur, 

all of the search strings must be found in the contact item.

This function does not use any find configuration plug-in that has been set 

(by calling SetViewFindConfigPlugin()), so new code should use one of the other 

overloads instead. This function has been maintained for binary compatibility 

with previous OS versions.

@param aContact The contact item to search.

@param aFindWords A descriptor array containing one or more search strings.

@param aSearchType The search type. This controls whether a search term can 

occur anywhere in a contact item field, or just at the beginning of a field.

@return True if all of the search strings were present in the contact item's 

fields. False if not. */

	{

	return MatchesCriteriaL(aContact,aFindWords,aSearchType,NULL);

	}

EXPORT_C TBool CContactViewBase::MatchesCriteriaL(const CViewContact& aContact,const MDesCArray& aFindWords, TSearchType aSearchType,CContactViewBase::CContactViewBaseExtension* aExtension)

/** Searches a single contact item for fields that contain one or more search strings.

The search type indicates whether the search strings can occur anywhere in 

a field, or must occur at the start of a field only. For a match to occur, 

all of the search strings must be found in the contact item.

If a find configuration plug-in UID is specified in the fourth parameter, 

this overload uses it, loading it first if necessary. This overrides any plug-in 

that had previously been set by a call to SetViewFindConfigPlugin().

@param aContact The contact item to search.

@param aFindWords A descriptor array containing one or more search strings.

@param aSearchType The search type. This controls whether a search term can 

occur anywhere in a contact item field, or just at the beginning of a field.

@param aExtension Optionally, this can be used to specify the UID of a find 

configuration plug-in, overriding any that has previously been set by a call 

to SetViewFindConfigPlugin().

@return True if all of the search strings were present in the contact item's 

fields. False if not. */

	{

#ifdef CONTACTS_API_PROFILING

	TContactsApiProfile::CntViewMethodLog(TContactsApiProfile::ECntVwClassViewBase, TContactsApiProfile::ECntViewApiMatchesCriteriaL, aContact.Id());

#endif

	CDesCArrayFlat* findWordArray = CreateFindWordArrayLC(aFindWords, aSearchType);

	TBool result = ContactMatchesCriteriaL(aContact, *findWordArray,aExtension);

	CleanupStack::PopAndDestroy(findWordArray);

	return result;

	}

/*

 * Create an array of words to use when matching contact data. 

 * @param aFindWords Array of words

 * @param aSearchType Specifies a prefix or substring match

 * @return Array of words

 */

CDesCArrayFlat* CContactViewBase::CreateFindWordArrayLC(const MDesCArray& aFindWords, TSearchType aSearchType)

	{

	const TInt numFindWords=aFindWords.MdcaCount();

	CDesCArrayFlat* findWordArray = new (ELeave) CDesCArrayFlat(numFindWords);

	CleanupStack::PushL(findWordArray);

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

		{

		TPtrC original(aFindWords.MdcaPoint(i));

		HBufC* findString=HBufC::NewLC(original.Length()+2);

		TPtr ptr(findString->Des());

		switch(aSearchType)

			{

			case EFullSearch:

				ptr.Append('*');

				break;

			case EPrefixSearch:

				break;

			default: // programming error.

				break;

			}

		ptr.Append(original);

		ptr.Append('*');

		findWordArray->AppendL(*findString);

		CleanupStack::PopAndDestroy(findString);

		}

	return findWordArray;

	}

/* 

 * Check if aContact matches aFindWords 

 * @return ETrue if matched, EFalse otherwise