phoenix-firestorm/indra/newview/llimview.h

708 lines
27 KiB
C++

/**
* @file LLIMMgr.h
* @brief Container for Instant Messaging
*
* $LicenseInfo:firstyear=2001&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library 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;
* version 2.1 of the License only.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
* $/LicenseInfo$
*/
#ifndef LL_LLIMVIEW_H
#define LL_LLIMVIEW_H
#include "lldockablefloater.h"
#include "lleventtimer.h"
#include "llinstantmessage.h"
#include "lllogchat.h"
#include "llvoicechannel.h"
#include "llinitdestroyclass.h"
#include "llcoros.h"
#include "lleventcoro.h"
class LLAvatarName;
class LLFriendObserver;
class LLCallDialogManager;
class LLIMSpeakerMgr;
/**
* Timeout Timer for outgoing Ad-Hoc/Group IM sessions which being initialized by the server
*/
class LLSessionTimeoutTimer : public LLEventTimer
{
public:
LLSessionTimeoutTimer(const LLUUID& session_id, F32 period) : LLEventTimer(period), mSessionId(session_id) {}
virtual ~LLSessionTimeoutTimer() {};
/* virtual */ bool tick();
private:
LLUUID mSessionId;
};
/**
* Model (MVC) for IM Sessions
*/
class LLIMModel : public LLSingleton<LLIMModel>
{
LLSINGLETON(LLIMModel);
public:
typedef std::list<LLSD> chat_message_list_t;
struct LLIMSession : public boost::signals2::trackable
{
typedef enum e_session_type
{ // for now we have 4 predefined types for a session
P2P_SESSION,
GROUP_SESSION,
ADHOC_SESSION,
NONE_SESSION,
} SType;
// [SL:KB] - Patch: Chat-GroupSnooze | Checked: 2014-03-01 (Catznip-3.6)
typedef enum e_session_close_action
{
CLOSE_DEFAULT,
CLOSE_LEAVE,
CLOSE_SNOOZE
} SCloseAction;
// [/SL:KB]
LLIMSession(const LLUUID& session_id, const std::string& name,
const EInstantMessage& type, const LLUUID& other_participant_id, const LLSD& voiceChannelInfo, const uuid_vec_t& ids, bool has_offline_msg);
virtual ~LLIMSession();
void initVoiceChannel(const LLSD &voiceChannelInfo = LLSD());
void sessionInitReplyReceived(const LLUUID& new_session_id);
void addMessagesFromHistoryCache(const std::list<LLSD>& history); // From local file
void addMessagesFromServerHistory(const LLSD& history, const std::string& target_from, const std::string& target_message, U32 timestamp); // From chat server
void addMessage(const std::string& from,
const LLUUID& from_id,
const std::string& utf8_text,
const std::string& time,
// <FS:Zi> Add a distinct color for server side group chat replay
// const bool is_history,
const S32 is_history,
const bool is_region_msg,
U32 timestamp);
void onVoiceChannelStateChanged(const LLVoiceChannel::EState& old_state, const LLVoiceChannel::EState& new_state, const LLVoiceChannel::EDirection& direction);
/** @deprecated */
static void chatFromLogFile(LLLogChat::ELogLineType type, const LLSD& msg, void* userdata);
bool isOutgoingAdHoc() const;
bool isAdHoc();
bool isP2P();
bool isGroupChat();
bool isP2PSessionType() const { return mSessionType == P2P_SESSION;}
bool isAdHocSessionType() const { return mSessionType == ADHOC_SESSION;}
bool isGroupSessionType() const { return mSessionType == GROUP_SESSION;}
LLUUID generateOutgoingAdHocHash() const;
//*TODO make private
/** ad-hoc sessions involve sophisticated chat history file naming schemes */
void buildHistoryFileName();
void loadHistory();
LLUUID mSessionID;
std::string mName;
EInstantMessage mType;
SType mSessionType;
// [SL:KB] - Patch: Chat-GroupSnooze | Checked: 2014-03-01 (Catznip-3.6)
SCloseAction mCloseAction;
S32 mSnoozeTime;
// [/SL:KB]
LLUUID mOtherParticipantID;
uuid_vec_t mInitialTargetIDs;
// <FS:Ansariel> Needed to store IDs of initially invited agents; required for FS Communication UI, as original IM floater gets destroyed
uuid_vec_t mInitialInvitedIDs;
std::string mHistoryFileName;
// Saved messages from the last minute of history read from the local group chat cache file
std::string mLastHistoryCacheDateTime;
chat_message_list_t mLastHistoryCacheMsgs;
// connection to voice channel state change signal
boost::signals2::connection mVoiceChannelStateChangeConnection;
//does NOT include system messages and agent's messages
S32 mParticipantUnreadMessageCount;
// does include all incoming messages
S32 mNumUnread;
chat_message_list_t mMsgs;
LLVoiceChannel* mVoiceChannel;
LLIMSpeakerMgr* mSpeakers;
bool mP2PAsAdhocCall;
bool mSessionInitialized;
//true if calling back the session URI after the session has closed is possible.
//Currently this will be false only for PSTN P2P calls.
bool mCallBackEnabled;
bool mTextIMPossible;
bool mStartCallOnInitialize;
//if IM session is created for a voice call
bool mStartedAsIMCall;
bool mHasOfflineMessage;
bool mIsDNDsend;
private:
void onAdHocNameCache(const LLAvatarName& av_name);
static LLUUID generateHash(const std::set<LLUUID>& sorted_uuids);
boost::signals2::connection mAvatarNameCacheConnection;
};
// <FS:Ansariel> [FS communication UI] Re-added to not toast if our IM floater is active
//we should control the currently active session
LLUUID mActiveSessionID;
void setActiveSessionID(const LLUUID& session_id);
void resetActiveSessionID() { mActiveSessionID.setNull(); }
LLUUID getActiveSessionID() { return mActiveSessionID; }
// </FS:Ansariel> [FS communication UI]
/** Session id to session object */
std::map<LLUUID, LLIMSession*> mId2SessionMap;
typedef boost::signals2::signal<void(const LLSD&)> session_signal_t;
session_signal_t mNewMsgSignal;
session_signal_t mNoUnreadMsgsSignal;
/**
* Find an IM Session corresponding to session_id
* Returns NULL if the session does not exist
*/
LLIMSession* findIMSession(const LLUUID& session_id) const;
/**
* Find an Ad-Hoc IM Session with specified participants
* @return first found Ad-Hoc session or NULL if the session does not exist
*/
LLIMSession* findAdHocIMSession(const uuid_vec_t& ids);
/**
* Rebind session data to a new session id.
*/
void processSessionInitializedReply(const LLUUID& old_session_id, const LLUUID& new_session_id);
boost::signals2::connection addNewMsgCallback(const session_signal_t::slot_type& cb ) { return mNewMsgSignal.connect(cb); }
boost::signals2::connection addNoUnreadMsgsCallback(const session_signal_t::slot_type& cb ) { return mNoUnreadMsgsSignal.connect(cb); }
/**
* Create new session object in a model
* @param name session name should not be empty, will return false if empty
*/
bool newSession(const LLUUID& session_id, const std::string& name, const EInstantMessage& type, const LLUUID& other_participant_id,
const uuid_vec_t& ids, const LLSD& voiceChannelInfo = LLSD(), bool has_offline_msg = false);
bool newSession(const LLUUID& session_id, const std::string& name, const EInstantMessage& type, const LLUUID &other_participant_id,
const LLSD &voiceChannelInfo = LLSD(), bool has_offline_msg = false);
/**
* Remove all session data associated with a session specified by session_id
*/
bool clearSession(const LLUUID& session_id);
// <FS:CR> Make public for FS Communications UI
/**
* Populate supplied std::list with messages starting from index specified by start_index without
* emitting no unread messages signal.
*/
void getMessagesSilently(const LLUUID& session_id, std::list<LLSD>& messages, int start_index = 0);
// </FS:CR>
/**
* Sends no unread messages signal.
*/
void sendNoUnreadMessages(const LLUUID& session_id);
/**
* Populate supplied std::list with messages starting from index specified by start_index
*/
void getMessages(const LLUUID& session_id, std::list<LLSD>& messages, int start_index = 0, const bool sendNoUnreadMsgs = true);
/**
* Add a message to an IM Model - the message is saved in a message store associated with a session specified by session_id
* and also saved into a file if log2file is specified.
* It sends new message signal for each added message.
*/
void addMessage(const LLUUID& session_id,
const std::string& from,
const LLUUID& other_participant_id,
const std::string& utf8_text,
bool log2file = true,
bool is_region_msg = false,
U32 time_stamp = 0,
// <FS:Ansariel> FS extra params
bool is_announcement = false,
bool keyword_alert_performed = false);
void processAddingMessage(const LLUUID& session_id,
const std::string& from,
const LLUUID& from_id,
const std::string& utf8_text,
bool log2file,
bool is_region_msg,
U32 time_stamp,
// <FS:Ansariel> FS extra params
bool is_announcement,
bool keyword_alert_performed = false);
/**
* Similar to addMessage(...) above but won't send a signal about a new message added
*/
// <FS:Ansariel> Added is_announcement parameter
//LLIMModel::LLIMSession* addMessageSilently(const LLUUID& session_id, const std::string& from, const LLUUID& from_id,
// const std::string& utf8_text, bool log2file = true, U32 timestamp = 0);
LLIMModel::LLIMSession* addMessageSilently(const LLUUID& session_id, const std::string& from, const LLUUID& from_id,
const std::string& utf8_text, bool log2file = true, bool is_region_msg = false, U32 timestamp = 0, bool is_announcement = false);
/**
* Add a system message to an IM Model
*/
void proccessOnlineOfflineNotification(const LLUUID& session_id, const std::string& utf8_text);
/**
* Get a session's name.
* For a P2P chat - it's an avatar's name,
* For a group chat - it's a group's name
* For an incoming ad-hoc chat - is received from the server and is in a from of "<Avatar's name> Conference"
* It is updated in LLIMModel::LLIMSession's constructor to localize the "Conference".
*/
const std::string getName(const LLUUID& session_id) const;
/**
* Get number of unread messages in a session with session_id
* Returns -1 if the session with session_id doesn't exist
*/
const S32 getNumUnread(const LLUUID& session_id) const;
/**
* Get uuid of other participant in a session with session_id
* Returns LLUUID::null if the session doesn't exist
*
* *TODO what to do with other participants in ad-hoc and group chats?
*/
const LLUUID& getOtherParticipantID(const LLUUID& session_id) const;
/**
* Get type of a session specified by session_id
* Returns EInstantMessage::IM_COUNT if the session does not exist
*/
EInstantMessage getType(const LLUUID& session_id) const;
/**
* Get voice channel for the session specified by session_id
* Returns NULL if the session does not exist
*/
LLVoiceChannel* getVoiceChannel(const LLUUID& session_id) const;
/**
* Get im speaker manager for the session specified by session_id
* Returns NULL if the session does not exist
*/
LLIMSpeakerMgr* getSpeakerManager(const LLUUID& session_id) const;
const std::string& getHistoryFileName(const LLUUID& session_id) const;
static void sendLeaveSession(const LLUUID& session_id, const LLUUID& other_participant_id);
static bool sendStartSession(const LLUUID& temp_session_id, const LLUUID& other_participant_id,
const uuid_vec_t& ids, EInstantMessage dialog, bool p2p_as_adhoc_call);
static void sendTypingState(LLUUID session_id, LLUUID other_participant_id, bool typing);
static void sendMessage(const std::string& utf8_text, const LLUUID& im_session_id,
const LLUUID& other_participant_id, EInstantMessage dialog);
// Adds people from speakers list (people with whom you are currently speaking) to the Recent People List
static void addSpeakersToRecent(const LLUUID& im_session_id);
void testMessages();
/**
* Saves an IM message into a file
*/
bool logToFile(const std::string& file_name, const std::string& from, const LLUUID& from_id, const std::string& utf8_text);
private:
// <FS:CR> Post CHUI - Move this public for FS Communications UI
/**
* Populate supplied std::list with messages starting from index specified by start_index without
* emitting no unread messages signal.
*/
//void getMessagesSilently(const LLUUID& session_id, std::list<LLSD>& messages, int start_index = 0);
// </FS:CR>
/**
* Add message to a list of message associated with session specified by session_id
*/
// <FS:Ansariel> Added is_announcement parameter
//bool addToHistory(const LLUUID& session_id, const std::string& from, const LLUUID& from_id, const std::string& utf8_text, bool is_region_msg, U32 timestamp);
bool addToHistory(const LLUUID& session_id, const std::string& from, const LLUUID& from_id, const std::string& utf8_text, bool is_region_msg, U32 timestamp, bool is_announcement);
};
class LLIMSessionObserver
{
public:
virtual ~LLIMSessionObserver() {}
virtual void sessionAdded(const LLUUID& session_id, const std::string& name, const LLUUID& other_participant_id, bool has_offline_msg) = 0;
virtual void sessionActivated(const LLUUID& session_id, const std::string& name, const LLUUID& other_participant_id) = 0;
virtual void sessionVoiceOrIMStarted(const LLUUID& session_id) = 0;
virtual void sessionRemoved(const LLUUID& session_id) = 0;
virtual void sessionIDUpdated(const LLUUID& old_session_id, const LLUUID& new_session_id) = 0;
};
class LLIMMgr : public LLSingleton<LLIMMgr>
{
LLSINGLETON(LLIMMgr);
friend class LLIMModel;
public:
enum EInvitationType
{
INVITATION_TYPE_INSTANT_MESSAGE = 0,
INVITATION_TYPE_VOICE = 1,
INVITATION_TYPE_IMMEDIATE = 2
};
// Add a message to a session. The session can keyed to sesion id
// or agent id.
void addMessage(const LLUUID& session_id,
const LLUUID& target_id,
const std::string& from,
const std::string& msg,
bool is_offline_msg = false,
const std::string& session_name = LLStringUtil::null,
EInstantMessage dialog = IM_NOTHING_SPECIAL,
U32 parent_estate_id = 0,
const LLUUID& region_id = LLUUID::null,
const LLVector3& position = LLVector3::zero,
bool is_region_msg = false,
U32 timestamp = 0,
LLUUID display_id = LLUUID::null,
std::string_view display_name = "",
bool is_announcement = false, // <FS:Ansariel> Special parameter indicating announcement
bool keyword_alert_performed = false // <FS:Ansariel> Pass info if keyword alert has been performed
);
void addSystemMessage(const LLUUID& session_id, const std::string& message_name, const LLSD& args);
// This adds a session to the talk view. The name is the local
// name of the session, dialog specifies the type of
// session. Since sessions can be keyed off of first recipient or
// initiator, the session can be matched against the id
// provided. If the session exists, it is brought forward. This
// method accepts a group id or an agent id. Specifying id = NULL
// results in an im session to everyone. Returns the uuid of the
// session.
LLUUID addSession(const std::string& name,
EInstantMessage dialog,
const LLUUID& other_participant_id,
const LLSD& voiceChannelInfo = LLSD());
// Adds a session using a specific group of starting agents
// the dialog type is assumed correct. Returns the uuid of the session.
// A session can be added to a floater specified by floater_id.
LLUUID addSession(const std::string& name,
EInstantMessage dialog,
const LLUUID& other_participant_id,
const std::vector<LLUUID> &ids,
const LLSD& voiceChannelInfo = LLSD(),
const LLUUID& floater_id = LLUUID::null);
/**
* Creates a P2P session with the requisite handle for responding to voice calls.
*
* @param name session name, cannot be null
* @param caller_uri - sip URI of caller. It should be always be passed into the method to avoid
* incorrect working of LLVoiceChannel instances. See EXT-2985.
*/
LLUUID addP2PSession(const std::string &name, const LLUUID &other_participant_id, const LLSD &voice_call_info);
/**
* Leave the session with session id. Send leave session notification
* to the server and removes all associated session data
* @return false if the session with specified id was not exist
*/
bool leaveSession(const LLUUID& session_id);
void inviteToSession(
const LLUUID& session_id,
const std::string& session_name,
const LLUUID& caller,
const std::string& caller_name,
EInstantMessage type,
EInvitationType inv_type,
const LLSD &voice_channel_info = LLSD()
);
void processIMTypingStart(const LLUUID& from_id, const EInstantMessage im_type);
void processIMTypingStop(const LLUUID& from_id, const EInstantMessage im_type);
// automatically start a call once the session has initialized
void autoStartCallOnStartup(const LLUUID& session_id);
// Calc number of all unread IMs
S32 getNumberOfUnreadIM();
/**
* Calculates number of unread IMs from real participants in all stored sessions
*/
S32 getNumberOfUnreadParticipantMessages();
// This method is used to go through all active sessions and
// disable all of them. This method is usally called when you are
// forced to log out or similar situations where you do not have a
// good connection.
void disconnectAllSessions();
bool hasSession(const LLUUID& session_id);
// [SL:KB] - Patch: Chat-GroupSnooze | Checked: 2012-06-16 (Catznip-3.3)
bool checkSnoozeExpiration(const LLUUID& session_id) const;
bool isSnoozedSession(const LLUUID& session_id) const;
bool restoreSnoozedSession(const LLUUID& session_id);
// [/SL:KB]
static LLUUID computeSessionID(EInstantMessage dialog, const LLUUID& other_participant_id);
void clearPendingInvitation(const LLUUID& session_id);
void processAgentListUpdates(const LLUUID& session_id, const LLSD& body);
LLSD getPendingAgentListUpdates(const LLUUID& session_id);
void addPendingAgentListUpdates(
const LLUUID& sessioN_id,
const LLSD& updates);
void clearPendingAgentListUpdates(const LLUUID& session_id);
void addSessionObserver(LLIMSessionObserver *);
void removeSessionObserver(LLIMSessionObserver *);
//show error statuses to the user
void showSessionStartError(const std::string& error_string, const LLUUID session_id);
void showSessionEventError(const std::string& event_string, const std::string& error_string, const LLUUID session_id);
void showSessionForceClose(const std::string& reason, const LLUUID session_id);
static bool onConfirmForceCloseError(const LLSD& notification, const LLSD& response);
/**
* Start call in a session
* @return false if voice channel doesn't exist
**/
bool startCall(const LLUUID& session_id, LLVoiceChannel::EDirection direction = LLVoiceChannel::OUTGOING_CALL, const LLSD& voice_channel_info = LLSD());
/**
* End call in a session
* @return false if voice channel doesn't exist
**/
bool endCall(const LLUUID& session_id);
bool isVoiceCall(const LLUUID& session_id);
void updateDNDMessageStatus();
bool isDNDMessageSend(const LLUUID& session_id);
void setDNDMessageSent(const LLUUID& session_id, bool is_send);
void addNotifiedNonFriendSessionID(const LLUUID& session_id);
bool isNonFriendSessionNotified(const LLUUID& session_id);
private:
/**
* Remove data associated with a particular session specified by session_id
*/
void removeSession(const LLUUID& session_id);
// This simple method just iterates through all of the ids, and
// prints a simple message if they are not online. Used to help
// reduce 'hello' messages to the linden employees unlucky enough
// to have their calling card in the default inventory.
void noteOfflineUsers(const LLUUID& session_id, const std::vector<LLUUID>& ids);
void noteMutedUsers(const LLUUID& session_id, const std::vector<LLUUID>& ids);
void processIMTypingCore(const LLUUID& from_id, const EInstantMessage im_type, bool typing);
static void onInviteNameLookup(LLSD payload, const LLUUID& id, const LLAvatarName& name);
void notifyObserverSessionAdded(const LLUUID& session_id, const std::string& name, const LLUUID& other_participant_id, bool has_offline_msg);
//Triggers when a session has already been added
void notifyObserverSessionActivated(const LLUUID& session_id, const std::string& name, const LLUUID& other_participant_id);
void notifyObserverSessionVoiceOrIMStarted(const LLUUID& session_id);
void notifyObserverSessionRemoved(const LLUUID& session_id);
void notifyObserverSessionIDUpdated(const LLUUID& old_session_id, const LLUUID& new_session_id);
private:
typedef std::list <LLIMSessionObserver *> session_observers_list_t;
session_observers_list_t mSessionObservers;
// EXP-901
// If "Only friends and groups can IM me" option is ON but the user got message from non-friend,
// the user should be notified that to be able to see this message the option should be OFF.
// This set stores session IDs in which user was notified. Need to store this IDs so that the user
// be notified only one time per session with non-friend.
typedef std::set<LLUUID> notified_non_friend_sessions_t;
notified_non_friend_sessions_t mNotifiedNonFriendSessions;
LLSD mPendingInvitations;
LLSD mPendingAgentListUpdates;
// [SL:KB] - Patch: Chat-GroupSnooze | Checked: 2012-06-16 (Catznip-3.3)
typedef std::map<LLUUID, F64> snoozed_sessions_t;
snoozed_sessions_t mSnoozedSessions;
// [/SL:KB]
};
class LLCallDialogManager : public LLSingleton<LLCallDialogManager>
{
LLSINGLETON(LLCallDialogManager);
~LLCallDialogManager();
public:
// static for convinience
static void onVoiceChannelChanged(const LLUUID &session_id);
static void onVoiceChannelStateChanged(const LLVoiceChannel::EState& old_state, const LLVoiceChannel::EState& new_state, const LLVoiceChannel::EDirection& direction, bool ended_by_agent);
private:
void initSingleton() override;
void onVoiceChannelChangedInt(const LLUUID &session_id);
void onVoiceChannelStateChangedInt(const LLVoiceChannel::EState& old_state, const LLVoiceChannel::EState& new_state, const LLVoiceChannel::EDirection& direction, bool ended_by_agent);
protected:
std::string mPreviousSessionlName;
std::string mCurrentSessionlName;
LLIMModel::LLIMSession* mSession;
LLVoiceChannel::EState mOldState;
boost::signals2::connection mVoiceChannelChanged;
};
class LLCallDialog : public LLDockableFloater
{
public:
LLCallDialog(const LLSD& payload);
virtual ~LLCallDialog();
virtual bool postBuild();
void dockToToolbarButton(const std::string& toolbarButtonName);
// check timer state
/*virtual*/ void draw();
/*virtual*/ void onOpen(const LLSD& key);
protected:
// lifetime timer for a notification
LLTimer mLifetimeTimer;
// notification's lifetime in seconds
S32 mLifetime;
static const S32 DEFAULT_LIFETIME = 5;
virtual bool lifetimeHasExpired();
virtual void onLifetimeExpired();
/**
* Sets icon depend on session.
*
* If passed session_id is a group id group icon will be shown, otherwise avatar icon for participant_id
*
* @param session_id - UUID of session
* @param participant_id - UUID of other participant
*/
void setIcon(const LLSD& session_id, const LLSD& participant_id);
LLSD mPayload;
private:
LLDockControl::DocAt getDockControlPos(const std::string& toolbarButtonName);
};
class LLIncomingCallDialog : public LLCallDialog
{
public:
LLIncomingCallDialog(const LLSD& payload);
~LLIncomingCallDialog()
{
if (mAvatarNameCacheConnection.connected())
{
mAvatarNameCacheConnection.disconnect();
}
}
/*virtual*/ bool postBuild();
/*virtual*/ void onOpen(const LLSD& key);
static void onAccept(void* user_data);
static void onReject(void* user_data);
static void onStartIM(void* user_data);
static void processCallResponse(S32 response, const LLSD& payload);
private:
void setCallerName(const std::string& ui_title,
const std::string& ui_label,
const std::string& call_type);
void onAvatarNameCache(const LLUUID& agent_id,
const LLAvatarName& av_name,
const std::string& call_type);
boost::signals2::connection mAvatarNameCacheConnection;
/*virtual*/ void onLifetimeExpired();
};
class LLOutgoingCallDialog : public LLCallDialog
{
public:
LLOutgoingCallDialog(const LLSD& payload);
/*virtual*/ bool postBuild();
void show(const LLSD& key);
static void onCancel(void* user_data);
static const LLUUID OCD_KEY;
private:
// hide all text boxes
void hideAllText();
};
// Globals
extern LLIMMgr *gIMMgr;
#endif // LL_LLIMView_H