perl/Spot.pm

   1 #
   2 # the dx spot handler
   3 #
   4 # Copyright (c) - 1998 Dirk Koopman G1TLH
   5 #
   6 # $Id$
   7 #
   8
   9 package Spot;
  10
  11 use FileHandle;
  12 use DXVars;
  13 use DXDebug;
  14 use DXUtil;
  15 use DXLog;
  16 use Julian;
  17 use Prefix;
  18 use Carp;
  19
  20 use strict;
  21 use vars qw($fp $maxspots $defaultspots $maxdays $dirprefix);
  22
  23 $fp = undef;
  24 $maxspots = 50;                                 # maximum spots to return
  25 $defaultspots = 10;                             # normal number of spots to return
  26 $maxdays = 35;                                  # normal maximum no of days to go back
  27 $dirprefix = "spots";
  28
  29 sub init
  30 {
  31         mkdir "$dirprefix", 0777 if !-e "$dirprefix";
  32         $fp = DXLog::new($dirprefix, "dat", 'd')
  33 }
  34
  35 sub prefix
  36 {
  37         return $fp->{prefix};
  38 }
  39
  40 # add a spot to the data file (call as Spot::add)
  41 sub add
  42 {
  43         my @spot = @_;                          # $freq, $call, $t, $comment, $spotter = @_
  44         my @out = @spot[0..4];      # just up to the spotter
  45
  46         # sure that the numeric things are numeric now (saves time later)
  47         $spot[0] = 0 + $spot[0];
  48         $spot[2] = 0 + $spot[2];
  49
  50         # remove ssids if present on spotter
  51         $out[4] =~ s/-\d+$//o;
  52
  53         # add the 'dxcc' country on the end for both spotted and spotter, then the cluster call
  54         my @dxcc = Prefix::extract($out[1]);
  55         push @out, (@dxcc > 0 ) ? $dxcc[1]->dxcc() : 0;
  56         @dxcc = Prefix::extract($out[4]);
  57         push @out, (@dxcc > 0 ) ? $dxcc[1]->dxcc() : 0;
  58         push @out, $spot[5];
  59
  60
  61         my $buf = join("\^", @out);
  62
  63         # compare dates to see whether need to open another save file (remember, redefining $fp
  64         # automagically closes the output file (if any)).
  65         $fp->writeunix($out[2], $buf);
  66
  67         return $buf;
  68 }
  69
  70 # search the spot database for records based on the field no and an expression
  71 # this returns a set of references to the spots
  72 #
  73 # the expression is a legal perl 'if' statement with the possible fields indicated
  74 # by $f<n> where :-
  75 #
  76 #   $f0 = frequency
  77 #   $f1 = call
  78 #   $f2 = date in unix format
  79 #   $f3 = comment
  80 #   $f4 = spotter
  81 #   $f5 = dxcc country
  82 #
  83 # In addition you can specify a range of days, this means that it will start searching
  84 # from <n> days less than today to <m> days less than today
  85 #
  86 # Also you can select a range of entries so normally you would get the 0th (latest) entry
  87 # back to the 5th latest, you can specify a range from the <x>th to the <y>the oldest.
  88 #
  89 # This routine is designed to be called as Spot::search(..)
  90 #
  91
  92 sub search
  93 {
  94         my ($expr, $dayfrom, $dayto, $from, $to) = @_;
  95         my $eval;
  96         my @out;
  97         my $ref;
  98         my $i;
  99         my $count;
 100         my @today = Julian::unixtoj(time);
 101         my @fromdate;
 102         my @todate;
 103
 104         $dayfrom = 0 if !$dayfrom;
 105         $dayto = $maxdays if !$dayto;
 106         @fromdate = Julian::sub(@today, $dayfrom);
 107         @todate = Julian::sub(@fromdate, $dayto);
 108         $from = 0 unless $from;
 109         $to = $defaultspots unless $to;
 110
 111         $to = $from + $maxspots if $to - $from > $maxspots || $to - $from <= 0;
 112
 113         $expr =~ s/\$f(\d)/\$ref->[$1]/g; # swap the letter n for the correct field name
 114         #  $expr =~ s/\$f(\d)/\$spots[$1]/g;               # swap the letter n for the correct field name
 115
 116         dbg("search", "expr='$expr', spotno=$from-$to, day=$dayfrom-$dayto\n");
 117
 118         # build up eval to execute
 119         $eval = qq(
 120                            my \$c;
 121                            my \$ref;
 122                            for (\$c = \$#spots; \$c >= 0; \$c--) {
 123                                         \$ref = \$spots[\$c];
 124                                         if ($expr) {
 125                                                 \$count++;
 126                                                 next if \$count < \$from; # wait until from
 127                                                 push(\@out, \$ref);
 128                                                 last if \$count >= \$to; # stop after to
 129                                         }
 130                                 }
 131                           );
 132
 133         $fp->close;                                     # close any open files
 134
 135         for ($i = 0; $i < $maxdays; ++$i) {     # look thru $maxdays worth of files only
 136                 my @now = Julian::sub(@fromdate, $i); # but you can pick which $maxdays worth
 137                 last if Julian::cmp(@now, @todate) <= 0;
 138
 139                 my @spots = ();
 140                 my $fh = $fp->open(@now); # get the next file
 141                 if ($fh) {
 142                         my $in;
 143                         while (<$fh>) {
 144                                 chomp;
 145                                 push @spots, [ split '\^' ];
 146                         }
 147                         eval $eval;                     # do the search on this file
 148                         last if $count >= $to; # stop after to
 149                         return ("Spot search error", $@) if $@;
 150                 }
 151         }
 152
 153         return @out;
 154 }
 155
 156 # format a spot for user output in 'broadcast' mode
 157 sub formatb
 158 {
 159         my @dx = @_;
 160         my $t = ztime($dx[2]);
 161         return sprintf "DX de %-7.7s%11.1f  %-12.12s %-30s %s", "$dx[4]:", $dx[0], $dx[1], $dx[3], $t ;
 162 }
 163
 164 # format a spot for user output in list mode
 165 sub formatl
 166 {
 167         my @dx = @_;
 168         my $t = ztime($dx[2]);
 169         my $d = cldate($dx[2]);
 170         return sprintf "%8.1f  %-11s %s %s  %-28.28s%7s>", $dx[0], $dx[1], $d, $t, $dx[3], "<$dx[4]" ;
 171 }
 172
 173 #
 174 # return all the spots from a day's file as an array of references
 175 # the parameter passed is a julian day
 176 sub readfile
 177 {
 178         my @spots;
 179
 180         my $fh = $fp->open(@_);
 181         if ($fh) {
 182                 my $in;
 183                 while (<$fh>) {
 184                         chomp;
 185                         push @spots, [ split '\^' ];
 186                 }
 187         }
 188         return @spots;
 189 }
 190 1;