Wed Oct 28 11:51:03 2009

Asterisk developer's documentation


dial.c

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2007, Digium, Inc.
00005  *
00006  * Joshua Colp <jcolp@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  *
00021  * \brief Dialing API
00022  *
00023  * \author Joshua Colp <jcolp@digium.com>
00024  */
00025 
00026 #include "asterisk.h"
00027 
00028 ASTERISK_FILE_VERSION(__FILE__, "$Revision: 153225 $")
00029 
00030 #include <sys/time.h>
00031 #include <signal.h>
00032 
00033 #include "asterisk/channel.h"
00034 #include "asterisk/utils.h"
00035 #include "asterisk/lock.h"
00036 #include "asterisk/linkedlists.h"
00037 #include "asterisk/dial.h"
00038 #include "asterisk/pbx.h"
00039 #include "asterisk/musiconhold.h"
00040 
00041 /*! \brief Main dialing structure. Contains global options, channels being dialed, and more! */
00042 struct ast_dial {
00043    int num;                                           /*!< Current number to give to next dialed channel */
00044    int timeout;                                       /*!< Maximum time allowed for dial attempts */
00045    int actual_timeout;                                /*!< Actual timeout based on all factors (ie: channels) */
00046    enum ast_dial_result state;                        /*!< Status of dial */
00047    void *options[AST_DIAL_OPTION_MAX];                /*!< Global options */
00048    ast_dial_state_callback state_callback;            /*!< Status callback */
00049    AST_LIST_HEAD(, ast_dial_channel) channels; /*!< Channels being dialed */
00050    pthread_t thread;                                  /*!< Thread (if running in async) */
00051    ast_mutex_t lock;                                  /*! Lock to protect the thread information above */
00052 };
00053 
00054 /*! \brief Dialing channel structure. Contains per-channel dialing options, asterisk channel, and more! */
00055 struct ast_dial_channel {
00056    int num;                               /*!< Unique number for dialed channel */
00057    int timeout;                           /*!< Maximum time allowed for attempt */
00058    char *tech;                            /*!< Technology being dialed */
00059    char *device;                          /*!< Device being dialed */
00060    void *options[AST_DIAL_OPTION_MAX];    /*!< Channel specific options */
00061    int cause;                             /*!< Cause code in case of failure */
00062    int is_running_app:1;                  /*!< Is this running an application? */
00063    struct ast_channel *owner;             /*!< Asterisk channel */
00064    AST_LIST_ENTRY(ast_dial_channel) list; /*!< Linked list information */
00065 };
00066 
00067 /*! \brief Typedef for dial option enable */
00068 typedef void *(*ast_dial_option_cb_enable)(void *data);
00069 
00070 /*! \brief Typedef for dial option disable */
00071 typedef int (*ast_dial_option_cb_disable)(void *data);
00072 
00073 /*! \brief Structure for 'ANSWER_EXEC' option */
00074 struct answer_exec_struct {
00075    char app[AST_MAX_APP]; /*!< Application name */
00076    char *args;            /*!< Application arguments */
00077 };
00078 
00079 /*! \brief Enable function for 'ANSWER_EXEC' option */
00080 static void *answer_exec_enable(void *data)
00081 {
00082    struct answer_exec_struct *answer_exec = NULL;
00083    char *app = ast_strdupa((char*)data), *args = NULL;
00084 
00085    /* Not giving any data to this option is bad, mmmk? */
00086    if (ast_strlen_zero(app))
00087       return NULL;
00088 
00089    /* Create new data structure */
00090    if (!(answer_exec = ast_calloc(1, sizeof(*answer_exec))))
00091       return NULL;
00092    
00093    /* Parse out application and arguments */
00094    if ((args = strchr(app, ','))) {
00095       *args++ = '\0';
00096       answer_exec->args = ast_strdup(args);
00097    }
00098 
00099    /* Copy application name */
00100    ast_copy_string(answer_exec->app, app, sizeof(answer_exec->app));
00101 
00102    return answer_exec;
00103 }
00104 
00105 /*! \brief Disable function for 'ANSWER_EXEC' option */
00106 static int answer_exec_disable(void *data)
00107 {
00108    struct answer_exec_struct *answer_exec = data;
00109 
00110    /* Make sure we have a value */
00111    if (!answer_exec)
00112       return -1;
00113 
00114    /* If arguments are present, free them too */
00115    if (answer_exec->args)
00116       ast_free(answer_exec->args);
00117 
00118    /* This is simple - just free the structure */
00119    ast_free(answer_exec);
00120 
00121    return 0;
00122 }
00123 
00124 static void *music_enable(void *data)
00125 {
00126    return ast_strdup(data);
00127 }
00128 
00129 static int music_disable(void *data)
00130 {
00131    if (!data)
00132       return -1;
00133 
00134    ast_free(data);
00135 
00136    return 0;
00137 }
00138 
00139 /*! \brief Application execution function for 'ANSWER_EXEC' option */
00140 static void answer_exec_run(struct ast_dial *dial, struct ast_dial_channel *dial_channel, char *app, char *args)
00141 {
00142    struct ast_channel *chan = dial_channel->owner;
00143    struct ast_app *ast_app = pbx_findapp(app);
00144 
00145    /* If the application was not found, return immediately */
00146    if (!ast_app)
00147       return;
00148 
00149    /* All is well... execute the application */
00150    pbx_exec(chan, ast_app, args);
00151 
00152    /* If another thread is not taking over hang up the channel */
00153    ast_mutex_lock(&dial->lock);
00154    if (dial->thread != AST_PTHREADT_STOP) {
00155       ast_hangup(chan);
00156       dial_channel->owner = NULL;
00157    }
00158    ast_mutex_unlock(&dial->lock);
00159 
00160    return;
00161 }
00162 
00163 /*! \brief Options structure - maps options to respective handlers (enable/disable). This list MUST be perfectly kept in order, or else madness will happen. */
00164 static const struct ast_option_types {
00165    enum ast_dial_option option;
00166    ast_dial_option_cb_enable enable;
00167    ast_dial_option_cb_disable disable;
00168 } option_types[] = {
00169    { AST_DIAL_OPTION_RINGING, NULL, NULL },                                  /*!< Always indicate ringing to caller */
00170    { AST_DIAL_OPTION_ANSWER_EXEC, answer_exec_enable, answer_exec_disable }, /*!< Execute application upon answer in async mode */
00171    { AST_DIAL_OPTION_MUSIC, music_enable, music_disable },                   /*!< Play music to the caller instead of ringing */
00172    { AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, NULL, NULL },                  /*!< Disable call forwarding on channels */
00173    { AST_DIAL_OPTION_MAX, NULL, NULL },                                      /*!< Terminator of list */
00174 };
00175 
00176 /*! \brief free the buffer if allocated, and set the pointer to the second arg */
00177 #define S_REPLACE(s, new_val) \
00178    do {                      \
00179       if (s) {              \
00180          free(s);          \
00181       }                     \
00182       s = (new_val);        \
00183    } while (0)
00184 
00185 /*! \brief Maximum number of channels we can watch at a time */
00186 #define AST_MAX_WATCHERS 256
00187 
00188 /*! \brief Macro for finding the option structure to use on a dialed channel */
00189 #define FIND_RELATIVE_OPTION(dial, dial_channel, ast_dial_option) (dial_channel->options[ast_dial_option] ? dial_channel->options[ast_dial_option] : dial->options[ast_dial_option])
00190 
00191 /*! \brief Macro that determines whether a channel is the caller or not */
00192 #define IS_CALLER(chan, owner) (chan == owner ? 1 : 0)
00193 
00194 /*! \brief New dialing structure
00195  * \note Create a dialing structure
00196  * \return Returns a calloc'd ast_dial structure, NULL on failure
00197  */
00198 struct ast_dial *ast_dial_create(void)
00199 {
00200    struct ast_dial *dial = NULL;
00201 
00202    /* Allocate new memory for structure */
00203    if (!(dial = ast_calloc(1, sizeof(*dial))))
00204       return NULL;
00205 
00206    /* Initialize list of channels */
00207    AST_LIST_HEAD_INIT(&dial->channels);
00208 
00209    /* Initialize thread to NULL */
00210    dial->thread = AST_PTHREADT_NULL;
00211 
00212    /* No timeout exists... yet */
00213    dial->timeout = -1;
00214    dial->actual_timeout = -1;
00215 
00216    /* Can't forget about the lock */
00217    ast_mutex_init(&dial->lock);
00218 
00219    return dial;
00220 }
00221 
00222 /*! \brief Append a channel
00223  * \note Appends a channel to a dialing structure
00224  * \return Returns channel reference number on success, -1 on failure
00225  */
00226 int ast_dial_append(struct ast_dial *dial, const char *tech, const char *device)
00227 {
00228    struct ast_dial_channel *channel = NULL;
00229 
00230    /* Make sure we have required arguments */
00231    if (!dial || !tech || !device)
00232       return -1;
00233 
00234    /* Allocate new memory for dialed channel structure */
00235    if (!(channel = ast_calloc(1, sizeof(*channel))))
00236       return -1;
00237 
00238    /* Record technology and device for when we actually dial */
00239    channel->tech = ast_strdup(tech);
00240    channel->device = ast_strdup(device);
00241 
00242    /* Grab reference number from dial structure */
00243    channel->num = ast_atomic_fetchadd_int(&dial->num, +1);
00244 
00245    /* No timeout exists... yet */
00246    channel->timeout = -1;
00247 
00248    /* Insert into channels list */
00249    AST_LIST_INSERT_TAIL(&dial->channels, channel, list);
00250 
00251    return channel->num;
00252 }
00253 
00254 /*! \brief Helper function that does the beginning dialing per-appended channel */
00255 static int begin_dial_channel(struct ast_dial_channel *channel, struct ast_channel *chan)
00256 {
00257    char numsubst[AST_MAX_EXTENSION];
00258    int res = 1;
00259 
00260    /* Copy device string over */
00261    ast_copy_string(numsubst, channel->device, sizeof(numsubst));
00262 
00263    /* If we fail to create our owner channel bail out */
00264    if (!(channel->owner = ast_request(channel->tech, chan ? chan->nativeformats : AST_FORMAT_AUDIO_MASK, numsubst, &channel->cause)))
00265       return -1;
00266 
00267    channel->owner->appl = "AppDial2";
00268    channel->owner->data = "(Outgoing Line)";
00269    memset(&channel->owner->whentohangup, 0, sizeof(channel->owner->whentohangup));
00270 
00271    /* Inherit everything from he who spawned this dial */
00272    if (chan) {
00273       ast_channel_inherit_variables(chan, channel->owner);
00274 
00275       /* Copy over callerid information */
00276       S_REPLACE(channel->owner->cid.cid_num, ast_strdup(chan->cid.cid_num));
00277       S_REPLACE(channel->owner->cid.cid_name, ast_strdup(chan->cid.cid_name));
00278       S_REPLACE(channel->owner->cid.cid_ani, ast_strdup(chan->cid.cid_ani));
00279       S_REPLACE(channel->owner->cid.cid_rdnis, ast_strdup(chan->cid.cid_rdnis));
00280 
00281       ast_string_field_set(channel->owner, language, chan->language);
00282       ast_string_field_set(channel->owner, accountcode, chan->accountcode);
00283       channel->owner->cdrflags = chan->cdrflags;
00284       if (ast_strlen_zero(channel->owner->musicclass))
00285          ast_string_field_set(channel->owner, musicclass, chan->musicclass);
00286 
00287       channel->owner->cid.cid_pres = chan->cid.cid_pres;
00288       channel->owner->cid.cid_ton = chan->cid.cid_ton;
00289       channel->owner->cid.cid_tns = chan->cid.cid_tns;
00290       channel->owner->adsicpe = chan->adsicpe;
00291       channel->owner->transfercapability = chan->transfercapability;
00292    }
00293 
00294    /* Attempt to actually call this device */
00295    if ((res = ast_call(channel->owner, numsubst, 0))) {
00296       res = 0;
00297       ast_hangup(channel->owner);
00298       channel->owner = NULL;
00299    } else {
00300       if (chan)
00301          ast_poll_channel_add(chan, channel->owner);
00302       res = 1;
00303       ast_verb(3, "Called %s\n", numsubst);
00304    }
00305 
00306    return res;
00307 }
00308 
00309 /*! \brief Helper function that does the beginning dialing per dial structure */
00310 static int begin_dial(struct ast_dial *dial, struct ast_channel *chan)
00311 {
00312    struct ast_dial_channel *channel = NULL;
00313    int success = 0;
00314 
00315    /* Iterate through channel list, requesting and calling each one */
00316    AST_LIST_LOCK(&dial->channels);
00317    AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00318       success += begin_dial_channel(channel, chan);
00319    }
00320    AST_LIST_UNLOCK(&dial->channels);
00321 
00322    /* If number of failures matches the number of channels, then this truly failed */
00323    return success;
00324 }
00325 
00326 /*! \brief Helper function to handle channels that have been call forwarded */
00327 static int handle_call_forward(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_channel *chan)
00328 {
00329    struct ast_channel *original = channel->owner;
00330    char *tmp = ast_strdupa(channel->owner->call_forward);
00331    char *tech = "Local", *device = tmp, *stuff;
00332 
00333    /* If call forwarding is disabled just drop the original channel and don't attempt to dial the new one */
00334    if (FIND_RELATIVE_OPTION(dial, channel, AST_DIAL_OPTION_DISABLE_CALL_FORWARDING)) {
00335       ast_hangup(original);
00336       channel->owner = NULL;
00337       return 0;
00338    }
00339 
00340    /* Figure out the new destination */
00341    if ((stuff = strchr(tmp, '/'))) {
00342       *stuff++ = '\0';
00343       tech = tmp;
00344       device = stuff;
00345    }
00346 
00347    /* Drop old destination information */
00348    ast_free(channel->tech);
00349    ast_free(channel->device);
00350 
00351    /* Update the dial channel with the new destination information */
00352    channel->tech = ast_strdup(tech);
00353    channel->device = ast_strdup(device);
00354    AST_LIST_UNLOCK(&dial->channels);
00355 
00356    /* Finally give it a go... send it out into the world */
00357    begin_dial_channel(channel, chan);
00358 
00359    /* Drop the original channel */
00360    ast_hangup(original);
00361 
00362    return 0;
00363 }
00364 
00365 /*! \brief Helper function that finds the dialed channel based on owner */
00366 static struct ast_dial_channel *find_relative_dial_channel(struct ast_dial *dial, struct ast_channel *owner)
00367 {
00368    struct ast_dial_channel *channel = NULL;
00369 
00370    AST_LIST_LOCK(&dial->channels);
00371    AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00372       if (channel->owner == owner)
00373          break;
00374    }
00375    AST_LIST_UNLOCK(&dial->channels);
00376 
00377    return channel;
00378 }
00379 
00380 static void set_state(struct ast_dial *dial, enum ast_dial_result state)
00381 {
00382    dial->state = state;
00383 
00384    if (dial->state_callback)
00385       dial->state_callback(dial);
00386 }
00387 
00388 /*! \brief Helper function that handles control frames WITH owner */
00389 static void handle_frame(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_frame *fr, struct ast_channel *chan)
00390 {
00391    if (fr->frametype == AST_FRAME_CONTROL) {
00392       switch (fr->subclass) {
00393       case AST_CONTROL_ANSWER:
00394          ast_verb(3, "%s answered %s\n", channel->owner->name, chan->name);
00395          AST_LIST_LOCK(&dial->channels);
00396          AST_LIST_REMOVE(&dial->channels, channel, list);
00397          AST_LIST_INSERT_HEAD(&dial->channels, channel, list);
00398          AST_LIST_UNLOCK(&dial->channels);
00399          set_state(dial, AST_DIAL_RESULT_ANSWERED);
00400          break;
00401       case AST_CONTROL_BUSY:
00402          ast_verb(3, "%s is busy\n", channel->owner->name);
00403          ast_hangup(channel->owner);
00404          channel->owner = NULL;
00405          break;
00406       case AST_CONTROL_CONGESTION:
00407          ast_verb(3, "%s is circuit-busy\n", channel->owner->name);
00408          ast_hangup(channel->owner);
00409          channel->owner = NULL;
00410          break;
00411       case AST_CONTROL_RINGING:
00412          ast_verb(3, "%s is ringing\n", channel->owner->name);
00413          if (!dial->options[AST_DIAL_OPTION_MUSIC])
00414             ast_indicate(chan, AST_CONTROL_RINGING);
00415          set_state(dial, AST_DIAL_RESULT_RINGING);
00416          break;
00417       case AST_CONTROL_PROGRESS:
00418          ast_verb(3, "%s is making progress, passing it to %s\n", channel->owner->name, chan->name);
00419          ast_indicate(chan, AST_CONTROL_PROGRESS);
00420          set_state(dial, AST_DIAL_RESULT_PROGRESS);
00421          break;
00422       case AST_CONTROL_VIDUPDATE:
00423          ast_verb(3, "%s requested a video update, passing it to %s\n", channel->owner->name, chan->name);
00424          ast_indicate(chan, AST_CONTROL_VIDUPDATE);
00425          break;
00426       case AST_CONTROL_SRCUPDATE:
00427          if (option_verbose > 2)
00428             ast_verbose (VERBOSE_PREFIX_3 "%s requested a source update, passing it to %s\n", channel->owner->name, chan->name);
00429          ast_indicate(chan, AST_CONTROL_SRCUPDATE);
00430          break;
00431       case AST_CONTROL_PROCEEDING:
00432          ast_verb(3, "%s is proceeding, passing it to %s\n", channel->owner->name, chan->name);
00433          ast_indicate(chan, AST_CONTROL_PROCEEDING);
00434          set_state(dial, AST_DIAL_RESULT_PROCEEDING);
00435          break;
00436       case AST_CONTROL_HOLD:
00437          ast_verb(3, "Call on %s placed on hold\n", chan->name);
00438          ast_indicate(chan, AST_CONTROL_HOLD);
00439          break;
00440       case AST_CONTROL_UNHOLD:
00441          ast_verb(3, "Call on %s left from hold\n", chan->name);
00442          ast_indicate(chan, AST_CONTROL_UNHOLD);
00443          break;
00444       case AST_CONTROL_OFFHOOK:
00445       case AST_CONTROL_FLASH:
00446          break;
00447       case -1:
00448          /* Prod the channel */
00449          ast_indicate(chan, -1);
00450          break;
00451       default:
00452          break;
00453       }
00454    }
00455 
00456    return;
00457 }
00458 
00459 /*! \brief Helper function that handles control frames WITHOUT owner */
00460 static void handle_frame_ownerless(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_frame *fr)
00461 {
00462    /* If we have no owner we can only update the state of the dial structure, so only look at control frames */
00463    if (fr->frametype != AST_FRAME_CONTROL)
00464       return;
00465 
00466    switch (fr->subclass) {
00467    case AST_CONTROL_ANSWER:
00468       ast_verb(3, "%s answered\n", channel->owner->name);
00469       AST_LIST_LOCK(&dial->channels);
00470       AST_LIST_REMOVE(&dial->channels, channel, list);
00471       AST_LIST_INSERT_HEAD(&dial->channels, channel, list);
00472       AST_LIST_UNLOCK(&dial->channels);
00473       set_state(dial, AST_DIAL_RESULT_ANSWERED);
00474       break;
00475    case AST_CONTROL_BUSY:
00476       ast_verb(3, "%s is busy\n", channel->owner->name);
00477       ast_hangup(channel->owner);
00478       channel->owner = NULL;
00479       break;
00480    case AST_CONTROL_CONGESTION:
00481       ast_verb(3, "%s is circuit-busy\n", channel->owner->name);
00482       ast_hangup(channel->owner);
00483       channel->owner = NULL;
00484       break;
00485    case AST_CONTROL_RINGING:
00486       ast_verb(3, "%s is ringing\n", channel->owner->name);
00487       set_state(dial, AST_DIAL_RESULT_RINGING);
00488       break;
00489    case AST_CONTROL_PROGRESS:
00490       ast_verb(3, "%s is making progress\n", channel->owner->name);
00491       set_state(dial, AST_DIAL_RESULT_PROGRESS);
00492       break;
00493    case AST_CONTROL_PROCEEDING:
00494       ast_verb(3, "%s is proceeding\n", channel->owner->name);
00495       set_state(dial, AST_DIAL_RESULT_PROCEEDING);
00496       break;
00497    default:
00498       break;
00499    }
00500 
00501    return;
00502 }
00503 
00504 /*! \brief Helper function to handle when a timeout occurs on dialing attempt */
00505 static int handle_timeout_trip(struct ast_dial *dial, struct timeval start)
00506 {
00507    struct ast_dial_channel *channel = NULL;
00508    int diff = ast_tvdiff_ms(ast_tvnow(), start), lowest_timeout = -1, new_timeout = -1;
00509 
00510    /* If the global dial timeout tripped switch the state to timeout so our channel loop will drop every channel */
00511    if (diff >= dial->timeout) {
00512       set_state(dial, AST_DIAL_RESULT_TIMEOUT);
00513       new_timeout = 0;
00514    }
00515 
00516    /* Go through dropping out channels that have met their timeout */
00517    AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00518       if (dial->state == AST_DIAL_RESULT_TIMEOUT || diff >= channel->timeout) {
00519          ast_hangup(channel->owner);
00520          channel->owner = NULL;
00521       } else if ((lowest_timeout == -1) || (lowest_timeout > channel->timeout)) {
00522          lowest_timeout = channel->timeout;
00523       }
00524    }
00525 
00526    /* Calculate the new timeout using the lowest timeout found */
00527    if (lowest_timeout >= 0)
00528       new_timeout = lowest_timeout - diff;
00529 
00530    return new_timeout;
00531 }
00532 
00533 /*! \brief Helper function that basically keeps tabs on dialing attempts */
00534 static enum ast_dial_result monitor_dial(struct ast_dial *dial, struct ast_channel *chan)
00535 {
00536    int timeout = -1;
00537    struct ast_channel *cs[AST_MAX_WATCHERS], *who = NULL;
00538    struct ast_dial_channel *channel = NULL;
00539    struct answer_exec_struct *answer_exec = NULL;
00540    struct timeval start;
00541 
00542    set_state(dial, AST_DIAL_RESULT_TRYING);
00543 
00544    /* If the "always indicate ringing" option is set, change state to ringing and indicate to the owner if present */
00545    if (dial->options[AST_DIAL_OPTION_RINGING]) {
00546       set_state(dial, AST_DIAL_RESULT_RINGING);
00547       if (chan)
00548          ast_indicate(chan, AST_CONTROL_RINGING);
00549    } else if (chan && dial->options[AST_DIAL_OPTION_MUSIC] && 
00550       !ast_strlen_zero(dial->options[AST_DIAL_OPTION_MUSIC])) {
00551       char *original_moh = ast_strdupa(chan->musicclass);
00552       ast_indicate(chan, -1);
00553       ast_string_field_set(chan, musicclass, dial->options[AST_DIAL_OPTION_MUSIC]);
00554       ast_moh_start(chan, dial->options[AST_DIAL_OPTION_MUSIC], NULL);
00555       ast_string_field_set(chan, musicclass, original_moh);
00556    }
00557 
00558    /* Record start time for timeout purposes */
00559    start = ast_tvnow();
00560 
00561    /* We actually figured out the maximum timeout we can do as they were added, so we can directly access the info */
00562    timeout = dial->actual_timeout;
00563 
00564    /* Go into an infinite loop while we are trying */
00565    while ((dial->state != AST_DIAL_RESULT_UNANSWERED) && (dial->state != AST_DIAL_RESULT_ANSWERED) && (dial->state != AST_DIAL_RESULT_HANGUP) && (dial->state != AST_DIAL_RESULT_TIMEOUT)) {
00566       int pos = 0, count = 0;
00567       struct ast_frame *fr = NULL;
00568 
00569       /* Set up channel structure array */
00570       pos = count = 0;
00571       if (chan)
00572          cs[pos++] = chan;
00573 
00574       /* Add channels we are attempting to dial */
00575       AST_LIST_LOCK(&dial->channels);
00576       AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00577          if (channel->owner) {
00578             cs[pos++] = channel->owner;
00579             count++;
00580          }
00581       }
00582       AST_LIST_UNLOCK(&dial->channels);
00583 
00584       /* If we have no outbound channels in progress, switch state to unanswered and stop */
00585       if (!count) {
00586          set_state(dial, AST_DIAL_RESULT_UNANSWERED);
00587          break;
00588       }
00589 
00590       /* Just to be safe... */
00591       if (dial->thread == AST_PTHREADT_STOP)
00592          break;
00593 
00594       /* Wait for frames from channels */
00595       who = ast_waitfor_n(cs, pos, &timeout);
00596 
00597       /* Check to see if our thread is being cancelled */
00598       if (dial->thread == AST_PTHREADT_STOP)
00599          break;
00600 
00601       /* If the timeout no longer exists OR if we got no channel it basically means the timeout was tripped, so handle it */
00602       if (!timeout || !who) {
00603          timeout = handle_timeout_trip(dial, start);
00604          continue;
00605       }
00606 
00607       /* Find relative dial channel */
00608       if (!chan || !IS_CALLER(chan, who))
00609          channel = find_relative_dial_channel(dial, who);
00610 
00611       /* See if this channel has been forwarded elsewhere */
00612       if (!ast_strlen_zero(who->call_forward)) {
00613          handle_call_forward(dial, channel, chan);
00614          continue;
00615       }
00616 
00617       /* Attempt to read in a frame */
00618       if (!(fr = ast_read(who))) {
00619          /* If this is the caller then we switch state to hangup and stop */
00620          if (chan && IS_CALLER(chan, who)) {
00621             set_state(dial, AST_DIAL_RESULT_HANGUP);
00622             break;
00623          }
00624          if (chan)
00625             ast_poll_channel_del(chan, channel->owner);
00626          ast_hangup(who);
00627          channel->owner = NULL;
00628          continue;
00629       }
00630 
00631       /* Process the frame */
00632       if (chan)
00633          handle_frame(dial, channel, fr, chan);
00634       else
00635          handle_frame_ownerless(dial, channel, fr);
00636 
00637       /* Free the received frame and start all over */
00638       ast_frfree(fr);
00639    }
00640 
00641    /* Do post-processing from loop */
00642    if (dial->state == AST_DIAL_RESULT_ANSWERED) {
00643       /* Hangup everything except that which answered */
00644       AST_LIST_LOCK(&dial->channels);
00645       AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00646          if (!channel->owner || channel->owner == who)
00647             continue;
00648          if (chan)
00649             ast_poll_channel_del(chan, channel->owner);
00650          ast_hangup(channel->owner);
00651          channel->owner = NULL;
00652       }
00653       AST_LIST_UNLOCK(&dial->channels);
00654       /* If ANSWER_EXEC is enabled as an option, execute application on answered channel */
00655       if ((channel = find_relative_dial_channel(dial, who)) && (answer_exec = FIND_RELATIVE_OPTION(dial, channel, AST_DIAL_OPTION_ANSWER_EXEC))) {
00656          channel->is_running_app = 1;
00657          answer_exec_run(dial, channel, answer_exec->app, answer_exec->args);
00658          channel->is_running_app = 0;
00659       }
00660 
00661       if (chan && dial->options[AST_DIAL_OPTION_MUSIC] && 
00662          !ast_strlen_zero(dial->options[AST_DIAL_OPTION_MUSIC])) {
00663          ast_moh_stop(chan);
00664       }
00665    } else if (dial->state == AST_DIAL_RESULT_HANGUP) {
00666       /* Hangup everything */
00667       AST_LIST_LOCK(&dial->channels);
00668       AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00669          if (!channel->owner)
00670             continue;
00671          if (chan)
00672             ast_poll_channel_del(chan, channel->owner);
00673          ast_hangup(channel->owner);
00674          channel->owner = NULL;
00675       }
00676       AST_LIST_UNLOCK(&dial->channels);
00677    }
00678 
00679    return dial->state;
00680 }
00681 
00682 /*! \brief Dial async thread function */
00683 static void *async_dial(void *data)
00684 {
00685    struct ast_dial *dial = data;
00686 
00687    /* This is really really simple... we basically pass monitor_dial a NULL owner and it changes it's behavior */
00688    monitor_dial(dial, NULL);
00689 
00690    return NULL;
00691 }
00692 
00693 /*! \brief Execute dialing synchronously or asynchronously
00694  * \note Dials channels in a dial structure.
00695  * \return Returns dial result code. (TRYING/INVALID/FAILED/ANSWERED/TIMEOUT/UNANSWERED).
00696  */
00697 enum ast_dial_result ast_dial_run(struct ast_dial *dial, struct ast_channel *chan, int async)
00698 {
00699    enum ast_dial_result res = AST_DIAL_RESULT_TRYING;
00700 
00701    /* Ensure required arguments are passed */
00702    if (!dial || (!chan && !async)) {
00703       ast_debug(1, "invalid #1\n");
00704       return AST_DIAL_RESULT_INVALID;
00705    }
00706 
00707    /* If there are no channels to dial we can't very well try to dial them */
00708    if (AST_LIST_EMPTY(&dial->channels)) {
00709       ast_debug(1, "invalid #2\n");
00710       return AST_DIAL_RESULT_INVALID;
00711    }
00712 
00713    /* Dial each requested channel */
00714    if (!begin_dial(dial, chan))
00715       return AST_DIAL_RESULT_FAILED;
00716 
00717    /* If we are running async spawn a thread and send it away... otherwise block here */
00718    if (async) {
00719       dial->state = AST_DIAL_RESULT_TRYING;
00720       /* Try to create a thread */
00721       if (ast_pthread_create(&dial->thread, NULL, async_dial, dial)) {
00722          /* Failed to create the thread - hangup all dialed channels and return failed */
00723          ast_dial_hangup(dial);
00724          res = AST_DIAL_RESULT_FAILED;
00725       }
00726    } else {
00727       res = monitor_dial(dial, chan);
00728    }
00729 
00730    return res;
00731 }
00732 
00733 /*! \brief Return channel that answered
00734  * \note Returns the Asterisk channel that answered
00735  * \param dial Dialing structure
00736  */
00737 struct ast_channel *ast_dial_answered(struct ast_dial *dial)
00738 {
00739    if (!dial)
00740       return NULL;
00741 
00742    return ((dial->state == AST_DIAL_RESULT_ANSWERED) ? AST_LIST_FIRST(&dial->channels)->owner : NULL);
00743 }
00744 
00745 /*! \brief Steal the channel that answered
00746  * \note Returns the Asterisk channel that answered and removes it from the dialing structure
00747  * \param dial Dialing structure
00748  */
00749 struct ast_channel *ast_dial_answered_steal(struct ast_dial *dial)
00750 {
00751    struct ast_channel *chan = NULL;
00752 
00753    if (!dial)
00754       return NULL;
00755 
00756    if (dial->state == AST_DIAL_RESULT_ANSWERED) {
00757       chan = AST_LIST_FIRST(&dial->channels)->owner;
00758       AST_LIST_FIRST(&dial->channels)->owner = NULL;
00759    }
00760 
00761    return chan;
00762 }
00763 
00764 /*! \brief Return state of dial
00765  * \note Returns the state of the dial attempt
00766  * \param dial Dialing structure
00767  */
00768 enum ast_dial_result ast_dial_state(struct ast_dial *dial)
00769 {
00770    return dial->state;
00771 }
00772 
00773 /*! \brief Cancel async thread
00774  * \note Cancel a running async thread
00775  * \param dial Dialing structure
00776  */
00777 enum ast_dial_result ast_dial_join(struct ast_dial *dial)
00778 {
00779    pthread_t thread;
00780 
00781    /* If the dial structure is not running in async, return failed */
00782    if (dial->thread == AST_PTHREADT_NULL)
00783       return AST_DIAL_RESULT_FAILED;
00784 
00785    /* Record thread */
00786    thread = dial->thread;
00787 
00788    /* Boom, commence locking */
00789    ast_mutex_lock(&dial->lock);
00790 
00791    /* Stop the thread */
00792    dial->thread = AST_PTHREADT_STOP;
00793 
00794    /* If the answered channel is running an application we have to soft hangup it, can't just poke the thread */
00795    AST_LIST_LOCK(&dial->channels);
00796    if (AST_LIST_FIRST(&dial->channels)->is_running_app) {
00797       struct ast_channel *chan = AST_LIST_FIRST(&dial->channels)->owner;
00798       if (chan) {
00799          ast_channel_lock(chan);
00800          ast_softhangup(chan, AST_SOFTHANGUP_EXPLICIT);
00801          ast_channel_unlock(chan);
00802       }
00803    } else {
00804       /* Now we signal it with SIGURG so it will break out of it's waitfor */
00805       pthread_kill(thread, SIGURG);
00806    }
00807    AST_LIST_UNLOCK(&dial->channels);
00808 
00809    /* Yay done with it */
00810    ast_mutex_unlock(&dial->lock);
00811 
00812    /* Finally wait for the thread to exit */
00813    pthread_join(thread, NULL);
00814 
00815    /* Yay thread is all gone */
00816    dial->thread = AST_PTHREADT_NULL;
00817 
00818    return dial->state;
00819 }
00820 
00821 /*! \brief Hangup channels
00822  * \note Hangup all active channels
00823  * \param dial Dialing structure
00824  */
00825 void ast_dial_hangup(struct ast_dial *dial)
00826 {
00827    struct ast_dial_channel *channel = NULL;
00828 
00829    if (!dial)
00830       return;
00831    
00832    AST_LIST_LOCK(&dial->channels);
00833    AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00834       if (channel->owner) {
00835          ast_hangup(channel->owner);
00836          channel->owner = NULL;
00837       }
00838    }
00839    AST_LIST_UNLOCK(&dial->channels);
00840 
00841    return;
00842 }
00843 
00844 /*! \brief Destroys a dialing structure
00845  * \note Destroys (free's) the given ast_dial structure
00846  * \param dial Dialing structure to free
00847  * \return Returns 0 on success, -1 on failure
00848  */
00849 int ast_dial_destroy(struct ast_dial *dial)
00850 {
00851    int i = 0;
00852    struct ast_dial_channel *channel = NULL;
00853 
00854    if (!dial)
00855       return -1;
00856    
00857    /* Hangup and deallocate all the dialed channels */
00858    AST_LIST_LOCK(&dial->channels);
00859    AST_LIST_TRAVERSE_SAFE_BEGIN(&dial->channels, channel, list) {
00860       /* Disable any enabled options */
00861       for (i = 0; i < AST_DIAL_OPTION_MAX; i++) {
00862          if (!channel->options[i])
00863             continue;
00864          if (option_types[i].disable)
00865             option_types[i].disable(channel->options[i]);
00866          channel->options[i] = NULL;
00867       }
00868       /* Hang up channel if need be */
00869       if (channel->owner) {
00870          ast_hangup(channel->owner);
00871          channel->owner = NULL;
00872       }
00873       /* Free structure */
00874       ast_free(channel->tech);
00875       ast_free(channel->device);
00876       AST_LIST_REMOVE_CURRENT(list);
00877       ast_free(channel);
00878    }
00879    AST_LIST_TRAVERSE_SAFE_END;
00880    AST_LIST_UNLOCK(&dial->channels);
00881  
00882    /* Disable any enabled options globally */
00883    for (i = 0; i < AST_DIAL_OPTION_MAX; i++) {
00884       if (!dial->options[i])
00885          continue;
00886       if (option_types[i].disable)
00887          option_types[i].disable(dial->options[i]);
00888       dial->options[i] = NULL;
00889    }
00890 
00891    /* Lock be gone! */
00892    ast_mutex_destroy(&dial->lock);
00893 
00894    /* Free structure */
00895    ast_free(dial);
00896 
00897    return 0;
00898 }
00899 
00900 /*! \brief Enables an option globally
00901  * \param dial Dial structure to enable option on
00902  * \param option Option to enable
00903  * \param data Data to pass to this option (not always needed)
00904  * \return Returns 0 on success, -1 on failure
00905  */
00906 int ast_dial_option_global_enable(struct ast_dial *dial, enum ast_dial_option option, void *data)
00907 {
00908    /* If the option is already enabled, return failure */
00909    if (dial->options[option])
00910       return -1;
00911 
00912    /* Execute enable callback if it exists, if not simply make sure the value is set */
00913    if (option_types[option].enable)
00914       dial->options[option] = option_types[option].enable(data);
00915    else
00916       dial->options[option] = (void*)1;
00917 
00918    return 0;
00919 }
00920 
00921 /*! \brief Helper function for finding a channel in a dial structure based on number
00922  */
00923 static struct ast_dial_channel *find_dial_channel(struct ast_dial *dial, int num)
00924 {
00925    struct ast_dial_channel *channel = AST_LIST_LAST(&dial->channels);
00926 
00927    /* We can try to predict programmer behavior, the last channel they added is probably the one they wanted to modify */
00928    if (channel->num == num)
00929       return channel;
00930 
00931    /* Hrm not at the end... looking through the list it is! */
00932    AST_LIST_LOCK(&dial->channels);
00933    AST_LIST_TRAVERSE(&dial->channels, channel, list) {
00934       if (channel->num == num)
00935          break;
00936    }
00937    AST_LIST_UNLOCK(&dial->channels);
00938    
00939    return channel;
00940 }
00941 
00942 /*! \brief Enables an option per channel
00943  * \param dial Dial structure
00944  * \param num Channel number to enable option on
00945  * \param option Option to enable
00946  * \param data Data to pass to this option (not always needed)
00947  * \return Returns 0 on success, -1 on failure
00948  */
00949 int ast_dial_option_enable(struct ast_dial *dial, int num, enum ast_dial_option option, void *data)
00950 {
00951    struct ast_dial_channel *channel = NULL;
00952 
00953    /* Ensure we have required arguments */
00954    if (!dial || AST_LIST_EMPTY(&dial->channels))
00955       return -1;
00956 
00957    if (!(channel = find_dial_channel(dial, num)))
00958       return -1;
00959 
00960    /* If the option is already enabled, return failure */
00961    if (channel->options[option])
00962       return -1;
00963 
00964    /* Execute enable callback if it exists, if not simply make sure the value is set */
00965    if (option_types[option].enable)
00966       channel->options[option] = option_types[option].enable(data);
00967    else
00968       channel->options[option] = (void*)1;
00969 
00970    return 0;
00971 }
00972 
00973 /*! \brief Disables an option globally
00974  * \param dial Dial structure to disable option on
00975  * \param option Option to disable
00976  * \return Returns 0 on success, -1 on failure
00977  */
00978 int ast_dial_option_global_disable(struct ast_dial *dial, enum ast_dial_option option)
00979 {
00980    /* If the option is not enabled, return failure */
00981    if (!dial->options[option]) {
00982       return -1;
00983    }
00984 
00985    /* Execute callback of option to disable if it exists */
00986    if (option_types[option].disable)
00987       option_types[option].disable(dial->options[option]);
00988 
00989    /* Finally disable option on the structure */
00990    dial->options[option] = NULL;
00991 
00992    return 0;
00993 }
00994 
00995 /*! \brief Disables an option per channel
00996  * \param dial Dial structure
00997  * \param num Channel number to disable option on
00998  * \param option Option to disable
00999  * \return Returns 0 on success, -1 on failure
01000  */
01001 int ast_dial_option_disable(struct ast_dial *dial, int num, enum ast_dial_option option)
01002 {
01003    struct ast_dial_channel *channel = NULL;
01004 
01005    /* Ensure we have required arguments */
01006    if (!dial || AST_LIST_EMPTY(&dial->channels))
01007       return -1;
01008 
01009    if (!(channel = find_dial_channel(dial, num)))
01010       return -1;
01011 
01012    /* If the option is not enabled, return failure */
01013    if (!channel->options[option])
01014       return -1;
01015 
01016    /* Execute callback of option to disable it if it exists */
01017    if (option_types[option].disable)
01018       option_types[option].disable(channel->options[option]);
01019 
01020    /* Finally disable the option on the structure */
01021    channel->options[option] = NULL;
01022 
01023    return 0;
01024 }
01025 
01026 void ast_dial_set_state_callback(struct ast_dial *dial, ast_dial_state_callback callback)
01027 {
01028    dial->state_callback = callback;
01029 }
01030 
01031 /*! \brief Set the maximum time (globally) allowed for trying to ring phones
01032  * \param dial The dial structure to apply the time limit to
01033  * \param timeout Maximum time allowed
01034  * \return nothing
01035  */
01036 void ast_dial_set_global_timeout(struct ast_dial *dial, int timeout)
01037 {
01038    dial->timeout = timeout;
01039 
01040    if (dial->timeout > 0 && (dial->actual_timeout > dial->timeout || dial->actual_timeout == -1))
01041       dial->actual_timeout = dial->timeout;
01042 
01043    return;
01044 }
01045 
01046 /*! \brief Set the maximum time (per channel) allowed for trying to ring the phone
01047  * \param dial The dial structure the channel belongs to
01048  * \param num Channel number to set timeout on
01049  * \param timeout Maximum time allowed
01050  * \return nothing
01051  */
01052 void ast_dial_set_timeout(struct ast_dial *dial, int num, int timeout)
01053 {
01054    struct ast_dial_channel *channel = NULL;
01055 
01056    if (!(channel = find_dial_channel(dial, num)))
01057       return;
01058 
01059    channel->timeout = timeout;
01060 
01061    if (channel->timeout > 0 && (dial->actual_timeout > channel->timeout || dial->actual_timeout == -1))
01062       dial->actual_timeout = channel->timeout;
01063 
01064    return;
01065 }

Generated on Wed Oct 28 11:51:03 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6