app_chanspy.c File Reference

ChanSpy: Listen in on any channel. More...

#include "asterisk.h"
#include <ctype.h>
#include <errno.h>
#include "asterisk/paths.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/audiohook.h"
#include "asterisk/features.h"
#include "asterisk/app.h"
#include "asterisk/utils.h"
#include "asterisk/say.h"
#include "asterisk/pbx.h"
#include "asterisk/translate.h"
#include "asterisk/manager.h"
#include "asterisk/module.h"
#include "asterisk/lock.h"
#include "asterisk/options.h"
#include "asterisk/autochan.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/json.h"
#include "asterisk/format_cache.h"

Include dependency graph for app_chanspy.c:

Go to the source code of this file.

Data Structures
struct	chanspy_translation_helper
struct	spy_dtmf_options

Macros
#define	AST_NAME_STRLEN   256
#define	NUM_SPYGROUPS   128

Enumerations
enum	{   OPTION_QUIET = (1 << 0) , OPTION_BRIDGED = (1 << 1) , OPTION_VOLUME = (1 << 2) , OPTION_GROUP = (1 << 3) ,   OPTION_RECORD = (1 << 4) , OPTION_WHISPER = (1 << 5) , OPTION_PRIVATE = (1 << 6) , OPTION_READONLY = (1 << 7) ,   OPTION_EXIT = (1 << 8) , OPTION_ENFORCED = (1 << 9) , OPTION_NOTECH = (1 << 10) , OPTION_BARGE = (1 << 11) ,   OPTION_NAME = (1 << 12) , OPTION_DTMF_SWITCH_MODES = (1 << 13) , OPTION_DTMF_EXIT = (1 << 14) , OPTION_DTMF_CYCLE = (1 << 15) ,   OPTION_DAHDI_SCAN = (1 << 16) , OPTION_STOP = (1 << 17) , OPTION_EXITONHANGUP = (1 << 18) , OPTION_UNIQUEID = (1 << 19) ,   OPTION_LONG_QUEUE = (1 << 20) , OPTION_INTERLEAVED = (1 << 21) , OPTION_NOANSWER = (1 << 22) }
enum	{   OPT_ARG_VOLUME = 0 , OPT_ARG_GROUP , OPT_ARG_RECORD , OPT_ARG_ENFORCED ,   OPT_ARG_NAME , OPT_ARG_EXIT , OPT_ARG_CYCLE , OPT_ARG_ARRAY_SIZE }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	attach_barge (struct ast_autochan *spyee_autochan, struct ast_autochan **spyee_bridge_autochan, struct ast_audiohook *bridge_whisper_audiohook, const char *spyer_name, const char *name, struct ast_flags *flags)
static void	change_spy_mode (const char digit, struct ast_flags *flags)
static int	channel_spy (struct ast_channel *chan, struct ast_autochan *spyee_autochan, int *volfactor, int fd, struct spy_dtmf_options *user_options, struct ast_flags *flags, char *exitcontext)
static int	chanspy_exec (struct ast_channel *chan, const char *data)
static int	common_exec (struct ast_channel *chan, struct ast_flags *flags, int volfactor, const int fd, struct spy_dtmf_options *user_options, const char *mygroup, const char *myenforced, const char *spec, const char *exten, const char *context, const char *mailbox, const char *name_context)
static int	dahdiscan_exec (struct ast_channel *chan, const char *data)
static int	extenspy_exec (struct ast_channel *chan, const char *data)
static int	load_module (void)
static struct ast_autochan *	next_channel (struct ast_channel_iterator *iter, struct ast_channel *chan)
static int	pack_channel_into_message (struct ast_channel *chan, const char *role, struct ast_multi_channel_blob *payload)
static void	publish_chanspy_message (struct ast_channel *spyer, struct ast_channel *spyee, int start)
static void *	spy_alloc (struct ast_channel *chan, void *data)
static int	spy_generate (struct ast_channel *chan, void *data, int len, int samples)
static void	spy_release (struct ast_channel *chan, void *data)
static int	spy_sayname (struct ast_channel *chan, const char *mailbox, const char *context)
static int	start_spying (struct ast_autochan *autochan, const char *spychan_name, struct ast_audiohook *audiohook, struct ast_flags *flags)
static int	start_whispering (struct ast_autochan *autochan, const char *spychan_name, struct ast_audiohook *audiohook, struct ast_flags *flags)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Listen to the audio of an active channel" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static const char	app_chan [] = "ChanSpy"
static const char	app_dahdiscan [] = "DAHDIScan"
static const char	app_ext [] = "ExtenSpy"
static const struct ast_module_info *	ast_module_info = &__mod_info
static const struct ast_app_option	spy_opts [128] = { [ 'b' ] = { .flag = OPTION_BRIDGED }, [ 'B' ] = { .flag = OPTION_BARGE }, [ 'c' ] = { .flag = OPTION_DTMF_CYCLE , .arg_index = OPT_ARG_CYCLE + 1 }, [ 'd' ] = { .flag = OPTION_DTMF_SWITCH_MODES }, [ 'D' ] = { .flag = OPTION_INTERLEAVED }, [ 'e' ] = { .flag = OPTION_ENFORCED , .arg_index = OPT_ARG_ENFORCED + 1 }, [ 'E' ] = { .flag = OPTION_EXITONHANGUP }, [ 'g' ] = { .flag = OPTION_GROUP , .arg_index = OPT_ARG_GROUP + 1 }, [ 'l' ] = { .flag = OPTION_LONG_QUEUE }, [ 'n' ] = { .flag = OPTION_NAME , .arg_index = OPT_ARG_NAME + 1 }, [ 'N' ] = { .flag = OPTION_NOANSWER }, [ 'o' ] = { .flag = OPTION_READONLY }, [ 'q' ] = { .flag = OPTION_QUIET }, [ 'r' ] = { .flag = OPTION_RECORD , .arg_index = OPT_ARG_RECORD + 1 }, [ 's' ] = { .flag = OPTION_NOTECH }, [ 'S' ] = { .flag = OPTION_STOP }, [ 'u' ] = { .flag = OPTION_UNIQUEID }, [ 'v' ] = { .flag = OPTION_VOLUME , .arg_index = OPT_ARG_VOLUME + 1 }, [ 'w' ] = { .flag = OPTION_WHISPER }, [ 'W' ] = { .flag = OPTION_PRIVATE }, [ 'x' ] = { .flag = OPTION_DTMF_EXIT , .arg_index = OPT_ARG_EXIT + 1 }, [ 'X' ] = { .flag = OPTION_EXIT }, }
static struct ast_generator	spygen

Detailed Description

ChanSpy: Listen in on any channel.

Author

Anthony Minessale II anthm.nosp@m.ct@y.nosp@m.ahoo..nosp@m.com

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

Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

Definition in file app_chanspy.c.

Macro Definition Documentation

AST_NAME_STRLEN

#define AST_NAME_STRLEN   256

Definition at line 60 of file app_chanspy.c.

NUM_SPYGROUPS

#define NUM_SPYGROUPS   128

Definition at line 61 of file app_chanspy.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
OPTION_QUIET
OPTION_BRIDGED
OPTION_VOLUME
OPTION_GROUP
OPTION_RECORD
OPTION_WHISPER
OPTION_PRIVATE
OPTION_READONLY
OPTION_EXIT
OPTION_ENFORCED
OPTION_NOTECH
OPTION_BARGE
OPTION_NAME
OPTION_DTMF_SWITCH_MODES
OPTION_DTMF_EXIT
OPTION_DTMF_CYCLE
OPTION_DAHDI_SCAN
OPTION_STOP
OPTION_EXITONHANGUP
OPTION_UNIQUEID
OPTION_LONG_QUEUE
OPTION_INTERLEAVED
OPTION_NOANSWER

Definition at line 394 of file app_chanspy.c.

     {
    OPTION_QUIET             = (1 << 0),    /* Quiet, no announcement */
    OPTION_BRIDGED           = (1 << 1),    /* Only look at bridged calls */
    OPTION_VOLUME            = (1 << 2),    /* Specify initial volume */
    OPTION_GROUP             = (1 << 3),    /* Only look at channels in group */
    OPTION_RECORD            = (1 << 4),
    OPTION_WHISPER           = (1 << 5),
    OPTION_PRIVATE           = (1 << 6),    /* Private Whisper mode */
    OPTION_READONLY          = (1 << 7),    /* Don't mix the two channels */
    OPTION_EXIT              = (1 << 8),    /* Exit to a valid single digit extension */
    OPTION_ENFORCED          = (1 << 9),    /* Enforced mode */
    OPTION_NOTECH            = (1 << 10),   /* Skip technology name playback */
    OPTION_BARGE             = (1 << 11),   /* Barge mode (whisper to both channels) */
    OPTION_NAME              = (1 << 12),   /* Say the name of the person on whom we will spy */
    OPTION_DTMF_SWITCH_MODES = (1 << 13),   /* Allow numeric DTMF to switch between chanspy modes */
    OPTION_DTMF_EXIT         = (1 << 14),   /* Set DTMF to exit, added for DAHDIScan integration */
    OPTION_DTMF_CYCLE        = (1 << 15),   /* Custom DTMF for cycling next available channel, (default is '*') */
    OPTION_DAHDI_SCAN        = (1 << 16),   /* Scan groups in DAHDIScan mode */
    OPTION_STOP              = (1 << 17),
    OPTION_EXITONHANGUP      = (1 << 18),   /* Hang up when the spied-on channel hangs up. */
    OPTION_UNIQUEID          = (1 << 19),   /* The chanprefix is a channel uniqueid or fully specified channel name. */
    OPTION_LONG_QUEUE        = (1 << 20),   /* Allow usage of a long queue to store audio frames. */
    OPTION_INTERLEAVED       = (1 << 21),   /* Interleave the Read and Write frames in the output frame. */
    OPTION_NOANSWER          = (1 << 22),   /* Do not automatically answer the channel */
};

anonymous enum

anonymous enum

Enumerator
OPT_ARG_VOLUME
OPT_ARG_GROUP
OPT_ARG_RECORD
OPT_ARG_ENFORCED
OPT_ARG_NAME
OPT_ARG_EXIT
OPT_ARG_CYCLE
OPT_ARG_ARRAY_SIZE

Definition at line 420 of file app_chanspy.c.

     {
    OPT_ARG_VOLUME = 0,
    OPT_ARG_GROUP,
    OPT_ARG_RECORD,
    OPT_ARG_ENFORCED,
    OPT_ARG_NAME,
    OPT_ARG_EXIT,
    OPT_ARG_CYCLE,
    OPT_ARG_ARRAY_SIZE,
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 1597 of file app_chanspy.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 1597 of file app_chanspy.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 1597 of file app_chanspy.c.

attach_barge()

static int attach_barge ( struct ast_autochan *  spyee_autochan, struct ast_autochan **  spyee_bridge_autochan, struct ast_audiohook *  bridge_whisper_audiohook, const char *  spyer_name, const char *  name, struct ast_flags *  flags  )

static

Definition at line 699 of file app_chanspy.c.

{
    int retval = 0;
    struct ast_autochan *internal_bridge_autochan;
    struct ast_channel *spyee_chan;
    RAII_VAR(struct ast_channel *, bridged, NULL, ast_channel_cleanup);
 
    ast_autochan_channel_lock(spyee_autochan);
    spyee_chan = ast_channel_ref(spyee_autochan->chan);
    ast_autochan_channel_unlock(spyee_autochan);
    bridged = ast_channel_bridge_peer(spyee_chan);
    ast_channel_unref(spyee_chan);
    if (!bridged) {
        return -1;
    }
 
    ast_audiohook_init(bridge_whisper_audiohook, AST_AUDIOHOOK_TYPE_WHISPER, "Chanspy", 0);
 
    internal_bridge_autochan = ast_autochan_setup(bridged);
    if (!internal_bridge_autochan) {
        return -1;
    }
 
    if (start_whispering(internal_bridge_autochan, spyer_name, bridge_whisper_audiohook, flags)) {
        ast_log(LOG_WARNING, "Unable to attach barge audiohook on spyee '%s'. Barge mode disabled.\n", name);
        retval = -1;
    }
 
    *spyee_bridge_autochan = internal_bridge_autochan;
 
    return retval;
}

References ast_audiohook_init(), AST_AUDIOHOOK_TYPE_WHISPER, ast_autochan_channel_lock, ast_autochan_channel_unlock, ast_autochan_setup(), ast_channel_bridge_peer(), ast_channel_cleanup, ast_channel_ref, ast_channel_unref, ast_log, ast_autochan::chan, ast_channel::flags, LOG_WARNING, name, NULL, RAII_VAR, and start_whispering().

Referenced by channel_spy().

change_spy_mode()

static void change_spy_mode ( const char  digit, struct ast_flags *  flags  )

static

Definition at line 624 of file app_chanspy.c.

{
    if (digit == '4') {
        ast_clear_flag(flags, OPTION_WHISPER);
        ast_clear_flag(flags, OPTION_BARGE);
    } else if (digit == '5') {
        ast_clear_flag(flags, OPTION_BARGE);
        ast_set_flag(flags, OPTION_WHISPER);
    } else if (digit == '6') {
        ast_clear_flag(flags, OPTION_WHISPER);
        ast_set_flag(flags, OPTION_BARGE);
    }
}

References ast_clear_flag, ast_set_flag, digit, OPTION_BARGE, and OPTION_WHISPER.

Referenced by channel_spy().

channel_spy()

static int channel_spy ( struct ast_channel *  chan, struct ast_autochan *  spyee_autochan, int *  volfactor, int  fd, struct spy_dtmf_options *  user_options, struct ast_flags *  flags, char *  exitcontext  )

static

Definition at line 734 of file app_chanspy.c.

{
    struct chanspy_translation_helper csth;
    int running = 0, bridge_connected = 0, res, x = 0;
    char inp[24] = {0};
    char *name;
    struct ast_frame *f;
    struct ast_silence_generator *silgen = NULL;
    struct ast_autochan *spyee_bridge_autochan = NULL;
    const char *spyer_name;
 
    ast_channel_lock(chan);
    if (ast_check_hangup(chan)) {
        ast_channel_unlock(chan);
        return 0;
    }
    spyer_name = ast_strdupa(ast_channel_name(chan));
    ast_channel_unlock(chan);
 
    ast_autochan_channel_lock(spyee_autochan);
    if (ast_check_hangup(spyee_autochan->chan)
        || ast_test_flag(ast_channel_flags(spyee_autochan->chan), AST_FLAG_ZOMBIE)) {
        ast_autochan_channel_unlock(spyee_autochan);
        return 0;
    }
    name = ast_strdupa(ast_channel_name(spyee_autochan->chan));
 
    ast_verb(2, "Spying on channel %s\n", name);
    publish_chanspy_message(chan, spyee_autochan->chan, 1);
    ast_autochan_channel_unlock(spyee_autochan);
 
    memset(&csth, 0, sizeof(csth));
    ast_copy_flags(&csth.flags, flags, AST_FLAGS_ALL);
 
    /* This is the audiohook which gives us the audio off the channel we are
       spying on.
    */
    ast_audiohook_init(&csth.spy_audiohook, AST_AUDIOHOOK_TYPE_SPY, "ChanSpy", 0);
 
    if (start_spying(spyee_autochan, spyer_name, &csth.spy_audiohook, flags)) {
        ast_audiohook_destroy(&csth.spy_audiohook);
        return 0;
    }
 
    if (ast_test_flag(flags, OPTION_WHISPER | OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
        /* This audiohook will let us inject audio from our channel into the
           channel we are currently spying on.
        */
        ast_audiohook_init(&csth.whisper_audiohook, AST_AUDIOHOOK_TYPE_WHISPER, "ChanSpy", 0);
 
        if (start_whispering(spyee_autochan, spyer_name, &csth.whisper_audiohook, flags)) {
            ast_log(LOG_WARNING, "Unable to attach whisper audiohook to spyee %s. Whisper mode disabled!\n", name);
        }
    }
 
    ast_channel_set_flag(chan, AST_FLAG_END_DTMF_ONLY);
 
    csth.volfactor = *volfactor;
 
    if (csth.volfactor) {
        csth.spy_audiohook.options.read_volume = csth.volfactor;
        csth.spy_audiohook.options.write_volume = csth.volfactor;
    }
 
    csth.fd = fd;
 
    if (ast_test_flag(flags, OPTION_PRIVATE))
        silgen = ast_channel_start_silence_generator(chan);
    else
        ast_activate_generator(chan, &spygen, &csth);
 
    /* We can no longer rely on 'spyee' being an actual channel;
       it can be hung up and freed out from under us. However, the
       channel destructor will put NULL into our csth.spy.chan
       field when that happens, so that is our signal that the spyee
       channel has gone away.
    */
 
    /* Note: it is very important that the ast_waitfor() be the first
       condition in this expression, so that if we wait for some period
       of time before receiving a frame from our spying channel, we check
       for hangup on the spied-on channel _after_ knowing that a frame
       has arrived, since the spied-on channel could have gone away while
       we were waiting
    */
    while (ast_waitfor(chan, -1) > -1 && csth.spy_audiohook.status == AST_AUDIOHOOK_STATUS_RUNNING) {
        if (!(f = ast_read(chan)) || ast_check_hangup(chan)) {
            running = -1;
            if (f) {
                ast_frfree(f);
            }
            break;
        }
 
        if (ast_test_flag(flags, OPTION_BARGE) && f->frametype == AST_FRAME_VOICE) {
            /* This hook lets us inject audio into the channel that the spyee is currently
             * bridged with. If the spyee isn't bridged with anything yet, nothing will
             * be attached and we'll need to continue attempting to attach the barge
             * audio hook. */
            if (!bridge_connected && attach_barge(spyee_autochan, &spyee_bridge_autochan,
                    &csth.bridge_whisper_audiohook, spyer_name, name, flags) == 0) {
                bridge_connected = 1;
            }
 
            ast_audiohook_lock(&csth.whisper_audiohook);
            ast_audiohook_write_frame(&csth.whisper_audiohook, AST_AUDIOHOOK_DIRECTION_WRITE, f);
            ast_audiohook_unlock(&csth.whisper_audiohook);
 
            if (bridge_connected) {
                ast_audiohook_lock(&csth.bridge_whisper_audiohook);
                ast_audiohook_write_frame(&csth.bridge_whisper_audiohook, AST_AUDIOHOOK_DIRECTION_WRITE, f);
                ast_audiohook_unlock(&csth.bridge_whisper_audiohook);
            }
 
            ast_frfree(f);
            continue;
        } else if (ast_test_flag(flags, OPTION_WHISPER) && f->frametype == AST_FRAME_VOICE) {
            ast_audiohook_lock(&csth.whisper_audiohook);
            ast_audiohook_write_frame(&csth.whisper_audiohook, AST_AUDIOHOOK_DIRECTION_WRITE, f);
            ast_audiohook_unlock(&csth.whisper_audiohook);
            ast_frfree(f);
            continue;
        }
 
        res = (f->frametype == AST_FRAME_DTMF) ? f->subclass.integer : 0;
        ast_frfree(f);
        if (!res)
            continue;
 
        if (x == sizeof(inp))
            x = 0;
 
        if (res < 0) {
            running = -1;
            break;
        }
 
        if (ast_test_flag(flags, OPTION_EXIT)) {
            char tmp[2];
            tmp[0] = res;
            tmp[1] = '\0';
            if (!ast_goto_if_exists(chan, exitcontext, tmp, 1)) {
                ast_debug(1, "Got DTMF %c, goto context %s\n", tmp[0], exitcontext);
                pbx_builtin_setvar_helper(chan, "SPY_CHANNEL", name);
                running = -2;
                break;
            } else {
                ast_debug(2, "Exit by single digit did not work in chanspy. Extension %s does not exist in context %s\n", tmp, exitcontext);
            }
        } else if (res >= '0' && res <= '9') {
            if (ast_test_flag(flags, OPTION_DTMF_SWITCH_MODES)) {
                change_spy_mode(res, flags);
            } else {
                inp[x++] = res;
            }
        }
 
        if (res == user_options->cycle) {
            running = 0;
            break;
        } else if (res == user_options->exit) {
            running = -2;
            break;
        } else if (res == user_options->volume) {
            if (!ast_strlen_zero(inp)) {
                running = atoi(inp);
                break;
            }
 
            (*volfactor)++;
            if (*volfactor > 4)
                *volfactor = -4;
            ast_verb(3, "Setting spy volume on %s to %d\n", ast_channel_name(chan), *volfactor);
 
            csth.volfactor = *volfactor;
            csth.spy_audiohook.options.read_volume = csth.volfactor;
            csth.spy_audiohook.options.write_volume = csth.volfactor;
        }
    }
 
    if (ast_test_flag(flags, OPTION_PRIVATE))
        ast_channel_stop_silence_generator(chan, silgen);
    else
        ast_deactivate_generator(chan);
 
    ast_channel_clear_flag(chan, AST_FLAG_END_DTMF_ONLY);
 
    if (ast_test_flag(flags, OPTION_WHISPER | OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
        ast_audiohook_lock(&csth.whisper_audiohook);
        ast_audiohook_detach(&csth.whisper_audiohook);
        ast_audiohook_unlock(&csth.whisper_audiohook);
        ast_audiohook_destroy(&csth.whisper_audiohook);
    }
 
    if (ast_test_flag(flags, OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
        ast_audiohook_lock(&csth.bridge_whisper_audiohook);
        ast_audiohook_detach(&csth.bridge_whisper_audiohook);
        ast_audiohook_unlock(&csth.bridge_whisper_audiohook);
        ast_audiohook_destroy(&csth.bridge_whisper_audiohook);
    }
 
    ast_audiohook_lock(&csth.spy_audiohook);
    ast_audiohook_detach(&csth.spy_audiohook);
    ast_audiohook_unlock(&csth.spy_audiohook);
    ast_audiohook_destroy(&csth.spy_audiohook);
 
    ast_verb(2, "Done Spying on channel %s\n", name);
    publish_chanspy_message(chan, spyee_autochan->chan, 0);
 
    if (spyee_bridge_autochan) {
        ast_autochan_destroy(spyee_bridge_autochan);
    }
 
    return running;
}

References ast_activate_generator(), ast_audiohook_destroy(), ast_audiohook_detach(), AST_AUDIOHOOK_DIRECTION_WRITE, ast_audiohook_init(), ast_audiohook_lock, AST_AUDIOHOOK_STATUS_RUNNING, AST_AUDIOHOOK_TYPE_SPY, AST_AUDIOHOOK_TYPE_WHISPER, ast_audiohook_unlock, ast_audiohook_write_frame(), ast_autochan_channel_lock, ast_autochan_channel_unlock, ast_autochan_destroy(), ast_channel_clear_flag(), ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_set_flag(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_channel_unlock, ast_check_hangup(), ast_copy_flags, ast_deactivate_generator(), ast_debug, AST_FLAG_END_DTMF_ONLY, AST_FLAG_ZOMBIE, AST_FLAGS_ALL, AST_FRAME_DTMF, AST_FRAME_VOICE, ast_frfree, ast_goto_if_exists(), ast_log, ast_read(), ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_verb, ast_waitfor(), attach_barge(), chanspy_translation_helper::bridge_whisper_audiohook, ast_autochan::chan, change_spy_mode(), spy_dtmf_options::cycle, spy_dtmf_options::exit, exitcontext, chanspy_translation_helper::fd, chanspy_translation_helper::flags, ast_frame::frametype, ast_frame_subclass::integer, LOG_WARNING, name, NULL, OPTION_BARGE, OPTION_DTMF_SWITCH_MODES, OPTION_EXIT, OPTION_PRIVATE, OPTION_WHISPER, ast_audiohook::options, pbx_builtin_setvar_helper(), publish_chanspy_message(), ast_audiohook_options::read_volume, chanspy_translation_helper::spy_audiohook, spygen, start_spying(), start_whispering(), ast_audiohook::status, ast_frame::subclass, chanspy_translation_helper::volfactor, spy_dtmf_options::volume, chanspy_translation_helper::whisper_audiohook, and ast_audiohook_options::write_volume.

Referenced by common_exec().

chanspy_exec()

static int chanspy_exec ( struct ast_channel *  chan, const char *  data  )

static

Definition at line 1296 of file app_chanspy.c.

{
    char *myenforced = NULL;
    char *mygroup = NULL;
    char *recbase = NULL;
    int fd = 0;
    struct ast_flags flags;
    struct spy_dtmf_options user_options = {
        .cycle = '*',
        .volume = '#',
        .exit = '\0',
    };
    RAII_VAR(struct ast_format *, oldwf, NULL, ao2_cleanup);
    int volfactor = 0;
    int res;
    char *mailbox = NULL;
    char *name_context = NULL;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(spec);
        AST_APP_ARG(options);
    );
    char *opts[OPT_ARG_ARRAY_SIZE];
    char *parse = ast_strdupa(data);
 
    AST_STANDARD_APP_ARGS(args, parse);
 
    if (args.spec && !strcmp(args.spec, "all"))
        args.spec = NULL;
 
    if (args.options) {
        char tmp;
        ast_app_parse_options(spy_opts, &flags, opts, args.options);
        if (ast_test_flag(&flags, OPTION_GROUP))
            mygroup = opts[OPT_ARG_GROUP];
 
        if (ast_test_flag(&flags, OPTION_RECORD) &&
            !(recbase = opts[OPT_ARG_RECORD]))
            recbase = "chanspy";
 
        if (ast_test_flag(&flags, OPTION_DTMF_EXIT) && opts[OPT_ARG_EXIT]) {
            tmp = opts[OPT_ARG_EXIT][0];
            if (strchr("0123456789*#", tmp) && tmp != '\0') {
                user_options.exit = tmp;
            } else {
                ast_log(LOG_NOTICE, "Argument for option 'x' must be a valid DTMF digit.\n");
            }
        }
 
        if (ast_test_flag(&flags, OPTION_DTMF_CYCLE) && opts[OPT_ARG_CYCLE]) {
            tmp = opts[OPT_ARG_CYCLE][0];
            if (strchr("0123456789*#", tmp) && tmp != '\0') {
                user_options.cycle = tmp;
            } else {
                ast_log(LOG_NOTICE, "Argument for option 'c' must be a valid DTMF digit.\n");
            }
        }
 
        if (ast_test_flag(&flags, OPTION_VOLUME) && opts[OPT_ARG_VOLUME]) {
            int vol;
 
            if ((sscanf(opts[OPT_ARG_VOLUME], "%30d", &vol) != 1) || (vol > 4) || (vol < -4))
                ast_log(LOG_NOTICE, "Volume factor must be a number between -4 and 4\n");
            else
                volfactor = vol;
        }
 
        if (ast_test_flag(&flags, OPTION_PRIVATE))
            ast_set_flag(&flags, OPTION_WHISPER);
 
        if (ast_test_flag(&flags, OPTION_ENFORCED))
            myenforced = opts[OPT_ARG_ENFORCED];
 
        if (ast_test_flag(&flags, OPTION_NAME)) {
            if (!ast_strlen_zero(opts[OPT_ARG_NAME])) {
                char *delimiter;
                if ((delimiter = strchr(opts[OPT_ARG_NAME], '@'))) {
                    mailbox = opts[OPT_ARG_NAME];
                    *delimiter++ = '\0';
                    name_context = delimiter;
                } else {
                    mailbox = opts[OPT_ARG_NAME];
                }
            }
        }
    } else {
        ast_clear_flag(&flags, AST_FLAGS_ALL);
    }
 
    oldwf = ao2_bump(ast_channel_writeformat(chan));
    if (ast_set_write_format(chan, ast_format_slin) < 0) {
        ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
        return -1;
    }
 
    if (recbase) {
        char filename[PATH_MAX];
 
        snprintf(filename, sizeof(filename), "%s/%s.%d.raw", ast_config_AST_MONITOR_DIR, recbase, (int) time(NULL));
        if ((fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC, AST_FILE_MODE)) <= 0) {
            ast_log(LOG_WARNING, "Cannot open '%s' for recording\n", filename);
            fd = 0;
        }
    }
 
    res = common_exec(chan, &flags, volfactor, fd, &user_options, mygroup, myenforced, args.spec, NULL, NULL, mailbox, name_context);
 
    if (fd)
        close(fd);
 
    if (oldwf && ast_set_write_format(chan, oldwf) < 0)
        ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
 
    if (ast_test_flag(&flags, OPTION_EXITONHANGUP)) {
        ast_verb(3, "Stopped spying due to the spied-on channel hanging up.\n");
    }
 
    return res;
}

References ao2_bump, ao2_cleanup, args, AST_APP_ARG, ast_app_parse_options(), ast_channel_writeformat(), ast_clear_flag, ast_config_AST_MONITOR_DIR, AST_DECLARE_APP_ARGS, AST_FILE_MODE, AST_FLAGS_ALL, ast_format_slin, ast_log, ast_set_flag, ast_set_write_format(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_verb, common_exec(), spy_dtmf_options::cycle, spy_dtmf_options::exit, ast_flags::flags, LOG_ERROR, LOG_NOTICE, LOG_WARNING, NULL, OPT_ARG_ARRAY_SIZE, OPT_ARG_CYCLE, OPT_ARG_ENFORCED, OPT_ARG_EXIT, OPT_ARG_GROUP, OPT_ARG_NAME, OPT_ARG_RECORD, OPT_ARG_VOLUME, OPTION_DTMF_CYCLE, OPTION_DTMF_EXIT, OPTION_ENFORCED, OPTION_EXITONHANGUP, OPTION_GROUP, OPTION_NAME, OPTION_PRIVATE, OPTION_RECORD, OPTION_VOLUME, OPTION_WHISPER, options, PATH_MAX, RAII_VAR, and spy_opts.

Referenced by load_module().

common_exec()

static int common_exec ( struct ast_channel *  chan, struct ast_flags *  flags, int  volfactor, const int  fd, struct spy_dtmf_options *  user_options, const char *  mygroup, const char *  myenforced, const char *  spec, const char *  exten, const char *  context, const char *  mailbox, const char *  name_context  )

static

Definition at line 986 of file app_chanspy.c.

{
    char nameprefix[AST_NAME_STRLEN];
    char exitcontext[AST_MAX_CONTEXT] = "";
    signed char zero_volume = 0;
    int waitms;
    int res;
    int num_spied_upon = 1;
    struct ast_channel_iterator *iter = NULL;
 
    if (ast_test_flag(flags, OPTION_EXIT)) {
        const char *c;
        ast_channel_lock(chan);
        if ((c = pbx_builtin_getvar_helper(chan, "SPY_EXIT_CONTEXT"))) {
            ast_copy_string(exitcontext, c, sizeof(exitcontext));
        } else {
            ast_copy_string(exitcontext, ast_channel_context(chan), sizeof(exitcontext));
        }
        ast_channel_unlock(chan);
    }
 
    if (!ast_test_flag(flags, OPTION_NOANSWER) && ast_channel_state(chan) != AST_STATE_UP) {
        ast_answer(chan);
    }
 
    ast_channel_set_flag(chan, AST_FLAG_SPYING);
 
    waitms = 100;
 
    for (;;) {
        struct ast_autochan *autochan = NULL, *next_autochan = NULL;
        struct ast_channel *prev = NULL;
 
        if (!ast_test_flag(flags, OPTION_QUIET) && num_spied_upon) {
            res = ast_streamfile(chan, "beep", ast_channel_language(chan));
            if (!res)
                res = ast_waitstream(chan, "");
            else if (res < 0) {
                ast_channel_clear_flag(chan, AST_FLAG_SPYING);
                break;
            }
            if (!ast_strlen_zero(exitcontext)) {
                char tmp[2];
                tmp[0] = res;
                tmp[1] = '\0';
                if (!ast_goto_if_exists(chan, exitcontext, tmp, 1))
                    goto exit;
                else
                    ast_debug(2, "Exit by single digit did not work in chanspy. Extension %s does not exist in context %s\n", tmp, exitcontext);
            }
        }
 
        /* Set up the iterator we'll be using during this call */
        if (!ast_strlen_zero(spec)) {
            if (ast_test_flag(flags, OPTION_UNIQUEID)) {
                struct ast_channel *unique_chan;
 
                unique_chan = ast_channel_get_by_name(spec);
                if (!unique_chan) {
                    res = -1;
                    goto exit;
                }
                iter = ast_channel_iterator_by_name_new(ast_channel_name(unique_chan), 0);
                ast_channel_unref(unique_chan);
            } else {
                iter = ast_channel_iterator_by_name_new(spec, strlen(spec));
            }
        } else if (!ast_strlen_zero(exten)) {
            iter = ast_channel_iterator_by_exten_new(exten, context);
        } else {
            iter = ast_channel_iterator_all_new();
        }
 
        if (!iter) {
            res = -1;
            goto exit;
        }
 
        res = ast_waitfordigit(chan, waitms);
        if (res < 0) {
            iter = ast_channel_iterator_destroy(iter);
            ast_channel_clear_flag(chan, AST_FLAG_SPYING);
            break;
        }
        if (!ast_strlen_zero(exitcontext)) {
            char tmp[2];
            tmp[0] = res;
            tmp[1] = '\0';
            if (!ast_goto_if_exists(chan, exitcontext, tmp, 1)) {
                iter = ast_channel_iterator_destroy(iter);
                goto exit;
            } else {
                ast_debug(2, "Exit by single digit did not work in chanspy. Extension %s does not exist in context %s\n", tmp, exitcontext);
            }
        }
 
        /* reset for the next loop around, unless overridden later */
        waitms = 100;
        num_spied_upon = 0;
 
        for (autochan = next_channel(iter, chan);
            autochan;
            prev = autochan->chan,
                ast_autochan_destroy(autochan),
                autochan = next_autochan ?: next_channel(iter, chan),
                next_autochan = NULL) {
            int igrp = !mygroup;
            int ienf = !myenforced;
 
            if (autochan->chan == prev) {
                ast_autochan_destroy(autochan);
                break;
            }
 
            if (ast_check_hangup(chan)) {
                ast_autochan_destroy(autochan);
                break;
            }
 
            ast_autochan_channel_lock(autochan);
            if (ast_test_flag(flags, OPTION_BRIDGED)
                && !ast_channel_is_bridged(autochan->chan)) {
                ast_autochan_channel_unlock(autochan);
                continue;
            }
 
            if (ast_check_hangup(autochan->chan)
                || ast_test_flag(ast_channel_flags(autochan->chan), AST_FLAG_SPYING)) {
                ast_autochan_channel_unlock(autochan);
                continue;
            }
            ast_autochan_channel_unlock(autochan);
 
            if (mygroup) {
                int num_groups = 0;
                int num_mygroups = 0;
                char dup_group[512];
                char dup_mygroup[512];
                char *groups[NUM_SPYGROUPS];
                char *mygroups[NUM_SPYGROUPS];
                const char *group = NULL;
                int x;
                int y;
                ast_copy_string(dup_mygroup, mygroup, sizeof(dup_mygroup));
                num_mygroups = ast_app_separate_args(dup_mygroup, ':', mygroups,
                    ARRAY_LEN(mygroups));
 
                /* Before dahdi scan was part of chanspy, it would use the "GROUP" variable
                 * rather than "SPYGROUP", this check is done to preserve expected behavior */
                ast_autochan_channel_lock(autochan);
                if (ast_test_flag(flags, OPTION_DAHDI_SCAN)) {
                    group = pbx_builtin_getvar_helper(autochan->chan, "GROUP");
                } else {
                    group = pbx_builtin_getvar_helper(autochan->chan, "SPYGROUP");
                }
                ast_autochan_channel_unlock(autochan);
 
                if (!ast_strlen_zero(group)) {
                    ast_copy_string(dup_group, group, sizeof(dup_group));
                    num_groups = ast_app_separate_args(dup_group, ':', groups,
                        ARRAY_LEN(groups));
                }
 
                for (y = 0; y < num_mygroups; y++) {
                    for (x = 0; x < num_groups; x++) {
                        if (!strcmp(mygroups[y], groups[x])) {
                            igrp = 1;
                            break;
                        }
                    }
                }
            }
 
            if (!igrp) {
                continue;
            }
            if (myenforced) {
                char ext[AST_CHANNEL_NAME + 3];
                char buffer[512];
                char *end;
 
                snprintf(buffer, sizeof(buffer) - 1, ":%s:", myenforced);
 
                ast_autochan_channel_lock(autochan);
                ast_copy_string(ext + 1, ast_channel_name(autochan->chan), sizeof(ext) - 1);
                ast_autochan_channel_unlock(autochan);
                if ((end = strchr(ext, '-'))) {
                    *end++ = ':';
                    *end = '\0';
                }
 
                ext[0] = ':';
 
                if (strcasestr(buffer, ext)) {
                    ienf = 1;
                }
            }
 
            if (!ienf) {
                continue;
            }
 
            if (!ast_test_flag(flags, OPTION_QUIET)) {
                char peer_name[AST_NAME_STRLEN + 5];
                char *ptr, *s;
 
                strcpy(peer_name, "spy-");
                ast_autochan_channel_lock(autochan);
                strncat(peer_name, ast_channel_name(autochan->chan), AST_NAME_STRLEN - 4 - 1);
                ast_autochan_channel_unlock(autochan);
                if ((ptr = strchr(peer_name, '/'))) {
                    *ptr++ = '\0';
                    for (s = peer_name; s < ptr; s++) {
                        *s = tolower(*s);
                    }
                    if ((s = strchr(ptr, '-'))) {
                        *s = '\0';
                    }
                }
 
                if (ast_test_flag(flags, OPTION_NAME)) {
                    const char *local_context = S_OR(name_context, "default");
                    const char *local_mailbox = S_OR(mailbox, ptr);
 
                    if (local_mailbox) {
                        res = spy_sayname(chan, local_mailbox, local_context);
                    } else {
                        res = -1;
                    }
                }
                if (!ast_test_flag(flags, OPTION_NAME) || res < 0) {
                    int num;
                    if (!ast_test_flag(flags, OPTION_NOTECH)) {
                        if (ast_fileexists(peer_name, NULL, NULL) > 0) {
                            res = ast_streamfile(chan, peer_name, ast_channel_language(chan));
                            if (!res) {
                                res = ast_waitstream(chan, "");
                            }
                            if (res) {
                                ast_autochan_destroy(autochan);
                                break;
                            }
                        } else {
                            res = ast_say_character_str(chan, peer_name, "", ast_channel_language(chan), AST_SAY_CASE_NONE);
                        }
                    }
                    if (ptr && (num = atoi(ptr))) {
                        ast_say_digits(chan, num, "", ast_channel_language(chan));
                    }
                }
            }
 
            res = channel_spy(chan, autochan, &volfactor, fd, user_options, flags, exitcontext);
            num_spied_upon++;
 
            if (res == -1) {
                ast_autochan_destroy(autochan);
                iter = ast_channel_iterator_destroy(iter);
                goto exit;
            } else if (res == -2) {
                res = 0;
                ast_autochan_destroy(autochan);
                iter = ast_channel_iterator_destroy(iter);
                goto exit;
            } else if (res > 1 && spec && !ast_test_flag(flags, OPTION_UNIQUEID)) {
                struct ast_channel *next;
 
                snprintf(nameprefix, AST_NAME_STRLEN, "%s/%d", spec, res);
 
                if ((next = ast_channel_get_by_name_prefix(nameprefix, strlen(nameprefix)))) {
                    next_autochan = ast_autochan_setup(next);
                    next = ast_channel_unref(next);
                } else {
                    /* stay on this channel, if it is still valid */
                    ast_autochan_channel_lock(autochan);
                    if (!ast_check_hangup(autochan->chan)) {
                        next_autochan = ast_autochan_setup(autochan->chan);
                    } else {
                        /* the channel is gone */
                        next_autochan = NULL;
                    }
                    ast_autochan_channel_unlock(autochan);
                }
            } else if (res == 0 && ast_test_flag(flags, OPTION_EXITONHANGUP)) {
                ast_autochan_destroy(autochan);
                iter = ast_channel_iterator_destroy(iter);
                goto exit;
            }
        }
 
        iter = ast_channel_iterator_destroy(iter);
 
        if (res == -1 || ast_check_hangup(chan))
            break;
        if (ast_test_flag(flags, OPTION_STOP) && !next_autochan) {
            break;
        }
    }
exit:
 
    ast_channel_clear_flag(chan, AST_FLAG_SPYING);
 
    ast_channel_setoption(chan, AST_OPTION_TXGAIN, &zero_volume, sizeof(zero_volume), 0);
 
    return res;
}

References ARRAY_LEN, ast_answer(), ast_app_separate_args, ast_autochan_channel_lock, ast_autochan_channel_unlock, ast_autochan_destroy(), ast_autochan_setup(), ast_channel_clear_flag(), ast_channel_context(), ast_channel_flags(), ast_channel_get_by_name(), ast_channel_get_by_name_prefix(), ast_channel_is_bridged(), ast_channel_iterator_all_new(), ast_channel_iterator_by_exten_new(), ast_channel_iterator_by_name_new(), ast_channel_iterator_destroy(), ast_channel_language(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_name(), ast_channel_set_flag(), ast_channel_setoption(), ast_channel_unlock, ast_channel_unref, ast_check_hangup(), ast_copy_string(), ast_debug, ast_fileexists(), AST_FLAG_SPYING, ast_goto_if_exists(), AST_MAX_CONTEXT, AST_NAME_STRLEN, AST_OPTION_TXGAIN, AST_SAY_CASE_NONE, ast_say_character_str(), ast_say_digits(), AST_STATE_UP, ast_streamfile(), ast_strlen_zero(), ast_test_flag, ast_waitfordigit(), ast_waitstream(), c, ast_autochan::chan, channel_spy(), ast_channel::context, end, exitcontext, ext, ast_channel::exten, ast_channel::flags, next_channel(), NULL, NUM_SPYGROUPS, OPTION_BRIDGED, OPTION_DAHDI_SCAN, OPTION_EXIT, OPTION_EXITONHANGUP, OPTION_NAME, OPTION_NOANSWER, OPTION_NOTECH, OPTION_QUIET, OPTION_STOP, OPTION_UNIQUEID, pbx_builtin_getvar_helper(), S_OR, spy_sayname(), strcasestr(), and ast_channel::x.

Referenced by chanspy_exec(), dahdiscan_exec(), and extenspy_exec().

dahdiscan_exec()

static int dahdiscan_exec ( struct ast_channel *  chan, const char *  data  )

static

Definition at line 1536 of file app_chanspy.c.

{
    const char *spec = "DAHDI";
    struct ast_flags flags = {0};
    struct spy_dtmf_options user_options = {
        .cycle = '#',
        .volume = '\0',
        .exit = '*',
    };
    struct ast_format *oldwf;
    int res;
    char *mygroup = NULL;
 
    /* Coverity - This uninit_use should be ignored since this macro initializes the flags */
    ast_clear_flag(&flags, AST_FLAGS_ALL);
 
    if (!ast_strlen_zero(data)) {
        mygroup = ast_strdupa(data);
    }
    ast_set_flag(&flags, OPTION_DTMF_EXIT);
    ast_set_flag(&flags, OPTION_DTMF_CYCLE);
    ast_set_flag(&flags, OPTION_DAHDI_SCAN);
 
    oldwf = ao2_bump(ast_channel_writeformat(chan));
    if (ast_set_write_format(chan, ast_format_slin) < 0) {
        ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
        ao2_cleanup(oldwf);
        return -1;
    }
 
    res = common_exec(chan, &flags, 0, 0, &user_options, mygroup, NULL, spec, NULL, NULL, NULL, NULL);
 
    if (oldwf && ast_set_write_format(chan, oldwf) < 0)
        ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
    ao2_cleanup(oldwf);
 
    return res;
}

References ao2_bump, ao2_cleanup, ast_channel_writeformat(), ast_clear_flag, AST_FLAGS_ALL, ast_format_slin, ast_log, ast_set_flag, ast_set_write_format(), ast_strdupa, ast_strlen_zero(), common_exec(), spy_dtmf_options::cycle, ast_flags::flags, LOG_ERROR, NULL, OPTION_DAHDI_SCAN, OPTION_DTMF_CYCLE, and OPTION_DTMF_EXIT.

Referenced by load_module().

extenspy_exec()

static int extenspy_exec ( struct ast_channel *  chan, const char *  data  )

static

Definition at line 1415 of file app_chanspy.c.

{
    char *ptr, *exten = NULL;
    char *mygroup = NULL;
    char *recbase = NULL;
    int fd = 0;
    struct ast_flags flags;
    struct spy_dtmf_options user_options = {
        .cycle = '*',
        .volume = '#',
        .exit = '\0',
    };
    RAII_VAR(struct ast_format *, oldwf, NULL, ao2_cleanup);
    int volfactor = 0;
    int res;
    char *mailbox = NULL;
    char *name_context = NULL;
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(context);
        AST_APP_ARG(options);
    );
    char *parse = ast_strdupa(data);
 
    AST_STANDARD_APP_ARGS(args, parse);
 
    if (!ast_strlen_zero(args.context) && (ptr = strchr(args.context, '@'))) {
        exten = args.context;
        *ptr++ = '\0';
        args.context = ptr;
    }
    if (ast_strlen_zero(args.context))
        args.context = ast_strdupa(ast_channel_context(chan));
 
    if (args.options) {
        char *opts[OPT_ARG_ARRAY_SIZE];
        char tmp;
 
        ast_app_parse_options(spy_opts, &flags, opts, args.options);
        if (ast_test_flag(&flags, OPTION_GROUP))
            mygroup = opts[OPT_ARG_GROUP];
 
        if (ast_test_flag(&flags, OPTION_RECORD) &&
            !(recbase = opts[OPT_ARG_RECORD]))
            recbase = "chanspy";
 
        if (ast_test_flag(&flags, OPTION_DTMF_EXIT) && opts[OPT_ARG_EXIT]) {
            tmp = opts[OPT_ARG_EXIT][0];
            if (strchr("0123456789*#", tmp) && tmp != '\0') {
                user_options.exit = tmp;
            } else {
                ast_log(LOG_NOTICE, "Argument for option 'x' must be a valid DTMF digit.\n");
            }
        }
 
        if (ast_test_flag(&flags, OPTION_DTMF_CYCLE) && opts[OPT_ARG_CYCLE]) {
            tmp = opts[OPT_ARG_CYCLE][0];
            if (strchr("0123456789*#", tmp) && tmp != '\0') {
                user_options.cycle = tmp;
            } else {
                ast_log(LOG_NOTICE, "Argument for option 'c' must be a valid DTMF digit.\n");
            }
        }
 
        if (ast_test_flag(&flags, OPTION_VOLUME) && opts[OPT_ARG_VOLUME]) {
            int vol;
 
            if ((sscanf(opts[OPT_ARG_VOLUME], "%30d", &vol) != 1) || (vol > 4) || (vol < -4))
                ast_log(LOG_NOTICE, "Volume factor must be a number between -4 and 4\n");
            else
                volfactor = vol;
        }
 
        if (ast_test_flag(&flags, OPTION_PRIVATE))
            ast_set_flag(&flags, OPTION_WHISPER);
 
        if (ast_test_flag(&flags, OPTION_NAME)) {
            if (!ast_strlen_zero(opts[OPT_ARG_NAME])) {
                char *delimiter;
                if ((delimiter = strchr(opts[OPT_ARG_NAME], '@'))) {
                    mailbox = opts[OPT_ARG_NAME];
                    *delimiter++ = '\0';
                    name_context = delimiter;
                } else {
                    mailbox = opts[OPT_ARG_NAME];
                }
            }
        }
 
    } else {
        /* Coverity - This uninit_use should be ignored since this macro initializes the flags */
        ast_clear_flag(&flags, AST_FLAGS_ALL);
    }
 
    oldwf = ao2_bump(ast_channel_writeformat(chan));
    if (ast_set_write_format(chan, ast_format_slin) < 0) {
        ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
        return -1;
    }
 
    if (recbase) {
        char filename[PATH_MAX];
 
        snprintf(filename, sizeof(filename), "%s/%s.%d.raw", ast_config_AST_MONITOR_DIR, recbase, (int) time(NULL));
        if ((fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC, AST_FILE_MODE)) <= 0) {
            ast_log(LOG_WARNING, "Cannot open '%s' for recording\n", filename);
            fd = 0;
        }
    }
 
 
    res = common_exec(chan, &flags, volfactor, fd, &user_options, mygroup, NULL, NULL, exten, args.context, mailbox, name_context);
 
    if (fd)
        close(fd);
 
    if (oldwf && ast_set_write_format(chan, oldwf) < 0)
        ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
 
    return res;
}

References ao2_bump, ao2_cleanup, args, AST_APP_ARG, ast_app_parse_options(), ast_channel_context(), ast_channel_writeformat(), ast_clear_flag, ast_config_AST_MONITOR_DIR, AST_DECLARE_APP_ARGS, AST_FILE_MODE, AST_FLAGS_ALL, ast_format_slin, ast_log, ast_set_flag, ast_set_write_format(), AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, common_exec(), spy_dtmf_options::cycle, spy_dtmf_options::exit, ast_flags::flags, LOG_ERROR, LOG_NOTICE, LOG_WARNING, NULL, OPT_ARG_ARRAY_SIZE, OPT_ARG_CYCLE, OPT_ARG_EXIT, OPT_ARG_GROUP, OPT_ARG_NAME, OPT_ARG_RECORD, OPT_ARG_VOLUME, OPTION_DTMF_CYCLE, OPTION_DTMF_EXIT, OPTION_GROUP, OPTION_NAME, OPTION_PRIVATE, OPTION_RECORD, OPTION_VOLUME, OPTION_WHISPER, options, PATH_MAX, RAII_VAR, and spy_opts.

Referenced by load_module().

load_module()

static int load_module ( void  )

static

Definition at line 1586 of file app_chanspy.c.

{
    int res = 0;
 
    res |= ast_register_application_xml(app_chan, chanspy_exec);
    res |= ast_register_application_xml(app_ext, extenspy_exec);
    res |= ast_register_application_xml(app_dahdiscan, dahdiscan_exec);
 
    return res;
}

References app_chan, app_dahdiscan, app_ext, ast_register_application_xml, chanspy_exec(), dahdiscan_exec(), and extenspy_exec().

next_channel()

static struct ast_autochan * next_channel ( struct ast_channel_iterator *  iter, struct ast_channel *  chan  )

static

Definition at line 952 of file app_chanspy.c.

{
    struct ast_channel *next;
    struct ast_autochan *autochan_store;
    const size_t pseudo_len = strlen("DAHDI/pseudo");
 
    if (!iter) {
        return NULL;
    }
 
    for (; (next = ast_channel_iterator_next(iter)); ast_channel_unref(next)) {
        if (!strncmp(ast_channel_name(next), "DAHDI/pseudo", pseudo_len)
            || next == chan) {
            continue;
        }
 
        autochan_store = ast_autochan_setup(next);
        ast_channel_unref(next);
 
        return autochan_store;
    }
    return NULL;
}

References ast_autochan_setup(), ast_channel_iterator_next(), ast_channel_name(), ast_channel_unref, ast_autochan::chan, ast_autochan::next, and NULL.

Referenced by common_exec().

pack_channel_into_message()

static int pack_channel_into_message ( struct ast_channel *  chan, const char *  role, struct ast_multi_channel_blob *  payload  )

static

Definition at line 638 of file app_chanspy.c.

{
    RAII_VAR(struct ast_channel_snapshot *, snapshot,
            ast_channel_snapshot_get_latest(ast_channel_uniqueid(chan)),
            ao2_cleanup);
 
    if (!snapshot) {
        return -1;
    }
    ast_multi_channel_blob_add_channel(payload, role, snapshot);
    return 0;
}

References ao2_cleanup, ast_channel_snapshot_get_latest(), ast_channel_uniqueid(), ast_multi_channel_blob_add_channel(), and RAII_VAR.

Referenced by publish_chanspy_message().

publish_chanspy_message()

static void publish_chanspy_message ( struct ast_channel *  spyer, struct ast_channel *  spyee, int  start  )

static

Definition at line 659 of file app_chanspy.c.

{
    RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
    RAII_VAR(struct ast_multi_channel_blob *, payload, NULL, ao2_cleanup);
    RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
    struct stasis_message_type *type = start ? ast_channel_chanspy_start_type(): ast_channel_chanspy_stop_type();
 
    if (!spyer) {
        ast_log(AST_LOG_WARNING, "Attempt to publish ChanSpy message for NULL spyer channel\n");
        return;
    }
    blob = ast_json_null();
    if (!blob || !type) {
        return;
    }
 
    payload = ast_multi_channel_blob_create(blob);
    if (!payload) {
        return;
    }
 
    if (pack_channel_into_message(spyer, "spyer_channel", payload)) {
        return;
    }
 
    if (spyee) {
        if (pack_channel_into_message(spyee, "spyee_channel", payload)) {
            return;
        }
    }
 
    message = stasis_message_create(type, payload);
    if (!message) {
        return;
    }
    stasis_publish(ast_channel_topic(spyer), message);
}

References ao2_cleanup, ast_channel_chanspy_start_type(), ast_channel_chanspy_stop_type(), ast_channel_topic(), ast_json_null(), ast_json_unref(), ast_log, AST_LOG_WARNING, ast_multi_channel_blob_create(), NULL, pack_channel_into_message(), RAII_VAR, stasis_message_create(), stasis_publish(), and type.

Referenced by channel_spy().

spy_alloc()

static void * spy_alloc ( struct ast_channel *  chan, void *  data  )

static

Definition at line 472 of file app_chanspy.c.

{
    /* just store the data pointer in the channel structure */
    return data;
}

spy_generate()

static int spy_generate ( struct ast_channel *  chan, void *  data, int  len, int  samples  )

static

Definition at line 483 of file app_chanspy.c.

{
    struct chanspy_translation_helper *csth = data;
    struct ast_frame *f, *cur;
 
    ast_audiohook_lock(&csth->spy_audiohook);
    if (csth->spy_audiohook.status != AST_AUDIOHOOK_STATUS_RUNNING) {
        /* Channel is already gone more than likely */
        ast_audiohook_unlock(&csth->spy_audiohook);
        return -1;
    }
 
    if (ast_test_flag(&csth->flags, OPTION_READONLY)) {
        /* Option 'o' was set, so don't mix channel audio */
        f = ast_audiohook_read_frame(&csth->spy_audiohook, samples, AST_AUDIOHOOK_DIRECTION_READ, ast_format_slin);
    } else if (ast_test_flag(&csth->flags, OPTION_INTERLEAVED)) {
        /* Option 'D' was set, so mix the spy frame as an interleaved dual channel frame. */
        int i;
        struct ast_frame *fr_read = NULL;
        struct ast_frame *fr_write = NULL;
        short read_buf[samples];
        short write_buf[samples];
        short stereo_buf[samples * 2];
        struct ast_frame stereo_frame = {
            .frametype = AST_FRAME_VOICE,
            .datalen = sizeof(stereo_buf),
            .samples = samples,
        };
 
        f = ast_audiohook_read_frame_all(&csth->spy_audiohook, samples, ast_format_slin, &fr_read, &fr_write);
        if (f) {
            ast_frame_free(f, 0);
            f = NULL;
        }
 
        if (fr_read) {
            memcpy(read_buf, fr_read->data.ptr, sizeof(read_buf));
        } else {
            /* silent out the output frame if we can't read the input */
            memset(read_buf, 0, sizeof(read_buf));
        }
 
        if (fr_write) {
            memcpy(write_buf, fr_write->data.ptr, sizeof(write_buf));
        } else {
            memset(write_buf, 0, sizeof(write_buf));
        }
 
        for (i = 0; i < samples; i++) {
            stereo_buf[i*2] = read_buf[i];
            stereo_buf[i*2+1] = write_buf[i];
        }
 
        stereo_frame.data.ptr = stereo_buf;
        stereo_frame.subclass.format = ast_format_cache_get_slin_by_rate(samples);
 
        f = ast_frdup(&stereo_frame);
 
        if (fr_read) {
            ast_frame_free(fr_read, 0);
        }
        if (fr_write) {
            ast_frame_free(fr_write, 0);
        }
 
    } else {
        f = ast_audiohook_read_frame(&csth->spy_audiohook, samples, AST_AUDIOHOOK_DIRECTION_BOTH, ast_format_slin);
    }
 
    ast_audiohook_unlock(&csth->spy_audiohook);
 
    if (!f)
        return 0;
 
    for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
        if (ast_write(chan, cur)) {
            ast_frfree(f);
            return -1;
        }
 
        if (csth->fd) {
            if (write(csth->fd, cur->data.ptr, cur->datalen) < 0) {
                ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
            }
        }
    }
 
    ast_frfree(f);
 
    return 0;
}

References AST_AUDIOHOOK_DIRECTION_BOTH, AST_AUDIOHOOK_DIRECTION_READ, ast_audiohook_lock, ast_audiohook_read_frame(), ast_audiohook_read_frame_all(), AST_AUDIOHOOK_STATUS_RUNNING, ast_audiohook_unlock, ast_format_cache_get_slin_by_rate(), ast_format_slin, ast_frame_free(), AST_FRAME_VOICE, ast_frdup, ast_frfree, AST_LIST_NEXT, ast_log, ast_test_flag, ast_write(), ast_frame::data, ast_frame::datalen, errno, chanspy_translation_helper::fd, chanspy_translation_helper::flags, ast_frame_subclass::format, ast_frame::frametype, LOG_WARNING, NULL, OPTION_INTERLEAVED, OPTION_READONLY, ast_frame::ptr, ast_frame::samples, chanspy_translation_helper::spy_audiohook, ast_audiohook::status, ast_frame::subclass, and write_buf().

spy_release()

static void spy_release ( struct ast_channel *  chan, void *  data  )

static

Definition at line 478 of file app_chanspy.c.

{
    /* nothing to do */
}

spy_sayname()

static int spy_sayname ( struct ast_channel *  chan, const char *  mailbox, const char *  context  )

static

Definition at line 977 of file app_chanspy.c.

{
    char *mailbox_id;
 
    mailbox_id = ast_alloca(strlen(mailbox) + strlen(context) + 2);
    sprintf(mailbox_id, "%s@%s", mailbox, context); /* Safe */
    return ast_app_sayname(chan, mailbox_id);
}

References ast_alloca, ast_app_sayname(), and ast_autochan::chan.

Referenced by common_exec().

start_spying()

static int start_spying ( struct ast_autochan *  autochan, const char *  spychan_name, struct ast_audiohook *  audiohook, struct ast_flags *  flags  )

static

Definition at line 581 of file app_chanspy.c.

{
    int res;
 
    ast_autochan_channel_lock(autochan);
    ast_verb(3, "Attaching spy channel %s to %s\n",
        spychan_name, ast_channel_name(autochan->chan));
 
    if (ast_test_flag(flags, OPTION_READONLY)) {
        ast_audiohook_set_frame_feed_direction(audiohook, AST_AUDIOHOOK_DIRECTION_READ);
        ast_set_flag(audiohook, AST_AUDIOHOOK_MUTE_WRITE);
    } else {
        ast_set_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC);
    }
    if (ast_test_flag(flags, OPTION_LONG_QUEUE)) {
        ast_debug(9, "Using a long queue to store audio frames in spy audiohook\n");
    } else {
        ast_set_flag(audiohook, AST_AUDIOHOOK_SMALL_QUEUE);
    }
    res = ast_audiohook_attach(autochan->chan, audiohook);
    ast_autochan_channel_unlock(autochan);
    return res;
}

References ast_audiohook_attach(), AST_AUDIOHOOK_DIRECTION_READ, AST_AUDIOHOOK_MUTE_WRITE, ast_audiohook_set_frame_feed_direction(), AST_AUDIOHOOK_SMALL_QUEUE, AST_AUDIOHOOK_TRIGGER_SYNC, ast_autochan_channel_lock, ast_autochan_channel_unlock, ast_channel_name(), ast_debug, ast_set_flag, ast_test_flag, ast_verb, ast_autochan::chan, OPTION_LONG_QUEUE, and OPTION_READONLY.

Referenced by channel_spy().

start_whispering()

static int start_whispering ( struct ast_autochan *  autochan, const char *  spychan_name, struct ast_audiohook *  audiohook, struct ast_flags *  flags  )

static

Definition at line 605 of file app_chanspy.c.

{
    int res;
 
    ast_autochan_channel_lock(autochan);
    ast_verb(3, "Attaching spy channel %s to %s\n",
        spychan_name, ast_channel_name(autochan->chan));
 
    ast_set_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC);
    if (ast_test_flag(flags, OPTION_LONG_QUEUE)) {
        ast_debug(9, "Using a long queue to store audio frames in whisper audiohook\n");
    } else {
        ast_set_flag(audiohook, AST_AUDIOHOOK_SMALL_QUEUE);
    }
    res = ast_audiohook_attach(autochan->chan, audiohook);
    ast_autochan_channel_unlock(autochan);
    return res;
}

References ast_audiohook_attach(), AST_AUDIOHOOK_SMALL_QUEUE, AST_AUDIOHOOK_TRIGGER_SYNC, ast_autochan_channel_lock, ast_autochan_channel_unlock, ast_channel_name(), ast_debug, ast_set_flag, ast_test_flag, ast_verb, ast_autochan::chan, and OPTION_LONG_QUEUE.

Referenced by attach_barge(), and channel_spy().

unload_module()

static int unload_module ( void  )

static

Definition at line 1575 of file app_chanspy.c.

{
    int res = 0;
 
    res |= ast_unregister_application(app_chan);
    res |= ast_unregister_application(app_ext);
    res |= ast_unregister_application(app_dahdiscan);
 
    return res;
}

References app_chan, app_dahdiscan, app_ext, and ast_unregister_application().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Listen to the audio of an active channel" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 1597 of file app_chanspy.c.

app_chan

const char app_chan[] = "ChanSpy"

static

Definition at line 388 of file app_chanspy.c.

Referenced by load_module(), and unload_module().

app_dahdiscan

const char app_dahdiscan[] = "DAHDIScan"

static

Definition at line 392 of file app_chanspy.c.

Referenced by load_module(), and unload_module().

app_ext

const char app_ext[] = "ExtenSpy"

static

Definition at line 390 of file app_chanspy.c.

Referenced by load_module(), and unload_module().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 1597 of file app_chanspy.c.

spy_opts

const struct ast_app_option spy_opts[128] = { [ 'b' ] = { .flag = OPTION_BRIDGED }, [ 'B' ] = { .flag = OPTION_BARGE }, [ 'c' ] = { .flag = OPTION_DTMF_CYCLE , .arg_index = OPT_ARG_CYCLE + 1 }, [ 'd' ] = { .flag = OPTION_DTMF_SWITCH_MODES }, [ 'D' ] = { .flag = OPTION_INTERLEAVED }, [ 'e' ] = { .flag = OPTION_ENFORCED , .arg_index = OPT_ARG_ENFORCED + 1 }, [ 'E' ] = { .flag = OPTION_EXITONHANGUP }, [ 'g' ] = { .flag = OPTION_GROUP , .arg_index = OPT_ARG_GROUP + 1 }, [ 'l' ] = { .flag = OPTION_LONG_QUEUE }, [ 'n' ] = { .flag = OPTION_NAME , .arg_index = OPT_ARG_NAME + 1 }, [ 'N' ] = { .flag = OPTION_NOANSWER }, [ 'o' ] = { .flag = OPTION_READONLY }, [ 'q' ] = { .flag = OPTION_QUIET }, [ 'r' ] = { .flag = OPTION_RECORD , .arg_index = OPT_ARG_RECORD + 1 }, [ 's' ] = { .flag = OPTION_NOTECH }, [ 'S' ] = { .flag = OPTION_STOP }, [ 'u' ] = { .flag = OPTION_UNIQUEID }, [ 'v' ] = { .flag = OPTION_VOLUME , .arg_index = OPT_ARG_VOLUME + 1 }, [ 'w' ] = { .flag = OPTION_WHISPER }, [ 'W' ] = { .flag = OPTION_PRIVATE }, [ 'x' ] = { .flag = OPTION_DTMF_EXIT , .arg_index = OPT_ARG_EXIT + 1 }, [ 'X' ] = { .flag = OPTION_EXIT }, }

static

Definition at line 454 of file app_chanspy.c.

Referenced by chanspy_exec(), and extenspy_exec().

spygen

struct ast_generator spygen

static

Initial value:

= {
    .alloc = spy_alloc,
    .release = spy_release,
    .generate = spy_generate,
}

Definition at line 575 of file app_chanspy.c.

                                     {
    .alloc = spy_alloc,
    .release = spy_release,
    .generate = spy_generate,
};

Referenced by channel_spy().