improve linked-list macros in two ways:
[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(int reload)
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         struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
293
294         if (!(cfg = ast_config_load("followme.conf", config_flags))) {
295                 ast_log(LOG_WARNING, "No follow me config file (followme.conf), so no follow me\n");
296                 return 0;
297         } else if (cfg == CONFIG_STATUS_FILEUNCHANGED)
298                 return 0;
299
300         AST_RWLIST_WRLOCK(&followmes);
301
302         /* Reset Global Var Values */
303         featuredigittimeout = 5000;
304
305         /* Mark all profiles as inactive for the moment */
306         AST_RWLIST_TRAVERSE(&followmes, f, entry) {
307                 f->active = 0;
308         }
309
310         featuredigittostr = ast_variable_retrieve(cfg, "general", "featuredigittimeout");
311         
312         if (!ast_strlen_zero(featuredigittostr)) {
313                 if (!sscanf(featuredigittostr, "%d", &featuredigittimeout))
314                         featuredigittimeout = 5000;
315         }
316
317         takecallstr = ast_variable_retrieve(cfg, "general", "takecall");
318         if (!ast_strlen_zero(takecallstr))
319                 ast_copy_string(takecall, takecallstr, sizeof(takecall));
320         
321         declinecallstr = ast_variable_retrieve(cfg, "general", "declinecall");
322         if (!ast_strlen_zero(declinecallstr))
323                 ast_copy_string(nextindp, declinecallstr, sizeof(nextindp));
324
325         tmpstr = ast_variable_retrieve(cfg, "general", "call-from-prompt");
326         if (!ast_strlen_zero(tmpstr))
327                 ast_copy_string(callfromprompt, tmpstr, sizeof(callfromprompt));
328
329         tmpstr = ast_variable_retrieve(cfg, "general", "norecording-prompt");
330         if (!ast_strlen_zero(tmpstr))
331                 ast_copy_string(norecordingprompt, tmpstr, sizeof(norecordingprompt));
332
333         tmpstr = ast_variable_retrieve(cfg, "general", "options-prompt");
334         if (!ast_strlen_zero(tmpstr))
335                 ast_copy_string(optionsprompt, tmpstr, sizeof(optionsprompt));
336
337         tmpstr = ast_variable_retrieve(cfg, "general", "pls-hold-prompt");
338         if (!ast_strlen_zero(tmpstr))
339                 ast_copy_string(plsholdprompt, tmpstr, sizeof(plsholdprompt));
340
341         tmpstr = ast_variable_retrieve(cfg, "general", "status-prompt");
342         if (!ast_strlen_zero(tmpstr))
343                 ast_copy_string(statusprompt, tmpstr, sizeof(statusprompt));
344
345         tmpstr = ast_variable_retrieve(cfg, "general", "sorry-prompt");
346         if (!ast_strlen_zero(tmpstr))
347                 ast_copy_string(sorryprompt, tmpstr, sizeof(sorryprompt));
348
349         /* Chug through config file */
350         while ((cat = ast_category_browse(cfg, cat))) {
351                 int new = 0;
352
353                 if (!strcasecmp(cat, "general"))
354                         continue;
355
356                 /* Look for an existing one */
357                 AST_LIST_TRAVERSE(&followmes, f, entry) {
358                         if (!strcasecmp(f->name, cat))
359                                 break;
360                 }
361
362                 ast_debug(1, "New profile %s.\n", cat);
363
364                 if (!f) {
365                         /* Make one then */
366                         f = alloc_profile(cat);
367                         new = 1;
368                 }
369
370                 /* Totally fail if we fail to find/create an entry */
371                 if (!f)
372                         continue;
373                 
374                 if (!new)
375                         ast_mutex_lock(&f->lock);
376                 /* Re-initialize the profile */
377                 init_profile(f);
378                 free_numbers(f);
379                 var = ast_variable_browse(cfg, cat);
380                 while(var) {
381                         if (!strcasecmp(var->name, "number")) {
382                                 int idx = 0;
383
384                                 /* Add a new number */
385                                 ast_copy_string(numberstr, var->value, sizeof(numberstr));
386                                 if ((tmp = strchr(numberstr, ','))) {
387                                         *tmp++ = '\0';
388                                         timeoutstr = ast_strdupa(tmp);
389                                         if ((tmp = strchr(timeoutstr, ','))) {
390                                                 *tmp++ = '\0';
391                                                 numorder = atoi(tmp);
392                                                 if (numorder < 0)
393                                                         numorder = 0;
394                                         } else 
395                                                 numorder = 0;
396                                         timeout = atoi(timeoutstr);
397                                         if (timeout < 0) 
398                                                 timeout = 25;
399                                 } else {
400                                         timeout = 25;
401                                         numorder = 0;
402                                 }
403                                 
404                                 if (!numorder) {        
405                                         idx = 1;
406                                         AST_LIST_TRAVERSE(&f->numbers, nm, entry) 
407                                                 idx++;
408                                         numorder = idx;
409                                 }
410                                 cur = create_followme_number(numberstr, timeout, numorder);
411                                 AST_LIST_INSERT_TAIL(&f->numbers, cur, entry);
412                         } else {
413                                 profile_set_param(f, var->name, var->value, var->lineno, 1);
414                                 ast_debug(2, "Logging parameter %s with value %s from lineno %d\n", var->name, var->value, var->lineno);
415                         }
416                         var = var->next;
417                 } /* End while(var) loop */
418                 
419                 if (!new) 
420                         ast_mutex_unlock(&f->lock);
421                 else
422                         AST_RWLIST_INSERT_HEAD(&followmes, f, entry);
423         }
424
425         ast_config_destroy(cfg);
426
427         AST_RWLIST_UNLOCK(&followmes);
428
429         return 1;
430 }
431
432 static void clear_caller(struct findme_user *tmpuser)
433 {
434         struct ast_channel *outbound;
435         
436         if (tmpuser && tmpuser->ochan && tmpuser->state >= 0) {
437                 outbound = tmpuser->ochan;
438                 if (!outbound->cdr) {
439                         outbound->cdr = ast_cdr_alloc();
440                         if (outbound->cdr)
441                                 ast_cdr_init(outbound->cdr, outbound);
442                 }
443                 if (outbound->cdr) {
444                         char tmp[256];
445
446                         snprintf(tmp, sizeof(tmp), "%s/%s", "Local", tmpuser->dialarg);
447                         ast_cdr_setapp(outbound->cdr, "FollowMe", tmp);
448                         ast_cdr_update(outbound);
449                         ast_cdr_start(outbound->cdr);
450                         ast_cdr_end(outbound->cdr);
451                         /* If the cause wasn't handled properly */
452                         if (ast_cdr_disposition(outbound->cdr, outbound->hangupcause))
453                                 ast_cdr_failed(outbound->cdr);
454                 } else
455                         ast_log(LOG_WARNING, "Unable to create Call Detail Record\n");
456                 ast_hangup(tmpuser->ochan);
457         }
458
459 }
460
461 static void clear_calling_tree(struct findme_user_listptr *findme_user_list) 
462 {
463         struct findme_user *tmpuser;
464         
465         AST_LIST_TRAVERSE(findme_user_list, tmpuser, entry) {
466                 clear_caller(tmpuser);
467                 tmpuser->cleared = 1;
468         }
469         
470 }
471
472
473
474 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) 
475 {
476         struct ast_channel *watchers[256];
477         int pos;
478         struct ast_channel *winner;
479         struct ast_frame *f;
480         int ctstatus = 0;
481         int dg;
482         struct findme_user *tmpuser;
483         int to = 0;
484         int livechannels = 0;
485         int tmpto;
486         long totalwait = 0, wtd = 0, towas = 0;
487         char *callfromname;
488         char *pressbuttonname;
489
490         /* ------------ wait_for_winner_channel start --------------- */ 
491
492         callfromname = ast_strdupa(tpargs->callfromprompt);
493         pressbuttonname = ast_strdupa(tpargs->optionsprompt);   
494
495         if (AST_LIST_EMPTY(findme_user_list)) {
496                 ast_verb(3, "couldn't reach at this number.\n");
497                 return NULL;
498         }
499         
500         if (!caller) {
501                 ast_verb(3, "Original caller hungup. Cleanup.\n");
502                 clear_calling_tree(findme_user_list);
503                 return NULL;
504         }
505         
506         totalwait = nm->timeout * 1000;
507         
508         while (!ctstatus) {
509                 to = 1000;
510                 pos = 1; 
511                 livechannels = 0;
512                 watchers[0] = caller;
513                 
514                 dg = 0; 
515                 winner = NULL;  
516                 AST_LIST_TRAVERSE(findme_user_list, tmpuser, entry) {
517                         if (tmpuser->state >= 0 && tmpuser->ochan) {
518                                 if (tmpuser->state == 3) 
519                                         tmpuser->digts += (towas - wtd);
520                                 if (tmpuser->digts && (tmpuser->digts > featuredigittimeout)) {
521                                         ast_verb(3, "We've been waiting for digits longer than we should have.\n");
522                                         if (!ast_strlen_zero(namerecloc)) {
523                                                 tmpuser->state = 1;
524                                                 tmpuser->digts = 0;
525                                                 if (!ast_streamfile(tmpuser->ochan, callfromname, tmpuser->ochan->language)) {
526                                                         ast_sched_runq(tmpuser->ochan->sched);
527                                                 } else {
528                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", callfromname);
529                                                         return NULL;
530                                                 }                                                       
531                                         } else {
532                                                 tmpuser->state = 2;
533                                                 tmpuser->digts = 0;
534                                                 if (!ast_streamfile(tmpuser->ochan, tpargs->norecordingprompt, tmpuser->ochan->language))
535                                                         ast_sched_runq(tmpuser->ochan->sched);
536                                                 else {
537                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", tpargs->norecordingprompt);
538                                                         return NULL;
539                                                 }
540                                         }
541                                 }
542                                 if (tmpuser->ochan->stream) {
543                                         ast_sched_runq(tmpuser->ochan->sched);
544                                         tmpto = ast_sched_wait(tmpuser->ochan->sched);
545                                         if (tmpto > 0 && tmpto < to)
546                                                 to = tmpto;
547                                         else if (tmpto < 0 && !tmpuser->ochan->timingfunc) {
548                                                 ast_stopstream(tmpuser->ochan);
549                                                 if (tmpuser->state == 1) {
550                                                         ast_verb(3, "Playback of the call-from file appears to be done.\n");
551                                                         if (!ast_streamfile(tmpuser->ochan, namerecloc, tmpuser->ochan->language)) {
552                                                                 tmpuser->state = 2;
553                                                         } else {
554                                                                 ast_log(LOG_NOTICE, "Unable to playback %s. Maybe the caller didn't record their name?\n", namerecloc);
555                                                                 memset(tmpuser->yn, 0, sizeof(tmpuser->yn));
556                                                                 tmpuser->ynidx = 0;
557                                                                 if (!ast_streamfile(tmpuser->ochan, pressbuttonname, tmpuser->ochan->language))
558                                                                         tmpuser->state = 3;
559                                                                 else {
560                                                                         ast_log(LOG_WARNING, "Unable to playback %s.\n", pressbuttonname);
561                                                                         return NULL;
562                                                                 } 
563                                                         }
564                                                 } else if (tmpuser->state == 2) {
565                                                         ast_verb(3, "Playback of name file appears to be done.\n");
566                                                         memset(tmpuser->yn, 0, sizeof(tmpuser->yn));
567                                                         tmpuser->ynidx = 0;
568                                                         if (!ast_streamfile(tmpuser->ochan, pressbuttonname, tmpuser->ochan->language)) {
569                                                                 tmpuser->state = 3;
570                                                                 
571                                                         } else {
572                                                                 return NULL;
573                                                         } 
574                                                 } else if (tmpuser->state == 3) {
575                                                         ast_verb(3, "Playback of the next step file appears to be done.\n");
576                                                         tmpuser->digts = 0;
577                                                 }
578                                         }
579                                 }
580                                 watchers[pos++] = tmpuser->ochan;
581                                 livechannels++;
582                         }
583                 }
584                 
585                 tmpto = to;
586                 if (to < 0) {
587                         to = 1000;
588                         tmpto = 1000;
589                 }
590                 towas = to;
591                 winner = ast_waitfor_n(watchers, pos, &to);
592                 tmpto -= to;
593                 totalwait -= tmpto;
594                 wtd = to;       
595                 if (totalwait <= 0) {
596                         ast_verb(3, "We've hit our timeout for this step. Drop everyone and move on to the next one. %ld\n", totalwait);
597                         clear_calling_tree(findme_user_list);
598                         return NULL;
599                 }
600                 if (winner) {
601                         /* Need to find out which channel this is */
602                         dg = 0;
603                         while ((winner != watchers[dg]) && (dg < 256))
604                                 dg++;
605                         AST_LIST_TRAVERSE(findme_user_list, tmpuser, entry)
606                                 if (tmpuser->ochan == winner)
607                                         break;
608                         f = ast_read(winner);
609                         if (f) {
610                                 if (f->frametype == AST_FRAME_CONTROL) {
611                                         switch(f->subclass) {
612                                         case AST_CONTROL_HANGUP:
613                                                 if (option_verbose > 2)
614                                                         ast_verb(3, "%s received a hangup frame.\n", winner->name);
615                                                 if (dg == 0) {
616                                                         ast_verb(3, "The calling channel hungup. Need to drop everyone else.\n");
617                                                         clear_calling_tree(findme_user_list);
618                                                         ctstatus = -1;
619                                                 }
620                                                 break;
621                                         case AST_CONTROL_ANSWER:
622                                                 if (option_verbose > 2)
623                                                         ast_verb(3, "%s answered %s\n", winner->name, caller->name);
624                                                 /* If call has been answered, then the eventual hangup is likely to be normal hangup */ 
625                                                 winner->hangupcause = AST_CAUSE_NORMAL_CLEARING;
626                                                 caller->hangupcause = AST_CAUSE_NORMAL_CLEARING;
627                                                 ast_verb(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                                                 ast_verb(3, "%s is busy\n", winner->name);
652                                                 break;
653                                         case AST_CONTROL_CONGESTION:
654                                                 ast_verb(3, "%s is circuit-busy\n", winner->name);
655                                                 break;
656                                         case AST_CONTROL_RINGING:
657                                                 ast_verb(3, "%s is ringing\n", winner->name);
658                                                 break;
659                                         case AST_CONTROL_PROGRESS:
660                                                 ast_verb(3, "%s is making progress passing it to %s\n", winner->name, caller->name);
661                                                 break;
662                                         case AST_CONTROL_VIDUPDATE:
663                                                 ast_verb(3, "%s requested a video update, passing it to %s\n", winner->name, caller->name);
664                                                 break;
665                                         case AST_CONTROL_PROCEEDING:
666                                                 ast_verb(3, "%s is proceeding passing it to %s\n", winner->name,caller->name);
667                                                 break;
668                                         case AST_CONTROL_HOLD:
669                                                 ast_verb(3, "Call on %s placed on hold\n", winner->name);
670                                                 break;
671                                         case AST_CONTROL_UNHOLD:
672                                                 ast_verb(3, "Call on %s left from hold\n", winner->name);
673                                                 break;
674                                         case AST_CONTROL_OFFHOOK:
675                                         case AST_CONTROL_FLASH:
676                                                 /* Ignore going off hook and flash */
677                                                 break;
678                                         case -1:
679                                                 ast_verb(3, "%s stopped sounds\n", winner->name);
680                                                 break;
681                                         default:
682                                                 ast_debug(1, "Dunno what to do with control type %d\n", f->subclass);
683                                                 break;
684                                         }
685                                 } 
686                                 if (tmpuser && tmpuser->state == 3 && f->frametype == AST_FRAME_DTMF) {
687                                         if (winner->stream)
688                                                 ast_stopstream(winner);
689                                         tmpuser->digts = 0;
690                                         ast_debug(1, "DTMF received: %c\n",(char) f->subclass);
691                                         tmpuser->yn[tmpuser->ynidx] = (char) f->subclass;
692                                         tmpuser->ynidx++;
693                                         ast_debug(1, "DTMF string: %s\n", tmpuser->yn);
694                                         if (tmpuser->ynidx >= ynlongest) {
695                                                 ast_debug(1, "reached longest possible match - doing evals\n");
696                                                 if (!strcmp(tmpuser->yn, tpargs->takecall)) {
697                                                         ast_debug(1, "Match to take the call!\n");
698                                                         ast_frfree(f);
699                                                         return tmpuser->ochan;  
700                                                 }
701                                                 if (!strcmp(tmpuser->yn, tpargs->nextindp)) {
702                                                         ast_debug(1, "Next in dial plan step requested.\n");
703                                                         *status = 1;
704                                                         ast_frfree(f);
705                                                         return NULL;
706                                                 }       
707                                                 
708                                         }
709                                 }
710                                 
711                                 ast_frfree(f);
712                         } else {
713                                 if (winner) {
714                                         ast_debug(1, "we didn't get a frame. hanging up. dg is %d\n",dg);                                             
715                                         if (!dg) {
716                                                 clear_calling_tree(findme_user_list);
717                                                 return NULL;
718                                         } else {
719                                                 tmpuser->state = -1;
720                                                 ast_hangup(winner);  
721                                                 livechannels--;
722                                                 ast_debug(1, "live channels left %d\n", livechannels);
723                                                 if (!livechannels) {
724                                                         ast_verb(3, "no live channels left. exiting.\n");
725                                                         return NULL;
726                                                 }
727                                         }
728                                 }
729                         }                                       
730                         
731                 } else
732                         ast_debug(1, "timed out waiting for action\n");
733         }
734         
735         /* --- WAIT FOR WINNER NUMBER END! -----------*/
736         return NULL;
737 }
738
739 static void findmeexec(struct fm_args *tpargs)
740 {
741         struct number *nm;
742         struct ast_channel *outbound;
743         struct ast_channel *caller;
744         struct ast_channel *winner = NULL;
745         char dialarg[512];
746         int dg, idx;
747         char *rest, *number;
748         struct findme_user *tmpuser;
749         struct findme_user *fmuser;
750         struct findme_user *headuser;
751         struct findme_user_listptr *findme_user_list;
752         int status;
753
754         findme_user_list = ast_calloc(1, sizeof(*findme_user_list));            
755         AST_LIST_HEAD_INIT_NOLOCK(findme_user_list);
756
757         /* We're going to figure out what the longest possible string of digits to collect is */
758         ynlongest = 0;
759         if (strlen(tpargs->takecall) > ynlongest)
760                 ynlongest = strlen(tpargs->takecall);
761         if (strlen(tpargs->nextindp) > ynlongest)
762                 ynlongest = strlen(tpargs->nextindp);
763
764         idx = 1;
765         caller = tpargs->chan;
766         AST_LIST_TRAVERSE(&tpargs->cnumbers, nm, entry)
767                 if (nm->order == idx)
768                         break;
769
770         while (nm) {
771
772                 ast_debug(2, "Number %s timeout %ld\n", nm->number,nm->timeout);
773                 time(&start_time);
774
775                 number = ast_strdupa(nm->number);
776                 ast_debug(3, "examining %s\n", number);
777                 do {
778                         rest = strchr(number, '&');
779                         if (rest) {
780                                 *rest = 0;
781                                 rest++;
782                         }
783
784                         if (!strcmp(tpargs->context, ""))
785                                 sprintf(dialarg, "%s", number);
786                         else
787                                 sprintf(dialarg, "%s@%s", number, tpargs->context);
788                                         
789                         tmpuser = ast_calloc(1, sizeof(*tmpuser));
790                         if (!tmpuser) {
791                                 ast_log(LOG_WARNING, "Out of memory!\n");
792                                 ast_free(findme_user_list);
793                                 return;
794                         }
795                                         
796                         outbound = ast_request("Local", ast_best_codec(caller->nativeformats), dialarg, &dg);
797                         if (outbound) {
798                                 ast_set_callerid(outbound, caller->cid.cid_num, caller->cid.cid_name, caller->cid.cid_num);
799                                 ast_channel_inherit_variables(tpargs->chan, outbound);
800                                 ast_verb(3, "calling %s\n", dialarg);
801                                 if (!ast_call(outbound,dialarg,0)) {
802                                         tmpuser->ochan = outbound;
803                                         tmpuser->state = 0;
804                                         tmpuser->cleared = 0;
805                                         ast_copy_string(tmpuser->dialarg, dialarg, sizeof(dialarg));
806                                         AST_LIST_INSERT_TAIL(findme_user_list, tmpuser, entry);
807                                 } else {
808                                         ast_verb(3, "couldn't reach at this number.\n"); 
809                                         if (outbound) {
810                                                 if (!outbound->cdr) 
811                                                         outbound->cdr = ast_cdr_alloc();
812                                                 if (outbound->cdr) {
813                                                         char tmp[256];
814
815                                                         ast_cdr_init(outbound->cdr, outbound);
816                                                         snprintf(tmp, sizeof(tmp), "%s/%s", "Local", dialarg);
817                                                         ast_cdr_setapp(outbound->cdr, "FollowMe", tmp);
818                                                         ast_cdr_update(outbound);
819                                                         ast_cdr_start(outbound->cdr);
820                                                         ast_cdr_end(outbound->cdr);
821                                                         /* If the cause wasn't handled properly */
822                                                         if (ast_cdr_disposition(outbound->cdr,outbound->hangupcause))
823                                                                 ast_cdr_failed(outbound->cdr);
824                                                 } else {
825                                                         ast_log(LOG_ERROR, "Unable to create Call Detail Record\n");
826                                                         ast_hangup(outbound);
827                                                         outbound = NULL;
828                                                 }
829                                         }
830                                                 
831                                 }
832                         } else 
833                                 ast_log(LOG_WARNING, "Unable to allocate a channel for Local/%s cause: %s\n", dialarg, ast_cause2str(dg));
834                                         
835                         number = rest;
836                 } while (number);
837                                 
838                 status = 0;     
839                 if (!AST_LIST_EMPTY(findme_user_list))
840                         winner = wait_for_winner(findme_user_list, nm, caller, tpargs->namerecloc, &status, tpargs);
841                 
842                                         
843                 while ((fmuser = AST_LIST_REMOVE_HEAD(findme_user_list, entry))) {
844                         if (!fmuser->cleared && fmuser->ochan != winner)
845                                 clear_caller(fmuser);
846                         ast_free(fmuser);
847                 }
848
849                 fmuser = NULL;
850                 tmpuser = NULL;
851                 headuser = NULL;        
852                 if (winner)
853                         break;
854
855                 if (!caller) {
856                         tpargs->status = 1;
857                         ast_free(findme_user_list);
858                         return; 
859                 }
860
861                 idx++;
862                 AST_LIST_TRAVERSE(&tpargs->cnumbers, nm, entry)
863                         if (nm->order == idx)
864                                 break;
865
866         }
867         ast_free(findme_user_list);
868         if (!winner) 
869                 tpargs->status = 1;
870         else {
871                 tpargs->status = 100;
872                 tpargs->outbound = winner;
873         }
874
875         
876         return;
877                 
878 }
879
880 static int app_exec(struct ast_channel *chan, void *data)
881 {
882         struct fm_args targs;
883         struct ast_bridge_config config;
884         struct call_followme *f;
885         struct number *nm, *newnm;
886         int res = 0;
887         char *argstr;
888         char namerecloc[255];
889         int duration = 0;
890         struct ast_channel *caller;
891         struct ast_channel *outbound;
892         static char toast[80];
893         
894         AST_DECLARE_APP_ARGS(args,
895                 AST_APP_ARG(followmeid);
896                 AST_APP_ARG(options);
897         );
898
899         if (ast_strlen_zero(data)) {
900                 ast_log(LOG_WARNING, "%s requires an argument (followmeid)\n", app);
901                 return -1;
902         }
903         
904         if (!(argstr = ast_strdupa((char *)data))) {
905                 ast_log(LOG_ERROR, "Out of memory!\n");
906                 return -1;
907         }
908
909         AST_STANDARD_APP_ARGS(args, argstr);
910
911         if (ast_strlen_zero(args.followmeid)) {
912                 ast_log(LOG_WARNING, "%s requires an argument (followmeid)\n", app);
913                 return -1;
914         }
915
916         AST_RWLIST_RDLOCK(&followmes);
917         AST_RWLIST_TRAVERSE(&followmes, f, entry) {
918                 if (!strcasecmp(f->name, args.followmeid) && (f->active))
919                         break;
920         }
921         AST_RWLIST_UNLOCK(&followmes);
922         
923         ast_debug(1, "New profile %s.\n", args.followmeid);
924
925         if (!f) {
926                 ast_log(LOG_WARNING, "Profile requested, %s, not found in the configuration.\n", args.followmeid);
927                 return 0;
928         }
929
930         /* XXX TODO: Reinsert the db check value to see whether or not follow-me is on or off */
931         if (args.options) 
932                 ast_app_parse_options(followme_opts, &targs.followmeflags, NULL, args.options);
933         
934         /* Lock the profile lock and copy out everything we need to run with before unlocking it again */
935         ast_mutex_lock(&f->lock);
936         targs.mohclass = ast_strdupa(f->moh);
937         ast_copy_string(targs.context, f->context, sizeof(targs.context));
938         ast_copy_string(targs.takecall, f->takecall, sizeof(targs.takecall));
939         ast_copy_string(targs.nextindp, f->nextindp, sizeof(targs.nextindp));
940         ast_copy_string(targs.callfromprompt, f->callfromprompt, sizeof(targs.callfromprompt));
941         ast_copy_string(targs.norecordingprompt, f->norecordingprompt, sizeof(targs.norecordingprompt));
942         ast_copy_string(targs.optionsprompt, f->optionsprompt, sizeof(targs.optionsprompt));
943         ast_copy_string(targs.plsholdprompt, f->plsholdprompt, sizeof(targs.plsholdprompt));
944         ast_copy_string(targs.statusprompt, f->statusprompt, sizeof(targs.statusprompt));
945         ast_copy_string(targs.sorryprompt, f->sorryprompt, sizeof(targs.sorryprompt));
946         /* Copy the numbers we're going to use into another list in case the master list should get modified 
947            (and locked) while we're trying to do a follow-me */
948         AST_LIST_HEAD_INIT_NOLOCK(&targs.cnumbers);
949         AST_LIST_TRAVERSE(&f->numbers, nm, entry) {
950                 newnm = create_followme_number(nm->number, nm->timeout, nm->order);
951                 AST_LIST_INSERT_TAIL(&targs.cnumbers, newnm, entry);
952         }
953         ast_mutex_unlock(&f->lock);
954         
955         if (ast_test_flag(&targs.followmeflags, FOLLOWMEFLAG_STATUSMSG)) 
956                 ast_stream_and_wait(chan, targs.statusprompt, "");
957         
958         snprintf(namerecloc,sizeof(namerecloc),"%s/followme.%s",ast_config_AST_SPOOL_DIR,chan->uniqueid);
959         duration = 5;
960         
961         if (ast_test_flag(&targs.followmeflags, FOLLOWMEFLAG_RECORDNAME)) 
962                 if (ast_play_and_record(chan, "vm-rec-name", namerecloc, 5, "sln", &duration, 128, 0, NULL) < 0)
963                         goto outrun;
964         
965         if (!ast_fileexists(namerecloc, NULL, chan->language))
966                 ast_copy_string(namerecloc, "", sizeof(namerecloc));                                    
967         
968         if (ast_streamfile(chan, targs.plsholdprompt, chan->language))
969                 goto outrun;
970         if (ast_waitstream(chan, "") < 0)
971                 goto outrun;
972         ast_moh_start(chan, S_OR(targs.mohclass, NULL), NULL);
973         
974         targs.status = 0;
975         targs.chan = chan;
976         ast_copy_string(targs.namerecloc, namerecloc, sizeof(targs.namerecloc));
977         
978         findmeexec(&targs);             
979         
980         while ((nm = AST_LIST_REMOVE_HEAD(&targs.cnumbers, entry)))
981                 ast_free(nm);
982                 
983         if (!ast_strlen_zero(namerecloc))
984                 unlink(namerecloc);     
985         
986         if (targs.status != 100) {
987                 ast_moh_stop(chan);
988                 if (ast_test_flag(&targs.followmeflags, FOLLOWMEFLAG_UNREACHABLEMSG)) 
989                         ast_stream_and_wait(chan, targs.sorryprompt, "");
990                 res = 0;
991         } else {
992                 caller = chan;
993                 outbound = targs.outbound;
994                 /* Bridge the two channels. */
995                 
996                 memset(&config,0,sizeof(struct ast_bridge_config));
997                 ast_set_flag(&(config.features_callee), AST_FEATURE_REDIRECT);
998                 ast_set_flag(&(config.features_callee), AST_FEATURE_AUTOMON);
999                 ast_set_flag(&(config.features_caller), AST_FEATURE_AUTOMON);
1000                 
1001                 ast_moh_stop(caller);
1002                 /* Be sure no generators are left on it */
1003                 ast_deactivate_generator(caller);
1004                 /* Make sure channels are compatible */
1005                 res = ast_channel_make_compatible(caller, outbound);
1006                 if (res < 0) {
1007                         ast_log(LOG_WARNING, "Had to drop call because I couldn't make %s compatible with %s\n", caller->name, outbound->name);
1008                         ast_hangup(outbound);
1009                         goto outrun;
1010                 }
1011                 time(&answer_time);
1012                 res = ast_bridge_call(caller,outbound,&config);
1013                 time(&end_time);
1014                 snprintf(toast, sizeof(toast), "%ld", (long)(end_time - start_time));
1015                 pbx_builtin_setvar_helper(caller, "DIALEDTIME", toast);
1016                 snprintf(toast, sizeof(toast), "%ld", (long)(end_time - answer_time));
1017                 pbx_builtin_setvar_helper(caller, "ANSWEREDTIME", toast);
1018                 if (outbound)
1019                         ast_hangup(outbound);
1020                 res = 1;
1021         }
1022
1023         outrun:
1024         
1025         return res;
1026 }
1027
1028 static int unload_module(void)
1029 {
1030         struct call_followme *f;
1031
1032         ast_unregister_application(app);
1033
1034         /* Free Memory. Yeah! I'm free! */
1035         AST_RWLIST_WRLOCK(&followmes);
1036         while ((f = AST_RWLIST_REMOVE_HEAD(&followmes, entry))) {
1037                 free_numbers(f);
1038                 ast_free(f);
1039         }
1040
1041         AST_RWLIST_UNLOCK(&followmes);
1042
1043         return 0;
1044 }
1045
1046 static int load_module(void)
1047 {
1048         if(!reload_followme(0))
1049                 return AST_MODULE_LOAD_DECLINE;
1050
1051         return ast_register_application(app, app_exec, synopsis, descrip);
1052 }
1053
1054 static int reload(void)
1055 {
1056         reload_followme(1);
1057
1058         return 0;       
1059 }
1060
1061 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Find-Me/Follow-Me Application",
1062                 .load = load_module,
1063                 .unload = unload_module,
1064                 .reload = reload,
1065                );