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