/*

* 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 "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: Music Player collection popup handler.

*

*/

// INCLUDE FILES

#include <hbaction.h>

#include <hbmenu.h>

#include <hbmessagebox.h>

#include <hbprogressdialog.h>

#include <hbselectiondialog.h>

#include <hbinputdialog.h>

#include <hblabel.h>

#include <hblistview.h>

#include <hbscrollbar.h>

#include "mpenginefactory.h"

#include "mpcollectionview.h"

#include "mpmpxcollectiondata.h"

#include "mpcollectiondatamodel.h"

#include "mpcollectiontbonelistdatamodel.h"

#include "mpcollectionpopuphandler.h"

#include "mptrace.h"

const int KNullIndex = -1;

const int KSongsToDisplayProgressDlg = 100;

// Popups launched by this class

const QString KContextMenu = QString( "ContextMenu" );

const QString KProgressDialog = QString( "ProgressDialog" );

const QString KAddToPlaylistSelectionDialog = QString( "AddToPlaylistSelectionDialog" );

const QString KInputTextDialog = QString( "InputTextDialog" );

const QString KGetModelIndexesListDialog = QString( "GetModelIndexesListDialog" );

const QString KArrangeSongsDialog = QString( "ArrangeSongsDialog" );

const QString KRequestDeleteMessageBox = QString( "RequestDeleteMessageBox" );

// Popups Actions

const QString KOk = QString( "Ok" );

const QString KCancel = QString( "Cancel" );

const QString KNew = QString( "New" );

const QString KOpen = QString( "Open" );

const QString KAdd = QString( "Add" );

const QString KDelete = QString( "Delete" );

const QString KRenamePlayList = QString( "RenamePlayList" );

const QString KDetails = QString( "Details" );

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

//    MpPopupHandlerPermanentData

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

/*!

    \class MpPopupHandlerPermanentData. This class is used by MpCollectionPopupHandler to

    store permanent data needed during asynchronous popups operation.

*/

class MpPopupHandlerPermanentData : public QObject

{

    public:

        MpPopupHandlerPermanentData( QObject *parent=0 );

        virtual ~MpPopupHandlerPermanentData();

        void clear();

    public:

        MpMpxCollectionData         *mIsolatedCollectionData;        // Not own

        QAbstractItemModel          *mAbstractItemModel;             // Own

        QList<int>                  mSelectedItems;

        QString                     mOriginalName;

        int                         mContextMenuIndex;

};

/*!

 Constructs the popup handler permanent data.

 */

MpPopupHandlerPermanentData::MpPopupHandlerPermanentData( QObject *parent )

    : QObject( parent ),

      mIsolatedCollectionData( 0 ),

      mAbstractItemModel( 0 ),

      mContextMenuIndex( KNullIndex )

{

      TX_ENTRY

      mSelectedItems.clear();

      mOriginalName.clear();

      TX_EXIT

}

/*!

 Destructs the popup handler permanent data.

 */

MpPopupHandlerPermanentData::~MpPopupHandlerPermanentData()

{

    TX_ENTRY

    clear();

    TX_EXIT

}

/*!

 \internal

  Clears all permanent data. 

 */

void MpPopupHandlerPermanentData::clear()

{

    TX_ENTRY

    mSelectedItems.clear();

    mOriginalName.clear();

    mContextMenuIndex = KNullIndex;

    if ( mIsolatedCollectionData ) {

        MpEngineFactory::sharedEngine()->releaseIsolatedCollection();

        mIsolatedCollectionData = 0;

    }

    if ( mAbstractItemModel ) {

        delete mAbstractItemModel;

        mAbstractItemModel = 0;

    }

    //clearing any child Objects.

    foreach (QObject* child, children()) {

        child->deleteLater();

    }

    TX_EXIT

}

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

//    MpCollectionPopupHandler

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

/*!

    \class MpCollectionPopupHandler

    \brief Music Player collection popup handler.

    This class controls the asynchronous operation of all dialogs 

    used by collection view.

*/

/*!

 Constructs the collection popup handler.

 */

MpCollectionPopupHandler::MpCollectionPopupHandler( MpCollectionView *parent )

    : QObject( parent ),

      mView( parent ),

      mOutstandingPopup( 0 ),

      mMpEngine( 0 ),

      mPermanentData( 0 ),

      mExternalEventsConnected( false )

{

    TX_ENTRY

    mMpEngine = MpEngineFactory::sharedEngine();

    mPermanentData = new MpPopupHandlerPermanentData( this );

    TX_EXIT

}

/*!

 Destructs the collection popup handler.

 */

MpCollectionPopupHandler::~MpCollectionPopupHandler()

{

    TX_ENTRY

    delete mOutstandingPopup;

    TX_EXIT

}

/*!

 Default view context menu.

 */

void MpCollectionPopupHandler::openDefaultViewContextMenu( int index, const QPointF &coords )

{

    TX_ENTRY

    if ( mView->isActivated() ) {

        HbMenu *contextMenu = 0;

        HbAction *action;

        bool usbBlocked = mMpEngine->verifyUsbBlocking();

        switch ( mMpEngine->collectionData()->context() ) {

            case ECollectionContextAllSongs:

            case ECollectionContextArtistAllSongs:

            case ECollectionContextArtistAlbumsTBone:

            case ECollectionContextAlbumsTBone:

                contextMenu = new HbMenu();

                action = contextMenu->addAction( hbTrId( "txt_common_menu_play_music" ) );

                action->setObjectName( KOpen );

                action = contextMenu->addAction( hbTrId( "txt_mus_menu_add_to_playlist" ) );

                action->setObjectName( KAdd );

                action->setEnabled( !usbBlocked );

                action = contextMenu->addAction( hbTrId( "txt_common_menu_delete" ) );

                action->setObjectName( KDelete );

                action->setEnabled( !usbBlocked );

                action = contextMenu->addAction( hbTrId( "txt_mus_menu_view_details" ) );

                action->setObjectName( KDetails );

                break;

            case ECollectionContextAlbums:

            case ECollectionContextArtists:

            case ECollectionContextArtistAlbums:

                contextMenu = new HbMenu();

                action = contextMenu->addAction( hbTrId( "txt_common_menu_open" ) );

                action->setObjectName( KOpen );

                action = contextMenu->addAction( hbTrId( "txt_mus_menu_add_to_playlist" ) );

                action->setObjectName( KAdd );

                action->setEnabled( !usbBlocked );

                action = contextMenu->addAction( hbTrId( "txt_common_menu_delete" ) );

                action->setObjectName( KDelete );

                action->setEnabled( !usbBlocked );

                break;

            case ECollectionContextPlaylists:

                contextMenu = new HbMenu();

                action = contextMenu->addAction( hbTrId( "txt_common_menu_open" ) );

                action->setObjectName( KOpen );

                if ( !mMpEngine->collectionData()->isAutoPlaylist( index ) ) {

                    action = contextMenu->addAction( hbTrId( "txt_common_menu_delete" ) );

                    action->setObjectName(KDelete);

                    action->setEnabled( !usbBlocked );

                    action = contextMenu->addAction( hbTrId( "txt_common_menu_rename_item" ) );

                    action->setObjectName( KRenamePlayList );

                    action->setEnabled( !usbBlocked );

                }

                break;

            case ECollectionContextPlaylistSongs:

                contextMenu = new HbMenu();

                action = contextMenu->addAction( hbTrId( "txt_common_menu_play_music" ) );

                action->setObjectName( KOpen );

                if ( !mMpEngine->collectionData()->isAutoPlaylist() ) {

                    action = contextMenu->addAction( hbTrId( "txt_common_menu_remove" ) );

                    action->setObjectName( KDelete );

                    action->setEnabled( !usbBlocked );

                }

                action = contextMenu->addAction( hbTrId( "txt_mus_menu_view_details" ) );

                action->setObjectName( KDetails );

                break;

            default:

                break;

        }

        if ( contextMenu ) {

            mPermanentData->mContextMenuIndex = index;

            contextMenu->setPreferredPos( coords );

            contextMenu->setObjectName( KContextMenu );

            contextMenu->setAttribute( Qt::WA_DeleteOnClose );

            setOutstandingPopup( contextMenu );

            contextMenu->open( this, SLOT( defaultContextMenuOptionSelected( HbAction* ) ) );

        }

    }

    TX_EXIT

}

/*!

 Fetch view context menu

 */

void MpCollectionPopupHandler::openFetchViewContextMenu( int index, const QPointF &coords )

{

    TX_ENTRY_ARGS( "index=" << index );

    if ( mView->isActivated() ) {

        HbAction *action;

        HbMenu *contextMenu = 0;

        switch ( mMpEngine->collectionData()->context() ) {

            case ECollectionContextAllSongs:

            case ECollectionContextArtistAlbumsTBone:

            case ECollectionContextArtistAllSongs:

            case ECollectionContextAlbumsTBone:

            case ECollectionContextPlaylistSongs:

                contextMenu = new HbMenu();

                action = contextMenu->addAction( hbTrId("txt_common_menu_play_music") );

                action->setEnabled( !mMpEngine->verifyUsbBlocking() );

                break;

            default:

                break;

        }

        if ( contextMenu ) {

            mPermanentData->mContextMenuIndex = index;

            contextMenu->setPreferredPos( coords );

            contextMenu->setAttribute( Qt::WA_DeleteOnClose );

            contextMenu->setObjectName( KContextMenu );

            setOutstandingPopup( contextMenu );

            contextMenu->open( this, SLOT( fetcherContextMenuOptionSelected( HbAction* ) ) );

        }

    }

    TX_EXIT

}

/*!

 Request a string to rename the playlist container.

 */

void MpCollectionPopupHandler::openRenamePlaylistContainerDialog( const QString &currentName )

{

    TX_ENTRY_ARGS( "Current name=" << currentName );

    mPermanentData->mOriginalName = currentName;

    getText( hbTrId( "txt_mus_dialog_enter_name" ), currentName,

             SLOT( handleRenamePlaylistContainer( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request a string to rename the playlist item.

 */

void MpCollectionPopupHandler::openRenamePlaylistItemDialog( const QString &currentName )

{

    TX_ENTRY_ARGS( "Current name=" << currentName );

    mPermanentData->mOriginalName = currentName;

    getText( hbTrId( "txt_mus_dialog_enter_name" ), currentName,

             SLOT( handleRenamePlaylistItem( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request to select songs to add to the playlist

 */

void MpCollectionPopupHandler::openAddSongsToPlaylist( QAbstractItemModel* model )

{

    TX_ENTRY

    getModelIndexes( hbTrId( "txt_mus_title_select_songs" ), model,

                     SLOT( handleAddSongsToPlayList( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request to select songs to add to the playlist from TBone

 */

void MpCollectionPopupHandler::openAddSongsToPlaylistFromTBone( )

{

    TX_ENTRY

    MpCollectionTBoneListDataModel *model;

    model = new MpCollectionTBoneListDataModel( mMpEngine->collectionData() );

    //this item will be deleted when clearing permanent data.

    model->setParent(mPermanentData);

    model->refreshModel();

    getModelIndexes( hbTrId( "txt_mus_title_select_songs" ), model,

                     SLOT( handleAddSongsToPlayList( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request to select songs to be deleted

 */

void MpCollectionPopupHandler::openDeleteSongs( QAbstractItemModel* model )

{

    TX_ENTRY

    getModelIndexes( hbTrId( "txt_mus_title_select_songs" ), model, 

                     SLOT( handleDeleteSongs( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request to select songs to be added to the current play list

 */

void MpCollectionPopupHandler::openAddToCurrentPlaylist( MpMpxCollectionData* collectionData )

{

    TX_ENTRY

    mPermanentData->mIsolatedCollectionData = collectionData;

    MpCollectionDataModel *collectionDataModel;

    collectionDataModel = new MpCollectionDataModel( collectionData );

    collectionDataModel->refreshModel();

    mPermanentData->mAbstractItemModel = collectionDataModel;

    getModelIndexes( hbTrId( "txt_mus_title_select_songs" ), collectionDataModel, 

                     SLOT( handleAddToCurrentPlaylist( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request to create a new play list and then add songs to it.

 */

void MpCollectionPopupHandler::openCreateNewPlaylist( MpMpxCollectionData* collectionData )

{

    TX_ENTRY

    mPermanentData->mIsolatedCollectionData = collectionData;

    MpCollectionDataModel *collectionDataModel;

    collectionDataModel = new MpCollectionDataModel( collectionData );

    collectionDataModel->refreshModel();

    mPermanentData->mAbstractItemModel = collectionDataModel;

    QStringList playlists;

    mMpEngine->findPlaylists( playlists );

    queryNewPlaylistName( playlists, SLOT( handleCreateNewPlaylistGetTextFinished( HbAction* ) ) );

    TX_EXIT

}

/*!

 Request to reorder songs

 */

void MpCollectionPopupHandler::openArrangeSongs( )

{

    TX_ENTRY

    launchArrangeSongsDialog();

    TX_EXIT

}

/*!

 Closes any active popup

 */

void MpCollectionPopupHandler::cancelOngoingPopup( bool onlyContextMenu )

{

    TX_ENTRY

    if ( mOutstandingPopup ) {

        if ( onlyContextMenu ) {

            if ( mOutstandingPopup->objectName() == KContextMenu ) {

                mOutstandingPopup->close();

                mPermanentData->clear();

            }

        }

        else {

            mOutstandingPopup->close();

            //Delete/Clear permanent data until current popup gets deleted

            mPermanentData->setParent( mOutstandingPopup );

            //Generate new permanent data for future popups

            mPermanentData = new MpPopupHandlerPermanentData( this );

        }

    }

    else {

        mPermanentData->clear();

    }

    TX_EXIT

}

/*!

 Slot to be called when an option has been selected from default context menu.

 */

void MpCollectionPopupHandler::defaultContextMenuOptionSelected( HbAction *selectedAction )

{

    TX_ENTRY

    if ( selectedAction ) {

        QString objectName = selectedAction->objectName();

        QList<int> selection;

        selection.append( mPermanentData->mContextMenuIndex );

        if ( objectName == KOpen ) {

            mView->openItem( mPermanentData->mContextMenuIndex );

        }

        if ( objectName == KAdd ) {

            launchAddToPlaylistDialog( selection );

        }

        else if ( objectName == KDelete ) {

            requestDelete( selection );

        }

        else if ( objectName == KRenamePlayList ) {

            QString currentName;

            currentName = mMpEngine->collectionData()->itemData( 

                    mPermanentData->mContextMenuIndex, MpMpxCollectionData::Title );

            openRenamePlaylistItemDialog( currentName );

        }

        else if ( objectName == KDetails ) {

            mView->showItemDetails( mPermanentData->mContextMenuIndex );

        }

    }

    TX_EXIT

}

/*!

 Slot to be called when play option has been selected from fetcher context menu.

 */

void MpCollectionPopupHandler::fetcherContextMenuOptionSelected( HbAction *selectedAction )

{

    TX_ENTRY

    if ( selectedAction ) {

        // Start the playback process. View will switch to playbackview.

        mMpEngine->previewItem( mPermanentData->mContextMenuIndex );

    }        

    TX_EXIT

}

/*!

 Slot to be called when AddToPlaylist dialog has finished

 */

void MpCollectionPopupHandler::handleAddToPlaylistDialogFinished( HbAction *selectedAction )

{

    TX_ENTRY

    HbSelectionDialog *dialog = qobject_cast<HbSelectionDialog *>( sender() );

    clearOutstandingPopup( dialog );

    bool operationCompleted( true );

    if ( selectedAction ) {

        QString objectName = selectedAction->objectName();

        if ( objectName == KNew ) {

            QStringList playlists;

            mMpEngine->findPlaylists( playlists );

            queryNewPlaylistName( playlists, SLOT( handleAddToPlaylistGetTextFinished( HbAction* ) ) );

            operationCompleted = false;

        }

    } 

    else if ( dialog->selectedItems().count() ) {//this only works for SingleSelection

        // User selected existing playlist.

        mMpEngine->saveToPlaylist( dialog->selectedItems().at( 0 ).toInt(), mPermanentData->mSelectedItems );

    }

    if ( operationCompleted ) {

        mPermanentData->clear();

    }

    TX_EXIT

}

/*!

 Slot to be called when input dialog (getText) has finished, comming from AddToPlayList.

 */

void MpCollectionPopupHandler::handleAddToPlaylistGetTextFinished( HbAction *selectedAction )

{

    TX_ENTRY

    HbInputDialog *dialog = qobject_cast<HbInputDialog *>( sender() );

    clearOutstandingPopup( dialog );

    bool operationCompleted( true );

    if ( selectedAction ) {

        QString objectName = selectedAction->objectName();

        if ( objectName == KOk ) {

            QString newPlaylistName = dialog->value().toString();

            if ( newPlaylistName.length() ) {

                //Create new playlist with given name

                mMpEngine->createPlaylist( newPlaylistName, mPermanentData->mSelectedItems );

            }

            else {

                //No valid name, prompt for one again.

                getText( hbTrId( "txt_mus_dialog_enter_name" ), newPlaylistName,

                         SLOT( handleAddToPlaylistGetTextFinished( HbAction* ) ) );