1914ab3179e53e54365c685a05b1022c95937f05
[spider.git] / 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 IO::File;
45 use IO::Socket;
46 use IPC::Open2;
47 use Net::Telnet qw(TELOPT_ECHO);
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                         $sock = new Net::Telnet (Timeout => $timeout, Port => $port);
213                         $sock->option_callback(\&optioncb);
214                         $sock->output_record_separator('');
215                         $sock->option_log('option_log');
216                         $sock->dump_log('dump');
217                         $sock->option_accept(Wont => TELOPT_ECHO);
218                         $sock->open($host) or die "Can't connect to $host port $port $!";
219 #               } else {
220 #                       $sock = IO::Socket::INET->new(PeerAddr => "$host:$port", Proto => 'tcp')
221 #                               or die "Can't connect to $host port $port $!";
222 #               }
223         } elsif ($sort eq 'ax25' || $sort eq 'prog') {
224                 my @args = split /\s+/, $line;
225                 $rfh = new IO::File;
226                 $wfh = new IO::File;
227                 $pid = open2($rfh, $wfh, "$line") or die "can't do $line $!";
228                 die "no receive channel $!" unless $rfh;
229                 die "no transmit channel $!" unless $wfh;
230                 dbg('connect', "got pid $pid");
231                 $wfh->autoflush(1);
232         } else {
233                 die "invalid type of connection ($sort)";
234         }
235         $csort = $sort;
236 }
237
238 sub doabort
239 {
240         my $string = shift;
241         dbg('connect', "abort $string");
242         $abort = $string;
243 }
244
245 sub dotimeout
246 {
247         my $val = shift;
248         dbg('connect', "timeout set to $val");
249         $timeout = $val;
250 }
251
252 sub dochat
253 {
254         my ($expect, $send) = @_;
255         dbg('connect', "CHAT \"$expect\" -> \"$send\"");
256     my $line;
257         
258         alarm($timeout);
259         
260     if ($expect) {
261                 for (;;) {
262                         if ($csort eq 'telnet') {
263                                 $line = $sock->get();
264                                 $line =~ s/\r\n/\n/og;
265                                 chomp;
266                         } elsif ($csort eq 'ax25' || $csort eq 'prog') {
267                                 local $/ = "\r";
268                                 $line = <$rfh>;
269                                 $line =~ s/\r//og;
270                         }
271                         dbg('connect', "received \"$line\"");
272                         if ($abort && $line =~ /$abort/i) {
273                                 dbg('connect', "aborted on /$abort/");
274                                 cease(11);
275                         }
276                         last if $line =~ /$expect/i;
277                 }
278         }
279         if ($send) {
280                 if ($csort eq 'telnet') {
281                         $sock->print("$send\n");
282                 } elsif ($csort eq 'ax25') {
283                         local $\ = "\r";
284                         $wfh->print("$send");
285                 }
286                 dbg('connect', "sent \"$send\"");
287         }
288 }
289
290 sub timeout
291 {
292         dbg('connect', "timed out after $timeout seconds");
293         cease(0);
294 }
295
296
297 #
298 # initialisation
299 #
300
301 $mode = 2;                      # 1 - \n = \r as EOL, 2 - \n = \n, 0 - transparent
302 $call = "";                     # the callsign being used
303 $conn = 0;                      # the connection object for the cluster
304 $lastbit = "";                  # the last bit of an incomplete input line
305 $mynl = "\n";                   # standard terminator
306 $lasttime = time;               # lasttime something happened on the interface
307 $outqueue = "";                 # the output queue 
308 $client_buffer_lth = 200;       # how many characters are buffered up on outqueue
309 $buffered = 1;                  # buffer output
310 $savenl = "";                   # an NL that has been saved from last time
311 $timeout = 60;                  # default timeout for connects
312 $abort = "";                    # the current abort string
313 $cpath = "$root/connect";               # the basic connect directory
314
315 $pid = 0;                       # the pid of the child program
316 $csort = "";                    # the connection type
317 $sock = 0;                      # connection socket
318
319 $stdin = *STDIN;
320 $stdout = *STDOUT;
321 $rfh = 0;
322 $wfh = 0;
323
324 $waitedpid = 0;
325
326 #
327 # deal with args
328 #
329
330 $call = uc shift @ARGV if @ARGV;
331 $call = uc $myalias if !$call;
332 $connsort = lc shift @ARGV if @ARGV;
333 $connsort = 'local' if !$connsort;
334
335 $loginreq = $call eq 'LOGIN';
336
337 # we will do this again later 'cos things may have changed
338 $mode = ($connsort eq 'ax25') ? 1 : 2;
339 setmode();
340
341 if ($call eq $mycall) {
342         print $stdout "You cannot connect as your cluster callsign ($mycall)", $nl;
343         cease(0);
344 }
345
346 $stdout->autoflush(1);
347
348 $SIG{'INT'} = \&sig_term;
349 $SIG{'TERM'} = \&sig_term;
350 $SIG{'HUP'} = 'IGNORE';
351 $SIG{'CHLD'} = \&sig_chld;
352 $SIG{'ALRM'} = \&timeout;
353
354 dbgadd('connect');
355
356 # do we need to do a login and password job?
357 if ($loginreq) {
358         my $user;
359         my $s;
360
361         if (-e "$data/issue") {
362                 open(I, "$data/issue") or die;
363                 local $/ = undef;
364                 $issue = <I>;
365                 close(I);
366                 $issue = s/\n/\r/og if $mode == 1;
367                 local $/ = $nl;
368                 $stdout->print($issue) if $issue;
369         }
370         
371
372         use DXUser;
373         
374         DXUser->init($userfn);
375         
376         # allow a login from an existing user. I could create a user but
377         # I want to check for valid callsigns and I don't have the 
378         # necessary info / regular expression yet
379         for ($state = 0; $state < 2; ) {
380                 alarm($timeout);
381                 
382                 if ($state == 0) {
383                         $stdout->print('login: ');
384                         $stdout->flush();
385                         local $\ = $nl;
386                         $s = $stdin->getline();
387                         chomp $s;
388                         $s =~ s/\s+//og;
389                         $s =~ s/-\d+$//o;            # no ssids!
390                         cease(0) unless $s gt ' ';
391                         $call = uc $s;
392                         $user = DXUser->get($call);
393                         $state = 1;
394                 } elsif ($state == 1) {
395                         $stdout->print('password: ');
396                         $stdout->flush();
397                         local $\ = $nl;
398                         $s = $stdin->getline();
399                         chomp $s;
400                         $state = 2;
401                         if (!$user || ($user->passwd && $user->passwd ne $s)) {
402                                 $stdout->print("sorry...$nl");
403                                 cease(0);
404                         }
405                 }
406         }
407 }
408
409 # handle callsign and connection type firtling
410 sub doclient
411 {
412         my $line = shift;
413         my @f = split /\s+/, $line;
414         $call = uc $f[0] if $f[0];
415         $csort = $f[1] if $f[1];
416 }
417
418 # is this an out going connection?
419 if ($connsort eq "connect") {
420         my $mcall = lc $call;
421         
422         open(IN, "$cpath/$mcall") or cease(2);
423         @in = <IN>;
424         close IN;
425
426         alarm($timeout);
427         
428         for (@in) {
429                 chomp;
430                 next if /^\s*\#/o;
431                 next if /^\s*$/o;
432                 doconnect($1, $2) if /^\s*co\w*\s+(\w+)\s+(.*)$/io;
433                 doabort($1) if /^\s*a\w*\s+(.*)/io;
434                 dotimeout($1) if /^\s*t\w*\s+(\d+)/io;
435                 dochat($1, $2) if /\s*\'(.*)\'\s+\'(.*)\'/io;
436                 if (/\s*cl\w+\s+(.*)/io) {
437                         doclient($1);
438                         last;
439                 }
440         }
441         
442     dbg('connect', "Connected to $call ($csort), starting normal protocol");
443         dbgsub('connect');
444         
445         # if we get here we are connected
446         if ($csort eq 'ax25' || $csort eq 'prog') {
447                 #               open(STDIN, "<&R"); 
448                 #               open(STDOUT, ">&W"); 
449                 #               close R;
450                 #               close W;
451         $stdin = $rfh;
452                 $stdout = $wfh;
453                 $csort = 'telnet' if $csort eq 'prog';
454         } elsif ($csort eq 'telnet') {
455                 #               open(STDIN, "<&$sock"); 
456                 #               open(STDOUT, ">&$sock"); 
457                 #               close $sock;
458                 $stdin = $sock;
459                 $stdout = $sock;
460         }
461     alarm(0);
462     $outbound = 1;
463         $connsort = $csort;
464         $stdout->autoflush(1);
465         close STDIN;
466         close STDOUT;
467         close STDERR;
468 }
469
470 $mode = ($connsort eq 'ax25') ? 1 : 2;
471 setmode();
472
473 $conn = Msg->connect("$clusteraddr", $clusterport, \&rec_socket);
474 if (! $conn) {
475         if (-r "$data/offline") {
476                 open IN, "$data/offline" or die;
477                 while (<IN>) {
478                         s/\n/\r/og if $mode == 1;
479                         print $stdout $_;
480                 }
481                 close IN;
482         } else {
483                 print $stdout "Sorry, the cluster $mycall is currently off-line", $mynl;
484         }
485         cease(0);
486 }
487
488 $let = $outbound ? 'O' : 'A';
489 $conn->send_now("$let$call|$connsort");
490 Msg->set_event_handler($stdin, "read" => \&rec_stdin);
491
492 for (;;) {
493         my $t;
494         Msg->event_loop(1, 0.010);
495         $t = time;
496         if ($t > $lasttime) {
497                 if ($outqueue) {
498                         print $stdout $outqueue;
499                         $outqueue = "";
500                 }
501                 $lasttime = $t;
502         }
503 }
504
505 exit(0);