res_srtp: Add support for libsrtp2.1.
[asterisk/asterisk.git] / res / res_stasis.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 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 support.
22  *
23  * \author David M. Lee, II <dlee@digium.com>
24  *
25  * <code>res_stasis.so</code> brings together the various components of the
26  * Stasis application infrastructure.
27  *
28  * First, there's the Stasis application handler, stasis_app_exec(). This is
29  * called by <code>app_stasis.so</code> to give control of a channel to the
30  * Stasis application code from the dialplan.
31  *
32  * While a channel is in stasis_app_exec(), it has a \ref stasis_app_control
33  * object, which may be used to control the channel.
34  *
35  * To control the channel, commands may be sent to channel using
36  * stasis_app_send_command() and stasis_app_send_async_command().
37  *
38  * Alongside this, applications may be registered/unregistered using
39  * stasis_app_register()/stasis_app_unregister(). While a channel is in Stasis,
40  * events received on the channel's topic are converted to JSON and forwarded to
41  * the \ref stasis_app_cb. The application may also subscribe to the channel to
42  * continue to receive messages even after the channel has left Stasis, but it
43  * will not be able to control it.
44  *
45  * Given all the stuff that comes together in this module, it's been broken up
46  * into several pieces that are in <code>res/stasis/</code> and compiled into
47  * <code>res_stasis.so</code>.
48  */
49
50 /*** MODULEINFO
51         <support_level>core</support_level>
52  ***/
53
54 #include "asterisk.h"
55
56 #include "asterisk/astobj2.h"
57 #include "asterisk/callerid.h"
58 #include "asterisk/module.h"
59 #include "asterisk/stasis_app_impl.h"
60 #include "asterisk/stasis_channels.h"
61 #include "asterisk/stasis_bridges.h"
62 #include "asterisk/stasis_endpoints.h"
63 #include "asterisk/stasis_message_router.h"
64 #include "asterisk/strings.h"
65 #include "stasis/app.h"
66 #include "stasis/control.h"
67 #include "stasis/messaging.h"
68 #include "stasis/stasis_bridge.h"
69 #include "asterisk/core_unreal.h"
70 #include "asterisk/musiconhold.h"
71 #include "asterisk/causes.h"
72 #include "asterisk/stringfields.h"
73 #include "asterisk/bridge_after.h"
74 #include "asterisk/format_cache.h"
75
76 /*! Time to wait for a frame in the application */
77 #define MAX_WAIT_MS 200
78
79 /*!
80  * \brief Number of buckets for the Stasis application hash table.  Remember to
81  * keep it a prime number!
82  */
83 #define APPS_NUM_BUCKETS 127
84
85 /*!
86  * \brief Number of buckets for the Stasis application hash table.  Remember to
87  * keep it a prime number!
88  */
89 #define CONTROLS_NUM_BUCKETS 127
90
91 /*!
92  * \brief Number of buckets for the Stasis bridges hash table.  Remember to
93  * keep it a prime number!
94  */
95 #define BRIDGES_NUM_BUCKETS 127
96
97 /*!
98  * \brief Stasis application container.
99  */
100 struct ao2_container *apps_registry;
101
102 struct ao2_container *app_controls;
103
104 struct ao2_container *app_bridges;
105
106 struct ao2_container *app_bridges_moh;
107
108 struct ao2_container *app_bridges_playback;
109
110 /*!
111  * \internal \brief List of registered event sources.
112  */
113 AST_RWLIST_HEAD_STATIC(event_sources, stasis_app_event_source);
114
115 static struct ast_json *stasis_end_to_json(struct stasis_message *message,
116                 const struct stasis_message_sanitizer *sanitize)
117 {
118         struct ast_channel_blob *payload = stasis_message_data(message);
119
120         if (sanitize && sanitize->channel_snapshot &&
121                         sanitize->channel_snapshot(payload->snapshot)) {
122                 return NULL;
123         }
124
125         return ast_json_pack("{s: s, s: o, s: o}",
126                 "type", "StasisEnd",
127                 "timestamp", ast_json_timeval(ast_tvnow(), NULL),
128                 "channel", ast_channel_snapshot_to_json(payload->snapshot, sanitize));
129 }
130
131 STASIS_MESSAGE_TYPE_DEFN_LOCAL(end_message_type,
132         .to_json = stasis_end_to_json);
133
134 struct start_message_blob {
135         struct ast_channel_snapshot *channel;           /*!< Channel that is entering Stasis() */
136         struct ast_channel_snapshot *replace_channel;   /*!< Channel that is being replaced (optional) */
137         struct ast_json *blob;                          /*!< JSON blob containing timestamp and args */
138 };
139
140 static struct ast_json *stasis_start_to_json(struct stasis_message *message,
141                 const struct stasis_message_sanitizer *sanitize)
142 {
143         struct start_message_blob *payload = stasis_message_data(message);
144         struct ast_json *msg;
145
146         if (sanitize && sanitize->channel_snapshot &&
147                         sanitize->channel_snapshot(payload->channel)) {
148                 return NULL;
149         }
150
151         msg = ast_json_pack("{s: s, s: o, s: o, s: o}",
152                 "type", "StasisStart",
153                 "timestamp", ast_json_copy(ast_json_object_get(payload->blob, "timestamp")),
154                 "args", ast_json_deep_copy(ast_json_object_get(payload->blob, "args")),
155                 "channel", ast_channel_snapshot_to_json(payload->channel, NULL));
156         if (!msg) {
157                 ast_log(LOG_ERROR, "Failed to pack JSON for StasisStart message\n");
158                 return NULL;
159         }
160
161         if (payload->replace_channel) {
162                 int res = ast_json_object_set(msg, "replace_channel",
163                         ast_channel_snapshot_to_json(payload->replace_channel, NULL));
164
165                 if (res) {
166                         ast_json_unref(msg);
167                         ast_log(LOG_ERROR, "Failed to append JSON for StasisStart message\n");
168                         return NULL;
169                 }
170         }
171
172         return msg;
173 }
174
175 STASIS_MESSAGE_TYPE_DEFN_LOCAL(start_message_type,
176         .to_json = stasis_start_to_json);
177
178 /*! AO2 hash function for \ref app */
179 static int app_hash(const void *obj, const int flags)
180 {
181         const struct stasis_app *app;
182         const char *key;
183
184         switch (flags & OBJ_SEARCH_MASK) {
185         case OBJ_SEARCH_KEY:
186                 key = obj;
187                 break;
188         case OBJ_SEARCH_OBJECT:
189                 app = obj;
190                 key = stasis_app_name(app);
191                 break;
192         default:
193                 /* Hash can only work on something with a full key. */
194                 ast_assert(0);
195                 return 0;
196         }
197         return ast_str_hash(key);
198 }
199
200 /*! AO2 comparison function for \ref app */
201 static int app_compare(void *obj, void *arg, int flags)
202 {
203         const struct stasis_app *object_left = obj;
204         const struct stasis_app *object_right = arg;
205         const char *right_key = arg;
206         int cmp;
207
208         switch (flags & OBJ_SEARCH_MASK) {
209         case OBJ_SEARCH_OBJECT:
210                 right_key = stasis_app_name(object_right);
211                 /* Fall through */
212         case OBJ_SEARCH_KEY:
213                 cmp = strcmp(stasis_app_name(object_left), right_key);
214                 break;
215         case OBJ_SEARCH_PARTIAL_KEY:
216                 /*
217                  * We could also use a partial key struct containing a length
218                  * so strlen() does not get called for every comparison instead.
219                  */
220                 cmp = strncmp(stasis_app_name(object_left), right_key, strlen(right_key));
221                 break;
222         default:
223                 /*
224                  * What arg points to is specific to this traversal callback
225                  * and has no special meaning to astobj2.
226                  */
227                 cmp = 0;
228                 break;
229         }
230         if (cmp) {
231                 return 0;
232         }
233         /*
234          * At this point the traversal callback is identical to a sorted
235          * container.
236          */
237         return CMP_MATCH;
238 }
239
240 /*! AO2 hash function for \ref stasis_app_control */
241 static int control_hash(const void *obj, const int flags)
242 {
243         const struct stasis_app_control *control;
244         const char *key;
245
246         switch (flags & OBJ_SEARCH_MASK) {
247         case OBJ_SEARCH_KEY:
248                 key = obj;
249                 break;
250         case OBJ_SEARCH_OBJECT:
251                 control = obj;
252                 key = stasis_app_control_get_channel_id(control);
253                 break;
254         default:
255                 /* Hash can only work on something with a full key. */
256                 ast_assert(0);
257                 return 0;
258         }
259         return ast_str_hash(key);
260 }
261
262 /*! AO2 comparison function for \ref stasis_app_control */
263 static int control_compare(void *obj, void *arg, int flags)
264 {
265         const struct stasis_app_control *object_left = obj;
266         const struct stasis_app_control *object_right = arg;
267         const char *right_key = arg;
268         int cmp;
269
270         switch (flags & OBJ_SEARCH_MASK) {
271         case OBJ_SEARCH_OBJECT:
272                 right_key = stasis_app_control_get_channel_id(object_right);
273                 /* Fall through */
274         case OBJ_SEARCH_KEY:
275                 cmp = strcmp(stasis_app_control_get_channel_id(object_left), right_key);
276                 break;
277         case OBJ_SEARCH_PARTIAL_KEY:
278                 /*
279                  * We could also use a partial key struct containing a length
280                  * so strlen() does not get called for every comparison instead.
281                  */
282                 cmp = strncmp(stasis_app_control_get_channel_id(object_left), right_key, strlen(right_key));
283                 break;
284         default:
285                 /*
286                  * What arg points to is specific to this traversal callback
287                  * and has no special meaning to astobj2.
288                  */
289                 cmp = 0;
290                 break;
291         }
292         if (cmp) {
293                 return 0;
294         }
295         /*
296          * At this point the traversal callback is identical to a sorted
297          * container.
298          */
299         return CMP_MATCH;
300 }
301
302 static int cleanup_cb(void *obj, void *arg, int flags)
303 {
304         struct stasis_app *app = obj;
305
306         if (!app_is_finished(app)) {
307                 return 0;
308         }
309
310         ast_verb(1, "Shutting down application '%s'\n", stasis_app_name(app));
311         app_shutdown(app);
312
313         return CMP_MATCH;
314
315 }
316
317 /*!
318  * \brief Clean up any old apps that we don't need any more.
319  */
320 static void cleanup(void)
321 {
322         ao2_callback(apps_registry, OBJ_MULTIPLE | OBJ_NODATA | OBJ_UNLINK,
323                 cleanup_cb, NULL);
324 }
325
326 struct stasis_app_control *stasis_app_control_create(struct ast_channel *chan)
327 {
328         return control_create(chan, NULL);
329 }
330
331 struct stasis_app_control *stasis_app_control_find_by_channel(
332         const struct ast_channel *chan)
333 {
334         if (chan == NULL) {
335                 return NULL;
336         }
337
338         return stasis_app_control_find_by_channel_id(
339                 ast_channel_uniqueid(chan));
340 }
341
342 struct stasis_app_control *stasis_app_control_find_by_channel_id(
343         const char *channel_id)
344 {
345         return ao2_find(app_controls, channel_id, OBJ_SEARCH_KEY);
346 }
347
348 /*! AO2 hash function for bridges container  */
349 static int bridges_hash(const void *obj, const int flags)
350 {
351         const struct ast_bridge *bridge;
352         const char *key;
353
354         switch (flags & OBJ_SEARCH_MASK) {
355         case OBJ_SEARCH_KEY:
356                 key = obj;
357                 break;
358         case OBJ_SEARCH_OBJECT:
359                 bridge = obj;
360                 key = bridge->uniqueid;
361                 break;
362         default:
363                 /* Hash can only work on something with a full key. */
364                 ast_assert(0);
365                 return 0;
366         }
367         return ast_str_hash(key);
368 }
369
370 /*! AO2 comparison function for bridges container */
371 static int bridges_compare(void *obj, void *arg, int flags)
372 {
373         const struct ast_bridge *object_left = obj;
374         const struct ast_bridge *object_right = arg;
375         const char *right_key = arg;
376         int cmp;
377
378         switch (flags & OBJ_SEARCH_MASK) {
379         case OBJ_SEARCH_OBJECT:
380                 right_key = object_right->uniqueid;
381                 /* Fall through */
382         case OBJ_SEARCH_KEY:
383                 cmp = strcmp(object_left->uniqueid, right_key);
384                 break;
385         case OBJ_SEARCH_PARTIAL_KEY:
386                 /*
387                  * We could also use a partial key struct containing a length
388                  * so strlen() does not get called for every comparison instead.
389                  */
390                 cmp = strncmp(object_left->uniqueid, right_key, strlen(right_key));
391                 break;
392         default:
393                 /*
394                  * What arg points to is specific to this traversal callback
395                  * and has no special meaning to astobj2.
396                  */
397                 cmp = 0;
398                 break;
399         }
400         if (cmp) {
401                 return 0;
402         }
403         /*
404          * At this point the traversal callback is identical to a sorted
405          * container.
406          */
407         return CMP_MATCH;
408 }
409
410 /*!
411  *  Used with app_bridges_moh and app_bridge_control, they provide links
412  *  between bridges and channels used for ARI application purposes
413  */
414 struct stasis_app_bridge_channel_wrapper {
415         AST_DECLARE_STRING_FIELDS(
416                 AST_STRING_FIELD(channel_id);
417                 AST_STRING_FIELD(bridge_id);
418         );
419 };
420
421 static void stasis_app_bridge_channel_wrapper_destructor(void *obj)
422 {
423         struct stasis_app_bridge_channel_wrapper *wrapper = obj;
424         ast_string_field_free_memory(wrapper);
425 }
426
427 /*! AO2 hash function for the bridges moh container */
428 static int bridges_channel_hash_fn(const void *obj, const int flags)
429 {
430         const struct stasis_app_bridge_channel_wrapper *wrapper;
431         const char *key;
432
433         switch (flags & OBJ_SEARCH_MASK) {
434         case OBJ_SEARCH_KEY:
435                 key = obj;
436                 break;
437         case OBJ_SEARCH_OBJECT:
438                 wrapper = obj;
439                 key = wrapper->bridge_id;
440                 break;
441         default:
442                 /* Hash can only work on something with a full key. */
443                 ast_assert(0);
444                 return 0;
445         }
446         return ast_str_hash(key);
447 }
448
449 static int bridges_channel_sort_fn(const void *obj_left, const void *obj_right, const int flags)
450 {
451         const struct stasis_app_bridge_channel_wrapper *left = obj_left;
452         const struct stasis_app_bridge_channel_wrapper *right = obj_right;
453         const char *right_key = obj_right;
454         int cmp;
455
456         switch (flags & OBJ_SEARCH_MASK) {
457         case OBJ_SEARCH_OBJECT:
458                 right_key = right->bridge_id;
459                 /* Fall through */
460         case OBJ_SEARCH_KEY:
461                 cmp = strcmp(left->bridge_id, right_key);
462                 break;
463         case OBJ_SEARCH_PARTIAL_KEY:
464                 cmp = strncmp(left->bridge_id, right_key, strlen(right_key));
465                 break;
466         default:
467                 /* Sort can only work on something with a full or partial key. */
468                 ast_assert(0);
469                 cmp = 0;
470                 break;
471         }
472         return cmp;
473 }
474
475 /*! Removes the bridge to music on hold channel link */
476 static void remove_bridge_moh(char *bridge_id)
477 {
478         ao2_find(app_bridges_moh, bridge_id, OBJ_SEARCH_KEY | OBJ_UNLINK | OBJ_NODATA);
479         ast_free(bridge_id);
480 }
481
482 /*! After bridge failure callback for moh channels */
483 static void moh_after_bridge_cb_failed(enum ast_bridge_after_cb_reason reason, void *data)
484 {
485         char *bridge_id = data;
486
487         remove_bridge_moh(bridge_id);
488 }
489
490 /*! After bridge callback for moh channels */
491 static void moh_after_bridge_cb(struct ast_channel *chan, void *data)
492 {
493         char *bridge_id = data;
494
495         remove_bridge_moh(bridge_id);
496 }
497
498 /*! Request a bridge MOH channel */
499 static struct ast_channel *prepare_bridge_moh_channel(void)
500 {
501         RAII_VAR(struct ast_format_cap *, cap, NULL, ao2_cleanup);
502
503         cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
504         if (!cap) {
505                 return NULL;
506         }
507
508         ast_format_cap_append(cap, ast_format_slin, 0);
509
510         return ast_request("Announcer", cap, NULL, NULL, "ARI_MOH", NULL);
511 }
512
513 /*! Provides the moh channel with a thread so it can actually play its music */
514 static void *moh_channel_thread(void *data)
515 {
516         struct ast_channel *moh_channel = data;
517
518         while (!ast_safe_sleep(moh_channel, 1000)) {
519         }
520
521         ast_moh_stop(moh_channel);
522         ast_hangup(moh_channel);
523
524         return NULL;
525 }
526
527 /*!
528  * \internal
529  * \brief Creates, pushes, and links a channel for playing music on hold to bridge
530  *
531  * \param bridge Which bridge this moh channel exists for
532  *
533  * \retval NULL if the channel could not be created, pushed, or linked
534  * \retval Reference to the channel on success
535  */
536 static struct ast_channel *bridge_moh_create(struct ast_bridge *bridge)
537 {
538         RAII_VAR(struct stasis_app_bridge_channel_wrapper *, new_wrapper, NULL, ao2_cleanup);
539         RAII_VAR(char *, bridge_id, ast_strdup(bridge->uniqueid), ast_free);
540         struct ast_channel *chan;
541         pthread_t threadid;
542
543         if (!bridge_id) {
544                 return NULL;
545         }
546
547         chan = prepare_bridge_moh_channel();
548         if (!chan) {
549                 return NULL;
550         }
551
552         if (stasis_app_channel_unreal_set_internal(chan)) {
553                 ast_hangup(chan);
554                 return NULL;
555         }
556
557         /* The after bridge callback assumes responsibility of the bridge_id. */
558         if (ast_bridge_set_after_callback(chan,
559                 moh_after_bridge_cb, moh_after_bridge_cb_failed, bridge_id)) {
560                 ast_hangup(chan);
561                 return NULL;
562         }
563         bridge_id = NULL;
564
565         if (ast_unreal_channel_push_to_bridge(chan, bridge,
566                 AST_BRIDGE_CHANNEL_FLAG_IMMOVABLE | AST_BRIDGE_CHANNEL_FLAG_LONELY)) {
567                 ast_hangup(chan);
568                 return NULL;
569         }
570
571         new_wrapper = ao2_alloc_options(sizeof(*new_wrapper),
572                 stasis_app_bridge_channel_wrapper_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
573         if (!new_wrapper) {
574                 ast_hangup(chan);
575                 return NULL;
576         }
577
578         if (ast_string_field_init(new_wrapper, 32)) {
579                 ast_hangup(chan);
580                 return NULL;
581         }
582         ast_string_field_set(new_wrapper, bridge_id, bridge->uniqueid);
583         ast_string_field_set(new_wrapper, channel_id, ast_channel_uniqueid(chan));
584
585         if (!ao2_link_flags(app_bridges_moh, new_wrapper, OBJ_NOLOCK)) {
586                 ast_hangup(chan);
587                 return NULL;
588         }
589
590         if (ast_pthread_create_detached(&threadid, NULL, moh_channel_thread, chan)) {
591                 ast_log(LOG_ERROR, "Failed to create channel thread. Abandoning MOH channel creation.\n");
592                 ao2_unlink_flags(app_bridges_moh, new_wrapper, OBJ_NOLOCK);
593                 ast_hangup(chan);
594                 return NULL;
595         }
596
597         return chan;
598 }
599
600 struct ast_channel *stasis_app_bridge_moh_channel(struct ast_bridge *bridge)
601 {
602         RAII_VAR(struct stasis_app_bridge_channel_wrapper *, moh_wrapper, NULL, ao2_cleanup);
603
604         {
605                 SCOPED_AO2LOCK(lock, app_bridges_moh);
606
607                 moh_wrapper = ao2_find(app_bridges_moh, bridge->uniqueid, OBJ_SEARCH_KEY | OBJ_NOLOCK);
608                 if (!moh_wrapper) {
609                         return bridge_moh_create(bridge);
610                 }
611         }
612
613         return ast_channel_get_by_name(moh_wrapper->channel_id);
614 }
615
616 int stasis_app_bridge_moh_stop(struct ast_bridge *bridge)
617 {
618         RAII_VAR(struct stasis_app_bridge_channel_wrapper *, moh_wrapper, NULL, ao2_cleanup);
619         struct ast_channel *chan;
620
621         moh_wrapper = ao2_find(app_bridges_moh, bridge->uniqueid, OBJ_SEARCH_KEY | OBJ_UNLINK);
622         if (!moh_wrapper) {
623                 return -1;
624         }
625
626         chan = ast_channel_get_by_name(moh_wrapper->channel_id);
627         if (!chan) {
628                 return -1;
629         }
630
631         ast_moh_stop(chan);
632         ast_softhangup(chan, AST_CAUSE_NORMAL_CLEARING);
633         ao2_cleanup(chan);
634
635         return 0;
636 }
637
638 /*! Removes the bridge to playback channel link */
639 static void remove_bridge_playback(char *bridge_id)
640 {
641         struct stasis_app_bridge_channel_wrapper *wrapper;
642         struct stasis_app_control *control;
643
644         wrapper = ao2_find(app_bridges_playback, bridge_id, OBJ_SEARCH_KEY | OBJ_UNLINK);
645
646         if (wrapper) {
647                 control = stasis_app_control_find_by_channel_id(wrapper->channel_id);
648                 if (control) {
649                         ao2_unlink(app_controls, control);
650                         ao2_ref(control, -1);
651                 }
652                 ao2_ref(wrapper, -1);
653         }
654         ast_free(bridge_id);
655 }
656
657 static void playback_after_bridge_cb_failed(enum ast_bridge_after_cb_reason reason, void *data)
658 {
659         char *bridge_id = data;
660
661         remove_bridge_playback(bridge_id);
662 }
663
664 static void playback_after_bridge_cb(struct ast_channel *chan, void *data)
665 {
666         char *bridge_id = data;
667
668         remove_bridge_playback(bridge_id);
669 }
670
671 int stasis_app_bridge_playback_channel_add(struct ast_bridge *bridge,
672         struct ast_channel *chan,
673         struct stasis_app_control *control)
674 {
675         RAII_VAR(struct stasis_app_bridge_channel_wrapper *, new_wrapper, NULL, ao2_cleanup);
676         char *bridge_id = ast_strdup(bridge->uniqueid);
677
678         if (!bridge_id) {
679                 return -1;
680         }
681
682         if (ast_bridge_set_after_callback(chan,
683                 playback_after_bridge_cb, playback_after_bridge_cb_failed, bridge_id)) {
684                 ast_free(bridge_id);
685                 return -1;
686         }
687
688         new_wrapper = ao2_alloc_options(sizeof(*new_wrapper),
689                 stasis_app_bridge_channel_wrapper_destructor, AO2_ALLOC_OPT_LOCK_NOLOCK);
690         if (!new_wrapper) {
691                 return -1;
692         }
693
694         if (ast_string_field_init(new_wrapper, 32)) {
695                 return -1;
696         }
697
698         ast_string_field_set(new_wrapper, bridge_id, bridge->uniqueid);
699         ast_string_field_set(new_wrapper, channel_id, ast_channel_uniqueid(chan));
700
701         if (!ao2_link(app_bridges_playback, new_wrapper)) {
702                 return -1;
703         }
704
705         ao2_link(app_controls, control);
706         return 0;
707 }
708
709 void stasis_app_bridge_playback_channel_remove(char *bridge_id,
710         struct stasis_app_control *control)
711 {
712         struct stasis_app_bridge_channel_wrapper *wrapper;
713
714         wrapper = ao2_find(app_bridges_playback, bridge_id, OBJ_SEARCH_KEY | OBJ_UNLINK);
715         if (wrapper) {
716                 /* If wrapper is not found, then that means the after bridge callback has been
717                  * called or is in progress. No need to unlink the control here since that has
718                  * been done or is about to be done in the after bridge callback
719                  */
720                 ao2_unlink(app_controls, control);
721                 ao2_ref(wrapper, -1);
722         }
723 }
724
725 struct ast_channel *stasis_app_bridge_playback_channel_find(struct ast_bridge *bridge)
726 {
727         struct stasis_app_bridge_channel_wrapper *playback_wrapper;
728         struct ast_channel *chan;
729
730         playback_wrapper = ao2_find(app_bridges_playback, bridge->uniqueid, OBJ_SEARCH_KEY);
731         if (!playback_wrapper) {
732                 return NULL;
733         }
734
735         chan = ast_channel_get_by_name(playback_wrapper->channel_id);
736         ao2_ref(playback_wrapper, -1);
737         return chan;
738 }
739
740 struct ast_bridge *stasis_app_bridge_find_by_id(
741         const char *bridge_id)
742 {
743         return ao2_find(app_bridges, bridge_id, OBJ_SEARCH_KEY);
744 }
745
746
747 /*!
748  * \brief In addition to running ao2_cleanup(), this function also removes the
749  * object from the app_controls container.
750  */
751 static void control_unlink(struct stasis_app_control *control)
752 {
753         if (!control) {
754                 return;
755         }
756
757         ao2_unlink(app_controls, control);
758         ao2_cleanup(control);
759 }
760
761 static struct ast_bridge *bridge_create_common(const char *type, const char *name, const char *id, int invisible)
762 {
763         struct ast_bridge *bridge;
764         char *requested_type, *requested_types = ast_strdupa(S_OR(type, "mixing"));
765         int capabilities = 0;
766         int flags = AST_BRIDGE_FLAG_MERGE_INHIBIT_FROM | AST_BRIDGE_FLAG_MERGE_INHIBIT_TO
767                 | AST_BRIDGE_FLAG_SWAP_INHIBIT_FROM | AST_BRIDGE_FLAG_SWAP_INHIBIT_TO
768                 | AST_BRIDGE_FLAG_TRANSFER_BRIDGE_ONLY;
769
770         if (invisible) {
771                 flags |= AST_BRIDGE_FLAG_INVISIBLE;
772         }
773
774         while ((requested_type = strsep(&requested_types, ","))) {
775                 requested_type = ast_strip(requested_type);
776
777                 if (!strcmp(requested_type, "mixing")) {
778                         capabilities |= STASIS_BRIDGE_MIXING_CAPABILITIES;
779                         flags |= AST_BRIDGE_FLAG_SMART;
780                 } else if (!strcmp(requested_type, "holding")) {
781                         capabilities |= AST_BRIDGE_CAPABILITY_HOLDING;
782                 } else if (!strcmp(requested_type, "dtmf_events") ||
783                         !strcmp(requested_type, "proxy_media")) {
784                         capabilities &= ~AST_BRIDGE_CAPABILITY_NATIVE;
785                 }
786         }
787
788         if (!capabilities
789                 /* Holding and mixing capabilities don't mix. */
790                 || ((capabilities & AST_BRIDGE_CAPABILITY_HOLDING)
791                         && (capabilities & (STASIS_BRIDGE_MIXING_CAPABILITIES)))) {
792                 return NULL;
793         }
794
795         bridge = bridge_stasis_new(capabilities, flags, name, id);
796         if (bridge) {
797                 ast_bridge_set_talker_src_video_mode(bridge);
798                 if (!ao2_link(app_bridges, bridge)) {
799                         ast_bridge_destroy(bridge, 0);
800                         bridge = NULL;
801                 }
802         }
803         return bridge;
804 }
805
806 struct ast_bridge *stasis_app_bridge_create(const char *type, const char *name, const char *id)
807 {
808         return bridge_create_common(type, name, id, 0);
809 }
810
811 struct ast_bridge *stasis_app_bridge_create_invisible(const char *type, const char *name, const char *id)
812 {
813         return bridge_create_common(type, name, id, 1);
814 }
815
816 void stasis_app_bridge_destroy(const char *bridge_id)
817 {
818         struct ast_bridge *bridge = stasis_app_bridge_find_by_id(bridge_id);
819         if (!bridge) {
820                 return;
821         }
822         ao2_unlink(app_bridges, bridge);
823         ast_bridge_destroy(bridge, 0);
824 }
825
826 struct replace_channel_store {
827         struct ast_channel_snapshot *snapshot;
828         char *app;
829 };
830
831 static void replace_channel_destroy(void *obj)
832 {
833         struct replace_channel_store *replace = obj;
834
835         ao2_cleanup(replace->snapshot);
836         ast_free(replace->app);
837         ast_free(replace);
838 }
839
840 static const struct ast_datastore_info replace_channel_store_info = {
841         .type = "replace-channel-store",
842         .destroy = replace_channel_destroy,
843 };
844
845 static struct replace_channel_store *get_replace_channel_store(struct ast_channel *chan, int no_create)
846 {
847         struct ast_datastore *datastore;
848
849         SCOPED_CHANNELLOCK(lock, chan);
850         datastore = ast_channel_datastore_find(chan, &replace_channel_store_info, NULL);
851         if (!datastore) {
852                 if (no_create) {
853                         return NULL;
854                 }
855
856                 datastore = ast_datastore_alloc(&replace_channel_store_info, NULL);
857                 if (!datastore) {
858                         return NULL;
859                 }
860                 ast_channel_datastore_add(chan, datastore);
861         }
862
863         if (!datastore->data) {
864                 datastore->data = ast_calloc(1, sizeof(struct replace_channel_store));
865         }
866         return datastore->data;
867 }
868
869 int app_set_replace_channel_snapshot(struct ast_channel *chan, struct ast_channel_snapshot *replace_snapshot)
870 {
871         struct replace_channel_store *replace = get_replace_channel_store(chan, 0);
872
873         if (!replace) {
874                 return -1;
875         }
876
877         ao2_replace(replace->snapshot, replace_snapshot);
878         return 0;
879 }
880
881 int app_set_replace_channel_app(struct ast_channel *chan, const char *replace_app)
882 {
883         struct replace_channel_store *replace = get_replace_channel_store(chan, 0);
884
885         if (!replace) {
886                 return -1;
887         }
888
889         ast_free(replace->app);
890         replace->app = NULL;
891
892         if (replace_app) {
893                 replace->app = ast_strdup(replace_app);
894                 if (!replace->app) {
895                         return -1;
896                 }
897         }
898
899         return 0;
900 }
901
902 static struct ast_channel_snapshot *get_replace_channel_snapshot(struct ast_channel *chan)
903 {
904         struct replace_channel_store *replace = get_replace_channel_store(chan, 1);
905         struct ast_channel_snapshot *replace_channel_snapshot;
906
907         if (!replace) {
908                 return NULL;
909         }
910
911         replace_channel_snapshot = replace->snapshot;
912         replace->snapshot = NULL;
913
914         return replace_channel_snapshot;
915 }
916
917 char *app_get_replace_channel_app(struct ast_channel *chan)
918 {
919         struct replace_channel_store *replace = get_replace_channel_store(chan, 1);
920         char *replace_channel_app;
921
922         if (!replace) {
923                 return NULL;
924         }
925
926         replace_channel_app = replace->app;
927         replace->app = NULL;
928
929         return replace_channel_app;
930 }
931
932 static void start_message_blob_dtor(void *obj)
933 {
934         struct start_message_blob *payload = obj;
935
936         ao2_cleanup(payload->channel);
937         ao2_cleanup(payload->replace_channel);
938         ast_json_unref(payload->blob);
939 }
940
941 static int send_start_msg_snapshots(struct ast_channel *chan, struct stasis_app *app,
942         int argc, char *argv[], struct ast_channel_snapshot *snapshot,
943         struct ast_channel_snapshot *replace_channel_snapshot)
944 {
945         RAII_VAR(struct ast_json *, json_blob, NULL, ast_json_unref);
946         struct ast_json *json_args;
947         RAII_VAR(struct start_message_blob *, payload, NULL, ao2_cleanup);
948         struct stasis_message *msg;
949         int i;
950
951         if (app_subscribe_channel(app, chan)) {
952                 ast_log(LOG_ERROR, "Error subscribing app '%s' to channel '%s'\n",
953                         stasis_app_name(app), ast_channel_name(chan));
954                 return -1;
955         }
956
957         payload = ao2_alloc(sizeof(*payload), start_message_blob_dtor);
958         if (!payload) {
959                 ast_log(LOG_ERROR, "Error packing JSON for StasisStart message\n");
960                 return -1;
961         }
962
963         payload->channel = ao2_bump(snapshot);
964         payload->replace_channel = ao2_bump(replace_channel_snapshot);
965
966         json_blob = ast_json_pack("{s: s, s: o, s: []}",
967                 "app", stasis_app_name(app),
968                 "timestamp", ast_json_timeval(ast_tvnow(), NULL),
969                 "args");
970         if (!json_blob) {
971                 ast_log(LOG_ERROR, "Error packing JSON for StasisStart message\n");
972                 return -1;
973         }
974
975         /* Append arguments to args array */
976         json_args = ast_json_object_get(json_blob, "args");
977         ast_assert(json_args != NULL);
978         for (i = 0; i < argc; ++i) {
979                 int r = ast_json_array_append(json_args,
980                                               ast_json_string_create(argv[i]));
981                 if (r != 0) {
982                         ast_log(LOG_ERROR, "Error appending to StasisStart message\n");
983                         return -1;
984                 }
985         }
986
987         payload->blob = ast_json_ref(json_blob);
988
989         msg = stasis_message_create(start_message_type(), payload);
990         if (!msg) {
991                 ast_log(LOG_ERROR, "Error sending StasisStart message\n");
992                 return -1;
993         }
994
995         if (replace_channel_snapshot) {
996                 app_unsubscribe_channel_id(app, replace_channel_snapshot->uniqueid);
997         }
998         stasis_publish(ast_app_get_topic(app), msg);
999         ao2_ref(msg, -1);
1000         return 0;
1001 }
1002
1003 static int send_start_msg(struct stasis_app *app, struct ast_channel *chan,
1004         int argc, char *argv[])
1005 {
1006         RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
1007         RAII_VAR(struct ast_channel_snapshot *, replace_channel_snapshot,
1008                 NULL, ao2_cleanup);
1009
1010         ast_assert(chan != NULL);
1011
1012         replace_channel_snapshot = get_replace_channel_snapshot(chan);
1013
1014         /* Set channel info */
1015         ast_channel_lock(chan);
1016         snapshot = ast_channel_snapshot_create(chan);
1017         ast_channel_unlock(chan);
1018         if (!snapshot) {
1019                 return -1;
1020         }
1021         return send_start_msg_snapshots(chan, app, argc, argv, snapshot, replace_channel_snapshot);
1022 }
1023
1024 static void remove_masquerade_store(struct ast_channel *chan);
1025
1026 int app_send_end_msg(struct stasis_app *app, struct ast_channel *chan)
1027 {
1028         struct stasis_message_sanitizer *sanitize = stasis_app_get_sanitizer();
1029         struct ast_json *blob;
1030         struct stasis_message *msg;
1031
1032         if (sanitize && sanitize->channel
1033                 && sanitize->channel(chan)) {
1034                 return 0;
1035         }
1036
1037         blob = ast_json_pack("{s: s}", "app", stasis_app_name(app));
1038         if (!blob) {
1039                 ast_log(LOG_ERROR, "Error packing JSON for StasisEnd message\n");
1040                 return -1;
1041         }
1042
1043         remove_masquerade_store(chan);
1044         app_unsubscribe_channel(app, chan);
1045         msg = ast_channel_blob_create(chan, end_message_type(), blob);
1046         if (msg) {
1047                 stasis_publish(ast_app_get_topic(app), msg);
1048         }
1049         ao2_cleanup(msg);
1050         ast_json_unref(blob);
1051
1052         return 0;
1053 }
1054
1055 static int masq_match_cb(void *obj, void *data, int flags)
1056 {
1057         struct stasis_app_control *control = obj;
1058         struct ast_channel *chan = data;
1059
1060         if (!strcmp(ast_channel_uniqueid(chan),
1061                 stasis_app_control_get_channel_id(control))) {
1062                 return CMP_MATCH;
1063         }
1064
1065         return 0;
1066 }
1067
1068 static void channel_stolen_cb(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
1069 {
1070         struct stasis_app_control *control;
1071
1072         /*
1073          * At this point, old_chan is the channel pointer that is in Stasis() and
1074          * has the unknown channel's name in it while new_chan is the channel pointer
1075          * that is not in Stasis(), but has the guts of the channel that Stasis() knows
1076          * about.
1077          *
1078          * Find and unlink control since the channel has a new name/uniqueid
1079          * and its hash has changed.  Since the channel is leaving stasis don't
1080          * bother putting it back into the container.  Nobody is going to
1081          * remove it from the container later.
1082          */
1083         control = ao2_callback(app_controls, OBJ_UNLINK, masq_match_cb, old_chan);
1084         if (!control) {
1085                 ast_log(LOG_ERROR, "Could not find control for masqueraded channel\n");
1086                 return;
1087         }
1088
1089         /* send the StasisEnd message to the app */
1090         stasis_app_channel_set_stasis_end_published(new_chan);
1091         app_send_end_msg(control_app(control), new_chan);
1092
1093         /* remove the datastore */
1094         remove_masquerade_store(old_chan);
1095
1096         ao2_cleanup(control);
1097 }
1098
1099 static void channel_replaced_cb(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
1100 {
1101         RAII_VAR(struct ast_channel_snapshot *, new_snapshot, NULL, ao2_cleanup);
1102         RAII_VAR(struct ast_channel_snapshot *, old_snapshot, NULL, ao2_cleanup);
1103         struct stasis_app_control *control;
1104
1105         /* At this point, new_chan is the channel pointer that is in Stasis() and
1106          * has the unknown channel's name in it while old_chan is the channel pointer
1107          * that is not in Stasis(), but has the guts of the channel that Stasis() knows
1108          * about */
1109
1110         /* grab a snapshot for the channel that is jumping into Stasis() */
1111         new_snapshot = ast_channel_snapshot_get_latest(ast_channel_uniqueid(new_chan));
1112         if (!new_snapshot) {
1113                 ast_log(LOG_ERROR, "Could not get snapshot for masquerading channel\n");
1114                 return;
1115         }
1116
1117         /* grab a snapshot for the channel that has been kicked out of Stasis() */
1118         old_snapshot = ast_channel_snapshot_get_latest(ast_channel_uniqueid(old_chan));
1119         if (!old_snapshot) {
1120                 ast_log(LOG_ERROR, "Could not get snapshot for masqueraded channel\n");
1121                 return;
1122         }
1123
1124         /*
1125          * Find, unlink, and relink control since the channel has a new
1126          * name/uniqueid and its hash has changed.
1127          */
1128         control = ao2_callback(app_controls, OBJ_UNLINK, masq_match_cb, new_chan);
1129         if (!control) {
1130                 ast_log(LOG_ERROR, "Could not find control for masquerading channel\n");
1131                 return;
1132         }
1133         ao2_link(app_controls, control);
1134
1135
1136         /* send the StasisStart with replace_channel to the app */
1137         send_start_msg_snapshots(new_chan, control_app(control), 0, NULL, new_snapshot,
1138                 old_snapshot);
1139         /* send the StasisEnd message to the app */
1140         app_send_end_msg(control_app(control), old_chan);
1141
1142         ao2_cleanup(control);
1143 }
1144
1145 static const struct ast_datastore_info masquerade_store_info = {
1146         .type = "stasis-masqerade",
1147         .chan_fixup = channel_stolen_cb,
1148         .chan_breakdown = channel_replaced_cb,
1149 };
1150
1151 static int has_masquerade_store(struct ast_channel *chan)
1152 {
1153         SCOPED_CHANNELLOCK(lock, chan);
1154         return !!ast_channel_datastore_find(chan, &masquerade_store_info, NULL);
1155 }
1156
1157 static int add_masquerade_store(struct ast_channel *chan)
1158 {
1159         struct ast_datastore *datastore;
1160
1161         SCOPED_CHANNELLOCK(lock, chan);
1162         if (ast_channel_datastore_find(chan, &masquerade_store_info, NULL)) {
1163                 return 0;
1164         }
1165
1166         datastore = ast_datastore_alloc(&masquerade_store_info, NULL);
1167         if (!datastore) {
1168                 return -1;
1169         }
1170
1171         ast_channel_datastore_add(chan, datastore);
1172
1173         return 0;
1174 }
1175
1176 static void remove_masquerade_store(struct ast_channel *chan)
1177 {
1178         struct ast_datastore *datastore;
1179
1180         SCOPED_CHANNELLOCK(lock, chan);
1181         datastore = ast_channel_datastore_find(chan, &masquerade_store_info, NULL);
1182         if (!datastore) {
1183                 return;
1184         }
1185
1186         ast_channel_datastore_remove(chan, datastore);
1187         ast_datastore_free(datastore);
1188 }
1189
1190 void stasis_app_control_execute_until_exhausted(struct ast_channel *chan, struct stasis_app_control *control)
1191 {
1192         while (!control_is_done(control)) {
1193                 int command_count;
1194                 command_count = control_dispatch_all(control, chan);
1195
1196                 ao2_lock(control);
1197
1198                 if (control_command_count(control)) {
1199                         /* If the command queue isn't empty, something added to the queue before it was locked. */
1200                         ao2_unlock(control);
1201                         continue;
1202                 }
1203
1204                 if (command_count == 0 || ast_channel_fdno(chan) == -1) {
1205                         control_mark_done(control);
1206                         ao2_unlock(control);
1207                         break;
1208                 }
1209                 ao2_unlock(control);
1210         }
1211 }
1212
1213 int stasis_app_control_is_done(struct stasis_app_control *control)
1214 {
1215         return control_is_done(control);
1216 }
1217
1218 void stasis_app_control_flush_queue(struct stasis_app_control *control)
1219 {
1220         control_flush_queue(control);
1221 }
1222
1223 struct ast_datastore_info set_end_published_info = {
1224         .type = "stasis_end_published",
1225 };
1226
1227 void stasis_app_channel_set_stasis_end_published(struct ast_channel *chan)
1228 {
1229         struct ast_datastore *datastore;
1230
1231         datastore = ast_datastore_alloc(&set_end_published_info, NULL);
1232         if (datastore) {
1233                 ast_channel_lock(chan);
1234                 ast_channel_datastore_add(chan, datastore);
1235                 ast_channel_unlock(chan);
1236         }
1237 }
1238
1239 int stasis_app_channel_is_stasis_end_published(struct ast_channel *chan)
1240 {
1241         struct ast_datastore *datastore;
1242
1243         ast_channel_lock(chan);
1244         datastore = ast_channel_datastore_find(chan, &set_end_published_info, NULL);
1245         ast_channel_unlock(chan);
1246
1247         return datastore ? 1 : 0;
1248 }
1249
1250 static void remove_stasis_end_published(struct ast_channel *chan)
1251 {
1252         struct ast_datastore *datastore;
1253
1254         ast_channel_lock(chan);
1255         datastore = ast_channel_datastore_find(chan, &set_end_published_info, NULL);
1256         if (datastore) {
1257                 ast_channel_datastore_remove(chan, datastore);
1258                 ast_datastore_free(datastore);
1259         }
1260         ast_channel_unlock(chan);
1261 }
1262
1263 /*! /brief Stasis dialplan application callback */
1264 int stasis_app_exec(struct ast_channel *chan, const char *app_name, int argc,
1265                     char *argv[])
1266 {
1267         SCOPED_MODULE_USE(ast_module_info->self);
1268
1269         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1270         RAII_VAR(struct stasis_app_control *, control, NULL, control_unlink);
1271         struct ast_bridge *bridge = NULL;
1272         int res = 0;
1273         int needs_depart;
1274
1275         ast_assert(chan != NULL);
1276
1277         /* Just in case there's a lingering indication that the channel has had a stasis
1278          * end published on it, remove that now.
1279          */
1280         remove_stasis_end_published(chan);
1281
1282         if (!apps_registry) {
1283                 return -1;
1284         }
1285
1286         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1287         if (!app) {
1288                 ast_log(LOG_ERROR,
1289                         "Stasis app '%s' not registered\n", app_name);
1290                 return -1;
1291         }
1292         if (!app_is_active(app)) {
1293                 ast_log(LOG_ERROR,
1294                         "Stasis app '%s' not active\n", app_name);
1295                 return -1;
1296         }
1297
1298         control = control_create(chan, app);
1299         if (!control) {
1300                 ast_log(LOG_ERROR, "Allocated failed\n");
1301                 return -1;
1302         }
1303         ao2_link(app_controls, control);
1304
1305         if (add_masquerade_store(chan)) {
1306                 ast_log(LOG_ERROR, "Failed to attach masquerade detector\n");
1307                 return -1;
1308         }
1309
1310         res = send_start_msg(app, chan, argc, argv);
1311         if (res != 0) {
1312                 ast_log(LOG_ERROR,
1313                         "Error sending start message to '%s'\n", app_name);
1314                 remove_masquerade_store(chan);
1315                 return -1;
1316         }
1317
1318         /* Pull queued prestart commands and execute */
1319         control_prestart_dispatch_all(control, chan);
1320
1321         while (!control_is_done(control)) {
1322                 RAII_VAR(struct ast_frame *, f, NULL, ast_frame_dtor);
1323                 int r;
1324                 int command_count;
1325                 RAII_VAR(struct ast_bridge *, last_bridge, NULL, ao2_cleanup);
1326
1327                 /* Check to see if a bridge absorbed our hangup frame */
1328                 if (ast_check_hangup_locked(chan)) {
1329                         control_mark_done(control);
1330                         break;
1331                 }
1332
1333                 last_bridge = bridge;
1334                 bridge = ao2_bump(stasis_app_get_bridge(control));
1335
1336                 if (bridge != last_bridge) {
1337                         if (last_bridge) {
1338                                 app_unsubscribe_bridge(app, last_bridge);
1339                         }
1340                         if (bridge) {
1341                                 app_subscribe_bridge(app, bridge);
1342                         }
1343                 }
1344
1345                 if (bridge) {
1346                         /* Bridge/dial is handling channel frames */
1347                         control_wait(control);
1348                         control_dispatch_all(control, chan);
1349                         continue;
1350                 }
1351
1352                 r = ast_waitfor(chan, MAX_WAIT_MS);
1353
1354                 if (r < 0) {
1355                         ast_debug(3, "%s: Poll error\n",
1356                                   ast_channel_uniqueid(chan));
1357                         control_mark_done(control);
1358                         break;
1359                 }
1360
1361                 command_count = control_dispatch_all(control, chan);
1362
1363                 if (command_count > 0 && ast_channel_fdno(chan) == -1) {
1364                         /* Command drained the channel; wait for next frame */
1365                         continue;
1366                 }
1367
1368                 if (r == 0) {
1369                         /* Timeout */
1370                         continue;
1371                 }
1372
1373                 f = ast_read(chan);
1374                 if (!f) {
1375                         /* Continue on in the dialplan */
1376                         ast_debug(3, "%s: Hangup (no more frames)\n",
1377                                 ast_channel_uniqueid(chan));
1378                         control_mark_done(control);
1379                         break;
1380                 }
1381
1382                 if (f->frametype == AST_FRAME_CONTROL) {
1383                         if (f->subclass.integer == AST_CONTROL_HANGUP) {
1384                                 /* Continue on in the dialplan */
1385                                 ast_debug(3, "%s: Hangup\n",
1386                                         ast_channel_uniqueid(chan));
1387                                 control_mark_done(control);
1388                                 break;
1389                         }
1390                 }
1391         }
1392
1393         ast_channel_lock(chan);
1394         needs_depart = (ast_channel_internal_bridge_channel(chan) != NULL);
1395         ast_channel_unlock(chan);
1396         if (needs_depart) {
1397                 ast_bridge_depart(chan);
1398         }
1399
1400         if (stasis_app_get_bridge(control)) {
1401                 app_unsubscribe_bridge(app, stasis_app_get_bridge(control));
1402         }
1403         ao2_cleanup(bridge);
1404
1405         /* Only publish a stasis_end event if it hasn't already been published */
1406         if (!stasis_app_channel_is_stasis_end_published(chan)) {
1407                 /* A masquerade has occurred and this message will be wrong so it
1408                  * has already been sent elsewhere. */
1409                 res = has_masquerade_store(chan) && app_send_end_msg(app, chan);
1410                 if (res != 0) {
1411                         ast_log(LOG_ERROR,
1412                                 "Error sending end message to %s\n", app_name);
1413                         return res;
1414                 }
1415         } else {
1416                 remove_stasis_end_published(chan);
1417         }
1418
1419         control_flush_queue(control);
1420
1421         /* Stop any lingering silence generator */
1422         control_silence_stop_now(control);
1423
1424         /* There's an off chance that app is ready for cleanup. Go ahead
1425          * and clean up, just in case
1426          */
1427         cleanup();
1428
1429         /* The control needs to be removed from the controls container in
1430          * case a new PBX is started and ends up coming back into Stasis.
1431          */
1432         ao2_cleanup(app);
1433         app = NULL;
1434         control_unlink(control);
1435         control = NULL;
1436
1437         if (!ast_channel_pbx(chan)) {
1438                 int chan_hungup;
1439
1440                 /* The ASYNCGOTO softhangup flag may have broken the channel out of
1441                  * its bridge to run dialplan, so if there's no pbx on the channel
1442                  * let it run dialplan here. Otherwise, it will run when this
1443                  * application exits. */
1444                 ast_channel_lock(chan);
1445                 ast_channel_clear_softhangup(chan, AST_SOFTHANGUP_ASYNCGOTO);
1446                 chan_hungup = ast_check_hangup(chan);
1447                 ast_channel_unlock(chan);
1448
1449                 if (!chan_hungup) {
1450                         struct ast_pbx_args pbx_args;
1451
1452                         memset(&pbx_args, 0, sizeof(pbx_args));
1453                         pbx_args.no_hangup_chan = 1;
1454
1455                         res = ast_pbx_run_args(chan, &pbx_args);
1456                 }
1457         }
1458
1459         return res;
1460 }
1461
1462 int stasis_app_send(const char *app_name, struct ast_json *message)
1463 {
1464         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1465
1466         if (!apps_registry) {
1467                 return -1;
1468         }
1469
1470         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1471         if (!app) {
1472                 /* XXX We can do a better job handling late binding, queueing up
1473                  * the call for a few seconds to wait for the app to register.
1474                  */
1475                 ast_log(LOG_WARNING,
1476                         "Stasis app '%s' not registered\n", app_name);
1477                 return -1;
1478         }
1479         app_send(app, message);
1480         return 0;
1481 }
1482
1483 static struct stasis_app *find_app_by_name(const char *app_name)
1484 {
1485         struct stasis_app *res = NULL;
1486
1487         if (!apps_registry) {
1488                 return NULL;
1489         }
1490
1491         if (!ast_strlen_zero(app_name)) {
1492                 res = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1493         }
1494
1495         return res;
1496 }
1497
1498 struct stasis_app *stasis_app_get_by_name(const char *name)
1499 {
1500         return find_app_by_name(name);
1501 }
1502
1503 static int append_name(void *obj, void *arg, int flags)
1504 {
1505         struct stasis_app *app = obj;
1506         struct ao2_container *apps = arg;
1507
1508         ast_str_container_add(apps, stasis_app_name(app));
1509         return 0;
1510 }
1511
1512 struct ao2_container *stasis_app_get_all(void)
1513 {
1514         RAII_VAR(struct ao2_container *, apps, NULL, ao2_cleanup);
1515
1516         if (!apps_registry) {
1517                 return NULL;
1518         }
1519
1520         apps = ast_str_container_alloc(1);
1521         if (!apps) {
1522                 return NULL;
1523         }
1524
1525         ao2_callback(apps_registry, OBJ_NODATA, append_name, apps);
1526
1527         return ao2_bump(apps);
1528 }
1529
1530 static int __stasis_app_register(const char *app_name, stasis_app_cb handler, void *data, int all_events)
1531 {
1532         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1533
1534         if (!apps_registry) {
1535                 return -1;
1536         }
1537
1538         ao2_lock(apps_registry);
1539         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY | OBJ_NOLOCK);
1540         if (app) {
1541                 app_update(app, handler, data);
1542         } else {
1543                 app = app_create(app_name, handler, data, all_events ? STASIS_APP_SUBSCRIBE_ALL : STASIS_APP_SUBSCRIBE_MANUAL);
1544                 if (app) {
1545                         if (all_events) {
1546                                 struct stasis_app_event_source *source;
1547                                 SCOPED_LOCK(lock, &event_sources, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
1548
1549                                 AST_LIST_TRAVERSE(&event_sources, source, next) {
1550                                         if (!source->subscribe) {
1551                                                 continue;
1552                                         }
1553
1554                                         source->subscribe(app, NULL);
1555                                 }
1556                         }
1557                         ao2_link_flags(apps_registry, app, OBJ_NOLOCK);
1558                 } else {
1559                         ao2_unlock(apps_registry);
1560                         return -1;
1561                 }
1562         }
1563
1564         /* We lazily clean up the apps_registry, because it's good enough to
1565          * prevent memory leaks, and we're lazy.
1566          */
1567         cleanup();
1568         ao2_unlock(apps_registry);
1569         return 0;
1570 }
1571
1572 int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data)
1573 {
1574         return __stasis_app_register(app_name, handler, data, 0);
1575 }
1576
1577 int stasis_app_register_all(const char *app_name, stasis_app_cb handler, void *data)
1578 {
1579         return __stasis_app_register(app_name, handler, data, 1);
1580 }
1581
1582 void stasis_app_unregister(const char *app_name)
1583 {
1584         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1585
1586         if (!app_name) {
1587                 return;
1588         }
1589
1590         if (!apps_registry) {
1591                 return;
1592         }
1593
1594         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1595         if (!app) {
1596                 ast_log(LOG_ERROR,
1597                         "Stasis app '%s' not registered\n", app_name);
1598                 return;
1599         }
1600
1601         app_deactivate(app);
1602
1603         /* There's a decent chance that app is ready for cleanup. Go ahead
1604          * and clean up, just in case
1605          */
1606         cleanup();
1607 }
1608
1609 void stasis_app_register_event_source(struct stasis_app_event_source *obj)
1610 {
1611         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
1612         AST_LIST_INSERT_TAIL(&event_sources, obj, next);
1613         /* only need to bump the module ref on non-core sources because the
1614            core ones are [un]registered by this module. */
1615         if (!stasis_app_is_core_event_source(obj)) {
1616                 ast_module_ref(ast_module_info->self);
1617         }
1618 }
1619
1620 void stasis_app_unregister_event_source(struct stasis_app_event_source *obj)
1621 {
1622         struct stasis_app_event_source *source;
1623         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
1624         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&event_sources, source, next) {
1625                 if (source == obj) {
1626                         AST_RWLIST_REMOVE_CURRENT(next);
1627                         if (!stasis_app_is_core_event_source(obj)) {
1628                                 ast_module_unref(ast_module_info->self);
1629                         }
1630                         break;
1631                 }
1632         }
1633         AST_RWLIST_TRAVERSE_SAFE_END;
1634 }
1635
1636 /*!
1637  * \internal
1638  * \brief Convert event source data to JSON.
1639  *
1640  * Calls each event source that has a "to_json" handler allowing each
1641  * source to add data to the given JSON object.
1642  *
1643  * \param app application associated with the event source
1644  * \param json a json object to "fill"
1645  *
1646  * \retval The given json object.
1647  */
1648 static struct ast_json *app_event_sources_to_json(
1649         const struct stasis_app *app, struct ast_json *json)
1650 {
1651         struct stasis_app_event_source *source;
1652         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
1653         AST_LIST_TRAVERSE(&event_sources, source, next) {
1654                 if (source->to_json) {
1655                         source->to_json(app, json);
1656                 }
1657         }
1658         return json;
1659 }
1660
1661 static struct ast_json *stasis_app_object_to_json(struct stasis_app *app)
1662 {
1663         if (!app) {
1664                 return NULL;
1665         }
1666
1667         return app_event_sources_to_json(app, app_to_json(app));
1668 }
1669
1670 struct ast_json *stasis_app_to_json(const char *app_name)
1671 {
1672         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1673
1674         return stasis_app_object_to_json(app);
1675 }
1676
1677 /*!
1678  * \internal
1679  * \brief Finds an event source that matches a uri scheme.
1680  *
1681  * Uri(s) should begin with a particular scheme that can be matched
1682  * against an event source.
1683  *
1684  * \param uri uri containing a scheme to match
1685  *
1686  * \retval an event source if found, NULL otherwise.
1687  */
1688 static struct stasis_app_event_source *app_event_source_find(const char *uri)
1689 {
1690         struct stasis_app_event_source *source;
1691         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
1692         AST_LIST_TRAVERSE(&event_sources, source, next) {
1693                 if (ast_begins_with(uri, source->scheme)) {
1694                         return source;
1695                 }
1696         }
1697         return NULL;
1698 }
1699
1700 /*!
1701  * \internal
1702  * \brief Callback for subscription handling
1703  *
1704  * \param app [un]subscribing application
1705  * \param uri scheme:id of an event source
1706  * \param event_source being [un]subscribed [from]to
1707  *
1708  * \retval stasis_app_subscribe_res return code.
1709  */
1710 typedef enum stasis_app_subscribe_res (*app_subscription_handler)(
1711         struct stasis_app *app, const char *uri,
1712         struct stasis_app_event_source *event_source);
1713
1714 /*!
1715  * \internal
1716  * \brief Subscriptions handler for application [un]subscribing.
1717  *
1718  * \param app_name Name of the application to subscribe.
1719  * \param event_source_uris URIs for the event sources to subscribe to.
1720  * \param event_sources_count Array size of event_source_uris.
1721  * \param json Optional output pointer for JSON representation of the app
1722  *             after adding the subscription.
1723  * \param handler [un]subscribe handler
1724  *
1725  * \retval stasis_app_subscribe_res return code.
1726  */
1727 static enum stasis_app_subscribe_res app_handle_subscriptions(
1728         const char *app_name, const char **event_source_uris,
1729         int event_sources_count, struct ast_json **json,
1730         app_subscription_handler handler)
1731 {
1732         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1733         int i;
1734
1735         if (!app) {
1736                 return STASIS_ASR_APP_NOT_FOUND;
1737         }
1738
1739         for (i = 0; i < event_sources_count; ++i) {
1740                 const char *uri = event_source_uris[i];
1741                 enum stasis_app_subscribe_res res = STASIS_ASR_INTERNAL_ERROR;
1742                 struct stasis_app_event_source *event_source;
1743
1744                 if (!(event_source = app_event_source_find(uri))) {
1745                         ast_log(LOG_WARNING, "Invalid scheme: %s\n", uri);
1746                         return STASIS_ASR_EVENT_SOURCE_BAD_SCHEME;
1747                 }
1748
1749                 if (handler &&
1750                     ((res = handler(app, uri, event_source)))) {
1751                         return res;
1752                 }
1753         }
1754
1755         if (json) {
1756                 ast_debug(3, "%s: Successful; setting results\n", app_name);
1757                 *json = stasis_app_object_to_json(app);
1758         }
1759
1760         return STASIS_ASR_OK;
1761 }
1762
1763 enum stasis_app_subscribe_res stasis_app_subscribe_channel(const char *app_name,
1764         struct ast_channel *chan)
1765 {
1766         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1767         int res;
1768
1769         if (!app) {
1770                 return STASIS_ASR_APP_NOT_FOUND;
1771         }
1772
1773         ast_debug(3, "%s: Subscribing to %s\n", app_name, ast_channel_uniqueid(chan));
1774
1775         res = app_subscribe_channel(app, chan);
1776         if (res != 0) {
1777                 ast_log(LOG_ERROR, "Error subscribing app '%s' to channel '%s'\n",
1778                         app_name, ast_channel_uniqueid(chan));
1779                 return STASIS_ASR_INTERNAL_ERROR;
1780         }
1781
1782         return STASIS_ASR_OK;
1783 }
1784
1785
1786 /*!
1787  * \internal
1788  * \brief Subscribe an app to an event source.
1789  *
1790  * \param app subscribing application
1791  * \param uri scheme:id of an event source
1792  * \param event_source being subscribed to
1793  *
1794  * \retval stasis_app_subscribe_res return code.
1795  */
1796 static enum stasis_app_subscribe_res app_subscribe(
1797         struct stasis_app *app, const char *uri,
1798         struct stasis_app_event_source *event_source)
1799 {
1800         const char *app_name = stasis_app_name(app);
1801         RAII_VAR(void *, obj, NULL, ao2_cleanup);
1802
1803         ast_debug(3, "%s: Checking %s\n", app_name, uri);
1804
1805         if (!ast_strlen_zero(uri + strlen(event_source->scheme)) &&
1806             (!event_source->find || (!(obj = event_source->find(app, uri + strlen(event_source->scheme)))))) {
1807                 ast_log(LOG_WARNING, "Event source not found: %s\n", uri);
1808                 return STASIS_ASR_EVENT_SOURCE_NOT_FOUND;
1809         }
1810
1811         ast_debug(3, "%s: Subscribing to %s\n", app_name, uri);
1812
1813         if (!event_source->subscribe || (event_source->subscribe(app, obj))) {
1814                 ast_log(LOG_WARNING, "Error subscribing app '%s' to '%s'\n",
1815                         app_name, uri);
1816                 return STASIS_ASR_INTERNAL_ERROR;
1817         }
1818
1819         return STASIS_ASR_OK;
1820 }
1821
1822 enum stasis_app_subscribe_res stasis_app_subscribe(const char *app_name,
1823         const char **event_source_uris, int event_sources_count,
1824         struct ast_json **json)
1825 {
1826         return app_handle_subscriptions(
1827                 app_name, event_source_uris, event_sources_count,
1828                 json, app_subscribe);
1829 }
1830
1831 /*!
1832  * \internal
1833  * \brief Unsubscribe an app from an event source.
1834  *
1835  * \param app application to unsubscribe
1836  * \param uri scheme:id of an event source
1837  * \param event_source being unsubscribed from
1838  *
1839  * \retval stasis_app_subscribe_res return code.
1840  */
1841 static enum stasis_app_subscribe_res app_unsubscribe(
1842         struct stasis_app *app, const char *uri,
1843         struct stasis_app_event_source *event_source)
1844 {
1845         const char *app_name = stasis_app_name(app);
1846         const char *id = uri + strlen(event_source->scheme);
1847
1848         if (!event_source->is_subscribed ||
1849             (!event_source->is_subscribed(app, id))) {
1850                 return STASIS_ASR_EVENT_SOURCE_NOT_FOUND;
1851         }
1852
1853         ast_debug(3, "%s: Unsubscribing from %s\n", app_name, uri);
1854
1855         if (!event_source->unsubscribe || (event_source->unsubscribe(app, id))) {
1856                 ast_log(LOG_WARNING, "Error unsubscribing app '%s' to '%s'\n",
1857                         app_name, uri);
1858                 return -1;
1859         }
1860         return 0;
1861 }
1862
1863 enum stasis_app_subscribe_res stasis_app_unsubscribe(const char *app_name,
1864         const char **event_source_uris, int event_sources_count,
1865         struct ast_json **json)
1866 {
1867         return app_handle_subscriptions(
1868                 app_name, event_source_uris, event_sources_count,
1869                 json, app_unsubscribe);
1870 }
1871
1872 enum stasis_app_user_event_res stasis_app_user_event(const char *app_name,
1873         const char *event_name,
1874         const char **source_uris, int sources_count,
1875         struct ast_json *json_variables)
1876 {
1877         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1878         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1879         RAII_VAR(struct ast_multi_object_blob *, multi, NULL, ao2_cleanup);
1880         RAII_VAR(void *, obj, NULL, ao2_cleanup);
1881         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
1882         enum stasis_app_user_event_res res = STASIS_APP_USER_INTERNAL_ERROR;
1883         struct ast_json *json_value;
1884         int have_channel = 0;
1885         int i;
1886
1887         if (!app) {
1888                 ast_log(LOG_WARNING, "App %s not found\n", app_name);
1889                 return STASIS_APP_USER_APP_NOT_FOUND;
1890         }
1891
1892         if (!ast_multi_user_event_type()) {
1893                 return res;
1894         }
1895
1896         blob = json_variables;
1897         if (!blob) {
1898                 blob = ast_json_pack("{}");
1899         } else {
1900                 ast_json_ref(blob);
1901         }
1902         json_value = ast_json_string_create(event_name);
1903         if (!json_value) {
1904                 ast_log(LOG_ERROR, "unable to create json string\n");
1905                 return res;
1906         }
1907         if (ast_json_object_set(blob, "eventname", json_value)) {
1908                 ast_log(LOG_ERROR, "unable to set eventname to blob\n");
1909                 return res;
1910         }
1911
1912         multi = ast_multi_object_blob_create(blob);
1913
1914         for (i = 0; i < sources_count; ++i) {
1915                 const char *uri = source_uris[i];
1916                 void *snapshot=NULL;
1917                 enum stasis_user_multi_object_snapshot_type type;
1918
1919                 if (ast_begins_with(uri, "channel:")) {
1920                         type = STASIS_UMOS_CHANNEL;
1921                         snapshot = ast_channel_snapshot_get_latest(uri + 8);
1922                         have_channel = 1;
1923                 } else if (ast_begins_with(uri, "bridge:")) {
1924                         type = STASIS_UMOS_BRIDGE;
1925                         snapshot = ast_bridge_snapshot_get_latest(uri + 7);
1926                 } else if (ast_begins_with(uri, "endpoint:")) {
1927                         type = STASIS_UMOS_ENDPOINT;
1928                         snapshot = ast_endpoint_latest_snapshot(uri + 9, NULL);
1929                 } else {
1930                         ast_log(LOG_WARNING, "Invalid scheme: %s\n", uri);
1931                         return STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME;
1932                 }
1933                 if (!snapshot) {
1934                         ast_log(LOG_ERROR, "Unable to get snapshot for %s\n", uri);
1935                         return STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND;
1936                 }
1937                 ast_multi_object_blob_add(multi, type, snapshot);
1938         }
1939
1940         message = stasis_message_create(ast_multi_user_event_type(), multi);
1941         if (!message) {
1942                 ast_log(LOG_ERROR, "Unable to create stasis user event message\n");
1943                 return res;
1944         }
1945
1946         /*
1947          * Publishing to two different topics is normally to be avoided -- except
1948          * in this case both are final destinations with no forwards (only listeners).
1949          * The message has to be delivered to the application topic for ARI, but a
1950          * copy is also delivered directly to the manager for AMI if there is a channel.
1951          */
1952         stasis_publish(ast_app_get_topic(app), message);
1953
1954         if (have_channel) {
1955                 stasis_publish(ast_manager_get_topic(), message);
1956         }
1957
1958         return STASIS_APP_USER_OK;
1959 }
1960
1961 void stasis_app_ref(void)
1962 {
1963         ast_module_ref(ast_module_info->self);
1964 }
1965
1966 void stasis_app_unref(void)
1967 {
1968         ast_module_unref(ast_module_info->self);
1969 }
1970
1971 static int unload_module(void)
1972 {
1973         stasis_app_unregister_event_sources();
1974
1975         messaging_cleanup();
1976
1977         cleanup();
1978         ao2_cleanup(apps_registry);
1979         apps_registry = NULL;
1980
1981         ao2_cleanup(app_controls);
1982         app_controls = NULL;
1983
1984         ao2_cleanup(app_bridges);
1985         app_bridges = NULL;
1986
1987         ao2_cleanup(app_bridges_moh);
1988         app_bridges_moh = NULL;
1989
1990         ao2_cleanup(app_bridges_playback);
1991         app_bridges_playback = NULL;
1992
1993         stasis_app_control_shutdown();
1994
1995         STASIS_MESSAGE_TYPE_CLEANUP(end_message_type);
1996         STASIS_MESSAGE_TYPE_CLEANUP(start_message_type);
1997
1998         return 0;
1999 }
2000
2001 /* \brief Sanitization callback for channel snapshots */
2002 static int channel_snapshot_sanitizer(const struct ast_channel_snapshot *snapshot)
2003 {
2004         if (!snapshot || !(snapshot->tech_properties & AST_CHAN_TP_INTERNAL)) {
2005                 return 0;
2006         }
2007         return 1;
2008 }
2009
2010 /* \brief Sanitization callback for channels */
2011 static int channel_sanitizer(const struct ast_channel *chan)
2012 {
2013         if (!chan || !(ast_channel_tech(chan)->properties & AST_CHAN_TP_INTERNAL)) {
2014                 return 0;
2015         }
2016         return 1;
2017 }
2018
2019 /* \brief Sanitization callback for channel unique IDs */
2020 static int channel_id_sanitizer(const char *id)
2021 {
2022         RAII_VAR(struct ast_channel_snapshot *, snapshot, ast_channel_snapshot_get_latest(id), ao2_cleanup);
2023
2024         return channel_snapshot_sanitizer(snapshot);
2025 }
2026
2027 /* \brief Sanitization callbacks for communication to Stasis applications */
2028 struct stasis_message_sanitizer app_sanitizer = {
2029         .channel_id = channel_id_sanitizer,
2030         .channel_snapshot = channel_snapshot_sanitizer,
2031         .channel = channel_sanitizer,
2032 };
2033
2034 struct stasis_message_sanitizer *stasis_app_get_sanitizer(void)
2035 {
2036         return &app_sanitizer;
2037 }
2038
2039 static const struct ast_datastore_info stasis_internal_channel_info = {
2040         .type = "stasis-internal-channel",
2041 };
2042
2043 static int set_internal_datastore(struct ast_channel *chan)
2044 {
2045         struct ast_datastore *datastore;
2046
2047         datastore = ast_channel_datastore_find(chan, &stasis_internal_channel_info, NULL);
2048         if (!datastore) {
2049                 datastore = ast_datastore_alloc(&stasis_internal_channel_info, NULL);
2050                 if (!datastore) {
2051                         return -1;
2052                 }
2053                 ast_channel_datastore_add(chan, datastore);
2054         }
2055         return 0;
2056 }
2057
2058 int stasis_app_channel_unreal_set_internal(struct ast_channel *chan)
2059 {
2060         struct ast_channel *outchan = NULL, *outowner = NULL;
2061         int res = 0;
2062         struct ast_unreal_pvt *unreal_pvt = ast_channel_tech_pvt(chan);
2063
2064         ao2_ref(unreal_pvt, +1);
2065         ast_unreal_lock_all(unreal_pvt, &outowner, &outchan);
2066         if (outowner) {
2067                 res |= set_internal_datastore(outowner);
2068                 ast_channel_unlock(outowner);
2069                 ast_channel_unref(outowner);
2070         }
2071         if (outchan) {
2072                 res |= set_internal_datastore(outchan);
2073                 ast_channel_unlock(outchan);
2074                 ast_channel_unref(outchan);
2075         }
2076         ao2_unlock(unreal_pvt);
2077         ao2_ref(unreal_pvt, -1);
2078         return res;
2079 }
2080
2081 int stasis_app_channel_set_internal(struct ast_channel *chan)
2082 {
2083         int res;
2084
2085         ast_channel_lock(chan);
2086         res = set_internal_datastore(chan);
2087         ast_channel_unlock(chan);
2088
2089         return res;
2090 }
2091
2092 int stasis_app_channel_is_internal(struct ast_channel *chan)
2093 {
2094         struct ast_datastore *datastore;
2095         int res = 0;
2096
2097         ast_channel_lock(chan);
2098         datastore = ast_channel_datastore_find(chan, &stasis_internal_channel_info, NULL);
2099         if (datastore) {
2100                 res = 1;
2101         }
2102         ast_channel_unlock(chan);
2103
2104         return res;
2105 }
2106
2107 static int load_module(void)
2108 {
2109         if (STASIS_MESSAGE_TYPE_INIT(start_message_type) != 0) {
2110                 return AST_MODULE_LOAD_DECLINE;
2111         }
2112         if (STASIS_MESSAGE_TYPE_INIT(end_message_type) != 0) {
2113                 return AST_MODULE_LOAD_DECLINE;
2114         }
2115         apps_registry = ao2_container_alloc(APPS_NUM_BUCKETS, app_hash, app_compare);
2116         app_controls = ao2_container_alloc(CONTROLS_NUM_BUCKETS, control_hash, control_compare);
2117         app_bridges = ao2_container_alloc(BRIDGES_NUM_BUCKETS, bridges_hash, bridges_compare);
2118         app_bridges_moh = ao2_container_alloc_hash(
2119                 AO2_ALLOC_OPT_LOCK_MUTEX, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT,
2120                 37, bridges_channel_hash_fn, bridges_channel_sort_fn, NULL);
2121         app_bridges_playback = ao2_container_alloc_hash(
2122                 AO2_ALLOC_OPT_LOCK_MUTEX, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT,
2123                 37, bridges_channel_hash_fn, bridges_channel_sort_fn, NULL);
2124         if (!apps_registry || !app_controls || !app_bridges || !app_bridges_moh || !app_bridges_playback) {
2125                 unload_module();
2126                 return AST_MODULE_LOAD_DECLINE;
2127         }
2128
2129         if (messaging_init()) {
2130                 unload_module();
2131                 return AST_MODULE_LOAD_DECLINE;
2132         }
2133
2134         bridge_stasis_init();
2135
2136         stasis_app_register_event_sources();
2137
2138         return AST_MODULE_LOAD_SUCCESS;
2139 }
2140
2141 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS, "Stasis application support",
2142         .load_pri = AST_MODPRI_APP_DEPEND,
2143         .support_level = AST_MODULE_SUPPORT_CORE,
2144         .load = load_module,
2145         .unload = unload_module,
2146 );