/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Symbian Foundation License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.symbianfoundation.org/legal/sfl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: This file implements classes CFSEmailUiMailListVisualiser, CMailListUpdater, CMsgMovedNoteTimer, CDateChangeTimer.

*

*/

// SYSTEM INCLUDES

#include "emailtrace.h"

#include <freestyleemailui.mbg>

#include <AknUtils.h>

#include <gulicon.h>

#include <StringLoader.h>

#include <FreestyleEmailUi.rsg>

//<cmail>

#include <featmgr.h>

//</cmail>

#include "CFSMailClient.h"

#include "CFSMailBox.h"

#include "CFSMailFolder.h"

#include "fscontrolbar.h"

#include "fscontrolbuttoninterface.h"

#include "fstreelist.h"

#include "fstreevisualizerbase.h"

#include "fstreeplainonelinenodedata.h"

#include "fstreeplainonelinenodevisualizer.h"

#include "fstreeplaintwolineitemdata.h"

#include "fstreeplaintwolineitemvisualizer.h"

#include "CFSMailCommon.h"

#include "ceuiemaillisttouchmanager.h"

#include "FSEmailBuildFlags.h"

#include "cfsccontactactionmenu.h"

#include "mfsccontactactionmenumodel.h"

#include <hlplch.h>

#include <AknIconArray.h>

#include <alf/alfdecklayout.h>

#include <alf/alfcontrolgroup.h>

#include <alf/alfframebrush.h>

#include <alf/alfevent.h>

#include <alf/alfstatic.h>

#include <aknnotewrappers.h>

#include <msvapi.h>

#include <akntitle.h>

//<cmail>

#include "ESMailSettingsPluginUids.hrh"

#include "ESMailSettingsPlugin.h"

#include "MFSMailBrandManager.h"

//</cmail>

#include <AknWaitDialog.h>

// <cmail>

#include <aknlayoutscalable_apps.cdl.h>

#include <layoutmetadata.cdl.h>

#include <csxhelp/cmail.hlp.hrh>

// </cmail>

// Meeting request

#include <MeetingRequestUids.hrh>

// <cmail>

#include "cesmricalviewer.h"

//</cmail>

#include <aknstyluspopupmenu.h>

// INTERNAL INCLUDES

#include "FreestyleEmailUiUtilities.h"

#include "FreestyleEmailUiLiterals.h"

#include "FreestyleEmailUiLayoutHandler.h"

#include "FreestyleEmailUiMailListModel.h"

#include "FreestyleEmailUiMailListVisualiser.h"

#include "FreestyleEmailUiFileSystemInfo.h"

#include "FreestyleEmailUiAppui.h"

#include "FreestyleEmailUi.hrh"

#include "FreestyleEmailUiTextureManager.h"

#include "FreestyleEmailUiMailListControl.h"

#include "FreestyleEmailUiMailViewerVisualiser.h"

#include "FreestyleEmailUiStatusIndicator.h"

#include "FreestyleEmailCenRepHandler.h"

#include "FreestyleEmailUiFolderListVisualiser.h"

#include "FreestyleEmailUiShortcutBinding.h"

#include "FreestyleEmailUiMsgDetailsVisualiser.h"

#include "FreestyleEmailDownloadInformationMediator.h"

#include "FreestyleEmailUiContactHandler.h"

#include "FreestyleEmailUiLauncherGridVisualiser.h"

#include "FreestyleEmailUiHtmlViewerView.h"

#include "FSDelayedLoader.h"

#include "FSEmail.pan"

// CONST VALUES

const TInt KControlBarTransitionTime = 250;

const TInt KMaxPreviewPaneLength = 60;

const TInt KMsgUpdaterTimerDelay = 2500000; // Time to update list, 2,5sec

static const TInt KMsgDeletionWaitNoteAmount = 5;

_LIT( KMissingPreviewDataMarker, "..." );

static const TInt KMaxItemsFethed = 1000;

static const TInt KCMsgBlock = 100;

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

// Static constructor.

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

//

CFSEmailUiMailListVisualiser* CFSEmailUiMailListVisualiser::NewL(CAlfEnv& aEnv,

																 CFreestyleEmailUiAppUi* aAppUi,

																 CAlfControlGroup& aMailListControlGroup )

    {

    FUNC_LOG;

    CFSEmailUiMailListVisualiser* self = CFSEmailUiMailListVisualiser::NewLC(aEnv, aAppUi, aMailListControlGroup );

    CleanupStack::Pop(self);

    return self;

    }

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

// Static constructor.

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

//

CFSEmailUiMailListVisualiser* CFSEmailUiMailListVisualiser::NewLC(CAlfEnv& aEnv,

																  CFreestyleEmailUiAppUi* aAppUi,

																  CAlfControlGroup& aMailListControlGroup)

    {

    FUNC_LOG;

    CFSEmailUiMailListVisualiser* self =

        new (ELeave) CFSEmailUiMailListVisualiser( aEnv, aAppUi, aMailListControlGroup );

    CleanupStack::PushL( self );

    self->ConstructL();

    return self;

    }

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

// Second phase constructor.

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

//

void CFSEmailUiMailListVisualiser::ConstructL()

	{

    FUNC_LOG;

	BaseConstructL( R_FSEMAILUI_MAIL_LIST_VIEW );

	// Don't construct this anywhere else than here.

	// Don't delete this until in the destructor to avoid NULL checks.

    iModel = CFSEmailUiMailListModel::NewL( &iAppUi );

	// Set list as initial focused control

	iFocusedControl = EMailListComponent;

	iThisViewActive = EFalse;

	iSkinChanged = EFalse;

	iFirstStartCompleted = EFalse;

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

	iAsyncRedrawer = new (ELeave) CAsyncCallBack( CActive::EPriorityLow );

 	}

// CFSEmailUiMailListVisualiser::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 CFSEmailUiMailListVisualiser::DoFirstStartL()

    {

    FUNC_LOG;

    // Create mail list updater timer

    iMailListUpdater = CMailListUpdater::NewL( this );

    // Set initial sort criteria

    iCurrentSortCriteria.iField = EFSMailSortByDate;

    iCurrentSortCriteria.iOrder = EFSMailDescending;

    // Create screen control and anchor layout

    iMailListControl = CFreestyleEmailUiMailListControl::NewL( iEnv, this );

    iScreenAnchorLayout = CAlfAnchorLayout::AddNewL( *iMailListControl );

    iScreenAnchorLayout->SetFlags(EAlfVisualFlagAutomaticLocaleMirroringEnabled);

    //<cmail>

    iTouchManager = CEUiEmailListTouchManager::NewL(*this);

    //</cmail>

    // Create control bar control and append to control group and anchor layout

    iControlBarControl = CFsControlBar::NewL( iEnv );

    iControlBarControl->AddObserverL( *this );

    //<cmail>

    iControlBarControl->AddObserverL( *iTouchManager );

    //</cmail>

    CreateControlBarLayoutL();

    SetMailListLayoutAnchors();

    iControlBarControl->SetSelectorTransitionTimeL( KControlBarTransitionTime );

    iControlBarControl->ClearBackgroundColor();

    iControlBarLayout = CAlfDeckLayout::AddNewL( *iControlBarControl, iScreenAnchorLayout );

    iControlBarVisual = iControlBarControl->Visual();

    // Create list and append to control group and anchor layout

    iListLayout = CAlfDeckLayout::AddNewL( *iMailListControl, iScreenAnchorLayout );

    iMailTreeListVisualizer = CFsTreeVisualizerBase::NewL(iMailListControl, *iListLayout);

    iMailTreeListVisualizer->SetFlipState( iKeyboardFlipOpen );

    iMailTreeListVisualizer->SetFocusVisibility( iFocusVisible );

    iMailList = CFsTreeList::NewL(*iMailTreeListVisualizer, iEnv );

    // Set mark type and icon

    iMailList->SetMarkTypeL( CFsTreeList::EFsTreeListMultiMarkable );

    iMailList->SetIndentationL(0);

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

    // opposite order.

    ControlGroup().AppendL( iMailListControl );

    ControlGroup().AppendL( iControlBarControl );

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

    //</cmail>

    iTreeItemArray.Reset();

    // Set empty text

    HBufC* emptyText = StringLoader::LoadLC( R_FREESTYLE_EMAIL_UI_EMPTY_MSG_LIST_TEXT );

    iMailTreeListVisualizer->SetEmptyListTextL( *emptyText );

    CleanupStack::PopAndDestroy( emptyText );

    TRgb normalColor = iAppUi.LayoutHandler()->ListNormalStateTextSkinColor();

    iMailTreeListVisualizer->RootNodeVisualizer()->SetNormalStateTextColor( normalColor );

    // Set page up and page down keys

    iMailTreeListVisualizer->AddCustomPageUpKey( EStdKeyPageUp );

    iMailTreeListVisualizer->AddCustomPageDownKey( EStdKeyPageDown );

    // Set selector brushes

    CAlfBrush* listSelectorBrush = iAppUi.FsTextureManager()->ListSelectorBrushL(); // not owned

    iMailTreeListVisualizer->SetSelectorPropertiesL( listSelectorBrush, 1.0, CFsTreeVisualizerBase::EFsSelectorMoveSmoothly );

    CAlfBrush* cbSelectorBrush = iAppUi.FsTextureManager()->NewCtrlBarSelectorBrushLC();

    iControlBarControl->SetSelectorImageL( cbSelectorBrush );

    CleanupStack::Pop( cbSelectorBrush ); // ownership transferred to control bar

    // Set menu, mark and background icons

    iMailTreeListVisualizer->SetMarkIcon( iAppUi.FsTextureManager()->TextureByIndex( EListControlMarkIcon ) );

    iMailTreeListVisualizer->SetMenuIcon( iAppUi.FsTextureManager()->TextureByIndex( EListControlMenuIcon ) );

    //<cmail> s60 skin support

    //iMailTreeListVisualizer->SetBackgroundTextureL( iAppUi.FsTextureManager()->TextureByIndex( EBackgroundTextureMailList ) );

    //</cmail>

    iMailList->AddObserverL( *this );

    //<cmail>

    iMailList->AddObserverL( *iTouchManager );

    //</cmail>

    // Initializing the default stylus long tap popup menu

    if( !iStylusPopUpMenu )

        {

        TPoint point( 0, 0 );

        iStylusPopUpMenu = CAknStylusPopUpMenu::NewL( this , point );

		TResourceReader reader;

		iCoeEnv->CreateResourceReaderLC( reader,

				R_STYLUS_POPUP_MENU_MESSAGE_LIST_VIEW );

		iStylusPopUpMenu->ConstructFromResourceL( reader );

		CleanupStack::PopAndDestroy();

        }

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

    iDateChangeTimer = CDateChangeTimer::NewL( *this );

    iDateChangeTimer->Start();

    UpdateMailListSettingsL();

    iMailList->SetIndentationL(0);

    iMailList->SetLoopingType( EFsTreeListLoopingDisabled );

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

    iMailList->SetScrollTime( iAppUi.LayoutHandler()->ListScrollingTime(), 0.5 );

    iFirstStartCompleted = ETrue;

    }

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

// Constructor.

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

//

CFSEmailUiMailListVisualiser::CFSEmailUiMailListVisualiser( CAlfEnv& aEnv,

    CFreestyleEmailUiAppUi* aAppUi, CAlfControlGroup& aMailListControlGroup )

    : CFsEmailUiViewBase( aMailListControlGroup, *aAppUi ),

    iEnv( aEnv ),

    iListMarkItemsState( ETrue ), //Initlly list has no markings

	{

    FUNC_LOG;

	}

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

// Destructor.

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

//

CFSEmailUiMailListVisualiser::~CFSEmailUiMailListVisualiser()

    {

    FUNC_LOG;

    if ( iMailFolder )

        {

        delete iMailFolder;

        iMailFolder = NULL;

        }

    delete iTouchManager;

    delete iStylusPopUpMenu;

    delete iMailList;

	// Don't construct this anywhere else than in constructor.

	// Don't delete anywhere else thatn here to avoid NULL checks.

    delete iModel;

    }

void CFSEmailUiMailListVisualiser::PrepareForExit()

    {

    FUNC_LOG;

    if ( iMsgNoteTimer )

        {

        iMsgNoteTimer->Cancel();

        delete iMsgNoteTimer;

        iMsgNoteTimer = NULL;

        }

    if ( iDateChangeTimer )

        {

        iDateChangeTimer->Cancel();

        delete iDateChangeTimer;

        iDateChangeTimer = NULL;

        }

    if ( iMailListUpdater )

        {

        iMailListUpdater->Stop();

        delete iMailListUpdater;

        iMailListUpdater = NULL;

        }

    if ( iAsyncRedrawer )

        {

        iAsyncRedrawer->Cancel();

        delete iAsyncRedrawer;

        iAsyncRedrawer = NULL;

        }

    if ( iAsyncCallback )

        {

        iAsyncCallback->Cancel();

        delete iAsyncCallback;

        iAsyncCallback = NULL;

        }

    if ( iMailList )

        {

        iMailList->RemoveObserver( *this );

        }

    if ( iControlBarControl )

        {

        iControlBarControl->RemoveObserver( *this );

        }

    // <cmail>

    iTreeItemArray.Reset();

    if ( iMailFolder )

        {

        delete iMailFolder;

        iMailFolder = NULL;

        }

	// Reset, not delete to avoid NULL checks.

    iModel->Reset();

    // </cmail>

    }

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

// Returns reference to mail list.

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

//

CFsTreeList& CFSEmailUiMailListVisualiser::GetMailList()

	{

    FUNC_LOG;

	return *iMailList;

	}

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

//

//

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

//

void CFSEmailUiMailListVisualiser::UpdateMailListModelL()

    {

    FUNC_LOG;

    // Reset model with each update

	iModel->Reset();

	if ( iMailFolder )

		{

		// Update folder if provided, otherwise use current folder

		RPointerArray<CFSMailMessage> folderMessages( KCMsgBlock );

		CleanupClosePushL( folderMessages );

		RPointerArray<CFSMailMessage> tempFolderMessages( KCMsgBlock );

        CleanupClosePushL( tempFolderMessages );

	 	TFSMailDetails details( EFSMsgDataEnvelope );

	    RArray<TFSMailSortCriteria> sorting;

		CleanupClosePushL( sorting );

	    sorting.Append( iCurrentSortCriteria );

	    if ( iCurrentSortCriteria.iField != EFSMailSortByDate )

	    	{

            // Add date+descending as secondary sort criteria if primary field is something else than date

            TFSMailSortCriteria secondarySortCriteria;

            secondarySortCriteria.iField = EFSMailSortByDate;

            secondarySortCriteria.iOrder = EFSMailDescending;

            sorting.Append( secondarySortCriteria );

	    	}

	    // List all or maximum number of messages

	    MFSMailIterator* iterator = iMailFolder->ListMessagesL( details, sorting );

		CleanupDeletePushL( iterator ); // standard CleanupStack::PushL does not work with non-C-class pointer

		// Use iterator to get messages in peaces of KCMsgBlock to avoid OOM in FSStore

		TFSMailMsgId dummy;

        TBool moreMessagesToFollow = iterator->NextL( dummy, KCMsgBlock, folderMessages  );

        for ( TInt i = KCMsgBlock; i < KMaxItemsFethed && moreMessagesToFollow ; i += KCMsgBlock )

            {

            tempFolderMessages.Reset();

            moreMessagesToFollow = iterator->NextL( folderMessages[i-1]->GetMessageId(), KCMsgBlock, tempFolderMessages  );

            for ( TInt a=0 ; a<tempFolderMessages.Count() ; a++)

                {

                folderMessages.Append(tempFolderMessages[a]);

                }

            }

		CleanupStack::PopAndDestroy( iterator );

		CleanupStack::PopAndDestroy( &sorting );

		// Update mail list model based on sorting criteria

		CreateModelItemsL( folderMessages );

		CleanupStack::PopAndDestroy( &tempFolderMessages );

		CleanupStack::PopAndDestroy( &folderMessages );

		}

    }

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

// CreateModelItemsL

// This function creates model items for the given messages and appends them

// to the model. Also title divider items are created when necessary.

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

//

void CFSEmailUiMailListVisualiser::CreateModelItemsL( RPointerArray<CFSMailMessage>& aMessages )

	{

    FUNC_LOG;

	// New Items

	// Draw first separator if there are messages.

	if ( aMessages.Count() && iNodesInUse == EListControlSeparatorEnabled )

		{

	    newItem = CreateSeparatorModelItemLC( *aMessages[0] );

	    iModel->AppendL( newItem );

		CleanupStack::Pop( newItem );

		}

	// Start appending items

    for (int i = 0; i < aMessages.Count(); i++)

	    {

	    CFSMailMessage* curMessage = aMessages[i];

	    if ( curMessage )

	        {

	        newItem = CFSEmailUiMailListModelItem::NewL( curMessage, ETypeMailItem );

	        CleanupStack::PushL( newItem );

	        iModel->AppendL( newItem );

	        CleanupStack::Pop( newItem );

	        // Append new separator if needed

	        if ( i != aMessages.Count()-1 && iNodesInUse == EListControlSeparatorEnabled )

	            {

	            CFSMailMessage* nextMessage = aMessages[i+1];   // This msg is next in the list

	            if ( nextMessage )

	                {

	                TBool needANewDivider =

	                    !MessagesBelongUnderSameSeparatorL( *curMessage, *nextMessage );

	                if ( needANewDivider )

	                    {

	                    newItem = CreateSeparatorModelItemLC( *nextMessage );

	                    iModel->AppendL( newItem );

	                    CleanupStack::Pop( newItem );

	                    }

	                }

	            }

	        }

	    }

	}

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

// CreateSeparatorModelItemLC

// Create separator model item for the given message. Separator text depends

// on active sorting mode.

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

//

CFSEmailUiMailListModelItem* CFSEmailUiMailListVisualiser::CreateSeparatorModelItemLC( CFSMailMessage& aMessage ) const

    {

    FUNC_LOG;

    CFSEmailUiMailListModelItem* separator =

        CFSEmailUiMailListModelItem::NewL( &aMessage, ETypeSeparator );

    CleanupStack::PushL( separator );

    HBufC* separatorText = NULL;

    switch ( iCurrentSortCriteria.iField )

        {

        case EFSMailSortByFlagStatus:

            {

            if ( aMessage.IsFlagSet( EFSMsgFlag_FollowUp ) )

                {

                separatorText = StringLoader::LoadLC( R_FREESTYLE_EMAIL_UI_SEPARATOR_FOLLOW_UP );

                }

            else if ( aMessage.IsFlagSet( EFSMsgFlag_FollowUpComplete ) )

                {

                separatorText = StringLoader::LoadLC( R_FREESTYLE_EMAIL_UI_SEPARATOR_FLAG_COMPLETE );

                }

            else

                {

                separatorText = StringLoader::LoadLC( R_FREESTYLE_EMAIL_UI_SEPARATOR_NO_FLAG );