/*

* Copyright (c) 2005-2007 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:  A high level class for matching phone numbers from stores.

*

*/

// INCLUDES

#include <CVPbkPhoneNumberMatchStrategy.h>

#include <CVPbkContactManager.h>

#include <CVPbkContactLinkArray.h>

#include <MVPbkContactOperation.h>

#include <MVPbkContactStoreList.h>

#include <MVPbkContactStore.h>

#include <MVPbkContactStoreProperties.h>

#include <MVPbkContactLink.h>

#include <MVPbkStoreContact.h>

#include <MVPbkSingleContactOperationObserver.h>

#include <RLocalizedResourceFile.h>

#include <VPbkDataCaging.hrh>

#include <VPbkEng.rsg>

#include <VPbkFieldTypeSelectors.rsg>

#include <CVPbkFieldTypeSelector.h>

#include <CVPbkFieldFilter.h>

#include <barsread.h>

#include <MVPbkContactFieldTextData.h>

#include <CVPbkContactStoreUriArray.h>

#include <centralrepository.h>

#include <VPbkStoreUriLiterals.h>

#include "CVPbkPhoneNumberSequentialMatchStrategy.h"

#include "CVPbkPhoneNumberParallelMatchStrategy.h"

// CONSTANTS

// Unnamed namespace for local definitions

namespace {

// --------------------------------------------------------------------------

// Phonebook Central Repository UIDs

// Copied from sf\app\contacts\phonebookui\Phonebook2\inc\Phonebook2InternalCRKeys.h

// --------------------------------------------------------------------------

//

const TUint32 KCRUidPhonebookStoreConfiguration             = 0x1020727f;

const TUint32 KPhonebookCurrentConfigurationPartialKey      = 0x00000100;

const TUint32 KPhonebookCurrentConfigurationMask            = 0xffffff00;

const TInt KInitialStoreUriSize = 22; // length of KVPbkDefaultCntDbURI

const TInt KMagicNumber = -1;

} // namespace

NONSHARABLE_CLASS(CVPbkPhoneNumberMatchStrategyImpl) :

        public CActive,

        public MVPbkContactFindObserver,

        public MVPbkSingleContactOperationObserver

    {

    public: // Construction

        static CVPbkPhoneNumberMatchStrategyImpl* NewL(

                CVPbkPhoneNumberMatchStrategy& aParent,

                const CVPbkPhoneNumberMatchStrategy::TConfig& aConfig,

                CVPbkContactManager& aContactManager,

                MVPbkContactFindObserver& aObserver);

        ~CVPbkPhoneNumberMatchStrategyImpl();

    public: // Interface

        void MatchL(const TDesC& aPhoneNumber);

        TInt MaxMatchDigits() const;

        TArray<MVPbkContactStore*> StoresToMatch() const;

        TBool IsSimStore( const MVPbkContactStore& aStore );

    private: // From CActive

        void RunL();

        void DoCancel();

        TInt RunError(TInt aError);

    private: // From MVPbkContactFindObserver

        void FindCompleteL(MVPbkContactLinkArray* aResults);

        void FindFailed(TInt aError);

    private: // From MVPbkSingleContactOperationObserver

        void VPbkSingleContactOperationComplete(

                MVPbkContactOperationBase& aOperation,

                MVPbkStoreContact* aContact);

        void VPbkSingleContactOperationFailed(

                MVPbkContactOperationBase& aOperation,

                TInt aError);

    private:

        /// Phone number types

        enum TNumberType { ENotInitialized, EUnknown, EDigit, EPlus, EOneZero, ETwoZeros };

    private: // Implementation

        CVPbkPhoneNumberMatchStrategyImpl(CVPbkPhoneNumberMatchStrategy& aParent);

        void ConstructL(

                const CVPbkPhoneNumberMatchStrategy::TConfig& aConfig,

                CVPbkContactManager& aContactManager,

                MVPbkContactFindObserver& aObserver);

        /**

         * Searches for a store that has given URI from the list of

         * stores that the contact manager has.

         * @param aUriPtr URI of the store to search for.

         * @return The store with aUriPtr, or NULL if store was not found.

         */

        MVPbkContactStore* FindStoreL(

                const TVPbkContactStoreUriPtr& aUriPtr);

        /**

         * Issues new request to be handled in RunL.

         */

        void IssueRequest();

        MVPbkContactLink* IsValidResultLC(MVPbkStoreContact* aContact);

        /**

         * Creates name tokens array

         * @param aContact which is checking, RPointerArray reference

         */

        void CreateNameTokensArrayL( MVPbkStoreContact* aContact, RPointerArray <HBufC>& aNameTokensArray );

        /**

         * Check if contact already exists in results array

         * @param aContact which is checking

         * @return True if contact exist or if array was empty.

         */

        TBool CheckContactDuplicationL( MVPbkStoreContact* aContact );

        /**

         * Gets contact's field value

         * @param aContact to get field's value from

         * @param aFieldType: EVPbkVersitNameN for Last Name 

         * EVPbkVersitNameFN for First Name

         * @return Pointer descriptor with field's value.

         */

        TPtrC NameFieldValueL( MVPbkStoreContact* aContact, TVPbkFieldTypeName aFieldType );

        TBool ValidateBestMatchingRulesL( const TDesC& aNumber );

        TBool CheckBestMatchingRules( const TDesC& aNumberA, TNumberType aNumberAType,

                const TDesC& aNumberB, TNumberType aNumberBType  );

        TInt FormatAndCheckNumberType( TDes& aNumber );

        /**

         * Reads current store configuration from central repositiry

         * @return Array of stores or NULL if error during reading form cenrep.

        */

        CVPbkContactStoreUriArray* GetCurrentStoreConfigurationL();

        /**

         * If there is in the results at least one contact

         * from currently used stores in Phonebook2 it removes from results 

         * contacts from other stores

        */

        void RefineDuplicatedNumbersL();

    private: // Data

        CVPbkPhoneNumberMatchStrategy& iParent;

        /// Ref: The contact manager instance to be used for searching.

        CVPbkContactManager* iContactManager;

        /// Ref: Observer for the searching process.

        MVPbkContactFindObserver* iObserver;

        /// Own: The find operation that is currently ongoing.

        MVPbkContactOperationBase* iOperation;

        /// Maximum number of matched digits.

        TInt iMaxMatchDigits;

        /// Flags to configure matching process, @see TVPbkPhoneNumberMatchFlags

        TUint32 iMatchFlags;

        /// Own: Array of stores that are used in matching.

        RPointerArray<MVPbkContactStore> iStoresToMatch;

        /// Own: Phone number that is being matched.

        HBufC* iPhoneNumber;

        /// Own: Intermediate results of the matching process.

        CVPbkContactLinkArray* iWorkingResults;

        /// Own: Final results of the matching process.

        CVPbkContactLinkArray* iResults;

        /// iWorkingResults index of current contact retrieval

        TInt iCurrentContact;

        /// Own: Currently retrieved contact

        MVPbkStoreContact* iStoreContact;

        /// Own: Field type selector

        CVPbkFieldTypeSelector* iFieldTypeSelector;

        /// Own: A filtered and sorted collection of Virtual Phonebook contact fields.

        CVPbkFieldFilter* iFieldFilter;

        /// Active object states

        enum TState { EMatch, ERemoveDuplicates, ERefineSearch, EComplete };

        /// Active object current state

        TState iState;

        /// Own: First Name field type selector

        CVPbkFieldTypeSelector* iFirstNameSelector;

        /// Own: Last Name field type selector

        CVPbkFieldTypeSelector* iLastNameSelector;

        /// Own: Array of tokens gotten from first and last name fields of first matched contact

        RPointerArray <HBufC> iNameTokensArray;

        /// Own: Array of tokens gotten from first and last name fields of contact

        RPointerArray <HBufC> iTempNameTokensArray;

        /// Indicates if all contact in iResult are the same

        TBool iDoubledContacts;

        /// type of iPhoneNumber

        TNumberType iPhoneNumberType;

    };

CVPbkPhoneNumberMatchStrategyImpl::CVPbkPhoneNumberMatchStrategyImpl(

        CVPbkPhoneNumberMatchStrategy& aParent) :

    CActive(CActive::EPriorityIdle),

    iParent(aParent)

    {

    CActiveScheduler::Add(this);

    }

inline void CVPbkPhoneNumberMatchStrategyImpl::ConstructL(

        const CVPbkPhoneNumberMatchStrategy::TConfig& aConfig,

        CVPbkContactManager& aContactManager,

        MVPbkContactFindObserver& aObserver)

    {

    iContactManager = &aContactManager;

    iObserver = &aObserver;

    iMaxMatchDigits = aConfig.iMaxMatchDigits;

    iMatchFlags = aConfig.iMatchFlags;

    const TInt uriCount = aConfig.iUriPriorities.Count();

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

        {

        MVPbkContactStore* store = FindStoreL(aConfig.iUriPriorities[i]);

        if (store)

            {

            iStoresToMatch.AppendL(store);

            }

        }

    VPbkEngUtils::RLocalizedResourceFile resFile;

    resFile.OpenLC(iContactManager->FsSession(),

                   KVPbkRomFileDrive,

                   KDC_RESOURCE_FILES_DIR,

                   KVPbkFieldTypeSelectorsResFileName);

    HBufC8* selectorBuf = resFile.AllocReadLC(R_VPBK_PHONE_NUMBER_SELECTOR);

    TResourceReader resReader;

    resReader.SetBuffer(selectorBuf);

    iFieldTypeSelector = CVPbkFieldTypeSelector::NewL(resReader, iContactManager->FieldTypes());

    CleanupStack::PopAndDestroy( selectorBuf );

    if ( iMatchFlags & CVPbkPhoneNumberMatchStrategy::EVPbkDuplicatedContactsMatchFlag )

    	{ 

	    HBufC8* firstNameSelectorBuf = resFile.AllocReadLC( R_VPBK_FIRST_NAME_SELECTOR );

	    resReader.SetBuffer( firstNameSelectorBuf );

	    iFirstNameSelector = CVPbkFieldTypeSelector::NewL( resReader, iContactManager->FieldTypes() );

	    CleanupStack::PopAndDestroy( firstNameSelectorBuf );

	    HBufC8* lastNameSelectorBuf = resFile.AllocReadLC( R_VPBK_LAST_NAME_SELECTOR );

	    resReader.SetBuffer( lastNameSelectorBuf );

	    iLastNameSelector = CVPbkFieldTypeSelector::NewL( resReader, iContactManager->FieldTypes() );

	    CleanupStack::PopAndDestroy( lastNameSelectorBuf );

    	}

    CleanupStack::PopAndDestroy( &resFile );

    }

CVPbkPhoneNumberMatchStrategyImpl* CVPbkPhoneNumberMatchStrategyImpl::NewL(

        CVPbkPhoneNumberMatchStrategy& aParent,

        const CVPbkPhoneNumberMatchStrategy::TConfig& aConfig,

        CVPbkContactManager& aContactManager,

        MVPbkContactFindObserver& aObserver)

    {

    CVPbkPhoneNumberMatchStrategyImpl* self =

            new(ELeave) CVPbkPhoneNumberMatchStrategyImpl(aParent);

    CleanupStack::PushL(self);

    self->ConstructL(aConfig, aContactManager, aObserver);

    CleanupStack::Pop(self);

    return self;

    }

CVPbkPhoneNumberMatchStrategyImpl::~CVPbkPhoneNumberMatchStrategyImpl()

    {

    Cancel();

    delete iFieldFilter;

    delete iFieldTypeSelector;

    delete iWorkingResults;

    delete iResults;

    delete iStoreContact;

    delete iPhoneNumber;

    delete iOperation;

    delete iFirstNameSelector;

    delete iLastNameSelector;

    iNameTokensArray.ResetAndDestroy();

    iTempNameTokensArray.ResetAndDestroy();

    iStoresToMatch.Close();

    }

void CVPbkPhoneNumberMatchStrategyImpl::MatchL(const TDesC& aPhoneNumber)

    {

    HBufC* phoneNumber = aPhoneNumber.AllocL();

    delete iPhoneNumber;

    iPhoneNumber = phoneNumber;

    iPhoneNumberType = ENotInitialized;

    if ( iWorkingResults )

        {

        iWorkingResults->ResetAndDestroy();

        }                

    if ( iResults )

        {

        iResults->ResetAndDestroy();

        }                

    iCurrentContact = KMagicNumber;

    if ( iMatchFlags & CVPbkPhoneNumberMatchStrategy::EVPbkDuplicatedContactsMatchFlag )

    	{

    	iDoubledContacts = ETrue;

    	}

    else

    	{

    	iDoubledContacts = EFalse;

    	}

    iState = EMatch;

    IssueRequest();

    }

void CVPbkPhoneNumberMatchStrategyImpl::IssueRequest()

    {

    TRequestStatus* status = &iStatus;

    User::RequestComplete(status, KErrNone);

    SetActive();

    }

void CVPbkPhoneNumberMatchStrategyImpl::RunL()

    {

    switch (iState)

        {

        case EMatch:

            {

            MVPbkContactOperation* operation = iParent.CreateFindOperationLC(*iPhoneNumber);

            if (operation)

                {

                operation->StartL();

                CleanupStack::Pop(); // operation

                delete iOperation;

                iOperation = operation;

                }

            else

                {

                // all needed operations are done if any

                iState = ERemoveDuplicates;

                IssueRequest();

                }

            break;

            }

        case ERemoveDuplicates:

            {

            const TInt count = iWorkingResults ? iWorkingResults->Count() : 0;

            CVPbkContactLinkArray* results = CVPbkContactLinkArray::NewLC();

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

                {

                MVPbkContactLink* link = iWorkingResults->At(i).CloneLC();

                if (results->Find(*link) == KErrNotFound)

                    {

                    results->AppendL(link);

                    CleanupStack::Pop(); // link

                    }

                else

                    {

                    CleanupStack::PopAndDestroy(); // link

                    }

                }

            CleanupStack::Pop(results);

            delete iWorkingResults;

            iWorkingResults = results;

            iState = ERefineSearch;

            iCurrentContact = 0;

            IssueRequest();

            break;

            }

        case ERefineSearch:

            {

            if (!iResults)

                {

                iResults = CVPbkContactLinkArray::NewL();

                }

            MVPbkContactLink* result = IsValidResultLC( iStoreContact );

            if ( result )

                {

                iResults->AppendL( result );

                CleanupStack::Pop(); // MVPbkContactLink

                if ( iDoubledContacts )

                    {

                    iDoubledContacts = CheckContactDuplicationL( iStoreContact );

                    }

                }

            delete iStoreContact;

            iStoreContact = NULL;

            const TInt count = iWorkingResults ? iWorkingResults->Count() : 0;

            if (iCurrentContact < count &&                 

                !( iResults->Count() > 0 && 

                        (iMatchFlags & CVPbkPhoneNumberMatchStrategy::EVPbkStopOnFirstMatchFlag)))

                {

                const MVPbkContactLink& link = iWorkingResults->At(iCurrentContact);

                delete iOperation;

                iOperation = NULL;

                iOperation = iContactManager->RetrieveContactL(link, *this);

                ++iCurrentContact;

                }

            else

                {

                iState = EComplete;

                IssueRequest();

                }

            break;

            }

        case EComplete:

            {

            iNameTokensArray.ResetAndDestroy();

            iTempNameTokensArray.ResetAndDestroy();

            if ( iDoubledContacts && iResults->Count() )

                {

                CVPbkContactLinkArray* results = CVPbkContactLinkArray::NewLC();

                MVPbkContactLink* link = iResults->At(0).CloneLC(); // first element

                results->AppendL( link );

                CleanupStack::Pop( 2, results ); // results, link

                delete iResults;

                iResults = results;

                }

            if ( iResults->Count() > 1 )

                {

                RefineDuplicatedNumbersL();

                }

            CVPbkContactLinkArray* results = iResults;

            iResults = NULL;            

            iObserver->FindCompleteL( results );

            break;

            }

        default:

            {

            // This case should not be possible

            User::Leave( KErrArgument );

            break;

            }

        }

    }

void CVPbkPhoneNumberMatchStrategyImpl::DoCancel()

    {

    }

TInt CVPbkPhoneNumberMatchStrategyImpl::RunError(TInt aError)

    {

    iObserver->FindFailed(aError);

    return KErrNone;

    }

inline MVPbkContactStore* CVPbkPhoneNumberMatchStrategyImpl::FindStoreL(

        const TVPbkContactStoreUriPtr& aUriPtr)

    {

    const TInt storeCount = iContactManager->ContactStoresL().Count();

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

        {

        MVPbkContactStore& store = iContactManager->ContactStoresL().At(i);

        if (store.StoreProperties().Uri().Compare(

                    aUriPtr,

                    TVPbkContactStoreUriPtr::EContactStoreUriAllComponents) == 0)

            {

            return &store;

            }

        }

    return NULL;

    }

void CVPbkPhoneNumberMatchStrategyImpl::FindCompleteL(MVPbkContactLinkArray* aResults)

    {

    // This function called by operation which is created in 

    // iParent.CreateFindOperationLC

    if (aResults)

        {

        CleanupDeletePushL( aResults ); // Take ownership

        if (!iWorkingResults)

            {

            iWorkingResults = CVPbkContactLinkArray::NewL();

            }

        const TInt count = aResults->Count();

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

            {