Merge "contrib/sip_to_pjsip: handle setvar in conversion"
[asterisk/asterisk.git] / funcs / func_strings.c
index 5bf687b..cb25385 100644 (file)
@@ -21,7 +21,7 @@
  * \brief String manipulation dialplan functions
  *
  * \author Tilghman Lesher
- * \author Anothony Minessale II 
+ * \author Anothony Minessale II
  * \ingroup functions
  */
 
@@ -31,8 +31,6 @@
 
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include <regex.h>
 #include <ctype.h>
 
@@ -108,13 +106,13 @@ AST_THREADSTORAGE(tmp_buf);
                        <parameter name="string" required="true" />
                </syntax>
                <description>
-                       <para>Permits all characters listed in <replaceable>allowed-chars</replaceable>, 
-                       filtering all others outs. In addition to literally listing the characters, 
+                       <para>Permits all characters listed in <replaceable>allowed-chars</replaceable>,
+                       filtering all others outs. In addition to literally listing the characters,
                        you may also use ranges of characters (delimited by a <literal>-</literal></para>
                        <para>Hexadecimal characters started with a <literal>\x</literal>(i.e. \x20)</para>
                        <para>Octal characters started with a <literal>\0</literal> (i.e. \040)</para>
-                       <para>Also <literal>\t</literal>,<literal>\n</literal> and <literal>\r</literal> are recognized.</para> 
-                       <note><para>If you want the <literal>-</literal> character it needs to be prefixed with a 
+                       <para>Also <literal>\t</literal>,<literal>\n</literal> and <literal>\r</literal> are recognized.</para>
+                       <note><para>If you want the <literal>-</literal> character it needs to be prefixed with a
                        <literal>\</literal></para></note>
                </description>
        </function>
@@ -165,6 +163,10 @@ AST_THREADSTORAGE(tmp_buf);
                        <para>Literally returns the given <replaceable>string</replaceable>.  The intent is to permit
                        other dialplan functions which take a variable name as an argument to be able to take a literal
                        string, instead.</para>
+                       <note><para>The functions which take a variable name need to be passed var and not
+                       ${var}.  Similarly, use PASSTHRU() and not ${PASSTHRU()}.</para></note>
+                       <para>Example: ${CHANNEL} contains SIP/321-1</para>
+                       <para>         ${CUT(PASSTHRU(${CUT(CHANNEL,-,1)}),/,2)}) will return 321</para>
                </description>
        </function>
        <function name="REGEX" language="en_US">
@@ -177,9 +179,9 @@ AST_THREADSTORAGE(tmp_buf);
                </syntax>
                <description>
                        <para>Return <literal>1</literal> on regular expression match or <literal>0</literal> otherwise</para>
-                       <para>Please note that the space following the double quotes separating the 
-                       regex from the data is optional and if present, is skipped. If a space is 
-                       desired at the beginning of the data, then put two spaces there; the second 
+                       <para>Please note that the space following the double quotes separating the
+                       regex from the data is optional and if present, is skipped. If a space is
+                       desired at the beginning of the data, then put two spaces there; the second
                        will not be skipped.</para>
                </description>
        </function>
@@ -216,8 +218,8 @@ AST_THREADSTORAGE(tmp_buf);
                        <parameter name="hashname" required="true" />
                </syntax>
                <description>
-                       <para>Returns a comma-delimited list of the current keys of the associative array 
-                       defined by the HASH() function. Note that if you iterate over the keys of 
+                       <para>Returns a comma-delimited list of the current keys of the associative array
+                       defined by the HASH() function. Note that if you iterate over the keys of
                        the result, adding keys during iteration will cause the result of the HASHKEYS()
                        function to change.</para>
                </description>
@@ -243,8 +245,8 @@ AST_THREADSTORAGE(tmp_buf);
                        <parameter name="varN" required="false" />
                </syntax>
                <description>
-                       <para>The comma-delimited list passed as a value to which the function is set will 
-                       be interpreted as a set of values to which the comma-delimited list of 
+                       <para>The comma-delimited list passed as a value to which the function is set will
+                       be interpreted as a set of values to which the comma-delimited list of
                        variable names in the argument should be set.</para>
                        <para>Example: Set(ARRAY(var1,var2)=1,2) will set var1 to 1 and var2 to 2</para>
                </description>
@@ -259,7 +261,7 @@ AST_THREADSTORAGE(tmp_buf);
                        <parameter name="format" required="true" />
                </syntax>
                <description>
-                       <para>This is useful for converting a date into <literal>EPOCH</literal> time, 
+                       <para>This is useful for converting a date into <literal>EPOCH</literal> time,
                        possibly to pass to an application like SayUnixTime or to calculate the difference
                        between the two date strings</para>
                        <para>Example: ${STRPTIME(2006-03-01 07:30:35,America/Chicago,%Y-%m-%d %H:%M:%S)} returns 1141219835</para>
@@ -349,7 +351,7 @@ AST_THREADSTORAGE(tmp_buf);
                        <parameter name="string" required="true" />
                </syntax>
                <description>
-                       <para>Example: ${QUOTE(ab"c"de)} will return "abcde"</para>
+                       <para>Example: ${QUOTE(ab"c"de)} will return ""ab\"c\"de""</para>
                </description>
        </function>
        <function name="CSV_QUOTE" language="en_US">
@@ -382,7 +384,7 @@ AST_THREADSTORAGE(tmp_buf);
                                NoOp(var is three) being executed.
                        </para>
                </description>
-       </function>     
+       </function>
        <function name="POP" language="en_US">
                <synopsis>
                        Removes and returns the last item off of a variable containing delimited text
@@ -402,7 +404,7 @@ AST_THREADSTORAGE(tmp_buf);
                                NoOp(var is one) being executed.
                        </para>
                </description>
-       </function>     
+       </function>
        <function name="PUSH" language="en_US">
                <synopsis>
                        Appends one or more values to the end of a variable containing delimited text
@@ -456,7 +458,7 @@ static int function_fieldqty_helper(struct ast_channel *chan, const char *cmd,
        if (args.delim) {
                ast_get_encoded_char(args.delim, delim, &delim_used);
 
-               varsubst = alloca(strlen(args.varname) + 4);
+               varsubst = ast_alloca(strlen(args.varname) + 4);
 
                sprintf(varsubst, "${%s}", args.varname);
                ast_str_substitute_variables(&str, 0, chan, varsubst);
@@ -522,7 +524,7 @@ static int function_fieldnum_helper(struct ast_channel *chan, const char *cmd,
                ast_log(LOG_ERROR, "Usage: FIELDNUM(<listname>,<delimiter>,<fieldvalue>)\n");
                res = -1;
        } else {
-               varsubst = alloca(strlen(args.varname) + 4);
+               varsubst = ast_alloca(strlen(args.varname) + 4);
                sprintf(varsubst, "${%s}", args.varname);
 
                ast_str_substitute_variables(&str, 0, chan, varsubst);
@@ -606,7 +608,7 @@ static int listfilter(struct ast_channel *chan, const char *cmd, char *parse, ch
                return -1;
        }
 
-       varsubst = alloca(strlen(args.listname) + 4);
+       varsubst = ast_alloca(strlen(args.listname) + 4);
        sprintf(varsubst, "${%s}", args.listname);
 
        /* If we don't lock the channel, the variable could disappear out from underneath us. */
@@ -615,7 +617,6 @@ static int listfilter(struct ast_channel *chan, const char *cmd, char *parse, ch
        }
        ast_str_substitute_variables(&orig_list, 0, chan, varsubst);
        if (!ast_str_strlen(orig_list)) {
-               ast_log(LOG_ERROR, "List variable '%s' not found\n", args.listname);
                if (chan) {
                        ast_channel_unlock(chan);
                }
@@ -636,7 +637,7 @@ static int listfilter(struct ast_channel *chan, const char *cmd, char *parse, ch
        }
 
        dlen = strlen(args.delimiter);
-       delim = alloca(dlen + 1);
+       delim = ast_alloca(dlen + 1);
        ast_get_encoded_str(args.delimiter, delim, dlen + 1);
 
        if ((dlen = strlen(delim)) == 0) {
@@ -794,7 +795,7 @@ static int replace(struct ast_channel *chan, const char *cmd, char *data, struct
                AST_APP_ARG(replace);
        );
        char *strptr, *varsubst;
-       struct ast_str *str = ast_str_thread_get(&result_buf, 16);
+       RAII_VAR(struct ast_str *, str, ast_str_create(16), ast_free);
        char find[256]; /* Only 256 characters possible */
        char replace[2] = "";
        size_t unused;
@@ -819,7 +820,7 @@ static int replace(struct ast_channel *chan, const char *cmd, char *data, struct
                return -1;
        }
 
-       varsubst = alloca(strlen(args.varname) + 4);
+       varsubst = ast_alloca(strlen(args.varname) + 4);
        sprintf(varsubst, "${%s}", args.varname);
        ast_str_substitute_variables(&str, 0, chan, varsubst);
 
@@ -837,8 +838,7 @@ static int replace(struct ast_channel *chan, const char *cmd, char *data, struct
                 * directly there */
                if (strchr(find, *strptr)) {
                        if (ast_strlen_zero(replace)) {
-                               /* Remove character */
-                               strcpy(strptr, strptr + 1); /* SAFE */
+                               memmove(strptr, strptr + 1, strlen(strptr + 1) + 1);
                                strptr--;
                        } else {
                                /* Replace character */
@@ -906,7 +906,7 @@ static int strreplace(struct ast_channel *chan, const char *cmd, char *data, str
        find_size = strlen(args.find_string);
 
        /* set varsubstr to the matching variable */
-       varsubstr = alloca(strlen(args.varname) + 4);
+       varsubstr = ast_alloca(strlen(args.varname) + 4);
        sprintf(varsubstr, "${%s}", args.varname);
        ast_str_substitute_variables(&str, 0, chan, varsubstr);
 
@@ -974,7 +974,7 @@ static int regex(struct ast_channel *chan, const char *cmd, char *parse, char *b
                ast_log(LOG_WARNING, "Malformed input %s(%s): %s\n", cmd, parse, buf);
                return -1;
        }
-       
+
        strcpy(buf, regexec(&regexbuf, args.str, 0, NULL, 0) ? "0" : "1");
 
        regfree(&regexbuf);
@@ -998,7 +998,7 @@ 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(ast_channel_varshead(chan), var, entries) {
-               if (strncasecmp(prefix, ast_var_name(var), len) == 0) {
+               if (strncmp(prefix, ast_var_name(var), len) == 0) {
                        AST_LIST_REMOVE_CURRENT(entries);
                        ast_free(var);
                }
@@ -1026,9 +1026,10 @@ static int array(struct ast_channel *chan, const char *cmd, char *var,
        char *origvar = "", *value2, varname[256];
        int i, ishash = 0;
 
-       value2 = ast_strdupa(value);
-       if (!var || !value2)
+       if (!var) {
                return -1;
+       }
+       value2 = ast_strdupa(value);
 
        if (!strcmp(cmd, "HASH")) {
                const char *var2 = pbx_builtin_getvar_helper(chan, "~ODBCFIELDS~");
@@ -1093,11 +1094,16 @@ static int hashkeys_read(struct ast_channel *chan, const char *cmd, char *data,
        struct ast_var_t *newvar;
        struct ast_str *prefix = ast_str_alloca(80);
 
+       if (!chan) {
+               ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
+               return -1;
+       }
+
        ast_str_set(&prefix, -1, HASH_PREFIX, data);
        memset(buf, 0, len);
 
        AST_LIST_TRAVERSE(ast_channel_varshead(chan), newvar, entries) {
-               if (strncasecmp(ast_str_buffer(prefix), ast_var_name(newvar), ast_str_strlen(prefix)) == 0) {
+               if (strncmp(ast_str_buffer(prefix), ast_var_name(newvar), ast_str_strlen(prefix)) == 0) {
                        /* Copy everything after the prefix */
                        strncat(buf, ast_var_name(newvar) + ast_str_strlen(prefix), len - strlen(buf) - 1);
                        /* Trim the trailing ~ */
@@ -1115,10 +1121,15 @@ static int hashkeys_read2(struct ast_channel *chan, const char *cmd, char *data,
        struct ast_str *prefix = ast_str_alloca(80);
        char *tmp;
 
+       if (!chan) {
+               ast_log(LOG_WARNING, "No channel was provided to %s function.\n", cmd);
+               return -1;
+       }
+
        ast_str_set(&prefix, -1, HASH_PREFIX, data);
 
        AST_LIST_TRAVERSE(ast_channel_varshead(chan), newvar, entries) {
-               if (strncasecmp(ast_str_buffer(prefix), ast_var_name(newvar), ast_str_strlen(prefix)) == 0) {
+               if (strncmp(ast_str_buffer(prefix), ast_var_name(newvar), ast_str_strlen(prefix)) == 0) {
                        /* Copy everything after the prefix */
                        ast_str_append(buf, len, "%s", ast_var_name(newvar) + ast_str_strlen(prefix));
                        /* Trim the trailing ~ */
@@ -1184,6 +1195,11 @@ static int hash_read(struct ast_channel *chan, const char *cmd, char *data, char
                        AST_APP_ARG(col)[100];
                );
 
+               if (!chan) {
+                       ast_log(LOG_WARNING, "No channel and only 1 parameter was provided to %s function.\n", cmd);
+                       return -1;
+               }
+
                /* Get column names, in no particular order */
                hashkeys_read(chan, "HASHKEYS", arg.hashname, colnames, sizeof(colnames));
                pbx_builtin_setvar_helper(chan, "~ODBCFIELDS~", colnames);
@@ -1544,7 +1560,7 @@ static int shift_pop(struct ast_channel *chan, const char *cmd, char *data, stru
                return -1;
        }
 
-       varsubst = alloca(strlen(args.var) + 4);
+       varsubst = ast_alloca(strlen(args.var) + 4);
        sprintf(varsubst, "${%s}", args.var);
        ast_str_substitute_variables(&before, 0, chan, varsubst);
 
@@ -1591,6 +1607,7 @@ static int unshift_push(struct ast_channel *chan, const char *cmd, char *data, c
                AST_APP_ARG(var);
                AST_APP_ARG(delimiter);
        );
+       const char *stripped_var;
 
        if (!(buf = ast_str_thread_get(&result_buf, 16)) ||
                !(previous_value = ast_str_thread_get(&tmp_buf, 16))) {
@@ -1608,8 +1625,15 @@ static int unshift_push(struct ast_channel *chan, const char *cmd, char *data, c
                ast_get_encoded_char(args.delimiter, delimiter, &unused);
        }
 
-       varsubst = alloca(strlen(args.var) + 4);
-       sprintf(varsubst, "${%s}", args.var);
+       /* UNSHIFT and PUSH act as ways of setting a variable, so we need to be
+        * sure to skip leading underscores if they appear. However, we only want
+        * to skip up to two since that is the maximum number that can be used to
+        * indicate variable inheritance. Any further underscores are part of the
+        * variable name.
+        */
+       stripped_var = args.var + MIN(strspn(args.var, "_"), 2);
+       varsubst = ast_alloca(strlen(stripped_var) + 4);
+       sprintf(varsubst, "${%s}", stripped_var);
        ast_str_substitute_variables(&previous_value, 0, chan, varsubst);
 
        if (!ast_str_strlen(previous_value)) {
@@ -1693,6 +1717,12 @@ AST_TEST_DEFINE(test_FIELDNUM)
 
        for (i = 0; i < ARRAY_LEN(test_args); i++) {
                struct ast_var_t *var = ast_var_assign("FIELDS", test_args[i].fields);
+               if (!var) {
+                       ast_test_status_update(test, "Out of memory\n");
+                       res = AST_TEST_FAIL;
+                       break;
+               }
+
                AST_LIST_INSERT_HEAD(ast_channel_varshead(chan), var, entries);
 
                snprintf(expression, sizeof(expression), "${FIELDNUM(%s,%s,%s)}", var->name, test_args[i].delim, test_args[i].field);
@@ -1715,6 +1745,76 @@ AST_TEST_DEFINE(test_FIELDNUM)
        return res;
 }
 
+AST_TEST_DEFINE(test_REPLACE)
+{
+       int i, res = AST_TEST_PASS;
+       struct ast_channel *chan;
+       struct ast_str *str;
+       char expression[256];
+       struct {
+               const char *test_string;
+               const char *find_chars;
+               const char *replace_char;
+               const char *expected;
+       } test_args[] = {
+               {"abc,def", "\\,", "-", "abc-def"},
+               {"abc,abc", "bc",  "a", "aaa,aaa"},
+               {"abc,def", "x",   "?", "abc,def"},
+               {"abc,def", "\\,", "",  "abcdef"}
+       };
+
+       switch (cmd) {
+       case TEST_INIT:
+               info->name = "func_REPLACE_test";
+               info->category = "/funcs/func_strings/";
+               info->summary = "Test REPLACE function";
+               info->description = "Verify REPLACE behavior";
+               return AST_TEST_NOT_RUN;
+       case TEST_EXECUTE:
+               break;
+       }
+
+       if (!(chan = ast_dummy_channel_alloc())) {
+               ast_test_status_update(test, "Unable to allocate dummy channel\n");
+               return AST_TEST_FAIL;
+       }
+
+       if (!(str = ast_str_create(16))) {
+               ast_test_status_update(test, "Unable to allocate dynamic string buffer\n");
+               ast_channel_release(chan);
+               return AST_TEST_FAIL;
+       }
+
+       for (i = 0; i < ARRAY_LEN(test_args); i++) {
+               struct ast_var_t *var = ast_var_assign("TEST_STRING", test_args[i].test_string);
+               if (!var) {
+                       ast_test_status_update(test, "Out of memory\n");
+                       res = AST_TEST_FAIL;
+                       break;
+               }
+
+               AST_LIST_INSERT_HEAD(ast_channel_varshead(chan), var, entries);
+
+               snprintf(expression, sizeof(expression), "${REPLACE(%s,%s,%s)}", var->name, test_args[i].find_chars, test_args[i].replace_char);
+               ast_str_substitute_variables(&str, 0, chan, expression);
+
+               AST_LIST_REMOVE(ast_channel_varshead(chan), var, entries);
+               ast_var_delete(var);
+
+               if (strcasecmp(ast_str_buffer(str), test_args[i].expected)) {
+                       ast_test_status_update(test, "Evaluation of '%s' returned '%s' instead of the expected value '%s'\n",
+                               expression, ast_str_buffer(str), test_args[i].expected);
+                       res = AST_TEST_FAIL;
+                       break;
+               }
+       }
+
+       ast_free(str);
+       ast_channel_release(chan);
+
+       return res;
+}
+
 AST_TEST_DEFINE(test_FILTER)
 {
        int i, res = AST_TEST_PASS;
@@ -1795,6 +1895,13 @@ AST_TEST_DEFINE(test_STRREPLACE)
                char tmp[512], tmp2[512] = "";
 
                struct ast_var_t *var = ast_var_assign("test_string", test_strings[i][0]);
+               if (!var) {
+                       ast_test_status_update(test, "Unable to allocate variable\n");
+                       ast_free(str);
+                       ast_channel_release(chan);
+                       return AST_TEST_FAIL;
+               }
+
                AST_LIST_INSERT_HEAD(ast_channel_varshead(chan), var, entries);
 
                if (test_strings[i][3]) {
@@ -1825,6 +1932,7 @@ static int unload_module(void)
        int res = 0;
 
        AST_TEST_UNREGISTER(test_FIELDNUM);
+       AST_TEST_UNREGISTER(test_REPLACE);
        AST_TEST_UNREGISTER(test_FILTER);
        AST_TEST_UNREGISTER(test_STRREPLACE);
        res |= ast_custom_function_unregister(&fieldqty_function);
@@ -1861,6 +1969,7 @@ static int load_module(void)
        int res = 0;
 
        AST_TEST_REGISTER(test_FIELDNUM);
+       AST_TEST_REGISTER(test_REPLACE);
        AST_TEST_REGISTER(test_FILTER);
        AST_TEST_REGISTER(test_STRREPLACE);
        res |= ast_custom_function_register(&fieldqty_function);