perl/client.pl

   1 #!/usr/bin/perl -w
   2 #
   3 # A thing that implements dxcluster 'protocol'
   4 #
   5 # This is a perl module/program that sits on the end of a dxcluster
   6 # 'protocol' connection and deals with anything that might come along.
   7 #
   8 # this program is called by ax25d or inetd and gets raw ax25 text on its input
   9 # It can also be launched into the ether by the cluster program itself for outgoing
  10 # connections
  11 #
  12 # Calling syntax is:-
  13 #
  14 # client.pl [callsign] [telnet|ax25|local] [[connect] [program name and args ...]]
  15 #
  16 # if the callsign isn't given then the sysop callsign in DXVars.pm is assumed
  17 #
  18 # if there is no connection type then 'local' is assumed
  19 #
  20 # if there is a 'connect' keyword then it will try to launch the following program
  21 # and any arguments and connect the stdin & stdout of both the program and the
  22 # client together.
  23 #
  24 # Copyright (c) 1998 Dirk Koopman G1TLH
  25 #
  26 # $Id$
  27 #
  28
  29 require 5.004;
  30
  31 # search local then perl directories
  32 BEGIN {
  33         # root of directory tree for this system
  34         $root = "/spider";
  35         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
  36
  37         unshift @INC, "$root/perl";     # this IS the right way round!
  38         unshift @INC, "$root/local";
  39 }
  40
  41 use Msg;
  42 use DXVars;
  43 use DXDebug;
  44 use Net::Telnet qw(TELOPT_ECHO);
  45 use IO::File;
  46 use IO::Socket;
  47 use IPC::Open2;
  48 use Carp qw{cluck};
  49
  50 # cease communications
  51 sub cease
  52 {
  53         my $sendz = shift;
  54         if ($conn && $sendz) {
  55                 $conn->send_now("Z$call|bye...\n");
  56         }
  57         $stdout->flush if $stdout;
  58         if ($pid) {
  59                 dbg('connect', "killing $pid");
  60                 kill(9, $pid);
  61         }
  62         dbgclose();
  63 #       $SIG{__WARN__} = sub {my $a = shift; cluck($a); };
  64         sleep(1);
  65         exit(0);
  66 }
  67
  68 # terminate program from signal
  69 sub sig_term
  70 {
  71         cease(1);
  72 }
  73
  74 # terminate a child
  75 sub sig_chld
  76 {
  77         $SIG{CHLD} = \&sig_chld;
  78         $waitedpid = wait;
  79         dbg('connect', "caught $pid");
  80 }
  81
  82
  83 sub setmode
  84 {
  85         if ($mode == 1) {
  86                 $mynl = "\r";
  87         } else {
  88                 $mynl = "\n";
  89         }
  90         $/ = $mynl;
  91 }
  92
  93 # handle incoming messages
  94 sub rec_socket
  95 {
  96         my ($con, $msg, $err) = @_;
  97         if (defined $err && $err) {
  98                 cease(1);
  99         }
 100         if (defined $msg) {
 101                 my ($sort, $call, $line) = $msg =~ /^(\w)([A-Z0-9\-]+)\|(.*)$/;
 102
 103                 if ($sort eq 'D') {
 104                         my $snl = $mynl;
 105                         my $newsavenl = "";
 106                         $snl = "" if $mode == 0;
 107                         if ($mode == 2 && $line =~ />$/) {
 108                                 $newsavenl = $snl;
 109                                 $snl = ' ';
 110                         }
 111                         $line =~ s/\n/\r/og if $mode == 1;
 112                         #my $p = qq($line$snl);
 113                         if ($buffered) {
 114                                 if (length $outqueue >= $client_buffer_lth) {
 115                                         print $stdout $outqueue;
 116                                         $outqueue = "";
 117                                 }
 118                                 $outqueue .= "$savenl$line$snl";
 119                                 $lasttime = time;
 120                         } else {
 121                                 print $stdout $savenl, $line, $snl;;
 122                         }
 123                         $savenl = $newsavenl;
 124                 } elsif ($sort eq 'M') {
 125                         $mode = $line;          # set new mode from cluster
 126                         setmode();
 127                 } elsif ($sort eq 'E') {
 128                         if ($sort eq 'telnet') {
 129                                 $mode = $line;          # set echo mode from cluster
 130                                 my $term = POSIX::Termios->new;
 131                                 $term->getattr(fileno($sock));
 132                                 $term->setiflag( 0 );
 133                                 $term->setoflag( 0 );
 134                                 $term->setattr(fileno($sock), &POSIX::TCSANOW );
 135                         }
 136                 } elsif ($sort eq 'I') {
 137                         ;                       # ignore echoed I frames
 138                 } elsif ($sort eq 'B') {
 139                         if ($buffered && $outqueue) {
 140                                 print $stdout $outqueue;
 141                                 $outqueue = "";
 142                         }
 143                         $buffered = $line;      # set buffered or unbuffered
 144                 } elsif ($sort eq 'Z') { # end, disconnect, go, away .....
 145                         cease(0);
 146                 }
 147         }
 148         $lasttime = time;
 149 }
 150
 151 sub rec_stdin
 152 {
 153         my ($fh) = @_;
 154         my $buf;
 155         my @lines;
 156         my $r;
 157         my $first;
 158         my $dangle = 0;
 159
 160         $r = sysread($fh, $buf, 1024);
 161         #  my $prbuf;
 162         #  $prbuf = $buf;
 163         #  $prbuf =~ s/\r/\\r/;
 164         #  $prbuf =~ s/\n/\\n/;
 165         #  print "sys: $r ($prbuf)\n";
 166         if (!defined $r || $r == 0) {
 167                 cease(1);
 168         } elsif ($r > 0) {
 169                 if ($mode) {
 170                         $buf =~ s/\r/\n/og if $mode == 1;
 171                         $buf =~ s/\r\n/\n/og if $mode == 2;
 172                         $dangle = !($buf =~ /\n$/);
 173                         if ($buf eq "\n") {
 174                                 @lines = (" ");
 175                         } else {
 176                                 @lines = split /\n/, $buf;
 177                         }
 178                         if ($dangle) {          # pull off any dangly bits
 179                                 $buf = pop @lines;
 180                         } else {
 181                                 $buf = "";
 182                         }
 183                         $first = shift @lines;
 184                         unshift @lines, ($lastbit . $first) if ($first);
 185                         foreach $first (@lines) {
 186                                 #                 print "send_now $call $first\n";
 187                                 $conn->send_later("I$call|$first");
 188                         }
 189                         $lastbit = $buf;
 190                         $savenl = "";           # reset savenl 'cos we will have done a newline on input
 191                 } else {
 192                         $conn->send_later("I$call|$buf");
 193                 }
 194         }
 195         $lasttime = time;
 196 }
 197
 198 sub optioncb
 199 {
 200 }
 201
 202 sub doconnect
 203 {
 204         my ($sort, $line) = @_;
 205         dbg('connect', "CONNECT sort: $sort command: $line");
 206         if ($sort eq 'telnet') {
 207                 # this is a straight network connect
 208                 my ($host, $port) = split /\s+/, $line;
 209                 $port = 23 if !$port;
 210
 211 #               if ($port == 23) {
 212
 213                         $sock = new Net::Telnet (Timeout => $timeout, Port => $port);
 214                         $sock->option_callback(\&optioncb);
 215                         $sock->output_record_separator('');
 216 #                       $sock->option_log('option_log');
 217 #                       $sock->dump_log('dump');
 218                         $sock->option_accept(Dont => TELOPT_ECHO, Wont => TELOPT_ECHO);
 219                         $sock->open($host) or die "Can't connect to $host port $port $!";
 220 #               } else {
 221 #                       $sock = IO::Socket::INET->new(PeerAddr => "$host:$port", Proto => 'tcp')
 222 #                               or die "Can't connect to $host port $port $!";
 223 #               }
 224         } elsif ($sort eq 'ax25' || $sort eq 'prog') {
 225                 my @args = split /\s+/, $line;
 226                 $rfh = new IO::File;
 227                 $wfh = new IO::File;
 228                 $pid = open2($rfh, $wfh, "$line") or die "can't do $line $!";
 229                 die "no receive channel $!" unless $rfh;
 230                 die "no transmit channel $!" unless $wfh;
 231                 dbg('connect', "got pid $pid");
 232                 $wfh->autoflush(1);
 233         } else {
 234                 die "invalid type of connection ($sort)";
 235         }
 236         $csort = $sort;
 237 }
 238
 239 sub doabort
 240 {
 241         my $string = shift;
 242         dbg('connect', "abort $string");
 243         $abort = $string;
 244 }
 245
 246 sub dotimeout
 247 {
 248         my $val = shift;
 249         dbg('connect', "timeout set to $val");
 250         $timeout = $val;
 251 }
 252
 253 sub dochat
 254 {
 255         my ($expect, $send) = @_;
 256         dbg('connect', "CHAT \"$expect\" -> \"$send\"");
 257     my $line;
 258
 259         alarm($timeout);
 260
 261     if ($expect) {
 262                 for (;;) {
 263                         if ($csort eq 'telnet') {
 264                                 $line = $sock->get();
 265                                 cease(11) unless $line;          # the socket has gone away?
 266                                 $line =~ s/\r\n/\n/og;
 267                                 chomp;
 268                         } elsif ($csort eq 'ax25' || $csort eq 'prog') {
 269                                 local $/ = "\r";
 270                                 $line = <$rfh>;
 271                                 $line =~ s/\r//og;
 272                         }
 273                         if (length $line == 0) {
 274                                 dbg('connect', "received 0 length line, aborting...");
 275                                 cease(11);
 276                         }
 277                         dbg('connect', "received \"$line\"");
 278                         if ($abort && $line =~ /$abort/i) {
 279                                 dbg('connect', "aborted on /$abort/");
 280                                 cease(11);
 281                         }
 282                         last if $line =~ /$expect/i;
 283                 }
 284         }
 285         if ($send) {
 286                 if ($csort eq 'telnet') {
 287                         $sock->print("$send\n");
 288                 } elsif ($csort eq 'ax25') {
 289                         local $\ = "\r";
 290                         $wfh->print("$send");
 291                 }
 292                 dbg('connect', "sent \"$send\"");
 293         }
 294 }
 295
 296 sub timeout
 297 {
 298         dbg('connect', "timed out after $timeout seconds");
 299         cease(0);
 300 }
 301
 302
 303 #
 304 # initialisation
 305 #
 306
 307 $mode = 2;                      # 1 - \n = \r as EOL, 2 - \n = \n, 0 - transparent
 308 $call = "";                     # the callsign being used
 309 $conn = 0;                      # the connection object for the cluster
 310 $lastbit = "";                  # the last bit of an incomplete input line
 311 $mynl = "\n";                   # standard terminator
 312 $lasttime = time;               # lasttime something happened on the interface
 313 $outqueue = "";                 # the output queue
 314 $client_buffer_lth = 200;       # how many characters are buffered up on outqueue
 315 $buffered = 1;                  # buffer output
 316 $savenl = "";                   # an NL that has been saved from last time
 317 $timeout = 60;                  # default timeout for connects
 318 $abort = "";                    # the current abort string
 319 $cpath = "$root/connect";               # the basic connect directory
 320
 321 $pid = 0;                       # the pid of the child program
 322 $csort = "";                    # the connection type
 323 $sock = 0;                      # connection socket
 324
 325 $stdin = *STDIN;
 326 $stdout = *STDOUT;
 327 $rfh = 0;
 328 $wfh = 0;
 329
 330 $waitedpid = 0;
 331
 332 #
 333 # deal with args
 334 #
 335
 336 $call = uc shift @ARGV if @ARGV;
 337 $call = uc $myalias if !$call;
 338 $connsort = lc shift @ARGV if @ARGV;
 339 $connsort = 'local' if !$connsort;
 340
 341 $loginreq = $call eq 'LOGIN';
 342
 343 # we will do this again later 'cos things may have changed
 344 $mode = ($connsort eq 'ax25') ? 1 : 2;
 345 setmode();
 346
 347 if ($call eq $mycall) {
 348         print $stdout "You cannot connect as your cluster callsign ($mycall)", $nl;
 349         cease(0);
 350 }
 351
 352 $stdout->autoflush(1);
 353
 354 $SIG{'INT'} = \&sig_term;
 355 $SIG{'TERM'} = \&sig_term;
 356 $SIG{'HUP'} = 'IGNORE';
 357 $SIG{'CHLD'} = \&sig_chld;
 358 $SIG{'ALRM'} = \&timeout;
 359
 360 dbgadd('connect');
 361
 362 # do we need to do a login and password job?
 363 if ($loginreq) {
 364         my $user;
 365         my $s;
 366
 367         if (-e "$data/issue") {
 368                 open(I, "$data/issue") or die;
 369                 local $/ = undef;
 370                 $issue = <I>;
 371                 close(I);
 372                 $issue = s/\n/\r/og if $mode == 1;
 373                 local $/ = $nl;
 374                 $stdout->print($issue) if $issue;
 375         }
 376
 377
 378         use DXUser;
 379
 380         DXUser->init($userfn);
 381
 382         # allow a login from an existing user. I could create a user but
 383         # I want to check for valid callsigns and I don't have the
 384         # necessary info / regular expression yet
 385         for ($state = 0; $state < 2; ) {
 386                 alarm($timeout);
 387
 388                 if ($state == 0) {
 389                         $stdout->print('login: ');
 390                         $stdout->flush();
 391                         local $\ = $nl;
 392                         $s = $stdin->getline();
 393                         chomp $s;
 394                         $s =~ s/\s+//og;
 395                         $s =~ s/-\d+$//o;            # no ssids!
 396                         cease(0) unless $s gt ' ';
 397                         $call = uc $s;
 398                         $user = DXUser->get($call);
 399                         $state = 1;
 400                 } elsif ($state == 1) {
 401                         $stdout->print('password: ');
 402                         $stdout->flush();
 403                         local $\ = $nl;
 404                         $s = $stdin->getline();
 405                         chomp $s;
 406                         $state = 2;
 407                         if (!$user || ($user->passwd && $user->passwd ne $s)) {
 408                                 $stdout->print("sorry...$nl");
 409                                 cease(0);
 410                         }
 411                 }
 412         }
 413 }
 414
 415 # handle callsign and connection type firtling
 416 sub doclient
 417 {
 418         my $line = shift;
 419         my @f = split /\s+/, $line;
 420         $call = uc $f[0] if $f[0];
 421         $csort = $f[1] if $f[1];
 422 }
 423
 424 # is this an out going connection?
 425 if ($connsort eq "connect") {
 426         my $mcall = lc $call;
 427
 428         open(IN, "$cpath/$mcall") or cease(2);
 429         @in = <IN>;
 430         close IN;
 431
 432         alarm($timeout);
 433
 434         for (@in) {
 435                 chomp;
 436                 next if /^\s*\#/o;
 437                 next if /^\s*$/o;
 438                 doconnect($1, $2) if /^\s*co\w*\s+(\w+)\s+(.*)$/io;
 439                 doabort($1) if /^\s*a\w*\s+(.*)/io;
 440                 dotimeout($1) if /^\s*t\w*\s+(\d+)/io;
 441                 dochat($1, $2) if /\s*\'(.*)\'\s+\'(.*)\'/io;
 442                 if (/\s*cl\w+\s+(.*)/io) {
 443                         doclient($1);
 444                         last;
 445                 }
 446         }
 447
 448     dbg('connect', "Connected to $call ($csort), starting normal protocol");
 449         dbgsub('connect');
 450
 451         # if we get here we are connected
 452         if ($csort eq 'ax25' || $csort eq 'prog') {
 453                 #               open(STDIN, "<&R");
 454                 #               open(STDOUT, ">&W");
 455                 #               close R;
 456                 #               close W;
 457         $stdin = $rfh;
 458                 $stdout = $wfh;
 459                 $csort = 'telnet' if $csort eq 'prog';
 460         } elsif ($csort eq 'telnet') {
 461                 #               open(STDIN, "<&$sock");
 462                 #               open(STDOUT, ">&$sock");
 463                 #               close $sock;
 464                 $stdin = $sock;
 465                 $stdout = $sock;
 466         }
 467     alarm(0);
 468     $outbound = 1;
 469         $connsort = $csort;
 470         $stdout->autoflush(1);
 471         close STDIN;
 472         close STDOUT;
 473         close STDERR;
 474 }
 475
 476 $mode = ($connsort eq 'ax25') ? 1 : 2;
 477 setmode();
 478
 479 $conn = Msg->connect("$clusteraddr", $clusterport, \&rec_socket);
 480 if (! $conn) {
 481         if (-r "$data/offline") {
 482                 open IN, "$data/offline" or die;
 483                 while (<IN>) {
 484                         s/\n/\r/og if $mode == 1;
 485                         print $stdout $_;
 486                 }
 487                 close IN;
 488         } else {
 489                 print $stdout "Sorry, the cluster $mycall is currently off-line", $mynl;
 490         }
 491         cease(0);
 492 }
 493
 494 $let = $outbound ? 'O' : 'A';
 495 $conn->send_now("$let$call|$connsort");
 496 Msg->set_event_handler($stdin, "read" => \&rec_stdin);
 497
 498 for (;;) {
 499         my $t;
 500         Msg->event_loop(1, 1);
 501         $t = time;
 502         if ($t > $lasttime) {
 503                 if ($outqueue) {
 504                         print $stdout $outqueue;
 505                         $outqueue = "";
 506                 }
 507                 $lasttime = $t;
 508         }
 509 }
 510
 511 exit(0);