fix ann filtering
[spider.git] / perl / Spot.pm
index 00b03d845e0cd35ff933f4a595c27dc7c89a4bc7..420025e6ed8f0d1445f5fd8ec5cfc85e1ce9a275 100644 (file)
 
 package Spot;
 
-use FileHandle;
+use IO::File;
 use DXVars;
 use DXDebug;
 use DXUtil;
+use DXLog;
 use Julian;
 use Prefix;
-use Carp;
-
-@ISA = qw(Julian);
+use DXDupe;
+use Data::Dumper;
 
 use strict;
-use vars qw($fp $maxspots $defaultspots $maxdays $dirprefix);
+
+use vars qw($VERSION $BRANCH);
+$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
+$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
+$main::build += $VERSION;
+$main::branch += $BRANCH;
+
+use vars qw($fp $statp $maxspots $defaultspots $maxdays $dirprefix $duplth $dupage $filterdef);
 
 $fp = undef;
-$maxspots = 50;      # maximum spots to return
-$defaultspots = 10;    # normal number of spots to return
-$maxdays = 35;        # normal maximum no of days to go back
-$dirprefix = "$main::data/spots";
+$statp = undef;
+$maxspots = 50;                                        # maximum spots to return
+$defaultspots = 10;                            # normal number of spots to return
+$maxdays = 100;                                # normal maximum no of days to go back
+$dirprefix = "spots";
+$duplth = 20;                                  # the length of text to use in the deduping
+$dupage = 3*3600;               # the length of time to hold spot dups
+$filterdef = bless ([
+                         # tag, sort, field, priv, special parser 
+                         ['freq', 'r', 0, 0, \&decodefreq],
+                         ['on', 'r', 0, 0, \&decodefreq],
+                         ['call', 'c', 1],
+                         ['info', 't', 3],
+                         ['by', 'c', 4],
+                         ['call_dxcc', 'n', 5],
+                         ['by_dxcc', 'n', 6],
+                         ['origin', 'c', 7, 9],
+                         ['call_itu', 'n', 8],
+                         ['call_zone', 'n', 9],
+                         ['by_itu', 'n', 10],
+                         ['by_zone', 'n', 11],
+                         ['channel', 'n', 12, 9],
+                        ], 'Filter::Cmd');
+
+
+# create a Spot Object
+sub new
+{
+       my $class = shift;
+       my $self = [ @_ ];
+       return bless $self, $class;
+}
+
+sub decodefreq
+{
+       my $dxchan = shift;
+       my $l = shift;
+       my @f = split /,/, $l;
+       my @out;
+       my $f;
+       
+       foreach $f (@f) {
+               my ($a, $b); 
+               if (m{^\d+/\d+$}) {
+                       push @out, $f;
+               } elsif (($a, $b) = $f =~ m{^(\w+)(?:/(\w+))?$}) {
+                       $b = lc $b if $b;
+                       my @fr = Bands::get_freq(lc $a, $b);
+                       if (@fr) {
+                               while (@fr) {
+                                       $a = shift @fr;
+                                       $b = shift @fr;
+                                       push @out, "$a/$b";  # add them as ranges
+                               }
+                       } else {
+                               return ('dfreq', $dxchan->msg('dfreq1', $f));
+                       }
+               } else {
+                       return ('dfreq', $dxchan->msg('e20', $f));
+               }
+       }
+       return (0, join(',', @out));                     
+}
 
 sub init
 {
-  mkdir "$dirprefix", 0777 if !-e "$dirprefix";
+       mkdir "$dirprefix", 0777 if !-e "$dirprefix";
+       $fp = DXLog::new($dirprefix, "dat", 'd');
+       $statp = DXLog::new($dirprefix, "bys", 'd');
 }
 
 sub prefix
 {
-  return $dirprefix;
+       return $fp->{prefix};
 }
 
-# add a spot to the data file (call as Spot::add)
-sub add
+# fix up the full spot data from the basic spot data
+sub prepare
 {
-  my @spot = @_;    # $freq, $call, $t, $comment, $spotter = @_
+       # $freq, $call, $t, $comment, $spotter = @_
+       my @out = @_[0..4];      # just up to the spotter
 
-  # sure that the numeric things are numeric now (saves time later)
-  $spot[0] = 0 + $spot[0];
-  $spot[2] = 0 + $spot[2];
+       # normalise frequency
+       $_[0] = sprintf "%.1f", $_[0];
   
-  # remove ssid if present on spotter
-  $spot[4] =~ s/-\d+$//o;
-
-  # compare dates to see whether need to open another save file (remember, redefining $fp 
-  # automagically closes the output file (if any))
-  my @date = Julian::unixtoj($spot[2]);
-  $fp = Spot->open(@date, ">>") if (!$fp || Julian::cmp(@date, $fp->{year}, $fp->{day}));
+       # remove ssids if present on spotter
+       $out[4] =~ s/-\d+$//o;
 
-  # save it
-  my $fh = $fp->{fh};
-
-  # add the 'dxcc' country on the end
-  my @dxcc = Prefix::extract($spot[1]);
-  push @spot, (@dxcc > 0 ) ? $dxcc[1]->dxcc() : 0;
+       # remove leading and trailing spaces
+       $_[3] = unpad($_[3]);
+       
+       # add the 'dxcc' country on the end for both spotted and spotter, then the cluster call
+       my @dxcc = Prefix::extract($out[1]);
+       my $spotted_dxcc = (@dxcc > 0 ) ? $dxcc[1]->dxcc() : 0;
+       my $spotted_itu = (@dxcc > 0 ) ? $dxcc[1]->itu() : 0;
+       my $spotted_cq = (@dxcc > 0 ) ? $dxcc[1]->cq() : 0;
+       push @out, $spotted_dxcc;
+       @dxcc = Prefix::extract($out[4]);
+       my $spotter_dxcc = (@dxcc > 0 ) ? $dxcc[1]->dxcc() : 0;
+       my $spotter_itu = (@dxcc > 0 ) ? $dxcc[1]->itu() : 0;
+       my $spotter_cq = (@dxcc > 0 ) ? $dxcc[1]->cq() : 0;
+       push @out, $spotter_dxcc;
+       push @out, $_[5];
+       return (@out, $spotted_itu, $spotted_cq, $spotter_itu, $spotter_cq);
+}
 
-  my $buf = join("\^", @spot);
-  $fh->print($buf, "\n");
-  
-  return $buf;
+sub add
+{
+       my $buf = join("\^", @_[0..7]);
+       $fp->writeunix($_[2], $buf);
 }
 
 # search the spot database for records based on the field no and an expression
@@ -78,7 +152,10 @@ sub add
 #   $f2 = date in unix format
 #   $f3 = comment
 #   $f4 = spotter
-#   $f5 = dxcc country
+#   $f5 = spotted dxcc country
+#   $f6 = spotter dxcc country
+#   $f7 = origin
+#
 #
 # In addition you can specify a range of days, this means that it will start searching
 # from <n> days less than today to <m> days less than today
@@ -91,114 +168,250 @@ sub add
 
 sub search
 {
-  my ($expr, $dayfrom, $dayto, $from, $to) = @_;
-  my $eval;
-  my @out;
-  my $ref;
-  my $i;
-  my $count;
-  my @today = Julian::unixtoj(time);
-  my @fromdate;
-  my @todate;
-  
-  if ($dayfrom > 0) {
-    @fromdate = Julian::sub(@today, $dayfrom);
-  } else {
-    @fromdate = @today;
-       $dayfrom = 0;
-  }
-  if ($dayto > 0) {
-    @todate = Julian::sub(@fromdate, $dayto);
-  } else {
-    @todate = Julian::sub(@fromdate, $maxdays);
-  }
-  if ($from || $to) {
-    $to = $from + $maxspots if $to - $from > $maxspots || $to - $from <= 0;
-  } else {
-    $from = 0;
-       $to = $defaultspots;
-  }
-
-  $expr =~ s/\$f(\d)/\$ref->[$1]/g;               # swap the letter n for the correct field name
-#  $expr =~ s/\$f(\d)/\$spots[$1]/g;               # swap the letter n for the correct field name
+       my ($expr, $dayfrom, $dayto, $from, $to, $hint) = @_;
+       my $eval;
+       my @out;
+       my $ref;
+       my $i;
+       my $count;
+       my $today = Julian::Day->new(time());
+       my $fromdate;
+       my $todate;
+
+       $dayfrom = 0 if !$dayfrom;
+       $dayto = $maxdays unless $dayto;
+       $dayto = $dayfrom + $maxdays if $dayto < $dayfrom;
+       $fromdate = $today->sub($dayfrom);
+       $todate = $fromdate->sub($dayto);
+       $from = 0 unless $from;
+       $to = $defaultspots unless $to;
+       $hint = $hint ? "next unless $hint" : "";
+       $expr = "1" unless $expr;
+       
+       $to = $from + $maxspots if $to - $from > $maxspots || $to - $from <= 0;
+
+       $expr =~ s/\$f(\d)/\$ref->[$1]/g; # swap the letter n for the correct field name
+       #  $expr =~ s/\$f(\d)/\$spots[$1]/g;               # swap the letter n for the correct field name
   
-  dbg("search", "expr='$expr', spotno=$from-$to, day=$dayfrom-$dayto\n");
+       dbg("hint='$hint', expr='$expr', spotno=$from-$to, day=$dayfrom-$dayto\n") if isdbg('search');
   
-  # build up eval to execute
-  $eval = qq(
-#    while (<\$fh>) {
-#        chomp;
-#        my \@spots = split /\\^/o;
-#        if ($expr) {                # note NO \$expr
-#          \$count++;
-#              next if \$count < \$from;                  # wait until from 
-#              push(\@out, \\\@spots);
-#              last LOOP if \$count >= \$to;                  # stop after to
-#        }
-#      }
-    my \$c;
-       my \$ref;
-    for (\$c = \$#spots; \$c >= 0; \$c--) {
-         \$ref = \$spots[\$c];
-         if ($expr) {
-           \$count++;
-               next if \$count < \$from;                  # wait until from 
-        push(\@out, \$ref);
-               last LOOP if \$count >= \$to;                  # stop after to
-         }
-    }
-  );
-
-LOOP:
-  for ($i = 0; $i < $maxdays; ++$i) {             # look thru $maxdays worth of files only
-    my @now = Julian::sub(@fromdate, $i);         # but you can pick which $maxdays worth
-       last if Julian::cmp(@now, @todate) <= 0;         
+       # build up eval to execute
+       $eval = qq(
+                          while (<\$fh>) {
+                                  $hint;
+                                  chomp;
+                                  push \@spots, [ split '\\^' ];
+                          }
+                          my \$c;
+                          my \$ref;
+                          for (\$c = \$#spots; \$c >= 0; \$c--) {
+                                       \$ref = \$spots[\$c];
+                                       if ($expr) {
+                                               \$count++;
+                                               next if \$count < \$from; # wait until from 
+                                               push(\@out, \$ref);
+                                               last if \$count >= \$to; # stop after to
+                                       }
+                               }
+                         );
+
+       $fp->close;                                     # close any open files
+
+       for ($i = $count = 0; $i < $maxdays; ++$i) {    # look thru $maxdays worth of files only
+               my $now = $fromdate->sub($i); # but you can pick which $maxdays worth
+               last if $now->cmp($todate) <= 0;         
        
-       my @spots = ();
-       my $fp = Spot->open(@now);  # get the next file
-       if ($fp) {
-         my $fh = $fp->{fh};
-         my $in;
-         foreach $in (<$fh>) {
-           chomp $in;
-       push @spots, [ split('\^', $in) ];
-         }
-         eval $eval;               # do the search on this file
-         return ("Spot search error", $@) if $@;
+               my @spots = ();
+               my $fh = $fp->open($now); # get the next file
+               if ($fh) {
+                       my $in;
+                       eval $eval;                     # do the search on this file
+                       last if $count >= $to; # stop after to
+                       return ("Spot search error", $@) if $@;
+               }
        }
-  }
 
-  return @out;
+       return @out;
 }
 
-# open a spot file of the Julian day
-sub open
+# change a freq range->regular expression
+sub ftor
 {
-  my $pkg = shift;
-  return Julian::open("spot", $dirprefix, @_);
-}
-
-# close a spot file
-sub close
-{
-  # do nothing, unreferencing or overwriting the $self will close it  
+       my ($a, $b) = @_;
+       return undef unless $a < $b;
+       $b--;
+       my $d = $b - $a;
+       my @a = split //, $a;
+       my @b = split //, $b;
+       my $out;
+       while (@b > @a) {
+               $out .= shift @b;
+       }
+       while (@b) {
+               my $aa = shift @a;
+               my $bb = shift @b;
+               if (@b < (length $d) - 1) {
+                       $out .= '\\d';
+               } elsif ($aa eq $bb) {
+                       $out .= $aa;
+               } elsif ($aa < $bb) {
+                       $out .= "[$aa-$bb]";
+               } else {
+                       $out .= "[0-$bb$aa-9]";
+               }
+       }
+       return $out;
 }
 
 # format a spot for user output in 'broadcast' mode
 sub formatb
 {
-  my @dx = @_;
-  my $t = ztime($dx[2]);
-  return sprintf "DX de %-7.7s: %13.1f %-12.12s %-30s<%s>", $dx[4], $dx[0], $dx[1], $dx[3], $t ;
+       my $wantgrid = shift;
+       my $t = ztime($_[2]);
+       my $ref = DXUser->get_current($_[4]);
+       my $loc = $ref->qra if $ref && $ref->qra && $wantgrid;
+       $loc = ' ' . substr($ref->qra, 0, 4) if $loc;
+       $loc = "" unless $loc;
+       return sprintf "DX de %-7.7s%11.1f  %-12.12s %-30s %s$loc", "$_[4]:", $_[0], $_[1], $_[3], $t ;
 }
 
 # format a spot for user output in list mode
 sub formatl
 {
-  my @dx = @_;
-  my $t = ztime($dx[2]);
-  my $d = cldate($dx[2]);
-  return sprintf "%9.1f %-12s %s %s %-30s<%s>", $dx[0], $dx[1], $d, $t, $dx[3], $dx[4] ;
+       my $t = ztime($_[2]);
+       my $d = cldate($_[2]);
+       return sprintf "%8.1f  %-11s %s %s  %-28.28s%7s>", $_[0], $_[1], $d, $t, $_[3], "<$_[4]" ;
+}
+
+#
+# return all the spots from a day's file as an array of references
+# the parameter passed is a julian day
+sub readfile($)
+{
+       my @spots;
+       
+       my $fh = $fp->open(shift); 
+       if ($fh) {
+               my $in;
+               while (<$fh>) {
+                       chomp;
+                       push @spots, [ split '\^' ];
+               }
+       }
+       return @spots;
+}
+
+# enter the spot for dup checking and return true if it is already a dup
+sub dup
+{
+       my ($freq, $call, $d, $text) = @_; 
+
+       # dump if too old
+       return 2 if $d < $main::systime - $dupage;
+       $freq = sprintf "%.1f", $freq;       # normalise frequency
+       chomp $text;
+       $text =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
+       $text = substr($text, 0, $duplth) if length $text > $duplth; 
+       unpad($text);
+       $text = pack("C*", map {$_ & 127} unpack("C*", $text));
+       $text =~ s/[^a-zA-Z0-9]//g;
+       for (0,60,120,180,240,300) {
+               my $dt = $d - $_;
+               my $dupkey = "X$freq|$call|$dt|\L$text";
+               return 1 if DXDupe::find($dupkey);
+       }
+       my $dupkey = "X$freq|$call|$d|\L$text";
+       DXDupe::add($dupkey, $main::systime+$dupage);
+       return 0;
+}
+
+sub listdups
+{
+       return DXDupe::listdups('X', $dupage, @_);
 }
 
+sub genstats($)
+{
+       my $date = shift;
+       my $in = $fp->open($date);
+       my $out = $statp->open($date, 'w');
+       my @freq = (
+                               [0, Bands::get_freq('160m')],
+                               [1, Bands::get_freq('80m')],
+                               [2, Bands::get_freq('40m')],
+                               [3, Bands::get_freq('30m')],
+                               [4, Bands::get_freq('20m')],
+                               [5, Bands::get_freq('17m')],
+                               [6, Bands::get_freq('15m')],
+                               [7, Bands::get_freq('12m')],
+                               [8, Bands::get_freq('10m')],
+                               [9, Bands::get_freq('6m')],
+                               [10, Bands::get_freq('4m')],
+                               [11, Bands::get_freq('2m')],
+                               [12, Bands::get_freq('70cm')],
+                               [13, Bands::get_freq('13cm')],
+                               [14, Bands::get_freq('9cm')],
+                               [15, Bands::get_freq('6cm')],
+                               [16, Bands::get_freq('3cm')],
+                               [17, Bands::get_freq('12mm')],
+                               [18, Bands::get_freq('6cm')],
+                          );
+       my %list;
+       my @tot;
+       
+       if ($in && $out) {
+               while (<$in>) {
+                       chomp;
+                       my ($freq, $by, $dxcc) = (split /\^/)[0,4,6];
+                       my $ref = $list{$by} || [0, $dxcc];
+                       for (@freq) {
+                               if ($freq >= $_->[1] && $freq <= $_->[2]) {
+                                       $$ref[$_->[0]+2]++;
+                                       $tot[$_->[0]+2]++;
+                                       $$ref[0]++;
+                                       $tot[0]++;
+                                       $list{$by} = $ref;
+                                       last;
+                               }
+                       }
+               }
+
+               my $i;
+               for ($i = 0; $i < @freq+2; $i++) {
+                       $tot[$i] ||= 0;
+               }
+               $out->write(join('^', 'TOTALS', @tot) . "\n");
+
+               for (sort {$list{$b}->[0] <=> $list{$a}->[0]} keys %list) {
+                       my $ref = $list{$_};
+                       my $call = $_;
+                       for ($i = 0; $i < @freq+2; ++$i) {
+                               $ref->[$i] ||= 0;
+                       }
+                       $out->write(join('^', $call, @$ref) . "\n");
+               }
+               $out->close;
+       }
+}
+
+# return true if the stat file is newer than than the spot file
+sub checkstats($)
+{
+       my $date = shift;
+       my $in = $fp->mtime($date);
+       my $out = $statp->mtime($date);
+       return defined $out && defined $in && $out >= $in;
+}
+
+# daily processing
+sub daily
+{
+       my $date = Julian::Day->new($main::systime)->sub(1);
+       genstats($date) unless checkstats($date);
+}
 1;
+
+
+
+