2 # The RBN connection system
4 # Copyright (c) 2020 Dirk Koopman G1TLH
19 use Math::Round qw(nearest);
21 use Time::HiRes qw(clock_gettime CLOCK_REALTIME);
24 our @ISA = qw(DXChannel);
26 our $startup_delay = 5*60; # don't send anything out until this timer has expired
27 # this is to allow the feed to "warm up" with duplicates
28 # so that the "big rush" doesn't happen.
30 our $minspottime = 60*60; # the time between respots of a callsign - if a call is
31 # still being spotted (on the same freq) and it has been
32 # spotted before, it's spotted again after this time
33 # until the next minspottime has passed.
35 our $beacontime = 5*60; # same as minspottime, but for beacons (and shorter)
37 our $dwelltime = 6; # the amount of time to wait for duplicates before issuing
38 # a spot to the user (no doubt waiting with bated breath).
40 our $filterdef = $Spot::filterdef; # we use the same filter as the Spot system. Can't think why.
44 my $self = DXChannel::alloc(@_);
46 # routing, this must go out here to prevent race condx
50 DXProt::_add_thingy($main::routeroot, [$call, 0, 0, 1, undef, undef, $self->hostname], );
58 $self->{lasttime} = $main::systime;
59 $self->{minspottime} = $minspottime;
60 $self->{beacontime} = $beacontime;
61 $self->{showstats} = 0;
68 my ($self, $line, $sort) = @_;
69 my $user = $self->{user};
70 my $call = $self->{call};
71 my $name = $user->{name};
72 my $dref = $self->{d};
73 my $spotref = $self->{spot};
76 my $host = $self->{conn}->peerhost;
78 $self->{hostname} = $host;
80 $self->{name} = $name ? $name : $call;
81 $self->state('prompt'); # a bit of room for further expansion, passwords etc
82 $self->{lang} = $user->lang || $main::lang || 'en';
83 if ($line =~ /host=/) {
84 my ($h) = $line =~ /host=(\d+\.\d+\.\d+\.\d+)/;
85 $line =~ s/\s*host=\d+\.\d+\.\d+\.\d+// if $h;
87 ($h) = $line =~ /host=([\da..fA..F:]+)/;
88 $line =~ s/\s*host=[\da..fA..F:]+// if $h;
90 $self->{hostname} = $h if $h;
92 $self->{width} = 80 unless $self->{width} && $self->{width} > 80;
93 $self->{consort} = $line; # save the connection type
95 LogDbg('DXCommand', "$call connected from $self->{hostname}");
97 # set some necessary flags on the user if they are connecting
98 $self->{registered} = 1;
99 # sort out privilege reduction
104 $nossid =~ s/-\d+$//;
106 $self->{spotsfilter} = Filter::read_in('spots', $call, 0)
107 || Filter::read_in('spots', $nossid, 0)
108 || Filter::read_in('spots', 'user_default', 0);
110 # clean up qra locators
111 my $qra = $user->qra;
112 $qra = undef if ($qra && !DXBearing::is_qra($qra));
114 my $lat = $user->lat;
115 my $long = $user->long;
116 $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);
120 $self->{inrushpreventor} = $main::systime + $startup_delay;
123 my @queue; # the queue of spots ready to send
130 my $spots = $self->{spot};
132 # save this for them's that need it
135 # remove leading and trailing spaces
142 my $tim = $main::systime;
145 dbg "RBN:RAW,$line" if isdbg('rbnraw');
146 return unless $line=~/^DX\s+de/;
148 my (undef, undef, $origin, $qrg, $call, $mode, $s, $m, $spd, $u, $sort, $t, $tx) = split /[:\s]+/, $line;
150 # fix up FT8 spots from 7001
151 $t = $u, $u = '' if !$t && is_ztime($u);
152 $t = $sort, $sort = '' if !$t && is_ztime($sort);
153 my $qra = $spd, $spd = '' if is_qra($spd);
156 $origin =~ s/\-(?:\d{1,2}\-)?\#$//; # get rid of all the crap we aren't interested in
162 dbg qq{or:$origin qr:$qrg ca:$call mo:$mode s:$s m:$m sp:$spd u:$u sort:$sort t:$t tx:$tx qra:$qra} if isdbg('rbn');
169 # fix up times for things like 'NXDXF B' etc
170 if ($tx && is_ztime($t)) {
179 if ($sort && $sort eq 'NCDXF') {
183 if ($sort && $sort eq 'BEACON') {
186 if ($mode =~ /^PSK/) {
189 if ($mode eq 'RTTY') {
193 # The main de-duping key is [call, $frequency], but we probe a bit around that frequency to find a
194 # range of concurrent frequencies that might be in play.
196 # The key to this is deducing the true callsign by "majority voting" (the greater the number of spotters
197 # the more effective this is) together with some lexical analsys probably in conjuction with DXSpider
198 # data sources (for singleton spots) to then generate a "centre" from and to zone (whatever that will mean if it isn't the usual one)
199 # and some heuristical "Kwalitee" rating given distance from the zone centres of spotter, recipient user
200 # and spotted. A map can be generated once per user and spotter as they are essentially mostly static.
201 # The spotted will only get a coarse position unless other info is available. Programs that parse
202 # DX bulletins and the online data online databases could be be used and then cached.
204 # Obviously users have to opt in to receiving RBN spots and other users will simply be passed over and
207 # Clearly this will only work in the 'mojo' branch of DXSpider where it is possible to pass off external
208 # data requests to ephemeral or semi resident forked processes that do any grunt work and the main
209 # process to just the standard "message passing" which has been shown to be able to sustain over 5000
210 # per second (limited by the test program's output and network speed, rather than DXSpider's handling).
212 my $nqrg = nearest(1, $qrg); # normalised to nearest Khz
213 my $sp = "$call|$nqrg"; # hopefully the skimmers will be calibrated at least this well!
214 my $spp = sprintf("$call|%d", $nqrg+1); # but, clearly, my hopes are rudely dashed
215 my $spm = sprintf("$call|%d", $nqrg-1); # in BOTH directions!
218 my $spot = $spots->{$sp};
219 $spot = $spots->{$spp}, $sp = $spp, dbg(qq{RBN: SPP using $spp for $sp}) if !$spot && exists $spots->{$spp};
220 $spot = $spots->{$spm}, $sp = $spm, dbg(qq{RBN: SPM using $spm for $sp}) if !$spot && exists $spots->{$spm};
223 # if we have one and there is only one slot and that slot's time isn't expired for respot then return
225 if ($spot && ref $spot) {
227 unless ($self->{minspottime} > 0 && $tim - $spot->[0] >= $self->{minspottime}) {
228 dbg("RBN: key: '$sp' call: $call qrg: $qrg DUPE \@ ". atime(int $spot->[0])) if isdbg('rbn');
232 dbg("RBN: key: '$sp' RESPOTTING call: $call qrg: $qrg last seen \@ ". atime(int $spot->[0])) if isdbg('rbn');
233 undef $spot; # it's about to be recreated (in one place)
237 # otherwise we have a spot being built up at the moment
239 dbg("RBN: key '$sp' = '$spot' not ref");
243 # here we either have an existing spot record buildup on the go, or we need to create the first one
245 $spots->{$sp} = $spot = [clock_gettime(CLOCK_REALTIME)];;
246 dbg("RBN: key: '$sp' call: $call qrg: $qrg NEW" . $respot ? ' RESPOT' : '') if isdbg('rbn');
249 # add me to the display queue unless we are waiting for initial in rush to finish
250 return unless $self->{inrushpreventor} < $main::systime;
251 push @{$self->{queue}}, $sp if @$spot == 1; # queue the KEY (not the record)
253 # build up a new record and store it in the buildup
254 # deal with the unix time
255 my ($hh,$mm) = $t =~ /(\d\d)(\d\d)Z$/;
256 my $utz = $hh*3600 + $mm*60 + $main::systime_daystart; # possible issue with late spot from previous day
257 $utz -= 86400 if $utz > $tim+3600; # too far ahead, drag it back one day
259 # create record and add into the buildup
260 my $r = [$origin, nearest(.1, $qrg), $call, $mode, $s, $t, $utz, $respot, $u];
261 dbg("RBN: key: '$sp' ADD RECORD call: $call qrg: $qrg origin: $origin") if isdbg('rbn');
262 my @s = Spot::prepare($r->[1], $r->[2], $r->[6], '', $r->[0]);
267 # At this point we run the queue to see if anything can be sent onwards to the punter
268 my $now = clock_gettime(CLOCK_REALTIME);
270 # now run the waiting queue which just contains KEYS ($call|$qrg)
271 foreach $sp (@{$self->{queue}}) {
272 my $cand = $spots->{$sp};
273 unless ($cand && $cand->[0]) {
274 dbg "RBN Cand " . ($cand ? 'def' : 'undef') . " [0] " . ($cand->[0] ? 'def' : 'undef') . " dwell $dwelltime";
277 if ($now >= $cand->[0] + $dwelltime ) {
278 # we have a candidate, create qualitee value(s);
279 unless (@$cand > 1) {
280 dbg "RBN: QUEUE key '$sp' MISSING RECORDS " . dd($cand) if isdbg 'rbn';
281 shift @{$self->{queue}};
284 my $savedtime = shift @$cand; # save the start time
286 my $quality = @$cand;
287 $quality = 9 if $quality > 9;
288 $quality = "Q:$quality";
289 if (isdbg('progress')) {
290 my $s = "RBN: SPOT key: '$sp' = $r->[2] on $r->[1] \@ $r->[5] $quality";
291 $s .= " route: $self->{call}";
295 send_dx_spot($self, $quality, $cand);
297 # clear out the data and make this now just "spotted", but no further action required until respot time
298 dbg "RBN: QUEUE key '$sp' cleared" if isdbg 'rbn';
300 $spots->{$sp} = [$savedtime];
301 shift @{$self->{queue}};
303 dbg sprintf("RBN: QUEUE key: '$sp' SEND time not yet reached %.1f secs left", $spot->[0] + $dwelltime - $now) if isdbg 'rbnqueue';
309 dbg "RBN:DATA,$line" if isdbg('rbn');
312 # # periodic clearing out of the two caches
313 if (($tim % 60 == 0 && $tim > $self->{last}) || ($self->{last} && $tim >= $self->{last} + 60)) {
316 while (my ($k,$v) = each %{$spots}) {
317 if ($tim - $v->[0] > $self->{minspottime}*2) {
325 dbg "RBN:ADMIN,$self->{call},spot cache remain: $count removed: $removed"; # if isdbg('rbn');
326 dbg "RBN:" . join(',', "STAT", $self->{noraw}, $self->{norbn}, $self->{nospot}) if $self->{showstats};
327 $self->{noraw} = $self->{norbn} = $self->{nospot} = 0;
328 $self->{last} = int($tim / 60) * 60;
337 # we should get the spot record minus the time, so just an array of record (arrays)
344 # $r = [$origin, $qrg, $call, $mode, $s, $utz, $respot];
346 my $mode = $spot->[0]->[3]; # as all the modes will be the same;
348 my @dxchan = DXChannel::get_all();
350 foreach my $dxchan (@dxchan) {
351 next unless $dxchan->is_user;
352 my $user = $dxchan->{user};
353 next unless $user && $user->wantrbn;
355 # does this user want this sort of spot at all?
357 ++$want if $user->wantbeacon && $mode =~ /^BCN|DXF/;
358 ++$want if $user->wantcw && $mode =~ /^CW/;
359 ++$want if $user->wantrtty && $mode =~ /^RTT/;
360 ++$want if $user->wantpsk && $mode =~ /^PSK/;
361 ++$want if $user->wantcw && $mode =~ /^CW/;
362 ++$want if $user->wantft && $mode =~ /^FT/;
363 ++$want unless $want; # send everything if nothing is selected.
367 # send one spot to one user out of the ones that we have
368 $self->dx_spot($dxchan, $quality, $spot) if $want;
379 my $strength = 100; # because it could if we talk about FTx
387 foreach my $r (@$spot) {
388 # $r = [$origin, $qrg, $call, $mode, $s, $t, $utz, $respot, $qra];
389 # Spot::prepare($qrg, $call, $utz, $comment, $origin);
391 my $comment = sprintf "%-3s %2ddB $quality", $r->[3], $r->[4];
392 $respot = 1 if $r->[7];
393 $qra = $r->[8] if !$qra && $r->[8] && is_qra($r->[8]);
395 my $s = $r->[9]; # the prepared spot
396 $s->[3] = $comment; # apply new generated comment
399 ++$zone{$s->[11]}; # save the spotter's zone
400 ++$qrg{$s->[0]}; # and the qrg
405 if ($dxchan->{rbnfilter}) {
406 ($filter, undef) = $dxchan->{rbnfilter}->it($s);
409 dbg("RBN: FILTERED call: $s->[1] qrg: $s->[0] origin: $s->[4] dB: $r->[4]") if isdbg 'rbn';
413 # save the lowest strength one
414 if ($r->[4] < $strength) {
417 dbg("RBN: STRENGTH call: $s->[1] qrg: $s->[0] origin: $s->[4] dB: $r->[4]") if isdbg 'rbn';
423 # create a zone list of spotters
424 delete $zone{$saver->[11]}; # remove this spotter's zone (leaving all the other zones)
425 my $z = join ',', sort {$a <=> $b} keys %zone;
427 # determine the most likely qrg and then set it
431 while (my ($k, $v) = each %qrg) {
432 $fk = $k, $mv = $v if $v > $mv;
436 $saver->[3] .= '*' if $c > 1;
437 $saver->[3] .= '+' if $respot;
438 $saver->[3] .= " Z:$z" if $z;
440 dbg("RBN: SENDING call: $saver->[1] qrg: $saver->[0] origin: $saver->[4] $saver->[3]") if isdbg 'rbn';
441 if ($dxchan->{ve7cc}) {
442 my $call = $saver->[1];
444 $buf = VE7CC::dx_spot($dxchan, @$saver);
447 $buf = $dxchan->format_dx_spot(@$saver);
450 $dxchan->local_send('N', $buf);
453 my $user = DXUser::get_current($saver->[1]) || DXUser->new($saver->[1]);
454 unless ($user->qra && is_qra($user->qra)) {
456 dbg("RBN: update qra on $saver->[1] to $qra");