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 # taking into account filtering and so on
238 foreach $dxchan (@dxchan) {
239 next if $dxchan == $self;
241 my ($filter, $hops) = Filter::it($dxchan->{spotfilter}, @spot) if $dxchan->{spotfilter};
243 $line =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
245 $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
246 next unless $routeit;
249 $dxchan->send($routeit) if $routeit;
251 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
255 # send orf to the users
257 my $buf = Spot::formatb($field[1], $field[2], $d, $text, $spotter);
258 broadcast_users("$buf\a\a", 'dx', $spot[0]);
264 if ($pcno == 12) { # announces
266 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
268 # strip leading and trailing stuff
269 my $text = unpad($field[3]);
274 if ($field[4] eq '*') { # sysops
276 @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
277 } elsif ($field[4] gt ' ') { # speciality list handling
278 my ($name) = split /\./, $field[4];
279 $target = "$name"; # put the rest in later (if bothered)
282 if ($field[6] eq '1') {
286 $target = "All" if !$target;
289 broadcast_list("$to$target de $field[1]: $text", 'ann', undef, @list);
291 broadcast_users("$target de $field[1]: $text", 'ann', undef);
293 Log('ann', $target, $field[1], $text);
295 return if $field[2] eq $main::mycall; # it's routed to me
297 route($field[2], $line);
298 return; # only on a routed one
314 if ($pcno == 16) { # add a user
315 my $node = DXCluster->get_exact($field[1]);
316 last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
317 last SWITCH unless $node->isa('DXNode');
321 for ($i = 2; $i < $#field; $i++) {
322 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
323 next if !$call || length $call < 3 || length $call > 8;
326 next if DXCluster->get_exact($call); # we already have this (loop?)
328 $confmode = $confmode eq '*';
329 DXNodeuser->new($self, $node, $call, $confmode, $here);
331 # add this station to the user database, if required
332 $call =~ s/-\d+$//o; # remove ssid for users
333 my $user = DXUser->get_current($call);
334 $user = DXUser->new($call) if !$user;
335 $user->homenode($node->call) if !$user->homenode;
336 $user->node($node->call);
337 $user->lastin($main::systime);
341 # queue up any messages (look for privates only)
342 DXMsg::queue_msg(1) if $self->state eq 'normal';
346 if ($pcno == 17) { # remove a user
348 my $ref = DXCluster->get_exact($field[1]);
353 if ($pcno == 18) { # link request
354 $self->send_local_config();
356 $self->state('init');
357 return; # we don't pass these on
360 if ($pcno == 19) { # incoming cluster list
362 for ($i = 1; $i < $#field-1; $i += 4) {
363 my $here = $field[$i];
364 my $call = uc $field[$i+1];
365 my $confmode = $field[$i+2] eq '*';
366 my $ver = $field[$i+3];
368 # now check the call over
369 next if DXCluster->get_exact($call); # we already have this
371 # check for sane parameters
372 next if $ver < 5000; # only works with version 5 software
373 next if length $call < 3; # min 3 letter callsigns
374 DXNode->new($self, $call, $confmode, $here, $ver);
376 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
377 my $mref = DXMsg::get_busy($call);
378 $mref->stop_msg($self) if $mref;
380 # add this station to the user database, if required (don't remove SSID from nodes)
381 my $user = DXUser->get_current($call);
383 $user = DXUser->new($call);
385 $user->priv(1); # I have relented and defaulted nodes
386 $self->{priv} = 1; # to user RCMDs allowed
387 $user->homenode($call);
390 $user->lastin($main::systime);
394 # queue up any messages
395 DXMsg::queue_msg(0) if $self->state eq 'normal';
399 if ($pcno == 20) { # send local configuration
400 $self->send_local_config();
402 $self->state('normal');
409 if ($pcno == 21) { # delete a cluster from the list
410 my $call = uc $field[1];
411 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
412 my $ref = DXCluster->get_exact($call);
419 $self->state('normal');
426 if ($pcno == 23 || $pcno == 27) { # WWV info
428 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
429 my $sfi = unpad($field[3]);
430 my $k = unpad($field[4]);
431 my $i = unpad($field[5]);
432 my $dupkey = "$d.$sfi$k$i";
433 if ($wwvdup{$dupkey}) {
434 dbg('chan', "Dup WWV Spot ignored\n");
437 if ($d > $main::systime + 900 || $field[2] < 0 || $field[2] > 23) {
438 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
441 $wwvdup{$dupkey} = $d;
442 $field[6] =~ s/-\d+$//o; # remove spotter's ssid
444 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..$#field]);
448 $r = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
450 # dbg('local', "Local::wwv2 error $@") if $@;
453 # DON'T be silly and send on PC27s!
454 return if $pcno == 27;
456 # broadcast to the eager users
457 broadcast_users("WWV de $field[7] <$field[2]>: SFI=$sfi, A=$k, K=$i, $field[6]", 'wwv', $wwv );
461 if ($pcno == 24) { # set here status
462 my $call = uc $field[1];
463 my $ref = DXCluster->get_exact($call);
464 $ref->here($field[2]) if $ref;
468 if ($pcno == 25) { # merge request
469 unless ($field[1] eq $main::mycall) {
470 dbg('chan', "merge request to $field[1] from $field[2] ignored");
474 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
478 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
481 $self->send(pc26(@{$in}[0..4], $in->[7]));
487 my @in = reverse Geomag::search(0, $field[4], time, 1);
490 $self->send(pc27(@{$in}));
496 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
497 DXMsg::process($self, $line);
501 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
502 if ($field[1] eq $main::mycall) {
503 my $ref = DXUser->get_current($field[2]);
504 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
505 unless ($field[3] =~ /rcmd/i) { # not allowed to relay RCMDS!
506 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
507 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
508 my @in = (DXCommandmode::run_cmd($self, $field[3]));
511 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
512 Log('rcmd', 'out', $field[2], $_);
514 delete $self->{remotecmd};
517 $self->send(pc35($main::mycall, $field[2], "$main::mycall:Tut tut tut...!"));
520 route($field[1], $line);
525 if ($pcno == 35) { # remote command replies
526 if ($field[1] eq $main::mycall) {
527 my $s = $rcmds{$field[2]};
529 my $dxchan = DXChannel->get($s->{call});
530 $dxchan->send($field[3]) if $dxchan;
531 delete $rcmds{$field[2]} if !$dxchan;
534 route($field[1], $line);
543 if ($pcno == 38) { # node connected list from neighbour
547 if ($pcno == 39) { # incoming disconnect
552 if ($pcno == 41) { # user info
553 # add this station to the user database, if required
554 my $user = DXUser->get_current($field[1]);
556 # then try without an SSID
557 $field[1] =~ s/-\d+$//o;
558 $user = DXUser->get_current($field[1]);
560 $user = DXUser->new($field[1]) if !$user;
562 if ($field[2] == 1) {
563 $user->name($field[3]);
564 } elsif ($field[2] == 2) {
565 $user->qth($field[3]);
566 } elsif ($field[2] == 3) {
567 my ($lat, $long) = DXBearing::stoll($field[3]);
570 } elsif ($field[2] == 4) {
571 $user->homenode($field[3]);
595 if ($pcno == 50) { # keep alive/user list
596 my $ref = DXCluster->get_exact($field[1]);
597 $ref->update_users($field[2]) if $ref;
601 if ($pcno == 51) { # incoming ping requests/answers
604 if ($field[1] eq $main::mycall) {
605 my $flag = $field[3];
607 $self->send(pc51($field[2], $field[1], '0'));
609 # it's a reply, look in the ping list for this one
610 my $ref = $pings{$field[2]};
613 my $dxchan = DXChannel->get($r->{call});
614 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
619 # route down an appropriate thingy
620 route($field[1], $line);
626 # if get here then rebroadcast the thing with its Hop count decremented (if
627 # there is one). If it has a hop count and it decrements to zero then don't
630 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
634 if (!$self->{isolate}) {
635 broadcast_ak1a($line, $self); # send it to everyone but me
640 # This is called from inside the main cluster processing loop and is used
641 # for despatching commands that are doing some long processing job
646 my @dxchan = DXChannel->get_all();
649 foreach $dxchan (@dxchan) {
650 next unless $dxchan->is_ak1a();
651 next if $dxchan == $me;
653 # send a pc50 out on this channel
654 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
655 $dxchan->send(pc50());
663 if ($main::systime - 3600 > $last_hour) {
664 $cutoff = $main::systime - $pc11_dup_age;
665 while (($key, $val) = each %spotdup) {
666 delete $spotdup{$key} if $val < $cutoff;
668 $cutoff = $main::systime - $pc23_dup_age;
669 while (($key, $val) = each %wwvdup) {
670 delete $wwvdup{$key} if $val < $cutoff;
672 $last_hour = $main::systime;
677 # finish up a pc context
682 my $call = $self->call;
683 my $ref = DXCluster->get_exact($call);
685 # unbusy and stop and outgoing mail
686 my $mref = DXMsg::get_busy($call);
687 $mref->stop_msg($self) if $mref;
689 # broadcast to all other nodes that all the nodes connected to via me are gone
690 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
693 foreach $node (@gonenodes) {
694 next if $node->call eq $call;
695 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
699 # remove outstanding pings
700 delete $pings{$call};
702 # now broadcast to all other ak1a nodes that I have gone
703 broadcast_ak1a(pc21($call, 'Gone.'), $self);
705 Log('DXProt', $call . " Disconnected");
710 # some active measures
713 sub send_local_config
720 if ($self->{isolate}) {
721 @nodes = (DXCluster->get_exact($main::mycall));
723 # create a list of all the nodes that are not connected to this connection
724 # and are not themselves isolated, this to make sure that isolated nodes
725 # don't appear outside of this node
726 @nodes = DXNode::get_all();
727 @nodes = grep { $_->dxchan != $self } @nodes;
728 @nodes = grep { !($_->dxchan && $_->dxchan->isolate) } @nodes;
731 my @s = $me->pc19(@nodes);
733 my $routeit = adjust_hops($self, $_);
734 $self->send($routeit) if $routeit;
737 # get all the users connected on the above nodes and send them out
738 foreach $n (@nodes) {
739 my @users = values %{$n->list};
740 my @s = pc16($n, @users);
742 my $routeit = adjust_hops($self, $_);
743 $self->send($routeit) if $routeit;
749 # route a message down an appropriate interface for a callsign
751 # is called route(to, pcline);
755 my ($call, $line) = @_;
756 my $cl = DXCluster->get_exact($call);
759 my $dxchan = $cl->{dxchan};
761 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
763 $dxchan->send($routeit) if $dxchan;
769 # broadcast a message to all clusters [except those mentioned after buffer]
772 my $s = shift; # the line to be rebroadcast
773 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
774 my @dxchan = get_all_ak1a();
777 # send it if it isn't the except list and isn't isolated and still has a hop count
778 foreach $dxchan (@dxchan) {
779 next if grep $dxchan == $_, @except;
780 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
781 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
785 # broadcast to all users
786 # storing the spot or whatever until it is in a state to receive it
789 my $s = shift; # the line to be rebroadcast
790 my $sort = shift; # the type of transmission
791 my $fref = shift; # a reference to an object to filter on
792 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
793 my @dxchan = get_all_users();
797 foreach $dxchan (@dxchan) {
798 next if grep $dxchan == $_, @except;
801 broadcast_list($s, $sort, $fref, @out);
804 # broadcast to a list of users
812 foreach $dxchan (@_) {
816 next unless $dxchan->{dx};
817 ($filter) = Filter::it($dxchan->{spotfilter}, @{$fref}) if ref $fref;
820 next if $sort eq 'ann' && !$dxchan->{ann};
821 next if $sort eq 'wwv' && !$dxchan->{wwv};
822 next if $sort eq 'wx' && !$dxchan->{wx};
824 $s =~ s/\a//og unless $dxchan->{beep};
826 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
835 # gimme all the ak1a nodes
839 my @list = DXChannel->get_all();
842 foreach $ref (@list) {
843 push @out, $ref if $ref->is_ak1a;
848 # return a list of all users
851 my @list = DXChannel->get_all();
854 foreach $ref (@list) {
855 push @out, $ref if $ref->is_user;
860 # return a list of all user callsigns
861 sub get_all_user_calls
863 my @list = DXChannel->get_all();
866 foreach $ref (@list) {
867 push @out, $ref->call if $ref->is_user;
873 # obtain the hops from the list for this callsign and pc no
879 my $hops = $DXProt::hopcount{$pcno};
880 $hops = $DXProt::def_hopcount if !$hops;
885 # adjust the hop count on a per node basis using the user loadable
886 # hop table if available or else decrement an existing one
893 my $call = $self->{call};
896 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
897 my ($pcno) = $s =~ /^PC(\d\d)/o;
898 confess "$call called adjust_hops with '$s'" unless $pcno;
899 my $ref = $nodehops{$call} if %nodehops;
901 my $newhops = $ref->{$pcno};
902 return "" if defined $newhops && $newhops == 0;
903 $newhops = $ref->{default} unless $newhops;
904 return "" if defined $newhops && $newhops == 0;
905 $newhops = $hops if !$newhops;
906 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
908 # simply decrement it
911 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
923 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
924 do "$main::data/hop_table.pl";
929 # remove leading and trailing spaces from an input string
937 # add a ping request to the ping queues
940 my ($from, $to) = @_;
941 my $ref = $pings{$to};
942 $ref = $pings{$to} = [] if !$ref;
945 $r->{t} = $main::systime;
946 route($to, pc51($to, $main::mycall, 1));
950 # add a rcmd request to the rcmd queues
953 my ($from, $to, $cmd) = @_;
956 $r->{t} = $main::systime;
958 route($to, pc34($main::mycall, $to, $cmd));