3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
31 use vars qw($me $pc11_max_age $pc11_dup_age $pc23_dup_age
32 %spotdup %wwvdup $last_hour %pings %rcmds
33 %nodehops @baddx $baddxfn);
35 $me = undef; # the channel id for this cluster
36 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
37 $pc11_dup_age = 24*3600; # the maximum time to keep the spot dup list for
38 $pc23_dup_age = 24*3600; # the maximum time to keep the wwv dup list for
39 %spotdup = (); # the pc11 and 26 dup hash
40 %wwvdup = (); # the pc23 and 27 dup hash
41 $last_hour = time; # last time I did an hourly periodic update
42 %pings = (); # outstanding ping requests outbound
43 %rcmds = (); # outstanding rcmd requests outbound
44 %nodehops = (); # node specific hop control
45 @baddx = (); # list of illegal spotted callsigns
47 $baddxfn = "$main::data/baddx.pl";
51 my $user = DXUser->get($main::mycall);
52 $DXProt::myprot_version += $main::version*100;
53 $me = DXProt->new($main::mycall, 0, $user);
55 $me->{state} = "indifferent";
56 do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
58 # $me->{sort} = 'M'; # M for me
60 # now prime the spot duplicates file with today's and yesterday's data
61 my @today = Julian::unixtoj(time);
62 my @spots = Spot::readfile(@today);
63 @today = Julian::sub(@today, 1);
64 push @spots, Spot::readfile(@today);
66 my $dupkey = "$_->[0]$_->[1]$_->[2]$_->[3]$_->[4]";
67 $spotdup{$dupkey} = $_->[2];
70 # now prime the wwv duplicates file with just this month's data
71 my @wwv = Geomag::readfile(time);
73 my $dupkey = "$_->[1].$_->[2]$_->[3]$_->[4]";
74 $wwvdup{$dupkey} = $_->[1];
78 do "$baddxfn" if -e "$baddxfn";
83 # obtain a new connection this is derived from dxchannel
88 my $self = DXChannel::alloc(@_);
89 $self->{'sort'} = 'A'; # in absence of how to find out what sort of an object I am
93 # this is how a pc connection starts (for an incoming connection)
94 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
95 # all the crap that comes between).
98 my ($self, $line, $sort) = @_;
99 my $call = $self->{call};
100 my $user = $self->{user};
102 # remember type of connection
103 $self->{consort} = $line;
104 $self->{outbound} = $sort eq 'O';
105 $self->{priv} = $user->priv;
106 $self->{lang} = $user->lang;
107 $self->{isolate} = $user->{isolate};
108 $self->{consort} = $line; # save the connection type
112 $self->{spotfilter} = Filter::read_in('spots', $call);
113 $self->{wwvfilter} = Filter::read_in('wwv', $call);
114 $self->{annfilter} = Filter::read_in('ann', $call);
117 $self->send_now('B',"0");
119 # send initialisation string
120 if (!$self->{outbound}) {
121 $self->send(pc38()) if DXNode->get_all();
124 $self->state('init');
127 Log('DXProt', "$call connected");
131 # This is the normal pcxx despatcher
135 my ($self, $line) = @_;
136 my @field = split /\^/, $line;
137 pop @field if $field[-1] eq '~';
139 # print join(',', @field), "\n";
141 # ignore any lines that don't start with PC
142 return if !$field[0] =~ /^PC/;
145 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
147 return if $pcno < 10 || $pcno > 51;
152 $pcr = Local::pcprot($self, $pcno, @field);
154 # dbg('local', "Local::pcprot error $@") if $@;
158 if ($pcno == 10) { # incoming talk
160 # is it for me or one of mine?
161 my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
162 if ($call eq $main::mycall || grep $_ eq $call, get_all_user_calls()) {
165 my $text = unpad($field[3]);
166 Log('talk', $call, $field[1], $field[6], $text);
167 $call = $main::myalias if $call eq $main::mycall;
168 my $ref = DXChannel->get($call);
169 $ref->send("$call de $field[1]: $text") if $ref && $ref->{talk};
171 route($field[2], $line); # relay it on its way
176 if ($pcno == 11 || $pcno == 26) { # dx spot
178 # if this is a 'nodx' node then ignore it
179 last SWITCH if grep $field[7] =~ /^$_/, @DXProt::nodx_node;
181 # convert the date to a unix date
182 my $d = cltounix($field[3], $field[4]);
183 # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
184 if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
185 dbg('chan', "Spot ignored, invalid date or out of range ($field[3] $field[4])\n");
189 # strip off the leading & trailing spaces from the comment
190 my $text = unpad($field[5]);
193 my $spotter = $field[6];
194 $spotter =~ s/-\d+$//o; # strip off the ssid from the spotter
197 my $freq = $field[1] - 0;
198 my $dupkey = "$freq$field[2]$d$text$spotter";
199 if ($spotdup{$dupkey}) {
200 dbg('chan', "Duplicate Spot ignored\n");
204 $spotdup{$dupkey} = $d;
207 if (grep $field[2] eq $_, @baddx) {
208 dbg('chan', "Bad DX spot, ignored");
212 my @spot = Spot::add($freq, $field[2], $d, $text, $spotter, $field[7]);
215 # @spot at this point contains:-
216 # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
217 # then spotted itu, spotted cq, spotters itu, spotters cq
218 # you should be able to route on any of these
224 $r = Local::spot($self, @spot);
226 # dbg('local', "Local::spot1 error $@") if $@;
229 # DON'T be silly and send on PC26s!
230 return if $pcno == 26;
232 # send out the filtered spots
233 my @dxchan = get_all_ak1a();
236 # send it if it isn't the except list and isn't isolated and still has a hop count
237 foreach $dxchan (@dxchan) {
238 next if $dxchan == $self;
239 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
240 my $filter = Filter::it($dxchan->{spotfilter}, @spot) if $dxchan->{spotfilter};
242 $dxchan->send($routeit) if $routeit;
244 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
248 # send orf to the users
250 my $buf = Spot::formatb($field[1], $field[2], $d, $text, $spotter);
251 broadcast_users("$buf\a\a", 'dx', $spot[0]);
257 if ($pcno == 12) { # announces
259 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
261 # strip leading and trailing stuff
262 my $text = unpad($field[3]);
267 if ($field[4] eq '*') { # sysops
269 @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
270 } elsif ($field[4] gt ' ') { # speciality list handling
271 my ($name) = split /\./, $field[4];
272 $target = "$name"; # put the rest in later (if bothered)
275 if ($field[6] eq '1') {
279 $target = "All" if !$target;
282 broadcast_list("$to$target de $field[1]: $text", 'ann', undef, @list);
284 broadcast_users("$target de $field[1]: $text", 'ann', undef);
286 Log('ann', $target, $field[1], $text);
288 return if $field[2] eq $main::mycall; # it's routed to me
290 route($field[2], $line);
291 return; # only on a routed one
307 if ($pcno == 16) { # add a user
308 my $node = DXCluster->get_exact($field[1]);
309 last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
310 last SWITCH unless $node->isa('DXNode');
314 for ($i = 2; $i < $#field; $i++) {
315 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
316 next if !$call || length $call < 3 || length $call > 8;
319 next if DXCluster->get_exact($call); # we already have this (loop?)
321 $confmode = $confmode eq '*';
322 DXNodeuser->new($self, $node, $call, $confmode, $here);
324 # add this station to the user database, if required
325 $call =~ s/-\d+$//o; # remove ssid for users
326 my $user = DXUser->get_current($call);
327 $user = DXUser->new($call) if !$user;
328 $user->homenode($node->call) if !$user->homenode;
329 $user->node($node->call);
330 $user->lastin($main::systime);
334 # queue up any messages (look for privates only)
335 DXMsg::queue_msg(1) if $self->state eq 'normal';
339 if ($pcno == 17) { # remove a user
341 my $ref = DXCluster->get_exact($field[1]);
346 if ($pcno == 18) { # link request
347 $self->send_local_config();
349 $self->state('init');
350 return; # we don't pass these on
353 if ($pcno == 19) { # incoming cluster list
355 for ($i = 1; $i < $#field-1; $i += 4) {
356 my $here = $field[$i];
357 my $call = uc $field[$i+1];
358 my $confmode = $field[$i+2] eq '*';
359 my $ver = $field[$i+3];
361 # now check the call over
362 next if DXCluster->get_exact($call); # we already have this
364 # check for sane parameters
365 next if $ver < 5000; # only works with version 5 software
366 next if length $call < 3; # min 3 letter callsigns
367 DXNode->new($self, $call, $confmode, $here, $ver);
369 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
370 my $mref = DXMsg::get_busy($call);
371 $mref->stop_msg($self) if $mref;
373 # add this station to the user database, if required (don't remove SSID from nodes)
374 my $user = DXUser->get_current($call);
376 $user = DXUser->new($call);
378 $user->priv(1); # I have relented and defaulted nodes
379 $self->{priv} = 1; # to user RCMDs allowed
380 $user->homenode($call);
383 $user->lastin($main::systime);
387 # queue up any messages
388 DXMsg::queue_msg(0) if $self->state eq 'normal';
392 if ($pcno == 20) { # send local configuration
393 $self->send_local_config();
395 $self->state('normal');
402 if ($pcno == 21) { # delete a cluster from the list
403 my $call = uc $field[1];
404 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
405 my $ref = DXCluster->get_exact($call);
412 $self->state('normal');
419 if ($pcno == 23 || $pcno == 27) { # WWV info
421 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
422 my $sfi = unpad($field[3]);
423 my $k = unpad($field[4]);
424 my $i = unpad($field[5]);
425 my $dupkey = "$d.$sfi$k$i";
426 if ($wwvdup{$dupkey}) {
427 dbg('chan', "Dup WWV Spot ignored\n");
430 if ($d > $main::systime + 900 || $field[2] < 0 || $field[2] > 23) {
431 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
434 $wwvdup{$dupkey} = $d;
435 $field[6] =~ s/-\d+$//o; # remove spotter's ssid
437 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..$#field]);
441 $r = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
443 # dbg('local', "Local::wwv2 error $@") if $@;
446 # DON'T be silly and send on PC27s!
447 return if $pcno == 27;
449 # broadcast to the eager users
450 broadcast_users("WWV de $field[7] <$field[2]>: SFI=$sfi, A=$k, K=$i, $field[6]", 'wwv', $wwv );
454 if ($pcno == 24) { # set here status
455 my $call = uc $field[1];
456 my $ref = DXCluster->get_exact($call);
457 $ref->here($field[2]) if $ref;
461 if ($pcno == 25) { # merge request
462 unless ($field[1] eq $main::mycall) {
463 dbg('chan', "merge request to $field[1] from $field[2] ignored");
467 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
471 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
474 $self->send(pc26(@{$in}[0..4], $in->[7]));
480 my @in = reverse Geomag::search(0, $field[4], time, 1);
483 $self->send(pc27(@{$in}));
489 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
490 DXMsg::process($self, $line);
494 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
495 if ($field[1] eq $main::mycall) {
496 my $ref = DXUser->get_current($field[2]);
497 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
498 unless ($field[3] =~ /rcmd/i) { # not allowed to relay RCMDS!
499 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
500 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
501 my @in = (DXCommandmode::run_cmd($self, $field[3]));
504 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
505 Log('rcmd', 'out', $field[2], $_);
507 delete $self->{remotecmd};
510 $self->send(pc35($main::mycall, $field[2], "$main::mycall:Tut tut tut...!"));
513 route($field[1], $line);
518 if ($pcno == 35) { # remote command replies
519 if ($field[1] eq $main::mycall) {
520 my $s = $rcmds{$field[2]};
522 my $dxchan = DXChannel->get($s->{call});
523 $dxchan->send($field[3]) if $dxchan;
524 delete $rcmds{$field[2]} if !$dxchan;
527 route($field[1], $line);
536 if ($pcno == 38) { # node connected list from neighbour
540 if ($pcno == 39) { # incoming disconnect
545 if ($pcno == 41) { # user info
546 # add this station to the user database, if required
547 my $user = DXUser->get_current($field[1]);
549 # then try without an SSID
550 $field[1] =~ s/-\d+$//o;
551 $user = DXUser->get_current($field[1]);
553 $user = DXUser->new($field[1]) if !$user;
555 if ($field[2] == 1) {
556 $user->name($field[3]);
557 } elsif ($field[2] == 2) {
558 $user->qth($field[3]);
559 } elsif ($field[2] == 3) {
560 my ($lat, $long) = DXBearing::stoll($field[3]);
563 } elsif ($field[2] == 4) {
564 $user->homenode($field[3]);
588 if ($pcno == 50) { # keep alive/user list
589 my $ref = DXCluster->get_exact($field[1]);
590 $ref->update_users($field[2]) if $ref;
594 if ($pcno == 51) { # incoming ping requests/answers
597 if ($field[1] eq $main::mycall) {
598 my $flag = $field[3];
600 $self->send(pc51($field[2], $field[1], '0'));
602 # it's a reply, look in the ping list for this one
603 my $ref = $pings{$field[2]};
606 my $dxchan = DXChannel->get($r->{call});
607 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
612 # route down an appropriate thingy
613 route($field[1], $line);
619 # if get here then rebroadcast the thing with its Hop count decremented (if
620 # there is one). If it has a hop count and it decrements to zero then don't
623 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
627 if (!$self->{isolate}) {
628 broadcast_ak1a($line, $self); # send it to everyone but me
633 # This is called from inside the main cluster processing loop and is used
634 # for despatching commands that are doing some long processing job
639 my @dxchan = DXChannel->get_all();
642 foreach $dxchan (@dxchan) {
643 next unless $dxchan->is_ak1a();
644 next if $dxchan == $me;
646 # send a pc50 out on this channel
647 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
648 $dxchan->send(pc50());
656 if ($main::systime - 3600 > $last_hour) {
657 $cutoff = $main::systime - $pc11_dup_age;
658 while (($key, $val) = each %spotdup) {
659 delete $spotdup{$key} if $val < $cutoff;
661 $cutoff = $main::systime - $pc23_dup_age;
662 while (($key, $val) = each %wwvdup) {
663 delete $wwvdup{$key} if $val < $cutoff;
665 $last_hour = $main::systime;
670 # finish up a pc context
675 my $call = $self->call;
676 my $ref = DXCluster->get_exact($call);
678 # unbusy and stop and outgoing mail
679 my $mref = DXMsg::get_busy($call);
680 $mref->stop_msg($self) if $mref;
682 # broadcast to all other nodes that all the nodes connected to via me are gone
683 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
686 foreach $node (@gonenodes) {
687 next if $node->call eq $call;
688 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
692 # remove outstanding pings
693 delete $pings{$call};
695 # now broadcast to all other ak1a nodes that I have gone
696 broadcast_ak1a(pc21($call, 'Gone.'), $self);
698 Log('DXProt', $call . " Disconnected");
703 # some active measures
706 sub send_local_config
713 if ($self->{isolate}) {
714 @nodes = (DXCluster->get_exact($main::mycall));
716 # create a list of all the nodes that are not connected to this connection
717 # and are not themselves isolated, this to make sure that isolated nodes
718 # don't appear outside of this node
719 @nodes = DXNode::get_all();
720 @nodes = grep { $_->dxchan != $self } @nodes;
721 @nodes = grep { !($_->dxchan && $_->dxchan->isolate) } @nodes;
724 my @s = $me->pc19(@nodes);
726 my $routeit = adjust_hops($self, $_);
727 $self->send($routeit) if $routeit;
730 # get all the users connected on the above nodes and send them out
731 foreach $n (@nodes) {
732 my @users = values %{$n->list};
733 my @s = pc16($n, @users);
735 my $routeit = adjust_hops($self, $_);
736 $self->send($routeit) if $routeit;
742 # route a message down an appropriate interface for a callsign
744 # is called route(to, pcline);
748 my ($call, $line) = @_;
749 my $cl = DXCluster->get_exact($call);
752 my $dxchan = $cl->{dxchan};
754 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
756 $dxchan->send($routeit) if $dxchan;
762 # broadcast a message to all clusters [except those mentioned after buffer]
765 my $s = shift; # the line to be rebroadcast
766 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
767 my @dxchan = get_all_ak1a();
770 # send it if it isn't the except list and isn't isolated and still has a hop count
771 foreach $dxchan (@dxchan) {
772 next if grep $dxchan == $_, @except;
773 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
774 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
778 # broadcast to all users
779 # storing the spot or whatever until it is in a state to receive it
782 my $s = shift; # the line to be rebroadcast
783 my $sort = shift; # the type of transmission
784 my $fref = shift; # a reference to an object to filter on
785 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
786 my @dxchan = get_all_users();
790 foreach $dxchan (@dxchan) {
791 next if grep $dxchan == $_, @except;
794 broadcast_list($s, $sort, $fref, @out);
797 # broadcast to a list of users
805 foreach $dxchan (@_) {
809 next unless $dxchan->{dx};
810 $filter = Filter::it($dxchan->{spotfilter}, @{$fref}) if ref $fref;
813 next if $sort eq 'ann' && !$dxchan->{ann};
814 next if $sort eq 'wwv' && !$dxchan->{wwv};
815 next if $sort eq 'wx' && !$dxchan->{wx};
817 $s =~ s/\a//og unless $dxchan->{beep};
819 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
828 # gimme all the ak1a nodes
832 my @list = DXChannel->get_all();
835 foreach $ref (@list) {
836 push @out, $ref if $ref->is_ak1a;
841 # return a list of all users
844 my @list = DXChannel->get_all();
847 foreach $ref (@list) {
848 push @out, $ref if $ref->is_user;
853 # return a list of all user callsigns
854 sub get_all_user_calls
856 my @list = DXChannel->get_all();
859 foreach $ref (@list) {
860 push @out, $ref->call if $ref->is_user;
866 # obtain the hops from the list for this callsign and pc no
872 my $hops = $DXProt::hopcount{$pcno};
873 $hops = $DXProt::def_hopcount if !$hops;
878 # adjust the hop count on a per node basis using the user loadable
879 # hop table if available or else decrement an existing one
886 my $call = $self->{call};
889 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
890 my ($pcno) = $s =~ /^PC(\d\d)/o;
891 confess "$call called adjust_hops with '$s'" unless $pcno;
892 my $ref = $nodehops{$call} if %nodehops;
894 my $newhops = $ref->{$pcno};
895 return "" if defined $newhops && $newhops == 0;
896 $newhops = $ref->{default} unless $newhops;
897 return "" if defined $newhops && $newhops == 0;
898 $newhops = $hops if !$newhops;
899 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
901 # simply decrement it
904 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
916 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
917 do "$main::data/hop_table.pl";
922 # remove leading and trailing spaces from an input string
930 # add a ping request to the ping queues
933 my ($from, $to) = @_;
934 my $ref = $pings{$to};
935 $ref = $pings{$to} = [] if !$ref;
938 $r->{t} = $main::systime;
939 route($to, pc51($to, $main::mycall, 1));
943 # add a rcmd request to the rcmd queues
946 my ($from, $to, $cmd) = @_;
949 $r->{t} = $main::systime;
951 route($to, pc34($main::mycall, $to, $cmd));