summaryrefslogtreecommitdiff
path: root/indra/newview/llparticipantlist.h
blob: bc6c6c2b502eae4f1d166128adbffea3ce2632d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
/** 
 * @file llparticipantlist.h
 * @brief LLParticipantList intended to update view(LLAvatarList) according to incoming messages
 *
 * $LicenseInfo:firstyear=2009&license=viewergpl$
 * 
 * Copyright (c) 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$
 */

#include "llviewerprecompiledheaders.h"
#include "llevent.h"
#include "llpanelpeoplemenus.h"
#include "llimview.h"

class LLSpeakerMgr;
class LLAvatarList;
class LLUICtrl;

class LLParticipantList
{
	LOG_CLASS(LLParticipantList);
	public:
		LLParticipantList(LLSpeakerMgr* data_source, LLAvatarList* avatar_list, bool use_context_menu = true);
		~LLParticipantList();
		void setSpeakingIndicatorsVisible(BOOL visible);

		typedef enum e_participant_sort_oder {
			E_SORT_BY_NAME = 0,
		} EParticipantSortOrder;

		/**
		 * Set and sort Avatarlist by given order
		 */
		void setSortOrder(EParticipantSortOrder order = E_SORT_BY_NAME);

		/**
		 * Refreshes participants to display ones not in voice as disabled.
		 * TODO: mantipov: probably should be moved into derived class for LLFloaterCall
		 */
		void refreshVoiceState();

	protected:
		/**
		 * LLSpeakerMgr event handlers
		 */
		bool onAddItemEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		bool onRemoveItemEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		bool onClearListEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		bool onModeratorUpdateEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		bool onSpeakerMuteEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);

		/**
		 * Sorts the Avatarlist by stored order
		 */
		void sort();

		//List of listeners implementing LLOldEvents::LLSimpleListener.
		//There is no way to handle all the events in one listener as LLSpeakerMgr registers listeners in such a way
		//that one listener can handle only one type of event
		class BaseSpeakerListner : public LLOldEvents::LLSimpleListener
		{
		public:
			BaseSpeakerListner(LLParticipantList& parent) : mParent(parent) {}
		protected:
			LLParticipantList& mParent;
		};

		class SpeakerAddListener : public BaseSpeakerListner
		{
		public:
			SpeakerAddListener(LLParticipantList& parent) : BaseSpeakerListner(parent) {}
			/*virtual*/ bool handleEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		};

		class SpeakerRemoveListener : public BaseSpeakerListner
		{
		public:
			SpeakerRemoveListener(LLParticipantList& parent) : BaseSpeakerListner(parent) {}
			/*virtual*/ bool handleEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		};

		class SpeakerClearListener : public BaseSpeakerListner
		{
		public:
			SpeakerClearListener(LLParticipantList& parent) : BaseSpeakerListner(parent) {}
			/*virtual*/ bool handleEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		};

		class SpeakerModeratorUpdateListener : public BaseSpeakerListner
		{
		public:
			SpeakerModeratorUpdateListener(LLParticipantList& parent) : BaseSpeakerListner(parent) {}
			/*virtual*/ bool handleEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		};
		
		class SpeakerMuteListener : public BaseSpeakerListner
		{
		public:
			SpeakerMuteListener(LLParticipantList& parent) : BaseSpeakerListner(parent) {}

			/*virtual*/ bool handleEvent(LLPointer<LLOldEvents::LLEvent> event, const LLSD& userdata);
		};

		/**
		 * Menu used in the participant list.
		 */
		class LLParticipantListMenu : public LLPanelPeopleMenus::ContextMenu
		{
		public:
			LLParticipantListMenu(LLParticipantList& parent):mParent(parent){};
			/*virtual*/ LLContextMenu* createMenu();
			/*virtual*/ void show(LLView* spawning_view, const std::vector<LLUUID>& uuids, S32 x, S32 y);
		protected:
			LLParticipantList& mParent;
		private:
			bool enableContextMenuItem(const LLSD& userdata);
			bool checkContextMenuItem(const LLSD& userdata);

			void toggleAllowTextChat(const LLSD& userdata);
			void toggleMute(const LLSD& userdata, U32 flags);
			void toggleMuteText(const LLSD& userdata);
			void toggleMuteVoice(const LLSD& userdata);
		
			/**
			 * Return true if Agent is group moderator(and moderator of group call).
			 */
			bool isGroupModerator();

			// Voice moderation support
			/**
			 * Check whether specified by argument avatar is muted for group chat or not.
			 */
			bool isMuted(const LLUUID& avatar_id);

			/**
			 * Processes Voice moderation menu items.
			 *
			 * It calls either moderateVoiceParticipant() or moderateVoiceParticipant() depend on
			 * passed parameter.
			 *
			 * @param userdata can be "selected" or "others".
			 *
			 * @see moderateVoiceParticipant()
			 * @see moderateVoiceOtherParticipants()
			 */
			void moderateVoice(const LLSD& userdata);

			/**
			 * Mutes/Unmutes avatar for current group voice chat.
			 *
			 * It only marks avatar as muted for session and does not use local Agent's Block list.
			 * It does not mute Agent itself.
			 *
			 * @param[in] avatar_id UUID of avatar to be processed
			 * @param[in] unmute if true - specified avatar will be muted, otherwise - unmuted.
			 *
			 * @see moderateVoiceOtherParticipants()
			 */
			void moderateVoiceParticipant(const LLUUID& avatar_id, bool unmute);

			/**
			 * Mutes/Unmutes all avatars except specified for current group voice chat.
			 *
			 * It only marks avatars as muted for session and does not use local Agent's Block list.
			 * It based call moderateVoiceParticipant() for each avatar should be muted/unmuted.
			 *
			 * @param[in] excluded_avatar_id UUID of avatar NOT to be processed
			 * @param[in] unmute if true - avatars will be muted, otherwise - unmuted.
			 *
			 * @see moderateVoiceParticipant()
			 */
			void moderateVoiceOtherParticipants(const LLUUID& excluded_avatar_id, bool unmute);
		};

	private:
		void onAvatarListDoubleClicked(LLAvatarList* list);
		void onAvatarListRefreshed(LLUICtrl* ctrl, const LLSD& param);

		/**
		 * Adds specified avatar ID to the existing list if it is not Agent's ID
		 *
		 * @param[in, out] existing_list - vector with avatars' UUIDs already in the list
		 * @param[in] avatar_id - Avatar UUID to be added into the list
		 */
		void addAvatarIDExceptAgent(std::vector<LLUUID>& existing_list, const LLUUID& avatar_id);

		/**
		 * Adjusts passed participant to work properly.
		 *
		 * Adds SpeakerMuteListener to process moderation actions.
		 */
		void adjustParticipant(const LLUUID& speaker_id);

		LLSpeakerMgr*		mSpeakerMgr;
		LLAvatarList*		mAvatarList;

		std::set<LLUUID>	mModeratorList;
		std::set<LLUUID>	mModeratorToRemoveList;

		LLPointer<SpeakerAddListener>				mSpeakerAddListener;
		LLPointer<SpeakerRemoveListener>			mSpeakerRemoveListener;
		LLPointer<SpeakerClearListener>				mSpeakerClearListener;
		LLPointer<SpeakerModeratorUpdateListener>	mSpeakerModeratorListener;
		LLPointer<SpeakerMuteListener>				mSpeakerMuteListener;

		LLParticipantListMenu*    mParticipantListMenu;

		EParticipantSortOrder	mSortOrder;

		// boost::connections
		boost::signals2::connection mAvatarListDoubleClickConnection;
		boost::signals2::connection mAvatarListRefreshConnection;
		boost::signals2::connection mAvatarListReturnConnection;
};