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