mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-03-07 14:16:10 -05:00
107 lines
4.5 KiB
C++
107 lines
4.5 KiB
C++
/*******************************************************************************
|
|
* libretroshare/src/retroshare: rsgxsforums.h *
|
|
* *
|
|
* libretroshare: retroshare core library *
|
|
* *
|
|
* Copyright 2012-2012 by Robert Fernie <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 RETROSHARE_GXS_FORUM_GUI_INTERFACE_H
|
|
#define RETROSHARE_GXS_FORUM_GUI_INTERFACE_H
|
|
|
|
#include <inttypes.h>
|
|
#include <string>
|
|
#include <list>
|
|
|
|
#include "retroshare/rstokenservice.h"
|
|
#include "retroshare/rsgxsifacehelper.h"
|
|
#include "serialiser/rstlvidset.h"
|
|
|
|
// Forum Service message flags, to be used in RsMsgMetaData::mMsgFlags
|
|
// Gxs imposes to use the first two bytes (lower bytes) of mMsgFlags for private forum flags, the upper bytes being used for internal GXS stuff.
|
|
|
|
static const uint32_t RS_GXS_FORUM_MSG_FLAGS_MASK = 0x0000000f ;
|
|
static const uint32_t RS_GXS_FORUM_MSG_FLAGS_MODERATED = 0x00000001 ;
|
|
|
|
#define IS_FORUM_MSG_MODERATION(flags) (flags & RS_GXS_FORUM_MSG_FLAGS_MODERATED)
|
|
|
|
/* The Main Interface Class - for information about your Peers */
|
|
class RsGxsForums;
|
|
extern RsGxsForums *rsGxsForums;
|
|
|
|
class RsGxsForumGroup
|
|
{
|
|
public:
|
|
RsGroupMetaData mMeta;
|
|
std::string mDescription;
|
|
|
|
// What's below is optional, and handled by the serialiser
|
|
|
|
RsTlvGxsIdSet mAdminList;
|
|
RsTlvGxsMsgIdSet mPinnedPosts;
|
|
};
|
|
|
|
class RsGxsForumMsg
|
|
{
|
|
public:
|
|
RsMsgMetaData mMeta;
|
|
std::string mMsg;
|
|
};
|
|
|
|
|
|
//typedef std::map<RsGxsGroupId, std::vector<RsGxsForumMsg> > GxsForumMsgResult;
|
|
|
|
std::ostream &operator<<(std::ostream &out, const RsGxsForumGroup &group);
|
|
std::ostream &operator<<(std::ostream &out, const RsGxsForumMsg &msg);
|
|
|
|
class RsGxsForums: public RsGxsIfaceHelper
|
|
{
|
|
public:
|
|
|
|
explicit RsGxsForums(RsGxsIface& gxs) : RsGxsIfaceHelper(gxs) {}
|
|
virtual ~RsGxsForums() {}
|
|
|
|
/* Specific Service Data */
|
|
virtual bool getGroupData(const uint32_t &token, std::vector<RsGxsForumGroup> &groups) = 0;
|
|
virtual bool getMsgData(const uint32_t &token, std::vector<RsGxsForumMsg> &msgs) = 0;
|
|
//Not currently used
|
|
//virtual bool getRelatedMessages(const uint32_t &token, std::vector<RsGxsForumMsg> &msgs) = 0;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual void setMessageReadStatus(uint32_t& token, const RsGxsGrpMsgIdPair& msgId, bool read) = 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 std::string &groupId, std::list<std::string>& peers);
|
|
|
|
virtual bool createGroup(uint32_t &token, RsGxsForumGroup &group) = 0;
|
|
virtual bool createMsg(uint32_t &token, RsGxsForumMsg &msg) = 0;
|
|
/*!
|
|
* To update forum group with new information
|
|
* @param token the token used to check completion status of update
|
|
* @param group group to be updated, groupId element must be set or will be rejected
|
|
* @return false groupId not set, true if set and accepted (still check token for completion)
|
|
*/
|
|
virtual bool updateGroup(uint32_t &token, RsGxsForumGroup &group) = 0;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|