/*

* 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 view.

*

*/

// INCLUDE FILES

#include <time.h>

#include <cstdlib>

#include <QtCore>

#include <hbinstance.h>

#include <hbapplication.h>

#include <hbaction.h>

#include <hbtoolbar.h>

#include <hbmenu.h>

#include <hbmessagebox.h>

#include <hblabel.h>

#include <QTranslator>

#include <QLocale>

#include <hblistview.h>

#include <hbscrollbar.h>

#include "mpcollectionview.h"

#include "mpcollectiondocumentloader.h"

#include "mpcollectioncontainerfactory.h"

#include "mpcollectioncontainer.h"

#include "mpcollectiondatamodel.h"

#include "mpenginefactory.h"

#include "mpmpxcollectiondata.h"

#include "mpnowplayingwidget.h"

#include "mpcommondefs.h"

#include "mptrace.h"

#include "mpsnapshotwidget.h"

#include "mpsettingsmanager.h"

#include "mpcollectionlistcontainer.h"

#include "mpcollectionpopuphandler.h"

const char*MUSIC_COLLECTION_DOCML = ":/docml/musiccollection.docml";

const char*EFFECT_SELECT = ":/effects/select.fxml";

const char*EFFECT_SELECT_END = ":/effects/select_end.fxml";

const int KMainToolBarAll = 0;

const int KMainToolBarArtists = 1;

const int KMainToolBarAlbums = 2;

const int KMainToolBarPlaylists = 3;

const int KPlaylistToolBarAdd = 0;

const int KPlaylistToolBarRemove = 1;

const int KplaylistToolBarReorder = 2;

/*!

    \class MpCollectionView

    \brief Music Player collection view.

    Collection view provides access to music collection in the device.

    This class owns the menu and the toolbar. In addition, it is

    responsible for creating UI containers and the underlying engine

    components and connecting them to work together.

*/

/*!

    \fn void command( int command )

    This signal is emitted when the view issues a \a command to the

    application such as request to switch to a different view.

 */

/*!

 Constructs the collection view.

 */

MpCollectionView::MpCollectionView()

    : mCollectionContext( ECollectionContextUnknown ),

      mMpEngine( 0 ),

      mContainerFactory( 0 ),

      mCollectionContainer( 0 ),

      mCollectionDataModel( 0 ),

      mActivated( false ),

      mNowPlayingBanner( 0 ),

      mBannerAttached( false ),

      mSoftKeyQuit( 0 ),

      mSoftKeyBack( 0 ),

      mDocumentLoader( 0 ),

      mMainContainer( 0 ),

      mMainToolBar( 0 ),

      mPlaylistToolBar( 0 ),

      mSnapshot( 0 ),

      mMpTranslator( 0 ),

      mCommonTranslator( 0 ),

      mActivationWaiting( false ),

      mMpPopupHandler( 0 ),

      mUsbBlocked( false )

{

    TX_LOG

}

/*!

 Destructs the collection view.

 */

MpCollectionView::~MpCollectionView()

{

    TX_ENTRY

    delete mSnapshot;

    delete mSoftKeyQuit;

    delete mSoftKeyBack;

    HbToolBar *toolBar = takeToolBar();

    if ( mMainToolBar != toolBar && mPlaylistToolBar != toolBar ) {

        delete toolBar;

    }

    if ( mMainToolBar ) {

        mMainToolBar->deleteLater();

    }

    if ( mPlaylistToolBar ) {

        mPlaylistToolBar->deleteLater();

    }

    delete mCollectionContainer;

    delete mContainerFactory;

    delete mCollectionDataModel;

    delete mDocumentLoader;

    delete mMpTranslator;

    delete mCommonTranslator;

    TX_EXIT

}

/*!

 Initializes the collection view. Allocates all resources needed by the view.

 */

void MpCollectionView::initializeView()

{

    TX_ENTRY

    //Load musicplayer and common translators

    QString lang = QLocale::system().name();

    QString path = QString( "z:/resource/qt/translations/" );

    bool translatorLoaded = false;

    mMpTranslator = new QTranslator( this );

    translatorLoaded = mMpTranslator->load( path + "musicplayer_" + lang );

    TX_LOG_ARGS( "Loading translator ok=" << translatorLoaded );

    if ( translatorLoaded ) {

        qApp->installTranslator( mMpTranslator );

    }

    mCommonTranslator = new QTranslator( this );

    translatorLoaded = mCommonTranslator->load( path + "common_" + lang );

    TX_LOG_ARGS( "Loading common translator ok=" << translatorLoaded );

    if ( translatorLoaded ) {

        qApp->installTranslator( mCommonTranslator );

    }

    mWindow = mainWindow();

    // Create softkey actions

    mSoftKeyQuit = new HbAction( Hb::QuitNaviAction, this );

    connect( mSoftKeyQuit, SIGNAL( triggered() ), this, SLOT( back() ) );

    mSoftKeyBack = new HbAction( Hb::BackNaviAction, this );

    connect( mSoftKeyBack, SIGNAL( triggered() ), this, SLOT( back() ) );

    mMpEngine = MpEngineFactory::sharedEngine();

    connect( mMpEngine, SIGNAL( collectionPlaylistOpened() ),

            this, SLOT( startPlaybackView() ) );

    connect( mMpEngine, SIGNAL( playlistSaved( bool ) ),

            this, SLOT( playlistSaved( bool ) ) );

    connect( mMpEngine, SIGNAL( songsDeleted( bool ) ),

            this, SLOT( songsDeleted( bool ) ) );

    connect( mMpEngine, SIGNAL( playlistsRenamed( bool ) ),

            this, SLOT( playlistsRenamed( bool ) ) );

    connect( mMpEngine, SIGNAL( isolatedCollectionOpened( MpMpxCollectionData* ) ),

            this, SLOT( handleIsolatedCollectionOpened( MpMpxCollectionData* ) ) );

    mCollectionData = mMpEngine->collectionData();

    qRegisterMetaType<TCollectionContext>("TCollectionContext");

    connect( mCollectionData, SIGNAL( contextChanged( TCollectionContext ) ), 

             this, SLOT( setContext( TCollectionContext ) ), Qt::QueuedConnection );

    mCollectionDataModel = new MpCollectionDataModel( mCollectionData );

    mDocumentLoader = new MpCollectionDocumentLoader();

    bool ok = false;

    mDocumentLoader->load( MUSIC_COLLECTION_DOCML, &ok );

    if ( ok ) {

        QGraphicsWidget *widget;

        widget = mDocumentLoader->findWidget( QString( "nowPlaying" ) );

        mNowPlayingBanner = qobject_cast<MpNowPlayingWidget*>( widget );

        if ( mViewMode == MpCommon::FetchView ) {

            // Banner is not needed since playback is stopped when returning

            // from playback preview. Disable the banner from updating.

            mNowPlayingBanner->setEnabled( false );

        }

        else {

            connect( mNowPlayingBanner, SIGNAL( clicked() ), this, SLOT( startPlaybackView() ) );

            connect( mNowPlayingBanner, SIGNAL( playbackAttachmentChanged( bool ) ),

                     this, SLOT( attachNowPlayingBanner( bool ) ) );

        }

        widget = mDocumentLoader->findWidget( QString( "mainContainer" ) );

        mMainContainer = qobject_cast<HbWidget*>( widget );

        setWidget( mMainContainer );

        HbEffect::add( QString( "container" ),

                QString( ":/effects/slide_out_to_left.fxml" ),

                QString( "slide_out_to_left" ) );

        HbEffect::add( QString( "container" ),

                QString( ":/effects/slide_out_to_right.fxml" ),

                QString( "slide_out_to_right" ) );

        HbEffect::add( QString( "container" ),

                QString( ":/effects/slide_out_to_top.fxml" ),

                QString( "slide_out_to_top" ) );

        HbEffect::add( QString( "container" ),

                QString( ":/effects/slide_in_to_right_and_fade_in.fxml" ),

                QString( "slide_in_to_right_and_fade_in" ) );

        HbEffect::add( QString( "container" ),

                QString( ":/effects/slide_in_to_left_and_fade_in.fxml" ),

                QString( "slide_in_to_left_and_fade_in" ) );

        HbEffect::add( QString( "container" ),

                QString( ":/effects/slide_in_to_top_and_fade_in.fxml" ),

                QString( "slide_in_to_top_and_fade_in" ) );

    }

    else {

        TX_LOG_ARGS( "Error: invalid xml file." );

        Q_ASSERT_X( ok, "MpCollectionView::initializeView", "invalid xml file" );

    }

    mContainerFactory = new MpCollectionContainerFactory( this, mDocumentLoader );

    mMpPopupHandler = new MpCollectionPopupHandler( this );

    connect( mMpEngine, SIGNAL( usbBlocked(bool) ),

             this, SLOT( handleUsbBlocked(bool) ) );

    connect( mMpEngine, SIGNAL( libraryAboutToUpdate() ),

             this, SLOT( handleLibraryAboutToUpdate() ) );

    connect( mMpEngine, SIGNAL( libraryUpdated() ),

             this, SLOT( handleLibraryUpdated() ) );

    mUsbBlocked = mMpEngine->verifyUsbBlocking();

    if ( MpSettingsManager::firstStartup() ) {

        mActivationWaiting = true;

        mMpEngine->refreshLibrary();

    }

    TX_EXIT

}

/*!

 Activates the collection view.

 */

void MpCollectionView::activateView()

{

    if ( mActivationWaiting ) {

        return;

    }

    mActivated = true;

    TX_ENTRY_ARGS( "mCollectionContext=" << mCollectionContext );

    if ( mCollectionContext == ECollectionContextUnknown ) {

        // Open 'All Songs' by default

    }

    else {

        // This true when returning from other views, e.g. playback view

        setSoftkey();

    }

    TX_EXIT

}

/*!

 Deactivates the collection view.

 */

void MpCollectionView::deactivateView()

{

    TX_ENTRY

    mActivated = false;

    cancelOngoingOperation();

    setNavigationAction( 0 );

    TX_EXIT

}

/*!

 Sets the default collection - AllSongs

 */

void MpCollectionView::setDefaultView()

{

    TX_ENTRY

    if ( mCollectionContext != ECollectionContextAllSongs ) {

        // Open 'All Songs' by default

        mMpEngine->openCollection( ECollectionContextAllSongs );

    }

    TX_EXIT

}

/*!

 Returns view activation status.

 */

bool MpCollectionView::isActivated()

{

    TX_LOG_ARGS( "View activated = " << mActivated );

    return mActivated;

}

/*!

 Opens or plays an item through collection container in order to keep track of the Artist / Album data used by infobar.

 */

void MpCollectionView::openItem( int index )

{

    TX_ENTRY_ARGS( "index = " << index );

    QModelIndex modelIndex;

    modelIndex = mCollectionDataModel->index( index );

    qobject_cast<MpCollectionListContainer*>(mCollectionContainer)->itemActivated( modelIndex );

    TX_EXIT

}

/*!

 Slot to be called when collection context is changed as a result of Open

 operation.

 */

void MpCollectionView::setContext( TCollectionContext context )

{

    TX_ENTRY_ARGS( "context=" << context );

    if ( mActivated ) {

        startContainerTransition( mCollectionContext, context );

    }

    mCollectionContext = context;

    // Reset softkey and the menu

    if ( mActivated ) {

        setSoftkey();

    }

    updateToolBar();

    updateMenu();

    TX_EXIT

}

/*!

 Slot to be called when 'All Songs' action is triggered from the toolbar.

 */

void MpCollectionView::openSongs()

{

    TX_ENTRY

    if ( mCollectionContext != ECollectionContextAllSongs ) {

        mMpEngine->openCollection( ECollectionContextAllSongs );

    }

    TX_EXIT

}

/*!

 Slot to be called when 'Artists' action is triggered from the toolbar.

 */

void MpCollectionView::openArtists()

{

    TX_ENTRY

    if ( mCollectionContext != ECollectionContextArtists ) {

        mMpEngine->openCollection( ECollectionContextArtists );

    }

    TX_EXIT

}

/*!

 Slot to be called when 'Albums' action is triggered from the toolbar.

 */

void MpCollectionView::openAlbums()

{

    TX_ENTRY

    if ( mCollectionContext != ECollectionContextAlbums ) {

        mMpEngine->openCollection( ECollectionContextAlbums );

    }

    TX_EXIT

}

/*!

 Slot to be called when 'Playlists' action is triggered from the toolbar.

 */

void MpCollectionView::openPlaylists()

{

    TX_ENTRY

    if ( mCollectionContext != ECollectionContextPlaylists) {

        mMpEngine->openCollection( ECollectionContextPlaylists );

    }

    TX_EXIT

}

/*!

 Slot to be called when 'Find' action is triggered from the toolbar.

 */

void MpCollectionView::find()

{

    // Todo

    HbMessageBox *messageBox = new HbMessageBox( "Not ready!", HbMessageBox::MessageTypeInformation );

    messageBox->setAttribute( Qt::WA_DeleteOnClose );

    messageBox->show();

    updateToolBar();

}

/*!

 Slot to be called when 'Music Store' action is triggered from the toolbar.

 */

void MpCollectionView::openMusicStore()

{

    // Todo

    HbMessageBox *messageBox = new HbMessageBox( "Not ready!", HbMessageBox::MessageTypeInformation );

    messageBox->setAttribute( Qt::WA_DeleteOnClose );

    messageBox->show();

    updateToolBar();

}

/*!

 Slot to be called when an item is selected by the user.

 */

void MpCollectionView::openIndex( int index )

{

    TX_ENTRY_ARGS( "index=" << index );

    bool doOpen = true;

    if ( mViewMode == MpCommon::FetchView ) {

        QString songUri;

        switch ( mCollectionContext ) {

            case ECollectionContextAllSongs:

            case ECollectionContextArtistAllSongs:

            case ECollectionContextPlaylistSongs:

                doOpen = false;

                songUri = mCollectionData->itemData( index, MpMpxCollectionData::Uri );

                emit songSelected( songUri );

                break;

            case ECollectionContextArtistAlbumsTBone:

            case ECollectionContextAlbumsTBone:

                doOpen = false;

                songUri = mCollectionData->albumSongData( index, MpMpxCollectionData::Uri );

                emit songSelected( songUri );

                break;

            default:

                break;

        }

    }

    // TODO: "showingPopup()" used as workaround for HbListView multiple events: longPress and activated.

    //       Remove once HbListView get fixed (wk16)

    if ( doOpen && !mMpPopupHandler->showingPopup() ) {

        if ( mCollectionContext == ECollectionContextArtistAlbums ) {

            if ( (mCollectionData->count() > 1) && (index == 0) ) {

                mMpEngine->openCollectionItem( index );

            }

            else {

                // Artist-Album view going into T-bone. We don't actually open the

                // collection. Just fake an open.

                mCollectionData->setContext( ECollectionContextArtistAlbumsTBone );

            }

        }

        else if ( mCollectionContext == ECollectionContextAlbums ) {

            // Album view going into T-bone. We don't actually open the

            // collection. Just fake an open.

            mCollectionData->setContext( ECollectionContextAlbumsTBone );

        }

        else {

            // Real open. Forward it to the engine.

            mMpEngine->openCollectionItem( index );

        }

    }

    TX_EXIT

}

/*!

 Slot to be called when an album is centered in T-Bone view and we need to

 find the songs beloging to album with \a index.

 */