mirror of
https://github.com/RetroShare/RetroShare.git
synced 2025-05-17 21:40:36 -04:00
fc0ff38206
Added new and missing tests of the RsItems. Added new notifier on channel changes. Reworked fill of channels in ChannelFeed. Now the channel tree is updated and not refilled. Show unread message count in channels tree. Fixed memory leak in context menu. Show a new tray icon and action icon in MainWindow, when new channel messages are available. Recompile of the GUI needed. git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@3626 b45a01b8-16f6-495d-af2f-9b41ad6348cc
249 lines
7 KiB
C++
249 lines
7 KiB
C++
#ifndef RS_CHANNEL_GUI_INTERFACE_H
|
|
#define RS_CHANNEL_GUI_INTERFACE_H
|
|
|
|
/*
|
|
* libretroshare/src/rsiface: rschannels.h
|
|
*
|
|
* RetroShare C++ Interface.
|
|
*
|
|
* Copyright 2008 by Robert Fernie.
|
|
*
|
|
* 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 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 <list>
|
|
#include <iostream>
|
|
#include <string>
|
|
|
|
#include "rstypes.h"
|
|
#include "rsdistrib.h" /* For FLAGS */
|
|
|
|
#define CHANNEL_MSG_STATUS_MASK 0x000f
|
|
#define CHANNEL_MSG_STATUS_READ 0x0001
|
|
#define CHANNEL_MSG_STATUS_UNREAD_BY_USER 0x0002
|
|
|
|
//! Stores information for a give channel id
|
|
/*!
|
|
* Stores all information for a given channel id
|
|
*/
|
|
class ChannelInfo
|
|
{
|
|
public:
|
|
ChannelInfo() : pngChanImage(NULL), pngImageLen(0) {}
|
|
std::string channelId;
|
|
std::wstring channelName;
|
|
std::wstring channelDesc;
|
|
|
|
uint32_t channelFlags;
|
|
uint32_t pop; /// popularity
|
|
|
|
unsigned char* pngChanImage;
|
|
uint32_t pngImageLen;
|
|
|
|
time_t lastPost;
|
|
};
|
|
|
|
//! for storing a channel msgs thumbnail picture
|
|
class ChannelMsgThumbnail
|
|
{
|
|
public:
|
|
ChannelMsgThumbnail() : image_thumbnail(NULL), im_thumbnail_size(0) {}
|
|
|
|
unsigned char* image_thumbnail;
|
|
int im_thumbnail_size;
|
|
};
|
|
|
|
//! Stores information on a message within a channel
|
|
class ChannelMsgInfo
|
|
{
|
|
public:
|
|
ChannelMsgInfo () : count(0), size(0) {}
|
|
std::string channelId;
|
|
std::string msgId;
|
|
|
|
unsigned int msgflags;
|
|
|
|
std::wstring subject;
|
|
std::wstring msg;
|
|
time_t ts; /// time stamp
|
|
|
|
std::list<FileInfo> files;
|
|
uint32_t count; /// file count
|
|
uint64_t size; /// size of all files
|
|
|
|
ChannelMsgThumbnail thumbnail;
|
|
|
|
};
|
|
|
|
|
|
//! gives a more brief account of a channel message than channelMsgInfo
|
|
class ChannelMsgSummary
|
|
{
|
|
public:
|
|
ChannelMsgSummary() : count(0) {}
|
|
std::string channelId;
|
|
std::string msgId;
|
|
|
|
uint32_t msgflags;
|
|
|
|
std::wstring subject;
|
|
std::wstring msg;
|
|
uint32_t count; /// file count
|
|
time_t ts; /// time stamp
|
|
|
|
};
|
|
|
|
std::ostream &operator<<(std::ostream &out, const ChannelInfo &info);
|
|
std::ostream &operator<<(std::ostream &out, const ChannelMsgSummary &info);
|
|
std::ostream &operator<<(std::ostream &out, const ChannelMsgInfo &info);
|
|
|
|
class RsChannels;
|
|
extern RsChannels *rsChannels;
|
|
|
|
/*!
|
|
* retroshare interface to the channels distributed group service
|
|
* Channels user to create feeds similar to RSS feed where you can share files
|
|
* with other users, when you subscribe to a channel you immediately begin downloading
|
|
* the file shared on that channel. Channel feeds are shared anonymously
|
|
*/
|
|
class RsChannels
|
|
{
|
|
public:
|
|
|
|
RsChannels() { return; }
|
|
virtual ~RsChannels() { return; }
|
|
|
|
/****************************************/
|
|
|
|
/*!
|
|
* returns a list of channel id that have changed (i.e. received new message, chan descr update)
|
|
* @param chanIds this is populated with channel ids that have changed
|
|
*/
|
|
virtual bool channelsChanged(std::list<std::string> &chanIds) = 0;
|
|
|
|
/*!
|
|
* @param chanName name of the channel
|
|
* @param chanDesc a short description for the created channel
|
|
* @param chanFlags admin details on created channel group see rsdistrib.h for flags types
|
|
* @param pngImageData point at image data in PNG format
|
|
* @param imageSize size of the image data
|
|
*/
|
|
virtual std::string createChannel(std::wstring chanName, std::wstring chanDesc, uint32_t chanFlags,
|
|
unsigned char* pngImageData, uint32_t imageSize) = 0;
|
|
|
|
/*!
|
|
* retrieve channel information
|
|
* @param cId channel id
|
|
* @param ci channel info is store here
|
|
*/
|
|
virtual bool getChannelInfo(std::string cId, ChannelInfo &ci) = 0;
|
|
|
|
/*!
|
|
* @param chanList populated channelinfo for all channels
|
|
*/
|
|
virtual bool getChannelList(std::list<ChannelInfo> &chanList) = 0;
|
|
|
|
/*!
|
|
* get a message summary list for a given channel id
|
|
* @param cId channel id user wants messages for
|
|
* @param msgs summary of messages for the given cId
|
|
*/
|
|
virtual bool getChannelMsgList(std::string cId, std::list<ChannelMsgSummary> &msgs) = 0;
|
|
|
|
/*!
|
|
* retrieve more comprehensive message info given channel id and message id
|
|
*/
|
|
virtual bool getChannelMessage(std::string cId, std::string mId, ChannelMsgInfo &msg) = 0;
|
|
|
|
/*!
|
|
* set message status
|
|
* @param cId channel id
|
|
* @param mId message id
|
|
* @param status status to set
|
|
* @param statusMask bitmask to modify
|
|
*/
|
|
virtual bool setMessageStatus(const std::string& cId,const std::string& mId, const uint32_t status, const uint32_t statusMask) = 0;
|
|
|
|
/*!
|
|
* set message status
|
|
* @param cId channel id
|
|
* @param mId message id
|
|
* @param status status
|
|
*/
|
|
virtual bool getMessageStatus(const std::string& cId, const std::string& mId, uint32_t& status) = 0;
|
|
|
|
/*!
|
|
* count the new and unread messages
|
|
* @param cId channel id
|
|
* @param newCount count of new messages
|
|
* @param unreadCount count of unread messages
|
|
*/
|
|
virtual bool getMessageCount(const std::string cId, unsigned int &newCount, unsigned int &unreadCount) = 0;
|
|
|
|
/*!
|
|
* send message contain in message info to the id indicated within it (make sure you set the channel id of the message info)
|
|
* @param info message to be sent
|
|
*/
|
|
virtual bool ChannelMessageSend(ChannelMsgInfo &info) = 0;
|
|
|
|
/*!
|
|
* @param cId the channel id
|
|
* @param subscribe set to true if you want to subscribe and to false to unsubscribe
|
|
*/
|
|
virtual bool channelSubscribe(std::string cId, bool subscribe) = 0;
|
|
|
|
/*!
|
|
* This hashes a file which is not already shared by client or his peers,
|
|
* The file is copied into the channels directory if its not too large (> 100mb)
|
|
* @param path This is full path to file
|
|
* @param channel Id
|
|
*/
|
|
virtual bool channelExtraFileHash(std::string path, std::string chId, FileInfo& fInfo) = 0;
|
|
|
|
/*!
|
|
* This removes hashed extra files, and also removes channels directory copy if it exists
|
|
* @param chId channel id
|
|
*/
|
|
virtual bool channelExtraFileRemove(std::string hash, std::string chId) = 0;
|
|
|
|
/*!
|
|
* Restores channel private keys for channel in the event keys stored in configuration files are lost
|
|
* @param chId channel id to restore keys for
|
|
*/
|
|
virtual bool channelRestoreKeys(std::string chId) = 0;
|
|
|
|
/*!
|
|
* shares keys with peers
|
|
*@param chId the channel for which private publish keys will be shared
|
|
*@param peers peers in this list will be sent keys
|
|
*
|
|
*/
|
|
virtual bool channelShareKeys(std::string chId, std::list<std::string>& peers) = 0;
|
|
/****************************************/
|
|
|
|
/*!
|
|
* allows peers to change information for the channel:
|
|
* can only change channel image, descriptions and name
|
|
*
|
|
*/
|
|
virtual bool channelEditInfo(std::string chId, ChannelInfo &ci) = 0;
|
|
};
|
|
|
|
|
|
#endif
|