res_stasis and res_speech: Fix load order.
[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         enum ast_bridge_video_mode_type video_mode = AST_BRIDGE_VIDEO_MODE_TALKER_SRC;
770
771         if (invisible) {
772                 flags |= AST_BRIDGE_FLAG_INVISIBLE;
773         }
774
775         while ((requested_type = strsep(&requested_types, ","))) {
776                 requested_type = ast_strip(requested_type);
777
778                 if (!strcmp(requested_type, "mixing")) {
779                         capabilities |= STASIS_BRIDGE_MIXING_CAPABILITIES;
780                         flags |= AST_BRIDGE_FLAG_SMART;
781                 } else if (!strcmp(requested_type, "holding")) {
782                         capabilities |= AST_BRIDGE_CAPABILITY_HOLDING;
783                 } else if (!strcmp(requested_type, "dtmf_events") ||
784                         !strcmp(requested_type, "proxy_media")) {
785                         capabilities &= ~AST_BRIDGE_CAPABILITY_NATIVE;
786                 } else if (!strcmp(requested_type, "video_sfu")) {
787                         video_mode = AST_BRIDGE_VIDEO_MODE_SFU;
788                 }
789         }
790
791         /* For an SFU video bridge we ensure it always remains in multimix for the best experience. */
792         if (video_mode == AST_BRIDGE_VIDEO_MODE_SFU) {
793                 capabilities = AST_BRIDGE_CAPABILITY_MULTIMIX;
794                 flags &= ~AST_BRIDGE_FLAG_SMART;
795         }
796
797         if (!capabilities
798                 /* Holding and mixing capabilities don't mix. */
799                 || ((capabilities & AST_BRIDGE_CAPABILITY_HOLDING)
800                         && (capabilities & (STASIS_BRIDGE_MIXING_CAPABILITIES)))) {
801                 return NULL;
802         }
803
804         bridge = bridge_stasis_new(capabilities, flags, name, id);
805         if (bridge) {
806                 if (video_mode == AST_BRIDGE_VIDEO_MODE_SFU) {
807                         ast_bridge_set_sfu_video_mode(bridge);
808                         /* We require a minimum 5 seconds between video updates to stop floods from clients,
809                          * this should rarely be changed but should become configurable in the future.
810                          */
811                         ast_bridge_set_video_update_discard(bridge, 5);
812                 } else {
813                         ast_bridge_set_talker_src_video_mode(bridge);
814                 }
815                 if (!ao2_link(app_bridges, bridge)) {
816                         ast_bridge_destroy(bridge, 0);
817                         bridge = NULL;
818                 }
819         }
820         return bridge;
821 }
822
823 struct ast_bridge *stasis_app_bridge_create(const char *type, const char *name, const char *id)
824 {
825         return bridge_create_common(type, name, id, 0);
826 }
827
828 struct ast_bridge *stasis_app_bridge_create_invisible(const char *type, const char *name, const char *id)
829 {
830         return bridge_create_common(type, name, id, 1);
831 }
832
833 void stasis_app_bridge_destroy(const char *bridge_id)
834 {
835         struct ast_bridge *bridge = stasis_app_bridge_find_by_id(bridge_id);
836         if (!bridge) {
837                 return;
838         }
839         ao2_unlink(app_bridges, bridge);
840         ast_bridge_destroy(bridge, 0);
841 }
842
843 struct replace_channel_store {
844         struct ast_channel_snapshot *snapshot;
845         char *app;
846 };
847
848 static void replace_channel_destroy(void *obj)
849 {
850         struct replace_channel_store *replace = obj;
851
852         ao2_cleanup(replace->snapshot);
853         ast_free(replace->app);
854         ast_free(replace);
855 }
856
857 static const struct ast_datastore_info replace_channel_store_info = {
858         .type = "replace-channel-store",
859         .destroy = replace_channel_destroy,
860 };
861
862 static struct replace_channel_store *get_replace_channel_store(struct ast_channel *chan, int no_create)
863 {
864         struct ast_datastore *datastore;
865
866         SCOPED_CHANNELLOCK(lock, chan);
867         datastore = ast_channel_datastore_find(chan, &replace_channel_store_info, NULL);
868         if (!datastore) {
869                 if (no_create) {
870                         return NULL;
871                 }
872
873                 datastore = ast_datastore_alloc(&replace_channel_store_info, NULL);
874                 if (!datastore) {
875                         return NULL;
876                 }
877                 ast_channel_datastore_add(chan, datastore);
878         }
879
880         if (!datastore->data) {
881                 datastore->data = ast_calloc(1, sizeof(struct replace_channel_store));
882         }
883         return datastore->data;
884 }
885
886 int app_set_replace_channel_snapshot(struct ast_channel *chan, struct ast_channel_snapshot *replace_snapshot)
887 {
888         struct replace_channel_store *replace = get_replace_channel_store(chan, 0);
889
890         if (!replace) {
891                 return -1;
892         }
893
894         ao2_replace(replace->snapshot, replace_snapshot);
895         return 0;
896 }
897
898 int app_set_replace_channel_app(struct ast_channel *chan, const char *replace_app)
899 {
900         struct replace_channel_store *replace = get_replace_channel_store(chan, 0);
901
902         if (!replace) {
903                 return -1;
904         }
905
906         ast_free(replace->app);
907         replace->app = NULL;
908
909         if (replace_app) {
910                 replace->app = ast_strdup(replace_app);
911                 if (!replace->app) {
912                         return -1;
913                 }
914         }
915
916         return 0;
917 }
918
919 static struct ast_channel_snapshot *get_replace_channel_snapshot(struct ast_channel *chan)
920 {
921         struct replace_channel_store *replace = get_replace_channel_store(chan, 1);
922         struct ast_channel_snapshot *replace_channel_snapshot;
923
924         if (!replace) {
925                 return NULL;
926         }
927
928         replace_channel_snapshot = replace->snapshot;
929         replace->snapshot = NULL;
930
931         return replace_channel_snapshot;
932 }
933
934 char *app_get_replace_channel_app(struct ast_channel *chan)
935 {
936         struct replace_channel_store *replace = get_replace_channel_store(chan, 1);
937         char *replace_channel_app;
938
939         if (!replace) {
940                 return NULL;
941         }
942
943         replace_channel_app = replace->app;
944         replace->app = NULL;
945
946         return replace_channel_app;
947 }
948
949 static void start_message_blob_dtor(void *obj)
950 {
951         struct start_message_blob *payload = obj;
952
953         ao2_cleanup(payload->channel);
954         ao2_cleanup(payload->replace_channel);
955         ast_json_unref(payload->blob);
956 }
957
958 static int send_start_msg_snapshots(struct ast_channel *chan, struct stasis_app *app,
959         int argc, char *argv[], struct ast_channel_snapshot *snapshot,
960         struct ast_channel_snapshot *replace_channel_snapshot)
961 {
962         RAII_VAR(struct ast_json *, json_blob, NULL, ast_json_unref);
963         struct ast_json *json_args;
964         RAII_VAR(struct start_message_blob *, payload, NULL, ao2_cleanup);
965         struct stasis_message *msg;
966         int i;
967
968         if (app_subscribe_channel(app, chan)) {
969                 ast_log(LOG_ERROR, "Error subscribing app '%s' to channel '%s'\n",
970                         stasis_app_name(app), ast_channel_name(chan));
971                 return -1;
972         }
973
974         payload = ao2_alloc(sizeof(*payload), start_message_blob_dtor);
975         if (!payload) {
976                 ast_log(LOG_ERROR, "Error packing JSON for StasisStart message\n");
977                 return -1;
978         }
979
980         payload->channel = ao2_bump(snapshot);
981         payload->replace_channel = ao2_bump(replace_channel_snapshot);
982
983         json_blob = ast_json_pack("{s: s, s: o, s: []}",
984                 "app", stasis_app_name(app),
985                 "timestamp", ast_json_timeval(ast_tvnow(), NULL),
986                 "args");
987         if (!json_blob) {
988                 ast_log(LOG_ERROR, "Error packing JSON for StasisStart message\n");
989                 return -1;
990         }
991
992         /* Append arguments to args array */
993         json_args = ast_json_object_get(json_blob, "args");
994         ast_assert(json_args != NULL);
995         for (i = 0; i < argc; ++i) {
996                 int r = ast_json_array_append(json_args,
997                                               ast_json_string_create(argv[i]));
998                 if (r != 0) {
999                         ast_log(LOG_ERROR, "Error appending to StasisStart message\n");
1000                         return -1;
1001                 }
1002         }
1003
1004         payload->blob = ast_json_ref(json_blob);
1005
1006         msg = stasis_message_create(start_message_type(), payload);
1007         if (!msg) {
1008                 ast_log(LOG_ERROR, "Error sending StasisStart message\n");
1009                 return -1;
1010         }
1011
1012         if (replace_channel_snapshot) {
1013                 app_unsubscribe_channel_id(app, replace_channel_snapshot->uniqueid);
1014         }
1015         stasis_publish(ast_app_get_topic(app), msg);
1016         ao2_ref(msg, -1);
1017         return 0;
1018 }
1019
1020 static int send_start_msg(struct stasis_app *app, struct ast_channel *chan,
1021         int argc, char *argv[])
1022 {
1023         RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
1024         RAII_VAR(struct ast_channel_snapshot *, replace_channel_snapshot,
1025                 NULL, ao2_cleanup);
1026
1027         ast_assert(chan != NULL);
1028
1029         replace_channel_snapshot = get_replace_channel_snapshot(chan);
1030
1031         /* Set channel info */
1032         ast_channel_lock(chan);
1033         snapshot = ast_channel_snapshot_create(chan);
1034         ast_channel_unlock(chan);
1035         if (!snapshot) {
1036                 return -1;
1037         }
1038         return send_start_msg_snapshots(chan, app, argc, argv, snapshot, replace_channel_snapshot);
1039 }
1040
1041 static void remove_masquerade_store(struct ast_channel *chan);
1042
1043 int app_send_end_msg(struct stasis_app *app, struct ast_channel *chan)
1044 {
1045         struct stasis_message_sanitizer *sanitize = stasis_app_get_sanitizer();
1046         struct ast_json *blob;
1047         struct stasis_message *msg;
1048
1049         if (sanitize && sanitize->channel
1050                 && sanitize->channel(chan)) {
1051                 return 0;
1052         }
1053
1054         blob = ast_json_pack("{s: s}", "app", stasis_app_name(app));
1055         if (!blob) {
1056                 ast_log(LOG_ERROR, "Error packing JSON for StasisEnd message\n");
1057                 return -1;
1058         }
1059
1060         remove_masquerade_store(chan);
1061         app_unsubscribe_channel(app, chan);
1062         msg = ast_channel_blob_create(chan, end_message_type(), blob);
1063         if (msg) {
1064                 stasis_publish(ast_app_get_topic(app), msg);
1065         }
1066         ao2_cleanup(msg);
1067         ast_json_unref(blob);
1068
1069         return 0;
1070 }
1071
1072 static int masq_match_cb(void *obj, void *data, int flags)
1073 {
1074         struct stasis_app_control *control = obj;
1075         struct ast_channel *chan = data;
1076
1077         if (!strcmp(ast_channel_uniqueid(chan),
1078                 stasis_app_control_get_channel_id(control))) {
1079                 return CMP_MATCH;
1080         }
1081
1082         return 0;
1083 }
1084
1085 static void channel_stolen_cb(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
1086 {
1087         struct stasis_app_control *control;
1088
1089         /*
1090          * At this point, old_chan is the channel pointer that is in Stasis() and
1091          * has the unknown channel's name in it while new_chan is the channel pointer
1092          * that is not in Stasis(), but has the guts of the channel that Stasis() knows
1093          * about.
1094          *
1095          * Find and unlink control since the channel has a new name/uniqueid
1096          * and its hash has changed.  Since the channel is leaving stasis don't
1097          * bother putting it back into the container.  Nobody is going to
1098          * remove it from the container later.
1099          */
1100         control = ao2_callback(app_controls, OBJ_UNLINK, masq_match_cb, old_chan);
1101         if (!control) {
1102                 ast_log(LOG_ERROR, "Could not find control for masqueraded channel\n");
1103                 return;
1104         }
1105
1106         /* send the StasisEnd message to the app */
1107         stasis_app_channel_set_stasis_end_published(new_chan);
1108         app_send_end_msg(control_app(control), new_chan);
1109
1110         /* remove the datastore */
1111         remove_masquerade_store(old_chan);
1112
1113         ao2_cleanup(control);
1114 }
1115
1116 static void channel_replaced_cb(void *data, struct ast_channel *old_chan, struct ast_channel *new_chan)
1117 {
1118         RAII_VAR(struct ast_channel_snapshot *, new_snapshot, NULL, ao2_cleanup);
1119         RAII_VAR(struct ast_channel_snapshot *, old_snapshot, NULL, ao2_cleanup);
1120         struct stasis_app_control *control;
1121
1122         /* At this point, new_chan is the channel pointer that is in Stasis() and
1123          * has the unknown channel's name in it while old_chan is the channel pointer
1124          * that is not in Stasis(), but has the guts of the channel that Stasis() knows
1125          * about */
1126
1127         /* grab a snapshot for the channel that is jumping into Stasis() */
1128         new_snapshot = ast_channel_snapshot_get_latest(ast_channel_uniqueid(new_chan));
1129         if (!new_snapshot) {
1130                 ast_log(LOG_ERROR, "Could not get snapshot for masquerading channel\n");
1131                 return;
1132         }
1133
1134         /* grab a snapshot for the channel that has been kicked out of Stasis() */
1135         old_snapshot = ast_channel_snapshot_get_latest(ast_channel_uniqueid(old_chan));
1136         if (!old_snapshot) {
1137                 ast_log(LOG_ERROR, "Could not get snapshot for masqueraded channel\n");
1138                 return;
1139         }
1140
1141         /*
1142          * Find, unlink, and relink control since the channel has a new
1143          * name/uniqueid and its hash has changed.
1144          */
1145         control = ao2_callback(app_controls, OBJ_UNLINK, masq_match_cb, new_chan);
1146         if (!control) {
1147                 ast_log(LOG_ERROR, "Could not find control for masquerading channel\n");
1148                 return;
1149         }
1150         ao2_link(app_controls, control);
1151
1152
1153         /* send the StasisStart with replace_channel to the app */
1154         send_start_msg_snapshots(new_chan, control_app(control), 0, NULL, new_snapshot,
1155                 old_snapshot);
1156         /* send the StasisEnd message to the app */
1157         app_send_end_msg(control_app(control), old_chan);
1158
1159         ao2_cleanup(control);
1160 }
1161
1162 static const struct ast_datastore_info masquerade_store_info = {
1163         .type = "stasis-masqerade",
1164         .chan_fixup = channel_stolen_cb,
1165         .chan_breakdown = channel_replaced_cb,
1166 };
1167
1168 static int has_masquerade_store(struct ast_channel *chan)
1169 {
1170         SCOPED_CHANNELLOCK(lock, chan);
1171         return !!ast_channel_datastore_find(chan, &masquerade_store_info, NULL);
1172 }
1173
1174 static int add_masquerade_store(struct ast_channel *chan)
1175 {
1176         struct ast_datastore *datastore;
1177
1178         SCOPED_CHANNELLOCK(lock, chan);
1179         if (ast_channel_datastore_find(chan, &masquerade_store_info, NULL)) {
1180                 return 0;
1181         }
1182
1183         datastore = ast_datastore_alloc(&masquerade_store_info, NULL);
1184         if (!datastore) {
1185                 return -1;
1186         }
1187
1188         ast_channel_datastore_add(chan, datastore);
1189
1190         return 0;
1191 }
1192
1193 static void remove_masquerade_store(struct ast_channel *chan)
1194 {
1195         struct ast_datastore *datastore;
1196
1197         SCOPED_CHANNELLOCK(lock, chan);
1198         datastore = ast_channel_datastore_find(chan, &masquerade_store_info, NULL);
1199         if (!datastore) {
1200                 return;
1201         }
1202
1203         ast_channel_datastore_remove(chan, datastore);
1204         ast_datastore_free(datastore);
1205 }
1206
1207 void stasis_app_control_execute_until_exhausted(struct ast_channel *chan, struct stasis_app_control *control)
1208 {
1209         while (!control_is_done(control)) {
1210                 int command_count;
1211                 command_count = control_dispatch_all(control, chan);
1212
1213                 ao2_lock(control);
1214
1215                 if (control_command_count(control)) {
1216                         /* If the command queue isn't empty, something added to the queue before it was locked. */
1217                         ao2_unlock(control);
1218                         continue;
1219                 }
1220
1221                 if (command_count == 0 || ast_channel_fdno(chan) == -1) {
1222                         control_mark_done(control);
1223                         ao2_unlock(control);
1224                         break;
1225                 }
1226                 ao2_unlock(control);
1227         }
1228 }
1229
1230 int stasis_app_control_is_done(struct stasis_app_control *control)
1231 {
1232         return control_is_done(control);
1233 }
1234
1235 void stasis_app_control_flush_queue(struct stasis_app_control *control)
1236 {
1237         control_flush_queue(control);
1238 }
1239
1240 struct ast_datastore_info set_end_published_info = {
1241         .type = "stasis_end_published",
1242 };
1243
1244 void stasis_app_channel_set_stasis_end_published(struct ast_channel *chan)
1245 {
1246         struct ast_datastore *datastore;
1247
1248         datastore = ast_datastore_alloc(&set_end_published_info, NULL);
1249         if (datastore) {
1250                 ast_channel_lock(chan);
1251                 ast_channel_datastore_add(chan, datastore);
1252                 ast_channel_unlock(chan);
1253         }
1254 }
1255
1256 int stasis_app_channel_is_stasis_end_published(struct ast_channel *chan)
1257 {
1258         struct ast_datastore *datastore;
1259
1260         ast_channel_lock(chan);
1261         datastore = ast_channel_datastore_find(chan, &set_end_published_info, NULL);
1262         ast_channel_unlock(chan);
1263
1264         return datastore ? 1 : 0;
1265 }
1266
1267 static void remove_stasis_end_published(struct ast_channel *chan)
1268 {
1269         struct ast_datastore *datastore;
1270
1271         ast_channel_lock(chan);
1272         datastore = ast_channel_datastore_find(chan, &set_end_published_info, NULL);
1273         if (datastore) {
1274                 ast_channel_datastore_remove(chan, datastore);
1275                 ast_datastore_free(datastore);
1276         }
1277         ast_channel_unlock(chan);
1278 }
1279
1280 /*! /brief Stasis dialplan application callback */
1281 int stasis_app_exec(struct ast_channel *chan, const char *app_name, int argc,
1282                     char *argv[])
1283 {
1284         SCOPED_MODULE_USE(ast_module_info->self);
1285
1286         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1287         RAII_VAR(struct stasis_app_control *, control, NULL, control_unlink);
1288         struct ast_bridge *bridge = NULL;
1289         int res = 0;
1290         int needs_depart;
1291
1292         ast_assert(chan != NULL);
1293
1294         /* Just in case there's a lingering indication that the channel has had a stasis
1295          * end published on it, remove that now.
1296          */
1297         remove_stasis_end_published(chan);
1298
1299         if (!apps_registry) {
1300                 return -1;
1301         }
1302
1303         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1304         if (!app) {
1305                 ast_log(LOG_ERROR,
1306                         "Stasis app '%s' not registered\n", app_name);
1307                 return -1;
1308         }
1309         if (!app_is_active(app)) {
1310                 ast_log(LOG_ERROR,
1311                         "Stasis app '%s' not active\n", app_name);
1312                 return -1;
1313         }
1314
1315         control = control_create(chan, app);
1316         if (!control) {
1317                 ast_log(LOG_ERROR, "Allocated failed\n");
1318                 return -1;
1319         }
1320         ao2_link(app_controls, control);
1321
1322         if (add_masquerade_store(chan)) {
1323                 ast_log(LOG_ERROR, "Failed to attach masquerade detector\n");
1324                 return -1;
1325         }
1326
1327         res = send_start_msg(app, chan, argc, argv);
1328         if (res != 0) {
1329                 ast_log(LOG_ERROR,
1330                         "Error sending start message to '%s'\n", app_name);
1331                 remove_masquerade_store(chan);
1332                 return -1;
1333         }
1334
1335         /* Pull queued prestart commands and execute */
1336         control_prestart_dispatch_all(control, chan);
1337
1338         while (!control_is_done(control)) {
1339                 RAII_VAR(struct ast_frame *, f, NULL, ast_frame_dtor);
1340                 int r;
1341                 int command_count;
1342                 RAII_VAR(struct ast_bridge *, last_bridge, NULL, ao2_cleanup);
1343
1344                 /* Check to see if a bridge absorbed our hangup frame */
1345                 if (ast_check_hangup_locked(chan)) {
1346                         control_mark_done(control);
1347                         break;
1348                 }
1349
1350                 last_bridge = bridge;
1351                 bridge = ao2_bump(stasis_app_get_bridge(control));
1352
1353                 if (bridge != last_bridge) {
1354                         if (last_bridge) {
1355                                 app_unsubscribe_bridge(app, last_bridge);
1356                         }
1357                         if (bridge) {
1358                                 app_subscribe_bridge(app, bridge);
1359                         }
1360                 }
1361
1362                 if (bridge) {
1363                         /* Bridge/dial is handling channel frames */
1364                         control_wait(control);
1365                         control_dispatch_all(control, chan);
1366                         continue;
1367                 }
1368
1369                 r = ast_waitfor(chan, MAX_WAIT_MS);
1370
1371                 if (r < 0) {
1372                         ast_debug(3, "%s: Poll error\n",
1373                                   ast_channel_uniqueid(chan));
1374                         control_mark_done(control);
1375                         break;
1376                 }
1377
1378                 command_count = control_dispatch_all(control, chan);
1379
1380                 if (command_count > 0 && ast_channel_fdno(chan) == -1) {
1381                         /* Command drained the channel; wait for next frame */
1382                         continue;
1383                 }
1384
1385                 if (r == 0) {
1386                         /* Timeout */
1387                         continue;
1388                 }
1389
1390                 f = ast_read(chan);
1391                 if (!f) {
1392                         /* Continue on in the dialplan */
1393                         ast_debug(3, "%s: Hangup (no more frames)\n",
1394                                 ast_channel_uniqueid(chan));
1395                         control_mark_done(control);
1396                         break;
1397                 }
1398
1399                 if (f->frametype == AST_FRAME_CONTROL) {
1400                         if (f->subclass.integer == AST_CONTROL_HANGUP) {
1401                                 /* Continue on in the dialplan */
1402                                 ast_debug(3, "%s: Hangup\n",
1403                                         ast_channel_uniqueid(chan));
1404                                 control_mark_done(control);
1405                                 break;
1406                         }
1407                 }
1408         }
1409
1410         ast_channel_lock(chan);
1411         needs_depart = (ast_channel_internal_bridge_channel(chan) != NULL);
1412         ast_channel_unlock(chan);
1413         if (needs_depart) {
1414                 ast_bridge_depart(chan);
1415         }
1416
1417         if (stasis_app_get_bridge(control)) {
1418                 app_unsubscribe_bridge(app, stasis_app_get_bridge(control));
1419         }
1420         ao2_cleanup(bridge);
1421
1422         /* Only publish a stasis_end event if it hasn't already been published */
1423         if (!stasis_app_channel_is_stasis_end_published(chan)) {
1424                 /* A masquerade has occurred and this message will be wrong so it
1425                  * has already been sent elsewhere. */
1426                 res = has_masquerade_store(chan) && app_send_end_msg(app, chan);
1427                 if (res != 0) {
1428                         ast_log(LOG_ERROR,
1429                                 "Error sending end message to %s\n", app_name);
1430                         return res;
1431                 }
1432         } else {
1433                 remove_stasis_end_published(chan);
1434         }
1435
1436         control_flush_queue(control);
1437
1438         /* Stop any lingering silence generator */
1439         control_silence_stop_now(control);
1440
1441         /* There's an off chance that app is ready for cleanup. Go ahead
1442          * and clean up, just in case
1443          */
1444         cleanup();
1445
1446         /* The control needs to be removed from the controls container in
1447          * case a new PBX is started and ends up coming back into Stasis.
1448          */
1449         ao2_cleanup(app);
1450         app = NULL;
1451         control_unlink(control);
1452         control = NULL;
1453
1454         if (!ast_channel_pbx(chan)) {
1455                 int chan_hungup;
1456
1457                 /* The ASYNCGOTO softhangup flag may have broken the channel out of
1458                  * its bridge to run dialplan, so if there's no pbx on the channel
1459                  * let it run dialplan here. Otherwise, it will run when this
1460                  * application exits. */
1461                 ast_channel_lock(chan);
1462                 ast_channel_clear_softhangup(chan, AST_SOFTHANGUP_ASYNCGOTO);
1463                 chan_hungup = ast_check_hangup(chan);
1464                 ast_channel_unlock(chan);
1465
1466                 if (!chan_hungup) {
1467                         struct ast_pbx_args pbx_args;
1468
1469                         memset(&pbx_args, 0, sizeof(pbx_args));
1470                         pbx_args.no_hangup_chan = 1;
1471
1472                         res = ast_pbx_run_args(chan, &pbx_args);
1473                 }
1474         }
1475
1476         return res;
1477 }
1478
1479 int stasis_app_send(const char *app_name, struct ast_json *message)
1480 {
1481         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1482
1483         if (!apps_registry) {
1484                 return -1;
1485         }
1486
1487         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1488         if (!app) {
1489                 /* XXX We can do a better job handling late binding, queueing up
1490                  * the call for a few seconds to wait for the app to register.
1491                  */
1492                 ast_log(LOG_WARNING,
1493                         "Stasis app '%s' not registered\n", app_name);
1494                 return -1;
1495         }
1496         app_send(app, message);
1497         return 0;
1498 }
1499
1500 static struct stasis_app *find_app_by_name(const char *app_name)
1501 {
1502         struct stasis_app *res = NULL;
1503
1504         if (!apps_registry) {
1505                 return NULL;
1506         }
1507
1508         if (!ast_strlen_zero(app_name)) {
1509                 res = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1510         }
1511
1512         return res;
1513 }
1514
1515 struct stasis_app *stasis_app_get_by_name(const char *name)
1516 {
1517         return find_app_by_name(name);
1518 }
1519
1520 static int append_name(void *obj, void *arg, int flags)
1521 {
1522         struct stasis_app *app = obj;
1523         struct ao2_container *apps = arg;
1524
1525         ast_str_container_add(apps, stasis_app_name(app));
1526         return 0;
1527 }
1528
1529 struct ao2_container *stasis_app_get_all(void)
1530 {
1531         RAII_VAR(struct ao2_container *, apps, NULL, ao2_cleanup);
1532
1533         if (!apps_registry) {
1534                 return NULL;
1535         }
1536
1537         apps = ast_str_container_alloc(1);
1538         if (!apps) {
1539                 return NULL;
1540         }
1541
1542         ao2_callback(apps_registry, OBJ_NODATA, append_name, apps);
1543
1544         return ao2_bump(apps);
1545 }
1546
1547 static int __stasis_app_register(const char *app_name, stasis_app_cb handler, void *data, int all_events)
1548 {
1549         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1550
1551         if (!apps_registry) {
1552                 return -1;
1553         }
1554
1555         ao2_lock(apps_registry);
1556         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY | OBJ_NOLOCK);
1557         if (app) {
1558                 app_update(app, handler, data);
1559         } else {
1560                 app = app_create(app_name, handler, data, all_events ? STASIS_APP_SUBSCRIBE_ALL : STASIS_APP_SUBSCRIBE_MANUAL);
1561                 if (app) {
1562                         if (all_events) {
1563                                 struct stasis_app_event_source *source;
1564                                 SCOPED_LOCK(lock, &event_sources, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
1565
1566                                 AST_LIST_TRAVERSE(&event_sources, source, next) {
1567                                         if (!source->subscribe) {
1568                                                 continue;
1569                                         }
1570
1571                                         source->subscribe(app, NULL);
1572                                 }
1573                         }
1574                         ao2_link_flags(apps_registry, app, OBJ_NOLOCK);
1575                 } else {
1576                         ao2_unlock(apps_registry);
1577                         return -1;
1578                 }
1579         }
1580
1581         /* We lazily clean up the apps_registry, because it's good enough to
1582          * prevent memory leaks, and we're lazy.
1583          */
1584         cleanup();
1585         ao2_unlock(apps_registry);
1586         return 0;
1587 }
1588
1589 int stasis_app_register(const char *app_name, stasis_app_cb handler, void *data)
1590 {
1591         return __stasis_app_register(app_name, handler, data, 0);
1592 }
1593
1594 int stasis_app_register_all(const char *app_name, stasis_app_cb handler, void *data)
1595 {
1596         return __stasis_app_register(app_name, handler, data, 1);
1597 }
1598
1599 void stasis_app_unregister(const char *app_name)
1600 {
1601         RAII_VAR(struct stasis_app *, app, NULL, ao2_cleanup);
1602
1603         if (!app_name) {
1604                 return;
1605         }
1606
1607         if (!apps_registry) {
1608                 return;
1609         }
1610
1611         app = ao2_find(apps_registry, app_name, OBJ_SEARCH_KEY);
1612         if (!app) {
1613                 ast_log(LOG_ERROR,
1614                         "Stasis app '%s' not registered\n", app_name);
1615                 return;
1616         }
1617
1618         app_deactivate(app);
1619
1620         /* There's a decent chance that app is ready for cleanup. Go ahead
1621          * and clean up, just in case
1622          */
1623         cleanup();
1624 }
1625
1626 void stasis_app_register_event_source(struct stasis_app_event_source *obj)
1627 {
1628         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
1629         AST_LIST_INSERT_TAIL(&event_sources, obj, next);
1630         /* only need to bump the module ref on non-core sources because the
1631            core ones are [un]registered by this module. */
1632         if (!stasis_app_is_core_event_source(obj)) {
1633                 ast_module_ref(ast_module_info->self);
1634         }
1635 }
1636
1637 void stasis_app_unregister_event_source(struct stasis_app_event_source *obj)
1638 {
1639         struct stasis_app_event_source *source;
1640         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_WRLOCK, AST_RWLIST_UNLOCK);
1641         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&event_sources, source, next) {
1642                 if (source == obj) {
1643                         AST_RWLIST_REMOVE_CURRENT(next);
1644                         if (!stasis_app_is_core_event_source(obj)) {
1645                                 ast_module_unref(ast_module_info->self);
1646                         }
1647                         break;
1648                 }
1649         }
1650         AST_RWLIST_TRAVERSE_SAFE_END;
1651 }
1652
1653 /*!
1654  * \internal
1655  * \brief Convert event source data to JSON.
1656  *
1657  * Calls each event source that has a "to_json" handler allowing each
1658  * source to add data to the given JSON object.
1659  *
1660  * \param app application associated with the event source
1661  * \param json a json object to "fill"
1662  *
1663  * \retval The given json object.
1664  */
1665 static struct ast_json *app_event_sources_to_json(
1666         const struct stasis_app *app, struct ast_json *json)
1667 {
1668         struct stasis_app_event_source *source;
1669         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
1670         AST_LIST_TRAVERSE(&event_sources, source, next) {
1671                 if (source->to_json) {
1672                         source->to_json(app, json);
1673                 }
1674         }
1675         return json;
1676 }
1677
1678 static struct ast_json *stasis_app_object_to_json(struct stasis_app *app)
1679 {
1680         if (!app) {
1681                 return NULL;
1682         }
1683
1684         return app_event_sources_to_json(app, app_to_json(app));
1685 }
1686
1687 struct ast_json *stasis_app_to_json(const char *app_name)
1688 {
1689         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1690
1691         return stasis_app_object_to_json(app);
1692 }
1693
1694 /*!
1695  * \internal
1696  * \brief Finds an event source that matches a uri scheme.
1697  *
1698  * Uri(s) should begin with a particular scheme that can be matched
1699  * against an event source.
1700  *
1701  * \param uri uri containing a scheme to match
1702  *
1703  * \retval an event source if found, NULL otherwise.
1704  */
1705 static struct stasis_app_event_source *app_event_source_find(const char *uri)
1706 {
1707         struct stasis_app_event_source *source;
1708         SCOPED_LOCK(lock, &event_sources, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK);
1709         AST_LIST_TRAVERSE(&event_sources, source, next) {
1710                 if (ast_begins_with(uri, source->scheme)) {
1711                         return source;
1712                 }
1713         }
1714         return NULL;
1715 }
1716
1717 /*!
1718  * \internal
1719  * \brief Callback for subscription handling
1720  *
1721  * \param app [un]subscribing application
1722  * \param uri scheme:id of an event source
1723  * \param event_source being [un]subscribed [from]to
1724  *
1725  * \retval stasis_app_subscribe_res return code.
1726  */
1727 typedef enum stasis_app_subscribe_res (*app_subscription_handler)(
1728         struct stasis_app *app, const char *uri,
1729         struct stasis_app_event_source *event_source);
1730
1731 /*!
1732  * \internal
1733  * \brief Subscriptions handler for application [un]subscribing.
1734  *
1735  * \param app_name Name of the application to subscribe.
1736  * \param event_source_uris URIs for the event sources to subscribe to.
1737  * \param event_sources_count Array size of event_source_uris.
1738  * \param json Optional output pointer for JSON representation of the app
1739  *             after adding the subscription.
1740  * \param handler [un]subscribe handler
1741  *
1742  * \retval stasis_app_subscribe_res return code.
1743  */
1744 static enum stasis_app_subscribe_res app_handle_subscriptions(
1745         const char *app_name, const char **event_source_uris,
1746         int event_sources_count, struct ast_json **json,
1747         app_subscription_handler handler)
1748 {
1749         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1750         int i;
1751
1752         if (!app) {
1753                 return STASIS_ASR_APP_NOT_FOUND;
1754         }
1755
1756         for (i = 0; i < event_sources_count; ++i) {
1757                 const char *uri = event_source_uris[i];
1758                 enum stasis_app_subscribe_res res = STASIS_ASR_INTERNAL_ERROR;
1759                 struct stasis_app_event_source *event_source;
1760
1761                 if (!(event_source = app_event_source_find(uri))) {
1762                         ast_log(LOG_WARNING, "Invalid scheme: %s\n", uri);
1763                         return STASIS_ASR_EVENT_SOURCE_BAD_SCHEME;
1764                 }
1765
1766                 if (handler &&
1767                     ((res = handler(app, uri, event_source)))) {
1768                         return res;
1769                 }
1770         }
1771
1772         if (json) {
1773                 ast_debug(3, "%s: Successful; setting results\n", app_name);
1774                 *json = stasis_app_object_to_json(app);
1775         }
1776
1777         return STASIS_ASR_OK;
1778 }
1779
1780 enum stasis_app_subscribe_res stasis_app_subscribe_channel(const char *app_name,
1781         struct ast_channel *chan)
1782 {
1783         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1784         int res;
1785
1786         if (!app) {
1787                 return STASIS_ASR_APP_NOT_FOUND;
1788         }
1789
1790         ast_debug(3, "%s: Subscribing to %s\n", app_name, ast_channel_uniqueid(chan));
1791
1792         res = app_subscribe_channel(app, chan);
1793         if (res != 0) {
1794                 ast_log(LOG_ERROR, "Error subscribing app '%s' to channel '%s'\n",
1795                         app_name, ast_channel_uniqueid(chan));
1796                 return STASIS_ASR_INTERNAL_ERROR;
1797         }
1798
1799         return STASIS_ASR_OK;
1800 }
1801
1802
1803 /*!
1804  * \internal
1805  * \brief Subscribe an app to an event source.
1806  *
1807  * \param app subscribing application
1808  * \param uri scheme:id of an event source
1809  * \param event_source being subscribed to
1810  *
1811  * \retval stasis_app_subscribe_res return code.
1812  */
1813 static enum stasis_app_subscribe_res app_subscribe(
1814         struct stasis_app *app, const char *uri,
1815         struct stasis_app_event_source *event_source)
1816 {
1817         const char *app_name = stasis_app_name(app);
1818         RAII_VAR(void *, obj, NULL, ao2_cleanup);
1819
1820         ast_debug(3, "%s: Checking %s\n", app_name, uri);
1821
1822         if (!ast_strlen_zero(uri + strlen(event_source->scheme)) &&
1823             (!event_source->find || (!(obj = event_source->find(app, uri + strlen(event_source->scheme)))))) {
1824                 ast_log(LOG_WARNING, "Event source not found: %s\n", uri);
1825                 return STASIS_ASR_EVENT_SOURCE_NOT_FOUND;
1826         }
1827
1828         ast_debug(3, "%s: Subscribing to %s\n", app_name, uri);
1829
1830         if (!event_source->subscribe || (event_source->subscribe(app, obj))) {
1831                 ast_log(LOG_WARNING, "Error subscribing app '%s' to '%s'\n",
1832                         app_name, uri);
1833                 return STASIS_ASR_INTERNAL_ERROR;
1834         }
1835
1836         return STASIS_ASR_OK;
1837 }
1838
1839 enum stasis_app_subscribe_res stasis_app_subscribe(const char *app_name,
1840         const char **event_source_uris, int event_sources_count,
1841         struct ast_json **json)
1842 {
1843         return app_handle_subscriptions(
1844                 app_name, event_source_uris, event_sources_count,
1845                 json, app_subscribe);
1846 }
1847
1848 /*!
1849  * \internal
1850  * \brief Unsubscribe an app from an event source.
1851  *
1852  * \param app application to unsubscribe
1853  * \param uri scheme:id of an event source
1854  * \param event_source being unsubscribed from
1855  *
1856  * \retval stasis_app_subscribe_res return code.
1857  */
1858 static enum stasis_app_subscribe_res app_unsubscribe(
1859         struct stasis_app *app, const char *uri,
1860         struct stasis_app_event_source *event_source)
1861 {
1862         const char *app_name = stasis_app_name(app);
1863         const char *id = uri + strlen(event_source->scheme);
1864
1865         if (!event_source->is_subscribed ||
1866             (!event_source->is_subscribed(app, id))) {
1867                 return STASIS_ASR_EVENT_SOURCE_NOT_FOUND;
1868         }
1869
1870         ast_debug(3, "%s: Unsubscribing from %s\n", app_name, uri);
1871
1872         if (!event_source->unsubscribe || (event_source->unsubscribe(app, id))) {
1873                 ast_log(LOG_WARNING, "Error unsubscribing app '%s' to '%s'\n",
1874                         app_name, uri);
1875                 return -1;
1876         }
1877         return 0;
1878 }
1879
1880 enum stasis_app_subscribe_res stasis_app_unsubscribe(const char *app_name,
1881         const char **event_source_uris, int event_sources_count,
1882         struct ast_json **json)
1883 {
1884         return app_handle_subscriptions(
1885                 app_name, event_source_uris, event_sources_count,
1886                 json, app_unsubscribe);
1887 }
1888
1889 enum stasis_app_user_event_res stasis_app_user_event(const char *app_name,
1890         const char *event_name,
1891         const char **source_uris, int sources_count,
1892         struct ast_json *json_variables)
1893 {
1894         RAII_VAR(struct stasis_app *, app, find_app_by_name(app_name), ao2_cleanup);
1895         RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1896         RAII_VAR(struct ast_multi_object_blob *, multi, NULL, ao2_cleanup);
1897         RAII_VAR(void *, obj, NULL, ao2_cleanup);
1898         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
1899         enum stasis_app_user_event_res res = STASIS_APP_USER_INTERNAL_ERROR;
1900         struct ast_json *json_value;
1901         int have_channel = 0;
1902         int i;
1903
1904         if (!app) {
1905                 ast_log(LOG_WARNING, "App %s not found\n", app_name);
1906                 return STASIS_APP_USER_APP_NOT_FOUND;
1907         }
1908
1909         if (!ast_multi_user_event_type()) {
1910                 return res;
1911         }
1912
1913         blob = json_variables;
1914         if (!blob) {
1915                 blob = ast_json_pack("{}");
1916         } else {
1917                 ast_json_ref(blob);
1918         }
1919         json_value = ast_json_string_create(event_name);
1920         if (!json_value) {
1921                 ast_log(LOG_ERROR, "unable to create json string\n");
1922                 return res;
1923         }
1924         if (ast_json_object_set(blob, "eventname", json_value)) {
1925                 ast_log(LOG_ERROR, "unable to set eventname to blob\n");
1926                 return res;
1927         }
1928
1929         multi = ast_multi_object_blob_create(blob);
1930
1931         for (i = 0; i < sources_count; ++i) {
1932                 const char *uri = source_uris[i];
1933                 void *snapshot=NULL;
1934                 enum stasis_user_multi_object_snapshot_type type;
1935
1936                 if (ast_begins_with(uri, "channel:")) {
1937                         type = STASIS_UMOS_CHANNEL;
1938                         snapshot = ast_channel_snapshot_get_latest(uri + 8);
1939                         have_channel = 1;
1940                 } else if (ast_begins_with(uri, "bridge:")) {
1941                         type = STASIS_UMOS_BRIDGE;
1942                         snapshot = ast_bridge_snapshot_get_latest(uri + 7);
1943                 } else if (ast_begins_with(uri, "endpoint:")) {
1944                         type = STASIS_UMOS_ENDPOINT;
1945                         snapshot = ast_endpoint_latest_snapshot(uri + 9, NULL);
1946                 } else {
1947                         ast_log(LOG_WARNING, "Invalid scheme: %s\n", uri);
1948                         return STASIS_APP_USER_EVENT_SOURCE_BAD_SCHEME;
1949                 }
1950                 if (!snapshot) {
1951                         ast_log(LOG_ERROR, "Unable to get snapshot for %s\n", uri);
1952                         return STASIS_APP_USER_EVENT_SOURCE_NOT_FOUND;
1953                 }
1954                 ast_multi_object_blob_add(multi, type, snapshot);
1955         }
1956
1957         message = stasis_message_create(ast_multi_user_event_type(), multi);
1958         if (!message) {
1959                 ast_log(LOG_ERROR, "Unable to create stasis user event message\n");
1960                 return res;
1961         }
1962
1963         /*
1964          * Publishing to two different topics is normally to be avoided -- except
1965          * in this case both are final destinations with no forwards (only listeners).
1966          * The message has to be delivered to the application topic for ARI, but a
1967          * copy is also delivered directly to the manager for AMI if there is a channel.
1968          */
1969         stasis_publish(ast_app_get_topic(app), message);
1970
1971         if (have_channel) {
1972                 stasis_publish(ast_manager_get_topic(), message);
1973         }
1974
1975         return STASIS_APP_USER_OK;
1976 }
1977
1978 void stasis_app_ref(void)
1979 {
1980         ast_module_ref(ast_module_info->self);
1981 }
1982
1983 void stasis_app_unref(void)
1984 {
1985         ast_module_unref(ast_module_info->self);
1986 }
1987
1988 static int unload_module(void)
1989 {
1990         stasis_app_unregister_event_sources();
1991
1992         messaging_cleanup();
1993
1994         cleanup();
1995         ao2_cleanup(apps_registry);
1996         apps_registry = NULL;
1997
1998         ao2_cleanup(app_controls);
1999         app_controls = NULL;
2000
2001         ao2_cleanup(app_bridges);
2002         app_bridges = NULL;
2003
2004         ao2_cleanup(app_bridges_moh);
2005         app_bridges_moh = NULL;
2006
2007         ao2_cleanup(app_bridges_playback);
2008         app_bridges_playback = NULL;
2009
2010         stasis_app_control_shutdown();
2011
2012         STASIS_MESSAGE_TYPE_CLEANUP(end_message_type);
2013         STASIS_MESSAGE_TYPE_CLEANUP(start_message_type);
2014
2015         return 0;
2016 }
2017
2018 /* \brief Sanitization callback for channel snapshots */
2019 static int channel_snapshot_sanitizer(const struct ast_channel_snapshot *snapshot)
2020 {
2021         if (!snapshot || !(snapshot->tech_properties & AST_CHAN_TP_INTERNAL)) {
2022                 return 0;
2023         }
2024         return 1;
2025 }
2026
2027 /* \brief Sanitization callback for channels */
2028 static int channel_sanitizer(const struct ast_channel *chan)
2029 {
2030         if (!chan || !(ast_channel_tech(chan)->properties & AST_CHAN_TP_INTERNAL)) {
2031                 return 0;
2032         }
2033         return 1;
2034 }
2035
2036 /* \brief Sanitization callback for channel unique IDs */
2037 static int channel_id_sanitizer(const char *id)
2038 {
2039         RAII_VAR(struct ast_channel_snapshot *, snapshot, ast_channel_snapshot_get_latest(id), ao2_cleanup);
2040
2041         return channel_snapshot_sanitizer(snapshot);
2042 }
2043
2044 /* \brief Sanitization callbacks for communication to Stasis applications */
2045 struct stasis_message_sanitizer app_sanitizer = {
2046         .channel_id = channel_id_sanitizer,
2047         .channel_snapshot = channel_snapshot_sanitizer,
2048         .channel = channel_sanitizer,
2049 };
2050
2051 struct stasis_message_sanitizer *stasis_app_get_sanitizer(void)
2052 {
2053         return &app_sanitizer;
2054 }
2055
2056 static const struct ast_datastore_info stasis_internal_channel_info = {
2057         .type = "stasis-internal-channel",
2058 };
2059
2060 static int set_internal_datastore(struct ast_channel *chan)
2061 {
2062         struct ast_datastore *datastore;
2063
2064         datastore = ast_channel_datastore_find(chan, &stasis_internal_channel_info, NULL);
2065         if (!datastore) {
2066                 datastore = ast_datastore_alloc(&stasis_internal_channel_info, NULL);
2067                 if (!datastore) {
2068                         return -1;
2069                 }
2070                 ast_channel_datastore_add(chan, datastore);
2071         }
2072         return 0;
2073 }
2074
2075 int stasis_app_channel_unreal_set_internal(struct ast_channel *chan)
2076 {
2077         struct ast_channel *outchan = NULL, *outowner = NULL;
2078         int res = 0;
2079         struct ast_unreal_pvt *unreal_pvt = ast_channel_tech_pvt(chan);
2080
2081         ao2_ref(unreal_pvt, +1);
2082         ast_unreal_lock_all(unreal_pvt, &outowner, &outchan);
2083         if (outowner) {
2084                 res |= set_internal_datastore(outowner);
2085                 ast_channel_unlock(outowner);
2086                 ast_channel_unref(outowner);
2087         }
2088         if (outchan) {
2089                 res |= set_internal_datastore(outchan);
2090                 ast_channel_unlock(outchan);
2091                 ast_channel_unref(outchan);
2092         }
2093         ao2_unlock(unreal_pvt);
2094         ao2_ref(unreal_pvt, -1);
2095         return res;
2096 }
2097
2098 int stasis_app_channel_set_internal(struct ast_channel *chan)
2099 {
2100         int res;
2101
2102         ast_channel_lock(chan);
2103         res = set_internal_datastore(chan);
2104         ast_channel_unlock(chan);
2105
2106         return res;
2107 }
2108
2109 int stasis_app_channel_is_internal(struct ast_channel *chan)
2110 {
2111         struct ast_datastore *datastore;
2112         int res = 0;
2113
2114         ast_channel_lock(chan);
2115         datastore = ast_channel_datastore_find(chan, &stasis_internal_channel_info, NULL);
2116         if (datastore) {
2117                 res = 1;
2118         }
2119         ast_channel_unlock(chan);
2120
2121         return res;
2122 }
2123
2124 static int load_module(void)
2125 {
2126         if (STASIS_MESSAGE_TYPE_INIT(start_message_type) != 0) {
2127                 return AST_MODULE_LOAD_DECLINE;
2128         }
2129         if (STASIS_MESSAGE_TYPE_INIT(end_message_type) != 0) {
2130                 return AST_MODULE_LOAD_DECLINE;
2131         }
2132         apps_registry = ao2_container_alloc(APPS_NUM_BUCKETS, app_hash, app_compare);
2133         app_controls = ao2_container_alloc(CONTROLS_NUM_BUCKETS, control_hash, control_compare);
2134         app_bridges = ao2_container_alloc(BRIDGES_NUM_BUCKETS, bridges_hash, bridges_compare);
2135         app_bridges_moh = ao2_container_alloc_hash(
2136                 AO2_ALLOC_OPT_LOCK_MUTEX, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT,
2137                 37, bridges_channel_hash_fn, bridges_channel_sort_fn, NULL);
2138         app_bridges_playback = ao2_container_alloc_hash(
2139                 AO2_ALLOC_OPT_LOCK_MUTEX, AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT,
2140                 37, bridges_channel_hash_fn, bridges_channel_sort_fn, NULL);
2141         if (!apps_registry || !app_controls || !app_bridges || !app_bridges_moh || !app_bridges_playback) {
2142                 unload_module();
2143                 return AST_MODULE_LOAD_DECLINE;
2144         }
2145
2146         if (messaging_init()) {
2147                 unload_module();
2148                 return AST_MODULE_LOAD_DECLINE;
2149         }
2150
2151         bridge_stasis_init();
2152
2153         stasis_app_register_event_sources();
2154
2155         return AST_MODULE_LOAD_SUCCESS;
2156 }
2157
2158 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Stasis application support",
2159         .load_pri = AST_MODPRI_APP_DEPEND - 1,
2160         .support_level = AST_MODULE_SUPPORT_CORE,
2161         .load = load_module,
2162         .unload = unload_module,
2163 );