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