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 DXProtVars;
  19 use DXCommandmode;
  20 use DXLog;
  21 use Spot;
  22 use DXProtout;
  23 use DXDebug;
  24 use Filter;
  25 use Local;
  26 use DXDb;
  27 use AnnTalk;
  28 use Geomag;
  29 use WCY;
  30 use Time::HiRes qw(gettimeofday tv_interval);
  31 use BadWords;
  32 use DXHash;
  33 use Route;
  34 use Route::Node;
  35
  36 use strict;
  37 use vars qw($me $pc11_max_age $pc23_max_age
  38                         $last_hour $last10 %eph  %pings %rcmds
  39                         %nodehops $baddx $badspotter $badnode $censorpc
  40                         $allowzero $decode_dk0wcy $send_opernam @checklist);
  41
  42 $me = undef;                                    # the channel id for this cluster
  43 $pc11_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc11
  44 $pc23_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc23
  45
  46 $last_hour = time;                              # last time I did an hourly periodic update
  47 %pings = ();                    # outstanding ping requests outbound
  48 %rcmds = ();                    # outstanding rcmd requests outbound
  49 %nodehops = ();                 # node specific hop control
  50 $censorpc = 1;                                  # Do a BadWords::check on text fields and reject things
  51                                                                 # loads of 'bad things'
  52 $baddx = new DXHash "baddx";
  53 $badspotter = new DXHash "badspotter";
  54 $badnode = new DXHash "badnode";
  55 $last10 = time;
  56
  57 @checklist =
  58 (
  59  [ qw(c c m bp bc c) ],                 # pc10
  60  [ qw(f m d t m c c h) ],               # pc11
  61  [ qw(c bc m bp bm p h) ],              # pc12
  62  [ qw(c h) ],                                   #
  63  [ qw(c h) ],                                   #
  64  [ qw(c m h) ],                                 #
  65  undef ,                                                # pc16 has to be validated manually
  66  [ qw(c c h) ],                                 # pc17
  67  [ qw(m n) ],                                   # pc18
  68  undef ,                                                # pc19 has to be validated manually
  69  undef ,                                                # pc20 no validation
  70  [ qw(c m h) ],                                 # pc21
  71  undef ,                                                # pc22 no validation
  72  [ qw(d n n n n m c c h) ],             # pc23
  73  [ qw(c p h) ],                                 # pc24
  74  [ qw(c c n n) ],                               # pc25
  75  [ qw(f m d t m c c bc) ],              # pc26
  76  [ qw(d n n n n m c c bc) ],    # pc27
  77  [ qw(c c m c d t p m bp n p bp bc) ], # pc28
  78  [ qw(c c n m) ],                               # pc29
  79  [ qw(c c n) ],                                 # pc30
  80  [ qw(c c n) ],                                 # pc31
  81  [ qw(c c n) ],                                 # pc32
  82  [ qw(c c n) ],                                 # pc33
  83  [ qw(c c m) ],                                 # pc34
  84  [ qw(c c m) ],                                 # pc35
  85  [ qw(c c m) ],                                 # pc36
  86  [ qw(c c n m) ],                               # pc37
  87  undef,                                                 # pc38 not interested
  88  [ qw(c m) ],                                   # pc39
  89  [ qw(c c m p n) ],                             # pc40
  90  [ qw(c n m h) ],                               # pc41
  91  [ qw(c c n) ],                                 # pc42
  92  undef,                                                 # pc43 don't handle it
  93  [ qw(c c n m m c) ],                   # pc44
  94  [ qw(c c n m) ],                               # pc45
  95  [ qw(c c n) ],                                 # pc46
  96  undef,                                                 # pc47
  97  undef,                                                 # pc48
  98  [ qw(c m h) ],                                 # pc49
  99  [ qw(c n h) ],                                 # pc50
 100  [ qw(c c n) ],                                 # pc51
 101  undef,
 102  undef,
 103  undef,
 104  undef,
 105  undef,
 106  undef,
 107  undef,
 108  undef,
 109  undef,                                                 # pc60
 110  undef,
 111  undef,
 112  undef,
 113  undef,
 114  undef,
 115  undef,
 116  undef,
 117  undef,
 118  undef,
 119  undef,                                                 # pc70
 120  undef,
 121  undef,
 122  [ qw(d n n n n n n m m m c c h) ],     # pc73
 123  undef,
 124  undef,
 125  undef,
 126  undef,
 127  undef,
 128  undef,
 129  undef,                                                 # pc80
 130  undef,
 131  undef,
 132  undef,
 133  [ qw(c c c m) ],                               # pc84
 134  [ qw(c c c m) ],                               # pc85
 135 );
 136
 137 # use the entry in the check list to check the field list presented
 138 # return OK if line NOT in check list (for now)
 139 sub check
 140 {
 141         my $n = shift;
 142         $n -= 10;
 143         return 0 if $n < 0 || $n > @checklist;
 144         my $ref = $checklist[$n];
 145         return 0 unless ref $ref;
 146
 147         my $i;
 148         shift;    # not interested in the first field
 149         for ($i = 0; $i < @$ref; $i++) {
 150                 my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
 151                 return 0 unless $act;
 152                 next if $blank && $_[$i] =~ /^[ \*]$/;
 153                 if ($act eq 'c') {
 154                         return $i+1 unless is_callsign($_[$i]);
 155                 } elsif ($act eq 'm') {
 156                         return $i+1 unless is_pctext($_[$i]);
 157                 } elsif ($act eq 'p') {
 158                         return $i+1 unless is_pcflag($_[$i]);
 159                 } elsif ($act eq 'f') {
 160                         return $i+1 unless is_freq($_[$i]);
 161                 } elsif ($act eq 'n') {
 162                         return $i+1 unless $_[$i] =~ /^[\d ]+$/;
 163                 } elsif ($act eq 'h') {
 164                         return $i+1 unless $_[$i] =~ /^H\d\d?$/;
 165                 } elsif ($act eq 'd') {
 166                         return $i+1 unless $_[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
 167                 } elsif ($act eq 't') {
 168                         return $i+1 unless $_[$i] =~ /^[012]\d[012345]\dZ$/;
 169                 }
 170         }
 171         return 0;
 172 }
 173
 174 sub init
 175 {
 176         my $user = DXUser->get($main::mycall);
 177         $DXProt::myprot_version += $main::version*100;
 178         $me = DXProt->new($main::mycall, 0, $user);
 179         $me->{here} = 1;
 180         $me->{state} = "indifferent";
 181         do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
 182         confess $@ if $@;
 183         $me->{sort} = 'S';    # S for spider
 184         $me->{priv} = 9;
 185 #       $Route::Node::me->adddxchan($me);
 186 }
 187
 188 #
 189 # obtain a new connection this is derived from dxchannel
 190 #
 191
 192 sub new
 193 {
 194         my $self = DXChannel::alloc(@_);
 195
 196         # add this node to the table, the values get filled in later
 197         my $pkg = shift;
 198         my $call = shift;
 199         $main::routeroot->add($call, '0000', Route::here(1)) if $call ne $main::mycall;
 200
 201         return $self;
 202 }
 203
 204 # this is how a pc connection starts (for an incoming connection)
 205 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
 206 # all the crap that comes between).
 207 sub start
 208 {
 209         my ($self, $line, $sort) = @_;
 210         my $call = $self->{call};
 211         my $user = $self->{user};
 212
 213         # remember type of connection
 214         $self->{consort} = $line;
 215         $self->{outbound} = $sort eq 'O';
 216         $self->{priv} = $user->priv || 1;     # other clusters can always be 'normal' users
 217         $self->{lang} = $user->lang || 'en';
 218         $self->{isolate} = $user->{isolate};
 219         $self->{consort} = $line;       # save the connection type
 220         $self->{here} = 1;
 221
 222         # get the output filters
 223         $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
 224         $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
 225         $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
 226         $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
 227         $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) ;
 228
 229
 230         # get the INPUT filters (these only pertain to Clusters)
 231         $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
 232         $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
 233         $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
 234         $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
 235         $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1);
 236
 237         # set unbuffered and no echo
 238         $self->send_now('B',"0");
 239         $self->send_now('E',"0");
 240
 241         # ping neighbour node stuff
 242         my $ping = $user->pingint;
 243         $ping = 5*60 unless defined $ping;
 244         $self->{pingint} = $ping;
 245         $self->{nopings} = $user->nopings || 2;
 246         $self->{pingtime} = [ ];
 247         $self->{pingave} = 0;
 248
 249         # send initialisation string
 250         unless ($self->{outbound}) {
 251                 $self->send(pc18());
 252                 $self->{lastping} = $main::systime;
 253         } else {
 254                 $self->{lastping} = $main::systime + ($self->pingint / 2);
 255         }
 256         $self->state('init');
 257         $self->{pc50_t} = $main::systime;
 258
 259         # send info to all logged in thingies
 260         $self->tell_login('loginn');
 261
 262         Log('DXProt', "$call connected");
 263 }
 264
 265 #
 266 # This is the normal pcxx despatcher
 267 #
 268 sub normal
 269 {
 270         my ($self, $line) = @_;
 271         my @field = split /\^/, $line;
 272         return unless @field;
 273
 274         pop @field if $field[-1] eq '~';
 275
 276 #       print join(',', @field), "\n";
 277
 278
 279         # process PC frames, this will fail unless the frame starts PCnn
 280         my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
 281         return unless $pcno;
 282         return if $pcno < 10 || $pcno > 99;
 283
 284         # check for and dump bad protocol messages
 285         my $n = check($pcno, @field);
 286         if ($n) {
 287                 dbg("PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")") if isdbg('chanerr');
 288                 return;
 289         }
 290
 291         # local processing 1
 292         my $pcr;
 293         eval {
 294                 $pcr = Local::pcprot($self, $pcno, @field);
 295         };
 296 #       dbg("Local::pcprot error $@") if isdbg('local') if $@;
 297         return if $pcr;
 298
 299  SWITCH: {
 300                 if ($pcno == 10) {              # incoming talk
 301
 302                         # will we allow it at all?
 303                         if ($censorpc) {
 304                                 my @bad;
 305                                 if (@bad = BadWords::check($field[3])) {
 306                                         dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
 307                                         return;
 308                                 }
 309                         }
 310
 311                         # is it for me or one of mine?
 312                         my ($to, $via, $call, $dxchan);
 313                         if ($field[5] gt ' ') {
 314                                 $call = $via = $field[2];
 315                                 $to = $field[5];
 316                         } else {
 317                                 $call = $to = $field[2];
 318                         }
 319                         $dxchan = DXChannel->get($main::myalias) if $call eq $main::mycall;
 320                         $dxchan = DXChannel->get($call) unless $dxchan;
 321                         if ($dxchan && $dxchan->is_user) {
 322                                 $field[3] =~ s/\%5E/^/g;
 323                                 $dxchan->talk($field[1], $to, $via, $field[3]);
 324                         } else {
 325                                 $self->route($field[2], $line); # relay it on its way
 326                         }
 327                         return;
 328                 }
 329
 330                 if ($pcno == 11 || $pcno == 26) { # dx spot
 331
 332                         # route 'foreign' pc26s
 333                         if ($pcno == 26) {
 334                                 if ($field[7] ne $main::mycall) {
 335                                         $self->route($field[7], $line);
 336                                         return;
 337                                 }
 338                         }
 339
 340                         # if this is a 'nodx' node then ignore it
 341                         if ($badnode->in($field[7])) {
 342                                 dbg("PCPROT: Bad Node, dropped") if isdbg('chanerr');
 343                                 return;
 344                         }
 345
 346                         # if this is a 'bad spotter' user then ignore it
 347                         if ($badspotter->in($field[6])) {
 348                                 dbg("PCPROT: Bad Spotter, dropped") if isdbg('chanerr');
 349                                 return;
 350                         }
 351
 352                         # convert the date to a unix date
 353                         my $d = cltounix($field[3], $field[4]);
 354                         # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
 355                         if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
 356                                 dbg("PCPROT: Spot ignored, invalid date or out of range ($field[3] $field[4])\n") if isdbg('chanerr');
 357                                 return;
 358                         }
 359
 360                         # is it 'baddx'
 361                         if ($baddx->in($field[2])) {
 362                                 dbg("PCPROT: Bad DX spot, ignored") if isdbg('chanerr');
 363                                 return;
 364                         }
 365
 366                         # do some de-duping
 367                         $field[5] =~ s/^\s+//;      # take any leading blanks off
 368                         $field[2] = unpad($field[2]);   # take off leading and trailing blanks from spotted callsign
 369                         if ($field[2] =~ /BUST\w*$/) {
 370                                 dbg("PCPROT: useless 'BUSTED' spot") if isdbg('chanerr');
 371                                 return;
 372                         }
 373                         if (Spot::dup($field[1], $field[2], $d, $field[5])) {
 374                                 dbg("PCPROT: Duplicate Spot ignored\n") if isdbg('chanerr');
 375                                 return;
 376                         }
 377                         if ($censorpc) {
 378                                 my @bad;
 379                                 if (@bad = BadWords::check($field[5])) {
 380                                         dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
 381                                         return;
 382                                 }
 383                         }
 384
 385                         my @spot = Spot::prepare($field[1], $field[2], $d, $field[5], $field[6], $field[7]);
 386                         # global spot filtering on INPUT
 387                         if ($self->{inspotsfilter}) {
 388                                 my ($filter, $hops) = $self->{inspotsfilter}->it(@spot);
 389                                 unless ($filter) {
 390                                         dbg("PCPROT: Rejected by input spot filter") if isdbg('chanerr');
 391                                         return;
 392                                 }
 393                         }
 394
 395                         # add it
 396                         Spot::add(@spot);
 397
 398             #
 399                         # @spot at this point contains:-
 400             # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
 401                         # then  spotted itu, spotted cq, spotters itu, spotters cq
 402                         # you should be able to route on any of these
 403             #
 404
 405                         # fix up qra locators of known users
 406                         my $user = DXUser->get_current($spot[4]);
 407                         if ($user) {
 408                                 my $qra = $user->qra;
 409                                 unless ($qra && is_qra($qra)) {
 410                                         my $lat = $user->lat;
 411                                         my $long = $user->long;
 412                                         if (defined $lat && defined $long) {
 413                                                 $user->qra(DXBearing::lltoqra($lat, $long));
 414                                                 $user->put;
 415                                         }
 416                                 }
 417
 418                                 # send a remote command to a distant cluster if it is visible and there is no
 419                                 # qra locator and we havn't done it for a month.
 420
 421                                 unless ($user->qra) {
 422                                         my $node;
 423                                         my $to = $user->homenode;
 424                                         my $last = $user->lastoper || 0;
 425                                         if ($send_opernam && $to && $to ne $main::mycall && $main::systime > $last + $DXUser::lastoperinterval && ($node = Route::Node::get($to)) ) {
 426                                                 my $cmd = "forward/opernam $spot[4]";
 427                                                 # send the rcmd but we aren't interested in the replies...
 428                                                 my $dxchan = $node->dxchan;
 429                                                 if ($dxchan && $dxchan->is_clx) {
 430                                                         route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
 431                                                 } else {
 432                                                         route(undef, $to, pc34($main::mycall, $to, $cmd));
 433                                                 }
 434                                                 if ($to ne $field[7]) {
 435                                                         $to = $field[7];
 436                                                         $node = Route::Node::get($to);
 437                                                         if ($node) {
 438                                                                 $dxchan = $node->dxchan;
 439                                                                 if ($dxchan && $dxchan->is_clx) {
 440                                                                         route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
 441                                                                 } else {
 442                                                                         route(undef, $to, pc34($main::mycall, $to, $cmd));
 443                                                                 }
 444                                                         }
 445                                                 }
 446                                                 $user->lastoper($main::systime);
 447                                                 $user->put;
 448                                         }
 449                                 }
 450                         }
 451
 452                         # local processing
 453                         my $r;
 454                         eval {
 455                                 $r = Local::spot($self, @spot);
 456                         };
 457 #                       dbg("Local::spot1 error $@") if isdbg('local') if $@;
 458                         return if $r;
 459
 460                         # DON'T be silly and send on PC26s!
 461                         return if $pcno == 26;
 462
 463                         # send out the filtered spots
 464                         send_dx_spot($self, $line, @spot) if @spot;
 465                         return;
 466                 }
 467
 468                 if ($pcno == 12) {              # announces
 469                         # announce duplicate checking
 470                         $field[3] =~ s/^\s+//;  # remove leading blanks
 471                         if (AnnTalk::dup($field[1], $field[2], $field[3])) {
 472                                 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
 473                                 return;
 474                         }
 475
 476                         if ($censorpc) {
 477                                 my @bad;
 478                                 if (@bad = BadWords::check($field[3])) {
 479                                         dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
 480                                         return;
 481                                 }
 482                         }
 483
 484                         if ($field[2] eq '*' || $field[2] eq $main::mycall) {
 485
 486                                 # global ann filtering on INPUT
 487                                 if ($self->{inannfilter}) {
 488                                         my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
 489                                         my @dxcc = Prefix::extract($field[1]);
 490                                         if (@dxcc > 0) {
 491                                                 $ann_dxcc = $dxcc[1]->dxcc;
 492                                                 $ann_itu = $dxcc[1]->itu;
 493                                                 $ann_cq = $dxcc[1]->cq();
 494                                         }
 495                                         @dxcc = Prefix::extract($field[5]);
 496                                         if (@dxcc > 0) {
 497                                                 $org_dxcc = $dxcc[1]->dxcc;
 498                                                 $org_itu = $dxcc[1]->itu;
 499                                                 $org_cq = $dxcc[1]->cq();
 500                                         }
 501                                         my ($filter, $hops) = $self->{inannfilter}->it(@field[1..6], $self->{call},
 502                                                                                                         $ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq);
 503                                         unless ($filter) {
 504                                                 dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
 505                                                 return;
 506                                         }
 507                                 }
 508
 509                                 # send it
 510                                 $self->send_announce($line, @field[1..6]);
 511                         } else {
 512                                 $self->route($field[2], $line);
 513                         }
 514
 515                         return;
 516                 }
 517
 518                 if ($pcno == 13) {
 519                         last SWITCH;
 520                 }
 521                 if ($pcno == 14) {
 522                         last SWITCH;
 523                 }
 524                 if ($pcno == 15) {
 525                         last SWITCH;
 526                 }
 527
 528                 if ($pcno == 16) {              # add a user
 529
 530                         # general checks
 531                         my $dxchan;
 532                         my $ncall = $field[1];
 533                         my $newline = "PC16^";
 534
 535                         if ($ncall eq $main::mycall) {
 536                                 dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
 537                                 return;
 538                         }
 539                         $dxchan = DXChannel->get($ncall);
 540                         if ($dxchan && $dxchan ne $self) {
 541                                 dbg("PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
 542                                 return;
 543                         }
 544                         my $parent = Route::Node::get($ncall);
 545                         unless ($parent) {
 546                                 dbg("PCPROT: Node $ncall not in config") if isdbg('chanerr');
 547                                 return;
 548                         }
 549
 550                         # input filter if required
 551                         return unless $self->in_filter_route($parent);
 552
 553                         my $i;
 554                         my @rout;
 555                         for ($i = 2; $i < $#field; $i++) {
 556                                 my ($call, $conf, $here) = $field[$i] =~ /^(\S+) (\S) (\d)/o;
 557                                 next unless $call && $conf && defined $here && is_callsign($call);
 558                                 next if $call eq $main::mycall;
 559
 560                                 eph_del_regex("^PC17\^$call\^$ncall");
 561
 562                                 $conf = $conf eq '*';
 563
 564                                 my $r = Route::User::get($call);
 565                                 my $flags = Route::here($here)|Route::conf($conf);
 566
 567                                 if ($r) {
 568                                         if ($r->flags != $flags) {
 569                                                 $r->flags($flags);
 570                                                 push @rout, $r;
 571                                         }
 572                                         $r->addparent($ncall);
 573                                 } else {
 574                                         push @rout, $parent->add_user($call, $flags);
 575                                 }
 576
 577                                 # add this station to the user database, if required
 578                                 $call =~ s/-\d+$//o;        # remove ssid for users
 579                                 my $user = DXUser->get_current($call);
 580                                 $user = DXUser->new($call) if !$user;
 581                                 $user->homenode($parent->call) if !$user->homenode;
 582                                 $user->node($parent->call);
 583                                 $user->lastin($main::systime) unless DXChannel->get($call);
 584                                 $user->put;
 585                         }
 586
 587                         if (eph_dup($line)) {
 588                                 dbg("PCPROT: dup PC16 detected") if isdbg('chanerr');
 589                                 return;
 590                         }
 591
 592                         # queue up any messages (look for privates only)
 593                         DXMsg::queue_msg(1) if $self->state eq 'normal';
 594
 595                         $self->route_pc16($parent, @rout) if @rout;
 596                         return;
 597                 }
 598
 599                 if ($pcno == 17) {              # remove a user
 600                         my $dxchan;
 601                         my $ncall = $field[2];
 602                         my $ucall = $field[1];
 603
 604                         eph_del_regex("^PC16.*$ncall.*$ucall");
 605
 606                         if ($ncall eq $main::mycall) {
 607                                 dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
 608                                 return;
 609                         }
 610                         $dxchan = DXChannel->get($ncall);
 611                         if ($dxchan && $dxchan ne $self) {
 612                                 dbg("PCPROT: PC17 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
 613                                 return;
 614                         }
 615                         my $parent = Route::Node::get($ncall);
 616                         unless ($parent) {
 617                                 dbg("PCPROT: Route::Node $ncall not in config") if isdbg('chanerr');
 618                                 return;
 619                         }
 620
 621                         # input filter if required
 622                         return unless $self->in_filter_route($parent);
 623
 624                         my @rout = $parent->del_user($ucall);
 625
 626                         if (eph_dup($line)) {
 627                                 dbg("PCPROT: dup PC17 detected") if isdbg('chanerr');
 628                                 return;
 629                         }
 630
 631                         $self->route_pc17($parent, @rout) if @rout;
 632                         return;
 633                 }
 634
 635                 if ($pcno == 18) {              # link request
 636                         $self->state('init');
 637
 638                         # first clear out any nodes on this dxchannel
 639                         my $parent = Route::Node::get($self->{call});
 640                         my @rout = $parent->del_nodes;
 641                         $self->route_pc21(@rout, $parent);
 642                         $self->send_local_config();
 643                         $self->send(pc20());
 644                         return;             # we don't pass these on
 645                 }
 646
 647                 if ($pcno == 19) {              # incoming cluster list
 648                         my $i;
 649                         my $newline = "PC19^";
 650
 651                         # new routing list
 652                         my @rout;
 653                         my $parent = Route::Node::get($self->{call});
 654                         unless ($parent) {
 655                                 dbg("DXPROT: my parent $self->{call} has disappeared");
 656                                 $self->disconnect;
 657                                 return;
 658                         }
 659
 660                         # parse the PC19
 661                         for ($i = 1; $i < $#field-1; $i += 4) {
 662                                 my $here = $field[$i];
 663                                 my $call = uc $field[$i+1];
 664                                 my $conf = $field[$i+2];
 665                                 my $ver = $field[$i+3];
 666                                 next unless defined $here && defined $conf && is_callsign($call);
 667
 668                                 eph_del_regex("^PC(?:21\^$call|17\^[^\^]+\^$call)");
 669
 670                                 # check for sane parameters
 671                                 $ver = 5000 if $ver eq '0000';
 672                                 next if $ver < 5000; # only works with version 5 software
 673                                 next if length $call < 3; # min 3 letter callsigns
 674                                 next if $call eq $main::mycall;
 675
 676                                 # update it if required
 677                                 my $r = Route::Node::get($call);
 678                                 my $flags = Route::here($here)|Route::conf($conf);
 679                                 if ($r) {
 680                                         my $ar;
 681                                         if ($call ne $parent->call) {
 682                                                 if ($self->in_filter_route($r)) {
 683                                                         $ar = $parent->add($call, $ver, $flags);
 684                                                         push @rout, $ar if $ar;
 685                                                 } else {
 686                                                         next;
 687                                                 }
 688                                         }
 689                                         if ($r->version ne $ver || $r->flags != $flags) {
 690                                                 $r->version($ver);
 691                                                 $r->flags($flags);
 692                                                 push @rout, $r unless $ar;
 693                                         }
 694                                 } else {
 695                                         if ($call eq $self->{call}) {
 696                                                 dbg("DXPROT: my channel route for $call has disappeared");
 697                                                 next;
 698                                         };
 699
 700                                         my $new = Route->new($call);          # throw away
 701                                     if ($self->in_filter_route($new)) {
 702                                                 my $r = $parent->add($call, $ver, $flags);
 703                                                 push @rout, $r;
 704                                         } else {
 705                                                 next;
 706                                         }
 707                                 }
 708
 709                                 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
 710                                 my $mref = DXMsg::get_busy($call);
 711                                 $mref->stop_msg($call) if $mref;
 712
 713                                 # add this station to the user database, if required (don't remove SSID from nodes)
 714                                 my $user = DXUser->get_current($call);
 715                                 if (!$user) {
 716                                         $user = DXUser->new($call);
 717                                         $user->sort('A');
 718                                         $user->priv(1);                   # I have relented and defaulted nodes
 719                                         $self->{priv} = 1;                # to user RCMDs allowed
 720                                         $user->homenode($call);
 721                                         $user->node($call);
 722                                 }
 723                                 $user->lastin($main::systime) unless DXChannel->get($call);
 724                                 $user->put;
 725                         }
 726
 727                         if (eph_dup($line)) {
 728                                 dbg("PCPROT: dup PC19 detected") if isdbg('chanerr');
 729                                 return;
 730                         }
 731
 732                         $self->route_pc19(@rout) if @rout;
 733                         return;
 734                 }
 735
 736                 if ($pcno == 20) {              # send local configuration
 737                         $self->send_local_config();
 738                         $self->send(pc22());
 739                         $self->state('normal');
 740                         return;
 741                 }
 742
 743                 if ($pcno == 21) {              # delete a cluster from the list
 744                         my $call = uc $field[1];
 745
 746                         eph_del_regex("^PC1[79].*$call");
 747
 748                         my @rout;
 749                         my $parent = Route::Node::get($self->{call});
 750                         unless ($parent) {
 751                                 dbg("DXPROT: my parent $self->{call} has disappeared");
 752                                 $self->disconnect;
 753                                 return;
 754                         }
 755                         my $node = Route::Node::get($call);
 756                         if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
 757                                 if ($call eq $self->{call}) {
 758                                         dbg("PCPROT: Trying to disconnect myself with PC21") if isdbg('chanerr');
 759                                         return;
 760                                 }
 761
 762                                 if ($node) {
 763                                         # input filter it
 764                                         return unless $self->in_filter_route($node);
 765
 766                                         # routing objects
 767                                         push @rout, $node->del($parent);
 768                                 }
 769                         } else {
 770                                 dbg("PCPROT: I WILL _NOT_ be disconnected!") if isdbg('chanerr');
 771                                 return;
 772                         }
 773
 774                         if (eph_dup($line)) {
 775                                 dbg("PCPROT: dup PC21 detected") if isdbg('chanerr');
 776                                 return;
 777                         }
 778
 779                         $self->route_pc21(@rout) if @rout;
 780                         return;
 781                 }
 782
 783                 if ($pcno == 22) {
 784                         $self->state('normal');
 785                         return;
 786                 }
 787
 788                 if ($pcno == 23 || $pcno == 27) { # WWV info
 789
 790                         # route 'foreign' pc27s
 791                         if ($pcno == 27) {
 792                                 if ($field[8] ne $main::mycall) {
 793                                         $self->route($field[8], $line);
 794                                         return;
 795                                 }
 796                         }
 797
 798                         # do some de-duping
 799                         my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
 800                         my $sfi = unpad($field[3]);
 801                         my $k = unpad($field[4]);
 802                         my $i = unpad($field[5]);
 803                         my ($r) = $field[6] =~ /R=(\d+)/;
 804                         $r = 0 unless $r;
 805                         if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
 806                                 dbg("PCPROT: WWV Date ($field[1] $field[2]) out of range") if isdbg('chanerr');
 807                                 return;
 808                         }
 809                         if (Geomag::dup($d,$sfi,$k,$i,$field[6])) {
 810                                 dbg("PCPROT: Dup WWV Spot ignored\n") if isdbg('chanerr');
 811                                 return;
 812                         }
 813                         $field[7] =~ s/-\d+$//o;            # remove spotter's ssid
 814
 815                         my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..8], $r);
 816
 817                         my $rep;
 818                         eval {
 819                                 $rep = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..8], $r);
 820                         };
 821 #                       dbg("Local::wwv2 error $@") if isdbg('local') if $@;
 822                         return if $rep;
 823
 824                         # DON'T be silly and send on PC27s!
 825                         return if $pcno == 27;
 826
 827                         # broadcast to the eager world
 828                         send_wwv_spot($self, $line, $d, $field[2], $sfi, $k, $i, @field[6..8]);
 829                         return;
 830                 }
 831
 832                 if ($pcno == 24) {              # set here status
 833                         my $call = uc $field[1];
 834                         my ($nref, $uref);
 835                         $nref = Route::Node::get($call);
 836                         $uref = Route::User::get($call);
 837                         return unless $nref || $uref;   # if we don't know where they are, it's pointless sending it on
 838
 839                         unless (eph_dup($line)) {
 840                                 $nref->here($field[2]) if $nref;
 841                                 $uref->here($field[2]) if $uref;
 842                                 my $ref = $nref || $uref;
 843                                 return unless $self->in_filter_route($ref);
 844                                 $self->route_pc24($ref, $field[3]);
 845                         }
 846                         return;
 847                 }
 848
 849                 if ($pcno == 25) {      # merge request
 850                         if ($field[1] ne $main::mycall) {
 851                                 $self->route($field[1], $line);
 852                                 return;
 853                         }
 854                         if ($field[2] eq $main::mycall) {
 855                                 dbg("PCPROT: Trying to merge to myself, ignored") if isdbg('chanerr');
 856                                 return;
 857                         }
 858
 859                         Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[1]");
 860
 861                         # spots
 862                         if ($field[3] > 0) {
 863                                 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]);
 864                                 my $in;
 865                                 foreach $in (@in) {
 866                                         $self->send(pc26(@{$in}[0..4], $field[2]));
 867                                 }
 868                         }
 869
 870                         # wwv
 871                         if ($field[4] > 0) {
 872                                 my @in = reverse Geomag::search(0, $field[4], time, 1);
 873                                 my $in;
 874                                 foreach $in (@in) {
 875                                         $self->send(pc27(@{$in}[0..5], $field[2]));
 876                                 }
 877                         }
 878                         return;
 879                 }
 880
 881                 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
 882                         if ($pcno == 49 || $field[1] eq $main::mycall) {
 883                                 DXMsg::process($self, $line);
 884                         } else {
 885                                 $self->route($field[1], $line) unless $self->is_clx;
 886                         }
 887                         return;
 888                 }
 889
 890                 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
 891                         $self->process_rcmd($field[1], $field[2], $field[2], $field[3]);
 892                         return;
 893                 }
 894
 895                 if ($pcno == 35) {              # remote command replies
 896                         $self->process_rcmd_reply($field[1], $field[2], $field[1], $field[3]);
 897                         return;
 898                 }
 899
 900                 # for pc 37 see 44 onwards
 901
 902                 if ($pcno == 38) {              # node connected list from neighbour
 903                         return;
 904                 }
 905
 906                 if ($pcno == 39) {              # incoming disconnect
 907                         if ($field[1] eq $self->{call}) {
 908                                 $self->disconnect(1);
 909                                 eph_del_regex("^PC(?:1[679]|21).*$field[1]");
 910                         } else {
 911                                 dbg("PCPROT: came in on wrong channel") if isdbg('chanerr');
 912                         }
 913                         return;
 914                 }
 915
 916                 if ($pcno == 41) {              # user info
 917                         my $call = $field[1];
 918
 919                         # input filter if required
 920 #                       my $ref = Route::get($call) || Route->new($call);
 921 #                       return unless $self->in_filter_route($ref);
 922
 923                         if ($field[3] eq $field[2]) {
 924                                 dbg('PCPROT: invalid value') if isdbg('chanerr');
 925                                 return;
 926                         }
 927
 928                         # add this station to the user database, if required
 929                         my $user = DXUser->get_current($call);
 930                         $user = DXUser->new($call) if !$user;
 931
 932                         if ($field[2] == 1) {
 933                                 $user->name($field[3]);
 934                         } elsif ($field[2] == 2) {
 935                                 $user->qth($field[3]);
 936                         } elsif ($field[2] == 3) {
 937                                 if (is_latlong($field[3])) {
 938                                         my ($lat, $long) = DXBearing::stoll($field[3]);
 939                                         $user->lat($lat);
 940                                         $user->long($long);
 941                                         $user->qra(DXBearing::lltoqra($lat, $long));
 942                                 } else {
 943                                         dbg('PCPROT: not a valid lat/long') if isdbg('chanerr');
 944                                         return;
 945                                 }
 946                         } elsif ($field[2] == 4) {
 947                                 $user->homenode($field[3]);
 948                         } elsif ($field[2] == 5) {
 949                                 if (is_qra($field[3])) {
 950                                         my ($lat, $long) = DXBearing::qratoll($field[3]);
 951                                         $user->lat($lat);
 952                                         $user->long($long);
 953                                         $user->qra($field[3]);
 954                                 } else {
 955                                         dbg('PCPROT: not a valid QRA locator') if isdbg('chanerr');
 956                                         return;
 957                                 }
 958                         }
 959                         $user->lastoper($main::systime);   # to cut down on excessive for/opers being generated
 960                         $user->put;
 961
 962 #  perhaps this IS what we want after all
 963 #                       $self->route_pc41($ref, $call, $field[2], $field[3], $field[4]);
 964 #                       return;
 965                 }
 966
 967                 if ($pcno == 43) {
 968                         last SWITCH;
 969                 }
 970
 971                 if ($pcno == 37 || $pcno == 44 || $pcno == 45 || $pcno == 46 || $pcno == 47 || $pcno == 48) {
 972                         DXDb::process($self, $line);
 973                         return;
 974                 }
 975
 976                 if ($pcno == 50) {              # keep alive/user list
 977                         my $call = $field[1];
 978                         my $node = Route::Node::get($call);
 979                         if ($node) {
 980                                 return unless $node->call eq $self->{call};
 981                                 $node->usercount($field[2]);
 982
 983                                 # input filter if required
 984                                 return unless $self->in_filter_route($node);
 985
 986                                 $self->route_pc50($node, $field[2], $field[3]) unless eph_dup($line);
 987                         }
 988                         return;
 989                 }
 990
 991                 if ($pcno == 51) {              # incoming ping requests/answers
 992                         my $to = $field[1];
 993                         my $from = $field[2];
 994                         my $flag = $field[3];
 995
 996
 997                         # is it for us?
 998                         if ($to eq $main::mycall) {
 999                                 if ($flag == 1) {
1000                                         $self->send(pc51($from, $to, '0'));
1001                                 } else {
1002                                         # it's a reply, look in the ping list for this one
1003                                         my $ref = $pings{$from};
1004                                         if ($ref) {
1005                                                 my $tochan =  DXChannel->get($from);
1006                                                 while (@$ref) {
1007                                                         my $r = shift @$ref;
1008                                                         my $dxchan = DXChannel->get($r->{call});
1009                                                         next unless $dxchan;
1010                                                         my $t = tv_interval($r->{t}, [ gettimeofday ]);
1011                                                         if ($dxchan->is_user) {
1012                                                                 my $s = sprintf "%.2f", $t;
1013                                                                 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
1014                                                                 $dxchan->send($dxchan->msg('pingi', $from, $s, $ave))
1015                                                         } elsif ($dxchan->is_node) {
1016                                                                 if ($tochan) {
1017                                                                         $tochan->{nopings} = $tochan->user->nopings || 2; # pump up the timer
1018                                                                         push @{$tochan->{pingtime}}, $t;
1019                                                                         shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
1020                                                                         my $st;
1021                                                                         for (@{$tochan->{pingtime}}) {
1022                                                                                 $st += $_;
1023                                                                         }
1024                                                                         $tochan->{pingave} = $st / @{$tochan->{pingtime}};
1025                                                                 }
1026                                                         }
1027                                                 }
1028                                         }
1029                                 }
1030                         } else {
1031                                 if (eph_dup($line)) {
1032                                         dbg("PCPROT: dup PC51 detected") if isdbg('chanerr');
1033                                         return;
1034                                 }
1035                                 # route down an appropriate thingy
1036                                 $self->route($to, $line);
1037                         }
1038                         return;
1039                 }
1040
1041                 if ($pcno == 75) {              # dunno but route it
1042                         my $call = $field[1];
1043                         if ($call ne $main::mycall) {
1044                                 $self->route($call, $line);
1045                         }
1046                         return;
1047                 }
1048
1049                 if ($pcno == 73) {  # WCY broadcasts
1050                         my $call = $field[1];
1051
1052                         # do some de-duping
1053                         my $d = cltounix($call, sprintf("%02d18Z", $field[2]));
1054                         if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
1055                                 dbg("PCPROT: WCY Date ($call $field[2]) out of range") if isdbg('chanerr');
1056                                 return;
1057                         }
1058                         @field = map { unpad($_) } @field;
1059                         if (WCY::dup($d,@field[3..7])) {
1060                                 dbg("PCPROT: Dup WCY Spot ignored\n") if isdbg('chanerr');
1061                                 return;
1062                         }
1063
1064                         my $wcy = WCY::update($d, @field[2..12]);
1065
1066                         my $rep;
1067                         eval {
1068                                 $rep = Local::wwv($self, @field[1..12]);
1069                         };
1070                         # dbg("Local::wcy error $@") if isdbg('local') if $@;
1071                         return if $rep;
1072
1073                         # broadcast to the eager world
1074                         send_wcy_spot($self, $line, $d, @field[2..12]);
1075                         return;
1076                 }
1077
1078                 if ($pcno == 84) { # remote commands (incoming)
1079                         $self->process_rcmd($field[1], $field[2], $field[3], $field[4]);
1080                         return;
1081                 }
1082
1083                 if ($pcno == 85) {              # remote command replies
1084                         $self->process_rcmd_reply($field[1], $field[2], $field[3], $field[4]);
1085
1086                         return;
1087                 }
1088         }
1089
1090         # if get here then rebroadcast the thing with its Hop count decremented (if
1091         # there is one). If it has a hop count and it decrements to zero then don't
1092         # rebroadcast it.
1093         #
1094         # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
1095         #        REBROADCAST!!!!
1096         #
1097
1098         if (eph_dup($line)) {
1099                 dbg("PCPROT: Ephemeral dup, dropped") if isdbg('chanerr');
1100         } else {
1101                 unless ($self->{isolate}) {
1102                         broadcast_ak1a($line, $self); # send it to everyone but me
1103                 }
1104         }
1105 }
1106
1107 #
1108 # This is called from inside the main cluster processing loop and is used
1109 # for despatching commands that are doing some long processing job
1110 #
1111 sub process
1112 {
1113         my $t = time;
1114         my @dxchan = DXChannel->get_all();
1115         my $dxchan;
1116
1117         foreach $dxchan (@dxchan) {
1118                 next unless $dxchan->is_node();
1119                 next if $dxchan == $me;
1120
1121                 # send a pc50 out on this channel
1122                 $dxchan->{pc50_t} = $main::systime unless exists $dxchan->{pc50_t};
1123                 if ($t >= $dxchan->{pc50_t} + $DXProt::pc50_interval) {
1124                         my $s = pc50($me, scalar DXChannel::get_all_users);
1125                         eph_dup($s);
1126                         $dxchan->send($s);
1127                         $dxchan->{pc50_t} = $t;
1128                 }
1129
1130                 # send a ping out on this channel
1131                 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
1132                         if ($dxchan->{nopings} <= 0) {
1133                                 $dxchan->disconnect;
1134                         } else {
1135                                 addping($main::mycall, $dxchan->call);
1136                                 $dxchan->{nopings} -= 1;
1137                                 $dxchan->{lastping} = $t;
1138                         }
1139                 }
1140         }
1141
1142         # every ten seconds
1143         if ($t - $last10 >= 10) {
1144                 # clean out ephemera
1145
1146                 eph_clean();
1147
1148                 $last10 = $t;
1149         }
1150
1151         if ($main::systime - 3600 > $last_hour) {
1152                 $last_hour = $main::systime;
1153         }
1154 }
1155
1156 #
1157 # finish up a pc context
1158 #
1159
1160 #
1161 # some active measures
1162 #
1163
1164 sub send_dx_spot
1165 {
1166         my $self = shift;
1167         my $line = shift;
1168         my @dxchan = DXChannel->get_all();
1169         my $dxchan;
1170
1171         # send it if it isn't the except list and isn't isolated and still has a hop count
1172         # taking into account filtering and so on
1173         foreach $dxchan (@dxchan) {
1174                 next if $dxchan == $me;
1175                 next if $dxchan == $self && $self->is_node;
1176                 $dxchan->dx_spot($line, $self->{isolate}, @_, $self->{call});
1177         }
1178 }
1179
1180 sub dx_spot
1181 {
1182         my $self = shift;
1183         my $line = shift;
1184         my $isolate = shift;
1185         my ($filter, $hops);
1186
1187         if ($self->{spotsfilter}) {
1188                 ($filter, $hops) = $self->{spotsfilter}->it(@_);
1189                 return unless $filter;
1190         }
1191         send_prot_line($self, $filter, $hops, $isolate, $line);
1192 }
1193
1194 sub send_prot_line
1195 {
1196         my ($self, $filter, $hops, $isolate, $line) = @_;
1197         my $routeit;
1198
1199         if ($hops) {
1200                 $routeit = $line;
1201                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1202         } else {
1203                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1204                 return unless $routeit;
1205         }
1206         if ($filter) {
1207                 $self->send($routeit);
1208         } else {
1209                 $self->send($routeit) unless $self->{isolate} || $isolate;
1210         }
1211 }
1212
1213
1214 sub send_wwv_spot
1215 {
1216         my $self = shift;
1217         my $line = shift;
1218         my @dxchan = DXChannel->get_all();
1219         my $dxchan;
1220         my ($wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1221         my @dxcc = Prefix::extract($_[7]);
1222         if (@dxcc > 0) {
1223                 $wwv_dxcc = $dxcc[1]->dxcc;
1224                 $wwv_itu = $dxcc[1]->itu;
1225                 $wwv_cq = $dxcc[1]->cq;
1226         }
1227         @dxcc = Prefix::extract($_[8]);
1228         if (@dxcc > 0) {
1229                 $org_dxcc = $dxcc[1]->dxcc;
1230                 $org_itu = $dxcc[1]->itu;
1231                 $org_cq = $dxcc[1]->cq;
1232         }
1233
1234         # send it if it isn't the except list and isn't isolated and still has a hop count
1235         # taking into account filtering and so on
1236         foreach $dxchan (@dxchan) {
1237                 next if $dxchan == $me;
1238                 next if $dxchan == $self && $self->is_node;
1239                 my $routeit;
1240                 my ($filter, $hops);
1241
1242                 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, $wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq);
1243         }
1244
1245 }
1246
1247 sub wwv
1248 {
1249         my $self = shift;
1250         my $line = shift;
1251         my $isolate = shift;
1252         my ($filter, $hops);
1253
1254         if ($self->{wwvfilter}) {
1255                 ($filter, $hops) = $self->{wwvfilter}->it(@_);
1256                 return unless $filter;
1257         }
1258         send_prot_line($self, $filter, $hops, $isolate, $line)
1259 }
1260
1261 sub send_wcy_spot
1262 {
1263         my $self = shift;
1264         my $line = shift;
1265         my @dxchan = DXChannel->get_all();
1266         my $dxchan;
1267         my ($wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1268         my @dxcc = Prefix::extract($_[11]);
1269         if (@dxcc > 0) {
1270                 $wcy_dxcc = $dxcc[1]->dxcc;
1271                 $wcy_itu = $dxcc[1]->itu;
1272                 $wcy_cq = $dxcc[1]->cq;
1273         }
1274         @dxcc = Prefix::extract($_[12]);
1275         if (@dxcc > 0) {
1276                 $org_dxcc = $dxcc[1]->dxcc;
1277                 $org_itu = $dxcc[1]->itu;
1278                 $org_cq = $dxcc[1]->cq;
1279         }
1280
1281         # send it if it isn't the except list and isn't isolated and still has a hop count
1282         # taking into account filtering and so on
1283         foreach $dxchan (@dxchan) {
1284                 next if $dxchan == $me;
1285                 next if $dxchan == $self;
1286
1287                 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, $wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq);
1288         }
1289 }
1290
1291 sub wcy
1292 {
1293         my $self = shift;
1294         my $line = shift;
1295         my $isolate = shift;
1296         my ($filter, $hops);
1297
1298         if ($self->{wcyfilter}) {
1299                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
1300                 return unless $filter;
1301         }
1302         send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
1303 }
1304
1305 # send an announce
1306 sub send_announce
1307 {
1308         my $self = shift;
1309         my $line = shift;
1310         my @dxchan = DXChannel->get_all();
1311         my $dxchan;
1312         my $target;
1313         my $to = 'To ';
1314         my $text = unpad($_[2]);
1315
1316         if ($_[3] eq '*') {     # sysops
1317                 $target = "SYSOP";
1318         } elsif ($_[3] gt ' ') { # speciality list handling
1319                 my ($name) = split /\./, $_[3];
1320                 $target = "$name"; # put the rest in later (if bothered)
1321         }
1322
1323         if ($_[5] eq '1') {
1324                 $target = "WX";
1325                 $to = '';
1326         }
1327         $target = "ALL" if !$target;
1328
1329         Log('ann', $target, $_[0], $text);
1330
1331         # obtain country codes etc
1332         my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1333         my @dxcc = Prefix::extract($_[0]);
1334         if (@dxcc > 0) {
1335                 $ann_dxcc = $dxcc[1]->dxcc;
1336                 $ann_itu = $dxcc[1]->itu;
1337                 $ann_cq = $dxcc[1]->cq;
1338         }
1339         @dxcc = Prefix::extract($_[4]);
1340         if (@dxcc > 0) {
1341                 $org_dxcc = $dxcc[1]->dxcc;
1342                 $org_itu = $dxcc[1]->itu;
1343                 $org_cq = $dxcc[1]->cq;
1344         }
1345
1346         # send it if it isn't the except list and isn't isolated and still has a hop count
1347         # taking into account filtering and so on
1348         foreach $dxchan (@dxchan) {
1349                 next if $dxchan == $me;
1350                 next if $dxchan == $self && $self->is_node;
1351                 my $routeit;
1352                 my ($filter, $hops);
1353
1354                 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call}, $ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq)
1355         }
1356 }
1357
1358 sub announce
1359 {
1360         my $self = shift;
1361         my $line = shift;
1362         my $isolate = shift;
1363         my $to = shift;
1364         my $target = shift;
1365         my ($filter, $hops);
1366
1367         if ($self->{annfilter}) {
1368                 ($filter, $hops) = $self->{annfilter}->it(@_);
1369                 return unless $filter;
1370         }
1371         send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
1372 }
1373
1374
1375 sub send_local_config
1376 {
1377         my $self = shift;
1378         my $n;
1379         my @nodes;
1380         my @localnodes;
1381         my @remotenodes;
1382
1383         dbg('DXProt::send_local_config') if isdbg('trace');
1384
1385         # send our nodes
1386         if ($self->{isolate}) {
1387                 @localnodes = ( $main::routeroot );
1388         } else {
1389                 # create a list of all the nodes that are not connected to this connection
1390                 # and are not themselves isolated, this to make sure that isolated nodes
1391         # don't appear outside of this node
1392                 my @dxchan = grep { $_->call ne $main::mycall && $_->call ne $self->{call} } DXChannel::get_all_nodes();
1393                 @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
1394                 my @intcalls = map { $_->nodes } @localnodes if @localnodes;
1395                 my $ref = Route::Node::get($self->{call});
1396                 my @rnodes = $ref->nodes;
1397                 for my $n (@intcalls) {
1398                         push @remotenodes, Route::Node::get($n) unless grep $n eq $_, @rnodes;
1399                 }
1400                 unshift @localnodes, $main::routeroot;
1401         }
1402
1403         send_route($self, \&pc19, scalar(@localnodes)+scalar(@remotenodes), @localnodes, @remotenodes);
1404
1405         # get all the users connected on the above nodes and send them out
1406         foreach $n (@localnodes, @remotenodes) {
1407                 if ($n) {
1408                         send_route($self, \&pc16, 1, $n, map {my $r = Route::User::get($_); $r ? ($r) : ()} $n->users);
1409                 } else {
1410                         dbg("sent a null value") if isdbg('chanerr');
1411                 }
1412         }
1413 }
1414
1415 #
1416 # route a message down an appropriate interface for a callsign
1417 #
1418 # is called route(to, pcline);
1419 #
1420 sub route
1421 {
1422         my ($self, $call, $line) = @_;
1423
1424         if (ref $self && $call eq $self->{call}) {
1425                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1426                 return;
1427         }
1428
1429         # always send it down the local interface if available
1430         my $dxchan = DXChannel->get($call);
1431         unless ($dxchan) {
1432                 my $cl = Route::get($call);
1433                 $dxchan = $cl->dxchan if $cl;
1434                 if (ref $dxchan) {
1435                         if (ref $self && $dxchan eq $self) {
1436                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1437                                 return;
1438                         }
1439                 }
1440         }
1441         if ($dxchan) {
1442                 my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
1443                 if ($routeit) {
1444                         $dxchan->send($routeit) unless $dxchan == $me;
1445                 }
1446         } else {
1447                 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
1448         }
1449 }
1450
1451 # broadcast a message to all clusters taking into account isolation
1452 # [except those mentioned after buffer]
1453 sub broadcast_ak1a
1454 {
1455         my $s = shift;                          # the line to be rebroadcast
1456         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
1457         my @dxchan = DXChannel::get_all_nodes();
1458         my $dxchan;
1459
1460         # send it if it isn't the except list and isn't isolated and still has a hop count
1461         foreach $dxchan (@dxchan) {
1462                 next if grep $dxchan == $_, @except;
1463                 next if $dxchan == $me;
1464
1465                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
1466                 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
1467         }
1468 }
1469
1470 # broadcast a message to all clusters ignoring isolation
1471 # [except those mentioned after buffer]
1472 sub broadcast_all_ak1a
1473 {
1474         my $s = shift;                          # the line to be rebroadcast
1475         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
1476         my @dxchan = DXChannel::get_all_nodes();
1477         my $dxchan;
1478
1479         # send it if it isn't the except list and isn't isolated and still has a hop count
1480         foreach $dxchan (@dxchan) {
1481                 next if grep $dxchan == $_, @except;
1482                 next if $dxchan == $me;
1483
1484                 my $routeit = adjust_hops($dxchan, $s);      # adjust its hop count by node name
1485                 $dxchan->send($routeit);
1486         }
1487 }
1488
1489 # broadcast to all users
1490 # storing the spot or whatever until it is in a state to receive it
1491 sub broadcast_users
1492 {
1493         my $s = shift;                          # the line to be rebroadcast
1494         my $sort = shift;           # the type of transmission
1495         my $fref = shift;           # a reference to an object to filter on
1496         my @except = @_;                        # to all channels EXCEPT these (dxchannel refs)
1497         my @dxchan = DXChannel::get_all_users();
1498         my $dxchan;
1499         my @out;
1500
1501         foreach $dxchan (@dxchan) {
1502                 next if grep $dxchan == $_, @except;
1503                 push @out, $dxchan;
1504         }
1505         broadcast_list($s, $sort, $fref, @out);
1506 }
1507
1508 # broadcast to a list of users
1509 sub broadcast_list
1510 {
1511         my $s = shift;
1512         my $sort = shift;
1513         my $fref = shift;
1514         my $dxchan;
1515
1516         foreach $dxchan (@_) {
1517                 my $filter = 1;
1518                 next if $dxchan == $me;
1519
1520                 if ($sort eq 'dx') {
1521                     next unless $dxchan->{dx};
1522                         ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
1523                         next unless $filter;
1524                 }
1525                 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
1526                 next if $sort eq 'wwv' && !$dxchan->{wwv};
1527                 next if $sort eq 'wcy' && !$dxchan->{wcy};
1528                 next if $sort eq 'wx' && !$dxchan->{wx};
1529
1530                 $s =~ s/\a//og unless $dxchan->{beep};
1531
1532                 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
1533                         $dxchan->send($s);
1534                 } else {
1535                         $dxchan->delay($s);
1536                 }
1537         }
1538 }
1539
1540
1541 #
1542 # obtain the hops from the list for this callsign and pc no
1543 #
1544
1545 sub get_hops
1546 {
1547         my $pcno = shift;
1548         my $hops = $DXProt::hopcount{$pcno};
1549         $hops = $DXProt::def_hopcount if !$hops;
1550         return "H$hops";
1551 }
1552
1553 #
1554 # adjust the hop count on a per node basis using the user loadable
1555 # hop table if available or else decrement an existing one
1556 #
1557
1558 sub adjust_hops
1559 {
1560         my $self = shift;
1561         my $s = shift;
1562         my $call = $self->{call};
1563         my $hops;
1564
1565         if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
1566                 my ($pcno) = $s =~ /^PC(\d\d)/o;
1567                 confess "$call called adjust_hops with '$s'" unless $pcno;
1568                 my $ref = $nodehops{$call} if %nodehops;
1569                 if ($ref) {
1570                         my $newhops = $ref->{$pcno};
1571                         return "" if defined $newhops && $newhops == 0;
1572                         $newhops = $ref->{default} unless $newhops;
1573                         return "" if defined $newhops && $newhops == 0;
1574                         $newhops = $hops if !$newhops;
1575                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
1576                 } else {
1577                         # simply decrement it
1578                         $hops--;
1579                         return "" if !$hops;
1580                         $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1581                 }
1582         }
1583         return $s;
1584 }
1585
1586 #
1587 # load hop tables
1588 #
1589 sub load_hops
1590 {
1591         my $self = shift;
1592         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1593         do "$main::data/hop_table.pl";
1594         return $@ if $@;
1595         return 0;
1596 }
1597
1598
1599 # add a ping request to the ping queues
1600 sub addping
1601 {
1602         my ($from, $to) = @_;
1603         my $ref = $pings{$to} || [];
1604         my $r = {};
1605         $r->{call} = $from;
1606         $r->{t} = [ gettimeofday ];
1607         route(undef, $to, pc51($to, $main::mycall, 1));
1608         push @$ref, $r;
1609         $pings{$to} = $ref;
1610 }
1611
1612 sub process_rcmd
1613 {
1614         my ($self, $tonode, $fromnode, $user, $cmd) = @_;
1615         if ($tonode eq $main::mycall) {
1616                 my $ref = DXUser->get_current($fromnode);
1617                 my $cref = Route::Node::get($fromnode);
1618                 Log('rcmd', 'in', $ref->{priv}, $fromnode, $cmd);
1619                 if ($cmd !~ /^\s*rcmd/i && $cref && $ref && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
1620                         if ($ref->{priv}) {             # you have to have SOME privilege, the commands have further filtering
1621                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
1622                                 my $oldpriv = $self->{priv};
1623                                 $self->{priv} = $ref->{priv}; # assume the user's privilege level
1624                                 my @in = (DXCommandmode::run_cmd($self, $cmd));
1625                                 $self->{priv} = $oldpriv;
1626                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
1627                                 delete $self->{remotecmd};
1628                         } else {
1629                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1630                         }
1631                 } else {
1632                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
1633                 }
1634         } else {
1635                 my $ref = DXUser->get_current($tonode);
1636                 if ($ref && $ref->is_clx) {
1637                         $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
1638                 } else {
1639                         $self->route($tonode, pc34($fromnode, $tonode, $cmd));
1640                 }
1641         }
1642 }
1643
1644 sub process_rcmd_reply
1645 {
1646         my ($self, $tonode, $fromnode, $user, $line) = @_;
1647         if ($tonode eq $main::mycall) {
1648                 my $s = $rcmds{$fromnode};
1649                 if ($s) {
1650                         my $dxchan = DXChannel->get($s->{call});
1651                         my $ref = $user eq $tonode ? $dxchan : (DXChannel->get($user) || $dxchan);
1652                         $ref->send($line) if $ref;
1653                         delete $rcmds{$fromnode} if !$dxchan;
1654                 } else {
1655                         # send unsolicited ones to the sysop
1656                         my $dxchan = DXChannel->get($main::myalias);
1657                         $dxchan->send($line) if $dxchan;
1658                 }
1659         } else {
1660                 my $ref = DXUser->get_current($tonode);
1661                 if ($ref && $ref->is_clx) {
1662                         $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
1663                 } else {
1664                         $self->route($tonode, pc35($fromnode, $tonode, $line));
1665                 }
1666         }
1667 }
1668
1669 sub send_rcmd_reply
1670 {
1671         my $self = shift;
1672         my $tonode = shift;
1673         my $fromnode = shift;
1674         my $user = shift;
1675         while (@_) {
1676                 my $line = shift;
1677                 $line =~ s/\s*$//;
1678                 Log('rcmd', 'out', $fromnode, $line);
1679                 if ($self->is_clx) {
1680                         $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
1681                 } else {
1682                         $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
1683                 }
1684         }
1685 }
1686
1687 # add a rcmd request to the rcmd queues
1688 sub addrcmd
1689 {
1690         my ($self, $to, $cmd) = @_;
1691
1692         my $r = {};
1693         $r->{call} = $self->{call};
1694         $r->{t} = $main::systime;
1695         $r->{cmd} = $cmd;
1696         $rcmds{$to} = $r;
1697
1698         my $ref = Route::Node::get($to);
1699         my $dxchan = $ref->dxchan;
1700         if ($dxchan && $dxchan->is_clx) {
1701                 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1702         } else {
1703                 route(undef, $to, pc34($main::mycall, $to, $cmd));
1704         }
1705 }
1706
1707 sub disconnect
1708 {
1709         my $self = shift;
1710         my $pc39flag = shift;
1711         my $call = $self->call;
1712
1713         unless ($pc39flag && $pc39flag == 1) {
1714                 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1715         }
1716
1717         # do routing stuff
1718         my $node = Route::Node::get($call);
1719         my @rout;
1720         if ($node) {
1721 #               @rout = $node->del_nodes;    # at the next level
1722                 @rout = $node->del($main::routeroot);
1723         }
1724
1725         # unbusy and stop and outgoing mail
1726         my $mref = DXMsg::get_busy($call);
1727         $mref->stop_msg($call) if $mref;
1728
1729         # broadcast to all other nodes that all the nodes connected to via me are gone
1730         unless ($pc39flag && $pc39flag == 2) {
1731                 $self->route_pc21(@rout) if @rout;
1732         }
1733
1734         # remove outstanding pings
1735         delete $pings{$call};
1736
1737         # I was the last node visited
1738     $self->user->node($main::mycall);
1739
1740         # send info to all logged in thingies
1741         $self->tell_login('logoutn');
1742
1743         Log('DXProt', $call . " Disconnected");
1744
1745         $self->SUPER::disconnect;
1746 }
1747
1748
1749 #
1750 # send a talk message to this thingy
1751 #
1752 sub talk
1753 {
1754         my ($self, $from, $to, $via, $line) = @_;
1755
1756         $line =~ s/\^/\\5E/g;                   # remove any ^ characters
1757         $self->send(DXProt::pc10($from, $to, $via, $line));
1758         Log('talk', $self->call, $from, $via?$via:$main::mycall, $line);
1759 }
1760
1761 # send it if it isn't the except list and isn't isolated and still has a hop count
1762 # taking into account filtering and so on
1763 sub send_route
1764 {
1765         my $self = shift;
1766         my $generate = shift;
1767         my $no = shift;     # the no of things to filter on
1768         my $routeit;
1769         my ($filter, $hops);
1770         my @rin;
1771
1772         for (; @_ && $no; $no--) {
1773                 my $r = shift;
1774
1775                 if ($self->{routefilter}) {
1776                         $filter = undef;
1777                         if ($r) {
1778                                 ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1779                                 if ($filter) {
1780                                         push @rin, $r;
1781                                 } else {
1782                                         dbg("DXPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('chanerr');
1783                                 }
1784                         } else {
1785                                 dbg("was sent a null value") if isdbg('chanerr');
1786                         }
1787                 } else {
1788                         push @rin, $r;
1789                 }
1790         }
1791         if (@rin) {
1792                 foreach my $line (&$generate(@rin, @_)) {
1793                         if ($hops) {
1794                                 $routeit = $line;
1795                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1796                         } else {
1797                                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1798                                 next unless $routeit;
1799                         }
1800                         $self->send($routeit);
1801                 }
1802         }
1803 }
1804
1805 sub broadcast_route
1806 {
1807         my $self = shift;
1808         my $generate = shift;
1809         my @dxchan = DXChannel::get_all_nodes();
1810         my $dxchan;
1811         my $line;
1812
1813         foreach $dxchan (@dxchan) {
1814                 next if $dxchan == $self;
1815                 next if $dxchan == $me;
1816                 if ($dxchan->{routefilter}) {
1817                         $dxchan->send_route($generate, @_);
1818                 } else {
1819                         $dxchan->send_route($generate, @_) unless $self->{isolate} || $dxchan->{isolate};
1820                 }
1821         }
1822 }
1823
1824 sub route_pc16
1825 {
1826         my $self = shift;
1827         broadcast_route($self, \&pc16, 1, @_);
1828 }
1829
1830 sub route_pc17
1831 {
1832         my $self = shift;
1833         broadcast_route($self, \&pc17, 1, @_);
1834 }
1835
1836 sub route_pc19
1837 {
1838         my $self = shift;
1839         broadcast_route($self, \&pc19, scalar @_, @_);
1840 }
1841
1842 sub route_pc21
1843 {
1844         my $self = shift;
1845         broadcast_route($self, \&pc21, scalar @_, @_);
1846 }
1847
1848 sub route_pc24
1849 {
1850         my $self = shift;
1851         broadcast_route($self, \&pc24, 1, @_);
1852 }
1853
1854 sub route_pc41
1855 {
1856         my $self = shift;
1857         broadcast_route($self, \&pc41, 1, @_);
1858 }
1859
1860 sub route_pc50
1861 {
1862         my $self = shift;
1863         broadcast_route($self, \&pc50, 1, @_);
1864 }
1865
1866 sub in_filter_route
1867 {
1868         my $self = shift;
1869         my $r = shift;
1870         my ($filter, $hops) = (1, 1);
1871
1872         if ($self->{inroutefilter}) {
1873                 ($filter, $hops) = $self->{inroutefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1874                 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
1875         }
1876         return $filter;
1877 }
1878
1879 sub eph_dup
1880 {
1881         my $s = shift;
1882
1883         # chop the end off
1884         $s =~ s/\^H\d\d?\^?\~?$//;
1885         return 1 if exists $eph{$s};
1886         $eph{$s} = $main::systime;
1887         return undef;
1888 }
1889
1890 sub eph_del_regex
1891 {
1892         my $regex = shift;
1893         my ($key, $val);
1894         while (($key, $val) = each %eph) {
1895                 if ($key =~ m{$regex}) {
1896                         delete $eph{$key};
1897                 }
1898         }
1899 }
1900
1901 sub eph_clean
1902 {
1903         my ($key, $val);
1904
1905         while (($key, $val) = each %eph) {
1906                 if ($main::systime - $val > 90) {
1907                         delete $eph{$key};
1908                 }
1909         }
1910 }
1911
1912 1;
1913 __END__