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