/*

* 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:  Contains functions to show notes in UI

*

*/

// INCLUDE FILES

#include <e32base.h>

#include <ImumUtils.rsg>

#include <StringLoader.h>       // StringLoader

#include <aknnotewrappers.h>    // CAknConfirmationNote

#include <aknclearer.h>         // CAknLocalScreenClearer

#include "ImumInternalApiImpl.h"

#include "ImumInSettingsData.h"

#include "ImumInMailboxUtilitiesImpl.h"

#include "IMSSettingsNoteUi.h"

#include "EmailUtils.H"

#include "IMASPageIds.hrh"

#include "ImumPanic.h"

#include "IMSSettingsBaseUi.h"

#include "ImumUtilsLogging.h"

#include "EmailFeatureUtils.h"

#include "muiuflagger.h"

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES

// CONSTANTS

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

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

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

// CIMSSettingsNoteUi::CIMSSettingsNoteUi()

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

//

CIMSSettingsNoteUi::CIMSSettingsNoteUi(

    CImumInternalApiImpl& aMailboxApi,

    CIMSSettingsBaseUI& aDialog )

    :

    iDialog( aDialog ),

    iMailboxApi( aMailboxApi )

    {

    IMUM_CONTEXT( CIMSSettingsNoteUi::CIMSSettingsNoteUi, 0, KLogUi );

    }

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

// CIMSSettingsNoteUi::~CIMSSettingsNoteUi()

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

//

CIMSSettingsNoteUi::~CIMSSettingsNoteUi()

    {

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

    }

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

// CIMSSettingsNoteUi::ConstructL()

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

//

void CIMSSettingsNoteUi::ConstructL()

    {

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

    }

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

// CIMSSettingsNoteUi::NewL()

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

//

CIMSSettingsNoteUi* CIMSSettingsNoteUi::NewL(

    CImumInternalApiImpl& aMailboxApi,

    CIMSSettingsBaseUI& aDialog )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::NewL, 0, utils, KLogUi );

    CIMSSettingsNoteUi* self = NewLC( aMailboxApi, aDialog );

    CleanupStack::Pop( self );

    return self;

    }

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

// CIMSSettingsNoteUi::NewLC()

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

//

CIMSSettingsNoteUi* CIMSSettingsNoteUi::NewLC(

    CImumInternalApiImpl& aMailboxApi,

    CIMSSettingsBaseUI& aDialog )

    {

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

    CIMSSettingsNoteUi* self =

        new ( ELeave ) CIMSSettingsNoteUi( aMailboxApi, aDialog );

    CleanupStack::PushL( self );

    return self;

    }

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

    STATIC FUNCTIONS

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

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

// CIMSSettingsNoteUi::MakeStringLC()

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

//

HBufC* CIMSSettingsNoteUi::MakeStringLC( const TUint aTextResource )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::MakeStringLC, 0, utils, KLogUi );

    HBufC* prompt = StringLoader::LoadL( aTextResource );

    CleanupStack::PushL( prompt );

    return prompt;

    }

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

// CIMSSettingsNoteUi::MakeString()

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

//

void CIMSSettingsNoteUi::MakeString(

    TDes& aDest,

    TInt aResourceId,

    TInt aValue )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::MakeString, 0, utils, KLogUi );

    // To minimize stack usage, use callers buffer to make the string instead

    // of using StringLoader::Format() and temporary buffer.

    // Read format string from resource

    aDest.Zero();

    StringLoader::Load( aDest, aResourceId );

    // Convert integer to text representation

    TBuf<sizeof(TInt) * 4> subs; // CSI: 47 # For conversion.

    subs.AppendNum( aValue );

    // Replace tag with supplied int

    _LIT(KTag, "%N");

    MakeString( aDest, KTag, subs );

    }

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

// CIMSSettingsNoteUi::MakeString()

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

//

void CIMSSettingsNoteUi::MakeStringL(

    TDes& aDest,

    TInt aResourceId,

    const TDesC& aSubs )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::MakeString, 0, utils, KLogUi );

    HBufC* statusText = StringLoader::LoadL(

        aResourceId,

        aSubs,CCoeEnv::Static() );

    aDest.Copy(statusText->Des());

    delete statusText;

    }

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

// CIMSSettingsNoteUi::MakeString()

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

//

void CIMSSettingsNoteUi::MakeString(

    TDes& aDest,

    const TDesC& aTag,

    const TDesC& aSubs )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::MakeString, 0, utils, KLogUi );

    // To minimize stack usage, use callers buffer to make the string instead

    // of using StringLoader::Format() and temporary buffer.

    // Replace tag with supplied text

    TInt pos = aDest.Find( aTag );

    if ( pos != KErrNotFound)

        {

        aDest.Delete( pos, aTag.Length() );

        TInt room = aDest.MaxLength() - aDest.Length();

        TInt insertLen = aSubs.Length() <= room ? aSubs.Length():room;

        const TPtrC replacement( aSubs.Ptr(),  insertLen );

        aDest.Insert( pos, replacement );

        }

    }

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

// CIMSSettingsNoteUi::ShowQuery

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

//

EXPORT_C TInt CIMSSettingsNoteUi::ShowQueryL(

    const TUint aTextResource,

    const TInt  aDialogResource,

    const TBool& aClearBackground,

    const CAknQueryDialog::TTone aTone )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::ShowQueryL, 0, utils, KLogUi );

    // Get text to be shown

    HBufC* prompt = MakeStringLC( aTextResource );

    // Create dialog and execute the dialog

    TInt result = CIMSSettingsNoteUi::ShowQueryL(

        prompt->Des(), aDialogResource, aClearBackground, aTone );

    CleanupStack::PopAndDestroy( prompt );

    return result;

    }

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

// CIMSSettingsNoteUi::ShowQuery

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

//

EXPORT_C TInt CIMSSettingsNoteUi::ShowQueryL(

    const TDesC& aText,

    const TInt  aDialogResource,

    const TBool& aClearBackground,

    const CAknQueryDialog::TTone aTone )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::ShowQueryL, 0, utils, KLogUi );

    CAknLocalScreenClearer* localScreenClearer = NULL;

    if ( aClearBackground )

        {

        localScreenClearer = CAknLocalScreenClearer::NewL( EFalse );

        CleanupStack::PushL( localScreenClearer );

        CEikonEnv::Static()->EikAppUi()->AddToStackL( 

        	localScreenClearer, ECoeStackPriorityDefault, 

        	ECoeStackFlagRefusesAllKeys|ECoeStackFlagRefusesFocus );

        CleanupStack::PushL( TCleanupItem( &ScreenClearerCleanupOperation, 

        	localScreenClearer ) );

        }     

    // Create dialog and execute the dialog

    CAknQueryDialog* dlg = CAknQueryDialog::NewL( aTone );

    TInt button = dlg->ExecuteLD( aDialogResource, aText );    

    if ( aClearBackground )

        {        

        CleanupStack::PopAndDestroy(); // CSI: 47 # TCleanupItem

        CleanupStack::PopAndDestroy( localScreenClearer );

        localScreenClearer = NULL;

        }

    return button;

    }

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

// CIMSSettingsNoteUi::ScreenClearerCleanupOperation

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

//

void CIMSSettingsNoteUi::ScreenClearerCleanupOperation( TAny* aScreenClearer )

	{

	CEikonEnv::Static()->EikAppUi()->RemoveFromStack( 

		static_cast<CAknLocalScreenClearer*>( aScreenClearer ) );

	}

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

// CIMSSettingsNoteUi::ShowNoteL

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

//

EXPORT_C void CIMSSettingsNoteUi::ShowNoteL(

    const TUint      aResource,

    const TIMSNotes& aNoteType,

    const TBool      aNoteWaiting )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::ShowNoteL, 0, utils, KLogUi );

    // Get text to be shown

    HBufC* prompt = MakeStringLC( aResource );

    // Show the note

    CIMSSettingsNoteUi::ShowNoteL( *prompt, aNoteType, aNoteWaiting );

    CleanupStack::PopAndDestroy( prompt );

    }

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

// CIMSSettingsNoteUi::ShowNoteL

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

//

EXPORT_C void CIMSSettingsNoteUi::ShowNoteL(

    const TDesC&      aText,

    const TIMSNotes& aNoteType,

    const TBool      aNoteWaiting )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::ShowNoteL, 0, utils, KLogUi );

    CAknResourceNoteDialog* note = NewNoteL( aNoteType, aNoteWaiting );

    // Show the note

    note->ExecuteLD( aText );

    }

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

// CIMSSettingsNoteUi::ShowNoteL

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

//

EXPORT_C void CIMSSettingsNoteUi::ShowNoteL(

    TUint aResource,

    TIMSNotes aNoteType,

    TBool aNoteWaiting,

    TInt aTimeOut )

    {

    IMUM_STATIC_CONTEXT( CIMSSettingsNoteUi::ShowNoteL, 0, utils, KLogUi );

    // Get text to be shown

    HBufC* prompt = MakeStringLC( aResource );

    CAknResourceNoteDialog* note = NewNoteL( aNoteType, aNoteWaiting );

    note->SetTimeout( static_cast<CAknNoteDialog::TTimeout>( aTimeOut ) );                

    // Show the note

    note->ExecuteLD( *prompt );

    CleanupStack::PopAndDestroy( prompt );

    }

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

    Error note ui

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

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

// CIMSSettingsNoteUi::ShowDialog()

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

//

TMuiuPageEventResult CIMSSettingsNoteUi::ShowDialog(

    const CMuiuSettingBase& aBaseItem,

    const TIMSErrors aError,

    const TDesC& aNewText )

    {

    IMUM_CONTEXT( CIMSSettingsNoteUi::ShowDialog, 0, KLogUi );

    TMuiuPageEventResult result = EMuiuPageEventResultApproved;

    TRAP_IGNORE( result = SelectDialogL( aBaseItem, aError, aNewText ) );

    /*TRAPD( err,

    // Show error note based on the id

    switch ( aBaseItem.iItemId.iUid )

        {

        case EIMAWProtocol:

            result = ShowProtocolErrorNoteL( aError );

            return result;

        case EIMASOutgoingEmailAddress:

        case EIMAWEmailAddress:

        case EIMASUserReplyTo:

            result = ShowEmailAddressErrorNoteL( aError );

            return result;

        case EIMAWReceivingServer:

        case EIMAWSendingServer:

        case EIMASIncomingMailServer:

        case EIMASOutgoingMailServer:

            result = ShowServerErrorNoteL( aError );

            return result;

        case EIMAWIap:

            result = ShowIapErrorNoteL( aError );

            return result;

        case EIMAWMailboxName:

            result = ShowWizMailboxNameErrorNoteL( aError );

            return result;

        case EIMASIncomingMailboxName:

            result = ShowSetMailboxNameErrorNoteL( aError, aNewText );

            return result;

        case EIMASIncomingProtocol:

            result = ShowProtocolReadOnlyErrorNoteL( aError );

            return result;

        case EIMASMailNotifications:

        case EIMASAORolling:

            result = ShowAlwaysOnlineErrorNoteL( aError );

            return result;

        case EIMASIncomingUserPwd:

        case EIMASIncomingUserName:

            result = ShowAlwaysOnlineRemovalQueryL( aError );

            return result;

        case EIMASLimitInbox:

        case EIMASLimitFolders:

            result = ShowFetchLimitErrorNoteL( aError );

            return result;

        default:

            break;

        }

    );*/

    return result;

    }

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

// CIMSSettingsNoteUi::SelectDialogL()

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

//

TMuiuPageEventResult CIMSSettingsNoteUi::SelectDialogL( 

    const CMuiuSettingBase& aBaseItem,

    const TIMSErrors aError,

    const TDesC& aNewText )

    {

    // Show error note based on the id

    switch ( aBaseItem.iItemId.iUid )

        {

        case EIMAWProtocol:

            return ShowProtocolErrorNoteL( aError );

        case EIMASOutgoingEmailAddress:

        case EIMAWEmailAddress:

        case EIMASUserReplyTo:

            return ShowEmailAddressErrorNoteL( aError );

        case EIMAWReceivingServer:

        case EIMAWSendingServer:

        case EIMASIncomingMailServer:

        case EIMASOutgoingMailServer:

            return ShowServerErrorNoteL( aError );

        case EIMAWIap:

            return ShowIapErrorNoteL( aError );

        case EIMAWMailboxName:

            return ShowWizMailboxNameErrorNoteL( aError );

        case EIMASIncomingMailboxName:

            return ShowSetMailboxNameErrorNoteL( aError, aNewText );

        case EIMASIncomingProtocol:

            return ShowProtocolReadOnlyErrorNoteL( aError );

        case EIMASMailNotifications:

        case EIMASAORolling:

            return ShowAlwaysOnlineErrorNoteL( aError );

        case EIMASIncomingUserPwd:

        case EIMASIncomingUserName:

            return ShowAlwaysOnlineRemovalQueryL( aError );

        case EIMASLimitInbox:

        case EIMASLimitFolders:

            return ShowFetchLimitErrorNoteL( aError );

        default:

            break;

        }

    return EMuiuPageEventResultApproved;

    }

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

// CIMSSettingsNoteUi::ShowProtocolErrorNoteL()

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

//

TMuiuPageEventResult CIMSSettingsNoteUi::ShowProtocolErrorNoteL(

    const TIMSErrors aError )

    {

    IMUM_CONTEXT( CIMSSettingsNoteUi::ShowProtocolErrorNoteL, 0, KLogUi );

    switch ( aError )

        {

        case EIMSItemEmpty:

            CIMSSettingsNoteUi::ShowQueryL(

                R_IMUM_WIZARD_INSERT_PROTOCOL, 

                R_EMAIL_INFORMATION_QUERY, 

                ETrue );

            return EMuiuPageEventResultDisapproved;

        default:

            break;

        }

    return EMuiuPageEventResultApproved;

    }

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

// CIMSSettingsNoteUi::ShowEmailAddressErrorNoteL()

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

//

TMuiuPageEventResult CIMSSettingsNoteUi::ShowEmailAddressErrorNoteL(

    const TIMSErrors aError )

    {

    IMUM_CONTEXT( CIMSSettingsNoteUi::ShowEmailAddressErrorNoteL, 0, KLogUi );

    // Show notes

    switch ( aError )

        {

        // Incorrect

        case EIMSItemInvalid:

            CIMSSettingsNoteUi::ShowNoteL(

                R_IMUM_EDIT_OWN_EMAIL_ADDRESS_ERROR_TEXT, 

                EIMSInformationNote, ETrue );

            return EMuiuPageEventResultDisapproved;

        // Not typed

        case EIMSItemEmpty:

            CIMSSettingsNoteUi::ShowQueryL(

                R_IMUM_WIZARD_INSERT_EMAIL, 

                R_EMAIL_INFORMATION_QUERY,

                ETrue );

            return EMuiuPageEventResultDisapproved;