3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
30 use vars qw($me $pc11_max_age $pc11_dup_age $pc23_dup_age
31 %spotdup %wwvdup $last_hour %pings %rcmds
32 %nodehops @baddx $baddxfn);
34 $me = undef; # the channel id for this cluster
35 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
36 $pc11_dup_age = 24*3600; # the maximum time to keep the spot dup list for
37 $pc23_dup_age = 24*3600; # the maximum time to keep the wwv dup list for
38 %spotdup = (); # the pc11 and 26 dup hash
39 %wwvdup = (); # the pc23 and 27 dup hash
40 $last_hour = time; # last time I did an hourly periodic update
41 %pings = (); # outstanding ping requests outbound
42 %rcmds = (); # outstanding rcmd requests outbound
43 %nodehops = (); # node specific hop control
44 @baddx = (); # list of illegal spotted callsigns
46 $baddxfn = "$main::data/baddx.pl";
50 my $user = DXUser->get($main::mycall);
51 $DXProt::myprot_version += $main::version*100;
52 $me = DXProt->new($main::mycall, 0, $user);
54 $me->{state} = "indifferent";
55 do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
57 # $me->{sort} = 'M'; # M for me
59 # now prime the spot duplicates file with today's and yesterday's data
60 my @today = Julian::unixtoj(time);
61 my @spots = Spot::readfile(@today);
62 @today = Julian::sub(@today, 1);
63 push @spots, Spot::readfile(@today);
65 my $dupkey = "$_->[0]$_->[1]$_->[2]$_->[3]$_->[4]";
66 $spotdup{$dupkey} = $_->[2];
69 # now prime the wwv duplicates file with just this month's data
70 my @wwv = Geomag::readfile(time);
72 my $dupkey = "$_->[1].$_->[2]$_->[3]$_->[4]";
73 $wwvdup{$dupkey} = $_->[1];
77 do "$baddxfn" if -e "$baddxfn";
82 # obtain a new connection this is derived from dxchannel
87 my $self = DXChannel::alloc(@_);
88 $self->{'sort'} = 'A'; # in absence of how to find out what sort of an object I am
92 # this is how a pc connection starts (for an incoming connection)
93 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
94 # all the crap that comes between).
97 my ($self, $line, $sort) = @_;
98 my $call = $self->{call};
99 my $user = $self->{user};
101 # remember type of connection
102 $self->{consort} = $line;
103 $self->{outbound} = $sort eq 'O';
104 $self->{priv} = $user->priv;
105 $self->{lang} = $user->lang;
106 $self->{isolate} = $user->{isolate};
107 $self->{consort} = $line; # save the connection type
111 $self->send_now('B',"0");
113 # send initialisation string
114 if (!$self->{outbound}) {
115 $self->send(pc38()) if DXNode->get_all();
118 $self->state('init');
121 Log('DXProt', "$call connected");
125 # This is the normal pcxx despatcher
129 my ($self, $line) = @_;
130 my @field = split /\^/, $line;
131 pop @field if $field[-1] eq '~';
133 # print join(',', @field), "\n";
135 # ignore any lines that don't start with PC
136 return if !$field[0] =~ /^PC/;
139 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
141 return if $pcno < 10 || $pcno > 51;
146 $pcr = Local::pcprot($self, $pcno, @field);
148 # dbg('local', "Local::pcprot error $@") if $@;
152 if ($pcno == 10) { # incoming talk
154 # is it for me or one of mine?
155 my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
156 if ($call eq $main::mycall || grep $_ eq $call, get_all_user_calls()) {
159 my $text = unpad($field[3]);
160 Log('talk', $call, $field[1], $field[6], $text);
161 $call = $main::myalias if $call eq $main::mycall;
162 my $ref = DXChannel->get($call);
163 $ref->send("$call de $field[1]: $text") if $ref && $ref->{talk};
165 route($field[2], $line); # relay it on its way
170 if ($pcno == 11 || $pcno == 26) { # dx spot
172 # if this is a 'nodx' node then ignore it
173 last SWITCH if grep $field[7] =~ /^$_/, @DXProt::nodx_node;
175 # convert the date to a unix date
176 my $d = cltounix($field[3], $field[4]);
177 # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
178 if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
179 dbg('chan', "Spot ignored, invalid date or out of range ($field[3] $field[4])\n");
183 # strip off the leading & trailing spaces from the comment
184 my $text = unpad($field[5]);
187 my $spotter = $field[6];
188 $spotter =~ s/-\d+$//o; # strip off the ssid from the spotter
191 my $freq = $field[1] - 0;
192 my $dupkey = "$freq$field[2]$d$text$spotter";
193 if ($spotdup{$dupkey}) {
194 dbg('chan', "Duplicate Spot ignored\n");
198 $spotdup{$dupkey} = $d;
201 if (grep $field[2] eq $_, @baddx) {
202 dbg('chan', "Bad DX spot, ignored");
206 my @spot = Spot::add($freq, $field[2], $d, $text, $spotter, $field[7]);
209 # @spot at this point contains:-
210 # freq, spotted call, time, text, spotter, spotted cc, spotters cc,
211 # orig node, spotted itu, spotted cq, spotters itu, spotters cq
212 # you should be able to route on any of these
218 $r = Local::spot($self, $freq, $field[2], $d, $text, $spotter, $field[7]);
220 # dbg('local', "Local::spot1 error $@") if $@;
223 # send orf to the users
224 if (@spot && $pcno == 11) {
225 my $buf = Spot::formatb($field[1], $field[2], $d, $text, $spotter);
226 broadcast_users("$buf\a\a", 'dx', $spot[0]);
229 # DON'T be silly and send on PC26s!
230 return if $pcno == 26;
235 if ($pcno == 12) { # announces
237 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
239 # strip leading and trailing stuff
240 my $text = unpad($field[3]);
245 if ($field[4] eq '*') { # sysops
247 @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
248 } elsif ($field[4] gt ' ') { # speciality list handling
249 my ($name) = split /\./, $field[4];
250 $target = "$name"; # put the rest in later (if bothered)
253 if ($field[6] eq '1') {
257 $target = "All" if !$target;
260 broadcast_list("$to$target de $field[1]: $text", 'ann', undef, @list);
262 broadcast_users("$target de $field[1]: $text", 'ann', undef);
264 Log('ann', $target, $field[1], $text);
266 return if $field[2] eq $main::mycall; # it's routed to me
268 route($field[2], $line);
269 return; # only on a routed one
285 if ($pcno == 16) { # add a user
286 my $node = DXCluster->get_exact($field[1]);
287 last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
288 last SWITCH unless $node->isa('DXNode');
292 for ($i = 2; $i < $#field; $i++) {
293 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
294 next if !$call || length $call < 3 || length $call > 8;
297 next if DXCluster->get_exact($call); # we already have this (loop?)
299 $confmode = $confmode eq '*';
300 DXNodeuser->new($self, $node, $call, $confmode, $here);
302 # add this station to the user database, if required
303 $call =~ s/-\d+$//o; # remove ssid for users
304 my $user = DXUser->get_current($call);
305 $user = DXUser->new($call) if !$user;
306 $user->homenode($node->call) if !$user->homenode;
307 $user->node($node->call);
308 $user->lastin($main::systime);
312 # queue up any messages (look for privates only)
313 DXMsg::queue_msg(1) if $self->state eq 'normal';
317 if ($pcno == 17) { # remove a user
319 my $ref = DXCluster->get_exact($field[1]);
324 if ($pcno == 18) { # link request
325 $self->send_local_config();
327 $self->state('init');
328 return; # we don't pass these on
331 if ($pcno == 19) { # incoming cluster list
333 for ($i = 1; $i < $#field-1; $i += 4) {
334 my $here = $field[$i];
335 my $call = uc $field[$i+1];
336 my $confmode = $field[$i+2] eq '*';
337 my $ver = $field[$i+3];
339 # now check the call over
340 next if DXCluster->get_exact($call); # we already have this
342 # check for sane parameters
343 next if $ver < 5000; # only works with version 5 software
344 next if length $call < 3; # min 3 letter callsigns
345 DXNode->new($self, $call, $confmode, $here, $ver);
347 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
348 my $mref = DXMsg::get_busy($call);
349 $mref->stop_msg($self) if $mref;
351 # add this station to the user database, if required (don't remove SSID from nodes)
352 my $user = DXUser->get_current($call);
354 $user = DXUser->new($call);
356 $user->priv(1); # I have relented and defaulted nodes
357 $self->{priv} = 1; # to user RCMDs allowed
358 $user->homenode($call);
361 $user->lastin($main::systime);
365 # queue up any messages
366 DXMsg::queue_msg(0) if $self->state eq 'normal';
370 if ($pcno == 20) { # send local configuration
371 $self->send_local_config();
373 $self->state('normal');
380 if ($pcno == 21) { # delete a cluster from the list
381 my $call = uc $field[1];
382 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
383 my $ref = DXCluster->get_exact($call);
390 $self->state('normal');
397 if ($pcno == 23 || $pcno == 27) { # WWV info
399 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
400 my $sfi = unpad($field[3]);
401 my $k = unpad($field[4]);
402 my $i = unpad($field[5]);
403 my $dupkey = "$d.$sfi$k$i";
404 if ($wwvdup{$dupkey}) {
405 dbg('chan', "Dup WWV Spot ignored\n");
408 if ($d > $main::systime + 900 || $field[2] < 0 || $field[2] > 23) {
409 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
412 $wwvdup{$dupkey} = $d;
413 $field[6] =~ s/-\d+$//o; # remove spotter's ssid
415 my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..$#field]);
419 $r = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
421 # dbg('local', "Local::wwv2 error $@") if $@;
424 # DON'T be silly and send on PC27s!
425 return if $pcno == 27;
427 # broadcast to the eager users
428 broadcast_users("WWV de $field[7] <$field[2]>: SFI=$sfi, K=$k, A=$i, $field[6]", 'wwv', $wwv );
432 if ($pcno == 24) { # set here status
433 my $call = uc $field[1];
434 my $ref = DXCluster->get_exact($call);
435 $ref->here($field[2]) if $ref;
439 if ($pcno == 25) { # merge request
440 unless ($field[1] eq $main::mycall) {
441 dbg('chan', "merge request to $field[1] from $field[2] ignored");
445 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
449 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
452 $self->send(pc26(@{$in}[0..4], $in->[7]));
458 my @in = reverse Geomag::search(0, $field[4], time, 1);
461 $self->send(pc27(@{$in}));
467 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
468 DXMsg::process($self, $line);
472 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
473 if ($field[1] eq $main::mycall) {
474 my $ref = DXUser->get_current($field[2]);
475 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
476 unless ($field[3] =~ /rcmd/i) { # not allowed to relay RCMDS!
477 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
478 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
479 my @in = (DXCommandmode::run_cmd($self, $field[3]));
482 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
483 Log('rcmd', 'out', $field[2], $_);
485 delete $self->{remotecmd};
488 $self->send(pc35($main::mycall, $field[2], "$main::mycall:Tut tut tut...!"));
491 route($field[1], $line);
496 if ($pcno == 35) { # remote command replies
497 if ($field[1] eq $main::mycall) {
498 my $s = $rcmds{$field[2]};
500 my $dxchan = DXChannel->get($s->{call});
501 $dxchan->send($field[3]) if $dxchan;
502 delete $rcmds{$field[2]} if !$dxchan;
505 route($field[1], $line);
514 if ($pcno == 38) { # node connected list from neighbour
518 if ($pcno == 39) { # incoming disconnect
523 if ($pcno == 41) { # user info
524 # add this station to the user database, if required
525 my $user = DXUser->get_current($field[1]);
527 # then try without an SSID
528 $field[1] =~ s/-\d+$//o;
529 $user = DXUser->get_current($field[1]);
531 $user = DXUser->new($field[1]) if !$user;
533 if ($field[2] == 1) {
534 $user->name($field[3]);
535 } elsif ($field[2] == 2) {
536 $user->qth($field[3]);
537 } elsif ($field[2] == 3) {
538 my ($lat, $long) = DXBearing::stoll($field[3]);
541 } elsif ($field[2] == 4) {
542 $user->homenode($field[3]);
566 if ($pcno == 50) { # keep alive/user list
567 my $ref = DXCluster->get_exact($field[1]);
568 $ref->update_users($field[2]) if $ref;
572 if ($pcno == 51) { # incoming ping requests/answers
575 if ($field[1] eq $main::mycall) {
576 my $flag = $field[3];
578 $self->send(pc51($field[2], $field[1], '0'));
580 # it's a reply, look in the ping list for this one
581 my $ref = $pings{$field[2]};
584 my $dxchan = DXChannel->get($r->{call});
585 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
590 # route down an appropriate thingy
591 route($field[1], $line);
597 # if get here then rebroadcast the thing with its Hop count decremented (if
598 # there is one). If it has a hop count and it decrements to zero then don't
601 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
605 if (!$self->{isolate}) {
606 broadcast_ak1a($line, $self); # send it to everyone but me
611 # This is called from inside the main cluster processing loop and is used
612 # for despatching commands that are doing some long processing job
617 my @dxchan = DXChannel->get_all();
620 foreach $dxchan (@dxchan) {
621 next unless $dxchan->is_ak1a();
622 next if $dxchan == $me;
624 # send a pc50 out on this channel
625 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
626 $dxchan->send(pc50());
634 if ($main::systime - 3600 > $last_hour) {
635 $cutoff = $main::systime - $pc11_dup_age;
636 while (($key, $val) = each %spotdup) {
637 delete $spotdup{$key} if $val < $cutoff;
639 $cutoff = $main::systime - $pc23_dup_age;
640 while (($key, $val) = each %wwvdup) {
641 delete $wwvdup{$key} if $val < $cutoff;
643 $last_hour = $main::systime;
648 # finish up a pc context
653 my $call = $self->call;
654 my $ref = DXCluster->get_exact($call);
656 # unbusy and stop and outgoing mail
657 my $mref = DXMsg::get_busy($call);
658 $mref->stop_msg($self) if $mref;
660 # broadcast to all other nodes that all the nodes connected to via me are gone
661 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
664 foreach $node (@gonenodes) {
665 next if $node->call eq $call;
666 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
670 # remove outstanding pings
671 delete $pings{$call};
673 # now broadcast to all other ak1a nodes that I have gone
674 broadcast_ak1a(pc21($call, 'Gone.'), $self);
676 Log('DXProt', $call . " Disconnected");
681 # some active measures
684 sub send_local_config
691 if ($self->{isolate}) {
692 @nodes = (DXCluster->get_exact($main::mycall));
694 # create a list of all the nodes that are not connected to this connection
695 @nodes = DXNode::get_all();
696 @nodes = grep { $_->dxchan != $self } @nodes;
699 my @s = $me->pc19(@nodes);
701 my $routeit = adjust_hops($self, $_);
702 $self->send($routeit) if $routeit;
705 # get all the users connected on the above nodes and send them out
706 foreach $n (@nodes) {
707 my @users = values %{$n->list};
708 my @s = pc16($n, @users);
710 my $routeit = adjust_hops($self, $_);
711 $self->send($routeit) if $routeit;
717 # route a message down an appropriate interface for a callsign
719 # is called route(to, pcline);
723 my ($call, $line) = @_;
724 my $cl = DXCluster->get_exact($call);
727 my $dxchan = $cl->{dxchan};
729 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
731 $dxchan->send($routeit) if $dxchan;
737 # broadcast a message to all clusters [except those mentioned after buffer]
740 my $s = shift; # the line to be rebroadcast
741 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
742 my @dxchan = get_all_ak1a();
745 # send it if it isn't the except list and isn't isolated and still has a hop count
746 foreach $dxchan (@dxchan) {
747 next if grep $dxchan == $_, @except;
748 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
749 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
753 # broadcast to all users
754 # storing the spot or whatever until it is in a state to receive it
757 my $s = shift; # the line to be rebroadcast
758 my $sort = shift; # the type of transmission
759 my $fref = shift; # a reference to an object to filter on
760 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
761 my @dxchan = get_all_users();
765 foreach $dxchan (@dxchan) {
766 next if grep $dxchan == $_, @except;
769 broadcast_list($s, $sort, $fref, @out);
772 # broadcast to a list of users
780 foreach $dxchan (@_) {
782 next if $sort eq 'dx' && !$dxchan->{dx};
783 next if $sort eq 'ann' && !$dxchan->{ann};
784 next if $sort eq 'wwv' && !$dxchan->{wwv};
785 next if $sort eq 'wx' && !$dxchan->{wx};
787 $s =~ s/\a//og unless $dxchan->{beep};
788 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
797 # gimme all the ak1a nodes
801 my @list = DXChannel->get_all();
804 foreach $ref (@list) {
805 push @out, $ref if $ref->is_ak1a;
810 # return a list of all users
813 my @list = DXChannel->get_all();
816 foreach $ref (@list) {
817 push @out, $ref if $ref->is_user;
822 # return a list of all user callsigns
823 sub get_all_user_calls
825 my @list = DXChannel->get_all();
828 foreach $ref (@list) {
829 push @out, $ref->call if $ref->is_user;
835 # obtain the hops from the list for this callsign and pc no
841 my $hops = $DXProt::hopcount{$pcno};
842 $hops = $DXProt::def_hopcount if !$hops;
847 # adjust the hop count on a per node basis using the user loadable
848 # hop table if available or else decrement an existing one
855 my $call = $self->{call};
858 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
859 my ($pcno) = $s =~ /^PC(\d\d)/o;
860 confess "$call called adjust_hops with '$s'" unless $pcno;
861 my $ref = $nodehops{$call} if %nodehops;
863 my $newhops = $ref->{$pcno};
864 return "" if defined $newhops && $newhops == 0;
865 $newhops = $ref->{default} unless $newhops;
866 return "" if defined $newhops && $newhops == 0;
867 $newhops = $hops if !$newhops;
868 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
870 # simply decrement it
873 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
885 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
886 do "$main::data/hop_table.pl";
891 # remove leading and trailing spaces from an input string
899 # add a ping request to the ping queues
902 my ($from, $to) = @_;
903 my $ref = $pings{$to};
904 $ref = $pings{$to} = [] if !$ref;
907 $r->{t} = $main::systime;
908 route($to, pc51($to, $main::mycall, 1));
912 # add a rcmd request to the rcmd queues
915 my ($from, $to, $cmd) = @_;
918 $r->{t} = $main::systime;
920 route($to, pc34($main::mycall, $to, $cmd));