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);
35 @ISA = qw(Msg ExtMsg);
42 $lastytime = $lasthtime = time;
43 $ypolltime = 10 unless defined $ypolltime;
44 $hpolltime = 300 unless defined $hpolltime;
49 return unless $enable;
53 dbg('err', "AGW initialising and connecting to $addr/$port ...");
54 $sock = IO::Socket::INET->new(PeerAddr => $addr, PeerPort => $port, Proto=>'tcp', Timeout=>15);
56 dbg('err', "Cannot connect to AGW Engine at $addr/$port $!");
59 Msg::blocking($sock, 0);
60 Msg::set_event_handler($sock, read=>\&_rcv, error=>\&_error);
62 # send a P frame for the login if required
64 my $data = pack "a255 a255", $login, $passwd;
65 _sendf('P', undef, undef, undef, undef, $data);
69 # R frame for the release number
70 # G frame to ask for ports
71 # X frame to say who we are
72 # optional m frame to enable monitoring
75 _sendf('X', $main::mycall);
76 _sendf('m') if $monitor;
86 dbg('err', "AGW ending...");
87 for (values %circuit) {
88 &{$_->{eproc}}() if $_->{eproc};
92 _sendf('m') if $monitor;
93 _sendf('x', $main::mycall);
95 Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
102 my $sort = shift || confess "need a valid AGW command letter";
103 my $from = shift || '';
104 my $to = shift || '';
105 my $port = shift || 0;
106 my $pid = shift || 0;
107 my $data = shift || '';
111 if ($sort eq 'y' || $sort eq 'H') {
112 dbg('agwpoll', "AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"");
113 } elsif ($sort eq 'D') {
117 dbg('agw', "AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$d\"");
120 dbg('agw', "AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"");
122 push @outqueue, pack('C x3 a1 x1 C x1 a10 a10 V x4 a*', $port, $sort, $pid, $from, $to, $len, $data);
123 Msg::set_event_handler($sock, write=>\&_send);
130 # If $flush is set, set the socket to blocking, and send all
131 # messages in the queue - return only if there's an error
132 # If $flush is 0 (deferred mode) make the socket non-blocking, and
133 # return to the event loop only after every message, or if it
134 # is likely to block in the middle of a message.
136 my $offset = $send_offset;
139 my $msg = $outqueue[0];
140 my $mlth = length($msg);
141 my $bytes_to_write = $mlth - $offset;
142 my $bytes_written = 0;
143 confess("Negative Length! msg: '$msg' lth: $mlth offset: $offset") if $bytes_to_write < 0;
144 while ($bytes_to_write > 0) {
145 $bytes_written = syswrite ($sock, $msg,
146 $bytes_to_write, $offset);
147 if (!defined($bytes_written)) {
148 if (Msg::_err_will_block($!)) {
149 # Should happen only in deferred mode. Record how
150 # much we have already sent.
151 $send_offset = $offset;
152 # Event handler should already be set, so we will
153 # be called back eventually, and will resume sending
157 return 0; # fail. Message remains in queue ..
161 dbgdump('raw', "send $bytes_written: ", $msg);
163 $offset += $bytes_written;
164 $bytes_to_write -= $bytes_written;
166 $send_offset = $offset = 0;
168 last; # Go back to select and wait
169 # for it to fire again.
172 # Call me back if queue has not been drained.
174 Msg::set_event_handler ($sock, write => \&_send);
176 Msg::set_event_handler ($sock, write => undef);
181 sub _rcv { # Complement to _send
183 my ($msg, $offset, $bytes_read);
185 $bytes_read = sysread ($sock, $msg, 1024, 0);
186 if (defined ($bytes_read)) {
187 if ($bytes_read > 0) {
190 dbgdump('raw', "read $bytes_read: ", $msg);
194 if (Msg::_err_will_block($!)) {
202 if (defined $bytes_read && $bytes_read == 0) {
205 _decode() if length $inmsg >= 36;
211 dbg('agw', "error on AGW connection $addr/$port $!");
212 Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
215 &{$_->{eproc}}() if $_->{eproc};
224 # we have at least 36 bytes of data (ugh!)
225 while (length $inmsg >= 36) {
226 my ($port, $sort, $pid, $from, $to, $len) = unpack('C x3 a1 x1 C x1 Z10 Z10 V x4', $inmsg);
229 # do a sanity check on the length
231 dbg('err', "AGW: invalid length $len > 2000 received ($sort $port $pid '$from'->'$to')");
236 if (length $inmsg > 36) {
237 $inmsg = substr($inmsg, 36);
241 } elsif (length $inmsg > $len + 36) {
242 $data = substr($inmsg, 36, $len);
243 $inmsg = substr($inmsg, $len + 36);
244 } elsif (length $inmsg == $len + 36) {
245 $data = substr($inmsg, 36);
249 # we don't have enough data or something
250 # or we have screwed up
255 $data = '' unless defined $data;
257 my $d = unpack "Z*", $data;
259 dbg('agw', "AGW Data In port: $port pid: $pid '$from'->'$to' length: $len \"$d\"");
260 my $conn = _find($from eq $main::mycall ? $to : $from);
262 if ($conn->{state} eq 'WC') {
263 if (exists $conn->{cmd}) {
264 if (@{$conn->{cmd}}) {
269 if ($conn->{state} eq 'WC' && exists $conn->{cmd} && @{$conn->{cmd}} == 0) {
270 $conn->to_connected($conn->{call}, 'O', $conn->{csort});
273 my @lines = split /\cM/, $data;
276 &{$conn->{rproc}}($conn, "I$conn->{call}|$_");
279 &{$conn->{rproc}}($conn, "I$conn->{call}|");
283 dbg('err', "AGW error Unsolicited Data!");
285 } elsif ($sort eq 'I' || $sort eq 'S' || $sort eq 'U' || $sort eq 'M' || $sort eq 'T') {
286 my $d = unpack "Z*", $data;
288 my @lines = split /\cM/, $d;
291 s/([\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
292 dbg('agw', "AGW Monitor port: $port \"$_\"");
294 } elsif ($sort eq 'C') {
295 my $d = unpack "Z*", $data;
297 dbg('agw', "AGW Connect port: $port pid: $pid '$from'->'$to' \"$d\"");
298 my $call = $from eq $main::mycall ? $to : $from;
299 my $conn = _find($call);
301 if ($conn->{state} eq 'WC') {
302 if (exists $conn->{cmd} && @{$conn->{cmd}}) {
304 if ($conn->{state} eq 'WC' && exists $conn->{cmd} && @{$conn->{cmd}} == 0) {
305 $conn->to_connected($conn->{call}, 'O', $conn->{csort});
310 $conn = AGWMsg->new($rproc);
311 $conn->{agwpid} = $pid;
312 $conn->{agwport} = $port;
313 $conn->{lineend} = "\cM";
314 $conn->{incoming} = 1;
315 $conn->{agwcall} = $call;
316 $circuit{$call} = $conn;
317 if ($call =~ /^(\w+)-(\d\d?)$/) {
321 if ($s <= 8 && $s > 0) {
327 $conn->to_connected($call, 'A', $conn->{csort} = 'ax25');
329 } elsif ($sort eq 'd') {
330 dbg('agw', "AGW '$from'->'$to' port: $port Disconnected");
331 my $conn = _find($from eq $main::mycall ? $to : $from);
333 &{$conn->{eproc}}() if $conn->{eproc};
334 $conn->in_disconnect;
336 } elsif ($sort eq 'y') {
337 my ($frames) = unpack "V", $data;
338 dbg('agwpollans', "AGW Frames Outstanding on port $port = $frames");
339 my $conn = _find($from);
340 $conn->{oframes} = $frames if $conn;
341 } elsif ($sort eq 'Y') {
342 my ($frames) = unpack "V", $data;
343 dbg('agw', "AGW Frames Outstanding on circuit '$from'->'$to' = $frames");
344 my $conn = _find($from eq $main::mycall ? $to : $from);
345 $conn->{oframes} = $frames if $conn;
346 } elsif ($sort eq 'H') {
347 unless ($from =~ /^\s+$/) {
348 my $d = unpack "Z*", $data;
350 dbg('agw', "AGW Heard port: $port \"$d\"");
352 } elsif ($sort eq 'X') {
353 my ($r) = unpack "C", $data;
354 $r = $r ? "Successful" : "Failed";
355 dbg('err', "AGW Register $from $r");
357 } elsif ($sort eq 'R') {
358 my ($major, $minor) = unpack "v x2 v x2", $data;
359 dbg('agw', "AGW Version $major.$minor");
360 } elsif ($sort eq 'G') {
361 my @ports = split /;/, $data;
362 $noports = shift @ports || '0';
363 dbg('agw', "AGW $noports Ports available");
364 pop @ports while @ports > $noports;
367 dbg('agw', "AGW Port: $_");
369 for (my $i = 0; $i < $noports; $i++) {
370 _sendf('y', undef, undef, $i);
371 _sendf('g', undef, undef, $i);
374 my $d = unpack "Z*", $data;
375 dbg('agw', "AGW decode $sort port: $port pid: $pid '$from'->'$to' length: $len \"$d\"");
383 return $circuit{$call};
388 my ($conn, $line) = @_;
390 my ($port, $call) = split /\s+/, $line;
391 $conn->{agwpid} = ord "\xF0";
392 $conn->{agwport} = $port - 1;
393 $conn->{lineend} = "\cM";
394 $conn->{incoming} = 0;
395 $conn->{csort} = 'ax25';
396 $conn->{agwcall} = uc $call;
397 $circuit{$conn->{agwcall}} = $conn;
399 _sendf('C', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
400 $conn->{state} = 'WC';
408 delete $circuit{$conn->{agwcall}};
409 $conn->SUPER::disconnect;
415 delete $circuit{$conn->{agwcall}};
416 if ($conn->{incoming}) {
417 _sendf('d', $conn->{agwcall}, $main::mycall, $conn->{agwport}, $conn->{agwpid});
419 _sendf('d', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
421 $conn->SUPER::disconnect;
426 my ($conn, $msg) = @_;
428 $msg =~ s/^[-\w]+\|//;
429 # _sendf('Y', $main::mycall, $conn->{call}, $conn->{agwport}, $conn->{agwpid});
430 _sendf('D', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid}, $msg . $conn->{lineend});
431 my $len = length($msg) + 1;
432 dbg('agw', "AGW Data Out port: $conn->{agwport} pid: $conn->{agwpid} '$main::mycall'->'$conn->{agwcall}' length: $len \"$msg\"");
439 if ($ypolltime && $main::systime - $lastytime >= $ypolltime) {
440 for (my $i = 0; $i < $noports; $i++) {
441 _sendf('y', undef, undef, $i );
443 $lastytime = $main::systime;
445 if ($hpolltime && $main::systime - $lasthtime >= $hpolltime) {
446 for (my $i = 0; $i < $noports; $i++) {
447 _sendf('H', undef, undef, $i );
449 $lasthtime = $main::systime;