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