e2e50f90ea50b76c5fc4ad2e961d0a6d35297cd3
[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  ***/
31
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include <sys/time.h>
38 #include <sys/signal.h>
39 #include <sys/stat.h>
40 #include <netinet/in.h>
41
42 #include "asterisk/paths.h" /* use ast_config_AST_DATA_DIR */
43 #include "asterisk/lock.h"
44 #include "asterisk/file.h"
45 #include "asterisk/channel.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/module.h"
48 #include "asterisk/translate.h"
49 #include "asterisk/say.h"
50 #include "asterisk/config.h"
51 #include "asterisk/features.h"
52 #include "asterisk/musiconhold.h"
53 #include "asterisk/callerid.h"
54 #include "asterisk/utils.h"
55 #include "asterisk/app.h"
56 #include "asterisk/causes.h"
57 #include "asterisk/rtp.h"
58 #include "asterisk/cdr.h"
59 #include "asterisk/manager.h"
60 #include "asterisk/privacy.h"
61 #include "asterisk/stringfields.h"
62 #include "asterisk/global_datastores.h"
63 #include "asterisk/dsp.h"
64
65 /*** DOCUMENTATION
66         <application name="Dial" language="en_US">
67                 <synopsis>
68                         Attempt to connect to another device or endpoint and bridge the call.
69                 </synopsis>
70                 <syntax>
71                         <parameter name="Technology/Resource" required="true" argsep="&amp;">
72                                 <argument name="Technology/Resource" required="true">
73                                         <para>Specification of the device(s) to dial.  These must be in the format of
74                                         <literal>Technology/Resource</literal>, where <replaceable>Technology</replaceable>
75                                         represents a particular channel driver, and <replaceable>Resource</replaceable>
76                                         represents a resource available to that particular channel driver.</para>
77                                 </argument>
78                                 <argument name="Technology2/Resource2" required="false" multiple="true">
79                                         <para>Optional extra devices to dial in parallel</para>
80                                         <para>If you need more then one enter them as
81                                         Technology2/Resource2&amp;Technology3/Resourse3&amp;.....</para>
82                                 </argument>
83                         </parameter>
84                         <parameter name="timeout" required="false">
85                                 <para>Specifies the number of seconds we attempt to dial the specified devices</para>
86                                 <para>If not specified, this defaults to 136 years.</para>
87                         </parameter>
88                         <parameter name="options" required="false">
89                            <optionlist>
90                                 <option name="A">
91                                         <argument name="x" required="true">
92                                                 <para>The file to play to the called party</para>
93                                         </argument>
94                                         <para>Play an announcement to the called party, where <replaceable>x</replaceable> is the prompt to be played</para>
95                                 </option>
96                                 <option name="C">
97                                         <para>Reset the call detail record (CDR) for this call.</para>
98                                 </option>
99                                 <option name="c">
100                                         <para>If the Dial() application cancels this call, always set the flag to tell the channel
101                                         driver that the call is answered elsewhere.</para>
102                                 </option>
103                                 <option name="d">
104                                         <para>Allow the calling user to dial a 1 digit extension while waiting for
105                                         a call to be answered. Exit to that extension if it exists in the
106                                         current context, or the context defined in the <variable>EXITCONTEXT</variable> variable,
107                                         if it exists.</para>
108                                 </option>
109                                 <option name="D" argsep=":">
110                                         <argument name="called" />
111                                         <argument name="calling" />
112                                         <para>Send the specified DTMF strings <emphasis>after</emphasis> the called
113                                         party has answered, but before the call gets bridged. The 
114                                         <replaceable>called</replaceable> DTMF string is sent to the called party, and the 
115                                         <replaceable>calling</replaceable> DTMF string is sent to the calling party. Both arguments 
116                                         can be used alone.</para>
117                                 </option>
118                                 <option name="e">
119                                         <para>Execute the <literal>h</literal> extension for peer after the call ends</para>
120                                 </option>
121                                 <option name="f">
122                                         <para>Force the callerid of the <emphasis>calling</emphasis> channel to be set as the
123                                         extension associated with the channel using a dialplan <literal>hint</literal>.
124                                         For example, some PSTNs do not allow CallerID to be set to anything
125                                         other than the number assigned to the caller.</para>
126                                 </option>
127                                 <option name="F" argsep="^">
128                                         <argument name="context" required="false" />
129                                         <argument name="exten" required="false" />
130                                         <argument name="priority" required="true" />
131                                         <para>When the caller hangs up, transfer the called party
132                                         to the specified destination and continue execution at that location.</para>
133                                 </option>
134                                 <option name="g">
135                                         <para>Proceed with dialplan execution at the next priority in the current extension if the
136                                         destination channel hangs up.</para>
137                                 </option>
138                                 <option name="G" argsep="^">
139                                         <argument name="context" required="false" />
140                                         <argument name="exten" required="false" />
141                                         <argument name="priority" required="true" />
142                                         <para>If the call is answered, transfer the calling party to
143                                         the specified <replaceable>priority</replaceable> and the called party to the specified 
144                                         <replaceable>priority</replaceable> plus one.</para>
145                                         <note>
146                                                 <para>You cannot use any additional action post answer options in conjunction with this option.</para>
147                                         </note>
148                                 </option>
149                                 <option name="h">
150                                         <para>Allow the called party to hang up by sending the <literal>*</literal> DTMF digit.</para>
151                                 </option>
152                                 <option name="H">
153                                         <para>Allow the calling party to hang up by hitting the <literal>*</literal> DTMF digit.</para>
154                                 </option>
155                                 <option name="i">
156                                         <para>Asterisk will ignore any forwarding requests it may receive on this dial attempt.</para>
157                                 </option>
158                                 <option name="k">
159                                         <para>Allow the called party to enable parking of the call by sending
160                                         the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
161                                 </option>
162                                 <option name="K">
163                                         <para>Allow the calling party to enable parking of the call by sending
164                                         the DTMF sequence defined for call parking in <filename>features.conf</filename>.</para>
165                                 </option>
166                                 <option name="L" argsep=":">
167                                         <argument name="x" required="true">
168                                                 <para>Maximum call time, in milliseconds</para>
169                                         </argument>
170                                         <argument name="y">
171                                                 <para>Warning time, in milliseconds</para>
172                                         </argument>
173                                         <argument name="z">
174                                                 <para>Repeat time, in milliseconds</para>
175                                         </argument>
176                                         <para>Limit the call to <replaceable>x</replaceable> milliseconds. Play a warning when <replaceable>y</replaceable> milliseconds are
177                                         left. Repeat the warning every <replaceable>z</replaceable> milliseconds until time expires.</para>
178                                         <para>This option is affected by the following variables:</para>
179                                         <variablelist>
180                                                 <variable name="LIMIT_PLAYAUDIO_CALLER">
181                                                         <value name="yes" default="true" />
182                                                         <value name="no" />
183                                                         <para>If set, this variable causes Asterisk to play the prompts to the caller.</para>
184                                                 </variable>
185                                                 <variable name="LIMIT_PLAYAUDIO_CALLEE">
186                                                         <value name="yes" />
187                                                         <value name="no" default="true"/>
188                                                         <para>If set, this variable causes Asterisk to play the prompts to the callee.</para>
189                                                 </variable>
190                                                 <variable name="LIMIT_TIMEOUT_FILE">
191                                                         <value name="filename"/>
192                                                         <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play when the timeout is reached.
193                                                         If not set, the time remaining will be announced.</para>
194                                                 </variable>
195                                                 <variable name="LIMIT_CONNECT_FILE">
196                                                         <value name="filename"/>
197                                                         <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play when the call begins.
198                                                         If not set, the time remaining will be announced.</para>
199                                                 </variable>
200                                                 <variable name="LIMIT_WARNING_FILE">
201                                                         <value name="filename"/>
202                                                         <para>If specified, <replaceable>filename</replaceable> specifies the sound prompt to play as
203                                                         a warning when time <replaceable>x</replaceable> is reached. If not set, the time remaining will be announced.</para>
204                                                 </variable>
205                                         </variablelist>
206                                 </option>
207                                 <option name="m">
208                                         <argument name="class" required="false"/>
209                                         <para>Provide hold music to the calling party until a requested
210                                         channel answers. A specific music on hold <replaceable>class</replaceable>
211                                         (as defined in <filename>musiconhold.conf</filename>) can be specified.</para>
212                                 </option>
213                                 <option name="M" argsep="^">
214                                         <argument name="macro" required="true">
215                                                 <para>Name of the macro that should be executed.</para>
216                                         </argument>
217                                         <argument name="arg" multiple="true">
218                                                 <para>Macro arguments</para>
219                                         </argument>
220                                         <para>Execute the specified <replaceable>macro</replaceable> for the <emphasis>called</emphasis> channel 
221                                         before connecting to the calling channel. Arguments can be specified to the Macro
222                                         using <literal>^</literal> as a delimiter. The macro can set the variable
223                                         <variable>MACRO_RESULT</variable> to specify the following actions after the macro is
224                                         finished executing:</para>
225                                         <variablelist>
226                                                 <variable name="MACRO_RESULT">
227                                                         <para>If set, this action will be taken after the macro finished executing.</para>
228                                                         <value name="ABORT">
229                                                                 Hangup both legs of the call
230                                                         </value>
231                                                         <value name="CONGESTION">
232                                                                 Behave as if line congestion was encountered
233                                                         </value>
234                                                         <value name="BUSY">
235                                                                 Behave as if a busy signal was encountered
236                                                         </value>
237                                                         <value name="CONTINUE">
238                                                                 Hangup the called party and allow the calling party to continue dialplan execution at the next priority
239                                                         </value>
240                                                         <!-- TODO: Fix this syntax up, once we've figured out how to specify the GOTO syntax -->
241                                                         <value name="GOTO:&lt;context&gt;^&lt;exten&gt;^&lt;priority&gt;">
242                                                                 Transfer the call to the specified destination.
243                                                         </value>
244                                                 </variable>
245                                         </variablelist>
246                                         <note>
247                                                 <para>You cannot use any additional action post answer options in conjunction
248                                                 with this option. Also, pbx services are not run on the peer (called) channel,
249                                                 so you will not be able to set timeouts via the TIMEOUT() function in this macro.</para>
250                                         </note>
251                                 </option>
252                                 <option name="n">
253                                         <para>This option is a modifier for the call screening/privacy mode. (See the 
254                                         <literal>p</literal> and <literal>P</literal> options.) It specifies
255                                         that no introductions are to be saved in the <directory>priv-callerintros</directory>
256                                         directory.</para>
257                                 </option>
258                                 <option name="N">
259                                         <para>This option is a modifier for the call screening/privacy mode. It specifies
260                                         that if Caller*ID is present, do not screen the call.</para>
261                                 </option>
262                                 <option name="o">
263                                         <para>Specify that the Caller*ID that was present on the <emphasis>calling</emphasis> channel
264                                         be set as the Caller*ID on the <emphasis>called</emphasis> channel. This was the
265                                         behavior of Asterisk 1.0 and earlier.</para>
266                                 </option>
267                                 <option name="O">
268                                         <argument name="mode">
269                                                 <para>With <replaceable>mode</replaceable> either not specified or set to <literal>1</literal>,
270                                                 the originator hanging up will cause the phone to ring back immediately.</para>
271                                                 <para>With <replaceable>mode</replaceable> set to <literal>2</literal>, when the operator 
272                                                 flashes the trunk, it will ring their phone back.</para>
273                                         </argument>
274                                         <para>Enables <emphasis>operator services</emphasis> mode.  This option only
275                                         works when bridging a DAHDI channel to another DAHDI channel
276                                         only. if specified on non-DAHDI interfaces, it will be ignored.
277                                         When the destination answers (presumably an operator services
278                                         station), the originator no longer has control of their line.
279                                         They may hang up, but the switch will not release their line
280                                         until the destination party (the operator) hangs up.</para>
281                                 </option>
282                                 <option name="p">
283                                         <para>This option enables screening mode. This is basically Privacy mode
284                                         without memory.</para>
285                                 </option>
286                                 <option name="P">
287                                         <argument name="x" />
288                                         <para>Enable privacy mode. Use <replaceable>x</replaceable> as the family/key in the AstDB database if
289                                         it is provided. The current extension is used if a database family/key is not specified.</para>
290                                 </option>
291                                 <option name="r">
292                                         <para>Indicate ringing to the calling party, even if the called party isn't actually ringing. Pass no audio to the calling
293                                         party until the called channel has answered.</para>
294                                 </option>
295                                 <option name="S">
296                                         <argument name="x" required="true" />
297                                         <para>Hang up the call <replaceable>x</replaceable> seconds <emphasis>after</emphasis> the called party has
298                                         answered the call.</para>
299                                 </option>
300                                 <option name="t">
301                                         <para>Allow the called party to transfer the calling party by sending the
302                                         DTMF sequence defined in <filename>features.conf</filename>.</para>
303                                 </option>
304                                 <option name="T">
305                                         <para>Allow the calling party to transfer the called party by sending the
306                                         DTMF sequence defined in <filename>features.conf</filename>.</para>
307                                 </option>
308                                 <option name="U" argsep="^">
309                                         <argument name="x" required="true">
310                                                 <para>Name of the subroutine to execute via Gosub</para>
311                                         </argument>
312                                         <argument name="arg" multiple="true" required="false">
313                                                 <para>Arguments for the Gosub routine</para>
314                                         </argument>
315                                         <para>Execute via Gosub the routine <replaceable>x</replaceable> for the <emphasis>called</emphasis> channel before connecting
316                                         to the calling channel. Arguments can be specified to the Gosub
317                                         using <literal>^</literal> as a delimiter. The Gosub routine can set the variable
318                                         <variable>GOSUB_RESULT</variable> to specify the following actions after the Gosub returns.</para>
319                                         <variablelist>
320                                                 <variable name="GOSUB_RESULT">
321                                                         <value name="ABORT">
322                                                                 Hangup both legs of the call.
323                                                         </value>
324                                                         <value name="CONGESTION">
325                                                                 Behave as if line congestion was encountered.
326                                                         </value>
327                                                         <value name="BUSY">
328                                                                 Behave as if a busy signal was encountered.
329                                                         </value>
330                                                         <value name="CONTINUE">
331                                                                 Hangup the called party and allow the calling party
332                                                                 to continue dialplan execution at the next priority.
333                                                         </value>
334                                                         <!-- TODO: Fix this syntax up, once we've figured out how to specify the GOTO syntax -->
335                                                         <value name="GOTO:&lt;context&gt;^&lt;exten&gt;^&lt;priority&gt;">
336                                                                 Transfer the call to the specified priority. Optionally, an extension, or
337                                                                 extension and priority can be specified.
338                                                         </value>
339                                                 </variable>
340                                         </variablelist>
341                                         <note>
342                                                 <para>You cannot use any additional action post answer options in conjunction
343                                                 with this option. Also, pbx services are not run on the peer (called) channel,
344                                                 so you will not be able to set timeouts via the TIMEOUT() function in this routine.</para>
345                                         </note>
346                                 </option>
347                                 <option name="w">
348                                         <para>Allow the called party to enable recording of the call by sending
349                                         the DTMF sequence defined for one-touch recording in <filename>features.conf</filename>.</para>
350                                 </option>
351                                 <option name="W">
352                                         <para>Allow the calling party to enable recording of the call by sending
353                                         the DTMF sequence defined for one-touch recording in <filename>features.conf</filename>.</para>
354                                 </option>
355                                 <option name="x">
356                                         <para>Allow the called party to enable recording of the call by sending
357                                         the DTMF sequence defined for one-touch automixmonitor in <filename>features.conf</filename>.</para>
358                                 </option>
359                                 <option name="X">
360                                         <para>Allow the calling party to enable recording of the call by sending
361                                         the DTMF sequence defined for one-touch automixmonitor in <filename>features.conf</filename>.</para>
362                                 </option>
363                                 </optionlist>
364                         </parameter>
365                         <parameter name="URL">
366                                 <para>The optional URL will be sent to the called party if the channel driver supports it.</para>
367                         </parameter>
368                 </syntax>
369                 <description>
370                         <para>This application will place calls to one or more specified channels. As soon
371                         as one of the requested channels answers, the originating channel will be
372                         answered, if it has not already been answered. These two channels will then
373                         be active in a bridged call. All other channels that were requested will then
374                         be hung up.</para>
375
376                         <para>Unless there is a timeout specified, the Dial application will wait
377                         indefinitely until one of the called channels answers, the user hangs up, or
378                         if all of the called channels are busy or unavailable. Dialplan executing will
379                         continue if no requested channels can be called, or if the timeout expires.
380                         This application will report normal termination if the originating channel
381                         hangs up, or if the call is bridged and either of the parties in the bridge
382                         ends the call.</para>
383
384                         <para>If the <variable>OUTBOUND_GROUP</variable> variable is set, all peer channels created by this
385                         application will be put into that group (as in Set(GROUP()=...).
386                         If the <variable>OUTBOUND_GROUP_ONCE</variable> variable is set, all peer channels created by this
387                         application will be put into that group (as in Set(GROUP()=...). Unlike OUTBOUND_GROUP,
388                         however, the variable will be unset after use.</para>
389
390                         <para>This application sets the following channel variables:</para>
391                         <variablelist>
392                                 <variable name="DIALEDTIME">
393                                         <para>This is the time from dialing a channel until when it is disconnected.</para>
394                                 </variable>
395                                 <variable name="ANSWEREDTIME">
396                                         <para>This is the amount of time for actual call.</para>
397                                 </variable>
398                                 <variable name="DIALSTATUS">
399                                         <para>This is the status of the call</para>
400                                         <value name="CHANUNAVAIL" />
401                                         <value name="CONGESTION" />
402                                         <value name="NOANSWER" />
403                                         <value name="BUSY" />
404                                         <value name="ANSWER" />
405                                         <value name="CANCEL" />
406                                         <value name="DONTCALL">
407                                                 For the Privacy and Screening Modes.
408                                                 Will be set if the called party chooses to send the calling party to the 'Go Away' script.
409                                         </value>
410                                         <value name="TORTURE">
411                                                 For the Privacy and Screening Modes.
412                                                 Will be set if the called party chooses to send the calling party to the 'torture' script.
413                                         </value>
414                                         <value name="INVALIDARGS" />
415                                 </variable>
416                         </variablelist>
417                 </description>
418         </application>
419         <application name="RetryDial" language="en_US">
420                 <synopsis>
421                         Place a call, retrying on failure allowing an optional exit extension.
422                 </synopsis>
423                 <syntax>
424                         <parameter name="announce" required="true">
425                                 <para>Filename of sound that will be played when no channel can be reached</para>
426                         </parameter>
427                         <parameter name="sleep" required="true">
428                                 <para>Number of seconds to wait after a dial attempt failed before a new attempt is made</para>
429                         </parameter>
430                         <parameter name="retries" required="true">
431                                 <para>Number of retries</para>
432                                 <para>When this is reached flow will continue at the next priority in the dialplan</para>
433                         </parameter>
434                         <parameter name="dialargs" required="true">
435                                 <para>Same format as arguments provided to the Dial application</para>
436                         </parameter>
437                 </syntax>
438                 <description>
439                         <para>This application will attempt to place a call using the normal Dial application.
440                         If no channel can be reached, the <replaceable>announce</replaceable> file will be played.
441                         Then, it will wait <replaceable>sleep</replaceable> number of seconds before retrying the call.
442                         After <replaceable>retries</replaceable> number of attempts, the calling channel will continue at the next priority in the dialplan.
443                         If the <replaceable>retries</replaceable> setting is set to 0, this application will retry endlessly.
444                         While waiting to retry a call, a 1 digit extension may be dialed. If that
445                         extension exists in either the context defined in <variable>EXITCONTEXT</variable> or the current
446                         one, The call will jump to that extension immediately.
447                         The <replaceable>dialargs</replaceable> are specified in the same format that arguments are provided
448                         to the Dial application.</para>
449                 </description>
450         </application>
451  ***/
452
453 static char *app = "Dial";
454 static char *rapp = "RetryDial";
455
456 enum {
457         OPT_ANNOUNCE =          (1 << 0),
458         OPT_RESETCDR =          (1 << 1),
459         OPT_DTMF_EXIT =         (1 << 2),
460         OPT_SENDDTMF =          (1 << 3),
461         OPT_FORCECLID =         (1 << 4),
462         OPT_GO_ON =             (1 << 5),
463         OPT_CALLEE_HANGUP =     (1 << 6),
464         OPT_CALLER_HANGUP =     (1 << 7),
465         OPT_DURATION_LIMIT =    (1 << 9),
466         OPT_MUSICBACK =         (1 << 10),
467         OPT_CALLEE_MACRO =      (1 << 11),
468         OPT_SCREEN_NOINTRO =    (1 << 12),
469         OPT_SCREEN_NOCLID =     (1 << 13),
470         OPT_ORIGINAL_CLID =     (1 << 14),
471         OPT_SCREENING =         (1 << 15),
472         OPT_PRIVACY =           (1 << 16),
473         OPT_RINGBACK =          (1 << 17),
474         OPT_DURATION_STOP =     (1 << 18),
475         OPT_CALLEE_TRANSFER =   (1 << 19),
476         OPT_CALLER_TRANSFER =   (1 << 20),
477         OPT_CALLEE_MONITOR =    (1 << 21),
478         OPT_CALLER_MONITOR =    (1 << 22),
479         OPT_GOTO =              (1 << 23),
480         OPT_OPERMODE =          (1 << 24),
481         OPT_CALLEE_PARK =       (1 << 25),
482         OPT_CALLER_PARK =       (1 << 26),
483         OPT_IGNORE_FORWARDING = (1 << 27),
484         OPT_CALLEE_GOSUB =      (1 << 28),
485         OPT_CALLEE_MIXMONITOR = (1 << 29),
486         OPT_CALLER_MIXMONITOR = (1 << 30),
487 };
488
489 #define DIAL_STILLGOING      (1 << 31)
490 #define DIAL_NOFORWARDHTML   ((uint64_t)1 << 32) /* flags are now 64 bits, so keep it up! */
491 #define OPT_CANCEL_ELSEWHERE ((uint64_t)1 << 33)
492 #define OPT_PEER_H           ((uint64_t)1 << 34)
493 #define OPT_CALLEE_GO_ON     ((uint64_t)1 << 35)
494
495 enum {
496         OPT_ARG_ANNOUNCE = 0,
497         OPT_ARG_SENDDTMF,
498         OPT_ARG_GOTO,
499         OPT_ARG_DURATION_LIMIT,
500         OPT_ARG_MUSICBACK,
501         OPT_ARG_CALLEE_MACRO,
502         OPT_ARG_CALLEE_GOSUB,
503         OPT_ARG_CALLEE_GO_ON,
504         OPT_ARG_PRIVACY,
505         OPT_ARG_DURATION_STOP,
506         OPT_ARG_OPERMODE,
507         /* note: this entry _MUST_ be the last one in the enum */
508         OPT_ARG_ARRAY_SIZE,
509 };
510
511 AST_APP_OPTIONS(dial_exec_options, BEGIN_OPTIONS
512         AST_APP_OPTION_ARG('A', OPT_ANNOUNCE, OPT_ARG_ANNOUNCE),
513         AST_APP_OPTION('C', OPT_RESETCDR),
514         AST_APP_OPTION('c', OPT_CANCEL_ELSEWHERE),
515         AST_APP_OPTION('d', OPT_DTMF_EXIT),
516         AST_APP_OPTION_ARG('D', OPT_SENDDTMF, OPT_ARG_SENDDTMF),
517         AST_APP_OPTION('e', OPT_PEER_H),
518         AST_APP_OPTION('f', OPT_FORCECLID),
519         AST_APP_OPTION_ARG('F', OPT_CALLEE_GO_ON, OPT_ARG_CALLEE_GO_ON),
520         AST_APP_OPTION('g', OPT_GO_ON),
521         AST_APP_OPTION_ARG('G', OPT_GOTO, OPT_ARG_GOTO),
522         AST_APP_OPTION('h', OPT_CALLEE_HANGUP),
523         AST_APP_OPTION('H', OPT_CALLER_HANGUP),
524         AST_APP_OPTION('i', OPT_IGNORE_FORWARDING),
525         AST_APP_OPTION('k', OPT_CALLEE_PARK),
526         AST_APP_OPTION('K', OPT_CALLER_PARK),
527         AST_APP_OPTION('k', OPT_CALLEE_PARK),
528         AST_APP_OPTION('K', OPT_CALLER_PARK),
529         AST_APP_OPTION_ARG('L', OPT_DURATION_LIMIT, OPT_ARG_DURATION_LIMIT),
530         AST_APP_OPTION_ARG('m', OPT_MUSICBACK, OPT_ARG_MUSICBACK),
531         AST_APP_OPTION_ARG('M', OPT_CALLEE_MACRO, OPT_ARG_CALLEE_MACRO),
532         AST_APP_OPTION('n', OPT_SCREEN_NOINTRO),
533         AST_APP_OPTION('N', OPT_SCREEN_NOCLID),
534         AST_APP_OPTION('o', OPT_ORIGINAL_CLID),
535         AST_APP_OPTION_ARG('O', OPT_OPERMODE, OPT_ARG_OPERMODE),
536         AST_APP_OPTION('p', OPT_SCREENING),
537         AST_APP_OPTION_ARG('P', OPT_PRIVACY, OPT_ARG_PRIVACY),
538         AST_APP_OPTION('r', OPT_RINGBACK),
539         AST_APP_OPTION_ARG('S', OPT_DURATION_STOP, OPT_ARG_DURATION_STOP),
540         AST_APP_OPTION('t', OPT_CALLEE_TRANSFER),
541         AST_APP_OPTION('T', OPT_CALLER_TRANSFER),
542         AST_APP_OPTION_ARG('U', OPT_CALLEE_GOSUB, OPT_ARG_CALLEE_GOSUB),
543         AST_APP_OPTION('w', OPT_CALLEE_MONITOR),
544         AST_APP_OPTION('W', OPT_CALLER_MONITOR),
545         AST_APP_OPTION('x', OPT_CALLEE_MIXMONITOR),
546         AST_APP_OPTION('X', OPT_CALLER_MIXMONITOR),
547 END_OPTIONS );
548
549 #define CAN_EARLY_BRIDGE(flags,chan,peer) (!ast_test_flag64(flags, OPT_CALLEE_HANGUP | \
550         OPT_CALLER_HANGUP | OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER | \
551         OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR | OPT_CALLEE_PARK | OPT_CALLER_PARK) && \
552         !chan->audiohooks && !peer->audiohooks)
553
554 /*
555  * The list of active channels
556  */
557 struct chanlist {
558         struct chanlist *next;
559         struct ast_channel *chan;
560         uint64_t flags;
561 };
562
563
564 static void hanguptree(struct chanlist *outgoing, struct ast_channel *exception, int answered_elsewhere)
565 {
566         /* Hang up a tree of stuff */
567         struct chanlist *oo;
568         while (outgoing) {
569                 /* Hangup any existing lines we have open */
570                 if (outgoing->chan && (outgoing->chan != exception)) {
571                         if (answered_elsewhere)
572                                 ast_set_flag(outgoing->chan, AST_FLAG_ANSWERED_ELSEWHERE);
573                         ast_hangup(outgoing->chan);
574                 }
575                 oo = outgoing;
576                 outgoing = outgoing->next;
577                 ast_free(oo);
578         }
579 }
580
581 #define AST_MAX_WATCHERS 256
582
583 /*
584  * argument to handle_cause() and other functions.
585  */
586 struct cause_args {
587         struct ast_channel *chan;
588         int busy;
589         int congestion;
590         int nochan;
591 };
592
593 static void handle_cause(int cause, struct cause_args *num)
594 {
595         struct ast_cdr *cdr = num->chan->cdr;
596
597         switch(cause) {
598         case AST_CAUSE_BUSY:
599                 if (cdr)
600                         ast_cdr_busy(cdr);
601                 num->busy++;
602                 break;
603
604         case AST_CAUSE_CONGESTION:
605                 if (cdr)
606                         ast_cdr_failed(cdr);
607                 num->congestion++;
608                 break;
609
610         case AST_CAUSE_NO_ROUTE_DESTINATION:
611         case AST_CAUSE_UNREGISTERED:
612                 if (cdr)
613                         ast_cdr_failed(cdr);
614                 num->nochan++;
615                 break;
616
617         case AST_CAUSE_NORMAL_CLEARING:
618                 break;
619
620         default:
621                 num->nochan++;
622                 break;
623         }
624 }
625
626 /* free the buffer if allocated, and set the pointer to the second arg */
627 #define S_REPLACE(s, new_val)           \
628         do {                            \
629                 if (s)                  \
630                         ast_free(s);    \
631                 s = (new_val);          \
632         } while (0)
633
634 static int onedigit_goto(struct ast_channel *chan, const char *context, char exten, int pri)
635 {
636         char rexten[2] = { exten, '\0' };
637
638         if (context) {
639                 if (!ast_goto_if_exists(chan, context, rexten, pri))
640                         return 1;
641         } else {
642                 if (!ast_goto_if_exists(chan, chan->context, rexten, pri))
643                         return 1;
644                 else if (!ast_strlen_zero(chan->macrocontext)) {
645                         if (!ast_goto_if_exists(chan, chan->macrocontext, rexten, pri))
646                                 return 1;
647                 }
648         }
649         return 0;
650 }
651
652
653 static const char *get_cid_name(char *name, int namelen, struct ast_channel *chan)
654 {
655         const char *context = S_OR(chan->macrocontext, chan->context);
656         const char *exten = S_OR(chan->macroexten, chan->exten);
657
658         return ast_get_hint(NULL, 0, name, namelen, chan, context, exten) ? name : "";
659 }
660
661 static void senddialevent(struct ast_channel *src, struct ast_channel *dst, const char *dialstring)
662 {
663         manager_event(EVENT_FLAG_CALL, "Dial",
664                 "SubEvent: Begin\r\n"
665                 "Channel: %s\r\n"
666                 "Destination: %s\r\n"
667                 "CallerIDNum: %s\r\n"
668                 "CallerIDName: %s\r\n"
669                 "UniqueID: %s\r\n"
670                 "DestUniqueID: %s\r\n"
671                 "Dialstring: %s\r\n",
672                 src->name, dst->name, S_OR(src->cid.cid_num, "<unknown>"),
673                 S_OR(src->cid.cid_name, "<unknown>"), src->uniqueid,
674                 dst->uniqueid, dialstring ? dialstring : "");
675 }
676
677 static void senddialendevent(const struct ast_channel *src, const char *dialstatus)
678 {
679         manager_event(EVENT_FLAG_CALL, "Dial",
680                 "SubEvent: End\r\n"
681                 "Channel: %s\r\n"
682                 "UniqueID: %s\r\n"
683                 "DialStatus: %s\r\n",
684                 src->name, src->uniqueid, dialstatus);
685 }
686
687 /*!
688  * helper function for wait_for_answer()
689  *
690  * XXX this code is highly suspicious, as it essentially overwrites
691  * the outgoing channel without properly deleting it.
692  */
693 static void do_forward(struct chanlist *o,
694         struct cause_args *num, struct ast_flags64 *peerflags, int single)
695 {
696         char tmpchan[256];
697         struct ast_channel *original = o->chan;
698         struct ast_channel *c = o->chan; /* the winner */
699         struct ast_channel *in = num->chan; /* the input channel */
700         char *stuff;
701         char *tech;
702         int cause;
703
704         ast_copy_string(tmpchan, c->call_forward, sizeof(tmpchan));
705         if ((stuff = strchr(tmpchan, '/'))) {
706                 *stuff++ = '\0';
707                 tech = tmpchan;
708         } else {
709                 const char *forward_context;
710                 ast_channel_lock(c);
711                 forward_context = pbx_builtin_getvar_helper(c, "FORWARD_CONTEXT");
712                 snprintf(tmpchan, sizeof(tmpchan), "%s@%s", c->call_forward, forward_context ? forward_context : c->context);
713                 ast_channel_unlock(c);
714                 stuff = tmpchan;
715                 tech = "Local";
716         }
717         /* Before processing channel, go ahead and check for forwarding */
718         ast_verb(3, "Now forwarding %s to '%s/%s' (thanks to %s)\n", in->name, tech, stuff, c->name);
719         /* If we have been told to ignore forwards, just set this channel to null and continue processing extensions normally */
720         if (ast_test_flag64(peerflags, OPT_IGNORE_FORWARDING)) {
721                 ast_verb(3, "Forwarding %s to '%s/%s' prevented.\n", in->name, tech, stuff);
722                 c = o->chan = NULL;
723                 cause = AST_CAUSE_BUSY;
724         } else {
725                 /* Setup parameters */
726                 c = o->chan = ast_request(tech, in->nativeformats, stuff, &cause);
727                 if (c) {
728                         if (single)
729                                 ast_channel_make_compatible(o->chan, in);
730                         ast_channel_inherit_variables(in, o->chan);
731                         ast_channel_datastore_inherit(in, o->chan);
732                 } else
733                         ast_log(LOG_NOTICE, "Unable to create local channel for call forward to '%s/%s' (cause = %d)\n", tech, stuff, cause);
734         }
735         if (!c) {
736                 ast_clear_flag64(o, DIAL_STILLGOING);
737                 handle_cause(cause, num);
738         } else {
739                 char *new_cid_num, *new_cid_name;
740                 struct ast_channel *src;
741
742                 ast_rtp_make_compatible(c, in, single);
743                 if (ast_test_flag64(o, OPT_FORCECLID)) {
744                         new_cid_num = ast_strdup(S_OR(in->macroexten, in->exten));
745                         new_cid_name = NULL; /* XXX no name ? */
746                         src = c; /* XXX possible bug in previous code, which used 'winner' ? it may have changed */
747                 } else {
748                         new_cid_num = ast_strdup(in->cid.cid_num);
749                         new_cid_name = ast_strdup(in->cid.cid_name);
750                         src = in;
751                 }
752                 ast_string_field_set(c, accountcode, src->accountcode);
753                 c->cdrflags = src->cdrflags;
754                 S_REPLACE(c->cid.cid_num, new_cid_num);
755                 S_REPLACE(c->cid.cid_name, new_cid_name);
756
757                 if (in->cid.cid_ani) { /* XXX or maybe unconditional ? */
758                         S_REPLACE(c->cid.cid_ani, ast_strdup(in->cid.cid_ani));
759                 }
760                 S_REPLACE(c->cid.cid_rdnis, ast_strdup(S_OR(in->macroexten, in->exten)));
761                 if (ast_call(c, tmpchan, 0)) {
762                         ast_log(LOG_NOTICE, "Failed to dial on local channel for call forward to '%s'\n", tmpchan);
763                         ast_clear_flag64(o, DIAL_STILLGOING);
764                         ast_hangup(original);
765                         c = o->chan = NULL;
766                         num->nochan++;
767                 } else {
768                         senddialevent(in, c, stuff);
769                         /* After calling, set callerid to extension */
770                         if (!ast_test_flag64(peerflags, OPT_ORIGINAL_CLID)) {
771                                 char cidname[AST_MAX_EXTENSION] = "";
772                                 ast_set_callerid(c, S_OR(in->macroexten, in->exten), get_cid_name(cidname, sizeof(cidname), in), NULL);
773                         }
774                         /* Hangup the original channel now, in case we needed it */
775                         ast_hangup(original);
776                 }
777         }
778 }
779
780 /* argument used for some functions. */
781 struct privacy_args {
782         int sentringing;
783         int privdb_val;
784         char privcid[256];
785         char privintro[1024];
786         char status[256];
787 };
788
789 static struct ast_channel *wait_for_answer(struct ast_channel *in,
790         struct chanlist *outgoing, int *to, struct ast_flags64 *peerflags,
791         struct privacy_args *pa,
792         const struct cause_args *num_in, int *result)
793 {
794         struct cause_args num = *num_in;
795         int prestart = num.busy + num.congestion + num.nochan;
796         int orig = *to;
797         struct ast_channel *peer = NULL;
798         /* single is set if only one destination is enabled */
799         int single = outgoing && !outgoing->next && !ast_test_flag64(outgoing, OPT_MUSICBACK | OPT_RINGBACK);
800 #ifdef HAVE_EPOLL
801         struct chanlist *epollo;
802 #endif
803
804         if (single) {
805                 /* Turn off hold music, etc */
806                 ast_deactivate_generator(in);
807                 /* If we are calling a single channel, make them compatible for in-band tone purpose */
808                 ast_channel_make_compatible(outgoing->chan, in);
809         }
810
811 #ifdef HAVE_EPOLL
812         for (epollo = outgoing; epollo; epollo = epollo->next)
813                 ast_poll_channel_add(in, epollo->chan);
814 #endif
815
816         while (*to && !peer) {
817                 struct chanlist *o;
818                 int pos = 0; /* how many channels do we handle */
819                 int numlines = prestart;
820                 struct ast_channel *winner;
821                 struct ast_channel *watchers[AST_MAX_WATCHERS];
822
823                 watchers[pos++] = in;
824                 for (o = outgoing; o; o = o->next) {
825                         /* Keep track of important channels */
826                         if (ast_test_flag64(o, DIAL_STILLGOING) && o->chan)
827                                 watchers[pos++] = o->chan;
828                         numlines++;
829                 }
830                 if (pos == 1) { /* only the input channel is available */
831                         if (numlines == (num.busy + num.congestion + num.nochan)) {
832                                 ast_verb(2, "Everyone is busy/congested at this time (%d:%d/%d/%d)\n", numlines, num.busy, num.congestion, num.nochan);
833                                 if (num.busy)
834                                         strcpy(pa->status, "BUSY");
835                                 else if (num.congestion)
836                                         strcpy(pa->status, "CONGESTION");
837                                 else if (num.nochan)
838                                         strcpy(pa->status, "CHANUNAVAIL");
839                         } else {
840                                 ast_verb(3, "No one is available to answer at this time (%d:%d/%d/%d)\n", numlines, num.busy, num.congestion, num.nochan);
841                         }
842                         *to = 0;
843                         return NULL;
844                 }
845                 winner = ast_waitfor_n(watchers, pos, to);
846                 for (o = outgoing; o; o = o->next) {
847                         struct ast_frame *f;
848                         struct ast_channel *c = o->chan;
849
850                         if (c == NULL)
851                                 continue;
852                         if (ast_test_flag64(o, DIAL_STILLGOING) && c->_state == AST_STATE_UP) {
853                                 if (!peer) {
854                                         ast_verb(3, "%s answered %s\n", c->name, in->name);
855                                         peer = c;
856                                         ast_copy_flags64(peerflags, o,
857                                                 OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
858                                                 OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
859                                                 OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
860                                                 OPT_CALLEE_PARK | OPT_CALLER_PARK |
861                                                 OPT_CALLEE_MIXMONITOR | OPT_CALLER_MIXMONITOR |
862                                                 DIAL_NOFORWARDHTML);
863                                         ast_string_field_set(c, dialcontext, "");
864                                         ast_copy_string(c->exten, "", sizeof(c->exten));
865                                 }
866                                 continue;
867                         }
868                         if (c != winner)
869                                 continue;
870                         /* here, o->chan == c == winner */
871                         if (!ast_strlen_zero(c->call_forward)) {
872                                 do_forward(o, &num, peerflags, single);
873                                 continue;
874                         }
875                         f = ast_read(winner);
876                         if (!f) {
877                                 in->hangupcause = c->hangupcause;
878 #ifdef HAVE_EPOLL
879                                 ast_poll_channel_del(in, c);
880 #endif
881                                 ast_hangup(c);
882                                 c = o->chan = NULL;
883                                 ast_clear_flag64(o, DIAL_STILLGOING);
884                                 handle_cause(in->hangupcause, &num);
885                                 continue;
886                         }
887                         if (f->frametype == AST_FRAME_CONTROL) {
888                                 switch(f->subclass) {
889                                 case AST_CONTROL_ANSWER:
890                                         /* This is our guy if someone answered. */
891                                         if (!peer) {
892                                                 ast_verb(3, "%s answered %s\n", c->name, in->name);
893                                                 peer = c;
894                                                 if (peer->cdr) {
895                                                         peer->cdr->answer = ast_tvnow();
896                                                         peer->cdr->disposition = AST_CDR_ANSWERED;
897                                                 }
898                                                 ast_copy_flags64(peerflags, o,
899                                                         OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
900                                                         OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
901                                                         OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
902                                                         OPT_CALLEE_PARK | OPT_CALLER_PARK |
903                                                         OPT_CALLEE_MIXMONITOR | OPT_CALLER_MIXMONITOR |
904                                                         DIAL_NOFORWARDHTML);
905                                                 ast_string_field_set(c, dialcontext, "");
906                                                 ast_copy_string(c->exten, "", sizeof(c->exten));
907                                                 if (CAN_EARLY_BRIDGE(peerflags, in, peer))
908                                                         /* Setup early bridge if appropriate */
909                                                         ast_channel_early_bridge(in, peer);
910                                         }
911                                         /* If call has been answered, then the eventual hangup is likely to be normal hangup */
912                                         in->hangupcause = AST_CAUSE_NORMAL_CLEARING;
913                                         c->hangupcause = AST_CAUSE_NORMAL_CLEARING;
914                                         break;
915                                 case AST_CONTROL_BUSY:
916                                         ast_verb(3, "%s is busy\n", c->name);
917                                         in->hangupcause = c->hangupcause;
918                                         ast_hangup(c);
919                                         c = o->chan = NULL;
920                                         ast_clear_flag64(o, DIAL_STILLGOING);
921                                         handle_cause(AST_CAUSE_BUSY, &num);
922                                         break;
923                                 case AST_CONTROL_CONGESTION:
924                                         ast_verb(3, "%s is circuit-busy\n", c->name);
925                                         in->hangupcause = c->hangupcause;
926                                         ast_hangup(c);
927                                         c = o->chan = NULL;
928                                         ast_clear_flag64(o, DIAL_STILLGOING);
929                                         handle_cause(AST_CAUSE_CONGESTION, &num);
930                                         break;
931                                 case AST_CONTROL_RINGING:
932                                         ast_verb(3, "%s is ringing\n", c->name);
933                                         /* Setup early media if appropriate */
934                                         if (single && CAN_EARLY_BRIDGE(peerflags, in, c))
935                                                 ast_channel_early_bridge(in, c);
936                                         if (!(pa->sentringing) && !ast_test_flag64(outgoing, OPT_MUSICBACK)) {
937                                                 ast_indicate(in, AST_CONTROL_RINGING);
938                                                 pa->sentringing++;
939                                         }
940                                         break;
941                                 case AST_CONTROL_PROGRESS:
942                                         ast_verb(3, "%s is making progress passing it to %s\n", c->name, in->name);
943                                         /* Setup early media if appropriate */
944                                         if (single && CAN_EARLY_BRIDGE(peerflags, in, c))
945                                                 ast_channel_early_bridge(in, c);
946                                         if (!ast_test_flag64(outgoing, OPT_RINGBACK))
947                                                 ast_indicate(in, AST_CONTROL_PROGRESS);
948                                         break;
949                                 case AST_CONTROL_VIDUPDATE:
950                                         ast_verb(3, "%s requested a video update, passing it to %s\n", c->name, in->name);
951                                         ast_indicate(in, AST_CONTROL_VIDUPDATE);
952                                         break;
953                                 case AST_CONTROL_SRCUPDATE:
954                                         ast_verb(3, "%s requested a source update, passing it to %s\n", c->name, in->name);
955                                         ast_indicate(in, AST_CONTROL_SRCUPDATE);
956                                         break;
957                                 case AST_CONTROL_PROCEEDING:
958                                         ast_verb(3, "%s is proceeding passing it to %s\n", c->name, in->name);
959                                         if (single && CAN_EARLY_BRIDGE(peerflags, in, c))
960                                                 ast_channel_early_bridge(in, c);
961                                         if (!ast_test_flag64(outgoing, OPT_RINGBACK))
962                                                 ast_indicate(in, AST_CONTROL_PROCEEDING);
963                                         break;
964                                 case AST_CONTROL_HOLD:
965                                         ast_verb(3, "Call on %s placed on hold\n", c->name);
966                                         ast_indicate(in, AST_CONTROL_HOLD);
967                                         break;
968                                 case AST_CONTROL_UNHOLD:
969                                         ast_verb(3, "Call on %s left from hold\n", c->name);
970                                         ast_indicate(in, AST_CONTROL_UNHOLD);
971                                         break;
972                                 case AST_CONTROL_OFFHOOK:
973                                 case AST_CONTROL_FLASH:
974                                         /* Ignore going off hook and flash */
975                                         break;
976                                 case -1:
977                                         if (!ast_test_flag64(outgoing, OPT_RINGBACK | OPT_MUSICBACK)) {
978                                                 ast_verb(3, "%s stopped sounds\n", c->name);
979                                                 ast_indicate(in, -1);
980                                                 pa->sentringing = 0;
981                                         }
982                                         break;
983                                 default:
984                                         ast_debug(1, "Dunno what to do with control type %d\n", f->subclass);
985                                 }
986                         } else if (single) {
987                                 switch (f->frametype) {
988                                         case AST_FRAME_VOICE:
989                                         case AST_FRAME_IMAGE:
990                                         case AST_FRAME_TEXT:
991                                                 if (ast_write(in, f)) {
992                                                         ast_log(LOG_WARNING, "Unable to write frame\n");
993                                                 }
994                                                 break;
995                                         case AST_FRAME_HTML:
996                                                 if (!ast_test_flag64(outgoing, DIAL_NOFORWARDHTML) && ast_channel_sendhtml(in, f->subclass, f->data.ptr, f->datalen) == -1) {
997                                                         ast_log(LOG_WARNING, "Unable to send URL\n");
998                                                 }
999                                                 break;
1000                                         default:
1001                                                 break;
1002                                 }
1003                         }
1004                         ast_frfree(f);
1005                 } /* end for */
1006                 if (winner == in) {
1007                         struct ast_frame *f = ast_read(in);
1008 #if 0
1009                         if (f && (f->frametype != AST_FRAME_VOICE))
1010                                 printf("Frame type: %d, %d\n", f->frametype, f->subclass);
1011                         else if (!f || (f->frametype != AST_FRAME_VOICE))
1012                                 printf("Hangup received on %s\n", in->name);
1013 #endif
1014                         if (!f || ((f->frametype == AST_FRAME_CONTROL) && (f->subclass == AST_CONTROL_HANGUP))) {
1015                                 /* Got hung up */
1016                                 *to = -1;
1017                                 strcpy(pa->status, "CANCEL");
1018                                 ast_cdr_noanswer(in->cdr);
1019                                 if (f) {
1020                                         if (f->data.uint32) {
1021                                                 in->hangupcause = f->data.uint32;
1022                                         }
1023                                         ast_frfree(f);
1024                                 }
1025                                 return NULL;
1026                         }
1027
1028                         /* now f is guaranteed non-NULL */
1029                         if (f->frametype == AST_FRAME_DTMF) {
1030                                 if (ast_test_flag64(peerflags, OPT_DTMF_EXIT)) {
1031                                         const char *context;
1032                                         ast_channel_lock(in);
1033                                         context = pbx_builtin_getvar_helper(in, "EXITCONTEXT");
1034                                         if (onedigit_goto(in, context, (char) f->subclass, 1)) {
1035                                                 ast_verb(3, "User hit %c to disconnect call.\n", f->subclass);
1036                                                 *to = 0;
1037                                                 ast_cdr_noanswer(in->cdr);
1038                                                 *result = f->subclass;
1039                                                 strcpy(pa->status, "CANCEL");
1040                                                 ast_frfree(f);
1041                                                 ast_channel_unlock(in);
1042                                                 return NULL;
1043                                         }
1044                                         ast_channel_unlock(in);
1045                                 }
1046
1047                                 if (ast_test_flag64(peerflags, OPT_CALLER_HANGUP) &&
1048                                                 (f->subclass == '*')) { /* hmm it it not guaranteed to be '*' anymore. */
1049                                         ast_verb(3, "User hit %c to disconnect call.\n", f->subclass);
1050                                         *to = 0;
1051                                         strcpy(pa->status, "CANCEL");
1052                                         ast_cdr_noanswer(in->cdr);
1053                                         ast_frfree(f);
1054                                         return NULL;
1055                                 }
1056                         }
1057
1058                         /* Forward HTML stuff */
1059                         if (single && (f->frametype == AST_FRAME_HTML) && !ast_test_flag64(outgoing, DIAL_NOFORWARDHTML))
1060                                 if (ast_channel_sendhtml(outgoing->chan, f->subclass, f->data.ptr, f->datalen) == -1)
1061                                         ast_log(LOG_WARNING, "Unable to send URL\n");
1062
1063                         if (single && ((f->frametype == AST_FRAME_VOICE) || (f->frametype == AST_FRAME_DTMF_BEGIN) || (f->frametype == AST_FRAME_DTMF_END)))  {
1064                                 if (ast_write(outgoing->chan, f))
1065                                         ast_log(LOG_WARNING, "Unable to forward voice or dtmf\n");
1066                         }
1067                         if (single && (f->frametype == AST_FRAME_CONTROL) &&
1068                                 ((f->subclass == AST_CONTROL_HOLD) ||
1069                                 (f->subclass == AST_CONTROL_UNHOLD) ||
1070                                 (f->subclass == AST_CONTROL_VIDUPDATE) ||
1071                                  (f->subclass == AST_CONTROL_SRCUPDATE))) {
1072                                 ast_verb(3, "%s requested special control %d, passing it to %s\n", in->name, f->subclass, outgoing->chan->name);
1073                                 ast_indicate_data(outgoing->chan, f->subclass, f->data.ptr, f->datalen);
1074                         }
1075                         ast_frfree(f);
1076                 }
1077                 if (!*to)
1078                         ast_verb(3, "Nobody picked up in %d ms\n", orig);
1079                 if (!*to || ast_check_hangup(in))
1080                         ast_cdr_noanswer(in->cdr);
1081         }
1082
1083 #ifdef HAVE_EPOLL
1084         for (epollo = outgoing; epollo; epollo = epollo->next) {
1085                 if (epollo->chan)
1086                         ast_poll_channel_del(in, epollo->chan);
1087         }
1088 #endif
1089
1090         return peer;
1091 }
1092
1093 static void replace_macro_delimiter(char *s)
1094 {
1095         for (; *s; s++)
1096                 if (*s == '^')
1097                         *s = ',';
1098 }
1099
1100 /* returns true if there is a valid privacy reply */
1101 static int valid_priv_reply(struct ast_flags64 *opts, int res)
1102 {
1103         if (res < '1')
1104                 return 0;
1105         if (ast_test_flag64(opts, OPT_PRIVACY) && res <= '5')
1106                 return 1;
1107         if (ast_test_flag64(opts, OPT_SCREENING) && res <= '4')
1108                 return 1;
1109         return 0;
1110 }
1111
1112 static int do_timelimit(struct ast_channel *chan, struct ast_bridge_config *config,
1113         char *parse, struct timeval *calldurationlimit)
1114 {
1115         char *stringp = ast_strdupa(parse);
1116         char *limit_str, *warning_str, *warnfreq_str;
1117         const char *var;
1118         int play_to_caller = 0, play_to_callee = 0;
1119         int delta;
1120
1121         limit_str = strsep(&stringp, ":");
1122         warning_str = strsep(&stringp, ":");
1123         warnfreq_str = strsep(&stringp, ":");
1124
1125         config->timelimit = atol(limit_str);
1126         if (warning_str)
1127                 config->play_warning = atol(warning_str);
1128         if (warnfreq_str)
1129                 config->warning_freq = atol(warnfreq_str);
1130
1131         if (!config->timelimit) {
1132                 ast_log(LOG_WARNING, "Dial does not accept L(%s), hanging up.\n", limit_str);
1133                 config->timelimit = config->play_warning = config->warning_freq = 0;
1134                 config->warning_sound = NULL;
1135                 return -1; /* error */
1136         } else if ( (delta = config->play_warning - config->timelimit) > 0) {
1137                 int w = config->warning_freq;
1138
1139                 /* If the first warning is requested _after_ the entire call would end,
1140                    and no warning frequency is requested, then turn off the warning. If
1141                    a warning frequency is requested, reduce the 'first warning' time by
1142                    that frequency until it falls within the call's total time limit.
1143                    Graphically:
1144                                   timelim->|    delta        |<-playwarning
1145                         0__________________|_________________|
1146                                          | w  |    |    |    |
1147
1148                    so the number of intervals to cut is 1+(delta-1)/w
1149                 */
1150
1151                 if (w == 0) {
1152                         config->play_warning = 0;
1153                 } else {
1154                         config->play_warning -= w * ( 1 + (delta-1)/w );
1155                         if (config->play_warning < 1)
1156                                 config->play_warning = config->warning_freq = 0;
1157                 }
1158         }
1159         
1160         ast_channel_lock(chan);
1161
1162         var = pbx_builtin_getvar_helper(chan, "LIMIT_PLAYAUDIO_CALLER");
1163
1164         play_to_caller = var ? ast_true(var) : 1;
1165
1166         var = pbx_builtin_getvar_helper(chan, "LIMIT_PLAYAUDIO_CALLEE");
1167         play_to_callee = var ? ast_true(var) : 0;
1168
1169         if (!play_to_caller && !play_to_callee)
1170                 play_to_caller = 1;
1171
1172         var = pbx_builtin_getvar_helper(chan, "LIMIT_WARNING_FILE");
1173         config->warning_sound = !ast_strlen_zero(var) ? ast_strdup(var) : ast_strdup("timeleft");
1174
1175         /* The code looking at config wants a NULL, not just "", to decide
1176          * that the message should not be played, so we replace "" with NULL.
1177          * Note, pbx_builtin_getvar_helper _can_ return NULL if the variable is
1178          * not found.
1179          */
1180
1181         var = pbx_builtin_getvar_helper(chan, "LIMIT_TIMEOUT_FILE");
1182         config->end_sound = !ast_strlen_zero(var) ? ast_strdup(var) : NULL;
1183
1184         var = pbx_builtin_getvar_helper(chan, "LIMIT_CONNECT_FILE");
1185         config->start_sound = !ast_strlen_zero(var) ? ast_strdup(var) : NULL;
1186
1187         ast_channel_unlock(chan);
1188
1189         /* undo effect of S(x) in case they are both used */
1190         calldurationlimit->tv_sec = 0;
1191         calldurationlimit->tv_usec = 0;
1192
1193         /* more efficient to do it like S(x) does since no advanced opts */
1194         if (!config->play_warning && !config->start_sound && !config->end_sound && config->timelimit) {
1195                 calldurationlimit->tv_sec = config->timelimit / 1000;
1196                 calldurationlimit->tv_usec = (config->timelimit % 1000) * 1000;
1197                 ast_verb(3, "Setting call duration limit to %.3lf seconds.\n",
1198                         calldurationlimit->tv_sec + calldurationlimit->tv_usec / 1000000.0);
1199                 config->timelimit = play_to_caller = play_to_callee =
1200                 config->play_warning = config->warning_freq = 0;
1201         } else {
1202                 ast_verb(3, "Limit Data for this call:\n");
1203                 ast_verb(4, "timelimit      = %ld\n", config->timelimit);
1204                 ast_verb(4, "play_warning   = %ld\n", config->play_warning);
1205                 ast_verb(4, "play_to_caller = %s\n", play_to_caller ? "yes" : "no");
1206                 ast_verb(4, "play_to_callee = %s\n", play_to_callee ? "yes" : "no");
1207                 ast_verb(4, "warning_freq   = %ld\n", config->warning_freq);
1208                 ast_verb(4, "start_sound    = %s\n", S_OR(config->start_sound, ""));
1209                 ast_verb(4, "warning_sound  = %s\n", config->warning_sound);
1210                 ast_verb(4, "end_sound      = %s\n", S_OR(config->end_sound, ""));
1211         }
1212         if (play_to_caller)
1213                 ast_set_flag(&(config->features_caller), AST_FEATURE_PLAY_WARNING);
1214         if (play_to_callee)
1215                 ast_set_flag(&(config->features_callee), AST_FEATURE_PLAY_WARNING);
1216         return 0;
1217 }
1218
1219 static int do_privacy(struct ast_channel *chan, struct ast_channel *peer,
1220         struct ast_flags64 *opts, char **opt_args, struct privacy_args *pa)
1221 {
1222
1223         int res2;
1224         int loopcount = 0;
1225
1226         /* Get the user's intro, store it in priv-callerintros/$CID,
1227            unless it is already there-- this should be done before the
1228            call is actually dialed  */
1229
1230         /* all ring indications and moh for the caller has been halted as soon as the
1231            target extension was picked up. We are going to have to kill some
1232            time and make the caller believe the peer hasn't picked up yet */
1233
1234         if (ast_test_flag64(opts, OPT_MUSICBACK) && !ast_strlen_zero(opt_args[OPT_ARG_MUSICBACK])) {
1235                 char *original_moh = ast_strdupa(chan->musicclass);
1236                 ast_indicate(chan, -1);
1237                 ast_string_field_set(chan, musicclass, opt_args[OPT_ARG_MUSICBACK]);
1238                 ast_moh_start(chan, opt_args[OPT_ARG_MUSICBACK], NULL);
1239                 ast_string_field_set(chan, musicclass, original_moh);
1240         } else if (ast_test_flag64(opts, OPT_RINGBACK)) {
1241                 ast_indicate(chan, AST_CONTROL_RINGING);
1242                 pa->sentringing++;
1243         }
1244
1245         /* Start autoservice on the other chan ?? */
1246         res2 = ast_autoservice_start(chan);
1247         /* Now Stream the File */
1248         for (loopcount = 0; loopcount < 3; loopcount++) {
1249                 if (res2 && loopcount == 0) /* error in ast_autoservice_start() */
1250                         break;
1251                 if (!res2) /* on timeout, play the message again */
1252                         res2 = ast_play_and_wait(peer, "priv-callpending");
1253                 if (!valid_priv_reply(opts, res2))
1254                         res2 = 0;
1255                 /* priv-callpending script:
1256                    "I have a caller waiting, who introduces themselves as:"
1257                 */
1258                 if (!res2)
1259                         res2 = ast_play_and_wait(peer, pa->privintro);
1260                 if (!valid_priv_reply(opts, res2))
1261                         res2 = 0;
1262                 /* now get input from the called party, as to their choice */
1263                 if (!res2) {
1264                         /* XXX can we have both, or they are mutually exclusive ? */
1265                         if (ast_test_flag64(opts, OPT_PRIVACY))
1266                                 res2 = ast_play_and_wait(peer, "priv-callee-options");
1267                         if (ast_test_flag64(opts, OPT_SCREENING))
1268                                 res2 = ast_play_and_wait(peer, "screen-callee-options");
1269                 }
1270                 /*! \page DialPrivacy Dial Privacy scripts
1271                 \par priv-callee-options script:
1272                         "Dial 1 if you wish this caller to reach you directly in the future,
1273                                 and immediately connect to their incoming call
1274                          Dial 2 if you wish to send this caller to voicemail now and
1275                                 forevermore.
1276                          Dial 3 to send this caller to the torture menus, now and forevermore.
1277                          Dial 4 to send this caller to a simple "go away" menu, now and forevermore.
1278                          Dial 5 to allow this caller to come straight thru to you in the future,
1279                                 but right now, just this once, send them to voicemail."
1280                 \par screen-callee-options script:
1281                         "Dial 1 if you wish to immediately connect to the incoming call
1282                          Dial 2 if you wish to send this caller to voicemail.
1283                          Dial 3 to send this caller to the torture menus.
1284                          Dial 4 to send this caller to a simple "go away" menu.
1285                 */
1286                 if (valid_priv_reply(opts, res2))
1287                         break;
1288                 /* invalid option */
1289                 res2 = ast_play_and_wait(peer, "vm-sorry");
1290         }
1291
1292         if (ast_test_flag64(opts, OPT_MUSICBACK)) {
1293                 ast_moh_stop(chan);
1294         } else if (ast_test_flag64(opts, OPT_RINGBACK)) {
1295                 ast_indicate(chan, -1);
1296                 pa->sentringing = 0;
1297         }
1298         ast_autoservice_stop(chan);
1299         if (ast_test_flag64(opts, OPT_PRIVACY) && (res2 >= '1' && res2 <= '5')) {
1300                 /* map keypresses to various things, the index is res2 - '1' */
1301                 static const char *_val[] = { "ALLOW", "DENY", "TORTURE", "KILL", "ALLOW" };
1302                 static const int _flag[] = { AST_PRIVACY_ALLOW, AST_PRIVACY_DENY, AST_PRIVACY_TORTURE, AST_PRIVACY_KILL, AST_PRIVACY_ALLOW};
1303                 int i = res2 - '1';
1304                 ast_verb(3, "--Set privacy database entry %s/%s to %s\n",
1305                         opt_args[OPT_ARG_PRIVACY], pa->privcid, _val[i]);
1306                 ast_privacy_set(opt_args[OPT_ARG_PRIVACY], pa->privcid, _flag[i]);
1307         }
1308         switch (res2) {
1309         case '1':
1310                 break;
1311         case '2':
1312                 ast_copy_string(pa->status, "NOANSWER", sizeof(pa->status));
1313                 break;
1314         case '3':
1315                 ast_copy_string(pa->status, "TORTURE", sizeof(pa->status));
1316                 break;
1317         case '4':
1318                 ast_copy_string(pa->status, "DONTCALL", sizeof(pa->status));
1319                 break;
1320         case '5':
1321                 /* XXX should we set status to DENY ? */
1322                 if (ast_test_flag64(opts, OPT_PRIVACY))
1323                         break;
1324                 /* if not privacy, then 5 is the same as "default" case */
1325         default: /* bad input or -1 if failure to start autoservice */
1326                 /* well, if the user messes up, ... he had his chance... What Is The Best Thing To Do?  */
1327                 /* well, there seems basically two choices. Just patch the caller thru immediately,
1328                           or,... put 'em thru to voicemail. */
1329                 /* since the callee may have hung up, let's do the voicemail thing, no database decision */
1330                 ast_log(LOG_NOTICE, "privacy: no valid response from the callee. Sending the caller to voicemail, the callee isn't responding\n");
1331                 /* XXX should we set status to DENY ? */
1332                 /* XXX what about the privacy flags ? */
1333                 break;
1334         }
1335
1336         if (res2 == '1') { /* the only case where we actually connect */
1337                 /* if the intro is NOCALLERID, then there's no reason to leave it on disk, it'll
1338                    just clog things up, and it's not useful information, not being tied to a CID */
1339                 if (strncmp(pa->privcid, "NOCALLERID", 10) == 0 || ast_test_flag64(opts, OPT_SCREEN_NOINTRO)) {
1340                         ast_filedelete(pa->privintro, NULL);
1341                         if (ast_fileexists(pa->privintro, NULL, NULL) > 0)
1342                                 ast_log(LOG_NOTICE, "privacy: ast_filedelete didn't do its job on %s\n", pa->privintro);
1343                         else
1344                                 ast_verb(3, "Successfully deleted %s intro file\n", pa->privintro);
1345                 }
1346                 return 0; /* the good exit path */
1347         } else {
1348                 ast_hangup(peer); /* hang up on the callee -- he didn't want to talk anyway! */
1349                 return -1;
1350         }
1351 }
1352
1353 /*! \brief returns 1 if successful, 0 or <0 if the caller should 'goto out' */
1354 static int setup_privacy_args(struct privacy_args *pa,
1355         struct ast_flags64 *opts, char *opt_args[], struct ast_channel *chan)
1356 {
1357         char callerid[60];
1358         int res;
1359         char *l;
1360         int silencethreshold;
1361
1362         if (!ast_strlen_zero(chan->cid.cid_num)) {
1363                 l = ast_strdupa(chan->cid.cid_num);
1364                 ast_shrink_phone_number(l);
1365                 if (ast_test_flag64(opts, OPT_PRIVACY) ) {
1366                         ast_verb(3, "Privacy DB is '%s', clid is '%s'\n", opt_args[OPT_ARG_PRIVACY], l);
1367                         pa->privdb_val = ast_privacy_check(opt_args[OPT_ARG_PRIVACY], l);
1368                 } else {
1369                         ast_verb(3, "Privacy Screening, clid is '%s'\n", l);
1370                         pa->privdb_val = AST_PRIVACY_UNKNOWN;
1371                 }
1372         } else {
1373                 char *tnam, *tn2;
1374
1375                 tnam = ast_strdupa(chan->name);
1376                 /* clean the channel name so slashes don't try to end up in disk file name */
1377                 for (tn2 = tnam; *tn2; tn2++) {
1378                         if (*tn2 == '/')  /* any other chars to be afraid of? */
1379                                 *tn2 = '=';
1380                 }
1381                 ast_verb(3, "Privacy-- callerid is empty\n");
1382
1383                 snprintf(callerid, sizeof(callerid), "NOCALLERID_%s%s", chan->exten, tnam);
1384                 l = callerid;
1385                 pa->privdb_val = AST_PRIVACY_UNKNOWN;
1386         }
1387
1388         ast_copy_string(pa->privcid, l, sizeof(pa->privcid));
1389
1390         if (strncmp(pa->privcid, "NOCALLERID", 10) != 0 && ast_test_flag64(opts, OPT_SCREEN_NOCLID)) {
1391                 /* if callerid is set and OPT_SCREEN_NOCLID is set also */
1392                 ast_verb(3, "CallerID set (%s); N option set; Screening should be off\n", pa->privcid);
1393                 pa->privdb_val = AST_PRIVACY_ALLOW;
1394         } else if (ast_test_flag64(opts, OPT_SCREEN_NOCLID) && strncmp(pa->privcid, "NOCALLERID", 10) == 0) {
1395                 ast_verb(3, "CallerID blank; N option set; Screening should happen; dbval is %d\n", pa->privdb_val);
1396         }
1397         
1398         if (pa->privdb_val == AST_PRIVACY_DENY) {
1399                 ast_verb(3, "Privacy DB reports PRIVACY_DENY for this callerid. Dial reports unavailable\n");
1400                 ast_copy_string(pa->status, "NOANSWER", sizeof(pa->status));
1401                 return 0;
1402         } else if (pa->privdb_val == AST_PRIVACY_KILL) {
1403                 ast_copy_string(pa->status, "DONTCALL", sizeof(pa->status));
1404                 return 0; /* Is this right? */
1405         } else if (pa->privdb_val == AST_PRIVACY_TORTURE) {
1406                 ast_copy_string(pa->status, "TORTURE", sizeof(pa->status));
1407                 return 0; /* is this right??? */
1408         } else if (pa->privdb_val == AST_PRIVACY_UNKNOWN) {
1409                 /* Get the user's intro, store it in priv-callerintros/$CID,
1410                    unless it is already there-- this should be done before the
1411                    call is actually dialed  */
1412
1413                 /* make sure the priv-callerintros dir actually exists */
1414                 snprintf(pa->privintro, sizeof(pa->privintro), "%s/sounds/priv-callerintros", ast_config_AST_DATA_DIR);
1415                 if ((res = ast_mkdir(pa->privintro, 0755))) {
1416                         ast_log(LOG_WARNING, "privacy: can't create directory priv-callerintros: %s\n", strerror(res));
1417                         return -1;
1418                 }
1419
1420                 snprintf(pa->privintro, sizeof(pa->privintro), "priv-callerintros/%s", pa->privcid);
1421                 if (ast_fileexists(pa->privintro, NULL, NULL ) > 0 && strncmp(pa->privcid, "NOCALLERID", 10) != 0) {
1422                         /* the DELUX version of this code would allow this caller the
1423                            option to hear and retape their previously recorded intro.
1424                         */
1425                 } else {
1426                         int duration; /* for feedback from play_and_wait */
1427                         /* the file doesn't exist yet. Let the caller submit his
1428                            vocal intro for posterity */
1429                         /* priv-recordintro script:
1430
1431                            "At the tone, please say your name:"
1432
1433                         */
1434                         silencethreshold = ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE);
1435                         ast_answer(chan);
1436                         res = ast_play_and_record(chan, "priv-recordintro", pa->privintro, 4, "gsm", &duration, silencethreshold, 2000, 0);  /* NOTE: I've reduced the total time to 4 sec */
1437                                                                         /* don't think we'll need a lock removed, we took care of
1438                                                                            conflicts by naming the pa.privintro file */
1439                         if (res == -1) {
1440                                 /* Delete the file regardless since they hung up during recording */
1441                                 ast_filedelete(pa->privintro, NULL);
1442                                 if (ast_fileexists(pa->privintro, NULL, NULL) > 0)
1443                                         ast_log(LOG_NOTICE, "privacy: ast_filedelete didn't do its job on %s\n", pa->privintro);
1444                                 else
1445                                         ast_verb(3, "Successfully deleted %s intro file\n", pa->privintro);
1446                                 return -1;
1447                         }
1448                         if (!ast_streamfile(chan, "vm-dialout", chan->language) )
1449                                 ast_waitstream(chan, "");
1450                 }
1451         }
1452         return 1; /* success */
1453 }
1454
1455 static void set_dial_features(struct ast_flags64 *opts, struct ast_dial_features *features)
1456 {
1457         struct ast_flags64 perm_opts = {.flags = 0};
1458
1459         ast_copy_flags64(&perm_opts, opts,
1460                 OPT_CALLER_TRANSFER | OPT_CALLER_PARK | OPT_CALLER_MONITOR | OPT_CALLER_MIXMONITOR | OPT_CALLER_HANGUP |
1461                 OPT_CALLEE_TRANSFER | OPT_CALLEE_PARK | OPT_CALLEE_MONITOR | OPT_CALLEE_MIXMONITOR | OPT_CALLEE_HANGUP);
1462
1463         memset(features->options, 0, sizeof(features->options));
1464
1465         ast_app_options2str64(dial_exec_options, &perm_opts, features->options, sizeof(features->options));
1466 }
1467
1468 static void end_bridge_callback(void *data)
1469 {
1470         char buf[80];
1471         time_t end;
1472         struct ast_channel *chan = data;
1473
1474         if (!chan->cdr) {
1475                 return;
1476         }
1477
1478         time(&end);
1479
1480         ast_channel_lock(chan);
1481         if (chan->cdr->answer.tv_sec) {
1482                 snprintf(buf, sizeof(buf), "%ld", end - chan->cdr->answer.tv_sec);
1483                 pbx_builtin_setvar_helper(chan, "ANSWEREDTIME", buf);
1484         }
1485
1486         if (chan->cdr->start.tv_sec) {
1487                 snprintf(buf, sizeof(buf), "%ld", end - chan->cdr->start.tv_sec);
1488                 pbx_builtin_setvar_helper(chan, "DIALEDTIME", buf);
1489         }
1490         ast_channel_unlock(chan);
1491 }
1492
1493 static int dial_exec_full(struct ast_channel *chan, void *data, struct ast_flags64 *peerflags, int *continue_exec)
1494 {
1495         int res = -1; /* default: error */
1496         char *rest, *cur; /* scan the list of destinations */
1497         struct chanlist *outgoing = NULL; /* list of destinations */
1498         struct ast_channel *peer;
1499         int to; /* timeout */
1500         struct cause_args num = { chan, 0, 0, 0 };
1501         int cause;
1502         char numsubst[256];
1503         char cidname[AST_MAX_EXTENSION] = "";
1504
1505         struct ast_bridge_config config = { { 0, } };
1506         struct timeval calldurationlimit = { 0, };
1507         char *dtmfcalled = NULL, *dtmfcalling = NULL;
1508         struct privacy_args pa = {
1509                 .sentringing = 0,
1510                 .privdb_val = 0,
1511                 .status = "INVALIDARGS",
1512         };
1513         int sentringing = 0, moh = 0;
1514         const char *outbound_group = NULL;
1515         int result = 0;
1516         char *parse;
1517         int opermode = 0;
1518         AST_DECLARE_APP_ARGS(args,
1519                 AST_APP_ARG(peers);
1520                 AST_APP_ARG(timeout);
1521                 AST_APP_ARG(options);
1522                 AST_APP_ARG(url);
1523         );
1524         struct ast_flags64 opts = { 0, };
1525         char *opt_args[OPT_ARG_ARRAY_SIZE];
1526         struct ast_datastore *datastore = NULL;
1527         struct ast_datastore *ds_caller_features = NULL;
1528         struct ast_datastore *ds_callee_features = NULL;
1529         struct ast_dial_features *caller_features;
1530         int fulldial = 0, num_dialed = 0;
1531
1532         /* Reset all DIAL variables back to blank, to prevent confusion (in case we don't reset all of them). */
1533         pbx_builtin_setvar_helper(chan, "DIALSTATUS", "");
1534         pbx_builtin_setvar_helper(chan, "DIALEDPEERNUMBER", "");
1535         pbx_builtin_setvar_helper(chan, "DIALEDPEERNAME", "");
1536         pbx_builtin_setvar_helper(chan, "ANSWEREDTIME", "");
1537         pbx_builtin_setvar_helper(chan, "DIALEDTIME", "");
1538
1539         if (ast_strlen_zero(data)) {
1540                 ast_log(LOG_WARNING, "Dial requires an argument (technology/number)\n");
1541                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
1542                 return -1;
1543         }
1544
1545         parse = ast_strdupa(data);
1546
1547         AST_STANDARD_APP_ARGS(args, parse);
1548
1549         if (!ast_strlen_zero(args.options) &&
1550                 ast_app_parse_options64(dial_exec_options, &opts, opt_args, args.options)) {
1551                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
1552                 goto done;
1553         }
1554
1555         if (ast_strlen_zero(args.peers)) {
1556                 ast_log(LOG_WARNING, "Dial requires an argument (technology/number)\n");
1557                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
1558                 goto done;
1559         }
1560
1561         if (ast_test_flag64(&opts, OPT_OPERMODE)) {
1562                 opermode = ast_strlen_zero(opt_args[OPT_ARG_OPERMODE]) ? 1 : atoi(opt_args[OPT_ARG_OPERMODE]);
1563                 ast_verb(3, "Setting operator services mode to %d.\n", opermode);
1564         }
1565         
1566         if (ast_test_flag64(&opts, OPT_DURATION_STOP) && !ast_strlen_zero(opt_args[OPT_ARG_DURATION_STOP])) {
1567                 calldurationlimit.tv_sec = atoi(opt_args[OPT_ARG_DURATION_STOP]);
1568                 if (!calldurationlimit.tv_sec) {
1569                         ast_log(LOG_WARNING, "Dial does not accept S(%s), hanging up.\n", opt_args[OPT_ARG_DURATION_STOP]);
1570                         pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
1571                         goto done;
1572                 }
1573                 ast_verb(3, "Setting call duration limit to %.3lf seconds.\n", calldurationlimit.tv_sec + calldurationlimit.tv_usec / 1000000.0);
1574         }
1575
1576         if (ast_test_flag64(&opts, OPT_SENDDTMF) && !ast_strlen_zero(opt_args[OPT_ARG_SENDDTMF])) {
1577                 dtmfcalling = opt_args[OPT_ARG_SENDDTMF];
1578                 dtmfcalled = strsep(&dtmfcalling, ":");
1579         }
1580
1581         if (ast_test_flag64(&opts, OPT_DURATION_LIMIT) && !ast_strlen_zero(opt_args[OPT_ARG_DURATION_LIMIT])) {
1582                 if (do_timelimit(chan, &config, opt_args[OPT_ARG_DURATION_LIMIT], &calldurationlimit))
1583                         goto done;
1584         }
1585
1586         if (ast_test_flag64(&opts, OPT_RESETCDR) && chan->cdr)
1587                 ast_cdr_reset(chan->cdr, NULL);
1588         if (ast_test_flag64(&opts, OPT_PRIVACY) && ast_strlen_zero(opt_args[OPT_ARG_PRIVACY]))
1589                 opt_args[OPT_ARG_PRIVACY] = ast_strdupa(chan->exten);
1590
1591         if (ast_test_flag64(&opts, OPT_PRIVACY) || ast_test_flag64(&opts, OPT_SCREENING)) {
1592                 res = setup_privacy_args(&pa, &opts, opt_args, chan);
1593                 if (res <= 0)
1594                         goto out;
1595                 res = -1; /* reset default */
1596         }
1597
1598         if (continue_exec)
1599                 *continue_exec = 0;
1600
1601         /* If a channel group has been specified, get it for use when we create peer channels */
1602
1603         ast_channel_lock(chan);
1604         if ((outbound_group = pbx_builtin_getvar_helper(chan, "OUTBOUND_GROUP_ONCE"))) {
1605                 outbound_group = ast_strdupa(outbound_group);   
1606                 pbx_builtin_setvar_helper(chan, "OUTBOUND_GROUP_ONCE", NULL);
1607         } else if ((outbound_group = pbx_builtin_getvar_helper(chan, "OUTBOUND_GROUP"))) {
1608                 outbound_group = ast_strdupa(outbound_group);
1609         }
1610         ast_channel_unlock(chan);       
1611         ast_copy_flags64(peerflags, &opts, OPT_DTMF_EXIT | OPT_GO_ON | OPT_ORIGINAL_CLID | OPT_CALLER_HANGUP | OPT_IGNORE_FORWARDING);
1612
1613         /* Create datastore for channel dial features for caller */
1614         if (!(ds_caller_features = ast_datastore_alloc(&dial_features_info, NULL))) {
1615                 ast_log(LOG_WARNING, "Unable to create channel datastore for dial features. Aborting!\n");
1616                 goto out;
1617         }
1618
1619         if (!(caller_features = ast_malloc(sizeof(*caller_features)))) {
1620                 ast_log(LOG_WARNING, "Unable to allocate memory for feature flags. Aborting!\n");
1621                 goto out;
1622         }
1623
1624         ast_copy_flags(&(caller_features->features_callee), &(config.features_caller), AST_FLAGS_ALL);
1625         caller_features->is_caller = 1;
1626         set_dial_features(&opts, caller_features);
1627
1628         ds_caller_features->inheritance = DATASTORE_INHERIT_FOREVER;
1629         ds_caller_features->data = caller_features;
1630
1631         ast_channel_lock(chan);
1632         ast_channel_datastore_add(chan, ds_caller_features);
1633         ast_channel_unlock(chan);
1634
1635         /* loop through the list of dial destinations */
1636         rest = args.peers;
1637         while ((cur = strsep(&rest, "&")) ) {
1638                 struct chanlist *tmp;
1639                 struct ast_channel *tc; /* channel for this destination */
1640                 /* Get a technology/[device:]number pair */
1641                 char *number = cur;
1642                 char *interface = ast_strdupa(number);
1643                 char *tech = strsep(&number, "/");
1644                 /* find if we already dialed this interface */
1645                 struct ast_dialed_interface *di;
1646                 struct ast_dial_features *callee_features;
1647                 AST_LIST_HEAD(, ast_dialed_interface) *dialed_interfaces;
1648                 num_dialed++;
1649                 if (!number) {
1650                         ast_log(LOG_WARNING, "Dial argument takes format (technology/[device:]number1)\n");
1651                         goto out;
1652                 }
1653                 if (!(tmp = ast_calloc(1, sizeof(*tmp))))
1654                         goto out;
1655                 if (opts.flags) {
1656                         ast_copy_flags64(tmp, &opts,
1657                                 OPT_CANCEL_ELSEWHERE |
1658                                 OPT_CALLEE_TRANSFER | OPT_CALLER_TRANSFER |
1659                                 OPT_CALLEE_HANGUP | OPT_CALLER_HANGUP |
1660                                 OPT_CALLEE_MONITOR | OPT_CALLER_MONITOR |
1661                                 OPT_CALLEE_PARK | OPT_CALLER_PARK |
1662                                 OPT_CALLEE_MIXMONITOR | OPT_CALLER_MIXMONITOR |
1663                                 OPT_RINGBACK | OPT_MUSICBACK | OPT_FORCECLID);
1664                         ast_set2_flag64(tmp, args.url, DIAL_NOFORWARDHTML);
1665                 }
1666                 ast_copy_string(numsubst, number, sizeof(numsubst));
1667                 /* Request the peer */
1668
1669                 ast_channel_lock(chan);
1670                 datastore = ast_channel_datastore_find(chan, &dialed_interface_info, NULL);
1671                 ast_channel_unlock(chan);
1672
1673                 if (datastore)
1674                         dialed_interfaces = datastore->data;
1675                 else {
1676                         if (!(datastore = ast_datastore_alloc(&dialed_interface_info, NULL))) {
1677                                 ast_log(LOG_WARNING, "Unable to create channel datastore for dialed interfaces. Aborting!\n");
1678                                 ast_free(tmp);
1679                                 goto out;
1680                         }
1681
1682                         datastore->inheritance = DATASTORE_INHERIT_FOREVER;
1683
1684                         if (!(dialed_interfaces = ast_calloc(1, sizeof(*dialed_interfaces)))) {
1685                                 ast_free(tmp);
1686                                 goto out;
1687                         }
1688
1689                         datastore->data = dialed_interfaces;
1690                         AST_LIST_HEAD_INIT(dialed_interfaces);
1691
1692                         ast_channel_lock(chan);
1693                         ast_channel_datastore_add(chan, datastore);
1694                         ast_channel_unlock(chan);
1695                 }
1696
1697                 AST_LIST_LOCK(dialed_interfaces);
1698                 AST_LIST_TRAVERSE(dialed_interfaces, di, list) {
1699                         if (!strcasecmp(di->interface, interface)) {
1700                                 ast_log(LOG_WARNING, "Skipping dialing interface '%s' again since it has already been dialed\n",
1701                                         di->interface);
1702                                 break;
1703                         }
1704                 }
1705                 AST_LIST_UNLOCK(dialed_interfaces);
1706
1707                 if (di) {
1708                         fulldial++;
1709                         ast_free(tmp);
1710                         continue;
1711                 }
1712
1713                 /* It is always ok to dial a Local interface.  We only keep track of
1714                  * which "real" interfaces have been dialed.  The Local channel will
1715                  * inherit this list so that if it ends up dialing a real interface,
1716                  * it won't call one that has already been called. */
1717                 if (strcasecmp(tech, "Local")) {
1718                         if (!(di = ast_calloc(1, sizeof(*di) + strlen(interface)))) {
1719                                 AST_LIST_UNLOCK(dialed_interfaces);
1720                                 ast_free(tmp);
1721                                 goto out;
1722                         }
1723                         strcpy(di->interface, interface);
1724
1725                         AST_LIST_LOCK(dialed_interfaces);
1726                         AST_LIST_INSERT_TAIL(dialed_interfaces, di, list);
1727                         AST_LIST_UNLOCK(dialed_interfaces);
1728                 }
1729
1730                 tc = ast_request(tech, chan->nativeformats, numsubst, &cause);
1731                 if (!tc) {
1732                         /* If we can't, just go on to the next call */
1733                         ast_log(LOG_WARNING, "Unable to create channel of type '%s' (cause %d - %s)\n",
1734                                 tech, cause, ast_cause2str(cause));
1735                         handle_cause(cause, &num);
1736                         if (!rest) /* we are on the last destination */
1737                                 chan->hangupcause = cause;
1738                         ast_free(tmp);
1739                         continue;
1740                 }
1741                 pbx_builtin_setvar_helper(tc, "DIALEDPEERNUMBER", numsubst);
1742
1743                 /* Setup outgoing SDP to match incoming one */
1744                 ast_rtp_make_compatible(tc, chan, !outgoing && !rest);
1745                 
1746                 /* Inherit specially named variables from parent channel */
1747                 ast_channel_inherit_variables(chan, tc);
1748                 ast_channel_datastore_inherit(chan, tc);
1749
1750                 tc->appl = "AppDial";
1751                 tc->data = "(Outgoing Line)";
1752                 memset(&tc->whentohangup, 0, sizeof(tc->whentohangup));
1753
1754                 S_REPLACE(tc->cid.cid_num, ast_strdup(chan->cid.cid_num));
1755                 S_REPLACE(tc->cid.cid_name, ast_strdup(chan->cid.cid_name));
1756                 S_REPLACE(tc->cid.cid_ani, ast_strdup(chan->cid.cid_ani));
1757                 S_REPLACE(tc->cid.cid_rdnis, ast_strdup(chan->cid.cid_rdnis));
1758                 
1759                 ast_string_field_set(tc, accountcode, chan->accountcode);
1760                 tc->cdrflags = chan->cdrflags;
1761                 if (ast_strlen_zero(tc->musicclass))
1762                         ast_string_field_set(tc, musicclass, chan->musicclass);
1763                 /* Pass callingpres, type of number, tns, ADSI CPE, transfer capability */
1764                 tc->cid.cid_pres = chan->cid.cid_pres;
1765                 tc->cid.cid_ton = chan->cid.cid_ton;
1766                 tc->cid.cid_tns = chan->cid.cid_tns;
1767                 tc->cid.cid_ani2 = chan->cid.cid_ani2;
1768                 tc->adsicpe = chan->adsicpe;
1769                 tc->transfercapability = chan->transfercapability;
1770
1771                 /* If we have an outbound group, set this peer channel to it */
1772                 if (outbound_group)
1773                         ast_app_group_set_channel(tc, outbound_group);
1774
1775                 /* Inherit context and extension */
1776                 ast_string_field_set(tc, dialcontext, ast_strlen_zero(chan->macrocontext) ? chan->context : chan->macrocontext);
1777                 if (!ast_strlen_zero(chan->macroexten))
1778                         ast_copy_string(tc->exten, chan->macroexten, sizeof(tc->exten));
1779                 else
1780                         ast_copy_string(tc->exten, chan->exten, sizeof(tc->exten));
1781
1782                 /* Save callee features */
1783                 if (!(ds_callee_features = ast_datastore_alloc(&dial_features_info, NULL))) {
1784                         ast_log(LOG_WARNING, "Unable to create channel datastore for dial features. Aborting!\n");
1785                         ast_free(tmp);
1786                         goto out;
1787                 }
1788
1789                 if (!(callee_features = ast_malloc(sizeof(*callee_features)))) {
1790                         ast_log(LOG_WARNING, "Unable to allocate memory for feature flags. Aborting!\n");
1791                         ast_free(tmp);
1792                         goto out;
1793                 }
1794
1795                 ast_copy_flags(&(callee_features->features_callee), &(config.features_callee), AST_FLAGS_ALL);
1796                 callee_features->is_caller = 0;
1797                 set_dial_features(&opts, callee_features);
1798
1799                 ds_callee_features->inheritance = DATASTORE_INHERIT_FOREVER;
1800                 ds_callee_features->data = callee_features;
1801
1802                 ast_channel_lock(chan);
1803                 ast_channel_datastore_add(tc, ds_callee_features);
1804                 ast_channel_unlock(chan);
1805
1806                 res = ast_call(tc, numsubst, 0); /* Place the call, but don't wait on the answer */
1807
1808                 /* Save the info in cdr's that we called them */
1809                 if (chan->cdr)
1810                         ast_cdr_setdestchan(chan->cdr, tc->name);
1811
1812                 /* check the results of ast_call */
1813                 if (res) {
1814                         /* Again, keep going even if there's an error */
1815                         ast_debug(1, "ast call on peer returned %d\n", res);
1816                         ast_verb(3, "Couldn't call %s\n", numsubst);
1817                         ast_hangup(tc);
1818                         tc = NULL;
1819                         ast_free(tmp);
1820                         continue;
1821                 } else {
1822                         senddialevent(chan, tc, numsubst);
1823                         ast_verb(3, "Called %s\n", numsubst);
1824                         if (!ast_test_flag64(peerflags, OPT_ORIGINAL_CLID))
1825                                 ast_set_callerid(tc, S_OR(chan->macroexten, chan->exten), get_cid_name(cidname, sizeof(cidname), chan), NULL);
1826                 }
1827                 /* Put them in the list of outgoing thingies...  We're ready now.
1828                    XXX If we're forcibly removed, these outgoing calls won't get
1829                    hung up XXX */
1830                 ast_set_flag64(tmp, DIAL_STILLGOING);
1831                 tmp->chan = tc;
1832                 tmp->next = outgoing;
1833                 outgoing = tmp;
1834                 /* If this line is up, don't try anybody else */
1835                 if (outgoing->chan->_state == AST_STATE_UP)
1836                         break;
1837         }
1838         
1839         if (ast_strlen_zero(args.timeout)) {
1840                 to = -1;
1841         } else {
1842                 to = atoi(args.timeout);
1843                 if (to > 0)
1844                         to *= 1000;
1845                 else {
1846                         ast_log(LOG_WARNING, "Invalid timeout specified: '%s'. Setting timeout to infinite\n", args.timeout);
1847                         to = -1;
1848                 }
1849         }
1850
1851         if (!outgoing) {
1852                 strcpy(pa.status, "CHANUNAVAIL");
1853                 if (fulldial == num_dialed) {
1854                         res = -1;
1855                         goto out;
1856                 }
1857         } else {
1858                 /* Our status will at least be NOANSWER */
1859                 strcpy(pa.status, "NOANSWER");
1860                 if (ast_test_flag64(outgoing, OPT_MUSICBACK)) {
1861                         moh = 1;
1862                         if (!ast_strlen_zero(opt_args[OPT_ARG_MUSICBACK])) {
1863                                 char *original_moh = ast_strdupa(chan->musicclass);
1864                                 ast_string_field_set(chan, musicclass, opt_args[OPT_ARG_MUSICBACK]);
1865                                 ast_moh_start(chan, opt_args[OPT_ARG_MUSICBACK], NULL);
1866                                 ast_string_field_set(chan, musicclass, original_moh);
1867                         } else {
1868                                 ast_moh_start(chan, NULL, NULL);
1869                         }
1870                         ast_indicate(chan, AST_CONTROL_PROGRESS);
1871                 } else if (ast_test_flag64(outgoing, OPT_RINGBACK)) {
1872                         ast_indicate(chan, AST_CONTROL_RINGING);
1873                         sentringing++;
1874                 }
1875         }
1876
1877         peer = wait_for_answer(chan, outgoing, &to, peerflags, &pa, &num, &result);
1878
1879         /* The ast_channel_datastore_remove() function could fail here if the
1880          * datastore was moved to another channel during a masquerade. If this is
1881          * the case, don't free the datastore here because later, when the channel
1882          * to which the datastore was moved hangs up, it will attempt to free this
1883          * datastore again, causing a crash
1884          */
1885         if (!ast_channel_datastore_remove(chan, datastore))
1886                 ast_datastore_free(datastore);
1887         if (!peer) {
1888                 if (result) {
1889                         res = result;
1890                 } else if (to) { /* Musta gotten hung up */
1891                         res = -1;
1892                 } else { /* Nobody answered, next please? */
1893                         res = 0;
1894                 }
1895
1896                 /* SIP, in particular, sends back this error code to indicate an
1897                  * overlap dialled number needs more digits. */
1898                 if (chan->hangupcause == AST_CAUSE_INVALID_NUMBER_FORMAT) {
1899                         res = AST_PBX_INCOMPLETE;
1900                 }
1901
1902                 /* almost done, although the 'else' block is 400 lines */
1903         } else {
1904                 const char *number;
1905
1906                 strcpy(pa.status, "ANSWER");
1907                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
1908                 /* Ah ha!  Someone answered within the desired timeframe.  Of course after this
1909                    we will always return with -1 so that it is hung up properly after the
1910                    conversation.  */
1911                 hanguptree(outgoing, peer, 1);
1912                 outgoing = NULL;
1913                 /* If appropriate, log that we have a destination channel */
1914                 if (chan->cdr)
1915                         ast_cdr_setdestchan(chan->cdr, peer->name);
1916                 if (peer->name)
1917                         pbx_builtin_setvar_helper(chan, "DIALEDPEERNAME", peer->name);
1918                 
1919                 ast_channel_lock(peer);
1920                 number = pbx_builtin_getvar_helper(peer, "DIALEDPEERNUMBER"); 
1921                 if (!number)
1922                         number = numsubst;
1923                 pbx_builtin_setvar_helper(chan, "DIALEDPEERNUMBER", number);
1924                 ast_channel_unlock(peer);
1925
1926                 if (!ast_strlen_zero(args.url) && ast_channel_supports_html(peer) ) {
1927                         ast_debug(1, "app_dial: sendurl=%s.\n", args.url);
1928                         ast_channel_sendurl( peer, args.url );
1929                 }
1930                 if ( (ast_test_flag64(&opts, OPT_PRIVACY) || ast_test_flag64(&opts, OPT_SCREENING)) && pa.privdb_val == AST_PRIVACY_UNKNOWN) {
1931                         if (do_privacy(chan, peer, &opts, opt_args, &pa)) {
1932                                 res = 0;
1933                                 goto out;
1934                         }
1935                 }
1936                 if (!ast_test_flag64(&opts, OPT_ANNOUNCE) || ast_strlen_zero(opt_args[OPT_ARG_ANNOUNCE])) {
1937                         res = 0;
1938                 } else {
1939                         int digit = 0;
1940                         /* Start autoservice on the other chan */
1941                         res = ast_autoservice_start(chan);
1942                         /* Now Stream the File */
1943                         if (!res)
1944                                 res = ast_streamfile(peer, opt_args[OPT_ARG_ANNOUNCE], peer->language);
1945                         if (!res) {
1946                                 digit = ast_waitstream(peer, AST_DIGIT_ANY);
1947                         }
1948                         /* Ok, done. stop autoservice */
1949                         res = ast_autoservice_stop(chan);
1950                         if (digit > 0 && !res)
1951                                 res = ast_senddigit(chan, digit, 0);
1952                         else
1953                                 res = digit;
1954
1955                 }
1956
1957                 if (chan && peer && ast_test_flag64(&opts, OPT_GOTO) && !ast_strlen_zero(opt_args[OPT_ARG_GOTO])) {
1958                         replace_macro_delimiter(opt_args[OPT_ARG_GOTO]);
1959                         ast_parseable_goto(chan, opt_args[OPT_ARG_GOTO]);
1960                         /* peer goes to the same context and extension as chan, so just copy info from chan*/
1961                         ast_copy_string(peer->context, chan->context, sizeof(peer->context));
1962                         ast_copy_string(peer->exten, chan->exten, sizeof(peer->exten));
1963                         peer->priority = chan->priority + 2;
1964                         ast_pbx_start(peer);
1965                         hanguptree(outgoing, NULL, ast_test_flag64(&opts, OPT_CANCEL_ELSEWHERE) ? 1 : 0);
1966                         if (continue_exec)
1967                                 *continue_exec = 1;
1968                         res = 0;
1969                         goto done;
1970                 }
1971
1972                 if (ast_test_flag64(&opts, OPT_CALLEE_MACRO) && !ast_strlen_zero(opt_args[OPT_ARG_CALLEE_MACRO])) {
1973                         struct ast_app *theapp;
1974                         const char *macro_result;
1975
1976                         res = ast_autoservice_start(chan);
1977                         if (res) {
1978                                 ast_log(LOG_ERROR, "Unable to start autoservice on calling channel\n");
1979                                 res = -1;
1980                         }
1981
1982                         theapp = pbx_findapp("Macro");
1983
1984                         if (theapp && !res) { /* XXX why check res here ? */
1985                                 replace_macro_delimiter(opt_args[OPT_ARG_CALLEE_MACRO]);
1986                                 res = pbx_exec(peer, theapp, opt_args[OPT_ARG_CALLEE_MACRO]);
1987                                 ast_debug(1, "Macro exited with status %d\n", res);
1988                                 res = 0;
1989                         } else {
1990                                 ast_log(LOG_ERROR, "Could not find application Macro\n");
1991                                 res = -1;
1992                         }
1993
1994                         if (ast_autoservice_stop(chan) < 0) {
1995                                 ast_log(LOG_ERROR, "Could not stop autoservice on calling channel\n");
1996                                 res = -1;
1997                         }
1998
1999                         ast_channel_lock(peer);
2000
2001                         if (!res && (macro_result = pbx_builtin_getvar_helper(peer, "MACRO_RESULT"))) {
2002                                 char *macro_transfer_dest;
2003
2004                                 if (!strcasecmp(macro_result, "BUSY")) {
2005                                         ast_copy_string(pa.status, macro_result, sizeof(pa.status));
2006                                         ast_set_flag64(peerflags, OPT_GO_ON);
2007                                         res = -1;
2008                                 } else if (!strcasecmp(macro_result, "CONGESTION") || !strcasecmp(macro_result, "CHANUNAVAIL")) {
2009                                         ast_copy_string(pa.status, macro_result, sizeof(pa.status));
2010                                         ast_set_flag64(peerflags, OPT_GO_ON);
2011                                         res = -1;
2012                                 } else if (!strcasecmp(macro_result, "CONTINUE")) {
2013                                         /* hangup peer and keep chan alive assuming the macro has changed
2014                                            the context / exten / priority or perhaps
2015                                            the next priority in the current exten is desired.
2016                                         */
2017                                         ast_set_flag64(peerflags, OPT_GO_ON);
2018                                         res = -1;
2019                                 } else if (!strcasecmp(macro_result, "ABORT")) {
2020                                         /* Hangup both ends unless the caller has the g flag */
2021                                         res = -1;
2022                                 } else if (!strncasecmp(macro_result, "GOTO:", 5) && (macro_transfer_dest = ast_strdupa(macro_result + 5))) {
2023                                         res = -1;
2024                                         /* perform a transfer to a new extension */
2025                                         if (strchr(macro_transfer_dest, '^')) { /* context^exten^priority*/
2026                                                 replace_macro_delimiter(macro_transfer_dest);
2027                                                 if (!ast_parseable_goto(chan, macro_transfer_dest))
2028                                                         ast_set_flag64(peerflags, OPT_GO_ON);
2029                                         }
2030                                 }
2031                         }
2032
2033                         ast_channel_unlock(peer);
2034                 }
2035
2036                 if (ast_test_flag64(&opts, OPT_CALLEE_GOSUB) && !ast_strlen_zero(opt_args[OPT_ARG_CALLEE_GOSUB])) {
2037                         struct ast_app *theapp;
2038                         const char *gosub_result;
2039                         char *gosub_args, *gosub_argstart;
2040                         int res9 = -1;
2041
2042                         res9 = ast_autoservice_start(chan);
2043                         if (res9) {
2044                                 ast_log(LOG_ERROR, "Unable to start autoservice on calling channel\n");
2045                                 res9 = -1;
2046                         }
2047
2048                         theapp = pbx_findapp("Gosub");
2049
2050                         if (theapp && !res9) {
2051                                 replace_macro_delimiter(opt_args[OPT_ARG_CALLEE_GOSUB]);
2052
2053                                 /* Set where we came from */
2054                                 ast_copy_string(peer->context, "app_dial_gosub_virtual_context", sizeof(peer->context));
2055                                 ast_copy_string(peer->exten, "s", sizeof(peer->exten));
2056                                 peer->priority = 0;
2057
2058                                 gosub_argstart = strchr(opt_args[OPT_ARG_CALLEE_GOSUB], ',');
2059                                 if (gosub_argstart) {
2060                                         *gosub_argstart = 0;
2061                                         if (asprintf(&gosub_args, "%s,s,1(%s)", opt_args[OPT_ARG_CALLEE_GOSUB], gosub_argstart + 1) < 0) {
2062                                                 ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
2063                                                 gosub_args = NULL;
2064                                         }
2065                                         *gosub_argstart = ',';
2066                                 } else {
2067                                         if (asprintf(&gosub_args, "%s,s,1", opt_args[OPT_ARG_CALLEE_GOSUB]) < 0) {
2068                                                 ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
2069                                                 gosub_args = NULL;
2070                                         }
2071                                 }
2072
2073                                 if (gosub_args) {
2074                                         res9 = pbx_exec(peer, theapp, gosub_args);
2075                                         ast_pbx_run(peer);
2076                                         ast_free(gosub_args);
2077                                         if (option_debug)
2078                                                 ast_log(LOG_DEBUG, "Gosub exited with status %d\n", res9);
2079                                 } else
2080                                         ast_log(LOG_ERROR, "Could not Allocate string for Gosub arguments -- Gosub Call Aborted!\n");
2081
2082                                 res9 = 0;
2083                         } else if (!res9) {
2084                                 ast_log(LOG_ERROR, "Could not find application Gosub\n");
2085                                 res9 = -1;
2086                         }
2087
2088                         if (ast_autoservice_stop(chan) < 0) {
2089                                 ast_log(LOG_ERROR, "Could not stop autoservice on calling channel\n");
2090                                 res9 = -1;
2091                         }
2092                         
2093                         ast_channel_lock(peer);
2094
2095                         if (!res9 && (gosub_result = pbx_builtin_getvar_helper(peer, "GOSUB_RESULT"))) {
2096                                 char *gosub_transfer_dest;
2097
2098                                 if (!strcasecmp(gosub_result, "BUSY")) {
2099                                         ast_copy_string(pa.status, gosub_result, sizeof(pa.status));
2100                                         ast_set_flag64(peerflags, OPT_GO_ON);
2101                                         res9 = -1;
2102                                 } else if (!strcasecmp(gosub_result, "CONGESTION") || !strcasecmp(gosub_result, "CHANUNAVAIL")) {
2103                                         ast_copy_string(pa.status, gosub_result, sizeof(pa.status));
2104                                         ast_set_flag64(peerflags, OPT_GO_ON);
2105                                         res9 = -1;
2106                                 } else if (!strcasecmp(gosub_result, "CONTINUE")) {
2107                                         /* hangup peer and keep chan alive assuming the macro has changed
2108                                            the context / exten / priority or perhaps
2109                                            the next priority in the current exten is desired.
2110                                         */
2111                                         ast_set_flag64(peerflags, OPT_GO_ON);
2112                                         res9 = -1;
2113                                 } else if (!strcasecmp(gosub_result, "ABORT")) {
2114                                         /* Hangup both ends unless the caller has the g flag */
2115                                         res9 = -1;
2116                                 } else if (!strncasecmp(gosub_result, "GOTO:", 5) && (gosub_transfer_dest = ast_strdupa(gosub_result + 5))) {
2117                                         res9 = -1;
2118                                         /* perform a transfer to a new extension */
2119                                         if (strchr(gosub_transfer_dest, '^')) { /* context^exten^priority*/
2120                                                 replace_macro_delimiter(gosub_transfer_dest);
2121                                                 if (!ast_parseable_goto(chan, gosub_transfer_dest))
2122                                                         ast_set_flag64(peerflags, OPT_GO_ON);
2123                                         }
2124                                 }
2125                         }
2126
2127                         ast_channel_unlock(peer);       
2128                 }
2129
2130                 if (!res) {
2131                         if (!ast_tvzero(calldurationlimit)) {
2132                                 struct timeval whentohangup = calldurationlimit;
2133                                 peer->whentohangup = ast_tvadd(ast_tvnow(), whentohangup);
2134                         }
2135                         if (!ast_strlen_zero(dtmfcalled)) {
2136                                 ast_verb(3, "Sending DTMF '%s' to the called party.\n", dtmfcalled);
2137                                 res = ast_dtmf_stream(peer, chan, dtmfcalled, 250, 0);
2138                         }
2139                         if (!ast_strlen_zero(dtmfcalling)) {
2140                                 ast_verb(3, "Sending DTMF '%s' to the calling party.\n", dtmfcalling);
2141                                 res = ast_dtmf_stream(chan, peer, dtmfcalling, 250, 0);
2142                         }
2143                 }
2144
2145                 if (res) { /* some error */
2146                         res = -1;
2147                 } else {
2148                         if (ast_test_flag64(peerflags, OPT_CALLEE_TRANSFER))
2149                                 ast_set_flag(&(config.features_callee), AST_FEATURE_REDIRECT);
2150                         if (ast_test_flag64(peerflags, OPT_CALLER_TRANSFER))
2151                                 ast_set_flag(&(config.features_caller), AST_FEATURE_REDIRECT);
2152                         if (ast_test_flag64(peerflags, OPT_CALLEE_HANGUP))
2153                                 ast_set_flag(&(config.features_callee), AST_FEATURE_DISCONNECT);
2154                         if (ast_test_flag64(peerflags, OPT_CALLER_HANGUP))
2155                                 ast_set_flag(&(config.features_caller), AST_FEATURE_DISCONNECT);
2156                         if (ast_test_flag64(peerflags, OPT_CALLEE_MONITOR))
2157                                 ast_set_flag(&(config.features_callee), AST_FEATURE_AUTOMON);
2158                         if (ast_test_flag64(peerflags, OPT_CALLER_MONITOR))
2159                                 ast_set_flag(&(config.features_caller), AST_FEATURE_AUTOMON);
2160                         if (ast_test_flag64(peerflags, OPT_CALLEE_PARK))
2161                                 ast_set_flag(&(config.features_callee), AST_FEATURE_PARKCALL);
2162                         if (ast_test_flag64(peerflags, OPT_CALLER_PARK))
2163                                 ast_set_flag(&(config.features_caller), AST_FEATURE_PARKCALL);
2164                         if (ast_test_flag64(peerflags, OPT_CALLEE_MIXMONITOR))
2165                                 ast_set_flag(&(config.features_callee), AST_FEATURE_AUTOMIXMON);
2166                         if (ast_test_flag64(peerflags, OPT_CALLER_MIXMONITOR))
2167                                 ast_set_flag(&(config.features_caller), AST_FEATURE_AUTOMIXMON);
2168                         if (ast_test_flag64(peerflags, OPT_GO_ON))
2169                                 ast_set_flag(&(config.features_caller), AST_FEATURE_NO_H_EXTEN);
2170
2171                         config.end_bridge_callback = end_bridge_callback;
2172                         config.end_bridge_callback_data = chan;
2173
2174                         if (moh) {
2175                                 moh = 0;
2176                                 ast_moh_stop(chan);
2177                         } else if (sentringing) {
2178                                 sentringing = 0;
2179                                 ast_indicate(chan, -1);
2180                         }
2181                         /* Be sure no generators are left on it */
2182                         ast_deactivate_generator(chan);
2183                         /* Make sure channels are compatible */
2184                         res = ast_channel_make_compatible(chan, peer);
2185                         if (res < 0) {
2186                                 ast_log(LOG_WARNING, "Had to drop call because I couldn't make %s compatible with %s\n", chan->name, peer->name);
2187                                 ast_hangup(peer);
2188                                 res = -1;
2189                                 goto done;
2190                         }
2191                         if (opermode) {
2192                                 struct oprmode oprmode;
2193
2194                                 oprmode.peer = peer;
2195                                 oprmode.mode = opermode;
2196
2197                                 ast_channel_setoption(chan, AST_OPTION_OPRMODE, &oprmode, sizeof(oprmode), 0);
2198                         }
2199                         res = ast_bridge_call(chan, peer, &config);
2200                 }
2201
2202                 if (res != AST_PBX_NO_HANGUP_PEER_PARKED && ast_test_flag64(&opts, OPT_PEER_H)) {
2203                         ast_log(LOG_NOTICE, "PEER context: %s; PEER exten: %s;  PEER priority: %d\n",
2204                                 peer->context, peer->exten, peer->priority);
2205                 }
2206                 if (res != AST_PBX_NO_HANGUP_PEER_PARKED)
2207                         strcpy(peer->context, chan->context);
2208
2209                 if (res != AST_PBX_NO_HANGUP_PEER_PARKED && ast_test_flag64(&opts, OPT_PEER_H) && ast_exists_extension(peer, peer->context, "h", 1, peer->cid.cid_num)) {
2210                         int autoloopflag;
2211                         int found;
2212                         int res9;
2213                         
2214                         strcpy(peer->exten, "h");
2215                         peer->priority = 1;
2216                         autoloopflag = ast_test_flag(peer, AST_FLAG_IN_AUTOLOOP); /* save value to restore at the end */
2217                         ast_set_flag(peer, AST_FLAG_IN_AUTOLOOP);
2218
2219                         while ((res9 = ast_spawn_extension(peer, peer->context, peer->exten, peer->priority, peer->cid.cid_num, &found, 1)) == 0)
2220                                 peer->priority++;
2221
2222                         if (found && res9) {
2223                                 /* Something bad happened, or a hangup has been requested. */
2224                                 ast_debug(1, "Spawn extension (%s,%s,%d) exited non-zero on '%s'\n", peer->context, peer->exten, peer->priority, peer->name);
2225                                 ast_verb(2, "Spawn extension (%s, %s, %d) exited non-zero on '%s'\n", peer->context, peer->exten, peer->priority, peer->name);
2226                         }
2227                         ast_set2_flag(peer, autoloopflag, AST_FLAG_IN_AUTOLOOP);  /* set it back the way it was */
2228                 }
2229                 if (res != AST_PBX_NO_HANGUP_PEER && res != AST_PBX_NO_HANGUP_PEER_PARKED) {
2230                         if (!ast_check_hangup(peer) && ast_test_flag64(&opts, OPT_CALLEE_GO_ON) && !ast_strlen_zero(opt_args[OPT_ARG_CALLEE_GO_ON])) {          
2231                                 replace_macro_delimiter(opt_args[OPT_ARG_CALLEE_GO_ON]);
2232                                 ast_parseable_goto(peer, opt_args[OPT_ARG_CALLEE_GO_ON]);
2233                                 ast_pbx_start(peer);
2234                         } else {
2235                                 if (!ast_check_hangup(chan))
2236                                         chan->hangupcause = peer->hangupcause;
2237                                 ast_hangup(peer);
2238                         }
2239                 }
2240         }
2241 out:
2242         /* cleaning up chan is not a good idea here if AST_PBX_KEEPALIVE
2243            is returned; chan will get the love it needs from another
2244            thread */
2245         if (res != AST_PBX_KEEPALIVE) {
2246                 if (moh) {
2247                         moh = 0;
2248                         ast_moh_stop(chan);
2249                 } else if (sentringing) {
2250                         sentringing = 0;
2251                         ast_indicate(chan, -1);
2252                 }
2253                 ast_channel_early_bridge(chan, NULL);
2254                 hanguptree(outgoing, NULL, 0); /* In this case, there's no answer anywhere */
2255                 pbx_builtin_setvar_helper(chan, "DIALSTATUS", pa.status);
2256                 senddialendevent(chan, pa.status);
2257                 ast_debug(1, "Exiting with DIALSTATUS=%s.\n", pa.status);
2258
2259                 if ((ast_test_flag64(peerflags, OPT_GO_ON)) && !ast_check_hangup(chan) && (res != AST_PBX_KEEPALIVE) && (res != AST_PBX_INCOMPLETE)) {
2260                         if (!ast_tvzero(calldurationlimit))
2261                                 memset(&chan->whentohangup, 0, sizeof(chan->whentohangup));
2262                         res = 0;
2263                 }
2264         }
2265
2266 done:
2267         if (config.warning_sound) {
2268                 ast_free((char *)config.warning_sound);
2269         }
2270         if (config.end_sound) {
2271                 ast_free((char *)config.end_sound);
2272         }
2273         if (config.start_sound) {
2274                 ast_free((char *)config.start_sound);
2275         }
2276         return res;
2277 }
2278
2279 static int dial_exec(struct ast_channel *chan, void *data)
2280 {
2281         struct ast_flags64 peerflags;
2282
2283         memset(&peerflags, 0, sizeof(peerflags));
2284
2285         return dial_exec_full(chan, data, &peerflags, NULL);
2286 }
2287
2288 static int retrydial_exec(struct ast_channel *chan, void *data)
2289 {
2290         char *parse;
2291         const char *context = NULL;
2292         int sleepms = 0, loops = 0, res = -1;
2293         struct ast_flags64 peerflags = { 0, };
2294         AST_DECLARE_APP_ARGS(args,
2295                 AST_APP_ARG(announce);
2296                 AST_APP_ARG(sleep);
2297                 AST_APP_ARG(retries);
2298                 AST_APP_ARG(dialdata);
2299         );
2300
2301         if (ast_strlen_zero(data)) {
2302                 ast_log(LOG_WARNING, "RetryDial requires an argument!\n");
2303                 return -1;
2304         }
2305
2306         parse = ast_strdupa(data);
2307         AST_STANDARD_APP_ARGS(args, parse);
2308
2309         if ((sleepms = atoi(args.sleep)))
2310                 sleepms *= 1000;
2311
2312         loops = atoi(args.retries);
2313
2314         if (!args.dialdata) {
2315                 ast_log(LOG_ERROR, "%s requires a 4th argument (dialdata)\n", rapp);
2316                 goto done;
2317         }
2318
2319         if (sleepms < 1000)
2320                 sleepms = 10000;
2321
2322         if (!loops)
2323                 loops = -1; /* run forever */
2324
2325         ast_channel_lock(chan);
2326         context = pbx_builtin_getvar_helper(chan, "EXITCONTEXT");
2327         context = !ast_strlen_zero(context) ? ast_strdupa(context) : NULL;
2328         ast_channel_unlock(chan);
2329
2330         res = 0;
2331         while (loops) {
2332                 int continue_exec;
2333
2334                 chan->data = "Retrying";
2335                 if (ast_test_flag(chan, AST_FLAG_MOH))
2336                         ast_moh_stop(chan);
2337
2338                 res = dial_exec_full(chan, args.dialdata, &peerflags, &continue_exec);
2339                 if (continue_exec)
2340                         break;
2341
2342                 if (res == 0) {
2343                         if (ast_test_flag64(&peerflags, OPT_DTMF_EXIT)) {
2344                                 if (!ast_strlen_zero(args.announce)) {
2345                                         if (ast_fileexists(args.announce, NULL, chan->language) > 0) {
2346                                                 if (!(res = ast_streamfile(chan, args.announce, chan->language)))
2347                                                         ast_waitstream(chan, AST_DIGIT_ANY);
2348                                         } else
2349                                                 ast_log(LOG_WARNING, "Announce file \"%s\" specified in Retrydial does not exist\n", args.announce);
2350                                 }
2351                                 if (!res && sleepms) {
2352                                         if (!ast_test_flag(chan, AST_FLAG_MOH))
2353                                                 ast_moh_start(chan, NULL, NULL);
2354                                         res = ast_waitfordigit(chan, sleepms);
2355                                 }
2356                         } else {
2357                                 if (!ast_strlen_zero(args.announce)) {
2358                                         if (ast_fileexists(args.announce, NULL, chan->language) > 0) {
2359                                                 if (!(res = ast_streamfile(chan, args.announce, chan->language)))
2360                                                         res = ast_waitstream(chan, "");
2361                                         } else
2362                                                 ast_log(LOG_WARNING, "Announce file \"%s\" specified in Retrydial does not exist\n", args.announce);
2363                                 }
2364                                 if (sleepms) {
2365                                         if (!ast_test_flag(chan, AST_FLAG_MOH))
2366                                                 ast_moh_start(chan, NULL, NULL);
2367                                         if (!res)
2368                                                 res = ast_waitfordigit(chan, sleepms);
2369                                 }
2370                         }
2371                 }
2372
2373                 if (res < 0 || res == AST_PBX_INCOMPLETE) {
2374                         break;
2375                 } else if (res > 0) { /* Trying to send the call elsewhere (1 digit ext) */
2376                         if (onedigit_goto(chan, context, (char) res, 1)) {
2377                                 res = 0;
2378                                 break;
2379                         }
2380                 }
2381                 loops--;
2382         }
2383         if (loops == 0)
2384                 res = 0;
2385         else if (res == 1)
2386                 res = 0;
2387
2388         if (ast_test_flag(chan, AST_FLAG_MOH))
2389                 ast_moh_stop(chan);
2390  done:
2391         return res;
2392 }
2393
2394 static int unload_module(void)
2395 {
2396         int res;
2397         struct ast_context *con;
2398
2399         res = ast_unregister_application(app);
2400         res |= ast_unregister_application(rapp);
2401
2402         if ((con = ast_context_find("app_dial_gosub_virtual_context"))) {
2403                 ast_context_remove_extension2(con, "s", 1, NULL, 0);
2404                 ast_context_destroy(con, "app_dial"); /* leave nothing behind */
2405         }
2406
2407         return res;
2408 }
2409
2410 static int load_module(void)
2411 {
2412         int res;
2413         struct ast_context *con;
2414
2415         con = ast_context_find_or_create(NULL, NULL, "app_dial_gosub_virtual_context", "app_dial");
2416         if (!con)
2417                 ast_log(LOG_ERROR, "Dial virtual context 'app_dial_gosub_virtual_context' does not exist and unable to create\n");
2418         else
2419                 ast_add_extension2(con, 1, "s", 1, NULL, NULL, "KeepAlive", ast_strdup(""), ast_free_ptr, "app_dial");
2420
2421         res = ast_register_application_xml(app, dial_exec);
2422         res |= ast_register_application_xml(rapp, retrydial_exec);
2423
2424         return res;
2425 }
2426
2427 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Dialing Application");