2 # This class is the internal subclass that deals with AGW Engine connections
4 # The complication here is that there only one 'real' (and from the node's point
5 # of view, invisible) IP connection. This connection then has multiplexed
6 # connections passed down it, a la BPQ native host ports (but not as nicely).
8 # It is a shame that the author has chosen an inherently dangerous binary format
9 # which is non-framed and has the potential for getting out of sync and not
10 # being able to recover. Relying on length fields is recipe for disaster (esp.
11 # for him!). DoS attacks are a wonderful thing....
13 # Also making the user handle the distinction between a level 2 and 4 connection
14 # and especially Digis, in the way that he has, is a bit of a cop out! If I can
15 # be arsed to do anything other than straight ax25 connects then it will only
16 # because I have the 'power of perl' available that avoids me getting
17 # terminally bored sorting out other people's sloppyness.
21 # Copyright (c) 2001 - Dirk Koopman G1TLH
32 use vars qw(@ISA $sock @outqueue $send_offset $inmsg $rproc $noports $lastytime
33 $lasthtime $ypolltime $hpolltime %circuit $total_in $total_out
34 $lastconnect $connectinterval);
36 @ISA = qw(Msg ExtMsg);
43 $lastytime = $lasthtime = time;
44 $ypolltime = 10 unless defined $ypolltime;
45 $hpolltime = 300 unless defined $hpolltime;
47 $total_in = $total_out = 0;
49 $connectinterval = 30;
53 return unless $enable;
55 # only set $rproc if there is something to set rproc from!
57 $rproc = $rp if defined $rp;
61 dbg("AGW initialising and connecting to $addr/$port ...");
62 $sock = IO::Socket::INET->new(PeerAddr => $addr, PeerPort => $port, Proto=>'tcp', Timeout=>3);
63 $lastconnect = $main::systime;
65 dbg("Cannot connect to AGW Engine at $addr/$port $!");
68 Msg::blocking($sock, 0);
69 Msg::set_event_handler($sock, read=>\&_rcv, error=>\&_error);
71 # send a P frame for the login if required
73 my $data = pack "a255 a255", $login, $passwd;
74 _sendf('P', undef, undef, undef, undef, $data);
78 # R frame for the release number
79 # G frame to ask for ports
80 # X frame to say who we are
81 # optional m frame to enable monitoring
84 _sendf('X', $main::mycall);
85 _sendf('m') if $monitor;
96 for (values %circuit) {
97 &{$_->{eproc}}() if $_->{eproc};
101 _sendf('m') if $monitor;
102 _sendf('x', $main::mycall);
104 Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
106 $lastconnect = $main::systime;
114 goto &main::login; # save some writing, this was the default
124 my $sort = shift || confess "need a valid AGW command letter";
125 my $from = shift || '';
126 my $to = shift || '';
127 my $port = shift || 0;
128 my $pid = shift || 0;
129 my $data = shift || '';
135 if ($sort eq 'y' || $sort eq 'H') {
136 dbg("AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"") if isdbg('agwpoll');
137 } elsif ($sort eq 'D') {
141 dbg("AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$d\"") if isdbg('agw');
144 dbg("AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"") if isdbg('agw');
146 push @outqueue, pack('C x3 a1 x1 C x1 a10 a10 V x4 a*', $port, $sort, $pid, $from, $to, $len, $data);
147 Msg::set_event_handler($sock, write=>\&_send);
154 # If $flush is set, set the socket to blocking, and send all
155 # messages in the queue - return only if there's an error
156 # If $flush is 0 (deferred mode) make the socket non-blocking, and
157 # return to the event loop only after every message, or if it
158 # is likely to block in the middle of a message.
160 my $offset = $send_offset;
163 my $msg = $outqueue[0];
164 my $mlth = length($msg);
165 my $bytes_to_write = $mlth - $offset;
166 my $bytes_written = 0;
167 confess("Negative Length! msg: '$msg' lth: $mlth offset: $offset") if $bytes_to_write < 0;
168 while ($bytes_to_write > 0) {
169 $bytes_written = syswrite ($sock, $msg,
170 $bytes_to_write, $offset);
171 if (!defined($bytes_written)) {
172 if (Msg::_err_will_block($!)) {
173 # Should happen only in deferred mode. Record how
174 # much we have already sent.
175 $send_offset = $offset;
176 # Event handler should already be set, so we will
177 # be called back eventually, and will resume sending
181 return 0; # fail. Message remains in queue ..
185 dbgdump('raw', "AGW send $bytes_written: ", $msg);
187 $total_out += $bytes_written;
188 $offset += $bytes_written;
189 $bytes_to_write -= $bytes_written;
191 $send_offset = $offset = 0;
193 last; # Go back to select and wait
194 # for it to fire again.
197 # Call me back if queue has not been drained.
199 Msg::set_event_handler ($sock, write => \&_send);
201 Msg::set_event_handler ($sock, write => undef);
206 sub _rcv { # Complement to _send
208 my ($msg, $offset, $bytes_read);
210 $bytes_read = sysread ($sock, $msg, 1024, 0);
211 if (defined ($bytes_read)) {
212 if ($bytes_read > 0) {
213 $total_in += $bytes_read;
216 dbgdump('raw', "AGW read $bytes_read: ", $msg);
220 if (Msg::_err_will_block($!)) {
229 if (defined $bytes_read && $bytes_read == 0) {
232 _decode() if length $inmsg >= 36;
238 return if $finishing;
240 dbg("AGW connection error on $addr/$port $!");
241 Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
243 &{$_->{eproc}}() if $_->{eproc};
247 $lastconnect = $main::systime;
255 # we have at least 36 bytes of data (ugh!)
256 while (length $inmsg >= 36) {
257 my ($port, $sort, $pid, $from, $to, $len) = unpack('C x3 a1 x1 C x1 Z10 Z10 V x4', $inmsg);
260 # do a sanity check on the length
262 dbg("AGW: invalid length $len > 2000 received ($sort $port $pid '$from'->'$to')");
267 if (length $inmsg > 36) {
268 $inmsg = substr($inmsg, 36);
272 } elsif (length $inmsg > $len + 36) {
273 $data = substr($inmsg, 36, $len);
274 $inmsg = substr($inmsg, $len + 36);
275 } elsif (length $inmsg == $len + 36) {
276 $data = substr($inmsg, 36);
280 # we don't have enough data or something
281 # or we have screwed up
286 $data = '' unless defined $data;
288 my $d = unpack "Z*", $data;
291 dbg("AGW Data In port: $port pid: $pid '$from'->'$to' length: $len \"$d\"") if isdbg('agw');
292 my $conn = _find($from eq $main::mycall ? $to : $from);
294 if ($conn->{state} eq 'WC') {
295 if (exists $conn->{cmd}) {
296 if (@{$conn->{cmd}}) {
297 dbg($d) if isdbg('connect');
301 if ($conn->{state} eq 'WC' && exists $conn->{cmd} && @{$conn->{cmd}} == 0) {
302 $conn->to_connected($conn->{call}, 'O', $conn->{csort});
305 my @lines = split /\cM\cJ?/, $d;
306 push @lines, $d unless @lines;
308 &{$conn->{rproc}}($conn, "I$conn->{call}|$_");
312 dbg("AGW error Unsolicited Data!");
314 } elsif ($sort eq 'I' || $sort eq 'S' || $sort eq 'U' || $sort eq 'M' || $sort eq 'T') {
315 my $d = unpack "Z*", $data;
318 my @lines = split /\cM\cJ?/, $d;
321 # s/([\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
322 dbg("AGW Monitor port: $port \"$_\"") if isdbg('agw');
324 } elsif ($sort eq 'C') {
325 my $d = unpack "Z*", $data;
327 dbg("AGW Connect port: $port pid: $pid '$from'->'$to' \"$d\"") if isdbg('agw');
328 my $call = $from eq $main::mycall ? $to : $from;
329 my $conn = _find($call);
331 if ($conn->{state} eq 'WC') {
332 if (exists $conn->{cmd} && @{$conn->{cmd}}) {
334 if ($conn->{state} eq 'WC' && exists $conn->{cmd} && @{$conn->{cmd}} == 0) {
335 $conn->to_connected($conn->{call}, 'O', $conn->{csort});
340 $conn = AGWMsg->new($rproc);
341 $conn->{agwpid} = $pid;
342 $conn->{agwport} = $port;
343 $conn->{lineend} = "\cM";
344 $conn->{incoming} = 1;
345 $conn->{agwcall} = $call;
346 $circuit{$call} = $conn;
347 if (my ($c, $s) = $call =~ /^(\w+)-(\d\d?)$/) {
348 $s = 15 - $s if $s > 8;
349 $call = $s > 0 ? "${c}-${s}" : $c;
351 $conn->to_connected($call, 'A', $conn->{csort} = 'ax25');
353 } elsif ($sort eq 'd') {
354 my $d = unpack "Z*", $data;
356 dbg("AGW '$from'->'$to' port: $port Disconnected ($d)") if isdbg('agw');
357 my $conn = _find($from eq $main::mycall ? $to : $from);
359 &{$conn->{eproc}}() if $conn->{eproc};
360 $conn->in_disconnect;
362 } elsif ($sort eq 'y') {
363 my ($frames) = unpack "V", $data;
364 dbg("AGW Frames Outstanding on port $port = $frames") if isdbg('agwpollans');
365 my $conn = _find($from);
366 $conn->{oframes} = $frames if $conn;
367 } elsif ($sort eq 'Y') {
368 my ($frames) = unpack "V", $data;
369 dbg("AGW Frames Outstanding on circuit '$from'->'$to' = $frames") if isdbg('agw');
370 my $conn = _find($from eq $main::mycall ? $to : $from);
371 $conn->{oframes} = $frames if $conn;
372 } elsif ($sort eq 'H') {
373 unless ($from =~ /^\s+$/) {
374 my $d = unpack "Z*", $data;
376 dbg("AGW Heard port: $port \"$d\"") if isdbg('agw');
378 } elsif ($sort eq 'X') {
379 my ($r) = unpack "C", $data;
380 $r = $r ? "Successful" : "Failed";
381 dbg("AGW Register $from $r");
383 } elsif ($sort eq 'R') {
384 my ($major, $minor) = unpack "v x2 v x2", $data;
385 dbg("AGW Version $major.$minor") if isdbg('agw');
386 } elsif ($sort eq 'G') {
387 my @ports = split /;/, $data;
388 $noports = shift @ports || '0';
389 dbg("AGW $noports Ports available") if isdbg('agw');
390 pop @ports while @ports > $noports;
393 dbg("AGW Port: $_") if isdbg('agw');
395 for (my $i = 0; $i < $noports; $i++) {
396 _sendf('y', undef, undef, $i);
397 _sendf('g', undef, undef, $i);
400 my $d = unpack "Z*", $data;
401 dbg("AGW decode $sort port: $port pid: $pid '$from'->'$to' length: $len \"$d\"") if isdbg('agw');
409 return $circuit{$call};
415 $conn->{peerhost} ||= 'ax25';
416 return $conn->{peerhost};
421 my ($conn, $line) = @_;
423 my ($port, $call) = split /\s+/, $line;
424 $conn->{agwpid} = ord "\xF0";
425 $conn->{agwport} = $port - 1;
426 $conn->{lineend} = "\cM";
427 $conn->{incoming} = 0;
428 $conn->{csort} = 'ax25';
429 $conn->{agwcall} = uc $call;
430 $circuit{$conn->{agwcall}} = $conn;
432 _sendf('C', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
433 $conn->{state} = 'WC';
441 delete $circuit{$conn->{agwcall}};
442 $conn->SUPER::disconnect;
448 delete $circuit{$conn->{agwcall}};
449 if ($conn->{incoming}) {
450 _sendf('d', $conn->{agwcall}, $main::mycall, $conn->{agwport}, $conn->{agwpid});
452 _sendf('d', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
454 $conn->SUPER::disconnect;
459 my ($conn, $msg) = @_;
461 $msg =~ s/^[-\w]+\|//;
462 # _sendf('Y', $main::mycall, $conn->{call}, $conn->{agwport}, $conn->{agwpid});
463 _sendf('D', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid}, $msg . $conn->{lineend});
464 my $len = length($msg) + 1;
465 dbg("AGW Data Out port: $conn->{agwport} pid: $conn->{agwpid} '$main::mycall'->'$conn->{agwcall}' length: $len \"$msg\"") if isdbg('agw');
471 # try to reconnect to AGW if we could not previously or there was an error
472 if ($enable && !$sock && $main::systime >= $lastconnect + $connectinterval) {
477 if ($ypolltime && $main::systime - $lastytime >= $ypolltime) {
478 for (my $i = 0; $i < $noports; $i++) {
479 _sendf('y', undef, undef, $i );
481 $lastytime = $main::systime;
483 if ($hpolltime && $main::systime - $lasthtime >= $hpolltime) {
484 for (my $i = 0; $i < $noports; $i++) {
485 _sendf('H', undef, undef, $i );
487 $lasthtime = $main::systime;