/*

* Copyright (c) 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: This file implements class CIpsSetUiBaseDialog.

*

*/

#include "emailtrace.h"

#include <akntitle.h>               // CAknTitlePane

#include <AknQueryDialog.h>         // CAknQueryDialog

#include <aknradiobuttonsettingpage.h> // CAknRadioButtonSettingPage

#include <aknpasswordsettingpage.h> // CAknPasswordSettingPage

#include <akntextsettingpage.h>     // CAknTextSettingPage

#include <akncheckboxsettingpage.h> // CAknCheckBoxSettingPage

#include <ipssossettings.rsg>

#include <StringLoader.h>

//<cmail> checking if MSK is enabled in layout (Layout_Meta_Data::IsMSKEnabled)

#include <layoutmetadata.cdl.h>

//</cmail>

#include "ipssetutilsexception.h"

#include "ipssetuiapprover.h"

#include "ipssetuiitembase.h"      // CIpsSetUiItem

#include "ipssetuiitemvalue.h" // CIpsSetUiItemValue

#include "ipssetuiitemtext.h"  // CIpsSetUiItemEditText

#include "ipssetuiitemlink.h"      // CIpsSetUiItemLink

#include "ipssetuiitemextlink.h"   // CIpsSetUiItemExtLink

#include "ipssetuictrlsoftkey.h"

#include "ipssetdata.h" // CIpsSetData::EAllDay, KIpsSetDataTimeDefault

#include "ipssetuibasedialog.h"     // CIpsSetUiBaseDialog

#include "ipssetutilspageids.hrh"

// Prevent any looping problems by defining maximum amount of editor openings

const TInt KIpsSetUiMaxEditors = 100;

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

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

// CIpsSetUiBaseDialog::CIpsSetUiBaseDialog()

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

//

CIpsSetUiBaseDialog::CIpsSetUiBaseDialog(

    CEikFormattedCellListBox& aListBox,

    CAknTitlePane& aTitlePane )

    :

    CIpsSetUiBaseArray(),

    iListBox( aListBox ),

    iTitlePane( aTitlePane ),

    iSoftkeys( NULL ),

    iSettingPage( NULL ),

    iSettingPageResources( NULL ),

    iSettingsPageArray( NULL ),

    iScrollBar( NULL ),

    iOldTitleText( NULL ),

    iQueryDialog( NULL ),

    iSettingsLastItemIndex( NULL ),

    iSettingValue( KErrNotFound ),

    iSettingText( NULL ),

    iNewPassword( NULL ),

    iOldPassword( NULL ),

    iButtonArray( NULL ),

    iCheckboxArray( NULL )

    {

    FUNC_LOG;

    }

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

// CIpsSetUiBaseDialog::~CIpsSetUiBaseDialog()

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

//

CIpsSetUiBaseDialog::~CIpsSetUiBaseDialog()

    {

    FUNC_LOG;

    // Remove the scrollbar from listbox

    iListBox.SetScrollBarFrame( NULL, CEikListBox::EOwnedExternally );

    if ( iSoftkeys )

        {

        iSoftkeys->SetObserver( EFalse, EFalse, EFalse, *this );

        }

    delete iSoftkeys;

    iSoftkeys = NULL;

    delete iSettingPageResources;

    iSettingPageResources = NULL;

    if ( iSettingsLastItemIndex )

        {

        iSettingsLastItemIndex->Reset();

        }

    delete iSettingsLastItemIndex;

    iSettingsLastItemIndex = NULL;

    if ( iCheckboxArray )

        {

        iCheckboxArray->ResetAndDestroy();

        }

    if ( iSettingsPageArray )

        {

        iSettingsPageArray->Reset();

        }

    if ( iBackupArray )

        {

        iBackupArray->ResetAndDestroy();

        }

    delete iBackupArray;

    iBackupArray = NULL;

    delete iSettingsPageArray;

    iSettingsPageArray = NULL;

    delete iCheckboxArray;

    iCheckboxArray = NULL;

    delete iOldTitleText;

    iOldTitleText = NULL;

    delete iQueryDialog;

    iQueryDialog = NULL;

    delete iSettingPage;

    iSettingPage = NULL;

    delete iButtonArray;

    iButtonArray = NULL;

    iSettingText.Close();

    delete iNewPassword;

    iNewPassword = NULL;

    delete iOldPassword;

    iOldPassword = NULL;

    iScrollBar = NULL;

    delete iItemApprover;

    iItemApprover = NULL;

    delete iMainMBoxMenuTitleText;

    iMainMBoxMenuTitleText = NULL;

    }

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

// CIpsSetUiBaseDialog::ConstructL()

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

//

void CIpsSetUiBaseDialog::ConstructL(

    CEikButtonGroupContainer& aSoftkeys,

    const TInt aResource,

    const TBool aUpdateMSK )

    {

    FUNC_LOG;

    BaseConstructL( aResource );

    // Set as observer

    iListBox.SetListBoxObserver( this );

    iListBox.View()->SetListEmptyTextL( KNullDesC );

    // Get scrollbar

    iScrollBar = iListBox.CreateScrollBarFrameL( ETrue );

    iScrollBar->SetScrollBarVisibilityL(

        CEikScrollBarFrame::EOff, CEikScrollBarFrame::EAuto );

    // Create array

    CTextListBoxModel* model = iListBox.Model();

    model->SetItemTextArray( this );

    model->SetOwnershipType( ELbmDoesNotOwnItemArray );

    // Set this dialog for button listening

    iSoftkeys = CIpsSetUiCtrlSoftkey::NewL( aSoftkeys );

    iSoftkeys->SetObserver( ETrue, ETrue, ETrue, *this );

    iSoftkeys->SetMSKLabelling( aUpdateMSK );

    iSoftkeys->UpdateMiddleSoftkeyLabelL(

        GetResourceForMiddlekey(), EAknSoftkeyOpen, this );

    // Prepare setting page arrays

    iSettingPageResources = CIpsSetUiCtrlPageResource::NewL();

    iSettingsLastItemIndex =

        new ( ELeave ) CIpsSetUiIntArray( KIpsSetUiArrayGranularity );

    // Add array to store the backup items

    iBackupArray = new ( ELeave ) CIpsSetUiBaseItemArray( KIpsSetUiArrayGranularity );

    // Define setting pages in enumeration order

    iSettingPageResources->CreateStackL( R_IPS_SET_DIALOG_LISTBOX );

    iSettingPageResources->CreateStackL( R_IPS_SET_DIALOG_CHECKLISTBOX );

    iSettingPageResources->CreateStackL( R_IPS_SET_DIALOG_TEXT );

    iSettingPageResources->CreateStackL( R_IPS_SET_DIALOG_NUMBER );

    iSettingPageResources->CreateStackL( R_IPS_SET_DIALOG_SC_NUMBER );

    iSettingPageResources->CreateStackL( R_IPS_SET_DIALOG_PASSWORD );

    iSettingPageResources->CreateStackL( NULL );

    iItemApprover = CIpsSetUiApprover::NewL();

    }

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

// CIpsSetUiBaseDialog::HandleListBoxEventL()

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

//

void CIpsSetUiBaseDialog::HandleListBoxEventL(

    CEikListBox* /* aListBox */,

    TListBoxEvent aEventType )

    {

    FUNC_LOG;

    if( aEventType == EEventItemSingleClicked )

    	{

    	CIpsSetUiItem* base = CurrentItem();

    	OpenSettingPageL( *base );

        }

    }

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

// CIpsSetUiBaseDialog::OfferKeyEventL

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

//

TKeyResponse CIpsSetUiBaseDialog::OfferKeyEventL(

    const TKeyEvent& /* aKeyEvent */,

    TEventCode aType )

    {

    FUNC_LOG;

    if ( aType == EEventKeyUp && iSoftkeys->MSKLabelling() )

        {

        iSoftkeys->UpdateMiddleSoftkeyLabelL(

            GetResourceForMiddlekey(), EAknSoftkeyOpen, this );

        }

    return EKeyWasNotConsumed;

    }

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

// CIpsSetUiBaseDialog::GetResourceForMiddlekey()

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

//

TInt CIpsSetUiBaseDialog::GetResourceForMiddlekey()

    {

    FUNC_LOG;

//<cmail> run-time MSK variation check (enabled in platform + in current layout)

    TInt resource = 0;

    if ( AknLayoutUtils::MSKEnabled() && Layout_Meta_Data::IsMSKEnabled() )

        {

        CIpsSetUiItem* item = CurrentItem();

        IPS_ASSERT_DEBUG( item , KErrNotFound, EBaseDialog );

        if ( item )

            {

            resource = ItemSubArrayCheck( *item ) ?

                R_QTN_MSK_OPEN : R_QTN_MSK_CHANGE; // <cmail>

            }

        }

    return resource;

//</cmail>

    }

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

// CIpsSetUiBaseDialog::SetTitlePaneTextL()

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

//

void CIpsSetUiBaseDialog::SetMainMBoxMenuTitlePaneTextL(

    const TDesC& aText,

    const TBool aSaveCurrent )

    {

    FUNC_LOG;

    // aText contains mailbox name

    HBufC* titleText = StringLoader::LoadLC(

            R_FSE_SETTINGS_LIST_MAILBOX_TITLE, aText );

    if ( aSaveCurrent )

        {

        delete iOldTitleText;

        iOldTitleText = NULL;

        iOldTitleText = iTitlePane.Text()->Alloc();

        delete iMainMBoxMenuTitleText;

        iMainMBoxMenuTitleText = NULL;

        iMainMBoxMenuTitleText = aText.AllocL();

        }

    iTitlePane.SetTextL( *titleText );

    CleanupStack::PopAndDestroy( titleText );

    titleText = NULL;

    }

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

// CIpsSetUiBaseDialog::SetPreviousTitlePaneText()

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

//

void CIpsSetUiBaseDialog::SetSettingsMenuTitlePaneText(

    const TBool aSaveCurrent )

    {

    FUNC_LOG;

    TRAP_IGNORE( SetMainMBoxMenuTitlePaneTextL(

            *iOldTitleText, aSaveCurrent ) );

    }

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

    Settingpage opening

    - Find out the item to be edited

    - Send start editing event with the item

    - Check the item type

    - Check the resources

    - If no resources available, ask them

    - Start editing

    - Send end editing event

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

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

// CIpsSetUiBaseDialog::OpenSettingPageL()

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

//

TIpsSetUiPageResult CIpsSetUiBaseDialog::OpenSettingPageL(

    const TInt aIndex )

    {

    FUNC_LOG;

    // To open setting page, check if the Setting Page index is provided,

    // if not get the current item index in array

    TInt index = ( aIndex == KErrNotFound ) ?

        iListBox.CurrentItemIndex() : aIndex;

    // Search for the item and open it

    return SettingPageOpenL( *GetItem( index ) );

    }

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

// CIpsSetUiBaseDialog::OpenSettingPageL()

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

//

TIpsSetUiPageResult CIpsSetUiBaseDialog::OpenSettingPageL(

    CIpsSetUiItem& aBaseItem )

    {

    FUNC_LOG;

    return SettingPageOpenL( aBaseItem );

    }

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

// CIpsSetUiBaseDialog::SettingPageOpenL()

//

// This function contains the main logic for the setting editor handling

// in the settings dialog. The setting editors are kept opening as long

// as the all the settings are gone through or the editor is dismissed.

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

//

TIpsSetUiPageResult CIpsSetUiBaseDialog::SettingPageOpenL(

    CIpsSetUiItem& aBaseItem )

    {

    FUNC_LOG;

    // Don't open the editor for read-only items

    if ( aBaseItem.iItemFlags.Flag32( KIpsSetUiFlagReadOnly ) )

        {

        return EIpsSetUiPageResultReadOnly;

        }

    // Store current focused item for last item index array

    iCurrentItemIndex = iListBox.CurrentItemIndex();

    // Starting editing of the item, do not allow updating during editing

    iArrayFlags.ClearFlag( EIpsSetUiArrayAllowRefresh );

    // When starting to edit page, send event so that item can be prepared

    // for the editing. In case of error, editing won't start

    TIpsSetUiEventResult eventResult = EventItemEditStartsL( aBaseItem );

    TIpsSetUiPageResult result;

    if ( eventResult == EIpsSetUiPageEventResultApproved )

        {

        // Create the array if it doesn't exist yet

        if ( !iSettingsPageArray )

            {

            iSettingsPageArray = new ( ELeave ) CIpsSetUiBaseItemArray(

                KIpsSetUiArrayGranularity );

            }

        // Clear the array and add the editable item to array

        CleanBackupArray();

        iSettingsPageArray->Reset();

        SetCurrentSettingsPageL( aBaseItem );

        result = SettingsPageOpenCheckL();

        do

            {

            if ( result == EIpsSetUiPageResultEditing )

                {

                // Open the setting page

                result = SettingPageOpenEditorL();

                // Do open check. Note that the result can be modified!

                SettingsCheckNextEditorOpenL( result );

                }

            // Finish the editing of the item

            SettingPageOpenFinishL();

            }

        while ( result == EIpsSetUiPageResultEditing );

        }

    else if ( eventResult == EIpsSetUiPageEventResultDisapproved )

        {

        result = EIpsSetUiPageResultOk;

        }

    else

        {

        result = EIpsSetUiPageResultEventCancel;

        }

    // Send item edit ends

    EventItemEditEndsL( aBaseItem );

    aBaseItem.iItemFlags.ClearFlag32( KIpsSetUiFlagOneTimeForceViewOpen );

    iArrayFlags.SetFlag( EIpsSetUiArrayAllowRefresh );

    // Update the listbox

    Refresh();

    return result;

    }

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

// CIpsSetUiBaseDialog::EventPrepareSubArrayL()

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

//

TInt CIpsSetUiBaseDialog::EventPrepareSubArrayL(

    CIpsSetUiItem& aBaseItem,

    const TBool aForward )

    {

    FUNC_LOG;

    // Check direction in array

    UpdateTitlePaneTextL( GetLastResourceId( ) );

    if ( aForward )

        {

        // Store the index and set to beginning

        SetSettingsLastItemIndexL( iCurrentItemIndex );

        iListBox.SetCurrentItemIndex( 0 );

        }

    // When going backwards

    else

        {

        // Restore previous index

        iListBox.SetCurrentItemIndex( SettingsLastItemIndex() );

        }

    return EventSubArrayChangeL( aBaseItem );

    }

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

// CIpsSetUiBaseDialog::UpdateTitlePaneTextL()

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

//

void CIpsSetUiBaseDialog::UpdateTitlePaneTextL( TInt aId )

    {

    FUNC_LOG;

    HBufC* titleText = NULL;

    switch ( aId )

        {

        case R_IPS_SET_MENU_MAILBOX_SETTINGS:

            titleText = StringLoader::LoadLC( R_FSE_SETTINGS_TITLE_MAILBOX );

            iTitlePane.SetTextL( *titleText );

            break;

        case R_IPS_SET_MENU_ADVANCED_MAILBOX_SETTINGS:

            titleText = StringLoader::LoadLC(

                    R_FSE_SETTINGS_ADVANCED_MAILBOX_SETTINGS );

            iTitlePane.SetTextL( *titleText );

            break;

		// <cmail> ipssossettings to use correct loc strings in titles

        case R_IPS_SET_MENU_INCOMING_SETTINGS:

            titleText = StringLoader::LoadLC(

            	R_FSE_SETTINGS_INCOMING_TITLE );

            iTitlePane.SetTextL( *titleText );

            break;

        case R_IPS_SET_MENU_OUTGOING_SETTINGS:

            titleText = StringLoader::LoadLC(

            	R_FSE_SETTINGS_OUTGOING_TITLE );

            iTitlePane.SetTextL( *titleText );

            break;

        case R_IPS_SET_MENU_WHAT_TO_SYNC:

        case R_IPS_SET_WHAT_TO_SYNC_ARRAY_EMAIL_RETRIEVE_POP3:

        case R_IPS_SET_WHAT_TO_SYNC_ARRAY_EMAIL_RETRIEVE_IMAP4:

            titleText = StringLoader::LoadLC( 

                    R_FSE_SETTINGS_SERVICE_WHAT_TO_SYNC_TITLE );

            iTitlePane.SetTextL( *titleText );

            break;

        case R_IPS_SET_MENU_WHEN_TO_SYNC:

            titleText = StringLoader::LoadLC( 

                    R_FSE_SETTINGS_SERVICE_WHEN_TO_SYNC_TITLE );

            iTitlePane.SetTextL( *titleText );

            break;

        // </cmail>

        default:

            {

            delete iMainMBoxMenuTitleText;

            iMainMBoxMenuTitleText = NULL;

            iMainMBoxMenuTitleText = GetItem( TUid::Uid( EIpsSetUiMailboxMailboxName ) )->Text().AllocL();

            Refresh();

            if ( iMainMBoxMenuTitleText )

                {

                titleText = StringLoader::LoadLC(

                        R_FSE_SETTINGS_LIST_MAILBOX_TITLE, *iMainMBoxMenuTitleText );

                iTitlePane.SetTextL( *titleText );

                }

            break;

            }

        }

    if ( titleText )

        {

        CleanupStack::PopAndDestroy( titleText );

        }

    }

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

    Settingpage creation

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

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

// CIpsSetUiBaseDialog::SettingsPageOpenCheckL()

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

//

TIpsSetUiPageResult CIpsSetUiBaseDialog::SettingsPageOpenCheckL()

    {

    FUNC_LOG;

    CIpsSetUiItem* base = CurrentSettingsPage();

    // Before starting to open the page, check that item type is not