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