fix console.pl
[spider.git] / perl / RBN.pm
index 492b1ac5331d68cddae9939c37e380595537ad45..bb64330bc06ef9bfa33e94c5887b2fb3467f8653 100644 (file)
@@ -19,21 +19,29 @@ use DXChannel;
 use Math::Round qw(nearest);
 use Date::Parse;
 use Time::HiRes qw(clock_gettime CLOCK_REALTIME);
+use Spot;
 
 our @ISA = qw(DXChannel);
 
-our $startup_delay =0;#3*60;           # don't send anything out until this timer has expired
+our $startup_delay = 5*60;             # don't send anything out until this timer has expired
                                 # this is to allow the feed to "warm up" with duplicates
-                                # so that the "big rush" doesn't happen. 
+                                # so that the "big rush" doesn't happen.
 
 our $minspottime = 60*60;              # the time between respots of a callsign - if a call is
                                 # still being spotted (on the same freq) and it has been
                                 # spotted before, it's spotted again after this time
                                 # until the next minspottime has passed.
 
+our $beacontime = 5*60;                        # same as minspottime, but for beacons (and shorter)
+
 our $dwelltime = 6;                    # the amount of time to wait for duplicates before issuing
                                 # a spot to the user (no doubt waiting with bated breath).
 
+our $filterdef = $Spot::filterdef; # we use the same filter as the Spot system. Can't think why :-).
+
+my $spots;                                             # the GLOBAL spot cache
+
+my %runtime;                                   # how long each channel has been running
 
 sub new 
 {
@@ -43,17 +51,27 @@ sub new
        my $pkg = shift;
        my $call = shift;
 
-       DXProt::_add_thingy($main::routeroot, [$call, 0, 0, 1, undef, undef, $self->hostname], );
-       $self->{d} = {};
-       $self->{spot} = {};
+       $spots ||= {};
        $self->{last} = 0;
        $self->{noraw} = 0;
        $self->{nospot} = 0;
+       $self->{nouser} = {};
        $self->{norbn} = 0;
+       $self->{noraw10} = 0;
+       $self->{nospot10} = 0;
+       $self->{nouser10} = {};
+       $self->{norbn10} = 0;
+       $self->{nospothour} = 0;
+       $self->{nouserhour} = {};
+       $self->{norbnhour} = 0;
+       $self->{norawhour} = 0;
        $self->{sort} = 'N';
        $self->{lasttime} = $main::systime;
        $self->{minspottime} = $minspottime;
+       $self->{beacontime} = $beacontime;
        $self->{showstats} = 0;
+       $self->{pingint} = 0;
+       $self->{nopings} = 0;
 
        return $self;
 }
@@ -64,8 +82,6 @@ sub start
        my $user = $self->{user};
        my $call = $self->{call};
        my $name = $user->{name};
-       my $dref = $self->{d};
-       my $spotref = $self->{spot};
                
        # log it
        my $host = $self->{conn}->peerhost;
@@ -82,7 +98,10 @@ sub start
                        ($h) = $line =~ /host=([\da..fA..F:]+)/;
                        $line =~ s/\s*host=[\da..fA..F:]+// if $h;
                }
-               $self->{hostname} = $h if $h;
+               if ($h) {
+                       $h =~ s/^::ffff://;
+                       $self->{hostname} = $h;
+               }
        }
        $self->{width} = 80 unless $self->{width} && $self->{width} > 80;
        $self->{consort} = $line;       # save the connection type
@@ -97,11 +116,10 @@ sub start
        # get the filters
        my $nossid = $call;
        $nossid =~ s/-\d+$//;
-       
-       $self->{spotsfilter} = Filter::read_in('spots', $call, 0) 
-               || Filter::read_in('spots', $nossid, 0)
-                       || Filter::read_in('spots', 'user_default', 0);
 
+       $self->{inrbnfilter} = Filter::read_in('rbn', $call, 1) 
+               || Filter::read_in('rbn', 'node_default', 1);
+       
        # clean up qra locators
        my $qra = $user->qra;
        $qra = undef if ($qra && !DXBearing::is_qra($qra));
@@ -111,8 +129,8 @@ sub start
                $user->qra(DXBearing::lltoqra($lat, $long)) if (defined $lat && defined $long);  
        }
 
-       # start inrush timer
-       $self->{inrushpreventor} = $main::systime + $startup_delay;
+       # if we have been running and stopped for a while 
+       $self->{inrushpreventor} = exists $runtime{$call} && $runtime{$call} > $startup_delay ? 0 : $main::systime + $startup_delay;
 }
 
 my @queue;                                             # the queue of spots ready to send
@@ -122,7 +140,7 @@ sub normal
        my $self = shift;
        my $line = shift;
        my @ans;
-       my $spots = $self->{spot};
+#      my $spots = $self->{spot};
        
        # save this for them's that need it
        my $rawline = $line;
@@ -156,6 +174,9 @@ sub normal
        $qra ||= '';
     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');
 
+       ++$self->{noraw};
+       ++$self->{noraw10};
+       ++$self->{norawhour};
        
        my $b;
        
@@ -184,20 +205,9 @@ sub normal
                if ($mode eq 'RTTY') {
                        $mode = 'RTT';
                }
-               
-               # We have an RBN data line, dedupe it very simply on time, ignore QRG completely.
-               # This works because the skimmers are NTP controlled (or should be) and will receive
-               # the spot at the same time (velocity factor of the atmosphere and network delays
-               # carefully (not) taken into account :-)
 
-               # Note, there is no intelligence here, but there are clearly basic heuristics that could
-               # be applied at this point that reject (more likely rewrite) the call of a busted spot that would
-               # useful for a zonal hotspot requirement from the cluster node.
-
-               # In reality, this mechanism would be incorporated within the cluster code, utilising the dxqsl database,
-               # and other resources in DXSpider, thus creating a zone map for an emitted spot. This is then passed through the
-               # normal "to-user" spot system (where normal spots are sent to be displayed per user) and then be
-               # processed through the normal, per user, spot filtering system - like a regular spot.
+               # The main de-duping key is [call, $frequency], but we probe a bit around that frequency to find a
+               # range of concurrent frequencies that might be in play. 
 
                # The key to this is deducing the true callsign by "majority voting" (the greater the number of spotters
         # the more effective this is) together with some lexical analsys probably in conjuction with DXSpider
@@ -215,33 +225,46 @@ sub normal
                # process to just the standard "message passing" which has been shown to be able to sustain over 5000 
                # per second (limited by the test program's output and network speed, rather than DXSpider's handling).
 
-               my $nqrg = nearest(.5, $qrg);  # normalised to nearest Khz
+               my $nqrg = nearest(1, $qrg);  # normalised to nearest Khz
                my $sp = "$call|$nqrg";           # hopefully the skimmers will be calibrated at least this well!
+               my $spp = sprintf("$call|%d", $nqrg+1); # but, clearly, my hopes are rudely dashed
+               my $spm = sprintf("$call|%d", $nqrg-1); # in BOTH directions!
 
                # do we have it?
                my $spot = $spots->{$sp};
+               $spot = $spots->{$spp}, $sp = $spp, dbg(qq{RBN: SPP using $spp for $sp}) if isdbg('rbn') && !$spot && exists $spots->{$spp};
+               $spot = $spots->{$spm}, $sp = $spm, dbg(qq{RBN: SPM using $spm for $sp}) if isdbg('rbn') && !$spot && exists $spots->{$spm};
+               
 
                # if we have one and there is only one slot and that slot's time isn't expired for respot then return
                my $respot = 0;
-               if ($spot && @$spot == 1) {
-                       unless ($self->{minspottime} > 0 && $tim - $spot->[0] >= $self->{minspottime}) {
-                               dbg("RBN: key: '$sp' call: $call qrg: $qrg DUPE \@ ". atime(int $spot->[0])) if isdbg('rbn');
-                               return;
+               if ($spot && ref $spot) {
+                       if (@$spot == 1) {
+                               unless ($self->{minspottime} > 0 && $tim - $spot->[0] >= $self->{minspottime}) {
+                                       dbg("RBN: key: '$sp' call: $call qrg: $qrg DUPE \@ ". atime(int $spot->[0])) if isdbg('rbn');
+                                       return;
+                               }
+                               
+                               dbg("RBN: key: '$sp' RESPOTTING call: $call qrg: $qrg last seen \@ ". atime(int $spot->[0])) if isdbg('rbn');
+                               undef $spot;    # it's about to be recreated (in one place)
+                               ++$respot;
                        }
-                       dbg("RBN: key: '$sp' RESPOTTING call: $call qrg: $qrg last seen \@ ". atime(int $spot->[0])) if isdbg('rbn');
-                       ++$respot;
+
+                       # otherwise we have a spot being built up at the moment
+               } elsif ($spot) {
+                       dbg("RBN: key '$sp' = '$spot' not ref");
+                       return;
                }
 
                # here we either have an existing spot record buildup on the go, or we need to create the first one
                unless ($spot) {
-                       $spot = [clock_gettime(CLOCK_REALTIME)];
-                       $spots->{$sp} = $spot;
-                       dbg("RBN: key: '$sp' call: $call qrg: $qrg NEW") if isdbg('rbn');
+                       $spots->{$sp} = $spot = [clock_gettime(CLOCK_REALTIME)];;
+                       dbg("RBN: key: '$sp' call: $call qrg: $qrg NEW" . $respot ? ' RESPOT' : '') if isdbg('rbn');
                }
 
                # add me to the display queue unless we are waiting for initial in rush to finish
                return unless $self->{inrushpreventor} < $main::systime;
-               push @queue, $sp if @$spot == 1; # queue the KEY (not the record)
+               push @{$self->{queue}}, $sp if @$spot == 1; # queue the KEY (not the record)
 
                # build up a new record and store it in the buildup
                # deal with the unix time
@@ -250,8 +273,14 @@ sub normal
                $utz -= 86400 if $utz > $tim+3600;                                         # too far ahead, drag it back one day
 
                # create record and add into the buildup
-               my $r = [$origin, nearest(.1, $qrg), $call, $mode, $s, $t, $utz, $respot];
+               my $r = [$origin, nearest(.1, $qrg), $call, $mode, $s, $t, $utz, $respot, $u];
                dbg("RBN: key: '$sp' ADD RECORD call: $call qrg: $qrg origin: $origin") if isdbg('rbn');
+               my @s =  Spot::prepare($r->[1], $r->[2], $r->[6], '', $r->[0]);
+               if ($self->{inrbnfilter}) {
+                       my ($want, undef) = $self->{inrbnfilter}->it($s);
+                       next unless $want;      
+               }
+               $r->[9] = \@s;
 
                push @$spot, $r;
 
@@ -259,13 +288,17 @@ sub normal
                my $now = clock_gettime(CLOCK_REALTIME);
 
                # now run the waiting queue which just contains KEYS ($call|$qrg)
-               foreach $sp (@queue) {
+               foreach $sp (@{$self->{queue}}) {
                        my $cand = $spots->{$sp};
-                       if ($now >= $cand->[0]+$dwelltime ) {
+                       unless ($cand && $cand->[0]) {
+                               dbg "RBN Cand " . ($cand ? 'def' : 'undef') . " [0] " . ($cand->[0] ? 'def' : 'undef') . " dwell $dwelltime";
+                               next;
+                       } 
+                       if ($now >= $cand->[0] + $dwelltime ) {
                                # we have a candidate, create qualitee value(s);
                                unless (@$cand > 1) {
                                        dbg "RBN: QUEUE key '$sp' MISSING RECORDS " . dd($cand) if isdbg 'rbn';
-                                       shift @queue;
+                                       shift @{$self->{queue}};
                                        next;
                                }
                                my $savedtime = shift @$cand; # save the start time
@@ -274,7 +307,7 @@ sub normal
                                $quality = 9 if $quality > 9;
                                $quality = "Q:$quality";
                                if (isdbg('progress')) {
-                                       my $s = "RBN: SPOT key: '$sp' = $r->[2] on $r->[1] \@ $r->[5] $quality";
+                                       my $s = "RBN: SPOT key: '$sp' = $r->[2] on $r->[1] by $r->[0] \@ $r->[5] $quality";
                                        $s .=  " route: $self->{call}";
                                        dbg($s);
                                }
@@ -283,42 +316,61 @@ sub normal
                                
                                # clear out the data and make this now just "spotted", but no further action required until respot time
                                dbg "RBN: QUEUE key '$sp' cleared" if isdbg 'rbn';
+                               
                                $spots->{$sp} = [$savedtime];
-                               shift @queue;
+                               shift @{$self->{queue}};
                        } else {
                                dbg sprintf("RBN: QUEUE key: '$sp' SEND time not yet reached %.1f secs left", $spot->[0] + $dwelltime - $now) if isdbg 'rbnqueue'; 
                        }
                }
-               
-
        } else {
                dbg "RBN:DATA,$line" if isdbg('rbn');
        }
+}
 
-       #       # periodic clearing out of the two caches
-       if (($tim % 60 == 0 && $tim > $self->{last}) || ($self->{last} && $tim >= $self->{last} + 60)) {
-               my $count = 0;
-               my $removed = 0;
-               while (my ($k,$v) = each %{$spots}) {
-                       if ($tim - $v->[0] > $self->{minspottime}*2) {
-                               delete $spots->{$k};
-                               ++$removed;
-                       }
-                       else {
-                               ++$count;
-                       }
+sub per_minute
+{
+       foreach my $dxchan (DXChannel::get_all()) {
+               next unless $dxchan->is_rbn;
+               dbg "RBN:STATS minute $dxchan->{call} raw: $dxchan->{noraw} sent: $dxchan->{norbn} delivered: $dxchan->{nospot} users: " . scalar keys %{$dxchan->{nousers}} if isdbg('rbnstats');
+               if ($dxchan->{noraw} == 0 && $dxchan->{lasttime} > 60) {
+                       LogDbg('RBN', "RBN: no input from $dxchan->{call}, disconnecting");
+                       $dxchan->disconnect;
                }
-               dbg "RBN:ADMIN,spot cache: $removed removed $count remain"; # if isdbg('rbn');
-               dbg "RBN:" . join(',', "STAT", $self->{noraw}, $self->{norbn}, $self->{nospot}) if $self->{showstats};
-               $self->{noraw} = $self->{norbn} = $self->{nospot} = 0;
-               $self->{last} = int($tim / 60) * 60;
+               $dxchan->{noraw} = $dxchan->{norbn} = $dxchan->{nospot} = 0; $dxchan->{nousers} = {};
+               $runtime{$dxchan->{call}} += 60;
        }
 }
 
+sub per_10_minute
+{
+       my $count = 0;
+       my $removed = 0;
+       while (my ($k,$v) = each %{$spots}) {
+               if ($main::systime - $v->[0] > $minspottime*2) {
+                       delete $spots->{$k};
+                       ++$removed;
+               }
+               else {
+                       ++$count;
+               }
+       }
+       dbg "RBN:STATS spot cache remain: $count removed: $removed"; # if isdbg('rbn');
+       foreach my $dxchan (DXChannel::get_all()) {
+               next unless $dxchan->is_rbn;
+               dbg "RBN:STATS 10-minute $dxchan->{call} raw: $dxchan->{noraw10} sent: $dxchan->{norbn10} delivered: $dxchan->{nospot10} users: " . scalar keys %{$dxchan->{nousers10}};
+               $dxchan->{noraw10} = $dxchan->{norbn10} = $dxchan->{nospot10} = 0; $dxchan->{nousers10} = {};
+       }
+}
 
-
-#      }
-# }
+sub per_hour
+{
+       foreach my $dxchan (DXChannel::get_all()) {
+               next unless $dxchan->is_rbn;
+               dbg "RBN:STATS hour $dxchan->{call} raw: $dxchan->{norawhour} sent: $dxchan->{norbnhour} delivered: $dxchan->{nospothour} users: " . scalar keys %{$dxchan->{nousershour}};
+               $dxchan->{norawhour} = $dxchan->{norbnhour} = $dxchan->{nospothour} = 0; $dxchan->{nousershour} = {};
+       }
+}
 
 # we should get the spot record minus the time, so just an array of record (arrays)
 sub send_dx_spot
@@ -327,6 +379,10 @@ sub send_dx_spot
        my $quality = shift;
        my $spot = shift;
 
+       ++$self->{norbn};
+       ++$self->{norbn10};
+       ++$self->{norbnhour};
+       
        # $r = [$origin, $qrg, $call, $mode, $s, $utz, $respot];
 
        my $mode = $spot->[0]->[3]; # as all the modes will be the same;
@@ -361,53 +417,102 @@ sub dx_spot
        my $dxchan = shift;
        my $quality = shift;
        my $spot = shift;
+       my $call = $dxchan->{call};
+       
 
        my $strength = 100;             # because it could if we talk about FTx
        my $saver;
 
        my %zone;
+       my %qrg;
+       my $respot;
+       my $qra;
+
+       ++$self->{nousers}->{$call};
+       ++$self->{nousers10}->{$call};
+       ++$self->{nousershour}->{$call};
        
        foreach my $r (@$spot) {
-               # $r = [$origin, $qrg, $call, $mode, $s, $t, $utz, $respot];
+               # $r = [$origin, $qrg, $call, $mode, $s, $t, $utz, $respot, $qra];
                # Spot::prepare($qrg, $call, $utz, $comment, $origin);
 
                my $comment = sprintf "%-3s %2ddB $quality", $r->[3], $r->[4];
-               my @s =  Spot::prepare($r->[1], $r->[2], $r->[6], $comment, $r->[0]);
+               $respot = 1 if $r->[7];
+               $qra = $r->[8] if !$qra && $r->[8] && is_qra($r->[8]);
 
-               ++$zone{$s[11]};                # save the spotter's zone
+               my $s = $r->[9];                # the prepared spot
+               $s->[3] = $comment;             # apply new generated comment
                
-               # save the highest strength one
-               if ($r->[4] < $strength) {
-                       $strength = $r->[4];
-                       $saver = \@s;
-                       dbg("RBN: STRENGTH call: $s[1] qrg: $s[0] origin: $s[4] dB: $r->[4]") if isdbg 'rbn';
-               }
-               my $filter = 0;
+               
+               ++$zone{$s->[11]};              # save the spotter's zone
+               ++$qrg{$s->[0]};                # and the qrg
 
-               if ($dxchan->{rbnfilter}) {
-                       ($filter, undef) = $dxchan->{rbnfilter}->it(\@s);
-                       next unless $filter;
-                       $saver = \@s;
-                       dbg("RBN: FILTERED call: $s[1] qrg: $s[0] origin: $s[4] dB: $r->[4]") if isdbg 'rbn';
+               my $want = 0;
+               my $rf = $dxchan->{rbnfilter} || $dxchan->{spotsfilter};
+               if ($rf) {
+                       ($want, undef) = $rf->it($s);
+                       next unless $want;
+                       $saver = $s;
+                       dbg("RBN: FILTERED call: $s->[1] qrg: $s->[0] origin: $s->[4] dB: $r->[4]") if isdbg 'rbn';
                        last;
                }
 
+               # save the lowest strength one
+               if ($r->[4] < $strength) {
+                       $strength = $r->[4];
+                       $saver = $s;
+                       dbg("RBN: STRENGTH call: $s->[1] qrg: $s->[0] origin: $s->[4] dB: $r->[4]") if isdbg 'rbn';
+               }
        }
 
        if ($saver) {
                my $buf;
+               # create a zone list of spotters
                delete $zone{$saver->[11]};  # remove this spotter's zone (leaving all the other zones)
                my $z = join ',', sort {$a <=> $b} keys %zone;
-               $saver->[3] .= " Z:$z" if length $z;
+
+               # determine the most likely qrg and then set it
+               my $mv = 0;
+               my $fk;
+               my $c = 0;
+               while (my ($k, $v) = each %qrg) {
+                       $fk = $k, $mv = $v if $v > $mv;
+                       ++$c;
+               }
+               $saver->[0] = $fk;
+               $saver->[3] .= '*' if $c > 1;
+               $saver->[3] .= '+' if $respot;
+               $saver->[3] .= " Z:$z" if $z;
+               
                dbg("RBN: SENDING call: $saver->[1] qrg: $saver->[0] origin: $saver->[4] $saver->[3]") if isdbg 'rbn';
                if ($dxchan->{ve7cc}) {
+                       my $call = $saver->[4];
+                       $saver->[4] .= '-#';
                        $buf = VE7CC::dx_spot($dxchan, @$saver);
+                       $saver->[4] = $call;
                } else {
+                       my $call = $saver->[4];
+                       $saver->[4] = substr($call, 0, 6);
+                       $saver->[4] .= '-#';
                        $buf = $dxchan->format_dx_spot(@$saver);
+                       $saver->[4] = $call;
                }
-               $buf =~ s/^DX/RB/;
+#              $buf =~ s/^DX/RB/;
                $dxchan->local_send('N', $buf);
+
+               ++$self->{nospot};
+               ++$self->{nospot10};
+               ++$self->{nospothour};
+               
+               if ($qra) {
+                       my $user = DXUser::get_current($saver->[1]) || DXUser->new($saver->[1]);
+                       unless ($user->qra && is_qra($user->qra)) {
+                               $user->qra($qra);
+                               dbg("RBN: update qra on $saver->[1] to $qra");
+                               $user->put;
+                       }
+               }
        }
 }