Asterisk - The Open Source Telephony Project GIT-master-77d630f
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 824 of file features.c.

824 {
825 BRIDGE_OPT_PLAYTONE = (1 << 0),
826 OPT_CALLEE_HANGUP = (1 << 1),
827 OPT_CALLER_HANGUP = (1 << 2),
828 OPT_DURATION_LIMIT = (1 << 3),
829 OPT_DURATION_STOP = (1 << 4),
830 OPT_CALLEE_TRANSFER = (1 << 5),
831 OPT_CALLER_TRANSFER = (1 << 6),
832 OPT_CALLEE_MONITOR = (1 << 7),
833 OPT_CALLER_MONITOR = (1 << 8),
834 OPT_CALLEE_PARK = (1 << 9),
835 OPT_CALLER_PARK = (1 << 10),
836 OPT_CALLEE_KILL = (1 << 11),
837 OPT_CALLEE_GO_ON = (1 << 12),
838 OPT_NOANSWER = (1 << 13),
839};
@ OPT_CALLEE_PARK
Definition: features.c:834
@ OPT_DURATION_LIMIT
Definition: features.c:828
@ OPT_DURATION_STOP
Definition: features.c:829
@ OPT_NOANSWER
Definition: features.c:838
@ OPT_CALLEE_TRANSFER
Definition: features.c:830
@ OPT_CALLEE_GO_ON
Definition: features.c:837
@ OPT_CALLER_PARK
Definition: features.c:835
@ OPT_CALLER_MONITOR
Definition: features.c:833
@ OPT_CALLEE_MONITOR
Definition: features.c:832
@ OPT_CALLER_HANGUP
Definition: features.c:827
@ OPT_CALLEE_HANGUP
Definition: features.c:826
@ BRIDGE_OPT_PLAYTONE
Definition: features.c:825
@ OPT_CALLEE_KILL
Definition: features.c:836
@ OPT_CALLER_TRANSFER
Definition: features.c:831

◆ 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 841 of file features.c.

841 {
845 /* note: this entry _MUST_ be the last one in the enum */
847};
@ OPT_ARG_CALLEE_GO_ON
Definition: features.c:844
@ OPT_ARG_DURATION_STOP
Definition: features.c:843
@ OPT_ARG_DURATION_LIMIT
Definition: features.c:842
@ OPT_ARG_ARRAY_SIZE
Definition: features.c:846

◆ feature_interpret_op

Enumerator
FEATURE_INTERPRET_DETECT 
FEATURE_INTERPRET_DO 
FEATURE_INTERPRET_CHECK 

Definition at line 264 of file features.c.

264 {
265 FEATURE_INTERPRET_DETECT, /* Used by ast_feature_detect */
266 FEATURE_INTERPRET_DO, /* Used by feature_interpret */
267 FEATURE_INTERPRET_CHECK, /* Used by feature_check */
feature_interpret_op
Definition: features.c:264
@ FEATURE_INTERPRET_CHECK
Definition: features.c:267
@ FEATURE_INTERPRET_DO
Definition: features.c:266
@ FEATURE_INTERPRET_DETECT
Definition: features.c:265

◆ play_tone_action

Enumerator
PLAYTONE_NONE 
PLAYTONE_CHANNEL1 
PLAYTONE_CHANNEL2 
PLAYTONE_BOTH 

Definition at line 699 of file features.c.

699 {
700 PLAYTONE_NONE = 0,
701 PLAYTONE_CHANNEL1 = (1 << 0),
702 PLAYTONE_CHANNEL2 = (1 << 1),
704};
@ PLAYTONE_CHANNEL1
Definition: features.c:701
@ PLAYTONE_CHANNEL2
Definition: features.c:702
@ PLAYTONE_NONE
Definition: features.c:700
@ PLAYTONE_BOTH
Definition: features.c:703

Function Documentation

◆ __reg_module()

static void __reg_module ( void  )
static

Definition at line 1168 of file features.c.

◆ __unreg_module()

static void __unreg_module ( void  )
static

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

736{
737 const char *channela = astman_get_header(m, "Channel1");
738 const char *channelb = astman_get_header(m, "Channel2");
740 RAII_VAR(struct ast_channel *, chana, NULL, ao2_cleanup);
741 RAII_VAR(struct ast_channel *, chanb, NULL, ao2_cleanup);
742 const char *chana_exten;
743 const char *chana_context;
744 int chana_priority;
745 const char *chanb_exten;
746 const char *chanb_context;
747 int chanb_priority;
748 struct ast_bridge *bridge;
749 char buf[256];
750 RAII_VAR(struct ast_features_xfer_config *, xfer_cfg_a, NULL, ao2_cleanup);
751 RAII_VAR(struct ast_features_xfer_config *, xfer_cfg_b, NULL, ao2_cleanup);
752
753 /* make sure valid channels were specified */
754 if (ast_strlen_zero(channela) || ast_strlen_zero(channelb)) {
755 astman_send_error(s, m, "Missing channel parameter in request");
756 return 0;
757 }
758
759 ast_debug(1, "Performing Bridge action on %s and %s\n", channela, channelb);
760
761 /* Start with chana */
762 chana = ast_channel_get_by_name_prefix(channela, strlen(channela));
763 if (!chana) {
764 snprintf(buf, sizeof(buf), "Channel1 does not exist: %s", channela);
765 astman_send_error(s, m, buf);
766 return 0;
767 }
768 ast_channel_lock(chana);
769 xfer_cfg_a = ast_get_chan_features_xfer_config(chana);
770 chana_exten = ast_strdupa(ast_channel_exten(chana));
771 chana_context = ast_strdupa(ast_channel_context(chana));
772 chana_priority = ast_channel_priority(chana);
774 chana_priority++;
775 }
776 ast_channel_unlock(chana);
777
778 chanb = ast_channel_get_by_name_prefix(channelb, strlen(channelb));
779 if (!chanb) {
780 snprintf(buf, sizeof(buf), "Channel2 does not exist: %s", channelb);
781 astman_send_error(s, m, buf);
782 return 0;
783 }
784 ast_channel_lock(chanb);
785 xfer_cfg_b = ast_get_chan_features_xfer_config(chanb);
786 chanb_exten = ast_strdupa(ast_channel_exten(chanb));
787 chanb_context = ast_strdupa(ast_channel_context(chanb));
788 chanb_priority = ast_channel_priority(chanb);
790 chanb_priority++;
791 }
792 ast_channel_unlock(chanb);
793
794 bridge = ast_bridge_basic_new();
795 if (!bridge) {
796 astman_send_error(s, m, "Unable to create bridge\n");
797 return 0;
798 }
799
800 ast_bridge_set_after_goto(chana, chana_context, chana_exten, chana_priority);
801 if (ast_bridge_add_channel(bridge, chana, NULL, playtone & PLAYTONE_CHANNEL1, xfer_cfg_a ? xfer_cfg_a->xfersound : NULL)) {
802 snprintf(buf, sizeof(buf), "Unable to add Channel1 to bridge: %s", ast_channel_name(chana));
803 astman_send_error(s, m, buf);
804 ast_bridge_destroy(bridge, 0);
805 return 0;
806 }
807
808 ast_bridge_set_after_goto(chanb, chanb_context, chanb_exten, chanb_priority);
809 if (ast_bridge_add_channel(bridge, chanb, NULL, playtone & PLAYTONE_CHANNEL2, xfer_cfg_b ? xfer_cfg_b->xfersound : NULL)) {
810 snprintf(buf, sizeof(buf), "Unable to add Channel2 to bridge: %s", ast_channel_name(chanb));
811 astman_send_error(s, m, buf);
812 ast_bridge_destroy(bridge, 0);
813 return 0;
814 }
815
816 astman_send_ack(s, m, "Channels have been bridged");
817 ao2_cleanup(bridge);
818
819 return 0;
820}
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:1009
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:2972
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
int ast_channel_priority(const struct ast_channel *chan)
@ AST_FLAG_IN_AUTOLOOP
Definition: channel.h:1017
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:1381
const char * ast_channel_exten(const struct ast_channel *chan)
#define ast_channel_unlock(chan)
Definition: channel.h:2973
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
play_tone_action
Definition: features.c:699
static enum play_tone_action parse_playtone(const char *playtone_val)
Definition: features.c:706
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:2540
void astman_send_error(struct mansession *s, const struct message *m, char *error)
Send error in manager transaction.
Definition: manager.c:1982
void astman_send_ack(struct mansession *s, const struct message *m, char *msg)
Send ack in manager transaction.
Definition: manager.c:2014
const char * astman_get_header(const struct message *m, char *var)
Get header from manager transaction.
Definition: manager.c:1643
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:353
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:978

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 306 of file features.c.

307{
308 struct ast_datastore *datastore;
309 struct ast_dial_features *dialfeatures;
310
311 ast_channel_lock(chan);
313 ast_channel_unlock(chan);
314 if (datastore) {
315 /* Already exists. */
316 return 1;
317 }
318
319 /* Create a new datastore with specified feature flags. */
321 if (!datastore) {
322 ast_log(LOG_WARNING, "Unable to create channel features datastore.\n");
323 return 0;
324 }
325 dialfeatures = ast_calloc(1, sizeof(*dialfeatures));
326 if (!dialfeatures) {
327 ast_log(LOG_WARNING, "Unable to allocate memory for feature flags.\n");
328 ast_datastore_free(datastore);
329 return 0;
330 }
334 datastore->data = dialfeatures;
335 ast_channel_lock(chan);
336 ast_channel_datastore_add(chan, datastore);
337 ast_channel_unlock(chan);
338 return 0;
339}
#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:2355
#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:2369
#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:290
#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:274
struct ast_flags my_features
Definition: features.c:272
#define ast_copy_flags(dest, src, flagz)
Definition: utils.h:84
#define AST_FLAGS_ALL
Definition: utils.h:214

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 437 of file features.c.

438{
439 if (add_features_datastore(caller, &config->features_caller, &config->features_callee)) {
440 /*
441 * If we don't return here, then when we do a builtin_atxfer we
442 * will copy the disconnect flags over from the atxfer to the
443 * callee (Party C).
444 */
445 return;
446 }
447
448 add_features_datastore(callee, &config->features_callee, &config->features_caller);
449}
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:306

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 694 of file features.c.

695{
696 return ast_bridge_call_with_flags(chan, peer, config, 0);
697}
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:604

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 604 of file features.c.

605{
606 int res;
607 struct ast_bridge *bridge;
608 struct ast_bridge_features chan_features;
609 struct ast_bridge_features *peer_features;
610 const char *value;
611 int noanswer;
612 SCOPE_TRACE(1, "%s Peer: %s\n", ast_channel_name(chan), ast_channel_name(peer));
613
614 /* Setup features. */
615 res = ast_bridge_features_init(&chan_features);
616 peer_features = ast_bridge_features_new();
617 if (res || !peer_features) {
618 ast_bridge_features_destroy(peer_features);
619 ast_bridge_features_cleanup(&chan_features);
620 bridge_failed_peer_goto(chan, peer);
621 return -1;
622 }
623
624 ast_channel_lock(chan);
625 value = pbx_builtin_getvar_helper(chan, "BRIDGE_NOANSWER");
626 noanswer = !ast_strlen_zero(value) ? 1 : 0;
627 ast_channel_unlock(chan);
628
629 if (pre_bridge_setup(chan, peer, config, &chan_features, peer_features, noanswer)) {
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 /* Create bridge */
637 bridge = ast_bridge_basic_new();
638 if (!bridge) {
639 ast_bridge_features_destroy(peer_features);
640 ast_bridge_features_cleanup(&chan_features);
641 bridge_failed_peer_goto(chan, peer);
642 return -1;
643 }
644
645 ast_bridge_basic_set_flags(bridge, flags);
646
647 /* Put peer into the bridge */
648 if (ast_bridge_impart(bridge, peer, NULL, peer_features,
650 ast_bridge_destroy(bridge, 0);
651 ast_bridge_features_cleanup(&chan_features);
652 bridge_failed_peer_goto(chan, peer);
653 return -1;
654 }
655
656 /* Join bridge */
657 ast_bridge_join(bridge, chan, NULL, &chan_features, NULL,
659
660 /*
661 * If the bridge was broken for a hangup that isn't real, then
662 * don't run the h extension, because the channel isn't really
663 * hung up. This should really only happen with
664 * AST_SOFTHANGUP_ASYNCGOTO.
665 */
666 res = -1;
667 ast_channel_lock(chan);
669 res = 0;
670 }
671 ast_channel_unlock(chan);
672
673 ast_bridge_features_cleanup(&chan_features);
674
675 if (res && config->end_bridge_callback) {
676 config->end_bridge_callback(config->end_bridge_callback_data);
677 }
678
679 return res;
680}
@ 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:1690
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:1947
@ AST_BRIDGE_IMPART_INHIBIT_JOIN_COLP
Definition: bridge.h:596
@ AST_BRIDGE_IMPART_CHAN_INDEPENDENT
Definition: bridge.h:594
@ AST_BRIDGE_JOIN_INHIBIT_JOIN_COLP
Definition: bridge.h:541
@ AST_BRIDGE_JOIN_PASS_REFERENCE
Definition: bridge.h:539
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:3699
struct ast_bridge_features * ast_bridge_features_new(void)
Allocate a new bridge features struct.
Definition: bridge.c:3762
void ast_bridge_features_cleanup(struct ast_bridge_features *features)
Clean up the contents of a bridge features structure.
Definition: bridge.c:3732
void ast_bridge_features_destroy(struct ast_bridge_features *features)
Destroy an allocated bridge features struct.
Definition: bridge.c:3753
@ 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:506
static void bridge_failed_peer_goto(struct ast_channel *chan, struct ast_channel *peer)
Definition: features.c:498
#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 866 of file features.c.

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

379{
380 ast_log(LOG_NOTICE, "______ %s (%lx)______\n", title, (unsigned long) chan);
381 ast_log(LOG_NOTICE, "CHAN: name: %s; appl: %s; data: %s; contxt: %s; exten: %s; pri: %d;\n",
384 ast_log(LOG_NOTICE, "CHAN: acctcode: %s; dialcontext: %s; amaflags: %x;\n",
386 ast_log(LOG_NOTICE, "CHAN: masq: %p; masqr: %p; uniqueID: %s; linkedID:%s\n",
389 if (ast_channel_masqr(chan)) {
390 ast_log(LOG_NOTICE, "CHAN: masquerading as: %s; cdr: %p;\n",
392 }
393
394 ast_log(LOG_NOTICE, "===== done ====\n");
395}
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 1168 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 476 of file features.c.

477{
478 if (ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING)) {
480 }
481
482 if (ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING)) {
484 }
485
486 caller_limits->duration = config->timelimit;
487 callee_limits->duration = config->timelimit;
488}
static void bridge_config_set_limits_warning_values(struct ast_bridge_config *config, struct ast_bridge_features_limits *limits)
Definition: features.c:451

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 451 of file features.c.

452{
453 if (config->end_sound) {
454 ast_string_field_set(limits, duration_sound, config->end_sound);
455 }
456
457 if (config->warning_sound) {
458 ast_string_field_set(limits, warning_sound, config->warning_sound);
459 }
460
461 if (config->start_sound) {
462 ast_string_field_set(limits, connect_sound, config->start_sound);
463 }
464
465 limits->frequency = config->warning_freq;
466 limits->warning = config->play_warning;
467}
#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 987 of file features.c.

988{
989 struct ast_channel *current_dest_chan = NULL;
990 char *tmp_data = NULL;
991 struct ast_flags opts = { 0, };
992 struct ast_bridge_config bconfig = { { 0, }, };
993 char *opt_args[OPT_ARG_ARRAY_SIZE];
994 struct timeval calldurationlimit = { 0, };
995 const char *context;
996 const char *extension;
997 int priority;
998 int bridge_add_failed;
999 int res = -1;
1000 struct ast_bridge_features chan_features;
1001 struct ast_bridge_features *peer_features;
1002 struct ast_bridge *bridge;
1003 struct ast_features_xfer_config *xfer_cfg;
1004 int noanswer;
1005
1007 AST_APP_ARG(dest_chan);
1009 );
1010
1011 tmp_data = ast_strdupa(data ?: "");
1012 AST_STANDARD_APP_ARGS(args, tmp_data);
1013 if (!ast_strlen_zero(args.options)) {
1014 ast_app_parse_options(bridge_exec_options, &opts, opt_args, args.options);
1015 }
1016
1017 /* make sure we have a valid end point */
1018 if (!ast_strlen_zero(args.dest_chan)) {
1019 current_dest_chan = ast_channel_get_by_name_prefix(args.dest_chan,
1020 strlen(args.dest_chan));
1021 }
1022 if (!current_dest_chan) {
1023 ast_verb(4, "Bridge failed because channel '%s' does not exist\n",
1024 args.dest_chan ?: "");
1025 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "NONEXISTENT");
1026 return 0;
1027 }
1028
1029 /* avoid bridge with ourselves */
1030 if (chan == current_dest_chan) {
1031 ast_channel_unref(current_dest_chan);
1032 ast_log(LOG_WARNING, "Unable to bridge channel %s with itself\n", ast_channel_name(chan));
1033 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "LOOP");
1034 return 0;
1035 }
1036
1039 && ast_bridge_timelimit(chan, &bconfig, opt_args[OPT_ARG_DURATION_LIMIT], &calldurationlimit)) {
1040 goto done;
1041 }
1042
1047 if (ast_test_flag(&opts, OPT_CALLEE_HANGUP))
1049 if (ast_test_flag(&opts, OPT_CALLER_HANGUP))
1055 if (ast_test_flag(&opts, OPT_CALLEE_PARK))
1057 if (ast_test_flag(&opts, OPT_CALLER_PARK))
1060
1061 /* Setup after bridge goto location. */
1062 if (ast_test_flag(&opts, OPT_CALLEE_GO_ON)) {
1063 ast_channel_lock(chan);
1067 ast_channel_unlock(chan);
1069 opt_args[OPT_ARG_CALLEE_GO_ON]);
1070 } else if (!ast_test_flag(&opts, OPT_CALLEE_KILL)) {
1071 ast_channel_lock(current_dest_chan);
1072 context = ast_strdupa(ast_channel_context(current_dest_chan));
1073 extension = ast_strdupa(ast_channel_exten(current_dest_chan));
1074 priority = ast_channel_priority(current_dest_chan);
1075 ast_channel_unlock(current_dest_chan);
1077 }
1078
1079 if (ast_bridge_features_init(&chan_features)) {
1080 ast_bridge_features_cleanup(&chan_features);
1081 goto done;
1082 }
1083
1084 peer_features = ast_bridge_features_new();
1085 if (!peer_features) {
1086 ast_bridge_features_cleanup(&chan_features);
1087 goto done;
1088 }
1089
1090 if (pre_bridge_setup(chan, current_dest_chan, &bconfig, &chan_features, peer_features, noanswer)) {
1091 ast_bridge_features_destroy(peer_features);
1092 ast_bridge_features_cleanup(&chan_features);
1093 goto done;
1094 }
1095
1096 bridge = ast_bridge_basic_new();
1097 if (!bridge) {
1098 ast_bridge_features_destroy(peer_features);
1099 ast_bridge_features_cleanup(&chan_features);
1100 goto done;
1101 }
1102
1103 ast_channel_lock(current_dest_chan);
1104 xfer_cfg = ast_get_chan_features_xfer_config(current_dest_chan);
1105 ast_channel_unlock(current_dest_chan);
1106 bridge_add_failed = ast_bridge_add_channel(bridge, current_dest_chan, peer_features,
1108 xfer_cfg ? xfer_cfg->xfersound : NULL);
1109 ao2_cleanup(xfer_cfg);
1110 if (bridge_add_failed) {
1111 ast_bridge_features_cleanup(&chan_features);
1112 ast_bridge_destroy(bridge, 0);
1113 goto done;
1114 }
1115
1116 /* Don't keep the channel ref in case it was not already in a bridge. */
1117 current_dest_chan = ast_channel_unref(current_dest_chan);
1118
1119 res = ast_bridge_join(bridge, chan, NULL, &chan_features, NULL,
1121
1122 ast_bridge_features_cleanup(&chan_features);
1123
1124done:
1125 if (res == -1) {
1126 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "FAILURE");
1127 } else {
1128 pbx_builtin_setvar_helper(chan, "BRIDGERESULT", "SUCCESS");
1129 }
1130
1131 ast_free((char *) bconfig.warning_sound);
1132 ast_free((char *) bconfig.end_sound);
1133 ast_free((char *) bconfig.start_sound);
1134
1135 ast_channel_cleanup(current_dest_chan);
1136 return 0;
1137}
#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:3008
#define ast_channel_cleanup(c)
Cleanup a channel reference.
Definition: channel.h:3019
static const struct ast_app_option bridge_exec_options[128]
Definition: features.c:864
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:866
#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:217
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 498 of file features.c.

499{
501 || ast_pbx_start(peer)) {
503 }
504}
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:4729

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 277 of file features.c.

278{
279 struct ast_dial_features *df = data, *df_copy;
280
281 if (!(df_copy = ast_calloc(1, sizeof(*df)))) {
282 return NULL;
283 }
284
285 memcpy(df_copy, df, sizeof(*df));
286
287 return df_copy;
288}

References ast_calloc, and NULL.

◆ load_module()

static int load_module ( void  )
static

Definition at line 1150 of file features.c.

1151{
1152 int res;
1153
1154 res = load_features_config();
1157
1159}
static char * app_bridge
Definition: features.c:822
static int action_bridge(struct mansession *s, const struct message *m)
Bridge channels together.
Definition: features.c:735
static int bridge_exec(struct ast_channel *chan, const char *data)
Bridge channels.
Definition: features.c:987
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:203
#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:104
@ 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 706 of file features.c.

707{
708 if (ast_strlen_zero(playtone_val) || ast_false(playtone_val)) {
709 return PLAYTONE_NONE;
710 } if (!strcasecmp(playtone_val, "channel1")) {
711 return PLAYTONE_CHANNEL1;
712 } else if (!strcasecmp(playtone_val, "channel2") || ast_true(playtone_val)) {
713 return PLAYTONE_CHANNEL2;
714 } else if (!strcasecmp(playtone_val, "both")) {
715 return PLAYTONE_BOTH;
716 } else {
717 /* Invalid input. Assume none */
718 return PLAYTONE_NONE;
719 }
720}
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:2252

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 506 of file features.c.

508{
509 int res;
510 SCOPE_TRACE(1, "%s Peer: %s\n", ast_channel_name(chan), ast_channel_name(peer));
511
513 add_features_datastores(chan, peer, config);
514
515 /*
516 * This is an interesting case. One example is if a ringing
517 * channel gets redirected to an extension that picks up a
518 * parked call. This will make sure that the call taken out of
519 * parking gets told that the channel it just got bridged to is
520 * still ringing.
521 */
525 }
526
528
529 /* Answer if need be */
530
531 res = 0;
532
533 if (noanswer) {
534 ast_debug(1, "Skipping answer on %s due to no answer directive\n", ast_channel_name(chan));
535 } else if (ast_channel_state(chan) != AST_STATE_UP) {
536 ast_debug(1, "Answering channel for bridge: %s\n", ast_channel_name(chan));
537 res = ast_raw_answer_with_stream_topology(chan, config->answer_topology);
538 if (res != 0) {
539 return -1;
540 }
541 }
542
543
544#ifdef FOR_DEBUG
545 /* show the two channels and cdrs involved in the bridge for debug & devel purposes */
546 ast_channel_log("Pre-bridge CHAN Channel info", chan);
547 ast_channel_log("Pre-bridge PEER Channel info", peer);
548#endif
549
550 res = 0;
551 ast_channel_lock(chan);
553 res |= ast_bridge_features_ds_append(chan, &config->features_caller);
554 ast_channel_unlock(chan);
555 ast_channel_lock(peer);
557 res |= ast_bridge_features_ds_append(peer, &config->features_callee);
558 ast_channel_unlock(peer);
559
560 if (res) {
561 return -1;
562 }
563
564 if (config->timelimit) {
565 struct ast_bridge_features_limits call_duration_limits_chan;
566 struct ast_bridge_features_limits call_duration_limits_peer;
567 int abandon_call = 0; /* TRUE if set limits fails so we can abandon the call. */
568
569 if (ast_bridge_features_limits_construct(&call_duration_limits_chan)) {
570 ast_log(LOG_ERROR, "Could not construct caller duration limits. Bridge canceled.\n");
571
572 return -1;
573 }
574
575 if (ast_bridge_features_limits_construct(&call_duration_limits_peer)) {
576 ast_log(LOG_ERROR, "Could not construct callee duration limits. Bridge canceled.\n");
577 ast_bridge_features_limits_destroy(&call_duration_limits_chan);
578
579 return -1;
580 }
581
582 bridge_config_set_limits(config, &call_duration_limits_chan, &call_duration_limits_peer);
583
584 if (ast_bridge_features_set_limits(chan_features, &call_duration_limits_chan, 0)) {
585 abandon_call = 1;
586 }
587 if (ast_bridge_features_set_limits(peer_features, &call_duration_limits_peer, 0)) {
588 abandon_call = 1;
589 }
590
591 /* At this point we are done with the limits structs since they have been copied to the individual feature sets. */
592 ast_bridge_features_limits_destroy(&call_duration_limits_chan);
593 ast_bridge_features_limits_destroy(&call_duration_limits_peer);
594
595 if (abandon_call) {
596 ast_log(LOG_ERROR, "Could not set duration limits on one or more sides of the call. Bridge canceled.\n");
597 return -1;
598 }
599 }
600
601 return 0;
602}
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:3491
int ast_bridge_features_limits_construct(struct ast_bridge_features_limits *limits)
Constructor function for ast_bridge_features_limits.
Definition: bridge.c:3475
void ast_bridge_features_limits_destroy(struct ast_bridge_features_limits *limits)
Destructor function for ast_bridge_features_limits.
Definition: bridge.c:3486
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:2609
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:4243
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:378
static void add_features_datastores(struct ast_channel *caller, struct ast_channel *callee, struct ast_bridge_config *config)
Definition: features.c:437
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:476
static void set_config_flags(struct ast_channel *chan, struct ast_bridge_config *config)
Definition: features.c:349
static void set_bridge_features_on_config(struct ast_bridge_config *config, const char *features)
Definition: features.c:397
@ 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 397 of file features.c.

398{
399 const char *feature;
400
401 if (ast_strlen_zero(features)) {
402 return;
403 }
404
405 for (feature = features; *feature; feature++) {
406 struct ast_flags *party;
407
408 if (isupper(*feature)) {
409 party = &config->features_caller;
410 } else {
411 party = &config->features_callee;
412 }
413
414 switch (tolower(*feature)) {
415 case 't' :
417 break;
418 case 'k' :
420 break;
421 case 'h' :
423 break;
424 case 'w' :
426 break;
427 case 'x' :
429 break;
430 default :
431 ast_log(LOG_WARNING, "Skipping unknown feature code '%c'\n", *feature);
432 break;
433 }
434 }
435}
@ 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 349 of file features.c.

350{
352
353 if (ast_test_flag(&config->features_caller, AST_FEATURE_DTMF_MASK)) {
355 }
356 if (ast_test_flag(&config->features_callee, AST_FEATURE_DTMF_MASK)) {
358 }
359
361 RAII_VAR(struct ao2_container *, applicationmap, NULL, ao2_cleanup);
362
363 ast_channel_lock(chan);
364 applicationmap = ast_get_chan_applicationmap(chan);
365 ast_channel_unlock(chan);
366
367 if (!applicationmap) {
368 return;
369 }
370
371 /* If an applicationmap exists for this channel at all, then the channel needs the DTMF flag set */
373 }
374}
#define AST_BRIDGE_DTMF_CHANNEL_0
Report DTMF on channel 0.
Definition: channel.h:2420
#define AST_BRIDGE_DTMF_CHANNEL_1
Report DTMF on channel 1.
Definition: channel.h:2422
#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 1139 of file features.c.

1140{
1142
1143 ast_manager_unregister("Bridge");
1144
1146
1147 return 0;
1148}
void unload_features_config(void)
int ast_manager_unregister(const char *action)
Unregister a registered manager command.
Definition: manager.c:7698
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 1168 of file features.c.

◆ app_bridge

char* app_bridge = "Bridge"
static

Definition at line 822 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 1168 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 864 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:277

Definition at line 290 of file features.c.

Referenced by add_features_datastore().