/*

* 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:  Phonebook 2 Predictive search view stack

*

*/

#include "CPbk2ContactPositionInfo.h"

#include "cpbk2predictiveviewstack.h"

// Phonebook 2 / Virtual Phonebook

#include <MVPbkContactViewFiltering.h>

#include <CVPbkContactFindPolicy.h>

#include <VPbkEng.rsg>

#include <MVPbkViewContact.h>

#include <CVPbkContactIdConverter.h>

#include <MPbk2AppUi.h>

#include <MPbk2ApplicationServices.h>

#include <VPbkContactStoreUris.h>

#include <centralrepository.h>

#include <Phonebook2PrivateCRKeys.h>

#include <CVPbkTopContactManager.h>

#include "cpbk2filteredviewstack.h"

#include <CPbk2StoreConfiguration.h>

#include <MVPbkContactBookmarkCollection.h>

#include <CVPbkContactIdConverter.h>

#include "CPbk2PredictiveSearchFilter.h"

#include <MPbk2ContactNameFormatter.h>

#include <MPbk2ContactNameFormatter2.h>

// Predictive seard engine headers 

#include <CPsSettings.h>

#include <CPsQueryItem.h>

#include <CPsData.h>

#include <CPsRequestHandler.h>

// Debugging headers

#include <Pbk2Debug.h>

#include <bidivisual.h>

#include <fepbase.h>

#include "Phonebook2PrivateCRKeys.h"

// System includes

#include <aknsfld.h>

#include <featmgr.h>

// CONSTANTS

const TInt Kspace = ' ';

_LIT(KPsGroupDBSuffix, "?id=%d");

/// Unnamed namespace for local definitions

namespace {

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

// SendEventToObservers

// Sends events to the array of observes that take MVPbkContactViewBase.

// as a parameter.

//

// @param aView         The parameter for the NotifyFunc.

// @param aObservers    An array of MVPbkContactViewObservers.

// @param aNotifyFunc   A member function pointer of the

//                      MVPbkContactViewObserver.

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

//

template <class Observer, class NotifyFunc>

void SendEventToObservers( MVPbkContactViewBase& aView,

        RPointerArray<Observer>& aObservers,

        NotifyFunc aNotifyFunc )

    {

    const TInt count = aObservers.Count();

    for (TInt i = count-1; i >= 0 ; --i)

        {

        Observer* observer = aObservers[i];

        (observer->*aNotifyFunc)(aView);

        }

    }

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

// SendEventToObservers

// Sends events to the array of MVPbkContactViewObserver.

// Used for MVPbkContactViewObserver functions that have two extra parameters

// in addition to MVPbkContactViewBase.

//

// @param aView         The first parameter for the NotifyFunc.

// @param aObservers    An array of MVPbkContactViewObserver.

// @param aNotifyFunc   A member function pointer of the

//                      MVPbkContactViewObserver.

// @param aParam1       The second parameter for the aNotifyFunc.

// @param aParam2       The third parameter for the aNotifyFunc.

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

//

template <class Observer, class FuncPtr, class ParamType1, class ParamType2>

void SendEventToObservers( MVPbkContactViewBase& aView,

        RPointerArray<Observer>& aObservers,

        FuncPtr aNotifyFunc,

        ParamType1 aParam1, ParamType2& aParam2)

    {

    const TInt count = aObservers.Count();

    for (TInt i = count-1; i >= 0 ; --i)

        {

        Observer* observer = aObservers[i];

        (observer->*aNotifyFunc)(aView, aParam1, aParam2);

        }

    }

} /// namespace

TInt CPbk2ContactPositionInfo::CompareByPosition( 

        const CPbk2ContactPositionInfo& aFirst, 

        const CPbk2ContactPositionInfo& aSecond )

    {

    if( aFirst.iPos < aSecond.iPos )

        {

        return -1;

        }

    else if( aFirst.iPos == aSecond.iPos )

        {

        return 0;

        }

    else

        {

        return 1;

        }

    }

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

// CPbk2PredictiveViewStack::CPbk2PredictiveViewStack

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

CPbk2PredictiveViewStack::CPbk2PredictiveViewStack( CPbk2PredictiveSearchFilter& aSearchFilter,

        MPbk2ContactNameFormatter& aNameformatter ):

    CActive( EPriorityStandard ), iSearchFilter( aSearchFilter ),

    iNameformatter(aNameformatter),

    iNonMatchedMarkedContactStartIndex(KErrNotFound),

    iNonMatchedMarkedContactEndIndex(KErrNotFound)

    {

    CActiveScheduler::Add( this );

    }

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

// CPbk2PredictiveViewStack::~CPbk2PredictiveViewStack

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

//

CPbk2PredictiveViewStack::~CPbk2PredictiveViewStack()

    {

    Cancel();

    iBidiPatterns.ResetAndDestroy();

    iPatternsCollection.ResetAndDestroy();

    iStackObservers.Reset();

    iViewObservers.Reset();

    delete iConverterDefaultStore;

    delete iPsQuery;

    delete iPsHandler;

    delete iCurrentGroupLink;

    if ( iBaseView )

        {

        iBaseView->RemoveObserver( *this );

        }

    if( iPredictiveSearchResultContactLinkArrray )

        {

        iPredictiveSearchResultContactLinkArrray->ResetAndDestroy();

        delete iPredictiveSearchResultContactLinkArrray;

        }

    iTopContactPositionInfoArray.ResetAndDestroy();

    iMarkedContactsPositionInfoArray.ResetAndDestroy();

    delete iTopContactManager;

    iSearchText.Close();

    if(iFeatureManagerInitilized)

        {

        FeatureManager::UnInitializeLib();

        }

    }

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

// CPbk2PredictiveViewStack::NewL

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

//

CPbk2PredictiveViewStack* CPbk2PredictiveViewStack::NewL(

        MVPbkContactViewBase& aBaseView,

        CPbk2PredictiveSearchFilter& aSearchFilter,

        MPbk2ContactNameFormatter& aNameformatter )

    {

    CPbk2PredictiveViewStack* self = new ( ELeave ) CPbk2PredictiveViewStack( aSearchFilter,

            aNameformatter );

    CleanupStack::PushL( self );

    self->ConstructL( aBaseView );

    CleanupStack::Pop( self );

    return self;

    }

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

// CPbk2PredictiveViewStack::ConstructL

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

//

void CPbk2PredictiveViewStack::ConstructL( MVPbkContactViewBase& aBaseView )

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING(

        "CPbk2PredictiveViewStack::ConstructL"));

    iSearchedState = EFalse;

    iViewReady = EFalse;

    iBaseView = &aBaseView;

    // Initialize feature manager

    FeatureManager::InitializeLibL();

    iFeatureManagerInitilized = ETrue;

    // Initilize the PCS engine 

    InitializePCSEngineL();

    CVPbkContactManager& manager = Phonebook2::Pbk2AppUi()->

        ApplicationServices().ContactManager();

    iTopContactManager = CVPbkTopContactManager::NewL( manager );

    // Arrary for holding the search result links

    iPredictiveSearchResultContactLinkArrray = CVPbkContactLinkArray::NewL();

    // Start listening view events

    iBaseView->AddObserverL( *this );

    }

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

// CPbk2PredictiveViewStack::UpdateFilterL

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

//

void CPbk2PredictiveViewStack::UpdateFilterL( const MDesCArray& aFindStrings,

        const MVPbkContactBookmarkCollection* aAlwaysincluded,

		        TBool aAlwaysIncludedChanged )

    {

    if ( aAlwaysIncludedChanged )

        {

        // iBookMarkCollection is not owned

        iBookMarkCollection = 

            const_cast<MVPbkContactBookmarkCollection*>( aAlwaysincluded );

        }

    iPredictiveSearch = iSearchFilter.IsPredictiveActivated();

    TKeyboardModes pcsKeyboardMode( EItut );

    if ( iPredictiveSearch )

        {

        pcsKeyboardMode = EItut;

        }

    else

        {

        pcsKeyboardMode = EQwerty;

        }

    // During filtering if there were multitaps, Fep transacton is broken 

    // and search box sends canceletion of last tap, we ignore this.

    if( iPredictiveSearch && iSearchFilter.IsFiltering() )

        {

        return;

        }   

    RBuf searchText;

    iSearchFilter.GetSearchTextL( searchText );

    CleanupClosePushL( searchText );

    // Events go on up and down key, it is not good do search always twice 

    TInt compareSearchText = iSearchText.Compare(searchText);

    iSearchText.Close();

    iSearchText.CreateL(searchText.Length());

    iSearchText = searchText;

    CleanupStack::PopAndDestroy(&searchText);

    if( compareSearchText == 0 )

        {

        return;

        }

    if( !aFindStrings.MdcaCount() )

        {

        if( compareSearchText == 1 )

            {

            if( !iSearchText.Length() )

                {

                Reset();

                }

            else

                {

                ClearSearch();

                }

            }

        return;

        }

    // Delete the previous query

    delete iPsQuery;

    iPsQuery = NULL;

    // Create the new search query

    iPsQuery = CPsQuery::NewL(); 

    // Combine the search strings and create the PCS query

    for ( TInt j = 0; j < aFindStrings.MdcaCount(); j++ )

        {

        HBufC* searchString = aFindStrings.MdcaPoint(j).AllocL();

        TPtrC searchStringPtr(*searchString);    

        CleanupStack::PushL( searchString );

        for ( TInt i = 0; i < searchStringPtr.Length(); i++ )

            {    

            // Add a query item

            CPsQueryItem* item = CPsQueryItem::NewL();

            item->SetCharacter(searchStringPtr[i]); 

            TInt qwertyNumber = KErrCancel;

            if( iPredictiveSearch )

                {

                TLex numberVal( searchStringPtr.Mid(i, 1) );

                TInt num = 0;

                qwertyNumber = numberVal.Val(num);

                }

            if( qwertyNumber == KErrNone )

                {

                // Set qwerty search mode (in predictive search we can tap numbers only by long tap)

                item->SetMode( EQwerty );

                }

            else

                {

                // Set current search mode

                item->SetMode( pcsKeyboardMode );

                }

            iPsQuery->AppendL(*item);      

            }

        //Add a space in between two words

        if(aFindStrings.MdcaCount() > 1)

            {

            CPsQueryItem* item = CPsQueryItem::NewL();

            item->SetCharacter(Kspace);   

            item->SetMode(EItut);

            iPsQuery->AppendL(*item);    

            }

        //Cleanup

        CleanupStack::PopAndDestroy( searchString);

        }

    //Send the search query to the  PCS engine

    iPsHandler->SearchL(*iPsQuery);

    }

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

// CPbk2PredictiveViewStack::Reset

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

//

void CPbk2PredictiveViewStack::Reset()

    {

    PBK2_DEBUG_PRINT(PBK2_DEBUG_STRING(

        "CPbk2PredictiveViewStack::Reset: topview(0x%x), current stack level = %d"));  

    TRAP_IGNORE(iSearchFilter.ResetL());

    iPsHandler->CancelSearch();

    ClearSearch();

    }

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

// CPbk2PredictiveViewStack::ClearSearch

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

//

void CPbk2PredictiveViewStack::ClearSearch()

    {

    iNonMatchedMarkedContactStartIndex = KErrNotFound;

    iNonMatchedMarkedContactEndIndex = KErrNotFound;

    iSearchedState = EFalse;

    iPredictiveSearchResultContactLinkArrray->ResetAndDestroy();

    iTopContactPositionInfoArray.ResetAndDestroy();

    iSearchText.Close();

    SendTopViewChangedEvent( *iBaseView );

    }

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

// CPbk2PredictiveViewStack::BaseView

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

//

MVPbkContactViewBase& CPbk2PredictiveViewStack::BaseView() const

    {

    return *iBaseView;

    }

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

// CPbk2PredictiveViewStack::SetNewBaseViewL

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

//

void CPbk2PredictiveViewStack::SetNewBaseViewL(

        MVPbkContactViewBase& aBaseView )

    {

    Reset();

    // Remove observering the old base view

    if ( iBaseView )

        {

        iBaseView->RemoveObserver( *this );

        }

    iBaseView = &aBaseView;

    // Start listening to new base view

    iBaseView->AddObserverL( *this );

    }

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

// CPbk2PredictiveViewStack::Level

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

//

TInt CPbk2PredictiveViewStack::Level() const

    {

    if ( iSearchedState )

        {

        return 1;

        }

    return 0;

    }

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

// CPbk2FilteredViewStack::AddStackObserverL

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

void CPbk2PredictiveViewStack::AddStackObserverL(

        MPbk2FilteredViewStackObserver& aStackObserver )

    {

    iStackObservers.AppendL( &aStackObserver );

    }

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

// CPbk2FilteredViewStack::RemoveStackObserver

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

//

void CPbk2PredictiveViewStack::RemoveStackObserver(

        MPbk2FilteredViewStackObserver& aStackObserver )

    {

    TInt index = iStackObservers.Find( &aStackObserver );

    if ( index != KErrNotFound )

        {

        iStackObservers.Remove( index );

        }

    }

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

// CPbk2PredictiveViewStack::Type

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

//

TVPbkContactViewType CPbk2PredictiveViewStack::Type() const

    {

    return iBaseView->Type();

    }

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

// CPbk2PredictiveViewStack::ChangeSortOrderL

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

//

void CPbk2PredictiveViewStack::ChangeSortOrderL(

        const MVPbkFieldTypeList& aSortOrder )

    {

    return iBaseView->ChangeSortOrderL( aSortOrder );

    }

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

// CPbk2PredictiveViewStack::SortOrder

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

//

const MVPbkFieldTypeList& CPbk2PredictiveViewStack::SortOrder() const

    {

    return iBaseView->SortOrder();

    }

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

// CPbk2PredictiveViewStack::RefreshL

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

//

void CPbk2PredictiveViewStack::RefreshL()

    {

    return iBaseView->RefreshL();

    }

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

// CPbk2PredictiveViewStack::ContactCountL

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

//

TInt CPbk2PredictiveViewStack::ContactCountL() const

    {

    TInt count;

    if ( iSearchedState )

        {

        count = iPredictiveSearchResultContactLinkArrray->Count();

        }

    else

        {

        count = iBaseView->ContactCountL();

        }

    return count;

    }

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

// CPbk2PredictiveViewStack::ContactAtL

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

//

const MVPbkViewContact& CPbk2PredictiveViewStack::ContactAtL

        ( TInt aIndex ) const

    {

    TInt ret = BaseViewIndex( aIndex);

    User::LeaveIfError( ret );

    return iBaseView->ContactAtL( ret  );

    }

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

// CPbk2PredictiveViewStack::CreateLinkLC

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

//