The purpose of this patch is to eliminate struct ast_callerid since it has turned into a miscellaneous collection of various party information. Eliminate struct ast_callerid and replace it with the following struct organization: struct ast_party_name { char *str; int char_set; int presentation; unsigned char valid; }; struct ast_party_number { char *str; int plan; int presentation; unsigned char valid; }; struct ast_party_subaddress { char *str; int type; unsigned char odd_even_indicator; unsigned char valid; }; struct ast_party_id { struct ast_party_name name; struct ast_party_number number; struct ast_party_subaddress subaddress; char *tag; }; struct ast_party_dialed { struct { char *str; int plan; } number; struct ast_party_subaddress subaddress; int transit_network_select; }; struct ast_party_caller { struct ast_party_id id; char *ani; int ani2; }; The new organization adds some new information as well. * The party name and number now have their own presentation value that can be manipulated independently. ISDN supplies the presentation value for the name and number at different times with the possibility that they could be different. * The party name and number now have a valid flag. Before this change the name or number string could be empty if the presentation were restricted. Most channel drivers assume that the name or number is then simply not available instead of indicating that the name or number was restricted. * The party name now has a character set value. SIP and Q.SIG have the ability to indicate what character set a name string is using so it could be presented properly. * The dialed party now has a numbering plan value that could be useful to have available. The various channel drivers will need to be updated to support the new core features as needed. They have simply been converted to supply current functionality at this time. The following items of note were either corrected or enhanced: * The CONNECTEDLINE() and REDIRECTING() dialplan functions were consolidated into func_callerid.c to share party id handling code. * CALLERPRES() is now deprecated because the name and number have their own presentation values. * Fixed app_alarmreceiver.c write_metadata(). The workstring[] could contain garbage. It also can only contain the caller id number so using ast_callerid_parse() on it is silly. There was also a typo in the CALLERNAME if test. * Fixed app_rpt.c using ast_callerid_parse() on the channel's caller id number string. ast_callerid_parse() alters the given buffer which in this case is the channel's caller id number string. Then using ast_shrink_phone_number() could alter it even more. * Fixed caller ID name and number memory leak in chan_usbradio.c. * Fixed uninitialized char arrays cid_num[] and cid_name[] in sig_analog.c. * Protected access to a caller channel with lock in chan_sip.c. * Clarified intent of code in app_meetme.c sla_ring_station() and dial_trunk(). Also made save all caller ID data instead of just the name and number strings. * Simplified cdr.c set_one_cid(). It hand coded the ast_callerid_merge() function. * Corrected some weirdness with app_privacy.c's use of caller presentation. Review: https://reviewboard.asterisk.org/r/702/ git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@276347 65c4cc65-6c06-0410-ace0-fbb531ad65f3
306 lines
10 KiB
C
306 lines
10 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2009, Digium, Inc.
|
|
*
|
|
* Tilghman Lesher <tlesher AT digium DOT 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 Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Substitution Test
|
|
*
|
|
* \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
|
|
*
|
|
* \ingroup tests
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<depend>TEST_FRAMEWORK</depend>
|
|
<depend>func_curl</depend>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/file.h"
|
|
#include "asterisk/channel.h"
|
|
#include "asterisk/pbx.h"
|
|
#include "asterisk/module.h"
|
|
#include "asterisk/lock.h"
|
|
#include "asterisk/app.h"
|
|
#include "asterisk/strings.h"
|
|
#include "asterisk/stringfields.h"
|
|
#include "asterisk/threadstorage.h"
|
|
#include "asterisk/test.h"
|
|
|
|
static enum ast_test_result_state test_chan_integer(struct ast_test *test,
|
|
struct ast_channel *c, int *ifield, const char *expression)
|
|
{
|
|
int i, okay = 1, value1 = -1, value2 = -1;
|
|
char workspace[4096];
|
|
struct ast_str *str = ast_str_create(16);
|
|
|
|
ast_test_status_update(test, "Testing '%s' . . . . . %s\n", expression, okay ? "passed" : "FAILED");
|
|
for (i = 0; i < 256; i++) {
|
|
*ifield = i;
|
|
ast_str_substitute_variables(&str, 0, c, expression);
|
|
pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
|
|
if (sscanf(workspace, "%d", &value1) != 1 || value1 != i || sscanf(ast_str_buffer(str), "%d", &value2) != 1 || value2 != i) {
|
|
ast_test_status_update(test, "%s != %s and/or %d != %d != %d\n", ast_str_buffer(str), workspace, value1, value2, i);
|
|
okay = 0;
|
|
}
|
|
}
|
|
|
|
ast_free(str);
|
|
|
|
return okay ? AST_TEST_PASS : AST_TEST_FAIL;
|
|
}
|
|
|
|
static enum ast_test_result_state test_chan_string(struct ast_test *test,
|
|
struct ast_channel *c, char *cfield, size_t cfieldsize,
|
|
const char *expression)
|
|
{
|
|
const char *values[] = { "one", "three", "reallylongdinosaursoundingthingwithwordsinit" };
|
|
int i, okay = 1;
|
|
char workspace[4096];
|
|
struct ast_str *str = ast_str_create(16);
|
|
|
|
for (i = 0; i < ARRAY_LEN(values); i++) {
|
|
ast_copy_string(cfield, values[i], cfieldsize);
|
|
ast_str_substitute_variables(&str, 0, c, expression);
|
|
pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
|
|
ast_test_status_update(test, "Testing '%s' . . . . . %s\n",
|
|
expression, okay ? "passed" : "FAILED");
|
|
if (strcmp(cfield, ast_str_buffer(str)) != 0 || strcmp(cfield, workspace) != 0) {
|
|
ast_test_status_update(test, "%s != %s != %s\n", cfield, ast_str_buffer(str), workspace);
|
|
okay = 0;
|
|
}
|
|
}
|
|
|
|
ast_free(str);
|
|
|
|
return okay ? AST_TEST_PASS : AST_TEST_FAIL;
|
|
}
|
|
|
|
static enum ast_test_result_state test_chan_variable(struct ast_test *test,
|
|
struct ast_channel *c, const char *varname)
|
|
{
|
|
const char *values[] = { "one", "three", "reallylongdinosaursoundingthingwithwordsinit" };
|
|
int i, okay = 1;
|
|
char workspace[4096];
|
|
struct ast_str *str = ast_str_create(16);
|
|
struct ast_str *var = ast_str_create(16);
|
|
|
|
ast_str_set(&var, 0, "${%s}", varname);
|
|
for (i = 0; i < ARRAY_LEN(values); i++) {
|
|
pbx_builtin_setvar_helper(c, varname, values[i]);
|
|
ast_str_substitute_variables(&str, 0, c, ast_str_buffer(var));
|
|
pbx_substitute_variables_helper(c, ast_str_buffer(var), workspace, sizeof(workspace));
|
|
ast_test_status_update(test, "Testing '%s' . . . . . %s\n",
|
|
ast_str_buffer(var), okay ? "passed" : "FAILED");
|
|
if (strcmp(values[i], ast_str_buffer(str)) != 0 || strcmp(values[i], workspace) != 0) {
|
|
ast_test_status_update(test, "%s != %s != %s\n",
|
|
values[i], ast_str_buffer(str), workspace);
|
|
okay = 0;
|
|
}
|
|
}
|
|
|
|
ast_free(str);
|
|
ast_free(var);
|
|
|
|
return okay ? AST_TEST_PASS : AST_TEST_FAIL;
|
|
}
|
|
|
|
static enum ast_test_result_state test_chan_function(struct ast_test *test,
|
|
struct ast_channel *c, const char *expression)
|
|
{
|
|
int okay = 1;
|
|
char workspace[4096];
|
|
struct ast_str *str = ast_str_create(16);
|
|
|
|
ast_str_substitute_variables(&str, 0, c, expression);
|
|
pbx_substitute_variables_helper(c, expression, workspace, sizeof(workspace));
|
|
ast_test_status_update(test, "Testing '%s' . . . . . %s\n",
|
|
expression, okay ? "passed" : "FAILED");
|
|
if (strcmp(workspace, ast_str_buffer(str)) != 0) {
|
|
ast_test_status_update(test, "test_chan_function, expr: '%s' ... %s != %s\n",
|
|
expression, ast_str_buffer(str), workspace);
|
|
okay = 0;
|
|
}
|
|
|
|
ast_free(str);
|
|
|
|
return okay ? AST_TEST_PASS : AST_TEST_FAIL;
|
|
}
|
|
|
|
static enum ast_test_result_state test_2way_function(struct ast_test *test,
|
|
struct ast_channel *c, const char *encode1, const char *encode2,
|
|
const char *decode1, const char *decode2)
|
|
{
|
|
struct ast_str *str = ast_str_create(16), *expression = ast_str_alloca(120);
|
|
int okay;
|
|
|
|
ast_str_set(&expression, 0, "%s%s%s", encode1, "foobarbaz", encode2);
|
|
ast_str_substitute_variables(&str, 0, c, ast_str_buffer(expression));
|
|
ast_str_set(&expression, 0, "%s%s%s", decode1, ast_str_buffer(str), decode2);
|
|
ast_str_substitute_variables(&str, 0, c, ast_str_buffer(expression));
|
|
|
|
okay = !strcmp(ast_str_buffer(str), "foobarbaz");
|
|
|
|
ast_test_status_update(test, "Testing '%s%s' and '%s%s' . . . . . %s\n",
|
|
encode1, encode2, decode1, decode2,
|
|
okay ? "passed" : "FAILED");
|
|
|
|
if (!okay) {
|
|
ast_test_status_update(test, " '%s' != 'foobarbaz'\n",
|
|
ast_str_buffer(str));
|
|
}
|
|
|
|
ast_free(str);
|
|
|
|
return okay ? AST_TEST_PASS : AST_TEST_FAIL;
|
|
}
|
|
|
|
static enum ast_test_result_state test_expected_result(struct ast_test *test,
|
|
struct ast_channel *c, const char *expression, const char *result)
|
|
{
|
|
struct ast_str *str = ast_str_create(16);
|
|
int okay;
|
|
|
|
ast_str_substitute_variables(&str, 0, c, expression);
|
|
okay = !strcmp(ast_str_buffer(str), result);
|
|
|
|
ast_test_status_update(test, "Testing '%s' ('%s') == '%s' . . . . . %s\n",
|
|
ast_str_buffer(str), expression, result,
|
|
okay ? "passed" : "FAILED");
|
|
|
|
if (!okay) {
|
|
ast_test_status_update(test, "test_expected_result: '%s' != '%s'\n",
|
|
ast_str_buffer(str), result);
|
|
}
|
|
|
|
ast_free(str);
|
|
|
|
return okay ? AST_TEST_PASS : AST_TEST_FAIL;
|
|
}
|
|
|
|
AST_TEST_DEFINE(test_substitution)
|
|
{
|
|
struct ast_channel *c;
|
|
int i;
|
|
enum ast_test_result_state res = AST_TEST_PASS;
|
|
|
|
switch (cmd) {
|
|
case TEST_INIT:
|
|
info->name = "test_substitution";
|
|
info->category = "/main/pbx/";
|
|
info->summary = "Test variable and function substitution";
|
|
info->description =
|
|
"This test executes a variety of variable and function substitutions "
|
|
"and ensures that the expected results are received.";
|
|
return AST_TEST_NOT_RUN;
|
|
case TEST_EXECUTE:
|
|
break;
|
|
}
|
|
|
|
ast_test_status_update(test, "Testing variable substitution ...\n");
|
|
|
|
c = ast_channel_alloc(0, 0, "", "", "", "", "", "", 0, "Test/substitution");
|
|
|
|
#define TEST(t) if (t == AST_TEST_FAIL) { res = AST_TEST_FAIL; }
|
|
#if 0
|
|
/*
|
|
* We can no longer test the CALLINGPRES value this way because it is now
|
|
* a calculated value from the name and number presentation information to
|
|
* get a combined presentation value.
|
|
*/
|
|
TEST(test_chan_integer(test, c, &c->caller.id.number.presentation, "${CALLINGPRES}"));
|
|
#endif
|
|
TEST(test_chan_integer(test, c, &c->caller.ani2, "${CALLINGANI2}"));
|
|
TEST(test_chan_integer(test, c, &c->caller.id.number.plan, "${CALLINGTON}"));
|
|
TEST(test_chan_integer(test, c, &c->dialed.transit_network_select, "${CALLINGTNS}"));
|
|
TEST(test_chan_integer(test, c, &c->hangupcause, "${HANGUPCAUSE}"));
|
|
TEST(test_chan_integer(test, c, &c->priority, "${PRIORITY}"));
|
|
TEST(test_chan_string(test, c, c->context, sizeof(c->context), "${CONTEXT}"));
|
|
TEST(test_chan_string(test, c, c->exten, sizeof(c->exten), "${EXTEN}"));
|
|
TEST(test_chan_variable(test, c, "CHANNEL(language)"));
|
|
TEST(test_chan_variable(test, c, "CHANNEL(musicclass)"));
|
|
TEST(test_chan_variable(test, c, "CHANNEL(parkinglot)"));
|
|
TEST(test_chan_variable(test, c, "CALLERID(name)"));
|
|
TEST(test_chan_variable(test, c, "CURLOPT(proxyuserpwd)"));
|
|
TEST(test_chan_variable(test, c, "CDR(foo)"));
|
|
TEST(test_chan_variable(test, c, "ENV(foo)"));
|
|
TEST(test_chan_variable(test, c, "GLOBAL(foo)"));
|
|
TEST(test_chan_variable(test, c, "GROUP()"));
|
|
TEST(test_2way_function(test, c, "${AES_ENCRYPT(abcdefghijklmnop,", ")}", "${AES_DECRYPT(abcdefghijklmnop,", ")}"));
|
|
TEST(test_2way_function(test, c, "${BASE64_ENCODE(", ")}", "${BASE64_DECODE(", ")}"));
|
|
pbx_builtin_setvar_helper(c, "foo", "123");
|
|
pbx_builtin_setvar_helper(c, "bar", "foo");
|
|
pbx_builtin_setvar_helper(c, "baz", "fo");
|
|
TEST(test_expected_result(test, c, "${foo}${foo}", "123123"));
|
|
TEST(test_expected_result(test, c, "A${foo}A${foo}A", "A123A123A"));
|
|
TEST(test_expected_result(test, c, "A${${bar}}A", "A123A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o}A", "A123A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o:1}A", "A23A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o:1:1}A", "A2A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o:1:-1}A", "A2A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o:-1:1}A", "A3A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o:-2:1}A", "A2A"));
|
|
TEST(test_expected_result(test, c, "A${${baz}o:-2:-1}A", "A2A"));
|
|
pbx_builtin_setvar_helper(c, "list1", "ab&cd&ef");
|
|
TEST(test_expected_result(test, c, "${LISTFILTER(list1,&,cd)}", "ab&ef"));
|
|
#undef TEST
|
|
|
|
/* For testing dialplan functions */
|
|
for (i = 0; ; i++) {
|
|
char *cmd = ast_cli_generator("core show function", "", i);
|
|
if (cmd == NULL) {
|
|
break;
|
|
}
|
|
if (strcmp(cmd, "CHANNEL") && strcmp(cmd, "CALLERID") && strncmp(cmd, "CURL", 4) &&
|
|
strncmp(cmd, "AES", 3) && strncmp(cmd, "BASE64", 6) &&
|
|
strcmp(cmd, "CDR") && strcmp(cmd, "ENV") && strcmp(cmd, "GLOBAL") &&
|
|
strcmp(cmd, "GROUP") && strcmp(cmd, "CUT") && strcmp(cmd, "LISTFILTER") &&
|
|
strcmp(cmd, "PP_EACH_EXTENSION") && strcmp(cmd, "SET")) {
|
|
struct ast_custom_function *acf = ast_custom_function_find(cmd);
|
|
if (acf->read && acf->read2) {
|
|
char expression[80];
|
|
snprintf(expression, sizeof(expression), "${%s(foo)}", cmd);
|
|
if (AST_TEST_FAIL == test_chan_function(test, c, expression)) {
|
|
res = AST_TEST_FAIL;
|
|
}
|
|
}
|
|
}
|
|
ast_free(cmd);
|
|
}
|
|
|
|
ast_hangup(c);
|
|
return res;
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
AST_TEST_UNREGISTER(test_substitution);
|
|
return 0;
|
|
}
|
|
|
|
static int load_module(void)
|
|
{
|
|
AST_TEST_REGISTER(test_substitution);
|
|
return AST_MODULE_LOAD_SUCCESS;
|
|
}
|
|
|
|
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Substitution tests");
|