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