2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2010, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Full-featured outgoing call spool support
27 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34 #include <sys/inotify.h>
35 #elif defined(HAVE_KQUEUE)
36 #include <sys/types.h>
38 #include <sys/event.h>
42 #include "asterisk/paths.h" /* use ast_config_AST_SPOOL_DIR */
43 #include "asterisk/lock.h"
44 #include "asterisk/file.h"
45 #include "asterisk/logger.h"
46 #include "asterisk/channel.h"
47 #include "asterisk/callerid.h"
48 #include "asterisk/pbx.h"
49 #include "asterisk/module.h"
50 #include "asterisk/utils.h"
51 #include "asterisk/options.h"
54 * pbx_spool is similar in spirit to qcall, but with substantially enhanced functionality...
55 * The spool file contains a header
59 /*! Always delete the call file after a call succeeds or the
60 * maximum number of retries is exceeded, even if the
61 * modification time of the call file is in the future.
63 SPOOL_FLAG_ALWAYS_DELETE = (1 << 0),
64 /* Don't unlink the call file after processing, move in qdonedir */
65 SPOOL_FLAG_ARCHIVE = (1 << 1)
68 static char qdir[255];
69 static char qdonedir[255];
72 int retries; /*!< Current number of retries */
73 int maxretries; /*!< Maximum number of retries permitted */
74 int retrytime; /*!< How long to wait between retries (in seconds) */
75 int waittime; /*!< How long to wait for an answer */
76 long callingpid; /*!< PID which is currently calling */
77 format_t format; /*!< Formats (codecs) for this call */
78 AST_DECLARE_STRING_FIELDS (
79 AST_STRING_FIELD(fn); /*!< File name of call file */
80 AST_STRING_FIELD(tech); /*!< Which channel technology to use for outgoing call */
81 AST_STRING_FIELD(dest); /*!< Which device/line to use for outgoing call */
82 AST_STRING_FIELD(app); /*!< If application: Application name */
83 AST_STRING_FIELD(data); /*!< If application: Application data */
84 AST_STRING_FIELD(exten); /*!< If extension/context/priority: Extension in dialplan */
85 AST_STRING_FIELD(context); /*!< If extension/context/priority: Dialplan context */
86 AST_STRING_FIELD(cid_num); /*!< CallerID Information: Number/extension */
87 AST_STRING_FIELD(cid_name); /*!< CallerID Information: Name */
88 AST_STRING_FIELD(account); /*!< account code */
90 int priority; /*!< If extension/context/priority: Dialplan priority */
91 struct ast_variable *vars; /*!< Variables and Functions */
92 int maxlen; /*!< Maximum length of call */
93 struct ast_flags options; /*!< options */
96 static int init_outgoing(struct outgoing *o)
101 o->format = AST_FORMAT_SLINEAR;
102 ast_set_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE);
103 if (ast_string_field_init(o, 128)) {
109 static void free_outgoing(struct outgoing *o)
112 ast_variables_destroy(o->vars);
114 ast_string_field_free_memory(o);
118 static int apply_outgoing(struct outgoing *o, const char *fn, FILE *f)
123 struct ast_variable *var, *last = o->vars;
125 while (last && last->next) {
129 while(fgets(buf, sizeof(buf), f)) {
133 while ((c = strchr(c, '#'))) {
134 if ((c == buf) || (*(c-1) == ' ') || (*(c-1) == '\t'))
141 while ((c = strchr(c, ';'))) {
142 if ((c > buf) && (c[-1] == '\\')) {
143 memmove(c - 1, c, strlen(c) + 1);
151 /* Trim trailing white space */
152 while(!ast_strlen_zero(buf) && buf[strlen(buf) - 1] < 33)
153 buf[strlen(buf) - 1] = '\0';
154 if (!ast_strlen_zero(buf)) {
155 c = strchr(buf, ':');
159 while ((*c) && (*c < 33))
162 printf("'%s' is '%s' at line %d\n", buf, c, lineno);
164 if (!strcasecmp(buf, "channel")) {
165 if ((c2 = strchr(c, '/'))) {
168 ast_string_field_set(o, tech, c);
169 ast_string_field_set(o, dest, c2);
171 ast_log(LOG_NOTICE, "Channel should be in form Tech/Dest at line %d of %s\n", lineno, fn);
173 } else if (!strcasecmp(buf, "callerid")) {
174 char cid_name[80] = {0}, cid_num[80] = {0};
175 ast_callerid_split(c, cid_name, sizeof(cid_name), cid_num, sizeof(cid_num));
176 ast_string_field_set(o, cid_num, cid_num);
177 ast_string_field_set(o, cid_name, cid_name);
178 } else if (!strcasecmp(buf, "application")) {
179 ast_string_field_set(o, app, c);
180 } else if (!strcasecmp(buf, "data")) {
181 ast_string_field_set(o, data, c);
182 } else if (!strcasecmp(buf, "maxretries")) {
183 if (sscanf(c, "%30d", &o->maxretries) != 1) {
184 ast_log(LOG_WARNING, "Invalid max retries at line %d of %s\n", lineno, fn);
187 } else if (!strcasecmp(buf, "codecs")) {
188 ast_parse_allow_disallow(NULL, &o->format, c, 1);
189 } else if (!strcasecmp(buf, "context")) {
190 ast_string_field_set(o, context, c);
191 } else if (!strcasecmp(buf, "extension")) {
192 ast_string_field_set(o, exten, c);
193 } else if (!strcasecmp(buf, "priority")) {
194 if ((sscanf(c, "%30d", &o->priority) != 1) || (o->priority < 1)) {
195 ast_log(LOG_WARNING, "Invalid priority at line %d of %s\n", lineno, fn);
198 } else if (!strcasecmp(buf, "retrytime")) {
199 if ((sscanf(c, "%30d", &o->retrytime) != 1) || (o->retrytime < 1)) {
200 ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
203 } else if (!strcasecmp(buf, "waittime")) {
204 if ((sscanf(c, "%30d", &o->waittime) != 1) || (o->waittime < 1)) {
205 ast_log(LOG_WARNING, "Invalid waittime at line %d of %s\n", lineno, fn);
208 } else if (!strcasecmp(buf, "retry")) {
210 } else if (!strcasecmp(buf, "startretry")) {
211 if (sscanf(c, "%30ld", &o->callingpid) != 1) {
212 ast_log(LOG_WARNING, "Unable to retrieve calling PID!\n");
215 } else if (!strcasecmp(buf, "endretry") || !strcasecmp(buf, "abortretry")) {
218 } else if (!strcasecmp(buf, "delayedretry")) {
219 } else if (!strcasecmp(buf, "setvar") || !strcasecmp(buf, "set")) {
223 var = ast_variable_new(c, c2, fn);
225 /* Always insert at the end, because some people want to treat the spool file as a script */
234 ast_log(LOG_WARNING, "Malformed \"%s\" argument. Should be \"%s: variable=value\"\n", buf, buf);
235 } else if (!strcasecmp(buf, "account")) {
236 ast_string_field_set(o, account, c);
237 } else if (!strcasecmp(buf, "alwaysdelete")) {
238 ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ALWAYS_DELETE);
239 } else if (!strcasecmp(buf, "archive")) {
240 ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ARCHIVE);
242 ast_log(LOG_WARNING, "Unknown keyword '%s' at line %d of %s\n", buf, lineno, fn);
245 ast_log(LOG_NOTICE, "Syntax error at line %d of %s\n", lineno, fn);
248 ast_string_field_set(o, fn, fn);
249 if (ast_strlen_zero(o->tech) || ast_strlen_zero(o->dest) || (ast_strlen_zero(o->app) && ast_strlen_zero(o->exten))) {
250 ast_log(LOG_WARNING, "At least one of app or extension must be specified, along with tech and dest in file %s\n", fn);
256 static void safe_append(struct outgoing *o, time_t now, char *s)
262 if ((fd = open(o->fn, O_WRONLY | O_APPEND)) < 0)
265 if ((f = fdopen(fd, "a"))) {
266 fprintf(f, "\n%s: %ld %d (%ld)\n", s, (long)ast_mainpid, o->retries, (long) now);
271 /* Update the file time */
273 tbuf.modtime = now + o->retrytime;
274 if (utime(o->fn, &tbuf))
275 ast_log(LOG_WARNING, "Unable to set utime on %s: %s\n", o->fn, strerror(errno));
279 * \brief Remove a call file from the outgoing queue optionally moving it in the archive dir
281 * \param o the pointer to outgoing struct
282 * \param status the exit status of the call. Can be "Completed", "Failed" or "Expired"
284 static int remove_from_queue(struct outgoing *o, const char *status)
291 if (!ast_test_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE)) {
292 struct stat current_file_status;
294 if (!stat(o->fn, ¤t_file_status)) {
295 if (time(NULL) < current_file_status.st_mtime)
300 if (!ast_test_flag(&o->options, SPOOL_FLAG_ARCHIVE)) {
305 if (ast_mkdir(qdonedir, 0777)) {
306 ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool archiving disabled\n", qdonedir);
311 if ((fd = open(o->fn, O_WRONLY | O_APPEND))) {
312 if ((f = fdopen(fd, "a"))) {
313 fprintf(f, "Status: %s\n", status);
319 if (!(bname = strrchr(o->fn, '/')))
323 snprintf(newfn, sizeof(newfn), "%s/%s", qdonedir, bname);
324 /* a existing call file the archive dir is overwritten */
326 if (rename(o->fn, newfn) != 0) {
333 static void *attempt_thread(void *data)
335 struct outgoing *o = data;
337 if (!ast_strlen_zero(o->app)) {
338 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);
339 res = ast_pbx_outgoing_app(o->tech, o->format, (void *) o->dest, o->waittime * 1000, o->app, o->data, &reason, 2 /* wait to finish */, o->cid_num, o->cid_name, o->vars, o->account, NULL);
342 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);
343 res = ast_pbx_outgoing_exten(o->tech, o->format, (void *) o->dest, o->waittime * 1000, o->context, o->exten, o->priority, &reason, 2 /* wait to finish */, o->cid_num, o->cid_name, o->vars, o->account, NULL);
347 ast_log(LOG_NOTICE, "Call failed to go through, reason (%d) %s\n", reason, ast_channel_reason2str(reason));
348 if (o->retries >= o->maxretries + 1) {
349 /* Max retries exceeded */
350 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" : "");
351 remove_from_queue(o, "Expired");
353 /* Notate that the call is still active */
354 safe_append(o, time(NULL), "EndRetry");
357 ast_log(LOG_NOTICE, "Call completed to %s/%s\n", o->tech, o->dest);
358 remove_from_queue(o, "Completed");
364 static void launch_service(struct outgoing *o)
369 if ((ret = ast_pthread_create_detached(&t, NULL, attempt_thread, o))) {
370 ast_log(LOG_WARNING, "Unable to create thread :( (returned error: %d)\n", ret);
375 /* Called from scan_thread or queue_file */
376 static int scan_service(const char *fn, time_t now)
378 struct outgoing *o = NULL;
382 if (!(o = ast_calloc(1, sizeof(*o)))) {
383 ast_log(LOG_WARNING, "Out of memory ;(\n");
387 if (init_outgoing(o)) {
388 /* No need to call free_outgoing here since we know the failure
389 * was to allocate string fields and no variables have been allocated
396 /* Attempt to open the file */
397 if (!(f = fopen(fn, "r+"))) {
398 remove_from_queue(o, "Failed");
400 ast_log(LOG_WARNING, "Unable to open %s: %s, deleting\n", fn, strerror(errno));
404 /* Read in and verify the contents */
405 if (apply_outgoing(o, fn, f)) {
406 remove_from_queue(o, "Failed");
408 ast_log(LOG_WARNING, "Invalid file contents in %s, deleting\n", fn);
414 printf("Filename: %s, Retries: %d, max: %d\n", fn, o->retries, o->maxretries);
417 if (o->retries <= o->maxretries) {
419 if (o->callingpid && (o->callingpid == ast_mainpid)) {
420 safe_append(o, time(NULL), "DelayedRetry");
421 ast_log(LOG_DEBUG, "Delaying retry since we're currently running '%s'\n", o->fn);
424 /* Increment retries */
426 /* If someone else was calling, they're presumably gone now
427 so abort their retry and continue as we were... */
429 safe_append(o, time(NULL), "AbortRetry");
431 safe_append(o, now, "StartRetry");
436 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" : "");
437 remove_from_queue(o, "Expired");
444 #if defined(HAVE_INOTIFY) || defined(HAVE_KQUEUE)
446 AST_LIST_ENTRY(direntry) list;
451 /* Only one thread is accessing this list, so no lock is necessary */
452 static AST_LIST_HEAD_NOLOCK_STATIC(dirlist, direntry);
454 static void queue_file(const char *filename, time_t when)
457 struct direntry *cur, *new;
459 time_t now = time(NULL);
461 if (filename[0] != '/') {
462 char *fn = alloca(strlen(qdir) + strlen(filename) + 2);
463 sprintf(fn, "%s/%s", qdir, filename); /* SAFE */
468 if (stat(filename, &st)) {
469 ast_log(LOG_WARNING, "Unable to stat %s: %s\n", filename, strerror(errno));
473 if (!S_ISREG(st.st_mode)) {
481 /* Need to check the existing list for kqueue(2), in order to avoid duplicates. */
482 AST_LIST_TRAVERSE(&dirlist, cur, list) {
483 if (cur->mtime == when && !strcmp(filename, cur->name)) {
489 if ((res = when) > now || (res = scan_service(filename, now)) > 0) {
490 if (!(new = ast_calloc(1, sizeof(*new) + strlen(filename) + 1))) {
494 strcpy(new->name, filename);
495 /* List is ordered by mtime */
496 if (AST_LIST_EMPTY(&dirlist)) {
497 AST_LIST_INSERT_HEAD(&dirlist, new, list);
500 AST_LIST_TRAVERSE_SAFE_BEGIN(&dirlist, cur, list) {
501 if (cur->mtime > new->mtime) {
502 AST_LIST_INSERT_BEFORE_CURRENT(new, list);
507 AST_LIST_TRAVERSE_SAFE_END
509 AST_LIST_INSERT_TAIL(&dirlist, new, list);
515 static void *scan_thread(void *unused)
520 struct timespec ts = { .tv_sec = 1 };
523 int inotify_fd = inotify_init();
525 struct inotify_event iev;
526 /* It may not look like we're using this element, but when we read
527 * from inotify_fd, the event is typically larger than the first
528 * struct, and overflows into this second one. */
529 char name[FILENAME_MAX + 1];
531 struct pollfd pfd = { .fd = inotify_fd, .events = POLLIN };
533 struct timespec nowait = { 0, 1 };
534 int inotify_fd = kqueue();
537 struct direntry *cur;
539 while (!ast_fully_booted) {
540 nanosleep(&ts, NULL);
543 if (inotify_fd < 0) {
544 ast_log(LOG_ERROR, "Unable to initialize "
555 inotify_add_watch(inotify_fd, qdir, IN_CLOSE_WRITE | IN_MOVED_TO);
558 /* First, run through the directory and clear existing entries */
559 if (!(dir = opendir(qdir))) {
560 ast_log(LOG_ERROR, "Unable to open directory %s: %s\n", qdir, strerror(errno));
565 EV_SET(&kev, dirfd(dir), EVFILT_VNODE, EV_ADD | EV_ENABLE, NOTE_WRITE | NOTE_EXTEND | NOTE_DELETE | NOTE_REVOKE | NOTE_ATTRIB, 0, NULL);
566 if (kevent(inotify_fd, &kev, 1, NULL, 0, &nowait) < 0 && errno != 0) {
567 ast_log(LOG_ERROR, "Unable to watch directory %s: %s\n", qdir, strerror(errno));
571 while ((de = readdir(dir))) {
572 queue_file(de->d_name, 0);
576 /* Directory needs to remain open for kqueue(2) */
580 /* Wait for either a) next timestamp to occur, or b) a change to happen */
582 time_t next = AST_LIST_EMPTY(&dirlist) ? INT_MAX : AST_LIST_FIRST(&dirlist)->mtime;
588 /* Convert from seconds to milliseconds, unless there's nothing
589 * in the queue already, in which case, we wait forever. */
590 int waittime = next == INT_MAX ? -1 : (next - now) * 1000;
591 /* When a file arrives, add it to the queue, in mtime order. */
592 if ((res = poll(&pfd, 1, waittime)) > 0 && (stage = 1) &&
593 (res = read(inotify_fd, &buf, sizeof(buf))) >= sizeof(buf.iev)) {
594 /* File(s) added to directory, add them to my list */
596 queue_file(buf.iev.name, 0);
597 res -= sizeof(buf.iev) + buf.iev.len;
598 if (res >= sizeof(buf.iev)) {
599 memmove(&buf.iev, &buf.iev.name[buf.iev.len], res);
604 } else if (res < 0 && errno != EINTR && errno != EAGAIN) {
605 ast_debug(1, "Got an error back from %s(2): %s\n", stage ? "read" : "poll", strerror(errno));
608 struct timespec ts2 = { next - now, 0 };
609 if (kevent(inotify_fd, NULL, 0, &kev, 1, &ts2) <= 0) {
610 /* Interrupt or timeout, restart calculations */
613 /* Directory changed, rescan */
615 while ((de = readdir(dir))) {
616 queue_file(de->d_name, 0);
623 /* Empty the list of all entries ready to be processed */
624 while (!AST_LIST_EMPTY(&dirlist) && AST_LIST_FIRST(&dirlist)->mtime <= now) {
625 cur = AST_LIST_REMOVE_HEAD(&dirlist, list);
626 queue_file(cur->name, cur->mtime);
634 static void *scan_thread(void *unused)
641 time_t last = 0, next = 0, now;
642 struct timespec ts = { .tv_sec = 1 };
644 while (!ast_fully_booted) {
645 nanosleep(&ts, NULL);
650 nanosleep(&ts, NULL);
653 if (stat(qdir, &st)) {
654 ast_log(LOG_WARNING, "Unable to stat %s\n", qdir);
658 /* Make sure it is time for us to execute our check */
659 if ((st.st_mtime == last) && (next && (next > now)))
663 printf("atime: %ld, mtime: %ld, ctime: %ld\n", st.st_atime, st.st_mtime, st.st_ctime);
664 printf("Ooh, something changed / timeout\n");
669 if (!(dir = opendir(qdir))) {
670 ast_log(LOG_WARNING, "Unable to open directory %s: %s\n", qdir, strerror(errno));
674 while ((de = readdir(dir))) {
675 snprintf(fn, sizeof(fn), "%s/%s", qdir, de->d_name);
677 ast_log(LOG_WARNING, "Unable to stat %s: %s\n", fn, strerror(errno));
680 if (!S_ISREG(st.st_mode))
682 if (st.st_mtime <= now) {
683 res = scan_service(fn, now);
685 /* Update next service time */
686 if (!next || (res < next)) {
690 ast_log(LOG_WARNING, "Failed to scan service '%s'\n", fn);
692 /* Expired entry: must recheck on the next go-around */
696 /* Update "next" update if necessary */
697 if (!next || (st.st_mtime < next))
707 static int unload_module(void)
712 static int load_module(void)
716 snprintf(qdir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing");
717 if (ast_mkdir(qdir, 0777)) {
718 ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool disabled\n", qdir);
719 return AST_MODULE_LOAD_DECLINE;
721 snprintf(qdonedir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing_done");
723 if ((ret = ast_pthread_create_detached_background(&thread, NULL, scan_thread, NULL))) {
724 ast_log(LOG_WARNING, "Unable to create thread :( (returned error: %d)\n", ret);
725 return AST_MODULE_LOAD_FAILURE;
728 return AST_MODULE_LOAD_SUCCESS;
731 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Outgoing Spool Support");