3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
31 use Time::HiRes qw(gettimeofday tv_interval);
34 use vars qw($me $pc11_max_age $pc23_max_age
35 $last_hour %pings %rcmds
36 %nodehops @baddx $baddxfn
37 $allowzero $decode_dk0wcy $send_opernam);
39 $me = undef; # the channel id for this cluster
40 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
41 $pc23_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc23
43 $last_hour = time; # last time I did an hourly periodic update
44 %pings = (); # outstanding ping requests outbound
45 %rcmds = (); # outstanding rcmd requests outbound
46 %nodehops = (); # node specific hop control
47 @baddx = (); # list of illegal spotted callsigns
50 $baddxfn = "$main::data/baddx.pl";
54 my $user = DXUser->get($main::mycall);
55 $DXProt::myprot_version += $main::version*100;
56 $me = DXProt->new($main::mycall, 0, $user);
58 $me->{state} = "indifferent";
59 do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
61 # $me->{sort} = 'M'; # M for me
63 # now prime the spot and wwv duplicates file with data
64 my @today = Julian::unixtoj(time);
65 for (Spot::readfile(@today), Spot::readfile(Julian::sub(@today, 1))) {
66 Spot::dup(@{$_}[0..3]);
68 for (Geomag::readfile(time)) {
69 Geomag::dup(@{$_}[1..5]);
73 do "$baddxfn" if -e "$baddxfn";
78 # obtain a new connection this is derived from dxchannel
83 my $self = DXChannel::alloc(@_);
87 # this is how a pc connection starts (for an incoming connection)
88 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
89 # all the crap that comes between).
92 my ($self, $line, $sort) = @_;
93 my $call = $self->{call};
94 my $user = $self->{user};
96 # remember type of connection
97 $self->{consort} = $line;
98 $self->{outbound} = $sort eq 'O';
99 $self->{priv} = $user->priv || 1; # other clusters can always be 'normal' users
100 $self->{lang} = $user->lang || 'en';
101 $self->{isolate} = $user->{isolate};
102 $self->{consort} = $line; # save the connection type
105 # get the INPUT filters (these only pertain to Clusters)
106 $self->{inspotfilter} = Filter::read_in('spots', $call, 1);
107 $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1);
108 $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1);
109 $self->{inannfilter} = Filter::read_in('ann', $call, 1);
111 # set unbuffered and no echo
112 $self->send_now('B',"0");
113 $self->send_now('E',"0");
115 # ping neighbour node stuff
116 my $ping = $user->pingint;
117 $ping = 5*60 unless defined $ping;
118 $self->{pingint} = $ping;
119 $self->{nopings} = $user->nopings || 2;
120 $self->{pingtime} = [ ];
121 $self->{pingave} = 0;
123 # send initialisation string
124 unless ($self->{outbound}) {
125 $self->send(pc38()) if DXNode->get_all();
127 $self->{lastping} = $main::systime;
129 # remove from outstanding connects queue
130 @main::outstanding_connects = grep {$_->{call} ne $call} @main::outstanding_connects;
131 $self->{lastping} = $main::systime + $self->pingint / 2;
133 $self->state('init');
136 # send info to all logged in thingies
137 $self->tell_login('loginn');
139 Log('DXProt', "$call connected");
143 # This is the normal pcxx despatcher
147 my ($self, $line) = @_;
148 my @field = split /\^/, $line;
149 pop @field if $field[-1] eq '~';
151 # print join(',', @field), "\n";
153 # ignore any lines that don't start with PC
154 return if !$field[0] =~ /^PC/;
157 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
159 return if $pcno < 10 || $pcno > 99;
161 # dump bad protocol messages
162 if ($line =~ /\%[01][0-9A-F]/) {
163 dbg('chan', "CORRUPT protocol message - dumped");
170 $pcr = Local::pcprot($self, $pcno, @field);
172 # dbg('local', "Local::pcprot error $@") if $@;
176 if ($pcno == 10) { # incoming talk
178 unless (is_callsign($field[1]) && is_callsign($field[2]) && is_callsign($field[6])) {
179 dbg('chan', "Corrupt talk, rejected");
182 # is it for me or one of mine?
183 my ($to, $via, $call, $dxchan);
184 if ($field[5] gt ' ') {
185 $call = $via = $field[2];
187 unless (is_callsign($to)) {
188 dbg('chan', "Corrupt talk, rejected");
192 $call = $to = $field[2];
194 if ($dxchan = DXChannel->get($call)) {
195 $dxchan->talk($field[1], $to, $via, $field[3]);
197 $self->route($field[2], $line); # relay it on its way
202 if ($pcno == 11 || $pcno == 26) { # dx spot
204 # are any of the callsign fields invalid?
205 unless ($field[2] !~ m/[^A-Z0-9\-\/]/ && is_callsign($field[6]) && is_callsign($field[7])) {
206 dbg('chan', "Spot contains lower case callsigns or blanks, rejected");
209 if ($field[1] =~ m/[^0-9\.]/) {
210 dbg('chan', "Spot frequency not numeric, rejected");
214 # route 'foreign' pc26s
216 if ($field[7] ne $main::mycall) {
217 $self->route($field[7], $line);
222 # if this is a 'nodx' node then ignore it
223 if (grep $field[7] =~ /^$_/, @DXProt::nodx_node) {
224 dbg('chan', "Bad DXNode, dropped");
228 # convert the date to a unix date
229 my $d = cltounix($field[3], $field[4]);
230 # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
231 if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
232 dbg('chan', "Spot ignored, invalid date or out of range ($field[3] $field[4])\n");
237 if (grep $field[2] eq $_, @baddx) {
238 dbg('chan', "Bad DX spot, ignored");
243 $field[5] =~ s/^\s+//; # take any leading blanks off
244 if (Spot::dup($field[1], $field[2], $d, $field[5])) {
245 dbg('chan', "Duplicate Spot ignored\n");
249 my @spot = Spot::add($field[1], $field[2], $d, $field[5], $field[6], $field[7]);
252 # @spot at this point contains:-
253 # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
254 # then spotted itu, spotted cq, spotters itu, spotters cq
255 # you should be able to route on any of these
258 # fix up qra locators of known users
259 my $user = DXUser->get_current($spot[4]);
261 my $qra = $user->qra;
262 unless ($qra && DXBearing::is_qra($qra)) {
263 my $lat = $user->lat;
264 my $long = $user->long;
265 if (defined $lat && defined $long) {
266 $user->qra(DXBearing::lltoqra($lat, $long));
271 # send a remote command to a distant cluster if it is visible and there is no
272 # qra locator and we havn't done it for a month.
274 unless ($user->qra) {
276 my $to = $user->homenode;
277 my $last = $user->lastoper || 0;
278 if ($send_opernam && $main::systime > $last + $DXUser::lastoperinterval && $to && ($node = DXCluster->get_exact($to)) ) {
279 my $cmd = "forward/opernam $spot[4]";
280 # send the rcmd but we aren't interested in the replies...
281 if ($node && $node->dxchan && $node->dxchan->is_clx) {
282 route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
284 route(undef, $to, pc34($main::mycall, $to, $cmd));
286 if ($to ne $field[7]) {
288 $node = DXCluster->get_exact($to);
289 if ($node && $node->dxchan && $node->dxchan->is_clx) {
290 route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
292 route(undef, $to, pc34($main::mycall, $to, $cmd));
295 $user->lastoper($main::systime);
304 $r = Local::spot($self, @spot);
306 # dbg('local', "Local::spot1 error $@") if $@;
309 # DON'T be silly and send on PC26s!
310 return if $pcno == 26;
312 # send out the filtered spots
313 send_dx_spot($self, $line, @spot) if @spot;
317 if ($pcno == 12) { # announces
318 unless (is_callsign($field[1]) && is_callsign($field[5])) {
319 dbg('chan', "Corrupt announce, rejected");
323 # announce duplicate checking
324 $field[3] =~ s/^\s+//; # remove leading blanks
325 if (AnnTalk::dup($field[1], $field[2], $field[3])) {
326 dbg('chan', "Duplicate Announce ignored\n");
330 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
332 # global ann filtering on INPUT
333 if ($self->{inannfilter}) {
334 my ($filter, $hops) = Filter::it($self->{inannfilter}, @field[1..6], $self->{call} );
336 dbg('chan', "Rejected by filter");
342 $self->send_announce($line, @field[1..6]);
344 $self->route($field[2], $line);
360 if ($pcno == 16) { # add a user
361 my $node = DXCluster->get_exact($field[1]);
363 if (!$node && ($dxchan = DXChannel->get($field[1]))) {
364 # add it to the node table if it isn't present and it's
366 $node = DXNode->new($dxchan, $field[1], 0, 1, 5400);
367 broadcast_ak1a(pc19($dxchan, $node), $dxchan, $self) unless $dxchan->{isolate};
370 return unless $node; # ignore if havn't seen a PC19 for this one yet
371 return unless $node->isa('DXNode');
372 if ($node->dxchan != $self) {
373 dbg('chan', "LOOP: $field[1] came in on wrong channel");
376 if (($dxchan = DXChannel->get($field[1])) && $dxchan != $self) {
377 dbg('chan', "LOOP: $field[1] connected locally");
382 for ($i = 2; $i < $#field; $i++) {
383 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
384 next if !$call || length $call < 3 || length $call > 8;
387 next if DXCluster->get_exact($call); # we already have this (loop?)
389 $confmode = $confmode eq '*';
390 DXNodeuser->new($self, $node, $call, $confmode, $here);
392 # add this station to the user database, if required
393 $call =~ s/-\d+$//o; # remove ssid for users
394 my $user = DXUser->get_current($call);
395 $user = DXUser->new($call) if !$user;
396 $user->homenode($node->call) if !$user->homenode;
397 $user->node($node->call);
398 $user->lastin($main::systime) unless DXChannel->get($call);
402 # queue up any messages (look for privates only)
403 DXMsg::queue_msg(1) if $self->state eq 'normal';
407 if ($pcno == 17) { # remove a user
408 my $node = DXCluster->get_exact($field[2]);
410 if (!$node && ($dxchan = DXChannel->get($field[2]))) {
411 # add it to the node table if it isn't present and it's
413 $node = DXNode->new($dxchan, $field[2], 0, 1, 5400);
414 broadcast_ak1a(pc19($dxchan, $node), $dxchan, $self) unless $dxchan->{isolate};
418 return unless $node->isa('DXNode');
419 if ($node->dxchan != $self) {
420 dbg('chan', "LOOP: $field[2] came in on wrong channel");
423 if (($dxchan = DXChannel->get($field[2])) && $dxchan != $self) {
424 dbg('chan', "LOOP: $field[2] connected locally");
427 my $ref = DXCluster->get_exact($field[1]);
432 if ($pcno == 18) { # link request
433 $self->state('init');
435 # first clear out any nodes on this dxchannel
436 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
437 foreach my $node (@gonenodes) {
438 next if $node->dxchan == $DXProt::me;
439 broadcast_ak1a(pc21($node->call, 'Gone, re-init') , $self) unless $self->{isolate};
442 $self->send_local_config();
444 return; # we don't pass these on
447 if ($pcno == 19) { # incoming cluster list
449 my $newline = "PC19^";
450 for ($i = 1; $i < $#field-1; $i += 4) {
451 my $here = $field[$i];
452 my $call = uc $field[$i+1];
453 my $confmode = $field[$i+2];
454 my $ver = $field[$i+3];
456 $ver = 5400 if !$ver && $allowzero;
458 # now check the call over
459 my $node = DXCluster->get_exact($call);
462 if (($dxchan = DXChannel->get($call)) && $dxchan != $self) {
463 dbg('chan', "LOOP: $call connected locally");
465 if ($node->dxchan != $self) {
466 dbg('chan', "LOOP: $call come in on wrong channel");
469 dbg('chan', "already have $call");
473 # check for sane parameters
474 next if $ver < 5000; # only works with version 5 software
475 next if length $call < 3; # min 3 letter callsigns
477 # add it to the nodes table and outgoing line
478 $newline .= "$here^$call^$confmode^$ver^";
479 DXNode->new($self, $call, $confmode, $here, $ver);
481 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
482 my $mref = DXMsg::get_busy($call);
483 $mref->stop_msg($call) if $mref;
485 # add this station to the user database, if required (don't remove SSID from nodes)
486 my $user = DXUser->get_current($call);
488 $user = DXUser->new($call);
490 $user->priv(1); # I have relented and defaulted nodes
491 $self->{priv} = 1; # to user RCMDs allowed
492 $user->homenode($call);
495 $user->lastin($main::systime) unless DXChannel->get($call);
499 return if $newline eq "PC19^";
502 $newline .= get_hops(19) . "^";
507 if ($pcno == 20) { # send local configuration
508 $self->send_local_config();
510 $self->state('normal');
514 if ($pcno == 21) { # delete a cluster from the list
515 my $call = uc $field[1];
516 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
517 my $node = DXCluster->get_exact($call);
519 if ($node->dxchan != $self) {
520 dbg('chan', "LOOP: $call come in on wrong channel");
524 if (($dxchan = DXChannel->get($call)) && $dxchan != $self) {
525 dbg('chan', "LOOP: $call connected locally");
530 dbg('chan', "$call not in table, dropped");
538 $self->state('normal');
542 if ($pcno == 23 || $pcno == 27) { # WWV info
544 # route 'foreign' pc27s
546 if ($field[8] ne $main::mycall) {
547 $self->route($field[8], $line);
553 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
554 my $sfi = unpad($field[3]);
555 my $k = unpad($field[4]);
556 my $i = unpad($field[5]);
557 my ($r) = $field[6] =~ /R=(\d+)/;
559 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
560 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
563 if (Geomag::dup($d,$sfi,$k,$i,$field[6])) {
564 dbg('chan', "Dup WWV Spot ignored\n");
567 $field[7] =~ s/-\d+$//o; # remove spotter's ssid
569 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..8], $r);
573 $rep = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..8], $r);
575 # dbg('local', "Local::wwv2 error $@") if $@;
578 # DON'T be silly and send on PC27s!
579 return if $pcno == 27;
581 # broadcast to the eager world
582 send_wwv_spot($self, $line, $d, $field[2], $sfi, $k, $i, @field[6..8]);
586 if ($pcno == 24) { # set here status
587 my $call = uc $field[1];
588 my $ref = DXCluster->get_exact($call);
589 $ref->here($field[2]) if $ref;
593 if ($pcno == 25) { # merge request
594 if ($field[1] ne $main::mycall) {
595 $self->route($field[1], $line);
598 if ($field[2] eq $main::mycall) {
599 dbg('chan', "Trying to merge to myself, ignored");
603 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
607 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]);
610 $self->send(pc26(@{$in}[0..4], $field[2]));
616 my @in = reverse Geomag::search(0, $field[4], time, 1);
619 $self->send(pc27(@{$in}[0..5], $field[2]));
625 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
626 if ($pcno == 49 || $field[1] eq $main::mycall) {
627 DXMsg::process($self, $line);
629 $self->route($field[1], $line);
634 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
635 if ($field[1] eq $main::mycall) {
636 my $ref = DXUser->get_current($field[2]);
637 my $cref = DXCluster->get($field[2]);
638 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
639 unless (!$cref || !$ref || $cref->mynode->call ne $ref->homenode) { # not allowed to relay RCMDS!
640 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
641 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
642 my $oldpriv = $self->{priv};
643 $self->{priv} = $ref->{priv}; # assume the user's privilege level
644 my @in = (DXCommandmode::run_cmd($self, $field[3]));
645 $self->{priv} = $oldpriv;
648 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
649 Log('rcmd', 'out', $field[2], $_);
651 delete $self->{remotecmd};
653 $self->send(pc35($main::mycall, $field[2], "$main::mycall:sorry...!"));
656 $self->send(pc35($main::mycall, $field[2], "$main::mycall:your attempt is logged, Tut tut tut...!"));
659 my $ref = DXUser->get_current($field[1]);
660 if ($ref && $ref->is_clx) {
661 route($field[1], pc84($field[2], $field[1], $field[2], $field[3]));
663 $self->route($field[1], $line);
669 if ($pcno == 35) { # remote command replies
670 if ($field[1] eq $main::mycall) {
671 my $s = $rcmds{$field[2]};
673 my $dxchan = DXChannel->get($s->{call});
674 $dxchan->send($field[3]) if $dxchan;
675 delete $rcmds{$field[2]} if !$dxchan;
677 # send unsolicited ones to the sysop
678 my $dxchan = DXChannel->get($main::myalias);
679 $dxchan->send($field[3]) if $dxchan;
682 my $ref = DXUser->get_current($field[1]);
683 if ($ref && $ref->is_clx) {
684 route($field[1], pc85($field[2], $field[1], $field[2], $field[3]));
686 $self->route($field[1], $line);
692 # for pc 37 see 44 onwards
694 if ($pcno == 38) { # node connected list from neighbour
698 if ($pcno == 39) { # incoming disconnect
699 $self->disconnect(1);
703 if ($pcno == 41) { # user info
704 # add this station to the user database, if required
705 my $user = DXUser->get_current($field[1]);
707 # then try without an SSID
708 $field[1] =~ s/-\d+$//o;
709 $user = DXUser->get_current($field[1]);
711 $user = DXUser->new($field[1]) if !$user;
713 if ($field[2] == 1) {
714 $user->name($field[3]);
715 } elsif ($field[2] == 2) {
716 $user->qth($field[3]);
717 } elsif ($field[2] == 3) {
718 my ($lat, $long) = DXBearing::stoll($field[3]);
721 $user->qra(DXBearing::lltoqra($lat, $long)) unless $user->qra && DXBearing::is_qra($user->qra);
722 } elsif ($field[2] == 4) {
723 $user->homenode($field[3]);
725 $user->lastoper($main::systime); # to cut down on excessive for/opers being generated
732 if ($pcno == 37 || $pcno == 44 || $pcno == 45 || $pcno == 46 || $pcno == 47 || $pcno == 48) {
733 DXDb::process($self, $line);
737 if ($pcno == 50) { # keep alive/user list
738 my $node = DXCluster->get_exact($field[1]);
740 return unless $node->isa('DXNode');
741 return unless $node->dxchan == $self;
742 $node->update_users($field[2]);
747 if ($pcno == 51) { # incoming ping requests/answers
750 if ($field[1] eq $main::mycall) {
751 my $flag = $field[3];
753 $self->send(pc51($field[2], $field[1], '0'));
755 # it's a reply, look in the ping list for this one
756 my $ref = $pings{$field[2]};
758 my $tochan = DXChannel->get($field[2]);
761 my $dxchan = DXChannel->get($r->{call});
763 my $t = tv_interval($r->{t}, [ gettimeofday ]);
764 if ($dxchan->is_user) {
765 my $s = sprintf "%.2f", $t;
766 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
767 $dxchan->send($dxchan->msg('pingi', $field[2], $s, $ave))
768 } elsif ($dxchan->is_node) {
770 $tochan->{nopings} = 2; # pump up the timer
771 push @{$tochan->{pingtime}}, $t;
772 shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
774 for (@{$tochan->{pingtime}}) {
777 $tochan->{pingave} = $st / @{$tochan->{pingtime}};
784 # route down an appropriate thingy
785 $self->route($field[1], $line);
790 if ($pcno == 73) { # WCY broadcasts
793 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
794 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
795 dbg('chan', "WCY Date ($field[1] $field[2]) out of range");
798 @field = map { unpad($_) } @field;
799 if (WCY::dup($d,@field[3..7])) {
800 dbg('chan', "Dup WCY Spot ignored\n");
804 my $wcy = WCY::update($d, @field[2..12]);
808 $rep = Local::wwv($self, @field[1..12]);
810 # dbg('local', "Local::wcy error $@") if $@;
813 # broadcast to the eager world
814 send_wcy_spot($self, $line, $d, @field[2..12]);
818 if ($pcno == 84) { # remote commands (incoming)
819 if ($field[1] eq $main::mycall) {
820 my $ref = DXUser->get_current($field[2]);
821 my $cref = DXCluster->get($field[2]);
822 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[4]);
823 unless ($field[4] =~ /rcmd/i || !$cref || !$ref || $cref->mynode->call ne $ref->homenode) { # not allowed to relay RCMDS!
824 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
825 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
826 my $oldpriv = $self->{priv};
827 $self->{priv} = $ref->{priv}; # assume the user's privilege level
828 my @in = (DXCommandmode::run_cmd($self, $field[4]));
829 $self->{priv} = $oldpriv;
832 $self->send(pc85($main::mycall, $field[2], $field[3], "$main::mycall:$_"));
833 Log('rcmd', 'out', $field[2], $_);
835 delete $self->{remotecmd};
837 $self->send(pc85($main::mycall, $field[2], $field[3], "$main::mycall:sorry...!"));
840 $self->send(pc85($main::mycall, $field[2], $field[3],"$main::mycall:your attempt is logged, Tut tut tut...!"));
843 my $ref = DXUser->get_current($field[1]);
844 if ($ref && $ref->is_clx) {
845 $self->route($field[1], $line);
847 route($field[1], pc34($field[2], $field[1], $field[4]));
853 if ($pcno == 85) { # remote command replies
854 if ($field[1] eq $main::mycall) {
855 my $dxchan = DXChannel->get($field[3]);
857 $dxchan->send($field[4]);
859 my $s = $rcmds{$field[2]};
861 $dxchan = DXChannel->get($s->{call});
862 $dxchan->send($field[4]) if $dxchan;
863 delete $rcmds{$field[2]} if !$dxchan;
865 # send unsolicited ones to the sysop
866 my $dxchan = DXChannel->get($main::myalias);
867 $dxchan->send($field[4]) if $dxchan;
871 my $ref = DXUser->get_current($field[1]);
872 if ($ref && $ref->is_clx) {
873 $self->route($field[1], $line);
875 route($field[1], pc35($field[2], $field[1], $field[4]));
882 # if get here then rebroadcast the thing with its Hop count decremented (if
883 # there is one). If it has a hop count and it decrements to zero then don't
886 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
890 unless ($self->{isolate}) {
891 broadcast_ak1a($line, $self); # send it to everyone but me
896 # This is called from inside the main cluster processing loop and is used
897 # for despatching commands that are doing some long processing job
902 my @dxchan = DXChannel->get_all();
905 foreach $dxchan (@dxchan) {
906 next unless $dxchan->is_node();
907 next if $dxchan == $me;
909 # send a pc50 out on this channel
910 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
911 $dxchan->send(pc50(scalar DXChannel::get_all_users));
915 # send a ping out on this channel
916 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
917 if ($dxchan->{nopings} <= 0) {
920 addping($main::mycall, $dxchan->call);
921 $dxchan->{nopings} -= 1;
922 $dxchan->{lastping} = $t;
930 if ($main::systime - 3600 > $last_hour) {
934 $last_hour = $main::systime;
939 # finish up a pc context
944 my $call = $self->call;
946 my $ref = DXCluster->get_exact($call);
948 # unbusy and stop and outgoing mail
949 my $mref = DXMsg::get_busy($call);
950 $mref->stop_msg($call) if $mref;
952 # broadcast to all other nodes that all the nodes connected to via me are gone
953 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
956 foreach $node (@gonenodes) {
957 next if $node->call eq $call;
958 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
962 # remove outstanding pings
963 delete $pings{$call};
965 # now broadcast to all other ak1a nodes that I have gone
966 broadcast_ak1a(pc21($call, 'Gone.'), $self) unless $self->{isolate};
968 # I was the last node visited
969 $self->user->node($main::mycall);
971 # send info to all logged in thingies
972 $self->tell_login('logoutn');
974 Log('DXProt', $call . " Disconnected");
979 # some active measures
985 my @dxchan = DXChannel->get_all();
988 # send it if it isn't the except list and isn't isolated and still has a hop count
989 # taking into account filtering and so on
990 foreach $dxchan (@dxchan) {
994 if ($dxchan->{spotfilter}) {
995 ($filter, $hops) = Filter::it($dxchan->{spotfilter}, @_, $self->{call} );
999 if ($dxchan->is_node) {
1000 next if $dxchan == $self;
1003 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1005 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1006 next unless $routeit;
1009 $dxchan->send($routeit) if $routeit;
1011 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1013 } elsif ($dxchan->is_user && $dxchan->{dx}) {
1014 my $buf = Spot::formatb($dxchan->{user}->wantgrid, $_[0], $_[1], $_[2], $_[3], $_[4]);
1015 $buf .= "\a\a" if $dxchan->{beep};
1016 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1017 $dxchan->send($buf);
1019 $dxchan->delay($buf);
1029 my @dxchan = DXChannel->get_all();
1032 # send it if it isn't the except list and isn't isolated and still has a hop count
1033 # taking into account filtering and so on
1034 foreach $dxchan (@dxchan) {
1036 my ($filter, $hops);
1038 if ($dxchan->{wwvfilter}) {
1039 ($filter, $hops) = Filter::it($dxchan->{wwvfilter}, @_, $self->{call} );
1040 next unless $filter;
1042 if ($dxchan->is_node) {
1043 next if $dxchan == $self;
1046 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1048 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1049 next unless $routeit;
1052 $dxchan->send($routeit) if $routeit;
1054 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1057 } elsif ($dxchan->is_user && $dxchan->{wwv}) {
1058 my $buf = "WWV de $_[6] <$_[1]>: SFI=$_[2], A=$_[3], K=$_[4], $_[5]";
1059 $buf .= "\a\a" if $dxchan->{beep};
1060 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1061 $dxchan->send($buf);
1063 $dxchan->delay($buf);
1073 my @dxchan = DXChannel->get_all();
1076 # send it if it isn't the except list and isn't isolated and still has a hop count
1077 # taking into account filtering and so on
1078 foreach $dxchan (@dxchan) {
1080 my ($filter, $hops);
1082 if ($dxchan->{wcyfilter}) {
1083 ($filter, $hops) = Filter::it($dxchan->{wcyfilter}, @_, $self->{call} );
1084 next unless $filter;
1086 if ($dxchan->is_clx || $dxchan->is_spider) {
1087 next if $dxchan == $self;
1090 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1092 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1093 next unless $routeit;
1096 $dxchan->send($routeit) if $routeit;
1098 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1100 } elsif ($dxchan->is_user && $dxchan->{wcy}) {
1101 my $buf = "WCY de $_[10] <$_[1]> : K=$_[4] expK=$_[5] A=$_[3] R=$_[6] SFI=$_[2] SA=$_[7] GMF=$_[8] Au=$_[9]";
1102 $buf .= "\a\a" if $dxchan->{beep};
1103 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1104 $dxchan->send($buf);
1106 $dxchan->delay($buf);
1117 my @dxchan = DXChannel->get_all();
1119 my $text = unpad($_[2]);
1123 if ($_[3] eq '*') { # sysops
1125 } elsif ($_[3] gt ' ') { # speciality list handling
1126 my ($name) = split /\./, $_[3];
1127 $target = "$name"; # put the rest in later (if bothered)
1134 $target = "All" if !$target;
1136 Log('ann', $target, $_[0], $text);
1138 # send it if it isn't the except list and isn't isolated and still has a hop count
1139 # taking into account filtering and so on
1140 foreach $dxchan (@dxchan) {
1142 my ($filter, $hops);
1144 if ($dxchan->{annfilter}) {
1145 ($filter, $hops) = Filter::it($dxchan->{annfilter}, @_, $self->{call} );
1146 next unless $filter;
1148 if ($dxchan->is_node && $_[1] ne $main::mycall) { # i.e not specifically routed to me
1149 next if $dxchan == $self;
1152 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1154 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1155 next unless $routeit;
1158 $dxchan->send($routeit) if $routeit;
1160 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1163 } elsif ($dxchan->is_user && $dxchan->{ann}) {
1164 next if $target eq 'SYSOP' && $dxchan->{priv} < 5;
1165 my $buf = "$to$target de $_[0]: $text";
1166 $buf .= "\a\a" if $dxchan->{beep};
1167 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1168 $dxchan->send($buf);
1170 $dxchan->delay($buf);
1176 sub send_local_config
1185 if ($self->{isolate}) {
1186 @localnodes = (DXCluster->get_exact($main::mycall));
1188 # create a list of all the nodes that are not connected to this connection
1189 # and are not themselves isolated, this to make sure that isolated nodes
1190 # don't appear outside of this node
1191 @nodes = DXNode::get_all();
1192 @nodes = grep { $_->{call} ne $main::mycall } @nodes;
1193 @nodes = grep { $_->dxchan != $self } @nodes if @nodes;
1194 @nodes = grep { !$_->dxchan->{isolate} } @nodes if @nodes;
1195 @localnodes = grep { $_->dxchan->{call} eq $_->{call} } @nodes if @nodes;
1196 unshift @localnodes, DXCluster->get_exact($main::mycall);
1197 @remotenodes = grep { $_->dxchan->{call} ne $_->{call} } @nodes if @nodes;
1200 my @s = $me->pc19(@localnodes, @remotenodes);
1202 my $routeit = adjust_hops($self, $_);
1203 $self->send($routeit) if $routeit;
1206 # get all the users connected on the above nodes and send them out
1207 foreach $n (@localnodes, @remotenodes) {
1208 my @users = values %{$n->list};
1209 my @s = pc16($n, @users);
1211 my $routeit = adjust_hops($self, $_);
1212 $self->send($routeit) if $routeit;
1218 # route a message down an appropriate interface for a callsign
1220 # is called route(to, pcline);
1224 my ($self, $call, $line) = @_;
1225 my $cl = DXCluster->get_exact($call);
1226 if ($cl) { # don't route it back down itself
1227 if (ref $self && $call eq $self->{call}) {
1228 dbg('chan', "Trying to route back to source, dropped");
1232 my $dxchan = $cl->{dxchan};
1234 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1236 $dxchan->send($routeit) if $dxchan;
1242 # broadcast a message to all clusters taking into account isolation
1243 # [except those mentioned after buffer]
1246 my $s = shift; # the line to be rebroadcast
1247 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1248 my @dxchan = DXChannel::get_all_ak1a();
1251 # send it if it isn't the except list and isn't isolated and still has a hop count
1252 foreach $dxchan (@dxchan) {
1253 next if grep $dxchan == $_, @except;
1254 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1255 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
1259 # broadcast a message to all clusters ignoring isolation
1260 # [except those mentioned after buffer]
1261 sub broadcast_all_ak1a
1263 my $s = shift; # the line to be rebroadcast
1264 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1265 my @dxchan = DXChannel::get_all_ak1a();
1268 # send it if it isn't the except list and isn't isolated and still has a hop count
1269 foreach $dxchan (@dxchan) {
1270 next if grep $dxchan == $_, @except;
1271 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1272 $dxchan->send($routeit);
1276 # broadcast to all users
1277 # storing the spot or whatever until it is in a state to receive it
1280 my $s = shift; # the line to be rebroadcast
1281 my $sort = shift; # the type of transmission
1282 my $fref = shift; # a reference to an object to filter on
1283 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1284 my @dxchan = DXChannel::get_all_users();
1288 foreach $dxchan (@dxchan) {
1289 next if grep $dxchan == $_, @except;
1292 broadcast_list($s, $sort, $fref, @out);
1295 # broadcast to a list of users
1303 foreach $dxchan (@_) {
1306 if ($sort eq 'dx') {
1307 next unless $dxchan->{dx};
1308 ($filter) = Filter::it($dxchan->{spotfilter}, @{$fref}) if ref $fref;
1309 next unless $filter;
1311 next if $sort eq 'ann' && !$dxchan->{ann};
1312 next if $sort eq 'wwv' && !$dxchan->{wwv};
1313 next if $sort eq 'wcy' && !$dxchan->{wcy};
1314 next if $sort eq 'wx' && !$dxchan->{wx};
1316 $s =~ s/\a//og unless $dxchan->{beep};
1318 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1328 # obtain the hops from the list for this callsign and pc no
1334 my $hops = $DXProt::hopcount{$pcno};
1335 $hops = $DXProt::def_hopcount if !$hops;
1340 # adjust the hop count on a per node basis using the user loadable
1341 # hop table if available or else decrement an existing one
1348 my $call = $self->{call};
1351 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
1352 my ($pcno) = $s =~ /^PC(\d\d)/o;
1353 confess "$call called adjust_hops with '$s'" unless $pcno;
1354 my $ref = $nodehops{$call} if %nodehops;
1356 my $newhops = $ref->{$pcno};
1357 return "" if defined $newhops && $newhops == 0;
1358 $newhops = $ref->{default} unless $newhops;
1359 return "" if defined $newhops && $newhops == 0;
1360 $newhops = $hops if !$newhops;
1361 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
1363 # simply decrement it
1365 return "" if !$hops;
1366 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1378 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1379 do "$main::data/hop_table.pl";
1385 # add a ping request to the ping queues
1388 my ($from, $to) = @_;
1389 my $ref = $pings{$to} || [];
1392 $r->{t} = [ gettimeofday ];
1393 route(undef, $to, pc51($to, $main::mycall, 1));
1398 # add a rcmd request to the rcmd queues
1401 my ($self, $to, $cmd) = @_;
1404 $r->{call} = $self->{call};
1405 $r->{t} = $main::systime;
1409 my $ref = DXCluster->get_exact($to);
1410 if ($ref && $ref->dxchan && $ref->dxchan->is_clx) {
1411 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1413 route(undef, $to, pc34($main::mycall, $to, $cmd));
1422 if ($self->{conn} && !$nopc39) {
1423 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1426 $self->SUPER::disconnect;
1429 # check that a field only has callsign characters in it
1432 return $_[0] !~ /[^A-Z0-9\-]/
1436 # send a talk message to this thingy
1440 my ($self, $from, $to, $via, $line) = @_;
1442 $line =~ s/\^/\\5E/g; # remove any ^ characters
1443 $self->send(DXProt::pc10($from, $to, $via, $line));
1444 Log('talk', $self->call, $from, $via?$via:$main::mycall, $line);