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