/*

* 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:  Implementation of mpxaddtracksdialogimp

*

*/

// INCLUDE FILES

#include <eikclb.h>

#include <eikclbd.h>

#include <eikimage.h>

#include <eiktxlbx.h>

#include <aknappui.h>

#include <akntitle.h>

#include <akncontext.h>

#include <aknlists.h>

#include <aknsfld.h>

#include <gulicon.h>

#include <AknIconArray.h>

#include <AknIconUtils.h>

#include <StringLoader.h>

#include <aknnotewrappers.h>

#include <e32base.h>

#include <barsread.h>

#include <bautils.h>

#include <data_caging_path_literals.hrh>

#include <textresolver.h>

#include <mpxlog.h>

#include <mpxcollectionutility.h>

#include <mpxcollectionplaylist.h>

#include <mpxaddtracksdialog.rsg>

#include <mpxaddtracksdialog.mbg>

#include <mpxcollectionhelperfactory.h>

#include <mpxcollectionplaylist.h>

#include <mpxmediageneraldefs.h>

#include <mpxmediacontainerdefs.h>

#include <mpxmedia.h>

#include <mpxmediamusicdefs.h>

#include <mpxmediaarray.h>

#include <mpxmessagegeneraldefs.h>

#include <mpxcollectionmessage.h>

#include <mpxuser.h>

#include "mpxcommonuihelper.h"

#include "mpxaddtracksdialogcommon.h"

#include "mpxaddtracksdialog.hrh"

#include "mpxaddtracksdialog.h"

#include "mpxaddtrackslistmodel.h"

#include "mpxaddtrackslbxarray.h"

#include <mpxlbxextendedfeatures.h>

// CONSTANTS

const TInt KMPXATMaxExpandedGroupNum = 1;

// Animation timer defined in UI spec

const TInt KAnimationFrame1Timer = 50000;

const TInt KAnimationFrame2Timer = 100000;

const TInt KAnimationFrame3Timer = 100000;

const TInt KAnimationFrame4Timer = 500000;

const TInt KAnimationFrameTimerInterval = 1;

const TInt KMaxTitleLength = 261;  // 255 + 6 for tab

_LIT( KMPXAddTracksDialogRscPath, "mpxaddtracksdialog.rsc" );

_LIT(KMPXSpace," ");

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

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

// CMPXAddTracksDialog::NewL

// Two-phased constructor.

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

//

EXPORT_C CMPXAddTracksDialog* CMPXAddTracksDialog::NewL()

    {

    MPX_FUNC( "CMPXAddTracksDialog::NewL" );

    CMPXAddTracksDialog* self = CMPXAddTracksDialog::NewLC();

    CleanupStack::Pop();

    return self;

    }

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

// CMPXAddTracksDialog::NewLC

// Two-phased constructor.

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

//

EXPORT_C CMPXAddTracksDialog* CMPXAddTracksDialog::NewLC()

    {

    MPX_FUNC( "CMPXAddTracksDialog::NewLC" );

    CMPXAddTracksDialog* self = new ( ELeave ) CMPXAddTracksDialog();

    CleanupStack::PushL( self );

    self->LoadResourceL();

    self->ConstructL( R_AVKON_SOFTKEYS_EMPTY );

    return self;

    }

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

// Destructor

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

//

EXPORT_C CMPXAddTracksDialog::~CMPXAddTracksDialog()

    {

    MPX_FUNC( "CMPXAddTracksDialog::~CMPXAddTracksDialog" );

    TRAP_IGNORE( RestorePreviousStatusPaneL() );

    if ( iCollectionUtility )

        {

        iCollectionUtility->Close();

        }

    if ( iCollectionUiHelper )

        {

        iCollectionUiHelper->Cancel();

        iCollectionUiHelper->Close();

        }

    if ( iOrigIcon )

        {

        delete iOrigIcon;

        }

    if ( iNewIcon )

        {

        delete iNewIcon;

        }

    if ( iLastFindTxt )

        {

        delete iLastFindTxt;

        }

    iMatchedSongArray.Reset();

    iMatchedGroupArray.Reset();

    delete iOrigTitle;

    delete iListModel;

    delete iNoSongText;

    delete iNoMatchText;

    if( iPeriodic )

        {

        delete iPeriodic;

        }

    delete iLbxExtFeat;

    if ( iResourceOffset )

        {

        iEikonEnv->DeleteResourceFile( iResourceOffset );

        }

    if ( iCategoryArray )

        {

        iCategoryArray->Reset();

        delete iCategoryArray;

        }

    if ( iAllSongsArray )

        {

        iAllSongsArray->Reset();

        delete iAllSongsArray;

        }

    delete iCommonUiHelper;

    delete iIdle;

    }

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

// CMPXAddTracksDialog::CMPXAddTracksDialog

// C++ default constructor can NOT contain any code, that

// might leave.

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

//

CMPXAddTracksDialog::CMPXAddTracksDialog():

    CAknSelectionListDialog( iLastIndex, NULL, 0 ),

    iAnimIconIndex( 0 ),

    iSongAllGroupExist( ETrue )

    {

    }

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

// CMPXAddTracksDialog::ConstructL

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::ConstructL( TInt aResource )

    {

    MPX_FUNC( "CMPXAddTracksDialog::ConstructL" );

    CAknSelectionListDialog::ConstructL( aResource );

    iCollectionUtility = MMPXCollectionUtility::NewL( this, KMcModeDefault );

    iCollectionUiHelper = CMPXCollectionHelperFactory::NewCollectionUiHelperL();

    iCommonUiHelper = CMPXCommonUiHelper::NewL();

    iNoSongText = StringLoader::LoadL( R_MPX_CUI_CATEGORY_ADDSONGVIEW_LBX_NOSONGTEXT );

    iNoMatchText = StringLoader::LoadL( R_MPX_CUI_CATEGORY_ADDSONGVIEW_LBX_EMPTYTEXT );

    }

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

// CMPXAddTracksDialog::BackupPreviousStatusPaneL()

// Backup previous status pane to internal members.

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::BackupPreviousStatusPaneL()

    {

    MPX_FUNC( "CMPXAddTracksDialog::BackupPreviousStatusPaneL" );

    CEikStatusPane* sp = iAvkonAppUi->StatusPane();

    // Backup title pane

    iTitlePane = static_cast<CAknTitlePane*>

        ( sp->ControlL( TUid::Uid( EEikStatusPaneUidTitle ) ) );

    iOrigTitle = iTitlePane->Text()->AllocL();

    // Backup context pane only if new context icon is created

    if ( iNewIcon )

        {

        iContextPane = static_cast<CAknContextPane*>

            ( sp->ControlL( TUid::Uid( EEikStatusPaneUidContext ) ) );

        iOrigIcon = iContextPane->SwapPicture( iNewIcon );

        iNewIcon = NULL;

        }

    }

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

// CMPXAddTracksDialog::RestorePreviousStatusPaneL()

// Restore previous status pane from internal members.

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::RestorePreviousStatusPaneL()

    {

    MPX_FUNC( "CMPXAddTracksDialog::RestorePreviousStatusPaneL" );

    if ( iOrigTitle )

        {

        // Set original title pane

        iTitlePane->SetTextL( *iOrigTitle );

        }

    // Restore original context icon

    if ( iOrigIcon )

        {

        iNewIcon = iContextPane->SwapPicture( iOrigIcon );

        iOrigIcon = NULL;

        }

    }

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

// CMPXAddTracksDialog::CreateContextIconL()

// Create context icon for add tracks dialog.

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::CreateContextIconL()

    {

    MPX_FUNC( "CMPXAddTracksDialog::CreateContextIconL" );

    TParse parse;

    parse.Set( KMPXAddTracksBmpFile, &KDC_APP_RESOURCE_DIR, NULL );

    TFileName iconFile( parse.FullName() );

    User::LeaveIfError( MPXUser::CompleteWithDllPath( iconFile ) );

    MAknsSkinInstance* skin( AknsUtils::SkinInstance() );

    CFbsBitmap* bitmap = NULL;

    CFbsBitmap* mask = NULL;

    AknsUtils::CreateIconLC(

            skin,

            KAknsIIDNone,

            bitmap,

            mask,

            iconFile,

            EMbmMpxaddtracksdialogQgn_graf_mup_ctx_addsong,

            EMbmMpxaddtracksdialogQgn_graf_mup_ctx_addsong_mask );

    iNewIcon = new ( ELeave ) CEikImage();

    iNewIcon->SetPicture( bitmap, mask );

    iNewIcon->SetPictureOwnedExternally( EFalse );

    CleanupStack::Pop( 2 ); // bitmap, mask

    }

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

// CMPXAddTracksDialog::UpdateSoftkeyL()

// Update softkey.

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::UpdateSoftkeyL()

    {

    MPX_FUNC( "CMPXAddTracksDialog::UpdateSoftkeyL" );

    TInt resId( 0 );

    TInt index = CurrentLbxItemIndex();

    CAknSearchField* findBox = FindBox();

    TBool findBoxVisible = ( findBox->IsVisible() ) && ( findBox->IsFocused() );

    MPX_DEBUG2( "CMPXAddTracksDialog::UpdateSoftkeyL index = %d", index);

    iListBox->View()->SetListEmptyTextL(

        findBoxVisible? *iNoMatchText : *iNoSongText );

    if ( iListBox->Model()->NumberOfItems() == 0 )

        {

        // redraw empty text

        iListBox->DrawDeferred();

        }

    if ( index == KErrNotFound )

        {

        resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_EMPTY_DONE;

        if ( findBoxVisible )

            {

            resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_EMPTY_CANCEL;

            }

        }

    else

        {

        TInt id = iListModel->TrackTypeL( index );

        if ( id == EMPXGroup )

            {

            resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_EXPAND_DONE;

            if ( findBoxVisible )

                {

                resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_EXPAND_CANCEL;

                }

            if ( iListModel->IsExpandedIndex( index ) )

                {

                resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_COLLAPSE_DONE;

                if ( findBoxVisible )

                    {

                    resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_COLLAPSE_CANCEL;

                    }

                }

            }

        else

            {

            resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_ADD_DONE;

            if ( findBoxVisible )

                {

                resId = R_MPX_CUI_ADDTRACKS_SOFTKEYS_ADD_CANCEL;

                }

            }

        }

    ButtonGroupContainer().SetCommandSetL( resId );

    // A temporary RSK command observer is registered so that FindBox 

    // cannot register its own RSK command observer. This way it will

    // not handle the RSK but the ProcessCommandL method in this dialog

    // will do it. The observer must not be removed, because if there 

    // is no observer registered when the find box is closed, then 

    // the execution of CAknSearchField::RestorePopupCBA will raise a

    // panic.

   	if( !ButtonGroupContainer().UpdatedCommandObserverExists( 

		CEikButtonGroupContainer::ERightSoftkeyPosition ) )

   		{

   		MPX_DEBUG1( "CMPXAddTracksDialog::UpdateSoftkeyL: Adding RSK observer" );

   		ButtonGroupContainer().UpdateCommandObserverL( 2, *this );

   		}

    ButtonGroupContainer().DrawDeferred();

    }

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

// CMPXAddTracksDialog::UpdateListboxByCategoryL()

// Update listbox content by category.

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::UpdateListboxByCategoryL( const CMPXMedia& aMedia  )

    {

    MPX_FUNC( "CMPXAddTracksDialog::UpdateListboxByCategoryL" );

    // Reset tracks list

    iListModel->ResetTracksList();

    // Insert "Songs (all)" to model

    CMPXMediaArray* media =

        const_cast<CMPXMediaArray*>(aMedia.Value<CMPXMediaArray>(

        KMPXMediaArrayContents ) );

    User::LeaveIfNull( media );

    delete iCategoryArray;

    iCategoryArray = NULL;

    iCategoryArray = CMPXMediaArray::NewL();

    TInt count = media->Count();

    for ( TInt i = 0; i < count; i++ )

        {

        CMPXMedia* orig( media->AtL( i ) );

        User::LeaveIfNull( orig );

        CMPXMedia* copy( CMPXMedia::NewL( *orig ) );

        CleanupStack::PushL( copy );

        iCategoryArray->AppendL( copy );

        CleanupStack::Pop( copy );

        }

    if ( count > 0 )

        {

        // change display text to unknown if the last entry is null

        CMPXMedia* aryMedia( media->AtL( count - 1 ) );

        User::LeaveIfNull( aryMedia );

        if ( aryMedia->ValueText( KMPXMediaGeneralTitle ).Length() == 0 )

            {

            HBufC* text = StringLoader::LoadLC(

                R_MPX_QTN_MP_UNKNOWN );

            CMPXMedia* catMedia( iCategoryArray->AtL( count - 1 ) );

            User::LeaveIfNull( catMedia );

            catMedia->SetTextValueL( KMPXMediaGeneralTitle, *text );

            aryMedia->SetTextValueL( KMPXMediaGeneralTitle, *text );

            CleanupStack::PopAndDestroy( text );

            }

        CMPXMedia* entry = CMPXMedia::NewL();

        CleanupStack::PushL( entry );

        HBufC* string =

            StringLoader::LoadLC( R_MPX_CUI_ADDSONGS_ADD_ALLSONGS_TXT );

        entry->SetTextValueL(

            KMPXMediaGeneralTitle, *string );

        media->Insert( entry, 0 );

        CleanupStack::PopAndDestroy( string );

        CleanupStack::Pop( entry );

        // Insert artists to model

        iListModel->InsertGroupsL( *media, -1, EMPXSong );

        HandleItemArrayChangeL();

        iSongAllGroupExist = ETrue;

        }

    else

        {

        MPX_DEBUG1( "CMPXAddTracksDialog::UpdateListboxByCategoryL no song" );

        // no song

        iSongAllGroupExist = EFalse;

        }

    }

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

// CMPXAddTracksDialog::UpdateListboxByCategoryforFindL()

// Update listbox content by category after find.

// (other items were commented in a header).

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

//

void CMPXAddTracksDialog::UpdateListboxByCategoryforFindL(

    TBool aFind, TInt aSongNum)

    {

    MPX_FUNC( "CMPXAddTracksDialog::UpdateListboxByCategoryforFindL" );

    if( aFind )

        {

        if( aSongNum != 0 )

            {

            // Insert "Songs (%N)" to list box model, change "%N" to matched songs' number

            CMPXMediaArray* media = CMPXMediaArray::NewL();

            CleanupStack::PushL( media );

            CMPXMedia* entry = CMPXMedia::NewL();

            CleanupStack::PushL( entry );

            HBufC* string = string = StringLoader::LoadLC(

                            R_MPX_CUI_ADDSONGS_ADD_SONGS_NUM_TXT, aSongNum );

            entry->SetTextValueL( KMPXMediaGeneralTitle, *string );

            media->AppendL( entry );

            iListModel->InsertGroupsL( *media, 0, EMPXSong );

            CleanupStack::PopAndDestroy( string );

            CleanupStack::Pop( entry );

            CleanupStack::PopAndDestroy( media );

            iSongAllGroupExist = ETrue;

            }

        else

            {

            iSongAllGroupExist = EFalse;

            }

        // Insert found groups

        TInt matchedGroupCount = iMatchedGroupArray.Count();

        if( matchedGroupCount > 0 )

            {

            CMPXMediaArray* media = CMPXMediaArray::NewL();

            CleanupStack::PushL( media );

            for ( TInt i = 0; i < matchedGroupCount; i++ )

                {

                TInt catIndex = iMatchedGroupArray[ i ];

                CMPXMedia* catMedia( iCategoryArray->AtL( catIndex ) );

                User::LeaveIfNull( catMedia );

                CMPXMedia* entry = CMPXMedia::NewL( *catMedia  );

                CleanupStack::PushL( entry );

                media->AppendL( entry );

                CleanupStack::Pop( entry );

                }

            if( !iSongAllGroupExist )

                {

                iListModel->InsertGroupsL( *media, 0 );

                }

            else

                {

                iListModel->InsertGroupsL( *media, 1 );

                }

            CleanupStack::PopAndDestroy( media );

            }

        }

    else

        {

        iListModel->ResetTracksList();

        }

    HandleItemArrayChangeL();

    }

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

// CMPXAddTracksDialog::CurrentLbxItemIndex

// Gets current listbox item index.

// (other items were commented in a header).

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

//

TInt CMPXAddTracksDialog::CurrentLbxItemIndex() const

    {

    MPX_FUNC( "CMPXAddTracksDialog::CurrentLbxItemIndex" );

    CTextListBoxModel* lbxModel = iListBox->Model();

    CAknSearchField* findBox = FindBox();

    TInt currentItem = iListBox->CurrentItemIndex();

    TInt count = lbxModel->NumberOfItems();

    // Make sure there's at least one item in the listbox

    if ( findBox && count )

        {

        CAknFilteredTextListBoxModel* filteredLbxModel =

            static_cast<CAknFilteredTextListBoxModel*>( lbxModel );

        CAknListBoxFilterItems* filterItems = filteredLbxModel->Filter();

        // Get the real listbox index

        currentItem = filterItems->FilteredItemIndex( currentItem );

        }

    return currentItem;

    }