/*

* 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 data - private implementation.

*

*/

#include <thumbnaildata.h>

#include <thumbnailobjectsource.h>

#include <mpxmedia.h>

#include <mpxmediacontainerdefs.h>

#include <mpxmediaarray.h>

#include <mpxmediageneraldefs.h>

#include <mpxmediamusicdefs.h>

#include "mpmpxcollectiondata_p.h"

#include "mptrace.h"

/*!

    \class MpMpxCollectionDataPrivate

    \brief Music Player collection data - private implementation.

    This is a private implementation of the collection data interface.

*/

/*!

 \internal

 */

MpMpxCollectionDataPrivate::MpMpxCollectionDataPrivate( MpMpxCollectionData *wrapper )

    : q_ptr( wrapper ),

      iContext( ECollectionContextUnknown ),

      iContainerMedia(0),

      iMediaArray(0),

      iCachedRemovedItem(0),

      iCurrentAlbumIndex(-1),

      iAlbumSongCount(0)

{

    TX_LOG

}

/*!

 \internal

 */

MpMpxCollectionDataPrivate::~MpMpxCollectionDataPrivate()

{

    TX_ENTRY

    delete iContainerMedia;

    delete iCachedRemovedItem;

    TX_EXIT

}

/*!

 \internal

 */

TCollectionContext MpMpxCollectionDataPrivate::context() const

{

    return iContext;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::count() const

{

    if ( iMediaArray ) {

        return iMediaArray->Count();

    }

    return 0;

}

/*!

 \internal

 */

QString MpMpxCollectionDataPrivate::collectionTitle() const

{

    TX_ENTRY

    QString title;

    if ( iContainerMedia && iContainerMedia->IsSupported( KMPXMediaGeneralTitle ) ) {

        const TDesC& titleText = iContainerMedia->ValueText( KMPXMediaGeneralTitle );

        if ( titleText.Compare( KNullDesC ) != 0 ) {

            title = QString::fromUtf16( titleText.Ptr(), titleText.Length() );

        }

    }

    TX_EXIT_ARGS("title =" << title);

    return title;

}

/*!

 \internal

 */

QString MpMpxCollectionDataPrivate::itemData( int index, MpMpxCollectionData::DataType type ) const

{

    TX_ENTRY_ARGS("index=" << index << ", type=" << type);

    QString data;

    TRAPD(err, DoGetDataL(index, type, data));

    if ( err != KErrNone ) {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return data;

}

/*!

 \internal

 */

bool MpMpxCollectionDataPrivate::isAutoPlaylist()

{

    TX_ENTRY

    if ( iContext != ECollectionContextPlaylistSongs ) {

        TX_EXIT

        return false;

    }

    bool isAuto = false;

    TRAPD(err, isAuto = DoIsAutoPlaylistL());

    if ( err == KErrNone ) {

        TX_LOG_ARGS("isAuto=" << isAuto);

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return isAuto;

}

/*!

 \internal

 */

bool MpMpxCollectionDataPrivate::isAutoPlaylist( int index )

{

    TX_ENTRY_ARGS("index=" << index);

    if ( iContext != ECollectionContextPlaylists ) {

        TX_EXIT

        return false;

    }

    bool isAuto = false;

    TRAPD(err, isAuto = DoIsAutoPlaylistL(index));

    if ( err == KErrNone ) {

        TX_LOG_ARGS("isAuto=" << isAuto);

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return isAuto;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::itemCount( int index )

{

    TX_ENTRY_ARGS("index=" << index);

    int count = 0;

    TRAPD(err, count = DoGetItemCountL(index));

    if ( err == KErrNone ) {

        TX_LOG_ARGS("count=" << count);

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return count;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::containerId()

{

    int id = -1;

    TRAPD( err, id = DoGetContainerIdL() );

    if ( err == KErrNone ) {

        TX_LOG_ARGS("id=" << id);

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return id;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::itemId( int index )

{

    TX_ENTRY_ARGS( "index=" << index );

    int id = -1;

    TRAPD( err, id = DoGetItemIdL( index ) );

    if ( err == KErrNone ) {

        TX_LOG_ARGS( "id=" << id );

    }

    else {

        TX_LOG_ARGS( "Error: " << err << "; should never get here." );

    }

    TX_EXIT

    return id;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::albumSongId( int index )

{

    TX_ENTRY_ARGS( "index=" << index );

    int id = -1;

    TRAPD( err, id = DoGetAlbumSongIdL( index ) );

    if ( err == KErrNone ) {

        TX_LOG_ARGS( "id=" << id );

    }

    else {

        TX_LOG_ARGS( "Error: " << err << "; should never get here." );

    }

    TX_EXIT

    return id;

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::removeItem(int index)

{

    TX_ENTRY_ARGS("index=" << index);

     TRAPD(err,  DoRemoveItemL(index));

    if ( err != KErrNone ) {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

}

/*!

 \internal

 */

bool MpMpxCollectionDataPrivate::testCachedItem( int itemId )

{

    TX_ENTRY_ARGS( "itemId=" << itemId);

    bool match = false;

    TRAPD( err, match = DoTestCachedItemL( itemId ) );

    if ( err == KErrNone ) {

        TX_LOG_ARGS("match=" << match);

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return match;

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::insertCachedItem(int index)

{

    TX_ENTRY_ARGS("index=" << index);

    iMediaArray->Insert( iCachedRemovedItem, index );

    iCachedRemovedItem = 0; //ownership tranferred above.

    TX_EXIT

}

/*!

 \internal

 */

bool MpMpxCollectionDataPrivate::setCurrentAlbum( int index )

{

    TX_ENTRY_ARGS( "index=" << index);

    bool available = false;

    TRAPD( err, available = DoSetCurrentAlbumL( index ) );

    if ( err != KErrNone ) {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return available;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::currentAlbumIndex() const

{

    return iCurrentAlbumIndex;

}

/*!

 \internal

 */

int MpMpxCollectionDataPrivate::albumSongsCount() const

{

    return iAlbumSongCount;

}

/*!

 \internal

 */

QString MpMpxCollectionDataPrivate::albumSongData( int index, MpMpxCollectionData::DataType type ) const

{

    TX_ENTRY_ARGS("index=" << index << ", type=" << type);

    QString data;

    TRAPD(err, DoGetAlbumSongDataL(index, type, data));

    if ( err != KErrNone ) {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

    return data;

}

/*!

 \internal

 New data from MPX collection. This could be due to Open operation, in which case

 context would have changed. This could also be due to Re-open after operations

 such as delete, playlist renaming, playlist rearraging, etc., in which case the

 context would remain the same, but the internal data may have changed.

 */

void MpMpxCollectionDataPrivate::setMpxMedia( const CMPXMedia& entries, bool reopen )

{

    TX_ENTRY

    TCollectionContext prevContext = iContext;

    int prevCount = count();

    TRAPD(err, DoSetMpxMediaL(entries));

    if ( err == KErrNone ) {

        int newCount = count();

        if ( (newCount == 0) || (prevCount == 0) ) {

            TX_LOG_ARGS("Empty container");

            // Two cases:

            //     1) newCount is zero: Last item in the model was deleted.

            //     2) prevCount is zero: Refresh operation found new data.

            // In these cases, independent of context change, we must emit the

            // contextChanged() signal so that the container can properly reload

            // the layout.

            emit q_ptr->contextChanged(iContext);

        }

        else if ( iContext != prevContext ) {

            TX_LOG_ARGS("Context changed: iContext=" << iContext);

            if ( prevContext == ECollectionContextArtistAlbumsTBone

                 && iContext == ECollectionContextArtistAlbums

                 && reopen ) {

                // Special case 1: This occurs when a song was deleted from TBone list

                // within artist container. And the fact that the new context is ArtistAlbums

                // indicates that the artist has more than 1 album.

                // Restore context to ArtistAlbumsTBone.

                iContext = ECollectionContextArtistAlbumsTBone;

                if ( newCount != prevCount ) {

                    // Change in count indicates that the deleted song was the last song

                    // in the TBone list. As a result, the album was deleted also, therefore

                    // we must emit dataChanged() indicating changes to the album section

                    // of the TBone.

                    emit q_ptr->dataChanged();

                }

                else {

                    // Same count indicates that one of the songs in the TBone's list

                    // section was deleted. We only want to reload the list section of the

                    // TBone in this case.

                    emit q_ptr->albumDataChanged();

                }

            }

            else if ( prevContext == ECollectionContextAlbumsTBone && reopen ) {

                // Special case 2: This occurs when a song was deleted from TBone list

                // within album container. Restore context to AlbumsTBone.

                iContext = ECollectionContextAlbumsTBone;

                if ( newCount != prevCount ) {

                    // Change in count indicates that the deleted song was the last song

                    // in the TBone list. As a result, the album was deleted also, therefore

                    // we must emit dataChanged() indicating changes to the album section

                    // of the TBone.

                    emit q_ptr->dataChanged();

                }

                else {

                    // Same count indicates that one of the songs in the TBone's list

                    // section was deleted. We only want to reload the list section of the

                    // TBone in this case.

                    emit q_ptr->albumDataChanged();

                }

            }

            else {

                // Simple case where the context has really changed and it didn't

                // involve TBone.

                emit q_ptr->contextChanged(iContext);

            }

        }

        else if ( prevContext == ECollectionContextArtistAlbumsTBone

                  && iContext == ECollectionContextArtistAlbumsTBone

                  && reopen ) {

            // Special case 3: This occurs when a song was deleted from TBone list

            // within artist container. This is similar to special case 1, however, the

            // fact that the new context is also ArtistAlbumsTBone indicates that the

            // artist has only 1 album. We only want to reload the list section of the

            // TBone in this case.

            emit q_ptr->albumDataChanged();

        }

        else {

            // Same context, but the data has changed.

            emit q_ptr->dataChanged();

        }

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

}

/*!

 \internal

 */

const CMPXMedia& MpMpxCollectionDataPrivate::containerMedia()

{

    return *iContainerMedia;

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::setContext( TCollectionContext context )

{

    iContext = context;

    TX_LOG_ARGS("Context changed: iContext=" << iContext);

    loadAlbumsLookup();

    emit q_ptr->contextChanged(iContext);

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::setAlbumContent( const CMPXMedia& albumContent )

{

    TX_ENTRY

    TRAPD(err, DoSetAlbumContentL(albumContent));

    if ( err == KErrNone ) {

        TX_LOG_ARGS("Album content is available.");

        loadAlbumSongsLookup();

        emit q_ptr->refreshAlbumSongs();

    }

    else {

        TX_LOG_ARGS("Error: " << err << "; should never get here.");

    }

    TX_EXIT

}

/*!

 \internal

   Currently only used to lookup playing song album id to index of albums on 

   media wall.

 */

int MpMpxCollectionDataPrivate::itemIndex( int itemUniqueId )

{

    return albumIdIndexMapping.value( itemUniqueId, -1 );

}

/*!

 \internal

   Currently only used to lookup playing song id to index of song in the 

   current album on media wall.

 */

int MpMpxCollectionDataPrivate::albumSongIndex( int songUniqueId )

{

    return albumSongIdIndexMapping.value( songUniqueId, -1 );

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::loadAlbumsLookup()

{

    //Clearing all the album ids.

    albumIdIndexMapping.clear();

    if ( iContext == ECollectionContextAlbumsMediaWall) {

        //Adding album ids and indixes to the hash, for itemIndex lookup.

        //This is disabled for other containers to save resources.

        for ( int i = count() - 1 ; i >= 0 ; i-- ) {

            albumIdIndexMapping.insert( itemId( i ) , i );

        }

    }

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::loadAlbumSongsLookup()

{

    //Clearing all the song ids.

    albumSongIdIndexMapping.clear();

    if ( iContext == ECollectionContextAlbumsMediaWall) {

        //Adding album song ids and indixes to the hash, for albumSongIndex lookup.

        //This is disabled for other containers to save resources.

        for ( int i = albumSongsCount() - 1 ; i >= 0 ; i-- ) {

            albumSongIdIndexMapping.insert( albumSongId( i ) , i );

        }

    }

}

/*!

 \internal

 */

void MpMpxCollectionDataPrivate::DoGetDataL( int index, MpMpxCollectionData::DataType type, QString& data ) const

{

    TX_ENTRY

    CMPXMedia* currentMedia( iMediaArray->AtL( index ) );