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