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