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