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                         $parent->del_user($uref);
 697                         $self->route_pc17($parent, $uref);
 698                         return;
 699                 }
 700
 701                 if ($pcno == 18) {              # link request
 702                         $self->state('init');
 703
 704                         # first clear out any nodes on this dxchannel
 705                         my $parent = Route::Node::get($self->{call});
 706                         my @rout = $parent->del_nodes;
 707                         $self->route_pc21(@rout, $parent) if @rout;
 708                         $self->send_local_config();
 709                         $self->send(pc20());
 710                         return;             # we don't pass these on
 711                 }
 712
 713                 if ($pcno == 19) {              # incoming cluster list
 714                         my $i;
 715                         my $newline = "PC19^";
 716
 717                         if (eph_dup($line)) {
 718                                 dbg("PCPROT: dup PC19 detected") if isdbg('chanerr');
 719                                 return;
 720                         }
 721
 722                         # new routing list
 723                         my @rout;
 724                         my $parent = Route::Node::get($self->{call});
 725                         unless ($parent) {
 726                                 dbg("DXPROT: my parent $self->{call} has disappeared");
 727                                 $self->disconnect;
 728                                 return;
 729                         }
 730
 731                         # parse the PC19
 732                         for ($i = 1; $i < $#field-1; $i += 4) {
 733                                 my $here = $field[$i];
 734                                 my $call = uc $field[$i+1];
 735                                 my $conf = $field[$i+2];
 736                                 my $ver = $field[$i+3];
 737                                 next unless defined $here && defined $conf && is_callsign($call);
 738
 739                                 eph_del_regex("^PC(?:21\^$call|17\^[^\^]+\^$call)");
 740
 741                                 # check for sane parameters
 742 #                               $ver = 5000 if $ver eq '0000';
 743                                 next if $ver < 5000; # only works with version 5 software
 744                                 next if length $call < 3; # min 3 letter callsigns
 745                                 next if $call eq $main::mycall;
 746
 747                                 # check that this PC19 isn't trying to alter the wrong dxchan
 748                                 my $dxchan = DXChannel->get($call);
 749                                 if ($dxchan && $dxchan != $self) {
 750                                         dbg("PCPROT: PC19 from $self->{call} trying to alter wrong locally connected $call, ignored!") if isdbg('chanerr');
 751                                         return;
 752                                 }
 753
 754                                 # update it if required
 755                                 my $r = Route::Node::get($call);
 756                                 my $flags = Route::here($here)|Route::conf($conf);
 757                                 if ($r) {
 758                                         my $ar;
 759                                         if ($call ne $parent->call) {
 760                                                 if ($self->in_filter_route($r)) {
 761                                                         $ar = $parent->add($call, $ver, $flags);
 762                                                         push @rout, $ar if $ar;
 763                                                 } else {
 764                                                         next;
 765                                                 }
 766                                         }
 767                                         if ($r->version ne $ver || $r->flags != $flags) {
 768                                                 $r->version($ver);
 769                                                 $r->flags($flags);
 770                                                 push @rout, $r unless $ar;
 771                                         }
 772                                 } else {
 773                                         if ($call eq $self->{call}) {
 774                                                 dbg("DXPROT: my channel route for $call has disappeared");
 775                                                 next;
 776                                         };
 777
 778                                         my $new = Route->new($call);          # throw away
 779                                     if ($self->in_filter_route($new)) {
 780                                                 my $r = $parent->add($call, $ver, $flags);
 781                                                 push @rout, $r;
 782                                         } else {
 783                                                 next;
 784                                         }
 785                                 }
 786
 787                                 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
 788                                 my $mref = DXMsg::get_busy($call);
 789                                 $mref->stop_msg($call) if $mref;
 790
 791                                 # add this station to the user database, if required (don't remove SSID from nodes)
 792                                 my $user = DXUser->get_current($call);
 793                                 if (!$user) {
 794                                         $user = DXUser->new($call);
 795                                         $user->sort('A');
 796                                         $user->priv(1);                   # I have relented and defaulted nodes
 797                                         $user->lockout(1);
 798                                         $user->homenode($call);
 799                                         $user->node($call);
 800                                 }
 801                                 $user->lastin($main::systime) unless DXChannel->get($call);
 802                                 $user->put;
 803                         }
 804
 805
 806                         $self->route_pc19(@rout) if @rout;
 807                         return;
 808                 }
 809
 810                 if ($pcno == 20) {              # send local configuration
 811                         $self->send_local_config();
 812                         $self->send(pc22());
 813                         $self->state('normal');
 814                         $self->{lastping} = 0;
 815                         return;
 816                 }
 817
 818                 if ($pcno == 21) {              # delete a cluster from the list
 819                         my $call = uc $field[1];
 820
 821                         if (eph_dup($line)) {
 822                                 dbg("PCPROT: dup PC21 detected") if isdbg('chanerr');
 823                                 return;
 824                         }
 825
 826                         eph_del_regex("^PC1[79].*$call");
 827
 828                         my @rout;
 829                         my $parent = Route::Node::get($self->{call});
 830                         unless ($parent) {
 831                                 dbg("DXPROT: my parent $self->{call} has disappeared");
 832                                 $self->disconnect;
 833                                 return;
 834                         }
 835                         if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
 836                                 if ($call eq $self->{call}) {
 837                                         dbg("PCPROT: Trying to disconnect myself with PC21") if isdbg('chanerr');
 838                                         return;
 839                                 }
 840
 841                                 my $node = Route::Node::get($call);
 842                                 if ($node) {
 843
 844                                         my $dxchan = DXChannel->get($call);
 845                                         if ($dxchan && $dxchan != $self) {
 846                                                 dbg("PCPROT: PC21 from $self->{call} trying to alter locally connected $call, ignored!") if isdbg('chanerr');
 847                                                 return;
 848                                         }
 849
 850                                         # input filter it
 851                                         return unless $self->in_filter_route($node);
 852
 853                                         # routing objects
 854                                         push @rout, $node->del($parent);
 855                                 }
 856                         } else {
 857                                 dbg("PCPROT: I WILL _NOT_ be disconnected!") if isdbg('chanerr');
 858                                 return;
 859                         }
 860
 861                         $self->route_pc21(@rout) if @rout;
 862                         return;
 863                 }
 864
 865                 if ($pcno == 22) {
 866                         $self->state('normal');
 867                         $self->{lastping} = 0;
 868                         return;
 869                 }
 870
 871                 if ($pcno == 23 || $pcno == 27) { # WWV info
 872
 873                         # route 'foreign' pc27s
 874                         if ($pcno == 27) {
 875                                 if ($field[8] ne $main::mycall) {
 876                                         $self->route($field[8], $line);
 877                                         return;
 878                                 }
 879                         }
 880
 881                         return if $rspfcheck and !$self->rspfcheck(1, $field[8], $field[7]);
 882
 883                         # do some de-duping
 884                         my $d = cltounix($field[1], sprintf("%02d18Z", $field[2]));
 885                         my $sfi = unpad($field[3]);
 886                         my $k = unpad($field[4]);
 887                         my $i = unpad($field[5]);
 888                         my ($r) = $field[6] =~ /R=(\d+)/;
 889                         $r = 0 unless $r;
 890                         if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
 891                                 dbg("PCPROT: WWV Date ($field[1] $field[2]) out of range") if isdbg('chanerr');
 892                                 return;
 893                         }
 894                         if (Geomag::dup($d,$sfi,$k,$i,$field[6])) {
 895                                 dbg("PCPROT: Dup WWV Spot ignored\n") if isdbg('chanerr');
 896                                 return;
 897                         }
 898                         $field[7] =~ s/-\d+$//o;            # remove spotter's ssid
 899
 900                         my $wwv = Geomag::update($d, $field[2], $sfi, $k, $i, @field[6..8], $r);
 901
 902                         my $rep;
 903                         eval {
 904                                 $rep = Local::wwv($self, $field[1], $field[2], $sfi, $k, $i, @field[6..8], $r);
 905                         };
 906 #                       dbg("Local::wwv2 error $@") if isdbg('local') if $@;
 907                         return if $rep;
 908
 909                         # DON'T be silly and send on PC27s!
 910                         return if $pcno == 27;
 911
 912                         # broadcast to the eager world
 913                         send_wwv_spot($self, $line, $d, $field[2], $sfi, $k, $i, @field[6..8]);
 914                         return;
 915                 }
 916
 917                 if ($pcno == 24) {              # set here status
 918                         my $call = uc $field[1];
 919                         my ($nref, $uref);
 920                         $nref = Route::Node::get($call);
 921                         $uref = Route::User::get($call);
 922                         return unless $nref || $uref;   # if we don't know where they are, it's pointless sending it on
 923
 924                         unless (eph_dup($line)) {
 925                                 $nref->here($field[2]) if $nref;
 926                                 $uref->here($field[2]) if $uref;
 927                                 my $ref = $nref || $uref;
 928                                 return unless $self->in_filter_route($ref);
 929                                 $self->route_pc24($ref, $field[3]);
 930                         }
 931                         return;
 932                 }
 933
 934                 if ($pcno == 25) {      # merge request
 935                         if ($field[1] ne $main::mycall) {
 936                                 $self->route($field[1], $line);
 937                                 return;
 938                         }
 939                         if ($field[2] eq $main::mycall) {
 940                                 dbg("PCPROT: Trying to merge to myself, ignored") if isdbg('chanerr');
 941                                 return;
 942                         }
 943
 944                         Log('DXProt', "Merge request for $field[3] spots and $field[4] WWV from $field[2]");
 945
 946                         # spots
 947                         if ($field[3] > 0) {
 948                                 my @in = reverse Spot::search(1, undef, undef, 0, $field[3]);
 949                                 my $in;
 950                                 foreach $in (@in) {
 951                                         $self->send(pc26(@{$in}[0..4], $field[2]));
 952                                 }
 953                         }
 954
 955                         # wwv
 956                         if ($field[4] > 0) {
 957                                 my @in = reverse Geomag::search(0, $field[4], time, 1);
 958                                 my $in;
 959                                 foreach $in (@in) {
 960                                         $self->send(pc27(@{$in}[0..5], $field[2]));
 961                                 }
 962                         }
 963                         return;
 964                 }
 965
 966                 if (($pcno >= 28 && $pcno <= 33) || $pcno == 40 || $pcno == 42 || $pcno == 49) { # mail/file handling
 967                         return if $pcno == 49 && eph_dup($line);
 968                         if ($pcno == 49 || $field[1] eq $main::mycall) {
 969                                 DXMsg::process($self, $line);
 970                         } else {
 971                                 $self->route($field[1], $line) unless $self->is_clx;
 972                         }
 973                         return;
 974                 }
 975
 976                 if ($pcno == 34 || $pcno == 36) { # remote commands (incoming)
 977                         $self->process_rcmd($field[1], $field[2], $field[2], $field[3]);
 978                         return;
 979                 }
 980
 981                 if ($pcno == 35) {              # remote command replies
 982                         $self->process_rcmd_reply($field[1], $field[2], $field[1], $field[3]);
 983                         return;
 984                 }
 985
 986                 # for pc 37 see 44 onwards
 987
 988                 if ($pcno == 38) {              # node connected list from neighbour
 989                         return;
 990                 }
 991
 992                 if ($pcno == 39) {              # incoming disconnect
 993                         if ($field[1] eq $self->{call}) {
 994                                 $self->disconnect(1);
 995                                 eph_del_regex("^PC(?:1[679]|21).*$field[1]");
 996                         } else {
 997                                 dbg("PCPROT: came in on wrong channel") if isdbg('chanerr');
 998                         }
 999                         return;
1000                 }
1001
1002                 if ($pcno == 41) {              # user info
1003                         my $call = $field[1];
1004
1005                         # input filter if required
1006 #                       my $ref = Route::get($call) || Route->new($call);
1007 #                       return unless $self->in_filter_route($ref);
1008
1009                         if ($field[3] eq $field[2] || $field[3] =~ /^\s*$/) {
1010                                 dbg('PCPROT: invalid value') if isdbg('chanerr');
1011                                 return;
1012                         }
1013
1014                         # add this station to the user database, if required
1015                         my $user = DXUser->get_current($call);
1016                         $user = DXUser->new($call) if !$user;
1017
1018                         if ($field[2] == 1) {
1019                                 $user->name($field[3]);
1020                         } elsif ($field[2] == 2) {
1021                                 $user->qth($field[3]);
1022                         } elsif ($field[2] == 3) {
1023                                 if (is_latlong($field[3])) {
1024                                         my ($lat, $long) = DXBearing::stoll($field[3]);
1025                                         $user->lat($lat);
1026                                         $user->long($long);
1027                                         $user->qra(DXBearing::lltoqra($lat, $long));
1028                                 } else {
1029                                         dbg('PCPROT: not a valid lat/long') if isdbg('chanerr');
1030                                         return;
1031                                 }
1032                         } elsif ($field[2] == 4) {
1033                                 $user->homenode($field[3]);
1034                         } elsif ($field[2] == 5) {
1035                                 if (is_qra($field[3])) {
1036                                         my ($lat, $long) = DXBearing::qratoll($field[3]);
1037                                         $user->lat($lat);
1038                                         $user->long($long);
1039                                         $user->qra($field[3]);
1040                                 } else {
1041                                         dbg('PCPROT: not a valid QRA locator') if isdbg('chanerr');
1042                                         return;
1043                                 }
1044                         }
1045                         $user->lastoper($main::systime);   # to cut down on excessive for/opers being generated
1046                         $user->put;
1047
1048 #  perhaps this IS what we want after all
1049 #                       $self->route_pc41($ref, $call, $field[2], $field[3], $field[4]);
1050 #                       return;
1051                 }
1052
1053                 if ($pcno == 43) {
1054                         last SWITCH;
1055                 }
1056
1057                 if ($pcno == 37 || $pcno == 44 || $pcno == 45 || $pcno == 46 || $pcno == 47 || $pcno == 48) {
1058                         DXDb::process($self, $line);
1059                         return;
1060                 }
1061
1062                 if ($pcno == 50) {              # keep alive/user list
1063                         my $call = $field[1];
1064                         my $node = Route::Node::get($call);
1065                         if ($node) {
1066                                 return unless $node->call eq $self->{call};
1067                                 $node->usercount($field[2]);
1068
1069                                 # input filter if required
1070                                 return unless $self->in_filter_route($node);
1071
1072                                 $self->route_pc50($node, $field[2], $field[3]) unless eph_dup($line);
1073                         }
1074                         return;
1075                 }
1076
1077                 if ($pcno == 51) {              # incoming ping requests/answers
1078                         my $to = $field[1];
1079                         my $from = $field[2];
1080                         my $flag = $field[3];
1081
1082
1083                         # is it for us?
1084                         if ($to eq $main::mycall) {
1085                                 if ($flag == 1) {
1086                                         $self->send(pc51($from, $to, '0'));
1087                                 } else {
1088                                         # it's a reply, look in the ping list for this one
1089                                         my $ref = $pings{$from};
1090                                         if ($ref) {
1091                                                 my $tochan =  DXChannel->get($from);
1092                                                 while (@$ref) {
1093                                                         my $r = shift @$ref;
1094                                                         my $dxchan = DXChannel->get($r->{call});
1095                                                         next unless $dxchan;
1096                                                         my $t = tv_interval($r->{t}, [ gettimeofday ]);
1097                                                         if ($dxchan->is_user) {
1098                                                                 my $s = sprintf "%.2f", $t;
1099                                                                 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
1100                                                                 $dxchan->send($dxchan->msg('pingi', $from, $s, $ave))
1101                                                         } elsif ($dxchan->is_node) {
1102                                                                 if ($tochan) {
1103                                                                         my $nopings = $tochan->user->nopings || 2;
1104                                                                         push @{$tochan->{pingtime}}, $t;
1105                                                                         shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
1106
1107                                                                         # cope with a missed ping, this means you must set the pingint large enough
1108                                                                         if ($t > $tochan->{pingint}  && $t < 2 * $tochan->{pingint} ) {
1109                                                                                 $t -= $tochan->{pingint};
1110                                                                         }
1111
1112                                                                         # calc smoothed RTT a la TCP
1113                                                                         if (@{$tochan->{pingtime}} == 1) {
1114                                                                                 $tochan->{pingave} = $t;
1115                                                                         } else {
1116                                                                                 $tochan->{pingave} = $tochan->{pingave} + (($t - $tochan->{pingave}) / 6);
1117                                                                         }
1118 #                                                                       my $st;
1119 #                                                                       for (@{$tochan->{pingtime}}) {
1120 #                                                                               $st += $_;
1121 #                                                                       }
1122 #                                                                       $tochan->{pingave} = $st / @{$tochan->{pingtime}};
1123                                                                         $tochan->{nopings} = $nopings; # pump up the timer
1124                                                                 }
1125                                                         }
1126                                                 }
1127                                         }
1128                                 }
1129                         } else {
1130                                 if (eph_dup($line)) {
1131                                         dbg("PCPROT: dup PC51 detected") if isdbg('chanerr');
1132                                         return;
1133                                 }
1134                                 # route down an appropriate thingy
1135                                 $self->route($to, $line);
1136                         }
1137                         return;
1138                 }
1139
1140                 if ($pcno == 75) {              # dunno but route it
1141                         my $call = $field[1];
1142                         if ($call ne $main::mycall) {
1143                                 $self->route($call, $line);
1144                         }
1145                         return;
1146                 }
1147
1148                 if ($pcno == 73) {  # WCY broadcasts
1149                         my $call = $field[1];
1150
1151                         # do some de-duping
1152                         my $d = cltounix($call, sprintf("%02d18Z", $field[2]));
1153                         if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $field[2] < 0 || $field[2] > 23) {
1154                                 dbg("PCPROT: WCY Date ($call $field[2]) out of range") if isdbg('chanerr');
1155                                 return;
1156                         }
1157                         @field = map { unpad($_) } @field;
1158                         if (WCY::dup($d)) {
1159                                 dbg("PCPROT: Dup WCY Spot ignored\n") if isdbg('chanerr');
1160                                 return;
1161                         }
1162
1163                         my $wcy = WCY::update($d, @field[2..12]);
1164
1165                         my $rep;
1166                         eval {
1167                                 $rep = Local::wcy($self, @field[1..12]);
1168                         };
1169                         # dbg("Local::wcy error $@") if isdbg('local') if $@;
1170                         return if $rep;
1171
1172                         # broadcast to the eager world
1173                         send_wcy_spot($self, $line, $d, @field[2..12]);
1174                         return;
1175                 }
1176
1177                 if ($pcno == 84) { # remote commands (incoming)
1178                         $self->process_rcmd($field[1], $field[2], $field[3], $field[4]);
1179                         return;
1180                 }
1181
1182                 if ($pcno == 85) {              # remote command replies
1183                         $self->process_rcmd_reply($field[1], $field[2], $field[3], $field[4]);
1184
1185                         return;
1186                 }
1187         }
1188
1189         # if get here then rebroadcast the thing with its Hop count decremented (if
1190         # there is one). If it has a hop count and it decrements to zero then don't
1191         # rebroadcast it.
1192         #
1193         # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
1194         #        REBROADCAST!!!!
1195         #
1196
1197         if (eph_dup($line)) {
1198                 dbg("PCPROT: Ephemeral dup, dropped") if isdbg('chanerr');
1199         } else {
1200                 unless ($self->{isolate}) {
1201                         DXChannel::broadcast_nodes($line, $self); # send it to everyone but me
1202                 }
1203         }
1204 }
1205
1206 #
1207 # This is called from inside the main cluster processing loop and is used
1208 # for despatching commands that are doing some long processing job
1209 #
1210 sub process
1211 {
1212         my $t = time;
1213         my @dxchan = DXChannel->get_all();
1214         my $dxchan;
1215         my $pc50s;
1216
1217         # send out a pc50 on EVERY channel all at once
1218         if ($t >= $last_pc50 + $DXProt::pc50_interval) {
1219                 $pc50s = pc50($main::me, scalar DXChannel::get_all_users);
1220                 eph_dup($pc50s);
1221                 $last_pc50 = $t;
1222         }
1223
1224         foreach $dxchan (@dxchan) {
1225                 next unless $dxchan->is_node();
1226                 next if $dxchan == $main::me;
1227
1228                 # send the pc50
1229                 $dxchan->send($pc50s) if $pc50s;
1230
1231                 # send a ping out on this channel
1232                 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
1233                         if ($dxchan->{nopings} <= 0) {
1234                                 $dxchan->disconnect;
1235                         } else {
1236                                 addping($main::mycall, $dxchan->call);
1237                                 $dxchan->{nopings} -= 1;
1238                                 $dxchan->{lastping} = $t;
1239                         }
1240                 }
1241         }
1242
1243         # every ten seconds
1244         if ($t - $last10 >= 10) {
1245                 # clean out ephemera
1246
1247                 eph_clean();
1248
1249                 $last10 = $t;
1250         }
1251
1252         if ($main::systime - 3600 > $last_hour) {
1253                 $last_hour = $main::systime;
1254         }
1255 }
1256
1257 #
1258 # finish up a pc context
1259 #
1260
1261 #
1262 # some active measures
1263 #
1264
1265 sub send_dx_spot
1266 {
1267         my $self = shift;
1268         my $line = shift;
1269         my @dxchan = DXChannel->get_all();
1270         my $dxchan;
1271
1272         # send it if it isn't the except list and isn't isolated and still has a hop count
1273         # taking into account filtering and so on
1274         foreach $dxchan (@dxchan) {
1275                 next if $dxchan == $main::me;
1276                 next if $dxchan == $self && $self->is_node;
1277                 $dxchan->dx_spot($line, $self->{isolate}, @_, $self->{call});
1278         }
1279 }
1280
1281 sub dx_spot
1282 {
1283         my $self = shift;
1284         my $line = shift;
1285         my $isolate = shift;
1286         my ($filter, $hops);
1287
1288         if ($self->{spotsfilter}) {
1289                 ($filter, $hops) = $self->{spotsfilter}->it(@_);
1290                 return unless $filter;
1291         }
1292         send_prot_line($self, $filter, $hops, $isolate, $line);
1293 }
1294
1295 sub send_prot_line
1296 {
1297         my ($self, $filter, $hops, $isolate, $line) = @_;
1298         my $routeit;
1299
1300         if ($hops) {
1301                 $routeit = $line;
1302                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1303         } else {
1304                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1305                 return unless $routeit;
1306         }
1307         if ($filter) {
1308                 $self->send($routeit);
1309         } else {
1310                 $self->send($routeit) unless $self->{isolate} || $isolate;
1311         }
1312 }
1313
1314
1315 sub send_wwv_spot
1316 {
1317         my $self = shift;
1318         my $line = shift;
1319         my @dxchan = DXChannel->get_all();
1320         my $dxchan;
1321         my ($wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1322         my @dxcc = Prefix::extract($_[6]);
1323         if (@dxcc > 0) {
1324                 $wwv_dxcc = $dxcc[1]->dxcc;
1325                 $wwv_itu = $dxcc[1]->itu;
1326                 $wwv_cq = $dxcc[1]->cq;
1327         }
1328         @dxcc = Prefix::extract($_[7]);
1329         if (@dxcc > 0) {
1330                 $org_dxcc = $dxcc[1]->dxcc;
1331                 $org_itu = $dxcc[1]->itu;
1332                 $org_cq = $dxcc[1]->cq;
1333         }
1334
1335         # send it if it isn't the except list and isn't isolated and still has a hop count
1336         # taking into account filtering and so on
1337         foreach $dxchan (@dxchan) {
1338                 next if $dxchan == $main::me;
1339                 next if $dxchan == $self && $self->is_node;
1340                 my $routeit;
1341                 my ($filter, $hops);
1342
1343                 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, $wwv_dxcc, $wwv_itu, $wwv_cq, $org_dxcc, $org_itu, $org_cq);
1344         }
1345
1346 }
1347
1348 sub wwv
1349 {
1350         my $self = shift;
1351         my $line = shift;
1352         my $isolate = shift;
1353         my ($filter, $hops);
1354
1355         if ($self->{wwvfilter}) {
1356                 ($filter, $hops) = $self->{wwvfilter}->it(@_);
1357                 return unless $filter;
1358         }
1359         send_prot_line($self, $filter, $hops, $isolate, $line)
1360 }
1361
1362 sub send_wcy_spot
1363 {
1364         my $self = shift;
1365         my $line = shift;
1366         my @dxchan = DXChannel->get_all();
1367         my $dxchan;
1368         my ($wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1369         my @dxcc = Prefix::extract($_[10]);
1370         if (@dxcc > 0) {
1371                 $wcy_dxcc = $dxcc[1]->dxcc;
1372                 $wcy_itu = $dxcc[1]->itu;
1373                 $wcy_cq = $dxcc[1]->cq;
1374         }
1375         @dxcc = Prefix::extract($_[11]);
1376         if (@dxcc > 0) {
1377                 $org_dxcc = $dxcc[1]->dxcc;
1378                 $org_itu = $dxcc[1]->itu;
1379                 $org_cq = $dxcc[1]->cq;
1380         }
1381
1382         # send it if it isn't the except list and isn't isolated and still has a hop count
1383         # taking into account filtering and so on
1384         foreach $dxchan (@dxchan) {
1385                 next if $dxchan == $main::me;
1386                 next if $dxchan == $self;
1387
1388                 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, $wcy_dxcc, $wcy_itu, $wcy_cq, $org_dxcc, $org_itu, $org_cq);
1389         }
1390 }
1391
1392 sub wcy
1393 {
1394         my $self = shift;
1395         my $line = shift;
1396         my $isolate = shift;
1397         my ($filter, $hops);
1398
1399         if ($self->{wcyfilter}) {
1400                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
1401                 return unless $filter;
1402         }
1403         send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
1404 }
1405
1406 # send an announce
1407 sub send_announce
1408 {
1409         my $self = shift;
1410         my $line = shift;
1411         my @dxchan = DXChannel->get_all();
1412         my $dxchan;
1413         my $target;
1414         my $to = 'To ';
1415         my $text = unpad($_[2]);
1416
1417         if ($_[3] eq '*') {     # sysops
1418                 $target = "SYSOP";
1419         } elsif ($_[3] gt ' ') { # speciality list handling
1420                 my ($name) = split /\./, $_[3];
1421                 $target = "$name"; # put the rest in later (if bothered)
1422         }
1423
1424         if ($_[5] eq '1') {
1425                 $target = "WX";
1426                 $to = '';
1427         }
1428         $target = "ALL" if !$target;
1429
1430
1431         # obtain country codes etc
1432         my ($ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq) = (0..0);
1433         my @dxcc = Prefix::extract($_[0]);
1434         if (@dxcc > 0) {
1435                 $ann_dxcc = $dxcc[1]->dxcc;
1436                 $ann_itu = $dxcc[1]->itu;
1437                 $ann_cq = $dxcc[1]->cq;
1438         }
1439         @dxcc = Prefix::extract($_[4]);
1440         if (@dxcc > 0) {
1441                 $org_dxcc = $dxcc[1]->dxcc;
1442                 $org_itu = $dxcc[1]->itu;
1443                 $org_cq = $dxcc[1]->cq;
1444         }
1445
1446         if ($self->{inannfilter}) {
1447                 my ($filter, $hops) =
1448                         $self->{inannfilter}->it(@_, $self->{call},
1449                                                                          $ann_dxcc, $ann_itu, $ann_cq,
1450                                                                          $org_dxcc, $org_itu, $org_cq);
1451                 unless ($filter) {
1452                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
1453                         return;
1454                 }
1455         }
1456
1457         if (AnnTalk::dup($_[0], $_[1], $_[2])) {
1458                 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
1459                 return;
1460         }
1461
1462         Log('ann', $target, $_[0], $text);
1463
1464         # send it if it isn't the except list and isn't isolated and still has a hop count
1465         # taking into account filtering and so on
1466         foreach $dxchan (@dxchan) {
1467                 next if $dxchan == $main::me;
1468                 next if $dxchan == $self && $self->is_node;
1469                 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call}, $ann_dxcc, $ann_itu, $ann_cq, $org_dxcc, $org_itu, $org_cq);
1470         }
1471 }
1472
1473 sub announce
1474 {
1475         my $self = shift;
1476         my $line = shift;
1477         my $isolate = shift;
1478         my $to = shift;
1479         my $target = shift;
1480         my $text = shift;
1481         my ($filter, $hops);
1482
1483         if ($self->{annfilter}) {
1484                 ($filter, $hops) = $self->{annfilter}->it(@_);
1485                 return unless $filter;
1486         }
1487         send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
1488 }
1489
1490
1491 sub send_local_config
1492 {
1493         my $self = shift;
1494         my $n;
1495         my @nodes;
1496         my @localnodes;
1497         my @remotenodes;
1498
1499         dbg('DXProt::send_local_config') if isdbg('trace');
1500
1501         # send our nodes
1502         if ($self->{isolate}) {
1503                 @localnodes = ( $main::routeroot );
1504         } else {
1505                 # create a list of all the nodes that are not connected to this connection
1506                 # and are not themselves isolated, this to make sure that isolated nodes
1507         # don't appear outside of this node
1508                 my @dxchan = grep { $_->call ne $main::mycall && $_ != $self && !$_->{isolate} } DXChannel::get_all_nodes();
1509                 @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
1510                 my @intcalls = map { $_->nodes } @localnodes if @localnodes;
1511                 my $ref = Route::Node::get($self->{call});
1512                 my @rnodes = $ref->nodes;
1513                 for my $n (@intcalls) {
1514                         push @remotenodes, Route::Node::get($n) unless grep $n eq $_, @rnodes;
1515                 }
1516                 unshift @localnodes, $main::routeroot;
1517         }
1518
1519         send_route($self, \&pc19, scalar(@localnodes)+scalar(@remotenodes), @localnodes, @remotenodes);
1520
1521         # get all the users connected on the above nodes and send them out
1522         foreach $n (@localnodes, @remotenodes) {
1523                 if ($n) {
1524                         send_route($self, \&pc16, 1, $n, map {my $r = Route::User::get($_); $r ? ($r) : ()} $n->users);
1525                 } else {
1526                         dbg("sent a null value") if isdbg('chanerr');
1527                 }
1528         }
1529 }
1530
1531 #
1532 # route a message down an appropriate interface for a callsign
1533 #
1534 # is called route(to, pcline);
1535 #
1536 sub route
1537 {
1538         my ($self, $call, $line) = @_;
1539
1540         if (ref $self && $call eq $self->{call}) {
1541                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1542                 return;
1543         }
1544
1545         # always send it down the local interface if available
1546         my $dxchan = DXChannel->get($call);
1547         unless ($dxchan) {
1548                 my $cl = Route::get($call);
1549                 $dxchan = $cl->dxchan if $cl;
1550                 if (ref $dxchan) {
1551                         if (ref $self && $dxchan eq $self) {
1552                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1553                                 return;
1554                         }
1555                 }
1556         }
1557         if ($dxchan) {
1558                 my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
1559                 if ($routeit) {
1560                         $dxchan->send($routeit) unless $dxchan == $main::me;
1561                 }
1562         } else {
1563                 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
1564         }
1565 }
1566
1567 #
1568 # obtain the hops from the list for this callsign and pc no
1569 #
1570
1571 sub get_hops
1572 {
1573         my $pcno = shift;
1574         my $hops = $DXProt::hopcount{$pcno};
1575         $hops = $DXProt::def_hopcount if !$hops;
1576         return "H$hops";
1577 }
1578
1579 #
1580 # adjust the hop count on a per node basis using the user loadable
1581 # hop table if available or else decrement an existing one
1582 #
1583
1584 sub adjust_hops
1585 {
1586         my $self = shift;
1587         my $s = shift;
1588         my $call = $self->{call};
1589         my $hops;
1590
1591         if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
1592                 my ($pcno) = $s =~ /^PC(\d\d)/o;
1593                 confess "$call called adjust_hops with '$s'" unless $pcno;
1594                 my $ref = $nodehops{$call} if %nodehops;
1595                 if ($ref) {
1596                         my $newhops = $ref->{$pcno};
1597                         return "" if defined $newhops && $newhops == 0;
1598                         $newhops = $ref->{default} unless $newhops;
1599                         return "" if defined $newhops && $newhops == 0;
1600                         $newhops = $hops if !$newhops;
1601                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
1602                 } else {
1603                         # simply decrement it
1604                         $hops--;
1605                         return "" if !$hops;
1606                         $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
1607                 }
1608         }
1609         return $s;
1610 }
1611
1612 #
1613 # load hop tables
1614 #
1615 sub load_hops
1616 {
1617         my $self = shift;
1618         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1619         do "$main::data/hop_table.pl";
1620         return $@ if $@;
1621         return 0;
1622 }
1623
1624
1625 # add a ping request to the ping queues
1626 sub addping
1627 {
1628         my ($from, $to) = @_;
1629         my $ref = $pings{$to} || [];
1630         my $r = {};
1631         $r->{call} = $from;
1632         $r->{t} = [ gettimeofday ];
1633         route(undef, $to, pc51($to, $main::mycall, 1));
1634         push @$ref, $r;
1635         $pings{$to} = $ref;
1636 }
1637
1638 sub process_rcmd
1639 {
1640         my ($self, $tonode, $fromnode, $user, $cmd) = @_;
1641         if ($tonode eq $main::mycall) {
1642                 my $ref = DXUser->get_current($fromnode);
1643                 my $cref = Route::Node::get($fromnode);
1644                 Log('rcmd', 'in', $ref->{priv}, $fromnode, $cmd);
1645                 if ($cmd !~ /^\s*rcmd/i && $cref && $ref && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
1646                         if ($ref->{priv}) {             # you have to have SOME privilege, the commands have further filtering
1647                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
1648                                 my $oldpriv = $self->{priv};
1649                                 $self->{priv} = $ref->{priv}; # assume the user's privilege level
1650                                 my @in = (DXCommandmode::run_cmd($self, $cmd));
1651                                 $self->{priv} = $oldpriv;
1652                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
1653                                 delete $self->{remotecmd};
1654                         } else {
1655                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1656                         }
1657                 } else {
1658                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
1659                 }
1660         } else {
1661                 my $ref = DXUser->get_current($tonode);
1662                 if ($ref && $ref->is_clx) {
1663                         $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
1664                 } else {
1665                         $self->route($tonode, pc34($fromnode, $tonode, $cmd));
1666                 }
1667         }
1668 }
1669
1670 sub process_rcmd_reply
1671 {
1672         my ($self, $tonode, $fromnode, $user, $line) = @_;
1673         if ($tonode eq $main::mycall) {
1674                 my $s = $rcmds{$fromnode};
1675                 if ($s) {
1676                         my $dxchan = DXChannel->get($s->{call});
1677                         my $ref = $user eq $tonode ? $dxchan : (DXChannel->get($user) || $dxchan);
1678                         $ref->send($line) if $ref;
1679                         delete $rcmds{$fromnode} if !$dxchan;
1680                 } else {
1681                         # send unsolicited ones to the sysop
1682                         my $dxchan = DXChannel->get($main::myalias);
1683                         $dxchan->send($line) if $dxchan;
1684                 }
1685         } else {
1686                 my $ref = DXUser->get_current($tonode);
1687                 if ($ref && $ref->is_clx) {
1688                         $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
1689                 } else {
1690                         $self->route($tonode, pc35($fromnode, $tonode, $line));
1691                 }
1692         }
1693 }
1694
1695 sub send_rcmd_reply
1696 {
1697         my $self = shift;
1698         my $tonode = shift;
1699         my $fromnode = shift;
1700         my $user = shift;
1701         while (@_) {
1702                 my $line = shift;
1703                 $line =~ s/\s*$//;
1704                 Log('rcmd', 'out', $fromnode, $line);
1705                 if ($self->is_clx) {
1706                         $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
1707                 } else {
1708                         $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
1709                 }
1710         }
1711 }
1712
1713 # add a rcmd request to the rcmd queues
1714 sub addrcmd
1715 {
1716         my ($self, $to, $cmd) = @_;
1717
1718         my $r = {};
1719         $r->{call} = $self->{call};
1720         $r->{t} = $main::systime;
1721         $r->{cmd} = $cmd;
1722         $rcmds{$to} = $r;
1723
1724         my $ref = Route::Node::get($to);
1725         my $dxchan = $ref->dxchan;
1726         if ($dxchan && $dxchan->is_clx) {
1727                 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1728         } else {
1729                 route(undef, $to, pc34($main::mycall, $to, $cmd));
1730         }
1731 }
1732
1733 sub disconnect
1734 {
1735         my $self = shift;
1736         my $pc39flag = shift;
1737         my $call = $self->call;
1738
1739         return if $self->{disconnecting}++;
1740
1741         unless ($pc39flag && $pc39flag == 1) {
1742                 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1743         }
1744
1745         # do routing stuff
1746         my $node = Route::Node::get($call);
1747         my @rout;
1748         if ($node) {
1749                 @rout = $node->del($main::routeroot);
1750         }
1751
1752         # unbusy and stop and outgoing mail
1753         my $mref = DXMsg::get_busy($call);
1754         $mref->stop_msg($call) if $mref;
1755
1756         # broadcast to all other nodes that all the nodes connected to via me are gone
1757         unless ($pc39flag && $pc39flag == 2) {
1758                 $self->route_pc21(@rout) if @rout;
1759         }
1760
1761         # remove outstanding pings
1762         delete $pings{$call};
1763
1764         # I was the last node visited
1765     $self->user->node($main::mycall);
1766
1767         # send info to all logged in thingies
1768         $self->tell_login('logoutn');
1769
1770         Log('DXProt', $call . " Disconnected");
1771
1772         $self->SUPER::disconnect;
1773 }
1774
1775
1776 #
1777 # send a talk message to this thingy
1778 #
1779 sub talk
1780 {
1781         my ($self, $from, $to, $via, $line, $origin) = @_;
1782
1783         $line =~ s/\^/\\5E/g;                   # remove any ^ characters
1784         $self->send(DXProt::pc10($from, $to, $via, $line, $origin));
1785         Log('talk', $to, $from, $via?$via:$self->call, $line) unless $origin && $origin ne $main::mycall;
1786 }
1787
1788 # send it if it isn't the except list and isn't isolated and still has a hop count
1789 # taking into account filtering and so on
1790 sub send_route
1791 {
1792         my $self = shift;
1793         my $generate = shift;
1794         my $no = shift;     # the no of things to filter on
1795         my $routeit;
1796         my ($filter, $hops);
1797         my @rin;
1798
1799         for (; @_ && $no; $no--) {
1800                 my $r = shift;
1801
1802                 if (!$self->{isolate} && $self->{routefilter}) {
1803                         $filter = undef;
1804                         if ($r) {
1805                                 ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1806                                 if ($filter) {
1807                                         push @rin, $r;
1808                                 } else {
1809                                         dbg("DXPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('chanerr');
1810                                 }
1811                         } else {
1812                                 dbg("was sent a null value") if isdbg('chanerr');
1813                         }
1814                 } else {
1815                         push @rin, $r unless $self->{isolate} && $r->call ne $main::mycall;
1816                 }
1817         }
1818         if (@rin) {
1819                 foreach my $line (&$generate(@rin, @_)) {
1820                         if ($hops) {
1821                                 $routeit = $line;
1822                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1823                         } else {
1824                                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1825                                 next unless $routeit;
1826                         }
1827                         $self->send($routeit);
1828                 }
1829         }
1830 }
1831
1832 sub broadcast_route
1833 {
1834         my $self = shift;
1835         my $generate = shift;
1836         my @dxchan = DXChannel::get_all_nodes();
1837         my $dxchan;
1838         my $line;
1839
1840         unless ($self->{isolate}) {
1841                 foreach $dxchan (@dxchan) {
1842                         next if $dxchan == $self;
1843                         next if $dxchan == $main::me;
1844                         $dxchan->send_route($generate, @_);
1845                 }
1846         }
1847 }
1848
1849 sub route_pc16
1850 {
1851         my $self = shift;
1852         broadcast_route($self, \&pc16, 1, @_);
1853 }
1854
1855 sub route_pc17
1856 {
1857         my $self = shift;
1858         broadcast_route($self, \&pc17, 1, @_);
1859 }
1860
1861 sub route_pc19
1862 {
1863         my $self = shift;
1864         broadcast_route($self, \&pc19, scalar @_, @_);
1865 }
1866
1867 sub route_pc21
1868 {
1869         my $self = shift;
1870         broadcast_route($self, \&pc21, scalar @_, @_);
1871 }
1872
1873 sub route_pc24
1874 {
1875         my $self = shift;
1876         broadcast_route($self, \&pc24, 1, @_);
1877 }
1878
1879 sub route_pc41
1880 {
1881         my $self = shift;
1882         broadcast_route($self, \&pc41, 1, @_);
1883 }
1884
1885 sub route_pc50
1886 {
1887         my $self = shift;
1888         broadcast_route($self, \&pc50, 1, @_);
1889 }
1890
1891 sub in_filter_route
1892 {
1893         my $self = shift;
1894         my $r = shift;
1895         my ($filter, $hops) = (1, 1);
1896
1897         if ($self->{inroutefilter}) {
1898                 ($filter, $hops) = $self->{inroutefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq);
1899                 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
1900         }
1901         return $filter;
1902 }
1903
1904 sub eph_dup
1905 {
1906         my $s = shift;
1907         my $r;
1908
1909         # chop the end off
1910         $s =~ s/\^H\d\d?\^?\~?$//;
1911         $r = 1 if exists $eph{$s};    # pump up the dup if it keeps circulating
1912         $eph{$s} = $main::systime;
1913         return $r;
1914 }
1915
1916 sub eph_del_regex
1917 {
1918         my $regex = shift;
1919         my ($key, $val);
1920         while (($key, $val) = each %eph) {
1921                 if ($key =~ m{$regex}) {
1922                         delete $eph{$key};
1923                 }
1924         }
1925 }
1926
1927 sub eph_clean
1928 {
1929         my ($key, $val);
1930
1931         while (($key, $val) = each %eph) {
1932                 if ($main::systime - $val > 180) {
1933                         delete $eph{$key};
1934                 }
1935         }
1936 }
1937
1938 1;
1939 __END__