Merged revisions 72806 via svnmerge from
[asterisk/asterisk.git] / pbx / pbx_spool.c
old mode 100755 (executable)
new mode 100644 (file)
index b4cc381..6c045d3
@@ -1,16 +1,31 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Full-featured outgoing call spool support
- * 
- * Copyright (C) 2002 - 2005, Digium, Inc.
+ * Copyright (C) 1999 - 2005, Digium, Inc.
  *
  * Mark Spencer <markster@digium.com>
  *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
  */
 
+/*! \file
+ *
+ * \brief Full-featured outgoing call spool support
+ * 
+ */
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include <sys/stat.h>
 #include <errno.h>
 #include <time.h>
 #include <stdio.h>
 #include <unistd.h>
 
-#include "asterisk.h"
-
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include "asterisk/lock.h"
 #include "asterisk/file.h"
 #include "asterisk/logger.h"
@@ -42,8 +53,18 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
  * The spool file contains a header 
  */
 
-static char *tdesc = "Outgoing Spool Support";
+enum {
+       /*! Always delete the call file after a call succeeds or the
+        * maximum number of retries is exceeded, even if the
+        * modification time of the call file is in the future.
+        */
+       SPOOL_FLAG_ALWAYS_DELETE = (1 << 0),
+       /* Don't unlink the call file after processing, move in qdonedir */
+       SPOOL_FLAG_ARCHIVE = (1 << 1)
+};
+
 static char qdir[255];
+static char qdonedir[255];
 
 struct outgoing {
        char fn[256];
@@ -56,7 +77,7 @@ struct outgoing {
        /* How long to wait for an answer */
        int waittime;
        /* PID which is currently calling */
-       int callingpid;
+       long callingpid;
        
        /* What to connect to outgoing */
        char tech[256];
@@ -75,14 +96,17 @@ struct outgoing {
        char cid_num[256];
        char cid_name[256];
 
-       /* Channel variables */
-       char variable[10*256];
-       /* Account code */
-       char account[256];
+       /* account code */
+       char account[AST_MAX_ACCOUNT_CODE];
+
+       /* Variables and Functions */
+       struct ast_variable *vars;
        
        /* Maximum length of call */
        int maxlen;
-       
+
+       /* options */
+       struct ast_flags options;
 };
 
 static void init_outgoing(struct outgoing *o)
@@ -91,6 +115,12 @@ static void init_outgoing(struct outgoing *o)
        o->priority = 1;
        o->retrytime = 300;
        o->waittime = 45;
+       ast_set_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE);
+}
+
+static void free_outgoing(struct outgoing *o)
+{
+       free(o);
 }
 
 static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
@@ -98,98 +128,119 @@ static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
        char buf[256];
        char *c, *c2;
        int lineno = 0;
+       struct ast_variable *var;
+
        while(fgets(buf, sizeof(buf), f)) {
                lineno++;
-                       /* Trim comments */
-                       c = buf;
-                       while ((c = strchr(c, '#'))) {
-                               if ((c == buf) || (*(c-1) == ' ') || (*(c-1) == '\t'))
-                                       *c = '\0';
-                               else
-                                       c++;
+               /* Trim comments */
+               c = buf;
+               while ((c = strchr(c, '#'))) {
+                       if ((c == buf) || (*(c-1) == ' ') || (*(c-1) == '\t'))
+                               *c = '\0';
+                       else
+                               c++;
+               }
+
+               c = buf;
+               while ((c = strchr(c, ';'))) {
+                       if ((c > buf) && (c[-1] == '\\')) {
+                               memmove(c - 1, c, strlen(c) + 1);
+                               c++;
+                       } else {
+                               *c = '\0';
+                               break;
                        }
-                       c = strchr(buf, ';');
-                       if (c)
-                                *c = '\0';
-
-                       /* Trim trailing white space */
-                       while(!ast_strlen_zero(buf) && buf[strlen(buf) - 1] < 33)
-                               buf[strlen(buf) - 1] = '\0';
-                       if (!ast_strlen_zero(buf)) {
-                               c = strchr(buf, ':');
-                               if (c) {
-                                       *c = '\0';
+               }
+
+               /* Trim trailing white space */
+               while(!ast_strlen_zero(buf) && buf[strlen(buf) - 1] < 33)
+                       buf[strlen(buf) - 1] = '\0';
+               if (!ast_strlen_zero(buf)) {
+                       c = strchr(buf, ':');
+                       if (c) {
+                               *c = '\0';
+                               c++;
+                               while ((*c) && (*c < 33))
                                        c++;
-                                       while ((*c) && (*c < 33))
-                                               c++;
 #if 0
-                                       printf("'%s' is '%s' at line %d\n", buf, c, lineno);
-#endif                                 
-                                       if (!strcasecmp(buf, "channel")) {
-                                               strncpy(o->tech, c, sizeof(o->tech) - 1);
-                                               if ((c2 = strchr(o->tech, '/'))) {
-                                                       *c2 = '\0';
-                                                       c2++;
-                                                       strncpy(o->dest, c2, sizeof(o->dest) - 1);
-                                               } else {
-                                                       ast_log(LOG_NOTICE, "Channel should be in form Tech/Dest at line %d of %s\n", lineno, fn);
-                                                       o->tech[0] = '\0';
-                                               }
-                                       } else if (!strcasecmp(buf, "callerid")) {
-                                               ast_callerid_split(c, o->cid_name, sizeof(o->cid_name), o->cid_num, sizeof(o->cid_num));
-                                       } else if (!strcasecmp(buf, "application")) {
-                                               strncpy(o->app, c, sizeof(o->app) - 1);
-                                       } else if (!strcasecmp(buf, "data")) {
-                                               strncpy(o->data, c, sizeof(o->data) - 1);
-                                       } else if (!strcasecmp(buf, "maxretries")) {
-                                               if (sscanf(c, "%d", &o->maxretries) != 1) {
-                                                       ast_log(LOG_WARNING, "Invalid max retries at line %d of %s\n", lineno, fn);
-                                                       o->maxretries = 0;
-                                               }
-                                       } else if (!strcasecmp(buf, "context")) {
-                                               strncpy(o->context, c, sizeof(o->context) - 1);
-                                       } else if (!strcasecmp(buf, "extension")) {
-                                               strncpy(o->exten, c, sizeof(o->exten) - 1);
-                                       } else if (!strcasecmp(buf, "priority")) {
-                                               if ((sscanf(c, "%d", &o->priority) != 1) || (o->priority < 1)) {
-                                                       ast_log(LOG_WARNING, "Invalid priority at line %d of %s\n", lineno, fn);
-                                                       o->priority = 1;
-                                               }
-                                       } else if (!strcasecmp(buf, "retrytime")) {
-                                               if ((sscanf(c, "%d", &o->retrytime) != 1) || (o->retrytime < 1)) {
-                                                       ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
-                                                       o->retrytime = 300;
-                                               }
-                                       } else if (!strcasecmp(buf, "waittime")) {
-                                               if ((sscanf(c, "%d", &o->waittime) != 1) || (o->waittime < 1)) {
-                                                       ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
-                                                       o->waittime = 45;
-                                               }
-                                       } else if (!strcasecmp(buf, "retry")) {
-                                               o->retries++;
-                                       } else if (!strcasecmp(buf, "startretry")) {
-                                               if (sscanf(c, "%d", &o->callingpid) != 1) {
-                                                       ast_log(LOG_WARNING, "Unable to retrieve calling PID!\n");
-                                                       o->callingpid = 0;
-                                               }
-                                       } else if (!strcasecmp(buf, "endretry") || !strcasecmp(buf, "abortretry")) {
-                                               o->callingpid = 0;
-                                               o->retries++;
-                                       } else if (!strcasecmp(buf, "delayedretry")) {
-                                       } else if (!strcasecmp(buf, "setvar")) { /* JDG variable support */
-                                               strncat(o->variable, c, sizeof(o->variable) - strlen(o->variable) - 1);
-                                               strncat(o->variable, "|", sizeof(o->variable) - strlen(o->variable) - 1);
-                                       } else if (!strcasecmp(buf, "account")) {
-                                               strncpy(o->account, c, sizeof(o->account) - 1);
+                               printf("'%s' is '%s' at line %d\n", buf, c, lineno);
+#endif
+                               if (!strcasecmp(buf, "channel")) {
+                                       ast_copy_string(o->tech, c, sizeof(o->tech));
+                                       if ((c2 = strchr(o->tech, '/'))) {
+                                               *c2 = '\0';
+                                               c2++;
+                                               ast_copy_string(o->dest, c2, sizeof(o->dest));
                                        } else {
-                                               ast_log(LOG_WARNING, "Unknown keyword '%s' at line %d of %s\n", buf, lineno, fn);
+                                               ast_log(LOG_NOTICE, "Channel should be in form Tech/Dest at line %d of %s\n", lineno, fn);
+                                               o->tech[0] = '\0';
                                        }
-                               } else
-                                       ast_log(LOG_NOTICE, "Syntax error at line %d of %s\n", lineno, fn);
-                       }
+                               } else if (!strcasecmp(buf, "callerid")) {
+                                       ast_callerid_split(c, o->cid_name, sizeof(o->cid_name), o->cid_num, sizeof(o->cid_num));
+                               } else if (!strcasecmp(buf, "application")) {
+                                       ast_copy_string(o->app, c, sizeof(o->app));
+                               } else if (!strcasecmp(buf, "data")) {
+                                       ast_copy_string(o->data, c, sizeof(o->data));
+                               } else if (!strcasecmp(buf, "maxretries")) {
+                                       if (sscanf(c, "%d", &o->maxretries) != 1) {
+                                               ast_log(LOG_WARNING, "Invalid max retries at line %d of %s\n", lineno, fn);
+                                               o->maxretries = 0;
+                                       }
+                               } else if (!strcasecmp(buf, "context")) {
+                                       ast_copy_string(o->context, c, sizeof(o->context));
+                               } else if (!strcasecmp(buf, "extension")) {
+                                       ast_copy_string(o->exten, c, sizeof(o->exten));
+                               } else if (!strcasecmp(buf, "priority")) {
+                                       if ((sscanf(c, "%d", &o->priority) != 1) || (o->priority < 1)) {
+                                               ast_log(LOG_WARNING, "Invalid priority at line %d of %s\n", lineno, fn);
+                                               o->priority = 1;
+                                       }
+                               } else if (!strcasecmp(buf, "retrytime")) {
+                                       if ((sscanf(c, "%d", &o->retrytime) != 1) || (o->retrytime < 1)) {
+                                               ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
+                                               o->retrytime = 300;
+                                       }
+                               } else if (!strcasecmp(buf, "waittime")) {
+                                       if ((sscanf(c, "%d", &o->waittime) != 1) || (o->waittime < 1)) {
+                                               ast_log(LOG_WARNING, "Invalid retrytime at line %d of %s\n", lineno, fn);
+                                               o->waittime = 45;
+                                       }
+                               } else if (!strcasecmp(buf, "retry")) {
+                                       o->retries++;
+                               } else if (!strcasecmp(buf, "startretry")) {
+                                       if (sscanf(c, "%ld", &o->callingpid) != 1) {
+                                               ast_log(LOG_WARNING, "Unable to retrieve calling PID!\n");
+                                               o->callingpid = 0;
+                                       }
+                               } else if (!strcasecmp(buf, "endretry") || !strcasecmp(buf, "abortretry")) {
+                                       o->callingpid = 0;
+                                       o->retries++;
+                               } else if (!strcasecmp(buf, "delayedretry")) {
+                               } else if (!strcasecmp(buf, "setvar") || !strcasecmp(buf, "set")) {
+                                       c2 = c;
+                                       strsep(&c2, "=");
+                                       if (c2) {
+                                               var = ast_variable_new(c, c2);
+                                               if (var) {
+                                                       var->next = o->vars;
+                                                       o->vars = var;
+                                               }
+                                       } else
+                                               ast_log(LOG_WARNING, "Malformed \"%s\" argument.  Should be \"%s: variable=value\"\n", buf, buf);
+                               } else if (!strcasecmp(buf, "account")) {
+                                       ast_copy_string(o->account, c, sizeof(o->account));
+                               } else if (!strcasecmp(buf, "alwaysdelete")) {
+                                       ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ALWAYS_DELETE);
+                               } else if (!strcasecmp(buf, "archive")) {
+                                       ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ARCHIVE);
+                               } else {
+                                       ast_log(LOG_WARNING, "Unknown keyword '%s' at line %d of %s\n", buf, lineno, fn);
+                               }
+                       } else
+                               ast_log(LOG_NOTICE, "Syntax error at line %d of %s\n", lineno, fn);
+               }
        }
-       strncpy(o->fn, fn, sizeof(o->fn) - 1);
+       ast_copy_string(o->fn, fn, sizeof(o->fn));
        if (ast_strlen_zero(o->tech) || ast_strlen_zero(o->dest) || (ast_strlen_zero(o->app) && ast_strlen_zero(o->exten))) {
                ast_log(LOG_WARNING, "At least one of app or extension must be specified, along with tech and dest in file %s\n", fn);
                return -1;
@@ -206,7 +257,7 @@ static void safe_append(struct outgoing *o, time_t now, char *s)
        if (fd > -1) {
                f = fdopen(fd, "a");
                if (f) {
-                       fprintf(f, "%s: %ld %d (%ld)\n", s, (long)ast_mainpid, o->retries, (long) now);
+                       fprintf(f, "\n%s: %ld %d (%ld)\n", s, (long)ast_mainpid, o->retries, (long) now);
                        fclose(f);
                } else
                        close(fd);
@@ -218,6 +269,61 @@ static void safe_append(struct outgoing *o, time_t now, char *s)
        }
 }
 
+/*!
+ * \brief Remove a call file from the outgoing queue optionally moving it in the archive dir
+ *
+ * \param o the pointer to outgoing struct
+ * \param status the exit status of the call. Can be "Completed", "Failed" or "Expired"
+ */
+static int remove_from_queue(struct outgoing *o, const char *status)
+{
+       int fd;
+       FILE *f;
+       char newfn[256];
+       const char *bname;
+
+       if (!ast_test_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE)) {
+               struct stat current_file_status;
+
+               if (!stat(o->fn, &current_file_status))
+                       if (time(NULL) < current_file_status.st_mtime)
+                               return 0;
+       }
+
+       if (!ast_test_flag(&o->options, SPOOL_FLAG_ARCHIVE)) {
+               unlink(o->fn);
+               return 0;
+       }
+       if (ast_mkdir(qdonedir, 0777)) {
+               ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool archiving disabled\n", qdonedir);
+               unlink(o->fn);
+               return -1;
+       }
+       fd = open(o->fn, O_WRONLY|O_APPEND);
+       if (fd > -1) {
+               f = fdopen(fd, "a");
+               if (f) {
+                       fprintf(f, "Status: %s\n", status);
+                       fclose(f);
+               } else
+                       close(fd);
+       }
+
+       bname = strrchr(o->fn,'/');
+       if (bname == NULL) 
+               bname = o->fn;
+       else 
+               bname++;        
+       snprintf(newfn, sizeof(newfn), "%s/%s", qdonedir, bname);
+       /* a existing call file the archive dir is overwritten */
+       unlink(newfn);
+       if (rename(o->fn, newfn) != 0) {
+               unlink(o->fn);
+               return -1;
+       } else
+               return 0;
+}
+
 static void *attempt_thread(void *data)
 {
        struct outgoing *o = data;
@@ -225,18 +331,18 @@ static void *attempt_thread(void *data)
        if (!ast_strlen_zero(o->app)) {
                if (option_verbose > 2)
                        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);
-               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->variable, o->account, NULL);
+               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, o->account, NULL);
        } else {
                if (option_verbose > 2)
                        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);
-               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->variable, o->account, NULL);
+               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, o->account, NULL);
        }
        if (res) {
                ast_log(LOG_NOTICE, "Call failed to go through, reason %d\n", reason);
                if (o->retries >= o->maxretries + 1) {
                        /* Max retries exceeded */
                        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" : "");
-                       unlink(o->fn);
+                       remove_from_queue(o, "Expired");
                } else {
                        /* Notate that the call is still active */
                        safe_append(o, time(NULL), "EndRetry");
@@ -244,21 +350,20 @@ static void *attempt_thread(void *data)
        } else {
                ast_log(LOG_NOTICE, "Call completed to %s/%s\n", o->tech, o->dest);
                ast_log(LOG_EVENT, "Queued call to %s/%s completed\n", o->tech, o->dest);
-               unlink(o->fn);
+               remove_from_queue(o, "Completed");
        }
-       free(o);
+       free_outgoing(o);
        return NULL;
 }
 
 static void launch_service(struct outgoing *o)
 {
        pthread_t t;
-       pthread_attr_t attr;
-       pthread_attr_init(&attr);
-       pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
-       if (ast_pthread_create(&t,&attr,attempt_thread, o) == -1) {
-               ast_log(LOG_WARNING, "Unable to create thread :(\n");
-               free(o);
+       int ret;
+
+       if ((ret = ast_pthread_create_detached(&t, NULL, attempt_thread, o))) {
+               ast_log(LOG_WARNING, "Unable to create thread :( (returned error: %d)\n", ret);
+               free_outgoing(o);
        }
 }
 
@@ -277,9 +382,11 @@ static int scan_service(char *fn, time_t now, time_t atime)
 #endif
                                fclose(f);
                                if (o->retries <= o->maxretries) {
+                                       now += o->retrytime;
                                        if (o->callingpid && (o->callingpid == ast_mainpid)) {
                                                safe_append(o, time(NULL), "DelayedRetry");
                                                ast_log(LOG_DEBUG, "Delaying retry since we're currently running '%s'\n", o->fn);
+                                               free_outgoing(o);
                                        } else {
                                                /* Increment retries */
                                                o->retries++;
@@ -291,24 +398,23 @@ static int scan_service(char *fn, time_t now, time_t atime)
                                                safe_append(o, now, "StartRetry");
                                                launch_service(o);
                                        }
-                                       now += o->retrytime;
                                        return now;
                                } else {
                                        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" : "");
-                                       free(o);
-                                       unlink(fn);
+                                       remove_from_queue(o, "Expired");
+                                       free_outgoing(o);
                                        return 0;
                                }
                        } else {
-                               free(o);
+                               remove_from_queue(o, "Failed");
+                               free_outgoing(o);
                                ast_log(LOG_WARNING, "Invalid file contents in %s, deleting\n", fn);
                                fclose(f);
-                               unlink(fn);
                        }
                } else {
-                       free(o);
+                       remove_from_queue(o, "Failed");
+                       free_outgoing(o);
                        ast_log(LOG_WARNING, "Unable to open %s: %s, deleting\n", fn, strerror(errno));
-                       unlink(fn);
                }
        } else
                ast_log(LOG_WARNING, "Out of memory :(\n");
@@ -369,40 +475,28 @@ static void *scan_thread(void *unused)
        return NULL;
 }
 
-int unload_module(void)
+static int unload_module(void)
 {
        return -1;
 }
 
-int load_module(void)
+static int load_module(void)
 {
        pthread_t thread;
-       pthread_attr_t attr;
+       int ret;
        snprintf(qdir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing");
-       if (mkdir(qdir, 0700) && (errno != EEXIST)) {
+       if (ast_mkdir(qdir, 0777)) {
                ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool disabled\n", qdir);
                return 0;
        }
-       pthread_attr_init(&attr);
-       pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED);
-       if (ast_pthread_create(&thread,&attr,scan_thread, NULL) == -1) {
-               ast_log(LOG_WARNING, "Unable to create thread :(\n");
+       snprintf(qdonedir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing_done");
+
+       if ((ret = ast_pthread_create_detached_background(&thread, NULL, scan_thread, NULL))) {
+               ast_log(LOG_WARNING, "Unable to create thread :( (returned error: %d)\n", ret);
                return -1;
        }
-       return 0;
-}
-
-char *description(void)
-{
-       return tdesc;
-}
 
-int usecount(void)
-{
-       return 1;
+       return 0;
 }
 
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Outgoing Spool Support");