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