123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486 |
- /*-
- * Copyright (c) 1997
- * David L Nugent <davidn@blaze.net.au>.
- * All rights reserved.
- *
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, is permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice immediately at the beginning of the file, without modification,
- * this list of conditions, and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- * 3. This work was done expressly for inclusion into FreeBSD. Other use
- * is permitted provided this notation is included.
- * 4. Absolutely no warranty of function or purpose is made by the authors.
- * 5. Modifications may be freely made to this file providing the above
- * conditions are met.
- *
- * Modem chat module - send/expect style functions for getty
- * For semi-intelligent modem handling.
- */
- #include <sys/types.h>
- #include <sys/ioctl.h>
- #include <sys/utsname.h>
- #include <ctype.h>
- #include <signal.h>
- #include <stdlib.h>
- #include <string.h>
- #include <syslog.h>
- #include <unistd.h>
- #include "gettytab.h"
- #include "extern.h"
- #define PAUSE_CH (unsigned char)'\xff' /* pause kludge */
- #define CHATDEBUG_RECEIVE 0x01
- #define CHATDEBUG_SEND 0x02
- #define CHATDEBUG_EXPECT 0x04
- #define CHATDEBUG_MISC 0x08
- #define CHATDEBUG_DEFAULT 0
- #define CHAT_DEFAULT_TIMEOUT 10
- static int chat_debug = CHATDEBUG_DEFAULT;
- static int chat_alarm = CHAT_DEFAULT_TIMEOUT; /* Default */
- static volatile int alarmed = 0;
- static void chat_alrm(int);
- static int chat_unalarm(void);
- static int getdigit(char **, int, int);
- static char **read_chat(char **);
- static char *cleanchr(char **, unsigned char);
- static const char *cleanstr(const char *, int);
- static const char *result(int);
- static int chat_expect(const char *);
- static int chat_send(char const *);
- /*
- * alarm signal handler
- * handle timeouts in read/write
- * change stdin to non-blocking mode to prevent
- * possible hang in read().
- */
- static void
- chat_alrm(int signo __unused)
- {
- int on = 1;
- alarm(1);
- alarmed = 1;
- signal(SIGALRM, chat_alrm);
- ioctl(STDIN_FILENO, FIONBIO, &on);
- }
- /*
- * Turn back on blocking mode reset by chat_alrm()
- */
- static int
- chat_unalarm(void)
- {
- int off = 0;
- return ioctl(STDIN_FILENO, FIONBIO, &off);
- }
- /*
- * convert a string of a given base (octal/hex) to binary
- */
- static int
- getdigit(char **ptr, int base, int max)
- {
- int i, val = 0;
- char * q;
- static const char xdigits[] = "0123456789abcdef";
- for (i = 0, q = *ptr; i++ < max; ++q) {
- int sval;
- const char * s = strchr(xdigits, tolower(*q));
- if (s == NULL || (sval = s - xdigits) >= base)
- break;
- val = (val * base) + sval;
- }
- *ptr = q;
- return val;
- }
- /*
- * read_chat()
- * Convert a whitespace delimtied string into an array
- * of strings, being expect/send pairs
- */
- static char **
- read_chat(char **chatstr)
- {
- char *str = *chatstr;
- char **res = NULL;
- if (str != NULL) {
- char *tmp = NULL;
- int l;
- if ((l=strlen(str)) > 0 && (tmp=malloc(l + 1)) != NULL &&
- (res=malloc(((l + 1) / 2 + 1) * sizeof(char *))) != NULL) {
- static char ws[] = " \t";
- char * p;
- for (l = 0, p = strtok(strcpy(tmp, str), ws);
- p != NULL;
- p = strtok(NULL, ws))
- {
- char *q, *r;
- /* Read escapes */
- for (q = r = p; *r; ++q)
- {
- if (*q == '\\')
- {
- /* handle special escapes */
- switch (*++q)
- {
- case 'a': /* bell */
- *r++ = '\a';
- break;
- case 'r': /* cr */
- *r++ = '\r';
- break;
- case 'n': /* nl */
- *r++ = '\n';
- break;
- case 'f': /* ff */
- *r++ = '\f';
- break;
- case 'b': /* bs */
- *r++ = '\b';
- break;
- case 'e': /* esc */
- *r++ = 27;
- break;
- case 't': /* tab */
- *r++ = '\t';
- break;
- case 'p': /* pause */
- *r++ = PAUSE_CH;
- break;
- case 's':
- case 'S': /* space */
- *r++ = ' ';
- break;
- case 'x': /* hexdigit */
- ++q;
- *r++ = getdigit(&q, 16, 2);
- --q;
- break;
- case '0': /* octal */
- ++q;
- *r++ = getdigit(&q, 8, 3);
- --q;
- break;
- default: /* literal */
- *r++ = *q;
- break;
- case 0: /* not past eos */
- --q;
- break;
- }
- } else {
- /* copy standard character */
- *r++ = *q;
- }
- }
- /* Remove surrounding quotes, if any
- */
- if (*p == '"' || *p == '\'') {
- q = strrchr(p+1, *p);
- if (q != NULL && *q == *p && q[1] == '\0') {
- *q = '\0';
- p++;
- }
- }
- res[l++] = p;
- }
- res[l] = NULL;
- *chatstr = tmp;
- return res;
- }
- free(tmp);
- }
- return res;
- }
- /*
- * clean a character for display (ctrl/meta character)
- */
- static char *
- cleanchr(char **buf, unsigned char ch)
- {
- int l;
- static char tmpbuf[5];
- char * tmp = buf ? *buf : tmpbuf;
- if (ch & 0x80) {
- strcpy(tmp, "M-");
- l = 2;
- ch &= 0x7f;
- } else
- l = 0;
- if (ch < 32) {
- tmp[l++] = '^';
- tmp[l++] = ch + '@';
- } else if (ch == 127) {
- tmp[l++] = '^';
- tmp[l++] = '?';
- } else
- tmp[l++] = ch;
- tmp[l] = '\0';
- if (buf)
- *buf = tmp + l;
- return tmp;
- }
- /*
- * clean a string for display (ctrl/meta characters)
- */
- static const char *
- cleanstr(const char *s, int l)
- {
- static char * tmp = NULL;
- static int tmplen = 0;
- if (tmplen < l * 4 + 1)
- tmp = realloc(tmp, tmplen = l * 4 + 1);
- if (tmp == NULL) {
- tmplen = 0;
- return "(mem alloc error)";
- } else {
- int i = 0;
- char * p = tmp;
- while (i < l)
- cleanchr(&p, s[i++]);
- *p = '\0';
- }
- return tmp;
- }
- /*
- * return result as a pseudo-english word
- */
- static const char *
- result(int r)
- {
- static const char * results[] = {
- "OK", "MEMERROR", "IOERROR", "TIMEOUT"
- };
- return results[r & 3];
- }
- /*
- * chat_expect()
- * scan input for an expected string
- */
- static int
- chat_expect(const char *str)
- {
- int len, r = 0;
- if (chat_debug & CHATDEBUG_EXPECT)
- syslog(LOG_DEBUG, "chat_expect '%s'", cleanstr(str, strlen(str)));
- if ((len = strlen(str)) > 0) {
- int i = 0;
- char * got;
- if ((got = malloc(len + 1)) == NULL)
- r = 1;
- else {
- memset(got, 0, len+1);
- alarm(chat_alarm);
- alarmed = 0;
- while (r == 0 && i < len) {
- if (alarmed)
- r = 3;
- else {
- unsigned char ch;
- if (read(STDIN_FILENO, &ch, 1) == 1) {
- if (chat_debug & CHATDEBUG_RECEIVE)
- syslog(LOG_DEBUG, "chat_recv '%s' m=%d",
- cleanchr(NULL, ch), i);
- if (ch == str[i])
- got[i++] = ch;
- else if (i > 0) {
- int j = 1;
- /* See if we can resync on a
- * partial match in our buffer
- */
- while (j < i && memcmp(got + j, str, i - j) != 0)
- j++;
- if (j < i)
- memcpy(got, got + j, i - j);
- i -= j;
- }
- } else
- r = alarmed ? 3 : 2;
- }
- }
- alarm(0);
- chat_unalarm();
- alarmed = 0;
- free(got);
- }
- }
- if (chat_debug & CHATDEBUG_EXPECT)
- syslog(LOG_DEBUG, "chat_expect %s", result(r));
- return r;
- }
- /*
- * chat_send()
- * send a chat string
- */
- static int
- chat_send(char const *str)
- {
- int r = 0;
- if (chat_debug & CHATDEBUG_SEND)
- syslog(LOG_DEBUG, "chat_send '%s'", cleanstr(str, strlen(str)));
- if (*str) {
- alarm(chat_alarm);
- alarmed = 0;
- while (r == 0 && *str)
- {
- unsigned char ch = (unsigned char)*str++;
- if (alarmed)
- r = 3;
- else if (ch == PAUSE_CH)
- usleep(500000); /* 1/2 second */
- else {
- usleep(10000); /* be kind to modem */
- if (write(STDOUT_FILENO, &ch, 1) != 1)
- r = alarmed ? 3 : 2;
- }
- }
- alarm(0);
- chat_unalarm();
- alarmed = 0;
- }
- if (chat_debug & CHATDEBUG_SEND)
- syslog(LOG_DEBUG, "chat_send %s", result(r));
- return r;
- }
- /*
- * getty_chat()
- *
- * Termination codes:
- * -1 - no script supplied
- * 0 - script terminated correctly
- * 1 - invalid argument, expect string too large, etc.
- * 2 - error on an I/O operation or fatal error condition
- * 3 - timeout waiting for a simple string
- *
- * Parameters:
- * char *scrstr - unparsed chat script
- * timeout - seconds timeout
- * debug - debug value (bitmask)
- */
- int
- getty_chat(char *scrstr, int timeout, int debug)
- {
- int r = -1;
- chat_alarm = timeout ? timeout : CHAT_DEFAULT_TIMEOUT;
- chat_debug = debug;
- if (scrstr != NULL) {
- char **script;
- if (chat_debug & CHATDEBUG_MISC)
- syslog(LOG_DEBUG, "getty_chat script='%s'", scrstr);
- if ((script = read_chat(&scrstr)) != NULL) {
- int i = r = 0;
- int off = 0;
- sig_t old_alarm;
- /*
- * We need to be in raw mode for all this
- * Rely on caller...
- */
- old_alarm = signal(SIGALRM, chat_alrm);
- chat_unalarm(); /* Force blocking mode at start */
- /*
- * This is the send/expect loop
- */
- while (r == 0 && script[i] != NULL)
- if ((r = chat_expect(script[i++])) == 0 && script[i] != NULL)
- r = chat_send(script[i++]);
- signal(SIGALRM, old_alarm);
- free(script);
- free(scrstr);
- /*
- * Ensure stdin is in blocking mode
- */
- ioctl(STDIN_FILENO, FIONBIO, &off);
- }
- if (chat_debug & CHATDEBUG_MISC)
- syslog(LOG_DEBUG, "getty_chat %s", result(r));
- }
- return r;
- }
|