5afb6716fcc8846aa825163964cd3ddb39f7d607
[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 #
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 DXProtHandle;
36
37 use Time::HiRes qw(gettimeofday tv_interval);
38 use Mojo::IOLoop::Subprocess;
39 use DXSubprocess;
40
41 use strict;
42
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
54                    );
55
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
58
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
63
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;
70 $ann_to_talk = 1;
71 $eph_restime = 60;
72 $eph_info_restime = 18*60*60;
73 $eph_pc15_restime = 6*60;
74 $eph_pc34_restime = 30;
75 $pingint = 5*60;
76 $obscount = 2;
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
86
87
88 @checklist =
89 (
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
93  [ qw(i c h) ],                                 #
94  [ qw(i c h) ],                                 #
95  [ qw(i c m h) ],                                       #
96  undef ,                                                # pc16 has to be validated manually
97  [ qw(i c c h) ],                                       # pc17
98  [ qw(i m n) ],                                 # pc18
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
127  undef,                                                 # pc47
128  undef,                                                 # pc48
129  [ qw(i c m h) ],                                       # pc49
130  [ qw(i c n h) ],                                       # pc50
131  [ qw(i c c n) ],                                       # pc51
132  undef,
133  undef,
134  undef,
135  undef,
136  undef,
137  undef,
138  undef,
139  undef,
140  undef,                                                 # pc60
141  [ qw(i f m d t m c c a h) ],           # pc61
142  undef,
143  undef,
144  undef,
145  undef,
146  undef,
147  undef,
148  undef,
149  undef,
150  undef,                                                 # pc70
151  undef,
152  undef,
153  [ qw(i d n n n n n n m m m c c h) ],   # pc73
154  undef,
155  undef,
156  undef,
157  undef,
158  undef,
159  undef,
160  undef,                                                 # pc80
161  undef,
162  undef,
163  undef,
164  [ qw(i c c c m) ],                             # pc84
165  [ qw(i c c c m) ],                             # pc85
166  undef,
167  undef,
168  undef,
169  undef,
170  undef,                                                 # pc90
171  undef,
172  [ qw(i c f l)],                                # pc92
173  [ qw(i c f *m c *c m)],                                        # pc93
174 );
175
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)
178 sub check
179 {
180         my $n = shift;
181         my $pc = shift;
182         
183         $n -= 10;
184         return 0 if $n < 0 || $n > @checklist;
185         my $ref = $checklist[$n];
186         return 0 unless ref $ref;
187
188         my $i;
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] =~ /^\*$/;
194                 if ($act eq 'c') {
195                         return $i unless is_callsign($pc->[$i]);
196                 } elsif ($act eq 'i') {
197                         ;                                       # do nothing
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]);
216                 }
217         }
218         return 0;
219 }
220
221 sub update_pc92_next
222 {
223         my $self = shift;
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');
227 }
228
229 sub update_pc92_keepalive
230 {
231         my $self = shift;
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');
235 }
236
237 sub init
238 {
239         my $fn = localdata("hop_table.pl");
240         do $fn if -e $fn;
241         confess $@ if $@;
242
243         my $user = DXUser::get($main::mycall);
244         die "User $main::mycall not setup or disappeared RTFM" unless $user;
245
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;
261 }
262
263 #
264 # obtain a new connection this is derived from dxchannel
265 #
266
267 sub new
268 {
269         my $self = DXChannel::alloc(@_);
270
271         # add this node to the table, the values get filled in later
272         my $pkg = shift;
273         my $call = shift;
274
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;
281         }
282         $main::routeroot->add($call, '5000', Route::here(1), $self->{conn}->peerhost) if $call ne $main::mycall;
283
284         return $self;
285 }
286
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).
290 sub start
291 {
292         my ($self, $line, $sort) = @_;
293         my $call = $self->{call};
294         my $user = $self->{user};
295
296         # log it
297         my $host = $self->{conn}->peerhost;
298         $host ||= "AGW Port #$self->{conn}->{agwport}" if exists $self->{conn}->{agwport};
299         $host ||= "unknown";
300         $self->{hostname} = $host if is_ipaddr($host);
301
302         Log('DXProt', "$call connected from $host");
303
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
313         $self->{here} = 1;
314         $self->{width} = 80;
315
316         # sort out registration
317         $self->{registered} = 1;
318
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} ;
326
327
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} ;
335
336
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');
341
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;
351
352         # send initialisation string
353         unless ($self->{outbound}) {
354                 $self->sendinit;
355         }
356
357         $self->state('init');
358         $self->{pc50_t} = $main::systime;
359
360         # send info to all logged in thingies
361         $self->tell_login('loginn');
362
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;
366
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);
370
371         # set next keepalive time
372         $self->update_pc92_keepalive;
373 }
374
375 #
376 # send outgoing 'challenge'
377 #
378
379 sub sendinit
380 {
381         my $self = shift;
382         $self->send(pc18(($self->{isolate} || !$self->user->wantpc9x) ? "" : " pc9x"));
383 }
384
385 #
386 # This is the normal pcxx despatcher
387 #
388 sub normal
389 {
390         my ($self, $line) = @_;
391
392         if ($line =~ '^<\w+\s' && $main::do_xml) {
393                 DXXml::normal($self, $line);
394                 return;
395         }
396
397         my @field = split /\^/, $line;
398         return unless @field;
399
400         pop @field if $field[-1] eq '~';
401
402 #       print join(',', @field), "\n";
403
404
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');
409                 return;
410         }
411
412         # check for and dump bad protocol messages
413         my $n = check($pcno, \@field);
414         if ($n) {
415                 dbg("PCPROT: bad field $n, dumped (" . parray($checklist[$pcno-10]) . ")") if isdbg('chanerr');
416                 return;
417         }
418
419         # modify the hop count here
420         if ($self != $main::me) {
421                 if (my ($hops, $trail) = $line =~ /\^H(\d+)(\^?\~?)?$/) {
422                         $trail ||= '';
423                         $hops--;
424                         return if $hops < 0;
425                         $line =~ s/\^H(\d+)(\^?\~?)?$/sprintf('^H%d%s', $hops, $trail)/e;
426                         $field[-1] = "H$hops";
427                 }
428         }
429
430         if (defined &Local::pcprot) {
431                 my $r;
432                 eval { $r = Local::pcprot($self, $pcno, $line, @field); };
433                 return if $r;                   # i.e don't process it
434         }
435
436         # send it out for processing
437         my $origin = $self->{call};
438         no strict 'subs';
439         my $sub = "handle_$pcno";
440
441         if ($self->can($sub)) {
442                 $self->$sub($pcno, $line, $origin, \@field);
443         } else {
444                 $self->handle_default($pcno, $line, $origin, \@field);
445         }
446 }
447
448 #
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
451 #
452 sub process
453 {
454         my $t = time;
455         my @dxchan = DXChannel::get_all();
456         my $dxchan;
457         my $pc50s;
458
459         # every ten seconds
460         if ($t - $last10 >= 10) {
461                 # clean out ephemera
462
463                 eph_clean();
464                 import_chat();
465
466                 $last10 = $t;
467
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);
471                         eph_dup($pc50s);
472                         $last_pc50 = $t;
473                 }
474
475                 foreach $dxchan (@dxchan) {
476                         next unless $dxchan->is_node;
477                         next if $dxchan == $main::me;
478
479                         # send the pc50
480                         $dxchan->send($pc50s) if !$dxchan->{do_pc9x} && $pc50s;
481
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');
486                                         $dxchan->disconnect;
487                                 } else {
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');
493                                 }
494                         }
495                 }
496
497                 clean_pc92_find();
498
499                 # send out config broadcasts
500                 foreach $dxchan (@dxchan) {
501                         next unless $dxchan->is_node;
502
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});
515                                         } else {
516                                                 $dxchan->update_pc92_next;
517                                         }
518                                 } else {
519                                         $dxchan->update_pc92_next; # this won't actually do anything, it's just to be tidy
520                                 }
521                         }
522                 }
523
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);
528                 }
529
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();
535                 }
536         }
537
538         if ($main::systime - 3600 > $last_hour) {
539                 $last_hour = $main::systime;
540         }
541 }
542
543 #
544 # finish up a pc context
545 #
546
547 #
548 # some active measures
549 #
550
551
552 sub send_dx_spot
553 {
554         my $self = shift;
555         my $line = shift;
556         my @dxchan = DXChannel::get_all();
557         my $dxchan;
558         my $pc11;
559
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                 if ($line =~ /PC61/ && !($dxchan->is_spider || $dxchan->is_user)) {
566                         unless ($pc11) {
567                                 my @f = split /\^/, $line;
568                                 $pc11 = join '^', 'PC11', @f[1..7,9];
569                         }
570                         $dxchan->dx_spot($pc11, $self->{isolate}, @_, $self->{call});
571                 } else {
572                         $dxchan->dx_spot($line, $self->{isolate}, @_, $self->{call});
573                 }
574         }
575 }
576
577 sub dx_spot
578 {
579         my $self = shift;
580         my $line = shift;
581         my $isolate = shift;
582         my ($filter, $hops);
583
584         if ($self->{spotsfilter}) {
585                 ($filter, $hops) = $self->{spotsfilter}->it(@_);
586                 return unless $filter;
587         }
588         send_prot_line($self, $filter, $hops, $isolate, $line);
589 }
590
591 sub send_prot_line
592 {
593         my ($self, $filter, $hops, $isolate, $line) = @_;
594         my $routeit;
595
596
597         if ($hops) {
598                 $routeit = $line;
599                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
600         } else {
601                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
602                 return unless $routeit;
603         }
604         if ($filter) {
605                 $self->send($routeit);
606         } else {
607                 $self->send($routeit) unless $self->{isolate} || $isolate;
608         }
609 }
610
611
612 sub send_wwv_spot
613 {
614         my $self = shift;
615         my $line = shift;
616         my @dxchan = DXChannel::get_all();
617         my $dxchan;
618         my @dxcc = ((Prefix::cty_data($_[6]))[0..2], (Prefix::cty_data($_[7]))[0..2]);
619
620         # send it if it isn't the except list and isn't isolated and still has a hop count
621         # taking into account filtering and so on
622         foreach $dxchan (@dxchan) {
623                 next if $dxchan == $main::me;
624                 next if $dxchan == $self && $self->is_node;
625                 my $routeit;
626                 my ($filter, $hops);
627
628                 $dxchan->wwv($line, $self->{isolate}, @_, $self->{call}, @dxcc);
629         }
630 }
631
632 sub wwv
633 {
634         my $self = shift;
635         my $line = shift;
636         my $isolate = shift;
637         my ($filter, $hops);
638
639         if ($self->{wwvfilter}) {
640                 ($filter, $hops) = $self->{wwvfilter}->it(@_[7..$#_]);
641                 return unless $filter;
642         }
643         send_prot_line($self, $filter, $hops, $isolate, $line)
644 }
645
646 sub send_wcy_spot
647 {
648         my $self = shift;
649         my $line = shift;
650         my @dxchan = DXChannel::get_all();
651         my $dxchan;
652         my @dxcc = ((Prefix::cty_data($_[10]))[0..2], (Prefix::cty_data($_[11]))[0..2]);
653
654         # send it if it isn't the except list and isn't isolated and still has a hop count
655         # taking into account filtering and so on
656         foreach $dxchan (@dxchan) {
657                 next if $dxchan == $main::me;
658                 next if $dxchan == $self;
659
660                 $dxchan->wcy($line, $self->{isolate}, @_, $self->{call}, @dxcc);
661         }
662 }
663
664 sub wcy
665 {
666         my $self = shift;
667         my $line = shift;
668         my $isolate = shift;
669         my ($filter, $hops);
670
671         if ($self->{wcyfilter}) {
672                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
673                 return unless $filter;
674         }
675         send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
676 }
677
678 # send an announce
679 sub send_announce
680 {
681         my $self = shift;
682         my $from_pc9x = shift;
683         my $line = shift;
684         my @dxchan = DXChannel::get_all();
685         my $dxchan;
686         my $target = $_[6];
687         my $to = 'To ';
688         my $text = unpad($_[2]);
689         my $from = $_[0];
690
691         if ($_[3] eq '*') {     # sysops
692                 $target = "SYSOP";
693         } elsif ($_[3] gt ' ') { # speciality list handling
694                 my ($name) = split /\./, $_[3];
695                 $target = "$name"; # put the rest in later (if bothered)
696         }
697
698         if ($_[5] eq '1') {
699                 $target = "WX";
700                 $to = '';
701         }
702         $target = "ALL" if !$target;
703
704
705         # obtain country codes etc
706         my @a = Prefix::cty_data($from);
707         my @b = Prefix::cty_data($_[4]);
708         if ($self->{inannfilter}) {
709                 my ($filter, $hops) =
710                         $self->{inannfilter}->it(@_, $self->{call},
711                                                                          @a[0..2],
712                                                                          @b[0..2], $a[3], $b[3]);
713                 unless ($filter) {
714                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
715                         return;
716                 }
717         }
718
719         # the sysop ('*') thing is an attempt to minimise the damage caused by non-updated PC93 generators
720         if (AnnTalk::dup($from, $target, $_[2]) || ($_[3] eq '*' && AnnTalk::dup($from, 'ALL', $_[2]))) {
721                 my $dxchan = DXChannel::get($from);
722                 if ($self == $main::me && $dxchan && $dxchan->is_user) {
723                         if ($dxchan->priv < 5) {
724                                 $dxchan->send($dxchan->msg('dup'));
725                                 return;
726                         }
727                 } else {
728                         dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
729                         return;
730                 }
731         }
732
733         Log('ann', $target, $from, $text);
734
735         # send it if it isn't the except list and isn't isolated and still has a hop count
736         # taking into account filtering and so on
737         foreach $dxchan (@dxchan) {
738                 next if $dxchan == $main::me;
739                 next if $dxchan == $self && $self->is_node;
740                 next if $from_pc9x && $dxchan->{do_pc9x};
741                 next if $target eq 'LOCAL' && $dxchan->is_node;
742                 $dxchan->announce($line, $self->{isolate}, $to, $target, $text, @_, $self->{call},
743                                                   @a[0..2], @b[0..2]);
744         }
745 }
746
747 my $msgid = int rand(1000);
748
749 sub nextchatmsgid
750 {
751         $msgid++;
752         $msgid = 1 if $msgid > 999;
753         return $msgid;
754 }
755
756 # send a chat line
757 sub send_chat
758 {
759         my $self = shift;
760         my $from_pc9x = shift;
761         my $line = shift;
762         my @dxchan = DXChannel::get_all();
763         my $dxchan;
764         my $target = $_[3];
765         my $text = unpad($_[2]);
766         my $ak1a_line;
767         my $from = $_[0];
768
769         # munge the group and recast the line if required
770         if ($target =~ s/\.LST$//) {
771                 $ak1a_line = $line;
772         }
773
774         # obtain country codes etc
775         my @a = Prefix::cty_data($from);
776         my @b = Prefix::cty_data($_[4]);
777         if ($self->{inannfilter}) {
778                 my ($filter, $hops) =
779                         $self->{inannfilter}->it(@_, $self->{call},
780                                                                          @a[0..2],
781                                                                          @b[0..2], $a[3], $b[3]);
782                 unless ($filter) {
783                         dbg("PCPROT: Rejected by input announce filter") if isdbg('chanerr');
784                         return;
785                 }
786         }
787
788         if (AnnTalk::dup($from, $target, $_[2], $main::systime + $chatdupeage)) {
789                 my $dxchan = DXChannel::get($from);
790                 if ($self == $main::me && $dxchan && $dxchan->is_user) {
791                         if ($dxchan->priv < 5) {
792                                 $dxchan->send($dxchan->msg('dup'));
793                                 return;
794                         }
795                 } else {
796                         dbg("PCPROT: Duplicate Announce ignored") if isdbg('chanerr');
797                         return;
798                 }
799         }
800
801
802         Log('chat', $target, $from, $text);
803
804         # send it if it isn't the except list and isn't isolated and still has a hop count
805         # taking into account filtering and so on
806         foreach $dxchan (@dxchan) {
807                 if ($dxchan->is_node) {
808                         next if $dxchan == $main::me;
809                         next if $dxchan == $self;
810                         next if $from_pc9x && $dxchan->do_pc9x;
811                         next unless $dxchan->is_spider && $dxchan->do_pc9x;
812                         next if $target eq 'LOCAL';
813                 }
814
815                 $dxchan->chat($line, $self->{isolate}, $target, $_[1],
816                                           $text, @_, $self->{call}, @a[0..2], @b[0..2]);
817         }
818 }
819
820 sub announce
821 {
822         my $self = shift;
823         my $line = shift;
824         my $isolate = shift;
825         my $to = shift;
826         my $target = shift;
827         my $text = shift;
828         my ($filter, $hops);
829
830         if ($self->{annfilter}) {
831                 ($filter, $hops) = $self->{annfilter}->it(@_);
832                 return unless $filter;
833         }
834         send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
835 }
836
837 sub chat
838 {
839         my $self = shift;
840         my $line = shift;
841         my $isolate = shift;
842         my $to = shift;
843         my $target = shift;
844         my $text = shift;
845         my ($filter, $hops);
846
847         if ($self->{annfilter}) {
848                 ($filter, $hops) = $self->{annfilter}->it(@_);
849                 return unless $filter;
850         }
851         if (($self->is_spider || $self->is_ak1a) && $_[1] ne $main::mycall) {
852                 send_prot_line($self, $filter, $hops, $isolate, $line);
853         }
854 }
855
856
857 sub send_local_config
858 {
859         my $self = shift;
860
861         dbg('DXProt::send_local_config') if isdbg('trace');
862
863         # send our nodes
864         my $node;
865         my @nodes;
866         my @localnodes;
867         my @remotenodes;
868
869         if ($self->{isolate}) {
870                 dbg("$self->{call} send_local_config: isolated");
871                 @localnodes = ( $main::routeroot );
872                 $self->send_route($main::mycall, \&pc19, 1, $main::routeroot);
873         } elsif ($self->{do_pc9x}) {
874                 dbg("$self->{call} send_local_config: doing pc9x");
875                 my $node = Route::Node::get($self->{call});
876 #               $self->send_last_pc92_config($main::routeroot);
877 #               $self->send(pc92a($main::routeroot, $node)) unless $main::routeroot->last_PC92C =~ /$self->{call}/;
878                 $self->send(pc92a($main::routeroot, $node));
879                 $self->send(pc92k($main::routeroot));
880         } else {
881                 # create a list of all the nodes that are not connected to this connection
882                 # and are not themselves isolated, this to make sure that isolated nodes
883                 # don't appear outside of this node
884
885                 dbg("$self->{call} send_local_config: traditional");
886
887                 # send locally connected nodes
888                 my @dxchan = grep { $_->call ne $main::mycall && $_ != $self && !$_->{isolate} } DXChannel::get_all_nodes();
889                 @localnodes = map { my $r = Route::Node::get($_->{call}); $r ? $r : () } @dxchan if @dxchan;
890                 $self->send_route($main::mycall, \&pc19, scalar(@localnodes)+1, $main::routeroot, @localnodes);
891
892                 my $node;
893                 my @rawintcalls = map { $_->nodes } @localnodes if @localnodes;
894                 my @intcalls;
895                 foreach $node (@rawintcalls) {
896                         push @intcalls, $node if grep $_ && $node != $_, @intcalls;
897                 }
898                 my $ref = Route::Node::get($self->{call});
899                 my @rnodes = $ref->nodes;
900                 foreach $node (@intcalls) {
901                         push @remotenodes, Route::Node::get($node) if grep $_ && $node != $_, @rnodes, @remotenodes;
902                 }
903                 $self->send_route($main::mycall, \&pc19, scalar(@remotenodes), @remotenodes);
904         }
905
906         # get all the users connected on the above nodes and send them out
907         unless ($self->{do_pc9x}) {
908                 foreach $node ($main::routeroot, @localnodes, @remotenodes) {
909                         if ($node) {
910                                 my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
911                                 $self->send_route($main::mycall, \&pc16, 1, $node, @rout) if @rout && $self->user->wantsendpc16;
912                         } else {
913                                 dbg("sent a null value") if isdbg('chanerr');
914                         }
915                 }
916         }
917 }
918
919 sub gen_my_pc92_config
920 {
921         my $node = shift;
922
923         if ($node->{call} eq $main::mycall) {
924                 clear_pc92_changes();           # remove any slugged data, we are generating it as now
925                 my @dxchan = grep { $_->call ne $main::mycall && !$_->{isolate} } DXChannel::get_all();
926                 dbg("ROUTE: all dxchan: " . join(',', map{$_->{call}} @dxchan)) if isdbg('routelow');
927                 my @localnodes = map { my $r = Route::get($_->{call}); $r ? $r : () } @dxchan;
928                 dbg("ROUTE: localnodes: " . join(',', map{$_->{call}} @localnodes)) if isdbg('routelow');
929                 return pc92c($node, @localnodes);
930         } else {
931                 my @rout = map {my $r = Route::User::get($_); $r ? ($r) : ()} $node->users;
932                 return pc92c($node, @rout);
933         }
934 }
935
936 sub send_last_pc92_config
937 {
938         my $self = shift;
939         my $node = shift;
940         if (my $l = $node->last_PC92C) {
941                 $self->send($l);
942         } else {
943                 $self->send_pc92_config($node);
944         }
945 }
946
947 sub send_pc92_config
948 {
949         my $self = shift;
950         my $node = shift;
951
952         dbg('DXProt::send_pc92_config') if isdbg('trace');
953
954         $node->last_PC92C(gen_my_pc92_config($node));
955         $self->send($node->last_PC92C);
956 }
957
958 sub broadcast_pc92_update
959 {
960         my $self = shift;
961         my $call = shift;
962
963         dbg("ROUTE: broadcast_pc92_update $call") if isdbg('obscount');
964
965         my $nref = Route::Node::get($call);
966         unless ($nref) {
967                 cluck("ERROR: broadcast_pc92_update - Route::Node $call disappeared");
968                 $self->update_pc92_next;
969                 return;
970         }
971         my $l = $nref->last_PC92C(gen_my_pc92_config($nref));
972         $nref->lastid(last_pc9x_id());
973         $main::me->broadcast_route_pc9x($main::mycall, undef, $l, 0);
974         $self->update_pc92_next;
975 }
976
977 sub broadcast_pc92_keepalive
978 {
979         my $self = shift;
980         my $call = shift;
981
982         dbg("ROUTE: broadcast_pc92_keepalive $call") if isdbg('obscount');
983
984         my $nref = Route::Node::get($call);
985         unless ($nref) {
986                 cluck("ERROR: broadcast_pc92_keepalive - Route::Node $call disappeared");
987                 $self->update_pc92_keepalive;
988                 return;
989         }
990         my $l = pc92k($nref);
991         $nref->lastid(last_pc9x_id());
992         $main::me->broadcast_route_pc9x($main::mycall, undef, $l, 0);
993         $self->update_pc92_keepalive;
994 }
995
996 sub time_out_pc92_routes
997 {
998         my @nodes = grep {$_->call ne $main::mycall && ($_->do_pc9x || $_->via_pc92)} Route::Node::get_all();
999         my @rdel;
1000         foreach my $n (@nodes) {
1001                 my $o = $n->dec_obs;
1002                 if ($o <= 0) {
1003                         if (my $dxchan = DXChannel::get($n->call)) {
1004                                 dbg("ROUTE: disconnecting local pc92 $dxchan->{call} on obscount") if isdbg('obscount');
1005                                 $dxchan->disconnect;
1006                                 next;
1007                         }
1008                         my @parents = map {Route::Node::get($_)} $n->parents;
1009                         for (@parents) {
1010                                 if ($_) {
1011                                         dbg("ROUTE: deleting pc92 $_->{call} from $n->{call} on obscount")  if isdbg('obscount');
1012                                         push @rdel, $n->del($_);
1013                                 }
1014                         }
1015                 } else {
1016                         dbg("ROUTE: obscount on $n->{call} now $o") if isdbg('obscount');
1017                 }
1018         }
1019         for (@rdel) {
1020                 $main::me->route_pc21($main::mycall, undef, $_) if $_;
1021         }
1022 }
1023
1024 #
1025 # route a message down an appropriate interface for a callsign
1026 #
1027 # is called route(to, pcline);
1028 #
1029
1030 sub route
1031 {
1032         my ($self, $call, $line) = @_;
1033
1034         if (ref $self && $call eq $self->{call}) {
1035                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1036                 return;
1037         }
1038
1039         # always send it down the local interface if available
1040         my $dxchan = DXChannel::get($call);
1041         if ($dxchan) {
1042                 dbg("route: $call -> $dxchan->{call} direct" ) if isdbg('route');
1043         } else {
1044                 my $cl = Route::get($call);
1045                 $dxchan = $cl->dxchan if $cl;
1046                 if (ref $dxchan) {
1047                         if (ref $self && $dxchan eq $self) {
1048                                 dbg("PCPROT: Trying to route back to source, dropped") if isdbg('chanerr');
1049                                 return;
1050                         }
1051                         dbg("route: $call -> $dxchan->{call} using normal route" ) if isdbg('route');
1052                 }
1053         }
1054
1055         if ($dxchan) {
1056                 my $routeit = adjust_hops($dxchan, $line);   # adjust its hop count by node name
1057                 if ($routeit) {
1058                         $dxchan->send($routeit) unless $dxchan == $main::me;
1059                 }
1060         } else {
1061                 dbg("PCPROT: No route available, dropped") if isdbg('chanerr');
1062         }
1063 }
1064
1065 #
1066 # obtain the hops from the list for this callsign and pc no
1067 #
1068
1069 sub get_hops
1070 {
1071         my $pcno = shift;
1072         my $hops = $DXProt::hopcount{$pcno};
1073         $hops = $DXProt::def_hopcount if !$hops;
1074         return "H$hops";
1075 }
1076
1077 #
1078 # adjust the hop count on a per node basis using the user loadable
1079 # hop table if available or else decrement an existing one
1080 #
1081
1082 sub adjust_hops
1083 {
1084         my $self = shift;
1085         my $s = shift;
1086         my $call = $self->{call};
1087         my $hops;
1088
1089         if (($hops) = $s =~ /\^H([-\d]+)\^?~?$/o) {
1090                 my ($pcno) = $s =~ /^PC(\d\d)/o;
1091                 confess "$call called adjust_hops with '$s'" unless $pcno;
1092                 my $ref = $nodehops{$call} if %nodehops;
1093                 if ($ref) {
1094                         my $newhops = $ref->{$pcno};
1095                         return "" if defined $newhops && $newhops == 0;
1096                         $newhops = $ref->{default} unless $newhops;
1097                         return "" if defined $newhops && $newhops == 0;
1098                         $newhops = $hops unless $newhops;
1099                         return "" unless $newhops > 0;
1100                         $s =~ s/\^H(\d+)(\^~?)$/\^H$newhops$2/ if $newhops != $hops;
1101                 } else {
1102                         return "" unless $hops > 0;
1103                 }
1104         }
1105         return $s;
1106 }
1107
1108 #
1109 # load hop tables
1110 #
1111 sub load_hops
1112 {
1113         my $self = shift;
1114         return $self->msg('lh1') unless -e "$main::data/hop_table.pl";
1115         do "$main::data/hop_table.pl";
1116         return $@ if $@;
1117         return ();
1118 }
1119
1120 sub process_rcmd
1121 {
1122         my ($self, $tonode, $fromnode, $user, $cmd) = @_;
1123
1124         if ($tonode eq $main::mycall) {
1125                 my $ref = DXUser::get_current($fromnode);
1126                 unless ($ref && UNIVERSAL::isa($ref, 'DXUser')) {
1127                         dbg("DXProt process_rcmd: user $fromnode isn't a reference (check user_asc and tell G1TLH)"); 
1128                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1129                         return;
1130                 }
1131                 Log('rcmd', 'in', ($ref->{priv}||0), $fromnode, $cmd, $user);
1132                 my $cref = Route::Node::get($fromnode);
1133                 unless ($cref && UNIVERSAL::isa($cref, 'Route')) {
1134                         dbg("DXProt process_rcmd: Route $fromnode isn't a reference (tell G1TLH)"); 
1135                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1136                         return;
1137                 }
1138                 if ($cmd !~ /^\s*rcmd/i && $ref->homenode && $cref->call eq $ref->homenode) { # not allowed to relay RCMDS!
1139                         if ($ref->{priv}) {             # you have to have SOME privilege, the commands have further filtering
1140                                 $self->{remotecmd} = 1; # for the benefit of any command that needs to know
1141                                 my $oldpriv = $self->{priv};
1142                                 $self->{priv} = 1; # set a maximum privilege 
1143
1144                                 # park homenode and user for any spawned command that run_cmd may do.
1145                                 $self->{_rcmd_user} = $user;
1146                                 $self->{_rcmd_fromnode} = $fromnode;
1147                                 my @in = (DXCommandmode::run_cmd($self, $cmd));
1148                                 delete $self->{_rcmd_fromnode};
1149                                 delete $self->{_rcmd_user};
1150                                 $self->{priv} = $oldpriv;
1151                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, @in);
1152                                 delete $self->{remotecmd};
1153                         } else {
1154                                 $self->send_rcmd_reply($main::mycall, $fromnode, $user, "sorry...!");
1155                         }
1156                 } else {
1157                         $self->send_rcmd_reply($main::mycall, $fromnode, $user, "your attempt is logged, Tut tut tut...!");
1158                 }
1159         } else {
1160                 my $ref = DXUser::get_current($tonode);
1161                 if ($ref && $ref->is_clx) {
1162                         $self->route($tonode, pc84($fromnode, $tonode, $user, $cmd));
1163                 } else {
1164                         $self->route($tonode, pc34($fromnode, $tonode, $cmd));
1165                 }
1166         }
1167 }
1168
1169
1170 sub send_rcmd_reply
1171 {
1172         my $self = shift;
1173         my $tonode = shift;
1174         my $fromnode = shift;
1175         my $user = shift;
1176         while (@_) {
1177                 my $line = shift;
1178                 $line =~ s/\s*$//;
1179                 Log('rcmd', 'out', $fromnode, $line, $user);
1180                 if ($self->is_clx) {
1181                         $self->send(pc85($main::mycall, $fromnode, $user, "$main::mycall:$line"));
1182                 } else {
1183                         $self->send(pc35($main::mycall, $fromnode, "$main::mycall:$line"));
1184                 }
1185         }
1186 }
1187
1188 # Punt off a long running command into a separate process - this will be caused by an rcmd from outside
1189 #
1190 # This is called from commands to run some potentially long running
1191 # function. The process forks and then runs the function and returns
1192 # the result back to the cmd. 
1193 #
1194 # NOTE: this merely forks the current process and then runs the cmd in that (current) context.
1195 #       IT DOES NOT START UP SOME NEW PROGRAM AND RELIES ON THE FACT THAT IT IS RUNNING DXSPIDER 
1196 #       THE CURRENT CONTEXT!!
1197
1198 # call: $self->spawn_cmd($original_cmd_line, \<function>, [cb => sub{...}], [prefix => "cmd> "], [progress => 0|1], [args => [...]]);
1199 sub spawn_cmd
1200 {
1201         my $self = shift;
1202         my $line = shift;
1203         my $cmdref = shift;
1204         my $call = $self->{call};
1205         my %args = @_;
1206         my @out;
1207         
1208         my $cb = delete $args{cb};
1209         my $prefix = delete $args{prefix};
1210         my $progress = delete $args{progress};
1211         my $args = delete $args{args} || [];
1212         my $t0 = [gettimeofday];
1213
1214         # remembered from process_cmd when spawn_cmd was called thru DXCommandmode::run_cmd which was called by process_rcmd
1215         my $fromnode = $self->{_rcmd_fromnode};
1216         my $user = $self->{_rcmd_user};
1217
1218         no strict 'refs';
1219                 
1220         my $fc = DXSubprocess->new;
1221
1222         # just behave normally if something has set the "one-shot" _nospawn in the channel
1223         if ($self->{_nospawn}) {
1224                 eval { @out = $cmdref->(@$args); };
1225                 if ($@) {
1226                         DXDebug::dbgprintring(25);
1227                         push @out, DXDebug::shortmess($@);
1228                 }
1229                 return @out;
1230         }
1231
1232         #       $fc->serializer(\&encode_json);
1233 #       $fc->deserializer(\&decode_json);
1234         $fc->run(
1235                          sub {
1236                                  my $subpro = shift;
1237                                  if (isdbg('spawn')) {
1238                                          my $s = __PACKAGE__ . qq{ line: "$line"};
1239                                          $s .= ", args: " . join(', ', map { defined $_ ? qq{'$_'} : q{'undef'} } @$args) if $args && @$args;
1240                                          dbg($s);
1241                                  }
1242                                  eval { @out = $cmdref->(@$args); };
1243                                  if ($@) {
1244                                          DXDebug::dbgprintring(25);
1245                                          push @out, DXDebug::shortmess($@);
1246                                  }
1247                                  return @out;
1248                          },
1249 #                        $args,
1250                          sub {
1251                                  my ($fc, $err, @res) = @_; 
1252                                  my $self = DXChannel::get($call);
1253                                  return unless $self;
1254
1255                                  if ($err) {
1256                                          my $s = "DXCommand::spawn_cmd: call $call error $err";
1257                                          dbg($s) if isdbg('chan');
1258                                          if ($fromnode && $user) {
1259                                                  $self->send_rcmd_reply($main::mycall, $fromnode, $user, $s);
1260                                          } else {
1261                                                  $self->send($s);
1262                                          }
1263                                          return;
1264                                  }
1265                                  if ($cb) {
1266                                          # transform output if required
1267                                          @res = $cb->($self, @res);
1268                                  }
1269                                  if (@res) {
1270                                          if ($fromnode && $user) {
1271                                                  $self->send_rcmd_reply($main::mycall, $fromnode, $user, @res);
1272                                          } else {
1273                                                  $self->send(@res);
1274                                          }
1275                                  }
1276                                  diffms(__PACKAGE__, " rcmd from $user on $call", $line, $t0, scalar @res) if isdbg('progress');
1277                          });
1278         
1279         return @out;
1280 }
1281
1282 sub process_rcmd_reply
1283 {
1284         my ($self, $tonode, $fromnode, $user, $line) = @_;
1285         if ($tonode eq $main::mycall) {
1286                 my $s = $rcmds{$fromnode};
1287                 if ($s) {
1288                         my $dxchan = DXChannel::get($s->{call});
1289                         my $ref = $user eq $tonode ? $dxchan : (DXChannel::get($user) || $dxchan);
1290                         $ref->send($line) if $ref;
1291                         delete $rcmds{$fromnode} if !$dxchan;
1292                 } else {
1293                         # send unsolicited ones to the sysop
1294                         my $dxchan = DXChannel::get($main::myalias);
1295                         $dxchan->send($line) if $dxchan;
1296                 }
1297         } else {
1298                 my $ref = DXUser::get_current($tonode);
1299                 if ($ref && $ref->is_clx) {
1300                         $self->route($tonode, pc85($fromnode, $tonode, $user, $line));
1301                 } else {
1302                         $self->route($tonode, pc35($fromnode, $tonode, $line));
1303                 }
1304         }
1305 }
1306
1307
1308
1309 # add a rcmd request to the rcmd queues
1310 sub addrcmd
1311 {
1312         my ($self, $to, $cmd) = @_;
1313
1314         my $r = {};
1315         $r->{call} = $self->{call};
1316         $r->{t} = $main::systime;
1317         $r->{cmd} = $cmd;
1318         $rcmds{$to} = $r;
1319
1320         my $ref = Route::Node::get($to);
1321         my $dxchan = $ref->dxchan;
1322         if ($dxchan && $dxchan->is_clx) {
1323                 route(undef, $to, pc84($main::mycall, $to, $self->{call}, $cmd));
1324         } else {
1325                 route(undef, $to, pc34($main::mycall, $to, $cmd));
1326         }
1327 }
1328
1329 sub disconnect
1330 {
1331         my $self = shift;
1332         my $pc39flag = shift || 0;
1333         my $call = $self->call;
1334
1335         return if $self->{disconnecting}++;
1336
1337         unless ($pc39flag == 1) {
1338                 $self->send_now("D", DXProt::pc39($main::mycall, $self->msg('disc1', "System Op")));
1339         }
1340
1341         # get rid of any PC16/17/19
1342         eph_del_regex("^PC1[679]*$call");
1343
1344         # do routing stuff, remove me from routing table
1345         my $node = Route::Node::get($call);
1346
1347         Route::delete_interface($call);
1348
1349         # unbusy and stop and outgoing mail
1350         my $mref = DXMsg::get_busy($call);
1351         $mref->stop_msg($call) if $mref;
1352
1353         # remove outstanding pings
1354         delete $pings{$call};
1355
1356         # I was the last node visited
1357     $self->user->node($main::mycall);
1358
1359         # send info to all logged in thingies
1360         $self->tell_login('logoutn');
1361
1362         Log('DXProt', $call . " Disconnected");
1363
1364         $self->SUPER::disconnect;
1365
1366         # here we determine what needs to go out of the routing table
1367         my @rout;
1368         if ($node && $pc39flag != 2) {
1369                 dbg('%Route::Node::List = ' . join(',', sort keys %Route::Node::list)) if isdbg('routedisc');
1370
1371                 @rout = $node->del($main::routeroot);
1372
1373                 dbg('@rout = ' . join(',', sort map {$_->call} @rout)) if isdbg('routedisc');
1374
1375                 # now we need to see what can't be routed anymore and came
1376                 # in via this node (probably).
1377                 my $n = 0;
1378                 while ($n != @rout) {
1379                         $n = @rout;
1380                         for (Route::Node::get_all()) {
1381                                 unless ($_->dxchan) {
1382                                         push @rout, $_->delete;
1383                                 }
1384                         }
1385                         dbg('@rout = ' . join(',', sort map {$_->call} @rout)) if isdbg('routedisc');
1386                 }
1387
1388                 dbg('%Route::Node::List = ' . join(',', sort keys %Route::Node::list)) if isdbg('routedisc');
1389
1390                 # and all my ephemera as well
1391                 for (@rout) {
1392                         my $c = $_->call;
1393                         eph_del_regex("^PC1[679].*$c");
1394                 }
1395         }
1396
1397         # broadcast to all other nodes that all the nodes connected to via me are gone
1398         unless ($pc39flag == 2)  {
1399                 $self->route_pc21($main::mycall, undef, @rout) if @rout;
1400                 $self->route_pc92d($main::mycall, undef, $main::routeroot, $node) if $node;
1401         }
1402 }
1403
1404
1405 #
1406 # send a talk message to this thingy
1407 #
1408 sub talk
1409 {
1410         my ($self, $from, $to, $via, $line, $origin) = @_;
1411
1412         if ($self->{do_pc9x}) {
1413                 $self->send(pc93($to, $from, $via, $line));
1414         } else {
1415                 $self->send(pc10($from, $to, $via, $line, $origin));
1416         }
1417         Log('talk', $to, $from, '>' . ($via || $origin || $self->call), $line) unless $origin && $origin ne $main::mycall;
1418 }
1419
1420 # send it if it isn't the except list and isn't isolated and still has a hop count
1421 # taking into account filtering and so on
1422
1423 sub send_route
1424 {
1425         my $self = shift;
1426         my $origin = shift;
1427         my $generate = shift;
1428         my $no = shift;     # the no of things to filter on
1429         my $routeit;
1430         my ($filter, $hops);
1431         my @rin;
1432
1433         for (; @_ && $no; $no--) {
1434                 my $r = shift;
1435
1436                 # don't send messages with $self's call in back to them
1437                 if ($r->call eq $self->{call}) {
1438                         dbg("PCPROT: trying to send $self->{call} back itself") if isdbg('chanerr');
1439                         next;
1440                 }
1441
1442                 if (!$self->{isolate} && $self->{routefilter}) {
1443                         $filter = undef;
1444                         if ($r) {
1445                                 ($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});
1446                                 if ($filter) {
1447                                         push @rin, $r;
1448                                 } else {
1449                                         dbg("PCPROT: $self->{call}/" . $r->call . " rejected by output filter") if isdbg('filter');
1450                                 }
1451                         } else {
1452                                 dbg("was sent a null value") if isdbg('chanerr');
1453                         }
1454                 } else {
1455                         push @rin, $r unless $self->{isolate} && $r->call ne $main::mycall;
1456                 }
1457         }
1458         if (@rin) {
1459                 foreach my $line (&$generate(@rin, @_)) {
1460                         if ($hops) {
1461                                 $routeit = $line;
1462                                 $routeit =~ s/\^H\d+\^\~$/\^H$hops\^\~/;
1463                         } else {
1464                                 $routeit = adjust_hops($self, $line);  # adjust its hop count by node name
1465                                 next unless $routeit;
1466                         }
1467
1468                         $self->send($routeit);
1469                 }
1470         }
1471 }
1472
1473 # broadcast everywhere
1474 sub broadcast_route
1475 {
1476         my $self = shift;
1477         my $origin = shift;
1478         my $generate = shift;
1479         my $line = shift;
1480         my @dxchan = DXChannel::get_all_nodes();
1481         my $dxchan;
1482
1483         if ($line) {
1484                 $line =~ /\^H(\d+)\^?\~?$/;
1485                 return unless $1 > 0;
1486         }
1487         unless ($self->{isolate}) {
1488                 foreach $dxchan (@dxchan) {
1489                         next if $dxchan == $self || $dxchan == $main::me;
1490                         next if $origin eq $dxchan->{call};     # don't route some from this call back again.
1491                         next unless $dxchan->isa('DXProt');
1492
1493                         $dxchan->send_route($origin, $generate, @_);
1494                 }
1495         }
1496 }
1497
1498 # broadcast to non-pc9x nodes
1499 sub broadcast_route_nopc9x
1500 {
1501         my $self = shift;
1502         my $origin = shift;
1503         my $generate = shift;
1504         my $line = shift;
1505         my @dxchan = DXChannel::get_all_nodes();
1506         my $dxchan;
1507
1508         if ($line) {
1509                 $line =~ /\^H(\d+)\^?\~?$/;
1510                 return unless $1 > 0;
1511         }
1512         unless ($self->{isolate}) {
1513                 foreach $dxchan (@dxchan) {
1514                         next if $dxchan == $self || $dxchan == $main::me;
1515                         next if $origin eq $dxchan->{call};     # don't route some from this call back again.
1516                         next unless $dxchan->isa('DXProt');
1517                         next if $dxchan->{do_pc9x};
1518                         if ($generate == \&pc16 || $generate==\&pc17) {
1519                                 next unless $dxchan->user->wantsendpc16;
1520                         }
1521                         $dxchan->send_route($origin, $generate, @_);
1522                 }
1523         }
1524 }
1525
1526 # this is only used for next door nodes on init
1527 sub send_route_pc92
1528 {
1529         my $self = shift;
1530
1531         return unless $self->{do_pc9x};
1532
1533         my $origin = shift;
1534         my $generate = shift;
1535         my $no = shift;     # the no of things to filter on
1536         my $line;
1537
1538         $line = &$generate(@_);
1539         $self->send($line);
1540 }
1541
1542 # broadcast only to pc9x nodes
1543 sub broadcast_route_pc9x
1544 {
1545         my $self = shift;
1546         my $origin = shift;
1547         my $generate = shift;
1548         my $line = shift;
1549         my $no = shift;
1550         my @dxchan = DXChannel::get_all_nodes();
1551         my $dxchan;
1552
1553         if ($origin eq $main::mycall && $generate && !$line) {
1554                 $line = &$generate(@_);
1555         }
1556
1557         $line =~ /\^H(\d+)\^\~?$/;
1558         unless ($1 > 0 && $self->{isolate}) {
1559                 foreach $dxchan (@dxchan) {
1560                         next if $dxchan == $self || $dxchan == $main::me;
1561                         next if $origin eq $dxchan->{call};     # don't route some from this call back again.
1562                         next unless $dxchan->isa('DXProt');
1563                         next unless $dxchan->{do_pc9x};
1564
1565                         $dxchan->send($line);
1566                 }
1567         }
1568 }
1569
1570 sub route_pc16
1571 {
1572         my $self = shift;
1573         return unless $self->user->wantpc16;
1574         my $origin = shift;
1575         my $line = shift;
1576         broadcast_route_nopc9x($self, $origin, \&pc16, $line, 1, @_);
1577 }
1578
1579 sub route_pc17
1580 {
1581         my $self = shift;
1582         return unless $self->user->wantpc16;
1583         my $origin = shift;
1584         my $line = shift;
1585         broadcast_route_nopc9x($self, $origin, \&pc17, $line, 1, @_);
1586 }
1587
1588 sub route_pc19
1589 {
1590         my $self = shift;
1591         my $origin = shift;
1592         my $line = shift;
1593         broadcast_route_nopc9x($self, $origin, \&pc19, $line, scalar @_, @_);
1594 }
1595
1596 sub route_pc21
1597 {
1598         my $self = shift;
1599         my $origin = shift;
1600         my $line = shift;
1601         broadcast_route_nopc9x($self, $origin, \&pc21, $line, scalar @_, @_);
1602 }
1603
1604 sub route_pc24
1605 {
1606         my $self = shift;
1607         my $origin = shift;
1608         my $line = shift;
1609         broadcast_route($self, $origin, \&pc24, $line, 1, @_);
1610 }
1611
1612 sub route_pc41
1613 {
1614         my $self = shift;
1615         my $origin = shift;
1616         my $line = shift;
1617         broadcast_route($self, $origin, \&pc41, $line, 1, @_);
1618 }
1619
1620 # this is probably obsolete now
1621 sub route_pc50
1622 {
1623         my $self = shift;
1624         my $origin = shift;
1625         my $line = shift;
1626
1627         broadcast_route($self, $origin, \&pc50, $line, 1, @_);
1628 }
1629
1630 sub route_pc92c
1631 {
1632         my $self = shift;
1633         my $origin = shift;
1634         my $line = shift;
1635         broadcast_route_pc9x($self, $origin, \&pc92c, $line, 1, @_);
1636 }
1637
1638 sub route_pc92a
1639 {
1640         my $self = shift;
1641         my $origin = shift;
1642         my $line = shift;
1643         broadcast_route_pc9x($self, $origin, \&pc92a, $line, 1, @_);
1644 }
1645
1646 sub route_pc92d
1647 {
1648         my $self = shift;
1649         my $origin = shift;
1650         my $line = shift;
1651         broadcast_route_pc9x($self, $origin, \&pc92d, $line, 1, @_);
1652 }
1653
1654 sub in_filter_route
1655 {
1656         my $self = shift;
1657         my $r = shift;
1658         my ($filter, $hops) = (1, 1);
1659
1660         if ($self->{inroutefilter}) {
1661                 ($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);
1662                 dbg("PCPROT: $self->{call}/" . $r->call . ' rejected by in_filter_route') if !$filter && isdbg('chanerr');
1663         }
1664         return $filter;
1665 }
1666
1667 sub eph_dup
1668 {
1669         my $s = shift;
1670         my $t = shift || $eph_restime;
1671         my $r;
1672
1673         # chop the end off
1674         $s =~ s/\^H\d\d?\^?\~?$//;
1675         $r = 1 if exists $eph{$s};    # pump up the dup if it keeps circulating
1676         $eph{$s} = $main::systime + $t;
1677         dbg("PCPROT: emphemeral duplicate") if $r && isdbg('chanerr');
1678         return $r;
1679 }
1680
1681 sub eph_del_regex
1682 {
1683         my $regex = shift;
1684         my ($key, $val);
1685         while (($key, $val) = each %eph) {
1686                 if ($key =~ m{$regex}) {
1687                         delete $eph{$key};
1688                 }
1689         }
1690 }
1691
1692 sub eph_clean
1693 {
1694         my ($key, $val);
1695
1696         while (($key, $val) = each %eph) {
1697                 if ($main::systime >= $val) {
1698                         delete $eph{$key};
1699                 }
1700         }
1701 }
1702
1703 sub eph_list
1704 {
1705         my ($key, $val);
1706         my @out;
1707
1708         while (($key, $val) = each %eph) {
1709                 push @out, $key, $val;
1710         }
1711         return @out;
1712 }
1713
1714 sub run_cmd
1715 {
1716         goto &DXCommandmode::run_cmd;
1717 }
1718
1719
1720 # import any msgs in the chat directory
1721 # the messages are sent to the chat group which forms the
1722 # the first part of the name (eg: solar.1243.txt would be
1723 # sent to chat group SOLAR)
1724 #
1725 # Each message found is sent: one non-blank line to one chat
1726 # message. So 4 lines = 4 chat messages.
1727 #
1728 # The special name LOCAL is for local users ANN
1729 # The special name ALL is for ANN/FULL
1730 # The special name SYSOP is for ANN/SYSOP
1731 #
1732 sub import_chat
1733 {
1734         # are there any to do in this directory?
1735         return unless -d $chatimportfn;
1736         unless (opendir(DIR, $chatimportfn)) {
1737                 dbg("can\'t open $chatimportfn $!") if isdbg('msg');
1738                 Log('msg', "can\'t open $chatimportfn $!");
1739                 return;
1740         }
1741
1742         my @names = readdir(DIR);
1743         closedir(DIR);
1744         my $name;
1745         foreach $name (@names) {
1746                 next if $name =~ /^\./;
1747                 my $splitit = $name =~ /^split/;
1748                 my $fn = "$chatimportfn/$name";
1749                 next unless -f $fn;
1750                 unless (open(MSG, $fn)) {
1751                         dbg("can\'t open import file $fn $!") if isdbg('msg');
1752                         Log('msg', "can\'t open import file $fn $!");
1753                         unlink($fn);
1754                         next;
1755                 }
1756                 my @msg = map { s/\r?\n$//; $_ } <MSG>;
1757                 close(MSG);
1758                 unlink($fn);
1759
1760                 my @cat = split /\./, $name;
1761                 my $target = uc $cat[0];
1762
1763                 foreach my $text (@msg) {
1764                         next unless $text && $text !~ /^\s*#/;
1765                         if ($target eq 'ALL' || $target eq 'LOCAL' || $target eq 'SYSOP' || $target eq 'WX') {
1766                                 my $sysop = uc $target eq 'SYSOP' ? '*' : ' ';
1767                                 my $wx = uc $target eq 'WX' ? '1' : '0';
1768                                 my $via = $target;
1769                                 $via = '*' if $target eq 'ALL' || $target eq 'SYSOP';
1770                                 Log('ann', $target, $main::mycall, $text);
1771                                 $main::me->normal(DXProt::pc93($target, $main::mycall, $via, $text));
1772                         } else {
1773                                 DXCommandmode::send_chats($main::me, $target, $text);
1774                         }
1775                 }
1776         }
1777 }
1778
1779 # start a pc92 find operation
1780 sub start_pc92_find
1781 {
1782         my $dxchan = shift;
1783         my $target = shift;
1784         my $key = "$dxchan->{call}|$target";
1785         if ($pc92_find{$key}) {
1786
1787         }
1788 }
1789
1790 # function (not method) to handle pc92 find returns
1791 sub handle_pc92_find_reply
1792 {
1793         my ($dxchan, $node, $from, $target, $flag, $ms) = @_;
1794
1795         $dxchan->print_pc92_find_reply($node, $target, $flag, $ms) if $dxchan->can('print_pc92_find_return');
1796 }
1797
1798 sub clean_pc92_find
1799 {
1800
1801 }
1802
1803
1804
1805 1;
1806 __END__