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                         last SWITCH if !$node; # ignore if havn't seen a PC19 for this one yet
 309                         last SWITCH unless $node->isa('DXNode');
 310                         my $i;
 311
 312
 313                         for ($i = 2; $i < $#field; $i++) {
 314                                 my ($call, $confmode, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
 315                                 next if !$call || length $call < 3 || length $call > 8;
 316                                 next if !$confmode;
 317                                 $call = uc $call;
 318                                 next if DXCluster->get_exact($call); # we already have this (loop?)
 319
 320                                 $confmode = $confmode eq '*';
 321                                 DXNodeuser->new($self, $node, $call, $confmode, $here);
 322
 323                                 # add this station to the user database, if required
 324                                 $call =~ s/-\d+$//o;        # remove ssid for users
 325                                 my $user = DXUser->get_current($call);
 326                                 $user = DXUser->new($call) if !$user;
 327                                 $user->homenode($node->call) if !$user->homenode;
 328                                 $user->node($node->call);
 329                                 $user->lastin($main::systime);
 330                                 $user->put;
 331                         }
 332
 333                         # queue up any messages (look for privates only)
 334                         DXMsg::queue_msg(1) if $self->state eq 'normal';
 335                         last SWITCH;
 336                 }
 337
 338                 if ($pcno == 17) {              # remove a user
 339
 340                         my $ref = DXCluster->get_exact($field[1]);
 341                         $ref->del() if $ref;
 342                         last SWITCH;
 343                 }
 344
 345                 if ($pcno == 18) {              # link request
 346                         $self->send_local_config();
 347                         $self->send(pc20());
 348                         $self->state('init');
 349                         return;             # we don't pass these on
 350                 }
 351
 352                 if ($pcno == 19) {              # incoming cluster list
 353                         my $i;
 354                         for ($i = 1; $i < $#field-1; $i += 4) {
 355                                 my $here = $field[$i];
 356                                 my $call = uc $field[$i+1];
 357                                 my $confmode = $field[$i+2] eq '*';
 358                                 my $ver = $field[$i+3];
 359
 360                                 # now check the call over
 361                                 next if DXCluster->get_exact($call); # we already have this
 362
 363                                 # check for sane parameters
 364                                 next if $ver < 5000; # only works with version 5 software
 365                                 next if length $call < 3; # min 3 letter callsigns
 366                                 DXNode->new($self, $call, $confmode, $here, $ver);
 367
 368                                 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
 369                                 my $mref = DXMsg::get_busy($call);
 370                                 $mref->stop_msg($self) if $mref;
 371
 372                                 # add this station to the user database, if required (don't remove SSID from nodes)
 373                                 my $user = DXUser->get_current($call);
 374                                 if (!$user) {
 375                                         $user = DXUser->new($call);
 376                                         $user->sort('A');
 377                                         $user->priv(1);                   # I have relented and defaulted nodes
 378                                         $self->{priv} = 1;                # to user RCMDs allowed
 379                                         $user->homenode($call);
 380                                         $user->node($call);
 381                                 }
 382                                 $user->lastin($main::systime);
 383                                 $user->put;
 384                         }
 385
 386                         # queue up any messages
 387                         DXMsg::queue_msg(0) if $self->state eq 'normal';
 388                         last SWITCH;
 389                 }
 390
 391                 if ($pcno == 20) {              # send local configuration
 392                         $self->send_local_config();
 393                         $self->send(pc22());
 394                         $self->state('normal');
 395
 396                         # queue mail
 397                         DXMsg::queue_msg(0);
 398
 399                         return;
 400                 }
 401
 402                 if ($pcno == 21) {              # delete a cluster from the list
 403                         my $call = uc $field[1];
 404                         if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
 405                                 my $ref = DXCluster->get_exact($call);
 406                                 $ref->del() if $ref;
 407                         }
 408                         last SWITCH;
 409                 }
 410
 411                 if ($pcno == 22) {
 412                         $self->state('normal');
 413
 414                         # queue mail
 415                         DXMsg::queue_msg(0);
 416                         return;
 417                 }
 418
 419                 if ($pcno == 23 || $pcno == 27) { # WWV info
 420                         # do some de-duping
 421                         my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
 422                         my $sfi = unpad($field[3]);
 423                         my $k = unpad($field[4]);
 424                         my $i = unpad($field[5]);
 425                         my $dupkey = "$d.$sfi$k$i";
 426                         if ($wwvdup{$dupkey}) {
 427                                 dbg('chan', "Dup WWV Spot ignored\n");
 428                                 return;
 429                         }
 430                         if ($d > $main::systime + 900 || $field[2] < 0 || $field[2] > 23) {
 431                                 dbg('chan', "WWV Date ($field[1] $field[2]) out of range");
 432                                 return;
 433                         }
 434                         $wwvdup{$dupkey} = $d;
 435                         $field[6] =~ s/-\d+$//o;            # remove spotter's ssid
 436
 437                         my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..$#field]);
 438
 439                         my $r;
 440                         eval {
 441                                 $r = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
 442                         };
 443 #                       dbg('local', "Local::wwv2 error $@") if $@;
 444                         return if $r;
 445
 446                         # DON'T be silly and send on PC27s!
 447                         return if $pcno == 27;
 448
 449                         # broadcast to the eager users
 450                         broadcast_users("WWV de $field[7] <$field[2]>:   SFI=$sfi, A=$k, K=$i, $field[6]", 'wwv', $wwv );
 451                         last SWITCH;
 452                 }
 453
 454                 if ($pcno == 24) {              # set here status
 455                         my $call = uc $field[1];
 456                         my $ref = DXCluster->get_exact($call);
 457                         $ref->here($field[2]) if $ref;
 458                         last SWITCH;
 459                 }
 460
 461                 if ($pcno == 25) {      # merge request
 462                         unless ($field[1] eq $main::mycall) {
 463                                 dbg('chan', "merge request to $field[1] from $field[2] ignored");
 464                                 return;
 465                         }
 466
 467                         Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
 468
 469                         # spots
 470                         if ($field[3] > 0) {
 471                                 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
 472                                 my $in;
 473                                 foreach $in (@in) {
 474                                         $self->send(pc26(@{$in}[0..4], $in->[7]));
 475                                 }
 476                         }
 477
 478                         # wwv
 479                         if ($field[4] > 0) {
 480                                 my @in = reverse Geomag::search(0, $field[4], time, 1);
 481                                 my $in;
 482                                 foreach $in (@in) {
 483                                         $self->send(pc27(@{$in}));
 484                                 }
 485                         }
 486                         return;
 487                 }
 488
 489                 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
 490                         DXMsg::process($self, $line);
 491                         return;
 492                 }
 493
 494                 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
 495                         if ($field[1] eq $main::mycall) {
 496                                 my $ref = DXUser->get_current($field[2]);
 497                                 my $cref = DXCluster->get($field[2]);
 498                                 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
 499                                 unless ($field[3] =~ /rcmd/i || !$cref || !$ref || $cref->mynode->call ne $ref->homenode) {    # not allowed to relay RCMDS!
 500                                         if ($ref->{priv}) {     # you have to have SOME privilege, the commands have further filtering
 501                                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
 502                                                 my @in = (DXCommandmode::run_cmd($self, $field[3]));
 503                                                 for (@in) {
 504                                                         s/\s*$//og;
 505                                                         $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
 506                                                         Log('rcmd', 'out', $field[2], $_);
 507                                                 }
 508                                                 delete $self->{remotecmd};
 509                                         } else {
 510                                                 $self->send(pc35($main::mycall, $field[2], "$main::mycall:sorry...!"));
 511                                         }
 512                                 } else {
 513                                         $self->send(pc35($main::mycall, $field[2], "$main::mycall:your attempt is logged, Tut tut tut...!"));
 514                                 }
 515                         } else {
 516                                 route($field[1], $line);
 517                         }
 518                         return;
 519                 }
 520
 521                 if ($pcno == 35) {              # remote command replies
 522                         if ($field[1] eq $main::mycall) {
 523                                 my $s = $rcmds{$field[2]};
 524                                 if ($s) {
 525                                         my $dxchan = DXChannel->get($s->{call});
 526                                         $dxchan->send($field[3]) if $dxchan;
 527                                         delete $rcmds{$field[2]} if !$dxchan;
 528                                 }
 529                         } else {
 530                                 route($field[1], $line);
 531                         }
 532                         return;
 533                 }
 534
 535                 if ($pcno == 37) {
 536                         last SWITCH;
 537                 }
 538
 539                 if ($pcno == 38) {              # node connected list from neighbour
 540                         return;
 541                 }
 542
 543                 if ($pcno == 39) {              # incoming disconnect
 544                         $self->disconnect();
 545                         return;
 546                 }
 547
 548                 if ($pcno == 41) {              # user info
 549                         # add this station to the user database, if required
 550                         my $user = DXUser->get_current($field[1]);
 551                         if (!$user) {
 552                                 # then try without an SSID
 553                                 $field[1] =~ s/-\d+$//o;
 554                                 $user = DXUser->get_current($field[1]);
 555                         }
 556                         $user = DXUser->new($field[1]) if !$user;
 557
 558                         if ($field[2] == 1) {
 559                                 $user->name($field[3]);
 560                         } elsif ($field[2] == 2) {
 561                                 $user->qth($field[3]);
 562                         } elsif ($field[2] == 3) {
 563                                 my ($lat, $long) = DXBearing::stoll($field[3]);
 564                                 $user->lat($lat);
 565                                 $user->long($long);
 566                         } elsif ($field[2] == 4) {
 567                                 $user->homenode($field[3]);
 568                         }
 569                         $user->put;
 570                         last SWITCH;
 571                 }
 572                 if ($pcno == 43) {
 573                         last SWITCH;
 574                 }
 575                 if ($pcno == 44) {
 576                         last SWITCH;
 577                 }
 578                 if ($pcno == 45) {
 579                         last SWITCH;
 580                 }
 581                 if ($pcno == 46) {
 582                         last SWITCH;
 583                 }
 584                 if ($pcno == 47) {
 585                         last SWITCH;
 586                 }
 587                 if ($pcno == 48) {
 588                         last SWITCH;
 589                 }
 590
 591                 if ($pcno == 50) {              # keep alive/user list
 592                         my $ref = DXCluster->get_exact($field[1]);
 593                         $ref->update_users($field[2]) if $ref;
 594                         last SWITCH;
 595                 }
 596
 597                 if ($pcno == 51) {              # incoming ping requests/answers
 598
 599                         # is it for us?
 600                         if ($field[1] eq $main::mycall) {
 601                                 my $flag = $field[3];
 602                                 if ($flag == 1) {
 603                                         $self->send(pc51($field[2], $field[1], '0'));
 604                                 } else {
 605                                         # it's a reply, look in the ping list for this one
 606                                         my $ref = $pings{$field[2]};
 607                                         if ($ref) {
 608                                                 my $r = shift @$ref;
 609                                                 my $dxchan = DXChannel->get($r->{call});
 610                                                 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
 611                                         }
 612                                 }
 613
 614                         } else {
 615                                 # route down an appropriate thingy
 616                                 route($field[1], $line);
 617                         }
 618                         return;
 619                 }
 620         }
 621
 622          # if get here then rebroadcast the thing with its Hop count decremented (if
 623          # there is one). If it has a hop count and it decrements to zero then don't
 624          # rebroadcast it.
 625          #
 626          # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
 627          #        REBROADCAST!!!!
 628          #
 629
 630         if (!$self->{isolate}) {
 631                 broadcast_ak1a($line, $self); # send it to everyone but me
 632         }
 633 }
 634
 635 #
 636 # This is called from inside the main cluster processing loop and is used
 637 # for despatching commands that are doing some long processing job
 638 #
 639 sub process
 640 {
 641         my $t = time;
 642         my @dxchan = DXChannel->get_all();
 643         my $dxchan;
 644
 645         foreach $dxchan (@dxchan) {
 646                 next unless $dxchan->is_ak1a();
 647                 next if $dxchan == $me;
 648
 649                 # send a pc50 out on this channel
 650                 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
 651                         $dxchan->send(pc50());
 652                         $dxchan->pc50_t($t);
 653                 }
 654         }
 655
 656         my $key;
 657         my $val;
 658         my $cutoff;
 659         if ($main::systime - 3600 > $last_hour) {
 660                 $cutoff  = $main::systime - $pc11_dup_age;
 661                 while (($key, $val) = each %spotdup) {
 662                         delete $spotdup{$key} if $val < $cutoff;
 663                 }
 664                 $cutoff = $main::systime - $pc23_dup_age;
 665                 while (($key, $val) = each %wwvdup) {
 666                         delete $wwvdup{$key} if $val < $cutoff;
 667                 }
 668                 $cutoff = $main::systime - $pc12_dup_age;
 669                 while (($key, $val) = each %anndup) {
 670                         delete $anndup{$key} if $val < $cutoff;
 671                 }
 672                 $last_hour = $main::systime;
 673         }
 674 }
 675
 676 #
 677 # finish up a pc context
 678 #
 679 sub finish
 680 {
 681         my $self = shift;
 682         my $call = $self->call;
 683         my $ref = DXCluster->get_exact($call);
 684
 685         # unbusy and stop and outgoing mail
 686         my $mref = DXMsg::get_busy($call);
 687         $mref->stop_msg($self) if $mref;
 688
 689         # broadcast to all other nodes that all the nodes connected to via me are gone
 690         my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
 691         my $node;
 692
 693         foreach $node (@gonenodes) {
 694                 next if $node->call eq $call;
 695                 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
 696                 $node->del();
 697         }
 698
 699         # remove outstanding pings
 700         delete $pings{$call};
 701
 702         # now broadcast to all other ak1a nodes that I have gone
 703         broadcast_ak1a(pc21($call, 'Gone.'), $self);
 704
 705         Log('DXProt', $call . " Disconnected");
 706         $ref->del() if $ref;
 707 }
 708
 709 #
 710 # some active measures
 711 #
 712 sub send_dx_spot
 713 {
 714         my $self = shift;
 715         my $line = shift;
 716         my @dxchan = DXChannel->get_all();
 717         my $dxchan;
 718
 719         # send it if it isn't the except list and isn't isolated and still has a hop count
 720         # taking into account filtering and so on
 721         foreach $dxchan (@dxchan) {
 722                 my $routeit;
 723                 my ($filter, $hops) = Filter::it($dxchan->{spotfilter}, @_, $self->{call} ) if $dxchan->{spotfilter};
 724                 if ($dxchan->is_ak1a) {
 725                         next if $dxchan == $self;
 726                         if ($hops) {
 727                                 $routeit = $line;
 728                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
 729                         } else {
 730                                 $routeit = adjust_hops($dxchan, $line);  # adjust its hop count by node name
 731                                 next unless $routeit;
 732                         }
 733                         if ($filter) {
 734                                 $dxchan->send($routeit) if $routeit;
 735                         } else {
 736                                 $dxchan->send($routeit) unless $dxchan->{isolate} || $self->{isolate};
 737
 738                         }
 739                 } elsif ($dxchan->is_user && $dxchan->{dx}) {
 740                         my $buf = Spot::formatb($_[0], $_[1], $_[2], $_[3], $_[4]);
 741                         $buf .= "\a\a" if $dxchan->{beep};
 742                         if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
 743                                 $dxchan->send($buf) if !$hops || ($hops && $filter);
 744                         } else {
 745                                 $dxchan->delay($buf) if !$hops || ($hops && $filter);
 746                         }
 747                 }
 748         }
 749 }
 750
 751 sub send_local_config
 752 {
 753         my $self = shift;
 754         my $n;
 755         my @nodes;
 756         my @localnodes;
 757         my @remotenodes;
 758
 759         # send our nodes
 760         if ($self->{isolate}) {
 761                 @localnodes = (DXCluster->get_exact($main::mycall));
 762         } else {
 763                 # create a list of all the nodes that are not connected to this connection
 764                 # and are not themselves isolated, this to make sure that isolated nodes
 765         # don't appear outside of this node
 766                 @nodes = DXNode::get_all();
 767                 @nodes = grep { $_->{call} ne $main::mycall } @nodes;
 768                 @nodes = grep { $_->dxchan != $self } @nodes if @nodes;
 769                 @nodes = grep { !$_->dxchan->{isolate} } @nodes if @nodes;
 770                 @localnodes = grep { $_->dxchan->{call} eq $_->{call} } @nodes if @nodes;
 771                 unshift @localnodes, DXCluster->get_exact($main::mycall);
 772                 @remotenodes = grep { $_->dxchan->{call} ne $_->{call} } @nodes if @nodes;
 773         }
 774
 775         my @s = $me->pc19(@localnodes, @remotenodes);
 776         for (@s) {
 777                 my $routeit = adjust_hops($self, $_);
 778                 $self->send($routeit) if $routeit;
 779         }
 780
 781         # get all the users connected on the above nodes and send them out
 782         foreach $n (@localnodes, @remotenodes) {
 783                 my @users = values %{$n->list};
 784                 my @s = pc16($n, @users);
 785                 for (@s) {
 786                         my $routeit = adjust_hops($self, $_);
 787                         $self->send($routeit) if $routeit;
 788                 }
 789         }
 790 }
 791
 792 #
 793 # route a message down an appropriate interface for a callsign
 794 #
 795 # is called route(to, pcline);
 796 #
 797 sub route
 798 {
 799         my ($call, $line) = @_;
 800         my $cl = DXCluster->get_exact($call);
 801         if ($cl) {
 802                 my $hops;
 803                 my $dxchan = $cl->{dxchan};
 804                 if ($dxchan) {
 805                         my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
 806                         if ($routeit) {
 807                                 $dxchan->send($routeit) if $dxchan;
 808                         }
 809                 }
 810         }
 811 }
 812
 813 # broadcast a message to all clusters taking into account isolation
 814 # [except those mentioned after buffer]
 815 sub broadcast_ak1a
 816 {
 817         my $s = shift;                          # the line to be rebroadcast
 818         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 819         my @dxchan = get_all_ak1a();
 820         my $dxchan;
 821
 822         # send it if it isn't the except list and isn't isolated and still has a hop count
 823         foreach $dxchan (@dxchan) {
 824                 next if grep $dxchan == $_, @except;
 825                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
 826                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
 827         }
 828 }
 829
 830 # broadcast a message to all clusters ignoring isolation
 831 # [except those mentioned after buffer]
 832 sub broadcast_all_ak1a
 833 {
 834         my $s = shift;                          # the line to be rebroadcast
 835         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 836         my @dxchan = get_all_ak1a();
 837         my $dxchan;
 838
 839         # send it if it isn't the except list and isn't isolated and still has a hop count
 840         foreach $dxchan (@dxchan) {
 841                 next if grep $dxchan == $_, @except;
 842                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
 843                 $dxchan->send($routeit);
 844         }
 845 }
 846
 847 # broadcast to all users
 848 # storing the spot or whatever until it is in a state to receive it
 849 sub broadcast_users
 850 {
 851         my $s = shift;                          # the line to be rebroadcast
 852         my $sort = shift;           # the type of transmission
 853         my $fref = shift;           # a reference to an object to filter on
 854         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 855         my @dxchan = get_all_users();
 856         my $dxchan;
 857         my @out;
 858
 859         foreach $dxchan (@dxchan) {
 860                 next if grep $dxchan == $_, @except;
 861                 push @out, $dxchan;
 862         }
 863         broadcast_list($s, $sort, $fref, @out);
 864 }
 865
 866 # broadcast to a list of users
 867 sub broadcast_list
 868 {
 869         my $s = shift;
 870         my $sort = shift;
 871         my $fref = shift;
 872         my $dxchan;
 873
 874         foreach $dxchan (@_) {
 875                 my $filter = 1;
 876
 877                 if ($sort eq 'dx') {
 878                     next unless $dxchan->{dx};
 879                         ($filter) = Filter::it($dxchan->{spotfilter}, @{$fref}) if ref $fref;
 880                         next unless $filter;
 881                 }
 882                 next if $sort eq 'ann' && !$dxchan->{ann};
 883                 next if $sort eq 'wwv' && !$dxchan->{wwv};
 884                 next if $sort eq 'wx' && !$dxchan->{wx};
 885
 886                 $s =~ s/\a//og unless $dxchan->{beep};
 887
 888                 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'convers') {
 889                         $dxchan->send($s);
 890                 } else {
 891                         $dxchan->delay($s);
 892                 }
 893         }
 894 }
 895
 896 #
 897 # gimme all the ak1a nodes
 898 #
 899 sub get_all_ak1a
 900 {
 901         my @list = DXChannel->get_all();
 902         my $ref;
 903         my @out;
 904         foreach $ref (@list) {
 905                 push @out, $ref if $ref->is_ak1a;
 906         }
 907         return @out;
 908 }
 909
 910 # return a list of all users
 911 sub get_all_users
 912 {
 913         my @list = DXChannel->get_all();
 914         my $ref;
 915         my @out;
 916         foreach $ref (@list) {
 917                 push @out, $ref if $ref->is_user;
 918         }
 919         return @out;
 920 }
 921
 922 # return a list of all user callsigns
 923 sub get_all_user_calls
 924 {
 925         my @list = DXChannel->get_all();
 926         my $ref;
 927         my @out;
 928         foreach $ref (@list) {
 929                 push @out, $ref->call if $ref->is_user;
 930         }
 931         return @out;
 932 }
 933
 934 #
 935 # obtain the hops from the list for this callsign and pc no
 936 #
 937
 938 sub get_hops
 939 {
 940         my ($pcno) = @_;
 941         my $hops = $DXProt::hopcount{$pcno};
 942         $hops = $DXProt::def_hopcount if !$hops;
 943         return "H$hops";
 944 }
 945
 946 #
 947 # adjust the hop count on a per node basis using the user loadable
 948 # hop table if available or else decrement an existing one
 949 #
 950
 951 sub adjust_hops
 952 {
 953         my $self = shift;
 954         my $s = shift;
 955         my $call = $self->{call};
 956         my $hops;
 957
 958         if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
 959                 my ($pcno) = $s =~ /^PC(\d\d)/o;
 960                 confess "$call called adjust_hops with '$s'" unless $pcno;
 961                 my $ref = $nodehops{$call} if %nodehops;
 962                 if ($ref) {
 963                         my $newhops = $ref->{$pcno};
 964                         return "" if defined $newhops && $newhops == 0;
 965                         $newhops = $ref->{default} unless $newhops;
 966                         return "" if defined $newhops && $newhops == 0;
 967                         $newhops = $hops if !$newhops;
 968                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
 969                 } else {
 970                         # simply decrement it
 971                         $hops--;
 972                         return "" if !$hops;
 973                         $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
 974                 }
 975         }
 976         return $s;
 977 }
 978
 979 #
 980 # load hop tables
 981 #
 982 sub load_hops
 983 {
 984         my $self = shift;
 985         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
 986         do "$main::data/hop_table.pl";
 987         return $@ if $@;
 988         return 0;
 989 }
 990
 991 # remove leading and trailing spaces from an input string
 992 sub unpad
 993 {
 994         my $s = shift;
 995         $s =~ s/^\s+|\s+$//;
 996         return $s;
 997 }
 998
 999 # add a ping request to the ping queues
1000 sub addping
1001 {
1002         my ($from, $to) = @_;
1003         my $ref = $pings{$to};
1004         $ref = $pings{$to} = [] if !$ref;
1005         my $r = {};
1006         $r->{call} = $from;
1007         $r->{t} = $main::systime;
1008         route($to, pc51($to, $main::mycall, 1));
1009         push @$ref, $r;
1010 }
1011
1012 # add a rcmd request to the rcmd queues
1013 sub addrcmd
1014 {
1015         my ($from, $to, $cmd) = @_;
1016         my $r = {};
1017         $r->{call} = $from;
1018         $r->{t} = $main::systime;
1019         $r->{cmd} = $cmd;
1020         route($to, pc34($main::mycall, $to, $cmd));
1021         $rcmds{$to} = $r;
1022 }
1023 1;
1024 __END__