perl/DXProt.pm

   1 #!/usr/bin/perl
   2 #
   3 # This module impliments the protocal mode for a dx cluster
   4 #
   5 # Copyright (c) 1998 Dirk Koopman G1TLH
   6 #
   7 # $Id$
   8 #
   9
  10 package DXProt;
  11
  12 @ISA = qw(DXChannel);
  13
  14 use DXUtil;
  15 use DXChannel;
  16 use DXUser;
  17 use DXM;
  18 use DXCluster;
  19 use DXProtVars;
  20 use DXCommandmode;
  21 use DXLog;
  22 use Spot;
  23 use DXProtout;
  24 use DXDebug;
  25 use Filter;
  26 use Local;
  27
  28 use Carp;
  29
  30 use strict;
  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 $pc12_dup_age
  34                         %anndup);
  35
  36 $me = undef;                                    # the channel id for this cluster
  37 $pc11_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc11
  38 $pc11_dup_age = 24*3600;                # the maximum time to keep the spot dup list for
  39 $pc23_dup_age = 24*3600;                # the maximum time to keep the wwv dup list for
  40 $pc12_dup_age = 24*3600;                # the maximum time to keep the ann dup list for
  41 %spotdup = ();                              # the pc11 and 26 dup hash
  42 %wwvdup = ();                               # the pc23 and 27 dup hash
  43 %anndup = ();                               # the PC12 dup hash
  44 $last_hour = time;                              # last time I did an hourly periodic update
  45 %pings = ();                    # outstanding ping requests outbound
  46 %rcmds = ();                    # outstanding rcmd requests outbound
  47 %nodehops = ();                 # node specific hop control
  48 @baddx = ();                    # list of illegal spotted callsigns
  49
  50 $baddxfn = "$main::data/baddx.pl";
  51
  52 sub init
  53 {
  54         my $user = DXUser->get($main::mycall);
  55         $DXProt::myprot_version += $main::version*100;
  56         $me = DXProt->new($main::mycall, 0, $user);
  57         $me->{here} = 1;
  58         $me->{state} = "indifferent";
  59         do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
  60         confess $@ if $@;
  61         #  $me->{sort} = 'M';    # M for me
  62
  63         # now prime the spot duplicates file with today's and yesterday's data
  64     my @today = Julian::unixtoj(time);
  65         my @spots = Spot::readfile(@today);
  66         @today = Julian::sub(@today, 1);
  67         push @spots, Spot::readfile(@today);
  68         for (@spots) {
  69                 my $dupkey = "$_->[0]$_->[1]$_->[2]$_->[3]$_->[4]";
  70                 $spotdup{$dupkey} = $_->[2];
  71         }
  72
  73         # now prime the wwv duplicates file with just this month's data
  74         my @wwv = Geomag::readfile(time);
  75         for (@wwv) {
  76                 my $dupkey = "$_->[1].$_->[2]$_->[3]$_->[4]";
  77                 $wwvdup{$dupkey} = $_->[1];
  78         }
  79
  80         # load the baddx file
  81         do "$baddxfn" if -e "$baddxfn";
  82         print "$@\n" if $@;
  83 }
  84
  85 #
  86 # obtain a new connection this is derived from dxchannel
  87 #
  88
  89 sub new
  90 {
  91         my $self = DXChannel::alloc(@_);
  92         $self->{'sort'} = 'A';          # in absence of how to find out what sort of an object I am
  93         return $self;
  94 }
  95
  96 # this is how a pc connection starts (for an incoming connection)
  97 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
  98 # all the crap that comes between).
  99 sub start
 100 {
 101         my ($self, $line, $sort) = @_;
 102         my $call = $self->{call};
 103         my $user = $self->{user};
 104
 105         # remember type of connection
 106         $self->{consort} = $line;
 107         $self->{outbound} = $sort eq 'O';
 108         $self->{priv} = $user->priv;
 109         $self->{lang} = $user->lang;
 110         $self->{isolate} = $user->{isolate};
 111         $self->{consort} = $line;       # save the connection type
 112         $self->{here} = 1;
 113
 114         # get the filters
 115         $self->{spotfilter} = Filter::read_in('spots', $call);
 116         $self->{wwvfilter} = Filter::read_in('wwv', $call);
 117         $self->{annfilter} = Filter::read_in('ann', $call);
 118
 119         # set unbuffered and no echo
 120         $self->send_now('B',"0");
 121         $self->send_now('E',"0");
 122
 123         # send initialisation string
 124         if (!$self->{outbound}) {
 125                 $self->send(pc38()) if DXNode->get_all();
 126                 $self->send(pc18());
 127         }
 128         $self->state('init');
 129         $self->pc50_t(time);
 130
 131         Log('DXProt', "$call connected");
 132 }
 133
 134 #
 135 # This is the normal pcxx despatcher
 136 #
 137 sub normal
 138 {
 139         my ($self, $line) = @_;
 140         my @field = split /\^/, $line;
 141         pop @field if $field[-1] eq '~';
 142
 143 #       print join(',', @field), "\n";
 144
 145         # ignore any lines that don't start with PC
 146         return if !$field[0] =~ /^PC/;
 147
 148         # process PC frames
 149         my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
 150         return unless $pcno;
 151         return if $pcno < 10 || $pcno > 51;
 152
 153         # local processing 1
 154         my $pcr;
 155         eval {
 156                 $pcr = Local::pcprot($self, $pcno, @field);
 157         };
 158 #       dbg('local', "Local::pcprot error $@") if $@;
 159         return if $pcr;
 160
 161  SWITCH: {
 162                 if ($pcno == 10) {              # incoming talk
 163
 164                         # is it for me or one of mine?
 165                         my $call = ($field[5] gt ' ') ? $field[5] : $field[2];
 166                         if ($call eq $main::mycall || grep $_ eq $call, get_all_user_calls()) {
 167
 168                                 # yes, it is
 169                                 my $text = unpad($field[3]);
 170                                 Log('talk', $call, $field[1], $field[6], $text);
 171                                 $call = $main::myalias if $call eq $main::mycall;
 172                                 my $ref = DXChannel->get($call);
 173                                 $ref->send("$call de $field[1]: $text") if $ref && $ref->{talk};
 174                         } else {
 175                                 route($field[2], $line); # relay it on its way
 176                         }
 177                         return;
 178                 }
 179
 180                 if ($pcno == 11 || $pcno == 26) { # dx spot
 181
 182                         # if this is a 'nodx' node then ignore it
 183                         last SWITCH if grep $field[7] =~ /^$_/,  @DXProt::nodx_node;
 184
 185                         # convert the date to a unix date
 186                         my $d = cltounix($field[3], $field[4]);
 187                         # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
 188                         if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
 189                                 dbg('chan', "Spot ignored, invalid date or out of range ($field[3] $field[4])\n");
 190                                 return;
 191                         }
 192
 193                         # strip off the leading & trailing spaces from the comment
 194                         my $text = unpad($field[5]);
 195
 196                         # store it away
 197                         my $spotter = $field[6];
 198                         $spotter =~ s/-\d+$//o; # strip off the ssid from the spotter
 199
 200                         # do some de-duping
 201                         my $freq = $field[1] - 0;
 202                         my $dupkey = "$freq$field[2]$d$text$spotter";
 203                         if ($spotdup{$dupkey}) {
 204                                 dbg('chan', "Duplicate Spot ignored\n");
 205                                 return;
 206                         }
 207
 208                         $spotdup{$dupkey} = $d;
 209
 210                         # is it 'baddx'
 211                         if (grep $field[2] eq $_, @baddx) {
 212                                 dbg('chan', "Bad DX spot, ignored");
 213                                 return;
 214                         }
 215
 216                         my @spot = Spot::add($freq, $field[2], $d, $text, $spotter, $field[7]);
 217
 218             #
 219                         # @spot at this point contains:-
 220             # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
 221                         # then  spotted itu, spotted cq, spotters itu, spotters cq
 222                         # you should be able to route on any of these
 223             #
 224
 225                         # local processing
 226                         my $r;
 227                         eval {
 228                                 $r = Local::spot($self, @spot);
 229                         };
 230 #                       dbg('local', "Local::spot1 error $@") if $@;
 231                         return if $r;
 232
 233                         # DON'T be silly and send on PC26s!
 234                         return if $pcno == 26;
 235
 236                         # send out the filtered spots
 237                         send_dx_spot($self, $line, @spot) if @spot;
 238                         return;
 239                 }
 240
 241                 if ($pcno == 12) {              # announces
 242                         # announce duplicate checking
 243                         my $text = uc unpad($field[3]);
 244                         my $dupkey = $field[1].$field[2].$text.$field[4].$field[6];
 245                         if ($anndup{$dupkey}) {
 246                                 dbg('chan', "Duplicate Announce ignored\n");
 247                                 return;
 248                         }
 249                         $anndup{$dupkey} = $main::systime;
 250
 251                         # global ann filtering
 252                         my ($filter, $hops) = Filter::it($self->{annfilter}, @field[1..6], $self->{call} ) if $self->{annfilter};
 253                         if ($self->{annfilter} && !$filter) {
 254                                 dbg('chan', "Rejected by filter");
 255                                 return;
 256                         }
 257
 258                         if ($field[2] eq '*' || $field[2] eq $main::mycall) {
 259
 260                                 # strip leading and trailing stuff
 261                                 my $text = unpad($field[3]);
 262                                 my $target;
 263                                 my $to = 'To ';
 264                                 my @list;
 265
 266                                 if ($field[4] eq '*') { # sysops
 267                                         $target = "SYSOP";
 268                                         @list = map { $_->priv >= 5 ? $_ : () } get_all_users();
 269                                 } elsif ($field[4] gt ' ') { # speciality list handling
 270                                         my ($name) = split /\./, $field[4];
 271                                         $target = "$name"; # put the rest in later (if bothered)
 272                                 }
 273
 274                                 if ($field[6] eq '1') {
 275                                         $target = "WX";
 276                                         $to = '';
 277                                 }
 278                                 $target = "All" if !$target;
 279
 280                                 if (@list > 0) {
 281                                         broadcast_list("$to$target de $field[1]: $text", 'ann', undef, @list);
 282                                 } else {
 283                                         broadcast_users("$target de $field[1]: $text", 'ann', undef);
 284                                 }
 285                                 Log('ann', $target, $field[1], $text);
 286
 287                                 return if $field[2] eq $main::mycall; # it's routed to me
 288                         } else {
 289                                 route($field[2], $line);
 290                                 return;                 # only on a routed one
 291                         }
 292
 293                         last SWITCH;
 294                 }
 295
 296                 if ($pcno == 13) {
 297                         last SWITCH;
 298                 }
 299                 if ($pcno == 14) {
 300                         last SWITCH;
 301                 }
 302                 if ($pcno == 15) {
 303                         last SWITCH;
 304                 }
 305
 306                 if ($pcno == 16) {              # add a user
 307                         my $node = DXCluster->get_exact($field[1]);
 308                         return unless $node; # ignore if havn't seen a PC19 for this one yet
 309                         return unless $node->isa('DXNode');
 310                         if ($node->dxchan != $self) {
 311                                 dbg('chan', "LOOP: come in on wrong channel");
 312                                 return;
 313                         }
 314                         my $i;
 315
 316
 317                         for ($i = 2; $i < $#field; $i++) {
 318                                 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
 319                                 next if !$call || length $call < 3 || length $call > 8;
 320                                 next if !$confmode;
 321                                 $call = uc $call;
 322                                 next if DXCluster->get_exact($call); # we already have this (loop?)
 323
 324                                 $confmode = $confmode eq '*';
 325                                 DXNodeuser->new($self, $node, $call, $confmode, $here);
 326
 327                                 # add this station to the user database, if required
 328                                 $call =~ s/-\d+$//o;        # remove ssid for users
 329                                 my $user = DXUser->get_current($call);
 330                                 $user = DXUser->new($call) if !$user;
 331                                 $user->homenode($node->call) if !$user->homenode;
 332                                 $user->node($node->call);
 333                                 $user->lastin($main::systime) unless DXChannel->get($call);
 334                                 $user->put;
 335                         }
 336
 337                         # queue up any messages (look for privates only)
 338                         DXMsg::queue_msg(1) if $self->state eq 'normal';
 339                         last SWITCH;
 340                 }
 341
 342                 if ($pcno == 17) {              # remove a user
 343                         my $node = DXCluster->get_exact($field[2]);
 344                         return unless $node;
 345                         return unless $node->isa('DXNode');
 346                         if ($node->dxchan != $self) {
 347                                 dbg('chan', "LOOP: come in on wrong channel");
 348                                 return;
 349                         }
 350                         my $ref = DXCluster->get_exact($field[1]);
 351                         $ref->del() if $ref;
 352                         last SWITCH;
 353                 }
 354
 355                 if ($pcno == 18) {              # link request
 356                         $self->send_local_config();
 357                         $self->send(pc20());
 358                         $self->state('init');
 359                         return;             # we don't pass these on
 360                 }
 361
 362                 if ($pcno == 19) {              # incoming cluster list
 363                         my $i;
 364                         for ($i = 1; $i < $#field-1; $i += 4) {
 365                                 my $here = $field[$i];
 366                                 my $call = uc $field[$i+1];
 367                                 my $confmode = $field[$i+2] eq '*';
 368                                 my $ver = $field[$i+3];
 369
 370                                 # now check the call over
 371                                 my $node = DXCluster->get_exact($call);
 372                                 if ($node && $node->dxchan != $self) {
 373                                         dbg('chan', "LOOP: come in on wrong channel");
 374                                         return;
 375                                 }
 376                                 next if $node; # we already have this
 377
 378                                 # check for sane parameters
 379                                 next if $ver < 5000; # only works with version 5 software
 380                                 next if length $call < 3; # min 3 letter callsigns
 381                                 DXNode->new($self, $call, $confmode, $here, $ver);
 382
 383                                 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
 384                                 my $mref = DXMsg::get_busy($call);
 385                                 $mref->stop_msg($self) if $mref;
 386
 387                                 # add this station to the user database, if required (don't remove SSID from nodes)
 388                                 my $user = DXUser->get_current($call);
 389                                 if (!$user) {
 390                                         $user = DXUser->new($call);
 391                                         $user->sort('A');
 392                                         $user->priv(1);                   # I have relented and defaulted nodes
 393                                         $self->{priv} = 1;                # to user RCMDs allowed
 394                                         $user->homenode($call);
 395                                         $user->node($call);
 396                                 }
 397                                 $user->lastin($main::systime) unless DXChannel->get($call);
 398                                 $user->put;
 399                         }
 400
 401                         # queue up any messages
 402                         DXMsg::queue_msg(0) if $self->state eq 'normal';
 403                         last SWITCH;
 404                 }
 405
 406                 if ($pcno == 20) {              # send local configuration
 407                         $self->send_local_config();
 408                         $self->send(pc22());
 409                         $self->state('normal');
 410
 411                         # queue mail
 412                         DXMsg::queue_msg(0);
 413
 414                         return;
 415                 }
 416
 417                 if ($pcno == 21) {              # delete a cluster from the list
 418                         my $call = uc $field[1];
 419                         if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
 420                                 my $node = DXCluster->get_exact($call);
 421                                 if ($node) {
 422                                         if ($node->dxchan != $self) {
 423                                                 dbg('chan', "LOOP: come in on wrong channel");
 424                                                 return;
 425                                         }
 426                                         $node->del();
 427                                 } else {
 428                                         dbg('chan', "$call not in table, dropped");
 429                                         return;
 430                                 }
 431                         }
 432                         last SWITCH;
 433                 }
 434
 435                 if ($pcno == 22) {
 436                         $self->state('normal');
 437
 438                         # queue mail
 439                         DXMsg::queue_msg(0);
 440                         return;
 441                 }
 442
 443                 if ($pcno == 23 || $pcno == 27) { # WWV info
 444                         # do some de-duping
 445                         my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
 446                         my $sfi = unpad($field[3]);
 447                         my $k = unpad($field[4]);
 448                         my $i = unpad($field[5]);
 449                         my $dupkey = "$d.$sfi$k$i";
 450                         if ($wwvdup{$dupkey}) {
 451                                 dbg('chan', "Dup WWV Spot ignored\n");
 452                                 return;
 453                         }
 454                         if ($d > $main::systime + 900 || $field[2] < 0 || $field[2] > 23) {
 455                                 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
 456                                 return;
 457                         }
 458                         $wwvdup{$dupkey} = $d;
 459                         $field[6] =~ s/-\d+$//o;            # remove spotter's ssid
 460
 461                         my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..$#field]);
 462
 463                         my $r;
 464                         eval {
 465                                 $r = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
 466                         };
 467 #                       dbg('local', "Local::wwv2 error $@") if $@;
 468                         return if $r;
 469
 470                         # DON'T be silly and send on PC27s!
 471                         return if $pcno == 27;
 472
 473                         # broadcast to the eager users
 474                         broadcast_users("WWV de $field[7] <$field[2]>:   SFI=$sfi, A=$k, K=$i, $field[6]", 'wwv', $wwv );
 475                         last SWITCH;
 476                 }
 477
 478                 if ($pcno == 24) {              # set here status
 479                         my $call = uc $field[1];
 480                         my $ref = DXCluster->get_exact($call);
 481                         $ref->here($field[2]) if $ref;
 482                         last SWITCH;
 483                 }
 484
 485                 if ($pcno == 25) {      # merge request
 486                         if ($field[1] ne $main::mycall) {
 487                                 route($field[1], $line);
 488                                 return;
 489                         }
 490
 491                         Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
 492
 493                         # spots
 494                         if ($field[3] > 0) {
 495                                 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
 496                                 my $in;
 497                                 foreach $in (@in) {
 498                                         $self->send(pc26(@{$in}[0..4], $in->[7]));
 499                                 }
 500                         }
 501
 502                         # wwv
 503                         if ($field[4] > 0) {
 504                                 my @in = reverse Geomag::search(0, $field[4], time, 1);
 505                                 my $in;
 506                                 foreach $in (@in) {
 507                                         $self->send(pc27(@{$in}));
 508                                 }
 509                         }
 510                         return;
 511                 }
 512
 513                 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
 514                         DXMsg::process($self, $line);
 515                         return;
 516                 }
 517
 518                 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
 519                         if ($field[1] eq $main::mycall) {
 520                                 my $ref = DXUser->get_current($field[2]);
 521                                 my $cref = DXCluster->get($field[2]);
 522                                 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
 523                                 unless ($field[3] =~ /rcmd/i || !$cref || !$ref || $cref->mynode->call ne $ref->homenode) {    # not allowed to relay RCMDS!
 524                                         if ($ref->{priv}) {     # you have to have SOME privilege, the commands have further filtering
 525                                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
 526                                                 my $oldpriv = $self->{priv};
 527                                                 $self->{priv} = $ref->{priv};     # assume the user's privilege level
 528                                                 my @in = (DXCommandmode::run_cmd($self, $field[3]));
 529                                                 $self->{priv} = $oldpriv;
 530                                                 for (@in) {
 531                                                         s/\s*$//og;
 532                                                         $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
 533                                                         Log('rcmd', 'out', $field[2], $_);
 534                                                 }
 535                                                 delete $self->{remotecmd};
 536                                         } else {
 537                                                 $self->send(pc35($main::mycall, $field[2], "$main::mycall:sorry...!"));
 538                                         }
 539                                 } else {
 540                                         $self->send(pc35($main::mycall, $field[2], "$main::mycall:your attempt is logged, Tut tut tut...!"));
 541                                 }
 542                         } else {
 543                                 route($field[1], $line);
 544                         }
 545                         return;
 546                 }
 547
 548                 if ($pcno == 35) {              # remote command replies
 549                         if ($field[1] eq $main::mycall) {
 550                                 my $s = $rcmds{$field[2]};
 551                                 if ($s) {
 552                                         my $dxchan = DXChannel->get($s->{call});
 553                                         $dxchan->send($field[3]) if $dxchan;
 554                                         delete $rcmds{$field[2]} if !$dxchan;
 555                                 }
 556                         } else {
 557                                 route($field[1], $line);
 558                         }
 559                         return;
 560                 }
 561
 562                 if ($pcno == 37) {
 563                         last SWITCH;
 564                 }
 565
 566                 if ($pcno == 38) {              # node connected list from neighbour
 567                         return;
 568                 }
 569
 570                 if ($pcno == 39) {              # incoming disconnect
 571                         $self->disconnect();
 572                         return;
 573                 }
 574
 575                 if ($pcno == 41) {              # user info
 576                         # add this station to the user database, if required
 577                         my $user = DXUser->get_current($field[1]);
 578                         if (!$user) {
 579                                 # then try without an SSID
 580                                 $field[1] =~ s/-\d+$//o;
 581                                 $user = DXUser->get_current($field[1]);
 582                         }
 583                         $user = DXUser->new($field[1]) if !$user;
 584
 585                         if ($field[2] == 1) {
 586                                 $user->name($field[3]);
 587                         } elsif ($field[2] == 2) {
 588                                 $user->qth($field[3]);
 589                         } elsif ($field[2] == 3) {
 590                                 my ($lat, $long) = DXBearing::stoll($field[3]);
 591                                 $user->lat($lat);
 592                                 $user->long($long);
 593                         } elsif ($field[2] == 4) {
 594                                 $user->homenode($field[3]);
 595                         }
 596                         $user->put;
 597                         last SWITCH;
 598                 }
 599                 if ($pcno == 43) {
 600                         last SWITCH;
 601                 }
 602                 if ($pcno == 44) {
 603                         last SWITCH;
 604                 }
 605                 if ($pcno == 45) {
 606                         last SWITCH;
 607                 }
 608                 if ($pcno == 46) {
 609                         last SWITCH;
 610                 }
 611                 if ($pcno == 47) {
 612                         last SWITCH;
 613                 }
 614                 if ($pcno == 48) {
 615                         last SWITCH;
 616                 }
 617
 618                 if ($pcno == 50) {              # keep alive/user list
 619                         my $ref = DXCluster->get_exact($field[1]);
 620                         $ref->update_users($field[2]) if $ref;
 621                         last SWITCH;
 622                 }
 623
 624                 if ($pcno == 51) {              # incoming ping requests/answers
 625
 626                         # is it for us?
 627                         if ($field[1] eq $main::mycall) {
 628                                 my $flag = $field[3];
 629                                 if ($flag == 1) {
 630                                         $self->send(pc51($field[2], $field[1], '0'));
 631                                 } else {
 632                                         # it's a reply, look in the ping list for this one
 633                                         my $ref = $pings{$field[2]};
 634                                         if ($ref) {
 635                                                 my $r = shift @$ref;
 636                                                 my $dxchan = DXChannel->get($r->{call});
 637                                                 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
 638                                         }
 639                                 }
 640
 641                         } else {
 642                                 # route down an appropriate thingy
 643                                 route($field[1], $line);
 644                         }
 645                         return;
 646                 }
 647         }
 648
 649          # if get here then rebroadcast the thing with its Hop count decremented (if
 650          # there is one). If it has a hop count and it decrements to zero then don't
 651          # rebroadcast it.
 652          #
 653          # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
 654          #        REBROADCAST!!!!
 655          #
 656
 657         if (!$self->{isolate}) {
 658                 broadcast_ak1a($line, $self); # send it to everyone but me
 659         }
 660 }
 661
 662 #
 663 # This is called from inside the main cluster processing loop and is used
 664 # for despatching commands that are doing some long processing job
 665 #
 666 sub process
 667 {
 668         my $t = time;
 669         my @dxchan = DXChannel->get_all();
 670         my $dxchan;
 671
 672         foreach $dxchan (@dxchan) {
 673                 next unless $dxchan->is_ak1a();
 674                 next if $dxchan == $me;
 675
 676                 # send a pc50 out on this channel
 677                 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
 678                         $dxchan->send(pc50());
 679                         $dxchan->pc50_t($t);
 680                 }
 681         }
 682
 683         my $key;
 684         my $val;
 685         my $cutoff;
 686         if ($main::systime - 3600 > $last_hour) {
 687                 $cutoff  = $main::systime - $pc11_dup_age;
 688                 while (($key, $val) = each %spotdup) {
 689                         delete $spotdup{$key} if $val < $cutoff;
 690                 }
 691                 $cutoff = $main::systime - $pc23_dup_age;
 692                 while (($key, $val) = each %wwvdup) {
 693                         delete $wwvdup{$key} if $val < $cutoff;
 694                 }
 695                 $cutoff = $main::systime - $pc12_dup_age;
 696                 while (($key, $val) = each %anndup) {
 697                         delete $anndup{$key} if $val < $cutoff;
 698                 }
 699                 $last_hour = $main::systime;
 700         }
 701 }
 702
 703 #
 704 # finish up a pc context
 705 #
 706 sub finish
 707 {
 708         my $self = shift;
 709         my $call = $self->call;
 710         my $ref = DXCluster->get_exact($call);
 711
 712         # unbusy and stop and outgoing mail
 713         my $mref = DXMsg::get_busy($call);
 714         $mref->stop_msg($self) if $mref;
 715
 716         # broadcast to all other nodes that all the nodes connected to via me are gone
 717         my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
 718         my $node;
 719
 720         foreach $node (@gonenodes) {
 721                 next if $node->call eq $call;
 722                 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
 723                 $node->del();
 724         }
 725
 726         # remove outstanding pings
 727         delete $pings{$call};
 728
 729         # now broadcast to all other ak1a nodes that I have gone
 730         broadcast_ak1a(pc21($call, 'Gone.'), $self);
 731
 732         Log('DXProt', $call . " Disconnected");
 733         $ref->del() if $ref;
 734 }
 735
 736 #
 737 # some active measures
 738 #
 739 sub send_dx_spot
 740 {
 741         my $self = shift;
 742         my $line = shift;
 743         my @dxchan = DXChannel->get_all();
 744         my $dxchan;
 745
 746         # send it if it isn't the except list and isn't isolated and still has a hop count
 747         # taking into account filtering and so on
 748         foreach $dxchan (@dxchan) {
 749                 my $routeit;
 750                 my ($filter, $hops) = Filter::it($dxchan->{spotfilter}, @_, $self->{call} ) if $dxchan->{spotfilter};
 751                 if ($dxchan->is_ak1a) {
 752                         next if $dxchan == $self;
 753                         if ($hops) {
 754                                 $routeit = $line;
 755                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
 756                         } else {
 757                                 $routeit = adjust_hops($dxchan, $line);  # adjust its hop count by node name
 758                                 next unless $routeit;
 759                         }
 760                         if ($filter) {
 761                                 $dxchan->send($routeit) if $routeit;
 762                         } else {
 763                                 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
 764
 765                         }
 766                 } elsif ($dxchan->is_user && $dxchan->{dx}) {
 767                         my $buf = Spot::formatb($_[0], $_[1], $_[2], $_[3], $_[4]);
 768                         $buf .= "\a\a" if $dxchan->{beep};
 769                         if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
 770                                 $dxchan->send($buf) if !$hops || ($hops && $filter);
 771                         } else {
 772                                 $dxchan->delay($buf) if !$hops || ($hops && $filter);
 773                         }
 774                 }
 775         }
 776 }
 777
 778 sub send_local_config
 779 {
 780         my $self = shift;
 781         my $n;
 782         my @nodes;
 783         my @localnodes;
 784         my @remotenodes;
 785
 786         # send our nodes
 787         if ($self->{isolate}) {
 788                 @localnodes = (DXCluster->get_exact($main::mycall));
 789         } else {
 790                 # create a list of all the nodes that are not connected to this connection
 791                 # and are not themselves isolated, this to make sure that isolated nodes
 792         # don't appear outside of this node
 793                 @nodes = DXNode::get_all();
 794                 @nodes = grep { $_->{call} ne $main::mycall } @nodes;
 795                 @nodes = grep { $_->dxchan != $self } @nodes if @nodes;
 796                 @nodes = grep { !$_->dxchan->{isolate} } @nodes if @nodes;
 797                 @localnodes = grep { $_->dxchan->{call} eq $_->{call} } @nodes if @nodes;
 798                 unshift @localnodes, DXCluster->get_exact($main::mycall);
 799                 @remotenodes = grep { $_->dxchan->{call} ne $_->{call} } @nodes if @nodes;
 800         }
 801
 802         my @s = $me->pc19(@localnodes, @remotenodes);
 803         for (@s) {
 804                 my $routeit = adjust_hops($self, $_);
 805                 $self->send($routeit) if $routeit;
 806         }
 807
 808         # get all the users connected on the above nodes and send them out
 809         foreach $n (@localnodes, @remotenodes) {
 810                 my @users = values %{$n->list};
 811                 my @s = pc16($n, @users);
 812                 for (@s) {
 813                         my $routeit = adjust_hops($self, $_);
 814                         $self->send($routeit) if $routeit;
 815                 }
 816         }
 817 }
 818
 819 #
 820 # route a message down an appropriate interface for a callsign
 821 #
 822 # is called route(to, pcline);
 823 #
 824 sub route
 825 {
 826         my ($call, $line) = @_;
 827         my $cl = DXCluster->get_exact($call);
 828         if ($cl) {
 829                 my $hops;
 830                 my $dxchan = $cl->{dxchan};
 831                 if ($dxchan) {
 832                         my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
 833                         if ($routeit) {
 834                                 $dxchan->send($routeit) if $dxchan;
 835                         }
 836                 }
 837         }
 838 }
 839
 840 # broadcast a message to all clusters taking into account isolation
 841 # [except those mentioned after buffer]
 842 sub broadcast_ak1a
 843 {
 844         my $s = shift;                          # the line to be rebroadcast
 845         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 846         my @dxchan = get_all_ak1a();
 847         my $dxchan;
 848
 849         # send it if it isn't the except list and isn't isolated and still has a hop count
 850         foreach $dxchan (@dxchan) {
 851                 next if grep $dxchan == $_, @except;
 852                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
 853                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
 854         }
 855 }
 856
 857 # broadcast a message to all clusters ignoring isolation
 858 # [except those mentioned after buffer]
 859 sub broadcast_all_ak1a
 860 {
 861         my $s = shift;                          # the line to be rebroadcast
 862         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 863         my @dxchan = get_all_ak1a();
 864         my $dxchan;
 865
 866         # send it if it isn't the except list and isn't isolated and still has a hop count
 867         foreach $dxchan (@dxchan) {
 868                 next if grep $dxchan == $_, @except;
 869                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
 870                 $dxchan->send($routeit);
 871         }
 872 }
 873
 874 # broadcast to all users
 875 # storing the spot or whatever until it is in a state to receive it
 876 sub broadcast_users
 877 {
 878         my $s = shift;                          # the line to be rebroadcast
 879         my $sort = shift;           # the type of transmission
 880         my $fref = shift;           # a reference to an object to filter on
 881         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 882         my @dxchan = get_all_users();
 883         my $dxchan;
 884         my @out;
 885
 886         foreach $dxchan (@dxchan) {
 887                 next if grep $dxchan == $_, @except;
 888                 push @out, $dxchan;
 889         }
 890         broadcast_list($s, $sort, $fref, @out);
 891 }
 892
 893 # broadcast to a list of users
 894 sub broadcast_list
 895 {
 896         my $s = shift;
 897         my $sort = shift;
 898         my $fref = shift;
 899         my $dxchan;
 900
 901         foreach $dxchan (@_) {
 902                 my $filter = 1;
 903
 904                 if ($sort eq 'dx') {
 905                     next unless $dxchan->{dx};
 906                         ($filter) = Filter::it($dxchan->{spotfilter}, @{$fref}) if ref $fref;
 907                         next unless $filter;
 908                 }
 909                 next if $sort eq 'ann' && !$dxchan->{ann};
 910                 next if $sort eq 'wwv' && !$dxchan->{wwv};
 911                 next if $sort eq 'wx' && !$dxchan->{wx};
 912
 913                 $s =~ s/\a//og unless $dxchan->{beep};
 914
 915                 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
 916                         $dxchan->send($s);
 917                 } else {
 918                         $dxchan->delay($s);
 919                 }
 920         }
 921 }
 922
 923 #
 924 # gimme all the ak1a nodes
 925 #
 926 sub get_all_ak1a
 927 {
 928         my @list = DXChannel->get_all();
 929         my $ref;
 930         my @out;
 931         foreach $ref (@list) {
 932                 push @out, $ref if $ref->is_ak1a;
 933         }
 934         return @out;
 935 }
 936
 937 # return a list of all users
 938 sub get_all_users
 939 {
 940         my @list = DXChannel->get_all();
 941         my $ref;
 942         my @out;
 943         foreach $ref (@list) {
 944                 push @out, $ref if $ref->is_user;
 945         }
 946         return @out;
 947 }
 948
 949 # return a list of all user callsigns
 950 sub get_all_user_calls
 951 {
 952         my @list = DXChannel->get_all();
 953         my $ref;
 954         my @out;
 955         foreach $ref (@list) {
 956                 push @out, $ref->call if $ref->is_user;
 957         }
 958         return @out;
 959 }
 960
 961 #
 962 # obtain the hops from the list for this callsign and pc no
 963 #
 964
 965 sub get_hops
 966 {
 967         my ($pcno) = @_;
 968         my $hops = $DXProt::hopcount{$pcno};
 969         $hops = $DXProt::def_hopcount if !$hops;
 970         return "H$hops";
 971 }
 972
 973 #
 974 # adjust the hop count on a per node basis using the user loadable
 975 # hop table if available or else decrement an existing one
 976 #
 977
 978 sub adjust_hops
 979 {
 980         my $self = shift;
 981         my $s = shift;
 982         my $call = $self->{call};
 983         my $hops;
 984
 985         if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
 986                 my ($pcno) = $s =~ /^PC(\d\d)/o;
 987                 confess "$call called adjust_hops with '$s'" unless $pcno;
 988                 my $ref = $nodehops{$call} if %nodehops;
 989                 if ($ref) {
 990                         my $newhops = $ref->{$pcno};
 991                         return "" if defined $newhops && $newhops == 0;
 992                         $newhops = $ref->{default} unless $newhops;
 993                         return "" if defined $newhops && $newhops == 0;
 994                         $newhops = $hops if !$newhops;
 995                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
 996                 } else {
 997                         # simply decrement it
 998                         $hops--;
 999                         return "" if !$hops;
1000                         $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1001                 }
1002         }
1003         return $s;
1004 }
1005
1006 #
1007 # load hop tables
1008 #
1009 sub load_hops
1010 {
1011         my $self = shift;
1012         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1013         do "$main::data/hop_table.pl";
1014         return $@ if $@;
1015         return 0;
1016 }
1017
1018 # remove leading and trailing spaces from an input string
1019 sub unpad
1020 {
1021         my $s = shift;
1022         $s =~ s/^\s+|\s+$//;
1023         return $s;
1024 }
1025
1026 # add a ping request to the ping queues
1027 sub addping
1028 {
1029         my ($from, $to) = @_;
1030         my $ref = $pings{$to};
1031         $ref = $pings{$to} = [] if !$ref;
1032         my $r = {};
1033         $r->{call} = $from;
1034         $r->{t} = $main::systime;
1035         route($to, pc51($to, $main::mycall, 1));
1036         push @$ref, $r;
1037 }
1038
1039 # add a rcmd request to the rcmd queues
1040 sub addrcmd
1041 {
1042         my ($from, $to, $cmd) = @_;
1043         my $r = {};
1044         $r->{call} = $from;
1045         $r->{t} = $main::systime;
1046         $r->{cmd} = $cmd;
1047         route($to, pc34($main::mycall, $to, $cmd));
1048         $rcmds{$to} = $r;
1049 }
1050 1;
1051 __END__