confbridge: Separate user muting from system muting overrides.
[asterisk/asterisk.git] / apps / confbridge / conf_state_multi_marked.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Terry Wilson
5  *
6  * Terry Wilson <twilson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  *
18  * Please follow coding guidelines
19  * http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES
20  */
21
22 /*! \file
23  *
24  * \brief Confbridge state handling for the MULTI_MARKED state
25  *
26  * \author\verbatim Terry Wilson <twilson@digium.com> \endverbatim
27  *
28  * \ingroup applications
29  */
30
31 /*** MODULEINFO
32         <support_level>core</support_level>
33  ***/
34
35 #include "asterisk.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/linkedlists.h"
38 #include "include/confbridge.h"
39 #include "asterisk/musiconhold.h"
40 #include "include/conf_state.h"
41
42 static void join_active(struct confbridge_user *user);
43 static void join_marked(struct confbridge_user *user);
44 static void leave_active(struct confbridge_user *user);
45 static void leave_marked(struct confbridge_user *user);
46 static void transition_to_marked(struct confbridge_user *user);
47
48 static struct confbridge_state STATE_MULTI_MARKED = {
49         .name = "MULTI_MARKED",
50         .join_unmarked = join_active,
51         .join_waitmarked = join_active,
52         .join_marked = join_marked,
53         .leave_unmarked = leave_active,
54         .leave_waitmarked = leave_active,
55         .leave_marked = leave_marked,
56         .entry = transition_to_marked,
57 };
58 struct confbridge_state *CONF_STATE_MULTI_MARKED = &STATE_MULTI_MARKED;
59
60 static void join_active(struct confbridge_user *user)
61 {
62         conf_add_user_active(user->conference, user);
63         conf_update_user_mute(user);
64 }
65
66 static void join_marked(struct confbridge_user *user)
67 {
68         conf_add_user_marked(user->conference, user);
69         conf_update_user_mute(user);
70 }
71
72 static void leave_active(struct confbridge_user *user)
73 {
74         conf_remove_user_active(user->conference, user);
75         if (user->conference->activeusers == 1) {
76                 conf_change_state(user, CONF_STATE_SINGLE_MARKED);
77         }
78 }
79
80 static void leave_marked(struct confbridge_user *user)
81 {
82         struct confbridge_user *user_iter;
83
84         conf_remove_user_marked(user->conference, user);
85
86         if (user->conference->markedusers == 0) {
87                 /* Play back the audio prompt saying the leader has left the conference */
88                 if (!ast_test_flag(&user->u_profile, USER_OPT_QUIET)) {
89                         ao2_unlock(user->conference);
90                         ast_autoservice_start(user->chan);
91                         play_sound_file(user->conference,
92                                 conf_get_sound(CONF_SOUND_LEADER_HAS_LEFT, user->b_profile.sounds));
93                         ast_autoservice_stop(user->chan);
94                         ao2_lock(user->conference);
95                 }
96
97                 AST_LIST_TRAVERSE_SAFE_BEGIN(&user->conference->active_list, user_iter, list) {
98                         /* Kick ENDMARKED user_iters */
99                         if (ast_test_flag(&user_iter->u_profile, USER_OPT_ENDMARKED)) {
100                                 if (ast_test_flag(&user_iter->u_profile, USER_OPT_WAITMARKED)
101                                         && !ast_test_flag(&user_iter->u_profile, USER_OPT_MARKEDUSER)) {
102                                         AST_LIST_REMOVE_CURRENT(list);
103                                         user_iter->conference->activeusers--;
104                                         AST_LIST_INSERT_TAIL(&user_iter->conference->waiting_list, user_iter, list);
105                                         user_iter->conference->waitingusers++;
106                                 }
107                                 user_iter->kicked = 1;
108                                 ast_bridge_remove(user_iter->conference->bridge, user_iter->chan);
109                         } else if (ast_test_flag(&user_iter->u_profile, USER_OPT_WAITMARKED)
110                                 && !ast_test_flag(&user_iter->u_profile, USER_OPT_MARKEDUSER)) {
111                                 AST_LIST_REMOVE_CURRENT(list);
112                                 user_iter->conference->activeusers--;
113                                 AST_LIST_INSERT_TAIL(&user_iter->conference->waiting_list, user_iter, list);
114                                 user_iter->conference->waitingusers++;
115
116                                 /* Handle moh of user_iter if necessary */
117                                 if (ast_test_flag(&user_iter->u_profile, USER_OPT_MUSICONHOLD)) {
118                                         conf_moh_start(user_iter);
119                                 }
120                                 conf_update_user_mute(user_iter);
121                         }
122                 }
123                 AST_LIST_TRAVERSE_SAFE_END;
124         }
125
126         switch (user->conference->activeusers) {
127         case 0:
128                 /* Implies markedusers == 0 */
129                 switch (user->conference->waitingusers) {
130                 case 0:
131                         conf_change_state(user, CONF_STATE_EMPTY);
132                         break;
133                 default:
134                         conf_change_state(user, CONF_STATE_INACTIVE);
135                         break;
136                 }
137                 break;
138         case 1:
139                 switch (user->conference->markedusers) {
140                 case 0:
141                         conf_change_state(user, CONF_STATE_SINGLE);
142                         break;
143                 case 1:
144                         /* XXX I seem to remember doing this for a reason, but right now it escapes me
145                          * how we could possibly ever have a waiting user while we have a marked user */
146                         switch (user->conference->waitingusers) {
147                         case 0:
148                                 conf_change_state(user, CONF_STATE_SINGLE_MARKED);
149                                 break;
150                         case 1:
151                                 break; /* Stay in marked */
152                         }
153                         break;
154                 }
155                 break;
156         default:
157                 switch (user->conference->markedusers) {
158                 case 0:
159                         conf_change_state(user, CONF_STATE_MULTI);
160                         break;
161                 default:
162                         break; /* Stay in marked */
163                 }
164         }
165 }
166
167 static void transition_to_marked(struct confbridge_user *user)
168 {
169         struct confbridge_user *user_iter;
170
171         /* Play the audio file stating they are going to be placed into the conference */
172         if (user->conference->markedusers == 1 && ast_test_flag(&user->u_profile, USER_OPT_MARKEDUSER)) {
173                 conf_handle_first_marked_common(user);
174         }
175
176         /* Move all waiting users to active, stopping MOH and unmuting if necessary */
177         AST_LIST_TRAVERSE_SAFE_BEGIN(&user->conference->waiting_list, user_iter, list) {
178                 AST_LIST_REMOVE_CURRENT(list);
179                 user->conference->waitingusers--;
180                 AST_LIST_INSERT_TAIL(&user->conference->active_list, user_iter, list);
181                 user->conference->activeusers++;
182                 if (user_iter->playing_moh) {
183                         conf_moh_stop(user_iter);
184                 }
185                 conf_update_user_mute(user_iter);
186         }
187         AST_LIST_TRAVERSE_SAFE_END;
188 }