/*

* 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:  MuiuDynamicSettingsArray.cpp

*

*/

// INCLUDE FILES

#include <e32base.h>            // Base symbian include

#include <gulutil.h>            // KColumnListSeparator

#include <eikrutil.h>           // EikResourceUtils

#include <AknUtils.h>           // AknTextUtils

#include <barsread.h>           // TResourceReader

#include "MuiuDynamicSettingsArray.h"

#include "MuiuDynamicSettingItemBase.h"      // CMuiuSettingBase

#include "MuiuDynamicSettingItemEditValue.h" // CMuiuSettingEditValue

#include "MuiuDynamicSettingItemEditText.h"  // CMuiuSettingEditText

#include "MuiuDynamicSettingItemLink.h"      // CMuiuSettingLink

#include "MuiuDynamicSettingItemExtLink.h"   // CMuiuSettingExtLink

#include <StringLoader.h>

#include <ImumUtils.rsg>

#include <data_caging_path_literals.hrh>

#include <muiu_internal.rsg>

#include "EmailFeatureUtils.h"

#include "MuiuDynamicSettingsItemFinder.h"

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES

// CONSTANTS

// This is added at the end of the locked setting item string

_LIT( KMuiuDynStrProtected, "\t\t\t\t\t0" );

// This is added at the end of the compulsory setting item string

_LIT( KMuiuDynStrCompulsory, "\t*" );

// Muiu resource file

_LIT( KMuiuResFileName, "z:muiu_internal.rsc" );

// The number of characters that can be shown in the screen

const TInt KMuiuDynVisibleTextLength = 30;

// The number of characters that is shown in password field

const TInt KMuiuDynVisiblePasswordChars = 4;

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

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

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

// CMuiuDynamicSettingsArray::CMuiuDynamicSettingsArray()

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

//

CMuiuDynamicSettingsArray::CMuiuDynamicSettingsArray()

    :

    iResourceLoader( *CCoeEnv::Static() ),

    iFinder( NULL ),

    iItemArray( NULL ),

    iCompulsoryText( NULL ),

    iPasswordFill( 0x00 ),

    iActiveCount( 0 ),

    iError( KErrNone ),

    iEnv( CEikonEnv::Static() )

    {

    }

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

// CMuiuDynamicSettingsArray::~CMuiuDynamicSettingsArray()

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

//

CMuiuDynamicSettingsArray::~CMuiuDynamicSettingsArray()

    {

    CleanArrayItems();

    if ( iResourceStack )

        {

        iResourceStack->Reset();

        delete iResourceStack;

        iResourceStack = NULL;

        }

    delete iItemArray;

    iItemArray = NULL;

    delete iTempText;

    iTempText = NULL;

    delete iResourceText;

    iResourceText = NULL;

    delete iCompulsoryText;

    iCompulsoryText = NULL;

    delete iFinder;

    iFinder = NULL;

    iResourceLoader.Close();

    iEnv = NULL;

    }

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

// CMuiuDynamicSettingsArray::BaseConstructL()

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

//

void CMuiuDynamicSettingsArray::BaseConstructL( const TBool aLockedSettings )

    {

    // Prepare the arrays

    iItemArray = new ( ELeave ) CMuiuDynSetItemArray( KMuiuDynArrayGranularity );

    iResourceStack = new ( ELeave ) RResourceStack( KMuiuDynArrayGranularity );

    iFinder = CMuiuDynamicSettingsItemFinder::NewL( *this );

    // Define resource file and open it

    TParse parse;

    parse.Set( KMuiuResFileName, &KDC_RESOURCE_FILES_DIR, NULL );

    TFileName fileName( parse.FullName() );

    iResourceLoader.OpenL( fileName );

    iArrayFlags.SetFlag( EMuiuDynArrayAllowRefresh );

    iArrayFlags.ChangeFlag( EMuiuEMailLockedSettings, aLockedSettings );

    // Prepare strings

    iTempText = HBufC::NewL( KMuiuDynMaxSettingsTextLength );

    iResourceText = iEnv->AllocReadResourceL(

        R_IMUM_SELEC_SETT_VAL_FIELD_NONE );

    iPasswordFill = EikResourceUtils::ReadTInt16L(

        R_MUIU_SETTINGS_DIALOG_PASSWORD_FILL, iEnv );

    iCompulsoryText = iEnv->AllocReadResourceL(

        R_MUIU_SETTINGS_DIALOG_COMPULSORY_FILL );

    }

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

// CMuiuDynamicSettingsArray::BaseConstructL()

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

//

void CMuiuDynamicSettingsArray::BaseConstructL(

    const TInt aResourceId,

    const TBool aLockedSettings )

    {

    // Initialize the members

    BaseConstructL( aLockedSettings );

    // If resource provided add it into the setting array

    LoadSettingArrayFromResourceL( aResourceId );

    UpdateActiveItemsCount();

    }

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

// CMuiuDynamicSettingsArray::CleanArrayItems()

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

//

void CMuiuDynamicSettingsArray::CleanArrayItems()

    {

    if ( iItemArray )

        {

        // Delete items from the array

        TInt index = iItemArray->Count() - 1;

        // Search through all items in the array

        for ( ; index >= 0; index-- )

            {

            // Only certain type of items can contain subarrays

            CMuiuSettingBase* base = ( *iItemArray )[index];

            delete base;

            base = NULL;

            }

        }

    }

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

// CMuiuDynamicSettingsArray::CreateCustomItemToArrayLC()

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

//

CMuiuSettingBase* CMuiuDynamicSettingsArray::CreateCustomItemToArrayLC(

    const TUid& /* aId */ )

    {

    return NULL;

    }

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

// CMuiuDynamicSettingsArray::ListboxItemFillMultiLineLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxItemFillMultiLineLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText = static_cast<const CMuiuSettingsLink*>(

        &aBaseItem )->iItemSettingText->Left( KMuiuDynVisibleTextLength );

    }

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

// CMuiuDynamicSettingsArray::ListboxItemFillEditTextLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxItemFillEditTextLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText.Copy( aBaseItem.VisibleText().Left( KMuiuDynVisibleTextLength ) );

    }

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

// CMuiuDynamicSettingsArray::ListboxItemFillEditValueLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxItemFillEditValueLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText.Append( aBaseItem.Value() );

    aText.SetLength( KMuiuDynVisibleTextLength );

    }

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

// CMuiuDynamicSettingsArray::ListboxItemFillEditTimeLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxItemFillEditTimeLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText.Append( aBaseItem.Value() );

    aText.SetLength( KMuiuDynVisibleTextLength );

    }

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

// CMuiuDynamicSettingsArray::ListboxUndefinedFillLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxUndefinedFillLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText = static_cast<const CMuiuSettingsLinkExtended*>(

        &aBaseItem )->iItemSettingText->Left( KMuiuDynVisibleTextLength );

    }

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

// CMuiuDynamicSettingsArray::ListboxRadioButtonFillArrayLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxRadioButtonFillArrayLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText = static_cast<const CMuiuSettingsLinkExtended*>(

        &aBaseItem )->iItemSettingText->Left( KMuiuDynVisibleTextLength );

    }

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

// CMuiuDynamicSettingsArray::ListboxCheckboxFillArrayLabel()

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

//

void CMuiuDynamicSettingsArray::ListboxCheckboxFillArrayLabel(

    const CMuiuSettingBase& aBaseItem,

    TMuiuSettingsText& aText ) const

    {

    aText = static_cast<const CMuiuSettingsLinkExtended*>(

        &aBaseItem )->iItemSettingText->Left( KMuiuDynVisibleTextLength );

    }

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

// CMuiuDynamicSettingsArray::ListboxItemLabelFillL()

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

//

TPtrC16 CMuiuDynamicSettingsArray::ListboxItemLabelFillL(

    CMuiuSettingBase& aBaseItem ) const

    {

    // Get the type of the setting item

    TMuiuDynSettingsType type = aBaseItem.iItemType;

    TMuiuSettingsText tempSettingText;

    tempSettingText.Zero();

    switch ( type )

        {

        case EMuiuDynSetItemMultiLine:

            ListboxItemFillMultiLineLabel( aBaseItem, tempSettingText );

            break;

        case EMuiuDynSetUndefined:

            ListboxUndefinedFillLabel( aBaseItem, tempSettingText );

            break;

        case EMuiuDynSetRadioButtonArray:

            ListboxRadioButtonFillArrayLabel( aBaseItem, tempSettingText );

            break;

        case EMuiuDynSetCheckBoxArray:

            ListboxCheckboxFillArrayLabel( aBaseItem, tempSettingText );

            break;

        case EMuiuDynSetItemEditText:

            ListboxItemFillEditTextLabel( aBaseItem, tempSettingText );

            break;

        case EMuiuDynSetItemEditValue:

            ListboxItemFillEditValueLabel( aBaseItem, tempSettingText );

            break;

        case EMuiuDynSetItemEditTime:

            ListboxItemFillEditTimeLabel( aBaseItem, tempSettingText );

            break;

        default:

            // Nothing to show, send empty text

            break;

        }

    // If the setting is marked as password, fill special character

    // instead of readable text

    TInt length = tempSettingText.Length();

    if ( length > 0 && aBaseItem.iItemFlags.Flag( EMuiuDynItemPassword ) )

        {

        // Add special chars to all type characters in setting field

        TChar passFill = TChar( iPasswordFill );

        tempSettingText.Zero();

        tempSettingText.AppendFill( passFill, KMuiuDynVisiblePasswordChars );

        }

    return tempSettingText;

    }

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

    Item property editors

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

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

// CMuiuDynamicSettingsArray::SetItemValue()

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

//

void CMuiuDynamicSettingsArray::SetItemValue(

    const TUid& aId,

    const TInt aValue,

    const TBool aUpdate )

    {

    CMuiuSettingBase* baseItem = GetItem( aId, EFalse );

    if ( baseItem )

        {

        SetItemValue( *baseItem, aValue, aUpdate );

        }

    baseItem = NULL;

    }

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

// CMuiuDynamicSettingsArray::SetItemValue()

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

//

void CMuiuDynamicSettingsArray::SetItemValue(

    const TInt aIndex,

    const TInt aValue,

    const TBool aUpdate )

    {

    CMuiuSettingBase* baseItem = iItemArray->At( aIndex );

    if ( baseItem )

        {

        SetItemValue( *baseItem, aValue, aUpdate );

        }

    baseItem = NULL;

    }

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

// CMuiuDynamicSettingsArray::SetItemValue()

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

//

void CMuiuDynamicSettingsArray::SetItemValue(

    CMuiuSettingBase& aBaseItem,

    const TInt aValue,

    const TBool aUpdate )

    {

    aBaseItem.SetValue( aValue );

    // Issue update when needed

    if ( aUpdate )

        {

        Refresh();

        }

    }

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

// CMuiuDynamicSettingsArray::SetItemText()

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

//

void CMuiuDynamicSettingsArray::SetItemText(

    const TUid& aId,

    const TMuiuSettingsText& aText,

    const TBool aUpdate )

    {

    CMuiuSettingBase* baseItem = GetItem( aId, EFalse );

    if ( baseItem )

        {

        SetItemText( *baseItem, aText, aUpdate );

        }

    baseItem = NULL;

    }

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

// CMuiuDynamicSettingsArray::SetItemText()

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

//

void CMuiuDynamicSettingsArray::SetItemText(

    const TInt aIndex,

    const TMuiuSettingsText& aText,

    const TBool aUpdate )

    {

    CMuiuSettingBase* baseItem = iItemArray->At( aIndex );

    if ( baseItem )

        {

        SetItemText( *baseItem, aText, aUpdate );

        }

    baseItem = NULL;

    }

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

// CMuiuDynamicSettingsArray::SetItemText()

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

//

void CMuiuDynamicSettingsArray::SetItemText(

    CMuiuSettingBase& aBaseItem,

    const TMuiuSettingsText& aText,

    const TBool aUpdate )

    {

    switch ( aBaseItem.iItemType )

        {

        case EMuiuDynSetItemEditValue:

            static_cast<CMuiuSettingsEditValue*>(

                &aBaseItem )->iItemSettingText->Copy( aText );

            break;

        case EMuiuDynSetRadioButtonArray:

        case EMuiuDynSetCheckBoxArray:

            static_cast<CMuiuSettingsLinkExtended*>(

                &aBaseItem )->iItemSettingText->Copy( aText );

            break;

        default:

            aBaseItem.SetText( &aText );

            break;

        }

    // Issue update when needed

    if ( aUpdate )

        {

        Refresh();

        }

    }

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

// CMuiuDynamicSettingsArray::ItemText()

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

//

const TMuiuSettingsText* CMuiuDynamicSettingsArray::ItemText(

    CMuiuSettingBase& aBaseItem )

    {

    switch ( aBaseItem.iItemType )

        {

        case EMuiuDynSetItemEditValue:

            return static_cast<CMuiuSettingsEditValue*>(

                &aBaseItem )->iItemSettingText;

        case EMuiuDynSetRadioButtonArray:

        case EMuiuDynSetCheckBoxArray:

            return static_cast<CMuiuSettingsLinkExtended*>(

                &aBaseItem )->iItemSettingText;

        }

    return aBaseItem.Text();

    }

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

    Base class function definitions

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

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

// CMuiuDynamicSettingsArray::SearchDoError()

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

//

TBool CMuiuDynamicSettingsArray::SearchDoError()

    {

    return ETrue;

    }

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

// CMuiuDynamicSettingsArray::SearchDoContinuationCheck()

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

//

TBool CMuiuDynamicSettingsArray::SearchDoContinuationCheck(

    const CMuiuSettingBase& /* aItem */,

    const TInt /* aIndex */ )

    {

    return ETrue;

    }

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

// CMuiuDynamicSettingsArray::SearchDoItemCheck()

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

//

TBool CMuiuDynamicSettingsArray::SearchDoItemCheck(

    CMuiuSettingBase& /* aItem */ )

    {

    return ETrue;

    }

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

// CMuiuDynamicSettingsArray::MdcaCount()

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

//

TInt CMuiuDynamicSettingsArray::MdcaCount() const

    {