3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
28 use vars qw($me $pc11_max_age $pc11_dup_age $pc23_dup_age %spotdup %wwvdup $last_hour %pings %rcmds %nodehops);
30 $me = undef; # the channel id for this cluster
31 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
32 $pc11_dup_age = 24*3600; # the maximum time to keep the spot dup list for
33 $pc23_dup_age = 24*3600; # the maximum time to keep the wwv dup list for
34 %spotdup = (); # the pc11 and 26 dup hash
35 %wwvdup = (); # the pc23 and 27 dup hash
36 $last_hour = time; # last time I did an hourly periodic update
37 %pings = (); # outstanding ping requests outbound
38 %rcmds = (); # outstanding rcmd requests outbound
39 %nodehops = (); # node specific hop control
44 my $user = DXUser->get($main::mycall);
45 $DXProt::myprot_version += $main::version*100;
46 $me = DXProt->new($main::mycall, 0, $user);
48 $me->{state} = "indifferent";
49 do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
51 # $me->{sort} = 'M'; # M for me
53 # now prime the spot duplicates file with today's and yesterday's data
54 my @today = Julian::unixtoj(time);
55 my @spots = Spot::readfile(@today);
56 @today = Julian::sub(@today, 1);
57 push @spots, Spot::readfile(@today);
59 my $dupkey = "$_->[0]$_->[1]$_->[2]$_->[3]$_->[4]";
60 $spotdup{$dupkey} = $_->[2];
63 # now prime the wwv duplicates file with just this month's data
64 my @wwv = Geomag::readfile(time);
66 my $dupkey = "$_->[1].$_->[2]$_->[3]$_->[4]";
67 $wwvdup{$dupkey} = $_->[1];
73 # obtain a new connection this is derived from dxchannel
78 my $self = DXChannel::alloc(@_);
79 $self->{'sort'} = 'A'; # in absence of how to find out what sort of an object I am
83 # this is how a pc connection starts (for an incoming connection)
84 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
85 # all the crap that comes between).
88 my ($self, $line, $sort) = @_;
89 my $call = $self->{call};
90 my $user = $self->{user};
92 # remember type of connection
93 $self->{consort} = $line;
94 $self->{outbound} = $sort eq 'O';
95 $self->{priv} = $user->priv;
96 $self->{lang} = $user->lang;
97 $self->{isolate} = $user->{isolate};
98 $self->{consort} = $line; # save the connection type
102 $self->send_now('B',"0");
104 # send initialisation string
105 if (!$self->{outbound}) {
106 $self->send(pc38()) if DXNode->get_all();
109 $self->state('init');
112 Log('DXProt', "$call connected");
116 # This is the normal pcxx despatcher
120 my ($self, $line) = @_;
121 my @field = split /[\^\~]/, $line;
123 # ignore any lines that don't start with PC
124 return if !$field[0] =~ /^PC/;
127 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
129 return if $pcno < 10 || $pcno > 51;
132 if ($pcno == 10) { # incoming talk
134 # is it for me or one of mine?
135 my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
136 if ($call eq $main::mycall || grep $_ eq $call, get_all_user_calls()) {
139 my $text = unpad($field[3]);
140 Log('talk', $call, $field[1], $field[6], $text);
141 $call = $main::myalias if $call eq $main::mycall;
142 my $ref = DXChannel->get($call);
143 $ref->send("$call de $field[1]: $text") if $ref;
145 route($field[2], $line); # relay it on its way
150 if ($pcno == 11 || $pcno == 26) { # dx spot
152 # if this is a 'nodx' node then ignore it
153 last SWITCH if grep $field[7] =~ /^$_/, @DXProt::nodx_node;
155 # convert the date to a unix date
156 my $d = cltounix($field[3], $field[4]);
157 # bang out (and don't pass on) if date is invalid or the spot is too old
158 if (!$d || ($pcno == 11 && $d < $main::systime - $pc11_max_age)) {
159 dbg('chan', "Spot ignored, invalid date or too old\n");
163 # strip off the leading & trailing spaces from the comment
164 my $text = unpad($field[5]);
167 my $spotter = $field[6];
168 $spotter =~ s/-\d+$//o; # strip off the ssid from the spotter
171 my $freq = $field[1] - 0;
172 my $dupkey = "$freq$field[2]$d$text$spotter";
173 if ($spotdup{$dupkey}) {
174 dbg('chan', "Duplicate Spot ignored\n");
178 $spotdup{$dupkey} = $d;
180 my $spot = Spot::add($freq, $field[2], $d, $text, $spotter, $field[7]);
182 # send orf to the users
183 if ($spot && $pcno == 11) {
184 my $buf = Spot::formatb($field[1], $field[2], $d, $text, $spotter);
185 broadcast_users("$buf\a\a");
188 # DON'T be silly and send on PC26s!
189 return if $pcno == 26;
194 if ($pcno == 12) { # announces
196 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
198 # strip leading and trailing stuff
199 my $text = unpad($field[3]);
204 if ($field[4] eq '*') { # sysops
206 @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
207 } elsif ($field[4] gt ' ') { # speciality list handling
208 my ($name) = split /\./, $field[4];
209 $target = "$name"; # put the rest in later (if bothered)
212 if ($field[6] eq '1') {
216 $target = "All" if !$target;
219 broadcast_list("$to$target de $field[1]: $text", @list);
221 broadcast_users("$target de $field[1]: $text");
223 Log('ann', $target, $field[1], $text);
225 return if $field[2] eq $main::mycall; # it's routed to me
227 route($field[2], $line);
228 return; # only on a routed one
244 if ($pcno == 16) { # add a user
245 my $node = DXCluster->get_exact($field[1]);
246 last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
247 last SWITCH unless $node->isa('DXNode');
251 for ($i = 2; $i < $#field; $i++) {
252 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
253 next if length $call < 3 || length $call > 8;
256 next if DXCluster->get_exact($call); # we already have this (loop?)
258 $confmode = $confmode eq '*';
259 DXNodeuser->new($self, $node, $call, $confmode, $here);
261 # add this station to the user database, if required
262 $call =~ s/-\d+$//o; # remove ssid for users
263 my $user = DXUser->get_current($call);
264 $user = DXUser->new($call) if !$user;
265 $user->homenode($node->call) if !$user->homenode;
266 $user->node($node->call);
267 $user->lastin($main::systime);
271 # queue up any messages (look for privates only)
272 DXMsg::queue_msg(1) if $self->state eq 'normal';
276 if ($pcno == 17) { # remove a user
278 my $ref = DXCluster->get_exact($field[1]);
283 if ($pcno == 18) { # link request
284 $self->send_local_config();
286 $self->state('init');
287 return; # we don't pass these on
290 if ($pcno == 19) { # incoming cluster list
292 for ($i = 1; $i < $#field-1; $i += 4) {
293 my $here = $field[$i];
294 my $call = uc $field[$i+1];
295 my $confmode = $field[$i+2] eq '*';
296 my $ver = $field[$i+3];
298 # now check the call over
299 next if DXCluster->get_exact($call); # we already have this
301 # check for sane parameters
302 next if $ver < 5000; # only works with version 5 software
303 next if length $call < 3; # min 3 letter callsigns
304 DXNode->new($self, $call, $confmode, $here, $ver);
306 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
307 my $mref = DXMsg::get_busy($call);
308 $mref->stop_msg($self) if $mref;
310 # add this station to the user database, if required (don't remove SSID from nodes)
311 my $user = DXUser->get_current($call);
313 $user = DXUser->new($call);
315 $user->priv(1); # I have relented and defaulted nodes
316 $self->{priv} = 1; # to user RCMDs allowed
317 $user->homenode($call);
320 $user->lastin($main::systime);
324 # queue up any messages
325 DXMsg::queue_msg(0) if $self->state eq 'normal';
329 if ($pcno == 20) { # send local configuration
330 $self->send_local_config();
332 $self->state('normal');
339 if ($pcno == 21) { # delete a cluster from the list
340 my $call = uc $field[1];
341 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
342 my $ref = DXCluster->get_exact($call);
349 $self->state('normal');
356 if ($pcno == 23 || $pcno == 27) { # WWV info
358 my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
359 my $sfi = unpad($field[3]);
360 my $k = unpad($field[4]);
361 my $i = unpad($field[5]);
362 my $dupkey = "$d.$sfi$k$i";
363 if ($wwvdup{$dupkey}) {
364 dbg('chan', "Dup WWV Spot ignored\n");
368 $wwvdup{$dupkey} = $d;
369 Geomag::update($field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
371 # DON'T be silly and send on PC27s!
372 return if $pcno == 27;
377 if ($pcno == 24) { # set here status
378 my $call = uc $field[1];
379 my $ref = DXCluster->get_exact($call);
380 $ref->here($field[2]) if $ref;
384 if ($pcno == 25) { # merge request
385 unless ($field[1] eq $main::mycall) {
386 dbg('chan', "merge request to $field[1] from $field[2] ignored");
390 Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
394 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
397 $self->send(pc26(@{$in}[0..4], $in->[7]));
403 my @in = reverse Geomag::search(0, $field[4], time, 1);
406 $self->send(pc27(@{$in}));
412 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
413 DXMsg::process($self, $line);
417 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
418 if ($field[1] eq $main::mycall) {
419 my $ref = DXUser->get_current($field[2]);
420 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
421 unless ($field[3] =~ /rcmd/i) { # not allowed to relay RCMDS!
422 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
423 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
424 my @in = (DXCommandmode::run_cmd($self, $field[3]));
427 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
428 Log('rcmd', 'out', $field[2], $_);
430 delete $self->{remotecmd};
433 $self->send(pc35($main::mycall, $field[2], "$main::mycall:Tut tut tut...!"));
436 route($field[1], $line);
441 if ($pcno == 35) { # remote command replies
442 if ($field[1] eq $main::mycall) {
443 my $s = $rcmds{$field[2]};
445 my $dxchan = DXChannel->get($s->{call});
446 $dxchan->send($field[3]) if $dxchan;
447 delete $rcmds{$field[2]} if !$dxchan;
450 route($field[1], $line);
459 if ($pcno == 38) { # node connected list from neighbour
463 if ($pcno == 39) { # incoming disconnect
468 if ($pcno == 41) { # user info
469 # add this station to the user database, if required
470 my $user = DXUser->get_current($field[1]);
472 # then try without an SSID
473 $field[1] =~ s/-\d+$//o;
474 $user = DXUser->get_current($field[1]);
476 $user = DXUser->new($field[1]) if !$user;
478 if ($field[2] == 1) {
479 $user->name($field[3]);
480 } elsif ($field[2] == 2) {
481 $user->qth($field[3]);
482 } elsif ($field[2] == 3) {
483 my ($lat, $long) = DXBearing::stoll($field[3]);
486 } elsif ($field[2] == 4) {
487 $user->homenode($field[3]);
511 if ($pcno == 50) { # keep alive/user list
512 my $ref = DXCluster->get_exact($field[1]);
513 $ref->update_users($field[2]) if $ref;
517 if ($pcno == 51) { # incoming ping requests/answers
520 if ($field[1] eq $main::mycall) {
521 my $flag = $field[3];
523 $self->send(pc51($field[2], $field[1], '0'));
525 # it's a reply, look in the ping list for this one
526 my $ref = $pings{$field[2]};
529 my $dxchan = DXChannel->get($r->{call});
530 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
535 # route down an appropriate thingy
536 route($field[1], $line);
542 # if get here then rebroadcast the thing with its Hop count decremented (if
543 # there is one). If it has a hop count and it decrements to zero then don't
546 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
550 if (!$self->{isolate}) {
551 broadcast_ak1a($line, $self); # send it to everyone but me
556 # This is called from inside the main cluster processing loop and is used
557 # for despatching commands that are doing some long processing job
562 my @dxchan = DXChannel->get_all();
565 foreach $dxchan (@dxchan) {
566 next unless $dxchan->is_ak1a();
567 next if $dxchan == $me;
569 # send a pc50 out on this channel
570 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
571 $dxchan->send(pc50());
579 if ($main::systime - 3600 > $last_hour) {
580 $cutoff = $main::systime - $pc11_dup_age;
581 while (($key, $val) = each %spotdup) {
582 delete $spotdup{$key} if $val < $cutoff;
584 $cutoff = $main::systime - $pc23_dup_age;
585 while (($key, $val) = each %wwvdup) {
586 delete $wwvdup{$key} if $val < $cutoff;
588 $last_hour = $main::systime;
593 # finish up a pc context
598 my $call = $self->call;
599 my $ref = DXCluster->get_exact($call);
601 # unbusy and stop and outgoing mail
602 my $mref = DXMsg::get_busy($call);
603 $mref->stop_msg($self) if $mref;
605 # broadcast to all other nodes that all the nodes connected to via me are gone
606 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
609 foreach $node (@gonenodes) {
610 next if $node->call eq $call;
611 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
615 # remove outstanding pings
616 delete $pings{$call};
618 # now broadcast to all other ak1a nodes that I have gone
619 broadcast_ak1a(pc21($call, 'Gone.'), $self);
621 Log('DXProt', $call . " Disconnected");
626 # some active measures
629 sub send_local_config
636 if ($self->{isolate}) {
637 @nodes = (DXCluster->get_exact($main::mycall));
639 # create a list of all the nodes that are not connected to this connection
640 @nodes = DXNode::get_all();
641 @nodes = grep { $_->dxchan != $self } @nodes;
644 my @s = $me->pc19(@nodes);
646 my $routeit = adjust_hops($self, $_);
647 $self->send($routeit) if $routeit;
650 # get all the users connected on the above nodes and send them out
651 foreach $n (@nodes) {
652 my @users = values %{$n->list};
653 my @s = pc16($n, @users);
655 my $routeit = adjust_hops($self, $_);
656 $self->send($routeit) if $routeit;
662 # route a message down an appropriate interface for a callsign
664 # is called route(to, pcline);
668 my ($call, $line) = @_;
669 my $cl = DXCluster->get_exact($call);
672 my $dxchan = $cl->{dxchan};
674 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
676 $dxchan->send($routeit) if $dxchan;
682 # broadcast a message to all clusters [except those mentioned after buffer]
685 my $s = shift; # the line to be rebroadcast
686 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
687 my @dxchan = get_all_ak1a();
690 # send it if it isn't the except list and isn't isolated and still has a hop count
691 foreach $dxchan (@dxchan) {
692 next if grep $dxchan == $_, @except;
693 my $routeit = adjust_hops($dxchan, $s); # adjust its hop count by node name
694 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
698 # broadcast to all users
701 my $s = shift; # the line to be rebroadcast
702 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
703 my @dxchan = get_all_users();
706 foreach $dxchan (@dxchan) {
707 next if grep $dxchan == $_, @except;
708 $s =~ s/\a//og if !$dxchan->{beep};
709 $dxchan->send($s); # send it if it isn't the except list or hasn't a passout flag
713 # broadcast to a list of users
719 foreach $dxchan (@_) {
720 $dxchan->send($s); # send it
725 # gimme all the ak1a nodes
729 my @list = DXChannel->get_all();
732 foreach $ref (@list) {
733 push @out, $ref if $ref->is_ak1a;
738 # return a list of all users
741 my @list = DXChannel->get_all();
744 foreach $ref (@list) {
745 push @out, $ref if $ref->is_user;
750 # return a list of all user callsigns
751 sub get_all_user_calls
753 my @list = DXChannel->get_all();
756 foreach $ref (@list) {
757 push @out, $ref->call if $ref->is_user;
763 # obtain the hops from the list for this callsign and pc no
769 my $hops = $DXProt::hopcount{$pcno};
770 $hops = $DXProt::def_hopcount if !$hops;
775 # adjust the hop count on a per node basis using the user loadable
776 # hop table if available or else decrement an existing one
783 my $call = $self->{call};
786 if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
787 my ($pcno) = $s =~ /^PC(\d\d)/o;
788 confess "$call called adjust_hops with '$s'" unless $pcno;
789 my $ref = $nodehops{$call} if %nodehops;
791 my $newhops = $ref->{$pcno};
792 return "" if defined $newhops && $newhops == 0;
793 $newhops = $ref->{default} unless $newhops;
794 return "" if defined $newhops && $newhops == 0;
795 $newhops = $hops if !$newhops;
796 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
798 # simply decrement it
801 $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
813 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
814 do "$main::data/hop_table.pl";
819 # remove leading and trailing spaces from an input string
827 # add a ping request to the ping queues
830 my ($from, $to) = @_;
831 my $ref = $pings{$to};
832 $ref = $pings{$to} = [] if !$ref;
835 $r->{t} = $main::systime;
836 route($to, pc51($to, $main::mycall, 1));
840 # add a rcmd request to the rcmd queues
843 my ($from, $to, $cmd) = @_;
846 $r->{t} = $main::systime;
848 route($to, pc34($main::mycall, $to, $cmd));