RetroShare/libretroshare/src/services/p3photoservice.h

/*******************************************************************************
 * libretroshare/src/services: p3photoservice.h                                *
 *                                                                             *
 * libretroshare: retroshare core library                                      *
 *                                                                             *
 * Copyright 2008-2012 Robert Fernie,Chris Evi-Parker <retroshare@lunamutt.com>*
 *                                                                             *
 * This program is free software: you can redistribute it and/or modify        *
 * it under the terms of the GNU Lesser General Public License as              *
 * published by the Free Software Foundation, either version 3 of the          *
 * License, or (at your option) any later version.                             *
 *                                                                             *
 * This program 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 Lesser General Public License for more details.                         *
 *                                                                             *
 * You should have received a copy of the GNU Lesser General Public License    *
 * along with this program. If not, see <https://www.gnu.org/licenses/>.       *
 *                                                                             *
 *******************************************************************************/
#ifndef P3PHOTOSERVICEV2_H
#define P3PHOTOSERVICEV2_H

#include "gxs/rsgenexchange.h"
#include "retroshare/rsphoto.h"
#include "services/p3gxscommon.h"

class p3PhotoService : public RsGenExchange, public RsPhoto
{
public:

	p3PhotoService(RsGeneralDataService* gds, RsNetworkExchangeService* nes, RsGixs* gixs);
	virtual RsServiceInfo getServiceInfo();

	static uint32_t photoAuthenPolicy();

public:

	/*!
	 * @return true if a change has occured
	 */
	bool updated();

	/*!
	 *
	 */
	void service_tick();

protected:

	void notifyChanges(std::vector<RsGxsNotify*>& changes);
public:

	/** Requests **/

	void groupsChanged(std::list<RsGxsGroupId>& grpIds);


	void msgsChanged(GxsMsgIdResult& msgs);

	RsTokenService* getTokenService();

	bool getGroupList(const uint32_t &token, std::list<RsGxsGroupId> &groupIds);
	bool getMsgList(const uint32_t &token, GxsMsgIdResult& msgIds);

	/* Generic Summary */
	bool getGroupSummary(const uint32_t &token, std::list<RsGroupMetaData> &groupInfo);

	bool getMsgSummary(const uint32_t &token, MsgMetaResult &msgInfo);

	/* Specific Service Data */
	bool getAlbum(const uint32_t &token, std::vector<RsPhotoAlbum> &albums);
	bool getPhoto(const uint32_t &token, PhotoResult &photos);

public:
	/* Comment service - Provide RsGxsCommentService - redirect to p3GxsCommentService */
	virtual bool getCommentData(uint32_t token, std::vector<RsGxsComment> &msgs) override
	{
		return mCommentService->getGxsCommentData(token, msgs);
	}

	virtual bool getRelatedComments( uint32_t token, std::vector<RsGxsComment> &msgs ) override
	{
		return mCommentService->getGxsRelatedComments(token, msgs);
	}

	virtual bool createNewComment(uint32_t &token, const RsGxsComment &msg) override
	{
		return mCommentService->createGxsComment(token, msg);
	}

	virtual bool createNewVote(uint32_t &token, RsGxsVote &msg) override
	{
		return mCommentService->createGxsVote(token, msg);
	}

	virtual bool acknowledgeComment(uint32_t token, std::pair<RsGxsGroupId, RsGxsMessageId>& msgId) override
	{
		return acknowledgeMsg(token, msgId);
	}

	virtual bool acknowledgeVote(uint32_t token, std::pair<RsGxsGroupId, RsGxsMessageId>& msgId) override
	{
		if (mCommentService->acknowledgeVote(token, msgId))
		{
			return true;
		}
		return acknowledgeMsg(token, msgId);
	}

	// Blocking versions.
	virtual bool createComment(RsGxsComment &msg) override
	{
		uint32_t token;
		return mCommentService->createGxsComment(token, msg) && waitToken(token) == RsTokenService::COMPLETE;
	}

public:

	/** Modifications **/

	/*!
	 * submits album, which returns a token that needs
	 * to be acknowledge to get album grp id
	 * @param token token to redeem for acknowledgement
	 * @param album album to be submitted
	 */
	bool submitAlbumDetails(uint32_t& token, RsPhotoAlbum &album);

	/*!
	 * submits photo, which returns a token that needs
	 * to be acknowledge to get photo msg-grp id pair
	 * @param token token to redeem for acknowledgement
	 * @param photo photo to be submitted
	 */
	bool submitPhoto(uint32_t& token, RsPhotoPhoto &photo);

	/*!
	 * submits photo comment, which returns a token that needs
	 * to be acknowledged to get photo msg-grp id pair
	 * The mParentId needs to be set to an existing msg for which
	 * commenting is enabled
	 * @param token token to redeem for acknowledgement
	 * @param comment comment to be submitted
	 */
	// bool submitComment(uint32_t& token, RsPhotoComment &photo);

	/*!
	 * subscribes to group, and returns token which can be used
	 * to be acknowledged to get group Id
	 * @param token token to redeem for acknowledgement
	 * @param grpId the id of the group to subscribe to
	 */
	bool subscribeToAlbum(uint32_t& token, const RsGxsGroupId& grpId, bool subscribe);

	/*!
	 * This allows the client service to acknowledge that their msgs has
	 * been created/modified and retrieve the create/modified msg ids
	 * @param token the token related to modification/create request
	 * @param msgIds map of grpid->msgIds of message created/modified
	 * @return true if token exists false otherwise
	 */
	bool acknowledgeMsg(const uint32_t& token, std::pair<RsGxsGroupId, RsGxsMessageId>& msgId);

	/*!
	 * This allows the client service to acknowledge that their grps has
	 * been created/modified and retrieve the create/modified grp ids
	 * @param token the token related to modification/create request
	 * @param msgIds vector of ids of groups created/modified
	 * @return true if token exists false otherwise
	 */
	bool acknowledgeGrp(const uint32_t& token, RsGxsGroupId& grpId);

	// Blocking versions.
	/*!
	 * request to create a new album. Blocks until process completes.
	 * @param album album to be submitted
	 * @return true if created false otherwise
	 */
	virtual bool createAlbum(RsPhotoAlbum &album) override;

	/*!
	 * request to update an existing album. Blocks until process completes.
	 * @param album album to be submitted
	 * @return true if created false otherwise
	 */
	virtual bool updateAlbum(const RsPhotoAlbum &album) override;

	/*!
	 * retrieve albums based in groupIds.
	 * @param groupIds the ids to fetch.
	 * @param albums vector to be filled by request.
	 * @return true is successful, false otherwise.
	 */
	virtual bool getAlbums(const std::list<RsGxsGroupId> &groupIds,
			std::vector<RsPhotoAlbum> &albums) override;
private:
	p3GxsCommentService* mCommentService;

	std::vector<RsGxsGroupChange*> mGroupChange;
	std::vector<RsGxsMsgChange*> mMsgChange;

	RsMutex mPhotoMutex;
};

#endif // P3PHOTOSERVICEV2_H