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