/*

* 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 <hblistdialog.h>

#include <hbinputdialog.h>

#include <hblabel.h>

#include "mpcollectionview.h"

#include "mpcollectiondocumentloader.h"

#include "mpcollectioncontainerfactory.h"

#include "mpcollectioncontainer.h"

#include "mpcollectiondatamodel.h"

#include "mpcollectionsongscanner.h"

#include "mpmpxframeworkwrapper.h"

#include "mpmpxcollectiondata.h"

#include "mpnowplayingwidget.h"

#include "mpcommondefs.h"

#include "mptrace.h"

#include "mpsnapshotwidget.h"

#include "mpsettingsmanager.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 KMainToolBarPlaylists = 2;

//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),

      mMpxWrapper(0),

      mContainerFactory(0),

      mCollectionContainer(0),

      mCollectionDataModel(0),

      mActivated(false),

      mNowPlayingBanner(0),

      mBannerAttached(false),

      mEffectOnGoing(false),

      mDocumentLoader(0),

      mMainContainer(0),

      mMainToolBar(0),

      mPlaylistToolBar(0),

      mSnapshot(0),

      mSongScanner(0),

      mScanning(false)

{

    TX_LOG

}

/*!

 Destructs the collection view.

 */

MpCollectionView::~MpCollectionView()

{

    TX_ENTRY

    delete mSongScanner;

    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 mCollectionDataModel;

    delete mCollectionContainer;

    delete mContainerFactory;

    delete mMpxWrapper;

    delete mDocumentLoader;

    TX_EXIT

}

/*!

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

 */

void MpCollectionView::initializeView()

{

    TX_ENTRY

    mWindow = mainWindow();

    // Create softkey actions

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

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

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

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

    mMpxWrapper = new MpMpxFrameworkWrapper(mViewMode);

    connect( mMpxWrapper, SIGNAL(collectionPlaylistOpened()), this, SLOT(startPlaybackView()) );

    connect( mMpxWrapper, SIGNAL(playlistSaved(bool)), this, SLOT(playlistSaved(bool)), Qt::QueuedConnection );

    connect( mMpxWrapper, SIGNAL(songsDeleted(bool)), this, SLOT(songsDeleted(bool)), Qt::QueuedConnection );

    connect( mMpxWrapper, SIGNAL(playlistsRenamed(bool)), this, SLOT(playlistsRenamed(bool)), Qt::QueuedConnection );

    mCollectionData = mMpxWrapper->collectionData();

    connect( mCollectionData, SIGNAL(contextChanged(TCollectionContext)), this, SLOT(setContext(TCollectionContext)) );

    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(nowPlayingBannerActivated()) );

            connect( mNowPlayingBanner, SIGNAL(playbackAttachmentChanged(bool)), this, SLOT(attachNowPlayingBanner(bool)) );

            HbEffect::add( QString("banner"), EFFECT_SELECT, QString("chosen") );

            HbEffect::add( QString("banner"), EFFECT_SELECT_END, QString("chosenEnd") );

        }

        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);

    if ( MpSettingsManager::firstStartup() ) {

        mSongScanner = new MpCollectionSongScanner(mMpxWrapper);

        connect(mSongScanner, SIGNAL(scanEnded()), this, SLOT(handleScanningComplete()));

        mScanning = true;

        mSongScanner->scan();

    }

    TX_EXIT

}

/*!

 Activates the collection view.

 */

void MpCollectionView::activateView()

{

    if ( mScanning ) {

        return;

    }

    mActivated = true;

    TX_ENTRY_ARGS("mCollectionContext=" << mCollectionContext);

    if ( mCollectionContext == ECollectionContextUnknown ) {

        // Open 'All Songs' by default

        mMpxWrapper->openCollection( ECollectionContextAllSongs );

    }

    else {

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

        setSoftkey();

    }

    TX_EXIT

}

/*!

 Deactivates the collection view.

 */

void MpCollectionView::deactivateView()

{

    TX_ENTRY

    clearSoftkey();

    mActivated = false;

    TX_EXIT

}

/*!

 Loads the correct layout based on the \a orientation.

 */

void MpCollectionView::orientationChange( Qt::Orientation orientation )

{

    if ( mCollectionContainer ) {

        mCollectionContainer->orientationChange(orientation);

    }

    if ( mBannerAttached ) {

        if ( orientation == Qt::Vertical ) {

            setBannerVisibility(true);

        }

        else {

            setBannerVisibility(false);

        }

    }

}

/*!

 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;

    mCollectionContainer = mContainerFactory->createContainer(context);

    mCollectionContainer->setViewMode(mViewMode);

    mCollectionDataModel->refreshModel();

    mCollectionContainer->setDataModel(mCollectionDataModel);

    // Reset softkey and the menu

    if (mActivated) {

        clearSoftkey();

        setSoftkey();

    }

    updateToolBar();

    updateMenu();

    TX_EXIT

}

/*!

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

 */

void MpCollectionView::openSongs()

{

    TX_ENTRY

    mMpxWrapper->openCollection( ECollectionContextAllSongs );

    TX_EXIT

}

/*!

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

 */

void MpCollectionView::openArtists()

{

    TX_ENTRY

    mMpxWrapper->openCollection( ECollectionContextArtistAlbums );

    TX_EXIT

}

/*!

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

 */

void MpCollectionView::openPlaylists()

{

    TX_ENTRY

    mMpxWrapper->openCollection( ECollectionContextPlaylists );

    TX_EXIT

}

/*!

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

 */

void MpCollectionView::openGenres()

{

    TX_ENTRY

    mMpxWrapper->openCollection( ECollectionContextGenres );

    TX_EXIT

}

/*!

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

 */

void MpCollectionView::find()

{

    // Todo

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

    messageBox.exec();

    updateToolBar();

}

/*!

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

 */

void MpCollectionView::openMusicStore()

{

    // Todo

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

    messageBox.exec();

    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 ECollectionContextAlbumSongs:

            case ECollectionContextPlaylistSongs:

            case ECollectionContextGenreSongs:

                doOpen = false;

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

                emit songSelected(songUri);

                break;

            default:

                break;

        }

    }

    if ( doOpen ) {

        mMpxWrapper->openCollectionItem( index );

    }

    TX_EXIT

}

/*!

 Slot to be called when back/quit softkey is pressed.

 */

void MpCollectionView::back()

{

    TX_ENTRY_ARGS("mCollectionContext=" << mCollectionContext);

    bool doExit(false);

    switch ( mCollectionContext ) {

        case ECollectionContextAllSongs:

        case ECollectionContextArtistAlbums:

        case ECollectionContextPlaylists:

        case ECollectionContextGenres:

            // Exit from these levels.

            doExit = true;

            break;

        case ECollectionContextAlbumSongs:

        case ECollectionContextPlaylistSongs:

        case ECollectionContextGenreSongs:

            mMpxWrapper->back();

            break;

        default:

            doExit = true;

            break;

    }

    if ( doExit ) {

	    if ( mViewMode == MpCommon::FetchView ) {

            // Send an empty string to indicate that user has cancelled

            // the fetch operation

            emit songSelected("");

        }

        else {

            emit command( MpCommon::Exit );

        }

    }

    TX_EXIT

}

/*!

 Slot to be called to exit.

 */

void MpCollectionView::exit()

{

    TX_ENTRY

    emit command( MpCommon::Exit );

    TX_EXIT

}

/*!

 Slot to be called to activate playback view.

 */

void MpCollectionView::startPlaybackView()

{

    TX_LOG

    emit command( MpCommon::ActivatePlaybackView );

}

/*!

 Slot to be called when 'Now Playing Banner' state changes. If active, 'Now

 Playing Banner' is attached/shown in the collection view.

 */

void MpCollectionView::attachNowPlayingBanner( bool active )

{

    TX_ENTRY

    setBannerVisibility( active );

    mBannerAttached = active;

    updateMenu();

    TX_EXIT

}

/*!

 Slot to be called when 'Now Playing Banner' is clicked by the user.

 */

void MpCollectionView::nowPlayingBannerActivated()

{

    if ( !mEffectOnGoing ) {

        HbEffect::start(mNowPlayingBanner, QString("banner"), QString("chosen"), this, "nowPlayingBannerChosenFxComplete1");

        mEffectOnGoing = true;

    }

}

/*!

 Slot for 'Now Playing Banner' effects part 1.

 */

void MpCollectionView::nowPlayingBannerChosenFxComplete1( const HbEffect::EffectStatus &status )

{

    Q_UNUSED(status);

    HbEffect::start(mNowPlayingBanner, QString("banner"), QString("chosenEnd"), this, "nowPlayingBannerChosenFxComplete2");

}

/*!

 Slot for 'Now Playing Banner' effects part 2. The end.

 */

void MpCollectionView::nowPlayingBannerChosenFxComplete2( const HbEffect::EffectStatus &status )

{

    Q_UNUSED(status);

    mEffectOnGoing = false;

    startPlaybackView();

}

/*!

 Slot for container transition end.

 */

void MpCollectionView::containerTransitionComplete( const HbEffect::EffectStatus &status )

{

    Q_UNUSED(status);

    qobject_cast<QGraphicsView *>(mWindow)->scene()->removeItem(mSnapshot);

    delete mSnapshot;

    mSnapshot = 0;

}

/*!

 Slot to be called when 'Shuffle play all' is clicked by the user from the menu.

 */

void MpCollectionView::shufflePlayAll()

{

    mMpxWrapper->setShuffle(true);

    MpSettingsManager::setShuffle(true);

    int index = generateShuffleIndex();

    openIndex(index);

}

/*!

 Slot to be called when 'Refresh Library' is clicked by the user from the menu.

 */

void MpCollectionView::refreshLibrary()

{

    if ( !mSongScanner ) {

        mSongScanner = new MpCollectionSongScanner(mMpxWrapper);

        connect(mSongScanner, SIGNAL(scanEnded()), this, SLOT(handleScanningComplete()));

    }

    mScanning = true;

    mSongScanner->scan();

}