Sun Aug 6 15:15:16 2006

Asterisk developer's documentation

---

res_adsi.c File Reference

ADSI support. More...

#include <time.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <math.h>
#include <errno.h>
#include "asterisk.h"
#include "asterisk/ulaw.h"
#include "asterisk/alaw.h"
#include "asterisk/callerid.h"
#include "asterisk/logger.h"
#include "asterisk/fskmodem.h"
#include "asterisk/channel.h"
#include "asterisk/adsi.h"
#include "asterisk/module.h"
#include "asterisk/config.h"
#include "asterisk/file.h"

Include dependency graph for res_adsi.c:

Go to the source code of this file.

Defines
#define	ADSI_FLAG_DATAMODE   (1 << 8)
#define	ADSI_MAX_INTRO   20
#define	ADSI_MAX_SPEED_DIAL   6
#define	ADSI_SPEED_DIAL   10
#define	DEFAULT_ADSI_MAX_RETRIES   3
Functions
static int	__adsi_transmit_messages (struct ast_channel *chan, unsigned char **msg, int *msglen, int *msgtype)
int	adsi_available (struct ast_channel *chan)
int	adsi_begin_download (struct ast_channel *chan, char *service, unsigned char *fdn, unsigned char *sec, int version)
static int	adsi_careful_send (struct ast_channel *chan, unsigned char *buf, int len, int *remainder)
int	adsi_channel_restore (struct ast_channel *chan)
int	adsi_clear_screen (unsigned char *buf)
int	adsi_clear_soft_keys (unsigned char *buf)
int	adsi_connect_session (unsigned char *buf, unsigned char *fdn, int ver)
int	adsi_data_mode (unsigned char *buf)
int	adsi_disconnect_session (unsigned char *buf)
int	adsi_display (unsigned char *buf, int page, int line, int just, int wrap, char *col1, char *col2)
int	adsi_download_connect (unsigned char *buf, char *service, unsigned char *fdn, unsigned char *sec, int ver)
int	adsi_download_disconnect (unsigned char *buf)
int	adsi_end_download (struct ast_channel *chan)
static int	adsi_generate (unsigned char *buf, int msgtype, unsigned char *msg, int msglen, int msgnum, int last, int codec)
int	adsi_get_cpeid (struct ast_channel *chan, unsigned char *cpeid, int voice)
int	adsi_get_cpeinfo (struct ast_channel *chan, int *width, int *height, int *buttons, int voice)
int	adsi_input_control (unsigned char *buf, int page, int line, int display, int format, int just)
int	adsi_input_format (unsigned char *buf, int num, int dir, int wrap, char *format1, char *format2)
static void	adsi_load (void)
int	adsi_load_session (struct ast_channel *chan, unsigned char *app, int ver, int data)
int	adsi_load_soft_key (unsigned char *buf, int key, char *llabel, char *slabel, char *ret, int data)
int	adsi_print (struct ast_channel *chan, char **lines, int *aligns, int voice)
int	adsi_query_cpeid (unsigned char *buf)
int	adsi_query_cpeinfo (unsigned char *buf)
int	adsi_read_encoded_dtmf (struct ast_channel *chan, unsigned char *buf, int maxlen)
int	adsi_set_keys (unsigned char *buf, unsigned char *keys)
int	adsi_set_line (unsigned char *buf, int page, int line)
int	adsi_transmit_message (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype)
int	adsi_transmit_message_full (struct ast_channel *chan, unsigned char *msg, int msglen, int msgtype, int dowait)
int	adsi_unload_session (struct ast_channel *chan)
int	adsi_voice_mode (unsigned char *buf, int when)
static int	ccopy (unsigned char *dst, unsigned char *src, int max)
char *	description (void)
	Provides a description of the module.
static void	init_state (void)
char *	key ()
	Returns the ASTERISK_GPL_KEY.
int	load_module (void)
	Initialize the module.
int	reload (void)
	Reload stuff.
static int	str2align (char *s)
int	unload_module (void)
	Cleanup all module structures, sockets, etc.
int	usecount (void)
	Provides a usecount.
Variables
static int	alignment = 0
static int	aligns [ADSI_MAX_INTRO]
static char	intro [ADSI_MAX_INTRO][20]
static int	maxretries = DEFAULT_ADSI_MAX_RETRIES
static char	speeddial [ADSI_MAX_SPEED_DIAL][3][20]
static int	speeds = 0
static int	total = 0

---

Detailed Description

ADSI support.

Definition in file res_adsi.c.

---

Define Documentation

#define ADSI_FLAG_DATAMODE   (1 << 8)

Definition at line 55 of file res_adsi.c. Referenced by __adsi_transmit_messages(), and adsi_transmit_message_full().

#define ADSI_MAX_INTRO   20

Definition at line 52 of file res_adsi.c. Referenced by adsi_load(), and init_state().

#define ADSI_MAX_SPEED_DIAL   6

Definition at line 53 of file res_adsi.c. Referenced by adsi_load().

#define ADSI_SPEED_DIAL   10

Definition at line 60 of file res_adsi.c. Referenced by adsi_channel_restore().

#define DEFAULT_ADSI_MAX_RETRIES   3

Definition at line 50 of file res_adsi.c.

---

Function Documentation

static int __adsi_transmit_messages (  struct ast_channel *  chan, unsigned char **  msg, int *  msglen, int *  msgtype )  [static]

Definition at line 190 of file res_adsi.c. References adsi_careful_send(), ADSI_FLAG_DATAMODE, adsi_generate(), ast_channel::adsicpe, AST_ADSI_AVAILABLE, AST_ADSI_UNAVAILABLE, ast_channel_defer_dtmf(), ast_channel_undefer_dtmf(), AST_FORMAT_ULAW, AST_FRAME_DTMF, ast_frfree(), ast_gen_cas(), ast_log(), ast_read(), ast_readstring(), ast_waitfor(), ast_frame::frametype, LOG_DEBUG, LOG_WARNING, maxretries, ast_channel::name, and ast_frame::subclass. Referenced by adsi_transmit_message_full(). { /* msglen must be no more than 256 bits, each */ unsigned char buf[24000 * 5]; int pos = 0, res; int x; int start=0; int retries = 0; char ack[3]; /* Wait up to 500 ms for initial ACK */ int waittime; struct ast_frame *f; int rem = 0; int def; if (chan->adsicpe == AST_ADSI_UNAVAILABLE) { /* Don't bother if we know they don't support ADSI */ errno = ENOSYS; return -1; } while(retries < maxretries) { if (!(chan->adsicpe & ADSI_FLAG_DATAMODE)) { /* Generate CAS (no SAS) */ ast_gen_cas(buf, 0, 680, AST_FORMAT_ULAW); /* Send CAS */ if (adsi_careful_send(chan, buf, 680, NULL)) { ast_log(LOG_WARNING, "Unable to send CAS\n"); } /* Wait For DTMF result */ waittime = 500; for(;;) { if (((res = ast_waitfor(chan, waittime)) < 1)) { /* Didn't get back DTMF A in time */ ast_log(LOG_DEBUG, "No ADSI CPE detected (%d)\n", res); if (!chan->adsicpe) chan->adsicpe = AST_ADSI_UNAVAILABLE; errno = ENOSYS; return -1; } waittime = res; f = ast_read(chan); if (!f) { ast_log(LOG_DEBUG, "Hangup in ADSI\n"); return -1; } if (f->frametype == AST_FRAME_DTMF) { if (f->subclass == 'A') { /* Okay, this is an ADSI CPE. Note this for future reference, too */ if (!chan->adsicpe) chan->adsicpe = AST_ADSI_AVAILABLE; break; } else { if (f->subclass == 'D') { ast_log(LOG_DEBUG, "Off-hook capable CPE only, not ADSI\n"); } else ast_log(LOG_WARNING, "Unknown ADSI response '%c'\n", f->subclass); if (!chan->adsicpe) chan->adsicpe = AST_ADSI_UNAVAILABLE; errno = ENOSYS; return -1; } } ast_frfree(f); } ast_log(LOG_DEBUG, "ADSI Compatible CPE Detected\n"); } else ast_log(LOG_DEBUG, "Already in data mode\n"); x = 0; pos = 0; #if 1 def= ast_channel_defer_dtmf(chan); #endif while((x < 6) && msg[x]) { res = adsi_generate(buf + pos, msgtype[x], msg[x], msglen[x], x+1 - start, (x == 5) || !msg[x+1], AST_FORMAT_ULAW); if (res < 0) { ast_log(LOG_WARNING, "Failed to generate ADSI message %d on channel %s\n", x + 1, chan->name); return -1; } ast_log(LOG_DEBUG, "Message %d, of %d input bytes, %d output bytes\n", x + 1, msglen[x], res); pos += res; x++; } rem = 0; res = adsi_careful_send(chan, buf, pos, &rem); if (!def) ast_channel_undefer_dtmf(chan); if (res) return -1; ast_log(LOG_DEBUG, "Sent total spill of %d bytes\n", pos); memset(ack, 0, sizeof(ack)); /* Get real result */ res = ast_readstring(chan, ack, 2, 1000, 1000, ""); /* Check for hangup */ if (res < 0) return -1; if (ack[0] == 'D') { ast_log(LOG_DEBUG, "Acked up to message %d\n", atoi(ack + 1)); start += atoi(ack + 1); if (start >= x) break; else { retries++; ast_log(LOG_DEBUG, "Retransmitting (%d), from %d\n", retries, start + 1); } } else { retries++; ast_log(LOG_WARNING, "Unexpected response to ack: %s (retry %d)\n", ack, retries); } } if (retries >= maxretries) { ast_log(LOG_WARNING, "Maximum ADSI Retries (%d) exceeded\n", maxretries); errno = ETIMEDOUT; return -1; } return 0; }

int adsi_available (  struct ast_channel *  chan  )

Parameters: chan  Channel to check Definition at line 762 of file res_adsi.c. References ast_channel::adsicpe, AST_ADSI_AVAILABLE, and AST_ADSI_UNKNOWN. Referenced by adsi_begin(), adsi_delete(), adsi_exec(), adsi_folders(), adsi_goodbye(), adsi_login(), adsi_message(), adsi_password(), adsi_status(), adsi_status2(), ast_park_call(), vm_newuser(), vm_options(), and vm_tempgreeting(). { int cpe = chan->adsicpe & 0xff; if ((cpe == AST_ADSI_AVAILABLE) || (cpe == AST_ADSI_UNKNOWN)) return 1; return 0; }

int adsi_begin_download (  struct ast_channel *  chan, char *  service, unsigned char *  fdn, unsigned char *  sec, int  version )

Definition at line 319 of file res_adsi.c. References adsi_download_connect(), ADSI_MSG_DOWNLOAD, adsi_transmit_message_full(), ast_log(), ast_readstring(), and LOG_DEBUG. Referenced by adsi_load_vmail(), and adsi_prog(). { int bytes; unsigned char buf[256]; char ack[2]; bytes = 0; /* Setup the resident soft key stuff, a piece at a time */ /* Upload what scripts we can for voicemail ahead of time */ bytes += adsi_download_connect(buf + bytes, service, fdn, sec, version); if (adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DOWNLOAD, 0)) return -1; if (ast_readstring(chan, ack, 1, 10000, 10000, "")) return -1; if (ack[0] == 'B') return 0; ast_log(LOG_DEBUG, "Download was denied by CPE\n"); return -1; }

static int adsi_careful_send (  struct ast_channel *  chan, unsigned char *  buf, int  len, int *  remainder )  [static]

Definition at line 119 of file res_adsi.c. References AST_FORMAT_ULAW, AST_FRAME_VOICE, ast_frfree(), ast_log(), ast_read(), ast_waitfor(), ast_write(), ast_frame::datalen, ast_frame::frametype, LOG_WARNING, and ast_frame::subclass. Referenced by __adsi_transmit_messages(). { /* Sends carefully on a full duplex channel by using reading for timing */ struct ast_frame *inf, outf; int amt; /* Zero out our outgoing frame */ memset(&outf, 0, sizeof(outf)); if (remainder && *remainder) { amt = len; /* Send remainder if provided */ if (amt > *remainder) amt = *remainder; else *remainder = *remainder - amt; outf.frametype = AST_FRAME_VOICE; outf.subclass = AST_FORMAT_ULAW; outf.data = buf; outf.datalen = amt; outf.samples = amt; if (ast_write(chan, &outf)) { ast_log(LOG_WARNING, "Failed to carefully write frame\n"); return -1; } /* Update pointers and lengths */ buf += amt; len -= amt; } while(len) { amt = len; /* If we don't get anything at all back in a second, forget about it */ if (ast_waitfor(chan, 1000) < 1) return -1; inf = ast_read(chan); /* Detect hangup */ if (!inf) return -1; if (inf->frametype == AST_FRAME_VOICE) { /* Read a voice frame */ if (inf->subclass != AST_FORMAT_ULAW) { ast_log(LOG_WARNING, "Channel not in ulaw?\n"); return -1; } /* Send no more than they sent us */ if (amt > inf->datalen) amt = inf->datalen; else if (remainder) *remainder = inf->datalen - amt; outf.frametype = AST_FRAME_VOICE; outf.subclass = AST_FORMAT_ULAW; outf.data = buf; outf.datalen = amt; outf.samples = amt; if (ast_write(chan, &outf)) { ast_log(LOG_WARNING, "Failed to carefully write frame\n"); return -1; } /* Update pointers and lengths */ buf += amt; len -= amt; } ast_frfree(inf); } return 0; }

int adsi_channel_restore (  struct ast_channel *  chan  )

Parameters: chan  Channel to restore Returns 0 on success (or adsi unavailable) and -1 on hangup Definition at line 920 of file res_adsi.c. References ADSI_INFO_PAGE, ADSI_MSG_DISPLAY, adsi_set_keys(), adsi_set_line(), ADSI_SPEED_DIAL, adsi_transmit_message_full(), dsp, and speeds. { unsigned char dsp[256]; int bytes; int x; unsigned char keyd[6]; memset(dsp, 0, sizeof(dsp)); /* Start with initial display setup */ bytes = 0; bytes += adsi_set_line(dsp + bytes, ADSI_INFO_PAGE, 1); /* Prepare key setup messages */ if (speeds) { memset(keyd, 0, sizeof(keyd)); for (x=0;x<speeds;x++) { keyd[x] = ADSI_SPEED_DIAL + x; } bytes += adsi_set_keys(dsp + bytes, keyd); } adsi_transmit_message_full(chan, dsp, bytes, ADSI_MSG_DISPLAY, 0); return 0; }

int adsi_clear_screen (  unsigned char *  buf  )

Definition at line 730 of file res_adsi.c. References ADSI_CLEAR_SCREEN. { int bytes=0; /* Message type */ buf[bytes++] = ADSI_CLEAR_SCREEN; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_clear_soft_keys (  unsigned char *  buf  )

Definition at line 715 of file res_adsi.c. References ADSI_CLEAR_SOFTKEY. { int bytes=0; /* Message type */ buf[bytes++] = ADSI_CLEAR_SOFTKEY; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_connect_session (  unsigned char *  buf, unsigned char *  fdn, int  ver )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) fdn  Optional 4 byte Feature Download Number (for loading soft keys) ver  Optional version number (0-255, or -1 to omit) Returns number of bytes added to buffer or -1 on error. Definition at line 480 of file res_adsi.c. References ADSI_CONNECT_SESSION. Referenced by adsi_load_session(). { int bytes=0; int x; /* Message type */ buf[bytes++] = ADSI_CONNECT_SESSION; /* Reserve space for length */ bytes++; if (fdn) { for (x=0;x<4;x++) buf[bytes++] = fdn[x]; if (ver > -1) buf[bytes++] = ver & 0xff; } buf[1] = bytes - 2; return bytes; }

int adsi_data_mode (  unsigned char *  buf  )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) Returns number of bytes added to buffer or -1 on error. Definition at line 700 of file res_adsi.c. References ADSI_SWITCH_TO_DATA. Referenced by adsi_get_cpeid(), adsi_get_cpeinfo(), adsi_load_session(), and adsi_load_vmail(). { int bytes=0; /* Message type */ buf[bytes++] = ADSI_SWITCH_TO_DATA; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_disconnect_session (  unsigned char *  buf  )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) Returns number of bytes added to buffer or -1 on error. Definition at line 533 of file res_adsi.c. References ADSI_DISC_SESSION. Referenced by adsi_unload_session(). { int bytes=0; /* Message type */ buf[bytes++] = ADSI_DISC_SESSION; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_display (  unsigned char *  buf, int  page, int  line, int  just, int  wrap, char *  col1, char *  col2 )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) page  Page to load (ADSI_COMM_PAGE or ADSI_INFO_PAGE) line  Line number to load (1-4 for Comm page, 1-33 for info page) just  Line justification (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CENT, ADSI_JUST_IND) wrap  Wrap (1 = yes, 0 = no) col1  Text to place in first column col2  Text to place in second column Returns number of bytes added to buffer or -1 on error. Definition at line 786 of file res_adsi.c. References ADSI_LOAD_VIRTUAL_DISP, and ccopy(). Referenced by adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_logo(), adsi_message(), adsi_print(), adsi_prog(), adsi_status(), adsi_status2(), vm_newuser(), vm_options(), and vm_tempgreeting(). { int bytes=0; /* Sanity check line number */ if (page) { if (line > 4) return -1; } else { if (line > 33) return -1; } if (line < 1) return -1; /* Parameter type */ buf[bytes++] = ADSI_LOAD_VIRTUAL_DISP; /* Reserve space for size */ bytes++; /* Page and wrap indicator */ buf[bytes++] = ((page & 0x1) << 7) | ((wrap & 0x1) << 6) | (line & 0x3f); /* Justification */ buf[bytes++] = (just & 0x3) << 5; /* Omit highlight mode definition */ buf[bytes++] = 0xff; /* Primary column */ bytes+= ccopy(buf + bytes, (unsigned char *)col1, 20); /* Delimiter */ buf[bytes++] = 0xff; /* Secondary column */ bytes += ccopy(buf + bytes, (unsigned char *)col2, 20); /* Update length */ buf[1] = bytes - 2; return bytes; }

int adsi_download_connect (  unsigned char *  buf, char *  service, unsigned char *  fdn, unsigned char *  sec, int  ver )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) service  a 1-18 byte name of the feature fdn  4 byte Feature Download Number (for loading soft keys) sec  4 byte vendor security code ver  version number (0-255, or -1 to omit) Returns number of bytes added to buffer or -1 on error. Definition at line 503 of file res_adsi.c. References ADSI_DOWNLOAD_CONNECT, and ccopy(). Referenced by adsi_begin_download(). { int bytes=0; int x; /* Message type */ buf[bytes++] = ADSI_DOWNLOAD_CONNECT; /* Reserve space for length */ bytes++; /* Primary column */ bytes+= ccopy(buf + bytes, (unsigned char *)service, 18); /* Delimiter */ buf[bytes++] = 0xff; for (x=0;x<4;x++) { buf[bytes++] = fdn[x]; } for (x=0;x<4;x++) buf[bytes++] = sec[x]; buf[bytes++] = ver & 0xff; buf[1] = bytes - 2; return bytes; }

int adsi_download_disconnect (  unsigned char *  buf  )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) Returns number of bytes added to buffer or -1 on error. Definition at line 771 of file res_adsi.c. References ADSI_DOWNLOAD_DISC. Referenced by adsi_end_download(), and adsi_load_vmail(). { int bytes=0; /* Message type */ buf[bytes++] = ADSI_DOWNLOAD_DISC; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_end_download (  struct ast_channel *  chan  )

Definition at line 338 of file res_adsi.c. References adsi_download_disconnect(), ADSI_MSG_DOWNLOAD, and adsi_transmit_message_full(). Referenced by adsi_load_vmail(), and adsi_prog(). { int bytes; unsigned char buf[256]; bytes = 0; /* Setup the resident soft key stuff, a piece at a time */ /* Upload what scripts we can for voicemail ahead of time */ bytes += adsi_download_disconnect(buf + bytes); if (adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DOWNLOAD, 0)) return -1; return 0; }

static int adsi_generate (  unsigned char *  buf, int  msgtype, unsigned char *  msg, int  msglen, int  msgnum, int  last, int  codec )  [static]

Definition at line 69 of file res_adsi.c. References PUT_CLID, and PUT_CLID_MARKMS. Referenced by __adsi_transmit_messages(). { int sum; int x; int bytes=0; /* Initial carrier (imaginary) */ float cr = 1.0; float ci = 0.0; float scont = 0.0; if (msglen > 255) msglen = 255; /* If first message, Send 150ms of MARK's */ if (msgnum == 1) { for (x=0;x<150;x++) /* was 150 */ PUT_CLID_MARKMS; } /* Put message type */ PUT_CLID(msgtype); sum = msgtype; /* Put message length (plus one for the message number) */ PUT_CLID(msglen + 1); sum += msglen + 1; /* Put message number */ PUT_CLID(msgnum); sum += msgnum; /* Put actual message */ for (x=0;x<msglen;x++) { PUT_CLID(msg[x]); sum += msg[x]; } /* Put 2's compliment of sum */ PUT_CLID(256-(sum & 0xff)); #if 0 if (last) { /* Put trailing marks */ for (x=0;x<50;x++) PUT_CLID_MARKMS; } #endif return bytes; }

int adsi_get_cpeid (  struct ast_channel *  chan, unsigned char *  cpeid, int  voice )

Returns 1 on success, storing 4 bytes of CPE ID at buf or -1 on hangup, or 0 if there was no hangup but it failed to find the device ID. Returns to voice mode if "voice" is non-zero. Definition at line 603 of file res_adsi.c. References adsi_data_mode(), ADSI_MSG_DISPLAY, adsi_query_cpeid(), adsi_read_encoded_dtmf(), adsi_transmit_message_full(), adsi_voice_mode(), ast_log(), ast_waitfordigit(), and LOG_WARNING. Referenced by cpeid_exec(). { unsigned char buf[256]; int bytes = 0; int res; bytes += adsi_data_mode(buf); adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); bytes = 0; bytes += adsi_query_cpeid(buf); adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); /* Get response */ memset(buf, 0, sizeof(buf)); res = adsi_read_encoded_dtmf(chan, cpeid, 4); if (res != 4) { ast_log(LOG_WARNING, "Got %d bytes back of encoded DTMF, expecting 4\n", res); res = 0; } else { res = 1; } if (voice) { bytes = 0; bytes += adsi_voice_mode(buf, 0); adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); /* Ignore the resulting DTMF B announcing it's in voice mode */ ast_waitfordigit(chan, 1000); } return res; }

int adsi_get_cpeinfo (  struct ast_channel *  chan, int *  width, int *  height, int *  buttons, int  voice )

Definition at line 635 of file res_adsi.c. References adsi_data_mode(), ADSI_MSG_DISPLAY, adsi_query_cpeinfo(), adsi_transmit_message_full(), adsi_voice_mode(), ast_log(), ast_readstring(), ast_waitfordigit(), and LOG_WARNING. Referenced by cpeid_exec(). { unsigned char buf[256]; int bytes = 0; int res; bytes += adsi_data_mode(buf); adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); bytes = 0; bytes += adsi_query_cpeinfo(buf); adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); /* Get width */ memset(buf, 0, sizeof(buf)); res = ast_readstring(chan, (char *)buf, 2, 1000, 500, ""); if (res < 0) return res; if (strlen((char *)buf) != 2) { ast_log(LOG_WARNING, "Got %d bytes of width, expecting 2\n", res); res = 0; } else { res = 1; } if (width) *width = atoi((char *)buf); /* Get height */ memset(buf, 0, sizeof(buf)); if (res) { res = ast_readstring(chan, (char *)buf, 2, 1000, 500, ""); if (res < 0) return res; if (strlen((char *)buf) != 2) { ast_log(LOG_WARNING, "Got %d bytes of height, expecting 2\n", res); res = 0; } else { res = 1; } if (height) *height= atoi((char *)buf); } /* Get buttons */ memset(buf, 0, sizeof(buf)); if (res) { res = ast_readstring(chan, (char *)buf, 1, 1000, 500, ""); if (res < 0) return res; if (strlen((char *)buf) != 1) { ast_log(LOG_WARNING, "Got %d bytes of buttons, expecting 1\n", res); res = 0; } else { res = 1; } if (buttons) *buttons = atoi((char *)buf); } if (voice) { bytes = 0; bytes += adsi_voice_mode(buf, 0); adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); /* Ignore the resulting DTMF B announcing it's in voice mode */ ast_waitfordigit(chan, 1000); } return res; }

int adsi_input_control (  unsigned char *  buf, int  page, int  line, int  display, int  format, int  just )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) page  Which page to input on (ADSI_COMM_PAGE or ADSI_INFO_PAGE) line  Line number to input on display  Set to zero to obscure input, or 1 to leave visible format  Format number to use (0-7) just  Justification (left, right center, indent) Returns number of bytes added to buffer or -1 on error. Definition at line 832 of file res_adsi.c. References ADSI_INPUT_CONTROL. Referenced by adsi_login(), and adsi_password(). { int bytes=0; if (page) { if (line > 4) return -1; } else { if (line > 33) return -1; } if (line < 1) return -1; buf[bytes++] = ADSI_INPUT_CONTROL; bytes++; buf[bytes++] = ((page & 1) << 7) | (line & 0x3f); buf[bytes++] = ((display & 1) << 7) | ((just & 0x3) << 4) | (format & 0x7); buf[1] = bytes - 2; return bytes; }

int adsi_input_format (  unsigned char *  buf, int  num, int  dir, int  wrap, char *  format1, char *  format2 )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) num  Which format we are setting dir  Which direction (ADSI_DIR_FROM_LEFT or ADSI_DIR_FROM_RIGHT) wrap  Set to 1 to permit line wrap, or 0 if not format1  Format for column 1 format2  Format for column 2 Returns number of bytes added to buffer or -1 on error. Definition at line 855 of file res_adsi.c. References ADSI_INPUT_FORMAT, and ccopy(). Referenced by adsi_login(), and adsi_password(). { int bytes = 0; if (!strlen((char *)format1)) return -1; buf[bytes++] = ADSI_INPUT_FORMAT; bytes++; buf[bytes++] = ((dir & 1) << 7) | ((wrap & 1) << 6) | (num & 0x7); bytes += ccopy(buf + bytes, (unsigned char *)format1, 20); buf[bytes++] = 0xff; if (format2 && strlen((char *)format2)) { bytes += ccopy(buf + bytes, (unsigned char *)format2, 20); } buf[1] = bytes - 2; return bytes; }

static void adsi_load (  void   )  [static]

Definition at line 1055 of file res_adsi.c. References ADSI_MAX_INTRO, ADSI_MAX_SPEED_DIAL, alignment, aligns, ast_config_destroy(), ast_config_load(), ast_variable_browse(), init_state(), intro, maxretries, ast_variable::name, name, ast_variable::next, speeddial, speeds, str2align(), strsep(), total, and ast_variable::value. Referenced by load_module(), and reload(). { int x; struct ast_config *conf; struct ast_variable *v; char *name, *sname; init_state(); conf = ast_config_load("adsi.conf"); if (conf) { x=0; v = ast_variable_browse(conf, "intro"); while(v) { if (!strcasecmp(v->name, "alignment")) alignment = str2align(v->value); else if (!strcasecmp(v->name, "greeting")) { if (x < ADSI_MAX_INTRO) { aligns[x] = alignment; strncpy(intro[x], v->value, sizeof(intro[x]) - 1); intro[x][sizeof(intro[x]) - 1] = '\0'; x++; } } else if (!strcasecmp(v->name, "maxretries")) { if (atoi(v->value) > 0) maxretries = atoi(v->value); } v = v->next; } v = ast_variable_browse(conf, "speeddial"); if (x) total = x; x = 0; while(v) { char *stringp=NULL; stringp=v->value; name = strsep(&stringp, ","); sname = strsep(&stringp, ","); if (!sname) sname = name; if (x < ADSI_MAX_SPEED_DIAL) { /* Up to 20 digits */ strncpy(speeddial[x][0], v->name, sizeof(speeddial[x][0]) - 1); strncpy(speeddial[x][1], name, 18); strncpy(speeddial[x][2], sname, 7); x++; } v = v->next; } if (x) speeds = x; ast_config_destroy(conf); } }

int adsi_load_session (  struct ast_channel *  chan, unsigned char *  app, int  ver, int  data )

Parameters: chan  Channel to test for loaded app app  Four character app name (must be unique to your application) ver  optional version number data  Non-zero if you want to be put in data mode Returns 0 if scripts is not loaded or not an ADSI CPE. Returns -1 on hangup. Returns 1 if script already loaded. Definition at line 967 of file res_adsi.c. References adsi_connect_session(), adsi_data_mode(), ADSI_MSG_DISPLAY, adsi_transmit_message_full(), ast_log(), ast_readstring(), dsp, LOG_DEBUG, and LOG_WARNING. Referenced by adsi_announce_park(), adsi_begin(), adsi_load_vmail(), adsi_prog(), and cpeid_exec(). { unsigned char dsp[256]; int bytes; int res; char resp[2]; memset(dsp, 0, sizeof(dsp)); /* Connect to session */ bytes = 0; bytes += adsi_connect_session(dsp + bytes, app, ver); if (data) bytes += adsi_data_mode(dsp + bytes); /* Prepare key setup messages */ if (adsi_transmit_message_full(chan, dsp, bytes, ADSI_MSG_DISPLAY, 0)) return -1; if (app) { res = ast_readstring(chan, resp, 1, 1200, 1200, ""); if (res < 0) return -1; if (res) { ast_log(LOG_DEBUG, "No response from CPE about version. Assuming not there.\n"); return 0; } if (!strcmp(resp, "B")) { ast_log(LOG_DEBUG, "CPE has script '%s' version %d already loaded\n", app, ver); return 1; } else if (!strcmp(resp, "A")) { ast_log(LOG_DEBUG, "CPE hasn't script '%s' version %d already loaded\n", app, ver); } else { ast_log(LOG_WARNING, "Unexpected CPE response to script query: %s\n", resp); } } else return 1; return 0; }

int adsi_load_soft_key (  unsigned char *  buf, int  key, char *  llabel, char *  slabel, char *  ret, int  data )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) key  Key code from 2 to 33, for which key we are loading llabel  Long label for key (1-18 bytes) slabel  Short label for key (1-7 bytes) ret  Optional return sequence (NULL for none) data  whether to put CPE in data mode before sending digits Returns number of bytes added to buffer or -1 on error. Definition at line 441 of file res_adsi.c. References ADSI_LOAD_SOFTKEY, ADSI_SWITCH_TO_DATA2, and ccopy(). Referenced by adsi_load_vmail(), and adsi_login(). { int bytes=0; /* Abort if invalid key specified */ if ((key < 2) || (key > 33)) return -1; buf[bytes++] = ADSI_LOAD_SOFTKEY; /* Reserve for length */ bytes++; /* Which key */ buf[bytes++] = key; /* Carefully copy long label */ bytes += ccopy(buf + bytes, (unsigned char *)llabel, 18); /* Place delimiter */ buf[bytes++] = 0xff; /* Short label */ bytes += ccopy(buf + bytes, (unsigned char *)slabel, 7); /* If specified, copy return string */ if (ret) { /* Place delimiter */ buf[bytes++] = 0xff; if (data) buf[bytes++] = ADSI_SWITCH_TO_DATA2; /* Carefully copy return string */ bytes += ccopy(buf + bytes, (unsigned char *)ret, 20); } /* Replace parameter length */ buf[1] = bytes - 2; return bytes; }

int adsi_print (  struct ast_channel *  chan, char **  lines, int *  align, int  voice )

Parameters: chan  Channel to display on lines  NULL-terminated list of things to print (no more than 4 recommended) align  list of alignments to use (ADSI_JUST_LEFT, ADSI_JUST_RIGHT, ADSI_JUST_CEN, etc..) voice  whether to jump into voice mode when finished Return 0 on success (or adsi unavailable) and -1 on hangup Definition at line 947 of file res_adsi.c. References adsi_display(), ADSI_INFO_PAGE, ADSI_MSG_DISPLAY, adsi_set_line(), adsi_transmit_message_full(), adsi_voice_mode(), and ast_waitfordigit(). Referenced by adsi_announce_park(), and cpeid_setstatus(). { unsigned char buf[4096]; int bytes=0; int res; int x; for(x=0;lines[x];x++) bytes += adsi_display(buf + bytes, ADSI_INFO_PAGE, x+1, aligns[x], 0, lines[x], ""); bytes += adsi_set_line(buf + bytes, ADSI_INFO_PAGE, 1); if (voice) { bytes += adsi_voice_mode(buf + bytes, 0); } res = adsi_transmit_message_full(chan, buf, bytes, ADSI_MSG_DISPLAY, 0); if (voice) { /* Ignore the resulting DTMF B announcing it's in voice mode */ ast_waitfordigit(chan, 1000); } return res; }

int adsi_query_cpeid (  unsigned char *  buf  )

Returns number of bytes added to message Definition at line 548 of file res_adsi.c. References ADSI_QUERY_CPEID. Referenced by adsi_get_cpeid(). { int bytes = 0; buf[bytes++] = ADSI_QUERY_CPEID; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_query_cpeinfo (  unsigned char *  buf  )

Definition at line 558 of file res_adsi.c. References ADSI_QUERY_CONFIG. Referenced by adsi_get_cpeinfo(). { int bytes = 0; buf[bytes++] = ADSI_QUERY_CONFIG; /* Reserve space for length */ bytes++; buf[1] = bytes - 2; return bytes; }

int adsi_read_encoded_dtmf (  struct ast_channel *  chan, unsigned char *  buf, int  maxlen )

Returns number of bytes received Definition at line 568 of file res_adsi.c. References ast_waitfordigit(). Referenced by adsi_get_cpeid(). { int bytes = 0; int res; unsigned char current = 0; int gotstar = 0; int pos = 0; memset(buf, 0, sizeof(buf)); while(bytes <= maxlen) { /* Wait up to a second for a digit */ res = ast_waitfordigit(chan, 1000); if (!res) break; if (res == '*') { gotstar = 1; continue; } /* Ignore anything other than a digit */ if ((res < '0') || (res > '9')) continue; res -= '0'; if (gotstar) res += 9; if (pos) { pos = 0; buf[bytes++] = (res << 4) | current; } else { pos = 1; current = res; } gotstar = 0; } return bytes; }

int adsi_set_keys (  unsigned char *  buf, unsigned char *  keys )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) keys  Array of 8 unsigned chars with the key numbers, may be OR'd with ADSI_KEY_HILITE But remember, the last two keys aren't real keys, they're for scrolling Returns number of bytes added to buffer or -1 on error. Definition at line 874 of file res_adsi.c. References ADSI_INIT_SOFTKEY_LINE. Referenced by adsi_channel_restore(), adsi_delete(), adsi_folders(), adsi_login(), adsi_message(), adsi_password(), adsi_status(), and adsi_status2(). { int bytes=0; int x; /* Message type */ buf[bytes++] = ADSI_INIT_SOFTKEY_LINE; /* Space for size */ bytes++; /* Key definitions */ for (x=0;x<6;x++) buf[bytes++] = (keys[x] & 0x3f) ? keys[x] : (keys[x] | 0x1); buf[1] = bytes - 2; return bytes; }

int adsi_set_line (  unsigned char *  buf, int  page, int  line )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) page  Which page (ADSI_COMM_PAGE or ADSI_INFO_PAGE) line  Line number (1-33 for info page, 1-4 for comm page) Returns number of bytes added to buffer or -1 on error. Definition at line 889 of file res_adsi.c. References ADSI_LINE_CONTROL. Referenced by adsi_channel_restore(), adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_message(), adsi_password(), adsi_print(), adsi_prog(), adsi_status(), adsi_status2(), vm_newuser(), vm_options(), and vm_tempgreeting(). { int bytes=0; /* Sanity check line number */ if (page) { if (line > 4) return -1; } else { if (line > 33) return -1; } if (line < 1) return -1; /* Parameter type */ buf[bytes++] = ADSI_LINE_CONTROL; /* Reserve space for size */ bytes++; /* Page and line */ buf[bytes++] = ((page & 0x1) << 7) | (line & 0x3f); buf[1] = bytes - 2; return bytes; };

int adsi_transmit_message (  struct ast_channel *  chan, unsigned char *  msg, int  msglen, int  msgtype )

Definition at line 425 of file res_adsi.c. References adsi_transmit_message_full(). Referenced by adsi_delete(), adsi_folders(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_message(), adsi_password(), adsi_prog(), adsi_status(), adsi_status2(), vm_newuser(), vm_options(), and vm_tempgreeting(). { return adsi_transmit_message_full(chan, msg, msglen, msgtype, 1); }

int adsi_transmit_message_full (  struct ast_channel *  chan, unsigned char *  msg, int  msglen, int  msgtype, int  dowait )

Definition at line 351 of file res_adsi.c. References __adsi_transmit_messages(), ADSI_FLAG_DATAMODE, ADSI_SWITCH_TO_DATA, ADSI_SWITCH_TO_VOICE, ast_channel::adsicpe, AST_FORMAT_ULAW, ast_log(), ast_safe_sleep(), ast_set_read_format(), ast_set_write_format(), ast_stopstream(), ast_waitfordigit(), LOG_DEBUG, LOG_WARNING, ast_channel::readformat, and ast_channel::writeformat. Referenced by adsi_begin_download(), adsi_channel_restore(), adsi_end_download(), adsi_get_cpeid(), adsi_get_cpeinfo(), adsi_load_session(), adsi_print(), adsi_transmit_message(), and adsi_unload_session(). { unsigned char *msgs[5] = { NULL, NULL, NULL, NULL, NULL }; int msglens[5]; int msgtypes[5]; int newdatamode; int res; int x; int writeformat, readformat; int waitforswitch = 0; writeformat = chan->writeformat; readformat = chan->readformat; newdatamode = chan->adsicpe & ADSI_FLAG_DATAMODE; for (x=0;x<msglen;x+=(msg[x+1]+2)) { if (msg[x] == ADSI_SWITCH_TO_DATA) { ast_log(LOG_DEBUG, "Switch to data is sent!\n"); waitforswitch++; newdatamode = ADSI_FLAG_DATAMODE; } if (msg[x] == ADSI_SWITCH_TO_VOICE) { ast_log(LOG_DEBUG, "Switch to voice is sent!\n"); waitforswitch++; newdatamode = 0; } } msgs[0] = msg; msglens[0] = msglen; msgtypes[0] = msgtype; if (msglen > 253) { ast_log(LOG_WARNING, "Can't send ADSI message of %d bytes, too large\n", msglen); return -1; } ast_stopstream(chan); if (ast_set_write_format(chan, AST_FORMAT_ULAW)) { ast_log(LOG_WARNING, "Unable to set write format to ULAW\n"); return -1; } if (ast_set_read_format(chan, AST_FORMAT_ULAW)) { ast_log(LOG_WARNING, "Unable to set read format to ULAW\n"); if (writeformat) { if (ast_set_write_format(chan, writeformat)) ast_log(LOG_WARNING, "Unable to restore write format to %d\n", writeformat); } return -1; } res = __adsi_transmit_messages(chan, msgs, msglens, msgtypes); if (dowait) { ast_log(LOG_DEBUG, "Wait for switch is '%d'\n", waitforswitch); while(waitforswitch-- && ((res = ast_waitfordigit(chan, 1000)) > 0)) { res = 0; ast_log(LOG_DEBUG, "Waiting for 'B'...\n"); } } if (!res) chan->adsicpe = (chan->adsicpe & ~ADSI_FLAG_DATAMODE) | newdatamode; if (writeformat) ast_set_write_format(chan, writeformat); if (readformat) ast_set_read_format(chan, readformat); if (!res) res = ast_safe_sleep(chan, 100 ); return res; }

int adsi_unload_session (  struct ast_channel *  chan  )

Definition at line 1008 of file res_adsi.c. References adsi_disconnect_session(), ADSI_MSG_DISPLAY, adsi_transmit_message_full(), adsi_voice_mode(), and dsp. Referenced by adsi_prog(), ast_park_call(), cpeid_exec(), and vm_execmain(). { unsigned char dsp[256]; int bytes; memset(dsp, 0, sizeof(dsp)); /* Connect to session */ bytes = 0; bytes += adsi_disconnect_session(dsp + bytes); bytes += adsi_voice_mode(dsp + bytes, 0); /* Prepare key setup messages */ if (adsi_transmit_message_full(chan, dsp, bytes, ADSI_MSG_DISPLAY, 0)) return -1; return 0; }

int adsi_voice_mode (  unsigned char *  buf, int  when )

Parameters: buf  Character buffer to create parameter in (must have at least 256 free) when  (a time in seconds) to make the switch Returns number of bytes added to buffer or -1 on error. Definition at line 745 of file res_adsi.c. References ADSI_SWITCH_TO_VOICE. Referenced by adsi_delete(), adsi_folders(), adsi_get_cpeid(), adsi_get_cpeinfo(), adsi_goodbye(), adsi_load_vmail(), adsi_login(), adsi_message(), adsi_password(), adsi_print(), adsi_status(), adsi_status2(), adsi_unload_session(), vm_newuser(), vm_options(), and vm_tempgreeting(). { int bytes=0; /* Message type */ buf[bytes++] = ADSI_SWITCH_TO_VOICE; /* Reserve space for length */ bytes++; buf[bytes++] = when & 0x7f; buf[1] = bytes - 2; return bytes; }

static int ccopy (  unsigned char *  dst, unsigned char *  src, int  max )  [inline, static]

Definition at line 430 of file res_adsi.c. Referenced by adsi_display(), adsi_download_connect(), adsi_input_format(), and adsi_load_soft_key(). { int x=0; /* Carefully copy the requested data */ while ((x < max) && src[x] && (src[x] != 0xff)) { dst[x] = src[x]; x++; } return x; }

char* description (  void   )

Provides a description of the module. Returns: a short description of your module Definition at line 1127 of file res_adsi.c. { return "ADSI Resource"; }

static void init_state (  void   )  [static]

Definition at line 1038 of file res_adsi.c. References ADSI_JUST_CENT, ADSI_MAX_INTRO, alignment, aligns, intro, speeddial, speeds, and total. Referenced by adsi_load(). { int x; for (x=0;x<ADSI_MAX_INTRO;x++) aligns[x] = ADSI_JUST_CENT; strncpy(intro[0], "Welcome to the", sizeof(intro[0]) - 1); strncpy(intro[1], "Asterisk", sizeof(intro[1]) - 1); strncpy(intro[2], "Open Source PBX", sizeof(intro[2]) - 1); total = 3; speeds = 0; for (x=3;x<ADSI_MAX_INTRO;x++) intro[x][0] = '\0'; memset(speeddial, 0, sizeof(speeddial)); alignment = ADSI_JUST_CENT; }

char* key (  void   )

Returns the ASTERISK_GPL_KEY. This returns the ASTERISK_GPL_KEY, signifiying that you agree to the terms of the GPL stated in the ASTERISK_GPL_KEY. Your module will not load if it does not return the EXACT message: char *key(void) { return ASTERISK_GPL_KEY; } Returns: ASTERISK_GPL_KEY Definition at line 1138 of file res_adsi.c. References ASTERISK_GPL_KEY. { return ASTERISK_GPL_KEY; }

int load_module (  void   )

Initialize the module. Initialize the Agents module. This function is being called by Asterisk when loading the module. Among other thing it registers applications, cli commands and reads the cofiguration file. Returns: int Always 0. Definition at line 1115 of file res_adsi.c. References adsi_load(). { adsi_load(); return 0; }

int reload (  void   )

Reload stuff. This function is where any reload routines take place. Re-read config files, change signalling, whatever is appropriate on a reload. Returns: The return value is not used. Definition at line 1109 of file res_adsi.c. References adsi_load(). { adsi_load(); return 0; }

static int str2align (  char *  s  )  [static]

Definition at line 1026 of file res_adsi.c. References ADSI_JUST_CENT, ADSI_JUST_IND, ADSI_JUST_LEFT, and ADSI_JUST_RIGHT. Referenced by adsi_load(). { if (!strncasecmp(s, "l", 1)) return ADSI_JUST_LEFT; else if (!strncasecmp(s, "r", 1)) return ADSI_JUST_RIGHT; else if (!strncasecmp(s, "i", 1)) return ADSI_JUST_IND; else return ADSI_JUST_CENT; }

int unload_module (  void   )

Cleanup all module structures, sockets, etc. Standard module functions ... Definition at line 1121 of file res_adsi.c. { /* Can't unload this once we're loaded */ return -1; }

int usecount (  void   )

Provides a usecount. This function will be called by various parts of asterisk. Basically, all it has to do is to return a usecount when called. You will need to maintain your usecount within the module somewhere. The usecount should be how many channels provided by this module are in use. Returns: The module's usecount. Definition at line 1132 of file res_adsi.c. { /* We should never be unloaded */ return 1; }

---

Variable Documentation

int alignment = 0 [static]

Definition at line 67 of file res_adsi.c. Referenced by adsi_load(), and init_state().

int aligns[ADSI_MAX_INTRO] [static]

Definition at line 63 of file res_adsi.c. Referenced by adsi_load(), and init_state().

char intro[ADSI_MAX_INTRO][20] [static]

Definition at line 62 of file res_adsi.c. Referenced by adsi_load(), and init_state().

int maxretries = DEFAULT_ADSI_MAX_RETRIES [static]

Definition at line 57 of file res_adsi.c. Referenced by __adsi_transmit_messages(), adsi_load(), ast_ivr_menu_run_internal(), and privacy_exec().

char speeddial[ADSI_MAX_SPEED_DIAL][3][20] [static]

Definition at line 65 of file res_adsi.c. Referenced by adsi_load(), and init_state().

int speeds = 0 [static]

Definition at line 918 of file res_adsi.c. Referenced by adsi_channel_restore(), adsi_load(), and init_state().

int total = 0 [static]

Definition at line 917 of file res_adsi.c. Referenced by adsi_load(), ast_app_getvoice(), ast_cdr_serialize_variables(), conf_cmd(), init_state(), manager_sip_show_peers(), pbx_builtin_serialize_variables(), and send_sound().

---