Remove dead code from features.c; refactor pickup code into pickup.c
[asterisk/asterisk.git] / res / stasis / control.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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 Stasis application control support.
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include "asterisk/stasis_channels.h"
31
32 #include "command.h"
33 #include "control.h"
34 #include "asterisk/dial.h"
35 #include "asterisk/bridge.h"
36 #include "asterisk/bridge_basic.h"
37 #include "asterisk/frame.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/musiconhold.h"
40
41 struct stasis_app_control {
42         /*! Queue of commands to dispatch on the channel */
43         struct ao2_container *command_queue;
44         /*!
45          * When set, /c app_stasis should exit and continue in the dialplan.
46          */
47         int is_done:1;
48         /*!
49          * The associated channel.
50          * Be very careful with the threading associated w/ manipulating
51          * the channel.
52          */
53         struct ast_channel *channel;
54 };
55
56 struct stasis_app_control *control_create(struct ast_channel *channel)
57 {
58         struct stasis_app_control *control;
59
60         control = ao2_alloc(sizeof(*control), NULL);
61         if (!control) {
62                 return NULL;
63         }
64
65         control->command_queue = ao2_container_alloc_list(
66                 AO2_ALLOC_OPT_LOCK_MUTEX, 0, NULL, NULL);
67
68         if (!control->command_queue) {
69                 ao2_cleanup(control);
70                 return NULL;
71         }
72
73         control->channel = channel;
74
75         return control;
76 }
77
78 static struct stasis_app_command *exec_command(
79         struct stasis_app_control *control, stasis_app_command_cb command_fn,
80         void *data)
81 {
82         RAII_VAR(struct stasis_app_command *, command, NULL, ao2_cleanup);
83
84         command = command_create(command_fn, data);
85
86         if (!command) {
87                 return NULL;
88         }
89
90         /* command_queue is a thread safe list; no lock needed */
91         ao2_link(control->command_queue, command);
92
93         ao2_ref(command, +1);
94         return command;
95 }
96
97 struct stasis_app_control_dial_data {
98         char endpoint[AST_CHANNEL_NAME];
99         int timeout;
100 };
101
102 static void *app_control_dial(struct stasis_app_control *control,
103         struct ast_channel *chan, void *data)
104 {
105         RAII_VAR(struct ast_dial *, dial, ast_dial_create(), ast_dial_destroy);
106         RAII_VAR(struct stasis_app_control_dial_data *, dial_data, data, ast_free);
107         enum ast_dial_result res;
108         char *tech, *resource;
109
110         struct ast_channel *new_chan;
111         struct ast_bridge *bridge;
112
113         tech = dial_data->endpoint;
114         if (!(resource = strchr(tech, '/'))) {
115                 return NULL;
116         }
117         *resource++ = '\0';
118
119         if (!dial) {
120                 ast_log(LOG_ERROR, "Failed to create dialing structure.\n");
121                 return NULL;
122         }
123
124         if (ast_dial_append(dial, tech, resource) < 0) {
125                 ast_log(LOG_ERROR, "Failed to add %s/%s to dialing structure.\n", tech, resource);
126                 return NULL;
127         }
128
129         ast_dial_set_global_timeout(dial, dial_data->timeout);
130
131         res = ast_dial_run(dial, NULL, 0);
132
133         if (res != AST_DIAL_RESULT_ANSWERED || !(new_chan = ast_dial_answered_steal(dial))) {
134                 return NULL;
135         }
136
137         if (!(bridge = ast_bridge_basic_new())) {
138                 ast_log(LOG_ERROR, "Failed to create basic bridge.\n");
139                 return NULL;
140         }
141
142         ast_bridge_impart(bridge, new_chan, NULL, NULL, 1);
143         stasis_app_control_add_channel_to_bridge(control, bridge);
144
145         return NULL;
146 }
147
148 int stasis_app_control_dial(struct stasis_app_control *control, const char *endpoint, int timeout)
149 {
150         struct stasis_app_control_dial_data *dial_data;
151
152         if (!(dial_data = ast_calloc(1, sizeof(*dial_data)))) {
153                 return -1;
154         }
155
156         ast_copy_string(dial_data->endpoint, endpoint, sizeof(dial_data->endpoint));
157
158         if (timeout > 0) {
159                 dial_data->timeout = timeout * 1000;
160         } else if (timeout == -1) {
161                 dial_data->timeout = -1;
162         } else {
163                 dial_data->timeout = 30000;
164         }
165
166         stasis_app_send_command_async(control, app_control_dial, dial_data);
167
168         return 0;
169 }
170
171 int control_is_done(struct stasis_app_control *control)
172 {
173         /* Called from stasis_app_exec thread; no lock needed */
174         return control->is_done;
175 }
176
177 struct stasis_app_control_continue_data {
178         char context[AST_MAX_CONTEXT];
179         char extension[AST_MAX_EXTENSION];
180         int priority;
181 };
182
183 static void *app_control_continue(struct stasis_app_control *control,
184         struct ast_channel *chan, void *data)
185 {
186         RAII_VAR(struct stasis_app_control_continue_data *, continue_data, data, ast_free);
187
188         /* Called from stasis_app_exec thread; no lock needed */
189         ast_explicit_goto(control->channel, continue_data->context, continue_data->extension, continue_data->priority);
190
191         control->is_done = 1;
192
193         return NULL;
194 }
195
196 int stasis_app_control_continue(struct stasis_app_control *control, const char *context, const char *extension, int priority)
197 {
198         struct stasis_app_control_continue_data *continue_data;
199
200         if (!(continue_data = ast_calloc(1, sizeof(*continue_data)))) {
201                 return -1;
202         }
203         ast_copy_string(continue_data->context, S_OR(context, ""), sizeof(continue_data->context));
204         ast_copy_string(continue_data->extension, S_OR(extension, ""), sizeof(continue_data->extension));
205         if (priority > 0) {
206                 continue_data->priority = priority;
207         } else {
208                 continue_data->priority = -1;
209         }
210
211         stasis_app_send_command_async(control, app_control_continue, continue_data);
212
213         return 0;
214 }
215
216 struct stasis_app_control_mute_data {
217         enum ast_frame_type frametype;
218         unsigned int direction;
219 };
220
221 static void *app_control_mute(struct stasis_app_control *control,
222         struct ast_channel *chan, void *data)
223 {
224         RAII_VAR(struct stasis_app_control_mute_data *, mute_data, data, ast_free);
225         SCOPED_CHANNELLOCK(lockvar, chan);
226
227         ast_channel_suppress(control->channel, mute_data->direction, mute_data->frametype);
228
229         return NULL;
230 }
231
232 int stasis_app_control_mute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype)
233 {
234         struct stasis_app_control_mute_data *mute_data;
235
236         if (!(mute_data = ast_calloc(1, sizeof(*mute_data)))) {
237                 return -1;
238         }
239
240         mute_data->direction = direction;
241         mute_data->frametype = frametype;
242
243         stasis_app_send_command_async(control, app_control_mute, mute_data);
244
245         return 0;
246 }
247
248 static void *app_control_unmute(struct stasis_app_control *control,
249         struct ast_channel *chan, void *data)
250 {
251         RAII_VAR(struct stasis_app_control_mute_data *, mute_data, data, ast_free);
252         SCOPED_CHANNELLOCK(lockvar, chan);
253
254         ast_channel_unsuppress(control->channel, mute_data->direction, mute_data->frametype);
255
256         return NULL;
257 }
258
259 int stasis_app_control_unmute(struct stasis_app_control *control, unsigned int direction, enum ast_frame_type frametype)
260 {
261         struct stasis_app_control_mute_data *mute_data;
262
263         if (!(mute_data = ast_calloc(1, sizeof(*mute_data)))) {
264                 return -1;
265         }
266
267         mute_data->direction = direction;
268         mute_data->frametype = frametype;
269
270         stasis_app_send_command_async(control, app_control_unmute, mute_data);
271
272         return 0;
273 }
274
275 char *stasis_app_control_get_channel_var(struct stasis_app_control *control, const char *variable)
276 {
277         RAII_VAR(struct ast_str *, tmp, ast_str_create(32), ast_free);
278         SCOPED_CHANNELLOCK(lockvar, control->channel);
279
280         if (!tmp) {
281                 return NULL;
282         }
283
284         if (variable[strlen(variable) - 1] == ')') {
285                 if (ast_func_read2(control->channel, variable, &tmp, 0)) {
286                         return NULL;
287                 }
288         } else {
289                 if (!ast_str_retrieve_variable(&tmp, 0, control->channel, NULL, variable)) {
290                         return NULL;
291                 }
292         }
293
294         return ast_strdup(ast_str_buffer(tmp));
295 }
296
297 int stasis_app_control_set_channel_var(struct stasis_app_control *control, const char *variable, const char *value)
298 {
299         return pbx_builtin_setvar_helper(control->channel, variable, value);
300 }
301
302 static void *app_control_hold(struct stasis_app_control *control,
303         struct ast_channel *chan, void *data)
304 {
305         ast_indicate(control->channel, AST_CONTROL_HOLD);
306
307         return NULL;
308 }
309
310 void stasis_app_control_hold(struct stasis_app_control *control)
311 {
312         stasis_app_send_command_async(control, app_control_hold, NULL);
313 }
314
315 static void *app_control_unhold(struct stasis_app_control *control,
316         struct ast_channel *chan, void *data)
317 {
318         ast_indicate(control->channel, AST_CONTROL_UNHOLD);
319
320         return NULL;
321 }
322
323 void stasis_app_control_unhold(struct stasis_app_control *control)
324 {
325         stasis_app_send_command_async(control, app_control_unhold, NULL);
326 }
327
328 static void *app_control_moh_start(struct stasis_app_control *control,
329         struct ast_channel *chan, void *data)
330 {
331         char *moh_class = data;
332
333         ast_moh_start(chan, moh_class, NULL);
334
335         ast_free(moh_class);
336         return NULL;
337 }
338
339 void stasis_app_control_moh_start(struct stasis_app_control *control, const char *moh_class)
340 {
341         char *data = NULL;
342
343         if (!ast_strlen_zero(moh_class)) {
344                 data = ast_strdup(moh_class);
345         }
346
347         stasis_app_send_command_async(control, app_control_moh_start, data);
348 }
349
350 static void *app_control_moh_stop(struct stasis_app_control *control,
351         struct ast_channel *chan, void *data)
352 {
353         ast_moh_stop(chan);
354         return NULL;
355 }
356
357 void stasis_app_control_moh_stop(struct stasis_app_control *control)
358 {
359         stasis_app_send_command_async(control, app_control_moh_stop, NULL);
360 }
361
362 struct ast_channel_snapshot *stasis_app_control_get_snapshot(
363         const struct stasis_app_control *control)
364 {
365         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
366         struct ast_channel_snapshot *snapshot;
367
368         msg = stasis_cache_get(ast_channel_cache(), ast_channel_snapshot_type(),
369                 stasis_app_control_get_channel_id(control));
370         if (!msg) {
371                 return NULL;
372         }
373
374         snapshot = stasis_message_data(msg);
375         ast_assert(snapshot != NULL);
376
377         ao2_ref(snapshot, +1);
378         return snapshot;
379 }
380
381 void *stasis_app_send_command(struct stasis_app_control *control,
382         stasis_app_command_cb command_fn, void *data)
383 {
384         RAII_VAR(struct stasis_app_command *, command, NULL, ao2_cleanup);
385
386         if (control == NULL) {
387                 return NULL;
388         }
389
390         command = exec_command(control, command_fn, data);
391         if (!command) {
392                 return NULL;
393         }
394
395         return command_join(command);
396 }
397
398 int stasis_app_send_command_async(struct stasis_app_control *control,
399         stasis_app_command_cb command_fn, void *data)
400 {
401         RAII_VAR(struct stasis_app_command *, command, NULL, ao2_cleanup);
402
403         if (control == NULL) {
404                 return -1;
405         }
406
407         command = exec_command(control, command_fn, data);
408         if (!command) {
409                 return -1;
410         }
411
412         return 0;
413 }
414
415 const char *stasis_app_control_get_channel_id(
416         const struct stasis_app_control *control)
417 {
418         return ast_channel_uniqueid(control->channel);
419 }
420
421 void stasis_app_control_publish(
422         struct stasis_app_control *control, struct stasis_message *message)
423 {
424         if (!control || !control->channel || !message) {
425                 return;
426         }
427         stasis_publish(ast_channel_topic(control->channel), message);
428 }
429
430 int stasis_app_control_queue_control(struct stasis_app_control *control,
431         enum ast_control_frame_type frame_type)
432 {
433         return ast_queue_control(control->channel, frame_type);
434 }
435
436 int control_dispatch_all(struct stasis_app_control *control,
437         struct ast_channel *chan)
438 {
439         int count = 0;
440         struct ao2_iterator i;
441         void *obj;
442
443         ast_assert(control->channel == chan);
444
445         i = ao2_iterator_init(control->command_queue, AO2_ITERATOR_UNLINK);
446
447         while ((obj = ao2_iterator_next(&i))) {
448                 RAII_VAR(struct stasis_app_command *, command, obj, ao2_cleanup);
449                 command_invoke(command, control, chan);
450                 ++count;
451         }
452
453         ao2_iterator_destroy(&i);
454         return count;
455 }
456
457 /* Must be defined here since it must operate on the channel outside of the queue */
458 int stasis_app_control_remove_channel_from_bridge(
459         struct stasis_app_control *control, struct ast_bridge *bridge)
460 {
461         return ast_bridge_remove(bridge, control->channel);
462 }