perl/DXProt.pm

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