/*

* 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:  FreestyleEmailUi folder list view implementation

*

*/

// SYSTEM INCLUDES

#include "emailtrace.h"

#include <AknUtils.h>

#include <StringLoader.h>

#include <AknBidiTextUtils.h>

#include <gulicon.h>

#include <aknlayoutscalable_apps.cdl.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include <layoutmetadata.cdl.h>

#include <AknStatuspaneUtils.h>

#include <akntoolbar.h>

#include <eikcolib.h>

#include <alf/alfdecklayout.h>

#include <alf/alftextvisual.h>

#include <alf/alfcontrolgroup.h>

#include <alf/alfbrusharray.h>

#include <alf/alfevent.h>

#include <alf/alfframebrush.h>

#include <alf/alfstatic.h>

// GENERIC LIST COMPONENT INCLUDES

#include "fstreelist.h"

#include "fstreevisualizerbase.h"

#include "fstreeplainonelineitemdata.h"

#include "fstreeplainonelineitemvisualizer.h"

#include "fstreeplaintwolineitemdata.h"

#include "fstreeplaintwolineitemvisualizer.h"

#include "fstreeplainonelinenodedata.h"

#include "fstreeplainonelinenodevisualizer.h"

#include "fscontrolbuttoninterface.h"

#include "fsseparatordata.h"

#include "fsseparatorvisualizer.h"

// FREESTYLE EMAIL FRAMEWORK INCLUDES

#include "CFSMailCommon.h"

#include "CFSMailClient.h"

#include "CFSMailBox.h"

#include "CFSMailFolder.h"

#include <csxhelp/cmail.hlp.hrh>

#include <featmgr.h>

// INTERNAL INCLUDES

#include <freestyleemailui.mbg>

#include <FreestyleEmailUi.rsg>

#include "FreestyleEmailUiAppui.h"

#include "FreestyleEmailUiFolderListControl.h"

#include "FreestyleEmailUiFolderListModel.h"

#include "FreestyleEmailUiFolderListVisualiser.h"

#include "FreestyleEmailUi.hrh"

#include "FreestyleEmailUiLayoutHandler.h"

#include "FreestyleEmailUiTextureManager.h"

#include "FreestyleEmailUiControlBarCallback.h"

#include "FreestyleEmailUiUtilities.h"

#include "FreestyleEmailUiLayoutData.h"

#include "FreestyleEmailUiShortcutBinding.h"

#include "ESMailSettingsPlugin.h"

#include "FreestyleEmailUiStatusIndicator.h"

// REMOVE WHEN DONE TESTING:

//#include "CSimpleAOTest.h"

// Defines the order of the folders in UI

enum TFSEmailUiFolderListPriorities

	{

    EFolderListPriorityInbox = 1,

    EFolderListPriorityDrafts,

    EFolderListPrioritySent,

    EFolderListPriorityOutbox,

    EFolderListPriorityDeleted,

    EFolderListPriorityOtherFolder

	};

// Defines the order of the list icons in the icon array

enum TFsEmailUiFolderListIcons

	{

    EFolderListIconInbox = 0,

    EFolderListIconInboxSubfolders,

    EFolderListIconOutbox,

    EFolderListIconDrafts,

    EFolderListIconSent,

    EFolderListIconDeleted,

    EFolderListIconServerFolders,

	EFolderListIconMoreFolders,

    EFolderListIconEmailAccount

	};

// List level for the root folders

static const TInt KListRootLevel( 1 );

// List supports three levels, so basically root folder + two levels of subfolders

static const TInt KListLastBasicLevel( KListRootLevel + 2 );

// Constants for drawing header text

const TReal KFSHeaderTextBackgroundOpacity = 0.3f;

const TAlfTimedValue KFSVisible( 1 );

const TAlfTimedValue KFSInvisible( 0 );

// Considering that there are 99999 unread emails + ( + ) + SPACE size should be 5+1+1+1 =8

static const TInt KFmtUnRdCntMaxLength( 8 );

_LIT(KFormatUnreadCnt, " (%d)");

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

// NewL

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

//

CFSEmailUiFolderListVisualiser* CFSEmailUiFolderListVisualiser::NewL( CAlfEnv& aEnv,

                                                 CAlfControlGroup& aControlGroup,

                                                 CFreestyleEmailUiAppUi& aAppUi )

    {

    FUNC_LOG;

    CFSEmailUiFolderListVisualiser* self = CFSEmailUiFolderListVisualiser::NewLC(aEnv, aControlGroup, aAppUi );

    CleanupStack::Pop(self);

    return self;

    }

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

// NewLC

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

//

CFSEmailUiFolderListVisualiser* CFSEmailUiFolderListVisualiser::NewLC( CAlfEnv& aEnv,

                                                 CAlfControlGroup& aControlGroup,

                                                 CFreestyleEmailUiAppUi& aAppUi )

	{

    FUNC_LOG;

    CFSEmailUiFolderListVisualiser* self = new (ELeave) CFSEmailUiFolderListVisualiser( aEnv, aAppUi, aControlGroup );

    CleanupStack::PushL(self);

    self->ConstructL();

    return self;

	}

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

// Constructor

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

//

CFSEmailUiFolderListVisualiser::CFSEmailUiFolderListVisualiser( CAlfEnv& aEnv, 

                                                                CFreestyleEmailUiAppUi& aAppUi, 

                                                                CAlfControlGroup& aControlGroup )

    : CFsEmailUiViewBase( aControlGroup, aAppUi ),

      iEnv( aEnv ),

      iFullScreen( ETrue ),

      iPreviousListLevel( KListRootLevel ),

      iMoveOrCopyInitiated(EFalse),

      iWaitingToGoOnline(EFalse),

      iNoConnectNeeded(ETrue)

	{

    FUNC_LOG;

	}

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

// Destructor

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

//

CFSEmailUiFolderListVisualiser::~CFSEmailUiFolderListVisualiser()

	{

    FUNC_LOG;

	delete iModel;

	iModel = NULL;

	delete iBackgroundBrush;

	iBackgroundBrush = NULL;

	// No need for ResetAndDestroy because list items are owned by generic list

	iListItemVisulizers.Close();

    //delete iNotifierTest;

    delete iTreeList;

    iTreeList = NULL;

    iIconArray.Close();

    if ( iAsyncCallback )

        {

        iAsyncCallback->Cancel();

        delete iAsyncCallback;

        }

    iListItemDatas.Close();

	}

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

// Second phase constructor

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

//

void CFSEmailUiFolderListVisualiser::ConstructL()

	{

    FUNC_LOG;

    BaseConstructL( R_FSEMAILUI_FOLDER_LIST_VIEW );

    iFirstStartCompleted = EFalse;

	}

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

// CFSEmailUiFolderListVisualiser::DoFirstStartL

// Purpose of this function is to do first start things only when list is

// really needed to be shown. Implemented to make app startuo faster.

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

//

void CFSEmailUiFolderListVisualiser::DoFirstStartL()

    {

    FUNC_LOG;

    iControl = CFSEmailUiFolderListControl::NewL( iEnv, *this );

    iModel = new (ELeave) CFSEmailUiFolderListModel();

    UpdateListSizeAttributes();

    //LoadIconsL();

    TRect mainPaneRect;

    AknLayoutUtils::LayoutMetricsRect(AknLayoutUtils::EMainPane, mainPaneRect);

    iFaderLayout = CAlfDeckLayout::AddNewL( *iControl );

    iFaderLayout->SetRect( mainPaneRect );

    iParentLayout = CAlfAnchorLayout::AddNewL( *iControl );

    iParentLayout->SetRect( iScreenRect );

    iParentLayout->SetFlags( EAlfVisualFlagManualLayout );

    iParentLayout->EnableBrushesL();

    SetAnchors();

    iFaderVisual = CAlfImageVisual::AddNewL( *iControl, iParentLayout );

    iHeaderLayout = CAlfDeckLayout::AddNewL( *iControl, iParentLayout );

    iHeaderLayout->SetFlags( EAlfVisualFlagAutomaticLocaleMirroringEnabled );

    iHeaderTextVisual = CAlfTextVisual::AddNewL( *iControl, iHeaderLayout );

    iHeaderTextVisual->SetWrapping( CAlfTextVisual::ELineWrapTruncate );

    iHeaderTextVisual->SetTextL( KNullDesC );

    TRgb headerTextColor( KRgbBlack );

    AknsUtils::GetCachedColor( AknsUtils::SkinInstance(), 

                               headerTextColor, KAknsIIDFsTextColors, EAknsCIFsTextColorsCG10 );

    iHeaderTextVisual->SetColor( headerTextColor );

    iHeaderTextVisual->SetTextStyle( iAppUi.LayoutHandler()->

        FSTextStyleFromLayoutL( AknLayoutScalable_Apps::main_sp_fs_ctrlbar_pane_t1( 0 ) ).Id() );

    if ( AknLayoutUtils::LayoutMirrored() )

        {

        iHeaderTextVisual->SetAlign( EAlfAlignHRight, EAlfAlignVCenter );

        }

    else

        {

        iHeaderTextVisual->SetAlign( EAlfAlignHLeft, EAlfAlignVCenter );

        }

	iHeaderTextVisual->SetOpacity( KFSInvisible );

	iHeaderLayout->SetOpacity( KFSInvisible );

    iListLayout = CAlfDeckLayout::AddNewL( *iControl, iParentLayout );

    iListLayout->SetFlags(EAlfVisualFlagLayoutUpdateNotification|EAlfVisualFlagAutomaticLocaleMirroringEnabled);

    iTreeVisualizer = CFsTreeVisualizerBase::NewL(iControl, *iListLayout);

    iTreeVisualizer->SetItemExpansionDelay( iAppUi.LayoutHandler()->ListItemExpansionDelay() );

    iTreeVisualizer->SetScrollTime( iAppUi.LayoutHandler()->ListScrollingTime() );

    iTreeVisualizer->SetFadeInEffectTime( iAppUi.LayoutHandler()->CtrlBarListFadeEffectTime() );

    iTreeVisualizer->SetFadeOutEffectTime( iAppUi.LayoutHandler()->CtrlBarListFadeEffectTime() );

    iTreeVisualizer->SetItemSeparatorSize( TSize(0, 0) );

    iTreeVisualizer->SetExpandCollapseAllOnLongTap( EFalse );

    iTreeList = CFsTreeList::NewL( *iTreeVisualizer, iEnv );

    // Compared to S60 3.2.3 in S60 5.0 Alf offers the key events in

    // opposite order.

    ControlGroup().AppendL( iControl );

    ControlGroup().AppendL( iTreeList->TreeControl() ); 

    iTreeList->AddObserverL(*this);

    iTreeList->SetLoopingType( EFsTreeListLoopingJumpToFirstLast );

    iTreeList->SetScrollbarVisibilityL( EFsScrollbarAuto );

    iAppUi.LayoutHandler()->SetListMarqueeBehaviour( iTreeList );

    iTreeList->HideListL();

    // Set page up and page down keys

    iTreeVisualizer->AddCustomPageUpKey( EStdKeyPageUp );

    iTreeVisualizer->AddCustomPageDownKey( EStdKeyPageDown );

    iTreeVisualizer->SetIndentationL(

            iAppUi.LayoutHandler()->FolderListIndentation(iScreenRect) );

    iTreeVisualizer->SetSelectorPropertiesL(

            iAppUi.FsTextureManager()->NewListSelectorBrushL(), 1.0,

            CFsTreeVisualizerBase::EFsSelectorMoveSmoothly );

    iAsyncCallback = new (ELeave) CAsyncCallBack( CActive::EPriorityStandard );

    //iNotifierTest = CSimpleAOTest::NewL();

    iFirstStartCompleted = ETrue;

    }

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

// CFSEmailUiFolderListVisualiser::Id

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

//

TUid CFSEmailUiFolderListVisualiser::Id() const

	{

    FUNC_LOG;

	return FolderListId;

	}			   

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

// CFSEmailUiFolderListVisualiser::PrepareFolderListL

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

//

void CFSEmailUiFolderListVisualiser::PrepareFolderListL()

    {

    FUNC_LOG;

    iTreeList->RemoveAllL();

    iListItemVisulizers.Reset();

    iModel->RemoveAll();

    iMoreFoldersItemId = KFsTreeNoneID;

    // SetRect need to be called twice for the parent layout (before and after

    // list construction), otherwise the layout is incorrect in some cases.

    UpdateListSizeAttributes();

    iParentLayout->SetRect( iScreenRect );

    SetAnchors();

    ResizeListIcons();

    // Show empty screen when offline

    CEikButtonGroupContainer* cba = CEikButtonGroupContainer::Current();

    if( iModel->Count() == 0 )

        {

        cba->SetCommandSetL( R_FREESTYLE_EMAUIL_UI_SK_OPTIONS_BACK );

        }

    if( iMoveOrCopyInitiated )

        {

        iTreeVisualizer->SetEmptyListTextL( KNullDesC );    

        iTreeVisualizer->RefreshListViewL();    

        }

	}

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

// CFSEmailUiFolderListVisualiser::PopulateFolderListL

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

//

void CFSEmailUiFolderListVisualiser::PopulateFolderListL()

    {

    FUNC_LOG;

    if ( !iFullScreen && iSortListCallback )

        {

        UpdateSortListL();

        SetFocusToCurrentSortItemL();

        }

  	else

        {

        UpdateFolderListL();

        if( !iFullScreen )

            {

            SetFocusToCurrentFolderL();

            }

        }

    if( !iFullScreen )

        {

        AdaptScreenRectToListContent();

        }

  	iParentLayout->SetRect(iScreenRect);

    CEikButtonGroupContainer* cba = CEikButtonGroupContainer::Current();

  	if( iModel->Count() > 0 )

  	    {

        cba->SetCommandSetL( R_FREESTYLE_EMAUIL_UI_SK_OPTIONS_BACK__SELECT );

  	    }

    if( iMoveOrCopyInitiated )

        {

        HBufC* emptyListText = StringLoader::LoadLC( 

               R_FREESTYLE_EMAIL_UI_FOLDER_LIST_NO_FOLDERS_AVAILABLE );

        iTreeVisualizer->SetEmptyListTextL( *emptyListText );

        CleanupStack::PopAndDestroy( emptyListText );

        iTreeVisualizer->RefreshListViewL();

        }

	}

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

// CFSEmailUiFolderListVisualiser::PopulateFolderListDeferred

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

//

void CFSEmailUiFolderListVisualiser::PopulateFolderListDeferred()

    {

    FUNC_LOG;

    if ( iAsyncCallback )

        {

        iAsyncCallback->Cancel();

        iAsyncCallback->Set( TCallBack( DoPopulateFolderList, this ) );

        iAsyncCallback->CallBack();

        }

    }

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

// CFSEmailUiFolderListVisualiser::DoPopulateFolderList

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

//

TInt CFSEmailUiFolderListVisualiser::DoPopulateFolderList( TAny* aSelfPtr )

    {

    FUNC_LOG;

    CFSEmailUiFolderListVisualiser* self =

        static_cast< CFSEmailUiFolderListVisualiser* >( aSelfPtr );

    TRAPD( err, 

        self->PopulateFolderListL();

        if ( self->iCustomMessageId == KFolderListMoveMessage ||

             self->iCustomMessageId == KFolderListMoveMessages ||

             self->iCustomMessageId == KFolderListCopyMessage ||

             self->iCustomMessageId == KFolderListCopyMessages )

            {

            self->SetFocusToLatestMovedFolderL();

            }

        self->iTreeList->SetFocusedL( ETrue );

        );

    return err;

    }

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

// CFSEmailUiFolderListVisualiser::IsPopupShown

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

//

TBool CFSEmailUiFolderListVisualiser::IsPopupShown()

    {

    return iPopupListShown;

    }

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

// CFSEmailUiFolderListVisualiser::HidePopupL

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

//

void CFSEmailUiFolderListVisualiser::HidePopupL()

	{

    FUNC_LOG;

    iParentLayout->SetRect( iCtrlButtonRect, iAppUi.LayoutHandler()->CtrlBarListFadeEffectTime() );

    TAlfTimedValue bgOpacity;

	// Hiding delay was removed to get rid of flickering if changing between

	// folderlist / sortlist popups. If delay is used in SetTarget,

	// folderlistview would be quickly drawn as fullscreen after HideListL

	// call, effecting ugly flickering

    bgOpacity.SetTarget( 0, 0 );

    iParentLayout->SetOpacity( bgOpacity );

	iTreeList->HideListL();

	iTreeList->DisableKineticScrolling( EFalse );

	ClearPopupSoftkeys();

	iPopupListShown = EFalse;

	}

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

// CFSEmailUiFolderListVisualiser::SetPopupSoftkeysL

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

//

void CFSEmailUiFolderListVisualiser::SetPopupSoftkeysL()

	{

    FUNC_LOG;

    CEikButtonGroupContainer* cba = CEikButtonGroupContainer::Current();

    cba->AddCommandSetToStackL( R_AVKON_SOFTKEYS_SELECT_CANCEL__SELECT);

    cba->UpdateCommandObserverL( cba->PositionById( EAknSoftkeySelect ), *this );

    cba->UpdateCommandObserverL( cba->PositionById( EEikBidCancel ), *this );

    cba->DrawNow();

	}

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

// CFSEmailUiFolderListVisualiser::ClearPopupSoftkeys

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

//

void CFSEmailUiFolderListVisualiser::ClearPopupSoftkeys()

	{

    FUNC_LOG;

    CEikButtonGroupContainer* cba = CEikButtonGroupContainer::Current();

    if (cba->UpdatedCommandObserverExists(CEikButtonGroupContainer::ELeftSoftkeyPosition))

        {

        cba->RemoveCommandObserver( cba->PositionById( EAknSoftkeySelect ) );

        }

    if (cba->UpdatedCommandObserverExists(CEikButtonGroupContainer::ERightSoftkeyPosition))

        {

        cba->RemoveCommandObserver( cba->PositionById( EEikBidCancel ) );

        }

    TInt pos = -1;

    if ((pos = cba->PositionById( EAknSoftkeySelect )) >= 0)

        {

        cba->RemoveCommandFromStack( pos, EAknSoftkeySelect );

        }

    if ((pos = cba->PositionById( EEikBidCancel )) >= 0)

        {

        cba->RemoveCommandFromStack( pos, EEikBidCancel );

        }

	}

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

// CFSEmailUiFolderListVisualiser::DoShowInPopupL

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

//

/*void CFSEmailUiFolderListVisualiser::DoShowInPopupL()*/

void CFSEmailUiFolderListVisualiser::DoShowInPopupL(

        MFsControlButtonInterface* aButton,

        MFSEmailUiFolderListCallback* aFolderCallback,

        MFSEmailUiSortListCallback* aSortCallback )

	{

    FUNC_LOG;

    if ( ( aFolderCallback == NULL && aSortCallback == NULL ) ||

            aButton == NULL )

        {

        return;

        }

    // In case of popup we are not moving or copying messages,