Realtime PBX Module. More...
#include "asterisk.h"#include <signal.h>#include "asterisk/file.h"#include "asterisk/logger.h"#include "asterisk/channel.h"#include "asterisk/config.h"#include "asterisk/pbx.h"#include "asterisk/module.h"#include "asterisk/frame.h"#include "asterisk/term.h"#include "asterisk/manager.h"#include "asterisk/cli.h"#include "asterisk/lock.h"#include "asterisk/linkedlists.h"#include "asterisk/chanvars.h"#include "asterisk/sched.h"#include "asterisk/io.h"#include "asterisk/utils.h"#include "asterisk/astdb.h"#include "asterisk/app.h"#include "asterisk/astobj2.h"
Go to the source code of this file.
Data Structures | |
| struct | cache_entry |
Defines | |
| #define | EXT_DATA_SIZE 256 |
| #define | MODE_CANMATCH 2 |
| #define | MODE_MATCH 0 |
| #define | MODE_MATCHMORE 1 |
Enumerations | |
| enum | option_flags { OPTION_A = (1 << 0), OPTION_B = (1 << 1), OPTION_C = (1 << 2), OPTION_WAIT = (1 << 0), OPTION_PATTERNS_DISABLED = (1 << 0) } |
Functions | |
| static void | __reg_module (void) |
| static void | __unreg_module (void) |
| static int | cache_cmp (void *obj, void *arg, int flags) |
| static int | cache_hash (const void *obj, const int flags) |
| static void * | cleanup (void *unused) |
| static struct ast_variable * | dup_vars (struct ast_variable *v) |
| static void | free_entry (void *obj) |
| static int | load_module (void) |
| static int | purge_old_fn (void *obj, void *arg, int flags) |
| static int | realtime_canmatch (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data) |
| static struct ast_variable * | realtime_common (const char *context, const char *exten, int priority, const char *data, int mode) |
| static int | realtime_exec (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data) |
| static int | realtime_exists (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data) |
| static int | realtime_matchmore (struct ast_channel *chan, const char *context, const char *exten, int priority, const char *callerid, const char *data) |
| static struct ast_variable * | realtime_switch_common (const char *table, const char *context, const char *exten, int priority, int mode, struct ast_flags flags) |
| static int | unload_module (void) |
Variables | |
| static struct ast_module_info | __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Realtime Switch" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } |
| static struct ast_module_info * | ast_module_info = &__mod_info |
| struct ao2_container * | cache |
| pthread_t | cleanup_thread = 0 |
| static struct ast_switch | realtime_switch |
| static struct ast_app_option | switch_opts [128] = { [ 'p' ] = { .flag = OPTION_PATTERNS_DISABLED },} |
Detailed Description
Realtime PBX Module.
- See also: ARA - The Asterisk Realtime Interface
Definition in file pbx_realtime.c.
Define Documentation
| #define EXT_DATA_SIZE 256 |
Definition at line 60 of file pbx_realtime.c.
Referenced by realtime_exec().
| #define MODE_CANMATCH 2 |
Definition at line 58 of file pbx_realtime.c.
Referenced by realtime_canmatch(), and realtime_switch_common().
| #define MODE_MATCH 0 |
Definition at line 56 of file pbx_realtime.c.
Referenced by realtime_common(), realtime_exec(), realtime_exists(), and realtime_switch_common().
| #define MODE_MATCHMORE 1 |
Definition at line 57 of file pbx_realtime.c.
Referenced by realtime_matchmore(), and realtime_switch_common().
Enumeration Type Documentation
| enum option_flags |
Definition at line 62 of file pbx_realtime.c.
{
OPTION_PATTERNS_DISABLED = (1 << 0),
};
Function Documentation
| static void __reg_module | ( | void | ) | [static] |
Definition at line 425 of file pbx_realtime.c.
| static void __unreg_module | ( | void | ) | [static] |
Definition at line 425 of file pbx_realtime.c.
| static int cache_cmp | ( | void * | obj, |
| void * | arg, | ||
| int | flags | ||
| ) | [static] |
Definition at line 87 of file pbx_realtime.c.
References CMP_MATCH, cache_entry::context, cache_entry::exten, f, and cache_entry::priority.
Referenced by load_module().
| static int cache_hash | ( | const void * | obj, |
| const int | flags | ||
| ) | [static] |
Definition at line 81 of file pbx_realtime.c.
References ast_str_case_hash(), cache_entry::exten, and cache_entry::priority.
Referenced by load_module().
{
const struct cache_entry *e = obj;
return ast_str_case_hash(e->exten) + e->priority;
}
| static void* cleanup | ( | void * | unused | ) | [static] |
Definition at line 125 of file pbx_realtime.c.
References ao2_callback, ao2_container_count(), ast_tvnow(), OBJ_MULTIPLE, OBJ_NODATA, OBJ_UNLINK, and purge_old_fn().
Referenced by _sip_tcp_helper_thread(), ast_sockaddr_resolve(), build_user(), handle_uri(), load_module(), and realtime_peer().
{
struct timespec forever = { 999999999, 0 }, one_second = { 1, 0 };
struct timeval now;
for (;;) {
pthread_testcancel();
if (ao2_container_count(cache) == 0) {
nanosleep(&forever, NULL);
}
pthread_testcancel();
now = ast_tvnow();
ao2_callback(cache, OBJ_MULTIPLE | OBJ_UNLINK | OBJ_NODATA, purge_old_fn, &now);
pthread_testcancel();
nanosleep(&one_second, NULL);
}
return NULL;
}
| static struct ast_variable* dup_vars | ( | struct ast_variable * | v | ) | [static, read] |
Definition at line 96 of file pbx_realtime.c.
References ast_variable_new(), ast_variables_destroy(), ast_variable::file, ast_variable::name, ast_variable::next, and ast_variable::value.
Referenced by realtime_common().
{
struct ast_variable *new, *list = NULL;
for (; v; v = v->next) {
if (!(new = ast_variable_new(v->name, v->value, v->file))) {
ast_variables_destroy(list);
return NULL;
}
/* Reversed list in cache, but when we duplicate out of the cache,
* it's back to correct order. */
new->next = list;
list = new;
}
return list;
}
| static void free_entry | ( | void * | obj | ) | [static] |
Definition at line 112 of file pbx_realtime.c.
References ast_variables_destroy(), and cache_entry::var.
Referenced by realtime_common().
{
struct cache_entry *e = obj;
ast_variables_destroy(e->var);
}
| static int load_module | ( | void | ) | [static] |
Definition at line 410 of file pbx_realtime.c.
References ao2_container_alloc, AST_MODULE_LOAD_FAILURE, AST_MODULE_LOAD_SUCCESS, ast_pthread_create, ast_register_switch(), cache_cmp(), cache_hash(), and cleanup().
{
if (!(cache = ao2_container_alloc(573, cache_hash, cache_cmp))) {
return AST_MODULE_LOAD_FAILURE;
}
if (ast_pthread_create(&cleanup_thread, NULL, cleanup, NULL)) {
return AST_MODULE_LOAD_FAILURE;
}
if (ast_register_switch(&realtime_switch))
return AST_MODULE_LOAD_FAILURE;
return AST_MODULE_LOAD_SUCCESS;
}
| static int purge_old_fn | ( | void * | obj, |
| void * | arg, | ||
| int | flags | ||
| ) | [static] |
Definition at line 118 of file pbx_realtime.c.
References ast_tvdiff_ms(), CMP_MATCH, and cache_entry::when.
Referenced by cleanup().
{
struct cache_entry *e = obj;
struct timeval *now = arg;
return ast_tvdiff_ms(*now, e->when) >= 1000 ? CMP_MATCH : 0;
}
| static int realtime_canmatch | ( | struct ast_channel * | chan, |
| const char * | context, | ||
| const char * | exten, | ||
| int | priority, | ||
| const char * | callerid, | ||
| const char * | data | ||
| ) | [static] |
Definition at line 291 of file pbx_realtime.c.
References ast_variables_destroy(), MODE_CANMATCH, and realtime_common().
{
struct ast_variable *var = realtime_common(context, exten, priority, data, MODE_CANMATCH);
if (var) {
ast_variables_destroy(var);
return 1;
}
return 0;
}
| static struct ast_variable* realtime_common | ( | const char * | context, |
| const char * | exten, | ||
| int | priority, | ||
| const char * | data, | ||
| int | mode | ||
| ) | [static, read] |
Definition at line 219 of file pbx_realtime.c.
References ao2_alloc, ao2_find, ao2_link, ao2_ref, ast_app_parse_options(), ast_copy_string(), AST_MAX_EXTENSION, ast_strdupa, ast_strlen_zero(), ast_tvnow(), ast_variables_destroy(), cache_entry::context, dup_vars(), cache_entry::exten, free_entry(), MODE_MATCH, OBJ_POINTER, cache_entry::priority, realtime_switch_common(), S_OR, switch_opts, table, cache_entry::var, var, and cache_entry::when.
Referenced by realtime_canmatch(), realtime_exec(), realtime_exists(), and realtime_matchmore().
{
const char *ctx = NULL;
char *table;
struct ast_variable *var=NULL;
struct ast_flags flags = { 0, };
struct cache_entry *ce;
struct {
struct cache_entry ce;
char exten[AST_MAX_EXTENSION];
} cache_search = { { .priority = priority, .context = (char *) context }, };
char *buf = ast_strdupa(data);
if (buf) {
/* "Realtime" prefix is stripped off in the parent engine. The
* remaining string is: [[context@]table][/opts] */
char *opts = strchr(buf, '/');
if (opts)
*opts++ = '\0';
table = strchr(buf, '@');
if (table) {
*table++ = '\0';
ctx = buf;
}
ctx = S_OR(ctx, context);
table = S_OR(table, "extensions");
if (!ast_strlen_zero(opts)) {
ast_app_parse_options(switch_opts, &flags, NULL, opts);
}
ast_copy_string(cache_search.exten, exten, sizeof(cache_search.exten));
if (mode == MODE_MATCH && (ce = ao2_find(cache, &cache_search, OBJ_POINTER))) {
var = dup_vars(ce->var);
ao2_ref(ce, -1);
} else {
var = realtime_switch_common(table, ctx, exten, priority, mode, flags);
do {
struct ast_variable *new;
/* Only cache matches */
if (mode != MODE_MATCH) {
break;
}
if (!(new = dup_vars(var))) {
break;
}
if (!(ce = ao2_alloc(sizeof(*ce) + strlen(exten) + strlen(context), free_entry))) {
ast_variables_destroy(new);
break;
}
ce->context = ce->exten + strlen(exten) + 1;
strcpy(ce->exten, exten); /* SAFE */
strcpy(ce->context, context); /* SAFE */
ce->priority = priority;
ce->var = new;
ce->when = ast_tvnow();
ao2_link(cache, ce);
pthread_kill(cleanup_thread, SIGURG);
ao2_ref(ce, -1);
} while (0);
}
}
return var;
}
| static int realtime_exec | ( | struct ast_channel * | chan, |
| const char * | context, | ||
| const char * | exten, | ||
| int | priority, | ||
| const char * | callerid, | ||
| const char * | data | ||
| ) | [static] |
Definition at line 301 of file pbx_realtime.c.
References app, ast_compat_pbx_realtime, ast_log(), ast_strdupa, ast_strlen_zero(), ast_variables_destroy(), ast_verb, COLOR_BRCYAN, COLOR_BRMAGENTA, ast_channel::context, EVENT_FLAG_DIALPLAN, EXT_DATA_SIZE, ast_channel::exten, LOG_NOTICE, LOG_WARNING, manager_event, MODE_MATCH, ast_variable::name, ast_channel::name, ast_variable::next, pbx_exec(), pbx_findapp(), pbx_substitute_variables_helper(), ast_channel::priority, realtime_common(), S_OR, term_color(), ast_channel::uniqueid, and ast_variable::value.
{
int res = -1;
struct ast_variable *var = realtime_common(context, exten, priority, data, MODE_MATCH);
if (var) {
char *tmp="";
char *app = NULL;
struct ast_variable *v;
for (v = var; v ; v = v->next) {
if (!strcasecmp(v->name, "app"))
app = ast_strdupa(v->value);
else if (!strcasecmp(v->name, "appdata")) {
if (ast_compat_pbx_realtime) {
char *ptr;
int in = 0;
tmp = alloca(strlen(v->value) * 2 + 1);
for (ptr = tmp; *v->value; v->value++) {
if (*v->value == ',') {
*ptr++ = '\\';
*ptr++ = ',';
} else if (*v->value == '|' && !in) {
*ptr++ = ',';
} else {
*ptr++ = *v->value;
}
/* Don't escape '|', meaning 'or', inside expressions ($[ ]) */
if (v->value[0] == '[' && v->value[-1] == '$') {
in++;
} else if (v->value[0] == ']' && in) {
in--;
}
}
*ptr = '\0';
} else {
tmp = ast_strdupa(v->value);
}
}
}
ast_variables_destroy(var);
if (!ast_strlen_zero(app)) {
struct ast_app *a = pbx_findapp(app);
if (a) {
char appdata[512];
char tmp1[80];
char tmp2[80];
char tmp3[EXT_DATA_SIZE];
appdata[0] = 0; /* just in case the substitute var func isn't called */
if(!ast_strlen_zero(tmp))
pbx_substitute_variables_helper(chan, tmp, appdata, sizeof(appdata) - 1);
ast_verb(3, "Executing [%s@%s:%d] %s(\"%s\", \"%s\")\n",
chan->exten, chan->context, chan->priority,
term_color(tmp1, app, COLOR_BRCYAN, 0, sizeof(tmp1)),
term_color(tmp2, chan->name, COLOR_BRMAGENTA, 0, sizeof(tmp2)),
term_color(tmp3, S_OR(appdata, ""), COLOR_BRMAGENTA, 0, sizeof(tmp3)));
manager_event(EVENT_FLAG_DIALPLAN, "Newexten",
"Channel: %s\r\n"
"Context: %s\r\n"
"Extension: %s\r\n"
"Priority: %d\r\n"
"Application: %s\r\n"
"AppData: %s\r\n"
"Uniqueid: %s\r\n",
chan->name, chan->context, chan->exten, chan->priority, app, !ast_strlen_zero(appdata) ? appdata : "(NULL)", chan->uniqueid);
res = pbx_exec(chan, a, appdata);
} else
ast_log(LOG_NOTICE, "No such application '%s' for extension '%s' in context '%s'\n", app, exten, context);
} else {
ast_log(LOG_WARNING, "No application specified for realtime extension '%s' in context '%s'\n", exten, context);
}
}
return res;
}
| static int realtime_exists | ( | struct ast_channel * | chan, |
| const char * | context, | ||
| const char * | exten, | ||
| int | priority, | ||
| const char * | callerid, | ||
| const char * | data | ||
| ) | [static] |
Definition at line 281 of file pbx_realtime.c.
References ast_variables_destroy(), MODE_MATCH, and realtime_common().
{
struct ast_variable *var = realtime_common(context, exten, priority, data, MODE_MATCH);
if (var) {
ast_variables_destroy(var);
return 1;
}
return 0;
}
| static int realtime_matchmore | ( | struct ast_channel * | chan, |
| const char * | context, | ||
| const char * | exten, | ||
| int | priority, | ||
| const char * | callerid, | ||
| const char * | data | ||
| ) | [static] |
Definition at line 379 of file pbx_realtime.c.
References ast_variables_destroy(), MODE_MATCHMORE, and realtime_common().
{
struct ast_variable *var = realtime_common(context, exten, priority, data, MODE_MATCHMORE);
if (var) {
ast_variables_destroy(var);
return 1;
}
return 0;
}
| static struct ast_variable* realtime_switch_common | ( | const char * | table, |
| const char * | context, | ||
| const char * | exten, | ||
| int | priority, | ||
| int | mode, | ||
| struct ast_flags | flags | ||
| ) | [static, read] |
Definition at line 160 of file pbx_realtime.c.
References ast_category_browse(), ast_category_detach_variables(), ast_category_get(), ast_config_destroy(), ast_copy_string(), ast_extension_close(), ast_extension_match(), ast_load_realtime(), ast_load_realtime_multientry(), AST_MAX_EXTENSION, ast_test_flag, match(), MODE_CANMATCH, MODE_MATCH, MODE_MATCHMORE, OPTION_PATTERNS_DISABLED, SENTINEL, and var.
Referenced by realtime_common().
{
struct ast_variable *var;
struct ast_config *cfg;
char pri[20];
char *ematch;
char rexten[AST_MAX_EXTENSION + 20]="";
int match;
/* Optimization: since we don't support hints in realtime, it's silly to
* query for a hint here, since we won't actually do anything with it.
* This just wastes CPU time and resources. */
if (priority < 0) {
return NULL;
}
snprintf(pri, sizeof(pri), "%d", priority);
switch(mode) {
case MODE_MATCHMORE:
ematch = "exten LIKE";
snprintf(rexten, sizeof(rexten), "%s_%%", exten);
break;
case MODE_CANMATCH:
ematch = "exten LIKE";
snprintf(rexten, sizeof(rexten), "%s%%", exten);
break;
case MODE_MATCH:
default:
ematch = "exten";
ast_copy_string(rexten, exten, sizeof(rexten));
}
var = ast_load_realtime(table, ematch, rexten, "context", context, "priority", pri, SENTINEL);
if (!var && !ast_test_flag(&flags, OPTION_PATTERNS_DISABLED)) {
cfg = ast_load_realtime_multientry(table, "exten LIKE", "\\_%", "context", context, "priority", pri, SENTINEL);
if (cfg) {
char *cat = ast_category_browse(cfg, NULL);
while(cat) {
switch(mode) {
case MODE_MATCHMORE:
match = ast_extension_close(cat, exten, 1);
break;
case MODE_CANMATCH:
match = ast_extension_close(cat, exten, 0);
break;
case MODE_MATCH:
default:
match = ast_extension_match(cat, exten);
}
if (match) {
var = ast_category_detach_variables(ast_category_get(cfg, cat));
break;
}
cat = ast_category_browse(cfg, cat);
}
ast_config_destroy(cfg);
}
}
return var;
}
| static int unload_module | ( | void | ) | [static] |
Definition at line 399 of file pbx_realtime.c.
References ao2_ref, and ast_unregister_switch().
{
ast_unregister_switch(&realtime_switch);
pthread_cancel(cleanup_thread);
pthread_kill(cleanup_thread, SIGURG);
pthread_join(cleanup_thread, NULL);
/* Destroy all remaining entries */
ao2_ref(cache, -1);
return 0;
}
Variable Documentation
struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Realtime Switch" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } [static] |
Definition at line 425 of file pbx_realtime.c.
struct ast_module_info* ast_module_info = &__mod_info [static] |
Definition at line 425 of file pbx_realtime.c.
| struct ao2_container* cache |
Definition at line 78 of file pbx_realtime.c.
| pthread_t cleanup_thread = 0 |
Definition at line 79 of file pbx_realtime.c.
struct ast_switch realtime_switch [static] |
Definition at line 389 of file pbx_realtime.c.
struct ast_app_option switch_opts[128] = { [ 'p' ] = { .flag = OPTION_PATTERNS_DISABLED },} [static] |
Definition at line 68 of file pbx_realtime.c.
Referenced by realtime_common().
