Mon Mar 31 07:38:18 2008

Asterisk developer's documentation


app_dial.c File Reference

dial() & retrydial() - Trivial application to dial a channel and send an URL on answer More...

#include "asterisk.h"
#include <stdlib.h>
#include <errno.h>
#include <unistd.h>
#include <string.h>
#include <stdio.h>
#include <sys/time.h>
#include <sys/signal.h>
#include <sys/stat.h>
#include <netinet/in.h>
#include "asterisk/lock.h"
#include "asterisk/file.h"
#include "asterisk/logger.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/options.h"
#include "asterisk/module.h"
#include "asterisk/translate.h"
#include "asterisk/say.h"
#include "asterisk/config.h"
#include "asterisk/features.h"
#include "asterisk/musiconhold.h"
#include "asterisk/callerid.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
#include "asterisk/causes.h"
#include "asterisk/rtp.h"
#include "asterisk/cdr.h"
#include "asterisk/manager.h"
#include "asterisk/privacy.h"
#include "asterisk/stringfields.h"
#include "asterisk/global_datastores.h"

Include dependency graph for app_dial.c:

Go to the source code of this file.

Data Structures

struct  dial_localuser

Defines

#define AST_MAX_WATCHERS   256
#define CAN_EARLY_BRIDGE(flags)
#define DIAL_NOFORWARDHTML   (1 << 31)
#define DIAL_STILLGOING   (1 << 30)
#define HANDLE_CAUSE(cause, chan)

Enumerations

enum  {
  OPT_ANNOUNCE = (1 << 0), OPT_RESETCDR = (1 << 1), OPT_DTMF_EXIT = (1 << 2), OPT_SENDDTMF = (1 << 3),
  OPT_FORCECLID = (1 << 4), OPT_GO_ON = (1 << 5), OPT_CALLEE_HANGUP = (1 << 6), OPT_CALLER_HANGUP = (1 << 7),
  OPT_PRIORITY_JUMP = (1 << 8), OPT_DURATION_LIMIT = (1 << 9), OPT_MUSICBACK = (1 << 10), OPT_CALLEE_MACRO = (1 << 11),
  OPT_SCREEN_NOINTRO = (1 << 12), OPT_SCREEN_NOCLID = (1 << 13), OPT_ORIGINAL_CLID = (1 << 14), OPT_SCREENING = (1 << 15),
  OPT_PRIVACY = (1 << 16), OPT_RINGBACK = (1 << 17), OPT_DURATION_STOP = (1 << 18), OPT_CALLEE_TRANSFER = (1 << 19),
  OPT_CALLER_TRANSFER = (1 << 20), OPT_CALLEE_MONITOR = (1 << 21), OPT_CALLER_MONITOR = (1 << 22), OPT_GOTO = (1 << 23),
  OPT_OPERMODE = (1 << 24), OPT_CALLEE_PARK = (1 << 25), OPT_CALLER_PARK = (1 << 26), OPT_IGNORE_FORWARDING = (1 << 27)
}
enum  {
  OPT_ARG_ANNOUNCE = 0, OPT_ARG_SENDDTMF, OPT_ARG_GOTO, OPT_ARG_DURATION_LIMIT,
  OPT_ARG_MUSICBACK, OPT_ARG_CALLEE_MACRO, OPT_ARG_PRIVACY, OPT_ARG_DURATION_STOP,
  OPT_ARG_OPERMODE, OPT_ARG_ARRAY_SIZE
}

Functions

 AST_APP_OPTIONS (dial_exec_options,{AST_APP_OPTION_ARG('A', OPT_ANNOUNCE, OPT_ARG_ANNOUNCE), AST_APP_OPTION('C', OPT_RESETCDR), AST_APP_OPTION('d', OPT_DTMF_EXIT), AST_APP_OPTION_ARG('D', OPT_SENDDTMF, OPT_ARG_SENDDTMF), AST_APP_OPTION('f', OPT_FORCECLID), AST_APP_OPTION('g', OPT_GO_ON), AST_APP_OPTION_ARG('G', OPT_GOTO, OPT_ARG_GOTO), AST_APP_OPTION('h', OPT_CALLEE_HANGUP), AST_APP_OPTION('H', OPT_CALLER_HANGUP), AST_APP_OPTION('i', OPT_IGNORE_FORWARDING), AST_APP_OPTION('j', OPT_PRIORITY_JUMP), AST_APP_OPTION('k', OPT_CALLEE_PARK), AST_APP_OPTION('K', OPT_CALLER_PARK), AST_APP_OPTION_ARG('L', OPT_DURATION_LIMIT, OPT_ARG_DURATION_LIMIT), AST_APP_OPTION_ARG('m', OPT_MUSICBACK, OPT_ARG_MUSICBACK), AST_APP_OPTION_ARG('M', OPT_CALLEE_MACRO, OPT_ARG_CALLEE_MACRO), AST_APP_OPTION('n', OPT_SCREEN_NOINTRO), AST_APP_OPTION('N', OPT_SCREEN_NOCLID), AST_APP_OPTION('o', OPT_ORIGINAL_CLID), AST_APP_OPTION_ARG('O', OPT_OPERMODE, OPT_ARG_OPERMODE), AST_APP_OPTION('p', OPT_SCREENING), AST_APP_OPTION_ARG('P', OPT_PRIVACY, OPT_ARG_PRIVACY), AST_APP_OPTION('r', OPT_RINGBACK), AST_APP_OPTION_ARG('S', OPT_DURATION_STOP, OPT_ARG_DURATION_STOP), AST_APP_OPTION('t', OPT_CALLEE_TRANSFER), AST_APP_OPTION('T', OPT_CALLER_TRANSFER), AST_APP_OPTION('w', OPT_CALLEE_MONITOR), AST_APP_OPTION('W', OPT_CALLER_MONITOR),})
 AST_MODULE_INFO_STANDARD (ASTERISK_GPL_KEY,"Dialing Application")
static int dial_exec (struct ast_channel *chan, void *data)
static const char * get_cid_name (char *name, int namelen, struct ast_channel *chan)
static void hanguptree (struct dial_localuser *outgoing, struct ast_channel *exception)
static int load_module (void)
static int onedigit_goto (struct ast_channel *chan, const char *context, char exten, int pri)
static void replace_macro_delimiter (char *s)
static int retrydial_exec (struct ast_channel *chan, void *data)
static void senddialevent (struct ast_channel *src, struct ast_channel *dst)
static int unload_module (void)
static int valid_priv_reply (struct ast_flags *opts, int res)
static struct ast_channelwait_for_answer (struct ast_channel *in, struct dial_localuser *outgoing, int *to, struct ast_flags *peerflags, int *sentringing, char *status, size_t statussize, int busystart, int nochanstart, int congestionstart, int priority_jump, int *result)

Variables

static char * app = "Dial"
static char * descrip
enum { ... }  dial_exec_option_args
enum { ... }  dial_exec_option_flags
static char * rapp = "RetryDial"
static char * rdescrip
static char * rsynopsis = "Place a call, retrying on failure allowing optional exit extension."
static char * synopsis = "Place a call and connect to the current channel"


Detailed Description

dial() & retrydial() - Trivial application to dial a channel and send an URL on answer

Author:
Mark Spencer <markster@digium.com>

Definition in file app_dial.c.


Define Documentation

#define AST_MAX_WATCHERS   256

Definition at line 330 of file app_dial.c.

#define CAN_EARLY_BRIDGE ( flags   ) 

Value:

Definition at line 301 of file app_dial.c.

Referenced by wait_for_answer().

#define DIAL_NOFORWARDHTML   (1 << 31)

Definition at line 254 of file app_dial.c.

Referenced by wait_for_answer().

#define DIAL_STILLGOING   (1 << 30)

Definition at line 253 of file app_dial.c.

Referenced by wait_for_answer().

#define HANDLE_CAUSE ( cause,
chan   ) 

Definition at line 332 of file app_dial.c.

Referenced by wait_for_answer().


Enumeration Type Documentation

anonymous enum

Enumerator:
OPT_ANNOUNCE 
OPT_RESETCDR 
OPT_DTMF_EXIT 
OPT_SENDDTMF 
OPT_FORCECLID 
OPT_GO_ON 
OPT_CALLEE_HANGUP 
OPT_CALLER_HANGUP 
OPT_PRIORITY_JUMP 
OPT_DURATION_LIMIT 
OPT_MUSICBACK 
OPT_CALLEE_MACRO 
OPT_SCREEN_NOINTRO 
OPT_SCREEN_NOCLID 
OPT_ORIGINAL_CLID 
OPT_SCREENING 
OPT_PRIVACY 
OPT_RINGBACK 
OPT_DURATION_STOP 
OPT_CALLEE_TRANSFER 
OPT_CALLER_TRANSFER 
OPT_CALLEE_MONITOR 
OPT_CALLER_MONITOR 
OPT_GOTO 
OPT_OPERMODE 
OPT_CALLEE_PARK 
OPT_CALLER_PARK 
OPT_IGNORE_FORWARDING 

Definition at line 222 of file app_dial.c.

00222      {
00223    OPT_ANNOUNCE =    (1 << 0),
00224    OPT_RESETCDR =    (1 << 1),
00225    OPT_DTMF_EXIT =      (1 << 2),
00226    OPT_SENDDTMF =    (1 << 3),
00227    OPT_FORCECLID =      (1 << 4),
00228    OPT_GO_ON =    (1 << 5),
00229    OPT_CALLEE_HANGUP =  (1 << 6),
00230    OPT_CALLER_HANGUP =  (1 << 7),
00231    OPT_PRIORITY_JUMP =  (1 << 8),
00232    OPT_DURATION_LIMIT = (1 << 9),
00233    OPT_MUSICBACK =      (1 << 10),
00234    OPT_CALLEE_MACRO =   (1 << 11),
00235    OPT_SCREEN_NOINTRO = (1 << 12),
00236    OPT_SCREEN_NOCLID =  (1 << 13),
00237    OPT_ORIGINAL_CLID =  (1 << 14),
00238    OPT_SCREENING =      (1 << 15),
00239    OPT_PRIVACY =     (1 << 16),
00240    OPT_RINGBACK =    (1 << 17),
00241    OPT_DURATION_STOP =  (1 << 18),
00242    OPT_CALLEE_TRANSFER =   (1 << 19),
00243    OPT_CALLER_TRANSFER =   (1 << 20),
00244    OPT_CALLEE_MONITOR = (1 << 21),
00245    OPT_CALLER_MONITOR = (1 << 22),
00246    OPT_GOTO =     (1 << 23),
00247    OPT_OPERMODE =       (1 << 24),
00248    OPT_CALLEE_PARK = (1 << 25),
00249    OPT_CALLER_PARK = (1 << 26),
00250    OPT_IGNORE_FORWARDING = (1 << 27),
00251 } dial_exec_option_flags;

anonymous enum

Enumerator:
OPT_ARG_ANNOUNCE 
OPT_ARG_SENDDTMF 
OPT_ARG_GOTO 
OPT_ARG_DURATION_LIMIT 
OPT_ARG_MUSICBACK 
OPT_ARG_CALLEE_MACRO 
OPT_ARG_PRIVACY 
OPT_ARG_DURATION_STOP 
OPT_ARG_OPERMODE 
OPT_ARG_ARRAY_SIZE 

Definition at line 256 of file app_dial.c.

00256      {
00257    OPT_ARG_ANNOUNCE = 0,
00258    OPT_ARG_SENDDTMF,
00259    OPT_ARG_GOTO,
00260    OPT_ARG_DURATION_LIMIT,
00261    OPT_ARG_MUSICBACK,
00262    OPT_ARG_CALLEE_MACRO,
00263    OPT_ARG_PRIVACY,
00264    OPT_ARG_DURATION_STOP,
00265    OPT_ARG_OPERMODE,
00266    /* note: this entry _MUST_ be the last one in the enum */
00267    OPT_ARG_ARRAY_SIZE,
00268 } dial_exec_option_args;


Function Documentation

AST_APP_OPTIONS ( dial_exec_options   ) 

AST_MODULE_INFO_STANDARD ( ASTERISK_GPL_KEY  ,
"Dialing Application"   
)

static int dial_exec ( struct ast_channel chan,
void *  data 
) [static]

Definition at line 1746 of file app_dial.c.

Referenced by load_module().

01747 {
01748    struct ast_flags peerflags;
01749 
01750    memset(&peerflags, 0, sizeof(peerflags));
01751 
01752    return dial_exec_full(chan, data, &peerflags, NULL);
01753 }

static const char* get_cid_name ( char *  name,
int  namelen,
struct ast_channel chan 
) [static]

Definition at line 377 of file app_dial.c.

References ast_get_hint(), dial_localuser::chan, ast_channel::context, context, ast_channel::exten, exten, ast_channel::macrocontext, ast_channel::macroexten, and S_OR.

Referenced by wait_for_answer().

00378 {
00379    const char *context = S_OR(chan->macrocontext, chan->context);
00380    const char *exten = S_OR(chan->macroexten, chan->exten);
00381 
00382    return ast_get_hint(NULL, 0, name, namelen, chan, context, exten) ? name : "";
00383 }

static void hanguptree ( struct dial_localuser outgoing,
struct ast_channel exception 
) [static]

Definition at line 316 of file app_dial.c.

References ast_hangup(), dial_localuser::chan, free, and dial_localuser::next.

00317 {
00318    /* Hang up a tree of stuff */
00319    struct dial_localuser *oo;
00320    while (outgoing) {
00321       /* Hangup any existing lines we have open */
00322       if (outgoing->chan && (outgoing->chan != exception))
00323          ast_hangup(outgoing->chan);
00324       oo = outgoing;
00325       outgoing=outgoing->next;
00326       free(oo);
00327    }
00328 }

static int load_module ( void   )  [static]

Definition at line 1883 of file app_dial.c.

References ast_register_application(), dial_exec(), and retrydial_exec().

01884 {
01885    int res;
01886 
01887    res = ast_register_application(app, dial_exec, synopsis, descrip);
01888    res |= ast_register_application(rapp, retrydial_exec, rsynopsis, rdescrip);
01889    
01890    return res;
01891 }

static int onedigit_goto ( struct ast_channel chan,
const char *  context,
char  exten,
int  pri 
) [static]

Definition at line 358 of file app_dial.c.

References ast_goto_if_exists(), ast_strlen_zero(), dial_localuser::chan, ast_channel::context, and ast_channel::macrocontext.

Referenced by retrydial_exec(), and wait_for_answer().

00359 {
00360    char rexten[2] = { exten, '\0' };
00361 
00362    if (context) {
00363       if (!ast_goto_if_exists(chan, context, rexten, pri))
00364          return 1;
00365    } else {
00366       if (!ast_goto_if_exists(chan, chan->context, rexten, pri))
00367          return 1;
00368       else if (!ast_strlen_zero(chan->macrocontext)) {
00369          if (!ast_goto_if_exists(chan, chan->macrocontext, rexten, pri))
00370             return 1;
00371       }
00372    }
00373    return 0;
00374 }

static void replace_macro_delimiter ( char *  s  )  [static]

Definition at line 772 of file app_dial.c.

00773 {
00774    for (; *s; s++)
00775       if (*s == '^')
00776          *s = '|';
00777 }

static int retrydial_exec ( struct ast_channel chan,
void *  data 
) [static]

Definition at line 1755 of file app_dial.c.

References AST_DIGIT_ANY, ast_fileexists(), AST_FLAG_MOH, ast_log(), ast_module_user_add, ast_module_user_remove, ast_moh_start(), ast_moh_stop(), ast_strdupa, ast_streamfile(), ast_strlen_zero(), ast_test_flag, ast_waitfordigit(), ast_waitstream(), context, ast_channel::data, LOG_ERROR, LOG_WARNING, onedigit_goto(), OPT_DTMF_EXIT, and pbx_builtin_getvar_helper().

Referenced by load_module().

01756 {
01757    char *announce = NULL, *dialdata = NULL;
01758    const char *context = NULL;
01759    int sleep = 0, loops = 0, res = -1;
01760    struct ast_module_user *u;
01761    struct ast_flags peerflags;
01762    
01763    if (ast_strlen_zero(data)) {
01764       ast_log(LOG_WARNING, "RetryDial requires an argument!\n");
01765       return -1;
01766    }  
01767 
01768    u = ast_module_user_add(chan);
01769 
01770    announce = ast_strdupa(data);
01771 
01772    memset(&peerflags, 0, sizeof(peerflags));
01773 
01774    if ((dialdata = strchr(announce, '|'))) {
01775       *dialdata++ = '\0';
01776       if (sscanf(dialdata, "%d", &sleep) == 1) {
01777          sleep *= 1000;
01778       } else {
01779          ast_log(LOG_ERROR, "%s requires the numerical argument <sleep>\n",rapp);
01780          goto done;
01781       }
01782       if ((dialdata = strchr(dialdata, '|'))) {
01783          *dialdata++ = '\0';
01784          if (sscanf(dialdata, "%d", &loops) != 1) {
01785             ast_log(LOG_ERROR, "%s requires the numerical argument <loops>\n",rapp);
01786             goto done;
01787          }
01788       }
01789    }
01790    
01791    if ((dialdata = strchr(dialdata, '|'))) {
01792       *dialdata++ = '\0';
01793    } else {
01794       ast_log(LOG_ERROR, "%s requires more arguments\n",rapp);
01795       goto done;
01796    }
01797       
01798    if (sleep < 1000)
01799       sleep = 10000;
01800 
01801    if (!loops)
01802       loops = -1; /* run forever */
01803    
01804    context = pbx_builtin_getvar_helper(chan, "EXITCONTEXT");
01805 
01806    res = 0;
01807    while (loops) {
01808       int continue_exec;
01809 
01810       chan->data = "Retrying";
01811       if (ast_test_flag(chan, AST_FLAG_MOH))
01812          ast_moh_stop(chan);
01813 
01814       res = dial_exec_full(chan, dialdata, &peerflags, &continue_exec);
01815       if (continue_exec)
01816          break;
01817 
01818       if (res == 0) {
01819          if (ast_test_flag(&peerflags, OPT_DTMF_EXIT)) {
01820             if (!ast_strlen_zero(announce)) {
01821                if (ast_fileexists(announce, NULL, chan->language) > 0) {
01822                   if(!(res = ast_streamfile(chan, announce, chan->language)))                      
01823                      ast_waitstream(chan, AST_DIGIT_ANY);
01824                } else
01825                   ast_log(LOG_WARNING, "Announce file \"%s\" specified in Retrydial does not exist\n", announce);
01826             }
01827             if (!res && sleep) {
01828                if (!ast_test_flag(chan, AST_FLAG_MOH))
01829                   ast_moh_start(chan, NULL, NULL);
01830                res = ast_waitfordigit(chan, sleep);
01831             }
01832          } else {
01833             if (!ast_strlen_zero(announce)) {
01834                if (ast_fileexists(announce, NULL, chan->language) > 0) {
01835                   if (!(res = ast_streamfile(chan, announce, chan->language)))
01836                      res = ast_waitstream(chan, "");
01837                } else
01838                   ast_log(LOG_WARNING, "Announce file \"%s\" specified in Retrydial does not exist\n", announce);
01839             }
01840             if (sleep) {
01841                if (!ast_test_flag(chan, AST_FLAG_MOH))
01842                   ast_moh_start(chan, NULL, NULL);
01843                if (!res)
01844                   res = ast_waitfordigit(chan, sleep);
01845             }
01846          }
01847       }
01848 
01849       if (res < 0)
01850          break;
01851       else if (res > 0) { /* Trying to send the call elsewhere (1 digit ext) */
01852          if (onedigit_goto(chan, context, (char) res, 1)) {
01853             res = 0;
01854             break;
01855          }
01856       }
01857       loops--;
01858    }
01859    if (loops == 0)
01860       res = 0;
01861    else if (res == 1)
01862       res = 0;
01863 
01864    if (ast_test_flag(chan, AST_FLAG_MOH))
01865       ast_moh_stop(chan);
01866  done:
01867    ast_module_user_remove(u);
01868    return res;
01869 }

static void senddialevent ( struct ast_channel src,
struct ast_channel dst 
) [static]

Definition at line 385 of file app_dial.c.

References ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, EVENT_FLAG_CALL, manager_event(), and S_OR.

Referenced by wait_for_answer().

00386 {
00387    /* XXX do we need also CallerIDnum ? */
00388    manager_event(EVENT_FLAG_CALL, "Dial", 
00389             "Source: %s\r\n"
00390             "Destination: %s\r\n"
00391             "CallerID: %s\r\n"
00392             "CallerIDName: %s\r\n"
00393             "SrcUniqueID: %s\r\n"
00394             "DestUniqueID: %s\r\n",
00395             src->name, dst->name, S_OR(src->cid.cid_num, "<unknown>"),
00396             S_OR(src->cid.cid_name, "<unknown>"), src->uniqueid,
00397             dst->uniqueid);
00398 }

static int unload_module ( void   )  [static]

Definition at line 1871 of file app_dial.c.

References ast_module_user_hangup_all, and ast_unregister_application().

01872 {
01873    int res;
01874 
01875    res = ast_unregister_application(app);
01876    res |= ast_unregister_application(rapp);
01877 
01878    ast_module_user_hangup_all();
01879    
01880    return res;
01881 }

static int valid_priv_reply ( struct ast_flags opts,
int  res 
) [static]

Definition at line 781 of file app_dial.c.

References ast_test_flag, OPT_PRIVACY, and OPT_SCREENING.

00782 {
00783    if (res < '1')
00784       return 0;
00785    if (ast_test_flag(opts, OPT_PRIVACY) && res <= '5')
00786       return 1;
00787    if (ast_test_flag(opts, OPT_SCREENING) && res <= '4')
00788       return 1;
00789    return 0;
00790 }

static struct ast_channel* wait_for_answer ( struct ast_channel in,
struct dial_localuser outgoing,
int *  to,
struct ast_flags peerflags,
int *  sentringing,
char *  status,
size_t  statussize,
int  busystart,
int  nochanstart,
int  congestionstart,
int  priority_jump,
int *  result 
) [static]

Definition at line 400 of file app_dial.c.

References ast_channel::_state, accountcode, ast_call(), AST_CAUSE_BUSY, AST_CAUSE_CONGESTION, AST_CAUSE_NORMAL_CLEARING, ast_cdr_noanswer(), ast_channel_datastore_inherit(), ast_channel_inherit_variables(), ast_channel_make_compatible(), ast_channel_sendhtml(), ast_check_hangup(), ast_clear_flag, AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_OFFHOOK, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_RINGING, AST_CONTROL_SRCUPDATE, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, ast_copy_flags, ast_deactivate_generator(), AST_FRAME_CONTROL, AST_FRAME_DTMF, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_HTML, AST_FRAME_IMAGE, AST_FRAME_TEXT, AST_FRAME_VOICE, ast_frfree, ast_goto_if_exists(), ast_hangup(), ast_indicate(), ast_indicate_data(), ast_log(), AST_MAX_EXTENSION, AST_MAX_WATCHERS, ast_opt_priority_jumping, ast_read(), ast_request(), ast_rtp_early_bridge(), ast_rtp_make_compatible(), ast_set_callerid(), AST_STATE_UP, ast_strdup, ast_string_field_set, ast_strlen_zero(), ast_test_flag, ast_verbose(), ast_waitfor_n(), ast_write(), CAN_EARLY_BRIDGE, ast_channel::cdr, ast_channel::cdrflags, dial_localuser::chan, ast_channel::cid, ast_callerid::cid_ani, ast_callerid::cid_name, ast_callerid::cid_num, context, ast_channel::context, DIAL_NOFORWARDHTML, DIAL_STILLGOING, ast_channel::dialcontext, ast_channel::exten, f, free, get_cid_name(), HANDLE_CAUSE, ast_channel::hangupcause, LOG_DEBUG, LOG_NOTICE, LOG_WARNING, ast_channel::macroexten, ast_channel::nativeformats, dial_localuser::next, onedigit_goto(), OPT_CALLEE_HANGUP, OPT_CALLEE_MONITOR, OPT_CALLEE_PARK, OPT_CALLEE_TRANSFER, OPT_CALLER_HANGUP, OPT_CALLER_MONITOR, OPT_CALLER_PARK, OPT_CALLER_TRANSFER, OPT_DTMF_EXIT, OPT_FORCECLID, OPT_IGNORE_FORWARDING, OPT_MUSICBACK, OPT_ORIGINAL_CLID, OPT_RINGBACK, option_debug, option_verbose, pbx_builtin_getvar_helper(), S_OR, senddialevent(), ast_channel::tech, VERBOSE_PREFIX_2, and VERBOSE_PREFIX_3.

Referenced by try_calling().

00401 {
00402    int numbusy = busystart;
00403    int numcongestion = congestionstart;
00404    int numnochan = nochanstart;
00405    int prestart = busystart + congestionstart + nochanstart;
00406    int orig = *to;
00407    struct ast_channel *peer = NULL;
00408    /* single is set if only one destination is enabled */
00409    int single = outgoing && !outgoing->next && !ast_test_flag(outgoing, OPT_MUSICBACK | OPT_RINGBACK);
00410    
00411    if (single) {
00412       /* Turn off hold music, etc */
00413       ast_deactivate_generator(in);
00414       /* If we are calling a single channel, make them compatible for in-band tone purpose */
00415       ast_channel_make_compatible(outgoing->chan, in);
00416    }
00417    
00418    
00419    while (*to && !peer) {
00420       struct dial_localuser *o;
00421       int pos = 0;   /* how many channels do we handle */
00422       int numlines = prestart;
00423       struct ast_channel *winner;
00424       struct ast_channel *watchers[AST_MAX_WATCHERS];
00425 
00426       watchers[pos++] = in;
00427       for (o = outgoing; o; o = o->next) {
00428          /* Keep track of important channels */
00429          if (ast_test_flag(o, DIAL_STILLGOING) && o->chan)
00430             watchers[pos++] = o->chan;
00431          numlines++;
00432       }
00433       if (pos == 1) {   /* only the input channel is available */
00434          if (numlines == (numbusy + numcongestion + numnochan)) {
00435             if (option_verbose > 2)
00436                ast_verbose( VERBOSE_PREFIX_2 "Everyone is busy/congested at this time (%d:%d/%d/%d)\n", numlines, numbusy, numcongestion, numnochan);
00437             if (numbusy)
00438                strcpy(status, "BUSY"); 
00439             else if (numcongestion)
00440                strcpy(status, "CONGESTION");
00441             else if (numnochan)
00442                strcpy(status, "CHANUNAVAIL");
00443             if (ast_opt_priority_jumping || priority_jump)
00444                ast_goto_if_exists(in, in->context, in->exten, in->priority + 101);
00445          } else {
00446             if (option_verbose > 2)
00447                ast_verbose(VERBOSE_PREFIX_3 "No one is available to answer at this time (%d:%d/%d/%d)\n", numlines, numbusy, numcongestion, numnochan);
00448          }
00449          *to = 0;
00450          return NULL;
00451       }
00452       winner = ast_waitfor_n(watchers, pos, to);
00453       for (o = outgoing; o; o = o->next) {
00454          struct ast_frame *f;
00455          struct ast_channel *c = o->chan;
00456 
00457          if (c == NULL)
00458             continue;
00459          if (ast_test_flag(o, DIAL_STILLGOING) && c->_state == AST_STATE_UP) {
00460             if (!peer) {
00461                if (option_verbose > 2)
00462                   ast_verbose(VERBOSE_PREFIX_3 "%s answered %s\n", c->name, in->name);
00463                peer = c;
00464                ast_copy_flags(peerflags, o,
00465                          OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
00466                          OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
00467                          OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
00468                          OPT_CALLEE_PARK | OPT_CALLER_PARK |
00469                          DIAL_NOFORWARDHTML);
00470                ast_copy_string(c->dialcontext, "", sizeof(c->dialcontext));
00471                ast_copy_string(c->exten, "", sizeof(c->exten));
00472             }
00473             continue;
00474          }
00475          if (c != winner)
00476             continue;
00477          if (!ast_strlen_zero(c->call_forward)) {
00478             char tmpchan[256];
00479             char *stuff;
00480             char *tech;
00481             int cause;
00482 
00483             ast_copy_string(tmpchan, c->call_forward, sizeof(tmpchan));
00484             if ((stuff = strchr(tmpchan, '/'))) {
00485                *stuff++ = '\0';
00486                tech = tmpchan;
00487             } else {
00488                const char *forward_context = pbx_builtin_getvar_helper(c, "FORWARD_CONTEXT");
00489                snprintf(tmpchan, sizeof(tmpchan), "%s@%s", c->call_forward, forward_context ? forward_context : c->context);
00490                stuff = tmpchan;
00491                tech = "Local";
00492             }
00493             /* Before processing channel, go ahead and check for forwarding */
00494             if (option_verbose > 2)
00495                ast_verbose(VERBOSE_PREFIX_3 "Now forwarding %s to '%s/%s' (thanks to %s)\n", in->name, tech, stuff, c->name);
00496             /* If we have been told to ignore forwards, just set this channel to null and continue processing extensions normally */
00497             if (ast_test_flag(peerflags, OPT_IGNORE_FORWARDING)) {
00498                if (option_verbose > 2)
00499                   ast_verbose(VERBOSE_PREFIX_3 "Forwarding %s to '%s/%s' prevented.\n", in->name, tech, stuff);
00500                c = o->chan = NULL;
00501                cause = AST_CAUSE_BUSY;
00502             } else {
00503                /* Setup parameters */
00504                if ((c = o->chan = ast_request(tech, in->nativeformats, stuff, &cause))) {
00505                   if (single)
00506                      ast_channel_make_compatible(o->chan, in);
00507                   ast_channel_inherit_variables(in, o->chan);
00508                   ast_channel_datastore_inherit(in, o->chan);
00509                } else
00510                   ast_log(LOG_NOTICE, "Unable to create local channel for call forward to '%s/%s' (cause = %d)\n", tech, stuff, cause);
00511             }
00512             if (!c) {
00513                ast_clear_flag(o, DIAL_STILLGOING); 
00514                HANDLE_CAUSE(cause, in);
00515             } else {
00516                ast_rtp_make_compatible(c, in, single);
00517                if (c->cid.cid_num)
00518                   free(c->cid.cid_num);
00519                c->cid.cid_num = NULL;
00520                if (c->cid.cid_name)
00521                   free(c->cid.cid_name);
00522                c->cid.cid_name = NULL;
00523 
00524                if (ast_test_flag(o, OPT_FORCECLID)) {
00525                   c->cid.cid_num = ast_strdup(S_OR(in->macroexten, in->exten));
00526                   ast_string_field_set(c, accountcode, winner->accountcode);
00527                   c->cdrflags = winner->cdrflags;
00528                } else {
00529                   c->cid.cid_num = ast_strdup(in->cid.cid_num);
00530                   c->cid.cid_name = ast_strdup(in->cid.cid_name);
00531                   ast_string_field_set(c, accountcode, in->accountcode);
00532                   c->cdrflags = in->cdrflags;
00533                }
00534 
00535                if (in->cid.cid_ani) {
00536                   if (c->cid.cid_ani)
00537                      free(c->cid.cid_ani);
00538                   c->cid.cid_ani = ast_strdup(in->cid.cid_ani);
00539                }
00540                if (c->cid.cid_rdnis) 
00541                   free(c->cid.cid_rdnis);
00542                c->cid.cid_rdnis = ast_strdup(S_OR(in->macroexten, in->exten));
00543                if (ast_call(c, tmpchan, 0)) {
00544                   ast_log(LOG_NOTICE, "Failed to dial on local channel for call forward to '%s'\n", tmpchan);
00545                   ast_clear_flag(o, DIAL_STILLGOING); 
00546                   ast_hangup(c);
00547                   c = o->chan = NULL;
00548                   numnochan++;
00549                } else {
00550                   senddialevent(in, c);
00551                   /* After calling, set callerid to extension */
00552                   if (!ast_test_flag(peerflags, OPT_ORIGINAL_CLID)) {
00553                      char cidname[AST_MAX_EXTENSION] = "";
00554                      ast_set_callerid(c, S_OR(in->macroexten, in->exten), get_cid_name(cidname, sizeof(cidname), in), NULL);
00555                   }
00556                }
00557             }
00558             /* Hangup the original channel now, in case we needed it */
00559             ast_hangup(winner);
00560             continue;
00561          }
00562          f = ast_read(winner);
00563          if (!f) {
00564             in->hangupcause = c->hangupcause;
00565             ast_hangup(c);
00566             c = o->chan = NULL;
00567             ast_clear_flag(o, DIAL_STILLGOING);
00568             HANDLE_CAUSE(in->hangupcause, in);
00569             continue;
00570          }
00571          if (f->frametype == AST_FRAME_CONTROL) {
00572             switch(f->subclass) {
00573             case AST_CONTROL_ANSWER:
00574                /* This is our guy if someone answered. */
00575                if (!peer) {
00576                   if (option_verbose > 2)
00577                      ast_verbose( VERBOSE_PREFIX_3 "%s answered %s\n", c->name, in->name);
00578                   peer = c;
00579                   ast_copy_flags(peerflags, o,
00580                             OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
00581                             OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
00582                             OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
00583                             OPT_CALLEE_PARK | OPT_CALLER_PARK |
00584                             DIAL_NOFORWARDHTML);
00585                   ast_copy_string(c->dialcontext, "", sizeof(c->dialcontext));
00586                   ast_copy_string(c->exten, "", sizeof(c->exten));
00587                   /* Setup RTP early bridge if appropriate */
00588                   if (CAN_EARLY_BRIDGE(peerflags))
00589                      ast_rtp_early_bridge(in, peer);
00590                }
00591                /* If call has been answered, then the eventual hangup is likely to be normal hangup */
00592                in->hangupcause = AST_CAUSE_NORMAL_CLEARING;
00593                c->hangupcause = AST_CAUSE_NORMAL_CLEARING;
00594                break;
00595             case AST_CONTROL_BUSY:
00596                if (option_verbose > 2)
00597                   ast_verbose(VERBOSE_PREFIX_3 "%s is busy\n", c->name);
00598                in->hangupcause = c->hangupcause;
00599                ast_hangup(c);
00600                c = o->chan = NULL;
00601                ast_clear_flag(o, DIAL_STILLGOING); 
00602                HANDLE_CAUSE(AST_CAUSE_BUSY, in);
00603                break;
00604             case AST_CONTROL_CONGESTION:
00605                if (option_verbose > 2)
00606                   ast_verbose(VERBOSE_PREFIX_3 "%s is circuit-busy\n", c->name);
00607                in->hangupcause = c->hangupcause;
00608                ast_hangup(c);
00609                c = o->chan = NULL;
00610                ast_clear_flag(o, DIAL_STILLGOING);
00611                HANDLE_CAUSE(AST_CAUSE_CONGESTION, in);
00612                break;
00613             case AST_CONTROL_RINGING:
00614                if (option_verbose > 2)
00615                   ast_verbose(VERBOSE_PREFIX_3 "%s is ringing\n", c->name);
00616                /* Setup early media if appropriate */
00617                if (single && CAN_EARLY_BRIDGE(peerflags))
00618                   ast_rtp_early_bridge(in, c);
00619                if (!(*sentringing) && !ast_test_flag(outgoing, OPT_MUSICBACK)) {
00620                   ast_indicate(in, AST_CONTROL_RINGING);
00621                   (*sentringing)++;
00622                }
00623                break;
00624             case AST_CONTROL_PROGRESS:
00625                if (option_verbose > 2)
00626                   ast_verbose (VERBOSE_PREFIX_3 "%s is making progress passing it to %s\n", c->name, in->name);
00627                /* Setup early media if appropriate */
00628                if (single && CAN_EARLY_BRIDGE(peerflags))
00629                   ast_rtp_early_bridge(in, c);
00630                if (!ast_test_flag(outgoing, OPT_RINGBACK))
00631                   ast_indicate(in, AST_CONTROL_PROGRESS);
00632                break;
00633             case AST_CONTROL_VIDUPDATE:
00634                if (option_verbose > 2)
00635                   ast_verbose (VERBOSE_PREFIX_3 "%s requested a video update, passing it to %s\n", c->name, in->name);
00636                ast_indicate(in, AST_CONTROL_VIDUPDATE);
00637                break;
00638             case AST_CONTROL_SRCUPDATE:
00639                if (option_verbose > 2)
00640                   ast_verbose (VERBOSE_PREFIX_3 "%s requested a source update, passing it to %s\n", c->name, in->name);
00641                ast_indicate(in, AST_CONTROL_SRCUPDATE);
00642                break;
00643             case AST_CONTROL_PROCEEDING:
00644                if (option_verbose > 2)
00645                   ast_verbose (VERBOSE_PREFIX_3 "%s is proceeding passing it to %s\n", c->name, in->name);
00646                if (single && CAN_EARLY_BRIDGE(peerflags))
00647                   ast_rtp_early_bridge(in, c);
00648                if (!ast_test_flag(outgoing, OPT_RINGBACK))
00649                   ast_indicate(in, AST_CONTROL_PROCEEDING);
00650                break;
00651             case AST_CONTROL_HOLD:
00652                if (option_verbose > 2)
00653                   ast_verbose(VERBOSE_PREFIX_3 "Call on %s placed on hold\n", c->name);
00654                ast_indicate(in, AST_CONTROL_HOLD);
00655                break;
00656             case AST_CONTROL_UNHOLD:
00657                if (option_verbose > 2)
00658                   ast_verbose(VERBOSE_PREFIX_3 "Call on %s left from hold\n", c->name);
00659                ast_indicate(in, AST_CONTROL_UNHOLD);
00660                break;
00661             case AST_CONTROL_OFFHOOK:
00662             case AST_CONTROL_FLASH:
00663                /* Ignore going off hook and flash */
00664                break;
00665             case -1:
00666                if (!ast_test_flag(outgoing, OPT_RINGBACK | OPT_MUSICBACK)) {
00667                   if (option_verbose > 2)
00668                      ast_verbose(VERBOSE_PREFIX_3 "%s stopped sounds\n", c->name);
00669                   ast_indicate(in, -1);
00670                   (*sentringing) = 0;
00671                }
00672                break;
00673             default:
00674                if (option_debug)
00675                   ast_log(LOG_DEBUG, "Dunno what to do with control type %d\n", f->subclass);
00676             }
00677          } else if (single) {
00678             /* XXX are we sure the logic is correct ? or we should just switch on f->frametype ? */
00679             if (f->frametype == AST_FRAME_VOICE && !ast_test_flag(outgoing, OPT_RINGBACK|OPT_MUSICBACK)) {
00680                if (ast_write(in, f)) 
00681                   ast_log(LOG_WARNING, "Unable to forward voice frame\n");
00682             } else if (f->frametype == AST_FRAME_IMAGE && !ast_test_flag(outgoing, OPT_RINGBACK|OPT_MUSICBACK)) {
00683                if (ast_write(in, f))
00684                   ast_log(LOG_WARNING, "Unable to forward image\n");
00685             } else if (f->frametype == AST_FRAME_TEXT && !ast_test_flag(outgoing, OPT_RINGBACK|OPT_MUSICBACK)) {
00686                if (ast_write(in, f))
00687                   ast_log(LOG_WARNING, "Unable to send text\n");
00688             } else if (f->frametype == AST_FRAME_HTML && !ast_test_flag(outgoing, DIAL_NOFORWARDHTML)) {
00689                if (ast_channel_sendhtml(in, f->subclass, f->data, f->datalen) == -1)
00690                   ast_log(LOG_WARNING, "Unable to send URL\n");
00691             }
00692          }
00693          ast_frfree(f);
00694       } /* end for */
00695       if (winner == in) {
00696          struct ast_frame *f = ast_read(in);
00697 #if 0
00698          if (f && (f->frametype != AST_FRAME_VOICE))
00699             printf("Frame type: %d, %d\n", f->frametype, f->subclass);
00700          else if (!f || (f->frametype != AST_FRAME_VOICE))
00701             printf("Hangup received on %s\n", in->name);
00702 #endif
00703          if (!f || ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_HANGUP))) {
00704             /* Got hung up */
00705             *to = -1;
00706             ast_cdr_noanswer(in->cdr);
00707             strcpy(status, "CANCEL");
00708             if (f)
00709                ast_frfree(f);
00710             return NULL;
00711          }
00712 
00713          if (f && (f->frametype == AST_FRAME_DTMF)) {
00714             if (ast_test_flag(peerflags, OPT_DTMF_EXIT)) {
00715                const char *context = pbx_builtin_getvar_helper(in, "EXITCONTEXT");
00716                if (onedigit_goto(in, context, (char) f->subclass, 1)) {
00717                   if (option_verbose > 2)
00718                      ast_verbose(VERBOSE_PREFIX_3 "User hit %c to disconnect call.\n", f->subclass);
00719                   *to=0;
00720                   ast_cdr_noanswer(in->cdr);
00721                   *result = f->subclass;
00722                   strcpy(status, "CANCEL");
00723                   ast_frfree(f);
00724                   return NULL;
00725                }
00726             }
00727 
00728             if (ast_test_flag(peerflags, OPT_CALLER_HANGUP) && 
00729                     (f->subclass == '*')) { /* hmm it it not guaranteed to be '*' anymore. */
00730                if (option_verbose > 2)
00731                   ast_verbose(VERBOSE_PREFIX_3 "User hit %c to disconnect call.\n", f->subclass);
00732                *to=0;
00733                ast_cdr_noanswer(in->cdr);
00734                strcpy(status, "CANCEL");
00735                ast_frfree(f);
00736                return NULL;
00737             }
00738          }
00739 
00740          /* Forward HTML stuff */
00741          if (single && f && (f->frametype == AST_FRAME_HTML) && !ast_test_flag(outgoing, DIAL_NOFORWARDHTML)) 
00742             if(ast_channel_sendhtml(outgoing->chan, f->subclass, f->data, f->datalen) == -1)
00743                ast_log(LOG_WARNING, "Unable to send URL\n");
00744          
00745 
00746          if (single && ((f->frametype == AST_FRAME_VOICE) || (f->frametype == AST_FRAME_DTMF_BEGIN) || (f->frametype == AST_FRAME_DTMF_END)))  {
00747             if (ast_write(outgoing->chan, f))
00748                ast_log(LOG_WARNING, "Unable to forward voice or dtmf\n");
00749          }
00750          if (single && (f->frametype == AST_FRAME_CONTROL) && 
00751             ((f->subclass == AST_CONTROL_HOLD) || 
00752              (f->subclass == AST_CONTROL_UNHOLD) || 
00753              (f->subclass == AST_CONTROL_VIDUPDATE) ||
00754              (f->subclass == AST_CONTROL_SRCUPDATE))) {
00755             if (option_verbose > 2)
00756                ast_verbose(VERBOSE_PREFIX_3 "%s requested special control %d, passing it to %s\n", in->name, f->subclass, outgoing->chan->name);
00757             ast_indicate_data(outgoing->chan, f->subclass, f->data, f->datalen);
00758          }
00759          ast_frfree(f);
00760       }
00761       if (!*to && (option_verbose > 2))
00762          ast_verbose(VERBOSE_PREFIX_3 "Nobody picked up in %d ms\n", orig);
00763       if (!*to || ast_check_hangup(in)) {
00764          ast_cdr_noanswer(in->cdr);
00765       }
00766       
00767    }
00768    
00769    return peer;
00770 }


Variable Documentation

char* app = "Dial" [static]

Definition at line 71 of file app_dial.c.

char* descrip [static]

Definition at line 75 of file app_dial.c.

enum { ... } dial_exec_option_args

enum { ... } dial_exec_option_flags

char* rapp = "RetryDial" [static]

Definition at line 207 of file app_dial.c.

char* rdescrip [static]

Definition at line 209 of file app_dial.c.

char* rsynopsis = "Place a call, retrying on failure allowing optional exit extension." [static]

Definition at line 208 of file app_dial.c.

char* synopsis = "Place a call and connect to the current channel" [static]

Definition at line 73 of file app_dial.c.


Generated on Mon Mar 31 07:38:19 2008 for Asterisk - the Open Source PBX by  doxygen 1.5.1