/*

* 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 contact editor dialog implementation.

*

*/

// INCLUDE FILES

#include "CPbk2ContactEditorDlgImpl.h"

// Phonebook 2

#include "Pbk2UIControls.hrh"

#include "MPbk2ContactEditorStrategy.h"

#include "CPbk2ContactEditorFieldArray.h"

#include "MPbk2ContactEditorField.h"

#include <MPbk2ContactEditorField2.h>

#include "CPbk2AddItemManager.h"

#include "Pbk2TitlePanePictureFactory.h"

#include "TPbk2DeleteItemManager.h"

#include <MPbk2StoreObservationRegister.h>

#include <MPbk2ApplicationServices.h>

#include <CPbk2PresentationContact.h>

#include <CPbk2PresentationContactField.h>

#include <CPbk2PresentationContactFieldCollection.h>

#include <MPbk2FieldProperty.h>

#include <MPbk2FieldProperty2.h>

#include <CPbk2FieldPropertyArray.h>

#include <Pbk2UIControls.rsg>

#include <MPbk2ContactNameFormatter.h>

#include <MPbk2ContactEditorExtension.h>

#include <CPbk2StoreConfiguration.h>

#include <CPbk2ContactRelocator.h>

#include <MPbk2ContactEditorEventObserver.h>

#include <MPbk2EditedContactObserver.h>

#include <CPbk2UIExtensionManager.h>

#include <MPbk2UIExtensionFactory.h>

#include <MPbk2ContactEditorContactRelocator.h>

#include <CPbk2AppUiBase.h>

#include <CPbk2StorePropertyArray.h>

#include <CPbk2StoreProperty.h>

#include <MPbk2ExitCallback.h>

#include <CPbk2IconInfoContainer.h>

#include <CPbk2IconFactory.h>

#include "Pbk2RingtoneCommands.h" 

#include "Pbk2ImageCommands.h"

#include "CPbk2ContactEditorUIAddressField.h"

#include "MPbk2ContactEditorUIField.h"

#include "Pbk2ContactEditorFieldFactory.h"

#include "Pbk2AddressTools.h"

#include "MPbk2UIField.h"

#include "CPbk2ContactEditorRingtoneField.h"

#include "CPbk2ContactEditorImageField.h"

#include "CPbk2ContactEditorReadonlyField.h" 

#include "Pbk2EditorLineIds.hrh" 

#include <Pbk2Config.hrh>

#include <Pbk2Commands.hrh>

#include "Pbk2FieldProperty.hrh"

#include "Pbk2IconId.hrh"

#include <Pbk2UID.h>

#include <pbk2mapcommands.hrh>

// Virtual Phonebook

#include <CVPbkContactManager.h>

#include <MVPbkStoreContact.h>

#include <MVPbkContactStore.h>

#include <MVPbkContactFieldTextData.h>

#include <MVPbkContactStoreProperties.h>

#include <MVPbkContactFieldData.h>

#include <MVPbkFieldType.h>

#include <TVPbkFieldVersitProperty.h>

#include <VPbkEng.rsg> 

#include <VPbkFieldType.hrh>

#include <VPbkContactStoreUris.h>

// System includes

#include <akntitle.h>

#include <aknnavi.h>

#include <StringLoader.h>

#include <eikcapc.h>

#include <barsread.h>

#include <aknnotewrappers.h>

#include <hlplch.h>

#include <aknnavide.h>

#include <akninputblock.h>

/// Unnamed namespace for local definitions

namespace {

const TInt KEditorNameFormatFlags = MPbk2ContactNameFormatter::EUseSeparator;

#ifdef _DEBUG

enum TPanicCode

    {

    EHandleControlStateChangeL_NullField = 1,

    EPanic_IsControlEmptyL_OOB,

    EPanic_EditorField_OOB

    };

void Panic(TInt aReason)

    {

    _LIT(KPanicText, "CPbk2ContactEditorDlgImpl");

    User::Panic(KPanicText, aReason);

    }

#endif // _DEBUG

/**

 * Displays a store not available note.

 *

 * @param aName     Store name.

 */

void ShowStoreNotAvailableNoteL( const TDesC& aName )

    {

    if ( aName.Length() > 0 )

        {

        HBufC* text = StringLoader::LoadLC( R_QTN_PHOB_STORE_NOT_AVAILABLE,

            aName );

        CAknInformationNote* note = new ( ELeave ) CAknInformationNote;

        note->ExecuteLD( *text );

        CleanupStack::PopAndDestroy( text );

        }

    }

/**

 * Decides whether to leave or not in case of an error.

 * Performs some filtering of errors.

 *

 * @param aError    Error code.

 */

void DecideToLeaveL( TInt aError )

    {

    if ( aError != KErrInUse && aError != KErrNone )

        {

        User::Leave( aError );

        }

    }

} /// namespace

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

// CPbk2ContactEditorDlgImpl::CPbk2ContactEditorDlgImpl

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

//

CPbk2ContactEditorDlgImpl::CPbk2ContactEditorDlgImpl

    ( TPbk2ContactEditorParams& aParams,

      CPbk2PresentationContact& aContact,

      CPbk2FieldPropertyArray& aFieldProperties,

      MPbk2EditedContactObserver& aContactObserver,

      MPbk2ContactEditorStrategy& aEditorStrategy,

      MPbk2ContactEditorContactRelocator& aRelocator,

      MPbk2ApplicationServices* aAppServices,

      HBufC* aTitleText ) :

        iParams( aParams ),

        iEditorStrategy( aEditorStrategy ),

        iFieldProperties( aFieldProperties ),

        iContact( aContact ),

        iContactObserver( aContactObserver ),

        iRelocator( aRelocator ),

        iEndKeyWasPressed( EFalse ),

        iAddressViewStandalone( EFalse ),

        iAppServices( aAppServices ),

    {

    // Exit is approved by default

    iExitRecord.Set( EExitApproved );

    }

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

// CPbk2ContactEditorDlgImpl::~CPbk2ContactEditorDlgImpl

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

//

CPbk2ContactEditorDlgImpl::~CPbk2ContactEditorDlgImpl()

    {

    if ( iWaitFinish && iWaitFinish->IsStarted() )

        {

        iWaitFinish->AsyncStop();

        }

    delete iWaitFinish;

    delete iInputBlock;

    if ( iSelfPtr )

        {

        *iSelfPtr = NULL;

        }

    if( iAppServices )

    	{

    	iAppServices->StoreObservationRegister().DeregisterStoreEvents( *this );

    	}

    else

    	{

    	Phonebook2::Pbk2AppUi()->ApplicationServices().

    	        StoreObservationRegister().DeregisterStoreEvents( *this );

    	}

    if ( iEikonEnv && iContextMenuBar )

        {

        iEikonEnv->EikAppUi()->RemoveFromStack( iContextMenuBar );

        delete iContextMenuBar;

        }

    // Restore the titlepane text

    if (iTitlePane && iStoredTitlePaneText)

        {

        }

    // Reset title pane picture

    if( iTitlePane )

        {

        iTitlePane->SetSmallPicture( NULL, NULL, EFalse );

        }

    // Remove empty status pane

    if (iNaviContainer)

        {

        iNaviContainer->Pop();

        }

    delete iStoreContact;

    delete iFieldFactory;

    delete iPbk2BaseCommand;

    delete iEditorExtension;

    delete iUiFieldArray;

    Release(iExtensionManager);

	delete iTitleText;    

    }

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

// CPbk2ContactEditorDlgImpl::NewL

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

//

CPbk2ContactEditorDlgImpl* CPbk2ContactEditorDlgImpl::NewL(

        TPbk2ContactEditorParams& aParams,

        CPbk2PresentationContact& aContact,

        CPbk2FieldPropertyArray& aFieldProperties,

        MPbk2EditedContactObserver& aContactObserver,

        MPbk2ContactEditorStrategy& aEditorStrategy,

        MPbk2ContactEditorContactRelocator& aRelocator)

    {	

    CPbk2ContactEditorDlgImpl* self =

        new ( ELeave ) CPbk2ContactEditorDlgImpl(aParams, aContact,

            aFieldProperties, aContactObserver,

            aEditorStrategy, aRelocator);

    CleanupStack::PushL(self);

    self->ConstructL();

    CleanupStack::Pop(self);

    return self;

    }

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

// CPbk2ContactEditorDlgImpl::NewL

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

//

CPbk2ContactEditorDlgImpl* CPbk2ContactEditorDlgImpl::NewL(

		TPbk2ContactEditorParams& aParams,

		CPbk2PresentationContact& aContact,

		CPbk2FieldPropertyArray& aFieldProperties,

		MPbk2EditedContactObserver& aContactObserver,

		MPbk2ContactEditorStrategy& aEditorStrategy,

		MPbk2ContactEditorContactRelocator& aRelocator,

		MPbk2ApplicationServices* aAppServices,

		HBufC* aTitleText )

	{

	CPbk2ContactEditorDlgImpl* self =

		new ( ELeave ) CPbk2ContactEditorDlgImpl(aParams, aContact,

			aFieldProperties, aContactObserver,

			aEditorStrategy, aRelocator, aAppServices, aTitleText );

	CleanupStack::PushL(self);

	self->ConstructL();

	CleanupStack::Pop(self);

	return self;

	}

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

// CPbk2ContactEditorDlgImpl::ConstructL

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

//

void CPbk2ContactEditorDlgImpl::ConstructL()

    {

    CAknDialog::ConstructL(R_PBK2_CONTACTEDITOR_MENUBAR);

    if(iParams.iActiveView != TPbk2ContactEditorParams::EEditorView)

        {

        iParams.iFocusedContactField = NULL;

        }

    if(iParams.iFocusedContactField)

        {

        const MVPbkFieldType* type = iParams.iFocusedContactField->BestMatchingFieldType();

        const TArray<TVPbkFieldVersitProperty> propArr = type->VersitProperties();

        if(propArr.Count())

            {

            const TVPbkFieldVersitProperty prop = propArr[0];

            if(prop.Name() == EVPbkVersitNameADR)

                {

                if(prop.Parameters().Contains(EVPbkVersitParamHOME))

                    {

                    iParams.iActiveView = TPbk2ContactEditorParams::EEditorAddressHomeView;

                    }

                else if(prop.Parameters().Contains(EVPbkVersitParamWORK))

                    {

                    iParams.iActiveView = TPbk2ContactEditorParams::EEditorAddressOfficeView;

                    }

                else

                    {

                    iParams.iActiveView = TPbk2ContactEditorParams::EEditorAddressView;

                    }

                iAddressViewStandalone = ETrue;

                iParams.iFocusedContactField = NULL;

                }

            }

        }

    // Register to listen store events, so that we can close editor if

    // iContact's store becomes unavailable.

    /*

	 * Use iAppServices if provided. This is to enable editor use outside from pbk2 context

	 */

    if( iAppServices )

    	{

    	iAppServices->StoreObservationRegister().RegisterStoreEventsL( *this );

    	iNameFormatter = &iAppServices->NameFormatter();

    	}

    else

    	{

    	Phonebook2::Pbk2AppUi()->ApplicationServices().

			StoreObservationRegister().RegisterStoreEventsL( *this );

    	iNameFormatter =

    	        &Phonebook2::Pbk2AppUi()->ApplicationServices().NameFormatter();

    	}

    StoreTitlePaneTextL();

    ConstructContextMenuL();

    ConstructNaviPaneL();

    iExtensionManager = CPbk2UIExtensionManager::InstanceL();

    /*

	 * Use iAppServices if provided. This is to enable editor use outside from pbk2 context

	 */

    CVPbkContactManager* manager = NULL;

    if( iAppServices )

    	{

    	manager = &iAppServices->ContactManager();

    	}

    else

    	{

    	manager = &Phonebook2::Pbk2AppUi()->ApplicationServices().ContactManager();

    	}

    iEditorExtension = iExtensionManager->FactoryL()->

        CreatePbk2ContactEditorExtensionL( *manager, iContact, *this );

    iFieldFactory = CPbk2ContactEditorFieldFactory::NewL(*this, *iEditorExtension);

    iUiFieldArray = CPbk2ContactEditorFieldArray::NewL(

    *manager, iContact, *this, *iFieldFactory, iAppServices );	

    iUseState = EUseReady;

    }

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

// CPbk2ContactEditorDlgImpl::ExecuteLD

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

//

void CPbk2ContactEditorDlgImpl::ExecuteLD()

    {

    CleanupStack::PushL( this );

    // Set status pane layout to the Phonebook 2 one

    CEikStatusPane* statusPane = iAvkonAppUi->StatusPane();

    if (statusPane)

        {

        statusPane->SwitchLayoutL(R_AVKON_STATUS_PANE_LAYOUT_USUAL);

        }

    CleanupStack::Pop( this );

    CAknForm::ExecuteLD(R_PBK2_EDIT_MEMORY_ENTRY_DIALOG);

    }

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

// CPbk2ContactEditorDlgImpl::CreateCustomControlL

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

//

SEikControlInfo CPbk2ContactEditorDlgImpl::CreateCustomControlL(

    TInt /*aControlType*/ )

    {

    iLastCreatedCustomControl = NULL;

    SEikControlInfo control = {NULL, 0, 0};

    iLastCreatedCustomControl = new (ELeave) CPbk2ContactEditorReadonlyField();  

    control.iControl = iLastCreatedCustomControl; 

    control.iTrailerTextId = 0;

    control.iFlags = 0;

    return control;

    }

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

// CPbk2ContactEditorDlgImpl::ContactEditorUiBuilderExtension

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

//

TAny* CPbk2ContactEditorDlgImpl::ContactEditorUiBuilderExtension( 

    TUid /*aExtensionUid*/ )

    {

    //return extension point of MPbk2ContactEditorUiBuilderExtension

    return static_cast<MPbk2ContactEditorUiBuilderExtension*>(this);

    }

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

// CPbk2ContactEditorDlgImpl::AddCustomFieldToFormL

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

//   

CCoeControl* CPbk2ContactEditorDlgImpl::AddCustomFieldToFormL(

    TInt aIndex,TInt aResourceId)

    {

    InsertLineL(aIndex, aResourceId);

    // Return value is updated in CreateCustomControlL()

    return iLastCreatedCustomControl;

    }

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

// CPbk2ContactEditorDlgImpl::HandleCustomFieldCommandL

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

//   

TBool CPbk2ContactEditorDlgImpl::HandleCustomFieldCommandL(TInt aCommand )

    {

    ProcessCommandL( aCommand );

    return ETrue;

    }

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

// CPbk2ContactEditorDlgImpl::ConvertCustomControlTypeToBaseControlType()

// Provide correct base type for custom contols

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

//

MEikDialogPageObserver::TFormControlTypes CPbk2ContactEditorDlgImpl::

    ConvertCustomControlTypeToBaseControlType(TInt aControlType) const

    {

    MEikDialogPageObserver::TFormControlTypes ret = 

        MEikDialogPageObserver::EUnknownType;

    switch(aControlType)

        {

        case EPbk2FieldCtrlTypeImageEditor:

        case EPbk2FieldCtrlTypeRingtoneEditor:

        case EPbk2FieldCtrlTypeExtAddressEditor:

        case EPbk2FieldCtrlTypeExtAddressHomeEditor:

        case EPbk2FieldCtrlTypeExtAddressOfficeEditor:

        case EPbk2FieldCtrlTypeExtAssignFromMapsEditor:

        {

            ret = MEikDialogPageObserver::EEdwinDerived;

            }

            break;

        default:

            {

            ret = MEikDialogPageObserver::EUnknownType;

            }

            break;

        }

    return ret;

    }

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

// CPbk2ContactEditorDlgImpl::HandlePointerEventL

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

//

void CPbk2ContactEditorDlgImpl::HandlePointerEventL( 

    const TPointerEvent& aPointerEvent )

    {

    //Here we can prevent recursive execution of ExecuteBaseCommandL if needed 

    //as touch events are handled in it too. So it may case multiple callbacks to here if 

    //user repeats the same pointer event very quickly using options menu.

    // if(!iCommandPending) //seems that this check is not needed

        {

        CAknForm::HandlePointerEventL( aPointerEvent );

        }

    }

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

// CPbk2ContactEditorDlgImpl::HandleResourceChange

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

//

void CPbk2ContactEditorDlgImpl::HandleResourceChange( TInt aType )

    {

    // Handle change in layout orientation

    if ( aType == KEikDynamicLayoutVariantSwitch )

        {

        // Set status pane layout to the Phonebook 2 one

        CEikStatusPane* statusPane = iAvkonAppUi->StatusPane();

        if ( statusPane )

            {

            TRAP_IGNORE(

                    statusPane->SwitchLayoutL(

                            R_AVKON_STATUS_PANE_LAYOUT_USUAL

                            )

            );

            }

        }

    CAknForm::HandleResourceChange( aType );

    }

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

// CPbk2ContactEditorDlgImpl::AddItemToContactL

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

//

void CPbk2ContactEditorDlgImpl::AddItemToContactL

      ( TInt aFieldTypeResourceId,

        const TDesC& aFieldTypeXspName, 

        TBool aSetFocus )

    {

    // Store the original parameter value, since it is