/*

* Copyright (c) 2006 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:  IMSSettingsWizard.cpp

*

*/

// INCLUDE FILES

#include <e32base.h>

#include <badesca.h>                // CDesCArrayFlat

#include <avkon.hrh>                // Softkey enumerations

#include <cemailaccounts.h>         // CEmailAccounts

#include <smtpset.h>                // CImSmtpSettings

#include <imapset.h>                // CImImap4Settings

#include <pop3set.h>                // CImPop3Settings

#include <iapprefs.h>               // CImIAPPreferences

#include <StringLoader.h>           // StringLoader

#include <aknmessagequerydialog.h>  // CAknMessageQueryDialog

#include <MuiuMsvUiServiceUtilities.h> // MsvUiServiceUtilities

#include <eikrted.h>                // CEikRichTextEditor

#include <txtrich.h>                // CRichText

#include <AknInfoPopupNoteController.h>

#include <mtudcbas.h>				// CBaseMtmUiData

#include <mtmuibas.h>		        // CBaseMtmUi

#include <mtsr.h>                   // CMtmRegistryControl

#include <MtmExtendedCapabilities.hrh>

#include <MTMStore.h>				// CMtmStore

#include "MuiuDynamicSettingsItemFinderInterface.h"

#include "MuiuDynamicSettingsDialog.h"

#include <SendUiConsts.h>

#include <ImumUtils.rsg>

#include "ImumInSettingsData.h"

#include "ImumInternalApiImpl.h"

#include "ImumInMailboxServicesImpl.h"

#include "IMSSettingsNoteUi.h"

#include "IMSSettingsWizard.h"

#include "IMSWTextEditorPage.h"

#include "IMSWRadiobuttonPage.h"

#include "IMSSettingsItemApprover.h"

#include "IMASPageIds.hrh"

#include "EmailUtils.H"

#include "EmailFeatureUtils.h"

#include "ComDbUtl.h"               // CMsvCommDbUtilities

#include "ImumUtilsLogging.h"

#include "ImumPanic.h"

#include "IMSWizardControl.h"

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES

// CONSTANTS

const TText KIMASCharDot = '.';

const TText KIMASCharAt = '@';

const TInt KMaxPages = 6;

const TInt KMsToWaitBeforePopup = 2000;

const TInt KMsToWaitBeforeRePopup = 6000;

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

// ============================ MEMBER FUNCTIONS ===============================

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

// CIMSSettingsWizard::CIMSSettingsWizard()

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

//

CIMSSettingsWizard::CIMSSettingsWizard(

    CIMSSettingsUi& aDialog,

    CImumInternalApiImpl& aMailboxApi,

    CEikFormattedCellListBox& aListBox,

    CIMSWizardControl& aHelpContainer,

    CAknTitlePane& aTitlePane,

    CMuiuFlags& aFlags )

    :

    CIMSSettingsBaseUI( aDialog, aMailboxApi, aListBox,

    					aTitlePane, aFlags ),

    iCurrentItem( KNullUid ),

    iWizState( EWizStateQuerying ),

    iPageEdit( NULL ),

    iPageRadioBtn( NULL ),

    iCurPage( 0 ),

    iPageText( NULL ),

    iHelpContainer( aHelpContainer )

    {

    }

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

// CIMSSettingsWizard::~CIMSSettingsWizard()

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

//

CIMSSettingsWizard::~CIMSSettingsWizard()

    {

    IMUM_CONTEXT( CIMSSettingsWizard::~CIMSSettingsWizard, 0, KLogUi );

    IMUM_IN();

    iProtocolArray.Close();

    delete iPageText;

    delete iMtmStore;

    iPageEdit = NULL;

    iPageRadioBtn = NULL;

    if ( iWizardLauncher )

        {

        iWizardLauncher->Cancel();

        }

    delete iWizardLauncher;

    IMUM_OUT();

    }

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

// CIMSSettingsWizard::ConstructL()

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

//

void CIMSSettingsWizard::ConstructL( CEikButtonGroupContainer& aSoftkeys,

    const TDesC& aEmailAddress )

    {

    IMUM_CONTEXT( CIMSSettingsWizard::ConstructL, 0, KLogUi );

    IMUM_IN();

    BaseUiConstructL( aSoftkeys, R_IMAS_WIZARD );

	iMtmStore = CMtmStore::NewL(iMailboxApi.MsvSession());

    // Clear the flags

    for ( TUint flag = EWizFlagLastFlag; --flag >= EWizFlagFirstFlag; )

        {

        ClearFlag( flag );

        }

    SettingsStartedL( aEmailAddress );

    // Hide the unnecessary scrollbar from the first page of the wizard

    CEikScrollBarFrame* scrollbar = iListBox.ScrollBarFrame();

    if ( scrollbar )

    	{

    	scrollbar->SetScrollBarVisibilityL( CEikScrollBarFrame::EOff, CEikScrollBarFrame::EOff );    	

    	}

	IMUM_OUT();

    }

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

// CIMSSettingsWizard::NewL()

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

//

CIMSSettingsWizard* CIMSSettingsWizard::NewL(

    CIMSSettingsUi& aDialog,

    CImumInternalApiImpl& aMailboxApi,

    CEikFormattedCellListBox& aListBox,

    CIMSWizardControl& aHelpContainer,

    CAknTitlePane& aTitlePane,

    CEikButtonGroupContainer& aSoftkeys,

    CMuiuFlags& aFlags,

    const TDesC& aEmailAddress )

    {

    CIMSSettingsWizard* self = NewLC(

        aDialog, aMailboxApi,

        aListBox, aHelpContainer, aTitlePane, aSoftkeys, aFlags, aEmailAddress );

    CleanupStack::Pop( self );

    return self;

    }

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

// CIMSSettingsWizard::NewLC()

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

//

CIMSSettingsWizard* CIMSSettingsWizard::NewLC(

    CIMSSettingsUi& aDialog,

    CImumInternalApiImpl& aMailboxApi,

    CEikFormattedCellListBox& aListBox,

    CIMSWizardControl& aHelpContainer,

    CAknTitlePane& aTitlePane,

    CEikButtonGroupContainer& aSoftkeys,

    CMuiuFlags& aFlags,

    const TDesC& aEmailAddress )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsWizard::NewLC, 0, utils, KLogUi );

    IMUM_IN();

    CIMSSettingsWizard* self =

        new ( ELeave ) CIMSSettingsWizard(

            aDialog, aMailboxApi,

            aListBox, aHelpContainer, aTitlePane, aFlags );

    CleanupStack::PushL( self );

    self->ConstructL( aSoftkeys, aEmailAddress );

	IMUM_OUT();

    return self;

    }

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

// CIMSSettingsWizard::DefinePageNumberStringL()

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

//

void CIMSSettingsWizard::DefinePageNumberStringL()

    {

    IMUM_CONTEXT( CIMSSettingsWizard::DefinePageNumberStringL, 0, KLogUi );

    IMUM_IN();

    CArrayFix<TInt>* array = new ( ELeave ) CArrayFixFlat<TInt>( 1 );

    CleanupStack::PushL( array );

    // If current page is zero, increase it to 1

    if ( iCurPage == 0 )

    	{

    	iCurPage++;

    	}

    array->AppendL( iCurPage );

    array->AppendL( KMaxPages );

    delete iPageText;

    iPageText = NULL;

    // Load page number to descriptor

	iPageText = StringLoader::LoadL(

	R_MBXS_SETTINGS_MAIL_NEWBOX_PAGES, *array );

    CleanupStack::PopAndDestroy( array );

    array = NULL;

    IMUM_OUT();

    }

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

// CIMSSettingsWizard::SettingsStartedL()

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

//

TBool CIMSSettingsWizard::SettingsStartedL( const TDesC& aEmailAddress )

    {

    IMUM_CONTEXT( CIMSSettingsWizard::SettingsStartedL, 0, KLogUi );

	IMUM_IN();

    // Set the titlepane text

    HBufC* text = StringLoader::LoadL( R_MBXS_SETTINGS_NEW_BOX );

    CleanupStack::PushL( text );

    SetTitlePaneTextL( *text );

    CleanupStack::PopAndDestroy( text );

    HidePermanently( ToUid( EIMAWRadioButtonIapAlwaysAsk ), ETrue );

    CMuiuSettingsEditText* email = static_cast<CMuiuSettingsEditText*>(

        GetItem( TUid::Uid( EIMAWEmailAddress ) ) );

    TMuiuSettingsText emailText;

    if ( aEmailAddress.Length() )

        {

        emailText = aEmailAddress;

        email->SetText( &emailText );

        SettingsItemDefineServers( *email->Text() );

        SettingsItemDefineMailboxName( *email->Text() );

        SetFlag( EWizFlagSkipEmail );

        SetFlag( EWizFlagPluginDetected );

        iWizardLauncher = CIMSWizardLauncher::NewL( *this, iDialog );

        //Next prevents the original info screen and buttons from flashing

        //on the screen

        iSoftkeys->SetVisibility( EFalse, this );

        if ( iHelpContainer.CountComponentControls() )

            {

            iHelpContainer.ComponentControl( 0 )->MakeVisible( EFalse );

            }

        }

    else

        {

        // Hide the listbox and the helpscreen

        // The buttons should be hidden here too for the dialog

        SetHideItems( ETrue, R_IMAS_WIZARD, ETrue );

        iDialog.MakeLineVisible( EIMSWizardRichTxtEditorContainer, ETrue);

        //TMuiuSettingsText at;

        emailText.Append( KIMASCharAt );

        email->SetText( &emailText );

        }

	IMUM_OUT();

    return EFalse;

    }

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

// CIMSSettingsWizard::OkToExitL()

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

//

TInt CIMSSettingsWizard::OkToExitL( const TInt /* aButtonId */ )

    {

    IMUM_CONTEXT( CIMSSettingsWizard::OkToExitL, 0, KLogUi );

    IMUM_IN();

    // If wizard is running (setting page is on display), let setting page

    // and wizard loop to exit before exiting. Save exit flags to reinstate

    // them when wizard loop exists.

    if ( Flag( EWizFlagStateRunning ) )

        {

        ChangeFlag( EWizFlagShouldExit, Flag( EImumSettingShouldExit ) );

        ChangeFlag( EWizFlagShouldClose, Flag( EImumSettingShouldClose ) );

        IMUM_OUT();

        return EFalse;

        }

    // Show query for exit

    TInt result = 1;

    // Check if user has to be asked about the exit

    if ( Flag( EImumSettingQueryClose ) && !Flag( EWizFlagForcedCancel ))

        {

        if ( !Flag( EWizFlagCompleted ) )

            {

            result = CIMSSettingsNoteUi::ShowQueryL(

	                R_MBXS_SETTINGS_NEW_BOX_EXIT_QUERY,

	                R_EMAIL_CONFIRMATION_QUERY );

            if ( !result && Flag( EWizFlagPluginDetected ) )

                {

                iWizardLauncher->StartLauncher();

                ClearFlag( EWizFlagShouldExit );

                ClearFlag( EWizFlagShouldClose );

                }

            }

        }

	IMUM_OUT();

    return result;

    }

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

// CIMSSettingsWizard::KeyPressSoftkey()

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

//

TBool CIMSSettingsWizard::KeyPressSoftkey(

    const TInt aButton )

    {

    IMUM_CONTEXT( CIMSSettingsWizard::KeyPressSoftkey, 0, KLogUi );

    IMUM_IN();

    TInt error = KErrNone;

    // Check which of the keys has been pressed

    if ( aButton == EAknSoftkeyBack )

        {

        if ( iWizState == EWizStateQuerying )

            {

            SetFlag( EImumSettingShouldClose );

            }

        else

            {

            TRAP( error, KeyPressBackL() );

            }

        }

    else

        {

        if ( iWizState == EWizStateQuerying )

            {

			WizRunStart();

            TRAP( error,

            		while( Flag( EWizFlagStateRunning ) )

            				 {

            				 WizRunStepL();

            				 } );

            }

        else

            {

            TRAP( error, KeyPressNextL() );

            }

        }

    __ASSERT_DEBUG( error == KErrNone,

        User::Panic( KIMSWizardPanic, error ) );

    IMUM_OUT();

    return ETrue;

    }

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

// CIMSSettingsWizard::KeyPressOKButtonL()

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

//

TBool CIMSSettingsWizard::KeyPressOKButtonL( const TInt /* aButton */ )

    {

    IMUM_CONTEXT( CIMSSettingsWizard::KeyPressOKButtonL, 0, KLogUi );

    IMUM_IN();

    // In help screen, ok button opens the first page

    if ( iWizState == EWizStateQuerying )

        {

        KeyPressSoftkey( EAknSoftkeyShow );

        }

    // Text page editing ongoing, call correct page

    else if ( iSettingPage && Flag( EWizFlagTextEditPage ) )

        {

        iPageEdit->KeyPressedSelectL();

        }

    // Radio button page editing ongoing, call correct page

    else if ( iSettingPage && Flag( EWizFlagRadioButtonPage ) )

        {

        iPageRadioBtn->KeyPressedSelectL();

        }

    else

        {

        // Nothing

        }

	IMUM_OUT();

    return ETrue;

    }

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

// CIMSSettingsWizard::KeyPressNextL()

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

//

void CIMSSettingsWizard::KeyPressNextL()

    {

    IMUM_CONTEXT( CIMSSettingsWizard::KeyPressNextL, 0, KLogUi );

    IMUM_IN();

    SetFlag( EWizFlagNextKeyPressed );

    // Text page editing ongoing, call correct page

    if ( iSettingPage && Flag( EWizFlagTextEditPage ) )

        {

        iPageEdit->KeyPressedNextL();

        }

    // Radio button page editing ongoing, call correct page

    else if ( iSettingPage && Flag( EWizFlagRadioButtonPage ) )

        {

        iPageRadioBtn->KeyPressedNextL();

        }

    else

        {

        // Nothing

        }

	IMUM_OUT();

    }

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

// CIMSSettingsWizard::KeyPressBackL()

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

//

void CIMSSettingsWizard::KeyPressBackL()

    {

    IMUM_CONTEXT( CIMSSettingsWizard::KeyPressBackL, 0, KLogUi );

    IMUM_IN();

    SetFlag( EWizFlagBackKeyPressed );

    // Text page editing ongoing, call correct page

    if ( iSettingPage && Flag( EWizFlagTextEditPage ) )

        {

        iPageEdit->KeyPressedBackL();

        }

    // Radio button page editing ongoing, call correct page

    else if ( iSettingPage && Flag( EWizFlagRadioButtonPage ) )

        {

        iPageRadioBtn->KeyPressedBackL();

        }

    else

        {

        // Nothing

        }

    if ( Flag( EWizFlagPluginDetected ) && iCurrentItem.iUid == EIMAWProtocol )

        {

        SetFlag( EImumSettingShouldClose );

        }

    IMUM_OUT();

    }

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

// CIMSSettingsWizard::EventItemEditStartsL

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

//

TMuiuPageEventResult CIMSSettingsWizard::EventItemEditStartsL(

    CMuiuSettingBase& /* aBaseItem */ )

    {

    IMUM_CONTEXT( CIMSSettingsWizard::EventItemEditStartsL, 0, KLogUi );

    IMUM_IN();

    iNoteDialog = ShowMailSettingsPopupAfterL(

        iCurrentItem, KMsToWaitBeforePopup );

	IMUM_OUT();

    return EMuiuPageEventResultApproved;

    }

/******************************************************************************

    Wizard state machine

******************************************************************************/

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

// CIMSSettingsWizard::WizRunStart()

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

//

void CIMSSettingsWizard::WizRunStart()

    {

    // This function is called, when user starts the wizard by

    // pressing Start-key or by choosing options->Start

    SetFlag( EWizFlagStateRunning );

    iWizState = EWizStateStarted;

    }

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