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