Mon Mar 20 08:20:26 2006

Asterisk developer's documentation

---

enum.h File Reference

DNS and ENUM functions. More...

#include "asterisk/channel.h"

Go to the source code of this file.

Functions
int	ast_enum_init (void)
int	ast_enum_reload (void)
int	ast_get_enum (struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char *suffix, char *options)
	Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup.
int	ast_get_txt (struct ast_channel *chan, const char *number, char *location, int maxloc, char *technology, int maxtech, char *txt, int maxtxt)
	Lookup DNS TXT record (used by app TXTCIDnum.

---

Detailed Description

DNS and ENUM functions.

Definition in file enum.h.

---

Function Documentation

int ast_enum_init (  void   )

Definition at line 622 of file enum.c. References ast_config_destroy(), ast_config_load(), ast_mutex_lock(), ast_mutex_unlock(), ast_variable_browse(), cfg, enum_newtoplev(), enumver, free, ast_variable::name, ast_variable::next, enum_search::next, s, TOPLEV, toplevs, and ast_variable::value. Referenced by ast_enum_reload(), and main(). { struct ast_config *cfg; struct enum_search *s, *sl; struct ast_variable *v; /* Destroy existing list */ ast_mutex_lock(&enumlock); s = toplevs; while(s) { sl = s; s = s->next; free(sl); } toplevs = NULL; cfg = ast_config_load("enum.conf"); if (cfg) { sl = NULL; v = ast_variable_browse(cfg, "general"); while(v) { if (!strcasecmp(v->name, "search")) { s = enum_newtoplev(v->value); if (s) { if (sl) sl->next = s; else toplevs = s; sl = s; } } v = v->next; } ast_config_destroy(cfg); } else { toplevs = enum_newtoplev(TOPLEV); } enumver++; ast_mutex_unlock(&enumlock); return 0; }

int ast_enum_reload (  void   )

Definition at line 663 of file enum.c. References ast_enum_init(). Referenced by ast_module_reload(), and main(). { return ast_enum_init(); }

int ast_get_enum (  struct ast_channel *  chan, const char *  number, char *  location, int  maxloc, char *  technology, int  maxtech, char *  suffix, char *  options )

Lookup entry in ENUM Returns 1 if found, 0 if not found, -1 on hangup. Parameters: chan  Channel number  E164 number with or without the leading + location  Number returned (or SIP uri) maxloc  Max length technology  Technology (from url scheme in response) You can set it to get particular answer RR, if there are many techs in DNS response, example: "sip" If you need any record, then set it to empty string maxtech  Max length suffix  Zone suffix (if is NULL then use enum.conf 'search' variable) options  Options ('c' to count number of NAPTR RR, or number - the position of required RR in the answer list Definition at line 384 of file enum.c. References ast_autoservice_start(), ast_autoservice_stop(), ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_search_dns(), enum_context::dst, enum_context::dstlen, enum_callback(), free, LOG_DEBUG, enum_naptr_rr::naptr, enum_context::naptr_rrs, enum_context::naptr_rrs_count, enum_context::naptrinput, enum_search::next, enum_context::options, naptr::order, enum_context::position, naptr::pref, enum_naptr_rr::result, s, enum_naptr_rr::sort_pos, enum_naptr_rr::tech, enum_context::tech, enum_context::techlen, and enum_search::toplev. Referenced by enumlookup_exec(), and function_enum(). { struct enum_context context; char tmp[259 + 512]; char naptrinput[512]; int pos = strlen(number) - 1; int newpos = 0; int ret = -1; struct enum_search *s = NULL; int version = -1; /* for ISN rewrite */ char *p1 = NULL; char *p2 = NULL; int k = 0; int i = 0; int z = 0; if (number[0] == 'n') { strncpy(naptrinput, number+1, sizeof(naptrinput)); } else { strncpy(naptrinput, number, sizeof(naptrinput)); } context.naptrinput = naptrinput; /* The number */ context.dst = dst; /* Return string */ context.dstlen = dstlen; context.tech = tech; context.techlen = techlen; context.options = 0; context.position = 1; context.naptr_rrs = NULL; context.naptr_rrs_count = 0; if (options != NULL){ if (*options == 'c'){ context.options = ENUMLOOKUP_OPTIONS_COUNT; context.position = 0; } else { context.position = atoi(options); if (context.position < 1) context.position = 1; } } if (pos > 128) pos = 128; /* ISN rewrite */ p1 = strchr(number, '*'); if (number[0] == 'n') { /* do not perform ISN rewrite ('n' is testing flag) */ p1 = NULL; k = 1; /* strip 'n' from number */ } if (p1 != NULL) { p2 = p1+1; while (p1 > number){ p1--; tmp[newpos++] = *p1; tmp[newpos++] = '.'; } if (*p2) { while(*p2 && newpos < 128){ tmp[newpos++] = *p2; p2++; } tmp[newpos++] = '.'; } } else { while (pos >= k) { if (isdigit(number[pos])) { tmp[newpos++] = number[pos]; tmp[newpos++] = '.'; } pos--; } } if (chan && ast_autoservice_start(chan) < 0) return -1; for (;;) { ast_mutex_lock(&enumlock); if (version != enumver) { /* Ooh, a reload... */ s = toplevs; version = enumver; } else { s = s->next; } if (suffix != NULL) { strncpy(tmp + newpos, suffix, sizeof(tmp) - newpos - 1); } else if (s) { strncpy(tmp + newpos, s->toplev, sizeof(tmp) - newpos - 1); } ast_mutex_unlock(&enumlock); if (!s) break; ret = ast_search_dns(&context, tmp, C_IN, T_NAPTR, enum_callback); if (ret > 0) break; if (suffix != NULL) break; } if (ret < 0) { ast_log(LOG_DEBUG, "No such number found: %s (%s)\n", tmp, strerror(errno)); ret = 0; } if (context.naptr_rrs_count >= context.position && ! (context.options & ENUMLOOKUP_OPTIONS_COUNT)) { /* sort array by NAPTR order/preference */ for (k=0; k<context.naptr_rrs_count; k++) { for (i=0; i<context.naptr_rrs_count; i++) { /* use order first and then preference to compare */ if ((ntohs(context.naptr_rrs[k].naptr.order) < ntohs(context.naptr_rrs[i].naptr.order) && context.naptr_rrs[k].sort_pos > context.naptr_rrs[i].sort_pos) || (ntohs(context.naptr_rrs[k].naptr.order) > ntohs(context.naptr_rrs[i].naptr.order) && context.naptr_rrs[k].sort_pos < context.naptr_rrs[i].sort_pos)){ z = context.naptr_rrs[k].sort_pos; context.naptr_rrs[k].sort_pos = context.naptr_rrs[i].sort_pos; context.naptr_rrs[i].sort_pos = z; continue; } if (ntohs(context.naptr_rrs[k].naptr.order) == ntohs(context.naptr_rrs[i].naptr.order)) { if ((ntohs(context.naptr_rrs[k].naptr.pref) < ntohs(context.naptr_rrs[i].naptr.pref) && context.naptr_rrs[k].sort_pos > context.naptr_rrs[i].sort_pos) || (ntohs(context.naptr_rrs[k].naptr.pref) > ntohs(context.naptr_rrs[i].naptr.pref) && context.naptr_rrs[k].sort_pos < context.naptr_rrs[i].sort_pos)){ z = context.naptr_rrs[k].sort_pos; context.naptr_rrs[k].sort_pos = context.naptr_rrs[i].sort_pos; context.naptr_rrs[i].sort_pos = z; } } } } for (k=0; k<context.naptr_rrs_count; k++) { if (context.naptr_rrs[k].sort_pos == context.position-1) { ast_copy_string(context.dst, context.naptr_rrs[k].result, dstlen); ast_copy_string(context.tech, context.naptr_rrs[k].tech, techlen); break; } } } else if (!(context.options & ENUMLOOKUP_OPTIONS_COUNT)) { context.dst[0] = 0; } if (chan) ret |= ast_autoservice_stop(chan); for (k=0; k<context.naptr_rrs_count; k++) { free(context.naptr_rrs[k].result); free(context.naptr_rrs[k].tech); } free(context.naptr_rrs); return ret; }

int ast_get_txt (  struct ast_channel *  chan, const char *  number, char *  location, int  maxloc, char *  technology, int  maxtech, char *  txt, int  maxtxt )

Lookup DNS TXT record (used by app TXTCIDnum. Parameters: chan  Channel number  E164 number with or without the leading + location  Number returned (or SIP uri) maxloc  Max length of number technology  Technology (not used in TXT records) maxtech  Max length txt  Text string (return value) maxtxt  Max length of "txt" Definition at line 548 of file enum.c. References ast_autoservice_start(), ast_autoservice_stop(), ast_log(), ast_mutex_lock(), ast_mutex_unlock(), ast_search_dns(), enum_context::dst, enum_context::dstlen, LOG_DEBUG, enum_context::naptrinput, enum_search::next, s, enum_context::tech, enum_context::techlen, enum_search::toplev, enum_context::txt, txt_callback(), and enum_context::txtlen. Referenced by function_txtcidname(), and txtcidname_exec(). { struct enum_context context; char tmp[259 + 512]; char naptrinput[512] = "+"; int pos = strlen(number) - 1; int newpos = 0; int ret = -1; struct enum_search *s = NULL; int version = -1; strncat(naptrinput, number, sizeof(naptrinput) - 2); context.naptrinput = naptrinput; context.dst = dst; context.dstlen = dstlen; context.tech = tech; context.techlen = techlen; context.txt = txt; context.txtlen = txtlen; if (pos > 128) pos = 128; while (pos >= 0) { tmp[newpos++] = number[pos--]; tmp[newpos++] = '.'; } if (chan && ast_autoservice_start(chan) < 0) return -1; for (;;) { ast_mutex_lock(&enumlock); if (version != enumver) { /* Ooh, a reload... */ s = toplevs; version = enumver; } else { s = s->next; } if (s) { strncpy(tmp + newpos, s->toplev, sizeof(tmp) - newpos - 1); } ast_mutex_unlock(&enumlock); if (!s) break; ret = ast_search_dns(&context, tmp, C_IN, T_TXT, txt_callback); if (ret > 0) break; } if (ret < 0) { ast_log(LOG_DEBUG, "No such number found: %s (%s)\n", tmp, strerror(errno)); ret = 0; } if (chan) ret |= ast_autoservice_stop(chan); return ret; }

---