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