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