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 use Investigate;
  37 use RouteDB;
  38 use Thingy;
  39 use Thingy::Dx;
  40 use Thingy::Rt;
  41 use Thingy::Ping;
  42 use Thingy::T;
  43 use Thingy::Hello;
  44 use Thingy::Bye;
  45
  46 use strict;
  47
  48 use vars qw($VERSION $BRANCH);
  49
  50 main::mkver($VERSION = q$Revision$);
  51
  52 use vars qw($pc11_max_age $pc23_max_age $last_pc50 $eph_restime $eph_info_restime $eph_pc34_restime
  53                         $last_hour $last10 %eph  %pings %rcmds $ann_to_talk
  54                         $pingint $obscount %pc19list $chatdupeage $chatimportfn
  55                         $investigation_int $pc19_version $myprot_version
  56                         %nodehops $baddx $badspotter $badnode $censorpc $rspfcheck
  57                         $allowzero $decode_dk0wcy $send_opernam @checklist);
  58
  59 $pc11_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc11
  60 $pc23_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc23
  61
  62 $last_hour = time;                              # last time I did an hourly periodic update
  63 %pings = ();                    # outstanding ping requests outbound
  64 %rcmds = ();                    # outstanding rcmd requests outbound
  65 %nodehops = ();                 # node specific hop control
  66 %pc19list = ();                                 # list of outstanding PC19s that haven't had PC16s on them
  67
  68 $censorpc = 1;                                  # Do a BadWords::check on text fields and reject things
  69                                                                 # loads of 'bad things'
  70 $baddx = new DXHash "baddx";
  71 $badspotter = new DXHash "badspotter";
  72 $badnode = new DXHash "badnode";
  73 $last10 = $last_pc50 = time;
  74 $ann_to_talk = 1;
  75 $rspfcheck = 1;
  76 $eph_restime = 180;
  77 $eph_info_restime = 60*60;
  78 $eph_pc34_restime = 30;
  79 $pingint = 5*60;
  80 $obscount = 2;
  81 $chatdupeage = 20 * 60 * 60;
  82 $chatimportfn = "$main::root/chat_import";
  83 $investigation_int = 12*60*60;  # time between checks to see if we can see this node
  84 $pc19_version = 5466;                   # the visible version no for outgoing PC19s generated from pc59
  85
  86 @checklist =
  87 (
  88  [ qw(i c c m bp bc c) ],                       # pc10
  89  [ qw(i f m d t m c c h) ],             # pc11
  90  [ qw(i c bm m bm bm p h) ],            # pc12
  91  [ qw(i c h) ],                                 #
  92  [ qw(i c h) ],                                 #
  93  [ qw(i c m h) ],                                       #
  94  undef ,                                                # pc16 has to be validated manually
  95  [ qw(i c c h) ],                                       # pc17
  96  [ qw(i m n) ],                                 # pc18
  97  undef ,                                                # pc19 has to be validated manually
  98  undef ,                                                # pc20 no validation
  99  [ qw(i c m h) ],                                       # pc21
 100  undef ,                                                # pc22 no validation
 101  [ qw(i d n n n n m c c h) ],           # pc23
 102  [ qw(i c p h) ],                                       # pc24
 103  [ qw(i c c n n) ],                             # pc25
 104  [ qw(i f m d t m c c bc) ],            # pc26
 105  [ qw(i d n n n n m c c bc) ],  # pc27
 106  [ qw(i c c m c d t p m bp n p bp bc) ], # pc28
 107  [ qw(i c c n m) ],                             # pc29
 108  [ qw(i c c n) ],                                       # pc30
 109  [ qw(i c c n) ],                                       # pc31
 110  [ qw(i c c n) ],                                       # pc32
 111  [ qw(i c c n) ],                                       # pc33
 112  [ qw(i c c m) ],                                       # pc34
 113  [ qw(i c c m) ],                                       # pc35
 114  [ qw(i c c m) ],                                       # pc36
 115  [ qw(i c c n m) ],                             # pc37
 116  undef,                                                 # pc38 not interested
 117  [ qw(i c m) ],                                 # pc39
 118  [ qw(i c c m p n) ],                           # pc40
 119  [ qw(i c n m h) ],                             # pc41
 120  [ qw(i c c n) ],                                       # pc42
 121  undef,                                                 # pc43 don't handle it
 122  [ qw(i c c n m m c) ],                 # pc44
 123  [ qw(i c c n m) ],                             # pc45
 124  [ qw(i c c n) ],                                       # pc46
 125  undef,                                                 # pc47
 126  undef,                                                 # pc48
 127  [ qw(i c m h) ],                                       # pc49
 128  [ qw(i c n h) ],                                       # pc50
 129  [ qw(i c c n) ],                                       # pc51
 130  undef,
 131  undef,
 132  undef,
 133  undef,
 134  undef,
 135  undef,
 136  undef,
 137  undef,
 138  undef,                                                 # pc60
 139  undef,
 140  undef,
 141  undef,
 142  undef,
 143  undef,
 144  undef,
 145  undef,
 146  undef,
 147  undef,
 148  undef,                                                 # pc70
 149  undef,
 150  undef,
 151  [ qw(i d n n n n n n m m m c c h) ],   # pc73
 152  undef,
 153  undef,
 154  undef,
 155  undef,
 156  undef,
 157  undef,
 158  undef,                                                 # pc80
 159  undef,
 160  undef,
 161  undef,
 162  [ qw(i c c c m) ],                             # pc84
 163  [ qw(i c c c m) ],                             # pc85
 164  undef,
 165  undef,
 166  undef,
 167  undef,
 168  [ qw(i c n) ],                                 # pc90
 169 );
 170
 171 # use the entry in the check list to check the field list presented
 172 # return OK if line NOT in check list (for now)
 173 sub check
 174 {
 175         my $n = shift;
 176         $n -= 10;
 177         return 0 if $n < 0 || $n > @checklist;
 178         my $ref = $checklist[$n];
 179         return 0 unless ref $ref;
 180
 181         my $i;
 182         for ($i = 1; $i < @$ref; $i++) {
 183                 my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
 184                 return 0 unless $act;
 185                 next if $blank && $_[$i] =~ /^[ \*]$/;
 186                 if ($act eq 'c') {
 187                         return $i unless is_callsign($_[$i]);
 188                 } elsif ($act eq 'i') {
 189                         ;                                       # do nothing
 190                 } elsif ($act eq 'm') {
 191                         return $i unless is_pctext($_[$i]);
 192                 } elsif ($act eq 'p') {
 193                         return $i unless is_pcflag($_[$i]);
 194                 } elsif ($act eq 'f') {
 195                         return $i unless is_freq($_[$i]);
 196                 } elsif ($act eq 'n') {
 197                         return $i unless $_[$i] =~ /^[\d ]+$/;
 198                 } elsif ($act eq 'h') {
 199                         return $i unless $_[$i] =~ /^H\d\d?$/;
 200                 } elsif ($act eq 'd') {
 201                         return $i unless $_[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
 202                 } elsif ($act eq 't') {
 203                         return $i unless $_[$i] =~ /^[012]\d[012345]\dZ$/;
 204                 }
 205         }
 206         return 0;
 207 }
 208
 209 sub init
 210 {
 211         do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
 212         confess $@ if $@;
 213
 214         my $user = DXUser->get($main::mycall);
 215         die "User $main::mycall not setup or disappeared RTFM" unless $user;
 216
 217         $myprot_version += $main::version*100;
 218         $main::me = DXProt->new($main::mycall, 0, $user);
 219         $main::me->{here} = 1;
 220         $main::me->{state} = "indifferent";
 221         $main::me->{sort} = 'S';    # S for spider
 222         $main::me->{priv} = 9;
 223         $main::me->{metric} = 0;
 224         $main::me->{pingave} = 0;
 225         $main::me->{registered} = 1;
 226         $main::me->{version} = 5251 + $main::version;
 227         $main::me->{build} = $main::build;
 228 }
 229
 230 #
 231 # obtain a new connection this is derived from dxchannel
 232 #
 233
 234 sub new
 235 {
 236         my $self = DXChannel::alloc(@_);
 237
 238         # add this node to the table, the values get filled in later
 239         my $pkg = shift;
 240         my $call = shift;
 241         $main::routeroot->add($call, '5000', Route::here(1)) if $call ne $main::mycall;
 242         if ($self->{call} ne $main::mycall) {
 243                 my $thing = Thingy::Hello->new(user=>$call);
 244                 $thing->broadcast($self);
 245         }
 246
 247         return $self;
 248 }
 249
 250 # this is how a pc connection starts (for an incoming connection)
 251 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
 252 # all the crap that comes between).
 253 sub start
 254 {
 255         my ($self, $line, $sort) = @_;
 256         my $call = $self->{call};
 257         my $user = $self->{user};
 258
 259         # log it
 260         my $host = $self->{conn}->{peerhost} || "unknown";
 261         Log('DXProt', "$call connected from $host");
 262
 263         # remember type of connection
 264         $self->{consort} = $line;
 265         $self->{outbound} = $sort eq 'O';
 266         my $priv = $user->priv;
 267         $priv = $user->priv(1) unless $priv;
 268         $self->{priv} = $priv;     # other clusters can always be 'normal' users
 269         $self->{lang} = $user->lang || 'en';
 270         $self->{isolate} = $user->{isolate};
 271         $self->{consort} = $line;       # save the connection type
 272         $self->{here} = 1;
 273         $self->{width} = 80;
 274
 275         # sort out registration
 276         $self->{registered} = 1;
 277
 278         # get the output filters
 279         $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
 280         $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
 281         $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
 282         $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
 283         $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) unless $self->{isolate} ;
 284
 285
 286         # get the INPUT filters (these only pertain to Clusters)
 287         $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
 288         $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
 289         $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
 290         $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
 291         $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1) unless $self->{isolate};
 292
 293         # set unbuffered and no echo
 294         $self->send_now('B',"0");
 295         $self->send_now('E',"0");
 296         $self->conn->echo(0) if $self->conn->can('echo');
 297
 298         # ping neighbour node stuff
 299         my $ping = $user->pingint;
 300         $ping = $pingint unless defined $ping;
 301         $self->{pingint} = $ping;
 302         $self->{nopings} = $user->nopings || $obscount;
 303         $self->{pingtime} = [ ];
 304         $self->{pingave} = 999;
 305         $self->{metric} ||= 100;
 306         $self->{lastping} = $main::systime;
 307
 308         # send initialisation string
 309         unless ($self->{outbound}) {
 310                 $self->sendinit;
 311         }
 312
 313         $self->state('init');
 314         $self->{pc50_t} = $main::systime;
 315
 316         # send info to all logged in thingies
 317         $self->tell_login('loginn');
 318
 319         # run a script send the output to the debug file
 320         my $script = new Script(lc $call) || new Script('node_default');
 321         $script->run($self) if $script;
 322 }
 323
 324 #
 325 # send outgoing 'challenge'
 326 #
 327
 328 sub sendinit
 329 {
 330         my $self = shift;
 331         $self->send(pc18());
 332 }
 333
 334
 335 #
 336 # This is the normal pcxx despatcher
 337 #
 338 sub normal
 339 {
 340         my ($self, $line) = @_;
 341
 342         my @field = split /\^/, $line;
 343         return unless @field;
 344
 345         pop @field if $field[-1] eq '~';
 346
 347 #       print join(',', @field), "\n";
 348
 349         # process PC frames, this will fail unless the frame starts PCnn
 350         my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
 351         unless (defined $pcno && $pcno >= 10 && $pcno <= 99) {
 352                 dbg("PCPROT: unknown protocol") if isdbg('chanerr');
 353                 return;
 354         }
 355
 356         # check for and dump bad protocol messages
 357         my $n = check($pcno, @field);
 358         if ($n) {
 359                 dbg("PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")") if isdbg('chanerr');
 360                 return;
 361         }
 362
 363         # decrement any hop fields at this point
 364         if ($line =~ /\^H(\d\d?)\^?~?$/) {
 365                 my $hops = $1 - 1;
 366                 if ($hops < 0) {
 367                         dbg("PCPROT: zero hop count, dumped") if isdbg('chanerr');
 368                         return;
 369                 }
 370                 $line =~ s/\^H\d\d?(\^?~?)$/^H$hops$1/;
 371         }
 372
 373         my $origin = $self->{call};
 374         no strict 'subs';
 375         my $sub = "handle_$pcno";
 376
 377         if ($self->can($sub)) {
 378                 $self->$sub($pcno, $line, $origin, @field);
 379         } else {
 380                 $self->handle_default($pcno, $line, $origin, @field);
 381         }
 382 }
 383
 384 # incoming talk commands
 385 sub handle_10
 386 {
 387         my $self = shift;
 388         my $pcno = shift;
 389         my $line = shift;
 390         my $origin = shift;
 391
 392         # rsfp check
 393         return if $rspfcheck and !$self->rspfcheck(0, $_[6], $_[1]);
 394
 395         # will we allow it at all?
 396         if ($censorpc) {
 397                 my @bad;
 398                 if (@bad = BadWords::check($_[3])) {
 399                         dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
 400                         return;
 401                 }
 402         }
 403
 404         # is it for me or one of mine?
 405         my ($from, $to, $via, $call, $dxchan);
 406         $from = $_[1];
 407         if ($_[5] gt ' ') {
 408                 $via = $_[2];
 409                 $to = $_[5];
 410         } else {
 411                 $to = $_[2];
 412         }
 413
 414         # if this is a 'nodx' node then ignore it
 415         if ($badnode->in($_[6]) || ($via && $badnode->in($via))) {
 416                 dbg("PCPROT: Bad Node, dropped") if isdbg('chanerr');
 417                 return;
 418         }
 419
 420         # if this is a 'bad spotter' user then ignore it
 421         my $nossid = $from;
 422         $nossid =~ s/-\d+$//;
 423         if ($badspotter->in($nossid)) {
 424                 dbg("PCPROT: Bad Spotter, dropped") if isdbg('chanerr');
 425                 return;
 426         }
 427
 428         # if we are converting announces to talk is it a dup?
 429         if ($ann_to_talk) {
 430                 if (AnnTalk::is_talk_candidate($from, $_[3]) && AnnTalk::dup($from, $to, $_[3])) {
 431                         dbg("DXPROT: Dupe talk from announce, dropped") if isdbg('chanerr');
 432                         return;
 433                 }
 434         }
 435
 436         # remember a route to this node and also the node on which this user is
 437         RouteDB::update($_[6], $origin);
 438 #       RouteDB::update($to, $_[6]);
 439
 440         # it is here and logged on
 441         $dxchan = DXChannel->get($main::myalias) if $to eq $main::mycall;
 442         $dxchan = DXChannel->get($to) unless $dxchan;
 443         if ($dxchan && $dxchan->is_user) {
 444                 $_[3] =~ s/\%5E/^/g;
 445                 $dxchan->talk($from, $to, $via, $_[3]);
 446                 return;
 447         }
 448
 449         # is it elsewhere, visible on the cluster via the to address?
 450         # note: this discards the via unless the to address is on
 451         # the via address
 452         my ($ref, $vref);
 453         if ($ref = Route::get($to)) {
 454                 $vref = Route::Node::get($via) if $via;
 455                 $vref = undef unless $vref && grep $to eq $_, $vref->users;
 456                 $ref->dxchan->talk($from, $to, $vref ? $via : undef, $_[3], $_[6]);
 457                 return;
 458         }
 459
 460         # can we see an interface to send it down?
 461
 462         # not visible here, send a message of condolence
 463         $vref = undef;
 464         $ref = Route::get($from);
 465         $vref = $ref = Route::Node::get($_[6]) unless $ref;
 466         if ($ref) {
 467                 $dxchan = $ref->dxchan;
 468                 $dxchan->talk($main::mycall, $from, $vref ? $vref->call : undef, $dxchan->msg('talknh', $to) );
 469         }
 470 }
 471
 472 # DX Spot handling
 473 sub handle_11
 474 {
 475         my $self = shift;
 476         my $pcno = shift;
 477         my $line = shift;
 478         my $origin = shift;
 479
 480         # route 'foreign' pc26s
 481         if ($pcno == 26) {
 482                 if ($_[7] ne $main::mycall) {
 483                         $self->route($_[7], $line);
 484                         return;
 485                 }
 486         }
 487
 488         # rsfp check
 489         #                       return if $rspfcheck and !$self->rspfcheck(1, $_[7], $_[6]);
 490
 491         # if this is a 'nodx' node then ignore it
 492         if ($badnode->in($_[7])) {
 493                 dbg("PCPROT: Bad Node, dropped") if isdbg('chanerr');
 494                 return;
 495         }
 496
 497         # if this is a 'bad spotter' user then ignore it
 498         my $nossid = $_[6];
 499         $nossid =~ s/-\d+$//;
 500         if ($badspotter->in($nossid)) {
 501                 dbg("PCPROT: Bad Spotter, dropped") if isdbg('chanerr');
 502                 return;
 503         }
 504
 505         # convert the date to a unix date
 506         my $d = cltounix($_[3], $_[4]);
 507         # bang out (and don't pass on) if date is invalid or the spot is too old (or too young)
 508         if (!$d || ($pcno == 11 && ($d < $main::systime - $pc11_max_age || $d > $main::systime + 900))) {
 509                 dbg("PCPROT: Spot ignored, invalid date or out of range ($_[3] $_[4])\n") if isdbg('chanerr');
 510                 return;
 511         }
 512
 513         # is it 'baddx'
 514         if ($baddx->in($_[2]) || BadWords::check($_[2])) {
 515                 dbg("PCPROT: Bad DX spot, ignored") if isdbg('chanerr');
 516                 return;
 517         }
 518
 519         # do some de-duping
 520         $_[5] =~ s/^\s+//;                      # take any leading blanks off
 521         $_[2] = unpad($_[2]);           # take off leading and trailing blanks from spotted callsign
 522         if ($_[2] =~ /BUST\w*$/) {
 523                 dbg("PCPROT: useless 'BUSTED' spot") if isdbg('chanerr');
 524                 return;
 525         }
 526         if ($censorpc) {
 527                 my @bad;
 528                 if (@bad = BadWords::check($_[5])) {
 529                         dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
 530                         return;
 531                 }
 532         }
 533
 534         # remember a route
 535 #       RouteDB::update($_[7], $self->{call});
 536 #       RouteDB::update($_[6], $_[7]);
 537
 538         my @spot = Spot::prepare($_[1], $_[2], $d, $_[5], $_[6], $_[7]);
 539
 540         my $thing = Thingy::Dx->new(origin=>$main::mycall);
 541         $thing->from_DXProt(DXProt=>$line,spotdata=>\@spot);
 542         $thing->process($self);
 543
 544         # this goes after the input filtering, but before the add
 545         # so that if it is input filtered, it isn't added to the dup
 546         # list. This allows it to come in from a "legitimate" source
 547         #
 548         # @spot at this point contains:-
 549         # freq, spotted call, time, text, spotter, spotted cc, spotters cc, orig node
 550         # then  spotted itu, spotted cq, spotters itu, spotters cq
 551         # you should be able to route on any of these
 552         #
 553
 554         # fix up qra locators of known users
 555         my $user = DXUser->get_current($spot[4]);
 556         if ($user) {
 557                 my $qra = $user->qra;
 558                 unless ($qra && is_qra($qra)) {
 559                         my $lat = $user->lat;
 560                         my $long = $user->long;
 561                         if (defined $lat && defined $long) {
 562                                 $user->qra(DXBearing::lltoqra($lat, $long));
 563                                 $user->put;
 564                         }
 565                 }
 566
 567                 # send a remote command to a distant cluster if it is visible and there is no
 568                 # qra locator and we havn't done it for a month.
 569
 570                 unless ($user->qra) {
 571                         my $node;
 572                         my $to = $user->homenode;
 573                         my $last = $user->lastoper || 0;
 574                         if ($send_opernam && $to && $to ne $main::mycall && $main::systime > $last + $DXUser::lastoperinterval && ($node = Route::Node::get($to)) ) {
 575                                 my $cmd = "forward/opernam $spot[4]";
 576                                 # send the rcmd but we aren't interested in the replies...
 577                                 my $dxchan = $node->dxchan;
 578                                 if ($dxchan && $dxchan->is_clx) {
 579                                         route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
 580                                 } else {
 581                                         route(undef, $to, pc34($main::mycall, $to, $cmd));
 582                                 }
 583                                 if ($to ne $_[7]) {
 584                                         $to = $_[7];
 585                                         $node = Route::Node::get($to);
 586                                         if ($node) {
 587                                                 $dxchan = $node->dxchan;
 588                                                 if ($dxchan && $dxchan->is_clx) {
 589                                                         route(undef, $to, pc84($main::mycall, $to, $main::mycall, $cmd));
 590                                                 } else {
 591                                                         route(undef, $to, pc34($main::mycall, $to, $cmd));
 592                                                 }
 593                                         }
 594                                 }
 595                                 $user->lastoper($main::systime);
 596                                 $user->put;
 597                         }
 598                 }
 599         }
 600 }
 601
 602 # announces
 603 sub handle_12
 604 {
 605         my $self = shift;
 606         my $pcno = shift;
 607         my $line = shift;
 608         my $origin = shift;
 609
 610         #                       return if $rspfcheck and !$self->rspfcheck(1, $_[5], $_[1]);
 611
 612         # announce duplicate checking
 613         $_[3] =~ s/^\s+//;                      # remove leading blanks
 614
 615         if ($censorpc) {
 616                 my @bad;
 617                 if (@bad = BadWords::check($_[3])) {
 618                         dbg("PCPROT: Bad words: @bad, dropped") if isdbg('chanerr');
 619                         return;
 620                 }
 621         }
 622
 623         # if this is a 'nodx' node then ignore it
 624         if ($badnode->in($_[5])) {
 625                 dbg("PCPROT: Bad Node, dropped") if isdbg('chanerr');
 626                 return;
 627         }
 628
 629         # if this is a 'bad spotter' user then ignore it
 630         my $nossid = $_[1];
 631         $nossid =~ s/-\d+$//;
 632         if ($badspotter->in($nossid)) {
 633                 dbg("PCPROT: Bad Spotter, dropped") if isdbg('chanerr');
 634                 return;
 635         }
 636
 637
 638         my $dxchan;
 639
 640         if ((($dxchan = DXChannel->get($_[2])) && $dxchan->is_user) || $_[4] =~ /^[\#\w.]+$/){
 641                 $self->send_chat($line, @_[1..6]);
 642         } elsif ($_[2] eq '*' || $_[2] eq $main::mycall) {
 643
 644                 # remember a route
 645 #               RouteDB::update($_[5], $self->{call});
 646 #               RouteDB::update($_[1], $_[5]);
 647
 648                 # ignore something that looks like a chat line coming in with sysop
 649                 # flag - this is a kludge...
 650                 if ($_[3] =~ /^\#\d+ / && $_[4] eq '*') {
 651                         dbg('PCPROT: Probable chat rewrite, dropped') if isdbg('chanerr');
 652                         return;
 653                 }
 654
 655                 # here's a bit of fun, convert incoming ann with a callsign in the first word
 656                 # or one saying 'to <call>' to a talk if we can route to the recipient
 657                 if ($ann_to_talk) {
 658                         my $call = AnnTalk::is_talk_candidate($_[1], $_[3]);
 659                         if ($call) {
 660                                 my $ref = Route::get($call);
 661                                 if ($ref) {
 662                                         $dxchan = $ref->dxchan;
 663                                         $dxchan->talk($_[1], $call, undef, $_[3], $_[5]) if $dxchan != $self;
 664                                         return;
 665                                 }
 666                         }
 667                 }
 668
 669                 # send it
 670                 $self->send_announce($line, @_[1..6]);
 671         } else {
 672                 $self->route($_[2], $line);
 673         }
 674 }
 675
 676 # incoming user
 677 sub handle_16
 678 {
 679         my $self = shift;
 680         my $pcno = shift;
 681         my $line = shift;
 682         my $origin = shift;
 683
 684         # general checks
 685         my $dxchan;
 686         my $ncall = $_[1];
 687         my $newline = "PC16^";
 688
 689         # dos I want users from this channel?
 690         unless ($self->user->wantpc16) {
 691                 dbg("PCPROT: don't send users to $origin") if isdbg('chanerr');
 692                 return;
 693         }
 694         # is it me?
 695         if ($ncall eq $main::mycall) {
 696                 dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
 697                 return;
 698         }
 699
 700         RouteDB::update($ncall, $self->{call});
 701
 702         # do we believe this call?
 703         unless ($ncall eq $self->{call} || $self->is_believed($ncall)) {
 704                 if (my $ivp = Investigate::get($ncall, $self->{call})) {
 705                         $ivp->store_pcxx($pcno,$line,$origin,@_);
 706                 } else {
 707                         dbg("PCPROT: We don't believe $ncall on $self->{call}") if isdbg('chanerr');
 708                 }
 709                 return;
 710         }
 711
 712         if (eph_dup($line)) {
 713                 dbg("PCPROT: dup PC16 detected") if isdbg('chanerr');
 714                 return;
 715         }
 716
 717         my $parent = Route::Node::get($ncall);
 718
 719         # if there is a parent, proceed, otherwise if there is a latent PC19 in the PC19list,
 720         # fix it up in the routing tables and issue it forth before the PC16
 721         unless ($parent) {
 722                 my $nl = $pc19list{$ncall};
 723
 724                 if ($nl && @_ > 3) { # 3 because of the hop count!
 725
 726                         # this is a new (remembered) node, now attach it to me if it isn't in filtered
 727                         # and we haven't disallowed it
 728                         my $user = DXUser->get_current($ncall);
 729                         if (!$user) {
 730                                 $user = DXUser->new($ncall);
 731                                 $user->sort('A');
 732                                 $user->priv(1); # I have relented and defaulted nodes
 733                                 $user->lockout(1);
 734                                 $user->homenode($ncall);
 735                                 $user->node($ncall);
 736                         }
 737
 738                         my $wantpc19 = $user->wantroutepc19;
 739                         if ($wantpc19 || !defined $wantpc19) {
 740                                 my $new = Route->new($ncall); # throw away
 741                                 if ($self->in_filter_route($new)) {
 742                                         my @nrout;
 743                                         for (@$nl) {
 744                                                 $parent = Route::Node::get($_->[0]);
 745                                                 $dxchan = $parent->dxchan if $parent;
 746                                                 if ($dxchan && $dxchan ne $self) {
 747                                                         dbg("PCPROT: PC19 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
 748                                                         $parent = undef;
 749                                                 }
 750         if ($parent) {
 751                                                         my $r = $parent->add($ncall, $_->[1], $_->[2]);
 752                                                         push @nrout, $r unless @nrout;
 753                                                 }
 754                                         }
 755                                         $user->wantroutepc19(1) unless defined $wantpc19; # for now we work on the basis that pc16 = real route
 756                                         $user->lastin($main::systime) unless DXChannel->get($ncall);
 757                                         $user->put;
 758
 759                                         # route the pc19 - this will cause 'stuttering PC19s' for a while
 760                                         $self->route_pc19($origin, $line, @nrout) if @nrout ;
 761                                         $parent = Route::Node::get($ncall);
 762                                         unless ($parent) {
 763                                                 dbg("PCPROT: lost $ncall after sending PC19 for it?");
 764                                                 return;
 765                                         }
 766                                 } else {
 767                                         return;
 768                                 }
 769                                 delete $pc19list{$ncall};
 770                         }
 771                 } else {
 772                         dbg("PCPROT: Node $ncall not in config") if isdbg('chanerr');
 773                         return;
 774                 }
 775         } else {
 776
 777                 $dxchan = $parent->dxchan;
 778                 if ($dxchan && $dxchan ne $self) {
 779                         dbg("PCPROT: PC16 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
 780                         return;
 781                 }
 782
 783                 # input filter if required
 784                 return unless $self->in_filter_route($parent);
 785         }
 786
 787                 my $i;
 788         my @rout;
 789                 for ($i = 2; $i < $#_; $i++) {
 790                         my ($call, $conf, $here) = $_[$i] =~ /^(\S+) (\S) (\d)/o;
 791                         next unless $call && $conf && defined $here && is_callsign($call);
 792                         next if $call eq $main::mycall;
 793
 794                         eph_del_regex("^PC17\\^$call\\^$ncall");
 795
 796                 $conf = $conf eq '*';
 797
 798                 # reject this if we think it is a node already
 799                 my $r = Route::Node::get($call);
 800                 my $u = DXUser->get_current($call) unless $r;
 801                 if ($r || ($u && $u->is_node)) {
 802                         dbg("PCPROT: $call is a node") if isdbg('chanerr');
 803                         next;
 804                 }
 805
 806                 $r = Route::User::get($call);
 807                 my $flags = Route::here($here)|Route::conf($conf);
 808
 809                 if ($r) {
 810                         my $au = $r->addparent($parent);
 811                         if ($r->flags != $flags) {
 812                                 $r->flags($flags);
 813                                 $au = $r;
 814                 }
 815                         push @rout, $r if $au;
 816         } else {
 817                         push @rout, $parent->add_user($call, $flags);
 818                 }
 819
 820
 821                 # add this station to the user database, if required
 822                 $call =~ s/-\d+$//o;    # remove ssid for users
 823                 my $user = DXUser->get_current($call);
 824                 $user = DXUser->new($call) if !$user;
 825                 $user->homenode($parent->call) if !$user->homenode;
 826                 $user->node($parent->call);
 827                 $user->lastin($main::systime) unless DXChannel->get($call);
 828                 $user->put;
 829         }
 830         $self->route_pc16($origin, $line, $parent, @rout) if @rout;
 831 }
 832
 833 # remove a user
 834 sub handle_17
 835 {
 836         my $self = shift;
 837         my $pcno = shift;
 838         my $line = shift;
 839         my $origin = shift;
 840         my $dxchan;
 841         my $ncall = $_[2];
 842         my $ucall = $_[1];
 843
 844         eph_del_regex("^PC16\\^$ncall.*$ucall");
 845
 846         # do I want users from this channel?
 847         unless ($self->user->wantpc16) {
 848                 dbg("PCPROT: don't send users to $self->{call}") if isdbg('chanerr');
 849                 return;
 850         }
 851         if ($ncall eq $main::mycall) {
 852                 dbg("PCPROT: trying to alter config on this node from outside!") if isdbg('chanerr');
 853                 return;
 854         }
 855
 856         RouteDB::delete($ncall, $self->{call});
 857
 858         # do we believe this call?
 859         unless ($ncall eq $self->{call} || $self->is_believed($ncall)) {
 860                 if (my $ivp = Investigate::get($ncall, $self->{call})) {
 861                         $ivp->store_pcxx($pcno,$line,$origin,@_);
 862                 } else {
 863                         dbg("PCPROT: We don't believe $ncall on $self->{call}") if isdbg('chanerr');
 864                 }
 865                 return;
 866         }
 867
 868         my $uref = Route::User::get($ucall);
 869         unless ($uref) {
 870                 dbg("PCPROT: Route::User $ucall not in config") if isdbg('chanerr');
 871         }
 872         my $parent = Route::Node::get($ncall);
 873         unless ($parent) {
 874                 dbg("PCPROT: Route::Node $ncall not in config") if isdbg('chanerr');
 875         }
 876
 877         $dxchan = $parent->dxchan if $parent;
 878         if ($dxchan && $dxchan ne $self) {
 879                 dbg("PCPROT: PC17 from $self->{call} trying to alter locally connected $ncall, ignored!") if isdbg('chanerr');
 880                 return;
 881         }
 882
 883         # input filter if required and then remove user if present
 884         if ($parent) {
 885 #               return unless $self->in_filter_route($parent);
 886                 $parent->del_user($uref) if $uref;
 887         } else {
 888                 $parent = Route->new($ncall);  # throw away
 889         }
 890
 891         if (eph_dup($line)) {
 892                 dbg("PCPROT: dup PC17 detected") if isdbg('chanerr');
 893                 return;
 894         }
 895
 896         $uref = Route->new($ucall) unless $uref; # throw away
 897         $self->route_pc17($origin, $line, $parent, $uref);
 898 }
 899
 900 # link request
 901 sub handle_18
 902 {
 903         my $self = shift;
 904         my $pcno = shift;
 905         my $line = shift;
 906         my $origin = shift;
 907         $self->state('init');
 908
 909         # record the type and version offered
 910         if ($_[1] =~ /DXSpider Version: (\d+\.\d+) Build: (\d+\.\d+)/) {
 911                 $self->version(52.51 + $1);
 912                 $self->user->version(52.51 + $1);
 913                 $self->build(0 + $2);
 914                 $self->user->build(0 + $2);
 915                 unless ($self->is_spider) {
 916                         $self->user->sort('S');
 917                         $self->user->put;
 918                         $self->sort('S');
 919                 }
 920         } else {
 921                 $self->version(50.0);
 922                 $self->version($_[2] / 100) if $_[2] && $_[2] =~ /^\d+$/;
 923                 $self->user->version($self->version);
 924         }
 925
 926         # first clear out any nodes on this dxchannel
 927         my $parent = Route::Node::get($origin);
 928         my @rout = $parent->del_nodes;
 929         $self->route_pc21($origin, $line, @rout, $parent) if @rout;
 930         $self->send_local_config();
 931         $self->send(pc20());
 932 }
 933
 934 # incoming cluster list
 935 sub handle_19
 936 {
 937         my $self = shift;
 938         my $pcno = shift;
 939         my $line = shift;
 940         my $origin = shift;
 941
 942         my $i;
 943         my $newline = "PC19^";
 944
 945         # new routing list
 946         my @rout;
 947
 948         # first get the INTERFACE node
 949         my $parent = Route::Node::get($origin);
 950         unless ($parent) {
 951                 dbg("DXPROT: my parent $origin has disappeared");
 952                 $self->disconnect;
 953                 return;
 954         }
 955
 956         # if the origin isn't the same as the INTERFACE, then reparent, creating nodes as necessary
 957         if ($origin ne $self->call) {
 958                 my $op = Route::Node::get($origin);
 959                 unless ($op) {
 960                         $op = $parent->add($origin, 5000, Route::here(1));
 961                         my $user = DXUser->get_current($origin);
 962                         if (!$user) {
 963                                 $user = DXUser->new($origin);
 964                                 $user->priv(1);         # I have relented and defaulted nodes
 965                                 $user->lockout(1);
 966                                 $user->homenode($origin);
 967                                 $user->node($origin);
 968                                 $user->wantroutepc19(1);
 969                         }
 970                         $user->sort('A') unless $user->is_node;
 971                         $user->put;
 972                 }
 973                 $parent = $op;
 974         }
 975
 976         # parse the PC19
 977         for ($i = 1; $i < $#_-1; $i += 4) {
 978                 my $here = $_[$i];
 979                 my $call = uc $_[$i+1];
 980                 my $conf = $_[$i+2];
 981                 my $ver = $_[$i+3];
 982                 next unless defined $here && defined $conf && is_callsign($call);
 983
 984                 eph_del_regex("^PC(?:21\\^$call|17\\^[^\\^]+\\^$call)");
 985
 986                 # check for sane parameters
 987                 #                               $ver = 5000 if $ver eq '0000';
 988                 next if $ver < 5000;    # only works with version 5 software
 989                 next if length $call < 3; # min 3 letter callsigns
 990                 next if $call eq $main::mycall;
 991
 992                 # check that this PC19 isn't trying to alter the wrong dxchan
 993                 my $dxchan = DXChannel->get($call);
 994                 if ($dxchan && $dxchan != $self) {
 995                         dbg("PCPROT: PC19 from $origin trying to alter wrong locally connected $call, ignored!") if isdbg('chanerr');
 996                         next;
 997                 }
 998
 999                 # add this station to the user database, if required (don't remove SSID from nodes)
1000                 my $user = DXUser->get_current($call);
1001                 if (!$user) {
1002                         $user = DXUser->new($call);
1003                         $user->priv(1);         # I have relented and defaulted nodes
1004                         $user->lockout(1);
1005                         $user->homenode($call);
1006                         $user->node($call);
1007                 }
1008                 $user->sort('A') unless $user->is_node;
1009
1010                 RouteDB::update($call, $origin);
1011
1012                 # do we believe this call?
1013                 my $genline = "PC19^$here^$call^$conf^$ver^$_[-1]^";
1014                 unless ($call eq $origin || $self->is_believed($call)) {
1015                         my $pt = $user->lastping($origin) || 0;
1016                         if ($pt+$investigation_int < $main::systime && !Investigate::get($call, $origin)) {
1017                                 my $ivp  = Investigate->new($call, $origin);
1018                                 $ivp->version($ver);
1019                                 $ivp->here($here);
1020                                 $ivp->store_pcxx($pcno,$genline,$origin,'PC19',$here,$call,$conf,$ver,$_[-1]);
1021                         } else {
1022                                 dbg("PCPROT: We don't believe $call on $origin") if isdbg('chanerr');
1023                         }
1024                         $user->put;
1025                         next;
1026                 }
1027
1028                 if (eph_dup($genline)) {
1029                         dbg("PCPROT: dup PC19 for $call detected") if isdbg('chanerr');
1030                         next;
1031                 }
1032
1033                 my $r = Route::Node::get($call);
1034                 my $flags = Route::here($here)|Route::conf($conf);
1035
1036                 # modify the routing table if it is in it, otherwise store it in the pc19list for now
1037                 if ($r) {
1038                         my $ar;
1039                         if ($call ne $parent->call) {
1040                                 if ($self->in_filter_route($r)) {
1041                                         $ar = $parent->add($call, $ver, $flags);
1042                                         push @rout, $ar if $ar;
1043                                 } else {
1044                                         next;
1045                                 }
1046                         }
1047                         if ($r->version ne $ver || $r->flags != $flags) {
1048                                 $r->version($ver);
1049                                 $r->flags($flags);
1050                                 push @rout, $r unless $ar;
1051                         }
1052                 } else {
1053
1054                         # if he is directly connected or allowed then add him, otherwise store him up for later
1055                         if ($call eq $origin || $user->wantroutepc19) {
1056                                 my $new = Route->new($call); # throw away
1057                                 if ($self->in_filter_route($new)) {
1058                                         my $ar = $parent->add($call, $ver, $flags);
1059                                         $user->wantroutepc19(1) unless defined $user->wantroutepc19;
1060                                         push @rout, $ar if $ar;
1061                                 } else {
1062                                         next;
1063                                 }
1064                         } else {
1065                                 $pc19list{$call} = [] unless exists $pc19list{$call};
1066                                 my $nl = $pc19list{$call};
1067                                 push @{$pc19list{$call}}, [$origin, $ver, $flags] unless grep $_->[0] eq $origin, @$nl;
1068                         }
1069                 }
1070
1071                 # unbusy and stop and outgoing mail (ie if somehow we receive another PC19 without a disconnect)
1072                 my $mref = DXMsg::get_busy($call);
1073                 $mref->stop_msg($call) if $mref;
1074
1075                 $user->lastin($main::systime) unless DXChannel->get($call);
1076                 $user->put;
1077         }
1078
1079
1080         $self->route_pc19($origin, $line, @rout) if @rout;
1081 }
1082
1083 # send local configuration
1084 sub handle_20
1085 {
1086         my $self = shift;
1087         my $pcno = shift;
1088         my $line = shift;
1089         my $origin = shift;
1090         $self->send_local_config();
1091         $self->send(pc22());
1092         $self->state('normal');
1093         $self->{lastping} = 0;
1094 }
1095
1096 # delete a cluster from the list
1097 sub handle_21
1098 {
1099         my $self = shift;
1100         my $pcno = shift;
1101         my $line = shift;
1102         my $origin = shift;
1103         my $call = uc $_[1];
1104
1105         eph_del_regex("^PC1[679].*$call");
1106
1107         # if I get a PC21 from the same callsign as self then treat it
1108         # as a PC39: I have gone away
1109         if ($call eq $self->call) {
1110                 $self->disconnect(1);
1111                 return;
1112         }
1113
1114         RouteDB::delete($call, $origin);
1115
1116         # check if we believe this
1117         unless ($call eq $origin || $self->is_believed($call)) {
1118                 if (my $ivp = Investigate::get($call, $origin)) {
1119                         $ivp->store_pcxx($pcno,$line,$origin,@_);
1120                 } else {
1121                         dbg("PCPROT: We don't believe $call on $origin") if isdbg('chanerr');
1122                 }
1123                 return;
1124         }
1125
1126         # check to see if we are in the pc19list, if we are then don't bother with any of
1127         # this routing table manipulation, just remove it from the list and dump it
1128         my @rout;
1129         if (my $nl = $pc19list{$call}) {
1130                 $pc19list{$call} = [ grep {$_->[0] ne $origin} @$nl ];
1131                 delete $pc19list{$call} unless @{$pc19list{$call}};
1132         } else {
1133
1134                 my $parent = Route::Node::get($origin);
1135                 unless ($parent) {
1136                         dbg("DXPROT: my parent $origin has disappeared");
1137                         $self->disconnect;
1138                         return;
1139                 }
1140                 if ($call ne $main::mycall) { # don't allow malicious buggers to disconnect me!
1141                         my $node = Route::Node::get($call);
1142                         if ($node) {
1143
1144                                 my $dxchan = DXChannel->get($call);
1145                                 if ($dxchan && $dxchan != $self) {
1146                                         dbg("PCPROT: PC21 from $origin trying to alter locally connected $call, ignored!") if isdbg('chanerr');
1147                                         return;
1148                                 }
1149
1150                                 # input filter it
1151                                 return unless $self->in_filter_route($node);
1152
1153                                 # routing objects
1154                                 push @rout, $node->del($parent);
1155                         }
1156                 } else {
1157                         dbg("PCPROT: I WILL _NOT_ be disconnected!") if isdbg('chanerr');
1158                         return;
1159                 }
1160         }
1161
1162         $self->route_pc21($origin, $line, @rout) if @rout;
1163 }
1164
1165
1166 sub handle_22
1167 {
1168         my $self = shift;
1169         my $pcno = shift;
1170         my $line = shift;
1171         my $origin = shift;
1172         $self->state('normal');
1173         $self->{lastping} = 0;
1174 }
1175
1176 # WWV info
1177 sub handle_23
1178 {
1179         my $self = shift;
1180         my $pcno = shift;
1181         my $line = shift;
1182         my $origin = shift;
1183
1184         # route foreign' pc27s
1185         if ($pcno == 27) {
1186                 if ($_[8] ne $main::mycall) {
1187                         $self->route($_[8], $line);
1188                         return;
1189                 }
1190         }
1191
1192         # only do a rspf check on PC23 (not 27)
1193         if ($pcno == 23) {
1194                 return if $rspfcheck and !$self->rspfcheck(1, $_[8], $_[7])
1195         }
1196
1197         # do some de-duping
1198         my $d = cltounix($_[1], sprintf("%02d18Z", $_[2]));
1199         my $sfi = unpad($_[3]);
1200         my $k = unpad($_[4]);
1201         my $i = unpad($_[5]);
1202         my ($r) = $_[6] =~ /R=(\d+)/;
1203         $r = 0 unless $r;
1204         if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $_[2] < 0 || $_[2] > 23) {
1205                 dbg("PCPROT: WWV Date ($_[1] $_[2]) out of range") if isdbg('chanerr');
1206                 return;
1207         }
1208         if (Geomag::dup($d,$sfi,$k,$i,$_[6])) {
1209                 dbg("PCPROT: Dup WWV Spot ignored\n") if isdbg('chanerr');
1210                 return;
1211         }
1212         $_[7] =~ s/-\d+$//o;            # remove spotter's ssid
1213
1214         my $wwv = Geomag::update($d, $_[2], $sfi, $k, $i, @_[6..8], $r);
1215
1216         my $rep;
1217         eval {
1218                 $rep = Local::wwv($self, $_[1], $_[2], $sfi, $k, $i, @_[6..8], $r);
1219         };
1220         #                       dbg("Local::wwv2 error $@") if isdbg('local') if $@;
1221         return if $rep;
1222
1223         # DON'T be silly and send on PC27s!
1224         return if $pcno == 27;
1225
1226         # broadcast to the eager world
1227         send_wwv_spot($self, $line, $d, $_[2], $sfi, $k, $i, @_[6..8]);
1228 }
1229
1230 # set here status
1231 sub handle_24
1232 {
1233         my $self = shift;
1234         my $pcno = shift;
1235         my $line = shift;
1236         my $origin = shift;
1237         my $call = uc $_[1];
1238         my ($nref, $uref);
1239         $nref = Route::Node::get($call);
1240         $uref = Route::User::get($call);
1241         return unless $nref || $uref; # if we don't know where they are, it's pointless sending it on
1242
1243         if (eph_dup($line)) {
1244                 dbg("PCPROT: Dup PC24 ignored\n") if isdbg('chanerr');
1245                 return;
1246         }
1247
1248         $nref->here($_[2]) if $nref;
1249         $uref->here($_[2]) if $uref;
1250         my $ref = $nref || $uref;
1251         return unless $self->in_filter_route($ref);
1252
1253         $self->route_pc24($origin, $line, $ref, $_[3]);
1254 }
1255
1256 # merge request
1257 sub handle_25
1258 {
1259         my $self = shift;
1260         my $pcno = shift;
1261         my $line = shift;
1262         my $origin = shift;
1263         if ($_[1] ne $main::mycall) {
1264                 $self->route($_[1], $line);
1265                 return;
1266         }
1267         if ($_[2] eq $main::mycall) {
1268                 dbg("PCPROT: Trying to merge to myself, ignored") if isdbg('chanerr');
1269                 return;
1270         }
1271
1272         Log('DXProt', "Merge request for $_[3] spots and $_[4] WWV from $_[2]");
1273
1274         # spots
1275         if ($_[3] > 0) {
1276                 my @in = reverse Spot::search(1, undef, undef, 0, $_[3]);
1277                 my $in;
1278                 foreach $in (@in) {
1279                         $self->send(pc26(@{$in}[0..4], $_[2]));
1280                 }
1281         }
1282
1283         # wwv
1284         if ($_[4] > 0) {
1285                 my @in = reverse Geomag::search(0, $_[4], time, 1);
1286                 my $in;
1287                 foreach $in (@in) {
1288                         $self->send(pc27(@{$in}[0..5], $_[2]));
1289                 }
1290         }
1291 }
1292
1293 sub handle_26 {goto &handle_11}
1294 sub handle_27 {goto &handle_23}
1295
1296 # mail/file handling
1297 sub handle_28
1298 {
1299         my $self = shift;
1300         my $pcno = shift;
1301         my $line = shift;
1302         my $origin = shift;
1303         if ($_[1] eq $main::mycall) {
1304                 no strict 'refs';
1305                 my $sub = "DXMsg::handle_$pcno";
1306                 &$sub($self, @_);
1307         } else {
1308                 $self->route($_[1], $line) unless $self->is_clx;
1309         }
1310 }
1311
1312 sub handle_29 {goto &handle_28}
1313 sub handle_30 {goto &handle_28}
1314 sub handle_31 {goto &handle_28}
1315 sub handle_32 {goto &handle_28}
1316 sub handle_33 {goto &handle_28}
1317
1318 sub handle_34
1319 {
1320         my $self = shift;
1321         my $pcno = shift;
1322         my $line = shift;
1323         my $origin = shift;
1324         if (eph_dup($line, $eph_pc34_restime)) {
1325                 dbg("PCPROT: dupe PC34, ignored") if isdbg('chanerr');
1326         } else {
1327                 $self->process_rcmd($_[1], $_[2], $_[2], $_[3]);
1328         }
1329 }
1330
1331 # remote command replies
1332 sub handle_35
1333 {
1334         my $self = shift;
1335         my $pcno = shift;
1336         my $line = shift;
1337         my $origin = shift;
1338         eph_del_regex("^PC35\\^$_[2]\\^$_[1]\\^");
1339         $self->process_rcmd_reply($_[1], $_[2], $_[1], $_[3]);
1340 }
1341
1342 sub handle_36 {goto &handle_34}
1343
1344 # database stuff
1345 sub handle_37
1346 {
1347         my $self = shift;
1348         my $pcno = shift;
1349         my $line = shift;
1350         my $origin = shift;
1351         if ($_[1] eq $main::mycall) {
1352                 no strict 'refs';
1353                 my $sub = "DXDb::handle_$pcno";
1354                 &$sub($self, @_);
1355         } else {
1356                 $self->route($_[1], $line) unless $self->is_clx;
1357         }
1358 }
1359
1360 # node connected list from neighbour
1361 sub handle_38
1362 {
1363         my $self = shift;
1364         my $pcno = shift;
1365         my $line = shift;
1366         my $origin = shift;
1367 }
1368
1369 # incoming disconnect
1370 sub handle_39
1371 {
1372         my $self = shift;
1373         my $pcno = shift;
1374         my $line = shift;
1375         my $origin = shift;
1376         if ($_[1] eq $origin) {
1377                 $self->disconnect(1);
1378         } else {
1379                 dbg("PCPROT: came in on wrong channel") if isdbg('chanerr');
1380         }
1381 }
1382
1383 sub handle_40 {goto &handle_28}
1384
1385 # user info
1386 sub handle_41
1387 {
1388         my $self = shift;
1389         my $pcno = shift;
1390         my $line = shift;
1391         my $origin = shift;
1392         my $call = $_[1];
1393
1394         my $l = $line;
1395         $l =~ s/[\x00-\x20\x7f-\xff]+//g; # remove all funny characters and spaces for dup checking
1396         if (eph_dup($l, $eph_info_restime)) {
1397                 dbg("PCPROT: dup PC41, ignored") if isdbg('chanerr');
1398                 return;
1399         }
1400
1401         # input filter if required
1402         #                       my $ref = Route::get($call) || Route->new($call);
1403         #                       return unless $self->in_filter_route($ref);
1404
1405         if ($_[3] eq $_[2] || $_[3] =~ /^\s*$/) {
1406                 dbg('PCPROT: invalid value') if isdbg('chanerr');
1407                 return;
1408         }
1409
1410         # add this station to the user database, if required
1411         my $user = DXUser->get_current($call);
1412         $user = DXUser->new($call) unless $user;
1413
1414         if ($_[2] == 1) {
1415                 $user->name($_[3]);
1416         } elsif ($_[2] == 2) {
1417                 $user->qth($_[3]);
1418         } elsif ($_[2] == 3) {
1419                 if (is_latlong($_[3])) {
1420                         my ($lat, $long) = DXBearing::stoll($_[3]);
1421                         $user->lat($lat);
1422                         $user->long($long);
1423                         $user->qra(DXBearing::lltoqra($lat, $long));
1424                 } else {
1425                         dbg('PCPROT: not a valid lat/long') if isdbg('chanerr');
1426                         return;
1427                 }
1428         } elsif ($_[2] == 4) {
1429                 $user->homenode($_[3]);
1430         } elsif ($_[2] == 5) {
1431                 if (is_qra(uc $_[3])) {
1432                         my ($lat, $long) = DXBearing::qratoll(uc $_[3]);
1433                         $user->lat($lat);
1434                         $user->long($long);
1435                         $user->qra(uc $_[3]);
1436                 } else {
1437                         dbg('PCPROT: not a valid QRA locator') if isdbg('chanerr');
1438                         return;
1439                 }
1440         }
1441         $user->lastoper($main::systime); # to cut down on excessive for/opers being generated
1442         $user->put;
1443
1444         unless ($self->{isolate}) {
1445                 DXChannel::broadcast_nodes($line, $self); # send it to everyone but me
1446         }
1447
1448         #  perhaps this IS what we want after all
1449         #                       $self->route_pc41($ref, $call, $_[2], $_[3], $_[4]);
1450 }
1451
1452 sub handle_42 {goto &handle_28}
1453
1454
1455 # database
1456 sub handle_44 {goto &handle_37}
1457 sub handle_45 {goto &handle_37}
1458 sub handle_46 {goto &handle_37}
1459 sub handle_47 {goto &handle_37}
1460 sub handle_48 {goto &handle_37}
1461
1462 # message and database
1463 sub handle_49
1464 {
1465         my $self = shift;
1466         my $pcno = shift;
1467         my $line = shift;
1468         my $origin = shift;
1469
1470         if (eph_dup($line)) {
1471                 dbg("PCPROT: Dup PC49 ignored\n") if isdbg('chanerr');
1472                 return;
1473         }
1474
1475         if ($_[1] eq $main::mycall) {
1476                 DXMsg::handle_49($self, @_);
1477         } else {
1478                 $self->route($_[1], $line) unless $self->is_clx;
1479         }
1480 }
1481
1482 # keep alive/user list
1483 sub handle_50
1484 {
1485         my $self = shift;
1486         my $pcno = shift;
1487         my $line = shift;
1488         my $origin = shift;
1489
1490         my $call = $_[1];
1491
1492         RouteDB::update($call, $origin);
1493
1494         my $node = Route::Node::get($call);
1495         if ($node) {
1496                 return unless $node->call eq $origin;
1497                 $node->usercount($_[2]);
1498
1499                 # input filter if required
1500                 return unless $self->in_filter_route($node);
1501
1502                 $self->route_pc50($origin, $line, $node, $_[2], $_[3]) unless eph_dup($line);
1503         }
1504 }
1505
1506 # incoming ping requests/answers
1507 sub handle_51
1508 {
1509         my $self = shift;
1510         my $pcno = shift;
1511         my $line = shift;
1512         my $origin = shift;
1513         my $to = $_[1];
1514         my $from = $_[2];
1515         my $flag = $_[3];
1516
1517
1518         # is it for us?
1519         if ($to eq $main::mycall) {
1520                 if ($flag == 1) {
1521                         $self->send(pc51($from, $to, '0'));
1522                 } else {
1523                         # it's a reply, look in the ping list for this one
1524                         my $ref = $pings{$from};
1525                         if ($ref) {
1526                                 my $tochan =  DXChannel->get($from);
1527                                 while (@$ref) {
1528                                         my $r = shift @$ref;
1529                                         my $dxchan = DXChannel->get($r->{call});
1530                                         next unless $dxchan;
1531                                         my $t = tv_interval($r->{t}, [ gettimeofday ]);
1532                                         if ($dxchan->is_user) {
1533                                                 my $s = sprintf "%.2f", $t;
1534                                                 my $ave = sprintf "%.2f", $tochan ? ($tochan->{pingave} || $t) : $t;
1535                                                 $dxchan->send($dxchan->msg('pingi', $from, $s, $ave))
1536                                         } elsif ($dxchan->is_node) {
1537                                                 if ($tochan) {
1538                                                         my $nopings = $tochan->user->nopings || $obscount;
1539                                                         push @{$tochan->{pingtime}}, $t;
1540                                                         shift @{$tochan->{pingtime}} if @{$tochan->{pingtime}} > 6;
1541
1542                                                         # cope with a missed ping, this means you must set the pingint large enough
1543                                                         if ($t > $tochan->{pingint}  && $t < 2 * $tochan->{pingint} ) {
1544                                                                 $t -= $tochan->{pingint};
1545                                                         }
1546
1547                                                         # calc smoothed RTT a la TCP
1548                                                         if (@{$tochan->{pingtime}} == 1) {
1549                                                                 $tochan->{pingave} = $t;
1550                                                         } else {
1551                                                                 $tochan->{pingave} = $tochan->{pingave} + (($t - $tochan->{pingave}) / 6);
1552                                                         }
1553                                                         $tochan->{nopings} = $nopings; # pump up the timer
1554                                                         if (my $ivp = Investigate::get($from, $origin)) {
1555                                                                 $ivp->handle_ping;
1556                                                         }
1557                                                 } elsif (my $rref = Route::Node::get($r->{call})) {
1558                                                         if (my $ivp = Investigate::get($from, $origin)) {
1559                                                                 $ivp->handle_ping;
1560                                                         }
1561                                                 }
1562                                         }
1563                                 }
1564                         }
1565                 }
1566         } else {
1567
1568                 RouteDB::update($from, $origin);
1569
1570                 if (eph_dup($line)) {
1571                         dbg("PCPROT: dup PC51 detected") if isdbg('chanerr');
1572                         return;
1573                 }
1574                 # route down an appropriate thingy
1575                 $self->route($to, $line);
1576         }
1577 }
1578
1579 # dunno but route it
1580 sub handle_75
1581 {
1582         my $self = shift;
1583         my $pcno = shift;
1584         my $line = shift;
1585         my $origin = shift;
1586         my $call = $_[1];
1587         if ($call ne $main::mycall) {
1588                 $self->route($call, $line);
1589         }
1590 }
1591
1592 # WCY broadcasts
1593 sub handle_73
1594 {
1595         my $self = shift;
1596         my $pcno = shift;
1597         my $line = shift;
1598         my $origin = shift;
1599         my $call = $_[1];
1600
1601         # do some de-duping
1602         my $d = cltounix($call, sprintf("%02d18Z", $_[2]));
1603         if (($pcno == 23 && $d < $main::systime - $pc23_max_age) || $d > $main::systime + 1500 || $_[2] < 0 || $_[2] > 23) {
1604                 dbg("PCPROT: WCY Date ($call $_[2]) out of range") if isdbg('chanerr');
1605                 return;
1606         }
1607         @_ = map { unpad($_) } @_;
1608         if (WCY::dup($d)) {
1609                 dbg("PCPROT: Dup WCY Spot ignored\n") if isdbg('chanerr');
1610                 return;
1611         }
1612
1613         my $wcy = WCY::update($d, @_[2..12]);
1614
1615         my $rep;
1616         eval {
1617                 $rep = Local::wcy($self, @_[1..12]);
1618         };
1619         # dbg("Local::wcy error $@") if isdbg('local') if $@;
1620         return if $rep;
1621
1622         # broadcast to the eager world
1623         send_wcy_spot($self, $line, $d, @_[2..12]);
1624 }
1625
1626 # remote commands (incoming)
1627 sub handle_84
1628 {
1629         my $self = shift;
1630         my $pcno = shift;
1631         my $line = shift;
1632         my $origin = shift;
1633         $self->process_rcmd($_[1], $_[2], $_[3], $_[4]);
1634 }
1635
1636 # remote command replies
1637 sub handle_85
1638 {
1639         my $self = shift;
1640         my $pcno = shift;
1641         my $line = shift;
1642         my $origin = shift;
1643         $self->process_rcmd_reply($_[1], $_[2], $_[3], $_[4]);
1644 }
1645
1646 # if get here then rebroadcast the thing with its Hop count decremented (if
1647 # there is one). If it has a hop count and it decrements to zero then don't
1648 # rebroadcast it.
1649 #
1650 # NOTE - don't arrive here UNLESS YOU WANT this lump of protocol to be
1651 #        REBROADCAST!!!!
1652 #
1653
1654 sub handle_default
1655 {
1656         my $self = shift;
1657         my $pcno = shift;
1658         my $line = shift;
1659         my $origin = shift;
1660
1661         if (eph_dup($line)) {
1662                 dbg("PCPROT: Ephemeral dup, dropped") if isdbg('chanerr');
1663         } else {
1664                 unless ($self->{isolate}) {
1665                         DXChannel::broadcast_nodes($line, $self) if $line =~ /\^H\d+\^?~?$/; # send it to everyone but me
1666                 }
1667         }
1668 }
1669
1670 #
1671 # This is called from inside the main cluster processing loop and is used
1672 # for despatching commands that are doing some long processing job
1673 #
1674 sub process
1675 {
1676         my $t = time;
1677         my @dxchan = DXChannel->get_all();
1678         my $dxchan;
1679         my $pc50s;
1680
1681         # send out a pc50 on EVERY channel all at once
1682         if ($t >= $last_pc50 + $DXProt::pc50_interval) {
1683                 $pc50s = pc50($main::me, scalar DXChannel::get_all_users);
1684                 eph_dup($pc50s);
1685                 $last_pc50 = $t;
1686         }
1687
1688         foreach $dxchan (@dxchan) {
1689                 next unless $dxchan->is_node();
1690                 next if $dxchan == $main::me;
1691
1692                 # send the pc50
1693                 $dxchan->send($pc50s) if $pc50s;
1694
1695                 # send a ping out on this channel
1696                 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
1697                         if ($dxchan->{nopings} <= 0) {
1698                                 $dxchan->disconnect;
1699                         } else {
1700                                 addping($main::mycall, $dxchan->call);
1701                                 $dxchan->{nopings} -= 1;
1702                                 $dxchan->{lastping} = $t;
1703                         }
1704                 }
1705         }
1706
1707         Investigate::process();
1708
1709         # every ten seconds
1710         if ($t - $last10 >= 10) {
1711                 # clean out ephemera
1712
1713                 eph_clean();
1714                 import_chat();
1715
1716
1717                 $last10 = $t;
1718         }
1719
1720         if ($main::systime - 3600 > $last_hour) {
1721                 $last_hour = $main::systime;
1722         }
1723 }
1724
1725 #
1726 # finish up a pc context
1727 #
1728
1729 #
1730 # some active measures
1731 #
1732
1733
1734 sub send_prot_line
1735 {
1736         my ($self, $filter, $hops, $isolate, $line) = @_;
1737         my $routeit;
1738
1739
1740         if ($hops) {
1741                 $routeit = $line;
1742                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1743         } else {
1744                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1745                 return unless $routeit;
1746         }
1747         if ($filter) {
1748                 $self->send($routeit);
1749         } else {
1750                 $self->send($routeit) unless $self->{isolate} || $isolate;
1751         }
1752 }
1753
1754
1755 sub send_wwv_spot
1756 {
1757         my $self = shift;
1758         my $line = shift;
1759         my @dxchan = DXChannel->get_all();
1760         my $dxchan;
1761         my @dxcc = ((Prefix::cty_data($_[6]))[0..2], (Prefix::cty_data($_[7]))[0..2]);
1762
1763         # send it if it isn't the except list and isn't isolated and still has a hop count
1764         # taking into account filtering and so on
1765         foreach $dxchan (@dxchan) {
1766                 next if $dxchan == $main::me;
1767                 next if $dxchan == $self && $self->is_node;
1768                 my $routeit;
1769                 my ($filter, $hops);
1770
1771                 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, @dxcc);
1772         }
1773 }
1774
1775 sub wwv
1776 {
1777         my $self = shift;
1778         my $line = shift;
1779         my $isolate = shift;
1780         my ($filter, $hops);
1781
1782         if ($self->{wwvfilter}) {
1783                 ($filter, $hops) = $self->{wwvfilter}->it(@_);
1784                 return unless $filter;
1785         }
1786         send_prot_line($self, $filter, $hops, $isolate, $line)
1787 }
1788
1789 sub send_wcy_spot
1790 {
1791         my $self = shift;
1792         my $line = shift;
1793         my @dxchan = DXChannel->get_all();
1794         my $dxchan;
1795         my @dxcc = ((Prefix::cty_data($_[10]))[0..2], (Prefix::cty_data($_[11]))[0..2]);
1796
1797         # send it if it isn't the except list and isn't isolated and still has a hop count
1798         # taking into account filtering and so on
1799         foreach $dxchan (@dxchan) {
1800                 next if $dxchan == $main::me;
1801                 next if $dxchan == $self;
1802
1803                 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, @dxcc);
1804         }
1805 }
1806
1807 sub wcy
1808 {
1809         my $self = shift;
1810         my $line = shift;
1811         my $isolate = shift;
1812         my ($filter, $hops);
1813
1814         if ($self->{wcyfilter}) {
1815                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
1816                 return unless $filter;
1817         }
1818         send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
1819 }
1820
1821 # send an announce
1822 sub send_announce
1823 {
1824         my $self = shift;
1825         my $line = shift;
1826         my @dxchan = DXChannel->get_all();
1827         my $dxchan;
1828         my $target;
1829         my $to = 'To ';
1830         my $text = unpad($_[2]);
1831
1832         if ($_[3] eq '*') {     # sysops
1833                 $target = "SYSOP";
1834         } elsif ($_[3] gt ' ') { # speciality list handling
1835                 my ($name) = split /\./, $_[3];
1836                 $target = "$name"; # put the rest in later (if bothered)
1837         }
1838
1839         if ($_[5] eq '1') {
1840                 $target = "WX";
1841                 $to = '';
1842         }
1843         $target = "ALL" if !$target;
1844
1845
1846         # obtain country codes etc
1847         my @a = Prefix::cty_data($_[0]);
1848         my @b = Prefix::cty_data($_[4]);
1849         if ($self->{inannfilter}) {
1850                 my ($filter, $hops) =
1851                         $self->{inannfilter}->it(@_, $self->{call},
1852                                                                          @a[0..2],
1853                                                                          @b[0..2], $a[3], $b[3]);
1854                 unless ($filter) {
1855                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
1856                         return;
1857                 }
1858         }
1859
1860         if (AnnTalk::dup($_[0], $_[1], $_[2])) {
1861                 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
1862                 return;
1863         }
1864
1865         Log('ann', $target, $_[0], $text);
1866
1867         # send it if it isn't the except list and isn't isolated and still has a hop count
1868         # taking into account filtering and so on
1869         foreach $dxchan (@dxchan) {
1870                 next if $dxchan == $main::me;
1871                 next if $dxchan == $self && $self->is_node;
1872                 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call},
1873                                                   @a[0..2], @b[0..2]);
1874         }
1875 }
1876
1877 my $msgid = 0;
1878
1879 sub nextchatmsgid
1880 {
1881         $msgid++;
1882         $msgid = 1 if $msgid > 999;
1883         return $msgid;
1884 }
1885
1886 # send a chat line
1887 sub send_chat
1888 {
1889         my $self = shift;
1890         my $line = shift;
1891         my @dxchan = DXChannel->get_all();
1892         my $dxchan;
1893         my $target = $_[3];
1894         my $text = unpad($_[2]);
1895         my $ak1a_line;
1896
1897         # munge the group and recast the line if required
1898         if ($target =~ s/\.LST$//) {
1899                 $ak1a_line = $line;
1900         }
1901
1902         # obtain country codes etc
1903         my @a = Prefix::cty_data($_[0]);
1904         my @b = Prefix::cty_data($_[4]);
1905         if ($self->{inannfilter}) {
1906                 my ($filter, $hops) =
1907                         $self->{inannfilter}->it(@_, $self->{call},
1908                                                                          @a[0..2],
1909                                                                          @b[0..2], $a[3], $b[3]);
1910                 unless ($filter) {
1911                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
1912                         return;
1913                 }
1914         }
1915
1916         if (AnnTalk::dup($_[0], $_[1], $_[2], $chatdupeage)) {
1917                 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
1918                 return;
1919         }
1920
1921
1922         Log('chat', $target, $_[0], $text);
1923
1924         # send it if it isn't the except list and isn't isolated and still has a hop count
1925         # taking into account filtering and so on
1926         foreach $dxchan (@dxchan) {
1927                 my $is_ak1a = $dxchan->is_ak1a;
1928
1929                 if ($dxchan->is_node) {
1930                         next if $dxchan == $main::me;
1931                         next if $dxchan == $self;
1932                         next unless $dxchan->is_spider || $is_ak1a;
1933                         next if $target eq 'LOCAL';
1934                         if (!$ak1a_line && $is_ak1a) {
1935                                 $ak1a_line = DXProt::pc12($_[0], $text, $_[1], "$target.LST");
1936                         }
1937                 }
1938
1939                 $dxchan->chat($is_ak1a ? $ak1a_line : $line, $self->{isolate}, $target, $_[1],
1940                                           $text, @_, $self->{call}, @a[0..2], @b[0..2]);
1941         }
1942 }
1943
1944 sub announce
1945 {
1946         my $self = shift;
1947         my $line = shift;
1948         my $isolate = shift;
1949         my $to = shift;
1950         my $target = shift;
1951         my $text = shift;
1952         my ($filter, $hops);
1953
1954         if ($self->{annfilter}) {
1955                 ($filter, $hops) = $self->{annfilter}->it(@_);
1956                 return unless $filter;
1957         }
1958         send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
1959 }
1960
1961 sub chat
1962 {
1963         goto &announce;
1964 }
1965
1966
1967 sub send_local_config
1968 {
1969         my $self = shift;
1970         my $node;
1971         my @nodes;
1972         my @localnodes;
1973         my @remotenodes;
1974
1975         dbg('DXProt::send_local_config') if isdbg('trace');
1976
1977         # send our nodes
1978         if ($self->{isolate}) {
1979                 @localnodes = ( $main::routeroot );
1980                 $self->send_route($main::mycall, \&pc19, 1, $main::routeroot);
1981         } else {
1982                 # create a list of all the nodes that are not connected to this connection
1983                 # and are not themselves isolated, this to make sure that isolated nodes
1984         # don't appear outside of this node
1985
1986                 # send locally connected nodes
1987                 my @dxchan = grep { $_->call ne $main::mycall && $_ != $self && !$_->{isolate} } DXChannel::get_all_nodes();
1988                 @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
1989                 $self->send_route($main::mycall, \&pc19, scalar(@localnodes)+1, $main::routeroot, @localnodes);
1990
1991                 my $node;
1992                 my @rawintcalls = map { $_->nodes } @localnodes if @localnodes;
1993                 my @intcalls;
1994                 for $node (@rawintcalls) {
1995                         push @intcalls, $node unless grep $node eq $_, @intcalls;
1996                 }
1997                 my $ref = Route::Node::get($self->{call});
1998                 my @rnodes = $ref->nodes;
1999                 for $node (@intcalls) {
2000                         push @remotenodes, Route::Node::get($node) unless grep $node eq $_, @rnodes, @remotenodes;
2001                 }
2002                 $self->send_route($main::mycall, \&pc19, scalar(@remotenodes), @remotenodes);
2003         }
2004
2005         # get all the users connected on the above nodes and send them out
2006         foreach $node ($main::routeroot, @localnodes, @remotenodes) {
2007                 if ($node) {
2008                         my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
2009                         $self->send_route($main::mycall, \&pc16, 1, $node, @rout) if @rout && $self->user->wantsendpc16;
2010                 } else {
2011                         dbg("sent a null value") if isdbg('chanerr');
2012                 }
2013         }
2014 }
2015
2016 #
2017 # route a message down an appropriate interface for a callsign
2018 #
2019 # is called route(to, pcline);
2020 #
2021
2022 sub route
2023 {
2024         my ($self, $call, $line) = @_;
2025
2026         if (ref $self && $call eq $self->{call}) {
2027                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
2028                 return;
2029         }
2030
2031         # always send it down the local interface if available
2032         my $dxchan = DXChannel->get($call);
2033         if ($dxchan) {
2034                 dbg("route: $call -> $dxchan->{call} direct" ) if isdbg('route');
2035         } else {
2036                 my $cl = Route::get($call);
2037                 $dxchan = $cl->dxchan if $cl;
2038                 if (ref $dxchan) {
2039                         if (ref $self && $dxchan eq $self) {
2040                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
2041                                 return;
2042                         }
2043                         dbg("route: $call -> $dxchan->{call} using normal route" ) if isdbg('route');
2044                 }
2045         }
2046
2047         # try the backstop method
2048         unless ($dxchan) {
2049                 my $rcall = RouteDB::get($call);
2050                 if ($rcall) {
2051                         if ($self && $rcall eq $self->{call}) {
2052                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
2053                                 return;
2054                         }
2055                         $dxchan = DXChannel->get($rcall);
2056                         dbg("route: $call -> $rcall using RouteDB" ) if isdbg('route') && $dxchan;
2057                 }
2058         }
2059
2060         if ($dxchan) {
2061                 my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
2062                 if ($routeit) {
2063                         $dxchan->send($routeit) unless $dxchan == $main::me;
2064                 }
2065         } else {
2066                 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
2067         }
2068 }
2069
2070 #
2071 # obtain the hops from the list for this callsign and pc no
2072 #
2073
2074 sub get_hops
2075 {
2076         my $pcno = shift;
2077         my $hops = $DXProt::hopcount{$pcno};
2078         $hops = $DXProt::def_hopcount if !$hops;
2079         return "H$hops";
2080 }
2081
2082 #
2083 # adjust the hop count on a per node basis using the user loadable
2084 # hop table if available or else decrement an existing one
2085 #
2086
2087 sub adjust_hops
2088 {
2089         my $self = shift;
2090         my $s = shift;
2091         my $call = $self->{call};
2092         my $hops;
2093
2094         if (($hops) = $s =~ /\^H(\d+)\^~?$/o) {
2095                 my ($pcno) = $s =~ /^PC(\d\d)/o;
2096                 confess "$call called adjust_hops with '$s'" unless $pcno;
2097                 my $ref = $nodehops{$call} if %nodehops;
2098                 if ($ref) {
2099                         my $newhops = $ref->{$pcno};
2100                         return "" if defined $newhops && $newhops == 0;
2101                         $newhops = $ref->{default} unless $newhops;
2102                         return "" if defined $newhops && $newhops == 0;
2103                         $newhops = $hops if !$newhops;
2104                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
2105                 } else {
2106                         # simply decrement it
2107 #                       $hops--;               this is done on receipt now
2108                         return "" if !$hops;
2109                         $s =~ s/\^H(\d+)(\^~?)$/\^H$hops$2/ if $hops;
2110                 }
2111         }
2112         return $s;
2113 }
2114
2115 #
2116 # load hop tables
2117 #
2118 sub load_hops
2119 {
2120         my $self = shift;
2121         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
2122         do "$main::data/hop_table.pl";
2123         return $@ if $@;
2124         return ();
2125 }
2126
2127
2128 # add a ping request to the ping queues
2129 sub addping
2130 {
2131         my ($from, $to, $via) = @_;
2132         my $ref = $pings{$to} || [];
2133         my $r = {};
2134         $r->{call} = $from;
2135         $r->{t} = [ gettimeofday ];
2136         if ($via && (my $dxchan = DXChannel->get($via))) {
2137                 $dxchan->send(pc51($to, $main::mycall, 1));
2138         } else {
2139                 route(undef, $to, pc51($to, $main::mycall, 1));
2140         }
2141         push @$ref, $r;
2142         $pings{$to} = $ref;
2143         my $u = DXUser->get_current($to);
2144         if ($u) {
2145                 $u->lastping(($via || $from), $main::systime);
2146                 $u->put;
2147         }
2148 }
2149
2150 sub process_rcmd
2151 {
2152         my ($self, $tonode, $fromnode, $user, $cmd) = @_;
2153         if ($tonode eq $main::mycall) {
2154                 my $ref = DXUser->get_current($fromnode);
2155                 my $cref = Route::Node::get($fromnode);
2156                 Log('rcmd', 'in', $ref->{priv}, $fromnode, $cmd);
2157                 if ($cmd !~ /^\s*rcmd/i && $cref && $ref && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
2158                         if ($ref->{priv}) {             # you have to have SOME privilege, the commands have further filtering
2159                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
2160                                 my $oldpriv = $self->{priv};
2161                                 $self->{priv} = $ref->{priv}; # assume the user's privilege level
2162                                 my @in = (DXCommandmode::run_cmd($self, $cmd));
2163                                 $self->{priv} = $oldpriv;
2164                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
2165                                 delete $self->{remotecmd};
2166                         } else {
2167                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
2168                         }
2169                 } else {
2170                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
2171                 }
2172         } else {
2173                 my $ref = DXUser->get_current($tonode);
2174                 if ($ref && $ref->is_clx) {
2175                         $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
2176                 } else {
2177                         $self->route($tonode, pc34($fromnode, $tonode, $cmd));
2178                 }
2179         }
2180 }
2181
2182 sub process_rcmd_reply
2183 {
2184         my ($self, $tonode, $fromnode, $user, $line) = @_;
2185         if ($tonode eq $main::mycall) {
2186                 my $s = $rcmds{$fromnode};
2187                 if ($s) {
2188                         my $dxchan = DXChannel->get($s->{call});
2189                         my $ref = $user eq $tonode ? $dxchan : (DXChannel->get($user) || $dxchan);
2190                         $ref->send($line) if $ref;
2191                         delete $rcmds{$fromnode} if !$dxchan;
2192                 } else {
2193                         # send unsolicited ones to the sysop
2194                         my $dxchan = DXChannel->get($main::myalias);
2195                         $dxchan->send($line) if $dxchan;
2196                 }
2197         } else {
2198                 my $ref = DXUser->get_current($tonode);
2199                 if ($ref && $ref->is_clx) {
2200                         $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
2201                 } else {
2202                         $self->route($tonode, pc35($fromnode, $tonode, $line));
2203                 }
2204         }
2205 }
2206
2207 sub send_rcmd_reply
2208 {
2209         my $self = shift;
2210         my $tonode = shift;
2211         my $fromnode = shift;
2212         my $user = shift;
2213         while (@_) {
2214                 my $line = shift;
2215                 $line =~ s/\s*$//;
2216                 Log('rcmd', 'out', $fromnode, $line);
2217                 if ($self->is_clx) {
2218                         $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
2219                 } else {
2220                         $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
2221                 }
2222         }
2223 }
2224
2225 # add a rcmd request to the rcmd queues
2226 sub addrcmd
2227 {
2228         my ($self, $to, $cmd) = @_;
2229
2230         my $r = {};
2231         $r->{call} = $self->{call};
2232         $r->{t} = $main::systime;
2233         $r->{cmd} = $cmd;
2234         $rcmds{$to} = $r;
2235
2236         my $ref = Route::Node::get($to);
2237         my $dxchan = $ref->dxchan;
2238         if ($dxchan && $dxchan->is_clx) {
2239                 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
2240         } else {
2241                 route(undef, $to, pc34($main::mycall, $to, $cmd));
2242         }
2243 }
2244
2245 sub disconnect
2246 {
2247         my $self = shift;
2248         my $pc39flag = shift;
2249         my $call = $self->call;
2250
2251         return if $self->{disconnecting}++;
2252
2253         unless ($pc39flag && $pc39flag == 1) {
2254                 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
2255         }
2256
2257         # get rid of any PC16/17/19
2258         eph_del_regex("^PC1[679]*$call");
2259
2260         # do routing stuff, remove me from routing table
2261         my $node = Route::Node::get($call);
2262         my @rout;
2263         if ($node) {
2264                 @rout = $node->del($main::routeroot);
2265
2266                 # and all my ephemera as well
2267                 for (@rout) {
2268                         my $c = $_->call;
2269                         eph_del_regex("^PC1[679].*$c");
2270                 }
2271         }
2272
2273         RouteDB::delete_interface($call);
2274
2275         # remove them from the pc19list as well
2276         while (my ($k,$v) = each %pc19list) {
2277                 my @l = grep {$_->[0] ne $call} @{$pc19list{$k}};
2278                 if (@l) {
2279                         $pc19list{$k} = \@l;
2280                 } else {
2281                         delete $pc19list{$k};
2282                 }
2283
2284                 # and the ephemera
2285                 eph_del_regex("^PC1[679].*$k");
2286         }
2287
2288         # unbusy and stop and outgoing mail
2289         my $mref = DXMsg::get_busy($call);
2290         $mref->stop_msg($call) if $mref;
2291
2292         # broadcast to all other nodes that all the nodes connected to via me are gone
2293         unless ($pc39flag && $pc39flag == 2) {
2294                 my $thing = Thingy::Bye->new(user=>$call);
2295                 $thing->broadcast($self);
2296
2297                 $self->route_pc21($main::mycall, undef, @rout) if @rout;
2298         }
2299
2300         # remove outstanding pings
2301         delete $pings{$call};
2302
2303         # I was the last node visited
2304     $self->user->node($main::mycall);
2305
2306         # send info to all logged in thingies
2307         $self->tell_login('logoutn');
2308
2309         Log('DXProt', $call . " Disconnected");
2310
2311         $self->SUPER::disconnect;
2312 }
2313
2314
2315 #
2316 # send a talk message to this thingy
2317 #
2318 sub talk
2319 {
2320         my ($self, $from, $to, $via, $line, $origin) = @_;
2321
2322         $line =~ s/\^/\\5E/g;                   # remove any ^ characters
2323         $self->send(DXProt::pc10($from, $to, $via, $line, $origin));
2324         Log('talk', $to, $from, $via?$via:$self->call, $line) unless $origin && $origin ne $main::mycall;
2325 }
2326
2327 # send it if it isn't the except list and isn't isolated and still has a hop count
2328 # taking into account filtering and so on
2329
2330 sub send_route
2331 {
2332         my $self = shift;
2333         my $origin = shift;
2334         my $generate = shift;
2335         my $no = shift;     # the no of things to filter on
2336         my $routeit;
2337         my ($filter, $hops);
2338         my @rin;
2339
2340         for (; @_ && $no; $no--) {
2341                 my $r = shift;
2342
2343                 if (!$self->{isolate} && $self->{routefilter}) {
2344                         $filter = undef;
2345                         if ($r) {
2346                                 ($filter, $hops) = $self->{routefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq, $self->{state}, $r->{state});
2347                                 if ($filter) {
2348                                         push @rin, $r;
2349                                 } else {
2350                                         dbg("DXPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('chanerr');
2351                                 }
2352                         } else {
2353                                 dbg("was sent a null value") if isdbg('chanerr');
2354                         }
2355                 } else {
2356                         push @rin, $r unless $self->{isolate} && $r->call ne $main::mycall;
2357                 }
2358         }
2359         if (@rin) {
2360                 foreach my $line (&$generate(@rin, @_)) {
2361                         if ($hops) {
2362                                 $routeit = $line;
2363                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
2364                         } else {
2365                                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
2366                                 next unless $routeit;
2367                         }
2368
2369                         $self->send($routeit);
2370                 }
2371         }
2372 }
2373
2374 sub broadcast_route
2375 {
2376         my $self = shift;
2377         my $origin = shift;
2378         my $generate = shift;
2379         my $line = shift;
2380         my @dxchan = DXChannel::get_all_nodes();
2381         my $dxchan;
2382
2383         unless ($self->{isolate}) {
2384                 foreach $dxchan (@dxchan) {
2385                         next if $dxchan == $self;
2386                         next if $dxchan == $main::me;
2387                         next unless $dxchan->isa('DXProt');
2388                         next if ($generate == \&pc16 || $generate==\&pc17) && !$dxchan->user->wantsendpc16;
2389
2390                         $dxchan->send_route($origin, $generate, @_);
2391                 }
2392         }
2393 }
2394
2395 sub route_pc16
2396 {
2397         my $self = shift;
2398         return unless $self->user->wantpc16;
2399         my $origin = shift;
2400         my $line = shift;
2401         broadcast_route($self, $origin, \&pc16, $line, 1, @_);
2402 }
2403
2404 sub route_pc17
2405 {
2406         my $self = shift;
2407         return unless $self->user->wantpc16;
2408         my $origin = shift;
2409         my $line = shift;
2410         broadcast_route($self, $origin, \&pc17, $line, 1, @_);
2411 }
2412
2413 sub route_pc19
2414 {
2415         my $self = shift;
2416         my $origin = shift;
2417         my $line = shift;
2418         broadcast_route($self, $origin, \&pc19, $line, scalar @_, @_);
2419 }
2420
2421 sub route_pc21
2422 {
2423         my $self = shift;
2424         my $origin = shift;
2425         my $line = shift;
2426         broadcast_route($self, $origin, \&pc21, $line, scalar @_, @_);
2427 }
2428
2429 sub route_pc24
2430 {
2431         my $self = shift;
2432         my $origin = shift;
2433         my $line = shift;
2434         broadcast_route($self, $origin, \&pc24, $line, 1, @_);
2435 }
2436
2437 sub route_pc41
2438 {
2439         my $self = shift;
2440         my $origin = shift;
2441         my $line = shift;
2442         broadcast_route($self, $origin, \&pc41, $line, 1, @_);
2443 }
2444
2445 sub route_pc50
2446 {
2447         my $self = shift;
2448         my $origin = shift;
2449         my $line = shift;
2450         broadcast_route($self, $origin, \&pc50, $line, 1, @_);
2451 }
2452
2453 sub in_filter_route
2454 {
2455         my $self = shift;
2456         my $r = shift;
2457         my ($filter, $hops) = (1, 1);
2458
2459         if ($self->{inroutefilter}) {
2460                 ($filter, $hops) = $self->{inroutefilter}->it($self->{call}, $self->{dxcc}, $self->{itu}, $self->{cq}, $r->call, $r->dxcc, $r->itu, $r->cq, $self->state, $r->state);
2461                 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
2462         }
2463         return $filter;
2464 }
2465
2466 sub eph_dup
2467 {
2468         my $s = shift;
2469         my $t = shift || $eph_restime;
2470         my $r;
2471
2472         # chop the end off
2473         $s =~ s/\^H\d\d?\^?\~?$//;
2474         $r = 1 if exists $eph{$s};    # pump up the dup if it keeps circulating
2475         $eph{$s} = $main::systime + $t;
2476         dbg("PCPROT: emphemeral duplicate") if $r && isdbg('chanerr');
2477         return $r;
2478 }
2479
2480 sub eph_del_regex
2481 {
2482         my $regex = shift;
2483         my ($key, $val);
2484         while (($key, $val) = each %eph) {
2485                 if ($key =~ m{$regex}) {
2486                         delete $eph{$key};
2487                 }
2488         }
2489 }
2490
2491 sub eph_clean
2492 {
2493         my ($key, $val);
2494
2495         while (($key, $val) = each %eph) {
2496                 if ($main::systime >= $val) {
2497                         delete $eph{$key};
2498                 }
2499         }
2500 }
2501
2502 sub eph_list
2503 {
2504         my ($key, $val);
2505         my @out;
2506
2507         while (($key, $val) = each %eph) {
2508                 push @out, $key, $val;
2509         }
2510         return @out;
2511 }
2512
2513 sub run_cmd
2514 {
2515         goto &DXCommandmode::run_cmd;
2516 }
2517
2518
2519 # import any msgs in the chat directory
2520 # the messages are sent to the chat group which forms the
2521 # the first part of the name (eg: solar.1243.txt would be
2522 # sent to chat group SOLAR)
2523 #
2524 # Each message found is sent: one non-blank line to one chat
2525 # message. So 4 lines = 4 chat messages.
2526 #
2527 # The special name LOCAL is for local users ANN
2528 # The special name ALL is for ANN/FULL
2529 # The special name SYSOP is for ANN/SYSOP
2530 #
2531 sub import_chat
2532 {
2533         # are there any to do in this directory?
2534         return unless -d $chatimportfn;
2535         unless (opendir(DIR, $chatimportfn)) {
2536                 dbg("can\'t open $chatimportfn $!") if isdbg('msg');
2537                 Log('msg', "can\'t open $chatimportfn $!");
2538                 return;
2539         }
2540
2541         my @names = readdir(DIR);
2542         closedir(DIR);
2543         my $name;
2544         foreach $name (@names) {
2545                 next if $name =~ /^\./;
2546                 my $splitit = $name =~ /^split/;
2547                 my $fn = "$chatimportfn/$name";
2548                 next unless -f $fn;
2549                 unless (open(MSG, $fn)) {
2550                         dbg("can\'t open import file $fn $!") if isdbg('msg');
2551                         Log('msg', "can\'t open import file $fn $!");
2552                         unlink($fn);
2553                         next;
2554                 }
2555                 my @msg = map { s/\r?\n$//; $_ } <MSG>;
2556                 close(MSG);
2557                 unlink($fn);
2558
2559                 my @cat = split /\./, $name;
2560                 my $target = uc $cat[0];
2561
2562                 foreach my $text (@msg) {
2563                         next unless $text && $text !~ /^\s*#/;
2564                         if ($target eq 'ALL' || $target eq 'LOCAL' || $target eq 'SYSOP') {
2565                                 my $sysopflag = $target eq 'SYSOP' ? '*' : ' ';
2566                                 if ($target ne 'LOCAL') {
2567                                         send_announce($main::me, pc12($main::mycall, $text, '*', $sysopflag), $main::mycall, '*', $text, $sysopflag, $main::mycall, '0');
2568                                 } else {
2569                                         Log('ann', 'LOCAL', $main::mycall, $text);
2570                                         DXChannel::broadcast_list("To LOCAL de ${main::mycall}: $text\a", 'ann', undef, DXCommandmode->get_all());
2571                                 }
2572                         } else {
2573                                 my $msgid = nextchatmsgid();
2574                                 $text = "#$msgid $text";
2575                                 send_chat($main::me, pc12($main::mycall, $text, '*', $target), $main::mycall, '*', $text, $target, $main::mycall, '0');
2576                         }
2577                 }
2578         }
2579 }
2580
2581 1;
2582 __END__