#ifndef RETROSHARE_GXS_CHANNEL_GUI_INTERFACE_H #define RETROSHARE_GXS_CHANNEL_GUI_INTERFACE_H /* * libretroshare/src/retroshare: rsgxschannel.h * * RetroShare C++ Interface. * * Copyright (C) 2012 by Robert Fernie. * Copyright (C) 2018 Gioacchino Mazzurco * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public * License Version 2.1 as published by the Free Software Foundation. * * This library 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 * Library General Public License for more details. * * You should have received a copy of the GNU Library General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA. * * Please report all bugs and problems to "retroshare@lunamutt.com". * */ #include #include #include #include "retroshare/rstokenservice.h" #include "retroshare/rsgxsifacehelper.h" #include "retroshare/rsgxscommon.h" #include "serialiser/rsserializable.h" class RsGxsChannels; /** * Pointer to global instance of RsGxsChannels service implementation * @jsonapi{development} */ extern RsGxsChannels* rsGxsChannels; // These should be in rsgxscommon.h struct RsGxsChannelGroup : RsSerializable { RsGroupMetaData mMeta; std::string mDescription; RsGxsImage mImage; bool mAutoDownload; /// @see RsSerializable virtual void serial_process( RsGenericSerializer::SerializeJob j, RsGenericSerializer::SerializeContext& ctx ) { RS_SERIAL_PROCESS(mMeta); RS_SERIAL_PROCESS(mDescription); //RS_SERIAL_PROCESS(mImage); RS_SERIAL_PROCESS(mAutoDownload); } }; std::ostream &operator<<(std::ostream& out, const RsGxsChannelGroup& group); struct RsGxsChannelPost : RsSerializable { RsGxsChannelPost() : mCount(0), mSize(0) {} RsMsgMetaData mMeta; std::set mOlderVersions; std::string mMsg; // UTF8 encoded. std::list mFiles; uint32_t mCount; // auto calced. uint64_t mSize; // auto calced. RsGxsImage mThumbnail; /// @see RsSerializable virtual void serial_process( RsGenericSerializer::SerializeJob j, RsGenericSerializer::SerializeContext& ctx ) { RS_SERIAL_PROCESS(mMeta); RS_SERIAL_PROCESS(mOlderVersions); RS_SERIAL_PROCESS(mMsg); RS_SERIAL_PROCESS(mFiles); RS_SERIAL_PROCESS(mCount); RS_SERIAL_PROCESS(mSize); //RS_SERIAL_PROCESS(mThumbnail); } }; std::ostream &operator<<(std::ostream& out, const RsGxsChannelPost& post); class RsGxsChannels: public RsGxsIfaceHelper, public RsGxsCommentService { public: explicit RsGxsChannels(RsGxsIface *gxs) :RsGxsIfaceHelper(gxs) {} virtual ~RsGxsChannels() {} /* Specific Service Data */ virtual bool getGroupData(const uint32_t &token, std::vector &groups) = 0; virtual bool getPostData(const uint32_t &token, std::vector &posts, std::vector &cmts) = 0; virtual bool getPostData(const uint32_t &token, std::vector &posts) = 0; //Not currently used //virtual bool getRelatedPosts(const uint32_t &token, std::vector &posts) = 0; /* From RsGxsCommentService */ //virtual bool getCommentData(const uint32_t &token, std::vector &comments) = 0; //virtual bool getRelatedComments(const uint32_t &token, std::vector &comments) = 0; //virtual bool createComment(uint32_t &token, RsGxsComment &comment) = 0; //virtual bool createVote(uint32_t &token, RsGxsVote &vote) = 0; ////////////////////////////////////////////////////////////////////////////// virtual void setMessageReadStatus(uint32_t& token, const RsGxsGrpMsgIdPair& msgId, bool read) = 0; virtual bool setChannelAutoDownload(const RsGxsGroupId &groupId, bool enabled) = 0; virtual bool getChannelAutoDownload(const RsGxsGroupId &groupid, bool& enabled) = 0; virtual bool setChannelDownloadDirectory(const RsGxsGroupId &groupId, const std::string& directory)=0; /** * Get download directory for the given channel * @jsonapi{development} * @param[in] channelId id of the channel * @param[out] directory reference to string where to store the path * @return false on error, true otherwise */ virtual bool getChannelDownloadDirectory( const RsGxsGroupId& channelId, std::string& directory ) = 0; //virtual void setChannelAutoDownload(uint32_t& token, const RsGxsGroupId& groupId, bool autoDownload) = 0; //virtual bool setMessageStatus(const std::string &msgId, const uint32_t status, const uint32_t statusMask); //virtual bool setGroupSubscribeFlags(const std::string &groupId, uint32_t subscribeFlags, uint32_t subscribeMask); //virtual bool groupRestoreKeys(const std::string &groupId); virtual bool groupShareKeys(const RsGxsGroupId &groupId, std::set& peers)=0; /** * @brief Request subscription to a group. * The action is performed asyncronously, so it could fail in a subsequent * phase even after returning true. * @jsonapi{development} * @param[out] token Storage for RsTokenService token to track request * status. * @param[in] groupId Channel id * @param[in] subscribe * @return false on error, true otherwise */ virtual bool subscribeToGroup( uint32_t& token, const RsGxsGroupId &groupId, bool subscribe ) = 0; /** * @brief Request channel creation. * The action is performed asyncronously, so it could fail in a subsequent * phase even after returning true. * @jsonapi{development} * @param[out] token Storage for RsTokenService token to track request * status. * @param[in] group Channel data (name, description...) * @return false on error, true otherwise */ virtual bool createGroup(uint32_t& token, RsGxsChannelGroup& group) = 0; /** * @brief Request post creation. * The action is performed asyncronously, so it could fail in a subsequent * phase even after returning true. * @jsonapi{development} * @param[out] token Storage for RsTokenService token to track request * status. * @param[in] post * @return false on error, true otherwise */ virtual bool createPost(uint32_t& token, RsGxsChannelPost& post) = 0; /** * @brief Request channel change. * The action is performed asyncronously, so it could fail in a subsequent * phase even after returning true. * @jsonapi{development} * @param[out] token Storage for RsTokenService token to track request * status. * @param[in] group Channel data (name, description...) with modifications * @return false on error, true otherwise */ virtual bool updateGroup(uint32_t& token, RsGxsChannelGroup& group) = 0; // File Interface virtual bool ExtraFileHash(const std::string &path, std::string filename) = 0; virtual bool ExtraFileRemove(const RsFileHash &hash) = 0; }; #endif