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