/*

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

*

*/

/**

 * NOTE! When running individual test cases, memory leak might be occured.

 * Check first that those leeks are not from ECom components (see documentation

 * REComSession::FinalClose()). VPbk does not use FinalClose() like it should

 * be used 'cause its only valid in debug builds.

 */

//  CLASS HEADER

#include "T_MVPbkContactStoreSingle.h"

//  EXTERNAL INCLUDES

#include <EUnitMacros.h>

#include <barsc.h>

#include <barsread.h>

#include <s32mem.h>

#include <ECom/ECom.h>

#include <bautils.h>

//  INTERNAL INCLUDES

#include <CVPbkContactManager.h>

#include <CVPbkContactViewDefinition.h>

#include <MVPbkContactStoreList.h>

#include <MVPbkContactStore.h>

#include <MVPbkFieldType.h>

#include <MVPbkContactStoreProperties.h>

#include <MVPbkStoreContactField.h>

#include <MVPbkStoreContact.h>

#include <MVPbkStoreContactFieldCollection.h>

#include <TVPbkFieldTypeMapping.h>

#include <CVPbkSortOrder.h>

#include <MVPbkContactView.h>

#include <MVPbkViewContact.h>

#include <MVPbkContactLink.h>

#include <MVPbkContactLinkArray.h>

#include <MVPbkContactOperationBase.h>

#include <MVPbkContactFieldTextData.h>

#include <MVPbkContactGroup.h>

#include <MVPbkContactStoreInfo.h>

#include <CVPbkContactStoreUriArray.h>

#include <MVPbkContactBookmark.h>

#include <CVPbkFieldTypeRefsList.h>

#include <TVPbkWordParserCallbackParam.h>

#include <VPbkContactViewFilterBuilder.h>

#include <MVPbkContactViewFiltering.h>

#include <MVPbkContactBookmarkCollection.h>

#include <CVPbkFieldTypeSelector.h>

#include <CVPbkFieldTypeIterator.h>

#include "T_ContactViewObserver.h"

#include "T_TestSuiteUtilities.h"

#include "VPbkFieldType.hrh"

#include <cntdb.h>

#include <EUnitMacros.h>

#include <barsc.h>

#include <s32mem.h>

// LOCAL

namespace 

    {

#if defined(__WINS__)

    _LIT( KResFile, "z:\\resource\\T_MVPbkContactStore.rsc" );

#else    

    _LIT( KResFile, "c:\\resource\\T_MVPbkContactStore.rsc" );

#endif // defined(__WINS__)    

	const TInt KFirstIndex = 0;

	const TInt KMaxNumOfStoreContacts = 6;

    _LIT( KFirstNameFieldValue, "Firstname value" );

    _LIT( KLastNameFieldValue, "Lastname value" );

    _LIT( KFNameFieldValuex, "xxxFirstname" );

    _LIT( KLNameFieldValuex, "xxxLastname" );

    _LIT( KAlphabet, "abcdefghijklmnopqrstuvwxyz" );

    _LIT( KFirstNameLabel, "First name" );

    _LIT( KFirstNameNewLabel, "1st name" );

    _LIT( KTelNoValue, "555-1234567890" );

    _LIT( KGroupLabel, "Grouplabel" );

    _LIT( KFindString, "a" );

    _LIT( KFindStrings, "al" );

    MVPbkStoreContactField* CreateFieldTypeL(

            MVPbkStoreContact& aStoreContact, 

            const MVPbkFieldType& aFieldType )

        {

        MVPbkStoreContactField* field = aStoreContact.CreateFieldLC( aFieldType );

        CleanupStack::Pop(); // field

        return field;

        }

    void StopScheduler( CActiveSchedulerWait& aScheduler )

        {

        if( aScheduler.IsStarted() )

            {

            aScheduler.AsyncStop();

            }

        }

    } // namespace

// CALLBACK FUNCTIONS

void T_MVPbkContactStoreSingle::StoreReady( MVPbkContactStore& aContactStore )

    {

    EUNIT_ASSERT( &iStoreList->At( 0 ) == &aContactStore );

    // Event coming straight from the store, so no OpenComplete() expected

    if( iNoOpenCompleteFlag ) 

        {

        iNoOpenCompleteFlag = EFalse;

        iLastStoreError = KErrNone;

        iLastStoreEvent = EStoreReady;

        if( iExpectedStoreEvent == iLastStoreEvent )

        	{

	        iExpectedStoreResponseFound = ETrue;

        	}

        }

    StopScheduler( iStoreScheduler );

    }

void T_MVPbkContactStoreSingle::StoreUnavailable(

        MVPbkContactStore& aContactStore, TInt aReason )

    {

    EUNIT_ASSERT( &iStoreList->At( 0 ) == &aContactStore );

    // Event coming straight from the store, so no OpenComplete() expected

    if( iNoOpenCompleteFlag )

        {

        iNoOpenCompleteFlag = EFalse;

        iLastStoreError = aReason;

        iLastStoreEvent = EOpenError;

        iExpectedStoreResponseFound = ETrue;

        StopScheduler( iStoreScheduler );

        }

    }

void T_MVPbkContactStoreSingle::HandleStoreEventL(

        MVPbkContactStore& /*aContactStore*/, 

        TVPbkContactStoreEvent /*aStoreEvent*/ )

	{

	}

void T_MVPbkContactStoreSingle::OpenComplete()

    {

    iLastStoreError = KErrNone;

    iLastStoreEvent = EOpenCompleted;

    if( iExpectedStoreEvent == iLastStoreEvent )

    	{

        iExpectedStoreResponseFound = ETrue;

    	}

    StopScheduler( iStoreScheduler );

    }

void T_MVPbkContactStoreSingle::ContactOperationCompleted(

        TContactOpResult aResult )

    {

	iLastContactOpError = KErrNone;

	iLastContactOpEvent = EContactOperationCompleted;

	if( aResult.iOpCode == EContactReadAndLock || 

	     aResult.iOpCode == EContactRead )

	    {

	    iStoreContact = aResult.iStoreContact;

	    }

    if( iExpectedContactOpEvent == iLastContactOpEvent )

    	{

        iExpectedContactOpResponseFound = ETrue;

    	}

	StopScheduler( iContactScheduler );

    }

void T_MVPbkContactStoreSingle::ContactOperationFailed(

        TContactOp /*aOpCode*/, TInt aErrorCode, TBool /*aErrorNotified*/ )

    {

    iLastContactOpError = aErrorCode;

    iLastContactOpEvent = EContactOperationFailed;

    iExpectedContactOpResponseFound = ETrue;

	StopScheduler( iContactScheduler );

    }

void T_MVPbkContactStoreSingle::VPbkSingleContactOperationComplete(

        MVPbkContactOperationBase& /*aOperation*/,

        MVPbkStoreContact* aContact )

    {

    iStoreContact = aContact;

    iLastSingleContactOpError = KErrNone;

    iLastSingleContactOpEvent = ESingleContactOperationCompleted;

    CActiveScheduler::Stop();

    }

void T_MVPbkContactStoreSingle::VPbkSingleContactOperationFailed(

        MVPbkContactOperationBase& /*aOperation*/, TInt aError )

    {

    iLastSingleContactOpError = aError;

    iLastSingleContactOpEvent = ESingleContactOperationFailed;

    CActiveScheduler::Stop();

    }

void T_MVPbkContactStoreSingle::ContactViewReady(

        MVPbkContactViewBase& /*aView*/ )

    {

    iLastViewError = KErrNone;

    iLastViewEvent = EContactViewReady;

    if( iExpectedViewEvent == iLastViewEvent )

    	{

        iExpectedViewResponseFound = ETrue;

    	}

    ++iCurViewEventCount;

    if ( iExpectedViewEventCount == iCurViewEventCount )

        {

        iExpectedViewEventCount = 1;

        iCurViewEventCount = 0;

        StopScheduler( iViewScheduler );

        }

    }

void T_MVPbkContactStoreSingle::ContactViewUnavailable(

        MVPbkContactViewBase& /*aView*/ )

    {

    iLastViewError = KErrNone;

    iLastViewEvent = EContactViewUnavailable;

    if( iExpectedViewEvent == iLastViewEvent )

    	{

        iExpectedViewResponseFound = ETrue;

    	}

    ++iCurViewEventCount;

    if ( iExpectedViewEventCount == iCurViewEventCount )

        {

        iExpectedViewEventCount = 1;

        iCurViewEventCount = 0;

        StopScheduler( iViewScheduler );

        }

    }

void T_MVPbkContactStoreSingle::ContactAddedToView(

        MVPbkContactViewBase& /*aView*/, TInt /*aIndex*/,

        const MVPbkContactLink& /*aLink*/ )

    {

    iLastViewError = KErrNone;

    iLastViewEvent = EContactAddedToView;

    if( iExpectedViewEvent == iLastViewEvent )

    	{

        iExpectedViewResponseFound = ETrue;

    	}

    ++iCurViewEventCount;

    if ( iExpectedViewEventCount == iCurViewEventCount )

        {

        iExpectedViewEventCount = 1;

        iCurViewEventCount = 0;

        StopScheduler( iViewScheduler );

        }

    }

void T_MVPbkContactStoreSingle::ContactRemovedFromView(

        MVPbkContactViewBase& /*aView*/, TInt /*aIndex*/,

        const MVPbkContactLink& /*aLink*/ )

    {

    iLastViewError = KErrNone;

    iLastViewEvent = EContactRemovedFromView;

    if( iExpectedViewEvent == iLastViewEvent )

    	{

        iExpectedViewResponseFound = ETrue;

    	}

    ++iCurViewEventCount;

    if ( iExpectedViewEventCount == iCurViewEventCount )

        {

        iExpectedViewEventCount = 1;

        iCurViewEventCount = 0;

        StopScheduler( iViewScheduler );

        }

    }

void T_MVPbkContactStoreSingle::ContactViewError(

        MVPbkContactViewBase& /*aView*/, TInt aError,

        TBool /*aErrorNotified*/ )

    {

    iLastViewError = aError;

    iLastViewEvent = EContactViewError;

    iExpectedViewResponseFound = ETrue;

    StopScheduler(iViewScheduler);

    }

void T_MVPbkContactStoreSingle::StepComplete(

        MVPbkContactOperationBase& /*aOperation*/, TInt aStepSize )

    {

    iStepCounter += aStepSize;

    iLastBatchOpError = KErrNone;

    iLastBatchOpEvent = EStepComplete;

    }

TBool T_MVPbkContactStoreSingle::StepFailed(

        MVPbkContactOperationBase& /*aOperation*/,

        TInt /*aStepSize*/,

        TInt aError )

    {

    iLastBatchOpError = aError;

    iLastBatchOpEvent = EStepFailed;

    CActiveScheduler::Stop();

    return EFalse;

    }

void T_MVPbkContactStoreSingle::OperationComplete(

        MVPbkContactOperationBase& /*aOperation*/ )

    {

    iLastBatchOpError = KErrNone;

    iLastBatchOpEvent = EOperationComplete;

    CActiveScheduler::Stop();

    }

void T_MVPbkContactStoreSingle::FindCompleteL(

        MVPbkContactLinkArray* aResults )

    {

    iContactLinks = aResults;

    iLastFindError = KErrNone;

    iLastFindEvent = EFindComplete;

    CActiveScheduler::Stop();

    }

void T_MVPbkContactStoreSingle::FindFailed( TInt aError )

    {

    iContactLinks = NULL;

    iLastFindError = aError;

    iLastFindEvent = EFindComplete;

    CActiveScheduler::Stop();

    }

// from MVPbkContactFindFromStoresObserver

void T_MVPbkContactStoreSingle::FindFromStoreSucceededL( 

        MVPbkContactStore& /*aStore*/,

        MVPbkContactLinkArray* aResultsFromStore )

    {

    // Must not return NULL

    EUNIT_ASSERT( aResultsFromStore );

    CleanupDeletePushL( aResultsFromStore );

    if( !iFindResults )

        {

        iFindResults = CVPbkContactLinkArray::NewL();

        }

    const TInt count = aResultsFromStore->Count();

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

        {

        iFindResults->AppendL( aResultsFromStore->At( i ).CloneLC() );

        CleanupStack::Pop(); // new link

        }

    CleanupStack::PopAndDestroy(); // aResultsFromStore

    iLastFindError = KErrNone;

    }

// from MVPbkContactFindFromStoresObserver

void T_MVPbkContactStoreSingle::FindFromStoreFailed(

        MVPbkContactStore& /*aStore*/, TInt aError )

    {

    iLastFindError = aError;

    }

// from MVPbkContactFindFromStoresObserver

void T_MVPbkContactStoreSingle::FindFromStoresOperationComplete()

    {

    // This is always called from find, and only one time.

    // In case search did not result in a success nor failure, e.g.

    // search with empty search terms.

    if( !iFindResults )

        {

        iFindResults = CVPbkContactLinkArray::NewL();

        }

    iLastFindEvent = EFindWithParserComplete;

    CActiveScheduler::Stop();

    }

TInt VPbkParseDataL( TAny* aParam )

    {

    TVPbkWordParserCallbackParam* param = 

        static_cast< TVPbkWordParserCallbackParam* >( aParam );

    const TText* ptr = param->iStringToParse->Ptr();

	const TText* end = ptr + param->iStringToParse->Length();

	const TText* startOfWord = NULL;

	FOREVER

		{

		// Other than alpha digit are separators

		if( ptr == end || !TChar( *ptr ).IsAlphaDigit() )

			{

			if( startOfWord )

				{

				TPtrC addWord( startOfWord, ptr - startOfWord );

				param->iWordArray->AppendL( addWord );

				startOfWord=NULL;

				}

			if( ptr == end )

			    {

			    break;

			    }

			}

		else if ( !startOfWord )

		    {

		    startOfWord = ptr;

		    }

		ptr++;

		}

	return KErrNone;

    }

// CONSTRUCTION

T_MVPbkContactStoreSingle* T_MVPbkContactStoreSingle::NewL(

        const TVPbkContactStoreUriPtr& aUri )

    {

    T_MVPbkContactStoreSingle* self = T_MVPbkContactStoreSingle::NewLC( aUri ); 

    CleanupStack::Pop();

    return self;

    }

T_MVPbkContactStoreSingle* T_MVPbkContactStoreSingle::NewLC(

        const TVPbkContactStoreUriPtr& aUri )

    {

    T_MVPbkContactStoreSingle* self = 

        new( ELeave ) T_MVPbkContactStoreSingle();

    CleanupStack::PushL( self );

	self->ConstructL( aUri );

    return self;

    }

T_MVPbkContactStoreSingle::~T_MVPbkContactStoreSingle()

    {

    delete iFindStrings;

    iFs.Close();

    delete iUriToTest;

    Teardown();

    }

T_MVPbkContactStoreSingle::T_MVPbkContactStoreSingle()

:   iNoOpenCompleteFlag( EFalse ),

    iStoreUnavailable( EFalse ),

    iExpectedViewEventCount( 1 ) // default: 1 event will stop the scheduler

    {

    }

void T_MVPbkContactStoreSingle::ConstructL(

        const TVPbkContactStoreUriPtr& aUri )

    {

    // The ConstructL from the base class CEUnitTestSuiteClass must be called.

    // It generates the test case table.

    CEUnitTestSuiteClass::ConstructL();

    iUriToTest = aUri.UriDes().AllocL();

    User::LeaveIfError( iFs.Connect() );

    TPtrC uri = iUriToTest->Des();

    EUNIT_PRINT( uri );

    // Use FinalClose() here to avoid resource and handle leaks for test

    // case scope. However, this does not eliminate DLL scope leaks that

    // may be present.

    REComSession::FinalClose();

    }

//  METHODS

void T_MVPbkContactStoreSingle::BaseSetupL(  )

    {

    CVPbkContactStoreUriArray* uriArray = CVPbkContactStoreUriArray::NewLC();

    uriArray->AppendL( TVPbkContactStoreUriPtr( *iUriToTest ) );

    iContactManager = CVPbkContactManager::NewL( *uriArray, &iFs );

    CleanupStack::PopAndDestroy( uriArray );

    iNoOpenCompleteFlag = EFalse;

    ResetTestSuiteEvents();

    }

void T_MVPbkContactStoreSingle::SetupStoreL()

    {

    BaseSetupL();

    ReplaceStoreL();

    }

void T_MVPbkContactStoreSingle::SetupViewL()

    {

    SetupStoreL();

    CreateContactViewL( iContactView, R_SORTORDER_LASTNAME_FIRSTNAME );

    }

void T_MVPbkContactStoreSingle::SetupDeleteContactsL()

    {

    SetupViewL();

    DeleteAllContactsL();

    }

void T_MVPbkContactStoreSingle::SetupDeleteContactsForMatchL()

    {

    SetupDeleteContactsL();

    // Find a telephone number field type supported by the current store

    TFileName path;        

    // NearestLanguageFile takes only TFileName

    path.Zero();

    path.Append( KResFile() );