source: rtems/cpukit/pppd/chat.c @ 40cf43ea

/*
 *      Chat -- a program for automatic session establishment (i.e. dial
 *              the phone and log in).
 *
 * Standard termination codes:
 *  0 - successful completion of the script
 *  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.
 *  4 - the first string declared as "ABORT"
 *  5 - the second string declared as "ABORT"
 *  6 - ... and so on for successive ABORT strings.
 *
 *      This software is in the public domain.
 *
 * -----------------
 *      22-May-99 added environment substitutuion, enabled with -E switch.
 *      Andreas Arens <andras@cityweb.de>.
 *
 *      12-May-99 added a feature to read data to be sent from a file,
 *      if the send string starts with @.  Idea from gpk <gpk@onramp.net>.
 *
 *      added -T and -U option and \T and \U substitution to pass a phone
 *      number into chat script. Two are needed for some ISDN TA applications.
 *      Keith Dart <kdart@cisco.com>
 *      
 *
 *      Added SAY keyword to send output to stderr.
 *      This allows to turn ECHO OFF and to output specific, user selected,
 *      text to give progress messages. This best works when stderr
 *      exists (i.e.: pppd in nodetach mode).
 *
 *      Added HANGUP directives to allow for us to be called
 *      back. When HANGUP is set to NO, chat will not hangup at HUP signal.
 *      We rely on timeouts in that case.
 *
 *      Added CLR_ABORT to clear previously set ABORT string. This has been
 *      dictated by the HANGUP above as "NO CARRIER" (for example) must be
 *      an ABORT condition until we know the other host is going to close
 *      the connection for call back. As soon as we have completed the
 *      first stage of the call back sequence, "NO CARRIER" is a valid, non
 *      fatal string. As soon as we got called back (probably get "CONNECT"),
 *      we should re-arm the ABORT "NO CARRIER". Hence the CLR_ABORT command.
 *      Note that CLR_ABORT packs the abort_strings[] array so that we do not
 *      have unused entries not being reclaimed.
 *
 *      In the same vein as above, added CLR_REPORT keyword.
 *
 *      Allow for comments. Line starting with '#' are comments and are
 *      ignored. If a '#' is to be expected as the first character, the 
 *      expect string must be quoted.
 *
 *
 *              Francis Demierre <Francis@SwissMail.Com>
 *              Thu May 15 17:15:40 MET DST 1997
 *
 *
 *      Added -r "report file" switch & REPORT keyword.
 *              Robert Geer <bgeer@xmission.com>
 *
 *      Added -s "use stderr" and -S "don't use syslog" switches.
 *              June 18, 1997
 *              Karl O. Pinc <kop@meme.com>
 *
 *
 *      Added -e "echo" switch & ECHO keyword
 *              Dick Streefland <dicks@tasking.nl>
 *
 *
 *      Considerable updates and modifications by
 *              Al Longyear <longyear@pobox.com>
 *              Paul Mackerras <paulus@cs.anu.edu.au>
 *
 *
 *      The original author is:
 *
 *              Karl Fox <karl@MorningStar.Com>
 *              Morning Star Technologies, Inc.
 *              1760 Zollinger Road
 *              Columbus, OH  43221
 *              (614)451-1883
 *
 */

#include <stdio.h>
#include <ctype.h>
#include <time.h>
#include <fcntl.h>
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <syslog.h>
#include <termios.h>
#include "pppd.h"

#undef  TERMIOS
#define TERMIOS


#define STR_LEN 1024
char temp2[STR_LEN];

#ifndef SIGTYPE
#define SIGTYPE void
#endif

#undef __P
#undef __V

#ifdef __STDC__
#include <stdarg.h>
#define __V(x)  x
#define __P(x)  x
#else
#include <varargs.h>
#define __V(x)  (va_alist) va_dcl
#define __P(x)  ()
#define const
#endif

#ifndef O_NONBLOCK
#define O_NONBLOCK      O_NDELAY
#endif


/*************** Micro getopt() *********************************************/
#define OPTION(c,v)     (_O&2&&**v?*(*v)++:!c||_O&4?0:(!(_O&1)&& \
                                (--c,++v),_O=4,c&&**v=='-'&&v[0][1]?*++*v=='-'\
                                &&!v[0][1]?(--c,++v,0):(_O=2,*(*v)++):0))
#define OPTARG(c,v)     (_O&2?**v||(++v,--c)?(_O=1,--c,*v++): \
                                (_O=4,(char*)0):(char*)0)
#define OPTONLYARG(c,v) (_O&2&&**v?(_O=1,--c,*v++):(char*)0)
#define ARG(c,v)        (c?(--c,*v++):(char*)0)

#if 0
static int _O = 0;              /* Internal state */
#endif
/*************** Micro getopt() *********************************************/

char *program_name;

#define MAX_ABORTS              16
#define MAX_REPORTS             16
#define DEFAULT_CHAT_TIMEOUT    45
#define MAX_TIMEOUTS            10

int echo             = 0;
int quiet            = 0;
int report           = 0;
int use_env          = 0;
int exit_code        = 0;
char *report_file    = (char *) 0;
char *chat_file      = (char *) 0;
char *phone_num      = (char *) 0;
char *phone_num2     = (char *) 0;
static int ttyfd;
static int timeout   = DEFAULT_CHAT_TIMEOUT;

#ifdef TERMIOS
#define term_parms struct termios
#define get_term_param(param) tcgetattr(0, param)
#define set_term_param(param) tcsetattr(0, TCSANOW, param)
struct termios saved_tty_parameters;
#endif

char *fail_reason = (char *)0;
char  fail_buffer[50];
char *abort_string[MAX_ABORTS]={"BUSY","NO DIALTONE","NO CARRIER","NO ANSWER","RING\r\nRING"};
int n_aborts = 5;
int abort_next = 0, timeout_next = 0, echo_next = 0;
int clear_abort_next = 0;

char *report_string[MAX_REPORTS] ;
char  report_buffer[50] ;
int n_reports = 0, report_next = 0, report_gathering = 0 ; 
int clear_report_next = 0;

int say_next = 0, hup_next = 0;

void *dup_mem __P((void *b, size_t c));
void *copy_of __P((char *s));
void break_sequence __P((void));
int  get_string __P((register char *string));
int  put_string __P((register char *s));
int  write_char __P((int c));
int  put_char __P((int c));
int  get_char __P((void));
void chat_send __P((register char *s));
char *character __P((int c));
void chat_expect __P((register char *s));
char *clean __P((register char *s, int sending));
char *expect_strtok __P((char *, char *));
int chatmain __P((int, int, char *));


void *dup_mem(b, c)
void *b;
size_t c;
{
    void *ans = malloc (c);
    if (!ans)
        return NULL;

    memcpy(ans, b, c);
    return ans;
}

void *copy_of (s)
char *s;
{
    return dup_mem(s, strlen (s) + 1);
}

char *getnextcommand(char **string)
{
        char *buf=*string,*res;
        res=strchr(buf,'|');
        if (res==NULL)
                return NULL;
        *res='\0';
        *string=res+1;
        return buf;
}

int chatmain(int fd, int mode, char *pScript)
{
  char    *arg;

  /* initialize exit code */
  exit_code = 0;
  ttyfd     = fd;

  if ( debug ) {
    dbglog("chat_main: %s\n", pScript);
  }

  /* get first expect string */
  arg = getnextcommand(&pScript);
  while (( arg != NULL ) && ( exit_code == 0 )) {
    /* process the expect string */
    chat_expect(arg);
    if ( exit_code == 0 ) {
      /* get the next send string */
      arg = getnextcommand(&pScript);
      if ( arg != NULL ) {
        /* process the send string */
        chat_send(arg);

        /* get the next expect string */
        arg = getnextcommand(&pScript);
      }
    }
  }
  ttyfd = (int)-1;

  return ( exit_code );
}

void break_sequence()
{
  tcsendbreak(ttyfd, 0);
}

/*
 *      'Clean up' this string.
 */
char *clean(s, sending)
register char *s;
int sending;  /* set to 1 when sending (putting) this string. */
{
    char temp[STR_LEN], env_str[STR_LEN], cur_chr;
    register char *s1, *phchar;
    int add_return = sending;
#define isoctal(chr)    (((chr) >= '0') && ((chr) <= '7'))
#define isalnumx(chr)   ((((chr) >= '0') && ((chr) <= '9')) \
                         || (((chr) >= 'a') && ((chr) <= 'z')) \
                         || (((chr) >= 'A') && ((chr) <= 'Z')) \
                         || (chr) == '_')

    s1 = temp;
    while (*s) {
        cur_chr = *s++;
        if (cur_chr == '^') {
            cur_chr = *s++;
            if (cur_chr == '\0') {
                *s1++ = '^';
                break;
            }
            cur_chr &= 0x1F;
            if (cur_chr != 0) {
                *s1++ = cur_chr;
            }
            continue;
        }
        
        if (use_env && cur_chr == '$') {                /* ARI */
            phchar = env_str;
            while (isalnumx(*s))
                *phchar++ = *s++;
            *phchar = '\0';
            phchar = getenv(env_str);
            if (phchar)
                while (*phchar)
                    *s1++ = *phchar++;
            continue;
        }

        if (cur_chr != '\\') {
            *s1++ = cur_chr;
            continue;
        }

        cur_chr = *s++;
        if (cur_chr == '\0') {
            if (sending) {
                *s1++ = '\\';
                *s1++ = '\\';
            }
            break;
        }

        switch (cur_chr) {
        case 'b':
            *s1++ = '\b';
            break;

        case 'c':
            if (sending && *s == '\0')
                add_return = 0;
            else
                *s1++ = cur_chr;
            break;

        case '\\':
        case 'K':
        case 'p':
        case 'd':
            if (sending)
                *s1++ = '\\';
            *s1++ = cur_chr;
            break;

        case 'T':
            if (sending && phone_num) {
                for (phchar = phone_num; *phchar != '\0'; phchar++) 
                    *s1++ = *phchar;
            }
            else {
                *s1++ = '\\';
                *s1++ = 'T';
            }
            break;

        case 'U':
            if (sending && phone_num2) {
                for (phchar = phone_num2; *phchar != '\0'; phchar++) 
                    *s1++ = *phchar;
            }
            else {
                *s1++ = '\\';
                *s1++ = 'U';
            }
            break;

        case 'q':
            quiet = 1;
            break;

        case 'r':
            *s1++ = '\r';
            break;

        case 'n':
            *s1++ = '\n';
            break;

        case 's':
            *s1++ = ' ';
            break;

        case 't':
            *s1++ = '\t';
            break;

        case 'N':
            if (sending) {
                *s1++ = '\\';
                *s1++ = '\0';
            }
            else
                *s1++ = 'N';
            break;
            
        case '$':                       /* ARI */
            if (use_env) {
                *s1++ = cur_chr;
                break;
            }
            /* FALL THROUGH */

        default:
            if (isoctal (cur_chr)) {
                cur_chr &= 0x07;
                if (isoctal (*s)) {
                    cur_chr <<= 3;
                    cur_chr |= *s++ - '0';
                    if (isoctal (*s)) {
                        cur_chr <<= 3;
                        cur_chr |= *s++ - '0';
                    }
                }

                if (cur_chr != 0 || sending) {
                    if (sending && (cur_chr == '\\' || cur_chr == 0))
                        *s1++ = '\\';
                    *s1++ = cur_chr;
                }
                break;
            }

            if (sending)
                *s1++ = '\\';
            *s1++ = cur_chr;
            break;
        }
    }

    if (add_return)
        *s1++ = '\r';

    *s1++ = '\0'; /* guarantee closure */
    *s1++ = '\0'; /* terminate the string */
    return dup_mem (temp, (size_t) (s1 - temp)); /* may have embedded nuls */
}

/*
 * A modified version of 'strtok'. This version skips \ sequences.
 */
char *expect_strtok (s, term)
     char *s, *term;
{
    static  char *str   = "";
    int     escape_flag = 0;
    char   *result;

/*
 * If a string was specified then do initial processing.
 */
    if (s)
        str = s;

/*
 * If this is the escape flag then reset it and ignore the character.
 */
    if (*str)
        result = str;
    else
        result = (char *) 0;

    while (*str) {
        if (escape_flag) {
            escape_flag = 0;
            ++str;
            continue;
        }

        if (*str == '\\') {
            ++str;
            escape_flag = 1;
            continue;
        }

/*
 * If this is not in the termination string, continue.
 */
        if (strchr (term, *str) == (char *) 0) {
            ++str;
            continue;
        }

/*
 * This is the terminator. Mark the end of the string and stop.
 */
        *str++ = '\0';
        break;
    }
    return (result);
}

/*
 * Process the expect string
 */
void chat_expect (s)
char *s;
{
    char *expect;
    char *reply;

    if (strcmp(s, "HANGUP") == 0) {
        ++hup_next;
        return;
    }
 
    if (strcmp(s, "ABORT") == 0) {
        ++abort_next;
        return;
    }

    if (strcmp(s, "CLR_ABORT") == 0) {
        ++clear_abort_next;
        return;
    }

    if (strcmp(s, "REPORT") == 0) {
        ++report_next;
        return;
    }

    if (strcmp(s, "CLR_REPORT") == 0) {
        ++clear_report_next;
        return;
    }

    if (strcmp(s, "TIMEOUT") == 0) {
        ++timeout_next;
        return;
    }

    if (strcmp(s, "ECHO") == 0) {
        ++echo_next;
        return;
    }

    if (strcmp(s, "SAY") == 0) {
        ++say_next;
        return;
    }

/*
 * Fetch the expect and reply string.
 */
    for (;;) {
        expect = expect_strtok (s, "-");
        s      = (char *) 0;

        if (expect == (char *) 0)
            return;

        reply = expect_strtok (s, "-");

/*
 * Handle the expect string. If successful then exit.
 */
        if (get_string (expect))
            return;

/*
 * If there is a sub-reply string then send it. Otherwise any condition
 * is terminal.
 */
        if (reply == (char *) 0 || exit_code != 3)
            break;

        chat_send (reply);
    }
}

/*
 * Translate the input character to the appropriate string for printing
 * the data.
 */

char *character(c)
int c;
{
    static char string[10];
    char *meta;

    meta = (c & 0x80) ? "M-" : "";
    c &= 0x7F;

    if (c < 32)
        sprintf(string, "%s^%c", meta, (int)c + '@');
    else if (c == 127)
        sprintf(string, "%s^?", meta);
    else
        sprintf(string, "%s%c", meta, c);

    return (string);
}

/*
 *  process the reply string
 */
void chat_send (s)
register char *s;
{
    char file_data[STR_LEN];

    if (say_next) {
        say_next = 0;
        s = clean(s, 1);
        write(2, s, strlen(s));
        free(s);
        return;
    }

    if (hup_next) {
        hup_next = 0;
        return;
    }

    if (echo_next) {
        echo_next = 0;
        echo = (strcmp(s, "ON") == 0);
        return;
    }

    if (abort_next) {
        char *s1;
        
        abort_next = 0;
        if ( n_aborts < MAX_ABORTS ) {
          s1 = clean(s, 0);
          if (( strlen(s1) <= strlen(s) ) &&
              ( strlen(s1) <  sizeof(fail_buffer))) {

            abort_string[n_aborts++] = s1;
          }
        }
        return;
    }

    if (clear_abort_next) {
        clear_abort_next = 0;
        return;
    }

    if (report_next) {
        report_next = 0;
        return;
    }

    if (clear_report_next) {
        clear_report_next = 0;
        return;
    }

    if (timeout_next) {
        timeout_next = 0;
        timeout = atoi(s);
        
        if (timeout <= 0)
            timeout = DEFAULT_CHAT_TIMEOUT;

        return;
    }

    if (strcmp(s, "EOT") == 0)
        s = "^D\\c";
    else if (strcmp(s, "BREAK") == 0)
        s = "\\K\\c";

    if (!put_string(s)) {
      exit_code = 2;
    }
}

int get_char()
{
    int status;
    char c;
    int tries=MAX_TIMEOUTS;

        while(tries)
        {
            status = read(ttyfd, &c, 1);
            switch (status) {
                   case 1:
                                return ((int)c & 0x7F);
                    default:
                                tries--;                        
            }
    }
        return -1;                                              
}

int put_char(c)
int c;
{
  char ch = c;

  write(ttyfd, &ch, 1);

  return 0;
}

int write_char (c)
int c;
{
    if (put_char(c) < 0) {
        return (0);
    }
    return (1);
}

int put_string (s)
register char *s;
{
    quiet = 0;
    s = clean(s, 1);
    while (*s) {
        register char c = *s++;

        if (c != '\\') {
            if (!write_char (c))
                return 0;
            continue;
        }

        c = *s++;
        switch (c) {
        case 'd':
            sleep(1);
            break;

        case 'K':
            break_sequence();
            break;

        case 'p':
#if 0 /* FIXME!!! */
            usleep(10000);      /* 1/100th of a second (arg is microseconds) */
#else
            sleep(1);
#endif
            break;

        default:
            if (!write_char (c))
                return 0;
            break;
        }
    }

    return (1);
}

/*
 *      'Wait for' this string to appear on this file descriptor.
 */
int get_string(string)
register char *string;
{
    int c, len, minlen;
    register char *s = temp2, *end = s + STR_LEN;
    char *logged = temp2;
    struct termios tios;

    memset(temp2, 0, sizeof(temp2));

    tcgetattr(ttyfd, &tios);
    tios.c_cc[VMIN] = 0;
    tios.c_cc[VTIME] = timeout*10/MAX_TIMEOUTS;
    tcsetattr(ttyfd, TCSANOW, &tios);
                
    string = clean(string, 0);
    len = strlen(string);
    minlen = (len > sizeof(fail_buffer)? len: sizeof(fail_buffer)) - 1;
        
    if (len > STR_LEN) {
        exit_code = 1;
        return 0;
    }

    if (len == 0) {
                        return (1);
    }

   while ( (c = get_char()) >= 0) {
                int n, abort_len;

        *s++ = c;
        *s=0;

        if (s - temp2 >= len &&
            c == string[len - 1] &&
            strncmp(s - len, string, len) == 0) {
            return (1);
        }

        for (n = 0; n < n_aborts; ++n) {
            if (s - temp2 >= (abort_len = strlen(abort_string[n])) &&
                strncmp(s - abort_len, abort_string[n], abort_len) == 0) {

                exit_code = n + 4;
                strcpy(fail_reason = fail_buffer, abort_string[n]);
                return (0);
            }
        }

        if (s >= end) {
            if (logged < s - minlen) {
                logged = s;
            }
            s -= minlen;
            memmove(temp2, s, minlen);
            logged = temp2 + (logged - s);
            s = temp2 + minlen;
        }
    }

    exit_code = 3;
    return (0);
}