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 unless it is a PC29
162 if ($line =~ /\%[0-9A-F][0-9A-F]/o && $pcno != 29) {
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 # is it for me or one of mine?
179 my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
180 if ($call eq $main::mycall || grep $_ eq $call, DXChannel::get_all_user_calls()) {
183 my $text = unpad($field[3]);
184 Log('talk', $call, $field[1], $field[6], $text);
185 $call = $main::myalias if $call eq $main::mycall;
186 my $ref = DXChannel->get($call);
187 $ref->send("$call de $field[1]: $text") if $ref && $ref->{talk};
189 $self->route($field[2], $line); # relay it on its way
194 if ($pcno == 11 || $pcno == 26) { # dx spot
196 # route 'foreign' pc26s
198 if ($field[7] ne $main::mycall) {
199 $self->route($field[7], $line);
204 # if this is a 'nodx' node then ignore it
205 if (grep $field[7] =~ /^$_/, @DXProt::nodx_node) {
206 dbg('chan', "Bad DXNode, dropped");
210 # convert the date to a unix date
211 my $d = cltounix($field[3], $field[4]);
212 # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
213 if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
214 dbg('chan', "Spot ignored, invalid date or out of range ($field[3] $field[4])\n");
219 if (grep $field[2] eq $_, @baddx) {
220 dbg('chan', "Bad DX spot, ignored");
224 # are any of the callsign fields invalid?
225 if ($field[2] =~ m/[^A-Z0-9\-\/]/ || $field[6] =~ m/[^A-Z0-9\-]/ || $field[7] =~ m/[^A-Z0-9\-]/) {
226 dbg('chan', "Spot contains lower case callsigns or blanks, rejected");
229 if ($field[1] =~ m/[^0-9\.]/) {
230 dbg('chan', "Spot frequency not numeric, rejected");
235 $field[5] =~ s/^\s+//; # take any leading blanks off
236 if (Spot::dup($field[1], $field[2], $d, $field[5])) {
237 dbg('chan', "Duplicate Spot ignored\n");
241 my @spot = Spot::add($field[1], $field[2], $d, $field[5], $field[6], $field[7]);
244 # @spot at this point contains:-
245 # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
246 # then spotted itu, spotted cq, spotters itu, spotters cq
247 # you should be able to route on any of these
250 # fix up qra locators of known users
251 my $user = DXUser->get_current($spot[4]);
253 my $qra = $user->qra;
254 unless ($qra && DXBearing::is_qra($qra)) {
255 my $lat = $user->lat;
256 my $long = $user->long;
257 if (defined $lat && defined $long) {
258 $user->qra(DXBearing::lltoqra($lat, $long));
263 # send a remote command to a distant cluster if it is visible and there is no
264 # qra locator and we havn't done it for a month.
266 unless ($user->qra) {
268 my $to = $user->homenode;
269 my $last = $user->lastoper || 0;
270 if ($send_opernam && $main::systime > $last + $DXUser::lastoperinterval && $to && ($node = DXCluster->get_exact($to)) ) {
271 my $cmd = "forward/opernam $spot[4]";
272 # send the rcmd but we aren't interested in the replies...
273 if ($node && $node->dxchan && $node->dxchan->is_clx) {
274 route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
276 route(undef, $to, pc34($main::mycall, $to, $cmd));
278 if ($to ne $field[7]) {
280 $node = DXCluster->get_exact($to);
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));
287 $user->lastoper($main::systime);
296 $r = Local::spot($self, @spot);
298 # dbg('local', "Local::spot1 error $@") if $@;
301 # DON'T be silly and send on PC26s!
302 return if $pcno == 26;
304 # send out the filtered spots
305 send_dx_spot($self, $line, @spot) if @spot;
309 if ($pcno == 12) { # announces
310 # announce duplicate checking
311 $field[3] =~ s/^\s+//; # remove leading blanks
312 if (AnnTalk::dup($field[1], $field[2], $field[3])) {
313 dbg('chan', "Duplicate Announce ignored\n");
317 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
319 # global ann filtering on INPUT
320 if ($self->{inannfilter}) {
321 my ($filter, $hops) = Filter::it($self->{inannfilter}, @field[1..6], $self->{call} );
323 dbg('chan', "Rejected by filter");
329 $self->send_announce($line, @field[1..6]);
331 $self->route($field[2], $line);
347 if ($pcno == 16) { # add a user
348 my $node = DXCluster->get_exact($field[1]);
350 if (!$node && ($dxchan = DXChannel->get($field[1]))) {
351 # add it to the node table if it isn't present and it's
353 $node = DXNode->new($dxchan, $field[1], 0, 1, 5400);
354 broadcast_ak1a(pc19($dxchan, $node), $dxchan, $self) unless $dxchan->{isolate};
357 return unless $node; # ignore if havn't seen a PC19 for this one yet
358 return unless $node->isa('DXNode');
359 if ($node->dxchan != $self) {
360 dbg('chan', "LOOP: $field[1] came in on wrong channel");
363 if (($dxchan = DXChannel->get($field[1])) && $dxchan != $self) {
364 dbg('chan', "LOOP: $field[1] connected locally");
369 for ($i = 2; $i < $#field; $i++) {
370 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
371 next if !$call || length $call < 3 || length $call > 8;
374 next if DXCluster->get_exact($call); # we already have this (loop?)
376 $confmode = $confmode eq '*';
377 DXNodeuser->new($self, $node, $call, $confmode, $here);
379 # add this station to the user database, if required
380 $call =~ s/-\d+$//o; # remove ssid for users
381 my $user = DXUser->get_current($call);
382 $user = DXUser->new($call) if !$user;
383 $user->homenode($node->call) if !$user->homenode;
384 $user->node($node->call);
385 $user->lastin($main::systime) unless DXChannel->get($call);
389 # queue up any messages (look for privates only)
390 DXMsg::queue_msg(1) if $self->state eq 'normal';
394 if ($pcno == 17) { # remove a user
395 my $node = DXCluster->get_exact($field[2]);
397 if (!$node && ($dxchan = DXChannel->get($field[2]))) {
398 # add it to the node table if it isn't present and it's
400 $node = DXNode->new($dxchan, $field[2], 0, 1, 5400);
401 broadcast_ak1a(pc19($dxchan, $node), $dxchan, $self) unless $dxchan->{isolate};
405 return unless $node->isa('DXNode');
406 if ($node->dxchan != $self) {
407 dbg('chan', "LOOP: $field[2] came in on wrong channel");
410 if (($dxchan = DXChannel->get($field[2])) && $dxchan != $self) {
411 dbg('chan', "LOOP: $field[2] connected locally");
414 my $ref = DXCluster->get_exact($field[1]);
419 if ($pcno == 18) { # link request
420 $self->state('init');
422 # first clear out any nodes on this dxchannel
423 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
424 foreach my $node (@gonenodes) {
425 next if $node->dxchan == $DXProt::me;
426 broadcast_ak1a(pc21($node->call, 'Gone, re-init') , $self) unless $self->{isolate};
429 $self->send_local_config();
431 return; # we don't pass these on
434 if ($pcno == 19) { # incoming cluster list
436 my $newline = "PC19^";
437 for ($i = 1; $i < $#field-1; $i += 4) {
438 my $here = $field[$i];
439 my $call = uc $field[$i+1];
440 my $confmode = $field[$i+2];
441 my $ver = $field[$i+3];
443 $ver = 5400 if !$ver && $allowzero;
445 # now check the call over
446 my $node = DXCluster->get_exact($call);
449 if (($dxchan = DXChannel->get($call)) && $dxchan != $self) {
450 dbg('chan', "LOOP: $call connected locally");
452 if ($node->dxchan != $self) {
453 dbg('chan', "LOOP: $call come in on wrong channel");
456 dbg('chan', "already have $call");
460 # check for sane parameters
461 next if $ver < 5000; # only works with version 5 software
462 next if length $call < 3; # min 3 letter callsigns
464 # add it to the nodes table and outgoing line
465 $newline .= "$here^$call^$confmode^$ver^";
466 DXNode->new($self, $call, $confmode, $here, $ver);
468 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
469 my $mref = DXMsg::get_busy($call);
470 $mref->stop_msg($call) if $mref;
472 # add this station to the user database, if required (don't remove SSID from nodes)
473 my $user = DXUser->get_current($call);
475 $user = DXUser->new($call);
477 $user->priv(1); # I have relented and defaulted nodes
478 $self->{priv} = 1; # to user RCMDs allowed
479 $user->homenode($call);
482 $user->lastin($main::systime) unless DXChannel->get($call);
486 return if $newline eq "PC19^";
489 $newline .= get_hops(19) . "^";
494 if ($pcno == 20) { # send local configuration
495 $self->send_local_config();
497 $self->state('normal');
501 if ($pcno == 21) { # delete a cluster from the list
502 my $call = uc $field[1];
503 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
504 my $node = DXCluster->get_exact($call);
506 if ($node->dxchan != $self) {
507 dbg('chan', "LOOP: $call come in on wrong channel");
511 if (($dxchan = DXChannel->get($call)) && $dxchan != $self) {
512 dbg('chan', "LOOP: $call connected locally");
517 dbg('chan', "$call not in table, dropped");
525 $self->state('normal');
529 if ($pcno == 23 || $pcno == 27) { # WWV info
531 # route 'foreign' pc27s
533 if ($field[8] ne $main::mycall) {
534 $self->route($field[8], $line);
540 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
541 my $sfi = unpad($field[3]);
542 my $k = unpad($field[4]);
543 my $i = unpad($field[5]);
544 my ($r) = $field[6] =~ /R=(\d+)/;
546 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
547 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
550 if (Geomag::dup($d,$sfi,$k,$i,$field[6])) {
551 dbg('chan', "Dup WWV Spot ignored\n");
554 $field[7] =~ s/-\d+$//o; # remove spotter's ssid
556 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..8], $r);
560 $rep = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..8], $r);
562 # dbg('local', "Local::wwv2 error $@") if $@;
565 # DON'T be silly and send on PC27s!
566 return if $pcno == 27;
568 # broadcast to the eager world
569 send_wwv_spot($self, $line, $d, $field[2], $sfi, $k, $i, @field[6..8]);
573 if ($pcno == 24) { # set here status
574 my $call = uc $field[1];
575 my $ref = DXCluster->get_exact($call);
576 $ref->here($field[2]) if $ref;
580 if ($pcno == 25) { # merge request
581 if ($field[1] ne $main::mycall) {
582 $self->route($field[1], $line);
585 if ($field[2] eq $main::mycall) {
586 dbg('chan', "Trying to merge to myself, ignored");
590 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
594 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]);
597 $self->send(pc26(@{$in}[0..4], $field[2]));
603 my @in = reverse Geomag::search(0, $field[4], time, 1);
606 $self->send(pc27(@{$in}[0..5], $field[2]));
612 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
613 if ($pcno == 49 || $field[1] eq $main::mycall) {
614 DXMsg::process($self, $line);
616 $self->route($field[1], $line);
621 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
622 if ($field[1] eq $main::mycall) {
623 my $ref = DXUser->get_current($field[2]);
624 my $cref = DXCluster->get($field[2]);
625 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
626 unless (!$cref || !$ref || $cref->mynode->call ne $ref->homenode) { # not allowed to relay RCMDS!
627 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
628 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
629 my $oldpriv = $self->{priv};
630 $self->{priv} = $ref->{priv}; # assume the user's privilege level
631 my @in = (DXCommandmode::run_cmd($self, $field[3]));
632 $self->{priv} = $oldpriv;
635 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
636 Log('rcmd', 'out', $field[2], $_);
638 delete $self->{remotecmd};
640 $self->send(pc35($main::mycall, $field[2], "$main::mycall:sorry...!"));
643 $self->send(pc35($main::mycall, $field[2], "$main::mycall:your attempt is logged, Tut tut tut...!"));
646 my $ref = DXUser->get_current($field[1]);
647 if ($ref && $ref->is_clx) {
648 route($field[1], pc84($field[2], $field[1], $field[2], $field[3]));
650 $self->route($field[1], $line);
656 if ($pcno == 35) { # remote command replies
657 if ($field[1] eq $main::mycall) {
658 my $s = $rcmds{$field[2]};
660 my $dxchan = DXChannel->get($s->{call});
661 $dxchan->send($field[3]) if $dxchan;
662 delete $rcmds{$field[2]} if !$dxchan;
664 # send unsolicited ones to the sysop
665 my $dxchan = DXChannel->get($main::myalias);
666 $dxchan->send($field[3]) if $dxchan;
669 my $ref = DXUser->get_current($field[1]);
670 if ($ref && $ref->is_clx) {
671 route($field[1], pc85($field[2], $field[1], $field[2], $field[3]));
673 $self->route($field[1], $line);
679 # for pc 37 see 44 onwards
681 if ($pcno == 38) { # node connected list from neighbour
685 if ($pcno == 39) { # incoming disconnect
686 $self->disconnect(1);
690 if ($pcno == 41) { # user info
691 # add this station to the user database, if required
692 my $user = DXUser->get_current($field[1]);
694 # then try without an SSID
695 $field[1] =~ s/-\d+$//o;
696 $user = DXUser->get_current($field[1]);
698 $user = DXUser->new($field[1]) if !$user;
700 if ($field[2] == 1) {
701 $user->name($field[3]);
702 } elsif ($field[2] == 2) {
703 $user->qth($field[3]);
704 } elsif ($field[2] == 3) {
705 my ($lat, $long) = DXBearing::stoll($field[3]);
708 $user->qra(DXBearing::lltoqra($lat, $long)) unless $user->qra && DXBearing::is_qra($user->qra);
709 } elsif ($field[2] == 4) {
710 $user->homenode($field[3]);
712 $user->lastoper($main::systime); # to cut down on excessive for/opers being generated
719 if ($pcno == 37 || $pcno == 44 || $pcno == 45 || $pcno == 46 || $pcno == 47 || $pcno == 48) {
720 DXDb::process($self, $line);
724 if ($pcno == 50) { # keep alive/user list
725 my $node = DXCluster->get_exact($field[1]);
727 return unless $node->isa('DXNode');
728 return unless $node->dxchan == $self;
729 $node->update_users($field[2]);
734 if ($pcno == 51) { # incoming ping requests/answers
737 if ($field[1] eq $main::mycall) {
738 my $flag = $field[3];
740 $self->send(pc51($field[2], $field[1], '0'));
742 # it's a reply, look in the ping list for this one
743 my $ref = $pings{$field[2]};
745 my $tochan = DXChannel->get($field[2]);
748 my $dxchan = DXChannel->get($r->{call});
750 my $t = tv_interval($r->{t}, [ gettimeofday ]);
751 if ($dxchan->is_user) {
752 my $s = sprintf "%.2f", $t;
753 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
754 $dxchan->send($dxchan->msg('pingi', $field[2], $s, $ave))
755 } elsif ($dxchan->is_node) {
757 $tochan->{nopings} = 2; # pump up the timer
758 push @{$tochan->{pingtime}}, $t;
759 shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
761 for (@{$tochan->{pingtime}}) {
764 $tochan->{pingave} = $st / @{$tochan->{pingtime}};
771 # route down an appropriate thingy
772 $self->route($field[1], $line);
777 if ($pcno == 73) { # WCY broadcasts
780 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
781 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
782 dbg('chan', "WCY Date ($field[1] $field[2]) out of range");
785 @field = map { unpad($_) } @field;
786 if (WCY::dup($d,@field[3..7])) {
787 dbg('chan', "Dup WCY Spot ignored\n");
791 my $wcy = WCY::update($d, @field[2..12]);
795 $rep = Local::wwv($self, @field[1..12]);
797 # dbg('local', "Local::wcy error $@") if $@;
800 # broadcast to the eager world
801 send_wcy_spot($self, $line, $d, @field[2..12]);
805 if ($pcno == 84) { # remote commands (incoming)
806 if ($field[1] eq $main::mycall) {
807 my $ref = DXUser->get_current($field[2]);
808 my $cref = DXCluster->get($field[2]);
809 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[4]);
810 unless ($field[4] =~ /rcmd/i || !$cref || !$ref || $cref->mynode->call ne $ref->homenode) { # not allowed to relay RCMDS!
811 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
812 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
813 my $oldpriv = $self->{priv};
814 $self->{priv} = $ref->{priv}; # assume the user's privilege level
815 my @in = (DXCommandmode::run_cmd($self, $field[4]));
816 $self->{priv} = $oldpriv;
819 $self->send(pc85($main::mycall, $field[2], $field[3], "$main::mycall:$_"));
820 Log('rcmd', 'out', $field[2], $_);
822 delete $self->{remotecmd};
824 $self->send(pc85($main::mycall, $field[2], $field[3], "$main::mycall:sorry...!"));
827 $self->send(pc85($main::mycall, $field[2], $field[3],"$main::mycall:your attempt is logged, Tut tut tut...!"));
830 my $ref = DXUser->get_current($field[1]);
831 if ($ref && $ref->is_clx) {
832 $self->route($field[1], $line);
834 route($field[1], pc34($field[2], $field[1], $field[4]));
840 if ($pcno == 85) { # remote command replies
841 if ($field[1] eq $main::mycall) {
842 my $dxchan = DXChannel->get($field[3]);
844 $dxchan->send($field[4]);
846 my $s = $rcmds{$field[2]};
848 $dxchan = DXChannel->get($s->{call});
849 $dxchan->send($field[4]) if $dxchan;
850 delete $rcmds{$field[2]} if !$dxchan;
852 # send unsolicited ones to the sysop
853 my $dxchan = DXChannel->get($main::myalias);
854 $dxchan->send($field[4]) if $dxchan;
858 my $ref = DXUser->get_current($field[1]);
859 if ($ref && $ref->is_clx) {
860 $self->route($field[1], $line);
862 route($field[1], pc35($field[2], $field[1], $field[4]));
869 # if get here then rebroadcast the thing with its Hop count decremented (if
870 # there is one). If it has a hop count and it decrements to zero then don't
873 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
877 unless ($self->{isolate}) {
878 broadcast_ak1a($line, $self); # send it to everyone but me
883 # This is called from inside the main cluster processing loop and is used
884 # for despatching commands that are doing some long processing job
889 my @dxchan = DXChannel->get_all();
892 foreach $dxchan (@dxchan) {
893 next unless $dxchan->is_node();
894 next if $dxchan == $me;
896 # send a pc50 out on this channel
897 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
898 $dxchan->send(pc50(scalar DXChannel::get_all_users));
902 # send a ping out on this channel
903 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
904 if ($dxchan->{nopings} <= 0) {
907 addping($main::mycall, $dxchan->call);
908 $dxchan->{nopings} -= 1;
909 $dxchan->{lastping} = $t;
917 if ($main::systime - 3600 > $last_hour) {
921 $last_hour = $main::systime;
926 # finish up a pc context
931 my $call = $self->call;
933 my $ref = DXCluster->get_exact($call);
935 # unbusy and stop and outgoing mail
936 my $mref = DXMsg::get_busy($call);
937 $mref->stop_msg($call) if $mref;
939 # broadcast to all other nodes that all the nodes connected to via me are gone
940 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
943 foreach $node (@gonenodes) {
944 next if $node->call eq $call;
945 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
949 # remove outstanding pings
950 delete $pings{$call};
952 # now broadcast to all other ak1a nodes that I have gone
953 broadcast_ak1a(pc21($call, 'Gone.'), $self) unless $self->{isolate};
955 # I was the last node visited
956 $self->user->node($main::mycall);
958 # send info to all logged in thingies
959 $self->tell_login('logoutn');
961 Log('DXProt', $call . " Disconnected");
966 # some active measures
972 my @dxchan = DXChannel->get_all();
975 # send it if it isn't the except list and isn't isolated and still has a hop count
976 # taking into account filtering and so on
977 foreach $dxchan (@dxchan) {
981 if ($dxchan->{spotfilter}) {
982 ($filter, $hops) = Filter::it($dxchan->{spotfilter}, @_, $self->{call} );
986 if ($dxchan->is_node) {
987 next if $dxchan == $self;
990 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
992 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
993 next unless $routeit;
996 $dxchan->send($routeit) if $routeit;
998 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1000 } elsif ($dxchan->is_user && $dxchan->{dx}) {
1001 my $buf = Spot::formatb($dxchan->{user}->wantgrid, $_[0], $_[1], $_[2], $_[3], $_[4]);
1002 $buf .= "\a\a" if $dxchan->{beep};
1003 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1004 $dxchan->send($buf);
1006 $dxchan->delay($buf);
1016 my @dxchan = DXChannel->get_all();
1019 # send it if it isn't the except list and isn't isolated and still has a hop count
1020 # taking into account filtering and so on
1021 foreach $dxchan (@dxchan) {
1023 my ($filter, $hops);
1025 if ($dxchan->{wwvfilter}) {
1026 ($filter, $hops) = Filter::it($dxchan->{wwvfilter}, @_, $self->{call} );
1027 next unless $filter;
1029 if ($dxchan->is_node) {
1030 next if $dxchan == $self;
1033 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1035 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1036 next unless $routeit;
1039 $dxchan->send($routeit) if $routeit;
1041 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1044 } elsif ($dxchan->is_user && $dxchan->{wwv}) {
1045 my $buf = "WWV de $_[6] <$_[1]>: SFI=$_[2], A=$_[3], K=$_[4], $_[5]";
1046 $buf .= "\a\a" if $dxchan->{beep};
1047 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1048 $dxchan->send($buf);
1050 $dxchan->delay($buf);
1060 my @dxchan = DXChannel->get_all();
1063 # send it if it isn't the except list and isn't isolated and still has a hop count
1064 # taking into account filtering and so on
1065 foreach $dxchan (@dxchan) {
1067 my ($filter, $hops);
1069 if ($dxchan->{wcyfilter}) {
1070 ($filter, $hops) = Filter::it($dxchan->{wcyfilter}, @_, $self->{call} );
1071 next unless $filter;
1073 if ($dxchan->is_clx || $dxchan->is_spider) {
1074 next if $dxchan == $self;
1077 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1079 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1080 next unless $routeit;
1083 $dxchan->send($routeit) if $routeit;
1085 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1087 } elsif ($dxchan->is_user && $dxchan->{wcy}) {
1088 my $buf = "WCY de $_[10] <$_[1]> : K=$_[4] expK=$_[5] A=$_[3] R=$_[6] SFI=$_[2] SA=$_[7] GMF=$_[8] Au=$_[9]";
1089 $buf .= "\a\a" if $dxchan->{beep};
1090 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1091 $dxchan->send($buf);
1093 $dxchan->delay($buf);
1104 my @dxchan = DXChannel->get_all();
1106 my $text = unpad($_[2]);
1110 if ($_[3] eq '*') { # sysops
1112 } elsif ($_[3] gt ' ') { # speciality list handling
1113 my ($name) = split /\./, $_[3];
1114 $target = "$name"; # put the rest in later (if bothered)
1121 $target = "All" if !$target;
1123 Log('ann', $target, $_[0], $text);
1125 # send it if it isn't the except list and isn't isolated and still has a hop count
1126 # taking into account filtering and so on
1127 foreach $dxchan (@dxchan) {
1129 my ($filter, $hops);
1131 if ($dxchan->{annfilter}) {
1132 ($filter, $hops) = Filter::it($dxchan->{annfilter}, @_, $self->{call} );
1133 next unless $filter;
1135 if ($dxchan->is_node && $_[1] ne $main::mycall) { # i.e not specifically routed to me
1136 next if $dxchan == $self;
1139 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1141 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1142 next unless $routeit;
1145 $dxchan->send($routeit) if $routeit;
1147 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1150 } elsif ($dxchan->is_user && $dxchan->{ann}) {
1151 next if $target eq 'SYSOP' && $dxchan->{priv} < 5;
1152 my $buf = "$to$target de $_[0]: $text";
1153 $buf .= "\a\a" if $dxchan->{beep};
1154 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1155 $dxchan->send($buf);
1157 $dxchan->delay($buf);
1163 sub send_local_config
1172 if ($self->{isolate}) {
1173 @localnodes = (DXCluster->get_exact($main::mycall));
1175 # create a list of all the nodes that are not connected to this connection
1176 # and are not themselves isolated, this to make sure that isolated nodes
1177 # don't appear outside of this node
1178 @nodes = DXNode::get_all();
1179 @nodes = grep { $_->{call} ne $main::mycall } @nodes;
1180 @nodes = grep { $_->dxchan != $self } @nodes if @nodes;
1181 @nodes = grep { !$_->dxchan->{isolate} } @nodes if @nodes;
1182 @localnodes = grep { $_->dxchan->{call} eq $_->{call} } @nodes if @nodes;
1183 unshift @localnodes, DXCluster->get_exact($main::mycall);
1184 @remotenodes = grep { $_->dxchan->{call} ne $_->{call} } @nodes if @nodes;
1187 my @s = $me->pc19(@localnodes, @remotenodes);
1189 my $routeit = adjust_hops($self, $_);
1190 $self->send($routeit) if $routeit;
1193 # get all the users connected on the above nodes and send them out
1194 foreach $n (@localnodes, @remotenodes) {
1195 my @users = values %{$n->list};
1196 my @s = pc16($n, @users);
1198 my $routeit = adjust_hops($self, $_);
1199 $self->send($routeit) if $routeit;
1205 # route a message down an appropriate interface for a callsign
1207 # is called route(to, pcline);
1211 my ($self, $call, $line) = @_;
1212 my $cl = DXCluster->get_exact($call);
1213 if ($cl) { # don't route it back down itself
1214 if (ref $self && $call eq $self->{call}) {
1215 dbg('chan', "Trying to route back to source, dropped");
1219 my $dxchan = $cl->{dxchan};
1221 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1223 $dxchan->send($routeit) if $dxchan;
1229 # broadcast a message to all clusters taking into account isolation
1230 # [except those mentioned after buffer]
1233 my $s = shift; # the line to be rebroadcast
1234 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1235 my @dxchan = DXChannel::get_all_ak1a();
1238 # send it if it isn't the except list and isn't isolated and still has a hop count
1239 foreach $dxchan (@dxchan) {
1240 next if grep $dxchan == $_, @except;
1241 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1242 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
1246 # broadcast a message to all clusters ignoring isolation
1247 # [except those mentioned after buffer]
1248 sub broadcast_all_ak1a
1250 my $s = shift; # the line to be rebroadcast
1251 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1252 my @dxchan = DXChannel::get_all_ak1a();
1255 # send it if it isn't the except list and isn't isolated and still has a hop count
1256 foreach $dxchan (@dxchan) {
1257 next if grep $dxchan == $_, @except;
1258 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1259 $dxchan->send($routeit);
1263 # broadcast to all users
1264 # storing the spot or whatever until it is in a state to receive it
1267 my $s = shift; # the line to be rebroadcast
1268 my $sort = shift; # the type of transmission
1269 my $fref = shift; # a reference to an object to filter on
1270 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1271 my @dxchan = DXChannel::get_all_users();
1275 foreach $dxchan (@dxchan) {
1276 next if grep $dxchan == $_, @except;
1279 broadcast_list($s, $sort, $fref, @out);
1282 # broadcast to a list of users
1290 foreach $dxchan (@_) {
1293 if ($sort eq 'dx') {
1294 next unless $dxchan->{dx};
1295 ($filter) = Filter::it($dxchan->{spotfilter}, @{$fref}) if ref $fref;
1296 next unless $filter;
1298 next if $sort eq 'ann' && !$dxchan->{ann};
1299 next if $sort eq 'wwv' && !$dxchan->{wwv};
1300 next if $sort eq 'wcy' && !$dxchan->{wcy};
1301 next if $sort eq 'wx' && !$dxchan->{wx};
1303 $s =~ s/\a//og unless $dxchan->{beep};
1305 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1315 # obtain the hops from the list for this callsign and pc no
1321 my $hops = $DXProt::hopcount{$pcno};
1322 $hops = $DXProt::def_hopcount if !$hops;
1327 # adjust the hop count on a per node basis using the user loadable
1328 # hop table if available or else decrement an existing one
1335 my $call = $self->{call};
1338 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
1339 my ($pcno) = $s =~ /^PC(\d\d)/o;
1340 confess "$call called adjust_hops with '$s'" unless $pcno;
1341 my $ref = $nodehops{$call} if %nodehops;
1343 my $newhops = $ref->{$pcno};
1344 return "" if defined $newhops && $newhops == 0;
1345 $newhops = $ref->{default} unless $newhops;
1346 return "" if defined $newhops && $newhops == 0;
1347 $newhops = $hops if !$newhops;
1348 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
1350 # simply decrement it
1352 return "" if !$hops;
1353 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1365 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1366 do "$main::data/hop_table.pl";
1372 # add a ping request to the ping queues
1375 my ($from, $to) = @_;
1376 my $ref = $pings{$to} || [];
1379 $r->{t} = [ gettimeofday ];
1380 route(undef, $to, pc51($to, $main::mycall, 1));
1385 # add a rcmd request to the rcmd queues
1388 my ($self, $to, $cmd) = @_;
1391 $r->{call} = $self->{call};
1392 $r->{t} = $main::systime;
1396 my $ref = DXCluster->get_exact($to);
1397 if ($ref && $ref->dxchan && $ref->dxchan->is_clx) {
1398 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1400 route(undef, $to, pc34($main::mycall, $to, $cmd));
1409 if ($self->{conn} && !$nopc39) {
1410 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1413 $self->SUPER::disconnect;
1417 # send a talk message to this thingy
1421 my ($self, $from, $to, $via, $line) = @_;
1423 $line =~ s/\^/\\5E/g; # remove any ^ characters
1424 $self->send(DXProt::pc10($from, $to, $via, $line));
1425 Log('talk', $self->call, $from, $via?$via:$main::mycall, $line);