Imported existing code

indra/newview/llimview.h

@@ -0,0 +1,229 @@
+/** 
+ * @file LLIMMgr.h
+ * @brief Container for Instant Messaging
+ *
+ * $LicenseInfo:firstyear=2001&license=viewergpl$
+ * 
+ * Copyright (c) 2001-2009, Linden Research, Inc.
+ * 
+ * Second Life Viewer Source Code
+ * The source code in this file ("Source Code") is provided by Linden Lab
+ * to you under the terms of the GNU General Public License, version 2.0
+ * ("GPL"), unless you have obtained a separate licensing agreement
+ * ("Other License"), formally executed by you and Linden Lab.  Terms of
+ * the GPL can be found in doc/GPL-license.txt in this distribution, or
+ * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
+ * 
+ * There are special exceptions to the terms and conditions of the GPL as
+ * it is applied to this Source Code. View the full text of the exception
+ * in the file doc/FLOSS-exception.txt in this software distribution, or
+ * online at
+ * http://secondlifegrid.net/programs/open_source/licensing/flossexception
+ * 
+ * By copying, modifying or distributing this software, you acknowledge
+ * that you have read and understood your obligations described above,
+ * and agree to abide by those obligations.
+ * 
+ * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
+ * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
+ * COMPLETENESS OR PERFORMANCE.
+ * $/LicenseInfo$
+ */
+
+#ifndef LL_LLIMVIEW_H
+#define LL_LLIMVIEW_H
+
+#include "llfloater.h"
+#include "llinstantmessage.h"
+#include "lluuid.h"
+
+class LLFloaterChatterBox;
+class LLUUID;
+class LLFloaterIMPanel;
+class LLFriendObserver;
+class LLFloaterIM;
+
+class LLIMMgr : public LLSingleton<LLIMMgr>
+{
+public:
+	enum EInvitationType
+	{
+		INVITATION_TYPE_INSTANT_MESSAGE = 0,
+		INVITATION_TYPE_VOICE = 1,
+		INVITATION_TYPE_IMMEDIATE = 2
+	};
+
+	LLIMMgr();
+	virtual ~LLIMMgr();
+
+	// 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,
+					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 link_name = false);
+
+	void addSystemMessage(const LLUUID& session_id, const std::string& message_name, const LLSD& args);
+
+	// This method returns TRUE if the local viewer has a session
+	// currently open keyed to the uuid. The uuid can be keyed by
+	// either session id or agent id.
+	BOOL isIMSessionOpen(const LLUUID& uuid);
+
+	// 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);
+
+	// Adds a session using a specific group of starting agents
+	// the dialog type is assumed correct. Returns the uuid of the session.
+	LLUUID addSession(const std::string& name,
+					  EInstantMessage dialog,
+					  const LLUUID& other_participant_id,
+					  const LLDynamicArray<LLUUID>& ids);
+
+	// Creates a P2P session with the requisite handle for responding to voice calls
+	LLUUID addP2PSession(const std::string& name,
+					  const LLUUID& other_participant_id,
+					  const std::string& voice_session_handle,
+					  const std::string& caller_uri = LLStringUtil::null);
+
+	// This removes the panel referenced by the uuid, and then
+	// restores internal consistency. The internal pointer is not
+	// deleted.
+	void removeSession(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 std::string& session_handle = LLStringUtil::null,
+		const std::string& session_uri = LLStringUtil::null);
+
+	//Updates a given session's session IDs.  Does not open,
+	//create or do anything new.  If the old session doesn't
+	//exist, then nothing happens.
+	void updateFloaterSessionID(const LLUUID& old_session_id,
+								const LLUUID& new_session_id);
+
+	void processIMTypingStart(const LLIMInfo* im_info);
+	void processIMTypingStop(const LLIMInfo* im_info);
+
+	// Rebuild stuff
+	void refresh();
+
+	void notifyNewIM();
+	void clearNewIMNotification();
+
+	// IM received that you haven't seen yet
+	BOOL getIMReceived() const;
+
+	void		setFloaterOpen(BOOL open);		/*Flawfinder: ignore*/
+	BOOL		getFloaterOpen();
+
+	LLFloaterChatterBox* getFloater();
+
+	// 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();
+
+	static void	toggle(void*);
+
+	// This is a helper function to determine what kind of im session
+	// should be used for the given agent.
+	static EInstantMessage defaultIMTypeForAgent(const LLUUID& agent_id);
+
+	BOOL hasSession(const LLUUID& session_id);
+
+	// This method returns the im panel corresponding to the uuid
+	// provided. The uuid must be a session id. Returns NULL if there
+	// is no matching panel.
+	LLFloaterIMPanel* findFloaterBySession(const LLUUID& session_id);
+
+	static LLUUID computeSessionID(EInstantMessage dialog, const LLUUID& other_participant_id);
+
+	void clearPendingInvitation(const LLUUID& session_id);
+
+	LLSD getPendingAgentListUpdates(const LLUUID& session_id);
+	void addPendingAgentListUpdates(
+		const LLUUID& sessioN_id,
+		const LLSD& updates);
+	void clearPendingAgentListUpdates(const LLUUID& session_id);
+
+	//HACK: need a better way of enumerating existing session, or listening to session create/destroy events
+	const std::set<LLHandle<LLFloater> >& getIMFloaterHandles() { return mFloaters; }
+
+private:
+	// create a panel and update internal representation for
+	// consistency. Returns the pointer, caller (the class instance
+	// since it is a private method) is not responsible for deleting
+	// the pointer.
+	LLFloaterIMPanel* createFloater(const LLUUID& session_id,
+									const LLUUID& target_id,
+									const std::string& name,
+									EInstantMessage dialog,
+									BOOL user_initiated = FALSE);
+
+	LLFloaterIMPanel* createFloater(const LLUUID& session_id,
+									const LLUUID& target_id,
+									const std::string& name,
+									const LLDynamicArray<LLUUID>& ids,
+									EInstantMessage dialog,
+									BOOL user_initiated = FALSE);
+
+	// 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(LLFloaterIMPanel* panel, const LLDynamicArray<LLUUID>& ids);
+	void noteMutedUsers(LLFloaterIMPanel* panel, const LLDynamicArray<LLUUID>& ids);
+
+	void processIMTypingCore(const LLIMInfo* im_info, BOOL typing);
+
+	static void onInviteNameLookup(const LLUUID& id, const std::string& first, const std::string& last, BOOL is_group, void* userdata);
+
+private:
+	std::set<LLHandle<LLFloater> > mFloaters;
+	LLFriendObserver* mFriendObserver;
+
+	// An IM has been received that you haven't seen yet.
+	BOOL mIMReceived;
+
+	LLSD mPendingInvitations;
+	LLSD mPendingAgentListUpdates;
+};
+
+
+class LLFloaterIM : public LLMultiFloater
+{
+public:
+	LLFloaterIM();
+	/*virtual*/ BOOL postBuild();
+
+	static std::map<std::string,std::string> sEventStringsMap;
+	static std::map<std::string,std::string> sErrorStringsMap;
+	static std::map<std::string,std::string> sForceCloseSessionMap;
+};
+
+// Globals
+extern LLIMMgr *gIMMgr;
+
+#endif  // LL_LLIMView_H