]> www.dxcluster.org Git - spider.git/blob - perl/Spot.pm
try to fix unblessed refs in PC34s
[spider.git] / perl / Spot.pm
1 #
2 # the dx spot handler
3 #
4 # Copyright (c) - 1998 Dirk Koopman G1TLH
5 #
6 #
7 #
8
9 package Spot;
10
11 use IO::File;
12 use DXVars;
13 use DXDebug;
14 use DXUtil;
15 use DXLog;
16 use Julian;
17 use Prefix;
18 use DXDupe;
19 use Data::Dumper;
20 use QSL;
21
22 use strict;
23
24 use vars qw($fp $statp $maxspots $defaultspots $maxdays $dirprefix $duplth $dupage $filterdef
25                         $totalspots $hfspots $vhfspots $maxcalllth $can_encode $use_db_for_search);
26
27 $fp = undef;
28 $statp = undef;
29 $maxspots = 100;                                        # maximum spots to return
30 $defaultspots = 10;                             # normal number of spots to return
31 $maxdays = 100;                         # normal maximum no of days to go back
32 $dirprefix = "spots";
33 $duplth = 20;                                   # the length of text to use in the deduping
34 $dupage = 1*3600;               # the length of time to hold spot dups
35 $maxcalllth = 12;                               # the max length of call to take into account for dupes
36 $filterdef = bless ([
37                           # tag, sort, field, priv, special parser 
38                           ['freq', 'r', 0, 0, \&decodefreq],
39                           ['on', 'r', 0, 0, \&decodefreq],
40                           ['call', 'c', 1],
41                           ['info', 't', 3],
42                           ['by', 'c', 4],
43                           ['call_dxcc', 'nc', 5],
44                           ['by_dxcc', 'nc', 6],
45                           ['origin', 'c', 7, 9],
46                           ['call_itu', 'ni', 8],
47                           ['call_zone', 'nz', 9],
48                           ['by_itu', 'ni', 10],
49                           ['by_zone', 'nz', 11],
50                           ['call_state', 'ns', 12],
51                           ['by_state', 'ns', 13],
52                           ['channel', 'c', 14],
53                                          
54                          ], 'Filter::Cmd');
55 $totalspots = $hfspots = $vhfspots = 0;
56 $use_db_for_search = 0;
57
58 # create a Spot Object
59 sub new
60 {
61         my $class = shift;
62         my $self = [ @_ ];
63         return bless $self, $class;
64 }
65
66 sub decodefreq
67 {
68         my $dxchan = shift;
69         my $l = shift;
70         my @f = split /,/, $l;
71         my @out;
72         my $f;
73         
74         foreach $f (@f) {
75                 my ($a, $b); 
76                 if (m{^\d+/\d+$}) {
77                         push @out, $f;
78                 } elsif (($a, $b) = $f =~ m{^(\w+)(?:/(\w+))?$}) {
79                         $b = lc $b if $b;
80                         my @fr = Bands::get_freq(lc $a, $b);
81                         if (@fr) {
82                                 while (@fr) {
83                                         $a = shift @fr;
84                                         $b = shift @fr;
85                                         push @out, "$a/$b";  # add them as ranges
86                                 }
87                         } else {
88                                 return ('dfreq', $dxchan->msg('dfreq1', $f));
89                         }
90                 } else {
91                         return ('dfreq', $dxchan->msg('e20', $f));
92                 }
93         }
94         return (0, join(',', @out));                     
95 }
96
97 sub init
98 {
99         mkdir "$dirprefix", 0777 if !-e "$dirprefix";
100         $fp = DXLog::new($dirprefix, "dat", 'd');
101         $statp = DXLog::new($dirprefix, "dys", 'd');
102
103         # load up any old spots 
104         if ($main::dbh) {
105                 unless (grep $_ eq 'spot', $main::dbh->show_tables) {
106                         dbg('initialising spot tables');
107                         my $t = time;
108                         my $total;
109                         $main::dbh->spot_create_table;
110                         
111                         my $now = Julian::Day->alloc(1995, 0);
112                         my $today = Julian::Day->new(time);
113                         my $sth = $main::dbh->spot_insert_prepare;
114                         $main::dbh->{RaiseError} = 0;
115                         while ($now->cmp($today) <= 0) {
116                                 my $fh = $fp->open($now);
117                                 if ($fh) {
118                                         my $count = 0;
119                                         while (<$fh>) {
120                                                 chomp;
121                                                 my @s = split /\^/;
122                                                 if (@s < 12) {
123                                                         my @a = (Prefix::cty_data($s[1]))[1..3];
124                                                         my @b = (Prefix::cty_data($s[4]))[1..3];
125                                                         push @s, $b[1] if @s < 7;
126                                                         push @s, '' if @s < 8;
127                                                         push @s, @a[0,1], @b[0,1] if @s < 12;
128                                                         push @s,  $a[2], $a[2] if @s < 14;  
129                                                 } 
130                                                 
131                                                 push @s, undef while @s < 14;
132                                                 pop @s while @s > 14;
133
134                                                 $main::dbh->spot_insert(\@s, $sth);
135                                                 $count++;
136                                         }
137                                         $main::dbh->commit if $count;
138                                         $main::dbh->{RaiseError} = 0;
139                                         dbg("inserted $count spots from $now->[0] $now->[1]");
140                                         $fh->close;
141                                         $total += $count;
142                                 }
143                                 $now = $now->add(1);
144                         }
145                         $main::dbh->spot_add_indexes;
146                         $main::dbh->commit;
147                         $main::dbh->{RaiseError} = 1;
148                         $t = time - $t;
149                         my $min = int($t / 60);
150                         my $sec = $t % 60;
151                         dbg("$total spots converted in $min:$sec");
152                 }
153         }
154 }
155
156 sub prefix
157 {
158         return $fp->{prefix};
159 }
160
161 # fix up the full spot data from the basic spot data
162 sub prepare
163 {
164         # $freq, $call, $t, $comment, $spotter, node, ip address = @_
165         my @out = @_[0..4];      # just up to the spotter
166
167         # normalise frequency
168         $out[0] = sprintf "%.1f", $out[0];
169   
170         # remove ssids and /xxx if present on spotter
171         $out[4] =~ s/-\d+$//o;
172
173         # remove leading and trailing spaces
174         $out[3] = unpad($out[3]);
175         
176         
177         # add the 'dxcc' country on the end for both spotted and spotter, then the cluster call
178         my @spd = Prefix::cty_data($out[1]);
179         push @out, $spd[0];
180         my @spt = Prefix::cty_data($out[4]);
181         push @out, $spt[0];
182         push @out, $_[5];
183         push @out, @spd[1,2], @spt[1,2], $spd[3], $spt[3];
184         push @out, $_[6] if $_[6] && is_ipaddr($_[6]);
185         return @out;
186 }
187
188 sub add
189 {
190         my $buf = join('^', @_);
191         $fp->writeunix($_[2], $buf);
192         if ($main::dbh) {
193                 $main::dbh->spot_insert(\@_);
194                 $main::dbh->commit;
195         }
196         $totalspots++;
197         if ($_[0] <= 30000) {
198                 $hfspots++;
199         } else {
200                 $vhfspots++;
201         }
202         if ($_[3] =~ /(?:QSL|VIA)/i) {
203                 my $q = QSL::get($_[1]) || new QSL $_[1];
204                 $q->update($_[3], $_[2], $_[4]);
205         }
206 }
207
208 # search the spot database for records based on the field no and an expression
209 # this returns a set of references to the spots
210 #
211 # the expression is a legal perl 'if' statement with the possible fields indicated
212 # by $f<n> where :-
213 #
214 #   $f0 = frequency
215 #   $f1 = call
216 #   $f2 = date in unix format
217 #   $f3 = comment
218 #   $f4 = spotter
219 #   $f5 = spotted dxcc country
220 #   $f6 = spotter dxcc country
221 #   $f7 = origin
222 #
223 #
224 # In addition you can specify a range of days, this means that it will start searching
225 # from <n> days less than today to <m> days less than today
226 #
227 # Also you can select a range of entries so normally you would get the 0th (latest) entry
228 # back to the 5th latest, you can specify a range from the <x>th to the <y>the oldest.
229 #
230 # This routine is designed to be called as Spot::search(..)
231 #
232
233 sub search
234 {
235         my ($expr, $dayfrom, $dayto, $from, $to, $hint, $dxchan) = @_;
236         my $eval;
237         my @out;
238         my $ref;
239         my $i;
240         my $count;
241         my $today = Julian::Day->new(time());
242         my $fromdate;
243         my $todate;
244
245         $dayfrom = 0 if !$dayfrom;
246         $dayto = $maxdays unless $dayto;
247         $dayto = $dayfrom + $maxdays if $dayto < $dayfrom;
248         $fromdate = $today->sub($dayfrom);
249         $todate = $fromdate->sub($dayto);
250         $from = 0 unless $from;
251         $to = $defaultspots unless $to;
252         $hint = $hint ? "next unless $hint" : "";
253         $expr = "1" unless $expr;
254         
255         $to = $from + $maxspots if $to - $from > $maxspots || $to - $from <= 0;
256
257         if ($main::dbh && $use_db_for_search) {
258                 return $main::dbh->spot_search($expr, $dayfrom, $dayto, $to-$from, $dxchan);
259         }
260
261         $expr =~ s/\$f(\d\d?)/\$ref->[$1]/g; # swap the letter n for the correct field name
262         #  $expr =~ s/\$f(\d)/\$spots[$1]/g;               # swap the letter n for the correct field name
263   
264         my $checkfilter;
265         $checkfilter = qq (
266                       if (\@s < 9) {
267                           my \@a = (Prefix::cty_data(\$s[1]))[1..3];
268                           my \@b = (Prefix::cty_data(\$s[4]))[1..3];
269                           push \@s, \@a[0,1], \@b[0,1], \$a[2], \$a[2];  
270                       } else {
271                           \$s[12] ||= ' ';
272                           \$s[13] ||= ' ';
273                       }
274                           my (\$filter, \$hops) = \$dxchan->{spotsfilter}->it(\@s);
275                           next unless (\$filter);
276                       ) if $dxchan;
277         $checkfilter ||= ' ';
278         
279         dbg("hint='$hint', expr='$expr', spotno=$from-$to, day=$dayfrom-$dayto\n") if isdbg('search');
280   
281         # build up eval to execute
282         $eval = qq(
283                            while (<\$fh>) {
284                                    $hint;
285                                    chomp;
286                                    my \@s = split /\\^/;
287                    $checkfilter;
288                    push \@spots, \\\@s;
289                            }
290                            my \$c;
291                            my \$ref;
292                            for (\$c = \$#spots; \$c >= 0; \$c--) {
293                                         \$ref = \$spots[\$c];
294                                         if ($expr) {
295                                                 \$count++;
296                                                 next if \$count < \$from; # wait until from 
297                                                 push(\@out, \$ref);
298                                                 last if \$count >= \$to; # stop after to
299                                         }
300                                 }
301                           );
302     
303         dbg("Spot eval: $eval") if isdbg('searcheval');
304         
305
306         $fp->close;                                     # close any open files
307
308         for ($i = $count = 0; $i < $maxdays; ++$i) {    # look thru $maxdays worth of files only
309                 my $now = $fromdate->sub($i); # but you can pick which $maxdays worth
310                 last if $now->cmp($todate) <= 0;         
311         
312                 my @spots = ();
313                 my $fh = $fp->open($now); # get the next file
314                 if ($fh) {
315                         my $in;
316                         eval $eval;                     # do the search on this file
317                         last if $count >= $to; # stop after to
318                         return ("Spot search error", $@) if $@;
319                 }
320         }
321
322         return @out;
323 }
324
325 # change a freq range->regular expression
326 sub ftor
327 {
328         my ($a, $b) = @_;
329         return undef unless $a < $b;
330         $b--;
331         my $d = $b - $a;
332         my @a = split //, $a;
333         my @b = split //, $b;
334         my $out;
335         while (@b > @a) {
336                 $out .= shift @b;
337         }
338         while (@b) {
339                 my $aa = shift @a;
340                 my $bb = shift @b;
341                 if (@b < (length $d)) {
342                         $out .= '\\d';
343                 } elsif ($aa eq $bb) {
344                         $out .= $aa;
345                 } elsif ($aa < $bb) {
346                         $out .= "[$aa-$bb]";
347                 } else {
348                         $out .= "[0-$bb$aa-9]";
349                 }
350         }
351         return $out;
352 }
353
354 # format a spot for user output in list mode
355 sub formatl
356 {
357         my $t = ztime($_[2]);
358         my $d = cldate($_[2]);
359         return sprintf "%8.1f  %-11s %s %s  %-28.28s%7s>", $_[0], $_[1], $d, $t, ($_[3]||''), "<$_[4]" ;
360 }
361
362 #
363 # return all the spots from a day's file as an array of references
364 # the parameter passed is a julian day
365 sub readfile($)
366 {
367         my @spots;
368         
369         my $fh = $fp->open(shift); 
370         if ($fh) {
371                 my $in;
372                 while (<$fh>) {
373                         chomp;
374                         push @spots, [ split '\^' ];
375                 }
376         }
377         return @spots;
378 }
379
380 # enter the spot for dup checking and return true if it is already a dup
381 sub dup
382 {
383         my ($freq, $call, $d, $text, $by, $cty) = @_; 
384
385         # dump if too old
386         return 2 if $d < $main::systime - $dupage;
387         
388         # turn the time into minutes (should be already but...)
389         $d = int ($d / 60);
390         $d *= 60;
391
392         # remove SSID or area
393         $by =~ s|[-/]\d+$||;
394         
395 #       $freq = sprintf "%.1f", $freq;       # normalise frequency
396         $freq = int $freq;       # normalise frequency
397         $call = substr($call, 0, $maxcalllth) if length $call > $maxcalllth;
398
399         chomp $text;
400         $text =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
401         $text = uc unpad($text);
402         if ($cty && $text && length $text <= 4) {
403                 unless ($text =~ /^C?Q/ || $text =~ /^\d+$/) {
404                         my @try = Prefix::cty_data($text);
405                         $text = "" if $cty == $try[0];
406                 }
407         }
408         my $otext = $text;
409 #       $text = Encode::encode("iso-8859-1", $text) if $main::can_encode && Encode::is_utf8($text, 1);
410         $text =~ s/^\+\w+\s*//;                 # remove leading LoTW callsign
411         $text =~ s/\s{2,}[\dA-Z]?[A-Z]\d?$// if length $text > 24;
412         $text =~ s/[\W\x00-\x2F\x7B-\xFF]//g; # tautology, just to make quite sure!
413         $text = substr($text, 0, $duplth) if length $text > $duplth; 
414         my $ldupkey = "X$freq|$call|$by|$text";
415         my $t = DXDupe::find($ldupkey);
416         return 1 if $t && $t - $main::systime > 0;
417         DXDupe::add($ldupkey, $main::systime+$dupage);
418         $otext = substr($otext, 0, $duplth) if length $otext > $duplth; 
419         $otext =~ s/\s+$//;
420         if (length $otext && $otext ne $text) {
421                 $ldupkey = "X$freq|$call|$by|$otext";
422                 $t = DXDupe::find($ldupkey);
423                 return 1 if $t && $t - $main::systime > 0;
424                 DXDupe::add($ldupkey, $main::systime+$dupage);
425         }
426         return 0;
427 }
428
429 sub listdups
430 {
431         return DXDupe::listdups('X', $dupage, @_);
432 }
433
434 sub genstats($)
435 {
436         my $date = shift;
437         my $in = $fp->open($date);
438         my $out = $statp->open($date, 'w');
439         my @freq;
440         my %list;
441         my @tot;
442         
443         if ($in && $out) {
444                 my $i = 0;
445                 @freq = map {[$i++, Bands::get_freq($_)]} qw(136khz 160m 80m 60m 40m 30m 20m 17m 15m 12m 10m 6m 4m 2m 220 70cm 23cm 13cm 9cm 6cm 3cm 12mm 6mm);
446                 while (<$in>) {
447                         chomp;
448                         my ($freq, $by, $dxcc) = (split /\^/)[0,4,6];
449                         my $ref = $list{$by} || [0, $dxcc];
450                         for (@freq) {
451                                 next unless defined $_;
452                                 if ($freq >= $_->[1] && $freq <= $_->[2]) {
453                                         $$ref[$_->[0]+2]++;
454                                         $tot[$_->[0]+2]++;
455                                         $$ref[0]++;
456                                         $tot[0]++;
457                                         $list{$by} = $ref;
458                                         last;
459                                 }
460                         }
461                 }
462
463                 for ($i = 0; $i < @freq+2; $i++) {
464                         $tot[$i] ||= 0;
465                 }
466                 $statp->write($date, join('^', 'TOTALS', @tot));
467
468                 for (sort {$list{$b}->[0] <=> $list{$a}->[0]} keys %list) {
469                         my $ref = $list{$_};
470                         my $call = $_;
471                         for ($i = 0; $i < @freq+2; ++$i) {
472                                 $ref->[$i] ||= 0;
473                         }
474                         $statp->write($date, join('^', $call, @$ref));
475                 }
476                 $statp->close;
477         }
478 }
479
480 # return true if the stat file is newer than than the spot file
481 sub checkstats($)
482 {
483         my $date = shift;
484         my $in = $fp->mtime($date);
485         my $out = $statp->mtime($date);
486         return defined $out && defined $in && $out >= $in;
487 }
488
489 # daily processing
490 sub daily
491 {
492         my $date = Julian::Day->new($main::systime)->sub(1);
493         genstats($date) unless checkstats($date);
494 }
495 1;
496
497
498
499