/src/libtomahawk/database/DatabaseCommand_LogPlayback.h

/* === This file is part of Tomahawk Player - <http://tomahawk-player.org> ===
 *
 *   Copyright 2010-2011, Christian Muehlhaeuser <muesli@tomahawk-player.org>
 *
 *   Tomahawk is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   Tomahawk is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with Tomahawk. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef DATABASECOMMAND_LOGPLAYBACK_H
#define DATABASECOMMAND_LOGPLAYBACK_H

#include <QObject>
#include <QVariantMap>

#include "database/DatabaseCommandLoggable.h"
#include "SourceList.h"
#include "Typedefs.h"
#include "Artist.h"
#include "Track.h"

#include "DllMacro.h"

namespace Tomahawk
{

class DLLEXPORT DatabaseCommand_LogPlayback : public DatabaseCommandLoggable
{
Q_OBJECT
Q_PROPERTY( QString artist READ artist WRITE setArtist )
Q_PROPERTY( QString track READ track WRITE setTrack )
Q_PROPERTY( unsigned int playtime READ playtime WRITE setPlaytime )
Q_PROPERTY( unsigned int secsPlayed READ secsPlayed WRITE setSecsPlayed )
Q_PROPERTY( unsigned int trackDuration READ trackDuration WRITE setTrackDuration )
Q_PROPERTY( int action READ action WRITE setAction )

public:
    enum Action
    {
        Started = 1,
        Finished = 2
    };

    explicit DatabaseCommand_LogPlayback( QObject* parent = 0 )
        : DatabaseCommandLoggable( parent ), m_secsPlayed( 0 ), m_playtime( 0 ), m_trackDuration( 0 )
    {}

    explicit DatabaseCommand_LogPlayback( const Tomahawk::track_ptr& track, Action action, unsigned int secsPlayed = 0, unsigned int timeStamp = 0, QObject* parent = 0 )
        : DatabaseCommandLoggable( parent ), m_secsPlayed( secsPlayed ), m_playtime( timeStamp ), m_action( action )
    {
        m_trackDuration = track->duration();
        setSource( SourceList::instance()->getLocal() );

        setArtist( track->artist() );
        setTrack( track->track() );
    }

    virtual QString commandname() const { return "logplayback"; }

    virtual void exec( DatabaseImpl* );
    virtual void postCommitHook();

    virtual bool doesMutates() const { return true; }
    virtual bool singletonCmd() const { return ( m_action == Started ); }
    virtual bool localOnly() const;
    virtual bool groupable() const { return true; }

    QString artist() const { return m_artist; }
    void setArtist( const QString& s ) { m_artist = s; }

    QString track() const { return m_track; }
    void setTrack( const QString& s ) { m_track = s; }

    unsigned int playtime() const { return m_playtime; }
    void setPlaytime( unsigned int i ) { m_playtime = i; }

    unsigned int secsPlayed() const { return m_secsPlayed; }
    void setSecsPlayed( unsigned int i ) { m_secsPlayed = i; }

    unsigned int trackDuration() const { return m_trackDuration; }
    void setTrackDuration( unsigned int trackDuration ) { m_trackDuration = trackDuration; }

    int action() const { return m_action; }
    void setAction( int a ) { m_action = (Action)a; }

signals:
    void trackPlaying( const Tomahawk::track_ptr& track, unsigned int duration );
    void trackPlayed( const Tomahawk::track_ptr& track, const Tomahawk::PlaybackLog& log );

private:
    QString m_artist;
    QString m_track;
    unsigned int m_secsPlayed;
    unsigned int m_playtime;
    unsigned int m_trackDuration;
    Action m_action;
};

}

#endif // DATABASECOMMAND_LOGPLAYBACK_H