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