Merge "core: Fix unused variable error in handle_show_sysinfo."
[asterisk/asterisk.git] / pbx / pbx_spool.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2010, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Full-featured outgoing call spool support
22  * 
23  */
24
25 /*** MODULEINFO
26         <support_level>core</support_level>
27  ***/
28
29 #include "asterisk.h"
30
31 #include <sys/stat.h>
32 #include <time.h>
33 #include <utime.h>
34 #include <dirent.h>
35 #ifdef HAVE_INOTIFY
36 #include <sys/inotify.h>
37 #elif defined(HAVE_KQUEUE)
38 #include <sys/types.h>
39 #include <sys/time.h>
40 #include <sys/event.h>
41 #include <fcntl.h>
42 #endif
43
44 #include "asterisk/paths.h"     /* use ast_config_AST_SPOOL_DIR */
45 #include "asterisk/lock.h"
46 #include "asterisk/file.h"
47 #include "asterisk/logger.h"
48 #include "asterisk/channel.h"
49 #include "asterisk/callerid.h"
50 #include "asterisk/pbx.h"
51 #include "asterisk/module.h"
52 #include "asterisk/utils.h"
53 #include "asterisk/options.h"
54 #include "asterisk/format.h"
55 #include "asterisk/format_cache.h"
56
57 /*
58  * pbx_spool is similar in spirit to qcall, but with substantially enhanced functionality...
59  * The spool file contains a header 
60  */
61
62 enum {
63         /*! Always delete the call file after a call succeeds or the
64          * maximum number of retries is exceeded, even if the
65          * modification time of the call file is in the future.
66          */
67         SPOOL_FLAG_ALWAYS_DELETE = (1 << 0),
68         /* Don't unlink the call file after processing, move in qdonedir */
69         SPOOL_FLAG_ARCHIVE = (1 << 1),
70         /* Connect the channel with the outgoing extension once early media is received */
71         SPOOL_FLAG_EARLY_MEDIA = (1 << 2),
72 };
73
74 static char qdir[255];
75 static char qdonedir[255];
76
77 struct outgoing {
78         int retries;                              /*!< Current number of retries */
79         int maxretries;                           /*!< Maximum number of retries permitted */
80         int retrytime;                            /*!< How long to wait between retries (in seconds) */
81         int waittime;                             /*!< How long to wait for an answer */
82         long callingpid;                          /*!< PID which is currently calling */
83         struct ast_format_cap *capabilities;                 /*!< Formats (codecs) for this call */
84         AST_DECLARE_STRING_FIELDS (
85                 AST_STRING_FIELD(fn);                 /*!< File name of call file */
86                 AST_STRING_FIELD(tech);               /*!< Which channel technology to use for outgoing call */
87                 AST_STRING_FIELD(dest);               /*!< Which device/line to use for outgoing call */
88                 AST_STRING_FIELD(app);                /*!< If application: Application name */
89                 AST_STRING_FIELD(data);               /*!< If application: Application data */
90                 AST_STRING_FIELD(exten);              /*!< If extension/context/priority: Extension in dialplan */
91                 AST_STRING_FIELD(context);            /*!< If extension/context/priority: Dialplan context */
92                 AST_STRING_FIELD(cid_num);            /*!< CallerID Information: Number/extension */
93                 AST_STRING_FIELD(cid_name);           /*!< CallerID Information: Name */
94                 AST_STRING_FIELD(account);            /*!< account code */
95         );
96         int priority;                             /*!< If extension/context/priority: Dialplan priority */
97         struct ast_variable *vars;                /*!< Variables and Functions */
98         int maxlen;                               /*!< Maximum length of call */
99         struct ast_flags options;                 /*!< options */
100 };
101
102 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
103 struct direntry {
104         AST_LIST_ENTRY(direntry) list;
105         time_t mtime;
106         char name[0];
107 };
108
109 static AST_LIST_HEAD_STATIC(dirlist, direntry);
110
111 static void queue_file(const char *filename, time_t when);
112 #endif
113
114 static void free_outgoing(struct outgoing *o)
115 {
116         if (o->vars) {
117                 ast_variables_destroy(o->vars);
118         }
119         ao2_cleanup(o->capabilities);
120         ast_string_field_free_memory(o);
121         ast_free(o);
122 }
123
124 static struct outgoing *new_outgoing(const char *fn)
125 {
126         struct outgoing *o;
127
128         o = ast_calloc(1, sizeof(*o));
129         if (!o) {
130                 return NULL;
131         }
132
133         /* Initialize the new object. */
134         o->priority = 1;
135         o->retrytime = 300;
136         o->waittime = 45;
137         ast_set_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE);
138         if (ast_string_field_init(o, 128)) {
139                 /*
140                  * No need to call free_outgoing here since the failure was to
141                  * allocate string fields and no variables have been allocated
142                  * yet.
143                  */
144                 ast_free(o);
145                 return NULL;
146         }
147         ast_string_field_set(o, fn, fn);
148         if (ast_strlen_zero(o->fn)) {
149                 /* String field set failed.  Since this string is important we must fail. */
150                 free_outgoing(o);
151                 return NULL;
152         }
153
154         o->capabilities = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
155         if (!o->capabilities) {
156                 free_outgoing(o);
157                 return NULL;
158         }
159         ast_format_cap_append(o->capabilities, ast_format_slin, 0);
160
161         return o;
162 }
163
164 static void append_variable(struct outgoing *o, const char *name, const char *value)
165 {
166         struct ast_variable *var = ast_variable_new(name, value, o->fn);
167
168         if (!var) {
169                 return;
170         }
171
172         /* Always insert at the end, because some people want to treat the spool
173          * file as a script */
174         ast_variable_list_append(&o->vars, var);
175 }
176
177 static void parse_line(char *line, unsigned int lineno, struct outgoing *o)
178 {
179         char *c;
180
181         /* Trim comments */
182         c = line;
183         while ((c = strchr(c, '#'))) {
184                 if ((c == line) || (*(c-1) == ' ') || (*(c-1) == '\t')) {
185                         *c = '\0';
186                         break;
187                 }
188                 c++;
189         }
190
191         c = line;
192         while ((c = strchr(c, ';'))) {
193                 if ((c > line) && (c[-1] == '\\')) {
194                         memmove(c - 1, c, strlen(c) + 1);
195                 } else {
196                         *c = '\0';
197                         break;
198                 }
199         }
200
201         /* Trim trailing white space */
202         ast_trim_blanks(line);
203         if (ast_strlen_zero(line)) {
204                 return;
205         }
206         c = strchr(line, ':');
207         if (!c) {
208                 ast_log(LOG_NOTICE, "Syntax error at line %d of %s\n", lineno, o->fn);
209                 return;
210         }
211         *c = '\0';
212         c = ast_skip_blanks(c + 1);
213 #if 0
214         printf("'%s' is '%s' at line %d\n", line, c, lineno);
215 #endif
216         if (!strcasecmp(line, "channel")) {
217                 char *c2;
218                 if ((c2 = strchr(c, '/'))) {
219                         *c2 = '\0';
220                         c2++;
221                         ast_string_field_set(o, tech, c);
222                         ast_string_field_set(o, dest, c2);
223                 } else {
224                         ast_log(LOG_NOTICE, "Channel should be in form Tech/Dest at line %d of %s\n", lineno, o->fn);
225                 }
226         } else if (!strcasecmp(line, "callerid")) {
227                 char cid_name[80] = {0}, cid_num[80] = {0};
228                 ast_callerid_split(c, cid_name, sizeof(cid_name), cid_num, sizeof(cid_num));
229                 ast_string_field_set(o, cid_num, cid_num);
230                 ast_string_field_set(o, cid_name, cid_name);
231         } else if (!strcasecmp(line, "application")) {
232                 ast_string_field_set(o, app, c);
233         } else if (!strcasecmp(line, "data")) {
234                 ast_string_field_set(o, data, c);
235         } else if (!strcasecmp(line, "maxretries")) {
236                 if (sscanf(c, "%30d", &o->maxretries) != 1) {
237                         ast_log(LOG_WARNING, "Invalid max retries at line %d of %s\n", lineno, o->fn);
238                         o->maxretries = 0;
239                 }
240         } else if (!strcasecmp(line, "codecs")) {
241                 ast_format_cap_update_by_allow_disallow(o->capabilities, c, 1);
242         } else if (!strcasecmp(line, "context")) {
243                 ast_string_field_set(o, context, c);
244         } else if (!strcasecmp(line, "extension")) {
245                 ast_string_field_set(o, exten, c);
246         } else if (!strcasecmp(line, "priority")) {
247                 if ((sscanf(c, "%30d", &o->priority) != 1) || (o->priority < 1)) {
248                         ast_log(LOG_WARNING, "Invalid priority at line %d of %s\n", lineno, o->fn);
249                         o->priority = 1;
250                 }
251         } else if (!strcasecmp(line, "retrytime")) {
252                 if ((sscanf(c, "%30d", &o->retrytime) != 1) || (o->retrytime < 1)) {
253                         ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, o->fn);
254                         o->retrytime = 300;
255                 }
256         } else if (!strcasecmp(line, "waittime")) {
257                 if ((sscanf(c, "%30d", &o->waittime) != 1) || (o->waittime < 1)) {
258                         ast_log(LOG_WARNING, "Invalid waittime at line %d of %s\n", lineno, o->fn);
259                         o->waittime = 45;
260                 }
261         } else if (!strcasecmp(line, "retry")) {
262                 o->retries++;
263         } else if (!strcasecmp(line, "startretry")) {
264                 if (sscanf(c, "%30ld", &o->callingpid) != 1) {
265                         ast_log(LOG_WARNING, "Unable to retrieve calling PID!\n");
266                         o->callingpid = 0;
267                 }
268         } else if (!strcasecmp(line, "endretry") || !strcasecmp(line, "abortretry")) {
269                 o->callingpid = 0;
270                 o->retries++;
271         } else if (!strcasecmp(line, "delayedretry")) {
272         } else if (!strcasecmp(line, "setvar") || !strcasecmp(line, "set")) {
273                 char *c2 = c;
274
275                 strsep(&c2, "=");
276                 if (c2) {
277                         append_variable(o, c, c2);
278                 } else {
279                         ast_log(LOG_WARNING, "Malformed \"%s\" argument.  Should be \"%s: variable=value\"\n", line, line);
280                 }
281         } else if (!strcasecmp(line, "account")) {
282                 ast_string_field_set(o, account, c);
283         } else if (!strcasecmp(line, "alwaysdelete")) {
284                 ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ALWAYS_DELETE);
285         } else if (!strcasecmp(line, "archive")) {
286                 ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ARCHIVE);
287         } else if (!strcasecmp(line, "early_media")) {
288                 ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_EARLY_MEDIA);
289         } else {
290                 ast_log(LOG_WARNING, "Unknown keyword '%s' at line %d of %s\n", line, lineno, o->fn);
291         }
292 }
293
294 #define LINE_BUFFER_SIZE 1024
295
296 static int apply_outgoing(struct outgoing *o, FILE *f)
297 {
298         char buf[LINE_BUFFER_SIZE];
299         unsigned int lineno = 0;
300
301         while (fgets(buf, sizeof(buf), f)) {
302                 size_t len = strlen(buf);
303
304                 lineno++;
305
306                 if (buf[len - 1] == '\n' || feof(f)) {
307                         /* We have a line, parse it */
308                         parse_line(buf, lineno, o);
309                         continue;
310                 }
311
312                 /* Crazy long line, skip it */
313                 ast_log(LOG_WARNING, "Skipping extremely long line at line %d of %s\n", lineno, o->fn);
314
315                 /* Consume the rest of the problematic line */
316                 while (fgets(buf, sizeof(buf), f)) {
317                         len = strlen(buf);
318                         if (buf[len - 1] == '\n' || feof(f)) {
319                                 break;
320                         }
321                 }
322         }
323
324         if (ast_strlen_zero(o->tech)
325                 || ast_strlen_zero(o->dest)
326                 || (ast_strlen_zero(o->app) && ast_strlen_zero(o->exten))) {
327                 ast_log(LOG_WARNING, "At least one of app or extension must be specified, "
328                         "along with tech and dest in file %s\n", o->fn);
329                 return -1;
330         }
331
332         if (snprintf(buf, sizeof(buf), "%d", o->retries + 1) < sizeof(buf)) {
333                 append_variable(o, "AST_OUTGOING_ATTEMPT", buf);
334         }
335
336         return 0;
337 }
338
339 static void safe_append(struct outgoing *o, time_t now, char *s)
340 {
341         FILE *f;
342         struct utimbuf tbuf = { .actime = now, .modtime = now + o->retrytime };
343
344         ast_debug(1, "Outgoing %s/%s: %s\n", o->tech, o->dest, s);
345
346         if ((f = fopen(o->fn, "a"))) {
347                 fprintf(f, "\n%s: %ld %d (%ld)\n", s, (long)ast_mainpid, o->retries, (long) now);
348                 fclose(f);
349         }
350
351         /* Update the file time */
352         if (utime(o->fn, &tbuf)) {
353                 ast_log(LOG_WARNING, "Unable to set utime on %s: %s\n", o->fn, strerror(errno));
354         }
355 }
356
357 /*!
358  * \brief Remove a call file from the outgoing queue optionally moving it in the archive dir
359  *
360  * \param o the pointer to outgoing struct
361  * \param status the exit status of the call. Can be "Completed", "Failed" or "Expired"
362  */
363 static int remove_from_queue(struct outgoing *o, const char *status)
364 {
365         FILE *f;
366         char newfn[256];
367         const char *bname;
368
369 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
370         struct direntry *cur;
371 #endif
372
373         if (!ast_test_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE)) {
374                 struct stat current_file_status;
375
376                 if (!stat(o->fn, &current_file_status)) {
377                         if (time(NULL) < current_file_status.st_mtime) {
378                                 return 0;
379                         }
380                 }
381         }
382
383 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
384         AST_LIST_LOCK(&dirlist);
385         AST_LIST_TRAVERSE_SAFE_BEGIN(&dirlist, cur, list) {
386                 if (!strcmp(cur->name, o->fn)) {
387                         AST_LIST_REMOVE_CURRENT(list);
388                         ast_free(cur);
389                         break;
390                 }
391         }
392         AST_LIST_TRAVERSE_SAFE_END;
393         AST_LIST_UNLOCK(&dirlist);
394 #endif
395
396         if (!ast_test_flag(&o->options, SPOOL_FLAG_ARCHIVE)) {
397                 unlink(o->fn);
398                 return 0;
399         }
400
401         if (ast_mkdir(qdonedir, 0777)) {
402                 ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool archiving disabled\n", qdonedir);
403                 unlink(o->fn);
404                 return -1;
405         }
406
407         if (!(bname = strrchr(o->fn, '/'))) {
408                 bname = o->fn;
409         } else {
410                 bname++;
411         }
412
413         snprintf(newfn, sizeof(newfn), "%s/%s", qdonedir, bname);
414         /* If there is already a call file with the name in the archive dir, it will be overwritten. */
415         unlink(newfn);
416         if (rename(o->fn, newfn) != 0) {
417                 unlink(o->fn);
418                 return -1;
419         }
420
421         /* Only append to the file AFTER we move it out of the watched directory,
422          * otherwise the fclose() causes another event for inotify(7) */
423         if ((f = fopen(newfn, "a"))) {
424                 fprintf(f, "Status: %s\n", status);
425                 fclose(f);
426         }
427
428         return 0;
429 }
430
431 static void *attempt_thread(void *data)
432 {
433         struct outgoing *o = data;
434         int res, reason;
435         if (!ast_strlen_zero(o->app)) {
436                 ast_verb(3, "Attempting call on %s/%s for application %s(%s) (Retry %d)\n", o->tech, o->dest, o->app, o->data, o->retries);
437                 res = ast_pbx_outgoing_app(o->tech, o->capabilities, o->dest,
438                         o->waittime * 1000, o->app, o->data, &reason,
439                         AST_OUTGOING_WAIT_COMPLETE, o->cid_num, o->cid_name,
440                         o->vars, o->account, NULL, NULL);
441         } else {
442                 ast_verb(3, "Attempting call on %s/%s for %s@%s:%d (Retry %d)\n", o->tech, o->dest, o->exten, o->context,o->priority, o->retries);
443                 res = ast_pbx_outgoing_exten(o->tech, o->capabilities, o->dest,
444                         o->waittime * 1000, o->context, o->exten, o->priority, &reason,
445                         AST_OUTGOING_WAIT_COMPLETE, o->cid_num, o->cid_name,
446                         o->vars, o->account, NULL, ast_test_flag(&o->options, SPOOL_FLAG_EARLY_MEDIA),
447                         NULL);
448         }
449         if (res) {
450                 ast_log(LOG_NOTICE, "Call failed to go through, reason (%d) %s\n", reason, ast_channel_reason2str(reason));
451                 if (o->retries >= o->maxretries + 1) {
452                         /* Max retries exceeded */
453                         ast_log(LOG_NOTICE, "Queued call to %s/%s expired without completion after %d attempt%s\n", o->tech, o->dest, o->retries - 1, ((o->retries - 1) != 1) ? "s" : "");
454                         remove_from_queue(o, "Expired");
455                 } else {
456                         /* Notate that the call is still active */
457                         safe_append(o, time(NULL), "EndRetry");
458 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
459                         queue_file(o->fn, time(NULL) + o->retrytime);
460 #endif
461                 }
462         } else {
463                 ast_log(LOG_NOTICE, "Call completed to %s/%s\n", o->tech, o->dest);
464                 remove_from_queue(o, "Completed");
465         }
466         free_outgoing(o);
467         return NULL;
468 }
469
470 static void launch_service(struct outgoing *o)
471 {
472         pthread_t t;
473         int ret;
474
475         if ((ret = ast_pthread_create_detached(&t, NULL, attempt_thread, o))) {
476                 ast_log(LOG_WARNING, "Unable to create thread :( (returned error: %d)\n", ret);
477                 free_outgoing(o);
478         }
479 }
480
481 /* Called from scan_thread or queue_file */
482 static int scan_service(const char *fn, time_t now)
483 {
484         struct outgoing *o;
485         FILE *f;
486         int res;
487
488         o = new_outgoing(fn);
489         if (!o) {
490                 return -1;
491         }
492
493         /* Attempt to open the file */
494         f = fopen(o->fn, "r");
495         if (!f) {
496 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
497                 /*!
498                  * \todo XXX There is some odd delayed duplicate servicing of
499                  * call files going on.  We need to suppress the error message
500                  * if the file does not exist as a result.
501                  */
502                 if (errno != ENOENT)
503 #endif
504                 {
505                         ast_log(LOG_WARNING, "Unable to open %s: '%s'(%d), deleting\n",
506                                 o->fn, strerror(errno), (int) errno);
507                 }
508                 remove_from_queue(o, "Failed");
509                 free_outgoing(o);
510                 return -1;
511         }
512
513         /* Read in and verify the contents */
514         res = apply_outgoing(o, f);
515         fclose(f);
516         if (res) {
517                 ast_log(LOG_WARNING, "Invalid file contents in %s, deleting\n", o->fn);
518                 remove_from_queue(o, "Failed");
519                 free_outgoing(o);
520                 return -1;
521         }
522
523         ast_debug(1, "Filename: %s, Retries: %d, max: %d\n", o->fn, o->retries, o->maxretries);
524         if (o->retries <= o->maxretries) {
525                 now += o->retrytime;
526                 if (o->callingpid && (o->callingpid == ast_mainpid)) {
527                         safe_append(o, time(NULL), "DelayedRetry");
528                         ast_debug(1, "Delaying retry since we're currently running '%s'\n", o->fn);
529                         free_outgoing(o);
530                 } else {
531                         /* Increment retries */
532                         o->retries++;
533                         /* If someone else was calling, they're presumably gone now
534                            so abort their retry and continue as we were... */
535                         if (o->callingpid)
536                                 safe_append(o, time(NULL), "AbortRetry");
537
538                         safe_append(o, now, "StartRetry");
539                         launch_service(o);
540                 }
541                 return now;
542         }
543
544         ast_log(LOG_NOTICE, "Queued call to %s/%s expired without completion after %d attempt%s\n",
545                 o->tech, o->dest, o->retries - 1, ((o->retries - 1) != 1) ? "s" : "");
546         remove_from_queue(o, "Expired");
547         free_outgoing(o);
548         return 0;
549 }
550
551
552 #if defined(HAVE_INOTIFY)
553 /* Only one thread is accessing this list, so no lock is necessary */
554 static AST_LIST_HEAD_NOLOCK_STATIC(createlist, direntry);
555 static AST_LIST_HEAD_NOLOCK_STATIC(openlist, direntry);
556 #endif
557
558 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
559
560 static void queue_file(const char *filename, time_t when)
561 {
562         struct stat st;
563         struct direntry *cur, *new;
564         int res;
565         time_t now = time(NULL);
566
567         if (!strchr(filename, '/')) {
568                 char *fn = ast_alloca(strlen(qdir) + strlen(filename) + 2);
569                 sprintf(fn, "%s/%s", qdir, filename); /* SAFE */
570                 filename = fn;
571         }
572
573         if (when == 0) {
574                 if (stat(filename, &st)) {
575                         ast_log(LOG_WARNING, "Unable to stat %s: %s\n", filename, strerror(errno));
576                         return;
577                 }
578
579                 if (!S_ISREG(st.st_mode)) {
580                         return;
581                 }
582
583                 when = st.st_mtime;
584         }
585
586         /* Need to check the existing list in order to avoid duplicates. */
587         AST_LIST_LOCK(&dirlist);
588         AST_LIST_TRAVERSE(&dirlist, cur, list) {
589                 if (cur->mtime == when && !strcmp(filename, cur->name)) {
590                         AST_LIST_UNLOCK(&dirlist);
591                         return;
592                 }
593         }
594
595         if ((res = when) > now || (res = scan_service(filename, now)) > 0) {
596                 if (!(new = ast_calloc(1, sizeof(*new) + strlen(filename) + 1))) {
597                         AST_LIST_UNLOCK(&dirlist);
598                         return;
599                 }
600                 new->mtime = res;
601                 strcpy(new->name, filename);
602                 /* List is ordered by mtime */
603                 if (AST_LIST_EMPTY(&dirlist)) {
604                         AST_LIST_INSERT_HEAD(&dirlist, new, list);
605                 } else {
606                         int found = 0;
607                         AST_LIST_TRAVERSE_SAFE_BEGIN(&dirlist, cur, list) {
608                                 if (cur->mtime > new->mtime) {
609                                         AST_LIST_INSERT_BEFORE_CURRENT(new, list);
610                                         found = 1;
611                                         break;
612                                 }
613                         }
614                         AST_LIST_TRAVERSE_SAFE_END
615                         if (!found) {
616                                 AST_LIST_INSERT_TAIL(&dirlist, new, list);
617                         }
618                 }
619         }
620         AST_LIST_UNLOCK(&dirlist);
621 }
622
623 #ifdef HAVE_INOTIFY
624 static void queue_file_create(const char *filename)
625 {
626         struct direntry *cur;
627
628         AST_LIST_TRAVERSE(&createlist, cur, list) {
629                 if (!strcmp(cur->name, filename)) {
630                         return;
631                 }
632         }
633
634         if (!(cur = ast_calloc(1, sizeof(*cur) + strlen(filename) + 1))) {
635                 return;
636         }
637         strcpy(cur->name, filename);
638         /* We'll handle this file unless an IN_OPEN event occurs within 2 seconds */
639         cur->mtime = time(NULL) + 2;
640         AST_LIST_INSERT_TAIL(&createlist, cur, list);
641 }
642
643 static void queue_file_open(const char *filename)
644 {
645         struct direntry *cur;
646
647         AST_LIST_TRAVERSE_SAFE_BEGIN(&createlist, cur, list) {
648                 if (!strcmp(cur->name, filename)) {
649                         AST_LIST_REMOVE_CURRENT(list);
650                         AST_LIST_INSERT_TAIL(&openlist, cur, list);
651                         break;
652                 }
653         }
654         AST_LIST_TRAVERSE_SAFE_END
655 }
656
657 static void queue_created_files(void)
658 {
659         struct direntry *cur;
660         time_t now = time(NULL);
661
662         AST_LIST_TRAVERSE_SAFE_BEGIN(&createlist, cur, list) {
663                 if (cur->mtime > now) {
664                         break;
665                 }
666
667                 AST_LIST_REMOVE_CURRENT(list);
668                 queue_file(cur->name, 0);
669                 ast_free(cur);
670         }
671         AST_LIST_TRAVERSE_SAFE_END
672 }
673
674 static void queue_file_write(const char *filename)
675 {
676         struct direntry *cur;
677         /* Only queue entries where an IN_CREATE preceded the IN_CLOSE_WRITE */
678         AST_LIST_TRAVERSE_SAFE_BEGIN(&openlist, cur, list) {
679                 if (!strcmp(cur->name, filename)) {
680                         AST_LIST_REMOVE_CURRENT(list);
681                         ast_free(cur);
682                         queue_file(filename, 0);
683                         break;
684                 }
685         }
686         AST_LIST_TRAVERSE_SAFE_END
687 }
688 #endif
689
690 static void *scan_thread(void *unused)
691 {
692         DIR *dir;
693         struct dirent *de;
694         time_t now;
695         struct timespec ts = { .tv_sec = 1 };
696 #ifdef HAVE_INOTIFY
697         ssize_t res;
698         int inotify_fd = inotify_init();
699         struct inotify_event *iev;
700         char buf[8192] __attribute__((aligned (sizeof(int))));
701         struct pollfd pfd = { .fd = inotify_fd, .events = POLLIN };
702 #else
703         struct timespec nowait = { .tv_sec = 0, .tv_nsec = 1 };
704         int inotify_fd = kqueue();
705         struct kevent kev;
706         struct kevent event;
707 #endif
708         struct direntry *cur;
709
710         while (!ast_fully_booted) {
711                 nanosleep(&ts, NULL);
712         }
713
714         if (inotify_fd < 0) {
715                 ast_log(LOG_ERROR, "Unable to initialize "
716 #ifdef HAVE_INOTIFY
717                         "inotify(7)"
718 #else
719                         "kqueue(2)"
720 #endif
721                         "\n");
722                 return NULL;
723         }
724
725 #ifdef HAVE_INOTIFY
726         inotify_add_watch(inotify_fd, qdir, IN_CREATE | IN_OPEN | IN_CLOSE_WRITE | IN_MOVED_TO);
727 #endif
728
729         /* First, run through the directory and clear existing entries */
730         if (!(dir = opendir(qdir))) {
731                 ast_log(LOG_ERROR, "Unable to open directory %s: %s\n", qdir, strerror(errno));
732                 return NULL;
733         }
734
735 #ifndef HAVE_INOTIFY
736         EV_SET(&kev, dirfd(dir), EVFILT_VNODE, EV_ADD | EV_ENABLE | EV_CLEAR, NOTE_WRITE, 0, NULL);
737         if (kevent(inotify_fd, &kev, 1, &event, 1, &nowait) < 0 && errno != 0) {
738                 ast_log(LOG_ERROR, "Unable to watch directory %s: %s\n", qdir, strerror(errno));
739         }
740 #endif
741         now = time(NULL);
742         while ((de = readdir(dir))) {
743                 queue_file(de->d_name, 0);
744         }
745
746 #ifdef HAVE_INOTIFY
747         /* Directory needs to remain open for kqueue(2) */
748         closedir(dir);
749 #endif
750
751         /* Wait for either a) next timestamp to occur, or b) a change to happen */
752         for (;/* ever */;) {
753                 time_t next = AST_LIST_EMPTY(&dirlist) ? INT_MAX : AST_LIST_FIRST(&dirlist)->mtime;
754
755                 time(&now);
756                 if (next > now) {
757 #ifdef HAVE_INOTIFY
758                         int stage = 0;
759                         /* Convert from seconds to milliseconds, unless there's nothing
760                          * in the queue already, in which case, we wait forever. */
761                         int waittime = next == INT_MAX ? -1 : (next - now) * 1000;
762                         if (!AST_LIST_EMPTY(&createlist)) {
763                                 waittime = 1000;
764                         }
765                         /* When a file arrives, add it to the queue, in mtime order. */
766                         if ((res = poll(&pfd, 1, waittime)) > 0 && (stage = 1) &&
767                                 (res = read(inotify_fd, &buf, sizeof(buf))) >= sizeof(*iev)) {
768                                 ssize_t len = 0;
769                                 /* File(s) added to directory, add them to my list */
770                                 for (iev = (void *) buf; res >= sizeof(*iev); iev = (struct inotify_event *) (((char *) iev) + len)) {
771                                         /* For an IN_MOVED_TO event, simply process the file. However, if
772                                          * we get an IN_CREATE event it *might* be an open(O_CREAT) or it
773                                          * might be a hardlink (like smsq does, since rename() might
774                                          * overwrite an existing file). So we have to see if we get a
775                                          * subsequent IN_OPEN event on the same file. If we do, keep it
776                                          * on the openlist and wait for the corresponding IN_CLOSE_WRITE.
777                                          * If we *don't* see an IN_OPEN event, then it was a hard link so
778                                          * it can be processed immediately.
779                                          *
780                                          * Unfortunately, although open(O_CREAT) is an atomic file system
781                                          * operation, the inotify subsystem doesn't give it to us in a
782                                          * single event with both IN_CREATE|IN_OPEN set. It's two separate
783                                          * events, and the kernel doesn't even give them to us at the same
784                                          * time. We can read() from inotify_fd after the IN_CREATE event,
785                                          * and get *nothing* from it. The IN_OPEN arrives only later! So
786                                          * we have a very short timeout of 2 seconds. */
787                                         if (iev->mask & IN_CREATE) {
788                                                 queue_file_create(iev->name);
789                                         } else if (iev->mask & IN_OPEN) {
790                                                 queue_file_open(iev->name);
791                                         } else if (iev->mask & IN_CLOSE_WRITE) {
792                                                 queue_file_write(iev->name);
793                                         } else if (iev->mask & IN_MOVED_TO) {
794                                                 queue_file(iev->name, 0);
795                                         } else {
796                                                 ast_log(LOG_ERROR, "Unexpected event %d for file '%s'\n", (int) iev->mask, iev->name);
797                                         }
798
799                                         len = sizeof(*iev) + iev->len;
800                                         res -= len;
801                                 }
802                         } else if (res < 0 && errno != EINTR && errno != EAGAIN) {
803                                 ast_debug(1, "Got an error back from %s(2): %s\n", stage ? "read" : "poll", strerror(errno));
804                         }
805                         time(&now);
806                 }
807                 queue_created_files();
808 #else
809                         int num_events;
810                         /* If queue empty then wait forever */
811                         if (next == INT_MAX) {
812                                 num_events = kevent(inotify_fd, &kev, 1, &event, 1, NULL);
813                         } else {
814                                 struct timespec ts2 = { .tv_sec = (unsigned long int)(next - now), .tv_nsec = 0 };
815                                 num_events = kevent(inotify_fd, &kev, 1, &event, 1, &ts2);
816                         }
817                         if ((num_events < 0) || (event.flags == EV_ERROR)) {
818                                 ast_debug(10, "KEvent error %s\n", strerror(errno));
819                                 continue;
820                         } else if (num_events == 0) {
821                                 /* Interrupt or timeout, restart calculations */
822                                 continue;
823                         } else {
824                                 /* Directory changed, rescan */
825                                 rewinddir(dir);
826                                 while ((de = readdir(dir))) {
827                                         queue_file(de->d_name, 0);
828                                 }
829                         }
830                         time(&now);
831                 }
832 #endif
833
834                 /* Empty the list of all entries ready to be processed */
835                 AST_LIST_LOCK(&dirlist);
836                 while (!AST_LIST_EMPTY(&dirlist) && AST_LIST_FIRST(&dirlist)->mtime <= now) {
837                         cur = AST_LIST_REMOVE_HEAD(&dirlist, list);
838                         queue_file(cur->name, cur->mtime);
839                         ast_free(cur);
840                 }
841                 AST_LIST_UNLOCK(&dirlist);
842         }
843         return NULL;
844 }
845
846 #else
847 static void *scan_thread(void *unused)
848 {
849         struct stat st;
850         DIR *dir;
851         struct dirent *de;
852         char fn[256];
853         int res;
854         int force_poll = 1;
855         time_t last = 0;
856         time_t next = 0;
857         time_t now;
858         struct timespec ts = { .tv_sec = 1 };
859
860         while (!ast_fully_booted) {
861                 nanosleep(&ts, NULL);
862         }
863
864         for (;;) {
865                 /* Wait a sec */
866                 nanosleep(&ts, NULL);
867                 time(&now);
868
869                 if (stat(qdir, &st)) {
870                         ast_log(LOG_WARNING, "Unable to stat %s\n", qdir);
871                         continue;
872                 }
873
874                 /* Make sure it is time for us to execute our check */
875                 if (!force_poll && st.st_mtime == last && (!next || now < next)) {
876                         /*
877                          * The directory timestamp did not change and any delayed
878                          * call-file is not ready to be executed.
879                          */
880                         continue;
881                 }
882
883 #if 0
884                 printf("atime: %ld, mtime: %ld, ctime: %ld\n", st.st_atime, st.st_mtime, st.st_ctime);
885                 printf("Ooh, something changed / timeout\n");
886 #endif
887
888                 if (!(dir = opendir(qdir))) {
889                         ast_log(LOG_WARNING, "Unable to open directory %s: %s\n", qdir, strerror(errno));
890                         continue;
891                 }
892
893                 /*
894                  * Since the dir timestamp is available at one second
895                  * resolution, we cannot know if it was updated within the same
896                  * second after we scanned it.  Therefore, we will force another
897                  * scan if the dir was just modified.
898                  */
899                 force_poll = (st.st_mtime == now);
900
901                 next = 0;
902                 last = st.st_mtime;
903                 while ((de = readdir(dir))) {
904                         snprintf(fn, sizeof(fn), "%s/%s", qdir, de->d_name);
905                         if (stat(fn, &st)) {
906                                 ast_log(LOG_WARNING, "Unable to stat %s: %s\n", fn, strerror(errno));
907                                 continue;
908                         }
909                         if (!S_ISREG(st.st_mode)) {
910                                 /* Not a regular file. */
911                                 continue;
912                         }
913                         if (st.st_mtime <= now) {
914                                 res = scan_service(fn, now);
915                                 if (res > 0) {
916                                         /* The call-file is delayed or to be retried later. */
917                                         if (!next || res < next) {
918                                                 /* This delayed call file expires earlier. */
919                                                 next = res;
920                                         }
921                                 } else if (res) {
922                                         ast_log(LOG_WARNING, "Failed to scan service '%s'\n", fn);
923                                 } else if (!next) {
924                                         /* Expired entry: must recheck on the next go-around */
925                                         next = st.st_mtime;
926                                 }
927                         } else {
928                                 /* The file's timestamp is in the future. */
929                                 if (!next || st.st_mtime < next) {
930                                         /* This call-file's timestamp expires earlier. */
931                                         next = st.st_mtime;
932                                 }
933                         }
934                 }
935                 closedir(dir);
936         }
937         return NULL;
938 }
939 #endif
940
941 static int unload_module(void)
942 {
943         return -1;
944 }
945
946 static int load_module(void)
947 {
948         pthread_t thread;
949         int ret;
950         snprintf(qdir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing");
951         if (ast_mkdir(qdir, 0777)) {
952                 ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool disabled\n", qdir);
953                 return AST_MODULE_LOAD_DECLINE;
954         }
955         snprintf(qdonedir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing_done");
956
957         if ((ret = ast_pthread_create_detached_background(&thread, NULL, scan_thread, NULL))) {
958                 ast_log(LOG_WARNING, "Unable to create thread :( (returned error: %d)\n", ret);
959                 return AST_MODULE_LOAD_FAILURE;
960         }
961
962         return AST_MODULE_LOAD_SUCCESS;
963 }
964
965 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Outgoing Spool Support");