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;
 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
 171                         if (!$d || ($pcno == 11 && $d < $main::systime - $pc11_max_age)) {
 172                                 dbg('chan', "Spot ignored, invalid date or too old\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");
 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", @list);
 241                                 } else {
 242                                         broadcast_users("$target de $field[1]: $text");
 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
 389                         $wwvdup{$dupkey} = $d;
 390                         Geomag::update($field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
 391
 392                         my $r;
 393                         eval {
 394                                 $r = Local::wwv2($self, $field[1], $field[2], $sfi, $k, $i, @field[6..$#field]);
 395                         };
 396                         dbg('local', "Local::wwv2 error $@") if $@;
 397                         return if $r;
 398
 399                         # DON'T be silly and send on PC27s!
 400                         return if $pcno == 27;
 401
 402                         last SWITCH;
 403                 }
 404
 405                 if ($pcno == 24) {              # set here status
 406                         my $call = uc $field[1];
 407                         my $ref = DXCluster->get_exact($call);
 408                         $ref->here($field[2]) if $ref;
 409                         last SWITCH;
 410                 }
 411
 412                 if ($pcno == 25) {      # merge request
 413                         unless ($field[1] eq $main::mycall) {
 414                                 dbg('chan', "merge request to $field[1] from $field[2] ignored");
 415                                 return;
 416                         }
 417
 418                         Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
 419
 420                         # spots
 421                         if ($field[3] > 0) {
 422                                 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]-1);
 423                                 my $in;
 424                                 foreach $in (@in) {
 425                                         $self->send(pc26(@{$in}[0..4], $in->[7]));
 426                                 }
 427                         }
 428
 429                         # wwv
 430                         if ($field[4] > 0) {
 431                                 my @in = reverse Geomag::search(0, $field[4], time, 1);
 432                                 my $in;
 433                                 foreach $in (@in) {
 434                                         $self->send(pc27(@{$in}));
 435                                 }
 436                         }
 437                         return;
 438                 }
 439
 440                 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
 441                         DXMsg::process($self, $line);
 442                         return;
 443                 }
 444
 445                 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
 446                         if ($field[1] eq $main::mycall) {
 447                                 my $ref = DXUser->get_current($field[2]);
 448                                 Log('rcmd', 'in', $ref->{priv}, $field[2], $field[3]);
 449                                 unless ($field[3] =~ /rcmd/i) {    # not allowed to relay RCMDS!
 450                                         if ($ref->{priv}) {     # you have to have SOME privilege, the commands have further filtering
 451                                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
 452                                                 my @in = (DXCommandmode::run_cmd($self, $field[3]));
 453                                                 for (@in) {
 454                                                         s/\s*$//og;
 455                                                         $self->send(pc35($main::mycall, $field[2], "$main::mycall:$_"));
 456                                                         Log('rcmd', 'out', $field[2], $_);
 457                                                 }
 458                                                 delete $self->{remotecmd};
 459                                         }
 460                                 } else {
 461                                         $self->send(pc35($main::mycall, $field[2], "$main::mycall:Tut tut tut...!"));
 462                                 }
 463                         } else {
 464                                 route($field[1], $line);
 465                         }
 466                         return;
 467                 }
 468
 469                 if ($pcno == 35) {              # remote command replies
 470                         if ($field[1] eq $main::mycall) {
 471                                 my $s = $rcmds{$field[2]};
 472                                 if ($s) {
 473                                         my $dxchan = DXChannel->get($s->{call});
 474                                         $dxchan->send($field[3]) if $dxchan;
 475                                         delete $rcmds{$field[2]} if !$dxchan;
 476                                 }
 477                         } else {
 478                                 route($field[1], $line);
 479                         }
 480                         return;
 481                 }
 482
 483                 if ($pcno == 37) {
 484                         last SWITCH;
 485                 }
 486
 487                 if ($pcno == 38) {              # node connected list from neighbour
 488                         return;
 489                 }
 490
 491                 if ($pcno == 39) {              # incoming disconnect
 492                         $self->disconnect();
 493                         return;
 494                 }
 495
 496                 if ($pcno == 41) {              # user info
 497                         # add this station to the user database, if required
 498                         my $user = DXUser->get_current($field[1]);
 499                         if (!$user) {
 500                                 # then try without an SSID
 501                                 $field[1] =~ s/-\d+$//o;
 502                                 $user = DXUser->get_current($field[1]);
 503                         }
 504                         $user = DXUser->new($field[1]) if !$user;
 505
 506                         if ($field[2] == 1) {
 507                                 $user->name($field[3]);
 508                         } elsif ($field[2] == 2) {
 509                                 $user->qth($field[3]);
 510                         } elsif ($field[2] == 3) {
 511                                 my ($lat, $long) = DXBearing::stoll($field[3]);
 512                                 $user->lat($lat);
 513                                 $user->long($long);
 514                         } elsif ($field[2] == 4) {
 515                                 $user->homenode($field[3]);
 516                         }
 517                         $user->put;
 518                         last SWITCH;
 519                 }
 520                 if ($pcno == 43) {
 521                         last SWITCH;
 522                 }
 523                 if ($pcno == 44) {
 524                         last SWITCH;
 525                 }
 526                 if ($pcno == 45) {
 527                         last SWITCH;
 528                 }
 529                 if ($pcno == 46) {
 530                         last SWITCH;
 531                 }
 532                 if ($pcno == 47) {
 533                         last SWITCH;
 534                 }
 535                 if ($pcno == 48) {
 536                         last SWITCH;
 537                 }
 538
 539                 if ($pcno == 50) {              # keep alive/user list
 540                         my $ref = DXCluster->get_exact($field[1]);
 541                         $ref->update_users($field[2]) if $ref;
 542                         last SWITCH;
 543                 }
 544
 545                 if ($pcno == 51) {              # incoming ping requests/answers
 546
 547                         # is it for us?
 548                         if ($field[1] eq $main::mycall) {
 549                                 my $flag = $field[3];
 550                                 if ($flag == 1) {
 551                                         $self->send(pc51($field[2], $field[1], '0'));
 552                                 } else {
 553                                         # it's a reply, look in the ping list for this one
 554                                         my $ref = $pings{$field[2]};
 555                                         if ($ref) {
 556                                                 my $r = shift @$ref;
 557                                                 my $dxchan = DXChannel->get($r->{call});
 558                                                 $dxchan->send($dxchan->msg('pingi', $field[2], atime($main::systime), $main::systime - $r->{t})) if $dxchan;
 559                                         }
 560                                 }
 561
 562                         } else {
 563                                 # route down an appropriate thingy
 564                                 route($field[1], $line);
 565                         }
 566                         return;
 567                 }
 568         }
 569
 570          # if get here then rebroadcast the thing with its Hop count decremented (if
 571          # there is one). If it has a hop count and it decrements to zero then don't
 572          # rebroadcast it.
 573          #
 574          # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
 575          #        REBROADCAST!!!!
 576          #
 577
 578         if (!$self->{isolate}) {
 579                 broadcast_ak1a($line, $self); # send it to everyone but me
 580         }
 581 }
 582
 583 #
 584 # This is called from inside the main cluster processing loop and is used
 585 # for despatching commands that are doing some long processing job
 586 #
 587 sub process
 588 {
 589         my $t = time;
 590         my @dxchan = DXChannel->get_all();
 591         my $dxchan;
 592
 593         foreach $dxchan (@dxchan) {
 594                 next unless $dxchan->is_ak1a();
 595                 next if $dxchan == $me;
 596
 597                 # send a pc50 out on this channel
 598                 if ($t >= $dxchan->pc50_t + $DXProt::pc50_interval) {
 599                         $dxchan->send(pc50());
 600                         $dxchan->pc50_t($t);
 601                 }
 602         }
 603
 604         my $key;
 605         my $val;
 606         my $cutoff;
 607         if ($main::systime - 3600 > $last_hour) {
 608                 $cutoff  = $main::systime - $pc11_dup_age;
 609                 while (($key, $val) = each %spotdup) {
 610                         delete $spotdup{$key} if $val < $cutoff;
 611                 }
 612                 $cutoff = $main::systime - $pc23_dup_age;
 613                 while (($key, $val) = each %wwvdup) {
 614                         delete $wwvdup{$key} if $val < $cutoff;
 615                 }
 616                 $last_hour = $main::systime;
 617         }
 618 }
 619
 620 #
 621 # finish up a pc context
 622 #
 623 sub finish
 624 {
 625         my $self = shift;
 626         my $call = $self->call;
 627         my $ref = DXCluster->get_exact($call);
 628
 629         # unbusy and stop and outgoing mail
 630         my $mref = DXMsg::get_busy($call);
 631         $mref->stop_msg($self) if $mref;
 632
 633         # broadcast to all other nodes that all the nodes connected to via me are gone
 634         my @gonenodes = map { $_->dxchan == $self ? $_ : () } DXNode::get_all();
 635         my $node;
 636
 637         foreach $node (@gonenodes) {
 638                 next if $node->call eq $call;
 639                 broadcast_ak1a(pc21($node->call, 'Gone') , $self) unless $self->{isolate};
 640                 $node->del();
 641         }
 642
 643         # remove outstanding pings
 644         delete $pings{$call};
 645
 646         # now broadcast to all other ak1a nodes that I have gone
 647         broadcast_ak1a(pc21($call, 'Gone.'), $self);
 648
 649         Log('DXProt', $call . " Disconnected");
 650         $ref->del() if $ref;
 651 }
 652
 653 #
 654 # some active measures
 655 #
 656
 657 sub send_local_config
 658 {
 659         my $self = shift;
 660         my $n;
 661         my @nodes;
 662
 663         # send our nodes
 664         if ($self->{isolate}) {
 665                 @nodes = (DXCluster->get_exact($main::mycall));
 666         } else {
 667                 # create a list of all the nodes that are not connected to this connection
 668                 @nodes = DXNode::get_all();
 669                 @nodes = grep { $_->dxchan != $self } @nodes;
 670         }
 671
 672         my @s = $me->pc19(@nodes);
 673         for (@s) {
 674                 my $routeit = adjust_hops($self, $_);
 675                 $self->send($routeit) if $routeit;
 676         }
 677
 678         # get all the users connected on the above nodes and send them out
 679         foreach $n (@nodes) {
 680                 my @users = values %{$n->list};
 681                 my @s = pc16($n, @users);
 682                 for (@s) {
 683                         my $routeit = adjust_hops($self, $_);
 684                         $self->send($routeit) if $routeit;
 685                 }
 686         }
 687 }
 688
 689 #
 690 # route a message down an appropriate interface for a callsign
 691 #
 692 # is called route(to, pcline);
 693 #
 694 sub route
 695 {
 696         my ($call, $line) = @_;
 697         my $cl = DXCluster->get_exact($call);
 698         if ($cl) {
 699                 my $hops;
 700                 my $dxchan = $cl->{dxchan};
 701                 if ($dxchan) {
 702                         my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
 703                         if ($routeit) {
 704                                 $dxchan->send($routeit) if $dxchan;
 705                         }
 706                 }
 707         }
 708 }
 709
 710 # broadcast a message to all clusters [except those mentioned after buffer]
 711 sub broadcast_ak1a
 712 {
 713         my $s = shift;                          # the line to be rebroadcast
 714         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 715         my @dxchan = get_all_ak1a();
 716         my $dxchan;
 717
 718         # send it if it isn't the except list and isn't isolated and still has a hop count
 719         foreach $dxchan (@dxchan) {
 720                 next if grep $dxchan == $_, @except;
 721                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
 722                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
 723         }
 724 }
 725
 726 # broadcast to all users
 727 sub broadcast_users
 728 {
 729         my $s = shift;                          # the line to be rebroadcast
 730         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
 731         my @dxchan = get_all_users();
 732         my $dxchan;
 733
 734         foreach $dxchan (@dxchan) {
 735                 next if grep $dxchan == $_, @except;
 736                 $s =~ s/\a//og if !$dxchan->{beep};
 737                 $dxchan->send($s);              # send it if it isn't the except list or hasn't a passout flag
 738         }
 739 }
 740
 741 # broadcast to a list of users
 742 sub broadcast_list
 743 {
 744         my $s = shift;
 745         my $dxchan;
 746
 747         foreach $dxchan (@_) {
 748                 $dxchan->send($s);              # send it
 749         }
 750 }
 751
 752 #
 753 # gimme all the ak1a nodes
 754 #
 755 sub get_all_ak1a
 756 {
 757         my @list = DXChannel->get_all();
 758         my $ref;
 759         my @out;
 760         foreach $ref (@list) {
 761                 push @out, $ref if $ref->is_ak1a;
 762         }
 763         return @out;
 764 }
 765
 766 # return a list of all users
 767 sub get_all_users
 768 {
 769         my @list = DXChannel->get_all();
 770         my $ref;
 771         my @out;
 772         foreach $ref (@list) {
 773                 push @out, $ref if $ref->is_user;
 774         }
 775         return @out;
 776 }
 777
 778 # return a list of all user callsigns
 779 sub get_all_user_calls
 780 {
 781         my @list = DXChannel->get_all();
 782         my $ref;
 783         my @out;
 784         foreach $ref (@list) {
 785                 push @out, $ref->call if $ref->is_user;
 786         }
 787         return @out;
 788 }
 789
 790 #
 791 # obtain the hops from the list for this callsign and pc no
 792 #
 793
 794 sub get_hops
 795 {
 796         my ($pcno) = @_;
 797         my $hops = $DXProt::hopcount{$pcno};
 798         $hops = $DXProt::def_hopcount if !$hops;
 799         return "H$hops";
 800 }
 801
 802 #
 803 # adjust the hop count on a per node basis using the user loadable
 804 # hop table if available or else decrement an existing one
 805 #
 806
 807 sub adjust_hops
 808 {
 809         my $self = shift;
 810         my $s = shift;
 811         my $call = $self->{call};
 812         my $hops;
 813
 814         if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
 815                 my ($pcno) = $s =~ /^PC(\d\d)/o;
 816                 confess "$call called adjust_hops with '$s'" unless $pcno;
 817                 my $ref = $nodehops{$call} if %nodehops;
 818                 if ($ref) {
 819                         my $newhops = $ref->{$pcno};
 820                         return "" if defined $newhops && $newhops == 0;
 821                         $newhops = $ref->{default} unless $newhops;
 822                         return "" if defined $newhops && $newhops == 0;
 823                         $newhops = $hops if !$newhops;
 824                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
 825                 } else {
 826                         # simply decrement it
 827                         $hops--;
 828                         return "" if !$hops;
 829                         $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
 830                 }
 831         }
 832         return $s;
 833 }
 834
 835 #
 836 # load hop tables
 837 #
 838 sub load_hops
 839 {
 840         my $self = shift;
 841         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
 842         do "$main::data/hop_table.pl";
 843         return $@ if $@;
 844         return 0;
 845 }
 846
 847 # remove leading and trailing spaces from an input string
 848 sub unpad
 849 {
 850         my $s = shift;
 851         $s =~ s/^\s+|\s+$//;
 852         return $s;
 853 }
 854
 855 # add a ping request to the ping queues
 856 sub addping
 857 {
 858         my ($from, $to) = @_;
 859         my $ref = $pings{$to};
 860         $ref = $pings{$to} = [] if !$ref;
 861         my $r = {};
 862         $r->{call} = $from;
 863         $r->{t} = $main::systime;
 864         route($to, pc51($to, $main::mycall, 1));
 865         push @$ref, $r;
 866 }
 867
 868 # add a rcmd request to the rcmd queues
 869 sub addrcmd
 870 {
 871         my ($from, $to, $cmd) = @_;
 872         my $r = {};
 873         $r->{call} = $from;
 874         $r->{t} = $main::systime;
 875         $r->{cmd} = $cmd;
 876         route($to, pc34($main::mycall, $to, $cmd));
 877         $rcmds{$to} = $r;
 878 }
 879 1;
 880 __END__