4 # Copyright (c) - Dirk Koopman G1TLH
22 use vars qw($db %prefix_loc %pre $lru $lrusize $misses $hits $matchtotal);
24 $db = undef; # the DB_File handle
25 %prefix_loc = (); # the meat of the info
26 %pre = (); # the prefix list
27 $hits = $misses = $matchtotal = 1; # cache stats
28 $lrusize = 1000; # size of prefix LRU cache
35 # fix up the node's default country codes
36 unless (@main::my_cc) {
37 push @main::my_cc, (61..67) if $main::mycall =~ /^GB/;
38 push @main::my_cc, qw(EA EA6 EA8 EA9) if $main::mycall =~ /^E[ABCD]/;
39 push @main::my_cc, qw(I IT IS) if $main::mycall =~ /^I/;
40 push @main::my_cc, qw(SV SV5 SV9) if $main::mycall =~ /^SV/;
43 push @main::my_cc, $main::mycall unless @main::my_cc;
51 my @dxcc = extract($_);
52 push @c, $dxcc[1]->dxcc if @dxcc > 1;
55 return "\@main::my_cc does not contain a valid prefix or callsign (" . join(',', @main::my_cc) . ")" unless @c;
72 # tie the main prefix database
73 eval {$db = tie(%pre, "DB_File", undef, O_RDWR|O_CREAT, 0664, $DB_BTREE);};
74 my $out = "$@($!)" if !$db || $@ ;
75 my $fn = localdata("prefix_data.pl");
76 eval {do $fn if !$out; };
78 $lru = LRU->newbase('Prefix', $lrusize);
91 my $fh = new IO::File;
92 my $fn = localdata("prefix_data.pl");
94 confess "Prefix system not started" if !$db;
97 rename "$fn.oooo", "$fn.ooooo" if -e "$fn.oooo";
98 rename "$fn.ooo", "$fn.oooo" if -e "$fn.ooo";
99 rename "$fn.oo", "$fn.ooo" if -e "$fn.oo";
100 rename "$fn.o", "$fn.oo" if -e "$fn.o";
101 rename "$fn", "$fn.o" if -e "$fn";
103 $fh->open(">$fn") or die "Can't open $fn ($!)";
105 # prefix location data
106 $fh->print("%prefix_loc = (\n");
107 foreach $l (sort {$a <=> $b} keys %prefix_loc) {
108 my $r = $prefix_loc{$l};
109 $fh->printf(" $l => bless( { name => '%s', dxcc => %d, itu => %d, utcoff => %d, lat => %f, long => %f }, 'Prefix'),\n",
110 $r->{name}, $r->{dxcc}, $r->{itu}, $r->{cq}, $r->{utcoff}, $r->{lat}, $r->{long});
112 $fh->print(");\n\n");
115 $fh->print("%pre = (\n");
116 foreach $k (sort keys %pre) {
117 $fh->print(" '$k' => [");
118 my @list = @{$pre{$k}};
125 $fh->print("$str ],\n");
132 # what you get is a list that looks like:-
134 # prefix => @list of blessed references to prefix_locs
136 # This routine will only do what you ask for, if you wish to be intelligent
137 # then that is YOUR problem!
145 return () if $db->seq($gotkey, $ref, R_CURSOR);
146 return () if $key ne substr $gotkey, 0, length $key;
148 return ($gotkey, map { $prefix_loc{$_} } split ',', $ref);
152 # get the next key that matches, this assumes that you have done a 'get' first
161 return () if $db->seq($gotkey, $ref, R_NEXT);
162 return () if $key ne substr $gotkey, 0, length $key;
164 return ($gotkey, map { $prefix_loc{$_} } split ',', $ref);
168 # put the key LRU incluing the city state info
173 my ($call, $ref) = @_;
175 my @s = USDB::get($call);
178 # this is deep magic, because this is a reference to static data, it
180 my $h = { %{$ref->[1]} };
181 bless $h, ref $ref->[1];
186 $ref->[1]->{city} = $ref->[1]->{state} = "" unless exists $ref->[1]->{state};
189 dbg("Prefix::lru_put $call -> ($ref->[1]->{city}, $ref->[1]->{state})") if isdbg('prefix');
190 $lru->put($call, $ref);
194 # search for the nearest match of a prefix string (starting
195 # from the RH end of the string passed)
203 for (my $i = length $pref; $i; $i--) {
205 my $s = substr($pref, 0, $i);
207 my $p = $lru->get($s);
210 if (isdbg('prefix')) {
211 my $percent = sprintf "%.1f", $hits * 100 / $misses;
212 dbg("Partial Prefix Cache Hit: $s Hits: $hits/$misses of $matchtotal = $percent\%");
214 lru_put($_, $p) for @partials;
219 if (isdbg('prefix')) {
220 my $part = $out[0] || "*";
221 $part .= '*' unless $part eq '*' || $part eq $s;
222 dbg("Partial prefix: $pref $s $part" );
224 if (@out && $out[0] eq $s) {
233 # extract a 'prefix' from a callsign, in other words the largest entity that will
234 # obtain a result from the prefix table.
236 # This is done by repeated probing, callsigns of the type VO1/G1TLH or
237 # G1TLH/VO1 (should) return VO1
242 my $calls = uc shift;
248 LM: foreach $call (split /,/, $calls) {
251 $call =~ s/-\d+$//; # ignore SSIDs
253 my $ecall = "=$call";
255 # first check if this is a call (by prefixing it with an = sign)
256 my $p = $lru->get($ecall);
259 if (isdbg('prefix')) {
260 my $percent = sprintf "%.1f", $hits * 100 / $misses;
261 dbg("Prefix Exact Cache Hit: $call Hits: $hits/$misses of $matchtotal = $percent\%");
267 # then check if the whole thing succeeds either because it is cached
268 # or because it simply is a stored prefix as callsign (or even a prefix)
269 $p = $lru->get($call);
272 if (isdbg('prefix')) {
273 my $percent = sprintf "%.1f", $hits * 100 / $misses;
274 dbg("Prefix Cache Hit: $call Hits: $hits/$misses of $matchtotal = $percent\%");
280 # is it in the USDB, force a matchprefix to match?
281 my @s = USDB::get($call);
284 @nout = matchprefix($call) unless @nout;
285 $nout[0] = $ecall if @nout;
288 # try a straight get for an exact callsign
292 # now store the exact prefix if it has been found
293 if (@nout && $nout[0] eq $ecall) {
296 lru_put("=$call", \@nout);
297 dbg("got exact prefix: $nout[0]") if isdbg('prefix');
302 # now try a non-exact call/prefix
303 if ((@nout = get($call)) && $nout[0] eq $call) {
305 lru_put($call, \@nout);
306 dbg("got exact prefix: $nout[0]") if isdbg('prefix');
311 # now split the call into parts if required
312 @parts = ($call =~ '/') ? split('/', $call) : ($call);
313 dbg("Parts: $call = " . join(' ', @parts)) if isdbg('prefix');
315 # remove any /0-9 /P /A /M /MM /AM suffixes etc
317 @parts = grep { !/^\d+$/ && !/^[PABM]$/ && !/^(?:|AM|MM|BCN|JOTA|SIX|WEB|NET|Q\w+)$/; } @parts;
319 # can we resolve them by direct lookup
320 my $s = join('/', @parts);
322 if (@nout && $nout[0] eq $s) {
323 dbg("got exact multipart prefix: $call $s") if isdbg('prefix');
325 lru_put($call, \@nout);
330 dbg("Parts now: $call = " . join(' ', @parts)) if isdbg('prefix');
332 # at this point we should have two or three parts
333 # if it is three parts then join the first and last parts together
336 # first deal with prefix/x00xx/single letter things
337 if (@parts == 3 && length $parts[0] <= length $parts[1]) {
338 @nout = matchprefix($parts[0]);
340 my $s = join('/', $nout[0], $parts[2]);
342 if (@try && $try[0] eq $s) {
343 dbg("got 3 part prefix: $call $s") if isdbg('prefix');
345 lru_put($call, \@try);
350 # if the second part is a callsign and the last part is one letter
351 if (is_callsign($parts[1]) && length $parts[2] == 1) {
357 # if it is a two parter
360 # try it as it is as compound, taking the first part as the prefix
361 @nout = matchprefix($parts[0]);
363 my $s = join('/', $nout[0], $parts[1]);
365 if (@try && $try[0] eq $s) {
366 dbg("got 2 part prefix: $call $s") if isdbg('prefix');
368 lru_put($call, \@try);
375 # remove the problematic /J suffix
376 pop @parts if @parts > 1 && $parts[$#parts] eq 'J';
380 @nout = matchprefix($parts[0]);
382 dbg("got prefix: $call = $nout[0]") if isdbg('prefix');
384 lru_put($call, \@nout);
393 L1: for ($n = 0; $n < @parts; $n++) {
396 for ($i = $k = 0; $i < @parts; $i++) {
397 next if $checked[$i];
399 if (!$sp || length $p < length $sp) {
400 dbg("try part: $p") if isdbg('prefix');
406 $sp =~ s/-\d+$//; # remove any SSID
408 # now start to resolve it from the right hand end
409 @nout = matchprefix($sp);
411 # try and search for it in the descriptions as
412 # a whole callsign if it has multiple parts and the output
413 # is more two long, this should catch things like
414 # FR5DX/T without having to explicitly stick it into
419 $parts[$k] = $nout[0];
420 my $try = join('/', @parts);
422 if (isdbg('prefix')) {
423 my $part = $try[0] || "*";
424 $part .= '*' unless $part eq '*' || $part eq $try;
425 dbg("Compound prefix: $try $part" );
427 if (@try && $try eq $try[0]) {
429 lru_put($call, \@try);
433 lru_put($call, \@nout);
438 lru_put($call, \@nout);
446 @nout = matchprefix('QQ');
448 lru_put($call, \@nout);
452 if (isdbg('prefixdata')) {
453 my $dd = new Data::Dumper([ \@out ], [qw(@out)]);
460 # turn a list of prefixes / dxcc numbers into a list of dxcc/itu/zone numbers
474 if ($cmd ne 'ns' && $v =~ /^\d+$/) {
475 push @out, $v unless grep $_ eq $v, @out;
477 if ($cmd eq 'ns' && $v =~ /^[A-Z][A-Z]$/i) {
478 push @out, uc $v unless grep $_ eq uc $v, @out;
480 my @pre = Prefix::extract($v);
483 foreach my $p (@pre) {
484 my $n = $p->dxcc if $cmd eq 'nc' ;
485 $n = $p->itu if $cmd eq 'ni' ;
486 $n = $p->cq if $cmd eq 'nz' ;
487 $n = $p->state if $cmd eq 'ns';
488 push @out, $n unless grep $_ eq $n, @out;
497 # get the full country data (dxcc, itu, cq, state, city) as a list
503 my @dxcc = extract($call);
505 my $state = $dxcc[1]->state || '';
506 my $city = $dxcc[1]->city || '';
507 my $name = $dxcc[1]->name || '';
509 return ($dxcc[1]->dxcc, $dxcc[1]->itu, $dxcc[1]->cq, $state, $city, $name);
511 return (666,0,0,'','','Pirate-Country-QQ');
515 lat => '0,Latitude,slat',
516 long => '0,Longitude,slong',
523 utcoff => '0,UTC offset',
524 cont => '0,Continent',
530 my $name = $AUTOLOAD;
532 return if $name =~ /::DESTROY$/;
535 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
536 # this clever line of code creates a subroutine which takes over from autoload
537 # from OO Perl - Conway
538 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}} ;
543 # return a prompt for a field
548 my ($self, $ele) = @_;