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 %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";
58 [ qw(c c m bp bc c) ], # pc10
59 [ qw(f m d t m c c h) ], # pc11
60 [ qw(c bc m bp bm p h) ], # pc12
64 undef , # pc16 has to be validated manually
67 undef , # pc19 has to be validated manually
68 undef , # pc20 no validation
70 undef , # pc22 no validation
71 [ qw(d n n n n m c c h) ], # pc23
73 [ qw(c c n n) ], # pc25
74 [ qw(f m d t m c c bc) ], # pc26
75 [ qw(d n n n n m c c bc) ], # pc27
76 [ qw(c c m c d t p m bp n p bp bc) ], # pc28
77 [ qw(c c n m) ], # pc29
85 [ qw(c c n m) ], # pc37
86 undef, # pc38 not interested
88 [ qw(c c m p n) ], # pc40
89 [ qw(c n m h) ], # pc41
91 undef, # pc43 don't handle it
92 [ qw(c c n m m c) ], # pc44
93 [ qw(c c n m) ], # pc45
121 [ qw(d n n n n n n m m m c c h) ], # pc73
132 [ qw(c c c m) ], # pc84
133 [ qw(c c c m) ], # pc85
136 # use the entry in the check list to check the field list presented
137 # return OK if line NOT in check list (for now)
142 return 0 if $n < 0 || $n > @checklist;
143 my $ref = $checklist[$n];
144 return 0 unless ref $ref;
147 shift; # not interested in the first field
148 for ($i = 0; $i < @$ref; $i++) {
149 my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
150 return 0 unless $act;
151 next if $blank && $_[$i] =~ /^[ \*]$/;
153 return $i+1 unless is_callsign($_[$i]);
154 } elsif ($act eq 'm') {
155 return $i+1 unless is_pctext($_[$i]);
156 } elsif ($act eq 'p') {
157 return $i+1 unless is_pcflag($_[$i]);
158 } elsif ($act eq 'f') {
159 return $i+1 unless is_freq($_[$i]);
160 } elsif ($act eq 'n') {
161 return $i+1 unless $_[$i] =~ /^[\d ]+$/;
162 } elsif ($act eq 'h') {
163 return $i+1 unless $_[$i] =~ /^H\d\d?$/;
164 } elsif ($act eq 'd') {
165 return $i+1 unless $_[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
166 } elsif ($act eq 't') {
167 return $i+1 unless $_[$i] =~ /^[012]\d[012345]\dZ$/;
175 my $user = DXUser->get($main::mycall);
176 $DXProt::myprot_version += $main::version*100;
177 $me = DXProt->new($main::mycall, 0, $user);
179 $me->{state} = "indifferent";
180 do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
182 $me->{sort} = 'S'; # S for spider
184 # $Route::Node::me->adddxchan($me);
188 # obtain a new connection this is derived from dxchannel
193 my $self = DXChannel::alloc(@_);
195 # add this node to the table, the values get filled in later
198 $main::routeroot->add($call, '0000', Route::here(1)) if $call ne $main::mycall;
203 # this is how a pc connection starts (for an incoming connection)
204 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
205 # all the crap that comes between).
208 my ($self, $line, $sort) = @_;
209 my $call = $self->{call};
210 my $user = $self->{user};
212 # remember type of connection
213 $self->{consort} = $line;
214 $self->{outbound} = $sort eq 'O';
215 $self->{priv} = $user->priv || 1; # other clusters can always be 'normal' users
216 $self->{lang} = $user->lang || 'en';
217 $self->{isolate} = $user->{isolate};
218 $self->{consort} = $line; # save the connection type
221 # get the output filters
222 $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
223 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
224 $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
225 $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
226 $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) ;
229 # get the INPUT filters (these only pertain to Clusters)
230 $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
231 $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
232 $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
233 $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
234 $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1);
236 # set unbuffered and no echo
237 $self->send_now('B',"0");
238 $self->send_now('E',"0");
240 # ping neighbour node stuff
241 my $ping = $user->pingint;
242 $ping = 5*60 unless defined $ping;
243 $self->{pingint} = $ping;
244 $self->{nopings} = $user->nopings || 2;
245 $self->{pingtime} = [ ];
246 $self->{pingave} = 0;
248 # send initialisation string
249 unless ($self->{outbound}) {
251 $self->{lastping} = $main::systime;
253 $self->{lastping} = $main::systime + ($self->pingint / 2);
255 $self->state('init');
256 $self->{pc50_t} = $main::systime;
258 # send info to all logged in thingies
259 $self->tell_login('loginn');
261 Log('DXProt', "$call connected");
265 # This is the normal pcxx despatcher
269 my ($self, $line) = @_;
270 my @field = split /\^/, $line;
271 return unless @field;
273 pop @field if $field[-1] eq '~';
275 # print join(',', @field), "\n";
277 # ignore any lines that don't start with PC
278 return if !$field[0] =~ /^PC/;
281 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
283 return if $pcno < 10 || $pcno > 99;
285 # check for and dump bad protocol messages
286 my $n = check($pcno, @field);
288 dbg('chan', "PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")");
295 $pcr = Local::pcprot($self, $pcno, @field);
297 # dbg('local', "Local::pcprot error $@") if $@;
301 if ($pcno == 10) { # incoming talk
303 # will we allow it at all?
306 if (@bad = BadWords::check($field[3])) {
307 dbg('chan', "PCPROT: Bad words: @bad, dropped" );
312 # is it for me or one of mine?
313 my ($to, $via, $call, $dxchan);
314 if ($field[5] gt ' ') {
315 $call = $via = $field[2];
318 $call = $to = $field[2];
320 $dxchan = DXChannel->get($call);
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('chan', "PCPROT: Bad Node, dropped");
346 # if this is a 'bad spotter' user then ignore it
347 if ($badspotter->in($field[6])) {
348 dbg('chan', "PCPROT: Bad Spotter, dropped");
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('chan', "PCPROT: Spot ignored, invalid date or out of range ($field[3] $field[4])\n");
361 if ($baddx->in($field[2])) {
362 dbg('chan', "PCPROT: Bad DX spot, ignored");
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('chan', "PCPROT: useless 'BUSTED' spot");
373 if (Spot::dup($field[1], $field[2], $d, $field[5])) {
374 dbg('chan', "PCPROT: Duplicate Spot ignored\n");
379 if (@bad = BadWords::check($field[5])) {
380 dbg('chan', "PCPROT: Bad words: @bad, dropped" );
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('chan', "PCPROT: Rejected by filter");
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 ($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', "Local::spot1 error $@") 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('chan', "PCPROT: Duplicate Announce ignored");
478 if (@bad = BadWords::check($field[3])) {
479 dbg('chan', "PCPROT: Bad words: @bad, dropped" );
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('chan', "PCPROT: Rejected by filter");
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('chan', "PCPROT: trying to alter config on this node from outside!");
539 $dxchan = DXChannel->get($ncall);
540 if ($dxchan && $dxchan ne $self) {
541 dbg('chan', "PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!");
544 my $parent = Route::Node::get($ncall);
546 dbg('chan', "PCPROT: Node $ncall not in config");
551 for ($i = 2; $i < $#field; $i++) {
552 my ($call, $conf, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
553 next unless $call && $conf && defined $here && is_callsign($call);
554 $conf = $conf eq '*';
556 push @rout, $parent->add_user($call, Route::here($here)|Route::conf($conf));
558 # add this station to the user database, if required
559 $call =~ s/-\d+$//o; # remove ssid for users
560 my $user = DXUser->get_current($call);
561 $user = DXUser->new($call) if !$user;
562 $user->homenode($parent->call) if !$user->homenode;
563 $user->node($parent->call);
564 $user->lastin($main::systime) unless DXChannel->get($call);
569 # queue up any messages (look for privates only)
570 DXMsg::queue_msg(1) if $self->state eq 'normal';
572 dbg('route', "B/C PC16 on $ncall for: " . join(',', map{$_->call} @rout)) if @rout;
573 $self->route_pc16($parent, @rout) if @rout;
577 if ($pcno == 17) { # remove a user
579 my $ncall = $field[2];
580 if ($ncall eq $main::mycall) {
581 dbg('chan', "PCPROT: trying to alter config on this node from outside!");
584 $dxchan = DXChannel->get($ncall);
585 if ($dxchan && $dxchan ne $self) {
586 dbg('chan', "PCPROT: PC17 from $self->{call} trying to alter locally connected $ncall, ignored!");
589 my $parent = Route::Node::get($ncall);
591 dbg('chan', "PCPROT: Route::Node $ncall not in config");
594 my @rout = $parent->del_user($field[1]);
595 dbg('route', "B/C PC17 on $ncall for: $field[1]");
596 $self->route_pc17($parent, @rout) if @rout;
600 if ($pcno == 18) { # link request
601 $self->state('init');
603 # first clear out any nodes on this dxchannel
604 my $parent = Route::Node::get($self->{call});
606 for ($parent->nodes) {
607 my $r = Route::Node::get($_);
608 push @rout, $r->del_node if $r;
610 $self->route_pc21(@rout, $parent);
611 $self->send_local_config();
613 return; # we don't pass these on
616 if ($pcno == 19) { # incoming cluster list
618 my $newline = "PC19^";
622 my $parent = Route::Node::get($self->{call});
625 for ($i = 1; $i < $#field-1; $i += 4) {
626 my $here = $field[$i];
627 my $call = uc $field[$i+1];
628 my $conf = $field[$i+2];
629 my $ver = $field[$i+3];
630 next unless defined $here && defined $conf && is_callsign($call);
631 # check for sane parameters
632 $ver = 5000 if $ver eq '0000';
633 next if $ver < 5000; # only works with version 5 software
634 next if length $call < 3; # min 3 letter callsigns
636 # update it if required
638 if ($parent->call eq $call && !$parent->version) {
639 $parent->version($ver);
640 $parent->flags(Route::here($here)|Route::conf($conf));
642 } elsif ($parent->call ne $call) {
643 next if $call eq $main::mycall || $call eq $self->{call};
645 my $r = $parent->add($call, $ver, Route::here($here)|Route::conf($conf));
646 push @rout, $r if $r;
648 $r = Route::Node::get($call);
649 if ($r && (!$r->version || $r->version eq '0000')) {
651 $r->flags(Route::here($here)|Route::conf($conf));
656 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
657 my $mref = DXMsg::get_busy($call);
658 $mref->stop_msg($call) if $mref;
660 # add this station to the user database, if required (don't remove SSID from nodes)
661 my $user = DXUser->get_current($call);
663 $user = DXUser->new($call);
665 $user->priv(1); # I have relented and defaulted nodes
666 $self->{priv} = 1; # to user RCMDs allowed
667 $user->homenode($call);
670 $user->lastin($main::systime) unless DXChannel->get($call);
674 dbg('route', "B/C PC19 for: " . join(',', map{$_->call} @rout)) if @rout;
676 $self->route_pc19(@rout) if @rout;
680 if ($pcno == 20) { # send local configuration
681 $self->send_local_config();
683 $self->state('normal');
687 if ($pcno == 21) { # delete a cluster from the list
688 my $call = uc $field[1];
690 my $parent = Route::Node::get($self->{call});
692 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
693 if ($call eq $self->{call}) {
694 dbg('chan', "PCPROT: Trying to disconnect myself with PC21");
700 push @rout, $parent->del_node($call);
702 dbg('chan', "PCPROT: Route::Node $call not in config");
705 dbg('chan', "PCPROT: I WILL _NOT_ be disconnected!");
708 dbg('route', "B/C PC21 for: " . join(',', (map{$_->call} @rout))) if @rout;
710 $self->route_pc21(@rout) if @rout;
715 $self->state('normal');
719 if ($pcno == 23 || $pcno == 27) { # WWV info
721 # route 'foreign' pc27s
723 if ($field[8] ne $main::mycall) {
724 $self->route($field[8], $line);
730 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
731 my $sfi = unpad($field[3]);
732 my $k = unpad($field[4]);
733 my $i = unpad($field[5]);
734 my ($r) = $field[6] =~ /R=(\d+)/;
736 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
737 dbg('chan', "PCPROT: WWV Date ($field[1] $field[2]) out of range");
740 if (Geomag::dup($d,$sfi,$k,$i,$field[6])) {
741 dbg('chan', "PCPROT: Dup WWV Spot ignored\n");
744 $field[7] =~ s/-\d+$//o; # remove spotter's ssid
746 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..8], $r);
750 $rep = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..8], $r);
752 # dbg('local', "Local::wwv2 error $@") if $@;
755 # DON'T be silly and send on PC27s!
756 return if $pcno == 27;
758 # broadcast to the eager world
759 send_wwv_spot($self, $line, $d, $field[2], $sfi, $k, $i, @field[6..8]);
763 if ($pcno == 24) { # set here status
764 my $call = uc $field[1];
765 my $ref = Route::Node::get($call);
766 $ref->here($field[2]) if $ref;
767 $ref = Route::User::get($call);
768 $ref->here($field[2]) if $ref;
772 if ($pcno == 25) { # merge request
773 if ($field[1] ne $main::mycall) {
774 $self->route($field[1], $line);
777 if ($field[2] eq $main::mycall) {
778 dbg('chan', "PCPROT: Trying to merge to myself, ignored");
782 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
786 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]);
789 $self->send(pc26(@{$in}[0..4], $field[2]));
795 my @in = reverse Geomag::search(0, $field[4], time, 1);
798 $self->send(pc27(@{$in}[0..5], $field[2]));
804 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
805 if ($pcno == 49 || $field[1] eq $main::mycall) {
806 DXMsg::process($self, $line);
808 $self->route($field[1], $line) unless $self->is_clx;
813 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
814 if ($field[1] eq $main::mycall) {
815 my $ref = DXUser->get_current($field[2]);
816 my $cref = Route::Node::get($field[2]);
817 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
818 unless (!$cref || !$ref || $cref->call ne $ref->homenode) { # not allowed to relay RCMDS!
819 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
820 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
821 my $oldpriv = $self->{priv};
822 $self->{priv} = $ref->{priv}; # assume the user's privilege level
823 my @in = (DXCommandmode::run_cmd($self, $field[3]));
824 $self->{priv} = $oldpriv;
827 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
828 Log('rcmd', 'out', $field[2], $_);
830 delete $self->{remotecmd};
832 $self->send(pc35($main::mycall, $field[2], "$main::mycall:sorry...!"));
835 $self->send(pc35($main::mycall, $field[2], "$main::mycall:your attempt is logged, Tut tut tut...!"));
838 my $ref = DXUser->get_current($field[1]);
839 if ($ref && $ref->is_clx) {
840 $self->route($field[1], pc84($field[2], $field[1], $field[2], $field[3]));
842 $self->route($field[1], $line);
848 if ($pcno == 35) { # remote command replies
849 if ($field[1] eq $main::mycall) {
850 my $s = $rcmds{$field[2]};
852 my $dxchan = DXChannel->get($s->{call});
853 $dxchan->send($field[3]) if $dxchan;
854 delete $rcmds{$field[2]} if !$dxchan;
856 # send unsolicited ones to the sysop
857 my $dxchan = DXChannel->get($main::myalias);
858 $dxchan->send($field[3]) if $dxchan;
861 my $ref = DXUser->get_current($field[1]);
862 if ($ref && $ref->is_clx) {
863 $self->route($field[1], pc85($field[2], $field[1], $field[2], $field[3]));
865 $self->route($field[1], $line);
871 # for pc 37 see 44 onwards
873 if ($pcno == 38) { # node connected list from neighbour
877 if ($pcno == 39) { # incoming disconnect
878 if ($field[1] eq $self->{call}) {
879 $self->disconnect(1);
881 dbg('chan', "PCPROT: came in on wrong channel");
886 if ($pcno == 41) { # user info
887 # add this station to the user database, if required
888 my $user = DXUser->get_current($field[1]);
889 $user = DXUser->new($field[1]) if !$user;
891 if ($field[2] == 1) {
892 $user->name($field[3]);
893 } elsif ($field[2] == 2) {
894 $user->qth($field[3]);
895 } elsif ($field[2] == 3) {
896 my ($lat, $long) = DXBearing::stoll($field[3]);
899 $user->qra(DXBearing::lltoqra($lat, $long)) unless $user->qra && DXBearing::is_qra($user->qra);
900 } elsif ($field[2] == 4) {
901 $user->homenode($field[3]);
903 $user->lastoper($main::systime); # to cut down on excessive for/opers being generated
910 if ($pcno == 37 || $pcno == 44 || $pcno == 45 || $pcno == 46 || $pcno == 47 || $pcno == 48) {
911 DXDb::process($self, $line);
915 if ($pcno == 50) { # keep alive/user list
916 my $node = Route::Node::get($field[1]);
918 return unless $node->call eq $self->{call};
919 $node->usercount($field[2]);
924 if ($pcno == 51) { # incoming ping requests/answers
927 if ($field[1] eq $main::mycall) {
928 my $flag = $field[3];
930 $self->send(pc51($field[2], $field[1], '0'));
932 # it's a reply, look in the ping list for this one
933 my $ref = $pings{$field[2]};
935 my $tochan = DXChannel->get($field[2]);
938 my $dxchan = DXChannel->get($r->{call});
940 my $t = tv_interval($r->{t}, [ gettimeofday ]);
941 if ($dxchan->is_user) {
942 my $s = sprintf "%.2f", $t;
943 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
944 $dxchan->send($dxchan->msg('pingi', $field[2], $s, $ave))
945 } elsif ($dxchan->is_node) {
947 $tochan->{nopings} = $tochan->user->nopings || 2; # pump up the timer
948 push @{$tochan->{pingtime}}, $t;
949 shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
951 for (@{$tochan->{pingtime}}) {
954 $tochan->{pingave} = $st / @{$tochan->{pingtime}};
961 # route down an appropriate thingy
962 $self->route($field[1], $line);
967 if ($pcno == 75) { # dunno but route it
968 if ($field[1] ne $main::mycall) {
969 $self->route($field[1], $line);
974 if ($pcno == 73) { # WCY broadcasts
977 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
978 if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
979 dbg('chan', "PCPROT: WCY Date ($field[1] $field[2]) out of range");
982 @field = map { unpad($_) } @field;
983 if (WCY::dup($d,@field[3..7])) {
984 dbg('chan', "PCPROT: Dup WCY Spot ignored\n");
988 my $wcy = WCY::update($d, @field[2..12]);
992 $rep = Local::wwv($self, @field[1..12]);
994 # dbg('local', "Local::wcy error $@") if $@;
997 # broadcast to the eager world
998 send_wcy_spot($self, $line, $d, @field[2..12]);
1002 if ($pcno == 84) { # remote commands (incoming)
1003 if ($field[1] eq $main::mycall) {
1004 my $ref = DXUser->get_current($field[2]);
1005 my $cref = Route::Node::get($field[2]);
1006 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[4]);
1007 unless ($field[4] =~ /rcmd/i || !$cref || !$ref || $cref->call ne $ref->homenode) { # not allowed to relay RCMDS!
1008 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
1009 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
1010 my $oldpriv = $self->{priv};
1011 $self->{priv} = $ref->{priv}; # assume the user's privilege level
1012 my @in = (DXCommandmode::run_cmd($self, $field[4]));
1013 $self->{priv} = $oldpriv;
1016 $self->send(pc85($main::mycall, $field[2], $field[3], "$main::mycall:$_"));
1017 Log('rcmd', 'out', $field[2], $_);
1019 delete $self->{remotecmd};
1021 $self->send(pc85($main::mycall, $field[2], $field[3], "$main::mycall:sorry...!"));
1024 $self->send(pc85($main::mycall, $field[2], $field[3],"$main::mycall:your attempt is logged, Tut tut tut...!"));
1027 my $ref = DXUser->get_current($field[1]);
1028 if ($ref && $ref->is_clx) {
1029 $self->route($field[1], $line);
1031 $self->route($field[1], pc34($field[2], $field[1], $field[4]));
1037 if ($pcno == 85) { # remote command replies
1038 if ($field[1] eq $main::mycall) {
1039 my $dxchan = DXChannel->get($field[3]);
1041 $dxchan->send($field[4]);
1043 my $s = $rcmds{$field[2]};
1045 $dxchan = DXChannel->get($s->{call});
1046 $dxchan->send($field[4]) if $dxchan;
1047 delete $rcmds{$field[2]} if !$dxchan;
1049 # send unsolicited ones to the sysop
1050 my $dxchan = DXChannel->get($main::myalias);
1051 $dxchan->send($field[4]) if $dxchan;
1055 my $ref = DXUser->get_current($field[1]);
1056 if ($ref && $ref->is_clx) {
1057 $self->route($field[1], $line);
1059 $self->route($field[1], pc35($field[2], $field[1], $field[4]));
1066 # if get here then rebroadcast the thing with its Hop count decremented (if
1067 # there is one). If it has a hop count and it decrements to zero then don't
1070 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
1074 unless ($self->{isolate}) {
1075 broadcast_ak1a($line, $self); # send it to everyone but me
1080 # This is called from inside the main cluster processing loop and is used
1081 # for despatching commands that are doing some long processing job
1086 my @dxchan = DXChannel->get_all();
1089 foreach $dxchan (@dxchan) {
1090 next unless $dxchan->is_node();
1091 next if $dxchan == $me;
1093 # send a pc50 out on this channel
1094 $dxchan->{pc50_t} = $main::systime unless exists $dxchan->{pc50_t};
1095 if ($t >= $dxchan->{pc50_t} + $DXProt::pc50_interval) {
1096 $dxchan->send(pc50(scalar DXChannel::get_all_users));
1097 $dxchan->{pc50_t} = $t;
1100 # send a ping out on this channel
1101 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
1102 if ($dxchan->{nopings} <= 0) {
1103 $dxchan->disconnect;
1105 addping($main::mycall, $dxchan->call);
1106 $dxchan->{nopings} -= 1;
1107 $dxchan->{lastping} = $t;
1115 if ($main::systime - 3600 > $last_hour) {
1119 $last_hour = $main::systime;
1124 # finish up a pc context
1128 # some active measures
1135 my @dxchan = DXChannel->get_all();
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) {
1141 next if $dxchan == $me;
1143 my ($filter, $hops);
1145 if ($dxchan->{spotsfilter}) {
1146 ($filter, $hops) = $dxchan->{spotsfilter}->it(@_, $self->{call} );
1147 next unless $filter;
1150 if ($dxchan->is_node) {
1151 next if $dxchan == $self;
1154 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1156 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1157 next unless $routeit;
1160 $dxchan->send($routeit) if $routeit;
1162 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1164 } elsif ($dxchan->is_user && $dxchan->{dx}) {
1165 my $buf = Spot::formatb($dxchan->{user}->wantgrid, $_[0], $_[1], $_[2], $_[3], $_[4]);
1166 $buf .= "\a\a" if $dxchan->{beep};
1168 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1169 $dxchan->send($buf);
1171 $dxchan->delay($buf);
1181 my @dxchan = DXChannel->get_all();
1183 my ($wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1184 my @dxcc = Prefix::extract($_[7]);
1186 $wwv_dxcc = $dxcc[1]->dxcc;
1187 $wwv_itu = $dxcc[1]->itu;
1188 $wwv_cq = $dxcc[1]->cq;
1190 @dxcc = Prefix::extract($_[8]);
1192 $org_dxcc = $dxcc[1]->dxcc;
1193 $org_itu = $dxcc[1]->itu;
1194 $org_cq = $dxcc[1]->cq;
1197 # send it if it isn't the except list and isn't isolated and still has a hop count
1198 # taking into account filtering and so on
1199 foreach $dxchan (@dxchan) {
1200 next if $dxchan == $self;
1201 next if $dxchan == $me;
1203 my ($filter, $hops);
1205 if ($dxchan->{wwvfilter}) {
1206 ($filter, $hops) = $dxchan->{wwvfilter}->it(@_, $self->{call}, $wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq);
1207 next unless $filter;
1209 if ($dxchan->is_node) {
1212 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1214 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1215 next unless $routeit;
1218 $dxchan->send($routeit) if $routeit;
1220 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1223 } elsif ($dxchan->is_user && $dxchan->{wwv}) {
1224 my $buf = "WWV de $_[6] <$_[1]>: SFI=$_[2], A=$_[3], K=$_[4], $_[5]";
1225 $buf .= "\a\a" if $dxchan->{beep};
1226 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1227 $dxchan->send($buf);
1229 $dxchan->delay($buf);
1239 my @dxchan = DXChannel->get_all();
1241 my ($wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1242 my @dxcc = Prefix::extract($_[11]);
1244 $wcy_dxcc = $dxcc[1]->dxcc;
1245 $wcy_itu = $dxcc[1]->itu;
1246 $wcy_cq = $dxcc[1]->cq;
1248 @dxcc = Prefix::extract($_[12]);
1250 $org_dxcc = $dxcc[1]->dxcc;
1251 $org_itu = $dxcc[1]->itu;
1252 $org_cq = $dxcc[1]->cq;
1255 # send it if it isn't the except list and isn't isolated and still has a hop count
1256 # taking into account filtering and so on
1257 foreach $dxchan (@dxchan) {
1258 next if $dxchan == $me;
1260 my ($filter, $hops);
1262 if ($dxchan->{wcyfilter}) {
1263 ($filter, $hops) = $dxchan->{wcyfilter}->it(@_, $self->{call}, $wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq);
1264 next unless $filter;
1266 if ($dxchan->is_clx || $dxchan->is_spider || $dxchan->is_dxnet) {
1269 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1271 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1272 next unless $routeit;
1275 $dxchan->send($routeit) if $routeit;
1277 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1279 } elsif ($dxchan->is_user && $dxchan->{wcy}) {
1280 my $buf = "WCY de $_[10] <$_[1]> : K=$_[4] expK=$_[5] A=$_[3] R=$_[6] SFI=$_[2] SA=$_[7] GMF=$_[8] Au=$_[9]";
1281 $buf .= "\a\a" if $dxchan->{beep};
1282 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1283 $dxchan->send($buf);
1285 $dxchan->delay($buf);
1296 my @dxchan = DXChannel->get_all();
1298 my $text = unpad($_[2]);
1302 if ($_[3] eq '*') { # sysops
1304 } elsif ($_[3] gt ' ') { # speciality list handling
1305 my ($name) = split /\./, $_[3];
1306 $target = "$name"; # put the rest in later (if bothered)
1313 $target = "ALL" if !$target;
1315 Log('ann', $target, $_[0], $text);
1317 # obtain country codes etc
1318 my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1319 my @dxcc = Prefix::extract($_[0]);
1321 $ann_dxcc = $dxcc[1]->dxcc;
1322 $ann_itu = $dxcc[1]->itu;
1323 $ann_cq = $dxcc[1]->cq;
1325 @dxcc = Prefix::extract($_[4]);
1327 $org_dxcc = $dxcc[1]->dxcc;
1328 $org_itu = $dxcc[1]->itu;
1329 $org_cq = $dxcc[1]->cq;
1332 # send it if it isn't the except list and isn't isolated and still has a hop count
1333 # taking into account filtering and so on
1334 foreach $dxchan (@dxchan) {
1335 next if $dxchan == $self;
1336 next if $dxchan == $me;
1338 my ($filter, $hops);
1340 if ($dxchan->{annfilter}) {
1341 ($filter, $hops) = $dxchan->{annfilter}->it(@_, $self->{call}, $ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq);
1342 next unless $filter;
1344 if ($dxchan->is_node && $_[1] ne $main::mycall) { # i.e not specifically routed to me
1347 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1349 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1350 next unless $routeit;
1353 $dxchan->send($routeit) if $routeit;
1355 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
1358 } elsif ($dxchan->is_user) {
1359 unless ($dxchan->{ann}) {
1360 next if $_[0] ne $main::myalias && $_[0] ne $main::mycall;
1362 next if $target eq 'SYSOP' && $dxchan->{priv} < 5;
1363 my $buf = "$to$target de $_[0]: $text";
1365 $buf .= "\a\a" if $dxchan->{beep};
1366 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1367 $dxchan->send($buf);
1369 $dxchan->delay($buf);
1375 sub send_local_config
1383 dbg('trace', 'DXProt::send_local_config');
1386 if ($self->{isolate}) {
1387 @localnodes = ( $main::routeroot );
1389 # create a list of all the nodes that are not connected to this connection
1390 # and are not themselves isolated, this to make sure that isolated nodes
1391 # don't appear outside of this node
1392 my @dxchan = grep { $_->call ne $main::mycall && $_->call ne $self->{call} } DXChannel::get_all_nodes();
1393 @localnodes = map { Route::Node::get($_->{call}) or die "connot find node $_->{call}" } @dxchan if @dxchan;
1394 my @intcalls = map { $_->nodes } @localnodes if @localnodes;
1395 my $ref = Route::Node::get($self->{call});
1396 my @rnodes = $ref->nodes;
1397 for my $n (@intcalls) {
1398 push @remotenodes, Route::Node::get($n) unless grep $n eq $_, @rnodes;
1400 unshift @localnodes, $main::routeroot;
1403 send_route($self, \&pc19, scalar(@localnodes)+scalar(@remotenodes), @localnodes, @remotenodes);
1405 # get all the users connected on the above nodes and send them out
1406 foreach $n (@localnodes, @remotenodes) {
1407 send_route($self, \&pc16, 1, $n, map {my $r = Route::User::get($_); $r ? ($r) : ()} $n->users);
1412 # route a message down an appropriate interface for a callsign
1414 # is called route(to, pcline);
1418 my ($self, $call, $line) = @_;
1420 if (ref $self && $call eq $self->{call}) {
1421 dbg('chan', "PCPROT: Trying to route back to source, dropped");
1425 # always send it down the local interface if available
1426 my $dxchan = DXChannel->get($call);
1428 my $cl = Route::Node::get($call);
1429 $dxchan = $cl->dxchan if $cl;
1431 if (ref $self && $dxchan eq $self) {
1432 dbg('chan', "PCPROT: Trying to route back to source, dropped");
1438 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1440 $dxchan->send($routeit);
1443 dbg('chan', "PCPROT: No route available, dropped");
1447 # broadcast a message to all clusters taking into account isolation
1448 # [except those mentioned after buffer]
1451 my $s = shift; # the line to be rebroadcast
1452 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1453 my @dxchan = DXChannel::get_all_nodes();
1456 # send it if it isn't the except list and isn't isolated and still has a hop count
1457 foreach $dxchan (@dxchan) {
1458 next if grep $dxchan == $_, @except;
1459 next if $dxchan == $me;
1461 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1462 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
1466 # broadcast a message to all clusters ignoring isolation
1467 # [except those mentioned after buffer]
1468 sub broadcast_all_ak1a
1470 my $s = shift; # the line to be rebroadcast
1471 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1472 my @dxchan = DXChannel::get_all_nodes();
1475 # send it if it isn't the except list and isn't isolated and still has a hop count
1476 foreach $dxchan (@dxchan) {
1477 next if grep $dxchan == $_, @except;
1478 next if $dxchan == $me;
1480 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
1481 $dxchan->send($routeit);
1485 # broadcast to all users
1486 # storing the spot or whatever until it is in a state to receive it
1489 my $s = shift; # the line to be rebroadcast
1490 my $sort = shift; # the type of transmission
1491 my $fref = shift; # a reference to an object to filter on
1492 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
1493 my @dxchan = DXChannel::get_all_users();
1497 foreach $dxchan (@dxchan) {
1498 next if grep $dxchan == $_, @except;
1501 broadcast_list($s, $sort, $fref, @out);
1504 # broadcast to a list of users
1512 foreach $dxchan (@_) {
1514 next if $dxchan == $me;
1516 if ($sort eq 'dx') {
1517 next unless $dxchan->{dx};
1518 ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
1519 next unless $filter;
1521 next if $sort eq 'ann' && !$dxchan->{ann};
1522 next if $sort eq 'wwv' && !$dxchan->{wwv};
1523 next if $sort eq 'wcy' && !$dxchan->{wcy};
1524 next if $sort eq 'wx' && !$dxchan->{wx};
1526 $s =~ s/\a//og unless $dxchan->{beep};
1528 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1538 # obtain the hops from the list for this callsign and pc no
1544 my $hops = $DXProt::hopcount{$pcno};
1545 $hops = $DXProt::def_hopcount if !$hops;
1550 # adjust the hop count on a per node basis using the user loadable
1551 # hop table if available or else decrement an existing one
1558 my $call = $self->{call};
1561 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
1562 my ($pcno) = $s =~ /^PC(\d\d)/o;
1563 confess "$call called adjust_hops with '$s'" unless $pcno;
1564 my $ref = $nodehops{$call} if %nodehops;
1566 my $newhops = $ref->{$pcno};
1567 return "" if defined $newhops && $newhops == 0;
1568 $newhops = $ref->{default} unless $newhops;
1569 return "" if defined $newhops && $newhops == 0;
1570 $newhops = $hops if !$newhops;
1571 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
1573 # simply decrement it
1575 return "" if !$hops;
1576 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1588 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1589 do "$main::data/hop_table.pl";
1595 # add a ping request to the ping queues
1598 my ($from, $to) = @_;
1599 my $ref = $pings{$to} || [];
1602 $r->{t} = [ gettimeofday ];
1603 route(undef, $to, pc51($to, $main::mycall, 1));
1608 # add a rcmd request to the rcmd queues
1611 my ($self, $to, $cmd) = @_;
1614 $r->{call} = $self->{call};
1615 $r->{t} = $main::systime;
1619 my $ref = Route::Node::get($to);
1620 my $dxchan = $ref->dxchan;
1621 if ($dxchan && $dxchan->is_clx) {
1622 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1624 route(undef, $to, pc34($main::mycall, $to, $cmd));
1631 my $pc39flag = shift;
1632 my $call = $self->call;
1634 unless ($pc39flag && $pc39flag == 1) {
1635 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1639 # my $node = Route::Node::get($self->{call});
1640 # my @rout = $node->del_nodes if $node;
1641 my @rout = $main::routeroot->del_node($call);
1642 dbg('route', "B/C PC21 (from PC39) for: " . join(',', (map{ $_->call } @rout))) if @rout;
1644 # unbusy and stop and outgoing mail
1645 my $mref = DXMsg::get_busy($call);
1646 $mref->stop_msg($call) if $mref;
1648 # broadcast to all other nodes that all the nodes connected to via me are gone
1649 unless ($pc39flag && $pc39flag == 2) {
1650 $self->route_pc21(@rout) if @rout;
1653 # remove outstanding pings
1654 delete $pings{$call};
1656 # I was the last node visited
1657 $self->user->node($main::mycall);
1659 # send info to all logged in thingies
1660 $self->tell_login('logoutn');
1662 Log('DXProt', $call . " Disconnected");
1664 $self->SUPER::disconnect;
1669 # send a talk message to this thingy
1673 my ($self, $from, $to, $via, $line) = @_;
1675 $line =~ s/\^/\\5E/g; # remove any ^ characters
1676 $self->send(DXProt::pc10($from, $to, $via, $line));
1677 Log('talk', $self->call, $from, $via?$via:$main::mycall, $line);
1680 # send it if it isn't the except list and isn't isolated and still has a hop count
1681 # taking into account filtering and so on
1685 my $generate = shift;
1686 my $no = shift; # the no of things to filter on
1688 my ($filter, $hops);
1691 if ($self->{routefilter}) {
1692 for (; @_ && $no; $no--) {
1694 ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1695 push @rin, $r if $filter;
1699 foreach my $line (&$generate(@rin, @_)) {
1702 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1704 $routeit = adjust_hops($self, $line); # adjust its hop count by node name
1705 next unless $routeit;
1707 $self->send($routeit);
1715 my $generate = shift;
1716 my @dxchan = DXChannel::get_all_nodes();
1720 foreach $dxchan (@dxchan) {
1721 next if $dxchan == $self;
1722 next if $dxchan == $me;
1723 $dxchan->send_route($generate, @_);
1730 broadcast_route($self, \&pc16, 1, @_);
1736 broadcast_route($self, \&pc17, 1, @_);
1742 broadcast_route($self, \&pc19, scalar @_, @_);
1748 broadcast_route($self, \&pc21, scalar @_, @_);