// 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 <cntviewbase.h>

#include "cntviewprivate.h"

#include <cntviewsortplugin.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <cntviewsortpluginbase.h>

#endif

#include "CCntServer.h" //for KSlot1 and KSlot2

#include "rcntmodel.h"

// uncomment define in header to select debug prints for API profiling 

#include "CntApiProfile.h"

//

// RContactRemoteView.

//

const TInt KCachedItemCountInvalid = -1;

/**

@capability ReadUserData

*/

void RContactRemoteView::OpenL(const CContactDatabase& aDb,const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes,const TUid& aSortPluginImplUid,const TDesC8& aSortPluginName) 

	{

	HBufC8* pckgBuf = PackageSortOrderAndPluginDetailsLC(aSortOrder,aContactTypes,aSortPluginImplUid,aSortPluginName);

	TIpcArgs args(pckgBuf->Length());

	args.Set(KSlot1,pckgBuf);

	TInt err = CreateSubSession(*aDb.iCntSvr, ECntCreateView, args );	

	CleanupStack::PopAndDestroy(pckgBuf);

	User::LeaveIfError(err);

	}

/**

@capability ReadUserData

*/

void RContactRemoteView::OpenL(const CContactDatabase& aDb,const TDesC& aName,const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes,const TUid& aSortPluginImplUid,const TDesC8& aSortPluginName)

	{

	HBufC8* pckgBuf = PackageSortOrderAndPluginDetailsLC(aSortOrder,aContactTypes,aSortPluginImplUid,aSortPluginName);

	TIpcArgs args(pckgBuf->Length());

	args.Set(KSlot1,pckgBuf);

	args.Set(KSlot2,&aName);

	TInt err = CreateSubSession(*aDb.iCntSvr, ECntCreateNamedView, args );	

	CleanupStack::PopAndDestroy(pckgBuf);

	User::LeaveIfError(err);

	}

/**

@capability None

*/

void RContactRemoteView::Close()

	{

	CloseSubSession(ECntCloseView);

	if(iContact!=NULL)

		{

		delete iContact;

		}

	iSortOrder.Close();

	}

/**

Returns the contact item at the specified index into the view.

@capability ReadUserData

@param aIndex Index

*/

CViewContact* RContactRemoteView::ContactAtL(TInt aIndex)

	{

	const TContactItemId KUnknownContactId = -1;

	// 4 context switches

	TPckgBuf<TInt>pckg;

	TIpcArgs args(aIndex,&pckg);

	User::LeaveIfError(SendReceive(ECntViewContactAtLength,args));

	//

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

	delete iContact;

	iContact = contact;

	CleanupStack::Pop(contact);

	//

	TInt contactLength=pckg();

	HBufC8* buf=HBufC8::NewLC(contactLength);

	TPtr8 bufPtr(buf->Des());

	TIpcArgs args2(&bufPtr);

	User::LeaveIfError(SendReceive(ECntViewContactAt,args2));

	RDesReadStream readStream(bufPtr);

	CleanupClosePushL(readStream);

	readStream >> *iContact;

	CleanupStack::PopAndDestroy(2); // readStream , buf.

	return iContact;

	}

/**

Searches all contact items in the view for fields that contain the search

strings specified. 

@capability ReadUserData

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

@param aMatchedContacts On return, an array of matching contact items

@param find behaviour configuration uid to be passed to the server.

 */

void RContactRemoteView::ContactsMatchingCriteriaL(const MDesCArray& aFindWords, RPointerArray<CViewContact>& aMatchedContacts, TBool aPrefixSearch,TUid aUid)

	{

	if(aUid != KNullUid)

		{

		TIpcArgs args(aUid.iUid);

		User::LeaveIfError(SendReceive(ECntSendPluginUidToServer,args));

		}

	CBufBase* buffer = CBufFlat::NewL(32);

	CleanupStack::PushL(buffer);

	RBufWriteStream writeStream(*buffer);

	CleanupClosePushL(writeStream);

	writeStream.WriteUint32L(aPrefixSearch);

	const TInt count = aFindWords.MdcaCount();

	writeStream.WriteUint32L(count);

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

		{

		TPtrC ptr = aFindWords.MdcaPoint(i);

		writeStream.WriteUint32L(ptr.Length());

		writeStream << ptr;

		}

	writeStream.CommitL();

	CleanupStack::PopAndDestroy(&writeStream); //writeStream.Close()

	TPtr8 ptr(buffer->Ptr(0));

	const TInt bufferSize = buffer->Size();

	TPckg<TInt> size(bufferSize);

	TPckgBuf<TInt> pckg;

	TIpcArgs args(&pckg,&size,&ptr);

	User::LeaveIfError(SendReceive(ECntContactMatchingCriteriaExternalizedSize,args));

	CleanupStack::PopAndDestroy(buffer);

	//Internalize Contacts

	HBufC8* buf=HBufC8::NewLC(pckg());

	TPtr8 contactsbufPtr(buf->Des());

	TIpcArgs args2(&contactsbufPtr);

	User::LeaveIfError(SendReceive(ECntGetContactMatchingCriteria,args2));

	RDesReadStream readStream(contactsbufPtr);

	CleanupClosePushL(readStream);

	const TInt findCount = readStream.ReadUint32L();

	for (TInt zz=0;zz<findCount;++zz)

		{

		CViewContact* thisContact = CViewContact::NewLC(KNullContactId);

		readStream >> *thisContact;

		aMatchedContacts.AppendL(thisContact);

		CleanupStack::Pop(thisContact);

		}

	CleanupStack::PopAndDestroy(2, buf);

	}

/**

@capability ReadUserData

*/

TContactItemId RContactRemoteView::AtL(TInt aIndex) const

	{

	TPckgBuf<TContactItemId> pckg;

	TIpcArgs args(aIndex,&pckg);

	User::LeaveIfError(SendReceive(ECntViewAt,args));

	return pckg();

	}

/**

@capability ReadUserData

*/

TInt RContactRemoteView::CountL() const

	{

	TPckgBuf<TInt> pckg;

	TIpcArgs args(&pckg);

	User::LeaveIfError(SendReceive(ECntViewCount,args));

	return pckg();

	}

/**

@capability ReadUserData

*/

TInt RContactRemoteView::FindL(TContactItemId aId) const

	{

	TPckgBuf<TInt> pckg;

	TIpcArgs args(aId, &pckg);

	User::LeaveIfError(SendReceive(ECntViewFind,args));

	return pckg();

	}

/**

@capability ReadUserData

*/

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

	{

	// 4 context switches

	TPckgBuf<TInt>pckg;

	TIpcArgs args(aIndex,&aSeparator,&pckg);

	User::LeaveIfError(SendReceive(ECntAllFieldsLength,args));

	TInt fieldLength = pckg();

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

	TPtr8 narrowBufPtr((TUint8*)buf->Ptr(),buf->Des().MaxLength()*2); // Note, must call MaxLength because the cell allocated may be larger than aLength.

	TIpcArgs args2(&narrowBufPtr);

	User::LeaveIfError(SendReceive(ECntAllFieldsText,args2));

	TPtr bufPtr(buf->Des());

	bufPtr.SetLength(narrowBufPtr.Length()/2);

	return buf;

	}

/**

@capability ReadUserData

*/

void RContactRemoteView::ChangeSortOrderL(const RContactViewSortOrder& aSortOrder)

	{

	TInt size = aSortOrder.ExternalizedSize();

	size +=sizeof(TInt32);//TContactViewPreferences

	TIpcArgs args(size);

	args.Set(KSlot1,PackageSortOrderLC(aSortOrder,ContactViewPreferencesL()));

	User::LeaveIfError(SendReceive(ECntChangeViewSortOrder,args));

	CleanupStack::PopAndDestroy(); // buf.

	}

/**

@capability ReadUserData

*/

void RContactRemoteView::GetSortOrderL(RContactViewSortOrder& aSortOrder)

	{

	TPckgBuf<TInt> pckg;

	TIpcArgs args(&pckg);

	User::LeaveIfError(SendReceive(ECntViewSortOrderExternalizedSize,args));

	HBufC8* buf=HBufC8::NewLC(pckg());

	TPtr8 bufPtr(buf->Des());

	TIpcArgs args2(&bufPtr);

	User::LeaveIfError(SendReceive(ECntGetViewSortOrder,args2));

	RDesReadStream readStream(bufPtr);

	CleanupClosePushL(readStream);

	readStream >> aSortOrder;

	CleanupStack::PopAndDestroy(2); //readStream // buf.

	}

/**

@capability ReadUserData

*/

void RContactRemoteView::RequestViewEvent(TPckgBuf<TContactViewEvent>& aEvent,TRequestStatus& aStatus)

	{

	TIpcArgs args(&aEvent);

	SendReceive(ECntRequestViewEvent,args,aStatus);

	}

/**

@capability None

*/

TInt RContactRemoteView::CancelRequestViewEvent()

	{

	TIpcArgs args;

	return SendReceive(ECntCancelRequestViewEvent,args);

	}

HBufC8* RContactRemoteView::PackageSortOrderLC(const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes) const

	{

	TInt bufLength=aSortOrder.ExternalizedSize();

	bufLength+=sizeof(TContactViewPreferences);//

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

	TPtr8 bufPtr(buf->Des());

	RDesWriteStream writeStream(bufPtr);

	writeStream << (TInt32&)aContactTypes;

	writeStream << aSortOrder;

	bufPtr.SetLength(bufLength);

	return buf;

	}

HBufC8* RContactRemoteView::PackageSortOrderAndPluginDetailsLC(const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes,const TUid& aSortPluginImplUid,const TDesC8& aSortPluginName) const

	{

	// Make a packe that includes the sort plugin name

	TInt bufLength = aSortOrder.ExternalizedSize();

	bufLength += sizeof(TContactViewPreferences);

	bufLength +=sizeof(TInt32);//length of UID

	bufLength +=sizeof(TInt32);//length of aSortPluginName

	bufLength +=aSortPluginName.Length();

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

	TPtr8 bufPtr(buf->Des());

	RDesWriteStream writeStream(bufPtr);

	writeStream << (TInt32&)aContactTypes;

	writeStream << aSortOrder;

	writeStream.WriteInt32L(aSortPluginImplUid.iUid);

	writeStream.WriteInt32L(aSortPluginName.Length());

	writeStream.WriteL(aSortPluginName);

	bufPtr.SetLength(bufLength);

	return buf;

	}

/**

@capability ReadUserData

*/

const RContactViewSortOrder& RContactRemoteView::SortOrderL()

	{

	iSortOrder.Close();

	GetSortOrderL(iSortOrder);

	return iSortOrder;

	}

/**

@capability ReadUserData

*/

TContactViewPreferences RContactRemoteView::ContactViewPreferencesL()

	{

	TPckgBuf<TContactViewPreferences> pckg;

	TIpcArgs args(&pckg);

	User::LeaveIfError(SendReceive(ECntGetIncludedTypes,args));

	return pckg();

	}

/**

Convert between view indexes and contact ids.

This method makes the request to the server.

@capability ReadUserData

 */

void RContactRemoteView::GetContactIdsL(const CArrayFix<TInt>& aIndexes, CContactIdArray& aContactIds)

	{

	CBufBase* buffer = CBufFlat::NewL(32);

	CleanupStack::PushL(buffer);

	RBufWriteStream writeStream(*buffer);

	CleanupClosePushL(writeStream);

	const TInt count = aIndexes.Count();

	writeStream.WriteUint32L(count);

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

		{

		writeStream.WriteUint32L(aIndexes[i]);

		}

	writeStream.CommitL();

	CleanupStack::PopAndDestroy(&writeStream); //writeStream.Close()

	TPtr8 indexes(buffer->Ptr(0));

	const TInt bufferSize = buffer->Size();

	TPckg<TInt> size(bufferSize);

	HBufC8* buf=HBufC8::NewLC(bufferSize);

	TPtr8 ids(buf->Des());

	TIpcArgs args(&size, &indexes, &ids);

	User::LeaveIfError(SendReceive(ECntGetContactIds,args));

	RDesReadStream readStream(ids);

	CleanupClosePushL(readStream);

	CContactIdArray* array = CContactIdArray::NewLC();

	readStream >> *array;

	const TInt arrayCount = array->Count();

	for(TInt loop=0;loop<arrayCount;loop++)

		aContactIds.AddL((*array)[loop]);

	CleanupStack::PopAndDestroy(4,buffer); //array, &readStream, buf, buffer

	}

/** 

Requests an array of contact IDs from the server-side view which

match the filter provided by the client.

@capability ReadUserData

@param aFilter Filter supplied by client

@param aMatchingContacts Array of contacts which match the filter

 */

void RContactRemoteView::GetContactsMatchingFilterL(TInt aFilter, RArray<TContactIdWithMapping>& aMatchingContacts)

	{

	// Create a large enough buffer to hold whole view and ask server which contacts match

	const TInt viewCount(CountL());

	const TInt maxBufferSize = (1+(viewCount*2))*sizeof(TInt);

	HBufC8* buf=HBufC8::NewLC(maxBufferSize);

	TPtr8 ids(buf->Des());

	TIpcArgs args(aFilter,&ids);

	User::LeaveIfError(SendReceive(ECntGetContactsMatchingFilter,args));

	// Read results from buffer externalized by server

	RDesReadStream readStream(ids);

	CleanupClosePushL(readStream);

	const TInt count = readStream.ReadUint32L();

	TContactIdWithMapping idMap;

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

		{

		idMap.iId=readStream.ReadInt32L();

		idMap.iMapping=readStream.ReadInt32L();

		aMatchingContacts.AppendL(idMap);

		}

	CleanupStack::PopAndDestroy(2,buf); //readStream, buf

	}

/*

 * Get Implementation Uid of loaded Sort Plug-in from Server View

 */

TUid RContactRemoteView::GetViewSortPluginImplUidL() const

	{

	TUid uid;

	TPckgBuf<TInt> pckg;

	TIpcArgs args(&pckg);

	User::LeaveIfError(SendReceive(ECntGetSortPluginUidFromServer,args));

	uid.iUid = pckg();

	return uid;

	}

//

// CContactRemoteViewNotifier.

//

CContactRemoteViewNotifier::CContactRemoteViewNotifier(RContactRemoteView& aView,TCallBack aCallBack)

	: CActive(EPriorityStandard),iView(aView),iCallBack(aCallBack)

	{

	CActiveScheduler::Add(this);

	}

CContactRemoteViewNotifier::~CContactRemoteViewNotifier()

		{

	Cancel();

		}

/**

@capability ReadUserData

*/

void CContactRemoteViewNotifier::Start()

	{

	ASSERT(!IsActive());

	iView.RequestViewEvent(iEvent,iStatus);

	SetActive();

	}

const TContactViewEvent& CContactRemoteViewNotifier::Event() const

	{

	return MUTABLE_CAST(CContactRemoteViewNotifier*,this)->iEvent();

	}

void CContactRemoteViewNotifier::RunL()

	{

	iCallBack.CallBack();

	Start();

	}

void CContactRemoteViewNotifier::DoCancel()

	{

	iView.CancelRequestViewEvent();

	}

//

// CContactRemoteViewBase.

//

/**

Cancels the active notifier and closes the session with the contacts server.

@internalComponent

@capability None

*/

CContactRemoteViewBase::~CContactRemoteViewBase()

	{

	delete iNotifier;

	iView.Close();

	}

CContactRemoteViewBase::CContactRemoteViewBase(const CContactDatabase& aDb) 

	: CContactViewBase(aDb), iCount(KCachedItemCountInvalid)

/** Protected C++ constructor.

@internalComponent

@param aDb The underlying database containing the contact items. */

	{

	}

void CContactRemoteViewBase::ConstructL(MContactViewObserver& aObserver)

/** Protected second phase constructor. 

Starts an active object which notifies this view (by calling its HandleContactViewEvent() 

function) when view events occur in the server side view. This remote view 

in turn passes the events to its observers.

@capability ReadUserData

@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. An attempt to use the view before this notification 

causes a panic. */

	{

	CContactViewBase::ConstructL();

	OpenL(aObserver);

	iNotifier=new(ELeave) CContactRemoteViewNotifier(iView,TCallBack(NotifierCallBack,this));

	iNotifier->Start();

	}

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

side view.

@capability ReadUserData

@param aIndex An index into the server side view.

@leave KErrNotFound The index is greater than or equal to the number of items 

in the view.

@leave KErrNotReady The view is not ready for use.

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

@panic CntLock 6 The index is less than zero. */

TContactItemId CContactRemoteViewBase::AtL(TInt aIndex) const

	{

#ifdef CONTACTS_API_PROFILING

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

#endif

	if (iState != EReady)

		{

		User::Leave(KErrNotReady);

		}

	return iView.AtL(aIndex);

	}

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

@capability ReadUserData

@param aIndex An index into the server side view.

@leave KErrNotFound The index is greater than or equal to the number of items 

in the view.

@leave KErrNotReady The view is not ready for use.

@return The contact item at the specified index.