Mostly cleanup of documentation to substitute the pipe with the comma, but a few...
[asterisk/asterisk.git] / apps / app_followme.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * A full-featured Find-Me/Follow-Me Application
5  * 
6  * Copyright (C) 2005-2006, BJ Weschke All Rights Reserved.
7  *
8  * BJ Weschke <bweschke@btwtech.com>
9  *
10  * This code is released by the author with no restrictions on usage.
11  *
12  * See http://www.asterisk.org for more information about
13  * the Asterisk project. Please do not directly contact
14  * any of the maintainers of this project for assistance;
15  * the project provides a web site, mailing lists and IRC
16  * channels for your use.
17  *
18  */
19
20 /*! \file
21  *
22  * \brief Find-Me Follow-Me application
23  *
24  * \author BJ Weschke <bweschke@btwtech.com>
25  *
26  * \arg See \ref Config_followme
27  *
28  * \ingroup applications
29  */
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <unistd.h>
38 #include <string.h>
39 #include <signal.h>
40
41 #include "asterisk/lock.h"
42 #include "asterisk/file.h"
43 #include "asterisk/logger.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/pbx.h"
46 #include "asterisk/options.h"
47 #include "asterisk/module.h"
48 #include "asterisk/translate.h"
49 #include "asterisk/say.h"
50 #include "asterisk/features.h"
51 #include "asterisk/musiconhold.h"
52 #include "asterisk/cli.h"
53 #include "asterisk/manager.h"
54 #include "asterisk/config.h"
55 #include "asterisk/monitor.h"
56 #include "asterisk/utils.h"
57 #include "asterisk/causes.h"
58 #include "asterisk/astdb.h"
59 #include "asterisk/app.h"
60
61 static char *app = "FollowMe";
62 static char *synopsis = "Find-Me/Follow-Me application";
63 static char *descrip = 
64 "  FollowMe(followmeid,options):\n"
65 "This application performs Find-Me/Follow-Me functionality for the caller\n"
66 "as defined in the profile matching the <followmeid> parameter in\n"
67 "followme.conf. If the specified <followmeid> profile doesn't exist in\n"
68 "followme.conf, execution will be returned to the dialplan and call\n"
69 "execution will continue at the next priority.\n\n"
70 "  Options:\n"
71 "    s    - Playback the incoming status message prior to starting the follow-me step(s)\n"
72 "    a    - Record the caller's name so it can be announced to the callee on each step\n" 
73 "    n    - Playback the unreachable status message if we've run out of steps to reach the\n"
74 "           or the callee has elected not to be reachable.\n"
75 "Returns -1 on hangup\n";
76
77 /*! \brief Number structure */
78 struct number {
79         char number[512];       /*!< Phone Number(s) and/or Extension(s) */
80         long timeout;           /*!< Dial Timeout, if used. */
81         int order;              /*!< The order to dial in */
82         AST_LIST_ENTRY(number) entry; /*!< Next Number record */
83 };
84
85 /*! \brief Data structure for followme scripts */
86 struct call_followme {
87         ast_mutex_t lock;
88         char name[AST_MAX_EXTENSION];   /*!< Name - FollowMeID */
89         char moh[AST_MAX_CONTEXT];      /*!< Music On Hold Class to be used */
90         char context[AST_MAX_CONTEXT];  /*!< Context to dial from */
91         unsigned int active;            /*!< Profile is active (1), or disabled (0). */
92         char takecall[20];              /*!< Digit mapping to take a call */
93         char nextindp[20];              /*!< Digit mapping to decline a call */
94         char callfromprompt[PATH_MAX];  /*!< Sound prompt name and path */
95         char norecordingprompt[PATH_MAX];       /*!< Sound prompt name and path */
96         char optionsprompt[PATH_MAX];   /*!< Sound prompt name and path */
97         char plsholdprompt[PATH_MAX];   /*!< Sound prompt name and path */
98         char statusprompt[PATH_MAX];    /*!< Sound prompt name and path */
99         char sorryprompt[PATH_MAX];     /*!< Sound prompt name and path */
100
101         AST_LIST_HEAD_NOLOCK(numbers, number) numbers;     /*!< Head of the list of follow-me numbers */
102         AST_LIST_HEAD_NOLOCK(blnumbers, number) blnumbers; /*!< Head of the list of black-listed numbers */
103         AST_LIST_HEAD_NOLOCK(wlnumbers, number) wlnumbers; /*!< Head of the list of white-listed numbers */
104         AST_LIST_ENTRY(call_followme) entry;           /*!< Next Follow-Me record */
105 };
106
107 struct fm_args {
108         struct ast_channel *chan;
109         char *mohclass;
110         AST_LIST_HEAD_NOLOCK(cnumbers, number) cnumbers;
111         int status;
112         char context[AST_MAX_CONTEXT];
113         char namerecloc[AST_MAX_CONTEXT];
114         struct ast_channel *outbound;
115         char takecall[20];              /*!< Digit mapping to take a call */
116         char nextindp[20];              /*!< Digit mapping to decline a call */
117         char callfromprompt[PATH_MAX];  /*!< Sound prompt name and path */
118         char norecordingprompt[PATH_MAX];       /*!< Sound prompt name and path */
119         char optionsprompt[PATH_MAX];   /*!< Sound prompt name and path */
120         char plsholdprompt[PATH_MAX];   /*!< Sound prompt name and path */
121         char statusprompt[PATH_MAX];    /*!< Sound prompt name and path */
122         char sorryprompt[PATH_MAX];     /*!< Sound prompt name and path */
123         struct ast_flags followmeflags;
124 };
125
126 struct findme_user {
127         struct ast_channel *ochan;
128         int state;
129         char dialarg[256];
130         char yn[10];
131         int ynidx; 
132         long digts;
133         int cleared;
134         AST_LIST_ENTRY(findme_user) entry;      
135 };
136
137 enum {
138         FOLLOWMEFLAG_STATUSMSG = (1 << 0),
139         FOLLOWMEFLAG_RECORDNAME = (1 << 1),
140         FOLLOWMEFLAG_UNREACHABLEMSG = (1 << 2)
141 };
142
143 AST_APP_OPTIONS(followme_opts, {
144         AST_APP_OPTION('s', FOLLOWMEFLAG_STATUSMSG ),
145         AST_APP_OPTION('a', FOLLOWMEFLAG_RECORDNAME ),
146         AST_APP_OPTION('n', FOLLOWMEFLAG_UNREACHABLEMSG ),
147 });
148
149 static int ynlongest = 0;
150 static time_t start_time, answer_time, end_time;
151
152 static const char *featuredigittostr;
153 static int featuredigittimeout = 5000;          /*!< Feature Digit Timeout */
154 static const char *defaultmoh = "default";      /*!< Default Music-On-Hold Class */
155
156 static char takecall[20] = "1", nextindp[20] = "2";
157 static char callfromprompt[PATH_MAX] = "followme/call-from";
158 static char norecordingprompt[PATH_MAX] = "followme/no-recording";
159 static char optionsprompt[PATH_MAX] = "followme/options";
160 static char plsholdprompt[PATH_MAX] = "followme/pls-hold-while-try";
161 static char statusprompt[PATH_MAX] = "followme/status";
162 static char sorryprompt[PATH_MAX] = "followme/sorry";
163
164
165 static AST_RWLIST_HEAD_STATIC(followmes, call_followme);
166 AST_LIST_HEAD_NOLOCK(findme_user_listptr, findme_user);
167
168 static void free_numbers(struct call_followme *f)
169 {
170         /* Free numbers attached to the profile */
171         struct number *prev;
172
173         while ((prev = AST_LIST_REMOVE_HEAD(&f->numbers, entry)))
174                 /* Free the number */
175                 ast_free(prev);
176         AST_LIST_HEAD_INIT_NOLOCK(&f->numbers);
177
178         while ((prev = AST_LIST_REMOVE_HEAD(&f->blnumbers, entry)))
179                 /* Free the blacklisted number */
180                 ast_free(prev);
181         AST_LIST_HEAD_INIT_NOLOCK(&f->blnumbers);
182
183         while ((prev = AST_LIST_REMOVE_HEAD(&f->wlnumbers, entry)))
184                 /* Free the whitelisted number */
185                 ast_free(prev);
186         AST_LIST_HEAD_INIT_NOLOCK(&f->wlnumbers);
187         
188 }
189
190
191 /*! \brief Allocate and initialize followme profile */
192 static struct call_followme *alloc_profile(const char *fmname)
193 {
194         struct call_followme *f;
195
196         if (!(f = ast_calloc(1, sizeof(*f))))
197                 return NULL;
198
199         ast_mutex_init(&f->lock);
200         ast_copy_string(f->name, fmname, sizeof(f->name));
201         f->moh[0] = '\0';
202         f->context[0] = '\0';
203         ast_copy_string(f->takecall, takecall, sizeof(f->takecall));
204         ast_copy_string(f->nextindp, nextindp, sizeof(f->nextindp));
205         ast_copy_string(f->callfromprompt, callfromprompt, sizeof(f->callfromprompt));
206         ast_copy_string(f->norecordingprompt, norecordingprompt, sizeof(f->norecordingprompt));
207         ast_copy_string(f->optionsprompt, optionsprompt, sizeof(f->optionsprompt));
208         ast_copy_string(f->plsholdprompt, plsholdprompt, sizeof(f->plsholdprompt));
209         ast_copy_string(f->statusprompt, statusprompt, sizeof(f->statusprompt));
210         ast_copy_string(f->sorryprompt, sorryprompt, sizeof(f->sorryprompt));
211         AST_LIST_HEAD_INIT_NOLOCK(&f->numbers);
212         AST_LIST_HEAD_INIT_NOLOCK(&f->blnumbers);
213         AST_LIST_HEAD_INIT_NOLOCK(&f->wlnumbers);
214         return f;
215 }
216
217 static void init_profile(struct call_followme *f)
218 {
219         f->active = 1;
220         ast_copy_string(f->moh, defaultmoh, sizeof(f->moh));
221 }
222
223    
224    
225 /*! \brief Set parameter in profile from configuration file */
226 static void profile_set_param(struct call_followme *f, const char *param, const char *val, int linenum, int failunknown)
227 {
228
229         if (!strcasecmp(param, "musicclass") || !strcasecmp(param, "musiconhold") || !strcasecmp(param, "music")) 
230                 ast_copy_string(f->moh, val, sizeof(f->moh));
231         else if (!strcasecmp(param, "context")) 
232                 ast_copy_string(f->context, val, sizeof(f->context));
233         else if (!strcasecmp(param, "takecall"))
234                 ast_copy_string(f->takecall, val, sizeof(f->takecall));
235         else if (!strcasecmp(param, "declinecall"))
236                 ast_copy_string(f->nextindp, val, sizeof(f->nextindp));
237         else if (!strcasecmp(param, "call-from-prompt"))
238                 ast_copy_string(f->callfromprompt, val, sizeof(f->callfromprompt));
239         else if (!strcasecmp(param, "followme-norecording-prompt")) 
240                 ast_copy_string(f->norecordingprompt, val, sizeof(f->norecordingprompt));
241         else if (!strcasecmp(param, "followme-options-prompt")) 
242                 ast_copy_string(f->optionsprompt, val, sizeof(f->optionsprompt));
243         else if (!strcasecmp(param, "followme-pls-hold-prompt"))
244                 ast_copy_string(f->plsholdprompt, val, sizeof(f->plsholdprompt));
245         else if (!strcasecmp(param, "followme-status-prompt")) 
246                 ast_copy_string(f->statusprompt, val, sizeof(f->statusprompt));
247         else if (!strcasecmp(param, "followme-sorry-prompt")) 
248                 ast_copy_string(f->sorryprompt, val, sizeof(f->sorryprompt));
249         else if (failunknown) {
250                 if (linenum >= 0)
251                         ast_log(LOG_WARNING, "Unknown keyword in profile '%s': %s at line %d of followme.conf\n", f->name, param, linenum);
252                 else
253                         ast_log(LOG_WARNING, "Unknown keyword in profile '%s': %s\n", f->name, param);
254         }
255 }
256
257 /*! \brief Add a new number */
258 static struct number *create_followme_number(char *number, int timeout, int numorder)
259 {
260         struct number *cur;
261         char *tmp;
262         
263
264         if (!(cur = ast_calloc(1, sizeof(*cur))))
265                 return NULL;
266
267         cur->timeout = timeout;
268         if ((tmp = strchr(number, ','))) 
269                 *tmp = '\0';
270         ast_copy_string(cur->number, number, sizeof(cur->number));
271         cur->order = numorder;
272         ast_debug(1, "Created a number, %s, order of , %d, with a timeout of %ld.\n", cur->number, cur->order, cur->timeout);
273
274         return cur;
275 }
276
277 /*! \brief Reload followme application module */
278 static int reload_followme(void)
279 {
280         struct call_followme *f;
281         struct ast_config *cfg;
282         char *cat = NULL, *tmp;
283         struct ast_variable *var;
284         struct number *cur, *nm;
285         char numberstr[90];
286         int timeout;
287         char *timeoutstr;
288         int numorder;   
289         const char *takecallstr;
290         const char *declinecallstr;
291         const char *tmpstr;
292
293         if (!(cfg = ast_config_load("followme.conf"))) {
294                 ast_log(LOG_WARNING, "No follow me config file (followme.conf), so no follow me\n");
295                 return 0;
296         }
297
298         AST_RWLIST_WRLOCK(&followmes);
299
300         /* Reset Global Var Values */
301         featuredigittimeout = 5000;
302
303         /* Mark all profiles as inactive for the moment */
304         AST_RWLIST_TRAVERSE(&followmes, f, entry) {
305                 f->active = 0;
306         }
307
308         featuredigittostr = ast_variable_retrieve(cfg, "general", "featuredigittimeout");
309         
310         if (!ast_strlen_zero(featuredigittostr)) {
311                 if (!sscanf(featuredigittostr, "%d", &featuredigittimeout))
312                         featuredigittimeout = 5000;
313         }
314
315         takecallstr = ast_variable_retrieve(cfg, "general", "takecall");
316         if (!ast_strlen_zero(takecallstr))
317                 ast_copy_string(takecall, takecallstr, sizeof(takecall));
318         
319         declinecallstr = ast_variable_retrieve(cfg, "general", "declinecall");
320         if (!ast_strlen_zero(declinecallstr))
321                 ast_copy_string(nextindp, declinecallstr, sizeof(nextindp));
322
323         tmpstr = ast_variable_retrieve(cfg, "general", "call-from-prompt");
324         if (!ast_strlen_zero(tmpstr))
325                 ast_copy_string(callfromprompt, tmpstr, sizeof(callfromprompt));
326
327         tmpstr = ast_variable_retrieve(cfg, "general", "norecording-prompt");
328         if (!ast_strlen_zero(tmpstr))
329                 ast_copy_string(norecordingprompt, tmpstr, sizeof(norecordingprompt));
330
331         tmpstr = ast_variable_retrieve(cfg, "general", "options-prompt");
332         if (!ast_strlen_zero(tmpstr))
333                 ast_copy_string(optionsprompt, tmpstr, sizeof(optionsprompt));
334
335         tmpstr = ast_variable_retrieve(cfg, "general", "pls-hold-prompt");
336         if (!ast_strlen_zero(tmpstr))
337                 ast_copy_string(plsholdprompt, tmpstr, sizeof(plsholdprompt));
338
339         tmpstr = ast_variable_retrieve(cfg, "general", "status-prompt");
340         if (!ast_strlen_zero(tmpstr))
341                 ast_copy_string(statusprompt, tmpstr, sizeof(statusprompt));
342
343         tmpstr = ast_variable_retrieve(cfg, "general", "sorry-prompt");
344         if (!ast_strlen_zero(tmpstr))
345                 ast_copy_string(sorryprompt, tmpstr, sizeof(sorryprompt));
346
347         /* Chug through config file */
348         while ((cat = ast_category_browse(cfg, cat))) {
349                 int new = 0;
350
351                 if (!strcasecmp(cat, "general"))
352                         continue;
353
354                 /* Look for an existing one */
355                 AST_LIST_TRAVERSE(&followmes, f, entry) {
356                         if (!strcasecmp(f->name, cat))
357                                 break;
358                 }
359
360                 ast_debug(1, "New profile %s.\n", cat);
361
362                 if (!f) {
363                         /* Make one then */
364                         f = alloc_profile(cat);
365                         new = 1;
366                 }
367
368                 /* Totally fail if we fail to find/create an entry */
369                 if (!f)
370                         continue;
371                 
372                 if (!new)
373                         ast_mutex_lock(&f->lock);
374                 /* Re-initialize the profile */
375                 init_profile(f);
376                 free_numbers(f);
377                 var = ast_variable_browse(cfg, cat);
378                 while(var) {
379                         if (!strcasecmp(var->name, "number")) {
380                                 int idx = 0;
381
382                                 /* Add a new number */
383                                 ast_copy_string(numberstr, var->value, sizeof(numberstr));
384                                 if ((tmp = strchr(numberstr, ','))) {
385                                         *tmp++ = '\0';
386                                         timeoutstr = ast_strdupa(tmp);
387                                         if ((tmp = strchr(timeoutstr, ','))) {
388                                                 *tmp++ = '\0';
389                                                 numorder = atoi(tmp);
390                                                 if (numorder < 0)
391                                                         numorder = 0;
392                                         } else 
393                                                 numorder = 0;
394                                         timeout = atoi(timeoutstr);
395                                         if (timeout < 0) 
396                                                 timeout = 25;
397                                 } else {
398                                         timeout = 25;
399                                         numorder = 0;
400                                 }
401                                 
402                                 if (!numorder) {        
403                                         idx = 1;
404                                         AST_LIST_TRAVERSE(&f->numbers, nm, entry) 
405                                                 idx++;
406                                         numorder = idx;
407                                 }
408                                 cur = create_followme_number(numberstr, timeout, numorder);
409                                 AST_LIST_INSERT_TAIL(&f->numbers, cur, entry);
410                         } else {
411                                 profile_set_param(f, var->name, var->value, var->lineno, 1);
412                                 ast_debug(2, "Logging parameter %s with value %s from lineno %d\n", var->name, var->value, var->lineno);
413                         }
414                         var = var->next;
415                 } /* End while(var) loop */
416                 
417                 if (!new) 
418                         ast_mutex_unlock(&f->lock);
419                 else
420                         AST_RWLIST_INSERT_HEAD(&followmes, f, entry);
421         }
422
423         ast_config_destroy(cfg);
424
425         AST_RWLIST_UNLOCK(&followmes);
426
427         return 1;
428 }
429
430 static void clear_caller(struct findme_user *tmpuser)
431 {
432         struct ast_channel *outbound;
433         
434         if (tmpuser && tmpuser->ochan && tmpuser->state >= 0) {
435                 outbound = tmpuser->ochan;
436                 if (!outbound->cdr) {
437                         outbound->cdr = ast_cdr_alloc();
438                         if (outbound->cdr)
439                                 ast_cdr_init(outbound->cdr, outbound);
440                 }
441                 if (outbound->cdr) {
442                         char tmp[256];
443
444                         snprintf(tmp, sizeof(tmp), "%s/%s", "Local", tmpuser->dialarg);
445                         ast_cdr_setapp(outbound->cdr, "FollowMe", tmp);
446                         ast_cdr_update(outbound);
447                         ast_cdr_start(outbound->cdr);
448                         ast_cdr_end(outbound->cdr);
449                         /* If the cause wasn't handled properly */
450                         if (ast_cdr_disposition(outbound->cdr, outbound->hangupcause))
451                                 ast_cdr_failed(outbound->cdr);
452                 } else
453                         ast_log(LOG_WARNING, "Unable to create Call Detail Record\n");
454                 ast_hangup(tmpuser->ochan);
455         }
456
457 }
458
459 static void clear_calling_tree(struct findme_user_listptr *findme_user_list) 
460 {
461         struct findme_user *tmpuser;
462         
463         AST_LIST_TRAVERSE(findme_user_list, tmpuser, entry) {
464                 clear_caller(tmpuser);
465                 tmpuser->cleared = 1;
466         }
467         
468 }
469
470
471
472 static struct ast_channel *wait_for_winner(struct findme_user_listptr *findme_user_list, struct number *nm, struct ast_channel *caller, char *namerecloc, int *status, struct fm_args *tpargs) 
473 {
474         struct ast_channel *watchers[256];
475         int pos;
476         struct ast_channel *winner;
477         struct ast_frame *f;
478         int ctstatus = 0;
479         int dg;
480         struct findme_user *tmpuser;
481         int to = 0;
482         int livechannels = 0;
483         int tmpto;
484         long totalwait = 0, wtd = 0, towas = 0;
485         char *callfromname;
486         char *pressbuttonname;
487
488         /* ------------ wait_for_winner_channel start --------------- */ 
489
490         callfromname = ast_strdupa(tpargs->callfromprompt);
491         pressbuttonname = ast_strdupa(tpargs->optionsprompt);   
492
493         if (AST_LIST_EMPTY(findme_user_list)) {
494                 ast_verb(3, "couldn't reach at this number.\n");
495                 return NULL;
496         }
497         
498         if (!caller) {
499                 ast_verb(3, "Original caller hungup. Cleanup.\n");
500                 clear_calling_tree(findme_user_list);
501                 return NULL;
502         }
503         
504         totalwait = nm->timeout * 1000;
505         
506         while (!ctstatus) {
507                 to = 1000;
508                 pos = 1; 
509                 livechannels = 0;
510                 watchers[0] = caller;
511                 
512                 dg = 0; 
513                 winner = NULL;  
514                 AST_LIST_TRAVERSE(findme_user_list, tmpuser, entry) {
515                         if (tmpuser->state >= 0 && tmpuser->ochan) {
516                                 if (tmpuser->state == 3) 
517                                         tmpuser->digts += (towas - wtd);
518                                 if (tmpuser->digts && (tmpuser->digts > featuredigittimeout)) {
519                                         ast_verb(3, "We've been waiting for digits longer than we should have.\n");
520                                         if (!ast_strlen_zero(namerecloc)) {
521                                                 tmpuser->state = 1;
522                                                 tmpuser->digts = 0;
523                                                 if (!ast_streamfile(tmpuser->ochan, callfromname, tmpuser->ochan->language)) {
524                                                         ast_sched_runq(tmpuser->ochan->sched);
525                                                 } else {
526                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", callfromname);
527                                                         return NULL;
528                                                 }                                                       
529                                         } else {
530                                                 tmpuser->state = 2;
531                                                 tmpuser->digts = 0;
532                                                 if (!ast_streamfile(tmpuser->ochan, tpargs->norecordingprompt, tmpuser->ochan->language))
533                                                         ast_sched_runq(tmpuser->ochan->sched);
534                                                 else {
535                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", tpargs->norecordingprompt);
536                                                         return NULL;
537                                                 }
538                                         }
539                                 }
540                                 if (tmpuser->ochan->stream) {
541                                         ast_sched_runq(tmpuser->ochan->sched);
542                                         tmpto = ast_sched_wait(tmpuser->ochan->sched);
543                                         if (tmpto > 0 && tmpto < to)
544                                                 to = tmpto;
545                                         else if (tmpto < 0 && !tmpuser->ochan->timingfunc) {
546                                                 ast_stopstream(tmpuser->ochan);
547                                                 if (tmpuser->state == 1) {
548                                                         ast_verb(3, "Playback of the call-from file appears to be done.\n");
549                                                         if (!ast_streamfile(tmpuser->ochan, namerecloc, tmpuser->ochan->language)) {
550                                                                 tmpuser->state = 2;
551                                                         } else {
552                                                                 ast_log(LOG_NOTICE, "Unable to playback %s. Maybe the caller didn't record their name?\n", namerecloc);
553                                                                 memset(tmpuser->yn, 0, sizeof(tmpuser->yn));
554                                                                 tmpuser->ynidx = 0;
555                                                                 if (!ast_streamfile(tmpuser->ochan, pressbuttonname, tmpuser->ochan->language))
556                                                                         tmpuser->state = 3;
557                                                                 else {
558                                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", pressbuttonname);
559                                                                         return NULL;
560                                                                 } 
561                                                         }
562                                                 } else if (tmpuser->state == 2) {
563                                                         ast_verb(3, "Playback of name file appears to be done.\n");
564                                                         memset(tmpuser->yn, 0, sizeof(tmpuser->yn));
565                                                         tmpuser->ynidx = 0;
566                                                         if (!ast_streamfile(tmpuser->ochan, pressbuttonname, tmpuser->ochan->language)) {
567                                                                 tmpuser->state = 3;
568                                                                 
569                                                         } else {
570                                                                 return NULL;
571                                                         } 
572                                                 } else if (tmpuser->state == 3) {
573                                                         ast_verb(3, "Playback of the next step file appears to be done.\n");
574                                                         tmpuser->digts = 0;
575                                                 }
576                                         }
577                                 }
578                                 watchers[pos++] = tmpuser->ochan;
579                                 livechannels++;
580                         }
581                 }
582                 
583                 tmpto = to;
584                 if (to < 0) {
585                         to = 1000;
586                         tmpto = 1000;
587                 }
588                 towas = to;
589                 winner = ast_waitfor_n(watchers, pos, &to);
590                 tmpto -= to;
591                 totalwait -= tmpto;
592                 wtd = to;       
593                 if (totalwait <= 0) {
594                         ast_verb(3, "We've hit our timeout for this step. Drop everyone and move on to the next one. %ld\n", totalwait);
595                         clear_calling_tree(findme_user_list);
596                         return NULL;
597                 }
598                 if (winner) {
599                         /* Need to find out which channel this is */
600                         dg = 0;
601                         while ((winner != watchers[dg]) && (dg < 256))
602                                 dg++;
603                         AST_LIST_TRAVERSE(findme_user_list, tmpuser, entry)
604                                 if (tmpuser->ochan == winner)
605                                         break;
606                         f = ast_read(winner);
607                         if (f) {
608                                 if (f->frametype == AST_FRAME_CONTROL) {
609                                         switch(f->subclass) {
610                                         case AST_CONTROL_HANGUP:
611                                                 if (option_verbose > 2)
612                                                         ast_verb(3, "%s received a hangup frame.\n", winner->name);
613                                                 if (dg == 0) {
614                                                         ast_verb(3, "The calling channel hungup. Need to drop everyone else.\n");
615                                                         clear_calling_tree(findme_user_list);
616                                                         ctstatus = -1;
617                                                 }
618                                                 break;
619                                         case AST_CONTROL_ANSWER:
620                                                 if (option_verbose > 2)
621                                                         ast_verb(3, "%s answered %s\n", winner->name, caller->name);
622                                                 /* If call has been answered, then the eventual hangup is likely to be normal hangup */ 
623                                                 winner->hangupcause = AST_CAUSE_NORMAL_CLEARING;
624                                                 caller->hangupcause = AST_CAUSE_NORMAL_CLEARING;
625                                                 ast_verb(3, "Starting playback of %s\n", callfromname);
626                                                 if (dg > 0) {
627                                                         if (!ast_strlen_zero(namerecloc)) {
628                                                                 if (!ast_streamfile(winner, callfromname, winner->language)) {
629                                                                         ast_sched_runq(winner->sched);
630                                                                         tmpuser->state = 1;
631                                                                 } else {
632                                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", callfromname);
633                                                                         ast_frfree(f);
634                                                                         return NULL;
635                                                                 }                               
636                                                         } else {                        
637                                                                 tmpuser->state = 2;
638                                                                 if (!ast_streamfile(tmpuser->ochan, tpargs->norecordingprompt, tmpuser->ochan->language))
639                                                                         ast_sched_runq(tmpuser->ochan->sched);
640                                                                 else {
641                                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", tpargs->norecordingprompt);
642                                                                         ast_frfree(f);
643                                                                         return NULL;
644                                                                 }
645                                                         }
646                                                 }
647                                                 break;
648                                         case AST_CONTROL_BUSY:
649                                                 ast_verb(3, "%s is busy\n", winner->name);
650                                                 break;
651                                         case AST_CONTROL_CONGESTION:
652                                                 ast_verb(3, "%s is circuit-busy\n", winner->name);
653                                                 break;
654                                         case AST_CONTROL_RINGING:
655                                                 ast_verb(3, "%s is ringing\n", winner->name);
656                                                 break;
657                                         case AST_CONTROL_PROGRESS:
658                                                 ast_verb(3, "%s is making progress passing it to %s\n", winner->name, caller->name);
659                                                 break;
660                                         case AST_CONTROL_VIDUPDATE:
661                                                 ast_verb(3, "%s requested a video update, passing it to %s\n", winner->name, caller->name);
662                                                 break;
663                                         case AST_CONTROL_PROCEEDING:
664                                                 ast_verb(3, "%s is proceeding passing it to %s\n", winner->name,caller->name);
665                                                 break;
666                                         case AST_CONTROL_HOLD:
667                                                 ast_verb(3, "Call on %s placed on hold\n", winner->name);
668                                                 break;
669                                         case AST_CONTROL_UNHOLD:
670                                                 ast_verb(3, "Call on %s left from hold\n", winner->name);
671                                                 break;
672                                         case AST_CONTROL_OFFHOOK:
673                                         case AST_CONTROL_FLASH:
674                                                 /* Ignore going off hook and flash */
675                                                 break;
676                                         case -1:
677                                                 ast_verb(3, "%s stopped sounds\n", winner->name);
678                                                 break;
679                                         default:
680                                                 ast_debug(1, "Dunno what to do with control type %d\n", f->subclass);
681                                                 break;
682                                         }
683                                 } 
684                                 if (tmpuser && tmpuser->state == 3 && f->frametype == AST_FRAME_DTMF) {
685                                         if (winner->stream)
686                                                 ast_stopstream(winner);
687                                         tmpuser->digts = 0;
688                                         ast_debug(1, "DTMF received: %c\n",(char) f->subclass);
689                                         tmpuser->yn[tmpuser->ynidx] = (char) f->subclass;
690                                         tmpuser->ynidx++;
691                                         ast_debug(1, "DTMF string: %s\n", tmpuser->yn);
692                                         if (tmpuser->ynidx >= ynlongest) {
693                                                 ast_debug(1, "reached longest possible match - doing evals\n");
694                                                 if (!strcmp(tmpuser->yn, tpargs->takecall)) {
695                                                         ast_debug(1, "Match to take the call!\n");
696                                                         ast_frfree(f);
697                                                         return tmpuser->ochan;  
698                                                 }
699                                                 if (!strcmp(tmpuser->yn, tpargs->nextindp)) {
700                                                         ast_debug(1, "Next in dial plan step requested.\n");
701                                                         *status = 1;
702                                                         ast_frfree(f);
703                                                         return NULL;
704                                                 }       
705                                                 
706                                         }
707                                 }
708                                 
709                                 ast_frfree(f);
710                         } else {
711                                 if (winner) {
712                                         ast_debug(1, "we didn't get a frame. hanging up. dg is %d\n",dg);                                             
713                                         if (!dg) {
714                                                 clear_calling_tree(findme_user_list);
715                                                 return NULL;
716                                         } else {
717                                                 tmpuser->state = -1;
718                                                 ast_hangup(winner);  
719                                                 livechannels--;
720                                                 ast_debug(1, "live channels left %d\n", livechannels);
721                                                 if (!livechannels) {
722                                                         ast_verb(3, "no live channels left. exiting.\n");
723                                                         return NULL;
724                                                 }
725                                         }
726                                 }
727                         }                                       
728                         
729                 } else
730                         ast_debug(1, "timed out waiting for action\n");
731         }
732         
733         /* --- WAIT FOR WINNER NUMBER END! -----------*/
734         return NULL;
735 }
736
737 static void findmeexec(struct fm_args *tpargs)
738 {
739         struct number *nm;
740         struct ast_channel *outbound;
741         struct ast_channel *caller;
742         struct ast_channel *winner = NULL;
743         char dialarg[512];
744         int dg, idx;
745         char *rest, *number;
746         struct findme_user *tmpuser;
747         struct findme_user *fmuser;
748         struct findme_user *headuser;
749         struct findme_user_listptr *findme_user_list;
750         int status;
751
752         findme_user_list = ast_calloc(1, sizeof(*findme_user_list));            
753         AST_LIST_HEAD_INIT_NOLOCK(findme_user_list);
754
755         /* We're going to figure out what the longest possible string of digits to collect is */
756         ynlongest = 0;
757         if (strlen(tpargs->takecall) > ynlongest)
758                 ynlongest = strlen(tpargs->takecall);
759         if (strlen(tpargs->nextindp) > ynlongest)
760                 ynlongest = strlen(tpargs->nextindp);
761
762         idx = 1;
763         caller = tpargs->chan;
764         AST_LIST_TRAVERSE(&tpargs->cnumbers, nm, entry)
765                 if (nm->order == idx)
766                         break;
767
768         while (nm) {
769
770                 ast_debug(2, "Number %s timeout %ld\n", nm->number,nm->timeout);
771                 time(&start_time);
772
773                 number = ast_strdupa(nm->number);
774                 ast_debug(3, "examining %s\n", number);
775                 do {
776                         rest = strchr(number, '&');
777                         if (rest) {
778                                 *rest = 0;
779                                 rest++;
780                         }
781
782                         if (!strcmp(tpargs->context, ""))
783                                 sprintf(dialarg, "%s", number);
784                         else
785                                 sprintf(dialarg, "%s@%s", number, tpargs->context);
786                                         
787                         tmpuser = ast_calloc(1, sizeof(*tmpuser));
788                         if (!tmpuser) {
789                                 ast_log(LOG_WARNING, "Out of memory!\n");
790                                 ast_free(findme_user_list);
791                                 return;
792                         }
793                                         
794                         outbound = ast_request("Local", ast_best_codec(caller->nativeformats), dialarg, &dg);
795                         if (outbound) {
796                                 ast_set_callerid(outbound, caller->cid.cid_num, caller->cid.cid_name, caller->cid.cid_num);
797                                 ast_channel_inherit_variables(tpargs->chan, outbound);
798                                 ast_verb(3, "calling %s\n", dialarg);
799                                 if (!ast_call(outbound,dialarg,0)) {
800                                         tmpuser->ochan = outbound;
801                                         tmpuser->state = 0;
802                                         tmpuser->cleared = 0;
803                                         ast_copy_string(tmpuser->dialarg, dialarg, sizeof(dialarg));
804                                         AST_LIST_INSERT_TAIL(findme_user_list, tmpuser, entry);
805                                 } else {
806                                         ast_verb(3, "couldn't reach at this number.\n"); 
807                                         if (outbound) {
808                                                 if (!outbound->cdr) 
809                                                         outbound->cdr = ast_cdr_alloc();
810                                                 if (outbound->cdr) {
811                                                         char tmp[256];
812
813                                                         ast_cdr_init(outbound->cdr, outbound);
814                                                         snprintf(tmp, sizeof(tmp), "%s/%s", "Local", dialarg);
815                                                         ast_cdr_setapp(outbound->cdr, "FollowMe", tmp);
816                                                         ast_cdr_update(outbound);
817                                                         ast_cdr_start(outbound->cdr);
818                                                         ast_cdr_end(outbound->cdr);
819                                                         /* If the cause wasn't handled properly */
820                                                         if (ast_cdr_disposition(outbound->cdr,outbound->hangupcause))
821                                                                 ast_cdr_failed(outbound->cdr);
822                                                 } else {
823                                                         ast_log(LOG_ERROR, "Unable to create Call Detail Record\n");
824                                                         ast_hangup(outbound);
825                                                         outbound = NULL;
826                                                 }
827                                         }
828                                                 
829                                 }
830                         } else 
831                                 ast_log(LOG_WARNING, "Unable to allocate a channel for Local/%s cause: %s\n", dialarg, ast_cause2str(dg));
832                                         
833                         number = rest;
834                 } while (number);
835                                 
836                 status = 0;     
837                 if (!AST_LIST_EMPTY(findme_user_list))
838                         winner = wait_for_winner(findme_user_list, nm, caller, tpargs->namerecloc, &status, tpargs);
839                 
840                                         
841                 AST_LIST_TRAVERSE_SAFE_BEGIN(findme_user_list, fmuser, entry) {
842                         if (!fmuser->cleared && fmuser->ochan != winner)
843                                 clear_caller(fmuser);
844                         AST_LIST_REMOVE_CURRENT(findme_user_list, entry);
845                         ast_free(fmuser);
846                 }
847                 AST_LIST_TRAVERSE_SAFE_END
848                 fmuser = NULL;
849                 tmpuser = NULL;
850                 headuser = NULL;        
851                 if (winner)
852                         break;
853
854                 if (!caller) {
855                         tpargs->status = 1;
856                         ast_free(findme_user_list);
857                         return; 
858                 }
859
860                 idx++;
861                 AST_LIST_TRAVERSE(&tpargs->cnumbers, nm, entry)
862                         if (nm->order == idx)
863                                 break;
864
865         }
866         ast_free(findme_user_list);
867         if (!winner) 
868                 tpargs->status = 1;
869         else {
870                 tpargs->status = 100;
871                 tpargs->outbound = winner;
872         }
873
874         
875         return;
876                 
877 }
878
879 static int app_exec(struct ast_channel *chan, void *data)
880 {
881         struct fm_args targs;
882         struct ast_bridge_config config;
883         struct call_followme *f;
884         struct number *nm, *newnm;
885         int res = 0;
886         char *argstr;
887         char namerecloc[255];
888         int duration = 0;
889         struct ast_channel *caller;
890         struct ast_channel *outbound;
891         static char toast[80];
892         
893         AST_DECLARE_APP_ARGS(args,
894                 AST_APP_ARG(followmeid);
895                 AST_APP_ARG(options);
896         );
897
898         if (ast_strlen_zero(data)) {
899                 ast_log(LOG_WARNING, "%s requires an argument (followmeid)\n", app);
900                 return -1;
901         }
902         
903         if (!(argstr = ast_strdupa((char *)data))) {
904                 ast_log(LOG_ERROR, "Out of memory!\n");
905                 return -1;
906         }
907
908         AST_STANDARD_APP_ARGS(args, argstr);
909
910         if (ast_strlen_zero(args.followmeid)) {
911                 ast_log(LOG_WARNING, "%s requires an argument (followmeid)\n", app);
912                 return -1;
913         }
914
915         AST_RWLIST_RDLOCK(&followmes);
916         AST_RWLIST_TRAVERSE(&followmes, f, entry) {
917                 if (!strcasecmp(f->name, args.followmeid) && (f->active))
918                         break;
919         }
920         AST_RWLIST_UNLOCK(&followmes);
921         
922         ast_debug(1, "New profile %s.\n", args.followmeid);
923
924         if (!f) {
925                 ast_log(LOG_WARNING, "Profile requested, %s, not found in the configuration.\n", args.followmeid);
926                 return 0;
927         }
928
929         /* XXX TODO: Reinsert the db check value to see whether or not follow-me is on or off */
930         if (args.options) 
931                 ast_app_parse_options(followme_opts, &targs.followmeflags, NULL, args.options);
932         
933         /* Lock the profile lock and copy out everything we need to run with before unlocking it again */
934         ast_mutex_lock(&f->lock);
935         targs.mohclass = ast_strdupa(f->moh);
936         ast_copy_string(targs.context, f->context, sizeof(targs.context));
937         ast_copy_string(targs.takecall, f->takecall, sizeof(targs.takecall));
938         ast_copy_string(targs.nextindp, f->nextindp, sizeof(targs.nextindp));
939         ast_copy_string(targs.callfromprompt, f->callfromprompt, sizeof(targs.callfromprompt));
940         ast_copy_string(targs.norecordingprompt, f->norecordingprompt, sizeof(targs.norecordingprompt));
941         ast_copy_string(targs.optionsprompt, f->optionsprompt, sizeof(targs.optionsprompt));
942         ast_copy_string(targs.plsholdprompt, f->plsholdprompt, sizeof(targs.plsholdprompt));
943         ast_copy_string(targs.statusprompt, f->statusprompt, sizeof(targs.statusprompt));
944         ast_copy_string(targs.sorryprompt, f->sorryprompt, sizeof(targs.sorryprompt));
945         /* Copy the numbers we're going to use into another list in case the master list should get modified 
946            (and locked) while we're trying to do a follow-me */
947         AST_LIST_HEAD_INIT_NOLOCK(&targs.cnumbers);
948         AST_LIST_TRAVERSE(&f->numbers, nm, entry) {
949                 newnm = create_followme_number(nm->number, nm->timeout, nm->order);
950                 AST_LIST_INSERT_TAIL(&targs.cnumbers, newnm, entry);
951         }
952         ast_mutex_unlock(&f->lock);
953         
954         if (ast_test_flag(&targs.followmeflags, FOLLOWMEFLAG_STATUSMSG)) 
955                 ast_stream_and_wait(chan, targs.statusprompt, "");
956         
957         snprintf(namerecloc,sizeof(namerecloc),"%s/followme.%s",ast_config_AST_SPOOL_DIR,chan->uniqueid);
958         duration = 5;
959         
960         if (ast_test_flag(&targs.followmeflags, FOLLOWMEFLAG_RECORDNAME)) 
961                 if (ast_play_and_record(chan, "vm-rec-name", namerecloc, 5, "sln", &duration, 128, 0, NULL) < 0)
962                         goto outrun;
963         
964         /* The following call looks like we're going to playback the file, but we're actually   */
965         /* just checking to see if we *can* play it.                                            */
966         if (ast_streamfile(chan, namerecloc, chan->language))
967                 ast_copy_string(namerecloc, "", sizeof(namerecloc));                                    
968         else
969                 ast_stopstream(chan);
970         
971         if (ast_streamfile(chan, targs.plsholdprompt, chan->language))
972                 goto outrun;
973         if (ast_waitstream(chan, "") < 0)
974                 goto outrun;
975         ast_moh_start(chan, S_OR(targs.mohclass, NULL), NULL);
976         
977         targs.status = 0;
978         targs.chan = chan;
979         ast_copy_string(targs.namerecloc, namerecloc, sizeof(targs.namerecloc));
980         
981         findmeexec(&targs);             
982         
983         AST_LIST_TRAVERSE_SAFE_BEGIN(&targs.cnumbers, nm, entry) {
984                 AST_LIST_REMOVE_CURRENT(&targs.cnumbers, entry);
985                 ast_free(nm);
986         }
987         AST_LIST_TRAVERSE_SAFE_END
988                 
989         if (!ast_strlen_zero(namerecloc))
990                 unlink(namerecloc);     
991         
992         if (targs.status != 100) {
993                 ast_moh_stop(chan);
994                 if (ast_test_flag(&targs.followmeflags, FOLLOWMEFLAG_UNREACHABLEMSG)) 
995                         ast_stream_and_wait(chan, targs.sorryprompt, "");
996                 res = 0;
997         } else {
998                 caller = chan;
999                 outbound = targs.outbound;
1000                 /* Bridge the two channels. */
1001                 
1002                 memset(&config,0,sizeof(struct ast_bridge_config));
1003                 ast_set_flag(&(config.features_callee), AST_FEATURE_REDIRECT);
1004                 ast_set_flag(&(config.features_callee), AST_FEATURE_AUTOMON);
1005                 ast_set_flag(&(config.features_caller), AST_FEATURE_AUTOMON);
1006                 
1007                 ast_moh_stop(caller);
1008                 /* Be sure no generators are left on it */
1009                 ast_deactivate_generator(caller);
1010                 /* Make sure channels are compatible */
1011                 res = ast_channel_make_compatible(caller, outbound);
1012                 if (res < 0) {
1013                         ast_log(LOG_WARNING, "Had to drop call because I couldn't make %s compatible with %s\n", caller->name, outbound->name);
1014                         ast_hangup(outbound);
1015                         goto outrun;
1016                 }
1017                 time(&answer_time);
1018                 res = ast_bridge_call(caller,outbound,&config);
1019                 time(&end_time);
1020                 snprintf(toast, sizeof(toast), "%ld", (long)(end_time - start_time));
1021                 pbx_builtin_setvar_helper(caller, "DIALEDTIME", toast);
1022                 snprintf(toast, sizeof(toast), "%ld", (long)(end_time - answer_time));
1023                 pbx_builtin_setvar_helper(caller, "ANSWEREDTIME", toast);
1024                 if (outbound)
1025                         ast_hangup(outbound);
1026                 res = 1;
1027         }
1028
1029         outrun:
1030         
1031         return res;
1032 }
1033
1034 static int unload_module(void)
1035 {
1036         struct call_followme *f;
1037
1038         ast_unregister_application(app);
1039
1040         /* Free Memory. Yeah! I'm free! */
1041         AST_RWLIST_WRLOCK(&followmes);
1042         while ((f = AST_RWLIST_REMOVE_HEAD(&followmes, entry))) {
1043                 free_numbers(f);
1044                 ast_free(f);
1045         }
1046
1047         AST_RWLIST_UNLOCK(&followmes);
1048
1049         return 0;
1050 }
1051
1052 static int load_module(void)
1053 {
1054         if(!reload_followme())
1055                 return AST_MODULE_LOAD_DECLINE;
1056
1057         return ast_register_application(app, app_exec, synopsis, descrip);
1058 }
1059
1060 static int reload(void)
1061 {
1062         reload_followme();
1063
1064         return 0;       
1065 }
1066
1067 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Find-Me/Follow-Me Application",
1068                 .load = load_module,
1069                 .unload = unload_module,
1070                 .reload = reload,
1071                );