2007-12-11 20:43:17 -05:00
|
|
|
/*
|
|
|
|
* libretroshare/src/services chatservice.h
|
|
|
|
*
|
|
|
|
* Services for RetroShare.
|
|
|
|
*
|
|
|
|
* Copyright 2004-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".
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef SERVICE_CHAT_HEADER
|
|
|
|
#define SERVICE_CHAT_HEADER
|
|
|
|
|
|
|
|
#include <list>
|
|
|
|
#include <string>
|
2012-01-06 17:17:08 -05:00
|
|
|
#include <vector>
|
2007-12-11 20:43:17 -05:00
|
|
|
|
|
|
|
#include "serialiser/rsmsgitems.h"
|
|
|
|
#include "services/p3service.h"
|
2014-03-28 23:57:44 -04:00
|
|
|
#include "pqi/pqiservicemonitor.h"
|
2014-11-08 09:55:29 -05:00
|
|
|
#include "chat/distantchat.h"
|
2014-11-11 11:10:54 -05:00
|
|
|
#include "chat/distributedchat.h"
|
2010-08-31 13:13:52 -04:00
|
|
|
#include "retroshare/rsmsgs.h"
|
2010-04-24 07:27:25 -04:00
|
|
|
|
2014-03-28 23:57:44 -04:00
|
|
|
class p3ServiceControl;
|
2011-07-09 14:39:34 -04:00
|
|
|
class p3LinkMgr;
|
2011-09-29 05:20:09 -04:00
|
|
|
class p3HistoryMgr;
|
2011-07-09 14:39:34 -04:00
|
|
|
|
2014-03-17 16:56:06 -04:00
|
|
|
typedef RsPeerId ChatLobbyVirtualPeerId ;
|
|
|
|
|
2010-04-24 07:27:25 -04:00
|
|
|
//!The basic Chat service.
|
|
|
|
/**
|
|
|
|
*
|
|
|
|
* Can be used to send and receive chats, immediate status (using notify), avatars, and custom status
|
|
|
|
* This service uses rsnotify (callbacks librs clients (e.g. rs-gui))
|
|
|
|
* @see NotifyBase
|
|
|
|
*/
|
2014-11-11 11:10:54 -05:00
|
|
|
class p3ChatService: public p3Service, public DistantChatService, public DistributedChatService, public p3Config, public pqiServiceMonitor
|
2007-12-11 20:43:17 -05:00
|
|
|
{
|
|
|
|
public:
|
2014-06-12 06:28:23 -04:00
|
|
|
p3ChatService(p3ServiceControl *cs, p3IdService *pids,p3LinkMgr *cm, p3HistoryMgr *historyMgr);
|
2009-01-30 14:52:47 -05:00
|
|
|
|
2014-03-21 23:53:44 -04:00
|
|
|
virtual RsServiceInfo getServiceInfo();
|
|
|
|
|
2010-09-20 20:08:06 -04:00
|
|
|
/***** overloaded from p3Service *****/
|
2010-08-31 13:13:52 -04:00
|
|
|
/*!
|
|
|
|
* This retrieves all chat msg items and also (important!)
|
|
|
|
* processes chat-status items that are in service item queue. chat msg item requests are also processed and not returned
|
|
|
|
* (important! also) notifications sent to notify base on receipt avatar, immediate status and custom status
|
|
|
|
* : notifyCustomState, notifyChatStatus, notifyPeerHasNewAvatar
|
|
|
|
* @see NotifyBase
|
|
|
|
*/
|
2009-01-30 14:52:47 -05:00
|
|
|
virtual int tick();
|
|
|
|
virtual int status();
|
|
|
|
|
2010-09-20 20:08:06 -04:00
|
|
|
/*************** pqiMonitor callback ***********************/
|
2014-03-28 23:57:44 -04:00
|
|
|
virtual void statusChange(const std::list<pqiServicePeer> &plist);
|
2010-09-20 20:08:06 -04:00
|
|
|
|
2010-04-24 07:27:25 -04:00
|
|
|
/*!
|
|
|
|
* public chat sent to all peers
|
|
|
|
*/
|
2013-10-03 17:41:34 -04:00
|
|
|
int sendPublicChat(const std::string &msg);
|
2010-04-24 07:27:25 -04:00
|
|
|
|
2010-09-20 20:08:06 -04:00
|
|
|
/********* RsMsgs ***********/
|
2010-04-24 07:27:25 -04:00
|
|
|
/*!
|
|
|
|
* chat is sent to specifc peer
|
2010-09-01 13:56:15 -04:00
|
|
|
* @param id peer to send chat msg to
|
2010-04-24 07:27:25 -04:00
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
bool sendPrivateChat(const RsPeerId &id, const std::string &msg);
|
2010-04-24 07:27:25 -04:00
|
|
|
|
|
|
|
/*!
|
2010-04-27 07:53:46 -04:00
|
|
|
* can be used to send 'immediate' status msgs, these status updates are meant for immediate use by peer (not saved by rs)
|
2010-04-24 07:27:25 -04:00
|
|
|
* e.g currently used to update user when a peer 'is typing' during a chat
|
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
void sendStatusString(const RsPeerId& peer_id,const std::string& status_str) ;
|
2010-04-24 07:27:25 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* send to all peers online
|
|
|
|
*@see sendStatusString()
|
|
|
|
*/
|
2009-09-29 16:37:20 -04:00
|
|
|
void sendGroupChatStatusString(const std::string& status_str) ;
|
2009-10-04 18:27:42 -04:00
|
|
|
|
2010-04-24 07:27:25 -04:00
|
|
|
/*!
|
2010-04-27 07:53:46 -04:00
|
|
|
* this retrieves custom status for a peers, generate a requests to the peer
|
2010-04-24 07:27:25 -04:00
|
|
|
* @param peer_id the id of the peer you want status string for
|
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
std::string getCustomStateString(const RsPeerId& peer_id) ;
|
2010-04-24 07:27:25 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* sets the client's custom status, generates 'status available' item sent to all online peers
|
|
|
|
*/
|
2009-10-04 18:27:42 -04:00
|
|
|
void setOwnCustomStateString(const std::string&) ;
|
2010-04-24 07:27:25 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* @return client's custom string
|
|
|
|
*/
|
2009-10-04 18:27:42 -04:00
|
|
|
std::string getOwnCustomStateString() ;
|
2007-12-11 20:43:17 -05:00
|
|
|
|
2010-04-15 06:47:48 -04:00
|
|
|
/*! gets the peer's avatar in jpeg format, if available. Null otherwise. Also asks the peer to send
|
|
|
|
* its avatar, if not already available. Creates a new unsigned char array. It's the caller's
|
|
|
|
* responsibility to delete this ones used.
|
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
void getAvatarJpegData(const RsPeerId& peer_id,unsigned char *& data,int& size) ;
|
2007-12-11 20:43:17 -05:00
|
|
|
|
2010-04-15 06:47:48 -04:00
|
|
|
/*!
|
|
|
|
* Sets the avatar data and size for client's account
|
|
|
|
* @param data is copied, so should be destroyed by the caller
|
|
|
|
*/
|
2009-01-30 14:52:47 -05:00
|
|
|
void setOwnAvatarJpegData(const unsigned char *data,int size) ;
|
2010-04-15 06:47:48 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* Gets the avatar data for clients account
|
2010-04-27 07:53:46 -04:00
|
|
|
* data is in jpeg format
|
2010-04-15 06:47:48 -04:00
|
|
|
*/
|
2009-01-30 14:52:47 -05:00
|
|
|
void getOwnAvatarJpegData(unsigned char *& data,int& size) ;
|
2007-12-11 20:43:17 -05:00
|
|
|
|
2010-04-24 07:27:25 -04:00
|
|
|
/*!
|
2010-09-20 20:08:06 -04:00
|
|
|
* returns the count of messages in public queue
|
2010-09-01 13:56:15 -04:00
|
|
|
* @param public or private queue
|
2010-04-24 07:27:25 -04:00
|
|
|
*/
|
2010-09-20 20:08:06 -04:00
|
|
|
int getPublicChatQueueCount();
|
2010-09-01 13:56:15 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* This retrieves all public chat msg items
|
|
|
|
*/
|
|
|
|
bool getPublicChatQueue(std::list<ChatInfo> &chats);
|
|
|
|
|
2010-09-20 20:08:06 -04:00
|
|
|
/*!
|
|
|
|
* returns the count of messages in private queue
|
|
|
|
* @param public or private queue
|
|
|
|
*/
|
|
|
|
int getPrivateChatQueueCount(bool incoming);
|
|
|
|
|
2010-09-01 13:56:15 -04:00
|
|
|
/*!
|
|
|
|
* @param id's of available private chat messages
|
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
bool getPrivateChatQueueIds(bool incoming, std::list<RsPeerId> &ids);
|
2010-09-01 13:56:15 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* This retrieves all private chat msg items for peer
|
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
bool getPrivateChatQueue(bool incoming, const RsPeerId &id, std::list<ChatInfo> &chats);
|
2010-09-20 20:08:06 -04:00
|
|
|
|
2014-07-06 07:33:04 -04:00
|
|
|
/*!
|
|
|
|
* Return the max message size for security forwarding
|
2014-12-16 05:39:56 -05:00
|
|
|
* @param type RS_CHAT_TYPE_...
|
|
|
|
* return 0 unlimited
|
2014-07-06 07:33:04 -04:00
|
|
|
*/
|
2014-12-16 05:39:56 -05:00
|
|
|
static uint32_t getMaxMessageSecuritySize(int type);
|
2014-07-06 07:33:04 -04:00
|
|
|
|
2013-08-08 05:55:19 -04:00
|
|
|
/*!
|
|
|
|
* Checks message security, especially remove billion laughs attacks
|
|
|
|
*/
|
|
|
|
|
|
|
|
static bool checkForMessageSecurity(RsChatMsgItem *) ;
|
|
|
|
|
2010-09-20 20:08:06 -04:00
|
|
|
/*!
|
|
|
|
* @param clear private chat queue
|
|
|
|
*/
|
2014-03-17 16:56:06 -04:00
|
|
|
bool clearPrivateChatQueue(bool incoming, const RsPeerId &id);
|
2008-01-25 02:49:28 -05:00
|
|
|
|
2011-06-30 16:50:08 -04:00
|
|
|
protected:
|
2009-09-29 16:37:20 -04:00
|
|
|
/************* from p3Config *******************/
|
|
|
|
virtual RsSerialiser *setupSerialiser() ;
|
2010-04-24 07:27:25 -04:00
|
|
|
|
|
|
|
/*!
|
|
|
|
* chat msg items and custom status are saved
|
|
|
|
*/
|
2010-12-18 14:35:07 -05:00
|
|
|
virtual bool saveList(bool& cleanup, std::list<RsItem*>&) ;
|
2010-09-20 20:08:06 -04:00
|
|
|
virtual void saveDone();
|
2010-12-18 14:35:07 -05:00
|
|
|
virtual bool loadList(std::list<RsItem*>& load) ;
|
2009-03-20 16:41:31 -04:00
|
|
|
|
2014-03-17 16:56:06 -04:00
|
|
|
bool isOnline(const RsPeerId& id) ;
|
2014-11-11 11:10:54 -05:00
|
|
|
|
|
|
|
/// This is to be used by subclasses/parents to call IndicateConfigChanged()
|
|
|
|
virtual void triggerConfigSave() { IndicateConfigChanged() ; }
|
|
|
|
/// Same, for storing messages in incoming list
|
|
|
|
virtual void locked_storeIncomingMsg(RsChatMsgItem *) ;
|
|
|
|
|
2008-01-25 02:49:28 -05:00
|
|
|
private:
|
2009-03-20 16:41:31 -04:00
|
|
|
RsMutex mChatMtx;
|
|
|
|
|
2009-01-30 14:52:47 -05:00
|
|
|
class AvatarInfo ;
|
2009-10-04 18:27:42 -04:00
|
|
|
class StateStringInfo ;
|
2009-01-30 14:52:47 -05:00
|
|
|
|
2010-08-31 13:13:52 -04:00
|
|
|
// Receive chat queue
|
|
|
|
void receiveChatQueue();
|
2013-04-08 17:25:32 -04:00
|
|
|
void handleIncomingItem(RsItem *); // called by the former, and turtle handler for incoming encrypted items
|
2010-08-31 13:13:52 -04:00
|
|
|
|
2014-11-11 11:10:54 -05:00
|
|
|
virtual void sendChatItem(RsChatItem *) ;
|
2014-11-08 09:55:29 -05:00
|
|
|
|
2010-08-31 13:13:52 -04:00
|
|
|
void initRsChatInfo(RsChatMsgItem *c, ChatInfo &i);
|
|
|
|
|
2009-01-30 14:52:47 -05:00
|
|
|
/// Send avatar info to peer in jpeg format.
|
2014-03-17 16:56:06 -04:00
|
|
|
void sendAvatarJpegData(const RsPeerId& peer_id) ;
|
2009-01-30 14:52:47 -05:00
|
|
|
|
2010-04-24 06:33:12 -04:00
|
|
|
/// Send custom state info to peer
|
2014-03-17 16:56:06 -04:00
|
|
|
void sendCustomState(const RsPeerId& peer_id);
|
2010-04-24 06:33:12 -04:00
|
|
|
|
2009-01-30 14:52:47 -05:00
|
|
|
/// Receive the avatar in a chat item, with RS_CHAT_RECEIVE_AVATAR flag.
|
2009-09-29 16:37:20 -04:00
|
|
|
void receiveAvatarJpegData(RsChatAvatarItem *ci) ; // new method
|
2014-03-17 16:56:06 -04:00
|
|
|
void receiveStateString(const RsPeerId& id,const std::string& s) ;
|
2009-01-30 14:52:47 -05:00
|
|
|
|
2012-01-06 17:17:08 -05:00
|
|
|
/// methods for handling various Chat items.
|
|
|
|
bool handleRecvChatMsgItem(RsChatMsgItem *item) ; // returns false if the item should be deleted.
|
|
|
|
void handleRecvChatStatusItem(RsChatStatusItem *item) ;
|
|
|
|
void handleRecvChatAvatarItem(RsChatAvatarItem *item) ;
|
2013-09-19 18:10:24 -04:00
|
|
|
|
2009-01-30 14:52:47 -05:00
|
|
|
/// Sends a request for an avatar to the peer of given id
|
2014-03-17 16:56:06 -04:00
|
|
|
void sendAvatarRequest(const RsPeerId& peer_id) ;
|
2009-01-30 14:52:47 -05:00
|
|
|
|
2010-04-24 06:33:12 -04:00
|
|
|
/// Send a request for custom status string
|
2014-03-17 16:56:06 -04:00
|
|
|
void sendCustomStateRequest(const RsPeerId& peer_id);
|
2010-04-24 06:33:12 -04:00
|
|
|
|
2011-05-04 16:52:45 -04:00
|
|
|
/// called as a proxy to sendItem(). Possibly splits item into multiple items of size lower than the maximum item size.
|
2014-11-11 11:10:54 -05:00
|
|
|
//void checkSizeAndSendMessage(RsChatLobbyMsgItem *item) ;
|
|
|
|
void checkSizeAndSendMessage(RsChatMsgItem *item) ; // keep for compatibility for a few weeks.
|
2011-05-04 16:52:45 -04:00
|
|
|
|
|
|
|
/// Called when a RsChatMsgItem is received. The item may be collapsed with any waiting partial chat item from the same peer.
|
2014-11-11 11:10:54 -05:00
|
|
|
bool locked_checkAndRebuildPartialMessage(RsChatMsgItem *) ;
|
2012-01-06 17:17:08 -05:00
|
|
|
|
2009-09-29 16:37:20 -04:00
|
|
|
RsChatAvatarItem *makeOwnAvatarItem() ;
|
2009-10-04 18:27:42 -04:00
|
|
|
RsChatStatusItem *makeOwnCustomStateStringItem() ;
|
2009-03-20 16:41:31 -04:00
|
|
|
|
2014-03-28 23:57:44 -04:00
|
|
|
p3ServiceControl *mServiceCtrl;
|
2011-07-09 14:39:34 -04:00
|
|
|
p3LinkMgr *mLinkMgr;
|
2011-09-29 05:20:09 -04:00
|
|
|
p3HistoryMgr *mHistoryMgr;
|
2009-01-30 14:52:47 -05:00
|
|
|
|
2010-09-01 13:56:15 -04:00
|
|
|
std::list<RsChatMsgItem *> publicList;
|
2010-09-20 20:08:06 -04:00
|
|
|
std::list<RsChatMsgItem *> privateIncomingList;
|
|
|
|
std::list<RsChatMsgItem *> privateOutgoingList;
|
2010-08-31 13:13:52 -04:00
|
|
|
|
2009-01-30 14:52:47 -05:00
|
|
|
AvatarInfo *_own_avatar ;
|
2014-03-17 16:56:06 -04:00
|
|
|
std::map<RsPeerId,AvatarInfo *> _avatars ;
|
|
|
|
std::map<RsPeerId,RsChatMsgItem *> _pendingPartialMessages ;
|
2014-11-11 11:10:54 -05:00
|
|
|
|
2009-09-29 16:37:20 -04:00
|
|
|
std::string _custom_status_string ;
|
2014-03-17 16:56:06 -04:00
|
|
|
std::map<RsPeerId,StateStringInfo> _state_strings ;
|
2011-11-25 16:31:52 -05:00
|
|
|
|
2013-04-08 17:25:32 -04:00
|
|
|
RsChatSerialiser *_serializer ;
|
2007-12-11 20:43:17 -05:00
|
|
|
};
|
|
|
|
|
2011-06-30 16:50:08 -04:00
|
|
|
class p3ChatService::StateStringInfo
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
StateStringInfo()
|
|
|
|
{
|
|
|
|
_custom_status_string = "" ; // the custom status string of the peer
|
|
|
|
_peer_is_new = false ; // true when the peer has a new avatar
|
|
|
|
_own_is_new = false ; // true when I myself a new avatar to send to this peer.
|
|
|
|
}
|
|
|
|
|
|
|
|
std::string _custom_status_string ;
|
|
|
|
int _peer_is_new ; // true when the peer has a new avatar
|
|
|
|
int _own_is_new ; // true when I myself a new avatar to send to this peer.
|
|
|
|
};
|
|
|
|
|
2007-12-11 20:43:17 -05:00
|
|
|
#endif // SERVICE_CHAT_HEADER
|
2009-01-30 14:52:47 -05:00
|
|
|
|