61b2c26a090fc2d94095b27f6a9a1d0cc1958593
[asterisk/asterisk.git] / apps / app_dial.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2012, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 dial() & retrydial() - Trivial application to dial a channel and send an URL on answer
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \ingroup applications
26  */
27
28 /*** MODULEINFO
29         <support_level>core</support_level>
30  ***/
31
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include <sys/time.h>
38 #include <sys/signal.h>
39 #include <sys/stat.h>
40 #include <netinet/in.h>
41
42 #include "asterisk/paths.h" /* use ast_config_AST_DATA_DIR */
43 #include "asterisk/lock.h"
44 #include "asterisk/file.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/module.h"
48 #include "asterisk/translate.h"
49 #include "asterisk/say.h"
50 #include "asterisk/config.h"
51 #include "asterisk/features.h"
52 #include "asterisk/musiconhold.h"
53 #include "asterisk/callerid.h"
54 #include "asterisk/utils.h"
55 #include "asterisk/app.h"
56 #include "asterisk/causes.h"
57 #include "asterisk/rtp_engine.h"
58 #include "asterisk/manager.h"
59 #include "asterisk/privacy.h"
60 #include "asterisk/stringfields.h"
61 #include "asterisk/global_datastores.h"
62 #include "asterisk/dsp.h"
63 #include "asterisk/aoc.h"
64 #include "asterisk/ccss.h"
65 #include "asterisk/indications.h"
66 #include "asterisk/framehook.h"
67 #include "asterisk/dial.h"
68 #include "asterisk/stasis_channels.h"
69 #include "asterisk/bridge_after.h"
70 #include "asterisk/features_config.h"
71
72 /*** DOCUMENTATION
73         <application name="Dial" language="en_US">
74                 <synopsis>
75                         Attempt to connect to another device or endpoint and bridge the call.
76                 </synopsis>
77                 <syntax>
78                         <parameter name="Technology/Resource" required="true" argsep="&amp;">
79                                 <argument name="Technology/Resource" required="true">
80                                         <para>Specification of the device(s) to dial.  These must be in the format of
81                                         <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
82                                         represents a particular channel driver, and <replaceable>Resource</replaceable>
83                                         represents a resource available to that particular channel driver.</para>
84                                 </argument>
85                                 <argument name="Technology2/Resource2" required="false" multiple="true">
86                                         <para>Optional extra devices to dial in parallel</para>
87                                         <para>If you need more then one enter them as
88                                         Technology2/Resource2&amp;Technology3/Resourse3&amp;.....</para>
89                                 </argument>
90                         </parameter>
91                         <parameter name="timeout" required="false">
92                                 <para>Specifies the number of seconds we attempt to dial the specified devices</para>
93                                 <para>If not specified, this defaults to 136 years.</para>
94                         </parameter>
95                         <parameter name="options" required="false">
96                                 <optionlist>
97                                 <option name="A">
98                                         <argument name="x" required="true">
99                                                 <para>The file to play to the called party</para>
100                                         </argument>
101                                         <para>Play an announcement to the called party, where <replaceable>x</replaceable> is the prompt to be played</para>
102                                 </option>
103                                 <option name="a">
104                                         <para>Immediately answer the calling channel when the called channel answers in
105                                         all cases. Normally, the calling channel is answered when the called channel
106                                         answers, but when options such as A() and M() are used, the calling channel is
107                                         not answered until all actions on the called channel (such as playing an
108                                         announcement) are completed.  This option can be used to answer the calling
109                                         channel before doing anything on the called channel. You will rarely need to use
110                                         this option, the default behavior is adequate in most cases.</para>
111                                 </option>
112                                 <option name="b" argsep="^">
113                                         <para>Before initiating an outgoing call, Gosub to the specified
114                                         location using the newly created channel.  The Gosub will be
115                                         executed for each destination channel.</para>
116                                         <argument name="context" required="false" />
117                                         <argument name="exten" required="false" />
118                                         <argument name="priority" required="true" hasparams="optional" argsep="^">
119                                                 <argument name="arg1" multiple="true" required="true" />
120                                                 <argument name="argN" />
121                                         </argument>
122                                 </option>
123                                 <option name="B" argsep="^">
124                                         <para>Before initiating the outgoing call(s), Gosub to the specified
125                                         location using the current channel.</para>
126                                         <argument name="context" required="false" />
127                                         <argument name="exten" required="false" />
128                                         <argument name="priority" required="true" hasparams="optional" argsep="^">
129                                                 <argument name="arg1" multiple="true" required="true" />
130                                                 <argument name="argN" />
131                                         </argument>
132                                 </option>
133                                 <option name="C">
134                                         <para>Reset the call detail record (CDR) for this call.</para>
135                                 </option>
136                                 <option name="c">
137                                         <para>If the Dial() application cancels this call, always set HANGUPCAUSE to 'answered elsewhere'</para>
138                                 </option>
139                                 <option name="d">
140                                         <para>Allow the calling user to dial a 1 digit extension while waiting for
141                                         a call to be answered. Exit to that extension if it exists in the
142                                         current context, or the context defined in the <variable>EXITCONTEXT</variable> variable,
143                                         if it exists.</para>
144                                         <note>
145                                                 <para>Many SIP and ISDN phones cannot send DTMF digits until the call is
146                                                 connected.  If you wish to use this option with these phones, you
147                                                 can use the <literal>Answer</literal> application before dialing.</para>
148                                         </note>
149                                 </option>
150                                 <option name="D" argsep=":">
151                                         <argument name="called" />
152                                         <argument name="calling" />
153                                         <argument name="progress" />
154                                         <para>Send the specified DTMF strings <emphasis>after</emphasis> the called
155                                         party has answered, but before the call gets bridged.  The
156                                         <replaceable>called</replaceable> DTMF string is sent to the called party, and the
157                                         <replaceable>calling</replaceable> DTMF string is sent to the calling party.  Both arguments
158                                         can be used alone.  If <replaceable>progress</replaceable> is specified, its DTMF is sent
159                                         to the called party immediately after receiving a PROGRESS message.</para>
160                                         <para>See SendDTMF for valid digits.</para>
161                                 </option>
162                                 <option name="e">
163                                         <para>Execute the <literal>h</literal> extension for peer after the call ends</para>
164                                 </option>
165                                 <option name="f">
166                                         <argument name="x" required="false" />
167                                         <para>If <replaceable>x</replaceable> is not provided, force the CallerID sent on a call-forward or
168                                         deflection to the dialplan extension of this Dial() using a dialplan <literal>hint</literal>.
169                                         For example, some PSTNs do not allow CallerID to be set to anything
170                                         other than the numbers assigned to you.
171                                         If <replaceable>x</replaceable> is provided, force the CallerID sent to <replaceable>x</replaceable>.</para>
172                                 </option>
173                                 <option name="F" argsep="^">
174                                         <argument name="context" required="false" />
175                                         <argument name="exten" required="false" />
176                                         <argument name="priority" required="true" />
177                                         <para>When the caller hangs up, transfer the <emphasis>called</emphasis> party
178                                         to the specified destination and <emphasis>start</emphasis> execution at that location.</para>
179                                         <note>
180                                                 <para>Any channel variables you want the called channel to inherit from the caller channel must be
181                                                 prefixed with one or two underbars ('_').</para>
182                                         </note>
183                                 </option>
184                                 <option name="F">
185                                         <para>When the caller hangs up, transfer the <emphasis>called</emphasis> party to the next priority of the current extension
186                                         and <emphasis>start</emphasis> execution at that location.</para>
187                                         <note>
188                                                 <para>Any channel variables you want the called channel to inherit from the caller channel must be
189                                                 prefixed with one or two underbars ('_').</para>
190                                         </note>
191                                         <note>
192                                                 <para>Using this option from a Macro() or GoSub() might not make sense as there would be no return points.</para>
193                                         </note>
194                                 </option>
195                                 <option name="g">
196                                         <para>Proceed with dialplan execution at the next priority in the current extension if the
197                                         destination channel hangs up.</para>
198                                 </option>
199                                 <option name="G" argsep="^">
200                                         <argument name="context" required="false" />
201                                         <argument name="exten" required="false" />
202                                         <argument name="priority" required="true" />
203                                         <para>If the call is answered, transfer the calling party to
204                                         the specified <replaceable>priority</replaceable> and the called party to the specified
205                                         <replaceable>priority</replaceable> plus one.</para>
206                                         <note>
207                                                 <para>You cannot use any additional action post answer options in conjunction with this option.</para>
208                                         </note>
209                                 </option>
210                                 <option name="h">
211                                         <para>Allow the called party to hang up by sending the DTMF sequence
212                                         defined for disconnect in <filename>features.conf</filename>.</para>
213                                 </option>
214                                 <option name="H">
215                                         <para>Allow the calling party to hang up by sending the DTMF sequence
216                                         defined for disconnect in <filename>features.conf</filename>.</para>
217                                         <note>
218                                                 <para>Many SIP and ISDN phones cannot send DTMF digits until the call is
219                                                 connected.  If you wish to allow DTMF disconnect before the dialed
220                                                 party answers with these phones, you can use the <literal>Answer</literal>
221                                                 application before dialing.</para>
222                                         </note>
223                                 </option>
224                                 <option name="i">
225                                         <para>Asterisk will ignore any forwarding requests it may receive on this dial attempt.</para>
226                                 </option>
227                                 <option name="I">
228                                         <para>Asterisk will ignore any connected line update requests or any redirecting party
229                                         update requests it may receive on this dial attempt.</para>
230                                 </option>
231                                 <option name="k">
232                                         <para>Allow the called party to enable parking of the call by sending
233                                         the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
234                                 </option>
235                                 <option name="K">
236                                         <para>Allow the calling party to enable parking of the call by sending
237                                         the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
238                                 </option>
239                                 <option name="L" argsep=":">
240                                         <argument name="x" required="true">
241                                                 <para>Maximum call time, in milliseconds</para>
242                                         </argument>
243                                         <argument name="y">
244                                                 <para>Warning time, in milliseconds</para>
245                                         </argument>
246                                         <argument name="z">
247                                                 <para>Repeat time, in milliseconds</para>
248                                         </argument>
249                                         <para>Limit the call to <replaceable>x</replaceable> milliseconds. Play a warning when <replaceable>y</replaceable> milliseconds are
250                                         left. Repeat the warning every <replaceable>z</replaceable> milliseconds until time expires.</para>
251                                         <para>This option is affected by the following variables:</para>
252                                         <variablelist>
253                                                 <variable name="LIMIT_PLAYAUDIO_CALLER">
254                                                         <value name="yes" default="true" />
255                                                         <value name="no" />
256                                                         <para>If set, this variable causes Asterisk to play the prompts to the caller.</para>
257                                                 </variable>
258                                                 <variable name="LIMIT_PLAYAUDIO_CALLEE">
259                                                         <value name="yes" />
260                                                         <value name="no" default="true"/>
261                                                         <para>If set, this variable causes Asterisk to play the prompts to the callee.</para>
262                                                 </variable>
263                                                 <variable name="LIMIT_TIMEOUT_FILE">
264                                                         <value name="filename"/>
265                                                         <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play when the timeout is reached.
266                                                         If not set, the time remaining will be announced.</para>
267                                                 </variable>
268                                                 <variable name="LIMIT_CONNECT_FILE">
269                                                         <value name="filename"/>
270                                                         <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play when the call begins.
271                                                         If not set, the time remaining will be announced.</para>
272                                                 </variable>
273                                                 <variable name="LIMIT_WARNING_FILE">
274                                                         <value name="filename"/>
275                                                         <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play as
276                                                         a warning when time <replaceable>x</replaceable> is reached. If not set, the time remaining will be announced.</para>
277                                                 </variable>
278                                         </variablelist>
279                                 </option>
280                                 <option name="m">
281                                         <argument name="class" required="false"/>
282                                         <para>Provide hold music to the calling party until a requested
283                                         channel answers. A specific music on hold <replaceable>class</replaceable>
284                                         (as defined in <filename>musiconhold.conf</filename>) can be specified.</para>
285                                 </option>
286                                 <option name="M" argsep="^">
287                                         <argument name="macro" required="true">
288                                                 <para>Name of the macro that should be executed.</para>
289                                         </argument>
290                                         <argument name="arg" multiple="true">
291                                                 <para>Macro arguments</para>
292                                         </argument>
293                                         <para>Execute the specified <replaceable>macro</replaceable> for the <emphasis>called</emphasis> channel
294                                         before connecting to the calling channel. Arguments can be specified to the Macro
295                                         using <literal>^</literal> as a delimiter. The macro can set the variable
296                                         <variable>MACRO_RESULT</variable> to specify the following actions after the macro is
297                                         finished executing:</para>
298                                         <variablelist>
299                                                 <variable name="MACRO_RESULT">
300                                                         <para>If set, this action will be taken after the macro finished executing.</para>
301                                                         <value name="ABORT">
302                                                                 Hangup both legs of the call
303                                                         </value>
304                                                         <value name="CONGESTION">
305                                                                 Behave as if line congestion was encountered
306                                                         </value>
307                                                         <value name="BUSY">
308                                                                 Behave as if a busy signal was encountered
309                                                         </value>
310                                                         <value name="CONTINUE">
311                                                                 Hangup the called party and allow the calling party to continue dialplan execution at the next priority
312                                                         </value>
313                                                         <value name="GOTO:[[&lt;context&gt;^]&lt;exten&gt;^]&lt;priority&gt;">
314                                                                 Transfer the call to the specified destination.
315                                                         </value>
316                                                 </variable>
317                                         </variablelist>
318                                         <note>
319                                                 <para>You cannot use any additional action post answer options in conjunction
320                                                 with this option. Also, pbx services are run on the peer (called) channel,
321                                                 so you will not be able to set timeouts via the TIMEOUT() function in this macro.</para>
322                                         </note>
323                                         <warning><para>Be aware of the limitations that macros have, specifically with regards to use of
324                                         the <literal>WaitExten</literal> application. For more information, see the documentation for
325                                         Macro()</para></warning>
326                                 </option>
327                                 <option name="n">
328                                         <argument name="delete">
329                                                 <para>With <replaceable>delete</replaceable> either not specified or set to <literal>0</literal>,
330                                                 the recorded introduction will not be deleted if the caller hangs up while the remote party has not
331                                                 yet answered.</para>
332                                                 <para>With <replaceable>delete</replaceable> set to <literal>1</literal>, the introduction will
333                                                 always be deleted.</para>
334                                         </argument>
335                                         <para>This option is a modifier for the call screening/privacy mode. (See the
336                                         <literal>p</literal> and <literal>P</literal> options.) It specifies
337                                         that no introductions are to be saved in the <directory>priv-callerintros</directory>
338                                         directory.</para>
339                                 </option>
340                                 <option name="N">
341                                         <para>This option is a modifier for the call screening/privacy mode. It specifies
342                                         that if Caller*ID is present, do not screen the call.</para>
343                                 </option>
344                                 <option name="o">
345                                         <argument name="x" required="false" />
346                                         <para>If <replaceable>x</replaceable> is not provided, specify that the CallerID that was present on the
347                                         <emphasis>calling</emphasis> channel be stored as the CallerID on the <emphasis>called</emphasis> channel.
348                                         This was the behavior of Asterisk 1.0 and earlier.
349                                         If <replaceable>x</replaceable> is provided, specify the CallerID stored on the <emphasis>called</emphasis> channel.
350                                         Note that o(${CALLERID(all)}) is similar to option o without the parameter.</para>
351                                 </option>
352                                 <option name="O">
353                                         <argument name="mode">
354                                                 <para>With <replaceable>mode</replaceable> either not specified or set to <literal>1</literal>,
355                                                 the originator hanging up will cause the phone to ring back immediately.</para>
356                                                 <para>With <replaceable>mode</replaceable> set to <literal>2</literal>, when the operator
357                                                 flashes the trunk, it will ring their phone back.</para>
358                                         </argument>
359                                         <para>Enables <emphasis>operator services</emphasis> mode.  This option only
360                                         works when bridging a DAHDI channel to another DAHDI channel
361                                         only. if specified on non-DAHDI interfaces, it will be ignored.
362                                         When the destination answers (presumably an operator services
363                                         station), the originator no longer has control of their line.
364                                         They may hang up, but the switch will not release their line
365                                         until the destination party (the operator) hangs up.</para>
366                                 </option>
367                                 <option name="p">
368                                         <para>This option enables screening mode. This is basically Privacy mode
369                                         without memory.</para>
370                                 </option>
371                                 <option name="P">
372                                         <argument name="x" />
373                                         <para>Enable privacy mode. Use <replaceable>x</replaceable> as the family/key in the AstDB database if
374                                         it is provided. The current extension is used if a database family/key is not specified.</para>
375                                 </option>
376                                 <option name="r">
377                                         <para>Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. Pass no audio to the calling
378                                         party until the called channel has answered.</para>
379                                         <argument name="tone" required="false">
380                                                 <para>Indicate progress to calling party. Send audio 'tone' from the indications.conf tonezone currently in use.</para>
381                                         </argument>
382                                 </option>
383                                 <option name="R">
384                                         <para>Default: Indicate ringing to the calling party, even if the called party isn't actually ringing. 
385                                         Allow interruption of the ringback if early media is received on the channel.</para>
386                                 </option>
387                                 <option name="S">
388                                         <argument name="x" required="true" />
389                                         <para>Hang up the call <replaceable>x</replaceable> seconds <emphasis>after</emphasis> the called party has
390                                         answered the call.</para>
391                                 </option>
392                                 <option name="s">
393                                         <argument name="x" required="true" />
394                                         <para>Force the outgoing callerid tag parameter to be set to the string <replaceable>x</replaceable>.</para>
395                                         <para>Works with the f option.</para>
396                                 </option>
397                                 <option name="t">
398                                         <para>Allow the called party to transfer the calling party by sending the
399                                         DTMF sequence defined in <filename>features.conf</filename>. This setting does not perform policy enforcement on
400                                         transfers initiated by other methods.</para>
401                                 </option>
402                                 <option name="T">
403                                         <para>Allow the calling party to transfer the called party by sending the
404                                         DTMF sequence defined in <filename>features.conf</filename>. This setting does not perform policy enforcement on
405                                         transfers initiated by other methods.</para>
406                                 </option>
407                                 <option name="U" argsep="^">
408                                         <argument name="x" required="true">
409                                                 <para>Name of the subroutine to execute via Gosub</para>
410                                         </argument>
411                                         <argument name="arg" multiple="true" required="false">
412                                                 <para>Arguments for the Gosub routine</para>
413                                         </argument>
414                                         <para>Execute via Gosub the routine <replaceable>x</replaceable> for the <emphasis>called</emphasis> channel before connecting
415                                         to the calling channel. Arguments can be specified to the Gosub
416                                         using <literal>^</literal> as a delimiter. The Gosub routine can set the variable
417                                         <variable>GOSUB_RESULT</variable> to specify the following actions after the Gosub returns.</para>
418                                         <variablelist>
419                                                 <variable name="GOSUB_RESULT">
420                                                         <value name="ABORT">
421                                                                 Hangup both legs of the call.
422                                                         </value>
423                                                         <value name="CONGESTION">
424                                                                 Behave as if line congestion was encountered.
425                                                         </value>
426                                                         <value name="BUSY">
427                                                                 Behave as if a busy signal was encountered.
428                                                         </value>
429                                                         <value name="CONTINUE">
430                                                                 Hangup the called party and allow the calling party
431                                                                 to continue dialplan execution at the next priority.
432                                                         </value>
433                                                         <value name="GOTO:[[&lt;context&gt;^]&lt;exten&gt;^]&lt;priority&gt;">
434                                                                 Transfer the call to the specified destination.
435                                                         </value>
436                                                 </variable>
437                                         </variablelist>
438                                         <note>
439                                                 <para>You cannot use any additional action post answer options in conjunction
440                                                 with this option. Also, pbx services are run on the peer (called) channel,
441                                                 so you will not be able to set timeouts via the TIMEOUT() function in this routine.</para>
442                                         </note>
443                                 </option>
444                                 <option name="u">
445                                         <argument name = "x" required="true">
446                                                 <para>Force the outgoing callerid presentation indicator parameter to be set
447                                                 to one of the values passed in <replaceable>x</replaceable>:
448                                                 <literal>allowed_not_screened</literal>
449                                                 <literal>allowed_passed_screen</literal>
450                                                 <literal>allowed_failed_screen</literal>
451                                                 <literal>allowed</literal>
452                                                 <literal>prohib_not_screened</literal>
453                                                 <literal>prohib_passed_screen</literal>
454                                                 <literal>prohib_failed_screen</literal>
455                                                 <literal>prohib</literal>
456                                                 <literal>unavailable</literal></para>
457                                         </argument>
458                                         <para>Works with the f option.</para>
459                                 </option>
460                                 <option name="w">
461                                         <para>Allow the called party to enable recording of the call by sending
462                                         the DTMF sequence defined for one-touch recording in <filename>features.conf</filename>.</para>
463                                 </option>
464                                 <option name="W">
465                                         <para>Allow the calling party to enable recording of the call by sending
466                                         the DTMF sequence defined for one-touch recording in <filename>features.conf</filename>.</para>
467                                 </option>
468                                 <option name="x">
469                                         <para>Allow the called party to enable recording of the call by sending
470                                         the DTMF sequence defined for one-touch automixmonitor in <filename>features.conf</filename>.</para>
471                                 </option>
472                                 <option name="X">
473                                         <para>Allow the calling party to enable recording of the call by sending
474                                         the DTMF sequence defined for one-touch automixmonitor in <filename>features.conf</filename>.</para>
475                                 </option>
476                                 <option name="z">
477                                         <para>On a call forward, cancel any dial timeout which has been set for this call.</para>
478                                 </option>
479                                 </optionlist>
480                         </parameter>
481                         <parameter name="URL">
482                                 <para>The optional URL will be sent to the called party if the channel driver supports it.</para>
483                         </parameter>
484                 </syntax>
485                 <description>
486                         <para>This application will place calls to one or more specified channels. As soon
487                         as one of the requested channels answers, the originating channel will be
488                         answered, if it has not already been answered. These two channels will then
489                         be active in a bridged call. All other channels that were requested will then
490                         be hung up.</para>
491
492                         <para>Unless there is a timeout specified, the Dial application will wait
493                         indefinitely until one of the called channels answers, the user hangs up, or
494                         if all of the called channels are busy or unavailable. Dialplan executing will
495                         continue if no requested channels can be called, or if the timeout expires.
496                         This application will report normal termination if the originating channel
497                         hangs up, or if the call is bridged and either of the parties in the bridge
498                         ends the call.</para>
499                         <para>If the <variable>OUTBOUND_GROUP</variable> variable is set, all peer channels created by this
500                         application will be put into that group (as in Set(GROUP()=...).
501                         If the <variable>OUTBOUND_GROUP_ONCE</variable> variable is set, all peer channels created by this
502                         application will be put into that group (as in Set(GROUP()=...). Unlike <variable>OUTBOUND_GROUP</variable>,
503                         however, the variable will be unset after use.</para>
504
505                         <para>This application sets the following channel variables:</para>
506                         <variablelist>
507                                 <variable name="DIALEDTIME">
508                                         <para>This is the time from dialing a channel until when it is disconnected.</para>
509                                 </variable>
510                                 <variable name="ANSWEREDTIME">
511                                         <para>This is the amount of time for actual call.</para>
512                                 </variable>
513                                 <variable name="DIALSTATUS">
514                                         <para>This is the status of the call</para>
515                                         <value name="CHANUNAVAIL" />
516                                         <value name="CONGESTION" />
517                                         <value name="NOANSWER" />
518                                         <value name="BUSY" />
519                                         <value name="ANSWER" />
520                                         <value name="CANCEL" />
521                                         <value name="DONTCALL">
522                                                 For the Privacy and Screening Modes.
523                                                 Will be set if the called party chooses to send the calling party to the 'Go Away' script.
524                                         </value>
525                                         <value name="TORTURE">
526                                                 For the Privacy and Screening Modes.
527                                                 Will be set if the called party chooses to send the calling party to the 'torture' script.
528                                         </value>
529                                         <value name="INVALIDARGS" />
530                                 </variable>
531                         </variablelist>
532                 </description>
533         </application>
534         <application name="RetryDial" language="en_US">
535                 <synopsis>
536                         Place a call, retrying on failure allowing an optional exit extension.
537                 </synopsis>
538                 <syntax>
539                         <parameter name="announce" required="true">
540                                 <para>Filename of sound that will be played when no channel can be reached</para>
541                         </parameter>
542                         <parameter name="sleep" required="true">
543                                 <para>Number of seconds to wait after a dial attempt failed before a new attempt is made</para>
544                         </parameter>
545                         <parameter name="retries" required="true">
546                                 <para>Number of retries</para>
547                                 <para>When this is reached flow will continue at the next priority in the dialplan</para>
548                         </parameter>
549                         <parameter name="dialargs" required="true">
550                                 <para>Same format as arguments provided to the Dial application</para>
551                         </parameter>
552                 </syntax>
553                 <description>
554                         <para>This application will attempt to place a call using the normal Dial application.
555                         If no channel can be reached, the <replaceable>announce</replaceable> file will be played.
556                         Then, it will wait <replaceable>sleep</replaceable> number of seconds before retrying the call.
557                         After <replaceable>retries</replaceable> number of attempts, the calling channel will continue at the next priority in the dialplan.
558                         If the <replaceable>retries</replaceable> setting is set to 0, this application will retry endlessly.
559                         While waiting to retry a call, a 1 digit extension may be dialed. If that
560                         extension exists in either the context defined in <variable>EXITCONTEXT</variable> or the current
561                         one, The call will jump to that extension immediately.
562                         The <replaceable>dialargs</replaceable> are specified in the same format that arguments are provided
563                         to the Dial application.</para>
564                 </description>
565         </application>
566  ***/
567
568 static const char app[] = "Dial";
569 static const char rapp[] = "RetryDial";
570
571 enum {
572         OPT_ANNOUNCE =          (1 << 0),
573         OPT_RESETCDR =          (1 << 1),
574         OPT_DTMF_EXIT =         (1 << 2),
575         OPT_SENDDTMF =          (1 << 3),
576         OPT_FORCECLID =         (1 << 4),
577         OPT_GO_ON =             (1 << 5),
578         OPT_CALLEE_HANGUP =     (1 << 6),
579         OPT_CALLER_HANGUP =     (1 << 7),
580         OPT_ORIGINAL_CLID =     (1 << 8),
581         OPT_DURATION_LIMIT =    (1 << 9),
582         OPT_MUSICBACK =         (1 << 10),
583         OPT_CALLEE_MACRO =      (1 << 11),
584         OPT_SCREEN_NOINTRO =    (1 << 12),
585         OPT_SCREEN_NOCALLERID = (1 << 13),
586         OPT_IGNORE_CONNECTEDLINE = (1 << 14),
587         OPT_SCREENING =         (1 << 15),
588         OPT_PRIVACY =           (1 << 16),
589         OPT_RINGBACK =          (1 << 17),
590         OPT_DURATION_STOP =     (1 << 18),
591         OPT_CALLEE_TRANSFER =   (1 << 19),
592         OPT_CALLER_TRANSFER =   (1 << 20),
593         OPT_CALLEE_MONITOR =    (1 << 21),
594         OPT_CALLER_MONITOR =    (1 << 22),
595         OPT_GOTO =              (1 << 23),
596         OPT_OPERMODE =          (1 << 24),
597         OPT_CALLEE_PARK =       (1 << 25),
598         OPT_CALLER_PARK =       (1 << 26),
599         OPT_IGNORE_FORWARDING = (1 << 27),
600         OPT_CALLEE_GOSUB =      (1 << 28),
601         OPT_CALLEE_MIXMONITOR = (1 << 29),
602         OPT_CALLER_MIXMONITOR = (1 << 30),
603 };
604
605 /* flags are now 64 bits, so keep it up! */
606 #define DIAL_STILLGOING      (1LLU << 31)
607 #define DIAL_NOFORWARDHTML   (1LLU << 32)
608 #define DIAL_CALLERID_ABSENT (1LLU << 33) /* TRUE if caller id is not available for connected line. */
609 #define OPT_CANCEL_ELSEWHERE (1LLU << 34)
610 #define OPT_PEER_H           (1LLU << 35)
611 #define OPT_CALLEE_GO_ON     (1LLU << 36)
612 #define OPT_CANCEL_TIMEOUT   (1LLU << 37)
613 #define OPT_FORCE_CID_TAG    (1LLU << 38)
614 #define OPT_FORCE_CID_PRES   (1LLU << 39)
615 #define OPT_CALLER_ANSWER    (1LLU << 40)
616 #define OPT_PREDIAL_CALLEE   (1LLU << 41)
617 #define OPT_PREDIAL_CALLER   (1LLU << 42)
618 #define OPT_RING_WITH_EARLY_MEDIA (1LLU << 43)
619
620 enum {
621         OPT_ARG_ANNOUNCE = 0,
622         OPT_ARG_SENDDTMF,
623         OPT_ARG_GOTO,
624         OPT_ARG_DURATION_LIMIT,
625         OPT_ARG_MUSICBACK,
626         OPT_ARG_CALLEE_MACRO,
627         OPT_ARG_RINGBACK,
628         OPT_ARG_CALLEE_GOSUB,
629         OPT_ARG_CALLEE_GO_ON,
630         OPT_ARG_PRIVACY,
631         OPT_ARG_DURATION_STOP,
632         OPT_ARG_OPERMODE,
633         OPT_ARG_SCREEN_NOINTRO,
634         OPT_ARG_ORIGINAL_CLID,
635         OPT_ARG_FORCECLID,
636         OPT_ARG_FORCE_CID_TAG,
637         OPT_ARG_FORCE_CID_PRES,
638         OPT_ARG_PREDIAL_CALLEE,
639         OPT_ARG_PREDIAL_CALLER,
640         /* note: this entry _MUST_ be the last one in the enum */
641         OPT_ARG_ARRAY_SIZE
642 };
643
644 AST_APP_OPTIONS(dial_exec_options, BEGIN_OPTIONS
645         AST_APP_OPTION_ARG('A', OPT_ANNOUNCE, OPT_ARG_ANNOUNCE),
646         AST_APP_OPTION('a', OPT_CALLER_ANSWER),
647         AST_APP_OPTION_ARG('b', OPT_PREDIAL_CALLEE, OPT_ARG_PREDIAL_CALLEE),
648         AST_APP_OPTION_ARG('B', OPT_PREDIAL_CALLER, OPT_ARG_PREDIAL_CALLER),
649         AST_APP_OPTION('C', OPT_RESETCDR),
650         AST_APP_OPTION('c', OPT_CANCEL_ELSEWHERE),
651         AST_APP_OPTION('d', OPT_DTMF_EXIT),
652         AST_APP_OPTION_ARG('D', OPT_SENDDTMF, OPT_ARG_SENDDTMF),
653         AST_APP_OPTION('e', OPT_PEER_H),
654         AST_APP_OPTION_ARG('f', OPT_FORCECLID, OPT_ARG_FORCECLID),
655         AST_APP_OPTION_ARG('F', OPT_CALLEE_GO_ON, OPT_ARG_CALLEE_GO_ON),
656         AST_APP_OPTION('g', OPT_GO_ON),
657         AST_APP_OPTION_ARG('G', OPT_GOTO, OPT_ARG_GOTO),
658         AST_APP_OPTION('h', OPT_CALLEE_HANGUP),
659         AST_APP_OPTION('H', OPT_CALLER_HANGUP),
660         AST_APP_OPTION('i', OPT_IGNORE_FORWARDING),
661         AST_APP_OPTION('I', OPT_IGNORE_CONNECTEDLINE),
662         AST_APP_OPTION('k', OPT_CALLEE_PARK),
663         AST_APP_OPTION('K', OPT_CALLER_PARK),
664         AST_APP_OPTION_ARG('L', OPT_DURATION_LIMIT, OPT_ARG_DURATION_LIMIT),
665         AST_APP_OPTION_ARG('m', OPT_MUSICBACK, OPT_ARG_MUSICBACK),
666         AST_APP_OPTION_ARG('M', OPT_CALLEE_MACRO, OPT_ARG_CALLEE_MACRO),
667         AST_APP_OPTION_ARG('n', OPT_SCREEN_NOINTRO, OPT_ARG_SCREEN_NOINTRO),
668         AST_APP_OPTION('N', OPT_SCREEN_NOCALLERID),
669         AST_APP_OPTION_ARG('o', OPT_ORIGINAL_CLID, OPT_ARG_ORIGINAL_CLID),
670         AST_APP_OPTION_ARG('O', OPT_OPERMODE, OPT_ARG_OPERMODE),
671         AST_APP_OPTION('p', OPT_SCREENING),
672         AST_APP_OPTION_ARG('P', OPT_PRIVACY, OPT_ARG_PRIVACY),
673         AST_APP_OPTION_ARG('r', OPT_RINGBACK, OPT_ARG_RINGBACK),
674         AST_APP_OPTION('R', OPT_RING_WITH_EARLY_MEDIA),
675         AST_APP_OPTION_ARG('S', OPT_DURATION_STOP, OPT_ARG_DURATION_STOP),
676         AST_APP_OPTION_ARG('s', OPT_FORCE_CID_TAG, OPT_ARG_FORCE_CID_TAG),
677         AST_APP_OPTION('t', OPT_CALLEE_TRANSFER),
678         AST_APP_OPTION('T', OPT_CALLER_TRANSFER),
679         AST_APP_OPTION_ARG('u', OPT_FORCE_CID_PRES, OPT_ARG_FORCE_CID_PRES),
680         AST_APP_OPTION_ARG('U', OPT_CALLEE_GOSUB, OPT_ARG_CALLEE_GOSUB),
681         AST_APP_OPTION('w', OPT_CALLEE_MONITOR),
682         AST_APP_OPTION('W', OPT_CALLER_MONITOR),
683         AST_APP_OPTION('x', OPT_CALLEE_MIXMONITOR),
684         AST_APP_OPTION('X', OPT_CALLER_MIXMONITOR),
685         AST_APP_OPTION('z', OPT_CANCEL_TIMEOUT),
686 END_OPTIONS );
687
688 #define CAN_EARLY_BRIDGE(flags,chan,peer) (!ast_test_flag64(flags, OPT_CALLEE_HANGUP | \
689         OPT_CALLER_HANGUP | OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER | \
690         OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR | OPT_CALLEE_PARK |  \
691         OPT_CALLER_PARK | OPT_ANNOUNCE | OPT_CALLEE_MACRO | OPT_CALLEE_GOSUB) && \
692         !ast_channel_audiohooks(chan) && !ast_channel_audiohooks(peer) && \
693         ast_framehook_list_is_empty(ast_channel_framehooks(chan)) && ast_framehook_list_is_empty(ast_channel_framehooks(peer)))
694
695 /*
696  * The list of active channels
697  */
698 struct chanlist {
699         AST_LIST_ENTRY(chanlist) node;
700         struct ast_channel *chan;
701         /*! Channel interface dialing string (is tech/number).  (Stored in stuff[]) */
702         const char *interface;
703         /*! Channel technology name.  (Stored in stuff[]) */
704         const char *tech;
705         /*! Channel device addressing.  (Stored in stuff[]) */
706         const char *number;
707         uint64_t flags;
708         /*! Saved connected party info from an AST_CONTROL_CONNECTED_LINE. */
709         struct ast_party_connected_line connected;
710         /*! TRUE if an AST_CONTROL_CONNECTED_LINE update was saved to the connected element. */
711         unsigned int pending_connected_update:1;
712         struct ast_aoc_decoded *aoc_s_rate_list;
713         /*! The interface, tech, and number strings are stuffed here. */
714         char stuff[0];
715 };
716
717 AST_LIST_HEAD_NOLOCK(dial_head, chanlist);
718
719 static int detect_disconnect(struct ast_channel *chan, char code, struct ast_str **featurecode);
720
721 static void chanlist_free(struct chanlist *outgoing)
722 {
723         ast_party_connected_line_free(&outgoing->connected);
724         ast_aoc_destroy_decoded(outgoing->aoc_s_rate_list);
725         ast_free(outgoing);
726 }
727
728 static void hanguptree(struct dial_head *out_chans, struct ast_channel *exception, int answered_elsewhere)
729 {
730         /* Hang up a tree of stuff */
731         struct chanlist *outgoing;
732
733         while ((outgoing = AST_LIST_REMOVE_HEAD(out_chans, node))) {
734                 /* Hangup any existing lines we have open */
735                 if (outgoing->chan && (outgoing->chan != exception)) {
736                         if (answered_elsewhere) {
737                                 /* This is for the channel drivers */
738                                 ast_channel_hangupcause_set(outgoing->chan, AST_CAUSE_ANSWERED_ELSEWHERE);
739                         }
740                         ast_hangup(outgoing->chan);
741                 }
742                 chanlist_free(outgoing);
743         }
744 }
745
746 #define AST_MAX_WATCHERS 256
747
748 /*
749  * argument to handle_cause() and other functions.
750  */
751 struct cause_args {
752         struct ast_channel *chan;
753         int busy;
754         int congestion;
755         int nochan;
756 };
757
758 static void handle_cause(int cause, struct cause_args *num)
759 {
760         switch(cause) {
761         case AST_CAUSE_BUSY:
762                 num->busy++;
763                 break;
764         case AST_CAUSE_CONGESTION:
765                 num->congestion++;
766                 break;
767         case AST_CAUSE_NO_ROUTE_DESTINATION:
768         case AST_CAUSE_UNREGISTERED:
769                 num->nochan++;
770                 break;
771         case AST_CAUSE_NO_ANSWER:
772         case AST_CAUSE_NORMAL_CLEARING:
773                 break;
774         default:
775                 num->nochan++;
776                 break;
777         }
778 }
779
780 static int onedigit_goto(struct ast_channel *chan, const char *context, char exten, int pri)
781 {
782         char rexten[2] = { exten, '\0' };
783
784         if (context) {
785                 if (!ast_goto_if_exists(chan, context, rexten, pri))
786                         return 1;
787         } else {
788                 if (!ast_goto_if_exists(chan, ast_channel_context(chan), rexten, pri))
789                         return 1;
790                 else if (!ast_strlen_zero(ast_channel_macrocontext(chan))) {
791                         if (!ast_goto_if_exists(chan, ast_channel_macrocontext(chan), rexten, pri))
792                                 return 1;
793                 }
794         }
795         return 0;
796 }
797
798 /* do not call with chan lock held */
799 static const char *get_cid_name(char *name, int namelen, struct ast_channel *chan)
800 {
801         const char *context;
802         const char *exten;
803
804         ast_channel_lock(chan);
805         context = ast_strdupa(S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)));
806         exten = ast_strdupa(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)));
807         ast_channel_unlock(chan);
808
809         return ast_get_hint(NULL, 0, name, namelen, chan, context, exten) ? name : "";
810 }
811
812 /*!
813  * helper function for wait_for_answer()
814  *
815  * \param o Outgoing call channel list.
816  * \param num Incoming call channel cause accumulation
817  * \param peerflags Dial option flags
818  * \param single TRUE if there is only one outgoing call.
819  * \param caller_entertained TRUE if the caller is being entertained by MOH or ringback.
820  * \param to Remaining call timeout time.
821  * \param forced_clid OPT_FORCECLID caller id to send
822  * \param stored_clid Caller id representing the called party if needed
823  *
824  * XXX this code is highly suspicious, as it essentially overwrites
825  * the outgoing channel without properly deleting it.
826  *
827  * \todo eventually this function should be intergrated into and replaced by ast_call_forward()
828  */
829 static void do_forward(struct chanlist *o, struct cause_args *num,
830         struct ast_flags64 *peerflags, int single, int caller_entertained, int *to,
831         struct ast_party_id *forced_clid, struct ast_party_id *stored_clid)
832 {
833         char tmpchan[256];
834         struct ast_channel *original = o->chan;
835         struct ast_channel *c = o->chan; /* the winner */
836         struct ast_channel *in = num->chan; /* the input channel */
837         char *stuff;
838         char *tech;
839         int cause;
840         struct ast_party_caller caller;
841
842         ast_copy_string(tmpchan, ast_channel_call_forward(c), sizeof(tmpchan));
843         if ((stuff = strchr(tmpchan, '/'))) {
844                 *stuff++ = '\0';
845                 tech = tmpchan;
846         } else {
847                 const char *forward_context;
848                 ast_channel_lock(c);
849                 forward_context = pbx_builtin_getvar_helper(c, "FORWARD_CONTEXT");
850                 if (ast_strlen_zero(forward_context)) {
851                         forward_context = NULL;
852                 }
853                 snprintf(tmpchan, sizeof(tmpchan), "%s@%s", ast_channel_call_forward(c), forward_context ? forward_context : ast_channel_context(c));
854                 ast_channel_unlock(c);
855                 stuff = tmpchan;
856                 tech = "Local";
857         }
858         if (!strcasecmp(tech, "Local")) {
859                 /*
860                  * Drop the connected line update block for local channels since
861                  * this is going to run dialplan and the user can change his
862                  * mind about what connected line information he wants to send.
863                  */
864                 ast_clear_flag64(o, OPT_IGNORE_CONNECTEDLINE);
865         }
866
867         /* Before processing channel, go ahead and check for forwarding */
868         ast_verb(3, "Now forwarding %s to '%s/%s' (thanks to %s)\n", ast_channel_name(in), tech, stuff, ast_channel_name(c));
869         /* If we have been told to ignore forwards, just set this channel to null and continue processing extensions normally */
870         if (ast_test_flag64(peerflags, OPT_IGNORE_FORWARDING)) {
871                 ast_verb(3, "Forwarding %s to '%s/%s' prevented.\n", ast_channel_name(in), tech, stuff);
872                 c = o->chan = NULL;
873                 cause = AST_CAUSE_BUSY;
874         } else {
875                 /* Setup parameters */
876                 c = o->chan = ast_request(tech, ast_channel_nativeformats(in), NULL, in, stuff, &cause);
877                 if (c) {
878                         if (single && !caller_entertained) {
879                                 ast_channel_make_compatible(in, o->chan);
880                         }
881                         ast_channel_lock_both(in, o->chan);
882                         ast_channel_inherit_variables(in, o->chan);
883                         ast_channel_datastore_inherit(in, o->chan);
884                         ast_channel_unlock(in);
885                         ast_channel_unlock(o->chan);
886                         /* When a call is forwarded, we don't want to track new interfaces
887                          * dialed for CC purposes. Setting the done flag will ensure that
888                          * any Dial operations that happen later won't record CC interfaces.
889                          */
890                         ast_ignore_cc(o->chan);
891                         ast_log(LOG_NOTICE, "Not accepting call completion offers from call-forward recipient %s\n", ast_channel_name(o->chan));
892                 } else
893                         ast_log(LOG_NOTICE,
894                                 "Forwarding failed to create channel to dial '%s/%s' (cause = %d)\n",
895                                 tech, stuff, cause);
896         }
897         if (!c) {
898                 ast_clear_flag64(o, DIAL_STILLGOING);
899                 handle_cause(cause, num);
900                 ast_hangup(original);
901         } else {
902                 ast_channel_lock_both(c, original);
903                 ast_party_redirecting_copy(ast_channel_redirecting(c),
904                         ast_channel_redirecting(original));
905                 ast_channel_unlock(c);
906                 ast_channel_unlock(original);
907
908                 ast_channel_lock_both(c, in);
909
910                 if (single && !caller_entertained && CAN_EARLY_BRIDGE(peerflags, c, in)) {
911                         ast_rtp_instance_early_bridge_make_compatible(c, in);
912                 }
913
914                 if (!ast_channel_redirecting(c)->from.number.valid
915                         || ast_strlen_zero(ast_channel_redirecting(c)->from.number.str)) {
916                         /*
917                          * The call was not previously redirected so it is
918                          * now redirected from this number.
919                          */
920                         ast_party_number_free(&ast_channel_redirecting(c)->from.number);
921                         ast_party_number_init(&ast_channel_redirecting(c)->from.number);
922                         ast_channel_redirecting(c)->from.number.valid = 1;
923                         ast_channel_redirecting(c)->from.number.str =
924                                 ast_strdup(S_OR(ast_channel_macroexten(in), ast_channel_exten(in)));
925                 }
926
927                 ast_channel_dialed(c)->transit_network_select = ast_channel_dialed(in)->transit_network_select;
928
929                 /* Determine CallerID to store in outgoing channel. */
930                 ast_party_caller_set_init(&caller, ast_channel_caller(c));
931                 if (ast_test_flag64(peerflags, OPT_ORIGINAL_CLID)) {
932                         caller.id = *stored_clid;
933                         ast_channel_set_caller_event(c, &caller, NULL);
934                         ast_set_flag64(o, DIAL_CALLERID_ABSENT);
935                 } else if (ast_strlen_zero(S_COR(ast_channel_caller(c)->id.number.valid,
936                         ast_channel_caller(c)->id.number.str, NULL))) {
937                         /*
938                          * The new channel has no preset CallerID number by the channel
939                          * driver.  Use the dialplan extension and hint name.
940                          */
941                         caller.id = *stored_clid;
942                         ast_channel_set_caller_event(c, &caller, NULL);
943                         ast_set_flag64(o, DIAL_CALLERID_ABSENT);
944                 } else {
945                         ast_clear_flag64(o, DIAL_CALLERID_ABSENT);
946                 }
947
948                 /* Determine CallerID for outgoing channel to send. */
949                 if (ast_test_flag64(o, OPT_FORCECLID)) {
950                         struct ast_party_connected_line connected;
951
952                         ast_party_connected_line_init(&connected);
953                         connected.id = *forced_clid;
954                         ast_party_connected_line_copy(ast_channel_connected(c), &connected);
955                 } else {
956                         ast_connected_line_copy_from_caller(ast_channel_connected(c), ast_channel_caller(in));
957                 }
958
959                 ast_channel_accountcode_set(c, ast_channel_accountcode(in));
960
961                 ast_channel_appl_set(c, "AppDial");
962                 ast_channel_data_set(c, "(Outgoing Line)");
963                 ast_channel_publish_snapshot(c);
964
965                 ast_channel_unlock(in);
966                 if (single && !ast_test_flag64(o, OPT_IGNORE_CONNECTEDLINE)) {
967                         struct ast_party_redirecting redirecting;
968
969                         /*
970                          * Redirecting updates to the caller make sense only on single
971                          * calls.
972                          *
973                          * We must unlock c before calling
974                          * ast_channel_redirecting_macro, because we put c into
975                          * autoservice there.  That is pretty much a guaranteed
976                          * deadlock.  This is why the handling of c's lock may seem a
977                          * bit unusual here.
978                          */
979                         ast_party_redirecting_init(&redirecting);
980                         ast_party_redirecting_copy(&redirecting, ast_channel_redirecting(c));
981                         ast_channel_unlock(c);
982                         if (ast_channel_redirecting_sub(c, in, &redirecting, 0) &&
983                                 ast_channel_redirecting_macro(c, in, &redirecting, 1, 0)) {
984                                 ast_channel_update_redirecting(in, &redirecting, NULL);
985                         }
986                         ast_party_redirecting_free(&redirecting);
987                 } else {
988                         ast_channel_unlock(c);
989                 }
990
991                 if (ast_test_flag64(peerflags, OPT_CANCEL_TIMEOUT)) {
992                         *to = -1;
993                 }
994
995                 if (ast_call(c, stuff, 0)) {
996                         ast_log(LOG_NOTICE, "Forwarding failed to dial '%s/%s'\n",
997                                 tech, stuff);
998                         ast_clear_flag64(o, DIAL_STILLGOING);
999                         ast_hangup(original);
1000                         ast_hangup(c);
1001                         c = o->chan = NULL;
1002                         num->nochan++;
1003                 } else {
1004                         ast_channel_publish_dial(in, c, stuff, NULL);
1005                         ast_channel_publish_dial_forward(in, original, c, NULL, "CANCEL",
1006                                 ast_channel_call_forward(original));
1007
1008                         /* Hangup the original channel now, in case we needed it */
1009                         ast_hangup(original);
1010                 }
1011                 if (single && !caller_entertained) {
1012                         ast_indicate(in, -1);
1013                 }
1014         }
1015 }
1016
1017 /* argument used for some functions. */
1018 struct privacy_args {
1019         int sentringing;
1020         int privdb_val;
1021         char privcid[256];
1022         char privintro[1024];
1023         char status[256];
1024 };
1025
1026 static void publish_dial_end_event(struct ast_channel *in, struct dial_head *out_chans, struct ast_channel *exception, const char *status)
1027 {
1028         struct chanlist *outgoing;
1029         AST_LIST_TRAVERSE(out_chans, outgoing, node) {
1030                 if (!outgoing->chan || outgoing->chan == exception) {
1031                         continue;
1032                 }
1033                 ast_channel_publish_dial(in, outgoing->chan, NULL, status);
1034         }
1035 }
1036
1037 static struct ast_channel *wait_for_answer(struct ast_channel *in,
1038         struct dial_head *out_chans, int *to, struct ast_flags64 *peerflags,
1039         char *opt_args[],
1040         struct privacy_args *pa,
1041         const struct cause_args *num_in, int *result, char *dtmf_progress,
1042         const int ignore_cc,
1043         struct ast_party_id *forced_clid, struct ast_party_id *stored_clid)
1044 {
1045         struct cause_args num = *num_in;
1046         int prestart = num.busy + num.congestion + num.nochan;
1047         int orig = *to;
1048         struct ast_channel *peer = NULL;
1049 #ifdef HAVE_EPOLL
1050         struct chanlist *epollo;
1051 #endif
1052         struct chanlist *outgoing = AST_LIST_FIRST(out_chans);
1053         /* single is set if only one destination is enabled */
1054         int single = outgoing && !AST_LIST_NEXT(outgoing, node);
1055         int caller_entertained = outgoing
1056                 && ast_test_flag64(outgoing, OPT_MUSICBACK | OPT_RINGBACK);
1057         struct ast_party_connected_line connected_caller;
1058         struct ast_str *featurecode = ast_str_alloca(AST_FEATURE_MAX_LEN + 1);
1059         int cc_recall_core_id;
1060         int is_cc_recall;
1061         int cc_frame_received = 0;
1062         int num_ringing = 0;
1063         struct timeval start = ast_tvnow();
1064
1065         ast_party_connected_line_init(&connected_caller);
1066         if (single) {
1067                 /* Turn off hold music, etc */
1068                 if (!caller_entertained) {
1069                         ast_deactivate_generator(in);
1070                         /* If we are calling a single channel, and not providing ringback or music, */
1071                         /* then, make them compatible for in-band tone purpose */
1072                         if (ast_channel_make_compatible(in, outgoing->chan) < 0) {
1073                                 /* If these channels can not be made compatible,
1074                                  * there is no point in continuing.  The bridge
1075                                  * will just fail if it gets that far.
1076                                  */
1077                                 *to = -1;
1078                                 strcpy(pa->status, "CONGESTION");
1079                                 ast_channel_publish_dial(in, outgoing->chan, NULL, pa->status);
1080                                 return NULL;
1081                         }
1082                 }
1083
1084                 if (!ast_test_flag64(outgoing, OPT_IGNORE_CONNECTEDLINE)
1085                         && !ast_test_flag64(outgoing, DIAL_CALLERID_ABSENT)) {
1086                         ast_channel_lock(outgoing->chan);
1087                         ast_connected_line_copy_from_caller(&connected_caller, ast_channel_caller(outgoing->chan));
1088                         ast_channel_unlock(outgoing->chan);
1089                         connected_caller.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
1090                         if (ast_channel_connected_line_sub(outgoing->chan, in, &connected_caller, 0) &&
1091                                 ast_channel_connected_line_macro(outgoing->chan, in, &connected_caller, 1, 0)) {
1092                                 ast_channel_update_connected_line(in, &connected_caller, NULL);
1093                         }
1094                         ast_party_connected_line_free(&connected_caller);
1095                 }
1096         }
1097
1098         is_cc_recall = ast_cc_is_recall(in, &cc_recall_core_id, NULL);
1099
1100 #ifdef HAVE_EPOLL
1101         AST_LIST_TRAVERSE(out_chans, epollo, node) {
1102                 ast_poll_channel_add(in, epollo->chan);
1103         }
1104 #endif
1105
1106         while ((*to = ast_remaining_ms(start, orig)) && !peer) {
1107                 struct chanlist *o;
1108                 int pos = 0; /* how many channels do we handle */
1109                 int numlines = prestart;
1110                 struct ast_channel *winner;
1111                 struct ast_channel *watchers[AST_MAX_WATCHERS];
1112
1113                 watchers[pos++] = in;
1114                 AST_LIST_TRAVERSE(out_chans, o, node) {
1115                         /* Keep track of important channels */
1116                         if (ast_test_flag64(o, DIAL_STILLGOING) && o->chan)
1117                                 watchers[pos++] = o->chan;
1118                         numlines++;
1119                 }
1120                 if (pos == 1) { /* only the input channel is available */
1121                         if (numlines == (num.busy + num.congestion + num.nochan)) {
1122                                 ast_verb(2, "Everyone is busy/congested at this time (%d:%d/%d/%d)\n", numlines, num.busy, num.congestion, num.nochan);
1123                                 if (num.busy)
1124                                         strcpy(pa->status, "BUSY");
1125                                 else if (num.congestion)
1126                                         strcpy(pa->status, "CONGESTION");
1127                                 else if (num.nochan)
1128                                         strcpy(pa->status, "CHANUNAVAIL");
1129                         } else {
1130                                 ast_verb(3, "No one is available to answer at this time (%d:%d/%d/%d)\n", numlines, num.busy, num.congestion, num.nochan);
1131                         }
1132                         *to = 0;
1133                         if (is_cc_recall) {
1134                                 ast_cc_failed(cc_recall_core_id, "Everyone is busy/congested for the recall. How sad");
1135                         }
1136                         return NULL;
1137                 }
1138                 winner = ast_waitfor_n(watchers, pos, to);
1139                 AST_LIST_TRAVERSE(out_chans, o, node) {
1140                         struct ast_frame *f;
1141                         struct ast_channel *c = o->chan;
1142
1143                         if (c == NULL)
1144                                 continue;
1145                         if (ast_test_flag64(o, DIAL_STILLGOING) && ast_channel_state(c) == AST_STATE_UP) {
1146                                 if (!peer) {
1147                                         ast_verb(3, "%s answered %s\n", ast_channel_name(c), ast_channel_name(in));
1148                                         if (!single && !ast_test_flag64(o, OPT_IGNORE_CONNECTEDLINE)) {
1149                                                 if (o->pending_connected_update) {
1150                                                         if (ast_channel_connected_line_sub(c, in, &o->connected, 0) &&
1151                                                                 ast_channel_connected_line_macro(c, in, &o->connected, 1, 0)) {
1152                                                                 ast_channel_update_connected_line(in, &o->connected, NULL);
1153                                                         }
1154                                                 } else if (!ast_test_flag64(o, DIAL_CALLERID_ABSENT)) {
1155                                                         ast_channel_lock(c);
1156                                                         ast_connected_line_copy_from_caller(&connected_caller, ast_channel_caller(c));
1157                                                         ast_channel_unlock(c);
1158                                                         connected_caller.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
1159                                                         if (ast_channel_connected_line_sub(c, in, &connected_caller, 0) &&
1160                                                                 ast_channel_connected_line_macro(c, in, &connected_caller, 1, 0)) {
1161                                                                 ast_channel_update_connected_line(in, &connected_caller, NULL);
1162                                                         }
1163                                                         ast_party_connected_line_free(&connected_caller);
1164                                                 }
1165                                         }
1166                                         if (o->aoc_s_rate_list) {
1167                                                 size_t encoded_size;
1168                                                 struct ast_aoc_encoded *encoded;
1169                                                 if ((encoded = ast_aoc_encode(o->aoc_s_rate_list, &encoded_size, o->chan))) {
1170                                                         ast_indicate_data(in, AST_CONTROL_AOC, encoded, encoded_size);
1171                                                         ast_aoc_destroy_encoded(encoded);
1172                                                 }
1173                                         }
1174                                         peer = c;
1175                                         ast_copy_flags64(peerflags, o,
1176                                                 OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
1177                                                 OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
1178                                                 OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
1179                                                 OPT_CALLEE_PARK | OPT_CALLER_PARK |
1180                                                 OPT_CALLEE_MIXMONITOR | OPT_CALLER_MIXMONITOR |
1181                                                 DIAL_NOFORWARDHTML);
1182                                         ast_channel_dialcontext_set(c, "");
1183                                         ast_channel_exten_set(c, "");
1184                                 }
1185                                 continue;
1186                         }
1187                         if (c != winner)
1188                                 continue;
1189                         /* here, o->chan == c == winner */
1190                         if (!ast_strlen_zero(ast_channel_call_forward(c))) {
1191                                 pa->sentringing = 0;
1192                                 if (!ignore_cc && (f = ast_read(c))) {
1193                                         if (f->frametype == AST_FRAME_CONTROL && f->subclass.integer == AST_CONTROL_CC) {
1194                                                 /* This channel is forwarding the call, and is capable of CC, so
1195                                                  * be sure to add the new device interface to the list
1196                                                  */
1197                                                 ast_handle_cc_control_frame(in, c, f->data.ptr);
1198                                         }
1199                                         ast_frfree(f);
1200                                 }
1201
1202                                 if (o->pending_connected_update) {
1203                                         /*
1204                                          * Re-seed the chanlist's connected line information with
1205                                          * previously acquired connected line info from the incoming
1206                                          * channel.  The previously acquired connected line info could
1207                                          * have been set through the CONNECTED_LINE dialplan function.
1208                                          */
1209                                         o->pending_connected_update = 0;
1210                                         ast_channel_lock(in);
1211                                         ast_party_connected_line_copy(&o->connected, ast_channel_connected(in));
1212                                         ast_channel_unlock(in);
1213                                 }
1214
1215                                 do_forward(o, &num, peerflags, single, caller_entertained, to,
1216                                         forced_clid, stored_clid);
1217
1218                                 if (single && o->chan
1219                                         && !ast_test_flag64(o, OPT_IGNORE_CONNECTEDLINE)
1220                                         && !ast_test_flag64(o, DIAL_CALLERID_ABSENT)) {
1221                                         ast_channel_lock(o->chan);
1222                                         ast_connected_line_copy_from_caller(&connected_caller,
1223                                                 ast_channel_caller(o->chan));
1224                                         ast_channel_unlock(o->chan);
1225                                         connected_caller.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
1226                                         if (ast_channel_connected_line_sub(o->chan, in, &connected_caller, 0) &&
1227                                                 ast_channel_connected_line_macro(o->chan, in, &connected_caller, 1, 0)) {
1228                                                 ast_channel_update_connected_line(in, &connected_caller, NULL);
1229                                         }
1230                                         ast_party_connected_line_free(&connected_caller);
1231                                 }
1232                                 continue;
1233                         }
1234                         f = ast_read(winner);
1235                         if (!f) {
1236                                 ast_channel_hangupcause_set(in, ast_channel_hangupcause(c));
1237 #ifdef HAVE_EPOLL
1238                                 ast_poll_channel_del(in, c);
1239 #endif
1240                                 ast_channel_publish_dial(in, c, NULL, ast_hangup_cause_to_dial_status(ast_channel_hangupcause(c)));
1241                                 ast_hangup(c);
1242                                 c = o->chan = NULL;
1243                                 ast_clear_flag64(o, DIAL_STILLGOING);
1244                                 handle_cause(ast_channel_hangupcause(in), &num);
1245                                 continue;
1246                         }
1247                         switch (f->frametype) {
1248                         case AST_FRAME_CONTROL:
1249                                 switch (f->subclass.integer) {
1250                                 case AST_CONTROL_ANSWER:
1251                                         /* This is our guy if someone answered. */
1252                                         if (!peer) {
1253                                                 ast_verb(3, "%s answered %s\n", ast_channel_name(c), ast_channel_name(in));
1254                                                 if (!single && !ast_test_flag64(o, OPT_IGNORE_CONNECTEDLINE)) {
1255                                                         if (o->pending_connected_update) {
1256                                                                 if (ast_channel_connected_line_sub(c, in, &o->connected, 0) &&
1257                                                                         ast_channel_connected_line_macro(c, in, &o->connected, 1, 0)) {
1258                                                                         ast_channel_update_connected_line(in, &o->connected, NULL);
1259                                                                 }
1260                                                         } else if (!ast_test_flag64(o, DIAL_CALLERID_ABSENT)) {
1261                                                                 ast_channel_lock(c);
1262                                                                 ast_connected_line_copy_from_caller(&connected_caller, ast_channel_caller(c));
1263                                                                 ast_channel_unlock(c);
1264                                                                 connected_caller.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
1265                                                                 if (ast_channel_connected_line_sub(c, in, &connected_caller, 0) &&
1266                                                                         ast_channel_connected_line_macro(c, in, &connected_caller, 1, 0)) {
1267                                                                         ast_channel_update_connected_line(in, &connected_caller, NULL);
1268                                                                 }
1269                                                                 ast_party_connected_line_free(&connected_caller);
1270                                                         }
1271                                                 }
1272                                                 if (o->aoc_s_rate_list) {
1273                                                         size_t encoded_size;
1274                                                         struct ast_aoc_encoded *encoded;
1275                                                         if ((encoded = ast_aoc_encode(o->aoc_s_rate_list, &encoded_size, o->chan))) {
1276                                                                 ast_indicate_data(in, AST_CONTROL_AOC, encoded, encoded_size);
1277                                                                 ast_aoc_destroy_encoded(encoded);
1278                                                         }
1279                                                 }
1280                                                 peer = c;
1281                                                 /* Inform everyone else that they've been canceled.
1282                                                  * The dial end event for the peer will be sent out after
1283                                                  * other Dial options have been handled.
1284                                                  */
1285                                                 publish_dial_end_event(in, out_chans, peer, "CANCEL");
1286                                                 ast_copy_flags64(peerflags, o,
1287                                                         OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
1288                                                         OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
1289                                                         OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
1290                                                         OPT_CALLEE_PARK | OPT_CALLER_PARK |
1291                                                         OPT_CALLEE_MIXMONITOR | OPT_CALLER_MIXMONITOR |
1292                                                         DIAL_NOFORWARDHTML);
1293                                                 ast_channel_dialcontext_set(c, "");
1294                                                 ast_channel_exten_set(c, "");
1295                                                 if (CAN_EARLY_BRIDGE(peerflags, in, peer)) {
1296                                                         /* Setup early bridge if appropriate */
1297                                                         ast_channel_early_bridge(in, peer);
1298                                                 }
1299                                         }
1300                                         /* If call has been answered, then the eventual hangup is likely to be normal hangup */
1301                                         ast_channel_hangupcause_set(in, AST_CAUSE_NORMAL_CLEARING);
1302                                         ast_channel_hangupcause_set(c, AST_CAUSE_NORMAL_CLEARING);
1303                                         break;
1304                                 case AST_CONTROL_BUSY:
1305                                         ast_verb(3, "%s is busy\n", ast_channel_name(c));
1306                                         ast_channel_hangupcause_set(in, ast_channel_hangupcause(c));
1307                                         ast_channel_publish_dial(in, c, NULL, "BUSY");
1308                                         ast_hangup(c);
1309                                         c = o->chan = NULL;
1310                                         ast_clear_flag64(o, DIAL_STILLGOING);
1311                                         handle_cause(AST_CAUSE_BUSY, &num);
1312                                         break;
1313                                 case AST_CONTROL_CONGESTION:
1314                                         ast_verb(3, "%s is circuit-busy\n", ast_channel_name(c));
1315                                         ast_channel_hangupcause_set(in, ast_channel_hangupcause(c));
1316                                         ast_channel_publish_dial(in, c, NULL, "CONGESTION");
1317                                         ast_hangup(c);
1318                                         c = o->chan = NULL;
1319                                         ast_clear_flag64(o, DIAL_STILLGOING);
1320                                         handle_cause(AST_CAUSE_CONGESTION, &num);
1321                                         break;
1322                                 case AST_CONTROL_RINGING:
1323                                         /* This is a tricky area to get right when using a native
1324                                          * CC agent. The reason is that we do the best we can to send only a
1325                                          * single ringing notification to the caller.
1326                                          *
1327                                          * Call completion complicates the logic used here. CCNR is typically
1328                                          * offered during a ringing message. Let's say that party A calls
1329                                          * parties B, C, and D. B and C do not support CC requests, but D
1330                                          * does. If we were to receive a ringing notification from B before
1331                                          * the others, then we would end up sending a ringing message to
1332                                          * A with no CCNR offer present.
1333                                          *
1334                                          * The approach that we have taken is that if we receive a ringing
1335                                          * response from a party and no CCNR offer is present, we need to
1336                                          * wait. Specifically, we need to wait until either a) a called party
1337                                          * offers CCNR in its ringing response or b) all called parties have
1338                                          * responded in some way to our call and none offers CCNR.
1339                                          *
1340                                          * The drawback to this is that if one of the parties has a delayed
1341                                          * response or, god forbid, one just plain doesn't respond to our
1342                                          * outgoing call, then this will result in a significant delay between
1343                                          * when the caller places the call and hears ringback.
1344                                          *
1345                                          * Note also that if CC is disabled for this call, then it is perfectly
1346                                          * fine for ringing frames to get sent through.
1347                                          */
1348                                         ++num_ringing;
1349                                         if (ignore_cc || cc_frame_received || num_ringing == numlines) {
1350                                                 ast_verb(3, "%s is ringing\n", ast_channel_name(c));
1351                                                 /* Setup early media if appropriate */
1352                                                 if (single && !caller_entertained
1353                                                         && CAN_EARLY_BRIDGE(peerflags, in, c)) {
1354                                                         ast_channel_early_bridge(in, c);
1355                                                 }
1356                                                 if (!(pa->sentringing) && !ast_test_flag64(outgoing, OPT_MUSICBACK) && ast_strlen_zero(opt_args[OPT_ARG_RINGBACK])) {
1357                                                         ast_indicate(in, AST_CONTROL_RINGING);
1358                                                         pa->sentringing++;
1359                                                 }
1360                                         }
1361                                         break;
1362                                 case AST_CONTROL_PROGRESS:
1363                                         ast_verb(3, "%s is making progress passing it to %s\n", ast_channel_name(c), ast_channel_name(in));
1364                                         /* Setup early media if appropriate */
1365                                         if (single && !caller_entertained
1366                                                 && CAN_EARLY_BRIDGE(peerflags, in, c)) {
1367                                                 ast_channel_early_bridge(in, c);
1368                                         }
1369                                         if (!ast_test_flag64(outgoing, OPT_RINGBACK)) {
1370                                                 if (single || (!single && !pa->sentringing)) {
1371                                                         ast_indicate(in, AST_CONTROL_PROGRESS);
1372                                                 }
1373                                         }
1374                                         if (!ast_strlen_zero(dtmf_progress)) {
1375                                                 ast_verb(3,
1376                                                         "Sending DTMF '%s' to the called party as result of receiving a PROGRESS message.\n",
1377                                                         dtmf_progress);
1378                                                 ast_dtmf_stream(c, in, dtmf_progress, 250, 0);
1379                                         }
1380                                         break;
1381                                 case AST_CONTROL_VIDUPDATE:
1382                                 case AST_CONTROL_SRCUPDATE:
1383                                 case AST_CONTROL_SRCCHANGE:
1384                                         if (!single || caller_entertained) {
1385                                                 break;
1386                                         }
1387                                         ast_verb(3, "%s requested media update control %d, passing it to %s\n",
1388                                                 ast_channel_name(c), f->subclass.integer, ast_channel_name(in));
1389                                         ast_indicate(in, f->subclass.integer);
1390                                         break;
1391                                 case AST_CONTROL_CONNECTED_LINE:
1392                                         if (ast_test_flag64(o, OPT_IGNORE_CONNECTEDLINE)) {
1393                                                 ast_verb(3, "Connected line update to %s prevented.\n", ast_channel_name(in));
1394                                                 break;
1395                                         }
1396                                         if (!single) {
1397                                                 struct ast_party_connected_line connected;
1398
1399                                                 ast_verb(3, "%s connected line has changed. Saving it until answer for %s\n",
1400                                                         ast_channel_name(c), ast_channel_name(in));
1401                                                 ast_party_connected_line_set_init(&connected, &o->connected);
1402                                                 ast_connected_line_parse_data(f->data.ptr, f->datalen, &connected);
1403                                                 ast_party_connected_line_set(&o->connected, &connected, NULL);
1404                                                 ast_party_connected_line_free(&connected);
1405                                                 o->pending_connected_update = 1;
1406                                                 break;
1407                                         }
1408                                         if (ast_channel_connected_line_sub(c, in, f, 1) &&
1409                                                 ast_channel_connected_line_macro(c, in, f, 1, 1)) {
1410                                                 ast_indicate_data(in, AST_CONTROL_CONNECTED_LINE, f->data.ptr, f->datalen);
1411                                         }
1412                                         break;
1413                                 case AST_CONTROL_AOC:
1414                                         {
1415                                                 struct ast_aoc_decoded *decoded = ast_aoc_decode(f->data.ptr, f->datalen, o->chan);
1416                                                 if (decoded && (ast_aoc_get_msg_type(decoded) == AST_AOC_S)) {
1417                                                         ast_aoc_destroy_decoded(o->aoc_s_rate_list);
1418                                                         o->aoc_s_rate_list = decoded;
1419                                                 } else {
1420                                                         ast_aoc_destroy_decoded(decoded);
1421                                                 }
1422                                         }
1423                                         break;
1424                                 case AST_CONTROL_REDIRECTING:
1425                                         if (!single) {
1426                                                 /*
1427                                                  * Redirecting updates to the caller make sense only on single
1428                                                  * calls.
1429                                                  */
1430                                                 break;
1431                                         }
1432                                         if (ast_test_flag64(o, OPT_IGNORE_CONNECTEDLINE)) {
1433                                                 ast_verb(3, "Redirecting update to %s prevented.\n", ast_channel_name(in));
1434                                                 break;
1435                                         }
1436                                         ast_verb(3, "%s redirecting info has changed, passing it to %s\n",
1437                                                 ast_channel_name(c), ast_channel_name(in));
1438                                         if (ast_channel_redirecting_sub(c, in, f, 1) &&
1439                                                 ast_channel_redirecting_macro(c, in, f, 1, 1)) {
1440                                                 ast_indicate_data(in, AST_CONTROL_REDIRECTING, f->data.ptr, f->datalen);
1441                                         }
1442                                         pa->sentringing = 0;
1443                                         break;
1444                                 case AST_CONTROL_PROCEEDING:
1445                                         ast_verb(3, "%s is proceeding passing it to %s\n", ast_channel_name(c), ast_channel_name(in));
1446                                         if (single && !caller_entertained
1447                                                 && CAN_EARLY_BRIDGE(peerflags, in, c)) {
1448                                                 ast_channel_early_bridge(in, c);
1449                                         }
1450                                         if (!ast_test_flag64(outgoing, OPT_RINGBACK))
1451                                                 ast_indicate(in, AST_CONTROL_PROCEEDING);
1452                                         break;
1453                                 case AST_CONTROL_HOLD:
1454                                         /* XXX this should be saved like AST_CONTROL_CONNECTED_LINE for !single || caller_entertained */
1455                                         ast_verb(3, "Call on %s placed on hold\n", ast_channel_name(c));
1456                                         ast_indicate_data(in, AST_CONTROL_HOLD, f->data.ptr, f->datalen);
1457                                         break;
1458                                 case AST_CONTROL_UNHOLD:
1459                                         /* XXX this should be saved like AST_CONTROL_CONNECTED_LINE for !single || caller_entertained */
1460                                         ast_verb(3, "Call on %s left from hold\n", ast_channel_name(c));
1461                                         ast_indicate(in, AST_CONTROL_UNHOLD);
1462                                         break;
1463                                 case AST_CONTROL_OFFHOOK:
1464                                 case AST_CONTROL_FLASH:
1465                                         /* Ignore going off hook and flash */
1466                                         break;
1467                                 case AST_CONTROL_CC:
1468                                         if (!ignore_cc) {
1469                                                 ast_handle_cc_control_frame(in, c, f->data.ptr);
1470                                                 cc_frame_received = 1;
1471                                         }
1472                                         break;
1473                                 case AST_CONTROL_PVT_CAUSE_CODE:
1474                                         ast_indicate_data(in, AST_CONTROL_PVT_CAUSE_CODE, f->data.ptr, f->datalen);
1475                                         break;
1476                                 case -1:
1477                                         if (single && !caller_entertained) {
1478                                                 ast_verb(3, "%s stopped sounds\n", ast_channel_name(c));
1479                                                 ast_indicate(in, -1);
1480                                                 pa->sentringing = 0;
1481                                         }
1482                                         break;
1483                                 default:
1484                                         ast_debug(1, "Dunno what to do with control type %d\n", f->subclass.integer);
1485                                         break;
1486                                 }
1487                                 break;
1488                         case AST_FRAME_VOICE:
1489                         case AST_FRAME_IMAGE:
1490                                 if (caller_entertained) {
1491                                         break;
1492                                 }
1493                                 /* Fall through */
1494                         case AST_FRAME_TEXT:
1495                                 if (single && ast_write(in, f)) {
1496                                         ast_log(LOG_WARNING, "Unable to write frametype: %d\n",
1497                                                 f->frametype);
1498                                 }
1499                                 break;
1500                         case AST_FRAME_HTML:
1501                                 if (single && !ast_test_flag64(outgoing, DIAL_NOFORWARDHTML)
1502                                         && ast_channel_sendhtml(in, f->subclass.integer, f->data.ptr, f->datalen) == -1) {
1503                                         ast_log(LOG_WARNING, "Unable to send URL\n");
1504                                 }
1505                                 break;
1506                         default:
1507                                 break;
1508                         }
1509                         ast_frfree(f);
1510                 } /* end for */
1511                 if (winner == in) {
1512                         struct ast_frame *f = ast_read(in);
1513 #if 0
1514                         if (f && (f->frametype != AST_FRAME_VOICE))
1515                                 printf("Frame type: %d, %d\n", f->frametype, f->subclass);
1516                         else if (!f || (f->frametype != AST_FRAME_VOICE))
1517                                 printf("Hangup received on %s\n", in->name);
1518 #endif
1519                         if (!f || ((f->frametype == AST_FRAME_CONTROL) && (f->subclass.integer == AST_CONTROL_HANGUP))) {
1520                                 /* Got hung up */
1521                                 *to = -1;
1522                                 strcpy(pa->status, "CANCEL");
1523                                 publish_dial_end_event(in, out_chans, NULL, pa->status);
1524                                 if (f) {
1525                                         if (f->data.uint32) {
1526                                                 ast_channel_hangupcause_set(in, f->data.uint32);
1527                                         }
1528                                         ast_frfree(f);
1529                                 }
1530                                 if (is_cc_recall) {
1531                                         ast_cc_completed(in, "CC completed, although the caller hung up (cancelled)");
1532                                 }
1533                                 return NULL;
1534                         }
1535
1536                         /* now f is guaranteed non-NULL */
1537                         if (f->frametype == AST_FRAME_DTMF) {
1538                                 if (ast_test_flag64(peerflags, OPT_DTMF_EXIT)) {
1539                                         const char *context;
1540                                         ast_channel_lock(in);
1541                                         context = pbx_builtin_getvar_helper(in, "EXITCONTEXT");
1542                                         if (onedigit_goto(in, context, (char) f->subclass.integer, 1)) {
1543                                                 ast_verb(3, "User hit %c to disconnect call.\n", f->subclass.integer);
1544                                                 *to = 0;
1545                                                 *result = f->subclass.integer;
1546                                                 strcpy(pa->status, "CANCEL");
1547                                                 publish_dial_end_event(in, out_chans, NULL, pa->status);
1548                                                 ast_frfree(f);
1549                                                 ast_channel_unlock(in);
1550                                                 if (is_cc_recall) {
1551                                                         ast_cc_completed(in, "CC completed, but the caller used DTMF to exit");
1552                                                 }
1553                                                 return NULL;
1554                                         }
1555                                         ast_channel_unlock(in);
1556                                 }
1557
1558                                 if (ast_test_flag64(peerflags, OPT_CALLER_HANGUP) &&
1559                                         detect_disconnect(in, f->subclass.integer, &featurecode)) {
1560                                         ast_verb(3, "User requested call disconnect.\n");
1561                                         *to = 0;
1562                                         strcpy(pa->status, "CANCEL");
1563                                         publish_dial_end_event(in, out_chans, NULL, pa->status);
1564                                         ast_frfree(f);
1565                                         if (is_cc_recall) {
1566                                                 ast_cc_completed(in, "CC completed, but the caller hung up with DTMF");
1567                                         }
1568                                         return NULL;
1569                                 }
1570                         }
1571
1572                         /* Send the frame from the in channel to all outgoing channels. */
1573                         AST_LIST_TRAVERSE(out_chans, o, node) {
1574                                 if (!o->chan || !ast_test_flag64(o, DIAL_STILLGOING)) {
1575                                         /* This outgoing channel has died so don't send the frame to it. */
1576                                         continue;
1577                                 }
1578                                 switch (f->frametype) {
1579                                 case AST_FRAME_HTML:
1580                                         /* Forward HTML stuff */
1581                                         if (!ast_test_flag64(o, DIAL_NOFORWARDHTML)
1582                                                 && ast_channel_sendhtml(o->chan, f->subclass.integer, f->data.ptr, f->datalen) == -1) {
1583                                                 ast_log(LOG_WARNING, "Unable to send URL\n");
1584                                         }
1585                                         break;
1586                                 case AST_FRAME_VOICE:
1587                                 case AST_FRAME_IMAGE:
1588                                         if (!single || caller_entertained) {
1589                                                 /*
1590                                                  * We are calling multiple parties or caller is being
1591                                                  * entertained and has thus not been made compatible.
1592                                                  * No need to check any other called parties.
1593                                                  */
1594                                                 goto skip_frame;
1595                                         }
1596                                         /* Fall through */
1597                                 case AST_FRAME_TEXT:
1598                                 case AST_FRAME_DTMF_BEGIN:
1599                                 case AST_FRAME_DTMF_END:
1600                                         if (ast_write(o->chan, f)) {
1601                                                 ast_log(LOG_WARNING, "Unable to forward frametype: %d\n",
1602                                                         f->frametype);
1603                                         }
1604                                         break;
1605                                 case AST_FRAME_CONTROL:
1606                                         switch (f->subclass.integer) {
1607                                         case AST_CONTROL_HOLD:
1608                                                 ast_verb(3, "Call on %s placed on hold\n", ast_channel_name(o->chan));
1609                                                 ast_indicate_data(o->chan, AST_CONTROL_HOLD, f->data.ptr, f->datalen);
1610                                                 break;
1611                                         case AST_CONTROL_UNHOLD:
1612                                                 ast_verb(3, "Call on %s left from hold\n", ast_channel_name(o->chan));
1613                                                 ast_indicate(o->chan, AST_CONTROL_UNHOLD);
1614                                                 break;
1615                                         case AST_CONTROL_VIDUPDATE:
1616                                         case AST_CONTROL_SRCUPDATE:
1617                                         case AST_CONTROL_SRCCHANGE:
1618                                                 if (!single || caller_entertained) {
1619                                                         /*
1620                                                          * We are calling multiple parties or caller is being
1621                                                          * entertained and has thus not been made compatible.
1622                                                          * No need to check any other called parties.
1623                                                          */
1624                                                         goto skip_frame;
1625                                                 }
1626                                                 ast_verb(3, "%s requested media update control %d, passing it to %s\n",
1627                                                         ast_channel_name(in), f->subclass.integer, ast_channel_name(o->chan));
1628                                                 ast_indicate(o->chan, f->subclass.integer);
1629                                                 break;
1630                                         case AST_CONTROL_CONNECTED_LINE:
1631                                                 if (ast_channel_connected_line_sub(in, o->chan, f, 1) &&
1632                                                         ast_channel_connected_line_macro(in, o->chan, f, 0, 1)) {
1633                                                         ast_indicate_data(o->chan, f->subclass.integer, f->data.ptr, f->datalen);
1634                                                 }
1635                                                 break;
1636                                         case AST_CONTROL_REDIRECTING:
1637                                                 if (ast_channel_redirecting_sub(in, o->chan, f, 1) &&
1638                                                         ast_channel_redirecting_macro(in, o->chan, f, 0, 1)) {
1639                                                         ast_indicate_data(o->chan, f->subclass.integer, f->data.ptr, f->datalen);
1640                                                 }
1641                                                 break;
1642                                         default:
1643                                                 /* We are not going to do anything with this frame. */
1644                                                 goto skip_frame;
1645                                         }
1646                                         break;
1647                                 default:
1648                                         /* We are not going to do anything with this frame. */
1649                                         goto skip_frame;
1650                                 }
1651                         }
1652 skip_frame:;
1653                         ast_frfree(f);
1654                 }
1655         }
1656
1657         if (!*to || ast_check_hangup(in)) {
1658                 ast_verb(3, "Nobody picked up in %d ms\n", orig);
1659                 publish_dial_end_event(in, out_chans, NULL, "NOANSWER");
1660         }
1661
1662 #ifdef HAVE_EPOLL
1663         AST_LIST_TRAVERSE(out_chans, epollo, node) {
1664                 if (epollo->chan)
1665                         ast_poll_channel_del(in, epollo->chan);
1666         }
1667 #endif
1668
1669         if (is_cc_recall) {
1670                 ast_cc_completed(in, "Recall completed!");
1671         }
1672         return peer;
1673 }
1674
1675 static int detect_disconnect(struct ast_channel *chan, char code, struct ast_str **featurecode)
1676 {
1677         char disconnect_code[AST_FEATURE_MAX_LEN];
1678         int res;
1679
1680         ast_str_append(featurecode, 1, "%c", code);
1681
1682         res = ast_get_builtin_feature(chan, "disconnect", disconnect_code, sizeof(disconnect_code));
1683         if (res) {
1684                 ast_str_reset(*featurecode);
1685                 return 0;
1686         }
1687
1688         if (strlen(disconnect_code) > ast_str_strlen(*featurecode)) {
1689                 /* Could be a partial match, anyway */
1690                 if (strncmp(disconnect_code, ast_str_buffer(*featurecode), ast_str_strlen(*featurecode))) {
1691                         ast_str_reset(*featurecode);
1692                 }
1693                 return 0;
1694         }
1695
1696         if (strcmp(disconnect_code, ast_str_buffer(*featurecode))) {
1697                 ast_str_reset(*featurecode);
1698                 return 0;
1699         }
1700
1701         return 1;
1702 }
1703
1704 /* returns true if there is a valid privacy reply */
1705 static int valid_priv_reply(struct ast_flags64 *opts, int res)
1706 {
1707         if (res < '1')
1708                 return 0;
1709         if (ast_test_flag64(opts, OPT_PRIVACY) && res <= '5')
1710                 return 1;
1711         if (ast_test_flag64(opts, OPT_SCREENING) && res <= '4')
1712                 return 1;
1713         return 0;
1714 }
1715
1716 static int do_privacy(struct ast_channel *chan, struct ast_channel *peer,
1717         struct ast_flags64 *opts, char **opt_args, struct privacy_args *pa)
1718 {
1719
1720         int res2;
1721         int loopcount = 0;
1722
1723         /* Get the user's intro, store it in priv-callerintros/$CID,
1724            unless it is already there-- this should be done before the
1725            call is actually dialed  */
1726
1727         /* all ring indications and moh for the caller has been halted as soon as the
1728            target extension was picked up. We are going to have to kill some
1729            time and make the caller believe the peer hasn't picked up yet */
1730
1731         if (ast_test_flag64(opts, OPT_MUSICBACK) && !ast_strlen_zero(opt_args[OPT_ARG_MUSICBACK])) {
1732                 char *original_moh = ast_strdupa(ast_channel_musicclass(chan));
1733                 ast_indicate(chan, -1);
1734                 ast_channel_musicclass_set(chan, opt_args[OPT_ARG_MUSICBACK]);
1735                 ast_moh_start(chan, opt_args[OPT_ARG_MUSICBACK], NULL);
1736                 ast_channel_musicclass_set(chan, original_moh);
1737         } else if (ast_test_flag64(opts, OPT_RINGBACK) || ast_test_flag64(opts, OPT_RING_WITH_EARLY_MEDIA)) {
1738                 ast_indicate(chan, AST_CONTROL_RINGING);
1739                 pa->sentringing++;
1740         }
1741
1742         /* Start autoservice on the other chan ?? */
1743         res2 = ast_autoservice_start(chan);
1744         /* Now Stream the File */
1745         for (loopcount = 0; loopcount < 3; loopcount++) {
1746                 if (res2 && loopcount == 0) /* error in ast_autoservice_start() */
1747                         break;
1748                 if (!res2) /* on timeout, play the message again */
1749                         res2 = ast_play_and_wait(peer, "priv-callpending");
1750                 if (!valid_priv_reply(opts, res2))
1751                         res2 = 0;
1752                 /* priv-callpending script:
1753                    "I have a caller waiting, who introduces themselves as:"
1754                 */
1755                 if (!res2)
1756                         res2 = ast_play_and_wait(peer, pa->privintro);
1757                 if (!valid_priv_reply(opts, res2))
1758                         res2 = 0;
1759                 /* now get input from the called party, as to their choice */
1760                 if (!res2) {
1761                         /* XXX can we have both, or they are mutually exclusive ? */
1762                         if (ast_test_flag64(opts, OPT_PRIVACY))
1763                                 res2 = ast_play_and_wait(peer, "priv-callee-options");
1764                         if (ast_test_flag64(opts, OPT_SCREENING))
1765                                 res2 = ast_play_and_wait(peer, "screen-callee-options");
1766                 }
1767
1768                 /*! \page DialPrivacy Dial Privacy scripts
1769                  * \par priv-callee-options script:
1770                  * \li Dial 1 if you wish this caller to reach you directly in the future,
1771                  *      and immediately connect to their incoming call.
1772                  * \li Dial 2 if you wish to send this caller to voicemail now and forevermore.
1773                  * \li Dial 3 to send this caller to the torture menus, now and forevermore.
1774                  * \li Dial 4 to send this caller to a simple "go away" menu, now and forevermore.
1775                  * \li Dial 5 to allow this caller to come straight thru to you in the future,
1776                  *      but right now, just this once, send them to voicemail.
1777                  *
1778                  * \par screen-callee-options script:
1779                  * \li Dial 1 if you wish to immediately connect to the incoming call
1780                  * \li Dial 2 if you wish to send this caller to voicemail.
1781                  * \li Dial 3 to send this caller to the torture menus.
1782                  * \li Dial 4 to send this caller to a simple "go away" menu.
1783                  */
1784                 if (valid_priv_reply(opts, res2))
1785                         break;
1786                 /* invalid option */
1787                 res2 = ast_play_and_wait(peer, "vm-sorry");
1788         }
1789
1790         if (ast_test_flag64(opts, OPT_MUSICBACK)) {
1791                 ast_moh_stop(chan);
1792         } else if (ast_test_flag64(opts, OPT_RINGBACK) || ast_test_flag64(opts, OPT_RING_WITH_EARLY_MEDIA)) {
1793                 ast_indicate(chan, -1);
1794                 pa->sentringing = 0;
1795         }
1796         ast_autoservice_stop(chan);
1797         if (ast_test_flag64(opts, OPT_PRIVACY) && (res2 >= '1' && res2 <= '5')) {
1798                 /* map keypresses to various things, the index is res2 - '1' */
1799                 static const char * const _val[] = { "ALLOW", "DENY", "TORTURE", "KILL", "ALLOW" };
1800                 static const int _flag[] = { AST_PRIVACY_ALLOW, AST_PRIVACY_DENY, AST_PRIVACY_TORTURE, AST_PRIVACY_KILL, AST_PRIVACY_ALLOW};
1801                 int i = res2 - '1';
1802                 ast_verb(3, "--Set privacy database entry %s/%s to %s\n",
1803                         opt_args[OPT_ARG_PRIVACY], pa->privcid, _val[i]);
1804                 ast_privacy_set(opt_args[OPT_ARG_PRIVACY], pa->privcid, _flag[i]);
1805         }
1806         switch (res2) {
1807         case '1':
1808                 break;
1809         case '2':
1810                 ast_copy_string(pa->status, "NOANSWER", sizeof(pa->status));
1811                 break;
1812         case '3':
1813                 ast_copy_string(pa->status, "TORTURE", sizeof(pa->status));
1814                 break;
1815         case '4':
1816                 ast_copy_string(pa->status, "DONTCALL", sizeof(pa->status));
1817                 break;
1818         case '5':
1819                 /* XXX should we set status to DENY ? */
1820                 if (ast_test_flag64(opts, OPT_PRIVACY))
1821                         break;
1822                 /* if not privacy, then 5 is the same as "default" case */
1823         default: /* bad input or -1 if failure to start autoservice */
1824                 /* well, if the user messes up, ... he had his chance... What Is The Best Thing To Do?  */
1825                 /* well, there seems basically two choices. Just patch the caller thru immediately,
1826                           or,... put 'em thru to voicemail. */
1827                 /* since the callee may have hung up, let's do the voicemail thing, no database decision */
1828                 ast_log(LOG_NOTICE, "privacy: no valid response from the callee. Sending the caller to voicemail, the callee isn't responding\n");
1829                 /* XXX should we set status to DENY ? */
1830                 /* XXX what about the privacy flags ? */
1831                 break;
1832         }
1833
1834         if (res2 == '1') { /* the only case where we actually connect */
1835                 /* if the intro is NOCALLERID, then there's no reason to leave it on disk, it'll
1836                    just clog things up, and it's not useful information, not being tied to a CID */
1837                 if (strncmp(pa->privcid, "NOCALLERID", 10) == 0 || ast_test_flag64(opts, OPT_SCREEN_NOINTRO)) {
1838                         ast_filedelete(pa->privintro, NULL);
1839                         if (ast_fileexists(pa->privintro, NULL, NULL) > 0)
1840                                 ast_log(LOG_NOTICE, "privacy: ast_filedelete didn't do its job on %s\n", pa->privintro);
1841                         else
1842                                 ast_verb(3, "Successfully deleted %s intro file\n", pa->privintro);
1843                 }
1844                 return 0; /* the good exit path */
1845         } else {
1846                 /* hang up on the callee -- he didn't want to talk anyway! */
1847                 ast_autoservice_chan_hangup_peer(chan, peer);
1848                 return -1;
1849         }
1850 }
1851
1852 /*! \brief returns 1 if successful, 0 or <0 if the caller should 'goto out' */
1853 static int setup_privacy_args(struct privacy_args *pa,
1854         struct ast_flags64 *opts, char *opt_args[], struct ast_channel *chan)
1855 {
1856         char callerid[60];
1857         int res;
1858         char *l;
1859
1860         if (ast_channel_caller(chan)->id.number.valid
1861                 && !ast_strlen_zero(ast_channel_caller(chan)->id.number.str)) {
1862                 l = ast_strdupa(ast_channel_caller(chan)->id.number.str);
1863                 ast_shrink_phone_number(l);
1864                 if (ast_test_flag64(opts, OPT_PRIVACY) ) {
1865                         ast_verb(3, "Privacy DB is '%s', clid is '%s'\n", opt_args[OPT_ARG_PRIVACY], l);
1866                         pa->privdb_val = ast_privacy_check(opt_args[OPT_ARG_PRIVACY], l);
1867                 } else {
1868                         ast_verb(3, "Privacy Screening, clid is '%s'\n", l);
1869                         pa->privdb_val = AST_PRIVACY_UNKNOWN;
1870                 }
1871         } else {
1872                 char *tnam, *tn2;
1873
1874                 tnam = ast_strdupa(ast_channel_name(chan));
1875                 /* clean the channel name so slashes don't try to end up in disk file name */
1876                 for (tn2 = tnam; *tn2; tn2++) {
1877                         if (*tn2 == '/')  /* any other chars to be afraid of? */
1878                                 *tn2 = '=';
1879                 }
1880                 ast_verb(3, "Privacy-- callerid is empty\n");
1881
1882                 snprintf(callerid, sizeof(callerid), "NOCALLERID_%s%s", ast_channel_exten(chan), tnam);
1883                 l = callerid;
1884                 pa->privdb_val = AST_PRIVACY_UNKNOWN;
1885         }
1886
1887         ast_copy_string(pa->privcid, l, sizeof(pa->privcid));
1888
1889         if (strncmp(pa->privcid, "NOCALLERID", 10) != 0 && ast_test_flag64(opts, OPT_SCREEN_NOCALLERID)) {
1890                 /* if callerid is set and OPT_SCREEN_NOCALLERID is set also */
1891                 ast_verb(3, "CallerID set (%s); N option set; Screening should be off\n", pa->privcid);
1892                 pa->privdb_val = AST_PRIVACY_ALLOW;
1893         } else if (ast_test_flag64(opts, OPT_SCREEN_NOCALLERID) && strncmp(pa->privcid, "NOCALLERID", 10) == 0) {
1894                 ast_verb(3, "CallerID blank; N option set; Screening should happen; dbval is %d\n", pa->privdb_val);
1895         }
1896
1897         if (pa->privdb_val == AST_PRIVACY_DENY) {
1898                 ast_verb(3, "Privacy DB reports PRIVACY_DENY for this callerid. Dial reports unavailable\n");
1899                 ast_copy_string(pa->status, "NOANSWER", sizeof(pa->status));
1900                 return 0;
1901         } else if (pa->privdb_val == AST_PRIVACY_KILL) {
1902                 ast_copy_string(pa->status, "DONTCALL", sizeof(pa->status));
1903                 return 0; /* Is this right? */
1904         } else if (pa->privdb_val == AST_PRIVACY_TORTURE) {
1905                 ast_copy_string(pa->status, "TORTURE", sizeof(pa->status));
1906                 return 0; /* is this right??? */
1907         } else if (pa->privdb_val == AST_PRIVACY_UNKNOWN) {
1908                 /* Get the user's intro, store it in priv-callerintros/$CID,
1909                    unless it is already there-- this should be done before the
1910                    call is actually dialed  */
1911
1912                 /* make sure the priv-callerintros dir actually exists */
1913                 snprintf(pa->privintro, sizeof(pa->privintro), "%s/sounds/priv-callerintros", ast_config_AST_DATA_DIR);
1914                 if ((res = ast_mkdir(pa->privintro, 0755))) {
1915                         ast_log(LOG_WARNING, "privacy: can't create directory priv-callerintros: %s\n", strerror(res));
1916                         return -1;
1917                 }
1918
1919                 snprintf(pa->privintro, sizeof(pa->privintro), "priv-callerintros/%s", pa->privcid);
1920                 if (ast_fileexists(pa->privintro, NULL, NULL ) > 0 && strncmp(pa->privcid, "NOCALLERID", 10) != 0) {
1921                         /* the DELUX version of this code would allow this caller the
1922                            option to hear and retape their previously recorded intro.
1923                         */
1924                 } else {
1925                         int duration; /* for feedback from play_and_wait */
1926                         /* the file doesn't exist yet. Let the caller submit his
1927                            vocal intro for posterity */
1928                         /* priv-recordintro script:
1929
1930                            "At the tone, please say your name:"
1931
1932                         */
1933                         int silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
1934                         ast_answer(chan);
1935                         res = ast_play_and_record(chan, "priv-recordintro", pa->privintro, 4, "sln", &duration, NULL, silencethreshold, 2000, 0);  /* NOTE: I've reduced the total time to 4 sec */
1936                                                                         /* don't think we'll need a lock removed, we took care of
1937                                                                            conflicts by naming the pa.privintro file */
1938                         if (res == -1) {
1939                                 /* Delete the file regardless since they hung up during recording */
1940                                 ast_filedelete(pa->privintro, NULL);
1941                                 if (ast_fileexists(pa->privintro, NULL, NULL) > 0)
1942                                         ast_log(LOG_NOTICE, "privacy: ast_filedelete didn't do its job on %s\n", pa->privintro);
1943                                 else
1944                                         ast_verb(3, "Successfully deleted %s intro file\n", pa->privintro);
1945                                 return -1;
1946                         }
1947                         if (!ast_streamfile(chan, "vm-dialout", ast_channel_language(chan)) )
1948                                 ast_waitstream(chan, "");
1949                 }
1950         }
1951         return 1; /* success */
1952 }
1953
1954 static void end_bridge_callback(void *data)
1955 {
1956         char buf[80];
1957         time_t end;
1958         struct ast_channel *chan = data;
1959
1960         time(&end);
1961
1962         ast_channel_lock(chan);
1963         ast_channel_stage_snapshot(chan);
1964         snprintf(buf, sizeof(buf), "%d", ast_channel_get_up_time(chan));
1965         pbx_builtin_setvar_helper(chan, "ANSWEREDTIME", buf);
1966         snprintf(buf, sizeof(buf), "%d", ast_channel_get_duration(chan));
1967         pbx_builtin_setvar_helper(chan, "DIALEDTIME", buf);
1968         ast_channel_stage_snapshot_done(chan);
1969         ast_channel_unlock(chan);
1970 }
1971
1972 static void end_bridge_callback_data_fixup(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator) {
1973         bconfig->end_bridge_callback_data = originator;
1974 }
1975
1976 static int dial_handle_playtones(struct ast_channel *chan, const char *data)
1977 {
1978         struct ast_tone_zone_sound *ts = NULL;
1979         int res;
1980         const char *str = data;
1981
1982         if (ast_strlen_zero(str)) {
1983                 ast_debug(1,"Nothing to play\n");
1984                 return -1;
1985         }
1986
1987         ts = ast_get_indication_tone(ast_channel_zone(chan), str);
1988
1989         if (ts && ts->data[0]) {
1990                 res = ast_playtones_start(chan, 0, ts->data, 0);
1991         } else {
1992                 res = -1;
1993         }
1994
1995         if (ts) {
1996                 ts = ast_tone_zone_sound_unref(ts);
1997         }
1998
1999         if (res) {
2000                 ast_log(LOG_WARNING, "Unable to start playtone \'%s\'\n", str);
2001         }
2002
2003         return res;
2004 }
2005
2006 /*!
2007  * \internal
2008  * \brief Setup the after bridge goto location on the peer.
2009  * \since 12.0.0
2010  *
2011  * \param chan Calling channel for bridge.
2012  * \param peer Peer channel for bridge.
2013  * \param opts Dialing option flags.
2014  * \param opt_args Dialing option argument strings.
2015  *
2016  * \return Nothing
2017  */
2018 static void setup_peer_after_bridge_goto(struct ast_channel *chan, struct ast_channel *peer, struct ast_flags64 *opts, char *opt_args[])
2019 {
2020         const char *context;
2021         const char *extension;
2022         int priority;
2023
2024         if (ast_test_flag64(opts, OPT_PEER_H)) {
2025                 ast_channel_lock(chan);
2026                 context = ast_strdupa(ast_channel_context(chan));
2027                 ast_channel_unlock(chan);
2028                 ast_bridge_set_after_h(peer, context);
2029         } else if (ast_test_flag64(opts, OPT_CALLEE_GO_ON)) {
2030                 ast_channel_lock(chan);
2031                 context = ast_strdupa(ast_channel_context(chan));
2032                 extension = ast_strdupa(ast_channel_exten(chan));
2033                 priority = ast_channel_priority(chan);
2034                 ast_channel_unlock(chan);
2035                 ast_bridge_set_after_go_on(peer, context, extension, priority,
2036                         opt_args[OPT_ARG_CALLEE_GO_ON]);
2037         }
2038 }
2039
2040 static int dial_exec_full(struct ast_channel *chan, const char *data, struct ast_flags64 *peerflags, int *continue_exec)
2041 {
2042         int res = -1; /* default: error */
2043         char *rest, *cur; /* scan the list of destinations */
2044         struct dial_head out_chans = AST_LIST_HEAD_NOLOCK_INIT_VALUE; /* list of destinations */
2045         struct chanlist *outgoing;
2046         struct chanlist *tmp;
2047         struct ast_channel *peer;
2048         int to; /* timeout */
2049         struct cause_args num = { chan, 0, 0, 0 };
2050         int cause;
2051
2052         struct ast_bridge_config config = { { 0, } };
2053         struct timeval calldurationlimit = { 0, };
2054         char *dtmfcalled = NULL, *dtmfcalling = NULL, *dtmf_progress=NULL;
2055         struct privacy_args pa = {
2056                 .sentringing = 0,
2057                 .privdb_val = 0,
2058                 .status = "INVALIDARGS",
2059         };
2060         int sentringing = 0, moh = 0;
2061         const char *outbound_group = NULL;
2062         int result = 0;
2063         char *parse;
2064         int opermode = 0;
2065         int delprivintro = 0;
2066         AST_DECLARE_APP_ARGS(args,
2067                 AST_APP_ARG(peers);
2068                 AST_APP_ARG(timeout);
2069                 AST_APP_ARG(options);
2070                 AST_APP_ARG(url);
2071         );
2072         struct ast_flags64 opts = { 0, };
2073         char *opt_args[OPT_ARG_ARRAY_SIZE];
2074         struct ast_datastore *datastore = NULL;
2075         int fulldial = 0, num_dialed = 0;
2076         int ignore_cc = 0;
2077         char device_name[AST_CHANNEL_NAME];
2078         char forced_clid_name[AST_MAX_EXTENSION];
2079         char stored_clid_name[AST_MAX_EXTENSION];
2080         int force_forwards_only;        /*!< TRUE if force CallerID on call forward only. Legacy behaviour.*/
2081         /*!
2082          * \brief Forced CallerID party information to send.
2083          * \note This will not have any malloced strings so do not free it.
2084          */
2085         struct ast_party_id forced_clid;
2086         /*!
2087          * \brief Stored CallerID information if needed.
2088          *
2089          * \note If OPT_ORIGINAL_CLID set then this is the o option
2090          * CallerID.  Otherwise it is the dialplan extension and hint
2091          * name.
2092          *
2093          * \note This will not have any malloced strings so do not free it.
2094          */
2095         struct ast_party_id stored_clid;
2096         /*!
2097          * \brief CallerID party information to store.
2098          * \note This will not have any malloced strings so do not free it.
2099          */
2100         struct ast_party_caller caller;
2101
2102         /* Reset all DIAL variables back to blank, to prevent confusion (in case we don't reset all of them). */
2103         ast_channel_lock(chan);
2104         ast_channel_stage_snapshot(chan);
2105         pbx_builtin_setvar_helper(chan, "DIALSTATUS", "");
2106         pbx_builtin_setvar_helper(chan, "DIALEDPEERNUMBER", "");
2107         pbx_builtin_setvar_helper(chan, "DIALEDPEERNAME", "");
2108         pbx_builtin_setvar_helper(chan, "ANSWEREDTIME", "");
2109         pbx_builtin_setvar_helper(chan, "DIALEDTIME", "");
2110         ast_channel_stage_snapshot_done(chan);
2111         ast_channel_unlock(chan);
2112
2113         if (ast_strlen_zero(data)) {
2114                 ast_log(LOG_WARNING, "Dial requires an argument (technology/resource)\n");
2115                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
2116                 return -1;
2117         }
2118
2119         parse = ast_strdupa(data);
2120
2121         AST_STANDARD_APP_ARGS(args, parse);
2122
2123         if (!ast_strlen_zero(args.options) &&
2124                 ast_app_parse_options64(dial_exec_options, &opts, opt_args, args.options)) {
2125                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
2126                 goto done;
2127         }
2128
2129         if (ast_strlen_zero(args.peers)) {
2130                 ast_log(LOG_WARNING, "Dial requires an argument (technology/resource)\n");
2131                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
2132                 goto done;
2133         }
2134
2135         if (ast_cc_call_init(chan, &ignore_cc)) {
2136                 goto done;
2137         }
2138
2139         if (ast_test_flag64(&opts, OPT_SCREEN_NOINTRO) && !ast_strlen_zero(opt_args[OPT_ARG_SCREEN_NOINTRO])) {
2140                 delprivintro = atoi(opt_args[OPT_ARG_SCREEN_NOINTRO]);
2141
2142                 if (delprivintro < 0 || delprivintro > 1) {
2143                         ast_log(LOG_WARNING, "Unknown argument %d specified to n option, ignoring\n", delprivintro);
2144                         delprivintro = 0;
2145                 }
2146         }
2147
2148         if (!ast_test_flag64(&opts, OPT_RINGBACK)) {
2149                 opt_args[OPT_ARG_RINGBACK] = NULL;
2150         }
2151
2152         if (ast_test_flag64(&opts, OPT_OPERMODE)) {
2153                 opermode = ast_strlen_zero(opt_args[OPT_ARG_OPERMODE]) ? 1 : atoi(opt_args[OPT_ARG_OPERMODE]);
2154                 ast_verb(3, "Setting operator services mode to %d.\n", opermode);
2155         }
2156
2157         if (ast_test_flag64(&opts, OPT_DURATION_STOP) && !ast_strlen_zero(opt_args[OPT_ARG_DURATION_STOP])) {
2158                 calldurationlimit.tv_sec = atoi(opt_args[OPT_ARG_DURATION_STOP]);
2159                 if (!calldurationlimit.tv_sec) {
2160                         ast_log(LOG_WARNING, "Dial does not accept S(%s), hanging up.\n", opt_args[OPT_ARG_DURATION_STOP]);
2161                         pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
2162                         goto done;
2163                 }
2164                 ast_verb(3, "Setting call duration limit to %.3lf seconds.\n", calldurationlimit.tv_sec + calldurationlimit.tv_usec / 1000000.0);
2165         }
2166
2167         if (ast_test_flag64(&opts, OPT_SENDDTMF) && !ast_strlen_zero(opt_args[OPT_ARG_SENDDTMF])) {
2168                 dtmf_progress = opt_args[OPT_ARG_SENDDTMF];
2169                 dtmfcalled = strsep(&dtmf_progress, ":");
2170                 dtmfcalling = strsep(&dtmf_progress, ":");
2171         }
2172
2173         if (ast_test_flag64(&opts, OPT_DURATION_LIMIT) && !ast_strlen_zero(opt_args[OPT_ARG_DURATION_LIMIT])) {
2174                 if (ast_bridge_timelimit(chan, &config, opt_args[OPT_ARG_DURATION_LIMIT], &calldurationlimit))
2175                         goto done;
2176         }
2177
2178         /* Setup the forced CallerID information to send if used. */
2179         ast_party_id_init(&forced_clid);
2180         force_forwards_only = 0;
2181         if (ast_test_flag64(&opts, OPT_FORCECLID)) {
2182                 if (ast_strlen_zero(opt_args[OPT_ARG_FORCECLID])) {
2183                         ast_channel_lock(chan);
2184                         forced_clid.number.str = ast_strdupa(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)));
2185                         ast_channel_unlock(chan);
2186                         forced_clid_name[0] = '\0';
2187                         forced_clid.name.str = (char *) get_cid_name(forced_clid_name,
2188                                 sizeof(forced_clid_name), chan);
2189                         force_forwards_only = 1;
2190                 } else {
2191                         /* Note: The opt_args[OPT_ARG_FORCECLID] string value is altered here. */
2192                         ast_callerid_parse(opt_args[OPT_ARG_FORCECLID], &forced_clid.name.str,
2193                                 &forced_clid.number.str);
2194                 }
2195                 if (!ast_strlen_zero(forced_clid.name.str)) {
2196                         forced_clid.name.valid = 1;
2197                 }
2198                 if (!ast_strlen_zero(forced_clid.number.str)) {
2199                         forced_clid.number.valid = 1;
2200                 }
2201         }
2202         if (ast_test_flag64(&opts, OPT_FORCE_CID_TAG)
2203                 && !ast_strlen_zero(opt_args[OPT_ARG_FORCE_CID_TAG])) {
2204                 forced_clid.tag = opt_args[OPT_ARG_FORCE_CID_TAG];
2205         }
2206         forced_clid.number.presentation = AST_PRES_ALLOWED_USER_NUMBER_PASSED_SCREEN;
2207         if (ast_test_flag64(&opts, OPT_FORCE_CID_PRES)
2208                 && !ast_strlen_zero(opt_args[OPT_ARG_FORCE_CID_PRES])) {
2209                 int pres;
2210
2211                 pres = ast_parse_caller_presentation(opt_args[OPT_ARG_FORCE_CID_PRES]);
2212                 if (0 <= pres) {
2213                         forced_clid.number.presentation = pres;
2214                 }
2215         }
2216
2217         /* Setup the stored CallerID information if needed. */
2218         ast_party_id_init(&stored_clid);
2219         if (ast_test_flag64(&opts, OPT_ORIGINAL_CLID)) {
2220                 if (ast_strlen_zero(opt_args[OPT_ARG_ORIGINAL_CLID])) {
2221                         ast_channel_lock(chan);
2222                         ast_party_id_set_init(&stored_clid, &ast_channel_caller(chan)->id);
2223                         if (!ast_strlen_zero(ast_channel_caller(chan)->id.name.str)) {
2224                                 stored_clid.name.str = ast_strdupa(ast_channel_caller(chan)->id.name.str);
2225                         }
2226                         if (!ast_strlen_zero(ast_channel_caller(chan)->id.number.str)) {
2227                                 stored_clid.number.str = ast_strdupa(ast_channel_caller(chan)->id.number.str);
2228                         }
2229                         if (!ast_strlen_zero(ast_channel_caller(chan)->id.subaddress.str)) {
2230                                 stored_clid.subaddress.str = ast_strdupa(ast_channel_caller(chan)->id.subaddress.str);
2231                         }
2232                         if (!ast_strlen_zero(ast_channel_caller(chan)->id.tag)) {
2233                                 stored_clid.tag = ast_strdupa(ast_channel_caller(chan)->id.tag);
2234                         }
2235                         ast_channel_unlock(chan);
2236                 } else {
2237                         /* Note: The opt_args[OPT_ARG_ORIGINAL_CLID] string value is altered here. */
2238                         ast_callerid_parse(opt_args[OPT_ARG_ORIGINAL_CLID], &stored_clid.name.str,
2239                                 &stored_clid.number.str);
2240                         if (!ast_strlen_zero(stored_clid.name.str)) {
2241                                 stored_clid.name.valid = 1;
2242                         }
2243                         if (!ast_strlen_zero(stored_clid.number.str)) {
2244                                 stored_clid.number.valid = 1;
2245                         }
2246                 }
2247         } else {
2248                 /*
2249                  * In case the new channel has no preset CallerID number by the
2250                  * channel driver, setup the dialplan extension and hint name.
2251                  */
2252                 stored_clid_name[0] = '\0';
2253                 stored_clid.name.str = (char *) get_cid_name(stored_clid_name,
2254                         sizeof(stored_clid_name), chan);
2255                 if (ast_strlen_zero(stored_clid.name.str)) {
2256                         stored_clid.name.str = NULL;
2257                 } else {
2258                         stored_clid.name.valid = 1;
2259                 }
2260                 ast_channel_lock(chan);
2261                 stored_clid.number.str = ast_strdupa(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)));
2262                 stored_clid.number.valid = 1;
2263                 ast_channel_unlock(chan);
2264         }
2265
2266         if (ast_test_flag64(&opts, OPT_RESETCDR)) {
2267                 ast_cdr_reset(ast_channel_name(chan), 0);
2268         }
2269         if (ast_test_flag64(&opts, OPT_PRIVACY) && ast_strlen_zero(opt_args[OPT_ARG_PRIVACY]))
2270                 opt_args[OPT_ARG_PRIVACY] = ast_strdupa(ast_channel_exten(chan));
2271
2272         if (ast_test_flag64(&opts, OPT_PRIVACY) || ast_test_flag64(&opts, OPT_SCREENING)) {
2273                 res = setup_privacy_args(&pa, &opts, opt_args, chan);
2274                 if (res <= 0)
2275                         goto out;
2276                 res = -1; /* reset default */
2277         }
2278
2279         if (continue_exec)
2280                 *continue_exec = 0;
2281
2282         /* If a channel group has been specified, get it for use when we create peer channels */
2283
2284         ast_channel_lock(chan);
2285         if ((outbound_group = pbx_builtin_getvar_helper(chan, "OUTBOUND_GROUP_ONCE"))) {
2286                 outbound_group = ast_strdupa(outbound_group);
2287                 pbx_builtin_setvar_helper(chan, "OUTBOUND_GROUP_ONCE", NULL);
2288         } else if ((outbound_group = pbx_builtin_getvar_helper(chan, "OUTBOUND_GROUP"))) {
2289                 outbound_group = ast_strdupa(outbound_group);
2290         }
2291         ast_channel_unlock(chan);
2292
2293         /* Set per dial instance flags.  These flags are also passed back to RetryDial. */
2294         ast_copy_flags64(peerflags, &opts, OPT_DTMF_EXIT | OPT_GO_ON | OPT_ORIGINAL_CLID
2295                 | OPT_CALLER_HANGUP | OPT_IGNORE_FORWARDING | OPT_CANCEL_TIMEOUT
2296                 | OPT_ANNOUNCE | OPT_CALLEE_MACRO | OPT_CALLEE_GOSUB | OPT_FORCECLID);
2297
2298         /* PREDIAL: Run gosub on the caller's channel */
2299         if (ast_test_flag64(&opts, OPT_PREDIAL_CALLER)
2300                 && !ast_strlen_zero(opt_args[OPT_ARG_PREDIAL_CALLER])) {
2301                 ast_replace_subargument_delimiter(opt_args[OPT_ARG_PREDIAL_CALLER]);
2302                 ast_app_exec_sub(NULL, chan, opt_args[OPT_ARG_PREDIAL_CALLER], 0);
2303         }
2304
2305         /* loop through the list of dial destinations */
2306         rest = args.peers;
2307         while ((cur = strsep(&rest, "&")) ) {
2308                 struct ast_channel *tc; /* channel for this destination */
2309                 /* Get a technology/resource pair */
2310                 char *number = cur;
2311                 char *tech = strsep(&number, "/");
2312                 size_t tech_len;
2313                 size_t number_len;
2314                 /* find if we already dialed this interface */
2315                 struct ast_dialed_interface *di;
2316                 AST_LIST_HEAD(,ast_dialed_interface) *dialed_interfaces;
2317
2318                 num_dialed++;
2319                 if (ast_strlen_zero(number)) {
2320                         ast_log(LOG_WARNING, "Dial argument takes format (technology/resource)\n");
2321                         goto out;
2322                 }
2323
2324                 tech_len = strlen(tech) + 1;
2325                 number_len = strlen(number) + 1;
2326                 tmp = ast_calloc(1, sizeof(*tmp) + (2 * tech_len) + number_len);
2327                 if (!tmp) {
2328                         goto out;
2329                 }
2330
2331                 /* Save tech, number, and interface. */
2332                 cur = tmp->stuff;
2333                 strcpy(cur, tech);
2334                 tmp->tech = cur;
2335                 cur += tech_len;
2336                 strcpy(cur, tech);
2337                 cur[tech_len - 1] = '/';
2338                 tmp->interface = cur;
2339                 cur += tech_len;
2340                 strcpy(cur, number);
2341                 tmp->number = cur;
2342
2343                 if (opts.flags) {
2344                         /* Set per outgoing call leg options. */
2345                         ast_copy_flags64(tmp, &opts,
2346                                 OPT_CANCEL_ELSEWHERE |
2347                                 OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
2348                                 OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
2349                                 OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
2350                                 OPT_CALLEE_PARK | OPT_CALLER_PARK |
2351                                 OPT_CALLEE_MIXMONITOR | OPT_CALLER_MIXMONITOR |
2352                                 OPT_RINGBACK | OPT_MUSICBACK | OPT_FORCECLID | OPT_IGNORE_CONNECTEDLINE |
2353                                 OPT_RING_WITH_EARLY_MEDIA);
2354                         ast_set2_flag64(tmp, args.url, DIAL_NOFORWARDHTML);
2355                 }
2356
2357                 /* Request the peer */
2358
2359                 ast_channel_lock(chan);
2360                 datastore = ast_channel_datastore_find(chan, &dialed_interface_info, NULL);
2361                 /*
2362                  * Seed the chanlist's connected line information with previously
2363                  * acquired connected line info from the incoming channel.  The
2364                  * previously acquired connected line info could have been set
2365                  * through the CONNECTED_LINE dialplan function.
2366                  */
2367                 ast_party_connected_line_copy(&tmp->connected, ast_channel_connected(chan));
2368                 ast_channel_unlock(chan);
2369
2370                 if (datastore)
2371                         dialed_interfaces = datastore->data;
2372                 else {
2373                         if (!(datastore = ast_datastore_alloc(&dialed_interface_info, NULL))) {
2374                                 ast_log(LOG_WARNING, "Unable to create channel datastore for dialed interfaces. Aborting!\n");
2375                                 chanlist_free(tmp);
2376                                 goto out;
2377                         }
2378                         datastore->inheritance = DATASTORE_INHERIT_FOREVER;
2379
2380                         if (!(dialed_interfaces = ast_calloc(1, sizeof(*dialed_interfaces)))) {
2381                                 ast_datastore_free(datastore);
2382                                 chanlist_free(tmp);
2383                                 goto out;
2384                         }
2385
2386                         datastore->data = dialed_interfaces;
2387                         AST_LIST_HEAD_INIT(dialed_interfaces);
2388
2389                         ast_channel_lock(chan);
2390                         ast_channel_datastore_add(chan, datastore);
2391                         ast_channel_unlock(chan);
2392                 }
2393
2394                 AST_LIST_LOCK(dialed_interfaces);
2395                 AST_LIST_TRAVERSE(dialed_interfaces, di, list) {
2396                         if (!strcasecmp(di->interface, tmp->interface)) {
2397                                 ast_log(LOG_WARNING, "Skipping dialing interface '%s' again since it has already been dialed\n",
2398                                         di->interface);
2399                                 break;
2400                         }
2401                 }
2402                 AST_LIST_UNLOCK(dialed_interfaces);
2403                 if (di) {
2404                         fulldial++;
2405                         chanlist_free(tmp);
2406                         continue;
2407                 }
2408
2409                 /* It is always ok to dial a Local interface.  We only keep track of
2410                  * which "real" interfaces have been dialed.  The Local channel will
2411                  * inherit this list so that if it ends up dialing a real interface,
2412                  * it won't call one that has already been called. */
2413                 if (strcasecmp(tmp->tech, "Local")) {
2414                         if (!(di = ast_calloc(1, sizeof(*di) + strlen(tmp->interface)))) {
2415                                 chanlist_free(tmp);
2416                                 goto out;
2417                         }
2418                         strcpy(di->interface, tmp->interface);
2419
2420                         AST_LIST_LOCK(dialed_interfaces);
2421                         AST_LIST_INSERT_TAIL(dialed_interfaces, di, list);
2422                         AST_LIST_UNLOCK(dialed_interfaces);
2423                 }
2424
2425                 tc = ast_request(tmp->tech, ast_channel_nativeformats(chan), NULL, chan, tmp->number, &cause);
2426                 if (!tc) {
2427                         /* If we can't, just go on to the next call */
2428                         ast_log(LOG_WARNING, "Unable to create channel of type '%s' (cause %d - %s)\n",
2429                                 tmp->tech, cause, ast_cause2str(cause));
2430                         handle_cause(cause, &num);
2431                         if (!rest) {
2432                                 /* we are on the last destination */
2433                                 ast_channel_hangupcause_set(chan, cause);
2434                         }
2435                         if (!ignore_cc && (cause == AST_CAUSE_BUSY || cause == AST_CAUSE_CONGESTION)) {
2436                                 if (!ast_cc_callback(chan, tmp->tech, tmp->number, ast_cc_busy_interface)) {
2437                                         ast_cc_extension_monitor_add_dialstring(chan, tmp->interface, "");
2438                                 }
2439                         }
2440                         chanlist_free(tmp);
2441                         continue;
2442                 }
2443
2444                 ast_channel_lock(tc);
2445                 ast_channel_stage_snapshot(tc);
2446                 ast_channel_unlock(tc);
2447
2448                 ast_channel_get_device_name(tc, device_name, sizeof(device_name));
2449                 if (!ignore_cc) {
2450                         ast_cc_extension_monitor_add_dialstring(chan, tmp->interface, device_name);
2451                 }
2452
2453                 ast_channel_lock_both(tc, chan);
2454                 pbx_builtin_setvar_helper(tc, "DIALEDPEERNUMBER", tmp->number);
2455
2456                 /* Setup outgoing SDP to match incoming one */
2457                 if (!AST_LIST_FIRST(&out_chans) && !rest && CAN_EARLY_BRIDGE(peerflags, chan, tc)) {
2458                         /* We are on the only destination. */
2459                         ast_rtp_instance_early_bridge_make_compatible(tc, chan);
2460                 }
2461
2462                 /* Inherit specially named variables from parent channel */
2463                 ast_channel_inherit_variables(chan, tc);
2464                 ast_channel_datastore_inherit(chan, tc);
2465
2466                 ast_channel_appl_set(tc, "AppDial");
2467                 ast_channel_data_set(tc, "(Outgoing Line)");
2468                 ast_channel_publish_snapshot(tc);
2469
2470                 memset(ast_channel_whentohangup(tc), 0, sizeof(*ast_channel_whentohangup(tc)));
2471
2472                 /* Determine CallerID to store in outgoing channel. */
2473                 ast_party_caller_set_init(&caller, ast_channel_caller(tc));
2474                 if (ast_test_flag64(peerflags, OPT_ORIGINAL_CLID)) {
2475                         caller.id = stored_clid;
2476                         ast_channel_set_caller_event(tc, &caller, NULL);
2477                         ast_set_flag64(tmp, DIAL_CALLERID_ABSENT);
2478                 } else if (ast_strlen_zero(S_COR(ast_channel_caller(tc)->id.number.valid,
2479                         ast_channel_caller(tc)->id.number.str, NULL))) {
2480                         /*
2481                          * The new channel has no preset CallerID number by the channel
2482                          * driver.  Use the dialplan extension and hint name.
2483                          */
2484                         caller.id = stored_clid;
2485                         if (!caller.id.name.valid
2486                                 && !ast_strlen_zero(S_COR(ast_channel_connected(chan)->id.name.valid,
2487                                         ast_channel_connected(chan)->id.name.str, NULL))) {
2488                                 /*
2489                                  * No hint name available.  We have a connected name supplied by
2490                                  * the dialplan we can use instead.
2491                                  */
2492                                 caller.id.name.valid = 1;
2493                                 caller.id.name = ast_channel_connected(chan)->id.name;
2494                         }
2495                         ast_channel_set_caller_event(tc, &caller, NULL);
2496                         ast_set_flag64(tmp, DIAL_CALLERID_ABSENT);
2497                 } else if (ast_strlen_zero(S_COR(ast_channel_caller(tc)->id.name.valid, ast_channel_caller(tc)->id.name.str,
2498                         NULL))) {
2499                         /* The new channel has no preset CallerID name by the channel driver. */
2500                         if (!ast_strlen_zero(S_COR(ast_channel_connected(chan)->id.name.valid,
2501                                 ast_channel_connected(chan)->id.name.str, NULL))) {
2502                                 /*
2503                                  * We have a connected name supplied by the dialplan we can
2504                                  * use instead.
2505                                  */
2506                                 caller.id.name.valid = 1;
2507                                 caller.id.name = ast_channel_connected(chan)->id.name;
2508                                 ast_channel_set_caller_event(tc, &caller, NULL);
2509                         }
2510                 }
2511
2512                 /* Determine CallerID for outgoing channel to send. */
2513                 if (ast_test_flag64(peerflags, OPT_FORCECLID) && !force_forwards_only) {
2514                         struct ast_party_connected_line connected;
2515
2516                         ast_party_connected_line_set_init(&connected, ast_channel_connected(tc));
2517                         connected.id = forced_clid;
2518                         ast_channel_set_connected_line(tc, &connected, NULL);
2519                 } else {
2520                         ast_connected_line_copy_from_caller(ast_channel_connected(tc), ast_channel_caller(chan));
2521                 }
2522
2523                 ast_party_redirecting_copy(ast_channel_redirecting(tc), ast_channel_redirecting(chan));
2524
2525                 ast_channel_dialed(tc)->transit_network_select = ast_channel_dialed(chan)->transit_network_select;
2526
2527                 if (!ast_strlen_zero(ast_channel_accountcode(chan))) {
2528                         ast_channel_accountcode_set(tc, ast_channel_accountcode(chan));
2529                 }
2530                 if (ast_strlen_zero(ast_channel_musicclass(tc))) {
2531                         ast_channel_musicclass_set(tc, ast_channel_musicclass(chan));
2532                 }
2533
2534                 /* Pass ADSI CPE and transfer capability */
2535                 ast_channel_adsicpe_set(tc, ast_channel_adsicpe(chan));
2536                 ast_channel_transfercapability_set(tc, ast_channel_transfercapability(chan));
2537
2538                 /* If we have an outbound group, set this peer channel to it */
2539                 if (outbound_group)
2540                         ast_app_group_set_channel(tc, outbound_group);
2541                 /* If the calling channel has the ANSWERED_ELSEWHERE flag set, inherit it. This is to support local channels */
2542                 if (ast_channel_hangupcause(chan) == AST_CAUSE_ANSWERED_ELSEWHERE)
2543                         ast_channel_hangupcause_set(tc, AST_CAUSE_ANSWERED_ELSEWHERE);
2544
2545                 /* Check if we're forced by configuration */
2546                 if (ast_test_flag64(&opts, OPT_CANCEL_ELSEWHERE))
2547                          ast_channel_hangupcause_set(tc, AST_CAUSE_ANSWERED_ELSEWHERE);
2548
2549
2550                 /* Inherit context and extension */
2551                 ast_channel_dialcontext_set(tc, ast_strlen_zero(ast_channel_macrocontext(chan)) ? ast_channel_context(chan) : ast_channel_macrocontext(chan));
2552                 if (!ast_strlen_zero(ast_channel_macroexten(chan)))
2553                         ast_channel_exten_set(tc, ast_channel_macroexten(chan));
2554                 else
2555                         ast_channel_exten_set(tc, ast_channel_exten(chan));
2556
2557                 ast_channel_stage_snapshot_done(tc);
2558
2559                 ast_channel_unlock(tc);
2560                 ast_channel_unlock(chan);
2561
2562                 /* Put channel in the list of outgoing thingies. */
2563                 tmp->chan = tc;
2564                 AST_LIST_INSERT_TAIL(&out_chans, tmp, node);
2565         }
2566
2567         /*
2568          * PREDIAL: Run gosub on all of the callee channels
2569          *
2570          * We run the callee predial before ast_call() in case the user
2571          * wishes to do something on the newly created channels before
2572          * the channel does anything important.
2573          *
2574          * Inside the target gosub we will be able to do something with
2575          * the newly created channel name ie: now the calling channel
2576          * can know what channel will be used to call the destination
2577          * ex: now we will know that SIP/abc-123 is calling SIP/def-124
2578          */
2579         if (ast_test_flag64(&opts, OPT_PREDIAL_CALLEE)
2580                 && !ast_strlen_zero(opt_args[OPT_ARG_PREDIAL_CALLEE])
2581                 && !AST_LIST_EMPTY(&out_chans)) {
2582                 const char *predial_callee;
2583
2584                 ast_replace_subargument_delimiter(opt_args[OPT_ARG_PREDIAL_CALLEE]);
2585                 predial_callee = ast_app_expand_sub_args(chan, opt_args[OPT_ARG_PREDIAL_CALLEE]);
2586                 if (predial_callee) {
2587                         ast_autoservice_start(chan);
2588                         AST_LIST_TRAVERSE(&out_chans, tmp, node) {
2589                                 ast_pre_call(tmp->chan, predial_callee);
2590                         }
2591                         ast_autoservice_stop(chan);
2592                         ast_free((char *) predial_callee);
2593                 }
2594         }
2595
2596         /* Start all outgoing calls */
2597         AST_LIST_TRAVERSE_SAFE_BEGIN(&out_chans, tmp, node) {
2598                 res = ast_call(tmp->chan, tmp->number, 0); /* Place the call, but don't wait on the answer */
2599                 ast_channel_lock(chan);
2600
2601                 /* check the results of ast_call */
2602                 if (res) {
2603                         /* Again, keep going even if there's an error */
2604                         ast_debug(1, "ast call on peer returned %d\n", res);
2605                         ast_verb(3, "Couldn't call %s\n", tmp->interface);
2606                         if (ast_channel_hangupcause(tmp->chan)) {
2607                                 ast_channel_hangupcause_set(chan, ast_channel_hangupcause(tmp->chan));
2608                         }
2609                         ast_channel_unlock(chan);
2610                         ast_cc_call_failed(chan, tmp->chan, tmp->interface);
2611                         ast_hangup(tmp->chan);
2612                         tmp->chan = NULL;
2613                         AST_LIST_REMOVE_CURRENT(node);
2614                         chanlist_free(tmp);
2615                         continue;
2616                 }
2617
2618                 ast_channel_publish_dial(chan, tmp->chan, tmp->number, NULL);
2619                 ast_channel_unlock(chan);
2620
2621                 ast_verb(3, "Called %s\n", tmp->interface);
2622                 ast_set_flag64(tmp, DIAL_STILLGOING);
2623
2624                 /* If this line is up, don't try anybody else */
2625                 if (ast_channel_state(tmp->chan) == AST_STATE_UP) {
2626                         break;
2627                 }
2628         }
2629         AST_LIST_TRAVERSE_SAFE_END;
2630
2631         if (ast_strlen_zero(args.timeout)) {
2632                 to = -1;
2633         } else {
2634                 to = atoi(args.timeout);
2635                 if (to > 0)
2636                         to *= 1000;
2637                 else {
2638                         ast_log(LOG_WARNING, "Invalid timeout specified: '%s'. Setting timeout to infinite\n", args.timeout);
2639                         to = -1;
2640                 }
2641         }
2642
2643         outgoing = AST_LIST_FIRST(&out_chans);
2644         if (!outgoing) {
2645                 strcpy(pa.status, "CHANUNAVAIL");
2646                 if (fulldial == num_dialed) {
2647                         res = -1;
2648                         goto out;
2649                 }
2650         } else {
2651                 /* Our status will at least be NOANSWER */
2652                 strcpy(pa.status, "NOANSWER");
2653                 if (ast_test_flag64(outgoing, OPT_MUSICBACK)) {
2654                         moh = 1;
2655                         if (!ast_strlen_zero(opt_args[OPT_ARG_MUSICBACK])) {
2656                                 char *original_moh = ast_strdupa(ast_channel_musicclass(chan));
2657                                 ast_channel_musicclass_set(chan, opt_args[OPT_ARG_MUSICBACK]);
2658                                 ast_moh_start(chan, opt_args[OPT_ARG_MUSICBACK], NULL);
2659                                 ast_channel_musicclass_set(chan, original_moh);
2660                         } else {
2661                                 ast_moh_start(chan, NULL, NULL);
2662                         }
2663                         ast_indicate(chan, AST_CONTROL_PROGRESS);
2664                 } else if (ast_test_flag64(outgoing, OPT_RINGBACK) || ast_test_flag64(outgoing, OPT_RING_WITH_EARLY_MEDIA)) {
2665                         if (!ast_strlen_zero(opt_args[OPT_ARG_RINGBACK])) {
2666                                 if (dial_handle_playtones(chan, opt_args[OPT_ARG_RINGBACK])){
2667                                         ast_indicate(chan, AST_CONTROL_RINGING);
2668                                         sentringing++;
2669                                 } else {
2670                                         ast_indicate(chan, AST_CONTROL_PROGRESS);
2671                                 }
2672                         } else {
2673                                 ast_indicate(chan, AST_CONTROL_RINGING);
2674                                 sentringing++;
2675                         }
2676                 }
2677         }
2678
2679         peer = wait_for_answer(chan, &out_chans, &to, peerflags, opt_args, &pa, &num, &result,
2680                 dtmf_progress, ignore_cc, &forced_clid, &stored_clid);
2681
2682         /* The ast_channel_datastore_remove() function could fail here if the
2683          * datastore was moved to another channel during a masquerade. If this is
2684          * the case, don't free the datastore here because later, when the channel
2685          * to which the datastore was moved hangs up, it will attempt to free this
2686          * datastore again, causing a crash
2687          */
2688         ast_channel_lock(chan);
2689         datastore = ast_channel_datastore_find(chan, &dialed_interface_info, NULL); /* make sure we weren't cleaned up already */
2690         if (datastore && !ast_channel_datastore_remove(chan, datastore)) {
2691                 ast_datastore_free(datastore);
2692         }
2693         ast_channel_unlock(chan);
2694         if (!peer) {
2695                 if (result) {
2696                         res = result;
2697                 } else if (to) { /* Musta gotten hung up */
2698                         res = -1;
2699                 } else { /* Nobody answered, next please? */
2700                         res = 0;
2701                 }
2702         } else {
2703                 const char *number;
2704
2705                 if (ast_test_flag64(&opts, OPT_CALLER_ANSWER))
2706                         ast_answer(chan);
2707
2708                 strcpy(pa.status, "ANSWER");
2709                 ast_channel_stage_snapshot(chan);
2710                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
2711                 /* Ah ha!  Someone answered within the desired timeframe.  Of course after this
2712                    we will always return with -1 so that it is hung up properly after the
2713                    conversation.  */
2714                 hanguptree(&out_chans, peer, 1);
2715                 /* If appropriate, log that we have a destination channel and set the answer time */
2716                 if (ast_channel_name(peer))
2717                         pbx_builtin_setvar_helper(chan, "DIALEDPEERNAME", ast_channel_name(peer));
2718
2719                 ast_channel_lock(peer);
2720                 number = pbx_builtin_getvar_helper(peer, "DIALEDPEERNUMBER");
2721                 if (ast_strlen_zero(number)) {
2722                         number = NULL;
2723                 } else {
2724                         number = ast_strdupa(number);
2725                 }
2726                 ast_channel_unlock(peer);
2727                 ast_channel_lock(chan);
2728                 pbx_builtin_setvar_helper(chan, "DIALEDPEERNUMBER", number);
2729                 ast_channel_stage_snapshot_done(chan);
2730                 ast_channel_unlock(chan);
2731
2732                 if (!ast_strlen_zero(args.url) && ast_channel_supports_html(peer) ) {
2733                         ast_debug(1, "app_dial: sendurl=%s.\n", args.url);
2734                         ast_channel_sendurl( peer, args.url );
2735                 }
2736                 if ( (ast_test_flag64(&opts, OPT_PRIVACY) || ast_test_flag64(&opts, OPT_SCREENING)) && pa.privdb_val == AST_PRIVACY_UNKNOWN) {
2737                         if (do_privacy(chan, peer, &opts, opt_args, &pa)) {
2738                                 ast_channel_publish_dial(chan, peer, NULL, pa.status);
2739                                 res = 0;
2740                                 goto out;
2741                         }
2742                 }
2743                 if (!ast_test_flag64(&opts, OPT_ANNOUNCE) || ast_strlen_zero(opt_args[OPT_ARG_ANNOUNCE])) {
2744                         res = 0;
2745                 } else {
2746                         int digit = 0;
2747                         struct ast_channel *chans[2];
2748                         struct ast_channel *active_chan;
2749
2750                         chans[0] = chan;
2751                         chans[1] = peer;
2752
2753                         /* we need to stream the announcment while monitoring the caller for a hangup */
2754
2755                         /* stream the file */
2756                         res = ast_streamfile(peer, opt_args[OPT_ARG_ANNOUNCE], ast_channel_language(peer));
2757                         if (res) {
2758                                 res = 0;
2759                                 ast_log(LOG_ERROR, "error streaming file '%s' to callee\n", opt_args[OPT_ARG_ANNOUNCE]);
2760                         }
2761
2762                         ast_set_flag(ast_channel_flags(peer), AST_FLAG_END_DTMF_ONLY);
2763                         while (ast_channel_stream(peer)) {
2764                                 int ms;
2765
2766                                 ms = ast_sched_wait(ast_channel_sched(peer));
2767
2768                                 if (ms < 0 && !ast_channel_timingfunc(peer)) {
2769                                         ast_stopstream(peer);
2770                                         break;
2771                                 }
2772                                 if (ms < 0)
2773                                         ms = 1000;
2774
2775                                 active_chan = ast_waitfor_n(chans, 2, &ms);
2776                                 if (active_chan) {
2777                                         struct ast_frame *fr = ast_read(active_chan);
2778                                         if (!fr) {
2779                                                 ast_autoservice_chan_hangup_peer(chan, peer);
2780                                                 res = -1;
2781                                                 goto done;
2782                                         }
2783                                         switch(fr->frametype) {
2784                                                 case AST_FRAME_DTMF_END:
2785                                                         digit = fr->subclass.integer;
2786                                                         if (active_chan == peer && strchr(AST_DIGIT_ANY, res)) {
2787                                                                 ast_stopstream(peer);
2788                                                                 res = ast_senddigit(chan, digit, 0);
2789                                                         }
2790                                                         break;
2791                                                 case AST_FRAME_CONTROL:
2792                                                         switch (fr->subclass.integer) {
2793                                                                 case AST_CONTROL_HANGUP:
2794                                                                         ast_frfree(fr);
2795                                                                         ast_autoservice_chan_hangup_peer(chan, peer);
2796                                                                         res = -1;
2797                                                                         goto done;
2798                                                                 default:
2799                                                                         break;
2800                                                         }
2801                                                         break;
2802                                                 default:
2803                                                         /* Ignore all others */
2804                                                         break;
2805                                         }
2806                                         ast_frfree(fr);
2807                                 }
2808                                 ast_sched_runq(ast_channel_sched(peer));
2809                         }
2810                         ast_clear_flag(ast_channel_flags(peer), AST_FLAG_END_DTMF_ONLY);
2811                 }
2812
2813                 if (chan && peer && ast_test_flag64(&opts, OPT_GOTO) && !ast_strlen_zero(opt_args[OPT_ARG_GOTO])) {
2814                         /* chan and peer are going into the PBX; as such neither are considered
2815                          * outgoing channels any longer */
2816                         ast_clear_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING);
2817
2818                         ast_replace_subargument_delimiter(opt_args[OPT_ARG_GOTO]);
2819                         ast_parseable_goto(chan, opt_args[OPT_ARG_GOTO]);
2820                         /* peer goes to the same context and extension as chan, so just copy info from chan*/
2821                         ast_channel_lock(peer);
2822                         ast_channel_stage_snapshot(peer);
2823                         ast_clear_flag(ast_channel_flags(peer), AST_FLAG_OUTGOING);
2824                         ast_channel_context_set(peer, ast_channel_context(chan));
2825                         ast_channel_exten_set(peer, ast_channel_exten(chan));
2826                         ast_channel_priority_set(peer, ast_channel_priority(chan) + 2);
2827                         ast_channel_stage_snapshot_done(peer);
2828                         ast_channel_unlock(peer);
2829                         if (ast_pbx_start(peer)) {
2830                                 ast_autoservice_chan_hangup_peer(chan, peer);
2831                         }
2832                         hanguptree(&out_chans, NULL, ast_test_flag64(&opts, OPT_CANCEL_ELSEWHERE) ? 1 : 0);
2833                         if (continue_exec)
2834                                 *continue_exec = 1;
2835                         res = 0;
2836                         ast_channel_publish_dial(chan, peer, NULL, "ANSWER");
2837                         goto done;
2838                 }
2839
2840                 if (ast_test_flag64(&opts, OPT_CALLEE_MACRO) && !ast_strlen_zero(opt_args[OPT_ARG_CALLEE_MACRO])) {
2841                         const char *macro_result_peer;