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