2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 2005 Anthony Minessale II (anthmct@yahoo.com)
5 * Copyright (C) 2005 - 2008, Digium, Inc.
7 * A license has been granted to Digium (via disclaimer) for the use of
10 * See http://www.asterisk.org for more information about
11 * the Asterisk project. Please do not directly contact
12 * any of the maintainers of this project for assistance;
13 * the project provides a web site, mailing lists and IRC
14 * channels for your use.
16 * This program is free software, distributed under the terms of
17 * the GNU General Public License Version 2. See the LICENSE file
18 * at the top of the source tree.
23 * \brief ChanSpy: Listen in on any channel.
25 * \author Anthony Minessale II <anthmct@yahoo.com>
26 * \author Joshua Colp <jcolp@digium.com>
27 * \author Russell Bryant <russell@digium.com>
29 * \ingroup applications
33 <support_level>core</support_level>
38 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
43 #include "asterisk/paths.h" /* use ast_config_AST_MONITOR_DIR */
44 #include "asterisk/file.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/audiohook.h"
47 #include "asterisk/features.h"
48 #include "asterisk/app.h"
49 #include "asterisk/utils.h"
50 #include "asterisk/say.h"
51 #include "asterisk/pbx.h"
52 #include "asterisk/translate.h"
53 #include "asterisk/manager.h"
54 #include "asterisk/module.h"
55 #include "asterisk/lock.h"
56 #include "asterisk/options.h"
57 #include "asterisk/autochan.h"
59 #define AST_NAME_STRLEN 256
60 #define NUM_SPYGROUPS 128
63 <application name="ChanSpy" language="en_US">
65 Listen to a channel, and optionally whisper into it.
68 <parameter name="chanprefix" />
69 <parameter name="options">
72 <para>Only spy on channels involved in a bridged call.</para>
75 <para>Instead of whispering on a single channel barge in on both
76 channels involved in the call.</para>
79 <argument name="digit" required="true">
80 <para>Specify a DTMF digit that can be used to spy on the next available channel.</para>
84 <para>Override the typical numeric DTMF functionality and instead
85 use DTMF to switch between spy modes.</para>
91 <para>whisper mode</para>
94 <para>barge mode</para>
99 <argument name="ext" required="true" />
100 <para>Enable <emphasis>enforced</emphasis> mode, so the spying channel can
101 only monitor extensions whose name is in the <replaceable>ext</replaceable> : delimited
105 <para>Exit when the spied-on channel hangs up.</para>
108 <argument name="grp" required="true">
109 <para>Only spy on channels in which one or more of the groups
110 listed in <replaceable>grp</replaceable> matches one or more groups from the
111 <variable>SPYGROUP</variable> variable set on the channel to be spied upon.</para>
113 <note><para>both <replaceable>grp</replaceable> and <variable>SPYGROUP</variable> can contain
114 either a single group or a colon-delimited list of groups, such
115 as <literal>sales:support:accounting</literal>.</para></note>
117 <option name="n" argsep="@">
118 <para>Say the name of the person being spied on if that person has recorded
119 his/her name. If a context is specified, then that voicemail context will
120 be searched when retrieving the name, otherwise the <literal>default</literal> context
121 be used when searching for the name (i.e. if SIP/1000 is the channel being
122 spied on and no mailbox is specified, then <literal>1000</literal> will be used when searching
123 for the name).</para>
124 <argument name="mailbox" />
125 <argument name="context" />
128 <para>Only listen to audio coming from this channel.</para>
131 <para>Don't play a beep when beginning to spy on a channel, or speak the
132 selected channel name.</para>
135 <para>Record the session to the monitor spool directory. An optional base for the filename
136 may be specified. The default is <literal>chanspy</literal>.</para>
137 <argument name="basename" />
140 <para>Skip the playback of the channel type (i.e. SIP, IAX, etc) when
141 speaking the selected channel name.</para>
144 <para>Stop when no more channels are left to spy on.</para>
147 <argument name="value" />
148 <para>Adjust the initial volume in the range from <literal>-4</literal>
149 to <literal>4</literal>. A negative value refers to a quieter setting.</para>
152 <para>Enable <literal>whisper</literal> mode, so the spying channel can talk to
153 the spied-on channel.</para>
156 <para>Enable <literal>private whisper</literal> mode, so the spying channel can
157 talk to the spied-on channel but cannot listen to that channel.</para>
160 <argument name="digit" required="true">
161 <para>Specify a DTMF digit that can be used to exit the application.</para>
165 <para>Allow the user to exit ChanSpy to a valid single digit
166 numeric extension in the current context or the context
167 specified by the <variable>SPY_EXIT_CONTEXT</variable> channel variable. The
168 name of the last channel that was spied on will be stored
169 in the <variable>SPY_CHANNEL</variable> variable.</para>
175 <para>This application is used to listen to the audio from an Asterisk channel. This includes the audio
176 coming in and out of the channel being spied on. If the <literal>chanprefix</literal> parameter is specified,
177 only channels beginning with this string will be spied upon.</para>
178 <para>While spying, the following actions may be performed:</para>
179 <para> - Dialing <literal>#</literal> cycles the volume level.</para>
180 <para> - Dialing <literal>*</literal> will stop spying and look for another channel to spy on.</para>
181 <para> - Dialing a series of digits followed by <literal>#</literal> builds a channel name to append
182 to 'chanprefix'. For example, executing ChanSpy(Agent) and then dialing the digits '1234#'
183 while spying will begin spying on the channel 'Agent/1234'. Note that this feature will be overridden if the 'd' option
185 <note><para>The <replaceable>X</replaceable> option supersedes the three features above in that if a valid
186 single digit extension exists in the correct context ChanSpy will exit to it.
187 This also disables choosing a channel based on <literal>chanprefix</literal> and a digit sequence.</para></note>
190 <ref type="application">ExtenSpy</ref>
193 <application name="ExtenSpy" language="en_US">
195 Listen to a channel, and optionally whisper into it.
198 <parameter name="exten" required="true" argsep="@">
199 <argument name="exten" required="true">
200 <para>Specify extension.</para>
202 <argument name="context">
203 <para>Optionally specify a context, defaults to <literal>default</literal>.</para>
206 <parameter name="options">
209 <para>Only spy on channels involved in a bridged call.</para>
212 <para>Instead of whispering on a single channel barge in on both
213 channels involved in the call.</para>
216 <argument name="digit" required="true">
217 <para>Specify a DTMF digit that can be used to spy on the next available channel.</para>
221 <para>Override the typical numeric DTMF functionality and instead
222 use DTMF to switch between spy modes.</para>
225 <para>spy mode</para>
228 <para>whisper mode</para>
231 <para>barge mode</para>
236 <argument name="ext" required="true" />
237 <para>Enable <emphasis>enforced</emphasis> mode, so the spying channel can
238 only monitor extensions whose name is in the <replaceable>ext</replaceable> : delimited
242 <para>Exit when the spied-on channel hangs up.</para>
245 <argument name="grp" required="true">
246 <para>Only spy on channels in which one or more of the groups
247 listed in <replaceable>grp</replaceable> matches one or more groups from the
248 <variable>SPYGROUP</variable> variable set on the channel to be spied upon.</para>
250 <note><para>both <replaceable>grp</replaceable> and <variable>SPYGROUP</variable> can contain
251 either a single group or a colon-delimited list of groups, such
252 as <literal>sales:support:accounting</literal>.</para></note>
254 <option name="n" argsep="@">
255 <para>Say the name of the person being spied on if that person has recorded
256 his/her name. If a context is specified, then that voicemail context will
257 be searched when retrieving the name, otherwise the <literal>default</literal> context
258 be used when searching for the name (i.e. if SIP/1000 is the channel being
259 spied on and no mailbox is specified, then <literal>1000</literal> will be used when searching
260 for the name).</para>
261 <argument name="mailbox" />
262 <argument name="context" />
265 <para>Only listen to audio coming from this channel.</para>
268 <para>Don't play a beep when beginning to spy on a channel, or speak the
269 selected channel name.</para>
272 <para>Record the session to the monitor spool directory. An optional base for the filename
273 may be specified. The default is <literal>chanspy</literal>.</para>
274 <argument name="basename" />
277 <para>Skip the playback of the channel type (i.e. SIP, IAX, etc) when
278 speaking the selected channel name.</para>
281 <para>Stop when there are no more extensions left to spy on.</para>
284 <argument name="value" />
285 <para>Adjust the initial volume in the range from <literal>-4</literal>
286 to <literal>4</literal>. A negative value refers to a quieter setting.</para>
289 <para>Enable <literal>whisper</literal> mode, so the spying channel can talk to
290 the spied-on channel.</para>
293 <para>Enable <literal>private whisper</literal> mode, so the spying channel can
294 talk to the spied-on channel but cannot listen to that channel.</para>
297 <argument name="digit" required="true">
298 <para>Specify a DTMF digit that can be used to exit the application.</para>
302 <para>Allow the user to exit ChanSpy to a valid single digit
303 numeric extension in the current context or the context
304 specified by the <variable>SPY_EXIT_CONTEXT</variable> channel variable. The
305 name of the last channel that was spied on will be stored
306 in the <variable>SPY_CHANNEL</variable> variable.</para>
312 <para>This application is used to listen to the audio from an Asterisk channel. This includes
313 the audio coming in and out of the channel being spied on. Only channels created by outgoing calls for the
314 specified extension will be selected for spying. If the optional context is not supplied,
315 the current channel's context will be used.</para>
316 <para>While spying, the following actions may be performed:</para>
317 <para> - Dialing <literal>#</literal> cycles the volume level.</para>
318 <para> - Dialing <literal>*</literal> will stop spying and look for another channel to spy on.</para>
319 <note><para>The <replaceable>X</replaceable> option supersedes the three features above in that if a valid
320 single digit extension exists in the correct context ChanSpy will exit to it.
321 This also disables choosing a channel based on <literal>chanprefix</literal> and a digit sequence.</para></note>
324 <ref type="application">ChanSpy</ref>
328 <application name="DAHDIScan" language="en_US">
330 Scan DAHDI channels to monitor calls.
333 <parameter name="group">
334 <para>Limit scanning to a channel <replaceable>group</replaceable> by setting this option.</para>
338 <para>Allows a call center manager to monitor DAHDI channels in a
339 convenient way. Use <literal>#</literal> to select the next channel and use <literal>*</literal> to exit.</para>
344 static const char app_chan[] = "ChanSpy";
346 static const char app_ext[] = "ExtenSpy";
348 static const char app_dahdiscan[] = "DAHDIScan";
351 OPTION_QUIET = (1 << 0), /* Quiet, no announcement */
352 OPTION_BRIDGED = (1 << 1), /* Only look at bridged calls */
353 OPTION_VOLUME = (1 << 2), /* Specify initial volume */
354 OPTION_GROUP = (1 << 3), /* Only look at channels in group */
355 OPTION_RECORD = (1 << 4),
356 OPTION_WHISPER = (1 << 5),
357 OPTION_PRIVATE = (1 << 6), /* Private Whisper mode */
358 OPTION_READONLY = (1 << 7), /* Don't mix the two channels */
359 OPTION_EXIT = (1 << 8), /* Exit to a valid single digit extension */
360 OPTION_ENFORCED = (1 << 9), /* Enforced mode */
361 OPTION_NOTECH = (1 << 10), /* Skip technology name playback */
362 OPTION_BARGE = (1 << 11), /* Barge mode (whisper to both channels) */
363 OPTION_NAME = (1 << 12), /* Say the name of the person on whom we will spy */
364 OPTION_DTMF_SWITCH_MODES = (1 << 13), /* Allow numeric DTMF to switch between chanspy modes */
365 OPTION_DTMF_EXIT = (1 << 14), /* Set DTMF to exit, added for DAHDIScan integration */
366 OPTION_DTMF_CYCLE = (1 << 15), /* Custom DTMF for cycling next avaliable channel, (default is '*') */
367 OPTION_DAHDI_SCAN = (1 << 16), /* Scan groups in DAHDIScan mode */
368 OPTION_STOP = (1 << 17),
369 OPTION_EXITONHANGUP = (1 << 18), /* Hang up when the spied-on channel hangs up. */
383 AST_APP_OPTIONS(spy_opts, {
384 AST_APP_OPTION('b', OPTION_BRIDGED),
385 AST_APP_OPTION('B', OPTION_BARGE),
386 AST_APP_OPTION_ARG('c', OPTION_DTMF_CYCLE, OPT_ARG_CYCLE),
387 AST_APP_OPTION('d', OPTION_DTMF_SWITCH_MODES),
388 AST_APP_OPTION_ARG('e', OPTION_ENFORCED, OPT_ARG_ENFORCED),
389 AST_APP_OPTION('E', OPTION_EXITONHANGUP),
390 AST_APP_OPTION_ARG('g', OPTION_GROUP, OPT_ARG_GROUP),
391 AST_APP_OPTION_ARG('n', OPTION_NAME, OPT_ARG_NAME),
392 AST_APP_OPTION('o', OPTION_READONLY),
393 AST_APP_OPTION('q', OPTION_QUIET),
394 AST_APP_OPTION_ARG('r', OPTION_RECORD, OPT_ARG_RECORD),
395 AST_APP_OPTION('s', OPTION_NOTECH),
396 AST_APP_OPTION('S', OPTION_STOP),
397 AST_APP_OPTION_ARG('v', OPTION_VOLUME, OPT_ARG_VOLUME),
398 AST_APP_OPTION('w', OPTION_WHISPER),
399 AST_APP_OPTION('W', OPTION_PRIVATE),
400 AST_APP_OPTION_ARG('x', OPTION_DTMF_EXIT, OPT_ARG_EXIT),
401 AST_APP_OPTION('X', OPTION_EXIT),
404 struct chanspy_translation_helper {
406 struct ast_audiohook spy_audiohook;
407 struct ast_audiohook whisper_audiohook;
408 struct ast_audiohook bridge_whisper_audiohook;
411 struct ast_flags flags;
414 struct spy_dtmf_options {
420 static void *spy_alloc(struct ast_channel *chan, void *data)
422 /* just store the data pointer in the channel structure */
426 static void spy_release(struct ast_channel *chan, void *data)
431 static int spy_generate(struct ast_channel *chan, void *data, int len, int samples)
433 struct chanspy_translation_helper *csth = data;
434 struct ast_frame *f, *cur;
435 struct ast_format format_slin;
437 ast_format_set(&format_slin, AST_FORMAT_SLINEAR, 0);
439 ast_audiohook_lock(&csth->spy_audiohook);
440 if (csth->spy_audiohook.status != AST_AUDIOHOOK_STATUS_RUNNING) {
441 /* Channel is already gone more than likely */
442 ast_audiohook_unlock(&csth->spy_audiohook);
446 if (ast_test_flag(&csth->flags, OPTION_READONLY)) {
447 /* Option 'o' was set, so don't mix channel audio */
448 f = ast_audiohook_read_frame(&csth->spy_audiohook, samples, AST_AUDIOHOOK_DIRECTION_READ, &format_slin);
450 f = ast_audiohook_read_frame(&csth->spy_audiohook, samples, AST_AUDIOHOOK_DIRECTION_BOTH, &format_slin);
453 ast_audiohook_unlock(&csth->spy_audiohook);
458 for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
459 if (ast_write(chan, cur)) {
465 if (write(csth->fd, cur->data.ptr, cur->datalen) < 0) {
466 ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
476 static struct ast_generator spygen = {
478 .release = spy_release,
479 .generate = spy_generate,
482 static int start_spying(struct ast_autochan *autochan, const char *spychan_name, struct ast_audiohook *audiohook)
485 struct ast_channel *peer = NULL;
487 ast_log(LOG_NOTICE, "Attaching %s to %s\n", spychan_name, ast_channel_name(autochan->chan));
489 ast_set_flag(audiohook, AST_AUDIOHOOK_TRIGGER_SYNC | AST_AUDIOHOOK_SMALL_QUEUE);
490 res = ast_audiohook_attach(autochan->chan, audiohook);
492 if (!res && ast_test_flag(autochan->chan, AST_FLAG_NBRIDGE) && (peer = ast_bridged_channel(autochan->chan))) {
493 ast_softhangup(peer, AST_SOFTHANGUP_UNBRIDGE);
498 static void change_spy_mode(const char digit, struct ast_flags *flags)
501 ast_clear_flag(flags, OPTION_WHISPER);
502 ast_clear_flag(flags, OPTION_BARGE);
503 } else if (digit == '5') {
504 ast_clear_flag(flags, OPTION_BARGE);
505 ast_set_flag(flags, OPTION_WHISPER);
506 } else if (digit == '6') {
507 ast_clear_flag(flags, OPTION_WHISPER);
508 ast_set_flag(flags, OPTION_BARGE);
512 static int channel_spy(struct ast_channel *chan, struct ast_autochan *spyee_autochan,
513 int *volfactor, int fd, struct spy_dtmf_options *user_options, struct ast_flags *flags,
516 struct chanspy_translation_helper csth;
517 int running = 0, res, x = 0;
521 struct ast_silence_generator *silgen = NULL;
522 struct ast_autochan *spyee_bridge_autochan = NULL;
523 const char *spyer_name;
524 struct ast_channel *chans[] = { chan, spyee_autochan->chan };
526 ast_channel_lock(chan);
527 spyer_name = ast_strdupa(ast_channel_name(chan));
528 ast_channel_unlock(chan);
530 /* We now hold the channel lock on spyee */
532 if (ast_check_hangup(chan) || ast_check_hangup(spyee_autochan->chan)) {
536 ast_channel_lock(spyee_autochan->chan);
537 name = ast_strdupa(ast_channel_name(spyee_autochan->chan));
538 ast_channel_unlock(spyee_autochan->chan);
540 ast_verb(2, "Spying on channel %s\n", name);
541 ast_manager_event_multichan(EVENT_FLAG_CALL, "ChanSpyStart", 2, chans,
542 "SpyerChannel: %s\r\n"
543 "SpyeeChannel: %s\r\n",
546 memset(&csth, 0, sizeof(csth));
547 ast_copy_flags(&csth.flags, flags, AST_FLAGS_ALL);
549 /* This is the audiohook which gives us the audio off the channel we are
552 ast_audiohook_init(&csth.spy_audiohook, AST_AUDIOHOOK_TYPE_SPY, "ChanSpy", 0);
554 if (start_spying(spyee_autochan, spyer_name, &csth.spy_audiohook)) {
555 ast_audiohook_destroy(&csth.spy_audiohook);
559 if (ast_test_flag(flags, OPTION_WHISPER | OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
560 /* This audiohook will let us inject audio from our channel into the
561 channel we are currently spying on.
563 ast_audiohook_init(&csth.whisper_audiohook, AST_AUDIOHOOK_TYPE_WHISPER, "ChanSpy", 0);
565 if (start_spying(spyee_autochan, spyer_name, &csth.whisper_audiohook)) {
566 ast_log(LOG_WARNING, "Unable to attach whisper audiohook to spyee %s. Whisper mode disabled!\n", name);
570 if (ast_test_flag(flags, OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
571 /* And this hook lets us inject audio into the channel that the spied on
572 channel is currently bridged with.
574 ast_audiohook_init(&csth.bridge_whisper_audiohook, AST_AUDIOHOOK_TYPE_WHISPER, "Chanspy", 0);
576 if ((spyee_bridge_autochan = ast_autochan_setup(ast_bridged_channel(spyee_autochan->chan)))) {
577 ast_channel_lock(spyee_bridge_autochan->chan);
578 if (start_spying(spyee_bridge_autochan, spyer_name, &csth.bridge_whisper_audiohook)) {
579 ast_log(LOG_WARNING, "Unable to attach barge audiohook on spyee %s. Barge mode disabled!\n", name);
581 ast_channel_unlock(spyee_bridge_autochan->chan);
585 ast_channel_lock(chan);
586 ast_set_flag(chan, AST_FLAG_END_DTMF_ONLY);
587 ast_channel_unlock(chan);
589 csth.volfactor = *volfactor;
591 if (csth.volfactor) {
592 csth.spy_audiohook.options.read_volume = csth.volfactor;
593 csth.spy_audiohook.options.write_volume = csth.volfactor;
598 if (ast_test_flag(flags, OPTION_PRIVATE))
599 silgen = ast_channel_start_silence_generator(chan);
601 ast_activate_generator(chan, &spygen, &csth);
603 /* We can no longer rely on 'spyee' being an actual channel;
604 it can be hung up and freed out from under us. However, the
605 channel destructor will put NULL into our csth.spy.chan
606 field when that happens, so that is our signal that the spyee
607 channel has gone away.
610 /* Note: it is very important that the ast_waitfor() be the first
611 condition in this expression, so that if we wait for some period
612 of time before receiving a frame from our spying channel, we check
613 for hangup on the spied-on channel _after_ knowing that a frame
614 has arrived, since the spied-on channel could have gone away while
617 while (ast_waitfor(chan, -1) > -1 && csth.spy_audiohook.status == AST_AUDIOHOOK_STATUS_RUNNING) {
618 if (!(f = ast_read(chan)) || ast_check_hangup(chan)) {
623 if (ast_test_flag(flags, OPTION_BARGE) && f->frametype == AST_FRAME_VOICE) {
624 ast_audiohook_lock(&csth.whisper_audiohook);
625 ast_audiohook_lock(&csth.bridge_whisper_audiohook);
626 ast_audiohook_write_frame(&csth.whisper_audiohook, AST_AUDIOHOOK_DIRECTION_WRITE, f);
627 ast_audiohook_write_frame(&csth.bridge_whisper_audiohook, AST_AUDIOHOOK_DIRECTION_WRITE, f);
628 ast_audiohook_unlock(&csth.whisper_audiohook);
629 ast_audiohook_unlock(&csth.bridge_whisper_audiohook);
632 } else if (ast_test_flag(flags, OPTION_WHISPER) && f->frametype == AST_FRAME_VOICE) {
633 ast_audiohook_lock(&csth.whisper_audiohook);
634 ast_audiohook_write_frame(&csth.whisper_audiohook, AST_AUDIOHOOK_DIRECTION_WRITE, f);
635 ast_audiohook_unlock(&csth.whisper_audiohook);
640 res = (f->frametype == AST_FRAME_DTMF) ? f->subclass.integer : 0;
645 if (x == sizeof(inp))
653 if (ast_test_flag(flags, OPTION_EXIT)) {
657 if (!ast_goto_if_exists(chan, exitcontext, tmp, 1)) {
658 ast_debug(1, "Got DTMF %c, goto context %s\n", tmp[0], exitcontext);
659 pbx_builtin_setvar_helper(chan, "SPY_CHANNEL", name);
663 ast_debug(2, "Exit by single digit did not work in chanspy. Extension %s does not exist in context %s\n", tmp, exitcontext);
665 } else if (res >= '0' && res <= '9') {
666 if (ast_test_flag(flags, OPTION_DTMF_SWITCH_MODES)) {
667 change_spy_mode(res, flags);
673 if (res == user_options->cycle) {
676 } else if (res == user_options->exit) {
679 } else if (res == user_options->volume) {
680 if (!ast_strlen_zero(inp)) {
688 ast_verb(3, "Setting spy volume on %s to %d\n", ast_channel_name(chan), *volfactor);
690 csth.volfactor = *volfactor;
691 csth.spy_audiohook.options.read_volume = csth.volfactor;
692 csth.spy_audiohook.options.write_volume = csth.volfactor;
696 if (ast_test_flag(flags, OPTION_PRIVATE))
697 ast_channel_stop_silence_generator(chan, silgen);
699 ast_deactivate_generator(chan);
701 ast_channel_lock(chan);
702 ast_clear_flag(chan, AST_FLAG_END_DTMF_ONLY);
703 ast_channel_unlock(chan);
705 if (ast_test_flag(flags, OPTION_WHISPER | OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
706 ast_audiohook_lock(&csth.whisper_audiohook);
707 ast_audiohook_detach(&csth.whisper_audiohook);
708 ast_audiohook_unlock(&csth.whisper_audiohook);
709 ast_audiohook_destroy(&csth.whisper_audiohook);
712 if (ast_test_flag(flags, OPTION_BARGE | OPTION_DTMF_SWITCH_MODES)) {
713 ast_audiohook_lock(&csth.bridge_whisper_audiohook);
714 ast_audiohook_detach(&csth.bridge_whisper_audiohook);
715 ast_audiohook_unlock(&csth.bridge_whisper_audiohook);
716 ast_audiohook_destroy(&csth.bridge_whisper_audiohook);
719 ast_audiohook_lock(&csth.spy_audiohook);
720 ast_audiohook_detach(&csth.spy_audiohook);
721 ast_audiohook_unlock(&csth.spy_audiohook);
722 ast_audiohook_destroy(&csth.spy_audiohook);
724 if (spyee_bridge_autochan) {
725 ast_autochan_destroy(spyee_bridge_autochan);
728 ast_verb(2, "Done Spying on channel %s\n", name);
729 ast_manager_event(chan, EVENT_FLAG_CALL, "ChanSpyStop", "SpyeeChannel: %s\r\n", name);
734 static struct ast_autochan *next_channel(struct ast_channel_iterator *iter,
735 struct ast_autochan *autochan, struct ast_channel *chan)
737 struct ast_channel *next;
738 struct ast_autochan *autochan_store;
739 const size_t pseudo_len = strlen("DAHDI/pseudo");
745 for (; (next = ast_channel_iterator_next(iter)); ast_channel_unref(next)) {
746 if (!strncmp(ast_channel_name(next), "DAHDI/pseudo", pseudo_len)
751 autochan_store = ast_autochan_setup(next);
752 ast_channel_unref(next);
754 return autochan_store;
759 static int common_exec(struct ast_channel *chan, struct ast_flags *flags,
760 int volfactor, const int fd, struct spy_dtmf_options *user_options,
761 const char *mygroup, const char *myenforced, const char *spec, const char *exten,
762 const char *context, const char *mailbox, const char *name_context)
764 char nameprefix[AST_NAME_STRLEN];
765 char peer_name[AST_NAME_STRLEN + 5];
766 char exitcontext[AST_MAX_CONTEXT] = "";
767 signed char zero_volume = 0;
771 int num_spyed_upon = 1;
772 struct ast_channel_iterator *iter = NULL;
774 if (ast_test_flag(flags, OPTION_EXIT)) {
776 ast_channel_lock(chan);
777 if ((c = pbx_builtin_getvar_helper(chan, "SPY_EXIT_CONTEXT"))) {
778 ast_copy_string(exitcontext, c, sizeof(exitcontext));
779 } else if (!ast_strlen_zero(ast_channel_macrocontext(chan))) {
780 ast_copy_string(exitcontext, ast_channel_macrocontext(chan), sizeof(exitcontext));
782 ast_copy_string(exitcontext, ast_channel_context(chan), sizeof(exitcontext));
784 ast_channel_unlock(chan);
787 if (ast_channel_state(chan) != AST_STATE_UP)
790 ast_set_flag(chan, AST_FLAG_SPYING); /* so nobody can spy on us while we are spying */
795 struct ast_autochan *autochan = NULL, *next_autochan = NULL;
796 struct ast_channel *prev = NULL;
798 if (!ast_test_flag(flags, OPTION_QUIET) && num_spyed_upon) {
799 res = ast_streamfile(chan, "beep", ast_channel_language(chan));
801 res = ast_waitstream(chan, "");
803 ast_clear_flag(chan, AST_FLAG_SPYING);
806 if (!ast_strlen_zero(exitcontext)) {
810 if (!ast_goto_if_exists(chan, exitcontext, tmp, 1))
813 ast_debug(2, "Exit by single digit did not work in chanspy. Extension %s does not exist in context %s\n", tmp, exitcontext);
817 /* Set up the iterator we'll be using during this call */
818 if (!ast_strlen_zero(spec)) {
819 iter = ast_channel_iterator_by_name_new(spec, strlen(spec));
820 } else if (!ast_strlen_zero(exten)) {
821 iter = ast_channel_iterator_by_exten_new(exten, context);
823 iter = ast_channel_iterator_all_new();
831 res = ast_waitfordigit(chan, waitms);
833 iter = ast_channel_iterator_destroy(iter);
834 ast_clear_flag(chan, AST_FLAG_SPYING);
837 if (!ast_strlen_zero(exitcontext)) {
841 if (!ast_goto_if_exists(chan, exitcontext, tmp, 1)) {
842 iter = ast_channel_iterator_destroy(iter);
845 ast_debug(2, "Exit by single digit did not work in chanspy. Extension %s does not exist in context %s\n", tmp, exitcontext);
849 /* reset for the next loop around, unless overridden later */
853 for (autochan = next_channel(iter, autochan, chan);
855 prev = autochan->chan, ast_autochan_destroy(autochan),
856 autochan = next_autochan ? next_autochan :
857 next_channel(iter, autochan, chan), next_autochan = NULL) {
859 int ienf = !myenforced;
862 if (autochan->chan == prev) {
863 ast_autochan_destroy(autochan);
867 if (ast_check_hangup(chan)) {
868 ast_autochan_destroy(autochan);
872 if (ast_test_flag(flags, OPTION_BRIDGED) && !ast_bridged_channel(autochan->chan)) {
876 if (ast_check_hangup(autochan->chan) || ast_test_flag(autochan->chan, AST_FLAG_SPYING)) {
882 int num_mygroups = 0;
884 char dup_mygroup[512];
885 char *groups[NUM_SPYGROUPS];
886 char *mygroups[NUM_SPYGROUPS];
887 const char *group = NULL;
890 ast_copy_string(dup_mygroup, mygroup, sizeof(dup_mygroup));
891 num_mygroups = ast_app_separate_args(dup_mygroup, ':', mygroups,
892 ARRAY_LEN(mygroups));
894 /* Before dahdi scan was part of chanspy, it would use the "GROUP" variable
895 * rather than "SPYGROUP", this check is done to preserve expected behavior */
896 if (ast_test_flag(flags, OPTION_DAHDI_SCAN)) {
897 group = pbx_builtin_getvar_helper(autochan->chan, "GROUP");
899 group = pbx_builtin_getvar_helper(autochan->chan, "SPYGROUP");
902 if (!ast_strlen_zero(group)) {
903 ast_copy_string(dup_group, group, sizeof(dup_group));
904 num_groups = ast_app_separate_args(dup_group, ':', groups,
908 for (y = 0; y < num_mygroups; y++) {
909 for (x = 0; x < num_groups; x++) {
910 if (!strcmp(mygroups[y], groups[x])) {
922 char ext[AST_CHANNEL_NAME + 3];
926 snprintf(buffer, sizeof(buffer) - 1, ":%s:", myenforced);
928 ast_copy_string(ext + 1, ast_channel_name(autochan->chan), sizeof(ext) - 1);
929 if ((end = strchr(ext, '-'))) {
936 if (strcasestr(buffer, ext)) {
945 strcpy(peer_name, "spy-");
946 strncat(peer_name, ast_channel_name(autochan->chan), AST_NAME_STRLEN - 4 - 1);
947 ptr = strchr(peer_name, '/');
949 ptr = strsep(&ptr, "-");
951 for (s = peer_name; s < ptr; s++)
954 if (!ast_test_flag(flags, OPTION_QUIET)) {
955 if (ast_test_flag(flags, OPTION_NAME)) {
956 const char *local_context = S_OR(name_context, "default");
957 const char *local_mailbox = S_OR(mailbox, ptr);
958 res = ast_app_sayname(chan, local_mailbox, local_context);
960 if (!ast_test_flag(flags, OPTION_NAME) || res < 0) {
962 if (!ast_test_flag(flags, OPTION_NOTECH)) {
963 if (ast_fileexists(peer_name, NULL, NULL) > 0) {
964 res = ast_streamfile(chan, peer_name, ast_channel_language(chan));
966 res = ast_waitstream(chan, "");
969 ast_autochan_destroy(autochan);
973 res = ast_say_character_str(chan, peer_name, "", ast_channel_language(chan));
976 if ((num = atoi(ptr))) {
977 ast_say_digits(chan, num, "", ast_channel_language(chan));
982 res = channel_spy(chan, autochan, &volfactor, fd, user_options, flags, exitcontext);
986 ast_autochan_destroy(autochan);
987 iter = ast_channel_iterator_destroy(iter);
989 } else if (res == -2) {
991 ast_autochan_destroy(autochan);
992 iter = ast_channel_iterator_destroy(iter);
994 } else if (res > 1 && spec) {
995 struct ast_channel *next;
997 snprintf(nameprefix, AST_NAME_STRLEN, "%s/%d", spec, res);
999 if ((next = ast_channel_get_by_name_prefix(nameprefix, strlen(nameprefix)))) {
1000 next_autochan = ast_autochan_setup(next);
1001 next = ast_channel_unref(next);
1003 /* stay on this channel, if it is still valid */
1004 if (!ast_check_hangup(autochan->chan)) {
1005 next_autochan = ast_autochan_setup(autochan->chan);
1007 /* the channel is gone */
1008 next_autochan = NULL;
1011 } else if (res == 0 && ast_test_flag(flags, OPTION_EXITONHANGUP)) {
1012 iter = ast_channel_iterator_destroy(iter);
1017 iter = ast_channel_iterator_destroy(iter);
1019 if (res == -1 || ast_check_hangup(chan))
1021 if (ast_test_flag(flags, OPTION_STOP) && !next_autochan) {
1027 ast_clear_flag(chan, AST_FLAG_SPYING);
1029 ast_channel_setoption(chan, AST_OPTION_TXGAIN, &zero_volume, sizeof(zero_volume), 0);
1034 static int chanspy_exec(struct ast_channel *chan, const char *data)
1036 char *myenforced = NULL;
1037 char *mygroup = NULL;
1038 char *recbase = NULL;
1040 struct ast_flags flags;
1041 struct spy_dtmf_options user_options = {
1046 struct ast_format oldwf;
1049 char *mailbox = NULL;
1050 char *name_context = NULL;
1051 AST_DECLARE_APP_ARGS(args,
1053 AST_APP_ARG(options);
1055 char *opts[OPT_ARG_ARRAY_SIZE];
1056 char *parse = ast_strdupa(data);
1058 AST_STANDARD_APP_ARGS(args, parse);
1059 ast_format_clear(&oldwf);
1061 if (args.spec && !strcmp(args.spec, "all"))
1066 ast_app_parse_options(spy_opts, &flags, opts, args.options);
1067 if (ast_test_flag(&flags, OPTION_GROUP))
1068 mygroup = opts[OPT_ARG_GROUP];
1070 if (ast_test_flag(&flags, OPTION_RECORD) &&
1071 !(recbase = opts[OPT_ARG_RECORD]))
1072 recbase = "chanspy";
1074 if (ast_test_flag(&flags, OPTION_DTMF_EXIT) && opts[OPT_ARG_EXIT]) {
1075 tmp = opts[OPT_ARG_EXIT][0];
1076 if (strchr("0123456789*#", tmp) && tmp != '\0') {
1077 user_options.exit = tmp;
1079 ast_log(LOG_NOTICE, "Argument for option 'x' must be a valid DTMF digit.");
1083 if (ast_test_flag(&flags, OPTION_DTMF_CYCLE) && opts[OPT_ARG_CYCLE]) {
1084 tmp = opts[OPT_ARG_CYCLE][0];
1085 if (strchr("0123456789*#", tmp) && tmp != '\0') {
1086 user_options.cycle = tmp;
1088 ast_log(LOG_NOTICE, "Argument for option 'c' must be a valid DTMF digit.");
1092 if (ast_test_flag(&flags, OPTION_VOLUME) && opts[OPT_ARG_VOLUME]) {
1095 if ((sscanf(opts[OPT_ARG_VOLUME], "%30d", &vol) != 1) || (vol > 4) || (vol < -4))
1096 ast_log(LOG_NOTICE, "Volume factor must be a number between -4 and 4\n");
1101 if (ast_test_flag(&flags, OPTION_PRIVATE))
1102 ast_set_flag(&flags, OPTION_WHISPER);
1104 if (ast_test_flag(&flags, OPTION_ENFORCED))
1105 myenforced = opts[OPT_ARG_ENFORCED];
1107 if (ast_test_flag(&flags, OPTION_NAME)) {
1108 if (!ast_strlen_zero(opts[OPT_ARG_NAME])) {
1110 if ((delimiter = strchr(opts[OPT_ARG_NAME], '@'))) {
1111 mailbox = opts[OPT_ARG_NAME];
1112 *delimiter++ = '\0';
1113 name_context = delimiter;
1115 mailbox = opts[OPT_ARG_NAME];
1120 ast_clear_flag(&flags, AST_FLAGS_ALL);
1123 ast_format_copy(&oldwf, ast_channel_writeformat(chan));
1124 if (ast_set_write_format_by_id(chan, AST_FORMAT_SLINEAR) < 0) {
1125 ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
1130 char filename[PATH_MAX];
1132 snprintf(filename, sizeof(filename), "%s/%s.%d.raw", ast_config_AST_MONITOR_DIR, recbase, (int) time(NULL));
1133 if ((fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC, AST_FILE_MODE)) <= 0) {
1134 ast_log(LOG_WARNING, "Cannot open '%s' for recording\n", filename);
1139 res = common_exec(chan, &flags, volfactor, fd, &user_options, mygroup, myenforced, args.spec, NULL, NULL, mailbox, name_context);
1144 if (oldwf.id && ast_set_write_format(chan, &oldwf) < 0)
1145 ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
1147 if (ast_test_flag(&flags, OPTION_EXITONHANGUP)) {
1148 ast_verb(3, "Stopped spying due to the spied-on channel hanging up.\n");
1154 static int extenspy_exec(struct ast_channel *chan, const char *data)
1156 char *ptr, *exten = NULL;
1157 char *mygroup = NULL;
1158 char *recbase = NULL;
1160 struct ast_flags flags;
1161 struct spy_dtmf_options user_options = {
1166 struct ast_format oldwf;
1169 char *mailbox = NULL;
1170 char *name_context = NULL;
1171 AST_DECLARE_APP_ARGS(args,
1172 AST_APP_ARG(context);
1173 AST_APP_ARG(options);
1175 char *parse = ast_strdupa(data);
1177 AST_STANDARD_APP_ARGS(args, parse);
1178 ast_format_clear(&oldwf);
1180 if (!ast_strlen_zero(args.context) && (ptr = strchr(args.context, '@'))) {
1181 exten = args.context;
1185 if (ast_strlen_zero(args.context))
1186 args.context = ast_strdupa(ast_channel_context(chan));
1189 char *opts[OPT_ARG_ARRAY_SIZE];
1192 ast_app_parse_options(spy_opts, &flags, opts, args.options);
1193 if (ast_test_flag(&flags, OPTION_GROUP))
1194 mygroup = opts[OPT_ARG_GROUP];
1196 if (ast_test_flag(&flags, OPTION_RECORD) &&
1197 !(recbase = opts[OPT_ARG_RECORD]))
1198 recbase = "chanspy";
1200 if (ast_test_flag(&flags, OPTION_DTMF_EXIT) && opts[OPT_ARG_EXIT]) {
1201 tmp = opts[OPT_ARG_EXIT][0];
1202 if (strchr("0123456789*#", tmp) && tmp != '\0') {
1203 user_options.exit = tmp;
1205 ast_log(LOG_NOTICE, "Argument for option 'x' must be a valid DTMF digit.");
1209 if (ast_test_flag(&flags, OPTION_DTMF_CYCLE) && opts[OPT_ARG_CYCLE]) {
1210 tmp = opts[OPT_ARG_CYCLE][0];
1211 if (strchr("0123456789*#", tmp) && tmp != '\0') {
1212 user_options.cycle = tmp;
1214 ast_log(LOG_NOTICE, "Argument for option 'c' must be a valid DTMF digit.");
1218 if (ast_test_flag(&flags, OPTION_VOLUME) && opts[OPT_ARG_VOLUME]) {
1221 if ((sscanf(opts[OPT_ARG_VOLUME], "%30d", &vol) != 1) || (vol > 4) || (vol < -4))
1222 ast_log(LOG_NOTICE, "Volume factor must be a number between -4 and 4\n");
1227 if (ast_test_flag(&flags, OPTION_PRIVATE))
1228 ast_set_flag(&flags, OPTION_WHISPER);
1230 if (ast_test_flag(&flags, OPTION_NAME)) {
1231 if (!ast_strlen_zero(opts[OPT_ARG_NAME])) {
1233 if ((delimiter = strchr(opts[OPT_ARG_NAME], '@'))) {
1234 mailbox = opts[OPT_ARG_NAME];
1235 *delimiter++ = '\0';
1236 name_context = delimiter;
1238 mailbox = opts[OPT_ARG_NAME];
1244 ast_clear_flag(&flags, AST_FLAGS_ALL);
1247 ast_format_copy(&oldwf, ast_channel_writeformat(chan));
1248 if (ast_set_write_format_by_id(chan, AST_FORMAT_SLINEAR) < 0) {
1249 ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
1254 char filename[PATH_MAX];
1256 snprintf(filename, sizeof(filename), "%s/%s.%d.raw", ast_config_AST_MONITOR_DIR, recbase, (int) time(NULL));
1257 if ((fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC, AST_FILE_MODE)) <= 0) {
1258 ast_log(LOG_WARNING, "Cannot open '%s' for recording\n", filename);
1264 res = common_exec(chan, &flags, volfactor, fd, &user_options, mygroup, NULL, NULL, exten, args.context, mailbox, name_context);
1269 if (oldwf.id && ast_set_write_format(chan, &oldwf) < 0)
1270 ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
1275 static int dahdiscan_exec(struct ast_channel *chan, const char *data)
1277 const char *spec = "DAHDI";
1278 struct ast_flags flags;
1279 struct spy_dtmf_options user_options = {
1284 struct ast_format oldwf;
1286 char *mygroup = NULL;
1288 ast_clear_flag(&flags, AST_FLAGS_ALL);
1289 ast_format_clear(&oldwf);
1290 if (!ast_strlen_zero(data)) {
1291 mygroup = ast_strdupa(data);
1293 ast_set_flag(&flags, OPTION_DTMF_EXIT);
1294 ast_set_flag(&flags, OPTION_DTMF_CYCLE);
1295 ast_set_flag(&flags, OPTION_DAHDI_SCAN);
1297 ast_format_copy(&oldwf, ast_channel_writeformat(chan));
1298 if (ast_set_write_format_by_id(chan, AST_FORMAT_SLINEAR) < 0) {
1299 ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
1303 res = common_exec(chan, &flags, 0, 0, &user_options, mygroup, NULL, spec, NULL, NULL, NULL, NULL);
1305 if (oldwf.id && ast_set_write_format(chan, &oldwf) < 0)
1306 ast_log(LOG_ERROR, "Could Not Set Write Format.\n");
1311 static int unload_module(void)
1315 res |= ast_unregister_application(app_chan);
1316 res |= ast_unregister_application(app_ext);
1317 res |= ast_unregister_application(app_dahdiscan);
1322 static int load_module(void)
1326 res |= ast_register_application_xml(app_chan, chanspy_exec);
1327 res |= ast_register_application_xml(app_ext, extenspy_exec);
1328 res |= ast_register_application_xml(app_dahdiscan, dahdiscan_exec);
1333 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Listen to the audio of an active channel");