/**

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

 * Manasij Roy, Nalina Hariharan

 * 

 * Description:

 * The Plugin Manager util class performs all plugin functional 

 * specific functionalities

 *

 */

// plugin interfaces

#include <QVector>

#include <QTextFormat>

#include <smfactivityfetcherplugin.h>

#include <smfcontactfetcherplugin.h>

#include <smfpostproviderplugin.h>

#include <smflyricsserviceplugin.h>

#include <smfmusiceventsplugin.h>

#include <smfmusicsearchplugin.h>

#include <smfmusicserviceplugin.h>

#include <smfplaylistserviceplugin.h>

#include <smfgalleryplugin.h>

#include <smfprovider.h>

#include "smfpluginmanagerutil.h"

#include "smfpluginmanager.h"

// Static data initialisation

SmfPluginManagerUtil* SmfPluginManagerUtil::m_myInstance = NULL;

/**

 * Method to get the instance of SmfPluginManagerUtil class

 * @param aParent The parent object

 * @return The instance of SmfPluginManagerUtil class

 */

SmfPluginManagerUtil* SmfPluginManagerUtil::getInstance ( QObject *aParent )

	{

	if(NULL == m_myInstance)

		m_myInstance = new SmfPluginManagerUtil( aParent );

	return m_myInstance;

	}

/**

 * Constructor with default argument

 * @param aParent The parent object

 */

SmfPluginManagerUtil::SmfPluginManagerUtil ( QObject *aParent )

	{

	Q_UNUSED(aParent)

	}

/**

 * Destructor

 */

SmfPluginManagerUtil::~SmfPluginManagerUtil ( )

	{

	if(m_myInstance)

		delete m_myInstance;

	}

/**

 * Method called by Plugin Manager to create a web query.

 * This method calls the respective plugin methods for creation of 

 * web queries using the aOperation and aInputData parameters.

 * @param aInstance Instance of the loaded plugin that perform this operation

 * @param aOperation The type of operation to be performed

 * @param aInputData The data required to create the web query

 * @param aReqData [out] The request data created by the 

 * plugin (don't consider for synchronous requests)

 * @param aResult [out] SmfError, The result of the operation

 * It can be :-

 * SmfPluginNoError (if plugin has created the request successfully)

 * SmfPluginUnknownPluginService (if plugin service is not known or unsupported)

 * SmfPluginRequestCreationFailed (if request creation has failed)

 * @param aOutputData [out] The output data to be filled by the 

 * plugins (for synchronous request only), don't consider for asynchronous requests

 */

void SmfPluginManagerUtil::createRequest ( QObject* aInstance, 

		const SmfRequestTypeID &aOperation, 

		QByteArray &aInputData,

		SmfPluginRequestData &aReqData,

		SmfError &aResult,

		QByteArray &aOutputData )

	{

	qDebug()<<"SmfPluginManagerUtil::createRequest()";

	SmfPluginError pluginErrorVal = SmfPluginErrServiceNotSupported;

	// Find the type of service required

	switch(aOperation)

		{

		case SmfActivitySelfActivity:

		case SmfActivityFriendsActivities:

		case SmfActivityFiltered:

		case SmfActivityCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createActivityFetcherRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfContactGetFriends:

		case SmfContactGetFollowers:

		case SmfContactSearch:

		case SmfContactSearchNear:

		case SmfContactGetGroups:

		case SmfContactSearchInGroup:

		case SmfContactCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createContactFetcherRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfContactRetrievePosts:

		case SmfContactPost:

		case SmfContactUpdatePost:

		case SmfContactPostDirected:

		case SmfContactCommentOnAPost:

		case SmfContactPostAppearence:

		case SmfContactSharePost:

		case SmfContactPostCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createContactPostRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfPostGetMaxCharsInPost:

		case SmfPostGetMaxItems:

		case SmfPostGetSupportedFormats:

		case SmfPostGetAppearanceSupport:

			pluginErrorVal = createSyncRequest(aInstance, aOperation, 

					aInputData, aOutputData);

			break;

		case SmfMusicGetLyrics:

		case SmfMusicGetSubtitle:

		case SmfMusicLyricsCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createMusicLyricsRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfMusicGetEventsOnLoc:

		case SmfMusicGetVenueOnLoc:

		case SmfMusicPostEvents:

		case SmfMusicEventsCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createMusicEventsRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfMusicGetRecommendations:

		case SmfMusicGetTracks:

		case SmfMusicGetTrackInfo:

		case SmfMusicGetStores:

		case SmfMusicSearchCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createMusicSearchRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfMusicGetUserInfo:

		case SmfMusicSearchUser:

		case SmfMusicPostCurrentPlaying:

		case SmfMusicPostRating:

		case SmfMusicPostComment:

		case SmfMusicServiceCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createMusicServiceRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfMusicGetPlaylists:

		case SmfMusicGetPlaylistsOfUser:

		case SmfMusicAddToPlaylist:

		case SmfMusicPostCurrentPlayingPlaylist:

		case SmfMusicPlaylistCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createMusicPlaylistRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		case SmfPictureGetAlbums:

		case SmfPictureGetPictures:

		case SmfPictureDescription:

		case SmfPictureUpload:

		case SmfPictureMultiUpload:

		case SmfPicturePostComment:

		case SmfPictureCustomRequest:

			// Authorise the plugin and call create request methods

			pluginErrorVal = createGalleryRequest(aInstance, aOperation, 

					aInputData, aReqData);

			break;

		default:

			qDebug()<<"Unknown service type!!!";

			aResult = SmfPMPluginUnknownPluginService;

		}

	qDebug()<<"return value = "<<pluginErrorVal;

	// Convert the SmfPluginError error type to SmfError type

	convertPluginErrorType(pluginErrorVal, aResult);

	}

/**

 * Method to create a web query to fetch activities

 * @param aPlugin The instance of the loaded plugin that performs the 

 * contact fetch operation.

 * @param aOperation The type of operation to be performed

 * @param aInputData The data required to create the web query

 * @param aReqData [out] The request data created by the plugin

 * @return SmfPluginError

 */

SmfPluginError SmfPluginManagerUtil::createActivityFetcherRequest ( QObject *aPlugin, 

		const SmfRequestTypeID &aOperation, 

		QByteArray &aInputData,

		SmfPluginRequestData &aReqData )

	{

	qDebug()<<"SmfPluginManagerUtil::createActivityFetcherRequest()";

	// typecast instance to the activity - fetcher type, here SmfActivityFetcherPlugin

	SmfActivityFetcherPlugin *plugin = qobject_cast<SmfActivityFetcherPlugin *>(aPlugin);

	SmfPluginError pluginErrorVal = SmfPluginErrServiceNotSupported;

	if(plugin)

		{

		QDataStream stream(aInputData);

		int pageNum, itemPerPage;

		quint8 flag = 0;

		switch(aOperation)

			{

			case SmfActivitySelfActivity:

				qDebug()<<"Plugin Operation requested : selfactivities()";

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->selfActivities(aReqData, pageNum, itemPerPage);

				break;

			case SmfActivityFriendsActivities:

				{

				qDebug()<<"Plugin Operation requested : friendsActivities()";

				SmfContact contact;

				stream>>flag;

				stream>>contact;

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->friendsActivities(aReqData, contact, pageNum, itemPerPage);

				break;

				}

			case SmfActivityFiltered:

				{

				qDebug()<<"Plugin Operation requested : filtered()";

				QList<SmfActivityObjectType> list;

				QList<int> intList;

				stream>>flag;

				stream>>intList;

				list.clear();

				foreach(int val, intList)

					{

					SmfActivityObjectType type = (SmfActivityObjectType)val;

					list.append(type);

					}

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->filtered(aReqData, list, pageNum, itemPerPage);

				break;

				}

			case SmfActivityCustomRequest:

				{

				qDebug()<<"Plugin Operation requested : customRequest()";

				int operationType;

				stream>>flag;

				stream>>operationType;

				QByteArray data;

				stream>>flag;

				if(flag)

					stream>>data;

				pluginErrorVal = plugin->customRequest(aReqData, operationType, &data);

				break;

				}

			default:

				// do nothing, unknown service

				qDebug()<<"No API found for this operation type!!!";

			}

		}

	else

		{

		qDebug()<<"Plugin instance couldn't be typecasted!!!";

		pluginErrorVal = SmfPluginErrRequestNotCreated; 

		}

	return pluginErrorVal;

	}

/**

 * Method to create a web query to fetch contact details.

 * @param aPlugin The instance of the loaded plugin that performs the 

 * contact fetch operation.

 * @param aOperation The type of operation to be performed

 * @param aInputData The data required to create the web query

 * @param aReqData [out] The request data created by the plugin

 * @return SmfPluginError, it can be :-

 * SmfPluginErrNone (if request is created successfully) or

 * SmfPluginErrServiceNotSupported (if the service requested is not known or unsupported) or

 * SmfPluginErrInvalidArguments (if the arguments are invalid) or 

 * SmfPluginErrRequestNotCreated (if request could not be created) 

 */

SmfPluginError SmfPluginManagerUtil::createContactFetcherRequest ( QObject *aPlugin, 

		const SmfRequestTypeID &aOperation, 

		QByteArray &aInputData,

		SmfPluginRequestData &aReqData )

	{

	qDebug()<<"SmfPluginManagerUtil::createContactFetcherRequest()";

	// typecast instance to the contact - fetcher type, here SmfContactFetcherPlugin

	SmfContactFetcherPlugin *plugin = qobject_cast<SmfContactFetcherPlugin *>(aPlugin);

	SmfPluginError pluginErrorVal = SmfPluginErrServiceNotSupported;

	if(plugin)

		{

		QDataStream stream(aInputData);

		int pageNum, itemPerPage;

		quint8 flag = 0;

		switch(aOperation)

			{

			case SmfContactGetFriends:

				qDebug()<<"Plugin Operation requested : friends()";

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->friends(aReqData, pageNum, itemPerPage);

				break;

			case SmfContactGetFollowers:

				qDebug()<<"Plugin Operation requested : followers()";

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->followers(aReqData, pageNum, itemPerPage);

				break;

			case SmfContactSearch:

				{

				qDebug()<<"Plugin Operation requested : search()";

				SmfContact searchContact;

				stream>>flag;

				if(flag)

					stream>>searchContact;

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->search(aReqData, searchContact, pageNum, itemPerPage);

				break;

				}

			case SmfContactSearchNear:

				{

				qDebug()<<"Plugin Operation requested : searchNear()";

				SmfLocation location;

				stream>>flag;

				if(flag)

					stream>>location;

				stream>>flag;

				int i;

				stream>>i;

				SmfLocationSearchBoundary proximity = (SmfLocationSearchBoundary)i;

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->searchNear(aReqData, location, proximity, pageNum, itemPerPage);

				break;

				}

			case SmfContactGetGroups:

				{

				qDebug()<<"Plugin Operation requested : groups()";

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->groups(aReqData, pageNum, itemPerPage);

				break;

				}

			case SmfContactSearchInGroup:

				{

				qDebug()<<"Plugin Operation requested : searchInGroup()";

				SmfGroup group;

				stream>>flag;

				stream>>group;

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->searchInGroup(aReqData, group, pageNum, itemPerPage);

				break;

				}

			case SmfContactCustomRequest:

				{

				qDebug()<<"Plugin Operation requested : customRequest()";

				int operationType;

				stream>>flag;

				stream>>operationType;

				QByteArray data;

				stream>>flag;

				if(flag)

					stream>>data;

				pluginErrorVal = plugin->customRequest(aReqData, operationType, &data);

				break;

				}

			default:

				// do nothing, unknown service

				qDebug()<<"No API found for this operation type!!!";

			}

		}

	else

		{

		qDebug()<<"Plugin instance couldn't be typecasted!!!";

		pluginErrorVal = SmfPluginErrRequestNotCreated; 

		}

	return pluginErrorVal;

	}

/**

 * Method to create a web query to do post operation on contacts 

 * (like scraps or messages)

 * @param aPlugin The instance of the loaded plugin that performs the 

 * contact fetch operation.

 * @param aOperation The type of operation to be performed

 * @param aInputData The data required to create the web query

 * @param aReqData [out] The request data created by the plugin

 * @return SmfPluginError, it can be :-

 * SmfPluginErrNone (if request is created successfully) or

 * SmfPluginErrServiceNotSupported (if the service requested is not known or unsupported) or

 * SmfPluginErrInvalidArguments (if the arguments are invalid) or 

 * SmfPluginErrRequestNotCreated (if request could not be created) 

 */

SmfPluginError SmfPluginManagerUtil::createContactPostRequest ( QObject *aPlugin, 

		const SmfRequestTypeID &aOperation, 

		QByteArray &aInputData,

		SmfPluginRequestData &aReqData )

	{

	qDebug()<<"SmfPluginManagerUtil::createContactPostRequest";

	// typecast instance to SmfPostProviderPlugin

	SmfPostProviderPlugin *plugin = qobject_cast<SmfPostProviderPlugin *>(aPlugin);

	SmfPluginError pluginErrorVal = SmfPluginErrServiceNotSupported;	

	if(plugin)

		{

		QDataStream stream(aInputData);

		SmfContact contact;

		SmfPost post;

		SmfLocation location;

		int pageNum, itemPerPage;

		quint8 flag = 0;

		switch(aOperation)

			{

			case SmfContactRetrievePosts:

				qDebug()<<"Plugin Operation requested : retrieve()";

				stream>>flag;

				if(flag)

					stream>>contact;

				stream>>flag;

				stream>>pageNum;

				stream>>flag;

				stream>>itemPerPage;

				pluginErrorVal = plugin->retrieve(aReqData, &contact, pageNum, itemPerPage);