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