2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2005, 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 * Full-featured outgoing call spool support
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
41 #include "asterisk/lock.h"
42 #include "asterisk/file.h"
43 #include "asterisk/logger.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/callerid.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/module.h"
48 #include "asterisk/options.h"
49 #include "asterisk/utils.h"
52 * pbx_spool is similar in spirit to qcall, but with substantially enhanced functionality...
53 * The spool file contains a header
56 static char *tdesc = "Outgoing Spool Support";
57 static char qdir[255];
61 /* Current number of retries */
63 /* Maximum number of retries permitted */
65 /* How long to wait between retries (in seconds) */
67 /* How long to wait for an answer */
69 /* PID which is currently calling */
72 /* What to connect to outgoing */
80 /* If extension/context/priority */
85 /* CallerID Information */
89 /* Variables and Functions */
90 struct ast_variable *vars;
92 /* Maximum length of call */
97 static void init_outgoing(struct outgoing *o)
99 memset(o, 0, sizeof(struct outgoing));
105 static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
110 struct ast_variable *var;
112 while(fgets(buf, sizeof(buf), f)) {
116 while ((c = strchr(c, '#'))) {
117 if ((c == buf) || (*(c-1) == ' ') || (*(c-1) == '\t'))
122 c = strchr(buf, ';');
126 /* Trim trailing white space */
127 while(!ast_strlen_zero(buf) && buf[strlen(buf) - 1] < 33)
128 buf[strlen(buf) - 1] = '\0';
129 if (!ast_strlen_zero(buf)) {
130 c = strchr(buf, ':');
134 while ((*c) && (*c < 33))
137 printf("'%s' is '%s' at line %d\n", buf, c, lineno);
139 if (!strcasecmp(buf, "channel")) {
140 strncpy(o->tech, c, sizeof(o->tech) - 1);
141 if ((c2 = strchr(o->tech, '/'))) {
144 strncpy(o->dest, c2, sizeof(o->dest) - 1);
146 ast_log(LOG_NOTICE, "Channel should be in form Tech/Dest at line %d of %s\n", lineno, fn);
149 } else if (!strcasecmp(buf, "callerid")) {
150 ast_callerid_split(c, o->cid_name, sizeof(o->cid_name), o->cid_num, sizeof(o->cid_num));
151 } else if (!strcasecmp(buf, "application")) {
152 strncpy(o->app, c, sizeof(o->app) - 1);
153 } else if (!strcasecmp(buf, "data")) {
154 strncpy(o->data, c, sizeof(o->data) - 1);
155 } else if (!strcasecmp(buf, "maxretries")) {
156 if (sscanf(c, "%d", &o->maxretries) != 1) {
157 ast_log(LOG_WARNING, "Invalid max retries at line %d of %s\n", lineno, fn);
160 } else if (!strcasecmp(buf, "context")) {
161 strncpy(o->context, c, sizeof(o->context) - 1);
162 } else if (!strcasecmp(buf, "extension")) {
163 strncpy(o->exten, c, sizeof(o->exten) - 1);
164 } else if (!strcasecmp(buf, "priority")) {
165 if ((sscanf(c, "%d", &o->priority) != 1) || (o->priority < 1)) {
166 ast_log(LOG_WARNING, "Invalid priority at line %d of %s\n", lineno, fn);
169 } else if (!strcasecmp(buf, "retrytime")) {
170 if ((sscanf(c, "%d", &o->retrytime) != 1) || (o->retrytime < 1)) {
171 ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
174 } else if (!strcasecmp(buf, "waittime")) {
175 if ((sscanf(c, "%d", &o->waittime) != 1) || (o->waittime < 1)) {
176 ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
179 } else if (!strcasecmp(buf, "retry")) {
181 } else if (!strcasecmp(buf, "startretry")) {
182 if (sscanf(c, "%d", &o->callingpid) != 1) {
183 ast_log(LOG_WARNING, "Unable to retrieve calling PID!\n");
186 } else if (!strcasecmp(buf, "endretry") || !strcasecmp(buf, "abortretry")) {
189 } else if (!strcasecmp(buf, "delayedretry")) {
190 } else if (!strcasecmp(buf, "setvar") || !strcasecmp(buf, "set")) {
193 var = ast_variable_new(c, c2);
198 } else if (!strcasecmp(buf, "account")) {
199 var = ast_variable_new("CDR(accountcode|r)", c);
205 ast_log(LOG_WARNING, "Unknown keyword '%s' at line %d of %s\n", buf, lineno, fn);
208 ast_log(LOG_NOTICE, "Syntax error at line %d of %s\n", lineno, fn);
211 strncpy(o->fn, fn, sizeof(o->fn) - 1);
212 if (ast_strlen_zero(o->tech) || ast_strlen_zero(o->dest) || (ast_strlen_zero(o->app) && ast_strlen_zero(o->exten))) {
213 ast_log(LOG_WARNING, "At least one of app or extension must be specified, along with tech and dest in file %s\n", fn);
219 static void safe_append(struct outgoing *o, time_t now, char *s)
224 fd = open(o->fn, O_WRONLY|O_APPEND);
228 fprintf(f, "%s: %ld %d (%ld)\n", s, (long)ast_mainpid, o->retries, (long) now);
232 /* Update the file time */
234 tbuf.modtime = now + o->retrytime;
235 if (utime(o->fn, &tbuf))
236 ast_log(LOG_WARNING, "Unable to set utime on %s: %s\n", o->fn, strerror(errno));
240 static void *attempt_thread(void *data)
242 struct outgoing *o = data;
244 if (!ast_strlen_zero(o->app)) {
245 if (option_verbose > 2)
246 ast_verbose(VERBOSE_PREFIX_3 "Attempting call on %s/%s for application %s(%s) (Retry %d)\n", o->tech, o->dest, o->app, o->data, o->retries);
247 res = ast_pbx_outgoing_app(o->tech, AST_FORMAT_SLINEAR, o->dest, o->waittime * 1000, o->app, o->data, &reason, 2 /* wait to finish */, o->cid_num, o->cid_name, o->vars, NULL);
249 if (option_verbose > 2)
250 ast_verbose(VERBOSE_PREFIX_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);
251 res = ast_pbx_outgoing_exten(o->tech, AST_FORMAT_SLINEAR, o->dest, o->waittime * 1000, o->context, o->exten, o->priority, &reason, 2 /* wait to finish */, o->cid_num, o->cid_name, o->vars, NULL);
254 ast_log(LOG_NOTICE, "Call failed to go through, reason %d\n", reason);
255 if (o->retries >= o->maxretries + 1) {
256 /* Max retries exceeded */
257 ast_log(LOG_EVENT, "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" : "");
260 /* Notate that the call is still active */
261 safe_append(o, time(NULL), "EndRetry");
264 ast_log(LOG_NOTICE, "Call completed to %s/%s\n", o->tech, o->dest);
265 ast_log(LOG_EVENT, "Queued call to %s/%s completed\n", o->tech, o->dest);
272 static void launch_service(struct outgoing *o)
276 pthread_attr_init(&attr);
277 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
278 if (ast_pthread_create(&t,&attr,attempt_thread, o) == -1) {
279 ast_log(LOG_WARNING, "Unable to create thread :(\n");
284 static int scan_service(char *fn, time_t now, time_t atime)
288 o = malloc(sizeof(struct outgoing));
293 if (!apply_outgoing(o, fn, f)) {
295 printf("Filename: %s, Retries: %d, max: %d\n", fn, o->retries, o->maxretries);
298 if (o->retries <= o->maxretries) {
299 if (o->callingpid && (o->callingpid == ast_mainpid)) {
300 safe_append(o, time(NULL), "DelayedRetry");
301 ast_log(LOG_DEBUG, "Delaying retry since we're currently running '%s'\n", o->fn);
303 /* Increment retries */
305 /* If someone else was calling, they're presumably gone now
306 so abort their retry and continue as we were... */
308 safe_append(o, time(NULL), "AbortRetry");
310 safe_append(o, now, "StartRetry");
316 ast_log(LOG_EVENT, "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" : "");
323 ast_log(LOG_WARNING, "Invalid file contents in %s, deleting\n", fn);
329 ast_log(LOG_WARNING, "Unable to open %s: %s, deleting\n", fn, strerror(errno));
333 ast_log(LOG_WARNING, "Out of memory :(\n");
337 static void *scan_thread(void *unused)
344 time_t last = 0, next = 0, now;
349 if (!stat(qdir, &st)) {
350 if ((st.st_mtime != last) || (next && (now > next))) {
352 printf("atime: %ld, mtime: %ld, ctime: %ld\n", st.st_atime, st.st_mtime, st.st_ctime);
353 printf("Ooh, something changed / timeout\n");
359 while((de = readdir(dir))) {
360 snprintf(fn, sizeof(fn), "%s/%s", qdir, de->d_name);
361 if (!stat(fn, &st)) {
362 if (S_ISREG(st.st_mode)) {
363 if (st.st_mtime <= now) {
364 res = scan_service(fn, now, st.st_atime);
366 /* Update next service time */
367 if (!next || (res < next)) {
371 ast_log(LOG_WARNING, "Failed to scan service '%s'\n", fn);
373 /* Update "next" update if necessary */
374 if (!next || (st.st_mtime < next))
379 ast_log(LOG_WARNING, "Unable to stat %s: %s\n", fn, strerror(errno));
383 ast_log(LOG_WARNING, "Unable to open directory %s: %s\n", qdir, strerror(errno));
386 ast_log(LOG_WARNING, "Unable to stat %s\n", qdir);
391 int unload_module(void)
396 int load_module(void)
400 snprintf(qdir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing");
401 if (mkdir(qdir, 0700) && (errno != EEXIST)) {
402 ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool disabled\n", qdir);
405 pthread_attr_init(&attr);
406 pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
407 if (ast_pthread_create(&thread,&attr,scan_thread, NULL) == -1) {
408 ast_log(LOG_WARNING, "Unable to create thread :(\n");
414 char *description(void)
426 return ASTERISK_GPL_KEY;