Asterisk - The Open Source Telephony Project GIT-master-f36a736
Data Structures | Enumerations | Functions | Variables
features.c File Reference

Routines implementing call features as call pickup, parking and transfer. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include "features_config.h"
#include <pthread.h>
#include <signal.h>
#include <sys/time.h>
#include <netinet/in.h>
#include "asterisk/lock.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/causes.h"
#include "asterisk/module.h"
#include "asterisk/translate.h"
#include "asterisk/app.h"
#include "asterisk/say.h"
#include "asterisk/features.h"
#include "asterisk/musiconhold.h"
#include "asterisk/config.h"
#include "asterisk/cli.h"
#include "asterisk/manager.h"
#include "asterisk/utils.h"
#include "asterisk/devicestate.h"
#include "asterisk/audiohook.h"
#include "asterisk/global_datastores.h"
#include "asterisk/astobj2.h"
#include "asterisk/test.h"
#include "asterisk/bridge.h"
#include "asterisk/bridge_features.h"
#include "asterisk/bridge_basic.h"
#include "asterisk/bridge_after.h"
#include "asterisk/stasis.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/features_config.h"
#include "asterisk/max_forwards.h"
#include "asterisk/stream.h"
Include dependency graph for features.c:

Go to the source code of this file.

Data Structures

struct  ast_bridge_thread_obj
 
struct  ast_dial_features
 

Enumerations

enum  {
  BRIDGE_OPT_PLAYTONE = (1 << 0) , OPT_CALLEE_HANGUP = (1 << 1) , OPT_CALLER_HANGUP = (1 << 2) , OPT_DURATION_LIMIT = (1 << 3) ,
  OPT_DURATION_STOP = (1 << 4) , OPT_CALLEE_TRANSFER = (1 << 5) , OPT_CALLER_TRANSFER = (1 << 6) , OPT_CALLEE_MONITOR = (1 << 7) ,
  OPT_CALLER_MONITOR = (1 << 8) , OPT_CALLEE_PARK = (1 << 9) , OPT_CALLER_PARK = (1 << 10) , OPT_CALLEE_KILL = (1 << 11) ,
  OPT_CALLEE_GO_ON = (1 << 12) , OPT_NOANSWER = (1 << 13)
}
 
enum  { OPT_ARG_DURATION_LIMIT = 0 , OPT_ARG_DURATION_STOP , OPT_ARG_CALLEE_GO_ON , OPT_ARG_ARRAY_SIZE }
 
enum  feature_interpret_op { FEATURE_INTERPRET_DETECT , FEATURE_INTERPRET_DO , FEATURE_INTERPRET_CHECK }
 
enum  play_tone_action { PLAYTONE_NONE = 0 , PLAYTONE_CHANNEL1 = (1 << 0) , PLAYTONE_CHANNEL2 = (1 << 1) , PLAYTONE_BOTH = PLAYTONE_CHANNEL1 | PLAYTONE_CHANNEL2 }
 

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static int action_bridge (struct mansession *s, const struct message *m)
 Bridge channels together. More...
 
static int add_features_datastore (struct ast_channel *chan, const struct ast_flags *my_features, const struct ast_flags *peer_features)
 
static void add_features_datastores (struct ast_channel *caller, struct ast_channel *callee, struct ast_bridge_config *config)
 
int ast_bridge_call (struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config)
 bridge the call and set CDR More...
 
int ast_bridge_call_with_flags (struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, unsigned int flags)
 Bridge a call, and add additional flags to the bridge. More...
 
int ast_bridge_timelimit (struct ast_channel *chan, struct ast_bridge_config *config, char *parse, struct timeval *calldurationlimit)
 parse L option and read associated channel variables to set warning, warning frequency, and timelimit More...
 
void ast_channel_log (char *title, struct ast_channel *chan)
 
struct ast_moduleAST_MODULE_SELF_SYM (void)
 
static void bridge_config_set_limits (struct ast_bridge_config *config, struct ast_bridge_features_limits *caller_limits, struct ast_bridge_features_limits *callee_limits)
 
static void bridge_config_set_limits_warning_values (struct ast_bridge_config *config, struct ast_bridge_features_limits *limits)
 
static int bridge_exec (struct ast_channel *chan, const char *data)
 Bridge channels. More...
 
static void bridge_failed_peer_goto (struct ast_channel *chan, struct ast_channel *peer)
 
static void * dial_features_duplicate (void *data)
 
static int load_module (void)
 
static enum play_tone_action parse_playtone (const char *playtone_val)
 
static int pre_bridge_setup (struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, struct ast_bridge_features *chan_features, struct ast_bridge_features *peer_features, int noanswer)
 
static void set_bridge_features_on_config (struct ast_bridge_config *config, const char *features)
 
static void set_config_flags (struct ast_channel *chan, struct ast_bridge_config *config)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Call Features" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .reload = reload_features_config, .load_pri = AST_MODPRI_CORE, .requires = "extconfig", }
 
static char * app_bridge = "Bridge"
 
static const struct ast_module_infoast_module_info = &__mod_info
 
static const struct ast_app_option bridge_exec_options [128] = { [ 'p' ] = { .flag = BRIDGE_OPT_PLAYTONE }, [ 'F' ] = { .flag = OPT_CALLEE_GO_ON , .arg_index = OPT_ARG_CALLEE_GO_ON + 1 }, [ 'h' ] = { .flag = OPT_CALLEE_HANGUP }, [ 'H' ] = { .flag = OPT_CALLER_HANGUP }, [ 'k' ] = { .flag = OPT_CALLEE_PARK }, [ 'K' ] = { .flag = OPT_CALLER_PARK }, [ 'L' ] = { .flag = OPT_DURATION_LIMIT , .arg_index = OPT_ARG_DURATION_LIMIT + 1 }, [ 'n' ] = { .flag = OPT_NOANSWER }, [ 'S' ] = { .flag = OPT_DURATION_STOP , .arg_index = OPT_ARG_DURATION_STOP + 1 }, [ 't' ] = { .flag = OPT_CALLEE_TRANSFER }, [ 'T' ] = { .flag = OPT_CALLER_TRANSFER }, [ 'w' ] = { .flag = OPT_CALLEE_MONITOR }, [ 'W' ] = { .flag = OPT_CALLER_MONITOR }, [ 'x' ] = { .flag = OPT_CALLEE_KILL }, }
 
static const struct ast_datastore_info dial_features_info
 

Detailed Description

Routines implementing call features as call pickup, parking and transfer.

Author
Mark Spencer marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file features.c.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
BRIDGE_OPT_PLAYTONE 
OPT_CALLEE_HANGUP 
OPT_CALLER_HANGUP 
OPT_DURATION_LIMIT 
OPT_DURATION_STOP 
OPT_CALLEE_TRANSFER 
OPT_CALLER_TRANSFER 
OPT_CALLEE_MONITOR 
OPT_CALLER_MONITOR 
OPT_CALLEE_PARK 
OPT_CALLER_PARK 
OPT_CALLEE_KILL 
OPT_CALLEE_GO_ON 
OPT_NOANSWER 

Definition at line 815 of file features.c.

815 {
816 BRIDGE_OPT_PLAYTONE = (1 << 0),
817 OPT_CALLEE_HANGUP = (1 << 1),
818 OPT_CALLER_HANGUP = (1 << 2),
819 OPT_DURATION_LIMIT = (1 << 3),
820 OPT_DURATION_STOP = (1 << 4),
821 OPT_CALLEE_TRANSFER = (1 << 5),
822 OPT_CALLER_TRANSFER = (1 << 6),
823 OPT_CALLEE_MONITOR = (1 << 7),
824 OPT_CALLER_MONITOR = (1 << 8),
825 OPT_CALLEE_PARK = (1 << 9),
826 OPT_CALLER_PARK = (1 << 10),
827 OPT_CALLEE_KILL = (1 << 11),
828 OPT_CALLEE_GO_ON = (1 << 12),
829 OPT_NOANSWER = (1 << 13),
830};
@ OPT_CALLEE_PARK
Definition: features.c:825
@ OPT_DURATION_LIMIT
Definition: features.c:819
@ OPT_DURATION_STOP
Definition: features.c:820
@ OPT_NOANSWER
Definition: features.c:829
@ OPT_CALLEE_TRANSFER
Definition: features.c:821
@ OPT_CALLEE_GO_ON
Definition: features.c:828
@ OPT_CALLER_PARK
Definition: features.c:826
@ OPT_CALLER_MONITOR
Definition: features.c:824
@ OPT_CALLEE_MONITOR
Definition: features.c:823
@ OPT_CALLER_HANGUP
Definition: features.c:818
@ OPT_CALLEE_HANGUP
Definition: features.c:817
@ BRIDGE_OPT_PLAYTONE
Definition: features.c:816
@ OPT_CALLEE_KILL
Definition: features.c:827
@ OPT_CALLER_TRANSFER
Definition: features.c:822

◆ anonymous enum

anonymous enum
Enumerator
OPT_ARG_DURATION_LIMIT 
OPT_ARG_DURATION_STOP 
OPT_ARG_CALLEE_GO_ON 
OPT_ARG_ARRAY_SIZE 

Definition at line 832 of file features.c.

832 {
836 /* note: this entry _MUST_ be the last one in the enum */
838};
@ OPT_ARG_CALLEE_GO_ON
Definition: features.c:835
@ OPT_ARG_DURATION_STOP
Definition: features.c:834
@ OPT_ARG_DURATION_LIMIT
Definition: features.c:833
@ OPT_ARG_ARRAY_SIZE
Definition: features.c:837

◆ feature_interpret_op

Enumerator
FEATURE_INTERPRET_DETECT 
FEATURE_INTERPRET_DO 
FEATURE_INTERPRET_CHECK 

Definition at line 255 of file features.c.

255 {
256 FEATURE_INTERPRET_DETECT, /* Used by ast_feature_detect */
257 FEATURE_INTERPRET_DO, /* Used by feature_interpret */
258 FEATURE_INTERPRET_CHECK, /* Used by feature_check */
feature_interpret_op
Definition: features.c:255
@ FEATURE_INTERPRET_CHECK
Definition: features.c:258
@ FEATURE_INTERPRET_DO
Definition: features.c:257
@ FEATURE_INTERPRET_DETECT
Definition: features.c:256

◆ play_tone_action

Enumerator
PLAYTONE_NONE 
PLAYTONE_CHANNEL1 
PLAYTONE_CHANNEL2 
PLAYTONE_BOTH 

Definition at line 690 of file features.c.

690 {
691 PLAYTONE_NONE = 0,
692 PLAYTONE_CHANNEL1 = (1 << 0),
693 PLAYTONE_CHANNEL2 = (1 << 1),
695};
@ PLAYTONE_CHANNEL1
Definition: features.c:692
@ PLAYTONE_CHANNEL2
Definition: features.c:693
@ PLAYTONE_NONE
Definition: features.c:691
@ PLAYTONE_BOTH
Definition: features.c:694

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 1159 of file features.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

Definition at line 1159 of file features.c.

◆ action_bridge()

static int action_bridge ( struct mansession s,
const struct message m 
)
static

Bridge channels together.

Parameters
s
m

Make sure valid channels were specified, send errors if any of the channels could not be found/locked, answer channels if needed, create the placeholder channels and grab the other channels make the channels compatible, send error if we fail doing so setup the bridge thread object and start the bridge.

Return values
0

Definition at line 726 of file features.c.

727{
728 const char *channela = astman_get_header(m, "Channel1");
729 const char *channelb = astman_get_header(m, "Channel2");
731 RAII_VAR(struct ast_channel *, chana, NULL, ao2_cleanup);
732 RAII_VAR(struct ast_channel *, chanb, NULL, ao2_cleanup);
733 const char *chana_exten;
734 const char *chana_context;
735 int chana_priority;
736 const char *chanb_exten;
737 const char *chanb_context;
738 int chanb_priority;
739 struct ast_bridge *bridge;
740 char buf[256];
741 RAII_VAR(struct ast_features_xfer_config *, xfer_cfg_a, NULL, ao2_cleanup);
742 RAII_VAR(struct ast_features_xfer_config *, xfer_cfg_b, NULL, ao2_cleanup);
743
744 /* make sure valid channels were specified */
745 if (ast_strlen_zero(channela) || ast_strlen_zero(channelb)) {
746 astman_send_error(s, m, "Missing channel parameter in request");
747 return 0;
748 }
749
750 ast_debug(1, "Performing Bridge action on %s and %s\n", channela, channelb);
751
752 /* Start with chana */
753 chana = ast_channel_get_by_name_prefix(channela, strlen(channela));
754 if (!chana) {
755 snprintf(buf, sizeof(buf), "Channel1 does not exist: %s", channela);
756 astman_send_error(s, m, buf);
757 return 0;
758 }
759 ast_channel_lock(chana);
760 xfer_cfg_a = ast_get_chan_features_xfer_config(chana);
761 chana_exten = ast_strdupa(ast_channel_exten(chana));
762 chana_context = ast_strdupa(ast_channel_context(chana));
763 chana_priority = ast_channel_priority(chana);
765 chana_priority++;
766 }
767 ast_channel_unlock(chana);
768
769 chanb = ast_channel_get_by_name_prefix(channelb, strlen(channelb));
770 if (!chanb) {
771 snprintf(buf, sizeof(buf), "Channel2 does not exist: %s", channelb);
772 astman_send_error(s, m, buf);
773 return 0;
774 }
775 ast_channel_lock(chanb);
776 xfer_cfg_b = ast_get_chan_features_xfer_config(chanb);
777 chanb_exten = ast_strdupa(ast_channel_exten(chanb));
778 chanb_context = ast_strdupa(ast_channel_context(chanb));
779 chanb_priority = ast_channel_priority(chanb);
781 chanb_priority++;
782 }
783 ast_channel_unlock(chanb);
784
785 bridge = ast_bridge_basic_new();
786 if (!bridge) {
787 astman_send_error(s, m, "Unable to create bridge\n");
788 return 0;
789 }
790
791 ast_bridge_set_after_goto(chana, chana_context, chana_exten, chana_priority);
792 if (ast_bridge_add_channel(bridge, chana, NULL, playtone & PLAYTONE_CHANNEL1, xfer_cfg_a ? xfer_cfg_a->xfersound : NULL)) {
793 snprintf(buf, sizeof(buf), "Unable to add Channel1 to bridge: %s", ast_channel_name(chana));
794 astman_send_error(s, m, buf);
795 ast_bridge_destroy(bridge, 0);
796 return 0;
797 }
798
799 ast_bridge_set_after_goto(chanb, chanb_context, chanb_exten, chanb_priority);
800 if (ast_bridge_add_channel(bridge, chanb, NULL, playtone & PLAYTONE_CHANNEL2, xfer_cfg_b ? xfer_cfg_b->xfersound : NULL)) {
801 snprintf(buf, sizeof(buf), "Unable to add Channel2 to bridge: %s", ast_channel_name(chanb));
802 astman_send_error(s, m, buf);
803 ast_bridge_destroy(bridge, 0);
804 return 0;
805 }
806
807 astman_send_ack(s, m, "Channels have been bridged");
808 ao2_cleanup(bridge);
809
810 return 0;
811}
static int playtone(struct ast_channel *chan, int tone, int len)
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:298
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
int ast_bridge_destroy(struct ast_bridge *bridge, int cause)
Destroy a bridge.
Definition: bridge.c:944
void ast_bridge_set_after_goto(struct ast_channel *chan, const char *context, const char *exten, int priority)
Set channel to goto specific location after the bridge.
Definition: bridge_after.c:612
struct ast_bridge * ast_bridge_basic_new(void)
Create a new basic class bridge.
const char * ast_channel_name(const struct ast_channel *chan)
#define ast_channel_lock(chan)
Definition: channel.h:2968
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
int ast_channel_priority(const struct ast_channel *chan)
const char * ast_channel_context(const struct ast_channel *chan)
struct ast_channel * ast_channel_get_by_name_prefix(const char *name, size_t name_len)
Find a channel by a name prefix.
Definition: channel.c:1453
@ AST_FLAG_IN_AUTOLOOP
Definition: channel.h:1017
const char * ast_channel_exten(const struct ast_channel *chan)
#define ast_channel_unlock(chan)
Definition: channel.h:2969
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
play_tone_action
Definition: features.c:690
static enum play_tone_action parse_playtone(const char *playtone_val)
Definition: features.c:697
int ast_bridge_add_channel(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_bridge_features *features, int play_tone, const char *xfersound)
Add an arbitrary channel to a bridge.
Definition: bridge.c:2471
void astman_send_error(struct mansession *s, const struct message *m, char *error)
Send error in manager transaction.
Definition: manager.c:1969
void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
Send ack in manager transaction.
Definition: manager.c:2001
const char * astman_get_header(const struct message *m, char *var)
Get header from manager transaction.
Definition: manager.c:1630
struct ast_features_xfer_config * ast_get_chan_features_xfer_config(struct ast_channel *chan)
Get the transfer configuration options for a channel.
#define ast_debug(level,...)
Log a DEBUG message.
#define NULL
Definition: resample.c:96
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
Structure that contains information about a bridge.
Definition: bridge.h:349
Main Channel structure associated with a channel.
Feature configuration relating to transfers.
#define ast_test_flag(p, flag)
Definition: utils.h:63
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition: utils.h:941

References ao2_cleanup, ast_bridge_add_channel(), ast_bridge_basic_new(), ast_bridge_destroy(), ast_bridge_set_after_goto(), ast_channel_context(), ast_channel_exten(), ast_channel_flags(), ast_channel_get_by_name_prefix(), ast_channel_lock, ast_channel_name(), ast_channel_priority(), ast_channel_unlock, ast_debug, AST_FLAG_IN_AUTOLOOP, ast_get_chan_features_xfer_config(), ast_strdupa, ast_strlen_zero(), ast_test_flag, astman_get_header(), astman_send_ack(), astman_send_error(), buf, NULL, parse_playtone(), playtone(), PLAYTONE_CHANNEL1, PLAYTONE_CHANNEL2, and RAII_VAR.

Referenced by load_module().

◆ add_features_datastore()

static int add_features_datastore ( struct ast_channel chan,
const struct ast_flags my_features,
const struct ast_flags peer_features 
)
static

Definition at line 297 of file features.c.

298{
299 struct ast_datastore *datastore;
300 struct ast_dial_features *dialfeatures;
301
302 ast_channel_lock(chan);
304 ast_channel_unlock(chan);
305 if (datastore) {
306 /* Already exists. */
307 return 1;
308 }
309
310 /* Create a new datastore with specified feature flags. */
312 if (!datastore) {
313 ast_log(LOG_WARNING, "Unable to create channel features datastore.\n");
314 return 0;
315 }
316 dialfeatures = ast_calloc(1, sizeof(*dialfeatures));
317 if (!dialfeatures) {
318 ast_log(LOG_WARNING, "Unable to allocate memory for feature flags.\n");
319 ast_datastore_free(datastore);
320 return 0;
321 }
325 datastore->data = dialfeatures;
326 ast_channel_lock(chan);
327 ast_channel_datastore_add(chan, datastore);
328 ast_channel_unlock(chan);
329 return 0;
330}
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define ast_log
Definition: astobj2.c:42
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2404
#define DATASTORE_INHERIT_FOREVER
Definition: channel.h:194
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2418
#define ast_datastore_alloc(info, uid)
Definition: datastore.h:85
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition: datastore.c:68
static const struct ast_datastore_info dial_features_info
Definition: features.c:281
#define LOG_WARNING
Structure for a data store object.
Definition: datastore.h:64
void * data
Definition: datastore.h:66
unsigned int inheritance
Definition: datastore.h:69
struct ast_flags peer_features
Definition: features.c:265
struct ast_flags my_features
Definition: features.c:263
#define ast_copy_flags(dest, src, flagz)
Definition: utils.h:84
#define AST_FLAGS_ALL
Definition: utils.h:196

References ast_calloc, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_copy_flags, ast_datastore_alloc, ast_datastore_free(), AST_FLAGS_ALL, ast_log, ast_datastore::data, DATASTORE_INHERIT_FOREVER, dial_features_info, ast_datastore::inheritance, LOG_WARNING, ast_dial_features::my_features, NULL, and ast_dial_features::peer_features.

Referenced by add_features_datastores().

◆ add_features_datastores()

static void add_features_datastores ( struct ast_channel caller,
struct ast_channel callee,
struct ast_bridge_config config 
)
static

Definition at line 428 of file features.c.

429{
430 if (add_features_datastore(caller, &config->features_caller, &config->features_callee)) {
431 /*
432 * If we don't return here, then when we do a builtin_atxfer we
433 * will copy the disconnect flags over from the atxfer to the
434 * callee (Party C).
435 */
436 return;
437 }
438
439 add_features_datastore(callee, &config->features_callee, &config->features_caller);
440}
static const char config[]
Definition: chan_ooh323.c:111
static int add_features_datastore(struct ast_channel *chan, const struct ast_flags *my_features, const struct ast_flags *peer_features)
Definition: features.c:297

References add_features_datastore(), and config.

Referenced by pre_bridge_setup().

◆ ast_bridge_call()

int ast_bridge_call ( struct ast_channel chan,
struct ast_channel peer,
struct ast_bridge_config config 
)

bridge the call and set CDR

Bridge a call, optionally allowing redirection.

Parameters
chanThe bridge considers this channel the caller.
peerThe bridge considers this channel the callee.
configConfiguration for this bridge.

Set start time, check for two channels,check if monitor on check for feature activation, create new CDR

Returns
res on success.
Return values
-1on failure to bridge.

Definition at line 685 of file features.c.

686{
687 return ast_bridge_call_with_flags(chan, peer, config, 0);
688}
int ast_bridge_call_with_flags(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, unsigned int flags)
Bridge a call, and add additional flags to the bridge.
Definition: features.c:595

References ast_bridge_call_with_flags(), and config.

Referenced by app_exec(), and dial_exec_full().

◆ ast_bridge_call_with_flags()

int ast_bridge_call_with_flags ( struct ast_channel chan,
struct ast_channel peer,
struct ast_bridge_config config,
unsigned int  flags 
)

Bridge a call, and add additional flags to the bridge.

This does the same thing as ast_bridge_call, except that once the bridge is created, the provided flags are set on the bridge. The provided flags are added to the bridge's flags; they will not clear any flags already set.

Parameters
chanThe calling channel
peerThe called channel
configBridge configuration for the channels
flagsAdditional flags to set on the created bridge
Note
The function caller is assumed to have already done the COLP exchange for the initial bridging of the two channels if it was desired.

Definition at line 595 of file features.c.

596{
597 int res;
598 struct ast_bridge *bridge;
599 struct ast_bridge_features chan_features;
600 struct ast_bridge_features *peer_features;
601 const char *value;
602 int noanswer;
603 SCOPE_TRACE(1, "%s Peer: %s\n", ast_channel_name(chan), ast_channel_name(peer));
604
605 /* Setup features. */
606 res = ast_bridge_features_init(&chan_features);
607 peer_features = ast_bridge_features_new();
608 if (res || !peer_features) {
609 ast_bridge_features_destroy(peer_features);
610 ast_bridge_features_cleanup(&chan_features);
611 bridge_failed_peer_goto(chan, peer);
612 return -1;
613 }
614
615 ast_channel_lock(chan);
616 value = pbx_builtin_getvar_helper(chan, "BRIDGE_NOANSWER");
617 noanswer = !ast_strlen_zero(value) ? 1 : 0;
618 ast_channel_unlock(chan);
619
620 if (pre_bridge_setup(chan, peer, config, &chan_features, peer_features, noanswer)) {
621 ast_bridge_features_destroy(peer_features);
622 ast_bridge_features_cleanup(&chan_features);
623 bridge_failed_peer_goto(chan, peer);
624 return -1;
625 }
626
627 /* Create bridge */
628 bridge = ast_bridge_basic_new();
629 if (!bridge) {
630 ast_bridge_features_destroy(peer_features);
631 ast_bridge_features_cleanup(&chan_features);
632 bridge_failed_peer_goto(chan, peer);
633 return -1;
634 }
635
636 ast_bridge_basic_set_flags(bridge, flags);
637
638 /* Put peer into the bridge */
639 if (ast_bridge_impart(bridge, peer, NULL, peer_features,
641 ast_bridge_destroy(bridge, 0);
642 ast_bridge_features_cleanup(&chan_features);
643 bridge_failed_peer_goto(chan, peer);
644 return -1;
645 }
646
647 /* Join bridge */
648 ast_bridge_join(bridge, chan, NULL, &chan_features, NULL,
650
651 /*
652 * If the bridge was broken for a hangup that isn't real, then
653 * don't run the h extension, because the channel isn't really
654 * hung up. This should really only happen with
655 * AST_SOFTHANGUP_ASYNCGOTO.
656 */
657 res = -1;
658 ast_channel_lock(chan);
660 res = 0;
661 }
662 ast_channel_unlock(chan);
663
664 ast_bridge_features_cleanup(&chan_features);
665
666 if (res && config->end_bridge_callback) {
667 config->end_bridge_callback(config->end_bridge_callback_data);
668 }
669
670 return res;
671}
@ noanswer
int ast_bridge_join(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, struct ast_bridge_tech_optimizations *tech_args, enum ast_bridge_join_flags flags)
Join a channel to a bridge (blocking)
Definition: bridge.c:1621
int ast_bridge_impart(struct ast_bridge *bridge, struct ast_channel *chan, struct ast_channel *swap, struct ast_bridge_features *features, enum ast_bridge_impart_flags flags) attribute_warn_unused_result
Impart a channel to a bridge (non-blocking)
Definition: bridge.c:1878
@ AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP
Definition: bridge.h:592
@ AST_BRIDGE_IMPART_CHAN_INDEPENDENT
Definition: bridge.h:590
@ AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP
Definition: bridge.h:537
@ AST_BRIDGE_JOIN_PASS_REFERENCE
Definition: bridge.h:535
void ast_bridge_basic_set_flags(struct ast_bridge *bridge, unsigned int flags)
Set feature flags on a basic bridge.
int ast_bridge_features_init(struct ast_bridge_features *features)
Initialize bridge features structure.
Definition: bridge.c:3620
struct ast_bridge_features * ast_bridge_features_new(void)
Allocate a new bridge features struct.
Definition: bridge.c:3683
void ast_bridge_features_cleanup(struct ast_bridge_features *features)
Clean up the contents of a bridge features structure.
Definition: bridge.c:3653
void ast_bridge_features_destroy(struct ast_bridge_features *features)
Destroy an allocated bridge features struct.
Definition: bridge.c:3674
@ AST_SOFTHANGUP_ASYNCGOTO
Definition: channel.h:1146
int ast_channel_softhangup_internal_flag(struct ast_channel *chan)
static int pre_bridge_setup(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, struct ast_bridge_features *chan_features, struct ast_bridge_features *peer_features, int noanswer)
Definition: features.c:497
static void bridge_failed_peer_goto(struct ast_channel *chan, struct ast_channel *peer)
Definition: features.c:489
#define SCOPE_TRACE(__level,...)
const char * pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name)
Return a pointer to the value of the corresponding channel variable.
Structure that contains features information.
int value
Definition: syslog.c:37

References ast_bridge_basic_new(), ast_bridge_basic_set_flags(), ast_bridge_destroy(), ast_bridge_features_cleanup(), ast_bridge_features_destroy(), ast_bridge_features_init(), ast_bridge_features_new(), ast_bridge_impart(), AST_BRIDGE_IMPART_CHAN_INDEPENDENT, AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP, ast_bridge_join(), AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP, AST_BRIDGE_JOIN_PASS_REFERENCE, ast_channel_lock, ast_channel_name(), ast_channel_softhangup_internal_flag(), ast_channel_unlock, AST_SOFTHANGUP_ASYNCGOTO, ast_strlen_zero(), bridge_failed_peer_goto(), config, noanswer, NULL, pbx_builtin_getvar_helper(), pre_bridge_setup(), SCOPE_TRACE, and value.

Referenced by ast_bridge_call(), and try_calling().

◆ ast_bridge_timelimit()

int ast_bridge_timelimit ( struct ast_channel chan,
struct ast_bridge_config config,
char *  parse,
struct timeval *  calldurationlimit 
)

parse L option and read associated channel variables to set warning, warning frequency, and timelimit

Note
caller must be aware of freeing memory for warning_sound, end_sound, and start_sound

Definition at line 857 of file features.c.

859{
860 char *stringp = ast_strdupa(parse);
861 char *limit_str, *warning_str, *warnfreq_str;
862 const char *var;
863 int play_to_caller = 0, play_to_callee = 0;
864 int delta;
865
866 limit_str = strsep(&stringp, ":");
867 warning_str = strsep(&stringp, ":");
868 warnfreq_str = strsep(&stringp, ":");
869
870 config->timelimit = atol(limit_str);
871 if (warning_str)
872 config->play_warning = atol(warning_str);
873 if (warnfreq_str)
874 config->warning_freq = atol(warnfreq_str);
875
876 if (!config->timelimit) {
877 ast_log(LOG_WARNING, "Bridge does not accept L(%s)\n", limit_str);
878 config->timelimit = config->play_warning = config->warning_freq = 0;
879 config->warning_sound = NULL;
880 return -1; /* error */
881 } else if ( (delta = config->play_warning - config->timelimit) > 0) {
882 int w = config->warning_freq;
883
884 /*
885 * If the first warning is requested _after_ the entire call
886 * would end, and no warning frequency is requested, then turn
887 * off the warning. If a warning frequency is requested, reduce
888 * the 'first warning' time by that frequency until it falls
889 * within the call's total time limit.
890 *
891 * Graphically:
892 * timelim->| delta |<-playwarning
893 * 0__________________|_________________|
894 * | w | | | |
895 *
896 * so the number of intervals to cut is 1+(delta-1)/w
897 */
898 if (w == 0) {
899 config->play_warning = 0;
900 } else {
901 config->play_warning -= w * ( 1 + (delta-1)/w );
902 if (config->play_warning < 1)
903 config->play_warning = config->warning_freq = 0;
904 }
905 }
906
907 ast_channel_lock(chan);
908
909 var = pbx_builtin_getvar_helper(chan, "LIMIT_PLAYAUDIO_CALLER");
910 play_to_caller = var ? ast_true(var) : 1;
911
912 var = pbx_builtin_getvar_helper(chan, "LIMIT_PLAYAUDIO_CALLEE");
913 play_to_callee = var ? ast_true(var) : 0;
914
915 if (!play_to_caller && !play_to_callee)
916 play_to_caller = 1;
917
918 var = pbx_builtin_getvar_helper(chan, "LIMIT_WARNING_FILE");
919 config->warning_sound = !ast_strlen_zero(var) ? ast_strdup(var) : ast_strdup("timeleft");
920
921 /* The code looking at config wants a NULL, not just "", to decide
922 * that the message should not be played, so we replace "" with NULL.
923 * Note, pbx_builtin_getvar_helper _can_ return NULL if the variable is
924 * not found.
925 */
926
927 var = pbx_builtin_getvar_helper(chan, "LIMIT_TIMEOUT_FILE");
928 config->end_sound = !ast_strlen_zero(var) ? ast_strdup(var) : NULL;
929
930 var = pbx_builtin_getvar_helper(chan, "LIMIT_CONNECT_FILE");
931 config->start_sound = !ast_strlen_zero(var) ? ast_strdup(var) : NULL;
932
933 ast_channel_unlock(chan);
934
935 /* undo effect of S(x) in case they are both used */
936 calldurationlimit->tv_sec = 0;
937 calldurationlimit->tv_usec = 0;
938
939 /* more efficient to do it like S(x) does since no advanced opts */
940 if (!config->play_warning && !config->start_sound && !config->end_sound && config->timelimit) {
941 calldurationlimit->tv_sec = config->timelimit / 1000;
942 calldurationlimit->tv_usec = (config->timelimit % 1000) * 1000;
943 ast_verb(3, "Setting call duration limit to %.3lf seconds.\n",
944 calldurationlimit->tv_sec + calldurationlimit->tv_usec / 1000000.0);
945 play_to_caller = 0;
946 play_to_callee = 0;
947 config->timelimit = 0;
948 config->play_warning = 0;
949 config->warning_freq = 0;
950 } else {
951 ast_verb(4, "Limit Data for this call:\n");
952 ast_verb(4, "timelimit = %ld ms (%.3lf s)\n", config->timelimit, config->timelimit / 1000.0);
953 ast_verb(4, "play_warning = %ld ms (%.3lf s)\n", config->play_warning, config->play_warning / 1000.0);
954 ast_verb(4, "play_to_caller = %s\n", play_to_caller ? "yes" : "no");
955 ast_verb(4, "play_to_callee = %s\n", play_to_callee ? "yes" : "no");
956 ast_verb(4, "warning_freq = %ld ms (%.3lf s)\n", config->warning_freq, config->warning_freq / 1000.0);
957 ast_verb(4, "start_sound = %s\n", S_OR(config->start_sound, ""));
958 ast_verb(4, "warning_sound = %s\n", config->warning_sound);
959 ast_verb(4, "end_sound = %s\n", S_OR(config->end_sound, ""));
960 }
961 if (play_to_caller)
962 ast_set_flag(&(config->features_caller), AST_FEATURE_PLAY_WARNING);
963 if (play_to_callee)
964 ast_set_flag(&(config->features_callee), AST_FEATURE_PLAY_WARNING);
965 return 0;
966}
#define var
Definition: ast_expr2f.c:605
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
@ AST_FEATURE_PLAY_WARNING
Definition: channel.h:1083
char * strsep(char **str, const char *delims)
#define ast_verb(level,...)
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition: strings.h:80
int attribute_pure ast_true(const char *val)
Make sure something is true. Determine if a string containing a boolean value is "true"....
Definition: utils.c:2199
#define ast_set_flag(p, flag)
Definition: utils.h:70

References ast_channel_lock, ast_channel_unlock, AST_FEATURE_PLAY_WARNING, ast_log, ast_set_flag, ast_strdup, ast_strdupa, ast_strlen_zero(), ast_true(), ast_verb, config, LOG_WARNING, NULL, pbx_builtin_getvar_helper(), S_OR, strsep(), and var.

Referenced by bridge_exec(), and dial_exec_full().

◆ ast_channel_log()

void ast_channel_log ( char *  title,
struct ast_channel chan 
)

Definition at line 369 of file features.c.

370{
371 ast_log(LOG_NOTICE, "______ %s (%lx)______\n", title, (unsigned long) chan);
372 ast_log(LOG_NOTICE, "CHAN: name: %s; appl: %s; data: %s; contxt: %s; exten: %s; pri: %d;\n",
375 ast_log(LOG_NOTICE, "CHAN: acctcode: %s; dialcontext: %s; amaflags: %x;\n",
377 ast_log(LOG_NOTICE, "CHAN: masq: %p; masqr: %p; uniqueID: %s; linkedID:%s\n",
380 if (ast_channel_masqr(chan)) {
381 ast_log(LOG_NOTICE, "CHAN: masquerading as: %s; cdr: %p;\n",
383 }
384
385 ast_log(LOG_NOTICE, "===== done ====\n");
386}
const char * ast_channel_linkedid(const struct ast_channel *chan)
struct ast_channel * ast_channel_masq(const struct ast_channel *chan)
const char * ast_channel_data(const struct ast_channel *chan)
struct ast_cdr * ast_channel_cdr(const struct ast_channel *chan)
const char * ast_channel_uniqueid(const struct ast_channel *chan)
const char * ast_channel_accountcode(const struct ast_channel *chan)
const char * ast_channel_appl(const struct ast_channel *chan)
enum ama_flags ast_channel_amaflags(const struct ast_channel *chan)
const char * ast_channel_dialcontext(const struct ast_channel *chan)
struct ast_channel * ast_channel_masqr(const struct ast_channel *chan)
#define LOG_NOTICE

References ast_channel_accountcode(), ast_channel_amaflags(), ast_channel_appl(), ast_channel_cdr(), ast_channel_context(), ast_channel_data(), ast_channel_dialcontext(), ast_channel_exten(), ast_channel_linkedid(), ast_channel_masq(), ast_channel_masqr(), ast_channel_name(), ast_channel_priority(), ast_channel_uniqueid(), ast_log, and LOG_NOTICE.

Referenced by pre_bridge_setup().

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void  )

Definition at line 1159 of file features.c.

◆ bridge_config_set_limits()

static void bridge_config_set_limits ( struct ast_bridge_config config,
struct ast_bridge_features_limits caller_limits,
struct ast_bridge_features_limits callee_limits 
)
static

Definition at line 467 of file features.c.

468{
469 if (ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING)) {
471 }
472
473 if (ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING)) {
475 }
476
477 caller_limits->duration = config->timelimit;
478 callee_limits->duration = config->timelimit;
479}
static void bridge_config_set_limits_warning_values(struct ast_bridge_config *config, struct ast_bridge_features_limits *limits)
Definition: features.c:442

References AST_FEATURE_PLAY_WARNING, ast_test_flag, bridge_config_set_limits_warning_values(), config, and ast_bridge_features_limits::duration.

Referenced by pre_bridge_setup().

◆ bridge_config_set_limits_warning_values()

static void bridge_config_set_limits_warning_values ( struct ast_bridge_config config,
struct ast_bridge_features_limits limits 
)
static

Definition at line 442 of file features.c.

443{
444 if (config->end_sound) {
445 ast_string_field_set(limits, duration_sound, config->end_sound);
446 }
447
448 if (config->warning_sound) {
449 ast_string_field_set(limits, warning_sound, config->warning_sound);
450 }
451
452 if (config->start_sound) {
453 ast_string_field_set(limits, connect_sound, config->start_sound);
454 }
455
456 limits->frequency = config->warning_freq;
457 limits->warning = config->play_warning;
458}
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition: stringfields.h:521

References ast_string_field_set, and config.

Referenced by bridge_config_set_limits().

◆ bridge_exec()

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

Bridge channels.

Parameters
chan
datachannel to bridge with.

Split data, check we aren't bridging with ourself, check valid channel, answer call if not already, check compatible channels, setup bridge config now bridge call, if transferred party hangs up return to PBX extension.

Definition at line 978 of file features.c.

979{
980 struct ast_channel *current_dest_chan = NULL;
981 char *tmp_data = NULL;
982 struct ast_flags opts = { 0, };
983 struct ast_bridge_config bconfig = { { 0, }, };
984 char *opt_args[OPT_ARG_ARRAY_SIZE];
985 struct timeval calldurationlimit = { 0, };
986 const char *context;
987 const char *extension;
988 int priority;
989 int bridge_add_failed;
990 int res = -1;
991 struct ast_bridge_features chan_features;
992 struct ast_bridge_features *peer_features;
993 struct ast_bridge *bridge;
994 struct ast_features_xfer_config *xfer_cfg;
995 int noanswer;
996
998 AST_APP_ARG(dest_chan);
1000 );
1001
1002 tmp_data = ast_strdupa(data ?: "");
1003 AST_STANDARD_APP_ARGS(args, tmp_data);
1004 if (!ast_strlen_zero(args.options)) {
1005 ast_app_parse_options(bridge_exec_options, &opts, opt_args, args.options);
1006 }
1007
1008 /* make sure we have a valid end point */
1009 if (!ast_strlen_zero(args.dest_chan)) {
1010 current_dest_chan = ast_channel_get_by_name_prefix(args.dest_chan,
1011 strlen(args.dest_chan));
1012 }
1013 if (!current_dest_chan) {
1014 ast_verb(4, "Bridge failed because channel '%s' does not exist\n",
1015 args.dest_chan ?: "");
1016 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "NONEXISTENT");
1017 return 0;
1018 }
1019
1020 /* avoid bridge with ourselves */
1021 if (chan == current_dest_chan) {
1022 ast_channel_unref(current_dest_chan);
1023 ast_log(LOG_WARNING, "Unable to bridge channel %s with itself\n", ast_channel_name(chan));
1024 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "LOOP");
1025 return 0;
1026 }
1027
1030 && ast_bridge_timelimit(chan, &bconfig, opt_args[OPT_ARG_DURATION_LIMIT], &calldurationlimit)) {
1031 goto done;
1032 }
1033
1038 if (ast_test_flag(&opts, OPT_CALLEE_HANGUP))
1040 if (ast_test_flag(&opts, OPT_CALLER_HANGUP))
1046 if (ast_test_flag(&opts, OPT_CALLEE_PARK))
1048 if (ast_test_flag(&opts, OPT_CALLER_PARK))
1051
1052 /* Setup after bridge goto location. */
1053 if (ast_test_flag(&opts, OPT_CALLEE_GO_ON)) {
1054 ast_channel_lock(chan);
1058 ast_channel_unlock(chan);
1060 opt_args[OPT_ARG_CALLEE_GO_ON]);
1061 } else if (!ast_test_flag(&opts, OPT_CALLEE_KILL)) {
1062 ast_channel_lock(current_dest_chan);
1063 context = ast_strdupa(ast_channel_context(current_dest_chan));
1064 extension = ast_strdupa(ast_channel_exten(current_dest_chan));
1065 priority = ast_channel_priority(current_dest_chan);
1066 ast_channel_unlock(current_dest_chan);
1068 }
1069
1070 if (ast_bridge_features_init(&chan_features)) {
1071 ast_bridge_features_cleanup(&chan_features);
1072 goto done;
1073 }
1074
1075 peer_features = ast_bridge_features_new();
1076 if (!peer_features) {
1077 ast_bridge_features_cleanup(&chan_features);
1078 goto done;
1079 }
1080
1081 if (pre_bridge_setup(chan, current_dest_chan, &bconfig, &chan_features, peer_features, noanswer)) {
1082 ast_bridge_features_destroy(peer_features);
1083 ast_bridge_features_cleanup(&chan_features);
1084 goto done;
1085 }
1086
1087 bridge = ast_bridge_basic_new();
1088 if (!bridge) {
1089 ast_bridge_features_destroy(peer_features);
1090 ast_bridge_features_cleanup(&chan_features);
1091 goto done;
1092 }
1093
1094 ast_channel_lock(current_dest_chan);
1095 xfer_cfg = ast_get_chan_features_xfer_config(current_dest_chan);
1096 ast_channel_unlock(current_dest_chan);
1097 bridge_add_failed = ast_bridge_add_channel(bridge, current_dest_chan, peer_features,
1099 xfer_cfg ? xfer_cfg->xfersound : NULL);
1100 ao2_cleanup(xfer_cfg);
1101 if (bridge_add_failed) {
1102 ast_bridge_features_cleanup(&chan_features);
1103 ast_bridge_destroy(bridge, 0);
1104 goto done;
1105 }
1106
1107 /* Don't keep the channel ref in case it was not already in a bridge. */
1108 current_dest_chan = ast_channel_unref(current_dest_chan);
1109
1110 res = ast_bridge_join(bridge, chan, NULL, &chan_features, NULL,
1112
1113 ast_bridge_features_cleanup(&chan_features);
1114
1115done:
1116 if (res == -1) {
1117 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "FAILURE");
1118 } else {
1119 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "SUCCESS");
1120 }
1121
1122 ast_free((char *) bconfig.warning_sound);
1123 ast_free((char *) bconfig.end_sound);
1124 ast_free((char *) bconfig.start_sound);
1125
1126 ast_channel_cleanup(current_dest_chan);
1127 return 0;
1128}
#define ast_free(a)
Definition: astmm.h:180
void ast_bridge_set_after_go_on(struct ast_channel *chan, const char *context, const char *exten, int priority, const char *parseable_goto)
Set channel to go on in the dialplan after the bridge.
Definition: bridge_after.c:622
static int priority
@ AST_FEATURE_REDIRECT
Definition: channel.h:1084
@ AST_FEATURE_PARKCALL
Definition: channel.h:1088
@ AST_FEATURE_AUTOMON
Definition: channel.h:1087
@ AST_FEATURE_DISCONNECT
Definition: channel.h:1085
#define ast_channel_unref(c)
Decrease channel reference count.
Definition: channel.h:3004
#define ast_channel_cleanup(c)
Cleanup a channel reference.
Definition: channel.h:3015
static const struct ast_app_option bridge_exec_options[128]
Definition: features.c:855
int ast_bridge_timelimit(struct ast_channel *chan, struct ast_bridge_config *config, char *parse, struct timeval *calldurationlimit)
parse L option and read associated channel variables to set warning, warning frequency,...
Definition: features.c:857
#define AST_APP_ARG(name)
Define an application argument.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_STANDARD_APP_ARGS(args, parse)
Performs the 'standard' argument separation process for an application.
int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr)
Parses a string containing application options and sets flags/arguments.
Definition: main/app.c:3066
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name.
bridge configuration
Definition: channel.h:1096
const char * end_sound
Definition: channel.h:1107
const char * warning_sound
Definition: channel.h:1106
struct ast_flags features_callee
Definition: channel.h:1098
struct ast_flags features_caller
Definition: channel.h:1097
const char * start_sound
Definition: channel.h:1108
Structure used to handle boolean flags.
Definition: utils.h:199
structure to hold extensions
int done
Definition: test_amihooks.c:48
const char * args
static struct test_options options

References ao2_cleanup, args, AST_APP_ARG, ast_app_parse_options(), ast_bridge_add_channel(), ast_bridge_basic_new(), ast_bridge_destroy(), ast_bridge_features_cleanup(), ast_bridge_features_destroy(), ast_bridge_features_init(), ast_bridge_features_new(), ast_bridge_join(), AST_BRIDGE_JOIN_PASS_REFERENCE, ast_bridge_set_after_go_on(), ast_bridge_timelimit(), ast_channel_cleanup, ast_channel_context(), ast_channel_exten(), ast_channel_get_by_name_prefix(), ast_channel_lock, ast_channel_name(), ast_channel_priority(), ast_channel_unlock, ast_channel_unref, AST_DECLARE_APP_ARGS, AST_FEATURE_AUTOMON, AST_FEATURE_DISCONNECT, AST_FEATURE_PARKCALL, AST_FEATURE_REDIRECT, ast_free, ast_get_chan_features_xfer_config(), ast_log, ast_set_flag, AST_STANDARD_APP_ARGS, ast_strdupa, ast_strlen_zero(), ast_test_flag, ast_verb, bridge_exec_options, BRIDGE_OPT_PLAYTONE, voicemailpwcheck::context, done, ast_bridge_config::end_sound, ast_bridge_config::features_callee, ast_bridge_config::features_caller, LOG_WARNING, noanswer, NULL, OPT_ARG_ARRAY_SIZE, OPT_ARG_CALLEE_GO_ON, OPT_ARG_DURATION_LIMIT, OPT_CALLEE_GO_ON, OPT_CALLEE_HANGUP, OPT_CALLEE_KILL, OPT_CALLEE_MONITOR, OPT_CALLEE_PARK, OPT_CALLEE_TRANSFER, OPT_CALLER_HANGUP, OPT_CALLER_MONITOR, OPT_CALLER_PARK, OPT_CALLER_TRANSFER, OPT_DURATION_LIMIT, OPT_NOANSWER, options, pbx_builtin_setvar_helper(), pre_bridge_setup(), priority, ast_bridge_config::start_sound, ast_bridge_config::warning_sound, and ast_features_xfer_config::xfersound.

Referenced by load_module().

◆ bridge_failed_peer_goto()

static void bridge_failed_peer_goto ( struct ast_channel chan,
struct ast_channel peer 
)
static

Definition at line 489 of file features.c.

490{
492 || ast_pbx_start(peer)) {
494 }
495}
int ast_bridge_setup_after_goto(struct ast_channel *chan)
Setup any after bridge goto location to begin execution.
Definition: bridge_after.c:435
void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer)
Put chan into autoservice while hanging up peer.
Definition: autoservice.c:349
enum ast_pbx_result ast_pbx_start(struct ast_channel *c)
Create a new thread and start the PBX.
Definition: pbx.c:4708

References ast_autoservice_chan_hangup_peer(), ast_bridge_setup_after_goto(), and ast_pbx_start().

Referenced by ast_bridge_call_with_flags().

◆ dial_features_duplicate()

static void * dial_features_duplicate ( void *  data)
static

Definition at line 268 of file features.c.

269{
270 struct ast_dial_features *df = data, *df_copy;
271
272 if (!(df_copy = ast_calloc(1, sizeof(*df)))) {
273 return NULL;
274 }
275
276 memcpy(df_copy, df, sizeof(*df));
277
278 return df_copy;
279}

References ast_calloc, and NULL.

◆ load_module()

static int load_module ( void  )
static

Definition at line 1141 of file features.c.

1142{
1143 int res;
1144
1145 res = load_features_config();
1148
1150}
static char * app_bridge
Definition: features.c:813
static int action_bridge(struct mansession *s, const struct message *m)
Bridge channels together.
Definition: features.c:726
static int bridge_exec(struct ast_channel *chan, const char *data)
Bridge channels.
Definition: features.c:978
int load_features_config(void)
#define ast_manager_register_xml_core(action, authority, func)
Register a manager callback using XML documentation to describe the manager.
Definition: manager.h:202
#define EVENT_FLAG_CALL
Definition: manager.h:76
int ast_register_application2(const char *app, int(*execute)(struct ast_channel *, const char *), const char *synopsis, const char *description, void *mod)
Register an application.
Definition: pbx_app.c:103
@ AST_MODULE_LOAD_FAILURE
Module could not be loaded properly.
Definition: module.h:102
@ AST_MODULE_LOAD_SUCCESS
Definition: module.h:70

References action_bridge(), app_bridge, ast_manager_register_xml_core, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, ast_register_application2(), bridge_exec(), EVENT_FLAG_CALL, load_features_config(), and NULL.

◆ parse_playtone()

static enum play_tone_action parse_playtone ( const char *  playtone_val)
static

Definition at line 697 of file features.c.

698{
699 if (ast_strlen_zero(playtone_val) || ast_false(playtone_val)) {
700 return PLAYTONE_NONE;
701 } if (!strcasecmp(playtone_val, "channel1")) {
702 return PLAYTONE_CHANNEL1;
703 } else if (!strcasecmp(playtone_val, "channel2") || ast_true(playtone_val)) {
704 return PLAYTONE_CHANNEL2;
705 } else if (!strcasecmp(playtone_val, "both")) {
706 return PLAYTONE_BOTH;
707 } else {
708 /* Invalid input. Assume none */
709 return PLAYTONE_NONE;
710 }
711}
int attribute_pure ast_false(const char *val)
Make sure something is false. Determine if a string containing a boolean value is "false"....
Definition: utils.c:2216

References ast_false(), ast_strlen_zero(), ast_true(), PLAYTONE_BOTH, PLAYTONE_CHANNEL1, PLAYTONE_CHANNEL2, and PLAYTONE_NONE.

Referenced by action_bridge().

◆ pre_bridge_setup()

static int pre_bridge_setup ( struct ast_channel chan,
struct ast_channel peer,
struct ast_bridge_config config,
struct ast_bridge_features chan_features,
struct ast_bridge_features peer_features,
int  noanswer 
)
static

Definition at line 497 of file features.c.

499{
500 int res;
501 SCOPE_TRACE(1, "%s Peer: %s\n", ast_channel_name(chan), ast_channel_name(peer));
502
504 add_features_datastores(chan, peer, config);
505
506 /*
507 * This is an interesting case. One example is if a ringing
508 * channel gets redirected to an extension that picks up a
509 * parked call. This will make sure that the call taken out of
510 * parking gets told that the channel it just got bridged to is
511 * still ringing.
512 */
516 }
517
519
520 /* Answer if need be */
521
522 res = 0;
523
524 if (noanswer) {
525 ast_debug(1, "Skipping answer on %s due to no answer directive\n", ast_channel_name(chan));
526 } else if (ast_channel_state(chan) != AST_STATE_UP) {
527 ast_debug(1, "Answering channel for bridge: %s\n", ast_channel_name(chan));
528 res = ast_raw_answer_with_stream_topology(chan, config->answer_topology);
529 if (res != 0) {
530 return -1;
531 }
532 }
533
534
535#ifdef FOR_DEBUG
536 /* show the two channels and cdrs involved in the bridge for debug & devel purposes */
537 ast_channel_log("Pre-bridge CHAN Channel info", chan);
538 ast_channel_log("Pre-bridge PEER Channel info", peer);
539#endif
540
541 res = 0;
542 ast_channel_lock(chan);
544 res |= ast_bridge_features_ds_append(chan, &config->features_caller);
545 ast_channel_unlock(chan);
546 ast_channel_lock(peer);
548 res |= ast_bridge_features_ds_append(peer, &config->features_callee);
549 ast_channel_unlock(peer);
550
551 if (res) {
552 return -1;
553 }
554
555 if (config->timelimit) {
556 struct ast_bridge_features_limits call_duration_limits_chan;
557 struct ast_bridge_features_limits call_duration_limits_peer;
558 int abandon_call = 0; /* TRUE if set limits fails so we can abandon the call. */
559
560 if (ast_bridge_features_limits_construct(&call_duration_limits_chan)) {
561 ast_log(LOG_ERROR, "Could not construct caller duration limits. Bridge canceled.\n");
562
563 return -1;
564 }
565
566 if (ast_bridge_features_limits_construct(&call_duration_limits_peer)) {
567 ast_log(LOG_ERROR, "Could not construct callee duration limits. Bridge canceled.\n");
568 ast_bridge_features_limits_destroy(&call_duration_limits_chan);
569
570 return -1;
571 }
572
573 bridge_config_set_limits(config, &call_duration_limits_chan, &call_duration_limits_peer);
574
575 if (ast_bridge_features_set_limits(chan_features, &call_duration_limits_chan, 0)) {
576 abandon_call = 1;
577 }
578 if (ast_bridge_features_set_limits(peer_features, &call_duration_limits_peer, 0)) {
579 abandon_call = 1;
580 }
581
582 /* At this point we are done with the limits structs since they have been copied to the individual feature sets. */
583 ast_bridge_features_limits_destroy(&call_duration_limits_chan);
584 ast_bridge_features_limits_destroy(&call_duration_limits_peer);
585
586 if (abandon_call) {
587 ast_log(LOG_ERROR, "Could not set duration limits on one or more sides of the call. Bridge canceled.\n");
588 return -1;
589 }
590 }
591
592 return 0;
593}
int ast_bridge_features_ds_append(struct ast_channel *chan, struct ast_flags *flags)
Append basic bridge DTMF feature flags on the channel.
Definition: bridge_basic.c:263
int ast_bridge_features_set_limits(struct ast_bridge_features *features, struct ast_bridge_features_limits *limits, enum ast_bridge_hook_remove_flags remove_flags)
Limit the amount of time a channel may stay in the bridge and optionally play warning messages as tim...
Definition: bridge.c:3412
int ast_bridge_features_limits_construct(struct ast_bridge_features_limits *limits)
Constructor function for ast_bridge_features_limits.
Definition: bridge.c:3396
void ast_bridge_features_limits_destroy(struct ast_bridge_features_limits *limits)
Destructor function for ast_bridge_features_limits.
Definition: bridge.c:3407
int ast_raw_answer_with_stream_topology(struct ast_channel *chan, struct ast_stream_topology *topology)
Answer a channel passing in a stream topology.
Definition: channel.c:2658
int ast_channel_visible_indication(const struct ast_channel *chan)
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition: channel.c:4296
ast_channel_state
ast_channel states
Definition: channelstate.h:35
@ AST_STATE_RINGING
Definition: channelstate.h:41
@ AST_STATE_UP
Definition: channelstate.h:42
void ast_channel_log(char *title, struct ast_channel *chan)
Definition: features.c:369
static void add_features_datastores(struct ast_channel *caller, struct ast_channel *callee, struct ast_bridge_config *config)
Definition: features.c:428
static void bridge_config_set_limits(struct ast_bridge_config *config, struct ast_bridge_features_limits *caller_limits, struct ast_bridge_features_limits *callee_limits)
Definition: features.c:467
static void set_config_flags(struct ast_channel *chan, struct ast_bridge_config *config)
Definition: features.c:340
static void set_bridge_features_on_config(struct ast_bridge_config *config, const char *features)
Definition: features.c:388
@ AST_CONTROL_RINGING
#define LOG_ERROR
int ast_max_forwards_reset(struct ast_channel *chan)
Reset the max forwards on a channel to its starting value.
Definition: max_forwards.c:151
Structure that contains configuration information for the limits feature.

References add_features_datastores(), ast_bridge_features_ds_append(), ast_bridge_features_limits_construct(), ast_bridge_features_limits_destroy(), ast_bridge_features_set_limits(), ast_channel_lock, ast_channel_log(), ast_channel_name(), ast_channel_unlock, ast_channel_visible_indication(), AST_CONTROL_RINGING, ast_debug, ast_indicate(), ast_log, ast_max_forwards_reset(), ast_raw_answer_with_stream_topology(), AST_STATE_RINGING, AST_STATE_UP, bridge_config_set_limits(), config, LOG_ERROR, noanswer, pbx_builtin_getvar_helper(), SCOPE_TRACE, set_bridge_features_on_config(), and set_config_flags().

Referenced by ast_bridge_call_with_flags(), and bridge_exec().

◆ set_bridge_features_on_config()

static void set_bridge_features_on_config ( struct ast_bridge_config config,
const char *  features 
)
static

Definition at line 388 of file features.c.

389{
390 const char *feature;
391
392 if (ast_strlen_zero(features)) {
393 return;
394 }
395
396 for (feature = features; *feature; feature++) {
397 struct ast_flags *party;
398
399 if (isupper(*feature)) {
400 party = &config->features_caller;
401 } else {
402 party = &config->features_callee;
403 }
404
405 switch (tolower(*feature)) {
406 case 't' :
408 break;
409 case 'k' :
411 break;
412 case 'h' :
414 break;
415 case 'w' :
417 break;
418 case 'x' :
420 break;
421 default :
422 ast_log(LOG_WARNING, "Skipping unknown feature code '%c'\n", *feature);
423 break;
424 }
425 }
426}
@ AST_FEATURE_AUTOMIXMON
Definition: channel.h:1089

References AST_FEATURE_AUTOMIXMON, AST_FEATURE_AUTOMON, AST_FEATURE_DISCONNECT, AST_FEATURE_PARKCALL, AST_FEATURE_REDIRECT, ast_log, ast_set_flag, ast_strlen_zero(), config, and LOG_WARNING.

Referenced by pre_bridge_setup().

◆ set_config_flags()

static void set_config_flags ( struct ast_channel chan,
struct ast_bridge_config config 
)
static

Definition at line 340 of file features.c.

341{
343
344 if (ast_test_flag(&config->features_caller, AST_FEATURE_DTMF_MASK)) {
346 }
347 if (ast_test_flag(&config->features_callee, AST_FEATURE_DTMF_MASK)) {
349 }
350
352 RAII_VAR(struct ao2_container *, applicationmap, NULL, ao2_cleanup);
353
354 ast_channel_lock(chan);
355 applicationmap = ast_get_chan_applicationmap(chan);
356 ast_channel_unlock(chan);
357
358 if (!applicationmap) {
359 return;
360 }
361
362 /* If an applicationmap exists for this channel at all, then the channel needs the DTMF flag set */
364 }
365}
#define AST_BRIDGE_DTMF_CHANNEL_0
Report DTMF on channel 0.
Definition: channel.h:2416
#define AST_BRIDGE_DTMF_CHANNEL_1
Report DTMF on channel 1.
Definition: channel.h:2418
#define AST_FEATURE_DTMF_MASK
Definition: channel.h:1092
struct ao2_container * ast_get_chan_applicationmap(struct ast_channel *chan)
Get the applicationmap for a given channel.
Generic container type.
#define ast_clear_flag(p, flag)
Definition: utils.h:77

References ao2_cleanup, AST_BRIDGE_DTMF_CHANNEL_0, AST_BRIDGE_DTMF_CHANNEL_1, ast_channel_lock, ast_channel_unlock, ast_clear_flag, AST_FEATURE_DTMF_MASK, AST_FLAGS_ALL, ast_get_chan_applicationmap(), ast_set_flag, ast_test_flag, config, NULL, and RAII_VAR.

Referenced by pre_bridge_setup().

◆ unload_module()

static int unload_module ( void  )
static

Definition at line 1130 of file features.c.

1131{
1133
1134 ast_manager_unregister("Bridge");
1135
1137
1138 return 0;
1139}
void unload_features_config(void)
int ast_manager_unregister(const char *action)
Unregister a registered manager command.
Definition: manager.c:7608
int ast_unregister_application(const char *app)
Unregister an application.
Definition: pbx_app.c:392

References app_bridge, ast_manager_unregister(), ast_unregister_application(), and unload_features_config().

Variable Documentation

◆ __mod_info

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

Definition at line 1159 of file features.c.

◆ app_bridge

char* app_bridge = "Bridge"
static

Definition at line 813 of file features.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 1159 of file features.c.

◆ bridge_exec_options

const struct ast_app_option bridge_exec_options[128] = { [ 'p' ] = { .flag = BRIDGE_OPT_PLAYTONE }, [ 'F' ] = { .flag = OPT_CALLEE_GO_ON , .arg_index = OPT_ARG_CALLEE_GO_ON + 1 }, [ 'h' ] = { .flag = OPT_CALLEE_HANGUP }, [ 'H' ] = { .flag = OPT_CALLER_HANGUP }, [ 'k' ] = { .flag = OPT_CALLEE_PARK }, [ 'K' ] = { .flag = OPT_CALLER_PARK }, [ 'L' ] = { .flag = OPT_DURATION_LIMIT , .arg_index = OPT_ARG_DURATION_LIMIT + 1 }, [ 'n' ] = { .flag = OPT_NOANSWER }, [ 'S' ] = { .flag = OPT_DURATION_STOP , .arg_index = OPT_ARG_DURATION_STOP + 1 }, [ 't' ] = { .flag = OPT_CALLEE_TRANSFER }, [ 'T' ] = { .flag = OPT_CALLER_TRANSFER }, [ 'w' ] = { .flag = OPT_CALLEE_MONITOR }, [ 'W' ] = { .flag = OPT_CALLER_MONITOR }, [ 'x' ] = { .flag = OPT_CALLEE_KILL }, }
static

Definition at line 855 of file features.c.

Referenced by bridge_exec().

◆ dial_features_info

const struct ast_datastore_info dial_features_info
static
Initial value:
= {
.type = "dial-features",
.destroy = ast_free_ptr,
}
void ast_free_ptr(void *ptr)
free() wrapper
Definition: astmm.c:1739
static void * dial_features_duplicate(void *data)
Definition: features.c:268

Definition at line 281 of file features.c.

Referenced by add_features_datastore().