Merge in ast_strftime branch, which changes timestamps to be accurate to the microsec...
[asterisk/asterisk.git] / funcs / func_strings.c
index 16c9962..c44c499 100644 (file)
  *
  * \author Tilghman Lesher
  * \author Anothony Minessale II 
+ * \ingroup functions
  */
 
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include <sys/types.h>
 #include <regex.h>
 
-#include "asterisk.h"
-
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include "asterisk/module.h"
+#include "asterisk/options.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/logger.h"
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
 #include "asterisk/localtime.h"
+#include "asterisk/options.h"
 
-static int function_fieldqty(struct ast_channel *chan, char *cmd,
+static int function_fieldqty(struct ast_channel *chan, const char *cmd,
                             char *parse, char *buf, size_t len)
 {
-       char *varval;
+       char *varsubst, varval[8192] = "", *varval2 = varval;
        int fieldcount = 0;
        AST_DECLARE_APP_ARGS(args,
                             AST_APP_ARG(varname);
@@ -54,9 +57,26 @@ static int function_fieldqty(struct ast_channel *chan, char *cmd,
 
        AST_STANDARD_APP_ARGS(args, parse);
        if (args.delim) {
-               pbx_retrieve_variable(chan, args.varname, &varval, buf, len, NULL);
-               while (strsep(&varval, args.delim))
-                       fieldcount++;
+               if (args.delim[0] == '\\') {
+                       if (args.delim[1] == 'n')
+                               ast_copy_string(args.delim, "\n", 2);
+                       else if (args.delim[1] == 't')
+                               ast_copy_string(args.delim, "\t", 2);
+                       else if (args.delim[1])
+                               ast_copy_string(args.delim, &args.delim[1], 2);
+                       else
+                               ast_copy_string(args.delim, "-", 2);
+               }
+               varsubst = alloca(strlen(args.varname) + 4);
+
+               sprintf(varsubst, "${%s}", args.varname);
+               pbx_substitute_variables_helper(chan, varsubst, varval, sizeof(varval) - 1);
+               if (ast_strlen_zero(varval2))
+                       fieldcount = 0;
+               else {
+                       while (strsep(&varval2, args.delim))
+                               fieldcount++;
+               }
        } else {
                fieldcount = 1;
        }
@@ -68,11 +88,11 @@ static int function_fieldqty(struct ast_channel *chan, char *cmd,
 static struct ast_custom_function fieldqty_function = {
        .name = "FIELDQTY",
        .synopsis = "Count the fields, with an arbitrary delimiter",
-       .syntax = "FIELDQTY(<varname>,<delim>)",
+       .syntax = "FIELDQTY(<varname>|<delim>)",
        .read = function_fieldqty,
 };
 
-static int filter(struct ast_channel *chan, char *cmd, char *parse, char *buf,
+static int filter(struct ast_channel *chan, const char *cmd, char *parse, char *buf,
                  size_t len)
 {
        AST_DECLARE_APP_ARGS(args,
@@ -84,7 +104,7 @@ static int filter(struct ast_channel *chan, char *cmd, char *parse, char *buf,
        AST_STANDARD_APP_ARGS(args, parse);
 
        if (!args.string) {
-               ast_log(LOG_ERROR, "Usage: FILTER(<allowed-chars>,<string>)\n");
+               ast_log(LOG_ERROR, "Usage: FILTER(<allowed-chars>|<string>)\n");
                return -1;
        }
 
@@ -100,11 +120,11 @@ static int filter(struct ast_channel *chan, char *cmd, char *parse, char *buf,
 static struct ast_custom_function filter_function = {
        .name = "FILTER",
        .synopsis = "Filter the string to include only the allowed characters",
-       .syntax = "FILTER(<allowed-chars>,<string>)",
+       .syntax = "FILTER(<allowed-chars>|<string>)",
        .read = filter,
 };
 
-static int regex(struct ast_channel *chan, char *cmd, char *parse, char *buf,
+static int regex(struct ast_channel *chan, const char *cmd, char *parse, char *buf,
                 size_t len)
 {
        AST_DECLARE_APP_ARGS(args,
@@ -119,16 +139,23 @@ static int regex(struct ast_channel *chan, char *cmd, char *parse, char *buf,
 
        AST_NONSTANDARD_APP_ARGS(args, parse, '"');
 
-       ast_log(LOG_DEBUG, "FUNCTION REGEX (%s)(%s)\n", args.reg, args.str);
+       if (args.argc != 3) {
+               ast_log(LOG_ERROR, "Unexpected arguments: should have been in the form '\"<regex>\" <string>'\n");
+               return -1;
+       }
+       if ((*args.str == ' ') || (*args.str == '\t'))
+               args.str++;
+
+       ast_debug(1, "FUNCTION REGEX (%s)(%s)\n", args.reg, args.str);
 
        if ((errcode = regcomp(&regexbuf, args.reg, REG_EXTENDED | REG_NOSUB))) {
                regerror(errcode, &regexbuf, buf, len);
                ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, parse, buf);
                return -1;
-       } else {
-               if (!regexec(&regexbuf, args.str, 0, NULL, 0))
-                       strcpy(buf, "1");
        }
+       
+       strcpy(buf, regexec(&regexbuf, args.str, 0, NULL, 0) ? "0" : "1");
+
        regfree(&regexbuf);
 
        return 0;
@@ -136,13 +163,48 @@ static int regex(struct ast_channel *chan, char *cmd, char *parse, char *buf,
 
 static struct ast_custom_function regex_function = {
        .name = "REGEX",
-       .synopsis =
-               "Regular Expression: Returns 1 if data matches regular expression.",
+       .synopsis = "Regular Expression",
+       .desc =  
+               "Returns 1 if data matches regular expression, or 0 otherwise.\n"
+               "Please note that the space following the double quotes separating the regex from the data\n"
+               "is optional and if present, is skipped. If a space is desired at the beginning of the data,\n"
+               "then put two spaces there; the second will not be skipped.\n",
        .syntax = "REGEX(\"<regular expression>\" <data>)",
        .read = regex,
 };
 
-static int array(struct ast_channel *chan, char *cmd, char *var,
+#define HASH_PREFIX    "~HASH~%s~"
+#define HASH_FORMAT    HASH_PREFIX "%s~"
+
+static char *app_clearhash = "ClearHash";
+static char *syn_clearhash = "Clear the keys from a specified hashname";
+static char *desc_clearhash =
+"ClearHash(<hashname>)\n"
+"  Clears all keys out of the specified hashname\n";
+
+/* This function probably should migrate to main/pbx.c, as pbx_builtin_clearvar_prefix() */
+static void clearvar_prefix(struct ast_channel *chan, const char *prefix)
+{
+       struct ast_var_t *var;
+       int len = strlen(prefix);
+       AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->varshead, var, entries) {
+               if (strncasecmp(prefix, ast_var_name(var), len) == 0) {
+                       AST_LIST_REMOVE_CURRENT(&chan->varshead, entries);
+                       ast_free(var);
+               }
+       }
+       AST_LIST_TRAVERSE_SAFE_END
+}
+
+static int exec_clearhash(struct ast_channel *chan, void *data)
+{
+       char prefix[80];
+       snprintf(prefix, sizeof(prefix), HASH_PREFIX, data ? (char *)data : "null");
+       clearvar_prefix(chan, prefix);
+       return 0;
+}
+
+static int array(struct ast_channel *chan, const char *cmd, char *var,
                 const char *value)
 {
        AST_DECLARE_APP_ARGS(arg1,
@@ -151,20 +213,30 @@ static int array(struct ast_channel *chan, char *cmd, char *var,
        AST_DECLARE_APP_ARGS(arg2,
                             AST_APP_ARG(val)[100];
        );
-       char *value2;
-       int i;
+       char *origvar = "", *value2, varname[256];
+       int i, ishash = 0;
 
        value2 = ast_strdupa(value);
        if (!var || !value2)
                return -1;
 
+       if (!strcmp(cmd, "HASH")) {
+               const char *var2 = pbx_builtin_getvar_helper(chan, "~ODBCFIELDS~");
+               origvar = var;
+               if (var2)
+                       var = ast_strdupa(var2);
+               else
+                       return -1;
+               ishash = 1;
+       }
+
        /* The functions this will generally be used with are SORT and ODBC_*, which
         * both return comma-delimited lists.  However, if somebody uses literal lists,
         * their commas will be translated to vertical bars by the load, and I don't
         * want them to be surprised by the result.  Hence, we prefer commas as the
         * delimiter, but we'll fall back to vertical bars if commas aren't found.
         */
-       ast_log(LOG_DEBUG, "array (%s=%s)\n", var, value2);
+       ast_debug(1, "array (%s=%s)\n", var, value2);
        if (strchr(var, ','))
                AST_NONSTANDARD_APP_ARGS(arg1, var, ',');
        else
@@ -176,35 +248,157 @@ static int array(struct ast_channel *chan, char *cmd, char *var,
                AST_STANDARD_APP_ARGS(arg2, value2);
 
        for (i = 0; i < arg1.argc; i++) {
-               ast_log(LOG_DEBUG, "array set value (%s=%s)\n", arg1.var[i],
-                       arg2.val[i]);
+               ast_debug(1, "array set value (%s=%s)\n", arg1.var[i],
+                               arg2.val[i]);
                if (i < arg2.argc) {
-                       pbx_builtin_setvar_helper(chan, arg1.var[i], arg2.val[i]);
+                       if (ishash) {
+                               snprintf(varname, sizeof(varname), HASH_FORMAT, origvar, arg1.var[i]);
+                               pbx_builtin_setvar_helper(chan, varname, arg2.val[i]);
+                       } else {
+                               pbx_builtin_setvar_helper(chan, arg1.var[i], arg2.val[i]);
+                       }
                } else {
                        /* We could unset the variable, by passing a NULL, but due to
                         * pushvar semantics, that could create some undesired behavior. */
-                       pbx_builtin_setvar_helper(chan, arg1.var[i], "");
+                       if (ishash) {
+                               snprintf(varname, sizeof(varname), HASH_FORMAT, origvar, arg1.var[i]);
+                               pbx_builtin_setvar_helper(chan, varname, "");
+                       } else {
+                               pbx_builtin_setvar_helper(chan, arg1.var[i], "");
+                       }
+               }
+       }
+
+       return 0;
+}
+
+static int hashkeys_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
+{
+       struct ast_var_t *newvar;
+       int plen;
+       char prefix[80];
+       snprintf(prefix, sizeof(prefix), HASH_PREFIX, data);
+       plen = strlen(prefix);
+
+       memset(buf, 0, len);
+       AST_LIST_TRAVERSE(&chan->varshead, newvar, entries) {
+               if (strncasecmp(prefix, ast_var_name(newvar), plen) == 0) {
+                       /* Copy everything after the prefix */
+                       strncat(buf, ast_var_name(newvar) + plen, len);
+                       /* Trim the trailing ~ */
+                       buf[strlen(buf) - 1] = ',';
+               }
+       }
+       /* Trim the trailing comma */
+       buf[strlen(buf) - 1] = '\0';
+       return 0;
+}
+
+static int hash_write(struct ast_channel *chan, const char *cmd, char *var, const char *value)
+{
+       char varname[256];
+       AST_DECLARE_APP_ARGS(arg,
+               AST_APP_ARG(hashname);
+               AST_APP_ARG(hashkey);
+       );
+
+       if (!strchr(var, '|')) {
+               /* Single argument version */
+               return array(chan, "HASH", var, value);
+       }
+
+       AST_STANDARD_APP_ARGS(arg, var);
+       snprintf(varname, sizeof(varname), HASH_FORMAT, arg.hashname, arg.hashkey);
+       pbx_builtin_setvar_helper(chan, varname, value);
+
+       return 0;
+}
+
+static int hash_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
+{
+       char varname[256];
+       const char *varvalue;
+       AST_DECLARE_APP_ARGS(arg,
+               AST_APP_ARG(hashname);
+               AST_APP_ARG(hashkey);
+       );
+
+       AST_STANDARD_APP_ARGS(arg, data);
+       if (arg.argc == 2) {
+               snprintf(varname, sizeof(varname), HASH_FORMAT, arg.hashname, arg.hashkey);
+               varvalue = pbx_builtin_getvar_helper(chan, varname);
+               if (varvalue)
+                       ast_copy_string(buf, varvalue, len);
+               else
+                       *buf = '\0';
+       } else if (arg.argc == 1) {
+               char colnames[4096];
+               int i;
+               AST_DECLARE_APP_ARGS(arg2,
+                       AST_APP_ARG(col)[100];
+               );
+
+               /* Get column names, in no particular order */
+               hashkeys_read(chan, "HASHKEYS", arg.hashname, colnames, sizeof(colnames));
+               pbx_builtin_setvar_helper(chan, "~ODBCFIELDS~", colnames);
+
+               AST_NONSTANDARD_APP_ARGS(arg2, colnames, ',');
+               *buf = '\0';
+
+               /* Now get the corresponding column values, in exactly the same order */
+               for (i = 0; i < arg2.argc; i++) {
+                       snprintf(varname, sizeof(varname), HASH_FORMAT, arg.hashname, arg2.col[i]);
+                       varvalue = pbx_builtin_getvar_helper(chan, varname);
+                       strncat(buf, varvalue, len);
+                       strncat(buf, ",", len);
                }
+
+               /* Strip trailing comma */
+               buf[strlen(buf) - 1] = '\0';
        }
 
        return 0;
 }
 
+static struct ast_custom_function hash_function = {
+       .name = "HASH",
+       .synopsis = "Implementation of a dialplan associative array",
+       .syntax = "HASH(hashname[|hashkey])",
+       .write = hash_write,
+       .read = hash_read,
+       .desc =
+               "In two argument mode, gets and sets values to corresponding keys within a named\n"
+               "associative array.  The single-argument mode will only work when assigned to from\n"
+               "a function defined by func_odbc.so.\n",
+};
+
+static struct ast_custom_function hashkeys_function = {
+       .name = "HASHKEYS",
+       .synopsis = "Retrieve the keys of a HASH()",
+       .syntax = "HASHKEYS(<hashname>)",
+       .read = hashkeys_read,
+       .desc =
+               "Returns a comma-delimited list of the current keys of an associative array\n"
+               "defined by the HASH() function.  Note that if you iterate over the keys of\n"
+               "the result, adding keys during iteration will cause the result of the HASHKEYS\n"
+               "function to change.\n",
+};
+
 static struct ast_custom_function array_function = {
        .name = "ARRAY",
        .synopsis = "Allows setting multiple variables at once",
-       .syntax = "ARRAY(var1[,var2[...][,varN]])",
+       .syntax = "ARRAY(var1[|var2[...][|varN]])",
        .write = array,
        .desc =
                "The comma-separated list passed as a value to which the function is set will\n"
                "be interpreted as a set of values to which the comma-separated list of\n"
                "variable names in the argument should be set.\n"
-               "Hence, Set(ARRAY(var1,var2)=1,2) will set var1 to 1 and var2 to 2\n"
+               "Hence, Set(ARRAY(var1|var2)=1\\,2) will set var1 to 1 and var2 to 2\n"
                "Note: remember to either backslash your commas in extensions.conf or quote the\n"
                "entire argument, since Set can take multiple arguments itself.\n",
 };
 
-static int acf_sprintf(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
+static int acf_sprintf(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 {
 #define SPRINTF_FLAG   0
 #define SPRINTF_WIDTH  1
@@ -265,7 +459,7 @@ static int acf_sprintf(struct ast_channel *chan, char *cmd, char *data, char *bu
                                formatbuf[&arg.format[i] - formatstart + 1] = '\0';
 
                                /* Convert the argument into the required type */
-                               if (sscanf(arg.var[argcount++], "%i", &tmpi) != 1) {
+                               if (sscanf(arg.var[argcount++], "%d", &tmpi) != 1) {
                                        ast_log(LOG_ERROR, "Argument '%s' is not an integer number for format '%s'\n", arg.var[argcount - 1], formatbuf);
                                        goto sprintf_fail;
                                }
@@ -339,7 +533,7 @@ sprintf_fail:
 static struct ast_custom_function sprintf_function = {
        .name = "SPRINTF",
        .synopsis = "Format a variable according to a format string",
-       .syntax = "SPRINTF(<format>,<arg1>[,...<argN>])",
+       .syntax = "SPRINTF(<format>|<arg1>[|...<argN>])",
        .read = acf_sprintf,
        .desc =
 "Parses the format string specified and returns a string matching that format.\n"
@@ -347,7 +541,7 @@ static struct ast_custom_function sprintf_function = {
 "a format specifier is not recognized.\n",
 };
 
-static int quote(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
+static int quote(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 {
        char *bufptr = buf, *dataptr = data;
        *bufptr++ = '"';
@@ -377,7 +571,7 @@ static struct ast_custom_function quote_function = {
 };
 
 
-static int len(struct ast_channel *chan, char *cmd, char *data, char *buf,
+static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf,
               size_t len)
 {
        int length = 0;
@@ -397,7 +591,7 @@ static struct ast_custom_function len_function = {
        .read = len,
 };
 
-static int acf_strftime(struct ast_channel *chan, char *cmd, char *parse,
+static int acf_strftime(struct ast_channel *chan, const char *cmd, char *parse,
                        char *buf, size_t len)
 {
        AST_DECLARE_APP_ARGS(args,
@@ -405,26 +599,20 @@ static int acf_strftime(struct ast_channel *chan, char *cmd, char *parse,
                             AST_APP_ARG(timezone);
                             AST_APP_ARG(format);
        );
-       time_t epochi;
-       struct tm tm;
+       struct timeval tv;
+       struct ast_tm tm;
 
        buf[0] = '\0';
 
-       if (ast_strlen_zero(parse)) {
-               ast_log(LOG_ERROR,
-                               "Asterisk function STRFTIME() requires an argument.\n");
-               return -1;
-       }
-
        AST_STANDARD_APP_ARGS(args, parse);
 
-       ast_get_time_t(args.epoch, &epochi, time(NULL), NULL);
-       ast_localtime(&epochi, &tm, args.timezone);
+       ast_get_timeval(args.epoch, &tv, ast_tvnow(), NULL);
+       ast_localtime(&tv, &tm, args.timezone);
 
        if (!args.format)
                args.format = "%c";
 
-       if (!strftime(buf, len, args.format, &tm))
+       if (ast_strftime(buf, len, args.format, &tm) <= 0)
                ast_log(LOG_WARNING, "C function strftime() output nothing?!!\n");
 
        buf[len - 1] = '\0';
@@ -435,11 +623,19 @@ static int acf_strftime(struct ast_channel *chan, char *cmd, char *parse,
 static struct ast_custom_function strftime_function = {
        .name = "STRFTIME",
        .synopsis = "Returns the current date/time in a specified format.",
-       .syntax = "STRFTIME([<epoch>][,[timezone][,format]])",
+       .syntax = "STRFTIME([<epoch>][|[timezone][|format]])",
+       .desc =
+"STRFTIME sports all of the same formats as the underlying C function\n"
+"strftime(3) - see the man page for details.  It also supports the\n"
+"following format:\n"
+" %[n]q - fractions of a second, with leading zeroes.  For example, %3q will\n"
+"         give milliseconds and %1q will give tenths of a second.  The default\n"
+"         is to output milliseconds (n=3).  The common case is to use it in\n"
+"         combination with %S, as in \"%S.%3q\".\n",
        .read = acf_strftime,
 };
 
-static int acf_strptime(struct ast_channel *chan, char *cmd, char *data,
+static int acf_strptime(struct ast_channel *chan, const char *cmd, char *data,
                        char *buf, size_t len)
 {
        AST_DECLARE_APP_ARGS(args,
@@ -447,9 +643,10 @@ static int acf_strptime(struct ast_channel *chan, char *cmd, char *data,
                             AST_APP_ARG(timezone);
                             AST_APP_ARG(format);
        );
-       struct tm time;
-
-       memset(&time, 0, sizeof(struct tm));
+       union {
+               struct ast_tm atm;
+               struct tm time;
+       } t = { { 0, }, };
 
        buf[0] = '\0';
 
@@ -467,10 +664,10 @@ static int acf_strptime(struct ast_channel *chan, char *cmd, char *data,
                return -1;
        }
 
-       if (!strptime(args.timestring, args.format, &time)) {
+       if (!strptime(args.timestring, args.format, &t.time)) {
                ast_log(LOG_WARNING, "C function strptime() output nothing?!!\n");
        } else {
-               snprintf(buf, len, "%d", (int) ast_mktime(&time, args.timezone));
+               snprintf(buf, len, "%d", (int) ast_mktime(&t.atm, args.timezone));
        }
 
        return 0;
@@ -491,10 +688,10 @@ static struct ast_custom_function strptime_function = {
        .read = acf_strptime,
 };
 
-static int function_eval(struct ast_channel *chan, char *cmd, char *data,
+static int function_eval(struct ast_channel *chan, const char *cmd, char *data,
                         char *buf, size_t len)
 {
-       buf[0] = '\0';
+       memset(buf, 0, len);
 
        if (ast_strlen_zero(data)) {
                ast_log(LOG_WARNING, "EVAL requires an argument: EVAL(<string>)\n");
@@ -522,7 +719,7 @@ static struct ast_custom_function eval_function = {
        .read = function_eval,
 };
 
-static int keypadhash(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
+static int keypadhash(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 {
        char *bufptr, *dataptr;
 
@@ -565,9 +762,7 @@ static struct ast_custom_function keypadhash_function = {
        .desc = "Example:  ${KEYPADHASH(Les)} returns \"537\"\n",
 };
 
-static char *tdesc = "String handling dialplan functions";
-
-static int unload_module(void *mod)
+static int unload_module(void)
 {
        int res = 0;
 
@@ -582,11 +777,14 @@ static int unload_module(void *mod)
        res |= ast_custom_function_unregister(&eval_function);
        res |= ast_custom_function_unregister(&keypadhash_function);
        res |= ast_custom_function_unregister(&sprintf_function);
+       res |= ast_custom_function_unregister(&hashkeys_function);
+       res |= ast_custom_function_unregister(&hash_function);
+       res |= ast_unregister_application(app_clearhash);
 
        return res;
 }
 
-static int load_module(void *mod)
+static int load_module(void)
 {
        int res = 0;
 
@@ -601,19 +799,11 @@ static int load_module(void *mod)
        res |= ast_custom_function_register(&eval_function);
        res |= ast_custom_function_register(&keypadhash_function);
        res |= ast_custom_function_register(&sprintf_function);
+       res |= ast_custom_function_register(&hashkeys_function);
+       res |= ast_custom_function_register(&hash_function);
+       res |= ast_register_application(app_clearhash, exec_clearhash, syn_clearhash, desc_clearhash);
 
        return res;
 }
 
-static const char *description(void)
-{
-       return tdesc;
-}
-
-
-static const char *key(void)
-{
-       return ASTERISK_GPL_KEY;
-}
-
-STD_MOD(MOD_1 | NO_USECOUNT, NULL, NULL, NULL);
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "String handling dialplan functions");