Asterisk - The Open Source Telephony Project  GIT-master-0190e70
dial.c
Go to the documentation of this file.
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 /*** MODULEINFO
27  <support_level>core</support_level>
28  ***/
29 
30 #include "asterisk.h"
31 
32 #include <sys/time.h>
33 #include <signal.h>
34 
35 #include "asterisk/channel.h"
36 #include "asterisk/utils.h"
37 #include "asterisk/lock.h"
38 #include "asterisk/linkedlists.h"
39 #include "asterisk/dial.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/musiconhold.h"
42 #include "asterisk/app.h"
43 #include "asterisk/causes.h"
45 #include "asterisk/max_forwards.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  int timeout; /*!< Maximum time allowed for dial attempts */
51  int actual_timeout; /*!< Actual timeout based on all factors (ie: channels) */
52  enum ast_dial_result state; /*!< Status of dial */
53  void *options[AST_DIAL_OPTION_MAX]; /*!< Global options */
54  ast_dial_state_callback state_callback; /*!< Status callback */
55  void *user_data; /*!< Attached user data */
56  AST_LIST_HEAD(, ast_dial_channel) channels; /*!< Channels being dialed */
57  pthread_t thread; /*!< Thread (if running in async) */
58  ast_callid callid; /*!< callid (if running in async) */
59  ast_mutex_t lock; /*! Lock to protect the thread information above */
60 };
61 
62 /*! \brief Dialing channel structure. Contains per-channel dialing options, asterisk channel, and more! */
64  int num; /*!< Unique number for dialed channel */
65  int timeout; /*!< Maximum time allowed for attempt */
66  char *tech; /*!< Technology being dialed */
67  char *device; /*!< Device being dialed */
68  void *options[AST_DIAL_OPTION_MAX]; /*!< Channel specific options */
69  int cause; /*!< Cause code in case of failure */
70  unsigned int is_running_app:1; /*!< Is this running an application? */
71  char *assignedid1; /*!< UniqueID to assign channel */
72  char *assignedid2; /*!< UniqueID to assign 2nd channel */
73  struct ast_channel *owner; /*!< Asterisk channel */
74  AST_LIST_ENTRY(ast_dial_channel) list; /*!< Linked list information */
75 };
76 
77 /*! \brief Typedef for dial option enable */
78 typedef void *(*ast_dial_option_cb_enable)(void *data);
79 
80 /*! \brief Typedef for dial option disable */
81 typedef int (*ast_dial_option_cb_disable)(void *data);
82 
83 /*! \brief Structure for 'ANSWER_EXEC' option */
85  char app[AST_MAX_APP]; /*!< Application name */
86  char *args; /*!< Application arguments */
87 };
88 
89 /*! \brief Enable function for 'ANSWER_EXEC' option */
90 static void *answer_exec_enable(void *data)
91 {
92  struct answer_exec_struct *answer_exec = NULL;
93  char *app = ast_strdupa((char*)data), *args = NULL;
94 
95  /* Not giving any data to this option is bad, mmmk? */
96  if (ast_strlen_zero(app))
97  return NULL;
98 
99  /* Create new data structure */
100  if (!(answer_exec = ast_calloc(1, sizeof(*answer_exec))))
101  return NULL;
102 
103  /* Parse out application and arguments */
104  if ((args = strchr(app, ','))) {
105  *args++ = '\0';
106  answer_exec->args = ast_strdup(args);
107  }
108 
109  /* Copy application name */
110  ast_copy_string(answer_exec->app, app, sizeof(answer_exec->app));
111 
112  return answer_exec;
113 }
114 
115 /*! \brief Disable function for 'ANSWER_EXEC' option */
116 static int answer_exec_disable(void *data)
117 {
118  struct answer_exec_struct *answer_exec = data;
119 
120  /* Make sure we have a value */
121  if (!answer_exec)
122  return -1;
123 
124  /* If arguments are present, free them too */
125  if (answer_exec->args)
126  ast_free(answer_exec->args);
127 
128  /* This is simple - just free the structure */
129  ast_free(answer_exec);
130 
131  return 0;
132 }
133 
134 static void *music_enable(void *data)
135 {
136  return ast_strdup(data);
137 }
138 
139 static int music_disable(void *data)
140 {
141  if (!data)
142  return -1;
143 
144  ast_free(data);
145 
146  return 0;
147 }
148 
149 static void *predial_enable(void *data)
150 {
151  return ast_strdup(data);
152 }
153 
154 static int predial_disable(void *data)
155 {
156  if (!data) {
157  return -1;
158  }
159 
160  ast_free(data);
161 
162  return 0;
163 }
164 
165 /*! \brief Application execution function for 'ANSWER_EXEC' option */
166 static void answer_exec_run(struct ast_dial *dial, struct ast_dial_channel *dial_channel, char *app, char *args)
167 {
168  struct ast_channel *chan = dial_channel->owner;
169  struct ast_app *ast_app = pbx_findapp(app);
170 
171  /* If the application was not found, return immediately */
172  if (!ast_app)
173  return;
174 
175  /* All is well... execute the application */
176  pbx_exec(chan, ast_app, args);
177 
178  /* If another thread is not taking over hang up the channel */
179  ast_mutex_lock(&dial->lock);
180  if (dial->thread != AST_PTHREADT_STOP) {
181  ast_hangup(chan);
182  dial_channel->owner = NULL;
183  }
184  ast_mutex_unlock(&dial->lock);
185 
186  return;
187 }
188 
190  enum ast_dial_option option;
193 };
194 
195 /*!
196  * \brief Map options to respective handlers (enable/disable).
197  *
198  * \note This list MUST be perfectly kept in order with enum
199  * ast_dial_option, or else madness will happen.
200  */
201 static const struct ast_option_types option_types[] = {
202  { AST_DIAL_OPTION_RINGING, NULL, NULL }, /*!< Always indicate ringing to caller */
203  { AST_DIAL_OPTION_ANSWER_EXEC, answer_exec_enable, answer_exec_disable }, /*!< Execute application upon answer in async mode */
204  { AST_DIAL_OPTION_MUSIC, music_enable, music_disable }, /*!< Play music to the caller instead of ringing */
205  { AST_DIAL_OPTION_DISABLE_CALL_FORWARDING, NULL, NULL }, /*!< Disable call forwarding on channels */
206  { AST_DIAL_OPTION_PREDIAL, predial_enable, predial_disable }, /*!< Execute a subroutine on the outbound channels prior to dialing */
207  { AST_DIAL_OPTION_DIAL_REPLACES_SELF, NULL, NULL }, /*!< The dial operation is a replacement for the requester */
208  { AST_DIAL_OPTION_SELF_DESTROY, NULL, NULL}, /*!< Destroy self at end of ast_dial_run */
209  { AST_DIAL_OPTION_MAX, NULL, NULL }, /*!< Terminator of list */
210 };
211 
212 /*! \brief Maximum number of channels we can watch at a time */
213 #define AST_MAX_WATCHERS 256
214 
215 /*! \brief Macro for finding the option structure to use on a dialed channel */
216 #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])
217 
218 /*! \brief Macro that determines whether a channel is the caller or not */
219 #define IS_CALLER(chan, owner) (chan == owner ? 1 : 0)
220 
221 /*! \brief New dialing structure
222  * \note Create a dialing structure
223  * \return Returns a calloc'd ast_dial structure, NULL on failure
224  */
226 {
227  struct ast_dial *dial = NULL;
228 
229  /* Allocate new memory for structure */
230  if (!(dial = ast_calloc(1, sizeof(*dial))))
231  return NULL;
232 
233  /* Initialize list of channels */
235 
236  /* Initialize thread to NULL */
237  dial->thread = AST_PTHREADT_NULL;
238 
239  /* No timeout exists... yet */
240  dial->timeout = -1;
241  dial->actual_timeout = -1;
242 
243  /* Can't forget about the lock */
244  ast_mutex_init(&dial->lock);
245 
246  return dial;
247 }
248 
249 static int dial_append_common(struct ast_dial *dial, struct ast_dial_channel *channel,
250  const char *tech, const char *device, const struct ast_assigned_ids *assignedids)
251 {
252  /* Record technology and device for when we actually dial */
253  channel->tech = ast_strdup(tech);
254  channel->device = ast_strdup(device);
255 
256  /* Store the assigned id */
257  if (assignedids && !ast_strlen_zero(assignedids->uniqueid)) {
258  channel->assignedid1 = ast_strdup(assignedids->uniqueid);
259 
260  if (!ast_strlen_zero(assignedids->uniqueid2)) {
261  channel->assignedid2 = ast_strdup(assignedids->uniqueid2);
262  }
263  }
264 
265  /* Grab reference number from dial structure */
266  channel->num = ast_atomic_fetchadd_int(&dial->num, +1);
267 
268  /* No timeout exists... yet */
269  channel->timeout = -1;
270 
271  /* Insert into channels list */
272  AST_LIST_INSERT_TAIL(&dial->channels, channel, list);
273 
274  return channel->num;
275 
276 }
277 
278 /*! \brief Append a channel
279  * \note Appends a channel to a dialing structure
280  * \return Returns channel reference number on success, -1 on failure
281  */
282 int ast_dial_append(struct ast_dial *dial, const char *tech, const char *device, const struct ast_assigned_ids *assignedids)
283 {
284  struct ast_dial_channel *channel = NULL;
285 
286  /* Make sure we have required arguments */
287  if (!dial || !tech || !device)
288  return -1;
289 
290  /* Allocate new memory for dialed channel structure */
291  if (!(channel = ast_calloc(1, sizeof(*channel))))
292  return -1;
293 
294  return dial_append_common(dial, channel, tech, device, assignedids);
295 }
296 
297 int ast_dial_append_channel(struct ast_dial *dial, struct ast_channel *chan)
298 {
299  struct ast_dial_channel *channel;
300  char *tech;
301  char *device;
302  char *dash;
303 
304  if (!dial || !chan) {
305  return -1;
306  }
307 
308  channel = ast_calloc(1, sizeof(*channel));
309  if (!channel) {
310  return -1;
311  }
312  channel->owner = chan;
313 
314  tech = ast_strdupa(ast_channel_name(chan));
315 
316  device = strchr(tech, '/');
317  if (!device) {
318  ast_free(channel);
319  return -1;
320  }
321  *device++ = '\0';
322 
323  dash = strrchr(device, '-');
324  if (dash) {
325  *dash = '\0';
326  }
327 
328  return dial_append_common(dial, channel, tech, device, NULL);
329 }
330 
331 /*! \brief Helper function that requests all channels */
332 static int begin_dial_prerun(struct ast_dial_channel *channel, struct ast_channel *chan, struct ast_format_cap *cap, const char *predial_string)
333 {
334  struct ast_format_cap *cap_all_audio = NULL;
335  struct ast_format_cap *cap_request;
336  struct ast_format_cap *requester_cap = NULL;
337  struct ast_assigned_ids assignedids = {
338  .uniqueid = channel->assignedid1,
339  .uniqueid2 = channel->assignedid2,
340  };
341 
342  if (chan) {
343  int max_forwards;
344 
345  ast_channel_lock(chan);
346  max_forwards = ast_max_forwards_get(chan);
347  requester_cap = ao2_bump(ast_channel_nativeformats(chan));
348  ast_channel_unlock(chan);
349 
350  if (max_forwards <= 0) {
351  ast_log(LOG_WARNING, "Cannot dial from channel '%s'. Max forwards exceeded\n",
352  ast_channel_name(chan));
353  }
354  }
355 
356  if (!channel->owner) {
357  if (cap && ast_format_cap_count(cap)) {
358  cap_request = cap;
359  } else if (requester_cap) {
360  cap_request = requester_cap;
361  } else {
364  cap_request = cap_all_audio;
365  }
366 
367  /* If we fail to create our owner channel bail out */
368  if (!(channel->owner = ast_request(channel->tech, cap_request, &assignedids, chan, channel->device, &channel->cause))) {
369  ao2_cleanup(cap_all_audio);
370  return -1;
371  }
372  cap_request = NULL;
373  ao2_cleanup(requester_cap);
374  ao2_cleanup(cap_all_audio);
375  }
376 
377  if (chan) {
378  ast_channel_lock_both(chan, channel->owner);
379  } else {
380  ast_channel_lock(channel->owner);
381  }
382 
384 
385  ast_channel_appl_set(channel->owner, "AppDial2");
386  ast_channel_data_set(channel->owner, "(Outgoing Line)");
387 
388  memset(ast_channel_whentohangup(channel->owner), 0, sizeof(*ast_channel_whentohangup(channel->owner)));
389 
390  /* Inherit everything from he who spawned this dial */
391  if (chan) {
392  ast_channel_inherit_variables(chan, channel->owner);
393  ast_channel_datastore_inherit(chan, channel->owner);
395 
396  /* Copy over callerid information */
398 
400 
402 
403  ast_channel_language_set(channel->owner, ast_channel_language(chan));
406  } else {
408  }
410  ast_channel_musicclass_set(channel->owner, ast_channel_musicclass(chan));
411 
414  ast_channel_unlock(chan);
415  }
416 
418  ast_channel_unlock(channel->owner);
419 
420  if (!ast_strlen_zero(predial_string)) {
421  if (chan) {
422  ast_autoservice_start(chan);
423  }
424  ast_pre_call(channel->owner, predial_string);
425  if (chan) {
426  ast_autoservice_stop(chan);
427  }
428  }
429 
430  return 0;
431 }
432 
433 int ast_dial_prerun(struct ast_dial *dial, struct ast_channel *chan, struct ast_format_cap *cap)
434 {
435  struct ast_dial_channel *channel;
436  int res = -1;
437  char *predial_string = dial->options[AST_DIAL_OPTION_PREDIAL];
438 
439  AST_LIST_LOCK(&dial->channels);
440  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
441  if ((res = begin_dial_prerun(channel, chan, cap, predial_string))) {
442  break;
443  }
444  }
445  AST_LIST_UNLOCK(&dial->channels);
446 
447  return res;
448 }
449 
450 /*! \brief Helper function that does the beginning dialing per-appended channel */
451 static int begin_dial_channel(struct ast_dial_channel *channel, struct ast_channel *chan, int async, const char *predial_string, struct ast_channel *forwarder_chan)
452 {
453  int res = 1;
454  char forwarder[AST_CHANNEL_NAME];
455 
456  /* If no owner channel exists yet execute pre-run */
457  if (!channel->owner && begin_dial_prerun(channel, chan, NULL, predial_string)) {
458  return 0;
459  }
460 
461  if (forwarder_chan) {
462  ast_copy_string(forwarder, ast_channel_name(forwarder_chan), sizeof(forwarder));
463  ast_channel_lock(channel->owner);
464  pbx_builtin_setvar_helper(channel->owner, "FORWARDERNAME", forwarder);
465  ast_channel_unlock(channel->owner);
466  }
467 
468  /* Attempt to actually call this device */
469  if ((res = ast_call(channel->owner, channel->device, 0))) {
470  res = 0;
471  ast_hangup(channel->owner);
472  channel->owner = NULL;
473  } else {
474  ast_channel_publish_dial(async ? NULL : chan, channel->owner, channel->device, NULL);
475  res = 1;
476  ast_verb(3, "Called %s\n", channel->device);
477  }
478 
479  return res;
480 }
481 
482 /*! \brief Helper function that does the beginning dialing per dial structure */
483 static int begin_dial(struct ast_dial *dial, struct ast_channel *chan, int async)
484 {
485  struct ast_dial_channel *channel = NULL;
486  int success = 0;
487  char *predial_string = dial->options[AST_DIAL_OPTION_PREDIAL];
488 
489  /* Iterate through channel list, requesting and calling each one */
490  AST_LIST_LOCK(&dial->channels);
491  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
492  success += begin_dial_channel(channel, chan, async, predial_string, NULL);
493  }
494  AST_LIST_UNLOCK(&dial->channels);
495 
496  /* If number of failures matches the number of channels, then this truly failed */
497  return success;
498 }
499 
500 /*! \brief Helper function to handle channels that have been call forwarded */
501 static int handle_call_forward(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_channel *chan)
502 {
503  struct ast_channel *original = channel->owner;
504  char *tmp = ast_strdupa(ast_channel_call_forward(channel->owner));
505  char *tech = "Local", *device = tmp, *stuff;
506  char *predial_string = dial->options[AST_DIAL_OPTION_PREDIAL];
507 
508  /* If call forwarding is disabled just drop the original channel and don't attempt to dial the new one */
510  ast_hangup(original);
511  channel->owner = NULL;
512  return 0;
513  }
514 
515  /* Figure out the new destination */
516  if ((stuff = strchr(tmp, '/'))) {
517  *stuff++ = '\0';
518  tech = tmp;
519  device = stuff;
520  } else {
521  const char *forward_context;
522  char destination[AST_MAX_CONTEXT + AST_MAX_EXTENSION + 1];
523 
524  ast_channel_lock(original);
525  forward_context = pbx_builtin_getvar_helper(original, "FORWARD_CONTEXT");
526  snprintf(destination, sizeof(destination), "%s@%s", tmp, S_OR(forward_context, ast_channel_context(original)));
527  ast_channel_unlock(original);
528  device = ast_strdupa(destination);
529  }
530 
531  /* Drop old destination information */
532  ast_free(channel->tech);
533  ast_free(channel->device);
534  ast_free(channel->assignedid1);
535  channel->assignedid1 = NULL;
536  ast_free(channel->assignedid2);
537  channel->assignedid2 = NULL;
538 
539  /* Update the dial channel with the new destination information */
540  channel->tech = ast_strdup(tech);
541  channel->device = ast_strdup(device);
542  AST_LIST_UNLOCK(&dial->channels);
543 
544  /* Drop the original channel */
545  channel->owner = NULL;
546 
547  /* Finally give it a go... send it out into the world */
548  begin_dial_channel(channel, chan, chan ? 0 : 1, predial_string, original);
549 
550  ast_channel_publish_dial_forward(chan, original, channel->owner, NULL, "CANCEL",
551  ast_channel_call_forward(original));
552 
553  ast_hangup(original);
554 
555  return 0;
556 }
557 
558 /*! \brief Helper function that finds the dialed channel based on owner */
560 {
561  struct ast_dial_channel *channel = NULL;
562 
563  AST_LIST_LOCK(&dial->channels);
564  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
565  if (channel->owner == owner)
566  break;
567  }
568  AST_LIST_UNLOCK(&dial->channels);
569 
570  return channel;
571 }
572 
573 static void set_state(struct ast_dial *dial, enum ast_dial_result state)
574 {
575  dial->state = state;
576 
577  if (dial->state_callback)
578  dial->state_callback(dial);
579 }
580 
581 /*! \brief Helper function that handles frames */
582 static void handle_frame(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_frame *fr, struct ast_channel *chan)
583 {
584  if (fr->frametype == AST_FRAME_CONTROL) {
585  switch (fr->subclass.integer) {
586  case AST_CONTROL_ANSWER:
587  if (chan) {
588  ast_verb(3, "%s answered %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
589  } else {
590  ast_verb(3, "%s answered\n", ast_channel_name(channel->owner));
591  }
592  AST_LIST_LOCK(&dial->channels);
593  AST_LIST_REMOVE(&dial->channels, channel, list);
594  AST_LIST_INSERT_HEAD(&dial->channels, channel, list);
595  AST_LIST_UNLOCK(&dial->channels);
596  ast_channel_publish_dial(chan, channel->owner, channel->device, "ANSWER");
598  break;
599  case AST_CONTROL_BUSY:
600  ast_verb(3, "%s is busy\n", ast_channel_name(channel->owner));
601  ast_channel_publish_dial(chan, channel->owner, channel->device, "BUSY");
602  ast_hangup(channel->owner);
603  channel->cause = AST_CAUSE_USER_BUSY;
604  channel->owner = NULL;
605  break;
607  ast_verb(3, "%s is circuit-busy\n", ast_channel_name(channel->owner));
608  ast_channel_publish_dial(chan, channel->owner, channel->device, "CONGESTION");
609  ast_hangup(channel->owner);
611  channel->owner = NULL;
612  break;
614  ast_verb(3, "%s dialed Incomplete extension %s\n", ast_channel_name(channel->owner), ast_channel_exten(channel->owner));
615  if (chan) {
617  } else {
618  ast_hangup(channel->owner);
619  channel->cause = AST_CAUSE_UNALLOCATED;
620  channel->owner = NULL;
621  }
622  break;
623  case AST_CONTROL_RINGING:
624  ast_verb(3, "%s is ringing\n", ast_channel_name(channel->owner));
625  ast_channel_publish_dial(chan, channel->owner, channel->device, "RINGING");
626  if (chan && !dial->options[AST_DIAL_OPTION_MUSIC])
629  break;
631  ast_channel_publish_dial(chan, channel->owner, channel->device, "PROGRESS");
632  if (chan) {
633  ast_verb(3, "%s is making progress, passing it to %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
635  } else {
636  ast_verb(3, "%s is making progress\n", ast_channel_name(channel->owner));
637  }
639  break;
641  if (!chan) {
642  break;
643  }
644  ast_verb(3, "%s requested a video update, passing it to %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
646  break;
648  if (!chan) {
649  break;
650  }
651  ast_verb(3, "%s requested a source update, passing it to %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
653  break;
655  if (!chan) {
656  break;
657  }
658  ast_verb(3, "%s connected line has changed, passing it to %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
659  if (ast_channel_connected_line_sub(channel->owner, chan, fr, 1) &&
660  ast_channel_connected_line_macro(channel->owner, chan, fr, 1, 1)) {
662  }
663  break;
665  if (!chan) {
666  break;
667  }
668  ast_verb(3, "%s redirecting info has changed, passing it to %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
669  if (ast_channel_redirecting_sub(channel->owner, chan, fr, 1) &&
670  ast_channel_redirecting_macro(channel->owner, chan, fr, 1, 1)) {
672  }
673  break;
675  ast_channel_publish_dial(chan, channel->owner, channel->device, "PROCEEDING");
676  if (chan) {
677  ast_verb(3, "%s is proceeding, passing it to %s\n", ast_channel_name(channel->owner), ast_channel_name(chan));
679  } else {
680  ast_verb(3, "%s is proceeding\n", ast_channel_name(channel->owner));
681  }
683  break;
684  case AST_CONTROL_HOLD:
685  if (!chan) {
686  break;
687  }
688  ast_verb(3, "Call on %s placed on hold\n", ast_channel_name(chan));
690  break;
691  case AST_CONTROL_UNHOLD:
692  if (!chan) {
693  break;
694  }
695  ast_verb(3, "Call on %s left from hold\n", ast_channel_name(chan));
697  break;
698  case AST_CONTROL_OFFHOOK:
699  case AST_CONTROL_FLASH:
700  break;
702  if (chan) {
704  }
705  break;
706  case -1:
707  if (chan) {
708  /* Prod the channel */
709  ast_indicate(chan, -1);
710  }
711  break;
712  default:
713  break;
714  }
715  }
716 }
717 
718 /*! \brief Helper function to handle when a timeout occurs on dialing attempt */
719 static int handle_timeout_trip(struct ast_dial *dial, struct timeval start)
720 {
721  struct ast_dial_channel *channel = NULL;
722  int diff = ast_tvdiff_ms(ast_tvnow(), start), lowest_timeout = -1, new_timeout = -1;
723 
724  /* If there is no difference yet return the dial timeout so we can go again, we were likely interrupted */
725  if (!diff) {
726  return dial->timeout;
727  }
728 
729  /* If the global dial timeout tripped switch the state to timeout so our channel loop will drop every channel */
730  if (diff >= dial->timeout) {
732  new_timeout = 0;
733  }
734 
735  /* Go through dropping out channels that have met their timeout */
736  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
737  if (dial->state == AST_DIAL_RESULT_TIMEOUT || diff >= channel->timeout) {
738  ast_hangup(channel->owner);
739  channel->cause = AST_CAUSE_NO_ANSWER;
740  channel->owner = NULL;
741  } else if ((lowest_timeout == -1) || (lowest_timeout > channel->timeout)) {
742  lowest_timeout = channel->timeout;
743  }
744  }
745 
746  /* Calculate the new timeout using the lowest timeout found */
747  if (lowest_timeout >= 0)
748  new_timeout = lowest_timeout - diff;
749 
750  return new_timeout;
751 }
752 
753 const char *ast_hangup_cause_to_dial_status(int hangup_cause)
754 {
755  switch(hangup_cause) {
756  case AST_CAUSE_BUSY:
757  return "BUSY";
759  return "CONGESTION";
762  return "CHANUNAVAIL";
763  case AST_CAUSE_NO_ANSWER:
764  default:
765  return "NOANSWER";
766  }
767 }
768 
769 /*! \brief Helper function that basically keeps tabs on dialing attempts */
770 static enum ast_dial_result monitor_dial(struct ast_dial *dial, struct ast_channel *chan)
771 {
772  int timeout = -1;
773  struct ast_channel *cs[AST_MAX_WATCHERS], *who = NULL;
774  struct ast_dial_channel *channel = NULL;
775  struct answer_exec_struct *answer_exec = NULL;
776  struct timeval start;
777 
779 
780  /* If the "always indicate ringing" option is set, change state to ringing and indicate to the owner if present */
781  if (dial->options[AST_DIAL_OPTION_RINGING]) {
783  if (chan)
785  } else if (chan && dial->options[AST_DIAL_OPTION_MUSIC] &&
787  char *original_moh = ast_strdupa(ast_channel_musicclass(chan));
788  ast_indicate(chan, -1);
789  ast_channel_musicclass_set(chan, dial->options[AST_DIAL_OPTION_MUSIC]);
791  ast_channel_musicclass_set(chan, original_moh);
792  }
793 
794  /* Record start time for timeout purposes */
795  start = ast_tvnow();
796 
797  /* We actually figured out the maximum timeout we can do as they were added, so we can directly access the info */
798  timeout = dial->actual_timeout;
799 
800  /* Go into an infinite loop while we are trying */
801  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)) {
802  int pos = 0, count = 0;
803  struct ast_frame *fr = NULL;
804 
805  /* Set up channel structure array */
806  pos = count = 0;
807  if (chan)
808  cs[pos++] = chan;
809 
810  /* Add channels we are attempting to dial */
811  AST_LIST_LOCK(&dial->channels);
812  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
813  if (channel->owner) {
814  cs[pos++] = channel->owner;
815  count++;
816  }
817  }
818  AST_LIST_UNLOCK(&dial->channels);
819 
820  /* If we have no outbound channels in progress, switch state to unanswered and stop */
821  if (!count) {
823  break;
824  }
825 
826  /* Just to be safe... */
827  if (dial->thread == AST_PTHREADT_STOP)
828  break;
829 
830  /* Wait for frames from channels */
831  who = ast_waitfor_n(cs, pos, &timeout);
832 
833  /* Check to see if our thread is being canceled */
834  if (dial->thread == AST_PTHREADT_STOP)
835  break;
836 
837  /* If the timeout no longer exists OR if we got no channel it basically means the timeout was tripped, so handle it */
838  if (!timeout || !who) {
839  timeout = handle_timeout_trip(dial, start);
840  continue;
841  }
842 
843  /* Find relative dial channel */
844  if (!chan || !IS_CALLER(chan, who))
845  channel = find_relative_dial_channel(dial, who);
846 
847  /* See if this channel has been forwarded elsewhere */
849  handle_call_forward(dial, channel, chan);
850  continue;
851  }
852 
853  /* Attempt to read in a frame */
854  if (!(fr = ast_read(who))) {
855  /* If this is the caller then we switch state to hangup and stop */
856  if (chan && IS_CALLER(chan, who)) {
858  break;
859  }
861  ast_hangup(who);
862  channel->owner = NULL;
863  continue;
864  }
865 
866  /* Process the frame */
867  handle_frame(dial, channel, fr, chan);
868 
869  /* Free the received frame and start all over */
870  ast_frfree(fr);
871  }
872 
873  /* Do post-processing from loop */
874  if (dial->state == AST_DIAL_RESULT_ANSWERED) {
875  /* Hangup everything except that which answered */
876  AST_LIST_LOCK(&dial->channels);
877  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
878  if (!channel->owner || channel->owner == who)
879  continue;
880  ast_channel_publish_dial(chan, channel->owner, channel->device, "CANCEL");
881  ast_hangup(channel->owner);
883  channel->owner = NULL;
884  }
885  AST_LIST_UNLOCK(&dial->channels);
886  /* If ANSWER_EXEC is enabled as an option, execute application on answered channel */
887  if ((channel = find_relative_dial_channel(dial, who)) && (answer_exec = FIND_RELATIVE_OPTION(dial, channel, AST_DIAL_OPTION_ANSWER_EXEC))) {
888  channel->is_running_app = 1;
889  answer_exec_run(dial, channel, answer_exec->app, answer_exec->args);
890  channel->is_running_app = 0;
891  }
892 
893  if (chan && dial->options[AST_DIAL_OPTION_MUSIC] &&
895  ast_moh_stop(chan);
896  }
897  } else if (dial->state == AST_DIAL_RESULT_HANGUP) {
898  /* Hangup everything */
899  AST_LIST_LOCK(&dial->channels);
900  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
901  if (!channel->owner)
902  continue;
903  ast_channel_publish_dial(chan, channel->owner, channel->device, "CANCEL");
904  ast_hangup(channel->owner);
905  channel->cause = AST_CAUSE_NORMAL_CLEARING;
906  channel->owner = NULL;
907  }
908  AST_LIST_UNLOCK(&dial->channels);
909  }
910 
912  enum ast_dial_result state = dial->state;
913 
914  ast_dial_destroy(dial);
915  return state;
916  }
917 
918  return dial->state;
919 }
920 
921 /*! \brief Dial async thread function */
922 static void *async_dial(void *data)
923 {
924  struct ast_dial *dial = data;
925  if (dial->callid) {
927  }
928 
929  /* This is really really simple... we basically pass monitor_dial a NULL owner and it changes it's behavior */
930  monitor_dial(dial, NULL);
931 
932  return NULL;
933 }
934 
935 /*! \brief Execute dialing synchronously or asynchronously
936  * \note Dials channels in a dial structure.
937  * \return Returns dial result code. (TRYING/INVALID/FAILED/ANSWERED/TIMEOUT/UNANSWERED).
938  */
939 enum ast_dial_result ast_dial_run(struct ast_dial *dial, struct ast_channel *chan, int async)
940 {
942 
943  /* Ensure required arguments are passed */
944  if (!dial) {
945  ast_debug(1, "invalid #1\n");
947  }
948 
949  /* If there are no channels to dial we can't very well try to dial them */
950  if (AST_LIST_EMPTY(&dial->channels)) {
951  ast_debug(1, "invalid #2\n");
953  }
954 
955  /* Dial each requested channel */
956  if (!begin_dial(dial, chan, async))
957  return AST_DIAL_RESULT_FAILED;
958 
959  /* If we are running async spawn a thread and send it away... otherwise block here */
960  if (async) {
961  /* reference be released at dial destruction if it isn't NULL */
964  /* Try to create a thread */
965  if (ast_pthread_create(&dial->thread, NULL, async_dial, dial)) {
966  /* Failed to create the thread - hangup all dialed channels and return failed */
967  ast_dial_hangup(dial);
969  }
970  } else {
971  res = monitor_dial(dial, chan);
972  }
973 
974  return res;
975 }
976 
977 /*! \brief Return channel that answered
978  * \note Returns the Asterisk channel that answered
979  * \param dial Dialing structure
980  */
982 {
983  if (!dial)
984  return NULL;
985 
986  return ((dial->state == AST_DIAL_RESULT_ANSWERED) ? AST_LIST_FIRST(&dial->channels)->owner : NULL);
987 }
988 
989 /*! \brief Steal the channel that answered
990  * \note Returns the Asterisk channel that answered and removes it from the dialing structure
991  * \param dial Dialing structure
992  */
994 {
995  struct ast_channel *chan = NULL;
996 
997  if (!dial)
998  return NULL;
999 
1000  if (dial->state == AST_DIAL_RESULT_ANSWERED) {
1001  chan = AST_LIST_FIRST(&dial->channels)->owner;
1002  AST_LIST_FIRST(&dial->channels)->owner = NULL;
1003  }
1004 
1005  return chan;
1006 }
1007 
1008 /*! \brief Return state of dial
1009  * \note Returns the state of the dial attempt
1010  * \param dial Dialing structure
1011  */
1013 {
1014  return dial->state;
1015 }
1016 
1017 /*! \brief Cancel async thread
1018  * \note Cancel a running async thread
1019  * \param dial Dialing structure
1020  */
1022 {
1023  pthread_t thread;
1024 
1025  /* If the dial structure is not running in async, return failed */
1026  if (dial->thread == AST_PTHREADT_NULL)
1027  return AST_DIAL_RESULT_FAILED;
1028 
1029  /* Record thread */
1030  thread = dial->thread;
1031 
1032  /* Boom, commence locking */
1033  ast_mutex_lock(&dial->lock);
1034 
1035  /* Stop the thread */
1036  dial->thread = AST_PTHREADT_STOP;
1037 
1038  /* If the answered channel is running an application we have to soft hangup it, can't just poke the thread */
1039  AST_LIST_LOCK(&dial->channels);
1040  if (AST_LIST_FIRST(&dial->channels)->is_running_app) {
1041  struct ast_channel *chan = AST_LIST_FIRST(&dial->channels)->owner;
1042  if (chan) {
1043  ast_channel_lock(chan);
1045  ast_channel_unlock(chan);
1046  }
1047  } else {
1048  /* Now we signal it with SIGURG so it will break out of it's waitfor */
1049  pthread_kill(thread, SIGURG);
1050  }
1051  AST_LIST_UNLOCK(&dial->channels);
1052 
1053  /* Yay done with it */
1054  ast_mutex_unlock(&dial->lock);
1055 
1056  /* Finally wait for the thread to exit */
1057  pthread_join(thread, NULL);
1058 
1059  /* Yay thread is all gone */
1060  dial->thread = AST_PTHREADT_NULL;
1061 
1062  return dial->state;
1063 }
1064 
1065 /*! \brief Hangup channels
1066  * \note Hangup all active channels
1067  * \param dial Dialing structure
1068  */
1069 void ast_dial_hangup(struct ast_dial *dial)
1070 {
1071  struct ast_dial_channel *channel = NULL;
1072 
1073  if (!dial)
1074  return;
1075 
1076  AST_LIST_LOCK(&dial->channels);
1077  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
1078  ast_hangup(channel->owner);
1079  channel->owner = NULL;
1080  }
1081  AST_LIST_UNLOCK(&dial->channels);
1082 
1083  return;
1084 }
1085 
1086 /*! \brief Destroys a dialing structure
1087  * \note Destroys (free's) the given ast_dial structure
1088  * \param dial Dialing structure to free
1089  * \return Returns 0 on success, -1 on failure
1090  */
1091 int ast_dial_destroy(struct ast_dial *dial)
1092 {
1093  int i = 0;
1094  struct ast_dial_channel *channel = NULL;
1095 
1096  if (!dial)
1097  return -1;
1098 
1099  /* Hangup and deallocate all the dialed channels */
1100  AST_LIST_LOCK(&dial->channels);
1101  AST_LIST_TRAVERSE_SAFE_BEGIN(&dial->channels, channel, list) {
1102  /* Disable any enabled options */
1103  for (i = 0; i < AST_DIAL_OPTION_MAX; i++) {
1104  if (!channel->options[i])
1105  continue;
1106  if (option_types[i].disable)
1107  option_types[i].disable(channel->options[i]);
1108  channel->options[i] = NULL;
1109  }
1110 
1111  /* Hang up channel if need be */
1112  ast_hangup(channel->owner);
1113  channel->owner = NULL;
1114 
1115  /* Free structure */
1116  ast_free(channel->tech);
1117  ast_free(channel->device);
1118  ast_free(channel->assignedid1);
1119  ast_free(channel->assignedid2);
1120 
1122  ast_free(channel);
1123  }
1125  AST_LIST_UNLOCK(&dial->channels);
1126 
1127  /* Disable any enabled options globally */
1128  for (i = 0; i < AST_DIAL_OPTION_MAX; i++) {
1129  if (!dial->options[i])
1130  continue;
1131  if (option_types[i].disable)
1132  option_types[i].disable(dial->options[i]);
1133  dial->options[i] = NULL;
1134  }
1135 
1136  /* Lock be gone! */
1137  ast_mutex_destroy(&dial->lock);
1138 
1139  /* Free structure */
1140  ast_free(dial);
1141 
1142  return 0;
1143 }
1144 
1145 /*! \brief Enables an option globally
1146  * \param dial Dial structure to enable option on
1147  * \param option Option to enable
1148  * \param data Data to pass to this option (not always needed)
1149  * \return Returns 0 on success, -1 on failure
1150  */
1151 int ast_dial_option_global_enable(struct ast_dial *dial, enum ast_dial_option option, void *data)
1152 {
1153  /* If the option is already enabled, return failure */
1154  if (dial->options[option])
1155  return -1;
1156 
1157  /* Execute enable callback if it exists, if not simply make sure the value is set */
1158  if (option_types[option].enable)
1159  dial->options[option] = option_types[option].enable(data);
1160  else
1161  dial->options[option] = (void*)1;
1162 
1163  return 0;
1164 }
1165 
1166 /*! \brief Helper function for finding a channel in a dial structure based on number
1167  */
1168 static struct ast_dial_channel *find_dial_channel(struct ast_dial *dial, int num)
1169 {
1170  struct ast_dial_channel *channel = AST_LIST_LAST(&dial->channels);
1171 
1172  /* We can try to predict programmer behavior, the last channel they added is probably the one they wanted to modify */
1173  if (channel->num == num)
1174  return channel;
1175 
1176  /* Hrm not at the end... looking through the list it is! */
1177  AST_LIST_LOCK(&dial->channels);
1178  AST_LIST_TRAVERSE(&dial->channels, channel, list) {
1179  if (channel->num == num)
1180  break;
1181  }
1182  AST_LIST_UNLOCK(&dial->channels);
1183 
1184  return channel;
1185 }
1186 
1187 /*! \brief Enables an option per channel
1188  * \param dial Dial structure
1189  * \param num Channel number to enable option on
1190  * \param option Option to enable
1191  * \param data Data to pass to this option (not always needed)
1192  * \return Returns 0 on success, -1 on failure
1193  */
1194 int ast_dial_option_enable(struct ast_dial *dial, int num, enum ast_dial_option option, void *data)
1195 {
1196  struct ast_dial_channel *channel = NULL;
1197 
1198  /* Ensure we have required arguments */
1199  if (!dial || AST_LIST_EMPTY(&dial->channels))
1200  return -1;
1201 
1202  if (!(channel = find_dial_channel(dial, num)))
1203  return -1;
1204 
1205  /* If the option is already enabled, return failure */
1206  if (channel->options[option])
1207  return -1;
1208 
1209  /* Execute enable callback if it exists, if not simply make sure the value is set */
1210  if (option_types[option].enable)
1211  channel->options[option] = option_types[option].enable(data);
1212  else
1213  channel->options[option] = (void*)1;
1214 
1215  return 0;
1216 }
1217 
1218 /*! \brief Disables an option globally
1219  * \param dial Dial structure to disable option on
1220  * \param option Option to disable
1221  * \return Returns 0 on success, -1 on failure
1222  */
1224 {
1225  /* If the option is not enabled, return failure */
1226  if (!dial->options[option]) {
1227  return -1;
1228  }
1229 
1230  /* Execute callback of option to disable if it exists */
1231  if (option_types[option].disable)
1232  option_types[option].disable(dial->options[option]);
1233 
1234  /* Finally disable option on the structure */
1235  dial->options[option] = NULL;
1236 
1237  return 0;
1238 }
1239 
1240 /*! \brief Disables an option per channel
1241  * \param dial Dial structure
1242  * \param num Channel number to disable option on
1243  * \param option Option to disable
1244  * \return Returns 0 on success, -1 on failure
1245  */
1246 int ast_dial_option_disable(struct ast_dial *dial, int num, enum ast_dial_option option)
1247 {
1248  struct ast_dial_channel *channel = NULL;
1249 
1250  /* Ensure we have required arguments */
1251  if (!dial || AST_LIST_EMPTY(&dial->channels))
1252  return -1;
1253 
1254  if (!(channel = find_dial_channel(dial, num)))
1255  return -1;
1256 
1257  /* If the option is not enabled, return failure */
1258  if (!channel->options[option])
1259  return -1;
1260 
1261  /* Execute callback of option to disable it if it exists */
1262  if (option_types[option].disable)
1263  option_types[option].disable(channel->options[option]);
1264 
1265  /* Finally disable the option on the structure */
1266  channel->options[option] = NULL;
1267 
1268  return 0;
1269 }
1270 
1271 int ast_dial_reason(struct ast_dial *dial, int num)
1272 {
1273  struct ast_dial_channel *channel;
1274 
1275  if (!dial || AST_LIST_EMPTY(&dial->channels) || !(channel = find_dial_channel(dial, num))) {
1276  return -1;
1277  }
1278 
1279  return channel->cause;
1280 }
1281 
1282 struct ast_channel *ast_dial_get_channel(struct ast_dial *dial, int num)
1283 {
1284  struct ast_dial_channel *channel;
1285 
1286  if (!dial || AST_LIST_EMPTY(&dial->channels) || !(channel = find_dial_channel(dial, num))) {
1287  return NULL;
1288  }
1289 
1290  return channel->owner;
1291 }
1292 
1294 {
1295  dial->state_callback = callback;
1296 }
1297 
1298 void ast_dial_set_user_data(struct ast_dial *dial, void *user_data)
1299 {
1300  dial->user_data = user_data;
1301 }
1302 
1304 {
1305  return dial->user_data;
1306 }
1307 
1308 /*! \brief Set the maximum time (globally) allowed for trying to ring phones
1309  * \param dial The dial structure to apply the time limit to
1310  * \param timeout Maximum time allowed
1311  * \return nothing
1312  */
1314 {
1315  dial->timeout = timeout;
1316 
1317  if (dial->timeout > 0 && (dial->actual_timeout > dial->timeout || dial->actual_timeout == -1))
1318  dial->actual_timeout = dial->timeout;
1319 
1320  return;
1321 }
1322 
1323 /*! \brief Set the maximum time (per channel) allowed for trying to ring the phone
1324  * \param dial The dial structure the channel belongs to
1325  * \param num Channel number to set timeout on
1326  * \param timeout Maximum time allowed
1327  * \return nothing
1328  */
1329 void ast_dial_set_timeout(struct ast_dial *dial, int num, int timeout)
1330 {
1331  struct ast_dial_channel *channel = NULL;
1332 
1333  if (!(channel = find_dial_channel(dial, num)))
1334  return;
1335 
1336  channel->timeout = timeout;
1337 
1338  if (channel->timeout > 0 && (dial->actual_timeout > channel->timeout || dial->actual_timeout == -1))
1339  dial->actual_timeout = channel->timeout;
1340 
1341  return;
1342 }
char * args
Definition: dial.c:86
int ast_dial_option_global_enable(struct ast_dial *dial, enum ast_dial_option option, void *data)
Enables an option globally.
Definition: dial.c:1151
struct ast_party_caller * ast_channel_caller(struct ast_channel *chan)
struct ast_channel * ast_waitfor_n(struct ast_channel **chan, int n, int *ms)
Waits for input on a group of channels Wait for input on an array of channels for a given # of millis...
Definition: channel.c:3152
static void answer_exec_run(struct ast_dial *dial, struct ast_dial_channel *dial_channel, char *app, char *args)
Application execution function for &#39;ANSWER_EXEC&#39; option.
Definition: dial.c:166
#define ast_channel_lock(chan)
Definition: channel.h:2890
Main Channel structure associated with a channel.
int ast_dial_append_channel(struct ast_dial *dial, struct ast_channel *chan)
Append a channel using an actual channel object.
Definition: dial.c:297
Music on hold handling.
int ast_max_forwards_get(struct ast_channel *chan)
Get the current max forwards for a particular channel.
Definition: max_forwards.c:121
int ast_dial_reason(struct ast_dial *dial, int num)
Get the reason an outgoing channel has failed.
Definition: dial.c:1271
static void set_state(struct ast_dial *dial, enum ast_dial_result state)
Definition: dial.c:573
#define AST_LIST_LOCK(head)
Locks a list.
Definition: linkedlists.h:39
Asterisk locking-related definitions:
Asterisk main include file. File version handling, generic pbx functions.
#define AST_LIST_FIRST(head)
Returns the first entry contained in a list.
Definition: linkedlists.h:420
int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int is_caller, int frame)
Run a connected line interception macro and update a channel&#39;s connected line information.
Definition: channel.c:10292
int(* ast_dial_option_cb_disable)(void *data)
Typedef for dial option disable.
Definition: dial.c:81
unsigned int is_running_app
Definition: dial.c:70
#define AST_LIST_HEAD(name, type)
Defines a structure to be used to hold a list of specified type.
Definition: linkedlists.h:172
void ast_dial_set_global_timeout(struct ast_dial *dial, int timeout)
Set the maximum time (globally) allowed for trying to ring phones.
Definition: dial.c:1313
void ast_dial_set_state_callback(struct ast_dial *dial, ast_dial_state_callback callback)
Set a callback for state changes.
Definition: dial.c:1293
int ast_autoservice_start(struct ast_channel *chan)
Automatically service a channel for us...
Definition: autoservice.c:200
unsigned short ast_channel_transfercapability(const struct ast_channel *chan)
int pbx_exec(struct ast_channel *c, struct ast_app *app, const char *data)
Execute an application.
Definition: pbx_app.c:471
Main dialing structure. Contains global options, channels being dialed, and more! ...
Definition: dial.c:48
void ast_dial_hangup(struct ast_dial *dial)
Hangup channels.
Definition: dial.c:1069
static struct ast_dial_channel * find_relative_dial_channel(struct ast_dial *dial, struct ast_channel *owner)
Helper function that finds the dialed channel based on owner.
Definition: dial.c:559
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition: channel.c:4291
int ast_dial_prerun(struct ast_dial *dial, struct ast_channel *chan, struct ast_format_cap *cap)
Request all appended channels, but do not dial.
Definition: dial.c:433
void ast_channel_publish_dial(struct ast_channel *caller, struct ast_channel *peer, const char *dialstring, const char *dialstatus)
Publish in the ast_channel_topic or ast_channel_topic_all topics a stasis message for the channels in...
void ast_channel_appl_set(struct ast_channel *chan, const char *value)
#define AST_CAUSE_UNALLOCATED
Definition: causes.h:97
enum ast_dial_result state
Definition: dial.c:52
#define LOG_WARNING
Definition: logger.h:274
#define AST_LIST_UNLOCK(head)
Attempts to unlock a list.
Definition: linkedlists.h:139
union ast_frame::@257 data
struct ast_dial * ast_dial_create(void)
New dialing structure.
Definition: dial.c:225
struct ast_channel * ast_dial_get_channel(struct ast_dial *dial, int num)
Get the dialing channel, if prerun has been executed.
Definition: dial.c:1282
static int tmp()
Definition: bt_open.c:389
int ast_call(struct ast_channel *chan, const char *addr, int timeout)
Make a call.
Definition: channel.c:6445
int ast_dial_option_disable(struct ast_dial *dial, int num, enum ast_dial_option option)
Disables an option per channel.
Definition: dial.c:1246
const char * ast_hangup_cause_to_dial_status(int hangup_cause)
Convert a hangup cause to a publishable dial status.
Definition: dial.c:753
struct ast_frame * ast_read(struct ast_channel *chan)
Reads a frame.
Definition: channel.c:4271
Structure to pass both assignedid values to channel drivers.
Definition: channel.h:605
void ast_dial_set_user_data(struct ast_dial *dial, void *user_data)
Set user data on a dial structure.
Definition: dial.c:1298
int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen)
Indicates condition of channel, with payload.
Definition: channel.c:4667
Dialing API.
struct ast_channel * ast_dial_answered_steal(struct ast_dial *dial)
Steal the channel that answered.
Definition: dial.c:993
int ast_format_cap_append_by_type(struct ast_format_cap *cap, enum ast_media_type type)
Add all codecs Asterisk knows about for a specific type to the capabilities structure.
Definition: format_cap.c:216
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:150
size_t ast_format_cap_count(const struct ast_format_cap *cap)
Get the number of formats present within the capabilities structure.
Definition: format_cap.c:395
static int begin_dial(struct ast_dial *dial, struct ast_channel *chan, int async)
Helper function that does the beginning dialing per dial structure.
Definition: dial.c:483
char * assignedid2
Definition: dial.c:72
unsigned int ast_callid
Definition: logger.h:87
const char * uniqueid
Definition: channel.h:606
#define AST_LIST_EMPTY(head)
Checks whether the specified list contains any entries.
Definition: linkedlists.h:449
#define FIND_RELATIVE_OPTION(dial, dial_channel, ast_dial_option)
Macro for finding the option structure to use on a dialed channel.
Definition: dial.c:216
#define ast_mutex_lock(a)
Definition: lock.h:187
Definition: muted.c:95
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:98
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:243
ast_callid callid
Definition: dial.c:58
const char * args
#define NULL
Definition: resample.c:96
const char * data
#define AST_CAUSE_NORMAL_CIRCUIT_CONGESTION
Definition: causes.h:119
#define AST_LIST_REMOVE(head, elm, field)
Removes a specific entry from a list.
Definition: linkedlists.h:855
int ast_dial_append(struct ast_dial *dial, const char *tech, const char *device, const struct ast_assigned_ids *assignedids)
Append a channel.
Definition: dial.c:282
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition: linkedlists.h:614
void ast_moh_stop(struct ast_channel *chan)
Turn off music on hold on a given channel.
Definition: channel.c:7739
const char * ast_channel_call_forward(const struct ast_channel *chan)
#define AST_MAX_WATCHERS
Maximum number of channels we can watch at a time.
Definition: dial.c:213
#define ast_verb(level,...)
Definition: logger.h:455
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition: lock.h:755
const char * pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name)
Return a pointer to the value of the corresponding channel variable.
struct ast_frame_subclass subclass
ast_callid ast_read_threadstorage_callid(void)
extracts the callerid from the thread
Definition: logger.c:1927
Utility functions.
pthread_t thread
Definition: dial.c:57
struct ast_channel * ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause)
Requests a channel.
Definition: channel.c:6336
struct timeval * ast_channel_whentohangup(struct ast_channel *chan)
const struct ast_channel_tech * tech
#define ao2_bump(obj)
Definition: astobj2.h:491
int ast_callid_threadassoc_add(ast_callid callid)
Adds a known callid to thread storage of the calling thread.
Definition: logger.c:1949
int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to)
Inherit datastores from a parent to a child.
Definition: channel.c:2359
enum ast_dial_result ast_dial_run(struct ast_dial *dial, struct ast_channel *chan, int async)
Execute dialing synchronously or asynchronously.
Definition: dial.c:939
static int begin_dial_channel(struct ast_dial_channel *channel, struct ast_channel *chan, int async, const char *predial_string, struct ast_channel *forwarder_chan)
Helper function that does the beginning dialing per-appended channel.
Definition: dial.c:451
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:444
#define ast_log
Definition: astobj2.c:42
void * options[AST_DIAL_OPTION_MAX]
Definition: dial.c:53
ast_dial_result
List of return codes for dial run API calls.
Definition: dial.h:54
General Asterisk PBX channel definitions.
void ast_channel_stage_snapshot_done(struct ast_channel *chan)
Clear flag to indicate channel snapshot is being staged, and publish snapshot.
struct ast_party_connected_line * ast_channel_connected(struct ast_channel *chan)
int num
Definition: dial.c:49
#define AST_PTHREADT_NULL
Definition: lock.h:66
#define AST_CAUSE_ANSWERED_ELSEWHERE
Definition: causes.h:113
static int dial_append_common(struct ast_dial *dial, struct ast_dial_channel *channel, const char *tech, const char *device, const struct ast_assigned_ids *assignedids)
Definition: dial.c:249
#define AST_MAX_EXTENSION
Definition: channel.h:135
#define AST_CAUSE_NORMAL_CLEARING
Definition: causes.h:105
int ast_channel_redirecting_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *redirecting_info, int is_frame)
Run a redirecting interception subroutine and update a channel&#39;s redirecting information.
Definition: channel.c:10441
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
Definition: linkedlists.h:556
int ast_softhangup(struct ast_channel *chan, int reason)
Softly hangup up a channel.
Definition: channel.c:2462
char * tech
Definition: dial.c:66
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: astmm.h:300
A set of macros to manage forward-linked lists.
#define AST_CAUSE_NO_ANSWER
Definition: causes.h:108
struct ast_channel * ast_dial_answered(struct ast_dial *dial)
Return channel that answered.
Definition: dial.c:981
#define ast_format_cap_alloc(flags)
Definition: format_cap.h:52
int ast_pre_call(struct ast_channel *chan, const char *sub_args)
Execute a Gosub call on the channel before a call is placed.
Definition: channel.c:6428
ast_dial_option
List of options that are applicable either globally or per dialed channel.
Definition: dial.h:42
void ast_channel_req_accountcodes(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship)
Setup new channel accountcodes from the requestor channel after ast_request().
Definition: channel.c:6418
void ast_channel_adsicpe_set(struct ast_channel *chan, enum ast_channel_adsicpe value)
const char * ast_channel_exten(const struct ast_channel *chan)
Core PBX routines and definitions.
int ast_autoservice_stop(struct ast_channel *chan)
Stop servicing a channel for us...
Definition: autoservice.c:266
static void * music_enable(void *data)
Definition: dial.c:134
void * options[AST_DIAL_OPTION_MAX]
Definition: dial.c:68
void ast_channel_stage_snapshot(struct ast_channel *chan)
Set flag to indicate channel snapshot is being staged.
struct ast_channel * owner
Definition: dial.c:73
ast_dial_option_cb_enable enable
Definition: dial.c:191
void * ast_dial_get_user_data(struct ast_dial *dial)
Return the user data on a dial structure.
Definition: dial.c:1303
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:730
static int answer_exec_disable(void *data)
Disable function for &#39;ANSWER_EXEC&#39; option.
Definition: dial.c:116
Format capabilities structure, holds formats + preference order + etc.
Definition: format_cap.c:54
#define AST_MAX_APP
Definition: pbx.h:40
ast_mutex_t lock
Definition: dial.c:56
static int predial_disable(void *data)
Definition: dial.c:154
int ast_channel_connected_line_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame)
Run a connected line interception subroutine and update a channel&#39;s connected line information...
Definition: channel.c:10396
Channel datastore data for max forwards.
Definition: max_forwards.c:29
ast_channel_adsicpe
Definition: channel.h:869
static int music_disable(void *data)
Definition: dial.c:139
struct ast_party_dialed * ast_channel_dialed(struct ast_channel *chan)
int ast_moh_start(struct ast_channel *chan, const char *mclass, const char *interpclass)
Turn on music on hold on a given channel.
Definition: channel.c:7729
#define AST_LIST_LAST(head)
Returns the last entry contained in a list.
Definition: linkedlists.h:428
void ast_channel_publish_dial_forward(struct ast_channel *caller, struct ast_channel *peer, struct ast_channel *forwarded, const char *dialstring, const char *dialstatus, const char *forward)
Publish in the ast_channel_topic or ast_channel_topic_all topics a stasis message for the channels in...
struct ast_dial_channel::@376 list
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:490
static int handle_call_forward(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_channel *chan)
Helper function to handle channels that have been call forwarded.
Definition: dial.c:501
#define AST_LIST_ENTRY(type)
Declare a forward link structure inside a list entry.
Definition: linkedlists.h:409
#define ast_strlen_zero(a)
Definition: muted.c:73
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
Definition: linkedlists.h:710
static void * async_dial(void *data)
Dial async thread function.
Definition: dial.c:922
enum ast_dial_result ast_dial_state(struct ast_dial *dial)
Return state of dial.
Definition: dial.c:1012
#define ast_channel_unlock(chan)
Definition: channel.h:2891
#define AST_MAX_CONTEXT
Definition: channel.h:136
#define AST_CAUSE_UNREGISTERED
Definition: causes.h:153
void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child)
Inherits channel variable from parent to child channel.
Definition: channel.c:6729
#define AST_LIST_HEAD_INIT(head)
Initializes a list head structure.
Definition: linkedlists.h:625
#define ast_free(a)
Definition: astmm.h:182
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:204
#define ast_pthread_create(a, b, c, d)
Definition: utils.h:499
#define AST_CHANNEL_NAME
Definition: channel.h:172
static void * answer_exec_enable(void *data)
Enable function for &#39;ANSWER_EXEC&#39; option.
Definition: dial.c:90
static const struct ast_option_types option_types[]
Map options to respective handlers (enable/disable).
Definition: dial.c:201
void ast_hangup(struct ast_channel *chan)
Hang up a channel.
Definition: channel.c:2534
struct ast_dial::@375 channels
static void * predial_enable(void *data)
Definition: dial.c:149
Structure for &#39;ANSWER_EXEC&#39; option.
Definition: dial.c:84
static enum ast_dial_result monitor_dial(struct ast_dial *dial, struct ast_channel *chan)
Helper function that basically keeps tabs on dialing attempts.
Definition: dial.c:770
struct ast_party_redirecting * ast_channel_redirecting(struct ast_channel *chan)
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name...
enum ast_dial_result ast_dial_join(struct ast_dial *dial)
Cancel async thread.
Definition: dial.c:1021
static void handle_frame(struct ast_dial *dial, struct ast_dial_channel *channel, struct ast_frame *fr, struct ast_channel *chan)
Helper function that handles frames.
Definition: dial.c:582
#define ast_channel_lock_both(chan1, chan2)
Lock two channels.
Definition: channel.h:2897
void ast_dial_set_timeout(struct ast_dial *dial, int num, int timeout)
Set the maximum time (per channel) allowed for trying to ring the phone.
Definition: dial.c:1329
int transit_network_select
Transit Network Select.
Definition: channel.h:398
ast_dial_state_callback state_callback
Definition: dial.c:54
#define AST_CAUSE_NO_ROUTE_DESTINATION
Definition: causes.h:99
static struct ast_dial_channel * find_dial_channel(struct ast_dial *dial, int num)
Helper function for finding a channel in a dial structure based on number.
Definition: dial.c:1168
int ast_max_forwards_decrement(struct ast_channel *chan)
Decrement the max forwards count for a particular channel.
Definition: max_forwards.c:135
#define ao2_cleanup(obj)
Definition: astobj2.h:1958
int ast_channel_hangupcause(const struct ast_channel *chan)
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:401
void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src)
Copy the caller information to the connected line information.
Definition: channel.c:8246
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one...
Definition: strings.h:79
ast_app: A registered application
Definition: pbx_app.c:45
const char * ast_channel_name(const struct ast_channel *chan)
int timeout
Definition: dial.c:50
#define AST_CAUSE_USER_BUSY
Definition: causes.h:106
void ast_channel_transfercapability_set(struct ast_channel *chan, unsigned short value)
#define AST_PTHREADT_STOP
Definition: lock.h:67
#define ast_frfree(fr)
static int begin_dial_prerun(struct ast_dial_channel *channel, struct ast_channel *chan, struct ast_format_cap *cap, const char *predial_string)
Helper function that requests all channels.
Definition: dial.c:332
#define AST_CAUSE_BUSY
Definition: causes.h:148
Data structure associated with a single frame of data.
Internal Asterisk hangup causes.
const char * ast_channel_language(const struct ast_channel *chan)
int ast_dial_option_global_disable(struct ast_dial *dial, enum ast_dial_option option)
Disables an option globally.
Definition: dial.c:1223
ast_dial_option_cb_disable disable
Definition: dial.c:192
void * user_data
Definition: dial.c:55
int ast_dial_option_enable(struct ast_dial *dial, int num, enum ast_dial_option option, void *data)
Enables an option per channel.
Definition: dial.c:1194
const char * ast_channel_context(const struct ast_channel *chan)
char * assignedid1
Definition: dial.c:71
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition: linkedlists.h:528
enum ast_frame_type frametype
int actual_timeout
Definition: dial.c:51
#define ast_mutex_init(pmutex)
Definition: lock.h:184
char app[AST_MAX_APP]
Definition: dial.c:85
void(* ast_dial_state_callback)(struct ast_dial *)
Definition: dial.h:39
#define ast_mutex_destroy(a)
Definition: lock.h:186
struct ast_app * pbx_findapp(const char *app)
Look up an application.
Definition: ael_main.c:165
int ast_dial_destroy(struct ast_dial *dial)
Destroys a dialing structure.
Definition: dial.c:1091
static const char app[]
Definition: app_mysql.c:62
#define IS_CALLER(chan, owner)
Macro that determines whether a channel is the caller or not.
Definition: dial.c:219
void *(* ast_dial_option_cb_enable)(void *data)
Typedef for dial option enable.
Definition: dial.c:78
const char * uniqueid2
Definition: channel.h:607
Application convenience functions, designed to give consistent look and feel to Asterisk apps...
char * device
Definition: dial.c:67
#define AST_CAUSE_CONGESTION
Definition: causes.h:152
void ast_channel_data_set(struct ast_channel *chan, const char *value)
void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src)
Copy the source redirecting information to the destination redirecting.
Definition: channel.c:2121
Structure for mutex and tracking information.
Definition: lock.h:135
static int handle_timeout_trip(struct ast_dial *dial, struct timeval start)
Helper function to handle when a timeout occurs on dialing attempt.
Definition: dial.c:719
const char * ast_channel_musicclass(const struct ast_channel *chan)
int timeout
Definition: dial.c:65
int ast_channel_redirecting_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *redirecting_info, int is_caller, int is_frame)
Run a redirecting interception macro and update a channel&#39;s redirecting information.
Definition: channel.c:10344
Dialing channel structure. Contains per-channel dialing options, asterisk channel, and more!
Definition: dial.c:63
#define ast_mutex_unlock(a)
Definition: lock.h:188