/*

* Copyright (c) 2010 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:  Easy dialing plugin.

*

*/

// INCLUDE FILES

#include "easydialingplugin.h"

#include "easydialinglistbox.h"

#include "easydialinglogger.h"

#include "easydialingpanics.h"

#include "easydialingcenreplistener.h"

#include "easydialingcontactdatamanager.h"

#include "easydialingutils.h"

#include "easydialingcommands.hrh"

#include <easydialingpluginresources.rsg>

// AVKON and drawing header files

#include <gdi.h>

#include <aknlists.h>

#include <AknUtils.h>

#include <e32cmn.h>

#include <bidivisual.h>

// Predictive search header files

#include <CPsSettings.h>

#include <CPsQuery.h>

#include <CPsQueryItem.h>

#include <CPsClientData.h>

#include <CPsPattern.h>

#include <CPsRequestHandler.h>

// Virtual phonebook header files

#include <VPbkContactStoreUris.h>

#include <CVPbkContactStoreUriArray.h>

#include <TVPbkContactStoreUriPtr.h>

#include <CVPbkContactLinkArray.h>

#include <VPbkEng.rsg> // contains virtual phonebook data fields

#include <phoneui.rsg> 

// CCA Launcher header files.

#include <ccafactory.h>

#include <mccaparameter.h>

#include <mccaconnection.h>

#include <mccaconnectionext.h> 

// Service provider settings api

#include <spsettingsvoiputils.h>

// AIW header files

#include <AiwContactAssignDataTypes.h>

#include <AiwContactSelectionDataTypes.h>

// CCA contactor service.

#include "edcontactorservice.h"

// Open system trace

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "easydialingpluginTraces.h"

#endif

#include <phoneappcommands.hrh>

#include <bautils.h>    // for BaflUtils

// Transition effects

#include <gfxtranseffect/gfxtranseffect.h>

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES

// CONSTANTS

const TInt KEDMaximumMatchingContactsCount = 100;

const TInt KEasyDialingListBoxModelGranularity = 8;

const TInt KEasyDialingMaximumMatchingParts = 10;

const TInt KErrEasyDialingNoFirstNamePCSIndexing = -2000;

const TInt KErrEasyDialingNoLastNamePCSIndexing = -2001;

const TInt KEDFlushContactDataManagerLimit = 20;

const TText KHighlightSeparatorChar = 0x1F;

_LIT(KHighlightSeparatorCharAsLiteral,"\x1F");

const TText KListFieldSeparatorChar = '\t';

const TText KArabicAndSouthEastAsianRangeStart = 0x0600;

const TText KArabicAndSouthEastAsianRangeEnd = 0x19FF;

const TText KArabicPresentationFormsARangenStart = 0xFB50;

const TText KArabicPresentationFormsARangeEnd = 0xFDFF;

const TText KArabicPresentationFormsBRangenStart = 0xFE70;

const TText KArabicPresentationFormsBRangeEnd = 0xFEFF;

const TInt KMaxRunInfoArrayCount = 20;

// Transition context_uid for dialer_list component effects

#define KGfxContactListBoxUid TUid::Uid( 0x2000B47B )

const TInt KGfxContactListBoxOpenEffect  = 3;

const TInt KGfxContactListBoxCloseEffect = 4;

// MACROS

// LOCAL CONSTANTS AND MACROS

_LIT(KResourceFile, "\\resource\\easydialingpluginresources.rsc");

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

void AppendStringWithMatchDataL(

        TDes& aBuffer,

        const TDesC& aText,

        CPSRequestHandler* aPSHandler,

        const CPsQuery* aPSQuery );

TBool HighlightingSupportedForText( const TDesC& aText );

inline TBool HighlightingSupportedForScript( TText aChar );

TBool IsStrictlyBidirectional( const TDesC& aText );

static HBufC* AllocWithoutHighlightSeparatorsLC( TDesC& aDesc );

static TBool IsItuTCharacter( TChar aChar );

static TInt Find( const MVPbkContactLink* aLink, const RPointerArray<MVPbkContactLink>& aArray );

template <class T>

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

// CEasyDialingPlugin

// The default c++ constructor

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

//

CEasyDialingPlugin::CEasyDialingPlugin() 

    : iActionToBeLaunched( ENoActionDefined )

    {

    }

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

// NewL

// Create instance of concrete ECOM interface implementation.

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

//

CEasyDialingPlugin* CEasyDialingPlugin::NewL()

    {

    OstTrace0( TRACE_NORMAL, CEASYDIALINGPLUGIN_NEWL_LOAD_PLUGIN, "Loading plugin.." );

    LOGSTRING("EasyDialingPlugin: Loading plugin..");

    CEasyDialingPlugin* self = new (ELeave) CEasyDialingPlugin;

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    OstTrace0( TRACE_NORMAL, CEASYDIALINGPLUGIN_NEWL_LOAD_PLUGIN_OK, "Loading plugin completed succesfully" );

    LOGSTRING("EasyDialingPlugin: Loading plugin completed succesfully");

    return self;

    }

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

// ConstructL

// Main construction handled here. Creates connection to the predictive search

// engine and initialises all member data.

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

//

void CEasyDialingPlugin::ConstructL()

    {

    // Create a contact store array.

    HBufC* defaultCdb = VPbkContactStoreUris::DefaultCntDbUri().AllocLC();

    iContactDataStores.AppendL( defaultCdb );

    CleanupStack::Pop( defaultCdb );

    // Create a contact manager instance.

    iContactStoreUriArray = CVPbkContactStoreUriArray::NewL();

    iContactStoreUriArray->AppendL( TVPbkContactStoreUriPtr( VPbkContactStoreUris::DefaultCntDbUri() ) );

    iContactManager = CVPbkContactManager::NewL( *iContactStoreUriArray );

    // Set contact store observer to listen to contact store events.

    iContactManager->ContactStoresL().OpenAllL( *this );

    iContactDataManager = new (ELeave) CEasyDialingContactDataManager(iContactManager);

    iContactDataManager->ConstructL();

    iContactDataManager->SetObserver(this);

    // Find a handle to ca launcher extension MCCAConnectionExt.

    // Easydialing has to use the extension API, because it needs function CloseAppL

    // only found in extension.

    // MCCAConnection extension has to be obtained through MCCAParameter extension,

    // since MCCAConnection is not designed to be extensible API.

    TAny* any = parameter->CcaParameterExtension( KMCCAConnectionExtUid );

    // Parameter can be deallocated since "any" containing pointer to contact launcher

    // is not tied to parameter in any way.

    parameter->Close();

    // Cast the pointer into contact launcher object. 

    User::LeaveIfNull( any );

    iContactLauncher = static_cast<MCCAConnectionExt*>( any );

    iCenrepListener = CEasyDialingCenrepListener::NewL(this);

    iContactorService = CEDContactorService::NewL( this );

    // EasyDialing resource file is attempted to be read from the same directory where the

    // executed binary is located

    TFileName dllFileName;

    Dll::FileName( dllFileName );

    TParse parse;

    User::LeaveIfError( parse.Set(KResourceFile, &dllFileName, NULL) );

    TFileName resourceFileName( parse.FullName() );

    BaflUtils::NearestLanguageFile( iCoeEnv->FsSession(), resourceFileName );

    iResourceFileOffset = iCoeEnv->AddResourceFileL( resourceFileName );

    SetComponentsToInheritVisibility( ETrue );

    }

// ~CEasyDialingPlugin

// The desctructor

//

CEasyDialingPlugin::~CEasyDialingPlugin()

    {

    iObservers.Reset();

    if ( iContactManager )

        {

        TRAP_IGNORE( iContactManager->ContactStoresL().CloseAll( *this ) );

        }

    delete iCenrepListener;

    delete iContactDataManager;

    delete iPredictiveSearchQuery;

    delete iContactManager;

    delete iContactStoreUriArray;

    iContactDataStores.ResetAndDestroy();

    if (iPredictiveContactSearchHandler)

        {

        iPredictiveContactSearchHandler->RemoveObserver(this);

        }

    delete iPredictiveContactSearchHandler;

    delete iListBoxModel;

    if ( iContactListBox )

        {

        GfxTransEffect::Deregister( iContactListBox );

        }

    delete iContactListBox;

    if (iContactLauncher)

        {

        iContactLauncher->Close();

        }

    delete iContactorService;

    iCoeEnv->DeleteResourceFile( iResourceFileOffset );

    delete iInputBlocker;

    if ( iAsyncCallBack )

        {

        iAsyncCallBack->Cancel();

        }

    delete iAsyncCallBack;

    OstTrace0( TRACE_NORMAL, CEASYDIALINGPLUGIN_UNLOAD_PLUGIN, "Plugin unloaded" );

    LOGSTRING("EasyDialingPlugin: Plugin unloaded");

    }

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

// InitializeL

// Initialises easy dialing.

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

//

void CEasyDialingPlugin::InitializeL( CCoeControl& aParent )

    {

    SetContainerWindowL( aParent );

    SetMopParent( &aParent );

    TCallBack asyncCallBack( AsyncCallBackToLaunchAction, this );

    iAsyncCallBack = new ( ELeave ) CAsyncCallBack( asyncCallBack, 

                                                    CActive::EPriorityStandard );

    iContactListBox = new (ELeave) CEasyDialingListBox();

    iListBoxModel = new(ELeave) CDesCArrayFlat( KEasyDialingListBoxModelGranularity );

    iContactListBox->ConstructL( CEikListBox::EPaintedSelection

            | CEikListBox::ENoFirstLetterMatching

            | CEikListBox::EDisableItemSpecificMenu, 

            iContactDataManager );

    iContactListBox->SetListBoxObserver(this);

    iContactListBox->SetMopParent(this);

    CTextListBoxModel* model = iContactListBox->Model();

    model->SetItemTextArray( iListBoxModel );

    model->SetOwnershipType( ELbmDoesNotOwnItemArray );

    iContactListBox->MakeVisible( EFalse );

    iContactListBox->ActivateL();

    GfxTransEffect::Register( iContactListBox, 

                              KGfxContactListBoxUid, EFalse );

    // Do delayed initialization of PCS. PCS constructions takes a long time.

    // On the other hand, easy dialing initialization is done in phone application

    // constructor, so it contributes the whole system boot time. These are good 

    // reasons not to construct PCS in easy dialing constructor, but do it later as

    // an asynchronous operation.

    AsyncActionLaunchL( EInitializePcs );

    }

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

// Reset

// Resets easydialing plugin.

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

//

void CEasyDialingPlugin::Reset()

    {

    iDiscardCompletingSearches = ETrue;

    iNewSearchNeeded = EFalse;

    iSearchString.Zero();

    iListBoxModel->Reset();

    iNumberOfNames = 0;

    iContactListBox->MakeVisible( EFalse );

    iContactDataManager->Reset();

    if ( IsFocused() )

        {

        SetFocus( EFalse );

        }

    }

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

// InitPredictiveContactSearchL

// Initialises predictive contact search.

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

//

void CEasyDialingPlugin::InitPredictiveContactSearchL()

    {

    iPredictiveContactSearchHandler = CPSRequestHandler::NewL();

    iPredictiveContactSearchHandler->AddObserverL(this);

    // Put the searched contact fields into array.

    RArray<TInt> contact_fields;

    CleanupClosePushL(contact_fields);

    // Check which relevant contact fields are indexed in PCS search.

    iFirstNamePCSIndex = FindContactFieldPCSIndexL( R_VPBK_FIELD_TYPE_FIRSTNAME );

    iLastNamePCSIndex = FindContactFieldPCSIndexL( R_VPBK_FIELD_TYPE_LASTNAME );

    iCompanyNamePCSIndex = FindContactFieldPCSIndexL( R_VPBK_FIELD_TYPE_COMPANYNAME );

    // If first name and last name are not indexed in PCS, easy dialing plugin

    // can not function reasonably. The function leaves, which in turn causes

    // the plugin not to be initialized.

    // Company name not being indexed is not as severe case, and does not cause a leave.

    // Fields used in PCS indexing are configured in cenrep 2000B5C6.

    if ( iFirstNamePCSIndex == KErrNotFound )

        {

        OstTrace0( TRACE_ERROR, CEASYDIALINGPLUGIN_INITPREDICTIVECONTACTSEARCHL_ERROR_NO_FIRST_NAME, "ERROR, PCS does not support first name indexing!" );

        LOGSTRING("EasyDialingPlugin: PCS does not support first name indexing => Leave");

        User::Leave( KErrEasyDialingNoFirstNamePCSIndexing );

        }

    if ( iLastNamePCSIndex == KErrNotFound )

        {

        OstTrace0( TRACE_ERROR, CEASYDIALINGPLUGIN_INITPREDICTIVECONTACTSEARCHL_ERROR_NO_LAST_NAME, "ERROR, PCS does not support last name indexing!" );

        LOGSTRING("EasyDialingPlugin: PCS does not support last name indexing => Leave");

        User::Leave( KErrEasyDialingNoLastNamePCSIndexing );

        }

    // First name, last name and company name (if supported) are used in PCS search.

    contact_fields.Append(R_VPBK_FIELD_TYPE_FIRSTNAME);

    contact_fields.Append(R_VPBK_FIELD_TYPE_LASTNAME);

    if ( iCompanyNamePCSIndex != KErrNotFound )

        {

        contact_fields.Append(R_VPBK_FIELD_TYPE_COMPANYNAME);

        }

    SetSortOrderL( iContactDataManager->NameOrder() );

    // Create and fill ps settings object.

    CPsSettings* ps_settings = CPsSettings::NewL();

    CleanupStack::PushL(ps_settings);

    ps_settings->SetSearchUrisL(iContactDataStores);

    ps_settings->SetMaxResults(KEDMaximumMatchingContactsCount);

    ps_settings->SetSortType(EAlphabetical);

    ps_settings->SetDisplayFieldsL(contact_fields);

    // Set the PCS settings.

    iPredictiveContactSearchHandler->SetSearchSettingsL(*ps_settings);

    CleanupStack::PopAndDestroy(ps_settings);

    CleanupStack::PopAndDestroy(&contact_fields);

    iPredictiveSearchQuery = CPsQuery::NewL();

    }

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

// SetSortOrderL

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

//

void CEasyDialingPlugin::SetSortOrderL( CEasyDialingContactDataManager::TNameOrder aNameOrder )

    {

    RArray<TInt> fields;

    CleanupClosePushL( fields );

    if ( aNameOrder == CEasyDialingContactDataManager::EFirstnameLastname )

        {

        fields.Append(R_VPBK_FIELD_TYPE_FIRSTNAME);

        fields.Append(R_VPBK_FIELD_TYPE_LASTNAME);

        }

    else

        {

        fields.Append(R_VPBK_FIELD_TYPE_LASTNAME);

        fields.Append(R_VPBK_FIELD_TYPE_FIRSTNAME);

        }

    if ( iCompanyNamePCSIndex != KErrNotFound )

        {

        fields.Append(R_VPBK_FIELD_TYPE_COMPANYNAME);

        }

    iPredictiveContactSearchHandler->ChangeSortOrderL( *iContactDataStores[0], fields );

    CleanupStack::PopAndDestroy( &fields );

    }

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

// OfferKeyEventL

// Check the received keypad event and performs user

// actions related to it.

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

//

TKeyResponse CEasyDialingPlugin::OfferKeyEventL(const TKeyEvent& aKeyEvent, TEventCode aType)

    {

    TKeyResponse keyResponse = EKeyWasNotConsumed;

    if ( aKeyEvent.iCode == 0 && aKeyEvent.iScanCode != EStdKeyDevice3)

        {

        return keyResponse;

        }

    TInt keyCode = aKeyEvent.iCode;

    // Swap right and left key codes in mirrored layout. This needs to be done

    // also for action menu grid as CAknGrid handles arrow keys like this:

    // left key = next column (not item!) and right is previous column and

    // grid layout (LtR/RtL) is not taken into account when movement is done

    // in columns (always like in LtR layout). So if right key should move

    // focus to the right also in mirroded layout, key codes must be switched.

    // This kind of approach is used also e.g. in application grid.

    if ( AknLayoutUtils::LayoutMirrored() ) 

        {

        if ( keyCode == EKeyRightArrow ) keyCode = EKeyLeftArrow;

        else if ( keyCode == EKeyLeftArrow ) keyCode = EKeyRightArrow;

        }

    if ( IsFocused() )

        {

        if ( keyCode == EKeyUpArrow )

            {

            // if the focus is on the top-most item

            if ( iContactListBox->CurrentItemIndex() == 0)

                {

                // then focus jumps off the component.

                SetFocus( EFalse );

                DrawDeferred();

                keyResponse = EKeyWasConsumed;

                }

            else

                {

                keyResponse = iContactListBox->OfferKeyEventL( aKeyEvent, aType );

                }

            }

        else if ( keyCode == EKeyDownArrow )

            {

            // if the focus is on the bottom-most item

            if ( iContactListBox->CurrentItemIndex() == (iNumberOfNames - 1) )

                {

                // then focus jumps off the component.

                SetFocus( EFalse );

                DrawDeferred();

                keyResponse = EKeyWasConsumed;

                }

            else

                {

                keyResponse = iContactListBox->OfferKeyEventL( aKeyEvent, aType );

                }

            }

        else if ( keyCode == EKeyRightArrow )

            {

            iRememberFocus = ETrue;

            AsyncActionLaunchL( ELaunchCurrentContact );