/**
* Copyright (c) 2010 Sasken Communication Technologies Ltd.
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of the "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:
* Chandradeep Gandhi, Sasken Communication Technologies Ltd - Initial contribution
*
* Contributors:
* Nalina Hariharan
*
* Description:
* The Plugin that does music search related functionalities from last.fm site
*
*/
#ifndef _LASTFMMUSICSEARCHPLUGIN_H
#define _LASTFMMUSICSEARCHPLUGIN_H
// Include files
#include <smfmusicsearchplugin.h>
// Class declaration
class LastFmMusicSearchProviderBase;
class QVariant;
/**
* The Plugin does music serach related functionalities from last.fm site
*/
class LastFmMusicSearchPlugin : public QObject, public SmfMusicSearchPlugin
{
Q_OBJECT
Q_INTERFACES( SmfMusicSearchPlugin SmfPluginBase )
public:
/**
* Destructor
*/
virtual ~LastFmMusicSearchPlugin ( );
public: // From SmfMusicSearchPlugin interface
/**
* Method to get recommended tracks
* @param aRequest [out] The request data to be sent to network
* @param aTrack The track for which similar recommendations
* need to be fetched.
* @param aPageNum The page to be extracted
* @param aItemsPerPage Number of items per page
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError recommendations( SmfPluginRequestData &aRequest,
const SmfTrackInfo &aTrack,
const int aPageNum = SMF_FIRST_PAGE,
const int aItemsPerPage = SMF_ITEMS_PER_PAGE );
/**
* Method to search for tracks similar to a given track
* @param aRequest [out] The request data to be sent to network
* @param aTrack The track for which similar tracks
* need to be fetched.
* @param aPageNum The page to be extracted
* @param aItemsPerPage Number of items per page
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError tracksSimilar( SmfPluginRequestData &aRequest,
const SmfTrackInfo &aTrack,
const int aPageNum = SMF_FIRST_PAGE,
const int aItemsPerPage = SMF_ITEMS_PER_PAGE );
/**
* Method to search for tracks of a given album
* @param aRequest [out] The request data to be sent to network
* @param aAlbum The album whose tracks need to be fetched.
* @param aPageNum The page to be extracted
* @param aItemsPerPage Number of items per page
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError tracksOfAlbum( SmfPluginRequestData &aRequest,
const SmfAlbum &aAlbum,
const int aPageNum = SMF_FIRST_PAGE,
const int aItemsPerPage = SMF_ITEMS_PER_PAGE );
/**
* Method to search for tracks of the given artist(s)
* @param aRequest [out] The request data to be sent to network
* @param aArtist The artist(s) whose tracks need to be fetched.
* @param aPageNum The page to be extracted
* @param aItemsPerPage Number of items per page
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError tracksOfArtist( SmfPluginRequestData &aRequest,
const SmfArtists &aArtist,
const int aPageNum = SMF_FIRST_PAGE,
const int aItemsPerPage = SMF_ITEMS_PER_PAGE );
/**
* Method to get tracks having a similar finger print
* @param aRequest [out] The request data to be sent to network
* @param aSignature The finger print to be searched for need to be
* fetched.
* @param aPageNum The page to be extracted
* @param aItemsPerPage Number of items per page
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError trackInfo( SmfPluginRequestData &aRequest,
const SmfMusicFingerPrint &aSignature,
const int aPageNum = SMF_FIRST_PAGE,
const int aItemsPerPage = SMF_ITEMS_PER_PAGE );
/**
* Method to search information about where to buy this song from
* @param aRequest [out] The request data to be sent to network
* @param aTrack The track for which stores need to be searched
* @param aPageNum The page to be extracted
* @param aItemsPerPage Number of items per page
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError stores( SmfPluginRequestData &aRequest,
const SmfTrackInfo &aTrack,
const int aPageNum = SMF_FIRST_PAGE,
const int aItemsPerPage = SMF_ITEMS_PER_PAGE );
/**
* Customised method for SmfMusicSearchPlugin interface
* @param aRequest [out] The request data to be sent to network
* @param aOperation The operation type (should be known between
* the client interface and the plugin)
* @param aData The data required to form the request (The type
* of data should be known between client and the plugin)
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError customRequest( SmfPluginRequestData &aRequest,
const int &aOperation, QByteArray *aData );
public: // From SmfPluginBase interface
/**
* The first method to be called in the plugin that implements this interface.
* If this method is not called, plugin may not behave as expected.
*/
void initialize( );
/**
* Method to get the provider information
* @return Instance of SmfProviderBase
*/
SmfProviderBase* getProviderInfo( );
/**
* Method to get the result for a network request.
* @param aOperation The type of operation to be requested
* @param aTransportResult The result of transport operation
* @param aResponse The QByteArray instance containing the network response.
* The plugins should delete this instance once they have read the
* data from it.
* @param aResult [out] An output parameter to the plugin manager.If the
* return value is SmfSendRequestAgain, QVariant will be of type
* SmfPluginRequestData.
* For SmfMusicSearchPlugin: If last operation was recommendations(),
* tracksSimilar() or tracksOfAlbum() or tracksOfArtist() or trackInfo(),
* aResult will be of type QList<SmfTrackInfo>.
* If last operation was stores(), aResult will be of type QList<SmfProvider>.
* @param aRetType [out] SmfPluginRetType
* @param aPageResult [out] The SmfResultPage structure variable
*/
SmfPluginError responseAvailable(
const SmfRequestTypeID aOperation,
const SmfTransportResult &aTransportResult,
QByteArray *aResponse,
QVariant* aResult,
SmfPluginRetType &aRetType,
SmfResultPage &aPageResult );
private:
/**
* Method called by plugins to generate a signature string from a base string
* @param aBaseString The base string
* @return The md5 hash of the base string
*/
QString generateSignature(const QString aBaseString);
/**
* Method to interpret the key sets obtained from credential manager
* @param aApiKey [out] The api key
* @param aApiSecret [out] The api secret
* @param aSessionKey [out] The session key
* @param aToken [out] The session token
*/
void fetchKeys( QString &aApiKey,
QString &aApiSecret,
QString &aToken );
/**
* Method to get the last.fm specific ID of the given album
* @param aRequest [out] The request data to be sent to network
* @param aAlbum The album whose tracks need to be fetched.
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError getAlbumId( SmfPluginRequestData &aRequest,
const SmfAlbum &aAlbum );
/**
* Method to search for tracks of a given album using its ID in last.fm
* @param aRequest [out] The request data to be sent to network
* @param aAlbum The album whose tracks need to be fetched.
* @return SmfPluginError Plugin error if any, else SmfPluginErrNone
*/
SmfPluginError getTracksOfAlbum( SmfPluginRequestData &aRequest,
const SmfAlbum &aAlbum );
/**
* Method to get the current country name as per ISO 3166-1 standard.
* @return Current country name
*/
QString currentCountryName() const;
private: // Data
LastFmMusicSearchProviderBase *m_provider;
};
/**
* The Plugin class that implements SmfProviderBase for this last.fm plugin
*/
class LastFmMusicSearchProviderBase : public QObject, public SmfProviderBase
{
Q_OBJECT
Q_INTERFACES( SmfProviderBase )
public:
/**
* Destructor
*/
virtual ~LastFmMusicSearchProviderBase( );
/**
* Method to get the Localisable name of the service.
* @return The Localisable name of the service.
*/
QString serviceName( ) const;
/**
* Method to get the Logo of the service
* @return The Logo of the service
*/
QImage serviceIcon( ) const;
/**
* Method to get the Readable service description
* @return The Readable service description
*/
QString description( ) const;
/**
* Method to get the Website of the service
* @return The Website of the service
*/
QUrl serviceUrl( ) const;
/**
* Method to get the URL of the Application providing this service
* @return The URL of the Application providing this service
*/
QUrl applicationUrl( ) const;
/**
* Method to get the Icon of the application
* @return The Icon of the application
*/
QImage applicationIcon( ) const;
/**
* Method to get the list of interfaces that this provider support
* @return List of supported Interafces
*/
QList<QString> supportedInterfaces( ) const;
/**
* Method to get the list of languages supported by this service provider
* @return a QStringList of languages supported by this service
* provider in 2 letter ISO 639-1 format.
*/
QStringList supportedLanguages( ) const;
/**
* Method to get the Plugin specific ID
* @return The Plugin specific ID
*/
QString pluginId( ) const;
/**
* Method to get the ID of the authentication application
* for this service
* @param aProgram The authentication application name
* @param aArguments List of arguments required for authentication app
* @param aMode Strting mode for authentication application
* @return The ID of the authentication application
*/
QString authenticationApp( QString &aProgram, QStringList & aArguments,
QIODevice::OpenModeFlag aMode = QIODevice::ReadWrite ) const;
/**
* Method to get the unique registration ID provided by the
* Smf for authorised plugins
* @return The unique registration ID/token provided by the Smf for
* authorised plugins
*/
QString smfRegistrationId( ) const;
private:
/**
* Method that initializes this class. This method should be called
* from the initialize() method of the FBContactFetcherPlugin class
*/
void initialize();
private:
friend class LastFmMusicSearchPlugin;
QString m_serviceName;
QImage m_serviceIcon;
QString m_description;
QUrl m_serviceUrl;
QUrl m_applicationUrl;
QImage m_applicationIcon;
QString m_pluginId;
QString m_authAppId;
QString m_smfRegToken;
QList<QString> m_supportedInterfaces;
QStringList m_supportedLangs;
QDateTime m_validity;
};
#endif //_LASTFMMUSICSEARCHPLUGIN_H