3 # This module impliments the protocal mode for a dx cluster
5 # Copyright (c) 1998 Dirk Koopman G1TLH
37 use Time::HiRes qw(gettimeofday tv_interval);
38 use Mojo::IOLoop::Subprocess;
43 use vars qw($pc11_max_age $pc23_max_age $last_pc50 $eph_restime $eph_info_restime $eph_pc34_restime
44 $last_hour $last10 %eph %pings %rcmds $ann_to_talk
45 $pingint $obscount %pc19list $chatdupeage $chatimportfn
46 $pc19_version $myprot_version
47 %nodehops $baddx $badspotter $badnode $censorpc
48 $allowzero $decode_dk0wcy $send_opernam @checklist
49 $eph_pc15_restime $pc92_update_period $pc92_obs_timeout
50 %pc92_find $pc92_find_timeout $pc92_short_update_period
51 $next_pc92_obs_timeout $pc92_slug_changes $last_pc92_slug
52 $pc92_extnode_update_period $pc50_interval
53 $pc92_keepalive_period
56 $pc11_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc11
57 $pc23_max_age = 1*3600; # the maximum age for an incoming 'real-time' pc23
59 $last_hour = time; # last time I did an hourly periodic update
60 %rcmds = (); # outstanding rcmd requests outbound
61 %nodehops = (); # node specific hop control
62 %pc19list = (); # list of outstanding PC19s that haven't had PC16s on them
64 $censorpc = 1; # Do a BadWords::check on text fields and reject things
65 # loads of 'bad things'
66 $baddx = new DXHash "baddx";
67 $badspotter = new DXHash "badspotter";
68 $badnode = new DXHash "badnode";
69 $last10 = $last_pc50 = time;
72 $eph_info_restime = 18*60*60;
73 $eph_pc15_restime = 6*60;
74 $eph_pc34_restime = 30;
77 $chatdupeage = 20 * 60;
78 $chatimportfn = "$main::root/chat_import";
79 $pc19_version = 5455; # the visible version no for outgoing PC19s generated from pc59
80 $pc92_update_period = 4*60*60; # the period between outgoing PC92 C updates
81 $pc92_short_update_period = 15*60; # shorten the update period after a connection or start up
82 $pc92_extnode_update_period = 1*60*60; # the update period for external nodes
83 $pc92_keepalive_period = 1*60*60; # frequency of PC92 K (keepalive) records
84 %pc92_find = (); # outstanding pc92 find operations
85 $pc92_find_timeout = 30; # maximum time to wait for a reply
90 [ qw(i c c m bp bc c) ], # pc10
91 [ qw(i f m d t m c c h) ], # pc11
92 [ qw(i c bm m bm bm p h) ], # pc12
96 undef , # pc16 has to be validated manually
97 [ qw(i c c h) ], # pc17
99 undef , # pc19 has to be validated manually
100 undef , # pc20 no validation
101 [ qw(i c m h) ], # pc21
102 undef , # pc22 no validation
103 [ qw(i d n n n n m c c h) ], # pc23
104 [ qw(i c p h) ], # pc24
105 [ qw(i c c n n) ], # pc25
106 [ qw(i f m d t m c c bc) ], # pc26
107 [ qw(i d n n n n m c c bc) ], # pc27
108 [ qw(i c c m c d t p m bp n p bp bc) ], # pc28
109 [ qw(i c c n m) ], # pc29
110 [ qw(i c c n) ], # pc30
111 [ qw(i c c n) ], # pc31
112 [ qw(i c c n) ], # pc32
113 [ qw(i c c n) ], # pc33
114 [ qw(i c c m) ], # pc34
115 [ qw(i c c m) ], # pc35
116 [ qw(i c c m) ], # pc36
117 [ qw(i c c n m) ], # pc37
118 undef, # pc38 not interested
119 [ qw(i c m) ], # pc39
120 [ qw(i c c m p n) ], # pc40
121 [ qw(i c n m h) ], # pc41
122 [ qw(i c c n) ], # pc42
123 undef, # pc43 don't handle it
124 [ qw(i c c n m m c) ], # pc44
125 [ qw(i c c n m) ], # pc45
126 [ qw(i c c n) ], # pc46
129 [ qw(i c m h) ], # pc49
130 [ qw(i c n h) ], # pc50
131 [ qw(i c c n) ], # pc51
141 [ qw(i f m d t m c c a h) ], # pc61
153 [ qw(i d n n n n n n m m m c c h) ], # pc73
164 [ qw(i c c c m) ], # pc84
165 [ qw(i c c c m) ], # pc85
172 [ qw(i c f l)], # pc92
173 [ qw(i c f *m c *c m)], # pc93
176 # use the entry in the check list to check the field list presented
177 # return OK if line NOT in check list (for now)
184 return 0 if $n < 0 || $n > @checklist;
185 my $ref = $checklist[$n];
186 return 0 unless ref $ref;
189 for ($i = 1; $i < @$ref; $i++) {
190 my ($blank, $act) = $$ref[$i] =~ /^(b?)(\w)$/;
191 return 0 unless $act;
192 next if $blank eq 'b' && $pc->[$i] =~ /^[ \*]$/;
193 next if $blank eq '*' && $pc->[$i] =~ /^\*$/;
195 return $i unless is_callsign($pc->[$i]);
196 } elsif ($act eq 'i') {
198 } elsif ($act eq 'm') {
199 return $i unless is_pctext($pc->[$i]);
200 } elsif ($act eq 'p') {
201 return $i unless is_pcflag($pc->[$i]);
202 } elsif ($act eq 'f') {
203 return $i unless is_freq($pc->[$i]);
204 } elsif ($act eq 'n') {
205 return $i unless $pc->[$i] =~ /^[\d ]+$/;
206 } elsif ($act eq 'h') {
207 return $i unless $pc->[$i] =~ /^H\d\d?$/;
208 } elsif ($act eq 'd') {
209 return $i unless $pc->[$i] =~ /^\s*\d+-\w\w\w-[12][90]\d\d$/;
210 } elsif ($act eq 't') {
211 return $i unless $pc->[$i] =~ /^[012]\d[012345]\dZ$/;
212 } elsif ($act eq 'l') {
213 return $i unless $pc->[$i] =~ /^[A-Z]$/;
214 } elsif ($act eq 'a') {
215 return $i unless is_ipaddr($pc->[$i]);
224 my $period = shift || ($self->{do_pc9x} ? $pc92_update_period : $pc92_extnode_update_period);
225 $self->{next_pc92_update} = $main::systime + $period - int rand($period / 4);
226 dbg("ROUTE: update_pc92_next: $self->{call} " . atime($self->{next_pc92_update})) if isdbg('obscount');
229 sub update_pc92_keepalive
232 my $period = shift || $pc92_keepalive_period;
233 $self->{next_pc92_keepalive} = $main::systime + $period - int rand($period / 4);
234 dbg("ROUTE: update_pc92_keepalive: $self->{call} " . atime($self->{next_pc92_keepalive})) if isdbg('obscount');
239 my $fn = localdata("hop_table.pl");
243 my $user = DXUser::get($main::mycall);
244 die "User $main::mycall not setup or disappeared RTFM" unless $user;
246 $myprot_version += $main::version*100;
247 $main::me = DXProt->new($main::mycall, 0, $user);
248 $main::me->{here} = 1;
249 $main::me->{state} = "indifferent";
250 $main::me->{sort} = 'S'; # S for spider
251 $main::me->{priv} = 9;
252 $main::me->{metric} = 0;
253 $main::me->{pingave} = 0;
254 $main::me->{registered} = 1;
255 $main::me->{version} = $main::version;
256 $main::me->{build} = $main::build;
257 $main::me->{do_pc9x} = 1;
258 $main::me->{hostname} = $main::clusteraddr;
259 $main::me->update_pc92_next($pc92_short_update_period);
260 $main::me->update_pc92_keepalive;
264 # obtain a new connection this is derived from dxchannel
269 my $self = DXChannel::alloc(@_);
271 # add this node to the table, the values get filled in later
275 # if we have an entry already, then send a PC21 to all connect
276 # old style connections, because we are about to get the real deal
277 if (my $ref = Route::Node::get($call)) {
278 dbg("ROUTE: $call is already in the routing table, deleting") if isdbg('route');
279 my @rout = $ref->delete;
280 $self->route_pc21($main::mycall, undef, @rout) if @rout;
282 $main::routeroot->add($call, '5000', Route::here(1), $self->{conn}->peerhost) if $call ne $main::mycall;
287 # this is how a pc connection starts (for an incoming connection)
288 # issue a PC38 followed by a PC18, then wait for a PC20 (remembering
289 # all the crap that comes between).
292 my ($self, $line, $sort) = @_;
293 my $call = $self->{call};
294 my $user = $self->{user};
297 my $host = $self->{conn}->peerhost;
298 $host ||= "AGW Port #$self->{conn}->{agwport}" if exists $self->{conn}->{agwport};
300 $self->{hostname} = $host if is_ipaddr($host);
302 Log('DXProt', "$call connected from $host");
304 # remember type of connection
305 $self->{consort} = $line;
306 $self->{outbound} = $sort eq 'O';
307 my $priv = $user->priv;
308 $priv = $user->priv(1) unless defined $priv;
309 $self->{priv} = $priv; # other clusters can always be 'normal' users
310 $self->{lang} = $user->lang || 'en';
311 $self->{isolate} = $user->{isolate};
312 $self->{consort} = $line; # save the connection type
316 # sort out registration
317 $self->{registered} = 1;
319 # get the output filters
320 $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
321 $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
322 $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
323 $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
324 $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) unless $self->{isolate};
325 $self->{pc92filter} = Filter::read_in('pc92', $call, 0) || Filter::read_in('pc92', 'node_default', 0) unless $self->{isolate} ;
328 # get the INPUT filters (these only pertain to Clusters)
329 $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
330 $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
331 $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
332 $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
333 $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1) unless $self->{isolate};
334 $self->{inpc92filter} = Filter::read_in('pc92', $call, 0) || Filter::read_in('pc92', 'node_default', 0) unless $self->{isolate} ;
337 # set unbuffered and no echo
338 $self->send_now('B',"0");
339 $self->send_now('E',"0");
340 $self->conn->echo(0) if $self->conn->can('echo');
342 # ping neighbour node stuff
343 my $ping = $user->pingint;
344 $ping = $pingint unless defined $ping;
345 $self->{pingint} = $ping;
346 $self->{nopings} = $user->nopings || $obscount;
347 $self->{pingtime} = [ ];
348 $self->{pingave} = 999;
349 $self->{metric} ||= 100;
350 $self->{lastping} = $main::systime;
352 # send initialisation string
353 unless ($self->{outbound}) {
357 $self->state('init');
358 $self->{pc50_t} = $main::systime;
360 # send info to all logged in thingies
361 $self->tell_login('loginn');
363 # run a script send the output to the debug file
364 my $script = new Script(lc $call) || new Script('node_default');
365 $script->run($self) if $script;
367 # set up a config broadcast "quite soon" to converge tables quicker
368 $main::me->update_pc92_next($pc92_short_update_period);
369 $self->update_pc92_next($pc92_short_update_period);
371 # set next keepalive time
372 $self->update_pc92_keepalive;
376 # send outgoing 'challenge'
382 $self->send(pc18(($self->{isolate} || !$self->user->wantpc9x) ? "" : " pc9x"));
386 # This is the normal pcxx despatcher
390 my ($self, $line) = @_;
392 if ($line =~ '^<\w+\s' && $main::do_xml) {
393 DXXml::normal($self, $line);
397 my @field = split /\^/, $line;
398 return unless @field;
400 pop @field if $field[-1] eq '~';
402 # print join(',', @field), "\n";
405 # process PC frames, this will fail unless the frame starts PCnn
406 my ($pcno) = $field[0] =~ /^PC(\d\d)/; # just get the number
407 unless (defined $pcno && $pcno >= 10 && $pcno <= 99) {
408 dbg("PCPROT: unknown protocol") if isdbg('chanerr');
412 # check for and dump bad protocol messages
413 my $n = check($pcno, \@field);
415 dbg("PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")") if isdbg('chanerr');
419 # modify the hop count here
420 if ($self != $main::me) {
421 if (my ($hops, $trail) = $line =~ /\^H(\d+)(\^?\~?)?$/) {
425 $line =~ s/\^H(\d+)(\^?\~?)?$/sprintf('^H%d%s', $hops, $trail)/e;
426 $field[-1] = "H$hops";
430 if (defined &Local::pcprot) {
432 eval { $r = Local::pcprot($self, $pcno, $line, @field); };
433 return if $r; # i.e don't process it
436 # send it out for processing
437 my $origin = $self->{call};
439 my $sub = "handle_$pcno";
441 if ($self->can($sub)) {
442 $self->$sub($pcno, $line, $origin, \@field);
444 $self->handle_default($pcno, $line, $origin, \@field);
449 # This is called from inside the main cluster processing loop and is used
450 # for despatching commands that are doing some long processing job
455 my @dxchan = DXChannel::get_all();
460 if ($t - $last10 >= 10) {
468 # send out a pc50 on EVERY channel all at once
469 if ($t >= $last_pc50 + $pc50_interval) {
470 $pc50s = pc50($main::me, scalar DXChannel::get_all_users);
475 foreach $dxchan (@dxchan) {
476 next unless $dxchan->is_node;
477 next if $dxchan == $main::me;
480 $dxchan->send($pc50s) if !$dxchan->{do_pc9x} && $pc50s;
482 # send a ping out on this channel
483 if ($dxchan->{pingint} && $t >= $dxchan->{pingint} + $dxchan->{lastping}) {
484 if ($dxchan->{nopings} <= 0) {
485 dbg("ROUTE: $dxchan->{call} disconnected on ping obscount") if isdbg('obscount');
488 DXXml::Ping::add($main::me, $dxchan->call);
489 $dxchan->{nopings} -= 1;
490 $dxchan->{lastping} = $t;
491 $dxchan->{lastping} += $dxchan->{pingint} / 2 unless @{$dxchan->{pingtime}};
492 dbg("ROUTE: $dxchan->{call} ping obscount = $dxchan->{nopings}") if isdbg('obscount');
499 # send out config broadcasts
500 foreach $dxchan (@dxchan) {
501 next unless $dxchan->is_node;
503 # send out a PC92 config record if required for me and
504 # all my non pc9x dependent nodes. But for dependent nodes we only do
505 # this if we have not seen any from anyone else for at least half
506 # of one update period. This should stop quite a bit of excess C
507 # records. Someone will win, it does not really matter who, because
508 # we always believe "us".
509 if ($main::systime >= $dxchan->{next_pc92_update}) {
510 if ($dxchan == $main::me || !$dxchan->{do_pc9x}) {
511 dbg("ROUTE: pc92 broadcast candidate: $dxchan->{call}") if isdbg('obscount');
512 my $ref = Route::Node::get($dxchan->{call});
513 if ($dxchan == $main::me || ($ref && ($ref->measure_pc9x_t($main::systime-$main::systime_daystart)) >= $pc92_extnode_update_period/2)) {
514 $dxchan->broadcast_pc92_update($dxchan->{call});
516 $dxchan->update_pc92_next;
519 $dxchan->update_pc92_next; # this won't actually do anything, it's just to be tidy
524 # do the keepalive for me, if required
525 if ($main::systime >= $main::me->{next_pc92_keepalive}) {
526 time_out_pc92_routes();
527 $main::me->broadcast_pc92_keepalive($main::mycall);
530 if ($pc92_slug_changes && $main::systime >= $last_pc92_slug + $pc92_slug_changes) {
531 my ($add, $del) = gen_pc92_changes();
532 $main::me->route_pc92d($main::mycall, undef, $main::routeroot, @$del) if @$del;
533 $main::me->route_pc92a($main::mycall, undef, $main::routeroot, @$add) if @$add;
534 clear_pc92_changes();
538 if ($main::systime - 3600 > $last_hour) {
539 $last_hour = $main::systime;
544 # finish up a pc context
548 # some active measures
556 my @dxchan = DXChannel::get_all();
560 # send it if it isn't the except list and isn't isolated and still has a hop count
561 # taking into account filtering and so on
562 foreach $dxchan (@dxchan) {
563 next if $dxchan == $main::me;
564 next if $dxchan == $self && $self->is_node;
565 next if $dxchan->is_rbn;
566 if ($line =~ /PC61/ && !($dxchan->is_spider || $dxchan->is_user)) {
568 my @f = split /\^/, $line;
569 $pc11 = join '^', 'PC11', @f[1..7,9];
571 $dxchan->dx_spot($pc11, $self->{isolate}, @_, $self->{call});
573 $dxchan->dx_spot($line, $self->{isolate}, @_, $self->{call});
585 if ($self->{spotsfilter}) {
586 ($filter, $hops) = $self->{spotsfilter}->it(@_);
587 return unless $filter;
589 send_prot_line($self, $filter, $hops, $isolate, $line);
594 my ($self, $filter, $hops, $isolate, $line) = @_;
600 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
602 $routeit = adjust_hops($self, $line); # adjust its hop count by node name
603 return unless $routeit;
606 $self->send($routeit);
608 $self->send($routeit) unless $self->{isolate} || $isolate;
617 my @dxchan = DXChannel::get_all();
619 my @dxcc = ((Prefix::cty_data($_[6]))[0..2], (Prefix::cty_data($_[7]))[0..2]);
621 # send it if it isn't the except list and isn't isolated and still has a hop count
622 # taking into account filtering and so on
623 foreach $dxchan (@dxchan) {
624 next if $dxchan == $main::me;
625 next if $dxchan == $self && $self->is_node;
626 next if $dxchan->is_rbn;
630 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, @dxcc);
641 if ($self->{wwvfilter}) {
642 ($filter, $hops) = $self->{wwvfilter}->it(@_[7..$#_]);
643 return unless $filter;
645 send_prot_line($self, $filter, $hops, $isolate, $line)
652 my @dxchan = DXChannel::get_all();
654 my @dxcc = ((Prefix::cty_data($_[10]))[0..2], (Prefix::cty_data($_[11]))[0..2]);
656 # send it if it isn't the except list and isn't isolated and still has a hop count
657 # taking into account filtering and so on
658 foreach $dxchan (@dxchan) {
659 next if $dxchan == $main::me;
660 next if $dxchan == $self;
661 next if $dxchan->is_rbn;
663 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, @dxcc);
674 if ($self->{wcyfilter}) {
675 ($filter, $hops) = $self->{wcyfilter}->it(@_);
676 return unless $filter;
678 send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
685 my $from_pc9x = shift;
687 my @dxchan = DXChannel::get_all();
691 my $text = unpad($_[2]);
694 if ($_[3] eq '*') { # sysops
696 } elsif ($_[3] gt ' ') { # speciality list handling
697 my ($name) = split /\./, $_[3];
698 $target = "$name"; # put the rest in later (if bothered)
705 $target = "ALL" if !$target;
708 # obtain country codes etc
709 my @a = Prefix::cty_data($from);
710 my @b = Prefix::cty_data($_[4]);
711 if ($self->{inannfilter}) {
712 my ($filter, $hops) =
713 $self->{inannfilter}->it(@_, $self->{call},
715 @b[0..2], $a[3], $b[3]);
717 dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
722 # the sysop ('*') thing is an attempt to minimise the damage caused by non-updated PC93 generators
723 if (AnnTalk::dup($from, $target, $_[2]) || ($_[3] eq '*' && AnnTalk::dup($from, 'ALL', $_[2]))) {
724 my $dxchan = DXChannel::get($from);
725 if ($self == $main::me && $dxchan && $dxchan->is_user) {
726 if ($dxchan->priv < 5) {
727 $dxchan->send($dxchan->msg('dup'));
731 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
736 Log('ann', $target, $from, $text);
738 # send it if it isn't the except list and isn't isolated and still has a hop count
739 # taking into account filtering and so on
740 foreach $dxchan (@dxchan) {
741 next if $dxchan == $main::me;
742 next if $dxchan == $self && $self->is_node;
743 next if $from_pc9x && $dxchan->{do_pc9x};
744 next if $target eq 'LOCAL' && $dxchan->is_node;
745 next if $dxchan->is_rbn;
746 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call},
751 my $msgid = int rand(1000);
756 $msgid = 1 if $msgid > 999;
764 my $from_pc9x = shift;
766 my @dxchan = DXChannel::get_all();
769 my $text = unpad($_[2]);
773 # munge the group and recast the line if required
774 if ($target =~ s/\.LST$//) {
778 # obtain country codes etc
779 my @a = Prefix::cty_data($from);
780 my @b = Prefix::cty_data($_[4]);
781 if ($self->{inannfilter}) {
782 my ($filter, $hops) =
783 $self->{inannfilter}->it(@_, $self->{call},
785 @b[0..2], $a[3], $b[3]);
787 dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
792 if (AnnTalk::dup($from, $target, $_[2], $main::systime + $chatdupeage)) {
793 my $dxchan = DXChannel::get($from);
794 if ($self == $main::me && $dxchan && $dxchan->is_user) {
795 if ($dxchan->priv < 5) {
796 $dxchan->send($dxchan->msg('dup'));
800 dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
806 Log('chat', $target, $from, $text);
808 # send it if it isn't the except list and isn't isolated and still has a hop count
809 # taking into account filtering and so on
810 foreach $dxchan (@dxchan) {
811 if ($dxchan->is_node) {
812 next if $dxchan == $main::me;
813 next if $dxchan == $self;
814 next if $from_pc9x && $dxchan->do_pc9x;
815 next unless $dxchan->is_spider && $dxchan->do_pc9x;
816 next if $target eq 'LOCAL';
818 next if $dxchan->is_rbn;
820 $dxchan->chat($line, $self->{isolate}, $target, $_[1],
821 $text, @_, $self->{call}, @a[0..2], @b[0..2]);
835 if ($self->{annfilter}) {
836 ($filter, $hops) = $self->{annfilter}->it(@_);
837 return unless $filter;
839 send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
852 if ($self->{annfilter}) {
853 ($filter, $hops) = $self->{annfilter}->it(@_);
854 return unless $filter;
856 if (($self->is_spider || $self->is_ak1a) && $_[1] ne $main::mycall) {
857 send_prot_line($self, $filter, $hops, $isolate, $line);
862 sub send_local_config
866 dbg('DXProt::send_local_config') if isdbg('trace');
874 if ($self->{isolate}) {
875 dbg("$self->{call} send_local_config: isolated");
876 @localnodes = ( $main::routeroot );
877 $self->send_route($main::mycall, \&pc19, 1, $main::routeroot);
878 } elsif ($self->{do_pc9x}) {
879 dbg("$self->{call} send_local_config: doing pc9x");
880 my $node = Route::Node::get($self->{call});
881 # $self->send_last_pc92_config($main::routeroot);
882 # $self->send(pc92a($main::routeroot, $node)) unless $main::routeroot->last_PC92C =~ /$self->{call}/;
883 $self->send(pc92a($main::routeroot, $node));
884 $self->send(pc92k($main::routeroot));
886 # create a list of all the nodes that are not connected to this connection
887 # and are not themselves isolated, this to make sure that isolated nodes
888 # don't appear outside of this node
890 dbg("$self->{call} send_local_config: traditional");
892 # send locally connected nodes
893 my @dxchan = grep { $_->call ne $main::mycall && $_ != $self && !$_->{isolate} } DXChannel::get_all_nodes();
894 @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
895 $self->send_route($main::mycall, \&pc19, scalar(@localnodes)+1, $main::routeroot, @localnodes);
898 my @rawintcalls = map { $_->nodes } @localnodes if @localnodes;
900 foreach $node (@rawintcalls) {
901 push @intcalls, $node if grep $_ && $node != $_, @intcalls;
903 my $ref = Route::Node::get($self->{call});
904 my @rnodes = $ref->nodes;
905 foreach $node (@intcalls) {
906 push @remotenodes, Route::Node::get($node) if grep $_ && $node != $_, @rnodes, @remotenodes;
908 $self->send_route($main::mycall, \&pc19, scalar(@remotenodes), @remotenodes);
911 # get all the users connected on the above nodes and send them out
912 unless ($self->{do_pc9x}) {
913 foreach $node ($main::routeroot, @localnodes, @remotenodes) {
915 my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
916 $self->send_route($main::mycall, \&pc16, 1, $node, @rout) if @rout && $self->user->wantsendpc16;
918 dbg("sent a null value") if isdbg('chanerr');
924 sub gen_my_pc92_config
928 if ($node->{call} eq $main::mycall) {
929 clear_pc92_changes(); # remove any slugged data, we are generating it as now
930 my @dxchan = grep { $_->call ne $main::mycall && !$_->{isolate} } DXChannel::get_all();
931 dbg("ROUTE: all dxchan: " . join(',', map{$_->{call}} @dxchan)) if isdbg('routelow');
932 my @localnodes = map { my $r = Route::get($_->{call}); $r ? $r : () } @dxchan;
933 dbg("ROUTE: localnodes: " . join(',', map{$_->{call}} @localnodes)) if isdbg('routelow');
934 return pc92c($node, @localnodes);
936 my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
937 return pc92c($node, @rout);
941 sub send_last_pc92_config
945 if (my $l = $node->last_PC92C) {
948 $self->send_pc92_config($node);
957 dbg('DXProt::send_pc92_config') if isdbg('trace');
959 $node->last_PC92C(gen_my_pc92_config($node));
960 $self->send($node->last_PC92C);
963 sub broadcast_pc92_update
968 dbg("ROUTE: broadcast_pc92_update $call") if isdbg('obscount');
970 my $nref = Route::Node::get($call);
972 cluck("ERROR: broadcast_pc92_update - Route::Node $call disappeared");
973 $self->update_pc92_next;
976 my $l = $nref->last_PC92C(gen_my_pc92_config($nref));
977 $nref->lastid(last_pc9x_id());
978 $main::me->broadcast_route_pc9x($main::mycall, undef, $l, 0);
979 $self->update_pc92_next;
982 sub broadcast_pc92_keepalive
987 dbg("ROUTE: broadcast_pc92_keepalive $call") if isdbg('obscount');
989 my $nref = Route::Node::get($call);
991 cluck("ERROR: broadcast_pc92_keepalive - Route::Node $call disappeared");
992 $self->update_pc92_keepalive;
995 my $l = pc92k($nref);
996 $nref->lastid(last_pc9x_id());
997 $main::me->broadcast_route_pc9x($main::mycall, undef, $l, 0);
998 $self->update_pc92_keepalive;
1001 sub time_out_pc92_routes
1003 my @nodes = grep {$_->call ne $main::mycall && ($_->do_pc9x || $_->via_pc92)} Route::Node::get_all();
1005 foreach my $n (@nodes) {
1006 my $o = $n->dec_obs;
1008 if (my $dxchan = DXChannel::get($n->call)) {
1009 dbg("ROUTE: disconnecting local pc92 $dxchan->{call} on obscount") if isdbg('obscount');
1010 $dxchan->disconnect;
1013 my @parents = map {Route::Node::get($_)} $n->parents;
1016 dbg("ROUTE: deleting pc92 $_->{call} from $n->{call} on obscount") if isdbg('obscount');
1017 push @rdel, $n->del($_);
1021 dbg("ROUTE: obscount on $n->{call} now $o") if isdbg('obscount');
1025 $main::me->route_pc21($main::mycall, undef, $_) if $_;
1030 # route a message down an appropriate interface for a callsign
1032 # is called route(to, pcline);
1037 my ($self, $call, $line) = @_;
1039 if (ref $self && $call eq $self->{call}) {
1040 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1044 # always send it down the local interface if available
1045 my $dxchan = DXChannel::get($call);
1047 dbg("route: $call -> $dxchan->{call} direct" ) if isdbg('route');
1049 my $cl = Route::get($call);
1050 $dxchan = $cl->dxchan if $cl;
1052 if (ref $self && $dxchan eq $self) {
1053 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1056 dbg("route: $call -> $dxchan->{call} using normal route" ) if isdbg('route');
1061 my $routeit = adjust_hops($dxchan, $line); # adjust its hop count by node name
1063 $dxchan->send($routeit) unless $dxchan == $main::me;
1066 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
1071 # obtain the hops from the list for this callsign and pc no
1077 my $hops = $DXProt::hopcount{$pcno};
1078 $hops = $DXProt::def_hopcount if !$hops;
1083 # adjust the hop count on a per node basis using the user loadable
1084 # hop table if available or else decrement an existing one
1091 my $call = $self->{call};
1094 if (($hops) = $s =~ /\^H([-\d]+)\^?~?$/o) {
1095 my ($pcno) = $s =~ /^PC(\d\d)/o;
1096 confess "$call called adjust_hops with '$s'" unless $pcno;
1097 my $ref = $nodehops{$call} if %nodehops;
1099 my $newhops = $ref->{$pcno};
1100 return "" if defined $newhops && $newhops == 0;
1101 $newhops = $ref->{default} unless $newhops;
1102 return "" if defined $newhops && $newhops == 0;
1103 $newhops = $hops unless $newhops;
1104 return "" unless $newhops > 0;
1105 $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops != $hops;
1107 return "" unless $hops > 0;
1119 return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1120 do "$main::data/hop_table.pl";
1127 my ($self, $tonode, $fromnode, $user, $cmd) = @_;
1129 if ($tonode eq $main::mycall) {
1130 my $ref = DXUser::get_current($fromnode);
1131 unless ($ref && UNIVERSAL::isa($ref, 'DXUser')) {
1132 dbg("DXProt process_rcmd: user $fromnode isn't a reference (check user_asc and tell G1TLH)");
1133 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1136 Log('rcmd', 'in', ($ref->{priv}||0), $fromnode, $cmd, $user);
1137 my $cref = Route::Node::get($fromnode);
1138 unless ($cref && UNIVERSAL::isa($cref, 'Route')) {
1139 dbg("DXProt process_rcmd: Route $fromnode isn't a reference (tell G1TLH)");
1140 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1143 if ($cmd !~ /^\s*rcmd/i && $ref->homenode && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
1144 if ($ref->{priv}) { # you have to have SOME privilege, the commands have further filtering
1145 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
1146 my $oldpriv = $self->{priv};
1147 $self->{priv} = 1; # set a maximum privilege
1149 # park homenode and user for any spawned command that run_cmd may do.
1150 $self->{_rcmd_user} = $user;
1151 $self->{_rcmd_fromnode} = $fromnode;
1152 my @in = (DXCommandmode::run_cmd($self, $cmd));
1153 delete $self->{_rcmd_fromnode};
1154 delete $self->{_rcmd_user};
1155 $self->{priv} = $oldpriv;
1156 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
1157 delete $self->{remotecmd};
1159 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1162 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
1165 my $ref = DXUser::get_current($tonode);
1166 if ($ref && $ref->is_clx) {
1167 $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
1169 $self->route($tonode, pc34($fromnode, $tonode, $cmd));
1179 my $fromnode = shift;
1184 Log('rcmd', 'out', $fromnode, $line, $user);
1185 if ($self->is_clx) {
1186 $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
1188 $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
1193 # Punt off a long running command into a separate process - this will be caused by an rcmd from outside
1195 # This is called from commands to run some potentially long running
1196 # function. The process forks and then runs the function and returns
1197 # the result back to the cmd.
1199 # NOTE: this merely forks the current process and then runs the cmd in that (current) context.
1200 # IT DOES NOT START UP SOME NEW PROGRAM AND RELIES ON THE FACT THAT IT IS RUNNING DXSPIDER
1201 # THE CURRENT CONTEXT!!
1203 # call: $self->spawn_cmd($original_cmd_line, \<function>, [cb => sub{...}], [prefix => "cmd> "], [progress => 0|1], [args => [...]]);
1209 my $call = $self->{call};
1213 my $cb = delete $args{cb};
1214 my $prefix = delete $args{prefix};
1215 my $progress = delete $args{progress};
1216 my $args = delete $args{args} || [];
1217 my $t0 = [gettimeofday];
1219 # remembered from process_cmd when spawn_cmd was called thru DXCommandmode::run_cmd which was called by process_rcmd
1220 my $fromnode = $self->{_rcmd_fromnode};
1221 my $user = $self->{_rcmd_user};
1225 my $fc = DXSubprocess->new;
1227 # just behave normally if something has set the "one-shot" _nospawn in the channel
1228 if ($self->{_nospawn}) {
1229 eval { @out = $cmdref->(@$args); };
1231 DXDebug::dbgprintring(25);
1232 push @out, DXDebug::shortmess($@);
1237 # $fc->serializer(\&encode_json);
1238 # $fc->deserializer(\&decode_json);
1242 if (isdbg('spawn')) {
1243 my $s = __PACKAGE__ . qq{ line: "$line"};
1244 $s .= ", args: " . join(', ', map { defined $_ ? qq{'$_'} : q{'undef'} } @$args) if $args && @$args;
1247 eval { @out = $cmdref->(@$args); };
1249 DXDebug::dbgprintring(25);
1250 push @out, DXDebug::shortmess($@);
1256 my ($fc, $err, @res) = @_;
1257 my $self = DXChannel::get($call);
1258 return unless $self;
1261 my $s = "DXCommand::spawn_cmd: call $call error $err";
1262 dbg($s) if isdbg('chan');
1263 if ($fromnode && $user) {
1264 $self->send_rcmd_reply($main::mycall, $fromnode, $user, $s);
1271 # transform output if required
1272 @res = $cb->($self, @res);
1275 if ($fromnode && $user) {
1276 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @res);
1281 diffms(__PACKAGE__, " rcmd from $user on $call", $line, $t0, scalar @res) if isdbg('progress');
1287 sub process_rcmd_reply
1289 my ($self, $tonode, $fromnode, $user, $line) = @_;
1290 if ($tonode eq $main::mycall) {
1291 my $s = $rcmds{$fromnode};
1293 my $dxchan = DXChannel::get($s->{call});
1294 my $ref = $user eq $tonode ? $dxchan : (DXChannel::get($user) || $dxchan);
1295 $ref->send($line) if $ref;
1296 delete $rcmds{$fromnode} if !$dxchan;
1298 # send unsolicited ones to the sysop
1299 my $dxchan = DXChannel::get($main::myalias);
1300 $dxchan->send($line) if $dxchan;
1303 my $ref = DXUser::get_current($tonode);
1304 if ($ref && $ref->is_clx) {
1305 $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
1307 $self->route($tonode, pc35($fromnode, $tonode, $line));
1314 # add a rcmd request to the rcmd queues
1317 my ($self, $to, $cmd) = @_;
1320 $r->{call} = $self->{call};
1321 $r->{t} = $main::systime;
1325 my $ref = Route::Node::get($to);
1326 my $dxchan = $ref->dxchan;
1327 if ($dxchan && $dxchan->is_clx) {
1328 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1330 route(undef, $to, pc34($main::mycall, $to, $cmd));
1337 my $pc39flag = shift || 0;
1338 my $call = $self->call;
1340 return if $self->{disconnecting}++;
1342 unless ($pc39flag == 1) {
1343 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1346 # get rid of any PC16/17/19
1347 eph_del_regex("^PC1[679]*$call");
1349 # do routing stuff, remove me from routing table
1350 my $node = Route::Node::get($call);
1352 Route::delete_interface($call);
1354 # unbusy and stop and outgoing mail
1355 my $mref = DXMsg::get_busy($call);
1356 $mref->stop_msg($call) if $mref;
1358 # remove outstanding pings
1359 delete $pings{$call};
1361 # I was the last node visited
1362 $self->user->node($main::mycall);
1364 # send info to all logged in thingies
1365 $self->tell_login('logoutn');
1367 Log('DXProt', $call . " Disconnected");
1369 $self->SUPER::disconnect;
1371 # here we determine what needs to go out of the routing table
1373 if ($node && $pc39flag != 2) {
1374 dbg('%Route::Node::List = ' . join(',', sort keys %Route::Node::list)) if isdbg('routedisc');
1376 @rout = $node->del($main::routeroot);
1378 dbg('@rout = ' . join(',', sort map {$_->call} @rout)) if isdbg('routedisc');
1380 # now we need to see what can't be routed anymore and came
1381 # in via this node (probably).
1383 while ($n != @rout) {
1385 for (Route::Node::get_all()) {
1386 unless ($_->dxchan) {
1387 push @rout, $_->delete;
1390 dbg('@rout = ' . join(',', sort map {$_->call} @rout)) if isdbg('routedisc');
1393 dbg('%Route::Node::List = ' . join(',', sort keys %Route::Node::list)) if isdbg('routedisc');
1395 # and all my ephemera as well
1398 eph_del_regex("^PC1[679].*$c");
1402 # broadcast to all other nodes that all the nodes connected to via me are gone
1403 unless ($pc39flag == 2) {
1404 $self->route_pc21($main::mycall, undef, @rout) if @rout;
1405 $self->route_pc92d($main::mycall, undef, $main::routeroot, $node) if $node;
1411 # send a talk message to this thingy
1415 my ($self, $from, $to, $via, $line, $origin) = @_;
1417 if ($self->{do_pc9x}) {
1418 $self->send(pc93($to, $from, $via, $line));
1420 $self->send(pc10($from, $to, $via, $line, $origin));
1422 Log('talk', $to, $from, '>' . ($via || $origin || $self->call), $line) unless $origin && $origin ne $main::mycall;
1425 # send it if it isn't the except list and isn't isolated and still has a hop count
1426 # taking into account filtering and so on
1432 my $generate = shift;
1433 my $no = shift; # the no of things to filter on
1435 my ($filter, $hops);
1438 for (; @_ && $no; $no--) {
1441 # don't send messages with $self's call in back to them
1442 if ($r->call eq $self->{call}) {
1443 dbg("PCPROT: trying to send $self->{call} back itself") if isdbg('chanerr');
1447 if (!$self->{isolate} && $self->{routefilter}) {
1450 ($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});
1454 dbg("PCPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('filter');
1457 dbg("was sent a null value") if isdbg('chanerr');
1460 push @rin, $r unless $self->{isolate} && $r->call ne $main::mycall;
1464 foreach my $line (&$generate(@rin, @_)) {
1467 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1469 $routeit = adjust_hops($self, $line); # adjust its hop count by node name
1470 next unless $routeit;
1473 $self->send($routeit);
1478 # broadcast everywhere
1483 my $generate = shift;
1485 my @dxchan = DXChannel::get_all_nodes();
1489 $line =~ /\^H(\d+)\^?\~?$/;
1490 return unless $1 > 0;
1492 unless ($self->{isolate}) {
1493 foreach $dxchan (@dxchan) {
1494 next if $dxchan == $self || $dxchan == $main::me;
1495 next if $origin eq $dxchan->{call}; # don't route some from this call back again.
1496 next unless $dxchan->isa('DXProt');
1498 $dxchan->send_route($origin, $generate, @_);
1503 # broadcast to non-pc9x nodes
1504 sub broadcast_route_nopc9x
1508 my $generate = shift;
1510 my @dxchan = DXChannel::get_all_nodes();
1514 $line =~ /\^H(\d+)\^?\~?$/;
1515 return unless $1 > 0;
1517 unless ($self->{isolate}) {
1518 foreach $dxchan (@dxchan) {
1519 next if $dxchan == $self || $dxchan == $main::me;
1520 next if $origin eq $dxchan->{call}; # don't route some from this call back again.
1521 next unless $dxchan->isa('DXProt');
1522 next if $dxchan->{do_pc9x};
1523 if ($generate == \&pc16 || $generate==\&pc17) {
1524 next unless $dxchan->user->wantsendpc16;
1526 $dxchan->send_route($origin, $generate, @_);
1531 # this is only used for next door nodes on init
1536 return unless $self->{do_pc9x};
1539 my $generate = shift;
1540 my $no = shift; # the no of things to filter on
1543 $line = &$generate(@_);
1547 # broadcast only to pc9x nodes
1548 sub broadcast_route_pc9x
1552 my $generate = shift;
1555 my @dxchan = DXChannel::get_all_nodes();
1558 if ($origin eq $main::mycall && $generate && !$line) {
1559 $line = &$generate(@_);
1562 $line =~ /\^H(\d+)\^\~?$/;
1563 unless ($1 > 0 && $self->{isolate}) {
1564 foreach $dxchan (@dxchan) {
1565 next if $dxchan == $self || $dxchan == $main::me;
1566 next if $origin eq $dxchan->{call}; # don't route some from this call back again.
1567 next unless $dxchan->isa('DXProt');
1568 next unless $dxchan->{do_pc9x};
1570 $dxchan->send($line);
1578 return unless $self->user->wantpc16;
1581 broadcast_route_nopc9x($self, $origin, \&pc16, $line, 1, @_);
1587 return unless $self->user->wantpc16;
1590 broadcast_route_nopc9x($self, $origin, \&pc17, $line, 1, @_);
1598 broadcast_route_nopc9x($self, $origin, \&pc19, $line, scalar @_, @_);
1606 broadcast_route_nopc9x($self, $origin, \&pc21, $line, scalar @_, @_);
1614 broadcast_route($self, $origin, \&pc24, $line, 1, @_);
1622 broadcast_route($self, $origin, \&pc41, $line, 1, @_);
1625 # this is probably obsolete now
1632 broadcast_route($self, $origin, \&pc50, $line, 1, @_);
1640 broadcast_route_pc9x($self, $origin, \&pc92c, $line, 1, @_);
1648 broadcast_route_pc9x($self, $origin, \&pc92a, $line, 1, @_);
1656 broadcast_route_pc9x($self, $origin, \&pc92d, $line, 1, @_);
1663 my ($filter, $hops) = (1, 1);
1665 if ($self->{inroutefilter}) {
1666 ($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);
1667 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
1675 my $t = shift || $eph_restime;
1679 $s =~ s/\^H\d\d?\^?\~?$//;
1680 $r = 1 if exists $eph{$s}; # pump up the dup if it keeps circulating
1681 $eph{$s} = $main::systime + $t;
1682 dbg("PCPROT: emphemeral duplicate") if $r && isdbg('chanerr');
1690 while (($key, $val) = each %eph) {
1691 if ($key =~ m{$regex}) {
1701 while (($key, $val) = each %eph) {
1702 if ($main::systime >= $val) {
1713 while (($key, $val) = each %eph) {
1714 push @out, $key, $val;
1721 goto &DXCommandmode::run_cmd;
1725 # import any msgs in the chat directory
1726 # the messages are sent to the chat group which forms the
1727 # the first part of the name (eg: solar.1243.txt would be
1728 # sent to chat group SOLAR)
1730 # Each message found is sent: one non-blank line to one chat
1731 # message. So 4 lines = 4 chat messages.
1733 # The special name LOCAL is for local users ANN
1734 # The special name ALL is for ANN/FULL
1735 # The special name SYSOP is for ANN/SYSOP
1739 # are there any to do in this directory?
1740 return unless -d $chatimportfn;
1741 unless (opendir(DIR, $chatimportfn)) {
1742 dbg("can\'t open $chatimportfn $!") if isdbg('msg');
1743 Log('msg', "can\'t open $chatimportfn $!");
1747 my @names = readdir(DIR);
1750 foreach $name (@names) {
1751 next if $name =~ /^\./;
1752 my $splitit = $name =~ /^split/;
1753 my $fn = "$chatimportfn/$name";
1755 unless (open(MSG, $fn)) {
1756 dbg("can\'t open import file $fn $!") if isdbg('msg');
1757 Log('msg', "can\'t open import file $fn $!");
1761 my @msg = map { s/\r?\n$//; $_ } <MSG>;
1765 my @cat = split /\./, $name;
1766 my $target = uc $cat[0];
1768 foreach my $text (@msg) {
1769 next unless $text && $text !~ /^\s*#/;
1770 if ($target eq 'ALL' || $target eq 'LOCAL' || $target eq 'SYSOP' || $target eq 'WX') {
1771 my $sysop = uc $target eq 'SYSOP' ? '*' : ' ';
1772 my $wx = uc $target eq 'WX' ? '1' : '0';
1774 $via = '*' if $target eq 'ALL' || $target eq 'SYSOP';
1775 Log('ann', $target, $main::mycall, $text);
1776 $main::me->normal(DXProt::pc93($target, $main::mycall, $via, $text));
1778 DXCommandmode::send_chats($main::me, $target, $text);
1784 # start a pc92 find operation
1789 my $key = "$dxchan->{call}|$target";
1790 if ($pc92_find{$key}) {
1795 # function (not method) to handle pc92 find returns
1796 sub handle_pc92_find_reply
1798 my ($dxchan, $node, $from, $target, $flag, $ms) = @_;
1800 $dxchan->print_pc92_find_reply($node, $target, $flag, $ms) if $dxchan->can('print_pc92_find_return');