1094578e61e08429ab4df159c237c75c2720708f
[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 BadWords;
31 use DXHash;
32 use Route;
33 use Route::Node;
34 use Script;
35 use Investigate;
36 use RouteDB;
37 use DXProtHandle;
38
39 use strict;
40
41 use vars qw($VERSION $BRANCH);
42 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
43 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
44 $main::build += $VERSION;
45 $main::branch += $BRANCH;
46
47 use vars qw($pc11_max_age $pc23_max_age $last_pc50 $eph_restime $eph_info_restime $eph_pc34_restime
48                         $last_hour $last10 %eph  %pings %rcmds $ann_to_talk
49                         $pingint $obscount %pc19list $chatdupeage $chatimportfn
50                         $investigation_int $pc19_version $myprot_version
51                         %nodehops $baddx $badspotter $badnode $censorpc $rspfcheck
52                         $allowzero $decode_dk0wcy $send_opernam @checklist
53                    );
54
55 $pc11_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc11
56 $pc23_max_age = 1*3600;                 # the maximum age for an incoming 'real-time' pc23
57
58 $last_hour = time;                              # last time I did an hourly periodic update
59 %rcmds = ();                    # outstanding rcmd requests outbound
60 %nodehops = ();                 # node specific hop control
61 %pc19list = ();                                 # list of outstanding PC19s that haven't had PC16s on them
62
63 $censorpc = 1;                                  # Do a BadWords::check on text fields and reject things
64                                                                 # loads of 'bad things'
65 $baddx = new DXHash "baddx";
66 $badspotter = new DXHash "badspotter";
67 $badnode = new DXHash "badnode";
68 $last10 = $last_pc50 = time;
69 $ann_to_talk = 1;
70 $rspfcheck = 1;
71 $eph_restime = 180;
72 $eph_info_restime = 60*60;
73 $eph_pc34_restime = 30;
74 $pingint = 5*60;
75 $obscount = 2;
76 $chatdupeage = 20 * 60 * 60;
77 $chatimportfn = "$main::root/chat_import";
78 $investigation_int = 12*60*60;  # time between checks to see if we can see this node
79 $pc19_version = 5466;                   # the visible version no for outgoing PC19s generated from pc59
80
81 @checklist = 
82 (
83  [ qw(i c c m bp bc c) ],                       # pc10
84  [ qw(i f m d t m c c h) ],             # pc11
85  [ qw(i c bm m bm bm p h) ],            # pc12
86  [ qw(i c h) ],                                 # 
87  [ qw(i c h) ],                                 # 
88  [ qw(i c m h) ],                                       # 
89  undef ,                                                # pc16 has to be validated manually
90  [ qw(i c c h) ],                                       # pc17
91  [ qw(i m n) ],                                 # pc18
92  undef ,                                                # pc19 has to be validated manually
93  undef ,                                                # pc20 no validation
94  [ qw(i c m h) ],                                       # pc21
95  undef ,                                                # pc22 no validation
96  [ qw(i d n n n n m c c h) ],           # pc23
97  [ qw(i c p h) ],                                       # pc24
98  [ qw(i c c n n) ],                             # pc25
99  [ qw(i f m d t m c c bc) ],            # pc26
100  [ qw(i d n n n n m c c bc) ],  # pc27
101  [ qw(i c c m c d t p m bp n p bp bc) ], # pc28
102  [ qw(i c c n m) ],                             # pc29
103  [ qw(i c c n) ],                                       # pc30
104  [ qw(i c c n) ],                                       # pc31
105  [ qw(i c c n) ],                                       # pc32
106  [ qw(i c c n) ],                                       # pc33
107  [ qw(i c c m) ],                                       # pc34
108  [ qw(i c c m) ],                                       # pc35
109  [ qw(i c c m) ],                                       # pc36
110  [ qw(i c c n m) ],                             # pc37
111  undef,                                                 # pc38 not interested
112  [ qw(i c m) ],                                 # pc39
113  [ qw(i c c m p n) ],                           # pc40
114  [ qw(i c n m h) ],                             # pc41
115  [ qw(i c c n) ],                                       # pc42
116  undef,                                                 # pc43 don't handle it
117  [ qw(i c c n m m c) ],                 # pc44
118  [ qw(i c c n m) ],                             # pc45
119  [ qw(i c c n) ],                                       # pc46
120  undef,                                                 # pc47
121  undef,                                                 # pc48
122  [ qw(i c m h) ],                                       # pc49
123  [ qw(i c n h) ],                                       # pc50
124  [ qw(i c c n) ],                                       # pc51
125  undef,
126  undef,
127  undef,
128  undef,
129  undef,
130  undef,
131  undef,
132  undef,
133  undef,                                                 # pc60
134  undef,
135  undef,
136  undef,
137  undef,
138  undef,
139  undef,
140  undef,
141  undef,
142  undef,
143  undef,                                                 # pc70
144  undef,
145  undef,
146  [ qw(i d n n n n n n m m m c c h) ],   # pc73
147  undef,
148  undef,
149  undef,
150  undef,
151  undef,
152  undef,
153  undef,                                                 # pc80
154  undef,
155  undef,
156  undef,
157  [ qw(i c c c m) ],                             # pc84
158  [ qw(i c c c m) ],                             # pc85
159  undef,
160  undef,
161  undef,
162  undef,
163  [ qw(i c n) ],                                 # pc90
164 );
165
166 # use the entry in the check list to check the field list presented
167 # return OK if line NOT in check list (for now)
168 sub check
169 {
170         my $n = shift;
171         $n -= 10;
172         return 0 if $n < 0 || $n > @checklist; 
173         my $ref = $checklist[$n];
174         return 0 unless ref $ref;
175         
176         my $i;
177         for ($i = 1; $i < @$ref; $i++) {
178                 my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
179                 return 0 unless $act;
180                 next if $blank && $_[$i] =~ /^[ \*]$/;
181                 if ($act eq 'c') {
182                         return $i unless is_callsign($_[$i]);
183                 } elsif ($act eq 'i') {                 
184                         ;                                       # do nothing
185                 } elsif ($act eq 'm') {
186                         return $i unless is_pctext($_[$i]);
187                 } elsif ($act eq 'p') {
188                         return $i unless is_pcflag($_[$i]);
189                 } elsif ($act eq 'f') {
190                         return $i unless is_freq($_[$i]);
191                 } elsif ($act eq 'n') {
192                         return $i unless $_[$i] =~ /^[\d ]+$/;
193                 } elsif ($act eq 'h') {
194                         return $i unless $_[$i] =~ /^H\d\d?$/;
195                 } elsif ($act eq 'd') {
196                         return $i unless $_[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
197                 } elsif ($act eq 't') {
198                         return $i unless $_[$i] =~ /^[012]\d[012345]\dZ$/;
199                 } 
200         }
201         return 0;
202 }
203
204 sub init
205 {
206         do "$main::data/hop_table.pl" if -e "$main::data/hop_table.pl";
207         confess $@ if $@;
208
209         my $user = DXUser->get($main::mycall);
210         die "User $main::mycall not setup or disappeared RTFM" unless $user;
211         
212         $myprot_version += $main::version*100;
213         $main::me = DXProt->new($main::mycall, 0, $user); 
214         $main::me->{here} = 1;
215         $main::me->{state} = "indifferent";
216         $main::me->{sort} = 'S';    # S for spider
217         $main::me->{priv} = 9;
218         $main::me->{metric} = 0;
219         $main::me->{pingave} = 0;
220         $main::me->{registered} = 1;
221         $main::me->{version} = $main::version;
222         $main::me->{build} = $main::build;
223 }
224
225 #
226 # obtain a new connection this is derived from dxchannel
227 #
228
229 sub new 
230 {
231         my $self = DXChannel::alloc(@_);
232
233         # add this node to the table, the values get filled in later
234         my $pkg = shift;
235         my $call = shift;
236         $main::routeroot->add($call, '5000', Route::here(1)) if $call ne $main::mycall;
237
238         return $self;
239 }
240
241 # this is how a pc connection starts (for an incoming connection)
242 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
243 # all the crap that comes between).
244 sub start
245 {
246         my ($self, $line, $sort) = @_;
247         my $call = $self->{call};
248         my $user = $self->{user};
249
250         # log it
251         my $host = $self->{conn}->{peerhost};
252         $host ||= "AGW Port #$self->{conn}->{agwport}" if exists $self->{conn}->{agwport};
253         $host ||= "unknown";
254
255         Log('DXProt', "$call connected from $host");
256         
257         # remember type of connection
258         $self->{consort} = $line;
259         $self->{outbound} = $sort eq 'O';
260         my $priv = $user->priv;
261         $priv = $user->priv(1) unless $priv;
262         $self->{priv} = $priv;     # other clusters can always be 'normal' users
263         $self->{lang} = $user->lang || 'en';
264         $self->{isolate} = $user->{isolate};
265         $self->{consort} = $line;       # save the connection type
266         $self->{here} = 1;
267         $self->{width} = 80;
268
269         # sort out registration
270         $self->{registered} = 1;
271
272         # get the output filters
273         $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
274         $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
275         $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
276         $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
277         $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) unless $self->{isolate} ;
278
279
280         # get the INPUT filters (these only pertain to Clusters)
281         $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
282         $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
283         $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
284         $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
285         $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1) unless $self->{isolate};
286         
287         # set unbuffered and no echo
288         $self->send_now('B',"0");
289         $self->send_now('E',"0");
290         $self->conn->echo(0) if $self->conn->can('echo');
291         
292         # ping neighbour node stuff
293         my $ping = $user->pingint;
294         $ping = $pingint unless defined $ping;
295         $self->{pingint} = $ping;
296         $self->{nopings} = $user->nopings || $obscount;
297         $self->{pingtime} = [ ];
298         $self->{pingave} = 999;
299         $self->{metric} ||= 100;
300         $self->{lastping} = $main::systime;
301         
302         # send initialisation string
303         unless ($self->{outbound}) {
304                 $self->sendinit;
305         }
306         
307         $self->state('init');
308         $self->{pc50_t} = $main::systime;
309
310         # send info to all logged in thingies
311         $self->tell_login('loginn');
312
313         # run a script send the output to the debug file
314         my $script = new Script(lc $call) || new Script('node_default');
315         $script->run($self) if $script;
316 }
317
318 #
319 # send outgoing 'challenge'
320 #
321
322 sub sendinit
323 {
324         my $self = shift;
325         $self->send(pc18());
326 }
327
328 #
329 # This is the normal pcxx despatcher
330 #
331 sub normal
332 {
333         my ($self, $line) = @_;
334
335         if ($line =~ '^<\w+\s' && $main::do_xml) {
336                 DXXml::normal($self, $line);
337                 return;
338         }
339
340         my @field = split /\^/, $line;
341         return unless @field;
342         
343         pop @field if $field[-1] eq '~';
344         
345 #       print join(',', @field), "\n";
346                                                 
347         
348         # process PC frames, this will fail unless the frame starts PCnn
349         my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
350         unless (defined $pcno && $pcno >= 10 && $pcno <= 99) {
351                 dbg("PCPROT: unknown protocol") if isdbg('chanerr');
352                 return;
353         }
354
355         # check for and dump bad protocol messages
356         my $n = check($pcno, @field);
357         if ($n) {
358                 dbg("PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")") if isdbg('chanerr');
359                 return;
360         }
361
362         # modify the hop count here
363         if (my ($hops, $trail) = $line =~ /\^H(\d+)(\^?\~?)?$/) {
364                 $trail ||= '';
365                 $hops--;
366                 return if $hops < 0;
367                 $line =~ s/\^H(\d+)(\^?\~?)?$/sprintf('^H%d%s', $hops, $trail)/e;
368         }
369
370         # send it out for processing
371         my $origin = $self->{call};
372         no strict 'subs';
373         my $sub = "handle_$pcno";
374
375         if ($self->can($sub)) {
376                 $self->$sub($pcno, $line, $origin, @field);
377         } else {
378                 $self->handle_default($pcno, $line, $origin, @field);
379         }
380 }
381
382 #
383 # This is called from inside the main cluster processing loop and is used
384 # for despatching commands that are doing some long processing job
385 #
386 sub process
387 {
388         my $t = time;
389         my @dxchan = DXChannel::get_all();
390         my $dxchan;
391         my $pc50s;
392         
393         # send out a pc50 on EVERY channel all at once
394         if ($t >= $last_pc50 + $DXProt::pc50_interval) {
395                 $pc50s = pc50($main::me, scalar DXChannel::get_all_users);
396                 eph_dup($pc50s);
397                 $last_pc50 = $t;
398         }
399
400         foreach $dxchan (@dxchan) {
401                 next unless $dxchan->is_node;
402                 next if $dxchan->handle_xml;
403                 next if $dxchan == $main::me;
404
405                 # send the pc50
406                 $dxchan->send($pc50s) if $pc50s;
407                 
408                 # send a ping out on this channel
409                 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
410                         if ($dxchan->{nopings} <= 0) {
411                                 $dxchan->disconnect;
412                         } else {
413                                 DXXml::Ping::add($main::me, $dxchan->call);
414                                 $dxchan->{nopings} -= 1;
415                                 $dxchan->{lastping} = $t;
416                                 $dxchan->{lastping} += $dxchan->{pingint} / 2 unless @{$dxchan->{pingtime}};
417                         }
418                 }
419         }
420
421         Investigate::process();
422
423         # every ten seconds
424         if ($t - $last10 >= 10) {       
425                 # clean out ephemera 
426
427                 eph_clean();
428                 import_chat();
429                 
430
431                 $last10 = $t;
432         }
433         
434         if ($main::systime - 3600 > $last_hour) {
435                 $last_hour = $main::systime;
436         }
437 }
438
439 #
440 # finish up a pc context
441 #
442
443 #
444 # some active measures
445 #
446
447
448 sub send_dx_spot
449 {
450         my $self = shift;
451         my $line = shift;
452         my @dxchan = DXChannel::get_all();
453         my $dxchan;
454         
455         # send it if it isn't the except list and isn't isolated and still has a hop count
456         # taking into account filtering and so on
457         foreach $dxchan (@dxchan) {
458                 next if $dxchan == $main::me;
459                 next if $dxchan == $self && $self->is_node;
460                 $dxchan->dx_spot($line, $self->{isolate}, @_, $self->{call});
461         }
462 }
463
464 sub dx_spot
465 {
466         my $self = shift;
467         my $line = shift;
468         my $isolate = shift;
469         my ($filter, $hops);
470
471         if ($self->{spotsfilter}) {
472                 ($filter, $hops) = $self->{spotsfilter}->it(@_);
473                 return unless $filter;
474         }
475         send_prot_line($self, $filter, $hops, $isolate, $line);
476 }
477
478 sub send_prot_line
479 {
480         my ($self, $filter, $hops, $isolate, $line) = @_;
481         my $routeit;
482
483
484         if ($hops) {
485                 $routeit = $line;
486                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
487         } else {
488                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
489                 return unless $routeit;
490         }
491         if ($filter) {
492                 $self->send($routeit);
493         } else {
494                 $self->send($routeit) unless $self->{isolate} || $isolate;
495         }
496 }
497
498
499 sub send_wwv_spot
500 {
501         my $self = shift;
502         my $line = shift;
503         my @dxchan = DXChannel::get_all();
504         my $dxchan;
505         my @dxcc = ((Prefix::cty_data($_[6]))[0..2], (Prefix::cty_data($_[7]))[0..2]);
506
507         # send it if it isn't the except list and isn't isolated and still has a hop count
508         # taking into account filtering and so on
509         foreach $dxchan (@dxchan) {
510                 next if $dxchan == $main::me;
511                 next if $dxchan == $self && $self->is_node;
512                 my $routeit;
513                 my ($filter, $hops);
514
515                 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, @dxcc);
516         }
517 }
518
519 sub wwv
520 {
521         my $self = shift;
522         my $line = shift;
523         my $isolate = shift;
524         my ($filter, $hops);
525         
526         if ($self->{wwvfilter}) {
527                 ($filter, $hops) = $self->{wwvfilter}->it(@_[7..$#_]);
528                 return unless $filter;
529         }
530         send_prot_line($self, $filter, $hops, $isolate, $line)
531 }
532
533 sub send_wcy_spot
534 {
535         my $self = shift;
536         my $line = shift;
537         my @dxchan = DXChannel::get_all();
538         my $dxchan;
539         my @dxcc = ((Prefix::cty_data($_[10]))[0..2], (Prefix::cty_data($_[11]))[0..2]);
540         
541         # send it if it isn't the except list and isn't isolated and still has a hop count
542         # taking into account filtering and so on
543         foreach $dxchan (@dxchan) {
544                 next if $dxchan == $main::me;
545                 next if $dxchan == $self;
546
547                 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, @dxcc);
548         }
549 }
550
551 sub wcy
552 {
553         my $self = shift;
554         my $line = shift;
555         my $isolate = shift;
556         my ($filter, $hops);
557
558         if ($self->{wcyfilter}) {
559                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
560                 return unless $filter;
561         }
562         send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
563 }
564
565 # send an announce
566 sub send_announce
567 {
568         my $self = shift;
569         my $line = shift;
570         my @dxchan = DXChannel::get_all();
571         my $dxchan;
572         my $target;
573         my $to = 'To ';
574         my $text = unpad($_[2]);
575                                 
576         if ($_[3] eq '*') {     # sysops
577                 $target = "SYSOP";
578         } elsif ($_[3] gt ' ') { # speciality list handling
579                 my ($name) = split /\./, $_[3]; 
580                 $target = "$name"; # put the rest in later (if bothered) 
581         } 
582         
583         if ($_[5] eq '1') {
584                 $target = "WX"; 
585                 $to = '';
586         }
587         $target = "ALL" if !$target;
588
589
590         # obtain country codes etc 
591         my @a = Prefix::cty_data($_[0]);
592         my @b = Prefix::cty_data($_[4]);
593         if ($self->{inannfilter}) {
594                 my ($filter, $hops) = 
595                         $self->{inannfilter}->it(@_, $self->{call}, 
596                                                                          @a[0..2],
597                                                                          @b[0..2], $a[3], $b[3]);
598                 unless ($filter) {
599                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
600                         return;
601                 }
602         }
603
604         if (AnnTalk::dup($_[0], $_[1], $_[2])) {
605                 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
606                 return;
607         }
608
609         Log('ann', $target, $_[0], $text);
610
611         # send it if it isn't the except list and isn't isolated and still has a hop count
612         # taking into account filtering and so on
613         foreach $dxchan (@dxchan) {
614                 next if $dxchan == $main::me;
615                 next if $dxchan == $self && $self->is_node;
616                 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call},
617                                                   @a[0..2], @b[0..2]);
618         }
619 }
620
621 my $msgid = 0;
622
623 sub nextchatmsgid
624 {
625         $msgid++;
626         $msgid = 1 if $msgid > 999;
627         return $msgid;
628 }
629
630 # send a chat line
631 sub send_chat
632 {
633         my $self = shift;
634         my $line = shift;
635         my @dxchan = DXChannel::get_all();
636         my $dxchan;
637         my $target = $_[3];
638         my $text = unpad($_[2]);
639         my $ak1a_line;
640                                 
641         # munge the group and recast the line if required
642         if ($target =~ s/\.LST$//) {
643                 $ak1a_line = $line;
644         }
645         
646         # obtain country codes etc 
647         my @a = Prefix::cty_data($_[0]);
648         my @b = Prefix::cty_data($_[4]);
649         if ($self->{inannfilter}) {
650                 my ($filter, $hops) = 
651                         $self->{inannfilter}->it(@_, $self->{call}, 
652                                                                          @a[0..2],
653                                                                          @b[0..2], $a[3], $b[3]);
654                 unless ($filter) {
655                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
656                         return;
657                 }
658         }
659
660         if (AnnTalk::dup($_[0], $_[1], $_[2], $chatdupeage)) {
661                 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
662                 return;
663         }
664
665
666         Log('chat', $target, $_[0], $text);
667
668         # send it if it isn't the except list and isn't isolated and still has a hop count
669         # taking into account filtering and so on
670         foreach $dxchan (@dxchan) {
671                 my $is_ak1a = $dxchan->is_ak1a;
672                 
673                 if ($dxchan->is_node) {
674                         next if $dxchan == $main::me;
675                         next if $dxchan == $self;
676                         next unless $dxchan->is_spider || $is_ak1a;
677                         next if $target eq 'LOCAL';
678                         if (!$ak1a_line && $is_ak1a) {
679                                 $ak1a_line = DXProt::pc12($_[0], $text, $_[1], "$target.LST");
680                         }
681                 }
682                 
683                 $dxchan->chat($is_ak1a ? $ak1a_line : $line, $self->{isolate}, $target, $_[1], 
684                                           $text, @_, $self->{call}, @a[0..2], @b[0..2]);
685         }
686 }
687
688 sub announce
689 {
690         my $self = shift;
691         my $line = shift;
692         my $isolate = shift;
693         my $to = shift;
694         my $target = shift;
695         my $text = shift;
696         my ($filter, $hops);
697
698         if ($self->{annfilter}) {
699                 ($filter, $hops) = $self->{annfilter}->it(@_);
700                 return unless $filter;
701         }
702         send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
703 }
704
705 sub chat
706 {
707         goto &announce;
708 }
709
710
711 sub send_local_config
712 {
713         my $self = shift;
714
715         dbg('DXProt::send_local_config') if isdbg('trace');
716
717         # send our nodes
718         if ($self->{do_pc92}) { 
719                 $self->send_pc92_config;
720         } else {
721                 my $node;
722                 my @nodes;
723                 my @localnodes;
724                 my @remotenodes;
725
726                 if ($self->{isolate}) {
727                         @localnodes = ( $main::routeroot );
728                         $self->send_route($main::mycall, \&pc19, 1, $main::routeroot);
729                 } else {
730                         # create a list of all the nodes that are not connected to this connection
731                         # and are not themselves isolated, this to make sure that isolated nodes
732                         # don't appear outside of this node
733
734                         # send locally connected nodes
735                         my @dxchan = grep { $_->call ne $main::mycall && $_ != $self && !$_->{isolate} } DXChannel::get_all_nodes();
736                         @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
737                         $self->send_route($main::mycall, \&pc19, scalar(@localnodes)+1, $main::routeroot, @localnodes);
738
739                         my $node;
740                         my @rawintcalls = map { $_->nodes } @localnodes if @localnodes;
741                         my @intcalls;
742                         for $node (@rawintcalls) {
743                                 push @intcalls, $node unless grep $node eq $_, @intcalls; 
744                         }
745                         my $ref = Route::Node::get($self->{call});
746                         my @rnodes = $ref->nodes;
747                         for $node (@intcalls) {
748                                 push @remotenodes, Route::Node::get($node) unless grep $node eq $_, @rnodes, @remotenodes;
749                         }
750                         $self->send_route($main::mycall, \&pc19, scalar(@remotenodes), @remotenodes);
751                 }
752         
753                 # get all the users connected on the above nodes and send them out
754                 foreach $node ($main::routeroot, @localnodes, @remotenodes) {
755                         if ($node) {
756                                 my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
757                                 $self->send_route($main::mycall, \&pc16, 1, $node, @rout) if @rout && $self->user->wantsendpc16;
758                         } else {
759                                 dbg("sent a null value") if isdbg('chanerr');
760                         }
761                 }
762         }
763 }
764
765 sub send_pc92_config
766 {
767         my $self = shift;
768         my $node;
769
770         dbg('DXProt::send_pc92_config') if isdbg('trace');
771         
772         my @dxchan = grep { $_->call ne $main::mycall && $_ != $self && !$_->{isolate} } DXChannel::get_all();
773         my @localnodes = map { my $r = Route::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
774         $self->send_route_pc92($main::mycall, \&pc92c, scalar @localnodes, @localnodes);
775 }
776
777 #
778 # route a message down an appropriate interface for a callsign
779 #
780 # is called route(to, pcline);
781 #
782
783 sub route
784 {
785         my ($self, $call, $line) = @_;
786
787         if (ref $self && $call eq $self->{call}) {
788                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
789                 return;
790         }
791
792         # always send it down the local interface if available
793         my $dxchan = DXChannel::get($call);
794         if ($dxchan) {
795                 dbg("route: $call -> $dxchan->{call} direct" ) if isdbg('route');
796         } else {
797                 my $cl = Route::get($call);
798                 $dxchan = $cl->dxchan if $cl;
799                 if (ref $dxchan) {
800                         if (ref $self && $dxchan eq $self) {
801                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
802                                 return;
803                         }
804                         dbg("route: $call -> $dxchan->{call} using normal route" ) if isdbg('route');
805                 }
806         }
807
808         # try the backstop method
809         unless ($dxchan) {
810                 my $rcall = RouteDB::get($call);
811                 if ($rcall) {
812                         if ($self && $rcall eq $self->{call}) {
813                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
814                                 return;
815                         }
816                         $dxchan = DXChannel::get($rcall);
817                         dbg("route: $call -> $rcall using RouteDB" ) if isdbg('route') && $dxchan;
818                 }
819         }
820
821         if ($dxchan) {
822                 my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
823                 if ($routeit) {
824                         $dxchan->send($routeit) unless $dxchan == $main::me;
825                 }
826         } else {
827                 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
828         }
829 }
830
831 #
832 # obtain the hops from the list for this callsign and pc no 
833 #
834
835 sub get_hops
836 {
837         my $pcno = shift;
838         my $hops = $DXProt::hopcount{$pcno};
839         $hops = $DXProt::def_hopcount if !$hops;
840         return "H$hops";       
841 }
842
843
844 # adjust the hop count on a per node basis using the user loadable 
845 # hop table if available or else decrement an existing one
846 #
847
848 sub adjust_hops
849 {
850         my $self = shift;
851         my $s = shift;
852         my $call = $self->{call};
853         my $hops;
854         
855         if (($hops) = $s =~ /\^H(\d+)\^?~?$/o) {
856                 my ($pcno) = $s =~ /^PC(\d\d)/o;
857                 confess "$call called adjust_hops with '$s'" unless $pcno;
858                 my $ref = $nodehops{$call} if %nodehops;
859                 if ($ref) {
860                         my $newhops = $ref->{$pcno};
861                         return "" if defined $newhops && $newhops == 0;
862                         $newhops = $ref->{default} unless $newhops;
863                         return "" if defined $newhops && $newhops == 0;
864                         $newhops = $hops if !$newhops;
865                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops;
866                 }
867         }
868         return $s;
869 }
870
871
872 # load hop tables
873 #
874 sub load_hops
875 {
876         my $self = shift;
877         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
878         do "$main::data/hop_table.pl";
879         return $@ if $@;
880         return ();
881 }
882
883 sub process_rcmd
884 {
885         my ($self, $tonode, $fromnode, $user, $cmd) = @_;
886         if ($tonode eq $main::mycall) {
887                 my $ref = DXUser->get_current($fromnode);
888                 my $cref = Route::Node::get($fromnode);
889                 Log('rcmd', 'in', $ref->{priv}, $fromnode, $cmd);
890                 if ($cmd !~ /^\s*rcmd/i && $cref && $ref && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
891                         if ($ref->{priv}) {             # you have to have SOME privilege, the commands have further filtering
892                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
893                                 my $oldpriv = $self->{priv};
894                                 $self->{priv} = $ref->{priv}; # assume the user's privilege level
895                                 my @in = (DXCommandmode::run_cmd($self, $cmd));
896                                 $self->{priv} = $oldpriv;
897                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
898                                 delete $self->{remotecmd};
899                         } else {
900                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
901                         }
902                 } else {
903                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
904                 }
905         } else {
906                 my $ref = DXUser->get_current($tonode);
907                 if ($ref && $ref->is_clx) {
908                         $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
909                 } else {
910                         $self->route($tonode, pc34($fromnode, $tonode, $cmd));
911                 }
912         }
913 }
914
915 sub process_rcmd_reply
916 {
917         my ($self, $tonode, $fromnode, $user, $line) = @_;
918         if ($tonode eq $main::mycall) {
919                 my $s = $rcmds{$fromnode};
920                 if ($s) {
921                         my $dxchan = DXChannel::get($s->{call});
922                         my $ref = $user eq $tonode ? $dxchan : (DXChannel::get($user) || $dxchan);
923                         $ref->send($line) if $ref;
924                         delete $rcmds{$fromnode} if !$dxchan;
925                 } else {
926                         # send unsolicited ones to the sysop
927                         my $dxchan = DXChannel::get($main::myalias);
928                         $dxchan->send($line) if $dxchan;
929                 }
930         } else {
931                 my $ref = DXUser->get_current($tonode);
932                 if ($ref && $ref->is_clx) {
933                         $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
934                 } else {
935                         $self->route($tonode, pc35($fromnode, $tonode, $line));
936                 }
937         }
938 }
939
940 sub send_rcmd_reply
941 {
942         my $self = shift;
943         my $tonode = shift;
944         my $fromnode = shift;
945         my $user = shift;
946         while (@_) {
947                 my $line = shift;
948                 $line =~ s/\s*$//;
949                 Log('rcmd', 'out', $fromnode, $line);
950                 if ($self->is_clx) {
951                         $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
952                 } else {
953                         $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
954                 }
955         }
956 }
957
958 # add a rcmd request to the rcmd queues
959 sub addrcmd
960 {
961         my ($self, $to, $cmd) = @_;
962
963         my $r = {};
964         $r->{call} = $self->{call};
965         $r->{t} = $main::systime;
966         $r->{cmd} = $cmd;
967         $rcmds{$to} = $r;
968         
969         my $ref = Route::Node::get($to);
970         my $dxchan = $ref->dxchan;
971         if ($dxchan && $dxchan->is_clx) {
972                 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
973         } else {
974                 route(undef, $to, pc34($main::mycall, $to, $cmd));
975         }
976 }
977
978 sub disconnect
979 {
980         my $self = shift;
981         my $pc39flag = shift;
982         my $call = $self->call;
983
984         return if $self->{disconnecting}++;
985         
986         unless ($pc39flag && $pc39flag == 1) {
987                 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
988         }
989
990         # get rid of any PC16/17/19
991         eph_del_regex("^PC1[679]*$call");
992
993         # do routing stuff, remove me from routing table
994         my $node = Route::Node::get($call);
995         my @rout;
996         if ($node) {
997                 @rout = $node->del($main::routeroot);
998                 
999                 # and all my ephemera as well
1000                 for (@rout) {
1001                         my $c = $_->call;
1002                         eph_del_regex("^PC1[679].*$c");
1003                 }
1004         }
1005
1006         RouteDB::delete_interface($call);
1007         
1008         # unbusy and stop and outgoing mail
1009         my $mref = DXMsg::get_busy($call);
1010         $mref->stop_msg($call) if $mref;
1011         
1012         # broadcast to all other nodes that all the nodes connected to via me are gone
1013         unless ($pc39flag && $pc39flag == 2)  {
1014                 $self->route_pc21($main::mycall, undef, @rout) if @rout;
1015                 $self->route_pc92d($main::mycall, undef, $node);
1016         }
1017
1018         # remove outstanding pings
1019         delete $pings{$call};
1020         
1021         # I was the last node visited
1022     $self->user->node($main::mycall);
1023
1024         # send info to all logged in thingies
1025         $self->tell_login('logoutn');
1026
1027         Log('DXProt', $call . " Disconnected");
1028
1029         $self->SUPER::disconnect;
1030 }
1031
1032
1033
1034 # send a talk message to this thingy
1035 #
1036 sub talk
1037 {
1038         my ($self, $from, $to, $via, $line, $origin) = @_;
1039         
1040         $line =~ s/\^/\\5E/g;                   # remove any ^ characters
1041         $self->send(DXProt::pc10($from, $to, $via, $line, $origin));
1042         Log('talk', $to, $from, $via?$via:$self->call, $line) unless $origin && $origin ne $main::mycall;
1043 }
1044
1045 # send it if it isn't the except list and isn't isolated and still has a hop count
1046 # taking into account filtering and so on
1047
1048 sub send_route
1049 {
1050         my $self = shift;
1051         my $origin = shift;
1052         my $generate = shift;
1053         my $no = shift;     # the no of things to filter on 
1054         my $routeit;
1055         my ($filter, $hops);
1056         my @rin;
1057         
1058         for (; @_ && $no; $no--) {
1059                 my $r = shift;
1060                 
1061                 if (!$self->{isolate} && $self->{routefilter}) {
1062                         $filter = undef;
1063                         if ($r) {
1064                                 ($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});
1065                                 if ($filter) {
1066                                         push @rin, $r;
1067                                 } else {
1068                                         dbg("DXPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('chanerr');
1069                                 }
1070                         } else {
1071                                 dbg("was sent a null value") if isdbg('chanerr');
1072                         }
1073                 } else {
1074                         push @rin, $r unless $self->{isolate} && $r->call ne $main::mycall;
1075                 }
1076         }
1077         if (@rin) {
1078                 foreach my $line (&$generate(@rin, @_)) {
1079                         if ($hops) {
1080                                 $routeit = $line;
1081                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1082                         } else {
1083                                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1084                                 next unless $routeit;
1085                         }
1086                         
1087                         $self->send($routeit);
1088                 }
1089         }
1090 }
1091
1092 sub broadcast_route
1093 {
1094         my $self = shift;
1095         my $origin = shift;
1096         my $generate = shift;
1097         my $line = shift;
1098         my @dxchan = DXChannel::get_all_nodes();
1099         my $dxchan;
1100
1101         if ($line) {
1102                 $line =~ /\^H(\d+)\^?\~?$/;
1103                 return unless $1 > 0;
1104         }
1105         unless ($self->{isolate}) {
1106                 foreach $dxchan (@dxchan) {
1107                         next if $dxchan == $self;
1108                         next if $dxchan == $main::me;
1109                         next unless $dxchan->isa('DXProt');
1110                         next if $dxchan->{do_pc92};
1111                         next if ($generate == \&pc16 || $generate==\&pc17) && !$dxchan->user->wantsendpc16;
1112  
1113                         $dxchan->send_route($origin, $generate, @_);
1114                 }
1115         }
1116 }
1117
1118 # this is only used for next door nodes on init
1119 sub send_route_pc92
1120 {
1121         my $self = shift;
1122
1123         return unless $self->{do_pc92};
1124         
1125         my $origin = shift;
1126         my $generate = shift;
1127         my $no = shift;     # the no of things to filter on 
1128         my $line;
1129
1130         $line = &$generate(@_);
1131         $self->send($line);
1132 }
1133
1134 sub broadcast_route_pc9x
1135 {
1136         my $self = shift;
1137         my $origin = shift;
1138         my $generate = shift;
1139         my $line = shift;
1140         my $no = shift;
1141         my @dxchan = DXChannel::get_all_nodes();
1142         my $dxchan;
1143
1144         if ($origin eq $main::mycall) {
1145                 $line = &$generate(@_);
1146         } 
1147
1148         $line =~ /\^H(\d+)\^$/;
1149         unless ($1 > 0 && $self->{isolate}) {
1150                 foreach $dxchan (@dxchan) {
1151                         next if $dxchan == $self;
1152                         next if $dxchan == $main::me;
1153                         next unless $dxchan->{do_pc92};
1154                         next unless $dxchan->isa('DXProt');
1155
1156                         $dxchan->send($line);
1157                 }
1158         }
1159 }
1160
1161 sub route_pc16
1162 {
1163         my $self = shift;
1164         return unless $self->user->wantpc16;
1165         my $origin = shift;
1166         my $line = shift;
1167         broadcast_route($self, $origin, \&pc16, $line, 1, @_);
1168 }
1169
1170 sub route_pc17
1171 {
1172         my $self = shift;
1173         return unless $self->user->wantpc16;
1174         my $origin = shift;
1175         my $line = shift;
1176         broadcast_route($self, $origin, \&pc17, $line, 1, @_);
1177 }
1178
1179 sub route_pc19
1180 {
1181         my $self = shift;
1182         my $origin = shift;
1183         my $line = shift;
1184         broadcast_route($self, $origin, \&pc19, $line, scalar @_, @_);
1185 }
1186
1187 sub route_pc21
1188 {
1189         my $self = shift;
1190         my $origin = shift;
1191         my $line = shift;
1192         broadcast_route($self, $origin, \&pc21, $line, scalar @_, @_);
1193 }
1194
1195 sub route_pc24
1196 {
1197         my $self = shift;
1198         my $origin = shift;
1199         my $line = shift;
1200         broadcast_route($self, $origin, \&pc24, $line, 1, @_);
1201 }
1202
1203 sub route_pc41
1204 {
1205         my $self = shift;
1206         my $origin = shift;
1207         my $line = shift;
1208         broadcast_route($self, $origin, \&pc41, $line, 1, @_);
1209 }
1210
1211 sub route_pc50
1212 {
1213         my $self = shift;
1214         my $origin = shift;
1215         my $line = shift;
1216         broadcast_route($self, $origin, \&pc50, $line, 1, @_);
1217 }
1218
1219 sub route_pc92c
1220 {
1221         my $self = shift;
1222         my $origin = shift;
1223         my $line = shift;
1224         broadcast_route_pc9x($self, $origin, \&pc92c, $line, 1, @_);
1225 }
1226
1227 sub route_pc92a
1228 {
1229         my $self = shift;
1230         my $origin = shift;
1231         my $line = shift;
1232         broadcast_route_pc9x($self, $origin, \&pc92a, $line, 1, @_);
1233 }
1234
1235 sub route_pc92d
1236 {
1237         my $self = shift;
1238         my $origin = shift;
1239         my $line = shift;
1240         broadcast_route_pc9x($self, $origin, \&pc92d, $line, 1, @_);
1241 }
1242
1243 sub in_filter_route
1244 {
1245         my $self = shift;
1246         my $r = shift;
1247         my ($filter, $hops) = (1, 1);
1248         
1249         if ($self->{inroutefilter}) {
1250                 ($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);
1251                 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
1252         }
1253         return $filter;
1254 }
1255
1256 sub eph_dup
1257 {
1258         my $s = shift;
1259         my $t = shift || $eph_restime;
1260         my $r;
1261
1262         # chop the end off
1263         $s =~ s/\^H\d\d?\^?\~?$//;
1264         $r = 1 if exists $eph{$s};    # pump up the dup if it keeps circulating
1265         $eph{$s} = $main::systime + $t;
1266         dbg("PCPROT: emphemeral duplicate") if $r && isdbg('chanerr'); 
1267         return $r;
1268 }
1269
1270 sub eph_del_regex
1271 {
1272         my $regex = shift;
1273         my ($key, $val);
1274         while (($key, $val) = each %eph) {
1275                 if ($key =~ m{$regex}) {
1276                         delete $eph{$key};
1277                 }
1278         }
1279 }
1280
1281 sub eph_clean
1282 {
1283         my ($key, $val);
1284         
1285         while (($key, $val) = each %eph) {
1286                 if ($main::systime >= $val) {
1287                         delete $eph{$key};
1288                 }
1289         }
1290 }
1291
1292 sub eph_list
1293 {
1294         my ($key, $val);
1295         my @out;
1296
1297         while (($key, $val) = each %eph) {
1298                 push @out, $key, $val;
1299         }
1300         return @out;
1301 }
1302
1303 sub run_cmd
1304 {
1305         goto &DXCommandmode::run_cmd;
1306 }
1307
1308
1309 # import any msgs in the chat directory
1310 # the messages are sent to the chat group which forms the
1311 # the first part of the name (eg: solar.1243.txt would be
1312 # sent to chat group SOLAR)
1313
1314 # Each message found is sent: one non-blank line to one chat
1315 # message. So 4 lines = 4 chat messages.
1316
1317 # The special name LOCAL is for local users ANN
1318 # The special name ALL is for ANN/FULL
1319 # The special name SYSOP is for ANN/SYSOP
1320 #
1321 sub import_chat
1322 {
1323         # are there any to do in this directory?
1324         return unless -d $chatimportfn;
1325         unless (opendir(DIR, $chatimportfn)) {
1326                 dbg("can\'t open $chatimportfn $!") if isdbg('msg');
1327                 Log('msg', "can\'t open $chatimportfn $!");
1328                 return;
1329         } 
1330
1331         my @names = readdir(DIR);
1332         closedir(DIR);
1333         my $name;
1334         foreach $name (@names) {
1335                 next if $name =~ /^\./;
1336                 my $splitit = $name =~ /^split/;
1337                 my $fn = "$chatimportfn/$name";
1338                 next unless -f $fn;
1339                 unless (open(MSG, $fn)) {
1340                         dbg("can\'t open import file $fn $!") if isdbg('msg');
1341                         Log('msg', "can\'t open import file $fn $!");
1342                         unlink($fn);
1343                         next;
1344                 }
1345                 my @msg = map { s/\r?\n$//; $_ } <MSG>;
1346                 close(MSG);
1347                 unlink($fn);
1348
1349                 my @cat = split /\./, $name;
1350                 my $target = uc $cat[0];
1351
1352                 foreach my $text (@msg) {
1353                         next unless $text && $text !~ /^\s*#/;
1354                         if ($target eq 'ALL' || $target eq 'LOCAL' || $target eq 'SYSOP') {
1355                                 my $sysopflag = $target eq 'SYSOP' ? '*' : ' ';
1356                                 if ($target ne 'LOCAL') {
1357                                         send_announce($main::me, pc12($main::mycall, $text, '*', $sysopflag), $main::mycall, '*', $text, $sysopflag, $main::mycall, '0');
1358                                 } else {
1359                                         Log('ann', 'LOCAL', $main::mycall, $text);
1360                                         DXChannel::broadcast_list("To LOCAL de ${main::mycall}: $text\a", 'ann', undef, DXCommandmode->get_all());
1361                                 }
1362                         } else {
1363                                 my $msgid = nextchatmsgid();
1364                                 $text = "#$msgid $text";
1365                                 send_chat($main::me, pc12($main::mycall, $text, '*', $target), $main::mycall, '*', $text, $target, $main::mycall, '0');
1366                         }
1367                 }
1368         }
1369 }
1370
1371 1;
1372 __END__