3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
27 use vars qw($me $pc11_max_age $pc11_dup_age %dup $last_hour %pings %rcmds);
29 $me = undef; # the channel id for this cluster
30 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
31 $pc11_dup_age = 24*3600; # the maximum time to keep the dup list for
32 %dup = (); # the pc11 and 26 dup hash
33 $last_hour = time; # last time I did an hourly periodic update
34 %pings = (); # outstanding ping requests outbound
35 %rcmds = (); # outstanding rcmd requests outbound
39 my $user = DXUser->get($main::mycall);
40 $me = DXProt->new($main::mycall, undef, $user);
42 # $me->{sort} = 'M'; # M for me
46 # obtain a new connection this is derived from dxchannel
51 my $self = DXChannel::alloc(@_);
52 $self->{sort} = 'A'; # in absence of how to find out what sort of an object I am
56 # this is how a pc connection starts (for an incoming connection)
57 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
58 # all the crap that comes between).
61 my ($self, $line, $sort) = @_;
62 my $call = $self->{call};
63 my $user = $self->{user};
65 # remember type of connection
66 $self->{consort} = $line;
67 $self->{outbound} = $sort eq 'O';
68 $self->{priv} = $user->priv;
69 $self->{lang} = $user->lang;
70 $self->{consort} = $line; # save the connection type
74 $self->send_now('B',"0");
76 # send initialisation string
77 if (!$self->{outbound}) {
78 $self->send(pc38()) if DXNode->get_all();
84 Log('DXProt', "$call connected");
88 # This is the normal pcxx despatcher
92 my ($self, $line) = @_;
93 my @field = split /[\^\~]/, $line;
95 # ignore any lines that don't start with PC
96 return if !$field[0] =~ /^PC/;
99 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
100 return if $pcno < 10 || $pcno > 51;
103 if ($pcno == 10) { # incoming talk
105 # is it for me or one of mine?
106 my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
107 if ($call eq $main::mycall || grep $_ eq $call, get_all_user_calls()) {
110 my $text = unpad($field[3]);
111 Log('talk', $call, $field[1], $field[6], $text);
112 $call = $main::myalias if $call eq $main::mycall;
113 my $ref = DXChannel->get($call);
114 $ref->send("$call de $field[1]: $text") if $ref;
116 route($field[2], $line); # relay it on its way
121 if ($pcno == 11 || $pcno == 26) { # dx spot
123 # if this is a 'nodx' node then ignore it
124 last SWITCH if grep $field[7] =~ /^$_/, @DXProt::nodx_node;
126 # convert the date to a unix date
127 my $d = cltounix($field[3], $field[4]);
128 return if !$d || ($pcno == 11 && $d < $main::systime - $pc11_max_age); # bang out (and don't pass on) if date is invalid or the spot is too old
130 # strip off the leading & trailing spaces from the comment
131 my $text = unpad($field[5]);
134 my $spotter = $field[6];
135 $spotter =~ s/-\d+$//o; # strip off the ssid from the spotter
138 my $dupkey = "$field[1]$field[2]$d$text$field[6]";
139 return if $dup{$dupkey};
142 my $spot = Spot::add($field[1], $field[2], $d, $text, $spotter);
144 # send orf to the users
145 if ($spot && $pcno == 11) {
146 my $buf = Spot::formatb($field[1], $field[2], $d, $text, $spotter);
147 broadcast_users("$buf\a\a");
153 if ($pcno == 12) { # announces
155 if ($field[2] eq '*' || $field[2] eq $main::mycall) {
157 # strip leading and trailing stuff
158 my $text = unpad($field[3]);
163 if ($field[4] eq '*') { # sysops
165 @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
166 } elsif ($field[4] gt ' ') { # speciality list handling
167 my ($name) = split /\./, $field[4];
168 $target = "$name"; # put the rest in later (if bothered)
171 if ($field[6] eq '1') {
175 $target = "All" if !$target;
178 broadcast_list("$to$target de $field[1]: $text", @list);
180 broadcast_users("$target de $field[1]: $text");
182 Log('ann', $target, $field[1], $text);
184 return if $field[2] eq $main::mycall; # it's routed to me
186 route($field[2], $line);
187 return; # only on a routed one
203 if ($pcno == 16) { # add a user
204 my $node = DXCluster->get_exact($field[1]);
205 last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
208 for ($i = 2; $i < $#field; $i++) {
209 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (-) (\d)/o;
210 next if length $call < 3;
213 next if DXCluster->get_exact($call); # we already have this (loop?)
215 $confmode = $confmode eq '*';
216 DXNodeuser->new($self, $node, $call, $confmode, $here);
218 # add this station to the user database, if required
219 $call =~ s/-\d+$//o; # remove ssid for users
220 my $user = DXUser->get_current($call);
221 $user = DXUser->new($call) if !$user;
222 $user->node($node->call);
223 $user->lastin($main::systime);
224 $user->homenode($node->call) if !$user->homenode;
228 # queue up any messages (look for privates only)
229 DXMsg::queue_msg(1) if $self->state eq 'normal';
233 if ($pcno == 17) { # remove a user
235 my $ref = DXCluster->get_exact($field[1]);
240 if ($pcno == 18) { # link request
241 $self->send_local_config();
243 $self->state('init');
247 if ($pcno == 19) { # incoming cluster list
249 for ($i = 1; $i < $#field-1; $i += 4) {
250 my $here = $field[$i];
251 my $call = uc $field[$i+1];
252 my $confmode = $field[$i+2] eq '*';
253 my $ver = $field[$i+3];
255 # now check the call over
256 next if DXCluster->get_exact($call); # we already have this
258 # check for sane parameters
259 next if $ver < 5000; # only works with version 5 software
260 next if length $call < 3; # min 3 letter callsigns
261 DXNode->new($self, $call, $confmode, $here, $ver);
263 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
264 my $mref = DXMsg::get_busy($call);
265 $mref->stop_msg($self) if $mref;
267 # add this station to the user database, if required (don't remove SSID from nodes)
268 my $user = DXUser->get_current($call);
270 $user = DXUser->new($call);
273 $user->homenode($call);
274 $user->lastin($main::systime);
279 # queue up any messages
280 DXMsg::queue_msg() if $self->state eq 'normal';
284 if ($pcno == 20) { # send local configuration
285 $self->send_local_config();
287 $self->state('normal');
294 if ($pcno == 21) { # delete a cluster from the list
295 my $call = uc $field[1];
296 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
297 my $ref = DXCluster->get_exact($call);
304 $self->state('normal');
311 if ($pcno == 23 || $pcno == 27) { # WWV info
312 Geomag::update(@field[1..$#field]);
316 if ($pcno == 24) { # set here status
317 my $call = uc $field[1];
318 my $ref = DXCluster->get_exact($call);
319 $ref->here($field[2]) if $ref;
327 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42) { # mail/file handling
328 DXMsg::process($self, $line);
332 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
333 if ($field[1] eq $main::mycall) {
334 my $ref = DXUser->get_current($field[2]);
335 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
336 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
337 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
338 my @in = (DXCommandmode::run_cmd($self, $field[3]));
341 $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
342 Log('rcmd', 'out', $field[2], $_);
344 delete $self->{remotecmd};
347 route($field[1], $line);
352 if ($pcno == 35) { # remote command replies
353 if ($field[1] eq $main::mycall) {
354 my $s = $rcmds{$field[2]};
356 my $dxchan = DXChannel->get($s->{call});
357 $dxchan->send($field[3]) if $dxchan;
358 delete $rcmds{$field[2]} if !$dxchan;
361 route($field[1], $line);
370 if ($pcno == 38) { # node connected list from neighbour
374 if ($pcno == 39) { # incoming disconnect
379 if ($pcno == 41) { # user info
380 # add this station to the user database, if required
381 my $user = DXUser->get_current($field[1]);
383 # then try without an SSID
384 $field[1] =~ s/-\d+$//o;
385 $user = DXUser->get_current($field[1]);
387 $user = DXUser->new($field[1]) if !$user;
389 if ($field[2] == 1) {
390 $user->name($field[3]);
391 } elsif ($field[2] == 2) {
392 $user->qth($field[3]);
393 } elsif ($field[2] == 3) {
394 my ($lat, $long) = DXBearing::stoll($field[3]);
397 } elsif ($field[2] == 4) {
398 $user->homenode($field[3]);
425 if ($pcno == 50) { # keep alive/user list
426 my $ref = DXCluster->get_exact($field[1]);
427 $ref->update_users($field[2]) if $ref;
431 if ($pcno == 51) { # incoming ping requests/answers
434 if ($field[1] eq $main::mycall) {
435 my $flag = $field[3];
437 $self->send(pc51($field[2], $field[1], '0'));
439 # it's a reply, look in the ping list for this one
440 my $ref = $pings{$field[2]};
443 my $dxchan = DXChannel->get($r->{call});
444 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
449 # route down an appropriate thingy
450 route($field[1], $line);
456 # if get here then rebroadcast the thing with its Hop count decremented (if
457 # there is one). If it has a hop count and it decrements to zero then don't
460 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
465 if (($hops) = $line =~ /H(\d+)\^\~?$/o) {
466 my $newhops = $hops - 1;
468 $line =~ s/\^H$hops(\^\~?)$/\^H$newhops$1/; # change the hop count
469 broadcast_ak1a($line, $self); # send it to everyone but me
475 # This is called from inside the main cluster processing loop and is used
476 # for despatching commands that are doing some long processing job
481 my @chan = DXChannel->get_all();
484 foreach $chan (@chan) {
485 next if !$chan->is_ak1a();
487 # send a pc50 out on this channel
488 if ($t >= $chan->pc50_t + $DXProt::pc50_interval) {
497 if ($main::systime - 3600 > $last_hour) {
498 $cutoff = $main::systime - $pc11_dup_age;
499 while (($key, $val) = each %dup) {
500 delete $dup{$key} if $val < $cutoff;
502 $last_hour = $main::systime;
507 # finish up a pc context
512 my $call = $self->call;
513 my $ref = DXCluster->get_exact($call);
515 # unbusy and stop and outgoing mail
516 my $mref = DXMsg::get_busy($call);
517 $mref->stop_msg($self) if $mref;
519 # broadcast to all other nodes that all the nodes connected to via me are gone
520 my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
523 foreach $node (@gonenodes) {
524 next if $node->call eq $call;
525 broadcast_ak1a(pc21($node->call, 'Gone'), $self); # done like this 'cos DXNodes don't have a pc21 method
529 # remove outstanding pings
530 delete $pings{$call};
532 # now broadcast to all other ak1a nodes that I have gone
533 broadcast_ak1a(pc21($call, 'Gone.'), $self);
535 Log('DXProt', $call . " Disconnected");
540 # some active measures
543 sub send_local_config
549 my @nodes = DXNode::get_all();
551 # create a list of all the nodes that are not connected to this connection
552 @nodes = grep { $_->dxchan != $self } @nodes;
553 $self->send($me->pc19(@nodes));
555 # get all the users connected on the above nodes and send them out
556 foreach $n (@nodes) {
557 my @users = values %{$n->list};
558 $self->send(DXProt::pc16($n, @users));
563 # route a message down an appropriate interface for a callsign
565 # is called route(to, pcline);
569 my ($call, $line) = @_;
570 my $cl = DXCluster->get_exact($call);
573 my $dxchan = $cl->{dxchan};
574 if (($hops) = $line =~ /H(\d+)\^\~?$/o) {
575 my $newhops = $hops - 1;
577 $line =~ s/\^H$hops(\^\~?)$/\^H$newhops$1/; # change the hop count
578 $dxchan->send($line) if $dxchan;
581 $dxchan->send($line) if $dxchan; # for them wot don't have Hops
586 # broadcast a message to all clusters [except those mentioned after buffer]
589 my $s = shift; # the line to be rebroadcast
590 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
591 my @chan = get_all_ak1a();
594 foreach $chan (@chan) {
595 next if grep $chan == $_, @except;
596 $chan->send($s); # send it if it isn't the except list
600 # broadcast to all users
603 my $s = shift; # the line to be rebroadcast
604 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
605 my @chan = get_all_users();
608 foreach $chan (@chan) {
609 next if grep $chan == $_, @except;
610 $s =~ s/\a//og if !$chan->{beep};
611 $chan->send($s); # send it if it isn't the except list
615 # broadcast to a list of users
622 $chan->send($s); # send it
627 # gimme all the ak1a nodes
631 my @list = DXChannel->get_all();
634 foreach $ref (@list) {
635 push @out, $ref if $ref->is_ak1a;
640 # return a list of all users
643 my @list = DXChannel->get_all();
646 foreach $ref (@list) {
647 push @out, $ref if $ref->is_user;
652 # return a list of all user callsigns
653 sub get_all_user_calls
655 my @list = DXChannel->get_all();
658 foreach $ref (@list) {
659 push @out, $ref->call if $ref->is_user;
665 # obtain the hops from the list for this callsign and pc no
671 my $hops = $DXProt::hopcount{$pcno};
672 $hops = $DXProt::def_hopcount if !$hops;
676 # remove leading and trailing spaces from an input string
684 # add a ping request to the ping queues
687 my ($from, $to) = @_;
688 my $ref = $pings{$to};
689 $ref = $pings{$to} = [] if !$ref;
692 $r->{t} = $main::systime;
693 route($to, pc51($to, $main::mycall, 1));
697 # add a rcmd request to the rcmd queues
700 my ($from, $to, $cmd) = @_;
703 $r->{t} = $main::systime;
705 route($to, pc34($main::mycall, $to, $cmd));