Asterisk - The Open Source Telephony Project  21.4.1
conf_state_multi_marked.c
Go to the documentation of this file.
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 
19 /*! \file
20  *
21  * \brief Confbridge state handling for the MULTI_MARKED state
22  *
23  * \author\verbatim Terry Wilson <twilson@digium.com> \endverbatim
24  *
25  * \ingroup applications
26  */
27 
28 /*** MODULEINFO
29  <support_level>core</support_level>
30  ***/
31 
32 #include "asterisk.h"
33 #include "asterisk/utils.h"
34 #include "asterisk/linkedlists.h"
35 #include "include/confbridge.h"
36 #include "asterisk/musiconhold.h"
37 #include "include/conf_state.h"
38 #include "asterisk/pbx.h"
39 
40 static void join_active(struct confbridge_user *user);
41 static void join_marked(struct confbridge_user *user);
42 static void leave_active(struct confbridge_user *user);
43 static void leave_marked(struct confbridge_user *user);
44 static void transition_to_marked(struct confbridge_user *user);
45 
46 static struct confbridge_state STATE_MULTI_MARKED = {
47  .name = "MULTI_MARKED",
48  .join_unmarked = join_active,
49  .join_waitmarked = join_active,
50  .join_marked = join_marked,
51  .leave_unmarked = leave_active,
52  .leave_waitmarked = leave_active,
53  .leave_marked = leave_marked,
54  .entry = transition_to_marked,
55 };
56 struct confbridge_state *CONF_STATE_MULTI_MARKED = &STATE_MULTI_MARKED;
57 
58 static void join_active(struct confbridge_user *user)
59 {
60  conf_add_user_active(user->conference, user);
62 }
63 
64 static void join_marked(struct confbridge_user *user)
65 {
66  conf_add_user_marked(user->conference, user);
68 }
69 
70 static void leave_active(struct confbridge_user *user)
71 {
73  if (user->conference->activeusers == 1) {
75  }
76 }
77 
78 static void leave_marked(struct confbridge_user *user)
79 {
80  struct confbridge_user *user_iter;
81  int need_prompt = 0;
82 
84 
85  /* If all marked users have left, or we're set to kick if any marked user leaves, then boot everyone */
87  if (user->conference->markedusers > 0 && !ast_test_flag(&user_iter->u_profile, USER_OPT_ENDMARKEDANY)) {
88  continue;
89  }
90  /* Kick ENDMARKED cbu_iters */
91  if ((ast_test_flag(&user_iter->u_profile, USER_OPT_ENDMARKED) || ast_test_flag(&user_iter->u_profile, USER_OPT_ENDMARKEDANY)) && !user_iter->kicked) {
92  if (ast_test_flag(&user_iter->u_profile, USER_OPT_WAITMARKED)
93  && (!ast_test_flag(&user_iter->u_profile, USER_OPT_MARKEDUSER) || ast_test_flag(&user_iter->u_profile, USER_OPT_ENDMARKEDANY))) {
95  user_iter->conference->activeusers--;
96  AST_LIST_INSERT_TAIL(&user_iter->conference->waiting_list, user_iter, list);
97  user_iter->conference->waitingusers++;
98  }
99  user_iter->kicked = 1;
100  pbx_builtin_setvar_helper(user_iter->chan, "CONFBRIDGE_RESULT", "ENDMARKED");
101  ast_bridge_remove(user_iter->conference->bridge, user_iter->chan);
102  } else if (ast_test_flag(&user_iter->u_profile, USER_OPT_WAITMARKED)
103  && !ast_test_flag(&user_iter->u_profile, USER_OPT_MARKEDUSER)) {
104  need_prompt = 1;
105 
107  user_iter->conference->activeusers--;
108  AST_LIST_INSERT_TAIL(&user_iter->conference->waiting_list, user_iter, list);
109  user_iter->conference->waitingusers++;
110  } else {
111  /* User is neither wait_marked nor end_marked nor end_marked_any; however, they
112  * should still hear the prompt.
113  */
114  need_prompt = 1;
115  }
116  }
118 
119  switch (user->conference->activeusers) {
120  case 0:
121  /* Implies markedusers == 0 */
122  switch (user->conference->waitingusers) {
123  case 0:
125  break;
126  default:
128  break;
129  }
130  break;
131  case 1:
132  switch (user->conference->markedusers) {
133  case 0:
135  break;
136  case 1:
137  /* XXX I seem to remember doing this for a reason, but right now it escapes me
138  * how we could possibly ever have a waiting user while we have a marked user */
139  switch (user->conference->waitingusers) {
140  case 0:
142  break;
143  case 1:
144  break; /* Stay in marked */
145  }
146  break;
147  }
148  break;
149  default:
150  switch (user->conference->markedusers) {
151  case 0:
153  break;
154  default:
155  break; /* Stay in marked */
156  }
157  }
158 
159  if (need_prompt) {
160  /* Play back the audio prompt saying the leader has left the conference */
161  if (!ast_test_flag(&user->u_profile, USER_OPT_QUIET)) {
163  conf_get_sound(CONF_SOUND_LEADER_HAS_LEFT, user->conference->b_profile.sounds),
164  NULL);
165  }
166 
167  AST_LIST_TRAVERSE(&user->conference->waiting_list, user_iter, list) {
168  if (user_iter->kicked) {
169  continue;
170  }
171 
172  if (ast_test_flag(&user_iter->u_profile, USER_OPT_MUSICONHOLD)) {
173  conf_moh_start(user_iter);
174  }
175 
176  conf_update_user_mute(user_iter);
177  }
178  }
179 }
180 
181 static int post_join_play_begin(struct confbridge_user *user)
182 {
183  int res;
184 
186  res = play_sound_file(user->conference,
187  conf_get_sound(CONF_SOUND_BEGIN, user->conference->b_profile.sounds));
188  ast_autoservice_stop(user->chan);
189  return res;
190 }
191 
192 static void transition_to_marked(struct confbridge_user *user)
193 {
194  struct confbridge_user *user_iter;
195  int waitmarked_moved = 0;
196 
197  /* Move all waiting users to active, stopping MOH and unmuting if necessary */
200  user->conference->waitingusers--;
201  AST_LIST_INSERT_TAIL(&user->conference->active_list, user_iter, list);
202  user->conference->activeusers++;
203  if (user_iter->playing_moh) {
204  conf_moh_stop(user_iter);
205  }
206  conf_update_user_mute(user_iter);
207  waitmarked_moved++;
208  }
210 
211  /* Play the audio file stating that the conference is beginning */
212  if (user->conference->markedusers == 1
213  && ast_test_flag(&user->u_profile, USER_OPT_MARKEDUSER)
214  && !ast_test_flag(&user->u_profile, USER_OPT_QUIET)
215  && waitmarked_moved) {
216  conf_add_post_join_action(user, post_join_play_begin);
217  }
218 }
void conf_remove_user_marked(struct confbridge_conference *conference, struct confbridge_user *user)
Remove a conference bridge user from the marked active conference users in the conference.
void conf_add_user_active(struct confbridge_conference *conference, struct confbridge_user *user)
Add a conference bridge user as an unmarked active user of the conference.
int ast_bridge_remove(struct ast_bridge *bridge, struct ast_channel *chan)
Remove a channel from a bridge.
Definition: bridge.c:1951
Music on hold handling.
int conf_add_post_join_action(struct confbridge_user *user, int(*func)(struct confbridge_user *user))
Queue a function to run with the given conference bridge user as an argument once the state transitio...
struct confbridge_state * CONF_STATE_MULTI
Conference state with multiple active users, but no marked users.
Asterisk main include file. File version handling, generic pbx functions.
void conf_remove_user_active(struct confbridge_conference *conference, struct confbridge_user *user)
Remove a conference bridge user from the unmarked active conference users in the conference.
int ast_autoservice_start(struct ast_channel *chan)
Automatically service a channel for us...
Definition: autoservice.c:200
struct ast_channel * chan
Definition: confbridge.h:279
unsigned int playing_moh
Definition: confbridge.h:285
struct confbridge_conference * conference
Definition: confbridge.h:274
const char * conf_get_sound(enum conf_sounds sound, struct bridge_profile_sounds *custom_sounds)
Looks to see if sound file is stored in bridge profile sounds, if not default sound is provided...
void conf_update_user_mute(struct confbridge_user *user)
Update the actual mute status of the user and set it on the bridge.
struct confbridge_state * CONF_STATE_EMPTY
Conference state with no active or waiting users.
struct confbridge_user::@94 list
void conf_add_user_marked(struct confbridge_conference *conference, struct confbridge_user *user)
Add a conference bridge user as a marked active user of the conference.
unsigned int markedusers
Definition: confbridge.h:252
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition: linkedlists.h:615
conference_event_fn join_marked
Definition: conf_state.h:49
struct confbridge_conference::@90 active_list
Utility functions.
struct bridge_profile b_profile
Definition: confbridge.h:250
struct confbridge_state * CONF_STATE_SINGLE_MARKED
Conference state with only a single marked active user.
unsigned int waitingusers
Definition: confbridge.h:253
conference_event_fn leave_marked
Definition: conf_state.h:52
int async_play_sound_file(struct confbridge_conference *conference, const char *filename, struct ast_channel *initiator)
Play sound file into conference bridge asynchronously.
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
Definition: linkedlists.h:557
A set of macros to manage forward-linked lists.
Core PBX routines and definitions.
int ast_autoservice_stop(struct ast_channel *chan)
Stop servicing a channel for us...
Definition: autoservice.c:266
void conf_moh_start(struct confbridge_user *user)
Start MOH for the conference user.
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
struct confbridge_state * CONF_STATE_SINGLE
Conference state with only a single unmarked active user.
void conf_moh_stop(struct confbridge_user *user)
Stop MOH for the conference user.
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
unsigned int activeusers
Definition: confbridge.h:251
structure to hold users read from users.conf
Confbridge state handling.
A conference state object to hold the various state callback functions.
Definition: conf_state.h:45
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name...
struct confbridge_state * CONF_STATE_INACTIVE
Conference state with only waiting users.
The structure that represents a conference bridge user.
Definition: confbridge.h:273
struct confbridge_conference::@91 waiting_list
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition: linkedlists.h:529
int play_sound_file(struct confbridge_conference *conference, const char *filename)
Play sound file into conference bridge.
struct user_profile u_profile
Definition: confbridge.h:276
struct confbridge_state * CONF_STATE_MULTI_MARKED
Conference state with multiple active users and at least one marked user.
unsigned int kicked
Definition: confbridge.h:284
void conf_change_state(struct confbridge_user *user, struct confbridge_state *newstate)
Execute conference state transition because of a user action.
Definition: conf_state.c:77
struct ast_bridge * bridge
Definition: confbridge.h:249