sysmocom/asterisk
11
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
asterisk/main/stasis_bridging.c
David M. Lee c9a3d4562d Update events to use Swagger 1.3 subtyping, and related aftermath 
This patch started with the simple idea of changing the /events data
model to be more sane. The original model would send out events like:

    { "stasis_start": { "args": [], "channel": { ... } } }

The event discriminator was the field name instead of being a value in
the object, due to limitations in how Swagger 1.1 could model objects.
While technically sufficient in communicating event information, it was
really difficult to deal with in terms of client side JSON handling.

This patch takes advantage of a proposed extension[1] to Swagger which
allows type variance through the use of a discriminator field. This had
a domino effect that made this a surprisingly large patch.

 [1]: https://groups.google.com/d/msg/wordnik-api/EC3rGajE0os/ey_5dBI_jWcJ

In changing the models, I also had to change the swagger_model.py
processor so it can handle the type discriminator and subtyping. I took
that a big step forward, and using that information to generate an
ari_model module, which can validate a JSON object against the Swagger
model.

The REST and WebSocket generators were changed to take advantage of the
validators. If compiled with AST_DEVMODE enabled, JSON objects that
don't match their corresponding models will not be sent out. For REST
API calls, a 500 Internal Server response is sent. For WebSockets, the
invalid JSON message is replaced with an error message.

Since this took over about half of the job of the existing JSON
generators, and the .to_json virtual function on messages took over the
other half, I reluctantly removed the generators.

The validators turned up all sorts of errors and inconsistencies in our
data models, and the code. These were cleaned up, with checks in the
code generator avoid some of the consistency problems in the future.

 * The model for a channel snapshot was trimmed down to match the
   information sent via AMI. Many of the field being sent were not
   useful in the general case.
 * The model for a bridge snapshot was updated to be more consistent
   with the other ARI models.

Another impact of introducing subtyping was that the swagger-codegen
documentation generator was insufficient (at least until it catches up
with Swagger 1.2). I wanted it to be easier to generate docs for the API
anyways, so I ported the wiki pages to use the Asterisk Swagger
generator. In the process, I was able to clean up many of the model
links, which would occasionally give inconsistent results on the wiki. I
also added error responses to the wiki docs, making the wiki
documentation more complete.

Finally, since Stasis-HTTP will now be named Asterisk REST Interface
(ARI), any new functions and files I created carry the ari_ prefix. I
changed a few stasis_http references to ari where it was non-intrusive
and made sense.

(closes issue ASTERISK-21885)
Review: https://reviewboard.asterisk.org/r/2639/



git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@393529 65c4cc65-6c06-0410-ace0-fbb531ad65f3
2013-07-03 16:32:41 +00:00

1064 lines
36 KiB
C
Raw Blame History

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2013, Digium, Inc.
*
* Kinsey Moore <kmoore@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief Stasis Messages and Data Types for Bridge Objects
*
* \author Kinsey Moore <kmoore@digium.com>
*/
/*** MODULEINFO
<support_level>core</support_level>
***/
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include "asterisk/astobj2.h"
#include "asterisk/stasis.h"
#include "asterisk/channel.h"
#include "asterisk/stasis_bridging.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/bridging.h"
#include "asterisk/bridging_technology.h"
#define SNAPSHOT_CHANNELS_BUCKETS 13
/*** DOCUMENTATION
<managerEvent language="en_US" name="BlindTransfer">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a blind transfer is complete.</synopsis>
<syntax>
<parameter name="Result">
<para>Indicates if the transfer was successful or if it failed.</para>
<enumlist>
<enum name="Fail"><para>An internal error occurred.</para></enum>
<enum name="Invalid"><para>Invalid configuration for transfer (e.g. Not bridged)</para></enum>
<enum name="Not Permitted"><para>Bridge does not permit transfers</para></enum>
<enum name="Success"><para>Transfer completed successfully</para></enum>
</enumlist>
<note><para>A result of <literal>Success</literal> does not necessarily mean that a target was succesfully
contacted. It means that a party was succesfully placed into the dialplan at the expected location.</para></note>
</parameter>
<parameter name="TransfererChannel">
<para>The name of the channel that performed the transfer</para>
</parameter>
<parameter name="TransfererChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
</parameter>
<parameter name="TransfererCallerIDNum">
</parameter>
<parameter name="TransfererCallerIDName">
</parameter>
<parameter name="TransfererConnectedLineNum">
</parameter>
<parameter name="TransfererConnectedLineName">
</parameter>
<parameter name="TransfererAccountCode">
</parameter>
<parameter name="TransfererContext">
</parameter>
<parameter name="TransfererExten">
</parameter>
<parameter name="TransfererPriority">
</parameter>
<parameter name="TransfererUniqueid">
</parameter>
<parameter name="BridgeUniqueid">
<para>The ID of the bridge where the Transferer performed the transfer</para>
</parameter>
<parameter name="BridgeType">
<para>The type of the bridge where the Transferer performed the transfer</para>
</parameter>
<parameter name="IsExternal">
<para>Indicates if the transfer was performed outside of Asterisk. For instance,
a channel protocol native transfer is external. A DTMF transfer is internal.</para>
<enumlist>
<enum name="Yes" />
<enum name="No" />
</enumlist>
</parameter>
<parameter name="Context">
<para>Destination context for the blind transfer.</para>
</parameter>
<parameter name="Extension">
<para>Destination extension for the blind transfer.</para>
</parameter>
</syntax>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="AttendedTransfer">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when an attended transfer is complete.</synopsis>
<syntax>
<xi:include xpointer="xpointer(docs/managerEvent[@name='BlindTransfer']/managerEventInstance/syntax/parameter[@name='Result'])" />
<parameter name="OrigTransfererChannel">
<para>The original transferer channel that performed the attended transfer.</para>
</parameter>
<parameter name="OrigTransfererChannelState">
<para>A numeric code for the channel's current state, related to DestChannelStateDesc</para>
</parameter>
<parameter name="OrigTransfererChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
</parameter>
<parameter name="OrigTransfererCallerIDNum">
</parameter>
<parameter name="OrigTransfererCallerIDName">
</parameter>
<parameter name="OrigTransfererConnectedLineNum">
</parameter>
<parameter name="OrigTransfererConnectedLineName">
</parameter>
<parameter name="OrigTransfererAccountCode">
</parameter>
<parameter name="OrigTransfererContext">
</parameter>
<parameter name="OrigTransfererExten">
</parameter>
<parameter name="OrigTransfererPriority">
</parameter>
<parameter name="OrigTransfererUniqueid">
</parameter>
<parameter name="OrigBridgeUniqueid">
<para>The ID of the bridge where the Transferer performed the transfer</para>
<note><para>This header will not be present if the original transferer was not in a bridge.</para></note>
</parameter>
<parameter name="OrigBridgeType">
<para>The type of the bridge where the Transferer performed the transfer</para>
<note><para>This header will not be present if the original transferer was not in a bridge.</para></note>
</parameter>
<parameter name="SecondTransfererChannel">
<para>The second transferer channel involved in the attended transfer.</para>
</parameter>
<parameter name="SecondTransfererChannelState">
<para>A numeric code for the channel's current state, related to SecondTransfererChannelStateDesc</para>
</parameter>
<parameter name="SecondTransfererChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
</parameter>
<parameter name="SecondTransfererCallerIDNum">
</parameter>
<parameter name="SecondTransfererCallerIDName">
</parameter>
<parameter name="SecondTransfererConnectedLineNum">
</parameter>
<parameter name="SecondTransfererConnectedLineName">
</parameter>
<parameter name="SecondTransfererAccountCode">
</parameter>
<parameter name="SecondTransfererContext">
</parameter>
<parameter name="SecondTransfererExten">
</parameter>
<parameter name="SecondTransfererPriority">
</parameter>
<parameter name="SecondTransfererUniqueid">
</parameter>
<parameter name="SecondBridgeUniqueid">
<para>The unique ID of the bridge that the second transferer channel was in, or <literal>None</literal> if the second transferer channel was not bridged</para>
<note><para>This header will not be present if the second transferer was not in a bridge.</para></note>
</parameter>
<parameter name="SecondBridgeType">
<para>The type of the bridge where the Transferer performed the transfer</para>
<note><para>This header will not be present if the second transferer was not in a bridge.</para></note>
</parameter>
<parameter name="DestType">
<para>Indicates the method by which the attended transfer completed.</para>
<enumlist>
<enum name="Bridge"><para>The transfer was accomplished by merging two bridges into one.</para></enum>
<enum name="App"><para>The transfer was accomplished by having a channel or bridge run a dialplan application.</para></enum>
<enum name="Link"><para>The transfer was accomplished by linking two bridges together using a local channel pair.</para></enum>
<enum name="Fail"><para>The transfer failed.</para></enum>
</enumlist>
</parameter>
<parameter name="DestBridgeUniqueid">
<para>Indicates the surviving bridge when bridges were merged to complete the transfer</para>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Bridge</literal></para></note>
</parameter>
<parameter name="DestApp">
<para>Indicates the application that is running when the transfer completes</para>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>App</literal></para></note>
</parameter>
<parameter name="LocalOneChannel">
<para>The local channel that is bridged with the original bridge when forming a link between bridges</para>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneChannelState">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneCallerIDNum">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneCallerIDName">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneConnectedLineNum">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneConnectedLineName">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneAccountCode">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneContext">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneExten">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOnePriority">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalOneUniqueid">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoChannel">
<para>The local channel that is bridged with the second bridge when forming a link between bridges</para>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoChannelState">
<para>A numeric code for the channel's current state, related to LocalTwoChannelStateDesc</para>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoChannelStateDesc">
<enumlist>
<enum name="Down"/>
<enum name="Rsrvd"/>
<enum name="OffHook"/>
<enum name="Dialing"/>
<enum name="Ring"/>
<enum name="Ringing"/>
<enum name="Up"/>
<enum name="Busy"/>
<enum name="Dialing Offhook"/>
<enum name="Pre-ring"/>
<enum name="Unknown"/>
</enumlist>
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoCallerIDNum">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoCallerIDName">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoConnectedLineNum">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoConnectedLineName">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoAccountCode">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoContext">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoExten">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoPriority">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
<parameter name="LocalTwoUniqueid">
<note><para>This header is only present when <replaceable>DestType</replaceable> is <literal>Link</literal></para></note>
</parameter>
</syntax>
<description>
<para>The headers in this event attempt to describe all the major details of the attended transfer. The two transferer channels
and the two bridges are determined based on their chronological establishment. So consider that Alice calls Bob, and then Alice
transfers the call to Voicemail. The transferer and bridge headers would be arranged as follows:</para>
<para> <replaceable>OrigTransfererChannel</replaceable>: Alice's channel in the bridge with Bob.</para>
<para> <replaceable>BridgeUniqueidOrig</replaceable>: The bridge between Alice and Bob.</para>
<para> <replaceable>SecondTransfererChannel</replaceable>: Alice's channel that called Voicemail.</para>
<para> <replaceable>BridgeUniqueidSecond</replaceable>: Not present, since a call to Voicemail has no bridge.</para>
<para>Now consider if the order were reversed; instead of having Alice call Bob and transfer him to Voicemail, Alice instead
calls her Voicemail and transfers that to Bob. The transferer and bridge headers would be arranged as follows:</para>
<para> <replaceable>OrigTransfererChannel</replaceable>: Alice's channel that called Voicemail.</para>
<para> <replaceable>BridgeUniqueidOrig</replaceable>: Not present, since a call to Voicemail has no bridge.</para>
<para> <replaceable>SecondTransfererChannel</replaceable>: Alice's channel in the bridge with Bob.</para>
<para> <replaceable>BridgeUniqueidSecond</replaceable>: The bridge between Alice and Bob.</para>
</description>
</managerEventInstance>
</managerEvent>
***/
static struct ast_manager_event_blob *attended_transfer_to_ami(struct stasis_message *message);
static struct ast_manager_event_blob *blind_transfer_to_ami(struct stasis_message *message);
/*!
* @{ \brief Define bridge message types.
*/
STASIS_MESSAGE_TYPE_DEFN(ast_bridge_snapshot_type);
STASIS_MESSAGE_TYPE_DEFN(ast_bridge_merge_message_type);
STASIS_MESSAGE_TYPE_DEFN(ast_channel_entered_bridge_type);
STASIS_MESSAGE_TYPE_DEFN(ast_channel_left_bridge_type);
STASIS_MESSAGE_TYPE_DEFN(ast_blind_transfer_type, .to_ami = blind_transfer_to_ami);
STASIS_MESSAGE_TYPE_DEFN(ast_attended_transfer_type, .to_ami = attended_transfer_to_ami);
/*! @} */
/*! \brief Aggregate topic for bridge messages */
static struct stasis_topic *bridge_topic_all;
/*! \brief Caching aggregate topic for bridge snapshots */
static struct stasis_caching_topic *bridge_topic_all_cached;
/*! \brief Topic pool for individual bridge topics */
static struct stasis_topic_pool *bridge_topic_pool;
/*! \brief Destructor for bridge snapshots */
static void bridge_snapshot_dtor(void *obj)
{
struct ast_bridge_snapshot *snapshot = obj;
ast_string_field_free_memory(snapshot);
ao2_cleanup(snapshot->channels);
snapshot->channels = NULL;
}
struct ast_bridge_snapshot *ast_bridge_snapshot_create(struct ast_bridge *bridge)
{
RAII_VAR(struct ast_bridge_snapshot *, snapshot, NULL, ao2_cleanup);
struct ast_bridge_channel *bridge_channel;
snapshot = ao2_alloc(sizeof(*snapshot), bridge_snapshot_dtor);
if (!snapshot || ast_string_field_init(snapshot, 128)) {
return NULL;
}
snapshot->channels = ast_str_container_alloc(SNAPSHOT_CHANNELS_BUCKETS);
if (!snapshot->channels) {
return NULL;
}
AST_LIST_TRAVERSE(&bridge->channels, bridge_channel, entry) {
if (ast_str_container_add(snapshot->channels,
ast_channel_uniqueid(bridge_channel->chan))) {
return NULL;
}
}
ast_string_field_set(snapshot, uniqueid, bridge->uniqueid);
ast_string_field_set(snapshot, technology, bridge->technology->name);
ast_string_field_set(snapshot, subclass, bridge->v_table->name);
snapshot->feature_flags = bridge->feature_flags;
snapshot->capabilities = bridge->technology->capabilities;
snapshot->num_channels = bridge->num_channels;
snapshot->num_active = bridge->num_active;
ao2_ref(snapshot, +1);
return snapshot;
}
struct stasis_topic *ast_bridge_topic(struct ast_bridge *bridge)
{
struct stasis_topic *bridge_topic = stasis_topic_pool_get_topic(bridge_topic_pool, bridge->uniqueid);
if (!bridge_topic) {
return ast_bridge_topic_all();
}
return bridge_topic;
}
struct stasis_topic *ast_bridge_topic_all(void)
{
return bridge_topic_all;
}
struct stasis_caching_topic *ast_bridge_topic_all_cached(void)
{
return bridge_topic_all_cached;
}
void ast_bridge_publish_state(struct ast_bridge *bridge)
{
RAII_VAR(struct ast_bridge_snapshot *, snapshot, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
ast_assert(bridge != NULL);
snapshot = ast_bridge_snapshot_create(bridge);
if (!snapshot) {
return;
}
msg = stasis_message_create(ast_bridge_snapshot_type(), snapshot);
if (!msg) {
return;
}
stasis_publish(ast_bridge_topic(bridge), msg);
}
static void bridge_publish_state_from_blob(struct ast_bridge_blob *obj)
{
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
ast_assert(obj != NULL);
msg = stasis_message_create(ast_bridge_snapshot_type(), obj->bridge);
if (!msg) {
return;
}
stasis_publish(stasis_topic_pool_get_topic(bridge_topic_pool, obj->bridge->uniqueid), msg);
}
/*! \brief Destructor for bridge merge messages */
static void bridge_merge_message_dtor(void *obj)
{
struct ast_bridge_merge_message *msg = obj;
ao2_cleanup(msg->to);
msg->to = NULL;
ao2_cleanup(msg->from);
msg->from = NULL;
}
/*! \brief Bridge merge message creation helper */
static struct ast_bridge_merge_message *bridge_merge_message_create(struct ast_bridge *to, struct ast_bridge *from)
{
RAII_VAR(struct ast_bridge_merge_message *, msg, NULL, ao2_cleanup);
msg = ao2_alloc(sizeof(*msg), bridge_merge_message_dtor);
if (!msg) {
return NULL;
}
msg->to = ast_bridge_snapshot_create(to);
if (!msg->to) {
return NULL;
}
msg->from = ast_bridge_snapshot_create(from);
if (!msg->from) {
return NULL;
}
ao2_ref(msg, +1);
return msg;
}
void ast_bridge_publish_merge(struct ast_bridge *to, struct ast_bridge *from)
{
RAII_VAR(struct ast_bridge_merge_message *, merge_msg, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
ast_assert(to != NULL);
ast_assert(from != NULL);
merge_msg = bridge_merge_message_create(to, from);
if (!merge_msg) {
return;
}
msg = stasis_message_create(ast_bridge_merge_message_type(), merge_msg);
if (!msg) {
return;
}
stasis_publish(ast_bridge_topic_all(), msg);
}
static void bridge_blob_dtor(void *obj)
{
struct ast_bridge_blob *event = obj;
ao2_cleanup(event->bridge);
event->bridge = NULL;
ao2_cleanup(event->channel);
event->channel = NULL;
ast_json_unref(event->blob);
event->blob = NULL;
}
struct stasis_message *ast_bridge_blob_create(
struct stasis_message_type *message_type,
struct ast_bridge *bridge,
struct ast_channel *chan,
struct ast_json *blob)
{
RAII_VAR(struct ast_bridge_blob *, obj, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
obj = ao2_alloc(sizeof(*obj), bridge_blob_dtor);
if (!obj) {
return NULL;
}
if (bridge) {
obj->bridge = ast_bridge_snapshot_create(bridge);
if (obj->bridge == NULL) {
return NULL;
}
}
if (chan) {
obj->channel = ast_channel_snapshot_create(chan);
if (obj->channel == NULL) {
return NULL;
}
}
if (blob) {
obj->blob = ast_json_ref(blob);
}
msg = stasis_message_create(message_type, obj);
if (!msg) {
return NULL;
}
ao2_ref(msg, +1);
return msg;
}
void ast_bridge_publish_enter(struct ast_bridge *bridge, struct ast_channel *chan)
{
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
msg = ast_bridge_blob_create(ast_channel_entered_bridge_type(), bridge, chan, NULL);
if (!msg) {
return;
}
/* enter blob first, then state */
stasis_publish(ast_bridge_topic(bridge), msg);
bridge_publish_state_from_blob(stasis_message_data(msg));
}
void ast_bridge_publish_leave(struct ast_bridge *bridge, struct ast_channel *chan)
{
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
msg = ast_bridge_blob_create(ast_channel_left_bridge_type(), bridge, chan, NULL);
if (!msg) {
return;
}
/* state first, then leave blob (opposite of enter, preserves nesting of events) */
bridge_publish_state_from_blob(stasis_message_data(msg));
stasis_publish(ast_bridge_topic(bridge), msg);
}
typedef struct ast_json *(*json_item_serializer_cb)(void *obj);
static struct ast_json *container_to_json_array(struct ao2_container *items, json_item_serializer_cb item_cb)
{
RAII_VAR(struct ast_json *, json_items, ast_json_array_create(), ast_json_unref);
void *item;
struct ao2_iterator it;
if (!json_items) {
return NULL;
}
it = ao2_iterator_init(items, 0);
while ((item = ao2_iterator_next(&it))) {
if (ast_json_array_append(json_items, item_cb(item))) {
ao2_iterator_destroy(&it);
return NULL;
}
}
ao2_iterator_destroy(&it);
return ast_json_ref(json_items);
}
static const char *capability2str(uint32_t capabilities)
{
if (capabilities & AST_BRIDGE_CAPABILITY_HOLDING) {
return "holding";
} else {
return "mixing";
}
}
struct ast_json *ast_bridge_snapshot_to_json(const struct ast_bridge_snapshot *snapshot)
{
RAII_VAR(struct ast_json *, json_bridge, NULL, ast_json_unref);
struct ast_json *json_channels;
if (snapshot == NULL) {
return NULL;
}
json_channels = container_to_json_array(snapshot->channels,
(json_item_serializer_cb)ast_json_string_create);
if (!json_channels) {
return NULL;
}
json_bridge = ast_json_pack("{s: s, s: s, s: s, s: s, s: o}",
"id", snapshot->uniqueid,
"technology", snapshot->technology,
"bridge_type", capability2str(snapshot->capabilities),
"bridge_class", snapshot->subclass,
"channels", json_channels);
if (!json_bridge) {
return NULL;
}
return ast_json_ref(json_bridge);
}
/*!
* \internal
* \brief Allocate the fields of an \ref ast_bridge_channel_snapshot_pair.
*
* \param pair A bridge and channel to get snapshots of
* \param[out] snapshot_pair An allocated snapshot pair.
* \retval 0 Success
* \retval non-zero Failure
*/
static int bridge_channel_snapshot_pair_init(struct ast_bridge_channel_pair *pair, struct ast_bridge_channel_snapshot_pair *snapshot_pair)
{
if (pair->bridge) {
snapshot_pair->bridge_snapshot = ast_bridge_snapshot_create(pair->bridge);
if (!snapshot_pair->bridge_snapshot) {
return -1;
}
}
snapshot_pair->channel_snapshot = ast_channel_snapshot_create(pair->channel);
if (!snapshot_pair->channel_snapshot) {
return -1;
}
return 0;
}
/*!
* \internal
* \brief Free the fields of an \ref ast_bridge_channel_snapshot_pair.
*
* \param pair The snapshot pair whose fields are to be cleaned up
*/
static void bridge_channel_snapshot_pair_cleanup(struct ast_bridge_channel_snapshot_pair *pair)
{
ao2_cleanup(pair->bridge_snapshot);
ao2_cleanup(pair->channel_snapshot);
}
static const char *result_strs[] = {
[AST_BRIDGE_TRANSFER_FAIL] = "Fail",
[AST_BRIDGE_TRANSFER_INVALID] = "Invalid",
[AST_BRIDGE_TRANSFER_NOT_PERMITTED] = "Not Permitted",
[AST_BRIDGE_TRANSFER_SUCCESS] = "Success",
};
static struct ast_manager_event_blob *blind_transfer_to_ami(struct stasis_message *msg)
{
RAII_VAR(struct ast_str *, channel_state, NULL, ast_free_ptr);
RAII_VAR(struct ast_str *, bridge_state, NULL, ast_free_ptr);
struct ast_bridge_blob *blob = stasis_message_data(msg);
const char *exten;
const char *context;
enum ast_transfer_result result;
int is_external;
if (!blob) {
return NULL;
}
channel_state = ast_manager_build_channel_state_string_prefix(blob->channel, "Transferer");
bridge_state = ast_manager_build_bridge_state_string(blob->bridge, "");
if (!channel_state || !bridge_state) {
return NULL;
}
exten = ast_json_string_get(ast_json_object_get(blob->blob, "exten"));
context = ast_json_string_get(ast_json_object_get(blob->blob, "context"));
result = ast_json_integer_get(ast_json_object_get(blob->blob, "result"));
is_external = ast_json_integer_get(ast_json_object_get(blob->blob, "is_external"));
return ast_manager_event_blob_create(EVENT_FLAG_CALL, "BlindTransfer",
"Result: %s\r\n"
"%s"
"%s"
"IsExternal: %s\r\n"
"Context: %s\r\n"
"Extension: %s\r\n",
result_strs[result],
ast_str_buffer(channel_state),
ast_str_buffer(bridge_state),
is_external ? "Yes" : "No",
context,
exten);
}
void ast_bridge_publish_blind_transfer(int is_external, enum ast_transfer_result result,
struct ast_bridge_channel_pair *transferer, const char *context, const char *exten)
{
RAII_VAR(struct ast_json *, json_object, NULL, ast_json_unref);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
json_object = ast_json_pack("{s: s, s: s, s: i, s: i}",
"context", context, "exten", exten, "result", result, "is_external", is_external);
if (!json_object) {
ast_log(LOG_NOTICE, "Failed to create json bridge blob\n");
return;
}
msg = ast_bridge_blob_create(ast_blind_transfer_type(),
transferer->bridge, transferer->channel, json_object);
if (!msg) {
ast_log(LOG_NOTICE, "Failed to create blob msg\n");
return;
}
stasis_publish(ast_bridge_topic_all(), msg);
}
static struct ast_manager_event_blob *attended_transfer_to_ami(struct stasis_message *msg)
{
RAII_VAR(struct ast_str *, variable_data, ast_str_create(64), ast_free_ptr);
RAII_VAR(struct ast_str *, transferer1_state, NULL, ast_free_ptr);
RAII_VAR(struct ast_str *, bridge1_state, NULL, ast_free_ptr);
RAII_VAR(struct ast_str *, transferer2_state, NULL, ast_free_ptr);
RAII_VAR(struct ast_str *, bridge2_state, NULL, ast_free_ptr);
RAII_VAR(struct ast_str *, local1_state, NULL, ast_free_ptr);
RAII_VAR(struct ast_str *, local2_state, NULL, ast_free_ptr);
struct ast_attended_transfer_message *transfer_msg = stasis_message_data(msg);
if (!variable_data) {
return NULL;
}
transferer1_state = ast_manager_build_channel_state_string_prefix(transfer_msg->to_transferee.channel_snapshot, "OrigTransferer");
transferer2_state = ast_manager_build_channel_state_string_prefix(transfer_msg->to_transfer_target.channel_snapshot, "SecondTransferer");
if (!transferer1_state || !transferer2_state) {
return NULL;
}
if (transfer_msg->to_transferee.bridge_snapshot) {
bridge1_state = ast_manager_build_bridge_state_string(transfer_msg->to_transferee.bridge_snapshot, "Orig");
if (!bridge1_state) {
return NULL;
}
}
if (transfer_msg->to_transfer_target.bridge_snapshot) {
bridge2_state = ast_manager_build_bridge_state_string(transfer_msg->to_transfer_target.bridge_snapshot, "Second");
if (!bridge2_state) {
return NULL;
}
}
switch (transfer_msg->dest_type) {
case AST_ATTENDED_TRANSFER_DEST_BRIDGE_MERGE:
ast_str_append(&variable_data, 0, "DestType: Bridge\r\n");
ast_str_append(&variable_data, 0, "DestBridgeUniqueid: %s\r\n", transfer_msg->dest.bridge);
break;
case AST_ATTENDED_TRANSFER_DEST_APP:
ast_str_append(&variable_data, 0, "DestType: App\r\n");
ast_str_append(&variable_data, 0, "DestApp: %s\r\n", transfer_msg->dest.app);
break;
case AST_ATTENDED_TRANSFER_DEST_LINK:
local1_state = ast_manager_build_channel_state_string_prefix(transfer_msg->dest.links[0], "LocalOne");
local2_state = ast_manager_build_channel_state_string_prefix(transfer_msg->dest.links[1], "LocalTwo");
if (!local1_state || !local2_state) {
return NULL;
}
ast_str_append(&variable_data, 0, "DestType: Link\r\n");
ast_str_append(&variable_data, 0, "%s", ast_str_buffer(local1_state));
ast_str_append(&variable_data, 0, "%s", ast_str_buffer(local2_state));
break;
case AST_ATTENDED_TRANSFER_DEST_FAIL:
ast_str_append(&variable_data, 0, "DestType: Fail\r\n");
break;
}
return ast_manager_event_blob_create(EVENT_FLAG_CALL, "AttendedTransfer",
"Result: %s\r\n"
"%s"
"%s"
"%s"
"%s"
"IsExternal: %s\r\n"
"%s\r\n",
result_strs[transfer_msg->result],
ast_str_buffer(transferer1_state),
bridge1_state ? ast_str_buffer(bridge1_state) : "",
ast_str_buffer(transferer2_state),
bridge2_state ? ast_str_buffer(bridge2_state) : "",
transfer_msg->is_external ? "Yes" : "No",
ast_str_buffer(variable_data));
}
static void attended_transfer_dtor(void *obj)
{
struct ast_attended_transfer_message *msg = obj;
int i;
bridge_channel_snapshot_pair_cleanup(&msg->to_transferee);
bridge_channel_snapshot_pair_cleanup(&msg->to_transfer_target);
if (msg->dest_type != AST_ATTENDED_TRANSFER_DEST_LINK) {
return;
}
for (i = 0; i < ARRAY_LEN(msg->dest.links); ++i) {
ao2_cleanup(msg->dest.links[i]);
}
}
static struct ast_attended_transfer_message *attended_transfer_message_create(int is_external, enum ast_transfer_result result,
struct ast_bridge_channel_pair *transferee, struct ast_bridge_channel_pair *target)
{
RAII_VAR(struct ast_attended_transfer_message *, msg, NULL, ao2_cleanup);
msg = ao2_alloc(sizeof(*msg), attended_transfer_dtor);
if (!msg) {
return NULL;
}
if (bridge_channel_snapshot_pair_init(transferee, &msg->to_transferee) ||
bridge_channel_snapshot_pair_init(target, &msg->to_transfer_target)) {
return NULL;
}
msg->is_external = is_external;
msg->result = result;
ao2_ref(msg, +1);
return msg;
}
void ast_bridge_publish_attended_transfer_fail(int is_external, enum ast_transfer_result result,
struct ast_bridge_channel_pair *transferee, struct ast_bridge_channel_pair *target)
{
RAII_VAR(struct ast_attended_transfer_message *, transfer_msg, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
transfer_msg = attended_transfer_message_create(is_external, result, transferee, target);
if (!transfer_msg) {
return;
}
transfer_msg->dest_type = AST_ATTENDED_TRANSFER_DEST_FAIL;
msg = stasis_message_create(ast_attended_transfer_type(), transfer_msg);
if (!msg) {
return;
}
stasis_publish(ast_bridge_topic_all(), msg);
}
void ast_bridge_publish_attended_transfer_bridge_merge(int is_external, enum ast_transfer_result result,
struct ast_bridge_channel_pair *transferee, struct ast_bridge_channel_pair *target,
struct ast_bridge *final_bridge)
{
RAII_VAR(struct ast_attended_transfer_message *, transfer_msg, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
transfer_msg = attended_transfer_message_create(is_external, result, transferee, target);
if (!transfer_msg) {
return;
}
transfer_msg->dest_type = AST_ATTENDED_TRANSFER_DEST_BRIDGE_MERGE;
ast_copy_string(transfer_msg->dest.bridge, final_bridge->uniqueid,
sizeof(transfer_msg->dest.bridge));
msg = stasis_message_create(ast_attended_transfer_type(), transfer_msg);
if (!msg) {
return;
}
stasis_publish(ast_bridge_topic_all(), msg);
}
void ast_bridge_publish_attended_transfer_app(int is_external, enum ast_transfer_result result,
struct ast_bridge_channel_pair *transferee, struct ast_bridge_channel_pair *target,
const char *dest_app)
{
RAII_VAR(struct ast_attended_transfer_message *, transfer_msg, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
transfer_msg = attended_transfer_message_create(is_external, result, transferee, target);
if (!transfer_msg) {
return;
}
transfer_msg->dest_type = AST_ATTENDED_TRANSFER_DEST_APP;
ast_copy_string(transfer_msg->dest.app, dest_app, sizeof(transfer_msg->dest.app));
msg = stasis_message_create(ast_attended_transfer_type(), transfer_msg);
if (!msg) {
return;
}
stasis_publish(ast_bridge_topic_all(), msg);
}
void ast_bridge_publish_attended_transfer_link(int is_external, enum ast_transfer_result result,
struct ast_bridge_channel_pair *transferee, struct ast_bridge_channel_pair *target,
struct ast_channel *locals[2])
{
RAII_VAR(struct ast_attended_transfer_message *, transfer_msg, NULL, ao2_cleanup);
RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
int i;
transfer_msg = attended_transfer_message_create(is_external, result, transferee, target);
if (!transfer_msg) {
return;
}
transfer_msg->dest_type = AST_ATTENDED_TRANSFER_DEST_LINK;
for (i = 0; i < 2; ++i) {
transfer_msg->dest.links[i] = ast_channel_snapshot_create(locals[i]);
if (!transfer_msg->dest.links[i]) {
return;
}
}
msg = stasis_message_create(ast_attended_transfer_type(), transfer_msg);
if (!msg) {
return;
}
stasis_publish(ast_bridge_topic_all(), msg);
}
struct ast_bridge_snapshot *ast_bridge_snapshot_get_latest(const char *uniqueid)
{
RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
struct ast_bridge_snapshot *snapshot;
ast_assert(!ast_strlen_zero(uniqueid));
message = stasis_cache_get(ast_bridge_topic_all_cached(),
ast_bridge_snapshot_type(),
uniqueid);
if (!message) {
return NULL;
}
snapshot = stasis_message_data(message);
if (!snapshot) {
return NULL;
}
ao2_ref(snapshot, +1);
return snapshot;
}
static void stasis_bridging_cleanup(void)
{
ao2_cleanup(bridge_topic_all);
bridge_topic_all = NULL;
bridge_topic_all_cached = stasis_caching_unsubscribe_and_join(
bridge_topic_all_cached);
ao2_cleanup(bridge_topic_pool);
bridge_topic_pool = NULL;
STASIS_MESSAGE_TYPE_CLEANUP(ast_bridge_snapshot_type);
STASIS_MESSAGE_TYPE_CLEANUP(ast_bridge_merge_message_type);
STASIS_MESSAGE_TYPE_CLEANUP(ast_channel_entered_bridge_type);
STASIS_MESSAGE_TYPE_CLEANUP(ast_channel_left_bridge_type);
STASIS_MESSAGE_TYPE_CLEANUP(ast_blind_transfer_type);
STASIS_MESSAGE_TYPE_CLEANUP(ast_attended_transfer_type);
}
/*! \brief snapshot ID getter for caching topic */
static const char *bridge_snapshot_get_id(struct stasis_message *msg)
{
struct ast_bridge_snapshot *snapshot;
if (stasis_message_type(msg) != ast_bridge_snapshot_type()) {
return NULL;
}
snapshot = stasis_message_data(msg);
return snapshot->uniqueid;
}
int ast_stasis_bridging_init(void)
{
ast_register_cleanup(stasis_bridging_cleanup);
STASIS_MESSAGE_TYPE_INIT(ast_bridge_snapshot_type);
STASIS_MESSAGE_TYPE_INIT(ast_bridge_merge_message_type);
STASIS_MESSAGE_TYPE_INIT(ast_channel_entered_bridge_type);
STASIS_MESSAGE_TYPE_INIT(ast_channel_left_bridge_type);
STASIS_MESSAGE_TYPE_INIT(ast_blind_transfer_type);
STASIS_MESSAGE_TYPE_INIT(ast_attended_transfer_type);
bridge_topic_all = stasis_topic_create("ast_bridge_topic_all");
bridge_topic_all_cached = stasis_caching_topic_create(bridge_topic_all, bridge_snapshot_get_id);
bridge_topic_pool = stasis_topic_pool_create(bridge_topic_all);
return !bridge_topic_all
|| !bridge_topic_all_cached
|| !bridge_topic_pool ? -1 : 0;
}
Reference in a new issue View git blame Copy permalink