perl/AGWMsg.pm

   1 #
   2 # This class is the internal subclass that deals with AGW Engine connections
   3 #
   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).
   7 #
   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....
  12 #
  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.
  18 #
  19 # $Id$
  20 #
  21 # Copyright (c) 2001 - Dirk Koopman G1TLH
  22 #
  23
  24 package AGWMsg;
  25
  26 use strict;
  27 use IO::Socket;
  28 use Msg;
  29 use AGWConnect;
  30 use DXDebug;
  31
  32 use vars qw(@ISA $sock @outqueue $send_offset $inmsg $rproc $noports $lastytime
  33                         $lasthtime $ypolltime $hpolltime %circuit);
  34
  35 @ISA = qw(Msg ExtMsg);
  36 $sock = undef;
  37 @outqueue = ();
  38 $send_offset = 0;
  39 $inmsg = '';
  40 $rproc = undef;
  41 $noports = 0;
  42 $lastytime = $lasthtime = time;
  43 $ypolltime = 10 unless defined $ypolltime;
  44 $hpolltime = 300 unless defined $hpolltime;
  45 %circuit = ();
  46
  47 use vars qw($VERSION $BRANCH);
  48 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
  49 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
  50 $main::build += $VERSION;
  51 $main::branch += $BRANCH;
  52
  53 sub init
  54 {
  55         return unless $enable;
  56         $rproc = shift;
  57
  58         finish();
  59         dbg("AGW initialising and connecting to $addr/$port ...");
  60         $sock = IO::Socket::INET->new(PeerAddr => $addr, PeerPort => $port, Proto=>'tcp', Timeout=>15);
  61         unless ($sock) {
  62                 dbg("Cannot connect to AGW Engine at $addr/$port $!");
  63                 return;
  64         }
  65         Msg::blocking($sock, 0);
  66         Msg::set_event_handler($sock, read=>\&_rcv, error=>\&_error);
  67
  68         # send a P frame for the login if required
  69         if ($login) {
  70                 my $data = pack "a255 a255", $login, $passwd;
  71                 _sendf('P', undef, undef, undef, undef, $data);
  72         }
  73
  74         # send:
  75         # R frame for the release number
  76         # G frame to ask for ports
  77         # X frame to say who we are
  78         # optional m frame to enable monitoring
  79         _sendf('R');
  80         _sendf('G');
  81         _sendf('X', $main::mycall);
  82         _sendf('m') if $monitor;
  83 }
  84
  85 my $finishing = 0;
  86
  87 sub finish
  88 {
  89         return if $finishing;
  90         if ($sock) {
  91                 $finishing = 1;
  92                 dbg("AGW ending...");
  93                 for (values %circuit) {
  94                         &{$_->{eproc}}() if $_->{eproc};
  95                         $_->disconnect;
  96                 }
  97                 # say we are going
  98                 _sendf('m') if $monitor;
  99                 _sendf('x', $main::mycall);
 100                 Msg->sleep(2);
 101                 Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
 102                 $sock->close;
 103         }
 104 }
 105
 106 sub active
 107 {
 108         return $sock;
 109 }
 110
 111 sub _sendf
 112 {
 113         my $sort = shift || confess "need a valid AGW command letter";
 114         my $from = shift || '';
 115         my $to   = shift || '';
 116         my $port = shift || 0;
 117         my $pid  = shift || 0;
 118         my $data = shift || '';
 119         my $len  = 0;
 120
 121         $len = length $data;
 122         if ($sort eq 'y' || $sort eq 'H') {
 123                 dbg("AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"") if isdbg('agwpoll');
 124         } elsif ($sort eq 'D') {
 125                 if (isdbg('agw')) {
 126                         my $d = $data;
 127                         $d =~ s/\cM$//;
 128                         dbg("AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$d\"") if isdbg('agw');
 129                 }
 130         } else {
 131                 dbg("AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"") if isdbg('agw');
 132         }
 133         push @outqueue, pack('C x3 a1 x1 C x1 a10 a10 V x4 a*', $port, $sort, $pid, $from, $to, $len, $data);
 134         Msg::set_event_handler($sock, write=>\&_send);
 135 }
 136
 137 sub _send
 138 {
 139     return unless $sock;
 140
 141     # If $flush is set, set the socket to blocking, and send all
 142     # messages in the queue - return only if there's an error
 143     # If $flush is 0 (deferred mode) make the socket non-blocking, and
 144     # return to the event loop only after every message, or if it
 145     # is likely to block in the middle of a message.
 146
 147     my $offset = $send_offset;
 148
 149     while (@outqueue) {
 150         my $msg            = $outqueue[0];
 151                 my $mlth           = length($msg);
 152         my $bytes_to_write = $mlth - $offset;
 153         my $bytes_written  = 0;
 154                 confess("Negative Length! msg: '$msg' lth: $mlth offset: $offset") if $bytes_to_write < 0;
 155         while ($bytes_to_write > 0) {
 156             $bytes_written = syswrite ($sock, $msg,
 157                                        $bytes_to_write, $offset);
 158             if (!defined($bytes_written)) {
 159                 if (Msg::_err_will_block($!)) {
 160                     # Should happen only in deferred mode. Record how
 161                     # much we have already sent.
 162                     $send_offset = $offset;
 163                     # Event handler should already be set, so we will
 164                     # be called back eventually, and will resume sending
 165                     return 1;
 166                 } else {    # Uh, oh
 167                                         _error();
 168                     return 0; # fail. Message remains in queue ..
 169                 }
 170             }
 171                         if (isdbg('raw')) {
 172                                 dbgdump('raw', "AGW send $bytes_written: ", $msg);
 173                         }
 174             $offset         += $bytes_written;
 175             $bytes_to_write -= $bytes_written;
 176         }
 177         $send_offset = $offset = 0;
 178         shift @outqueue;
 179         last;  # Go back to select and wait
 180                        # for it to fire again.
 181     }
 182
 183     # Call me back if queue has not been drained.
 184     if (@outqueue) {
 185         Msg::set_event_handler ($sock, write => \&_send);
 186     } else {
 187         Msg::set_event_handler ($sock, write => undef);
 188     }
 189     1;  # Success
 190 }
 191
 192 sub _rcv {                     # Complement to _send
 193     return unless $sock;
 194     my ($msg, $offset, $bytes_read);
 195
 196         $bytes_read = sysread ($sock, $msg, 1024, 0);
 197         if (defined ($bytes_read)) {
 198                 if ($bytes_read > 0) {
 199                         $inmsg .= $msg;
 200                         if (isdbg('raw')) {
 201                                 dbgdump('raw', "AGW read $bytes_read: ", $msg);
 202                         }
 203                 }
 204         } else {
 205                 if (Msg::_err_will_block($!)) {
 206                         return;
 207                 } else {
 208                         $bytes_read = 0;
 209                 }
 210     }
 211
 212 FINISH:
 213     if (defined $bytes_read && $bytes_read == 0) {
 214                 finish();
 215     } else {
 216                 _decode() if length $inmsg >= 36;
 217         }
 218 }
 219
 220 sub _error
 221 {
 222         dbg("error on AGW connection $addr/$port $!");
 223         Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
 224         $sock = undef;
 225         for (%circuit) {
 226                 &{$_->{eproc}}() if $_->{eproc};
 227                 $_->disconnect;
 228         }
 229 }
 230
 231 sub _decode
 232 {
 233         return unless $sock;
 234
 235         # we have at least 36 bytes of data (ugh!)
 236         while (length $inmsg >= 36) {
 237                 my ($port, $sort, $pid, $from, $to, $len) = unpack('C x3 a1 x1 C x1 Z10 Z10 V x4', $inmsg);
 238                 my $data;
 239
 240                 # do a sanity check on the length
 241                 if ($len > 2000) {
 242                         dbg("AGW: invalid length $len > 2000 received ($sort $port $pid '$from'->'$to')");
 243                         finish();
 244                         return;
 245                 }
 246                 if ($len == 0){
 247                         if (length $inmsg > 36) {
 248                                 $inmsg = substr($inmsg, 36);
 249                         } else {
 250                                 $inmsg = '';
 251                         }
 252                 } elsif (length $inmsg > $len + 36) {
 253                         $data = substr($inmsg, 36, $len);
 254                         $inmsg = substr($inmsg, $len + 36);
 255                 } elsif (length $inmsg == $len + 36) {
 256                         $data = substr($inmsg, 36);
 257                         $inmsg = '';
 258                 } else {
 259                         #
 260                         # we don't have enough data or something
 261                         # or we have screwed up
 262                         #
 263                         return;
 264                 }
 265
 266                 $data = '' unless defined $data;
 267                 if ($sort eq 'D') {
 268                         my $d = unpack "Z*", $data;
 269                         $d =~ s/\cJ//g;         # remove all new line characters
 270                         $d =~ s/\cM$//;
 271                         dbg("AGW Data In port: $port pid: $pid '$from'->'$to' length: $len \"$d\"") if isdbg('agw');
 272                         my $conn = _find($from eq $main::mycall ? $to : $from);
 273                         if ($conn) {
 274                                 if ($conn->{state} eq 'WC') {
 275                                         if (exists $conn->{cmd}) {
 276                                                 if (@{$conn->{cmd}}) {
 277                                                         dbg($d) if isdbg('connect');
 278                                                         $conn->_docmd($d);
 279                                                 }
 280                                         }
 281                                         if ($conn->{state} eq 'WC' && exists $conn->{cmd} && @{$conn->{cmd}} == 0) {
 282                                                 $conn->to_connected($conn->{call}, 'O', $conn->{csort});
 283                                         }
 284                                 } else {
 285                                         my @lines = split /\cM/, $data;
 286                                         if (@lines) {
 287                                                 for (@lines) {
 288                                                         &{$conn->{rproc}}($conn, "I$conn->{call}|$_");
 289                                                 }
 290                                         } else {
 291                                                 &{$conn->{rproc}}($conn, "I$conn->{call}|");
 292                                         }
 293                                 }
 294                         } else {
 295                                 dbg("AGW error Unsolicited Data!");
 296                         }
 297                 } elsif ($sort eq 'I' || $sort eq 'S' || $sort eq 'U' || $sort eq 'M' || $sort eq 'T') {
 298                         my $d = unpack "Z*", $data;
 299                         $d =~ s/\cJ//g;         # remove all new line characters
 300                         $d =~ s/\cM$//;
 301                         my @lines = split /\cM/, $d;
 302
 303                         for (@lines) {
 304 #                               s/([\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 305                                 dbg("AGW Monitor port: $port \"$_\"") if isdbg('agw');
 306                         }
 307                 } elsif ($sort eq 'C') {
 308                         my $d = unpack "Z*", $data;
 309                         $d =~ s/\cM$//;
 310                         dbg("AGW Connect port: $port pid: $pid '$from'->'$to' \"$d\"") if isdbg('agw');
 311                         my $call = $from eq $main::mycall ? $to : $from;
 312                         my $conn = _find($call);
 313                         if ($conn) {
 314                                 if ($conn->{state} eq 'WC') {
 315                                         if (exists $conn->{cmd} && @{$conn->{cmd}}) {
 316                                                 $conn->_docmd($d);
 317                                                 if ($conn->{state} eq 'WC' && exists $conn->{cmd} &&  @{$conn->{cmd}} == 0) {
 318                                                         $conn->to_connected($conn->{call}, 'O', $conn->{csort});
 319                                                 }
 320                                         }
 321                                 }
 322                         } else {
 323                                 $conn = AGWMsg->new($rproc);
 324                                 $conn->{agwpid} = $pid;
 325                                 $conn->{agwport} = $port;
 326                                 $conn->{lineend} = "\cM";
 327                                 $conn->{incoming} = 1;
 328                                 $conn->{agwcall} = $call;
 329                                 $circuit{$call} = $conn;
 330                                 if ($call =~ /^(\w+)-(\d\d?)$/) {
 331                                         my $c = $1;
 332                                         my $s = $2;
 333                                         $s = 15 - $s;
 334                                         if ($s <= 8 && $s > 0) {
 335                                                 $call = "${c}-${s}";
 336                                         } else {
 337                                                 $call = $c;
 338                                         }
 339                                 }
 340                                 $conn->to_connected($call, 'A', $conn->{csort} = 'ax25');
 341                         }
 342                 } elsif ($sort eq 'd') {
 343                         my $d = unpack "Z*", $data;
 344                         $d =~ s/\cM$//;
 345                         dbg("AGW '$from'->'$to' port: $port Disconnected ($d)") if isdbg('agw');
 346                         my $conn = _find($from eq $main::mycall ? $to : $from);
 347                         if ($conn) {
 348                                 &{$conn->{eproc}}() if $conn->{eproc};
 349                                 $conn->in_disconnect;
 350                         }
 351                 } elsif ($sort eq 'y') {
 352                         my ($frames) = unpack "V", $data;
 353                         dbg("AGW Frames Outstanding on port $port = $frames") if isdbg('agwpollans');
 354                         my $conn = _find($from);
 355                         $conn->{oframes} = $frames if $conn;
 356                 } elsif ($sort eq 'Y') {
 357                         my ($frames) = unpack "V", $data;
 358                         dbg("AGW Frames Outstanding on circuit '$from'->'$to' = $frames") if isdbg('agw');
 359                         my $conn = _find($from eq $main::mycall ? $to : $from);
 360                         $conn->{oframes} = $frames if $conn;
 361                 } elsif ($sort eq 'H') {
 362                         unless ($from =~ /^\s+$/) {
 363                                 my $d = unpack "Z*", $data;
 364                                 $d =~ s/\cM$//;
 365                                 dbg("AGW Heard port: $port \"$d\"") if isdbg('agw');
 366                         }
 367                 } elsif ($sort eq 'X') {
 368                         my ($r) = unpack "C", $data;
 369                         $r = $r ? "Successful" : "Failed";
 370                         dbg("AGW Register $from $r");
 371                         finish() unless $r;
 372                 } elsif ($sort eq 'R') {
 373                         my ($major, $minor) = unpack "v x2 v x2", $data;
 374                         dbg("AGW Version $major.$minor") if isdbg('agw');
 375                 } elsif ($sort eq 'G') {
 376                         my @ports = split /;/, $data;
 377                         $noports = shift @ports || '0';
 378                         dbg("AGW $noports Ports available") if isdbg('agw');
 379                         pop @ports while @ports > $noports;
 380                         for (@ports) {
 381                                 next unless $_;
 382                                 dbg("AGW Port: $_") if isdbg('agw');
 383                         }
 384                         for (my $i = 0; $i < $noports; $i++) {
 385                                 _sendf('y', undef, undef, $i);
 386                                 _sendf('g', undef, undef, $i);
 387                         }
 388                 } else {
 389                         my $d = unpack "Z*", $data;
 390                         dbg("AGW decode $sort port: $port pid: $pid '$from'->'$to' length: $len \"$d\"") if isdbg('agw');
 391                 }
 392         }
 393 }
 394
 395 sub _find
 396 {
 397         my $call = shift;
 398         return $circuit{$call};
 399 }
 400
 401 sub connect
 402 {
 403         my ($conn, $line) = @_;
 404
 405         my ($port, $call) = split /\s+/, $line;
 406         $conn->{agwpid} = ord "\xF0";
 407         $conn->{agwport} = $port - 1;
 408         $conn->{lineend} = "\cM";
 409         $conn->{incoming} = 0;
 410         $conn->{csort} = 'ax25';
 411         $conn->{agwcall} = uc $call;
 412         $circuit{$conn->{agwcall}} = $conn;
 413
 414         _sendf('C', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
 415         $conn->{state} = 'WC';
 416
 417         return 1;
 418 }
 419
 420 sub in_disconnect
 421 {
 422         my $conn = shift;
 423         delete $circuit{$conn->{agwcall}};
 424         $conn->SUPER::disconnect;
 425 }
 426
 427 sub disconnect
 428 {
 429         my $conn = shift;
 430         delete $circuit{$conn->{agwcall}};
 431         if ($conn->{incoming}) {
 432                 _sendf('d', $conn->{agwcall}, $main::mycall, $conn->{agwport}, $conn->{agwpid});
 433         } else {
 434                 _sendf('d', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
 435         }
 436         $conn->SUPER::disconnect;
 437 }
 438
 439 sub enqueue
 440 {
 441         my ($conn, $msg) = @_;
 442         if ($msg =~ /^D/) {
 443                 $msg =~ s/^[-\w]+\|//;
 444 #               _sendf('Y', $main::mycall, $conn->{call}, $conn->{agwport}, $conn->{agwpid});
 445                 _sendf('D', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid}, $msg . $conn->{lineend});
 446                 my $len = length($msg) + 1;
 447                 dbg("AGW Data Out port: $conn->{agwport} pid: $conn->{agwpid} '$main::mycall'->'$conn->{agwcall}' length: $len \"$msg\"") if isdbg('agw');
 448         }
 449 }
 450
 451 sub process
 452 {
 453         return unless $sock;
 454         if ($ypolltime && $main::systime - $lastytime >= $ypolltime) {
 455                 for (my $i = 0; $i < $noports; $i++) {
 456                         _sendf('y', undef, undef, $i );
 457                 }
 458                 $lastytime = $main::systime;
 459         }
 460         if ($hpolltime && $main::systime - $lasthtime >= $hpolltime) {
 461                 for (my $i = 0; $i < $noports; $i++) {
 462                         _sendf('H', undef, undef, $i );
 463                 }
 464                 $lasthtime = $main::systime;
 465         }
 466 }
 467
 468 1;
 469