bridge_builtin_features.c File Reference

Built in bridging features. More...

#include "asterisk.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/bridge.h"
#include "asterisk/bridge_technology.h"
#include "asterisk/frame.h"
#include "asterisk/file.h"
#include "asterisk/app.h"
#include "asterisk/astobj2.h"
#include "asterisk/pbx.h"
#include "asterisk/parking.h"
#include "asterisk/features_config.h"
#include "asterisk/mixmonitor.h"
#include "asterisk/audiohook.h"
#include "asterisk/causes.h"
#include "asterisk/beep.h"

Include dependency graph for bridge_builtin_features.c:

Go to the source code of this file.

Enumerations
enum	set_touch_variables_res { SET_TOUCH_SUCCESS , SET_TOUCH_UNSET , SET_TOUCH_ALLOC_FAILURE }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	feature_automixmonitor (struct ast_bridge_channel *bridge_channel, void *hook_pvt)
static int	feature_hangup (struct ast_bridge_channel *bridge_channel, void *hook_pvt)
	Internal built in feature for hangup. More...
static int	load_module (void)
static void	set_touch_variable (enum set_touch_variables_res *res, struct ast_channel *chan, const char *var_name, char **touch)
static enum set_touch_variables_res	set_touch_variables (struct ast_channel *chan, char **touch_format, char **touch_monitor, char **touch_monitor_prefix, char **touch_monitor_beep)
static void	start_automixmonitor (struct ast_bridge_channel *bridge_channel, struct ast_channel *peer_chan, struct ast_features_general_config *features_cfg, const char *start_message)
static void	stop_automixmonitor (struct ast_bridge_channel *bridge_channel, struct ast_channel *peer_chan, struct ast_features_general_config *features_cfg, const char *stop_message)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Built in bridging features" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, }
static const struct ast_module_info *	ast_module_info = &__mod_info

Detailed Description

Built in bridging features.

Author

Joshua Colp jcolp.nosp@m.@dig.nosp@m.ium.c.nosp@m.om

Definition in file bridge_builtin_features.c.

Enumeration Type Documentation

set_touch_variables_res

enum set_touch_variables_res

Enumerator
SET_TOUCH_SUCCESS
SET_TOUCH_UNSET
SET_TOUCH_ALLOC_FAILURE

Definition at line 56 of file bridge_builtin_features.c.

                             {
    SET_TOUCH_SUCCESS,
    SET_TOUCH_UNSET,
    SET_TOUCH_ALLOC_FAILURE,
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 346 of file bridge_builtin_features.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 346 of file bridge_builtin_features.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 346 of file bridge_builtin_features.c.

feature_automixmonitor()

static int feature_automixmonitor ( struct ast_bridge_channel *  bridge_channel, void *  hook_pvt  )

static

Definition at line 228 of file bridge_builtin_features.c.

{
    static const char *mixmonitor_spy_type = "MixMonitor";
    const char *stop_message;
    const char *start_message;
    struct ast_bridge_features_automixmonitor *options = hook_pvt;
    enum ast_bridge_features_monitor start_stop = options ? options->start_stop : AUTO_MONITOR_TOGGLE;
    int is_monitoring;
 
    RAII_VAR(struct ast_channel *, peer_chan, NULL, ast_channel_cleanup);
    RAII_VAR(struct ast_features_general_config *, features_cfg, NULL, ao2_cleanup);
 
    ast_channel_lock(bridge_channel->chan);
    features_cfg = ast_get_chan_features_general_config(bridge_channel->chan);
    ast_channel_unlock(bridge_channel->chan);
    ast_bridge_channel_lock_bridge(bridge_channel);
    peer_chan = ast_bridge_peer_nolock(bridge_channel->bridge, bridge_channel->chan);
    ast_bridge_unlock(bridge_channel->bridge);
 
    if (!peer_chan) {
        ast_verb(4, "Cannot start AutoMixMonitor for %s - cannot determine peer in bridge.\n",
            ast_channel_name(bridge_channel->chan));
        if (features_cfg && !ast_strlen_zero(features_cfg->recordingfailsound)) {
            ast_bridge_channel_queue_playfile(bridge_channel, NULL, features_cfg->recordingfailsound, NULL);
        }
        return 0;
    }
 
    ast_channel_lock(bridge_channel->chan);
    start_message = pbx_builtin_getvar_helper(bridge_channel->chan,
        "TOUCH_MIXMONITOR_MESSAGE_START");
    start_message = ast_strdupa(S_OR(start_message, ""));
    stop_message = pbx_builtin_getvar_helper(bridge_channel->chan,
        "TOUCH_MIXMONITOR_MESSAGE_STOP");
    stop_message = ast_strdupa(S_OR(stop_message, ""));
    ast_channel_unlock(bridge_channel->chan);
 
    is_monitoring =
        0 < ast_channel_audiohook_count_by_source(peer_chan, mixmonitor_spy_type, AST_AUDIOHOOK_TYPE_SPY);
    switch (start_stop) {
    case AUTO_MONITOR_TOGGLE:
        if (is_monitoring) {
            stop_automixmonitor(bridge_channel, peer_chan, features_cfg, stop_message);
        } else {
            start_automixmonitor(bridge_channel, peer_chan, features_cfg, start_message);
        }
        return 0;
    case AUTO_MONITOR_START:
        if (!is_monitoring) {
            start_automixmonitor(bridge_channel, peer_chan, features_cfg, start_message);
            return 0;
        }
        ast_verb(4, "AutoMixMonitor already recording call.\n");
        break;
    case AUTO_MONITOR_STOP:
        if (is_monitoring) {
            stop_automixmonitor(bridge_channel, peer_chan, features_cfg, stop_message);
            return 0;
        }
        ast_verb(4, "AutoMixMonitor already stopped on call.\n");
        break;
    }
 
    /*
     * Fake start/stop to invoker so will think it did something but
     * was already in that mode.
     */
    if (features_cfg && !ast_strlen_zero(features_cfg->courtesytone)) {
        ast_bridge_channel_queue_playfile(bridge_channel, NULL, features_cfg->courtesytone, NULL);
    }
    if (is_monitoring) {
        if (!ast_strlen_zero(start_message)) {
            ast_bridge_channel_queue_playfile(bridge_channel, NULL, start_message, NULL);
        }
    } else {
        if (!ast_strlen_zero(stop_message)) {
            ast_bridge_channel_queue_playfile(bridge_channel, NULL, stop_message, NULL);
        }
    }
    return 0;
}

References ao2_cleanup, AST_AUDIOHOOK_TYPE_SPY, ast_bridge_channel_lock_bridge(), ast_bridge_channel_queue_playfile(), ast_bridge_peer_nolock(), ast_bridge_unlock, ast_channel_audiohook_count_by_source(), ast_channel_cleanup, ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_get_chan_features_general_config(), ast_strdupa, ast_strlen_zero(), ast_verb, AUTO_MONITOR_START, AUTO_MONITOR_STOP, AUTO_MONITOR_TOGGLE, ast_bridge_channel::bridge, ast_bridge_channel::chan, mixmonitor_spy_type, NULL, options, pbx_builtin_getvar_helper(), RAII_VAR, S_OR, start_automixmonitor(), ast_bridge_features_automixmonitor::start_stop, and stop_automixmonitor().

Referenced by load_module().

feature_hangup()

static int feature_hangup ( struct ast_bridge_channel *  bridge_channel, void *  hook_pvt  )

static

Internal built in feature for hangup.

Definition at line 311 of file bridge_builtin_features.c.

{
    /*
     * This is very simple, we simply change the state on the
     * bridge_channel to force the channel out of the bridge and the
     * core takes care of the rest.
     */
    ast_bridge_channel_leave_bridge(bridge_channel, BRIDGE_CHANNEL_STATE_END,
        AST_CAUSE_NORMAL_CLEARING);
    return 0;
}

References ast_bridge_channel_leave_bridge(), AST_CAUSE_NORMAL_CLEARING, and BRIDGE_CHANNEL_STATE_END.

Referenced by load_module().

load_module()

static int load_module ( void  )

static

Definition at line 331 of file bridge_builtin_features.c.

{
    ast_bridge_features_register(AST_BRIDGE_BUILTIN_HANGUP, feature_hangup, NULL);
    ast_bridge_features_register(AST_BRIDGE_BUILTIN_AUTOMIXMON, feature_automixmonitor, NULL);
 
    /* This module cannot be unloaded until shutdown */
    ast_module_shutdown_ref(ast_module_info->self);
 
    return AST_MODULE_LOAD_SUCCESS;
}

References AST_BRIDGE_BUILTIN_AUTOMIXMON, AST_BRIDGE_BUILTIN_HANGUP, ast_bridge_features_register(), AST_MODULE_LOAD_SUCCESS, ast_module_shutdown_ref, feature_automixmonitor(), feature_hangup(), NULL, and ast_module_info::self.

set_touch_variable()

static void set_touch_variable ( enum set_touch_variables_res *  res, struct ast_channel *  chan, const char *  var_name, char **  touch  )

static

Definition at line 62 of file bridge_builtin_features.c.

{
    const char *c_touch;
 
    if (*res == SET_TOUCH_ALLOC_FAILURE) {
        return;
    }
    c_touch = pbx_builtin_getvar_helper(chan, var_name);
    if (!ast_strlen_zero(c_touch)) {
        *touch = ast_strdup(c_touch);
        if (!*touch) {
            *res = SET_TOUCH_ALLOC_FAILURE;
        } else {
            *res = SET_TOUCH_SUCCESS;
        }
    }
}

References ast_strdup, ast_strlen_zero(), pbx_builtin_getvar_helper(), SET_TOUCH_ALLOC_FAILURE, and SET_TOUCH_SUCCESS.

Referenced by set_touch_variables().

set_touch_variables()

static enum set_touch_variables_res set_touch_variables ( struct ast_channel *  chan, char **  touch_format, char **  touch_monitor, char **  touch_monitor_prefix, char **  touch_monitor_beep  )

static

Definition at line 80 of file bridge_builtin_features.c.

{
    enum set_touch_variables_res res = SET_TOUCH_UNSET;
    const char *var_format;
    const char *var_monitor;
    const char *var_prefix;
    const char *var_beep;
 
    SCOPED_CHANNELLOCK(lock, chan);
 
    var_format = "TOUCH_MIXMONITOR_FORMAT";
    var_monitor = "TOUCH_MIXMONITOR";
    var_prefix = "TOUCH_MIXMONITOR_PREFIX";
    var_beep = "TOUCH_MIXMONITOR_BEEP";
 
    set_touch_variable(&res, chan, var_format, touch_format);
    set_touch_variable(&res, chan, var_monitor, touch_monitor);
    set_touch_variable(&res, chan, var_prefix, touch_monitor_prefix);
    set_touch_variable(&res, chan, var_beep, touch_monitor_beep);
 
    return res;
}

References lock, SCOPED_CHANNELLOCK, SET_TOUCH_UNSET, and set_touch_variable().

Referenced by start_automixmonitor().

start_automixmonitor()

static void start_automixmonitor ( struct ast_bridge_channel *  bridge_channel, struct ast_channel *  peer_chan, struct ast_features_general_config *  features_cfg, const char *  start_message  )

static

Definition at line 127 of file bridge_builtin_features.c.

{
    char *touch_filename, mix_options[32] = "b";
    size_t len;
    int x;
    enum set_touch_variables_res set_touch_res;
 
    RAII_VAR(char *, touch_format, NULL, ast_free);
    RAII_VAR(char *, touch_monitor, NULL, ast_free);
    RAII_VAR(char *, touch_monitor_prefix, NULL, ast_free);
    RAII_VAR(char *, touch_monitor_beep, NULL, ast_free);
 
    set_touch_res = set_touch_variables(bridge_channel->chan, &touch_format,
        &touch_monitor, &touch_monitor_prefix, &touch_monitor_beep);
    switch (set_touch_res) {
    case SET_TOUCH_SUCCESS:
        break;
    case SET_TOUCH_UNSET:
        set_touch_res = set_touch_variables(peer_chan, &touch_format, &touch_monitor,
            &touch_monitor_prefix, &touch_monitor_beep);
        if (set_touch_res == SET_TOUCH_ALLOC_FAILURE) {
            return;
        }
        break;
    case SET_TOUCH_ALLOC_FAILURE:
        return;
    }
 
    if (!ast_strlen_zero(touch_monitor)) {
        len = strlen(touch_monitor) + 50;
        touch_filename = ast_alloca(len);
        snprintf(touch_filename, len, "%s-%ld-%s.%s",
            S_OR(touch_monitor_prefix, "auto"),
            (long) time(NULL),
            touch_monitor,
            S_OR(touch_format, "wav"));
    } else {
        char *caller_chan_id;
        char *peer_chan_id;
 
        caller_chan_id = ast_strdupa(S_COR(ast_channel_caller(bridge_channel->chan)->id.number.valid,
            ast_channel_caller(bridge_channel->chan)->id.number.str, ast_channel_name(bridge_channel->chan)));
        peer_chan_id = ast_strdupa(S_COR(ast_channel_caller(peer_chan)->id.number.valid,
            ast_channel_caller(peer_chan)->id.number.str, ast_channel_name(peer_chan)));
        len = strlen(caller_chan_id) + strlen(peer_chan_id) + 50;
        touch_filename = ast_alloca(len);
        snprintf(touch_filename, len, "%s-%ld-%s-%s.%s",
            S_OR(touch_monitor_prefix, "auto"),
            (long) time(NULL),
            caller_chan_id,
            peer_chan_id,
            S_OR(touch_format, "wav"));
    }
 
    for (x = 0; x < strlen(touch_filename); x++) {
        if (touch_filename[x] == '/') {
            touch_filename[x] = '-';
        }
    }
 
    ast_verb(4, "AutoMixMonitor used to record call. Filename: %s\n", touch_filename);
 
    if (!ast_strlen_zero(touch_monitor_beep)) {
        unsigned int interval = 15;
        if (sscanf(touch_monitor_beep, "%30u", &interval) != 1) {
            ast_log(LOG_WARNING, "Invalid interval '%s' for periodic beep. Using default of %u\n",
                        touch_monitor_beep, interval);
        }
 
        if (interval < 5) {
            interval = 5;
            ast_log(LOG_WARNING, "Interval '%s' too small for periodic beep. Using minimum of %u\n",
                    touch_monitor_beep, interval);
        }
        snprintf(mix_options, sizeof(mix_options), "bB(%d)", interval);
    }
 
    if (ast_start_mixmonitor(peer_chan, touch_filename, mix_options)) {
        ast_verb(4, "AutoMixMonitor feature was tried by '%s' but MixMonitor failed to start.\n",
            ast_channel_name(bridge_channel->chan));
 
        if (features_cfg && !ast_strlen_zero(features_cfg->recordingfailsound)) {
            ast_bridge_channel_queue_playfile(bridge_channel, NULL, features_cfg->recordingfailsound, NULL);
        }
        return;
    }
 
    if (features_cfg && !ast_strlen_zero(features_cfg->courtesytone)) {
        ast_bridge_channel_queue_playfile(bridge_channel, NULL, features_cfg->courtesytone, NULL);
        ast_bridge_channel_write_playfile(bridge_channel, NULL, features_cfg->courtesytone, NULL);
    }
 
    if (!ast_strlen_zero(start_message)) {
        ast_bridge_channel_queue_playfile(bridge_channel, NULL, start_message, NULL);
        ast_bridge_channel_write_playfile(bridge_channel, NULL, start_message, NULL);
    }
 
    pbx_builtin_setvar_helper(bridge_channel->chan, "TOUCH_MIXMONITOR_OUTPUT", touch_filename);
    pbx_builtin_setvar_helper(peer_chan, "TOUCH_MIXMONITOR_OUTPUT", touch_filename);
}

References ast_alloca, ast_bridge_channel_queue_playfile(), ast_bridge_channel_write_playfile(), ast_channel_caller(), ast_channel_name(), ast_free, ast_log, ast_start_mixmonitor(), ast_strdupa, ast_strlen_zero(), ast_verb, ast_bridge_channel::chan, ast_features_general_config::courtesytone, ast_party_caller::id, len(), LOG_WARNING, NULL, ast_party_id::number, pbx_builtin_setvar_helper(), RAII_VAR, ast_features_general_config::recordingfailsound, S_COR, S_OR, SET_TOUCH_ALLOC_FAILURE, SET_TOUCH_SUCCESS, SET_TOUCH_UNSET, set_touch_variables(), ast_party_number::str, and ast_party_number::valid.

Referenced by feature_automixmonitor().

stop_automixmonitor()

static void stop_automixmonitor ( struct ast_bridge_channel *  bridge_channel, struct ast_channel *  peer_chan, struct ast_features_general_config *  features_cfg, const char *  stop_message  )

static

Definition at line 104 of file bridge_builtin_features.c.

{
    ast_verb(4, "AutoMixMonitor used to stop recording call.\n");
 
    if (ast_stop_mixmonitor(peer_chan, NULL)) {
        ast_verb(4, "Failed to stop AutoMixMonitor for %s.\n", ast_channel_name(bridge_channel->chan));
        if (features_cfg && !(ast_strlen_zero(features_cfg->recordingfailsound))) {
            ast_bridge_channel_queue_playfile(bridge_channel, NULL, features_cfg->recordingfailsound, NULL);
        }
        return;
    }
 
    if (features_cfg && !ast_strlen_zero(features_cfg->courtesytone)) {
        ast_bridge_channel_queue_playfile(bridge_channel, NULL, features_cfg->courtesytone, NULL);
        ast_bridge_channel_write_playfile(bridge_channel, NULL, features_cfg->courtesytone, NULL);
    }
 
    if (!ast_strlen_zero(stop_message)) {
        ast_bridge_channel_queue_playfile(bridge_channel, NULL, stop_message, NULL);
        ast_bridge_channel_write_playfile(bridge_channel, NULL, stop_message, NULL);
    }
}

References ast_bridge_channel_queue_playfile(), ast_bridge_channel_write_playfile(), ast_channel_name(), ast_stop_mixmonitor(), ast_strlen_zero(), ast_verb, ast_bridge_channel::chan, ast_features_general_config::courtesytone, NULL, and ast_features_general_config::recordingfailsound.

Referenced by feature_automixmonitor().

unload_module()

static int unload_module ( void  )

static

Definition at line 323 of file bridge_builtin_features.c.

{
    ast_bridge_features_unregister(AST_BRIDGE_BUILTIN_HANGUP);
    ast_bridge_features_unregister(AST_BRIDGE_BUILTIN_AUTOMIXMON);
 
    return 0;
}

References AST_BRIDGE_BUILTIN_AUTOMIXMON, AST_BRIDGE_BUILTIN_HANGUP, and ast_bridge_features_unregister().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Built in bridging features" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, }

static

Definition at line 346 of file bridge_builtin_features.c.

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 346 of file bridge_builtin_features.c.