3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
30 use Time::HiRes qw(gettimeofday tv_interval);
37 use vars qw($me $pc11_max_age $pc23_max_age
38 $last_hour $last10 %eph %pings %rcmds
39 %nodehops $baddx $badspotter $badnode $censorpc
40 $allowzero $decode_dk0wcy $send_opernam @checklist);
42 $me = undef; # the channel id for this cluster
43 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
44 $pc23_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc23
46 $last_hour = time; # last time I did an hourly periodic update
47 %pings = (); # outstanding ping requests outbound
48 %rcmds = (); # outstanding rcmd requests outbound
49 %nodehops = (); # node specific hop control
50 $censorpc = 1; # Do a BadWords::check on text fields and reject things
51 # loads of 'bad things'
52 $baddx = new DXHash "baddx";
53 $badspotter = new DXHash "badspotter";
54 $badnode = new DXHash "badnode";
59 [ qw(c c m bp bc c) ], # pc10
60 [ qw(f m d t m c c h) ], # pc11
61 [ qw(c bc m bp bm p h) ], # pc12
65 undef , # pc16 has to be validated manually
68 undef , # pc19 has to be validated manually
69 undef , # pc20 no validation
71 undef , # pc22 no validation
72 [ qw(d n n n n m c c h) ], # pc23
74 [ qw(c c n n) ], # pc25
75 [ qw(f m d t m c c bc) ], # pc26
76 [ qw(d n n n n m c c bc) ], # pc27
77 [ qw(c c m c d t p m bp n p bp bc) ], # pc28
78 [ qw(c c n m) ], # pc29
86 [ qw(c c n m) ], # pc37
87 undef, # pc38 not interested
89 [ qw(c c m p n) ], # pc40
90 [ qw(c n m h) ], # pc41
92 undef, # pc43 don't handle it
93 [ qw(c c n m m c) ], # pc44
94 [ qw(c c n m) ], # pc45
100 [ qw(c c n) ], # pc51
122 [ qw(d n n n n n n m m m c c h) ], # pc73
133 [ qw(c c c m) ], # pc84
134 [ qw(c c c m) ], # pc85
137 # use the entry in the check list to check the field list presented
138 # return OK if line NOT in check list (for now)
143 return 0 if $n < 0 || $n > @checklist;
144 my $ref = $checklist[$n];
145 return 0 unless ref $ref;
148 shift; # not interested in the first field
149 for ($i = 0; $i < @$ref; $i++) {
150 my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
151 return 0 unless $act;
152 next if $blank && $_[$i] =~ /^[ \*]$/;
154 return $i+1 unless is_callsign($_[$i]);
155 } elsif ($act eq 'm') {
156 return $i+1 unless is_pctext($_[$i]);
157 } elsif ($act eq 'p') {
158 return $i+1 unless is_pcflag($_[$i]);
159 } elsif ($act eq 'f') {
160 return $i+1 unless is_freq($_[$i]);
161 } elsif ($act eq 'n') {
162 return $i+1 unless $_[$i] =~ /^[\d ]+$/;
163 } elsif ($act eq 'h') {
164 return $i+1 unless $_[$i] =~ /^H\d\d?$/;
165 } elsif ($act eq 'd') {
166 return $i+1 unless $_[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
167 } elsif ($act eq 't') {
168 return $i+1 unless $_[$i] =~ /^[012]\d[012345]\dZ$/;
176 my $user = DXUser->get($main::mycall);
177 $DXProt::myprot_version += $main::version*100;
178 $me = DXProt->new($main::mycall, 0, $user);
180 $me->{state} = "indifferent";
181 do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
183 $me->{sort} = 'S'; # S for spider
185 # $Route::Node::me->adddxchan($me);
189 # obtain a new connection this is derived from dxchannel
194 my $self = DXChannel::alloc(@_);
196 # add this node to the table, the values get filled in later
199 $main::routeroot->add($call, '0000', Route::here(1)) if $call ne $main::mycall;
204 # this is how a pc connection starts (for an incoming connection)
205 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
206 # all the crap that comes between).
209 my ($self, $line, $sort) = @_;
210 my $call = $self->{call};
211 my $user = $self->{user};
213 # remember type of connection
214 $self->{consort} = $line;
215 $self->{outbound} = $sort eq 'O';
216 $self->{priv} = $user->priv || 1; # other clusters can always be 'normal' users
217 $self->{lang} = $user->lang || 'en';
218 $self->{isolate} = $user->{isolate};
219 $self->{consort} = $line; # save the connection type
222 # get the output filters
223 $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
224 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
225 $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
226 $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
227 $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) ;
230 # get the INPUT filters (these only pertain to Clusters)
231 $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
232 $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
233 $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
234 $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
235 $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1);
237 # set unbuffered and no echo
238 $self->send_now('B',"0");
239 $self->send_now('E',"0");
241 # ping neighbour node stuff
242 my $ping = $user->pingint;
243 $ping = 5*60 unless defined $ping;
244 $self->{pingint} = $ping;
245 $self->{nopings} = $user->nopings || 2;
246 $self->{pingtime} = [ ];
247 $self->{pingave} = 0;
249 # send initialisation string
250 unless ($self->{outbound}) {
252 $self->{lastping} = $main::systime;
254 $self->{lastping} = $main::systime + ($self->pingint / 2);
256 $self->state('init');
257 $self->{pc50_t} = $main::systime;
259 # send info to all logged in thingies
260 $self->tell_login('loginn');
262 Log('DXProt', "$call connected");
266 # This is the normal pcxx despatcher
270 my ($self, $line) = @_;
271 my @field = split /\^/, $line;
272 return unless @field;
274 pop @field if $field[-1] eq '~';
276 # print join(',', @field), "\n";
279 # process PC frames, this will fail unless the frame starts PCnn
280 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
282 return if $pcno < 10 || $pcno > 99;
284 # check for and dump bad protocol messages
285 my $n = check($pcno, @field);
287 dbg("PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")") if isdbg('chanerr');
294 $pcr = Local::pcprot($self, $pcno, @field);
296 # dbg("Local::pcprot error $@") if isdbg('local') if $@;
300 if ($pcno == 10) { # incoming talk
302 # will we allow it at all?
305 if (@bad = BadWords::check($field[3])) {
306 dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
311 # is it for me or one of mine?
312 my ($to, $via, $call, $dxchan);
313 if ($field[5] gt ' ') {
314 $call = $via = $field[2];
317 $call = $to = $field[2];
319 $dxchan = DXChannel->get($main::myalias) if $call eq $main::mycall;
320 $dxchan = DXChannel->get($call) unless $dxchan;
321 if ($dxchan && $dxchan->is_user) {
322 $field[3] =~ s/\%5E/^/g;
323 $dxchan->talk($field[1], $to, $via, $field[3]);
325 $self->route($field[2], $line); # relay it on its way
330 if ($pcno == 11 || $pcno == 26) { # dx spot
332 # route 'foreign' pc26s
334 if ($field[7] ne $main::mycall) {
335 $self->route($field[7], $line);
340 # if this is a 'nodx' node then ignore it
341 if ($badnode->in($field[7])) {
342 dbg("PCPROT: Bad Node, dropped") if isdbg('chanerr');
346 # if this is a 'bad spotter' user then ignore it
347 if ($badspotter->in($field[6])) {
348 dbg("PCPROT: Bad Spotter, dropped") if isdbg('chanerr');
352 # convert the date to a unix date
353 my $d = cltounix($field[3], $field[4]);
354 # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
355 if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
356 dbg("PCPROT: Spot ignored, invalid date or out of range ($field[3] $field[4])\n") if isdbg('chanerr');
361 if ($baddx->in($field[2])) {
362 dbg("PCPROT: Bad DX spot, ignored") if isdbg('chanerr');
367 $field[5] =~ s/^\s+//; # take any leading blanks off
368 $field[2] = unpad($field[2]); # take off leading and trailing blanks from spotted callsign
369 if ($field[2] =~ /BUST\w*$/) {
370 dbg("PCPROT: useless 'BUSTED' spot") if isdbg('chanerr');
373 if (Spot::dup($field[1], $field[2], $d, $field[5])) {
374 dbg("PCPROT: Duplicate Spot ignored\n") if isdbg('chanerr');
379 if (@bad = BadWords::check($field[5])) {
380 dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
385 my @spot = Spot::prepare($field[1], $field[2], $d, $field[5], $field[6], $field[7]);
386 # global spot filtering on INPUT
387 if ($self->{inspotsfilter}) {
388 my ($filter, $hops) = $self->{inspotsfilter}->it(@spot);
390 dbg("PCPROT: Rejected by input spot filter") if isdbg('chanerr');
399 # @spot at this point contains:-
400 # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
401 # then spotted itu, spotted cq, spotters itu, spotters cq
402 # you should be able to route on any of these
405 # fix up qra locators of known users
406 my $user = DXUser->get_current($spot[4]);
408 my $qra = $user->qra;
409 unless ($qra && DXBearing::is_qra($qra)) {
410 my $lat = $user->lat;
411 my $long = $user->long;
412 if (defined $lat && defined $long) {
413 $user->qra(DXBearing::lltoqra($lat, $long));
418 # send a remote command to a distant cluster if it is visible and there is no
419 # qra locator and we havn't done it for a month.
421 unless ($user->qra) {
423 my $to = $user->homenode;
424 my $last = $user->lastoper || 0;
425 if ($to ne $main::mycall && $send_opernam && $main::systime > $last + $DXUser::lastoperinterval && $to && ($node = Route::Node::get($to)) ) {
426 my $cmd = "forward/opernam $spot[4]";
427 # send the rcmd but we aren't interested in the replies...
428 my $dxchan = $node->dxchan;
429 if ($dxchan && $dxchan->is_clx) {
430 route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
432 route(undef, $to, pc34($main::mycall, $to, $cmd));
434 if ($to ne $field[7]) {
436 $node = Route::Node::get($to);
438 $dxchan = $node->dxchan;
439 if ($dxchan && $dxchan->is_clx) {
440 route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
442 route(undef, $to, pc34($main::mycall, $to, $cmd));
446 $user->lastoper($main::systime);
455 $r = Local::spot($self, @spot);
457 # dbg("Local::spot1 error $@") if isdbg('local') if $@;
460 # DON'T be silly and send on PC26s!
461 return if $pcno == 26;
463 # send out the filtered spots
464 send_dx_spot($self, $line, @spot) if @spot;
468 if ($pcno == 12) { # announces
469 # announce duplicate checking
470 $field[3] =~ s/^\s+//; # remove leading blanks
471 if (AnnTalk::dup($field[1], $field[2], $field[3])) {
472 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
478 if (@bad = BadWords::check($field[3])) {
479 dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
484 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
486 # global ann filtering on INPUT
487 if ($self->{inannfilter}) {
488 my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
489 my @dxcc = Prefix::extract($field[1]);
491 $ann_dxcc = $dxcc[1]->dxcc;
492 $ann_itu = $dxcc[1]->itu;
493 $ann_cq = $dxcc[1]->cq();
495 @dxcc = Prefix::extract($field[5]);
497 $org_dxcc = $dxcc[1]->dxcc;
498 $org_itu = $dxcc[1]->itu;
499 $org_cq = $dxcc[1]->cq();
501 my ($filter, $hops) = $self->{inannfilter}->it(@field[1..6], $self->{call},
502 $ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq);
504 dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
510 $self->send_announce($line, @field[1..6]);
512 $self->route($field[2], $line);
528 if ($pcno == 16) { # add a user
532 my $ncall = $field[1];
533 my $newline = "PC16^";
535 if ($ncall eq $main::mycall) {
536 dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
539 $dxchan = DXChannel->get($ncall);
540 if ($dxchan && $dxchan ne $self) {
541 dbg("PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
544 my $parent = Route::Node::get($ncall);
546 dbg("PCPROT: Node $ncall not in config") if isdbg('chanerr');
550 # input filter if required
551 return unless $self->in_filter_route($parent);
555 for ($i = 2; $i < $#field; $i++) {
556 my ($call, $conf, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
557 next unless $call && $conf && defined $here && is_callsign($call);
558 next if $call eq $main::mycall;
560 $conf = $conf eq '*';
562 my $r = Route::User::get($call);
563 my $flags = Route::here($here)|Route::conf($conf);
566 if ($r->flags != $flags) {
570 $r->addparent($ncall);
572 push @rout, $parent->add_user($call, $flags);
575 # add this station to the user database, if required
576 $call =~ s/-\d+$//o; # remove ssid for users
577 my $user = DXUser->get_current($call);
578 $user = DXUser->new($call) if !$user;
579 $user->homenode($parent->call) if !$user->homenode;
580 $user->node($parent->call);
581 $user->lastin($main::systime) unless DXChannel->get($call);
586 # queue up any messages (look for privates only)
587 DXMsg::queue_msg(1) if $self->state eq 'normal';
589 $self->route_pc16($parent, @rout) if @rout;
593 if ($pcno == 17) { # remove a user
595 my $ncall = $field[2];
596 my $ucall = $field[1];
597 if ($ncall eq $main::mycall) {
598 dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
601 $dxchan = DXChannel->get($ncall);
602 if ($dxchan && $dxchan ne $self) {
603 dbg("PCPROT: PC17 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
606 my $parent = Route::Node::get($ncall);
608 dbg("PCPROT: Route::Node $ncall not in config") if isdbg('chanerr');
612 # input filter if required
613 return unless $self->in_filter_route($parent);
615 my @rout = $parent->del_user($ucall);
616 $self->route_pc17($parent, @rout) if @rout;
620 if ($pcno == 18) { # link request
621 $self->state('init');
623 # first clear out any nodes on this dxchannel
624 my $parent = Route::Node::get($self->{call});
625 my @rout = $parent->del_nodes;
626 $self->route_pc21(@rout, $parent);
627 $self->send_local_config();
629 return; # we don't pass these on
632 if ($pcno == 19) { # incoming cluster list
634 my $newline = "PC19^";
638 my $parent = Route::Node::get($self->{call});
640 dbg("DXPROT: my parent $self->{call} has disappeared");
646 for ($i = 1; $i < $#field-1; $i += 4) {
647 my $here = $field[$i];
648 my $call = uc $field[$i+1];
649 my $conf = $field[$i+2];
650 my $ver = $field[$i+3];
651 next unless defined $here && defined $conf && is_callsign($call);
652 # check for sane parameters
653 $ver = 5000 if $ver eq '0000';
654 next if $ver < 5000; # only works with version 5 software
655 next if length $call < 3; # min 3 letter callsigns
656 next if $call eq $main::mycall;
658 # update it if required
659 my $r = Route::Node::get($call);
660 my $flags = Route::here($here)|Route::conf($conf);
663 if ($call ne $parent->call) {
664 if ($self->in_filter_route($r)) {
665 $ar = $parent->add($call, $ver, $flags);
666 push @rout, $ar if $ar;
671 if ($r->version ne $ver || $r->flags != $flags) {
674 push @rout, $r unless $ar;
677 if ($call eq $self->{call}) {
678 dbg("DXPROT: my channel route for $call has disappeared");
682 my $new = Route->new($call); # throw away
683 if ($self->in_filter_route($new)) {
684 my $r = $parent->add($call, $ver, $flags);
691 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
692 my $mref = DXMsg::get_busy($call);
693 $mref->stop_msg($call) if $mref;
695 # add this station to the user database, if required (don't remove SSID from nodes)
696 my $user = DXUser->get_current($call);
698 $user = DXUser->new($call);
700 $user->priv(1); # I have relented and defaulted nodes
701 $self->{priv} = 1; # to user RCMDs allowed
702 $user->homenode($call);
705 $user->lastin($main::systime) unless DXChannel->get($call);
709 $self->route_pc19(@rout) if @rout;
713 if ($pcno == 20) { # send local configuration
714 $self->send_local_config();
716 $self->state('normal');
720 if ($pcno == 21) { # delete a cluster from the list
721 my $call = uc $field[1];
723 my $parent = Route::Node::get($self->{call});
725 dbg("DXPROT: my parent $self->{call} has disappeared");
729 my $node = Route::Node::get($call);
730 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
731 if ($call eq $self->{call}) {
732 dbg("PCPROT: Trying to disconnect myself with PC21") if isdbg('chanerr');
738 return unless $self->in_filter_route($node);
741 push @rout, $node->del($parent);
744 dbg("PCPROT: I WILL _NOT_ be disconnected!") if isdbg('chanerr');
747 $self->route_pc21(@rout) if @rout;
752 $self->state('normal');
756 if ($pcno == 23 || $pcno == 27) { # WWV info
758 # route 'foreign' pc27s
760 if ($field[8] ne $main::mycall) {
761 $self->route($field[8], $line);
767 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
768 my $sfi = unpad($field[3]);
769 my $k = unpad($field[4]);
770 my $i = unpad($field[5]);
771 my ($r) = $field[6] =~ /R=(\d+)/;
773 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
774 dbg("PCPROT: WWV Date ($field[1] $field[2]) out of range") if isdbg('chanerr');
777 if (Geomag::dup($d,$sfi,$k,$i,$field[6])) {
778 dbg("PCPROT: Dup WWV Spot ignored\n") if isdbg('chanerr');
781 $field[7] =~ s/-\d+$//o; # remove spotter's ssid
783 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..8], $r);
787 $rep = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..8], $r);
789 # dbg("Local::wwv2 error $@") if isdbg('local') if $@;
792 # DON'T be silly and send on PC27s!
793 return if $pcno == 27;
795 # broadcast to the eager world
796 send_wwv_spot($self, $line, $d, $field[2], $sfi, $k, $i, @field[6..8]);
800 if ($pcno == 24) { # set here status
801 my $call = uc $field[1];
803 $nref = Route::Node::get($call);
804 $uref = Route::User::get($call);
805 return unless $nref || $uref; # if we don't know where they are, it's pointless sending it on
807 unless (eph_dup($line)) {
808 $nref->here($field[2]) if $nref;
809 $uref->here($field[2]) if $uref;
810 my $ref = $nref || $uref;
811 return unless $self->in_filter_route($ref);
812 $self->route_pc24($ref, $field[3]);
817 if ($pcno == 25) { # merge request
818 if ($field[1] ne $main::mycall) {
819 $self->route($field[1], $line);
822 if ($field[2] eq $main::mycall) {
823 dbg("PCPROT: Trying to merge to myself, ignored") if isdbg('chanerr');
827 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
831 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]);
834 $self->send(pc26(@{$in}[0..4], $field[2]));
840 my @in = reverse Geomag::search(0, $field[4], time, 1);
843 $self->send(pc27(@{$in}[0..5], $field[2]));
849 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
850 if ($pcno == 49 || $field[1] eq $main::mycall) {
851 DXMsg::process($self, $line);
853 $self->route($field[1], $line) unless $self->is_clx;
858 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
859 $self->process_rcmd($field[1], $field[2], $field[2], $field[3]);
863 if ($pcno == 35) { # remote command replies
864 $self->process_rcmd_reply($field[1], $field[2], $field[1], $field[3]);
868 # for pc 37 see 44 onwards
870 if ($pcno == 38) { # node connected list from neighbour
874 if ($pcno == 39) { # incoming disconnect
875 if ($field[1] eq $self->{call}) {
876 $self->disconnect(1);
878 dbg("PCPROT: came in on wrong channel") if isdbg('chanerr');
883 if ($pcno == 41) { # user info
884 my $call = $field[1];
886 # input filter if required
887 my $ref = Route::get($call) || Route->new($call);
888 return unless $self->in_filter_route($ref);
890 # add this station to the user database, if required
891 my $user = DXUser->get_current($call);
892 $user = DXUser->new($call) if !$user;
894 if ($field[2] == 1) {
895 $user->name($field[3]);
896 } elsif ($field[2] == 2) {
897 $user->qth($field[3]);
898 } elsif ($field[2] == 3) {
899 my ($lat, $long) = DXBearing::stoll($field[3]);
902 $user->qra(DXBearing::lltoqra($lat, $long)) unless $user->qra && DXBearing::is_qra($user->qra);
903 } elsif ($field[2] == 4) {
904 $user->homenode($field[3]);
906 $user->lastoper($main::systime); # to cut down on excessive for/opers being generated
909 # perhaps this IS what we want after all
910 # $self->route_pc41($ref, $call, $field[2], $field[3], $field[4]);
918 if ($pcno == 37 || $pcno == 44 || $pcno == 45 || $pcno == 46 || $pcno == 47 || $pcno == 48) {
919 DXDb::process($self, $line);
923 if ($pcno == 50) { # keep alive/user list
924 my $call = $field[1];
925 my $node = Route::Node::get($call);
927 return unless $node->call eq $self->{call};
928 $node->usercount($field[2]);
930 # input filter if required
931 return unless $self->in_filter_route($node);
933 $self->route_pc50($node, $field[2], $field[3]) unless eph_dup($line);
938 if ($pcno == 51) { # incoming ping requests/answers
940 my $from = $field[2];
941 my $flag = $field[3];
944 if ($to eq $main::mycall) {
946 $self->send(pc51($from, $to, '0'));
948 # it's a reply, look in the ping list for this one
949 my $ref = $pings{$from};
951 my $tochan = DXChannel->get($from);
954 my $dxchan = DXChannel->get($r->{call});
956 my $t = tv_interval($r->{t}, [ gettimeofday ]);
957 if ($dxchan->is_user) {
958 my $s = sprintf "%.2f", $t;
959 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
960 $dxchan->send($dxchan->msg('pingi', $from, $s, $ave))
961 } elsif ($dxchan->is_node) {
963 $tochan->{nopings} = $tochan->user->nopings || 2; # pump up the timer
964 push @{$tochan->{pingtime}}, $t;
965 shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
967 for (@{$tochan->{pingtime}}) {
970 $tochan->{pingave} = $st / @{$tochan->{pingtime}};
977 # route down an appropriate thingy
978 $self->route($to, $line);
983 if ($pcno == 75) { # dunno but route it
984 my $call = $field[1];
985 if ($call ne $main::mycall) {
986 $self->route($call, $line);
991 if ($pcno == 73) { # WCY broadcasts
992 my $call = $field[1];
995 my $d = cltounix($call, sprintf("%02d18Z", $field[2]));
996 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
997 dbg("PCPROT: WCY Date ($call $field[2]) out of range") if isdbg('chanerr');
1000 @field = map { unpad($_) } @field;
1001 if (WCY::dup($d,@field[3..7])) {
1002 dbg("PCPROT: Dup WCY Spot ignored\n") if isdbg('chanerr');
1006 my $wcy = WCY::update($d, @field[2..12]);
1010 $rep = Local::wwv($self, @field[1..12]);
1012 # dbg("Local::wcy error $@") if isdbg('local') if $@;
1015 # broadcast to the eager world
1016 send_wcy_spot($self, $line, $d, @field[2..12]);
1020 if ($pcno == 84) { # remote commands (incoming)
1021 $self->process_rcmd($field[1], $field[2], $field[3], $field[4]);
1025 if ($pcno == 85) { # remote command replies
1026 $self->process_rcmd_reply($field[1], $field[2], $field[3], $field[4]);
1032 # if get here then rebroadcast the thing with its Hop count decremented (if
1033 # there is one). If it has a hop count and it decrements to zero then don't
1036 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
1040 if (eph_dup($line)) {
1041 dbg("PCPROT: Ephemeral dup, dropped") if isdbg('chanerr');
1043 unless ($self->{isolate}) {
1044 broadcast_ak1a($line, $self); # send it to everyone but me
1050 # This is called from inside the main cluster processing loop and is used
1051 # for despatching commands that are doing some long processing job
1056 my @dxchan = DXChannel->get_all();
1059 foreach $dxchan (@dxchan) {
1060 next unless $dxchan->is_node();
1061 next if $dxchan == $me;
1063 # send a pc50 out on this channel
1064 $dxchan->{pc50_t} = $main::systime unless exists $dxchan->{pc50_t};
1065 if ($t >= $dxchan->{pc50_t} + $DXProt::pc50_interval) {
1066 my $s = pc50($me, scalar DXChannel::get_all_users);
1069 $dxchan->{pc50_t} = $t;
1072 # send a ping out on this channel
1073 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
1074 if ($dxchan->{nopings} <= 0) {
1075 $dxchan->disconnect;
1077 addping($main::mycall, $dxchan->call);
1078 $dxchan->{nopings} -= 1;
1079 $dxchan->{lastping} = $t;
1085 if ($t - $last10 >= 10) {
1086 # clean out ephemera
1093 if ($main::systime - 3600 > $last_hour) {
1094 $last_hour = $main::systime;
1099 # finish up a pc context
1103 # some active measures
1110 my @dxchan = DXChannel->get_all();
1113 # send it if it isn't the except list and isn't isolated and still has a hop count
1114 # taking into account filtering and so on
1115 foreach $dxchan (@dxchan) {
1116 next if $dxchan == $me;
1117 next if $dxchan == $self && $self->is_node;
1118 $dxchan->dx_spot($line, $self->{isolate}, @_, $self->{call});
1126 my $isolate = shift;
1127 my ($filter, $hops);
1129 if ($self->{spotsfilter}) {
1130 ($filter, $hops) = $self->{spotsfilter}->it(@_);
1131 return unless $filter;
1133 send_prot_line($self, $filter, $hops, $isolate, $line)
1138 my ($self, $filter, $hops, $isolate, $line) = @_;
1143 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1145 $routeit = adjust_hops($self, $line); # adjust its hop count by node name
1146 return unless $routeit;
1149 $self->send($routeit) if $routeit;
1151 $self->send($routeit) unless $self->{isolate} || $isolate;
1160 my @dxchan = DXChannel->get_all();
1162 my ($wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1163 my @dxcc = Prefix::extract($_[7]);
1165 $wwv_dxcc = $dxcc[1]->dxcc;
1166 $wwv_itu = $dxcc[1]->itu;
1167 $wwv_cq = $dxcc[1]->cq;
1169 @dxcc = Prefix::extract($_[8]);
1171 $org_dxcc = $dxcc[1]->dxcc;
1172 $org_itu = $dxcc[1]->itu;
1173 $org_cq = $dxcc[1]->cq;
1176 # send it if it isn't the except list and isn't isolated and still has a hop count
1177 # taking into account filtering and so on
1178 foreach $dxchan (@dxchan) {
1179 next if $dxchan == $me;
1180 next if $dxchan == $self && $self->is_node;
1182 my ($filter, $hops);
1184 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, $wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq);
1193 my $isolate = shift;
1194 my ($filter, $hops);
1196 if ($self->{wwvfilter}) {
1197 ($filter, $hops) = $self->{wwvfilter}->it(@_);
1198 return unless $filter;
1200 send_prot_line($self, $filter, $hops, $isolate, $line)
1207 my @dxchan = DXChannel->get_all();
1209 my ($wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1210 my @dxcc = Prefix::extract($_[11]);
1212 $wcy_dxcc = $dxcc[1]->dxcc;
1213 $wcy_itu = $dxcc[1]->itu;
1214 $wcy_cq = $dxcc[1]->cq;
1216 @dxcc = Prefix::extract($_[12]);
1218 $org_dxcc = $dxcc[1]->dxcc;
1219 $org_itu = $dxcc[1]->itu;
1220 $org_cq = $dxcc[1]->cq;
1223 # send it if it isn't the except list and isn't isolated and still has a hop count
1224 # taking into account filtering and so on
1225 foreach $dxchan (@dxchan) {
1226 next if $dxchan == $me;
1227 next if $dxchan == $self;
1229 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, $wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq);
1237 my $isolate = shift;
1238 my ($filter, $hops);
1240 if ($self->{wcyfilter}) {
1241 ($filter, $hops) = $self->{wcyfilter}->it(@_);
1242 return unless $filter;
1244 send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
1252 my @dxchan = DXChannel->get_all();
1256 my $text = unpad($_[2]);
1258 if ($_[3] eq '*') { # sysops
1260 } elsif ($_[3] gt ' ') { # speciality list handling
1261 my ($name) = split /\./, $_[3];
1262 $target = "$name"; # put the rest in later (if bothered)
1269 $target = "ALL" if !$target;
1271 Log('ann', $target, $_[0], $text);
1273 # obtain country codes etc
1274 my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1275 my @dxcc = Prefix::extract($_[0]);
1277 $ann_dxcc = $dxcc[1]->dxcc;
1278 $ann_itu = $dxcc[1]->itu;
1279 $ann_cq = $dxcc[1]->cq;
1281 @dxcc = Prefix::extract($_[4]);
1283 $org_dxcc = $dxcc[1]->dxcc;
1284 $org_itu = $dxcc[1]->itu;
1285 $org_cq = $dxcc[1]->cq;
1288 # send it if it isn't the except list and isn't isolated and still has a hop count
1289 # taking into account filtering and so on
1290 foreach $dxchan (@dxchan) {
1291 next if $dxchan == $me;
1292 next if $dxchan == $self && $self->is_node;
1294 my ($filter, $hops);
1296 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call}, $ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq)
1304 my $isolate = shift;
1307 my ($filter, $hops);
1309 if ($self->{annfilter}) {
1310 ($filter, $hops) = $self->{annfilter}->it(@_);
1311 return unless $filter;
1313 send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
1317 sub send_local_config
1325 dbg('DXProt::send_local_config') if isdbg('trace');
1328 if ($self->{isolate}) {
1329 @localnodes = ( $main::routeroot );
1331 # create a list of all the nodes that are not connected to this connection
1332 # and are not themselves isolated, this to make sure that isolated nodes
1333 # don't appear outside of this node
1334 my @dxchan = grep { $_->call ne $main::mycall && $_->call ne $self->{call} } DXChannel::get_all_nodes();
1335 @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
1336 my @intcalls = map { $_->nodes } @localnodes if @localnodes;
1337 my $ref = Route::Node::get($self->{call});
1338 my @rnodes = $ref->nodes;
1339 for my $n (@intcalls) {
1340 push @remotenodes, Route::Node::get($n) unless grep $n eq $_, @rnodes;
1342 unshift @localnodes, $main::routeroot;
1345 send_route($self, \&pc19, scalar(@localnodes)+scalar(@remotenodes), @localnodes, @remotenodes);
1347 # get all the users connected on the above nodes and send them out
1348 foreach $n (@localnodes, @remotenodes) {
1350 send_route($self, \&pc16, 1, $n, map {my $r = Route::User::get($_); $r ? ($r) : ()} $n->users);
1352 dbg("sent a null value") if isdbg('chanerr');
1358 # route a message down an appropriate interface for a callsign
1360 # is called route(to, pcline);
1364 my ($self, $call, $line) = @_;
1366 if (ref $self && $call eq $self->{call}) {
1367 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1371 # always send it down the local interface if available
1372 my $dxchan = DXChannel->get($call);
1374 my $cl = Route::get($call);
1375 $dxchan = $cl->dxchan if $cl;
1377 if (ref $self && $dxchan eq $self) {
1378 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1384 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1386 $dxchan->send($routeit) unless $dxchan == $me;
1389 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
1393 # broadcast a message to all clusters taking into account isolation
1394 # [except those mentioned after buffer]
1397 my $s = shift; # the line to be rebroadcast
1398 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1399 my @dxchan = DXChannel::get_all_nodes();
1402 # send it if it isn't the except list and isn't isolated and still has a hop count
1403 foreach $dxchan (@dxchan) {
1404 next if grep $dxchan == $_, @except;
1405 next if $dxchan == $me;
1407 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1408 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
1412 # broadcast a message to all clusters ignoring isolation
1413 # [except those mentioned after buffer]
1414 sub broadcast_all_ak1a
1416 my $s = shift; # the line to be rebroadcast
1417 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1418 my @dxchan = DXChannel::get_all_nodes();
1421 # send it if it isn't the except list and isn't isolated and still has a hop count
1422 foreach $dxchan (@dxchan) {
1423 next if grep $dxchan == $_, @except;
1424 next if $dxchan == $me;
1426 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1427 $dxchan->send($routeit);
1431 # broadcast to all users
1432 # storing the spot or whatever until it is in a state to receive it
1435 my $s = shift; # the line to be rebroadcast
1436 my $sort = shift; # the type of transmission
1437 my $fref = shift; # a reference to an object to filter on
1438 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1439 my @dxchan = DXChannel::get_all_users();
1443 foreach $dxchan (@dxchan) {
1444 next if grep $dxchan == $_, @except;
1447 broadcast_list($s, $sort, $fref, @out);
1450 # broadcast to a list of users
1458 foreach $dxchan (@_) {
1460 next if $dxchan == $me;
1462 if ($sort eq 'dx') {
1463 next unless $dxchan->{dx};
1464 ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
1465 next unless $filter;
1467 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
1468 next if $sort eq 'wwv' && !$dxchan->{wwv};
1469 next if $sort eq 'wcy' && !$dxchan->{wcy};
1470 next if $sort eq 'wx' && !$dxchan->{wx};
1472 $s =~ s/\a//og unless $dxchan->{beep};
1474 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1484 # obtain the hops from the list for this callsign and pc no
1490 my $hops = $DXProt::hopcount{$pcno};
1491 $hops = $DXProt::def_hopcount if !$hops;
1496 # adjust the hop count on a per node basis using the user loadable
1497 # hop table if available or else decrement an existing one
1504 my $call = $self->{call};
1507 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
1508 my ($pcno) = $s =~ /^PC(\d\d)/o;
1509 confess "$call called adjust_hops with '$s'" unless $pcno;
1510 my $ref = $nodehops{$call} if %nodehops;
1512 my $newhops = $ref->{$pcno};
1513 return "" if defined $newhops && $newhops == 0;
1514 $newhops = $ref->{default} unless $newhops;
1515 return "" if defined $newhops && $newhops == 0;
1516 $newhops = $hops if !$newhops;
1517 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
1519 # simply decrement it
1521 return "" if !$hops;
1522 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1534 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1535 do "$main::data/hop_table.pl";
1541 # add a ping request to the ping queues
1544 my ($from, $to) = @_;
1545 my $ref = $pings{$to} || [];
1548 $r->{t} = [ gettimeofday ];
1549 route(undef, $to, pc51($to, $main::mycall, 1));
1556 my ($self, $tonode, $fromnode, $user, $cmd) = @_;
1557 if ($tonode eq $main::mycall) {
1558 my $ref = DXUser->get_current($fromnode);
1559 my $cref = Route::Node::get($fromnode);
1560 Log('rcmd', 'in', $ref->{priv}, $fromnode, $cmd);
1561 if ($cmd !~ /^\s*rcmd/i && $cref && $ref && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
1562 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
1563 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
1564 my $oldpriv = $self->{priv};
1565 $self->{priv} = $ref->{priv}; # assume the user's privilege level
1566 my @in = (DXCommandmode::run_cmd($self, $cmd));
1567 $self->{priv} = $oldpriv;
1568 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
1569 delete $self->{remotecmd};
1571 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1574 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
1577 my $ref = DXUser->get_current($tonode);
1578 if ($ref && $ref->is_clx) {
1579 $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
1581 $self->route($tonode, pc34($fromnode, $tonode, $cmd));
1586 sub process_rcmd_reply
1588 my ($self, $tonode, $fromnode, $user, $line) = @_;
1589 if ($tonode eq $main::mycall) {
1590 my $s = $rcmds{$fromnode};
1592 my $dxchan = DXChannel->get($s->{call});
1593 my $ref = DXChannel->get($user) || $dxchan;
1594 if ($ref->{call} eq $main::mycall) {
1595 $ref = DXChannel->get($main::myalias) || $ref;
1597 $ref->send($line) if $ref;
1598 delete $rcmds{$fromnode} if !$dxchan;
1600 # send unsolicited ones to the sysop
1601 my $dxchan = DXChannel->get($main::myalias);
1602 $dxchan->send($line) if $dxchan;
1605 my $ref = DXUser->get_current($tonode);
1606 if ($ref && $ref->is_clx) {
1607 $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
1609 $self->route($tonode, pc35($fromnode, $tonode, $line));
1618 my $fromnode = shift;
1623 Log('rcmd', 'out', $fromnode, $line);
1624 if ($self->is_clx) {
1625 $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
1627 $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
1632 # add a rcmd request to the rcmd queues
1635 my ($self, $to, $cmd) = @_;
1638 $r->{call} = $self->{call};
1639 $r->{t} = $main::systime;
1643 my $ref = Route::Node::get($to);
1644 my $dxchan = $ref->dxchan;
1645 if ($dxchan && $dxchan->is_clx) {
1646 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1648 route(undef, $to, pc34($main::mycall, $to, $cmd));
1655 my $pc39flag = shift;
1656 my $call = $self->call;
1658 unless ($pc39flag && $pc39flag == 1) {
1659 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1663 my $node = Route::Node::get($call);
1666 @rout = $node->del_nodes; # at the next level
1667 @rout = $node->del($main::routeroot);
1670 # unbusy and stop and outgoing mail
1671 my $mref = DXMsg::get_busy($call);
1672 $mref->stop_msg($call) if $mref;
1674 # broadcast to all other nodes that all the nodes connected to via me are gone
1675 unless ($pc39flag && $pc39flag == 2) {
1676 $self->route_pc21(@rout) if @rout;
1679 # remove outstanding pings
1680 delete $pings{$call};
1682 # I was the last node visited
1683 $self->user->node($main::mycall);
1685 # send info to all logged in thingies
1686 $self->tell_login('logoutn');
1688 Log('DXProt', $call . " Disconnected");
1690 $self->SUPER::disconnect;
1695 # send a talk message to this thingy
1699 my ($self, $from, $to, $via, $line) = @_;
1701 $line =~ s/\^/\\5E/g; # remove any ^ characters
1702 $self->send(DXProt::pc10($from, $to, $via, $line));
1703 Log('talk', $self->call, $from, $via?$via:$main::mycall, $line);
1706 # send it if it isn't the except list and isn't isolated and still has a hop count
1707 # taking into account filtering and so on
1711 my $generate = shift;
1712 my $no = shift; # the no of things to filter on
1714 my ($filter, $hops);
1717 for (; @_ && $no; $no--) {
1720 if ($self->{routefilter}) {
1723 ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1727 dbg("DXPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('chanerr');
1730 dbg("was sent a null value") if isdbg('chanerr');
1737 foreach my $line (&$generate(@rin, @_)) {
1740 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1742 $routeit = adjust_hops($self, $line); # adjust its hop count by node name
1743 next unless $routeit;
1745 $self->send($routeit) if $self->{routefilter} || !$self->{isolate};
1753 my $generate = shift;
1754 my @dxchan = DXChannel::get_all_nodes();
1758 foreach $dxchan (@dxchan) {
1759 next if $dxchan == $self;
1760 next if $dxchan == $me;
1761 if ($dxchan->{routefilter} || !$self->{isolate}) {
1762 $dxchan->send_route($generate, @_)
1764 dbg('DXPROT: isolated') if isdbg('chanerr');
1772 broadcast_route($self, \&pc16, 1, @_);
1778 broadcast_route($self, \&pc17, 1, @_);
1784 broadcast_route($self, \&pc19, scalar @_, @_);
1790 broadcast_route($self, \&pc21, scalar @_, @_);
1796 broadcast_route($self, \&pc24, 1, @_);
1802 broadcast_route($self, \&pc41, 1, @_);
1808 broadcast_route($self, \&pc50, 1, @_);
1815 my ($filter, $hops) = (1, 1);
1817 if ($self->{inroutefilter}) {
1818 ($filter, $hops) = $self->{inroutefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1819 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
1829 $s =~ s/\^H\d\d?\^?\~?$//;
1830 return 1 if exists $eph{$s};
1831 $eph{$s} = $main::systime;
1839 while (($key, $val) = each %eph) {
1840 if ($main::systime - $val > 90) {