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