perl/client.pl

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