]> scm.dxcluster.org Git - spider.git/blob - perl/AGWMsg.pm
41f23702abd7ab5b79ea6fcd1fa82012867c89ca
[spider.git] / 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 sub init
48 {
49         return unless $enable;
50         $rproc = shift;
51         
52         finish();
53         dbg('err', "AGW initialising and connecting to $addr/$port ...");
54         $sock = IO::Socket::INET->new(PeerAddr => $addr, PeerPort => $port, Proto=>'tcp', Timeout=>15);
55         unless ($sock) {
56                 dbg('err', "Cannot connect to AGW Engine at $addr/$port $!");
57                 return;
58         }
59         Msg::blocking($sock, 0);
60         Msg::set_event_handler($sock, read=>\&_rcv, error=>\&_error);
61         
62         # send a P frame for the login if required
63         if ($login) {
64                 my $data = pack "a255 a255", $login, $passwd;
65                 _sendf('P', undef, undef, undef, undef, $data);
66         }
67
68         # send:
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
73         _sendf('R');
74         _sendf('G');
75         _sendf('X', $main::mycall);
76         _sendf('m') if $monitor;
77 }
78
79 my $finishing = 0;
80
81 sub finish
82 {
83         return if $finishing;
84         if ($sock) {
85                 $finishing = 1;
86                 dbg('err', "AGW ending...");
87                 for (values %circuit) {
88                         &{$_->{eproc}}() if $_->{eproc};
89                         $_->disconnect;
90                 }
91                 # say we are going
92                 _sendf('m') if $monitor;
93                 _sendf('x', $main::mycall);
94                 Msg->sleep(2);
95                 Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
96                 $sock->close;
97         }
98 }
99
100 sub _sendf
101 {
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 || '';
108         my $len  = 0;
109         
110         $len = length $data; 
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') {
114                 if (isdbg('agw')) {
115                         my $d = $data;
116                         $d =~ s/\cM$//;
117                         dbg('agw', "AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$d\"");
118                 }
119         } else {
120                 dbg('agw', "AGW sendf: $sort '${from}'->'${to}' port: $port pid: $pid \"$data\"");
121         }
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);
124 }
125
126 sub _send 
127 {
128     return unless $sock;
129
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.
135
136     my $offset = $send_offset;
137
138     while (@outqueue) {
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
154                     return 1;
155                 } else {    # Uh, oh
156                                         _error();
157                     return 0; # fail. Message remains in queue ..
158                 }
159             }
160                         if (isdbg('raw')) {
161                                 dbgdump('raw', "send $bytes_written: ", $msg);
162                         }
163             $offset         += $bytes_written;
164             $bytes_to_write -= $bytes_written;
165         }
166         $send_offset = $offset = 0;
167         shift @outqueue;
168         last;  # Go back to select and wait
169                        # for it to fire again.
170     }
171
172     # Call me back if queue has not been drained.
173     if (@outqueue) {
174         Msg::set_event_handler ($sock, write => \&_send);
175     } else {
176         Msg::set_event_handler ($sock, write => undef);
177     }
178     1;  # Success
179 }
180
181 sub _rcv {                     # Complement to _send
182     return unless $sock;
183     my ($msg, $offset, $bytes_read);
184
185         $bytes_read = sysread ($sock, $msg, 1024, 0);
186         if (defined ($bytes_read)) {
187                 if ($bytes_read > 0) {
188                         $inmsg .= $msg;
189                         if (isdbg('raw')) {
190                                 dbgdump('raw', "read $bytes_read: ", $msg);
191                         }
192                 } 
193         } else {
194                 if (Msg::_err_will_block($!)) {
195                         return; 
196                 } else {
197                         $bytes_read = 0;
198                 }
199     }
200
201 FINISH:
202     if (defined $bytes_read && $bytes_read == 0) {
203                 finish();
204     } else {
205                 _decode() if length $inmsg >= 36;
206         }
207 }
208
209 sub _error
210 {
211         dbg('agw', "error on AGW connection $addr/$port $!");
212         Msg::set_event_handler($sock, read=>undef, write=>undef, error=>undef);
213         $sock = undef;
214         for (%circuit) {
215                 &{$_->{eproc}}() if $_->{eproc};
216                 $_->disconnect;
217         }
218 }
219
220 sub _decode
221 {
222         return unless $sock;
223
224         # we have at least 36 bytes of data (ugh!)
225         my ($port, $sort, $pid, $from, $to, $len) = unpack('C x3 a1 x1 C x1 Z10 Z10 V x4', $inmsg);
226         my $data;
227
228         # do a sanity check on the length
229         if ($len > 2000) {
230                 dbg('err', "AGW: invalid length $len > 2000 received ($sort $port $pid '$from'->'$to')");
231                 finish();
232                 return;
233         }
234         if ($len == 0){
235                 if (length $inmsg > 36) {
236                         $inmsg = substr($inmsg, 36);
237                 } else {
238                         $inmsg = '';
239                 }
240         } elsif (length $inmsg > $len + 36) {
241                 $data = substr($inmsg, 36, $len);
242                 $inmsg = substr($inmsg, $len + 36);
243         } elsif (length $inmsg == $len + 36) {
244                 $data = substr($inmsg, 36);
245                 $inmsg = '';
246         } else {
247                 # we don't have enough data or something
248                 # or we have screwed up
249                 return;
250         }
251
252         $data = '' unless defined $data;
253         if ($sort eq 'D') {
254                 my $d = unpack "Z*", $data;
255                 $d =~ s/\cM$//;
256                 dbg('agw', "AGW Data In port: $port pid: $pid '$from'->'$to' length: $len \"$d\"");
257                 my $conn = _find($from eq $main::mycall ? $to : $from);
258                 if ($conn) {
259                         if ($conn->{state} eq 'WC') {
260                                 if (exists $conn->{cmd}) {
261                                         if (@{$conn->{cmd}}) {
262                                                 dbg('connect', $d);
263                                                 $conn->_docmd($d);
264                                         }
265                                 }
266                                 if ($conn->{state} eq 'WC' && exists $conn->{cmd} && @{$conn->{cmd}} == 0) {
267                                         $conn->to_connected($conn->{call}, 'O', $conn->{csort});
268                                 }
269                         } else {
270                                 my @lines = split /\cM/, $data;
271                                 if (@lines) {
272                                         for (@lines) {
273                                                 &{$conn->{rproc}}($conn, "I$conn->{call}|$_");
274                                         }
275                                 } else {
276                                         &{$conn->{rproc}}($conn, "I$conn->{call}|");
277                                 }
278                         }
279                 } else {
280                         dbg('err', "AGW error Unsolicited Data!");
281                 }
282         } elsif ($sort eq 'I' || $sort eq 'S' || $sort eq 'U' || $sort eq 'M' || $sort eq 'T') {
283                 my $d = unpack "Z*", $data;
284                 $d =~ s/\cM$//;
285                 my @lines = split /\cM/, $d;
286
287                 for (@lines) {
288                         s/([\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
289                         dbg('agw', "AGW Monitor port: $port \"$_\"");
290                 }
291         } elsif ($sort eq 'C') {
292                 my $d = unpack "Z*", $data;
293                 $d =~ s/\cM$//;
294                 dbg('agw', "AGW Connect port: $port pid: $pid '$from'->'$to' \"$d\"");
295                 my $call = $from eq $main::mycall ? $to : $from;
296                 my $conn = _find($call);
297                 if ($conn) {
298                         if ($conn->{state} eq 'WC') {
299                                 if (exists $conn->{cmd} && @{$conn->{cmd}}) {
300                                         $conn->_docmd($d);
301                                         if ($conn->{state} eq 'WC' && exists $conn->{cmd} &&  @{$conn->{cmd}} == 0) {
302                                                 $conn->to_connected($conn->{call}, 'O', $conn->{csort});
303                                         }
304                                 }
305                         }
306                 } else {
307                         $conn = AGWMsg->new($rproc);
308                         $conn->{agwpid} = $pid;
309                         $conn->{agwport} = $port;
310                         $conn->{lineend} = "\cM";
311                         $conn->{incoming} = 1;
312                         $conn->{agwcall} = $call;
313                         $circuit{$call} = $conn;
314                         if ($call =~ /^(\w+)-(\d\d?)$/) {
315                                 my $c = $1;
316                                 my $s = $2;
317                                 $s = 15 - $s;
318                                 if ($s <= 8 && $s > 0) {
319                                         $call = "${c}-${s}";
320                                 } else {
321                                         $call = $c;
322                                 }
323                         }
324                         $conn->to_connected($call, 'A', $conn->{csort} = 'ax25');
325                 }
326         } elsif ($sort eq 'd') {
327                 dbg('agw', "AGW '$from'->'$to' port: $port Disconnected");
328                 my $conn = _find($from eq $main::mycall ? $to : $from);
329                 if ($conn) {
330                         &{$conn->{eproc}}() if $conn->{eproc};
331                         $conn->in_disconnect;
332                 }
333         } elsif ($sort eq 'y') {
334                 my ($frames) = unpack "V", $data;
335                 dbg('agwpollans', "AGW Frames Outstanding on port $port = $frames");
336                 my $conn = _find($from);
337                 $conn->{oframes} = $frames if $conn;
338         } elsif ($sort eq 'Y') {
339                 my ($frames) = unpack "V", $data;
340                 dbg('agw', "AGW Frames Outstanding on circuit '$from'->'$to' = $frames");
341                 my $conn = _find($from eq $main::mycall ? $to : $from);
342                 $conn->{oframes} = $frames if $conn;
343         } elsif ($sort eq 'H') {
344                 unless ($from =~ /^\s+$/) {
345                         my $d = unpack "Z*", $data;
346                         $d =~ s/\cM$//;
347                         dbg('agw', "AGW Heard port: $port \"$d\"");
348                 }
349         } elsif ($sort eq 'X') {
350                 my ($r) = unpack "C", $data;
351                 $r = $r ? "Successful" : "Failed";
352                 dbg('err', "AGW Register $from $r");
353                 finish() unless $r;
354         } elsif ($sort eq 'R') {
355                 my ($major, $minor) = unpack "v x2 v x2", $data;
356                 dbg('agw', "AGW Version $major.$minor");
357         } elsif ($sort eq 'G') {
358                 my @ports = split /;/, $data;
359             $noports = shift @ports || '0';
360                 dbg('agw', "AGW $noports Ports available");
361                 pop @ports while @ports > $noports;
362                 for (@ports) {
363                         next unless $_;
364                         dbg('agw', "AGW Port: $_");
365                 }
366                 for (my $i = 0; $i < $noports; $i++) {
367                         _sendf('y', undef, undef, $i);
368                         _sendf('g', undef, undef, $i);
369                 }
370         } else {
371                 my $d = unpack "Z*", $data;
372                 dbg('agw', "AGW decode $sort port: $port pid: $pid '$from'->'$to' length: $len \"$d\"");
373         }
374 }
375
376 sub _find
377 {
378         my $call = shift;
379         return $circuit{$call};
380 }
381
382 sub connect
383 {
384         my ($conn, $line) = @_;
385
386         my ($port, $call) = split /\s+/, $line;
387         $conn->{agwpid} = ord "\xF0";
388         $conn->{agwport} = $port - 1;
389         $conn->{lineend} = "\cM";
390         $conn->{incoming} = 0;
391         $conn->{csort} = 'ax25';
392         $conn->{agwcall} = uc $call;
393         $circuit{$conn->{agwcall}} = $conn; 
394         
395         _sendf('C', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
396         $conn->{state} = 'WC';
397         
398         return 1;
399 }
400
401 sub in_disconnect
402 {
403         my $conn = shift;
404         delete $circuit{$conn->{agwcall}}; 
405         $conn->SUPER::disconnect;
406 }
407
408 sub disconnect
409 {
410         my $conn = shift;
411         delete $circuit{$conn->{agwcall}}; 
412         if ($conn->{incoming}) {
413                 _sendf('d', $conn->{agwcall}, $main::mycall, $conn->{agwport}, $conn->{agwpid});
414         } else {
415                 _sendf('d', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid});
416         }
417         $conn->SUPER::disconnect;
418 }
419
420 sub enqueue
421 {
422         my ($conn, $msg) = @_;
423         if ($msg =~ /^D/) {
424                 $msg =~ s/^[-\w]+\|//;
425 #               _sendf('Y', $main::mycall, $conn->{call}, $conn->{agwport}, $conn->{agwpid});
426                 _sendf('D', $main::mycall, $conn->{agwcall}, $conn->{agwport}, $conn->{agwpid}, $msg . $conn->{lineend});
427                 my $len = length($msg) + 1; 
428                 dbg('agw', "AGW Data Out port: $conn->{agwport} pid: $conn->{agwpid} '$main::mycall'->'$conn->{agwcall}' length: $len \"$msg\"");
429         }
430 }
431
432 sub process
433 {
434         return unless $sock;
435         if ($ypolltime && $main::systime - $lastytime >= $ypolltime) {
436                 for (my $i = 0; $i < $noports; $i++) {
437                         _sendf('y', undef, undef, $i );
438                 }
439                 $lastytime = $main::systime;
440         }
441         if ($hpolltime && $main::systime - $lasthtime >= $hpolltime) {
442                 for (my $i = 0; $i < $noports; $i++) {
443                         _sendf('H', undef, undef, $i );
444                 }
445                 $lasthtime = $main::systime;
446         }
447 }
448
449 1;
450