More 'static' qualifiers on module global variables.
[asterisk/asterisk.git] / pbx / pbx_spool.c
index 6a037fd..ca73933 100644 (file)
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
 #include <sys/stat.h>
-#include <errno.h>
 #include <time.h>
 #include <utime.h>
-#include <stdlib.h>
-#include <unistd.h>
 #include <dirent.h>
-#include <string.h>
-#include <string.h>
-#include <stdio.h>
-#include <unistd.h>
 
+#include "asterisk/paths.h"    /* use ast_config_AST_SPOOL_DIR */
 #include "asterisk/lock.h"
 #include "asterisk/file.h"
 #include "asterisk/logger.h"
@@ -45,8 +39,8 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/callerid.h"
 #include "asterisk/pbx.h"
 #include "asterisk/module.h"
-#include "asterisk/options.h"
 #include "asterisk/utils.h"
+#include "asterisk/options.h"
 
 /*
  * pbx_spool is similar in spirit to qcall, but with substantially enhanced functionality...
@@ -67,58 +61,49 @@ static char qdir[255];
 static char qdonedir[255];
 
 struct outgoing {
-       char fn[256];
-       /*! Current number of retries */
-       int retries;
-       /*! Maximum number of retries permitted */
-       int maxretries;
-       /*! How long to wait between retries (in seconds) */
-       int retrytime;
-       /*! How long to wait for an answer */
-       int waittime;
-       /*! PID which is currently calling */
-       long callingpid;
-       
-       /*! What to connect to outgoing */
-       char tech[256];
-       char dest[256];
-       
-       /* If application */
-       char app[256];
-       char data[256];
-
-       /* If extension/context/priority */
-       char exten[AST_MAX_EXTENSION];
-       char context[AST_MAX_CONTEXT];
-       int priority;
-
-       /* CallerID Information */
-       char cid_num[256];
-       char cid_name[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;
+       int retries;                              /*!< Current number of retries */
+       int maxretries;                           /*!< Maximum number of retries permitted */
+       int retrytime;                            /*!< How long to wait between retries (in seconds) */
+       int waittime;                             /*!< How long to wait for an answer */
+       long callingpid;                          /*!< PID which is currently calling */
+       int format;                               /*!< Formats (codecs) for this call */
+       AST_DECLARE_STRING_FIELDS (
+               AST_STRING_FIELD(fn);                 /*!< File name of call file */
+               AST_STRING_FIELD(tech);               /*!< Which channel technology to use for outgoing call */
+               AST_STRING_FIELD(dest);               /*!< Which device/line to use for outgoing call */
+               AST_STRING_FIELD(app);                /*!< If application: Application name */
+               AST_STRING_FIELD(data);               /*!< If application: Application data */
+               AST_STRING_FIELD(exten);              /*!< If extension/context/priority: Extension in dialplan */
+               AST_STRING_FIELD(context);            /*!< If extension/context/priority: Dialplan context */
+               AST_STRING_FIELD(cid_num);            /*!< CallerID Information: Number/extension */
+               AST_STRING_FIELD(cid_name);           /*!< CallerID Information: Name */
+               AST_STRING_FIELD(account);            /*!< account code */
+       );
+       int priority;                             /*!< If extension/context/priority: Dialplan priority */
+       struct ast_variable *vars;                /*!< Variables and Functions */
+       int maxlen;                               /*!< Maximum length of call */
+       struct ast_flags options;                 /*!< options */
 };
 
-static void init_outgoing(struct outgoing *o)
+static int init_outgoing(struct outgoing *o)
 {
        o->priority = 1;
        o->retrytime = 300;
        o->waittime = 45;
+       o->format = AST_FORMAT_SLINEAR;
        ast_set_flag(&o->options, SPOOL_FLAG_ALWAYS_DELETE);
+       if (ast_string_field_init(o, 128)) {
+               return -1;
+       }
+       return 0;
 }
 
 static void free_outgoing(struct outgoing *o)
 {
+       if (o->vars) {
+               ast_variables_destroy(o->vars);
+       }
+       ast_string_field_free_memory(o);
        ast_free(o);
 }
 
@@ -127,7 +112,11 @@ static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
        char buf[256];
        char *c, *c2;
        int lineno = 0;
-       struct ast_variable *var;
+       struct ast_variable *var, *last = o->vars;
+
+       while (last && last->next) {
+               last = last->next;
+       }
 
        while(fgets(buf, sizeof(buf), f)) {
                lineno++;
@@ -165,30 +154,34 @@ static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
                                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, '/'))) {
+                                       if ((c2 = strchr(c, '/'))) {
                                                *c2 = '\0';
                                                c2++;
-                                               ast_copy_string(o->dest, c2, sizeof(o->dest));
+                                               ast_string_field_set(o, tech, c);
+                                               ast_string_field_set(o, dest, c2);
                                        } 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));
+                                       char cid_name[80] = {0}, cid_num[80] = {0};
+                                       ast_callerid_split(c, cid_name, sizeof(cid_name), cid_num, sizeof(cid_num));
+                                       ast_string_field_set(o, cid_num, cid_num);
+                                       ast_string_field_set(o, cid_name, cid_name);
                                } else if (!strcasecmp(buf, "application")) {
-                                       ast_copy_string(o->app, c, sizeof(o->app));
+                                       ast_string_field_set(o, app, c);
                                } else if (!strcasecmp(buf, "data")) {
-                                       ast_copy_string(o->data, c, sizeof(o->data));
+                                       ast_string_field_set(o, data, c);
                                } 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, "codecs")) {
+                                       ast_parse_allow_disallow(NULL, &o->format, c, 1);
                                } else if (!strcasecmp(buf, "context")) {
-                                       ast_copy_string(o->context, c, sizeof(o->context));
+                                       ast_string_field_set(o, context, c);
                                } else if (!strcasecmp(buf, "extension")) {
-                                       ast_copy_string(o->exten, c, sizeof(o->exten));
+                                       ast_string_field_set(o, exten, c);
                                } 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);
@@ -201,7 +194,7 @@ static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
                                        }
                                } 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);
+                                               ast_log(LOG_WARNING, "Invalid waittime at line %d of %s\n", lineno, fn);
                                                o->waittime = 45;
                                        }
                                } else if (!strcasecmp(buf, "retry")) {
@@ -219,15 +212,20 @@ static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
                                        c2 = c;
                                        strsep(&c2, "=");
                                        if (c2) {
-                                               var = ast_variable_new(c, c2);
+                                               var = ast_variable_new(c, c2, fn);
                                                if (var) {
-                                                       var->next = o->vars;
-                                                       o->vars = var;
+                                                       /* Always insert at the end, because some people want to treat the spool file as a script */
+                                                       if (last) {
+                                                               last->next = var;
+                                                       } else {
+                                                               o->vars = var;
+                                                       }
+                                                       last = 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));
+                                       ast_string_field_set(o, account, c);
                                } else if (!strcasecmp(buf, "alwaysdelete")) {
                                        ast_set2_flag(&o->options, ast_true(c), SPOOL_FLAG_ALWAYS_DELETE);
                                } else if (!strcasecmp(buf, "archive")) {
@@ -239,7 +237,7 @@ static int apply_outgoing(struct outgoing *o, char *fn, FILE *f)
                                ast_log(LOG_NOTICE, "Syntax error at line %d of %s\n", lineno, fn);
                }
        }
-       ast_copy_string(o->fn, fn, sizeof(o->fn));
+       ast_string_field_set(o, fn, 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;
@@ -330,16 +328,18 @@ static void *attempt_thread(void *data)
        int res, reason;
        if (!ast_strlen_zero(o->app)) {
                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);
-               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);
+               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);
+               o->vars = NULL;
        } else {
                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);
-               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);
+               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);
+               o->vars = NULL;
        }
        if (res) {
-               ast_log(LOG_NOTICE, "Call failed to go through, reason %d\n", reason);
+               ast_log(LOG_NOTICE, "Call failed to go through, reason (%d) %s\n", reason, ast_channel_reason2str(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" : "");
+                       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" : "");
                        remove_from_queue(o, "Expired");
                } else {
                        /* Notate that the call is still active */
@@ -347,7 +347,6 @@ 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);
                remove_from_queue(o, "Completed");
        }
        free_outgoing(o);
@@ -376,7 +375,14 @@ static int scan_service(char *fn, time_t now, time_t atime)
                return -1;
        }
        
-       init_outgoing(o);
+       if (init_outgoing(o)) {
+               /* No need to call free_outgoing here since we know the failure
+                * was to allocate string fields and no variables have been allocated
+                * yet.
+                */
+               ast_free(o);
+               return -1;
+       }
 
        /* Attempt to open the file */
        if (!(f = fopen(fn, "r+"))) {
@@ -418,7 +424,7 @@ static int scan_service(char *fn, time_t now, time_t atime)
                }
                res = 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" : "");
+               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" : "");
                remove_from_queue(o, "Expired");
                free_outgoing(o);
        }
@@ -434,10 +440,15 @@ static void *scan_thread(void *unused)
        char fn[256];
        int res;
        time_t last = 0, next = 0, now;
+       struct timespec ts = { .tv_sec = 1 };
+  
+       while (!ast_fully_booted) {
+               nanosleep(&ts, NULL);
+       }
 
        for(;;) {
                /* Wait a sec */
-               sleep(1);
+               nanosleep(&ts, NULL);
                time(&now);
 
                if (stat(qdir, &st)) {
@@ -452,7 +463,7 @@ static void *scan_thread(void *unused)
 #if 0
                printf("atime: %ld, mtime: %ld, ctime: %ld\n", st.st_atime, st.st_mtime, st.st_ctime);
                printf("Ooh, something changed / timeout\n");
-#endif                         
+#endif
                next = 0;
                last = st.st_mtime;
 
@@ -476,8 +487,12 @@ static void *scan_thread(void *unused)
                                        if (!next || (res < next)) {
                                                next = res;
                                        }
-                               } else if (res)
+                               } else if (res) {
                                        ast_log(LOG_WARNING, "Failed to scan service '%s'\n", fn);
+                               } else if (!next) {
+                                       /* Expired entry: must recheck on the next go-around */
+                                       next = st.st_mtime;
+                               }
                        } else {
                                /* Update "next" update if necessary */
                                if (!next || (st.st_mtime < next))
@@ -501,16 +516,16 @@ static int load_module(void)
        snprintf(qdir, sizeof(qdir), "%s/%s", ast_config_AST_SPOOL_DIR, "outgoing");
        if (ast_mkdir(qdir, 0777)) {
                ast_log(LOG_WARNING, "Unable to create queue directory %s -- outgoing spool disabled\n", qdir);
-               return 0;
+               return AST_MODULE_LOAD_DECLINE;
        }
        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 AST_MODULE_LOAD_FAILURE;
        }
 
-       return 0;
+       return AST_MODULE_LOAD_SUCCESS;
 }
 
 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Outgoing Spool Support");