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

//

#include "ContactUtilitiesCollection.h"

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include "cntdb_internal.h"

#endif

/**

 * Destructor

 */

CContactUtilitiesCollection::~CContactUtilitiesCollection()

	{

	}

/**

 * Constructor

 */

CContactUtilitiesCollection* CContactUtilitiesCollection::NewL(CTestStep& aTestStep, CContactDatabase& aDb, CContactViewCollection& aViewCollection)

	{

	CContactUtilitiesCollection* self = new(ELeave) CContactUtilitiesCollection(aTestStep, aDb, aViewCollection);

    return self;

	}

/**

 * Return database reference

 * @return CContactDatabase&

 */

CContactDatabase& CContactUtilitiesCollection::DatabaseReference()

	{

	return iDb;

	}

/**

 * Return viewcollection reference

 * @return CContactViewCollection&

 */

CContactViewCollection& CContactUtilitiesCollection::ViewCollectionReference()

	{

	return iViewCollection;

	}

/**

 * Constructor

 */

CContactUtilitiesCollection::CContactUtilitiesCollection(CTestStep& aTestStep, CContactDatabase& aDb, CContactViewCollection& aViewCollection)

: iBaseTestStep(aTestStep), iDb(aDb), iViewCollection(aViewCollection)

	{

	}

/**

 * Gets a reference to the base test step. This is needed to read from the ini file

 * @return CTestStep&

 */

CTestStep& CContactUtilitiesCollection::BaseTestStepReference()

	{

	return iBaseTestStep;

	}

/**

* Get the data required for the construction of the local view from the ini file and call the function

* ConstructLocalViewL to construct a local view Object.

* @param aSection ini section

*/

void CContactUtilitiesCollection::GetDataAndConstructLocalViewL(const TDesC& aSection)

	{

	TPtrC	viewSortOrder;

	TPtrC	viewPreferences;

	TPtrC	localViewSortPlugin;

	TBool 	viewNotReady = EFalse;

	BaseTestStepReference().GetBoolFromConfig(aSection, KViewNotReady, viewNotReady);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewSortOrder, viewSortOrder);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewPreferences, viewPreferences);

	BaseTestStepReference().GetStringFromConfig(aSection, KLocalViewSortPlugin, localViewSortPlugin);

	// Construct the local view by passing the input data required for the construction

	ConstructLocalViewL(viewSortOrder, viewPreferences, localViewSortPlugin, viewNotReady);

	}

/*

* Allocate and construct a local view object based on the sortorder, view preferences, sortplug-in given from the

* ini file

* @param aSortOrder specifies the fields to use to sort the items in the view

* @param aViewPreferences specifies the type of the contact item to be included in the view

* @param aSortPlugin specifies a plug-in that will be used to compare view contacts when the view is sorted

*/

void CContactUtilitiesCollection::ConstructLocalViewL(const TDesC& aSortOrder, const TDesC& aViewPreferences, const TDesC& aSortPlugin,

													TBool aViewNotReady)

	{

	// Get Db and view collection reference

	CContactDatabase& cDb = DatabaseReference();

	CContactViewCollection& cViewCollection = ViewCollectionReference();

	// Construct a view event queue object

	CContactViewEventQueue*	viewEventQueue = CContactViewEventQueue::NewL();

	CleanupStack::PushL(viewEventQueue);

	TContactViewPreferences	viewPreferences = ConvertStringToContactViewPreferencesL(aViewPreferences);

	RContactViewSortOrder	sortOrder = ConvertStringToSortOrderL(aSortOrder);

	CContactLocalView*	localView = NULL;

	// if sortplugin is specified in the ini, then create a local view object which contains sort plugin details.

	if ( aSortPlugin != KNullDesC() )

		{

		HBufC8*	sortPlugin = HBufC8::NewLC(aSortPlugin.Length());

		sortPlugin->Des().Copy(aSortPlugin);

		TRAPD( err, localView = CContactLocalView::NewL(*viewEventQueue, cDb, sortOrder, viewPreferences, sortPlugin->Des()));

		if( err != KErrNone )

			{

			BaseTestStepReference().ERR_PRINTF2(KErrSortPlugin, err);

			BaseTestStepReference().SetTestStepError(err);

			aViewNotReady = TRUE;

			}

		CleanupStack::Pop(sortPlugin);

		}

	else

		{

		localView = CContactLocalView::NewL(*viewEventQueue, cDb, sortOrder, viewPreferences);

		}

	CleanupStack::PushL(localView);

	if(!aViewNotReady)

		{

		WaitForViewReady(viewEventQueue);

		}

	if(localView!=NULL)

		{

		(cViewCollection.iArrayOfLocalViews).AppendL(localView);

		(cViewCollection.iArrayOfLocalViewEvents).AppendL(viewEventQueue);

		}

	CleanupStack::Pop(localView);

	CleanupStack::Pop(viewEventQueue);

	}

/*

* Get the data required for the construction of the remote view from the ini file and call the function

* ConstructRemoteViewL to construct a remote view Object.

* @param aSection ini section name

*/

void CContactUtilitiesCollection::GetDataAndConstructRemoteViewL(const TDesC& aSection)

	{

	TPtrC	viewSortOrder;

	TPtrC	viewPreferences;

	TPtrC	remoteViewSortPlugin;

	TBool 	viewNotReady = EFalse;

	BaseTestStepReference().GetBoolFromConfig(aSection, KViewNotReady, viewNotReady);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewSortOrder, viewSortOrder);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewPreferences, viewPreferences);

	BaseTestStepReference().GetStringFromConfig(aSection, KRemoteViewSortPlugin, remoteViewSortPlugin);

	// Construct remote view by passing the data required for the construction

	ConstructRemoteViewL(viewSortOrder, viewPreferences, remoteViewSortPlugin, viewNotReady);

	}

/*

* Allocate and construct a remote view object based on the sortorder, view preferences, sortplug-in given from the

* ini file

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

* aram aViewPreferences Specifies the type of the contact item to be included in the view

* aram aSortPlugin Specifies a plug-in that will be used to compare view contacts when the view is sorted

*/

void CContactUtilitiesCollection::ConstructRemoteViewL(const TDesC& aSortOrder, const TDesC& aViewPreferences, const TDesC& aSortPlugin,

								TBool aViewNotReady)

	{

	TContactViewPreferences	viewPreferences = ConvertStringToContactViewPreferencesL(aViewPreferences);

	RContactViewSortOrder	sortOrder = ConvertStringToSortOrderL(aSortOrder);

	CContactViewEventQueue*	viewEventQueue = CContactViewEventQueue::NewL();

	CleanupStack::PushL(viewEventQueue);

	CContactRemoteView*	remoteView = NULL;

	CContactDatabase& cDb = DatabaseReference();

	CContactViewCollection& cViewCollection = ViewCollectionReference();

	if ( aSortPlugin != KNullDesC() )

		{

		HBufC8*	sortPlugin = HBufC8::NewLC(aSortPlugin.Length());

		sortPlugin->Des().Copy(aSortPlugin);

		// Construct a remote view which contains sort plugin details.

		TRAPD( err, remoteView = CContactRemoteView::NewL(*viewEventQueue, cDb, sortOrder, viewPreferences, sortPlugin->Des()));

		CleanupStack::Pop(sortPlugin);

		if( err != KErrNone )

			{

			BaseTestStepReference().ERR_PRINTF2(KErrSortPlugin, err);

			BaseTestStepReference().SetTestStepError(err);

			aViewNotReady = TRUE;

			}

		}

	else

		{

		remoteView = CContactRemoteView::NewL(*viewEventQueue, cDb, sortOrder, viewPreferences);

		}

	CleanupStack::PushL(remoteView);

	if(!aViewNotReady)

		{

		WaitForViewReady(viewEventQueue);

		}

	// Append the remote view and remote view events in the array which will be used for testing

	(cViewCollection.iArrayOfRemoteViewEvents).AppendL(viewEventQueue);

	(cViewCollection.iArrayOfRemoteViews).AppendL(remoteView);

	CleanupStack::Pop(remoteView);

	CleanupStack::Pop(viewEventQueue);

	}

/*

* Get the data required for the construction of the named remote view from the ini file and call the function

* ConstructNamedRemoteView to construct a named remote view Object.

* @param aSection ini section name

*/

void CContactUtilitiesCollection::GetDataAndConstructNamedRemoteViewL(const TDesC& aSection)

	{

	TPtrC	name;

	TPtrC	viewSortOrder;

	TPtrC	viewPreferences;

	TPtrC	namedViewSortPlugin;

	TBool 	viewNotReady = EFalse;

	BaseTestStepReference().GetBoolFromConfig(aSection, KViewNotReady, viewNotReady);

	BaseTestStepReference().GetStringFromConfig(aSection, KNamedRemoteViewName, name);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewSortOrder, viewSortOrder);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewPreferences, viewPreferences);

	BaseTestStepReference().GetStringFromConfig(aSection, KNamedViewSortPlugin, namedViewSortPlugin);

	// Construct a named remote view by passing the data required for the construction

	ConstructNamedRemoteViewL(name, viewSortOrder, viewPreferences, namedViewSortPlugin, viewNotReady);

	}

/*

* Allocate and construct a named remote view object based on the name, sortorder, view preferences, sortplug-in given from the

* ini file

* @param aName The name of the view object in the server

* @param aSortOrder specifies the fields to use to sort the items in the view

* @param aViewPreferences specifies the type of the contact item to be included in the view

* @param aSortPlugin specifies a plug-in that will be used to compare view contacts when the view is sorted

*/

void CContactUtilitiesCollection::ConstructNamedRemoteViewL(const TDesC& aName, const TDesC& aSortOrder, const TDesC& aViewPreferences,

														const TDesC& aSortPlugin, TBool aViewNotReady)

	{

	TContactViewPreferences	viewPreferences = ConvertStringToContactViewPreferencesL(aViewPreferences);

	RContactViewSortOrder	sortOrder = ConvertStringToSortOrderL(aSortOrder);

	CContactViewEventQueue*	viewEventQueue = CContactViewEventQueue::NewL();

	CleanupStack::PushL(viewEventQueue);

	HBufC*	name = HBufC::NewLC(aName.Length());

	name->Des().Copy(aName);

	CContactNamedRemoteView* namedRemoteView = NULL;

	CContactDatabase& cDb = DatabaseReference();

	CContactViewCollection& cViewCollection = ViewCollectionReference();

	if ( aSortPlugin != KNullDesC() )

		{

		HBufC8*	sortPlugin = HBufC8::NewLC(aSortPlugin.Length());

		sortPlugin->Des().Copy(aSortPlugin);

		// Construct a named remote view which contains sort plug-in details

		TRAPD( err, namedRemoteView = CContactNamedRemoteView::NewL(*viewEventQueue, name->Des(), cDb, sortOrder, viewPreferences, sortPlugin->Des()));

		CleanupStack::PopAndDestroy(sortPlugin);

		if( err != KErrNone )

			{

			BaseTestStepReference().ERR_PRINTF2(KErrSortPlugin, err);

			BaseTestStepReference().SetTestStepError(err);

			aViewNotReady = TRUE;

			}

		}

	else

		{

		namedRemoteView = CContactNamedRemoteView::NewL(*viewEventQueue, name->Des(), cDb, sortOrder, viewPreferences);

		}

	CleanupStack::PushL(namedRemoteView);

	// If aViewNotReady is set to true then the view is not ready

	if(!aViewNotReady)

		{

		WaitForViewReady(viewEventQueue);

		}

	if(namedRemoteView != NULL)

		{

		(cViewCollection.iArrayOfNamedRemoteViewEvents).AppendL(viewEventQueue);

		// append the named remote view and named remote view events to the array which will be used for testing

		(cViewCollection.iArrayOfNamedRemoteViews).AppendL(namedRemoteView);

		}

	CleanupStack::Pop(namedRemoteView);

	CleanupStack::PopAndDestroy(name);

	CleanupStack::Pop(viewEventQueue);

	}

/*

* Get the data required for the construction of the find view from the ini file and call the function

* ConstructFindView to construct a find view Object.

* @param aSection ini section name

*/

void CContactUtilitiesCollection::GetDataAndConstructFindViewL(const TDesC& aSection)

	{

	TPtrC	searchWords;

	TPtrC	searchType;

	TBool 	viewNotReady = EFalse;

	BaseTestStepReference().GetBoolFromConfig(aSection, KViewNotReady, viewNotReady);

	BaseTestStepReference().GetStringFromConfig(aSection, KSearchWords, searchWords);

	BaseTestStepReference().GetStringFromConfig(aSection, KSearchType, searchType);

	// Get the underlying required view for the construction of find view

	CContactViewBase*	viewBase = GetDesiredView(aSection);

	// Construct a find view by passing the data required for the construction

	ConstructFindViewL(searchWords, searchType, viewBase, viewNotReady);

	}

/*

* Allocate and constructs a find view object based on the search words and the search type given from the

* ini file

* @param aSearchWords The search terms

* @param aSortPlugin specifies a plug-in that will be used to compare view contacts when the view is sorted

* @param aSearchType The search type

* @param aViewBase underlying view

*/

void CContactUtilitiesCollection::ConstructFindViewL(const TDesC& aSearchWords, const TDesC& aSearchType,

													CContactViewBase* aViewBase, TBool aViewNotReady)

	{

	RArray<TPtrC>	searchList;

	CleanupClosePushL(searchList);

	TokenizeStringL(aSearchWords, searchList);

	// allocate an array to store the search words

	CPtrCArray*	findWords = new(ELeave) CPtrCArray(3);

	CleanupStack::PushL(findWords);

	for ( TInt i = 0; i < searchList.Count(); ++i )

		{

		findWords->AppendL(searchList[i]);

		}

	CContactViewBase::TSearchType	searchType = GetSearchType(aSearchType);

	// Construct an view event queue object

	CContactViewEventQueue*	viewEventQueue = CContactViewEventQueue::NewL();

	CleanupStack::PushL(viewEventQueue);

	CContactFindView*	findView;

	CContactDatabase& cDb = DatabaseReference();

	CContactViewCollection& cViewCollection = ViewCollectionReference();

	if ( aSearchType != KNullDesC() )

		{

		// Construct a find view which contains search type

		findView = CContactFindView::NewL(cDb, *aViewBase, *viewEventQueue, findWords, searchType);

		}

	else

		{

		findView = CContactFindView::NewL(cDb, *aViewBase, *viewEventQueue, findWords);

		}

	CleanupStack::PushL(findView);

	// If aViewNotReady is set to true then the view is not ready

	if(!aViewNotReady)

		{

		WaitForViewReady(viewEventQueue);

		}

	// appends the find view and find view events to the array which will be used for testing

	if(findView != NULL)

		{

		(cViewCollection.iArrayOfFindViewEvents).AppendL(viewEventQueue);

		(cViewCollection.iArrayOfFindViews).AppendL(findView);

		}

	CleanupStack::Pop(findView);

	CleanupStack::Pop(viewEventQueue);

	CleanupStack::PopAndDestroy(findWords);

	CleanupStack::PopAndDestroy(&searchList);

	}

/*

* Get the data required for the construction of the local view from the ini file and call the function

* ConstructGroupView to construct a group view Object.

* @param aSection ini section name

*/

void CContactUtilitiesCollection::GetDataAndConstructGroupViewL(const TDesC& aSection)

	{

	TPtrC	groupType;

	TPtrC	groupName;

	TInt	groupId = -1;

	TBool 	viewNotReady = EFalse;

	TInt    groupViewVersion = 0;

	BaseTestStepReference().GetBoolFromConfig(aSection, KViewNotReady, viewNotReady);

	BaseTestStepReference().GetStringFromConfig(aSection, KGroupType, groupType);

	BaseTestStepReference().GetStringFromConfig(aSection, KGroupName, groupName);

	BaseTestStepReference().GetIntFromConfig(aSection, KGroupId, groupId);

	BaseTestStepReference().GetIntFromConfig(aSection, KGroupVersion, groupViewVersion);

	// Get the underlying view for the construction of group view

	CContactViewBase*	viewBase = GetDesiredView(aSection);

	// Construct the group view by passing the data required for the construction

	ConstructGroupViewL(groupType, groupName, groupId, viewBase, viewNotReady, groupViewVersion);

	}

/*

* Allocate and construct a group view object based on the grouptype, groupid and groupname given from the

* ini file

* @param aGroupType The group Type

* @param aGroupName the group name

* @param aGroupId The Id of the contact group

* @param aViewBase underlying view

*/

void CContactUtilitiesCollection::ConstructGroupViewL(const TDesC& aGroupType, const TDesC& aGroupName, const TInt& aGroupId,

													CContactViewBase* aViewBase, TBool aViewNotReady, TInt& aGroupViewVersion)

	{

	// Get the group type required for the construction of group view

	CContactGroupView::TGroupType	groupType = GetGroupType(aGroupType);

	CContactViewEventQueue*	viewEventQueue = CContactViewEventQueue::NewL();

	CleanupStack::PushL(viewEventQueue);

	CContactGroupView*	groupView = NULL;

	CContactDatabase& cDb = DatabaseReference();

	CContactViewCollection& cViewCollection = ViewCollectionReference();

	//Construct a group view using version 1

	if(aGroupViewVersion == 1)

		{

		if( aGroupName != KNullDesC() )

			{

			// Construct a group view which contains the details of group name

			TRAPD(err, groupView = CContactGroupView::NewL(cDb, *aViewBase, *viewEventQueue, aGroupName, groupType));

			if( err != KErrNone)

				{

				BaseTestStepReference().SetTestStepError(err);

				BaseTestStepReference().SetTestStepResult(EFail);

				aViewNotReady = ETrue;

				}

			}

		if(aGroupId > 0)

			{

			TRAPD(err, groupView = CContactGroupView::NewL(cDb, *aViewBase, *viewEventQueue, aGroupId, groupType));

			if( err != KErrNone)

				{

				BaseTestStepReference().SetTestStepError(err);

				BaseTestStepReference().SetTestStepResult(EFail);

				aViewNotReady = ETrue;

				}

			}

		}

	else

		{//Construct a group view using version 2

		if( aGroupName != KNullDesC() )

			{

			// Construct a group view which contains the details of group name

			TRAPD(err, groupView =CContactGroupView::NewL(*aViewBase, cDb, *viewEventQueue, aGroupName, groupType));

			if( err != KErrNone)

				{

				BaseTestStepReference().SetTestStepError(err);

				BaseTestStepReference().SetTestStepResult(EFail);

				aViewNotReady = ETrue;

				}

			}

		if(aGroupId > 0)

			{

			TRAPD(err, groupView = CContactGroupView::NewL(*aViewBase, cDb, *viewEventQueue, aGroupId, groupType));

			if( err != KErrNone)

				{

				BaseTestStepReference().SetTestStepError(err);

				BaseTestStepReference().SetTestStepResult(EFail);

				aViewNotReady = ETrue;

				}

			}

		}

	CleanupStack::PushL(groupView);

    if(!aViewNotReady)

		{

		WaitForViewReady(viewEventQueue);

		}

	// append the group view to the array which will be used for multiple view access tests

	if( groupView != NULL )

		{

		(cViewCollection.iArrayOfGroupViews).AppendL(groupView);

		(cViewCollection.iArrayOfGroupViewEvents).AppendL(viewEventQueue);

		}

	CleanupStack::Pop(groupView);

	CleanupStack::Pop(viewEventQueue);

	}

/*

* Get the data required for the construction of the local view from the ini file and call the function

* ConstructFilteredView to construct a filtered view Object.

* @param aSection ini section name

*/

void CContactUtilitiesCollection::GetDataAndConstructFilteredViewL(const TDesC& aSection)

	{

	TPtrC	viewFilter;

	TBool 	viewNotReady = EFalse;

	BaseTestStepReference().GetBoolFromConfig(aSection, KViewNotReady, viewNotReady);

	BaseTestStepReference().GetStringFromConfig(aSection, KViewFilter, viewFilter);

	// Get the underlying view required for the construction of filtered view

	CContactViewBase*	viewBase = GetDesiredView(aSection);

	// construct the filtered view by passing the data required for the construction

	ConstructFilteredViewL(viewFilter, viewBase, viewNotReady);

	}

/*

* Allocate and constructs a filter view object based on the filter type given from the

* ini file

* @param aViewFilter The filter to use.

* @param aViewBase underlying view

*/

void CContactUtilitiesCollection::ConstructFilteredViewL(const TDesC& aViewFilter, CContactViewBase* aViewBase, TBool aViewNotReady)

	{

	// Get the filter type required for the construction of filtered view

	CContactDatabase::TContactViewFilter	viewFilter = GetContactViewFilterL(aViewFilter);

	CContactViewEventQueue*	viewEventQueue = CContactViewEventQueue::NewL();

	CleanupStack::PushL(viewEventQueue);

	CContactDatabase& cDb = DatabaseReference();

	CContactViewCollection& cViewCollection = ViewCollectionReference();

	CContactFilteredView*	filteredView = CContactFilteredView::NewL(*viewEventQueue, cDb, *aViewBase, viewFilter);

	CleanupStack::PushL(filteredView);

	if(!aViewNotReady)

		{

		WaitForViewReady(viewEventQueue);

		}

	// append the filtered view and its events to the array which will be used for testing