main/dial.c

   1 /*
   2  * Asterisk -- An open source telephony toolkit.
   3  *
   4  * Copyright (C) 1999 - 2007, Digium, Inc.
   5  *
   6  * Joshua Colp <jcolp@digium.com>
   7  *
   8  * See http://www.asterisk.org for more information about
   9  * the Asterisk project. Please do not directly contact
  10  * any of the maintainers of this project for assistance;
  11  * the project provides a web site, mailing lists and IRC
  12  * channels for your use.
  13  *
  14  * This program is free software, distributed under the terms of
  15  * the GNU General Public License Version 2. See the LICENSE file
  16  * at the top of the source tree.
  17  */
  18
  19 /*! \file
  20  *
  21  * \brief Dialing API
  22  *
  23  * \author Joshua Colp <jcolp@digium.com>
  24  */
  25
  26 #include "asterisk.h"
  27
  28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <sys/time.h>
  34 #include <signal.h>
  35 #include <errno.h>
  36 #include <unistd.h>
  37
  38 #include "asterisk/logger.h"
  39 #include "asterisk/channel.h"
  40 #include "asterisk/options.h"
  41 #include "asterisk/utils.h"
  42 #include "asterisk/lock.h"
  43 #include "asterisk/linkedlists.h"
  44 #include "asterisk/dial.h"
  45 #include "asterisk/pbx.h"
  46
  47 /*! \brief Main dialing structure. Contains global options, channels being dialed, and more! */
  48 struct ast_dial {
  49         int num;                                           /*! Current number to give to next dialed channel */
  50         enum ast_dial_result state;                       /*! Status of dial */
  51         void *options[AST_DIAL_OPTION_MAX];                /*! Global options */
  52         ast_dial_state_callback state_callback;          /*! Status callback */
  53         AST_LIST_HEAD(, ast_dial_channel) channels; /*! Channels being dialed */
  54         pthread_t thread;                                  /*! Thread (if running in async) */
  55         ast_mutex_t lock;                                  /*! Lock to protect the thread information above */
  56 };
  57
  58 /*! \brief Dialing channel structure. Contains per-channel dialing options, asterisk channel, and more! */
  59 struct ast_dial_channel {
  60         int num;                               /*! Unique number for dialed channel */
  61         const char *tech;                      /*! Technology being dialed */
  62         const char *device;                    /*! Device being dialed */
  63         void *options[AST_DIAL_OPTION_MAX];    /*! Channel specific options */
  64         int cause;                             /*! Cause code in case of failure */
  65         int is_running_app:1;                  /*! Is this running an application? */
  66         struct ast_channel *owner;             /*! Asterisk channel */
  67         AST_LIST_ENTRY(ast_dial_channel) list; /*! Linked list information */
  68 };
  69
  70 /*! \brief Typedef for dial option enable */
  71 typedef void *(*ast_dial_option_cb_enable)(void *data);
  72
  73 /*! \brief Typedef for dial option disable */
  74 typedef int (*ast_dial_option_cb_disable)(void *data);
  75
  76 /* Structure for 'ANSWER_EXEC' option */
  77 struct answer_exec_struct {
  78         char app[AST_MAX_APP]; /* Application name */
  79         char *args;            /* Application arguments */
  80 };
  81
  82 /* Enable function for 'ANSWER_EXEC' option */
  83 static void *answer_exec_enable(void *data)
  84 {
  85         struct answer_exec_struct *answer_exec = NULL;
  86         char *app = ast_strdupa((char*)data), *args = NULL;
  87
  88         /* Not giving any data to this option is bad, mmmk? */
  89         if (ast_strlen_zero(app))
  90                 return NULL;
  91
  92         /* Create new data structure */
  93         if (!(answer_exec = ast_calloc(1, sizeof(*answer_exec))))
  94                 return NULL;
  95
  96         /* Parse out application and arguments */
  97         if ((args = strchr(app, '|'))) {
  98                 *args++ = '\0';
  99                 answer_exec->args = ast_strdup(args);
 100         }
 101
 102         /* Copy application name */
 103         ast_copy_string(answer_exec->app, app, sizeof(answer_exec->app));
 104
 105         return answer_exec;
 106 }
 107
 108 /* Disable function for 'ANSWER_EXEC' option */
 109 static int answer_exec_disable(void *data)
 110 {
 111         struct answer_exec_struct *answer_exec = data;
 112
 113         /* Make sure we have a value */
 114         if (!answer_exec)
 115                 return -1;
 116
 117         /* If arguments are present, free them too */
 118         if (answer_exec->args)
 119                 free(answer_exec->args);
 120
 121         /* This is simple - just free the structure */
 122         free(answer_exec);
 123
 124         return 0;
 125 }
 126
 127 /* Application execution function for 'ANSWER_EXEC' option */
 128 static void answer_exec_run(struct ast_dial *dial, struct ast_dial_channel *dial_channel, char *app, char *args)
 129 {
 130         struct ast_channel *chan = dial_channel->owner;
 131         struct ast_app *ast_app = pbx_findapp(app);
 132
 133         /* If the application was not found, return immediately */
 134         if (!ast_app)
 135                 return;
 136
 137         /* All is well... execute the application */
 138         pbx_exec(chan, ast_app, args);
 139
 140         /* If another thread is not taking over hang up the channel */
 141         ast_mutex_lock(&dial->lock);
 142         if (dial->thread != AST_PTHREADT_STOP) {
 143                 ast_hangup(chan);
 144                 dial_channel->owner = NULL;
 145         }
 146         ast_mutex_unlock(&dial->lock);
 147
 148         return;
 149 }
 150
 151 /*! \brief Options structure - maps options to respective handlers (enable/disable). This list MUST be perfectly kept in order, or else madness will happen. */
 152 static const struct ast_option_types {
 153         enum ast_dial_option option;
 154         ast_dial_option_cb_enable enable;
 155         ast_dial_option_cb_disable disable;
 156 } option_types[] = {
 157         { AST_DIAL_OPTION_RINGING, NULL, NULL },                                  /*! Always indicate ringing to caller */
 158         { AST_DIAL_OPTION_ANSWER_EXEC, answer_exec_enable, answer_exec_disable }, /*! Execute application upon answer in async mode */
 159         { AST_DIAL_OPTION_MAX, NULL, NULL },                                      /*! Terminator of list */
 160 };
 161
 162 /* free the buffer if allocated, and set the pointer to the second arg */
 163 #define S_REPLACE(s, new_val)           \
 164         do {                            \
 165                 if (s)                  \
 166                         free(s);        \
 167                 s = (new_val);          \
 168         } while (0)
 169
 170 /*! \brief Maximum number of channels we can watch at a time */
 171 #define AST_MAX_WATCHERS 256
 172
 173 /*! \brief Macro for finding the option structure to use on a dialed channel */
 174 #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])
 175
 176 /*! \brief Macro that determines whether a channel is the caller or not */
 177 #define IS_CALLER(chan, owner) (chan == owner ? 1 : 0)
 178
 179 /*! \brief New dialing structure
 180  * \note Create a dialing structure
 181  * \return Returns a calloc'd ast_dial structure, NULL on failure
 182  */
 183 struct ast_dial *ast_dial_create(void)
 184 {
 185         struct ast_dial *dial = NULL;
 186
 187         /* Allocate new memory for structure */
 188         if (!(dial = ast_calloc(1, sizeof(*dial))))
 189                 return NULL;
 190
 191         /* Initialize list of channels */
 192         AST_LIST_HEAD_INIT(&dial->channels);
 193
 194         /* Initialize thread to NULL */
 195         dial->thread = AST_PTHREADT_NULL;
 196
 197         /* Can't forget about the lock */
 198         ast_mutex_init(&dial->lock);
 199
 200         return dial;
 201 }
 202
 203 /*! \brief Append a channel
 204  * \note Appends a channel to a dialing structure
 205  * \return Returns channel reference number on success, -1 on failure
 206  */
 207 int ast_dial_append(struct ast_dial *dial, const char *tech, const char *device)
 208 {
 209         struct ast_dial_channel *channel = NULL;
 210
 211         /* Make sure we have required arguments */
 212         if (!dial || !tech || !device)
 213                 return -1;
 214
 215         /* Allocate new memory for dialed channel structure */
 216         if (!(channel = ast_calloc(1, sizeof(*channel))))
 217                 return -1;
 218
 219         /* Record technology and device for when we actually dial */
 220         channel->tech = tech;
 221         channel->device = device;
 222
 223         /* Grab reference number from dial structure */
 224         channel->num = ast_atomic_fetchadd_int(&dial->num, +1);
 225
 226         /* Insert into channels list */
 227         AST_LIST_INSERT_TAIL(&dial->channels, channel, list);
 228
 229         return channel->num;
 230 }
 231
 232 /*! \brief Helper function that does the beginning dialing */
 233 static int begin_dial(struct ast_dial *dial, struct ast_channel *chan)
 234 {
 235         struct ast_dial_channel *channel = NULL;
 236         int success = 0, res = 0;
 237
 238         /* Iterate through channel list, requesting and calling each one */
 239         AST_LIST_LOCK(&dial->channels);
 240         AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 241                 char numsubst[AST_MAX_EXTENSION];
 242
 243                 /* Copy device string over */
 244                 ast_copy_string(numsubst, channel->device, sizeof(numsubst));
 245
 246                 /* Request that the channel be created */
 247                 if (!(channel->owner = ast_request(channel->tech,
 248                         chan ? chan->nativeformats : AST_FORMAT_AUDIO_MASK, numsubst, &channel->cause))) {
 249                         continue;
 250                 }
 251
 252                 channel->owner->appl = "AppDial2";
 253                 channel->owner->data = "(Outgoing Line)";
 254                 channel->owner->whentohangup = 0;
 255
 256                 /* Inherit everything from he who spawned this Dial */
 257                 if (chan) {
 258                         ast_channel_inherit_variables(chan, channel->owner);
 259
 260                         /* Copy over callerid information */
 261                         S_REPLACE(channel->owner->cid.cid_num, ast_strdup(chan->cid.cid_num));
 262                         S_REPLACE(channel->owner->cid.cid_name, ast_strdup(chan->cid.cid_name));
 263                         S_REPLACE(channel->owner->cid.cid_ani, ast_strdup(chan->cid.cid_ani));
 264                         S_REPLACE(channel->owner->cid.cid_rdnis, ast_strdup(chan->cid.cid_rdnis));
 265
 266                         ast_string_field_set(channel->owner, language, chan->language);
 267                         ast_string_field_set(channel->owner, accountcode, chan->accountcode);
 268                         channel->owner->cdrflags = chan->cdrflags;
 269                         if (ast_strlen_zero(channel->owner->musicclass))
 270                                 ast_string_field_set(channel->owner, musicclass, chan->musicclass);
 271
 272                         channel->owner->cid.cid_pres = chan->cid.cid_pres;
 273                         channel->owner->cid.cid_ton = chan->cid.cid_ton;
 274                         channel->owner->cid.cid_tns = chan->cid.cid_tns;
 275                         channel->owner->adsicpe = chan->adsicpe;
 276                         channel->owner->transfercapability = chan->transfercapability;
 277                 }
 278
 279                 /* Actually call the device */
 280                 if ((res = ast_call(channel->owner, numsubst, 0))) {
 281                         ast_hangup(channel->owner);
 282                         channel->owner = NULL;
 283                 } else {
 284                         success++;
 285                         if (option_verbose > 2)
 286                                 ast_verbose(VERBOSE_PREFIX_3 "Called %s\n", numsubst);
 287                 }
 288         }
 289         AST_LIST_UNLOCK(&dial->channels);
 290
 291         /* If number of failures matches the number of channels, then this truly failed */
 292         return success;
 293 }
 294
 295 /*! \brief Helper function that finds the dialed channel based on owner */
 296 static struct ast_dial_channel *find_relative_dial_channel(struct ast_dial *dial, struct ast_channel *owner)
 297 {
 298         struct ast_dial_channel *channel = NULL;
 299
 300         AST_LIST_LOCK(&dial->channels);
 301         AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 302                 if (channel->owner == owner)
 303                         break;
 304         }
 305         AST_LIST_UNLOCK(&dial->channels);
 306
 307         return channel;
 308 }
 309
 310 static void set_state(struct ast_dial *dial, enum ast_dial_result state)
 311 {
 312         dial->state = state;
 313
 314         if (dial->state_callback)
 315                 dial->state_callback(dial);
 316 }
 317
 318 /*! \brief Helper function that handles control frames WITH owner */
 319 static void handle_frame(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_frame *fr, struct ast_channel *chan)
 320 {
 321         if (fr->frametype == AST_FRAME_CONTROL) {
 322                 switch (fr->subclass) {
 323                 case AST_CONTROL_ANSWER:
 324                         if (option_verbose > 2)
 325                                 ast_verbose( VERBOSE_PREFIX_3 "%s answered %s\n", channel->owner->name, chan->name);
 326                         AST_LIST_LOCK(&dial->channels);
 327                         AST_LIST_REMOVE(&dial->channels, channel, list);
 328                         AST_LIST_INSERT_HEAD(&dial->channels, channel, list);
 329                         AST_LIST_UNLOCK(&dial->channels);
 330                         set_state(dial, AST_DIAL_RESULT_ANSWERED);
 331                         break;
 332                 case AST_CONTROL_BUSY:
 333                         if (option_verbose > 2)
 334                                 ast_verbose(VERBOSE_PREFIX_3 "%s is busy\n", channel->owner->name);
 335                         ast_hangup(channel->owner);
 336                         channel->owner = NULL;
 337                         break;
 338                 case AST_CONTROL_CONGESTION:
 339                         if (option_verbose > 2)
 340                                 ast_verbose(VERBOSE_PREFIX_3 "%s is circuit-busy\n", channel->owner->name);
 341                         ast_hangup(channel->owner);
 342                         channel->owner = NULL;
 343                         break;
 344                 case AST_CONTROL_RINGING:
 345                         if (option_verbose > 2)
 346                                 ast_verbose(VERBOSE_PREFIX_3 "%s is ringing\n", channel->owner->name);
 347                         ast_indicate(chan, AST_CONTROL_RINGING);
 348                         set_state(dial, AST_DIAL_RESULT_RINGING);
 349                         break;
 350                 case AST_CONTROL_PROGRESS:
 351                         if (option_verbose > 2)
 352                                 ast_verbose (VERBOSE_PREFIX_3 "%s is making progress, passing it to %s\n", channel->owner->name, chan->name);
 353                         ast_indicate(chan, AST_CONTROL_PROGRESS);
 354                         set_state(dial, AST_DIAL_RESULT_PROGRESS);
 355                         break;
 356                 case AST_CONTROL_VIDUPDATE:
 357                         if (option_verbose > 2)
 358                                 ast_verbose (VERBOSE_PREFIX_3 "%s requested a video update, passing it to %s\n", channel->owner->name, chan->name);
 359                         ast_indicate(chan, AST_CONTROL_VIDUPDATE);
 360                         break;
 361                 case AST_CONTROL_PROCEEDING:
 362                         if (option_verbose > 2)
 363                                 ast_verbose (VERBOSE_PREFIX_3 "%s is proceeding, passing it to %s\n", channel->owner->name, chan->name);
 364                         ast_indicate(chan, AST_CONTROL_PROCEEDING);
 365                         set_state(dial, AST_DIAL_RESULT_PROCEEDING);
 366                         break;
 367                 case AST_CONTROL_HOLD:
 368                         if (option_verbose > 2)
 369                                 ast_verbose(VERBOSE_PREFIX_3 "Call on %s placed on hold\n", chan->name);
 370                         ast_indicate(chan, AST_CONTROL_HOLD);
 371                         break;
 372                 case AST_CONTROL_UNHOLD:
 373                         if (option_verbose > 2)
 374                                 ast_verbose(VERBOSE_PREFIX_3 "Call on %s left from hold\n", chan->name);
 375                         ast_indicate(chan, AST_CONTROL_UNHOLD);
 376                         break;
 377                 case AST_CONTROL_OFFHOOK:
 378                 case AST_CONTROL_FLASH:
 379                         break;
 380                 case -1:
 381                         /* Prod the channel */
 382                         ast_indicate(chan, -1);
 383                         break;
 384                 default:
 385                         break;
 386                 }
 387         }
 388
 389         return;
 390 }
 391
 392 /*! \brief Helper function that handles control frames WITHOUT owner */
 393 static void handle_frame_ownerless(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_frame *fr)
 394 {
 395         /* If we have no owner we can only update the state of the dial structure, so only look at control frames */
 396         if (fr->frametype != AST_FRAME_CONTROL)
 397                 return;
 398
 399         switch (fr->subclass) {
 400         case AST_CONTROL_ANSWER:
 401                 if (option_verbose > 2)
 402                         ast_verbose( VERBOSE_PREFIX_3 "%s answered\n", channel->owner->name);
 403                 AST_LIST_LOCK(&dial->channels);
 404                 AST_LIST_REMOVE(&dial->channels, channel, list);
 405                 AST_LIST_INSERT_HEAD(&dial->channels, channel, list);
 406                 AST_LIST_UNLOCK(&dial->channels);
 407                 set_state(dial, AST_DIAL_RESULT_ANSWERED);
 408                 break;
 409         case AST_CONTROL_BUSY:
 410                 if (option_verbose > 2)
 411                         ast_verbose(VERBOSE_PREFIX_3 "%s is busy\n", channel->owner->name);
 412                 ast_hangup(channel->owner);
 413                 channel->owner = NULL;
 414                 break;
 415         case AST_CONTROL_CONGESTION:
 416                 if (option_verbose > 2)
 417                         ast_verbose(VERBOSE_PREFIX_3 "%s is circuit-busy\n", channel->owner->name);
 418                 ast_hangup(channel->owner);
 419                 channel->owner = NULL;
 420                 break;
 421         case AST_CONTROL_RINGING:
 422                 if (option_verbose > 2)
 423                         ast_verbose(VERBOSE_PREFIX_3 "%s is ringing\n", channel->owner->name);
 424                 set_state(dial, AST_DIAL_RESULT_RINGING);
 425                 break;
 426         case AST_CONTROL_PROGRESS:
 427                 if (option_verbose > 2)
 428                         ast_verbose (VERBOSE_PREFIX_3 "%s is making progress\n", channel->owner->name);
 429                 set_state(dial, AST_DIAL_RESULT_PROGRESS);
 430                 break;
 431         case AST_CONTROL_PROCEEDING:
 432                 if (option_verbose > 2)
 433                         ast_verbose (VERBOSE_PREFIX_3 "%s is proceeding\n", channel->owner->name);
 434                 set_state(dial, AST_DIAL_RESULT_PROCEEDING);
 435                 break;
 436         default:
 437                 break;
 438         }
 439
 440         return;
 441 }
 442
 443 /*! \brief Helper function that basically keeps tabs on dialing attempts */
 444 static enum ast_dial_result monitor_dial(struct ast_dial *dial, struct ast_channel *chan)
 445 {
 446         int timeout = -1, count = 0;
 447         struct ast_channel *cs[AST_MAX_WATCHERS], *who = NULL;
 448         struct ast_dial_channel *channel = NULL;
 449         struct answer_exec_struct *answer_exec = NULL;
 450
 451         set_state(dial, AST_DIAL_RESULT_TRYING);
 452
 453         /* If the "always indicate ringing" option is set, change state to ringing and indicate to the owner if present */
 454         if (dial->options[AST_DIAL_OPTION_RINGING]) {
 455                 set_state(dial, AST_DIAL_RESULT_RINGING);
 456                 if (chan)
 457                         ast_indicate(chan, AST_CONTROL_RINGING);
 458         }
 459
 460         /* Go into an infinite loop while we are trying */
 461         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)) {
 462                 int pos = 0;
 463                 struct ast_frame *fr = NULL;
 464
 465                 /* Set up channel structure array */
 466                 pos = count = 0;
 467                 if (chan)
 468                         cs[pos++] = chan;
 469
 470                 /* Add channels we are attempting to dial */
 471                 AST_LIST_LOCK(&dial->channels);
 472                 AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 473                         if (channel->owner) {
 474                                 cs[pos++] = channel->owner;
 475                                 count++;
 476                         }
 477                 }
 478                 AST_LIST_UNLOCK(&dial->channels);
 479
 480                 /* If we have no outbound channels in progress, switch state to unanswered and stop */
 481                 if (!count) {
 482                         set_state(dial, AST_DIAL_RESULT_UNANSWERED);
 483                         break;
 484                 }
 485
 486                 /* Just to be safe... */
 487                 if (dial->thread == AST_PTHREADT_STOP)
 488                         break;
 489
 490                 /* Wait for frames from channels */
 491                 who = ast_waitfor_n(cs, pos, &timeout);
 492
 493                 /* Check to see if our thread is being cancelled */
 494                 if (dial->thread == AST_PTHREADT_STOP)
 495                         break;
 496
 497                 /* If we are not being cancelled and we have no channel, then timeout was tripped */
 498                 if (!who)
 499                         continue;
 500
 501                 /* Find relative dial channel */
 502                 if (!chan || !IS_CALLER(chan, who))
 503                         channel = find_relative_dial_channel(dial, who);
 504
 505                 /* Attempt to read in a frame */
 506                 if (!(fr = ast_read(who))) {
 507                         /* If this is the caller then we switch state to hangup and stop */
 508                         if (chan && IS_CALLER(chan, who)) {
 509                                 set_state(dial, AST_DIAL_RESULT_HANGUP);
 510                                 break;
 511                         }
 512                         ast_hangup(who);
 513                         channel->owner = NULL;
 514                         continue;
 515                 }
 516
 517                 /* Process the frame */
 518                 if (chan)
 519                         handle_frame(dial, channel, fr, chan);
 520                 else
 521                         handle_frame_ownerless(dial, channel, fr);
 522
 523                 /* Free the received frame and start all over */
 524                 ast_frfree(fr);
 525         }
 526
 527         /* Do post-processing from loop */
 528         if (dial->state == AST_DIAL_RESULT_ANSWERED) {
 529                 /* Hangup everything except that which answered */
 530                 AST_LIST_LOCK(&dial->channels);
 531                 AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 532                         if (!channel->owner || channel->owner == who)
 533                                 continue;
 534                         ast_hangup(channel->owner);
 535                         channel->owner = NULL;
 536                 }
 537                 AST_LIST_UNLOCK(&dial->channels);
 538                 /* If ANSWER_EXEC is enabled as an option, execute application on answered channel */
 539                 if ((channel = find_relative_dial_channel(dial, who)) && (answer_exec = FIND_RELATIVE_OPTION(dial, channel, AST_DIAL_OPTION_ANSWER_EXEC))) {
 540                         channel->is_running_app = 1;
 541                         answer_exec_run(dial, channel, answer_exec->app, answer_exec->args);
 542                         channel->is_running_app = 0;
 543                 }
 544         } else if (dial->state == AST_DIAL_RESULT_HANGUP) {
 545                 /* Hangup everything */
 546                 AST_LIST_LOCK(&dial->channels);
 547                 AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 548                         if (!channel->owner)
 549                                 continue;
 550                         ast_hangup(channel->owner);
 551                         channel->owner = NULL;
 552                 }
 553                 AST_LIST_UNLOCK(&dial->channels);
 554         }
 555
 556         return dial->state;
 557 }
 558
 559 /*! \brief Dial async thread function */
 560 static void *async_dial(void *data)
 561 {
 562         struct ast_dial *dial = data;
 563
 564         /* This is really really simple... we basically pass monitor_dial a NULL owner and it changes it's behavior */
 565         monitor_dial(dial, NULL);
 566
 567         return NULL;
 568 }
 569
 570 /*! \brief Execute dialing synchronously or asynchronously
 571  * \note Dials channels in a dial structure.
 572  * \return Returns dial result code. (TRYING/INVALID/FAILED/ANSWERED/TIMEOUT/UNANSWERED).
 573  */
 574 enum ast_dial_result ast_dial_run(struct ast_dial *dial, struct ast_channel *chan, int async)
 575 {
 576         enum ast_dial_result res = AST_DIAL_RESULT_TRYING;
 577
 578         /* Ensure required arguments are passed */
 579         if (!dial || (!chan && !async)) {
 580                 ast_log(LOG_DEBUG, "invalid #1\n");
 581                 return AST_DIAL_RESULT_INVALID;
 582         }
 583
 584         /* If there are no channels to dial we can't very well try to dial them */
 585         if (AST_LIST_EMPTY(&dial->channels)) {
 586                 ast_log(LOG_DEBUG, "invalid #2\n");
 587                 return AST_DIAL_RESULT_INVALID;
 588         }
 589
 590         /* Dial each requested channel */
 591         if (!begin_dial(dial, chan))
 592                 return AST_DIAL_RESULT_FAILED;
 593
 594         /* If we are running async spawn a thread and send it away... otherwise block here */
 595         if (async) {
 596                 dial->state = AST_DIAL_RESULT_TRYING;
 597                 /* Try to create a thread */
 598                 if (ast_pthread_create(&dial->thread, NULL, async_dial, dial)) {
 599                         /* Failed to create the thread - hangup all dialed channels and return failed */
 600                         ast_dial_hangup(dial);
 601                         res = AST_DIAL_RESULT_FAILED;
 602                 }
 603         } else {
 604                 res = monitor_dial(dial, chan);
 605         }
 606
 607         return res;
 608 }
 609
 610 /*! \brief Return channel that answered
 611  * \note Returns the Asterisk channel that answered
 612  * \param dial Dialing structure
 613  */
 614 struct ast_channel *ast_dial_answered(struct ast_dial *dial)
 615 {
 616         if (!dial)
 617                 return NULL;
 618
 619         return ((dial->state == AST_DIAL_RESULT_ANSWERED) ? AST_LIST_FIRST(&dial->channels)->owner : NULL);
 620 }
 621
 622 /*! \brief Return state of dial
 623  * \note Returns the state of the dial attempt
 624  * \param dial Dialing structure
 625  */
 626 enum ast_dial_result ast_dial_state(struct ast_dial *dial)
 627 {
 628         return dial->state;
 629 }
 630
 631 /*! \brief Cancel async thread
 632  * \note Cancel a running async thread
 633  * \param dial Dialing structure
 634  */
 635 enum ast_dial_result ast_dial_join(struct ast_dial *dial)
 636 {
 637         pthread_t thread;
 638
 639         /* If the dial structure is not running in async, return failed */
 640         if (dial->thread == AST_PTHREADT_NULL)
 641                 return AST_DIAL_RESULT_FAILED;
 642
 643         /* Record thread */
 644         thread = dial->thread;
 645
 646         /* Boom, commence locking */
 647         ast_mutex_lock(&dial->lock);
 648
 649         /* Stop the thread */
 650         dial->thread = AST_PTHREADT_STOP;
 651
 652         /* If the answered channel is running an application we have to soft hangup it, can't just poke the thread */
 653         AST_LIST_LOCK(&dial->channels);
 654         if (AST_LIST_FIRST(&dial->channels)->is_running_app) {
 655                 struct ast_channel *chan = AST_LIST_FIRST(&dial->channels)->owner;
 656                 if (chan) {
 657                         ast_channel_lock(chan);
 658                         ast_softhangup(chan, AST_SOFTHANGUP_EXPLICIT);
 659                         ast_channel_unlock(chan);
 660                 }
 661         } else {
 662                 /* Now we signal it with SIGURG so it will break out of it's waitfor */
 663                 pthread_kill(thread, SIGURG);
 664         }
 665         AST_LIST_UNLOCK(&dial->channels);
 666
 667         /* Yay done with it */
 668         ast_mutex_unlock(&dial->lock);
 669
 670         /* Finally wait for the thread to exit */
 671         pthread_join(thread, NULL);
 672
 673         /* Yay thread is all gone */
 674         dial->thread = AST_PTHREADT_NULL;
 675
 676         return dial->state;
 677 }
 678
 679 /*! \brief Hangup channels
 680  * \note Hangup all active channels
 681  * \param dial Dialing structure
 682  */
 683 void ast_dial_hangup(struct ast_dial *dial)
 684 {
 685         struct ast_dial_channel *channel = NULL;
 686
 687         if (!dial)
 688                 return;
 689
 690         AST_LIST_LOCK(&dial->channels);
 691         AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 692                 if (channel->owner) {
 693                         ast_hangup(channel->owner);
 694                         channel->owner = NULL;
 695                 }
 696         }
 697         AST_LIST_UNLOCK(&dial->channels);
 698
 699         return;
 700 }
 701
 702 /*! \brief Destroys a dialing structure
 703  * \note Destroys (free's) the given ast_dial structure
 704  * \param dial Dialing structure to free
 705  * \return Returns 0 on success, -1 on failure
 706  */
 707 int ast_dial_destroy(struct ast_dial *dial)
 708 {
 709         int i = 0;
 710         struct ast_dial_channel *channel = NULL;
 711
 712         if (!dial)
 713                 return -1;
 714
 715         /* Hangup and deallocate all the dialed channels */
 716         AST_LIST_LOCK(&dial->channels);
 717         AST_LIST_TRAVERSE_SAFE_BEGIN(&dial->channels, channel, list) {
 718                 /* Disable any enabled options */
 719                 for (i = 0; i < AST_DIAL_OPTION_MAX; i++) {
 720                         if (!channel->options[i])
 721                                 continue;
 722                         if (option_types[i].disable)
 723                                 option_types[i].disable(channel->options[i]);
 724                         channel->options[i] = NULL;
 725                 }
 726                 /* Hang up channel if need be */
 727                 if (channel->owner) {
 728                         ast_hangup(channel->owner);
 729                         channel->owner = NULL;
 730                 }
 731                 /* Free structure */
 732                 AST_LIST_REMOVE_CURRENT(&dial->channels, list);
 733                 free(channel);
 734         }
 735         AST_LIST_TRAVERSE_SAFE_END;
 736         AST_LIST_UNLOCK(&dial->channels);
 737
 738         /* Disable any enabled options globally */
 739         for (i = 0; i < AST_DIAL_OPTION_MAX; i++) {
 740                 if (!dial->options[i])
 741                         continue;
 742                 if (option_types[i].disable)
 743                         option_types[i].disable(dial->options[i]);
 744                 dial->options[i] = NULL;
 745         }
 746
 747         /* Lock be gone! */
 748         ast_mutex_destroy(&dial->lock);
 749
 750         /* Free structure */
 751         free(dial);
 752
 753         return 0;
 754 }
 755
 756 /*! \brief Enables an option globally
 757  * \param dial Dial structure to enable option on
 758  * \param option Option to enable
 759  * \param data Data to pass to this option (not always needed)
 760  * \return Returns 0 on success, -1 on failure
 761  */
 762 int ast_dial_option_global_enable(struct ast_dial *dial, enum ast_dial_option option, void *data)
 763 {
 764         /* If the option is already enabled, return failure */
 765         if (dial->options[option])
 766                 return -1;
 767
 768         /* Execute enable callback if it exists, if not simply make sure the value is set */
 769         if (option_types[option].enable)
 770                 dial->options[option] = option_types[option].enable(data);
 771         else
 772                 dial->options[option] = (void*)1;
 773
 774         return 0;
 775 }
 776
 777 /*! \brief Enables an option per channel
 778  * \param dial Dial structure
 779  * \param num Channel number to enable option on
 780  * \param option Option to enable
 781  * \param data Data to pass to this option (not always needed)
 782  * \return Returns 0 on success, -1 on failure
 783  */
 784 int ast_dial_option_enable(struct ast_dial *dial, int num, enum ast_dial_option option, void *data)
 785 {
 786         struct ast_dial_channel *channel = NULL;
 787
 788         /* Ensure we have required arguments */
 789         if (!dial || AST_LIST_EMPTY(&dial->channels))
 790                 return -1;
 791
 792         /* Look for channel, we can sort of cheat and predict things - the last channel in the list will probably be what they want */
 793         AST_LIST_LOCK(&dial->channels);
 794         if (AST_LIST_LAST(&dial->channels)->num != num) {
 795                 AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 796                         if (channel->num == num)
 797                                 break;
 798                 }
 799         } else {
 800                 channel = AST_LIST_LAST(&dial->channels);
 801         }
 802         AST_LIST_UNLOCK(&dial->channels);
 803
 804         /* If none found, return failure */
 805         if (!channel)
 806                 return -1;
 807
 808         /* If the option is already enabled, return failure */
 809         if (channel->options[option])
 810                 return -1;
 811
 812         /* Execute enable callback if it exists, if not simply make sure the value is set */
 813         if (option_types[option].enable)
 814                 channel->options[option] = option_types[option].enable(data);
 815         else
 816                 channel->options[option] = (void*)1;
 817
 818         return 0;
 819 }
 820
 821 /*! \brief Disables an option globally
 822  * \param dial Dial structure to disable option on
 823  * \param option Option to disable
 824  * \return Returns 0 on success, -1 on failure
 825  */
 826 int ast_dial_option_global_disable(struct ast_dial *dial, enum ast_dial_option option)
 827 {
 828         /* If the option is not enabled, return failure */
 829         if (!dial->options[option])
 830                 return -1;
 831
 832         /* Execute callback of option to disable if it exists */
 833         if (option_types[option].disable)
 834                 option_types[option].disable(dial->options[option]);
 835
 836         /* Finally disable option on the structure */
 837         dial->options[option] = NULL;
 838
 839         return 0;
 840 }
 841
 842 /*! \brief Disables an option per channel
 843  * \param dial Dial structure
 844  * \param num Channel number to disable option on
 845  * \param option Option to disable
 846  * \return Returns 0 on success, -1 on failure
 847  */
 848 int ast_dial_option_disable(struct ast_dial *dial, int num, enum ast_dial_option option)
 849 {
 850         struct ast_dial_channel *channel = NULL;
 851
 852         /* Ensure we have required arguments */
 853         if (!dial || AST_LIST_EMPTY(&dial->channels))
 854                 return -1;
 855
 856         /* Look for channel, we can sort of cheat and predict things - the last channel in the list will probably be what they want */
 857         AST_LIST_LOCK(&dial->channels);
 858         if (AST_LIST_LAST(&dial->channels)->num != num) {
 859                 AST_LIST_TRAVERSE(&dial->channels, channel, list) {
 860                         if (channel->num == num)
 861                                 break;
 862                 }
 863         } else {
 864                 channel = AST_LIST_LAST(&dial->channels);
 865         }
 866         AST_LIST_UNLOCK(&dial->channels);
 867
 868         /* If none found, return failure */
 869         if (!channel)
 870                 return -1;
 871
 872         /* If the option is not enabled, return failure */
 873         if (!channel->options[option])
 874                 return -1;
 875
 876         /* Execute callback of option to disable it if it exists */
 877         if (option_types[option].disable)
 878                 option_types[option].disable(channel->options[option]);
 879
 880         /* Finally disable the option on the structure */
 881         channel->options[option] = NULL;
 882
 883         return 0;
 884 }
 885
 886 void ast_dial_set_state_callback(struct ast_dial *dial, ast_dial_state_callback callback)
 887 {
 888         dial->state_callback = callback;
 889 }