Fix documentation replication issues
[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 }
64
65 static void join_marked(struct confbridge_user *user)
66 {
67         conf_add_user_marked(user->conference, user);
68 }
69
70 static void leave_active(struct confbridge_user *user)
71 {
72         conf_remove_user_active(user->conference, user);
73         if (user->conference->activeusers == 1) {
74                 conf_change_state(user, CONF_STATE_SINGLE_MARKED);
75         }
76 }
77
78 static void leave_marked(struct confbridge_user *user)
79 {
80         struct confbridge_user *user_iter;
81
82         conf_remove_user_marked(user->conference, user);
83
84         if (user->conference->markedusers == 0) {
85                 /* Play back the audio prompt saying the leader has left the conference */
86                 if (!ast_test_flag(&user->u_profile, USER_OPT_QUIET)) {
87                         ao2_unlock(user->conference);
88                         ast_autoservice_start(user->chan);
89                         play_sound_file(user->conference,
90                                 conf_get_sound(CONF_SOUND_LEADER_HAS_LEFT, user->b_profile.sounds));
91                         ast_autoservice_stop(user->chan);
92                         ao2_lock(user->conference);
93                 }
94
95                 AST_LIST_TRAVERSE_SAFE_BEGIN(&user->conference->active_list, user_iter, list) {
96                         /* Kick ENDMARKED cbu_iters */
97                         if (ast_test_flag(&user_iter->u_profile, USER_OPT_ENDMARKED)) {
98                                 user_iter->kicked = 1;
99                                 ast_bridge_remove(user_iter->conference->bridge, user_iter->chan);
100                         } else 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                                 /* Handle muting/moh of user_iter if necessary */
107                                 if (ast_test_flag(&user_iter->u_profile, USER_OPT_MUSICONHOLD)) {
108                                         user_iter->features.mute = 1;
109                                         conf_moh_start(user_iter);
110                                 }
111                         }
112                 }
113                 AST_LIST_TRAVERSE_SAFE_END;
114         }
115
116         switch (user->conference->activeusers) {
117         case 0:
118                 /* Implies markedusers == 0 */
119                 switch (user->conference->waitingusers) {
120                 case 0:
121                         conf_change_state(user, CONF_STATE_EMPTY);
122                         break;
123                 default:
124                         conf_change_state(user, CONF_STATE_INACTIVE);
125                         break;
126                 }
127                 break;
128         case 1:
129                 switch (user->conference->markedusers) {
130                 case 0:
131                         conf_change_state(user, CONF_STATE_SINGLE);
132                         break;
133                 case 1:
134                         /* XXX I seem to remember doing this for a reason, but right now it escapes me
135                          * how we could possibly ever have a waiting user while we have a marked user */
136                         switch (user->conference->waitingusers) {
137                         case 0:
138                                 conf_change_state(user, CONF_STATE_SINGLE_MARKED);
139                                 break;
140                         case 1:
141                                 break; /* Stay in marked */
142                         }
143                         break;
144                 }
145                 break;
146         default:
147                 switch (user->conference->markedusers) {
148                 case 0:
149                         conf_change_state(user, CONF_STATE_MULTI);
150                         break;
151                 default:
152                         break; /* Stay in marked */
153                 }
154         }
155 }
156
157 static void transition_to_marked(struct confbridge_user *user)
158 {
159         struct confbridge_user *user_iter;
160
161         /* Play the audio file stating they are going to be placed into the conference */
162         if (user->conference->markedusers == 1 && ast_test_flag(&user->u_profile, USER_OPT_MARKEDUSER)) {
163                 conf_handle_first_marked_common(user);
164         }
165
166         /* Move all waiting users to active, stopping MOH and umuting if necessary */
167         AST_LIST_TRAVERSE_SAFE_BEGIN(&user->conference->waiting_list, user_iter, list) {
168                 AST_LIST_REMOVE_CURRENT(list);
169                 user->conference->waitingusers--;
170                 AST_LIST_INSERT_TAIL(&user->conference->active_list, user_iter, list);
171                 user->conference->activeusers++;
172                 if (user_iter->playing_moh) {
173                         conf_moh_stop(user_iter);
174                 }
175                 /* only unmute them if they are not supposed to start muted */
176                 if (!ast_test_flag(&user_iter->u_profile, USER_OPT_STARTMUTED)) {
177                         user_iter->features.mute = 0;
178                 }
179         }
180         AST_LIST_TRAVERSE_SAFE_END;
181 }